mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 12:32:48 +01:00
33384816b5
13782b8ba8 docs: add perf section to developer docs (James O'Beirne) 58180b5fd4 tests: add utility to easily profile node performance with perf (James O'Beirne) Pull request description: Adds a context manager to easily (and selectively) profile node performance during functional test execution using `perf`. While writing some tests, I encountered some odd bitcoind slowness. I wrote up a utility (`TestNode.profile_with_perf`) that generates performance diagnostics for a node by running `perf` during the execution of a particular region of test code. `perf` usage is detailed in the excellent (and sadly unmerged) https://github.com/bitcoin/bitcoin/pull/12649; all due props to @eklitzke. ### Example ```python with node.profile_with_perf("large-msgs"): for i in range(200): node.p2p.send_message(some_large_msg) node.p2p.sync_with_ping() ``` This generates a perf data file in the test node's datadir (`/tmp/testtxmpod0y/node0/node-0-TestName-large-msgs.perf.data`). Running `perf report` generates nice output about where the node spent most of its time while running that part of the test: ```bash $ perf report -i /tmp/testtxmpod0y/node0/node-0-TestName-large-msgs.perf.data --stdio \ | c++filt \ | less # To display the perf.data header info, please use --header/--header-only options. # # # Total Lost Samples: 0 # # Samples: 135 of event 'cycles:pp' # Event count (approx.): 1458205679493582 # # Children Self Command Shared Object Symbol # ........ ........ ............... ................... ........................................................................................................................................................................................................................................................................ # 70.14% 0.00% bitcoin-net bitcoind [.] CNode::ReceiveMsgBytes(char const*, unsigned int, bool&) | ---CNode::ReceiveMsgBytes(char const*, unsigned int, bool&) 70.14% 0.00% bitcoin-net bitcoind [.] CNetMessage::readData(char const*, unsigned int) | ---CNetMessage::readData(char const*, unsigned int) CNode::ReceiveMsgBytes(char const*, unsigned int, bool&) 35.52% 0.00% bitcoin-net bitcoind [.] std::vector<char, zero_after_free_allocator<char> >::_M_fill_insert(__gnu_cxx::__normal_iterator<char*, std::vector<char, zero_after_free_allocator<char> > >, unsigned long, char const&) | ---std::vector<char, zero_after_free_allocator<char> >::_M_fill_insert(__gnu_cxx::__normal_iterator<char*, std::vector<char, zero_after_free_allocator<char> > >, unsigned long, char const&) CNetMessage::readData(char const*, unsigned int) CNode::ReceiveMsgBytes(char const*, unsigned int, bool&) ... ``` Tree-SHA512: 9ac4ceaa88818d5eca00994e8e3c8ad42ae019550d6583972a0a4f7b0c4f61032e3d0c476b4ae58756bc5eb8f8015a19a7fc26c095bd588f31d49a37ed0c6b3e |
||
|---|---|---|
| .. | ||
| gitian-building | ||
| man | ||
| release-notes/dash | ||
| .gitignore | ||
| assets-attribution.md | ||
| benchmarking.md | ||
| bips.md | ||
| bitcoin_logo_doxygen.png | ||
| build-cross.md | ||
| build-generic.md | ||
| build-netbsd.md | ||
| build-osx.md | ||
| build-unix.md | ||
| build-windows.md | ||
| dash-conf.md | ||
| developer-notes.md | ||
| dnsseed-policy.md | ||
| Doxyfile.in | ||
| files.md | ||
| fuzzing.md | ||
| gitian-building.md | ||
| init.md | ||
| instantsend.md | ||
| JSON-RPC-interface.md | ||
| keepass.md | ||
| masternode-budget.md | ||
| productivity.md | ||
| psbt.md | ||
| README_windows.txt | ||
| README.md | ||
| reduce-memory.md | ||
| reduce-traffic.md | ||
| release-notes.md | ||
| release-process.md | ||
| REST-interface.md | ||
| shared-libraries.md | ||
| tor.md | ||
| translation_process.md | ||
| translation_strings_policy.md | ||
| travis-ci.md | ||
| zmq.md | ||
Dash Core
This is the official reference wallet for Dash digital currency and comprises the backbone of the Dash peer-to-peer network. You can download Dash Core or build it yourself using the guides below.
Running
The following are some helpful notes on how to run Dash Core on your native platform.
Unix
Unpack the files into a directory and run:
bin/dash-qt(GUI) orbin/dashd(headless)
Windows
Unpack the files into a directory, and then run dash-qt.exe.
macOS
Drag Dash Core to your applications folder, and then run Dash Core.
Need Help?
- See the Dash documentation for help and more information.
- Ask for help on Dash Discord
- Ask for help on the Dash Forum
Building
The following are developer notes on how to build Dash Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- macOS Build Notes
- Unix Build Notes
- Windows Build Notes
- OpenBSD Build Notes
- NetBSD Build Notes
- Gitian Building Guide
Development
The Dash Core repo's root README contains relevant information on the development process and automated testing.
- Developer Notes
- Productivity Notes
- Release Notes
- Release Process
- Source Code Documentation TODO
- Translation Process
- Translation Strings Policy
- Travis CI
- JSON-RPC Interface
- Unauthenticated REST Interface
- Shared Libraries
- BIPS
- Dnsseed Policy
- Benchmarking
Resources
- See the Dash Developer Documentation for technical specifications and implementation details.
- Discuss on the Dash Forum, in the Development & Technical Discussion board.
- Discuss on Dash Discord
- Discuss on Dash Developers Discord
Miscellaneous
- Assets Attribution
- dash.conf Configuration File
- Files
- Fuzz-testing
- Reduce Memory
- Reduce Traffic
- Tor Support
- Init Scripts (systemd/upstart/openrc)
- ZMQ
- PSBT support
License
Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.