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