src/util.cpp

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