1 //===- llvm/System/Linux/Path.cpp - Linux Path Implementation ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Reid Spencer and is distributed under the
6 // University of Illinois Open Source 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:
28 // Windows happily accepts either forward or backward slashes, though any path
29 // returned by a Win32 API will have backward slashes. As LLVM code basically
30 // assumes forward slashes are used, backward slashs are converted where they
31 // can be introduced into a path.
33 // Another invariant is that a path ends with a slash if and only if the path
34 // is a root directory. Any other use of a trailing slash is stripped. Unlike
35 // in Unix, Windows has a rather complicated notion of a root path and this
36 // invariant helps simply the code.
38 static void FlipBackSlashes(std::string& s) {
39 for (size_t i = 0; i < s.size(); i++)
48 Path::isValid() const {
52 // If there is a colon, it must be the second character, preceded by a letter
53 // and followed by something.
54 size_t len = path.size();
55 size_t pos = path.rfind(':',len);
57 if (pos != std::string::npos) {
58 if (pos != 1 || !isalpha(path[0]) || len < 3)
63 // Look for a UNC path, and if found adjust our notion of the root slash.
64 if (len > 3 && path[0] == '/' && path[1] == '/') {
65 rootslash = path.find('/', 2);
66 if (rootslash == std::string::npos)
70 // Check for illegal characters.
71 if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
72 "\013\014\015\016\017\020\021\022\023\024\025\026"
73 "\027\030\031\032\033\034\035\036\037")
77 // Remove trailing slash, unless it's a root slash.
78 if (len > rootslash+1 && path[len-1] == '/')
81 // Check each component for legality.
82 for (pos = 0; pos < len; ++pos) {
83 // A component may not end in a space.
84 if (path[pos] == ' ') {
85 if (path[pos+1] == '/' || path[pos+1] == '\0')
89 // A component may not end in a period.
90 if (path[pos] == '.') {
91 if (path[pos+1] == '/' || path[pos+1] == '\0') {
92 // Unless it is the pseudo-directory "."...
93 if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
96 if (pos > 0 && path[pos-1] == '.') {
97 if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
108 static Path *TempDirectory = NULL;
111 Path::GetTemporaryDirectory() {
113 return *TempDirectory;
115 char pathname[MAX_PATH];
116 if (!GetTempPath(MAX_PATH, pathname))
117 throw std::string("Can't determine temporary directory");
120 result.set(pathname);
122 // Append a subdirectory passed on our process id so multiple LLVMs don't
123 // step on each other's toes.
124 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
125 result.appendComponent(pathname);
127 // If there's a directory left over from a previous LLVM execution that
128 // happened to have the same process id, get rid of it.
129 result.eraseFromDisk(true);
131 // And finally (re-)create the empty directory.
132 result.createDirectoryOnDisk(false);
133 TempDirectory = new Path(result);
134 return *TempDirectory;
137 Path::Path(const std::string& unverified_path)
138 : path(unverified_path)
140 FlipBackSlashes(path);
141 if (unverified_path.empty())
147 throw std::string(unverified_path + ": path is not valid");
150 // FIXME: the following set of functions don't map to Windows very well.
152 Path::GetRootDirectory() {
158 static void getPathList(const char*path, std::vector<sys::Path>& Paths) {
159 const char* at = path;
160 const char* delim = strchr(at, ';');
163 std::string tmp(at, size_t(delim-at));
164 if (tmpPath.set(tmp))
165 if (tmpPath.canRead())
166 Paths.push_back(tmpPath);
168 delim = strchr(at, ';');
172 if (tmpPath.set(std::string(at)))
173 if (tmpPath.canRead())
174 Paths.push_back(tmpPath);
178 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
179 Paths.push_back(sys::Path("C:/WINDOWS/SYSTEM32"));
180 Paths.push_back(sys::Path("C:/WINDOWS"));
184 Path::GetBytecodeLibraryPaths(std::vector<sys::Path>& Paths) {
185 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
187 getPathList(env_var,Paths);
192 if (tmpPath.set(LLVM_LIBDIR))
193 if (tmpPath.canRead())
194 Paths.push_back(tmpPath);
197 GetSystemLibraryPaths(Paths);
201 Path::GetLLVMDefaultConfigDir() {
202 // TODO: this isn't going to fly on Windows
203 return Path("/etc/llvm");
207 Path::GetUserHomeDirectory() {
208 // TODO: Typical Windows setup doesn't define HOME.
209 const char* home = getenv("HOME");
212 if (result.set(home))
215 return GetRootDirectory();
217 // FIXME: the above set of functions don't map to Windows very well.
220 Path::isFile() const {
221 WIN32_FILE_ATTRIBUTE_DATA fi;
222 BOOL rc = GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi);
224 return !(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
225 else if (GetLastError() != ERROR_NOT_FOUND)
226 ThrowError(std::string(path) + ": Can't get status: ");
231 Path::isDirectory() const {
232 WIN32_FILE_ATTRIBUTE_DATA fi;
233 BOOL rc = GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi);
235 return fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
236 else if (GetLastError() != ERROR_NOT_FOUND)
237 ThrowError(std::string(path) + ": Can't get status: ");
242 Path::isHidden() const {
243 WIN32_FILE_ATTRIBUTE_DATA fi;
244 BOOL rc = GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi);
246 return fi.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN;
247 else if (GetLastError() != ERROR_NOT_FOUND)
248 ThrowError(std::string(path) + ": Can't get status: ");
253 Path::isRootDirectory() const {
254 size_t len = path.size();
255 return len > 0 && path[len-1] == '/';
259 Path::getBasename() const {
260 // Find the last slash
261 size_t slash = path.rfind('/');
262 if (slash == std::string::npos)
267 size_t dot = path.rfind('.');
268 if (dot == std::string::npos || dot < slash)
269 return path.substr(slash);
271 return path.substr(slash, dot - slash);
274 bool Path::hasMagicNumber(const std::string &Magic) const {
275 std::string actualMagic;
276 if (getMagicNumber(actualMagic, Magic.size()))
277 return Magic == actualMagic;
282 Path::isBytecodeFile() const {
285 std::string actualMagic;
286 if (!getMagicNumber(actualMagic, 4))
288 return actualMagic == "llvc" || actualMagic == "llvm";
292 Path::exists() const {
293 DWORD attr = GetFileAttributes(path.c_str());
294 return attr != INVALID_FILE_ATTRIBUTES;
298 Path::canRead() const {
299 // FIXME: take security attributes into account.
300 DWORD attr = GetFileAttributes(path.c_str());
301 return attr != INVALID_FILE_ATTRIBUTES;
305 Path::canWrite() const {
306 // FIXME: take security attributes into account.
307 DWORD attr = GetFileAttributes(path.c_str());
308 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
312 Path::canExecute() const {
313 // FIXME: take security attributes into account.
314 DWORD attr = GetFileAttributes(path.c_str());
315 return attr != INVALID_FILE_ATTRIBUTES;
319 Path::getLast() const {
320 // Find the last slash
321 size_t pos = path.rfind('/');
323 // Handle the corner cases
324 if (pos == std::string::npos)
327 // If the last character is a slash, we have a root directory
328 if (pos == path.length()-1)
331 // Return everything after the last slash
332 return path.substr(pos+1);
336 Path::getStatusInfo(StatusInfo& info) const {
337 WIN32_FILE_ATTRIBUTE_DATA fi;
338 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
339 ThrowError(std::string(path) + ": Can't get status: ");
341 info.fileSize = fi.nFileSizeHigh;
342 info.fileSize <<= 32;
343 info.fileSize += fi.nFileSizeLow;
345 info.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
346 info.user = 9999; // Not applicable to Windows, so...
347 info.group = 9999; // Not applicable to Windows, so...
349 __int64 ft = *reinterpret_cast<__int64*>(&fi.ftLastWriteTime);
350 info.modTime.fromWin32Time(ft);
352 info.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
355 static bool AddPermissionBits(const std::string& Filename, int bits) {
356 DWORD attr = GetFileAttributes(Filename.c_str());
358 // If it doesn't exist, we're done.
359 if (attr == INVALID_FILE_ATTRIBUTES)
362 // The best we can do to interpret Unix permission bits is to use
363 // the owner writable bit.
364 if ((attr & FILE_ATTRIBUTE_READONLY) && (bits & 0200)) {
365 if (!SetFileAttributes(Filename.c_str(), attr & ~FILE_ATTRIBUTE_READONLY))
366 ThrowError(Filename + ": SetFileAttributes: ");
371 void Path::makeReadableOnDisk() {
372 // All files are readable on Windows (ignoring security attributes).
375 void Path::makeWriteableOnDisk() {
376 DWORD attr = GetFileAttributes(path.c_str());
378 // If it doesn't exist, we're done.
379 if (attr == INVALID_FILE_ATTRIBUTES)
382 if (attr & FILE_ATTRIBUTE_READONLY) {
383 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY))
384 ThrowError(std::string(path) + ": Can't make file writable: ");
388 void Path::makeExecutableOnDisk() {
389 // All files are executable on Windows (ignoring security attributes).
393 Path::getDirectoryContents(std::set<Path>& result) const {
399 std::string searchpath = path;
400 if (path.size() == 0 || searchpath[path.size()-1] == '/')
405 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
406 if (h == INVALID_HANDLE_VALUE) {
407 if (GetLastError() == ERROR_FILE_NOT_FOUND)
408 return true; // not really an error, now is it?
409 ThrowError(path + ": Can't read directory: ");
413 if (fd.cFileName[0] == '.')
416 aPath.appendComponent(&fd.cFileName[0]);
417 result.insert(aPath);
418 } while (FindNextFile(h, &fd));
420 DWORD err = GetLastError();
422 if (err != ERROR_NO_MORE_FILES) {
424 ThrowError(path + ": Can't read directory: ");
430 Path::set(const std::string& a_path) {
431 if (a_path.size() == 0)
433 std::string save(path);
435 FlipBackSlashes(path);
444 Path::appendComponent(const std::string& name) {
447 std::string save(path);
449 size_t last = path.size() - 1;
450 if (path[last] != '/')
462 Path::eraseComponent() {
463 size_t slashpos = path.rfind('/',path.size());
464 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
466 std::string save(path);
467 path.erase(slashpos);
476 Path::appendSuffix(const std::string& suffix) {
477 std::string save(path);
488 Path::eraseSuffix() {
489 size_t dotpos = path.rfind('.',path.size());
490 size_t slashpos = path.rfind('/',path.size());
491 if (dotpos != std::string::npos) {
492 if (slashpos == std::string::npos || dotpos > slashpos+1) {
493 std::string save(path);
494 path.erase(dotpos, path.size()-dotpos);
506 Path::createDirectoryOnDisk(bool create_parents) {
507 // Get a writeable copy of the path name
508 size_t len = path.length();
509 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
510 path.copy(pathname, len);
513 // Make sure it ends with a slash.
514 if (len == 0 || pathname[len - 1] != '/') {
519 // Determine starting point for initial / search.
520 char *next = pathname;
521 if (pathname[0] == '/' && pathname[1] == '/') {
523 next = strchr(pathname+2, '/');
525 throw std::string(pathname) + ": badly formed remote directory";
527 next = strchr(next+1, '/');
529 throw std::string(pathname) + ": badly formed remote directory";
532 throw std::string(pathname) + ": badly formed remote directory";
534 if (pathname[1] == ':')
535 next += 2; // skip drive letter
537 next++; // skip root directory
540 // If we're supposed to create intermediate directories
541 if (create_parents) {
542 // Loop through the directory components until we're done
544 next = strchr(next, '/');
546 if (!CreateDirectory(pathname, NULL))
547 ThrowError(std::string(pathname) + ": Can't create directory: ");
551 // Drop trailing slash.
553 if (!CreateDirectory(pathname, NULL)) {
554 ThrowError(std::string(pathname) + ": Can't create directory: ");
561 Path::createFileOnDisk() {
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 ThrowError(path + ": Can't create file: ");
573 Path::eraseFromDisk(bool remove_contents) const {
575 DWORD attr = GetFileAttributes(path.c_str());
577 // If it doesn't exist, we're done.
578 if (attr == INVALID_FILE_ATTRIBUTES)
581 // Read-only files cannot be deleted on Windows. Must remove the read-only
583 if (attr & FILE_ATTRIBUTE_READONLY) {
584 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY))
585 ThrowError(path + ": Can't destroy file: ");
588 if (!DeleteFile(path.c_str()))
589 ThrowError(path + ": Can't destroy file: ");
591 } else if (isDirectory()) {
592 // If it doesn't exist, we're done.
596 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
597 int lastchar = path.length() - 1 ;
598 path.copy(pathname, lastchar+1);
600 // Make path end with '/*'.
601 if (pathname[lastchar] != '/')
602 pathname[++lastchar] = '/';
603 pathname[lastchar+1] = '*';
604 pathname[lastchar+2] = 0;
606 if (remove_contents) {
608 HANDLE h = FindFirstFile(pathname, &fd);
610 // It's a bad idea to alter the contents of a directory while enumerating
611 // its contents. So build a list of its contents first, then destroy them.
613 if (h != INVALID_HANDLE_VALUE) {
614 std::vector<Path> list;
617 if (strcmp(fd.cFileName, ".") == 0)
619 if (strcmp(fd.cFileName, "..") == 0)
623 aPath.appendComponent(&fd.cFileName[0]);
624 list.push_back(aPath);
625 } while (FindNextFile(h, &fd));
627 DWORD err = GetLastError();
629 if (err != ERROR_NO_MORE_FILES) {
631 ThrowError(path + ": Can't read directory: ");
634 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
637 aPath.eraseFromDisk(true);
640 if (GetLastError() != ERROR_FILE_NOT_FOUND)
641 ThrowError(path + ": Can't read directory: ");
645 pathname[lastchar] = 0;
646 if (!RemoveDirectory(pathname))
647 ThrowError(std::string(pathname) + ": Can't destroy directory: ");
650 // It appears the path doesn't exist.
655 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
658 assert(len < 1024 && "Request for magic string too long");
659 char* buf = (char*) alloca(1 + len);
661 HANDLE h = CreateFile(path.c_str(),
666 FILE_ATTRIBUTE_NORMAL,
668 if (h == INVALID_HANDLE_VALUE)
672 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
675 if (!ret || nRead != len)
684 Path::renamePathOnDisk(const Path& newName) {
685 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
686 ThrowError("Can't move '" + path +
687 "' to '" + newName.path + "': ");
692 Path::setStatusInfoOnDisk(const StatusInfo& si) const {
693 // FIXME: should work on directories also.
694 if (!isFile()) return false;
696 HANDLE h = CreateFile(path.c_str(),
697 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
698 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
701 FILE_ATTRIBUTE_NORMAL,
703 if (h == INVALID_HANDLE_VALUE)
706 BY_HANDLE_FILE_INFORMATION bhfi;
707 if (!GetFileInformationByHandle(h, &bhfi)) {
708 DWORD err = GetLastError();
711 ThrowError(path + ": GetFileInformationByHandle: ");
715 (uint64_t&)ft = si.modTime.toWin32Time();
716 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
717 DWORD err = GetLastError();
721 ThrowError(path + ": SetFileTime: ");
724 // Best we can do with Unix permission bits is to interpret the owner
726 if (si.mode & 0200) {
727 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
728 if (!SetFileAttributes(path.c_str(),
729 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
730 ThrowError(path + ": SetFileAttributes: ");
733 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
734 if (!SetFileAttributes(path.c_str(),
735 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
736 ThrowError(path + ": SetFileAttributes: ");
744 CopyFile(const sys::Path &Dest, const sys::Path &Src) {
745 // Can't use CopyFile macro defined in Windows.h because it would mess up the
746 // above line. We use the expansion it would have in a non-UNICODE build.
747 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
748 ThrowError("Can't copy '" + Src.toString() +
749 "' to '" + Dest.toString() + "': ");
753 Path::makeUnique(bool reuse_current) {
754 if (reuse_current && !exists())
755 return; // File doesn't exist already, just use it!
757 // Reserve space for -XXXXXX at the end.
758 char *FNBuffer = (char*) alloca(path.size()+8);
759 unsigned offset = path.size();
760 path.copy(FNBuffer, offset);
762 // Find a numeric suffix that isn't used by an existing file. Assume there
763 // won't be more than 1 million files with the same prefix. Probably a safe
765 static unsigned FCounter = 0;
767 sprintf(FNBuffer+offset, "-%06u", FCounter);
768 if (++FCounter > 999999)
775 Path::createTemporaryFileOnDisk(bool reuse_current) {
776 // Make this into a unique file name
777 makeUnique(reuse_current);
779 // Now go and create it
780 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
781 FILE_ATTRIBUTE_NORMAL, NULL);
782 if (h == INVALID_HANDLE_VALUE)