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(static_cast<unsigned char>(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 #if defined(_MSC_VER)
193 // Visual Studio gets confused and emits a diagnostic about calling exists,
194 // even though this is the implementation for PathV1. Temporarily
195 // disable the deprecated warning message
196 #pragma warning(push)
197 #pragma warning(disable:4996)
199 assert(TempDirectory->exists() && "Who has removed TempDirectory?");
200 #if defined(_MSC_VER)
203 return *TempDirectory;
206 char pathname[MAX_PATH];
207 if (!GetTempPath(MAX_PATH, pathname)) {
209 *ErrMsg = "Can't determine temporary directory";
214 result.set(pathname);
216 // Append a subdirectory based on our process id so multiple LLVMs don't
217 // step on each other's toes.
219 // Mingw's Win32 header files are broken.
220 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
222 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
224 result.appendComponent(pathname);
226 // If there's a directory left over from a previous LLVM execution that
227 // happened to have the same process id, get rid of it.
228 result.eraseFromDisk(true);
230 // And finally (re-)create the empty directory.
231 result.createDirectoryOnDisk(false);
232 TempDirectory = new Path(result);
233 return *TempDirectory;
236 // FIXME: the following set of functions don't map to Windows very well.
238 Path::GetRootDirectory() {
239 // This is the only notion that that Windows has of a root directory. Nothing
240 // is here except for drives.
241 return Path("file:///");
245 Path::GetUserHomeDirectory() {
247 HRESULT res = SHGetFolderPathA(NULL,
248 CSIDL_FLAG_CREATE | CSIDL_APPDATA,
253 assert(0 && "Failed to get user home directory");
258 Path::GetCurrentDirectory() {
259 char pathname[MAX_PATH];
260 ::GetCurrentDirectoryA(MAX_PATH,pathname);
261 return Path(pathname);
264 /// GetMainExecutable - Return the path to the main executable, given the
265 /// value of argv[0] from program startup.
266 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
267 char pathname[MAX_PATH];
268 DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
269 return ret != MAX_PATH ? Path(pathname) : Path();
273 // FIXME: the above set of functions don't map to Windows very well.
276 StringRef Path::getDirname() const {
277 return getDirnameCharSep(path, "/");
281 Path::getBasename() const {
282 // Find the last slash
283 size_t slash = path.rfind('/');
284 if (slash == std::string::npos)
289 size_t dot = path.rfind('.');
290 if (dot == std::string::npos || dot < slash)
291 return StringRef(path).substr(slash);
293 return StringRef(path).substr(slash, dot - slash);
297 Path::getSuffix() const {
298 // Find the last slash
299 size_t slash = path.rfind('/');
300 if (slash == std::string::npos)
305 size_t dot = path.rfind('.');
306 if (dot == std::string::npos || dot < slash)
307 return StringRef("");
309 return StringRef(path).substr(dot + 1);
313 Path::exists() const {
314 DWORD attr = GetFileAttributes(path.c_str());
315 return attr != INVALID_FILE_ATTRIBUTES;
319 Path::isDirectory() const {
320 DWORD attr = GetFileAttributes(path.c_str());
321 return (attr != INVALID_FILE_ATTRIBUTES) &&
322 (attr & FILE_ATTRIBUTE_DIRECTORY);
326 Path::isSymLink() const {
327 DWORD attributes = GetFileAttributes(path.c_str());
329 if (attributes == INVALID_FILE_ATTRIBUTES)
330 // There's no sane way to report this :(.
331 assert(0 && "GetFileAttributes returned INVALID_FILE_ATTRIBUTES");
333 // This isn't exactly what defines a NTFS symlink, but it is only true for
334 // paths that act like a symlink.
335 return attributes & FILE_ATTRIBUTE_REPARSE_POINT;
339 Path::canRead() const {
340 // FIXME: take security attributes into account.
341 DWORD attr = GetFileAttributes(path.c_str());
342 return attr != INVALID_FILE_ATTRIBUTES;
346 Path::canWrite() const {
347 // FIXME: take security attributes into account.
348 DWORD attr = GetFileAttributes(path.c_str());
349 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
353 Path::canExecute() const {
354 // FIXME: take security attributes into account.
355 DWORD attr = GetFileAttributes(path.c_str());
356 return attr != INVALID_FILE_ATTRIBUTES;
360 Path::isRegularFile() const {
362 if (fs::is_regular_file(path, res))
368 Path::getLast() const {
369 // Find the last slash
370 size_t pos = path.rfind('/');
372 // Handle the corner cases
373 if (pos == std::string::npos)
376 // If the last character is a slash, we have a root directory
377 if (pos == path.length()-1)
380 // Return everything after the last slash
381 return StringRef(path).substr(pos+1);
385 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
386 if (!fsIsValid || update) {
387 WIN32_FILE_ATTRIBUTE_DATA fi;
388 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
389 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
390 ": Can't get status: ");
394 status.fileSize = fi.nFileSizeHigh;
395 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
396 status.fileSize += fi.nFileSizeLow;
398 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
399 status.user = 9999; // Not applicable to Windows, so...
400 status.group = 9999; // Not applicable to Windows, so...
402 // FIXME: this is only unique if the file is accessed by the same file path.
403 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
404 // numbers, but the concept doesn't exist in Windows.
406 for (unsigned i = 0; i < path.length(); ++i)
407 status.uniqueID += path[i];
410 ui.LowPart = fi.ftLastWriteTime.dwLowDateTime;
411 ui.HighPart = fi.ftLastWriteTime.dwHighDateTime;
412 status.modTime.fromWin32Time(ui.QuadPart);
414 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
420 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
421 // All files are readable on Windows (ignoring security attributes).
425 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
426 DWORD attr = GetFileAttributes(path.c_str());
428 // If it doesn't exist, we're done.
429 if (attr == INVALID_FILE_ATTRIBUTES)
432 if (attr & FILE_ATTRIBUTE_READONLY) {
433 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
434 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
441 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
442 // All files are executable on Windows (ignoring security attributes).
447 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
448 WIN32_FILE_ATTRIBUTE_DATA fi;
449 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
450 MakeErrMsg(ErrMsg, path + ": can't get status of file");
454 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
456 *ErrMsg = path + ": not a directory";
462 std::string searchpath = path;
463 if (path.size() == 0 || searchpath[path.size()-1] == '/')
468 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
469 if (h == INVALID_HANDLE_VALUE) {
470 if (GetLastError() == ERROR_FILE_NOT_FOUND)
471 return true; // not really an error, now is it?
472 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
477 if (fd.cFileName[0] == '.')
480 aPath.appendComponent(&fd.cFileName[0]);
481 result.insert(aPath);
482 } while (FindNextFile(h, &fd));
484 DWORD err = GetLastError();
486 if (err != ERROR_NO_MORE_FILES) {
488 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
495 Path::set(StringRef a_path) {
498 std::string save(path);
500 FlipBackSlashes(path);
509 Path::appendComponent(StringRef name) {
512 std::string save(path);
514 size_t last = path.size() - 1;
515 if (path[last] != '/')
527 Path::eraseComponent() {
528 size_t slashpos = path.rfind('/',path.size());
529 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
531 std::string save(path);
532 path.erase(slashpos);
541 Path::eraseSuffix() {
542 size_t dotpos = path.rfind('.',path.size());
543 size_t slashpos = path.rfind('/',path.size());
544 if (dotpos != std::string::npos) {
545 if (slashpos == std::string::npos || dotpos > slashpos+1) {
546 std::string save(path);
547 path.erase(dotpos, path.size()-dotpos);
558 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
560 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
565 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
566 // Get a writeable copy of the path name
567 size_t len = path.length();
568 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
569 path.copy(pathname, len);
572 // Make sure it ends with a slash.
573 if (len == 0 || pathname[len - 1] != '/') {
578 // Determine starting point for initial / search.
579 char *next = pathname;
580 if (pathname[0] == '/' && pathname[1] == '/') {
582 next = strchr(pathname+2, '/');
584 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
587 next = strchr(next+1, '/');
589 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
593 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
596 if (pathname[1] == ':')
597 next += 2; // skip drive letter
599 next++; // skip root directory
602 // If we're supposed to create intermediate directories
603 if (create_parents) {
604 // Loop through the directory components until we're done
606 next = strchr(next, '/');
608 if (!CreateDirectory(pathname, NULL) &&
609 GetLastError() != ERROR_ALREADY_EXISTS)
610 return MakeErrMsg(ErrMsg,
611 std::string(pathname) + ": Can't create directory: ");
615 // Drop trailing slash.
617 if (!CreateDirectory(pathname, NULL) &&
618 GetLastError() != ERROR_ALREADY_EXISTS) {
619 return MakeErrMsg(ErrMsg, std::string(pathname) +
620 ": Can't create directory: ");
627 Path::createFileOnDisk(std::string* ErrMsg) {
629 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
630 FILE_ATTRIBUTE_NORMAL, NULL);
631 if (h == INVALID_HANDLE_VALUE)
632 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
639 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
640 WIN32_FILE_ATTRIBUTE_DATA fi;
641 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
644 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
645 // If it doesn't exist, we're done.
647 if (fs::exists(path, Exists) || !Exists)
650 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
651 int lastchar = path.length() - 1 ;
652 path.copy(pathname, lastchar+1);
654 // Make path end with '/*'.
655 if (pathname[lastchar] != '/')
656 pathname[++lastchar] = '/';
657 pathname[lastchar+1] = '*';
658 pathname[lastchar+2] = 0;
660 if (remove_contents) {
662 HANDLE h = FindFirstFile(pathname, &fd);
664 // It's a bad idea to alter the contents of a directory while enumerating
665 // its contents. So build a list of its contents first, then destroy them.
667 if (h != INVALID_HANDLE_VALUE) {
668 std::vector<Path> list;
671 if (strcmp(fd.cFileName, ".") == 0)
673 if (strcmp(fd.cFileName, "..") == 0)
677 aPath.appendComponent(&fd.cFileName[0]);
678 list.push_back(aPath);
679 } while (FindNextFile(h, &fd));
681 DWORD err = GetLastError();
683 if (err != ERROR_NO_MORE_FILES) {
685 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
688 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
691 aPath.eraseFromDisk(true);
694 if (GetLastError() != ERROR_FILE_NOT_FOUND)
695 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
699 pathname[lastchar] = 0;
700 if (!RemoveDirectory(pathname))
701 return MakeErrMsg(ErrStr,
702 std::string(pathname) + ": Can't destroy directory: ");
705 // Read-only files cannot be deleted on Windows. Must remove the read-only
707 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
708 if (!SetFileAttributes(path.c_str(),
709 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
710 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
713 if (!DeleteFile(path.c_str()))
714 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
719 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
720 assert(len < 1024 && "Request for magic string too long");
721 char* buf = reinterpret_cast<char*>(alloca(len));
723 HANDLE h = CreateFile(path.c_str(),
728 FILE_ATTRIBUTE_NORMAL,
730 if (h == INVALID_HANDLE_VALUE)
734 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
737 if (!ret || nRead != len)
740 Magic = std::string(buf, len);
745 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
746 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
747 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
753 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
754 // FIXME: should work on directories also.
759 HANDLE h = CreateFile(path.c_str(),
760 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
761 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
764 FILE_ATTRIBUTE_NORMAL,
766 if (h == INVALID_HANDLE_VALUE)
769 BY_HANDLE_FILE_INFORMATION bhfi;
770 if (!GetFileInformationByHandle(h, &bhfi)) {
771 DWORD err = GetLastError();
774 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
778 ui.QuadPart = si.modTime.toWin32Time();
780 ft.dwLowDateTime = ui.LowPart;
781 ft.dwHighDateTime = ui.HighPart;
782 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
783 DWORD err = GetLastError();
787 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
790 // Best we can do with Unix permission bits is to interpret the owner
792 if (si.mode & 0200) {
793 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
794 if (!SetFileAttributes(path.c_str(),
795 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
796 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
799 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
800 if (!SetFileAttributes(path.c_str(),
801 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
802 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
810 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
811 // Can't use CopyFile macro defined in Windows.h because it would mess up the
812 // above line. We use the expansion it would have in a non-UNICODE build.
813 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
814 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.str() +
815 "' to '" + Dest.str() + "': ");
820 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
822 if (reuse_current && (fs::exists(path, Exists) || !Exists))
823 return false; // File doesn't exist already, just use it!
825 // Reserve space for -XXXXXX at the end.
826 char *FNBuffer = (char*) alloca(path.size()+8);
827 unsigned offset = path.size();
828 path.copy(FNBuffer, offset);
830 // Find a numeric suffix that isn't used by an existing file. Assume there
831 // won't be more than 1 million files with the same prefix. Probably a safe
833 static int FCounter = -1;
835 // Give arbitrary initial seed.
836 // FIXME: We should use sys::fs::unique_file() in future.
838 DWORD x = GetCurrentProcessId();
839 x = (x << 16) | (x >> 16);
840 if (QueryPerformanceCounter(&cnt64)) // RDTSC
841 x ^= cnt64.HighPart ^ cnt64.LowPart;
842 FCounter = x % 1000000;
845 sprintf(FNBuffer+offset, "-%06u", FCounter);
846 if (++FCounter > 999999)
849 } while (!fs::exists(path, Exists) && Exists);
854 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
855 // Make this into a unique file name
856 makeUnique(reuse_current, ErrMsg);
858 // Now go and create it
859 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
860 FILE_ATTRIBUTE_NORMAL, NULL);
861 if (h == INVALID_HANDLE_VALUE)
862 return MakeErrMsg(ErrMsg, path + ": can't create file");
868 /// MapInFilePages - Not yet implemented on win32.
869 const char *Path::MapInFilePages(int FD, size_t FileSize, off_t Offset) {
873 /// MapInFilePages - Not yet implemented on win32.
874 void Path::UnMapFilePages(const char *Base, size_t FileSize) {
875 assert(0 && "NOT IMPLEMENTED");