#include <compat.h>
#include <fs.h>
#include <logging.h>
#include <sync.h>
#include <tinyformat.h>
#include <utilmemory.h>
#include <utiltime.h>
#include <atomic>
#include <exception>
#include <map>
#include <set>
#include <stdint.h>
#include <string>
#include <unordered_set>
#include <utility>
#include <vector>
#include <boost/thread/condition_variable.hpp>

Include dependency graph for util.h:

Classes
class	ArgsManager

struct	ArgsManager::Arg

Namespaces
	util

Enumerations
enum	OptionsCategory { OptionsCategory::OPTIONS, OptionsCategory::CONNECTION, OptionsCategory::WALLET, OptionsCategory::WALLET_DEBUG_TEST, OptionsCategory::ZMQ, OptionsCategory::DEBUG_TEST, OptionsCategory::CHAINPARAMS, OptionsCategory::NODE_RELAY, OptionsCategory::BLOCK_CREATION, OptionsCategory::RPC, OptionsCategory::GUI, OptionsCategory::COMMANDS, OptionsCategory::REGISTER_COMMANDS, OptionsCategory::HIDDEN }

Functions
int64_t	GetStartupTime ()
	Server/client environment: argument handling, config file parsing, thread wrappers, startup time. More...

std::string	_ (const char *psz)
	Translation function. More...

void	SetupEnvironment ()

bool	SetupNetworking ()

template<typename... Args>
bool	error (const char *fmt, const Args &... args)

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

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

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

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

bool	DirIsWritable (const fs::path &directory)

void	ReleaseDirectoryLocks ()
	Release all directory locks. More...

bool	TryCreateDirectories (const fs::path &p)
	Ignores exceptions thrown by Boost's create_directories if the requested directory exists. More...

fs::path	GetDefaultDataDir ()

const fs::path &	GetBlocksDir (bool fNetSpecific=true)

const fs::path &	GetDataDir (bool fNetSpecific=true)

void	ClearDatadirCache ()

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

fs::path	GetPidFile ()

void	CreatePidFile (const fs::path &path, pid_t pid)

void	runCommand (const std::string &strCommand)

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

bool	IsSwitchChar (char c)

bool	HelpRequested (const ArgsManager &args)

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

int	GetNumCores ()
	Return the number of cores available on the current system. More...

void	RenameThread (const char *name)

template<typename Callable >
void	TraceThread (const char *name, Callable func)

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

int	ScheduleBatchPriority ()
	On platforms that support it, tell the kernel the calling thread is CPU-intensive and non-interactive. More...

void	SetThreadPriority (int nPriority)

template<typename Tdst , typename Tsrc >
void	util::insert (Tdst &dst, const Tsrc &src)
	Simplification of std insertion. More...

template<typename TsetT , typename Tsrc >
void	util::insert (std::set< TsetT > &dst, const Tsrc &src)

Variables
const char *const	BITCOIN_CONF_FILENAME

const char *const	BITCOIN_PID_FILENAME

const std::function< std::string(const char *)>	G_TRANSLATION_FUN
	Translate a message to the native language of the user. More...

ArgsManager	gArgs

Enumeration Type Documentation

◆ OptionsCategory

enum OptionsCategory

strong

Enumerator
OPTIONS
CONNECTION
WALLET
WALLET_DEBUG_TEST
ZMQ
DEBUG_TEST
CHAINPARAMS
NODE_RELAY
BLOCK_CREATION
RPC
GUI
COMMANDS
REGISTER_COMMANDS
HIDDEN

Definition at line 113 of file util.h.

Function Documentation

◆ _()

std::string _ ( const char * psz )

inline

Translation function.

If no translation function is set, simply return the input.

Definition at line 50 of file util.h.

Here is the caller graph for this function:

◆ 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

path	The path to be conditionally prefixed with datadir.
net_specific	Forwarded to GetDataDir().

Returns: The normalized path.

Definition at line 1255 of file util.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 1097 of file util.cpp.

◆ ClearDatadirCache()

void ClearDatadirCache ( )

Definition at line 798 of file util.cpp.

◆ CopyrightHolders()

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

Definition at line 1238 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreatePidFile()

void CreatePidFile	(	const fs::path &	path,
		pid_t	pid
	)

Definition at line 988 of file util.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 177 of file util.cpp.

Here is the call graph for this function:

◆ error()

template<typename... Args>

bool error	(	const char *	fmt,
		const Args &...	args
	)

Definition at line 59 of file util.h.

Here is the caller graph for this function:

◆ FileCommit()

bool FileCommit ( FILE * file )

Definition at line 1029 of file util.cpp.

◆ GetBlocksDir()

const fs::path& GetBlocksDir ( bool fNetSpecific = true )

Definition at line 737 of file util.cpp.

Here is the caller graph for this function:

◆ GetConfigFile()

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

Definition at line 808 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDir()

const fs::path& GetDataDir ( bool fNetSpecific = true )

Definition at line 766 of file util.cpp.

Here is the caller graph for this function:

◆ GetDefaultDataDir()

fs::path GetDefaultDataDir ( )

Definition at line 705 of file util.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 1233 of file util.cpp.

Here is the caller graph for this function:

◆ GetPidFile()

fs::path GetPidFile ( )

Definition at line 983 of file util.cpp.

Here is the call graph for this function:

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 1250 of file util.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

message Group name (e.g. "RPC server options:")

Returns: the formatted string

Definition at line 671 of file util.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

option	Option message (e.g. "-rpcuser=<user>")
message	Option description (e.g. "Username for JSON-RPC connections")

Returns: the formatted string

Definition at line 675 of file util.cpp.

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 662 of file util.cpp.

Here is the call graph for this function:

◆ IsSwitchChar()

bool IsSwitchChar ( char c )

inline

Definition at line 104 of file util.h.

◆ LockDirectory()

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

Definition at line 147 of file util.cpp.

Here is the caller graph for this function:

◆ PrintExceptionContinue()

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

Definition at line 698 of file util.cpp.

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 1074 of file util.cpp.

◆ 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 171 of file util.cpp.

◆ RenameOver()

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

Definition at line 999 of file util.cpp.

◆ RenameThread()

void RenameThread ( const char * name )

Definition at line 1168 of file util.cpp.

Here is the caller graph for this function:

◆ runCommand()

void runCommand ( const std::string & strCommand )

Definition at line 1156 of file util.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 1273 of file util.cpp.

◆ SetThreadPriority()

void SetThreadPriority ( int nPriority )

Definition at line 1260 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupEnvironment()

void SetupEnvironment ( )

Definition at line 1184 of file util.cpp.

Here is the caller graph for this function:

◆ SetupNetworking()

bool SetupNetworking ( )

Definition at line 1221 of file util.cpp.

Here is the caller graph for this function:

◆ TraceThread()

template<typename Callable >

void TraceThread	(	const char *	name,
		Callable	func
	)

. and a wrapper that just calls func once

Definition at line 317 of file util.h.

Here is the call graph for this function:

◆ TruncateFile()

bool TruncateFile	(	FILE *	file,
		unsigned int	length
	)

Definition at line 1062 of file util.cpp.

◆ 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 1015 of file util.cpp.

Here is the caller graph for this function:

Variable Documentation

◆ BITCOIN_CONF_FILENAME

const char* const BITCOIN_CONF_FILENAME

Definition at line 85 of file util.cpp.

◆ BITCOIN_PID_FILENAME

const char* const BITCOIN_PID_FILENAME

Definition at line 86 of file util.cpp.

◆ G_TRANSLATION_FUN

const std::function<std::string(const char*)> G_TRANSLATION_FUN

Translate a message to the native language of the user.

Definition at line 16 of file bench_bitcoin.cpp.

◆ gArgs

ArgsManager gArgs

Definition at line 88 of file util.cpp.

Classes

Namespaces

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ OptionsCategory

Function Documentation

◆ _()

◆ AbsPathForConfigVal()

◆ AllocateFileRange()

◆ ClearDatadirCache()

◆ CopyrightHolders()

◆ CreatePidFile()

◆ DirIsWritable()

◆ error()

◆ FileCommit()

◆ GetBlocksDir()

◆ GetConfigFile()

◆ GetDataDir()

◆ GetDefaultDataDir()

◆ GetNumCores()

◆ GetPidFile()

◆ GetStartupTime()

◆ HelpMessageGroup()

◆ HelpMessageOpt()

◆ HelpRequested()

◆ IsSwitchChar()

◆ LockDirectory()

◆ PrintExceptionContinue()

◆ RaiseFileDescriptorLimit()

◆ ReleaseDirectoryLocks()

◆ RenameOver()

◆ RenameThread()

◆ runCommand()

◆ ScheduleBatchPriority()

◆ SetThreadPriority()

◆ SetupEnvironment()

◆ SetupNetworking()

◆ TraceThread()

◆ TruncateFile()

◆ TryCreateDirectories()

Variable Documentation

◆ BITCOIN_CONF_FILENAME

◆ BITCOIN_PID_FILENAME

◆ G_TRANSLATION_FUN

◆ gArgs