fix(buck2): allow rustc to use Nix environment when compiling #2266
Conversation
This file contains 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
This change enables our project to build using the Nix environment running on Linux and macOS platforms. Background ---------- The upstream `rustc_action.py` script which invokes `rustc` filters the environment in an effort to maintain a better sandboxed build. When we build in a Nix environment (currently used for development and shortly in CI), there are several environment variables that cause the correct linking behavior under Nix. The Nix environment provides wrapper scripts for `clang` and `clang++` which use these environment variables. The `rustc` program is responsible for invoking the linker (by default this tends to be `cc`/`clang`) which means these environment variables need to be present in the `rustc` process so that its children can inherit them. The Fix ------- While there were many attempts at a solution to this problem, we went with a "patch the upstream" approach. In other words, the `rustc_action.py` script is what prevents our correct Nix behavior, so we slightly augmented it with support for more environment variables. This script is provided to us via the upstream `facebookincubator/buck2-prelude` Git repository which we currently vendor using `git subtree`. This means that our "patch" will be wiped out when we re-vendor/update against upstream changes. With this in mind, we provide a `third-party/patches/nix_rustc_action.patch` file which should allow us to patch over upstream updates similar to upstream patching in a packaging system. Co-authored-by: Nick Gerace <[email protected]> Signed-off-by: Fletcher Nichol <[email protected]>
|
bors merge |
|
Build succeeded: |
fnichol
added a commit
that referenced
this pull request
Nov 23, 2023
Update to patch required after change in facebook/buck2-prelude@9e1cfaf resulted in a merge conflict (trivial to resolve but there nonetheless). References: #2266 References: facebook/buck2#466 Signed-off-by: Fletcher Nichol <[email protected]>
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.
This change enables our project to build using the Nix environment running on Linux and macOS platforms.
Background
The upstream
rustc_action.pyscript which invokesrustcfilters the environment in an effort to maintain a better sandboxed build. When we build in a Nix environment (currently used for development and shortly in CI), there are several environment variables that cause the correct linking behavior under Nix.The Nix environment provides wrapper scripts for
clangandclang++which use these environment variables. Therustcprogram is responsible for invoking the linker (by default this tends to becc/clang) which means these environment variables need to be present in therustcprocess so that its children can inherit them.The Fix
While there were many attempts at a solution to this problem, we went with a "patch the upstream" approach. In other words, the
rustc_action.pyscript is what prevents our correct Nix behavior, so we slightly augmented it with support for more environment variables. This script is provided to us via the upstreamfacebookincubator/buck2-preludeGit repository which we currently vendor usinggit subtree. This means that our "patch" will be wiped out when we re-vendor/update against upstream changes. With this in mind, we provide athird-party/patches/nix_rustc_action.patchfile which should allow us to patch over upstream updates similar to upstream patching in a packaging system.