fix: strip SCCACHE_BASEDIRS from escaped-backslash paths on Windows#2736
Open
rconde01 wants to merge 1 commit into
Open
fix: strip SCCACHE_BASEDIRS from escaped-backslash paths on Windows#2736rconde01 wants to merge 1 commit into
rconde01 wants to merge 1 commit into
Conversation
On Windows, paths in preprocessor output are emitted as C string
literals: MSVC `#line` directives and clang GNU linemarkers quote them
with escaped backslash separators, e.g.
#line 1 "C:\\Users\\me\\project\\src\\main.c"
`normalize_win_path` converts every backslash to a forward slash, so
each escaped separator `\\` becomes a DOUBLE forward slash:
c://users//me//project//src//main.c
The normalized basedir, however, uses single slashes
(`c:/users/me/project/`), so `strip_basedirs` never finds a match and
SCCACHE_BASEDIRS silently has no effect on Windows. Cache entries stay
tied to absolute source paths and are not shared across checkout
directories.
Fix: in `strip_basedirs`, also search for a doubled-separator variant of
each basedir (new `double_path_separators` helper), so escaped paths are
stripped as well. Both the escaped and plain forms are handled, including
UNC basedirs. The extra needle and helper are gated behind
`cfg(target_os = "windows")` so non-Windows builds are unchanged.
Adds unit tests covering MSVC `#line`, clang linemarkers, mixed
escaped/plain occurrences, UNC paths, and a hash-key test asserting the
same source compiled from two different basedir roots hashes equally.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2736 +/- ##
==========================================
+ Coverage 74.51% 74.56% +0.05%
==========================================
Files 70 70
Lines 39652 39747 +95
==========================================
+ Hits 29546 29639 +93
- Misses 10106 10108 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix: strip
SCCACHE_BASEDIRSfrom escaped-backslash paths on WindowsFixes #2737.
Problem
SCCACHE_BASEDIRShas no effect on Windows. The same source compiledfrom two different checkout directories produces different cache keys, so
nothing is shared across roots — the feature silently does nothing.
Root cause
On Windows, paths inside preprocessor output are emitted as C string
literals. MSVC
#linedirectives and clang GNU linemarkers quote themwith escaped backslash separators:
normalize_win_pathconverts every backslash to a forward slash, so eachescaped separator
\\becomes a double forward slash:But the normalized basedir uses single slashes (
c:/users/me/project/),so
strip_basedirsnever finds a boundary match, and the absolute path isleft in the preprocessed output that feeds the hash.
Fix
In
strip_basedirs, also search for a doubled-separator variant of eachbasedir, produced by a new
double_path_separatorshelper. Escaped pathsare now stripped in addition to the existing plain form; mixed
escaped/plain occurrences and UNC basedirs are handled too.
The extra needle and the helper are gated behind
cfg(target_os = "windows"), so non-Windows builds and behavior areunchanged.
Tests
New unit tests (Windows-only):
util::tests::test_strip_basedir_windows_escaped_backslashes— MSVC#line, clang linemarker, and mixed escaped/plain occurrences.util::tests::test_strip_basedir_windows_escaped_unc— escaped UNCbasedir.
compiler::c::test::test_hash_key_basedirs_windows_escaped_backslashes— the same source under two different basedir roots hashes equally, and
differs without basedirs.
All three fail before the change and pass after.
cargo test --lib,cargo fmt --check, andcargo clippy --libare clean on the changedcode (the single pre-existing clippy warning in
msvc.rsis untouched).Manual end-to-end verification
Reproduced with real toolchains on Windows: building the same source from
two distinct absolute directories with
SCCACHE_BASEDIRSset goes from0/2 cache hits (unpatched) to 1/2 (patched) for both clang and
MSVC.