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
38 static const int32_t nOneHour = 60 * 60;
39 static const int32_t nOneDay = 24 * 60 * 60;
41 static const int64_t COIN = 1000000;
42 static const int64_t 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]))
50 #define UVOIDBEGIN(a) ((void*)&(a))
51 #define CVOIDBEGIN(a) ((const void*)&(a))
52 #define UINTBEGIN(a) ((uint32_t*)&(a))
53 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
55 #ifndef THROW_WITH_STACKTRACE
56 #define THROW_WITH_STACKTRACE(exception) \
65 /* Format characters for (s)size_t and ptrdiff_t */
66 #if defined(_MSC_VER) || defined(__MSVCRT__)
67 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
68 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
76 #else /* C99 standard */
85 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
86 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
88 // Align by increasing pointer, must have extra space at end of buffer
89 template <size_t nBytes, typename T>
98 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
103 #define MSG_NOSIGNAL 0
104 #define MSG_DONTWAIT 0
111 #define MAX_PATH 1024
112 inline void Sleep(int64_t n)
114 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
115 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
116 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
120 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
121 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
122 * Parameters count from 1.
125 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
127 #define ATTR_WARN_PRINTF(X,Y)
137 extern std::map<std::string, std::string> mapArgs;
138 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
140 extern bool fDebugNet;
141 extern bool fPrintToConsole;
142 extern bool fPrintToDebugger;
143 extern bool fRequestShutdown;
144 extern bool fShutdown;
147 extern bool fCommandLine;
148 extern std::string strMiscWarning;
149 extern bool fTestNet;
150 extern bool fNoListen;
151 extern bool fLogTimestamps;
152 extern bool fReopenDebugLog;
155 void RandAddSeedPerfmon();
156 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
159 Rationale for the real_strprintf / strprintf construction:
160 It is not allowed to use va_start with a pass-by-reference argument.
161 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
162 macro to keep similar semantics.
165 /** Overload strprintf for char*, so that GCC format type warnings can be given */
166 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
167 /** Overload strprintf for std::string, to be able to use it with _ (translation).
168 * This will not support GCC format type warnings (-Wformat) so be careful.
170 std::string real_strprintf(const std::string &format, int dummy, ...);
171 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
172 std::string vstrprintf(const char *format, va_list ap);
174 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
176 /* Redefine printf so that it directs output to debug.log
178 * Do this *after* defining the other printf-like functions, because otherwise the
179 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
180 * which confuses gcc.
182 #define printf OutputDebugStringF
184 void LogException(std::exception* pex, const char* pszThread);
185 void PrintException(std::exception* pex, const char* pszThread);
186 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
187 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
188 std::string FormatMoney(int64_t n, bool fPlus=false);
189 bool ParseMoney(const std::string& str, int64_t& nRet);
190 bool ParseMoney(const char* pszIn, int64_t& nRet);
191 std::vector<unsigned char> ParseHex(const char* psz);
192 std::vector<unsigned char> ParseHex(const std::string& str);
193 bool IsHex(const std::string& str);
194 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
195 std::string DecodeBase64(const std::string& str);
196 std::string EncodeBase64(const unsigned char* pch, size_t len);
197 std::string EncodeBase64(const std::string& str);
198 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
199 std::string DecodeBase32(const std::string& str);
200 std::string EncodeBase32(const unsigned char* pch, size_t len);
201 std::string EncodeBase32(const std::string& str);
202 std::string EncodeDumpTime(int64_t nTime);
203 int64_t DecodeDumpTime(const std::string& s);
204 std::string EncodeDumpString(const std::string &str);
205 std::string DecodeDumpString(const std::string &str);
206 void ParseParameters(int argc, const char*const argv[]);
207 bool WildcardMatch(const char* psz, const char* mask);
208 bool WildcardMatch(const std::string& str, const std::string& mask);
209 void FileCommit(FILE *fileout);
210 int GetFilesize(FILE* file);
211 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
212 boost::filesystem::path GetDefaultDataDir();
213 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
214 boost::filesystem::path GetConfigFile();
215 boost::filesystem::path GetPidFile();
217 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
219 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
221 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
223 void ShrinkDebugFile();
224 int GetRandInt(int nMax);
225 uint64_t GetRand(uint64_t nMax);
226 uint256 GetRandHash();
228 void SetMockTime(int64_t nMockTimeIn);
229 int64_t GetAdjustedTime();
230 int64_t GetTimeOffset();
231 int64_t GetNodesOffset();
232 std::string FormatFullVersion();
233 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
234 void AddTimeData(const CNetAddr& ip, int64_t nTime);
235 void runCommand(std::string strCommand);
245 inline std::string i64tostr(int64_t n)
247 return strprintf("%" PRId64, n);
250 inline std::string itostr(int n)
252 return strprintf("%d", n);
255 inline int64_t atoi64(const char* psz)
260 return strtoll(psz, NULL, 10);
264 inline int64_t atoi64(const std::string& str)
267 return _atoi64(str.c_str());
269 return strtoll(str.c_str(), NULL, 10);
273 inline int32_t strtol(const char* psz)
275 return strtol(psz, NULL, 10);
278 inline int32_t strtol(const std::string& str)
280 return strtol(str.c_str(), NULL, 10);
283 inline uint32_t strtoul(const char* psz)
285 return strtoul(psz, NULL, 10);
288 inline uint32_t strtoul(const std::string& str)
290 return strtoul(str.c_str(), NULL, 10);
293 inline int atoi(const std::string& str)
295 return atoi(str.c_str());
298 inline int roundint(double d)
300 return (int)(d > 0 ? d + 0.5 : d - 0.5);
303 inline int64_t roundint64(double d)
305 return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
308 inline int64_t abs64(int64_t n)
310 return (n >= 0 ? n : -n);
313 inline std::string leftTrim(std::string src, char chr)
315 std::string::size_type pos = src.find_first_not_of(chr, 0);
324 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
327 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
328 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
329 rv.reserve((itend-itbegin)*3);
330 for(T it = itbegin; it < itend; ++it)
332 unsigned char val = (unsigned char)(*it);
333 if(fSpaces && it != itbegin)
335 rv.push_back(hexmap[val>>4]);
336 rv.push_back(hexmap[val&15]);
342 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
344 return HexStr(vch.begin(), vch.end(), fSpaces);
348 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
350 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
353 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
355 printf(pszFormat, HexStr(vch, fSpaces).c_str());
358 inline int64_t GetPerformanceCounter()
360 int64_t nCounter = 0;
362 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
365 gettimeofday(&t, NULL);
366 nCounter = (int64_t) t.tv_sec * 1000000 + t.tv_usec;
371 inline int64_t GetTimeMillis()
373 return (boost::posix_time::microsec_clock::universal_time() -
374 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
377 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
379 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
380 inline std::string DateTimeStrFormat(int64_t nTime)
382 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
387 void skipspaces(T& it)
393 inline bool IsSwitchChar(char c)
396 return c == '-' || c == '/';
403 * Return string argument or default value
405 * @param strArg Argument to get (e.g. "-foo")
406 * @param default (e.g. "1")
407 * @return command-line argument or default value
409 std::string GetArg(const std::string& strArg, const std::string& strDefault);
412 * Return 64-bit integer argument or default value
414 * @param strArg Argument to get (e.g. "-foo")
415 * @param default (e.g. 1)
416 * @return command-line argument (0 if invalid number) or default value
418 int64_t GetArg(const std::string& strArg, int64_t nDefault);
421 * Return 32-bit integer argument or default value
423 * @param strArg Argument to get (e.g. "-foo")
424 * @param default (e.g. 1)
425 * @return command-line argument (0 if invalid number) or default value
427 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
430 * Return 32-bit unsigned integer argument or default value
432 * @param strArg Argument to get (e.g. "-foo")
433 * @param default (e.g. 1)
434 * @return command-line argument (0 if invalid number) or default value
436 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
439 * Return boolean argument or default value
441 * @param strArg Argument to get (e.g. "-foo")
442 * @param default (true or false)
443 * @return command-line argument or default value
445 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
448 * Set an argument if it doesn't already have a value
450 * @param strArg Argument to set (e.g. "-foo")
451 * @param strValue Value (e.g. "1")
452 * @return true if argument gets set, false if it already had a value
454 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
457 * Set a boolean argument if it doesn't already have a value
459 * @param strArg Argument to set (e.g. "-foo")
460 * @param fValue Value (e.g. false)
461 * @return true if argument gets set, false if it already had a value
463 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
466 * Timing-attack-resistant comparison.
467 * Takes time proportional to length
470 template <typename T>
471 bool TimingResistantEqual(const T& a, const T& b)
473 if (b.size() == 0) return a.size() == 0;
474 size_t accumulator = a.size() ^ b.size();
475 for (size_t i = 0; i < a.size(); i++)
476 accumulator |= a[i] ^ b[i%b.size()];
477 return accumulator == 0;
480 /** Median filter over a stream of values.
481 * Returns the median of the last N numbers
483 template <typename T> class CMedianFilter
486 std::vector<T> vValues;
487 std::vector<T> vSorted;
490 CMedianFilter(unsigned int size, T initial_value):
493 vValues.reserve(size);
494 vValues.push_back(initial_value);
500 if(vValues.size() == nSize)
502 vValues.erase(vValues.begin());
504 vValues.push_back(value);
506 vSorted.resize(vValues.size());
507 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
508 std::sort(vSorted.begin(), vSorted.end());
513 int size = vSorted.size();
515 if(size & 1) // Odd number of elements
517 return vSorted[size/2];
519 else // Even number of elements
521 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
527 return static_cast<int>(vValues.size());
530 std::vector<T> sorted () const
536 bool NewThread(void(*pfn)(void*), void* parg);
539 inline void SetThreadPriority(int nPriority)
541 SetThreadPriority(GetCurrentThread(), nPriority);
545 #define THREAD_PRIORITY_LOWEST PRIO_MAX
546 #define THREAD_PRIORITY_BELOW_NORMAL 2
547 #define THREAD_PRIORITY_NORMAL 0
548 #define THREAD_PRIORITY_ABOVE_NORMAL 0
550 inline void SetThreadPriority(int nPriority)
552 // It's unclear if it's even possible to change thread priorities on Linux,
553 // but we really and truly need it for the generation threads.
555 setpriority(PRIO_THREAD, 0, nPriority);
557 setpriority(PRIO_PROCESS, 0, nPriority);
561 inline void ExitThread(size_t nExitCode)
563 pthread_exit((void*)nExitCode);
567 void RenameThread(const char* name);
569 inline uint32_t ByteReverse(uint32_t value)
571 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
572 return (value<<16) | (value>>16);