Skip to content
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

Add cryptsetup benchmark #5242

Open
jellyfishcake opened this issue Oct 4, 2024 · 0 comments
Open

Add cryptsetup benchmark #5242

jellyfishcake opened this issue Oct 4, 2024 · 0 comments
Labels
good first issue This is a good issue for someone new to PKB

Comments

@jellyfishcake
Copy link
Contributor

https://man7.org/linux/man-pages/man8/cryptsetup-benchmark.8.html

This task adds cryptsetup as a new benchmark for PKB. It can be divided into a few different components:

  1. Add the benchmarking framework
    create cryptsetup_benchmark.py file in linux_benchmarks
    populate BENCHMARK_NAME and BENCHMARK_CONFIG constants so that the benchmark can be found by PKB.
    create GetConfig, Prepare, Run and Cleanup functions handlers with pass/return [] as function content.
    At this point you can run your new benchmark in PKB (though it will not do anything yet).
  2. Install cryptsetup
  • cryptsetup comes with linux distributions so validate that installation is not needed
  1. Add a function in cryptsetup.py that you added to linux_packages with a sensible name, e.g. ParseResults
    Parse results should take a str as input and produce a list of PKB Samples as output. You goal is to parse the output into useful samples, where each sample as a metric name, metric value, metric unit, metric metadata. Each row of output should be a separate metric.
    Test the parser function
@jellyfishcake jellyfishcake added the good first issue This is a good issue for someone new to PKB label Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue This is a good issue for someone new to PKB
Projects
None yet
Development

No branches or pull requests

1 participant