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