History

Wladimir J. van der Laan 4ebe2f6e75 Merge #18011 : Replace current benchmarking framework with nanobench `78c312c983` Replace current benchmarking framework with nanobench (Martin Ankerl) Pull request description: Replace current benchmarking framework with nanobench This replaces the current benchmarking framework with nanobench [1], an MIT licensed single-header benchmarking library, of which I am the autor. This has in my opinion several advantages, especially on Linux: * fast: Running all benchmarks takes ~6 seconds instead of 4m13s on an Intel i7-8700 CPU @ 3.20GHz. * accurate: I ran e.g. the benchmark for SipHash_32b 10 times and calculate standard deviation / mean = coefficient of variation: * 0.57% CV for old benchmarking framework * 0.20% CV for nanobench So the benchmark results with nanobench seem to vary less than with the old framework. * It automatically determines runtime based on clock precision, no need to specify number of evaluations. * measure instructions, cycles, branches, instructions per cycle, branch misses (only Linux, when performance counters are available) * output in markdown table format. * Warn about unstable environment (frequency scaling, turbo, ...) * For better profiling, it is possible to set the environment variable NANOBENCH_ENDLESS to force endless running of a particular benchmark without the need to recompile. This makes it to e.g. run "perf top" and look at hotspots. Here is an example copy & pasted from the terminal output: \| ns/byte \| byte/s \| err% \| ins/byte \| cyc/byte \| IPC \| bra/byte \| miss% \| total \| benchmark \|--------------------:\|--------------------:\|--------:\|----------------:\|----------------:\|-------:\|---------------:\|--------:\|----------:\|:---------- \| 2.52 \| 396,529,415.94 \| 0.6% \| 25.42 \| 8.02 \| 3.169 \| 0.06 \| 0.0% \| 0.03 \| `bench/crypto_hash.cpp RIPEMD160` \| 1.87 \| 535,161,444.83 \| 0.3% \| 21.36 \| 5.95 \| 3.589 \| 0.06 \| 0.0% \| 0.02 \| `bench/crypto_hash.cpp SHA1` \| 3.22 \| 310,344,174.79 \| 1.1% \| 36.80 \| 10.22 \| 3.601 \| 0.09 \| 0.0% \| 0.04 \| `bench/crypto_hash.cpp SHA256` \| 2.01 \| 496,375,796.23 \| 0.0% \| 18.72 \| 6.43 \| 2.911 \| 0.01 \| 1.0% \| 0.00 \| `bench/crypto_hash.cpp SHA256D64_1024` \| 7.23 \| 138,263,519.35 \| 0.1% \| 82.66 \| 23.11 \| 3.577 \| 1.63 \| 0.1% \| 0.00 \| `bench/crypto_hash.cpp SHA256_32b` \| 3.04 \| 328,780,166.40 \| 0.3% \| 35.82 \| 9.69 \| 3.696 \| 0.03 \| 0.0% \| 0.03 \| `bench/crypto_hash.cpp SHA512` [1] https://github.com/martinus/nanobench ACKs for top commit: laanwj: ACK `78c312c983` Tree-SHA512: 9e18770b18b6f95a7d0105a4a5497d31cf4eb5efe6574f4482f6f1b4c88d7e0946b9a4a1e9e8e6ecbf41a3f2d7571240677dcb45af29a6f0584e89b25f32e49e		4 years ago
..
man	doc: remove OpenSSL from build instructions and licensing info	5 years ago
release-notes	doc: Add release-notes-0.20.0.md	4 years ago
.gitignore	…
Doxyfile.in	test: Add crc32c exception to various linters and generation scripts	5 years ago
JSON-RPC-interface.md	…
README.md	doc: Update webchat URLs in README.md	5 years ago
README_doxygen.md	doc: Improve doxygen readme navigation section	5 years ago
README_windows.txt	…
REST-interface.md	Merge #19390 : doc/REST-interface: Remove stale info	4 years ago
assets-attribution.md	…
benchmarking.md	Replace current benchmarking framework with nanobench	4 years ago
bips.md	doc: Update doc/bips.md with recent changes in master	5 years ago
bitcoin-conf.md	doc: add default bitcoin.conf locations	5 years ago
bitcoin_logo_doxygen.png	…
build-freebsd.md	doc: mention MAKE=gmake workaround when building on a BSD	5 years ago
build-netbsd.md	doc: mention MAKE=gmake workaround when building on a BSD	5 years ago
build-openbsd.md	doc: mention MAKE=gmake workaround when building on a BSD	5 years ago
build-osx.md	Merge #18070 : doc: add note about `brew doctor`	5 years ago
build-unix.md	doc: remove Boost Chrono from install docs	5 years ago
build-windows.md	Add Windows WSL build recommendation to temporarily disable Win32 PE support.	4 years ago
dependencies.md	build: Set libevent minimum version to 2.0.21	5 years ago
descriptors.md	Output a descriptor in createmultisig and addmultisigaddress	5 years ago
developer-notes.md	Merge #19258 : doc: improve subtree check instructions	4 years ago
dnsseed-policy.md	…
files.md	Add <datadir>/settings.json persistent settings storage.	4 years ago
fuzzing.md	doc: afl fuzzing comment about afl-gcc and afl-g++	4 years ago
gitian-building.md	…
init.md	fixing documentation to not require rpcpassword	5 years ago
multiprocess.md	build: multiprocess autotools changes	5 years ago
productivity.md	doc: Drop protobuf stuff	5 years ago
psbt.md	…
reduce-memory.md	doc: block-relay-only is not blocksonly	5 years ago
reduce-traffic.md	doc: Use precise permission flags where possible	4 years ago
release-notes-16525.md	Additionally treat Tx.nVersion as unsigned in joinpsbts	5 years ago
release-notes.md	gui, doc: rm Ban Score in GUI Peers window/release notes updates	4 years ago
release-process.md	[doc] fix git add argument	5 years ago
shared-libraries.md	…
tor.md	Elaborate on the need to re-login on Debian-based systems to use tor following usermod	5 years ago
translation_process.md	build: Factor out qt translations from build system	5 years ago
translation_strings_policy.md	doc: Do not translate technical or extremely rare errors	5 years ago
zmq.md	Add a link from ZMQ doc to ZMQ example in contrib/	5 years ago

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

bin/bitcoin-qt (GUI) or
bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

See the documentation at the Bitcoin Wiki for help and more information.
Ask for help on #bitcoin on Freenode. If you don't have an IRC client, use webchat here.
Ask for help on the BitcoinTalk forums, in the Technical Support board.

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client, use webchat here.
Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client, use webchat here.

Miscellaneous

License

Distributed under the MIT software license.