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 typedef long long int64;
23 typedef unsigned long long uint64;
26 #define _WIN32_WINNT 0x0501
28 // This is used to attempt to keep keying material out of swap
29 // Note that VirtualLock does not provide this as a guarantee on Windows,
30 // but, in practice, memory that has been VirtualLock'd almost never gets written to
31 // the pagefile except in rare circumstances where memory is extremely low.
33 #define mlock(p, n) VirtualLock((p), (n));
34 #define munlock(p, n) VirtualUnlock((p), (n));
38 /* This comes from limits.h if it's not defined there set a sane default */
41 #define PAGESIZE sysconf(_SC_PAGESIZE)
44 mlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
45 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
46 #define munlock(a,b) \
47 munlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
48 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
54 static const unsigned int MAX_SIZE = 0x02000000;
56 static const int PROTOCOL_VERSION = 60000;
58 // Used to bypass the rule against non-const reference to temporary
59 // where it makes sense with wrappers such as CFlatData or CTxDB
61 inline T& REF(const T& val)
63 return const_cast<T&>(val);
66 /////////////////////////////////////////////////////////////////
68 // Templates for serializing to anything that looks like a stream,
69 // i.e. anything that supports .read(char*, int) and .write(char*, int)
75 SER_NETWORK = (1 << 0),
77 SER_GETHASH = (1 << 2),
80 SER_SKIPSIG = (1 << 16),
81 SER_BLOCKHEADERONLY = (1 << 17),
84 #define IMPLEMENT_SERIALIZE(statements) \
85 unsigned int GetSerializeSize(int nType=0, int nVersion=PROTOCOL_VERSION) const \
87 CSerActionGetSerializeSize ser_action; \
88 const bool fGetSize = true; \
89 const bool fWrite = false; \
90 const bool fRead = false; \
91 unsigned int nSerSize = 0; \
92 ser_streamplaceholder s; \
93 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
95 s.nVersion = nVersion; \
99 template<typename Stream> \
100 void Serialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) const \
102 CSerActionSerialize ser_action; \
103 const bool fGetSize = false; \
104 const bool fWrite = true; \
105 const bool fRead = false; \
106 unsigned int nSerSize = 0; \
107 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
110 template<typename Stream> \
111 void Unserialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) \
113 CSerActionUnserialize ser_action; \
114 const bool fGetSize = false; \
115 const bool fWrite = false; \
116 const bool fRead = true; \
117 unsigned int nSerSize = 0; \
118 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
122 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
132 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
133 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
135 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
136 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
137 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
138 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
139 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
140 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
141 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
142 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
143 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
144 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
145 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
146 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
147 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
149 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
150 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
151 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
152 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
153 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
154 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
155 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
156 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
157 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
158 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
159 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
160 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
161 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
163 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
164 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
165 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
166 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
167 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
168 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
169 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
170 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
171 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
172 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
173 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
174 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
175 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
177 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
178 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
179 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
188 // size < 253 -- 1 byte
189 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
190 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
191 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
193 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
195 if (nSize < 253) return sizeof(unsigned char);
196 else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
197 else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
198 else return sizeof(unsigned char) + sizeof(uint64);
201 template<typename Stream>
202 void WriteCompactSize(Stream& os, uint64 nSize)
206 unsigned char chSize = nSize;
207 WRITEDATA(os, chSize);
209 else if (nSize <= std::numeric_limits<unsigned short>::max())
211 unsigned char chSize = 253;
212 unsigned short xSize = nSize;
213 WRITEDATA(os, chSize);
214 WRITEDATA(os, xSize);
216 else if (nSize <= std::numeric_limits<unsigned int>::max())
218 unsigned char chSize = 254;
219 unsigned int xSize = nSize;
220 WRITEDATA(os, chSize);
221 WRITEDATA(os, xSize);
225 unsigned char chSize = 255;
226 uint64 xSize = nSize;
227 WRITEDATA(os, chSize);
228 WRITEDATA(os, xSize);
233 template<typename Stream>
234 uint64 ReadCompactSize(Stream& is)
236 unsigned char chSize;
237 READDATA(is, chSize);
243 else if (chSize == 253)
245 unsigned short xSize;
249 else if (chSize == 254)
261 if (nSizeRet > (uint64)MAX_SIZE)
262 throw std::ios_base::failure("ReadCompactSize() : size too large");
268 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
270 /** Wrapper for serializing arrays and POD.
271 * There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it.
279 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
280 char* begin() { return pbegin; }
281 const char* begin() const { return pbegin; }
282 char* end() { return pend; }
283 const char* end() const { return pend; }
285 unsigned int GetSerializeSize(int, int=0) const
287 return pend - pbegin;
290 template<typename Stream>
291 void Serialize(Stream& s, int, int=0) const
293 s.write(pbegin, pend - pbegin);
296 template<typename Stream>
297 void Unserialize(Stream& s, int, int=0)
299 s.read(pbegin, pend - pbegin);
305 /** string stored as a fixed length field */
306 template<std::size_t LEN>
307 class CFixedFieldString
310 const std::string* pcstr;
313 explicit CFixedFieldString(const std::string& str) : pcstr(&str), pstr(NULL) { }
314 explicit CFixedFieldString(std::string& str) : pcstr(&str), pstr(&str) { }
316 unsigned int GetSerializeSize(int, int=0) const
321 template<typename Stream>
322 void Serialize(Stream& s, int, int=0) const
325 strncpy(pszBuf, pcstr->c_str(), LEN);
326 s.write(pszBuf, LEN);
329 template<typename Stream>
330 void Unserialize(Stream& s, int, int=0)
333 throw std::ios_base::failure("CFixedFieldString::Unserialize : trying to unserialize to const string");
346 // Forward declarations
350 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
351 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
352 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
355 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
356 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
357 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
358 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&);
359 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&);
360 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
361 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&);
362 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&);
363 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion=PROTOCOL_VERSION);
365 // others derived from vector
366 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
367 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
368 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion=PROTOCOL_VERSION);
371 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
372 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
373 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion=PROTOCOL_VERSION);
376 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=PROTOCOL_VERSION);
377 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);
378 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);
381 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);
382 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);
383 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);
386 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);
387 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);
388 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);
391 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion=PROTOCOL_VERSION);
392 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);
393 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);
400 // If none of the specialized versions above matched, default to calling member function.
401 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
402 // The compiler will only cast int to long if none of the other templates matched.
403 // Thanks to Boost serialization for this idea.
406 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion=PROTOCOL_VERSION)
408 return a.GetSerializeSize((int)nType, nVersion);
411 template<typename Stream, typename T>
412 inline void Serialize(Stream& os, const T& a, long nType, int nVersion=PROTOCOL_VERSION)
414 a.Serialize(os, (int)nType, nVersion);
417 template<typename Stream, typename T>
418 inline void Unserialize(Stream& is, T& a, long nType, int nVersion=PROTOCOL_VERSION)
420 a.Unserialize(is, (int)nType, nVersion);
431 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
433 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
436 template<typename Stream, typename C>
437 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
439 WriteCompactSize(os, str.size());
441 os.write((char*)&str[0], str.size() * sizeof(str[0]));
444 template<typename Stream, typename C>
445 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
447 unsigned int nSize = ReadCompactSize(is);
450 is.read((char*)&str[0], nSize * sizeof(str[0]));
458 template<typename T, typename A>
459 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
461 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
464 template<typename T, typename A>
465 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
467 unsigned int nSize = GetSizeOfCompactSize(v.size());
468 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
469 nSize += GetSerializeSize((*vi), nType, nVersion);
473 template<typename T, typename A>
474 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
476 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
480 template<typename Stream, typename T, typename A>
481 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
483 WriteCompactSize(os, v.size());
485 os.write((char*)&v[0], v.size() * sizeof(T));
488 template<typename Stream, typename T, typename A>
489 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
491 WriteCompactSize(os, v.size());
492 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
493 ::Serialize(os, (*vi), nType, nVersion);
496 template<typename Stream, typename T, typename A>
497 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
499 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
503 template<typename Stream, typename T, typename A>
504 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
506 //unsigned int nSize = ReadCompactSize(is);
508 //is.read((char*)&v[0], nSize * sizeof(T));
510 // Limit size per read so bogus size value won't cause out of memory
512 unsigned int nSize = ReadCompactSize(is);
516 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
518 is.read((char*)&v[i], blk * sizeof(T));
523 template<typename Stream, typename T, typename A>
524 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
526 //unsigned int nSize = ReadCompactSize(is);
528 //for (std::vector<T, A>::iterator vi = v.begin(); vi != v.end(); ++vi)
529 // Unserialize(is, (*vi), nType, nVersion);
532 unsigned int nSize = ReadCompactSize(is);
534 unsigned int nMid = 0;
537 nMid += 5000000 / sizeof(T);
541 for (; i < nMid; i++)
542 Unserialize(is, v[i], nType, nVersion);
546 template<typename Stream, typename T, typename A>
547 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
549 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
555 // others derived from vector
557 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
559 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
562 template<typename Stream>
563 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
565 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
568 template<typename Stream>
569 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
571 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
579 template<typename K, typename T>
580 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
582 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
585 template<typename Stream, typename K, typename T>
586 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
588 Serialize(os, item.first, nType, nVersion);
589 Serialize(os, item.second, nType, nVersion);
592 template<typename Stream, typename K, typename T>
593 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
595 Unserialize(is, item.first, nType, nVersion);
596 Unserialize(is, item.second, nType, nVersion);
604 template<typename T0, typename T1, typename T2>
605 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
607 unsigned int nSize = 0;
608 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
609 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
610 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
614 template<typename Stream, typename T0, typename T1, typename T2>
615 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
617 Serialize(os, boost::get<0>(item), nType, nVersion);
618 Serialize(os, boost::get<1>(item), nType, nVersion);
619 Serialize(os, boost::get<2>(item), nType, nVersion);
622 template<typename Stream, typename T0, typename T1, typename T2>
623 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
625 Unserialize(is, boost::get<0>(item), nType, nVersion);
626 Unserialize(is, boost::get<1>(item), nType, nVersion);
627 Unserialize(is, boost::get<2>(item), nType, nVersion);
635 template<typename T0, typename T1, typename T2, typename T3>
636 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
638 unsigned int nSize = 0;
639 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
640 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
641 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
642 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
646 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
647 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
649 Serialize(os, boost::get<0>(item), nType, nVersion);
650 Serialize(os, boost::get<1>(item), nType, nVersion);
651 Serialize(os, boost::get<2>(item), nType, nVersion);
652 Serialize(os, boost::get<3>(item), nType, nVersion);
655 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
656 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
658 Unserialize(is, boost::get<0>(item), nType, nVersion);
659 Unserialize(is, boost::get<1>(item), nType, nVersion);
660 Unserialize(is, boost::get<2>(item), nType, nVersion);
661 Unserialize(is, boost::get<3>(item), nType, nVersion);
669 template<typename K, typename T, typename Pred, typename A>
670 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
672 unsigned int nSize = GetSizeOfCompactSize(m.size());
673 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
674 nSize += GetSerializeSize((*mi), nType, nVersion);
678 template<typename Stream, typename K, typename T, typename Pred, typename A>
679 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
681 WriteCompactSize(os, m.size());
682 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
683 Serialize(os, (*mi), nType, nVersion);
686 template<typename Stream, typename K, typename T, typename Pred, typename A>
687 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
690 unsigned int nSize = ReadCompactSize(is);
691 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
692 for (unsigned int i = 0; i < nSize; i++)
694 std::pair<K, T> item;
695 Unserialize(is, item, nType, nVersion);
696 mi = m.insert(mi, item);
705 template<typename K, typename Pred, typename A>
706 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
708 unsigned int nSize = GetSizeOfCompactSize(m.size());
709 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
710 nSize += GetSerializeSize((*it), nType, nVersion);
714 template<typename Stream, typename K, typename Pred, typename A>
715 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
717 WriteCompactSize(os, m.size());
718 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
719 Serialize(os, (*it), nType, nVersion);
722 template<typename Stream, typename K, typename Pred, typename A>
723 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
726 unsigned int nSize = ReadCompactSize(is);
727 typename std::set<K, Pred, A>::iterator it = m.begin();
728 for (unsigned int i = 0; i < nSize; i++)
731 Unserialize(is, key, nType, nVersion);
732 it = m.insert(it, key);
739 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
741 class CSerActionGetSerializeSize { };
742 class CSerActionSerialize { };
743 class CSerActionUnserialize { };
745 template<typename Stream, typename T>
746 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
748 return ::GetSerializeSize(obj, nType, nVersion);
751 template<typename Stream, typename T>
752 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
754 ::Serialize(s, obj, nType, nVersion);
758 template<typename Stream, typename T>
759 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
761 ::Unserialize(s, obj, nType, nVersion);
765 struct ser_streamplaceholder
780 // Allocator that locks its contents from being paged
781 // out of memory and clears its contents before deletion.
784 struct secure_allocator : public std::allocator<T>
786 // MSVC8 default copy constructor is broken
787 typedef std::allocator<T> base;
788 typedef typename base::size_type size_type;
789 typedef typename base::difference_type difference_type;
790 typedef typename base::pointer pointer;
791 typedef typename base::const_pointer const_pointer;
792 typedef typename base::reference reference;
793 typedef typename base::const_reference const_reference;
794 typedef typename base::value_type value_type;
795 secure_allocator() throw() {}
796 secure_allocator(const secure_allocator& a) throw() : base(a) {}
797 template <typename U>
798 secure_allocator(const secure_allocator<U>& a) throw() : base(a) {}
799 ~secure_allocator() throw() {}
800 template<typename _Other> struct rebind
801 { typedef secure_allocator<_Other> other; };
803 T* allocate(std::size_t n, const void *hint = 0)
806 p = std::allocator<T>::allocate(n, hint);
808 mlock(p, sizeof(T) * n);
812 void deallocate(T* p, std::size_t n)
816 memset(p, 0, sizeof(T) * n);
817 munlock(p, sizeof(T) * n);
819 std::allocator<T>::deallocate(p, n);
825 // Allocator that clears its contents before deletion.
828 struct zero_after_free_allocator : public std::allocator<T>
830 // MSVC8 default copy constructor is broken
831 typedef std::allocator<T> base;
832 typedef typename base::size_type size_type;
833 typedef typename base::difference_type difference_type;
834 typedef typename base::pointer pointer;
835 typedef typename base::const_pointer const_pointer;
836 typedef typename base::reference reference;
837 typedef typename base::const_reference const_reference;
838 typedef typename base::value_type value_type;
839 zero_after_free_allocator() throw() {}
840 zero_after_free_allocator(const zero_after_free_allocator& a) throw() : base(a) {}
841 template <typename U>
842 zero_after_free_allocator(const zero_after_free_allocator<U>& a) throw() : base(a) {}
843 ~zero_after_free_allocator() throw() {}
844 template<typename _Other> struct rebind
845 { typedef zero_after_free_allocator<_Other> other; };
847 void deallocate(T* p, std::size_t n)
850 memset(p, 0, sizeof(T) * n);
851 std::allocator<T>::deallocate(p, n);
857 /** Double ended buffer combining vector and stream-like interfaces.
859 * >> and << read and write unformatted data using the above serialization templates.
860 * Fills with data in linear time; some stringstream implementations take N^2 time.
865 typedef std::vector<char, zero_after_free_allocator<char> > vector_type;
867 unsigned int nReadPos;
874 typedef vector_type::allocator_type allocator_type;
875 typedef vector_type::size_type size_type;
876 typedef vector_type::difference_type difference_type;
877 typedef vector_type::reference reference;
878 typedef vector_type::const_reference const_reference;
879 typedef vector_type::value_type value_type;
880 typedef vector_type::iterator iterator;
881 typedef vector_type::const_iterator const_iterator;
882 typedef vector_type::reverse_iterator reverse_iterator;
884 explicit CDataStream(int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION)
886 Init(nTypeIn, nVersionIn);
889 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(pbegin, pend)
891 Init(nTypeIn, nVersionIn);
894 #if !defined(_MSC_VER) || _MSC_VER >= 1300
895 CDataStream(const char* pbegin, const char* pend, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(pbegin, pend)
897 Init(nTypeIn, nVersionIn);
901 CDataStream(const vector_type& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(vchIn.begin(), vchIn.end())
903 Init(nTypeIn, nVersionIn);
906 CDataStream(const std::vector<char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch(vchIn.begin(), vchIn.end())
908 Init(nTypeIn, nVersionIn);
911 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
913 Init(nTypeIn, nVersionIn);
916 void Init(int nTypeIn=SER_NETWORK, int nVersionIn=PROTOCOL_VERSION)
920 nVersion = nVersionIn;
922 exceptmask = std::ios::badbit | std::ios::failbit;
925 CDataStream& operator+=(const CDataStream& b)
927 vch.insert(vch.end(), b.begin(), b.end());
931 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
938 std::string str() const
940 return (std::string(begin(), end()));
947 const_iterator begin() const { return vch.begin() + nReadPos; }
948 iterator begin() { return vch.begin() + nReadPos; }
949 const_iterator end() const { return vch.end(); }
950 iterator end() { return vch.end(); }
951 size_type size() const { return vch.size() - nReadPos; }
952 bool empty() const { return vch.size() == nReadPos; }
953 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
954 void reserve(size_type n) { vch.reserve(n + nReadPos); }
955 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
956 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
957 void clear() { vch.clear(); nReadPos = 0; }
958 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
959 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
961 void insert(iterator it, const_iterator first, const_iterator last)
963 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
965 // special case for inserting at the front when there's room
966 nReadPos -= (last - first);
967 memcpy(&vch[nReadPos], &first[0], last - first);
970 vch.insert(it, first, last);
973 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
975 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
977 // special case for inserting at the front when there's room
978 nReadPos -= (last - first);
979 memcpy(&vch[nReadPos], &first[0], last - first);
982 vch.insert(it, first, last);
985 #if !defined(_MSC_VER) || _MSC_VER >= 1300
986 void insert(iterator it, const char* first, const char* last)
988 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
990 // special case for inserting at the front when there's room
991 nReadPos -= (last - first);
992 memcpy(&vch[nReadPos], &first[0], last - first);
995 vch.insert(it, first, last);
999 iterator erase(iterator it)
1001 if (it == vch.begin() + nReadPos)
1003 // special case for erasing from the front
1004 if (++nReadPos >= vch.size())
1006 // whenever we reach the end, we take the opportunity to clear the buffer
1008 return vch.erase(vch.begin(), vch.end());
1010 return vch.begin() + nReadPos;
1013 return vch.erase(it);
1016 iterator erase(iterator first, iterator last)
1018 if (first == vch.begin() + nReadPos)
1020 // special case for erasing from the front
1021 if (last == vch.end())
1024 return vch.erase(vch.begin(), vch.end());
1028 nReadPos = (last - vch.begin());
1033 return vch.erase(first, last);
1036 inline void Compact()
1038 vch.erase(vch.begin(), vch.begin() + nReadPos);
1042 bool Rewind(size_type n)
1044 // Rewind by n characters if the buffer hasn't been compacted yet
1055 void setstate(short bits, const char* psz)
1058 if (state & exceptmask)
1059 throw std::ios_base::failure(psz);
1062 bool eof() const { return size() == 0; }
1063 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1064 bool good() const { return !eof() && (state == 0); }
1065 void clear(short n) { state = n; } // name conflict with vector clear()
1066 short exceptions() { return exceptmask; }
1067 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1068 CDataStream* rdbuf() { return this; }
1069 int in_avail() { return size(); }
1071 void SetType(int n) { nType = n; }
1072 int GetType() { return nType; }
1073 void SetVersion(int n) { nVersion = n; }
1074 int GetVersion() { return nVersion; }
1075 void ReadVersion() { *this >> nVersion; }
1076 void WriteVersion() { *this << nVersion; }
1078 CDataStream& read(char* pch, int nSize)
1080 // Read from the beginning of the buffer
1082 unsigned int nReadPosNext = nReadPos + nSize;
1083 if (nReadPosNext >= vch.size())
1085 if (nReadPosNext > vch.size())
1087 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1088 memset(pch, 0, nSize);
1089 nSize = vch.size() - nReadPos;
1091 memcpy(pch, &vch[nReadPos], nSize);
1096 memcpy(pch, &vch[nReadPos], nSize);
1097 nReadPos = nReadPosNext;
1101 CDataStream& ignore(int nSize)
1103 // Ignore from the beginning of the buffer
1105 unsigned int nReadPosNext = nReadPos + nSize;
1106 if (nReadPosNext >= vch.size())
1108 if (nReadPosNext > vch.size())
1110 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1111 nSize = vch.size() - nReadPos;
1117 nReadPos = nReadPosNext;
1121 CDataStream& write(const char* pch, int nSize)
1123 // Write to the end of the buffer
1125 vch.insert(vch.end(), pch, pch + nSize);
1129 template<typename Stream>
1130 void Serialize(Stream& s, int nType=0, int nVersion=PROTOCOL_VERSION) const
1132 // Special case: stream << stream concatenates like stream += stream
1134 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1137 template<typename T>
1138 unsigned int GetSerializeSize(const T& obj)
1140 // Tells the size of the object if serialized to this stream
1141 return ::GetSerializeSize(obj, nType, nVersion);
1144 template<typename T>
1145 CDataStream& operator<<(const T& obj)
1147 // Serialize to this stream
1148 ::Serialize(*this, obj, nType, nVersion);
1152 template<typename T>
1153 CDataStream& operator>>(T& obj)
1155 // Unserialize from this stream
1156 ::Unserialize(*this, obj, nType, nVersion);
1161 #ifdef TESTCDATASTREAM
1168 // n=16000 0 seconds
1169 // n=32000 0 seconds
1170 // n=64000 1 seconds
1171 // n=128000 1 seconds
1172 // n=256000 2 seconds
1173 // n=512000 4 seconds
1174 // n=1024000 8 seconds
1175 // n=2048000 16 seconds
1176 // n=4096000 32 seconds
1180 // n=4000 13 seconds
1181 // n=8000 87 seconds
1182 // n=16000 400 seconds
1183 // n=32000 1660 seconds
1184 // n=64000 6749 seconds
1185 // n=128000 27241 seconds
1186 // n=256000 109804 seconds
1188 int main(int argc, char *argv[])
1190 vector<unsigned char> vch(0xcc, 250);
1191 printf("CDataStream:\n");
1192 for (int n = 1000; n <= 4500000; n *= 2)
1195 time_t nStart = time(NULL);
1196 for (int i = 0; i < n; i++)
1197 ss.write((char*)&vch[0], vch.size());
1198 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1200 printf("stringstream:\n");
1201 for (int n = 1000; n <= 4500000; n *= 2)
1204 time_t nStart = time(NULL);
1205 for (int i = 0; i < n; i++)
1206 ss.write((char*)&vch[0], vch.size());
1207 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1221 /** RAII wrapper for FILE*.
1223 * Will automatically close the file when it goes out of scope if not null.
1224 * If you're returning the file pointer, return file.release().
1225 * If you need to close the file early, use file.fclose() instead of fclose(file).
1237 typedef FILE element_type;
1239 CAutoFile(FILE* filenew=NULL, int nTypeIn=SER_DISK, int nVersionIn=PROTOCOL_VERSION)
1243 nVersion = nVersionIn;
1245 exceptmask = std::ios::badbit | std::ios::failbit;
1255 if (file != NULL && file != stdin && file != stdout && file != stderr)
1260 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1261 operator FILE*() { return file; }
1262 FILE* operator->() { return file; }
1263 FILE& operator*() { return *file; }
1264 FILE** operator&() { return &file; }
1265 FILE* operator=(FILE* pnew) { return file = pnew; }
1266 bool operator!() { return (file == NULL); }
1272 void setstate(short bits, const char* psz)
1275 if (state & exceptmask)
1276 throw std::ios_base::failure(psz);
1279 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1280 bool good() const { return state == 0; }
1281 void clear(short n = 0) { state = n; }
1282 short exceptions() { return exceptmask; }
1283 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1285 void SetType(int n) { nType = n; }
1286 int GetType() { return nType; }
1287 void SetVersion(int n) { nVersion = n; }
1288 int GetVersion() { return nVersion; }
1289 void ReadVersion() { *this >> nVersion; }
1290 void WriteVersion() { *this << nVersion; }
1292 CAutoFile& read(char* pch, int nSize)
1295 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1296 if (fread(pch, 1, nSize, file) != nSize)
1297 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1301 CAutoFile& write(const char* pch, int nSize)
1304 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1305 if (fwrite(pch, 1, nSize, file) != nSize)
1306 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1310 template<typename T>
1311 unsigned int GetSerializeSize(const T& obj)
1313 // Tells the size of the object if serialized to this stream
1314 return ::GetSerializeSize(obj, nType, nVersion);
1317 template<typename T>
1318 CAutoFile& operator<<(const T& obj)
1320 // Serialize to this stream
1322 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1323 ::Serialize(*this, obj, nType, nVersion);
1327 template<typename T>
1328 CAutoFile& operator>>(T& obj)
1330 // Unserialize from this stream
1332 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1333 ::Unserialize(*this, obj, nType, nVersion);