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