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;
272 if (error_code ec = status(path, st))
275 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
279 if (st.type() == file_type::directory_file) {
280 if (!::RemoveDirectoryW(c_str(path_utf16))) {
281 error_code ec = windows_error(::GetLastError());
282 if (ec != windows_error::file_not_found)
288 if (!::DeleteFileW(c_str(path_utf16))) {
289 error_code ec = windows_error(::GetLastError());
290 if (ec != windows_error::file_not_found)
300 error_code rename(const Twine &from, const Twine &to) {
302 SmallString<128> from_storage;
303 SmallString<128> to_storage;
304 StringRef f = from.toStringRef(from_storage);
305 StringRef t = to.toStringRef(to_storage);
307 // Convert to utf-16.
308 SmallVector<wchar_t, 128> wide_from;
309 SmallVector<wchar_t, 128> wide_to;
310 if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
311 if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
313 if (!::MoveFileExW(wide_from.begin(), wide_to.begin(),
314 MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
315 return windows_error(::GetLastError());
320 error_code resize_file(const Twine &path, uint64_t size) {
321 SmallString<128> path_storage;
322 SmallVector<wchar_t, 128> path_utf16;
324 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
328 int fd = ::_wopen(path_utf16.begin(), O_BINARY, S_IREAD | S_IWRITE);
330 return error_code(errno, generic_category());
331 #ifdef HAVE__CHSIZE_S
332 errno_t error = ::_chsize_s(fd, size);
334 errno_t error = ::_chsize(fd, size);
337 return error_code(error, generic_category());
340 error_code exists(const Twine &path, bool &result) {
341 SmallString<128> path_storage;
342 SmallVector<wchar_t, 128> path_utf16;
344 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
348 DWORD attributes = ::GetFileAttributesW(path_utf16.begin());
350 if (attributes == INVALID_FILE_ATTRIBUTES) {
351 // See if the file didn't actually exist.
352 error_code ec = make_error_code(windows_error(::GetLastError()));
353 if (ec != windows_error::file_not_found &&
354 ec != windows_error::path_not_found)
362 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
364 SmallString<128> a_storage;
365 SmallString<128> b_storage;
366 StringRef a = A.toStringRef(a_storage);
367 StringRef b = B.toStringRef(b_storage);
369 // Convert to utf-16.
370 SmallVector<wchar_t, 128> wide_a;
371 SmallVector<wchar_t, 128> wide_b;
372 if (error_code ec = UTF8ToUTF16(a, wide_a)) return ec;
373 if (error_code ec = UTF8ToUTF16(b, wide_b)) return ec;
376 ::CreateFileW(wide_b.begin(),
378 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
381 FILE_FLAG_BACKUP_SEMANTICS,
385 ::CreateFileW(wide_a.begin(),
387 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
390 FILE_FLAG_BACKUP_SEMANTICS,
393 // If both handles are invalid, it's an error.
394 if (HandleA == INVALID_HANDLE_VALUE &&
395 HandleB == INVALID_HANDLE_VALUE)
396 return windows_error(::GetLastError());
398 // If only one is invalid, it's false.
399 if (HandleA == INVALID_HANDLE_VALUE &&
400 HandleB == INVALID_HANDLE_VALUE) {
405 // Get file information.
406 BY_HANDLE_FILE_INFORMATION InfoA, InfoB;
407 if (!::GetFileInformationByHandle(HandleA, &InfoA))
408 return windows_error(::GetLastError());
409 if (!::GetFileInformationByHandle(HandleB, &InfoB))
410 return windows_error(::GetLastError());
412 // See if it's all the same.
414 InfoA.dwVolumeSerialNumber == InfoB.dwVolumeSerialNumber &&
415 InfoA.nFileIndexHigh == InfoB.nFileIndexHigh &&
416 InfoA.nFileIndexLow == InfoB.nFileIndexLow &&
417 InfoA.nFileSizeHigh == InfoB.nFileSizeHigh &&
418 InfoA.nFileSizeLow == InfoB.nFileSizeLow &&
419 InfoA.ftLastWriteTime.dwLowDateTime ==
420 InfoB.ftLastWriteTime.dwLowDateTime &&
421 InfoA.ftLastWriteTime.dwHighDateTime ==
422 InfoB.ftLastWriteTime.dwHighDateTime;
427 error_code file_size(const Twine &path, uint64_t &result) {
428 SmallString<128> path_storage;
429 SmallVector<wchar_t, 128> path_utf16;
431 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
435 WIN32_FILE_ATTRIBUTE_DATA FileData;
436 if (!::GetFileAttributesExW(path_utf16.begin(),
437 ::GetFileExInfoStandard,
439 return windows_error(::GetLastError());
442 (uint64_t(FileData.nFileSizeHigh) << (sizeof(FileData.nFileSizeLow) * 8))
443 + FileData.nFileSizeLow;
448 error_code status(const Twine &path, file_status &result) {
449 SmallString<128> path_storage;
450 SmallVector<wchar_t, 128> path_utf16;
452 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
456 DWORD attr = ::GetFileAttributesW(path_utf16.begin());
457 if (attr == INVALID_FILE_ATTRIBUTES)
458 goto handle_status_error;
460 // Handle reparse points.
461 if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
463 ::CreateFileW(path_utf16.begin(),
464 0, // Attributes only.
465 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
468 FILE_FLAG_BACKUP_SEMANTICS,
470 if (h == INVALID_HANDLE_VALUE)
471 goto handle_status_error;
474 if (attr & FILE_ATTRIBUTE_DIRECTORY)
475 result = file_status(file_type::directory_file);
477 result = file_status(file_type::regular_file);
482 error_code ec = windows_error(::GetLastError());
483 if (ec == windows_error::file_not_found ||
484 ec == windows_error::path_not_found)
485 result = file_status(file_type::file_not_found);
486 else if (ec == windows_error::sharing_violation)
487 result = file_status(file_type::type_unknown);
489 result = file_status(file_type::status_error);
496 error_code unique_file(const Twine &model, int &result_fd,
497 SmallVectorImpl<char> &result_path) {
498 // Use result_path as temp storage.
499 result_path.set_size(0);
500 StringRef m = model.toStringRef(result_path);
502 SmallVector<wchar_t, 128> model_utf16;
503 if (error_code ec = UTF8ToUTF16(m, model_utf16)) return ec;
505 // Make model absolute by prepending a temp directory if it's not already.
506 bool absolute = path::is_absolute(m);
509 SmallVector<wchar_t, 64> temp_dir;
510 if (error_code ec = TempDir(temp_dir)) return ec;
511 // Handle c: by removing it.
512 if (model_utf16.size() > 2 && model_utf16[1] == L':') {
513 model_utf16.erase(model_utf16.begin(), model_utf16.begin() + 2);
515 model_utf16.insert(model_utf16.begin(), temp_dir.begin(), temp_dir.end());
518 // Replace '%' with random chars. From here on, DO NOT modify model. It may be
519 // needed if the randomly chosen path already exists.
520 SmallVector<wchar_t, 128> random_path_utf16;
522 // Get a Crypto Provider for CryptGenRandom.
524 if (!::CryptAcquireContextW(&HCPC,
528 CRYPT_VERIFYCONTEXT))
529 return windows_error(::GetLastError());
530 ScopedCryptContext CryptoProvider(HCPC);
533 random_path_utf16.set_size(0);
534 for (SmallVectorImpl<wchar_t>::const_iterator i = model_utf16.begin(),
535 e = model_utf16.end();
539 if (!::CryptGenRandom(CryptoProvider, 1, &val))
540 return windows_error(::GetLastError());
541 random_path_utf16.push_back("0123456789abcdef"[val & 15]);
544 random_path_utf16.push_back(*i);
546 // Make random_path_utf16 null terminated.
547 random_path_utf16.push_back(0);
548 random_path_utf16.pop_back();
550 // Try to create + open the path.
552 HANDLE TempFileHandle = ::CreateFileW(random_path_utf16.begin(),
553 GENERIC_READ | GENERIC_WRITE,
556 // Return ERROR_FILE_EXISTS if the file
559 FILE_ATTRIBUTE_TEMPORARY,
561 if (TempFileHandle == INVALID_HANDLE_VALUE) {
562 // If the file existed, try again, otherwise, error.
563 error_code ec = windows_error(::GetLastError());
564 if (ec == windows_error::file_exists)
565 goto retry_random_path;
566 // Check for non-existing parent directories.
567 if (ec == windows_error::path_not_found) {
568 // Create the directories using result_path as temp storage.
569 if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
570 random_path_utf16.size(), result_path))
572 StringRef p(result_path.begin(), result_path.size());
573 SmallString<64> dir_to_create;
574 for (path::const_iterator i = path::begin(p),
575 e = --path::end(p); i != e; ++i) {
576 path::append(dir_to_create, *i);
578 if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
580 // If c: doesn't exist, bail.
581 if (i->endswith(":"))
584 SmallVector<wchar_t, 64> dir_to_create_utf16;
585 if (error_code ec = UTF8ToUTF16(dir_to_create, dir_to_create_utf16))
588 // Create the directory.
589 if (!::CreateDirectoryW(dir_to_create_utf16.begin(), NULL))
590 return windows_error(::GetLastError());
593 goto retry_create_file;
598 // Set result_path to the utf-8 representation of the path.
599 if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
600 random_path_utf16.size(), result_path)) {
601 ::CloseHandle(TempFileHandle);
602 ::DeleteFileW(random_path_utf16.begin());
606 // Convert the Windows API file handle into a C-runtime handle.
607 int fd = ::_open_osfhandle(intptr_t(TempFileHandle), 0);
609 ::CloseHandle(TempFileHandle);
610 ::DeleteFileW(random_path_utf16.begin());
611 // MSDN doesn't say anything about _open_osfhandle setting errno or
612 // GetLastError(), so just return invalid_handle.
613 return windows_error::invalid_handle;
620 error_code get_magic(const Twine &path, uint32_t len,
621 SmallVectorImpl<char> &result) {
622 SmallString<128> path_storage;
623 SmallVector<wchar_t, 128> path_utf16;
626 // Convert path to UTF-16.
627 if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
632 HANDLE file = ::CreateFileW(c_str(path_utf16),
637 FILE_ATTRIBUTE_READONLY,
639 if (file == INVALID_HANDLE_VALUE)
640 return windows_error(::GetLastError());
646 DWORD bytes_read = 0;
647 BOOL read_success = ::ReadFile(file, result.data(), len, &bytes_read, NULL);
648 error_code ec = windows_error(::GetLastError());
650 if (!read_success || (bytes_read != len)) {
651 // Set result size to the number of bytes read if it's valid.
652 if (bytes_read <= len)
653 result.set_size(bytes_read);
654 // ERROR_HANDLE_EOF is mapped to errc::value_too_large.
658 result.set_size(len);
662 error_code directory_iterator_construct(directory_iterator &it, StringRef path){
663 SmallVector<wchar_t, 128> path_utf16;
665 if (error_code ec = UTF8ToUTF16(path,
669 // Convert path to the format that Windows is happy with.
670 if (path_utf16.size() > 0 &&
671 !is_separator(path_utf16[path.size() - 1]) &&
672 path_utf16[path.size() - 1] != L':') {
673 path_utf16.push_back(L'\\');
674 path_utf16.push_back(L'*');
676 path_utf16.push_back(L'*');
679 // Get the first directory entry.
680 WIN32_FIND_DATAW FirstFind;
681 ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
683 return windows_error(::GetLastError());
685 size_t FilenameLen = ::wcslen(FirstFind.cFileName);
686 while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
687 (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
688 FirstFind.cFileName[1] == L'.'))
689 if (!::FindNextFileW(FindHandle, &FirstFind)) {
690 error_code ec = windows_error(::GetLastError());
692 if (ec == windows_error::no_more_files)
693 return directory_iterator_destruct(it);
696 FilenameLen = ::wcslen(FirstFind.cFileName);
698 // Construct the current directory entry.
699 SmallString<128> directory_entry_name_utf8;
700 if (error_code ec = UTF16ToUTF8(FirstFind.cFileName,
701 ::wcslen(FirstFind.cFileName),
702 directory_entry_name_utf8))
705 it.IterationHandle = intptr_t(FindHandle.take());
706 SmallString<128> directory_entry_path(path);
707 path::append(directory_entry_path, directory_entry_name_utf8.str());
708 it.CurrentEntry = directory_entry(directory_entry_path.str());
713 error_code directory_iterator_destruct(directory_iterator& it) {
714 if (it.IterationHandle != 0)
715 // Closes the handle if it's valid.
716 ScopedFindHandle close(HANDLE(it.IterationHandle));
717 it.IterationHandle = 0;
718 it.CurrentEntry = directory_entry();
722 error_code directory_iterator_increment(directory_iterator& it) {
723 WIN32_FIND_DATAW FindData;
724 if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
725 error_code ec = windows_error(::GetLastError());
727 if (ec == windows_error::no_more_files)
728 return directory_iterator_destruct(it);
732 size_t FilenameLen = ::wcslen(FindData.cFileName);
733 if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
734 (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
735 FindData.cFileName[1] == L'.'))
736 return directory_iterator_increment(it);
738 SmallString<128> directory_entry_path_utf8;
739 if (error_code ec = UTF16ToUTF8(FindData.cFileName,
740 ::wcslen(FindData.cFileName),
741 directory_entry_path_utf8))
744 it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
748 } // end namespace fs
749 } // end namespace sys
750 } // end namespace llvm