Commit 23e77009 authored by Florian Fischer's avatar Florian Fischer
Browse files

update Readme

parent 9e05ba8b
...@@ -12,33 +12,38 @@ git clone https://muhq.space/software/allocbench.git ...@@ -12,33 +12,38 @@ git clone https://muhq.space/software/allocbench.git
* make, find, gcc (build dependencies) * make, find, gcc (build dependencies)
* perf (`perf stat -d` is the default command to measure benchmark results) * perf (`perf stat -d` is the default command to measure benchmark results)
* util-linux (`whereis` is used to find system installed allocators) * util-linux (`whereis` is used to find system installed allocators)
* (git to clone allocators in `allocators/{no_falsesharing, BA_allocators}.py`) * (git to clone allocators in `src/allocators/*.py`)
## Usage ## Usage
usage: bench.py [-h] [-ds, --dont-save] [-l LOAD] [-a ALLOCATORS] [-r RUNS] usage: bench.py [-h] [-ds, --dont-save] [-l LOAD] [--analyse] [-r RUNS] [-v]
[-v] [-vdebug] [-b BENCHMARKS [BENCHMARKS ...]] [-ns] [-vdebug] [-b BENCHMARKS [BENCHMARKS ...]]
[-rd RESULTDIR] [--license] [-xb EXCLUDE_BENCHMARKS [EXCLUDE_BENCHMARKS ...]]
[-a ALLOCATORS [ALLOCATORS ...]] [-ns] [-rd RESULTDIR]
benchmark memory allocators [--license]
optional arguments: benchmark memory allocators
-h, --help show this help message and exit
-ds, --dont-save don't save benchmark results in RESULTDIR optional arguments:
-l LOAD, --load LOAD load benchmark results from directory -h, --help show this help message and exit
-a ALLOCATORS, --allocators ALLOCATORS -ds, --dont-save don't save benchmark results in RESULTDIR
load allocator definitions from file -l LOAD, --load LOAD load benchmark results from directory
-r RUNS, --runs RUNS how often the benchmarks run --analyse analyse benchmark behaviour using malt
-v, --verbose more output -r RUNS, --runs RUNS how often the benchmarks run
-vdebug, --verbose-debug -v, --verbose more output
debug output -vdebug, --verbose-debug
-b BENCHMARKS [BENCHMARKS ...], --benchmarks BENCHMARKS [BENCHMARKS ...] debug output
benchmarks to run -b BENCHMARKS [BENCHMARKS ...], --benchmarks BENCHMARKS [BENCHMARKS ...]
-ns, --nosum don't produce plots benchmarks to run
-rd RESULTDIR, --resultdir RESULTDIR -xb EXCLUDE_BENCHMARKS [EXCLUDE_BENCHMARKS ...], --exclude-benchmarks EXCLUDE_BENCHMARKS [EXCLUDE_BENCHMARKS ...]
directory where all results go explicitly excluded benchmarks
--license print license info and exit -a ALLOCATORS [ALLOCATORS ...], --allocators ALLOCATORS [ALLOCATORS ...]
allocators to test
-ns, --nosum don't produce plots
-rd RESULTDIR, --resultdir RESULTDIR
directory where all results go
--license print license info and exit
### Examples ### Examples
...@@ -47,10 +52,10 @@ git clone https://muhq.space/software/allocbench.git ...@@ -47,10 +52,10 @@ git clone https://muhq.space/software/allocbench.git
runs only the loop benchmark for some installed allocators and will put its runs only the loop benchmark for some installed allocators and will put its
results in `$PWD/results/$HOSTNAME/<time>/loop` results in `$PWD/results/$HOSTNAME/<time>/loop`
./bench.py -a allocators/BA_allocators.py ./bench.py -a BA_allocators
builds all allocators used in my [BA thesis](https://muhq.space/ba.html) and runs all builds all allocators used in Florian Fischer's [BA thesis](https://muhq.space/ba.html)
default benchmarks and runs all benchmarks
./bench.py -r 0 -l <path/to/saved/results> ./bench.py -r 0 -l <path/to/saved/results>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment