You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

init.cpp 79KB

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