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 "Windows.h"
  21 #include <fcntl.h>
  22 #include <io.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25
  26 #undef max
  27
  28 // MinGW doesn't define this.
  29 #ifndef _ERRNO_T_DEFINED
  30 #define _ERRNO_T_DEFINED
  31 typedef int errno_t;
  32 #endif
  33
  34 using namespace llvm;
  35
  36 namespace {
  37   typedef BOOLEAN (WINAPI *PtrCreateSymbolicLinkW)(
  38     /*__in*/ LPCWSTR lpSymlinkFileName,
  39     /*__in*/ LPCWSTR lpTargetFileName,
  40     /*__in*/ DWORD dwFlags);
  41
  42   PtrCreateSymbolicLinkW create_symbolic_link_api = PtrCreateSymbolicLinkW(
  43     ::GetProcAddress(::GetModuleHandleA("kernel32.dll"),
  44                      "CreateSymbolicLinkW"));
  45
  46   error_code UTF8ToUTF16(StringRef utf8, SmallVectorImpl<wchar_t> &utf16) {
  47     int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS,
  48                                     utf8.begin(), utf8.size(),
  49                                     utf16.begin(), 0);
  50
  51     if (len == 0)
  52       return windows_error(::GetLastError());
  53
  54     utf16.reserve(len + 1);
  55     utf16.set_size(len);
  56
  57     len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS,
  58                                     utf8.begin(), utf8.size(),
  59                                     utf16.begin(), utf16.size());
  60
  61     if (len == 0)
  62       return windows_error(::GetLastError());
  63
  64     // Make utf16 null terminated.
  65     utf16.push_back(0);
  66     utf16.pop_back();
  67
  68     return error_code::success();
  69   }
  70
  71   error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
  72                                SmallVectorImpl<char> &utf8) {
  73     // Get length.
  74     int len = ::WideCharToMultiByte(CP_UTF8, 0,
  75                                     utf16, utf16_len,
  76                                     utf8.begin(), 0,
  77                                     NULL, NULL);
  78
  79     if (len == 0)
  80       return windows_error(::GetLastError());
  81
  82     utf8.reserve(len);
  83     utf8.set_size(len);
  84
  85     // Now do the actual conversion.
  86     len = ::WideCharToMultiByte(CP_UTF8, 0,
  87                                 utf16, utf16_len,
  88                                 utf8.data(), utf8.size(),
  89                                 NULL, NULL);
  90
  91     if (len == 0)
  92       return windows_error(::GetLastError());
  93
  94     // Make utf8 null terminated.
  95     utf8.push_back(0);
  96     utf8.pop_back();
  97
  98     return error_code::success();
  99   }
 100
 101   error_code TempDir(SmallVectorImpl<wchar_t> &result) {
 102   retry_temp_dir:
 103     DWORD len = ::GetTempPathW(result.capacity(), result.begin());
 104
 105     if (len == 0)
 106       return windows_error(::GetLastError());
 107
 108     if (len > result.capacity()) {
 109       result.reserve(len);
 110       goto retry_temp_dir;
 111     }
 112
 113     result.set_size(len);
 114     return error_code::success();
 115   }
 116
 117   bool is_separator(const wchar_t value) {
 118     switch (value) {
 119     case L'\\':
 120     case L'/':
 121       return true;
 122     default:
 123       return false;
 124     }
 125   }
 126 }
 127
 128 // FIXME: mode should be used here and default to user r/w only,
 129 // it currently comes in as a UNIX mode.
 130 static error_code createUniqueEntity(const Twine &model, int &result_fd,
 131                                      SmallVectorImpl<char> &result_path,
 132                                      bool makeAbsolute, unsigned mode,
 133                                      FSEntity Type) {
 134   // Use result_path as temp storage.
 135   result_path.set_size(0);
 136   StringRef m = model.toStringRef(result_path);
 137
 138   SmallVector<wchar_t, 128> model_utf16;
 139   if (error_code ec = UTF8ToUTF16(m, model_utf16)) return ec;
 140
 141   if (makeAbsolute) {
 142     // Make model absolute by prepending a temp directory if it's not already.
 143     bool absolute = sys::path::is_absolute(m);
 144
 145     if (!absolute) {
 146       SmallVector<wchar_t, 64> temp_dir;
 147       if (error_code ec = TempDir(temp_dir)) return ec;
 148       // Handle c: by removing it.
 149       if (model_utf16.size() > 2 && model_utf16[1] == L':') {
 150         model_utf16.erase(model_utf16.begin(), model_utf16.begin() + 2);
 151       }
 152       model_utf16.insert(model_utf16.begin(), temp_dir.begin(), temp_dir.end());
 153     }
 154   }
 155
 156   // Replace '%' with random chars. From here on, DO NOT modify model. It may be
 157   // needed if the randomly chosen path already exists.
 158   SmallVector<wchar_t, 128> random_path_utf16;
 159
 160   // Get a Crypto Provider for CryptGenRandom.
 161   HCRYPTPROV HCPC;
 162   if (!::CryptAcquireContextW(&HCPC,
 163                               NULL,
 164                               NULL,
 165                               PROV_RSA_FULL,
 166                               CRYPT_VERIFYCONTEXT))
 167     return windows_error(::GetLastError());
 168   ScopedCryptContext CryptoProvider(HCPC);
 169
 170 retry_random_path:
 171   random_path_utf16.set_size(0);
 172   for (SmallVectorImpl<wchar_t>::const_iterator i = model_utf16.begin(),
 173                                                 e = model_utf16.end();
 174                                                 i != e; ++i) {
 175     if (*i == L'%') {
 176       BYTE val = 0;
 177       if (!::CryptGenRandom(CryptoProvider, 1, &val))
 178           return windows_error(::GetLastError());
 179       random_path_utf16.push_back("0123456789abcdef"[val & 15]);
 180     }
 181     else
 182       random_path_utf16.push_back(*i);
 183   }
 184   // Make random_path_utf16 null terminated.
 185   random_path_utf16.push_back(0);
 186   random_path_utf16.pop_back();
 187
 188   HANDLE TempFileHandle = INVALID_HANDLE_VALUE;
 189
 190   switch (Type) {
 191   case FS_File: {
 192     // Try to create + open the path.
 193     TempFileHandle =
 194         ::CreateFileW(random_path_utf16.begin(), GENERIC_READ | GENERIC_WRITE,
 195                       FILE_SHARE_READ, NULL,
 196                       // Return ERROR_FILE_EXISTS if the file
 197                       // already exists.
 198                       CREATE_NEW, FILE_ATTRIBUTE_TEMPORARY, NULL);
 199     if (TempFileHandle == INVALID_HANDLE_VALUE) {
 200       // If the file existed, try again, otherwise, error.
 201       error_code ec = windows_error(::GetLastError());
 202       if (ec == windows_error::file_exists)
 203         goto retry_random_path;
 204
 205       return ec;
 206     }
 207
 208     // Convert the Windows API file handle into a C-runtime handle.
 209     int fd = ::_open_osfhandle(intptr_t(TempFileHandle), 0);
 210     if (fd == -1) {
 211       ::CloseHandle(TempFileHandle);
 212       ::DeleteFileW(random_path_utf16.begin());
 213       // MSDN doesn't say anything about _open_osfhandle setting errno or
 214       // GetLastError(), so just return invalid_handle.
 215       return windows_error::invalid_handle;
 216     }
 217
 218     result_fd = fd;
 219     break;
 220   }
 221
 222   case FS_Name: {
 223     DWORD attributes = ::GetFileAttributesW(random_path_utf16.begin());
 224     if (attributes != INVALID_FILE_ATTRIBUTES)
 225       goto retry_random_path;
 226     error_code EC = make_error_code(windows_error(::GetLastError()));
 227     if (EC != windows_error::file_not_found &&
 228         EC != windows_error::path_not_found)
 229       return EC;
 230     break;
 231   }
 232
 233   case FS_Dir:
 234     if (!::CreateDirectoryW(random_path_utf16.begin(), NULL)) {
 235       error_code EC = windows_error(::GetLastError());
 236       if (EC != windows_error::already_exists)
 237         return EC;
 238       goto retry_random_path;
 239     }
 240     break;
 241   }
 242
 243   // Set result_path to the utf-8 representation of the path.
 244   if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
 245                                   random_path_utf16.size(), result_path)) {
 246     switch (Type) {
 247     case FS_File:
 248       ::CloseHandle(TempFileHandle);
 249       ::DeleteFileW(random_path_utf16.begin());
 250     case FS_Name:
 251       break;
 252     case FS_Dir:
 253       ::RemoveDirectoryW(random_path_utf16.begin());
 254       break;
 255     }
 256     return ec;
 257   }
 258
 259   return error_code::success();
 260 }
 261
 262 namespace llvm {
 263 namespace sys  {
 264 namespace fs {
 265
 266 std::string getMainExecutable(const char *argv0, void *MainExecAddr) {
 267   char pathname[MAX_PATH];
 268   DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
 269   return ret != MAX_PATH ? pathname : "";
 270 }
 271
 272 UniqueID file_status::getUniqueID() const {
 273   // The file is uniquely identified by the volume serial number along
 274   // with the 64-bit file identifier.
 275   uint64_t FileID = (static_cast<uint64_t>(FileIndexHigh) << 32ULL) |
 276                     static_cast<uint64_t>(FileIndexLow);
 277
 278   return UniqueID(VolumeSerialNumber, FileID);
 279 }
 280
 281 TimeValue file_status::getLastModificationTime() const {
 282   ULARGE_INTEGER UI;
 283   UI.LowPart = LastWriteTimeLow;
 284   UI.HighPart = LastWriteTimeHigh;
 285
 286   TimeValue Ret;
 287   Ret.fromWin32Time(UI.QuadPart);
 288   return Ret;
 289 }
 290
 291 error_code current_path(SmallVectorImpl<char> &result) {
 292   SmallVector<wchar_t, 128> cur_path;
 293   cur_path.reserve(128);
 294 retry_cur_dir:
 295   DWORD len = ::GetCurrentDirectoryW(cur_path.capacity(), cur_path.data());
 296
 297   // A zero return value indicates a failure other than insufficient space.
 298   if (len == 0)
 299     return windows_error(::GetLastError());
 300
 301   // If there's insufficient space, the len returned is larger than the len
 302   // given.
 303   if (len > cur_path.capacity()) {
 304     cur_path.reserve(len);
 305     goto retry_cur_dir;
 306   }
 307
 308   cur_path.set_size(len);
 309   // cur_path now holds the current directory in utf-16. Convert to utf-8.
 310
 311   // Find out how much space we need. Sadly, this function doesn't return the
 312   // size needed unless you tell it the result size is 0, which means you
 313   // _always_ have to call it twice.
 314   len = ::WideCharToMultiByte(CP_UTF8, 0,
 315                               cur_path.data(), cur_path.size(),
 316                               result.data(), 0,
 317                               NULL, NULL);
 318
 319   if (len == 0)
 320     return make_error_code(windows_error(::GetLastError()));
 321
 322   result.reserve(len);
 323   result.set_size(len);
 324   // Now do the actual conversion.
 325   len = ::WideCharToMultiByte(CP_UTF8, 0,
 326                               cur_path.data(), cur_path.size(),
 327                               result.data(), result.size(),
 328                               NULL, NULL);
 329   if (len == 0)
 330     return windows_error(::GetLastError());
 331
 332   return error_code::success();
 333 }
 334
 335 error_code create_directory(const Twine &path, bool &existed) {
 336   SmallString<128> path_storage;
 337   SmallVector<wchar_t, 128> path_utf16;
 338
 339   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
 340                                   path_utf16))
 341     return ec;
 342
 343   if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
 344     error_code ec = windows_error(::GetLastError());
 345     if (ec == windows_error::already_exists)
 346       existed = true;
 347     else
 348       return ec;
 349   } else
 350     existed = false;
 351
 352   return error_code::success();
 353 }
 354
 355 error_code create_hard_link(const Twine &to, const Twine &from) {
 356   // Get arguments.
 357   SmallString<128> from_storage;
 358   SmallString<128> to_storage;
 359   StringRef f = from.toStringRef(from_storage);
 360   StringRef t = to.toStringRef(to_storage);
 361
 362   // Convert to utf-16.
 363   SmallVector<wchar_t, 128> wide_from;
 364   SmallVector<wchar_t, 128> wide_to;
 365   if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
 366   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 367
 368   if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
 369     return windows_error(::GetLastError());
 370
 371   return error_code::success();
 372 }
 373
 374 error_code create_symlink(const Twine &to, const Twine &from) {
 375   // Only do it if the function is available at runtime.
 376   if (!create_symbolic_link_api)
 377     return make_error_code(errc::function_not_supported);
 378
 379   // Get arguments.
 380   SmallString<128> from_storage;
 381   SmallString<128> to_storage;
 382   StringRef f = from.toStringRef(from_storage);
 383   StringRef t = to.toStringRef(to_storage);
 384
 385   // Convert to utf-16.
 386   SmallVector<wchar_t, 128> wide_from;
 387   SmallVector<wchar_t, 128> wide_to;
 388   if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
 389   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 390
 391   if (!create_symbolic_link_api(wide_from.begin(), wide_to.begin(), 0))
 392     return windows_error(::GetLastError());
 393
 394   return error_code::success();
 395 }
 396
 397 error_code remove(const Twine &path, bool &existed) {
 398   SmallString<128> path_storage;
 399   SmallVector<wchar_t, 128> path_utf16;
 400
 401   file_status st;
 402   if (error_code ec = status(path, st))
 403     return ec;
 404
 405   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
 406                                   path_utf16))
 407     return ec;
 408
 409   if (st.type() == file_type::directory_file) {
 410     if (!::RemoveDirectoryW(c_str(path_utf16))) {
 411       error_code ec = windows_error(::GetLastError());
 412       if (ec != windows_error::file_not_found)
 413         return ec;
 414       existed = false;
 415     } else
 416       existed = true;
 417   } else {
 418     if (!::DeleteFileW(c_str(path_utf16))) {
 419       error_code ec = windows_error(::GetLastError());
 420       if (ec != windows_error::file_not_found)
 421         return ec;
 422       existed = false;
 423     } else
 424       existed = true;
 425   }
 426
 427   return error_code::success();
 428 }
 429
 430 error_code rename(const Twine &from, const Twine &to) {
 431   // Get arguments.
 432   SmallString<128> from_storage;
 433   SmallString<128> to_storage;
 434   StringRef f = from.toStringRef(from_storage);
 435   StringRef t = to.toStringRef(to_storage);
 436
 437   // Convert to utf-16.
 438   SmallVector<wchar_t, 128> wide_from;
 439   SmallVector<wchar_t, 128> wide_to;
 440   if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
 441   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 442
 443   error_code ec = error_code::success();
 444   for (int i = 0; i < 2000; i++) {
 445     if (::MoveFileExW(wide_from.begin(), wide_to.begin(),
 446                       MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
 447       return error_code::success();
 448     ec = windows_error(::GetLastError());
 449     if (ec != windows_error::access_denied)
 450       break;
 451     // Retry MoveFile() at ACCESS_DENIED.
 452     // System scanners (eg. indexer) might open the source file when
 453     // It is written and closed.
 454     ::Sleep(1);
 455   }
 456
 457   return ec;
 458 }
 459
 460 error_code resize_file(const Twine &path, uint64_t size) {
 461   SmallString<128> path_storage;
 462   SmallVector<wchar_t, 128> path_utf16;
 463
 464   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
 465                                   path_utf16))
 466     return ec;
 467
 468   int fd = ::_wopen(path_utf16.begin(), O_BINARY | _O_RDWR, S_IWRITE);
 469   if (fd == -1)
 470     return error_code(errno, generic_category());
 471 #ifdef HAVE__CHSIZE_S
 472   errno_t error = ::_chsize_s(fd, size);
 473 #else
 474   errno_t error = ::_chsize(fd, size);
 475 #endif
 476   ::close(fd);
 477   return error_code(error, generic_category());
 478 }
 479
 480 error_code exists(const Twine &path, bool &result) {
 481   SmallString<128> path_storage;
 482   SmallVector<wchar_t, 128> path_utf16;
 483
 484   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
 485                                   path_utf16))
 486     return ec;
 487
 488   DWORD attributes = ::GetFileAttributesW(path_utf16.begin());
 489
 490   if (attributes == INVALID_FILE_ATTRIBUTES) {
 491     // See if the file didn't actually exist.
 492     error_code ec = make_error_code(windows_error(::GetLastError()));
 493     if (ec != windows_error::file_not_found &&
 494         ec != windows_error::path_not_found)
 495       return ec;
 496     result = false;
 497   } else
 498     result = true;
 499   return error_code::success();
 500 }
 501
 502 bool can_write(const Twine &Path) {
 503   // FIXME: take security attributes into account.
 504   SmallString<128> PathStorage;
 505   SmallVector<wchar_t, 128> PathUtf16;
 506
 507   if (UTF8ToUTF16(Path.toStringRef(PathStorage), PathUtf16))
 508     return false;
 509
 510   DWORD Attr = ::GetFileAttributesW(PathUtf16.begin());
 511   return (Attr != INVALID_FILE_ATTRIBUTES) && !(Attr & FILE_ATTRIBUTE_READONLY);
 512 }
 513
 514 bool can_execute(const Twine &Path) {
 515   SmallString<128> PathStorage;
 516   SmallVector<wchar_t, 128> PathUtf16;
 517
 518   if (UTF8ToUTF16(Path.toStringRef(PathStorage), PathUtf16))
 519     return false;
 520
 521   DWORD Attr = ::GetFileAttributesW(PathUtf16.begin());
 522   return Attr != INVALID_FILE_ATTRIBUTES;
 523 }
 524
 525 bool equivalent(file_status A, file_status B) {
 526   assert(status_known(A) && status_known(B));
 527   return A.FileIndexHigh      == B.FileIndexHigh &&
 528          A.FileIndexLow       == B.FileIndexLow &&
 529          A.FileSizeHigh       == B.FileSizeHigh &&
 530          A.FileSizeLow        == B.FileSizeLow &&
 531          A.LastWriteTimeHigh  == B.LastWriteTimeHigh &&
 532          A.LastWriteTimeLow   == B.LastWriteTimeLow &&
 533          A.VolumeSerialNumber == B.VolumeSerialNumber;
 534 }
 535
 536 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
 537   file_status fsA, fsB;
 538   if (error_code ec = status(A, fsA)) return ec;
 539   if (error_code ec = status(B, fsB)) return ec;
 540   result = equivalent(fsA, fsB);
 541   return error_code::success();
 542 }
 543
 544 static bool isReservedName(StringRef path) {
 545   // This list of reserved names comes from MSDN, at:
 546   // http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
 547   static const char *sReservedNames[] = { "nul", "con", "prn", "aux",
 548                               "com1", "com2", "com3", "com4", "com5", "com6",
 549                               "com7", "com8", "com9", "lpt1", "lpt2", "lpt3",
 550                               "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9" };
 551
 552   // First, check to see if this is a device namespace, which always
 553   // starts with \\.\, since device namespaces are not legal file paths.
 554   if (path.startswith("\\\\.\\"))
 555     return true;
 556
 557   // Then compare against the list of ancient reserved names
 558   for (size_t i = 0; i < array_lengthof(sReservedNames); ++i) {
 559     if (path.equals_lower(sReservedNames[i]))
 560       return true;
 561   }
 562
 563   // The path isn't what we consider reserved.
 564   return false;
 565 }
 566
 567 static error_code getStatus(HANDLE FileHandle, file_status &Result) {
 568   if (FileHandle == INVALID_HANDLE_VALUE)
 569     goto handle_status_error;
 570
 571   switch (::GetFileType(FileHandle)) {
 572   default:
 573     llvm_unreachable("Don't know anything about this file type");
 574   case FILE_TYPE_UNKNOWN: {
 575     DWORD Err = ::GetLastError();
 576     if (Err != NO_ERROR)
 577       return windows_error(Err);
 578     Result = file_status(file_type::type_unknown);
 579     return error_code::success();
 580   }
 581   case FILE_TYPE_DISK:
 582     break;
 583   case FILE_TYPE_CHAR:
 584     Result = file_status(file_type::character_file);
 585     return error_code::success();
 586   case FILE_TYPE_PIPE:
 587     Result = file_status(file_type::fifo_file);
 588     return error_code::success();
 589   }
 590
 591   BY_HANDLE_FILE_INFORMATION Info;
 592   if (!::GetFileInformationByHandle(FileHandle, &Info))
 593     goto handle_status_error;
 594
 595   {
 596     file_type Type = (Info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 597                          ? file_type::directory_file
 598                          : file_type::regular_file;
 599     Result =
 600         file_status(Type, Info.ftLastWriteTime.dwHighDateTime,
 601                     Info.ftLastWriteTime.dwLowDateTime,
 602                     Info.dwVolumeSerialNumber, Info.nFileSizeHigh,
 603                     Info.nFileSizeLow, Info.nFileIndexHigh, Info.nFileIndexLow);
 604     return error_code::success();
 605   }
 606
 607 handle_status_error:
 608   error_code EC = windows_error(::GetLastError());
 609   if (EC == windows_error::file_not_found ||
 610       EC == windows_error::path_not_found)
 611     Result = file_status(file_type::file_not_found);
 612   else if (EC == windows_error::sharing_violation)
 613     Result = file_status(file_type::type_unknown);
 614   else {
 615     Result = file_status(file_type::status_error);
 616     return EC;
 617   }
 618   return error_code::success();
 619 }
 620
 621 error_code status(const Twine &path, file_status &result) {
 622   SmallString<128> path_storage;
 623   SmallVector<wchar_t, 128> path_utf16;
 624
 625   StringRef path8 = path.toStringRef(path_storage);
 626   if (isReservedName(path8)) {
 627     result = file_status(file_type::character_file);
 628     return error_code::success();
 629   }
 630
 631   if (error_code ec = UTF8ToUTF16(path8, path_utf16))
 632     return ec;
 633
 634   DWORD attr = ::GetFileAttributesW(path_utf16.begin());
 635   if (attr == INVALID_FILE_ATTRIBUTES)
 636     return getStatus(INVALID_HANDLE_VALUE, result);
 637
 638   // Handle reparse points.
 639   if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
 640     ScopedFileHandle h(
 641       ::CreateFileW(path_utf16.begin(),
 642                     0, // Attributes only.
 643                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 644                     NULL,
 645                     OPEN_EXISTING,
 646                     FILE_FLAG_BACKUP_SEMANTICS,
 647                     0));
 648     if (!h)
 649       return getStatus(INVALID_HANDLE_VALUE, result);
 650   }
 651
 652   ScopedFileHandle h(
 653       ::CreateFileW(path_utf16.begin(), 0, // Attributes only.
 654                     FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
 655                     NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0));
 656     if (!h)
 657       return getStatus(INVALID_HANDLE_VALUE, result);
 658
 659     return getStatus(h, result);
 660 }
 661
 662 error_code status(int FD, file_status &Result) {
 663   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 664   return getStatus(FileHandle, Result);
 665 }
 666
 667 error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
 668   ULARGE_INTEGER UI;
 669   UI.QuadPart = Time.toWin32Time();
 670   FILETIME FT;
 671   FT.dwLowDateTime = UI.LowPart;
 672   FT.dwHighDateTime = UI.HighPart;
 673   HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
 674   if (!SetFileTime(FileHandle, NULL, &FT, &FT))
 675     return windows_error(::GetLastError());
 676   return error_code::success();
 677 }
 678
 679 error_code get_magic(const Twine &path, uint32_t len,
 680                      SmallVectorImpl<char> &result) {
 681   SmallString<128> path_storage;
 682   SmallVector<wchar_t, 128> path_utf16;
 683   result.set_size(0);
 684
 685   // Convert path to UTF-16.
 686   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
 687                                   path_utf16))
 688     return ec;
 689
 690   // Open file.
 691   HANDLE file = ::CreateFileW(c_str(path_utf16),
 692                               GENERIC_READ,
 693                               FILE_SHARE_READ,
 694                               NULL,
 695                               OPEN_EXISTING,
 696                               FILE_ATTRIBUTE_READONLY,
 697                               NULL);
 698   if (file == INVALID_HANDLE_VALUE)
 699     return windows_error(::GetLastError());
 700
 701   // Allocate buffer.
 702   result.reserve(len);
 703
 704   // Get magic!
 705   DWORD bytes_read = 0;
 706   BOOL read_success = ::ReadFile(file, result.data(), len, &bytes_read, NULL);
 707   error_code ec = windows_error(::GetLastError());
 708   ::CloseHandle(file);
 709   if (!read_success || (bytes_read != len)) {
 710     // Set result size to the number of bytes read if it's valid.
 711     if (bytes_read <= len)
 712       result.set_size(bytes_read);
 713     // ERROR_HANDLE_EOF is mapped to errc::value_too_large.
 714     return ec;
 715   }
 716
 717   result.set_size(len);
 718   return error_code::success();
 719 }
 720
 721 error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
 722   FileDescriptor = FD;
 723   // Make sure that the requested size fits within SIZE_T.
 724   if (Size > std::numeric_limits<SIZE_T>::max()) {
 725     if (FileDescriptor) {
 726       if (CloseFD)
 727         _close(FileDescriptor);
 728     } else
 729       ::CloseHandle(FileHandle);
 730     return make_error_code(errc::invalid_argument);
 731   }
 732
 733   DWORD flprotect;
 734   switch (Mode) {
 735   case readonly:  flprotect = PAGE_READONLY; break;
 736   case readwrite: flprotect = PAGE_READWRITE; break;
 737   case priv:      flprotect = PAGE_WRITECOPY; break;
 738   }
 739
 740   FileMappingHandle = ::CreateFileMapping(FileHandle,
 741                                           0,
 742                                           flprotect,
 743                                           Size >> 32,
 744                                           Size & 0xffffffff,
 745                                           0);
 746   if (FileMappingHandle == NULL) {
 747     error_code ec = windows_error(GetLastError());
 748     if (FileDescriptor) {
 749       if (CloseFD)
 750         _close(FileDescriptor);
 751     } else
 752       ::CloseHandle(FileHandle);
 753     return ec;
 754   }
 755
 756   DWORD dwDesiredAccess;
 757   switch (Mode) {
 758   case readonly:  dwDesiredAccess = FILE_MAP_READ; break;
 759   case readwrite: dwDesiredAccess = FILE_MAP_WRITE; break;
 760   case priv:      dwDesiredAccess = FILE_MAP_COPY; break;
 761   }
 762   Mapping = ::MapViewOfFile(FileMappingHandle,
 763                             dwDesiredAccess,
 764                             Offset >> 32,
 765                             Offset & 0xffffffff,
 766                             Size);
 767   if (Mapping == NULL) {
 768     error_code ec = windows_error(GetLastError());
 769     ::CloseHandle(FileMappingHandle);
 770     if (FileDescriptor) {
 771       if (CloseFD)
 772         _close(FileDescriptor);
 773     } else
 774       ::CloseHandle(FileHandle);
 775     return ec;
 776   }
 777
 778   if (Size == 0) {
 779     MEMORY_BASIC_INFORMATION mbi;
 780     SIZE_T Result = VirtualQuery(Mapping, &mbi, sizeof(mbi));
 781     if (Result == 0) {
 782       error_code ec = windows_error(GetLastError());
 783       ::UnmapViewOfFile(Mapping);
 784       ::CloseHandle(FileMappingHandle);
 785       if (FileDescriptor) {
 786         if (CloseFD)
 787           _close(FileDescriptor);
 788       } else
 789         ::CloseHandle(FileHandle);
 790       return ec;
 791     }
 792     Size = mbi.RegionSize;
 793   }
 794
 795   // Close all the handles except for the view. It will keep the other handles
 796   // alive.
 797   ::CloseHandle(FileMappingHandle);
 798   if (FileDescriptor) {
 799     if (CloseFD)
 800       _close(FileDescriptor); // Also closes FileHandle.
 801   } else
 802     ::CloseHandle(FileHandle);
 803   return error_code::success();
 804 }
 805
 806 mapped_file_region::mapped_file_region(const Twine &path,
 807                                        mapmode mode,
 808                                        uint64_t length,
 809                                        uint64_t offset,
 810                                        error_code &ec)
 811   : Mode(mode)
 812   , Size(length)
 813   , Mapping()
 814   , FileDescriptor()
 815   , FileHandle(INVALID_HANDLE_VALUE)
 816   , FileMappingHandle() {
 817   SmallString<128> path_storage;
 818   SmallVector<wchar_t, 128> path_utf16;
 819
 820   // Convert path to UTF-16.
 821   if ((ec = UTF8ToUTF16(path.toStringRef(path_storage), path_utf16)))
 822     return;
 823
 824   // Get file handle for creating a file mapping.
 825   FileHandle = ::CreateFileW(c_str(path_utf16),
 826                              Mode == readonly ? GENERIC_READ
 827                                               : GENERIC_READ | GENERIC_WRITE,
 828                              Mode == readonly ? FILE_SHARE_READ
 829                                               : 0,
 830                              0,
 831                              Mode == readonly ? OPEN_EXISTING
 832                                               : OPEN_ALWAYS,
 833                              Mode == readonly ? FILE_ATTRIBUTE_READONLY
 834                                               : FILE_ATTRIBUTE_NORMAL,
 835                              0);
 836   if (FileHandle == INVALID_HANDLE_VALUE) {
 837     ec = windows_error(::GetLastError());
 838     return;
 839   }
 840
 841   FileDescriptor = 0;
 842   ec = init(FileDescriptor, true, offset);
 843   if (ec) {
 844     Mapping = FileMappingHandle = 0;
 845     FileHandle = INVALID_HANDLE_VALUE;
 846     FileDescriptor = 0;
 847   }
 848 }
 849
 850 mapped_file_region::mapped_file_region(int fd,
 851                                        bool closefd,
 852                                        mapmode mode,
 853                                        uint64_t length,
 854                                        uint64_t offset,
 855                                        error_code &ec)
 856   : Mode(mode)
 857   , Size(length)
 858   , Mapping()
 859   , FileDescriptor(fd)
 860   , FileHandle(INVALID_HANDLE_VALUE)
 861   , FileMappingHandle() {
 862   FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(fd));
 863   if (FileHandle == INVALID_HANDLE_VALUE) {
 864     if (closefd)
 865       _close(FileDescriptor);
 866     FileDescriptor = 0;
 867     ec = make_error_code(errc::bad_file_descriptor);
 868     return;
 869   }
 870
 871   ec = init(FileDescriptor, closefd, offset);
 872   if (ec) {
 873     Mapping = FileMappingHandle = 0;
 874     FileHandle = INVALID_HANDLE_VALUE;
 875     FileDescriptor = 0;
 876   }
 877 }
 878
 879 mapped_file_region::~mapped_file_region() {
 880   if (Mapping)
 881     ::UnmapViewOfFile(Mapping);
 882 }
 883
 884 #if LLVM_HAS_RVALUE_REFERENCES
 885 mapped_file_region::mapped_file_region(mapped_file_region &&other)
 886   : Mode(other.Mode)
 887   , Size(other.Size)
 888   , Mapping(other.Mapping)
 889   , FileDescriptor(other.FileDescriptor)
 890   , FileHandle(other.FileHandle)
 891   , FileMappingHandle(other.FileMappingHandle) {
 892   other.Mapping = other.FileMappingHandle = 0;
 893   other.FileHandle = INVALID_HANDLE_VALUE;
 894   other.FileDescriptor = 0;
 895 }
 896 #endif
 897
 898 mapped_file_region::mapmode mapped_file_region::flags() const {
 899   assert(Mapping && "Mapping failed but used anyway!");
 900   return Mode;
 901 }
 902
 903 uint64_t mapped_file_region::size() const {
 904   assert(Mapping && "Mapping failed but used anyway!");
 905   return Size;
 906 }
 907
 908 char *mapped_file_region::data() const {
 909   assert(Mode != readonly && "Cannot get non const data for readonly mapping!");
 910   assert(Mapping && "Mapping failed but used anyway!");
 911   return reinterpret_cast<char*>(Mapping);
 912 }
 913
 914 const char *mapped_file_region::const_data() const {
 915   assert(Mapping && "Mapping failed but used anyway!");
 916   return reinterpret_cast<const char*>(Mapping);
 917 }
 918
 919 int mapped_file_region::alignment() {
 920   SYSTEM_INFO SysInfo;
 921   ::GetSystemInfo(&SysInfo);
 922   return SysInfo.dwAllocationGranularity;
 923 }
 924
 925 error_code detail::directory_iterator_construct(detail::DirIterState &it,
 926                                                 StringRef path){
 927   SmallVector<wchar_t, 128> path_utf16;
 928
 929   if (error_code ec = UTF8ToUTF16(path,
 930                                   path_utf16))
 931     return ec;
 932
 933   // Convert path to the format that Windows is happy with.
 934   if (path_utf16.size() > 0 &&
 935       !is_separator(path_utf16[path.size() - 1]) &&
 936       path_utf16[path.size() - 1] != L':') {
 937     path_utf16.push_back(L'\\');
 938     path_utf16.push_back(L'*');
 939   } else {
 940     path_utf16.push_back(L'*');
 941   }
 942
 943   //  Get the first directory entry.
 944   WIN32_FIND_DATAW FirstFind;
 945   ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
 946   if (!FindHandle)
 947     return windows_error(::GetLastError());
 948
 949   size_t FilenameLen = ::wcslen(FirstFind.cFileName);
 950   while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
 951          (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
 952                               FirstFind.cFileName[1] == L'.'))
 953     if (!::FindNextFileW(FindHandle, &FirstFind)) {
 954       error_code ec = windows_error(::GetLastError());
 955       // Check for end.
 956       if (ec == windows_error::no_more_files)
 957         return detail::directory_iterator_destruct(it);
 958       return ec;
 959     } else
 960       FilenameLen = ::wcslen(FirstFind.cFileName);
 961
 962   // Construct the current directory entry.
 963   SmallString<128> directory_entry_name_utf8;
 964   if (error_code ec = UTF16ToUTF8(FirstFind.cFileName,
 965                                   ::wcslen(FirstFind.cFileName),
 966                                   directory_entry_name_utf8))
 967     return ec;
 968
 969   it.IterationHandle = intptr_t(FindHandle.take());
 970   SmallString<128> directory_entry_path(path);
 971   path::append(directory_entry_path, directory_entry_name_utf8.str());
 972   it.CurrentEntry = directory_entry(directory_entry_path.str());
 973
 974   return error_code::success();
 975 }
 976
 977 error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
 978   if (it.IterationHandle != 0)
 979     // Closes the handle if it's valid.
 980     ScopedFindHandle close(HANDLE(it.IterationHandle));
 981   it.IterationHandle = 0;
 982   it.CurrentEntry = directory_entry();
 983   return error_code::success();
 984 }
 985
 986 error_code detail::directory_iterator_increment(detail::DirIterState &it) {
 987   WIN32_FIND_DATAW FindData;
 988   if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
 989     error_code ec = windows_error(::GetLastError());
 990     // Check for end.
 991     if (ec == windows_error::no_more_files)
 992       return detail::directory_iterator_destruct(it);
 993     return ec;
 994   }
 995
 996   size_t FilenameLen = ::wcslen(FindData.cFileName);
 997   if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
 998       (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
 999                            FindData.cFileName[1] == L'.'))
1000     return directory_iterator_increment(it);
1001
1002   SmallString<128> directory_entry_path_utf8;
1003   if (error_code ec = UTF16ToUTF8(FindData.cFileName,
1004                                   ::wcslen(FindData.cFileName),
1005                                   directory_entry_path_utf8))
1006     return ec;
1007
1008   it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
1009   return error_code::success();
1010 }
1011
1012 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
1013                                             bool map_writable, void *&result) {
1014   assert(0 && "NOT IMPLEMENTED");
1015   return windows_error::invalid_function;
1016 }
1017
1018 error_code unmap_file_pages(void *base, size_t size) {
1019   assert(0 && "NOT IMPLEMENTED");
1020   return windows_error::invalid_function;
1021 }
1022
1023 error_code openFileForRead(const Twine &Name, int &ResultFD) {
1024   SmallString<128> PathStorage;
1025   SmallVector<wchar_t, 128> PathUTF16;
1026
1027   if (error_code EC = UTF8ToUTF16(Name.toStringRef(PathStorage),
1028                                   PathUTF16))
1029     return EC;
1030
1031   HANDLE H = ::CreateFileW(PathUTF16.begin(), GENERIC_READ,
1032                            FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1033                            OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
1034   if (H == INVALID_HANDLE_VALUE) {
1035     error_code EC = windows_error(::GetLastError());
1036     // Provide a better error message when trying to open directories.
1037     // This only runs if we failed to open the file, so there is probably
1038     // no performances issues.
1039     if (EC != windows_error::access_denied)
1040       return EC;
1041     if (is_directory(Name))
1042       return error_code(errc::is_a_directory, posix_category());
1043     return EC;
1044   }
1045
1046   int FD = ::_open_osfhandle(intptr_t(H), 0);
1047   if (FD == -1) {
1048     ::CloseHandle(H);
1049     return windows_error::invalid_handle;
1050   }
1051
1052   ResultFD = FD;
1053   return error_code::success();
1054 }
1055
1056 error_code openFileForWrite(const Twine &Name, int &ResultFD,
1057                             sys::fs::OpenFlags Flags, unsigned Mode) {
1058   // Verify that we don't have both "append" and "excl".
1059   assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
1060          "Cannot specify both 'excl' and 'append' file creation flags!");
1061
1062   SmallString<128> PathStorage;
1063   SmallVector<wchar_t, 128> PathUTF16;
1064
1065   if (error_code EC = UTF8ToUTF16(Name.toStringRef(PathStorage),
1066                                   PathUTF16))
1067     return EC;
1068
1069   DWORD CreationDisposition;
1070   if (Flags & F_Excl)
1071     CreationDisposition = CREATE_NEW;
1072   else if (Flags & F_Append)
1073     CreationDisposition = OPEN_ALWAYS;
1074   else
1075     CreationDisposition = CREATE_ALWAYS;
1076
1077   HANDLE H = ::CreateFileW(PathUTF16.begin(), GENERIC_WRITE,
1078                            FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1079                            CreationDisposition, FILE_ATTRIBUTE_NORMAL, NULL);
1080
1081   if (H == INVALID_HANDLE_VALUE) {
1082     error_code EC = windows_error(::GetLastError());
1083     // Provide a better error message when trying to open directories.
1084     // This only runs if we failed to open the file, so there is probably
1085     // no performances issues.
1086     if (EC != windows_error::access_denied)
1087       return EC;
1088     if (is_directory(Name))
1089       return error_code(errc::is_a_directory, posix_category());
1090     return EC;
1091   }
1092
1093   int OpenFlags = 0;
1094   if (Flags & F_Append)
1095     OpenFlags |= _O_APPEND;
1096
1097   if (!(Flags & F_Binary))
1098     OpenFlags |= _O_TEXT;
1099
1100   int FD = ::_open_osfhandle(intptr_t(H), OpenFlags);
1101   if (FD == -1) {
1102     ::CloseHandle(H);
1103     return windows_error::invalid_handle;
1104   }
1105
1106   ResultFD = FD;
1107   return error_code::success();
1108 }
1109
1110 } // end namespace fs
1111 } // end namespace sys
1112 } // end namespace llvm