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 extern std::map<std::string, std::string> mapArgs;
 146 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
 147 extern bool fDebug;
 148 extern bool fDebugNet;
 149 extern bool fPrintToConsole;
 150 extern bool fPrintToDebugger;
 151 extern bool fRequestShutdown;
 152 extern bool fShutdown;
 153 extern bool fDaemon;
 154 extern bool fServer;
 155 extern bool fCommandLine;
 156 extern std::string strMiscWarning;
 157 extern bool fTestNet;
 158 extern bool fNoListen;
 159 extern bool fLogTimestamps;
 160 extern bool fReopenDebugLog;
 161
 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_t n, bool fPlus=false);
 195 bool ParseMoney(const std::string& str, int64_t& nRet);
 196 bool ParseMoney(const char* pszIn, int64_t& 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_t nTime);
 209 int64_t 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 int64_t GetTime();
 231 int64_t GetTimeMillis();
 232 int64_t GetTimeMicros();
 233 std::string FormatFullVersion();
 234 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
 235 void runCommand(std::string strCommand);
 236
 237
 238 inline std::string i64tostr(int64_t n)
 239 {
 240     return strprintf("%" PRId64, n);
 241 }
 242
 243 inline std::string itostr(int n)
 244 {
 245     return strprintf("%d", n);
 246 }
 247
 248 inline int64_t atoi64(const char* psz)
 249 {
 250 #ifdef _MSC_VER
 251     return _atoi64(psz);
 252 #else
 253     return strtoll(psz, NULL, 10);
 254 #endif
 255 }
 256
 257 inline int64_t atoi64(const std::string& str)
 258 {
 259 #ifdef _MSC_VER
 260     return _atoi64(str.c_str());
 261 #else
 262     return strtoll(str.c_str(), NULL, 10);
 263 #endif
 264 }
 265
 266 inline int32_t strtol(const char* psz)
 267 {
 268     return strtol(psz, NULL, 10);
 269 }
 270
 271 inline int32_t strtol(const std::string& str)
 272 {
 273     return strtol(str.c_str(), NULL, 10);
 274 }
 275
 276 inline uint32_t strtoul(const char* psz)
 277 {
 278     return strtoul(psz, NULL, 10);
 279 }
 280
 281 inline uint32_t strtoul(const std::string& str)
 282 {
 283     return strtoul(str.c_str(), NULL, 10);
 284 }
 285
 286 inline int atoi(const std::string& str)
 287 {
 288     return atoi(str.c_str());
 289 }
 290
 291 inline int roundint(double d)
 292 {
 293     return (int)(d > 0 ? d + 0.5 : d - 0.5);
 294 }
 295
 296 inline int64_t roundint64(double d)
 297 {
 298     return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
 299 }
 300
 301 inline int64_t abs64(int64_t n)
 302 {
 303     return (n >= 0 ? n : -n);
 304 }
 305
 306 inline std::string leftTrim(std::string src, char chr)
 307 {
 308     std::string::size_type pos = src.find_first_not_of(chr, 0);
 309
 310     if(pos > 0)
 311         src.erase(0, pos);
 312
 313     return src;
 314 }
 315
 316 template<typename T>
 317 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
 318 {
 319     std::string rv;
 320     static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 321                                      '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 322     rv.reserve((itend-itbegin)*3);
 323     for(T it = itbegin; it < itend; ++it)
 324     {
 325         unsigned char val = (unsigned char)(*it);
 326         if(fSpaces && it != itbegin)
 327             rv.push_back(' ');
 328         rv.push_back(hexmap[val>>4]);
 329         rv.push_back(hexmap[val&15]);
 330     }
 331
 332     return rv;
 333 }
 334
 335 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
 336 {
 337     return HexStr(vch.begin(), vch.end(), fSpaces);
 338 }
 339
 340 template<typename T>
 341 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
 342 {
 343     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
 344 }
 345
 346 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
 347 {
 348     printf(pszFormat, HexStr(vch, fSpaces).c_str());
 349 }
 350
 351 inline int64_t GetTimeMillis()
 352 {
 353     return (boost::posix_time::microsec_clock::universal_time() -
 354             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
 355 }
 356
 357 inline int64_t GetTimeMicros()
 358 {
 359     return (boost::posix_time::microsec_clock::universal_time() -
 360                    boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_microseconds();
 361 }
 362
 363 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
 364
 365 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
 366 inline std::string DateTimeStrFormat(int64_t nTime)
 367 {
 368     return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
 369 }
 370
 371
 372 template<typename T>
 373 void skipspaces(T& it)
 374 {
 375     while (isspace(*it))
 376         ++it;
 377 }
 378
 379 inline bool IsSwitchChar(char c)
 380 {
 381 #ifdef WIN32
 382     return c == '-' || c == '/';
 383 #else
 384     return c == '-';
 385 #endif
 386 }
 387
 388 /**
 389  * Return string argument or default value
 390  *
 391  * @param strArg Argument to get (e.g. "-foo")
 392  * @param default (e.g. "1")
 393  * @return command-line argument or default value
 394  */
 395 std::string GetArg(const std::string& strArg, const std::string& strDefault);
 396
 397 /**
 398  * Return 64-bit integer argument or default value
 399  *
 400  * @param strArg Argument to get (e.g. "-foo")
 401  * @param default (e.g. 1)
 402  * @return command-line argument (0 if invalid number) or default value
 403  */
 404 int64_t GetArg(const std::string& strArg, int64_t nDefault);
 405
 406 /**
 407  * Return 32-bit integer argument or default value
 408  *
 409  * @param strArg Argument to get (e.g. "-foo")
 410  * @param default (e.g. 1)
 411  * @return command-line argument (0 if invalid number) or default value
 412  */
 413 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
 414
 415 /**
 416  * Return 32-bit unsigned integer argument or default value
 417  *
 418  * @param strArg Argument to get (e.g. "-foo")
 419  * @param default (e.g. 1)
 420  * @return command-line argument (0 if invalid number) or default value
 421  */
 422 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
 423
 424 /**
 425  * Return boolean argument or default value
 426  *
 427  * @param strArg Argument to get (e.g. "-foo")
 428  * @param default (true or false)
 429  * @return command-line argument or default value
 430  */
 431 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 432
 433 /**
 434  * Set an argument if it doesn't already have a value
 435  *
 436  * @param strArg Argument to set (e.g. "-foo")
 437  * @param strValue Value (e.g. "1")
 438  * @return true if argument gets set, false if it already had a value
 439  */
 440 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
 441
 442 /**
 443  * Set a boolean argument if it doesn't already have a value
 444  *
 445  * @param strArg Argument to set (e.g. "-foo")
 446  * @param fValue Value (e.g. false)
 447  * @return true if argument gets set, false if it already had a value
 448  */
 449 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
 450
 451 /**
 452  * Timing-attack-resistant comparison.
 453  * Takes time proportional to length
 454  * of first argument.
 455  */
 456 template <typename T>
 457 bool TimingResistantEqual(const T& a, const T& b)
 458 {
 459     if (b.size() == 0) return a.size() == 0;
 460     size_t accumulator = a.size() ^ b.size();
 461     for (size_t i = 0; i < a.size(); i++)
 462         accumulator |= a[i] ^ b[i%b.size()];
 463     return accumulator == 0;
 464 }
 465
 466 bool NewThread(void(*pfn)(void*), void* parg);
 467
 468 #ifdef WIN32
 469 inline void SetThreadPriority(int nPriority)
 470 {
 471     SetThreadPriority(GetCurrentThread(), nPriority);
 472 }
 473 #else
 474
 475 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
 476 #define THREAD_PRIORITY_BELOW_NORMAL    2
 477 #define THREAD_PRIORITY_NORMAL          0
 478 #define THREAD_PRIORITY_ABOVE_NORMAL    0
 479
 480 inline void SetThreadPriority(int nPriority)
 481 {
 482     // It's unclear if it's even possible to change thread priorities on Linux,
 483     // but we really and truly need it for the generation threads.
 484 #ifdef PRIO_THREAD
 485     setpriority(PRIO_THREAD, 0, nPriority);
 486 #else
 487     setpriority(PRIO_PROCESS, 0, nPriority);
 488 #endif
 489 }
 490
 491 inline void ExitThread(size_t nExitCode)
 492 {
 493     pthread_exit((void*)nExitCode);
 494 }
 495 #endif
 496
 497 void RenameThread(const char* name);
 498
 499 inline uint32_t ByteReverse(uint32_t value)
 500 {
 501     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
 502     return (value<<16) | (value>>16);
 503 }
 504
 505 #endif