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