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