src/util.cpp

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2011 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
   5 #include "headers.h"
   6 #include "strlcpy.h"
   7 #include <boost/algorithm/string/join.hpp>
   8 #include <boost/program_options/detail/config_file.hpp>
   9 #include <boost/program_options/parsers.hpp>
  10 #include <boost/filesystem.hpp>
  11 #include <boost/filesystem/fstream.hpp>
  12 #include <boost/interprocess/sync/interprocess_mutex.hpp>
  13 #include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
  14 #include <boost/foreach.hpp>
  15
  16 using namespace std;
  17 using namespace boost;
  18
  19 map<string, string> mapArgs;
  20 map<string, vector<string> > mapMultiArgs;
  21 bool fDebug = false;
  22 bool fPrintToConsole = false;
  23 bool fPrintToDebugger = false;
  24 char pszSetDataDir[MAX_PATH] = "";
  25 bool fRequestShutdown = false;
  26 bool fShutdown = false;
  27 bool fDaemon = false;
  28 bool fServer = false;
  29 bool fCommandLine = false;
  30 string strMiscWarning;
  31 bool fTestNet = false;
  32 bool fNoListen = false;
  33 bool fLogTimestamps = false;
  34 CMedianFilter<int64> vTimeOffsets(200,0);
  35
  36
  37
  38 // Workaround for "multiple definition of `_tls_used'"
  39 // http://svn.boost.org/trac/boost/ticket/4258
  40 extern "C" void tss_cleanup_implemented() { }
  41
  42
  43
  44
  45
  46 // Init openssl library multithreading support
  47 static boost::interprocess::interprocess_mutex** ppmutexOpenSSL;
  48 void locking_callback(int mode, int i, const char* file, int line)
  49 {
  50     if (mode & CRYPTO_LOCK)
  51         ppmutexOpenSSL[i]->lock();
  52     else
  53         ppmutexOpenSSL[i]->unlock();
  54 }
  55
  56 // Init
  57 class CInit
  58 {
  59 public:
  60     CInit()
  61     {
  62         // Init openssl library multithreading support
  63         ppmutexOpenSSL = (boost::interprocess::interprocess_mutex**)OPENSSL_malloc(CRYPTO_num_locks() * sizeof(boost::interprocess::interprocess_mutex*));
  64         for (int i = 0; i < CRYPTO_num_locks(); i++)
  65             ppmutexOpenSSL[i] = new boost::interprocess::interprocess_mutex();
  66         CRYPTO_set_locking_callback(locking_callback);
  67
  68 #ifdef WIN32
  69         // Seed random number generator with screen scrape and other hardware sources
  70         RAND_screen();
  71 #endif
  72
  73         // Seed random number generator with performance counter
  74         RandAddSeed();
  75     }
  76     ~CInit()
  77     {
  78         // Shutdown openssl library multithreading support
  79         CRYPTO_set_locking_callback(NULL);
  80         for (int i = 0; i < CRYPTO_num_locks(); i++)
  81             delete ppmutexOpenSSL[i];
  82         OPENSSL_free(ppmutexOpenSSL);
  83     }
  84 }
  85 instance_of_cinit;
  86
  87
  88
  89
  90
  91
  92
  93
  94 void RandAddSeed()
  95 {
  96     // Seed with CPU performance counter
  97     int64 nCounter = GetPerformanceCounter();
  98     RAND_add(&nCounter, sizeof(nCounter), 1.5);
  99     memset(&nCounter, 0, sizeof(nCounter));
 100 }
 101
 102 void RandAddSeedPerfmon()
 103 {
 104     RandAddSeed();
 105
 106     // This can take up to 2 seconds, so only do it every 10 minutes
 107     static int64 nLastPerfmon;
 108     if (GetTime() < nLastPerfmon + 10 * 60)
 109         return;
 110     nLastPerfmon = GetTime();
 111
 112 #ifdef WIN32
 113     // Don't need this on Linux, OpenSSL automatically uses /dev/urandom
 114     // Seed with the entire set of perfmon data
 115     unsigned char pdata[250000];
 116     memset(pdata, 0, sizeof(pdata));
 117     unsigned long nSize = sizeof(pdata);
 118     long ret = RegQueryValueExA(HKEY_PERFORMANCE_DATA, "Global", NULL, NULL, pdata, &nSize);
 119     RegCloseKey(HKEY_PERFORMANCE_DATA);
 120     if (ret == ERROR_SUCCESS)
 121     {
 122         RAND_add(pdata, nSize, nSize/100.0);
 123         memset(pdata, 0, nSize);
 124         printf("%s RandAddSeed() %d bytes\n", DateTimeStrFormat("%x %H:%M", GetTime()).c_str(), nSize);
 125     }
 126 #endif
 127 }
 128
 129 uint64 GetRand(uint64 nMax)
 130 {
 131     if (nMax == 0)
 132         return 0;
 133
 134     // The range of the random source must be a multiple of the modulus
 135     // to give every possible output value an equal possibility
 136     uint64 nRange = (std::numeric_limits<uint64>::max() / nMax) * nMax;
 137     uint64 nRand = 0;
 138     do
 139         RAND_bytes((unsigned char*)&nRand, sizeof(nRand));
 140     while (nRand >= nRange);
 141     return (nRand % nMax);
 142 }
 143
 144 int GetRandInt(int nMax)
 145 {
 146     return GetRand(nMax);
 147 }
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159 inline int OutputDebugStringF(const char* pszFormat, ...)
 160 {
 161     int ret = 0;
 162     if (fPrintToConsole)
 163     {
 164         // print to console
 165         va_list arg_ptr;
 166         va_start(arg_ptr, pszFormat);
 167         ret = vprintf(pszFormat, arg_ptr);
 168         va_end(arg_ptr);
 169     }
 170     else
 171     {
 172         // print to debug.log
 173         static FILE* fileout = NULL;
 174
 175         if (!fileout)
 176         {
 177             char pszFile[MAX_PATH+100];
 178             GetDataDir(pszFile);
 179             strlcat(pszFile, "/debug.log", sizeof(pszFile));
 180             fileout = fopen(pszFile, "a");
 181             if (fileout) setbuf(fileout, NULL); // unbuffered
 182         }
 183         if (fileout)
 184         {
 185             static bool fStartedNewLine = true;
 186
 187             // Debug print useful for profiling
 188             if (fLogTimestamps && fStartedNewLine)
 189                 fprintf(fileout, "%s ", DateTimeStrFormat("%x %H:%M:%S", GetTime()).c_str());
 190             if (pszFormat[strlen(pszFormat) - 1] == '\n')
 191                 fStartedNewLine = true;
 192             else
 193                 fStartedNewLine = false;
 194
 195             va_list arg_ptr;
 196             va_start(arg_ptr, pszFormat);
 197             ret = vfprintf(fileout, pszFormat, arg_ptr);
 198             va_end(arg_ptr);
 199         }
 200     }
 201
 202 #ifdef WIN32
 203     if (fPrintToDebugger)
 204     {
 205         static CCriticalSection cs_OutputDebugStringF;
 206
 207         // accumulate a line at a time
 208         CRITICAL_BLOCK(cs_OutputDebugStringF)
 209         {
 210             static char pszBuffer[50000];
 211             static char* pend;
 212             if (pend == NULL)
 213                 pend = pszBuffer;
 214             va_list arg_ptr;
 215             va_start(arg_ptr, pszFormat);
 216             int limit = END(pszBuffer) - pend - 2;
 217             int ret = _vsnprintf(pend, limit, pszFormat, arg_ptr);
 218             va_end(arg_ptr);
 219             if (ret < 0 || ret >= limit)
 220             {
 221                 pend = END(pszBuffer) - 2;
 222                 *pend++ = '\n';
 223             }
 224             else
 225                 pend += ret;
 226             *pend = '\0';
 227             char* p1 = pszBuffer;
 228             char* p2;
 229             while (p2 = strchr(p1, '\n'))
 230             {
 231                 p2++;
 232                 char c = *p2;
 233                 *p2 = '\0';
 234                 OutputDebugStringA(p1);
 235                 *p2 = c;
 236                 p1 = p2;
 237             }
 238             if (p1 != pszBuffer)
 239                 memmove(pszBuffer, p1, pend - p1 + 1);
 240             pend -= (p1 - pszBuffer);
 241         }
 242     }
 243 #endif
 244     return ret;
 245 }
 246
 247
 248 // Safer snprintf
 249 //  - prints up to limit-1 characters
 250 //  - output string is always null terminated even if limit reached
 251 //  - return value is the number of characters actually printed
 252 int my_snprintf(char* buffer, size_t limit, const char* format, ...)
 253 {
 254     if (limit == 0)
 255         return 0;
 256     va_list arg_ptr;
 257     va_start(arg_ptr, format);
 258     int ret = _vsnprintf(buffer, limit, format, arg_ptr);
 259     va_end(arg_ptr);
 260     if (ret < 0 || ret >= limit)
 261     {
 262         ret = limit - 1;
 263         buffer[limit-1] = 0;
 264     }
 265     return ret;
 266 }
 267
 268 string strprintf(const std::string &format, ...)
 269 {
 270     char buffer[50000];
 271     char* p = buffer;
 272     int limit = sizeof(buffer);
 273     int ret;
 274     loop
 275     {
 276         va_list arg_ptr;
 277         va_start(arg_ptr, format);
 278         ret = _vsnprintf(p, limit, format.c_str(), arg_ptr);
 279         va_end(arg_ptr);
 280         if (ret >= 0 && ret < limit)
 281             break;
 282         if (p != buffer)
 283             delete[] p;
 284         limit *= 2;
 285         p = new char[limit];
 286         if (p == NULL)
 287             throw std::bad_alloc();
 288     }
 289     string str(p, p+ret);
 290     if (p != buffer)
 291         delete[] p;
 292     return str;
 293 }
 294
 295 bool error(const std::string &format, ...)
 296 {
 297     char buffer[50000];
 298     int limit = sizeof(buffer);
 299     va_list arg_ptr;
 300     va_start(arg_ptr, format);
 301     int ret = _vsnprintf(buffer, limit, format.c_str(), arg_ptr);
 302     va_end(arg_ptr);
 303     if (ret < 0 || ret >= limit)
 304     {
 305         ret = limit - 1;
 306         buffer[limit-1] = 0;
 307     }
 308     printf("ERROR: %s\n", buffer);
 309     return false;
 310 }
 311
 312
 313 void ParseString(const string& str, char c, vector<string>& v)
 314 {
 315     if (str.empty())
 316         return;
 317     string::size_type i1 = 0;
 318     string::size_type i2;
 319     loop
 320     {
 321         i2 = str.find(c, i1);
 322         if (i2 == str.npos)
 323         {
 324             v.push_back(str.substr(i1));
 325             return;
 326         }
 327         v.push_back(str.substr(i1, i2-i1));
 328         i1 = i2+1;
 329     }
 330 }
 331
 332
 333 string FormatMoney(int64 n, bool fPlus)
 334 {
 335     // Note: not using straight sprintf here because we do NOT want
 336     // localized number formatting.
 337     int64 n_abs = (n > 0 ? n : -n);
 338     int64 quotient = n_abs/COIN;
 339     int64 remainder = n_abs%COIN;
 340     string str = strprintf("%"PRI64d".%08"PRI64d, quotient, remainder);
 341
 342     // Right-trim excess 0's before the decimal point:
 343     int nTrim = 0;
 344     for (int i = str.size()-1; (str[i] == '0' && isdigit(str[i-2])); --i)
 345         ++nTrim;
 346     if (nTrim)
 347         str.erase(str.size()-nTrim, nTrim);
 348
 349     if (n < 0)
 350         str.insert((unsigned int)0, 1, '-');
 351     else if (fPlus && n > 0)
 352         str.insert((unsigned int)0, 1, '+');
 353     return str;
 354 }
 355
 356
 357 bool ParseMoney(const string& str, int64& nRet)
 358 {
 359     return ParseMoney(str.c_str(), nRet);
 360 }
 361
 362 bool ParseMoney(const char* pszIn, int64& nRet)
 363 {
 364     string strWhole;
 365     int64 nUnits = 0;
 366     const char* p = pszIn;
 367     while (isspace(*p))
 368         p++;
 369     for (; *p; p++)
 370     {
 371         if (*p == '.')
 372         {
 373             p++;
 374             int64 nMult = CENT*10;
 375             while (isdigit(*p) && (nMult > 0))
 376             {
 377                 nUnits += nMult * (*p++ - '0');
 378                 nMult /= 10;
 379             }
 380             break;
 381         }
 382         if (isspace(*p))
 383             break;
 384         if (!isdigit(*p))
 385             return false;
 386         strWhole.insert(strWhole.end(), *p);
 387     }
 388     for (; *p; p++)
 389         if (!isspace(*p))
 390             return false;
 391     if (strWhole.size() > 10) // guard against 63 bit overflow
 392         return false;
 393     if (nUnits < 0 || nUnits > COIN)
 394         return false;
 395     int64 nWhole = atoi64(strWhole);
 396     int64 nValue = nWhole*COIN + nUnits;
 397
 398     nRet = nValue;
 399     return true;
 400 }
 401
 402
 403 static char phexdigit[256] =
 404 { -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 405   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 406   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 407   0,1,2,3,4,5,6,7,8,9,-1,-1,-1,-1,-1,-1,
 408   -1,0xa,0xb,0xc,0xd,0xe,0xf,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 409   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 410   -1,0xa,0xb,0xc,0xd,0xe,0xf,-1,-1,-1,-1,-1,-1,-1,-1,-1
 411   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 412   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 413   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 414   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 415   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 416   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 417   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 418   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 419   -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, };
 420
 421 bool IsHex(const string& str)
 422 {
 423     BOOST_FOREACH(unsigned char c, str)
 424     {
 425         if (phexdigit[c] < 0)
 426             return false;
 427     }
 428     return (str.size() > 0) && (str.size()%2 == 0);
 429 }
 430
 431 vector<unsigned char> ParseHex(const char* psz)
 432 {
 433     // convert hex dump to vector
 434     vector<unsigned char> vch;
 435     loop
 436     {
 437         while (isspace(*psz))
 438             psz++;
 439         char c = phexdigit[(unsigned char)*psz++];
 440         if (c == (char)-1)
 441             break;
 442         unsigned char n = (c << 4);
 443         c = phexdigit[(unsigned char)*psz++];
 444         if (c == (char)-1)
 445             break;
 446         n |= c;
 447         vch.push_back(n);
 448     }
 449     return vch;
 450 }
 451
 452 vector<unsigned char> ParseHex(const string& str)
 453 {
 454     return ParseHex(str.c_str());
 455 }
 456
 457 void ParseParameters(int argc, char* argv[])
 458 {
 459     mapArgs.clear();
 460     mapMultiArgs.clear();
 461     for (int i = 1; i < argc; i++)
 462     {
 463         char psz[10000];
 464         strlcpy(psz, argv[i], sizeof(psz));
 465         char* pszValue = (char*)"";
 466         if (strchr(psz, '='))
 467         {
 468             pszValue = strchr(psz, '=');
 469             *pszValue++ = '\0';
 470         }
 471         #ifdef WIN32
 472         _strlwr(psz);
 473         if (psz[0] == '/')
 474             psz[0] = '-';
 475         #endif
 476         if (psz[0] != '-')
 477             break;
 478         mapArgs[psz] = pszValue;
 479         mapMultiArgs[psz].push_back(pszValue);
 480     }
 481 }
 482
 483 bool SoftSetArg(const std::string& strArg, const std::string& strValue)
 484 {
 485     if (mapArgs.count(strArg))
 486         return false;
 487     mapArgs[strArg] = strValue;
 488     return true;
 489 }
 490
 491 bool SoftSetArg(const std::string& strArg, bool fValue)
 492 {
 493     if (fValue)
 494         return SoftSetArg(strArg, std::string("1"));
 495     else
 496         return SoftSetArg(strArg, std::string("0"));
 497 }
 498
 499
 500 string EncodeBase64(const unsigned char* pch, size_t len)
 501 {
 502     static const char *pbase64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 503
 504     string strRet="";
 505     strRet.reserve((len+2)/3*4);
 506
 507     int mode=0, left=0;
 508     const unsigned char *pchEnd = pch+len;
 509
 510     while (pch<pchEnd)
 511     {
 512         int enc = *(pch++);
 513         switch (mode)
 514         {
 515             case 0: // we have no bits
 516                 strRet += pbase64[enc >> 2];
 517                 left = (enc & 3) << 4;
 518                 mode = 1;
 519                 break;
 520
 521             case 1: // we have two bits
 522                 strRet += pbase64[left | (enc >> 4)];
 523                 left = (enc & 15) << 2;
 524                 mode = 2;
 525                 break;
 526
 527             case 2: // we have four bits
 528                 strRet += pbase64[left | (enc >> 6)];
 529                 strRet += pbase64[enc & 63];
 530                 mode = 0;
 531                 break;
 532         }
 533     }
 534
 535     if (mode)
 536     {
 537         strRet += pbase64[left];
 538         strRet += '=';
 539         if (mode == 1)
 540             strRet += '=';
 541     }
 542
 543     return strRet;
 544 }
 545
 546 string EncodeBase64(const string& str)
 547 {
 548     return EncodeBase64((const unsigned char*)str.c_str(), str.size());
 549 }
 550
 551 vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)
 552 {
 553     static const int decode64_table[256] =
 554     {
 555         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 556         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 557         -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1,
 558         -1, -1, -1, -1, -1,  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14,
 559         15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1, -1, 26, 27, 28,
 560         29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48,
 561         49, 50, 51, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 562         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 563         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 564         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 565         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 566         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 567         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
 568     };
 569
 570     if (pfInvalid)
 571         *pfInvalid = false;
 572
 573     vector<unsigned char> vchRet;
 574     vchRet.reserve(strlen(p)*3/4);
 575
 576     int mode = 0;
 577     int left = 0;
 578
 579     while (1)
 580     {
 581          int dec = decode64_table[*p];
 582          if (dec == -1) break;
 583          p++;
 584          switch (mode)
 585          {
 586              case 0: // we have no bits and get 6
 587                  left = dec;
 588                  mode = 1;
 589                  break;
 590
 591               case 1: // we have 6 bits and keep 4
 592                   vchRet.push_back((left<<2) | (dec>>4));
 593                   left = dec & 15;
 594                   mode = 2;
 595                   break;
 596
 597              case 2: // we have 4 bits and get 6, we keep 2
 598                  vchRet.push_back((left<<4) | (dec>>2));
 599                  left = dec & 3;
 600                  mode = 3;
 601                  break;
 602
 603              case 3: // we have 2 bits and get 6
 604                  vchRet.push_back((left<<6) | dec);
 605                  mode = 0;
 606                  break;
 607          }
 608     }
 609
 610     if (pfInvalid)
 611         switch (mode)
 612         {
 613             case 0: // 4n base64 characters processed: ok
 614                 break;
 615
 616             case 1: // 4n+1 base64 character processed: impossible
 617                 *pfInvalid = true;
 618                 break;
 619
 620             case 2: // 4n+2 base64 characters processed: require '=='
 621                 if (left || p[0] != '=' || p[1] != '=' || decode64_table[p[2]] != -1)
 622                     *pfInvalid = true;
 623                 break;
 624
 625             case 3: // 4n+3 base64 characters processed: require '='
 626                 if (left || p[0] != '=' || decode64_table[p[1]] != -1)
 627                     *pfInvalid = true;
 628                 break;
 629         }
 630
 631     return vchRet;
 632 }
 633
 634 string DecodeBase64(const string& str)
 635 {
 636     vector<unsigned char> vchRet = DecodeBase64(str.c_str());
 637     return string((const char*)&vchRet[0], vchRet.size());
 638 }
 639
 640
 641 bool WildcardMatch(const char* psz, const char* mask)
 642 {
 643     loop
 644     {
 645         switch (*mask)
 646         {
 647         case '\0':
 648             return (*psz == '\0');
 649         case '*':
 650             return WildcardMatch(psz, mask+1) || (*psz && WildcardMatch(psz+1, mask));
 651         case '?':
 652             if (*psz == '\0')
 653                 return false;
 654             break;
 655         default:
 656             if (*psz != *mask)
 657                 return false;
 658             break;
 659         }
 660         psz++;
 661         mask++;
 662     }
 663 }
 664
 665 bool WildcardMatch(const string& str, const string& mask)
 666 {
 667     return WildcardMatch(str.c_str(), mask.c_str());
 668 }
 669
 670
 671
 672
 673
 674
 675
 676
 677 void FormatException(char* pszMessage, std::exception* pex, const char* pszThread)
 678 {
 679 #ifdef WIN32
 680     char pszModule[MAX_PATH];
 681     pszModule[0] = '\0';
 682     GetModuleFileNameA(NULL, pszModule, sizeof(pszModule));
 683 #else
 684     const char* pszModule = "bitcoin";
 685 #endif
 686     if (pex)
 687         snprintf(pszMessage, 1000,
 688             "EXCEPTION: %s       \n%s       \n%s in %s       \n", typeid(*pex).name(), pex->what(), pszModule, pszThread);
 689     else
 690         snprintf(pszMessage, 1000,
 691             "UNKNOWN EXCEPTION       \n%s in %s       \n", pszModule, pszThread);
 692 }
 693
 694 void LogException(std::exception* pex, const char* pszThread)
 695 {
 696     char pszMessage[10000];
 697     FormatException(pszMessage, pex, pszThread);
 698     printf("\n%s", pszMessage);
 699 }
 700
 701 void PrintException(std::exception* pex, const char* pszThread)
 702 {
 703     char pszMessage[10000];
 704     FormatException(pszMessage, pex, pszThread);
 705     printf("\n\n************************\n%s\n", pszMessage);
 706     fprintf(stderr, "\n\n************************\n%s\n", pszMessage);
 707     strMiscWarning = pszMessage;
 708     throw;
 709 }
 710
 711 void ThreadOneMessageBox(string strMessage)
 712 {
 713     // Skip message boxes if one is already open
 714     static bool fMessageBoxOpen;
 715     if (fMessageBoxOpen)
 716         return;
 717     fMessageBoxOpen = true;
 718     ThreadSafeMessageBox(strMessage, "Bitcoin", wxOK | wxICON_EXCLAMATION);
 719     fMessageBoxOpen = false;
 720 }
 721
 722 void PrintExceptionContinue(std::exception* pex, const char* pszThread)
 723 {
 724     char pszMessage[10000];
 725     FormatException(pszMessage, pex, pszThread);
 726     printf("\n\n************************\n%s\n", pszMessage);
 727     fprintf(stderr, "\n\n************************\n%s\n", pszMessage);
 728     strMiscWarning = pszMessage;
 729 }
 730
 731
 732
 733
 734
 735
 736
 737
 738 #ifdef WIN32
 739 typedef WINSHELLAPI BOOL (WINAPI *PSHGETSPECIALFOLDERPATHA)(HWND hwndOwner, LPSTR lpszPath, int nFolder, BOOL fCreate);
 740
 741 string MyGetSpecialFolderPath(int nFolder, bool fCreate)
 742 {
 743     char pszPath[MAX_PATH+100] = "";
 744
 745     // SHGetSpecialFolderPath isn't always available on old Windows versions
 746     HMODULE hShell32 = LoadLibraryA("shell32.dll");
 747     if (hShell32)
 748     {
 749         PSHGETSPECIALFOLDERPATHA pSHGetSpecialFolderPath =
 750             (PSHGETSPECIALFOLDERPATHA)GetProcAddress(hShell32, "SHGetSpecialFolderPathA");
 751         if (pSHGetSpecialFolderPath)
 752             (*pSHGetSpecialFolderPath)(NULL, pszPath, nFolder, fCreate);
 753         FreeModule(hShell32);
 754     }
 755
 756     // Backup option
 757     if (pszPath[0] == '\0')
 758     {
 759         if (nFolder == CSIDL_STARTUP)
 760         {
 761             strcpy(pszPath, getenv("USERPROFILE"));
 762             strcat(pszPath, "\\Start Menu\\Programs\\Startup");
 763         }
 764         else if (nFolder == CSIDL_APPDATA)
 765         {
 766             strcpy(pszPath, getenv("APPDATA"));
 767         }
 768     }
 769
 770     return pszPath;
 771 }
 772 #endif
 773
 774 string GetDefaultDataDir()
 775 {
 776     // Windows: C:\Documents and Settings\username\Application Data\Bitcoin
 777     // Mac: ~/Library/Application Support/Bitcoin
 778     // Unix: ~/.bitcoin
 779 #ifdef WIN32
 780     // Windows
 781     return MyGetSpecialFolderPath(CSIDL_APPDATA, true) + "\\Bitcoin";
 782 #else
 783     char* pszHome = getenv("HOME");
 784     if (pszHome == NULL || strlen(pszHome) == 0)
 785         pszHome = (char*)"/";
 786     string strHome = pszHome;
 787     if (strHome[strHome.size()-1] != '/')
 788         strHome += '/';
 789 #ifdef MAC_OSX
 790     // Mac
 791     strHome += "Library/Application Support/";
 792     filesystem::create_directory(strHome.c_str());
 793     return strHome + "Bitcoin";
 794 #else
 795     // Unix
 796     return strHome + ".bitcoin";
 797 #endif
 798 #endif
 799 }
 800
 801 void GetDataDir(char* pszDir)
 802 {
 803     // pszDir must be at least MAX_PATH length.
 804     int nVariation;
 805     if (pszSetDataDir[0] != 0)
 806     {
 807         strlcpy(pszDir, pszSetDataDir, MAX_PATH);
 808         nVariation = 0;
 809     }
 810     else
 811     {
 812         // This can be called during exceptions by printf, so we cache the
 813         // value so we don't have to do memory allocations after that.
 814         static char pszCachedDir[MAX_PATH];
 815         if (pszCachedDir[0] == 0)
 816             strlcpy(pszCachedDir, GetDefaultDataDir().c_str(), sizeof(pszCachedDir));
 817         strlcpy(pszDir, pszCachedDir, MAX_PATH);
 818         nVariation = 1;
 819     }
 820     if (fTestNet)
 821     {
 822         char* p = pszDir + strlen(pszDir);
 823         if (p > pszDir && p[-1] != '/' && p[-1] != '\\')
 824             *p++ = '/';
 825         strcpy(p, "testnet");
 826         nVariation += 2;
 827     }
 828     static bool pfMkdir[4];
 829     if (!pfMkdir[nVariation])
 830     {
 831         pfMkdir[nVariation] = true;
 832         boost::filesystem::create_directory(pszDir);
 833     }
 834 }
 835
 836 string GetDataDir()
 837 {
 838     char pszDir[MAX_PATH];
 839     GetDataDir(pszDir);
 840     return pszDir;
 841 }
 842
 843 string GetConfigFile()
 844 {
 845     namespace fs = boost::filesystem;
 846     fs::path pathConfig(GetArg("-conf", "bitcoin.conf"));
 847     if (!pathConfig.is_complete())
 848         pathConfig = fs::path(GetDataDir()) / pathConfig;
 849     return pathConfig.string();
 850 }
 851
 852 void ReadConfigFile(map<string, string>& mapSettingsRet,
 853                     map<string, vector<string> >& mapMultiSettingsRet)
 854 {
 855     namespace fs = boost::filesystem;
 856     namespace pod = boost::program_options::detail;
 857
 858     fs::ifstream streamConfig(GetConfigFile());
 859     if (!streamConfig.good())
 860         return;
 861
 862     set<string> setOptions;
 863     setOptions.insert("*");
 864
 865     for (pod::config_file_iterator it(streamConfig, setOptions), end; it != end; ++it)
 866     {
 867         // Don't overwrite existing settings so command line settings override bitcoin.conf
 868         string strKey = string("-") + it->string_key;
 869         if (mapSettingsRet.count(strKey) == 0)
 870             mapSettingsRet[strKey] = it->value[0];
 871         mapMultiSettingsRet[strKey].push_back(it->value[0]);
 872     }
 873 }
 874
 875 string GetPidFile()
 876 {
 877     namespace fs = boost::filesystem;
 878     fs::path pathConfig(GetArg("-pid", "bitcoind.pid"));
 879     if (!pathConfig.is_complete())
 880         pathConfig = fs::path(GetDataDir()) / pathConfig;
 881     return pathConfig.string();
 882 }
 883
 884 void CreatePidFile(string pidFile, pid_t pid)
 885 {
 886     FILE* file = fopen(pidFile.c_str(), "w");
 887     if (file)
 888     {
 889         fprintf(file, "%d\n", pid);
 890         fclose(file);
 891     }
 892 }
 893
 894 int GetFilesize(FILE* file)
 895 {
 896     int nSavePos = ftell(file);
 897     int nFilesize = -1;
 898     if (fseek(file, 0, SEEK_END) == 0)
 899         nFilesize = ftell(file);
 900     fseek(file, nSavePos, SEEK_SET);
 901     return nFilesize;
 902 }
 903
 904 void ShrinkDebugFile()
 905 {
 906     // Scroll debug.log if it's getting too big
 907     string strFile = GetDataDir() + "/debug.log";
 908     FILE* file = fopen(strFile.c_str(), "r");
 909     if (file && GetFilesize(file) > 10 * 1000000)
 910     {
 911         // Restart the file with some of the end
 912         char pch[200000];
 913         fseek(file, -sizeof(pch), SEEK_END);
 914         int nBytes = fread(pch, 1, sizeof(pch), file);
 915         fclose(file);
 916
 917         file = fopen(strFile.c_str(), "w");
 918         if (file)
 919         {
 920             fwrite(pch, 1, nBytes, file);
 921             fclose(file);
 922         }
 923     }
 924 }
 925
 926
 927
 928
 929
 930
 931
 932
 933 //
 934 // "Never go to sea with two chronometers; take one or three."
 935 // Our three time sources are:
 936 //  - System clock
 937 //  - Median of other nodes's clocks
 938 //  - The user (asking the user to fix the system clock if the first two disagree)
 939 //
 940 static int64 nMockTime = 0;  // For unit testing
 941
 942 int64 GetTime()
 943 {
 944     if (nMockTime) return nMockTime;
 945
 946     return time(NULL);
 947 }
 948
 949 void SetMockTime(int64 nMockTimeIn)
 950 {
 951     nMockTime = nMockTimeIn;
 952 }
 953
 954 static int64 nTimeOffset = 0;
 955
 956 int64 GetAdjustedTime()
 957 {
 958     return GetTime() + nTimeOffset;
 959 }
 960
 961 void AddTimeData(const CNetAddr& ip, int64 nTime)
 962 {
 963     int64 nOffsetSample = nTime - GetTime();
 964
 965     // Ignore duplicates
 966     static set<CNetAddr> setKnown;
 967     if (!setKnown.insert(ip).second)
 968         return;
 969
 970     // Add data
 971     vTimeOffsets.input(nOffsetSample);
 972     printf("Added time data, samples %d, offset %+"PRI64d" (%+"PRI64d" minutes)\n", vTimeOffsets.size(), nOffsetSample, nOffsetSample/60);
 973     if (vTimeOffsets.size() >= 5 && vTimeOffsets.size() % 2 == 1)
 974     {
 975         int64 nMedian = vTimeOffsets.median();
 976         std::vector<int64> vSorted = vTimeOffsets.sorted();
 977         // Only let other nodes change our time by so much
 978         if (abs64(nMedian) < 70 * 60)
 979         {
 980             nTimeOffset = nMedian;
 981         }
 982         else
 983         {
 984             nTimeOffset = 0;
 985
 986             static bool fDone;
 987             if (!fDone)
 988             {
 989                 // If nobody has a time different than ours but within 5 minutes of ours, give a warning
 990                 bool fMatch = false;
 991                 BOOST_FOREACH(int64 nOffset, vSorted)
 992                     if (nOffset != 0 && abs64(nOffset) < 5 * 60)
 993                         fMatch = true;
 994
 995                 if (!fMatch)
 996                 {
 997                     fDone = true;
 998                     string strMessage = _("Warning: Please check that your computer's date and time are correct.  If your clock is wrong Bitcoin will not work properly.");
 999                     strMiscWarning = strMessage;
1000                     printf("*** %s\n", strMessage.c_str());
1001                     boost::thread(boost::bind(ThreadSafeMessageBox, strMessage+" ", string("Bitcoin"), wxOK | wxICON_EXCLAMATION, (wxWindow*)NULL, -1, -1));
1002                 }
1003             }
1004         }
1005         if (fDebug) {
1006             BOOST_FOREACH(int64 n, vSorted)
1007                 printf("%+"PRI64d"  ", n);
1008             printf("|  ");
1009         }
1010         printf("nTimeOffset = %+"PRI64d"  (%+"PRI64d" minutes)\n", nTimeOffset, nTimeOffset/60);
1011     }
1012 }
1013
1014
1015
1016
1017
1018
1019
1020
1021 string FormatVersion(int nVersion)
1022 {
1023     if (nVersion%100 == 0)
1024         return strprintf("%d.%d.%d", nVersion/1000000, (nVersion/10000)%100, (nVersion/100)%100);
1025     else
1026         return strprintf("%d.%d.%d.%d", nVersion/1000000, (nVersion/10000)%100, (nVersion/100)%100, nVersion%100);
1027 }
1028
1029 string FormatFullVersion()
1030 {
1031     string s = FormatVersion(CLIENT_VERSION);
1032     if (VERSION_IS_BETA) {
1033         s += "-";
1034         s += _("beta");
1035     }
1036     return s;
1037 }
1038
1039 // Format the subversion field according to BIP 14 spec (https://en.bitcoin.it/wiki/BIP_0014)
1040 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments)
1041 {
1042     std::ostringstream ss;
1043     ss << "/";
1044     ss << name << ":" << FormatVersion(nClientVersion);
1045     if (!comments.empty())
1046         ss << "(" << boost::algorithm::join(comments, "; ") << ")";
1047     ss << "/";
1048     return ss.str();
1049 }
1050
1051
1052
1053 #ifdef DEBUG_LOCKORDER
1054 //
1055 // Early deadlock detection.
1056 // Problem being solved:
1057 //    Thread 1 locks  A, then B, then C
1058 //    Thread 2 locks  D, then C, then A
1059 //     --> may result in deadlock between the two threads, depending on when they run.
1060 // Solution implemented here:
1061 // Keep track of pairs of locks: (A before B), (A before C), etc.
1062 // Complain if any thread trys to lock in a different order.
1063 //
1064
1065 struct CLockLocation
1066 {
1067     CLockLocation(const char* pszName, const char* pszFile, int nLine)
1068     {
1069         mutexName = pszName;
1070         sourceFile = pszFile;
1071         sourceLine = nLine;
1072     }
1073
1074     std::string ToString() const
1075     {
1076         return mutexName+"  "+sourceFile+":"+itostr(sourceLine);
1077     }
1078
1079 private:
1080     std::string mutexName;
1081     std::string sourceFile;
1082     int sourceLine;
1083 };
1084
1085 typedef std::vector< std::pair<CCriticalSection*, CLockLocation> > LockStack;
1086
1087 static boost::interprocess::interprocess_mutex dd_mutex;
1088 static std::map<std::pair<CCriticalSection*, CCriticalSection*>, LockStack> lockorders;
1089 static boost::thread_specific_ptr<LockStack> lockstack;
1090
1091
1092 static void potential_deadlock_detected(const std::pair<CCriticalSection*, CCriticalSection*>& mismatch, const LockStack& s1, const LockStack& s2)
1093 {
1094     printf("POTENTIAL DEADLOCK DETECTED\n");
1095     printf("Previous lock order was:\n");
1096     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, s2)
1097     {
1098         if (i.first == mismatch.first) printf(" (1)");
1099         if (i.first == mismatch.second) printf(" (2)");
1100         printf(" %s\n", i.second.ToString().c_str());
1101     }
1102     printf("Current lock order is:\n");
1103     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, s1)
1104     {
1105         if (i.first == mismatch.first) printf(" (1)");
1106         if (i.first == mismatch.second) printf(" (2)");
1107         printf(" %s\n", i.second.ToString().c_str());
1108     }
1109 }
1110
1111 static void push_lock(CCriticalSection* c, const CLockLocation& locklocation)
1112 {
1113     bool fOrderOK = true;
1114     if (lockstack.get() == NULL)
1115         lockstack.reset(new LockStack);
1116
1117     if (fDebug) printf("Locking: %s\n", locklocation.ToString().c_str());
1118     dd_mutex.lock();
1119
1120     (*lockstack).push_back(std::make_pair(c, locklocation));
1121
1122     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, (*lockstack))
1123     {
1124         if (i.first == c) break;
1125
1126         std::pair<CCriticalSection*, CCriticalSection*> p1 = std::make_pair(i.first, c);
1127         if (lockorders.count(p1))
1128             continue;
1129         lockorders[p1] = (*lockstack);
1130
1131         std::pair<CCriticalSection*, CCriticalSection*> p2 = std::make_pair(c, i.first);
1132         if (lockorders.count(p2))
1133         {
1134             potential_deadlock_detected(p1, lockorders[p2], lockorders[p1]);
1135             break;
1136         }
1137     }
1138     dd_mutex.unlock();
1139 }
1140
1141 static void pop_lock()
1142 {
1143     if (fDebug)
1144     {
1145         const CLockLocation& locklocation = (*lockstack).rbegin()->second;
1146         printf("Unlocked: %s\n", locklocation.ToString().c_str());
1147     }
1148     dd_mutex.lock();
1149     (*lockstack).pop_back();
1150     dd_mutex.unlock();
1151 }
1152
1153 void CCriticalSection::Enter(const char* pszName, const char* pszFile, int nLine)
1154 {
1155     push_lock(this, CLockLocation(pszName, pszFile, nLine));
1156     mutex.lock();
1157 }
1158 void CCriticalSection::Leave()
1159 {
1160     mutex.unlock();
1161     pop_lock();
1162 }
1163 bool CCriticalSection::TryEnter(const char* pszName, const char* pszFile, int nLine)
1164 {
1165     push_lock(this, CLockLocation(pszName, pszFile, nLine));
1166     bool result = mutex.try_lock();
1167     if (!result) pop_lock();
1168     return result;
1169 }
1170
1171 #else
1172
1173 void CCriticalSection::Enter(const char*, const char*, int)
1174 {
1175     mutex.lock();
1176 }
1177
1178 void CCriticalSection::Leave()
1179 {
1180     mutex.unlock();
1181 }
1182
1183 bool CCriticalSection::TryEnter(const char*, const char*, int)
1184 {
1185     bool result = mutex.try_lock();
1186     return result;
1187 }
1188
1189 #endif /* DEBUG_LOCKORDER */
1190