Disable debug info compilation in CI to boost performance. #779
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
DJMcNab
approved these changes
Dec 9, 2024
Cargo.toml
Outdated
| @@ -128,5 +128,7 @@ time = "0.3.36" | |||
|
|
|||
| [profile.ci] | |||
| inherits = "dev" | |||
| debug = 0 # Don't compile debug info to reduce compilation artifact size for cache benefits. | |||
| strip = "debuginfo" # Implied with debug = 0 since Rust 1.77, still useful for older. | |||
There was a problem hiding this comment.
This sentence doesn't scan to me - older doesn't really work as a subject. Maybe something like:
Suggested change
| strip = "debuginfo" # Implied with debug = 0 since Rust 1.77, still useful for older. | |
| strip = "debuginfo" # Implied by debug = 0 since Rust 1.77 - but our MSRV is older. |
There was a problem hiding this comment.
It's meant to be copy-pastable and in Xilem's case the MSRV is actually newer than 1.77. I adjusted the comment but made the MSRV reference a bit more conditional.
There was a problem hiding this comment.
MSRV will be 1.82 as soon as this gets updated Peniko or Vello.
There was a problem hiding this comment.
Maybe we should just not have the comment at all? The redundancy doesn't have any real cost
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.
Turning off debug info in CI gives us tiny speedups, with potential for more in some scenarios. Most notably there is 30% space savings on artifact size in Linux, really helping with cache pressure and compression/decompression time.
We don't really need the benefits of debug info in the CI environment. We're not attaching debuggers there and in case of panics we can still get a backtrace. Thus it's just wasted effort to generate the debug info and then to link it in and cache it.
Benchmarks
I did some minor benchmarking on three different OS setups with Rust 1.83. Every step was repeated four times (1 warmup, then 3 for measuring), but stuff like CPU boost frequency etc was not controlled for. Even so, the numbers are useful for ballparking.
I set
CARGO_INCREMENTALto0to match the CI and measuredcargo clippy -p xilem --locked --profile ci --all-features.