src/util.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2012 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5 #ifndef BITCOIN_UTIL_H
   6 #define BITCOIN_UTIL_H
   7
   8 #include "uint256.h"
   9
  10 #ifndef WIN32
  11 #include <sys/types.h>
  12 #include <sys/time.h>
  13 #include <sys/resource.h>
  14 #else
  15 typedef int pid_t; /* define for Windows compatibility */
  16 #endif
  17 #include <map>
  18 #include <vector>
  19 #include <string>
  20
  21 #include <boost/thread.hpp>
  22 #include <boost/filesystem.hpp>
  23 #include <boost/filesystem/path.hpp>
  24 #include <boost/date_time/gregorian/gregorian_types.hpp>
  25 #include <boost/date_time/posix_time/posix_time_types.hpp>
  26
  27 #include <openssl/sha.h>
  28 #include <openssl/ripemd.h>
  29
  30 #include "netbase.h" // for AddTimeData
  31
  32 typedef long long  int64;
  33 typedef unsigned long long  uint64;
  34
  35 static const int64 COIN = 1000000;
  36 static const int64 CENT = 10000;
  37
  38 #define BEGIN(a)            ((char*)&(a))
  39 #define END(a)              ((char*)&((&(a))[1]))
  40 #define UBEGIN(a)           ((unsigned char*)&(a))
  41 #define UEND(a)             ((unsigned char*)&((&(a))[1]))
  42 #define ARRAYLEN(array)     (sizeof(array)/sizeof((array)[0]))
  43
  44 #define UVOIDBEGIN(a)        ((void*)&(a))
  45 #define CVOIDBEGIN(a)        ((const void*)&(a))
  46 #define UINTBEGIN(a)        ((uint32_t*)&(a))
  47 #define CUINTBEGIN(a)        ((const uint32_t*)&(a))
  48
  49 #ifndef PRI64d
  50 #if defined(_MSC_VER) || defined(__MSVCRT__)
  51 #define PRI64d  "I64d"
  52 #define PRI64u  "I64u"
  53 #define PRI64x  "I64x"
  54 #else
  55 #define PRI64d  "lld"
  56 #define PRI64u  "llu"
  57 #define PRI64x  "llx"
  58 #endif
  59 #endif
  60
  61 #ifndef THROW_WITH_STACKTRACE
  62 #define THROW_WITH_STACKTRACE(exception)  \
  63 {                                         \
  64     LogStackTrace();                      \
  65     throw (exception);                    \
  66 }
  67 void LogStackTrace();
  68 #endif
  69
  70
  71 /* Format characters for (s)size_t and ptrdiff_t */
  72 #if defined(_MSC_VER) || defined(__MSVCRT__)
  73   /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
  74      http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
  75    */
  76   #define PRIszx    "Ix"
  77   #define PRIszu    "Iu"
  78   #define PRIszd    "Id"
  79   #define PRIpdx    "Ix"
  80   #define PRIpdu    "Iu"
  81   #define PRIpdd    "Id"
  82 #else /* C99 standard */
  83   #define PRIszx    "zx"
  84   #define PRIszu    "zu"
  85   #define PRIszd    "zd"
  86   #define PRIpdx    "tx"
  87   #define PRIpdu    "tu"
  88   #define PRIpdd    "td"
  89 #endif
  90
  91 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
  92 #define PAIRTYPE(t1, t2)    std::pair<t1, t2>
  93
  94 // Align by increasing pointer, must have extra space at end of buffer
  95 template <size_t nBytes, typename T>
  96 T* alignup(T* p)
  97 {
  98     union
  99     {
 100         T* ptr;
 101         size_t n;
 102     } u;
 103     u.ptr = p;
 104     u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
 105     return u.ptr;
 106 }
 107
 108 #ifdef WIN32
 109 #define MSG_NOSIGNAL        0
 110 #define MSG_DONTWAIT        0
 111
 112 #ifndef S_IRUSR
 113 #define S_IRUSR             0400
 114 #define S_IWUSR             0200
 115 #endif
 116 #else
 117 #define MAX_PATH            1024
 118 inline void Sleep(int64 n)
 119 {
 120     /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
 121       So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
 122     boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
 123 }
 124 #endif
 125
 126 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
 127  * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
 128  * Parameters count from 1.
 129  */
 130 #ifdef __GNUC__
 131 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
 132 #else
 133 #define ATTR_WARN_PRINTF(X,Y)
 134 #endif
 135
 136
 137
 138
 139
 140
 141
 142
 143 extern std::map<std::string, std::string> mapArgs;
 144 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
 145 extern bool fDebug;
 146 extern bool fDebugNet;
 147 extern bool fPrintToConsole;
 148 extern bool fPrintToDebugger;
 149 extern bool fRequestShutdown;
 150 extern bool fShutdown;
 151 extern bool fDaemon;
 152 extern bool fServer;
 153 extern bool fCommandLine;
 154 extern std::string strMiscWarning;
 155 extern bool fTestNet;
 156 extern bool fNoListen;
 157 extern bool fLogTimestamps;
 158 extern bool fReopenDebugLog;
 159
 160 void RandAddSeed();
 161 void RandAddSeedPerfmon();
 162 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
 163
 164 /*
 165   Rationale for the real_strprintf / strprintf construction:
 166     It is not allowed to use va_start with a pass-by-reference argument.
 167     (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
 168     macro to keep similar semantics.
 169 */
 170
 171 /** Overload strprintf for char*, so that GCC format type warnings can be given */
 172 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
 173 /** Overload strprintf for std::string, to be able to use it with _ (translation).
 174  * This will not support GCC format type warnings (-Wformat) so be careful.
 175  */
 176 std::string real_strprintf(const std::string &format, int dummy, ...);
 177 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
 178 std::string vstrprintf(const char *format, va_list ap);
 179
 180 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
 181
 182 /* Redefine printf so that it directs output to debug.log
 183  *
 184  * Do this *after* defining the other printf-like functions, because otherwise the
 185  * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
 186  * which confuses gcc.
 187  */
 188 #define printf OutputDebugStringF
 189
 190 void LogException(std::exception* pex, const char* pszThread);
 191 void PrintException(std::exception* pex, const char* pszThread);
 192 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
 193 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
 194 std::string FormatMoney(int64 n, bool fPlus=false);
 195 bool ParseMoney(const std::string& str, int64& nRet);
 196 bool ParseMoney(const char* pszIn, int64& nRet);
 197 std::vector<unsigned char> ParseHex(const char* psz);
 198 std::vector<unsigned char> ParseHex(const std::string& str);
 199 bool IsHex(const std::string& str);
 200 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
 201 std::string DecodeBase64(const std::string& str);
 202 std::string EncodeBase64(const unsigned char* pch, size_t len);
 203 std::string EncodeBase64(const std::string& str);
 204 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
 205 std::string DecodeBase32(const std::string& str);
 206 std::string EncodeBase32(const unsigned char* pch, size_t len);
 207 std::string EncodeBase32(const std::string& str);
 208 void ParseParameters(int argc, const char*const argv[]);
 209 bool WildcardMatch(const char* psz, const char* mask);
 210 bool WildcardMatch(const std::string& str, const std::string& mask);
 211 void FileCommit(FILE *fileout);
 212 int GetFilesize(FILE* file);
 213 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
 214 boost::filesystem::path GetDefaultDataDir();
 215 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
 216 boost::filesystem::path GetConfigFile();
 217 boost::filesystem::path GetPidFile();
 218 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
 219 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
 220 #ifdef WIN32
 221 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
 222 #endif
 223 void ShrinkDebugFile();
 224 int GetRandInt(int nMax);
 225 uint64 GetRand(uint64 nMax);
 226 uint256 GetRandHash();
 227 int64 GetTime();
 228 void SetMockTime(int64 nMockTimeIn);
 229 int64 GetAdjustedTime();
 230 int64 GetTimeOffset();
 231 std::string FormatFullVersion();
 232 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
 233 void AddTimeData(const CNetAddr& ip, int64 nTime);
 234 void runCommand(std::string strCommand);
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244 inline std::string i64tostr(int64 n)
 245 {
 246     return strprintf("%"PRI64d, n);
 247 }
 248
 249 inline std::string itostr(int n)
 250 {
 251     return strprintf("%d", n);
 252 }
 253
 254 inline int64 atoi64(const char* psz)
 255 {
 256 #ifdef _MSC_VER
 257     return _atoi64(psz);
 258 #else
 259     return strtoll(psz, NULL, 10);
 260 #endif
 261 }
 262
 263 inline int64 atoi64(const std::string& str)
 264 {
 265 #ifdef _MSC_VER
 266     return _atoi64(str.c_str());
 267 #else
 268     return strtoll(str.c_str(), NULL, 10);
 269 #endif
 270 }
 271
 272 inline int atoi(const std::string& str)
 273 {
 274     return atoi(str.c_str());
 275 }
 276
 277 inline int roundint(double d)
 278 {
 279     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 280 }
 281
 282 inline int64 roundint64(double d)
 283 {
 284     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
 285 }
 286
 287 inline int64 abs64(int64 n)
 288 {
 289     return (n >= 0 ? n : -n);
 290 }
 291
 292 template<typename T>
 293 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 294 {
 295     std::string rv;
 296     static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 297                                      '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 298     rv.reserve((itend-itbegin)*3);
 299     for(T it = itbegin; it < itend; ++it)
 300     {
 301         unsigned char val = (unsigned char)(*it);
 302         if(fSpaces && it != itbegin)
 303             rv.push_back(' ');
 304         rv.push_back(hexmap[val>>4]);
 305         rv.push_back(hexmap[val&15]);
 306     }
 307
 308     return rv;
 309 }
 310
 311 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
 312 {
 313     return HexStr(vch.begin(), vch.end(), fSpaces);
 314 }
 315
 316 template<typename T>
 317 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 318 {
 319     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 320 }
 321
 322 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 323 {
 324     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 325 }
 326
 327 inline int64 GetPerformanceCounter()
 328 {
 329     int64 nCounter = 0;
 330 #ifdef WIN32
 331     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
 332 #else
 333     timeval t;
 334     gettimeofday(&t, NULL);
 335     nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec;
 336 #endif
 337     return nCounter;
 338 }
 339
 340 inline int64 GetTimeMillis()
 341 {
 342     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
 343             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
 344 }
 345
 346 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
 347 {
 348     time_t n = nTime;
 349     struct tm* ptmTime = gmtime(&n);
 350     char pszTime[200];
 351     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
 352     return pszTime;
 353 }
 354
 355 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
 356 inline std::string DateTimeStrFormat(int64 nTime)
 357 {
 358     return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
 359 }
 360
 361
 362 template<typename T>
 363 void skipspaces(T& it)
 364 {
 365     while (isspace(*it))
 366         ++it;
 367 }
 368
 369 inline bool IsSwitchChar(char c)
 370 {
 371 #ifdef WIN32
 372     return c == '-' || c == '/';
 373 #else
 374     return c == '-';
 375 #endif
 376 }
 377
 378 /**
 379  * Return string argument or default value
 380  *
 381  * @param strArg Argument to get (e.g. "-foo")
 382  * @param default (e.g. "1")
 383  * @return command-line argument or default value
 384  */
 385 std::string GetArg(const std::string& strArg, const std::string& strDefault);
 386
 387 /**
 388  * Return integer argument or default value
 389  *
 390  * @param strArg Argument to get (e.g. "-foo")
 391  * @param default (e.g. 1)
 392  * @return command-line argument (0 if invalid number) or default value
 393  */
 394 int64 GetArg(const std::string& strArg, int64 nDefault);
 395
 396 /**
 397  * Return boolean argument or default value
 398  *
 399  * @param strArg Argument to get (e.g. "-foo")
 400  * @param default (true or false)
 401  * @return command-line argument or default value
 402  */
 403 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 404
 405 /**
 406  * Set an argument if it doesn't already have a value
 407  *
 408  * @param strArg Argument to set (e.g. "-foo")
 409  * @param strValue Value (e.g. "1")
 410  * @return true if argument gets set, false if it already had a value
 411  */
 412 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
 413
 414 /**
 415  * Set a boolean argument if it doesn't already have a value
 416  *
 417  * @param strArg Argument to set (e.g. "-foo")
 418  * @param fValue Value (e.g. false)
 419  * @return true if argument gets set, false if it already had a value
 420  */
 421 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431 template<typename T1>
 432 inline uint256 Hash(const T1 pbegin, const T1 pend)
 433 {
 434     static unsigned char pblank[1];
 435     uint256 hash1;
 436     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
 437     uint256 hash2;
 438     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 439     return hash2;
 440 }
 441
 442 class CHashWriter
 443 {
 444 private:
 445     SHA256_CTX ctx;
 446
 447 public:
 448     int nType;
 449     int nVersion;
 450
 451     void Init() {
 452         SHA256_Init(&ctx);
 453     }
 454
 455     CHashWriter(int nTypeIn, int nVersionIn) : nType(nTypeIn), nVersion(nVersionIn) {
 456         Init();
 457     }
 458
 459     CHashWriter& write(const char *pch, size_t size) {
 460         SHA256_Update(&ctx, pch, size);
 461         return (*this);
 462     }
 463
 464     // invalidates the object
 465     uint256 GetHash() {
 466         uint256 hash1;
 467         SHA256_Final((unsigned char*)&hash1, &ctx);
 468         uint256 hash2;
 469         SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 470         return hash2;
 471     }
 472
 473     template<typename T>
 474     CHashWriter& operator<<(const T& obj) {
 475         // Serialize to this stream
 476         ::Serialize(*this, obj, nType, nVersion);
 477         return (*this);
 478     }
 479 };
 480
 481
 482 template<typename T1, typename T2>
 483 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 484                     const T2 p2begin, const T2 p2end)
 485 {
 486     static unsigned char pblank[1];
 487     uint256 hash1;
 488     SHA256_CTX ctx;
 489     SHA256_Init(&ctx);
 490     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 491     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 492     SHA256_Final((unsigned char*)&hash1, &ctx);
 493     uint256 hash2;
 494     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 495     return hash2;
 496 }
 497
 498 template<typename T1, typename T2, typename T3>
 499 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 500                     const T2 p2begin, const T2 p2end,
 501                     const T3 p3begin, const T3 p3end)
 502 {
 503     static unsigned char pblank[1];
 504     uint256 hash1;
 505     SHA256_CTX ctx;
 506     SHA256_Init(&ctx);
 507     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 508     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 509     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
 510     SHA256_Final((unsigned char*)&hash1, &ctx);
 511     uint256 hash2;
 512     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 513     return hash2;
 514 }
 515
 516 template<typename T>
 517 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
 518 {
 519     CHashWriter ss(nType, nVersion);
 520     ss << obj;
 521     return ss.GetHash();
 522 }
 523
 524 inline uint160 Hash160(const std::vector<unsigned char>& vch)
 525 {
 526     uint256 hash1;
 527     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
 528     uint160 hash2;
 529     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 530     return hash2;
 531 }
 532
 533 /**
 534  * Timing-attack-resistant comparison.
 535  * Takes time proportional to length
 536  * of first argument.
 537  */
 538 template <typename T>
 539 bool TimingResistantEqual(const T& a, const T& b)
 540 {
 541     if (b.size() == 0) return a.size() == 0;
 542     size_t accumulator = a.size() ^ b.size();
 543     for (size_t i = 0; i < a.size(); i++)
 544         accumulator |= a[i] ^ b[i%b.size()];
 545     return accumulator == 0;
 546 }
 547
 548 /** Median filter over a stream of values.
 549  * Returns the median of the last N numbers
 550  */
 551 template <typename T> class CMedianFilter
 552 {
 553 private:
 554     std::vector<T> vValues;
 555     std::vector<T> vSorted;
 556     unsigned int nSize;
 557 public:
 558     CMedianFilter(unsigned int size, T initial_value):
 559         nSize(size)
 560     {
 561         vValues.reserve(size);
 562         vValues.push_back(initial_value);
 563         vSorted = vValues;
 564     }
 565
 566     void input(T value)
 567     {
 568         if(vValues.size() == nSize)
 569         {
 570             vValues.erase(vValues.begin());
 571         }
 572         vValues.push_back(value);
 573
 574         vSorted.resize(vValues.size());
 575         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
 576         std::sort(vSorted.begin(), vSorted.end());
 577     }
 578
 579     T median() const
 580     {
 581         int size = vSorted.size();
 582         assert(size>0);
 583         if(size & 1) // Odd number of elements
 584         {
 585             return vSorted[size/2];
 586         }
 587         else // Even number of elements
 588         {
 589             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
 590         }
 591     }
 592
 593     int size() const
 594     {
 595         return vValues.size();
 596     }
 597
 598     std::vector<T> sorted () const
 599     {
 600         return vSorted;
 601     }
 602 };
 603
 604 bool NewThread(void(*pfn)(void*), void* parg);
 605
 606 #ifdef WIN32
 607 inline void SetThreadPriority(int nPriority)
 608 {
 609     SetThreadPriority(GetCurrentThread(), nPriority);
 610 }
 611 #else
 612
 613 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 614 #define THREAD_PRIORITY_BELOW_NORMAL    2
 615 #define THREAD_PRIORITY_NORMAL          0
 616 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 617
 618 inline void SetThreadPriority(int nPriority)
 619 {
 620     // It's unclear if it's even possible to change thread priorities on Linux,
 621     // but we really and truly need it for the generation threads.
 622 #ifdef PRIO_THREAD
 623     setpriority(PRIO_THREAD, 0, nPriority);
 624 #else
 625     setpriority(PRIO_PROCESS, 0, nPriority);
 626 #endif
 627 }
 628
 629 inline void ExitThread(size_t nExitCode)
 630 {
 631     pthread_exit((void*)nExitCode);
 632 }
 633 #endif
 634
 635 void RenameThread(const char* name);
 636
 637 inline uint32_t ByteReverse(uint32_t value)
 638 {
 639     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
 640     return (value<<16) | (value>>16);
 641 }
 642
 643 #endif
 644