1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/Path.h"
11 #include "llvm/Support/ErrorHandling.h"
12 #include "llvm/Support/FileSystem.h"
13 #include "llvm/Support/MemoryBuffer.h"
14 #include "llvm/Support/raw_ostream.h"
15 #include "gtest/gtest.h"
22 using namespace llvm::sys;
23 using std::error_code;
25 #define ASSERT_NO_ERROR(x) \
26 if (error_code ASSERT_NO_ERROR_ec = x) { \
27 SmallString<128> MessageStorage; \
28 raw_svector_ostream Message(MessageStorage); \
29 Message << #x ": did not return errc::success.\n" \
30 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
31 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
32 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
37 TEST(is_separator, Works) {
38 EXPECT_TRUE(path::is_separator('/'));
39 EXPECT_FALSE(path::is_separator('\0'));
40 EXPECT_FALSE(path::is_separator('-'));
41 EXPECT_FALSE(path::is_separator(' '));
44 EXPECT_TRUE(path::is_separator('\\'));
46 EXPECT_FALSE(path::is_separator('\\'));
51 SmallVector<StringRef, 40> paths;
54 paths.push_back("..");
55 paths.push_back("foo");
57 paths.push_back("/foo");
58 paths.push_back("foo/");
59 paths.push_back("/foo/");
60 paths.push_back("foo/bar");
61 paths.push_back("/foo/bar");
62 paths.push_back("//net");
63 paths.push_back("//net/foo");
64 paths.push_back("///foo///");
65 paths.push_back("///foo///bar");
66 paths.push_back("/.");
67 paths.push_back("./");
68 paths.push_back("/..");
69 paths.push_back("../");
70 paths.push_back("foo/.");
71 paths.push_back("foo/..");
72 paths.push_back("foo/./");
73 paths.push_back("foo/./bar");
74 paths.push_back("foo/..");
75 paths.push_back("foo/../");
76 paths.push_back("foo/../bar");
77 paths.push_back("c:");
78 paths.push_back("c:/");
79 paths.push_back("c:foo");
80 paths.push_back("c:/foo");
81 paths.push_back("c:foo/");
82 paths.push_back("c:/foo/");
83 paths.push_back("c:/foo/bar");
84 paths.push_back("prn:");
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/");
91 paths.push_back("c:/foo\\bar");
93 for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
97 for (sys::path::const_iterator ci = sys::path::begin(*i),
98 ce = sys::path::end(*i);
101 ASSERT_FALSE(ci->empty());
104 #if 0 // Valgrind is whining about this.
105 outs() << " Reverse Iteration: [";
106 for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
107 ce = sys::path::rend(*i);
110 outs() << *ci << ',';
115 path::has_root_path(*i);
117 path::has_root_name(*i);
119 path::has_root_directory(*i);
120 path::root_directory(*i);
121 path::has_parent_path(*i);
122 path::parent_path(*i);
123 path::has_filename(*i);
127 path::has_extension(*i);
129 path::is_absolute(*i);
130 path::is_relative(*i);
132 SmallString<128> temp_store;
134 ASSERT_NO_ERROR(fs::make_absolute(temp_store));
136 path::remove_filename(temp_store);
139 path::replace_extension(temp_store, "ext");
140 StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
141 stem = path::stem(filename);
142 ext = path::extension(filename);
143 EXPECT_EQ(*(--sys::path::end(filename)), (stem + ext).str());
145 path::native(*i, temp_store);
149 TEST(Support, RelativePathIterator) {
150 SmallString<64> Path(StringRef("c/d/e/foo.txt"));
151 typedef SmallVector<StringRef, 4> PathComponents;
152 PathComponents ExpectedPathComponents;
153 PathComponents ActualPathComponents;
155 StringRef(Path).split(ExpectedPathComponents, "/");
157 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
159 ActualPathComponents.push_back(*I);
162 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
164 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
165 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
169 TEST(Support, AbsolutePathIterator) {
170 SmallString<64> Path(StringRef("/c/d/e/foo.txt"));
171 typedef SmallVector<StringRef, 4> PathComponents;
172 PathComponents ExpectedPathComponents;
173 PathComponents ActualPathComponents;
175 StringRef(Path).split(ExpectedPathComponents, "/");
177 // The root path will also be a component when iterating
178 ExpectedPathComponents[0] = "/";
180 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
182 ActualPathComponents.push_back(*I);
185 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
187 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
188 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
193 TEST(Support, AbsolutePathIteratorWin32) {
194 SmallString<64> Path(StringRef("c:\\c\\e\\foo.txt"));
195 typedef SmallVector<StringRef, 4> PathComponents;
196 PathComponents ExpectedPathComponents;
197 PathComponents ActualPathComponents;
199 StringRef(Path).split(ExpectedPathComponents, "\\");
201 // The root path (which comes after the drive name) will also be a component
203 ExpectedPathComponents.insert(ExpectedPathComponents.begin()+1, "\\");
205 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
207 ActualPathComponents.push_back(*I);
210 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
212 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
213 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
216 #endif // LLVM_ON_WIN32
218 TEST(Support, AbsolutePathIteratorEnd) {
219 // Trailing slashes are converted to '.' unless they are part of the root path.
220 SmallVector<StringRef, 4> Paths;
221 Paths.push_back("/foo/");
222 Paths.push_back("/foo//");
223 Paths.push_back("//net//");
225 Paths.push_back("c:\\\\");
228 for (StringRef Path : Paths) {
229 StringRef LastComponent = *--path::end(Path);
230 EXPECT_EQ(".", LastComponent);
233 SmallVector<StringRef, 3> RootPaths;
234 RootPaths.push_back("/");
235 RootPaths.push_back("//net/");
237 RootPaths.push_back("c:\\");
240 for (StringRef Path : RootPaths) {
241 StringRef LastComponent = *--path::end(Path);
242 EXPECT_EQ(1u, LastComponent.size());
243 EXPECT_TRUE(path::is_separator(LastComponent[0]));
247 TEST(Support, HomeDirectory) {
249 // This test only makes sense on Unix if $HOME is set.
250 if (::getenv("HOME")) {
252 SmallString<128> HomeDir;
253 EXPECT_TRUE(path::home_directory(HomeDir));
254 EXPECT_FALSE(HomeDir.empty());
260 class FileSystemTest : public testing::Test {
262 /// Unique temporary directory in which all created filesystem entities must
263 /// be placed. It is recursively removed at the end of each test.
264 SmallString<128> TestDirectory;
266 virtual void SetUp() {
268 fs::createUniqueDirectory("file-system-test", TestDirectory));
269 // We don't care about this specific file.
270 errs() << "Test Directory: " << TestDirectory << '\n';
274 virtual void TearDown() {
275 ASSERT_NO_ERROR(fs::remove(TestDirectory.str()));
279 TEST_F(FileSystemTest, Unique) {
280 // Create a temp file.
282 SmallString<64> TempPath;
284 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
286 // The same file should return an identical unique id.
288 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
289 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
292 // Different files should return different unique ids.
294 SmallString<64> TempPath2;
296 fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
299 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
301 ::close(FileDescriptor2);
303 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
305 // Two paths representing the same file on disk should still provide the
306 // same unique id. We can test this by making a hard link.
307 ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
309 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
312 ::close(FileDescriptor);
314 SmallString<128> Dir1;
316 fs::createUniqueDirectory("dir1", Dir1));
317 ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F1));
318 ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F2));
321 SmallString<128> Dir2;
323 fs::createUniqueDirectory("dir2", Dir2));
324 ASSERT_NO_ERROR(fs::getUniqueID(Dir2.c_str(), F2));
328 TEST_F(FileSystemTest, TempFiles) {
329 // Create a temp file.
331 SmallString<64> TempPath;
333 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
335 // Make sure it exists.
337 ASSERT_NO_ERROR(sys::fs::exists(Twine(TempPath), TempFileExists));
338 EXPECT_TRUE(TempFileExists);
340 // Create another temp tile.
342 SmallString<64> TempPath2;
343 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
344 ASSERT_TRUE(TempPath2.endswith(".temp"));
345 ASSERT_NE(TempPath.str(), TempPath2.str());
347 fs::file_status A, B;
348 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
349 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
350 EXPECT_FALSE(fs::equivalent(A, B));
355 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
356 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
357 ASSERT_EQ(fs::remove(Twine(TempPath2), false),
358 std::errc::no_such_file_or_directory);
360 error_code EC = fs::status(TempPath2.c_str(), B);
361 EXPECT_EQ(EC, std::errc::no_such_file_or_directory);
362 EXPECT_EQ(B.type(), fs::file_type::file_not_found);
364 // Make sure Temp2 doesn't exist.
365 ASSERT_NO_ERROR(fs::exists(Twine(TempPath2), TempFileExists));
366 EXPECT_FALSE(TempFileExists);
368 SmallString<64> TempPath3;
369 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
370 ASSERT_FALSE(TempPath3.endswith("."));
372 // Create a hard link to Temp1.
373 ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
375 ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
377 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
378 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
379 EXPECT_TRUE(fs::equivalent(A, B));
382 ::close(FileDescriptor);
383 ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
385 // Remove the hard link.
386 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
388 // Make sure Temp1 doesn't exist.
389 ASSERT_NO_ERROR(fs::exists(Twine(TempPath), TempFileExists));
390 EXPECT_FALSE(TempFileExists);
393 // Path name > 260 chars should get an error.
394 const char *Path270 =
395 "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
396 "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
397 "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
398 "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
399 "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
400 EXPECT_EQ(fs::createUniqueFile(Twine(Path270), FileDescriptor, TempPath),
401 std::errc::no_such_file_or_directory);
405 TEST_F(FileSystemTest, CreateDir) {
406 ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
407 ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
408 ASSERT_EQ(fs::create_directory(Twine(TestDirectory) + "foo", false),
409 std::errc::file_exists);
410 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "foo"));
413 TEST_F(FileSystemTest, DirectoryIteration) {
415 for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
418 // Create a known hierarchy to recurse over.
420 fs::create_directories(Twine(TestDirectory) + "/recursive/a0/aa1"));
422 fs::create_directories(Twine(TestDirectory) + "/recursive/a0/ab1"));
423 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) +
424 "/recursive/dontlookhere/da1"));
426 fs::create_directories(Twine(TestDirectory) + "/recursive/z0/za1"));
428 fs::create_directories(Twine(TestDirectory) + "/recursive/pop/p1"));
429 typedef std::vector<std::string> v_t;
431 for (fs::recursive_directory_iterator i(Twine(TestDirectory)
432 + "/recursive", ec), e; i != e; i.increment(ec)){
434 if (path::filename(i->path()) == "p1") {
436 // FIXME: recursive_directory_iterator should be more robust.
439 if (path::filename(i->path()) == "dontlookhere")
441 visited.push_back(path::filename(i->path()));
443 v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
444 v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
445 v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
446 v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
448 v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
449 v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
450 v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
451 v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
452 v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
454 // Make sure that each path was visited correctly.
455 ASSERT_NE(a0, visited.end());
456 ASSERT_NE(aa1, visited.end());
457 ASSERT_NE(ab1, visited.end());
458 ASSERT_NE(dontlookhere, visited.end());
459 ASSERT_EQ(da1, visited.end()); // Not visited.
460 ASSERT_NE(z0, visited.end());
461 ASSERT_NE(za1, visited.end());
462 ASSERT_NE(pop, visited.end());
463 ASSERT_EQ(p1, visited.end()); // Not visited.
465 // Make sure that parents were visited before children. No other ordering
466 // guarantees can be made across siblings.
471 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/aa1"));
472 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/ab1"));
473 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0"));
475 fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere/da1"));
476 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere"));
477 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop/p1"));
478 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop"));
479 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0/za1"));
480 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0"));
481 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive"));
484 const char archive[] = "!<arch>\x0A";
485 const char bitcode[] = "\xde\xc0\x17\x0b";
486 const char coff_object[] = "\x00\x00......";
487 const char coff_import_library[] = "\x00\x00\xff\xff....";
488 const char elf_relocatable[] = { 0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0,
489 0, 0, 0, 0, 0, 0, 0, 0, 1 };
490 const char macho_universal_binary[] = "\xca\xfe\xba\xbe...\0x00";
491 const char macho_object[] = "\xfe\xed\xfa\xce..........\x00\x01";
492 const char macho_executable[] = "\xfe\xed\xfa\xce..........\x00\x02";
493 const char macho_fixed_virtual_memory_shared_lib[] =
494 "\xfe\xed\xfa\xce..........\x00\x03";
495 const char macho_core[] = "\xfe\xed\xfa\xce..........\x00\x04";
496 const char macho_preload_executable[] = "\xfe\xed\xfa\xce..........\x00\x05";
497 const char macho_dynamically_linked_shared_lib[] =
498 "\xfe\xed\xfa\xce..........\x00\x06";
499 const char macho_dynamic_linker[] = "\xfe\xed\xfa\xce..........\x00\x07";
500 const char macho_bundle[] = "\xfe\xed\xfa\xce..........\x00\x08";
501 const char macho_dsym_companion[] = "\xfe\xed\xfa\xce..........\x00\x0a";
502 const char windows_resource[] = "\x00\x00\x00\x00\x020\x00\x00\x00\xff";
504 TEST_F(FileSystemTest, Magic) {
506 const char *filename;
507 const char *magic_str;
508 size_t magic_str_len;
509 fs::file_magic magic;
511 #define DEFINE(magic) \
512 { #magic, magic, sizeof(magic), fs::file_magic::magic }
516 DEFINE(coff_import_library),
517 DEFINE(elf_relocatable),
518 DEFINE(macho_universal_binary),
519 DEFINE(macho_object),
520 DEFINE(macho_executable),
521 DEFINE(macho_fixed_virtual_memory_shared_lib),
523 DEFINE(macho_preload_executable),
524 DEFINE(macho_dynamically_linked_shared_lib),
525 DEFINE(macho_dynamic_linker),
526 DEFINE(macho_bundle),
527 DEFINE(macho_dsym_companion),
528 DEFINE(windows_resource)
532 // Create some files filled with magic.
533 for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
535 SmallString<128> file_pathname(TestDirectory);
536 path::append(file_pathname, i->filename);
538 raw_fd_ostream file(file_pathname.c_str(), ErrMsg, sys::fs::F_None);
539 ASSERT_FALSE(file.has_error());
540 StringRef magic(i->magic_str, i->magic_str_len);
543 EXPECT_EQ(i->magic, fs::identify_magic(magic));
544 ASSERT_NO_ERROR(fs::remove(Twine(file_pathname)));
549 TEST_F(FileSystemTest, CarriageReturn) {
550 SmallString<128> FilePathname(TestDirectory);
552 path::append(FilePathname, "test");
555 raw_fd_ostream File(FilePathname.c_str(), ErrMsg, sys::fs::F_Text);
556 EXPECT_EQ(ErrMsg, "");
560 std::unique_ptr<MemoryBuffer> Buf;
561 MemoryBuffer::getFile(FilePathname.c_str(), Buf);
562 EXPECT_EQ(Buf->getBuffer(), "\r\n");
566 raw_fd_ostream File(FilePathname.c_str(), ErrMsg, sys::fs::F_None);
567 EXPECT_EQ(ErrMsg, "");
571 std::unique_ptr<MemoryBuffer> Buf;
572 MemoryBuffer::getFile(FilePathname.c_str(), Buf);
573 EXPECT_EQ(Buf->getBuffer(), "\n");
575 ASSERT_NO_ERROR(fs::remove(Twine(FilePathname)));
579 TEST_F(FileSystemTest, FileMapping) {
580 // Create a temp file.
582 SmallString<64> TempPath;
584 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
585 // Map in temp file and add some content
587 StringRef Val("hello there");
589 fs::mapped_file_region mfr(FileDescriptor,
591 fs::mapped_file_region::readwrite,
596 std::copy(Val.begin(), Val.end(), mfr.data());
597 // Explicitly add a 0.
598 mfr.data()[Val.size()] = 0;
602 // Map it back in read-only
603 fs::mapped_file_region mfr(Twine(TempPath),
604 fs::mapped_file_region::readonly,
611 EXPECT_EQ(StringRef(mfr.const_data()), Val);
615 fs::mapped_file_region m(Twine(TempPath),
616 fs::mapped_file_region::readonly,
621 const char *Data = m.const_data();
622 fs::mapped_file_region mfrrv(std::move(m));
623 EXPECT_EQ(mfrrv.const_data(), Data);
626 TEST(Support, NormalizePath) {
627 #if defined(LLVM_ON_WIN32)
628 #define EXPECT_PATH_IS(path__, windows__, not_windows__) \
629 EXPECT_EQ(path__, windows__);
631 #define EXPECT_PATH_IS(path__, windows__, not_windows__) \
632 EXPECT_EQ(path__, not_windows__);
635 SmallString<64> Path1("a");
636 SmallString<64> Path2("a/b");
637 SmallString<64> Path3("a\\b");
638 SmallString<64> Path4("a\\\\b");
639 SmallString<64> Path5("\\a");
640 SmallString<64> Path6("a\\");
642 ASSERT_NO_ERROR(fs::normalize_separators(Path1));
643 EXPECT_PATH_IS(Path1, "a", "a");
645 ASSERT_NO_ERROR(fs::normalize_separators(Path2));
646 EXPECT_PATH_IS(Path2, "a/b", "a/b");
648 ASSERT_NO_ERROR(fs::normalize_separators(Path3));
649 EXPECT_PATH_IS(Path3, "a\\b", "a/b");
651 ASSERT_NO_ERROR(fs::normalize_separators(Path4));
652 EXPECT_PATH_IS(Path4, "a\\\\b", "a\\\\b");
654 ASSERT_NO_ERROR(fs::normalize_separators(Path5));
655 EXPECT_PATH_IS(Path5, "\\a", "/a");
657 ASSERT_NO_ERROR(fs::normalize_separators(Path6));
658 EXPECT_PATH_IS(Path6, "a\\", "a/");
660 #undef EXPECT_PATH_IS
662 } // anonymous namespace