src/util.cpp

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2016 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #if defined(HAVE_CONFIG_H)
   7 #include <config/bitcoin-config.h>
   8 #endif
   9
  10 #include <util.h>
  11
  12 #include <chainparamsbase.h>
  13 #include <fs.h>
  14 #include <random.h>
  15 #include <serialize.h>
  16 #include <utilstrencodings.h>
  17 #include <utiltime.h>
  18
  19 #include <stdarg.h>
  20
  21 #if (defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__DragonFly__))
  22 #include <pthread.h>
  23 #include <pthread_np.h>
  24 #endif
  25
  26 #ifndef WIN32
  27 // for posix_fallocate
  28 #ifdef __linux__
  29
  30 #ifdef _POSIX_C_SOURCE
  31 #undef _POSIX_C_SOURCE
  32 #endif
  33
  34 #define _POSIX_C_SOURCE 200112L
  35
  36 #endif // __linux__
  37
  38 #include <algorithm>
  39 #include <fcntl.h>
  40 #include <sys/resource.h>
  41 #include <sys/stat.h>
  42
  43 #else
  44
  45 #ifdef _MSC_VER
  46 #pragma warning(disable:4786)
  47 #pragma warning(disable:4804)
  48 #pragma warning(disable:4805)
  49 #pragma warning(disable:4717)
  50 #endif
  51
  52 #ifdef _WIN32_WINNT
  53 #undef _WIN32_WINNT
  54 #endif
  55 #define _WIN32_WINNT 0x0501
  56
  57 #ifdef _WIN32_IE
  58 #undef _WIN32_IE
  59 #endif
  60 #define _WIN32_IE 0x0501
  61
  62 #define WIN32_LEAN_AND_MEAN 1
  63 #ifndef NOMINMAX
  64 #define NOMINMAX
  65 #endif
  66
  67 #include <io.h> /* for _commit */
  68 #include <shlobj.h>
  69 #endif
  70
  71 #ifdef HAVE_SYS_PRCTL_H
  72 #include <sys/prctl.h>
  73 #endif
  74
  75 #ifdef HAVE_MALLOPT_ARENA_MAX
  76 #include <malloc.h>
  77 #endif
  78
  79 #include <boost/algorithm/string/case_conv.hpp> // for to_lower()
  80 #include <boost/algorithm/string/predicate.hpp> // for startswith() and endswith()
  81 #include <boost/program_options/detail/config_file.hpp>
  82 #include <boost/thread.hpp>
  83 #include <openssl/crypto.h>
  84 #include <openssl/rand.h>
  85 #include <openssl/conf.h>
  86
  87 // Application startup time (used for uptime calculation)
  88 const int64_t nStartupTime = GetTime();
  89
  90 const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
  91 const char * const BITCOIN_PID_FILENAME = "bitcoind.pid";
  92 const char * const DEFAULT_DEBUGLOGFILE = "debug.log";
  93
  94 ArgsManager gArgs;
  95 bool fPrintToConsole = false;
  96 bool fPrintToDebugLog = true;
  97
  98 bool fLogTimestamps = DEFAULT_LOGTIMESTAMPS;
  99 bool fLogTimeMicros = DEFAULT_LOGTIMEMICROS;
 100 bool fLogIPs = DEFAULT_LOGIPS;
 101 std::atomic<bool> fReopenDebugLog(false);
 102 CTranslationInterface translationInterface;
 103
 104 /** Log categories bitfield. */
 105 std::atomic<uint32_t> logCategories(0);
 106
 107 /** Init OpenSSL library multithreading support */
 108 static std::unique_ptr<CCriticalSection[]> ppmutexOpenSSL;
 109 void locking_callback(int mode, int i, const char* file, int line) NO_THREAD_SAFETY_ANALYSIS
 110 {
 111     if (mode & CRYPTO_LOCK) {
 112         ENTER_CRITICAL_SECTION(ppmutexOpenSSL[i]);
 113     } else {
 114         LEAVE_CRITICAL_SECTION(ppmutexOpenSSL[i]);
 115     }
 116 }
 117
 118 // Singleton for wrapping OpenSSL setup/teardown.
 119 class CInit
 120 {
 121 public:
 122     CInit()
 123     {
 124         // Init OpenSSL library multithreading support
 125         ppmutexOpenSSL.reset(new CCriticalSection[CRYPTO_num_locks()]);
 126         CRYPTO_set_locking_callback(locking_callback);
 127
 128         // OpenSSL can optionally load a config file which lists optional loadable modules and engines.
 129         // We don't use them so we don't require the config. However some of our libs may call functions
 130         // which attempt to load the config file, possibly resulting in an exit() or crash if it is missing
 131         // or corrupt. Explicitly tell OpenSSL not to try to load the file. The result for our libs will be
 132         // that the config appears to have been loaded and there are no modules/engines available.
 133         OPENSSL_no_config();
 134
 135 #ifdef WIN32
 136         // Seed OpenSSL PRNG with current contents of the screen
 137         RAND_screen();
 138 #endif
 139
 140         // Seed OpenSSL PRNG with performance counter
 141         RandAddSeed();
 142     }
 143     ~CInit()
 144     {
 145         // Securely erase the memory used by the PRNG
 146         RAND_cleanup();
 147         // Shutdown OpenSSL library multithreading support
 148         CRYPTO_set_locking_callback(nullptr);
 149         // Clear the set of locks now to maintain symmetry with the constructor.
 150         ppmutexOpenSSL.reset();
 151     }
 152 }
 153 instance_of_cinit;
 154
 155 /**
 156  * LogPrintf() has been broken a couple of times now
 157  * by well-meaning people adding mutexes in the most straightforward way.
 158  * It breaks because it may be called by global destructors during shutdown.
 159  * Since the order of destruction of static/global objects is undefined,
 160  * defining a mutex as a global object doesn't work (the mutex gets
 161  * destroyed, and then some later destructor calls OutputDebugStringF,
 162  * maybe indirectly, and you get a core dump at shutdown trying to lock
 163  * the mutex).
 164  */
 165
 166 static boost::once_flag debugPrintInitFlag = BOOST_ONCE_INIT;
 167
 168 /**
 169  * We use boost::call_once() to make sure mutexDebugLog and
 170  * vMsgsBeforeOpenLog are initialized in a thread-safe manner.
 171  *
 172  * NOTE: fileout, mutexDebugLog and sometimes vMsgsBeforeOpenLog
 173  * are leaked on exit. This is ugly, but will be cleaned up by
 174  * the OS/libc. When the shutdown sequence is fully audited and
 175  * tested, explicit destruction of these objects can be implemented.
 176  */
 177 static FILE* fileout = nullptr;
 178 static boost::mutex* mutexDebugLog = nullptr;
 179 static std::list<std::string>* vMsgsBeforeOpenLog;
 180
 181 static int FileWriteStr(const std::string &str, FILE *fp)
 182 {
 183     return fwrite(str.data(), 1, str.size(), fp);
 184 }
 185
 186 static void DebugPrintInit()
 187 {
 188     assert(mutexDebugLog == nullptr);
 189     mutexDebugLog = new boost::mutex();
 190     vMsgsBeforeOpenLog = new std::list<std::string>;
 191 }
 192
 193 fs::path GetDebugLogPath()
 194 {
 195     fs::path logfile(gArgs.GetArg("-debuglogfile", DEFAULT_DEBUGLOGFILE));
 196     if (logfile.is_absolute()) {
 197         return logfile;
 198     } else {
 199         return GetDataDir() / logfile;
 200     }
 201 }
 202
 203 bool OpenDebugLog()
 204 {
 205     boost::call_once(&DebugPrintInit, debugPrintInitFlag);
 206     boost::mutex::scoped_lock scoped_lock(*mutexDebugLog);
 207
 208     assert(fileout == nullptr);
 209     assert(vMsgsBeforeOpenLog);
 210     fs::path pathDebug = GetDebugLogPath();
 211
 212     fileout = fsbridge::fopen(pathDebug, "a");
 213     if (!fileout) {
 214         return false;
 215     }
 216
 217     setbuf(fileout, nullptr); // unbuffered
 218     // dump buffered messages from before we opened the log
 219     while (!vMsgsBeforeOpenLog->empty()) {
 220         FileWriteStr(vMsgsBeforeOpenLog->front(), fileout);
 221         vMsgsBeforeOpenLog->pop_front();
 222     }
 223
 224     delete vMsgsBeforeOpenLog;
 225     vMsgsBeforeOpenLog = nullptr;
 226     return true;
 227 }
 228
 229 struct CLogCategoryDesc
 230 {
 231     uint32_t flag;
 232     std::string category;
 233 };
 234
 235 const CLogCategoryDesc LogCategories[] =
 236 {
 237     {BCLog::NONE, "0"},
 238     {BCLog::NONE, "none"},
 239     {BCLog::NET, "net"},
 240     {BCLog::TOR, "tor"},
 241     {BCLog::MEMPOOL, "mempool"},
 242     {BCLog::HTTP, "http"},
 243     {BCLog::BENCH, "bench"},
 244     {BCLog::ZMQ, "zmq"},
 245     {BCLog::DB, "db"},
 246     {BCLog::RPC, "rpc"},
 247     {BCLog::ESTIMATEFEE, "estimatefee"},
 248     {BCLog::ADDRMAN, "addrman"},
 249     {BCLog::SELECTCOINS, "selectcoins"},
 250     {BCLog::REINDEX, "reindex"},
 251     {BCLog::CMPCTBLOCK, "cmpctblock"},
 252     {BCLog::RAND, "rand"},
 253     {BCLog::PRUNE, "prune"},
 254     {BCLog::PROXY, "proxy"},
 255     {BCLog::MEMPOOLREJ, "mempoolrej"},
 256     {BCLog::LIBEVENT, "libevent"},
 257     {BCLog::COINDB, "coindb"},
 258     {BCLog::QT, "qt"},
 259     {BCLog::LEVELDB, "leveldb"},
 260     {BCLog::ALL, "1"},
 261     {BCLog::ALL, "all"},
 262 };
 263
 264 bool GetLogCategory(uint32_t *f, const std::string *str)
 265 {
 266     if (f && str) {
 267         if (*str == "") {
 268             *f = BCLog::ALL;
 269             return true;
 270         }
 271         for (unsigned int i = 0; i < ARRAYLEN(LogCategories); i++) {
 272             if (LogCategories[i].category == *str) {
 273                 *f = LogCategories[i].flag;
 274                 return true;
 275             }
 276         }
 277     }
 278     return false;
 279 }
 280
 281 std::string ListLogCategories()
 282 {
 283     std::string ret;
 284     int outcount = 0;
 285     for (unsigned int i = 0; i < ARRAYLEN(LogCategories); i++) {
 286         // Omit the special cases.
 287         if (LogCategories[i].flag != BCLog::NONE && LogCategories[i].flag != BCLog::ALL) {
 288             if (outcount != 0) ret += ", ";
 289             ret += LogCategories[i].category;
 290             outcount++;
 291         }
 292     }
 293     return ret;
 294 }
 295
 296 std::vector<CLogCategoryActive> ListActiveLogCategories()
 297 {
 298     std::vector<CLogCategoryActive> ret;
 299     for (unsigned int i = 0; i < ARRAYLEN(LogCategories); i++) {
 300         // Omit the special cases.
 301         if (LogCategories[i].flag != BCLog::NONE && LogCategories[i].flag != BCLog::ALL) {
 302             CLogCategoryActive catActive;
 303             catActive.category = LogCategories[i].category;
 304             catActive.active = LogAcceptCategory(LogCategories[i].flag);
 305             ret.push_back(catActive);
 306         }
 307     }
 308     return ret;
 309 }
 310
 311 /**
 312  * fStartedNewLine is a state variable held by the calling context that will
 313  * suppress printing of the timestamp when multiple calls are made that don't
 314  * end in a newline. Initialize it to true, and hold it, in the calling context.
 315  */
 316 static std::string LogTimestampStr(const std::string &str, std::atomic_bool *fStartedNewLine)
 317 {
 318     std::string strStamped;
 319
 320     if (!fLogTimestamps)
 321         return str;
 322
 323     if (*fStartedNewLine) {
 324         int64_t nTimeMicros = GetTimeMicros();
 325         strStamped = DateTimeStrFormat("%Y-%m-%d %H:%M:%S", nTimeMicros/1000000);
 326         if (fLogTimeMicros)
 327             strStamped += strprintf(".%06d", nTimeMicros%1000000);
 328         int64_t mocktime = GetMockTime();
 329         if (mocktime) {
 330             strStamped += " (mocktime: " + DateTimeStrFormat("%Y-%m-%d %H:%M:%S", mocktime) + ")";
 331         }
 332         strStamped += ' ' + str;
 333     } else
 334         strStamped = str;
 335
 336     if (!str.empty() && str[str.size()-1] == '\n')
 337         *fStartedNewLine = true;
 338     else
 339         *fStartedNewLine = false;
 340
 341     return strStamped;
 342 }
 343
 344 int LogPrintStr(const std::string &str)
 345 {
 346     int ret = 0; // Returns total number of characters written
 347     static std::atomic_bool fStartedNewLine(true);
 348
 349     std::string strTimestamped = LogTimestampStr(str, &fStartedNewLine);
 350
 351     if (fPrintToConsole)
 352     {
 353         // print to console
 354         ret = fwrite(strTimestamped.data(), 1, strTimestamped.size(), stdout);
 355         fflush(stdout);
 356     }
 357     else if (fPrintToDebugLog)
 358     {
 359         boost::call_once(&DebugPrintInit, debugPrintInitFlag);
 360         boost::mutex::scoped_lock scoped_lock(*mutexDebugLog);
 361
 362         // buffer if we haven't opened the log yet
 363         if (fileout == nullptr) {
 364             assert(vMsgsBeforeOpenLog);
 365             ret = strTimestamped.length();
 366             vMsgsBeforeOpenLog->push_back(strTimestamped);
 367         }
 368         else
 369         {
 370             // reopen the log file, if requested
 371             if (fReopenDebugLog) {
 372                 fReopenDebugLog = false;
 373                 fs::path pathDebug = GetDebugLogPath();
 374                 if (fsbridge::freopen(pathDebug,"a",fileout) != nullptr)
 375                     setbuf(fileout, nullptr); // unbuffered
 376             }
 377
 378             ret = FileWriteStr(strTimestamped, fileout);
 379         }
 380     }
 381     return ret;
 382 }
 383
 384 /** Interpret string as boolean, for argument parsing */
 385 static bool InterpretBool(const std::string& strValue)
 386 {
 387     if (strValue.empty())
 388         return true;
 389     return (atoi(strValue) != 0);
 390 }
 391
 392 /** Turn -noX into -X=0 */
 393 static void InterpretNegativeSetting(std::string& strKey, std::string& strValue)
 394 {
 395     if (strKey.length()>3 && strKey[0]=='-' && strKey[1]=='n' && strKey[2]=='o')
 396     {
 397         strKey = "-" + strKey.substr(3);
 398         strValue = InterpretBool(strValue) ? "0" : "1";
 399     }
 400 }
 401
 402 void ArgsManager::ParseParameters(int argc, const char* const argv[])
 403 {
 404     LOCK(cs_args);
 405     mapArgs.clear();
 406     mapMultiArgs.clear();
 407
 408     for (int i = 1; i < argc; i++)
 409     {
 410         std::string str(argv[i]);
 411         std::string strValue;
 412         size_t is_index = str.find('=');
 413         if (is_index != std::string::npos)
 414         {
 415             strValue = str.substr(is_index+1);
 416             str = str.substr(0, is_index);
 417         }
 418 #ifdef WIN32
 419         boost::to_lower(str);
 420         if (boost::algorithm::starts_with(str, "/"))
 421             str = "-" + str.substr(1);
 422 #endif
 423
 424         if (str[0] != '-')
 425             break;
 426
 427         // Interpret --foo as -foo.
 428         // If both --foo and -foo are set, the last takes effect.
 429         if (str.length() > 1 && str[1] == '-')
 430             str = str.substr(1);
 431         InterpretNegativeSetting(str, strValue);
 432
 433         mapArgs[str] = strValue;
 434         mapMultiArgs[str].push_back(strValue);
 435     }
 436 }
 437
 438 std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
 439 {
 440     LOCK(cs_args);
 441     auto it = mapMultiArgs.find(strArg);
 442     if (it != mapMultiArgs.end()) return it->second;
 443     return {};
 444 }
 445
 446 bool ArgsManager::IsArgSet(const std::string& strArg) const
 447 {
 448     LOCK(cs_args);
 449     return mapArgs.count(strArg);
 450 }
 451
 452 std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
 453 {
 454     LOCK(cs_args);
 455     auto it = mapArgs.find(strArg);
 456     if (it != mapArgs.end()) return it->second;
 457     return strDefault;
 458 }
 459
 460 int64_t ArgsManager::GetArg(const std::string& strArg, int64_t nDefault) const
 461 {
 462     LOCK(cs_args);
 463     auto it = mapArgs.find(strArg);
 464     if (it != mapArgs.end()) return atoi64(it->second);
 465     return nDefault;
 466 }
 467
 468 bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
 469 {
 470     LOCK(cs_args);
 471     auto it = mapArgs.find(strArg);
 472     if (it != mapArgs.end()) return InterpretBool(it->second);
 473     return fDefault;
 474 }
 475
 476 bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
 477 {
 478     LOCK(cs_args);
 479     if (IsArgSet(strArg)) return false;
 480     ForceSetArg(strArg, strValue);
 481     return true;
 482 }
 483
 484 bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
 485 {
 486     if (fValue)
 487         return SoftSetArg(strArg, std::string("1"));
 488     else
 489         return SoftSetArg(strArg, std::string("0"));
 490 }
 491
 492 void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
 493 {
 494     LOCK(cs_args);
 495     mapArgs[strArg] = strValue;
 496     mapMultiArgs[strArg] = {strValue};
 497 }
 498
 499
 500
 501 static const int screenWidth = 79;
 502 static const int optIndent = 2;
 503 static const int msgIndent = 7;
 504
 505 std::string HelpMessageGroup(const std::string &message) {
 506     return std::string(message) + std::string("\n\n");
 507 }
 508
 509 std::string HelpMessageOpt(const std::string &option, const std::string &message) {
 510     return std::string(optIndent,' ') + std::string(option) +
 511            std::string("\n") + std::string(msgIndent,' ') +
 512            FormatParagraph(message, screenWidth - msgIndent, msgIndent) +
 513            std::string("\n\n");
 514 }
 515
 516 static std::string FormatException(const std::exception* pex, const char* pszThread)
 517 {
 518 #ifdef WIN32
 519     char pszModule[MAX_PATH] = "";
 520     GetModuleFileNameA(nullptr, pszModule, sizeof(pszModule));
 521 #else
 522     const char* pszModule = "bitcoin";
 523 #endif
 524     if (pex)
 525         return strprintf(
 526             "EXCEPTION: %s       \n%s       \n%s in %s       \n", typeid(*pex).name(), pex->what(), pszModule, pszThread);
 527     else
 528         return strprintf(
 529             "UNKNOWN EXCEPTION       \n%s in %s       \n", pszModule, pszThread);
 530 }
 531
 532 void PrintExceptionContinue(const std::exception* pex, const char* pszThread)
 533 {
 534     std::string message = FormatException(pex, pszThread);
 535     LogPrintf("\n\n************************\n%s\n", message);
 536     fprintf(stderr, "\n\n************************\n%s\n", message.c_str());
 537 }
 538
 539 fs::path GetDefaultDataDir()
 540 {
 541     // Windows < Vista: C:\Documents and Settings\Username\Application Data\Bitcoin
 542     // Windows >= Vista: C:\Users\Username\AppData\Roaming\Bitcoin
 543     // Mac: ~/Library/Application Support/Bitcoin
 544     // Unix: ~/.bitcoin
 545 #ifdef WIN32
 546     // Windows
 547     return GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
 548 #else
 549     fs::path pathRet;
 550     char* pszHome = getenv("HOME");
 551     if (pszHome == nullptr || strlen(pszHome) == 0)
 552         pathRet = fs::path("/");
 553     else
 554         pathRet = fs::path(pszHome);
 555 #ifdef MAC_OSX
 556     // Mac
 557     return pathRet / "Library/Application Support/Bitcoin";
 558 #else
 559     // Unix
 560     return pathRet / ".bitcoin";
 561 #endif
 562 #endif
 563 }
 564
 565 static fs::path pathCached;
 566 static fs::path pathCachedNetSpecific;
 567 static CCriticalSection csPathCached;
 568
 569 const fs::path &GetDataDir(bool fNetSpecific)
 570 {
 571
 572     LOCK(csPathCached);
 573
 574     fs::path &path = fNetSpecific ? pathCachedNetSpecific : pathCached;
 575
 576     // This can be called during exceptions by LogPrintf(), so we cache the
 577     // value so we don't have to do memory allocations after that.
 578     if (!path.empty())
 579         return path;
 580
 581     if (gArgs.IsArgSet("-datadir")) {
 582         path = fs::system_complete(gArgs.GetArg("-datadir", ""));
 583         if (!fs::is_directory(path)) {
 584             path = "";
 585             return path;
 586         }
 587     } else {
 588         path = GetDefaultDataDir();
 589     }
 590     if (fNetSpecific)
 591         path /= BaseParams().DataDir();
 592
 593     if (fs::create_directories(path)) {
 594         // This is the first run, create wallets subdirectory too
 595         fs::create_directories(path / "wallets");
 596     }
 597
 598     return path;
 599 }
 600
 601 void ClearDatadirCache()
 602 {
 603     LOCK(csPathCached);
 604
 605     pathCached = fs::path();
 606     pathCachedNetSpecific = fs::path();
 607 }
 608
 609 fs::path GetConfigFile(const std::string& confPath)
 610 {
 611     fs::path pathConfigFile(confPath);
 612     if (!pathConfigFile.is_complete())
 613         pathConfigFile = GetDataDir(false) / pathConfigFile;
 614
 615     return pathConfigFile;
 616 }
 617
 618 void ArgsManager::ReadConfigFile(const std::string& confPath)
 619 {
 620     fs::ifstream streamConfig(GetConfigFile(confPath));
 621     if (!streamConfig.good())
 622         return; // No bitcoin.conf file is OK
 623
 624     {
 625         LOCK(cs_args);
 626         std::set<std::string> setOptions;
 627         setOptions.insert("*");
 628
 629         for (boost::program_options::detail::config_file_iterator it(streamConfig, setOptions), end; it != end; ++it)
 630         {
 631             // Don't overwrite existing settings so command line settings override bitcoin.conf
 632             std::string strKey = std::string("-") + it->string_key;
 633             std::string strValue = it->value[0];
 634             InterpretNegativeSetting(strKey, strValue);
 635             if (mapArgs.count(strKey) == 0)
 636                 mapArgs[strKey] = strValue;
 637             mapMultiArgs[strKey].push_back(strValue);
 638         }
 639     }
 640     // If datadir is changed in .conf file:
 641     ClearDatadirCache();
 642 }
 643
 644 #ifndef WIN32
 645 fs::path GetPidFile()
 646 {
 647     fs::path pathPidFile(gArgs.GetArg("-pid", BITCOIN_PID_FILENAME));
 648     if (!pathPidFile.is_complete()) pathPidFile = GetDataDir() / pathPidFile;
 649     return pathPidFile;
 650 }
 651
 652 void CreatePidFile(const fs::path &path, pid_t pid)
 653 {
 654     FILE* file = fsbridge::fopen(path, "w");
 655     if (file)
 656     {
 657         fprintf(file, "%d\n", pid);
 658         fclose(file);
 659     }
 660 }
 661 #endif
 662
 663 bool RenameOver(fs::path src, fs::path dest)
 664 {
 665 #ifdef WIN32
 666     return MoveFileExA(src.string().c_str(), dest.string().c_str(),
 667                        MOVEFILE_REPLACE_EXISTING) != 0;
 668 #else
 669     int rc = std::rename(src.string().c_str(), dest.string().c_str());
 670     return (rc == 0);
 671 #endif /* WIN32 */
 672 }
 673
 674 /**
 675  * Ignores exceptions thrown by Boost's create_directories if the requested directory exists.
 676  * Specifically handles case where path p exists, but it wasn't possible for the user to
 677  * write to the parent directory.
 678  */
 679 bool TryCreateDirectories(const fs::path& p)
 680 {
 681     try
 682     {
 683         return fs::create_directories(p);
 684     } catch (const fs::filesystem_error&) {
 685         if (!fs::exists(p) || !fs::is_directory(p))
 686             throw;
 687     }
 688
 689     // create_directories didn't create the directory, it had to have existed already
 690     return false;
 691 }
 692
 693 void FileCommit(FILE *file)
 694 {
 695     fflush(file); // harmless if redundantly called
 696 #ifdef WIN32
 697     HANDLE hFile = (HANDLE)_get_osfhandle(_fileno(file));
 698     FlushFileBuffers(hFile);
 699 #else
 700     #if defined(__linux__) || defined(__NetBSD__)
 701     fdatasync(fileno(file));
 702     #elif defined(__APPLE__) && defined(F_FULLFSYNC)
 703     fcntl(fileno(file), F_FULLFSYNC, 0);
 704     #else
 705     fsync(fileno(file));
 706     #endif
 707 #endif
 708 }
 709
 710 bool TruncateFile(FILE *file, unsigned int length) {
 711 #if defined(WIN32)
 712     return _chsize(_fileno(file), length) == 0;
 713 #else
 714     return ftruncate(fileno(file), length) == 0;
 715 #endif
 716 }
 717
 718 /**
 719  * this function tries to raise the file descriptor limit to the requested number.
 720  * It returns the actual file descriptor limit (which may be more or less than nMinFD)
 721  */
 722 int RaiseFileDescriptorLimit(int nMinFD) {
 723 #if defined(WIN32)
 724     return 2048;
 725 #else
 726     struct rlimit limitFD;
 727     if (getrlimit(RLIMIT_NOFILE, &limitFD) != -1) {
 728         if (limitFD.rlim_cur < (rlim_t)nMinFD) {
 729             limitFD.rlim_cur = nMinFD;
 730             if (limitFD.rlim_cur > limitFD.rlim_max)
 731                 limitFD.rlim_cur = limitFD.rlim_max;
 732             setrlimit(RLIMIT_NOFILE, &limitFD);
 733             getrlimit(RLIMIT_NOFILE, &limitFD);
 734         }
 735         return limitFD.rlim_cur;
 736     }
 737     return nMinFD; // getrlimit failed, assume it's fine
 738 #endif
 739 }
 740
 741 /**
 742  * this function tries to make a particular range of a file allocated (corresponding to disk space)
 743  * it is advisory, and the range specified in the arguments will never contain live data
 744  */
 745 void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length) {
 746 #if defined(WIN32)
 747     // Windows-specific version
 748     HANDLE hFile = (HANDLE)_get_osfhandle(_fileno(file));
 749     LARGE_INTEGER nFileSize;
 750     int64_t nEndPos = (int64_t)offset + length;
 751     nFileSize.u.LowPart = nEndPos & 0xFFFFFFFF;
 752     nFileSize.u.HighPart = nEndPos >> 32;
 753     SetFilePointerEx(hFile, nFileSize, 0, FILE_BEGIN);
 754     SetEndOfFile(hFile);
 755 #elif defined(MAC_OSX)
 756     // OSX specific version
 757     fstore_t fst;
 758     fst.fst_flags = F_ALLOCATECONTIG;
 759     fst.fst_posmode = F_PEOFPOSMODE;
 760     fst.fst_offset = 0;
 761     fst.fst_length = (off_t)offset + length;
 762     fst.fst_bytesalloc = 0;
 763     if (fcntl(fileno(file), F_PREALLOCATE, &fst) == -1) {
 764         fst.fst_flags = F_ALLOCATEALL;
 765         fcntl(fileno(file), F_PREALLOCATE, &fst);
 766     }
 767     ftruncate(fileno(file), fst.fst_length);
 768 #elif defined(__linux__)
 769     // Version using posix_fallocate
 770     off_t nEndPos = (off_t)offset + length;
 771     posix_fallocate(fileno(file), 0, nEndPos);
 772 #else
 773     // Fallback version
 774     // TODO: just write one byte per block
 775     static const char buf[65536] = {};
 776     fseek(file, offset, SEEK_SET);
 777     while (length > 0) {
 778         unsigned int now = 65536;
 779         if (length < now)
 780             now = length;
 781         fwrite(buf, 1, now, file); // allowed to fail; this function is advisory anyway
 782         length -= now;
 783     }
 784 #endif
 785 }
 786
 787 void ShrinkDebugFile()
 788 {
 789     // Amount of debug.log to save at end when shrinking (must fit in memory)
 790     constexpr size_t RECENT_DEBUG_HISTORY_SIZE = 10 * 1000000;
 791     // Scroll debug.log if it's getting too big
 792     fs::path pathLog = GetDebugLogPath();
 793     FILE* file = fsbridge::fopen(pathLog, "r");
 794     // If debug.log file is more than 10% bigger the RECENT_DEBUG_HISTORY_SIZE
 795     // trim it down by saving only the last RECENT_DEBUG_HISTORY_SIZE bytes
 796     if (file && fs::file_size(pathLog) > 11 * (RECENT_DEBUG_HISTORY_SIZE / 10))
 797     {
 798         // Restart the file with some of the end
 799         std::vector<char> vch(RECENT_DEBUG_HISTORY_SIZE, 0);
 800         fseek(file, -((long)vch.size()), SEEK_END);
 801         int nBytes = fread(vch.data(), 1, vch.size(), file);
 802         fclose(file);
 803
 804         file = fsbridge::fopen(pathLog, "w");
 805         if (file)
 806         {
 807             fwrite(vch.data(), 1, nBytes, file);
 808             fclose(file);
 809         }
 810     }
 811     else if (file != nullptr)
 812         fclose(file);
 813 }
 814
 815 #ifdef WIN32
 816 fs::path GetSpecialFolderPath(int nFolder, bool fCreate)
 817 {
 818     char pszPath[MAX_PATH] = "";
 819
 820     if(SHGetSpecialFolderPathA(nullptr, pszPath, nFolder, fCreate))
 821     {
 822         return fs::path(pszPath);
 823     }
 824
 825     LogPrintf("SHGetSpecialFolderPathA() failed, could not obtain requested path.\n");
 826     return fs::path("");
 827 }
 828 #endif
 829
 830 void runCommand(const std::string& strCommand)
 831 {
 832     if (strCommand.empty()) return;
 833     int nErr = ::system(strCommand.c_str());
 834     if (nErr)
 835         LogPrintf("runCommand error: system(%s) returned %d\n", strCommand, nErr);
 836 }
 837
 838 void RenameThread(const char* name)
 839 {
 840 #if defined(PR_SET_NAME)
 841     // Only the first 15 characters are used (16 - NUL terminator)
 842     ::prctl(PR_SET_NAME, name, 0, 0, 0);
 843 #elif (defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__DragonFly__))
 844     pthread_set_name_np(pthread_self(), name);
 845
 846 #elif defined(MAC_OSX)
 847     pthread_setname_np(name);
 848 #else
 849     // Prevent warnings for unused parameters...
 850     (void)name;
 851 #endif
 852 }
 853
 854 void SetupEnvironment()
 855 {
 856 #ifdef HAVE_MALLOPT_ARENA_MAX
 857     // glibc-specific: On 32-bit systems set the number of arenas to 1.
 858     // By default, since glibc 2.10, the C library will create up to two heap
 859     // arenas per core. This is known to cause excessive virtual address space
 860     // usage in our usage. Work around it by setting the maximum number of
 861     // arenas to 1.
 862     if (sizeof(void*) == 4) {
 863         mallopt(M_ARENA_MAX, 1);
 864     }
 865 #endif
 866     // On most POSIX systems (e.g. Linux, but not BSD) the environment's locale
 867     // may be invalid, in which case the "C" locale is used as fallback.
 868 #if !defined(WIN32) && !defined(MAC_OSX) && !defined(__FreeBSD__) && !defined(__OpenBSD__)
 869     try {
 870         std::locale(""); // Raises a runtime error if current locale is invalid
 871     } catch (const std::runtime_error&) {
 872         setenv("LC_ALL", "C", 1);
 873     }
 874 #endif
 875     // The path locale is lazy initialized and to avoid deinitialization errors
 876     // in multithreading environments, it is set explicitly by the main thread.
 877     // A dummy locale is used to extract the internal default locale, used by
 878     // fs::path, which is then used to explicitly imbue the path.
 879     std::locale loc = fs::path::imbue(std::locale::classic());
 880     fs::path::imbue(loc);
 881 }
 882
 883 bool SetupNetworking()
 884 {
 885 #ifdef WIN32
 886     // Initialize Windows Sockets
 887     WSADATA wsadata;
 888     int ret = WSAStartup(MAKEWORD(2,2), &wsadata);
 889     if (ret != NO_ERROR || LOBYTE(wsadata.wVersion ) != 2 || HIBYTE(wsadata.wVersion) != 2)
 890         return false;
 891 #endif
 892     return true;
 893 }
 894
 895 int GetNumCores()
 896 {
 897 #if BOOST_VERSION >= 105600
 898     return boost::thread::physical_concurrency();
 899 #else // Must fall back to hardware_concurrency, which unfortunately counts virtual cores
 900     return boost::thread::hardware_concurrency();
 901 #endif
 902 }
 903
 904 std::string CopyrightHolders(const std::string& strPrefix)
 905 {
 906     std::string strCopyrightHolders = strPrefix + strprintf(_(COPYRIGHT_HOLDERS), _(COPYRIGHT_HOLDERS_SUBSTITUTION));
 907
 908     // Check for untranslated substitution to make sure Bitcoin Core copyright is not removed by accident
 909     if (strprintf(COPYRIGHT_HOLDERS, COPYRIGHT_HOLDERS_SUBSTITUTION).find("Bitcoin Core") == std::string::npos) {
 910         strCopyrightHolders += "\n" + strPrefix + "The Bitcoin Core developers";
 911     }
 912     return strCopyrightHolders;
 913 }
 914
 915 // Obtain the application startup time (used for uptime calculation)
 916 int64_t GetStartupTime()
 917 {
 918     return nStartupTime;
 919 }