1#include <xrpld/app/main/Application.h>
2#include <xrpld/app/rdb/Vacuum.h>
3#include <xrpld/core/Config.h>
4#include <xrpld/core/ConfigSections.h>
5#include <xrpld/core/TimeKeeper.h>
6#include <xrpld/rpc/RPCCall.h>
8#include <xrpl/basics/Log.h>
9#include <xrpl/beast/core/CurrentThreadName.h>
10#include <xrpl/protocol/BuildInfo.h>
12#include <boost/asio/io_context.hpp>
13#include <boost/process/v1/args.hpp>
14#include <boost/process/v1/child.hpp>
15#include <boost/process/v1/exe.hpp>
18#include <test/unit_test/multi_runner.h>
20#include <xrpl/beast/unit_test/match.h>
22#include <boost/algorithm/string.hpp>
23#include <boost/program_options.hpp>
25#include <google/protobuf/stubs/common.h>
39#if !BOOST_OS_LINUX && !BOOST_OS_WINDOWS && !BOOST_OS_MACOS
40#error Supported platforms are: Linux, Windows and MacOS
44#if (BOOST_OS_LINUX && (BOOST_OS_WINDOWS || BOOST_OS_MACOS)) || \
45 (BOOST_OS_MACOS && (BOOST_OS_WINDOWS || BOOST_OS_LINUX)) || \
46 (BOOST_OS_WINDOWS && (BOOST_OS_LINUX || BOOST_OS_MACOS))
47#error Multiple supported platforms appear active at once
51#include "antithesis_instrumentation.h"
54namespace po = boost::program_options;
67 if (getrlimit(RLIMIT_NOFILE, &rl) == 0)
70 if (rl.rlim_cur == RLIM_INFINITY)
82 if (setrlimit(RLIMIT_NOFILE, &rl) == 0)
89 j.
fatal() <<
"Insufficient number of file descriptors: " << needed
90 <<
" are needed, but only " <<
available <<
" are available.";
92 std::cerr <<
"Insufficient number of file descriptors: " << needed
94 <<
" are available.\n";
107 <<
systemName() <<
"d [options] <command> <params>\n"
110 " account_currencies <account> [<ledger>]\n"
111 " account_info <account>|<key> [<ledger>]\n"
112 " account_lines <account> <account>|\"\" [<ledger>]\n"
113 " account_channels <account> <account>|\"\" [<ledger>]\n"
114 " account_objects <account> [<ledger>]\n"
115 " account_offers <account>|<account_public_key> [<ledger>]\n"
116 " account_tx accountID [ledger_index_min [ledger_index_max "
119 " book_changes [<ledger hash|id>]\n"
120 " book_offers <taker_pays> <taker_gets> [<taker [<ledger> "
121 "[<limit> [<proof> [<marker>]]]]]\n"
122 " can_delete [<ledgerid>|<ledgerhash>|now|always|never]\n"
123 " channel_authorize <private_key> <channel_id> <drops>\n"
124 " channel_verify <public_key> <channel_id> <drops> <signature>\n"
125 " connect <ip> [<port>]\n"
127 " deposit_authorized <source_account> <destination_account> "
128 "[<ledger> [<credentials>, ...]]\n"
129 " feature [<feature> [accept|reject]]\n"
130 " fetch_info [clear]\n"
131 " gateway_balances [<ledger>] <issuer_account> [ <hotwallet> [ "
134 " json <method> <json>\n"
135 " ledger [<id>|current|closed|validated] [full]\n"
140 " ledger_request <ledger>\n"
141 " log_level [[<partition>] <severity>]\n"
143 " manifest <public_key>\n"
147 " peer_reservations_add <public_key> [<description>]\n"
148 " peer_reservations_del <public_key>\n"
149 " peer_reservations_list\n"
151 " ripple_path_find <json> [<ledger>]\n"
152 " server_definitions [<hash>]\n"
153 " server_info [counters]\n"
154 " server_state [counters]\n"
155 " sign <private_key> <tx_json> [offline]\n"
156 " sign_for <signer_address> <signer_private_key> <tx_json> "
157 "[offline] [<signature_field>]\n"
159 " simulate [<tx_blob>|<tx_json>] [<binary>]\n"
160 " submit <tx_blob>|[<private_key> <tx_json>]\n"
161 " submit_multisigned <tx_json>\n"
163 " validation_create [<seed>|<pass_phrase>|<key>]\n"
166 " validator_list_sites\n"
168 " wallet_propose [<passphrase>]\n";
183 explicit multi_selector(
std::string const& patterns =
"")
186 boost::split(v, patterns, boost::algorithm::is_any_of(
","));
190 if (selectors_.empty() || !s.empty())
191 selectors_.emplace_back(
192 beast::unit_test::selector::automatch, s);
199 for (
auto& sel : selectors_)
208 return selectors_.
size();
216template <
class Runner>
218anyMissing(Runner& runner, multi_selector
const& pred)
220 if (runner.tests() == 0)
222 runner.add_failures(1);
226 if (runner.suites() < pred.size())
228 auto const missing = pred.size() - runner.suites();
229 runner.add_failures(missing);
231 <<
" filters did not match any existing test suites"
255 if (!child && num_jobs == 1)
260 child_runner.arg(argument);
261 multi_selector pred(pattern);
262 auto const any_failed =
263 child_runner.run_multi(pred) || anyMissing(child_runner, pred);
278 for (
int i = 1; i < argc; ++i)
285 boost::process::v1::exe = exe_name,
286 boost::process::v1::args = args);
288 int bad_child_exits = 0;
289 int terminated_child_exits = 0;
290 for (
auto& c : children)
302 ++terminated_child_exits;
307 anyMissing(parent_runner, multi_selector(pattern));
309 if (parent_runner.
any_failed() || bad_child_exits)
318 auto const anyFailed =
runner.run_multi(multi_selector(pattern));
337 po::variables_map vm;
341 importText +=
"Import an existing node database (specified in the [";
343 importText +=
"] configuration file section) into the current ";
344 importText +=
"node database (specified in the [";
346 importText +=
"] configuration file section).";
351 po::options_description gen(
"General Options");
353 "conf", po::value<std::string>(),
"Specify the configuration file.")(
354 "debug",
"Enable normally suppressed debug logging")(
355 "help,h",
"Display this message.")(
356 "newnodeid",
"Generate a new node identity for this server.")(
358 po::value<std::string>(),
359 "Specify the node identity for this server.")(
361 po::value<std::size_t>(),
362 "Override the minimum validation quorum.")(
363 "silent",
"No output to the console after startup.")(
364 "standalone,a",
"Run with no peers.")(
"verbose,v",
"Verbose logging.")
366 (
"force_ledger_present_range",
367 po::value<std::string>(),
368 "Specify the range of present ledgers for testing purposes. Min and "
369 "max values are comma separated.")(
370 "version",
"Display the build version.");
372 po::options_description data(
"Ledger/Data Options");
373 data.add_options()(
"import", importText.
c_str())(
375 po::value<std::string>(),
376 "Load the specified ledger and start from the value given.")(
378 po::value<std::string>(),
379 "Load the specified ledger file.")(
380 "load",
"Load the current ledger from the local DB.")(
381 "net",
"Get the initial ledger from the network.")(
382 "replay",
"Replay a ledger close.")(
384 po::value<std::string>(),
385 "Trap a specific transaction during replay.")(
386 "start",
"Start from a fresh Ledger.")(
387 "vacuum",
"VACUUM the transaction db.")(
388 "valid",
"Consider the initial ledger a valid network ledger.");
390 po::options_description
rpc(
"RPC Client Options");
393 "Perform rpc command - see below for available commands. "
394 "This is assumed if any positional parameters are provided.")(
396 po::value<std::string>(),
397 "Specify the IP address for RPC command. "
398 "Format: <ip-address>[':'<port-number>]")(
400 po::value<std::uint16_t>(),
401 "DEPRECATED: include with rpc_ip instead. "
402 "Specify the port number for RPC command.");
405 po::options_description test(
"Unit Test Options");
408 "Suppress test suite messages, "
409 "including suite/case name (at start) and test log messages.")(
411 po::value<std::string>()->implicit_value(
""),
412 "Perform unit tests. The optional argument specifies one or "
413 "more comma-separated selectors. Each selector specifies a suite name, "
414 "suite name prefix, full-name (lib.module.suite), module, or library "
415 "(checked in that order).")(
417 po::value<std::string>()->implicit_value(
""),
418 "Supplies an argument string to unit tests. If provided, this argument "
419 "is made available to each suite that runs. Interpretation of the "
420 "argument is handled individually by any suite that accesses it -- "
421 "as such, it typically only make sense to provide this when running "
424 "Use IPv6 localhost when running unittests (default is IPv4).")(
426 "Force unit test log message output. Only useful in combination with "
427 "--quiet, in which case log messages will print but suite/case names "
430 po::value<std::size_t>(),
431 "Number of unittest jobs to run in parallel (child processes).");
436 po::options_description hidden(
"Hidden Options");
437 hidden.add_options()(
439 po::value<vector<string>>(),
440 "Specify rpc command and parameters. This option must be repeated "
441 "for each command/param. Positional parameters also serve this "
443 "so this option is not needed for users")
446 "For internal use only when spawning child unit test processes.")
448 (
"unittest",
"Disabled in this build.")(
449 "unittest-child",
"Disabled in this build.")
451 (
"fg",
"Deprecated: server always in foreground mode.");
454 po::positional_options_description p;
455 p.add(
"parameters", -1);
457 po::options_description
all;
466 po::options_description desc;
479 po::command_line_parser(argc, argv)
493 if (vm.count(
"help"))
499 if (vm.count(
"version"))
503#ifdef GIT_COMMIT_HASH
513 if (vm.count(
"unittest") || vm.count(
"unittest-child"))
523 if (vm.count(
"unittest"))
527 if (vm.count(
"unittest-arg"))
531 bool unittestChild =
false;
532 if (vm.count(
"unittest-jobs"))
533 numJobs =
std::max(numJobs, vm[
"unittest-jobs"].as<std::size_t>());
534 unittestChild = bool(vm.count(
"unittest-child"));
537 vm[
"unittest"].as<std::string>(),
539 bool(vm.count(
"quiet")),
540 bool(vm.count(
"unittest-log")),
542 bool(vm.count(
"unittest-ipv6")),
550 if (vm.count(
"unittest-jobs"))
553 std::cerr <<
"rippled: '--unittest-jobs' specified without "
555 std::cerr <<
"To run the unit tests the '--unittest' option must "
570 bool(vm.count(
"quiet")),
571 bool(vm.count(
"silent")),
572 bool(vm.count(
"standalone")));
574 if (vm.count(
"vacuum"))
576 if (config->standalone())
578 std::cerr <<
"vacuum not applicable in standalone mode.\n";
590 std::cerr <<
"exception " << e.
what() <<
" in function " << __func__
598 if (vm.contains(
"force_ledger_present_range"))
606 vm[
"force_ledger_present_range"].as<std::string>(),
607 boost::algorithm::is_any_of(
","));
609 for (
auto& s : strVec)
623 "Invalid force_ledger_present_range parameter");
625 config->FORCED_LEDGER_RANGE_PRESENT.emplace(r[0], r[1]);
630 "Invalid force_ledger_present_range parameter");
635 std::cerr <<
"invalid 'force_ledger_present_range' parameter. The "
636 "parameter must be two numbers separated by a comma. "
637 "The first number must be <= the second."
643 if (vm.count(
"start"))
648 if (vm.count(
"import"))
649 config->doImport =
true;
651 if (vm.count(
"ledger"))
653 config->START_LEDGER = vm[
"ledger"].as<
std::string>();
654 if (vm.count(
"replay"))
657 if (vm.count(
"trap_tx_hash"))
663 config->TRAP_TX_HASH = tmp;
667 std::cerr <<
"Trap parameter was ill-formed, expected "
668 "valid transaction hash but received: "
677 else if (vm.count(
"ledgerfile"))
679 config->START_LEDGER = vm[
"ledgerfile"].as<
std::string>();
682 else if (vm.count(
"load") || config->FAST_LOAD)
687 if (vm.count(
"trap_tx_hash") && vm.count(
"replay") == 0)
689 std::cerr <<
"Cannot use trap option without replay option"
694 if (vm.count(
"net") && !config->FAST_LOAD)
699 std::cerr <<
"Net and load/replay options are incompatible"
707 if (vm.count(
"valid"))
709 config->START_VALID =
true;
714 if (vm.count(
"rpc_ip"))
717 vm[
"rpc_ip"].as<std::string>());
725 if (endpoint->port() == 0)
727 std::cerr <<
"No port specified in rpc_ip.\n";
728 if (vm.count(
"rpc_port"))
730 std::cerr <<
"WARNING: using deprecated rpc_port param.\n";
734 endpoint->at_port(vm[
"rpc_port"].as<std::uint16_t>());
735 if (endpoint->port() == 0)
748 config->rpc_ip = std::move(*endpoint);
751 if (vm.count(
"quorum"))
755 config->VALIDATION_QUORUM = vm[
"quorum"].as<
std::size_t>();
763 std::cerr <<
"Invalid value specified for --quorum (" << e.
what()
773 if (vm.count(
"quiet"))
775 else if (vm.count(
"verbose"))
781 if (!vm.count(
"parameters"))
785 if (config->had_trailing_comments())
787 JLOG(logs->journal(
"Application").warn())
788 <<
"Trailing comments were seen in your config file. "
789 <<
"The treatment of inline/trailing comments has changed "
791 <<
"Any `#` characters NOT intended to delimit comments should "
793 <<
"preceded by a \\";
801 if (vm.count(
"debug"))
813 app->fdRequired(), app->logs().journal(
"Application")))
835main(
int argc,
char** argv)
855 atexit(&google::protobuf::ShutdownProtobufLibrary);
static std::optional< Endpoint > from_string_checked(std::string const &s)
Create an Endpoint from a string.
A generic endpoint for log messages.
Unit test runner interface.
void arg(std::string const &s)
Set the argument string.
Associates a unit test type with metadata.
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
Set the expected result code for a JTx The test will fail if the code doesn't match.
A class to run a subset of unit tests.
Manager for children running unit tests.
void add_failures(std::size_t failures)
T emplace_back(T... args)
A namespace for easy access to logging severity values.
Severity
Severity level / threshold of a Journal message.
void setCurrentThreadName(std::string_view newThreadName)
Changes the name of the caller thread.
std::string const & getVersionString()
Server version.
int fromCommandLine(Config const &config, std::vector< std::string > const &vCmd, Logs &logs)
std::atomic< bool > envUseIPv4
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
static std::string const & systemName()
DatabaseCon::Setup setup_DatabaseCon(Config const &c, std::optional< beast::Journal > j=std::nullopt)
std::unique_ptr< Application > make_Application(std::unique_ptr< Config > config, std::unique_ptr< Logs > logs, std::unique_ptr< TimeKeeper > timeKeeper)
int run(int argc, char **argv)
bool adjustDescriptorLimit(int needed, beast::Journal j)
std::unique_ptr< beast::Journal::Sink > setDebugLogSink(std::unique_ptr< beast::Journal::Sink > sink)
Set the sink for the debug journal.
bool doVacuumDB(DatabaseCon::Setup const &setup, beast::Journal j)
doVacuumDB Creates, initialises, and performs cleanup on a database.
void printHelp(po::options_description const &desc)
static std::string nodeDatabase()
static std::string importNodeDatabase()