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.
10 #include <sys/types.h>
12 #include <sys/resource.h>
24 #include <boost/thread.hpp>
25 #include <boost/filesystem.hpp>
26 #include <boost/filesystem/path.hpp>
27 #include <boost/date_time/gregorian/gregorian_types.hpp>
28 #include <boost/date_time/posix_time/posix_time_types.hpp>
33 #if defined(__USE_MINGW_ANSI_STDIO)
34 #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior
39 static const int32_t nOneHour = 60 * 60;
40 static const int32_t nOneDay = 24 * 60 * 60;
41 static const int64_t nOneWeek = 7 * 24 * 60 * 60;
43 static const int64_t COIN = 1000000;
44 static const int64_t CENT = 10000;
46 #define BEGIN(a) ((char*)&(a))
47 #define END(a) ((char*)&((&(a))[1]))
48 #define UBEGIN(a) ((unsigned char*)&(a))
49 #define UEND(a) ((unsigned char*)&((&(a))[1]))
50 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
52 #define UVOIDBEGIN(a) ((void*)&(a))
53 #define CVOIDBEGIN(a) ((const void*)&(a))
54 #define UINTBEGIN(a) ((uint32_t*)&(a))
55 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
57 #ifndef THROW_WITH_STACKTRACE
58 #define THROW_WITH_STACKTRACE(exception) \
66 #if defined(_MSC_VER) || defined(__MSVCRT__)
67 /* Silence compiler warnings on Windows
68 related to MinGWs inttypes.h */
79 /* Format characters for (s)size_t and ptrdiff_t */
80 #if defined(_MSC_VER) || defined(__MSVCRT__)
81 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
82 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
90 #else /* C99 standard */
99 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
100 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
102 // Align by increasing pointer, must have extra space at end of buffer
103 template <size_t nBytes, typename T>
112 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
117 #define MSG_NOSIGNAL 0
118 #define MSG_DONTWAIT 0
125 #define MAX_PATH 1024
126 inline void Sleep(int64_t n)
128 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
129 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
130 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
134 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
135 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
136 * Parameters count from 1.
139 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
141 #define ATTR_WARN_PRINTF(X,Y)
145 extern std::map<std::string, std::string> mapArgs;
146 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
148 extern bool fDebugNet;
149 extern bool fPrintToConsole;
150 extern bool fPrintToDebugger;
151 extern bool fRequestShutdown;
152 extern bool fShutdown;
155 extern bool fCommandLine;
156 extern std::string strMiscWarning;
157 extern bool fTestNet;
158 extern bool fNoListen;
159 extern bool fLogTimestamps;
160 extern bool fReopenDebugLog;
162 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
165 Rationale for the real_strprintf / strprintf construction:
166 It is not allowed to use va_start with a pass-by-reference argument.
167 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
168 macro to keep similar semantics.
171 /** Overload strprintf for char*, so that GCC format type warnings can be given */
172 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
173 /** Overload strprintf for std::string, to be able to use it with _ (translation).
174 * This will not support GCC format type warnings (-Wformat) so be careful.
176 std::string real_strprintf(const std::string &format, int dummy, ...);
177 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
178 std::string vstrprintf(const char *format, va_list ap);
180 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
182 /* Redefine printf so that it directs output to debug.log
184 * Do this *after* defining the other printf-like functions, because otherwise the
185 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
186 * which confuses gcc.
188 #define printf OutputDebugStringF
190 void LogException(std::exception* pex, const char* pszThread);
191 void PrintException(std::exception* pex, const char* pszThread);
192 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
193 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
194 std::string FormatMoney(int64_t n, bool fPlus=false);
195 bool ParseMoney(const std::string& str, int64_t& nRet);
196 bool ParseMoney(const char* pszIn, int64_t& nRet);
197 std::vector<unsigned char> ParseHex(const char* psz);
198 std::vector<unsigned char> ParseHex(const std::string& str);
199 bool IsHex(const std::string& str);
200 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
201 std::string DecodeBase64(const std::string& str);
202 std::string EncodeBase64(const unsigned char* pch, size_t len);
203 std::string EncodeBase64(const std::string& str);
204 std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL);
205 std::string DecodeBase32(const std::string& str);
206 std::string EncodeBase32(const unsigned char* pch, size_t len);
207 std::string EncodeBase32(const std::string& str);
208 std::string EncodeDumpTime(int64_t nTime);
209 int64_t DecodeDumpTime(const std::string& s);
210 std::string EncodeDumpString(const std::string &str);
211 std::string DecodeDumpString(const std::string &str);
212 void ParseParameters(int argc, const char*const argv[]);
213 bool WildcardMatch(const char* psz, const char* mask);
214 bool WildcardMatch(const std::string& str, const std::string& mask);
215 void FileCommit(FILE *fileout);
216 int GetFilesize(FILE* file);
217 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
218 boost::filesystem::path GetDefaultDataDir();
219 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
220 boost::filesystem::path GetConfigFile();
221 boost::filesystem::path GetPidFile();
223 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
225 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
227 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
229 void ShrinkDebugFile();
231 int64_t GetTimeMillis();
232 int64_t GetTimeMicros();
233 std::string FormatFullVersion();
234 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
235 void runCommand(std::string strCommand);
238 inline std::string i64tostr(int64_t n)
240 return strprintf("%" PRId64, n);
243 inline std::string itostr(int n)
245 return strprintf("%d", n);
248 inline int64_t atoi64(const char* psz)
253 return strtoll(psz, NULL, 10);
257 inline int64_t atoi64(const std::string& str)
260 return _atoi64(str.c_str());
262 return strtoll(str.c_str(), NULL, 10);
266 inline int32_t strtol(const char* psz)
268 return strtol(psz, NULL, 10);
271 inline int32_t strtol(const std::string& str)
273 return strtol(str.c_str(), NULL, 10);
276 inline uint32_t strtoul(const char* psz)
278 return strtoul(psz, NULL, 10);
281 inline uint32_t strtoul(const std::string& str)
283 return strtoul(str.c_str(), NULL, 10);
286 inline int atoi(const std::string& str)
288 return atoi(str.c_str());
291 inline int roundint(double d)
293 return (int)(d > 0 ? d + 0.5 : d - 0.5);
296 inline int64_t roundint64(double d)
298 return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
301 inline int64_t abs64(int64_t n)
303 return (n >= 0 ? n : -n);
306 inline std::string leftTrim(std::string src, char chr)
308 std::string::size_type pos = src.find_first_not_of(chr, 0);
317 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
320 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
321 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
322 rv.reserve((itend-itbegin)*3);
323 for(T it = itbegin; it < itend; ++it)
325 unsigned char val = (unsigned char)(*it);
326 if(fSpaces && it != itbegin)
328 rv.push_back(hexmap[val>>4]);
329 rv.push_back(hexmap[val&15]);
335 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
337 return HexStr(vch.begin(), vch.end(), fSpaces);
341 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
343 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
346 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
348 printf(pszFormat, HexStr(vch, fSpaces).c_str());
351 inline int64_t GetTimeMillis()
353 return (boost::posix_time::microsec_clock::universal_time() -
354 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
357 inline int64_t GetTimeMicros()
359 return (boost::posix_time::microsec_clock::universal_time() -
360 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_microseconds();
363 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
365 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
366 inline std::string DateTimeStrFormat(int64_t nTime)
368 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
373 void skipspaces(T& it)
379 inline bool IsSwitchChar(char c)
382 return c == '-' || c == '/';
389 * Return string argument or default value
391 * @param strArg Argument to get (e.g. "-foo")
392 * @param default (e.g. "1")
393 * @return command-line argument or default value
395 std::string GetArg(const std::string& strArg, const std::string& strDefault);
398 * Return 64-bit integer argument or default value
400 * @param strArg Argument to get (e.g. "-foo")
401 * @param default (e.g. 1)
402 * @return command-line argument (0 if invalid number) or default value
404 int64_t GetArg(const std::string& strArg, int64_t nDefault);
407 * Return 32-bit integer argument or default value
409 * @param strArg Argument to get (e.g. "-foo")
410 * @param default (e.g. 1)
411 * @return command-line argument (0 if invalid number) or default value
413 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
416 * Return 32-bit unsigned integer argument or default value
418 * @param strArg Argument to get (e.g. "-foo")
419 * @param default (e.g. 1)
420 * @return command-line argument (0 if invalid number) or default value
422 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
425 * Return boolean argument or default value
427 * @param strArg Argument to get (e.g. "-foo")
428 * @param default (true or false)
429 * @return command-line argument or default value
431 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
434 * Set an argument if it doesn't already have a value
436 * @param strArg Argument to set (e.g. "-foo")
437 * @param strValue Value (e.g. "1")
438 * @return true if argument gets set, false if it already had a value
440 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
443 * Set a boolean argument if it doesn't already have a value
445 * @param strArg Argument to set (e.g. "-foo")
446 * @param fValue Value (e.g. false)
447 * @return true if argument gets set, false if it already had a value
449 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
452 * Timing-attack-resistant comparison.
453 * Takes time proportional to length
456 template <typename T>
457 bool TimingResistantEqual(const T& a, const T& b)
459 if (b.size() == 0) return a.size() == 0;
460 size_t accumulator = a.size() ^ b.size();
461 for (size_t i = 0; i < a.size(); i++)
462 accumulator |= a[i] ^ b[i%b.size()];
463 return accumulator == 0;
466 bool NewThread(void(*pfn)(void*), void* parg);
469 inline void SetThreadPriority(int nPriority)
471 SetThreadPriority(GetCurrentThread(), nPriority);
475 #define THREAD_PRIORITY_LOWEST PRIO_MAX
476 #define THREAD_PRIORITY_BELOW_NORMAL 2
477 #define THREAD_PRIORITY_NORMAL 0
478 #define THREAD_PRIORITY_ABOVE_NORMAL 0
480 inline void SetThreadPriority(int nPriority)
482 // It's unclear if it's even possible to change thread priorities on Linux,
483 // but we really and truly need it for the generation threads.
485 setpriority(PRIO_THREAD, 0, nPriority);
487 setpriority(PRIO_PROCESS, 0, nPriority);
491 inline void ExitThread(size_t nExitCode)
493 pthread_exit((void*)nExitCode);
497 void RenameThread(const char* name);
499 inline uint32_t ByteReverse(uint32_t value)
501 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
502 return (value<<16) | (value>>16);