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