1 //===- llvm/Support/Win32/Path.cpp - Win32 Path Implementation ---*- C++ -*-===//
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 // This file provides the Win32 specific implementation of the Path class.
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic Win32 code that
16 //=== is guaranteed to work on *all* Win32 variants.
17 //===----------------------------------------------------------------------===//
23 // We need to undo a macro defined in Windows.h, otherwise we won't compile:
25 #undef GetCurrentDirectory
27 // Windows happily accepts either forward or backward slashes, though any path
28 // returned by a Win32 API will have backward slashes. As LLVM code basically
29 // assumes forward slashes are used, backward slashs are converted where they
30 // can be introduced into a path.
32 // Another invariant is that a path ends with a slash if and only if the path
33 // is a root directory. Any other use of a trailing slash is stripped. Unlike
34 // in Unix, Windows has a rather complicated notion of a root path and this
35 // invariant helps simply the code.
37 static void FlipBackSlashes(std::string& s) {
38 for (size_t i = 0; i < s.size(); i++)
46 const char PathSeparator = ';';
48 StringRef Path::GetEXESuffix() {
52 Path::Path(llvm::StringRef p)
54 FlipBackSlashes(path);
57 Path::Path(const char *StrStart, unsigned StrLen)
58 : path(StrStart, StrLen) {
59 FlipBackSlashes(path);
63 Path::operator=(StringRef that) {
64 path.assign(that.data(), that.size());
65 FlipBackSlashes(path);
70 Path::isValid() const {
74 size_t len = path.size();
75 // If there is a null character, it and all its successors are ignored.
76 size_t pos = path.find_first_of('\0');
77 if (pos != std::string::npos)
80 // If there is a colon, it must be the second character, preceded by a letter
81 // and followed by something.
82 pos = path.rfind(':',len);
84 if (pos != std::string::npos) {
85 if (pos != 1 || !isalpha(path[0]) || len < 3)
90 // Look for a UNC path, and if found adjust our notion of the root slash.
91 if (len > 3 && path[0] == '/' && path[1] == '/') {
92 rootslash = path.find('/', 2);
93 if (rootslash == std::string::npos)
97 // Check for illegal characters.
98 if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
99 "\013\014\015\016\017\020\021\022\023\024\025\026"
100 "\027\030\031\032\033\034\035\036\037")
101 != std::string::npos)
104 // Remove trailing slash, unless it's a root slash.
105 if (len > rootslash+1 && path[len-1] == '/')
108 // Check each component for legality.
109 for (pos = 0; pos < len; ++pos) {
110 // A component may not end in a space.
111 if (path[pos] == ' ') {
112 if (pos+1 == len || path[pos+1] == '/' || path[pos+1] == '\0')
116 // A component may not end in a period.
117 if (path[pos] == '.') {
118 if (pos+1 == len || path[pos+1] == '/') {
119 // Unless it is the pseudo-directory "."...
120 if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
123 if (pos > 0 && path[pos-1] == '.') {
124 if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
135 void Path::makeAbsolute() {
136 TCHAR FullPath[MAX_PATH + 1] = {0};
137 LPTSTR FilePart = NULL;
139 DWORD RetLength = ::GetFullPathNameA(path.c_str(),
140 sizeof(FullPath)/sizeof(FullPath[0]),
141 FullPath, &FilePart);
143 if (0 == RetLength) {
144 // FIXME: Report the error GetLastError()
145 assert(0 && "Unable to make absolute path!");
146 } else if (RetLength > MAX_PATH) {
147 // FIXME: Report too small buffer (needed RetLength bytes).
148 assert(0 && "Unable to make absolute path!");
155 Path::isAbsolute(const char *NameStart, unsigned NameLen) {
157 // FIXME: This does not handle correctly an absolute path starting from
158 // a drive letter or in UNC format.
164 return NameStart[0] == '/';
167 (NameStart[0] == '/' || (NameStart[1] == ':' && NameStart[2] == '/')) ||
168 (NameStart[0] == '\\' || (NameStart[1] == ':' && NameStart[2] == '\\'));
173 Path::isAbsolute() const {
174 // FIXME: This does not handle correctly an absolute path starting from
175 // a drive letter or in UNC format.
176 switch (path.length()) {
181 return path[0] == '/';
183 return path[0] == '/' || (path[1] == ':' && path[2] == '/');
187 static Path *TempDirectory;
190 Path::GetTemporaryDirectory(std::string* ErrMsg) {
192 return *TempDirectory;
194 char pathname[MAX_PATH];
195 if (!GetTempPath(MAX_PATH, pathname)) {
197 *ErrMsg = "Can't determine temporary directory";
202 result.set(pathname);
204 // Append a subdirectory passed on our process id so multiple LLVMs don't
205 // step on each other's toes.
207 // Mingw's Win32 header files are broken.
208 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
210 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
212 result.appendComponent(pathname);
214 // If there's a directory left over from a previous LLVM execution that
215 // happened to have the same process id, get rid of it.
216 result.eraseFromDisk(true);
218 // And finally (re-)create the empty directory.
219 result.createDirectoryOnDisk(false);
220 TempDirectory = new Path(result);
221 return *TempDirectory;
224 // FIXME: the following set of functions don't map to Windows very well.
226 Path::GetRootDirectory() {
227 // This is the only notion that that Windows has of a root directory. Nothing
228 // is here except for drives.
229 return Path("file:///");
233 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
235 // Generic form of C:\Windows\System32
236 HRESULT res = SHGetFolderPathA(NULL,
237 CSIDL_FLAG_CREATE | CSIDL_SYSTEM,
242 assert(0 && "Failed to get system directory");
245 Paths.push_back(sys::Path(buff));
249 // Generic form of C:\Windows
250 res = SHGetFolderPathA(NULL,
251 CSIDL_FLAG_CREATE | CSIDL_WINDOWS,
256 assert(0 && "Failed to get windows directory");
259 Paths.push_back(sys::Path(buff));
263 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
264 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
266 getPathList(env_var,Paths);
271 if (tmpPath.set(LLVM_LIBDIR))
272 if (tmpPath.canRead())
273 Paths.push_back(tmpPath);
276 GetSystemLibraryPaths(Paths);
280 Path::GetLLVMDefaultConfigDir() {
281 Path ret = GetUserHomeDirectory();
282 if (!ret.appendComponent(".llvm"))
283 assert(0 && "Failed to append .llvm");
288 Path::GetUserHomeDirectory() {
290 HRESULT res = SHGetFolderPathA(NULL,
291 CSIDL_FLAG_CREATE | CSIDL_APPDATA,
296 assert(0 && "Failed to get user home directory");
301 Path::GetCurrentDirectory() {
302 char pathname[MAX_PATH];
303 ::GetCurrentDirectoryA(MAX_PATH,pathname);
304 return Path(pathname);
307 /// GetMainExecutable - Return the path to the main executable, given the
308 /// value of argv[0] from program startup.
309 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
310 char pathname[MAX_PATH];
311 DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
312 return ret != MAX_PATH ? Path(pathname) : Path();
316 // FIXME: the above set of functions don't map to Windows very well.
319 StringRef Path::getDirname() const {
320 return getDirnameCharSep(path, "/");
324 Path::getBasename() const {
325 // Find the last slash
326 size_t slash = path.rfind('/');
327 if (slash == std::string::npos)
332 size_t dot = path.rfind('.');
333 if (dot == std::string::npos || dot < slash)
334 return StringRef(path).substr(slash);
336 return StringRef(path).substr(slash, dot - slash);
340 Path::getSuffix() const {
341 // Find the last slash
342 size_t slash = path.rfind('/');
343 if (slash == std::string::npos)
348 size_t dot = path.rfind('.');
349 if (dot == std::string::npos || dot < slash)
350 return StringRef("");
352 return StringRef(path).substr(dot + 1);
356 Path::exists() const {
357 DWORD attr = GetFileAttributes(path.c_str());
358 return attr != INVALID_FILE_ATTRIBUTES;
362 Path::isDirectory() const {
363 DWORD attr = GetFileAttributes(path.c_str());
364 return (attr != INVALID_FILE_ATTRIBUTES) &&
365 (attr & FILE_ATTRIBUTE_DIRECTORY);
369 Path::isSymLink() const {
370 DWORD attributes = GetFileAttributes(path.c_str());
372 if (attributes == INVALID_FILE_ATTRIBUTES)
373 // There's no sane way to report this :(.
374 assert(0 && "GetFileAttributes returned INVALID_FILE_ATTRIBUTES");
376 // This isn't exactly what defines a NTFS symlink, but it is only true for
377 // paths that act like a symlink.
378 return attributes & FILE_ATTRIBUTE_REPARSE_POINT;
382 Path::canRead() const {
383 // FIXME: take security attributes into account.
384 DWORD attr = GetFileAttributes(path.c_str());
385 return attr != INVALID_FILE_ATTRIBUTES;
389 Path::canWrite() const {
390 // FIXME: take security attributes into account.
391 DWORD attr = GetFileAttributes(path.c_str());
392 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
396 Path::canExecute() const {
397 // FIXME: take security attributes into account.
398 DWORD attr = GetFileAttributes(path.c_str());
399 return attr != INVALID_FILE_ATTRIBUTES;
403 Path::isRegularFile() const {
405 if (fs::is_regular_file(path, res))
411 Path::getLast() const {
412 // Find the last slash
413 size_t pos = path.rfind('/');
415 // Handle the corner cases
416 if (pos == std::string::npos)
419 // If the last character is a slash, we have a root directory
420 if (pos == path.length()-1)
423 // Return everything after the last slash
424 return StringRef(path).substr(pos+1);
428 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
429 if (!fsIsValid || update) {
430 WIN32_FILE_ATTRIBUTE_DATA fi;
431 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
432 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
433 ": Can't get status: ");
437 status.fileSize = fi.nFileSizeHigh;
438 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
439 status.fileSize += fi.nFileSizeLow;
441 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
442 status.user = 9999; // Not applicable to Windows, so...
443 status.group = 9999; // Not applicable to Windows, so...
445 // FIXME: this is only unique if the file is accessed by the same file path.
446 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
447 // numbers, but the concept doesn't exist in Windows.
449 for (unsigned i = 0; i < path.length(); ++i)
450 status.uniqueID += path[i];
453 ui.LowPart = fi.ftLastWriteTime.dwLowDateTime;
454 ui.HighPart = fi.ftLastWriteTime.dwHighDateTime;
455 status.modTime.fromWin32Time(ui.QuadPart);
457 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
463 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
464 // All files are readable on Windows (ignoring security attributes).
468 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
469 DWORD attr = GetFileAttributes(path.c_str());
471 // If it doesn't exist, we're done.
472 if (attr == INVALID_FILE_ATTRIBUTES)
475 if (attr & FILE_ATTRIBUTE_READONLY) {
476 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
477 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
484 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
485 // All files are executable on Windows (ignoring security attributes).
490 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
491 WIN32_FILE_ATTRIBUTE_DATA fi;
492 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
493 MakeErrMsg(ErrMsg, path + ": can't get status of file");
497 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
499 *ErrMsg = path + ": not a directory";
505 std::string searchpath = path;
506 if (path.size() == 0 || searchpath[path.size()-1] == '/')
511 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
512 if (h == INVALID_HANDLE_VALUE) {
513 if (GetLastError() == ERROR_FILE_NOT_FOUND)
514 return true; // not really an error, now is it?
515 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
520 if (fd.cFileName[0] == '.')
523 aPath.appendComponent(&fd.cFileName[0]);
524 result.insert(aPath);
525 } while (FindNextFile(h, &fd));
527 DWORD err = GetLastError();
529 if (err != ERROR_NO_MORE_FILES) {
531 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
538 Path::set(StringRef a_path) {
541 std::string save(path);
543 FlipBackSlashes(path);
552 Path::appendComponent(StringRef name) {
555 std::string save(path);
557 size_t last = path.size() - 1;
558 if (path[last] != '/')
570 Path::eraseComponent() {
571 size_t slashpos = path.rfind('/',path.size());
572 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
574 std::string save(path);
575 path.erase(slashpos);
584 Path::eraseSuffix() {
585 size_t dotpos = path.rfind('.',path.size());
586 size_t slashpos = path.rfind('/',path.size());
587 if (dotpos != std::string::npos) {
588 if (slashpos == std::string::npos || dotpos > slashpos+1) {
589 std::string save(path);
590 path.erase(dotpos, path.size()-dotpos);
601 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
603 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
608 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
609 // Get a writeable copy of the path name
610 size_t len = path.length();
611 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
612 path.copy(pathname, len);
615 // Make sure it ends with a slash.
616 if (len == 0 || pathname[len - 1] != '/') {
621 // Determine starting point for initial / search.
622 char *next = pathname;
623 if (pathname[0] == '/' && pathname[1] == '/') {
625 next = strchr(pathname+2, '/');
627 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
630 next = strchr(next+1, '/');
632 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
636 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
639 if (pathname[1] == ':')
640 next += 2; // skip drive letter
642 next++; // skip root directory
645 // If we're supposed to create intermediate directories
646 if (create_parents) {
647 // Loop through the directory components until we're done
649 next = strchr(next, '/');
651 if (!CreateDirectory(pathname, NULL) &&
652 GetLastError() != ERROR_ALREADY_EXISTS)
653 return MakeErrMsg(ErrMsg,
654 std::string(pathname) + ": Can't create directory: ");
658 // Drop trailing slash.
660 if (!CreateDirectory(pathname, NULL) &&
661 GetLastError() != ERROR_ALREADY_EXISTS) {
662 return MakeErrMsg(ErrMsg, std::string(pathname) +
663 ": Can't create directory: ");
670 Path::createFileOnDisk(std::string* ErrMsg) {
672 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
673 FILE_ATTRIBUTE_NORMAL, NULL);
674 if (h == INVALID_HANDLE_VALUE)
675 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
682 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
683 WIN32_FILE_ATTRIBUTE_DATA fi;
684 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
687 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
688 // If it doesn't exist, we're done.
690 if (fs::exists(path, Exists) || !Exists)
693 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
694 int lastchar = path.length() - 1 ;
695 path.copy(pathname, lastchar+1);
697 // Make path end with '/*'.
698 if (pathname[lastchar] != '/')
699 pathname[++lastchar] = '/';
700 pathname[lastchar+1] = '*';
701 pathname[lastchar+2] = 0;
703 if (remove_contents) {
705 HANDLE h = FindFirstFile(pathname, &fd);
707 // It's a bad idea to alter the contents of a directory while enumerating
708 // its contents. So build a list of its contents first, then destroy them.
710 if (h != INVALID_HANDLE_VALUE) {
711 std::vector<Path> list;
714 if (strcmp(fd.cFileName, ".") == 0)
716 if (strcmp(fd.cFileName, "..") == 0)
720 aPath.appendComponent(&fd.cFileName[0]);
721 list.push_back(aPath);
722 } while (FindNextFile(h, &fd));
724 DWORD err = GetLastError();
726 if (err != ERROR_NO_MORE_FILES) {
728 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
731 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
734 aPath.eraseFromDisk(true);
737 if (GetLastError() != ERROR_FILE_NOT_FOUND)
738 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
742 pathname[lastchar] = 0;
743 if (!RemoveDirectory(pathname))
744 return MakeErrMsg(ErrStr,
745 std::string(pathname) + ": Can't destroy directory: ");
748 // Read-only files cannot be deleted on Windows. Must remove the read-only
750 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
751 if (!SetFileAttributes(path.c_str(),
752 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
753 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
756 if (!DeleteFile(path.c_str()))
757 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
762 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
763 assert(len < 1024 && "Request for magic string too long");
764 char* buf = reinterpret_cast<char*>(alloca(len));
766 HANDLE h = CreateFile(path.c_str(),
771 FILE_ATTRIBUTE_NORMAL,
773 if (h == INVALID_HANDLE_VALUE)
777 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
780 if (!ret || nRead != len)
783 Magic = std::string(buf, len);
788 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
789 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
790 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
796 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
797 // FIXME: should work on directories also.
802 HANDLE h = CreateFile(path.c_str(),
803 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
804 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
807 FILE_ATTRIBUTE_NORMAL,
809 if (h == INVALID_HANDLE_VALUE)
812 BY_HANDLE_FILE_INFORMATION bhfi;
813 if (!GetFileInformationByHandle(h, &bhfi)) {
814 DWORD err = GetLastError();
817 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
821 ui.QuadPart = si.modTime.toWin32Time();
823 ft.dwLowDateTime = ui.LowPart;
824 ft.dwHighDateTime = ui.HighPart;
825 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
826 DWORD err = GetLastError();
830 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
833 // Best we can do with Unix permission bits is to interpret the owner
835 if (si.mode & 0200) {
836 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
837 if (!SetFileAttributes(path.c_str(),
838 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
839 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
842 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
843 if (!SetFileAttributes(path.c_str(),
844 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
845 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
853 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
854 // Can't use CopyFile macro defined in Windows.h because it would mess up the
855 // above line. We use the expansion it would have in a non-UNICODE build.
856 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
857 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.str() +
858 "' to '" + Dest.str() + "': ");
863 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
865 if (reuse_current && (fs::exists(path, Exists) || !Exists))
866 return false; // File doesn't exist already, just use it!
868 // Reserve space for -XXXXXX at the end.
869 char *FNBuffer = (char*) alloca(path.size()+8);
870 unsigned offset = path.size();
871 path.copy(FNBuffer, offset);
873 // Find a numeric suffix that isn't used by an existing file. Assume there
874 // won't be more than 1 million files with the same prefix. Probably a safe
876 static int FCounter = -1;
878 // Give arbitrary initial seed.
879 // FIXME: We should use sys::fs::unique_file() in future.
881 DWORD x = GetCurrentProcessId();
882 x = (x << 16) | (x >> 16);
883 if (QueryPerformanceCounter(&cnt64)) // RDTSC
884 x ^= cnt64.HighPart ^ cnt64.LowPart;
885 FCounter = x % 1000000;
888 sprintf(FNBuffer+offset, "-%06u", FCounter);
889 if (++FCounter > 999999)
892 } while (!fs::exists(path, Exists) && Exists);
897 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
898 // Make this into a unique file name
899 makeUnique(reuse_current, ErrMsg);
901 // Now go and create it
902 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
903 FILE_ATTRIBUTE_NORMAL, NULL);
904 if (h == INVALID_HANDLE_VALUE)
905 return MakeErrMsg(ErrMsg, path + ": can't create file");
911 /// MapInFilePages - Not yet implemented on win32.
912 const char *Path::MapInFilePages(int FD, size_t FileSize, off_t Offset) {
916 /// MapInFilePages - Not yet implemented on win32.
917 void Path::UnMapFilePages(const char *Base, size_t FileSize) {
918 assert(0 && "NOT IMPLEMENTED");