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 "netbase.h" // for AddTimeData
28 typedef long long int64;
29 typedef unsigned long long uint64;
31 static const int64 COIN = 1000000;
32 static const int64 CENT = 10000;
34 #define BEGIN(a) ((char*)&(a))
35 #define END(a) ((char*)&((&(a))[1]))
36 #define UBEGIN(a) ((unsigned char*)&(a))
37 #define UEND(a) ((unsigned char*)&((&(a))[1]))
38 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
40 #define UVOIDBEGIN(a) ((void*)&(a))
41 #define CVOIDBEGIN(a) ((const void*)&(a))
42 #define UINTBEGIN(a) ((uint32_t*)&(a))
43 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
46 #if defined(_MSC_VER) || defined(__MSVCRT__)
57 #ifndef THROW_WITH_STACKTRACE
58 #define THROW_WITH_STACKTRACE(exception) \
67 /* Format characters for (s)size_t and ptrdiff_t */
68 #if defined(_MSC_VER) || defined(__MSVCRT__)
69 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
70 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
78 #else /* C99 standard */
87 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
88 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
90 // Align by increasing pointer, must have extra space at end of buffer
91 template <size_t nBytes, typename T>
100 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
105 #define MSG_NOSIGNAL 0
106 #define MSG_DONTWAIT 0
113 #define MAX_PATH 1024
114 inline void Sleep(int64 n)
116 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
117 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
118 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
122 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
123 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
124 * Parameters count from 1.
127 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
129 #define ATTR_WARN_PRINTF(X,Y)
139 extern std::map<std::string, std::string> mapArgs;
140 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
142 extern bool fDebugNet;
143 extern bool fPrintToConsole;
144 extern bool fPrintToDebugger;
145 extern bool fRequestShutdown;
146 extern bool fShutdown;
149 extern bool fCommandLine;
150 extern std::string strMiscWarning;
151 extern bool fTestNet;
152 extern bool fNoListen;
153 extern bool fLogTimestamps;
154 extern bool fReopenDebugLog;
157 void RandAddSeedPerfmon();
158 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
161 Rationale for the real_strprintf / strprintf construction:
162 It is not allowed to use va_start with a pass-by-reference argument.
163 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
164 macro to keep similar semantics.
167 /** Overload strprintf for char*, so that GCC format type warnings can be given */
168 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
169 /** Overload strprintf for std::string, to be able to use it with _ (translation).
170 * This will not support GCC format type warnings (-Wformat) so be careful.
172 std::string real_strprintf(const std::string &format, int dummy, ...);
173 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
174 std::string vstrprintf(const char *format, va_list ap);
176 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
178 /* Redefine printf so that it directs output to debug.log
180 * Do this *after* defining the other printf-like functions, because otherwise the
181 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
182 * which confuses gcc.
184 #define printf OutputDebugStringF
186 void LogException(std::exception* pex, const char* pszThread);
187 void PrintException(std::exception* pex, const char* pszThread);
188 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
189 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
190 std::string FormatMoney(int64 n, bool fPlus=false);
191 bool ParseMoney(const std::string& str, int64& nRet);
192 bool ParseMoney(const char* pszIn, int64& nRet);
193 std::vector<unsigned char> ParseHex(const char* psz);
194 std::vector<unsigned char> ParseHex(const std::string& str);
195 bool IsHex(const std::string& str);
196 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
197 std::string DecodeBase64(const std::string& str);
198 std::string EncodeBase64(const unsigned char* pch, size_t len);
199 std::string EncodeBase64(const std::string& str);
200 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
201 std::string DecodeBase32(const std::string& str);
202 std::string EncodeBase32(const unsigned char* pch, size_t len);
203 std::string EncodeBase32(const std::string& str);
204 std::string EncodeDumpTime(int64 nTime);
205 int64 DecodeDumpTime(const std::string& s);
206 std::string EncodeDumpString(const std::string &str);
207 std::string DecodeDumpString(const std::string &str);
208 void ParseParameters(int argc, const char*const argv[]);
209 bool WildcardMatch(const char* psz, const char* mask);
210 bool WildcardMatch(const std::string& str, const std::string& mask);
211 void FileCommit(FILE *fileout);
212 int GetFilesize(FILE* file);
213 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
214 boost::filesystem::path GetDefaultDataDir();
215 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
216 boost::filesystem::path GetConfigFile();
217 boost::filesystem::path GetPidFile();
219 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
221 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
223 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
225 void ShrinkDebugFile();
226 int GetRandInt(int nMax);
227 uint64 GetRand(uint64 nMax);
228 uint256 GetRandHash();
230 void SetMockTime(int64 nMockTimeIn);
231 int64 GetAdjustedTime();
232 int64 GetTimeOffset();
233 std::string FormatFullVersion();
234 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
235 void AddTimeData(const CNetAddr& ip, int64 nTime);
236 void runCommand(std::string strCommand);
246 inline std::string i64tostr(int64 n)
248 return strprintf("%"PRI64d, n);
251 inline std::string itostr(int n)
253 return strprintf("%d", n);
256 inline int64 atoi64(const char* psz)
261 return strtoll(psz, NULL, 10);
265 inline int64 atoi64(const std::string& str)
268 return _atoi64(str.c_str());
270 return strtoll(str.c_str(), NULL, 10);
274 inline int atoi(const std::string& str)
276 return atoi(str.c_str());
279 inline int roundint(double d)
281 return (int)(d > 0 ? d + 0.5 : d - 0.5);
284 inline int64 roundint64(double d)
286 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
289 inline int64 abs64(int64 n)
291 return (n >= 0 ? n : -n);
294 inline std::string leftTrim(std::string src, char chr)
296 std::string::size_type pos = src.find_first_not_of(chr, 0);
305 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
308 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
309 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
310 rv.reserve((itend-itbegin)*3);
311 for(T it = itbegin; it < itend; ++it)
313 unsigned char val = (unsigned char)(*it);
314 if(fSpaces && it != itbegin)
316 rv.push_back(hexmap[val>>4]);
317 rv.push_back(hexmap[val&15]);
323 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
325 return HexStr(vch.begin(), vch.end(), fSpaces);
329 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
331 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
334 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
336 printf(pszFormat, HexStr(vch, fSpaces).c_str());
339 inline int64 GetPerformanceCounter()
343 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
346 gettimeofday(&t, NULL);
347 nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec;
352 inline int64 GetTimeMillis()
354 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
355 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
358 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
361 struct tm* ptmTime = gmtime(&n);
363 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
367 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
368 inline std::string DateTimeStrFormat(int64 nTime)
370 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
375 void skipspaces(T& it)
381 inline bool IsSwitchChar(char c)
384 return c == '-' || c == '/';
391 * Return string argument or default value
393 * @param strArg Argument to get (e.g. "-foo")
394 * @param default (e.g. "1")
395 * @return command-line argument or default value
397 std::string GetArg(const std::string& strArg, const std::string& strDefault);
400 * Return integer argument or default value
402 * @param strArg Argument to get (e.g. "-foo")
403 * @param default (e.g. 1)
404 * @return command-line argument (0 if invalid number) or default value
406 int64 GetArg(const std::string& strArg, int64 nDefault);
409 * Return boolean argument or default value
411 * @param strArg Argument to get (e.g. "-foo")
412 * @param default (true or false)
413 * @return command-line argument or default value
415 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
418 * Set an argument if it doesn't already have a value
420 * @param strArg Argument to set (e.g. "-foo")
421 * @param strValue Value (e.g. "1")
422 * @return true if argument gets set, false if it already had a value
424 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
427 * Set a boolean argument if it doesn't already have a value
429 * @param strArg Argument to set (e.g. "-foo")
430 * @param fValue Value (e.g. false)
431 * @return true if argument gets set, false if it already had a value
433 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
436 * Timing-attack-resistant comparison.
437 * Takes time proportional to length
440 template <typename T>
441 bool TimingResistantEqual(const T& a, const T& b)
443 if (b.size() == 0) return a.size() == 0;
444 size_t accumulator = a.size() ^ b.size();
445 for (size_t i = 0; i < a.size(); i++)
446 accumulator |= a[i] ^ b[i%b.size()];
447 return accumulator == 0;
450 /** Median filter over a stream of values.
451 * Returns the median of the last N numbers
453 template <typename T> class CMedianFilter
456 std::vector<T> vValues;
457 std::vector<T> vSorted;
460 CMedianFilter(unsigned int size, T initial_value):
463 vValues.reserve(size);
464 vValues.push_back(initial_value);
470 if(vValues.size() == nSize)
472 vValues.erase(vValues.begin());
474 vValues.push_back(value);
476 vSorted.resize(vValues.size());
477 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
478 std::sort(vSorted.begin(), vSorted.end());
483 int size = vSorted.size();
485 if(size & 1) // Odd number of elements
487 return vSorted[size/2];
489 else // Even number of elements
491 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
497 return vValues.size();
500 std::vector<T> sorted () const
506 bool NewThread(void(*pfn)(void*), void* parg);
509 inline void SetThreadPriority(int nPriority)
511 SetThreadPriority(GetCurrentThread(), nPriority);
515 #define THREAD_PRIORITY_LOWEST PRIO_MAX
516 #define THREAD_PRIORITY_BELOW_NORMAL 2
517 #define THREAD_PRIORITY_NORMAL 0
518 #define THREAD_PRIORITY_ABOVE_NORMAL 0
520 inline void SetThreadPriority(int nPriority)
522 // It's unclear if it's even possible to change thread priorities on Linux,
523 // but we really and truly need it for the generation threads.
525 setpriority(PRIO_THREAD, 0, nPriority);
527 setpriority(PRIO_PROCESS, 0, nPriority);
531 inline void ExitThread(size_t nExitCode)
533 pthread_exit((void*)nExitCode);
537 void RenameThread(const char* name);
539 inline uint32_t ByteReverse(uint32_t value)
541 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
542 return (value<<16) | (value>>16);