bitcoin-bitcoin-core/src/common/system.h

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_COMMON_SYSTEM_H
#define BITCOIN_COMMON_SYSTEM_H

#include <config/bitcoin-config.h> // IWYU pragma: keep

#include <cstdint>
#include <string>

// Application startup time (used for uptime calculation)
int64_t GetStartupTime();

void SetupEnvironment();
[[nodiscard]] bool SetupNetworking();
#ifndef WIN32
std::string ShellEscape(const std::string& arg);
#endif
#if HAVE_SYSTEM
void runCommand(const std::string& strCommand);
#endif

/**
 * Return the number of cores available on the current system.
 * @note This does count virtual cores, such as those provided by HyperThreading.
 */
int GetNumCores();

#endif // BITCOIN_COMMON_SYSTEM_H
begin integration with bitcoin upstream 2011-05-14 10:31:46 +02:00			`// Copyright (c) 2009-2010 Satoshi Nakamoto`
Move compat.h include from system.h to system.cpp 2023-10-16 14:18:28 +02:00			`// Copyright (c) 2009-present The Bitcoin Core developers`
Update comments in util to be doxygen compatible 2014-11-17 11:04:01 +08:00			`// Distributed under the MIT software license, see the accompanying`
Update License in File Headers I originally created a pull to replace the "COPYING" in crypter.cpp and crypter.h, but it turned out that COPYING was actually the correct file. 2012-05-18 22:02:28 +08:00			`// file COPYING or http://www.opensource.org/licenses/mit-license.php.`
Cleanup code using forward declarations. Use misc methods of avoiding unnecesary header includes. Replace int typedefs with int##_t from stdint.h. Replace PRI64[xdu] with PRI[xdu]64 from inttypes.h. Normalize QT_VERSION ifs where possible. Resolve some indirect dependencies as direct ones. Remove extern declarations from .cpp files. 2013-04-13 00:13:08 -05:00
refactor: Move system from util to common library Since the kernel library no longer depends on the system file, move it to the common library instead in accordance to the diagram in doc/design/libraries.md. 2023-05-08 11:32:13 +02:00			`#ifndef BITCOIN_COMMON_SYSTEM_H`
			`#define BITCOIN_COMMON_SYSTEM_H`
begin integration with bitcoin upstream 2011-05-14 10:31:46 +02:00
scripted-diff: Add IWYU pragma keep to bitcoin-config.h includes -BEGIN VERIFY SCRIPT- perl -0777 -pi -e 's/#if defined\(HAVE_CONFIG_H\)\n#include <config\/bitcoin-config.h>.\n#endif.\n/#include <config\/bitcoin-config.h> \/\/ IWYU pragma: keep\n/g' $( git grep -l '#include <config/bitcoin-config.h>' ) -END VERIFY SCRIPT- 2024-02-26 13:36:30 +01:00			`#include <config/bitcoin-config.h> // IWYU pragma: keep`
Cleanup code using forward declarations. Use misc methods of avoiding unnecesary header includes. Replace int typedefs with int##_t from stdint.h. Replace PRI64[xdu] with PRI[xdu]64 from inttypes.h. Normalize QT_VERSION ifs where possible. Resolve some indirect dependencies as direct ones. Remove extern declarations from .cpp files. 2013-04-13 00:13:08 -05:00
Move compat.h include from system.h to system.cpp 2023-10-16 14:18:28 +02:00			`#include <cstdint>`
Cleanup code using forward declarations. Use misc methods of avoiding unnecesary header includes. Replace int typedefs with int##_t from stdint.h. Replace PRI64[xdu] with PRI[xdu]64 from inttypes.h. Normalize QT_VERSION ifs where possible. Resolve some indirect dependencies as direct ones. Remove extern declarations from .cpp files. 2013-04-13 00:13:08 -05:00			`#include <string>`
[util] add RunCommandParseJSON 2020-01-30 12:07:57 +01:00
[RPC] Add an uptime command that displays the amount of time that bitcoind has been running 2017-05-14 19:18:26 +01:00			`// Application startup time (used for uptime calculation)`
			`int64_t GetStartupTime();`

SetupEnvironment() - clean commit 2014-05-13 10:15:00 +00:00			`void SetupEnvironment();`
test: Setup networking globally 2023-11-28 19:11:52 +00:00			`[[nodiscard]] bool SetupNetworking();`
wallet: Replace %w by wallet name in -walletnotify script Co-authored-by: Russell Yanofsky <russ@yanofsky.org> 2018-05-29 14:37:53 +01:00			`#ifndef WIN32`
			`std::string ShellEscape(const std::string& arg);`
			`#endif`
[build]: use #if HAVE_SYSTEM instead of defined(HAVE_SYSTEM) 2019-07-05 18:30:15 +02:00			`#if HAVE_SYSTEM`
use const references where appropriate 2015-05-31 15:36:44 +02:00			`void runCommand(const std::string& strCommand);`
[build]: check std::system for -[alert\|block\|wallet]notify Platforms such as iOs do not support launching a process through system(). 2019-03-14 11:30:37 +01:00			`#endif`
begin integration with bitcoin upstream 2011-05-14 10:31:46 +02:00
Use real number of cores for default -par, ignore virtual cores To determine the default for `-par`, the number of script verification threads, use [boost::thread::physical_concurrency()](http://www.boost.org/doc/libs/1_58_0/doc/html/thread/thread_management.html#thread.thread_management.thread.physical_concurrency) which counts only physical cores, not virtual cores. Virtual cores are roughly a set of cached registers to avoid context switches while threading, they cannot actually perform work, so spawning a verification thread for them could even reduce efficiency and will put undue load on the system. Should fix issue #6358, as well as some other reported system overload issues, especially on Intel processors. The function was only introduced in boost 1.56, so provide a utility function `GetNumCores` to fall back for older Boost versions. 2015-07-01 17:38:15 +02:00			`/**`
Use std::thread::hardware_concurrency, instead of Boost, to determine available cores 2017-04-25 09:34:23 +08:00			`* Return the number of cores available on the current system.`
			`* @note This does count virtual cores, such as those provided by HyperThreading.`
Use real number of cores for default -par, ignore virtual cores To determine the default for `-par`, the number of script verification threads, use [boost::thread::physical_concurrency()](http://www.boost.org/doc/libs/1_58_0/doc/html/thread/thread_management.html#thread.thread_management.thread.physical_concurrency) which counts only physical cores, not virtual cores. Virtual cores are roughly a set of cached registers to avoid context switches while threading, they cannot actually perform work, so spawning a verification thread for them could even reduce efficiency and will put undue load on the system. Should fix issue #6358, as well as some other reported system overload issues, especially on Intel processors. The function was only introduced in boost 1.56, so provide a utility function `GetNumCores` to fall back for older Boost versions. 2015-07-01 17:38:15 +02:00			`*/`
			`int GetNumCores();`

refactor: Move system from util to common library Since the kernel library no longer depends on the system file, move it to the common library instead in accordance to the diagram in doc/design/libraries.md. 2023-05-08 11:32:13 +02:00			`#endif // BITCOIN_COMMON_SYSTEM_H`