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