Use semaphores instead of condition variables
[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_semaphore.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
274 #define LOCK(cs) CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__)
275 #define LOCK2(cs1,cs2) CCriticalBlock criticalblock1(cs1, #cs1, __FILE__, __LINE__),criticalblock2(cs2, #cs2, __FILE__, __LINE__)
276 #define TRY_LOCK(cs,name) CCriticalBlock name(cs, #cs, __FILE__, __LINE__, true)
277
278 #define ENTER_CRITICAL_SECTION(cs) \
279     { \
280         EnterCritical(#cs, __FILE__, __LINE__, (void*)(&cs)); \
281         (cs).lock(); \
282     }
283
284 #define LEAVE_CRITICAL_SECTION(cs) \
285     { \
286         (cs).unlock(); \
287         LeaveCritical(); \
288     }
289
290 typedef boost::interprocess::interprocess_semaphore CSemaphore;
291
292 inline std::string i64tostr(int64 n)
293 {
294     return strprintf("%"PRI64d, n);
295 }
296
297 inline std::string itostr(int n)
298 {
299     return strprintf("%d", n);
300 }
301
302 inline int64 atoi64(const char* psz)
303 {
304 #ifdef _MSC_VER
305     return _atoi64(psz);
306 #else
307     return strtoll(psz, NULL, 10);
308 #endif
309 }
310
311 inline int64 atoi64(const std::string& str)
312 {
313 #ifdef _MSC_VER
314     return _atoi64(str.c_str());
315 #else
316     return strtoll(str.c_str(), NULL, 10);
317 #endif
318 }
319
320 inline int atoi(const std::string& str)
321 {
322     return atoi(str.c_str());
323 }
324
325 inline int roundint(double d)
326 {
327     return (int)(d > 0 ? d + 0.5 : d - 0.5);
328 }
329
330 inline int64 roundint64(double d)
331 {
332     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
333 }
334
335 inline int64 abs64(int64 n)
336 {
337     return (n >= 0 ? n : -n);
338 }
339
340 template<typename T>
341 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
342 {
343     std::vector<char> rv;
344     static char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
345                                '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
346     rv.reserve((itend-itbegin)*3);
347     for(T it = itbegin; it < itend; ++it)
348     {
349         unsigned char val = (unsigned char)(*it);
350         if(fSpaces && it != itbegin)
351             rv.push_back(' ');
352         rv.push_back(hexmap[val>>4]);
353         rv.push_back(hexmap[val&15]);
354     }
355
356     return std::string(rv.begin(), rv.end());
357 }
358
359 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
360 {
361     return HexStr(vch.begin(), vch.end(), fSpaces);
362 }
363
364 template<typename T>
365 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
366 {
367     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
368 }
369
370 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
371 {
372     printf(pszFormat, HexStr(vch, fSpaces).c_str());
373 }
374
375 inline int64 GetPerformanceCounter()
376 {
377     int64 nCounter = 0;
378 #ifdef WIN32
379     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
380 #else
381     timeval t;
382     gettimeofday(&t, NULL);
383     nCounter = t.tv_sec * 1000000 + t.tv_usec;
384 #endif
385     return nCounter;
386 }
387
388 inline int64 GetTimeMillis()
389 {
390     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
391             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
392 }
393
394 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
395 {
396     time_t n = nTime;
397     struct tm* ptmTime = gmtime(&n);
398     char pszTime[200];
399     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
400     return pszTime;
401 }
402
403 template<typename T>
404 void skipspaces(T& it)
405 {
406     while (isspace(*it))
407         ++it;
408 }
409
410 inline bool IsSwitchChar(char c)
411 {
412 #ifdef WIN32
413     return c == '-' || c == '/';
414 #else
415     return c == '-';
416 #endif
417 }
418
419 /**
420  * Return string argument or default value
421  *
422  * @param strArg Argument to get (e.g. "-foo")
423  * @param default (e.g. "1")
424  * @return command-line argument or default value
425  */
426 std::string GetArg(const std::string& strArg, const std::string& strDefault);
427
428 /**
429  * Return integer argument or default value
430  *
431  * @param strArg Argument to get (e.g. "-foo")
432  * @param default (e.g. 1)
433  * @return command-line argument (0 if invalid number) or default value
434  */
435 int64 GetArg(const std::string& strArg, int64 nDefault);
436
437 /**
438  * Return boolean argument or default value
439  *
440  * @param strArg Argument to get (e.g. "-foo")
441  * @param default (true or false)
442  * @return command-line argument or default value
443  */
444 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
445
446 /**
447  * Set an argument if it doesn't already have a value
448  *
449  * @param strArg Argument to set (e.g. "-foo")
450  * @param strValue Value (e.g. "1")
451  * @return true if argument gets set, false if it already had a value
452  */
453 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
454
455 /**
456  * Set a boolean argument if it doesn't already have a value
457  *
458  * @param strArg Argument to set (e.g. "-foo")
459  * @param fValue Value (e.g. false)
460  * @return true if argument gets set, false if it already had a value
461  */
462 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
463
464
465
466
467
468
469
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
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  */
556 template <typename T> class CMedianFilter
557 {
558 private:
559     std::vector<T> vValues;
560     std::vector<T> vSorted;
561     unsigned int nSize;
562 public:
563     CMedianFilter(unsigned int size, T initial_value):
564         nSize(size)
565     {
566         vValues.reserve(size);
567         vValues.push_back(initial_value);
568         vSorted = vValues;
569     }
570     
571     void input(T value)
572     {
573         if(vValues.size() == nSize)
574         {
575             vValues.erase(vValues.begin());
576         }
577         vValues.push_back(value);
578
579         vSorted.resize(vValues.size());
580         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
581         std::sort(vSorted.begin(), vSorted.end());
582     }
583
584     T median() const
585     {
586         int size = vSorted.size();
587         assert(size>0);
588         if(size & 1) // Odd number of elements
589         {
590             return vSorted[size/2];
591         }
592         else // Even number of elements
593         {
594             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
595         }
596     }
597
598     int size() const
599     {
600         return vValues.size();
601     }
602
603     std::vector<T> sorted () const
604     {
605         return vSorted;
606     }
607 };
608
609
610
611
612
613
614
615
616
617
618 // Note: It turns out we might have been able to use boost::thread
619 // by using TerminateThread(boost::thread.native_handle(), 0);
620 #ifdef WIN32
621 typedef HANDLE pthread_t;
622
623 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
624 {
625     DWORD nUnused = 0;
626     HANDLE hthread =
627         CreateThread(
628             NULL,                        // default security
629             0,                           // inherit stack size from parent
630             (LPTHREAD_START_ROUTINE)pfn, // function pointer
631             parg,                        // argument
632             0,                           // creation option, start immediately
633             &nUnused);                   // thread identifier
634     if (hthread == NULL)
635     {
636         printf("Error: CreateThread() returned %d\n", GetLastError());
637         return (pthread_t)0;
638     }
639     if (!fWantHandle)
640     {
641         CloseHandle(hthread);
642         return (pthread_t)-1;
643     }
644     return hthread;
645 }
646
647 inline void SetThreadPriority(int nPriority)
648 {
649     SetThreadPriority(GetCurrentThread(), nPriority);
650 }
651 #else
652 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
653 {
654     pthread_t hthread = 0;
655     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
656     if (ret != 0)
657     {
658         printf("Error: pthread_create() returned %d\n", ret);
659         return (pthread_t)0;
660     }
661     if (!fWantHandle)
662     {
663         pthread_detach(hthread);
664         return (pthread_t)-1;
665     }
666     return hthread;
667 }
668
669 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
670 #define THREAD_PRIORITY_BELOW_NORMAL    2
671 #define THREAD_PRIORITY_NORMAL          0
672 #define THREAD_PRIORITY_ABOVE_NORMAL    0
673
674 inline void SetThreadPriority(int nPriority)
675 {
676     // It's unclear if it's even possible to change thread priorities on Linux,
677     // but we really and truly need it for the generation threads.
678 #ifdef PRIO_THREAD
679     setpriority(PRIO_THREAD, 0, nPriority);
680 #else
681     setpriority(PRIO_PROCESS, 0, nPriority);
682 #endif
683 }
684
685 inline void ExitThread(size_t nExitCode)
686 {
687     pthread_exit((void*)nExitCode);
688 }
689 #endif
690
691
692
693
694
695 inline uint32_t ByteReverse(uint32_t value)
696 {
697     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
698     return (value<<16) | (value>>16);
699 }
700
701 #endif
702