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>
20 #include <boost/thread.hpp>
21 #include <boost/filesystem/path.hpp>
22 #include <boost/date_time/gregorian/gregorian_types.hpp>
23 #include <boost/date_time/posix_time/posix_time_types.hpp>
26 #if defined(__USE_MINGW_ANSI_STDIO)
27 #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior
36 static const int32_t nOneHour = 60 * 60;
37 static const int32_t nOneDay = 24 * 60 * 60;
38 static const int64_t nOneWeek = 7 * 24 * 60 * 60;
40 static const int64_t COIN = 1000000;
41 static const int64_t CENT = 10000;
43 #define BEGIN(a) ((char*)&(a))
44 #define END(a) ((char*)&((&(a))[1]))
45 #define UBEGIN(a) ((unsigned char*)&(a))
46 #define UEND(a) ((unsigned char*)&((&(a))[1]))
47 #define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0]))
49 #define UVOIDBEGIN(a) ((void*)&(a))
50 #define CVOIDBEGIN(a) ((const void*)&(a))
51 #define UINTBEGIN(a) ((uint32_t*)&(a))
52 #define CUINTBEGIN(a) ((const uint32_t*)&(a))
54 #ifndef THROW_WITH_STACKTRACE
55 #define THROW_WITH_STACKTRACE(exception) \
63 #if defined(_MSC_VER) || defined(__MSVCRT__)
64 /* Silence compiler warnings on Windows
65 related to MinGWs inttypes.h */
76 /* Format characters for (s)size_t and ptrdiff_t */
77 #if defined(_MSC_VER) || defined(__MSVCRT__)
78 /* (s)size_t and ptrdiff_t have the same size specifier in MSVC:
79 http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx
87 #else /* C99 standard */
96 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
97 #define PAIRTYPE(t1, t2) std::pair<t1, t2>
99 // Align by increasing pointer, must have extra space at end of buffer
100 template <size_t nBytes, typename T>
109 u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
114 #define MSG_NOSIGNAL 0
115 #define MSG_DONTWAIT 0
122 #define MAX_PATH 1024
123 inline void Sleep(int64_t n)
125 /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
126 So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
127 boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
131 /* This GNU C extension enables the compiler to check the format string against the parameters provided.
132 * X is the number of the "format string" parameter, and Y is the number of the first variadic parameter.
133 * Parameters count from 1.
136 #define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y)))
138 #define ATTR_WARN_PRINTF(X,Y)
142 extern std::map<std::string, std::string> mapArgs;
143 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
145 extern bool fDebugNet;
146 extern bool fPrintToConsole;
147 extern bool fPrintToDebugger;
148 extern bool fRequestShutdown;
149 extern bool fShutdown;
152 extern bool fCommandLine;
153 extern std::string strMiscWarning;
154 extern bool fTestNet;
155 extern bool fNoListen;
156 extern bool fLogTimestamps;
157 extern bool fReopenDebugLog;
159 int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...);
162 Rationale for the real_strprintf / strprintf construction:
163 It is not allowed to use va_start with a pass-by-reference argument.
164 (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
165 macro to keep similar semantics.
168 /** Overload strprintf for char*, so that GCC format type warnings can be given */
169 std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...);
170 /** Overload strprintf for std::string, to be able to use it with _ (translation).
171 * This will not support GCC format type warnings (-Wformat) so be careful.
173 std::string real_strprintf(const std::string &format, int dummy, ...);
174 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
175 std::string vstrprintf(const char *format, va_list ap);
177 bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...);
179 /* Redefine printf so that it directs output to debug.log
181 * Do this *after* defining the other printf-like functions, because otherwise the
182 * __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y)))
183 * which confuses gcc.
185 #define printf OutputDebugStringF
187 void LogException(std::exception* pex, const char* pszThread);
188 void PrintException(std::exception* pex, const char* pszThread);
189 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
190 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
191 std::string FormatMoney(int64_t n, bool fPlus=false);
192 bool ParseMoney(const std::string& str, int64_t& nRet);
193 bool ParseMoney(const char* pszIn, int64_t& nRet);
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_t nTime);
206 int64_t 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 bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest);
215 boost::filesystem::path GetDefaultDataDir();
216 const boost::filesystem::path &GetDataDir(bool fNetSpecific = true);
217 boost::filesystem::path GetConfigFile();
218 boost::filesystem::path GetPidFile();
220 void CreatePidFile(const boost::filesystem::path &path, pid_t pid);
222 void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
224 boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true);
226 void ShrinkDebugFile();
228 int64_t GetTimeMillis();
229 int64_t GetTimeMicros();
230 std::string FormatFullVersion();
231 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
232 void runCommand(std::string strCommand);
235 inline std::string i64tostr(int64_t n)
237 return strprintf("%" PRId64, n);
240 inline std::string itostr(int n)
242 return strprintf("%d", n);
245 inline int64_t atoi64(const char* psz)
250 return strtoll(psz, NULL, 10);
254 inline int64_t atoi64(const std::string& str)
257 return _atoi64(str.c_str());
259 return strtoll(str.c_str(), NULL, 10);
263 inline int32_t strtol(const char* psz)
265 return strtol(psz, NULL, 10);
268 inline int32_t strtol(const std::string& str)
270 return strtol(str.c_str(), NULL, 10);
273 inline uint32_t strtoul(const char* psz)
275 return strtoul(psz, NULL, 10);
278 inline uint32_t strtoul(const std::string& str)
280 return strtoul(str.c_str(), NULL, 10);
283 inline int atoi(const std::string& str)
285 return atoi(str.c_str());
288 inline int roundint(double d)
290 return (int)(d > 0 ? d + 0.5 : d - 0.5);
293 inline int64_t roundint64(double d)
295 return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
298 inline std::string leftTrim(std::string src, char chr)
300 std::string::size_type pos = src.find_first_not_of(chr, 0);
309 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
312 static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
313 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
314 rv.reserve((itend-itbegin)*3);
315 for(T it = itbegin; it < itend; ++it)
317 unsigned char val = (unsigned char)(*it);
318 if(fSpaces && it != itbegin)
320 rv.push_back(hexmap[val>>4]);
321 rv.push_back(hexmap[val&15]);
327 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
329 return HexStr(vch.begin(), vch.end(), fSpaces);
333 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
335 printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
338 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
340 printf(pszFormat, HexStr(vch, fSpaces).c_str());
343 inline int64_t GetTimeMillis()
345 return (boost::posix_time::microsec_clock::universal_time() -
346 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
349 inline int64_t GetTimeMicros()
351 return (boost::posix_time::microsec_clock::universal_time() -
352 boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_microseconds();
355 std::string DateTimeStrFormat(const char* pszFormat, int64_t nTime);
357 static const std::string strTimestampFormat = "%Y-%m-%d %H:%M:%S UTC";
358 inline std::string DateTimeStrFormat(int64_t nTime)
360 return DateTimeStrFormat(strTimestampFormat.c_str(), nTime);
365 void skipspaces(T& it)
371 inline bool IsSwitchChar(char c)
374 return c == '-' || c == '/';
381 * Return string argument or default value
383 * @param strArg Argument to get (e.g. "-foo")
384 * @param default (e.g. "1")
385 * @return command-line argument or default value
387 std::string GetArg(const std::string& strArg, const std::string& strDefault);
390 * Return 64-bit integer argument or default value
392 * @param strArg Argument to get (e.g. "-foo")
393 * @param default (e.g. 1)
394 * @return command-line argument (0 if invalid number) or default value
396 int64_t GetArg(const std::string& strArg, int64_t nDefault);
399 * Return 32-bit integer argument or default value
401 * @param strArg Argument to get (e.g. "-foo")
402 * @param default (e.g. 1)
403 * @return command-line argument (0 if invalid number) or default value
405 int32_t GetArgInt(const std::string& strArg, int32_t nDefault);
408 * Return 32-bit unsigned integer argument or default value
410 * @param strArg Argument to get (e.g. "-foo")
411 * @param default (e.g. 1)
412 * @return command-line argument (0 if invalid number) or default value
414 uint32_t GetArgUInt(const std::string& strArg, uint32_t nDefault);
417 * Return boolean argument or default value
419 * @param strArg Argument to get (e.g. "-foo")
420 * @param default (true or false)
421 * @return command-line argument or default value
423 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
426 * Set an argument if it doesn't already have a value
428 * @param strArg Argument to set (e.g. "-foo")
429 * @param strValue Value (e.g. "1")
430 * @return true if argument gets set, false if it already had a value
432 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
435 * Set a boolean argument if it doesn't already have a value
437 * @param strArg Argument to set (e.g. "-foo")
438 * @param fValue Value (e.g. false)
439 * @return true if argument gets set, false if it already had a value
441 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
444 * Timing-attack-resistant comparison.
445 * Takes time proportional to length
448 template <typename T>
449 bool TimingResistantEqual(const T& a, const T& b)
451 if (b.size() == 0) return a.size() == 0;
452 size_t accumulator = a.size() ^ b.size();
453 for (size_t i = 0; i < a.size(); i++)
454 accumulator |= a[i] ^ b[i%b.size()];
455 return accumulator == 0;
458 bool NewThread(void(*pfn)(void*), void* parg);
461 inline void SetThreadPriority(int nPriority)
463 SetThreadPriority(GetCurrentThread(), nPriority);
467 #define THREAD_PRIORITY_LOWEST PRIO_MAX
468 #define THREAD_PRIORITY_BELOW_NORMAL 2
469 #define THREAD_PRIORITY_NORMAL 0
470 #define THREAD_PRIORITY_ABOVE_NORMAL 0
472 inline void SetThreadPriority(int nPriority)
474 // It's unclear if it's even possible to change thread priorities on Linux,
475 // but we really and truly need it for the generation threads.
477 setpriority(PRIO_THREAD, 0, nPriority);
479 setpriority(PRIO_PROCESS, 0, nPriority);
483 inline void ExitThread(size_t nExitCode)
485 pthread_exit((void*)nExitCode);
489 void RenameThread(const char* name);
491 inline uint32_t ByteReverse(uint32_t value)
493 value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
494 return (value<<16) | (value>>16);