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