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     this_thread::sleep_for(std::chrono::milliseconds(n));
 119 }
 120 #endif
 121
 122 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
 123  * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
 124  * Parameters count from 1.
 125  */
 126 #ifdef __GNUC__
 127 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
 128 #else
 129 #define ATTR_WARN_PRINTF(X,Y)
 130 #endif
 131
 132
 133
 134
 135
 136
 137
 138
 139 extern std::map<std::string, std::string> mapArgs;
 140 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
 141 extern bool fDebug;
 142 extern bool fDebugNet;
 143 extern bool fPrintToConsole;
 144 extern bool fPrintToDebugger;
 145 extern bool fRequestShutdown;
 146 extern bool fShutdown;
 147 extern bool fDaemon;
 148 extern bool fServer;
 149 extern bool fCommandLine;
 150 extern std::string strMiscWarning;
 151 extern bool fTestNet;
 152 extern bool fNoListen;
 153 extern bool fLogTimestamps;
 154 extern bool fReopenDebugLog;
 155
 156 void RandAddSeed();
 157 void RandAddSeedPerfmon();
 158 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
 159
 160 /*
 161   Rationale for the real_strprintf / strprintf construction:
 162     It is not allowed to use va_start with a pass-by-reference argument.
 163     (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
 164     macro to keep similar semantics.
 165 */
 166
 167 /** Overload strprintf for char*, so that GCC format type warnings can be given */
 168 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
 169 /** Overload strprintf for std::string, to be able to use it with _ (translation).
 170  * This will not support GCC format type warnings (-Wformat) so be careful.
 171  */
 172 std::string real_strprintf(const std::string &format, int dummy, ...);
 173 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
 174 std::string vstrprintf(const char *format, va_list ap);
 175
 176 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
 177
 178 /* Redefine printf so that it directs output to debug.log
 179  *
 180  * Do this *after* defining the other printf-like functions, because otherwise the
 181  * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
 182  * which confuses gcc.
 183  */
 184 #define printf OutputDebugStringF
 185
 186 void LogException(std::exception* pex, const char* pszThread);
 187 void PrintException(std::exception* pex, const char* pszThread);
 188 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
 189 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
 190 std::string FormatMoney(int64_t n, bool fPlus=false);
 191 bool ParseMoney(const std::string& str, int64_t& nRet);
 192 bool ParseMoney(const char* pszIn, int64_t& nRet);
 193 std::vector<uint8_t> ParseHex(const char *str);
 194 inline std::vector<uint8_t> ParseHex(const std::string& str) { return ParseHex(str.c_str()); }
 195 bool IsHex(const std::string& str);
 196 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
 197 std::string DecodeBase64(const std::string& str);
 198 std::string EncodeBase64(const unsigned char* pch, size_t len);
 199 std::string EncodeBase64(const std::string& str);
 200 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
 201 std::string DecodeBase32(const std::string& str);
 202 std::string EncodeBase32(const unsigned char* pch, size_t len);
 203 std::string EncodeBase32(const std::string& str);
 204 std::string EncodeDumpTime(int64_t nTime);
 205 int64_t DecodeDumpTime(const std::string& s);
 206 std::string EncodeDumpString(const std::string &str);
 207 std::string DecodeDumpString(const std::string &str);
 208 void ParseParameters(int argc, const char*const argv[]);
 209 bool WildcardMatch(const char* psz, const char* mask);
 210 bool WildcardMatch(const std::string& str, const std::string& mask);
 211 void FileCommit(FILE *fileout);
 212 int GetFilesize(FILE* file);
 213 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
 214 boost::filesystem::path GetDefaultDataDir();
 215 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
 216 boost::filesystem::path GetConfigFile();
 217 boost::filesystem::path GetPidFile();
 218 #ifndef WIN32
 219 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
 220 #endif
 221 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
 222 #ifdef WIN32
 223 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
 224 #endif
 225 void ShrinkDebugFile();
 226 int GetRandInt(int nMax);
 227 uint64_t GetRand(uint64_t nMax);
 228 uint256 GetRandHash();
 229 void FillRand(uint8_t *buffer, size_t nCount);
 230 int64_t GetTime();
 231 int64_t GetTimeMillis();
 232 int64_t GetTimeMicros();
 233
 234 int64_t GetAdjustedTime();
 235 int64_t GetTimeOffset();
 236 int64_t GetNodesOffset();
 237 std::string FormatFullVersion();
 238 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
 239 void AddTimeData(const CNetAddr& ip, int64_t nTime);
 240 void runCommand(std::string strCommand);
 241
 242
 243
 244
 245
 246 inline std::string i64tostr(int64_t n)
 247 {
 248     return strprintf("%" PRId64, n);
 249 }
 250
 251 inline int64_t strtoll(const char* psz)
 252 {
 253     return strtoll(psz, NULL, 10);
 254 }
 255
 256 inline int64_t strtoll(const std::string& str)
 257 {
 258     return strtoll(str.c_str(), NULL, 10);
 259 }
 260
 261 inline int32_t strtol(const char* psz)
 262 {
 263     return strtol(psz, NULL, 10);
 264 }
 265
 266 inline int32_t strtol(const std::string& str)
 267 {
 268     return strtol(str.c_str(), NULL, 10);
 269 }
 270
 271 inline uint32_t strtoul(const char* psz)
 272 {
 273     return strtoul(psz, NULL, 10);
 274 }
 275
 276 inline uint32_t strtoul(const std::string& str)
 277 {
 278     return strtoul(str.c_str(), NULL, 10);
 279 }
 280
 281 inline int atoi(const std::string& str)
 282 {
 283     return atoi(str.c_str());
 284 }
 285
 286 inline int roundint(double d)
 287 {
 288     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 289 }
 290
 291 inline int64_t roundint64(double d)
 292 {
 293     return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
 294 }
 295
 296 inline std::string leftTrim(std::string src, char chr)
 297 {
 298     std::string::size_type pos = src.find_first_not_of(chr, 0);
 299
 300     if(pos > 0)
 301         src.erase(0, pos);
 302
 303     return src;
 304 }
 305
 306 template<typename T>
 307 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 308 {
 309     std::string rv;
 310     static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 311                                      '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 312     rv.reserve((itend-itbegin)*3);
 313     for(T it = itbegin; it < itend; ++it)
 314     {
 315         unsigned char val = (unsigned char)(*it);
 316         if(fSpaces && it != itbegin)
 317             rv.push_back(' ');
 318         rv.push_back(hexmap[val>>4]);
 319         rv.push_back(hexmap[val&15]);
 320     }
 321
 322     return rv;
 323 }
 324
 325 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
 326 {
 327     return HexStr(vch.begin(), vch.end(), fSpaces);
 328 }
 329
 330 template<typename T>
 331 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 332 {
 333     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 334 }
 335
 336 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 337 {
 338     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 339 }
 340
 341 inline int64_t GetPerformanceCounter()
 342 {
 343     int64_t nCounter = 0;
 344 #ifdef WIN32
 345     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
 346 #else
 347     timeval t;
 348     gettimeofday(&t, NULL);
 349     nCounter = (int64_t) t.tv_sec * 1000000 + t.tv_usec;
 350 #endif
 351     return nCounter;
 352 }
 353
 354 inline int64_t GetTimeMillis()
 355 {
 356     return std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch()).count();
 357 }
 358
 359 inline int64_t GetTimeMicros()
 360 {
 361     return std::chrono::duration_cast<std::chrono::microseconds>(std::chrono::system_clock::now().time_since_epoch()).count();
 362 }
 363
 364 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
 365
 366 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
 367 inline std::string DateTimeStrFormat(int64_t 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 64-bit 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_t GetArg(const std::string& strArg, int64_t nDefault);
 406
 407 /**
 408  * Return 32-bit integer argument or default value
 409  *
 410  * @param strArg Argument to get (e.g. "-foo")
 411  * @param default (e.g. 1)
 412  * @return command-line argument (0 if invalid number) or default value
 413  */
 414 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
 415
 416 /**
 417  * Return 32-bit unsigned integer argument or default value
 418  *
 419  * @param strArg Argument to get (e.g. "-foo")
 420  * @param default (e.g. 1)
 421  * @return command-line argument (0 if invalid number) or default value
 422  */
 423 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
 424
 425 /**
 426  * Return boolean argument or default value
 427  *
 428  * @param strArg Argument to get (e.g. "-foo")
 429  * @param default (true or false)
 430  * @return command-line argument or default value
 431  */
 432 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 433
 434 /**
 435  * Set an argument if it doesn't already have a value
 436  *
 437  * @param strArg Argument to set (e.g. "-foo")
 438  * @param strValue Value (e.g. "1")
 439  * @return true if argument gets set, false if it already had a value
 440  */
 441 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
 442
 443 /**
 444  * Set a boolean argument if it doesn't already have a value
 445  *
 446  * @param strArg Argument to set (e.g. "-foo")
 447  * @param fValue Value (e.g. false)
 448  * @return true if argument gets set, false if it already had a value
 449  */
 450 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
 451
 452 /**
 453  * Timing-attack-resistant comparison.
 454  * Takes time proportional to length
 455  * of first argument.
 456  */
 457 template <typename T>
 458 bool TimingResistantEqual(const T& a, const T& b)
 459 {
 460     if (b.size() == 0) return a.size() == 0;
 461     size_t accumulator = a.size() ^ b.size();
 462     for (size_t i = 0; i < a.size(); i++)
 463         accumulator |= a[i] ^ b[i%b.size()];
 464     return accumulator == 0;
 465 }
 466
 467 /** Median filter over a stream of values.
 468  * Returns the median of the last N numbers
 469  */
 470 template <typename T> class CMedianFilter
 471 {
 472 private:
 473     std::vector<T> vValues;
 474     std::vector<T> vSorted;
 475     unsigned int nSize;
 476 public:
 477     CMedianFilter(unsigned int size, T initial_value):
 478         nSize(size)
 479     {
 480         vValues.reserve(size);
 481         vValues.push_back(initial_value);
 482         vSorted = vValues;
 483     }
 484
 485     void input(T value)
 486     {
 487         if(vValues.size() == nSize)
 488         {
 489             vValues.erase(vValues.begin());
 490         }
 491         vValues.push_back(value);
 492
 493         vSorted.resize(vValues.size());
 494         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
 495         std::sort(vSorted.begin(), vSorted.end());
 496     }
 497
 498     T median() const
 499     {
 500         size_t size = vSorted.size();
 501         assert(size>0);
 502         if(size & 1) // Odd number of elements
 503         {
 504             return vSorted[size/2];
 505         }
 506         else // Even number of elements
 507         {
 508             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
 509         }
 510     }
 511
 512     int size() const
 513     {
 514         return static_cast<int>(vValues.size());
 515     }
 516
 517     std::vector<T> sorted () const
 518     {
 519         return vSorted;
 520     }
 521 };
 522
 523 bool NewThread(void(*pfn)(void*), void* parg);
 524
 525 #ifdef WIN32
 526 inline void SetThreadPriority(int nPriority)
 527 {
 528     SetThreadPriority(GetCurrentThread(), nPriority);
 529 }
 530 #else
 531
 532 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 533 #define THREAD_PRIORITY_BELOW_NORMAL    2
 534 #define THREAD_PRIORITY_NORMAL          0
 535 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 536
 537 inline void SetThreadPriority(int nPriority)
 538 {
 539     // It's unclear if it's even possible to change thread priorities on Linux,
 540     // but we really and truly need it for the generation threads.
 541 #ifdef PRIO_THREAD
 542     setpriority(PRIO_THREAD, 0, nPriority);
 543 #else
 544     setpriority(PRIO_PROCESS, 0, nPriority);
 545 #endif
 546 }
 547
 548 inline void ExitThread(size_t nExitCode)
 549 {
 550     pthread_exit((void*)nExitCode);
 551 }
 552 #endif
 553
 554 void RenameThread(const char* name);
 555
 556 inline uint32_t ByteReverse(uint32_t value)
 557 {
 558     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
 559     return (value<<16) | (value>>16);
 560 }
 561
 562 #endif
 563