mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-14 13:52:36 -03:00
192325a77d
Because libbitcoinkernel does not include this new object, this has the side-effect of eliminating the unnecessary boost::process dependency.
1417 lines
46 KiB
C++
1417 lines
46 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2021 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include <util/system.h>
|
|
|
|
#include <chainparamsbase.h>
|
|
#include <fs.h>
|
|
#include <sync.h>
|
|
#include <util/check.h>
|
|
#include <util/getuniquepath.h>
|
|
#include <util/strencodings.h>
|
|
#include <util/string.h>
|
|
#include <util/syserror.h>
|
|
#include <util/translation.h>
|
|
|
|
|
|
#if (defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__DragonFly__))
|
|
#include <pthread.h>
|
|
#include <pthread_np.h>
|
|
#endif
|
|
|
|
#ifndef WIN32
|
|
// for posix_fallocate, in configure.ac we check if it is present after this
|
|
#ifdef __linux__
|
|
|
|
#ifdef _POSIX_C_SOURCE
|
|
#undef _POSIX_C_SOURCE
|
|
#endif
|
|
|
|
#define _POSIX_C_SOURCE 200112L
|
|
|
|
#endif // __linux__
|
|
|
|
#include <algorithm>
|
|
#include <cassert>
|
|
#include <fcntl.h>
|
|
#include <sched.h>
|
|
#include <sys/resource.h>
|
|
#include <sys/stat.h>
|
|
|
|
#else
|
|
|
|
#include <codecvt>
|
|
|
|
#include <io.h> /* for _commit */
|
|
#include <shellapi.h>
|
|
#include <shlobj.h>
|
|
#endif
|
|
|
|
#ifdef HAVE_MALLOPT_ARENA_MAX
|
|
#include <malloc.h>
|
|
#endif
|
|
|
|
#include <univalue.h>
|
|
|
|
#include <fstream>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <system_error>
|
|
#include <thread>
|
|
#include <typeinfo>
|
|
|
|
// Application startup time (used for uptime calculation)
|
|
const int64_t nStartupTime = GetTime();
|
|
|
|
const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
|
|
const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
|
|
|
|
ArgsManager gArgs;
|
|
|
|
/** Mutex to protect dir_locks. */
|
|
static GlobalMutex cs_dir_locks;
|
|
/** A map that contains all the currently held directory locks. After
|
|
* successful locking, these will be held here until the global destructor
|
|
* cleans them up and thus automatically unlocks them, or ReleaseDirectoryLocks
|
|
* is called.
|
|
*/
|
|
static std::map<std::string, std::unique_ptr<fsbridge::FileLock>> dir_locks GUARDED_BY(cs_dir_locks);
|
|
|
|
bool LockDirectory(const fs::path& directory, const fs::path& lockfile_name, bool probe_only)
|
|
{
|
|
LOCK(cs_dir_locks);
|
|
fs::path pathLockFile = directory / lockfile_name;
|
|
|
|
// If a lock for this directory already exists in the map, don't try to re-lock it
|
|
if (dir_locks.count(fs::PathToString(pathLockFile))) {
|
|
return true;
|
|
}
|
|
|
|
// Create empty lock file if it doesn't exist.
|
|
FILE* file = fsbridge::fopen(pathLockFile, "a");
|
|
if (file) fclose(file);
|
|
auto lock = std::make_unique<fsbridge::FileLock>(pathLockFile);
|
|
if (!lock->TryLock()) {
|
|
return error("Error while attempting to lock directory %s: %s", fs::PathToString(directory), lock->GetReason());
|
|
}
|
|
if (!probe_only) {
|
|
// Lock successful and we're not just probing, put it into the map
|
|
dir_locks.emplace(fs::PathToString(pathLockFile), std::move(lock));
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void UnlockDirectory(const fs::path& directory, const fs::path& lockfile_name)
|
|
{
|
|
LOCK(cs_dir_locks);
|
|
dir_locks.erase(fs::PathToString(directory / lockfile_name));
|
|
}
|
|
|
|
void ReleaseDirectoryLocks()
|
|
{
|
|
LOCK(cs_dir_locks);
|
|
dir_locks.clear();
|
|
}
|
|
|
|
bool DirIsWritable(const fs::path& directory)
|
|
{
|
|
fs::path tmpFile = GetUniquePath(directory);
|
|
|
|
FILE* file = fsbridge::fopen(tmpFile, "a");
|
|
if (!file) return false;
|
|
|
|
fclose(file);
|
|
remove(tmpFile);
|
|
|
|
return true;
|
|
}
|
|
|
|
bool CheckDiskSpace(const fs::path& dir, uint64_t additional_bytes)
|
|
{
|
|
constexpr uint64_t min_disk_space = 52428800; // 50 MiB
|
|
|
|
uint64_t free_bytes_available = fs::space(dir).available;
|
|
return free_bytes_available >= min_disk_space + additional_bytes;
|
|
}
|
|
|
|
std::streampos GetFileSize(const char* path, std::streamsize max) {
|
|
std::ifstream file{path, std::ios::binary};
|
|
file.ignore(max);
|
|
return file.gcount();
|
|
}
|
|
|
|
/**
|
|
* Interpret a string argument as a boolean.
|
|
*
|
|
* The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values
|
|
* like "foo", return 0. This means that if a user unintentionally supplies a
|
|
* non-integer argument here, the return value is always false. This means that
|
|
* -foo=false does what the user probably expects, but -foo=true is well defined
|
|
* but does not do what they probably expected.
|
|
*
|
|
* The return value of LocaleIndependentAtoi<int>(...) is zero when given input not
|
|
* representable as an int.
|
|
*
|
|
* For a more extensive discussion of this topic (and a wide range of opinions
|
|
* on the Right Way to change this code), see PR12713.
|
|
*/
|
|
static bool InterpretBool(const std::string& strValue)
|
|
{
|
|
if (strValue.empty())
|
|
return true;
|
|
return (LocaleIndependentAtoi<int>(strValue) != 0);
|
|
}
|
|
|
|
static std::string SettingName(const std::string& arg)
|
|
{
|
|
return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
|
|
}
|
|
|
|
struct KeyInfo {
|
|
std::string name;
|
|
std::string section;
|
|
bool negated{false};
|
|
};
|
|
|
|
/**
|
|
* Parse "name", "section.name", "noname", "section.noname" settings keys.
|
|
*
|
|
* @note Where an option was negated can be later checked using the
|
|
* IsArgNegated() method. One use case for this is to have a way to disable
|
|
* options that are not normally boolean (e.g. using -nodebuglogfile to request
|
|
* that debug log output is not sent to any file at all).
|
|
*/
|
|
KeyInfo InterpretKey(std::string key)
|
|
{
|
|
KeyInfo result;
|
|
// Split section name from key name for keys like "testnet.foo" or "regtest.bar"
|
|
size_t option_index = key.find('.');
|
|
if (option_index != std::string::npos) {
|
|
result.section = key.substr(0, option_index);
|
|
key.erase(0, option_index + 1);
|
|
}
|
|
if (key.substr(0, 2) == "no") {
|
|
key.erase(0, 2);
|
|
result.negated = true;
|
|
}
|
|
result.name = key;
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Interpret settings value based on registered flags.
|
|
*
|
|
* @param[in] key key information to know if key was negated
|
|
* @param[in] value string value of setting to be parsed
|
|
* @param[in] flags ArgsManager registered argument flags
|
|
* @param[out] error Error description if settings value is not valid
|
|
*
|
|
* @return parsed settings value if it is valid, otherwise nullopt accompanied
|
|
* by a descriptive error string
|
|
*/
|
|
static std::optional<util::SettingsValue> InterpretValue(const KeyInfo& key, const std::string* value,
|
|
unsigned int flags, std::string& error)
|
|
{
|
|
// Return negated settings as false values.
|
|
if (key.negated) {
|
|
if (flags & ArgsManager::DISALLOW_NEGATION) {
|
|
error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
|
|
return std::nullopt;
|
|
}
|
|
// Double negatives like -nofoo=0 are supported (but discouraged)
|
|
if (value && !InterpretBool(*value)) {
|
|
LogPrintf("Warning: parsed potentially confusing double-negative -%s=%s\n", key.name, *value);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
|
|
error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
|
|
return std::nullopt;
|
|
}
|
|
return value ? *value : "";
|
|
}
|
|
|
|
// Define default constructor and destructor that are not inline, so code instantiating this class doesn't need to
|
|
// #include class definitions for all members.
|
|
// For example, m_settings has an internal dependency on univalue.
|
|
ArgsManager::ArgsManager() = default;
|
|
ArgsManager::~ArgsManager() = default;
|
|
|
|
const std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
|
|
{
|
|
std::set<std::string> unsuitables;
|
|
|
|
LOCK(cs_args);
|
|
|
|
// if there's no section selected, don't worry
|
|
if (m_network.empty()) return std::set<std::string> {};
|
|
|
|
// if it's okay to use the default section for this network, don't worry
|
|
if (m_network == CBaseChainParams::MAIN) return std::set<std::string> {};
|
|
|
|
for (const auto& arg : m_network_only_args) {
|
|
if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
|
|
unsuitables.insert(arg);
|
|
}
|
|
}
|
|
return unsuitables;
|
|
}
|
|
|
|
const std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
|
|
{
|
|
// Section names to be recognized in the config file.
|
|
static const std::set<std::string> available_sections{
|
|
CBaseChainParams::REGTEST,
|
|
CBaseChainParams::SIGNET,
|
|
CBaseChainParams::TESTNET,
|
|
CBaseChainParams::MAIN
|
|
};
|
|
|
|
LOCK(cs_args);
|
|
std::list<SectionInfo> unrecognized = m_config_sections;
|
|
unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.find(appeared.m_name) != available_sections.end(); });
|
|
return unrecognized;
|
|
}
|
|
|
|
void ArgsManager::SelectConfigNetwork(const std::string& network)
|
|
{
|
|
LOCK(cs_args);
|
|
m_network = network;
|
|
}
|
|
|
|
bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
|
|
{
|
|
LOCK(cs_args);
|
|
m_settings.command_line_options.clear();
|
|
|
|
for (int i = 1; i < argc; i++) {
|
|
std::string key(argv[i]);
|
|
|
|
#ifdef MAC_OSX
|
|
// At the first time when a user gets the "App downloaded from the
|
|
// internet" warning, and clicks the Open button, macOS passes
|
|
// a unique process serial number (PSN) as -psn_... command-line
|
|
// argument, which we filter out.
|
|
if (key.substr(0, 5) == "-psn_") continue;
|
|
#endif
|
|
|
|
if (key == "-") break; //bitcoin-tx using stdin
|
|
std::optional<std::string> val;
|
|
size_t is_index = key.find('=');
|
|
if (is_index != std::string::npos) {
|
|
val = key.substr(is_index + 1);
|
|
key.erase(is_index);
|
|
}
|
|
#ifdef WIN32
|
|
key = ToLower(key);
|
|
if (key[0] == '/')
|
|
key[0] = '-';
|
|
#endif
|
|
|
|
if (key[0] != '-') {
|
|
if (!m_accept_any_command && m_command.empty()) {
|
|
// The first non-dash arg is a registered command
|
|
std::optional<unsigned int> flags = GetArgFlags(key);
|
|
if (!flags || !(*flags & ArgsManager::COMMAND)) {
|
|
error = strprintf("Invalid command '%s'", argv[i]);
|
|
return false;
|
|
}
|
|
}
|
|
m_command.push_back(key);
|
|
while (++i < argc) {
|
|
// The remaining args are command args
|
|
m_command.push_back(argv[i]);
|
|
}
|
|
break;
|
|
}
|
|
|
|
// Transform --foo to -foo
|
|
if (key.length() > 1 && key[1] == '-')
|
|
key.erase(0, 1);
|
|
|
|
// Transform -foo to foo
|
|
key.erase(0, 1);
|
|
KeyInfo keyinfo = InterpretKey(key);
|
|
std::optional<unsigned int> flags = GetArgFlags('-' + keyinfo.name);
|
|
|
|
// Unknown command line options and command line options with dot
|
|
// characters (which are returned from InterpretKey with nonempty
|
|
// section strings) are not valid.
|
|
if (!flags || !keyinfo.section.empty()) {
|
|
error = strprintf("Invalid parameter %s", argv[i]);
|
|
return false;
|
|
}
|
|
|
|
std::optional<util::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
|
|
if (!value) return false;
|
|
|
|
m_settings.command_line_options[keyinfo.name].push_back(*value);
|
|
}
|
|
|
|
// we do not allow -includeconf from command line, only -noincludeconf
|
|
if (auto* includes = util::FindKey(m_settings.command_line_options, "includeconf")) {
|
|
const util::SettingsSpan values{*includes};
|
|
// Range may be empty if -noincludeconf was passed
|
|
if (!values.empty()) {
|
|
error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
|
|
return false; // pick first value as example
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
|
|
{
|
|
LOCK(cs_args);
|
|
for (const auto& arg_map : m_available_args) {
|
|
const auto search = arg_map.second.find(name);
|
|
if (search != arg_map.second.end()) {
|
|
return search->second.m_flags;
|
|
}
|
|
}
|
|
return std::nullopt;
|
|
}
|
|
|
|
fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
|
|
{
|
|
if (IsArgNegated(arg)) return fs::path{};
|
|
std::string path_str = GetArg(arg, "");
|
|
if (path_str.empty()) return default_value;
|
|
fs::path result = fs::PathFromString(path_str).lexically_normal();
|
|
// Remove trailing slash, if present.
|
|
return result.has_filename() ? result : result.parent_path();
|
|
}
|
|
|
|
const fs::path& ArgsManager::GetBlocksDirPath() const
|
|
{
|
|
LOCK(cs_args);
|
|
fs::path& path = m_cached_blocks_path;
|
|
|
|
// Cache the path to avoid calling fs::create_directories on every call of
|
|
// this function
|
|
if (!path.empty()) return path;
|
|
|
|
if (IsArgSet("-blocksdir")) {
|
|
path = fs::absolute(GetPathArg("-blocksdir"));
|
|
if (!fs::is_directory(path)) {
|
|
path = "";
|
|
return path;
|
|
}
|
|
} else {
|
|
path = GetDataDirBase();
|
|
}
|
|
|
|
path /= fs::PathFromString(BaseParams().DataDir());
|
|
path /= "blocks";
|
|
fs::create_directories(path);
|
|
return path;
|
|
}
|
|
|
|
const fs::path& ArgsManager::GetDataDir(bool net_specific) const
|
|
{
|
|
LOCK(cs_args);
|
|
fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
|
|
|
|
// Cache the path to avoid calling fs::create_directories on every call of
|
|
// this function
|
|
if (!path.empty()) return path;
|
|
|
|
const fs::path datadir{GetPathArg("-datadir")};
|
|
if (!datadir.empty()) {
|
|
path = fs::absolute(datadir);
|
|
if (!fs::is_directory(path)) {
|
|
path = "";
|
|
return path;
|
|
}
|
|
} else {
|
|
path = GetDefaultDataDir();
|
|
}
|
|
|
|
if (!fs::exists(path)) {
|
|
fs::create_directories(path / "wallets");
|
|
}
|
|
|
|
if (net_specific && !BaseParams().DataDir().empty()) {
|
|
path /= fs::PathFromString(BaseParams().DataDir());
|
|
if (!fs::exists(path)) {
|
|
fs::create_directories(path / "wallets");
|
|
}
|
|
}
|
|
|
|
return path;
|
|
}
|
|
|
|
void ArgsManager::ClearPathCache()
|
|
{
|
|
LOCK(cs_args);
|
|
|
|
m_cached_datadir_path = fs::path();
|
|
m_cached_network_datadir_path = fs::path();
|
|
m_cached_blocks_path = fs::path();
|
|
}
|
|
|
|
std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
|
|
{
|
|
Command ret;
|
|
LOCK(cs_args);
|
|
auto it = m_command.begin();
|
|
if (it == m_command.end()) {
|
|
// No command was passed
|
|
return std::nullopt;
|
|
}
|
|
if (!m_accept_any_command) {
|
|
// The registered command
|
|
ret.command = *(it++);
|
|
}
|
|
while (it != m_command.end()) {
|
|
// The unregistered command and args (if any)
|
|
ret.args.push_back(*(it++));
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
|
|
{
|
|
std::vector<std::string> result;
|
|
for (const util::SettingsValue& value : GetSettingsList(strArg)) {
|
|
result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
|
|
}
|
|
return result;
|
|
}
|
|
|
|
bool ArgsManager::IsArgSet(const std::string& strArg) const
|
|
{
|
|
return !GetSetting(strArg).isNull();
|
|
}
|
|
|
|
bool ArgsManager::InitSettings(std::string& error)
|
|
{
|
|
if (!GetSettingsPath()) {
|
|
return true; // Do nothing if settings file disabled.
|
|
}
|
|
|
|
std::vector<std::string> errors;
|
|
if (!ReadSettingsFile(&errors)) {
|
|
error = strprintf("Failed loading settings file:\n%s\n", MakeUnorderedList(errors));
|
|
return false;
|
|
}
|
|
if (!WriteSettingsFile(&errors)) {
|
|
error = strprintf("Failed saving settings file:\n%s\n", MakeUnorderedList(errors));
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
|
|
{
|
|
fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
|
|
if (settings.empty()) {
|
|
return false;
|
|
}
|
|
if (backup) {
|
|
settings += ".bak";
|
|
}
|
|
if (filepath) {
|
|
*filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
|
|
{
|
|
for (const auto& error : errors) {
|
|
if (error_out) {
|
|
error_out->emplace_back(error);
|
|
} else {
|
|
LogPrintf("%s\n", error);
|
|
}
|
|
}
|
|
}
|
|
|
|
bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
|
|
{
|
|
fs::path path;
|
|
if (!GetSettingsPath(&path, /* temp= */ false)) {
|
|
return true; // Do nothing if settings file disabled.
|
|
}
|
|
|
|
LOCK(cs_args);
|
|
m_settings.rw_settings.clear();
|
|
std::vector<std::string> read_errors;
|
|
if (!util::ReadSettings(path, m_settings.rw_settings, read_errors)) {
|
|
SaveErrors(read_errors, errors);
|
|
return false;
|
|
}
|
|
for (const auto& setting : m_settings.rw_settings) {
|
|
KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
|
|
if (!GetArgFlags('-' + key.name)) {
|
|
LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
|
|
{
|
|
fs::path path, path_tmp;
|
|
if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
|
|
throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
|
|
}
|
|
|
|
LOCK(cs_args);
|
|
std::vector<std::string> write_errors;
|
|
if (!util::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
|
|
SaveErrors(write_errors, errors);
|
|
return false;
|
|
}
|
|
if (!RenameOver(path_tmp, path)) {
|
|
SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
util::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const
|
|
{
|
|
LOCK(cs_args);
|
|
return util::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
|
|
/*ignore_nonpersistent=*/true, /*get_chain_name=*/false);
|
|
}
|
|
|
|
bool ArgsManager::IsArgNegated(const std::string& strArg) const
|
|
{
|
|
return GetSetting(strArg).isFalse();
|
|
}
|
|
|
|
std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
|
|
{
|
|
return GetArg(strArg).value_or(strDefault);
|
|
}
|
|
|
|
std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
|
|
{
|
|
const util::SettingsValue value = GetSetting(strArg);
|
|
return SettingToString(value);
|
|
}
|
|
|
|
std::optional<std::string> SettingToString(const util::SettingsValue& value)
|
|
{
|
|
if (value.isNull()) return std::nullopt;
|
|
if (value.isFalse()) return "0";
|
|
if (value.isTrue()) return "1";
|
|
if (value.isNum()) return value.getValStr();
|
|
return value.get_str();
|
|
}
|
|
|
|
std::string SettingToString(const util::SettingsValue& value, const std::string& strDefault)
|
|
{
|
|
return SettingToString(value).value_or(strDefault);
|
|
}
|
|
|
|
int64_t ArgsManager::GetIntArg(const std::string& strArg, int64_t nDefault) const
|
|
{
|
|
return GetIntArg(strArg).value_or(nDefault);
|
|
}
|
|
|
|
std::optional<int64_t> ArgsManager::GetIntArg(const std::string& strArg) const
|
|
{
|
|
const util::SettingsValue value = GetSetting(strArg);
|
|
return SettingToInt(value);
|
|
}
|
|
|
|
std::optional<int64_t> SettingToInt(const util::SettingsValue& value)
|
|
{
|
|
if (value.isNull()) return std::nullopt;
|
|
if (value.isFalse()) return 0;
|
|
if (value.isTrue()) return 1;
|
|
if (value.isNum()) return value.getInt<int64_t>();
|
|
return LocaleIndependentAtoi<int64_t>(value.get_str());
|
|
}
|
|
|
|
int64_t SettingToInt(const util::SettingsValue& value, int64_t nDefault)
|
|
{
|
|
return SettingToInt(value).value_or(nDefault);
|
|
}
|
|
|
|
bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
|
|
{
|
|
return GetBoolArg(strArg).value_or(fDefault);
|
|
}
|
|
|
|
std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
|
|
{
|
|
const util::SettingsValue value = GetSetting(strArg);
|
|
return SettingToBool(value);
|
|
}
|
|
|
|
std::optional<bool> SettingToBool(const util::SettingsValue& value)
|
|
{
|
|
if (value.isNull()) return std::nullopt;
|
|
if (value.isBool()) return value.get_bool();
|
|
return InterpretBool(value.get_str());
|
|
}
|
|
|
|
bool SettingToBool(const util::SettingsValue& value, bool fDefault)
|
|
{
|
|
return SettingToBool(value).value_or(fDefault);
|
|
}
|
|
|
|
bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
|
|
{
|
|
LOCK(cs_args);
|
|
if (IsArgSet(strArg)) return false;
|
|
ForceSetArg(strArg, strValue);
|
|
return true;
|
|
}
|
|
|
|
bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
|
|
{
|
|
if (fValue)
|
|
return SoftSetArg(strArg, std::string("1"));
|
|
else
|
|
return SoftSetArg(strArg, std::string("0"));
|
|
}
|
|
|
|
void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
|
|
{
|
|
LOCK(cs_args);
|
|
m_settings.forced_settings[SettingName(strArg)] = strValue;
|
|
}
|
|
|
|
void ArgsManager::AddCommand(const std::string& cmd, const std::string& help)
|
|
{
|
|
Assert(cmd.find('=') == std::string::npos);
|
|
Assert(cmd.at(0) != '-');
|
|
|
|
LOCK(cs_args);
|
|
m_accept_any_command = false; // latch to false
|
|
std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
|
|
auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
|
|
Assert(ret.second); // Fail on duplicate commands
|
|
}
|
|
|
|
void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
|
|
{
|
|
Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
|
|
|
|
// Split arg name from its help param
|
|
size_t eq_index = name.find('=');
|
|
if (eq_index == std::string::npos) {
|
|
eq_index = name.size();
|
|
}
|
|
std::string arg_name = name.substr(0, eq_index);
|
|
|
|
LOCK(cs_args);
|
|
std::map<std::string, Arg>& arg_map = m_available_args[cat];
|
|
auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
|
|
assert(ret.second); // Make sure an insertion actually happened
|
|
|
|
if (flags & ArgsManager::NETWORK_ONLY) {
|
|
m_network_only_args.emplace(arg_name);
|
|
}
|
|
}
|
|
|
|
void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
|
|
{
|
|
for (const std::string& name : names) {
|
|
AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
|
|
}
|
|
}
|
|
|
|
std::string ArgsManager::GetHelpMessage() const
|
|
{
|
|
const bool show_debug = GetBoolArg("-help-debug", false);
|
|
|
|
std::string usage;
|
|
LOCK(cs_args);
|
|
for (const auto& arg_map : m_available_args) {
|
|
switch(arg_map.first) {
|
|
case OptionsCategory::OPTIONS:
|
|
usage += HelpMessageGroup("Options:");
|
|
break;
|
|
case OptionsCategory::CONNECTION:
|
|
usage += HelpMessageGroup("Connection options:");
|
|
break;
|
|
case OptionsCategory::ZMQ:
|
|
usage += HelpMessageGroup("ZeroMQ notification options:");
|
|
break;
|
|
case OptionsCategory::DEBUG_TEST:
|
|
usage += HelpMessageGroup("Debugging/Testing options:");
|
|
break;
|
|
case OptionsCategory::NODE_RELAY:
|
|
usage += HelpMessageGroup("Node relay options:");
|
|
break;
|
|
case OptionsCategory::BLOCK_CREATION:
|
|
usage += HelpMessageGroup("Block creation options:");
|
|
break;
|
|
case OptionsCategory::RPC:
|
|
usage += HelpMessageGroup("RPC server options:");
|
|
break;
|
|
case OptionsCategory::WALLET:
|
|
usage += HelpMessageGroup("Wallet options:");
|
|
break;
|
|
case OptionsCategory::WALLET_DEBUG_TEST:
|
|
if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
|
|
break;
|
|
case OptionsCategory::CHAINPARAMS:
|
|
usage += HelpMessageGroup("Chain selection options:");
|
|
break;
|
|
case OptionsCategory::GUI:
|
|
usage += HelpMessageGroup("UI Options:");
|
|
break;
|
|
case OptionsCategory::COMMANDS:
|
|
usage += HelpMessageGroup("Commands:");
|
|
break;
|
|
case OptionsCategory::REGISTER_COMMANDS:
|
|
usage += HelpMessageGroup("Register Commands:");
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
// When we get to the hidden options, stop
|
|
if (arg_map.first == OptionsCategory::HIDDEN) break;
|
|
|
|
for (const auto& arg : arg_map.second) {
|
|
if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
|
|
std::string name;
|
|
if (arg.second.m_help_param.empty()) {
|
|
name = arg.first;
|
|
} else {
|
|
name = arg.first + arg.second.m_help_param;
|
|
}
|
|
usage += HelpMessageOpt(name, arg.second.m_help_text);
|
|
}
|
|
}
|
|
}
|
|
return usage;
|
|
}
|
|
|
|
bool HelpRequested(const ArgsManager& args)
|
|
{
|
|
return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
|
|
}
|
|
|
|
void SetupHelpOptions(ArgsManager& args)
|
|
{
|
|
args.AddArg("-?", "Print this help message and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
args.AddHiddenArgs({"-h", "-help"});
|
|
}
|
|
|
|
static const int screenWidth = 79;
|
|
static const int optIndent = 2;
|
|
static const int msgIndent = 7;
|
|
|
|
std::string HelpMessageGroup(const std::string &message) {
|
|
return std::string(message) + std::string("\n\n");
|
|
}
|
|
|
|
std::string HelpMessageOpt(const std::string &option, const std::string &message) {
|
|
return std::string(optIndent,' ') + std::string(option) +
|
|
std::string("\n") + std::string(msgIndent,' ') +
|
|
FormatParagraph(message, screenWidth - msgIndent, msgIndent) +
|
|
std::string("\n\n");
|
|
}
|
|
|
|
static std::string FormatException(const std::exception* pex, std::string_view thread_name)
|
|
{
|
|
#ifdef WIN32
|
|
char pszModule[MAX_PATH] = "";
|
|
GetModuleFileNameA(nullptr, pszModule, sizeof(pszModule));
|
|
#else
|
|
const char* pszModule = "bitcoin";
|
|
#endif
|
|
if (pex)
|
|
return strprintf(
|
|
"EXCEPTION: %s \n%s \n%s in %s \n", typeid(*pex).name(), pex->what(), pszModule, thread_name);
|
|
else
|
|
return strprintf(
|
|
"UNKNOWN EXCEPTION \n%s in %s \n", pszModule, thread_name);
|
|
}
|
|
|
|
void PrintExceptionContinue(const std::exception* pex, std::string_view thread_name)
|
|
{
|
|
std::string message = FormatException(pex, thread_name);
|
|
LogPrintf("\n\n************************\n%s\n", message);
|
|
tfm::format(std::cerr, "\n\n************************\n%s\n", message);
|
|
}
|
|
|
|
fs::path GetDefaultDataDir()
|
|
{
|
|
// Windows: C:\Users\Username\AppData\Roaming\Bitcoin
|
|
// macOS: ~/Library/Application Support/Bitcoin
|
|
// Unix-like: ~/.bitcoin
|
|
#ifdef WIN32
|
|
// Windows
|
|
return GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
|
|
#else
|
|
fs::path pathRet;
|
|
char* pszHome = getenv("HOME");
|
|
if (pszHome == nullptr || strlen(pszHome) == 0)
|
|
pathRet = fs::path("/");
|
|
else
|
|
pathRet = fs::path(pszHome);
|
|
#ifdef MAC_OSX
|
|
// macOS
|
|
return pathRet / "Library/Application Support/Bitcoin";
|
|
#else
|
|
// Unix-like
|
|
return pathRet / ".bitcoin";
|
|
#endif
|
|
#endif
|
|
}
|
|
|
|
bool CheckDataDirOption()
|
|
{
|
|
const fs::path datadir{gArgs.GetPathArg("-datadir")};
|
|
return datadir.empty() || fs::is_directory(fs::absolute(datadir));
|
|
}
|
|
|
|
fs::path GetConfigFile(const fs::path& configuration_file_path)
|
|
{
|
|
return AbsPathForConfigVal(configuration_file_path, /*net_specific=*/false);
|
|
}
|
|
|
|
static bool GetConfigOptions(std::istream& stream, const std::string& filepath, std::string& error, std::vector<std::pair<std::string, std::string>>& options, std::list<SectionInfo>& sections)
|
|
{
|
|
std::string str, prefix;
|
|
std::string::size_type pos;
|
|
int linenr = 1;
|
|
while (std::getline(stream, str)) {
|
|
bool used_hash = false;
|
|
if ((pos = str.find('#')) != std::string::npos) {
|
|
str = str.substr(0, pos);
|
|
used_hash = true;
|
|
}
|
|
const static std::string pattern = " \t\r\n";
|
|
str = TrimString(str, pattern);
|
|
if (!str.empty()) {
|
|
if (*str.begin() == '[' && *str.rbegin() == ']') {
|
|
const std::string section = str.substr(1, str.size() - 2);
|
|
sections.emplace_back(SectionInfo{section, filepath, linenr});
|
|
prefix = section + '.';
|
|
} else if (*str.begin() == '-') {
|
|
error = strprintf("parse error on line %i: %s, options in configuration file must be specified without leading -", linenr, str);
|
|
return false;
|
|
} else if ((pos = str.find('=')) != std::string::npos) {
|
|
std::string name = prefix + TrimString(std::string_view{str}.substr(0, pos), pattern);
|
|
std::string_view value = TrimStringView(std::string_view{str}.substr(pos + 1), pattern);
|
|
if (used_hash && name.find("rpcpassword") != std::string::npos) {
|
|
error = strprintf("parse error on line %i, using # in rpcpassword can be ambiguous and should be avoided", linenr);
|
|
return false;
|
|
}
|
|
options.emplace_back(name, value);
|
|
if ((pos = name.rfind('.')) != std::string::npos && prefix.length() <= pos) {
|
|
sections.emplace_back(SectionInfo{name.substr(0, pos), filepath, linenr});
|
|
}
|
|
} else {
|
|
error = strprintf("parse error on line %i: %s", linenr, str);
|
|
if (str.size() >= 2 && str.substr(0, 2) == "no") {
|
|
error += strprintf(", if you intended to specify a negated option, use %s=1 instead", str);
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
++linenr;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool ArgsManager::ReadConfigStream(std::istream& stream, const std::string& filepath, std::string& error, bool ignore_invalid_keys)
|
|
{
|
|
LOCK(cs_args);
|
|
std::vector<std::pair<std::string, std::string>> options;
|
|
if (!GetConfigOptions(stream, filepath, error, options, m_config_sections)) {
|
|
return false;
|
|
}
|
|
for (const std::pair<std::string, std::string>& option : options) {
|
|
KeyInfo key = InterpretKey(option.first);
|
|
std::optional<unsigned int> flags = GetArgFlags('-' + key.name);
|
|
if (flags) {
|
|
std::optional<util::SettingsValue> value = InterpretValue(key, &option.second, *flags, error);
|
|
if (!value) {
|
|
return false;
|
|
}
|
|
m_settings.ro_config[key.section][key.name].push_back(*value);
|
|
} else {
|
|
if (ignore_invalid_keys) {
|
|
LogPrintf("Ignoring unknown configuration value %s\n", option.first);
|
|
} else {
|
|
error = strprintf("Invalid configuration value %s", option.first);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool ArgsManager::ReadConfigFiles(std::string& error, bool ignore_invalid_keys)
|
|
{
|
|
{
|
|
LOCK(cs_args);
|
|
m_settings.ro_config.clear();
|
|
m_config_sections.clear();
|
|
}
|
|
|
|
const fs::path conf_path = GetPathArg("-conf", BITCOIN_CONF_FILENAME);
|
|
std::ifstream stream{GetConfigFile(conf_path)};
|
|
|
|
// not ok to have a config file specified that cannot be opened
|
|
if (IsArgSet("-conf") && !stream.good()) {
|
|
error = strprintf("specified config file \"%s\" could not be opened.", fs::PathToString(conf_path));
|
|
return false;
|
|
}
|
|
// ok to not have a config file
|
|
if (stream.good()) {
|
|
if (!ReadConfigStream(stream, fs::PathToString(conf_path), error, ignore_invalid_keys)) {
|
|
return false;
|
|
}
|
|
// `-includeconf` cannot be included in the command line arguments except
|
|
// as `-noincludeconf` (which indicates that no included conf file should be used).
|
|
bool use_conf_file{true};
|
|
{
|
|
LOCK(cs_args);
|
|
if (auto* includes = util::FindKey(m_settings.command_line_options, "includeconf")) {
|
|
// ParseParameters() fails if a non-negated -includeconf is passed on the command-line
|
|
assert(util::SettingsSpan(*includes).last_negated());
|
|
use_conf_file = false;
|
|
}
|
|
}
|
|
if (use_conf_file) {
|
|
std::string chain_id = GetChainName();
|
|
std::vector<std::string> conf_file_names;
|
|
|
|
auto add_includes = [&](const std::string& network, size_t skip = 0) {
|
|
size_t num_values = 0;
|
|
LOCK(cs_args);
|
|
if (auto* section = util::FindKey(m_settings.ro_config, network)) {
|
|
if (auto* values = util::FindKey(*section, "includeconf")) {
|
|
for (size_t i = std::max(skip, util::SettingsSpan(*values).negated()); i < values->size(); ++i) {
|
|
conf_file_names.push_back((*values)[i].get_str());
|
|
}
|
|
num_values = values->size();
|
|
}
|
|
}
|
|
return num_values;
|
|
};
|
|
|
|
// We haven't set m_network yet (that happens in SelectParams()), so manually check
|
|
// for network.includeconf args.
|
|
const size_t chain_includes = add_includes(chain_id);
|
|
const size_t default_includes = add_includes({});
|
|
|
|
for (const std::string& conf_file_name : conf_file_names) {
|
|
std::ifstream conf_file_stream{GetConfigFile(fs::PathFromString(conf_file_name))};
|
|
if (conf_file_stream.good()) {
|
|
if (!ReadConfigStream(conf_file_stream, conf_file_name, error, ignore_invalid_keys)) {
|
|
return false;
|
|
}
|
|
LogPrintf("Included configuration file %s\n", conf_file_name);
|
|
} else {
|
|
error = "Failed to include configuration file " + conf_file_name;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Warn about recursive -includeconf
|
|
conf_file_names.clear();
|
|
add_includes(chain_id, /* skip= */ chain_includes);
|
|
add_includes({}, /* skip= */ default_includes);
|
|
std::string chain_id_final = GetChainName();
|
|
if (chain_id_final != chain_id) {
|
|
// Also warn about recursive includeconf for the chain that was specified in one of the includeconfs
|
|
add_includes(chain_id_final);
|
|
}
|
|
for (const std::string& conf_file_name : conf_file_names) {
|
|
tfm::format(std::cerr, "warning: -includeconf cannot be used from included files; ignoring -includeconf=%s\n", conf_file_name);
|
|
}
|
|
}
|
|
}
|
|
|
|
// If datadir is changed in .conf file:
|
|
gArgs.ClearPathCache();
|
|
if (!CheckDataDirOption()) {
|
|
error = strprintf("specified data directory \"%s\" does not exist.", GetArg("-datadir", ""));
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::string ArgsManager::GetChainName() const
|
|
{
|
|
auto get_net = [&](const std::string& arg) {
|
|
LOCK(cs_args);
|
|
util::SettingsValue value = util::GetSetting(m_settings, /* section= */ "", SettingName(arg),
|
|
/* ignore_default_section_config= */ false,
|
|
/*ignore_nonpersistent=*/false,
|
|
/* get_chain_name= */ true);
|
|
return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
|
|
};
|
|
|
|
const bool fRegTest = get_net("-regtest");
|
|
const bool fSigNet = get_net("-signet");
|
|
const bool fTestNet = get_net("-testnet");
|
|
const bool is_chain_arg_set = IsArgSet("-chain");
|
|
|
|
if ((int)is_chain_arg_set + (int)fRegTest + (int)fSigNet + (int)fTestNet > 1) {
|
|
throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet and -chain. Can use at most one.");
|
|
}
|
|
if (fRegTest)
|
|
return CBaseChainParams::REGTEST;
|
|
if (fSigNet) {
|
|
return CBaseChainParams::SIGNET;
|
|
}
|
|
if (fTestNet)
|
|
return CBaseChainParams::TESTNET;
|
|
|
|
return GetArg("-chain", CBaseChainParams::MAIN);
|
|
}
|
|
|
|
bool ArgsManager::UseDefaultSection(const std::string& arg) const
|
|
{
|
|
return m_network == CBaseChainParams::MAIN || m_network_only_args.count(arg) == 0;
|
|
}
|
|
|
|
util::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
|
|
{
|
|
LOCK(cs_args);
|
|
return util::GetSetting(
|
|
m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
|
|
/*ignore_nonpersistent=*/false, /*get_chain_name=*/false);
|
|
}
|
|
|
|
std::vector<util::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
|
|
{
|
|
LOCK(cs_args);
|
|
return util::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
|
|
}
|
|
|
|
void ArgsManager::logArgsPrefix(
|
|
const std::string& prefix,
|
|
const std::string& section,
|
|
const std::map<std::string, std::vector<util::SettingsValue>>& args) const
|
|
{
|
|
std::string section_str = section.empty() ? "" : "[" + section + "] ";
|
|
for (const auto& arg : args) {
|
|
for (const auto& value : arg.second) {
|
|
std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
|
|
if (flags) {
|
|
std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
|
|
LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void ArgsManager::LogArgs() const
|
|
{
|
|
LOCK(cs_args);
|
|
for (const auto& section : m_settings.ro_config) {
|
|
logArgsPrefix("Config file arg:", section.first, section.second);
|
|
}
|
|
for (const auto& setting : m_settings.rw_settings) {
|
|
LogPrintf("Setting file arg: %s = %s\n", setting.first, setting.second.write());
|
|
}
|
|
logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
|
|
}
|
|
|
|
bool RenameOver(fs::path src, fs::path dest)
|
|
{
|
|
#ifdef __MINGW64__
|
|
// This is a workaround for a bug in libstdc++ which
|
|
// implements std::filesystem::rename with _wrename function.
|
|
// This bug has been fixed in upstream:
|
|
// - GCC 10.3: 8dd1c1085587c9f8a21bb5e588dfe1e8cdbba79e
|
|
// - GCC 11.1: 1dfd95f0a0ca1d9e6cbc00e6cbfd1fa20a98f312
|
|
// For more details see the commits mentioned above.
|
|
return MoveFileExW(src.wstring().c_str(), dest.wstring().c_str(),
|
|
MOVEFILE_REPLACE_EXISTING) != 0;
|
|
#else
|
|
std::error_code error;
|
|
fs::rename(src, dest, error);
|
|
return !error;
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Ignores exceptions thrown by create_directories if the requested directory exists.
|
|
* Specifically handles case where path p exists, but it wasn't possible for the user to
|
|
* write to the parent directory.
|
|
*/
|
|
bool TryCreateDirectories(const fs::path& p)
|
|
{
|
|
try
|
|
{
|
|
return fs::create_directories(p);
|
|
} catch (const fs::filesystem_error&) {
|
|
if (!fs::exists(p) || !fs::is_directory(p))
|
|
throw;
|
|
}
|
|
|
|
// create_directories didn't create the directory, it had to have existed already
|
|
return false;
|
|
}
|
|
|
|
bool FileCommit(FILE *file)
|
|
{
|
|
if (fflush(file) != 0) { // harmless if redundantly called
|
|
LogPrintf("%s: fflush failed: %d\n", __func__, errno);
|
|
return false;
|
|
}
|
|
#ifdef WIN32
|
|
HANDLE hFile = (HANDLE)_get_osfhandle(_fileno(file));
|
|
if (FlushFileBuffers(hFile) == 0) {
|
|
LogPrintf("%s: FlushFileBuffers failed: %d\n", __func__, GetLastError());
|
|
return false;
|
|
}
|
|
#elif defined(MAC_OSX) && defined(F_FULLFSYNC)
|
|
if (fcntl(fileno(file), F_FULLFSYNC, 0) == -1) { // Manpage says "value other than -1" is returned on success
|
|
LogPrintf("%s: fcntl F_FULLFSYNC failed: %d\n", __func__, errno);
|
|
return false;
|
|
}
|
|
#elif HAVE_FDATASYNC
|
|
if (fdatasync(fileno(file)) != 0 && errno != EINVAL) { // Ignore EINVAL for filesystems that don't support sync
|
|
LogPrintf("%s: fdatasync failed: %d\n", __func__, errno);
|
|
return false;
|
|
}
|
|
#else
|
|
if (fsync(fileno(file)) != 0 && errno != EINVAL) {
|
|
LogPrintf("%s: fsync failed: %d\n", __func__, errno);
|
|
return false;
|
|
}
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
void DirectoryCommit(const fs::path &dirname)
|
|
{
|
|
#ifndef WIN32
|
|
FILE* file = fsbridge::fopen(dirname, "r");
|
|
if (file) {
|
|
fsync(fileno(file));
|
|
fclose(file);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
bool TruncateFile(FILE *file, unsigned int length) {
|
|
#if defined(WIN32)
|
|
return _chsize(_fileno(file), length) == 0;
|
|
#else
|
|
return ftruncate(fileno(file), length) == 0;
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* this function tries to raise the file descriptor limit to the requested number.
|
|
* It returns the actual file descriptor limit (which may be more or less than nMinFD)
|
|
*/
|
|
int RaiseFileDescriptorLimit(int nMinFD) {
|
|
#if defined(WIN32)
|
|
return 2048;
|
|
#else
|
|
struct rlimit limitFD;
|
|
if (getrlimit(RLIMIT_NOFILE, &limitFD) != -1) {
|
|
if (limitFD.rlim_cur < (rlim_t)nMinFD) {
|
|
limitFD.rlim_cur = nMinFD;
|
|
if (limitFD.rlim_cur > limitFD.rlim_max)
|
|
limitFD.rlim_cur = limitFD.rlim_max;
|
|
setrlimit(RLIMIT_NOFILE, &limitFD);
|
|
getrlimit(RLIMIT_NOFILE, &limitFD);
|
|
}
|
|
return limitFD.rlim_cur;
|
|
}
|
|
return nMinFD; // getrlimit failed, assume it's fine
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* this function tries to make a particular range of a file allocated (corresponding to disk space)
|
|
* it is advisory, and the range specified in the arguments will never contain live data
|
|
*/
|
|
void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length) {
|
|
#if defined(WIN32)
|
|
// Windows-specific version
|
|
HANDLE hFile = (HANDLE)_get_osfhandle(_fileno(file));
|
|
LARGE_INTEGER nFileSize;
|
|
int64_t nEndPos = (int64_t)offset + length;
|
|
nFileSize.u.LowPart = nEndPos & 0xFFFFFFFF;
|
|
nFileSize.u.HighPart = nEndPos >> 32;
|
|
SetFilePointerEx(hFile, nFileSize, 0, FILE_BEGIN);
|
|
SetEndOfFile(hFile);
|
|
#elif defined(MAC_OSX)
|
|
// OSX specific version
|
|
// NOTE: Contrary to other OS versions, the OSX version assumes that
|
|
// NOTE: offset is the size of the file.
|
|
fstore_t fst;
|
|
fst.fst_flags = F_ALLOCATECONTIG;
|
|
fst.fst_posmode = F_PEOFPOSMODE;
|
|
fst.fst_offset = 0;
|
|
fst.fst_length = length; // mac os fst_length takes the # of free bytes to allocate, not desired file size
|
|
fst.fst_bytesalloc = 0;
|
|
if (fcntl(fileno(file), F_PREALLOCATE, &fst) == -1) {
|
|
fst.fst_flags = F_ALLOCATEALL;
|
|
fcntl(fileno(file), F_PREALLOCATE, &fst);
|
|
}
|
|
ftruncate(fileno(file), static_cast<off_t>(offset) + length);
|
|
#else
|
|
#if defined(HAVE_POSIX_FALLOCATE)
|
|
// Version using posix_fallocate
|
|
off_t nEndPos = (off_t)offset + length;
|
|
if (0 == posix_fallocate(fileno(file), 0, nEndPos)) return;
|
|
#endif
|
|
// Fallback version
|
|
// TODO: just write one byte per block
|
|
static const char buf[65536] = {};
|
|
if (fseek(file, offset, SEEK_SET)) {
|
|
return;
|
|
}
|
|
while (length > 0) {
|
|
unsigned int now = 65536;
|
|
if (length < now)
|
|
now = length;
|
|
fwrite(buf, 1, now, file); // allowed to fail; this function is advisory anyway
|
|
length -= now;
|
|
}
|
|
#endif
|
|
}
|
|
|
|
#ifdef WIN32
|
|
fs::path GetSpecialFolderPath(int nFolder, bool fCreate)
|
|
{
|
|
WCHAR pszPath[MAX_PATH] = L"";
|
|
|
|
if(SHGetSpecialFolderPathW(nullptr, pszPath, nFolder, fCreate))
|
|
{
|
|
return fs::path(pszPath);
|
|
}
|
|
|
|
LogPrintf("SHGetSpecialFolderPathW() failed, could not obtain requested path.\n");
|
|
return fs::path("");
|
|
}
|
|
#endif
|
|
|
|
#ifndef WIN32
|
|
std::string ShellEscape(const std::string& arg)
|
|
{
|
|
std::string escaped = arg;
|
|
ReplaceAll(escaped, "'", "'\"'\"'");
|
|
return "'" + escaped + "'";
|
|
}
|
|
#endif
|
|
|
|
#if HAVE_SYSTEM
|
|
void runCommand(const std::string& strCommand)
|
|
{
|
|
if (strCommand.empty()) return;
|
|
#ifndef WIN32
|
|
int nErr = ::system(strCommand.c_str());
|
|
#else
|
|
int nErr = ::_wsystem(std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>,wchar_t>().from_bytes(strCommand).c_str());
|
|
#endif
|
|
if (nErr)
|
|
LogPrintf("runCommand error: system(%s) returned %d\n", strCommand, nErr);
|
|
}
|
|
#endif
|
|
|
|
|
|
void SetupEnvironment()
|
|
{
|
|
#ifdef HAVE_MALLOPT_ARENA_MAX
|
|
// glibc-specific: On 32-bit systems set the number of arenas to 1.
|
|
// By default, since glibc 2.10, the C library will create up to two heap
|
|
// arenas per core. This is known to cause excessive virtual address space
|
|
// usage in our usage. Work around it by setting the maximum number of
|
|
// arenas to 1.
|
|
if (sizeof(void*) == 4) {
|
|
mallopt(M_ARENA_MAX, 1);
|
|
}
|
|
#endif
|
|
// On most POSIX systems (e.g. Linux, but not BSD) the environment's locale
|
|
// may be invalid, in which case the "C.UTF-8" locale is used as fallback.
|
|
#if !defined(WIN32) && !defined(MAC_OSX) && !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
|
|
try {
|
|
std::locale(""); // Raises a runtime error if current locale is invalid
|
|
} catch (const std::runtime_error&) {
|
|
setenv("LC_ALL", "C.UTF-8", 1);
|
|
}
|
|
#elif defined(WIN32)
|
|
// Set the default input/output charset is utf-8
|
|
SetConsoleCP(CP_UTF8);
|
|
SetConsoleOutputCP(CP_UTF8);
|
|
#endif
|
|
}
|
|
|
|
bool SetupNetworking()
|
|
{
|
|
#ifdef WIN32
|
|
// Initialize Windows Sockets
|
|
WSADATA wsadata;
|
|
int ret = WSAStartup(MAKEWORD(2,2), &wsadata);
|
|
if (ret != NO_ERROR || LOBYTE(wsadata.wVersion ) != 2 || HIBYTE(wsadata.wVersion) != 2)
|
|
return false;
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
int GetNumCores()
|
|
{
|
|
return std::thread::hardware_concurrency();
|
|
}
|
|
|
|
// Obtain the application startup time (used for uptime calculation)
|
|
int64_t GetStartupTime()
|
|
{
|
|
return nStartupTime;
|
|
}
|
|
|
|
fs::path AbsPathForConfigVal(const fs::path& path, bool net_specific)
|
|
{
|
|
if (path.is_absolute()) {
|
|
return path;
|
|
}
|
|
return fsbridge::AbsPathJoin(net_specific ? gArgs.GetDataDirNet() : gArgs.GetDataDirBase(), path);
|
|
}
|
|
|
|
void ScheduleBatchPriority()
|
|
{
|
|
#ifdef SCHED_BATCH
|
|
const static sched_param param{};
|
|
const int rc = pthread_setschedparam(pthread_self(), SCHED_BATCH, ¶m);
|
|
if (rc != 0) {
|
|
LogPrintf("Failed to pthread_setschedparam: %s\n", SysErrorString(rc));
|
|
}
|
|
#endif
|
|
}
|
|
|
|
namespace util {
|
|
#ifdef WIN32
|
|
WinCmdLineArgs::WinCmdLineArgs()
|
|
{
|
|
wchar_t** wargv = CommandLineToArgvW(GetCommandLineW(), &argc);
|
|
std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>, wchar_t> utf8_cvt;
|
|
argv = new char*[argc];
|
|
args.resize(argc);
|
|
for (int i = 0; i < argc; i++) {
|
|
args[i] = utf8_cvt.to_bytes(wargv[i]);
|
|
argv[i] = &*args[i].begin();
|
|
}
|
|
LocalFree(wargv);
|
|
}
|
|
|
|
WinCmdLineArgs::~WinCmdLineArgs()
|
|
{
|
|
delete[] argv;
|
|
}
|
|
|
|
std::pair<int, char**> WinCmdLineArgs::get()
|
|
{
|
|
return std::make_pair(argc, argv);
|
|
}
|
|
#endif
|
|
} // namespace util
|