Skip to content

Remap the exec root out of build script rustflags - #4202

Open
cpcwood wants to merge 2 commits into
bazelbuild:mainfrom
cpcwood:fix/build-script-remap-path-prefix
Open

Remap the exec root out of build script rustflags#4202
cpcwood wants to merge 2 commits into
bazelbuild:mainfrom
cpcwood:fix/build-script-remap-path-prefix

Conversation

@cpcwood

@cpcwood cpcwood commented Aug 4, 2026

Copy link
Copy Markdown

Fixes issue: #4201

Build scripts that invoke rustc themselves bake the exec root into their output, because cargo_build_script does not include --remap-path-prefix in the CARGO_ENCODED_RUSTFLAGS it passes to them.

rustix's build.rs feature probe pipes source to rustc on stdin, so the working directory is the only path input rustc has, and it folds that into the --emit=metadata output written to $OUT_DIR. That is a declared build-script output, hashed into the cache key of every dependent crate, so the same source built at two different absolute paths produces different cache keys for the whole dependent chain.

construct_arguments() already applies --remap-path-prefix to every rustc invocation the ruleset constructs, "For determinism to help with build distribution and such". Build scripts reach rustc through CARGO_ENCODED_RUSTFLAGS rather than construct_arguments(), so they never inherited it. rustdoc is the only other exception and is documented as one.

Reproduction, with a Bazel-free minimal check and a four-workspace Bazel proof: https://github.com/cpcwood/bazel-rules-rust-rustix-cache-bust-demo

probe output
  unpatched  e27190bc...  01079d73...   differ
  patched    7e887e12...  7e887e12...   identical

Rustc actions re-executed at a second path
  unpatched  3   (rustix, //:mylib, //:myapp)
  patched    0

Verified on aarch64-darwin and ubuntu-latest. Hash values are platform-specific.

@google-cla

google-cla Bot commented Aug 4, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@cpcwood
cpcwood force-pushed the fix/build-script-remap-path-prefix branch 2 times, most recently from 0a713a3 to 666ce19 Compare August 4, 2026 09:19
Build scripts that invoke rustc themselves, such as rustix's feature probe,
receive CARGO_ENCODED_RUSTFLAGS and forward it verbatim. Without
--remap-path-prefix the exec root is folded into whatever they emit into
OUT_DIR, and because that directory is hashed into the cache key of every
dependent crate, identical sources built at two different absolute paths
produce different cache keys for the whole subtree.

construct_arguments already applies this remapping to every rustc invocation
rules_rust constructs directly. Build scripts reach rustc indirectly, through
the environment, so they did not inherit it.
@cpcwood
cpcwood force-pushed the fix/build-script-remap-path-prefix branch from 666ce19 to 5f3b621 Compare August 4, 2026 09:21

@UebelAndre UebelAndre left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I had jut one question 😄

Comment thread cargo/private/cargo_build_script.bzl
@UebelAndre
UebelAndre self-requested a review August 19, 2026 15:41

@UebelAndre UebelAndre left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Comment thread cargo/private/cargo_build_script.bzl
@UebelAndre
UebelAndre enabled auto-merge August 25, 2026 20:23
@UebelAndre
UebelAndre added this pull request to the merge queue Aug 25, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants