1 //===- llvm/Support/Windows/Path.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 Path API.
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
15 //=== WARNING: Implementation here must contain only generic Windows code that
16 //=== is guaranteed to work on *all* Windows variants.
17 //===----------------------------------------------------------------------===//
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Support/WindowsError.h"
24 #include <sys/types.h>
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"
33 // MinGW doesn't define this.
34 #ifndef _ERRNO_T_DEFINED
35 #define _ERRNO_T_DEFINED
40 # pragma comment(lib, "advapi32.lib") // This provides CryptAcquireContextW.
45 using llvm::sys::windows::UTF8ToUTF16;
46 using llvm::sys::windows::UTF16ToUTF8;
47 using llvm::sys::path::widenPath;
49 static std::error_code windows_error(DWORD E) {
50 return mapWindowsError(E);
53 static bool is_separator(const wchar_t value) {
67 // Convert a UTF-8 path to UTF-16. Also, if the absolute equivalent of the
68 // path is longer than CreateDirectory can tolerate, make it absolute and
69 // prefixed by '\\?\'.
70 std::error_code widenPath(const Twine &Path8,
71 SmallVectorImpl<wchar_t> &Path16) {
72 const size_t MaxDirLen = MAX_PATH - 12; // Must leave room for 8.3 filename.
74 // Several operations would convert Path8 to SmallString; more efficient to
75 // do it once up front.
76 SmallString<128> Path8Str;
77 Path8.toVector(Path8Str);
79 // If we made this path absolute, how much longer would it get?
81 if (llvm::sys::path::is_absolute(Twine(Path8Str)))
82 CurPathLen = 0; // No contribution from current_path needed.
84 CurPathLen = ::GetCurrentDirectoryW(0, NULL);
86 return windows_error(::GetLastError());
89 // Would the absolute path be longer than our limit?
90 if ((Path8Str.size() + CurPathLen) >= MaxDirLen &&
91 !Path8Str.startswith("\\\\?\\")) {
92 SmallString<2*MAX_PATH> FullPath("\\\\?\\");
94 SmallString<80> CurPath;
95 if (std::error_code EC = llvm::sys::fs::current_path(CurPath))
97 FullPath.append(CurPath);
99 // Traverse the requested path, canonicalizing . and .. as we go (because
100 // the \\?\ prefix is documented to treat them as real components).
101 // The iterators don't report separators and append() always attaches
102 // preferred_separator so we don't need to call native() on the result.
103 for (llvm::sys::path::const_iterator I = llvm::sys::path::begin(Path8Str),
104 E = llvm::sys::path::end(Path8Str);
106 if (I->size() == 1 && *I == ".")
108 if (I->size() == 2 && *I == "..")
109 llvm::sys::path::remove_filename(FullPath);
111 llvm::sys::path::append(FullPath, *I);
113 return UTF8ToUTF16(FullPath, Path16);
116 // Just use the caller's original path.
117 return UTF8ToUTF16(Path8Str, Path16);
119 } // end namespace path
123 std::string getMainExecutable(const char *argv0, void *MainExecAddr) {
124 SmallVector<wchar_t, MAX_PATH> PathName;
125 DWORD Size = ::GetModuleFileNameW(NULL, PathName.data(), PathName.capacity());
127 // A zero return value indicates a failure other than insufficient space.
131 // Insufficient space is determined by a return value equal to the size of
132 // the buffer passed in.
133 if (Size == PathName.capacity())
136 // On success, GetModuleFileNameW returns the number of characters written to
137 // the buffer not including the NULL terminator.
138 PathName.set_size(Size);
140 // Convert the result from UTF-16 to UTF-8.
141 SmallVector<char, MAX_PATH> PathNameUTF8;
142 if (UTF16ToUTF8(PathName.data(), PathName.size(), PathNameUTF8))
145 return std::string(PathNameUTF8.data());
148 UniqueID file_status::getUniqueID() const {
149 // The file is uniquely identified by the volume serial number along
150 // with the 64-bit file identifier.
151 uint64_t FileID = (static_cast<uint64_t>(FileIndexHigh) << 32ULL) |
152 static_cast<uint64_t>(FileIndexLow);
154 return UniqueID(VolumeSerialNumber, FileID);
157 TimeValue file_status::getLastModificationTime() const {
159 UI.LowPart = LastWriteTimeLow;
160 UI.HighPart = LastWriteTimeHigh;
163 Ret.fromWin32Time(UI.QuadPart);
167 std::error_code current_path(SmallVectorImpl<char> &result) {
168 SmallVector<wchar_t, MAX_PATH> cur_path;
169 DWORD len = MAX_PATH;
172 cur_path.reserve(len);
173 len = ::GetCurrentDirectoryW(cur_path.capacity(), cur_path.data());
175 // A zero return value indicates a failure other than insufficient space.
177 return windows_error(::GetLastError());
179 // If there's insufficient space, the len returned is larger than the len
181 } while (len > cur_path.capacity());
183 // On success, GetCurrentDirectoryW returns the number of characters not
184 // including the null-terminator.
185 cur_path.set_size(len);
186 return UTF16ToUTF8(cur_path.begin(), cur_path.size(), result);
189 std::error_code create_directory(const Twine &path, bool IgnoreExisting) {
190 SmallVector<wchar_t, 128> path_utf16;
192 if (std::error_code ec = widenPath(path, path_utf16))
195 if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
196 DWORD LastError = ::GetLastError();
197 if (LastError != ERROR_ALREADY_EXISTS || !IgnoreExisting)
198 return windows_error(LastError);
201 return std::error_code();
204 // We can't use symbolic links for windows.
205 std::error_code create_link(const Twine &to, const Twine &from) {
206 // Convert to utf-16.
207 SmallVector<wchar_t, 128> wide_from;
208 SmallVector<wchar_t, 128> wide_to;
209 if (std::error_code ec = widenPath(from, wide_from))
211 if (std::error_code ec = widenPath(to, wide_to))
214 if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
215 return windows_error(::GetLastError());
217 return std::error_code();
220 std::error_code remove(const Twine &path, bool IgnoreNonExisting) {
221 SmallVector<wchar_t, 128> path_utf16;
224 if (std::error_code EC = status(path, ST)) {
225 if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
227 return std::error_code();
230 if (std::error_code ec = widenPath(path, path_utf16))
233 if (ST.type() == file_type::directory_file) {
234 if (!::RemoveDirectoryW(c_str(path_utf16))) {
235 std::error_code EC = windows_error(::GetLastError());
236 if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
239 return std::error_code();
241 if (!::DeleteFileW(c_str(path_utf16))) {
242 std::error_code EC = windows_error(::GetLastError());
243 if (EC != errc::no_such_file_or_directory || !IgnoreNonExisting)
246 return std::error_code();
249 std::error_code rename(const Twine &from, const Twine &to) {
250 // Convert to utf-16.
251 SmallVector<wchar_t, 128> wide_from;
252 SmallVector<wchar_t, 128> wide_to;
253 if (std::error_code ec = widenPath(from, wide_from))
255 if (std::error_code ec = widenPath(to, wide_to))
258 std::error_code ec = std::error_code();
259 for (int i = 0; i < 2000; i++) {
260 if (::MoveFileExW(wide_from.begin(), wide_to.begin(),
261 MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
262 return std::error_code();
263 DWORD LastError = ::GetLastError();
264 if (LastError != ERROR_ACCESS_DENIED)
266 // Retry MoveFile() at ACCESS_DENIED.
267 // System scanners (eg. indexer) might open the source file when
268 // It is written and closed.
275 std::error_code resize_file(const Twine &path, uint64_t size) {
276 SmallVector<wchar_t, 128> path_utf16;
278 if (std::error_code ec = widenPath(path, path_utf16))
281 int fd = ::_wopen(path_utf16.begin(), O_BINARY | _O_RDWR, S_IWRITE);
283 return std::error_code(errno, std::generic_category());
284 #ifdef HAVE__CHSIZE_S
285 errno_t error = ::_chsize_s(fd, size);
287 errno_t error = ::_chsize(fd, size);
290 return std::error_code(error, std::generic_category());
293 std::error_code access(const Twine &Path, AccessMode Mode) {
294 SmallVector<wchar_t, 128> PathUtf16;
296 if (std::error_code EC = widenPath(Path, PathUtf16))
299 DWORD Attributes = ::GetFileAttributesW(PathUtf16.begin());
301 if (Attributes == INVALID_FILE_ATTRIBUTES) {
302 // See if the file didn't actually exist.
303 DWORD LastError = ::GetLastError();
304 if (LastError != ERROR_FILE_NOT_FOUND &&
305 LastError != ERROR_PATH_NOT_FOUND)
306 return windows_error(LastError);
307 return errc::no_such_file_or_directory;
310 if (Mode == AccessMode::Write && (Attributes & FILE_ATTRIBUTE_READONLY))
311 return errc::permission_denied;
313 return std::error_code();
316 bool equivalent(file_status A, file_status B) {
317 assert(status_known(A) && status_known(B));
318 return A.FileIndexHigh == B.FileIndexHigh &&
319 A.FileIndexLow == B.FileIndexLow &&
320 A.FileSizeHigh == B.FileSizeHigh &&
321 A.FileSizeLow == B.FileSizeLow &&
322 A.LastWriteTimeHigh == B.LastWriteTimeHigh &&
323 A.LastWriteTimeLow == B.LastWriteTimeLow &&
324 A.VolumeSerialNumber == B.VolumeSerialNumber;
327 std::error_code equivalent(const Twine &A, const Twine &B, bool &result) {
328 file_status fsA, fsB;
329 if (std::error_code ec = status(A, fsA))
331 if (std::error_code ec = status(B, fsB))
333 result = equivalent(fsA, fsB);
334 return std::error_code();
337 static bool isReservedName(StringRef path) {
338 // This list of reserved names comes from MSDN, at:
339 // http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
340 static const char *sReservedNames[] = { "nul", "con", "prn", "aux",
341 "com1", "com2", "com3", "com4", "com5", "com6",
342 "com7", "com8", "com9", "lpt1", "lpt2", "lpt3",
343 "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9" };
345 // First, check to see if this is a device namespace, which always
346 // starts with \\.\, since device namespaces are not legal file paths.
347 if (path.startswith("\\\\.\\"))
350 // Then compare against the list of ancient reserved names
351 for (size_t i = 0; i < array_lengthof(sReservedNames); ++i) {
352 if (path.equals_lower(sReservedNames[i]))
356 // The path isn't what we consider reserved.
360 static std::error_code getStatus(HANDLE FileHandle, file_status &Result) {
361 if (FileHandle == INVALID_HANDLE_VALUE)
362 goto handle_status_error;
364 switch (::GetFileType(FileHandle)) {
366 llvm_unreachable("Don't know anything about this file type");
367 case FILE_TYPE_UNKNOWN: {
368 DWORD Err = ::GetLastError();
370 return windows_error(Err);
371 Result = file_status(file_type::type_unknown);
372 return std::error_code();
377 Result = file_status(file_type::character_file);
378 return std::error_code();
380 Result = file_status(file_type::fifo_file);
381 return std::error_code();
384 BY_HANDLE_FILE_INFORMATION Info;
385 if (!::GetFileInformationByHandle(FileHandle, &Info))
386 goto handle_status_error;
389 file_type Type = (Info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
390 ? file_type::directory_file
391 : file_type::regular_file;
393 file_status(Type, Info.ftLastWriteTime.dwHighDateTime,
394 Info.ftLastWriteTime.dwLowDateTime,
395 Info.dwVolumeSerialNumber, Info.nFileSizeHigh,
396 Info.nFileSizeLow, Info.nFileIndexHigh, Info.nFileIndexLow);
397 return std::error_code();
401 DWORD LastError = ::GetLastError();
402 if (LastError == ERROR_FILE_NOT_FOUND ||
403 LastError == ERROR_PATH_NOT_FOUND)
404 Result = file_status(file_type::file_not_found);
405 else if (LastError == ERROR_SHARING_VIOLATION)
406 Result = file_status(file_type::type_unknown);
408 Result = file_status(file_type::status_error);
409 return windows_error(LastError);
412 std::error_code status(const Twine &path, file_status &result) {
413 SmallString<128> path_storage;
414 SmallVector<wchar_t, 128> path_utf16;
416 StringRef path8 = path.toStringRef(path_storage);
417 if (isReservedName(path8)) {
418 result = file_status(file_type::character_file);
419 return std::error_code();
422 if (std::error_code ec = widenPath(path8, path_utf16))
425 DWORD attr = ::GetFileAttributesW(path_utf16.begin());
426 if (attr == INVALID_FILE_ATTRIBUTES)
427 return getStatus(INVALID_HANDLE_VALUE, result);
429 // Handle reparse points.
430 if (attr & FILE_ATTRIBUTE_REPARSE_POINT) {
432 ::CreateFileW(path_utf16.begin(),
433 0, // Attributes only.
434 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
437 FILE_FLAG_BACKUP_SEMANTICS,
440 return getStatus(INVALID_HANDLE_VALUE, result);
444 ::CreateFileW(path_utf16.begin(), 0, // Attributes only.
445 FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE,
446 NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0));
448 return getStatus(INVALID_HANDLE_VALUE, result);
450 return getStatus(h, result);
453 std::error_code status(int FD, file_status &Result) {
454 HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
455 return getStatus(FileHandle, Result);
458 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time) {
460 UI.QuadPart = Time.toWin32Time();
462 FT.dwLowDateTime = UI.LowPart;
463 FT.dwHighDateTime = UI.HighPart;
464 HANDLE FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(FD));
465 if (!SetFileTime(FileHandle, NULL, &FT, &FT))
466 return windows_error(::GetLastError());
467 return std::error_code();
470 std::error_code mapped_file_region::init(int FD, bool CloseFD, uint64_t Offset) {
472 // Make sure that the requested size fits within SIZE_T.
473 if (Size > std::numeric_limits<SIZE_T>::max()) {
474 if (FileDescriptor) {
476 _close(FileDescriptor);
478 ::CloseHandle(FileHandle);
479 return make_error_code(errc::invalid_argument);
484 case readonly: flprotect = PAGE_READONLY; break;
485 case readwrite: flprotect = PAGE_READWRITE; break;
486 case priv: flprotect = PAGE_WRITECOPY; break;
490 ::CreateFileMappingW(FileHandle, 0, flprotect,
491 (Offset + Size) >> 32,
492 (Offset + Size) & 0xffffffff,
494 if (FileMappingHandle == NULL) {
495 std::error_code ec = windows_error(GetLastError());
496 if (FileDescriptor) {
498 _close(FileDescriptor);
500 ::CloseHandle(FileHandle);
504 DWORD dwDesiredAccess;
506 case readonly: dwDesiredAccess = FILE_MAP_READ; break;
507 case readwrite: dwDesiredAccess = FILE_MAP_WRITE; break;
508 case priv: dwDesiredAccess = FILE_MAP_COPY; break;
510 Mapping = ::MapViewOfFile(FileMappingHandle,
515 if (Mapping == NULL) {
516 std::error_code ec = windows_error(GetLastError());
517 ::CloseHandle(FileMappingHandle);
518 if (FileDescriptor) {
520 _close(FileDescriptor);
522 ::CloseHandle(FileHandle);
527 MEMORY_BASIC_INFORMATION mbi;
528 SIZE_T Result = VirtualQuery(Mapping, &mbi, sizeof(mbi));
530 std::error_code ec = windows_error(GetLastError());
531 ::UnmapViewOfFile(Mapping);
532 ::CloseHandle(FileMappingHandle);
533 if (FileDescriptor) {
535 _close(FileDescriptor);
537 ::CloseHandle(FileHandle);
540 Size = mbi.RegionSize;
543 // Close all the handles except for the view. It will keep the other handles
545 ::CloseHandle(FileMappingHandle);
546 if (FileDescriptor) {
548 _close(FileDescriptor); // Also closes FileHandle.
550 ::CloseHandle(FileHandle);
551 return std::error_code();
554 mapped_file_region::mapped_file_region(const Twine &path,
563 , FileHandle(INVALID_HANDLE_VALUE)
564 , FileMappingHandle() {
565 SmallVector<wchar_t, 128> path_utf16;
567 // Convert path to UTF-16.
568 if ((ec = widenPath(path, path_utf16)))
571 // Get file handle for creating a file mapping.
572 FileHandle = ::CreateFileW(c_str(path_utf16),
573 Mode == readonly ? GENERIC_READ
574 : GENERIC_READ | GENERIC_WRITE,
575 Mode == readonly ? FILE_SHARE_READ
578 Mode == readonly ? OPEN_EXISTING
580 Mode == readonly ? FILE_ATTRIBUTE_READONLY
581 : FILE_ATTRIBUTE_NORMAL,
583 if (FileHandle == INVALID_HANDLE_VALUE) {
584 ec = windows_error(::GetLastError());
589 ec = init(FileDescriptor, true, offset);
591 Mapping = FileMappingHandle = 0;
592 FileHandle = INVALID_HANDLE_VALUE;
597 mapped_file_region::mapped_file_region(int fd,
607 , FileHandle(INVALID_HANDLE_VALUE)
608 , FileMappingHandle() {
609 FileHandle = reinterpret_cast<HANDLE>(_get_osfhandle(fd));
610 if (FileHandle == INVALID_HANDLE_VALUE) {
612 _close(FileDescriptor);
614 ec = make_error_code(errc::bad_file_descriptor);
618 ec = init(FileDescriptor, closefd, offset);
620 Mapping = FileMappingHandle = 0;
621 FileHandle = INVALID_HANDLE_VALUE;
626 mapped_file_region::~mapped_file_region() {
628 ::UnmapViewOfFile(Mapping);
631 mapped_file_region::mapped_file_region(mapped_file_region &&other)
634 , Mapping(other.Mapping)
635 , FileDescriptor(other.FileDescriptor)
636 , FileHandle(other.FileHandle)
637 , FileMappingHandle(other.FileMappingHandle) {
638 other.Mapping = other.FileMappingHandle = 0;
639 other.FileHandle = INVALID_HANDLE_VALUE;
640 other.FileDescriptor = 0;
643 mapped_file_region::mapmode mapped_file_region::flags() const {
644 assert(Mapping && "Mapping failed but used anyway!");
648 uint64_t mapped_file_region::size() const {
649 assert(Mapping && "Mapping failed but used anyway!");
653 char *mapped_file_region::data() const {
654 assert(Mode != readonly && "Cannot get non-const data for readonly mapping!");
655 assert(Mapping && "Mapping failed but used anyway!");
656 return reinterpret_cast<char*>(Mapping);
659 const char *mapped_file_region::const_data() const {
660 assert(Mapping && "Mapping failed but used anyway!");
661 return reinterpret_cast<const char*>(Mapping);
664 int mapped_file_region::alignment() {
666 ::GetSystemInfo(&SysInfo);
667 return SysInfo.dwAllocationGranularity;
670 std::error_code detail::directory_iterator_construct(detail::DirIterState &it,
672 SmallVector<wchar_t, 128> path_utf16;
674 if (std::error_code ec = widenPath(path, path_utf16))
677 // Convert path to the format that Windows is happy with.
678 if (path_utf16.size() > 0 &&
679 !is_separator(path_utf16[path.size() - 1]) &&
680 path_utf16[path.size() - 1] != L':') {
681 path_utf16.push_back(L'\\');
682 path_utf16.push_back(L'*');
684 path_utf16.push_back(L'*');
687 // Get the first directory entry.
688 WIN32_FIND_DATAW FirstFind;
689 ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
691 return windows_error(::GetLastError());
693 size_t FilenameLen = ::wcslen(FirstFind.cFileName);
694 while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
695 (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
696 FirstFind.cFileName[1] == L'.'))
697 if (!::FindNextFileW(FindHandle, &FirstFind)) {
698 DWORD LastError = ::GetLastError();
700 if (LastError == ERROR_NO_MORE_FILES)
701 return detail::directory_iterator_destruct(it);
702 return windows_error(LastError);
704 FilenameLen = ::wcslen(FirstFind.cFileName);
706 // Construct the current directory entry.
707 SmallString<128> directory_entry_name_utf8;
708 if (std::error_code ec =
709 UTF16ToUTF8(FirstFind.cFileName, ::wcslen(FirstFind.cFileName),
710 directory_entry_name_utf8))
713 it.IterationHandle = intptr_t(FindHandle.take());
714 SmallString<128> directory_entry_path(path);
715 path::append(directory_entry_path, directory_entry_name_utf8.str());
716 it.CurrentEntry = directory_entry(directory_entry_path.str());
718 return std::error_code();
721 std::error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
722 if (it.IterationHandle != 0)
723 // Closes the handle if it's valid.
724 ScopedFindHandle close(HANDLE(it.IterationHandle));
725 it.IterationHandle = 0;
726 it.CurrentEntry = directory_entry();
727 return std::error_code();
730 std::error_code detail::directory_iterator_increment(detail::DirIterState &it) {
731 WIN32_FIND_DATAW FindData;
732 if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
733 DWORD LastError = ::GetLastError();
735 if (LastError == ERROR_NO_MORE_FILES)
736 return detail::directory_iterator_destruct(it);
737 return windows_error(LastError);
740 size_t FilenameLen = ::wcslen(FindData.cFileName);
741 if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
742 (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
743 FindData.cFileName[1] == L'.'))
744 return directory_iterator_increment(it);
746 SmallString<128> directory_entry_path_utf8;
747 if (std::error_code ec =
748 UTF16ToUTF8(FindData.cFileName, ::wcslen(FindData.cFileName),
749 directory_entry_path_utf8))
752 it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
753 return std::error_code();
756 std::error_code openFileForRead(const Twine &Name, int &ResultFD) {
757 SmallVector<wchar_t, 128> PathUTF16;
759 if (std::error_code EC = widenPath(Name, PathUTF16))
762 HANDLE H = ::CreateFileW(PathUTF16.begin(), GENERIC_READ,
763 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
764 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
765 if (H == INVALID_HANDLE_VALUE) {
766 DWORD LastError = ::GetLastError();
767 std::error_code EC = windows_error(LastError);
768 // Provide a better error message when trying to open directories.
769 // This only runs if we failed to open the file, so there is probably
770 // no performances issues.
771 if (LastError != ERROR_ACCESS_DENIED)
773 if (is_directory(Name))
774 return make_error_code(errc::is_a_directory);
778 int FD = ::_open_osfhandle(intptr_t(H), 0);
781 return windows_error(ERROR_INVALID_HANDLE);
785 return std::error_code();
788 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
789 sys::fs::OpenFlags Flags, unsigned Mode) {
790 // Verify that we don't have both "append" and "excl".
791 assert((!(Flags & sys::fs::F_Excl) || !(Flags & sys::fs::F_Append)) &&
792 "Cannot specify both 'excl' and 'append' file creation flags!");
794 SmallVector<wchar_t, 128> PathUTF16;
796 if (std::error_code EC = widenPath(Name, PathUTF16))
799 DWORD CreationDisposition;
801 CreationDisposition = CREATE_NEW;
802 else if (Flags & F_Append)
803 CreationDisposition = OPEN_ALWAYS;
805 CreationDisposition = CREATE_ALWAYS;
807 DWORD Access = GENERIC_WRITE;
809 Access |= GENERIC_READ;
811 HANDLE H = ::CreateFileW(PathUTF16.begin(), Access,
812 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
813 CreationDisposition, FILE_ATTRIBUTE_NORMAL, NULL);
815 if (H == INVALID_HANDLE_VALUE) {
816 DWORD LastError = ::GetLastError();
817 std::error_code EC = windows_error(LastError);
818 // Provide a better error message when trying to open directories.
819 // This only runs if we failed to open the file, so there is probably
820 // no performances issues.
821 if (LastError != ERROR_ACCESS_DENIED)
823 if (is_directory(Name))
824 return make_error_code(errc::is_a_directory);
829 if (Flags & F_Append)
830 OpenFlags |= _O_APPEND;
833 OpenFlags |= _O_TEXT;
835 int FD = ::_open_osfhandle(intptr_t(H), OpenFlags);
838 return windows_error(ERROR_INVALID_HANDLE);
842 return std::error_code();
844 } // end namespace fs
848 bool home_directory(SmallVectorImpl<char> &result) {
849 wchar_t Path[MAX_PATH];
850 if (::SHGetFolderPathW(0, CSIDL_APPDATA | CSIDL_FLAG_CREATE, 0,
851 /*SHGFP_TYPE_CURRENT*/0, Path) != S_OK)
854 if (UTF16ToUTF8(Path, ::wcslen(Path), result))
860 static bool getTempDirEnvVar(const char *Var, SmallVectorImpl<char> &Res) {
861 SmallVector<wchar_t, 128> NameUTF16;
862 if (windows::UTF8ToUTF16(Var, NameUTF16))
865 SmallVector<wchar_t, 1024> Buf;
870 GetEnvironmentVariableW(NameUTF16.data(), Buf.data(), Buf.capacity());
874 // Try again with larger buffer.
875 } while (Size > Buf.capacity());
878 if (windows::UTF16ToUTF8(Buf.data(), Size, Res))
883 static bool getTempDirEnvVar(SmallVectorImpl<char> &Res) {
884 const char *EnvironmentVariables[] = {"TMP", "TEMP", "USERPROFILE"};
885 for (const char *Env : EnvironmentVariables) {
886 if (getTempDirEnvVar(Env, Res))
892 void system_temp_directory(bool ErasedOnReboot, SmallVectorImpl<char> &Result) {
893 (void)ErasedOnReboot;
896 // Check whether the temporary directory is specified by an environment
898 if (getTempDirEnvVar(Result))
901 // Fall back to a system default.
902 const char *DefaultResult = "C:\\TEMP";
903 Result.append(DefaultResult, DefaultResult + strlen(DefaultResult));
905 } // end namespace path
908 std::error_code UTF8ToUTF16(llvm::StringRef utf8,
909 llvm::SmallVectorImpl<wchar_t> &utf16) {
911 int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
912 utf8.size(), utf16.begin(), 0);
915 return windows_error(::GetLastError());
917 utf16.reserve(len + 1);
920 len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, utf8.begin(),
921 utf8.size(), utf16.begin(), utf16.size());
924 return windows_error(::GetLastError());
927 // Make utf16 null terminated.
931 return std::error_code();
935 std::error_code UTF16ToCodePage(unsigned codepage, const wchar_t *utf16,
937 llvm::SmallVectorImpl<char> &utf8) {
940 int len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.begin(),
944 return windows_error(::GetLastError());
949 // Now do the actual conversion.
950 len = ::WideCharToMultiByte(codepage, 0, utf16, utf16_len, utf8.data(),
951 utf8.size(), NULL, NULL);
954 return windows_error(::GetLastError());
957 // Make utf8 null terminated.
961 return std::error_code();
964 std::error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
965 llvm::SmallVectorImpl<char> &utf8) {
966 return UTF16ToCodePage(CP_UTF8, utf16, utf16_len, utf8);
969 std::error_code UTF16ToCurCP(const wchar_t *utf16, size_t utf16_len,
970 llvm::SmallVectorImpl<char> &utf8) {
971 return UTF16ToCodePage(CP_ACP, utf16, utf16_len, utf8);
973 } // end namespace windows
974 } // end namespace sys
975 } // end namespace llvm