use median filter for peer-reported reported number of blocks
[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 // 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::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 __WXMSW__
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) && !defined(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 void ParseParameters(int argc, char* argv[]);
182 const char* wxGetTranslation(const char* psz);
183 bool WildcardMatch(const char* psz, const char* mask);
184 bool WildcardMatch(const std::string& str, const std::string& mask);
185 int GetFilesize(FILE* file);
186 void GetDataDir(char* pszDirRet);
187 std::string GetConfigFile();
188 std::string GetPidFile();
189 void CreatePidFile(std::string pidFile, pid_t pid);
190 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
191 #ifdef __WXMSW__
192 std::string MyGetSpecialFolderPath(int nFolder, bool fCreate);
193 #endif
194 std::string GetDefaultDataDir();
195 std::string GetDataDir();
196 void ShrinkDebugFile();
197 int GetRandInt(int nMax);
198 uint64 GetRand(uint64 nMax);
199 int64 GetTime();
200 int64 GetAdjustedTime();
201 void AddTimeData(unsigned int ip, int64 nTime);
202 std::string FormatFullVersion();
203
204
205
206
207
208
209
210
211
212
213
214
215
216 // Wrapper to automatically initialize mutex
217 class CCriticalSection
218 {
219 protected:
220     boost::interprocess::interprocess_recursive_mutex mutex;
221 public:
222     explicit CCriticalSection() { }
223     ~CCriticalSection() { }
224     void Enter(const char* pszName, const char* pszFile, int nLine);
225     void Leave();
226     bool TryEnter(const char* pszName, const char* pszFile, int nLine);
227 };
228
229 // Automatically leave critical section when leaving block, needed for exception safety
230 class CCriticalBlock
231 {
232 protected:
233     CCriticalSection* pcs;
234
235 public:
236     CCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
237     {
238         pcs = &csIn;
239         pcs->Enter(pszName, pszFile, nLine);
240     }
241     ~CCriticalBlock()
242     {
243         pcs->Leave();
244     }
245 };
246
247 // WARNING: This will catch continue and break!
248 // break is caught with an assertion, but there's no way to detect continue.
249 // I'd rather be careful than suffer the other more error prone syntax.
250 // The compiler will optimise away all this loop junk.
251 #define CRITICAL_BLOCK(cs)     \
252     for (bool fcriticalblockonce=true; fcriticalblockonce; assert(("break caught by CRITICAL_BLOCK!" && !fcriticalblockonce)), fcriticalblockonce=false) \
253         for (CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__); fcriticalblockonce; fcriticalblockonce=false)
254
255 class CTryCriticalBlock
256 {
257 protected:
258     CCriticalSection* pcs;
259
260 public:
261     CTryCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
262     {
263         pcs = (csIn.TryEnter(pszName, pszFile, nLine) ? &csIn : NULL);
264     }
265     ~CTryCriticalBlock()
266     {
267         if (pcs)
268         {
269             pcs->Leave();
270         }
271     }
272     bool Entered() { return pcs != NULL; }
273 };
274
275 #define TRY_CRITICAL_BLOCK(cs)     \
276     for (bool fcriticalblockonce=true; fcriticalblockonce; assert(("break caught by TRY_CRITICAL_BLOCK!" && !fcriticalblockonce)), fcriticalblockonce=false) \
277         for (CTryCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__); fcriticalblockonce && (fcriticalblockonce = criticalblock.Entered()); fcriticalblockonce=false)
278
279
280
281
282
283
284
285
286
287
288 inline std::string i64tostr(int64 n)
289 {
290     return strprintf("%"PRI64d, n);
291 }
292
293 inline std::string itostr(int n)
294 {
295     return strprintf("%d", n);
296 }
297
298 inline int64 atoi64(const char* psz)
299 {
300 #ifdef _MSC_VER
301     return _atoi64(psz);
302 #else
303     return strtoll(psz, NULL, 10);
304 #endif
305 }
306
307 inline int64 atoi64(const std::string& str)
308 {
309 #ifdef _MSC_VER
310     return _atoi64(str.c_str());
311 #else
312     return strtoll(str.c_str(), NULL, 10);
313 #endif
314 }
315
316 inline int atoi(const std::string& str)
317 {
318     return atoi(str.c_str());
319 }
320
321 inline int roundint(double d)
322 {
323     return (int)(d > 0 ? d + 0.5 : d - 0.5);
324 }
325
326 inline int64 roundint64(double d)
327 {
328     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
329 }
330
331 inline int64 abs64(int64 n)
332 {
333     return (n >= 0 ? n : -n);
334 }
335
336 template<typename T>
337 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
338 {
339     if (itbegin == itend)
340         return "";
341     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
342     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
343     std::string str;
344     str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
345     for (const unsigned char* p = pbegin; p != pend; p++)
346         str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
347     return str;
348 }
349
350 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
351 {
352     return HexStr(vch.begin(), vch.end(), fSpaces);
353 }
354
355 template<typename T>
356 std::string HexNumStr(const T itbegin, const T itend, bool f0x=true)
357 {
358     if (itbegin == itend)
359         return "";
360     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
361     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
362     std::string str = (f0x ? "0x" : "");
363     str.reserve(str.size() + (pend-pbegin) * 2);
364     for (const unsigned char* p = pend-1; p >= pbegin; p--)
365         str += strprintf("%02x", *p);
366     return str;
367 }
368
369 inline std::string HexNumStr(const std::vector<unsigned char>& vch, bool f0x=true)
370 {
371     return HexNumStr(vch.begin(), vch.end(), f0x);
372 }
373
374 template<typename T>
375 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
376 {
377     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
378 }
379
380 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
381 {
382     printf(pszFormat, HexStr(vch, fSpaces).c_str());
383 }
384
385 inline int64 GetPerformanceCounter()
386 {
387     int64 nCounter = 0;
388 #ifdef __WXMSW__
389     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
390 #else
391     timeval t;
392     gettimeofday(&t, NULL);
393     nCounter = t.tv_sec * 1000000 + t.tv_usec;
394 #endif
395     return nCounter;
396 }
397
398 inline int64 GetTimeMillis()
399 {
400     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
401             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
402 }
403
404 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
405 {
406     time_t n = nTime;
407     struct tm* ptmTime = gmtime(&n);
408     char pszTime[200];
409     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
410     return pszTime;
411 }
412
413 template<typename T>
414 void skipspaces(T& it)
415 {
416     while (isspace(*it))
417         ++it;
418 }
419
420 inline bool IsSwitchChar(char c)
421 {
422 #ifdef __WXMSW__
423     return c == '-' || c == '/';
424 #else
425     return c == '-';
426 #endif
427 }
428
429 inline std::string GetArg(const std::string& strArg, const std::string& strDefault)
430 {
431     if (mapArgs.count(strArg))
432         return mapArgs[strArg];
433     return strDefault;
434 }
435
436 inline int64 GetArg(const std::string& strArg, int64 nDefault)
437 {
438     if (mapArgs.count(strArg))
439         return atoi64(mapArgs[strArg]);
440     return nDefault;
441 }
442
443 inline bool GetBoolArg(const std::string& strArg)
444 {
445     if (mapArgs.count(strArg))
446     {
447         if (mapArgs[strArg].empty())
448             return true;
449         return (atoi(mapArgs[strArg]) != 0);
450     }
451     return false;
452 }
453
454
455
456
457
458
459
460
461
462
463 inline void heapchk()
464 {
465 #ifdef __WXMSW__
466     /// for debugging
467     //if (_heapchk() != _HEAPOK)
468     //    DebugBreak();
469 #endif
470 }
471
472 // Randomize the stack to help protect against buffer overrun exploits
473 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn)     \
474     {                                           \
475         static char nLoops;                     \
476         if (nLoops <= 0)                        \
477             nLoops = GetRand(20) + 1;           \
478         if (nLoops-- > 1)                       \
479         {                                       \
480             ThreadFn;                           \
481             return;                             \
482         }                                       \
483     }
484
485 #define CATCH_PRINT_EXCEPTION(pszFn)     \
486     catch (std::exception& e) {          \
487         PrintException(&e, (pszFn));     \
488     } catch (...) {                      \
489         PrintException(NULL, (pszFn));   \
490     }
491
492
493
494
495
496
497
498
499
500
501 template<typename T1>
502 inline uint256 Hash(const T1 pbegin, const T1 pend)
503 {
504     static unsigned char pblank[1];
505     uint256 hash1;
506     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
507     uint256 hash2;
508     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
509     return hash2;
510 }
511
512 template<typename T1, typename T2>
513 inline uint256 Hash(const T1 p1begin, const T1 p1end,
514                     const T2 p2begin, const T2 p2end)
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_Final((unsigned char*)&hash1, &ctx);
523     uint256 hash2;
524     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
525     return hash2;
526 }
527
528 template<typename T1, typename T2, typename T3>
529 inline uint256 Hash(const T1 p1begin, const T1 p1end,
530                     const T2 p2begin, const T2 p2end,
531                     const T3 p3begin, const T3 p3end)
532 {
533     static unsigned char pblank[1];
534     uint256 hash1;
535     SHA256_CTX ctx;
536     SHA256_Init(&ctx);
537     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
538     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
539     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
540     SHA256_Final((unsigned char*)&hash1, &ctx);
541     uint256 hash2;
542     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
543     return hash2;
544 }
545
546 template<typename T>
547 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=VERSION)
548 {
549     // Most of the time is spent allocating and deallocating CDataStream's
550     // buffer.  If this ever needs to be optimized further, make a CStaticStream
551     // class with its buffer on the stack.
552     CDataStream ss(nType, nVersion);
553     ss.reserve(10000);
554     ss << obj;
555     return Hash(ss.begin(), ss.end());
556 }
557
558 inline uint160 Hash160(const std::vector<unsigned char>& vch)
559 {
560     uint256 hash1;
561     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
562     uint160 hash2;
563     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
564     return hash2;
565 }
566
567
568 // Median filter over a stream of values
569 // Returns the median of the last N numbers
570 template <typename T> class CMedianFilter
571 {
572 private:
573     std::vector<T> vValues;
574     std::vector<T> vSorted;
575     int nSize;
576 public:
577     CMedianFilter(int size, T initial_value):
578         nSize(size)
579     {
580         vValues.reserve(size);
581         vValues.push_back(initial_value);
582         vSorted = vValues;
583     }
584     
585     void input(T value)
586     {
587         if(vValues.size() == nSize)
588         {
589             vValues.erase(vValues.begin());
590         }
591         vValues.push_back(value);
592
593         vSorted.resize(vValues.size());
594         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
595         std::sort(vSorted.begin(), vSorted.end());
596     }
597
598     T median() const
599     {
600         int size = vSorted.size();
601         if(size & 1) // Odd number of elements
602         {
603             return vSorted[size/2];
604         }
605         else // Even number of elements
606         {
607             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
608         }
609     }
610 };
611
612
613
614
615
616
617
618
619
620
621 // Note: It turns out we might have been able to use boost::thread
622 // by using TerminateThread(boost::thread.native_handle(), 0);
623 #ifdef __WXMSW__
624 typedef HANDLE pthread_t;
625
626 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
627 {
628     DWORD nUnused = 0;
629     HANDLE hthread =
630         CreateThread(
631             NULL,                        // default security
632             0,                           // inherit stack size from parent
633             (LPTHREAD_START_ROUTINE)pfn, // function pointer
634             parg,                        // argument
635             0,                           // creation option, start immediately
636             &nUnused);                   // thread identifier
637     if (hthread == NULL)
638     {
639         printf("Error: CreateThread() returned %d\n", GetLastError());
640         return (pthread_t)0;
641     }
642     if (!fWantHandle)
643     {
644         CloseHandle(hthread);
645         return (pthread_t)-1;
646     }
647     return hthread;
648 }
649
650 inline void SetThreadPriority(int nPriority)
651 {
652     SetThreadPriority(GetCurrentThread(), nPriority);
653 }
654 #else
655 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
656 {
657     pthread_t hthread = 0;
658     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
659     if (ret != 0)
660     {
661         printf("Error: pthread_create() returned %d\n", ret);
662         return (pthread_t)0;
663     }
664     if (!fWantHandle)
665     {
666         pthread_detach(hthread);
667         return (pthread_t)-1;
668     }
669     return hthread;
670 }
671
672 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
673 #define THREAD_PRIORITY_BELOW_NORMAL    2
674 #define THREAD_PRIORITY_NORMAL          0
675 #define THREAD_PRIORITY_ABOVE_NORMAL    0
676
677 inline void SetThreadPriority(int nPriority)
678 {
679     // It's unclear if it's even possible to change thread priorities on Linux,
680     // but we really and truly need it for the generation threads.
681 #ifdef PRIO_THREAD
682     setpriority(PRIO_THREAD, 0, nPriority);
683 #else
684     setpriority(PRIO_PROCESS, 0, nPriority);
685 #endif
686 }
687
688 inline bool TerminateThread(pthread_t hthread, unsigned int nExitCode)
689 {
690     return (pthread_cancel(hthread) == 0);
691 }
692
693 inline void ExitThread(size_t nExitCode)
694 {
695     pthread_exit((void*)nExitCode);
696 }
697 #endif
698
699
700
701
702
703 inline bool AffinityBugWorkaround(void(*pfn)(void*))
704 {
705 #ifdef __WXMSW__
706     // Sometimes after a few hours affinity gets stuck on one processor
707     DWORD dwProcessAffinityMask = -1;
708     DWORD dwSystemAffinityMask = -1;
709     GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
710     DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
711     DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
712     if (dwPrev2 != dwProcessAffinityMask)
713     {
714         printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
715         if (!CreateThread(pfn, NULL))
716             printf("Error: CreateThread() failed\n");
717         return true;
718     }
719 #endif
720     return false;
721 }
722
723 #endif