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