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 vector<unsigned char> ParseHex(const char* psz)
 404 {
 405     static char phexdigit[256] =
 406     { -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 407       -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 408       -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 409       0,1,2,3,4,5,6,7,8,9,-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,0xa,0xb,0xc,0xd,0xe,0xf,-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       -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
 421       -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, };
 422
 423     // convert hex dump to vector
 424     vector<unsigned char> vch;
 425     loop
 426     {
 427         while (isspace(*psz))
 428             psz++;
 429         char c = phexdigit[(unsigned char)*psz++];
 430         if (c == (char)-1)
 431             break;
 432         unsigned char n = (c << 4);
 433         c = phexdigit[(unsigned char)*psz++];
 434         if (c == (char)-1)
 435             break;
 436         n |= c;
 437         vch.push_back(n);
 438     }
 439     return vch;
 440 }
 441
 442 vector<unsigned char> ParseHex(const string& str)
 443 {
 444     return ParseHex(str.c_str());
 445 }
 446
 447 void ParseParameters(int argc, char* argv[])
 448 {
 449     mapArgs.clear();
 450     mapMultiArgs.clear();
 451     for (int i = 1; i < argc; i++)
 452     {
 453         char psz[10000];
 454         strlcpy(psz, argv[i], sizeof(psz));
 455         char* pszValue = (char*)"";
 456         if (strchr(psz, '='))
 457         {
 458             pszValue = strchr(psz, '=');
 459             *pszValue++ = '\0';
 460         }
 461         #ifdef WIN32
 462         _strlwr(psz);
 463         if (psz[0] == '/')
 464             psz[0] = '-';
 465         #endif
 466         if (psz[0] != '-')
 467             break;
 468         mapArgs[psz] = pszValue;
 469         mapMultiArgs[psz].push_back(pszValue);
 470     }
 471 }
 472
 473 bool SoftSetArg(const std::string& strArg, const std::string& strValue)
 474 {
 475     if (mapArgs.count(strArg))
 476         return false;
 477     mapArgs[strArg] = strValue;
 478     return true;
 479 }
 480
 481 bool SoftSetArg(const std::string& strArg, bool fValue)
 482 {
 483     if (fValue)
 484         return SoftSetArg(strArg, std::string("1"));
 485     else
 486         return SoftSetArg(strArg, std::string("0"));
 487 }
 488
 489
 490 string EncodeBase64(const unsigned char* pch, size_t len)
 491 {
 492     static const char *pbase64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 493
 494     string strRet="";
 495     strRet.reserve((len+2)/3*4);
 496
 497     int mode=0, left=0;
 498     const unsigned char *pchEnd = pch+len;
 499
 500     while (pch<pchEnd)
 501     {
 502         int enc = *(pch++);
 503         switch (mode)
 504         {
 505             case 0: // we have no bits
 506                 strRet += pbase64[enc >> 2];
 507                 left = (enc & 3) << 4;
 508                 mode = 1;
 509                 break;
 510
 511             case 1: // we have two bits
 512                 strRet += pbase64[left | (enc >> 4)];
 513                 left = (enc & 15) << 2;
 514                 mode = 2;
 515                 break;
 516
 517             case 2: // we have four bits
 518                 strRet += pbase64[left | (enc >> 6)];
 519                 strRet += pbase64[enc & 63];
 520                 mode = 0;
 521                 break;
 522         }
 523     }
 524
 525     if (mode)
 526     {
 527         strRet += pbase64[left];
 528         strRet += '=';
 529         if (mode == 1)
 530             strRet += '=';
 531     }
 532
 533     return strRet;
 534 }
 535
 536 string EncodeBase64(const string& str)
 537 {
 538     return EncodeBase64((const unsigned char*)str.c_str(), str.size());
 539 }
 540
 541 vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)
 542 {
 543     static const int decode64_table[256] =
 544     {
 545         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 546         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 547         -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1,
 548         -1, -1, -1, -1, -1,  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14,
 549         15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1, -1, 26, 27, 28,
 550         29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48,
 551         49, 50, 51, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 552         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 553         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 554         -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
 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, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
 558     };
 559
 560     if (pfInvalid)
 561         *pfInvalid = false;
 562
 563     vector<unsigned char> vchRet;
 564     vchRet.reserve(strlen(p)*3/4);
 565
 566     int mode = 0;
 567     int left = 0;
 568
 569     while (1)
 570     {
 571          int dec = decode64_table[*p];
 572          if (dec == -1) break;
 573          p++;
 574          switch (mode)
 575          {
 576              case 0: // we have no bits and get 6
 577                  left = dec;
 578                  mode = 1;
 579                  break;
 580
 581               case 1: // we have 6 bits and keep 4
 582                   vchRet.push_back((left<<2) | (dec>>4));
 583                   left = dec & 15;
 584                   mode = 2;
 585                   break;
 586
 587              case 2: // we have 4 bits and get 6, we keep 2
 588                  vchRet.push_back((left<<4) | (dec>>2));
 589                  left = dec & 3;
 590                  mode = 3;
 591                  break;
 592
 593              case 3: // we have 2 bits and get 6
 594                  vchRet.push_back((left<<6) | dec);
 595                  mode = 0;
 596                  break;
 597          }
 598     }
 599
 600     if (pfInvalid)
 601         switch (mode)
 602         {
 603             case 0: // 4n base64 characters processed: ok
 604                 break;
 605
 606             case 1: // 4n+1 base64 character processed: impossible
 607                 *pfInvalid = true;
 608                 break;
 609
 610             case 2: // 4n+2 base64 characters processed: require '=='
 611                 if (left || p[0] != '=' || p[1] != '=' || decode64_table[p[2]] != -1)
 612                     *pfInvalid = true;
 613                 break;
 614
 615             case 3: // 4n+3 base64 characters processed: require '='
 616                 if (left || p[0] != '=' || decode64_table[p[1]] != -1)
 617                     *pfInvalid = true;
 618                 break;
 619         }
 620
 621     return vchRet;
 622 }
 623
 624 string DecodeBase64(const string& str)
 625 {
 626     vector<unsigned char> vchRet = DecodeBase64(str.c_str());
 627     return string((const char*)&vchRet[0], vchRet.size());
 628 }
 629
 630
 631 bool WildcardMatch(const char* psz, const char* mask)
 632 {
 633     loop
 634     {
 635         switch (*mask)
 636         {
 637         case '\0':
 638             return (*psz == '\0');
 639         case '*':
 640             return WildcardMatch(psz, mask+1) || (*psz && WildcardMatch(psz+1, mask));
 641         case '?':
 642             if (*psz == '\0')
 643                 return false;
 644             break;
 645         default:
 646             if (*psz != *mask)
 647                 return false;
 648             break;
 649         }
 650         psz++;
 651         mask++;
 652     }
 653 }
 654
 655 bool WildcardMatch(const string& str, const string& mask)
 656 {
 657     return WildcardMatch(str.c_str(), mask.c_str());
 658 }
 659
 660
 661
 662
 663
 664
 665
 666
 667 void FormatException(char* pszMessage, std::exception* pex, const char* pszThread)
 668 {
 669 #ifdef WIN32
 670     char pszModule[MAX_PATH];
 671     pszModule[0] = '\0';
 672     GetModuleFileNameA(NULL, pszModule, sizeof(pszModule));
 673 #else
 674     const char* pszModule = "bitcoin";
 675 #endif
 676     if (pex)
 677         snprintf(pszMessage, 1000,
 678             "EXCEPTION: %s       \n%s       \n%s in %s       \n", typeid(*pex).name(), pex->what(), pszModule, pszThread);
 679     else
 680         snprintf(pszMessage, 1000,
 681             "UNKNOWN EXCEPTION       \n%s in %s       \n", pszModule, pszThread);
 682 }
 683
 684 void LogException(std::exception* pex, const char* pszThread)
 685 {
 686     char pszMessage[10000];
 687     FormatException(pszMessage, pex, pszThread);
 688     printf("\n%s", pszMessage);
 689 }
 690
 691 void PrintException(std::exception* pex, const char* pszThread)
 692 {
 693     char pszMessage[10000];
 694     FormatException(pszMessage, pex, pszThread);
 695     printf("\n\n************************\n%s\n", pszMessage);
 696     fprintf(stderr, "\n\n************************\n%s\n", pszMessage);
 697     strMiscWarning = pszMessage;
 698     throw;
 699 }
 700
 701 void ThreadOneMessageBox(string strMessage)
 702 {
 703     // Skip message boxes if one is already open
 704     static bool fMessageBoxOpen;
 705     if (fMessageBoxOpen)
 706         return;
 707     fMessageBoxOpen = true;
 708     ThreadSafeMessageBox(strMessage, "Bitcoin", wxOK | wxICON_EXCLAMATION);
 709     fMessageBoxOpen = false;
 710 }
 711
 712 void PrintExceptionContinue(std::exception* pex, const char* pszThread)
 713 {
 714     char pszMessage[10000];
 715     FormatException(pszMessage, pex, pszThread);
 716     printf("\n\n************************\n%s\n", pszMessage);
 717     fprintf(stderr, "\n\n************************\n%s\n", pszMessage);
 718     strMiscWarning = pszMessage;
 719 }
 720
 721
 722
 723
 724
 725
 726
 727
 728 #ifdef WIN32
 729 typedef WINSHELLAPI BOOL (WINAPI *PSHGETSPECIALFOLDERPATHA)(HWND hwndOwner, LPSTR lpszPath, int nFolder, BOOL fCreate);
 730
 731 string MyGetSpecialFolderPath(int nFolder, bool fCreate)
 732 {
 733     char pszPath[MAX_PATH+100] = "";
 734
 735     // SHGetSpecialFolderPath isn't always available on old Windows versions
 736     HMODULE hShell32 = LoadLibraryA("shell32.dll");
 737     if (hShell32)
 738     {
 739         PSHGETSPECIALFOLDERPATHA pSHGetSpecialFolderPath =
 740             (PSHGETSPECIALFOLDERPATHA)GetProcAddress(hShell32, "SHGetSpecialFolderPathA");
 741         if (pSHGetSpecialFolderPath)
 742             (*pSHGetSpecialFolderPath)(NULL, pszPath, nFolder, fCreate);
 743         FreeModule(hShell32);
 744     }
 745
 746     // Backup option
 747     if (pszPath[0] == '\0')
 748     {
 749         if (nFolder == CSIDL_STARTUP)
 750         {
 751             strcpy(pszPath, getenv("USERPROFILE"));
 752             strcat(pszPath, "\\Start Menu\\Programs\\Startup");
 753         }
 754         else if (nFolder == CSIDL_APPDATA)
 755         {
 756             strcpy(pszPath, getenv("APPDATA"));
 757         }
 758     }
 759
 760     return pszPath;
 761 }
 762 #endif
 763
 764 string GetDefaultDataDir()
 765 {
 766     // Windows: C:\Documents and Settings\username\Application Data\Bitcoin
 767     // Mac: ~/Library/Application Support/Bitcoin
 768     // Unix: ~/.bitcoin
 769 #ifdef WIN32
 770     // Windows
 771     return MyGetSpecialFolderPath(CSIDL_APPDATA, true) + "\\Bitcoin";
 772 #else
 773     char* pszHome = getenv("HOME");
 774     if (pszHome == NULL || strlen(pszHome) == 0)
 775         pszHome = (char*)"/";
 776     string strHome = pszHome;
 777     if (strHome[strHome.size()-1] != '/')
 778         strHome += '/';
 779 #ifdef MAC_OSX
 780     // Mac
 781     strHome += "Library/Application Support/";
 782     filesystem::create_directory(strHome.c_str());
 783     return strHome + "Bitcoin";
 784 #else
 785     // Unix
 786     return strHome + ".bitcoin";
 787 #endif
 788 #endif
 789 }
 790
 791 void GetDataDir(char* pszDir)
 792 {
 793     // pszDir must be at least MAX_PATH length.
 794     int nVariation;
 795     if (pszSetDataDir[0] != 0)
 796     {
 797         strlcpy(pszDir, pszSetDataDir, MAX_PATH);
 798         nVariation = 0;
 799     }
 800     else
 801     {
 802         // This can be called during exceptions by printf, so we cache the
 803         // value so we don't have to do memory allocations after that.
 804         static char pszCachedDir[MAX_PATH];
 805         if (pszCachedDir[0] == 0)
 806             strlcpy(pszCachedDir, GetDefaultDataDir().c_str(), sizeof(pszCachedDir));
 807         strlcpy(pszDir, pszCachedDir, MAX_PATH);
 808         nVariation = 1;
 809     }
 810     if (fTestNet)
 811     {
 812         char* p = pszDir + strlen(pszDir);
 813         if (p > pszDir && p[-1] != '/' && p[-1] != '\\')
 814             *p++ = '/';
 815         strcpy(p, "testnet");
 816         nVariation += 2;
 817     }
 818     static bool pfMkdir[4];
 819     if (!pfMkdir[nVariation])
 820     {
 821         pfMkdir[nVariation] = true;
 822         boost::filesystem::create_directory(pszDir);
 823     }
 824 }
 825
 826 string GetDataDir()
 827 {
 828     char pszDir[MAX_PATH];
 829     GetDataDir(pszDir);
 830     return pszDir;
 831 }
 832
 833 string GetConfigFile()
 834 {
 835     namespace fs = boost::filesystem;
 836     fs::path pathConfig(GetArg("-conf", "bitcoin.conf"));
 837     if (!pathConfig.is_complete())
 838         pathConfig = fs::path(GetDataDir()) / pathConfig;
 839     return pathConfig.string();
 840 }
 841
 842 void ReadConfigFile(map<string, string>& mapSettingsRet,
 843                     map<string, vector<string> >& mapMultiSettingsRet)
 844 {
 845     namespace fs = boost::filesystem;
 846     namespace pod = boost::program_options::detail;
 847
 848     fs::ifstream streamConfig(GetConfigFile());
 849     if (!streamConfig.good())
 850         return;
 851
 852     set<string> setOptions;
 853     setOptions.insert("*");
 854
 855     for (pod::config_file_iterator it(streamConfig, setOptions), end; it != end; ++it)
 856     {
 857         // Don't overwrite existing settings so command line settings override bitcoin.conf
 858         string strKey = string("-") + it->string_key;
 859         if (mapSettingsRet.count(strKey) == 0)
 860             mapSettingsRet[strKey] = it->value[0];
 861         mapMultiSettingsRet[strKey].push_back(it->value[0]);
 862     }
 863 }
 864
 865 string GetPidFile()
 866 {
 867     namespace fs = boost::filesystem;
 868     fs::path pathConfig(GetArg("-pid", "bitcoind.pid"));
 869     if (!pathConfig.is_complete())
 870         pathConfig = fs::path(GetDataDir()) / pathConfig;
 871     return pathConfig.string();
 872 }
 873
 874 void CreatePidFile(string pidFile, pid_t pid)
 875 {
 876     FILE* file = fopen(pidFile.c_str(), "w");
 877     if (file)
 878     {
 879         fprintf(file, "%d\n", pid);
 880         fclose(file);
 881     }
 882 }
 883
 884 int GetFilesize(FILE* file)
 885 {
 886     int nSavePos = ftell(file);
 887     int nFilesize = -1;
 888     if (fseek(file, 0, SEEK_END) == 0)
 889         nFilesize = ftell(file);
 890     fseek(file, nSavePos, SEEK_SET);
 891     return nFilesize;
 892 }
 893
 894 void ShrinkDebugFile()
 895 {
 896     // Scroll debug.log if it's getting too big
 897     string strFile = GetDataDir() + "/debug.log";
 898     FILE* file = fopen(strFile.c_str(), "r");
 899     if (file && GetFilesize(file) > 10 * 1000000)
 900     {
 901         // Restart the file with some of the end
 902         char pch[200000];
 903         fseek(file, -sizeof(pch), SEEK_END);
 904         int nBytes = fread(pch, 1, sizeof(pch), file);
 905         fclose(file);
 906
 907         file = fopen(strFile.c_str(), "w");
 908         if (file)
 909         {
 910             fwrite(pch, 1, nBytes, file);
 911             fclose(file);
 912         }
 913     }
 914 }
 915
 916
 917
 918
 919
 920
 921
 922
 923 //
 924 // "Never go to sea with two chronometers; take one or three."
 925 // Our three time sources are:
 926 //  - System clock
 927 //  - Median of other nodes's clocks
 928 //  - The user (asking the user to fix the system clock if the first two disagree)
 929 //
 930 static int64 nMockTime = 0;  // For unit testing
 931
 932 int64 GetTime()
 933 {
 934     if (nMockTime) return nMockTime;
 935
 936     return time(NULL);
 937 }
 938
 939 void SetMockTime(int64 nMockTimeIn)
 940 {
 941     nMockTime = nMockTimeIn;
 942 }
 943
 944 static int64 nTimeOffset = 0;
 945
 946 int64 GetAdjustedTime()
 947 {
 948     return GetTime() + nTimeOffset;
 949 }
 950
 951 void AddTimeData(const CNetAddr& ip, int64 nTime)
 952 {
 953     int64 nOffsetSample = nTime - GetTime();
 954
 955     // Ignore duplicates
 956     static set<CNetAddr> setKnown;
 957     if (!setKnown.insert(ip).second)
 958         return;
 959
 960     // Add data
 961     vTimeOffsets.input(nOffsetSample);
 962     printf("Added time data, samples %d, offset %+"PRI64d" (%+"PRI64d" minutes)\n", vTimeOffsets.size(), nOffsetSample, nOffsetSample/60);
 963     if (vTimeOffsets.size() >= 5 && vTimeOffsets.size() % 2 == 1)
 964     {
 965         int64 nMedian = vTimeOffsets.median();
 966         std::vector<int64> vSorted = vTimeOffsets.sorted();
 967         // Only let other nodes change our time by so much
 968         if (abs64(nMedian) < 70 * 60)
 969         {
 970             nTimeOffset = nMedian;
 971         }
 972         else
 973         {
 974             nTimeOffset = 0;
 975
 976             static bool fDone;
 977             if (!fDone)
 978             {
 979                 // If nobody has a time different than ours but within 5 minutes of ours, give a warning
 980                 bool fMatch = false;
 981                 BOOST_FOREACH(int64 nOffset, vSorted)
 982                     if (nOffset != 0 && abs64(nOffset) < 5 * 60)
 983                         fMatch = true;
 984
 985                 if (!fMatch)
 986                 {
 987                     fDone = true;
 988                     string strMessage = _("Warning: Please check that your computer's date and time are correct.  If your clock is wrong Bitcoin will not work properly.");
 989                     strMiscWarning = strMessage;
 990                     printf("*** %s\n", strMessage.c_str());
 991                     boost::thread(boost::bind(ThreadSafeMessageBox, strMessage+" ", string("Bitcoin"), wxOK | wxICON_EXCLAMATION, (wxWindow*)NULL, -1, -1));
 992                 }
 993             }
 994         }
 995         if (fDebug) {
 996             BOOST_FOREACH(int64 n, vSorted)
 997                 printf("%+"PRI64d"  ", n);
 998             printf("|  ");
 999         }
1000         printf("nTimeOffset = %+"PRI64d"  (%+"PRI64d" minutes)\n", nTimeOffset, nTimeOffset/60);
1001     }
1002 }
1003
1004
1005
1006
1007
1008
1009
1010
1011 string FormatVersion(int nVersion)
1012 {
1013     if (nVersion%100 == 0)
1014         return strprintf("%d.%d.%d", nVersion/1000000, (nVersion/10000)%100, (nVersion/100)%100);
1015     else
1016         return strprintf("%d.%d.%d.%d", nVersion/1000000, (nVersion/10000)%100, (nVersion/100)%100, nVersion%100);
1017 }
1018
1019 string FormatFullVersion()
1020 {
1021     string s = FormatVersion(CLIENT_VERSION);
1022     if (VERSION_IS_BETA) {
1023         s += "-";
1024         s += _("beta");
1025     }
1026     return s;
1027 }
1028
1029 // Format the subversion field according to BIP 14 spec (https://en.bitcoin.it/wiki/BIP_0014)
1030 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments)
1031 {
1032     std::ostringstream ss;
1033     ss << "/";
1034     ss << name << ":" << FormatVersion(nClientVersion);
1035     if (!comments.empty())
1036         ss << "(" << boost::algorithm::join(comments, "; ") << ")";
1037     ss << "/";
1038     return ss.str();
1039 }
1040
1041
1042
1043 #ifdef DEBUG_LOCKORDER
1044 //
1045 // Early deadlock detection.
1046 // Problem being solved:
1047 //    Thread 1 locks  A, then B, then C
1048 //    Thread 2 locks  D, then C, then A
1049 //     --> may result in deadlock between the two threads, depending on when they run.
1050 // Solution implemented here:
1051 // Keep track of pairs of locks: (A before B), (A before C), etc.
1052 // Complain if any thread trys to lock in a different order.
1053 //
1054
1055 struct CLockLocation
1056 {
1057     CLockLocation(const char* pszName, const char* pszFile, int nLine)
1058     {
1059         mutexName = pszName;
1060         sourceFile = pszFile;
1061         sourceLine = nLine;
1062     }
1063
1064     std::string ToString() const
1065     {
1066         return mutexName+"  "+sourceFile+":"+itostr(sourceLine);
1067     }
1068
1069 private:
1070     std::string mutexName;
1071     std::string sourceFile;
1072     int sourceLine;
1073 };
1074
1075 typedef std::vector< std::pair<CCriticalSection*, CLockLocation> > LockStack;
1076
1077 static boost::interprocess::interprocess_mutex dd_mutex;
1078 static std::map<std::pair<CCriticalSection*, CCriticalSection*>, LockStack> lockorders;
1079 static boost::thread_specific_ptr<LockStack> lockstack;
1080
1081
1082 static void potential_deadlock_detected(const std::pair<CCriticalSection*, CCriticalSection*>& mismatch, const LockStack& s1, const LockStack& s2)
1083 {
1084     printf("POTENTIAL DEADLOCK DETECTED\n");
1085     printf("Previous lock order was:\n");
1086     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, s2)
1087     {
1088         if (i.first == mismatch.first) printf(" (1)");
1089         if (i.first == mismatch.second) printf(" (2)");
1090         printf(" %s\n", i.second.ToString().c_str());
1091     }
1092     printf("Current lock order is:\n");
1093     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, s1)
1094     {
1095         if (i.first == mismatch.first) printf(" (1)");
1096         if (i.first == mismatch.second) printf(" (2)");
1097         printf(" %s\n", i.second.ToString().c_str());
1098     }
1099 }
1100
1101 static void push_lock(CCriticalSection* c, const CLockLocation& locklocation)
1102 {
1103     bool fOrderOK = true;
1104     if (lockstack.get() == NULL)
1105         lockstack.reset(new LockStack);
1106
1107     if (fDebug) printf("Locking: %s\n", locklocation.ToString().c_str());
1108     dd_mutex.lock();
1109
1110     (*lockstack).push_back(std::make_pair(c, locklocation));
1111
1112     BOOST_FOREACH(const PAIRTYPE(CCriticalSection*, CLockLocation)& i, (*lockstack))
1113     {
1114         if (i.first == c) break;
1115
1116         std::pair<CCriticalSection*, CCriticalSection*> p1 = std::make_pair(i.first, c);
1117         if (lockorders.count(p1))
1118             continue;
1119         lockorders[p1] = (*lockstack);
1120
1121         std::pair<CCriticalSection*, CCriticalSection*> p2 = std::make_pair(c, i.first);
1122         if (lockorders.count(p2))
1123         {
1124             potential_deadlock_detected(p1, lockorders[p2], lockorders[p1]);
1125             break;
1126         }
1127     }
1128     dd_mutex.unlock();
1129 }
1130
1131 static void pop_lock()
1132 {
1133     if (fDebug)
1134     {
1135         const CLockLocation& locklocation = (*lockstack).rbegin()->second;
1136         printf("Unlocked: %s\n", locklocation.ToString().c_str());
1137     }
1138     dd_mutex.lock();
1139     (*lockstack).pop_back();
1140     dd_mutex.unlock();
1141 }
1142
1143 void CCriticalSection::Enter(const char* pszName, const char* pszFile, int nLine)
1144 {
1145     push_lock(this, CLockLocation(pszName, pszFile, nLine));
1146     mutex.lock();
1147 }
1148 void CCriticalSection::Leave()
1149 {
1150     mutex.unlock();
1151     pop_lock();
1152 }
1153 bool CCriticalSection::TryEnter(const char* pszName, const char* pszFile, int nLine)
1154 {
1155     push_lock(this, CLockLocation(pszName, pszFile, nLine));
1156     bool result = mutex.try_lock();
1157     if (!result) pop_lock();
1158     return result;
1159 }
1160
1161 #else
1162
1163 void CCriticalSection::Enter(const char*, const char*, int)
1164 {
1165     mutex.lock();
1166 }
1167
1168 void CCriticalSection::Leave()
1169 {
1170     mutex.unlock();
1171 }
1172
1173 bool CCriticalSection::TryEnter(const char*, const char*, int)
1174 {
1175     bool result = mutex.try_lock();
1176     return result;
1177 }
1178
1179 #endif /* DEBUG_LOCKORDER */
1180