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;
237 Path::GetCurrentDirectory() {
238 char pathname[MAX_PATH];
239 ::GetCurrentDirectoryA(MAX_PATH,pathname);
240 return Path(pathname);
243 /// GetMainExecutable - Return the path to the main executable, given the
244 /// value of argv[0] from program startup.
245 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
246 char pathname[MAX_PATH];
247 DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
248 return ret != MAX_PATH ? Path(pathname) : Path();
252 // FIXME: the above set of functions don't map to Windows very well.
255 StringRef Path::getDirname() const {
256 return getDirnameCharSep(path, "/");
260 Path::getBasename() const {
261 // Find the last slash
262 size_t slash = path.rfind('/');
263 if (slash == std::string::npos)
268 size_t dot = path.rfind('.');
269 if (dot == std::string::npos || dot < slash)
270 return StringRef(path).substr(slash);
272 return StringRef(path).substr(slash, dot - slash);
276 Path::getSuffix() const {
277 // Find the last slash
278 size_t slash = path.rfind('/');
279 if (slash == std::string::npos)
284 size_t dot = path.rfind('.');
285 if (dot == std::string::npos || dot < slash)
286 return StringRef("");
288 return StringRef(path).substr(dot + 1);
292 Path::exists() const {
293 DWORD attr = GetFileAttributes(path.c_str());
294 return attr != INVALID_FILE_ATTRIBUTES;
298 Path::isDirectory() const {
299 DWORD attr = GetFileAttributes(path.c_str());
300 return (attr != INVALID_FILE_ATTRIBUTES) &&
301 (attr & FILE_ATTRIBUTE_DIRECTORY);
305 Path::isSymLink() const {
306 DWORD attributes = GetFileAttributes(path.c_str());
308 if (attributes == INVALID_FILE_ATTRIBUTES)
309 // There's no sane way to report this :(.
310 assert(0 && "GetFileAttributes returned INVALID_FILE_ATTRIBUTES");
312 // This isn't exactly what defines a NTFS symlink, but it is only true for
313 // paths that act like a symlink.
314 return attributes & FILE_ATTRIBUTE_REPARSE_POINT;
318 Path::canRead() const {
319 // FIXME: take security attributes into account.
320 DWORD attr = GetFileAttributes(path.c_str());
321 return attr != INVALID_FILE_ATTRIBUTES;
325 Path::canWrite() const {
326 // FIXME: take security attributes into account.
327 DWORD attr = GetFileAttributes(path.c_str());
328 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
332 Path::canExecute() const {
333 // FIXME: take security attributes into account.
334 DWORD attr = GetFileAttributes(path.c_str());
335 return attr != INVALID_FILE_ATTRIBUTES;
339 Path::isRegularFile() const {
341 if (fs::is_regular_file(path, res))
347 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
348 if (!fsIsValid || update) {
349 WIN32_FILE_ATTRIBUTE_DATA fi;
350 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
351 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
352 ": Can't get status: ");
356 status.fileSize = fi.nFileSizeHigh;
357 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
358 status.fileSize += fi.nFileSizeLow;
360 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
361 status.user = 9999; // Not applicable to Windows, so...
362 status.group = 9999; // Not applicable to Windows, so...
364 // FIXME: this is only unique if the file is accessed by the same file path.
365 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
366 // numbers, but the concept doesn't exist in Windows.
368 for (unsigned i = 0; i < path.length(); ++i)
369 status.uniqueID += path[i];
372 ui.LowPart = fi.ftLastWriteTime.dwLowDateTime;
373 ui.HighPart = fi.ftLastWriteTime.dwHighDateTime;
374 status.modTime.fromWin32Time(ui.QuadPart);
376 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
382 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
383 // All files are readable on Windows (ignoring security attributes).
387 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
388 DWORD attr = GetFileAttributes(path.c_str());
390 // If it doesn't exist, we're done.
391 if (attr == INVALID_FILE_ATTRIBUTES)
394 if (attr & FILE_ATTRIBUTE_READONLY) {
395 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
396 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
403 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
404 // All files are executable on Windows (ignoring security attributes).
409 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
410 WIN32_FILE_ATTRIBUTE_DATA fi;
411 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
412 MakeErrMsg(ErrMsg, path + ": can't get status of file");
416 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
418 *ErrMsg = path + ": not a directory";
424 std::string searchpath = path;
425 if (path.size() == 0 || searchpath[path.size()-1] == '/')
430 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
431 if (h == INVALID_HANDLE_VALUE) {
432 if (GetLastError() == ERROR_FILE_NOT_FOUND)
433 return true; // not really an error, now is it?
434 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
439 if (fd.cFileName[0] == '.')
442 aPath.appendComponent(&fd.cFileName[0]);
443 result.insert(aPath);
444 } while (FindNextFile(h, &fd));
446 DWORD err = GetLastError();
448 if (err != ERROR_NO_MORE_FILES) {
450 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
457 Path::set(StringRef a_path) {
460 std::string save(path);
462 FlipBackSlashes(path);
471 Path::appendComponent(StringRef name) {
474 std::string save(path);
476 size_t last = path.size() - 1;
477 if (path[last] != '/')
489 Path::eraseComponent() {
490 size_t slashpos = path.rfind('/',path.size());
491 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
493 std::string save(path);
494 path.erase(slashpos);
503 Path::eraseSuffix() {
504 size_t dotpos = path.rfind('.',path.size());
505 size_t slashpos = path.rfind('/',path.size());
506 if (dotpos != std::string::npos) {
507 if (slashpos == std::string::npos || dotpos > slashpos+1) {
508 std::string save(path);
509 path.erase(dotpos, path.size()-dotpos);
520 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
522 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
527 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
528 // Get a writeable copy of the path name
529 size_t len = path.length();
530 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
531 path.copy(pathname, len);
534 // Make sure it ends with a slash.
535 if (len == 0 || pathname[len - 1] != '/') {
540 // Determine starting point for initial / search.
541 char *next = pathname;
542 if (pathname[0] == '/' && pathname[1] == '/') {
544 next = strchr(pathname+2, '/');
546 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
549 next = strchr(next+1, '/');
551 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
555 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
558 if (pathname[1] == ':')
559 next += 2; // skip drive letter
561 next++; // skip root directory
564 // If we're supposed to create intermediate directories
565 if (create_parents) {
566 // Loop through the directory components until we're done
568 next = strchr(next, '/');
570 if (!CreateDirectory(pathname, NULL) &&
571 GetLastError() != ERROR_ALREADY_EXISTS)
572 return MakeErrMsg(ErrMsg,
573 std::string(pathname) + ": Can't create directory: ");
577 // Drop trailing slash.
579 if (!CreateDirectory(pathname, NULL) &&
580 GetLastError() != ERROR_ALREADY_EXISTS) {
581 return MakeErrMsg(ErrMsg, std::string(pathname) +
582 ": Can't create directory: ");
589 Path::createFileOnDisk(std::string* ErrMsg) {
591 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
592 FILE_ATTRIBUTE_NORMAL, NULL);
593 if (h == INVALID_HANDLE_VALUE)
594 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
601 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
602 WIN32_FILE_ATTRIBUTE_DATA fi;
603 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
606 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
607 // If it doesn't exist, we're done.
609 if (fs::exists(path, Exists) || !Exists)
612 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
613 int lastchar = path.length() - 1 ;
614 path.copy(pathname, lastchar+1);
616 // Make path end with '/*'.
617 if (pathname[lastchar] != '/')
618 pathname[++lastchar] = '/';
619 pathname[lastchar+1] = '*';
620 pathname[lastchar+2] = 0;
622 if (remove_contents) {
624 HANDLE h = FindFirstFile(pathname, &fd);
626 // It's a bad idea to alter the contents of a directory while enumerating
627 // its contents. So build a list of its contents first, then destroy them.
629 if (h != INVALID_HANDLE_VALUE) {
630 std::vector<Path> list;
633 if (strcmp(fd.cFileName, ".") == 0)
635 if (strcmp(fd.cFileName, "..") == 0)
639 aPath.appendComponent(&fd.cFileName[0]);
640 list.push_back(aPath);
641 } while (FindNextFile(h, &fd));
643 DWORD err = GetLastError();
645 if (err != ERROR_NO_MORE_FILES) {
647 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
650 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
653 aPath.eraseFromDisk(true);
656 if (GetLastError() != ERROR_FILE_NOT_FOUND)
657 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
661 pathname[lastchar] = 0;
662 if (!RemoveDirectory(pathname))
663 return MakeErrMsg(ErrStr,
664 std::string(pathname) + ": Can't destroy directory: ");
667 // Read-only files cannot be deleted on Windows. Must remove the read-only
669 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
670 if (!SetFileAttributes(path.c_str(),
671 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
672 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
675 if (!DeleteFile(path.c_str()))
676 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
681 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
682 assert(len < 1024 && "Request for magic string too long");
683 char* buf = reinterpret_cast<char*>(alloca(len));
685 HANDLE h = CreateFile(path.c_str(),
690 FILE_ATTRIBUTE_NORMAL,
692 if (h == INVALID_HANDLE_VALUE)
696 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
699 if (!ret || nRead != len)
702 Magic = std::string(buf, len);
707 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
708 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
709 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
715 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
716 // FIXME: should work on directories also.
721 HANDLE h = CreateFile(path.c_str(),
722 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
723 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
726 FILE_ATTRIBUTE_NORMAL,
728 if (h == INVALID_HANDLE_VALUE)
731 BY_HANDLE_FILE_INFORMATION bhfi;
732 if (!GetFileInformationByHandle(h, &bhfi)) {
733 DWORD err = GetLastError();
736 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
740 ui.QuadPart = si.modTime.toWin32Time();
742 ft.dwLowDateTime = ui.LowPart;
743 ft.dwHighDateTime = ui.HighPart;
744 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
745 DWORD err = GetLastError();
749 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
752 // Best we can do with Unix permission bits is to interpret the owner
754 if (si.mode & 0200) {
755 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
756 if (!SetFileAttributes(path.c_str(),
757 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
758 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
761 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
762 if (!SetFileAttributes(path.c_str(),
763 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
764 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
772 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
773 // Can't use CopyFile macro defined in Windows.h because it would mess up the
774 // above line. We use the expansion it would have in a non-UNICODE build.
775 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
776 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.str() +
777 "' to '" + Dest.str() + "': ");
782 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
784 if (reuse_current && (fs::exists(path, Exists) || !Exists))
785 return false; // File doesn't exist already, just use it!
787 // Reserve space for -XXXXXX at the end.
788 char *FNBuffer = (char*) alloca(path.size()+8);
789 unsigned offset = path.size();
790 path.copy(FNBuffer, offset);
792 // Find a numeric suffix that isn't used by an existing file. Assume there
793 // won't be more than 1 million files with the same prefix. Probably a safe
795 static int FCounter = -1;
797 // Give arbitrary initial seed.
798 // FIXME: We should use sys::fs::unique_file() in future.
800 DWORD x = GetCurrentProcessId();
801 x = (x << 16) | (x >> 16);
802 if (QueryPerformanceCounter(&cnt64)) // RDTSC
803 x ^= cnt64.HighPart ^ cnt64.LowPart;
804 FCounter = x % 1000000;
807 sprintf(FNBuffer+offset, "-%06u", FCounter);
808 if (++FCounter > 999999)
811 } while (!fs::exists(path, Exists) && Exists);
816 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
817 // Make this into a unique file name
818 makeUnique(reuse_current, ErrMsg);
820 // Now go and create it
821 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
822 FILE_ATTRIBUTE_NORMAL, NULL);
823 if (h == INVALID_HANDLE_VALUE)
824 return MakeErrMsg(ErrMsg, path + ": can't create file");
830 /// MapInFilePages - Not yet implemented on win32.
831 const char *Path::MapInFilePages(int FD, size_t FileSize, off_t Offset) {
835 /// MapInFilePages - Not yet implemented on win32.
836 void Path::UnMapFilePages(const char *Base, size_t FileSize) {
837 assert(0 && "NOT IMPLEMENTED");