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