src/serialize.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2012 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5 #ifndef BITCOIN_SERIALIZE_H
   6 #define BITCOIN_SERIALIZE_H
   7
   8 #include <cassert>
   9 #include <vector>
  10 #include <set>
  11 #include <tuple>
  12 #include <type_traits>
  13 #include <limits>
  14 #include <cstdio>
  15 #include <ios>
  16 #include <cinttypes>
  17 #include <map>
  18
  19 #if defined __USE_MINGW_ANSI_STDIO
  20 #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior
  21 #endif
  22
  23
  24 class CScript;
  25
  26 static const unsigned int MAX_SIZE = 0x02000000;
  27
  28 // Used to bypass the rule against non-const reference to temporary
  29 // where it makes sense with wrappers such as CFlatData or CTxDB
  30 template<typename T>
  31 inline T& REF(const T& val)
  32 {
  33     return const_cast<T&>(val);
  34 }
  35
  36 /////////////////////////////////////////////////////////////////
  37 //
  38 // Templates for serializing to anything that looks like a stream,
  39 // i.e. anything that supports .read(char*, int) and .write(char*, int)
  40 //
  41
  42 enum
  43 {
  44     // primary actions
  45     SER_NETWORK         = (1 << 0),
  46     SER_DISK            = (1 << 1),
  47     SER_GETHASH         = (1 << 2),
  48
  49     // modifiers
  50     SER_SKIPSIG         = (1 << 16),
  51     SER_BLOCKHEADERONLY = (1 << 17)
  52
  53 };
  54
  55 #define IMPLEMENT_SERIALIZE(statements)    \
  56     unsigned int GetSerializeSize(int nType, int nVersion) const  \
  57     {                                           \
  58         CSerActionGetSerializeSize ser_action;  \
  59         const bool fGetSize = true;             \
  60         const bool fWrite = false;              \
  61         const bool fRead = false;               \
  62         unsigned int nSerSize = 0;              \
  63         ser_streamplaceholder s;                \
  64         assert(fGetSize||fWrite||fRead); /* suppress warning */ \
  65         s.nType = nType;                        \
  66         s.nVersion = nVersion;                  \
  67         {statements}                            \
  68         return nSerSize;                        \
  69     }                                           \
  70     template<typename Stream>                   \
  71     void Serialize(Stream& s, int nType, int nVersion) const  \
  72     {                                           \
  73         CSerActionSerialize ser_action;         \
  74         const bool fGetSize = false;            \
  75         const bool fWrite = true;               \
  76         const bool fRead = false;               \
  77         unsigned int nSerSize = 0;              \
  78         assert(fGetSize||fWrite||fRead); /* suppress warning */ \
  79         {statements}                            \
  80     }                                           \
  81     template<typename Stream>                   \
  82     void Unserialize(Stream& s, int nType, int nVersion)  \
  83     {                                           \
  84         CSerActionUnserialize ser_action;       \
  85         const bool fGetSize = false;            \
  86         const bool fWrite = false;              \
  87         const bool fRead = true;                \
  88         unsigned int nSerSize = 0;              \
  89         assert(fGetSize||fWrite||fRead); /* suppress warning */ \
  90         {statements}                            \
  91     }
  92
  93 #define READWRITE(obj)      (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
  94
  95
  96
  97
  98
  99
 100 //
 101 // Basic types
 102 //
 103 #define WRITEDATA(s, obj)   s.write((char*)&(obj), sizeof(obj))
 104 #define READDATA(s, obj)    s.read((char*)&(obj), sizeof(obj))
 105
 106 inline unsigned int GetSerializeSize(char a,           int, int=0) { return sizeof(a); }
 107 inline unsigned int GetSerializeSize(signed char a,    int, int=0) { return sizeof(a); }
 108 inline unsigned int GetSerializeSize(unsigned char a,  int, int=0) { return sizeof(a); }
 109 inline unsigned int GetSerializeSize(signed short a,   int, int=0) { return sizeof(a); }
 110 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
 111 inline unsigned int GetSerializeSize(signed int a,     int, int=0) { return sizeof(a); }
 112 inline unsigned int GetSerializeSize(unsigned int a,   int, int=0) { return sizeof(a); }
 113 //inline unsigned int GetSerializeSize(signed long a,    int, int=0) { return sizeof(a); }
 114 //inline unsigned int GetSerializeSize(unsigned long a,  int, int=0) { return sizeof(a); }
 115 inline unsigned int GetSerializeSize(int64_t a,    int, int=0) { return sizeof(a); }
 116 inline unsigned int GetSerializeSize(uint64_t a,  int, int=0) { return sizeof(a); }
 117 inline unsigned int GetSerializeSize(float a,          int, int=0) { return sizeof(a); }
 118 inline unsigned int GetSerializeSize(double a,         int, int=0) { return sizeof(a); }
 119
 120 template<typename Stream> inline void Serialize(Stream& s, char a,           int, int=0) { WRITEDATA(s, a); }
 121 template<typename Stream> inline void Serialize(Stream& s, signed char a,    int, int=0) { WRITEDATA(s, a); }
 122 template<typename Stream> inline void Serialize(Stream& s, unsigned char a,  int, int=0) { WRITEDATA(s, a); }
 123 template<typename Stream> inline void Serialize(Stream& s, signed short a,   int, int=0) { WRITEDATA(s, a); }
 124 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
 125 template<typename Stream> inline void Serialize(Stream& s, signed int a,     int, int=0) { WRITEDATA(s, a); }
 126 template<typename Stream> inline void Serialize(Stream& s, unsigned int a,   int, int=0) { WRITEDATA(s, a); }
 127 //template<typename Stream> inline void Serialize(Stream& s, signed long a,    int, int=0) { WRITEDATA(s, a); }
 128 //template<typename Stream> inline void Serialize(Stream& s, unsigned long a,  int, int=0) { WRITEDATA(s, a); }
 129 template<typename Stream> inline void Serialize(Stream& s, int64_t a,    int, int=0) { WRITEDATA(s, a); }
 130 template<typename Stream> inline void Serialize(Stream& s, uint64_t a,  int, int=0) { WRITEDATA(s, a); }
 131 template<typename Stream> inline void Serialize(Stream& s, float a,          int, int=0) { WRITEDATA(s, a); }
 132 template<typename Stream> inline void Serialize(Stream& s, double a,         int, int=0) { WRITEDATA(s, a); }
 133
 134 template<typename Stream> inline void Unserialize(Stream& s, char& a,           int, int=0) { READDATA(s, a); }
 135 template<typename Stream> inline void Unserialize(Stream& s, signed char& a,    int, int=0) { READDATA(s, a); }
 136 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a,  int, int=0) { READDATA(s, a); }
 137 template<typename Stream> inline void Unserialize(Stream& s, signed short& a,   int, int=0) { READDATA(s, a); }
 138 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
 139 template<typename Stream> inline void Unserialize(Stream& s, signed int& a,     int, int=0) { READDATA(s, a); }
 140 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a,   int, int=0) { READDATA(s, a); }
 141 //template<typename Stream> inline void Unserialize(Stream& s, signed long& a,    int, int=0) { READDATA(s, a); }
 142 //template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a,  int, int=0) { READDATA(s, a); }
 143 template<typename Stream> inline void Unserialize(Stream& s, int64_t& a,    int, int=0) { READDATA(s, a); }
 144 template<typename Stream> inline void Unserialize(Stream& s, uint64_t& a,  int, int=0) { READDATA(s, a); }
 145 template<typename Stream> inline void Unserialize(Stream& s, float& a,          int, int=0) { READDATA(s, a); }
 146 template<typename Stream> inline void Unserialize(Stream& s, double& a,         int, int=0) { READDATA(s, a); }
 147
 148 inline unsigned int GetSerializeSize(bool a, int, int=0)                          { return sizeof(char); }
 149 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0)    { char f=a; WRITEDATA(s, f); }
 150 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
 151
 152
 153
 154
 155
 156
 157 //
 158 // Compact size
 159 //  size <  253        -- 1 byte
 160 //  size <= USHRT_MAX  -- 3 bytes  (253 + 2 bytes)
 161 //  size <= UINT_MAX   -- 5 bytes  (254 + 4 bytes)
 162 //  size >  UINT_MAX   -- 9 bytes  (255 + 8 bytes)
 163 //
 164 inline unsigned int GetSizeOfCompactSize(uint64_t nSize)
 165 {
 166     if (nSize < 253)             return sizeof(unsigned char);
 167     else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
 168     else if (nSize <= std::numeric_limits<unsigned int>::max())  return sizeof(unsigned char) + sizeof(unsigned int);
 169     else                         return sizeof(unsigned char) + sizeof(uint64_t);
 170 }
 171
 172 template<typename Stream>
 173 void WriteCompactSize(Stream& os, uint64_t nSize)
 174 {
 175     if (nSize < 253)
 176     {
 177         unsigned char chSize = (unsigned char)nSize;
 178         WRITEDATA(os, chSize);
 179     }
 180     else if (nSize <= std::numeric_limits<unsigned short>::max())
 181     {
 182         unsigned char chSize = 253;
 183         unsigned short xSize = (unsigned short)nSize;
 184         WRITEDATA(os, chSize);
 185         WRITEDATA(os, xSize);
 186     }
 187     else if (nSize <= std::numeric_limits<unsigned int>::max())
 188     {
 189         unsigned char chSize = 254;
 190         unsigned int xSize = (unsigned int)nSize;
 191         WRITEDATA(os, chSize);
 192         WRITEDATA(os, xSize);
 193     }
 194     else
 195     {
 196         unsigned char chSize = 255;
 197         uint64_t xSize = nSize;
 198         WRITEDATA(os, chSize);
 199         WRITEDATA(os, xSize);
 200     }
 201     return;
 202 }
 203
 204 template<typename Stream>
 205 uint64_t ReadCompactSize(Stream& is)
 206 {
 207     unsigned char chSize;
 208     READDATA(is, chSize);
 209     uint64_t nSizeRet = 0;
 210     if (chSize < 253)
 211     {
 212         nSizeRet = chSize;
 213     }
 214     else if (chSize == 253)
 215     {
 216         unsigned short xSize;
 217         READDATA(is, xSize);
 218         nSizeRet = xSize;
 219     }
 220     else if (chSize == 254)
 221     {
 222         unsigned int xSize;
 223         READDATA(is, xSize);
 224         nSizeRet = xSize;
 225     }
 226     else
 227     {
 228         uint64_t xSize;
 229         READDATA(is, xSize);
 230         nSizeRet = xSize;
 231     }
 232     if (nSizeRet > (uint64_t)MAX_SIZE)
 233         throw std::ios_base::failure("ReadCompactSize() : size too large");
 234     return nSizeRet;
 235 }
 236
 237 // Variable-length integers: bytes are a MSB base-128 encoding of the number.
 238 // The high bit in each byte signifies whether another digit follows. To make
 239 // the encoding is one-to-one, one is subtracted from all but the last digit.
 240 // Thus, the byte sequence a[] with length len, where all but the last byte
 241 // has bit 128 set, encodes the number:
 242 //
 243 //   (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))
 244 //
 245 // Properties:
 246 // * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
 247 // * Every integer has exactly one encoding
 248 // * Encoding does not depend on size of original integer type
 249 // * No redundancy: every (infinite) byte sequence corresponds to a list
 250 //   of encoded integers.
 251 //
 252 // 0:         [0x00]  256:        [0x81 0x00]
 253 // 1:         [0x01]  16383:      [0xFE 0x7F]
 254 // 127:       [0x7F]  16384:      [0xFF 0x00]
 255 // 128:  [0x80 0x00]  16511: [0x80 0xFF 0x7F]
 256 // 255:  [0x80 0x7F]  65535: [0x82 0xFD 0x7F]
 257 // 2^32:           [0x8E 0xFE 0xFE 0xFF 0x00]
 258
 259 template<typename I>
 260 inline unsigned int GetSizeOfVarInt(I n)
 261 {
 262     int nRet = 0;
 263     for ( ; ; ) {
 264         nRet++;
 265         if (n <= 0x7F)
 266             break;
 267         n = (n >> 7) - 1;
 268     }
 269     return nRet;
 270 }
 271
 272 template<typename Stream, typename I>
 273 void WriteVarInt(Stream& os, I n)
 274 {
 275     unsigned char tmp[(sizeof(n)*8+6)/7];
 276     int len=0;
 277     for ( ; ; ) {
 278         tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00);
 279         if (n <= 0x7F)
 280             break;
 281         n = (n >> 7) - 1;
 282         len++;
 283     }
 284     do {
 285         WRITEDATA(os, tmp[len]);
 286     } while(len--);
 287 }
 288
 289 template<typename Stream, typename I>
 290 I ReadVarInt(Stream& is)
 291 {
 292     I n = 0;
 293     for ( ; ; ) {
 294         unsigned char chData;
 295         READDATA(is, chData);
 296         n = (n << 7) | (chData & 0x7F);
 297         if (chData & 0x80)
 298             n++;
 299         else
 300             return n;
 301     }
 302 }
 303
 304 #define FLATDATA(obj)  REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
 305 #define VARINT(obj)    REF(WrapVarInt(REF(obj)))
 306
 307 /** Wrapper for serializing arrays and POD.
 308  */
 309 class CFlatData
 310 {
 311 protected:
 312     char* pbegin;
 313     char* pend;
 314 public:
 315     CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
 316     char* begin() { return pbegin; }
 317     const char* begin() const { return pbegin; }
 318     char* end() { return pend; }
 319     const char* end() const { return pend; }
 320
 321     unsigned int GetSerializeSize(int, int=0) const
 322     {
 323         return (unsigned int)(pend - pbegin);
 324     }
 325
 326     template<typename Stream>
 327     void Serialize(Stream& s, int, int=0) const
 328     {
 329         s.write(pbegin, (int)(pend - pbegin));
 330     }
 331
 332     template<typename Stream>
 333     void Unserialize(Stream& s, int, int=0)
 334     {
 335         s.read(pbegin, pend - pbegin);
 336     }
 337 };
 338
 339 template<typename I>
 340 class CVarInt
 341 {
 342 protected:
 343     I &n;
 344 public:
 345     CVarInt(I& nIn) : n(nIn) { }
 346
 347     unsigned int GetSerializeSize(int, int) const {
 348         return GetSizeOfVarInt<I>(n);
 349     }
 350
 351     template<typename Stream>
 352     void Serialize(Stream &s, int, int) const {
 353         WriteVarInt<Stream,I>(s, n);
 354     }
 355
 356     template<typename Stream>
 357     void Unserialize(Stream& s, int, int) {
 358         n = ReadVarInt<Stream,I>(s);
 359     }
 360 };
 361
 362 template<typename I>
 363 CVarInt<I> WrapVarInt(I& n) { return CVarInt<I>(n); }
 364
 365 //
 366 // Forward declarations
 367 //
 368
 369 // string
 370 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
 371 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
 372 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
 373
 374 // vector
 375 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const std::true_type&);
 376 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const std::false_type&);
 377 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion);
 378 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const std::true_type&);
 379 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const std::false_type&);
 380 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion);
 381 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const std::true_type&);
 382 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const std::false_type&);
 383 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion);
 384
 385 // others derived from vector
 386 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion);
 387 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion);
 388 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion);
 389
 390 // pair
 391 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion);
 392 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion);
 393 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion);
 394
 395 // 3 tuple
 396 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const std::tuple<T0, T1, T2>& item, int nType, int nVersion);
 397 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const std::tuple<T0, T1, T2>& item, int nType, int nVersion);
 398 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, std::tuple<T0, T1, T2>& item, int nType, int nVersion);
 399
 400 // 4 tuple
 401 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
 402 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Serialize(Stream& os, const std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
 403 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Unserialize(Stream& is, std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
 404
 405 // map
 406 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion);
 407 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);
 408 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);
 409
 410 // set
 411 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion);
 412 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion);
 413 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion);
 414
 415
 416
 417
 418
 419 //
 420 // If none of the specialized versions above matched, default to calling member function.
 421 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
 422 // The compiler will only cast int to long if none of the other templates matched.
 423 // Thanks to Boost serialization for this idea.
 424 //
 425 template<typename T>
 426 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion)
 427 {
 428     return a.GetSerializeSize((int)nType, nVersion);
 429 }
 430
 431 template<typename Stream, typename T>
 432 inline void Serialize(Stream& os, const T& a, long nType, int nVersion)
 433 {
 434     a.Serialize(os, (int)nType, nVersion);
 435 }
 436
 437 template<typename Stream, typename T>
 438 inline void Unserialize(Stream& is, T& a, long nType, int nVersion)
 439 {
 440     a.Unserialize(is, (int)nType, nVersion);
 441 }
 442
 443
 444
 445
 446
 447 //
 448 // string
 449 //
 450 template<typename C>
 451 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
 452 {
 453     return (unsigned int)(GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]));
 454 }
 455
 456 template<typename Stream, typename C>
 457 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
 458 {
 459     WriteCompactSize(os, str.size());
 460     if (!str.empty())
 461         os.write((char*)&str[0], (int)(str.size() * sizeof(str[0])));
 462 }
 463
 464 template<typename Stream, typename C>
 465 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
 466 {
 467     unsigned int nSize = (unsigned int)(ReadCompactSize(is));
 468     str.resize(nSize);
 469     if (nSize != 0)
 470         is.read((char*)&str[0], nSize * sizeof(str[0]));
 471 }
 472
 473
 474
 475 //
 476 // vector
 477 //
 478 template<typename T, typename A>
 479 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const std::true_type&)
 480 {
 481     return (unsigned int)(GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
 482 }
 483
 484 template<typename T, typename A>
 485 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const std::false_type&)
 486 {
 487     unsigned int nSize = GetSizeOfCompactSize(v.size());
 488     for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
 489         nSize += GetSerializeSize((*vi), nType, nVersion);
 490     return nSize;
 491 }
 492
 493 template<typename T, typename A>
 494 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
 495 {
 496     return GetSerializeSize_impl(v, nType, nVersion, std::is_fundamental<T>());
 497 }
 498
 499
 500 template<typename Stream, typename T, typename A>
 501 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const std::true_type&)
 502 {
 503     WriteCompactSize(os, v.size());
 504     if (!v.empty())
 505         os.write((char*)&v[0], (int)(v.size() * sizeof(T)));
 506 }
 507
 508 template<typename Stream, typename T, typename A>
 509 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const std::false_type&)
 510 {
 511     WriteCompactSize(os, v.size());
 512     for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
 513         ::Serialize(os, (*vi), nType, nVersion);
 514 }
 515
 516 template<typename Stream, typename T, typename A>
 517 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
 518 {
 519     Serialize_impl(os, v, nType, nVersion, std::is_fundamental<T>());
 520 }
 521
 522
 523 template<typename Stream, typename T, typename A>
 524 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const std::true_type&)
 525 {
 526     // Limit size per read so bogus size value won't cause out of memory
 527     v.clear();
 528     unsigned int nSize = (unsigned int)(ReadCompactSize(is));
 529     unsigned int i = 0;
 530     while (i < nSize)
 531     {
 532         unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
 533         v.resize(i + blk);
 534         is.read((char*)&v[i], blk * sizeof(T));
 535         i += blk;
 536     }
 537 }
 538
 539 template<typename Stream, typename T, typename A>
 540 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const std::false_type&)
 541 {
 542     v.clear();
 543     unsigned int nSize = (unsigned int)(ReadCompactSize(is));
 544     unsigned int i = 0;
 545     unsigned int nMid = 0;
 546     while (nMid < nSize)
 547     {
 548         nMid += 5000000 / sizeof(T);
 549         if (nMid > nSize)
 550             nMid = nSize;
 551         v.resize(nMid);
 552         for (; i < nMid; i++)
 553             Unserialize(is, v[i], nType, nVersion);
 554     }
 555 }
 556
 557 template<typename Stream, typename T, typename A>
 558 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
 559 {
 560     Unserialize_impl(is, v, nType, nVersion, std::is_fundamental<T>());
 561 }
 562
 563
 564
 565 //
 566 // others derived from vector
 567 //
 568 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
 569 {
 570     return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
 571 }
 572
 573 template<typename Stream>
 574 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
 575 {
 576     Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
 577 }
 578
 579 template<typename Stream>
 580 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
 581 {
 582     Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
 583 }
 584
 585
 586
 587 //
 588 // pair
 589 //
 590 template<typename K, typename T>
 591 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
 592 {
 593     return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
 594 }
 595
 596 template<typename Stream, typename K, typename T>
 597 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
 598 {
 599     Serialize(os, item.first, nType, nVersion);
 600     Serialize(os, item.second, nType, nVersion);
 601 }
 602
 603 template<typename Stream, typename K, typename T>
 604 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
 605 {
 606     Unserialize(is, item.first, nType, nVersion);
 607     Unserialize(is, item.second, nType, nVersion);
 608 }
 609
 610
 611
 612 //
 613 // 3 tuple
 614 //
 615 template<typename T0, typename T1, typename T2>
 616 unsigned int GetSerializeSize(const std::tuple<T0, T1, T2>& item, int nType, int nVersion)
 617 {
 618     unsigned int nSize = 0;
 619     nSize += GetSerializeSize(std::get<0>(item), nType, nVersion);
 620     nSize += GetSerializeSize(std::get<1>(item), nType, nVersion);
 621     nSize += GetSerializeSize(std::get<2>(item), nType, nVersion);
 622     return nSize;
 623 }
 624
 625 template<typename Stream, typename T0, typename T1, typename T2>
 626 void Serialize(Stream& os, const std::tuple<T0, T1, T2>& item, int nType, int nVersion)
 627 {
 628     Serialize(os, std::get<0>(item), nType, nVersion);
 629     Serialize(os, std::get<1>(item), nType, nVersion);
 630     Serialize(os, std::get<2>(item), nType, nVersion);
 631 }
 632
 633 template<typename Stream, typename T0, typename T1, typename T2>
 634 void Unserialize(Stream& is, std::tuple<T0, T1, T2>& item, int nType, int nVersion)
 635 {
 636     Unserialize(is, std::get<0>(item), nType, nVersion);
 637     Unserialize(is, std::get<1>(item), nType, nVersion);
 638     Unserialize(is, std::get<2>(item), nType, nVersion);
 639 }
 640
 641
 642
 643 //
 644 // 4 tuple
 645 //
 646 template<typename T0, typename T1, typename T2, typename T3>
 647 unsigned int GetSerializeSize(const std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
 648 {
 649     unsigned int nSize = 0;
 650     nSize += GetSerializeSize(std::get<0>(item), nType, nVersion);
 651     nSize += GetSerializeSize(std::get<1>(item), nType, nVersion);
 652     nSize += GetSerializeSize(std::get<2>(item), nType, nVersion);
 653     nSize += GetSerializeSize(std::get<3>(item), nType, nVersion);
 654     return nSize;
 655 }
 656
 657 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
 658 void Serialize(Stream& os, const std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
 659 {
 660     Serialize(os, std::get<0>(item), nType, nVersion);
 661     Serialize(os, std::get<1>(item), nType, nVersion);
 662     Serialize(os, std::get<2>(item), nType, nVersion);
 663     Serialize(os, std::get<3>(item), nType, nVersion);
 664 }
 665
 666 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
 667 void Unserialize(Stream& is, std::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
 668 {
 669     Unserialize(is, std::get<0>(item), nType, nVersion);
 670     Unserialize(is, std::get<1>(item), nType, nVersion);
 671     Unserialize(is, std::get<2>(item), nType, nVersion);
 672     Unserialize(is, std::get<3>(item), nType, nVersion);
 673 }
 674
 675
 676
 677 //
 678 // map
 679 //
 680 template<typename K, typename T, typename Pred, typename A>
 681 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
 682 {
 683     unsigned int nSize = GetSizeOfCompactSize(m.size());
 684     for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
 685         nSize += GetSerializeSize((*mi), nType, nVersion);
 686     return nSize;
 687 }
 688
 689 template<typename Stream, typename K, typename T, typename Pred, typename A>
 690 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
 691 {
 692     WriteCompactSize(os, m.size());
 693     for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
 694         Serialize(os, (*mi), nType, nVersion);
 695 }
 696
 697 template<typename Stream, typename K, typename T, typename Pred, typename A>
 698 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
 699 {
 700     m.clear();
 701     unsigned int nSize = (unsigned int)(ReadCompactSize(is));
 702     typename std::map<K, T, Pred, A>::iterator mi = m.begin();
 703     for (unsigned int i = 0; i < nSize; i++)
 704     {
 705         std::pair<K, T> item;
 706         Unserialize(is, item, nType, nVersion);
 707         mi = m.insert(mi, item);
 708     }
 709 }
 710
 711
 712
 713 //
 714 // set
 715 //
 716 template<typename K, typename Pred, typename A>
 717 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
 718 {
 719     unsigned int nSize = GetSizeOfCompactSize(m.size());
 720     for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
 721         nSize += GetSerializeSize((*it), nType, nVersion);
 722     return nSize;
 723 }
 724
 725 template<typename Stream, typename K, typename Pred, typename A>
 726 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
 727 {
 728     WriteCompactSize(os, m.size());
 729     for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
 730         Serialize(os, (*it), nType, nVersion);
 731 }
 732
 733 template<typename Stream, typename K, typename Pred, typename A>
 734 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
 735 {
 736     m.clear();
 737     unsigned int nSize = ReadCompactSize(is);
 738     typename std::set<K, Pred, A>::iterator it = m.begin();
 739     for (unsigned int i = 0; i < nSize; i++)
 740     {
 741         K key;
 742         Unserialize(is, key, nType, nVersion);
 743         it = m.insert(it, key);
 744     }
 745 }
 746
 747
 748
 749 //
 750 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
 751 //
 752 class CSerActionGetSerializeSize { };
 753 class CSerActionSerialize { };
 754 class CSerActionUnserialize { };
 755
 756 template<typename Stream, typename T>
 757 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
 758 {
 759     return ::GetSerializeSize(obj, nType, nVersion);
 760 }
 761
 762 template<typename Stream, typename T>
 763 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
 764 {
 765     ::Serialize(s, obj, nType, nVersion);
 766     return 0;
 767 }
 768
 769 template<typename Stream, typename T>
 770 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
 771 {
 772     ::Unserialize(s, obj, nType, nVersion);
 773     return 0;
 774 }
 775
 776 struct ser_streamplaceholder
 777 {
 778     int nType;
 779     int nVersion;
 780 };
 781
 782 #endif