1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Copyright (c) 2012 The PPCoin developers
4 // Distributed under the MIT/X11 software license, see the accompanying
5 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
12 #include <sys/types.h>
14 #include <sys/resource.h>
16 typedef int pid_t; /* define for windows compatiblity */
22 #include <boost/thread.hpp>
23 #include <boost/filesystem.hpp>
24 #include <boost/filesystem/path.hpp>
25 #include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
26 #include <boost/interprocess/sync/scoped_lock.hpp>
27 #include <boost/interprocess/sync/interprocess_semaphore.hpp>
28 #include <boost/interprocess/sync/lock_options.hpp>
29 #include <boost/date_time/gregorian/gregorian_types.hpp>
30 #include <boost/date_time/posix_time/posix_time_types.hpp>
32 #include <openssl/sha.h>
33 #include <openssl/ripemd.h>
35 #include "netbase.h" // for AddTimeData
37 typedef long long int64;
38 typedef unsigned long long uint64;
40 static const int64 COIN = 1000000;
41 static const int64 CENT = 10000;
44 #define BEGIN(a) ((char*)&(a))
45 #define END(a) ((char*)&((&(a))[1]))
46 #define UBEGIN(a) ((unsigned char*)&(a))
47 #define UEND(a) ((unsigned char*)&((&(a))[1]))
48 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
49 #define printf OutputDebugStringF
51 #define UVOIDBEGIN(a) ((void*)&(a))
52 #define CVOIDBEGIN(a) ((const void*)&(a))
53 #define UINTBEGIN(a) ((uint32_t*)&(a))
54 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
59 #define snprintf my_snprintf
62 #if defined(_MSC_VER) || defined(__MSVCRT__)
73 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
74 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
76 // Align by increasing pointer, must have extra space at end of buffer
77 template <size_t nBytes, typename T>
86 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
91 #define MSG_NOSIGNAL 0
92 #define MSG_DONTWAIT 0
98 #define unlink _unlink
100 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
101 #define strlwr(psz) to_lower(psz)
102 #define _strlwr(psz) to_lower(psz)
103 #define MAX_PATH 1024
104 inline void Sleep(int64 n)
106 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
107 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
108 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
112 #ifndef THROW_WITH_STACKTRACE
113 #define THROW_WITH_STACKTRACE(exception) \
118 void LogStackTrace();
126 extern std::map<std::string, std::string> mapArgs;
127 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
129 extern bool fPrintToConsole;
130 extern bool fPrintToDebugger;
131 extern bool fRequestShutdown;
132 extern bool fShutdown;
135 extern bool fCommandLine;
136 extern std::string strMiscWarning;
137 extern bool fTestNet;
138 extern bool fNoListen;
139 extern bool fLogTimestamps;
142 void RandAddSeedPerfmon();
143 int OutputDebugStringF(const char* pszFormat, ...);
144 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
146 /* It is not allowed to use va_start with a pass-by-reference argument.
147 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
148 macro to keep similar semantics.
150 std::string real_strprintf(const std::string &format, int dummy, ...);
151 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
153 bool error(const char *format, ...);
154 void LogException(std::exception* pex, const char* pszThread);
155 void PrintException(std::exception* pex, const char* pszThread);
156 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
157 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
158 std::string FormatMoney(int64 n, bool fPlus=false);
159 bool ParseMoney(const std::string& str, int64& nRet);
160 bool ParseMoney(const char* pszIn, int64& nRet);
161 std::vector<unsigned char> ParseHex(const char* psz);
162 std::vector<unsigned char> ParseHex(const std::string& str);
163 bool IsHex(const std::string& str);
164 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
165 std::string DecodeBase64(const std::string& str);
166 std::string EncodeBase64(const unsigned char* pch, size_t len);
167 std::string EncodeBase64(const std::string& str);
168 void ParseParameters(int argc, const char*const argv[]);
169 bool WildcardMatch(const char* psz, const char* mask);
170 bool WildcardMatch(const std::string& str, const std::string& mask);
171 int GetFilesize(FILE* file);
172 boost::filesystem::path GetDefaultDataDir();
173 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
174 boost::filesystem::path GetConfigFile();
175 boost::filesystem::path GetPidFile();
176 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
177 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
178 bool GetStartOnSystemStartup();
179 bool SetStartOnSystemStartup(bool fAutoStart);
180 void ShrinkDebugFile();
181 int GetRandInt(int nMax);
182 uint64 GetRand(uint64 nMax);
183 uint256 GetRandHash();
185 void SetMockTime(int64 nMockTimeIn);
186 int64 GetAdjustedTime();
187 std::string FormatFullVersion();
188 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
189 void AddTimeData(const CNetAddr& ip, int64 nTime);
201 /** Wrapped boost mutex: supports recursive locking, but no waiting */
202 typedef boost::interprocess::interprocess_recursive_mutex CCriticalSection;
204 /** Wrapped boost mutex: supports waiting but not recursive locking */
205 typedef boost::interprocess::interprocess_mutex CWaitableCriticalSection;
207 #ifdef DEBUG_LOCKORDER
208 void EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false);
209 void LeaveCritical();
211 void static inline EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false) {}
212 void static inline LeaveCritical() {}
215 /** Wrapper around boost::interprocess::scoped_lock */
216 template<typename Mutex>
220 boost::interprocess::scoped_lock<Mutex> lock;
223 void Enter(const char* pszName, const char* pszFile, int nLine)
227 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()));
228 #ifdef DEBUG_LOCKCONTENTION
229 if (!lock.try_lock())
231 printf("LOCKCONTENTION: %s\n", pszName);
232 printf("Locker: %s:%d\n", pszFile, nLine);
235 #ifdef DEBUG_LOCKCONTENTION
250 bool TryEnter(const char* pszName, const char* pszFile, int nLine)
254 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()), true);
262 CMutexLock(Mutex& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) : lock(mutexIn, boost::interprocess::defer_lock)
265 TryEnter(pszName, pszFile, nLine);
267 Enter(pszName, pszFile, nLine);
281 boost::interprocess::scoped_lock<Mutex> &GetLock()
287 typedef CMutexLock<CCriticalSection> CCriticalBlock;
289 #define LOCK(cs) CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__)
290 #define LOCK2(cs1,cs2) CCriticalBlock criticalblock1(cs1, #cs1, __FILE__, __LINE__),criticalblock2(cs2, #cs2, __FILE__, __LINE__)
291 #define TRY_LOCK(cs,name) CCriticalBlock name(cs, #cs, __FILE__, __LINE__, true)
293 #define ENTER_CRITICAL_SECTION(cs) \
295 EnterCritical(#cs, __FILE__, __LINE__, (void*)(&cs)); \
299 #define LEAVE_CRITICAL_SECTION(cs) \
306 // boost::interprocess::interprocess_semaphore seems to spinlock on OSX; prefer polling instead
314 CSemaphore(int init) : val(init) {}
344 typedef boost::interprocess::interprocess_semaphore CSemaphore;
347 inline std::string i64tostr(int64 n)
349 return strprintf("%"PRI64d, n);
352 inline std::string itostr(int n)
354 return strprintf("%d", n);
357 inline int64 atoi64(const char* psz)
362 return strtoll(psz, NULL, 10);
366 inline int64 atoi64(const std::string& str)
369 return _atoi64(str.c_str());
371 return strtoll(str.c_str(), NULL, 10);
375 inline int atoi(const std::string& str)
377 return atoi(str.c_str());
380 inline int roundint(double d)
382 return (int)(d > 0 ? d + 0.5 : d - 0.5);
385 inline int64 roundint64(double d)
387 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
390 inline int64 abs64(int64 n)
392 return (n >= 0 ? n : -n);
396 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
398 std::vector<char> rv;
399 static char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
400 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
401 rv.reserve((itend-itbegin)*3);
402 for(T it = itbegin; it < itend; ++it)
404 unsigned char val = (unsigned char)(*it);
405 if(fSpaces && it != itbegin)
407 rv.push_back(hexmap[val>>4]);
408 rv.push_back(hexmap[val&15]);
411 return std::string(rv.begin(), rv.end());
414 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
416 return HexStr(vch.begin(), vch.end(), fSpaces);
420 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
422 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
425 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
427 printf(pszFormat, HexStr(vch, fSpaces).c_str());
430 inline int64 GetPerformanceCounter()
434 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
437 gettimeofday(&t, NULL);
438 nCounter = t.tv_sec * 1000000 + t.tv_usec;
443 inline int64 GetTimeMillis()
445 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
446 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
449 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
452 struct tm* ptmTime = gmtime(&n);
454 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
458 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
459 inline std::string DateTimeStrFormat(int64 nTime)
461 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
465 void skipspaces(T& it)
471 inline bool IsSwitchChar(char c)
474 return c == '-' || c == '/';
481 * Return string argument or default value
483 * @param strArg Argument to get (e.g. "-foo")
484 * @param default (e.g. "1")
485 * @return command-line argument or default value
487 std::string GetArg(const std::string& strArg, const std::string& strDefault);
490 * Return integer argument or default value
492 * @param strArg Argument to get (e.g. "-foo")
493 * @param default (e.g. 1)
494 * @return command-line argument (0 if invalid number) or default value
496 int64 GetArg(const std::string& strArg, int64 nDefault);
499 * Return boolean argument or default value
501 * @param strArg Argument to get (e.g. "-foo")
502 * @param default (true or false)
503 * @return command-line argument or default value
505 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
508 * Set an argument if it doesn't already have a value
510 * @param strArg Argument to set (e.g. "-foo")
511 * @param strValue Value (e.g. "1")
512 * @return true if argument gets set, false if it already had a value
514 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
517 * Set a boolean argument if it doesn't already have a value
519 * @param strArg Argument to set (e.g. "-foo")
520 * @param fValue Value (e.g. false)
521 * @return true if argument gets set, false if it already had a value
523 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
533 // Randomize the stack to help protect against buffer overrun exploits
534 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn) \
536 static char nLoops; \
538 nLoops = GetRand(20) + 1; \
547 template<typename T1>
548 inline uint256 Hash(const T1 pbegin, const T1 pend)
550 static unsigned char pblank[1];
552 SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
554 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
558 template<typename T1, typename T2>
559 inline uint256 Hash(const T1 p1begin, const T1 p1end,
560 const T2 p2begin, const T2 p2end)
562 static unsigned char pblank[1];
566 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
567 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
568 SHA256_Final((unsigned char*)&hash1, &ctx);
570 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
574 template<typename T1, typename T2, typename T3>
575 inline uint256 Hash(const T1 p1begin, const T1 p1end,
576 const T2 p2begin, const T2 p2end,
577 const T3 p3begin, const T3 p3end)
579 static unsigned char pblank[1];
583 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
584 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
585 SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
586 SHA256_Final((unsigned char*)&hash1, &ctx);
588 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
593 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
595 // Most of the time is spent allocating and deallocating CDataStream's
596 // buffer. If this ever needs to be optimized further, make a CStaticStream
597 // class with its buffer on the stack.
598 CDataStream ss(nType, nVersion);
601 return Hash(ss.begin(), ss.end());
604 inline uint160 Hash160(const std::vector<unsigned char>& vch)
607 SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
609 RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
614 /** Median filter over a stream of values.
615 * Returns the median of the last N numbers
617 template <typename T> class CMedianFilter
620 std::vector<T> vValues;
621 std::vector<T> vSorted;
624 CMedianFilter(unsigned int size, T initial_value):
627 vValues.reserve(size);
628 vValues.push_back(initial_value);
634 if(vValues.size() == nSize)
636 vValues.erase(vValues.begin());
638 vValues.push_back(value);
640 vSorted.resize(vValues.size());
641 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
642 std::sort(vSorted.begin(), vSorted.end());
647 int size = vSorted.size();
649 if(size & 1) // Odd number of elements
651 return vSorted[size/2];
653 else // Even number of elements
655 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
661 return vValues.size();
664 std::vector<T> sorted () const
679 // Note: It turns out we might have been able to use boost::thread
680 // by using TerminateThread(boost::thread.native_handle(), 0);
682 typedef HANDLE bitcoin_pthread_t;
684 inline bitcoin_pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
689 NULL, // default security
690 0, // inherit stack size from parent
691 (LPTHREAD_START_ROUTINE)pfn, // function pointer
693 0, // creation option, start immediately
694 &nUnused); // thread identifier
697 printf("Error: CreateThread() returned %d\n", GetLastError());
698 return (bitcoin_pthread_t)0;
702 CloseHandle(hthread);
703 return (bitcoin_pthread_t)-1;
708 inline void SetThreadPriority(int nPriority)
710 SetThreadPriority(GetCurrentThread(), nPriority);
713 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
715 pthread_t hthread = 0;
716 int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
719 printf("Error: pthread_create() returned %d\n", ret);
724 pthread_detach(hthread);
725 return (pthread_t)-1;
730 #define THREAD_PRIORITY_LOWEST PRIO_MAX
731 #define THREAD_PRIORITY_BELOW_NORMAL 2
732 #define THREAD_PRIORITY_NORMAL 0
733 #define THREAD_PRIORITY_ABOVE_NORMAL 0
735 inline void SetThreadPriority(int nPriority)
737 // It's unclear if it's even possible to change thread priorities on Linux,
738 // but we really and truly need it for the generation threads.
740 setpriority(PRIO_THREAD, 0, nPriority);
742 setpriority(PRIO_PROCESS, 0, nPriority);
746 inline void ExitThread(size_t nExitCode)
748 pthread_exit((void*)nExitCode);
756 inline uint32_t ByteReverse(uint32_t value)
758 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
759 return (value<<16) | (value>>16);