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