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