Page MenuHomePhabricator
Files F10615344

bench_bitcoin.cpp
No OneTemporary
Actions

bench_bitcoin.cpp
View Options

// Copyright (c) 2015-2019 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <bench/bench.h>
#include <clientversion.h>
#include <common/args.h>
#include <crypto/sha256.h>
#include <util/fs.h>
#include <util/strencodings.h>
#include <chrono>
#include <cstdint>
#include <iostream>
#include <sstream>
#include <vector>
static const char *DEFAULT_BENCH_FILTER = ".*";
static constexpr int64_t DEFAULT_MIN_TIME_MS{10};
static void SetupBenchArgs(ArgsManager &argsman) {
SetupHelpOptions(argsman);
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);
argsman.AddArg("-filter=<regex>",
strprintf("Regular expression filter to select benchmark by "
"name (default: %s)",
DEFAULT_BENCH_FILTER),
ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-list", "List benchmarks without executing them",
ArgsManager::ALLOW_BOOL, OptionsCategory::OPTIONS);
argsman.AddArg(
"-min_time=<milliseconds>",
strprintf(
"Minimum runtime per benchmark, in milliseconds (default: %d)",
DEFAULT_MIN_TIME_MS),
ArgsManager::ALLOW_INT, OptionsCategory::OPTIONS);
argsman.AddArg(
"-output_csv=<output.csv>",
"Generate CSV file with the most important benchmark results",
ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-output_json=<output.json>",
"Generate JSON file with all benchmark results",
ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
}
// parses a comma separated list like "10,20,30,50"
static std::vector<double> parseAsymptote(const std::string &str) {
std::stringstream ss(str);
std::vector<double> numbers;
double d;
char c;
while (ss >> d) {
numbers.push_back(d);
ss >> c;
}
return numbers;
}
int main(int argc, char **argv) {
ArgsManager argsman;
SetupBenchArgs(argsman);
SHA256AutoDetect();
std::string error;
if (!argsman.ParseParameters(argc, argv, error)) {
tfm::format(std::cerr, "Error parsing command line arguments: %s\n",
error);
return EXIT_FAILURE;
}
if (HelpRequested(argsman)) {
std::cout
<< "Usage: bitcoin-bench [options]\n"
"\n"
<< argsman.GetHelpMessage()
<< "Description:\n"
"\n"
" bitcoin-bench executes microbenchmarks. The quality of the "
"benchmark results\n"
" highly depend on the stability of the machine. It can "
"sometimes be difficult\n"
" to get stable, repeatable results, so here are a few tips:\n"
"\n"
" * Use pyperf [1] to disable frequency scaling, turbo boost "
"etc. For best\n"
" results, use CPU pinning and CPU isolation (see [2]).\n"
"\n"
" * Each call of run() should do exactly the same work. E.g. "
"inserting into\n"
" a std::vector doesn't do that as it will reallocate on "
"certain calls. Make\n"
" sure each run has exactly the same preconditions.\n"
"\n"
" * If results are still not reliable, increase runtime with "
"e.g.\n"
" -min_time=5000 to let a benchmark run for at least 5 "
"seconds.\n"
"\n"
" * bitcoin-bench uses nanobench [3] for which there is "
"extensive\n"
" documentation available online.\n"
"\n"
"Environment Variables:\n"
"\n"
" To attach a profiler you can run a benchmark in endless "
"mode. This can be\n"
" done with the environment variable NANOBENCH_ENDLESS. E.g. "
"like so:\n"
"\n"
" NANOBENCH_ENDLESS=MuHash ./bitcoin-bench -filter=MuHash\n"
"\n"
" In rare cases it can be useful to suppress stability "
"warnings. This can be\n"
" done with the environment variable "
"NANOBENCH_SUPPRESS_WARNINGS, e.g:\n"
"\n"
" NANOBENCH_SUPPRESS_WARNINGS=1 ./bitcoin-bench\n"
"\n"
"Notes:\n"
"\n"
" 1. pyperf\n"
" https://github.com/psf/pyperf\n"
"\n"
" 2. CPU pinning & isolation\n"
" https://pyperf.readthedocs.io/en/latest/system.html\n"
"\n"
" 3. nanobench\n"
" https://github.com/martinus/nanobench\n"
"\n";
return EXIT_SUCCESS;
}
benchmark::Args args;
args.asymptote = parseAsymptote(argsman.GetArg("-asymptote", ""));
args.is_list_only = argsman.GetBoolArg("-list", false);
args.min_time = std::chrono::milliseconds(
argsman.GetIntArg("-min_time", DEFAULT_MIN_TIME_MS));
args.output_csv = argsman.GetPathArg("-output_csv");
args.output_json = argsman.GetPathArg("-output_json");
args.regex_filter = argsman.GetArg("-filter", DEFAULT_BENCH_FILTER);
benchmark::BenchRunner::RunAll(args);
return EXIT_SUCCESS;
}

File Metadata

Mime Type
text/x-c
Expires
Sat, Nov 23, 10:05 (1 d, 5 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4518692
Default Alt Text
bench_bitcoin.cpp (5 KB)

Event Timeline