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