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.
12 #include <sys/types.h>
14 #include <sys/resource.h>
22 #include <boost/thread.hpp>
23 #include <boost/filesystem.hpp>
24 #include <boost/filesystem/path.hpp>
25 #include <boost/date_time/gregorian/gregorian_types.hpp>
26 #include <boost/date_time/posix_time/posix_time_types.hpp>
31 #if defined(__USE_MINGW_ANSI_STDIO)
32 #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior
36 #include "netbase.h" // for AddTimeData
39 static const int64_t COIN = 1000000;
40 static const int64_t CENT = 10000;
42 #define BEGIN(a) ((char*)&(a))
43 #define END(a) ((char*)&((&(a))[1]))
44 #define UBEGIN(a) ((unsigned char*)&(a))
45 #define UEND(a) ((unsigned char*)&((&(a))[1]))
46 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
48 #define UVOIDBEGIN(a) ((void*)&(a))
49 #define CVOIDBEGIN(a) ((const void*)&(a))
50 #define UINTBEGIN(a) ((uint32_t*)&(a))
51 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
53 #ifndef THROW_WITH_STACKTRACE
54 #define THROW_WITH_STACKTRACE(exception) \
63 /* Format characters for (s)size_t and ptrdiff_t */
64 #if defined(_MSC_VER) || defined(__MSVCRT__)
65 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
66 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
74 #else /* C99 standard */
83 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
84 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
86 // Align by increasing pointer, must have extra space at end of buffer
87 template <size_t nBytes, typename T>
96 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
101 #define MSG_NOSIGNAL 0
102 #define MSG_DONTWAIT 0
109 #define MAX_PATH 1024
110 inline void Sleep(int64_t n)
112 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
113 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
114 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
118 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
119 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
120 * Parameters count from 1.
123 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
125 #define ATTR_WARN_PRINTF(X,Y)
135 extern std::map<std::string, std::string> mapArgs;
136 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
138 extern bool fDebugNet;
139 extern bool fPrintToConsole;
140 extern bool fPrintToDebugger;
141 extern bool fRequestShutdown;
142 extern bool fShutdown;
145 extern bool fCommandLine;
146 extern std::string strMiscWarning;
147 extern bool fTestNet;
148 extern bool fNoListen;
149 extern bool fLogTimestamps;
150 extern bool fReopenDebugLog;
153 void RandAddSeedPerfmon();
154 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
157 Rationale for the real_strprintf / strprintf construction:
158 It is not allowed to use va_start with a pass-by-reference argument.
159 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
160 macro to keep similar semantics.
163 /** Overload strprintf for char*, so that GCC format type warnings can be given */
164 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
165 /** Overload strprintf for std::string, to be able to use it with _ (translation).
166 * This will not support GCC format type warnings (-Wformat) so be careful.
168 std::string real_strprintf(const std::string &format, int dummy, ...);
169 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
170 std::string vstrprintf(const char *format, va_list ap);
172 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
174 /* Redefine printf so that it directs output to debug.log
176 * Do this *after* defining the other printf-like functions, because otherwise the
177 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
178 * which confuses gcc.
180 #define printf OutputDebugStringF
182 void LogException(std::exception* pex, const char* pszThread);
183 void PrintException(std::exception* pex, const char* pszThread);
184 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
185 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
186 std::string FormatMoney(int64_t n, bool fPlus=false);
187 bool ParseMoney(const std::string& str, int64_t& nRet);
188 bool ParseMoney(const char* pszIn, int64_t& nRet);
189 std::vector<unsigned char> ParseHex(const char* psz);
190 std::vector<unsigned char> ParseHex(const std::string& str);
191 bool IsHex(const std::string& str);
192 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
193 std::string DecodeBase64(const std::string& str);
194 std::string EncodeBase64(const unsigned char* pch, size_t len);
195 std::string EncodeBase64(const std::string& str);
196 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
197 std::string DecodeBase32(const std::string& str);
198 std::string EncodeBase32(const unsigned char* pch, size_t len);
199 std::string EncodeBase32(const std::string& str);
200 std::string EncodeDumpTime(int64_t nTime);
201 int64_t DecodeDumpTime(const std::string& s);
202 std::string EncodeDumpString(const std::string &str);
203 std::string DecodeDumpString(const std::string &str);
204 void ParseParameters(int argc, const char*const argv[]);
205 bool WildcardMatch(const char* psz, const char* mask);
206 bool WildcardMatch(const std::string& str, const std::string& mask);
207 void FileCommit(FILE *fileout);
208 int GetFilesize(FILE* file);
209 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
210 boost::filesystem::path GetDefaultDataDir();
211 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
212 boost::filesystem::path GetConfigFile();
213 boost::filesystem::path GetPidFile();
215 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
217 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
219 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
221 void ShrinkDebugFile();
222 int GetRandInt(int nMax);
223 uint64_t GetRand(uint64_t nMax);
224 uint256 GetRandHash();
226 void SetMockTime(int64_t nMockTimeIn);
227 int64_t GetAdjustedTime();
228 int64_t GetTimeOffset();
229 std::string FormatFullVersion();
230 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
231 void AddTimeData(const CNetAddr& ip, int64_t nTime);
232 void runCommand(std::string strCommand);
242 inline std::string i64tostr(int64_t n)
244 return strprintf("%" PRId64, n);
247 inline std::string itostr(int n)
249 return strprintf("%d", n);
252 inline int64_t atoi64(const char* psz)
257 return strtoll(psz, NULL, 10);
261 inline int64_t atoi64(const std::string& str)
264 return _atoi64(str.c_str());
266 return strtoll(str.c_str(), NULL, 10);
270 inline int atoi(const std::string& str)
272 return atoi(str.c_str());
275 inline int roundint(double d)
277 return (int)(d > 0 ? d + 0.5 : d - 0.5);
280 inline int64_t roundint64(double d)
282 return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
285 inline int64_t abs64(int64_t n)
287 return (n >= 0 ? n : -n);
290 inline std::string leftTrim(std::string src, char chr)
292 std::string::size_type pos = src.find_first_not_of(chr, 0);
301 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
304 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
305 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
306 rv.reserve((itend-itbegin)*3);
307 for(T it = itbegin; it < itend; ++it)
309 unsigned char val = (unsigned char)(*it);
310 if(fSpaces && it != itbegin)
312 rv.push_back(hexmap[val>>4]);
313 rv.push_back(hexmap[val&15]);
319 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
321 return HexStr(vch.begin(), vch.end(), fSpaces);
325 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
327 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
330 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
332 printf(pszFormat, HexStr(vch, fSpaces).c_str());
335 inline int64_t GetPerformanceCounter()
337 int64_t nCounter = 0;
339 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
342 gettimeofday(&t, NULL);
343 nCounter = (int64_t) t.tv_sec * 1000000 + t.tv_usec;
348 inline int64_t GetTimeMillis()
350 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
351 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
354 inline std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime)
357 struct tm* ptmTime = gmtime(&n);
359 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
363 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
364 inline std::string DateTimeStrFormat(int64_t nTime)
366 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
371 void skipspaces(T& it)
377 inline bool IsSwitchChar(char c)
380 return c == '-' || c == '/';
387 * Return string argument or default value
389 * @param strArg Argument to get (e.g. "-foo")
390 * @param default (e.g. "1")
391 * @return command-line argument or default value
393 std::string GetArg(const std::string& strArg, const std::string& strDefault);
396 * Return integer argument or default value
398 * @param strArg Argument to get (e.g. "-foo")
399 * @param default (e.g. 1)
400 * @return command-line argument (0 if invalid number) or default value
402 int64_t GetArg(const std::string& strArg, int64_t nDefault);
405 * Return boolean argument or default value
407 * @param strArg Argument to get (e.g. "-foo")
408 * @param default (true or false)
409 * @return command-line argument or default value
411 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
414 * Set an argument if it doesn't already have a value
416 * @param strArg Argument to set (e.g. "-foo")
417 * @param strValue Value (e.g. "1")
418 * @return true if argument gets set, false if it already had a value
420 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
423 * Set a boolean argument if it doesn't already have a value
425 * @param strArg Argument to set (e.g. "-foo")
426 * @param fValue Value (e.g. false)
427 * @return true if argument gets set, false if it already had a value
429 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
432 * Timing-attack-resistant comparison.
433 * Takes time proportional to length
436 template <typename T>
437 bool TimingResistantEqual(const T& a, const T& b)
439 if (b.size() == 0) return a.size() == 0;
440 size_t accumulator = a.size() ^ b.size();
441 for (size_t i = 0; i < a.size(); i++)
442 accumulator |= a[i] ^ b[i%b.size()];
443 return accumulator == 0;
446 /** Median filter over a stream of values.
447 * Returns the median of the last N numbers
449 template <typename T> class CMedianFilter
452 std::vector<T> vValues;
453 std::vector<T> vSorted;
456 CMedianFilter(unsigned int size, T initial_value):
459 vValues.reserve(size);
460 vValues.push_back(initial_value);
466 if(vValues.size() == nSize)
468 vValues.erase(vValues.begin());
470 vValues.push_back(value);
472 vSorted.resize(vValues.size());
473 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
474 std::sort(vSorted.begin(), vSorted.end());
479 int size = vSorted.size();
481 if(size & 1) // Odd number of elements
483 return vSorted[size/2];
485 else // Even number of elements
487 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
493 return vValues.size();
496 std::vector<T> sorted () const
502 bool NewThread(void(*pfn)(void*), void* parg);
505 inline void SetThreadPriority(int nPriority)
507 SetThreadPriority(GetCurrentThread(), nPriority);
511 #define THREAD_PRIORITY_LOWEST PRIO_MAX
512 #define THREAD_PRIORITY_BELOW_NORMAL 2
513 #define THREAD_PRIORITY_NORMAL 0
514 #define THREAD_PRIORITY_ABOVE_NORMAL 0
516 inline void SetThreadPriority(int nPriority)
518 // It's unclear if it's even possible to change thread priorities on Linux,
519 // but we really and truly need it for the generation threads.
521 setpriority(PRIO_THREAD, 0, nPriority);
523 setpriority(PRIO_PROCESS, 0, nPriority);
527 inline void ExitThread(size_t nExitCode)
529 pthread_exit((void*)nExitCode);
533 void RenameThread(const char* name);
535 inline uint32_t ByteReverse(uint32_t value)
537 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
538 return (value<<16) | (value>>16);