Starting and stopping a Bitcoin Core node

751    if (can_listen_ipc) {
752        argsman.AddArg("-ipcbind=<address>", "Bind to Unix socket address and listen for incoming connections. Valid address values are \"unix\" to listen on the default path, <datadir>/node.sock, or \"unix:/custom/path\" to specify a custom path. Can be specified multiple times to listen on multiple paths. Default behavior is not to listen on any path. If relative paths are specified, they are interpreted relative to the network data directory. If paths include any parent directory components and the parent directories do not exist, they will be created. Enabling this gives local processes that can access the socket unauthenticated RPC access, so it's important to choose a path with secure permissions if customizing this.", ArgsManager::ALLOW_ANY, OptionsCategory::IPC);
753    }
754
755#if HAVE_DECL_FORK
756    argsman.AddArg("-daemon", strprintf("Run in the background as a daemon and accept commands (default: %d)", DEFAULT_DAEMON), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
757    argsman.AddArg("-daemonwait", strprintf("Wait for initialization to be finished before exiting. This implies -daemon (default: %d)", DEFAULT_DAEMONWAIT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
758#else
759    hidden_args.emplace_back("-daemon");
760    hidden_args.emplace_back("-daemonwait");
761#endif
762
763    // Add the hidden options
764    argsman.AddHiddenArgs(hidden_args);
765}
766
767#if HAVE_SYSTEM
768static void StartupNotify(const ArgsManager& args)
769{
770    std::string cmd = args.GetArg("-startupnotify", "");
771    if (!cmd.empty()) {
772        std::thread t(runCommand, cmd);
773        t.detach(); // thread runs free
774    }
775}
776#endif
777
778static bool AppInitServers(NodeContext& node)
779{
780    const ArgsManager& args = *Assert(node.args);
781    if (!InitHTTPServer()) {
782        return false;
783    }
784    StartRPC();
785    node.rpc_interruption_point = RpcInterruptionPoint;
786    if (!StartHTTPRPC(&node))
787        return false;
788    if (args.GetBoolArg("-rest", DEFAULT_REST_ENABLE)) StartREST(&node);
789    StartHTTPServer();
790    return true;
791}
792
793// Parameter interaction based on rules
794void InitParameterInteraction(ArgsManager& args)
795{
796    // when specifying an explicit binding address, you want to listen on it
797    // even when -connect or -proxy is specified
798    if (!args.GetArgs("-bind").empty()) {
799        if (args.SoftSetBoolArg("-listen", true))
800            LogInfo("parameter interaction: -bind set -> setting -listen=1\n");
801    }
802    if (!args.GetArgs("-whitebind").empty()) {
803        if (args.SoftSetBoolArg("-listen", true))
804            LogInfo("parameter interaction: -whitebind set -> setting -listen=1\n");
805    }
806
807    if (!args.GetArgs("-connect").empty() || args.IsArgNegated("-connect") || args.GetIntArg("-maxconnections", DEFAULT_MAX_PEER_CONNECTIONS) <= 0) {
808        // when only connecting to trusted nodes, do not seed via DNS, or listen by default
809        // do the same when connections are disabled
810        if (args.SoftSetBoolArg("-dnsseed", false))
811            LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0\n");
812        if (args.SoftSetBoolArg("-listen", false))
813            LogInfo("parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0\n");
814    }
815
816    std::string proxy_arg = args.GetArg("-proxy", "");
817    if (proxy_arg != "" && proxy_arg != "0") {
818        // to protect privacy, do not listen by default if a default proxy server is specified
819        if (args.SoftSetBoolArg("-listen", false))
820            LogInfo("parameter interaction: -proxy set -> setting -listen=0\n");
821        // to protect privacy, do not map ports when a proxy is set. The user may still specify -listen=1
822        // to listen locally, so don't rely on this happening through -listen below.
823        if (args.SoftSetBoolArg("-natpmp", false)) {
824            LogInfo("parameter interaction: -proxy set -> setting -natpmp=0\n");
825        }
826        // to protect privacy, do not discover addresses by default
827        if (args.SoftSetBoolArg("-discover", false))
828            LogInfo("parameter interaction: -proxy set -> setting -discover=0\n");
829    }
830
831    if (!args.GetBoolArg("-listen", DEFAULT_LISTEN)) {
832        // do not map ports or try to retrieve public IP when not listening (pointless)
833        if (args.SoftSetBoolArg("-natpmp", false)) {
834            LogInfo("parameter interaction: -listen=0 -> setting -natpmp=0\n");
835        }
836        if (args.SoftSetBoolArg("-discover", false))
837            LogInfo("parameter interaction: -listen=0 -> setting -discover=0\n");
838        if (args.SoftSetBoolArg("-listenonion", false))
839            LogInfo("parameter interaction: -listen=0 -> setting -listenonion=0\n");
840        if (args.SoftSetBoolArg("-i2pacceptincoming", false)) {
841            LogInfo("parameter interaction: -listen=0 -> setting -i2pacceptincoming=0\n");
842        }
843    }
844
845    if (!args.GetArgs("-externalip").empty()) {
846        // if an explicit public IP is specified, do not try to find others
847        if (args.SoftSetBoolArg("-discover", false))
848            LogInfo("parameter interaction: -externalip set -> setting -discover=0\n");
849    }
850
851    if (args.GetBoolArg("-blocksonly", DEFAULT_BLOCKSONLY)) {
852        // disable whitelistrelay in blocksonly mode
853        if (args.SoftSetBoolArg("-whitelistrelay", false))
854            LogInfo("parameter interaction: -blocksonly=1 -> setting -whitelistrelay=0\n");
855        // Reduce default mempool size in blocksonly mode to avoid unexpected resource usage
856        if (args.SoftSetArg("-maxmempool", ToString(DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB)))
857            LogInfo("parameter interaction: -blocksonly=1 -> setting -maxmempool=%d\n", DEFAULT_BLOCKSONLY_MAX_MEMPOOL_SIZE_MB);
858    }
859
860    // Forcing relay from whitelisted hosts implies we will accept relays from them in the first place.
861    if (args.GetBoolArg("-whitelistforcerelay", DEFAULT_WHITELISTFORCERELAY)) {
862        if (args.SoftSetBoolArg("-whitelistrelay", true))
863            LogInfo("parameter interaction: -whitelistforcerelay=1 -> setting -whitelistrelay=1\n");
864    }
865    const auto onlynets = args.GetArgs("-onlynet");
866    if (!onlynets.empty()) {
867        bool clearnet_reachable = std::any_of(onlynets.begin(), onlynets.end(), [](const auto& net) {
868            const auto n = ParseNetwork(net);
869            return n == NET_IPV4 || n == NET_IPV6;
870        });
871        if (!clearnet_reachable && args.SoftSetBoolArg("-dnsseed", false)) {
872            LogInfo("parameter interaction: -onlynet excludes IPv4 and IPv6 -> setting -dnsseed=0\n");
873        }
874    }
875}
876
877/**
878 * Initialize global loggers.
879 *
880 * Note that this is called very early in the process lifetime, so you should be
881 * careful about what global state you rely on here.
882 */
883void InitLogging(const ArgsManager& args)
884{
885    init::SetLoggingOptions(args);
886    init::LogPackageVersion();
887}
888
889namespace { // Variables internal to initialization process only
890
891int num_p2p_max_connections;
892int available_fds;
893ServiceFlags g_local_services = ServiceFlags(NODE_NETWORK_LIMITED | NODE_WITNESS);
894int64_t peer_connect_timeout;
895std::set<BlockFilterType> g_enabled_filter_types;
896
897} // namespace
898
899[[noreturn]] static void new_handler_terminate()
900{
901    // Rather than throwing std::bad-alloc if allocation fails, terminate
902    // immediately to (try to) avoid chain corruption.
903    // Since logging may itself allocate memory, set the handler directly
904    // to terminate first.
905    std::set_new_handler(std::terminate);
906    LogError("Out of memory. Terminating.\n");
907
908    // The log was successful, terminate now.
909    std::terminate();
910};
911
912bool AppInitBasicSetup(const ArgsManager& args, std::atomic<int>& exit_status)
913{
914    // ********************************************************* Step 1: setup
915#ifdef _MSC_VER
916    // Turn off Microsoft heap dump noise
917    _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_FILE);
918    _CrtSetReportFile(_CRT_WARN, CreateFileA("NUL", GENERIC_WRITE, 0, nullptr, OPEN_EXISTING, 0, 0));
919    // Disable confusing "helpful" text message on abort, Ctrl-C
920    _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
921#endif
922#ifdef WIN32
923    // Enable heap terminate-on-corruption
924    HeapSetInformation(nullptr, HeapEnableTerminationOnCorruption, nullptr, 0);
925#endif
926    if (!SetupNetworking()) {
927        return InitError(Untranslated("Initializing networking failed."));
928    }
929
930#ifndef WIN32
931    // Clean shutdown on SIGTERM
932    registerSignalHandler(SIGTERM, HandleSIGTERM);
933    registerSignalHandler(SIGINT, HandleSIGTERM);
934
935    // Reopen debug.log on SIGHUP
936    registerSignalHandler(SIGHUP, HandleSIGHUP);
937
938    // Ignore SIGPIPE, otherwise it will bring the daemon down if the client closes unexpectedly
939    signal(SIGPIPE, SIG_IGN);
940#else
941    SetConsoleCtrlHandler(consoleCtrlHandler, true);
942#endif
943
944    std::set_new_handler(new_handler_terminate);
945
946    return true;
947}
948
949bool AppInitParameterInteraction(const ArgsManager& args)
950{
951    const CChainParams& chainparams = Params();
952    // ********************************************************* Step 2: parameter interactions
953
954    // also see: InitParameterInteraction()
955
956    // We removed checkpoints but keep the option to warn users who still have it in their config.
957    if (args.IsArgSet("-checkpoints")) {
958        InitWarning(_("Option '-checkpoints' is set but checkpoints were removed. This option has no effect."));
959    }
960    if (args.IsArgSet("-limitancestorsize")) {
961        InitWarning(_("Option '-limitancestorsize' is given but ancestor size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
962    }
963    if (args.IsArgSet("-limitdescendantsize")) {
964        InitWarning(_("Option '-limitdescendantsize' is given but descendant size limits have been replaced with cluster size limits (see -limitclustersize). This option has no effect."));
965    }
966
967    // Error if network-specific options (-addnode, -connect, etc) are
968    // specified in default section of config file, but not overridden
969    // on the command line or in this chain's section of the config file.
970    ChainType chain = args.GetChainType();
971    if (chain == ChainType::SIGNET) {
972        LogInfo("Signet derived magic (message start): %s", HexStr(chainparams.MessageStart()));
973    }
974    bilingual_str errors;
975    for (const auto& arg : args.GetUnsuitableSectionOnlyArgs()) {
976        errors += strprintf(_("Config setting for %s only applied on %s network when in [%s] section."), arg, ChainTypeToString(chain), ChainTypeToString(chain)) + Untranslated("\n");
977    }
978
979    if (!errors.empty()) {
980        return InitError(errors);
981    }
982
983    // Testnet3 deprecation warning
984    if (chain == ChainType::TESTNET) {
985        LogInfo("Warning: Support for testnet3 is deprecated and will be removed in an upcoming release. Consider switching to testnet4.\n");
986    }
987
988    // Warn if unrecognized section name are present in the config file.
989    bilingual_str warnings;
990    for (const auto& section : args.GetUnrecognizedSections()) {
991        warnings += Untranslated(strprintf("%s:%i ", section.m_file, section.m_line)) + strprintf(_("Section [%s] is not recognized."), section.m_name) + Untranslated("\n");
992    }
993
994    if (!warnings.empty()) {
995        InitWarning(warnings);
996    }
997
998    if (!fs::is_directory(args.GetBlocksDirPath())) {
999        return InitError(strprintf(_("Specified blocks directory \"%s\" does not exist."), args.GetArg("-blocksdir", "")));
1000    }