See the overview for an introduction to the project.
Rust is required for this project. To download Rustup and install Rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Linux 5.x+ is required to run this project.
To build this project:
- Checkout
mainbranch from github usinggit clone. - From top-level directory run
cargo build.- For best profiling specify
cargo build --releaseas cargo will default todebug.
- For best profiling specify
To build a sample program:
-
cargo build -p file-io
-
cargo build -p fp-calc
To install this project:
- With the project repository downloaded, run
cargo install --path *ruperf_path*where*ruperf_path*is the path to the ruperf repository on your machine. - For configuration information about
cargo installincluding information about how to specify installation location, etc see documentation - Another option is to build the code using
cargo buildand thencdinto thetargetdirectory and select the target.
-
See
./ruperf --help -
Examples:
-
./ruperf stat -e cycles -e instructions -e task-clock -e L1D-cache-reads ls -a
-
./ruperf test --json -
./ruperf gui
-
-
See our rustdocs for more documentation by running
cargo doc --no-deps --openin the ruperf repository.
Verification is done through a combination of cargo test, manual inspection comparing output of perf stat with output of ruperf on programs as documented in pull request history, and through inspection of contributor code.
Watch our demo video about ruperf on YouTube:
This tool uses the perf_event_open() system call, which requires some special permissions.
While our tool currently checks if perf_event_paranoid is equal to 0,
this is less than ideal is some situations. A way around this is to change
the capabilities of the ruperf executable using setcap.
For Linux 5.8+, use CAP_PERFMON; otherwise use CAP_SYSADMIN.
ruperf is an open source project and is open to recieving contributions!
Please see CONTRIBUTING
We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.