| <!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/internal/windows/symlink.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_35c8ff4668e5819502b5d29320c39425.html">internal</a></li><li class="navelem"><a class="el" href="dir_3bd05d674f9d85fce6785660a08f69c2.html">windows</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">symlink.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="symlink_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_INTERNAL_WINDOWS_SYMLINK_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __STOUT_INTERNAL_WINDOWS_SYMLINK_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 <string></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">stout/windows.hpp</a>></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="reparsepoint_8hpp.html">stout/internal/windows/reparsepoint.hpp</a>></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="realpath_8hpp.html">stout/os/realpath.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> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>internal {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>windows {</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Gets symlink data for a given path, if it exists.</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// This turns out to be a very complicated task on Windows. The gist of it is</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// that we know that symlinks on Windows are implemented with the Reparse Point</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// API, and so the process is a matter of:</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// 1. Checking whether the attributes for the file/folder specified by the</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// path have the reparse point bit set; all symlinks are implemented with</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// reparse points, so this bit should be on all symlinks.</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// 2. Opening a file/folder handle for that path, instructing it specifically</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// to open a handle for the symlink (if the path points at a symlink) and</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// *not* the file the symlink points at (as is the default). Note that</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// file and folder handles are different, so we have a function that</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// chooses appropriately.</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// 3. Using `DeviceIoControl` to obtain information about the handle for this</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// reparse point, which we can then query to figure out if it's a reparse</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// point that is owned by the symlink filesystem filter driver.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// 4. If it is, then we report that this path does point at a symlink.</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// NOTE: it may be helpful to consult the documentation for each of these</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// functions, as they give you sources that justify the arguments to the</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// obscure APIs we call to get this all working.</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="namespaceinternal_1_1windows.html#a39ca8fa0643b489f6bef951bef207c92"> 51</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<SymbolicLink></a> <a class="code" href="namespaceinternal_1_1windows.html#a39ca8fa0643b489f6bef951bef207c92">query_symbolic_link_data</a>(<span class="keyword">const</span> std::string& path)</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// Convert to absolute path because Windows APIs expect it.</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <a class="code" href="classResult.html">Result<std::string></a> absolute_path = <a class="code" href="namespaceos.html#a7fd21154b15bc00e31e2b457cab83ff2">os::realpath</a>(path);</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">if</span> (!absolute_path.<a class="code" href="classResult.html#a85eaa52037223d71092e65701c166562">isSome</a>()) {</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(absolute_path.<a class="code" href="classResult.html#a521adf96f5c27d26d6b1d580aae8aaee">error</a>());</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</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="comment">// Windows has no built-in way to tell whether a path points at a symbolic</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// link; but, we know that symbolic links are implemented with reparse</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// points, so we begin by checking that.</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classTry.html">Try<bool></a> is_reparse_point =</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="namespaceinternal_1_1windows.html#ab48abfb7e70b90bcd8ff4047cf53ac83">reparse_point_attribute_set</a>(absolute_path.<a class="code" href="classResult.html#aedf79f3b14dcda5791b84a64ada4d412">get</a>());</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">if</span> (is_reparse_point.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(is_reparse_point.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!is_reparse_point.<a class="code" href="classTry.html#a7be0768038e0628632492edf6cc1515a">get</a>()) {</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="stringliteral">"Reparse point attribute is not set for path '"</span> + absolute_path.<a class="code" href="classResult.html#aedf79f3b14dcda5791b84a64ada4d412">get</a>() +</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="stringliteral">"', and therefore it is not a symbolic link"</span>);</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">const</span> <a class="code" href="classTry.html">Try<SharedHandle></a> symlink_handle =</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="namespaceinternal_1_1windows.html#a8ee4f75d803d8ed56ce760d8e1dfac14">get_handle_no_follow</a>(absolute_path.<a class="code" href="classResult.html#aedf79f3b14dcda5791b84a64ada4d412">get</a>());</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">if</span> (symlink_handle.<a class="code" href="classTry.html#a0b98f95163b8a38daafd1651b043a276">isError</a>()) {</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(symlink_handle.<a class="code" href="classTry.html#aec4a11ddd3c036e889d90b7eb6258ba7">error</a>());</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Finally, retrieve symlink data for the handle, if any.</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceinternal_1_1windows.html#a85f7e5d0197eeb93bde525379b8e14d6">get_symbolic_link_data</a>(symlink_handle.<a class="code" href="classTry.html#a7be0768038e0628632492edf6cc1515a">get</a>().<a class="code" href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">get_handle</a>());</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> }</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> } <span class="comment">// namespace windows {</span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <span class="comment">// namespace internal {</span></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif // __STOUT_INTERNAL_WINDOWS_SYMLINK_HPP__</span></div> |
| <div class="ttc" id="namespaceinternal_1_1windows_html_a8ee4f75d803d8ed56ce760d8e1dfac14"><div class="ttname"><a href="namespaceinternal_1_1windows.html#a8ee4f75d803d8ed56ce760d8e1dfac14">internal::windows::get_handle_no_follow</a></div><div class="ttdeci">Try< SharedHandle > get_handle_no_follow(const std::string &absolute_path)</div><div class="ttdef"><b>Definition:</b> reparsepoint.hpp:160</div></div> |
| <div class="ttc" id="realpath_8hpp_html"><div class="ttname"><a href="realpath_8hpp.html">realpath.hpp</a></div></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="classSharedHandle_html_a800385e17e17cb826147968e748fd8fa"><div class="ttname"><a href="classSharedHandle.html#a800385e17e17cb826147968e748fd8fa">SharedHandle::get_handle</a></div><div class="ttdeci">HANDLE get_handle() const </div><div class="ttdef"><b>Definition:</b> windows.hpp:72</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="classResult_html_a521adf96f5c27d26d6b1d580aae8aaee"><div class="ttname"><a href="classResult.html#a521adf96f5c27d26d6b1d580aae8aaee">Result::error</a></div><div class="ttdeci">static Result< T > error(const std::string &message)</div><div class="ttdef"><b>Definition:</b> result.hpp:53</div></div> |
| <div class="ttc" id="namespaceinternal_1_1windows_html_a39ca8fa0643b489f6bef951bef207c92"><div class="ttname"><a href="namespaceinternal_1_1windows.html#a39ca8fa0643b489f6bef951bef207c92">internal::windows::query_symbolic_link_data</a></div><div class="ttdeci">Try< SymbolicLink > query_symbolic_link_data(const std::string &path)</div><div class="ttdef"><b>Definition:</b> symlink.hpp:51</div></div> |
| <div class="ttc" id="3rdparty_2stout_2include_2stout_2windows_8hpp_html"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2windows_8hpp.html">windows.hpp</a></div></div> |
| <div class="ttc" id="classResult_html"><div class="ttname"><a href="classResult.html">Result</a></div><div class="ttdef"><b>Definition:</b> result.hpp:40</div></div> |
| <div class="ttc" id="reparsepoint_8hpp_html"><div class="ttname"><a href="reparsepoint_8hpp.html">reparsepoint.hpp</a></div></div> |
| <div class="ttc" id="namespaceinternal_1_1windows_html_a85f7e5d0197eeb93bde525379b8e14d6"><div class="ttname"><a href="namespaceinternal_1_1windows.html#a85f7e5d0197eeb93bde525379b8e14d6">internal::windows::get_symbolic_link_data</a></div><div class="ttdeci">Try< SymbolicLink > get_symbolic_link_data(const HANDLE handle)</div><div class="ttdef"><b>Definition:</b> reparsepoint.hpp:215</div></div> |
| <div class="ttc" id="classResult_html_aedf79f3b14dcda5791b84a64ada4d412"><div class="ttname"><a href="classResult.html#aedf79f3b14dcda5791b84a64ada4d412">Result::get</a></div><div class="ttdeci">const T & get() const </div><div class="ttdef"><b>Definition:</b> result.hpp:112</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="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="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div> |
| <div class="ttc" id="classResult_html_a85eaa52037223d71092e65701c166562"><div class="ttname"><a href="classResult.html#a85eaa52037223d71092e65701c166562">Result::isSome</a></div><div class="ttdeci">bool isSome() const </div><div class="ttdef"><b>Definition:</b> result.hpp:108</div></div> |
| <div class="ttc" id="classTry_html_a7be0768038e0628632492edf6cc1515a"><div class="ttname"><a href="classTry.html#a7be0768038e0628632492edf6cc1515a">Try::get</a></div><div class="ttdeci">const T & get() const </div><div class="ttdef"><b>Definition:</b> try.hpp:73</div></div> |
| <div class="ttc" id="namespaceinternal_1_1windows_html_ab48abfb7e70b90bcd8ff4047cf53ac83"><div class="ttname"><a href="namespaceinternal_1_1windows.html#ab48abfb7e70b90bcd8ff4047cf53ac83">internal::windows::reparse_point_attribute_set</a></div><div class="ttdeci">Try< bool > reparse_point_attribute_set(const std::string &absolute_path)</div><div class="ttdef"><b>Definition:</b> reparsepoint.hpp:115</div></div> |
| <div class="ttc" id="namespaceos_html_a7fd21154b15bc00e31e2b457cab83ff2"><div class="ttname"><a href="namespaceos.html#a7fd21154b15bc00e31e2b457cab83ff2">os::realpath</a></div><div class="ttdeci">Result< std::string > realpath(const std::string &path)</div><div class="ttdef"><b>Definition:</b> realpath.hpp:26</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> |
