Add black_box to some benchmarks that need it#23692
Open
nishantc1527 wants to merge 1 commit intobevyengine:mainfrom
Open
Add black_box to some benchmarks that need it#23692nishantc1527 wants to merge 1 commit intobevyengine:mainfrom
nishantc1527 wants to merge 1 commit intobevyengine:mainfrom
Conversation
Contributor
|
Welcome, new contributor! Please make sure you've read our contributing guide, as well as our policy regarding AI usage, and we look forward to reviewing your pull request shortly ✨ |
alice-i-cecile
approved these changes
Apr 6, 2026
Member
|
@mockersf I'm in favor of this, but giving you a heads-up because this will introduce spurious changes in the benchmarks. |
Contributor
|
Could you run before/after on the benchmarks that have changed? That way we can know what to expect in CI if there are any measurable changes. |
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.
Objective
The
black_bxofunction in Criterion is essential to make consistent benchmarks because LLVM likes to optimize things out randomly. It's a very weird and confusing process, it takes into account the size of the overall function and some random other stuff that's impossible to predict. So even though benchmarks work now, they may not work in the future. I wasn't able to reproduce any of this in the current state, but that's because it's so hard to predict LLVM.Fixes #7156
Solution
I looked across the
benchescrate and found a few places that neededblack_box. I didn't do a thorough check, I just kind of skimmed the files to look for things that stood out (constant numbers are usually a good tell, as well as unused variables).Testing
It's a very hard thing to test because it's hard to reproduce. But looking at the docs (https://doc.rust-lang.org/beta/std/hint/fn.black_box.html) it's clear that every place I put it is necessary.