Automated Themis Core benchmarks #580
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
Let's add some reproducible, verifiable, and automatable benchmarks for Themis performance. We are using Criterion.rs -- a framework in Rust -- but since C is easily callable from Rust, it's not much an issue to use that framework for accurately benchmarking C code. And I don't have to reinvent the wheel and build a benchmarking harness myself as it is usually done in C/C++ world. Currently we cover Secure Cell in Seal mode with master key. More benches will come in later, this is only an example and a primer. We exercise both encryption and decryption code paths. The data does not really matter so we use whatever is easy to get. Message size comparison confirms that encryption and decryption have roughly the same cost and indeed have linear complexity.
Do this for every build, at least to check that they are still buildable. Also run some of them for a modest amount of time and attach benchmark reports to builds. It would be nice to compare base branch with PR branch to see if there are any changes in that. However, with current approach branch switching is kinda involved so we'll add that later.
ilammy
added
core
Oh yeah, one more readme file has been lost during rebases.
Yes, I'm bad at doing git, sorry.
vixentael
approved these changes
Jan 27, 2020
| ``` | ||
|
|
||
| Don’t forget to _reinstall_ Themis Core library every time you make a change in it and want to measure it. | ||
| <!-- TODO: and to pester maintainers to support local builds --> |
Co-Authored-By: vixentael <[email protected]>
6 tasks
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.
Exactly what it says on the tin.
Let's add some reproducible, verifiable, and automatable benchmarks for Themis performance. We are using Criterion.rs – a framework in Rust – but since C is easily callable from Rust, it's not much an issue to use that framework for accurately benchmarking C code. And I don't have to reinvent the wheel and build a benchmarking harness myself as it is usually done in C/C++ world.
Currently we cover Secure Cell in Seal mode with master key. More benches will come in later, this is only an example and a primer. We exercise both encryption and decryption code paths. The data does not really matter so we use whatever is easy to get. Message size comparison confirms that encryption and decryption have roughly the same cost and indeed have linear complexity.
Also, run benchmarks for every build, at least to check that they are still buildable. Run some of them for a modest amount of time and attach benchmark reports to builds.
It would be nice to compare base branch with PR branch to see if there are any changes in that. However, with current approach branch switching is kinda involved so we'll add that later.
You are also welcome to run them on your machines and provide feedback on UX.
Example of benchmark report.
Checklist