1 //===- llvm/Support/Windows/PathV2.inc - Windows Path Impl ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Windows specific implementation of the PathV2 API.
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic Windows code that
16 //=== is guaranteed to work on *all* Windows variants.
17 //===----------------------------------------------------------------------===//
24 #include <sys/types.h>
26 // MinGW doesn't define this.
27 #ifndef _ERRNO_T_DEFINED
28 #define _ERRNO_T_DEFINED
35 typedef BOOLEAN (WINAPI *PtrCreateSymbolicLinkW)(
36 /*__in*/ LPCWSTR lpSymlinkFileName,
37 /*__in*/ LPCWSTR lpTargetFileName,
38 /*__in*/ DWORD dwFlags);
40 PtrCreateSymbolicLinkW create_symbolic_link_api = PtrCreateSymbolicLinkW(
41 ::GetProcAddress(::GetModuleHandleA("kernel32.dll"),
42 "CreateSymbolicLinkW"));
44 error_code UTF8ToUTF16(StringRef utf8, SmallVectorImpl<wchar_t> &utf16) {
45 int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS,
46 utf8.begin(), utf8.size(),
50 return windows_error(::GetLastError());
52 utf16.reserve(len + 1);
55 len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS,
56 utf8.begin(), utf8.size(),
57 utf16.begin(), utf16.size());
60 return windows_error(::GetLastError());
62 // Make utf16 null terminated.
69 error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
70 SmallVectorImpl<char> &utf8) {
72 int len = ::WideCharToMultiByte(CP_UTF8, 0,
78 return windows_error(::GetLastError());
83 // Now do the actual conversion.
84 len = ::WideCharToMultiByte(CP_UTF8, 0,
86 utf8.data(), utf8.size(),
90 return windows_error(::GetLastError());
92 // Make utf8 null terminated.
99 error_code TempDir(SmallVectorImpl<wchar_t> &result) {
101 DWORD len = ::GetTempPathW(result.capacity(), result.begin());
104 return windows_error(::GetLastError());
106 if (len > result.capacity()) {
111 result.set_size(len);
115 // Forwarder for ScopedHandle.
116 BOOL WINAPI CryptReleaseContext(HCRYPTPROV Provider) {
117 return ::CryptReleaseContext(Provider, 0);
120 typedef ScopedHandle<HCRYPTPROV, uintptr_t(-1),
121 BOOL (WINAPI*)(HCRYPTPROV), CryptReleaseContext>
123 bool is_separator(const wchar_t value) {
138 error_code current_path(SmallVectorImpl<char> &result) {
139 SmallVector<wchar_t, 128> cur_path;
140 cur_path.reserve(128);
142 DWORD len = ::GetCurrentDirectoryW(cur_path.capacity(), cur_path.data());
144 // A zero return value indicates a failure other than insufficient space.
146 return windows_error(::GetLastError());
148 // If there's insufficient space, the len returned is larger than the len
150 if (len > cur_path.capacity()) {
151 cur_path.reserve(len);
155 cur_path.set_size(len);
156 // cur_path now holds the current directory in utf-16. Convert to utf-8.
158 // Find out how much space we need. Sadly, this function doesn't return the
159 // size needed unless you tell it the result size is 0, which means you
160 // _always_ have to call it twice.
161 len = ::WideCharToMultiByte(CP_UTF8, 0,
162 cur_path.data(), cur_path.size(),
167 return make_error_code(windows_error(::GetLastError()));
170 result.set_size(len);
171 // Now do the actual conversion.
172 len = ::WideCharToMultiByte(CP_UTF8, 0,
173 cur_path.data(), cur_path.size(),
174 result.data(), result.size(),
177 return windows_error(::GetLastError());
182 error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
184 SmallString<128> from_storage;
185 SmallString<128> to_storage;
186 StringRef f = from.toStringRef(from_storage);
187 StringRef t = to.toStringRef(to_storage);
189 // Convert to utf-16.
190 SmallVector<wchar_t, 128> wide_from;
191 SmallVector<wchar_t, 128> wide_to;
192 if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
193 if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
196 BOOL res = ::CopyFileW(wide_from.begin(), wide_to.begin(),
197 copt != copy_option::overwrite_if_exists);
200 return windows_error(::GetLastError());
205 error_code create_directory(const Twine &path, bool &existed) {
206 SmallString<128> path_storage;
207 SmallVector<wchar_t, 128> path_utf16;
209 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
213 if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
214 error_code ec = windows_error(::GetLastError());
215 if (ec == windows_error::already_exists)
225 error_code create_hard_link(const Twine &to, const Twine &from) {
227 SmallString<128> from_storage;
228 SmallString<128> to_storage;
229 StringRef f = from.toStringRef(from_storage);
230 StringRef t = to.toStringRef(to_storage);
232 // Convert to utf-16.
233 SmallVector<wchar_t, 128> wide_from;
234 SmallVector<wchar_t, 128> wide_to;
235 if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
236 if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
238 if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
239 return windows_error(::GetLastError());
244 error_code create_symlink(const Twine &to, const Twine &from) {
245 // Only do it if the function is available at runtime.
246 if (!create_symbolic_link_api)
247 return make_error_code(errc::function_not_supported);
250 SmallString<128> from_storage;
251 SmallString<128> to_storage;
252 StringRef f = from.toStringRef(from_storage);
253 StringRef t = to.toStringRef(to_storage);
255 // Convert to utf-16.
256 SmallVector<wchar_t, 128> wide_from;
257 SmallVector<wchar_t, 128> wide_to;
258 if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
259 if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
261 if (!create_symbolic_link_api(wide_from.begin(), wide_to.begin(), 0))
262 return windows_error(::GetLastError());
267 error_code remove(const Twine &path, bool &existed) {
268 SmallString<128> path_storage;
269 SmallVector<wchar_t, 128> path_utf16;
271 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
275 if (!::DeleteFileW(path_utf16.begin())) {
276 error_code ec = windows_error(::GetLastError());
277 if (ec != windows_error::file_not_found)
286 error_code rename(const Twine &from, const Twine &to) {
288 SmallString<128> from_storage;
289 SmallString<128> to_storage;
290 StringRef f = from.toStringRef(from_storage);
291 StringRef t = to.toStringRef(to_storage);
293 // Convert to utf-16.
294 SmallVector<wchar_t, 128> wide_from;
295 SmallVector<wchar_t, 128> wide_to;
296 if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
297 if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
299 if (!::MoveFileW(wide_from.begin(), wide_to.begin()))
300 return windows_error(::GetLastError());
305 error_code resize_file(const Twine &path, uint64_t size) {
306 SmallString<128> path_storage;
307 SmallVector<wchar_t, 128> path_utf16;
309 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
313 int fd = ::_wopen(path_utf16.begin(), O_BINARY, S_IREAD | S_IWRITE);
315 return error_code(errno, generic_category());
316 #ifdef HAVE__CHSIZE_S
317 errno_t error = ::_chsize_s(fd, size);
319 errno_t error = ::_chsize(fd, size);
322 return error_code(error, generic_category());
325 error_code exists(const Twine &path, bool &result) {
326 SmallString<128> path_storage;
327 SmallVector<wchar_t, 128> path_utf16;
329 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
333 DWORD attributes = ::GetFileAttributesW(path_utf16.begin());
335 if (attributes == INVALID_FILE_ATTRIBUTES) {
336 // See if the file didn't actually exist.
337 error_code ec = make_error_code(windows_error(::GetLastError()));
338 if (ec != windows_error::file_not_found &&
339 ec != windows_error::path_not_found)
347 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
349 SmallString<128> a_storage;
350 SmallString<128> b_storage;
351 StringRef a = A.toStringRef(a_storage);
352 StringRef b = B.toStringRef(b_storage);
354 // Convert to utf-16.
355 SmallVector<wchar_t, 128> wide_a;
356 SmallVector<wchar_t, 128> wide_b;
357 if (error_code ec = UTF8ToUTF16(a, wide_a)) return ec;
358 if (error_code ec = UTF8ToUTF16(b, wide_b)) return ec;
361 ::CreateFileW(wide_b.begin(),
363 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
366 FILE_FLAG_BACKUP_SEMANTICS,
370 ::CreateFileW(wide_a.begin(),
372 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
375 FILE_FLAG_BACKUP_SEMANTICS,
378 // If both handles are invalid, it's an error.
379 if (HandleA == INVALID_HANDLE_VALUE &&
380 HandleB == INVALID_HANDLE_VALUE)
381 return windows_error(::GetLastError());
383 // If only one is invalid, it's false.
384 if (HandleA == INVALID_HANDLE_VALUE &&
385 HandleB == INVALID_HANDLE_VALUE) {
390 // Get file information.
391 BY_HANDLE_FILE_INFORMATION InfoA, InfoB;
392 if (!::GetFileInformationByHandle(HandleA, &InfoA))
393 return windows_error(::GetLastError());
394 if (!::GetFileInformationByHandle(HandleB, &InfoB))
395 return windows_error(::GetLastError());
397 // See if it's all the same.
399 InfoA.dwVolumeSerialNumber == InfoB.dwVolumeSerialNumber &&
400 InfoA.nFileIndexHigh == InfoB.nFileIndexHigh &&
401 InfoA.nFileIndexLow == InfoB.nFileIndexLow &&
402 InfoA.nFileSizeHigh == InfoB.nFileSizeHigh &&
403 InfoA.nFileSizeLow == InfoB.nFileSizeLow &&
404 InfoA.ftLastWriteTime.dwLowDateTime ==
405 InfoB.ftLastWriteTime.dwLowDateTime &&
406 InfoA.ftLastWriteTime.dwHighDateTime ==
407 InfoB.ftLastWriteTime.dwHighDateTime;
412 error_code file_size(const Twine &path, uint64_t &result) {
413 SmallString<128> path_storage;
414 SmallVector<wchar_t, 128> path_utf16;
416 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
420 WIN32_FILE_ATTRIBUTE_DATA FileData;
421 if (!::GetFileAttributesExW(path_utf16.begin(),
422 ::GetFileExInfoStandard,
424 return windows_error(::GetLastError());
427 (uint64_t(FileData.nFileSizeHigh) << (sizeof(FileData.nFileSizeLow) * 8))
428 + FileData.nFileSizeLow;
433 error_code status(const Twine &path, file_status &result) {
434 SmallString<128> path_storage;
435 SmallVector<wchar_t, 128> path_utf16;
437 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
441 DWORD attr = ::GetFileAttributesW(path_utf16.begin());
442 if (attr == INVALID_FILE_ATTRIBUTES)
443 goto handle_status_error;
445 // Handle reparse points.
446 if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
448 ::CreateFileW(path_utf16.begin(),
449 0, // Attributes only.
450 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
453 FILE_FLAG_BACKUP_SEMANTICS,
455 if (h == INVALID_HANDLE_VALUE)
456 goto handle_status_error;
459 if (attr & FILE_ATTRIBUTE_DIRECTORY)
460 result = file_status(file_type::directory_file);
462 result = file_status(file_type::regular_file);
467 error_code ec = windows_error(::GetLastError());
468 if (ec == windows_error::file_not_found ||
469 ec == windows_error::path_not_found)
470 result = file_status(file_type::file_not_found);
471 else if (ec == windows_error::sharing_violation)
472 result = file_status(file_type::type_unknown);
474 result = file_status(file_type::status_error);
481 error_code unique_file(const Twine &model, int &result_fd,
482 SmallVectorImpl<char> &result_path) {
483 // Use result_path as temp storage.
484 result_path.set_size(0);
485 StringRef m = model.toStringRef(result_path);
487 SmallVector<wchar_t, 128> model_utf16;
488 if (error_code ec = UTF8ToUTF16(m, model_utf16)) return ec;
490 // Make model absolute by prepending a temp directory if it's not already.
491 bool absolute = path::is_absolute(m);
494 SmallVector<wchar_t, 64> temp_dir;
495 if (error_code ec = TempDir(temp_dir)) return ec;
496 // Handle c: by removing it.
497 if (model_utf16.size() > 2 && model_utf16[1] == L':') {
498 model_utf16.erase(model_utf16.begin(), model_utf16.begin() + 2);
500 model_utf16.insert(model_utf16.begin(), temp_dir.begin(), temp_dir.end());
503 // Replace '%' with random chars. From here on, DO NOT modify model. It may be
504 // needed if the randomly chosen path already exists.
505 SmallVector<wchar_t, 128> random_path_utf16;
507 // Get a Crypto Provider for CryptGenRandom.
509 if (!::CryptAcquireContextW(&HCPC,
514 return windows_error(::GetLastError());
515 ScopedCryptContext CryptoProvider(HCPC);
518 random_path_utf16.set_size(0);
519 for (SmallVectorImpl<wchar_t>::const_iterator i = model_utf16.begin(),
520 e = model_utf16.end();
524 if (!::CryptGenRandom(CryptoProvider, 1, &val))
525 return windows_error(::GetLastError());
526 random_path_utf16.push_back("0123456789abcdef"[val & 15]);
529 random_path_utf16.push_back(*i);
531 // Make random_path_utf16 null terminated.
532 random_path_utf16.push_back(0);
533 random_path_utf16.pop_back();
535 // Try to create + open the path.
537 HANDLE TempFileHandle = ::CreateFileW(random_path_utf16.begin(),
538 GENERIC_READ | GENERIC_WRITE,
541 // Return ERROR_FILE_EXISTS if the file
544 FILE_ATTRIBUTE_TEMPORARY,
546 if (TempFileHandle == INVALID_HANDLE_VALUE) {
547 // If the file existed, try again, otherwise, error.
548 error_code ec = windows_error(::GetLastError());
549 if (ec == windows_error::file_exists)
550 goto retry_random_path;
551 // Check for non-existing parent directories.
552 if (ec == windows_error::path_not_found) {
553 // Create the directories using result_path as temp storage.
554 if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
555 random_path_utf16.size(), result_path))
557 StringRef p(result_path.begin(), result_path.size());
558 SmallString<64> dir_to_create;
559 for (path::const_iterator i = path::begin(p),
560 e = --path::end(p); i != e; ++i) {
561 path::append(dir_to_create, *i);
563 if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
565 // If c: doesn't exist, bail.
566 if (i->endswith(":"))
569 SmallVector<wchar_t, 64> dir_to_create_utf16;
570 if (error_code ec = UTF8ToUTF16(dir_to_create, dir_to_create_utf16))
573 // Create the directory.
574 if (!::CreateDirectoryW(dir_to_create_utf16.begin(), NULL))
575 return windows_error(::GetLastError());
578 goto retry_create_file;
583 // Set result_path to the utf-8 representation of the path.
584 if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
585 random_path_utf16.size(), result_path)) {
586 ::CloseHandle(TempFileHandle);
587 ::DeleteFileW(random_path_utf16.begin());
591 // Convert the Windows API file handle into a C-runtime handle.
592 int fd = ::_open_osfhandle(intptr_t(TempFileHandle), 0);
594 ::CloseHandle(TempFileHandle);
595 ::DeleteFileW(random_path_utf16.begin());
596 // MSDN doesn't say anything about _open_osfhandle setting errno or
597 // GetLastError(), so just return invalid_handle.
598 return windows_error::invalid_handle;
605 error_code directory_iterator_construct(directory_iterator &it, StringRef path){
606 SmallVector<wchar_t, 128> path_utf16;
608 if (error_code ec = UTF8ToUTF16(path,
612 // Convert path to the format that Windows is happy with.
613 if (path_utf16.size() > 0 &&
614 !is_separator(path_utf16[path.size() - 1]) &&
615 path_utf16[path.size() - 1] != L':') {
616 path_utf16.push_back(L'\\');
617 path_utf16.push_back(L'*');
619 path_utf16.push_back(L'*');
622 // Get the first directory entry.
623 WIN32_FIND_DATAW FirstFind;
624 ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
626 return windows_error(::GetLastError());
628 // Construct the current directory entry.
629 SmallString<128> directory_entry_path_utf8;
630 if (error_code ec = UTF16ToUTF8(FirstFind.cFileName,
631 ::wcslen(FirstFind.cFileName),
632 directory_entry_path_utf8))
635 it.IterationHandle = intptr_t(FindHandle.take());
636 it.CurrentEntry = directory_entry(path);
637 it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
642 error_code directory_iterator_destruct(directory_iterator& it) {
643 if (it.IterationHandle != 0)
644 // Closes the handle if it's valid.
645 ScopedFindHandle close(HANDLE(it.IterationHandle));
646 it.IterationHandle = 0;
647 it.CurrentEntry = directory_entry();
651 error_code directory_iterator_increment(directory_iterator& it) {
652 WIN32_FIND_DATAW FindData;
653 if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
654 error_code ec = windows_error(::GetLastError());
656 if (ec == windows_error::no_more_files)
657 return directory_iterator_destruct(it);
661 SmallString<128> directory_entry_path_utf8;
662 if (error_code ec = UTF16ToUTF8(FindData.cFileName,
663 ::wcslen(FindData.cFileName),
664 directory_entry_path_utf8))
667 it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
671 } // end namespace fs
672 } // end namespace sys
673 } // end namespace llvm