lib/Support/Windows/Path.inc

   1 //===- llvm/Support/Win32/Path.cpp - Win32 Path Implementation ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file provides the Win32 specific implementation of the Path class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 //===----------------------------------------------------------------------===//
  15 //=== WARNING: Implementation here must contain only generic Win32 code that
  16 //===          is guaranteed to work on *all* Win32 variants.
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "Windows.h"
  20 #include <cstdio>
  21 #include <malloc.h>
  22
  23 // We need to undo a macro defined in Windows.h, otherwise we won't compile:
  24 #undef GetCurrentDirectory
  25
  26 // Windows happily accepts either forward or backward slashes, though any path
  27 // returned by a Win32 API will have backward slashes.  As LLVM code basically
  28 // assumes forward slashes are used, backward slashs are converted where they
  29 // can be introduced into a path.
  30 //
  31 // Another invariant is that a path ends with a slash if and only if the path
  32 // is a root directory.  Any other use of a trailing slash is stripped.  Unlike
  33 // in Unix, Windows has a rather complicated notion of a root path and this
  34 // invariant helps simply the code.
  35
  36 static void FlipBackSlashes(std::string& s) {
  37   for (size_t i = 0; i < s.size(); i++)
  38     if (s[i] == '\\')
  39       s[i] = '/';
  40 }
  41
  42 namespace llvm {
  43 namespace sys {
  44
  45 const char PathSeparator = ';';
  46
  47 StringRef Path::GetEXESuffix() {
  48   return "exe";
  49 }
  50
  51 Path::Path(llvm::StringRef p)
  52   : path(p) {
  53   FlipBackSlashes(path);
  54 }
  55
  56 Path::Path(const char *StrStart, unsigned StrLen)
  57   : path(StrStart, StrLen) {
  58   FlipBackSlashes(path);
  59 }
  60
  61 Path&
  62 Path::operator=(StringRef that) {
  63   path.assign(that.data(), that.size());
  64   FlipBackSlashes(path);
  65   return *this;
  66 }
  67
  68 bool
  69 Path::isValid() const {
  70   if (path.empty())
  71     return false;
  72
  73   size_t len = path.size();
  74   // If there is a null character, it and all its successors are ignored.
  75   size_t pos = path.find_first_of('\0');
  76   if (pos != std::string::npos)
  77     len = pos;
  78
  79   // If there is a colon, it must be the second character, preceded by a letter
  80   // and followed by something.
  81   pos = path.rfind(':',len);
  82   size_t rootslash = 0;
  83   if (pos != std::string::npos) {
  84     if (pos != 1 || !isalpha(static_cast<unsigned char>(path[0])) || len < 3)
  85       return false;
  86       rootslash = 2;
  87   }
  88
  89   // Look for a UNC path, and if found adjust our notion of the root slash.
  90   if (len > 3 && path[0] == '/' && path[1] == '/') {
  91     rootslash = path.find('/', 2);
  92     if (rootslash == std::string::npos)
  93       rootslash = 0;
  94   }
  95
  96   // Check for illegal characters.
  97   if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
  98                          "\013\014\015\016\017\020\021\022\023\024\025\026"
  99                          "\027\030\031\032\033\034\035\036\037")
 100       != std::string::npos)
 101     return false;
 102
 103   // Remove trailing slash, unless it's a root slash.
 104   if (len > rootslash+1 && path[len-1] == '/')
 105     path.erase(--len);
 106
 107   // Check each component for legality.
 108   for (pos = 0; pos < len; ++pos) {
 109     // A component may not end in a space.
 110     if (path[pos] == ' ') {
 111       if (pos+1 == len || path[pos+1] == '/' || path[pos+1] == '\0')
 112         return false;
 113     }
 114
 115     // A component may not end in a period.
 116     if (path[pos] == '.') {
 117       if (pos+1 == len || path[pos+1] == '/') {
 118         // Unless it is the pseudo-directory "."...
 119         if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
 120           return true;
 121         // or "..".
 122         if (pos > 0 && path[pos-1] == '.') {
 123           if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
 124             return true;
 125         }
 126         return false;
 127       }
 128     }
 129   }
 130
 131   return true;
 132 }
 133
 134 void Path::makeAbsolute() {
 135   TCHAR  FullPath[MAX_PATH + 1] = {0};
 136   LPTSTR FilePart = NULL;
 137
 138   DWORD RetLength = ::GetFullPathNameA(path.c_str(),
 139                         sizeof(FullPath)/sizeof(FullPath[0]),
 140                         FullPath, &FilePart);
 141
 142   if (0 == RetLength) {
 143     // FIXME: Report the error GetLastError()
 144     assert(0 && "Unable to make absolute path!");
 145   } else if (RetLength > MAX_PATH) {
 146     // FIXME: Report too small buffer (needed RetLength bytes).
 147     assert(0 && "Unable to make absolute path!");
 148   } else {
 149     path = FullPath;
 150   }
 151 }
 152
 153 static Path *TempDirectory;
 154
 155 Path
 156 Path::GetTemporaryDirectory(std::string* ErrMsg) {
 157   if (TempDirectory) {
 158 #if defined(_MSC_VER)
 159     // Visual Studio gets confused and emits a diagnostic about calling exists,
 160     // even though this is the implementation for PathV1.  Temporarily
 161     // disable the deprecated warning message
 162     #pragma warning(push)
 163     #pragma warning(disable:4996)
 164 #endif
 165     assert(TempDirectory->exists() && "Who has removed TempDirectory?");
 166 #if defined(_MSC_VER)
 167     #pragma warning(pop)
 168 #endif
 169     return *TempDirectory;
 170   }
 171
 172   char pathname[MAX_PATH];
 173   if (!GetTempPath(MAX_PATH, pathname)) {
 174     if (ErrMsg)
 175       *ErrMsg = "Can't determine temporary directory";
 176     return Path();
 177   }
 178
 179   Path result;
 180   result.set(pathname);
 181
 182   // Append a subdirectory based on our process id so multiple LLVMs don't
 183   // step on each other's toes.
 184 #ifdef __MINGW32__
 185   // Mingw's Win32 header files are broken.
 186   sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
 187 #else
 188   sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
 189 #endif
 190   result.appendComponent(pathname);
 191
 192   // If there's a directory left over from a previous LLVM execution that
 193   // happened to have the same process id, get rid of it.
 194   result.eraseFromDisk(true);
 195
 196   // And finally (re-)create the empty directory.
 197   result.createDirectoryOnDisk(false);
 198   TempDirectory = new Path(result);
 199   return *TempDirectory;
 200 }
 201
 202 Path
 203 Path::GetCurrentDirectory() {
 204   char pathname[MAX_PATH];
 205   ::GetCurrentDirectoryA(MAX_PATH,pathname);
 206   return Path(pathname);
 207 }
 208
 209 /// GetMainExecutable - Return the path to the main executable, given the
 210 /// value of argv[0] from program startup.
 211 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
 212   char pathname[MAX_PATH];
 213   DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
 214   return ret != MAX_PATH ? Path(pathname) : Path();
 215 }
 216
 217
 218 // FIXME: the above set of functions don't map to Windows very well.
 219
 220 bool
 221 Path::exists() const {
 222   DWORD attr = GetFileAttributes(path.c_str());
 223   return attr != INVALID_FILE_ATTRIBUTES;
 224 }
 225
 226 bool
 227 Path::isDirectory() const {
 228   DWORD attr = GetFileAttributes(path.c_str());
 229   return (attr != INVALID_FILE_ATTRIBUTES) &&
 230          (attr & FILE_ATTRIBUTE_DIRECTORY);
 231 }
 232
 233 bool
 234 Path::isSymLink() const {
 235   DWORD attributes = GetFileAttributes(path.c_str());
 236
 237   if (attributes == INVALID_FILE_ATTRIBUTES)
 238     // There's no sane way to report this :(.
 239     assert(0 && "GetFileAttributes returned INVALID_FILE_ATTRIBUTES");
 240
 241   // This isn't exactly what defines a NTFS symlink, but it is only true for
 242   // paths that act like a symlink.
 243   return attributes & FILE_ATTRIBUTE_REPARSE_POINT;
 244 }
 245
 246 bool
 247 Path::isRegularFile() const {
 248   bool res;
 249   if (fs::is_regular_file(path, res))
 250     return false;
 251   return res;
 252 }
 253
 254 const FileStatus *
 255 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
 256   if (!fsIsValid || update) {
 257     WIN32_FILE_ATTRIBUTE_DATA fi;
 258     if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
 259       MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
 260                       ": Can't get status: ");
 261       return 0;
 262     }
 263
 264     status.fileSize = fi.nFileSizeHigh;
 265     status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
 266     status.fileSize += fi.nFileSizeLow;
 267
 268     status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
 269     status.user = 9999;    // Not applicable to Windows, so...
 270     status.group = 9999;   // Not applicable to Windows, so...
 271
 272     ULARGE_INTEGER ui;
 273     ui.LowPart = fi.ftLastWriteTime.dwLowDateTime;
 274     ui.HighPart = fi.ftLastWriteTime.dwHighDateTime;
 275     status.modTime.fromWin32Time(ui.QuadPart);
 276
 277     status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
 278     fsIsValid = true;
 279   }
 280   return &status;
 281 }
 282
 283 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
 284   // All files are readable on Windows (ignoring security attributes).
 285   return false;
 286 }
 287
 288 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
 289   DWORD attr = GetFileAttributes(path.c_str());
 290
 291   // If it doesn't exist, we're done.
 292   if (attr == INVALID_FILE_ATTRIBUTES)
 293     return false;
 294
 295   if (attr & FILE_ATTRIBUTE_READONLY) {
 296     if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
 297       MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
 298       return true;
 299     }
 300   }
 301   return false;
 302 }
 303
 304 bool
 305 Path::set(StringRef a_path) {
 306   if (a_path.empty())
 307     return false;
 308   std::string save(path);
 309   path = a_path;
 310   FlipBackSlashes(path);
 311   if (!isValid()) {
 312     path = save;
 313     return false;
 314   }
 315   return true;
 316 }
 317
 318 bool
 319 Path::appendComponent(StringRef name) {
 320   if (name.empty())
 321     return false;
 322   std::string save(path);
 323   if (!path.empty()) {
 324     size_t last = path.size() - 1;
 325     if (path[last] != '/')
 326       path += '/';
 327   }
 328   path += name;
 329   if (!isValid()) {
 330     path = save;
 331     return false;
 332   }
 333   return true;
 334 }
 335
 336 bool
 337 Path::eraseComponent() {
 338   size_t slashpos = path.rfind('/',path.size());
 339   if (slashpos == path.size() - 1 || slashpos == std::string::npos)
 340     return false;
 341   std::string save(path);
 342   path.erase(slashpos);
 343   if (!isValid()) {
 344     path = save;
 345     return false;
 346   }
 347   return true;
 348 }
 349
 350 bool
 351 Path::eraseSuffix() {
 352   size_t dotpos = path.rfind('.',path.size());
 353   size_t slashpos = path.rfind('/',path.size());
 354   if (dotpos != std::string::npos) {
 355     if (slashpos == std::string::npos || dotpos > slashpos+1) {
 356       std::string save(path);
 357       path.erase(dotpos, path.size()-dotpos);
 358       if (!isValid()) {
 359         path = save;
 360         return false;
 361       }
 362       return true;
 363     }
 364   }
 365   return false;
 366 }
 367
 368 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
 369   if (ErrMsg)
 370     *ErrMsg = std::string(pathname) + ": " + std::string(msg);
 371   return true;
 372 }
 373
 374 bool
 375 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
 376   // Get a writeable copy of the path name
 377   size_t len = path.length();
 378   char *pathname = reinterpret_cast<char *>(_alloca(len+2));
 379   path.copy(pathname, len);
 380   pathname[len] = 0;
 381
 382   // Make sure it ends with a slash.
 383   if (len == 0 || pathname[len - 1] != '/') {
 384     pathname[len] = '/';
 385     pathname[++len] = 0;
 386   }
 387
 388   // Determine starting point for initial / search.
 389   char *next = pathname;
 390   if (pathname[0] == '/' && pathname[1] == '/') {
 391     // Skip host name.
 392     next = strchr(pathname+2, '/');
 393     if (next == NULL)
 394       return PathMsg(ErrMsg, pathname, "badly formed remote directory");
 395
 396     // Skip share name.
 397     next = strchr(next+1, '/');
 398     if (next == NULL)
 399       return PathMsg(ErrMsg, pathname,"badly formed remote directory");
 400
 401     next++;
 402     if (*next == 0)
 403       return PathMsg(ErrMsg, pathname, "badly formed remote directory");
 404
 405   } else {
 406     if (pathname[1] == ':')
 407       next += 2;    // skip drive letter
 408     if (*next == '/')
 409       next++;       // skip root directory
 410   }
 411
 412   // If we're supposed to create intermediate directories
 413   if (create_parents) {
 414     // Loop through the directory components until we're done
 415     while (*next) {
 416       next = strchr(next, '/');
 417       *next = 0;
 418       if (!CreateDirectory(pathname, NULL) &&
 419           GetLastError() != ERROR_ALREADY_EXISTS)
 420           return MakeErrMsg(ErrMsg,
 421             std::string(pathname) + ": Can't create directory: ");
 422       *next++ = '/';
 423     }
 424   } else {
 425     // Drop trailing slash.
 426     pathname[len-1] = 0;
 427     if (!CreateDirectory(pathname, NULL) &&
 428         GetLastError() != ERROR_ALREADY_EXISTS) {
 429       return MakeErrMsg(ErrMsg, std::string(pathname) +
 430                         ": Can't create directory: ");
 431     }
 432   }
 433   return false;
 434 }
 435
 436 bool
 437 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
 438   WIN32_FILE_ATTRIBUTE_DATA fi;
 439   if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
 440     return true;
 441
 442   if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
 443     // If it doesn't exist, we're done.
 444     bool Exists;
 445     if (fs::exists(path, Exists) || !Exists)
 446       return false;
 447
 448     char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
 449     int lastchar = path.length() - 1 ;
 450     path.copy(pathname, lastchar+1);
 451
 452     // Make path end with '/*'.
 453     if (pathname[lastchar] != '/')
 454       pathname[++lastchar] = '/';
 455     pathname[lastchar+1] = '*';
 456     pathname[lastchar+2] = 0;
 457
 458     if (remove_contents) {
 459       WIN32_FIND_DATA fd;
 460       HANDLE h = FindFirstFile(pathname, &fd);
 461
 462       // It's a bad idea to alter the contents of a directory while enumerating
 463       // its contents. So build a list of its contents first, then destroy them.
 464
 465       if (h != INVALID_HANDLE_VALUE) {
 466         std::vector<Path> list;
 467
 468         do {
 469           if (strcmp(fd.cFileName, ".") == 0)
 470             continue;
 471           if (strcmp(fd.cFileName, "..") == 0)
 472             continue;
 473
 474           Path aPath(path);
 475           aPath.appendComponent(&fd.cFileName[0]);
 476           list.push_back(aPath);
 477         } while (FindNextFile(h, &fd));
 478
 479         DWORD err = GetLastError();
 480         FindClose(h);
 481         if (err != ERROR_NO_MORE_FILES) {
 482           SetLastError(err);
 483           return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
 484         }
 485
 486         for (std::vector<Path>::iterator I = list.begin(); I != list.end();
 487              ++I) {
 488           Path &aPath = *I;
 489           aPath.eraseFromDisk(true);
 490         }
 491       } else {
 492         if (GetLastError() != ERROR_FILE_NOT_FOUND)
 493           return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
 494       }
 495     }
 496
 497     pathname[lastchar] = 0;
 498     if (!RemoveDirectory(pathname))
 499       return MakeErrMsg(ErrStr,
 500         std::string(pathname) + ": Can't destroy directory: ");
 501     return false;
 502   } else {
 503     // Read-only files cannot be deleted on Windows.  Must remove the read-only
 504     // attribute first.
 505     if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
 506       if (!SetFileAttributes(path.c_str(),
 507                              fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
 508         return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
 509     }
 510
 511     if (!DeleteFile(path.c_str()))
 512       return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
 513     return false;
 514   }
 515 }
 516
 517 bool
 518 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
 519   if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
 520     return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
 521         + "': ");
 522   return false;
 523 }
 524
 525 bool
 526 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
 527   // FIXME: should work on directories also.
 528   if (!si.isFile) {
 529     return true;
 530   }
 531
 532   HANDLE h = CreateFile(path.c_str(),
 533                         FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
 534                         FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 535                         NULL,
 536                         OPEN_EXISTING,
 537                         FILE_ATTRIBUTE_NORMAL,
 538                         NULL);
 539   if (h == INVALID_HANDLE_VALUE)
 540     return true;
 541
 542   BY_HANDLE_FILE_INFORMATION bhfi;
 543   if (!GetFileInformationByHandle(h, &bhfi)) {
 544     DWORD err = GetLastError();
 545     CloseHandle(h);
 546     SetLastError(err);
 547     return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
 548   }
 549
 550   ULARGE_INTEGER ui;
 551   ui.QuadPart = si.modTime.toWin32Time();
 552   FILETIME ft;
 553   ft.dwLowDateTime = ui.LowPart;
 554   ft.dwHighDateTime = ui.HighPart;
 555   BOOL ret = SetFileTime(h, NULL, &ft, &ft);
 556   DWORD err = GetLastError();
 557   CloseHandle(h);
 558   if (!ret) {
 559     SetLastError(err);
 560     return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
 561   }
 562
 563   // Best we can do with Unix permission bits is to interpret the owner
 564   // writable bit.
 565   if (si.mode & 0200) {
 566     if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
 567       if (!SetFileAttributes(path.c_str(),
 568               bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
 569         return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
 570     }
 571   } else {
 572     if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
 573       if (!SetFileAttributes(path.c_str(),
 574               bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
 575         return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
 576     }
 577   }
 578
 579   return false;
 580 }
 581
 582 bool
 583 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
 584   bool Exists;
 585   if (reuse_current && (fs::exists(path, Exists) || !Exists))
 586     return false; // File doesn't exist already, just use it!
 587
 588   // Reserve space for -XXXXXX at the end.
 589   char *FNBuffer = (char*) alloca(path.size()+8);
 590   unsigned offset = path.size();
 591   path.copy(FNBuffer, offset);
 592
 593   // Find a numeric suffix that isn't used by an existing file.  Assume there
 594   // won't be more than 1 million files with the same prefix.  Probably a safe
 595   // bet.
 596   static int FCounter = -1;
 597   if (FCounter < 0) {
 598     // Give arbitrary initial seed.
 599     // FIXME: We should use sys::fs::unique_file() in future.
 600     LARGE_INTEGER cnt64;
 601     DWORD x = GetCurrentProcessId();
 602     x = (x << 16) | (x >> 16);
 603     if (QueryPerformanceCounter(&cnt64))    // RDTSC
 604       x ^= cnt64.HighPart ^ cnt64.LowPart;
 605     FCounter = x % 1000000;
 606   }
 607   do {
 608     sprintf(FNBuffer+offset, "-%06u", FCounter);
 609     if (++FCounter > 999999)
 610       FCounter = 0;
 611     path = FNBuffer;
 612   } while (!fs::exists(path, Exists) && Exists);
 613   return false;
 614 }
 615
 616 bool
 617 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
 618   // Make this into a unique file name
 619   makeUnique(reuse_current, ErrMsg);
 620
 621   // Now go and create it
 622   HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
 623                         FILE_ATTRIBUTE_NORMAL, NULL);
 624   if (h == INVALID_HANDLE_VALUE)
 625     return MakeErrMsg(ErrMsg, path + ": can't create file");
 626
 627   CloseHandle(h);
 628   return false;
 629 }
 630 }
 631 }