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