lib/Support/Windows/Path.inc

   1 //===- llvm/Support/Windows/Path.inc - Windows Path Impl --------*- 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 implements the Windows specific implementation of the Path API.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 //===----------------------------------------------------------------------===//
  15 //=== WARNING: Implementation here must contain only generic Windows code that
  16 //===          is guaranteed to work on *all* Windows variants.
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/Support/WindowsError.h"
  21 #include <fcntl.h>
  22 #include <io.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25
  26 // These two headers must be included last, and make sure shlobj is required
  27 // after Windows.h to make sure it picks up our definition of _WIN32_WINNT
  28 #include "WindowsSupport.h"
  29 #include <shlobj.h>
  30
  31 #undef max
  32
  33 // MinGW doesn't define this.
  34 #ifndef _ERRNO_T_DEFINED
  35 #define _ERRNO_T_DEFINED
  36 typedef int errno_t;
  37 #endif
  38
  39 #ifdef _MSC_VER
  40 # pragma comment(lib, "advapi32.lib")  // This provides CryptAcquireContextW.
  41 #endif
  42
  43 using namespace llvm;
  44
  45 using llvm::sys::windows::UTF8ToUTF16;
  46 using llvm::sys::windows::UTF16ToUTF8;
  47 using llvm::sys::path::widenPath;
  48
  49 static bool is_separator(const wchar_t value) {
  50   switch (value) {
  51   case L'\\':
  52   case L'/':
  53     return true;
  54   default:
  55     return false;
  56   }
  57 }
  58
  59 namespace llvm {
  60 namespace sys  {
  61 namespace path {
  62
  63 // Convert a UTF-8 path to UTF-16.  Also, if the absolute equivalent of the
  64 // path is longer than CreateDirectory can tolerate, make it absolute and
  65 // prefixed by '\\?\'.
  66 std::error_code widenPath(const Twine &Path8,
  67                           SmallVectorImpl<wchar_t> &Path16) {
  68   const size_t MaxDirLen = MAX_PATH - 12; // Must leave room for 8.3 filename.
  69
  70   // Several operations would convert Path8 to SmallString; more efficient to
  71   // do it once up front.
  72   SmallString<128> Path8Str;
  73   Path8.toVector(Path8Str);
  74
  75   // If we made this path absolute, how much longer would it get?
  76   size_t CurPathLen;
  77   if (llvm::sys::path::is_absolute(Twine(Path8Str)))
  78     CurPathLen = 0; // No contribution from current_path needed.
  79   else {
  80     CurPathLen = ::GetCurrentDirectoryW(0, NULL);
  81     if (CurPathLen == 0)
  82       return mapWindowsError(::GetLastError());
  83   }
  84
  85   // Would the absolute path be longer than our limit?
  86   if ((Path8Str.size() + CurPathLen) >= MaxDirLen &&
  87       !Path8Str.startswith("\\\\?\\")) {
  88     SmallString<2*MAX_PATH> FullPath("\\\\?\\");
  89     if (CurPathLen) {
  90       SmallString<80> CurPath;
  91       if (std::error_code EC = llvm::sys::fs::current_path(CurPath))
  92         return EC;
  93       FullPath.append(CurPath);
  94     }
  95     // Traverse the requested path, canonicalizing . and .. as we go (because
  96     // the \\?\ prefix is documented to treat them as real components).
  97     // The iterators don't report separators and append() always attaches
  98     // preferred_separator so we don't need to call native() on the result.
  99     for (llvm::sys::path::const_iterator I = llvm::sys::path::begin(Path8Str),
 100                                          E = llvm::sys::path::end(Path8Str);
 101                                          I != E; ++I) {
 102       if (I->size() == 1 && *I == ".")
 103         continue;
 104       if (I->size() == 2 && *I == "..")
 105         llvm::sys::path::remove_filename(FullPath);
 106       else
 107         llvm::sys::path::append(FullPath, *I);
 108     }
 109     return UTF8ToUTF16(FullPath, Path16);
 110   }
 111
 112   // Just use the caller's original path.
 113   return UTF8ToUTF16(Path8Str, Path16);
 114 }
 115 } // end namespace path
 116
 117 namespace fs {
 118
 119 std::string getMainExecutable(const char *argv0, void *MainExecAddr) {
 120   SmallVector<wchar_t, MAX_PATH> PathName;
 121   DWORD Size = ::GetModuleFileNameW(NULL, PathName.data(), PathName.capacity());
 122
 123   // A zero return value indicates a failure other than insufficient space.
 124   if (Size == 0)
 125     return "";
 126
 127   // Insufficient space is determined by a return value equal to the size of
 128   // the buffer passed in.
 129   if (Size == PathName.capacity())
 130     return "";
 131
 132   // On success, GetModuleFileNameW returns the number of characters written to
 133   // the buffer not including the NULL terminator.
 134   PathName.set_size(Size);
 135
 136   // Convert the result from UTF-16 to UTF-8.
 137   SmallVector<char, MAX_PATH> PathNameUTF8;
 138   if (UTF16ToUTF8(PathName.data(), PathName.size(), PathNameUTF8))
 139     return "";
 140
 141   return std::string(PathNameUTF8.data());
 142 }
 143
 144 UniqueID file_status::getUniqueID() const {
 145   // The file is uniquely identified by the volume serial number along
 146   // with the 64-bit file identifier.
 147   uint64_t FileID = (static_cast<uint64_t>(FileIndexHigh) << 32ULL) |
 148                     static_cast<uint64_t>(FileIndexLow);
 149
 150   return UniqueID(VolumeSerialNumber, FileID);
 151 }
 152
 153 TimeValue file_status::getLastModificationTime() const {
 154   ULARGE_INTEGER UI;
 155   UI.LowPart = LastWriteTimeLow;
 156   UI.HighPart = LastWriteTimeHigh;
 157
 158   TimeValue Ret;
 159   Ret.fromWin32Time(UI.QuadPart);
 160   return Ret;
 161 }
 162
 163 std::error_code current_path(SmallVectorImpl<char> &result) {
 164   SmallVector<wchar_t, MAX_PATH> cur_path;
 165   DWORD len = MAX_PATH;
 166
 167   do {
 168     cur_path.reserve(len);
 169     len = ::GetCurrentDirectoryW(cur_path.capacity(), cur_path.data());
 170
 171     // A zero return value indicates a failure other than insufficient space.
 172     if (len == 0)
 173       return mapWindowsError(::GetLastError());
 174
 175     // If there's insufficient space, the len returned is larger than the len
 176     // given.
 177   } while (len > cur_path.capacity());
 178
 179   // On success, GetCurrentDirectoryW returns the number of characters not
 180   // including the null-terminator.
 181   cur_path.set_size(len);
 182   return UTF16ToUTF8(cur_path.begin(), cur_path.size(), result);
 183 }
 184
 185 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
 186                                  perms Perms) {
 187   SmallVector<wchar_t, 128> path_utf16;
 188
 189   if (std::error_code ec = widenPath(path, path_utf16))
 190     return ec;
 191
 192   if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
 193     DWORD LastError = ::GetLastError();
 194     if (LastError != ERROR_ALREADY_EXISTS || !IgnoreExisting)
 195       return mapWindowsError(LastError);
 196   }
 197
 198   return std::error_code();
 199 }
 200
 201 // We can't use symbolic links for windows.
 202 std::error_code create_link(const Twine &to, const Twine &from) {
 203   // Convert to utf-16.
 204   SmallVector<wchar_t, 128> wide_from;
 205   SmallVector<wchar_t, 128> wide_to;
 206   if (std::error_code ec = widenPath(from, wide_from))
 207     return ec;
 208   if (std::error_code ec = widenPath(to, wide_to))
 209     return ec;
 210
 211   if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
 212     return mapWindowsError(::GetLastError());
 213
 214   return std::error_code();
 215 }
 216
 217 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
 218   SmallVector<wchar_t, 128> path_utf16;
 219
 220   file_status ST;
 221   if (std::error_code EC = status(path, ST)) {
 222     if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 223       return EC;
 224     return std::error_code();
 225   }
 226
 227   if (std::error_code ec = widenPath(path, path_utf16))
 228     return ec;
 229
 230   if (ST.type() == file_type::directory_file) {
 231     if (!::RemoveDirectoryW(c_str(path_utf16))) {
 232       std::error_code EC = mapWindowsError(::GetLastError());
 233       if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 234         return EC;
 235     }
 236     return std::error_code();
 237   }
 238   if (!::DeleteFileW(c_str(path_utf16))) {
 239     std::error_code EC = mapWindowsError(::GetLastError());
 240     if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 241       return EC;
 242   }
 243   return std::error_code();
 244 }
 245
 246 std::error_code rename(const Twine &from, const Twine &to) {
 247   // Convert to utf-16.
 248   SmallVector<wchar_t, 128> wide_from;
 249   SmallVector<wchar_t, 128> wide_to;
 250   if (std::error_code ec = widenPath(from, wide_from))
 251     return ec;
 252   if (std::error_code ec = widenPath(to, wide_to))
 253     return ec;
 254
 255   std::error_code ec = std::error_code();
 256
 257   // Retry while we see ERROR_ACCESS_DENIED.
 258   // System scanners (eg. indexer) might open the source file when it is written
 259   // and closed.
 260
 261   for (int i = 0; i < 2000; i++) {
 262     // Try ReplaceFile first, as it is able to associate a new data stream with
 263     // the destination even if the destination file is currently open.
 264     if (::ReplaceFileW(wide_to.begin(), wide_from.begin(), NULL, 0, NULL, NULL))
 265       return std::error_code();
 266
 267     // We get ERROR_FILE_NOT_FOUND if the destination file is missing.
 268     // MoveFileEx can handle this case.
 269     DWORD ReplaceError = ::GetLastError();
 270     ec = mapWindowsError(ReplaceError);
 271     if (ReplaceError != ERROR_ACCESS_DENIED &&
 272         ReplaceError != ERROR_FILE_NOT_FOUND &&
 273         ReplaceError != ERROR_SHARING_VIOLATION)
 274       break;
 275
 276     if (::MoveFileExW(wide_from.begin(), wide_to.begin(),
 277                       MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
 278       return std::error_code();
 279
 280     DWORD MoveError = ::GetLastError();
 281     ec = mapWindowsError(MoveError);
 282     if (MoveError != ERROR_ACCESS_DENIED) break;
 283
 284     ::Sleep(1);
 285   }
 286
 287   return ec;
 288 }
 289
 290 std::error_code resize_file(int FD, uint64_t Size) {
 291 #ifdef HAVE__CHSIZE_S
 292   errno_t error = ::_chsize_s(FD, Size);
 293 #else
 294   errno_t error = ::_chsize(FD, Size);
 295 #endif
 296   return std::error_code(error, std::generic_category());
 297 }
 298
 299 std::error_code access(const Twine &Path, AccessMode Mode) {
 300   SmallVector<wchar_t, 128> PathUtf16;
 301
 302   if (std::error_code EC = widenPath(Path, PathUtf16))
 303     return EC;
 304
 305   DWORD Attributes = ::GetFileAttributesW(PathUtf16.begin());
 306
 307   if (Attributes == INVALID_FILE_ATTRIBUTES) {
 308     // See if the file didn't actually exist.
 309     DWORD LastError = ::GetLastError();
 310     if (LastError != ERROR_FILE_NOT_FOUND &&
 311         LastError != ERROR_PATH_NOT_FOUND)
 312       return mapWindowsError(LastError);
 313     return errc::no_such_file_or_directory;
 314   }
 315
 316   if (Mode == AccessMode::Write && (Attributes & FILE_ATTRIBUTE_READONLY))
 317     return errc::permission_denied;
 318
 319   return std::error_code();
 320 }
 321
 322 bool can_execute(const Twine &Path) {
 323   return !access(Path, AccessMode::Execute) ||
 324          !access(Path + ".exe", AccessMode::Execute);
 325 }
 326
 327 bool equivalent(file_status A, file_status B) {
 328   assert(status_known(A) && status_known(B));
 329   return A.FileIndexHigh      == B.FileIndexHigh &&
 330          A.FileIndexLow       == B.FileIndexLow &&
 331          A.FileSizeHigh       == B.FileSizeHigh &&
 332          A.FileSizeLow        == B.FileSizeLow &&
 333          A.LastWriteTimeHigh  == B.LastWriteTimeHigh &&
 334          A.LastWriteTimeLow   == B.LastWriteTimeLow &&
 335          A.VolumeSerialNumber == B.VolumeSerialNumber;
 336 }
 337
 338 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 339   file_status fsA, fsB;
 340   if (std::error_code ec = status(A, fsA))
 341     return ec;
 342   if (std::error_code ec = status(B, fsB))
 343     return ec;
 344   result = equivalent(fsA, fsB);
 345   return std::error_code();
 346 }
 347
 348 static bool isReservedName(StringRef path) {
 349   // This list of reserved names comes from MSDN, at:
 350   // http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
 351   static const char *sReservedNames[] = { "nul", "con", "prn", "aux",
 352                               "com1", "com2", "com3", "com4", "com5", "com6",
 353                               "com7", "com8", "com9", "lpt1", "lpt2", "lpt3",
 354                               "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9" };
 355
 356   // First, check to see if this is a device namespace, which always
 357   // starts with \\.\, since device namespaces are not legal file paths.
 358   if (path.startswith("\\\\.\\"))
 359     return true;
 360
 361   // Then compare against the list of ancient reserved names
 362   for (size_t i = 0; i < array_lengthof(sReservedNames); ++i) {
 363     if (path.equals_lower(sReservedNames[i]))
 364       return true;
 365   }
 366
 367   // The path isn't what we consider reserved.
 368   return false;
 369 }
 370
 371 static std::error_code getStatus(HANDLE FileHandle, file_status &Result) {
 372   if (FileHandle == INVALID_HANDLE_VALUE)
 373     goto handle_status_error;
 374
 375   switch (::GetFileType(FileHandle)) {
 376   default:
 377     llvm_unreachable("Don't know anything about this file type");
 378   case FILE_TYPE_UNKNOWN: {
 379     DWORD Err = ::GetLastError();
 380     if (Err != NO_ERROR)
 381       return mapWindowsError(Err);
 382     Result = file_status(file_type::type_unknown);
 383     return std::error_code();
 384   }
 385   case FILE_TYPE_DISK:
 386     break;
 387   case FILE_TYPE_CHAR:
 388     Result = file_status(file_type::character_file);
 389     return std::error_code();
 390   case FILE_TYPE_PIPE:
 391     Result = file_status(file_type::fifo_file);
 392     return std::error_code();
 393   }
 394
 395   BY_HANDLE_FILE_INFORMATION Info;
 396   if (!::GetFileInformationByHandle(FileHandle, &Info))
 397     goto handle_status_error;
 398
 399   {
 400     file_type Type = (Info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 401                          ? file_type::directory_file
 402                          : file_type::regular_file;
 403     Result =
 404         file_status(Type, Info.ftLastWriteTime.dwHighDateTime,
 405                     Info.ftLastWriteTime.dwLowDateTime,
 406                     Info.dwVolumeSerialNumber, Info.nFileSizeHigh,
 407                     Info.nFileSizeLow, Info.nFileIndexHigh, Info.nFileIndexLow);
 408     return std::error_code();
 409   }
 410
 411 handle_status_error:
 412   DWORD LastError = ::GetLastError();
 413   if (LastError == ERROR_FILE_NOT_FOUND ||
 414       LastError == ERROR_PATH_NOT_FOUND)
 415     Result = file_status(file_type::file_not_found);
 416   else if (LastError == ERROR_SHARING_VIOLATION)
 417     Result = file_status(file_type::type_unknown);
 418   else
 419     Result = file_status(file_type::status_error);
 420   return mapWindowsError(LastError);
 421 }
 422
 423 std::error_code status(const Twine &path, file_status &result) {
 424   SmallString<128> path_storage;
 425   SmallVector<wchar_t, 128> path_utf16;
 426
 427   StringRef path8 = path.toStringRef(path_storage);
 428   if (isReservedName(path8)) {
 429     result = file_status(file_type::character_file);
 430     return std::error_code();
 431   }
 432
 433   if (std::error_code ec = widenPath(path8, path_utf16))
 434     return ec;
 435
 436   DWORD attr = ::GetFileAttributesW(path_utf16.begin());
 437   if (attr == INVALID_FILE_ATTRIBUTES)
 438     return getStatus(INVALID_HANDLE_VALUE, result);
 439
 440   // Handle reparse points.
 441   if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
 442     ScopedFileHandle h(
 443       ::CreateFileW(path_utf16.begin(),
 444                     0, // Attributes only.
 445                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 446                     NULL,
 447                     OPEN_EXISTING,
 448                     FILE_FLAG_BACKUP_SEMANTICS,
 449                     0));
 450     if (!h)
 451       return getStatus(INVALID_HANDLE_VALUE, result);
 452   }
 453
 454   ScopedFileHandle h(
 455       ::CreateFileW(path_utf16.begin(), 0, // Attributes only.
 456                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 457                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0));
 458     if (!h)
 459       return getStatus(INVALID_HANDLE_VALUE, result);
 460
 461     return getStatus(h, result);
 462 }
 463
 464 std::error_code status(int FD, file_status &Result) {
 465   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 466   return getStatus(FileHandle, Result);
 467 }
 468
 469 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
 470   ULARGE_INTEGER UI;
 471   UI.QuadPart = Time.toWin32Time();
 472   FILETIME FT;
 473   FT.dwLowDateTime = UI.LowPart;
 474   FT.dwHighDateTime = UI.HighPart;
 475   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 476   if (!SetFileTime(FileHandle, NULL, &FT, &FT))
 477     return mapWindowsError(::GetLastError());
 478   return std::error_code();
 479 }
 480
 481 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
 482                                          mapmode Mode) {
 483   // Make sure that the requested size fits within SIZE_T.
 484   if (Size > std::numeric_limits<SIZE_T>::max())
 485     return make_error_code(errc::invalid_argument);
 486
 487   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 488   if (FileHandle == INVALID_HANDLE_VALUE)
 489     return make_error_code(errc::bad_file_descriptor);
 490
 491   DWORD flprotect;
 492   switch (Mode) {
 493   case readonly:  flprotect = PAGE_READONLY; break;
 494   case readwrite: flprotect = PAGE_READWRITE; break;
 495   case priv:      flprotect = PAGE_WRITECOPY; break;
 496   }
 497
 498   HANDLE FileMappingHandle =
 499       ::CreateFileMappingW(FileHandle, 0, flprotect,
 500                            (Offset + Size) >> 32,
 501                            (Offset + Size) & 0xffffffff,
 502                            0);
 503   if (FileMappingHandle == NULL) {
 504     std::error_code ec = mapWindowsError(GetLastError());
 505     return ec;
 506   }
 507
 508   DWORD dwDesiredAccess;
 509   switch (Mode) {
 510   case readonly:  dwDesiredAccess = FILE_MAP_READ; break;
 511   case readwrite: dwDesiredAccess = FILE_MAP_WRITE; break;
 512   case priv:      dwDesiredAccess = FILE_MAP_COPY; break;
 513   }
 514   Mapping = ::MapViewOfFile(FileMappingHandle,
 515                             dwDesiredAccess,
 516                             Offset >> 32,
 517                             Offset & 0xffffffff,
 518                             Size);
 519   if (Mapping == NULL) {
 520     std::error_code ec = mapWindowsError(GetLastError());
 521     ::CloseHandle(FileMappingHandle);
 522     return ec;
 523   }
 524
 525   if (Size == 0) {
 526     MEMORY_BASIC_INFORMATION mbi;
 527     SIZE_T Result = VirtualQuery(Mapping, &mbi, sizeof(mbi));
 528     if (Result == 0) {
 529       std::error_code ec = mapWindowsError(GetLastError());
 530       ::UnmapViewOfFile(Mapping);
 531       ::CloseHandle(FileMappingHandle);
 532       return ec;
 533     }
 534     Size = mbi.RegionSize;
 535   }
 536
 537   // Close all the handles except for the view. It will keep the other handles
 538   // alive.
 539   ::CloseHandle(FileMappingHandle);
 540   return std::error_code();
 541 }
 542
 543 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
 544                                        uint64_t offset, std::error_code &ec)
 545     : Size(length), Mapping() {
 546   ec = init(fd, offset, mode);
 547   if (ec)
 548     Mapping = 0;
 549 }
 550
 551 mapped_file_region::~mapped_file_region() {
 552   if (Mapping)
 553     ::UnmapViewOfFile(Mapping);
 554 }
 555
 556 uint64_t mapped_file_region::size() const {
 557   assert(Mapping && "Mapping failed but used anyway!");
 558   return Size;
 559 }
 560
 561 char *mapped_file_region::data() const {
 562   assert(Mapping && "Mapping failed but used anyway!");
 563   return reinterpret_cast<char*>(Mapping);
 564 }
 565
 566 const char *mapped_file_region::const_data() const {
 567   assert(Mapping && "Mapping failed but used anyway!");
 568   return reinterpret_cast<const char*>(Mapping);
 569 }
 570
 571 int mapped_file_region::alignment() {
 572   SYSTEM_INFO SysInfo;
 573   ::GetSystemInfo(&SysInfo);
 574   return SysInfo.dwAllocationGranularity;
 575 }
 576
 577 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
 578                                                 StringRef path){
 579   SmallVector<wchar_t, 128> path_utf16;
 580
 581   if (std::error_code ec = widenPath(path, path_utf16))
 582     return ec;
 583
 584   // Convert path to the format that Windows is happy with.
 585   if (path_utf16.size() > 0 &&
 586       !is_separator(path_utf16[path.size() - 1]) &&
 587       path_utf16[path.size() - 1] != L':') {
 588     path_utf16.push_back(L'\\');
 589     path_utf16.push_back(L'*');
 590   } else {
 591     path_utf16.push_back(L'*');
 592   }
 593
 594   //  Get the first directory entry.
 595   WIN32_FIND_DATAW FirstFind;
 596   ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
 597   if (!FindHandle)
 598     return mapWindowsError(::GetLastError());
 599
 600   size_t FilenameLen = ::wcslen(FirstFind.cFileName);
 601   while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
 602          (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
 603                               FirstFind.cFileName[1] == L'.'))
 604     if (!::FindNextFileW(FindHandle, &FirstFind)) {
 605       DWORD LastError = ::GetLastError();
 606       // Check for end.
 607       if (LastError == ERROR_NO_MORE_FILES)
 608         return detail::directory_iterator_destruct(it);
 609       return mapWindowsError(LastError);
 610     } else
 611       FilenameLen = ::wcslen(FirstFind.cFileName);
 612
 613   // Construct the current directory entry.
 614   SmallString<128> directory_entry_name_utf8;
 615   if (std::error_code ec =
 616           UTF16ToUTF8(FirstFind.cFileName, ::wcslen(FirstFind.cFileName),
 617                       directory_entry_name_utf8))
 618     return ec;
 619
 620   it.IterationHandle = intptr_t(FindHandle.take());
 621   SmallString<128> directory_entry_path(path);
 622   path::append(directory_entry_path, directory_entry_name_utf8);
 623   it.CurrentEntry = directory_entry(directory_entry_path);
 624
 625   return std::error_code();
 626 }
 627
 628 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 629   if (it.IterationHandle != 0)
 630     // Closes the handle if it's valid.
 631     ScopedFindHandle close(HANDLE(it.IterationHandle));
 632   it.IterationHandle = 0;
 633   it.CurrentEntry = directory_entry();
 634   return std::error_code();
 635 }
 636
 637 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 638   WIN32_FIND_DATAW FindData;
 639   if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
 640     DWORD LastError = ::GetLastError();
 641     // Check for end.
 642     if (LastError == ERROR_NO_MORE_FILES)
 643       return detail::directory_iterator_destruct(it);
 644     return mapWindowsError(LastError);
 645   }
 646
 647   size_t FilenameLen = ::wcslen(FindData.cFileName);
 648   if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
 649       (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
 650                            FindData.cFileName[1] == L'.'))
 651     return directory_iterator_increment(it);
 652
 653   SmallString<128> directory_entry_path_utf8;
 654   if (std::error_code ec =
 655           UTF16ToUTF8(FindData.cFileName, ::wcslen(FindData.cFileName),
 656                       directory_entry_path_utf8))
 657     return ec;
 658
 659   it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
 660   return std::error_code();
 661 }
 662
 663 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
 664   SmallVector<wchar_t, 128> PathUTF16;
 665
 666   if (std::error_code EC = widenPath(Name, PathUTF16))
 667     return EC;
 668
 669   HANDLE H =
 670       ::CreateFileW(PathUTF16.begin(), GENERIC_READ,
 671                     FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 672                     NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 673   if (H == INVALID_HANDLE_VALUE) {
 674     DWORD LastError = ::GetLastError();
 675     std::error_code EC = mapWindowsError(LastError);
 676     // Provide a better error message when trying to open directories.
 677     // This only runs if we failed to open the file, so there is probably
 678     // no performances issues.
 679     if (LastError != ERROR_ACCESS_DENIED)
 680       return EC;
 681     if (is_directory(Name))
 682       return make_error_code(errc::is_a_directory);
 683     return EC;
 684   }
 685
 686   int FD = ::_open_osfhandle(intptr_t(H), 0);
 687   if (FD == -1) {
 688     ::CloseHandle(H);
 689     return mapWindowsError(ERROR_INVALID_HANDLE);
 690   }
 691
 692   ResultFD = FD;
 693   return std::error_code();
 694 }
 695
 696 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 697                             sys::fs::OpenFlags Flags, unsigned Mode) {
 698   // Verify that we don't have both "append" and "excl".
 699   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
 700          "Cannot specify both 'excl' and 'append' file creation flags!");
 701
 702   SmallVector<wchar_t, 128> PathUTF16;
 703
 704   if (std::error_code EC = widenPath(Name, PathUTF16))
 705     return EC;
 706
 707   DWORD CreationDisposition;
 708   if (Flags & F_Excl)
 709     CreationDisposition = CREATE_NEW;
 710   else if (Flags & F_Append)
 711     CreationDisposition = OPEN_ALWAYS;
 712   else
 713     CreationDisposition = CREATE_ALWAYS;
 714
 715   DWORD Access = GENERIC_WRITE;
 716   if (Flags & F_RW)
 717     Access |= GENERIC_READ;
 718
 719   HANDLE H = ::CreateFileW(PathUTF16.begin(), Access,
 720                            FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
 721                            CreationDisposition, FILE_ATTRIBUTE_NORMAL, NULL);
 722
 723   if (H == INVALID_HANDLE_VALUE) {
 724     DWORD LastError = ::GetLastError();
 725     std::error_code EC = mapWindowsError(LastError);
 726     // Provide a better error message when trying to open directories.
 727     // This only runs if we failed to open the file, so there is probably
 728     // no performances issues.
 729     if (LastError != ERROR_ACCESS_DENIED)
 730       return EC;
 731     if (is_directory(Name))
 732       return make_error_code(errc::is_a_directory);
 733     return EC;
 734   }
 735
 736   int OpenFlags = 0;
 737   if (Flags & F_Append)
 738     OpenFlags |= _O_APPEND;
 739
 740   if (Flags & F_Text)
 741     OpenFlags |= _O_TEXT;
 742
 743   int FD = ::_open_osfhandle(intptr_t(H), OpenFlags);
 744   if (FD == -1) {
 745     ::CloseHandle(H);
 746     return mapWindowsError(ERROR_INVALID_HANDLE);
 747   }
 748
 749   ResultFD = FD;
 750   return std::error_code();
 751 }
 752 } // end namespace fs
 753
 754 namespace path {
 755
 756 namespace {
 757 bool getKnownFolderPath(KNOWNFOLDERID folderId, SmallVectorImpl<char> &result) {
 758   wchar_t *path = nullptr;
 759   if (::SHGetKnownFolderPath(folderId, KF_FLAG_CREATE, nullptr, &path) != S_OK)
 760     return false;
 761
 762   bool ok = !UTF16ToUTF8(path, ::wcslen(path), result);
 763   ::CoTaskMemFree(path);
 764   return ok;
 765 }
 766 }
 767
 768 bool home_directory(SmallVectorImpl<char> &result) {
 769   return getKnownFolderPath(FOLDERID_Profile, result);
 770 }
 771
 772 static bool getTempDirEnvVar(const char *Var, SmallVectorImpl<char> &Res) {
 773   SmallVector<wchar_t, 128> NameUTF16;
 774   if (windows::UTF8ToUTF16(Var, NameUTF16))
 775     return false;
 776
 777   SmallVector<wchar_t, 1024> Buf;
 778   size_t Size = 1024;
 779   do {
 780     Buf.reserve(Size);
 781     Size =
 782         GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.capacity());
 783     if (Size == 0)
 784       return false;
 785
 786     // Try again with larger buffer.
 787   } while (Size > Buf.capacity());
 788   Buf.set_size(Size);
 789
 790   if (windows::UTF16ToUTF8(Buf.data(), Size, Res))
 791     return false;
 792   return true;
 793 }
 794
 795 static bool getTempDirEnvVar(SmallVectorImpl<char> &Res) {
 796   const char *EnvironmentVariables[] = {"TMP", "TEMP", "USERPROFILE"};
 797   for (const char *Env : EnvironmentVariables) {
 798     if (getTempDirEnvVar(Env, Res))
 799       return true;
 800   }
 801   return false;
 802 }
 803
 804 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
 805   (void)ErasedOnReboot;
 806   Result.clear();
 807
 808   // Check whether the temporary directory is specified by an environment
 809   // variable.
 810   if (getTempDirEnvVar(Result))
 811     return;
 812
 813   // Fall back to a system default.
 814   const char *DefaultResult = "C:\\TEMP";
 815   Result.append(DefaultResult, DefaultResult + strlen(DefaultResult));
 816 }
 817 } // end namespace path
 818
 819 namespace windows {
 820 std::error_code UTF8ToUTF16(llvm::StringRef utf8,
 821                             llvm::SmallVectorImpl<wchar_t> &utf16) {
 822   if (!utf8.empty()) {
 823     int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 824                                     utf8.size(), utf16.begin(), 0);
 825
 826     if (len == 0)
 827       return mapWindowsError(::GetLastError());
 828
 829     utf16.reserve(len + 1);
 830     utf16.set_size(len);
 831
 832     len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 833                                 utf8.size(), utf16.begin(), utf16.size());
 834
 835     if (len == 0)
 836       return mapWindowsError(::GetLastError());
 837   }
 838
 839   // Make utf16 null terminated.
 840   utf16.push_back(0);
 841   utf16.pop_back();
 842
 843   return std::error_code();
 844 }
 845
 846 static
 847 std::error_code UTF16ToCodePage(unsigned codepage, const wchar_t *utf16,
 848                                 size_t utf16_len,
 849                                 llvm::SmallVectorImpl<char> &utf8) {
 850   if (utf16_len) {
 851     // Get length.
 852     int len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.begin(),
 853                                     0, NULL, NULL);
 854
 855     if (len == 0)
 856       return mapWindowsError(::GetLastError());
 857
 858     utf8.reserve(len);
 859     utf8.set_size(len);
 860
 861     // Now do the actual conversion.
 862     len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.data(),
 863                                 utf8.size(), NULL, NULL);
 864
 865     if (len == 0)
 866       return mapWindowsError(::GetLastError());
 867   }
 868
 869   // Make utf8 null terminated.
 870   utf8.push_back(0);
 871   utf8.pop_back();
 872
 873   return std::error_code();
 874 }
 875
 876 std::error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
 877                             llvm::SmallVectorImpl<char> &utf8) {
 878   return UTF16ToCodePage(CP_UTF8, utf16, utf16_len, utf8);
 879 }
 880
 881 std::error_code UTF16ToCurCP(const wchar_t *utf16, size_t utf16_len,
 882                              llvm::SmallVectorImpl<char> &utf8) {
 883   return UTF16ToCodePage(CP_ACP, utf16, utf16_len, utf8);
 884 }
 885 } // end namespace windows
 886 } // end namespace sys
 887 } // end namespace llvm