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_SERIALIZE_H
6 #define BITCOIN_SERIALIZE_H
17 #include <boost/type_traits/is_fundamental.hpp>
18 #include <boost/tuple/tuple.hpp>
19 #include <boost/tuple/tuple_comparison.hpp>
20 #include <boost/tuple/tuple_io.hpp>
22 #include "allocators.h"
25 typedef long long int64;
26 typedef unsigned long long uint64;
31 static const unsigned int MAX_SIZE = 0x02000000;
33 // Used to bypass the rule against non-const reference to temporary
34 // where it makes sense with wrappers such as CFlatData or CTxDB
36 inline T& REF(const T& val)
38 return const_cast<T&>(val);
41 /////////////////////////////////////////////////////////////////
43 // Templates for serializing to anything that looks like a stream,
44 // i.e. anything that supports .read(char*, int) and .write(char*, int)
50 SER_NETWORK = (1 << 0),
52 SER_GETHASH = (1 << 2),
55 SER_SKIPSIG = (1 << 16),
56 SER_BLOCKHEADERONLY = (1 << 17),
59 #define IMPLEMENT_SERIALIZE(statements) \
60 unsigned int GetSerializeSize(int nType=0, int nVersion=PROTOCOL_VERSION) const \
62 CSerActionGetSerializeSize ser_action; \
63 const bool fGetSize = true; \
64 const bool fWrite = false; \
65 const bool fRead = false; \
66 unsigned int nSerSize = 0; \
67 ser_streamplaceholder s; \
68 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
70 s.nVersion = nVersion; \
74 template<typename Stream> \
75 void Serialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) const \
77 CSerActionSerialize ser_action; \
78 const bool fGetSize = false; \
79 const bool fWrite = true; \
80 const bool fRead = false; \
81 unsigned int nSerSize = 0; \
82 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
85 template<typename Stream> \
86 void Unserialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) \
88 CSerActionUnserialize ser_action; \
89 const bool fGetSize = false; \
90 const bool fWrite = false; \
91 const bool fRead = true; \
92 unsigned int nSerSize = 0; \
93 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
97 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
107 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
108 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
110 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
111 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
112 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
113 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
114 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
115 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
116 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
117 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
118 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
119 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
120 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
121 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
122 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
124 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
125 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
126 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
127 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
128 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
129 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
130 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
131 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
132 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
133 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
134 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
135 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
136 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
138 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
139 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
140 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
141 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
142 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
143 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
144 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
145 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
146 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
147 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
148 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
149 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
150 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
152 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
153 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
154 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
163 // size < 253 -- 1 byte
164 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
165 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
166 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
168 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
170 if (nSize < 253) return sizeof(unsigned char);
171 else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
172 else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
173 else return sizeof(unsigned char) + sizeof(uint64);
176 template<typename Stream>
177 void WriteCompactSize(Stream& os, uint64 nSize)
181 unsigned char chSize = nSize;
182 WRITEDATA(os, chSize);
184 else if (nSize <= std::numeric_limits<unsigned short>::max())
186 unsigned char chSize = 253;
187 unsigned short xSize = nSize;
188 WRITEDATA(os, chSize);
189 WRITEDATA(os, xSize);
191 else if (nSize <= std::numeric_limits<unsigned int>::max())
193 unsigned char chSize = 254;
194 unsigned int xSize = nSize;
195 WRITEDATA(os, chSize);
196 WRITEDATA(os, xSize);
200 unsigned char chSize = 255;
201 uint64 xSize = nSize;
202 WRITEDATA(os, chSize);
203 WRITEDATA(os, xSize);
208 template<typename Stream>
209 uint64 ReadCompactSize(Stream& is)
211 unsigned char chSize;
212 READDATA(is, chSize);
218 else if (chSize == 253)
220 unsigned short xSize;
224 else if (chSize == 254)
236 if (nSizeRet > (uint64)MAX_SIZE)
237 throw std::ios_base::failure("ReadCompactSize() : size too large");
243 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
245 /** Wrapper for serializing arrays and POD.
246 * There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it.
254 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
255 char* begin() { return pbegin; }
256 const char* begin() const { return pbegin; }
257 char* end() { return pend; }
258 const char* end() const { return pend; }
260 unsigned int GetSerializeSize(int, int=0) const
262 return pend - pbegin;
265 template<typename Stream>
266 void Serialize(Stream& s, int, int=0) const
268 s.write(pbegin, pend - pbegin);
271 template<typename Stream>
272 void Unserialize(Stream& s, int, int=0)
274 s.read(pbegin, pend - pbegin);
280 /** string stored as a fixed length field */
281 template<std::size_t LEN>
282 class CFixedFieldString
285 const std::string* pcstr;
288 explicit CFixedFieldString(const std::string& str) : pcstr(&str), pstr(NULL) { }
289 explicit CFixedFieldString(std::string& str) : pcstr(&str), pstr(&str) { }
291 unsigned int GetSerializeSize(int, int=0) const
296 template<typename Stream>
297 void Serialize(Stream& s, int, int=0) const
300 strncpy(pszBuf, pcstr->c_str(), LEN);
301 s.write(pszBuf, LEN);
304 template<typename Stream>
305 void Unserialize(Stream& s, int, int=0)
308 throw std::ios_base::failure("CFixedFieldString::Unserialize : trying to unserialize to const string");
321 // Forward declarations
325 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
326 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
327 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
330 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
331 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
332 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
333 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&);
334 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&);
335 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
336 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&);
337 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&);
338 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
340 // others derived from vector
341 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
342 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
343 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
346 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
347 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
348 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
351 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=PROTOCOL_VERSION);
352 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=PROTOCOL_VERSION);
353 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion=PROTOCOL_VERSION);
356 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion=PROTOCOL_VERSION);
357 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=PROTOCOL_VERSION);
358 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=PROTOCOL_VERSION);
361 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion=PROTOCOL_VERSION);
362 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=PROTOCOL_VERSION);
363 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=PROTOCOL_VERSION);
366 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion=PROTOCOL_VERSION);
367 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion=PROTOCOL_VERSION);
368 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion=PROTOCOL_VERSION);
375 // If none of the specialized versions above matched, default to calling member function.
376 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
377 // The compiler will only cast int to long if none of the other templates matched.
378 // Thanks to Boost serialization for this idea.
381 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion=PROTOCOL_VERSION)
383 return a.GetSerializeSize((int)nType, nVersion);
386 template<typename Stream, typename T>
387 inline void Serialize(Stream& os, const T& a, long nType, int nVersion=PROTOCOL_VERSION)
389 a.Serialize(os, (int)nType, nVersion);
392 template<typename Stream, typename T>
393 inline void Unserialize(Stream& is, T& a, long nType, int nVersion=PROTOCOL_VERSION)
395 a.Unserialize(is, (int)nType, nVersion);
406 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
408 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
411 template<typename Stream, typename C>
412 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
414 WriteCompactSize(os, str.size());
416 os.write((char*)&str[0], str.size() * sizeof(str[0]));
419 template<typename Stream, typename C>
420 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
422 unsigned int nSize = ReadCompactSize(is);
425 is.read((char*)&str[0], nSize * sizeof(str[0]));
433 template<typename T, typename A>
434 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
436 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
439 template<typename T, typename A>
440 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
442 unsigned int nSize = GetSizeOfCompactSize(v.size());
443 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
444 nSize += GetSerializeSize((*vi), nType, nVersion);
448 template<typename T, typename A>
449 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
451 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
455 template<typename Stream, typename T, typename A>
456 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
458 WriteCompactSize(os, v.size());
460 os.write((char*)&v[0], v.size() * sizeof(T));
463 template<typename Stream, typename T, typename A>
464 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
466 WriteCompactSize(os, v.size());
467 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
468 ::Serialize(os, (*vi), nType, nVersion);
471 template<typename Stream, typename T, typename A>
472 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
474 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
478 template<typename Stream, typename T, typename A>
479 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
481 //unsigned int nSize = ReadCompactSize(is);
483 //is.read((char*)&v[0], nSize * sizeof(T));
485 // Limit size per read so bogus size value won't cause out of memory
487 unsigned int nSize = ReadCompactSize(is);
491 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
493 is.read((char*)&v[i], blk * sizeof(T));
498 template<typename Stream, typename T, typename A>
499 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
501 //unsigned int nSize = ReadCompactSize(is);
503 //for (std::vector<T, A>::iterator vi = v.begin(); vi != v.end(); ++vi)
504 // Unserialize(is, (*vi), nType, nVersion);
507 unsigned int nSize = ReadCompactSize(is);
509 unsigned int nMid = 0;
512 nMid += 5000000 / sizeof(T);
516 for (; i < nMid; i++)
517 Unserialize(is, v[i], nType, nVersion);
521 template<typename Stream, typename T, typename A>
522 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
524 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
530 // others derived from vector
532 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
534 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
537 template<typename Stream>
538 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
540 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
543 template<typename Stream>
544 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
546 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
554 template<typename K, typename T>
555 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
557 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
560 template<typename Stream, typename K, typename T>
561 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
563 Serialize(os, item.first, nType, nVersion);
564 Serialize(os, item.second, nType, nVersion);
567 template<typename Stream, typename K, typename T>
568 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
570 Unserialize(is, item.first, nType, nVersion);
571 Unserialize(is, item.second, nType, nVersion);
579 template<typename T0, typename T1, typename T2>
580 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
582 unsigned int nSize = 0;
583 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
584 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
585 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
589 template<typename Stream, typename T0, typename T1, typename T2>
590 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
592 Serialize(os, boost::get<0>(item), nType, nVersion);
593 Serialize(os, boost::get<1>(item), nType, nVersion);
594 Serialize(os, boost::get<2>(item), nType, nVersion);
597 template<typename Stream, typename T0, typename T1, typename T2>
598 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
600 Unserialize(is, boost::get<0>(item), nType, nVersion);
601 Unserialize(is, boost::get<1>(item), nType, nVersion);
602 Unserialize(is, boost::get<2>(item), nType, nVersion);
610 template<typename T0, typename T1, typename T2, typename T3>
611 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
613 unsigned int nSize = 0;
614 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
615 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
616 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
617 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
621 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
622 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
624 Serialize(os, boost::get<0>(item), nType, nVersion);
625 Serialize(os, boost::get<1>(item), nType, nVersion);
626 Serialize(os, boost::get<2>(item), nType, nVersion);
627 Serialize(os, boost::get<3>(item), nType, nVersion);
630 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
631 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
633 Unserialize(is, boost::get<0>(item), nType, nVersion);
634 Unserialize(is, boost::get<1>(item), nType, nVersion);
635 Unserialize(is, boost::get<2>(item), nType, nVersion);
636 Unserialize(is, boost::get<3>(item), nType, nVersion);
644 template<typename K, typename T, typename Pred, typename A>
645 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
647 unsigned int nSize = GetSizeOfCompactSize(m.size());
648 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
649 nSize += GetSerializeSize((*mi), nType, nVersion);
653 template<typename Stream, typename K, typename T, typename Pred, typename A>
654 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
656 WriteCompactSize(os, m.size());
657 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
658 Serialize(os, (*mi), nType, nVersion);
661 template<typename Stream, typename K, typename T, typename Pred, typename A>
662 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
665 unsigned int nSize = ReadCompactSize(is);
666 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
667 for (unsigned int i = 0; i < nSize; i++)
669 std::pair<K, T> item;
670 Unserialize(is, item, nType, nVersion);
671 mi = m.insert(mi, item);
680 template<typename K, typename Pred, typename A>
681 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
683 unsigned int nSize = GetSizeOfCompactSize(m.size());
684 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
685 nSize += GetSerializeSize((*it), nType, nVersion);
689 template<typename Stream, typename K, typename Pred, typename A>
690 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
692 WriteCompactSize(os, m.size());
693 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
694 Serialize(os, (*it), nType, nVersion);
697 template<typename Stream, typename K, typename Pred, typename A>
698 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
701 unsigned int nSize = ReadCompactSize(is);
702 typename std::set<K, Pred, A>::iterator it = m.begin();
703 for (unsigned int i = 0; i < nSize; i++)
706 Unserialize(is, key, nType, nVersion);
707 it = m.insert(it, key);
714 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
716 class CSerActionGetSerializeSize { };
717 class CSerActionSerialize { };
718 class CSerActionUnserialize { };
720 template<typename Stream, typename T>
721 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
723 return ::GetSerializeSize(obj, nType, nVersion);
726 template<typename Stream, typename T>
727 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
729 ::Serialize(s, obj, nType, nVersion);
733 template<typename Stream, typename T>
734 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
736 ::Unserialize(s, obj, nType, nVersion);
740 struct ser_streamplaceholder
757 /** Double ended buffer combining vector and stream-like interfaces.
759 * >> and << read and write unformatted data using the above serialization templates.
760 * Fills with data in linear time; some stringstream implementations take N^2 time.
765 typedef std::vector<char, zero_after_free_allocator<char> > vector_type;
767 unsigned int nReadPos;
774 typedef vector_type::allocator_type allocator_type;
775 typedef vector_type::size_type size_type;
776 typedef vector_type::difference_type difference_type;
777 typedef vector_type::reference reference;
778 typedef vector_type::const_reference const_reference;
779 typedef vector_type::value_type value_type;
780 typedef vector_type::iterator iterator;
781 typedef vector_type::const_iterator const_iterator;
782 typedef vector_type::reverse_iterator reverse_iterator;
784 explicit CDataStream(int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION)
786 Init(nTypeIn, nVersionIn);
789 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(pbegin, pend)
791 Init(nTypeIn, nVersionIn);
794 #if !defined(_MSC_VER) || _MSC_VER >= 1300
795 CDataStream(const char* pbegin, const char* pend, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(pbegin, pend)
797 Init(nTypeIn, nVersionIn);
801 CDataStream(const vector_type& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(vchIn.begin(), vchIn.end())
803 Init(nTypeIn, nVersionIn);
806 CDataStream(const std::vector<char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(vchIn.begin(), vchIn.end())
808 Init(nTypeIn, nVersionIn);
811 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
813 Init(nTypeIn, nVersionIn);
816 void Init(int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION)
820 nVersion = nVersionIn;
822 exceptmask = std::ios::badbit | std::ios::failbit;
825 CDataStream& operator+=(const CDataStream& b)
827 vch.insert(vch.end(), b.begin(), b.end());
831 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
838 std::string str() const
840 return (std::string(begin(), end()));
847 const_iterator begin() const { return vch.begin() + nReadPos; }
848 iterator begin() { return vch.begin() + nReadPos; }
849 const_iterator end() const { return vch.end(); }
850 iterator end() { return vch.end(); }
851 size_type size() const { return vch.size() - nReadPos; }
852 bool empty() const { return vch.size() == nReadPos; }
853 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
854 void reserve(size_type n) { vch.reserve(n + nReadPos); }
855 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
856 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
857 void clear() { vch.clear(); nReadPos = 0; }
858 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
859 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
861 void insert(iterator it, const_iterator first, const_iterator last)
863 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
865 // special case for inserting at the front when there's room
866 nReadPos -= (last - first);
867 memcpy(&vch[nReadPos], &first[0], last - first);
870 vch.insert(it, first, last);
873 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
875 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
877 // special case for inserting at the front when there's room
878 nReadPos -= (last - first);
879 memcpy(&vch[nReadPos], &first[0], last - first);
882 vch.insert(it, first, last);
885 #if !defined(_MSC_VER) || _MSC_VER >= 1300
886 void insert(iterator it, const char* first, const char* last)
888 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
890 // special case for inserting at the front when there's room
891 nReadPos -= (last - first);
892 memcpy(&vch[nReadPos], &first[0], last - first);
895 vch.insert(it, first, last);
899 iterator erase(iterator it)
901 if (it == vch.begin() + nReadPos)
903 // special case for erasing from the front
904 if (++nReadPos >= vch.size())
906 // whenever we reach the end, we take the opportunity to clear the buffer
908 return vch.erase(vch.begin(), vch.end());
910 return vch.begin() + nReadPos;
913 return vch.erase(it);
916 iterator erase(iterator first, iterator last)
918 if (first == vch.begin() + nReadPos)
920 // special case for erasing from the front
921 if (last == vch.end())
924 return vch.erase(vch.begin(), vch.end());
928 nReadPos = (last - vch.begin());
933 return vch.erase(first, last);
936 inline void Compact()
938 vch.erase(vch.begin(), vch.begin() + nReadPos);
942 bool Rewind(size_type n)
944 // Rewind by n characters if the buffer hasn't been compacted yet
955 void setstate(short bits, const char* psz)
958 if (state & exceptmask)
959 throw std::ios_base::failure(psz);
962 bool eof() const { return size() == 0; }
963 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
964 bool good() const { return !eof() && (state == 0); }
965 void clear(short n) { state = n; } // name conflict with vector clear()
966 short exceptions() { return exceptmask; }
967 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
968 CDataStream* rdbuf() { return this; }
969 int in_avail() { return size(); }
971 void SetType(int n) { nType = n; }
972 int GetType() { return nType; }
973 void SetVersion(int n) { nVersion = n; }
974 int GetVersion() { return nVersion; }
975 void ReadVersion() { *this >> nVersion; }
976 void WriteVersion() { *this << nVersion; }
978 CDataStream& read(char* pch, int nSize)
980 // Read from the beginning of the buffer
982 unsigned int nReadPosNext = nReadPos + nSize;
983 if (nReadPosNext >= vch.size())
985 if (nReadPosNext > vch.size())
987 setstate(std::ios::failbit, "CDataStream::read() : end of data");
988 memset(pch, 0, nSize);
989 nSize = vch.size() - nReadPos;
991 memcpy(pch, &vch[nReadPos], nSize);
996 memcpy(pch, &vch[nReadPos], nSize);
997 nReadPos = nReadPosNext;
1001 CDataStream& ignore(int nSize)
1003 // Ignore from the beginning of the buffer
1005 unsigned int nReadPosNext = nReadPos + nSize;
1006 if (nReadPosNext >= vch.size())
1008 if (nReadPosNext > vch.size())
1010 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1011 nSize = vch.size() - nReadPos;
1017 nReadPos = nReadPosNext;
1021 CDataStream& write(const char* pch, int nSize)
1023 // Write to the end of the buffer
1025 vch.insert(vch.end(), pch, pch + nSize);
1029 template<typename Stream>
1030 void Serialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) const
1032 // Special case: stream << stream concatenates like stream += stream
1034 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1037 template<typename T>
1038 unsigned int GetSerializeSize(const T& obj)
1040 // Tells the size of the object if serialized to this stream
1041 return ::GetSerializeSize(obj, nType, nVersion);
1044 template<typename T>
1045 CDataStream& operator<<(const T& obj)
1047 // Serialize to this stream
1048 ::Serialize(*this, obj, nType, nVersion);
1052 template<typename T>
1053 CDataStream& operator>>(T& obj)
1055 // Unserialize from this stream
1056 ::Unserialize(*this, obj, nType, nVersion);
1061 #ifdef TESTCDATASTREAM
1068 // n=16000 0 seconds
1069 // n=32000 0 seconds
1070 // n=64000 1 seconds
1071 // n=128000 1 seconds
1072 // n=256000 2 seconds
1073 // n=512000 4 seconds
1074 // n=1024000 8 seconds
1075 // n=2048000 16 seconds
1076 // n=4096000 32 seconds
1080 // n=4000 13 seconds
1081 // n=8000 87 seconds
1082 // n=16000 400 seconds
1083 // n=32000 1660 seconds
1084 // n=64000 6749 seconds
1085 // n=128000 27241 seconds
1086 // n=256000 109804 seconds
1088 int main(int argc, char *argv[])
1090 vector<unsigned char> vch(0xcc, 250);
1091 printf("CDataStream:\n");
1092 for (int n = 1000; n <= 4500000; n *= 2)
1095 time_t nStart = time(NULL);
1096 for (int i = 0; i < n; i++)
1097 ss.write((char*)&vch[0], vch.size());
1098 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1100 printf("stringstream:\n");
1101 for (int n = 1000; n <= 4500000; n *= 2)
1104 time_t nStart = time(NULL);
1105 for (int i = 0; i < n; i++)
1106 ss.write((char*)&vch[0], vch.size());
1107 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1121 /** RAII wrapper for FILE*.
1123 * Will automatically close the file when it goes out of scope if not null.
1124 * If you're returning the file pointer, return file.release().
1125 * If you need to close the file early, use file.fclose() instead of fclose(file).
1137 typedef FILE element_type;
1139 CAutoFile(FILE* filenew=NULL, int nTypeIn=SER_DISK, int nVersionIn=PROTOCOL_VERSION)
1143 nVersion = nVersionIn;
1145 exceptmask = std::ios::badbit | std::ios::failbit;
1155 if (file != NULL && file != stdin && file != stdout && file != stderr)
1160 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1161 operator FILE*() { return file; }
1162 FILE* operator->() { return file; }
1163 FILE& operator*() { return *file; }
1164 FILE** operator&() { return &file; }
1165 FILE* operator=(FILE* pnew) { return file = pnew; }
1166 bool operator!() { return (file == NULL); }
1172 void setstate(short bits, const char* psz)
1175 if (state & exceptmask)
1176 throw std::ios_base::failure(psz);
1179 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1180 bool good() const { return state == 0; }
1181 void clear(short n = 0) { state = n; }
1182 short exceptions() { return exceptmask; }
1183 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1185 void SetType(int n) { nType = n; }
1186 int GetType() { return nType; }
1187 void SetVersion(int n) { nVersion = n; }
1188 int GetVersion() { return nVersion; }
1189 void ReadVersion() { *this >> nVersion; }
1190 void WriteVersion() { *this << nVersion; }
1192 CAutoFile& read(char* pch, int nSize)
1195 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1196 if (fread(pch, 1, nSize, file) != nSize)
1197 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1201 CAutoFile& write(const char* pch, int nSize)
1204 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1205 if (fwrite(pch, 1, nSize, file) != nSize)
1206 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1210 template<typename T>
1211 unsigned int GetSerializeSize(const T& obj)
1213 // Tells the size of the object if serialized to this stream
1214 return ::GetSerializeSize(obj, nType, nVersion);
1217 template<typename T>
1218 CAutoFile& operator<<(const T& obj)
1220 // Serialize to this stream
1222 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1223 ::Serialize(*this, obj, nType, nVersion);
1227 template<typename T>
1228 CAutoFile& operator>>(T& obj)
1230 // Unserialize from this stream
1232 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1233 ::Unserialize(*this, obj, nType, nVersion);