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