Support/FileSystem: Implement recursive_directory_iterator and make
[oota-llvm.git] / lib / Support / Windows / PathV2.inc
index 7d9421ac768316d24cd5f14e43043ab3d653a683..3872512e4faea7afb258495052d4d89ca3c36041 100644 (file)
@@ -1,4 +1,4 @@
-//===- llvm/Support/Win32/PathV2.cpp - Windows Path Impl --------*- C++ -*-===//
+//===- llvm/Support/Windows/PathV2.inc - Windows Path Impl ------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -17,7 +17,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "Windows.h"
-#include <WinCrypt.h>
+#include <wincrypt.h>
 #include <fcntl.h>
 #include <io.h>
 #include <sys/stat.h>
@@ -41,14 +41,13 @@ namespace {
     ::GetProcAddress(::GetModuleHandleA("kernel32.dll"),
                      "CreateSymbolicLinkW"));
 
-  error_code UTF8ToUTF16(const StringRef &utf8,
-                               SmallVectorImpl<wchar_t> &utf16) {
+  error_code UTF8ToUTF16(StringRef utf8, SmallVectorImpl<wchar_t> &utf16) {
     int len = ::MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS,
                                     utf8.begin(), utf8.size(),
                                     utf16.begin(), 0);
 
     if (len == 0)
-      return make_error_code(windows_error(::GetLastError()));
+      return windows_error(::GetLastError());
 
     utf16.reserve(len + 1);
     utf16.set_size(len);
@@ -58,13 +57,13 @@ namespace {
                                     utf16.begin(), utf16.size());
 
     if (len == 0)
-      return make_error_code(windows_error(::GetLastError()));
+      return windows_error(::GetLastError());
 
     // Make utf16 null terminated.
     utf16.push_back(0);
     utf16.pop_back();
 
-    return make_error_code(errc::success);
+    return success;
   }
 
   error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
@@ -76,7 +75,7 @@ namespace {
                                     NULL, NULL);
 
     if (len == 0)
-      return make_error_code(windows_error(::GetLastError()));
+      return windows_error(::GetLastError());
 
     utf8.reserve(len);
     utf8.set_size(len);
@@ -88,13 +87,13 @@ namespace {
                                 NULL, NULL);
 
     if (len == 0)
-      return make_error_code(windows_error(::GetLastError()));
+      return windows_error(::GetLastError());
 
     // Make utf8 null terminated.
     utf8.push_back(0);
     utf8.pop_back();
 
-    return make_error_code(errc::success);
+    return success;
   }
 
   error_code TempDir(SmallVectorImpl<wchar_t> &result) {
@@ -102,7 +101,7 @@ namespace {
     DWORD len = ::GetTempPathW(result.capacity(), result.begin());
 
     if (len == 0)
-      return make_error_code(windows_error(::GetLastError()));
+      return windows_error(::GetLastError());
 
     if (len > result.capacity()) {
       result.reserve(len);
@@ -110,23 +109,31 @@ namespace {
     }
 
     result.set_size(len);
-    return make_error_code(errc::success);
+    return success;
   }
 
-  struct AutoCryptoProvider {
-    HCRYPTPROV CryptoProvider;
+  // Forwarder for ScopedHandle.
+  BOOL WINAPI CryptReleaseContext(HCRYPTPROV Provider) {
+    return ::CryptReleaseContext(Provider, 0);
+  }
 
-    ~AutoCryptoProvider() {
-      ::CryptReleaseContext(CryptoProvider, 0);
+  typedef ScopedHandle<HCRYPTPROV, uintptr_t(-1),
+                       BOOL (WINAPI*)(HCRYPTPROV), CryptReleaseContext>
+    ScopedCryptContext;
+  bool is_separator(const wchar_t value) {
+    switch (value) {
+    case L'\\':
+    case L'/':
+      return true;
+    default:
+      return false;
     }
-
-    operator HCRYPTPROV() const {return CryptoProvider;}
-  };
+  }
 }
 
 namespace llvm {
 namespace sys  {
-namespace path {
+namespace fs {
 
 error_code current_path(SmallVectorImpl<char> &result) {
   SmallVector<wchar_t, 128> cur_path;
@@ -136,7 +143,7 @@ retry_cur_dir:
 
   // A zero return value indicates a failure other than insufficient space.
   if (len == 0)
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
   // If there's insufficient space, the len returned is larger than the len
   // given.
@@ -167,15 +174,11 @@ retry_cur_dir:
                               result.data(), result.size(),
                               NULL, NULL);
   if (len == 0)
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
-  return make_error_code(errc::success);
+  return success;
 }
 
-} // end namespace path
-
-namespace fs {
-
 error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
   // Get arguments.
   SmallString<128> from_storage;
@@ -194,9 +197,9 @@ error_code copy_file(const Twine &from, const Twine &to, copy_option copt) {
                          copt != copy_option::overwrite_if_exists);
 
   if (res == 0)
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code create_directory(const Twine &path, bool &existed) {
@@ -208,15 +211,15 @@ error_code create_directory(const Twine &path, bool &existed) {
     return ec;
 
   if (!::CreateDirectoryW(path_utf16.begin(), NULL)) {
-    error_code ec = make_error_code(windows_error(::GetLastError()));
-    if (ec == make_error_code(windows_error::already_exists))
+    error_code ec = windows_error(::GetLastError());
+    if (ec == windows_error::already_exists)
       existed = true;
     else
       return ec;
   } else
     existed = false;
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code create_hard_link(const Twine &to, const Twine &from) {
@@ -233,9 +236,9 @@ error_code create_hard_link(const Twine &to, const Twine &from) {
   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 
   if (!::CreateHardLinkW(wide_from.begin(), wide_to.begin(), NULL))
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code create_symlink(const Twine &to, const Twine &from) {
@@ -256,28 +259,42 @@ error_code create_symlink(const Twine &to, const Twine &from) {
   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 
   if (!create_symbolic_link_api(wide_from.begin(), wide_to.begin(), 0))
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code remove(const Twine &path, bool &existed) {
   SmallString<128> path_storage;
   SmallVector<wchar_t, 128> path_utf16;
 
+  file_status st;
+  if (error_code ec = status(path, st))
+    return ec;
+
   if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
                                   path_utf16))
     return ec;
 
-  if (!::DeleteFileW(path_utf16.begin())) {
-    error_code ec = make_error_code(windows_error(::GetLastError()));
-    if (ec != make_error_code(windows_error::file_not_found))
-      return ec;
-    existed = false;
-  } else
-    existed = true;
+  if (st.type() == file_type::directory_file) {
+    if (!::RemoveDirectoryW(c_str(path_utf16))) {
+      error_code ec = windows_error(::GetLastError());
+      if (ec != windows_error::file_not_found)
+        return ec;
+      existed = false;
+    } else
+      existed = true;
+  } else {
+    if (!::DeleteFileW(c_str(path_utf16))) {
+      error_code ec = windows_error(::GetLastError());
+      if (ec != windows_error::file_not_found)
+        return ec;
+      existed = false;
+    } else
+      existed = true;
+  }
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code rename(const Twine &from, const Twine &to) {
@@ -293,10 +310,11 @@ error_code rename(const Twine &from, const Twine &to) {
   if (error_code ec = UTF8ToUTF16(f, wide_from)) return ec;
   if (error_code ec = UTF8ToUTF16(t, wide_to)) return ec;
 
-  if (!::MoveFileW(wide_from.begin(), wide_to.begin()))
-    return make_error_code(windows_error(::GetLastError()));
+  if (!::MoveFileExW(wide_from.begin(), wide_to.begin(),
+                     MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING))
+    return windows_error(::GetLastError());
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code resize_file(const Twine &path, uint64_t size) {
@@ -332,13 +350,13 @@ error_code exists(const Twine &path, bool &result) {
   if (attributes == INVALID_FILE_ATTRIBUTES) {
     // See if the file didn't actually exist.
     error_code ec = make_error_code(windows_error(::GetLastError()));
-    if (ec != error_code(windows_error::file_not_found) &&
-        ec != error_code(windows_error::path_not_found))
+    if (ec != windows_error::file_not_found &&
+        ec != windows_error::path_not_found)
       return ec;
     result = false;
   } else
     result = true;
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code equivalent(const Twine &A, const Twine &B, bool &result) {
@@ -375,21 +393,21 @@ error_code equivalent(const Twine &A, const Twine &B, bool &result) {
   // If both handles are invalid, it's an error.
   if (HandleA == INVALID_HANDLE_VALUE &&
       HandleB == INVALID_HANDLE_VALUE)
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
   // If only one is invalid, it's false.
   if (HandleA == INVALID_HANDLE_VALUE &&
       HandleB == INVALID_HANDLE_VALUE) {
     result = false;
-    return make_error_code(errc::success);
+    return success;
   }
 
   // Get file information.
   BY_HANDLE_FILE_INFORMATION InfoA, InfoB;
   if (!::GetFileInformationByHandle(HandleA, &InfoA))
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
   if (!::GetFileInformationByHandle(HandleB, &InfoB))
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
   // See if it's all the same.
   result =
@@ -403,7 +421,7 @@ error_code equivalent(const Twine &A, const Twine &B, bool &result) {
     InfoA.ftLastWriteTime.dwHighDateTime ==
       InfoB.ftLastWriteTime.dwHighDateTime;
 
-  return make_error_code(errc::success);
+  return success;
 }
 
 error_code file_size(const Twine &path, uint64_t &result) {
@@ -418,20 +436,49 @@ error_code file_size(const Twine &path, uint64_t &result) {
   if (!::GetFileAttributesExW(path_utf16.begin(),
                               ::GetFileExInfoStandard,
                               &FileData))
-    return make_error_code(windows_error(::GetLastError()));
+    return windows_error(::GetLastError());
 
   result =
     (uint64_t(FileData.nFileSizeHigh) << (sizeof(FileData.nFileSizeLow) * 8))
     + FileData.nFileSizeLow;
 
-  return make_error_code(errc::success);
+  return success;
+}
+
+static bool isReservedName(StringRef path) {
+  // This list of reserved names comes from MSDN, at:
+  // http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx
+  static const char *sReservedNames[] = { "nul", "con", "prn", "aux",
+                              "com1", "com2", "com3", "com4", "com5", "com6",
+                              "com7", "com8", "com9", "lpt1", "lpt2", "lpt3",
+                              "lpt4", "lpt5", "lpt6", "lpt7", "lpt8", "lpt9" };
+
+  // First, check to see if this is a device namespace, which always
+  // starts with \\.\, since device namespaces are not legal file paths.
+  if (path.startswith("\\\\.\\"))
+    return true;
+
+  // Then compare against the list of ancient reserved names
+  for (size_t i = 0; i < sizeof(sReservedNames) / sizeof(const char *); ++i) {
+    if (path.equals_lower(sReservedNames[i]))
+      return true;
+  }
+
+  // The path isn't what we consider reserved.
+  return false;
 }
 
 error_code status(const Twine &path, file_status &result) {
   SmallString<128> path_storage;
   SmallVector<wchar_t, 128> path_utf16;
 
-  if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
+  StringRef path8 = path.toStringRef(path_storage);
+  if (isReservedName(path8)) {
+    result = file_status(file_type::character_file);
+    return success;
+  }
+
+  if (error_code ec = UTF8ToUTF16(path8,
                                   path_utf16))
     return ec;
 
@@ -476,7 +523,8 @@ handle_status_error:
 }
 
 error_code unique_file(const Twine &model, int &result_fd,
-                             SmallVectorImpl<char> &result_path) {
+                             SmallVectorImpl<char> &result_path,
+                             bool makeAbsolute) {
   // Use result_path as temp storage.
   result_path.set_size(0);
   StringRef m = model.toStringRef(result_path);
@@ -484,18 +532,19 @@ error_code unique_file(const Twine &model, int &result_fd,
   SmallVector<wchar_t, 128> model_utf16;
   if (error_code ec = UTF8ToUTF16(m, model_utf16)) return ec;
 
-  // Make model absolute by prepending a temp directory if it's not already.
-  bool absolute;
-  if (error_code ec = path::is_absolute(m, absolute)) return ec;
+  if (makeAbsolute) {
+    // Make model absolute by prepending a temp directory if it's not already.
+    bool absolute = path::is_absolute(m);
 
-  if (!absolute) {
-    SmallVector<wchar_t, 64> temp_dir;
-    if (error_code ec = TempDir(temp_dir)) return ec;
-    // Handle c: by removing it.
-    if (model_utf16.size() > 2 && model_utf16[1] == L':') {
-      model_utf16.erase(model_utf16.begin(), model_utf16.begin() + 2);
+    if (!absolute) {
+      SmallVector<wchar_t, 64> temp_dir;
+      if (error_code ec = TempDir(temp_dir)) return ec;
+      // Handle c: by removing it.
+      if (model_utf16.size() > 2 && model_utf16[1] == L':') {
+        model_utf16.erase(model_utf16.begin(), model_utf16.begin() + 2);
+      }
+      model_utf16.insert(model_utf16.begin(), temp_dir.begin(), temp_dir.end());
     }
-    model_utf16.insert(model_utf16.begin(), temp_dir.begin(), temp_dir.end());
   }
 
   // Replace '%' with random chars. From here on, DO NOT modify model. It may be
@@ -503,14 +552,14 @@ error_code unique_file(const Twine &model, int &result_fd,
   SmallVector<wchar_t, 128> random_path_utf16;
 
   // Get a Crypto Provider for CryptGenRandom.
-  AutoCryptoProvider CryptoProvider;
-  BOOL success = ::CryptAcquireContextW(&CryptoProvider.CryptoProvider,
-                                        NULL,
-                                        NULL,
-                                        PROV_RSA_FULL,
-                                        0);
-  if (!success)
-    return make_error_code(windows_error(::GetLastError()));
+  HCRYPTPROV HCPC;
+  if (!::CryptAcquireContextW(&HCPC,
+                              NULL,
+                              NULL,
+                              PROV_RSA_FULL,
+                              CRYPT_VERIFYCONTEXT))
+    return windows_error(::GetLastError());
+  ScopedCryptContext CryptoProvider(HCPC);
 
 retry_random_path:
   random_path_utf16.set_size(0);
@@ -520,7 +569,7 @@ retry_random_path:
     if (*i == L'%') {
       BYTE val = 0;
       if (!::CryptGenRandom(CryptoProvider, 1, &val))
-          return make_error_code(windows_error(::GetLastError()));
+          return windows_error(::GetLastError());
       random_path_utf16.push_back("0123456789abcdef"[val & 15]);
     }
     else
@@ -543,11 +592,11 @@ retry_create_file:
                                         NULL);
   if (TempFileHandle == INVALID_HANDLE_VALUE) {
     // If the file existed, try again, otherwise, error.
-    error_code ec = make_error_code(windows_error(::GetLastError()));
-    if (ec == error_code(windows_error::file_exists))
+    error_code ec = windows_error(::GetLastError());
+    if (ec == windows_error::file_exists)
       goto retry_random_path;
     // Check for non-existing parent directories.
-    if (ec == error_code(windows_error::path_not_found)) {
+    if (ec == windows_error::path_not_found) {
       // Create the directories using result_path as temp storage.
       if (error_code ec = UTF16ToUTF8(random_path_utf16.begin(),
                                       random_path_utf16.size(), result_path))
@@ -556,7 +605,7 @@ retry_create_file:
       SmallString<64> dir_to_create;
       for (path::const_iterator i = path::begin(p),
                                 e = --path::end(p); i != e; ++i) {
-        if (error_code ec = path::append(dir_to_create, *i)) return ec;
+        path::append(dir_to_create, *i);
         bool Exists;
         if (error_code ec = exists(Twine(dir_to_create), Exists)) return ec;
         if (!Exists) {
@@ -570,7 +619,7 @@ retry_create_file:
 
           // Create the directory.
           if (!::CreateDirectoryW(dir_to_create_utf16.begin(), NULL))
-            return make_error_code(windows_error(::GetLastError()));
+            return windows_error(::GetLastError());
         }
       }
       goto retry_create_file;
@@ -593,12 +642,142 @@ retry_create_file:
     ::DeleteFileW(random_path_utf16.begin());
     // MSDN doesn't say anything about _open_osfhandle setting errno or
     // GetLastError(), so just return invalid_handle.
-    return make_error_code(windows_error::invalid_handle);
+    return windows_error::invalid_handle;
   }
 
   result_fd = fd;
-  return make_error_code(errc::success);
+  return success;
+}
+
+error_code get_magic(const Twine &path, uint32_t len,
+                     SmallVectorImpl<char> &result) {
+  SmallString<128> path_storage;
+  SmallVector<wchar_t, 128> path_utf16;
+  result.set_size(0);
+
+  // Convert path to UTF-16.
+  if (error_code ec = UTF8ToUTF16(path.toStringRef(path_storage),
+                                  path_utf16))
+    return ec;
+
+  // Open file.
+  HANDLE file = ::CreateFileW(c_str(path_utf16),
+                              GENERIC_READ,
+                              FILE_SHARE_READ,
+                              NULL,
+                              OPEN_EXISTING,
+                              FILE_ATTRIBUTE_READONLY,
+                              NULL);
+  if (file == INVALID_HANDLE_VALUE)
+    return windows_error(::GetLastError());
+
+  // Allocate buffer.
+  result.reserve(len);
+
+  // Get magic!
+  DWORD bytes_read = 0;
+  BOOL read_success = ::ReadFile(file, result.data(), len, &bytes_read, NULL);
+  error_code ec = windows_error(::GetLastError());
+  ::CloseHandle(file);
+  if (!read_success || (bytes_read != len)) {
+    // Set result size to the number of bytes read if it's valid.
+    if (bytes_read <= len)
+      result.set_size(bytes_read);
+    // ERROR_HANDLE_EOF is mapped to errc::value_too_large.
+    return ec;
+  }
+
+  result.set_size(len);
+  return success;
+}
+
+error_code detail::directory_iterator_construct(detail::DirIterState &it,
+                                                StringRef path){
+  SmallVector<wchar_t, 128> path_utf16;
+
+  if (error_code ec = UTF8ToUTF16(path,
+                                  path_utf16))
+    return ec;
+
+  // Convert path to the format that Windows is happy with.
+  if (path_utf16.size() > 0 &&
+      !is_separator(path_utf16[path.size() - 1]) &&
+      path_utf16[path.size() - 1] != L':') {
+    path_utf16.push_back(L'\\');
+    path_utf16.push_back(L'*');
+  } else {
+    path_utf16.push_back(L'*');
+  }
+
+  //  Get the first directory entry.
+  WIN32_FIND_DATAW FirstFind;
+  ScopedFindHandle FindHandle(::FindFirstFileW(c_str(path_utf16), &FirstFind));
+  if (!FindHandle)
+    return windows_error(::GetLastError());
+
+  size_t FilenameLen = ::wcslen(FirstFind.cFileName);
+  while ((FilenameLen == 1 && FirstFind.cFileName[0] == L'.') ||
+         (FilenameLen == 2 && FirstFind.cFileName[0] == L'.' &&
+                              FirstFind.cFileName[1] == L'.'))
+    if (!::FindNextFileW(FindHandle, &FirstFind)) {
+      error_code ec = windows_error(::GetLastError());
+      // Check for end.
+      if (ec == windows_error::no_more_files)
+        return detail::directory_iterator_destruct(it);
+      return ec;
+    } else
+      FilenameLen = ::wcslen(FirstFind.cFileName);
+
+  // Construct the current directory entry.
+  SmallString<128> directory_entry_name_utf8;
+  if (error_code ec = UTF16ToUTF8(FirstFind.cFileName,
+                                  ::wcslen(FirstFind.cFileName),
+                                  directory_entry_name_utf8))
+    return ec;
+
+  it.IterationHandle = intptr_t(FindHandle.take());
+  SmallString<128> directory_entry_path(path);
+  path::append(directory_entry_path, directory_entry_name_utf8.str());
+  it.CurrentEntry = directory_entry(directory_entry_path.str());
+
+  return success;
+}
+
+error_code detail::directory_iterator_destruct(detail::DirIterState &it) {
+  if (it.IterationHandle != 0)
+    // Closes the handle if it's valid.
+    ScopedFindHandle close(HANDLE(it.IterationHandle));
+  it.IterationHandle = 0;
+  it.CurrentEntry = directory_entry();
+  return success;
+}
+
+error_code detail::directory_iterator_increment(detail::DirIterState &it) {
+  WIN32_FIND_DATAW FindData;
+  if (!::FindNextFileW(HANDLE(it.IterationHandle), &FindData)) {
+    error_code ec = windows_error(::GetLastError());
+    // Check for end.
+    if (ec == windows_error::no_more_files)
+      return detail::directory_iterator_destruct(it);
+    return ec;
+  }
+
+  size_t FilenameLen = ::wcslen(FindData.cFileName);
+  if ((FilenameLen == 1 && FindData.cFileName[0] == L'.') ||
+      (FilenameLen == 2 && FindData.cFileName[0] == L'.' &&
+                           FindData.cFileName[1] == L'.'))
+    return directory_iterator_increment(it);
+
+  SmallString<128> directory_entry_path_utf8;
+  if (error_code ec = UTF16ToUTF8(FindData.cFileName,
+                                  ::wcslen(FindData.cFileName),
+                                  directory_entry_path_utf8))
+    return ec;
+
+  it.CurrentEntry.replace_filename(Twine(directory_entry_path_utf8));
+  return success;
 }
+
 } // end namespace fs
 } // end namespace sys
 } // end namespace llvm