| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.5"/> |
| <title>Apache Mesos: 3rdparty/stout/include/stout/os/open.hpp Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_aa547de1d719d14adccfca1dfb1735b3.html">stout</a></li><li class="navelem"><a class="el" href="dir_1a1b923d951dd999d43396870333fc33.html">include</a></li><li class="navelem"><a class="el" href="dir_dbd52553d038069c1ed93e3477ea333d.html">stout</a></li><li class="navelem"><a class="el" href="dir_27832e6c74c2ee170d1dd05a196f816c.html">os</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">open.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="open_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// you may not use this file except in compliance with the License.</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// limitations under the License.</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __STOUT_OS_OPEN_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __STOUT_OS_OPEN_HPP__</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <sys/stat.h></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <sys/types.h></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="close_8hpp.html">stout/os/close.hpp</a>></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="int__fd_8hpp.html">stout/os/int_fd.hpp</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// For old systems that do not support O_CLOEXEC, we still want</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// os::open to accept that flag so that we can simplify the code.</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef O_CLOEXEC</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="comment">// Since we will define O_CLOEXEC if it is not yet defined, we use a</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// special symbol to tell if the flag is truly unavailable or not.</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="open_8hpp.html#a33e0146d5aa161897076c36c8207ac3a"> 33</a></span> <span class="preprocessor">#define O_CLOEXEC_UNDEFINED</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// NOTE: For backward compatibility concern, kernel usually does not</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// change the constant values for symbols like O_CLOEXEC.</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#if defined(__APPLE__)</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="comment">// Copied from '/usr/include/sys/fcntl.h'</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define O_CLOEXEC 0x1000000</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#elif defined(__linux__)</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="comment">// Copied from '/usr/include/asm-generic/fcntl.h'.</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define O_CLOEXEC 02000000</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#elif defined(__sun)</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="comment">// Not defined on Solaris, taking a spare flag.</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define O_CLOEXEC 0x1000000</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __ APPLE__</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span><span class="preprocessor">#endif // O_CLOEXEC</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// Only include `fcntl` when strictly necessary, i.e., when we need to use</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// `os::cloexec` to set the close-on-exec behavior of a file descriptor. We do</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// this because some platforms (like Windows) will probably never support</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// `os::cloexec`, and hence referencing that header will cause problems on some</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// systems.</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#ifdef O_CLOEXEC_UNDEFINED</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="fcntl_8hpp.html">stout/os/fcntl.hpp</a>></span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif // O_CLOEXEC_UNDEFINED</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">namespace </span>os {</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="namespaceos.html#abbdbbbe902fd8dc271077d94b99994e7"> 61</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<int_fd></a> <a class="code" href="namespaceos.html#abbdbbbe902fd8dc271077d94b99994e7">open</a>(<span class="keyword">const</span> std::string& path, <span class="keywordtype">int</span> oflag, <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a8a35dd1207a16dfa8b1d4163176d828c">mode_t</a> <a class="code" href="namespaceos_1_1stat.html#a8c2f88a3dd82d5f3103c16a165d829d7">mode</a> = 0)</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> {</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#ifdef O_CLOEXEC_UNDEFINED</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span> <span class="comment">// Before we passing oflag to ::open, we need to strip the O_CLOEXEC</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// flag since it's not supported.</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> <a class="code" href="namespaceos.html#a7d71bda07a41304403b0e13aa47f0764">cloexec</a> = <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">if</span> ((oflag & <a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ad6d8fbe4e494b4dbe051612572d3f757">O_CLOEXEC</a>) != 0) {</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  oflag &= ~O_CLOEXEC;</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  cloexec = <span class="keyword">true</span>;</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="int__fd_8hpp.html#aea4dbda01c90455f158ffa9b924c2f07">int_fd</a> fd = <a class="code" href="namespaceos.html#abbdbbbe902fd8dc271077d94b99994e7">::open</a>(path.c_str(), oflag, <a class="code" href="namespaceos_1_1stat.html#a8c2f88a3dd82d5f3103c16a165d829d7">mode</a>);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">if</span> (fd < 0) {</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> <a class="code" href="classErrnoError.html">ErrnoError</a>();</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#ifdef O_CLOEXEC_UNDEFINED</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span> <span class="keywordflow">if</span> (cloexec) {</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classTry.html">Try<Nothing></a> result = <a class="code" href="namespaceos.html#a7d71bda07a41304403b0e13aa47f0764">os::cloexec</a>(fd);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span> (result.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="namespaceos.html#a8df77ec6d6b8d32d9b287a41bc74cfdc">os::close</a>(fd);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to set cloexec: "</span> + result.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> fd;</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> } <span class="comment">// namespace os {</span></div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#endif // __STOUT_OS_OPEN_HPP__</span></div> |
| <div class="ttc" id="classError_html"><div class="ttname"><a href="classError.html">Error</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:35</div></div> |
| <div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div> |
| <div class="ttc" id="classErrnoError_html"><div class="ttname"><a href="classErrnoError.html">ErrnoError</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:44</div></div> |
| <div class="ttc" id="namespaceos_1_1stat_html_a8c2f88a3dd82d5f3103c16a165d829d7"><div class="ttname"><a href="namespaceos_1_1stat.html#a8c2f88a3dd82d5f3103c16a165d829d7">os::stat::mode</a></div><div class="ttdeci">Try< mode_t > mode(const std::string &path)</div><div class="ttdef"><b>Definition:</b> stat.hpp:120</div></div> |
| <div class="ttc" id="close_8hpp_html"><div class="ttname"><a href="close_8hpp.html">close.hpp</a></div></div> |
| <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_a8a35dd1207a16dfa8b1d4163176d828c"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#a8a35dd1207a16dfa8b1d4163176d828c">mode_t</a></div><div class="ttdeci">int mode_t</div><div class="ttdef"><b>Definition:</b> windows.hpp:167</div></div> |
| <div class="ttc" id="fcntl_8hpp_html"><div class="ttname"><a href="fcntl_8hpp.html">fcntl.hpp</a></div></div> |
| <div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div> |
| <div class="ttc" id="namespaceos_html_a8df77ec6d6b8d32d9b287a41bc74cfdc"><div class="ttname"><a href="namespaceos.html#a8df77ec6d6b8d32d9b287a41bc74cfdc">os::close</a></div><div class="ttdeci">Try< Nothing > close(int fd)</div><div class="ttdef"><b>Definition:</b> close.hpp:24</div></div> |
| <div class="ttc" id="namespaceos_html_a7d71bda07a41304403b0e13aa47f0764"><div class="ttname"><a href="namespaceos.html#a7d71bda07a41304403b0e13aa47f0764">os::cloexec</a></div><div class="ttdeci">Try< Nothing > cloexec(int fd)</div><div class="ttdef"><b>Definition:</b> fcntl.hpp:27</div></div> |
| <div class="ttc" id="classTry_html_aec4a11ddd3c036e889d90b7eb6258ba7"><div class="ttname"><a href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">Try::error</a></div><div class="ttdeci">static Try error(const E &e)</div><div class="ttdef"><b>Definition:</b> try.hpp:42</div></div> |
| <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html_ad6d8fbe4e494b4dbe051612572d3f757"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ad6d8fbe4e494b4dbe051612572d3f757">O_CLOEXEC</a></div><div class="ttdeci">#define O_CLOEXEC</div><div class="ttdef"><b>Definition:</b> windows.hpp:150</div></div> |
| <div class="ttc" id="error_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div> |
| <div class="ttc" id="classTry_html_a0b98f95163b8a38daafd1651b043a276"><div class="ttname"><a href="classTry.html#a0b98f95163b8a38daafd1651b043a276">Try::isError</a></div><div class="ttdeci">bool isError() const </div><div class="ttdef"><b>Definition:</b> try.hpp:71</div></div> |
| <div class="ttc" id="namespaceos_html_abbdbbbe902fd8dc271077d94b99994e7"><div class="ttname"><a href="namespaceos.html#abbdbbbe902fd8dc271077d94b99994e7">os::open</a></div><div class="ttdeci">Try< int_fd > open(const std::string &path, int oflag, mode_t mode=0)</div><div class="ttdef"><b>Definition:</b> open.hpp:61</div></div> |
| <div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div> |
| <div class="ttc" id="int__fd_8hpp_html"><div class="ttname"><a href="int__fd_8hpp.html">int_fd.hpp</a></div></div> |
| <div class="ttc" id="int__fd_8hpp_html_aea4dbda01c90455f158ffa9b924c2f07"><div class="ttname"><a href="int__fd_8hpp.html#aea4dbda01c90455f158ffa9b924c2f07">int_fd</a></div><div class="ttdeci">int int_fd</div><div class="ttdef"><b>Definition:</b> int_fd.hpp:35</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
