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