Skip to content

Commit d8513fe

Browse files
committed
doc: update doc/benchmarking.md
1 parent 84e2d5b commit d8513fe

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

doc/benchmarking.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ thread queue, wallet balance.
88
Running
99
---------------------
1010

11-
For benchmarks purposes you only need to compile `bitcoin_bench`. Beware of configuring without `--enable-debug` as this would impact
12-
benchmarking by unlatching log printers and lock analysis.
11+
For benchmarking, you only need to compile `bitcoin_bench`. The bench runner
12+
warns if you configure with `--enable-debug`, but consider if building without
13+
it will impact the benchmark(s) you are interested in by unlatching log printers
14+
and lock analysis.
1315

1416
make -C src bitcoin_bench
1517

@@ -19,19 +21,28 @@ After compiling bitcoin-core, the benchmarks can be run with:
1921

2022
The output will look similar to:
2123
```
22-
| ns/byte | byte/s | error % | benchmark
23-
|--------------------:|--------------------:|--------:|:----------------------------------------------
24-
| 64.13 | 15,592,356.01 | 0.1% | `Base58CheckEncode`
25-
| 24.56 | 40,722,672.68 | 0.2% | `Base58Decode`
24+
| ns/op | op/s | err% | total | benchmark
25+
|--------------------:|--------------------:|--------:|----------:|:----------
26+
| 57,927,463.00 | 17.26 | 3.6% | 0.66 | `AddrManAdd`
27+
| 677,816.00 | 1,475.33 | 4.9% | 0.01 | `AddrManGetAddr`
28+
29+
...
30+
31+
| ns/byte | byte/s | err% | total | benchmark
32+
|--------------------:|--------------------:|--------:|----------:|:----------
33+
| 127.32 | 7,854,302.69 | 0.3% | 0.00 | `Base58CheckEncode`
34+
| 31.95 | 31,303,226.99 | 0.2% | 0.00 | `Base58Decode`
35+
2636
...
2737
```
2838

2939
Help
3040
---------------------
3141

32-
src/bench/bench_bitcoin --help
42+
src/bench/bench_bitcoin -?
3343

34-
To print options like scaling factor or per-benchmark filter.
44+
To print the various options, like listing the benchmarks without running them
45+
or using a regex filter to only run certain benchmarks.
3546

3647
Notes
3748
---------------------

0 commit comments

Comments
 (0)