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