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::string SanitizeString(const std::string& str);
194 std::vector<unsigned char> ParseHex(const char* psz);
195 std::vector<unsigned char> ParseHex(const std::string& str);
196 bool IsHex(const std::string& str);
197 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
198 std::string DecodeBase64(const std::string& str);
199 std::string EncodeBase64(const unsigned char* pch, size_t len);
200 std::string EncodeBase64(const std::string& str);
201 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
202 std::string DecodeBase32(const std::string& str);
203 std::string EncodeBase32(const unsigned char* pch, size_t len);
204 std::string EncodeBase32(const std::string& str);
205 std::string EncodeDumpTime(int64 nTime);
206 int64 DecodeDumpTime(const std::string& s);
207 std::string EncodeDumpString(const std::string &str);
208 std::string DecodeDumpString(const std::string &str);
209 void ParseParameters(int argc, const char*const argv[]);
210 bool WildcardMatch(const char* psz, const char* mask);
211 bool WildcardMatch(const std::string& str, const std::string& mask);
212 void FileCommit(FILE *fileout);
213 int GetFilesize(FILE* file);
214 void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length);
215 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
216 boost::filesystem::path GetDefaultDataDir();
217 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
218 boost::filesystem::path GetConfigFile();
219 boost::filesystem::path GetPidFile();
221 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
223 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
225 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
227 void ShrinkDebugFile();
228 int GetRandInt(int nMax);
229 uint64 GetRand(uint64 nMax);
230 uint256 GetRandHash();
232 void SetMockTime(int64 nMockTimeIn);
233 int64 GetAdjustedTime();
234 int64 GetTimeOffset();
235 std::string FormatFullVersion();
236 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
237 void AddTimeData(const CNetAddr& ip, int64 nTime);
238 void runCommand(std::string strCommand);
248 inline std::string i64tostr(int64 n)
250 return strprintf("%"PRI64d, n);
253 inline std::string itostr(int n)
255 return strprintf("%d", n);
258 inline int64 atoi64(const char* psz)
263 return strtoll(psz, NULL, 10);
267 inline int64 atoi64(const std::string& str)
270 return _atoi64(str.c_str());
272 return strtoll(str.c_str(), NULL, 10);
276 inline int atoi(const std::string& str)
278 return atoi(str.c_str());
281 inline int roundint(double d)
283 return (int)(d > 0 ? d + 0.5 : d - 0.5);
286 inline int64 roundint64(double d)
288 return (int64)(d > 0 ? d + 0.5 : d - 0.5);
291 inline int64 abs64(int64 n)
293 return (n >= 0 ? n : -n);
296 inline std::string leftTrim(std::string src, char chr)
298 std::string::size_type pos = src.find_first_not_of(chr, 0);
307 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
310 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
311 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
312 rv.reserve((itend-itbegin)*3);
313 for(T it = itbegin; it < itend; ++it)
315 unsigned char val = (unsigned char)(*it);
316 if(fSpaces && it != itbegin)
318 rv.push_back(hexmap[val>>4]);
319 rv.push_back(hexmap[val&15]);
325 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
327 return HexStr(vch.begin(), vch.end(), fSpaces);
331 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
333 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
336 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
338 printf(pszFormat, HexStr(vch, fSpaces).c_str());
341 inline int64 GetPerformanceCounter()
345 QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
348 gettimeofday(&t, NULL);
349 nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec;
354 inline int64 GetTimeMillis()
356 return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
357 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
360 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
363 struct tm* ptmTime = gmtime(&n);
365 strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
369 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
370 inline std::string DateTimeStrFormat(int64 nTime)
372 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
377 void skipspaces(T& it)
383 inline bool IsSwitchChar(char c)
386 return c == '-' || c == '/';
393 * Return string argument or default value
395 * @param strArg Argument to get (e.g. "-foo")
396 * @param default (e.g. "1")
397 * @return command-line argument or default value
399 std::string GetArg(const std::string& strArg, const std::string& strDefault);
402 * Return integer argument or default value
404 * @param strArg Argument to get (e.g. "-foo")
405 * @param default (e.g. 1)
406 * @return command-line argument (0 if invalid number) or default value
408 int64 GetArg(const std::string& strArg, int64 nDefault);
411 * Return boolean argument or default value
413 * @param strArg Argument to get (e.g. "-foo")
414 * @param default (true or false)
415 * @return command-line argument or default value
417 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
420 * Set an argument if it doesn't already have a value
422 * @param strArg Argument to set (e.g. "-foo")
423 * @param strValue Value (e.g. "1")
424 * @return true if argument gets set, false if it already had a value
426 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
429 * Set a boolean argument if it doesn't already have a value
431 * @param strArg Argument to set (e.g. "-foo")
432 * @param fValue Value (e.g. false)
433 * @return true if argument gets set, false if it already had a value
435 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
438 * Timing-attack-resistant comparison.
439 * Takes time proportional to length
442 template <typename T>
443 bool TimingResistantEqual(const T& a, const T& b)
445 if (b.size() == 0) return a.size() == 0;
446 size_t accumulator = a.size() ^ b.size();
447 for (size_t i = 0; i < a.size(); i++)
448 accumulator |= a[i] ^ b[i%b.size()];
449 return accumulator == 0;
452 /** Median filter over a stream of values.
453 * Returns the median of the last N numbers
455 template <typename T> class CMedianFilter
458 std::vector<T> vValues;
459 std::vector<T> vSorted;
462 CMedianFilter(unsigned int size, T initial_value):
465 vValues.reserve(size);
466 vValues.push_back(initial_value);
472 if(vValues.size() == nSize)
474 vValues.erase(vValues.begin());
476 vValues.push_back(value);
478 vSorted.resize(vValues.size());
479 std::copy(vValues.begin(), vValues.end(), vSorted.begin());
480 std::sort(vSorted.begin(), vSorted.end());
485 int size = vSorted.size();
487 if(size & 1) // Odd number of elements
489 return vSorted[size/2];
491 else // Even number of elements
493 return (vSorted[size/2-1] + vSorted[size/2]) / 2;
499 return vValues.size();
502 std::vector<T> sorted () const
508 bool NewThread(void(*pfn)(void*), void* parg);
511 inline void SetThreadPriority(int nPriority)
513 SetThreadPriority(GetCurrentThread(), nPriority);
517 #define THREAD_PRIORITY_LOWEST PRIO_MAX
518 #define THREAD_PRIORITY_BELOW_NORMAL 2
519 #define THREAD_PRIORITY_NORMAL 0
520 #define THREAD_PRIORITY_ABOVE_NORMAL 0
522 inline void SetThreadPriority(int nPriority)
524 // It's unclear if it's even possible to change thread priorities on Linux,
525 // but we really and truly need it for the generation threads.
527 setpriority(PRIO_THREAD, 0, nPriority);
529 setpriority(PRIO_PROCESS, 0, nPriority);
533 inline void ExitThread(size_t nExitCode)
535 pthread_exit((void*)nExitCode);
539 void RenameThread(const char* name);
541 inline uint32_t ByteReverse(uint32_t value)
543 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
544 return (value<<16) | (value>>16);