1 //===- llvm/System/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 // Modified by Henrik Bach to comply with at least MinGW.
9 // Ported to Win32 by Jeff Cohen.
11 //===----------------------------------------------------------------------===//
13 // This file provides the Win32 specific implementation of the Path class.
15 //===----------------------------------------------------------------------===//
17 //===----------------------------------------------------------------------===//
18 //=== WARNING: Implementation here must contain only generic Win32 code that
19 //=== is guaranteed to work on *all* Win32 variants.
20 //===----------------------------------------------------------------------===//
25 // We need to undo a macro defined in Windows.h, otherwise we won't compile:
27 #undef GetCurrentDirectory
29 // Windows happily accepts either forward or backward slashes, though any path
30 // returned by a Win32 API will have backward slashes. As LLVM code basically
31 // assumes forward slashes are used, backward slashs are converted where they
32 // can be introduced into a path.
34 // Another invariant is that a path ends with a slash if and only if the path
35 // is a root directory. Any other use of a trailing slash is stripped. Unlike
36 // in Unix, Windows has a rather complicated notion of a root path and this
37 // invariant helps simply the code.
39 static void FlipBackSlashes(std::string& s) {
40 for (size_t i = 0; i < s.size(); i++)
47 const char PathSeparator = ';';
49 Path::Path(const std::string& p)
51 FlipBackSlashes(path);
54 Path::Path(const char *StrStart, unsigned StrLen)
55 : path(StrStart, StrLen) {
56 FlipBackSlashes(path);
60 Path::isValid() const {
64 // If there is a colon, it must be the second character, preceded by a letter
65 // and followed by something.
66 size_t len = path.size();
67 size_t pos = path.rfind(':',len);
69 if (pos != std::string::npos) {
70 if (pos != 1 || !isalpha(path[0]) || len < 3)
75 // Look for a UNC path, and if found adjust our notion of the root slash.
76 if (len > 3 && path[0] == '/' && path[1] == '/') {
77 rootslash = path.find('/', 2);
78 if (rootslash == std::string::npos)
82 // Check for illegal characters.
83 if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
84 "\013\014\015\016\017\020\021\022\023\024\025\026"
85 "\027\030\031\032\033\034\035\036\037")
89 // Remove trailing slash, unless it's a root slash.
90 if (len > rootslash+1 && path[len-1] == '/')
93 // Check each component for legality.
94 for (pos = 0; pos < len; ++pos) {
95 // A component may not end in a space.
96 if (path[pos] == ' ') {
97 if (path[pos+1] == '/' || path[pos+1] == '\0')
101 // A component may not end in a period.
102 if (path[pos] == '.') {
103 if (path[pos+1] == '/' || path[pos+1] == '\0') {
104 // Unless it is the pseudo-directory "."...
105 if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
108 if (pos > 0 && path[pos-1] == '.') {
109 if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
121 Path::isAbsolute() const {
122 switch (path.length()) {
127 return path[0] == '/';
129 return path[0] == '/' || (path[1] == ':' && path[2] == '/');
133 static Path *TempDirectory = NULL;
136 Path::GetTemporaryDirectory(std::string* ErrMsg) {
138 return *TempDirectory;
140 char pathname[MAX_PATH];
141 if (!GetTempPath(MAX_PATH, pathname)) {
143 *ErrMsg = "Can't determine temporary directory";
148 result.set(pathname);
150 // Append a subdirectory passed on our process id so multiple LLVMs don't
151 // step on each other's toes.
153 // Mingw's Win32 header files are broken.
154 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
156 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
158 result.appendComponent(pathname);
160 // If there's a directory left over from a previous LLVM execution that
161 // happened to have the same process id, get rid of it.
162 result.eraseFromDisk(true);
164 // And finally (re-)create the empty directory.
165 result.createDirectoryOnDisk(false);
166 TempDirectory = new Path(result);
167 return *TempDirectory;
170 // FIXME: the following set of functions don't map to Windows very well.
172 Path::GetRootDirectory() {
179 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
180 Paths.push_back(sys::Path("C:/WINDOWS/SYSTEM32"));
181 Paths.push_back(sys::Path("C:/WINDOWS"));
185 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
186 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
188 getPathList(env_var,Paths);
193 if (tmpPath.set(LLVM_LIBDIR))
194 if (tmpPath.canRead())
195 Paths.push_back(tmpPath);
198 GetSystemLibraryPaths(Paths);
202 Path::GetLLVMDefaultConfigDir() {
203 // TODO: this isn't going to fly on Windows
204 return Path("/etc/llvm");
208 Path::GetUserHomeDirectory() {
209 // TODO: Typical Windows setup doesn't define HOME.
210 const char* home = getenv("HOME");
213 if (result.set(home))
216 return GetRootDirectory();
220 Path::GetCurrentDirectory() {
221 char pathname[MAX_PATH];
222 ::GetCurrentDirectoryA(MAX_PATH,pathname);
223 return Path(pathname);
226 /// GetMainExecutable - Return the path to the main executable, given the
227 /// value of argv[0] from program startup.
228 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
233 // FIXME: the above set of functions don't map to Windows very well.
237 Path::isRootDirectory() const {
238 size_t len = path.size();
239 return len > 0 && path[len-1] == '/';
242 std::string Path::getDirname() const {
243 return getDirnameCharSep(path, '/');
247 Path::getBasename() const {
248 // Find the last slash
249 size_t slash = path.rfind('/');
250 if (slash == std::string::npos)
255 size_t dot = path.rfind('.');
256 if (dot == std::string::npos || dot < slash)
257 return path.substr(slash);
259 return path.substr(slash, dot - slash);
263 Path::getSuffix() const {
264 // Find the last slash
265 size_t slash = path.rfind('/');
266 if (slash == std::string::npos)
271 size_t dot = path.rfind('.');
272 if (dot == std::string::npos || dot < slash)
273 return std::string();
275 return path.substr(dot + 1);
279 Path::exists() const {
280 DWORD attr = GetFileAttributes(path.c_str());
281 return attr != INVALID_FILE_ATTRIBUTES;
285 Path::isDirectory() const {
286 DWORD attr = GetFileAttributes(path.c_str());
287 return (attr != INVALID_FILE_ATTRIBUTES) &&
288 (attr & FILE_ATTRIBUTE_DIRECTORY);
292 Path::canRead() const {
293 // FIXME: take security attributes into account.
294 DWORD attr = GetFileAttributes(path.c_str());
295 return attr != INVALID_FILE_ATTRIBUTES;
299 Path::canWrite() const {
300 // FIXME: take security attributes into account.
301 DWORD attr = GetFileAttributes(path.c_str());
302 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
306 Path::canExecute() const {
307 // FIXME: take security attributes into account.
308 DWORD attr = GetFileAttributes(path.c_str());
309 return attr != INVALID_FILE_ATTRIBUTES;
313 Path::getLast() const {
314 // Find the last slash
315 size_t pos = path.rfind('/');
317 // Handle the corner cases
318 if (pos == std::string::npos)
321 // If the last character is a slash, we have a root directory
322 if (pos == path.length()-1)
325 // Return everything after the last slash
326 return path.substr(pos+1);
330 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
331 if (!fsIsValid || update) {
332 WIN32_FILE_ATTRIBUTE_DATA fi;
333 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
334 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
335 ": Can't get status: ");
339 status.fileSize = fi.nFileSizeHigh;
340 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
341 status.fileSize += fi.nFileSizeLow;
343 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
344 status.user = 9999; // Not applicable to Windows, so...
345 status.group = 9999; // Not applicable to Windows, so...
347 // FIXME: this is only unique if the file is accessed by the same file path.
348 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
349 // numbers, but the concept doesn't exist in Windows.
351 for (unsigned i = 0; i < path.length(); ++i)
352 status.uniqueID += path[i];
354 __int64 ft = *reinterpret_cast<__int64*>(&fi.ftLastWriteTime);
355 status.modTime.fromWin32Time(ft);
357 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
363 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
364 // All files are readable on Windows (ignoring security attributes).
368 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
369 DWORD attr = GetFileAttributes(path.c_str());
371 // If it doesn't exist, we're done.
372 if (attr == INVALID_FILE_ATTRIBUTES)
375 if (attr & FILE_ATTRIBUTE_READONLY) {
376 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
377 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
384 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
385 // All files are executable on Windows (ignoring security attributes).
390 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
391 WIN32_FILE_ATTRIBUTE_DATA fi;
392 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
393 MakeErrMsg(ErrMsg, path + ": can't get status of file");
397 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
399 *ErrMsg = path + ": not a directory";
405 std::string searchpath = path;
406 if (path.size() == 0 || searchpath[path.size()-1] == '/')
411 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
412 if (h == INVALID_HANDLE_VALUE) {
413 if (GetLastError() == ERROR_FILE_NOT_FOUND)
414 return true; // not really an error, now is it?
415 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
420 if (fd.cFileName[0] == '.')
423 aPath.appendComponent(&fd.cFileName[0]);
424 result.insert(aPath);
425 } while (FindNextFile(h, &fd));
427 DWORD err = GetLastError();
429 if (err != ERROR_NO_MORE_FILES) {
431 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
438 Path::set(const std::string& a_path) {
441 std::string save(path);
443 FlipBackSlashes(path);
452 Path::appendComponent(const std::string& name) {
455 std::string save(path);
457 size_t last = path.size() - 1;
458 if (path[last] != '/')
470 Path::eraseComponent() {
471 size_t slashpos = path.rfind('/',path.size());
472 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
474 std::string save(path);
475 path.erase(slashpos);
484 Path::appendSuffix(const std::string& suffix) {
485 std::string save(path);
496 Path::eraseSuffix() {
497 size_t dotpos = path.rfind('.',path.size());
498 size_t slashpos = path.rfind('/',path.size());
499 if (dotpos != std::string::npos) {
500 if (slashpos == std::string::npos || dotpos > slashpos+1) {
501 std::string save(path);
502 path.erase(dotpos, path.size()-dotpos);
513 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
515 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
520 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
521 // Get a writeable copy of the path name
522 size_t len = path.length();
523 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
524 path.copy(pathname, len);
527 // Make sure it ends with a slash.
528 if (len == 0 || pathname[len - 1] != '/') {
533 // Determine starting point for initial / search.
534 char *next = pathname;
535 if (pathname[0] == '/' && pathname[1] == '/') {
537 next = strchr(pathname+2, '/');
539 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
542 next = strchr(next+1, '/');
544 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
548 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
551 if (pathname[1] == ':')
552 next += 2; // skip drive letter
554 next++; // skip root directory
557 // If we're supposed to create intermediate directories
558 if (create_parents) {
559 // Loop through the directory components until we're done
561 next = strchr(next, '/');
563 if (!CreateDirectory(pathname, NULL))
564 return MakeErrMsg(ErrMsg,
565 std::string(pathname) + ": Can't create directory: ");
569 // Drop trailing slash.
571 if (!CreateDirectory(pathname, NULL)) {
572 return MakeErrMsg(ErrMsg, std::string(pathname) + ": Can't create directory: ");
579 Path::createFileOnDisk(std::string* ErrMsg) {
581 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
582 FILE_ATTRIBUTE_NORMAL, NULL);
583 if (h == INVALID_HANDLE_VALUE)
584 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
591 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
592 WIN32_FILE_ATTRIBUTE_DATA fi;
593 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
596 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
597 // If it doesn't exist, we're done.
601 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
602 int lastchar = path.length() - 1 ;
603 path.copy(pathname, lastchar+1);
605 // Make path end with '/*'.
606 if (pathname[lastchar] != '/')
607 pathname[++lastchar] = '/';
608 pathname[lastchar+1] = '*';
609 pathname[lastchar+2] = 0;
611 if (remove_contents) {
613 HANDLE h = FindFirstFile(pathname, &fd);
615 // It's a bad idea to alter the contents of a directory while enumerating
616 // its contents. So build a list of its contents first, then destroy them.
618 if (h != INVALID_HANDLE_VALUE) {
619 std::vector<Path> list;
622 if (strcmp(fd.cFileName, ".") == 0)
624 if (strcmp(fd.cFileName, "..") == 0)
628 aPath.appendComponent(&fd.cFileName[0]);
629 list.push_back(aPath);
630 } while (FindNextFile(h, &fd));
632 DWORD err = GetLastError();
634 if (err != ERROR_NO_MORE_FILES) {
636 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
639 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
642 aPath.eraseFromDisk(true);
645 if (GetLastError() != ERROR_FILE_NOT_FOUND)
646 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
650 pathname[lastchar] = 0;
651 if (!RemoveDirectory(pathname))
652 return MakeErrMsg(ErrStr,
653 std::string(pathname) + ": Can't destroy directory: ");
656 // Read-only files cannot be deleted on Windows. Must remove the read-only
658 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
659 if (!SetFileAttributes(path.c_str(),
660 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
661 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
664 if (!DeleteFile(path.c_str()))
665 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
670 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
671 assert(len < 1024 && "Request for magic string too long");
672 char* buf = (char*) alloca(1 + len);
674 HANDLE h = CreateFile(path.c_str(),
679 FILE_ATTRIBUTE_NORMAL,
681 if (h == INVALID_HANDLE_VALUE)
685 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
688 if (!ret || nRead != len)
697 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
698 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
699 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
705 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
706 // FIXME: should work on directories also.
711 HANDLE h = CreateFile(path.c_str(),
712 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
713 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
716 FILE_ATTRIBUTE_NORMAL,
718 if (h == INVALID_HANDLE_VALUE)
721 BY_HANDLE_FILE_INFORMATION bhfi;
722 if (!GetFileInformationByHandle(h, &bhfi)) {
723 DWORD err = GetLastError();
726 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
730 (uint64_t&)ft = si.modTime.toWin32Time();
731 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
732 DWORD err = GetLastError();
736 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
739 // Best we can do with Unix permission bits is to interpret the owner
741 if (si.mode & 0200) {
742 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
743 if (!SetFileAttributes(path.c_str(),
744 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
745 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
748 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
749 if (!SetFileAttributes(path.c_str(),
750 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
751 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
759 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
760 // Can't use CopyFile macro defined in Windows.h because it would mess up the
761 // above line. We use the expansion it would have in a non-UNICODE build.
762 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
763 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.toString() +
764 "' to '" + Dest.toString() + "': ");
769 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
770 if (reuse_current && !exists())
771 return false; // File doesn't exist already, just use it!
773 // Reserve space for -XXXXXX at the end.
774 char *FNBuffer = (char*) alloca(path.size()+8);
775 unsigned offset = path.size();
776 path.copy(FNBuffer, offset);
778 // Find a numeric suffix that isn't used by an existing file. Assume there
779 // won't be more than 1 million files with the same prefix. Probably a safe
781 static unsigned FCounter = 0;
783 sprintf(FNBuffer+offset, "-%06u", FCounter);
784 if (++FCounter > 999999)
792 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
793 // Make this into a unique file name
794 makeUnique(reuse_current, ErrMsg);
796 // Now go and create it
797 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
798 FILE_ATTRIBUTE_NORMAL, NULL);
799 if (h == INVALID_HANDLE_VALUE)
800 return MakeErrMsg(ErrMsg, path + ": can't create file");
806 /// MapInFilePages - Not yet implemented on win32.
807 const char *Path::MapInFilePages(int FD, uint64_t FileSize) {
811 /// MapInFilePages - Not yet implemented on win32.
812 void Path::UnMapFilePages(const char *Base, uint64_t FileSize) {
813 assert(0 && "NOT IMPLEMENTED");