remove dependency on serialize.h and util.h for SecureString
[novacoin.git] / src / util.h
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 license.txt or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef BITCOIN_UTIL_H
6 #define BITCOIN_UTIL_H
7
8 #include "uint256.h"
9
10 #ifndef WIN32
11 #include <sys/types.h>
12 #include <sys/time.h>
13 #include <sys/resource.h>
14 #else
15 typedef int pid_t; /* define for windows compatiblity */
16 #endif
17 #include <map>
18 #include <vector>
19 #include <string>
20
21 #include <boost/thread.hpp>
22 #include <boost/interprocess/sync/interprocess_recursive_mutex.hpp>
23 #include <boost/date_time/gregorian/gregorian_types.hpp>
24 #include <boost/date_time/posix_time/posix_time_types.hpp>
25
26 #include <openssl/sha.h>
27 #include <openssl/ripemd.h>
28
29 #include "netbase.h"
30
31 typedef long long  int64;
32 typedef unsigned long long  uint64;
33
34 #define loop                for (;;)
35 #define BEGIN(a)            ((char*)&(a))
36 #define END(a)              ((char*)&((&(a))[1]))
37 #define UBEGIN(a)           ((unsigned char*)&(a))
38 #define UEND(a)             ((unsigned char*)&((&(a))[1]))
39 #define ARRAYLEN(array)     (sizeof(array)/sizeof((array)[0]))
40 #define printf              OutputDebugStringF
41
42 #ifdef snprintf
43 #undef snprintf
44 #endif
45 #define snprintf my_snprintf
46
47 #ifndef PRI64d
48 #if defined(_MSC_VER) || defined(__MSVCRT__)
49 #define PRI64d  "I64d"
50 #define PRI64u  "I64u"
51 #define PRI64x  "I64x"
52 #else
53 #define PRI64d  "lld"
54 #define PRI64u  "llu"
55 #define PRI64x  "llx"
56 #endif
57 #endif
58
59 // This is needed because the foreach macro can't get over the comma in pair<t1, t2>
60 #define PAIRTYPE(t1, t2)    std::pair<t1, t2>
61
62 // Align by increasing pointer, must have extra space at end of buffer
63 template <size_t nBytes, typename T>
64 T* alignup(T* p)
65 {
66     union
67     {
68         T* ptr;
69         size_t n;
70     } u;
71     u.ptr = p;
72     u.n = (u.n + (nBytes-1)) & ~(nBytes-1);
73     return u.ptr;
74 }
75
76 #ifdef WIN32
77 #define MSG_NOSIGNAL        0
78 #define MSG_DONTWAIT        0
79
80 #ifndef S_IRUSR
81 #define S_IRUSR             0400
82 #define S_IWUSR             0200
83 #endif
84 #define unlink              _unlink
85 #else
86 #define _vsnprintf(a,b,c,d) vsnprintf(a,b,c,d)
87 #define strlwr(psz)         to_lower(psz)
88 #define _strlwr(psz)        to_lower(psz)
89 #define MAX_PATH            1024
90 inline void Sleep(int64 n)
91 {
92     /*Boost has a year 2038 problem— if the request sleep time is past epoch+2^31 seconds the sleep returns instantly.
93       So we clamp our sleeps here to 10 years and hope that boost is fixed by 2028.*/
94     boost::thread::sleep(boost::get_system_time() + boost::posix_time::milliseconds(n>315576000000LL?315576000000LL:n));
95 }
96 #endif
97
98 #if !defined(QT_GUI)
99 inline const char* _(const char* psz)
100 {
101     return psz;
102 }
103 #endif
104
105
106
107
108
109
110
111
112
113 extern std::map<std::string, std::string> mapArgs;
114 extern std::map<std::string, std::vector<std::string> > mapMultiArgs;
115 extern bool fDebug;
116 extern bool fPrintToConsole;
117 extern bool fPrintToDebugger;
118 extern char pszSetDataDir[MAX_PATH];
119 extern bool fRequestShutdown;
120 extern bool fShutdown;
121 extern bool fDaemon;
122 extern bool fServer;
123 extern bool fCommandLine;
124 extern std::string strMiscWarning;
125 extern bool fTestNet;
126 extern bool fNoListen;
127 extern bool fLogTimestamps;
128
129 void RandAddSeed();
130 void RandAddSeedPerfmon();
131 int OutputDebugStringF(const char* pszFormat, ...);
132 int my_snprintf(char* buffer, size_t limit, const char* format, ...);
133
134 /* It is not allowed to use va_start with a pass-by-reference argument.
135    (C++ standard, 18.7, paragraph 3). Use a dummy argument to work around this, and use a
136    macro to keep similar semantics.
137 */
138 std::string real_strprintf(const std::string &format, int dummy, ...);
139 #define strprintf(format, ...) real_strprintf(format, 0, __VA_ARGS__)
140
141 bool error(const char *format, ...);
142 void LogException(std::exception* pex, const char* pszThread);
143 void PrintException(std::exception* pex, const char* pszThread);
144 void PrintExceptionContinue(std::exception* pex, const char* pszThread);
145 void ParseString(const std::string& str, char c, std::vector<std::string>& v);
146 std::string FormatMoney(int64 n, bool fPlus=false);
147 bool ParseMoney(const std::string& str, int64& nRet);
148 bool ParseMoney(const char* pszIn, int64& nRet);
149 std::vector<unsigned char> ParseHex(const char* psz);
150 std::vector<unsigned char> ParseHex(const std::string& str);
151 bool IsHex(const std::string& str);
152 std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = NULL);
153 std::string DecodeBase64(const std::string& str);
154 std::string EncodeBase64(const unsigned char* pch, size_t len);
155 std::string EncodeBase64(const std::string& str);
156 void ParseParameters(int argc, const char*const argv[]);
157 bool WildcardMatch(const char* psz, const char* mask);
158 bool WildcardMatch(const std::string& str, const std::string& mask);
159 int GetFilesize(FILE* file);
160 void GetDataDir(char* pszDirRet);
161 std::string GetConfigFile();
162 std::string GetPidFile();
163 void CreatePidFile(std::string pidFile, pid_t pid);
164 bool ReadConfigFile(std::map<std::string, std::string>& mapSettingsRet, std::map<std::string, std::vector<std::string> >& mapMultiSettingsRet);
165 #ifdef WIN32
166 std::string MyGetSpecialFolderPath(int nFolder, bool fCreate);
167 #endif
168 std::string GetDefaultDataDir();
169 std::string GetDataDir();
170 void ShrinkDebugFile();
171 int GetRandInt(int nMax);
172 uint64 GetRand(uint64 nMax);
173 int64 GetTime();
174 void SetMockTime(int64 nMockTimeIn);
175 int64 GetAdjustedTime();
176 std::string FormatFullVersion();
177 std::string FormatSubVersion(const std::string& name, int nClientVersion, const std::vector<std::string>& comments);
178 void AddTimeData(const CNetAddr& ip, int64 nTime);
179
180
181
182
183
184
185
186
187
188
189
190
191 /** Wrapper to automatically initialize mutex. */
192 class CCriticalSection
193 {
194 protected:
195     boost::interprocess::interprocess_recursive_mutex mutex;
196 public:
197     explicit CCriticalSection() { }
198     ~CCriticalSection() { }
199     void Enter(const char* pszName, const char* pszFile, int nLine);
200     void Leave();
201     bool TryEnter(const char* pszName, const char* pszFile, int nLine);
202 };
203
204 /** RAII object that acquires mutex. Needed for exception safety. */
205 class CCriticalBlock
206 {
207 protected:
208     CCriticalSection* pcs;
209
210 public:
211     CCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
212     {
213         pcs = &csIn;
214         pcs->Enter(pszName, pszFile, nLine);
215     }
216
217     operator bool() const
218     {
219         return true;
220     }
221
222     ~CCriticalBlock()
223     {
224         pcs->Leave();
225     }
226 };
227
228 #define CRITICAL_BLOCK(cs)     \
229     if (CCriticalBlock criticalblock = CCriticalBlock(cs, #cs, __FILE__, __LINE__))
230
231 #define ENTER_CRITICAL_SECTION(cs) \
232     (cs).Enter(#cs, __FILE__, __LINE__)
233
234 #define LEAVE_CRITICAL_SECTION(cs) \
235     (cs).Leave()
236
237 /** RAII object that tries to acquire mutex. Needed for exception safety. */
238 class CTryCriticalBlock
239 {
240 protected:
241     CCriticalSection* pcs;
242
243 public:
244     CTryCriticalBlock(CCriticalSection& csIn, const char* pszName, const char* pszFile, int nLine)
245     {
246         pcs = (csIn.TryEnter(pszName, pszFile, nLine) ? &csIn : NULL);
247     }
248
249     operator bool() const
250     {
251         return Entered();
252     }
253
254     ~CTryCriticalBlock()
255     {
256         if (pcs)
257         {
258             pcs->Leave();
259         }
260     }
261     bool Entered() const { return pcs != NULL; }
262 };
263
264 #define TRY_CRITICAL_BLOCK(cs)     \
265     if (CTryCriticalBlock criticalblock = CTryCriticalBlock(cs, #cs, __FILE__, __LINE__))
266
267
268
269
270 inline std::string i64tostr(int64 n)
271 {
272     return strprintf("%"PRI64d, n);
273 }
274
275 inline std::string itostr(int n)
276 {
277     return strprintf("%d", n);
278 }
279
280 inline int64 atoi64(const char* psz)
281 {
282 #ifdef _MSC_VER
283     return _atoi64(psz);
284 #else
285     return strtoll(psz, NULL, 10);
286 #endif
287 }
288
289 inline int64 atoi64(const std::string& str)
290 {
291 #ifdef _MSC_VER
292     return _atoi64(str.c_str());
293 #else
294     return strtoll(str.c_str(), NULL, 10);
295 #endif
296 }
297
298 inline int atoi(const std::string& str)
299 {
300     return atoi(str.c_str());
301 }
302
303 inline int roundint(double d)
304 {
305     return (int)(d > 0 ? d + 0.5 : d - 0.5);
306 }
307
308 inline int64 roundint64(double d)
309 {
310     return (int64)(d > 0 ? d + 0.5 : d - 0.5);
311 }
312
313 inline int64 abs64(int64 n)
314 {
315     return (n >= 0 ? n : -n);
316 }
317
318 template<typename T>
319 std::string HexStr(const T itbegin, const T itend, bool fSpaces=false)
320 {
321     if (itbegin == itend)
322         return "";
323     const unsigned char* pbegin = (const unsigned char*)&itbegin[0];
324     const unsigned char* pend = pbegin + (itend - itbegin) * sizeof(itbegin[0]);
325     std::string str;
326     str.reserve((pend-pbegin) * (fSpaces ? 3 : 2));
327     for (const unsigned char* p = pbegin; p != pend; p++)
328         str += strprintf((fSpaces && p != pend-1 ? "%02x " : "%02x"), *p);
329     return str;
330 }
331
332 inline std::string HexStr(const std::vector<unsigned char>& vch, bool fSpaces=false)
333 {
334     return HexStr(vch.begin(), vch.end(), fSpaces);
335 }
336
337 template<typename T>
338 void PrintHex(const T pbegin, const T pend, const char* pszFormat="%s", bool fSpaces=true)
339 {
340     printf(pszFormat, HexStr(pbegin, pend, fSpaces).c_str());
341 }
342
343 inline void PrintHex(const std::vector<unsigned char>& vch, const char* pszFormat="%s", bool fSpaces=true)
344 {
345     printf(pszFormat, HexStr(vch, fSpaces).c_str());
346 }
347
348 inline int64 GetPerformanceCounter()
349 {
350     int64 nCounter = 0;
351 #ifdef WIN32
352     QueryPerformanceCounter((LARGE_INTEGER*)&nCounter);
353 #else
354     timeval t;
355     gettimeofday(&t, NULL);
356     nCounter = t.tv_sec * 1000000 + t.tv_usec;
357 #endif
358     return nCounter;
359 }
360
361 inline int64 GetTimeMillis()
362 {
363     return (boost::posix_time::ptime(boost::posix_time::microsec_clock::universal_time()) -
364             boost::posix_time::ptime(boost::gregorian::date(1970,1,1))).total_milliseconds();
365 }
366
367 inline std::string DateTimeStrFormat(const char* pszFormat, int64 nTime)
368 {
369     time_t n = nTime;
370     struct tm* ptmTime = gmtime(&n);
371     char pszTime[200];
372     strftime(pszTime, sizeof(pszTime), pszFormat, ptmTime);
373     return pszTime;
374 }
375
376 template<typename T>
377 void skipspaces(T& it)
378 {
379     while (isspace(*it))
380         ++it;
381 }
382
383 inline bool IsSwitchChar(char c)
384 {
385 #ifdef WIN32
386     return c == '-' || c == '/';
387 #else
388     return c == '-';
389 #endif
390 }
391
392 /**
393  * Return string argument or default value
394  *
395  * @param strArg Argument to get (e.g. "-foo")
396  * @param default (e.g. "1")
397  * @return command-line argument or default value
398  */
399 std::string GetArg(const std::string& strArg, const std::string& strDefault);
400
401 /**
402  * Return integer argument or default value
403  *
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
407  */
408 int64 GetArg(const std::string& strArg, int64 nDefault);
409
410 /**
411  * Return boolean argument or default value
412  *
413  * @param strArg Argument to get (e.g. "-foo")
414  * @param default (true or false)
415  * @return command-line argument or default value
416  */
417 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
418
419 /**
420  * Set an argument if it doesn't already have a value
421  *
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
425  */
426 bool SoftSetArg(const std::string& strArg, const std::string& strValue);
427
428 /**
429  * Set a boolean argument if it doesn't already have a value
430  *
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
434  */
435 bool SoftSetBoolArg(const std::string& strArg, bool fValue);
436
437
438
439
440
441
442
443
444
445 // Randomize the stack to help protect against buffer overrun exploits
446 #define IMPLEMENT_RANDOMIZE_STACK(ThreadFn)     \
447     {                                           \
448         static char nLoops;                     \
449         if (nLoops <= 0)                        \
450             nLoops = GetRand(20) + 1;           \
451         if (nLoops-- > 1)                       \
452         {                                       \
453             ThreadFn;                           \
454             return;                             \
455         }                                       \
456     }
457
458
459 template<typename T1>
460 inline uint256 Hash(const T1 pbegin, const T1 pend)
461 {
462     static unsigned char pblank[1];
463     uint256 hash1;
464     SHA256((pbegin == pend ? pblank : (unsigned char*)&pbegin[0]), (pend - pbegin) * sizeof(pbegin[0]), (unsigned char*)&hash1);
465     uint256 hash2;
466     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
467     return hash2;
468 }
469
470 template<typename T1, typename T2>
471 inline uint256 Hash(const T1 p1begin, const T1 p1end,
472                     const T2 p2begin, const T2 p2end)
473 {
474     static unsigned char pblank[1];
475     uint256 hash1;
476     SHA256_CTX ctx;
477     SHA256_Init(&ctx);
478     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
479     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
480     SHA256_Final((unsigned char*)&hash1, &ctx);
481     uint256 hash2;
482     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
483     return hash2;
484 }
485
486 template<typename T1, typename T2, typename T3>
487 inline uint256 Hash(const T1 p1begin, const T1 p1end,
488                     const T2 p2begin, const T2 p2end,
489                     const T3 p3begin, const T3 p3end)
490 {
491     static unsigned char pblank[1];
492     uint256 hash1;
493     SHA256_CTX ctx;
494     SHA256_Init(&ctx);
495     SHA256_Update(&ctx, (p1begin == p1end ? pblank : (unsigned char*)&p1begin[0]), (p1end - p1begin) * sizeof(p1begin[0]));
496     SHA256_Update(&ctx, (p2begin == p2end ? pblank : (unsigned char*)&p2begin[0]), (p2end - p2begin) * sizeof(p2begin[0]));
497     SHA256_Update(&ctx, (p3begin == p3end ? pblank : (unsigned char*)&p3begin[0]), (p3end - p3begin) * sizeof(p3begin[0]));
498     SHA256_Final((unsigned char*)&hash1, &ctx);
499     uint256 hash2;
500     SHA256((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
501     return hash2;
502 }
503
504 template<typename T>
505 uint256 SerializeHash(const T& obj, int nType=SER_GETHASH, int nVersion=PROTOCOL_VERSION)
506 {
507     // Most of the time is spent allocating and deallocating CDataStream's
508     // buffer.  If this ever needs to be optimized further, make a CStaticStream
509     // class with its buffer on the stack.
510     CDataStream ss(nType, nVersion);
511     ss.reserve(10000);
512     ss << obj;
513     return Hash(ss.begin(), ss.end());
514 }
515
516 inline uint160 Hash160(const std::vector<unsigned char>& vch)
517 {
518     uint256 hash1;
519     SHA256(&vch[0], vch.size(), (unsigned char*)&hash1);
520     uint160 hash2;
521     RIPEMD160((unsigned char*)&hash1, sizeof(hash1), (unsigned char*)&hash2);
522     return hash2;
523 }
524
525
526 /** Median filter over a stream of values. 
527  * Returns the median of the last N numbers
528  */
529 template <typename T> class CMedianFilter
530 {
531 private:
532     std::vector<T> vValues;
533     std::vector<T> vSorted;
534     int nSize;
535 public:
536     CMedianFilter(int size, T initial_value):
537         nSize(size)
538     {
539         vValues.reserve(size);
540         vValues.push_back(initial_value);
541         vSorted = vValues;
542     }
543     
544     void input(T value)
545     {
546         if(vValues.size() == nSize)
547         {
548             vValues.erase(vValues.begin());
549         }
550         vValues.push_back(value);
551
552         vSorted.resize(vValues.size());
553         std::copy(vValues.begin(), vValues.end(), vSorted.begin());
554         std::sort(vSorted.begin(), vSorted.end());
555     }
556
557     T median() const
558     {
559         int size = vSorted.size();
560         assert(size>0);
561         if(size & 1) // Odd number of elements
562         {
563             return vSorted[size/2];
564         }
565         else // Even number of elements
566         {
567             return (vSorted[size/2-1] + vSorted[size/2]) / 2;
568         }
569     }
570
571     int size() const
572     {
573         return vValues.size();
574     }
575
576     std::vector<T> sorted () const
577     {
578         return vSorted;
579     }
580 };
581
582
583
584
585
586
587
588
589
590
591 // Note: It turns out we might have been able to use boost::thread
592 // by using TerminateThread(boost::thread.native_handle(), 0);
593 #ifdef WIN32
594 typedef HANDLE pthread_t;
595
596 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
597 {
598     DWORD nUnused = 0;
599     HANDLE hthread =
600         CreateThread(
601             NULL,                        // default security
602             0,                           // inherit stack size from parent
603             (LPTHREAD_START_ROUTINE)pfn, // function pointer
604             parg,                        // argument
605             0,                           // creation option, start immediately
606             &nUnused);                   // thread identifier
607     if (hthread == NULL)
608     {
609         printf("Error: CreateThread() returned %d\n", GetLastError());
610         return (pthread_t)0;
611     }
612     if (!fWantHandle)
613     {
614         CloseHandle(hthread);
615         return (pthread_t)-1;
616     }
617     return hthread;
618 }
619
620 inline void SetThreadPriority(int nPriority)
621 {
622     SetThreadPriority(GetCurrentThread(), nPriority);
623 }
624 #else
625 inline pthread_t CreateThread(void(*pfn)(void*), void* parg, bool fWantHandle=false)
626 {
627     pthread_t hthread = 0;
628     int ret = pthread_create(&hthread, NULL, (void*(*)(void*))pfn, parg);
629     if (ret != 0)
630     {
631         printf("Error: pthread_create() returned %d\n", ret);
632         return (pthread_t)0;
633     }
634     if (!fWantHandle)
635     {
636         pthread_detach(hthread);
637         return (pthread_t)-1;
638     }
639     return hthread;
640 }
641
642 #define THREAD_PRIORITY_LOWEST          PRIO_MAX
643 #define THREAD_PRIORITY_BELOW_NORMAL    2
644 #define THREAD_PRIORITY_NORMAL          0
645 #define THREAD_PRIORITY_ABOVE_NORMAL    0
646
647 inline void SetThreadPriority(int nPriority)
648 {
649     // It's unclear if it's even possible to change thread priorities on Linux,
650     // but we really and truly need it for the generation threads.
651 #ifdef PRIO_THREAD
652     setpriority(PRIO_THREAD, 0, nPriority);
653 #else
654     setpriority(PRIO_PROCESS, 0, nPriority);
655 #endif
656 }
657
658 inline void ExitThread(size_t nExitCode)
659 {
660     pthread_exit((void*)nExitCode);
661 }
662 #endif
663
664
665
666
667
668 inline bool AffinityBugWorkaround(void(*pfn)(void*))
669 {
670 #ifdef WIN32
671     // Sometimes after a few hours affinity gets stuck on one processor
672     DWORD_PTR dwProcessAffinityMask = -1;
673     DWORD_PTR dwSystemAffinityMask = -1;
674     GetProcessAffinityMask(GetCurrentProcess(), &dwProcessAffinityMask, &dwSystemAffinityMask);
675     DWORD dwPrev1 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
676     DWORD dwPrev2 = SetThreadAffinityMask(GetCurrentThread(), dwProcessAffinityMask);
677     if (dwPrev2 != dwProcessAffinityMask)
678     {
679         printf("AffinityBugWorkaround() : SetThreadAffinityMask=%d, ProcessAffinityMask=%d, restarting thread\n", dwPrev2, dwProcessAffinityMask);
680         if (!CreateThread(pfn, NULL))
681             printf("Error: CreateThread() failed\n");
682         return true;
683     }
684 #endif
685     return false;
686 }
687
688 inline uint32_t ByteReverse(uint32_t value)
689 {
690     value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8);
691     return (value<<16) | (value>>16);
692 }
693
694 #endif
695