Header include guideline
[bitcoinplatinum.git] / src / init.cpp
blob18ca93239a5cfa34516933cf7e28fcf5b6adbb98
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
6 #if defined(HAVE_CONFIG_H)
7 #include "config/bitcoin-config.h"
8 #endif
10 #include "init.h"
12 #include "addrman.h"
13 #include "amount.h"
14 #include "chain.h"
15 #include "chainparams.h"
16 #include "checkpoints.h"
17 #include "compat/sanity.h"
18 #include "consensus/validation.h"
19 #include "fs.h"
20 #include "httpserver.h"
21 #include "httprpc.h"
22 #include "key.h"
23 #include "validation.h"
24 #include "miner.h"
25 #include "netbase.h"
26 #include "net.h"
27 #include "net_processing.h"
28 #include "policy/feerate.h"
29 #include "policy/fees.h"
30 #include "policy/policy.h"
31 #include "rpc/server.h"
32 #include "rpc/register.h"
33 #include "rpc/blockchain.h"
34 #include "script/standard.h"
35 #include "script/sigcache.h"
36 #include "scheduler.h"
37 #include "timedata.h"
38 #include "txdb.h"
39 #include "txmempool.h"
40 #include "torcontrol.h"
41 #include "ui_interface.h"
42 #include "util.h"
43 #include "utilmoneystr.h"
44 #include "validationinterface.h"
45 #ifdef ENABLE_WALLET
46 #include "wallet/wallet.h"
47 #endif
48 #include "warnings.h"
49 #include <stdint.h>
50 #include <stdio.h>
51 #include <memory>
53 #ifndef WIN32
54 #include <signal.h>
55 #endif
57 #include <boost/algorithm/string/classification.hpp>
58 #include <boost/algorithm/string/replace.hpp>
59 #include <boost/algorithm/string/split.hpp>
60 #include <boost/bind.hpp>
61 #include <boost/interprocess/sync/file_lock.hpp>
62 #include <boost/thread.hpp>
63 #include <openssl/crypto.h>
65 #if ENABLE_ZMQ
66 #include "zmq/zmqnotificationinterface.h"
67 #endif
69 bool fFeeEstimatesInitialized = false;
70 static const bool DEFAULT_PROXYRANDOMIZE = true;
71 static const bool DEFAULT_REST_ENABLE = false;
72 static const bool DEFAULT_DISABLE_SAFEMODE = false;
73 static const bool DEFAULT_STOPAFTERBLOCKIMPORT = false;
75 std::unique_ptr<CConnman> g_connman;
76 std::unique_ptr<PeerLogicValidation> peerLogic;
78 #if ENABLE_ZMQ
79 static CZMQNotificationInterface* pzmqNotificationInterface = NULL;
80 #endif
82 #ifdef WIN32
83 // Win32 LevelDB doesn't use filedescriptors, and the ones used for
84 // accessing block files don't count towards the fd_set size limit
85 // anyway.
86 #define MIN_CORE_FILEDESCRIPTORS 0
87 #else
88 #define MIN_CORE_FILEDESCRIPTORS 150
89 #endif
91 /** Used to pass flags to the Bind() function */
92 enum BindFlags {
93 BF_NONE = 0,
94 BF_EXPLICIT = (1U << 0),
95 BF_REPORT_ERROR = (1U << 1),
96 BF_WHITELIST = (1U << 2),
99 static const char* FEE_ESTIMATES_FILENAME="fee_estimates.dat";
101 //////////////////////////////////////////////////////////////////////////////
103 // Shutdown
107 // Thread management and startup/shutdown:
109 // The network-processing threads are all part of a thread group
110 // created by AppInit() or the Qt main() function.
112 // A clean exit happens when StartShutdown() or the SIGTERM
113 // signal handler sets fRequestShutdown, which triggers
114 // the DetectShutdownThread(), which interrupts the main thread group.
115 // DetectShutdownThread() then exits, which causes AppInit() to
116 // continue (it .joins the shutdown thread).
117 // Shutdown() is then
118 // called to clean up database connections, and stop other
119 // threads that should only be stopped after the main network-processing
120 // threads have exited.
122 // Shutdown for Qt is very similar, only it uses a QTimer to detect
123 // fRequestShutdown getting set, and then does the normal Qt
124 // shutdown thing.
127 std::atomic<bool> fRequestShutdown(false);
128 std::atomic<bool> fDumpMempoolLater(false);
130 void StartShutdown()
132 fRequestShutdown = true;
134 bool ShutdownRequested()
136 return fRequestShutdown;
140 * This is a minimally invasive approach to shutdown on LevelDB read errors from the
141 * chainstate, while keeping user interface out of the common library, which is shared
142 * between bitcoind, and bitcoin-qt and non-server tools.
144 class CCoinsViewErrorCatcher : public CCoinsViewBacked
146 public:
147 CCoinsViewErrorCatcher(CCoinsView* view) : CCoinsViewBacked(view) {}
148 bool GetCoin(const COutPoint &outpoint, Coin &coin) const override {
149 try {
150 return CCoinsViewBacked::GetCoin(outpoint, coin);
151 } catch(const std::runtime_error& e) {
152 uiInterface.ThreadSafeMessageBox(_("Error reading from database, shutting down."), "", CClientUIInterface::MSG_ERROR);
153 LogPrintf("Error reading from database: %s\n", e.what());
154 // Starting the shutdown sequence and returning false to the caller would be
155 // interpreted as 'entry not found' (as opposed to unable to read data), and
156 // could lead to invalid interpretation. Just exit immediately, as we can't
157 // continue anyway, and all writes should be atomic.
158 abort();
161 // Writes do not need similar protection, as failure to write is handled by the caller.
164 static CCoinsViewDB *pcoinsdbview = NULL;
165 static CCoinsViewErrorCatcher *pcoinscatcher = NULL;
166 static std::unique_ptr<ECCVerifyHandle> globalVerifyHandle;
168 void Interrupt(boost::thread_group& threadGroup)
170 InterruptHTTPServer();
171 InterruptHTTPRPC();
172 InterruptRPC();
173 InterruptREST();
174 InterruptTorControl();
175 if (g_connman)
176 g_connman->Interrupt();
177 threadGroup.interrupt_all();
180 void Shutdown()
182 LogPrintf("%s: In progress...\n", __func__);
183 static CCriticalSection cs_Shutdown;
184 TRY_LOCK(cs_Shutdown, lockShutdown);
185 if (!lockShutdown)
186 return;
188 /// Note: Shutdown() must be able to handle cases in which initialization failed part of the way,
189 /// for example if the data directory was found to be locked.
190 /// Be sure that anything that writes files or flushes caches only does this if the respective
191 /// module was initialized.
192 RenameThread("bitcoin-shutoff");
193 mempool.AddTransactionsUpdated(1);
195 StopHTTPRPC();
196 StopREST();
197 StopRPC();
198 StopHTTPServer();
199 #ifdef ENABLE_WALLET
200 if (pwalletMain)
201 pwalletMain->Flush(false);
202 #endif
203 MapPort(false);
204 UnregisterValidationInterface(peerLogic.get());
205 peerLogic.reset();
206 g_connman.reset();
208 StopTorControl();
209 UnregisterNodeSignals(GetNodeSignals());
210 if (fDumpMempoolLater && GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
211 DumpMempool();
214 if (fFeeEstimatesInitialized)
216 ::feeEstimator.FlushUnconfirmed(::mempool);
217 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
218 CAutoFile est_fileout(fsbridge::fopen(est_path, "wb"), SER_DISK, CLIENT_VERSION);
219 if (!est_fileout.IsNull())
220 ::feeEstimator.Write(est_fileout);
221 else
222 LogPrintf("%s: Failed to write fee estimates to %s\n", __func__, est_path.string());
223 fFeeEstimatesInitialized = false;
227 LOCK(cs_main);
228 if (pcoinsTip != NULL) {
229 FlushStateToDisk();
231 delete pcoinsTip;
232 pcoinsTip = NULL;
233 delete pcoinscatcher;
234 pcoinscatcher = NULL;
235 delete pcoinsdbview;
236 pcoinsdbview = NULL;
237 delete pblocktree;
238 pblocktree = NULL;
240 #ifdef ENABLE_WALLET
241 if (pwalletMain)
242 pwalletMain->Flush(true);
243 #endif
245 #if ENABLE_ZMQ
246 if (pzmqNotificationInterface) {
247 UnregisterValidationInterface(pzmqNotificationInterface);
248 delete pzmqNotificationInterface;
249 pzmqNotificationInterface = NULL;
251 #endif
253 #ifndef WIN32
254 try {
255 fs::remove(GetPidFile());
256 } catch (const fs::filesystem_error& e) {
257 LogPrintf("%s: Unable to remove pidfile: %s\n", __func__, e.what());
259 #endif
260 UnregisterAllValidationInterfaces();
261 #ifdef ENABLE_WALLET
262 delete pwalletMain;
263 pwalletMain = NULL;
264 #endif
265 globalVerifyHandle.reset();
266 ECC_Stop();
267 LogPrintf("%s: done\n", __func__);
271 * Signal handlers are very limited in what they are allowed to do.
272 * The execution context the handler is invoked in is not guaranteed,
273 * so we restrict handler operations to just touching variables:
275 static void HandleSIGTERM(int)
277 fRequestShutdown = true;
280 static void HandleSIGHUP(int)
282 fReopenDebugLog = true;
285 #ifndef WIN32
286 static void registerSignalHandler(int signal, void(*handler)(int))
288 struct sigaction sa;
289 sa.sa_handler = handler;
290 sigemptyset(&sa.sa_mask);
291 sa.sa_flags = 0;
292 sigaction(signal, &sa, NULL);
294 #endif
296 bool static Bind(CConnman& connman, const CService &addr, unsigned int flags) {
297 if (!(flags & BF_EXPLICIT) && IsLimited(addr))
298 return false;
299 std::string strError;
300 if (!connman.BindListenPort(addr, strError, (flags & BF_WHITELIST) != 0)) {
301 if (flags & BF_REPORT_ERROR)
302 return InitError(strError);
303 return false;
305 return true;
307 void OnRPCStarted()
309 uiInterface.NotifyBlockTip.connect(&RPCNotifyBlockChange);
312 void OnRPCStopped()
314 uiInterface.NotifyBlockTip.disconnect(&RPCNotifyBlockChange);
315 RPCNotifyBlockChange(false, nullptr);
316 cvBlockChange.notify_all();
317 LogPrint(BCLog::RPC, "RPC stopped.\n");
320 void OnRPCPreCommand(const CRPCCommand& cmd)
322 // Observe safe mode
323 std::string strWarning = GetWarnings("rpc");
324 if (strWarning != "" && !GetBoolArg("-disablesafemode", DEFAULT_DISABLE_SAFEMODE) &&
325 !cmd.okSafeMode)
326 throw JSONRPCError(RPC_FORBIDDEN_BY_SAFE_MODE, std::string("Safe mode: ") + strWarning);
329 std::string HelpMessage(HelpMessageMode mode)
331 const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
332 const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
333 const auto defaultChainParams = CreateChainParams(CBaseChainParams::MAIN);
334 const auto testnetChainParams = CreateChainParams(CBaseChainParams::TESTNET);
335 const bool showDebug = GetBoolArg("-help-debug", false);
337 // When adding new options to the categories, please keep and ensure alphabetical ordering.
338 // Do not translate _(...) -help-debug options, Many technical terms, and only a very small audience, so is unnecessary stress to translators.
339 std::string strUsage = HelpMessageGroup(_("Options:"));
340 strUsage += HelpMessageOpt("-?", _("Print this help message and exit"));
341 strUsage += HelpMessageOpt("-version", _("Print version and exit"));
342 strUsage += HelpMessageOpt("-alertnotify=<cmd>", _("Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message)"));
343 strUsage += HelpMessageOpt("-blocknotify=<cmd>", _("Execute command when the best block changes (%s in cmd is replaced by block hash)"));
344 if (showDebug)
345 strUsage += HelpMessageOpt("-blocksonly", strprintf(_("Whether to operate in a blocks only mode (default: %u)"), DEFAULT_BLOCKSONLY));
346 strUsage +=HelpMessageOpt("-assumevalid=<hex>", strprintf(_("If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: %s, testnet: %s)"), defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnetChainParams->GetConsensus().defaultAssumeValid.GetHex()));
347 strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
348 if (mode == HMM_BITCOIND)
350 #if HAVE_DECL_DAEMON
351 strUsage += HelpMessageOpt("-daemon", _("Run in the background as a daemon and accept commands"));
352 #endif
354 strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
355 strUsage += HelpMessageOpt("-dbcache=<n>", strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache));
356 if (showDebug)
357 strUsage += HelpMessageOpt("-feefilter", strprintf("Tell other nodes to filter invs to us by our mempool min fee (default: %u)", DEFAULT_FEEFILTER));
358 strUsage += HelpMessageOpt("-loadblock=<file>", _("Imports blocks from external blk000??.dat file on startup"));
359 strUsage += HelpMessageOpt("-maxorphantx=<n>", strprintf(_("Keep at most <n> unconnectable transactions in memory (default: %u)"), DEFAULT_MAX_ORPHAN_TRANSACTIONS));
360 strUsage += HelpMessageOpt("-maxmempool=<n>", strprintf(_("Keep the transaction memory pool below <n> megabytes (default: %u)"), DEFAULT_MAX_MEMPOOL_SIZE));
361 strUsage += HelpMessageOpt("-mempoolexpiry=<n>", strprintf(_("Do not keep transactions in the mempool longer than <n> hours (default: %u)"), DEFAULT_MEMPOOL_EXPIRY));
362 strUsage += HelpMessageOpt("-persistmempool", strprintf(_("Whether to save the mempool on shutdown and load on restart (default: %u)"), DEFAULT_PERSIST_MEMPOOL));
363 strUsage += HelpMessageOpt("-blockreconstructionextratxn=<n>", strprintf(_("Extra transactions to keep in memory for compact block reconstructions (default: %u)"), DEFAULT_BLOCK_RECONSTRUCTION_EXTRA_TXN));
364 strUsage += HelpMessageOpt("-par=<n>", strprintf(_("Set the number of script verification threads (%u to %d, 0 = auto, <0 = leave that many cores free, default: %d)"),
365 -GetNumCores(), MAX_SCRIPTCHECK_THREADS, DEFAULT_SCRIPTCHECK_THREADS));
366 #ifndef WIN32
367 strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
368 #endif
369 strUsage += HelpMessageOpt("-prune=<n>", strprintf(_("Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is incompatible with -txindex and -rescan. "
370 "Warning: Reverting this setting requires re-downloading the entire blockchain. "
371 "(default: 0 = disable pruning blocks, 1 = allow manual pruning via RPC, >%u = automatically prune block files to stay under the specified target size in MiB)"), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
372 strUsage += HelpMessageOpt("-reindex-chainstate", _("Rebuild chain state from the currently indexed blocks"));
373 strUsage += HelpMessageOpt("-reindex", _("Rebuild chain state and block index from the blk*.dat files on disk"));
374 #ifndef WIN32
375 strUsage += HelpMessageOpt("-sysperms", _("Create new files with system default permissions, instead of umask 077 (only effective with disabled wallet functionality)"));
376 #endif
377 strUsage += HelpMessageOpt("-txindex", strprintf(_("Maintain a full transaction index, used by the getrawtransaction rpc call (default: %u)"), DEFAULT_TXINDEX));
379 strUsage += HelpMessageGroup(_("Connection options:"));
380 strUsage += HelpMessageOpt("-addnode=<ip>", _("Add a node to connect to and attempt to keep the connection open"));
381 strUsage += HelpMessageOpt("-banscore=<n>", strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), DEFAULT_BANSCORE_THRESHOLD));
382 strUsage += HelpMessageOpt("-bantime=<n>", strprintf(_("Number of seconds to keep misbehaving peers from reconnecting (default: %u)"), DEFAULT_MISBEHAVING_BANTIME));
383 strUsage += HelpMessageOpt("-bind=<addr>", _("Bind to given address and always listen on it. Use [host]:port notation for IPv6"));
384 strUsage += HelpMessageOpt("-connect=<ip>", _("Connect only to the specified node(s); -connect=0 disables automatic connections"));
385 strUsage += HelpMessageOpt("-discover", _("Discover own IP addresses (default: 1 when listening and no -externalip or -proxy)"));
386 strUsage += HelpMessageOpt("-dns", _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + strprintf(_("(default: %u)"), DEFAULT_NAME_LOOKUP));
387 strUsage += HelpMessageOpt("-dnsseed", _("Query for peer addresses via DNS lookup, if low on addresses (default: 1 unless -connect used)"));
388 strUsage += HelpMessageOpt("-externalip=<ip>", _("Specify your own public address"));
389 strUsage += HelpMessageOpt("-forcednsseed", strprintf(_("Always query for peer addresses via DNS lookup (default: %u)"), DEFAULT_FORCEDNSSEED));
390 strUsage += HelpMessageOpt("-listen", _("Accept connections from outside (default: 1 if no -proxy or -connect)"));
391 strUsage += HelpMessageOpt("-listenonion", strprintf(_("Automatically create Tor hidden service (default: %d)"), DEFAULT_LISTEN_ONION));
392 strUsage += HelpMessageOpt("-maxconnections=<n>", strprintf(_("Maintain at most <n> connections to peers (default: %u)"), DEFAULT_MAX_PEER_CONNECTIONS));
393 strUsage += HelpMessageOpt("-maxreceivebuffer=<n>", strprintf(_("Maximum per-connection receive buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXRECEIVEBUFFER));
394 strUsage += HelpMessageOpt("-maxsendbuffer=<n>", strprintf(_("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)"), DEFAULT_MAXSENDBUFFER));
395 strUsage += HelpMessageOpt("-maxtimeadjustment", strprintf(_("Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: %u seconds)"), DEFAULT_MAX_TIME_ADJUSTMENT));
396 strUsage += HelpMessageOpt("-onion=<ip:port>", strprintf(_("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: %s)"), "-proxy"));
397 strUsage += HelpMessageOpt("-onlynet=<net>", _("Only connect to nodes in network <net> (ipv4, ipv6 or onion)"));
398 strUsage += HelpMessageOpt("-permitbaremultisig", strprintf(_("Relay non-P2SH multisig (default: %u)"), DEFAULT_PERMIT_BAREMULTISIG));
399 strUsage += HelpMessageOpt("-peerbloomfilters", strprintf(_("Support filtering of blocks and transaction with bloom filters (default: %u)"), DEFAULT_PEERBLOOMFILTERS));
400 strUsage += HelpMessageOpt("-port=<port>", strprintf(_("Listen for connections on <port> (default: %u or testnet: %u)"), defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort()));
401 strUsage += HelpMessageOpt("-proxy=<ip:port>", _("Connect through SOCKS5 proxy"));
402 strUsage += HelpMessageOpt("-proxyrandomize", strprintf(_("Randomize credentials for every proxy connection. This enables Tor stream isolation (default: %u)"), DEFAULT_PROXYRANDOMIZE));
403 strUsage += HelpMessageOpt("-seednode=<ip>", _("Connect to a node to retrieve peer addresses, and disconnect"));
404 strUsage += HelpMessageOpt("-timeout=<n>", strprintf(_("Specify connection timeout in milliseconds (minimum: 1, default: %d)"), DEFAULT_CONNECT_TIMEOUT));
405 strUsage += HelpMessageOpt("-torcontrol=<ip>:<port>", strprintf(_("Tor control port to use if onion listening enabled (default: %s)"), DEFAULT_TOR_CONTROL));
406 strUsage += HelpMessageOpt("-torpassword=<pass>", _("Tor control port password (default: empty)"));
407 #ifdef USE_UPNP
408 #if USE_UPNP
409 strUsage += HelpMessageOpt("-upnp", _("Use UPnP to map the listening port (default: 1 when listening and no -proxy)"));
410 #else
411 strUsage += HelpMessageOpt("-upnp", strprintf(_("Use UPnP to map the listening port (default: %u)"), 0));
412 #endif
413 #endif
414 strUsage += HelpMessageOpt("-whitebind=<addr>", _("Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6"));
415 strUsage += HelpMessageOpt("-whitelist=<IP address or network>", _("Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple times.") +
416 " " + _("Whitelisted peers cannot be DoS banned and their transactions are always relayed, even if they are already in the mempool, useful e.g. for a gateway"));
417 strUsage += HelpMessageOpt("-maxuploadtarget=<n>", strprintf(_("Tries to keep outbound traffic under the given target (in MiB per 24h), 0 = no limit (default: %d)"), DEFAULT_MAX_UPLOAD_TARGET));
419 #ifdef ENABLE_WALLET
420 strUsage += CWallet::GetWalletHelpString(showDebug);
421 #endif
423 #if ENABLE_ZMQ
424 strUsage += HelpMessageGroup(_("ZeroMQ notification options:"));
425 strUsage += HelpMessageOpt("-zmqpubhashblock=<address>", _("Enable publish hash block in <address>"));
426 strUsage += HelpMessageOpt("-zmqpubhashtx=<address>", _("Enable publish hash transaction in <address>"));
427 strUsage += HelpMessageOpt("-zmqpubrawblock=<address>", _("Enable publish raw block in <address>"));
428 strUsage += HelpMessageOpt("-zmqpubrawtx=<address>", _("Enable publish raw transaction in <address>"));
429 #endif
431 strUsage += HelpMessageGroup(_("Debugging/Testing options:"));
432 strUsage += HelpMessageOpt("-uacomment=<cmt>", _("Append comment to the user agent string"));
433 if (showDebug)
435 strUsage += HelpMessageOpt("-checkblocks=<n>", strprintf(_("How many blocks to check at startup (default: %u, 0 = all)"), DEFAULT_CHECKBLOCKS));
436 strUsage += HelpMessageOpt("-checklevel=<n>", strprintf(_("How thorough the block verification of -checkblocks is (0-4, default: %u)"), DEFAULT_CHECKLEVEL));
437 strUsage += HelpMessageOpt("-checkblockindex", strprintf("Do a full consistency check for mapBlockIndex, setBlockIndexCandidates, chainActive and mapBlocksUnlinked occasionally. Also sets -checkmempool (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
438 strUsage += HelpMessageOpt("-checkmempool=<n>", strprintf("Run checks every <n> transactions (default: %u)", defaultChainParams->DefaultConsistencyChecks()));
439 strUsage += HelpMessageOpt("-checkpoints", strprintf("Disable expensive verification for known chain history (default: %u)", DEFAULT_CHECKPOINTS_ENABLED));
440 strUsage += HelpMessageOpt("-disablesafemode", strprintf("Disable safemode, override a real safe mode event (default: %u)", DEFAULT_DISABLE_SAFEMODE));
441 strUsage += HelpMessageOpt("-testsafemode", strprintf("Force safe mode (default: %u)", DEFAULT_TESTSAFEMODE));
442 strUsage += HelpMessageOpt("-dropmessagestest=<n>", "Randomly drop 1 of every <n> network messages");
443 strUsage += HelpMessageOpt("-fuzzmessagestest=<n>", "Randomly fuzz 1 of every <n> network messages");
444 strUsage += HelpMessageOpt("-stopafterblockimport", strprintf("Stop running after importing blocks from disk (default: %u)", DEFAULT_STOPAFTERBLOCKIMPORT));
445 strUsage += HelpMessageOpt("-stopatheight", strprintf("Stop running after reaching the given height in the main chain (default: %u)", DEFAULT_STOPATHEIGHT));
447 strUsage += HelpMessageOpt("-limitancestorcount=<n>", strprintf("Do not accept transactions if number of in-mempool ancestors is <n> or more (default: %u)", DEFAULT_ANCESTOR_LIMIT));
448 strUsage += HelpMessageOpt("-limitancestorsize=<n>", strprintf("Do not accept transactions whose size with all in-mempool ancestors exceeds <n> kilobytes (default: %u)", DEFAULT_ANCESTOR_SIZE_LIMIT));
449 strUsage += HelpMessageOpt("-limitdescendantcount=<n>", strprintf("Do not accept transactions if any ancestor would have <n> or more in-mempool descendants (default: %u)", DEFAULT_DESCENDANT_LIMIT));
450 strUsage += HelpMessageOpt("-limitdescendantsize=<n>", strprintf("Do not accept transactions if any ancestor would have more than <n> kilobytes of in-mempool descendants (default: %u).", DEFAULT_DESCENDANT_SIZE_LIMIT));
451 strUsage += HelpMessageOpt("-vbparams=deployment:start:end", "Use given start/end times for specified version bits deployment (regtest-only)");
453 strUsage += HelpMessageOpt("-debug=<category>", strprintf(_("Output debugging information (default: %u, supplying <category> is optional)"), 0) + ". " +
454 _("If <category> is not supplied or if <category> = 1, output all debugging information.") + " " + _("<category> can be:") + " " + ListLogCategories() + ".");
455 strUsage += HelpMessageOpt("-debugexclude=<category>", strprintf(_("Exclude debugging information for a category. Can be used in conjunction with -debug=1 to output debug logs for all categories except one or more specified categories.")));
456 strUsage += HelpMessageOpt("-help-debug", _("Show all debugging options (usage: --help -help-debug)"));
457 strUsage += HelpMessageOpt("-logips", strprintf(_("Include IP addresses in debug output (default: %u)"), DEFAULT_LOGIPS));
458 strUsage += HelpMessageOpt("-logtimestamps", strprintf(_("Prepend debug output with timestamp (default: %u)"), DEFAULT_LOGTIMESTAMPS));
459 if (showDebug)
461 strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
462 strUsage += HelpMessageOpt("-mocktime=<n>", "Replace actual time with <n> seconds since epoch (default: 0)");
463 strUsage += HelpMessageOpt("-maxsigcachesize=<n>", strprintf("Limit size of signature cache to <n> MiB (default: %u)", DEFAULT_MAX_SIG_CACHE_SIZE));
464 strUsage += HelpMessageOpt("-maxtipage=<n>", strprintf("Maximum tip age in seconds to consider node in initial block download (default: %u)", DEFAULT_MAX_TIP_AGE));
466 strUsage += HelpMessageOpt("-maxtxfee=<amt>", strprintf(_("Maximum total fees (in %s) to use in a single wallet transaction or raw transaction; setting this too low may abort large transactions (default: %s)"),
467 CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MAXFEE)));
468 strUsage += HelpMessageOpt("-printtoconsole", _("Send trace/debug info to console instead of debug.log file"));
469 if (showDebug)
471 strUsage += HelpMessageOpt("-printpriority", strprintf("Log transaction fee per kB when mining blocks (default: %u)", DEFAULT_PRINTPRIORITY));
473 strUsage += HelpMessageOpt("-shrinkdebugfile", _("Shrink debug.log file on client startup (default: 1 when no -debug)"));
475 AppendParamsHelpMessages(strUsage, showDebug);
477 strUsage += HelpMessageGroup(_("Node relay options:"));
478 if (showDebug) {
479 strUsage += HelpMessageOpt("-acceptnonstdtxn", strprintf("Relay and mine \"non-standard\" transactions (%sdefault: %u)", "testnet/regtest only; ", defaultChainParams->RequireStandard()));
480 strUsage += HelpMessageOpt("-incrementalrelayfee=<amt>", strprintf("Fee rate (in %s/kB) used to define cost of relay, used for mempool limiting and BIP 125 replacement. (default: %s)", CURRENCY_UNIT, FormatMoney(DEFAULT_INCREMENTAL_RELAY_FEE)));
481 strUsage += HelpMessageOpt("-dustrelayfee=<amt>", strprintf("Fee rate (in %s/kB) used to defined dust, the value of an output such that it will cost about 1/3 of its value in fees at this fee rate to spend it. (default: %s)", CURRENCY_UNIT, FormatMoney(DUST_RELAY_TX_FEE)));
483 strUsage += HelpMessageOpt("-bytespersigop", strprintf(_("Equivalent bytes per sigop in transactions for relay and mining (default: %u)"), DEFAULT_BYTES_PER_SIGOP));
484 strUsage += HelpMessageOpt("-datacarrier", strprintf(_("Relay and mine data carrier transactions (default: %u)"), DEFAULT_ACCEPT_DATACARRIER));
485 strUsage += HelpMessageOpt("-datacarriersize", strprintf(_("Maximum size of data in data carrier transactions we relay and mine (default: %u)"), MAX_OP_RETURN_RELAY));
486 strUsage += HelpMessageOpt("-mempoolreplacement", strprintf(_("Enable transaction replacement in the memory pool (default: %u)"), DEFAULT_ENABLE_REPLACEMENT));
487 strUsage += HelpMessageOpt("-minrelaytxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for relaying, mining and transaction creation (default: %s)"),
488 CURRENCY_UNIT, FormatMoney(DEFAULT_MIN_RELAY_TX_FEE)));
489 strUsage += HelpMessageOpt("-whitelistrelay", strprintf(_("Accept relayed transactions received from whitelisted peers even when not relaying transactions (default: %d)"), DEFAULT_WHITELISTRELAY));
490 strUsage += HelpMessageOpt("-whitelistforcerelay", strprintf(_("Force relay of transactions from whitelisted peers even if they violate local relay policy (default: %d)"), DEFAULT_WHITELISTFORCERELAY));
492 strUsage += HelpMessageGroup(_("Block creation options:"));
493 strUsage += HelpMessageOpt("-blockmaxweight=<n>", strprintf(_("Set maximum BIP141 block weight (default: %d)"), DEFAULT_BLOCK_MAX_WEIGHT));
494 strUsage += HelpMessageOpt("-blockmaxsize=<n>", strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE));
495 strUsage += HelpMessageOpt("-blockmintxfee=<amt>", strprintf(_("Set lowest fee rate (in %s/kB) for transactions to be included in block creation. (default: %s)"), CURRENCY_UNIT, FormatMoney(DEFAULT_BLOCK_MIN_TX_FEE)));
496 if (showDebug)
497 strUsage += HelpMessageOpt("-blockversion=<n>", "Override block version to test forking scenarios");
499 strUsage += HelpMessageGroup(_("RPC server options:"));
500 strUsage += HelpMessageOpt("-server", _("Accept command line and JSON-RPC commands"));
501 strUsage += HelpMessageOpt("-rest", strprintf(_("Accept public REST requests (default: %u)"), DEFAULT_REST_ENABLE));
502 strUsage += HelpMessageOpt("-rpcbind=<addr>[:port]", _("Bind to given address to listen for JSON-RPC connections. This option is ignored unless -rpcallowip is also passed. Port is optional and overrides -rpcport. Use [host]:port notation for IPv6. This option can be specified multiple times (default: 127.0.0.1 and ::1 i.e., localhost, or if -rpcallowip has been specified, 0.0.0.0 and :: i.e., all addresses)"));
503 strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
504 strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
505 strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
506 strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times"));
507 strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Listen for JSON-RPC connections on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
508 strUsage += HelpMessageOpt("-rpcallowip=<ip>", _("Allow JSON-RPC connections from specified source. Valid for <ip> are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This option can be specified multiple times"));
509 strUsage += HelpMessageOpt("-rpcserialversion", strprintf(_("Sets the serialization of raw transaction or block hex returned in non-verbose mode, non-segwit(0) or segwit(1) (default: %d)"), DEFAULT_RPC_SERIALIZE_VERSION));
510 strUsage += HelpMessageOpt("-rpcthreads=<n>", strprintf(_("Set the number of threads to service RPC calls (default: %d)"), DEFAULT_HTTP_THREADS));
511 if (showDebug) {
512 strUsage += HelpMessageOpt("-rpcworkqueue=<n>", strprintf("Set the depth of the work queue to service RPC calls (default: %d)", DEFAULT_HTTP_WORKQUEUE));
513 strUsage += HelpMessageOpt("-rpcservertimeout=<n>", strprintf("Timeout during HTTP requests (default: %d)", DEFAULT_HTTP_SERVER_TIMEOUT));
516 return strUsage;
519 std::string LicenseInfo()
521 const std::string URL_SOURCE_CODE = "<https://github.com/bitcoin/bitcoin>";
522 const std::string URL_WEBSITE = "<https://bitcoincore.org>";
524 return CopyrightHolders(strprintf(_("Copyright (C) %i-%i"), 2009, COPYRIGHT_YEAR) + " ") + "\n" +
525 "\n" +
526 strprintf(_("Please contribute if you find %s useful. "
527 "Visit %s for further information about the software."),
528 PACKAGE_NAME, URL_WEBSITE) +
529 "\n" +
530 strprintf(_("The source code is available from %s."),
531 URL_SOURCE_CODE) +
532 "\n" +
533 "\n" +
534 _("This is experimental software.") + "\n" +
535 strprintf(_("Distributed under the MIT software license, see the accompanying file %s or %s"), "COPYING", "<https://opensource.org/licenses/MIT>") + "\n" +
536 "\n" +
537 strprintf(_("This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit %s and cryptographic software written by Eric Young and UPnP software written by Thomas Bernard."), "<https://www.openssl.org>") +
538 "\n";
541 static void BlockNotifyCallback(bool initialSync, const CBlockIndex *pBlockIndex)
543 if (initialSync || !pBlockIndex)
544 return;
546 std::string strCmd = GetArg("-blocknotify", "");
548 boost::replace_all(strCmd, "%s", pBlockIndex->GetBlockHash().GetHex());
549 boost::thread t(runCommand, strCmd); // thread runs free
552 static bool fHaveGenesis = false;
553 static boost::mutex cs_GenesisWait;
554 static CConditionVariable condvar_GenesisWait;
556 static void BlockNotifyGenesisWait(bool, const CBlockIndex *pBlockIndex)
558 if (pBlockIndex != NULL) {
560 boost::unique_lock<boost::mutex> lock_GenesisWait(cs_GenesisWait);
561 fHaveGenesis = true;
563 condvar_GenesisWait.notify_all();
567 struct CImportingNow
569 CImportingNow() {
570 assert(fImporting == false);
571 fImporting = true;
574 ~CImportingNow() {
575 assert(fImporting == true);
576 fImporting = false;
581 // If we're using -prune with -reindex, then delete block files that will be ignored by the
582 // reindex. Since reindexing works by starting at block file 0 and looping until a blockfile
583 // is missing, do the same here to delete any later block files after a gap. Also delete all
584 // rev files since they'll be rewritten by the reindex anyway. This ensures that vinfoBlockFile
585 // is in sync with what's actually on disk by the time we start downloading, so that pruning
586 // works correctly.
587 void CleanupBlockRevFiles()
589 std::map<std::string, fs::path> mapBlockFiles;
591 // Glob all blk?????.dat and rev?????.dat files from the blocks directory.
592 // Remove the rev files immediately and insert the blk file paths into an
593 // ordered map keyed by block file index.
594 LogPrintf("Removing unusable blk?????.dat and rev?????.dat files for -reindex with -prune\n");
595 fs::path blocksdir = GetDataDir() / "blocks";
596 for (fs::directory_iterator it(blocksdir); it != fs::directory_iterator(); it++) {
597 if (is_regular_file(*it) &&
598 it->path().filename().string().length() == 12 &&
599 it->path().filename().string().substr(8,4) == ".dat")
601 if (it->path().filename().string().substr(0,3) == "blk")
602 mapBlockFiles[it->path().filename().string().substr(3,5)] = it->path();
603 else if (it->path().filename().string().substr(0,3) == "rev")
604 remove(it->path());
608 // Remove all block files that aren't part of a contiguous set starting at
609 // zero by walking the ordered map (keys are block file indices) by
610 // keeping a separate counter. Once we hit a gap (or if 0 doesn't exist)
611 // start removing block files.
612 int nContigCounter = 0;
613 BOOST_FOREACH(const PAIRTYPE(std::string, fs::path)& item, mapBlockFiles) {
614 if (atoi(item.first) == nContigCounter) {
615 nContigCounter++;
616 continue;
618 remove(item.second);
622 void ThreadImport(std::vector<fs::path> vImportFiles)
624 const CChainParams& chainparams = Params();
625 RenameThread("bitcoin-loadblk");
628 CImportingNow imp;
630 // -reindex
631 if (fReindex) {
632 int nFile = 0;
633 while (true) {
634 CDiskBlockPos pos(nFile, 0);
635 if (!fs::exists(GetBlockPosFilename(pos, "blk")))
636 break; // No block files left to reindex
637 FILE *file = OpenBlockFile(pos, true);
638 if (!file)
639 break; // This error is logged in OpenBlockFile
640 LogPrintf("Reindexing block file blk%05u.dat...\n", (unsigned int)nFile);
641 LoadExternalBlockFile(chainparams, file, &pos);
642 nFile++;
644 pblocktree->WriteReindexing(false);
645 fReindex = false;
646 LogPrintf("Reindexing finished\n");
647 // To avoid ending up in a situation without genesis block, re-try initializing (no-op if reindexing worked):
648 InitBlockIndex(chainparams);
651 // hardcoded $DATADIR/bootstrap.dat
652 fs::path pathBootstrap = GetDataDir() / "bootstrap.dat";
653 if (fs::exists(pathBootstrap)) {
654 FILE *file = fsbridge::fopen(pathBootstrap, "rb");
655 if (file) {
656 fs::path pathBootstrapOld = GetDataDir() / "bootstrap.dat.old";
657 LogPrintf("Importing bootstrap.dat...\n");
658 LoadExternalBlockFile(chainparams, file);
659 RenameOver(pathBootstrap, pathBootstrapOld);
660 } else {
661 LogPrintf("Warning: Could not open bootstrap file %s\n", pathBootstrap.string());
665 // -loadblock=
666 BOOST_FOREACH(const fs::path& path, vImportFiles) {
667 FILE *file = fsbridge::fopen(path, "rb");
668 if (file) {
669 LogPrintf("Importing blocks file %s...\n", path.string());
670 LoadExternalBlockFile(chainparams, file);
671 } else {
672 LogPrintf("Warning: Could not open blocks file %s\n", path.string());
676 // scan for better chains in the block chain database, that are not yet connected in the active best chain
677 CValidationState state;
678 if (!ActivateBestChain(state, chainparams)) {
679 LogPrintf("Failed to connect best block");
680 StartShutdown();
683 if (GetBoolArg("-stopafterblockimport", DEFAULT_STOPAFTERBLOCKIMPORT)) {
684 LogPrintf("Stopping after block import\n");
685 StartShutdown();
687 } // End scope of CImportingNow
688 if (GetArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
689 LoadMempool();
690 fDumpMempoolLater = !fRequestShutdown;
694 /** Sanity checks
695 * Ensure that Bitcoin is running in a usable environment with all
696 * necessary library support.
698 bool InitSanityCheck(void)
700 if(!ECC_InitSanityCheck()) {
701 InitError("Elliptic curve cryptography sanity check failure. Aborting.");
702 return false;
705 if (!glibc_sanity_test() || !glibcxx_sanity_test())
706 return false;
708 if (!Random_SanityCheck()) {
709 InitError("OS cryptographic RNG sanity check failure. Aborting.");
710 return false;
713 return true;
716 bool AppInitServers(boost::thread_group& threadGroup)
718 RPCServer::OnStarted(&OnRPCStarted);
719 RPCServer::OnStopped(&OnRPCStopped);
720 RPCServer::OnPreCommand(&OnRPCPreCommand);
721 if (!InitHTTPServer())
722 return false;
723 if (!StartRPC())
724 return false;
725 if (!StartHTTPRPC())
726 return false;
727 if (GetBoolArg("-rest", DEFAULT_REST_ENABLE) && !StartREST())
728 return false;
729 if (!StartHTTPServer())
730 return false;
731 return true;
734 // Parameter interaction based on rules
735 void InitParameterInteraction()
737 // when specifying an explicit binding address, you want to listen on it
738 // even when -connect or -proxy is specified
739 if (IsArgSet("-bind")) {
740 if (SoftSetBoolArg("-listen", true))
741 LogPrintf("%s: parameter interaction: -bind set -> setting -listen=1\n", __func__);
743 if (IsArgSet("-whitebind")) {
744 if (SoftSetBoolArg("-listen", true))
745 LogPrintf("%s: parameter interaction: -whitebind set -> setting -listen=1\n", __func__);
748 if (gArgs.IsArgSet("-connect")) {
749 // when only connecting to trusted nodes, do not seed via DNS, or listen by default
750 if (SoftSetBoolArg("-dnsseed", false))
751 LogPrintf("%s: parameter interaction: -connect set -> setting -dnsseed=0\n", __func__);
752 if (SoftSetBoolArg("-listen", false))
753 LogPrintf("%s: parameter interaction: -connect set -> setting -listen=0\n", __func__);
756 if (IsArgSet("-proxy")) {
757 // to protect privacy, do not listen by default if a default proxy server is specified
758 if (SoftSetBoolArg("-listen", false))
759 LogPrintf("%s: parameter interaction: -proxy set -> setting -listen=0\n", __func__);
760 // to protect privacy, do not use UPNP when a proxy is set. The user may still specify -listen=1
761 // to listen locally, so don't rely on this happening through -listen below.
762 if (SoftSetBoolArg("-upnp", false))
763 LogPrintf("%s: parameter interaction: -proxy set -> setting -upnp=0\n", __func__);
764 // to protect privacy, do not discover addresses by default
765 if (SoftSetBoolArg("-discover", false))
766 LogPrintf("%s: parameter interaction: -proxy set -> setting -discover=0\n", __func__);
769 if (!GetBoolArg("-listen", DEFAULT_LISTEN)) {
770 // do not map ports or try to retrieve public IP when not listening (pointless)
771 if (SoftSetBoolArg("-upnp", false))
772 LogPrintf("%s: parameter interaction: -listen=0 -> setting -upnp=0\n", __func__);
773 if (SoftSetBoolArg("-discover", false))
774 LogPrintf("%s: parameter interaction: -listen=0 -> setting -discover=0\n", __func__);
775 if (SoftSetBoolArg("-listenonion", false))
776 LogPrintf("%s: parameter interaction: -listen=0 -> setting -listenonion=0\n", __func__);
779 if (IsArgSet("-externalip")) {
780 // if an explicit public IP is specified, do not try to find others
781 if (SoftSetBoolArg("-discover", false))
782 LogPrintf("%s: parameter interaction: -externalip set -> setting -discover=0\n", __func__);
785 // disable whitelistrelay in blocksonly mode
786 if (GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
787 if (SoftSetBoolArg("-whitelistrelay", false))
788 LogPrintf("%s: parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n", __func__);
791 // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
792 if (GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
793 if (SoftSetBoolArg("-whitelistrelay", true))
794 LogPrintf("%s: parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n", __func__);
798 static std::string ResolveErrMsg(const char * const optname, const std::string& strBind)
800 return strprintf(_("Cannot resolve -%s address: '%s'"), optname, strBind);
803 void InitLogging()
805 fPrintToConsole = GetBoolArg("-printtoconsole", false);
806 fLogTimestamps = GetBoolArg("-logtimestamps", DEFAULT_LOGTIMESTAMPS);
807 fLogTimeMicros = GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
808 fLogIPs = GetBoolArg("-logips", DEFAULT_LOGIPS);
810 LogPrintf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
811 LogPrintf("Bitcoin version %s\n", FormatFullVersion());
814 namespace { // Variables internal to initialization process only
816 ServiceFlags nRelevantServices = NODE_NETWORK;
817 int nMaxConnections;
818 int nUserMaxConnections;
819 int nFD;
820 ServiceFlags nLocalServices = NODE_NETWORK;
824 [[noreturn]] static void new_handler_terminate()
826 // Rather than throwing std::bad-alloc if allocation fails, terminate
827 // immediately to (try to) avoid chain corruption.
828 // Since LogPrintf may itself allocate memory, set the handler directly
829 // to terminate first.
830 std::set_new_handler(std::terminate);
831 LogPrintf("Error: Out of memory. Terminating.\n");
833 // The log was successful, terminate now.
834 std::terminate();
837 bool AppInitBasicSetup()
839 // ********************************************************* Step 1: setup
840 #ifdef _MSC_VER
841 // Turn off Microsoft heap dump noise
842 _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
843 _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, 0));
844 #endif
845 #if _MSC_VER >= 1400
846 // Disable confusing "helpful" text message on abort, Ctrl-C
847 _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
848 #endif
849 #ifdef WIN32
850 // Enable Data Execution Prevention (DEP)
851 // Minimum supported OS versions: WinXP SP3, WinVista >= SP1, Win Server 2008
852 // A failure is non-critical and needs no further attention!
853 #ifndef PROCESS_DEP_ENABLE
854 // We define this here, because GCCs winbase.h limits this to _WIN32_WINNT >= 0x0601 (Windows 7),
855 // which is not correct. Can be removed, when GCCs winbase.h is fixed!
856 #define PROCESS_DEP_ENABLE 0x00000001
857 #endif
858 typedef BOOL (WINAPI *PSETPROCDEPPOL)(DWORD);
859 PSETPROCDEPPOL setProcDEPPol = (PSETPROCDEPPOL)GetProcAddress(GetModuleHandleA("Kernel32.dll"), "SetProcessDEPPolicy");
860 if (setProcDEPPol != NULL) setProcDEPPol(PROCESS_DEP_ENABLE);
861 #endif
863 if (!SetupNetworking())
864 return InitError("Initializing networking failed");
866 #ifndef WIN32
867 if (!GetBoolArg("-sysperms", false)) {
868 umask(077);
871 // Clean shutdown on SIGTERM
872 registerSignalHandler(SIGTERM, HandleSIGTERM);
873 registerSignalHandler(SIGINT, HandleSIGTERM);
875 // Reopen debug.log on SIGHUP
876 registerSignalHandler(SIGHUP, HandleSIGHUP);
878 // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
879 signal(SIGPIPE, SIG_IGN);
880 #endif
882 std::set_new_handler(new_handler_terminate);
884 return true;
887 bool AppInitParameterInteraction()
889 const CChainParams& chainparams = Params();
890 // ********************************************************* Step 2: parameter interactions
892 // also see: InitParameterInteraction()
894 // if using block pruning, then disallow txindex
895 if (GetArg("-prune", 0)) {
896 if (GetBoolArg("-txindex", DEFAULT_TXINDEX))
897 return InitError(_("Prune mode is incompatible with -txindex."));
900 // Make sure enough file descriptors are available
901 int nBind = std::max(
902 (gArgs.IsArgSet("-bind") ? gArgs.GetArgs("-bind").size() : 0) +
903 (gArgs.IsArgSet("-whitebind") ? gArgs.GetArgs("-whitebind").size() : 0), size_t(1));
904 nUserMaxConnections = GetArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS);
905 nMaxConnections = std::max(nUserMaxConnections, 0);
907 // Trim requested connection counts, to fit into system limitations
908 nMaxConnections = std::max(std::min(nMaxConnections, (int)(FD_SETSIZE - nBind - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS)), 0);
909 nFD = RaiseFileDescriptorLimit(nMaxConnections + MIN_CORE_FILEDESCRIPTORS + MAX_ADDNODE_CONNECTIONS);
910 if (nFD < MIN_CORE_FILEDESCRIPTORS)
911 return InitError(_("Not enough file descriptors available."));
912 nMaxConnections = std::min(nFD - MIN_CORE_FILEDESCRIPTORS - MAX_ADDNODE_CONNECTIONS, nMaxConnections);
914 if (nMaxConnections < nUserMaxConnections)
915 InitWarning(strprintf(_("Reducing -maxconnections from %d to %d, because of system limitations."), nUserMaxConnections, nMaxConnections));
917 // ********************************************************* Step 3: parameter-to-internal-flags
918 if (gArgs.IsArgSet("-debug")) {
919 // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
920 const std::vector<std::string> categories = gArgs.GetArgs("-debug");
922 if (find(categories.begin(), categories.end(), std::string("0")) == categories.end()) {
923 for (const auto& cat : categories) {
924 uint32_t flag = 0;
925 if (!GetLogCategory(&flag, &cat)) {
926 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debug", cat));
927 continue;
929 logCategories |= flag;
934 // Now remove the logging categories which were explicitly excluded
935 if (gArgs.IsArgSet("-debugexclude")) {
936 for (const std::string& cat : gArgs.GetArgs("-debugexclude")) {
937 uint32_t flag = 0;
938 if (!GetLogCategory(&flag, &cat)) {
939 InitWarning(strprintf(_("Unsupported logging category %s=%s."), "-debugexclude", cat));
940 continue;
942 logCategories &= ~flag;
946 // Check for -debugnet
947 if (GetBoolArg("-debugnet", false))
948 InitWarning(_("Unsupported argument -debugnet ignored, use -debug=net."));
949 // Check for -socks - as this is a privacy risk to continue, exit here
950 if (IsArgSet("-socks"))
951 return InitError(_("Unsupported argument -socks found. Setting SOCKS version isn't possible anymore, only SOCKS5 proxies are supported."));
952 // Check for -tor - as this is a privacy risk to continue, exit here
953 if (GetBoolArg("-tor", false))
954 return InitError(_("Unsupported argument -tor found, use -onion."));
956 if (GetBoolArg("-benchmark", false))
957 InitWarning(_("Unsupported argument -benchmark ignored, use -debug=bench."));
959 if (GetBoolArg("-whitelistalwaysrelay", false))
960 InitWarning(_("Unsupported argument -whitelistalwaysrelay ignored, use -whitelistrelay and/or -whitelistforcerelay."));
962 if (IsArgSet("-blockminsize"))
963 InitWarning("Unsupported argument -blockminsize ignored.");
965 // Checkmempool and checkblockindex default to true in regtest mode
966 int ratio = std::min<int>(std::max<int>(GetArg("-checkmempool", chainparams.DefaultConsistencyChecks() ? 1 : 0), 0), 1000000);
967 if (ratio != 0) {
968 mempool.setSanityCheck(1.0 / ratio);
970 fCheckBlockIndex = GetBoolArg("-checkblockindex", chainparams.DefaultConsistencyChecks());
971 fCheckpointsEnabled = GetBoolArg("-checkpoints", DEFAULT_CHECKPOINTS_ENABLED);
973 hashAssumeValid = uint256S(GetArg("-assumevalid", chainparams.GetConsensus().defaultAssumeValid.GetHex()));
974 if (!hashAssumeValid.IsNull())
975 LogPrintf("Assuming ancestors of block %s have valid signatures.\n", hashAssumeValid.GetHex());
976 else
977 LogPrintf("Validating signatures for all blocks.\n");
979 // mempool limits
980 int64_t nMempoolSizeMax = GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
981 int64_t nMempoolSizeMin = GetArg("-limitdescendantsize", DEFAULT_DESCENDANT_SIZE_LIMIT) * 1000 * 40;
982 if (nMempoolSizeMax < 0 || nMempoolSizeMax < nMempoolSizeMin)
983 return InitError(strprintf(_("-maxmempool must be at least %d MB"), std::ceil(nMempoolSizeMin / 1000000.0)));
984 // incremental relay fee sets the minimum feerate increase necessary for BIP 125 replacement in the mempool
985 // and the amount the mempool min fee increases above the feerate of txs evicted due to mempool limiting.
986 if (IsArgSet("-incrementalrelayfee"))
988 CAmount n = 0;
989 if (!ParseMoney(GetArg("-incrementalrelayfee", ""), n))
990 return InitError(AmountErrMsg("incrementalrelayfee", GetArg("-incrementalrelayfee", "")));
991 incrementalRelayFee = CFeeRate(n);
994 // -par=0 means autodetect, but nScriptCheckThreads==0 means no concurrency
995 nScriptCheckThreads = GetArg("-par", DEFAULT_SCRIPTCHECK_THREADS);
996 if (nScriptCheckThreads <= 0)
997 nScriptCheckThreads += GetNumCores();
998 if (nScriptCheckThreads <= 1)
999 nScriptCheckThreads = 0;
1000 else if (nScriptCheckThreads > MAX_SCRIPTCHECK_THREADS)
1001 nScriptCheckThreads = MAX_SCRIPTCHECK_THREADS;
1003 // block pruning; get the amount of disk space (in MiB) to allot for block & undo files
1004 int64_t nPruneArg = GetArg("-prune", 0);
1005 if (nPruneArg < 0) {
1006 return InitError(_("Prune cannot be configured with a negative value."));
1008 nPruneTarget = (uint64_t) nPruneArg * 1024 * 1024;
1009 if (nPruneArg == 1) { // manual pruning: -prune=1
1010 LogPrintf("Block pruning enabled. Use RPC call pruneblockchain(height) to manually prune block and undo files.\n");
1011 nPruneTarget = std::numeric_limits<uint64_t>::max();
1012 fPruneMode = true;
1013 } else if (nPruneTarget) {
1014 if (nPruneTarget < MIN_DISK_SPACE_FOR_BLOCK_FILES) {
1015 return InitError(strprintf(_("Prune configured below the minimum of %d MiB. Please use a higher number."), MIN_DISK_SPACE_FOR_BLOCK_FILES / 1024 / 1024));
1017 LogPrintf("Prune configured to target %uMiB on disk for block and undo files.\n", nPruneTarget / 1024 / 1024);
1018 fPruneMode = true;
1021 RegisterAllCoreRPCCommands(tableRPC);
1022 #ifdef ENABLE_WALLET
1023 RegisterWalletRPCCommands(tableRPC);
1024 #endif
1026 nConnectTimeout = GetArg("-timeout", DEFAULT_CONNECT_TIMEOUT);
1027 if (nConnectTimeout <= 0)
1028 nConnectTimeout = DEFAULT_CONNECT_TIMEOUT;
1030 // Fee-per-kilobyte amount required for mempool acceptance and relay
1031 // If you are mining, be careful setting this:
1032 // if you set it to zero then
1033 // a transaction spammer can cheaply fill blocks using
1034 // 0-fee transactions. It should be set above the real
1035 // cost to you of processing a transaction.
1036 if (IsArgSet("-minrelaytxfee"))
1038 CAmount n = 0;
1039 if (!ParseMoney(GetArg("-minrelaytxfee", ""), n)) {
1040 return InitError(AmountErrMsg("minrelaytxfee", GetArg("-minrelaytxfee", "")));
1042 // High fee check is done afterward in CWallet::ParameterInteraction()
1043 ::minRelayTxFee = CFeeRate(n);
1044 } else if (incrementalRelayFee > ::minRelayTxFee) {
1045 // Allow only setting incrementalRelayFee to control both
1046 ::minRelayTxFee = incrementalRelayFee;
1047 LogPrintf("Increasing minrelaytxfee to %s to match incrementalrelayfee\n",::minRelayTxFee.ToString());
1050 // Sanity check argument for min fee for including tx in block
1051 // TODO: Harmonize which arguments need sanity checking and where that happens
1052 if (IsArgSet("-blockmintxfee"))
1054 CAmount n = 0;
1055 if (!ParseMoney(GetArg("-blockmintxfee", ""), n))
1056 return InitError(AmountErrMsg("blockmintxfee", GetArg("-blockmintxfee", "")));
1059 // Feerate used to define dust. Shouldn't be changed lightly as old
1060 // implementations may inadvertently create non-standard transactions
1061 if (IsArgSet("-dustrelayfee"))
1063 CAmount n = 0;
1064 if (!ParseMoney(GetArg("-dustrelayfee", ""), n) || 0 == n)
1065 return InitError(AmountErrMsg("dustrelayfee", GetArg("-dustrelayfee", "")));
1066 dustRelayFee = CFeeRate(n);
1069 fRequireStandard = !GetBoolArg("-acceptnonstdtxn", !chainparams.RequireStandard());
1070 if (chainparams.RequireStandard() && !fRequireStandard)
1071 return InitError(strprintf("acceptnonstdtxn is not currently supported for %s chain", chainparams.NetworkIDString()));
1072 nBytesPerSigOp = GetArg("-bytespersigop", nBytesPerSigOp);
1074 #ifdef ENABLE_WALLET
1075 if (!CWallet::ParameterInteraction())
1076 return false;
1077 #endif
1079 fIsBareMultisigStd = GetBoolArg("-permitbaremultisig", DEFAULT_PERMIT_BAREMULTISIG);
1080 fAcceptDatacarrier = GetBoolArg("-datacarrier", DEFAULT_ACCEPT_DATACARRIER);
1081 nMaxDatacarrierBytes = GetArg("-datacarriersize", nMaxDatacarrierBytes);
1083 // Option to startup with mocktime set (used for regression testing):
1084 SetMockTime(GetArg("-mocktime", 0)); // SetMockTime(0) is a no-op
1086 if (GetBoolArg("-peerbloomfilters", DEFAULT_PEERBLOOMFILTERS))
1087 nLocalServices = ServiceFlags(nLocalServices | NODE_BLOOM);
1089 if (GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) < 0)
1090 return InitError("rpcserialversion must be non-negative.");
1092 if (GetArg("-rpcserialversion", DEFAULT_RPC_SERIALIZE_VERSION) > 1)
1093 return InitError("unknown rpcserialversion requested.");
1095 nMaxTipAge = GetArg("-maxtipage", DEFAULT_MAX_TIP_AGE);
1097 fEnableReplacement = GetBoolArg("-mempoolreplacement", DEFAULT_ENABLE_REPLACEMENT);
1098 if ((!fEnableReplacement) && IsArgSet("-mempoolreplacement")) {
1099 // Minimal effort at forwards compatibility
1100 std::string strReplacementModeList = GetArg("-mempoolreplacement", ""); // default is impossible
1101 std::vector<std::string> vstrReplacementModes;
1102 boost::split(vstrReplacementModes, strReplacementModeList, boost::is_any_of(","));
1103 fEnableReplacement = (std::find(vstrReplacementModes.begin(), vstrReplacementModes.end(), "fee") != vstrReplacementModes.end());
1106 if (gArgs.IsArgSet("-vbparams")) {
1107 // Allow overriding version bits parameters for testing
1108 if (!chainparams.MineBlocksOnDemand()) {
1109 return InitError("Version bits parameters may only be overridden on regtest.");
1111 for (const std::string& strDeployment : gArgs.GetArgs("-vbparams")) {
1112 std::vector<std::string> vDeploymentParams;
1113 boost::split(vDeploymentParams, strDeployment, boost::is_any_of(":"));
1114 if (vDeploymentParams.size() != 3) {
1115 return InitError("Version bits parameters malformed, expecting deployment:start:end");
1117 int64_t nStartTime, nTimeout;
1118 if (!ParseInt64(vDeploymentParams[1], &nStartTime)) {
1119 return InitError(strprintf("Invalid nStartTime (%s)", vDeploymentParams[1]));
1121 if (!ParseInt64(vDeploymentParams[2], &nTimeout)) {
1122 return InitError(strprintf("Invalid nTimeout (%s)", vDeploymentParams[2]));
1124 bool found = false;
1125 for (int j=0; j<(int)Consensus::MAX_VERSION_BITS_DEPLOYMENTS; ++j)
1127 if (vDeploymentParams[0].compare(VersionBitsDeploymentInfo[j].name) == 0) {
1128 UpdateVersionBitsParameters(Consensus::DeploymentPos(j), nStartTime, nTimeout);
1129 found = true;
1130 LogPrintf("Setting version bits activation parameters for %s to start=%ld, timeout=%ld\n", vDeploymentParams[0], nStartTime, nTimeout);
1131 break;
1134 if (!found) {
1135 return InitError(strprintf("Invalid deployment (%s)", vDeploymentParams[0]));
1139 return true;
1142 static bool LockDataDirectory(bool probeOnly)
1144 std::string strDataDir = GetDataDir().string();
1146 // Make sure only a single Bitcoin process is using the data directory.
1147 fs::path pathLockFile = GetDataDir() / ".lock";
1148 FILE* file = fsbridge::fopen(pathLockFile, "a"); // empty lock file; created if it doesn't exist.
1149 if (file) fclose(file);
1151 try {
1152 static boost::interprocess::file_lock lock(pathLockFile.string().c_str());
1153 if (!lock.try_lock()) {
1154 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running."), strDataDir, _(PACKAGE_NAME)));
1156 if (probeOnly) {
1157 lock.unlock();
1159 } catch(const boost::interprocess::interprocess_exception& e) {
1160 return InitError(strprintf(_("Cannot obtain a lock on data directory %s. %s is probably already running.") + " %s.", strDataDir, _(PACKAGE_NAME), e.what()));
1162 return true;
1165 bool AppInitSanityChecks()
1167 // ********************************************************* Step 4: sanity checks
1169 // Initialize elliptic curve code
1170 ECC_Start();
1171 globalVerifyHandle.reset(new ECCVerifyHandle());
1173 // Sanity check
1174 if (!InitSanityCheck())
1175 return InitError(strprintf(_("Initialization sanity check failed. %s is shutting down."), _(PACKAGE_NAME)));
1177 // Probe the data directory lock to give an early error message, if possible
1178 return LockDataDirectory(true);
1181 bool AppInitMain(boost::thread_group& threadGroup, CScheduler& scheduler)
1183 const CChainParams& chainparams = Params();
1184 // ********************************************************* Step 4a: application initialization
1185 // After daemonization get the data directory lock again and hold on to it until exit
1186 // This creates a slight window for a race condition to happen, however this condition is harmless: it
1187 // will at most make us exit without printing a message to console.
1188 if (!LockDataDirectory(false)) {
1189 // Detailed error printed inside LockDataDirectory
1190 return false;
1193 #ifndef WIN32
1194 CreatePidFile(GetPidFile(), getpid());
1195 #endif
1196 if (GetBoolArg("-shrinkdebugfile", logCategories == BCLog::NONE)) {
1197 // Do this first since it both loads a bunch of debug.log into memory,
1198 // and because this needs to happen before any other debug.log printing
1199 ShrinkDebugFile();
1202 if (fPrintToDebugLog)
1203 OpenDebugLog();
1205 if (!fLogTimestamps)
1206 LogPrintf("Startup time: %s\n", DateTimeStrFormat("%Y-%m-%d %H:%M:%S", GetTime()));
1207 LogPrintf("Default data directory %s\n", GetDefaultDataDir().string());
1208 LogPrintf("Using data directory %s\n", GetDataDir().string());
1209 LogPrintf("Using config file %s\n", GetConfigFile(GetArg("-conf", BITCOIN_CONF_FILENAME)).string());
1210 LogPrintf("Using at most %i automatic connections (%i file descriptors available)\n", nMaxConnections, nFD);
1212 InitSignatureCache();
1214 LogPrintf("Using %u threads for script verification\n", nScriptCheckThreads);
1215 if (nScriptCheckThreads) {
1216 for (int i=0; i<nScriptCheckThreads-1; i++)
1217 threadGroup.create_thread(&ThreadScriptCheck);
1220 // Start the lightweight task scheduler thread
1221 CScheduler::Function serviceLoop = boost::bind(&CScheduler::serviceQueue, &scheduler);
1222 threadGroup.create_thread(boost::bind(&TraceThread<CScheduler::Function>, "scheduler", serviceLoop));
1224 /* Start the RPC server already. It will be started in "warmup" mode
1225 * and not really process calls already (but it will signify connections
1226 * that the server is there and will be ready later). Warmup mode will
1227 * be disabled when initialisation is finished.
1229 if (GetBoolArg("-server", false))
1231 uiInterface.InitMessage.connect(SetRPCWarmupStatus);
1232 if (!AppInitServers(threadGroup))
1233 return InitError(_("Unable to start HTTP server. See debug log for details."));
1236 int64_t nStart;
1238 // ********************************************************* Step 5: verify wallet database integrity
1239 #ifdef ENABLE_WALLET
1240 if (!CWallet::Verify())
1241 return false;
1242 #endif
1243 // ********************************************************* Step 6: network initialization
1244 // Note that we absolutely cannot open any actual connections
1245 // until the very end ("start node") as the UTXO/block state
1246 // is not yet setup and may end up being set up twice if we
1247 // need to reindex later.
1249 assert(!g_connman);
1250 g_connman = std::unique_ptr<CConnman>(new CConnman(GetRand(std::numeric_limits<uint64_t>::max()), GetRand(std::numeric_limits<uint64_t>::max())));
1251 CConnman& connman = *g_connman;
1253 peerLogic.reset(new PeerLogicValidation(&connman));
1254 RegisterValidationInterface(peerLogic.get());
1255 RegisterNodeSignals(GetNodeSignals());
1257 // sanitize comments per BIP-0014, format user agent and check total size
1258 std::vector<std::string> uacomments;
1259 if (gArgs.IsArgSet("-uacomment")) {
1260 BOOST_FOREACH(std::string cmt, gArgs.GetArgs("-uacomment"))
1262 if (cmt != SanitizeString(cmt, SAFE_CHARS_UA_COMMENT))
1263 return InitError(strprintf(_("User Agent comment (%s) contains unsafe characters."), cmt));
1264 uacomments.push_back(cmt);
1267 strSubVersion = FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, uacomments);
1268 if (strSubVersion.size() > MAX_SUBVERSION_LENGTH) {
1269 return InitError(strprintf(_("Total length of network version string (%i) exceeds maximum length (%i). Reduce the number or size of uacomments."),
1270 strSubVersion.size(), MAX_SUBVERSION_LENGTH));
1273 if (gArgs.IsArgSet("-onlynet")) {
1274 std::set<enum Network> nets;
1275 BOOST_FOREACH(const std::string& snet, gArgs.GetArgs("-onlynet")) {
1276 enum Network net = ParseNetwork(snet);
1277 if (net == NET_UNROUTABLE)
1278 return InitError(strprintf(_("Unknown network specified in -onlynet: '%s'"), snet));
1279 nets.insert(net);
1281 for (int n = 0; n < NET_MAX; n++) {
1282 enum Network net = (enum Network)n;
1283 if (!nets.count(net))
1284 SetLimited(net);
1288 if (gArgs.IsArgSet("-whitelist")) {
1289 BOOST_FOREACH(const std::string& net, gArgs.GetArgs("-whitelist")) {
1290 CSubNet subnet;
1291 LookupSubNet(net.c_str(), subnet);
1292 if (!subnet.IsValid())
1293 return InitError(strprintf(_("Invalid netmask specified in -whitelist: '%s'"), net));
1294 connman.AddWhitelistedRange(subnet);
1298 // Check for host lookup allowed before parsing any network related parameters
1299 fNameLookup = GetBoolArg("-dns", DEFAULT_NAME_LOOKUP);
1301 bool proxyRandomize = GetBoolArg("-proxyrandomize", DEFAULT_PROXYRANDOMIZE);
1302 // -proxy sets a proxy for all outgoing network traffic
1303 // -noproxy (or -proxy=0) as well as the empty string can be used to not set a proxy, this is the default
1304 std::string proxyArg = GetArg("-proxy", "");
1305 SetLimited(NET_TOR);
1306 if (proxyArg != "" && proxyArg != "0") {
1307 CService proxyAddr;
1308 if (!Lookup(proxyArg.c_str(), proxyAddr, 9050, fNameLookup)) {
1309 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1312 proxyType addrProxy = proxyType(proxyAddr, proxyRandomize);
1313 if (!addrProxy.IsValid())
1314 return InitError(strprintf(_("Invalid -proxy address or hostname: '%s'"), proxyArg));
1316 SetProxy(NET_IPV4, addrProxy);
1317 SetProxy(NET_IPV6, addrProxy);
1318 SetProxy(NET_TOR, addrProxy);
1319 SetNameProxy(addrProxy);
1320 SetLimited(NET_TOR, false); // by default, -proxy sets onion as reachable, unless -noonion later
1323 // -onion can be used to set only a proxy for .onion, or override normal proxy for .onion addresses
1324 // -noonion (or -onion=0) disables connecting to .onion entirely
1325 // An empty string is used to not override the onion proxy (in which case it defaults to -proxy set above, or none)
1326 std::string onionArg = GetArg("-onion", "");
1327 if (onionArg != "") {
1328 if (onionArg == "0") { // Handle -noonion/-onion=0
1329 SetLimited(NET_TOR); // set onions as unreachable
1330 } else {
1331 CService onionProxy;
1332 if (!Lookup(onionArg.c_str(), onionProxy, 9050, fNameLookup)) {
1333 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1335 proxyType addrOnion = proxyType(onionProxy, proxyRandomize);
1336 if (!addrOnion.IsValid())
1337 return InitError(strprintf(_("Invalid -onion address or hostname: '%s'"), onionArg));
1338 SetProxy(NET_TOR, addrOnion);
1339 SetLimited(NET_TOR, false);
1343 // see Step 2: parameter interactions for more information about these
1344 fListen = GetBoolArg("-listen", DEFAULT_LISTEN);
1345 fDiscover = GetBoolArg("-discover", true);
1346 fRelayTxes = !GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY);
1348 if (fListen) {
1349 bool fBound = false;
1350 if (gArgs.IsArgSet("-bind")) {
1351 BOOST_FOREACH(const std::string& strBind, gArgs.GetArgs("-bind")) {
1352 CService addrBind;
1353 if (!Lookup(strBind.c_str(), addrBind, GetListenPort(), false))
1354 return InitError(ResolveErrMsg("bind", strBind));
1355 fBound |= Bind(connman, addrBind, (BF_EXPLICIT | BF_REPORT_ERROR));
1358 if (gArgs.IsArgSet("-whitebind")) {
1359 BOOST_FOREACH(const std::string& strBind, gArgs.GetArgs("-whitebind")) {
1360 CService addrBind;
1361 if (!Lookup(strBind.c_str(), addrBind, 0, false))
1362 return InitError(ResolveErrMsg("whitebind", strBind));
1363 if (addrBind.GetPort() == 0)
1364 return InitError(strprintf(_("Need to specify a port with -whitebind: '%s'"), strBind));
1365 fBound |= Bind(connman, addrBind, (BF_EXPLICIT | BF_REPORT_ERROR | BF_WHITELIST));
1368 if (!gArgs.IsArgSet("-bind") && !gArgs.IsArgSet("-whitebind")) {
1369 struct in_addr inaddr_any;
1370 inaddr_any.s_addr = INADDR_ANY;
1371 fBound |= Bind(connman, CService(in6addr_any, GetListenPort()), BF_NONE);
1372 fBound |= Bind(connman, CService(inaddr_any, GetListenPort()), !fBound ? BF_REPORT_ERROR : BF_NONE);
1374 if (!fBound)
1375 return InitError(_("Failed to listen on any port. Use -listen=0 if you want this."));
1378 if (gArgs.IsArgSet("-externalip")) {
1379 BOOST_FOREACH(const std::string& strAddr, gArgs.GetArgs("-externalip")) {
1380 CService addrLocal;
1381 if (Lookup(strAddr.c_str(), addrLocal, GetListenPort(), fNameLookup) && addrLocal.IsValid())
1382 AddLocal(addrLocal, LOCAL_MANUAL);
1383 else
1384 return InitError(ResolveErrMsg("externalip", strAddr));
1388 #if ENABLE_ZMQ
1389 pzmqNotificationInterface = CZMQNotificationInterface::Create();
1391 if (pzmqNotificationInterface) {
1392 RegisterValidationInterface(pzmqNotificationInterface);
1394 #endif
1395 uint64_t nMaxOutboundLimit = 0; //unlimited unless -maxuploadtarget is set
1396 uint64_t nMaxOutboundTimeframe = MAX_UPLOAD_TIMEFRAME;
1398 if (IsArgSet("-maxuploadtarget")) {
1399 nMaxOutboundLimit = GetArg("-maxuploadtarget", DEFAULT_MAX_UPLOAD_TARGET)*1024*1024;
1402 // ********************************************************* Step 7: load block chain
1404 fReindex = GetBoolArg("-reindex", false);
1405 bool fReindexChainState = GetBoolArg("-reindex-chainstate", false);
1407 fs::create_directories(GetDataDir() / "blocks");
1409 // cache size calculations
1410 int64_t nTotalCache = (GetArg("-dbcache", nDefaultDbCache) << 20);
1411 nTotalCache = std::max(nTotalCache, nMinDbCache << 20); // total cache cannot be less than nMinDbCache
1412 nTotalCache = std::min(nTotalCache, nMaxDbCache << 20); // total cache cannot be greater than nMaxDbcache
1413 int64_t nBlockTreeDBCache = nTotalCache / 8;
1414 nBlockTreeDBCache = std::min(nBlockTreeDBCache, (GetBoolArg("-txindex", DEFAULT_TXINDEX) ? nMaxBlockDBAndTxIndexCache : nMaxBlockDBCache) << 20);
1415 nTotalCache -= nBlockTreeDBCache;
1416 int64_t nCoinDBCache = std::min(nTotalCache / 2, (nTotalCache / 4) + (1 << 23)); // use 25%-50% of the remainder for disk cache
1417 nCoinDBCache = std::min(nCoinDBCache, nMaxCoinsDBCache << 20); // cap total coins db cache
1418 nTotalCache -= nCoinDBCache;
1419 nCoinCacheUsage = nTotalCache; // the rest goes to in-memory cache
1420 int64_t nMempoolSizeMax = GetArg("-maxmempool", DEFAULT_MAX_MEMPOOL_SIZE) * 1000000;
1421 LogPrintf("Cache configuration:\n");
1422 LogPrintf("* Using %.1fMiB for block index database\n", nBlockTreeDBCache * (1.0 / 1024 / 1024));
1423 LogPrintf("* Using %.1fMiB for chain state database\n", nCoinDBCache * (1.0 / 1024 / 1024));
1424 LogPrintf("* Using %.1fMiB for in-memory UTXO set (plus up to %.1fMiB of unused mempool space)\n", nCoinCacheUsage * (1.0 / 1024 / 1024), nMempoolSizeMax * (1.0 / 1024 / 1024));
1426 bool fLoaded = false;
1427 while (!fLoaded) {
1428 bool fReset = fReindex;
1429 std::string strLoadError;
1431 uiInterface.InitMessage(_("Loading block index..."));
1433 nStart = GetTimeMillis();
1434 do {
1435 try {
1436 UnloadBlockIndex();
1437 delete pcoinsTip;
1438 delete pcoinsdbview;
1439 delete pcoinscatcher;
1440 delete pblocktree;
1442 pblocktree = new CBlockTreeDB(nBlockTreeDBCache, false, fReindex);
1443 pcoinsdbview = new CCoinsViewDB(nCoinDBCache, false, fReindex || fReindexChainState);
1444 pcoinscatcher = new CCoinsViewErrorCatcher(pcoinsdbview);
1445 pcoinsTip = new CCoinsViewCache(pcoinscatcher);
1447 if (fReindex) {
1448 pblocktree->WriteReindexing(true);
1449 //If we're reindexing in prune mode, wipe away unusable block files and all undo data files
1450 if (fPruneMode)
1451 CleanupBlockRevFiles();
1452 } else {
1453 // If necessary, upgrade from older database format.
1454 if (!pcoinsdbview->Upgrade()) {
1455 strLoadError = _("Error upgrading chainstate database");
1456 break;
1460 if (!LoadBlockIndex(chainparams)) {
1461 strLoadError = _("Error loading block database");
1462 break;
1465 // If the loaded chain has a wrong genesis, bail out immediately
1466 // (we're likely using a testnet datadir, or the other way around).
1467 if (!mapBlockIndex.empty() && mapBlockIndex.count(chainparams.GetConsensus().hashGenesisBlock) == 0)
1468 return InitError(_("Incorrect or no genesis block found. Wrong datadir for network?"));
1470 // Initialize the block index (no-op if non-empty database was already loaded)
1471 if (!InitBlockIndex(chainparams)) {
1472 strLoadError = _("Error initializing block database");
1473 break;
1476 // Check for changed -txindex state
1477 if (fTxIndex != GetBoolArg("-txindex", DEFAULT_TXINDEX)) {
1478 strLoadError = _("You need to rebuild the database using -reindex-chainstate to change -txindex");
1479 break;
1482 // Check for changed -prune state. What we are concerned about is a user who has pruned blocks
1483 // in the past, but is now trying to run unpruned.
1484 if (fHavePruned && !fPruneMode) {
1485 strLoadError = _("You need to rebuild the database using -reindex to go back to unpruned mode. This will redownload the entire blockchain");
1486 break;
1489 if (!fReindex && chainActive.Tip() != NULL) {
1490 uiInterface.InitMessage(_("Rewinding blocks..."));
1491 if (!RewindBlockIndex(chainparams)) {
1492 strLoadError = _("Unable to rewind the database to a pre-fork state. You will need to redownload the blockchain");
1493 break;
1497 uiInterface.InitMessage(_("Verifying blocks..."));
1498 if (fHavePruned && GetArg("-checkblocks", DEFAULT_CHECKBLOCKS) > MIN_BLOCKS_TO_KEEP) {
1499 LogPrintf("Prune: pruned datadir may not have more than %d blocks; only checking available blocks",
1500 MIN_BLOCKS_TO_KEEP);
1504 LOCK(cs_main);
1505 CBlockIndex* tip = chainActive.Tip();
1506 RPCNotifyBlockChange(true, tip);
1507 if (tip && tip->nTime > GetAdjustedTime() + 2 * 60 * 60) {
1508 strLoadError = _("The block database contains a block which appears to be from the future. "
1509 "This may be due to your computer's date and time being set incorrectly. "
1510 "Only rebuild the block database if you are sure that your computer's date and time are correct");
1511 break;
1515 if (!CVerifyDB().VerifyDB(chainparams, pcoinsdbview, GetArg("-checklevel", DEFAULT_CHECKLEVEL),
1516 GetArg("-checkblocks", DEFAULT_CHECKBLOCKS))) {
1517 strLoadError = _("Corrupted block database detected");
1518 break;
1520 } catch (const std::exception& e) {
1521 LogPrintf("%s\n", e.what());
1522 strLoadError = _("Error opening block database");
1523 break;
1526 fLoaded = true;
1527 } while(false);
1529 if (!fLoaded) {
1530 // first suggest a reindex
1531 if (!fReset) {
1532 bool fRet = uiInterface.ThreadSafeQuestion(
1533 strLoadError + ".\n\n" + _("Do you want to rebuild the block database now?"),
1534 strLoadError + ".\nPlease restart with -reindex or -reindex-chainstate to recover.",
1535 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::BTN_ABORT);
1536 if (fRet) {
1537 fReindex = true;
1538 fRequestShutdown = false;
1539 } else {
1540 LogPrintf("Aborted block database rebuild. Exiting.\n");
1541 return false;
1543 } else {
1544 return InitError(strLoadError);
1549 // As LoadBlockIndex can take several minutes, it's possible the user
1550 // requested to kill the GUI during the last operation. If so, exit.
1551 // As the program has not fully started yet, Shutdown() is possibly overkill.
1552 if (fRequestShutdown)
1554 LogPrintf("Shutdown requested. Exiting.\n");
1555 return false;
1557 LogPrintf(" block index %15dms\n", GetTimeMillis() - nStart);
1559 fs::path est_path = GetDataDir() / FEE_ESTIMATES_FILENAME;
1560 CAutoFile est_filein(fsbridge::fopen(est_path, "rb"), SER_DISK, CLIENT_VERSION);
1561 // Allowed to fail as this file IS missing on first startup.
1562 if (!est_filein.IsNull())
1563 ::feeEstimator.Read(est_filein);
1564 fFeeEstimatesInitialized = true;
1566 // ********************************************************* Step 8: load wallet
1567 #ifdef ENABLE_WALLET
1568 if (!CWallet::InitLoadWallet())
1569 return false;
1570 #else
1571 LogPrintf("No wallet support compiled in!\n");
1572 #endif
1574 // ********************************************************* Step 9: data directory maintenance
1576 // if pruning, unset the service bit and perform the initial blockstore prune
1577 // after any wallet rescanning has taken place.
1578 if (fPruneMode) {
1579 LogPrintf("Unsetting NODE_NETWORK on prune mode\n");
1580 nLocalServices = ServiceFlags(nLocalServices & ~NODE_NETWORK);
1581 if (!fReindex) {
1582 uiInterface.InitMessage(_("Pruning blockstore..."));
1583 PruneAndFlush();
1587 if (chainparams.GetConsensus().vDeployments[Consensus::DEPLOYMENT_SEGWIT].nTimeout != 0) {
1588 // Only advertise witness capabilities if they have a reasonable start time.
1589 // This allows us to have the code merged without a defined softfork, by setting its
1590 // end time to 0.
1591 // Note that setting NODE_WITNESS is never required: the only downside from not
1592 // doing so is that after activation, no upgraded nodes will fetch from you.
1593 nLocalServices = ServiceFlags(nLocalServices | NODE_WITNESS);
1594 // Only care about others providing witness capabilities if there is a softfork
1595 // defined.
1596 nRelevantServices = ServiceFlags(nRelevantServices | NODE_WITNESS);
1599 // ********************************************************* Step 10: import blocks
1601 if (!CheckDiskSpace())
1602 return false;
1604 // Either install a handler to notify us when genesis activates, or set fHaveGenesis directly.
1605 // No locking, as this happens before any background thread is started.
1606 if (chainActive.Tip() == NULL) {
1607 uiInterface.NotifyBlockTip.connect(BlockNotifyGenesisWait);
1608 } else {
1609 fHaveGenesis = true;
1612 if (IsArgSet("-blocknotify"))
1613 uiInterface.NotifyBlockTip.connect(BlockNotifyCallback);
1615 std::vector<fs::path> vImportFiles;
1616 if (gArgs.IsArgSet("-loadblock"))
1618 BOOST_FOREACH(const std::string& strFile, gArgs.GetArgs("-loadblock"))
1619 vImportFiles.push_back(strFile);
1622 threadGroup.create_thread(boost::bind(&ThreadImport, vImportFiles));
1624 // Wait for genesis block to be processed
1626 boost::unique_lock<boost::mutex> lock(cs_GenesisWait);
1627 while (!fHaveGenesis) {
1628 condvar_GenesisWait.wait(lock);
1630 uiInterface.NotifyBlockTip.disconnect(BlockNotifyGenesisWait);
1633 // ********************************************************* Step 11: start node
1635 //// debug print
1636 LogPrintf("mapBlockIndex.size() = %u\n", mapBlockIndex.size());
1637 LogPrintf("nBestHeight = %d\n", chainActive.Height());
1638 if (GetBoolArg("-listenonion", DEFAULT_LISTEN_ONION))
1639 StartTorControl(threadGroup, scheduler);
1641 Discover(threadGroup);
1643 // Map ports with UPnP
1644 MapPort(GetBoolArg("-upnp", DEFAULT_UPNP));
1646 std::string strNodeError;
1647 CConnman::Options connOptions;
1648 connOptions.nLocalServices = nLocalServices;
1649 connOptions.nRelevantServices = nRelevantServices;
1650 connOptions.nMaxConnections = nMaxConnections;
1651 connOptions.nMaxOutbound = std::min(MAX_OUTBOUND_CONNECTIONS, connOptions.nMaxConnections);
1652 connOptions.nMaxAddnode = MAX_ADDNODE_CONNECTIONS;
1653 connOptions.nMaxFeeler = 1;
1654 connOptions.nBestHeight = chainActive.Height();
1655 connOptions.uiInterface = &uiInterface;
1656 connOptions.nSendBufferMaxSize = 1000*GetArg("-maxsendbuffer", DEFAULT_MAXSENDBUFFER);
1657 connOptions.nReceiveFloodSize = 1000*GetArg("-maxreceivebuffer", DEFAULT_MAXRECEIVEBUFFER);
1659 connOptions.nMaxOutboundTimeframe = nMaxOutboundTimeframe;
1660 connOptions.nMaxOutboundLimit = nMaxOutboundLimit;
1662 if (gArgs.IsArgSet("-seednode")) {
1663 connOptions.vSeedNodes = gArgs.GetArgs("-seednode");
1666 if (!connman.Start(scheduler, strNodeError, connOptions))
1667 return InitError(strNodeError);
1669 // ********************************************************* Step 12: finished
1671 SetRPCWarmupFinished();
1672 uiInterface.InitMessage(_("Done loading"));
1674 #ifdef ENABLE_WALLET
1675 if (pwalletMain)
1676 pwalletMain->postInitProcess(scheduler);
1677 #endif
1679 return !fRequestShutdown;