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 COPYING or http://www.opensource.org/licenses/mit-license.php.
11 #include <sys/types.h>
13 #include <sys/resource.h>
20 #include <boost/thread.hpp>
21 #include <boost/filesystem.hpp>
22 #include <boost/filesystem/path.hpp>
23 #include <boost/date_time/gregorian/gregorian_types.hpp>
24 #include <boost/date_time/posix_time/posix_time_types.hpp>
26 #include <openssl/sha.h>
27 #include <openssl/ripemd.h>
29 #include "netbase.h" // for AddTimeData
31 typedef long long int64;
32 typedef unsigned long long uint64;
34 static const int64 COIN = 1000000;
35 static const int64 CENT = 10000;
37 #define BEGIN(a) ((char*)&(a))
38 #define END(a) ((char*)&((&(a))[1]))
39 #define UBEGIN(a) ((unsigned char*)&(a))
40 #define UEND(a) ((unsigned char*)&((&(a))[1]))
41 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
43 #define UVOIDBEGIN(a) ((void*)&(a))
44 #define CVOIDBEGIN(a) ((const void*)&(a))
45 #define UINTBEGIN(a) ((uint32_t*)&(a))
46 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
49 #if defined(_MSC_VER) || defined(__MSVCRT__)
60 #ifndef THROW_WITH_STACKTRACE
61 #define THROW_WITH_STACKTRACE(exception) \
70 /* Format characters for (s)size_t and ptrdiff_t */
71 #if defined(_MSC_VER) || defined(__MSVCRT__)
72 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
73 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
81 #else /* C99 standard */
90 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
91 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
93 // Align by increasing pointer, must have extra space at end of buffer
94 template <size_t nBytes, typename T>
103 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
108 #define MSG_NOSIGNAL 0
109 #define MSG_DONTWAIT 0
116 #define MAX_PATH 1024
117 inline void Sleep(int64 n)
119 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
120 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
121 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
125 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
126 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
127 * Parameters count from 1.
130 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
132 #define ATTR_WARN_PRINTF(X,Y)
142 extern std::map<std::string, std::string> mapArgs;
143 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
145 extern bool fDebugNet;
146 extern bool fPrintToConsole;
147 extern bool fPrintToDebugger;
148 extern bool fRequestShutdown;
149 extern bool fShutdown;
152 extern bool fCommandLine;
153 extern std::string strMiscWarning;
154 extern bool fTestNet;
155 extern bool fNoListen;
156 extern bool fLogTimestamps;
157 extern bool fReopenDebugLog;
160 void RandAddSeedPerfmon();
161 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
164 Rationale for the real_strprintf / strprintf construction:
165 It is not allowed to use va_start with a pass-by-reference argument.
166 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
167 macro to keep similar semantics.
170 /** Overload strprintf for char*, so that GCC format type warnings can be given */
171 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
172 /** Overload strprintf for std::string, to be able to use it with _ (translation).
173 * This will not support GCC format type warnings (-Wformat) so be careful.
175 std::string real_strprintf(const std::string &format, int dummy, ...);
176 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
177 std::string vstrprintf(const char *format, va_list ap);
179 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
181 /* Redefine printf so that it directs output to debug.log
183 * Do this *after* defining the other printf-like functions, because otherwise the
184 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
185 * which confuses gcc.
187 #define printf OutputDebugStringF
189 void LogException(std::exception* pex, const char* pszThread);
190 void PrintException(std::exception* pex, const char* pszThread);
191 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
192 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
193 std::string FormatMoney(int64 n, bool fPlus=false);
194 bool ParseMoney(const std::string& str, int64& nRet);
195 bool ParseMoney(const char* pszIn, int64& nRet);
196 std::vector<unsigned char> ParseHex(const char* psz);
197 std::vector<unsigned char> ParseHex(const std::string& str);
198 bool IsHex(const std::string& str);
199 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
200 std::string DecodeBase64(const std::string& str);
201 std::string EncodeBase64(const unsigned char* pch, size_t len);
202 std::string EncodeBase64(const std::string& str);
203 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
204 std::string DecodeBase32(const std::string& str);
205 std::string EncodeBase32(const unsigned char* pch, size_t len);
206 std::string EncodeBase32(const std::string& str);
207 std::string EncodeDumpTime(int64 nTime);
208 int64 DecodeDumpTime(const std::string& s);
209 std::string EncodeDumpString(const std::string &str);
210 std::string DecodeDumpString(const std::string &str);
211 void ParseParameters(int argc, const char*const argv[]);
212 bool WildcardMatch(const char* psz, const char* mask);
213 bool WildcardMatch(const std::string& str, const std::string& mask);
214 void FileCommit(FILE *fileout);
215 int GetFilesize(FILE* file);
216 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
217 boost::filesystem::path GetDefaultDataDir();
218 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
219 boost::filesystem::path GetConfigFile();
220 boost::filesystem::path GetPidFile();
222 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
224 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
226 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
228 void ShrinkDebugFile();
229 int GetRandInt(int nMax);
230 uint64 GetRand(uint64 nMax);
231 uint256 GetRandHash();
233 void SetMockTime(int64 nMockTimeIn);
234 int64 GetAdjustedTime();
235 int64 GetTimeOffset();
236 std::string FormatFullVersion();
237 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
238 void AddTimeData(const CNetAddr& ip, int64 nTime);
239 void runCommand(std::string strCommand);
249 inline std::string i64tostr(int64 n)
251 return strprintf("%"PRI64d, n);
254 inline std::string itostr(int n)
256 return strprintf("%d", n);
259 inline int64 atoi64(const char* psz)
264 return strtoll(psz, NULL, 10);
268 inline int64 atoi64(const std::string& str)
271 return _atoi64(str.c_str());
273 return strtoll(str.c_str(), NULL, 10);
277 inline int atoi(const std::string& str)
279 return atoi(str.c_str());
282 inline int roundint(double d)
284 return (int)(d > 0 ? d + 0.5 : d - 0.5);
287 inline int64 roundint64(double d)
289 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
292 inline int64 abs64(int64 n)
294 return (n >= 0 ? n : -n);
297 inline std::string leftTrim(std::string src, char chr)
299 std::string::size_type pos = src.find_first_not_of(chr, 0);
308 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
311 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
312 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
313 rv.reserve((itend-itbegin)*3);
314 for(T it = itbegin; it < itend; ++it)
316 unsigned char val = (unsigned char)(*it);
317 if(fSpaces && it != itbegin)
319 rv.push_back(hexmap[val>>4]);
320 rv.push_back(hexmap[val&15]);
326 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
328 return HexStr(vch.begin(), vch.end(), fSpaces);
332 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
334 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
337 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
339 printf(pszFormat, HexStr(vch, fSpaces).c_str());
342 inline int64 GetPerformanceCounter()
346 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
349 gettimeofday(&t, NULL);
350 nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec;
355 inline int64 GetTimeMillis()
357 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
358 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
361 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
364 struct tm* ptmTime = gmtime(&n);
366 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
370 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
371 inline std::string DateTimeStrFormat(int64 nTime)
373 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
378 void skipspaces(T& it)
384 inline bool IsSwitchChar(char c)
387 return c == '-' || c == '/';
394 * Return string argument or default value
396 * @param strArg Argument to get (e.g. "-foo")
397 * @param default (e.g. "1")
398 * @return command-line argument or default value
400 std::string GetArg(const std::string& strArg, const std::string& strDefault);
403 * Return integer argument or default value
405 * @param strArg Argument to get (e.g. "-foo")
406 * @param default (e.g. 1)
407 * @return command-line argument (0 if invalid number) or default value
409 int64 GetArg(const std::string& strArg, int64 nDefault);
412 * Return boolean argument or default value
414 * @param strArg Argument to get (e.g. "-foo")
415 * @param default (true or false)
416 * @return command-line argument or default value
418 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
421 * Set an argument if it doesn't already have a value
423 * @param strArg Argument to set (e.g. "-foo")
424 * @param strValue Value (e.g. "1")
425 * @return true if argument gets set, false if it already had a value
427 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
430 * Set a boolean argument if it doesn't already have a value
432 * @param strArg Argument to set (e.g. "-foo")
433 * @param fValue Value (e.g. false)
434 * @return true if argument gets set, false if it already had a value
436 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
446 template<typename T1>
447 inline uint256 Hash(const T1 pbegin, const T1 pend)
449 static unsigned char pblank[1];
451 SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
453 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
470 CHashWriter(int nTypeIn, int nVersionIn) : nType(nTypeIn), nVersion(nVersionIn) {
474 CHashWriter& write(const char *pch, size_t size) {
475 SHA256_Update(&ctx, pch, size);
479 // invalidates the object
482 SHA256_Final((unsigned char*)&hash1, &ctx);
484 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
489 CHashWriter& operator<<(const T& obj) {
490 // Serialize to this stream
491 ::Serialize(*this, obj, nType, nVersion);
497 template<typename T1, typename T2>
498 inline uint256 Hash(const T1 p1begin, const T1 p1end,
499 const T2 p2begin, const T2 p2end)
501 static unsigned char pblank[1];
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);
509 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
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)
518 static unsigned char pblank[1];
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);
527 SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
532 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
534 CHashWriter ss(nType, nVersion);
539 inline uint160 Hash160(const std::vector<unsigned char>& vch)
542 SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
544 RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
549 * Timing-attack-resistant comparison.
550 * Takes time proportional to length
553 template <typename T>
554 bool TimingResistantEqual(const T& a, const T& b)
556 if (b.size() == 0) return a.size() == 0;
557 size_t accumulator = a.size() ^ b.size();
558 for (size_t i = 0; i < a.size(); i++)
559 accumulator |= a[i] ^ b[i%b.size()];
560 return accumulator == 0;
563 /** Median filter over a stream of values.
564 * Returns the median of the last N numbers
566 template <typename T> class CMedianFilter
569 std::vector<T> vValues;
570 std::vector<T> vSorted;
573 CMedianFilter(unsigned int size, T initial_value):
576 vValues.reserve(size);
577 vValues.push_back(initial_value);
583 if(vValues.size() == nSize)
585 vValues.erase(vValues.begin());
587 vValues.push_back(value);
589 vSorted.resize(vValues.size());
590 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
591 std::sort(vSorted.begin(), vSorted.end());
596 int size = vSorted.size();
598 if(size & 1) // Odd number of elements
600 return vSorted[size/2];
602 else // Even number of elements
604 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
610 return vValues.size();
613 std::vector<T> sorted () const
619 bool NewThread(void(*pfn)(void*), void* parg);
622 inline void SetThreadPriority(int nPriority)
624 SetThreadPriority(GetCurrentThread(), nPriority);
628 #define THREAD_PRIORITY_LOWEST PRIO_MAX
629 #define THREAD_PRIORITY_BELOW_NORMAL 2
630 #define THREAD_PRIORITY_NORMAL 0
631 #define THREAD_PRIORITY_ABOVE_NORMAL 0
633 inline void SetThreadPriority(int nPriority)
635 // It's unclear if it's even possible to change thread priorities on Linux,
636 // but we really and truly need it for the generation threads.
638 setpriority(PRIO_THREAD, 0, nPriority);
640 setpriority(PRIO_PROCESS, 0, nPriority);
644 inline void ExitThread(size_t nExitCode)
646 pthread_exit((void*)nExitCode);
650 void RenameThread(const char* name);
652 inline uint32_t ByteReverse(uint32_t value)
654 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
655 return (value<<16) | (value>>16);