Bitcoin Core  27.99.0
P2P Digital Currency
bitcoind.cpp
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 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 
6 #include <config/bitcoin-config.h> // IWYU pragma: keep
7 
8 #include <chainparams.h>
9 #include <clientversion.h>
10 #include <common/args.h>
11 #include <common/init.h>
12 #include <common/system.h>
13 #include <compat/compat.h>
14 #include <init.h>
15 #include <interfaces/chain.h>
16 #include <interfaces/init.h>
17 #include <kernel/context.h>
18 #include <node/context.h>
19 #include <node/interface_ui.h>
20 #include <node/warnings.h>
21 #include <noui.h>
22 #include <util/check.h>
23 #include <util/exception.h>
24 #include <util/signalinterrupt.h>
25 #include <util/strencodings.h>
26 #include <util/syserror.h>
27 #include <util/threadnames.h>
28 #include <util/tokenpipe.h>
29 #include <util/translation.h>
30 
31 #include <any>
32 #include <functional>
33 #include <optional>
34 
35 using node::NodeContext;
36 
37 const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
38 
39 #if HAVE_DECL_FORK
40 
51 int fork_daemon(bool nochdir, bool noclose, TokenPipeEnd& endpoint)
52 {
53  // communication pipe with child process
54  std::optional<TokenPipe> umbilical = TokenPipe::Make();
55  if (!umbilical) {
56  return -1; // pipe or pipe2 failed.
57  }
58 
59  int pid = fork();
60  if (pid < 0) {
61  return -1; // fork failed.
62  }
63  if (pid != 0) {
64  // Parent process gets read end, closes write end.
65  endpoint = umbilical->TakeReadEnd();
66  umbilical->TakeWriteEnd().Close();
67 
68  int status = endpoint.TokenRead();
69  if (status != 0) { // Something went wrong while setting up child process.
70  endpoint.Close();
71  return -1;
72  }
73 
74  return pid;
75  }
76  // Child process gets write end, closes read end.
77  endpoint = umbilical->TakeWriteEnd();
78  umbilical->TakeReadEnd().Close();
79 
80 #if HAVE_DECL_SETSID
81  if (setsid() < 0) {
82  exit(1); // setsid failed.
83  }
84 #endif
85 
86  if (!nochdir) {
87  if (chdir("/") != 0) {
88  exit(1); // chdir failed.
89  }
90  }
91  if (!noclose) {
92  // Open /dev/null, and clone it into STDIN, STDOUT and STDERR to detach
93  // from terminal.
94  int fd = open("/dev/null", O_RDWR);
95  if (fd >= 0) {
96  bool err = dup2(fd, STDIN_FILENO) < 0 || dup2(fd, STDOUT_FILENO) < 0 || dup2(fd, STDERR_FILENO) < 0;
97  // Don't close if fd<=2 to try to handle the case where the program was invoked without any file descriptors open.
98  if (fd > 2) close(fd);
99  if (err) {
100  exit(1); // dup2 failed.
101  }
102  } else {
103  exit(1); // open /dev/null failed.
104  }
105  }
106  endpoint.TokenWrite(0); // Success
107  return 0;
108 }
109 
110 #endif
111 
112 static bool ParseArgs(ArgsManager& args, int argc, char* argv[])
113 {
114  // If Qt is used, parameters/bitcoin.conf are parsed in qt/bitcoin.cpp's main()
116  std::string error;
117  if (!args.ParseParameters(argc, argv, error)) {
118  return InitError(Untranslated(strprintf("Error parsing command line arguments: %s", error)));
119  }
120 
121  if (auto error = common::InitConfig(args)) {
122  return InitError(error->message, error->details);
123  }
124 
125  // Error out when loose non-argument tokens are encountered on command line
126  for (int i = 1; i < argc; i++) {
127  if (!IsSwitchChar(argv[i][0])) {
128  return InitError(Untranslated(strprintf("Command line contains unexpected token '%s', see bitcoind -h for a list of options.", argv[i])));
129  }
130  }
131  return true;
132 }
133 
135 {
136  // Process help and version before taking care about datadir
137  if (HelpRequested(args) || args.IsArgSet("-version")) {
138  std::string strUsage = PACKAGE_NAME " version " + FormatFullVersion() + "\n";
139 
140  if (args.IsArgSet("-version")) {
141  strUsage += FormatParagraph(LicenseInfo());
142  } else {
143  strUsage += "\nUsage: bitcoind [options] Start " PACKAGE_NAME "\n"
144  "\n";
145  strUsage += args.GetHelpMessage();
146  }
147 
148  tfm::format(std::cout, "%s", strUsage);
149  return true;
150  }
151 
152  return false;
153 }
154 
155 static bool AppInit(NodeContext& node)
156 {
157  bool fRet = false;
158  ArgsManager& args = *Assert(node.args);
159 
160 #if HAVE_DECL_FORK
161  // Communication with parent after daemonizing. This is used for signalling in the following ways:
162  // - a boolean token is sent when the initialization process (all the Init* functions) have finished to indicate
163  // that the parent process can quit, and whether it was successful/unsuccessful.
164  // - an unexpected shutdown of the child process creates an unexpected end of stream at the parent
165  // end, which is interpreted as failure to start.
166  TokenPipeEnd daemon_ep;
167 #endif
168  std::any context{&node};
169  try
170  {
171  // -server defaults to true for bitcoind but not for the GUI so do this here
172  args.SoftSetBoolArg("-server", true);
173  // Set this early so that parameter interactions go to console
174  InitLogging(args);
176  if (!AppInitBasicSetup(args, node.exit_status)) {
177  // InitError will have been called with detailed error, which ends up on console
178  return false;
179  }
181  // InitError will have been called with detailed error, which ends up on console
182  return false;
183  }
184 
185  node.warnings = std::make_unique<node::Warnings>();
186 
187  node.kernel = std::make_unique<kernel::Context>();
188  node.ecc_context = std::make_unique<ECC_Context>();
189  if (!AppInitSanityChecks(*node.kernel))
190  {
191  // InitError will have been called with detailed error, which ends up on console
192  return false;
193  }
194 
195  if (args.GetBoolArg("-daemon", DEFAULT_DAEMON) || args.GetBoolArg("-daemonwait", DEFAULT_DAEMONWAIT)) {
196 #if HAVE_DECL_FORK
197  tfm::format(std::cout, PACKAGE_NAME " starting\n");
198 
199  // Daemonize
200  switch (fork_daemon(1, 0, daemon_ep)) { // don't chdir (1), do close FDs (0)
201  case 0: // Child: continue.
202  // If -daemonwait is not enabled, immediately send a success token the parent.
203  if (!args.GetBoolArg("-daemonwait", DEFAULT_DAEMONWAIT)) {
204  daemon_ep.TokenWrite(1);
205  daemon_ep.Close();
206  }
207  break;
208  case -1: // Error happened.
209  return InitError(Untranslated(strprintf("fork_daemon() failed: %s", SysErrorString(errno))));
210  default: { // Parent: wait and exit.
211  int token = daemon_ep.TokenRead();
212  if (token) { // Success
213  exit(EXIT_SUCCESS);
214  } else { // fRet = false or token read error (premature exit).
215  tfm::format(std::cerr, "Error during initialization - check debug.log for details\n");
216  exit(EXIT_FAILURE);
217  }
218  }
219  }
220 #else
221  return InitError(Untranslated("-daemon is not supported on this operating system"));
222 #endif // HAVE_DECL_FORK
223  }
224  // Lock data directory after daemonization
226  {
227  // If locking the data directory failed, exit immediately
228  return false;
229  }
231  }
232  catch (const std::exception& e) {
233  PrintExceptionContinue(&e, "AppInit()");
234  } catch (...) {
235  PrintExceptionContinue(nullptr, "AppInit()");
236  }
237 
238 #if HAVE_DECL_FORK
239  if (daemon_ep.IsOpen()) {
240  // Signal initialization status to parent, then close pipe.
241  daemon_ep.TokenWrite(fRet);
242  daemon_ep.Close();
243  }
244 #endif
245  return fRet;
246 }
247 
249 {
250 #ifdef WIN32
251  common::WinCmdLineArgs winArgs;
252  std::tie(argc, argv) = winArgs.get();
253 #endif
254 
257  std::unique_ptr<interfaces::Init> init = interfaces::MakeNodeInit(node, argc, argv, exit_status);
258  if (!init) {
259  return exit_status;
260  }
261 
263 
264  // Connect bitcoind signal handlers
265  noui_connect();
266 
268 
269  // Interpret command line arguments
271  if (!ParseArgs(args, argc, argv)) return EXIT_FAILURE;
272  // Process early info return commands such as -help or -version
274 
275  // Start application
276  if (!AppInit(node) || !Assert(node.shutdown)->wait()) {
277  node.exit_status = EXIT_FAILURE;
278  }
281 
282  return node.exit_status;
283 }
bool HelpRequested(const ArgsManager &args)
Definition: args.cpp:659
bool IsSwitchChar(char c)
Definition: args.h:43
#define PACKAGE_NAME
return EXIT_SUCCESS
int exit_status
Definition: bitcoind.cpp:256
static bool ParseArgs(ArgsManager &args, int argc, char *argv[])
Definition: bitcoind.cpp:112
noui_connect()
Definition: noui.cpp:60
ArgsManager & args
Definition: bitcoind.cpp:270
const std::function< std::string(const char *)> G_TRANSLATION_FUN
Translate string to current locale using Qt.
Definition: bitcoind.cpp:37
SetupEnvironment()
Definition: system.cpp:59
static bool AppInit(NodeContext &node)
Definition: bitcoind.cpp:155
Interrupt(node)
Shutdown(node)
static bool ProcessInitCommands(ArgsManager &args)
Definition: bitcoind.cpp:134
MAIN_FUNCTION
Definition: bitcoind.cpp:249
#define Assert(val)
Identity function.
Definition: check.h:77
bool ParseParameters(int argc, const char *const argv[], std::string &error)
Definition: args.cpp:177
std::string GetHelpMessage() const
Get the help string.
Definition: args.cpp:590
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: args.cpp:369
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:536
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:505
One end of a token pipe.
Definition: tokenpipe.h:15
bool IsOpen()
Return whether endpoint is open.
Definition: tokenpipe.h:53
int TokenWrite(uint8_t token)
Write token to endpoint.
Definition: tokenpipe.cpp:38
void Close()
Explicit close function.
Definition: tokenpipe.cpp:76
int TokenRead()
Read token from endpoint.
Definition: tokenpipe.cpp:56
static std::optional< TokenPipe > Make()
Create a new pipe.
Definition: tokenpipe.cpp:82
std::string FormatFullVersion()
std::string LicenseInfo()
Returns licensing information (for -version)
void PrintExceptionContinue(const std::exception *pex, std::string_view thread_name)
Definition: exception.cpp:36
void InitLogging(const ArgsManager &args)
Initialize global loggers.
Definition: init.cpp:818
bool AppInitLockDataDirectory()
Lock bitcoin core data directory.
Definition: init.cpp:1104
void SetupServerArgs(ArgsManager &argsman)
Register all arguments with the ArgsManager.
Definition: init.cpp:443
bool AppInitBasicSetup(const ArgsManager &args, std::atomic< int > &exit_status)
Initialize bitcoin core: Basic context setup.
Definition: init.cpp:848
bool AppInitParameterInteraction(const ArgsManager &args)
Initialization: parameter interaction.
Definition: init.cpp:885
bool AppInitInterfaces(NodeContext &node)
Initialize node and wallet interface pointers.
Definition: init.cpp:1116
void InitParameterInteraction(ArgsManager &args)
Parameter interaction: change current parameters depending on various rules.
Definition: init.cpp:726
bool AppInitMain(NodeContext &node, interfaces::BlockAndHeaderTipInfo *tip_info)
Bitcoin core main initialization.
Definition: init.cpp:1123
bool AppInitSanityChecks(const kernel::Context &kernel)
Initialization sanity checks.
Definition: init.cpp:1085
static constexpr bool DEFAULT_DAEMON
Default value for -daemon option.
Definition: init.h:14
static constexpr bool DEFAULT_DAEMONWAIT
Default value for -daemonwait option.
Definition: init.h:16
bool InitError(const bilingual_str &str)
Show error message.
std::optional< ConfigError > InitConfig(ArgsManager &args, SettingsAbortFn settings_abort_fn)
Definition: init.cpp:18
std::unique_ptr< Init > MakeNodeInit(node::NodeContext &node, int argc, char *argv[], int &exit_status)
Return implementation of Init interface for the node process.
Definition: messages.h:20
void format(std::ostream &out, const char *fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1059
void ThreadSetInternalName(const std::string &)
Set the internal (in-memory) name of the current thread only.
Definition: threadnames.cpp:63
NodeContext struct containing references to chain state and connection state.
Definition: context.h:55
std::string SysErrorString(int err)
Return system error string from errno value.
Definition: syserror.cpp:19
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1161
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:48
std::string FormatParagraph(std::string_view in, size_t width, size_t indent)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.