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