Skip to content

Commit c609e10

Browse files
fanquakefanquake
committed
Merge bitcoin/bitcoin#22292: bench, doc: benchmarking updates and fixups
d8513fe doc: update doc/benchmarking.md (Jon Atack) 84e2d5b bench: bench_bitcoin.cpp help fixups (Jon Atack) 10f4ce2 bench: bench.h fixes and improvements (Jon Atack) Pull request description: Fixups and updates I noticed while writing benchmarks for #22284. ACKs for top commit: za-kk: ACK d8513fe theStack: ACK d8513fe 🚤 Tree-SHA512: d494956b5d6a3329e98e8b6f4405a10613b8fce51a04bbf4493d8b3497b8d5b177c1a9a3eeb828796eb4edb92b0ace769595151e223671c0dc8f09bcf631ebb5
2 parents 7a49fdc + d8513fe commit c609e10

File tree

3 files changed

+34
-19
lines changed

3 files changed

+34
-19
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
---------------------

‎src/bench/bench.h‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,19 @@
1818
/*
1919
* Usage:
2020
21-
static void CODE_TO_TIME(benchmark::Bench& bench)
21+
static void NameOfYourBenchmarkFunction(benchmark::Bench& bench)
2222
{
23-
... do any setup needed...
24-
nanobench::Config().run([&] {
25-
... do stuff you want to time...
23+
...do any setup needed...
24+
25+
bench.run([&] {
26+
...do stuff you want to time; refer to src/bench/nanobench.h
27+
for more information and the options that can be passed here...
2628
});
27-
... do any cleanup needed...
29+
30+
...do any cleanup needed...
2831
}
2932
30-
BENCHMARK(CODE_TO_TIME);
33+
BENCHMARK(NameOfYourBenchmarkFunction);
3134
3235
*/
3336

@@ -55,7 +58,8 @@ class BenchRunner
5558

5659
static void RunAll(const Args& args);
5760
};
58-
}
61+
} // namespace benchmark
62+
5963
// BENCHMARK(foo) expands to: benchmark::BenchRunner bench_11foo("foo", foo);
6064
#define BENCHMARK(n) \
6165
benchmark::BenchRunner PASTE2(bench_, PASTE2(__LINE__, n))(STRINGIZE(n), n);

‎src/bench/bench_bitcoin.cpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ static void SetupBenchArgs(ArgsManager& argsman)
1616
{
1717
SetupHelpOptions(argsman);
1818

19-
argsman.AddArg("-list", "List benchmarks without executing them", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
19+
argsman.AddArg("-asymptote=n1,n2,n3,...", "Test asymptotic growth of the runtime of an algorithm, if supported by the benchmark", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
2020
argsman.AddArg("-filter=<regex>", strprintf("Regular expression filter to select benchmark by name (default: %s)", DEFAULT_BENCH_FILTER), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
21-
argsman.AddArg("-asymptote=n1,n2,n3,...", strprintf("Test asymptotic growth of the runtime of an algorithm, if supported by the benchmark"), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
22-
argsman.AddArg("-output_csv=<output.csv>", "Generate CSV file with the most important benchmark results.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
23-
argsman.AddArg("-output_json=<output.json>", "Generate JSON file with all benchmark results.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
21+
argsman.AddArg("-list", "List benchmarks without executing them", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
22+
argsman.AddArg("-output_csv=<output.csv>", "Generate CSV file with the most important benchmark results", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
23+
argsman.AddArg("-output_json=<output.json>", "Generate JSON file with all benchmark results", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
2424
}
2525

2626
// parses a comma separated list like "10,20,30,50"

0 commit comments

Comments
 (0)