Bitcoin Core  0.18.99
P2P Digital Currency
Classes | Namespaces | Functions | Variables
system.cpp File Reference
#include <util/system.h>
#include <chainparamsbase.h>
#include <util/strencodings.h>
#include <util/translation.h>
#include <stdarg.h>
#include <algorithm>
#include <fcntl.h>
#include <sched.h>
#include <sys/resource.h>
#include <sys/stat.h>
#include <thread>
Include dependency graph for system.cpp:

Go to the source code of this file.

Classes

class  ArgsManagerHelper
 Internal helper functions for ArgsManager. More...
 

Namespaces

 util
 

Functions

bool LockDirectory (const fs::path &directory, const std::string lockfile_name, bool probe_only)
 
void UnlockDirectory (const fs::path &directory, const std::string &lockfile_name)
 
void ReleaseDirectoryLocks ()
 Release all directory locks. More...
 
bool DirIsWritable (const fs::path &directory)
 
bool CheckDiskSpace (const fs::path &dir, uint64_t additional_bytes)
 
static bool InterpretBool (const std::string &strValue)
 Interpret a string argument as a boolean. More...
 
static NODISCARD bool InterpretOption (std::string key, std::string val, unsigned int flags, std::map< std::string, std::vector< std::string >> &args, std::string &error)
 Interpret -nofoo as if the user supplied -foo=0. More...
 
bool HelpRequested (const ArgsManager &args)
 
void SetupHelpOptions (ArgsManager &args)
 Add help options to the args manager. More...
 
std::string HelpMessageGroup (const std::string &message)
 Format a string to be used as group of options in help messages. More...
 
std::string HelpMessageOpt (const std::string &option, const std::string &message)
 Format a string to be used as option description in help messages. More...
 
static std::string FormatException (const std::exception *pex, const char *pszThread)
 
void PrintExceptionContinue (const std::exception *pex, const char *pszThread)
 
fs::path GetDefaultDataDir ()
 
const fs::path & GetBlocksDir ()
 
const fs::path & GetDataDir (bool fNetSpecific)
 
bool CheckDataDirOption ()
 
void ClearDatadirCache ()
 Tests only. More...
 
fs::path GetConfigFile (const std::string &confPath)
 
static std::string TrimString (const std::string &str, const std::string &pattern)
 
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)
 
bool RenameOver (fs::path src, fs::path dest)
 
bool TryCreateDirectories (const fs::path &p)
 Ignores exceptions thrown by Boost's create_directories if the requested directory exists. More...
 
bool FileCommit (FILE *file)
 
bool TruncateFile (FILE *file, unsigned int length)
 
int RaiseFileDescriptorLimit (int nMinFD)
 this function tries to raise the file descriptor limit to the requested number. More...
 
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 is advisory, and the range specified in the arguments will never contain live data More...
 
void SetupEnvironment ()
 
bool SetupNetworking ()
 
int GetNumCores ()
 Return the number of cores available on the current system. More...
 
std::string CopyrightHolders (const std::string &strPrefix)
 
int64_t GetStartupTime ()
 Server/client environment: argument handling, config file parsing, thread wrappers, startup time. More...
 
fs::path AbsPathForConfigVal (const fs::path &path, bool net_specific)
 Most paths passed as configuration arguments are treated as relative to the datadir if they are not absolute. More...
 
int ScheduleBatchPriority ()
 On platforms that support it, tell the kernel the calling thread is CPU-intensive and non-interactive. More...
 

Variables

const int64_t nStartupTime = GetTime()
 
const char *const BITCOIN_CONF_FILENAME = "bitcoin.conf"
 
ArgsManager gArgs
 
static std::map< std::string, std::unique_ptr< fsbridge::FileLock > > dir_locks
 A map that contains all the currently held directory locks. More...
 
static std::mutex cs_dir_locks
 Mutex to protect dir_locks. More...
 
static const int screenWidth = 79
 
static const int optIndent = 2
 
static const int msgIndent = 7
 
static fs::path g_blocks_path_cache_net_specific
 
static fs::path pathCached
 
static fs::path pathCachedNetSpecific
 
static RecursiveMutex csPathCached
 

Function Documentation

◆ AbsPathForConfigVal()

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 absolute.

Parameters
pathThe path to be conditionally prefixed with datadir.
net_specificForwarded to GetDataDir().
Returns
The normalized path.

Definition at line 1213 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AllocateFileRange()

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 is advisory, and the range specified in the arguments will never contain live data

Definition at line 1067 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CheckDataDirOption()

bool CheckDataDirOption ( )

Definition at line 772 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CheckDiskSpace()

bool CheckDiskSpace ( const fs::path &  dir,
uint64_t  additional_bytes 
)

Definition at line 133 of file system.cpp.

Here is the caller graph for this function:

◆ ClearDatadirCache()

void ClearDatadirCache ( )

Tests only.

Definition at line 778 of file system.cpp.

Here is the caller graph for this function:

◆ CopyrightHolders()

std::string CopyrightHolders ( const std::string &  strPrefix)

Definition at line 1195 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DirIsWritable()

bool DirIsWritable ( const fs::path &  directory)

Definition at line 120 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FileCommit()

bool FileCommit ( FILE *  file)

Definition at line 999 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FormatException()

static std::string FormatException ( const std::exception *  pex,
const char *  pszThread 
)
static

Definition at line 663 of file system.cpp.

Here is the caller graph for this function:

◆ GetBlocksDir()

const fs::path& GetBlocksDir ( )

Definition at line 717 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetConfigFile()

fs::path GetConfigFile ( const std::string &  confPath)

Definition at line 787 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetConfigOptions()

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 
)
static

Definition at line 802 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDataDir()

const fs::path& GetDataDir ( bool  fNetSpecific)

Definition at line 742 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDefaultDataDir()

fs::path GetDefaultDataDir ( )

Definition at line 686 of file system.cpp.

Here is the caller graph for this function:

◆ GetNumCores()

int GetNumCores ( )

Return the number of cores available on the current system.

Note
This does count virtual cores, such as those provided by HyperThreading.

Definition at line 1190 of file system.cpp.

Here is the caller graph for this function:

◆ GetStartupTime()

int64_t GetStartupTime ( )

Server/client environment: argument handling, config file parsing, thread wrappers, startup time.

Definition at line 1208 of file system.cpp.

Here is the caller graph for this function:

◆ HelpMessageGroup()

std::string HelpMessageGroup ( const std::string &  message)

Format a string to be used as group of options in help messages.

Parameters
messageGroup name (e.g. "RPC server options:")
Returns
the formatted string

Definition at line 652 of file system.cpp.

Here is the caller graph for this function:

◆ HelpMessageOpt()

std::string HelpMessageOpt ( const std::string &  option,
const std::string &  message 
)

Format a string to be used as option description in help messages.

Parameters
optionOption message (e.g. "-rpcuser=<user>")
messageOption description (e.g. "Username for JSON-RPC connections")
Returns
the formatted string

Definition at line 656 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HelpRequested()

bool HelpRequested ( const ArgsManager args)
Returns
true if help has been requested via a command-line arg

Definition at line 637 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InterpretBool()

static bool InterpretBool ( const std::string &  strValue)
static

Interpret a string argument as a boolean.

The definition of atoi() 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 atoi() is undefined when given input not representable as an int. On most systems this means string value between "-2147483648" and "2147483647" are well defined (this method will return true). Setting -txindex=2147483648 on most systems, however, is probably undefined.

For a more extensive discussion of this topic (and a wide range of opinions on the Right Way to change this code), see PR12713.

Definition at line 158 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InterpretOption()

static NODISCARD bool InterpretOption ( std::string  key,
std::string  val,
unsigned int  flags,
std::map< std::string, std::vector< std::string >> &  args,
std::string &  error 
)
static

Interpret -nofoo as if the user supplied -foo=0.

This method also tracks when the -no form was supplied, and if so, checks whether there was a double-negative (-nofoo=0 -> -foo=1).

If there was not a double negative, it removes the "no" from the key and clears the args vector to indicate a negated option.

If there was a double negative, it removes "no" from the key, sets the value to "1" and pushes the key and the updated value to the args vector.

If there was no "no", it leaves key and value untouched and pushes them to the args vector.

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).

Definition at line 286 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LockDirectory()

bool LockDirectory ( const fs::path &  directory,
const std::string  lockfile_name,
bool  probe_only 
)

Definition at line 84 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PrintExceptionContinue()

void PrintExceptionContinue ( const std::exception *  pex,
const char *  pszThread 
)

Definition at line 679 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RaiseFileDescriptorLimit()

int RaiseFileDescriptorLimit ( int  nMinFD)

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)

Definition at line 1044 of file system.cpp.

Here is the caller graph for this function:

◆ ReleaseDirectoryLocks()

void ReleaseDirectoryLocks ( )

Release all directory locks.

This is used for unit testing only, at runtime the global destructor will take care of the locks.

Definition at line 114 of file system.cpp.

Here is the caller graph for this function:

◆ RenameOver()

bool RenameOver ( fs::path  src,
fs::path  dest 
)

Definition at line 969 of file system.cpp.

Here is the caller graph for this function:

◆ ScheduleBatchPriority()

int ScheduleBatchPriority ( )

On platforms that support it, tell the kernel the calling thread is CPU-intensive and non-interactive.

See SCHED_BATCH in sched(7) for details.

Returns
The return value of sched_setschedule(), or 1 on systems without sched_setschedule().

Definition at line 1221 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetupEnvironment()

void SetupEnvironment ( )

Definition at line 1141 of file system.cpp.

Here is the caller graph for this function:

◆ SetupHelpOptions()

void SetupHelpOptions ( ArgsManager args)

Add help options to the args manager.

Definition at line 642 of file system.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetupNetworking()

bool SetupNetworking ( )

Definition at line 1178 of file system.cpp.

Here is the caller graph for this function:

◆ TrimString()

static std::string TrimString ( const std::string &  str,
const std::string &  pattern 
)
static

Definition at line 792 of file system.cpp.

Here is the caller graph for this function:

◆ TruncateFile()

bool TruncateFile ( FILE *  file,
unsigned int  length 
)

Definition at line 1032 of file system.cpp.

Here is the caller graph for this function:

◆ TryCreateDirectories()

bool TryCreateDirectories ( const fs::path &  p)

Ignores exceptions thrown by Boost's 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.

Definition at line 985 of file system.cpp.

Here is the caller graph for this function:

◆ UnlockDirectory()

void UnlockDirectory ( const fs::path &  directory,
const std::string &  lockfile_name 
)

Definition at line 108 of file system.cpp.

Here is the caller graph for this function:

Variable Documentation

◆ BITCOIN_CONF_FILENAME

const char* const BITCOIN_CONF_FILENAME = "bitcoin.conf"

Definition at line 71 of file system.cpp.

◆ cs_dir_locks

std::mutex cs_dir_locks
static

Mutex to protect dir_locks.

Definition at line 82 of file system.cpp.

◆ csPathCached

RecursiveMutex csPathCached
static

Definition at line 715 of file system.cpp.

◆ dir_locks

std::map<std::string, std::unique_ptr<fsbridge::FileLock> > dir_locks
static

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.

Definition at line 80 of file system.cpp.

◆ g_blocks_path_cache_net_specific

fs::path g_blocks_path_cache_net_specific
static

Definition at line 712 of file system.cpp.

◆ gArgs

ArgsManager gArgs

Definition at line 73 of file system.cpp.

◆ msgIndent

const int msgIndent = 7
static

Definition at line 650 of file system.cpp.

◆ nStartupTime

const int64_t nStartupTime = GetTime()

Definition at line 69 of file system.cpp.

◆ optIndent

const int optIndent = 2
static

Definition at line 649 of file system.cpp.

◆ pathCached

fs::path pathCached
static

Definition at line 713 of file system.cpp.

◆ pathCachedNetSpecific

fs::path pathCachedNetSpecific
static

Definition at line 714 of file system.cpp.

◆ screenWidth

const int screenWidth = 79
static

Definition at line 648 of file system.cpp.