| <!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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/filesystem.h 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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </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_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">filesystem.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="filesystem_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef DMLC_FILESYSTEM_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define DMLC_FILESYSTEM_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <dmlc/logging.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html">dmlc/io.h</a>></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <algorithm></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <random></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* platform specific headers */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifdef _WIN32</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define NOMINMAX</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <windows.h></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <Shlwapi.h></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#pragma comment(lib, "Shlwapi.lib")</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#else // _WIN32</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <unistd.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <sys/stat.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <sys/types.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif // _WIN32</span></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="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classdmlc_1_1TemporaryDirectory.html"> 54</a></span> <span class="keyword">class </span><a class="code" href="classdmlc_1_1TemporaryDirectory.html">TemporaryDirectory</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classdmlc_1_1TemporaryDirectory.html#aba66f5c82ab2182af705417b566387e4"> 61</a></span>  <span class="keyword">explicit</span> <a class="code" href="classdmlc_1_1TemporaryDirectory.html#aba66f5c82ab2182af705417b566387e4">TemporaryDirectory</a>(<span class="keywordtype">bool</span> verbose = <span class="keyword">false</span>)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  : verbose_(verbose) {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#if _WIN32</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">/* locate the root directory of temporary area */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">char</span> tmproot[MAX_PATH] = {0};</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> DWORD dw_retval = GetTempPathA(MAX_PATH, tmproot);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">if</span> (dw_retval > MAX_PATH || dw_retval == 0) {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  LOG(FATAL) << <span class="stringliteral">"TemporaryDirectory(): "</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  << <span class="stringliteral">"Could not create temporary directory"</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="comment">/* generate a unique 8-letter alphanumeric string */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::string letters = <span class="stringliteral">"abcdefghijklmnopqrstuvwxyz0123456789_"</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  std::string uniqstr(8, <span class="charliteral">'\0'</span>);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::random_device rd;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  std::mt19937 gen(rd());</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::uniform_int_distribution<int> dis(0, letters.length() - 1);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::generate(uniqstr.begin(), uniqstr.end(),</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  [&dis, &gen, &letters]() -> <span class="keywordtype">char</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> letters[dis(gen)];</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  });</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">/* combine paths to get the name of the temporary directory */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">char</span> tmpdir[MAX_PATH] = {0};</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  PathCombineA(tmpdir, tmproot, uniqstr.c_str());</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span> (!CreateDirectoryA(tmpdir, NULL)) {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  LOG(FATAL) << <span class="stringliteral">"TemporaryDirectory(): "</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  << <span class="stringliteral">"Could not create temporary directory"</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a> = std::string(tmpdir);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#else // _WIN32</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::string tmproot; <span class="comment">/* root directory of temporary area */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::string dirtemplate; <span class="comment">/* template for temporary directory name */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">/* Get TMPDIR env variable or fall back to /tmp/ */</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* tmpenv = getenv(<span class="stringliteral">"TMPDIR"</span>);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">if</span> (tmpenv) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  tmproot = std::string(tmpenv);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// strip trailing forward slashes</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">while</span> (tmproot.length() != 0 && tmproot[tmproot.length() - 1] == <span class="charliteral">'/'</span>) {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  tmproot.resize(tmproot.length() - 1);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  tmproot = <span class="stringliteral">"/tmp"</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  dirtemplate = tmproot + <span class="stringliteral">"/tmpdir.XXXXXX"</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::vector<char> dirtemplate_buf(dirtemplate.begin(), dirtemplate.end());</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  dirtemplate_buf.push_back(<span class="charliteral">'\0'</span>);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">char</span>* tmpdir = mkdtemp(&dirtemplate_buf[0]);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">if</span> (!tmpdir) {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  LOG(FATAL) << <span class="stringliteral">"TemporaryDirectory(): "</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  << <span class="stringliteral">"Could not create temporary directory"</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a> = std::string(tmpdir);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif // _WIN32</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">if</span> (verbose_) {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  LOG(INFO) << <span class="stringliteral">"Created temporary directory "</span> << <a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classdmlc_1_1TemporaryDirectory.html#a3e909dd51a3463d57580d4bf2da71f1e"> 121</a></span>  <a class="code" href="classdmlc_1_1TemporaryDirectory.html#a3e909dd51a3463d57580d4bf2da71f1e">~TemporaryDirectory</a>() {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  RecursiveDelete(<a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a>);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522"> 126</a></span>  std::string <a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">bool</span> verbose_;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsSymlink(<span class="keyword">const</span> std::string& path) {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#ifdef _WIN32</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  DWORD attr = GetFileAttributesA(path.c_str());</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  CHECK_NE(attr, INVALID_FILE_ATTRIBUTES)</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  << <span class="stringliteral">"dmlc::TemporaryDirectory::IsSymlink(): Unable to read file attributes"</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">return</span> attr & FILE_ATTRIBUTE_REPARSE_POINT;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#else // _WIN32</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">struct </span>stat sb;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  CHECK_EQ(lstat(path.c_str(), &sb), 0)</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  << <span class="stringliteral">"dmlc::TemporaryDirectory::IsSymlink(): Unable to read file attributes"</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordflow">return</span> S_ISLNK(sb.st_mode);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif // _WIN32</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  }</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">void</span> RecursiveDelete(<span class="keyword">const</span> std::string& path);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> };</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> } <span class="comment">// namespace dmlc</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif // DMLC_FILESYSTEM_H_</span></div><div class="ttc" id="classdmlc_1_1TemporaryDirectory_html_a254cc8d6c4c1e35e6e0e01bf367d1522"><div class="ttname"><a href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">dmlc::TemporaryDirectory::path</a></div><div class="ttdeci">std::string path</div><div class="ttdoc">Full path of the temporary directory. </div><div class="ttdef"><b>Definition:</b> filesystem.h:126</div></div> |
| <div class="ttc" id="classdmlc_1_1TemporaryDirectory_html_aba66f5c82ab2182af705417b566387e4"><div class="ttname"><a href="classdmlc_1_1TemporaryDirectory.html#aba66f5c82ab2182af705417b566387e4">dmlc::TemporaryDirectory::TemporaryDirectory</a></div><div class="ttdeci">TemporaryDirectory(bool verbose=false)</div><div class="ttdoc">Default constructor. Creates a new temporary directory with a unique name. </div><div class="ttdef"><b>Definition:</b> filesystem.h:61</div></div> |
| <div class="ttc" id="namespacedmlc_html"><div class="ttname"><a href="namespacedmlc.html">dmlc</a></div><div class="ttdoc">namespace for dmlc </div><div class="ttdef"><b>Definition:</b> array_view.h:12</div></div> |
| <div class="ttc" id="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_html"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html">io.h</a></div></div> |
| <div class="ttc" id="classdmlc_1_1TemporaryDirectory_html_a3e909dd51a3463d57580d4bf2da71f1e"><div class="ttname"><a href="classdmlc_1_1TemporaryDirectory.html#a3e909dd51a3463d57580d4bf2da71f1e">dmlc::TemporaryDirectory::~TemporaryDirectory</a></div><div class="ttdeci">~TemporaryDirectory()</div><div class="ttdoc">Destructor. Will perform recursive deletion via RecursiveDelete() </div><div class="ttdef"><b>Definition:</b> filesystem.h:121</div></div> |
| <div class="ttc" id="classdmlc_1_1TemporaryDirectory_html"><div class="ttname"><a href="classdmlc_1_1TemporaryDirectory.html">dmlc::TemporaryDirectory</a></div><div class="ttdoc">Manager class for temporary directories. Whenever a new TemporaryDirectory object is constructed...</div><div class="ttdef"><b>Definition:</b> filesystem.h:54</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Jun 8 2022 23:30:29 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |