1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Distributed under the MIT/X11 software license, see the accompanying
3 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
4 #ifndef BITCOIN_SERIALIZE_H
5 #define BITCOIN_SERIALIZE_H
16 #include <boost/type_traits/is_fundamental.hpp>
17 #include <boost/tuple/tuple.hpp>
18 #include <boost/tuple/tuple_comparison.hpp>
19 #include <boost/tuple/tuple_io.hpp>
21 #if defined(_MSC_VER) || defined(__BORLANDC__)
22 typedef __int64 int64;
23 typedef unsigned __int64 uint64;
25 typedef long long int64;
26 typedef unsigned long long uint64;
28 #if defined(_MSC_VER) && _MSC_VER < 1300
29 #define for if (false) ; else for
33 // This is used to attempt to keep keying material out of swap
34 // Note that VirtualLock does not provide this as a guarantee on Windows,
35 // but, in practice, memory that has been VirtualLock'd almost never gets written to
36 // the pagefile except in rare circumstances where memory is extremely low.
38 #define mlock(p, n) VirtualLock((p), (n));
39 #define munlock(p, n) VirtualUnlock((p), (n));
43 /* This comes from limits.h if it's not defined there set a sane default */
46 #define PAGESIZE sysconf(_SC_PAGESIZE)
49 mlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
50 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
51 #define munlock(a,b) \
52 munlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
53 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
59 static const unsigned int MAX_SIZE = 0x02000000;
61 static const int VERSION = 32500;
62 static const char* pszSubVer = "";
63 static const bool VERSION_IS_BETA = true;
70 /////////////////////////////////////////////////////////////////
72 // Templates for serializing to anything that looks like a stream,
73 // i.e. anything that supports .read(char*, int) and .write(char*, int)
79 SER_NETWORK = (1 << 0),
81 SER_GETHASH = (1 << 2),
84 SER_SKIPSIG = (1 << 16),
85 SER_BLOCKHEADERONLY = (1 << 17),
88 #define IMPLEMENT_SERIALIZE(statements) \
89 unsigned int GetSerializeSize(int nType=0, int nVersion=VERSION) const \
91 CSerActionGetSerializeSize ser_action; \
92 const bool fGetSize = true; \
93 const bool fWrite = false; \
94 const bool fRead = false; \
95 unsigned int nSerSize = 0; \
96 ser_streamplaceholder s; \
98 s.nVersion = nVersion; \
102 template<typename Stream> \
103 void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const \
105 CSerActionSerialize ser_action; \
106 const bool fGetSize = false; \
107 const bool fWrite = true; \
108 const bool fRead = false; \
109 unsigned int nSerSize = 0; \
112 template<typename Stream> \
113 void Unserialize(Stream& s, int nType=0, int nVersion=VERSION) \
115 CSerActionUnserialize ser_action; \
116 const bool fGetSize = false; \
117 const bool fWrite = false; \
118 const bool fRead = true; \
119 unsigned int nSerSize = 0; \
123 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
133 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
134 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
136 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
137 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
138 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
139 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
140 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
141 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
142 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
143 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
144 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
145 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
146 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
147 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
148 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
150 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
151 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
152 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
153 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
154 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
155 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
156 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
157 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
158 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
159 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
160 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
161 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
162 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
164 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
165 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
166 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
167 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
168 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
169 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
170 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
171 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
172 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
173 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
174 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
175 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
176 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
178 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
179 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
180 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
189 // size < 253 -- 1 byte
190 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
191 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
192 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
194 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
196 if (nSize < 253) return sizeof(unsigned char);
197 else if (nSize <= USHRT_MAX) return sizeof(unsigned char) + sizeof(unsigned short);
198 else if (nSize <= UINT_MAX) return sizeof(unsigned char) + sizeof(unsigned int);
199 else return sizeof(unsigned char) + sizeof(uint64);
202 template<typename Stream>
203 void WriteCompactSize(Stream& os, uint64 nSize)
207 unsigned char chSize = nSize;
208 WRITEDATA(os, chSize);
210 else if (nSize <= USHRT_MAX)
212 unsigned char chSize = 253;
213 unsigned short xSize = nSize;
214 WRITEDATA(os, chSize);
215 WRITEDATA(os, xSize);
217 else if (nSize <= UINT_MAX)
219 unsigned char chSize = 254;
220 unsigned int xSize = nSize;
221 WRITEDATA(os, chSize);
222 WRITEDATA(os, xSize);
226 unsigned char chSize = 255;
227 uint64 xSize = nSize;
228 WRITEDATA(os, chSize);
229 WRITEDATA(os, xSize);
234 template<typename Stream>
235 uint64 ReadCompactSize(Stream& is)
237 unsigned char chSize;
238 READDATA(is, chSize);
244 else if (chSize == 253)
246 unsigned short xSize;
250 else if (chSize == 254)
262 if (nSizeRet > (uint64)MAX_SIZE)
263 throw std::ios_base::failure("ReadCompactSize() : size too large");
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
273 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
280 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
281 char* begin() { return pbegin; }
282 const char* begin() const { return pbegin; }
283 char* end() { return pend; }
284 const char* end() const { return pend; }
286 unsigned int GetSerializeSize(int, int=0) const
288 return pend - pbegin;
291 template<typename Stream>
292 void Serialize(Stream& s, int, int=0) const
294 s.write(pbegin, pend - pbegin);
297 template<typename Stream>
298 void Unserialize(Stream& s, int, int=0)
300 s.read(pbegin, pend - pbegin);
307 // string stored as a fixed length field
309 template<std::size_t LEN>
310 class CFixedFieldString
313 const std::string* pcstr;
316 explicit CFixedFieldString(const std::string& str) : pcstr(&str), pstr(NULL) { }
317 explicit CFixedFieldString(std::string& str) : pcstr(&str), pstr(&str) { }
319 unsigned int GetSerializeSize(int, int=0) const
324 template<typename Stream>
325 void Serialize(Stream& s, int, int=0) const
328 strncpy(pszBuf, pcstr->c_str(), LEN);
329 s.write(pszBuf, LEN);
332 template<typename Stream>
333 void Unserialize(Stream& s, int, int=0)
336 throw std::ios_base::failure("CFixedFieldString::Unserialize : trying to unserialize to const string");
349 // Forward declarations
353 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
354 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
355 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
358 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
359 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
360 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion=VERSION);
361 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&);
362 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&);
363 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion=VERSION);
364 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&);
365 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&);
366 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion=VERSION);
368 // others derived from vector
369 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion=VERSION);
370 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion=VERSION);
371 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion=VERSION);
374 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion=VERSION);
375 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion=VERSION);
376 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion=VERSION);
379 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
380 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
381 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
384 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion=VERSION);
385 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=VERSION);
386 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=VERSION);
389 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion=VERSION);
390 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=VERSION);
391 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=VERSION);
394 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
395 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
396 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
403 // If none of the specialized versions above matched, default to calling member function.
404 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
405 // The compiler will only cast int to long if none of the other templates matched.
406 // Thanks to Boost serialization for this idea.
409 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion=VERSION)
411 return a.GetSerializeSize((int)nType, nVersion);
414 template<typename Stream, typename T>
415 inline void Serialize(Stream& os, const T& a, long nType, int nVersion=VERSION)
417 a.Serialize(os, (int)nType, nVersion);
420 template<typename Stream, typename T>
421 inline void Unserialize(Stream& is, T& a, long nType, int nVersion=VERSION)
423 a.Unserialize(is, (int)nType, nVersion);
434 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
436 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
439 template<typename Stream, typename C>
440 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
442 WriteCompactSize(os, str.size());
444 os.write((char*)&str[0], str.size() * sizeof(str[0]));
447 template<typename Stream, typename C>
448 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
450 unsigned int nSize = ReadCompactSize(is);
453 is.read((char*)&str[0], nSize * sizeof(str[0]));
461 template<typename T, typename A>
462 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
464 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
467 template<typename T, typename A>
468 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
470 unsigned int nSize = GetSizeOfCompactSize(v.size());
471 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
472 nSize += GetSerializeSize((*vi), nType, nVersion);
476 template<typename T, typename A>
477 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
479 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
483 template<typename Stream, typename T, typename A>
484 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
486 WriteCompactSize(os, v.size());
488 os.write((char*)&v[0], v.size() * sizeof(T));
491 template<typename Stream, typename T, typename A>
492 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
494 WriteCompactSize(os, v.size());
495 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
496 ::Serialize(os, (*vi), nType, nVersion);
499 template<typename Stream, typename T, typename A>
500 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
502 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
506 template<typename Stream, typename T, typename A>
507 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
509 //unsigned int nSize = ReadCompactSize(is);
511 //is.read((char*)&v[0], nSize * sizeof(T));
513 // Limit size per read so bogus size value won't cause out of memory
515 unsigned int nSize = ReadCompactSize(is);
519 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
521 is.read((char*)&v[i], blk * sizeof(T));
526 template<typename Stream, typename T, typename A>
527 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
529 //unsigned int nSize = ReadCompactSize(is);
531 //for (std::vector<T, A>::iterator vi = v.begin(); vi != v.end(); ++vi)
532 // Unserialize(is, (*vi), nType, nVersion);
535 unsigned int nSize = ReadCompactSize(is);
537 unsigned int nMid = 0;
540 nMid += 5000000 / sizeof(T);
544 for (; i < nMid; i++)
545 Unserialize(is, v[i], nType, nVersion);
549 template<typename Stream, typename T, typename A>
550 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
552 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
558 // others derived from vector
560 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
562 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
565 template<typename Stream>
566 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
568 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
571 template<typename Stream>
572 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
574 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
582 template<typename K, typename T>
583 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
585 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
588 template<typename Stream, typename K, typename T>
589 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
591 Serialize(os, item.first, nType, nVersion);
592 Serialize(os, item.second, nType, nVersion);
595 template<typename Stream, typename K, typename T>
596 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
598 Unserialize(is, item.first, nType, nVersion);
599 Unserialize(is, item.second, nType, nVersion);
607 template<typename T0, typename T1, typename T2>
608 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
610 unsigned int nSize = 0;
611 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
612 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
613 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
617 template<typename Stream, typename T0, typename T1, typename T2>
618 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
620 Serialize(os, boost::get<0>(item), nType, nVersion);
621 Serialize(os, boost::get<1>(item), nType, nVersion);
622 Serialize(os, boost::get<2>(item), nType, nVersion);
625 template<typename Stream, typename T0, typename T1, typename T2>
626 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
628 Unserialize(is, boost::get<0>(item), nType, nVersion);
629 Unserialize(is, boost::get<1>(item), nType, nVersion);
630 Unserialize(is, boost::get<2>(item), nType, nVersion);
638 template<typename T0, typename T1, typename T2, typename T3>
639 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
641 unsigned int nSize = 0;
642 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
643 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
644 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
645 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
649 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
650 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
652 Serialize(os, boost::get<0>(item), nType, nVersion);
653 Serialize(os, boost::get<1>(item), nType, nVersion);
654 Serialize(os, boost::get<2>(item), nType, nVersion);
655 Serialize(os, boost::get<3>(item), nType, nVersion);
658 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
659 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
661 Unserialize(is, boost::get<0>(item), nType, nVersion);
662 Unserialize(is, boost::get<1>(item), nType, nVersion);
663 Unserialize(is, boost::get<2>(item), nType, nVersion);
664 Unserialize(is, boost::get<3>(item), nType, nVersion);
672 template<typename K, typename T, typename Pred, typename A>
673 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
675 unsigned int nSize = GetSizeOfCompactSize(m.size());
676 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
677 nSize += GetSerializeSize((*mi), nType, nVersion);
681 template<typename Stream, typename K, typename T, typename Pred, typename A>
682 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
684 WriteCompactSize(os, m.size());
685 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
686 Serialize(os, (*mi), nType, nVersion);
689 template<typename Stream, typename K, typename T, typename Pred, typename A>
690 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
693 unsigned int nSize = ReadCompactSize(is);
694 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
695 for (unsigned int i = 0; i < nSize; i++)
697 std::pair<K, T> item;
698 Unserialize(is, item, nType, nVersion);
699 mi = m.insert(mi, item);
708 template<typename K, typename Pred, typename A>
709 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
711 unsigned int nSize = GetSizeOfCompactSize(m.size());
712 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
713 nSize += GetSerializeSize((*it), nType, nVersion);
717 template<typename Stream, typename K, typename Pred, typename A>
718 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
720 WriteCompactSize(os, m.size());
721 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
722 Serialize(os, (*it), nType, nVersion);
725 template<typename Stream, typename K, typename Pred, typename A>
726 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
729 unsigned int nSize = ReadCompactSize(is);
730 typename std::set<K, Pred, A>::iterator it = m.begin();
731 for (unsigned int i = 0; i < nSize; i++)
734 Unserialize(is, key, nType, nVersion);
735 it = m.insert(it, key);
742 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
744 class CSerActionGetSerializeSize { };
745 class CSerActionSerialize { };
746 class CSerActionUnserialize { };
748 template<typename Stream, typename T>
749 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
751 return ::GetSerializeSize(obj, nType, nVersion);
754 template<typename Stream, typename T>
755 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
757 ::Serialize(s, obj, nType, nVersion);
761 template<typename Stream, typename T>
762 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
764 ::Unserialize(s, obj, nType, nVersion);
768 struct ser_streamplaceholder
783 // Allocator that locks its contents from being paged
784 // out of memory and clears its contents before deletion.
787 struct secure_allocator : public std::allocator<T>
789 // MSVC8 default copy constructor is broken
790 typedef std::allocator<T> base;
791 typedef typename base::size_type size_type;
792 typedef typename base::difference_type difference_type;
793 typedef typename base::pointer pointer;
794 typedef typename base::const_pointer const_pointer;
795 typedef typename base::reference reference;
796 typedef typename base::const_reference const_reference;
797 typedef typename base::value_type value_type;
798 secure_allocator() throw() {}
799 secure_allocator(const secure_allocator& a) throw() : base(a) {}
800 template <typename U>
801 secure_allocator(const secure_allocator<U>& a) throw() : base(a) {}
802 ~secure_allocator() throw() {}
803 template<typename _Other> struct rebind
804 { typedef secure_allocator<_Other> other; };
806 T* allocate(std::size_t n, const void *hint = 0)
809 p = std::allocator<T>::allocate(n, hint);
811 mlock(p, sizeof(T) * n);
815 void deallocate(T* p, std::size_t n)
819 memset(p, 0, sizeof(T) * n);
820 munlock(p, sizeof(T) * n);
822 std::allocator<T>::deallocate(p, n);
829 // Double ended buffer combining vector and stream-like interfaces.
830 // >> and << read and write unformatted data using the above serialization templates.
831 // Fills with data in linear time; some stringstream implementations take N^2 time.
836 typedef std::vector<char, secure_allocator<char> > vector_type;
838 unsigned int nReadPos;
845 typedef vector_type::allocator_type allocator_type;
846 typedef vector_type::size_type size_type;
847 typedef vector_type::difference_type difference_type;
848 typedef vector_type::reference reference;
849 typedef vector_type::const_reference const_reference;
850 typedef vector_type::value_type value_type;
851 typedef vector_type::iterator iterator;
852 typedef vector_type::const_iterator const_iterator;
853 typedef vector_type::reverse_iterator reverse_iterator;
855 explicit CDataStream(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
857 Init(nTypeIn, nVersionIn);
860 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
862 Init(nTypeIn, nVersionIn);
865 #if !defined(_MSC_VER) || _MSC_VER >= 1300
866 CDataStream(const char* pbegin, const char* pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
868 Init(nTypeIn, nVersionIn);
872 CDataStream(const vector_type& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
874 Init(nTypeIn, nVersionIn);
877 CDataStream(const std::vector<char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
879 Init(nTypeIn, nVersionIn);
882 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
884 Init(nTypeIn, nVersionIn);
887 void Init(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
891 nVersion = nVersionIn;
893 exceptmask = std::ios::badbit | std::ios::failbit;
896 CDataStream& operator+=(const CDataStream& b)
898 vch.insert(vch.end(), b.begin(), b.end());
902 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
909 std::string str() const
911 return (std::string(begin(), end()));
918 const_iterator begin() const { return vch.begin() + nReadPos; }
919 iterator begin() { return vch.begin() + nReadPos; }
920 const_iterator end() const { return vch.end(); }
921 iterator end() { return vch.end(); }
922 size_type size() const { return vch.size() - nReadPos; }
923 bool empty() const { return vch.size() == nReadPos; }
924 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
925 void reserve(size_type n) { vch.reserve(n + nReadPos); }
926 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
927 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
928 void clear() { vch.clear(); nReadPos = 0; }
929 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
930 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
932 void insert(iterator it, const_iterator first, const_iterator last)
934 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
936 // special case for inserting at the front when there's room
937 nReadPos -= (last - first);
938 memcpy(&vch[nReadPos], &first[0], last - first);
941 vch.insert(it, first, last);
944 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
946 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
948 // special case for inserting at the front when there's room
949 nReadPos -= (last - first);
950 memcpy(&vch[nReadPos], &first[0], last - first);
953 vch.insert(it, first, last);
956 #if !defined(_MSC_VER) || _MSC_VER >= 1300
957 void insert(iterator it, const char* first, const char* last)
959 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
961 // special case for inserting at the front when there's room
962 nReadPos -= (last - first);
963 memcpy(&vch[nReadPos], &first[0], last - first);
966 vch.insert(it, first, last);
970 iterator erase(iterator it)
972 if (it == vch.begin() + nReadPos)
974 // special case for erasing from the front
975 if (++nReadPos >= vch.size())
977 // whenever we reach the end, we take the opportunity to clear the buffer
979 return vch.erase(vch.begin(), vch.end());
981 return vch.begin() + nReadPos;
984 return vch.erase(it);
987 iterator erase(iterator first, iterator last)
989 if (first == vch.begin() + nReadPos)
991 // special case for erasing from the front
992 if (last == vch.end())
995 return vch.erase(vch.begin(), vch.end());
999 nReadPos = (last - vch.begin());
1004 return vch.erase(first, last);
1007 inline void Compact()
1009 vch.erase(vch.begin(), vch.begin() + nReadPos);
1013 bool Rewind(size_type n)
1015 // Rewind by n characters if the buffer hasn't been compacted yet
1026 void setstate(short bits, const char* psz)
1029 if (state & exceptmask)
1030 throw std::ios_base::failure(psz);
1033 bool eof() const { return size() == 0; }
1034 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1035 bool good() const { return !eof() && (state == 0); }
1036 void clear(short n) { state = n; } // name conflict with vector clear()
1037 short exceptions() { return exceptmask; }
1038 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1039 CDataStream* rdbuf() { return this; }
1040 int in_avail() { return size(); }
1042 void SetType(int n) { nType = n; }
1043 int GetType() { return nType; }
1044 void SetVersion(int n) { nVersion = n; }
1045 int GetVersion() { return nVersion; }
1046 void ReadVersion() { *this >> nVersion; }
1047 void WriteVersion() { *this << nVersion; }
1049 CDataStream& read(char* pch, int nSize)
1051 // Read from the beginning of the buffer
1053 unsigned int nReadPosNext = nReadPos + nSize;
1054 if (nReadPosNext >= vch.size())
1056 if (nReadPosNext > vch.size())
1058 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1059 memset(pch, 0, nSize);
1060 nSize = vch.size() - nReadPos;
1062 memcpy(pch, &vch[nReadPos], nSize);
1067 memcpy(pch, &vch[nReadPos], nSize);
1068 nReadPos = nReadPosNext;
1072 CDataStream& ignore(int nSize)
1074 // Ignore from the beginning of the buffer
1076 unsigned int nReadPosNext = nReadPos + nSize;
1077 if (nReadPosNext >= vch.size())
1079 if (nReadPosNext > vch.size())
1081 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1082 nSize = vch.size() - nReadPos;
1088 nReadPos = nReadPosNext;
1092 CDataStream& write(const char* pch, int nSize)
1094 // Write to the end of the buffer
1096 vch.insert(vch.end(), pch, pch + nSize);
1100 template<typename Stream>
1101 void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const
1103 // Special case: stream << stream concatenates like stream += stream
1105 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1108 template<typename T>
1109 unsigned int GetSerializeSize(const T& obj)
1111 // Tells the size of the object if serialized to this stream
1112 return ::GetSerializeSize(obj, nType, nVersion);
1115 template<typename T>
1116 CDataStream& operator<<(const T& obj)
1118 // Serialize to this stream
1119 ::Serialize(*this, obj, nType, nVersion);
1123 template<typename T>
1124 CDataStream& operator>>(T& obj)
1126 // Unserialize from this stream
1127 ::Unserialize(*this, obj, nType, nVersion);
1132 #ifdef TESTCDATASTREAM
1139 // n=16000 0 seconds
1140 // n=32000 0 seconds
1141 // n=64000 1 seconds
1142 // n=128000 1 seconds
1143 // n=256000 2 seconds
1144 // n=512000 4 seconds
1145 // n=1024000 8 seconds
1146 // n=2048000 16 seconds
1147 // n=4096000 32 seconds
1151 // n=4000 13 seconds
1152 // n=8000 87 seconds
1153 // n=16000 400 seconds
1154 // n=32000 1660 seconds
1155 // n=64000 6749 seconds
1156 // n=128000 27241 seconds
1157 // n=256000 109804 seconds
1159 int main(int argc, char *argv[])
1161 vector<unsigned char> vch(0xcc, 250);
1162 printf("CDataStream:\n");
1163 for (int n = 1000; n <= 4500000; n *= 2)
1166 time_t nStart = time(NULL);
1167 for (int i = 0; i < n; i++)
1168 ss.write((char*)&vch[0], vch.size());
1169 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1171 printf("stringstream:\n");
1172 for (int n = 1000; n <= 4500000; n *= 2)
1175 time_t nStart = time(NULL);
1176 for (int i = 0; i < n; i++)
1177 ss.write((char*)&vch[0], vch.size());
1178 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1193 // Automatic closing wrapper for FILE*
1194 // - Will automatically close the file when it goes out of scope if not null.
1195 // - If you're returning the file pointer, return file.release().
1196 // - If you need to close the file early, use file.fclose() instead of fclose(file).
1208 typedef FILE element_type;
1210 CAutoFile(FILE* filenew=NULL, int nTypeIn=SER_DISK, int nVersionIn=VERSION)
1214 nVersion = nVersionIn;
1216 exceptmask = std::ios::badbit | std::ios::failbit;
1226 if (file != NULL && file != stdin && file != stdout && file != stderr)
1231 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1232 operator FILE*() { return file; }
1233 FILE* operator->() { return file; }
1234 FILE& operator*() { return *file; }
1235 FILE** operator&() { return &file; }
1236 FILE* operator=(FILE* pnew) { return file = pnew; }
1237 bool operator!() { return (file == NULL); }
1243 void setstate(short bits, const char* psz)
1246 if (state & exceptmask)
1247 throw std::ios_base::failure(psz);
1250 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1251 bool good() const { return state == 0; }
1252 void clear(short n = 0) { state = n; }
1253 short exceptions() { return exceptmask; }
1254 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1256 void SetType(int n) { nType = n; }
1257 int GetType() { return nType; }
1258 void SetVersion(int n) { nVersion = n; }
1259 int GetVersion() { return nVersion; }
1260 void ReadVersion() { *this >> nVersion; }
1261 void WriteVersion() { *this << nVersion; }
1263 CAutoFile& read(char* pch, int nSize)
1266 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1267 if (fread(pch, 1, nSize, file) != nSize)
1268 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1272 CAutoFile& write(const char* pch, int nSize)
1275 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1276 if (fwrite(pch, 1, nSize, file) != nSize)
1277 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1281 template<typename T>
1282 unsigned int GetSerializeSize(const T& obj)
1284 // Tells the size of the object if serialized to this stream
1285 return ::GetSerializeSize(obj, nType, nVersion);
1288 template<typename T>
1289 CAutoFile& operator<<(const T& obj)
1291 // Serialize to this stream
1293 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1294 ::Serialize(*this, obj, nType, nVersion);
1298 template<typename T>
1299 CAutoFile& operator>>(T& obj)
1301 // Unserialize from this stream
1303 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1304 ::Unserialize(*this, obj, nType, nVersion);