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 #ifndef WIN32
 219 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
 220 #endif
 221 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
 222 #ifdef WIN32
 223 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
 224 #endif
 225 void ShrinkDebugFile();
 226 int GetRandInt(int nMax);
 227 uint64 GetRand(uint64 nMax);
 228 uint256 GetRandHash();
 229 int64 GetTime();
 230 void SetMockTime(int64 nMockTimeIn);
 231 int64 GetAdjustedTime();
 232 int64 GetTimeOffset();
 233 std::string FormatFullVersion();
 234 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
 235 void AddTimeData(const CNetAddr& ip, int64 nTime);
 236 void runCommand(std::string strCommand);
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246 inline std::string i64tostr(int64 n)
 247 {
 248     return strprintf("%"PRI64d, n);
 249 }
 250
 251 inline std::string itostr(int n)
 252 {
 253     return strprintf("%d", n);
 254 }
 255
 256 inline int64 atoi64(const char* psz)
 257 {
 258 #ifdef _MSC_VER
 259     return _atoi64(psz);
 260 #else
 261     return strtoll(psz, NULL, 10);
 262 #endif
 263 }
 264
 265 inline int64 atoi64(const std::string& str)
 266 {
 267 #ifdef _MSC_VER
 268     return _atoi64(str.c_str());
 269 #else
 270     return strtoll(str.c_str(), NULL, 10);
 271 #endif
 272 }
 273
 274 inline int atoi(const std::string& str)
 275 {
 276     return atoi(str.c_str());
 277 }
 278
 279 inline int roundint(double d)
 280 {
 281     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 282 }
 283
 284 inline int64 roundint64(double d)
 285 {
 286     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
 287 }
 288
 289 inline int64 abs64(int64 n)
 290 {
 291     return (n >= 0 ? n : -n);
 292 }
 293
 294 template<typename T>
 295 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 296 {
 297     std::string rv;
 298     static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 299                                      '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 300     rv.reserve((itend-itbegin)*3);
 301     for(T it = itbegin; it < itend; ++it)
 302     {
 303         unsigned char val = (unsigned char)(*it);
 304         if(fSpaces && it != itbegin)
 305             rv.push_back(' ');
 306         rv.push_back(hexmap[val>>4]);
 307         rv.push_back(hexmap[val&15]);
 308     }
 309
 310     return rv;
 311 }
 312
 313 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
 314 {
 315     return HexStr(vch.begin(), vch.end(), fSpaces);
 316 }
 317
 318 template<typename T>
 319 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 320 {
 321     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 322 }
 323
 324 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 325 {
 326     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 327 }
 328
 329 inline int64 GetPerformanceCounter()
 330 {
 331     int64 nCounter = 0;
 332 #ifdef WIN32
 333     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
 334 #else
 335     timeval t;
 336     gettimeofday(&t, NULL);
 337     nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec;
 338 #endif
 339     return nCounter;
 340 }
 341
 342 inline int64 GetTimeMillis()
 343 {
 344     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
 345             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
 346 }
 347
 348 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
 349 {
 350     time_t n = nTime;
 351     struct tm* ptmTime = gmtime(&n);
 352     char pszTime[200];
 353     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
 354     return pszTime;
 355 }
 356
 357 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
 358 inline std::string DateTimeStrFormat(int64 nTime)
 359 {
 360     return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
 361 }
 362
 363
 364 template<typename T>
 365 void skipspaces(T& it)
 366 {
 367     while (isspace(*it))
 368         ++it;
 369 }
 370
 371 inline bool IsSwitchChar(char c)
 372 {
 373 #ifdef WIN32
 374     return c == '-' || c == '/';
 375 #else
 376     return c == '-';
 377 #endif
 378 }
 379
 380 /**
 381  * Return string argument or default value
 382  *
 383  * @param strArg Argument to get (e.g. "-foo")
 384  * @param default (e.g. "1")
 385  * @return command-line argument or default value
 386  */
 387 std::string GetArg(const std::string& strArg, const std::string& strDefault);
 388
 389 /**
 390  * Return integer argument or default value
 391  *
 392  * @param strArg Argument to get (e.g. "-foo")
 393  * @param default (e.g. 1)
 394  * @return command-line argument (0 if invalid number) or default value
 395  */
 396 int64 GetArg(const std::string& strArg, int64 nDefault);
 397
 398 /**
 399  * Return boolean argument or default value
 400  *
 401  * @param strArg Argument to get (e.g. "-foo")
 402  * @param default (true or false)
 403  * @return command-line argument or default value
 404  */
 405 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 406
 407 /**
 408  * Set an argument if it doesn't already have a value
 409  *
 410  * @param strArg Argument to set (e.g. "-foo")
 411  * @param strValue Value (e.g. "1")
 412  * @return true if argument gets set, false if it already had a value
 413  */
 414 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
 415
 416 /**
 417  * Set a boolean argument if it doesn't already have a value
 418  *
 419  * @param strArg Argument to set (e.g. "-foo")
 420  * @param fValue Value (e.g. false)
 421  * @return true if argument gets set, false if it already had a value
 422  */
 423 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433 template<typename T1>
 434 inline uint256 Hash(const T1 pbegin, const T1 pend)
 435 {
 436     static unsigned char pblank[1];
 437     uint256 hash1;
 438     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
 439     uint256 hash2;
 440     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 441     return hash2;
 442 }
 443
 444 class CHashWriter
 445 {
 446 private:
 447     SHA256_CTX ctx;
 448
 449 public:
 450     int nType;
 451     int nVersion;
 452
 453     void Init() {
 454         SHA256_Init(&ctx);
 455     }
 456
 457     CHashWriter(int nTypeIn, int nVersionIn) : nType(nTypeIn), nVersion(nVersionIn) {
 458         Init();
 459     }
 460
 461     CHashWriter& write(const char *pch, size_t size) {
 462         SHA256_Update(&ctx, pch, size);
 463         return (*this);
 464     }
 465
 466     // invalidates the object
 467     uint256 GetHash() {
 468         uint256 hash1;
 469         SHA256_Final((unsigned char*)&hash1, &ctx);
 470         uint256 hash2;
 471         SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 472         return hash2;
 473     }
 474
 475     template<typename T>
 476     CHashWriter& operator<<(const T& obj) {
 477         // Serialize to this stream
 478         ::Serialize(*this, obj, nType, nVersion);
 479         return (*this);
 480     }
 481 };
 482
 483
 484 template<typename T1, typename T2>
 485 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 486                     const T2 p2begin, const T2 p2end)
 487 {
 488     static unsigned char pblank[1];
 489     uint256 hash1;
 490     SHA256_CTX ctx;
 491     SHA256_Init(&ctx);
 492     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 493     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 494     SHA256_Final((unsigned char*)&hash1, &ctx);
 495     uint256 hash2;
 496     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 497     return hash2;
 498 }
 499
 500 template<typename T1, typename T2, typename T3>
 501 inline uint256 Hash(const T1 p1begin, const T1 p1end,
 502                     const T2 p2begin, const T2 p2end,
 503                     const T3 p3begin, const T3 p3end)
 504 {
 505     static unsigned char pblank[1];
 506     uint256 hash1;
 507     SHA256_CTX ctx;
 508     SHA256_Init(&ctx);
 509     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
 510     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
 511     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
 512     SHA256_Final((unsigned char*)&hash1, &ctx);
 513     uint256 hash2;
 514     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 515     return hash2;
 516 }
 517
 518 template<typename T>
 519 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
 520 {
 521     CHashWriter ss(nType, nVersion);
 522     ss << obj;
 523     return ss.GetHash();
 524 }
 525
 526 inline uint160 Hash160(const std::vector<unsigned char>& vch)
 527 {
 528     uint256 hash1;
 529     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
 530     uint160 hash2;
 531     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
 532     return hash2;
 533 }
 534
 535 /**
 536  * Timing-attack-resistant comparison.
 537  * Takes time proportional to length
 538  * of first argument.
 539  */
 540 template <typename T>
 541 bool TimingResistantEqual(const T& a, const T& b)
 542 {
 543     if (b.size() == 0) return a.size() == 0;
 544     size_t accumulator = a.size() ^ b.size();
 545     for (size_t i = 0; i < a.size(); i++)
 546         accumulator |= a[i] ^ b[i%b.size()];
 547     return accumulator == 0;
 548 }
 549
 550 /** Median filter over a stream of values.
 551  * Returns the median of the last N numbers
 552  */
 553 template <typename T> class CMedianFilter
 554 {
 555 private:
 556     std::vector<T> vValues;
 557     std::vector<T> vSorted;
 558     unsigned int nSize;
 559 public:
 560     CMedianFilter(unsigned int size, T initial_value):
 561         nSize(size)
 562     {
 563         vValues.reserve(size);
 564         vValues.push_back(initial_value);
 565         vSorted = vValues;
 566     }
 567
 568     void input(T value)
 569     {
 570         if(vValues.size() == nSize)
 571         {
 572             vValues.erase(vValues.begin());
 573         }
 574         vValues.push_back(value);
 575
 576         vSorted.resize(vValues.size());
 577         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
 578         std::sort(vSorted.begin(), vSorted.end());
 579     }
 580
 581     T median() const
 582     {
 583         int size = vSorted.size();
 584         assert(size>0);
 585         if(size & 1) // Odd number of elements
 586         {
 587             return vSorted[size/2];
 588         }
 589         else // Even number of elements
 590         {
 591             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
 592         }
 593     }
 594
 595     int size() const
 596     {
 597         return vValues.size();
 598     }
 599
 600     std::vector<T> sorted () const
 601     {
 602         return vSorted;
 603     }
 604 };
 605
 606 bool NewThread(void(*pfn)(void*), void* parg);
 607
 608 #ifdef WIN32
 609 inline void SetThreadPriority(int nPriority)
 610 {
 611     SetThreadPriority(GetCurrentThread(), nPriority);
 612 }
 613 #else
 614
 615 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 616 #define THREAD_PRIORITY_BELOW_NORMAL    2
 617 #define THREAD_PRIORITY_NORMAL          0
 618 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 619
 620 inline void SetThreadPriority(int nPriority)
 621 {
 622     // It's unclear if it's even possible to change thread priorities on Linux,
 623     // but we really and truly need it for the generation threads.
 624 #ifdef PRIO_THREAD
 625     setpriority(PRIO_THREAD, 0, nPriority);
 626 #else
 627     setpriority(PRIO_PROCESS, 0, nPriority);
 628 #endif
 629 }
 630
 631 inline void ExitThread(size_t nExitCode)
 632 {
 633     pthread_exit((void*)nExitCode);
 634 }
 635 #endif
 636
 637 void RenameThread(const char* name);
 638
 639 inline uint32_t ByteReverse(uint32_t value)
 640 {
 641     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
 642     return (value<<16) | (value>>16);
 643 }
 644
 645 #endif
 646