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 *const sReservedNames[] = { "nul", "con", "prn", "aux",
 352                                                 "com1", "com2", "com3", "com4",
 353                                                 "com5", "com6", "com7", "com8",
 354                                                 "com9", "lpt1", "lpt2", "lpt3",
 355                                                 "lpt4", "lpt5", "lpt6", "lpt7",
 356                                                 "lpt8", "lpt9" };
 357
 358   // First, check to see if this is a device namespace, which always
 359   // starts with \\.\, since device namespaces are not legal file paths.
 360   if (path.startswith("\\\\.\\"))
 361     return true;
 362
 363   // Then compare against the list of ancient reserved names
 364   for (size_t i = 0; i < array_lengthof(sReservedNames); ++i) {
 365     if (path.equals_lower(sReservedNames[i]))
 366       return true;
 367   }
 368
 369   // The path isn't what we consider reserved.
 370   return false;
 371 }
 372
 373 static std::error_code getStatus(HANDLE FileHandle, file_status &Result) {
 374   if (FileHandle == INVALID_HANDLE_VALUE)
 375     goto handle_status_error;
 376
 377   switch (::GetFileType(FileHandle)) {
 378   default:
 379     llvm_unreachable("Don't know anything about this file type");
 380   case FILE_TYPE_UNKNOWN: {
 381     DWORD Err = ::GetLastError();
 382     if (Err != NO_ERROR)
 383       return mapWindowsError(Err);
 384     Result = file_status(file_type::type_unknown);
 385     return std::error_code();
 386   }
 387   case FILE_TYPE_DISK:
 388     break;
 389   case FILE_TYPE_CHAR:
 390     Result = file_status(file_type::character_file);
 391     return std::error_code();
 392   case FILE_TYPE_PIPE:
 393     Result = file_status(file_type::fifo_file);
 394     return std::error_code();
 395   }
 396
 397   BY_HANDLE_FILE_INFORMATION Info;
 398   if (!::GetFileInformationByHandle(FileHandle, &Info))
 399     goto handle_status_error;
 400
 401   {
 402     file_type Type = (Info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 403                          ? file_type::directory_file
 404                          : file_type::regular_file;
 405     Result =
 406         file_status(Type, Info.ftLastWriteTime.dwHighDateTime,
 407                     Info.ftLastWriteTime.dwLowDateTime,
 408                     Info.dwVolumeSerialNumber, Info.nFileSizeHigh,
 409                     Info.nFileSizeLow, Info.nFileIndexHigh, Info.nFileIndexLow);
 410     return std::error_code();
 411   }
 412
 413 handle_status_error:
 414   DWORD LastError = ::GetLastError();
 415   if (LastError == ERROR_FILE_NOT_FOUND ||
 416       LastError == ERROR_PATH_NOT_FOUND)
 417     Result = file_status(file_type::file_not_found);
 418   else if (LastError == ERROR_SHARING_VIOLATION)
 419     Result = file_status(file_type::type_unknown);
 420   else
 421     Result = file_status(file_type::status_error);
 422   return mapWindowsError(LastError);
 423 }
 424
 425 std::error_code status(const Twine &path, file_status &result) {
 426   SmallString<128> path_storage;
 427   SmallVector<wchar_t, 128> path_utf16;
 428
 429   StringRef path8 = path.toStringRef(path_storage);
 430   if (isReservedName(path8)) {
 431     result = file_status(file_type::character_file);
 432     return std::error_code();
 433   }
 434
 435   if (std::error_code ec = widenPath(path8, path_utf16))
 436     return ec;
 437
 438   DWORD attr = ::GetFileAttributesW(path_utf16.begin());
 439   if (attr == INVALID_FILE_ATTRIBUTES)
 440     return getStatus(INVALID_HANDLE_VALUE, result);
 441
 442   // Handle reparse points.
 443   if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
 444     ScopedFileHandle h(
 445       ::CreateFileW(path_utf16.begin(),
 446                     0, // Attributes only.
 447                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 448                     NULL,
 449                     OPEN_EXISTING,
 450                     FILE_FLAG_BACKUP_SEMANTICS,
 451                     0));
 452     if (!h)
 453       return getStatus(INVALID_HANDLE_VALUE, result);
 454   }
 455
 456   ScopedFileHandle h(
 457       ::CreateFileW(path_utf16.begin(), 0, // Attributes only.
 458                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 459                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0));
 460     if (!h)
 461       return getStatus(INVALID_HANDLE_VALUE, result);
 462
 463     return getStatus(h, result);
 464 }
 465
 466 std::error_code status(int FD, file_status &Result) {
 467   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 468   return getStatus(FileHandle, Result);
 469 }
 470
 471 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
 472   ULARGE_INTEGER UI;
 473   UI.QuadPart = Time.toWin32Time();
 474   FILETIME FT;
 475   FT.dwLowDateTime = UI.LowPart;
 476   FT.dwHighDateTime = UI.HighPart;
 477   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 478   if (!SetFileTime(FileHandle, NULL, &FT, &FT))
 479     return mapWindowsError(::GetLastError());
 480   return std::error_code();
 481 }
 482
 483 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
 484                                          mapmode Mode) {
 485   // Make sure that the requested size fits within SIZE_T.
 486   if (Size > std::numeric_limits<SIZE_T>::max())
 487     return make_error_code(errc::invalid_argument);
 488
 489   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 490   if (FileHandle == INVALID_HANDLE_VALUE)
 491     return make_error_code(errc::bad_file_descriptor);
 492
 493   DWORD flprotect;
 494   switch (Mode) {
 495   case readonly:  flprotect = PAGE_READONLY; break;
 496   case readwrite: flprotect = PAGE_READWRITE; break;
 497   case priv:      flprotect = PAGE_WRITECOPY; break;
 498   }
 499
 500   HANDLE FileMappingHandle =
 501       ::CreateFileMappingW(FileHandle, 0, flprotect,
 502                            (Offset + Size) >> 32,
 503                            (Offset + Size) & 0xffffffff,
 504                            0);
 505   if (FileMappingHandle == NULL) {
 506     std::error_code ec = mapWindowsError(GetLastError());
 507     return ec;
 508   }
 509
 510   DWORD dwDesiredAccess;
 511   switch (Mode) {
 512   case readonly:  dwDesiredAccess = FILE_MAP_READ; break;
 513   case readwrite: dwDesiredAccess = FILE_MAP_WRITE; break;
 514   case priv:      dwDesiredAccess = FILE_MAP_COPY; break;
 515   }
 516   Mapping = ::MapViewOfFile(FileMappingHandle,
 517                             dwDesiredAccess,
 518                             Offset >> 32,
 519                             Offset & 0xffffffff,
 520                             Size);
 521   if (Mapping == NULL) {
 522     std::error_code ec = mapWindowsError(GetLastError());
 523     ::CloseHandle(FileMappingHandle);
 524     return ec;
 525   }
 526
 527   if (Size == 0) {
 528     MEMORY_BASIC_INFORMATION mbi;
 529     SIZE_T Result = VirtualQuery(Mapping, &mbi, sizeof(mbi));
 530     if (Result == 0) {
 531       std::error_code ec = mapWindowsError(GetLastError());
 532       ::UnmapViewOfFile(Mapping);
 533       ::CloseHandle(FileMappingHandle);
 534       return ec;
 535     }
 536     Size = mbi.RegionSize;
 537   }
 538
 539   // Close all the handles except for the view. It will keep the other handles
 540   // alive.
 541   ::CloseHandle(FileMappingHandle);
 542   return std::error_code();
 543 }
 544
 545 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
 546                                        uint64_t offset, std::error_code &ec)
 547     : Size(length), Mapping() {
 548   ec = init(fd, offset, mode);
 549   if (ec)
 550     Mapping = 0;
 551 }
 552
 553 mapped_file_region::~mapped_file_region() {
 554   if (Mapping)
 555     ::UnmapViewOfFile(Mapping);
 556 }
 557
 558 uint64_t mapped_file_region::size() const {
 559   assert(Mapping && "Mapping failed but used anyway!");
 560   return Size;
 561 }
 562
 563 char *mapped_file_region::data() const {
 564   assert(Mapping && "Mapping failed but used anyway!");
 565   return reinterpret_cast<char*>(Mapping);
 566 }
 567
 568 const char *mapped_file_region::const_data() const {
 569   assert(Mapping && "Mapping failed but used anyway!");
 570   return reinterpret_cast<const char*>(Mapping);
 571 }
 572
 573 int mapped_file_region::alignment() {
 574   SYSTEM_INFO SysInfo;
 575   ::GetSystemInfo(&SysInfo);
 576   return SysInfo.dwAllocationGranularity;
 577 }
 578
 579 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
 580                                                 StringRef path){
 581   SmallVector<wchar_t, 128> path_utf16;
 582
 583   if (std::error_code ec = widenPath(path, path_utf16))
 584     return ec;
 585
 586   // Convert path to the format that Windows is happy with.
 587   if (path_utf16.size() > 0 &&
 588       !is_separator(path_utf16[path.size() - 1]) &&
 589       path_utf16[path.size() - 1] != L':') {
 590     path_utf16.push_back(L'\\');
 591     path_utf16.push_back(L'*');
 592   } else {
 593     path_utf16.push_back(L'*');
 594   }
 595
 596   //  Get the first directory entry.
 597   WIN32_FIND_DATAW FirstFind;
 598   ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
 599   if (!FindHandle)
 600     return mapWindowsError(::GetLastError());
 601
 602   size_t FilenameLen = ::wcslen(FirstFind.cFileName);
 603   while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
 604          (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
 605                               FirstFind.cFileName[1] == L'.'))
 606     if (!::FindNextFileW(FindHandle, &FirstFind)) {
 607       DWORD LastError = ::GetLastError();
 608       // Check for end.
 609       if (LastError == ERROR_NO_MORE_FILES)
 610         return detail::directory_iterator_destruct(it);
 611       return mapWindowsError(LastError);
 612     } else
 613       FilenameLen = ::wcslen(FirstFind.cFileName);
 614
 615   // Construct the current directory entry.
 616   SmallString<128> directory_entry_name_utf8;
 617   if (std::error_code ec =
 618           UTF16ToUTF8(FirstFind.cFileName, ::wcslen(FirstFind.cFileName),
 619                       directory_entry_name_utf8))
 620     return ec;
 621
 622   it.IterationHandle = intptr_t(FindHandle.take());
 623   SmallString<128> directory_entry_path(path);
 624   path::append(directory_entry_path, directory_entry_name_utf8);
 625   it.CurrentEntry = directory_entry(directory_entry_path);
 626
 627   return std::error_code();
 628 }
 629
 630 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 631   if (it.IterationHandle != 0)
 632     // Closes the handle if it's valid.
 633     ScopedFindHandle close(HANDLE(it.IterationHandle));
 634   it.IterationHandle = 0;
 635   it.CurrentEntry = directory_entry();
 636   return std::error_code();
 637 }
 638
 639 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 640   WIN32_FIND_DATAW FindData;
 641   if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
 642     DWORD LastError = ::GetLastError();
 643     // Check for end.
 644     if (LastError == ERROR_NO_MORE_FILES)
 645       return detail::directory_iterator_destruct(it);
 646     return mapWindowsError(LastError);
 647   }
 648
 649   size_t FilenameLen = ::wcslen(FindData.cFileName);
 650   if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
 651       (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
 652                            FindData.cFileName[1] == L'.'))
 653     return directory_iterator_increment(it);
 654
 655   SmallString<128> directory_entry_path_utf8;
 656   if (std::error_code ec =
 657           UTF16ToUTF8(FindData.cFileName, ::wcslen(FindData.cFileName),
 658                       directory_entry_path_utf8))
 659     return ec;
 660
 661   it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
 662   return std::error_code();
 663 }
 664
 665 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
 666   SmallVector<wchar_t, 128> PathUTF16;
 667
 668   if (std::error_code EC = widenPath(Name, PathUTF16))
 669     return EC;
 670
 671   HANDLE H =
 672       ::CreateFileW(PathUTF16.begin(), GENERIC_READ,
 673                     FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 674                     NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 675   if (H == INVALID_HANDLE_VALUE) {
 676     DWORD LastError = ::GetLastError();
 677     std::error_code EC = mapWindowsError(LastError);
 678     // Provide a better error message when trying to open directories.
 679     // This only runs if we failed to open the file, so there is probably
 680     // no performances issues.
 681     if (LastError != ERROR_ACCESS_DENIED)
 682       return EC;
 683     if (is_directory(Name))
 684       return make_error_code(errc::is_a_directory);
 685     return EC;
 686   }
 687
 688   int FD = ::_open_osfhandle(intptr_t(H), 0);
 689   if (FD == -1) {
 690     ::CloseHandle(H);
 691     return mapWindowsError(ERROR_INVALID_HANDLE);
 692   }
 693
 694   ResultFD = FD;
 695   return std::error_code();
 696 }
 697
 698 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 699                             sys::fs::OpenFlags Flags, unsigned Mode) {
 700   // Verify that we don't have both "append" and "excl".
 701   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
 702          "Cannot specify both 'excl' and 'append' file creation flags!");
 703
 704   SmallVector<wchar_t, 128> PathUTF16;
 705
 706   if (std::error_code EC = widenPath(Name, PathUTF16))
 707     return EC;
 708
 709   DWORD CreationDisposition;
 710   if (Flags & F_Excl)
 711     CreationDisposition = CREATE_NEW;
 712   else if (Flags & F_Append)
 713     CreationDisposition = OPEN_ALWAYS;
 714   else
 715     CreationDisposition = CREATE_ALWAYS;
 716
 717   DWORD Access = GENERIC_WRITE;
 718   if (Flags & F_RW)
 719     Access |= GENERIC_READ;
 720
 721   HANDLE H = ::CreateFileW(PathUTF16.begin(), Access,
 722                            FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
 723                            CreationDisposition, FILE_ATTRIBUTE_NORMAL, NULL);
 724
 725   if (H == INVALID_HANDLE_VALUE) {
 726     DWORD LastError = ::GetLastError();
 727     std::error_code EC = mapWindowsError(LastError);
 728     // Provide a better error message when trying to open directories.
 729     // This only runs if we failed to open the file, so there is probably
 730     // no performances issues.
 731     if (LastError != ERROR_ACCESS_DENIED)
 732       return EC;
 733     if (is_directory(Name))
 734       return make_error_code(errc::is_a_directory);
 735     return EC;
 736   }
 737
 738   int OpenFlags = 0;
 739   if (Flags & F_Append)
 740     OpenFlags |= _O_APPEND;
 741
 742   if (Flags & F_Text)
 743     OpenFlags |= _O_TEXT;
 744
 745   int FD = ::_open_osfhandle(intptr_t(H), OpenFlags);
 746   if (FD == -1) {
 747     ::CloseHandle(H);
 748     return mapWindowsError(ERROR_INVALID_HANDLE);
 749   }
 750
 751   ResultFD = FD;
 752   return std::error_code();
 753 }
 754 } // end namespace fs
 755
 756 namespace path {
 757 static bool getKnownFolderPath(KNOWNFOLDERID folderId,
 758                                SmallVectorImpl<char> &result) {
 759   wchar_t *path = nullptr;
 760   if (::SHGetKnownFolderPath(folderId, KF_FLAG_CREATE, nullptr, &path) != S_OK)
 761     return false;
 762
 763   bool ok = !UTF16ToUTF8(path, ::wcslen(path), result);
 764   ::CoTaskMemFree(path);
 765   return ok;
 766 }
 767
 768 bool getUserCacheDir(SmallVectorImpl<char> &Result) {
 769   return getKnownFolderPath(FOLDERID_LocalAppData, Result);
 770 }
 771
 772 bool home_directory(SmallVectorImpl<char> &result) {
 773   return getKnownFolderPath(FOLDERID_Profile, result);
 774 }
 775
 776 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
 777   (void)ErasedOnReboot;
 778
 779   wchar_t Path[MAX_PATH + 2]; // GetTempPath can return MAX_PATH + 1 + null
 780   if (auto PathLength = ::GetTempPathW(sizeof(Path) / sizeof(wchar_t), Path)) {
 781     assert(PathLength > 0 && PathLength <= (MAX_PATH + 1) &&
 782            "GetTempPath returned undocumented result");
 783     if (Path[PathLength - 1] == L'\\')
 784       --PathLength; // skip trailing "\" added by GetTempPath
 785     if (!UTF16ToUTF8(Path, PathLength, Result))
 786       return;
 787   }
 788
 789   // Fall back to a system default.
 790   const char *DefaultResult = "C:\\TEMP";
 791   Result.clear();
 792   Result.append(DefaultResult, DefaultResult + strlen(DefaultResult));
 793 }
 794 } // end namespace path
 795
 796 namespace windows {
 797 std::error_code UTF8ToUTF16(llvm::StringRef utf8,
 798                             llvm::SmallVectorImpl<wchar_t> &utf16) {
 799   if (!utf8.empty()) {
 800     int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 801                                     utf8.size(), utf16.begin(), 0);
 802
 803     if (len == 0)
 804       return mapWindowsError(::GetLastError());
 805
 806     utf16.reserve(len + 1);
 807     utf16.set_size(len);
 808
 809     len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 810                                 utf8.size(), utf16.begin(), utf16.size());
 811
 812     if (len == 0)
 813       return mapWindowsError(::GetLastError());
 814   }
 815
 816   // Make utf16 null terminated.
 817   utf16.push_back(0);
 818   utf16.pop_back();
 819
 820   return std::error_code();
 821 }
 822
 823 static
 824 std::error_code UTF16ToCodePage(unsigned codepage, const wchar_t *utf16,
 825                                 size_t utf16_len,
 826                                 llvm::SmallVectorImpl<char> &utf8) {
 827   if (utf16_len) {
 828     // Get length.
 829     int len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.begin(),
 830                                     0, NULL, NULL);
 831
 832     if (len == 0)
 833       return mapWindowsError(::GetLastError());
 834
 835     utf8.reserve(len);
 836     utf8.set_size(len);
 837
 838     // Now do the actual conversion.
 839     len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.data(),
 840                                 utf8.size(), NULL, NULL);
 841
 842     if (len == 0)
 843       return mapWindowsError(::GetLastError());
 844   }
 845
 846   // Make utf8 null terminated.
 847   utf8.push_back(0);
 848   utf8.pop_back();
 849
 850   return std::error_code();
 851 }
 852
 853 std::error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
 854                             llvm::SmallVectorImpl<char> &utf8) {
 855   return UTF16ToCodePage(CP_UTF8, utf16, utf16_len, utf8);
 856 }
 857
 858 std::error_code UTF16ToCurCP(const wchar_t *utf16, size_t utf16_len,
 859                              llvm::SmallVectorImpl<char> &utf8) {
 860   return UTF16ToCodePage(CP_ACP, utf16, utf16_len, utf8);
 861 }
 862 } // end namespace windows
 863 } // end namespace sys
 864 } // end namespace llvm