1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/Support/Path.h"
11 #include "llvm/Support/ConvertUTF.h"
12 #include "llvm/Support/Errc.h"
13 #include "llvm/Support/ErrorHandling.h"
14 #include "llvm/Support/FileSystem.h"
15 #include "llvm/Support/MemoryBuffer.h"
16 #include "llvm/Support/raw_ostream.h"
17 #include "gtest/gtest.h"
18 
19 #ifdef LLVM_ON_WIN32
20 #include "llvm/ADT/ArrayRef.h"
21 #include <windows.h>
22 #include <winerror.h>
23 #endif
24 
25 #ifdef LLVM_ON_UNIX
26 #include <sys/stat.h>
27 #endif
28 
29 using namespace llvm;
30 using namespace llvm::sys;
31 
32 #define ASSERT_NO_ERROR(x)                                                     \
33   if (std::error_code ASSERT_NO_ERROR_ec = x) {                                \
34     SmallString<128> MessageStorage;                                           \
35     raw_svector_ostream Message(MessageStorage);                               \
36     Message << #x ": did not return errc::success.\n"                          \
37             << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n"          \
38             << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n";      \
39     GTEST_FATAL_FAILURE_(MessageStorage.c_str());                              \
40   } else {                                                                     \
41   }
42 
43 namespace {
44 
45 TEST(is_separator, Works) {
46   EXPECT_TRUE(path::is_separator('/'));
47   EXPECT_FALSE(path::is_separator('\0'));
48   EXPECT_FALSE(path::is_separator('-'));
49   EXPECT_FALSE(path::is_separator(' '));
50 
51 #ifdef LLVM_ON_WIN32
52   EXPECT_TRUE(path::is_separator('\\'));
53 #else
54   EXPECT_FALSE(path::is_separator('\\'));
55 #endif
56 }
57 
58 TEST(Support, Path) {
59   SmallVector<StringRef, 40> paths;
60   paths.push_back("");
61   paths.push_back(".");
62   paths.push_back("..");
63   paths.push_back("foo");
64   paths.push_back("/");
65   paths.push_back("/foo");
66   paths.push_back("foo/");
67   paths.push_back("/foo/");
68   paths.push_back("foo/bar");
69   paths.push_back("/foo/bar");
70   paths.push_back("//net");
71   paths.push_back("//net/foo");
72   paths.push_back("///foo///");
73   paths.push_back("///foo///bar");
74   paths.push_back("/.");
75   paths.push_back("./");
76   paths.push_back("/..");
77   paths.push_back("../");
78   paths.push_back("foo/.");
79   paths.push_back("foo/..");
80   paths.push_back("foo/./");
81   paths.push_back("foo/./bar");
82   paths.push_back("foo/..");
83   paths.push_back("foo/../");
84   paths.push_back("foo/../bar");
85   paths.push_back("c:");
86   paths.push_back("c:/");
87   paths.push_back("c:foo");
88   paths.push_back("c:/foo");
89   paths.push_back("c:foo/");
90   paths.push_back("c:/foo/");
91   paths.push_back("c:/foo/bar");
92   paths.push_back("prn:");
93   paths.push_back("c:\\");
94   paths.push_back("c:foo");
95   paths.push_back("c:\\foo");
96   paths.push_back("c:foo\\");
97   paths.push_back("c:\\foo\\");
98   paths.push_back("c:\\foo/");
99   paths.push_back("c:/foo\\bar");
100 
101   SmallVector<StringRef, 5> ComponentStack;
102   for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
103                                                   e = paths.end();
104                                                   i != e;
105                                                   ++i) {
106     for (sys::path::const_iterator ci = sys::path::begin(*i),
107                                    ce = sys::path::end(*i);
108                                    ci != ce;
109                                    ++ci) {
110       ASSERT_FALSE(ci->empty());
111       ComponentStack.push_back(*ci);
112     }
113 
114     for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
115                                      ce = sys::path::rend(*i);
116                                      ci != ce;
117                                      ++ci) {
118       ASSERT_TRUE(*ci == ComponentStack.back());
119       ComponentStack.pop_back();
120     }
121     ASSERT_TRUE(ComponentStack.empty());
122 
123     path::has_root_path(*i);
124     path::root_path(*i);
125     path::has_root_name(*i);
126     path::root_name(*i);
127     path::has_root_directory(*i);
128     path::root_directory(*i);
129     path::has_parent_path(*i);
130     path::parent_path(*i);
131     path::has_filename(*i);
132     path::filename(*i);
133     path::has_stem(*i);
134     path::stem(*i);
135     path::has_extension(*i);
136     path::extension(*i);
137     path::is_absolute(*i);
138     path::is_relative(*i);
139 
140     SmallString<128> temp_store;
141     temp_store = *i;
142     ASSERT_NO_ERROR(fs::make_absolute(temp_store));
143     temp_store = *i;
144     path::remove_filename(temp_store);
145 
146     temp_store = *i;
147     path::replace_extension(temp_store, "ext");
148     StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
149     stem = path::stem(filename);
150     ext  = path::extension(filename);
151     EXPECT_EQ(*sys::path::rbegin(filename), (stem + ext).str());
152 
153     path::native(*i, temp_store);
154   }
155 
156   SmallString<32> Relative("foo.cpp");
157   ASSERT_NO_ERROR(sys::fs::make_absolute("/root", Relative));
158   Relative[5] = '/'; // Fix up windows paths.
159   ASSERT_EQ("/root/foo.cpp", Relative);
160 }
161 
162 TEST(Support, RelativePathIterator) {
163   SmallString<64> Path(StringRef("c/d/e/foo.txt"));
164   typedef SmallVector<StringRef, 4> PathComponents;
165   PathComponents ExpectedPathComponents;
166   PathComponents ActualPathComponents;
167 
168   StringRef(Path).split(ExpectedPathComponents, '/');
169 
170   for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
171        ++I) {
172     ActualPathComponents.push_back(*I);
173   }
174 
175   ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
176 
177   for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
178     EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
179   }
180 }
181 
182 TEST(Support, RelativePathDotIterator) {
183   SmallString<64> Path(StringRef(".c/.d/../."));
184   typedef SmallVector<StringRef, 4> PathComponents;
185   PathComponents ExpectedPathComponents;
186   PathComponents ActualPathComponents;
187 
188   StringRef(Path).split(ExpectedPathComponents, '/');
189 
190   for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
191        ++I) {
192     ActualPathComponents.push_back(*I);
193   }
194 
195   ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
196 
197   for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
198     EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
199   }
200 }
201 
202 TEST(Support, AbsolutePathIterator) {
203   SmallString<64> Path(StringRef("/c/d/e/foo.txt"));
204   typedef SmallVector<StringRef, 4> PathComponents;
205   PathComponents ExpectedPathComponents;
206   PathComponents ActualPathComponents;
207 
208   StringRef(Path).split(ExpectedPathComponents, '/');
209 
210   // The root path will also be a component when iterating
211   ExpectedPathComponents[0] = "/";
212 
213   for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
214        ++I) {
215     ActualPathComponents.push_back(*I);
216   }
217 
218   ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
219 
220   for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
221     EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
222   }
223 }
224 
225 TEST(Support, AbsolutePathDotIterator) {
226   SmallString<64> Path(StringRef("/.c/.d/../."));
227   typedef SmallVector<StringRef, 4> PathComponents;
228   PathComponents ExpectedPathComponents;
229   PathComponents ActualPathComponents;
230 
231   StringRef(Path).split(ExpectedPathComponents, '/');
232 
233   // The root path will also be a component when iterating
234   ExpectedPathComponents[0] = "/";
235 
236   for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
237        ++I) {
238     ActualPathComponents.push_back(*I);
239   }
240 
241   ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
242 
243   for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
244     EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
245   }
246 }
247 
248 #ifdef LLVM_ON_WIN32
249 TEST(Support, AbsolutePathIteratorWin32) {
250   SmallString<64> Path(StringRef("c:\\c\\e\\foo.txt"));
251   typedef SmallVector<StringRef, 4> PathComponents;
252   PathComponents ExpectedPathComponents;
253   PathComponents ActualPathComponents;
254 
255   StringRef(Path).split(ExpectedPathComponents, "\\");
256 
257   // The root path (which comes after the drive name) will also be a component
258   // when iterating.
259   ExpectedPathComponents.insert(ExpectedPathComponents.begin()+1, "\\");
260 
261   for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
262        ++I) {
263     ActualPathComponents.push_back(*I);
264   }
265 
266   ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
267 
268   for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
269     EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
270   }
271 }
272 #endif // LLVM_ON_WIN32
273 
274 TEST(Support, AbsolutePathIteratorEnd) {
275   // Trailing slashes are converted to '.' unless they are part of the root path.
276   SmallVector<StringRef, 4> Paths;
277   Paths.push_back("/foo/");
278   Paths.push_back("/foo//");
279   Paths.push_back("//net//");
280 #ifdef LLVM_ON_WIN32
281   Paths.push_back("c:\\\\");
282 #endif
283 
284   for (StringRef Path : Paths) {
285     StringRef LastComponent = *path::rbegin(Path);
286     EXPECT_EQ(".", LastComponent);
287   }
288 
289   SmallVector<StringRef, 3> RootPaths;
290   RootPaths.push_back("/");
291   RootPaths.push_back("//net/");
292 #ifdef LLVM_ON_WIN32
293   RootPaths.push_back("c:\\");
294 #endif
295 
296   for (StringRef Path : RootPaths) {
297     StringRef LastComponent = *path::rbegin(Path);
298     EXPECT_EQ(1u, LastComponent.size());
299     EXPECT_TRUE(path::is_separator(LastComponent[0]));
300   }
301 }
302 
303 TEST(Support, HomeDirectory) {
304   std::string expected;
305 #ifdef LLVM_ON_WIN32
306   if (wchar_t const *path = ::_wgetenv(L"USERPROFILE")) {
307     auto pathLen = ::wcslen(path);
308     ArrayRef<char> ref{reinterpret_cast<char const *>(path),
309                        pathLen * sizeof(wchar_t)};
310     convertUTF16ToUTF8String(ref, expected);
311   }
312 #else
313   if (char const *path = ::getenv("HOME"))
314     expected = path;
315 #endif
316   // Do not try to test it if we don't know what to expect.
317   // On Windows we use something better than env vars.
318   if (!expected.empty()) {
319     SmallString<128> HomeDir;
320     auto status = path::home_directory(HomeDir);
321     EXPECT_TRUE(status);
322     EXPECT_EQ(expected, HomeDir);
323   }
324 }
325 
326 TEST(Support, UserCacheDirectory) {
327   SmallString<13> CacheDir;
328   SmallString<20> CacheDir2;
329   auto Status = path::user_cache_directory(CacheDir, "");
330   EXPECT_TRUE(Status ^ CacheDir.empty());
331 
332   if (Status) {
333     EXPECT_TRUE(path::user_cache_directory(CacheDir2, "")); // should succeed
334     EXPECT_EQ(CacheDir, CacheDir2); // and return same paths
335 
336     EXPECT_TRUE(path::user_cache_directory(CacheDir, "A", "B", "file.c"));
337     auto It = path::rbegin(CacheDir);
338     EXPECT_EQ("file.c", *It);
339     EXPECT_EQ("B", *++It);
340     EXPECT_EQ("A", *++It);
341     auto ParentDir = *++It;
342 
343     // Test Unicode: "<user_cache_dir>/(pi)r^2/aleth.0"
344     EXPECT_TRUE(path::user_cache_directory(CacheDir2, "\xCF\x80r\xC2\xB2",
345                                            "\xE2\x84\xB5.0"));
346     auto It2 = path::rbegin(CacheDir2);
347     EXPECT_EQ("\xE2\x84\xB5.0", *It2);
348     EXPECT_EQ("\xCF\x80r\xC2\xB2", *++It2);
349     auto ParentDir2 = *++It2;
350 
351     EXPECT_EQ(ParentDir, ParentDir2);
352   }
353 }
354 
355 TEST(Support, TempDirectory) {
356   SmallString<32> TempDir;
357   path::system_temp_directory(false, TempDir);
358   EXPECT_TRUE(!TempDir.empty());
359   TempDir.clear();
360   path::system_temp_directory(true, TempDir);
361   EXPECT_TRUE(!TempDir.empty());
362 }
363 
364 #ifdef LLVM_ON_WIN32
365 static std::string path2regex(std::string Path) {
366   size_t Pos = 0;
367   while ((Pos = Path.find('\\', Pos)) != std::string::npos) {
368     Path.replace(Pos, 1, "\\\\");
369     Pos += 2;
370   }
371   return Path;
372 }
373 
374 /// Helper for running temp dir test in separated process. See below.
375 #define EXPECT_TEMP_DIR(prepare, expected)                                     \
376   EXPECT_EXIT(                                                                 \
377       {                                                                        \
378         prepare;                                                               \
379         SmallString<300> TempDir;                                              \
380         path::system_temp_directory(true, TempDir);                            \
381         raw_os_ostream(std::cerr) << TempDir;                                  \
382         std::exit(0);                                                          \
383       },                                                                       \
384       ::testing::ExitedWithCode(0), path2regex(expected))
385 
386 TEST(SupportDeathTest, TempDirectoryOnWindows) {
387   // In this test we want to check how system_temp_directory responds to
388   // different values of specific env vars. To prevent corrupting env vars of
389   // the current process all checks are done in separated processes.
390   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:\\OtherFolder"), "C:\\OtherFolder");
391   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:/Unix/Path/Seperators"),
392                   "C:\\Unix\\Path\\Seperators");
393   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"Local Path"), ".+\\Local Path$");
394   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"F:\\TrailingSep\\"), "F:\\TrailingSep");
395   EXPECT_TEMP_DIR(
396       _wputenv_s(L"TMP", L"C:\\2\x03C0r-\x00B5\x00B3\\\x2135\x2080"),
397       "C:\\2\xCF\x80r-\xC2\xB5\xC2\xB3\\\xE2\x84\xB5\xE2\x82\x80");
398 
399   // Test $TMP empty, $TEMP set.
400   EXPECT_TEMP_DIR(
401       {
402         _wputenv_s(L"TMP", L"");
403         _wputenv_s(L"TEMP", L"C:\\Valid\\Path");
404       },
405       "C:\\Valid\\Path");
406 
407   // All related env vars empty
408   EXPECT_TEMP_DIR(
409   {
410     _wputenv_s(L"TMP", L"");
411     _wputenv_s(L"TEMP", L"");
412     _wputenv_s(L"USERPROFILE", L"");
413   },
414     "C:\\Temp");
415 
416   // Test evn var / path with 260 chars.
417   SmallString<270> Expected{"C:\\Temp\\AB\\123456789"};
418   while (Expected.size() < 260)
419     Expected.append("\\DirNameWith19Charss");
420   ASSERT_EQ(260U, Expected.size());
421   EXPECT_TEMP_DIR(_putenv_s("TMP", Expected.c_str()), Expected.c_str());
422 }
423 #endif
424 
425 class FileSystemTest : public testing::Test {
426 protected:
427   /// Unique temporary directory in which all created filesystem entities must
428   /// be placed. It is removed at the end of each test (must be empty).
429   SmallString<128> TestDirectory;
430 
431   void SetUp() override {
432     ASSERT_NO_ERROR(
433         fs::createUniqueDirectory("file-system-test", TestDirectory));
434     // We don't care about this specific file.
435     errs() << "Test Directory: " << TestDirectory << '\n';
436     errs().flush();
437   }
438 
439   void TearDown() override { ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); }
440 };
441 
442 TEST_F(FileSystemTest, Unique) {
443   // Create a temp file.
444   int FileDescriptor;
445   SmallString<64> TempPath;
446   ASSERT_NO_ERROR(
447       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
448 
449   // The same file should return an identical unique id.
450   fs::UniqueID F1, F2;
451   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
452   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
453   ASSERT_EQ(F1, F2);
454 
455   // Different files should return different unique ids.
456   int FileDescriptor2;
457   SmallString<64> TempPath2;
458   ASSERT_NO_ERROR(
459       fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
460 
461   fs::UniqueID D;
462   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
463   ASSERT_NE(D, F1);
464   ::close(FileDescriptor2);
465 
466   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
467 
468   // Two paths representing the same file on disk should still provide the
469   // same unique id.  We can test this by making a hard link.
470   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
471   fs::UniqueID D2;
472   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
473   ASSERT_EQ(D2, F1);
474 
475   ::close(FileDescriptor);
476 
477   SmallString<128> Dir1;
478   ASSERT_NO_ERROR(
479      fs::createUniqueDirectory("dir1", Dir1));
480   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F1));
481   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F2));
482   ASSERT_EQ(F1, F2);
483 
484   SmallString<128> Dir2;
485   ASSERT_NO_ERROR(
486      fs::createUniqueDirectory("dir2", Dir2));
487   ASSERT_NO_ERROR(fs::getUniqueID(Dir2.c_str(), F2));
488   ASSERT_NE(F1, F2);
489 }
490 
491 TEST_F(FileSystemTest, TempFiles) {
492   // Create a temp file.
493   int FileDescriptor;
494   SmallString<64> TempPath;
495   ASSERT_NO_ERROR(
496       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
497 
498   // Make sure it exists.
499   ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
500 
501   // Create another temp tile.
502   int FD2;
503   SmallString<64> TempPath2;
504   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
505   ASSERT_TRUE(TempPath2.endswith(".temp"));
506   ASSERT_NE(TempPath.str(), TempPath2.str());
507 
508   fs::file_status A, B;
509   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
510   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
511   EXPECT_FALSE(fs::equivalent(A, B));
512 
513   ::close(FD2);
514 
515   // Remove Temp2.
516   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
517   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
518   ASSERT_EQ(fs::remove(Twine(TempPath2), false),
519             errc::no_such_file_or_directory);
520 
521   std::error_code EC = fs::status(TempPath2.c_str(), B);
522   EXPECT_EQ(EC, errc::no_such_file_or_directory);
523   EXPECT_EQ(B.type(), fs::file_type::file_not_found);
524 
525   // Make sure Temp2 doesn't exist.
526   ASSERT_EQ(fs::access(Twine(TempPath2), sys::fs::AccessMode::Exist),
527             errc::no_such_file_or_directory);
528 
529   SmallString<64> TempPath3;
530   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
531   ASSERT_FALSE(TempPath3.endswith("."));
532 
533   // Create a hard link to Temp1.
534   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
535   bool equal;
536   ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
537   EXPECT_TRUE(equal);
538   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
539   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
540   EXPECT_TRUE(fs::equivalent(A, B));
541 
542   // Remove Temp1.
543   ::close(FileDescriptor);
544   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
545 
546   // Remove the hard link.
547   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
548 
549   // Make sure Temp1 doesn't exist.
550   ASSERT_EQ(fs::access(Twine(TempPath), sys::fs::AccessMode::Exist),
551             errc::no_such_file_or_directory);
552 
553 #ifdef LLVM_ON_WIN32
554   // Path name > 260 chars should get an error.
555   const char *Path270 =
556     "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
557     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
558     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
559     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
560     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
561   EXPECT_EQ(fs::createUniqueFile(Path270, FileDescriptor, TempPath),
562             errc::invalid_argument);
563   // Relative path < 247 chars, no problem.
564   const char *Path216 =
565     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
566     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
567     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
568     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
569   ASSERT_NO_ERROR(fs::createTemporaryFile(Path216, "", TempPath));
570   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
571 #endif
572 }
573 
574 TEST_F(FileSystemTest, CreateDir) {
575   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
576   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
577   ASSERT_EQ(fs::create_directory(Twine(TestDirectory) + "foo", false),
578             errc::file_exists);
579   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "foo"));
580 
581 #ifdef LLVM_ON_UNIX
582   // Set a 0000 umask so that we can test our directory permissions.
583   mode_t OldUmask = ::umask(0000);
584 
585   fs::file_status Status;
586   ASSERT_NO_ERROR(
587       fs::create_directory(Twine(TestDirectory) + "baz500", false,
588                            fs::perms::owner_read | fs::perms::owner_exe));
589   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz500", Status));
590   ASSERT_EQ(Status.permissions() & fs::perms::all_all,
591             fs::perms::owner_read | fs::perms::owner_exe);
592   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "baz777", false,
593                                        fs::perms::all_all));
594   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz777", Status));
595   ASSERT_EQ(Status.permissions() & fs::perms::all_all, fs::perms::all_all);
596 
597   // Restore umask to be safe.
598   ::umask(OldUmask);
599 #endif
600 
601 #ifdef LLVM_ON_WIN32
602   // Prove that create_directories() can handle a pathname > 248 characters,
603   // which is the documented limit for CreateDirectory().
604   // (248 is MAX_PATH subtracting room for an 8.3 filename.)
605   // Generate a directory path guaranteed to fall into that range.
606   size_t TmpLen = TestDirectory.size();
607   const char *OneDir = "\\123456789";
608   size_t OneDirLen = strlen(OneDir);
609   ASSERT_LT(OneDirLen, 12U);
610   size_t NLevels = ((248 - TmpLen) / OneDirLen) + 1;
611   SmallString<260> LongDir(TestDirectory);
612   for (size_t I = 0; I < NLevels; ++I)
613     LongDir.append(OneDir);
614   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
615   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
616   ASSERT_EQ(fs::create_directories(Twine(LongDir), false),
617             errc::file_exists);
618   // Tidy up, "recursively" removing the directories.
619   StringRef ThisDir(LongDir);
620   for (size_t J = 0; J < NLevels; ++J) {
621     ASSERT_NO_ERROR(fs::remove(ThisDir));
622     ThisDir = path::parent_path(ThisDir);
623   }
624 
625   // Similarly for a relative pathname.  Need to set the current directory to
626   // TestDirectory so that the one we create ends up in the right place.
627   char PreviousDir[260];
628   size_t PreviousDirLen = ::GetCurrentDirectoryA(260, PreviousDir);
629   ASSERT_GT(PreviousDirLen, 0U);
630   ASSERT_LT(PreviousDirLen, 260U);
631   ASSERT_NE(::SetCurrentDirectoryA(TestDirectory.c_str()), 0);
632   LongDir.clear();
633   // Generate a relative directory name with absolute length > 248.
634   size_t LongDirLen = 249 - TestDirectory.size();
635   LongDir.assign(LongDirLen, 'a');
636   ASSERT_NO_ERROR(fs::create_directory(Twine(LongDir)));
637   // While we're here, prove that .. and . handling works in these long paths.
638   const char *DotDotDirs = "\\..\\.\\b";
639   LongDir.append(DotDotDirs);
640   ASSERT_NO_ERROR(fs::create_directory("b"));
641   ASSERT_EQ(fs::create_directory(Twine(LongDir), false), errc::file_exists);
642   // And clean up.
643   ASSERT_NO_ERROR(fs::remove("b"));
644   ASSERT_NO_ERROR(fs::remove(
645     Twine(LongDir.substr(0, LongDir.size() - strlen(DotDotDirs)))));
646   ASSERT_NE(::SetCurrentDirectoryA(PreviousDir), 0);
647 #endif
648 }
649 
650 TEST_F(FileSystemTest, DirectoryIteration) {
651   std::error_code ec;
652   for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
653     ASSERT_NO_ERROR(ec);
654 
655   // Create a known hierarchy to recurse over.
656   ASSERT_NO_ERROR(
657       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/aa1"));
658   ASSERT_NO_ERROR(
659       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/ab1"));
660   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) +
661                                          "/recursive/dontlookhere/da1"));
662   ASSERT_NO_ERROR(
663       fs::create_directories(Twine(TestDirectory) + "/recursive/z0/za1"));
664   ASSERT_NO_ERROR(
665       fs::create_directories(Twine(TestDirectory) + "/recursive/pop/p1"));
666   typedef std::vector<std::string> v_t;
667   v_t visited;
668   for (fs::recursive_directory_iterator i(Twine(TestDirectory)
669          + "/recursive", ec), e; i != e; i.increment(ec)){
670     ASSERT_NO_ERROR(ec);
671     if (path::filename(i->path()) == "p1") {
672       i.pop();
673       // FIXME: recursive_directory_iterator should be more robust.
674       if (i == e) break;
675     }
676     if (path::filename(i->path()) == "dontlookhere")
677       i.no_push();
678     visited.push_back(path::filename(i->path()));
679   }
680   v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
681   v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
682   v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
683   v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
684                                                "dontlookhere");
685   v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
686   v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
687   v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
688   v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
689   v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
690 
691   // Make sure that each path was visited correctly.
692   ASSERT_NE(a0, visited.end());
693   ASSERT_NE(aa1, visited.end());
694   ASSERT_NE(ab1, visited.end());
695   ASSERT_NE(dontlookhere, visited.end());
696   ASSERT_EQ(da1, visited.end()); // Not visited.
697   ASSERT_NE(z0, visited.end());
698   ASSERT_NE(za1, visited.end());
699   ASSERT_NE(pop, visited.end());
700   ASSERT_EQ(p1, visited.end()); // Not visited.
701 
702   // Make sure that parents were visited before children. No other ordering
703   // guarantees can be made across siblings.
704   ASSERT_LT(a0, aa1);
705   ASSERT_LT(a0, ab1);
706   ASSERT_LT(z0, za1);
707 
708   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/aa1"));
709   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/ab1"));
710   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0"));
711   ASSERT_NO_ERROR(
712       fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere/da1"));
713   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere"));
714   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop/p1"));
715   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop"));
716   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0/za1"));
717   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0"));
718   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive"));
719 }
720 
721 const char archive[] = "!<arch>\x0A";
722 const char bitcode[] = "\xde\xc0\x17\x0b";
723 const char coff_object[] = "\x00\x00......";
724 const char coff_bigobj[] = "\x00\x00\xff\xff\x00\x02......"
725     "\xc7\xa1\xba\xd1\xee\xba\xa9\x4b\xaf\x20\xfa\xf6\x6a\xa4\xdc\xb8";
726 const char coff_import_library[] = "\x00\x00\xff\xff....";
727 const char elf_relocatable[] = { 0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0,
728                                  0,    0,   0,   0,   0, 0, 0, 0, 1 };
729 const char macho_universal_binary[] = "\xca\xfe\xba\xbe...\x00";
730 const char macho_object[] =
731     "\xfe\xed\xfa\xce........\x00\x00\x00\x01............";
732 const char macho_executable[] =
733     "\xfe\xed\xfa\xce........\x00\x00\x00\x02............";
734 const char macho_fixed_virtual_memory_shared_lib[] =
735     "\xfe\xed\xfa\xce........\x00\x00\x00\x03............";
736 const char macho_core[] =
737     "\xfe\xed\xfa\xce........\x00\x00\x00\x04............";
738 const char macho_preload_executable[] =
739     "\xfe\xed\xfa\xce........\x00\x00\x00\x05............";
740 const char macho_dynamically_linked_shared_lib[] =
741     "\xfe\xed\xfa\xce........\x00\x00\x00\x06............";
742 const char macho_dynamic_linker[] =
743     "\xfe\xed\xfa\xce........\x00\x00\x00\x07............";
744 const char macho_bundle[] =
745     "\xfe\xed\xfa\xce........\x00\x00\x00\x08............";
746 const char macho_dsym_companion[] =
747     "\xfe\xed\xfa\xce........\x00\x00\x00\x0a............";
748 const char macho_kext_bundle[] =
749     "\xfe\xed\xfa\xce........\x00\x00\x00\x0b............";
750 const char windows_resource[] = "\x00\x00\x00\x00\x020\x00\x00\x00\xff";
751 const char macho_dynamically_linked_shared_lib_stub[] =
752     "\xfe\xed\xfa\xce........\x00\x00\x00\x09............";
753 
754 TEST_F(FileSystemTest, Magic) {
755   struct type {
756     const char *filename;
757     const char *magic_str;
758     size_t magic_str_len;
759     fs::file_magic magic;
760   } types[] = {
761 #define DEFINE(magic)                                           \
762     { #magic, magic, sizeof(magic), fs::file_magic::magic }
763     DEFINE(archive),
764     DEFINE(bitcode),
765     DEFINE(coff_object),
766     { "coff_bigobj", coff_bigobj, sizeof(coff_bigobj), fs::file_magic::coff_object },
767     DEFINE(coff_import_library),
768     DEFINE(elf_relocatable),
769     DEFINE(macho_universal_binary),
770     DEFINE(macho_object),
771     DEFINE(macho_executable),
772     DEFINE(macho_fixed_virtual_memory_shared_lib),
773     DEFINE(macho_core),
774     DEFINE(macho_preload_executable),
775     DEFINE(macho_dynamically_linked_shared_lib),
776     DEFINE(macho_dynamic_linker),
777     DEFINE(macho_bundle),
778     DEFINE(macho_dynamically_linked_shared_lib_stub),
779     DEFINE(macho_dsym_companion),
780     DEFINE(macho_kext_bundle),
781     DEFINE(windows_resource)
782 #undef DEFINE
783     };
784 
785   // Create some files filled with magic.
786   for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
787                                                                      ++i) {
788     SmallString<128> file_pathname(TestDirectory);
789     path::append(file_pathname, i->filename);
790     std::error_code EC;
791     raw_fd_ostream file(file_pathname, EC, sys::fs::F_None);
792     ASSERT_FALSE(file.has_error());
793     StringRef magic(i->magic_str, i->magic_str_len);
794     file << magic;
795     file.close();
796     EXPECT_EQ(i->magic, fs::identify_magic(magic));
797     ASSERT_NO_ERROR(fs::remove(Twine(file_pathname)));
798   }
799 }
800 
801 #ifdef LLVM_ON_WIN32
802 TEST_F(FileSystemTest, CarriageReturn) {
803   SmallString<128> FilePathname(TestDirectory);
804   std::error_code EC;
805   path::append(FilePathname, "test");
806 
807   {
808     raw_fd_ostream File(FilePathname, EC, sys::fs::F_Text);
809     ASSERT_NO_ERROR(EC);
810     File << '\n';
811   }
812   {
813     auto Buf = MemoryBuffer::getFile(FilePathname.str());
814     EXPECT_TRUE((bool)Buf);
815     EXPECT_EQ(Buf.get()->getBuffer(), "\r\n");
816   }
817 
818   {
819     raw_fd_ostream File(FilePathname, EC, sys::fs::F_None);
820     ASSERT_NO_ERROR(EC);
821     File << '\n';
822   }
823   {
824     auto Buf = MemoryBuffer::getFile(FilePathname.str());
825     EXPECT_TRUE((bool)Buf);
826     EXPECT_EQ(Buf.get()->getBuffer(), "\n");
827   }
828   ASSERT_NO_ERROR(fs::remove(Twine(FilePathname)));
829 }
830 #endif
831 
832 TEST_F(FileSystemTest, Resize) {
833   int FD;
834   SmallString<64> TempPath;
835   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
836   ASSERT_NO_ERROR(fs::resize_file(FD, 123));
837   fs::file_status Status;
838   ASSERT_NO_ERROR(fs::status(FD, Status));
839   ASSERT_EQ(Status.getSize(), 123U);
840 }
841 
842 TEST_F(FileSystemTest, FileMapping) {
843   // Create a temp file.
844   int FileDescriptor;
845   SmallString<64> TempPath;
846   ASSERT_NO_ERROR(
847       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
848   unsigned Size = 4096;
849   ASSERT_NO_ERROR(fs::resize_file(FileDescriptor, Size));
850 
851   // Map in temp file and add some content
852   std::error_code EC;
853   StringRef Val("hello there");
854   {
855     fs::mapped_file_region mfr(FileDescriptor,
856                                fs::mapped_file_region::readwrite, Size, 0, EC);
857     ASSERT_NO_ERROR(EC);
858     std::copy(Val.begin(), Val.end(), mfr.data());
859     // Explicitly add a 0.
860     mfr.data()[Val.size()] = 0;
861     // Unmap temp file
862   }
863 
864   // Map it back in read-only
865   int FD;
866   EC = fs::openFileForRead(Twine(TempPath), FD);
867   ASSERT_NO_ERROR(EC);
868   fs::mapped_file_region mfr(FD, fs::mapped_file_region::readonly, Size, 0, EC);
869   ASSERT_NO_ERROR(EC);
870 
871   // Verify content
872   EXPECT_EQ(StringRef(mfr.const_data()), Val);
873 
874   // Unmap temp file
875   fs::mapped_file_region m(FD, fs::mapped_file_region::readonly, Size, 0, EC);
876   ASSERT_NO_ERROR(EC);
877   ASSERT_EQ(close(FD), 0);
878 }
879 
880 TEST(Support, NormalizePath) {
881 #if defined(LLVM_ON_WIN32)
882 #define EXPECT_PATH_IS(path__, windows__, not_windows__)                        \
883   EXPECT_EQ(path__, windows__);
884 #else
885 #define EXPECT_PATH_IS(path__, windows__, not_windows__)                        \
886   EXPECT_EQ(path__, not_windows__);
887 #endif
888 
889   SmallString<64> Path1("a");
890   SmallString<64> Path2("a/b");
891   SmallString<64> Path3("a\\b");
892   SmallString<64> Path4("a\\\\b");
893   SmallString<64> Path5("\\a");
894   SmallString<64> Path6("a\\");
895 
896   path::native(Path1);
897   EXPECT_PATH_IS(Path1, "a", "a");
898 
899   path::native(Path2);
900   EXPECT_PATH_IS(Path2, "a\\b", "a/b");
901 
902   path::native(Path3);
903   EXPECT_PATH_IS(Path3, "a\\b", "a/b");
904 
905   path::native(Path4);
906   EXPECT_PATH_IS(Path4, "a\\\\b", "a\\\\b");
907 
908   path::native(Path5);
909   EXPECT_PATH_IS(Path5, "\\a", "/a");
910 
911   path::native(Path6);
912   EXPECT_PATH_IS(Path6, "a\\", "a/");
913 
914 #undef EXPECT_PATH_IS
915 }
916 
917 TEST(Support, RemoveLeadingDotSlash) {
918   StringRef Path1("././/foolz/wat");
919   StringRef Path2("./////");
920 
921   Path1 = path::remove_leading_dotslash(Path1);
922   EXPECT_EQ(Path1, "foolz/wat");
923   Path2 = path::remove_leading_dotslash(Path2);
924   EXPECT_EQ(Path2, "");
925 }
926 
927 static std::string remove_dots(StringRef path,
928     bool remove_dot_dot) {
929   SmallString<256> buffer(path);
930   path::remove_dots(buffer, remove_dot_dot);
931   return buffer.str();
932 }
933 
934 TEST(Support, RemoveDots) {
935 #if defined(LLVM_ON_WIN32)
936   EXPECT_EQ("foolz\\wat", remove_dots(".\\.\\\\foolz\\wat", false));
937   EXPECT_EQ("", remove_dots(".\\\\\\\\\\", false));
938 
939   EXPECT_EQ("a\\..\\b\\c", remove_dots(".\\a\\..\\b\\c", false));
940   EXPECT_EQ("b\\c", remove_dots(".\\a\\..\\b\\c", true));
941   EXPECT_EQ("c", remove_dots(".\\.\\c", true));
942 
943   SmallString<64> Path1(".\\.\\c");
944   EXPECT_TRUE(path::remove_dots(Path1, true));
945   EXPECT_EQ("c", Path1);
946 #else
947   EXPECT_EQ("foolz/wat", remove_dots("././/foolz/wat", false));
948   EXPECT_EQ("", remove_dots("./////", false));
949 
950   EXPECT_EQ("a/../b/c", remove_dots("./a/../b/c", false));
951   EXPECT_EQ("b/c", remove_dots("./a/../b/c", true));
952   EXPECT_EQ("c", remove_dots("././c", true));
953 
954   SmallString<64> Path1("././c");
955   EXPECT_TRUE(path::remove_dots(Path1, true));
956   EXPECT_EQ("c", Path1);
957 #endif
958 }
959 } // anonymous namespace
960