Feature cleanup for bench crate #4120
Merged
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
toidiu
reviewed
Jul 27, 2023
| @@ -19,13 +19,17 @@ certs/generate_certs.sh | |||
| cargo bench --config aws-lc-config/s2n.toml | |||
| ``` | |||
|
|
|||
| ### Features | |||
|
|
|||
| Default features (`rustls` and `openssl`) can be disabled by running the benches with `--no-default-features`. The non-default `memory` and `historical-perf` features are used to enable dependencies specific to those types of benches, and are automatically used by the scripts that run those benches. | |||
There was a problem hiding this comment.
Prob dont need this section. Features are pretty well defined in the cargo docs so I dont think we need to explain it here.
There was a problem hiding this comment.
I think this would be good for someone that usually uses C but wants to do benching, but I don't have strong opinions on it.
toidiu
approved these changes
Aug 1, 2023
jmayclin
approved these changes
Aug 1, 2023
| serde_json = { version = "1.0", optional = true } | ||
| semver = { version = "1.0", optional = true } | ||
|
|
||
| [dependencies.plotters] |
There was a problem hiding this comment.
Rather than breaking this out into a separate table, could we keep using the inline syntax?
There was a problem hiding this comment.
We could, but the line would be way too long. Criterion does the same with breaking it out: https://github.com/bheisler/criterion.rs/blob/master/Cargo.toml#L47
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.
Description of changes:
The bench crate has a lot of dependencies that in reality only need to be loaded for certain functionalities. This PR adds feature logic to all of the dependencies.
Call-outs:
I decided to unwrap the subtractive
historical-perffeature into additiverustlsandopenssldefault features. Originally, thehistorical-perffeature was included because using--no-default-featuresjust for historical benching performance felt weird and nonobvious, but separating it out has started to make more sense, especially considering that if run in CI--no-default-featuresto remove rustls and openssl benching might be run more frequently.Testing:
To test this change, run all of the benches, scripts, and binaries, with and without default features. No behaviour should have changed, and this can be confirmed by running benches before and after the changes in this PR.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.