[perf] Add some instructions for building/running benchmarks.

This commit is contained in:
Garret Rieger 2022-04-20 18:54:36 +00:00 committed by Behdad Esfahbod
parent cef64b947d
commit 40975fc3c2
1 changed files with 24 additions and 0 deletions

24
perf/README.md Normal file
View File

@ -0,0 +1,24 @@
Benchmarks are implemented using [Google Benchmark](https://github.com/google/benchmark).
To build the benchmarks in this directory you need to set the benchmark
option while configuring the build with meson:
```
meson configure build -Dbenchmark=enabled
```
Then build the benchmark binaries with ninja:
```
ninja -Cbuild perf/benchmark-set
```
Finally, to run one of the benchmarks:
```
./build/perf/benchmark-set
```
It's possible to filter the benchmarks being run and customize the output
via flags to the benchmark binary. See the
[Google Benchmark User Guide](https://github.com/google/benchmark/blob/main/docs/user_guide.md#user-guide) for more details.