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.
11 #include <sys/types.h>
13 #include <sys/resource.h>
15 typedef int pid_t; /* define for windows compatiblity */
21 #include <boost/thread.hpp>
22 #include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
23 #include <boost/interprocess/sync/scoped_lock.hpp>
24 #include <boost/interprocess/sync/interprocess_condition.hpp>
25 #include <boost/interprocess/sync/lock_options.hpp>
26 #include <boost/date_time/gregorian/gregorian_types.hpp>
27 #include <boost/date_time/posix_time/posix_time_types.hpp>
29 #include <openssl/sha.h>
30 #include <openssl/ripemd.h>
34 typedef long long int64;
35 typedef unsigned long long uint64;
38 #define BEGIN(a) ((char*)&(a))
39 #define END(a) ((char*)&((&(a))[1]))
40 #define UBEGIN(a) ((unsigned char*)&(a))
41 #define UEND(a) ((unsigned char*)&((&(a))[1]))
42 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
43 #define printf OutputDebugStringF
48 #define snprintf my_snprintf
51 #if defined(_MSC_VER) || defined(__MSVCRT__)
62 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
63 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
65 // Align by increasing pointer, must have extra space at end of buffer
66 template <size_t nBytes, typename T>
75 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
80 #define MSG_NOSIGNAL 0
81 #define MSG_DONTWAIT 0
87 #define unlink _unlink
89 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
90 #define strlwr(psz) to_lower(psz)
91 #define _strlwr(psz) to_lower(psz)
93 inline void Sleep(int64 n)
95 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
96 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
97 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
109 extern std::map<std::string, std::string> mapArgs;
110 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
112 extern bool fPrintToConsole;
113 extern bool fPrintToDebugger;
114 extern char pszSetDataDir[MAX_PATH];
115 extern bool fRequestShutdown;
116 extern bool fShutdown;
119 extern bool fCommandLine;
120 extern std::string strMiscWarning;
121 extern bool fTestNet;
122 extern bool fNoListen;
123 extern bool fLogTimestamps;
126 void RandAddSeedPerfmon();
127 int OutputDebugStringF(const char* pszFormat, ...);
128 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
130 /* It is not allowed to use va_start with a pass-by-reference argument.
131 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
132 macro to keep similar semantics.
134 std::string real_strprintf(const std::string &format, int dummy, ...);
135 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
137 bool error(const char *format, ...);
138 void LogException(std::exception* pex, const char* pszThread);
139 void PrintException(std::exception* pex, const char* pszThread);
140 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
141 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
142 std::string FormatMoney(int64 n, bool fPlus=false);
143 bool ParseMoney(const std::string& str, int64& nRet);
144 bool ParseMoney(const char* pszIn, int64& nRet);
145 std::vector<unsigned char> ParseHex(const char* psz);
146 std::vector<unsigned char> ParseHex(const std::string& str);
147 bool IsHex(const std::string& str);
148 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
149 std::string DecodeBase64(const std::string& str);
150 std::string EncodeBase64(const unsigned char* pch, size_t len);
151 std::string EncodeBase64(const std::string& str);
152 void ParseParameters(int argc, const char*const argv[]);
153 bool WildcardMatch(const char* psz, const char* mask);
154 bool WildcardMatch(const std::string& str, const std::string& mask);
155 int GetFilesize(FILE* file);
156 void GetDataDir(char* pszDirRet);
157 std::string GetConfigFile();
158 std::string GetPidFile();
159 void CreatePidFile(std::string pidFile, pid_t pid);
160 bool ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
162 std::string MyGetSpecialFolderPath(int nFolder, bool fCreate);
164 std::string GetDefaultDataDir();
165 std::string GetDataDir();
166 void ShrinkDebugFile();
167 int GetRandInt(int nMax);
168 uint64 GetRand(uint64 nMax);
170 void SetMockTime(int64 nMockTimeIn);
171 int64 GetAdjustedTime();
172 std::string FormatFullVersion();
173 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
174 void AddTimeData(const CNetAddr& ip, int64 nTime);
186 /** Wrapped boost mutex: supports recursive locking, but no waiting */
187 typedef boost::interprocess::interprocess_recursive_mutex CCriticalSection;
189 /** Wrapped boost mutex: supports waiting but not recursive locking */
190 typedef boost::interprocess::interprocess_mutex CWaitableCriticalSection;
192 #ifdef DEBUG_LOCKORDER
193 void EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false);
194 void LeaveCritical();
196 void static inline EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false) {}
197 void static inline LeaveCritical() {}
200 /** Wrapper around boost::interprocess::scoped_lock */
201 template<typename Mutex>
205 boost::interprocess::scoped_lock<Mutex> lock;
208 void Enter(const char* pszName, const char* pszFile, int nLine)
212 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()));
213 #ifdef DEBUG_LOCKCONTENTION
214 if (!lock.try_lock())
216 printf("LOCKCONTENTION: %s\n", pszName);
217 printf("Locker: %s:%d\n", pszFile, nLine);
233 bool TryEnter(const char* pszName, const char* pszFile, int nLine)
237 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()), true);
245 CMutexLock(Mutex& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) : lock(mutexIn, boost::interprocess::defer_lock)
248 TryEnter(pszName, pszFile, nLine);
250 Enter(pszName, pszFile, nLine);
264 boost::interprocess::scoped_lock<Mutex> &GetLock()
270 typedef CMutexLock<CCriticalSection> CCriticalBlock;
271 typedef CMutexLock<CWaitableCriticalSection> CWaitableCriticalBlock;
272 typedef boost::interprocess::interprocess_condition CConditionVariable;
274 /** Wait for a given condition inside a WAITABLE_CRITICAL_BLOCK */
275 #define WAIT(name,condition) \
276 do { while(!(condition)) { (name).wait(waitablecriticalblock.GetLock()); } } while(0)
278 /** Notify waiting threads that a condition may hold now */
279 #define NOTIFY(name) \
280 do { (name).notify_one(); } while(0)
282 #define NOTIFY_ALL(name) \
283 do { (name).notify_all(); } while(0)
285 #define LOCK(cs) CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__)
286 #define LOCK2(cs1,cs2) CCriticalBlock criticalblock1(cs1, #cs1, __FILE__, __LINE__),criticalblock2(cs2, #cs2, __FILE__, __LINE__)
287 #define TRY_LOCK(cs,name) CCriticalBlock name(cs, #cs, __FILE__, __LINE__, true)
288 #define WAITABLE_LOCK(cs) CWaitableCriticalBlock waitablecriticalblock(cs, #cs, __FILE__, __LINE__)
290 #define ENTER_CRITICAL_SECTION(cs) \
292 EnterCritical(#cs, __FILE__, __LINE__, (void*)(&cs)); \
296 #define LEAVE_CRITICAL_SECTION(cs) \
303 // This is exactly like std::string, but with a custom allocator.
304 // (secure_allocator<> is defined in serialize.h)
305 typedef std::basic_string<char, std::char_traits<char>, secure_allocator<char> > SecureString;
311 inline std::string i64tostr(int64 n)
313 return strprintf("%"PRI64d, n);
316 inline std::string itostr(int n)
318 return strprintf("%d", n);
321 inline int64 atoi64(const char* psz)
326 return strtoll(psz, NULL, 10);
330 inline int64 atoi64(const std::string& str)
333 return _atoi64(str.c_str());
335 return strtoll(str.c_str(), NULL, 10);
339 inline int atoi(const std::string& str)
341 return atoi(str.c_str());
344 inline int roundint(double d)
346 return (int)(d > 0 ? d + 0.5 : d - 0.5);
349 inline int64 roundint64(double d)
351 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
354 inline int64 abs64(int64 n)
356 return (n >= 0 ? n : -n);
360 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
362 if (itbegin == itend)
364 const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
365 const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
367 str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
368 for (const unsigned char* p = pbegin; p != pend; p++)
369 str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
373 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
375 return HexStr(vch.begin(), vch.end(), fSpaces);
379 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
381 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
384 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
386 printf(pszFormat, HexStr(vch, fSpaces).c_str());
389 inline int64 GetPerformanceCounter()
393 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
396 gettimeofday(&t, NULL);
397 nCounter = t.tv_sec * 1000000 + t.tv_usec;
402 inline int64 GetTimeMillis()
404 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
405 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
408 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
411 struct tm* ptmTime = gmtime(&n);
413 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
418 void skipspaces(T& it)
424 inline bool IsSwitchChar(char c)
427 return c == '-' || c == '/';
434 * Return string argument or default value
436 * @param strArg Argument to get (e.g. "-foo")
437 * @param default (e.g. "1")
438 * @return command-line argument or default value
440 std::string GetArg(const std::string& strArg, const std::string& strDefault);
443 * Return integer argument or default value
445 * @param strArg Argument to get (e.g. "-foo")
446 * @param default (e.g. 1)
447 * @return command-line argument (0 if invalid number) or default value
449 int64 GetArg(const std::string& strArg, int64 nDefault);
452 * Return boolean argument or default value
454 * @param strArg Argument to get (e.g. "-foo")
455 * @param default (true or false)
456 * @return command-line argument or default value
458 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
461 * Set an argument if it doesn't already have a value
463 * @param strArg Argument to set (e.g. "-foo")
464 * @param strValue Value (e.g. "1")
465 * @return true if argument gets set, false if it already had a value
467 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
470 * Set a boolean argument if it doesn't already have a value
472 * @param strArg Argument to set (e.g. "-foo")
473 * @param fValue Value (e.g. false)
474 * @return true if argument gets set, false if it already had a value
476 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
486 // Randomize the stack to help protect against buffer overrun exploits
487 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn) \
489 static char nLoops; \
491 nLoops = GetRand(20) + 1; \
500 template<typename T1>
501 inline uint256 Hash(const T1 pbegin, const T1 pend)
503 static unsigned char pblank[1];
505 SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
507 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
511 template<typename T1, typename T2>
512 inline uint256 Hash(const T1 p1begin, const T1 p1end,
513 const T2 p2begin, const T2 p2end)
515 static unsigned char pblank[1];
519 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
520 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
521 SHA256_Final((unsigned char*)&hash1, &ctx);
523 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
527 template<typename T1, typename T2, typename T3>
528 inline uint256 Hash(const T1 p1begin, const T1 p1end,
529 const T2 p2begin, const T2 p2end,
530 const T3 p3begin, const T3 p3end)
532 static unsigned char pblank[1];
536 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
537 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
538 SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
539 SHA256_Final((unsigned char*)&hash1, &ctx);
541 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
546 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
548 // Most of the time is spent allocating and deallocating CDataStream's
549 // buffer. If this ever needs to be optimized further, make a CStaticStream
550 // class with its buffer on the stack.
551 CDataStream ss(nType, nVersion);
554 return Hash(ss.begin(), ss.end());
557 inline uint160 Hash160(const std::vector<unsigned char>& vch)
560 SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
562 RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
567 /** Median filter over a stream of values.
568 * Returns the median of the last N numbers
570 template <typename T> class CMedianFilter
573 std::vector<T> vValues;
574 std::vector<T> vSorted;
577 CMedianFilter(int size, T initial_value):
580 vValues.reserve(size);
581 vValues.push_back(initial_value);
587 if(vValues.size() == nSize)
589 vValues.erase(vValues.begin());
591 vValues.push_back(value);
593 vSorted.resize(vValues.size());
594 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
595 std::sort(vSorted.begin(), vSorted.end());
600 int size = vSorted.size();
602 if(size & 1) // Odd number of elements
604 return vSorted[size/2];
606 else // Even number of elements
608 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
614 return vValues.size();
617 std::vector<T> sorted () const
632 // Note: It turns out we might have been able to use boost::thread
633 // by using TerminateThread(boost::thread.native_handle(), 0);
635 typedef HANDLE pthread_t;
637 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
642 NULL, // default security
643 0, // inherit stack size from parent
644 (LPTHREAD_START_ROUTINE)pfn, // function pointer
646 0, // creation option, start immediately
647 &nUnused); // thread identifier
650 printf("Error: CreateThread() returned %d\n", GetLastError());
655 CloseHandle(hthread);
656 return (pthread_t)-1;
661 inline void SetThreadPriority(int nPriority)
663 SetThreadPriority(GetCurrentThread(), nPriority);
666 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
668 pthread_t hthread = 0;
669 int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
672 printf("Error: pthread_create() returned %d\n", ret);
677 pthread_detach(hthread);
678 return (pthread_t)-1;
683 #define THREAD_PRIORITY_LOWEST PRIO_MAX
684 #define THREAD_PRIORITY_BELOW_NORMAL 2
685 #define THREAD_PRIORITY_NORMAL 0
686 #define THREAD_PRIORITY_ABOVE_NORMAL 0
688 inline void SetThreadPriority(int nPriority)
690 // It's unclear if it's even possible to change thread priorities on Linux,
691 // but we really and truly need it for the generation threads.
693 setpriority(PRIO_THREAD, 0, nPriority);
695 setpriority(PRIO_PROCESS, 0, nPriority);
699 inline void ExitThread(size_t nExitCode)
701 pthread_exit((void*)nExitCode);
709 inline bool AffinityBugWorkaround(void(*pfn)(void*))
712 // Sometimes after a few hours affinity gets stuck on one processor
713 DWORD_PTR dwProcessAffinityMask = -1;
714 DWORD_PTR dwSystemAffinityMask = -1;
715 GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
716 DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
717 DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
718 if (dwPrev2 != dwProcessAffinityMask)
720 printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
721 if (!CreateThread(pfn, NULL))
722 printf("Error: CreateThread() failed\n");
729 inline uint32_t ByteReverse(uint32_t value)
731 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
732 return (value<<16) | (value>>16);