READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

41,142 bytes · SHA-256 78bbc2ce46fb71d9… · View upstream ↗

1// Based on the https://github.com/arun11299/cpp-subprocess project.
2
3/*!
4
5Documentation for C++ subprocessing library.
6
7@copyright The code is licensed under the [MIT
8  License](http://opensource.org/licenses/MIT):
9  <br>
10  Copyright &copy; 2016-2018 Arun Muralidharan.
11  <br>
12  Permission is hereby granted, free of charge, to any person obtaining a copy
13  of this software and associated documentation files (the "Software"), to deal
14  in the Software without restriction, including without limitation the rights
15  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16  copies of the Software, and to permit persons to whom the Software is
17  furnished to do so, subject to the following conditions:
18  <br>
19  The above copyright notice and this permission notice shall be included in
20  all copies or substantial portions of the Software.
21  <br>
22  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28  SOFTWARE.
29
30@author [Arun Muralidharan]
31@see https://github.com/arun11299/cpp-subprocess to download the source code
32
33@version 1.0.0
34*/
35
36#ifndef BITCOIN_UTIL_SUBPROCESS_H
37#define BITCOIN_UTIL_SUBPROCESS_H
38
39#include <util/check.h>
40#include <util/syserror.h>
41
42#include <algorithm>
43#include <csignal>
44#include <cstdio>
45#include <cstdlib>
46#include <cstring>
47#include <exception>
48#include <future>
49#include <initializer_list>
50#include <iostream>
51#include <map>
52#include <memory>
53#include <sstream>
54#include <string>
55#include <vector>
56
57extern "C" {
58#ifdef WIN32
59  #include <windows.h>
60  #include <io.h>
61#else
62  #include <sys/wait.h>
63  #include <unistd.h>
64#endif
65  #include <csignal>
66  #include <fcntl.h>
67  #include <sys/types.h>
68}
69
70// The Microsoft C++ compiler issues deprecation warnings
71// for the standard POSIX function names.
72// Its preferred implementations have a leading underscore.
73// See: https://learn.microsoft.com/en-us/cpp/c-runtime-library/compatibility.
74#if (defined _MSC_VER)
75  #define subprocess_close _close
76  #define subprocess_fileno _fileno
77  #define subprocess_open _open
78  #define subprocess_write _write
79#else
80  #define subprocess_close close
81  #define subprocess_fileno fileno
82  #define subprocess_open open
83  #define subprocess_write write
84#endif
85
86/*!
87 * Getting started with reading this source code.
88 * The source is mainly divided into four parts:
89 * 1. Exception Classes:
90 *    These are very basic exception classes derived from
91 *    runtime_error exception.
92 *    There are two types of exception thrown from subprocess
93 *    library: OSError and CalledProcessError
94 *
95 * 2. Popen Class
96 *    This is the main class the users will deal with. It
97 *    provides with all the API's to deal with processes.
98 *
99 * 3. Util namespace
100 *    It includes some helper functions to split/join a string,
101 *    reading from file descriptors, waiting on a process, fcntl
102 *    options on file descriptors etc.
103 *
104 * 4. Detail namespace
105 *    This includes some metaprogramming and helper classes.
106 */
107
108
109namespace subprocess {
110
111// Max buffer size allocated on stack for read error
112// from pipe
113inline constexpr size_t SP_MAX_ERR_BUF_SIZ = 1024;
114
115// Default buffer capacity for OutBuffer and ErrBuffer.
116// If the data exceeds this capacity, the buffer size is grown
117// by 1.5 times its previous capacity
118inline constexpr size_t DEFAULT_BUF_CAP_BYTES = 8192;
119
120
121/*-----------------------------------------------
122 *    EXCEPTION CLASSES
123 *-----------------------------------------------
124 */
125
126/*!
127 * class: CalledProcessError
128 * Thrown when there was error executing the command.
129 * Check Popen class API's to know when this exception
130 * can be thrown.
131 *
132 */
133class CalledProcessError: public std::runtime_error
134{
135public:
136  int retcode;
137  CalledProcessError(const std::string& error_msg, int retcode):
138    std::runtime_error(error_msg), retcode(retcode)
139  {}
140};
141
142
143/*!
144 * class: OSError
145 * Thrown when some system call fails to execute or give result.
146 * The exception message contains the name of the failed system call
147 * with the stringisized errno code.
148 * Check Popen class API's to know when this exception would be
149 * thrown.
150 * Its usual that the API exception specification would have
151 * this exception together with CalledProcessError.
152 */
153class OSError: public std::runtime_error
154{
155public:
156  OSError(const std::string& err_msg, int err_code):
157    std::runtime_error(err_msg + ": " + SysErrorString(err_code))
158  {}
159};
160
161//--------------------------------------------------------------------
162namespace util
163{
164#ifdef WIN32
165  inline void quote_argument(const std::string &argument, std::string &command_line,
166                      bool force)
167  {
168    constexpr char quote = '"';
169    constexpr char backslash = '\\';
170
171    //
172    // Unless we're told otherwise, don't quote unless we actually
173    // need to do so --- hopefully avoid problems if programs won't
174    // parse quotes properly
175    //
176
177    if (force == false && argument.empty() == false &&
178        argument.find_first_of(" \t\n\v") == argument.npos) {
179      command_line.append(argument);
180    }
181    else {
182      command_line.push_back(quote);
183
184      for (auto it = argument.begin();; ++it) {
185        unsigned number_backslashes = 0;
186
187        while (it != argument.end() && *it == backslash) {
188          ++it;
189          ++number_backslashes;
190        }
191
192        if (it == argument.end()) {
193
194          //
195          // Escape all backslashes, but let the terminating
196          // double quotation mark we add below be interpreted
197          // as a metacharacter.
198          //
199
200          command_line.append(number_backslashes * 2, backslash);
201          break;
202        }
203        else if (*it == quote) {
204
205          //
206          // Escape all backslashes and the following
207          // double quotation mark.
208          //
209
210          command_line.append(number_backslashes * 2 + 1, backslash);
211          command_line.push_back(*it);
212        }
213        else {
214
215          //
216          // Backslashes aren't special here.
217          //
218
219          command_line.append(number_backslashes, backslash);
220          command_line.push_back(*it);
221        }
222      }
223
224      command_line.push_back(quote);
225    }
226  }
227
228  inline std::string get_last_error(DWORD errorMessageID)
229  {
230    if (errorMessageID == 0)
231      return std::string();
232
233    LPSTR messageBuffer = nullptr;
234    size_t size = FormatMessageA(
235        FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
236            FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_MAX_WIDTH_MASK,
237        NULL, errorMessageID, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
238        (LPSTR)&messageBuffer, 0, NULL);
239
240    std::string message(messageBuffer, size);
241
242    LocalFree(messageBuffer);
243
244    return message;
245  }
246
247  inline FILE *file_from_handle(HANDLE h, const char *mode)
248  {
249    int md;
250    if (!mode) {

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.