1 //===- llvm/System/Linux/Path.cpp - Linux 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++)
49 Path::isValid() const {
53 // If there is a colon, it must be the second character, preceded by a letter
54 // and followed by something.
55 size_t len = path.size();
56 size_t pos = path.rfind(':',len);
58 if (pos != std::string::npos) {
59 if (pos != 1 || !isalpha(path[0]) || len < 3)
64 // Look for a UNC path, and if found adjust our notion of the root slash.
65 if (len > 3 && path[0] == '/' && path[1] == '/') {
66 rootslash = path.find('/', 2);
67 if (rootslash == std::string::npos)
71 // Check for illegal characters.
72 if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
73 "\013\014\015\016\017\020\021\022\023\024\025\026"
74 "\027\030\031\032\033\034\035\036\037")
78 // Remove trailing slash, unless it's a root slash.
79 if (len > rootslash+1 && path[len-1] == '/')
82 // Check each component for legality.
83 for (pos = 0; pos < len; ++pos) {
84 // A component may not end in a space.
85 if (path[pos] == ' ') {
86 if (path[pos+1] == '/' || path[pos+1] == '\0')
90 // A component may not end in a period.
91 if (path[pos] == '.') {
92 if (path[pos+1] == '/' || path[pos+1] == '\0') {
93 // Unless it is the pseudo-directory "."...
94 if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
97 if (pos > 0 && path[pos-1] == '.') {
98 if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
110 Path::isAbsolute() const {
111 switch (path.length()) {
116 return path[0] == '/';
118 return path[0] == '/' || (path[1] == ':' && path[2] == '/');
122 static Path *TempDirectory = NULL;
125 Path::GetTemporaryDirectory(std::string* ErrMsg) {
127 return *TempDirectory;
129 char pathname[MAX_PATH];
130 if (!GetTempPath(MAX_PATH, pathname)) {
132 *ErrMsg = "Can't determine temporary directory";
137 result.set(pathname);
139 // Append a subdirectory passed on our process id so multiple LLVMs don't
140 // step on each other's toes.
142 // Mingw's Win32 header files are broken.
143 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
145 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
147 result.appendComponent(pathname);
149 // If there's a directory left over from a previous LLVM execution that
150 // happened to have the same process id, get rid of it.
151 result.eraseFromDisk(true);
153 // And finally (re-)create the empty directory.
154 result.createDirectoryOnDisk(false);
155 TempDirectory = new Path(result);
156 return *TempDirectory;
159 // FIXME: the following set of functions don't map to Windows very well.
161 Path::GetRootDirectory() {
167 static void getPathList(const char*path, std::vector<sys::Path>& Paths) {
168 const char* at = path;
169 const char* delim = strchr(at, ';');
172 std::string tmp(at, size_t(delim-at));
173 if (tmpPath.set(tmp))
174 if (tmpPath.canRead())
175 Paths.push_back(tmpPath);
177 delim = strchr(at, ';');
181 if (tmpPath.set(std::string(at)))
182 if (tmpPath.canRead())
183 Paths.push_back(tmpPath);
187 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
188 Paths.push_back(sys::Path("C:/WINDOWS/SYSTEM32"));
189 Paths.push_back(sys::Path("C:/WINDOWS"));
193 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
194 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
196 getPathList(env_var,Paths);
201 if (tmpPath.set(LLVM_LIBDIR))
202 if (tmpPath.canRead())
203 Paths.push_back(tmpPath);
206 GetSystemLibraryPaths(Paths);
210 Path::GetLLVMDefaultConfigDir() {
211 // TODO: this isn't going to fly on Windows
212 return Path("/etc/llvm");
216 Path::GetUserHomeDirectory() {
217 // TODO: Typical Windows setup doesn't define HOME.
218 const char* home = getenv("HOME");
221 if (result.set(home))
224 return GetRootDirectory();
228 Path::GetCurrentDirectory() {
229 char pathname[MAX_PATH];
230 ::GetCurrentDirectoryA(MAX_PATH,pathname);
231 return Path(pathname);
235 // FIXME: the above set of functions don't map to Windows very well.
239 Path::isRootDirectory() const {
240 size_t len = path.size();
241 return len > 0 && path[len-1] == '/';
245 Path::getBasename() const {
246 // Find the last slash
247 size_t slash = path.rfind('/');
248 if (slash == std::string::npos)
253 size_t dot = path.rfind('.');
254 if (dot == std::string::npos || dot < slash)
255 return path.substr(slash);
257 return path.substr(slash, dot - slash);
261 Path::exists() const {
262 DWORD attr = GetFileAttributes(path.c_str());
263 return attr != INVALID_FILE_ATTRIBUTES;
267 Path::isDirectory() const {
268 DWORD attr = GetFileAttributes(path.c_str());
269 return (attr != INVALID_FILE_ATTRIBUTES) &&
270 (attr & FILE_ATTRIBUTE_DIRECTORY);
274 Path::canRead() const {
275 // FIXME: take security attributes into account.
276 DWORD attr = GetFileAttributes(path.c_str());
277 return attr != INVALID_FILE_ATTRIBUTES;
281 Path::canWrite() const {
282 // FIXME: take security attributes into account.
283 DWORD attr = GetFileAttributes(path.c_str());
284 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
288 Path::canExecute() const {
289 // FIXME: take security attributes into account.
290 DWORD attr = GetFileAttributes(path.c_str());
291 return attr != INVALID_FILE_ATTRIBUTES;
295 Path::getLast() const {
296 // Find the last slash
297 size_t pos = path.rfind('/');
299 // Handle the corner cases
300 if (pos == std::string::npos)
303 // If the last character is a slash, we have a root directory
304 if (pos == path.length()-1)
307 // Return everything after the last slash
308 return path.substr(pos+1);
312 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
313 if (!fsIsValid || update) {
314 WIN32_FILE_ATTRIBUTE_DATA fi;
315 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
316 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
317 ": Can't get status: ");
321 status.fileSize = fi.nFileSizeHigh;
322 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
323 status.fileSize += fi.nFileSizeLow;
325 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
326 status.user = 9999; // Not applicable to Windows, so...
327 status.group = 9999; // Not applicable to Windows, so...
329 // FIXME: this is only unique if the file is accessed by the same file path.
330 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
331 // numbers, but the concept doesn't exist in Windows.
333 for (unsigned i = 0; i < path.length(); ++i)
334 status.uniqueID += path[i];
336 __int64 ft = *reinterpret_cast<__int64*>(&fi.ftLastWriteTime);
337 status.modTime.fromWin32Time(ft);
339 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
345 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
346 // All files are readable on Windows (ignoring security attributes).
350 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
351 DWORD attr = GetFileAttributes(path.c_str());
353 // If it doesn't exist, we're done.
354 if (attr == INVALID_FILE_ATTRIBUTES)
357 if (attr & FILE_ATTRIBUTE_READONLY) {
358 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
359 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
366 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
367 // All files are executable on Windows (ignoring security attributes).
372 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
373 WIN32_FILE_ATTRIBUTE_DATA fi;
374 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
375 MakeErrMsg(ErrMsg, path + ": can't get status of file");
379 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
381 *ErrMsg = path + ": not a directory";
387 std::string searchpath = path;
388 if (path.size() == 0 || searchpath[path.size()-1] == '/')
393 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
394 if (h == INVALID_HANDLE_VALUE) {
395 if (GetLastError() == ERROR_FILE_NOT_FOUND)
396 return true; // not really an error, now is it?
397 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
402 if (fd.cFileName[0] == '.')
405 aPath.appendComponent(&fd.cFileName[0]);
406 result.insert(aPath);
407 } while (FindNextFile(h, &fd));
409 DWORD err = GetLastError();
411 if (err != ERROR_NO_MORE_FILES) {
413 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
420 Path::set(const std::string& a_path) {
423 std::string save(path);
425 FlipBackSlashes(path);
434 Path::appendComponent(const std::string& name) {
437 std::string save(path);
439 size_t last = path.size() - 1;
440 if (path[last] != '/')
452 Path::eraseComponent() {
453 size_t slashpos = path.rfind('/',path.size());
454 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
456 std::string save(path);
457 path.erase(slashpos);
466 Path::appendSuffix(const std::string& suffix) {
467 std::string save(path);
478 Path::eraseSuffix() {
479 size_t dotpos = path.rfind('.',path.size());
480 size_t slashpos = path.rfind('/',path.size());
481 if (dotpos != std::string::npos) {
482 if (slashpos == std::string::npos || dotpos > slashpos+1) {
483 std::string save(path);
484 path.erase(dotpos, path.size()-dotpos);
495 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
497 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
502 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
503 // Get a writeable copy of the path name
504 size_t len = path.length();
505 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
506 path.copy(pathname, len);
509 // Make sure it ends with a slash.
510 if (len == 0 || pathname[len - 1] != '/') {
515 // Determine starting point for initial / search.
516 char *next = pathname;
517 if (pathname[0] == '/' && pathname[1] == '/') {
519 next = strchr(pathname+2, '/');
521 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
524 next = strchr(next+1, '/');
526 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
530 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
533 if (pathname[1] == ':')
534 next += 2; // skip drive letter
536 next++; // skip root directory
539 // If we're supposed to create intermediate directories
540 if (create_parents) {
541 // Loop through the directory components until we're done
543 next = strchr(next, '/');
545 if (!CreateDirectory(pathname, NULL))
546 return MakeErrMsg(ErrMsg,
547 std::string(pathname) + ": Can't create directory: ");
551 // Drop trailing slash.
553 if (!CreateDirectory(pathname, NULL)) {
554 return MakeErrMsg(ErrMsg, std::string(pathname) + ": Can't create directory: ");
561 Path::createFileOnDisk(std::string* ErrMsg) {
563 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
564 FILE_ATTRIBUTE_NORMAL, NULL);
565 if (h == INVALID_HANDLE_VALUE)
566 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
573 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
574 WIN32_FILE_ATTRIBUTE_DATA fi;
575 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
578 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
579 // If it doesn't exist, we're done.
583 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
584 int lastchar = path.length() - 1 ;
585 path.copy(pathname, lastchar+1);
587 // Make path end with '/*'.
588 if (pathname[lastchar] != '/')
589 pathname[++lastchar] = '/';
590 pathname[lastchar+1] = '*';
591 pathname[lastchar+2] = 0;
593 if (remove_contents) {
595 HANDLE h = FindFirstFile(pathname, &fd);
597 // It's a bad idea to alter the contents of a directory while enumerating
598 // its contents. So build a list of its contents first, then destroy them.
600 if (h != INVALID_HANDLE_VALUE) {
601 std::vector<Path> list;
604 if (strcmp(fd.cFileName, ".") == 0)
606 if (strcmp(fd.cFileName, "..") == 0)
610 aPath.appendComponent(&fd.cFileName[0]);
611 list.push_back(aPath);
612 } while (FindNextFile(h, &fd));
614 DWORD err = GetLastError();
616 if (err != ERROR_NO_MORE_FILES) {
618 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
621 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
624 aPath.eraseFromDisk(true);
627 if (GetLastError() != ERROR_FILE_NOT_FOUND)
628 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
632 pathname[lastchar] = 0;
633 if (!RemoveDirectory(pathname))
634 return MakeErrMsg(ErrStr,
635 std::string(pathname) + ": Can't destroy directory: ");
638 // Read-only files cannot be deleted on Windows. Must remove the read-only
640 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
641 if (!SetFileAttributes(path.c_str(),
642 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
643 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
646 if (!DeleteFile(path.c_str()))
647 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
652 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
653 assert(len < 1024 && "Request for magic string too long");
654 char* buf = (char*) alloca(1 + len);
656 HANDLE h = CreateFile(path.c_str(),
661 FILE_ATTRIBUTE_NORMAL,
663 if (h == INVALID_HANDLE_VALUE)
667 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
670 if (!ret || nRead != len)
679 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
680 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
681 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
687 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
688 // FIXME: should work on directories also.
693 HANDLE h = CreateFile(path.c_str(),
694 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
695 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
698 FILE_ATTRIBUTE_NORMAL,
700 if (h == INVALID_HANDLE_VALUE)
703 BY_HANDLE_FILE_INFORMATION bhfi;
704 if (!GetFileInformationByHandle(h, &bhfi)) {
705 DWORD err = GetLastError();
708 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
712 (uint64_t&)ft = si.modTime.toWin32Time();
713 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
714 DWORD err = GetLastError();
718 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
721 // Best we can do with Unix permission bits is to interpret the owner
723 if (si.mode & 0200) {
724 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
725 if (!SetFileAttributes(path.c_str(),
726 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
727 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
730 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
731 if (!SetFileAttributes(path.c_str(),
732 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
733 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
741 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
742 // Can't use CopyFile macro defined in Windows.h because it would mess up the
743 // above line. We use the expansion it would have in a non-UNICODE build.
744 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
745 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.toString() +
746 "' to '" + Dest.toString() + "': ");
751 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
752 if (reuse_current && !exists())
753 return false; // File doesn't exist already, just use it!
755 // Reserve space for -XXXXXX at the end.
756 char *FNBuffer = (char*) alloca(path.size()+8);
757 unsigned offset = path.size();
758 path.copy(FNBuffer, offset);
760 // Find a numeric suffix that isn't used by an existing file. Assume there
761 // won't be more than 1 million files with the same prefix. Probably a safe
763 static unsigned FCounter = 0;
765 sprintf(FNBuffer+offset, "-%06u", FCounter);
766 if (++FCounter > 999999)
774 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
775 // Make this into a unique file name
776 makeUnique(reuse_current, ErrMsg);
778 // Now go and create it
779 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
780 FILE_ATTRIBUTE_NORMAL, NULL);
781 if (h == INVALID_HANDLE_VALUE)
782 return MakeErrMsg(ErrMsg, path + ": can't create file");