You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
582 lines
16 KiB
582 lines
16 KiB
// Copyright (c) 2009-2010 Satoshi Nakamoto |
|
// Copyright (c) 2009-2012 The Bitcoin developers |
|
// Distributed under the MIT/X11 software license, see the accompanying |
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php. |
|
#ifndef BITCOIN_UTIL_H |
|
#define BITCOIN_UTIL_H |
|
|
|
#include "uint256.h" |
|
|
|
#include <stdarg.h> |
|
|
|
#ifndef WIN32 |
|
#include <sys/types.h> |
|
#include <sys/time.h> |
|
#include <sys/resource.h> |
|
#endif |
|
#include <map> |
|
#include <list> |
|
#include <utility> |
|
#include <vector> |
|
#include <string> |
|
|
|
#include <boost/version.hpp> |
|
#include <boost/thread.hpp> |
|
#include <boost/filesystem.hpp> |
|
#include <boost/filesystem/path.hpp> |
|
#include <boost/date_time/gregorian/gregorian_types.hpp> |
|
#include <boost/date_time/posix_time/posix_time_types.hpp> |
|
|
|
#include "netbase.h" // for AddTimeData |
|
|
|
typedef long long int64; |
|
typedef unsigned long long uint64; |
|
|
|
static const int64 COIN = 100000000; |
|
static const int64 CENT = 1000000; |
|
|
|
#define BEGIN(a) ((char*)&(a)) |
|
#define END(a) ((char*)&((&(a))[1])) |
|
#define UBEGIN(a) ((unsigned char*)&(a)) |
|
#define UEND(a) ((unsigned char*)&((&(a))[1])) |
|
#define ARRAYLEN(array) (sizeof(array)/sizeof((array)[0])) |
|
|
|
#ifndef PRI64d |
|
#if defined(_MSC_VER) || defined(__MSVCRT__) |
|
#define PRI64d "I64d" |
|
#define PRI64u "I64u" |
|
#define PRI64x "I64x" |
|
#else |
|
#define PRI64d "lld" |
|
#define PRI64u "llu" |
|
#define PRI64x "llx" |
|
#endif |
|
#endif |
|
|
|
/* Format characters for (s)size_t and ptrdiff_t */ |
|
#if defined(_MSC_VER) || defined(__MSVCRT__) |
|
/* (s)size_t and ptrdiff_t have the same size specifier in MSVC: |
|
http://msdn.microsoft.com/en-us/library/tcxf1dw6%28v=vs.100%29.aspx |
|
*/ |
|
#define PRIszx "Ix" |
|
#define PRIszu "Iu" |
|
#define PRIszd "Id" |
|
#define PRIpdx "Ix" |
|
#define PRIpdu "Iu" |
|
#define PRIpdd "Id" |
|
#else /* C99 standard */ |
|
#define PRIszx "zx" |
|
#define PRIszu "zu" |
|
#define PRIszd "zd" |
|
#define PRIpdx "tx" |
|
#define PRIpdu "tu" |
|
#define PRIpdd "td" |
|
#endif |
|
|
|
// This is needed because the foreach macro can't get over the comma in pair<t1, t2> |
|
#define PAIRTYPE(t1, t2) std::pair<t1, t2> |
|
|
|
// Align by increasing pointer, must have extra space at end of buffer |
|
template <size_t nBytes, typename T> |
|
T* alignup(T* p) |
|
{ |
|
union |
|
{ |
|
T* ptr; |
|
size_t n; |
|
} u; |
|
u.ptr = p; |
|
u.n = (u.n + (nBytes-1)) & ~(nBytes-1); |
|
return u.ptr; |
|
} |
|
|
|
#ifdef WIN32 |
|
#define MSG_NOSIGNAL 0 |
|
#define MSG_DONTWAIT 0 |
|
|
|
#ifndef S_IRUSR |
|
#define S_IRUSR 0400 |
|
#define S_IWUSR 0200 |
|
#endif |
|
#else |
|
#define MAX_PATH 1024 |
|
#endif |
|
|
|
inline void MilliSleep(int64 n) |
|
{ |
|
// Boost's sleep_for was uninterruptable when backed by nanosleep from 1.50 |
|
// until fixed in 1.52. Use the deprecated sleep method for the broken case. |
|
// See: https://svn.boost.org/trac/boost/ticket/7238 |
|
|
|
#if BOOST_VERSION >= 105000 && (!defined(BOOST_HAS_NANOSLEEP) || BOOST_VERSION >= 105200) |
|
boost::this_thread::sleep_for(boost::chrono::milliseconds(n)); |
|
#else |
|
boost::this_thread::sleep(boost::posix_time::milliseconds(n)); |
|
#endif |
|
} |
|
|
|
/* This GNU C extension enables the compiler to check the format string against the parameters provided. |
|
* X is the number of the "format string" parameter, and Y is the number of the first variadic parameter. |
|
* Parameters count from 1. |
|
*/ |
|
#ifdef __GNUC__ |
|
#define ATTR_WARN_PRINTF(X,Y) __attribute__((format(printf,X,Y))) |
|
#else |
|
#define ATTR_WARN_PRINTF(X,Y) |
|
#endif |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
extern std::map<std::string, std::string> mapArgs; |
|
extern std::map<std::string, std::vector<std::string> > mapMultiArgs; |
|
extern bool fDebug; |
|
extern bool fDebugNet; |
|
extern bool fPrintToConsole; |
|
extern bool fPrintToDebugger; |
|
extern bool fDaemon; |
|
extern bool fServer; |
|
extern bool fCommandLine; |
|
extern std::string strMiscWarning; |
|
extern bool fNoListen; |
|
extern bool fLogTimestamps; |
|
extern volatile bool fReopenDebugLog; |
|
|
|
void RandAddSeed(); |
|
void RandAddSeedPerfmon(); |
|
int ATTR_WARN_PRINTF(1,2) OutputDebugStringF(const char* pszFormat, ...); |
|
|
|
/* |
|
Rationale for the real_strprintf / strprintf construction: |
|
It is not allowed to use va_start with a pass-by-reference argument. |
|
(C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a |
|
macro to keep similar semantics. |
|
*/ |
|
|
|
/** Overload strprintf for char*, so that GCC format type warnings can be given */ |
|
std::string ATTR_WARN_PRINTF(1,3) real_strprintf(const char *format, int dummy, ...); |
|
/** Overload strprintf for std::string, to be able to use it with _ (translation). |
|
* This will not support GCC format type warnings (-Wformat) so be careful. |
|
*/ |
|
std::string real_strprintf(const std::string &format, int dummy, ...); |
|
#define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__) |
|
std::string vstrprintf(const char *format, va_list ap); |
|
|
|
bool ATTR_WARN_PRINTF(1,2) error(const char *format, ...); |
|
|
|
/* Redefine printf so that it directs output to debug.log |
|
* |
|
* Do this *after* defining the other printf-like functions, because otherwise the |
|
* __attribute__((format(printf,X,Y))) gets expanded to __attribute__((format(OutputDebugStringF,X,Y))) |
|
* which confuses gcc. |
|
*/ |
|
#define printf OutputDebugStringF |
|
|
|
void LogException(std::exception* pex, const char* pszThread); |
|
void PrintException(std::exception* pex, const char* pszThread); |
|
void PrintExceptionContinue(std::exception* pex, const char* pszThread); |
|
void ParseString(const std::string& str, char c, std::vector<std::string>& v); |
|
std::string FormatMoney(int64 n, bool fPlus=false); |
|
bool ParseMoney(const std::string& str, int64& nRet); |
|
bool ParseMoney(const char* pszIn, int64& nRet); |
|
std::vector<unsigned char> ParseHex(const char* psz); |
|
std::vector<unsigned char> ParseHex(const std::string& str); |
|
bool IsHex(const std::string& str); |
|
std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL); |
|
std::string DecodeBase64(const std::string& str); |
|
std::string EncodeBase64(const unsigned char* pch, size_t len); |
|
std::string EncodeBase64(const std::string& str); |
|
std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = NULL); |
|
std::string DecodeBase32(const std::string& str); |
|
std::string EncodeBase32(const unsigned char* pch, size_t len); |
|
std::string EncodeBase32(const std::string& str); |
|
void ParseParameters(int argc, const char*const argv[]); |
|
bool WildcardMatch(const char* psz, const char* mask); |
|
bool WildcardMatch(const std::string& str, const std::string& mask); |
|
void FileCommit(FILE *fileout); |
|
int GetFilesize(FILE* file); |
|
bool TruncateFile(FILE *file, unsigned int length); |
|
int RaiseFileDescriptorLimit(int nMinFD); |
|
void AllocateFileRange(FILE *file, unsigned int offset, unsigned int length); |
|
bool RenameOver(boost::filesystem::path src, boost::filesystem::path dest); |
|
boost::filesystem::path GetDefaultDataDir(); |
|
const boost::filesystem::path &GetDataDir(bool fNetSpecific = true); |
|
boost::filesystem::path GetConfigFile(); |
|
boost::filesystem::path GetPidFile(); |
|
void CreatePidFile(const boost::filesystem::path &path, pid_t pid); |
|
void ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet); |
|
#ifdef WIN32 |
|
boost::filesystem::path GetSpecialFolderPath(int nFolder, bool fCreate = true); |
|
#endif |
|
boost::filesystem::path GetTempPath(); |
|
void ShrinkDebugFile(); |
|
int GetRandInt(int nMax); |
|
uint64 GetRand(uint64 nMax); |
|
uint256 GetRandHash(); |
|
int64 GetTime(); |
|
void SetMockTime(int64 nMockTimeIn); |
|
int64 GetAdjustedTime(); |
|
int64 GetTimeOffset(); |
|
std::string FormatFullVersion(); |
|
std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments); |
|
void AddTimeData(const CNetAddr& ip, int64 nTime); |
|
void runCommand(std::string strCommand); |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
inline std::string i64tostr(int64 n) |
|
{ |
|
return strprintf("%"PRI64d, n); |
|
} |
|
|
|
inline std::string itostr(int n) |
|
{ |
|
return strprintf("%d", n); |
|
} |
|
|
|
inline int64 atoi64(const char* psz) |
|
{ |
|
#ifdef _MSC_VER |
|
return _atoi64(psz); |
|
#else |
|
return strtoll(psz, NULL, 10); |
|
#endif |
|
} |
|
|
|
inline int64 atoi64(const std::string& str) |
|
{ |
|
#ifdef _MSC_VER |
|
return _atoi64(str.c_str()); |
|
#else |
|
return strtoll(str.c_str(), NULL, 10); |
|
#endif |
|
} |
|
|
|
inline int atoi(const std::string& str) |
|
{ |
|
return atoi(str.c_str()); |
|
} |
|
|
|
inline int roundint(double d) |
|
{ |
|
return (int)(d > 0 ? d + 0.5 : d - 0.5); |
|
} |
|
|
|
inline int64 roundint64(double d) |
|
{ |
|
return (int64)(d > 0 ? d + 0.5 : d - 0.5); |
|
} |
|
|
|
inline int64 abs64(int64 n) |
|
{ |
|
return (n >= 0 ? n : -n); |
|
} |
|
|
|
template<typename T> |
|
std::string HexStr(const T itbegin, const T itend, bool fSpaces=false) |
|
{ |
|
std::string rv; |
|
static const char hexmap[16] = { '0', '1', '2', '3', '4', '5', '6', '7', |
|
'8', '9', 'a', 'b', 'c', 'd', 'e', 'f' }; |
|
rv.reserve((itend-itbegin)*3); |
|
for(T it = itbegin; it < itend; ++it) |
|
{ |
|
unsigned char val = (unsigned char)(*it); |
|
if(fSpaces && it != itbegin) |
|
rv.push_back(' '); |
|
rv.push_back(hexmap[val>>4]); |
|
rv.push_back(hexmap[val&15]); |
|
} |
|
|
|
return rv; |
|
} |
|
|
|
template<typename T> |
|
inline std::string HexStr(const T& vch, bool fSpaces=false) |
|
{ |
|
return HexStr(vch.begin(), vch.end(), fSpaces); |
|
} |
|
|
|
template<typename T> |
|
void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true) |
|
{ |
|
printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str()); |
|
} |
|
|
|
inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true) |
|
{ |
|
printf(pszFormat, HexStr(vch, fSpaces).c_str()); |
|
} |
|
|
|
inline int64 GetPerformanceCounter() |
|
{ |
|
int64 nCounter = 0; |
|
#ifdef WIN32 |
|
QueryPerformanceCounter((LARGE_INTEGER*)&nCounter); |
|
#else |
|
timeval t; |
|
gettimeofday(&t, NULL); |
|
nCounter = (int64) t.tv_sec * 1000000 + t.tv_usec; |
|
#endif |
|
return nCounter; |
|
} |
|
|
|
inline int64 GetTimeMillis() |
|
{ |
|
return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) - |
|
boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds(); |
|
} |
|
|
|
inline int64 GetTimeMicros() |
|
{ |
|
return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) - |
|
boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_microseconds(); |
|
} |
|
|
|
inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime) |
|
{ |
|
time_t n = nTime; |
|
struct tm* ptmTime = gmtime(&n); |
|
char pszTime[200]; |
|
strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime); |
|
return pszTime; |
|
} |
|
|
|
template<typename T> |
|
void skipspaces(T& it) |
|
{ |
|
while (isspace(*it)) |
|
++it; |
|
} |
|
|
|
inline bool IsSwitchChar(char c) |
|
{ |
|
#ifdef WIN32 |
|
return c == '-' || c == '/'; |
|
#else |
|
return c == '-'; |
|
#endif |
|
} |
|
|
|
/** |
|
* Return string argument or default value |
|
* |
|
* @param strArg Argument to get (e.g. "-foo") |
|
* @param default (e.g. "1") |
|
* @return command-line argument or default value |
|
*/ |
|
std::string GetArg(const std::string& strArg, const std::string& strDefault); |
|
|
|
/** |
|
* Return integer argument or default value |
|
* |
|
* @param strArg Argument to get (e.g. "-foo") |
|
* @param default (e.g. 1) |
|
* @return command-line argument (0 if invalid number) or default value |
|
*/ |
|
int64 GetArg(const std::string& strArg, int64 nDefault); |
|
|
|
/** |
|
* Return boolean argument or default value |
|
* |
|
* @param strArg Argument to get (e.g. "-foo") |
|
* @param default (true or false) |
|
* @return command-line argument or default value |
|
*/ |
|
bool GetBoolArg(const std::string& strArg, bool fDefault); |
|
|
|
/** |
|
* Set an argument if it doesn't already have a value |
|
* |
|
* @param strArg Argument to set (e.g. "-foo") |
|
* @param strValue Value (e.g. "1") |
|
* @return true if argument gets set, false if it already had a value |
|
*/ |
|
bool SoftSetArg(const std::string& strArg, const std::string& strValue); |
|
|
|
/** |
|
* Set a boolean argument if it doesn't already have a value |
|
* |
|
* @param strArg Argument to set (e.g. "-foo") |
|
* @param fValue Value (e.g. false) |
|
* @return true if argument gets set, false if it already had a value |
|
*/ |
|
bool SoftSetBoolArg(const std::string& strArg, bool fValue); |
|
|
|
/** |
|
* MWC RNG of George Marsaglia |
|
* This is intended to be fast. It has a period of 2^59.3, though the |
|
* least significant 16 bits only have a period of about 2^30.1. |
|
* |
|
* @return random value |
|
*/ |
|
extern uint32_t insecure_rand_Rz; |
|
extern uint32_t insecure_rand_Rw; |
|
static inline uint32_t insecure_rand(void) |
|
{ |
|
insecure_rand_Rz = 36969 * (insecure_rand_Rz & 65535) + (insecure_rand_Rz >> 16); |
|
insecure_rand_Rw = 18000 * (insecure_rand_Rw & 65535) + (insecure_rand_Rw >> 16); |
|
return (insecure_rand_Rw << 16) + insecure_rand_Rz; |
|
} |
|
|
|
/** |
|
* Seed insecure_rand using the random pool. |
|
* @param Deterministic Use a determinstic seed |
|
*/ |
|
void seed_insecure_rand(bool fDeterministic=false); |
|
|
|
/** Median filter over a stream of values. |
|
* Returns the median of the last N numbers |
|
*/ |
|
template <typename T> class CMedianFilter |
|
{ |
|
private: |
|
std::vector<T> vValues; |
|
std::vector<T> vSorted; |
|
unsigned int nSize; |
|
public: |
|
CMedianFilter(unsigned int size, T initial_value): |
|
nSize(size) |
|
{ |
|
vValues.reserve(size); |
|
vValues.push_back(initial_value); |
|
vSorted = vValues; |
|
} |
|
|
|
void input(T value) |
|
{ |
|
if(vValues.size() == nSize) |
|
{ |
|
vValues.erase(vValues.begin()); |
|
} |
|
vValues.push_back(value); |
|
|
|
vSorted.resize(vValues.size()); |
|
std::copy(vValues.begin(), vValues.end(), vSorted.begin()); |
|
std::sort(vSorted.begin(), vSorted.end()); |
|
} |
|
|
|
T median() const |
|
{ |
|
int size = vSorted.size(); |
|
assert(size>0); |
|
if(size & 1) // Odd number of elements |
|
{ |
|
return vSorted[size/2]; |
|
} |
|
else // Even number of elements |
|
{ |
|
return (vSorted[size/2-1] + vSorted[size/2]) / 2; |
|
} |
|
} |
|
|
|
int size() const |
|
{ |
|
return vValues.size(); |
|
} |
|
|
|
std::vector<T> sorted () const |
|
{ |
|
return vSorted; |
|
} |
|
}; |
|
|
|
#ifdef WIN32 |
|
inline void SetThreadPriority(int nPriority) |
|
{ |
|
SetThreadPriority(GetCurrentThread(), nPriority); |
|
} |
|
#else |
|
|
|
#define THREAD_PRIORITY_LOWEST PRIO_MAX |
|
#define THREAD_PRIORITY_BELOW_NORMAL 2 |
|
#define THREAD_PRIORITY_NORMAL 0 |
|
#define THREAD_PRIORITY_ABOVE_NORMAL (-2) |
|
|
|
inline void SetThreadPriority(int nPriority) |
|
{ |
|
// It's unclear if it's even possible to change thread priorities on Linux, |
|
// but we really and truly need it for the generation threads. |
|
#ifdef PRIO_THREAD |
|
setpriority(PRIO_THREAD, 0, nPriority); |
|
#else |
|
setpriority(PRIO_PROCESS, 0, nPriority); |
|
#endif |
|
} |
|
#endif |
|
|
|
void RenameThread(const char* name); |
|
|
|
inline uint32_t ByteReverse(uint32_t value) |
|
{ |
|
value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8); |
|
return (value<<16) | (value>>16); |
|
} |
|
|
|
// Standard wrapper for do-something-forever thread functions. |
|
// "Forever" really means until the thread is interrupted. |
|
// Use it like: |
|
// new boost::thread(boost::bind(&LoopForever<void (*)()>, "dumpaddr", &DumpAddresses, 900000)); |
|
// or maybe: |
|
// boost::function<void()> f = boost::bind(&FunctionWithArg, argument); |
|
// threadGroup.create_thread(boost::bind(&LoopForever<boost::function<void()> >, "nothing", f, milliseconds)); |
|
template <typename Callable> void LoopForever(const char* name, Callable func, int64 msecs) |
|
{ |
|
std::string s = strprintf("bitcoin-%s", name); |
|
RenameThread(s.c_str()); |
|
printf("%s thread start\n", name); |
|
try |
|
{ |
|
while (1) |
|
{ |
|
MilliSleep(msecs); |
|
func(); |
|
} |
|
} |
|
catch (boost::thread_interrupted) |
|
{ |
|
printf("%s thread stop\n", name); |
|
throw; |
|
} |
|
catch (std::exception& e) { |
|
PrintException(&e, name); |
|
} |
|
catch (...) { |
|
PrintException(NULL, name); |
|
} |
|
} |
|
// .. and a wrapper that just calls func once |
|
template <typename Callable> void TraceThread(const char* name, Callable func) |
|
{ |
|
std::string s = strprintf("bitcoin-%s", name); |
|
RenameThread(s.c_str()); |
|
try |
|
{ |
|
printf("%s thread start\n", name); |
|
func(); |
|
printf("%s thread exit\n", name); |
|
} |
|
catch (boost::thread_interrupted) |
|
{ |
|
printf("%s thread interrupt\n", name); |
|
throw; |
|
} |
|
catch (std::exception& e) { |
|
PrintException(&e, name); |
|
} |
|
catch (...) { |
|
PrintException(NULL, name); |
|
} |
|
} |
|
|
|
#endif
|
|
|