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 ErrorOr<space_info> disk_space(const Twine &Path) {
 155   ULARGE_INTEGER Avail, Total, Free;
 156   if (!::GetDiskFreeSpaceExA(Path.str().c_str(), &Avail, &Total, &Free))
 157     return mapWindowsError(::GetLastError());
 158   space_info SpaceInfo;
 159   SpaceInfo.capacity =
 160       (static_cast<uint64_t>(Total.HighPart) << 32) + Total.LowPart;
 161   SpaceInfo.free = (static_cast<uint64_t>(Free.HighPart) << 32) + Free.LowPart;
 162   SpaceInfo.available =
 163       (static_cast<uint64_t>(Avail.HighPart) << 32) + Avail.LowPart;
 164   return SpaceInfo;
 165 }
 166
 167 TimePoint<> file_status::getLastAccessedTime() const {
 168   FILETIME Time;
 169   Time.dwLowDateTime = LastAccessedTimeLow;
 170   Time.dwHighDateTime = LastAccessedTimeHigh;
 171   return toTimePoint(Time);
 172 }
 173
 174 TimePoint<> file_status::getLastModificationTime() const {
 175   FILETIME Time;
 176   Time.dwLowDateTime = LastWriteTimeLow;
 177   Time.dwHighDateTime = LastWriteTimeHigh;
 178   return toTimePoint(Time);
 179 }
 180
 181 std::error_code current_path(SmallVectorImpl<char> &result) {
 182   SmallVector<wchar_t, MAX_PATH> cur_path;
 183   DWORD len = MAX_PATH;
 184
 185   do {
 186     cur_path.reserve(len);
 187     len = ::GetCurrentDirectoryW(cur_path.capacity(), cur_path.data());
 188
 189     // A zero return value indicates a failure other than insufficient space.
 190     if (len == 0)
 191       return mapWindowsError(::GetLastError());
 192
 193     // If there's insufficient space, the len returned is larger than the len
 194     // given.
 195   } while (len > cur_path.capacity());
 196
 197   // On success, GetCurrentDirectoryW returns the number of characters not
 198   // including the null-terminator.
 199   cur_path.set_size(len);
 200   return UTF16ToUTF8(cur_path.begin(), cur_path.size(), result);
 201 }
 202
 203 std::error_code create_directory(const Twine &path, bool IgnoreExisting,
 204                                  perms Perms) {
 205   SmallVector<wchar_t, 128> path_utf16;
 206
 207   if (std::error_code ec = widenPath(path, path_utf16))
 208     return ec;
 209
 210   if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
 211     DWORD LastError = ::GetLastError();
 212     if (LastError != ERROR_ALREADY_EXISTS || !IgnoreExisting)
 213       return mapWindowsError(LastError);
 214   }
 215
 216   return std::error_code();
 217 }
 218
 219 // We can't use symbolic links for windows.
 220 std::error_code create_link(const Twine &to, const Twine &from) {
 221   // Convert to utf-16.
 222   SmallVector<wchar_t, 128> wide_from;
 223   SmallVector<wchar_t, 128> wide_to;
 224   if (std::error_code ec = widenPath(from, wide_from))
 225     return ec;
 226   if (std::error_code ec = widenPath(to, wide_to))
 227     return ec;
 228
 229   if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
 230     return mapWindowsError(::GetLastError());
 231
 232   return std::error_code();
 233 }
 234
 235 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
 236   SmallVector<wchar_t, 128> path_utf16;
 237
 238   file_status ST;
 239   if (std::error_code EC = status(path, ST)) {
 240     if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 241       return EC;
 242     return std::error_code();
 243   }
 244
 245   if (std::error_code ec = widenPath(path, path_utf16))
 246     return ec;
 247
 248   if (ST.type() == file_type::directory_file) {
 249     if (!::RemoveDirectoryW(c_str(path_utf16))) {
 250       std::error_code EC = mapWindowsError(::GetLastError());
 251       if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 252         return EC;
 253     }
 254     return std::error_code();
 255   }
 256   if (!::DeleteFileW(c_str(path_utf16))) {
 257     std::error_code EC = mapWindowsError(::GetLastError());
 258     if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
 259       return EC;
 260   }
 261   return std::error_code();
 262 }
 263
 264 std::error_code rename(const Twine &from, const Twine &to) {
 265   // Convert to utf-16.
 266   SmallVector<wchar_t, 128> wide_from;
 267   SmallVector<wchar_t, 128> wide_to;
 268   if (std::error_code ec = widenPath(from, wide_from))
 269     return ec;
 270   if (std::error_code ec = widenPath(to, wide_to))
 271     return ec;
 272
 273   std::error_code ec = std::error_code();
 274
 275   // Retry while we see recoverable errors.
 276   // System scanners (eg. indexer) might open the source file when it is written
 277   // and closed.
 278
 279   bool TryReplace = true;
 280
 281   for (int i = 0; i < 2000; i++) {
 282     if (i > 0)
 283       ::Sleep(1);
 284
 285     if (TryReplace) {
 286       // Try ReplaceFile first, as it is able to associate a new data stream
 287       // with the destination even if the destination file is currently open.
 288       if (::ReplaceFileW(wide_to.data(), wide_from.data(), NULL, 0, NULL, NULL))
 289         return std::error_code();
 290
 291       DWORD ReplaceError = ::GetLastError();
 292       ec = mapWindowsError(ReplaceError);
 293
 294       // If ReplaceFileW returned ERROR_UNABLE_TO_MOVE_REPLACEMENT or
 295       // ERROR_UNABLE_TO_MOVE_REPLACEMENT_2, retry but only use MoveFileExW().
 296       if (ReplaceError == ERROR_UNABLE_TO_MOVE_REPLACEMENT ||
 297           ReplaceError == ERROR_UNABLE_TO_MOVE_REPLACEMENT_2) {
 298         TryReplace = false;
 299         continue;
 300       }
 301       // If ReplaceFileW returned ERROR_UNABLE_TO_REMOVE_REPLACED, retry
 302       // using ReplaceFileW().
 303       if (ReplaceError == ERROR_UNABLE_TO_REMOVE_REPLACED)
 304         continue;
 305       // We get ERROR_FILE_NOT_FOUND if the destination file is missing.
 306       // MoveFileEx can handle this case.
 307       if (ReplaceError != ERROR_ACCESS_DENIED &&
 308           ReplaceError != ERROR_FILE_NOT_FOUND &&
 309           ReplaceError != ERROR_SHARING_VIOLATION)
 310         break;
 311     }
 312
 313     if (::MoveFileExW(wide_from.begin(), wide_to.begin(),
 314                       MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
 315       return std::error_code();
 316
 317     DWORD MoveError = ::GetLastError();
 318     ec = mapWindowsError(MoveError);
 319     if (MoveError != ERROR_ACCESS_DENIED) break;
 320   }
 321
 322   return ec;
 323 }
 324
 325 std::error_code resize_file(int FD, uint64_t Size) {
 326 #ifdef HAVE__CHSIZE_S
 327   errno_t error = ::_chsize_s(FD, Size);
 328 #else
 329   errno_t error = ::_chsize(FD, Size);
 330 #endif
 331   return std::error_code(error, std::generic_category());
 332 }
 333
 334 std::error_code access(const Twine &Path, AccessMode Mode) {
 335   SmallVector<wchar_t, 128> PathUtf16;
 336
 337   if (std::error_code EC = widenPath(Path, PathUtf16))
 338     return EC;
 339
 340   DWORD Attributes = ::GetFileAttributesW(PathUtf16.begin());
 341
 342   if (Attributes == INVALID_FILE_ATTRIBUTES) {
 343     // See if the file didn't actually exist.
 344     DWORD LastError = ::GetLastError();
 345     if (LastError != ERROR_FILE_NOT_FOUND &&
 346         LastError != ERROR_PATH_NOT_FOUND)
 347       return mapWindowsError(LastError);
 348     return errc::no_such_file_or_directory;
 349   }
 350
 351   if (Mode == AccessMode::Write && (Attributes & FILE_ATTRIBUTE_READONLY))
 352     return errc::permission_denied;
 353
 354   return std::error_code();
 355 }
 356
 357 bool can_execute(const Twine &Path) {
 358   return !access(Path, AccessMode::Execute) ||
 359          !access(Path + ".exe", AccessMode::Execute);
 360 }
 361
 362 bool equivalent(file_status A, file_status B) {
 363   assert(status_known(A) && status_known(B));
 364   return A.FileIndexHigh         == B.FileIndexHigh &&
 365          A.FileIndexLow          == B.FileIndexLow &&
 366          A.FileSizeHigh          == B.FileSizeHigh &&
 367          A.FileSizeLow           == B.FileSizeLow &&
 368          A.LastAccessedTimeHigh  == B.LastAccessedTimeHigh &&
 369          A.LastAccessedTimeLow   == B.LastAccessedTimeLow &&
 370          A.LastWriteTimeHigh     == B.LastWriteTimeHigh &&
 371          A.LastWriteTimeLow      == B.LastWriteTimeLow &&
 372          A.VolumeSerialNumber    == B.VolumeSerialNumber;
 373 }
 374
 375 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 376   file_status fsA, fsB;
 377   if (std::error_code ec = status(A, fsA))
 378     return ec;
 379   if (std::error_code ec = status(B, fsB))
 380     return ec;
 381   result = equivalent(fsA, fsB);
 382   return std::error_code();
 383 }
 384
 385 static bool isReservedName(StringRef path) {
 386   // This list of reserved names comes from MSDN, at:
 387   // http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
 388   static const char *const sReservedNames[] = { "nul", "con", "prn", "aux",
 389                                                 "com1", "com2", "com3", "com4",
 390                                                 "com5", "com6", "com7", "com8",
 391                                                 "com9", "lpt1", "lpt2", "lpt3",
 392                                                 "lpt4", "lpt5", "lpt6", "lpt7",
 393                                                 "lpt8", "lpt9" };
 394
 395   // First, check to see if this is a device namespace, which always
 396   // starts with \\.\, since device namespaces are not legal file paths.
 397   if (path.startswith("\\\\.\\"))
 398     return true;
 399
 400   // Then compare against the list of ancient reserved names.
 401   for (size_t i = 0; i < array_lengthof(sReservedNames); ++i) {
 402     if (path.equals_lower(sReservedNames[i]))
 403       return true;
 404   }
 405
 406   // The path isn't what we consider reserved.
 407   return false;
 408 }
 409
 410 static std::error_code getStatus(HANDLE FileHandle, file_status &Result) {
 411   if (FileHandle == INVALID_HANDLE_VALUE)
 412     goto handle_status_error;
 413
 414   switch (::GetFileType(FileHandle)) {
 415   default:
 416     llvm_unreachable("Don't know anything about this file type");
 417   case FILE_TYPE_UNKNOWN: {
 418     DWORD Err = ::GetLastError();
 419     if (Err != NO_ERROR)
 420       return mapWindowsError(Err);
 421     Result = file_status(file_type::type_unknown);
 422     return std::error_code();
 423   }
 424   case FILE_TYPE_DISK:
 425     break;
 426   case FILE_TYPE_CHAR:
 427     Result = file_status(file_type::character_file);
 428     return std::error_code();
 429   case FILE_TYPE_PIPE:
 430     Result = file_status(file_type::fifo_file);
 431     return std::error_code();
 432   }
 433
 434   BY_HANDLE_FILE_INFORMATION Info;
 435   if (!::GetFileInformationByHandle(FileHandle, &Info))
 436     goto handle_status_error;
 437
 438   {
 439     file_type Type = (Info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 440                          ? file_type::directory_file
 441                          : file_type::regular_file;
 442     Result =
 443         file_status(Type, Info.ftLastAccessTime.dwHighDateTime,
 444                     Info.ftLastAccessTime.dwLowDateTime,
 445                     Info.ftLastWriteTime.dwHighDateTime,
 446                     Info.ftLastWriteTime.dwLowDateTime,
 447                     Info.dwVolumeSerialNumber, Info.nFileSizeHigh,
 448                     Info.nFileSizeLow, Info.nFileIndexHigh, Info.nFileIndexLow);
 449     return std::error_code();
 450   }
 451
 452 handle_status_error:
 453   DWORD LastError = ::GetLastError();
 454   if (LastError == ERROR_FILE_NOT_FOUND ||
 455       LastError == ERROR_PATH_NOT_FOUND)
 456     Result = file_status(file_type::file_not_found);
 457   else if (LastError == ERROR_SHARING_VIOLATION)
 458     Result = file_status(file_type::type_unknown);
 459   else
 460     Result = file_status(file_type::status_error);
 461   return mapWindowsError(LastError);
 462 }
 463
 464 std::error_code status(const Twine &path, file_status &result) {
 465   SmallString<128> path_storage;
 466   SmallVector<wchar_t, 128> path_utf16;
 467
 468   StringRef path8 = path.toStringRef(path_storage);
 469   if (isReservedName(path8)) {
 470     result = file_status(file_type::character_file);
 471     return std::error_code();
 472   }
 473
 474   if (std::error_code ec = widenPath(path8, path_utf16))
 475     return ec;
 476
 477   DWORD attr = ::GetFileAttributesW(path_utf16.begin());
 478   if (attr == INVALID_FILE_ATTRIBUTES)
 479     return getStatus(INVALID_HANDLE_VALUE, result);
 480
 481   // Handle reparse points.
 482   if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
 483     ScopedFileHandle h(
 484       ::CreateFileW(path_utf16.begin(),
 485                     0, // Attributes only.
 486                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 487                     NULL,
 488                     OPEN_EXISTING,
 489                     FILE_FLAG_BACKUP_SEMANTICS,
 490                     0));
 491     if (!h)
 492       return getStatus(INVALID_HANDLE_VALUE, result);
 493   }
 494
 495   ScopedFileHandle h(
 496       ::CreateFileW(path_utf16.begin(), 0, // Attributes only.
 497                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 498                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0));
 499     if (!h)
 500       return getStatus(INVALID_HANDLE_VALUE, result);
 501
 502     return getStatus(h, result);
 503 }
 504
 505 std::error_code status(int FD, file_status &Result) {
 506   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 507   return getStatus(FileHandle, Result);
 508 }
 509
 510 std::error_code setLastModificationAndAccessTime(int FD, TimePoint<> Time) {
 511   FILETIME FT = toFILETIME(Time);
 512   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 513   if (!SetFileTime(FileHandle, NULL, &FT, &FT))
 514     return mapWindowsError(::GetLastError());
 515   return std::error_code();
 516 }
 517
 518 std::error_code mapped_file_region::init(int FD, uint64_t Offset,
 519                                          mapmode Mode) {
 520   // Make sure that the requested size fits within SIZE_T.
 521   if (Size > std::numeric_limits<SIZE_T>::max())
 522     return make_error_code(errc::invalid_argument);
 523
 524   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 525   if (FileHandle == INVALID_HANDLE_VALUE)
 526     return make_error_code(errc::bad_file_descriptor);
 527
 528   DWORD flprotect;
 529   switch (Mode) {
 530   case readonly:  flprotect = PAGE_READONLY; break;
 531   case readwrite: flprotect = PAGE_READWRITE; break;
 532   case priv:      flprotect = PAGE_WRITECOPY; break;
 533   }
 534
 535   HANDLE FileMappingHandle =
 536       ::CreateFileMappingW(FileHandle, 0, flprotect,
 537                            (Offset + Size) >> 32,
 538                            (Offset + Size) & 0xffffffff,
 539                            0);
 540   if (FileMappingHandle == NULL) {
 541     std::error_code ec = mapWindowsError(GetLastError());
 542     return ec;
 543   }
 544
 545   DWORD dwDesiredAccess;
 546   switch (Mode) {
 547   case readonly:  dwDesiredAccess = FILE_MAP_READ; break;
 548   case readwrite: dwDesiredAccess = FILE_MAP_WRITE; break;
 549   case priv:      dwDesiredAccess = FILE_MAP_COPY; break;
 550   }
 551   Mapping = ::MapViewOfFile(FileMappingHandle,
 552                             dwDesiredAccess,
 553                             Offset >> 32,
 554                             Offset & 0xffffffff,
 555                             Size);
 556   if (Mapping == NULL) {
 557     std::error_code ec = mapWindowsError(GetLastError());
 558     ::CloseHandle(FileMappingHandle);
 559     return ec;
 560   }
 561
 562   if (Size == 0) {
 563     MEMORY_BASIC_INFORMATION mbi;
 564     SIZE_T Result = VirtualQuery(Mapping, &mbi, sizeof(mbi));
 565     if (Result == 0) {
 566       std::error_code ec = mapWindowsError(GetLastError());
 567       ::UnmapViewOfFile(Mapping);
 568       ::CloseHandle(FileMappingHandle);
 569       return ec;
 570     }
 571     Size = mbi.RegionSize;
 572   }
 573
 574   // Close all the handles except for the view. It will keep the other handles
 575   // alive.
 576   ::CloseHandle(FileMappingHandle);
 577   return std::error_code();
 578 }
 579
 580 mapped_file_region::mapped_file_region(int fd, mapmode mode, uint64_t length,
 581                                        uint64_t offset, std::error_code &ec)
 582     : Size(length), Mapping() {
 583   ec = init(fd, offset, mode);
 584   if (ec)
 585     Mapping = 0;
 586 }
 587
 588 mapped_file_region::~mapped_file_region() {
 589   if (Mapping)
 590     ::UnmapViewOfFile(Mapping);
 591 }
 592
 593 uint64_t mapped_file_region::size() const {
 594   assert(Mapping && "Mapping failed but used anyway!");
 595   return Size;
 596 }
 597
 598 char *mapped_file_region::data() const {
 599   assert(Mapping && "Mapping failed but used anyway!");
 600   return reinterpret_cast<char*>(Mapping);
 601 }
 602
 603 const char *mapped_file_region::const_data() const {
 604   assert(Mapping && "Mapping failed but used anyway!");
 605   return reinterpret_cast<const char*>(Mapping);
 606 }
 607
 608 int mapped_file_region::alignment() {
 609   SYSTEM_INFO SysInfo;
 610   ::GetSystemInfo(&SysInfo);
 611   return SysInfo.dwAllocationGranularity;
 612 }
 613
 614 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
 615                                                 StringRef path){
 616   SmallVector<wchar_t, 128> path_utf16;
 617
 618   if (std::error_code ec = widenPath(path, path_utf16))
 619     return ec;
 620
 621   // Convert path to the format that Windows is happy with.
 622   if (path_utf16.size() > 0 &&
 623       !is_separator(path_utf16[path.size() - 1]) &&
 624       path_utf16[path.size() - 1] != L':') {
 625     path_utf16.push_back(L'\\');
 626     path_utf16.push_back(L'*');
 627   } else {
 628     path_utf16.push_back(L'*');
 629   }
 630
 631   //  Get the first directory entry.
 632   WIN32_FIND_DATAW FirstFind;
 633   ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
 634   if (!FindHandle)
 635     return mapWindowsError(::GetLastError());
 636
 637   size_t FilenameLen = ::wcslen(FirstFind.cFileName);
 638   while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
 639          (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
 640                               FirstFind.cFileName[1] == L'.'))
 641     if (!::FindNextFileW(FindHandle, &FirstFind)) {
 642       DWORD LastError = ::GetLastError();
 643       // Check for end.
 644       if (LastError == ERROR_NO_MORE_FILES)
 645         return detail::directory_iterator_destruct(it);
 646       return mapWindowsError(LastError);
 647     } else
 648       FilenameLen = ::wcslen(FirstFind.cFileName);
 649
 650   // Construct the current directory entry.
 651   SmallString<128> directory_entry_name_utf8;
 652   if (std::error_code ec =
 653           UTF16ToUTF8(FirstFind.cFileName, ::wcslen(FirstFind.cFileName),
 654                       directory_entry_name_utf8))
 655     return ec;
 656
 657   it.IterationHandle = intptr_t(FindHandle.take());
 658   SmallString<128> directory_entry_path(path);
 659   path::append(directory_entry_path, directory_entry_name_utf8);
 660   it.CurrentEntry = directory_entry(directory_entry_path);
 661
 662   return std::error_code();
 663 }
 664
 665 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 666   if (it.IterationHandle != 0)
 667     // Closes the handle if it's valid.
 668     ScopedFindHandle close(HANDLE(it.IterationHandle));
 669   it.IterationHandle = 0;
 670   it.CurrentEntry = directory_entry();
 671   return std::error_code();
 672 }
 673
 674 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 675   WIN32_FIND_DATAW FindData;
 676   if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
 677     DWORD LastError = ::GetLastError();
 678     // Check for end.
 679     if (LastError == ERROR_NO_MORE_FILES)
 680       return detail::directory_iterator_destruct(it);
 681     return mapWindowsError(LastError);
 682   }
 683
 684   size_t FilenameLen = ::wcslen(FindData.cFileName);
 685   if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
 686       (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
 687                            FindData.cFileName[1] == L'.'))
 688     return directory_iterator_increment(it);
 689
 690   SmallString<128> directory_entry_path_utf8;
 691   if (std::error_code ec =
 692           UTF16ToUTF8(FindData.cFileName, ::wcslen(FindData.cFileName),
 693                       directory_entry_path_utf8))
 694     return ec;
 695
 696   it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
 697   return std::error_code();
 698 }
 699
 700 std::error_code openFileForRead(const Twine &Name, int &ResultFD,
 701                                 SmallVectorImpl<char> *RealPath) {
 702   SmallVector<wchar_t, 128> PathUTF16;
 703
 704   if (std::error_code EC = widenPath(Name, PathUTF16))
 705     return EC;
 706
 707   HANDLE H =
 708       ::CreateFileW(PathUTF16.begin(), GENERIC_READ,
 709                     FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 710                     NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 711   if (H == INVALID_HANDLE_VALUE) {
 712     DWORD LastError = ::GetLastError();
 713     std::error_code EC = mapWindowsError(LastError);
 714     // Provide a better error message when trying to open directories.
 715     // This only runs if we failed to open the file, so there is probably
 716     // no performances issues.
 717     if (LastError != ERROR_ACCESS_DENIED)
 718       return EC;
 719     if (is_directory(Name))
 720       return make_error_code(errc::is_a_directory);
 721     return EC;
 722   }
 723
 724   int FD = ::_open_osfhandle(intptr_t(H), 0);
 725   if (FD == -1) {
 726     ::CloseHandle(H);
 727     return mapWindowsError(ERROR_INVALID_HANDLE);
 728   }
 729
 730   // Fetch the real name of the file, if the user asked
 731   if (RealPath) {
 732     RealPath->clear();
 733     wchar_t RealPathUTF16[MAX_PATH];
 734     DWORD CountChars =
 735       ::GetFinalPathNameByHandleW(H, RealPathUTF16, MAX_PATH,
 736                                   FILE_NAME_NORMALIZED);
 737     if (CountChars > 0 && CountChars < MAX_PATH) {
 738       // Convert the result from UTF-16 to UTF-8.
 739       SmallString<MAX_PATH> RealPathUTF8;
 740       if (!UTF16ToUTF8(RealPathUTF16, CountChars, RealPathUTF8))
 741         RealPath->append(RealPathUTF8.data(),
 742                          RealPathUTF8.data() + strlen(RealPathUTF8.data()));
 743     }
 744   }
 745
 746   ResultFD = FD;
 747   return std::error_code();
 748 }
 749
 750 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
 751                             sys::fs::OpenFlags Flags, unsigned Mode) {
 752   // Verify that we don't have both "append" and "excl".
 753   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
 754          "Cannot specify both 'excl' and 'append' file creation flags!");
 755
 756   SmallVector<wchar_t, 128> PathUTF16;
 757
 758   if (std::error_code EC = widenPath(Name, PathUTF16))
 759     return EC;
 760
 761   DWORD CreationDisposition;
 762   if (Flags & F_Excl)
 763     CreationDisposition = CREATE_NEW;
 764   else if (Flags & F_Append)
 765     CreationDisposition = OPEN_ALWAYS;
 766   else
 767     CreationDisposition = CREATE_ALWAYS;
 768
 769   DWORD Access = GENERIC_WRITE;
 770   if (Flags & F_RW)
 771     Access |= GENERIC_READ;
 772
 773   HANDLE H = ::CreateFileW(PathUTF16.begin(), Access,
 774                            FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
 775                            CreationDisposition, FILE_ATTRIBUTE_NORMAL, NULL);
 776
 777   if (H == INVALID_HANDLE_VALUE) {
 778     DWORD LastError = ::GetLastError();
 779     std::error_code EC = mapWindowsError(LastError);
 780     // Provide a better error message when trying to open directories.
 781     // This only runs if we failed to open the file, so there is probably
 782     // no performances issues.
 783     if (LastError != ERROR_ACCESS_DENIED)
 784       return EC;
 785     if (is_directory(Name))
 786       return make_error_code(errc::is_a_directory);
 787     return EC;
 788   }
 789
 790   int OpenFlags = 0;
 791   if (Flags & F_Append)
 792     OpenFlags |= _O_APPEND;
 793
 794   if (Flags & F_Text)
 795     OpenFlags |= _O_TEXT;
 796
 797   int FD = ::_open_osfhandle(intptr_t(H), OpenFlags);
 798   if (FD == -1) {
 799     ::CloseHandle(H);
 800     return mapWindowsError(ERROR_INVALID_HANDLE);
 801   }
 802
 803   ResultFD = FD;
 804   return std::error_code();
 805 }
 806
 807 std::error_code getPathFromOpenFD(int FD, SmallVectorImpl<char> &ResultPath) {
 808   HANDLE FileHandle = reinterpret_cast<HANDLE>(::_get_osfhandle(FD));
 809   if (FileHandle == INVALID_HANDLE_VALUE)
 810     return make_error_code(errc::bad_file_descriptor);
 811
 812   DWORD CharCount;
 813   SmallVector<wchar_t, 1024> TempPath;
 814   do {
 815     CharCount = ::GetFinalPathNameByHandleW(FileHandle, TempPath.begin(),
 816                                             TempPath.capacity(),
 817                                             FILE_NAME_NORMALIZED);
 818     if (CharCount < TempPath.capacity())
 819       break;
 820
 821     // Reserve sufficient space for the path as well as the null character. Even
 822     // though the API does not document that it is required, if we reserve just
 823     // CharCount space, the function call will not store the resulting path and
 824     // still report success.
 825     TempPath.reserve(CharCount + 1);
 826   } while (true);
 827
 828   if (CharCount == 0)
 829     return mapWindowsError(::GetLastError());
 830
 831   TempPath.set_size(CharCount);
 832
 833   // On earlier Windows releases, the character count includes the terminating
 834   // null.
 835   if (TempPath.back() == L'\0') {
 836     --CharCount;
 837     TempPath.pop_back();
 838   }
 839
 840   return windows::UTF16ToUTF8(TempPath.data(), CharCount, ResultPath);
 841 }
 842 } // end namespace fs
 843
 844 namespace path {
 845 static bool getKnownFolderPath(KNOWNFOLDERID folderId,
 846                                SmallVectorImpl<char> &result) {
 847   wchar_t *path = nullptr;
 848   if (::SHGetKnownFolderPath(folderId, KF_FLAG_CREATE, nullptr, &path) != S_OK)
 849     return false;
 850
 851   bool ok = !UTF16ToUTF8(path, ::wcslen(path), result);
 852   ::CoTaskMemFree(path);
 853   return ok;
 854 }
 855
 856 bool getUserCacheDir(SmallVectorImpl<char> &Result) {
 857   return getKnownFolderPath(FOLDERID_LocalAppData, Result);
 858 }
 859
 860 bool home_directory(SmallVectorImpl<char> &result) {
 861   return getKnownFolderPath(FOLDERID_Profile, result);
 862 }
 863
 864 static bool getTempDirEnvVar(const wchar_t *Var, SmallVectorImpl<char> &Res) {
 865   SmallVector<wchar_t, 1024> Buf;
 866   size_t Size = 1024;
 867   do {
 868     Buf.reserve(Size);
 869     Size = GetEnvironmentVariableW(Var, Buf.data(), Buf.capacity());
 870     if (Size == 0)
 871       return false;
 872
 873     // Try again with larger buffer.
 874   } while (Size > Buf.capacity());
 875   Buf.set_size(Size);
 876
 877   return !windows::UTF16ToUTF8(Buf.data(), Size, Res);
 878 }
 879
 880 static bool getTempDirEnvVar(SmallVectorImpl<char> &Res) {
 881   const wchar_t *EnvironmentVariables[] = {L"TMP", L"TEMP", L"USERPROFILE"};
 882   for (auto *Env : EnvironmentVariables) {
 883     if (getTempDirEnvVar(Env, Res))
 884       return true;
 885   }
 886   return false;
 887 }
 888
 889 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
 890   (void)ErasedOnReboot;
 891   Result.clear();
 892
 893   // Check whether the temporary directory is specified by an environment var.
 894   // This matches GetTempPath logic to some degree. GetTempPath is not used
 895   // directly as it cannot handle evn var longer than 130 chars on Windows 7
 896   // (fixed on Windows 8).
 897   if (getTempDirEnvVar(Result)) {
 898     assert(!Result.empty() && "Unexpected empty path");
 899     native(Result); // Some Unix-like shells use Unix path separator in $TMP.
 900     fs::make_absolute(Result); // Make it absolute if not already.
 901     return;
 902   }
 903
 904   // Fall back to a system default.
 905   const char *DefaultResult = "C:\\Temp";
 906   Result.append(DefaultResult, DefaultResult + strlen(DefaultResult));
 907 }
 908 } // end namespace path
 909
 910 namespace windows {
 911 std::error_code UTF8ToUTF16(llvm::StringRef utf8,
 912                             llvm::SmallVectorImpl<wchar_t> &utf16) {
 913   if (!utf8.empty()) {
 914     int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 915                                     utf8.size(), utf16.begin(), 0);
 916
 917     if (len == 0)
 918       return mapWindowsError(::GetLastError());
 919
 920     utf16.reserve(len + 1);
 921     utf16.set_size(len);
 922
 923     len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
 924                                 utf8.size(), utf16.begin(), utf16.size());
 925
 926     if (len == 0)
 927       return mapWindowsError(::GetLastError());
 928   }
 929
 930   // Make utf16 null terminated.
 931   utf16.push_back(0);
 932   utf16.pop_back();
 933
 934   return std::error_code();
 935 }
 936
 937 static
 938 std::error_code UTF16ToCodePage(unsigned codepage, const wchar_t *utf16,
 939                                 size_t utf16_len,
 940                                 llvm::SmallVectorImpl<char> &utf8) {
 941   if (utf16_len) {
 942     // Get length.
 943     int len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.begin(),
 944                                     0, NULL, NULL);
 945
 946     if (len == 0)
 947       return mapWindowsError(::GetLastError());
 948
 949     utf8.reserve(len);
 950     utf8.set_size(len);
 951
 952     // Now do the actual conversion.
 953     len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.data(),
 954                                 utf8.size(), NULL, NULL);
 955
 956     if (len == 0)
 957       return mapWindowsError(::GetLastError());
 958   }
 959
 960   // Make utf8 null terminated.
 961   utf8.push_back(0);
 962   utf8.pop_back();
 963
 964   return std::error_code();
 965 }
 966
 967 std::error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
 968                             llvm::SmallVectorImpl<char> &utf8) {
 969   return UTF16ToCodePage(CP_UTF8, utf16, utf16_len, utf8);
 970 }
 971
 972 std::error_code UTF16ToCurCP(const wchar_t *utf16, size_t utf16_len,
 973                              llvm::SmallVectorImpl<char> &utf8) {
 974   return UTF16ToCodePage(CP_ACP, utf16, utf16_len, utf8);
 975 }
 976
 977 } // end namespace windows
 978 } // end namespace sys
 979 } // end namespace llvm