util.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Distributed under the MIT/X11 software license, see the accompanying
   3 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
   4
   5
   6 #if defined(_MSC_VER) || defined(__BORLANDC__)
   7 typedef __int64  int64;
   8 typedef unsigned __int64  uint64;
   9 #else
  10 typedef long long  int64;
  11 typedef unsigned long long  uint64;
  12 #endif
  13 #if defined(_MSC_VER) && _MSC_VER < 1300
  14 #define for  if (false) ; else for
  15 #endif
  16 #ifndef _MSC_VER
  17 #define __forceinline  inline
  18 #endif
  19
  20 #define foreach             BOOST_FOREACH
  21 #define loop                for (;;)
  22 #define BEGIN(a)            ((char*)&(a))
  23 #define END(a)              ((char*)&((&(a))[1]))
  24 #define UBEGIN(a)           ((unsigned char*)&(a))
  25 #define UEND(a)             ((unsigned char*)&((&(a))[1]))
  26 #define ARRAYLEN(array)     (sizeof(array)/sizeof((array)[0]))
  27 #define printf              OutputDebugStringF
  28
  29 #ifdef snprintf
  30 #undef snprintf
  31 #endif
  32 #define snprintf my_snprintf
  33
  34 #ifndef PRI64d
  35 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MSVCRT__)
  36 #define PRI64d  "I64d"
  37 #define PRI64u  "I64u"
  38 #define PRI64x  "I64x"
  39 #else
  40 #define PRI64d  "lld"
  41 #define PRI64u  "llu"
  42 #define PRI64x  "llx"
  43 #endif
  44 #endif
  45
  46 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
  47 #define PAIRTYPE(t1, t2)    pair<t1, t2>
  48
  49 // Used to bypass the rule against non-const reference to temporary
  50 // where it makes sense with wrappers such as CFlatData or CTxDB
  51 template<typename T>
  52 inline T& REF(const T& val)
  53 {
  54     return (T&)val;
  55 }
  56
  57 // Align by increasing pointer, must have extra space at end of buffer
  58 template <size_t nBytes, typename T>
  59 T* alignup(T* p)
  60 {
  61     union
  62     {
  63         T* ptr;
  64         size_t n;
  65     } u;
  66     u.ptr = p;
  67     u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
  68     return u.ptr;
  69 }
  70
  71 #ifdef __WXMSW__
  72 #define MSG_NOSIGNAL        0
  73 #define MSG_DONTWAIT        0
  74 #ifndef UINT64_MAX
  75 #define UINT64_MAX          _UI64_MAX
  76 #define INT64_MAX           _I64_MAX
  77 #define INT64_MIN           _I64_MIN
  78 #endif
  79 #ifndef S_IRUSR
  80 #define S_IRUSR             0400
  81 #define S_IWUSR             0200
  82 #endif
  83 #define unlink              _unlink
  84 typedef int socklen_t;
  85 #else
  86 #define WSAGetLastError()   errno
  87 #define WSAEWOULDBLOCK      EWOULDBLOCK
  88 #define WSAEMSGSIZE         EMSGSIZE
  89 #define WSAEINTR            EINTR
  90 #define WSAEINPROGRESS      EINPROGRESS
  91 #define WSAEADDRINUSE       EADDRINUSE
  92 #define WSAENOTSOCK         EBADF
  93 #define INVALID_SOCKET      (SOCKET)(~0)
  94 #define SOCKET_ERROR        -1
  95 typedef u_int SOCKET;
  96 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
  97 #define strlwr(psz)         to_lower(psz)
  98 #define _strlwr(psz)        to_lower(psz)
  99 #define MAX_PATH            1024
 100 #define Beep(n1,n2)         (0)
 101 inline void Sleep(int64 n)
 102 {
 103     boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n));
 104 }
 105 #endif
 106
 107 inline int myclosesocket(SOCKET& hSocket)
 108 {
 109     if (hSocket == INVALID_SOCKET)
 110         return WSAENOTSOCK;
 111 #ifdef __WXMSW__
 112     int ret = closesocket(hSocket);
 113 #else
 114     int ret = close(hSocket);
 115 #endif
 116     hSocket = INVALID_SOCKET;
 117     return ret;
 118 }
 119 #define closesocket(s)      myclosesocket(s)
 120
 121 #ifndef GUI
 122 inline const char* _(const char* psz)
 123 {
 124     return psz;
 125 }
 126 #endif
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137 extern map<string, string> mapArgs;
 138 extern map<string, vector<string> > mapMultiArgs;
 139 extern bool fDebug;
 140 extern bool fPrintToConsole;
 141 extern bool fPrintToDebugger;
 142 extern char pszSetDataDir[MAX_PATH];
 143 extern bool fRequestShutdown;
 144 extern bool fShutdown;
 145 extern bool fDaemon;
 146 extern bool fServer;
 147 extern bool fCommandLine;
 148 extern string strMiscWarning;
 149 extern bool fTestNet;
 150 extern bool fNoListen;
 151 extern bool fLogTimestamps;
 152
 153 void RandAddSeed();
 154 void RandAddSeedPerfmon();
 155 int OutputDebugStringF(const char* pszFormat, ...);
 156 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
 157 string strprintf(const char* format, ...);
 158 bool error(const char* format, ...);
 159 void LogException(std::exception* pex, const char* pszThread);
 160 void PrintException(std::exception* pex, const char* pszThread);
 161 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
 162 void ParseString(const string& str, char c, vector<string>& v);
 163 string FormatMoney(int64 n, bool fPlus=false);
 164 bool ParseMoney(const string& str, int64& nRet);
 165 bool ParseMoney(const char* pszIn, int64& nRet);
 166 vector<unsigned char> ParseHex(const char* psz);
 167 vector<unsigned char> ParseHex(const string& str);
 168 void ParseParameters(int argc, char* argv[]);
 169 const char* wxGetTranslation(const char* psz);
 170 bool WildcardMatch(const char* psz, const char* mask);
 171 bool WildcardMatch(const string& str, const string& mask);
 172 int GetFilesize(FILE* file);
 173 void GetDataDir(char* pszDirRet);
 174 string GetConfigFile();
 175 void ReadConfigFile(map<string, string>& mapSettingsRet, map<string, vector<string> >& mapMultiSettingsRet);
 176 #ifdef __WXMSW__
 177 string MyGetSpecialFolderPath(int nFolder, bool fCreate);
 178 #endif
 179 string GetDefaultDataDir();
 180 string GetDataDir();
 181 void ShrinkDebugFile();
 182 int GetRandInt(int nMax);
 183 uint64 GetRand(uint64 nMax);
 184 int64 GetTime();
 185 int64 GetAdjustedTime();
 186 void AddTimeData(unsigned int ip, int64 nTime);
 187 string FormatFullVersion();
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201 // Wrapper to automatically initialize critical sections
 202 class CCriticalSection
 203 {
 204 #ifdef __WXMSW__
 205 protected:
 206     CRITICAL_SECTION cs;
 207 public:
 208     explicit CCriticalSection() { InitializeCriticalSection(&cs); }
 209     ~CCriticalSection() { DeleteCriticalSection(&cs); }
 210     void Enter() { EnterCriticalSection(&cs); }
 211     void Leave() { LeaveCriticalSection(&cs); }
 212     bool TryEnter() { return TryEnterCriticalSection(&cs); }
 213 #else
 214 protected:
 215     boost::interprocess::interprocess_recursive_mutex mutex;
 216 public:
 217     explicit CCriticalSection() { }
 218     ~CCriticalSection() { }
 219     void Enter() { mutex.lock(); }
 220     void Leave() { mutex.unlock(); }
 221     bool TryEnter() { return mutex.try_lock(); }
 222 #endif
 223 public:
 224     const char* pszFile;
 225     int nLine;
 226 };
 227
 228 // Automatically leave critical section when leaving block, needed for exception safety
 229 class CCriticalBlock
 230 {
 231 protected:
 232     CCriticalSection* pcs;
 233 public:
 234     CCriticalBlock(CCriticalSection& csIn) { pcs = &csIn; pcs->Enter(); }
 235     ~CCriticalBlock() { pcs->Leave(); }
 236 };
 237
 238 // WARNING: This will catch continue and break!
 239 // break is caught with an assertion, but there's no way to detect continue.
 240 // I'd rather be careful than suffer the other more error prone syntax.
 241 // The compiler will optimise away all this loop junk.
 242 #define CRITICAL_BLOCK(cs)     \
 243     for (bool fcriticalblockonce=true; fcriticalblockonce; assert(("break caught by CRITICAL_BLOCK!", !fcriticalblockonce)), fcriticalblockonce=false)  \
 244     for (CCriticalBlock criticalblock(cs); fcriticalblockonce && (cs.pszFile=__FILE__, cs.nLine=__LINE__, true); fcriticalblockonce=false, cs.pszFile=NULL, cs.nLine=0)
 245
 246 class CTryCriticalBlock
 247 {
 248 protected:
 249     CCriticalSection* pcs;
 250 public:
 251     CTryCriticalBlock(CCriticalSection& csIn) { pcs = (csIn.TryEnter() ? &csIn : NULL); }
 252     ~CTryCriticalBlock() { if (pcs) pcs->Leave(); }
 253     bool Entered() { return pcs != NULL; }
 254 };
 255
 256 #define TRY_CRITICAL_BLOCK(cs)     \
 257     for (bool fcriticalblockonce=true; fcriticalblockonce; assert(("break caught by TRY_CRITICAL_BLOCK!", !fcriticalblockonce)), fcriticalblockonce=false)  \
 258     for (CTryCriticalBlock criticalblock(cs); fcriticalblockonce && (fcriticalblockonce = criticalblock.Entered()) && (cs.pszFile=__FILE__, cs.nLine=__LINE__, true); fcriticalblockonce=false, cs.pszFile=NULL, cs.nLine=0)
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269 inline string i64tostr(int64 n)
 270 {
 271     return strprintf("%"PRI64d, n);
 272 }
 273
 274 inline string itostr(int n)
 275 {
 276     return strprintf("%d", n);
 277 }
 278
 279 inline int64 atoi64(const char* psz)
 280 {
 281 #ifdef _MSC_VER
 282     return _atoi64(psz);
 283 #else
 284     return strtoll(psz, NULL, 10);
 285 #endif
 286 }
 287
 288 inline int64 atoi64(const string& str)
 289 {
 290 #ifdef _MSC_VER
 291     return _atoi64(str.c_str());
 292 #else
 293     return strtoll(str.c_str(), NULL, 10);
 294 #endif
 295 }
 296
 297 inline int atoi(const string& str)
 298 {
 299     return atoi(str.c_str());
 300 }
 301
 302 inline int roundint(double d)
 303 {
 304     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 305 }
 306
 307 inline int64 roundint64(double d)
 308 {
 309     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
 310 }
 311
 312 inline int64 abs64(int64 n)
 313 {
 314     return (n >= 0 ? n : -n);
 315 }
 316
 317 template<typename T>
 318 string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 319 {
 320     if (itbegin == itend)
 321         return "";
 322     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
 323     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
 324     string str;
 325     str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
 326     for (const unsigned char* p = pbegin; p != pend; p++)
 327         str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
 328     return str;
 329 }
 330
 331 inline string HexStr(const vector<unsigned char>& vch, bool fSpaces=false)
 332 {
 333     return HexStr(vch.begin(), vch.end(), fSpaces);
 334 }
 335
 336 template<typename T>
 337 string HexNumStr(const T itbegin, const T itend, bool f0x=true)
 338 {
 339     if (itbegin == itend)
 340         return "";
 341     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
 342     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
 343     string str = (f0x ? "0x" : "");
 344     str.reserve(str.size() + (pend-pbegin) * 2);
 345     for (const unsigned char* p = pend-1; p >= pbegin; p--)
 346         str += strprintf("%02x", *p);
 347     return str;
 348 }
 349
 350 inline string HexNumStr(const vector<unsigned char>& vch, bool f0x=true)
 351 {
 352     return HexNumStr(vch.begin(), vch.end(), f0x);
 353 }
 354
 355 template<typename T>
 356 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 357 {
 358     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 359 }
 360
 361 inline void PrintHex(const vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 362 {
 363     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 364 }
 365
 366 inline int64 GetPerformanceCounter()
 367 {
 368     int64 nCounter = 0;
 369 #ifdef __WXMSW__
 370     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
 371 #else
 372     timeval t;
 373     gettimeofday(&t, NULL);
 374     nCounter = t.tv_sec * 1000000 + t.tv_usec;
 375 #endif
 376     return nCounter;
 377 }
 378
 379 inline int64 GetTimeMillis()
 380 {
 381     return (posix_time::ptime(posix_time::microsec_clock::universal_time()) -
 382             posix_time::ptime(gregorian::date(1970,1,1))).total_milliseconds();
 383 }
 384
 385 inline string DateTimeStrFormat(const char* pszFormat, int64 nTime)
 386 {
 387     time_t n = nTime;
 388     struct tm* ptmTime = gmtime(&n);
 389     char pszTime[200];
 390     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
 391     return pszTime;
 392 }
 393
 394 template<typename T>
 395 void skipspaces(T& it)
 396 {
 397     while (isspace(*it))
 398         ++it;
 399 }
 400
 401 inline bool IsSwitchChar(char c)
 402 {
 403 #ifdef __WXMSW__
 404     return c == '-' || c == '/';
 405 #else
 406     return c == '-';
 407 #endif
 408 }
 409
 410 inline string GetArg(const string& strArg, const string& strDefault)
 411 {
 412     if (mapArgs.count(strArg))
 413         return mapArgs[strArg];
 414     return strDefault;
 415 }
 416
 417 inline int64 GetArg(const string& strArg, int64 nDefault)
 418 {
 419     if (mapArgs.count(strArg))
 420         return atoi64(mapArgs[strArg]);
 421     return nDefault;
 422 }
 423
 424 inline bool GetBoolArg(const string& strArg)
 425 {
 426     if (mapArgs.count(strArg))
 427     {
 428         if (mapArgs[strArg].empty())
 429             return true;
 430         return (atoi(mapArgs[strArg]) != 0);
 431     }
 432     return false;
 433 }
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444 inline void heapchk()
 445 {
 446 #ifdef __WXMSW__
 447     /// for debugging
 448     //if (_heapchk() != _HEAPOK)
 449     //    DebugBreak();
 450 #endif
 451 }
 452
 453 // Randomize the stack to help protect against buffer overrun exploits
 454 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn)     \
 455     {                                           \
 456         static char nLoops;                     \
 457         if (nLoops <= 0)                        \
 458             nLoops = GetRand(20) + 1;           \
 459         if (nLoops-- > 1)                       \
 460         {                                       \
 461             ThreadFn;                           \
 462             return;                             \
 463         }                                       \
 464     }
 465
 466 #define CATCH_PRINT_EXCEPTION(pszFn)     \
 467     catch (std::exception& e) {          \
 468         PrintException(&e, (pszFn));     \
 469     } catch (...) {                      \
 470         PrintException(NULL, (pszFn));   \
 471     }
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482 template<typename T1>
 483 inline uint256 Hash(const T1 pbegin, const T1 pend)
 484 {
 485     static unsigned char pblank[1];
 486     uint256 hash1;
 487     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
 488     uint256 hash2;
 489     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 490     return hash2;
 491 }
 492
 493 template<typename T1, typename T2>
 494 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 495                     const T2 p2begin, const T2 p2end)
 496 {
 497     static unsigned char pblank[1];
 498     uint256 hash1;
 499     SHA256_CTX ctx;
 500     SHA256_Init(&ctx);
 501     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 502     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 503     SHA256_Final((unsigned char*)&hash1, &ctx);
 504     uint256 hash2;
 505     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 506     return hash2;
 507 }
 508
 509 template<typename T1, typename T2, typename T3>
 510 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 511                     const T2 p2begin, const T2 p2end,
 512                     const T3 p3begin, const T3 p3end)
 513 {
 514     static unsigned char pblank[1];
 515     uint256 hash1;
 516     SHA256_CTX ctx;
 517     SHA256_Init(&ctx);
 518     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 519     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 520     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
 521     SHA256_Final((unsigned char*)&hash1, &ctx);
 522     uint256 hash2;
 523     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 524     return hash2;
 525 }
 526
 527 template<typename T>
 528 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=VERSION)
 529 {
 530     // Most of the time is spent allocating and deallocating CDataStream's
 531     // buffer.  If this ever needs to be optimized further, make a CStaticStream
 532     // class with its buffer on the stack.
 533     CDataStream ss(nType, nVersion);
 534     ss.reserve(10000);
 535     ss << obj;
 536     return Hash(ss.begin(), ss.end());
 537 }
 538
 539 inline uint160 Hash160(const vector<unsigned char>& vch)
 540 {
 541     uint256 hash1;
 542     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
 543     uint160 hash2;
 544     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 545     return hash2;
 546 }
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558 // Note: It turns out we might have been able to use boost::thread
 559 // by using TerminateThread(boost::thread.native_handle(), 0);
 560 #ifdef __WXMSW__
 561 typedef HANDLE pthread_t;
 562
 563 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
 564 {
 565     DWORD nUnused = 0;
 566     HANDLE hthread =
 567         CreateThread(
 568             NULL,                        // default security
 569             0,                           // inherit stack size from parent
 570             (LPTHREAD_START_ROUTINE)pfn, // function pointer
 571             parg,                        // argument
 572             0,                           // creation option, start immediately
 573             &nUnused);                   // thread identifier
 574     if (hthread == NULL)
 575     {
 576         printf("Error: CreateThread() returned %d\n", GetLastError());
 577         return (pthread_t)0;
 578     }
 579     if (!fWantHandle)
 580     {
 581         CloseHandle(hthread);
 582         return (pthread_t)-1;
 583     }
 584     return hthread;
 585 }
 586
 587 inline void SetThreadPriority(int nPriority)
 588 {
 589     SetThreadPriority(GetCurrentThread(), nPriority);
 590 }
 591 #else
 592 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
 593 {
 594     pthread_t hthread = 0;
 595     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
 596     if (ret != 0)
 597     {
 598         printf("Error: pthread_create() returned %d\n", ret);
 599         return (pthread_t)0;
 600     }
 601     if (!fWantHandle)
 602         return (pthread_t)-1;
 603     return hthread;
 604 }
 605
 606 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 607 #define THREAD_PRIORITY_BELOW_NORMAL    2
 608 #define THREAD_PRIORITY_NORMAL          0
 609 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 610
 611 inline void SetThreadPriority(int nPriority)
 612 {
 613     // It's unclear if it's even possible to change thread priorities on Linux,
 614     // but we really and truly need it for the generation threads.
 615 #ifdef PRIO_THREAD
 616     setpriority(PRIO_THREAD, 0, nPriority);
 617 #else
 618     setpriority(PRIO_PROCESS, 0, nPriority);
 619 #endif
 620 }
 621
 622 inline bool TerminateThread(pthread_t hthread, unsigned int nExitCode)
 623 {
 624     return (pthread_cancel(hthread) == 0);
 625 }
 626
 627 inline void ExitThread(unsigned int nExitCode)
 628 {
 629     pthread_exit((void*)nExitCode);
 630 }
 631 #endif
 632
 633
 634
 635
 636
 637 inline bool AffinityBugWorkaround(void(*pfn)(void*))
 638 {
 639 #ifdef __WXMSW__
 640     // Sometimes after a few hours affinity gets stuck on one processor
 641     DWORD dwProcessAffinityMask = -1;
 642     DWORD dwSystemAffinityMask = -1;
 643     GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
 644     DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
 645     DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
 646     if (dwPrev2 != dwProcessAffinityMask)
 647     {
 648         printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
 649         if (!CreateThread(pfn, NULL))
 650             printf("Error: CreateThread() failed\n");
 651         return true;
 652     }
 653 #endif
 654     return false;
 655 }