10 #ifndef BITCOIN_UTIL_SYSTEM_H
11 #define BITCOIN_UTIL_SYSTEM_H
13 #if defined(HAVE_CONFIG_H)
14 #include <config/bitcoin-config.h>
45 template <
typename... Args>
bool error(
const char *fmt,
const Args &...args) {
57 bool probe_only =
false);
59 const std::string &lockfile_name);
72 std::streamsize max = std::numeric_limits<std::streamsize>::max());
87 fs::path GetSpecialFolderPath(
int nFolder,
bool fCreate =
true);
92 #if defined(HAVE_SYSTEM)
93 void runCommand(
const std::string &strCommand);
96 [[nodiscard]]
bool ParseKeyValue(std::string &key, std::string &val);
110 return c ==
'-' || c ==
'/';
175 std::map<OptionsCategory, std::map<std::string, Arg>>
183 const std::string &filepath,
185 bool ignore_invalid_keys =
false);
207 std::vector<util::SettingsValue>
222 bool ignore_invalid_keys =
false);
272 std::vector<std::string>
GetArgs(
const std::string &strArg)
const;
280 bool IsArgSet(
const std::string &strArg)
const;
298 std::string
GetArg(
const std::string &strArg,
299 const std::string &strDefault)
const;
308 int64_t
GetIntArg(
const std::string &strArg, int64_t nDefault)
const;
317 bool GetBoolArg(
const std::string &strArg,
bool fDefault)
const;
326 bool SoftSetArg(
const std::string &strArg,
const std::string &strValue);
339 void ForceSetArg(
const std::string &strArg,
const std::string &strValue);
343 const std::vector<std::string> &values);
374 m_available_args.clear();
375 m_network_only_args.clear();
387 std::optional<unsigned int>
GetArgFlags(
const std::string &
name)
const;
440 const std::map<std::string, std::vector<util::SettingsValue>>
470 const std::string &message);
491 template <
typename Tdst,
typename Tsrc>
492 inline void insert(Tdst &dst,
const Tsrc &src) {
493 dst.insert(dst.begin(), src.begin(), src.end());
495 template <
typename TsetT,
typename Tsrc>
496 inline void insert(std::set<TsetT> &dst,
const Tsrc &src) {
497 dst.insert(src.begin(), src.end());
505 template <
typename T> T *
AnyPtr(
const std::any &any) noexcept {
506 T *
const *ptr = std::any_cast<T *>(&any);
507 return ptr ? *ptr :
nullptr;
511 class WinCmdLineArgs {
515 std::pair<int, char **> get();
520 std::vector<std::string> args;
const std::set< std::string > GetUnsuitableSectionOnlyArgs() const
Log warnings for options in m_section_only_args when they are specified in the default section but no...
const fs::path & GetBlocksDirPath() const
Get blocks directory path.
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
void ForceSetArg(const std::string &strArg, const std::string &strValue)
void logArgsPrefix(const std::string &prefix, const std::string §ion, const std::map< std::string, std::vector< util::SettingsValue >> &args) const
bool InitSettings(std::string &error)
Read and update settings file with saved settings.
fs::path m_cached_datadir_path GUARDED_BY(cs_args)
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr) const
Write settings file.
bool ParseParameters(int argc, const char *const argv[], std::string &error)
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
const fs::path & GetDataDirBase() const
Get data directory path.
std::string m_network GUARDED_BY(cs_args)
void LockSettings(Fn &&fn)
Access settings with lock held.
bool SoftSetArg(const std::string &strArg, const std::string &strValue)
Set an argument if it doesn't already have a value.
void SelectConfigNetwork(const std::string &network)
Select the network in use.
std::string GetHelpMessage() const
Get the help string.
void ForceSetMultiArg(const std::string &strArg, const std::vector< std::string > &values)
This function is only used for testing purpose so so we should not worry about element uniqueness and...
void ClearPathCache()
Clear cached directory paths.
fs::path m_cached_blocks_path GUARDED_BY(cs_args)
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
const fs::path & GetDataDirNet() const
Get data directory path with appended network identifier.
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
std::map< OptionsCategory, std::map< std::string, Arg > > m_available_args GUARDED_BY(cs_args)
const fs::path & GetDataDir(bool net_specific) const
Get data directory path.
void ClearArgs()
Clear available arguments.
util::Settings m_settings GUARDED_BY(cs_args)
void ClearForcedArg(const std::string &strArg)
Remove a forced arg setting, used only in testing.
std::vector< util::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
bool GetSettingsPath(fs::path *filepath=nullptr, bool temp=false) const
Get settings file path, or return false if read-write settings were disabled with -nosettings.
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
fs::path m_cached_network_datadir_path GUARDED_BY(cs_args)
bool UseDefaultSection(const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)
Returns true if settings values from the default section should be used, depending on the current net...
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
std::set< std::string > m_network_only_args GUARDED_BY(cs_args)
util::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
bool ReadConfigStream(std::istream &stream, const std::string &filepath, std::string &error, bool ignore_invalid_keys=false)
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
bool ReadConfigFiles(std::string &error, bool ignore_invalid_keys=false)
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
std::list< SectionInfo > m_config_sections GUARDED_BY(cs_args)
const std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
std::string GetChainName() const
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.
Path class wrapper to prepare application code for transition from boost::filesystem library to std::...
T * AnyPtr(const std::any &any) noexcept
Helper function to access the contained object of a std::any instance.
void insert(Tdst &dst, const Tsrc &src)
Simplification of std insertion.
bool error(const char *fmt, const Args &...args)
bool HelpRequested(const ArgsManager &args)
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
fs::path GetDefaultDataDir()
int64_t GetStartupTime()
Server/client environment: argument handling, config file parsing, thread wrappers,...
const char *const BITCOIN_SETTINGS_FILENAME
bool ParseKeyValue(std::string &key, std::string &val)
std::string CopyrightHolders(const std::string &strPrefix)
void UnlockDirectory(const fs::path &directory, const std::string &lockfile_name)
bool CheckDataDirOption()
bool DirIsWritable(const fs::path &directory)
bool RenameOver(fs::path src, fs::path dest)
void ScheduleBatchPriority()
On platforms that support it, tell the kernel the calling thread is CPU-intensive and non-interactive...
int RaiseFileDescriptorLimit(int nMinFD)
This function tries to raise the file descriptor limit to the requested number.
std::streampos GetFileSize(const char *path, std::streamsize max=std::numeric_limits< std::streamsize >::max())
Get the size of a file by scanning it.
void ReleaseDirectoryLocks()
Release all directory locks.
bool TryCreateDirectories(const fs::path &p)
Ignores exceptions thrown by Boost's create_directories if the requested directory exists.
void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length)
This function tries to make a particular range of a file allocated (corresponding to disk space) it i...
fs::path AbsPathForConfigVal(const fs::path &path, bool net_specific=true)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
bool LockDirectory(const fs::path &directory, const std::string lockfile_name, bool probe_only=false)
fs::path GetConfigFile(const std::string &confPath)
void PrintExceptionContinue(const std::exception *pex, const char *pszThread)
std::string HelpMessageGroup(const std::string &message)
Format a string to be used as group of options in help messages.
const char *const BITCOIN_CONF_FILENAME
bool IsSwitchChar(char c)
bool TruncateFile(FILE *file, unsigned int length)
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes=0)
int GetNumCores()
Return the number of cores available on the current system.
std::string HelpMessageOpt(const std::string &option, const std::string &message)
Format a string to be used as option description in help messages.
bool FileCommit(FILE *file)
std::string ShellEscape(const std::string &arg)
#define EXCLUSIVE_LOCKS_REQUIRED(...)