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.
5 #ifndef BITCOIN_SERIALIZE_H
6 #define BITCOIN_SERIALIZE_H
18 #include <boost/type_traits/is_fundamental.hpp>
19 #include <boost/tuple/tuple.hpp>
20 #include <boost/tuple/tuple_comparison.hpp>
21 #include <boost/tuple/tuple_io.hpp>
24 #if defined __USE_MINGW_ANSI_STDIO
25 #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior
29 #include "allocators.h"
36 static const unsigned int MAX_SIZE = 0x02000000;
38 // Used to bypass the rule against non-const reference to temporary
39 // where it makes sense with wrappers such as CFlatData or CTxDB
41 inline T& REF(const T& val)
43 return const_cast<T&>(val);
46 /////////////////////////////////////////////////////////////////
48 // Templates for serializing to anything that looks like a stream,
49 // i.e. anything that supports .read(char*, int) and .write(char*, int)
55 SER_NETWORK = (1 << 0),
57 SER_GETHASH = (1 << 2),
60 SER_SKIPSIG = (1 << 16),
61 SER_BLOCKHEADERONLY = (1 << 17)
65 #define IMPLEMENT_SERIALIZE(statements) \
66 unsigned int GetSerializeSize(int nType, int nVersion) const \
68 CSerActionGetSerializeSize ser_action; \
69 const bool fGetSize = true; \
70 const bool fWrite = false; \
71 const bool fRead = false; \
72 unsigned int nSerSize = 0; \
73 ser_streamplaceholder s; \
74 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
76 s.nVersion = nVersion; \
80 template<typename Stream> \
81 void Serialize(Stream& s, int nType, int nVersion) const \
83 CSerActionSerialize ser_action; \
84 const bool fGetSize = false; \
85 const bool fWrite = true; \
86 const bool fRead = false; \
87 unsigned int nSerSize = 0; \
88 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
91 template<typename Stream> \
92 void Unserialize(Stream& s, int nType, int nVersion) \
94 CSerActionUnserialize ser_action; \
95 const bool fGetSize = false; \
96 const bool fWrite = false; \
97 const bool fRead = true; \
98 unsigned int nSerSize = 0; \
99 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
103 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
113 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
114 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
116 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
117 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
118 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
119 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
120 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
121 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
122 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
123 //inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
124 //inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
125 inline unsigned int GetSerializeSize(int64_t a, int, int=0) { return sizeof(a); }
126 inline unsigned int GetSerializeSize(uint64_t a, int, int=0) { return sizeof(a); }
127 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
128 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
130 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
131 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
132 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
133 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
134 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
135 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
136 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
137 //template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
138 //template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
139 template<typename Stream> inline void Serialize(Stream& s, int64_t a, int, int=0) { WRITEDATA(s, a); }
140 template<typename Stream> inline void Serialize(Stream& s, uint64_t a, int, int=0) { WRITEDATA(s, a); }
141 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
142 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
144 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
145 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
146 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
147 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
148 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
149 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
150 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
151 //template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
152 //template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
153 template<typename Stream> inline void Unserialize(Stream& s, int64_t& a, int, int=0) { READDATA(s, a); }
154 template<typename Stream> inline void Unserialize(Stream& s, uint64_t& a, int, int=0) { READDATA(s, a); }
155 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
156 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
158 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
159 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
160 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
169 // size < 253 -- 1 byte
170 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
171 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
172 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
174 inline unsigned int GetSizeOfCompactSize(uint64_t nSize)
176 if (nSize < 253) return sizeof(unsigned char);
177 else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
178 else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
179 else return sizeof(unsigned char) + sizeof(uint64_t);
182 template<typename Stream>
183 void WriteCompactSize(Stream& os, uint64_t nSize)
187 unsigned char chSize = (unsigned char)nSize;
188 WRITEDATA(os, chSize);
190 else if (nSize <= std::numeric_limits<unsigned short>::max())
192 unsigned char chSize = 253;
193 unsigned short xSize = (unsigned short)nSize;
194 WRITEDATA(os, chSize);
195 WRITEDATA(os, xSize);
197 else if (nSize <= std::numeric_limits<unsigned int>::max())
199 unsigned char chSize = 254;
200 unsigned int xSize = (unsigned int)nSize;
201 WRITEDATA(os, chSize);
202 WRITEDATA(os, xSize);
206 unsigned char chSize = 255;
207 uint64_t xSize = nSize;
208 WRITEDATA(os, chSize);
209 WRITEDATA(os, xSize);
214 template<typename Stream>
215 uint64_t ReadCompactSize(Stream& is)
217 unsigned char chSize;
218 READDATA(is, chSize);
219 uint64_t nSizeRet = 0;
224 else if (chSize == 253)
226 unsigned short xSize;
230 else if (chSize == 254)
242 if (nSizeRet > (uint64_t)MAX_SIZE)
243 throw std::ios_base::failure("ReadCompactSize() : size too large");
247 // Variable-length integers: bytes are a MSB base-128 encoding of the number.
248 // The high bit in each byte signifies whether another digit follows. To make
249 // the encoding is one-to-one, one is subtracted from all but the last digit.
250 // Thus, the byte sequence a[] with length len, where all but the last byte
251 // has bit 128 set, encodes the number:
253 // (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))
256 // * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
257 // * Every integer has exactly one encoding
258 // * Encoding does not depend on size of original integer type
259 // * No redundancy: every (infinite) byte sequence corresponds to a list
260 // of encoded integers.
262 // 0: [0x00] 256: [0x81 0x00]
263 // 1: [0x01] 16383: [0xFE 0x7F]
264 // 127: [0x7F] 16384: [0xFF 0x00]
265 // 128: [0x80 0x00] 16511: [0x80 0xFF 0x7F]
266 // 255: [0x80 0x7F] 65535: [0x82 0xFD 0x7F]
267 // 2^32: [0x8E 0xFE 0xFE 0xFF 0x00]
270 inline unsigned int GetSizeOfVarInt(I n)
282 template<typename Stream, typename I>
283 void WriteVarInt(Stream& os, I n)
285 unsigned char tmp[(sizeof(n)*8+6)/7];
288 tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00);
295 WRITEDATA(os, tmp[len]);
299 template<typename Stream, typename I>
300 I ReadVarInt(Stream& is)
304 unsigned char chData;
305 READDATA(is, chData);
306 n = (n << 7) | (chData & 0x7F);
314 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
315 #define VARINT(obj) REF(WrapVarInt(REF(obj)))
317 /** Wrapper for serializing arrays and POD.
325 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
326 char* begin() { return pbegin; }
327 const char* begin() const { return pbegin; }
328 char* end() { return pend; }
329 const char* end() const { return pend; }
331 unsigned int GetSerializeSize(int, int=0) const
333 return (unsigned int)(pend - pbegin);
336 template<typename Stream>
337 void Serialize(Stream& s, int, int=0) const
339 s.write(pbegin, (int)(pend - pbegin));
342 template<typename Stream>
343 void Unserialize(Stream& s, int, int=0)
345 s.read(pbegin, pend - pbegin);
355 CVarInt(I& nIn) : n(nIn) { }
357 unsigned int GetSerializeSize(int, int) const {
358 return GetSizeOfVarInt<I>(n);
361 template<typename Stream>
362 void Serialize(Stream &s, int, int) const {
363 WriteVarInt<Stream,I>(s, n);
366 template<typename Stream>
367 void Unserialize(Stream& s, int, int) {
368 n = ReadVarInt<Stream,I>(s);
373 CVarInt<I> WrapVarInt(I& n) { return CVarInt<I>(n); }
376 // Forward declarations
380 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
381 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
382 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
385 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
386 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
387 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion);
388 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
389 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
390 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion);
391 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
392 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
393 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion);
395 // others derived from vector
396 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion);
397 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion);
398 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion);
401 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion);
402 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion);
403 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion);
406 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
407 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
408 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
411 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
412 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
413 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
416 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion);
417 template<typename Stream, typename K, typename T, typename Pred, typename A> void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion);
418 template<typename Stream, typename K, typename T, typename Pred, typename A> void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion);
421 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion);
422 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion);
423 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion);
430 // If none of the specialized versions above matched, default to calling member function.
431 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
432 // The compiler will only cast int to long if none of the other templates matched.
433 // Thanks to Boost serialization for this idea.
436 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion)
438 return a.GetSerializeSize((int)nType, nVersion);
441 template<typename Stream, typename T>
442 inline void Serialize(Stream& os, const T& a, long nType, int nVersion)
444 a.Serialize(os, (int)nType, nVersion);
447 template<typename Stream, typename T>
448 inline void Unserialize(Stream& is, T& a, long nType, int nVersion)
450 a.Unserialize(is, (int)nType, nVersion);
461 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
463 return (unsigned int)(GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]));
466 template<typename Stream, typename C>
467 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
469 WriteCompactSize(os, str.size());
471 os.write((char*)&str[0], (int)(str.size() * sizeof(str[0])));
474 template<typename Stream, typename C>
475 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
477 unsigned int nSize = (unsigned int)(ReadCompactSize(is));
480 is.read((char*)&str[0], nSize * sizeof(str[0]));
488 template<typename T, typename A>
489 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
491 return (unsigned int)(GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
494 template<typename T, typename A>
495 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
497 unsigned int nSize = GetSizeOfCompactSize(v.size());
498 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
499 nSize += GetSerializeSize((*vi), nType, nVersion);
503 template<typename T, typename A>
504 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
506 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
510 template<typename Stream, typename T, typename A>
511 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
513 WriteCompactSize(os, v.size());
515 os.write((char*)&v[0], (int)(v.size() * sizeof(T)));
518 template<typename Stream, typename T, typename A>
519 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
521 WriteCompactSize(os, v.size());
522 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
523 ::Serialize(os, (*vi), nType, nVersion);
526 template<typename Stream, typename T, typename A>
527 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
529 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
533 template<typename Stream, typename T, typename A>
534 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
536 // Limit size per read so bogus size value won't cause out of memory
538 unsigned int nSize = (unsigned int)(ReadCompactSize(is));
542 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
544 is.read((char*)&v[i], blk * sizeof(T));
549 template<typename Stream, typename T, typename A>
550 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
553 unsigned int nSize = (unsigned int)(ReadCompactSize(is));
555 unsigned int nMid = 0;
558 nMid += 5000000 / sizeof(T);
562 for (; i < nMid; i++)
563 Unserialize(is, v[i], nType, nVersion);
567 template<typename Stream, typename T, typename A>
568 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
570 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
576 // others derived from vector
578 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
580 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
583 template<typename Stream>
584 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
586 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
589 template<typename Stream>
590 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
592 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
600 template<typename K, typename T>
601 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
603 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
606 template<typename Stream, typename K, typename T>
607 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
609 Serialize(os, item.first, nType, nVersion);
610 Serialize(os, item.second, nType, nVersion);
613 template<typename Stream, typename K, typename T>
614 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
616 Unserialize(is, item.first, nType, nVersion);
617 Unserialize(is, item.second, nType, nVersion);
625 template<typename T0, typename T1, typename T2>
626 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
628 unsigned int nSize = 0;
629 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
630 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
631 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
635 template<typename Stream, typename T0, typename T1, typename T2>
636 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
638 Serialize(os, boost::get<0>(item), nType, nVersion);
639 Serialize(os, boost::get<1>(item), nType, nVersion);
640 Serialize(os, boost::get<2>(item), nType, nVersion);
643 template<typename Stream, typename T0, typename T1, typename T2>
644 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
646 Unserialize(is, boost::get<0>(item), nType, nVersion);
647 Unserialize(is, boost::get<1>(item), nType, nVersion);
648 Unserialize(is, boost::get<2>(item), nType, nVersion);
656 template<typename T0, typename T1, typename T2, typename T3>
657 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
659 unsigned int nSize = 0;
660 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
661 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
662 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
663 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
667 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
668 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
670 Serialize(os, boost::get<0>(item), nType, nVersion);
671 Serialize(os, boost::get<1>(item), nType, nVersion);
672 Serialize(os, boost::get<2>(item), nType, nVersion);
673 Serialize(os, boost::get<3>(item), nType, nVersion);
676 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
677 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
679 Unserialize(is, boost::get<0>(item), nType, nVersion);
680 Unserialize(is, boost::get<1>(item), nType, nVersion);
681 Unserialize(is, boost::get<2>(item), nType, nVersion);
682 Unserialize(is, boost::get<3>(item), nType, nVersion);
690 template<typename K, typename T, typename Pred, typename A>
691 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
693 unsigned int nSize = GetSizeOfCompactSize(m.size());
694 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
695 nSize += GetSerializeSize((*mi), nType, nVersion);
699 template<typename Stream, typename K, typename T, typename Pred, typename A>
700 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
702 WriteCompactSize(os, m.size());
703 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
704 Serialize(os, (*mi), nType, nVersion);
707 template<typename Stream, typename K, typename T, typename Pred, typename A>
708 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
711 unsigned int nSize = (unsigned int)(ReadCompactSize(is));
712 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
713 for (unsigned int i = 0; i < nSize; i++)
715 std::pair<K, T> item;
716 Unserialize(is, item, nType, nVersion);
717 mi = m.insert(mi, item);
726 template<typename K, typename Pred, typename A>
727 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
729 unsigned int nSize = GetSizeOfCompactSize(m.size());
730 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
731 nSize += GetSerializeSize((*it), nType, nVersion);
735 template<typename Stream, typename K, typename Pred, typename A>
736 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
738 WriteCompactSize(os, m.size());
739 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
740 Serialize(os, (*it), nType, nVersion);
743 template<typename Stream, typename K, typename Pred, typename A>
744 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
747 unsigned int nSize = ReadCompactSize(is);
748 typename std::set<K, Pred, A>::iterator it = m.begin();
749 for (unsigned int i = 0; i < nSize; i++)
752 Unserialize(is, key, nType, nVersion);
753 it = m.insert(it, key);
760 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
762 class CSerActionGetSerializeSize { };
763 class CSerActionSerialize { };
764 class CSerActionUnserialize { };
766 template<typename Stream, typename T>
767 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
769 return ::GetSerializeSize(obj, nType, nVersion);
772 template<typename Stream, typename T>
773 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
775 ::Serialize(s, obj, nType, nVersion);
779 template<typename Stream, typename T>
780 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
782 ::Unserialize(s, obj, nType, nVersion);
786 struct ser_streamplaceholder
802 typedef std::vector<char, zero_after_free_allocator<char> > CSerializeData;
804 /** Double ended buffer combining vector and stream-like interfaces.
806 * >> and << read and write unformatted data using the above serialization templates.
807 * Fills with data in linear time; some stringstream implementations take N^2 time.
812 typedef CSerializeData vector_type;
814 unsigned int nReadPos;
821 typedef vector_type::allocator_type allocator_type;
822 typedef vector_type::size_type size_type;
823 typedef vector_type::difference_type difference_type;
824 typedef vector_type::reference reference;
825 typedef vector_type::const_reference const_reference;
826 typedef vector_type::value_type value_type;
827 typedef vector_type::iterator iterator;
828 typedef vector_type::const_iterator const_iterator;
829 typedef vector_type::reverse_iterator reverse_iterator;
831 explicit CDataStream(int nTypeIn, int nVersionIn)
833 Init(nTypeIn, nVersionIn);
836 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
838 Init(nTypeIn, nVersionIn);
841 #if !defined(_MSC_VER) || _MSC_VER >= 1300
842 CDataStream(const char* pbegin, const char* pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
844 Init(nTypeIn, nVersionIn);
848 CDataStream(const vector_type& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
850 Init(nTypeIn, nVersionIn);
853 CDataStream(const std::vector<char>& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
855 Init(nTypeIn, nVersionIn);
858 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
860 Init(nTypeIn, nVersionIn);
863 void Init(int nTypeIn, int nVersionIn)
867 nVersion = nVersionIn;
869 exceptmask = std::ios::badbit | std::ios::failbit;
872 CDataStream& operator+=(const CDataStream& b)
874 vch.insert(vch.end(), b.begin(), b.end());
878 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
885 std::string str() const
887 return (std::string(begin(), end()));
894 const_iterator begin() const { return vch.begin() + nReadPos; }
895 iterator begin() { return vch.begin() + nReadPos; }
896 const_iterator end() const { return vch.end(); }
897 iterator end() { return vch.end(); }
898 size_type size() const { return vch.size() - nReadPos; }
899 bool empty() const { return vch.size() == nReadPos; }
900 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
901 void reserve(size_type n) { vch.reserve(n + nReadPos); }
902 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
903 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
904 void clear() { vch.clear(); nReadPos = 0; }
905 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
906 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
909 void insert(iterator it, const_iterator first, const_iterator last)
911 assert(last - first >= 0);
912 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
914 // special case for inserting at the front when there's room
915 nReadPos -= (unsigned int)(last - first);
916 memcpy(&vch[nReadPos], &first[0], last - first);
919 vch.insert(it, first, last);
924 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
926 assert(last - first >= 0);
927 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
929 // special case for inserting at the front when there's room
930 nReadPos -= (last - first);
931 memcpy(&vch[nReadPos], &first[0], last - first);
934 vch.insert(it, first, last);
938 #if !defined(_MSC_VER) || _MSC_VER >= 1300
939 void insert(iterator it, const char* first, const char* last)
941 assert(last - first >= 0);
942 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
944 // special case for inserting at the front when there's room
945 nReadPos -= (unsigned int)(last - first);
946 memcpy(&vch[nReadPos], &first[0], last - first);
949 vch.insert(it, first, last);
953 iterator erase(iterator it)
955 if (it == vch.begin() + nReadPos)
957 // special case for erasing from the front
958 if (++nReadPos >= vch.size())
960 // whenever we reach the end, we take the opportunity to clear the buffer
962 return vch.erase(vch.begin(), vch.end());
964 return vch.begin() + nReadPos;
967 return vch.erase(it);
970 iterator erase(iterator first, iterator last)
972 if (first == vch.begin() + nReadPos)
974 // special case for erasing from the front
975 if (last == vch.end())
978 return vch.erase(vch.begin(), vch.end());
982 nReadPos = (unsigned int)(last - vch.begin());
987 return vch.erase(first, last);
990 inline void Compact()
992 vch.erase(vch.begin(), vch.begin() + nReadPos);
996 bool Rewind(size_type n)
998 // Rewind by n characters if the buffer hasn't been compacted yet
1001 nReadPos -= (unsigned int)n;
1009 void setstate(short bits, const char* psz)
1012 if (state & exceptmask)
1013 throw std::ios_base::failure(psz);
1016 bool eof() const { return size() == 0; }
1017 bool fail() const { return (state & (std::ios::badbit | std::ios::failbit)) != 0; }
1018 bool good() const { return !eof() && (state == 0); }
1019 void clear(short n) { state = n; } // name conflict with vector clear()
1020 short exceptions() { return exceptmask; }
1021 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1022 CDataStream* rdbuf() { return this; }
1023 int in_avail() { return (int)(size()); }
1025 void SetType(int n) { nType = n; }
1026 int GetType() { return nType; }
1027 void SetVersion(int n) { nVersion = n; }
1028 int GetVersion() { return nVersion; }
1029 void ReadVersion() { *this >> nVersion; }
1030 void WriteVersion() { *this << nVersion; }
1032 CDataStream& read(char* pch, int nSize)
1034 // Read from the beginning of the buffer
1036 unsigned int nReadPosNext = nReadPos + nSize;
1037 if (nReadPosNext >= vch.size())
1039 if (nReadPosNext > vch.size())
1041 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1042 memset(pch, 0, nSize);
1043 nSize = (int)(vch.size() - nReadPos);
1045 memcpy(pch, &vch[nReadPos], nSize);
1050 memcpy(pch, &vch[nReadPos], nSize);
1051 nReadPos = nReadPosNext;
1055 CDataStream& ignore(int nSize)
1057 // Ignore from the beginning of the buffer
1059 unsigned int nReadPosNext = nReadPos + nSize;
1060 if (nReadPosNext >= vch.size())
1062 if (nReadPosNext > vch.size())
1063 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1068 nReadPos = nReadPosNext;
1072 CDataStream& write(const char* pch, int nSize)
1074 // Write to the end of the buffer
1076 vch.insert(vch.end(), pch, pch + nSize);
1080 template<typename Stream>
1081 void Serialize(Stream& s, int nType, int nVersion) const
1083 // Special case: stream << stream concatenates like stream += stream
1085 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1088 template<typename T>
1089 unsigned int GetSerializeSize(const T& obj)
1091 // Tells the size of the object if serialized to this stream
1092 return ::GetSerializeSize(obj, nType, nVersion);
1095 template<typename T>
1096 CDataStream& operator<<(const T& obj)
1098 // Serialize to this stream
1099 ::Serialize(*this, obj, nType, nVersion);
1103 template<typename T>
1104 CDataStream& operator>>(T& obj)
1106 // Unserialize from this stream
1107 ::Unserialize(*this, obj, nType, nVersion);
1111 void GetAndClear(CSerializeData &data) {
1113 CSerializeData().swap(vch);
1126 /** RAII wrapper for FILE*.
1128 * Will automatically close the file when it goes out of scope if not null.
1129 * If you're returning the file pointer, return file.release().
1130 * If you need to close the file early, use file.fclose() instead of fclose(file).
1142 CAutoFile(FILE* filenew, int nTypeIn, int nVersionIn)
1146 nVersion = nVersionIn;
1148 exceptmask = std::ios::badbit | std::ios::failbit;
1158 if (file != NULL && file != stdin && file != stdout && file != stderr)
1163 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1164 operator FILE*() { return file; }
1165 FILE* operator->() { return file; }
1166 FILE& operator*() { return *file; }
1167 FILE** operator&() { return &file; }
1168 FILE* operator=(FILE* pnew) { return file = pnew; }
1169 bool operator!() { return (file == NULL); }
1175 void setstate(short bits, const char* psz)
1178 if (state & exceptmask)
1179 throw std::ios_base::failure(psz);
1182 bool fail() const { return (state & (std::ios::badbit | std::ios::failbit)) != 0; }
1183 bool good() const { return state == 0; }
1184 void clear(short n = 0) { state = n; }
1185 short exceptions() { return exceptmask; }
1186 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1188 void SetType(int n) { nType = n; }
1189 int GetType() { return nType; }
1190 void SetVersion(int n) { nVersion = n; }
1191 int GetVersion() { return nVersion; }
1192 void ReadVersion() { *this >> nVersion; }
1193 void WriteVersion() { *this << nVersion; }
1195 CAutoFile& read(char* pch, size_t nSize)
1198 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1199 if (fread(pch, 1, nSize, file) != nSize)
1200 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1204 CAutoFile& write(const char* pch, size_t nSize)
1207 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1208 if (fwrite(pch, 1, nSize, file) != nSize)
1209 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1213 template<typename T>
1214 unsigned int GetSerializeSize(const T& obj)
1216 // Tells the size of the object if serialized to this stream
1217 return ::GetSerializeSize(obj, nType, nVersion);
1220 template<typename T>
1221 CAutoFile& operator<<(const T& obj)
1223 // Serialize to this stream
1225 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1226 ::Serialize(*this, obj, nType, nVersion);
1230 template<typename T>
1231 CAutoFile& operator>>(T& obj)
1233 // Unserialize from this stream
1235 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1236 ::Unserialize(*this, obj, nType, nVersion);
1241 /** Wrapper around a FILE* that implements a ring buffer to
1242 * deserialize from. It guarantees the ability to rewind
1243 * a given number of bytes. */
1247 FILE *src; // source file
1248 uint64_t nSrcPos; // how many bytes have been read from source
1249 uint64_t nReadPos; // how many bytes have been read from this
1250 uint64_t nReadLimit; // up to which position we're allowed to read
1251 uint64_t nRewind; // how many bytes we guarantee to rewind
1252 std::vector<char> vchBuf; // the buffer
1258 void setstate(short bits, const char *psz) {
1260 if (state & exceptmask)
1261 throw std::ios_base::failure(psz);
1264 // read data from the source to fill the buffer
1266 unsigned int pos = (unsigned int)(nSrcPos % vchBuf.size());
1267 unsigned int readNow = (unsigned int)(vchBuf.size() - pos);
1268 unsigned int nAvail = (unsigned int)(vchBuf.size() - (nSrcPos - nReadPos) - nRewind);
1269 if (nAvail < readNow)
1273 size_t read = fread((void*)&vchBuf[pos], 1, readNow, src);
1275 setstate(std::ios_base::failbit, feof(src) ? "CBufferedFile::Fill : end of file" : "CBufferedFile::Fill : fread failed");
1287 CBufferedFile(FILE *fileIn, uint64_t nBufSize, uint64_t nRewindIn, int nTypeIn, int nVersionIn) :
1288 src(fileIn), nSrcPos(0), nReadPos(0), nReadLimit(std::numeric_limits<uint64_t>::max()), nRewind(nRewindIn), vchBuf(nBufSize, 0),
1289 state(0), exceptmask(std::ios_base::badbit | std::ios_base::failbit), nType(nTypeIn), nVersion(nVersionIn) {
1292 // check whether no error occurred
1297 // check whether we're at the end of the source file
1299 return nReadPos == nSrcPos && feof(src);
1302 // read a number of bytes
1303 CBufferedFile& read(char *pch, size_t nSize) {
1304 if (nSize + nReadPos > nReadLimit)
1305 throw std::ios_base::failure("Read attempted past buffer limit");
1306 if (nSize + nRewind > vchBuf.size())
1307 throw std::ios_base::failure("Read larger than buffer size");
1309 if (nReadPos == nSrcPos)
1311 unsigned int pos = (unsigned int)(nReadPos % vchBuf.size());
1312 size_t nNow = nSize;
1313 if (nNow + pos > vchBuf.size())
1314 nNow = vchBuf.size() - pos;
1315 if (nNow + nReadPos > nSrcPos)
1316 nNow = (size_t)(nSrcPos - nReadPos);
1317 memcpy(pch, &vchBuf[pos], nNow);
1325 // return the current reading position
1330 // rewind to a given reading position
1331 bool SetPos(uint64_t nPos) {
1333 if (nReadPos + nRewind < nSrcPos) {
1334 nReadPos = nSrcPos - nRewind;
1336 } else if (nReadPos > nSrcPos) {
1344 bool Seek(uint64_t nPos) {
1345 long nLongPos = (long)nPos;
1346 if (nPos != (uint64_t)nLongPos)
1348 if (fseek(src, nLongPos, SEEK_SET))
1350 nLongPos = ftell(src);
1352 nReadPos = nLongPos;
1357 // prevent reading beyond a certain position
1358 // no argument removes the limit
1359 bool SetLimit(uint64_t nPos = std::numeric_limits<uint64_t>::max()) {
1360 if (nPos < nReadPos)
1366 template<typename T>
1367 CBufferedFile& operator>>(T& obj) {
1368 // Unserialize from this stream
1369 ::Unserialize(*this, obj, nType, nVersion);
1373 // search for a given byte in the stream, and remain positioned on it
1374 void FindByte(char ch) {
1376 if (nReadPos == nSrcPos)
1378 if (vchBuf[nReadPos % vchBuf.size()] == ch)