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 TEST(Support, UserCacheDirectory) {
326   SmallString<13> CacheDir;
327   SmallString<20> CacheDir2;
328   auto Status = path::user_cache_directory(CacheDir, "");
329   EXPECT_TRUE(Status ^ CacheDir.empty());
330 
331   if (Status) {
332     EXPECT_TRUE(path::user_cache_directory(CacheDir2, "")); // should succeed
333     EXPECT_EQ(CacheDir, CacheDir2); // and return same paths
334 
335     EXPECT_TRUE(path::user_cache_directory(CacheDir, "A", "B", "file.c"));
336     auto It = path::rbegin(CacheDir);
337     EXPECT_EQ("file.c", *It);
338     EXPECT_EQ("B", *++It);
339     EXPECT_EQ("A", *++It);
340     auto ParentDir = *++It;
341 
342     // Test Unicode: "<user_cache_dir>/(pi)r^2/aleth.0"
343     EXPECT_TRUE(path::user_cache_directory(CacheDir2, "\xCF\x80r\xC2\xB2",
344                                            "\xE2\x84\xB5.0"));
345     auto It2 = path::rbegin(CacheDir2);
346     EXPECT_EQ("\xE2\x84\xB5.0", *It2);
347     EXPECT_EQ("\xCF\x80r\xC2\xB2", *++It2);
348     auto ParentDir2 = *++It2;
349 
350     EXPECT_EQ(ParentDir, ParentDir2);
351   }
352 }
353 
354 class FileSystemTest : public testing::Test {
355 protected:
356   /// Unique temporary directory in which all created filesystem entities must
357   /// be placed. It is removed at the end of each test (must be empty).
358   SmallString<128> TestDirectory;
359 
360   void SetUp() override {
361     ASSERT_NO_ERROR(
362         fs::createUniqueDirectory("file-system-test", TestDirectory));
363     // We don't care about this specific file.
364     errs() << "Test Directory: " << TestDirectory << '\n';
365     errs().flush();
366   }
367 
368   void TearDown() override { ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); }
369 };
370 
371 TEST_F(FileSystemTest, Unique) {
372   // Create a temp file.
373   int FileDescriptor;
374   SmallString<64> TempPath;
375   ASSERT_NO_ERROR(
376       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
377 
378   // The same file should return an identical unique id.
379   fs::UniqueID F1, F2;
380   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
381   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
382   ASSERT_EQ(F1, F2);
383 
384   // Different files should return different unique ids.
385   int FileDescriptor2;
386   SmallString<64> TempPath2;
387   ASSERT_NO_ERROR(
388       fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
389 
390   fs::UniqueID D;
391   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
392   ASSERT_NE(D, F1);
393   ::close(FileDescriptor2);
394 
395   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
396 
397   // Two paths representing the same file on disk should still provide the
398   // same unique id.  We can test this by making a hard link.
399   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
400   fs::UniqueID D2;
401   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
402   ASSERT_EQ(D2, F1);
403 
404   ::close(FileDescriptor);
405 
406   SmallString<128> Dir1;
407   ASSERT_NO_ERROR(
408      fs::createUniqueDirectory("dir1", Dir1));
409   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F1));
410   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F2));
411   ASSERT_EQ(F1, F2);
412 
413   SmallString<128> Dir2;
414   ASSERT_NO_ERROR(
415      fs::createUniqueDirectory("dir2", Dir2));
416   ASSERT_NO_ERROR(fs::getUniqueID(Dir2.c_str(), F2));
417   ASSERT_NE(F1, F2);
418 }
419 
420 TEST_F(FileSystemTest, TempFiles) {
421   // Create a temp file.
422   int FileDescriptor;
423   SmallString<64> TempPath;
424   ASSERT_NO_ERROR(
425       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
426 
427   // Make sure it exists.
428   ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
429 
430   // Create another temp tile.
431   int FD2;
432   SmallString<64> TempPath2;
433   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
434   ASSERT_TRUE(TempPath2.endswith(".temp"));
435   ASSERT_NE(TempPath.str(), TempPath2.str());
436 
437   fs::file_status A, B;
438   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
439   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
440   EXPECT_FALSE(fs::equivalent(A, B));
441 
442   ::close(FD2);
443 
444   // Remove Temp2.
445   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
446   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
447   ASSERT_EQ(fs::remove(Twine(TempPath2), false),
448             errc::no_such_file_or_directory);
449 
450   std::error_code EC = fs::status(TempPath2.c_str(), B);
451   EXPECT_EQ(EC, errc::no_such_file_or_directory);
452   EXPECT_EQ(B.type(), fs::file_type::file_not_found);
453 
454   // Make sure Temp2 doesn't exist.
455   ASSERT_EQ(fs::access(Twine(TempPath2), sys::fs::AccessMode::Exist),
456             errc::no_such_file_or_directory);
457 
458   SmallString<64> TempPath3;
459   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
460   ASSERT_FALSE(TempPath3.endswith("."));
461 
462   // Create a hard link to Temp1.
463   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
464   bool equal;
465   ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
466   EXPECT_TRUE(equal);
467   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
468   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
469   EXPECT_TRUE(fs::equivalent(A, B));
470 
471   // Remove Temp1.
472   ::close(FileDescriptor);
473   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
474 
475   // Remove the hard link.
476   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
477 
478   // Make sure Temp1 doesn't exist.
479   ASSERT_EQ(fs::access(Twine(TempPath), sys::fs::AccessMode::Exist),
480             errc::no_such_file_or_directory);
481 
482 #ifdef LLVM_ON_WIN32
483   // Path name > 260 chars should get an error.
484   const char *Path270 =
485     "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
486     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
487     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
488     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
489     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
490   EXPECT_EQ(fs::createUniqueFile(Path270, FileDescriptor, TempPath),
491             errc::invalid_argument);
492   // Relative path < 247 chars, no problem.
493   const char *Path216 =
494     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
495     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
496     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
497     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
498   ASSERT_NO_ERROR(fs::createTemporaryFile(Path216, "", TempPath));
499   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
500 #endif
501 }
502 
503 TEST_F(FileSystemTest, CreateDir) {
504   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
505   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
506   ASSERT_EQ(fs::create_directory(Twine(TestDirectory) + "foo", false),
507             errc::file_exists);
508   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "foo"));
509 
510 #ifdef LLVM_ON_UNIX
511   // Set a 0000 umask so that we can test our directory permissions.
512   mode_t OldUmask = ::umask(0000);
513 
514   fs::file_status Status;
515   ASSERT_NO_ERROR(
516       fs::create_directory(Twine(TestDirectory) + "baz500", false,
517                            fs::perms::owner_read | fs::perms::owner_exe));
518   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz500", Status));
519   ASSERT_EQ(Status.permissions() & fs::perms::all_all,
520             fs::perms::owner_read | fs::perms::owner_exe);
521   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "baz777", false,
522                                        fs::perms::all_all));
523   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz777", Status));
524   ASSERT_EQ(Status.permissions() & fs::perms::all_all, fs::perms::all_all);
525 
526   // Restore umask to be safe.
527   ::umask(OldUmask);
528 #endif
529 
530 #ifdef LLVM_ON_WIN32
531   // Prove that create_directories() can handle a pathname > 248 characters,
532   // which is the documented limit for CreateDirectory().
533   // (248 is MAX_PATH subtracting room for an 8.3 filename.)
534   // Generate a directory path guaranteed to fall into that range.
535   size_t TmpLen = TestDirectory.size();
536   const char *OneDir = "\\123456789";
537   size_t OneDirLen = strlen(OneDir);
538   ASSERT_LT(OneDirLen, 12U);
539   size_t NLevels = ((248 - TmpLen) / OneDirLen) + 1;
540   SmallString<260> LongDir(TestDirectory);
541   for (size_t I = 0; I < NLevels; ++I)
542     LongDir.append(OneDir);
543   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
544   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
545   ASSERT_EQ(fs::create_directories(Twine(LongDir), false),
546             errc::file_exists);
547   // Tidy up, "recursively" removing the directories.
548   StringRef ThisDir(LongDir);
549   for (size_t J = 0; J < NLevels; ++J) {
550     ASSERT_NO_ERROR(fs::remove(ThisDir));
551     ThisDir = path::parent_path(ThisDir);
552   }
553 
554   // Similarly for a relative pathname.  Need to set the current directory to
555   // TestDirectory so that the one we create ends up in the right place.
556   char PreviousDir[260];
557   size_t PreviousDirLen = ::GetCurrentDirectoryA(260, PreviousDir);
558   ASSERT_GT(PreviousDirLen, 0U);
559   ASSERT_LT(PreviousDirLen, 260U);
560   ASSERT_NE(::SetCurrentDirectoryA(TestDirectory.c_str()), 0);
561   LongDir.clear();
562   // Generate a relative directory name with absolute length > 248.
563   size_t LongDirLen = 249 - TestDirectory.size();
564   LongDir.assign(LongDirLen, 'a');
565   ASSERT_NO_ERROR(fs::create_directory(Twine(LongDir)));
566   // While we're here, prove that .. and . handling works in these long paths.
567   const char *DotDotDirs = "\\..\\.\\b";
568   LongDir.append(DotDotDirs);
569   ASSERT_NO_ERROR(fs::create_directory("b"));
570   ASSERT_EQ(fs::create_directory(Twine(LongDir), false), errc::file_exists);
571   // And clean up.
572   ASSERT_NO_ERROR(fs::remove("b"));
573   ASSERT_NO_ERROR(fs::remove(
574     Twine(LongDir.substr(0, LongDir.size() - strlen(DotDotDirs)))));
575   ASSERT_NE(::SetCurrentDirectoryA(PreviousDir), 0);
576 #endif
577 }
578 
579 TEST_F(FileSystemTest, DirectoryIteration) {
580   std::error_code ec;
581   for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
582     ASSERT_NO_ERROR(ec);
583 
584   // Create a known hierarchy to recurse over.
585   ASSERT_NO_ERROR(
586       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/aa1"));
587   ASSERT_NO_ERROR(
588       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/ab1"));
589   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) +
590                                          "/recursive/dontlookhere/da1"));
591   ASSERT_NO_ERROR(
592       fs::create_directories(Twine(TestDirectory) + "/recursive/z0/za1"));
593   ASSERT_NO_ERROR(
594       fs::create_directories(Twine(TestDirectory) + "/recursive/pop/p1"));
595   typedef std::vector<std::string> v_t;
596   v_t visited;
597   for (fs::recursive_directory_iterator i(Twine(TestDirectory)
598          + "/recursive", ec), e; i != e; i.increment(ec)){
599     ASSERT_NO_ERROR(ec);
600     if (path::filename(i->path()) == "p1") {
601       i.pop();
602       // FIXME: recursive_directory_iterator should be more robust.
603       if (i == e) break;
604     }
605     if (path::filename(i->path()) == "dontlookhere")
606       i.no_push();
607     visited.push_back(path::filename(i->path()));
608   }
609   v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
610   v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
611   v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
612   v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
613                                                "dontlookhere");
614   v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
615   v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
616   v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
617   v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
618   v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
619 
620   // Make sure that each path was visited correctly.
621   ASSERT_NE(a0, visited.end());
622   ASSERT_NE(aa1, visited.end());
623   ASSERT_NE(ab1, visited.end());
624   ASSERT_NE(dontlookhere, visited.end());
625   ASSERT_EQ(da1, visited.end()); // Not visited.
626   ASSERT_NE(z0, visited.end());
627   ASSERT_NE(za1, visited.end());
628   ASSERT_NE(pop, visited.end());
629   ASSERT_EQ(p1, visited.end()); // Not visited.
630 
631   // Make sure that parents were visited before children. No other ordering
632   // guarantees can be made across siblings.
633   ASSERT_LT(a0, aa1);
634   ASSERT_LT(a0, ab1);
635   ASSERT_LT(z0, za1);
636 
637   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/aa1"));
638   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/ab1"));
639   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0"));
640   ASSERT_NO_ERROR(
641       fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere/da1"));
642   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere"));
643   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop/p1"));
644   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop"));
645   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0/za1"));
646   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0"));
647   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive"));
648 }
649 
650 const char archive[] = "!<arch>\x0A";
651 const char bitcode[] = "\xde\xc0\x17\x0b";
652 const char coff_object[] = "\x00\x00......";
653 const char coff_bigobj[] = "\x00\x00\xff\xff\x00\x02......"
654     "\xc7\xa1\xba\xd1\xee\xba\xa9\x4b\xaf\x20\xfa\xf6\x6a\xa4\xdc\xb8";
655 const char coff_import_library[] = "\x00\x00\xff\xff....";
656 const char elf_relocatable[] = { 0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0,
657                                  0,    0,   0,   0,   0, 0, 0, 0, 1 };
658 const char macho_universal_binary[] = "\xca\xfe\xba\xbe...\0x00";
659 const char macho_object[] = "\xfe\xed\xfa\xce..........\x00\x01";
660 const char macho_executable[] = "\xfe\xed\xfa\xce..........\x00\x02";
661 const char macho_fixed_virtual_memory_shared_lib[] =
662     "\xfe\xed\xfa\xce..........\x00\x03";
663 const char macho_core[] = "\xfe\xed\xfa\xce..........\x00\x04";
664 const char macho_preload_executable[] = "\xfe\xed\xfa\xce..........\x00\x05";
665 const char macho_dynamically_linked_shared_lib[] =
666     "\xfe\xed\xfa\xce..........\x00\x06";
667 const char macho_dynamic_linker[] = "\xfe\xed\xfa\xce..........\x00\x07";
668 const char macho_bundle[] = "\xfe\xed\xfa\xce..........\x00\x08";
669 const char macho_dsym_companion[] = "\xfe\xed\xfa\xce..........\x00\x0a";
670 const char macho_kext_bundle[] = "\xfe\xed\xfa\xce..........\x00\x0b";
671 const char windows_resource[] = "\x00\x00\x00\x00\x020\x00\x00\x00\xff";
672 const char macho_dynamically_linked_shared_lib_stub[] =
673     "\xfe\xed\xfa\xce..........\x00\x09";
674 
675 TEST_F(FileSystemTest, Magic) {
676   struct type {
677     const char *filename;
678     const char *magic_str;
679     size_t magic_str_len;
680     fs::file_magic magic;
681   } types[] = {
682 #define DEFINE(magic)                                           \
683     { #magic, magic, sizeof(magic), fs::file_magic::magic }
684     DEFINE(archive),
685     DEFINE(bitcode),
686     DEFINE(coff_object),
687     { "coff_bigobj", coff_bigobj, sizeof(coff_bigobj), fs::file_magic::coff_object },
688     DEFINE(coff_import_library),
689     DEFINE(elf_relocatable),
690     DEFINE(macho_universal_binary),
691     DEFINE(macho_object),
692     DEFINE(macho_executable),
693     DEFINE(macho_fixed_virtual_memory_shared_lib),
694     DEFINE(macho_core),
695     DEFINE(macho_preload_executable),
696     DEFINE(macho_dynamically_linked_shared_lib),
697     DEFINE(macho_dynamic_linker),
698     DEFINE(macho_bundle),
699     DEFINE(macho_dynamically_linked_shared_lib_stub),
700     DEFINE(macho_dsym_companion),
701     DEFINE(macho_kext_bundle),
702     DEFINE(windows_resource)
703 #undef DEFINE
704     };
705 
706   // Create some files filled with magic.
707   for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
708                                                                      ++i) {
709     SmallString<128> file_pathname(TestDirectory);
710     path::append(file_pathname, i->filename);
711     std::error_code EC;
712     raw_fd_ostream file(file_pathname, EC, sys::fs::F_None);
713     ASSERT_FALSE(file.has_error());
714     StringRef magic(i->magic_str, i->magic_str_len);
715     file << magic;
716     file.close();
717     EXPECT_EQ(i->magic, fs::identify_magic(magic));
718     ASSERT_NO_ERROR(fs::remove(Twine(file_pathname)));
719   }
720 }
721 
722 #ifdef LLVM_ON_WIN32
723 TEST_F(FileSystemTest, CarriageReturn) {
724   SmallString<128> FilePathname(TestDirectory);
725   std::error_code EC;
726   path::append(FilePathname, "test");
727 
728   {
729     raw_fd_ostream File(FilePathname, EC, sys::fs::F_Text);
730     ASSERT_NO_ERROR(EC);
731     File << '\n';
732   }
733   {
734     auto Buf = MemoryBuffer::getFile(FilePathname.str());
735     EXPECT_TRUE((bool)Buf);
736     EXPECT_EQ(Buf.get()->getBuffer(), "\r\n");
737   }
738 
739   {
740     raw_fd_ostream File(FilePathname, EC, sys::fs::F_None);
741     ASSERT_NO_ERROR(EC);
742     File << '\n';
743   }
744   {
745     auto Buf = MemoryBuffer::getFile(FilePathname.str());
746     EXPECT_TRUE((bool)Buf);
747     EXPECT_EQ(Buf.get()->getBuffer(), "\n");
748   }
749   ASSERT_NO_ERROR(fs::remove(Twine(FilePathname)));
750 }
751 #endif
752 
753 TEST_F(FileSystemTest, Resize) {
754   int FD;
755   SmallString<64> TempPath;
756   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
757   ASSERT_NO_ERROR(fs::resize_file(FD, 123));
758   fs::file_status Status;
759   ASSERT_NO_ERROR(fs::status(FD, Status));
760   ASSERT_EQ(Status.getSize(), 123U);
761 }
762 
763 TEST_F(FileSystemTest, FileMapping) {
764   // Create a temp file.
765   int FileDescriptor;
766   SmallString<64> TempPath;
767   ASSERT_NO_ERROR(
768       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
769   unsigned Size = 4096;
770   ASSERT_NO_ERROR(fs::resize_file(FileDescriptor, Size));
771 
772   // Map in temp file and add some content
773   std::error_code EC;
774   StringRef Val("hello there");
775   {
776     fs::mapped_file_region mfr(FileDescriptor,
777                                fs::mapped_file_region::readwrite, Size, 0, EC);
778     ASSERT_NO_ERROR(EC);
779     std::copy(Val.begin(), Val.end(), mfr.data());
780     // Explicitly add a 0.
781     mfr.data()[Val.size()] = 0;
782     // Unmap temp file
783   }
784 
785   // Map it back in read-only
786   int FD;
787   EC = fs::openFileForRead(Twine(TempPath), FD);
788   ASSERT_NO_ERROR(EC);
789   fs::mapped_file_region mfr(FD, fs::mapped_file_region::readonly, Size, 0, EC);
790   ASSERT_NO_ERROR(EC);
791 
792   // Verify content
793   EXPECT_EQ(StringRef(mfr.const_data()), Val);
794 
795   // Unmap temp file
796   fs::mapped_file_region m(FD, fs::mapped_file_region::readonly, Size, 0, EC);
797   ASSERT_NO_ERROR(EC);
798   ASSERT_EQ(close(FD), 0);
799 }
800 
801 TEST(Support, NormalizePath) {
802 #if defined(LLVM_ON_WIN32)
803 #define EXPECT_PATH_IS(path__, windows__, not_windows__)                        \
804   EXPECT_EQ(path__, windows__);
805 #else
806 #define EXPECT_PATH_IS(path__, windows__, not_windows__)                        \
807   EXPECT_EQ(path__, not_windows__);
808 #endif
809 
810   SmallString<64> Path1("a");
811   SmallString<64> Path2("a/b");
812   SmallString<64> Path3("a\\b");
813   SmallString<64> Path4("a\\\\b");
814   SmallString<64> Path5("\\a");
815   SmallString<64> Path6("a\\");
816 
817   path::native(Path1);
818   EXPECT_PATH_IS(Path1, "a", "a");
819 
820   path::native(Path2);
821   EXPECT_PATH_IS(Path2, "a\\b", "a/b");
822 
823   path::native(Path3);
824   EXPECT_PATH_IS(Path3, "a\\b", "a/b");
825 
826   path::native(Path4);
827   EXPECT_PATH_IS(Path4, "a\\\\b", "a\\\\b");
828 
829   path::native(Path5);
830   EXPECT_PATH_IS(Path5, "\\a", "/a");
831 
832   path::native(Path6);
833   EXPECT_PATH_IS(Path6, "a\\", "a/");
834 
835 #undef EXPECT_PATH_IS
836 }
837 
838 TEST(Support, RemoveLeadingDotSlash) {
839   StringRef Path1("././/foolz/wat");
840   StringRef Path2("./////");
841 
842   Path1 = path::remove_leading_dotslash(Path1);
843   EXPECT_EQ(Path1, "foolz/wat");
844   Path2 = path::remove_leading_dotslash(Path2);
845   EXPECT_EQ(Path2, "");
846 }
847 
848 static std::string remove_dots(StringRef path,
849     bool remove_dot_dot) {
850   SmallString<256> buffer(path);
851   path::remove_dots(buffer, remove_dot_dot);
852   return buffer.str();
853 }
854 
855 TEST(Support, RemoveDots) {
856 #if defined(LLVM_ON_WIN32)
857   EXPECT_EQ("foolz\\wat", remove_dots(".\\.\\\\foolz\\wat", false));
858   EXPECT_EQ("", remove_dots(".\\\\\\\\\\", false));
859 
860   EXPECT_EQ("a\\..\\b\\c", remove_dots(".\\a\\..\\b\\c", false));
861   EXPECT_EQ("b\\c", remove_dots(".\\a\\..\\b\\c", true));
862   EXPECT_EQ("c", remove_dots(".\\.\\c", true));
863 
864   SmallString<64> Path1(".\\.\\c");
865   EXPECT_TRUE(path::remove_dots(Path1, true));
866   EXPECT_EQ("c", Path1);
867 #else
868   EXPECT_EQ("foolz/wat", remove_dots("././/foolz/wat", false));
869   EXPECT_EQ("", remove_dots("./////", false));
870 
871   EXPECT_EQ("a/../b/c", remove_dots("./a/../b/c", false));
872   EXPECT_EQ("b/c", remove_dots("./a/../b/c", true));
873   EXPECT_EQ("c", remove_dots("././c", true));
874 
875   SmallString<64> Path1("././c");
876   EXPECT_TRUE(path::remove_dots(Path1, true));
877   EXPECT_EQ("c", Path1);
878 #endif
879 }
880 } // anonymous namespace
881