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) \
64 #if defined(_MSC_VER) || defined(__MSVCRT__)
65 /* Silence compiler warnings on Windows
66 related to MinGWs inttypes.h */
77 /* Format characters for (s)size_t and ptrdiff_t */
78 #if defined(_MSC_VER) || defined(__MSVCRT__)
79 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
80 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
88 #else /* C99 standard */
97 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
98 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
100 // Align by increasing pointer, must have extra space at end of buffer
101 template <size_t nBytes, typename T>
110 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
115 #define MSG_NOSIGNAL 0
116 #define MSG_DONTWAIT 0
123 #define MAX_PATH 1024
124 inline void Sleep(int64_t n)
126 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
127 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
128 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
132 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
133 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
134 * Parameters count from 1.
137 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
139 #define ATTR_WARN_PRINTF(X,Y)
149 extern std::map<std::string, std::string> mapArgs;
150 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
152 extern bool fDebugNet;
153 extern bool fPrintToConsole;
154 extern bool fPrintToDebugger;
155 extern bool fRequestShutdown;
156 extern bool fShutdown;
159 extern bool fCommandLine;
160 extern std::string strMiscWarning;
161 extern bool fTestNet;
162 extern bool fNoListen;
163 extern bool fLogTimestamps;
164 extern bool fReopenDebugLog;
167 void RandAddSeedPerfmon();
168 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
171 Rationale for the real_strprintf / strprintf construction:
172 It is not allowed to use va_start with a pass-by-reference argument.
173 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
174 macro to keep similar semantics.
177 /** Overload strprintf for char*, so that GCC format type warnings can be given */
178 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
179 /** Overload strprintf for std::string, to be able to use it with _ (translation).
180 * This will not support GCC format type warnings (-Wformat) so be careful.
182 std::string real_strprintf(const std::string &format, int dummy, ...);
183 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
184 std::string vstrprintf(const char *format, va_list ap);
186 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
188 /* Redefine printf so that it directs output to debug.log
190 * Do this *after* defining the other printf-like functions, because otherwise the
191 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
192 * which confuses gcc.
194 #define printf OutputDebugStringF
196 void LogException(std::exception* pex, const char* pszThread);
197 void PrintException(std::exception* pex, const char* pszThread);
198 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
199 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
200 std::string FormatMoney(int64_t n, bool fPlus=false);
201 bool ParseMoney(const std::string& str, int64_t& nRet);
202 bool ParseMoney(const char* pszIn, int64_t& nRet);
203 std::vector<unsigned char> ParseHex(const char* psz);
204 std::vector<unsigned char> ParseHex(const std::string& str);
205 bool IsHex(const std::string& str);
206 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
207 std::string DecodeBase64(const std::string& str);
208 std::string EncodeBase64(const unsigned char* pch, size_t len);
209 std::string EncodeBase64(const std::string& str);
210 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
211 std::string DecodeBase32(const std::string& str);
212 std::string EncodeBase32(const unsigned char* pch, size_t len);
213 std::string EncodeBase32(const std::string& str);
214 std::string EncodeDumpTime(int64_t nTime);
215 int64_t DecodeDumpTime(const std::string& s);
216 std::string EncodeDumpString(const std::string &str);
217 std::string DecodeDumpString(const std::string &str);
218 void ParseParameters(int argc, const char*const argv[]);
219 bool WildcardMatch(const char* psz, const char* mask);
220 bool WildcardMatch(const std::string& str, const std::string& mask);
221 void FileCommit(FILE *fileout);
222 int GetFilesize(FILE* file);
223 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
224 boost::filesystem::path GetDefaultDataDir();
225 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
226 boost::filesystem::path GetConfigFile();
227 boost::filesystem::path GetPidFile();
229 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
231 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
233 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
235 void ShrinkDebugFile();
236 int GetRandInt(int nMax);
237 uint64_t GetRand(uint64_t nMax);
238 uint256 GetRandHash();
240 void SetMockTime(int64_t nMockTimeIn);
241 int64_t GetAdjustedTime();
242 int64_t GetTimeOffset();
243 int64_t GetNodesOffset();
244 std::string FormatFullVersion();
245 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
246 void AddTimeData(const CNetAddr& ip, int64_t nTime);
247 void runCommand(std::string strCommand);
257 inline std::string i64tostr(int64_t n)
259 return strprintf("%" PRId64, n);
262 inline std::string itostr(int n)
264 return strprintf("%d", n);
267 inline int64_t atoi64(const char* psz)
272 return strtoll(psz, NULL, 10);
276 inline int64_t atoi64(const std::string& str)
279 return _atoi64(str.c_str());
281 return strtoll(str.c_str(), NULL, 10);
285 inline int32_t strtol(const char* psz)
287 return strtol(psz, NULL, 10);
290 inline int32_t strtol(const std::string& str)
292 return strtol(str.c_str(), NULL, 10);
295 inline uint32_t strtoul(const char* psz)
297 return strtoul(psz, NULL, 10);
300 inline uint32_t strtoul(const std::string& str)
302 return strtoul(str.c_str(), NULL, 10);
305 inline int atoi(const std::string& str)
307 return atoi(str.c_str());
310 inline int roundint(double d)
312 return (int)(d > 0 ? d + 0.5 : d - 0.5);
315 inline int64_t roundint64(double d)
317 return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
320 inline int64_t abs64(int64_t n)
322 return (n >= 0 ? n : -n);
325 inline std::string leftTrim(std::string src, char chr)
327 std::string::size_type pos = src.find_first_not_of(chr, 0);
336 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
339 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
340 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
341 rv.reserve((itend-itbegin)*3);
342 for(T it = itbegin; it < itend; ++it)
344 unsigned char val = (unsigned char)(*it);
345 if(fSpaces && it != itbegin)
347 rv.push_back(hexmap[val>>4]);
348 rv.push_back(hexmap[val&15]);
354 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
356 return HexStr(vch.begin(), vch.end(), fSpaces);
360 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
362 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
365 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
367 printf(pszFormat, HexStr(vch, fSpaces).c_str());
370 inline int64_t GetPerformanceCounter()
372 int64_t nCounter = 0;
374 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
377 gettimeofday(&t, NULL);
378 nCounter = (int64_t) t.tv_sec * 1000000 + t.tv_usec;
383 inline int64_t GetTimeMillis()
385 return (boost::posix_time::microsec_clock::universal_time() -
386 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
389 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
391 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
392 inline std::string DateTimeStrFormat(int64_t nTime)
394 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
399 void skipspaces(T& it)
405 inline bool IsSwitchChar(char c)
408 return c == '-' || c == '/';
415 * Return string argument or default value
417 * @param strArg Argument to get (e.g. "-foo")
418 * @param default (e.g. "1")
419 * @return command-line argument or default value
421 std::string GetArg(const std::string& strArg, const std::string& strDefault);
424 * Return 64-bit integer argument or default value
426 * @param strArg Argument to get (e.g. "-foo")
427 * @param default (e.g. 1)
428 * @return command-line argument (0 if invalid number) or default value
430 int64_t GetArg(const std::string& strArg, int64_t nDefault);
433 * Return 32-bit integer argument or default value
435 * @param strArg Argument to get (e.g. "-foo")
436 * @param default (e.g. 1)
437 * @return command-line argument (0 if invalid number) or default value
439 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
442 * Return 32-bit unsigned integer argument or default value
444 * @param strArg Argument to get (e.g. "-foo")
445 * @param default (e.g. 1)
446 * @return command-line argument (0 if invalid number) or default value
448 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
451 * Return boolean argument or default value
453 * @param strArg Argument to get (e.g. "-foo")
454 * @param default (true or false)
455 * @return command-line argument or default value
457 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
460 * Set an argument if it doesn't already have a value
462 * @param strArg Argument to set (e.g. "-foo")
463 * @param strValue Value (e.g. "1")
464 * @return true if argument gets set, false if it already had a value
466 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
469 * Set a boolean argument if it doesn't already have a value
471 * @param strArg Argument to set (e.g. "-foo")
472 * @param fValue Value (e.g. false)
473 * @return true if argument gets set, false if it already had a value
475 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
478 * Timing-attack-resistant comparison.
479 * Takes time proportional to length
482 template <typename T>
483 bool TimingResistantEqual(const T& a, const T& b)
485 if (b.size() == 0) return a.size() == 0;
486 size_t accumulator = a.size() ^ b.size();
487 for (size_t i = 0; i < a.size(); i++)
488 accumulator |= a[i] ^ b[i%b.size()];
489 return accumulator == 0;
492 /** Median filter over a stream of values.
493 * Returns the median of the last N numbers
495 template <typename T> class CMedianFilter
498 std::vector<T> vValues;
499 std::vector<T> vSorted;
502 CMedianFilter(unsigned int size, T initial_value):
505 vValues.reserve(size);
506 vValues.push_back(initial_value);
512 if(vValues.size() == nSize)
514 vValues.erase(vValues.begin());
516 vValues.push_back(value);
518 vSorted.resize(vValues.size());
519 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
520 std::sort(vSorted.begin(), vSorted.end());
525 int size = vSorted.size();
527 if(size & 1) // Odd number of elements
529 return vSorted[size/2];
531 else // Even number of elements
533 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
539 return static_cast<int>(vValues.size());
542 std::vector<T> sorted () const
548 bool NewThread(void(*pfn)(void*), void* parg);
551 inline void SetThreadPriority(int nPriority)
553 SetThreadPriority(GetCurrentThread(), nPriority);
557 #define THREAD_PRIORITY_LOWEST PRIO_MAX
558 #define THREAD_PRIORITY_BELOW_NORMAL 2
559 #define THREAD_PRIORITY_NORMAL 0
560 #define THREAD_PRIORITY_ABOVE_NORMAL 0
562 inline void SetThreadPriority(int nPriority)
564 // It's unclear if it's even possible to change thread priorities on Linux,
565 // but we really and truly need it for the generation threads.
567 setpriority(PRIO_THREAD, 0, nPriority);
569 setpriority(PRIO_PROCESS, 0, nPriority);
573 inline void ExitThread(size_t nExitCode)
575 pthread_exit((void*)nExitCode);
579 void RenameThread(const char* name);
581 inline uint32_t ByteReverse(uint32_t value)
583 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
584 return (value<<16) | (value>>16);