-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Introduce -Zembed-metadata
to allow omitting full metadata from rlibs and dylibs
#137535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This comment has been minimized.
This comment has been minimized.
(The test failure is the one situation not yet implemented, which is described in the PR description - |
That's by design,
In #120855 the heuristics were a temporary measure to enable split metadata in bootstrap, while cargo still doesn't support it. |
Interesting. So if I understood it correctly, you would like to remove all heuristics from rustc (so no lookup of On the other hand, it would essentially double the length of the rustc command line, because for every library that you depend on, Cargo would have to pass both |
Yes.
My impression was that it is already the case with pipelined builds, but apparently it's indeed only |
Some changes occurred in compiler/rustc_codegen_ssa This PR modifies cc @jieyouxu |
Ok, rebased and removed the heuristics. I added an error message when the full metadata is not found, but I'm not sure if we should emit the error eagerly (left a comment in code). Could you please take a look at fe29fec? Thank you! |
This comment has been minimized.
This comment has been minimized.
rust-lang/compiler-team#851 was accepted, so I think that we can go forward with this. @petrochenkov What do you think about renaming the flag to |
Seems ok to me. |
-Zsplit-metadata
to split metadata out of rlibs/dylibs-Zembed-metadata
to allow omitting full metadata from rlibs and dylibs
Ok, changed it to @rustbot ready |
This comment has been minimized.
This comment has been minimized.
Created a tracking issue and fixed tests. |
r=me with the metadata version updated. |
This comment has been minimized.
This comment has been minimized.
rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead. cc @rust-lang/rust-analyzer |
@bors r=petrochenkov rollup=never Marked as rollup=never, because this modifies metadata version. |
☀️ Test successful - checks-actions |
What is this?This is an experimental post-merge analysis report that shows differences in test outcomes between the merged PR and its parent PR.Comparing ed20157 (parent) -> 8c35f4a (this PR) Test differencesShow 43 test diffsStage 1
Stage 2
Additionally, 2 doctest diffs were found. These are ignored, as they are noisy. Job group index
Job duration changes
How to interpret the job duration changes?Job durations can vary a lot, based on the actual runner instance |
Finished benchmarking commit (8c35f4a): comparison URL. Overall result: no relevant changes - no action needed@rustbot label: -perf-regression Instruction countThis benchmark run did not return any relevant results for this metric. Max RSS (memory usage)Results (secondary -1.7%)This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
CyclesResults (secondary 3.9%)This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
Binary sizeResults (secondary 0.0%)This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
Bootstrap: 773.019s -> 774.818s (0.23%) |
### What does this PR try to resolve? This PR adds Cargo integration for the new unstable `-Zembed-metadata` rustc flag, which was implemented in rust-lang/rust#137535 ([tracking issue](rust-lang/rust#139165)). The new behavior has to be enabled explicitly using a new unstable CLI flag `-Zno-embed-metadata`. The `-Zembed-metadata=no` rustc flag can reduce disk usage of compiled artifacts, and also the size of Rust dynamic library artifacts shipped to users. However, it is not enough to just pass this flag through `RUSTFLAGS`; it needs to be integrated within Cargo, because it interacts with how the `--emit` flag is passed to rustc, and also how `--extern` args are passed to the final linked artifact build by Cargo. Furthermore, using the flag for all crates in a crate graph compiled by Cargo would be suboptimal (this will all be described below). When you pass `-Zembed-metadata=no` to rustc, it will not store Rust metadata into the compiled artifact. This is important when compiling libs/rlibs/dylibs, since it reduces their size on disk. However, this also means that everytime we use this flag, we have to make sure that we also: - Include `metadata` in the `--emit` flag to generate a `.rmeta` file, otherwise no metadata would be generated whatsoever, which would mean that the artifact wouldn't be usable as a dependency. - Pass also `--extern <dep>=<path>.rmeta` when compiling the final linkable artifact. Before, Cargo would only pass `--extern <dep>=<path>.[rlib|so|dll]`. Since with `-Zembed-metadata=no`, the metadata is only in the `.rmeta` file and not in the rlib/dylib, this is needed to help rustc find out where the metadata lies. - Note: this essentially doubles the cmdline length when compiling the final linked artifact. Not sure if that is a concern. The two points above is what this PR implements, and why this rustc flag needs Cargo integration. The `-Zembed-metadata` flag is only passed to libs, rlibs and dylibs. It does not seem to make sense for other crate types. The one situation where it might make sense are proc macros, but according to @bjorn3 (who initially came up with the idea for `-Zembed-metadata`, it isn't really worth it). Here is a table that summarizes the changes in passed flags and generated files on disk for rlibs and dylibs: | **Crate type** | **Flags** | **Generated files** | **Disk usage** | |--|--|--|--| | Rlib/Lib (before) | `--emit=dep-info,metadata,link` | `.rlib` (with metadata), `.rmeta` (for pipelining) | - | | Rlib/Lib (after) | `--emit=dep-info,metadata,link -Zembed-metadata=no` | `.rlib` (without metadata), `.rmeta` (for metadata/pipelining) | Reduced (metadata no longer duplicated) | | Dylib (before) | `--emit=dep-info,link` | `[.so\|.dll]` (with metadata) | - | | Dylib (after) | `--emit=dep-info,metadata,link -Zembed-metadata=no` | `[.so\|.dll]` (without metadata), `.rmeta` | Unchanged, but split between two files | Behavior for other target kinds/crate types should be unchanged. From the table above, we can see two benefits of using `-Zembed-metadata=no`: - For rlibs/dylibs, we no longer store their metadata twice in the target directory, thus reducing target directory size. - For dylibs, we store esssentially the same amount of data on disk, but the benefit is that the metadata is now in a separate .rmeta file. This means that you can ship the dylib (`.so`/`.dll`) to users without also shipping the metadata. This would slightly reduce e.g. the [size](rust-lang/rust#120855 (comment)) of the shipped rustc toolchains (note that the size reduction here is after the toolchain has been already heavily compressed). Note that if this behavior ever becomes the default, it should be possible to simplify the code quite a bit, and essentially merge the `requires_upstream_objects` and `benefits_from_split_metadata` functions. I did a very simple initial benchmark to evaluate the space savings on cargo itself and [hyperqueue](https://github.com/It4innovations/hyperqueue) (a mid-size crate from my work) using `cargo build` and `cargo build --release` with and without `-Zembed-metadata=no`:  For debug/incremental builds, the effect is smaller, as the artifact disk usage is dwarfed by incremental artifacts and debuginfo. But for (non-incremental) release builds, the disk savings (and also performed I/O operations) are significantly reduced. ### How should we test and review this PR? I wrote two basic tests. The second one tests a situation where a crate depends on a dylib dependency, which is quite rare, but the behavior of this has actually changed in this PR (see comparison table above). Testing this on various real-world projects (or even trying to enable it by default across the whole Cargo suite?) might be beneficial. ## Unresolved questions ### Is this a breaking change? With this new behavior, dylibs and rlibs will no longer contain metadata. If they are compiled with Cargo, that shouldn't matter, but other build systems might have to adapt. ### Should this become the default? I think that in terms of disk size usage and performed I/O operations, it is a pure win. It should either generate less disk data (for rlibs) or the ~same amount of data for dylibs (the data will be a bit larger, because the dylib will still contain a metadata stub header, but that's like 50 bytes and doesn't scale with the size of the dylib, so it's negligible). So I think that eventually, we should just do this by default in Cargo, unless some concerns are found. I suppose that before stabilizing we should also benchmark the effect on compilation performance.
This is a continuation of #120855 (I was mentored by @bjorn3 to move it forward). Most of the original code was written by bjorn3, I tried to clean it up a bit and add some documentation and tests.
This PR introduces a new unstable compiler flag called
-Zembed-metadata=[no|yes]
, with the default beingyes
(see #57076 for context). When set tono
, rustc will only store a small metadata stub inside rlibs/dylibs instead of the full metadata, to keep their size smaller. It should be used in combination with--emit=metadata
, so that the users of such a compiled library can still read the metadata from the corresponding.rmeta
file. This comment shows an example of binary/artifact size wins that can be achieved using this approach.Contrary to #120855, this PR only introduces the new flag, along with a couple of run-make tests and documentation, but does not yet use it in bootstrap to actually compile rustc. I plan to do that as a follow-up step (along with integration in Cargo, which should ideally just always pass this flag to reduce the size of target directories).
Fixes #23366
Closes #29511
Fixes #57076
Another attempt of #93945 and #120855.
r? @petrochenkov