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