2013-05-26 19:48:30 +02:00
|
|
|
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
2016-12-31 19:01:21 +01:00
|
|
|
// Copyright (c) 2009-2016 The Bitcoin Core developers
|
2014-12-13 05:09:33 +01:00
|
|
|
// Distributed under the MIT software license, see the accompanying
|
2013-05-26 19:48:30 +02:00
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
2015-12-09 11:53:12 +01:00
|
|
|
#if defined(HAVE_CONFIG_H)
|
|
|
|
#include "config/bitcoin-config.h"
|
|
|
|
#endif
|
|
|
|
|
2015-07-05 14:17:46 +02:00
|
|
|
#include "chainparams.h"
|
2014-10-29 02:33:23 +01:00
|
|
|
#include "clientversion.h"
|
2016-06-28 08:35:41 +02:00
|
|
|
#include "compat.h"
|
2017-03-01 16:54:22 +01:00
|
|
|
#include "fs.h"
|
2016-01-15 01:55:17 +01:00
|
|
|
#include "rpc/server.h"
|
2013-05-26 19:48:30 +02:00
|
|
|
#include "init.h"
|
2013-04-13 07:13:08 +02:00
|
|
|
#include "noui.h"
|
2015-04-03 17:50:06 +02:00
|
|
|
#include "scheduler.h"
|
2013-04-13 07:13:08 +02:00
|
|
|
#include "util.h"
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
2015-01-23 07:53:17 +01:00
|
|
|
#include "httpserver.h"
|
|
|
|
#include "httprpc.h"
|
2016-02-03 06:38:27 +01:00
|
|
|
#include "utilstrencodings.h"
|
2013-04-13 07:13:08 +02:00
|
|
|
|
Split up util.cpp/h
Split up util.cpp/h into:
- string utilities (hex, base32, base64): no internal dependencies, no dependency on boost (apart from foreach)
- money utilities (parsesmoney, formatmoney)
- time utilities (gettime*, sleep, format date):
- and the rest (logging, argument parsing, config file parsing)
The latter is basically the environment and OS handling,
and is stripped of all utility functions, so we may want to
rename it to something else than util.cpp/h for clarity (Matt suggested
osinterface).
Breaks dependency of sha256.cpp on all the things pulled in by util.
2014-08-21 16:11:09 +02:00
|
|
|
#include <boost/thread.hpp>
|
2013-05-26 19:48:30 +02:00
|
|
|
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
2015-01-23 07:53:17 +01:00
|
|
|
#include <stdio.h>
|
|
|
|
|
2013-11-17 14:17:39 +01:00
|
|
|
/* Introduction text for doxygen: */
|
|
|
|
|
|
|
|
/*! \mainpage Developer documentation
|
|
|
|
*
|
|
|
|
* \section intro_sec Introduction
|
|
|
|
*
|
2015-02-11 05:27:21 +01:00
|
|
|
* This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin (https://www.bitcoin.org/),
|
2013-11-17 14:17:39 +01:00
|
|
|
* which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
|
|
|
|
* with no central authority: managing transactions and issuing money are carried out collectively by the network.
|
|
|
|
*
|
|
|
|
* The software is a community-driven open source project, released under the MIT license.
|
|
|
|
*
|
|
|
|
* \section Navigation
|
|
|
|
* Use the buttons <code>Namespaces</code>, <code>Classes</code> or <code>Files</code> at the top of the page to start navigating the code.
|
|
|
|
*/
|
|
|
|
|
2015-01-19 15:33:55 +01:00
|
|
|
void WaitForShutdown(boost::thread_group* threadGroup)
|
2013-05-26 19:48:30 +02:00
|
|
|
{
|
2013-10-06 14:18:55 +02:00
|
|
|
bool fShutdown = ShutdownRequested();
|
2013-05-26 19:48:30 +02:00
|
|
|
// Tell the main threads to shutdown.
|
2013-10-06 14:18:55 +02:00
|
|
|
while (!fShutdown)
|
2013-05-26 19:48:30 +02:00
|
|
|
{
|
|
|
|
MilliSleep(200);
|
2013-10-06 14:18:55 +02:00
|
|
|
fShutdown = ShutdownRequested();
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
|
|
|
if (threadGroup)
|
2013-10-06 14:18:55 +02:00
|
|
|
{
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
2015-01-23 07:53:17 +01:00
|
|
|
Interrupt(*threadGroup);
|
2013-10-06 14:18:55 +02:00
|
|
|
threadGroup->join_all();
|
|
|
|
}
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
//
|
|
|
|
// Start
|
|
|
|
//
|
|
|
|
bool AppInit(int argc, char* argv[])
|
|
|
|
{
|
|
|
|
boost::thread_group threadGroup;
|
2015-04-03 17:50:06 +02:00
|
|
|
CScheduler scheduler;
|
2013-05-26 19:48:30 +02:00
|
|
|
|
|
|
|
bool fRet = false;
|
2014-11-22 19:56:25 +01:00
|
|
|
|
|
|
|
//
|
|
|
|
// Parameters
|
|
|
|
//
|
|
|
|
// If Qt is used, parameters/bitcoin.conf are parsed in qt/bitcoin.cpp's main()
|
2017-08-01 21:17:40 +02:00
|
|
|
gArgs.ParseParameters(argc, argv);
|
2014-11-22 19:56:25 +01:00
|
|
|
|
|
|
|
// Process help and version before taking care about datadir
|
2017-08-01 21:17:40 +02:00
|
|
|
if (gArgs.IsArgSet("-?") || gArgs.IsArgSet("-h") || gArgs.IsArgSet("-help") || gArgs.IsArgSet("-version"))
|
2014-11-22 19:56:25 +01:00
|
|
|
{
|
2015-12-09 11:53:12 +01:00
|
|
|
std::string strUsage = strprintf(_("%s Daemon"), _(PACKAGE_NAME)) + " " + _("version") + " " + FormatFullVersion() + "\n";
|
2014-11-22 19:56:25 +01:00
|
|
|
|
2017-08-01 21:17:40 +02:00
|
|
|
if (gArgs.IsArgSet("-version"))
|
2014-11-22 19:56:25 +01:00
|
|
|
{
|
2016-02-03 06:38:27 +01:00
|
|
|
strUsage += FormatParagraph(LicenseInfo());
|
2014-11-22 19:56:25 +01:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
strUsage += "\n" + _("Usage:") + "\n" +
|
2015-12-09 11:53:12 +01:00
|
|
|
" bitcoind [options] " + strprintf(_("Start %s Daemon"), _(PACKAGE_NAME)) + "\n";
|
2014-11-22 19:56:25 +01:00
|
|
|
|
|
|
|
strUsage += "\n" + HelpMessage(HMM_BITCOIND);
|
|
|
|
}
|
|
|
|
|
|
|
|
fprintf(stdout, "%s", strUsage.c_str());
|
2016-11-02 19:59:09 +01:00
|
|
|
return true;
|
2014-11-22 19:56:25 +01:00
|
|
|
}
|
|
|
|
|
2013-05-26 19:48:30 +02:00
|
|
|
try
|
|
|
|
{
|
2017-03-01 17:05:50 +01:00
|
|
|
if (!fs::is_directory(GetDataDir(false)))
|
2013-05-26 19:48:30 +02:00
|
|
|
{
|
2017-08-01 21:17:40 +02:00
|
|
|
fprintf(stderr, "Error: Specified data directory \"%s\" does not exist.\n", gArgs.GetArg("-datadir", "").c_str());
|
2013-06-23 18:04:44 +02:00
|
|
|
return false;
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
2014-04-07 10:10:01 +02:00
|
|
|
try
|
|
|
|
{
|
2017-08-01 21:17:40 +02:00
|
|
|
gArgs.ReadConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME));
|
2014-12-07 13:29:06 +01:00
|
|
|
} catch (const std::exception& e) {
|
2014-04-07 10:10:01 +02:00
|
|
|
fprintf(stderr,"Error reading configuration file: %s\n", e.what());
|
|
|
|
return false;
|
|
|
|
}
|
2014-03-22 20:22:14 +01:00
|
|
|
// Check for -testnet or -regtest parameter (Params() calls are only valid after this clause)
|
2015-05-25 09:00:17 +02:00
|
|
|
try {
|
|
|
|
SelectParams(ChainNameFromCommandLine());
|
2015-10-27 17:39:42 +01:00
|
|
|
} catch (const std::exception& e) {
|
2015-05-25 09:00:17 +02:00
|
|
|
fprintf(stderr, "Error: %s\n", e.what());
|
2013-06-23 18:04:44 +02:00
|
|
|
return false;
|
|
|
|
}
|
2013-05-26 19:48:30 +02:00
|
|
|
|
2017-05-24 09:28:51 +02:00
|
|
|
// Error out when loose non-argument tokens are encountered on command line
|
|
|
|
for (int i = 1; i < argc; i++) {
|
|
|
|
if (!IsSwitchChar(argv[i][0])) {
|
|
|
|
fprintf(stderr, "Error: Command line contains unexpected token '%s', see bitcoind -h for a list of options.\n", argv[i]);
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
2017-05-24 09:28:51 +02:00
|
|
|
|
2016-10-25 11:34:27 +02:00
|
|
|
// -server defaults to true for bitcoind but not for the GUI so do this here
|
2017-08-01 21:17:40 +02:00
|
|
|
gArgs.SoftSetBoolArg("-server", true);
|
2016-10-25 11:34:27 +02:00
|
|
|
// Set this early so that parameter interactions go to console
|
|
|
|
InitLogging();
|
|
|
|
InitParameterInteraction();
|
|
|
|
if (!AppInitBasicSetup())
|
|
|
|
{
|
|
|
|
// InitError will have been called with detailed error, which ends up on console
|
2017-02-21 09:16:25 +01:00
|
|
|
exit(EXIT_FAILURE);
|
2016-10-25 11:34:27 +02:00
|
|
|
}
|
|
|
|
if (!AppInitParameterInteraction())
|
|
|
|
{
|
|
|
|
// InitError will have been called with detailed error, which ends up on console
|
2017-02-21 09:16:25 +01:00
|
|
|
exit(EXIT_FAILURE);
|
2016-10-25 11:34:27 +02:00
|
|
|
}
|
|
|
|
if (!AppInitSanityChecks())
|
|
|
|
{
|
|
|
|
// InitError will have been called with detailed error, which ends up on console
|
2017-02-21 09:16:25 +01:00
|
|
|
exit(EXIT_FAILURE);
|
2016-10-25 11:34:27 +02:00
|
|
|
}
|
2017-08-01 21:17:40 +02:00
|
|
|
if (gArgs.GetBoolArg("-daemon", false))
|
2013-05-26 19:48:30 +02:00
|
|
|
{
|
2016-06-28 08:35:41 +02:00
|
|
|
#if HAVE_DECL_DAEMON
|
2013-12-20 11:48:22 +01:00
|
|
|
fprintf(stdout, "Bitcoin server starting\n");
|
|
|
|
|
2013-05-26 19:48:30 +02:00
|
|
|
// Daemonize
|
2016-06-28 08:35:41 +02:00
|
|
|
if (daemon(1, 0)) { // don't chdir (1), do close FDs (0)
|
|
|
|
fprintf(stderr, "Error: daemon() failed: %s\n", strerror(errno));
|
2013-05-26 19:48:30 +02:00
|
|
|
return false;
|
|
|
|
}
|
2016-06-28 08:35:41 +02:00
|
|
|
#else
|
|
|
|
fprintf(stderr, "Error: -daemon is not supported on this operating system\n");
|
|
|
|
return false;
|
|
|
|
#endif // HAVE_DECL_DAEMON
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
2017-07-15 10:46:06 +02:00
|
|
|
// Lock data directory after daemonization
|
|
|
|
if (!AppInitLockDataDirectory())
|
|
|
|
{
|
|
|
|
// If locking the data directory failed, exit immediately
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2016-10-25 11:34:27 +02:00
|
|
|
fRet = AppInitMain(threadGroup, scheduler);
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
2014-12-07 13:29:06 +01:00
|
|
|
catch (const std::exception& e) {
|
2013-05-26 19:48:30 +02:00
|
|
|
PrintExceptionContinue(&e, "AppInit()");
|
|
|
|
} catch (...) {
|
2017-08-07 07:36:37 +02:00
|
|
|
PrintExceptionContinue(nullptr, "AppInit()");
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
2013-10-06 14:18:55 +02:00
|
|
|
|
|
|
|
if (!fRet)
|
|
|
|
{
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
2015-01-23 07:53:17 +01:00
|
|
|
Interrupt(threadGroup);
|
Always wait for threadGroup to exit in bitcoind shutdown
This resolves a possible-assert-on-shutdown race introduced in
1f668b646806f94acd851acdbd9939c24e0492d3 when early shutdown
occurs.
Previously this was not done to avoid any cases where the
threadGroup might not exit due to a blocking thread, but at this
point the threadGroup isn't used all that much, plus Qt already
does this, and its good to keep their init/shutdown consistent.
For those curious, the threadGroup is only used in a few places:
* Its used to run the CCheckQueues in script validation, but these
use the boost mutex/condition variable primitives, so they
respect the interrupt pretty trivially.
* Its used for the import thread, which should exit rather quickly
as mostly it just calls LoadExternalBlockFile, which has an
interruption_point right before each block loaded.
* Its used in the scheduler thread, which is only used for:
* validationinterface has an effectively-dummy reference to it.
* wallet compaction, which should not last long
* addr/banlist dumping from CConnman, which should also be fast
2017-07-23 19:29:06 +02:00
|
|
|
threadGroup.join_all();
|
2015-01-19 15:33:55 +01:00
|
|
|
} else {
|
|
|
|
WaitForShutdown(&threadGroup);
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|
|
|
|
Shutdown();
|
|
|
|
|
|
|
|
return fRet;
|
|
|
|
}
|
|
|
|
|
|
|
|
int main(int argc, char* argv[])
|
|
|
|
{
|
2014-05-13 12:15:00 +02:00
|
|
|
SetupEnvironment();
|
|
|
|
|
2013-05-26 19:48:30 +02:00
|
|
|
// Connect bitcoind signal handlers
|
|
|
|
noui_connect();
|
|
|
|
|
2016-11-07 19:31:38 +01:00
|
|
|
return (AppInit(argc, argv) ? EXIT_SUCCESS : EXIT_FAILURE);
|
2013-05-26 19:48:30 +02:00
|
|
|
}
|