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