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/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>
31 #include <openssl/sha.h>
32 #include <openssl/ripemd.h>
34 #include "netbase.h" // for AddTimeData
36 typedef long long int64;
37 typedef unsigned long long uint64;
39 static const int64 COIN = 100000000;
40 static const int64 CENT = 1000000;
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
53 #define snprintf my_snprintf
56 #if defined(_MSC_VER) || defined(__MSVCRT__)
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>
70 // Align by increasing pointer, must have extra space at end of buffer
71 template <size_t nBytes, typename T>
80 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
85 #define MSG_NOSIGNAL 0
86 #define MSG_DONTWAIT 0
92 #define unlink _unlink
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)
98 inline void Sleep(int64 n)
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));
114 extern std::map<std::string, std::string> mapArgs;
115 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
117 extern bool fPrintToConsole;
118 extern bool fPrintToDebugger;
119 extern bool fRequestShutdown;
120 extern bool fShutdown;
123 extern bool fCommandLine;
124 extern std::string strMiscWarning;
125 extern bool fTestNet;
126 extern bool fNoListen;
127 extern bool fLogTimestamps;
130 void RandAddSeedPerfmon();
131 int OutputDebugStringF(const char* pszFormat, ...);
132 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
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.
138 std::string real_strprintf(const std::string &format, int dummy, ...);
139 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
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 uint256 GetRandHash();
173 void SetMockTime(int64 nMockTimeIn);
174 int64 GetAdjustedTime();
175 std::string FormatFullVersion();
176 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
177 void AddTimeData(const CNetAddr& ip, int64 nTime);
189 /** Wrapped boost mutex: supports recursive locking, but no waiting */
190 typedef boost::interprocess::interprocess_recursive_mutex CCriticalSection;
192 /** Wrapped boost mutex: supports waiting but not recursive locking */
193 typedef boost::interprocess::interprocess_mutex CWaitableCriticalSection;
195 #ifdef DEBUG_LOCKORDER
196 void EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false);
197 void LeaveCritical();
199 void static inline EnterCritical(const char* pszName, const char* pszFile, int nLine, void* cs, bool fTry = false) {}
200 void static inline LeaveCritical() {}
203 /** Wrapper around boost::interprocess::scoped_lock */
204 template<typename Mutex>
208 boost::interprocess::scoped_lock<Mutex> lock;
211 void Enter(const char* pszName, const char* pszFile, int nLine)
215 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()));
216 #ifdef DEBUG_LOCKCONTENTION
217 if (!lock.try_lock())
219 printf("LOCKCONTENTION: %s\n", pszName);
220 printf("Locker: %s:%d\n", pszFile, nLine);
236 bool TryEnter(const char* pszName, const char* pszFile, int nLine)
240 EnterCritical(pszName, pszFile, nLine, (void*)(lock.mutex()), true);
248 CMutexLock(Mutex& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) : lock(mutexIn, boost::interprocess::defer_lock)
251 TryEnter(pszName, pszFile, nLine);
253 Enter(pszName, pszFile, nLine);
267 boost::interprocess::scoped_lock<Mutex> &GetLock()
273 typedef CMutexLock<CCriticalSection> CCriticalBlock;
275 #define LOCK(cs) CCriticalBlock criticalblock(cs, #cs, __FILE__, __LINE__)
276 #define LOCK2(cs1,cs2) CCriticalBlock criticalblock1(cs1, #cs1, __FILE__, __LINE__),criticalblock2(cs2, #cs2, __FILE__, __LINE__)
277 #define TRY_LOCK(cs,name) CCriticalBlock name(cs, #cs, __FILE__, __LINE__, true)
279 #define ENTER_CRITICAL_SECTION(cs) \
281 EnterCritical(#cs, __FILE__, __LINE__, (void*)(&cs)); \
285 #define LEAVE_CRITICAL_SECTION(cs) \
292 // boost::interprocess::interprocess_semaphore seems to spinlock on OSX; prefer polling instead
300 CSemaphore(int init) : val(init) {}
330 typedef boost::interprocess::interprocess_semaphore CSemaphore;
333 inline std::string i64tostr(int64 n)
335 return strprintf("%"PRI64d, n);
338 inline std::string itostr(int n)
340 return strprintf("%d", n);
343 inline int64 atoi64(const char* psz)
348 return strtoll(psz, NULL, 10);
352 inline int64 atoi64(const std::string& str)
355 return _atoi64(str.c_str());
357 return strtoll(str.c_str(), NULL, 10);
361 inline int atoi(const std::string& str)
363 return atoi(str.c_str());
366 inline int roundint(double d)
368 return (int)(d > 0 ? d + 0.5 : d - 0.5);
371 inline int64 roundint64(double d)
373 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
376 inline int64 abs64(int64 n)
378 return (n >= 0 ? n : -n);
382 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
384 std::vector<char> rv;
385 static char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
386 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
387 rv.reserve((itend-itbegin)*3);
388 for(T it = itbegin; it < itend; ++it)
390 unsigned char val = (unsigned char)(*it);
391 if(fSpaces && it != itbegin)
393 rv.push_back(hexmap[val>>4]);
394 rv.push_back(hexmap[val&15]);
397 return std::string(rv.begin(), rv.end());
400 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
402 return HexStr(vch.begin(), vch.end(), fSpaces);
406 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
408 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
411 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
413 printf(pszFormat, HexStr(vch, fSpaces).c_str());
416 inline int64 GetPerformanceCounter()
420 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
423 gettimeofday(&t, NULL);
424 nCounter = t.tv_sec * 1000000 + t.tv_usec;
429 inline int64 GetTimeMillis()
431 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
432 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
435 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
438 struct tm* ptmTime = gmtime(&n);
440 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
445 void skipspaces(T& it)
451 inline bool IsSwitchChar(char c)
454 return c == '-' || c == '/';
461 * Return string argument or default value
463 * @param strArg Argument to get (e.g. "-foo")
464 * @param default (e.g. "1")
465 * @return command-line argument or default value
467 std::string GetArg(const std::string& strArg, const std::string& strDefault);
470 * Return integer argument or default value
472 * @param strArg Argument to get (e.g. "-foo")
473 * @param default (e.g. 1)
474 * @return command-line argument (0 if invalid number) or default value
476 int64 GetArg(const std::string& strArg, int64 nDefault);
479 * Return boolean argument or default value
481 * @param strArg Argument to get (e.g. "-foo")
482 * @param default (true or false)
483 * @return command-line argument or default value
485 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
488 * Set an argument if it doesn't already have a value
490 * @param strArg Argument to set (e.g. "-foo")
491 * @param strValue Value (e.g. "1")
492 * @return true if argument gets set, false if it already had a value
494 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
497 * Set a boolean argument if it doesn't already have a value
499 * @param strArg Argument to set (e.g. "-foo")
500 * @param fValue Value (e.g. false)
501 * @return true if argument gets set, false if it already had a value
503 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
513 // Randomize the stack to help protect against buffer overrun exploits
514 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn) \
516 static char nLoops; \
518 nLoops = GetRand(20) + 1; \
527 template<typename T1>
528 inline uint256 Hash(const T1 pbegin, const T1 pend)
530 static unsigned char pblank[1];
532 SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
534 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
538 template<typename T1, typename T2>
539 inline uint256 Hash(const T1 p1begin, const T1 p1end,
540 const T2 p2begin, const T2 p2end)
542 static unsigned char pblank[1];
546 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
547 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
548 SHA256_Final((unsigned char*)&hash1, &ctx);
550 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
554 template<typename T1, typename T2, typename T3>
555 inline uint256 Hash(const T1 p1begin, const T1 p1end,
556 const T2 p2begin, const T2 p2end,
557 const T3 p3begin, const T3 p3end)
559 static unsigned char pblank[1];
563 SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
564 SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
565 SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
566 SHA256_Final((unsigned char*)&hash1, &ctx);
568 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
573 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
575 // Most of the time is spent allocating and deallocating CDataStream's
576 // buffer. If this ever needs to be optimized further, make a CStaticStream
577 // class with its buffer on the stack.
578 CDataStream ss(nType, nVersion);
581 return Hash(ss.begin(), ss.end());
584 inline uint160 Hash160(const std::vector<unsigned char>& vch)
587 SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
589 RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
594 /** Median filter over a stream of values.
595 * Returns the median of the last N numbers
597 template <typename T> class CMedianFilter
600 std::vector<T> vValues;
601 std::vector<T> vSorted;
604 CMedianFilter(unsigned int size, T initial_value):
607 vValues.reserve(size);
608 vValues.push_back(initial_value);
614 if(vValues.size() == nSize)
616 vValues.erase(vValues.begin());
618 vValues.push_back(value);
620 vSorted.resize(vValues.size());
621 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
622 std::sort(vSorted.begin(), vSorted.end());
627 int size = vSorted.size();
629 if(size & 1) // Odd number of elements
631 return vSorted[size/2];
633 else // Even number of elements
635 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
641 return vValues.size();
644 std::vector<T> sorted () const
659 // Note: It turns out we might have been able to use boost::thread
660 // by using TerminateThread(boost::thread.native_handle(), 0);
662 typedef HANDLE pthread_t;
664 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
669 NULL, // default security
670 0, // inherit stack size from parent
671 (LPTHREAD_START_ROUTINE)pfn, // function pointer
673 0, // creation option, start immediately
674 &nUnused); // thread identifier
677 printf("Error: CreateThread() returned %d\n", GetLastError());
682 CloseHandle(hthread);
683 return (pthread_t)-1;
688 inline void SetThreadPriority(int nPriority)
690 SetThreadPriority(GetCurrentThread(), nPriority);
693 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
695 pthread_t hthread = 0;
696 int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
699 printf("Error: pthread_create() returned %d\n", ret);
704 pthread_detach(hthread);
705 return (pthread_t)-1;
710 #define THREAD_PRIORITY_LOWEST PRIO_MAX
711 #define THREAD_PRIORITY_BELOW_NORMAL 2
712 #define THREAD_PRIORITY_NORMAL 0
713 #define THREAD_PRIORITY_ABOVE_NORMAL 0
715 inline void SetThreadPriority(int nPriority)
717 // It's unclear if it's even possible to change thread priorities on Linux,
718 // but we really and truly need it for the generation threads.
720 setpriority(PRIO_THREAD, 0, nPriority);
722 setpriority(PRIO_PROCESS, 0, nPriority);
726 inline void ExitThread(size_t nExitCode)
728 pthread_exit((void*)nExitCode);
736 inline uint32_t ByteReverse(uint32_t value)
738 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
739 return (value<<16) | (value>>16);