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