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
34 // This is used to attempt to keep keying material out of swap
35 // Note that VirtualLock does not provide this as a guarantee on Windows,
36 // but, in practice, memory that has been VirtualLock'd almost never gets written to
37 // the pagefile except in rare circumstances where memory is extremely low.
39 #define mlock(p, n) VirtualLock((p), (n));
40 #define munlock(p, n) VirtualUnlock((p), (n));
44 /* This comes from limits.h if it's not defined there set a sane default */
47 #define PAGESIZE sysconf(_SC_PAGESIZE)
50 mlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
51 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
52 #define munlock(a,b) \
53 munlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
54 (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
60 static const unsigned int MAX_SIZE = 0x02000000;
62 static const int VERSION = 32500;
63 static const char* pszSubVer = "";
64 static const bool VERSION_IS_BETA = true;
71 /////////////////////////////////////////////////////////////////
73 // Templates for serializing to anything that looks like a stream,
74 // i.e. anything that supports .read(char*, int) and .write(char*, int)
80 SER_NETWORK = (1 << 0),
82 SER_GETHASH = (1 << 2),
85 SER_SKIPSIG = (1 << 16),
86 SER_BLOCKHEADERONLY = (1 << 17),
89 #define IMPLEMENT_SERIALIZE(statements) \
90 unsigned int GetSerializeSize(int nType=0, int nVersion=VERSION) const \
92 CSerActionGetSerializeSize ser_action; \
93 const bool fGetSize = true; \
94 const bool fWrite = false; \
95 const bool fRead = false; \
96 unsigned int nSerSize = 0; \
97 ser_streamplaceholder s; \
99 s.nVersion = nVersion; \
103 template<typename Stream> \
104 void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const \
106 CSerActionSerialize ser_action; \
107 const bool fGetSize = false; \
108 const bool fWrite = true; \
109 const bool fRead = false; \
110 unsigned int nSerSize = 0; \
113 template<typename Stream> \
114 void Unserialize(Stream& s, int nType=0, int nVersion=VERSION) \
116 CSerActionUnserialize ser_action; \
117 const bool fGetSize = false; \
118 const bool fWrite = false; \
119 const bool fRead = true; \
120 unsigned int nSerSize = 0; \
124 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
134 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
135 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
137 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
138 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
139 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
140 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
141 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
142 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
143 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
144 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
145 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
146 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
147 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
148 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
149 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
151 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
152 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
153 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
154 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
155 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
156 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
157 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
158 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
159 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
160 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
161 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
162 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
163 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
165 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
166 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
167 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
168 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
169 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
170 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
171 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
172 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
173 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
174 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
175 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
176 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
177 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
179 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
180 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
181 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
190 // size < 253 -- 1 byte
191 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
192 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
193 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
195 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
197 if (nSize < 253) return sizeof(unsigned char);
198 else if (nSize <= USHRT_MAX) return sizeof(unsigned char) + sizeof(unsigned short);
199 else if (nSize <= UINT_MAX) return sizeof(unsigned char) + sizeof(unsigned int);
200 else return sizeof(unsigned char) + sizeof(uint64);
203 template<typename Stream>
204 void WriteCompactSize(Stream& os, uint64 nSize)
208 unsigned char chSize = nSize;
209 WRITEDATA(os, chSize);
211 else if (nSize <= USHRT_MAX)
213 unsigned char chSize = 253;
214 unsigned short xSize = nSize;
215 WRITEDATA(os, chSize);
216 WRITEDATA(os, xSize);
218 else if (nSize <= UINT_MAX)
220 unsigned char chSize = 254;
221 unsigned int xSize = nSize;
222 WRITEDATA(os, chSize);
223 WRITEDATA(os, xSize);
227 unsigned char chSize = 255;
228 uint64 xSize = nSize;
229 WRITEDATA(os, chSize);
230 WRITEDATA(os, xSize);
235 template<typename Stream>
236 uint64 ReadCompactSize(Stream& is)
238 unsigned char chSize;
239 READDATA(is, chSize);
245 else if (chSize == 253)
247 unsigned short xSize;
251 else if (chSize == 254)
263 if (nSizeRet > (uint64)MAX_SIZE)
264 throw std::ios_base::failure("ReadCompactSize() : size too large");
271 // Wrapper for serializing arrays and POD
272 // There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it
274 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
281 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
282 char* begin() { return pbegin; }
283 const char* begin() const { return pbegin; }
284 char* end() { return pend; }
285 const char* end() const { return pend; }
287 unsigned int GetSerializeSize(int, int=0) const
289 return pend - pbegin;
292 template<typename Stream>
293 void Serialize(Stream& s, int, int=0) const
295 s.write(pbegin, pend - pbegin);
298 template<typename Stream>
299 void Unserialize(Stream& s, int, int=0)
301 s.read(pbegin, pend - pbegin);
308 // string stored as a fixed length field
310 template<std::size_t LEN>
311 class CFixedFieldString
314 const std::string* pcstr;
317 explicit CFixedFieldString(const std::string& str) : pcstr(&str), pstr(NULL) { }
318 explicit CFixedFieldString(std::string& str) : pcstr(&str), pstr(&str) { }
320 unsigned int GetSerializeSize(int, int=0) const
325 template<typename Stream>
326 void Serialize(Stream& s, int, int=0) const
329 strncpy(pszBuf, pcstr->c_str(), LEN);
330 s.write(pszBuf, LEN);
333 template<typename Stream>
334 void Unserialize(Stream& s, int, int=0)
337 throw std::ios_base::failure("CFixedFieldString::Unserialize : trying to unserialize to const string");
350 // Forward declarations
354 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
355 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
356 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
359 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
360 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
361 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion=VERSION);
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::true_type&);
363 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&);
364 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion=VERSION);
365 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&);
366 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&);
367 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion=VERSION);
369 // others derived from vector
370 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion=VERSION);
371 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion=VERSION);
372 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion=VERSION);
375 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion=VERSION);
376 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion=VERSION);
377 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion=VERSION);
380 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
381 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);
382 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
385 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);
386 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);
387 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);
390 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);
391 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);
392 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);
395 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
396 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);
397 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
404 // If none of the specialized versions above matched, default to calling member function.
405 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
406 // The compiler will only cast int to long if none of the other templates matched.
407 // Thanks to Boost serialization for this idea.
410 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion=VERSION)
412 return a.GetSerializeSize((int)nType, nVersion);
415 template<typename Stream, typename T>
416 inline void Serialize(Stream& os, const T& a, long nType, int nVersion=VERSION)
418 a.Serialize(os, (int)nType, nVersion);
421 template<typename Stream, typename T>
422 inline void Unserialize(Stream& is, T& a, long nType, int nVersion=VERSION)
424 a.Unserialize(is, (int)nType, nVersion);
435 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
437 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
440 template<typename Stream, typename C>
441 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
443 WriteCompactSize(os, str.size());
445 os.write((char*)&str[0], str.size() * sizeof(str[0]));
448 template<typename Stream, typename C>
449 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
451 unsigned int nSize = ReadCompactSize(is);
454 is.read((char*)&str[0], nSize * sizeof(str[0]));
462 template<typename T, typename A>
463 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
465 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
468 template<typename T, typename A>
469 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
471 unsigned int nSize = GetSizeOfCompactSize(v.size());
472 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
473 nSize += GetSerializeSize((*vi), nType, nVersion);
477 template<typename T, typename A>
478 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
480 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
484 template<typename Stream, typename T, typename A>
485 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
487 WriteCompactSize(os, v.size());
489 os.write((char*)&v[0], v.size() * sizeof(T));
492 template<typename Stream, typename T, typename A>
493 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
495 WriteCompactSize(os, v.size());
496 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
497 ::Serialize(os, (*vi), nType, nVersion);
500 template<typename Stream, typename T, typename A>
501 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
503 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
507 template<typename Stream, typename T, typename A>
508 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
510 //unsigned int nSize = ReadCompactSize(is);
512 //is.read((char*)&v[0], nSize * sizeof(T));
514 // Limit size per read so bogus size value won't cause out of memory
516 unsigned int nSize = ReadCompactSize(is);
520 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
522 is.read((char*)&v[i], blk * sizeof(T));
527 template<typename Stream, typename T, typename A>
528 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
530 //unsigned int nSize = ReadCompactSize(is);
532 //for (std::vector<T, A>::iterator vi = v.begin(); vi != v.end(); ++vi)
533 // Unserialize(is, (*vi), nType, nVersion);
536 unsigned int nSize = ReadCompactSize(is);
538 unsigned int nMid = 0;
541 nMid += 5000000 / sizeof(T);
545 for (; i < nMid; i++)
546 Unserialize(is, v[i], nType, nVersion);
550 template<typename Stream, typename T, typename A>
551 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
553 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
559 // others derived from vector
561 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
563 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
566 template<typename Stream>
567 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
569 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
572 template<typename Stream>
573 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
575 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
583 template<typename K, typename T>
584 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
586 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
589 template<typename Stream, typename K, typename T>
590 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
592 Serialize(os, item.first, nType, nVersion);
593 Serialize(os, item.second, nType, nVersion);
596 template<typename Stream, typename K, typename T>
597 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
599 Unserialize(is, item.first, nType, nVersion);
600 Unserialize(is, item.second, nType, nVersion);
608 template<typename T0, typename T1, typename T2>
609 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
611 unsigned int nSize = 0;
612 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
613 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
614 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
618 template<typename Stream, typename T0, typename T1, typename T2>
619 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
621 Serialize(os, boost::get<0>(item), nType, nVersion);
622 Serialize(os, boost::get<1>(item), nType, nVersion);
623 Serialize(os, boost::get<2>(item), nType, nVersion);
626 template<typename Stream, typename T0, typename T1, typename T2>
627 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
629 Unserialize(is, boost::get<0>(item), nType, nVersion);
630 Unserialize(is, boost::get<1>(item), nType, nVersion);
631 Unserialize(is, boost::get<2>(item), nType, nVersion);
639 template<typename T0, typename T1, typename T2, typename T3>
640 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
642 unsigned int nSize = 0;
643 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
644 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
645 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
646 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
650 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
651 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
653 Serialize(os, boost::get<0>(item), nType, nVersion);
654 Serialize(os, boost::get<1>(item), nType, nVersion);
655 Serialize(os, boost::get<2>(item), nType, nVersion);
656 Serialize(os, boost::get<3>(item), nType, nVersion);
659 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
660 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
662 Unserialize(is, boost::get<0>(item), nType, nVersion);
663 Unserialize(is, boost::get<1>(item), nType, nVersion);
664 Unserialize(is, boost::get<2>(item), nType, nVersion);
665 Unserialize(is, boost::get<3>(item), nType, nVersion);
673 template<typename K, typename T, typename Pred, typename A>
674 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
676 unsigned int nSize = GetSizeOfCompactSize(m.size());
677 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
678 nSize += GetSerializeSize((*mi), nType, nVersion);
682 template<typename Stream, typename K, typename T, typename Pred, typename A>
683 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
685 WriteCompactSize(os, m.size());
686 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
687 Serialize(os, (*mi), nType, nVersion);
690 template<typename Stream, typename K, typename T, typename Pred, typename A>
691 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
694 unsigned int nSize = ReadCompactSize(is);
695 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
696 for (unsigned int i = 0; i < nSize; i++)
698 std::pair<K, T> item;
699 Unserialize(is, item, nType, nVersion);
700 mi = m.insert(mi, item);
709 template<typename K, typename Pred, typename A>
710 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
712 unsigned int nSize = GetSizeOfCompactSize(m.size());
713 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
714 nSize += GetSerializeSize((*it), nType, nVersion);
718 template<typename Stream, typename K, typename Pred, typename A>
719 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
721 WriteCompactSize(os, m.size());
722 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
723 Serialize(os, (*it), nType, nVersion);
726 template<typename Stream, typename K, typename Pred, typename A>
727 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
730 unsigned int nSize = ReadCompactSize(is);
731 typename std::set<K, Pred, A>::iterator it = m.begin();
732 for (unsigned int i = 0; i < nSize; i++)
735 Unserialize(is, key, nType, nVersion);
736 it = m.insert(it, key);
743 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
745 class CSerActionGetSerializeSize { };
746 class CSerActionSerialize { };
747 class CSerActionUnserialize { };
749 template<typename Stream, typename T>
750 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
752 return ::GetSerializeSize(obj, nType, nVersion);
755 template<typename Stream, typename T>
756 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
758 ::Serialize(s, obj, nType, nVersion);
762 template<typename Stream, typename T>
763 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
765 ::Unserialize(s, obj, nType, nVersion);
769 struct ser_streamplaceholder
784 // Allocator that locks its contents from being paged
785 // out of memory and clears its contents before deletion.
788 struct secure_allocator : public std::allocator<T>
790 // MSVC8 default copy constructor is broken
791 typedef std::allocator<T> base;
792 typedef typename base::size_type size_type;
793 typedef typename base::difference_type difference_type;
794 typedef typename base::pointer pointer;
795 typedef typename base::const_pointer const_pointer;
796 typedef typename base::reference reference;
797 typedef typename base::const_reference const_reference;
798 typedef typename base::value_type value_type;
799 secure_allocator() throw() {}
800 secure_allocator(const secure_allocator& a) throw() : base(a) {}
801 template <typename U>
802 secure_allocator(const secure_allocator<U>& a) throw() : base(a) {}
803 ~secure_allocator() throw() {}
804 template<typename _Other> struct rebind
805 { typedef secure_allocator<_Other> other; };
807 T* allocate(std::size_t n, const void *hint = 0)
810 p = std::allocator<T>::allocate(n, hint);
812 mlock(p, sizeof(T) * n);
816 void deallocate(T* p, std::size_t n)
820 memset(p, 0, sizeof(T) * n);
821 munlock(p, sizeof(T) * n);
823 std::allocator<T>::deallocate(p, n);
830 // Double ended buffer combining vector and stream-like interfaces.
831 // >> and << read and write unformatted data using the above serialization templates.
832 // Fills with data in linear time; some stringstream implementations take N^2 time.
837 typedef std::vector<char, secure_allocator<char> > vector_type;
839 unsigned int nReadPos;
846 typedef vector_type::allocator_type allocator_type;
847 typedef vector_type::size_type size_type;
848 typedef vector_type::difference_type difference_type;
849 typedef vector_type::reference reference;
850 typedef vector_type::const_reference const_reference;
851 typedef vector_type::value_type value_type;
852 typedef vector_type::iterator iterator;
853 typedef vector_type::const_iterator const_iterator;
854 typedef vector_type::reverse_iterator reverse_iterator;
856 explicit CDataStream(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
858 Init(nTypeIn, nVersionIn);
861 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
863 Init(nTypeIn, nVersionIn);
866 #if !defined(_MSC_VER) || _MSC_VER >= 1300
867 CDataStream(const char* pbegin, const char* pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
869 Init(nTypeIn, nVersionIn);
873 CDataStream(const vector_type& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
875 Init(nTypeIn, nVersionIn);
878 CDataStream(const std::vector<char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
880 Init(nTypeIn, nVersionIn);
883 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
885 Init(nTypeIn, nVersionIn);
888 void Init(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
892 nVersion = nVersionIn;
894 exceptmask = std::ios::badbit | std::ios::failbit;
897 CDataStream& operator+=(const CDataStream& b)
899 vch.insert(vch.end(), b.begin(), b.end());
903 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
910 std::string str() const
912 return (std::string(begin(), end()));
919 const_iterator begin() const { return vch.begin() + nReadPos; }
920 iterator begin() { return vch.begin() + nReadPos; }
921 const_iterator end() const { return vch.end(); }
922 iterator end() { return vch.end(); }
923 size_type size() const { return vch.size() - nReadPos; }
924 bool empty() const { return vch.size() == nReadPos; }
925 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
926 void reserve(size_type n) { vch.reserve(n + nReadPos); }
927 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
928 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
929 void clear() { vch.clear(); nReadPos = 0; }
930 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
931 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
933 void insert(iterator it, const_iterator first, const_iterator last)
935 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
937 // special case for inserting at the front when there's room
938 nReadPos -= (last - first);
939 memcpy(&vch[nReadPos], &first[0], last - first);
942 vch.insert(it, first, last);
945 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
947 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
949 // special case for inserting at the front when there's room
950 nReadPos -= (last - first);
951 memcpy(&vch[nReadPos], &first[0], last - first);
954 vch.insert(it, first, last);
957 #if !defined(_MSC_VER) || _MSC_VER >= 1300
958 void insert(iterator it, const char* first, const char* last)
960 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
962 // special case for inserting at the front when there's room
963 nReadPos -= (last - first);
964 memcpy(&vch[nReadPos], &first[0], last - first);
967 vch.insert(it, first, last);
971 iterator erase(iterator it)
973 if (it == vch.begin() + nReadPos)
975 // special case for erasing from the front
976 if (++nReadPos >= vch.size())
978 // whenever we reach the end, we take the opportunity to clear the buffer
980 return vch.erase(vch.begin(), vch.end());
982 return vch.begin() + nReadPos;
985 return vch.erase(it);
988 iterator erase(iterator first, iterator last)
990 if (first == vch.begin() + nReadPos)
992 // special case for erasing from the front
993 if (last == vch.end())
996 return vch.erase(vch.begin(), vch.end());
1000 nReadPos = (last - vch.begin());
1005 return vch.erase(first, last);
1008 inline void Compact()
1010 vch.erase(vch.begin(), vch.begin() + nReadPos);
1014 bool Rewind(size_type n)
1016 // Rewind by n characters if the buffer hasn't been compacted yet
1027 void setstate(short bits, const char* psz)
1030 if (state & exceptmask)
1031 throw std::ios_base::failure(psz);
1034 bool eof() const { return size() == 0; }
1035 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1036 bool good() const { return !eof() && (state == 0); }
1037 void clear(short n) { state = n; } // name conflict with vector clear()
1038 short exceptions() { return exceptmask; }
1039 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1040 CDataStream* rdbuf() { return this; }
1041 int in_avail() { return size(); }
1043 void SetType(int n) { nType = n; }
1044 int GetType() { return nType; }
1045 void SetVersion(int n) { nVersion = n; }
1046 int GetVersion() { return nVersion; }
1047 void ReadVersion() { *this >> nVersion; }
1048 void WriteVersion() { *this << nVersion; }
1050 CDataStream& read(char* pch, int nSize)
1052 // Read from the beginning of the buffer
1054 unsigned int nReadPosNext = nReadPos + nSize;
1055 if (nReadPosNext >= vch.size())
1057 if (nReadPosNext > vch.size())
1059 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1060 memset(pch, 0, nSize);
1061 nSize = vch.size() - nReadPos;
1063 memcpy(pch, &vch[nReadPos], nSize);
1068 memcpy(pch, &vch[nReadPos], nSize);
1069 nReadPos = nReadPosNext;
1073 CDataStream& ignore(int nSize)
1075 // Ignore from the beginning of the buffer
1077 unsigned int nReadPosNext = nReadPos + nSize;
1078 if (nReadPosNext >= vch.size())
1080 if (nReadPosNext > vch.size())
1082 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1083 nSize = vch.size() - nReadPos;
1089 nReadPos = nReadPosNext;
1093 CDataStream& write(const char* pch, int nSize)
1095 // Write to the end of the buffer
1097 vch.insert(vch.end(), pch, pch + nSize);
1101 template<typename Stream>
1102 void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const
1104 // Special case: stream << stream concatenates like stream += stream
1106 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1109 template<typename T>
1110 unsigned int GetSerializeSize(const T& obj)
1112 // Tells the size of the object if serialized to this stream
1113 return ::GetSerializeSize(obj, nType, nVersion);
1116 template<typename T>
1117 CDataStream& operator<<(const T& obj)
1119 // Serialize to this stream
1120 ::Serialize(*this, obj, nType, nVersion);
1124 template<typename T>
1125 CDataStream& operator>>(T& obj)
1127 // Unserialize from this stream
1128 ::Unserialize(*this, obj, nType, nVersion);
1133 #ifdef TESTCDATASTREAM
1140 // n=16000 0 seconds
1141 // n=32000 0 seconds
1142 // n=64000 1 seconds
1143 // n=128000 1 seconds
1144 // n=256000 2 seconds
1145 // n=512000 4 seconds
1146 // n=1024000 8 seconds
1147 // n=2048000 16 seconds
1148 // n=4096000 32 seconds
1152 // n=4000 13 seconds
1153 // n=8000 87 seconds
1154 // n=16000 400 seconds
1155 // n=32000 1660 seconds
1156 // n=64000 6749 seconds
1157 // n=128000 27241 seconds
1158 // n=256000 109804 seconds
1160 int main(int argc, char *argv[])
1162 vector<unsigned char> vch(0xcc, 250);
1163 printf("CDataStream:\n");
1164 for (int n = 1000; n <= 4500000; n *= 2)
1167 time_t nStart = time(NULL);
1168 for (int i = 0; i < n; i++)
1169 ss.write((char*)&vch[0], vch.size());
1170 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1172 printf("stringstream:\n");
1173 for (int n = 1000; n <= 4500000; n *= 2)
1176 time_t nStart = time(NULL);
1177 for (int i = 0; i < n; i++)
1178 ss.write((char*)&vch[0], vch.size());
1179 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1194 // Automatic closing wrapper for FILE*
1195 // - Will automatically close the file when it goes out of scope if not null.
1196 // - If you're returning the file pointer, return file.release().
1197 // - If you need to close the file early, use file.fclose() instead of fclose(file).
1209 typedef FILE element_type;
1211 CAutoFile(FILE* filenew=NULL, int nTypeIn=SER_DISK, int nVersionIn=VERSION)
1215 nVersion = nVersionIn;
1217 exceptmask = std::ios::badbit | std::ios::failbit;
1227 if (file != NULL && file != stdin && file != stdout && file != stderr)
1232 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1233 operator FILE*() { return file; }
1234 FILE* operator->() { return file; }
1235 FILE& operator*() { return *file; }
1236 FILE** operator&() { return &file; }
1237 FILE* operator=(FILE* pnew) { return file = pnew; }
1238 bool operator!() { return (file == NULL); }
1244 void setstate(short bits, const char* psz)
1247 if (state & exceptmask)
1248 throw std::ios_base::failure(psz);
1251 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1252 bool good() const { return state == 0; }
1253 void clear(short n = 0) { state = n; }
1254 short exceptions() { return exceptmask; }
1255 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1257 void SetType(int n) { nType = n; }
1258 int GetType() { return nType; }
1259 void SetVersion(int n) { nVersion = n; }
1260 int GetVersion() { return nVersion; }
1261 void ReadVersion() { *this >> nVersion; }
1262 void WriteVersion() { *this << nVersion; }
1264 CAutoFile& read(char* pch, int nSize)
1267 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1268 if (fread(pch, 1, nSize, file) != nSize)
1269 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1273 CAutoFile& write(const char* pch, int nSize)
1276 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1277 if (fwrite(pch, 1, nSize, file) != nSize)
1278 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1282 template<typename T>
1283 unsigned int GetSerializeSize(const T& obj)
1285 // Tells the size of the object if serialized to this stream
1286 return ::GetSerializeSize(obj, nType, nVersion);
1289 template<typename T>
1290 CAutoFile& operator<<(const T& obj)
1292 // Serialize to this stream
1294 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1295 ::Serialize(*this, obj, nType, nVersion);
1299 template<typename T>
1300 CAutoFile& operator>>(T& obj)
1302 // Unserialize from this stream
1304 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1305 ::Unserialize(*this, obj, nType, nVersion);