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 int64_t GetTimeMillis();
 242 int64_t GetTimeMicros();
 243
 244 int64_t GetAdjustedTime();
 245 int64_t GetTimeOffset();
 246 int64_t GetNodesOffset();
 247 std::string FormatFullVersion();
 248 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
 249 void AddTimeData(const CNetAddr& ip, int64_t nTime);
 250 void runCommand(std::string strCommand);
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260 inline std::string i64tostr(int64_t n)
 261 {
 262     return strprintf("%" PRId64, n);
 263 }
 264
 265 inline std::string itostr(int n)
 266 {
 267     return strprintf("%d", n);
 268 }
 269
 270 inline int64_t atoi64(const char* psz)
 271 {
 272 #ifdef _MSC_VER
 273     return _atoi64(psz);
 274 #else
 275     return strtoll(psz, NULL, 10);
 276 #endif
 277 }
 278
 279 inline int64_t atoi64(const std::string& str)
 280 {
 281 #ifdef _MSC_VER
 282     return _atoi64(str.c_str());
 283 #else
 284     return strtoll(str.c_str(), NULL, 10);
 285 #endif
 286 }
 287
 288 inline int32_t strtol(const char* psz)
 289 {
 290     return strtol(psz, NULL, 10);
 291 }
 292
 293 inline int32_t strtol(const std::string& str)
 294 {
 295     return strtol(str.c_str(), NULL, 10);
 296 }
 297
 298 inline uint32_t strtoul(const char* psz)
 299 {
 300     return strtoul(psz, NULL, 10);
 301 }
 302
 303 inline uint32_t strtoul(const std::string& str)
 304 {
 305     return strtoul(str.c_str(), NULL, 10);
 306 }
 307
 308 inline int atoi(const std::string& str)
 309 {
 310     return atoi(str.c_str());
 311 }
 312
 313 inline int roundint(double d)
 314 {
 315     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 316 }
 317
 318 inline int64_t roundint64(double d)
 319 {
 320     return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
 321 }
 322
 323 inline int64_t abs64(int64_t n)
 324 {
 325     return (n >= 0 ? n : -n);
 326 }
 327
 328 inline std::string leftTrim(std::string src, char chr)
 329 {
 330     std::string::size_type pos = src.find_first_not_of(chr, 0);
 331
 332     if(pos > 0)
 333         src.erase(0, pos);
 334
 335     return src;
 336 }
 337
 338 template<typename T>
 339 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 340 {
 341     std::string rv;
 342     static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 343                                      '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 344     rv.reserve((itend-itbegin)*3);
 345     for(T it = itbegin; it < itend; ++it)
 346     {
 347         unsigned char val = (unsigned char)(*it);
 348         if(fSpaces && it != itbegin)
 349             rv.push_back(' ');
 350         rv.push_back(hexmap[val>>4]);
 351         rv.push_back(hexmap[val&15]);
 352     }
 353
 354     return rv;
 355 }
 356
 357 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
 358 {
 359     return HexStr(vch.begin(), vch.end(), fSpaces);
 360 }
 361
 362 template<typename T>
 363 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 364 {
 365     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 366 }
 367
 368 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 369 {
 370     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 371 }
 372
 373 inline int64_t GetPerformanceCounter()
 374 {
 375     int64_t nCounter = 0;
 376 #ifdef WIN32
 377     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
 378 #else
 379     timeval t;
 380     gettimeofday(&t, NULL);
 381     nCounter = (int64_t) t.tv_sec * 1000000 + t.tv_usec;
 382 #endif
 383     return nCounter;
 384 }
 385
 386 inline int64_t GetTimeMillis()
 387 {
 388     return (boost::posix_time::microsec_clock::universal_time() -
 389             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
 390 }
 391
 392 inline int64_t GetTimeMicros()
 393 {
 394     return (boost::posix_time::microsec_clock::universal_time() -
 395                    boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_microseconds();
 396 }
 397
 398 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
 399
 400 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
 401 inline std::string DateTimeStrFormat(int64_t nTime)
 402 {
 403     return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
 404 }
 405
 406
 407 template<typename T>
 408 void skipspaces(T& it)
 409 {
 410     while (isspace(*it))
 411         ++it;
 412 }
 413
 414 inline bool IsSwitchChar(char c)
 415 {
 416 #ifdef WIN32
 417     return c == '-' || c == '/';
 418 #else
 419     return c == '-';
 420 #endif
 421 }
 422
 423 /**
 424  * Return string argument or default value
 425  *
 426  * @param strArg Argument to get (e.g. "-foo")
 427  * @param default (e.g. "1")
 428  * @return command-line argument or default value
 429  */
 430 std::string GetArg(const std::string& strArg, const std::string& strDefault);
 431
 432 /**
 433  * Return 64-bit integer argument or default value
 434  *
 435  * @param strArg Argument to get (e.g. "-foo")
 436  * @param default (e.g. 1)
 437  * @return command-line argument (0 if invalid number) or default value
 438  */
 439 int64_t GetArg(const std::string& strArg, int64_t nDefault);
 440
 441 /**
 442  * Return 32-bit integer argument or default value
 443  *
 444  * @param strArg Argument to get (e.g. "-foo")
 445  * @param default (e.g. 1)
 446  * @return command-line argument (0 if invalid number) or default value
 447  */
 448 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
 449
 450 /**
 451  * Return 32-bit unsigned integer argument or default value
 452  *
 453  * @param strArg Argument to get (e.g. "-foo")
 454  * @param default (e.g. 1)
 455  * @return command-line argument (0 if invalid number) or default value
 456  */
 457 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
 458
 459 /**
 460  * Return boolean argument or default value
 461  *
 462  * @param strArg Argument to get (e.g. "-foo")
 463  * @param default (true or false)
 464  * @return command-line argument or default value
 465  */
 466 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 467
 468 /**
 469  * Set an argument if it doesn't already have a value
 470  *
 471  * @param strArg Argument to set (e.g. "-foo")
 472  * @param strValue Value (e.g. "1")
 473  * @return true if argument gets set, false if it already had a value
 474  */
 475 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
 476
 477 /**
 478  * Set a boolean argument if it doesn't already have a value
 479  *
 480  * @param strArg Argument to set (e.g. "-foo")
 481  * @param fValue Value (e.g. false)
 482  * @return true if argument gets set, false if it already had a value
 483  */
 484 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
 485
 486 /**
 487  * Timing-attack-resistant comparison.
 488  * Takes time proportional to length
 489  * of first argument.
 490  */
 491 template <typename T>
 492 bool TimingResistantEqual(const T& a, const T& b)
 493 {
 494     if (b.size() == 0) return a.size() == 0;
 495     size_t accumulator = a.size() ^ b.size();
 496     for (size_t i = 0; i < a.size(); i++)
 497         accumulator |= a[i] ^ b[i%b.size()];
 498     return accumulator == 0;
 499 }
 500
 501 /** Median filter over a stream of values.
 502  * Returns the median of the last N numbers
 503  */
 504 template <typename T> class CMedianFilter
 505 {
 506 private:
 507     std::vector<T> vValues;
 508     std::vector<T> vSorted;
 509     unsigned int nSize;
 510 public:
 511     CMedianFilter(unsigned int size, T initial_value):
 512         nSize(size)
 513     {
 514         vValues.reserve(size);
 515         vValues.push_back(initial_value);
 516         vSorted = vValues;
 517     }
 518
 519     void input(T value)
 520     {
 521         if(vValues.size() == nSize)
 522         {
 523             vValues.erase(vValues.begin());
 524         }
 525         vValues.push_back(value);
 526
 527         vSorted.resize(vValues.size());
 528         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
 529         std::sort(vSorted.begin(), vSorted.end());
 530     }
 531
 532     T median() const
 533     {
 534         size_t size = vSorted.size();
 535         assert(size>0);
 536         if(size & 1) // Odd number of elements
 537         {
 538             return vSorted[size/2];
 539         }
 540         else // Even number of elements
 541         {
 542             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
 543         }
 544     }
 545
 546     int size() const
 547     {
 548         return static_cast<int>(vValues.size());
 549     }
 550
 551     std::vector<T> sorted () const
 552     {
 553         return vSorted;
 554     }
 555 };
 556
 557 bool NewThread(void(*pfn)(void*), void* parg);
 558
 559 #ifdef WIN32
 560 inline void SetThreadPriority(int nPriority)
 561 {
 562     SetThreadPriority(GetCurrentThread(), nPriority);
 563 }
 564 #else
 565
 566 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 567 #define THREAD_PRIORITY_BELOW_NORMAL    2
 568 #define THREAD_PRIORITY_NORMAL          0
 569 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 570
 571 inline void SetThreadPriority(int nPriority)
 572 {
 573     // It's unclear if it's even possible to change thread priorities on Linux,
 574     // but we really and truly need it for the generation threads.
 575 #ifdef PRIO_THREAD
 576     setpriority(PRIO_THREAD, 0, nPriority);
 577 #else
 578     setpriority(PRIO_PROCESS, 0, nPriority);
 579 #endif
 580 }
 581
 582 inline void ExitThread(size_t nExitCode)
 583 {
 584     pthread_exit((void*)nExitCode);
 585 }
 586 #endif
 587
 588 void RenameThread(const char* name);
 589
 590 inline uint32_t ByteReverse(uint32_t value)
 591 {
 592     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
 593     return (value<<16) | (value>>16);
 594 }
 595
 596 #endif
 597