Cleaned up the critical section macros.
[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
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 // 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 WIN32
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::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n));
119 }
120 #endif
121
122 inline int myclosesocket(SOCKET& hSocket)
123 {
124     if (hSocket == INVALID_SOCKET)
125         return WSAENOTSOCK;
126 #ifdef WIN32
127     int ret = closesocket(hSocket);
128 #else
129     int ret = close(hSocket);
130 #endif
131     hSocket = INVALID_SOCKET;
132     return ret;
133 }
134 #define closesocket(s)      myclosesocket(s)
135 #if !defined(QT_GUI)
136 inline const char* _(const char* psz)
137 {
138     return psz;
139 }
140 #endif
141
142
143
144
145
146
147
148
149
150 extern std::map<std::string, std::string> mapArgs;
151 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
152 extern bool fDebug;
153 extern bool fPrintToConsole;
154 extern bool fPrintToDebugger;
155 extern char pszSetDataDir[MAX_PATH];
156 extern bool fRequestShutdown;
157 extern bool fShutdown;
158 extern bool fDaemon;
159 extern bool fServer;
160 extern bool fCommandLine;
161 extern std::string strMiscWarning;
162 extern bool fTestNet;
163 extern bool fNoListen;
164 extern bool fLogTimestamps;
165
166 void RandAddSeed();
167 void RandAddSeedPerfmon();
168 int OutputDebugStringF(const char* pszFormat, ...);
169 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
170 std::string strprintf(const std::string &format, ...);
171 bool error(const std::string &format, ...);
172 void LogException(std::exception* pex, const char* pszThread);
173 void PrintException(std::exception* pex, const char* pszThread);
174 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
175 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
176 std::string FormatMoney(int64 n, bool fPlus=false);
177 bool ParseMoney(const std::string& str, int64& nRet);
178 bool ParseMoney(const char* pszIn, int64& nRet);
179 std::vector<unsigned char> ParseHex(const char* psz);
180 std::vector<unsigned char> ParseHex(const std::string& str);
181 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
182 std::string DecodeBase64(const std::string& str);
183 std::string EncodeBase64(const unsigned char* pch, size_t len);
184 std::string EncodeBase64(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 WIN32
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 void SetMockTime(int64 nMockTimeIn);
205 int64 GetAdjustedTime();
206 void AddTimeData(unsigned int ip, int64 nTime);
207 std::string FormatFullVersion();
208
209
210
211
212
213
214
215
216
217
218
219
220
221 // Wrapper to automatically initialize mutex
222 class CCriticalSection
223 {
224 protected:
225     boost::interprocess::interprocess_recursive_mutex mutex;
226 public:
227     explicit CCriticalSection() { }
228     ~CCriticalSection() { }
229     void Enter(const char* pszName, const char* pszFile, int nLine);
230     void Leave();
231     bool TryEnter(const char* pszName, const char* pszFile, int nLine);
232 };
233
234 // Automatically leave critical section when leaving block, needed for exception safety
235 class CCriticalBlock
236 {
237 protected:
238     CCriticalSection* pcs;
239
240 public:
241     CCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
242     {
243         pcs = &csIn;
244         pcs->Enter(pszName, pszFile, nLine);
245     }
246
247     operator bool() const
248     {
249         return true;
250     }
251
252     ~CCriticalBlock()
253     {
254         pcs->Leave();
255     }
256 };
257
258 #define CRITICAL_BLOCK(cs)     \
259     if (CCriticalBlock criticalblock = CCriticalBlock(cs, #cs, __FILE__, __LINE__))
260
261 class CTryCriticalBlock
262 {
263 protected:
264     CCriticalSection* pcs;
265
266 public:
267     CTryCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
268     {
269         pcs = (csIn.TryEnter(pszName, pszFile, nLine) ? &csIn : NULL);
270     }
271
272     operator bool() const
273     {
274         return Entered();
275     }
276
277     ~CTryCriticalBlock()
278     {
279         if (pcs)
280         {
281             pcs->Leave();
282         }
283     }
284     bool Entered() const { return pcs != NULL; }
285 };
286
287 #define TRY_CRITICAL_BLOCK(cs)     \
288     if (CTryCriticalBlock criticalblock = CTryCriticalBlock(cs, #cs, __FILE__, __LINE__))
289
290
291
292
293
294
295
296
297
298
299 inline std::string i64tostr(int64 n)
300 {
301     return strprintf("%"PRI64d, n);
302 }
303
304 inline std::string itostr(int n)
305 {
306     return strprintf("%d", n);
307 }
308
309 inline int64 atoi64(const char* psz)
310 {
311 #ifdef _MSC_VER
312     return _atoi64(psz);
313 #else
314     return strtoll(psz, NULL, 10);
315 #endif
316 }
317
318 inline int64 atoi64(const std::string& str)
319 {
320 #ifdef _MSC_VER
321     return _atoi64(str.c_str());
322 #else
323     return strtoll(str.c_str(), NULL, 10);
324 #endif
325 }
326
327 inline int atoi(const std::string& str)
328 {
329     return atoi(str.c_str());
330 }
331
332 inline int roundint(double d)
333 {
334     return (int)(d > 0 ? d + 0.5 : d - 0.5);
335 }
336
337 inline int64 roundint64(double d)
338 {
339     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
340 }
341
342 inline int64 abs64(int64 n)
343 {
344     return (n >= 0 ? n : -n);
345 }
346
347 template<typename T>
348 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
349 {
350     if (itbegin == itend)
351         return "";
352     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
353     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
354     std::string str;
355     str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
356     for (const unsigned char* p = pbegin; p != pend; p++)
357         str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
358     return str;
359 }
360
361 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
362 {
363     return HexStr(vch.begin(), vch.end(), fSpaces);
364 }
365
366 template<typename T>
367 std::string HexNumStr(const T itbegin, const T itend, bool f0x=true)
368 {
369     if (itbegin == itend)
370         return "";
371     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
372     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
373     std::string str = (f0x ? "0x" : "");
374     str.reserve(str.size() + (pend-pbegin) * 2);
375     for (const unsigned char* p = pend-1; p >= pbegin; p--)
376         str += strprintf("%02x", *p);
377     return str;
378 }
379
380 inline std::string HexNumStr(const std::vector<unsigned char>& vch, bool f0x=true)
381 {
382     return HexNumStr(vch.begin(), vch.end(), f0x);
383 }
384
385 template<typename T>
386 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
387 {
388     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
389 }
390
391 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
392 {
393     printf(pszFormat, HexStr(vch, fSpaces).c_str());
394 }
395
396 inline int64 GetPerformanceCounter()
397 {
398     int64 nCounter = 0;
399 #ifdef WIN32
400     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
401 #else
402     timeval t;
403     gettimeofday(&t, NULL);
404     nCounter = t.tv_sec * 1000000 + t.tv_usec;
405 #endif
406     return nCounter;
407 }
408
409 inline int64 GetTimeMillis()
410 {
411     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
412             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
413 }
414
415 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
416 {
417     time_t n = nTime;
418     struct tm* ptmTime = gmtime(&n);
419     char pszTime[200];
420     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
421     return pszTime;
422 }
423
424 template<typename T>
425 void skipspaces(T& it)
426 {
427     while (isspace(*it))
428         ++it;
429 }
430
431 inline bool IsSwitchChar(char c)
432 {
433 #ifdef WIN32
434     return c == '-' || c == '/';
435 #else
436     return c == '-';
437 #endif
438 }
439
440 inline std::string GetArg(const std::string& strArg, const std::string& strDefault)
441 {
442     if (mapArgs.count(strArg))
443         return mapArgs[strArg];
444     return strDefault;
445 }
446
447 inline int64 GetArg(const std::string& strArg, int64 nDefault)
448 {
449     if (mapArgs.count(strArg))
450         return atoi64(mapArgs[strArg]);
451     return nDefault;
452 }
453
454 inline bool GetBoolArg(const std::string& strArg)
455 {
456     if (mapArgs.count(strArg))
457     {
458         if (mapArgs[strArg].empty())
459             return true;
460         return (atoi(mapArgs[strArg]) != 0);
461     }
462     return false;
463 }
464
465
466
467
468
469
470
471
472
473
474 inline void heapchk()
475 {
476 #ifdef WIN32
477     /// for debugging
478     //if (_heapchk() != _HEAPOK)
479     //    DebugBreak();
480 #endif
481 }
482
483 // Randomize the stack to help protect against buffer overrun exploits
484 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn)     \
485     {                                           \
486         static char nLoops;                     \
487         if (nLoops <= 0)                        \
488             nLoops = GetRand(20) + 1;           \
489         if (nLoops-- > 1)                       \
490         {                                       \
491             ThreadFn;                           \
492             return;                             \
493         }                                       \
494     }
495
496 #define CATCH_PRINT_EXCEPTION(pszFn)     \
497     catch (std::exception& e) {          \
498         PrintException(&e, (pszFn));     \
499     } catch (...) {                      \
500         PrintException(NULL, (pszFn));   \
501     }
502
503
504
505
506
507
508
509
510
511
512 template<typename T1>
513 inline uint256 Hash(const T1 pbegin, const T1 pend)
514 {
515     static unsigned char pblank[1];
516     uint256 hash1;
517     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
518     uint256 hash2;
519     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
520     return hash2;
521 }
522
523 template<typename T1, typename T2>
524 inline uint256 Hash(const T1 p1begin, const T1 p1end,
525                     const T2 p2begin, const T2 p2end)
526 {
527     static unsigned char pblank[1];
528     uint256 hash1;
529     SHA256_CTX ctx;
530     SHA256_Init(&ctx);
531     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
532     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
533     SHA256_Final((unsigned char*)&hash1, &ctx);
534     uint256 hash2;
535     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
536     return hash2;
537 }
538
539 template<typename T1, typename T2, typename T3>
540 inline uint256 Hash(const T1 p1begin, const T1 p1end,
541                     const T2 p2begin, const T2 p2end,
542                     const T3 p3begin, const T3 p3end)
543 {
544     static unsigned char pblank[1];
545     uint256 hash1;
546     SHA256_CTX ctx;
547     SHA256_Init(&ctx);
548     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
549     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
550     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
551     SHA256_Final((unsigned char*)&hash1, &ctx);
552     uint256 hash2;
553     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
554     return hash2;
555 }
556
557 template<typename T>
558 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=VERSION)
559 {
560     // Most of the time is spent allocating and deallocating CDataStream's
561     // buffer.  If this ever needs to be optimized further, make a CStaticStream
562     // class with its buffer on the stack.
563     CDataStream ss(nType, nVersion);
564     ss.reserve(10000);
565     ss << obj;
566     return Hash(ss.begin(), ss.end());
567 }
568
569 inline uint160 Hash160(const std::vector<unsigned char>& vch)
570 {
571     uint256 hash1;
572     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
573     uint160 hash2;
574     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
575     return hash2;
576 }
577
578
579 // Median filter over a stream of values
580 // Returns the median of the last N numbers
581 template <typename T> class CMedianFilter
582 {
583 private:
584     std::vector<T> vValues;
585     std::vector<T> vSorted;
586     int nSize;
587 public:
588     CMedianFilter(int size, T initial_value):
589         nSize(size)
590     {
591         vValues.reserve(size);
592         vValues.push_back(initial_value);
593         vSorted = vValues;
594     }
595     
596     void input(T value)
597     {
598         if(vValues.size() == nSize)
599         {
600             vValues.erase(vValues.begin());
601         }
602         vValues.push_back(value);
603
604         vSorted.resize(vValues.size());
605         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
606         std::sort(vSorted.begin(), vSorted.end());
607     }
608
609     T median() const
610     {
611         int size = vSorted.size();
612         assert(size>0);
613         if(size & 1) // Odd number of elements
614         {
615             return vSorted[size/2];
616         }
617         else // Even number of elements
618         {
619             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
620         }
621     }
622 };
623
624
625
626
627
628
629
630
631
632
633 // Note: It turns out we might have been able to use boost::thread
634 // by using TerminateThread(boost::thread.native_handle(), 0);
635 #ifdef WIN32
636 typedef HANDLE pthread_t;
637
638 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
639 {
640     DWORD nUnused = 0;
641     HANDLE hthread =
642         CreateThread(
643             NULL,                        // default security
644             0,                           // inherit stack size from parent
645             (LPTHREAD_START_ROUTINE)pfn, // function pointer
646             parg,                        // argument
647             0,                           // creation option, start immediately
648             &nUnused);                   // thread identifier
649     if (hthread == NULL)
650     {
651         printf("Error: CreateThread() returned %d\n", GetLastError());
652         return (pthread_t)0;
653     }
654     if (!fWantHandle)
655     {
656         CloseHandle(hthread);
657         return (pthread_t)-1;
658     }
659     return hthread;
660 }
661
662 inline void SetThreadPriority(int nPriority)
663 {
664     SetThreadPriority(GetCurrentThread(), nPriority);
665 }
666 #else
667 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
668 {
669     pthread_t hthread = 0;
670     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
671     if (ret != 0)
672     {
673         printf("Error: pthread_create() returned %d\n", ret);
674         return (pthread_t)0;
675     }
676     if (!fWantHandle)
677     {
678         pthread_detach(hthread);
679         return (pthread_t)-1;
680     }
681     return hthread;
682 }
683
684 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
685 #define THREAD_PRIORITY_BELOW_NORMAL    2
686 #define THREAD_PRIORITY_NORMAL          0
687 #define THREAD_PRIORITY_ABOVE_NORMAL    0
688
689 inline void SetThreadPriority(int nPriority)
690 {
691     // It's unclear if it's even possible to change thread priorities on Linux,
692     // but we really and truly need it for the generation threads.
693 #ifdef PRIO_THREAD
694     setpriority(PRIO_THREAD, 0, nPriority);
695 #else
696     setpriority(PRIO_PROCESS, 0, nPriority);
697 #endif
698 }
699
700 inline bool TerminateThread(pthread_t hthread, unsigned int nExitCode)
701 {
702     return (pthread_cancel(hthread) == 0);
703 }
704
705 inline void ExitThread(size_t nExitCode)
706 {
707     pthread_exit((void*)nExitCode);
708 }
709 #endif
710
711
712
713
714
715 inline bool AffinityBugWorkaround(void(*pfn)(void*))
716 {
717 #ifdef WIN32
718     // Sometimes after a few hours affinity gets stuck on one processor
719     DWORD_PTR dwProcessAffinityMask = -1;
720     DWORD_PTR dwSystemAffinityMask = -1;
721     GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
722     DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
723     DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
724     if (dwPrev2 != dwProcessAffinityMask)
725     {
726         printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
727         if (!CreateThread(pfn, NULL))
728             printf("Error: CreateThread() failed\n");
729         return true;
730     }
731 #endif
732     return false;
733 }
734
735 inline uint32_t ByteReverse(uint32_t value)
736 {
737         value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
738         return (value<<16) | (value>>16);
739 }
740
741 #endif