Replace tabs with four spaces to comply with coding standard in doc/coding.txt
[novacoin.git] / src / util.h
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 #ifndef BITCOIN_UTIL_H
6 #define BITCOIN_UTIL_H
7
8 #include "uint256.h"
9
10 #ifndef WIN32
11 #include <sys/types.h>
12 #include <sys/time.h>
13 #include <sys/resource.h>
14 #endif
15 #include <map>
16 #include <vector>
17 #include <string>
18
19 #include <boost/thread.hpp>
20 #include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
21 #include <boost/date_time/gregorian/gregorian_types.hpp>
22 #include <boost/date_time/posix_time/posix_time_types.hpp>
23
24 #include <openssl/sha.h>
25 #include <openssl/ripemd.h>
26
27 #include "netbase.h"
28
29 typedef long long  int64;
30 typedef unsigned long long  uint64;
31
32 #define loop                for (;;)
33 #define BEGIN(a)            ((char*)&(a))
34 #define END(a)              ((char*)&((&(a))[1]))
35 #define UBEGIN(a)           ((unsigned char*)&(a))
36 #define UEND(a)             ((unsigned char*)&((&(a))[1]))
37 #define ARRAYLEN(array)     (sizeof(array)/sizeof((array)[0]))
38 #define printf              OutputDebugStringF
39
40 #ifdef snprintf
41 #undef snprintf
42 #endif
43 #define snprintf my_snprintf
44
45 #ifndef PRI64d
46 #if defined(_MSC_VER) || defined(__MSVCRT__)
47 #define PRI64d  "I64d"
48 #define PRI64u  "I64u"
49 #define PRI64x  "I64x"
50 #else
51 #define PRI64d  "lld"
52 #define PRI64u  "llu"
53 #define PRI64x  "llx"
54 #endif
55 #endif
56
57 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
58 #define PAIRTYPE(t1, t2)    std::pair<t1, t2>
59
60 // Align by increasing pointer, must have extra space at end of buffer
61 template <size_t nBytes, typename T>
62 T* alignup(T* p)
63 {
64     union
65     {
66         T* ptr;
67         size_t n;
68     } u;
69     u.ptr = p;
70     u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
71     return u.ptr;
72 }
73
74 #ifdef WIN32
75 #define MSG_NOSIGNAL        0
76 #define MSG_DONTWAIT        0
77
78 #ifndef S_IRUSR
79 #define S_IRUSR             0400
80 #define S_IWUSR             0200
81 #endif
82 #define unlink              _unlink
83 #else
84 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
85 #define strlwr(psz)         to_lower(psz)
86 #define _strlwr(psz)        to_lower(psz)
87 #define MAX_PATH            1024
88 #define Beep(n1,n2)         (0)
89 inline void Sleep(int64 n)
90 {
91     boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n));
92 }
93 #endif
94
95 #if !defined(QT_GUI)
96 inline const char* _(const char* psz)
97 {
98     return psz;
99 }
100 #endif
101
102
103
104
105
106
107
108
109
110 extern std::map<std::string, std::string> mapArgs;
111 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
112 extern bool fDebug;
113 extern bool fPrintToConsole;
114 extern bool fPrintToDebugger;
115 extern char pszSetDataDir[MAX_PATH];
116 extern bool fRequestShutdown;
117 extern bool fShutdown;
118 extern bool fDaemon;
119 extern bool fServer;
120 extern bool fCommandLine;
121 extern std::string strMiscWarning;
122 extern bool fTestNet;
123 extern bool fNoListen;
124 extern bool fLogTimestamps;
125
126 void RandAddSeed();
127 void RandAddSeedPerfmon();
128 int OutputDebugStringF(const char* pszFormat, ...);
129 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
130 std::string strprintf(const std::string &format, ...);
131 bool error(const std::string &format, ...);
132 void LogException(std::exception* pex, const char* pszThread);
133 void PrintException(std::exception* pex, const char* pszThread);
134 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
135 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
136 std::string FormatMoney(int64 n, bool fPlus=false);
137 bool ParseMoney(const std::string& str, int64& nRet);
138 bool ParseMoney(const char* pszIn, int64& nRet);
139 std::vector<unsigned char> ParseHex(const char* psz);
140 std::vector<unsigned char> ParseHex(const std::string& str);
141 bool IsHex(const std::string& str);
142 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
143 std::string DecodeBase64(const std::string& str);
144 std::string EncodeBase64(const unsigned char* pch, size_t len);
145 std::string EncodeBase64(const std::string& str);
146 void ParseParameters(int argc, char* argv[]);
147 bool WildcardMatch(const char* psz, const char* mask);
148 bool WildcardMatch(const std::string& str, const std::string& mask);
149 int GetFilesize(FILE* file);
150 void GetDataDir(char* pszDirRet);
151 std::string GetConfigFile();
152 std::string GetPidFile();
153 void CreatePidFile(std::string pidFile, pid_t pid);
154 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
155 #ifdef WIN32
156 std::string MyGetSpecialFolderPath(int nFolder, bool fCreate);
157 #endif
158 std::string GetDefaultDataDir();
159 std::string GetDataDir();
160 void ShrinkDebugFile();
161 int GetRandInt(int nMax);
162 uint64 GetRand(uint64 nMax);
163 int64 GetTime();
164 void SetMockTime(int64 nMockTimeIn);
165 int64 GetAdjustedTime();
166 std::string FormatFullVersion();
167 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
168 void AddTimeData(const CNetAddr& ip, int64 nTime);
169
170
171
172
173
174
175
176
177
178
179
180
181 // Wrapper to automatically initialize mutex
182 class CCriticalSection
183 {
184 protected:
185     boost::interprocess::interprocess_recursive_mutex mutex;
186 public:
187     explicit CCriticalSection() { }
188     ~CCriticalSection() { }
189     void Enter(const char* pszName, const char* pszFile, int nLine);
190     void Leave();
191     bool TryEnter(const char* pszName, const char* pszFile, int nLine);
192 };
193
194 // Automatically leave critical section when leaving block, needed for exception safety
195 class CCriticalBlock
196 {
197 protected:
198     CCriticalSection* pcs;
199
200 public:
201     CCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
202     {
203         pcs = &csIn;
204         pcs->Enter(pszName, pszFile, nLine);
205     }
206
207     operator bool() const
208     {
209         return true;
210     }
211
212     ~CCriticalBlock()
213     {
214         pcs->Leave();
215     }
216 };
217
218 #define CRITICAL_BLOCK(cs)     \
219     if (CCriticalBlock criticalblock = CCriticalBlock(cs, #cs, __FILE__, __LINE__))
220
221 class CTryCriticalBlock
222 {
223 protected:
224     CCriticalSection* pcs;
225
226 public:
227     CTryCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
228     {
229         pcs = (csIn.TryEnter(pszName, pszFile, nLine) ? &csIn : NULL);
230     }
231
232     operator bool() const
233     {
234         return Entered();
235     }
236
237     ~CTryCriticalBlock()
238     {
239         if (pcs)
240         {
241             pcs->Leave();
242         }
243     }
244     bool Entered() const { return pcs != NULL; }
245 };
246
247 #define TRY_CRITICAL_BLOCK(cs)     \
248     if (CTryCriticalBlock criticalblock = CTryCriticalBlock(cs, #cs, __FILE__, __LINE__))
249
250
251
252
253
254
255 // This is exactly like std::string, but with a custom allocator.
256 // (secure_allocator<> is defined in serialize.h)
257 typedef std::basic_string<char, std::char_traits<char>, secure_allocator<char> > SecureString;
258
259
260
261
262
263 inline std::string i64tostr(int64 n)
264 {
265     return strprintf("%"PRI64d, n);
266 }
267
268 inline std::string itostr(int n)
269 {
270     return strprintf("%d", n);
271 }
272
273 inline int64 atoi64(const char* psz)
274 {
275 #ifdef _MSC_VER
276     return _atoi64(psz);
277 #else
278     return strtoll(psz, NULL, 10);
279 #endif
280 }
281
282 inline int64 atoi64(const std::string& str)
283 {
284 #ifdef _MSC_VER
285     return _atoi64(str.c_str());
286 #else
287     return strtoll(str.c_str(), NULL, 10);
288 #endif
289 }
290
291 inline int atoi(const std::string& str)
292 {
293     return atoi(str.c_str());
294 }
295
296 inline int roundint(double d)
297 {
298     return (int)(d > 0 ? d + 0.5 : d - 0.5);
299 }
300
301 inline int64 roundint64(double d)
302 {
303     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
304 }
305
306 inline int64 abs64(int64 n)
307 {
308     return (n >= 0 ? n : -n);
309 }
310
311 template<typename T>
312 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
313 {
314     if (itbegin == itend)
315         return "";
316     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
317     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
318     std::string str;
319     str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
320     for (const unsigned char* p = pbegin; p != pend; p++)
321         str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
322     return str;
323 }
324
325 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
326 {
327     return HexStr(vch.begin(), vch.end(), fSpaces);
328 }
329
330 template<typename T>
331 std::string HexNumStr(const T itbegin, const T itend, bool f0x=true)
332 {
333     if (itbegin == itend)
334         return "";
335     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
336     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
337     std::string str = (f0x ? "0x" : "");
338     str.reserve(str.size() + (pend-pbegin) * 2);
339     for (const unsigned char* p = pend-1; p >= pbegin; p--)
340         str += strprintf("%02x", *p);
341     return str;
342 }
343
344 inline std::string HexNumStr(const std::vector<unsigned char>& vch, bool f0x=true)
345 {
346     return HexNumStr(vch.begin(), vch.end(), f0x);
347 }
348
349 template<typename T>
350 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
351 {
352     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
353 }
354
355 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
356 {
357     printf(pszFormat, HexStr(vch, fSpaces).c_str());
358 }
359
360 inline int64 GetPerformanceCounter()
361 {
362     int64 nCounter = 0;
363 #ifdef WIN32
364     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
365 #else
366     timeval t;
367     gettimeofday(&t, NULL);
368     nCounter = t.tv_sec * 1000000 + t.tv_usec;
369 #endif
370     return nCounter;
371 }
372
373 inline int64 GetTimeMillis()
374 {
375     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
376             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
377 }
378
379 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
380 {
381     time_t n = nTime;
382     struct tm* ptmTime = gmtime(&n);
383     char pszTime[200];
384     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
385     return pszTime;
386 }
387
388 template<typename T>
389 void skipspaces(T& it)
390 {
391     while (isspace(*it))
392         ++it;
393 }
394
395 inline bool IsSwitchChar(char c)
396 {
397 #ifdef WIN32
398     return c == '-' || c == '/';
399 #else
400     return c == '-';
401 #endif
402 }
403
404 inline std::string GetArg(const std::string& strArg, const std::string& strDefault)
405 {
406     if (mapArgs.count(strArg))
407         return mapArgs[strArg];
408     return strDefault;
409 }
410
411 inline int64 GetArg(const std::string& strArg, int64 nDefault)
412 {
413     if (mapArgs.count(strArg))
414         return atoi64(mapArgs[strArg]);
415     return nDefault;
416 }
417
418 inline bool GetBoolArg(const std::string& strArg, bool fDefault=false)
419 {
420     if (mapArgs.count(strArg))
421     {
422         if (mapArgs[strArg].empty())
423             return true;
424         return (atoi(mapArgs[strArg]) != 0);
425     }
426     return fDefault;
427 }
428
429 /**
430  * Set an argument if it doesn't already have a value
431  *
432  * @param strArg Argument to set (e.g. "-foo")
433  * @param strValue Value (e.g. "1")
434  * @return true if argument gets set, false if it already had a value
435  */
436 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
437
438 /**
439  * Set a boolean argument if it doesn't already have a value
440  *
441  * @param strArg Argument to set (e.g. "-foo")
442  * @param fValue Value (e.g. false)
443  * @return true if argument gets set, false if it already had a value
444  */
445 bool SoftSetArg(const std::string& strArg, bool fValue);
446
447
448
449
450
451
452
453
454
455 // Randomize the stack to help protect against buffer overrun exploits
456 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn)     \
457     {                                           \
458         static char nLoops;                     \
459         if (nLoops <= 0)                        \
460             nLoops = GetRand(20) + 1;           \
461         if (nLoops-- > 1)                       \
462         {                                       \
463             ThreadFn;                           \
464             return;                             \
465         }                                       \
466     }
467
468 #define CATCH_PRINT_EXCEPTION(pszFn)     \
469     catch (std::exception& e) {          \
470         PrintException(&e, (pszFn));     \
471     } catch (...) {                      \
472         PrintException(NULL, (pszFn));   \
473     }
474
475
476
477
478
479
480
481
482
483
484 template<typename T1>
485 inline uint256 Hash(const T1 pbegin, const T1 pend)
486 {
487     static unsigned char pblank[1];
488     uint256 hash1;
489     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
490     uint256 hash2;
491     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
492     return hash2;
493 }
494
495 template<typename T1, typename T2>
496 inline uint256 Hash(const T1 p1begin, const T1 p1end,
497                     const T2 p2begin, const T2 p2end)
498 {
499     static unsigned char pblank[1];
500     uint256 hash1;
501     SHA256_CTX ctx;
502     SHA256_Init(&ctx);
503     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
504     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
505     SHA256_Final((unsigned char*)&hash1, &ctx);
506     uint256 hash2;
507     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
508     return hash2;
509 }
510
511 template<typename T1, typename T2, typename T3>
512 inline uint256 Hash(const T1 p1begin, const T1 p1end,
513                     const T2 p2begin, const T2 p2end,
514                     const T3 p3begin, const T3 p3end)
515 {
516     static unsigned char pblank[1];
517     uint256 hash1;
518     SHA256_CTX ctx;
519     SHA256_Init(&ctx);
520     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
521     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
522     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
523     SHA256_Final((unsigned char*)&hash1, &ctx);
524     uint256 hash2;
525     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
526     return hash2;
527 }
528
529 template<typename T>
530 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
531 {
532     // Most of the time is spent allocating and deallocating CDataStream's
533     // buffer.  If this ever needs to be optimized further, make a CStaticStream
534     // class with its buffer on the stack.
535     CDataStream ss(nType, nVersion);
536     ss.reserve(10000);
537     ss << obj;
538     return Hash(ss.begin(), ss.end());
539 }
540
541 inline uint160 Hash160(const std::vector<unsigned char>& vch)
542 {
543     uint256 hash1;
544     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
545     uint160 hash2;
546     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
547     return hash2;
548 }
549
550
551 // Median filter over a stream of values
552 // Returns the median of the last N numbers
553 template <typename T> class CMedianFilter
554 {
555 private:
556     std::vector<T> vValues;
557     std::vector<T> vSorted;
558     int nSize;
559 public:
560     CMedianFilter(int size, T initial_value):
561         nSize(size)
562     {
563         vValues.reserve(size);
564         vValues.push_back(initial_value);
565         vSorted = vValues;
566     }
567     
568     void input(T value)
569     {
570         if(vValues.size() == nSize)
571         {
572             vValues.erase(vValues.begin());
573         }
574         vValues.push_back(value);
575
576         vSorted.resize(vValues.size());
577         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
578         std::sort(vSorted.begin(), vSorted.end());
579     }
580
581     T median() const
582     {
583         int size = vSorted.size();
584         assert(size>0);
585         if(size & 1) // Odd number of elements
586         {
587             return vSorted[size/2];
588         }
589         else // Even number of elements
590         {
591             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
592         }
593     }
594
595     int size() const
596     {
597         return vValues.size();
598     }
599
600     std::vector<T> sorted () const
601     {
602         return vSorted;
603     }
604 };
605
606
607
608
609
610
611
612
613
614
615 // Note: It turns out we might have been able to use boost::thread
616 // by using TerminateThread(boost::thread.native_handle(), 0);
617 #ifdef WIN32
618 typedef HANDLE pthread_t;
619
620 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
621 {
622     DWORD nUnused = 0;
623     HANDLE hthread =
624         CreateThread(
625             NULL,                        // default security
626             0,                           // inherit stack size from parent
627             (LPTHREAD_START_ROUTINE)pfn, // function pointer
628             parg,                        // argument
629             0,                           // creation option, start immediately
630             &nUnused);                   // thread identifier
631     if (hthread == NULL)
632     {
633         printf("Error: CreateThread() returned %d\n", GetLastError());
634         return (pthread_t)0;
635     }
636     if (!fWantHandle)
637     {
638         CloseHandle(hthread);
639         return (pthread_t)-1;
640     }
641     return hthread;
642 }
643
644 inline void SetThreadPriority(int nPriority)
645 {
646     SetThreadPriority(GetCurrentThread(), nPriority);
647 }
648 #else
649 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
650 {
651     pthread_t hthread = 0;
652     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
653     if (ret != 0)
654     {
655         printf("Error: pthread_create() returned %d\n", ret);
656         return (pthread_t)0;
657     }
658     if (!fWantHandle)
659     {
660         pthread_detach(hthread);
661         return (pthread_t)-1;
662     }
663     return hthread;
664 }
665
666 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
667 #define THREAD_PRIORITY_BELOW_NORMAL    2
668 #define THREAD_PRIORITY_NORMAL          0
669 #define THREAD_PRIORITY_ABOVE_NORMAL    0
670
671 inline void SetThreadPriority(int nPriority)
672 {
673     // It's unclear if it's even possible to change thread priorities on Linux,
674     // but we really and truly need it for the generation threads.
675 #ifdef PRIO_THREAD
676     setpriority(PRIO_THREAD, 0, nPriority);
677 #else
678     setpriority(PRIO_PROCESS, 0, nPriority);
679 #endif
680 }
681
682 inline bool TerminateThread(pthread_t hthread, unsigned int nExitCode)
683 {
684     return (pthread_cancel(hthread) == 0);
685 }
686
687 inline void ExitThread(size_t nExitCode)
688 {
689     pthread_exit((void*)nExitCode);
690 }
691 #endif
692
693
694
695
696
697 inline bool AffinityBugWorkaround(void(*pfn)(void*))
698 {
699 #ifdef WIN32
700     // Sometimes after a few hours affinity gets stuck on one processor
701     DWORD_PTR dwProcessAffinityMask = -1;
702     DWORD_PTR dwSystemAffinityMask = -1;
703     GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
704     DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
705     DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
706     if (dwPrev2 != dwProcessAffinityMask)
707     {
708         printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
709         if (!CreateThread(pfn, NULL))
710             printf("Error: CreateThread() failed\n");
711         return true;
712     }
713 #endif
714     return false;
715 }
716
717 inline uint32_t ByteReverse(uint32_t value)
718 {
719     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
720     return (value<<16) | (value>>16);
721 }
722
723 #endif
724