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
54 #define snprintf my_snprintf
57 #if defined(_MSC_VER) || defined(__MSVCRT__)
68 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
69 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
71 // Align by increasing pointer, must have extra space at end of buffer
72 template <size_t nBytes, typename T>
81 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
86 #define MSG_NOSIGNAL 0
87 #define MSG_DONTWAIT 0
93 #define unlink _unlink
95 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
96 #define strlwr(psz) to_lower(psz)
97 #define _strlwr(psz) to_lower(psz)
99 inline void Sleep(int64 n)
101 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
102 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
103 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
107 #ifndef THROW_WITH_STACKTRACE
108 #define THROW_WITH_STACKTRACE(exception) \
113 void LogStackTrace();
121 extern std::map<std::string, std::string> mapArgs;
122 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
124 extern bool fPrintToConsole;
125 extern bool fPrintToDebugger;
126 extern bool fRequestShutdown;
127 extern bool fShutdown;
130 extern bool fCommandLine;
131 extern std::string strMiscWarning;
132 extern bool fTestNet;
133 extern bool fNoListen;
134 extern bool fLogTimestamps;
137 void RandAddSeedPerfmon();
138 int OutputDebugStringF(const char* pszFormat, ...);
139 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
141 /* It is not allowed to use va_start with a pass-by-reference argument.
142 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
143 macro to keep similar semantics.
145 std::string real_strprintf(const std::string &format, int dummy, ...);
146 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
148 bool error(const char *format, ...);
149 void LogException(std::exception* pex, const char* pszThread);
150 void PrintException(std::exception* pex, const char* pszThread);
151 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
152 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
153 std::string FormatMoney(int64 n, bool fPlus=false);
154 bool ParseMoney(const std::string& str, int64& nRet);
155 bool ParseMoney(const char* pszIn, int64& nRet);
156 std::vector<unsigned char> ParseHex(const char* psz);
157 std::vector<unsigned char> ParseHex(const std::string& str);
158 bool IsHex(const std::string& str);
159 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
160 std::string DecodeBase64(const std::string& str);
161 std::string EncodeBase64(const unsigned char* pch, size_t len);
162 std::string EncodeBase64(const std::string& str);
163 void ParseParameters(int argc, const char*const argv[]);
164 bool WildcardMatch(const char* psz, const char* mask);
165 bool WildcardMatch(const std::string& str, const std::string& mask);
166 int GetFilesize(FILE* file);
167 boost::filesystem::path GetDefaultDataDir();
168 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
169 boost::filesystem::path GetConfigFile();
170 boost::filesystem::path GetPidFile();
171 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
172 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
173 bool GetStartOnSystemStartup();
174 bool SetStartOnSystemStartup(bool fAutoStart);
175 void ShrinkDebugFile();
176 int GetRandInt(int nMax);
177 uint64 GetRand(uint64 nMax);
178 uint256 GetRandHash();
180 void SetMockTime(int64 nMockTimeIn);
181 int64 GetAdjustedTime();
182 std::string FormatFullVersion();
183 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
184 void AddTimeData(const CNetAddr& ip, int64 nTime);
196 /** Wrapped boost mutex: supports recursive locking, but no waiting */
197 typedef boost::interprocess::interprocess_recursive_mutex CCriticalSection;
199 /** Wrapped boost mutex: supports waiting but not recursive locking */
200 typedef boost::interprocess::interprocess_mutex CWaitableCriticalSection;
202 #ifdef DEBUG_LOCKORDER
203 void EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false);
204 void LeaveCritical();
206 void static inline EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false) {}
207 void static inline LeaveCritical() {}
210 /** Wrapper around boost::interprocess::scoped_lock */
211 template<typename Mutex>
215 boost::interprocess::scoped_lock<Mutex> lock;
218 void Enter(const char* pszName, const char* pszFile, int nLine)
222 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()));
223 #ifdef DEBUG_LOCKCONTENTION
224 if (!lock.try_lock())
226 printf("LOCKCONTENTION: %s\n", pszName);
227 printf("Locker: %s:%d\n", pszFile, nLine);
230 #ifdef DEBUG_LOCKCONTENTION
245 bool TryEnter(const char* pszName, const char* pszFile, int nLine)
249 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()), true);
257 CMutexLock(Mutex& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) : lock(mutexIn, boost::interprocess::defer_lock)
260 TryEnter(pszName, pszFile, nLine);
262 Enter(pszName, pszFile, nLine);
276 boost::interprocess::scoped_lock<Mutex> &GetLock()
282 typedef CMutexLock<CCriticalSection> CCriticalBlock;
284 #define LOCK(cs) CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__)
285 #define LOCK2(cs1,cs2) CCriticalBlock criticalblock1(cs1, #cs1, __FILE__, __LINE__),criticalblock2(cs2, #cs2, __FILE__, __LINE__)
286 #define TRY_LOCK(cs,name) CCriticalBlock name(cs, #cs, __FILE__, __LINE__, true)
288 #define ENTER_CRITICAL_SECTION(cs) \
290 EnterCritical(#cs, __FILE__, __LINE__, (void*)(&cs)); \
294 #define LEAVE_CRITICAL_SECTION(cs) \
301 // boost::interprocess::interprocess_semaphore seems to spinlock on OSX; prefer polling instead
309 CSemaphore(int init) : val(init) {}
339 typedef boost::interprocess::interprocess_semaphore CSemaphore;
342 inline std::string i64tostr(int64 n)
344 return strprintf("%"PRI64d, n);
347 inline std::string itostr(int n)
349 return strprintf("%d", n);
352 inline int64 atoi64(const char* psz)
357 return strtoll(psz, NULL, 10);
361 inline int64 atoi64(const std::string& str)
364 return _atoi64(str.c_str());
366 return strtoll(str.c_str(), NULL, 10);
370 inline int atoi(const std::string& str)
372 return atoi(str.c_str());
375 inline int roundint(double d)
377 return (int)(d > 0 ? d + 0.5 : d - 0.5);
380 inline int64 roundint64(double d)
382 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
385 inline int64 abs64(int64 n)
387 return (n >= 0 ? n : -n);
391 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
393 std::vector<char> rv;
394 static char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
395 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
396 rv.reserve((itend-itbegin)*3);
397 for(T it = itbegin; it < itend; ++it)
399 unsigned char val = (unsigned char)(*it);
400 if(fSpaces && it != itbegin)
402 rv.push_back(hexmap[val>>4]);
403 rv.push_back(hexmap[val&15]);
406 return std::string(rv.begin(), rv.end());
409 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
411 return HexStr(vch.begin(), vch.end(), fSpaces);
415 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
417 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
420 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
422 printf(pszFormat, HexStr(vch, fSpaces).c_str());
425 inline int64 GetPerformanceCounter()
429 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
432 gettimeofday(&t, NULL);
433 nCounter = t.tv_sec * 1000000 + t.tv_usec;
438 inline int64 GetTimeMillis()
440 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
441 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
444 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
447 struct tm* ptmTime = gmtime(&n);
449 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
454 void skipspaces(T& it)
460 inline bool IsSwitchChar(char c)
463 return c == '-' || c == '/';
470 * Return string argument or default value
472 * @param strArg Argument to get (e.g. "-foo")
473 * @param default (e.g. "1")
474 * @return command-line argument or default value
476 std::string GetArg(const std::string& strArg, const std::string& strDefault);
479 * Return integer argument or default value
481 * @param strArg Argument to get (e.g. "-foo")
482 * @param default (e.g. 1)
483 * @return command-line argument (0 if invalid number) or default value
485 int64 GetArg(const std::string& strArg, int64 nDefault);
488 * Return boolean argument or default value
490 * @param strArg Argument to get (e.g. "-foo")
491 * @param default (true or false)
492 * @return command-line argument or default value
494 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
497 * Set an argument if it doesn't already have a value
499 * @param strArg Argument to set (e.g. "-foo")
500 * @param strValue Value (e.g. "1")
501 * @return true if argument gets set, false if it already had a value
503 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
506 * Set a boolean argument if it doesn't already have a value
508 * @param strArg Argument to set (e.g. "-foo")
509 * @param fValue Value (e.g. false)
510 * @return true if argument gets set, false if it already had a value
512 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
522 // Randomize the stack to help protect against buffer overrun exploits
523 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn) \
525 static char nLoops; \
527 nLoops = GetRand(20) + 1; \
536 template<typename T1>
537 inline uint256 Hash(const T1 pbegin, const T1 pend)
539 static unsigned char pblank[1];
541 SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
543 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
547 template<typename T1, typename T2>
548 inline uint256 Hash(const T1 p1begin, const T1 p1end,
549 const T2 p2begin, const T2 p2end)
551 static unsigned char pblank[1];
555 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
556 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
557 SHA256_Final((unsigned char*)&hash1, &ctx);
559 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
563 template<typename T1, typename T2, typename T3>
564 inline uint256 Hash(const T1 p1begin, const T1 p1end,
565 const T2 p2begin, const T2 p2end,
566 const T3 p3begin, const T3 p3end)
568 static unsigned char pblank[1];
572 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
573 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
574 SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
575 SHA256_Final((unsigned char*)&hash1, &ctx);
577 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
582 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
584 // Most of the time is spent allocating and deallocating CDataStream's
585 // buffer. If this ever needs to be optimized further, make a CStaticStream
586 // class with its buffer on the stack.
587 CDataStream ss(nType, nVersion);
590 return Hash(ss.begin(), ss.end());
593 inline uint160 Hash160(const std::vector<unsigned char>& vch)
596 SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
598 RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
603 /** Median filter over a stream of values.
604 * Returns the median of the last N numbers
606 template <typename T> class CMedianFilter
609 std::vector<T> vValues;
610 std::vector<T> vSorted;
613 CMedianFilter(unsigned int size, T initial_value):
616 vValues.reserve(size);
617 vValues.push_back(initial_value);
623 if(vValues.size() == nSize)
625 vValues.erase(vValues.begin());
627 vValues.push_back(value);
629 vSorted.resize(vValues.size());
630 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
631 std::sort(vSorted.begin(), vSorted.end());
636 int size = vSorted.size();
638 if(size & 1) // Odd number of elements
640 return vSorted[size/2];
642 else // Even number of elements
644 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
650 return vValues.size();
653 std::vector<T> sorted () const
668 // Note: It turns out we might have been able to use boost::thread
669 // by using TerminateThread(boost::thread.native_handle(), 0);
671 typedef HANDLE bitcoin_pthread_t;
673 inline bitcoin_pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
678 NULL, // default security
679 0, // inherit stack size from parent
680 (LPTHREAD_START_ROUTINE)pfn, // function pointer
682 0, // creation option, start immediately
683 &nUnused); // thread identifier
686 printf("Error: CreateThread() returned %d\n", GetLastError());
687 return (bitcoin_pthread_t)0;
691 CloseHandle(hthread);
692 return (bitcoin_pthread_t)-1;
697 inline void SetThreadPriority(int nPriority)
699 SetThreadPriority(GetCurrentThread(), nPriority);
702 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
704 pthread_t hthread = 0;
705 int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
708 printf("Error: pthread_create() returned %d\n", ret);
713 pthread_detach(hthread);
714 return (pthread_t)-1;
719 #define THREAD_PRIORITY_LOWEST PRIO_MAX
720 #define THREAD_PRIORITY_BELOW_NORMAL 2
721 #define THREAD_PRIORITY_NORMAL 0
722 #define THREAD_PRIORITY_ABOVE_NORMAL 0
724 inline void SetThreadPriority(int nPriority)
726 // It's unclear if it's even possible to change thread priorities on Linux,
727 // but we really and truly need it for the generation threads.
729 setpriority(PRIO_THREAD, 0, nPriority);
731 setpriority(PRIO_PROCESS, 0, nPriority);
735 inline void ExitThread(size_t nExitCode)
737 pthread_exit((void*)nExitCode);
745 inline uint32_t ByteReverse(uint32_t value)
747 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
748 return (value<<16) | (value>>16);