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