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