[Support][Windows] disk_space handle unicode paths

[ahorek]

replaces GetDiskFreeSpaceExA with GetDiskFreeSpaceExW to handle user paths with Unicode characters

fixes: #170571

I’m not entirely sure the fix is correct, so I’d appreciate it if someone more familiar with the code could review it. Thanks!

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-platform-windows

@llvm/pr-subscribers-llvm-support

Author: Pavel Rosický (ahorek)

Changes

replaces GetDiskFreeSpaceExA with GetDiskFreeSpaceExW to handle user paths with Unicode characters

fixes: #170571

I’m not entirely sure the fix is correct, so I’d appreciate it if someone more familiar with the code could review it. Thanks!

---

Full diff: https://github.com/llvm/llvm-project/pull/170716.diff

2 Files Affected:

• (modified) llvm/lib/Support/CachePruning.cpp (+2-1)
• (modified) llvm/lib/Support/Windows/Path.inc (+11-6)

diff --git a/llvm/lib/Support/CachePruning.cpp b/llvm/lib/Support/CachePruning.cpp
index 4eae08b18c9b5..c3a190bd346e5 100644
--- a/llvm/lib/Support/CachePruning.cpp
+++ b/llvm/lib/Support/CachePruning.cpp
@@ -280,7 +280,8 @@ bool llvm::pruneCache(StringRef Path, CachePruningPolicy Policy,
   if (Policy.MaxSizePercentageOfAvailableSpace > 0 || Policy.MaxSizeBytes > 0) {
     auto ErrOrSpaceInfo = sys::fs::disk_space(Path);
     if (!ErrOrSpaceInfo) {
-      report_fatal_error("Can't get available size");
+      auto EC = ErrOrSpaceInfo.getError();
+      report_fatal_error("Can't get available size for '" + Path.str() + "': " + EC.message());
     }
     sys::fs::space_info SpaceInfo = ErrOrSpaceInfo.get();
     auto AvailableSpace = TotalSize + SpaceInfo.free;
diff --git a/llvm/lib/Support/Windows/Path.inc b/llvm/lib/Support/Windows/Path.inc
index be007b7abdb51..a133b3ddd9eb5 100644
--- a/llvm/lib/Support/Windows/Path.inc
+++ b/llvm/lib/Support/Windows/Path.inc
@@ -170,14 +170,19 @@ UniqueID file_status::getUniqueID() const {
 
 ErrorOr<space_info> disk_space(const Twine &Path) {
   ULARGE_INTEGER Avail, Total, Free;
-  if (!::GetDiskFreeSpaceExA(Path.str().c_str(), &Avail, &Total, &Free))
+  SmallVector<wchar_t, 128> PathUTF16;
+
+  if (std::error_code EC = widenPath(Path, PathUTF16))
+    return EC;
+
+  if (!::GetDiskFreeSpaceExW(PathUTF16.data(), &Avail, &Total, &Free))
     return mapWindowsError(::GetLastError());
+
   space_info SpaceInfo;
-  SpaceInfo.capacity =
-      (static_cast<uint64_t>(Total.HighPart) << 32) + Total.LowPart;
-  SpaceInfo.free = (static_cast<uint64_t>(Free.HighPart) << 32) + Free.LowPart;
-  SpaceInfo.available =
-      (static_cast<uint64_t>(Avail.HighPart) << 32) + Avail.LowPart;
+  SpaceInfo.capacity  = Total.QuadPart;
+  SpaceInfo.free = Free.QuadPart;
+  SpaceInfo.available = Avail.QuadPart;
+
   return SpaceInfo;
 }
 

[AaronBallman]

These changes look correct to me and there isn't really a good way to test disk space failures, so I think we don't need any extra test coverage.

CC @zmodem @compnerd for some extra eyes in case I've missed something.

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[github-actions]

🐧 Linux x64 Test Results

• 187010 tests passed
• 4924 tests skipped

✅ The build succeeded and all tests passed.

[compnerd]

Thanks for this cleanup! All FS operations really should use the wide variant, and the cleanup with the QuadPart is nice.

[github-actions]

@ahorek Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!