src/serialize.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2016 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #ifndef BITCOIN_SERIALIZE_H
   7 #define BITCOIN_SERIALIZE_H
   8
   9 #include <compat/endian.h>
  10
  11 #include <algorithm>
  12 #include <assert.h>
  13 #include <ios>
  14 #include <limits>
  15 #include <map>
  16 #include <memory>
  17 #include <set>
  18 #include <stdint.h>
  19 #include <string>
  20 #include <string.h>
  21 #include <utility>
  22 #include <vector>
  23
  24 #include <prevector.h>
  25
  26 static const unsigned int MAX_SIZE = 0x02000000;
  27
  28 /**
  29  * Dummy data type to identify deserializing constructors.
  30  *
  31  * By convention, a constructor of a type T with signature
  32  *
  33  *   template <typename Stream> T::T(deserialize_type, Stream& s)
  34  *
  35  * is a deserializing constructor, which builds the type by
  36  * deserializing it from s. If T contains const fields, this
  37  * is likely the only way to do so.
  38  */
  39 struct deserialize_type {};
  40 constexpr deserialize_type deserialize {};
  41
  42 /**
  43  * Used to bypass the rule against non-const reference to temporary
  44  * where it makes sense with wrappers such as CFlatData or CTxDB
  45  */
  46 template<typename T>
  47 inline T& REF(const T& val)
  48 {
  49     return const_cast<T&>(val);
  50 }
  51
  52 /**
  53  * Used to acquire a non-const pointer "this" to generate bodies
  54  * of const serialization operations from a template
  55  */
  56 template<typename T>
  57 inline T* NCONST_PTR(const T* val)
  58 {
  59     return const_cast<T*>(val);
  60 }
  61
  62 /*
  63  * Lowest-level serialization and conversion.
  64  * @note Sizes of these types are verified in the tests
  65  */
  66 template<typename Stream> inline void ser_writedata8(Stream &s, uint8_t obj)
  67 {
  68     s.write((char*)&obj, 1);
  69 }
  70 template<typename Stream> inline void ser_writedata16(Stream &s, uint16_t obj)
  71 {
  72     obj = htole16(obj);
  73     s.write((char*)&obj, 2);
  74 }
  75 template<typename Stream> inline void ser_writedata32(Stream &s, uint32_t obj)
  76 {
  77     obj = htole32(obj);
  78     s.write((char*)&obj, 4);
  79 }
  80 template<typename Stream> inline void ser_writedata64(Stream &s, uint64_t obj)
  81 {
  82     obj = htole64(obj);
  83     s.write((char*)&obj, 8);
  84 }
  85 template<typename Stream> inline uint8_t ser_readdata8(Stream &s)
  86 {
  87     uint8_t obj;
  88     s.read((char*)&obj, 1);
  89     return obj;
  90 }
  91 template<typename Stream> inline uint16_t ser_readdata16(Stream &s)
  92 {
  93     uint16_t obj;
  94     s.read((char*)&obj, 2);
  95     return le16toh(obj);
  96 }
  97 template<typename Stream> inline uint32_t ser_readdata32(Stream &s)
  98 {
  99     uint32_t obj;
 100     s.read((char*)&obj, 4);
 101     return le32toh(obj);
 102 }
 103 template<typename Stream> inline uint64_t ser_readdata64(Stream &s)
 104 {
 105     uint64_t obj;
 106     s.read((char*)&obj, 8);
 107     return le64toh(obj);
 108 }
 109 inline uint64_t ser_double_to_uint64(double x)
 110 {
 111     union { double x; uint64_t y; } tmp;
 112     tmp.x = x;
 113     return tmp.y;
 114 }
 115 inline uint32_t ser_float_to_uint32(float x)
 116 {
 117     union { float x; uint32_t y; } tmp;
 118     tmp.x = x;
 119     return tmp.y;
 120 }
 121 inline double ser_uint64_to_double(uint64_t y)
 122 {
 123     union { double x; uint64_t y; } tmp;
 124     tmp.y = y;
 125     return tmp.x;
 126 }
 127 inline float ser_uint32_to_float(uint32_t y)
 128 {
 129     union { float x; uint32_t y; } tmp;
 130     tmp.y = y;
 131     return tmp.x;
 132 }
 133
 134
 135 /////////////////////////////////////////////////////////////////
 136 //
 137 // Templates for serializing to anything that looks like a stream,
 138 // i.e. anything that supports .read(char*, size_t) and .write(char*, size_t)
 139 //
 140
 141 class CSizeComputer;
 142
 143 enum
 144 {
 145     // primary actions
 146     SER_NETWORK         = (1 << 0),
 147     SER_DISK            = (1 << 1),
 148     SER_GETHASH         = (1 << 2),
 149 };
 150
 151 #define READWRITE(obj)      (::SerReadWrite(s, (obj), ser_action))
 152 #define READWRITEMANY(...)      (::SerReadWriteMany(s, ser_action, __VA_ARGS__))
 153
 154 /**
 155  * Implement three methods for serializable objects. These are actually wrappers over
 156  * "SerializationOp" template, which implements the body of each class' serialization
 157  * code. Adding "ADD_SERIALIZE_METHODS" in the body of the class causes these wrappers to be
 158  * added as members.
 159  */
 160 #define ADD_SERIALIZE_METHODS                                         \
 161     template<typename Stream>                                         \
 162     void Serialize(Stream& s) const {                                 \
 163         NCONST_PTR(this)->SerializationOp(s, CSerActionSerialize());  \
 164     }                                                                 \
 165     template<typename Stream>                                         \
 166     void Unserialize(Stream& s) {                                     \
 167         SerializationOp(s, CSerActionUnserialize());                  \
 168     }
 169
 170 template<typename Stream> inline void Serialize(Stream& s, char a    ) { ser_writedata8(s, a); } // TODO Get rid of bare char
 171 template<typename Stream> inline void Serialize(Stream& s, int8_t a  ) { ser_writedata8(s, a); }
 172 template<typename Stream> inline void Serialize(Stream& s, uint8_t a ) { ser_writedata8(s, a); }
 173 template<typename Stream> inline void Serialize(Stream& s, int16_t a ) { ser_writedata16(s, a); }
 174 template<typename Stream> inline void Serialize(Stream& s, uint16_t a) { ser_writedata16(s, a); }
 175 template<typename Stream> inline void Serialize(Stream& s, int32_t a ) { ser_writedata32(s, a); }
 176 template<typename Stream> inline void Serialize(Stream& s, uint32_t a) { ser_writedata32(s, a); }
 177 template<typename Stream> inline void Serialize(Stream& s, int64_t a ) { ser_writedata64(s, a); }
 178 template<typename Stream> inline void Serialize(Stream& s, uint64_t a) { ser_writedata64(s, a); }
 179 template<typename Stream> inline void Serialize(Stream& s, float a   ) { ser_writedata32(s, ser_float_to_uint32(a)); }
 180 template<typename Stream> inline void Serialize(Stream& s, double a  ) { ser_writedata64(s, ser_double_to_uint64(a)); }
 181
 182 template<typename Stream> inline void Unserialize(Stream& s, char& a    ) { a = ser_readdata8(s); } // TODO Get rid of bare char
 183 template<typename Stream> inline void Unserialize(Stream& s, int8_t& a  ) { a = ser_readdata8(s); }
 184 template<typename Stream> inline void Unserialize(Stream& s, uint8_t& a ) { a = ser_readdata8(s); }
 185 template<typename Stream> inline void Unserialize(Stream& s, int16_t& a ) { a = ser_readdata16(s); }
 186 template<typename Stream> inline void Unserialize(Stream& s, uint16_t& a) { a = ser_readdata16(s); }
 187 template<typename Stream> inline void Unserialize(Stream& s, int32_t& a ) { a = ser_readdata32(s); }
 188 template<typename Stream> inline void Unserialize(Stream& s, uint32_t& a) { a = ser_readdata32(s); }
 189 template<typename Stream> inline void Unserialize(Stream& s, int64_t& a ) { a = ser_readdata64(s); }
 190 template<typename Stream> inline void Unserialize(Stream& s, uint64_t& a) { a = ser_readdata64(s); }
 191 template<typename Stream> inline void Unserialize(Stream& s, float& a   ) { a = ser_uint32_to_float(ser_readdata32(s)); }
 192 template<typename Stream> inline void Unserialize(Stream& s, double& a  ) { a = ser_uint64_to_double(ser_readdata64(s)); }
 193
 194 template<typename Stream> inline void Serialize(Stream& s, bool a)    { char f=a; ser_writedata8(s, f); }
 195 template<typename Stream> inline void Unserialize(Stream& s, bool& a) { char f=ser_readdata8(s); a=f; }
 196
 197
 198
 199
 200
 201
 202 /**
 203  * Compact Size
 204  * size <  253        -- 1 byte
 205  * size <= USHRT_MAX  -- 3 bytes  (253 + 2 bytes)
 206  * size <= UINT_MAX   -- 5 bytes  (254 + 4 bytes)
 207  * size >  UINT_MAX   -- 9 bytes  (255 + 8 bytes)
 208  */
 209 inline unsigned int GetSizeOfCompactSize(uint64_t nSize)
 210 {
 211     if (nSize < 253)             return sizeof(unsigned char);
 212     else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
 213     else if (nSize <= std::numeric_limits<unsigned int>::max())  return sizeof(unsigned char) + sizeof(unsigned int);
 214     else                         return sizeof(unsigned char) + sizeof(uint64_t);
 215 }
 216
 217 inline void WriteCompactSize(CSizeComputer& os, uint64_t nSize);
 218
 219 template<typename Stream>
 220 void WriteCompactSize(Stream& os, uint64_t nSize)
 221 {
 222     if (nSize < 253)
 223     {
 224         ser_writedata8(os, nSize);
 225     }
 226     else if (nSize <= std::numeric_limits<unsigned short>::max())
 227     {
 228         ser_writedata8(os, 253);
 229         ser_writedata16(os, nSize);
 230     }
 231     else if (nSize <= std::numeric_limits<unsigned int>::max())
 232     {
 233         ser_writedata8(os, 254);
 234         ser_writedata32(os, nSize);
 235     }
 236     else
 237     {
 238         ser_writedata8(os, 255);
 239         ser_writedata64(os, nSize);
 240     }
 241     return;
 242 }
 243
 244 template<typename Stream>
 245 uint64_t ReadCompactSize(Stream& is)
 246 {
 247     uint8_t chSize = ser_readdata8(is);
 248     uint64_t nSizeRet = 0;
 249     if (chSize < 253)
 250     {
 251         nSizeRet = chSize;
 252     }
 253     else if (chSize == 253)
 254     {
 255         nSizeRet = ser_readdata16(is);
 256         if (nSizeRet < 253)
 257             throw std::ios_base::failure("non-canonical ReadCompactSize()");
 258     }
 259     else if (chSize == 254)
 260     {
 261         nSizeRet = ser_readdata32(is);
 262         if (nSizeRet < 0x10000u)
 263             throw std::ios_base::failure("non-canonical ReadCompactSize()");
 264     }
 265     else
 266     {
 267         nSizeRet = ser_readdata64(is);
 268         if (nSizeRet < 0x100000000ULL)
 269             throw std::ios_base::failure("non-canonical ReadCompactSize()");
 270     }
 271     if (nSizeRet > (uint64_t)MAX_SIZE)
 272         throw std::ios_base::failure("ReadCompactSize(): size too large");
 273     return nSizeRet;
 274 }
 275
 276 /**
 277  * Variable-length integers: bytes are a MSB base-128 encoding of the number.
 278  * The high bit in each byte signifies whether another digit follows. To make
 279  * sure the encoding is one-to-one, one is subtracted from all but the last digit.
 280  * Thus, the byte sequence a[] with length len, where all but the last byte
 281  * has bit 128 set, encodes the number:
 282  *
 283  *  (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))
 284  *
 285  * Properties:
 286  * * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
 287  * * Every integer has exactly one encoding
 288  * * Encoding does not depend on size of original integer type
 289  * * No redundancy: every (infinite) byte sequence corresponds to a list
 290  *   of encoded integers.
 291  *
 292  * 0:         [0x00]  256:        [0x81 0x00]
 293  * 1:         [0x01]  16383:      [0xFE 0x7F]
 294  * 127:       [0x7F]  16384:      [0xFF 0x00]
 295  * 128:  [0x80 0x00]  16511:      [0xFF 0x7F]
 296  * 255:  [0x80 0x7F]  65535: [0x82 0xFE 0x7F]
 297  * 2^32:           [0x8E 0xFE 0xFE 0xFF 0x00]
 298  */
 299
 300 template<typename I>
 301 inline unsigned int GetSizeOfVarInt(I n)
 302 {
 303     int nRet = 0;
 304     while(true) {
 305         nRet++;
 306         if (n <= 0x7F)
 307             break;
 308         n = (n >> 7) - 1;
 309     }
 310     return nRet;
 311 }
 312
 313 template<typename I>
 314 inline void WriteVarInt(CSizeComputer& os, I n);
 315
 316 template<typename Stream, typename I>
 317 void WriteVarInt(Stream& os, I n)
 318 {
 319     unsigned char tmp[(sizeof(n)*8+6)/7];
 320     int len=0;
 321     while(true) {
 322         tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00);
 323         if (n <= 0x7F)
 324             break;
 325         n = (n >> 7) - 1;
 326         len++;
 327     }
 328     do {
 329         ser_writedata8(os, tmp[len]);
 330     } while(len--);
 331 }
 332
 333 template<typename Stream, typename I>
 334 I ReadVarInt(Stream& is)
 335 {
 336     I n = 0;
 337     while(true) {
 338         unsigned char chData = ser_readdata8(is);
 339         if (n > (std::numeric_limits<I>::max() >> 7)) {
 340            throw std::ios_base::failure("ReadVarInt(): size too large");
 341         }
 342         n = (n << 7) | (chData & 0x7F);
 343         if (chData & 0x80) {
 344             if (n == std::numeric_limits<I>::max()) {
 345                 throw std::ios_base::failure("ReadVarInt(): size too large");
 346             }
 347             n++;
 348         } else {
 349             return n;
 350         }
 351     }
 352 }
 353
 354 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
 355 #define VARINT(obj) REF(WrapVarInt(REF(obj)))
 356 #define COMPACTSIZE(obj) REF(CCompactSize(REF(obj)))
 357 #define LIMITED_STRING(obj,n) REF(LimitedString< n >(REF(obj)))
 358
 359 /**
 360  * Wrapper for serializing arrays and POD.
 361  */
 362 class CFlatData
 363 {
 364 protected:
 365     char* pbegin;
 366     char* pend;
 367 public:
 368     CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
 369     template <class T, class TAl>
 370     explicit CFlatData(std::vector<T,TAl> &v)
 371     {
 372         pbegin = (char*)v.data();
 373         pend = (char*)(v.data() + v.size());
 374     }
 375     template <unsigned int N, typename T, typename S, typename D>
 376     explicit CFlatData(prevector<N, T, S, D> &v)
 377     {
 378         pbegin = (char*)v.data();
 379         pend = (char*)(v.data() + v.size());
 380     }
 381     char* begin() { return pbegin; }
 382     const char* begin() const { return pbegin; }
 383     char* end() { return pend; }
 384     const char* end() const { return pend; }
 385
 386     template<typename Stream>
 387     void Serialize(Stream& s) const
 388     {
 389         s.write(pbegin, pend - pbegin);
 390     }
 391
 392     template<typename Stream>
 393     void Unserialize(Stream& s)
 394     {
 395         s.read(pbegin, pend - pbegin);
 396     }
 397 };
 398
 399 template<typename I>
 400 class CVarInt
 401 {
 402 protected:
 403     I &n;
 404 public:
 405     explicit CVarInt(I& nIn) : n(nIn) { }
 406
 407     template<typename Stream>
 408     void Serialize(Stream &s) const {
 409         WriteVarInt<Stream,I>(s, n);
 410     }
 411
 412     template<typename Stream>
 413     void Unserialize(Stream& s) {
 414         n = ReadVarInt<Stream,I>(s);
 415     }
 416 };
 417
 418 class CCompactSize
 419 {
 420 protected:
 421     uint64_t &n;
 422 public:
 423     explicit CCompactSize(uint64_t& nIn) : n(nIn) { }
 424
 425     template<typename Stream>
 426     void Serialize(Stream &s) const {
 427         WriteCompactSize<Stream>(s, n);
 428     }
 429
 430     template<typename Stream>
 431     void Unserialize(Stream& s) {
 432         n = ReadCompactSize<Stream>(s);
 433     }
 434 };
 435
 436 template<size_t Limit>
 437 class LimitedString
 438 {
 439 protected:
 440     std::string& string;
 441 public:
 442     explicit LimitedString(std::string& _string) : string(_string) {}
 443
 444     template<typename Stream>
 445     void Unserialize(Stream& s)
 446     {
 447         size_t size = ReadCompactSize(s);
 448         if (size > Limit) {
 449             throw std::ios_base::failure("String length limit exceeded");
 450         }
 451         string.resize(size);
 452         if (size != 0)
 453             s.read((char*)string.data(), size);
 454     }
 455
 456     template<typename Stream>
 457     void Serialize(Stream& s) const
 458     {
 459         WriteCompactSize(s, string.size());
 460         if (!string.empty())
 461             s.write((char*)string.data(), string.size());
 462     }
 463 };
 464
 465 template<typename I>
 466 CVarInt<I> WrapVarInt(I& n) { return CVarInt<I>(n); }
 467
 468 /**
 469  * Forward declarations
 470  */
 471
 472 /**
 473  *  string
 474  */
 475 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str);
 476 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str);
 477
 478 /**
 479  * prevector
 480  * prevectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.
 481  */
 482 template<typename Stream, unsigned int N, typename T> void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&);
 483 template<typename Stream, unsigned int N, typename T, typename V> void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&);
 484 template<typename Stream, unsigned int N, typename T> inline void Serialize(Stream& os, const prevector<N, T>& v);
 485 template<typename Stream, unsigned int N, typename T> void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&);
 486 template<typename Stream, unsigned int N, typename T, typename V> void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&);
 487 template<typename Stream, unsigned int N, typename T> inline void Unserialize(Stream& is, prevector<N, T>& v);
 488
 489 /**
 490  * vector
 491  * vectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.
 492  */
 493 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&);
 494 template<typename Stream, typename T, typename A, typename V> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&);
 495 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v);
 496 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&);
 497 template<typename Stream, typename T, typename A, typename V> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&);
 498 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v);
 499
 500 /**
 501  * pair
 502  */
 503 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item);
 504 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item);
 505
 506 /**
 507  * map
 508  */
 509 template<typename Stream, typename K, typename T, typename Pred, typename A> void Serialize(Stream& os, const std::map<K, T, Pred, A>& m);
 510 template<typename Stream, typename K, typename T, typename Pred, typename A> void Unserialize(Stream& is, std::map<K, T, Pred, A>& m);
 511
 512 /**
 513  * set
 514  */
 515 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m);
 516 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m);
 517
 518 /**
 519  * shared_ptr
 520  */
 521 template<typename Stream, typename T> void Serialize(Stream& os, const std::shared_ptr<const T>& p);
 522 template<typename Stream, typename T> void Unserialize(Stream& os, std::shared_ptr<const T>& p);
 523
 524 /**
 525  * unique_ptr
 526  */
 527 template<typename Stream, typename T> void Serialize(Stream& os, const std::unique_ptr<const T>& p);
 528 template<typename Stream, typename T> void Unserialize(Stream& os, std::unique_ptr<const T>& p);
 529
 530
 531
 532 /**
 533  * If none of the specialized versions above matched, default to calling member function.
 534  */
 535 template<typename Stream, typename T>
 536 inline void Serialize(Stream& os, const T& a)
 537 {
 538     a.Serialize(os);
 539 }
 540
 541 template<typename Stream, typename T>
 542 inline void Unserialize(Stream& is, T& a)
 543 {
 544     a.Unserialize(is);
 545 }
 546
 547
 548
 549
 550
 551 /**
 552  * string
 553  */
 554 template<typename Stream, typename C>
 555 void Serialize(Stream& os, const std::basic_string<C>& str)
 556 {
 557     WriteCompactSize(os, str.size());
 558     if (!str.empty())
 559         os.write((char*)str.data(), str.size() * sizeof(C));
 560 }
 561
 562 template<typename Stream, typename C>
 563 void Unserialize(Stream& is, std::basic_string<C>& str)
 564 {
 565     unsigned int nSize = ReadCompactSize(is);
 566     str.resize(nSize);
 567     if (nSize != 0)
 568         is.read((char*)str.data(), nSize * sizeof(C));
 569 }
 570
 571
 572
 573 /**
 574  * prevector
 575  */
 576 template<typename Stream, unsigned int N, typename T>
 577 void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&)
 578 {
 579     WriteCompactSize(os, v.size());
 580     if (!v.empty())
 581         os.write((char*)v.data(), v.size() * sizeof(T));
 582 }
 583
 584 template<typename Stream, unsigned int N, typename T, typename V>
 585 void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&)
 586 {
 587     WriteCompactSize(os, v.size());
 588     for (typename prevector<N, T>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
 589         ::Serialize(os, (*vi));
 590 }
 591
 592 template<typename Stream, unsigned int N, typename T>
 593 inline void Serialize(Stream& os, const prevector<N, T>& v)
 594 {
 595     Serialize_impl(os, v, T());
 596 }
 597
 598
 599 template<typename Stream, unsigned int N, typename T>
 600 void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&)
 601 {
 602     // Limit size per read so bogus size value won't cause out of memory
 603     v.clear();
 604     unsigned int nSize = ReadCompactSize(is);
 605     unsigned int i = 0;
 606     while (i < nSize)
 607     {
 608         unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
 609         v.resize(i + blk);
 610         is.read((char*)&v[i], blk * sizeof(T));
 611         i += blk;
 612     }
 613 }
 614
 615 template<typename Stream, unsigned int N, typename T, typename V>
 616 void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&)
 617 {
 618     v.clear();
 619     unsigned int nSize = ReadCompactSize(is);
 620     unsigned int i = 0;
 621     unsigned int nMid = 0;
 622     while (nMid < nSize)
 623     {
 624         nMid += 5000000 / sizeof(T);
 625         if (nMid > nSize)
 626             nMid = nSize;
 627         v.resize(nMid);
 628         for (; i < nMid; i++)
 629             Unserialize(is, v[i]);
 630     }
 631 }
 632
 633 template<typename Stream, unsigned int N, typename T>
 634 inline void Unserialize(Stream& is, prevector<N, T>& v)
 635 {
 636     Unserialize_impl(is, v, T());
 637 }
 638
 639
 640
 641 /**
 642  * vector
 643  */
 644 template<typename Stream, typename T, typename A>
 645 void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&)
 646 {
 647     WriteCompactSize(os, v.size());
 648     if (!v.empty())
 649         os.write((char*)v.data(), v.size() * sizeof(T));
 650 }
 651
 652 template<typename Stream, typename T, typename A, typename V>
 653 void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&)
 654 {
 655     WriteCompactSize(os, v.size());
 656     for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
 657         ::Serialize(os, (*vi));
 658 }
 659
 660 template<typename Stream, typename T, typename A>
 661 inline void Serialize(Stream& os, const std::vector<T, A>& v)
 662 {
 663     Serialize_impl(os, v, T());
 664 }
 665
 666
 667 template<typename Stream, typename T, typename A>
 668 void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&)
 669 {
 670     // Limit size per read so bogus size value won't cause out of memory
 671     v.clear();
 672     unsigned int nSize = ReadCompactSize(is);
 673     unsigned int i = 0;
 674     while (i < nSize)
 675     {
 676         unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
 677         v.resize(i + blk);
 678         is.read((char*)&v[i], blk * sizeof(T));
 679         i += blk;
 680     }
 681 }
 682
 683 template<typename Stream, typename T, typename A, typename V>
 684 void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&)
 685 {
 686     v.clear();
 687     unsigned int nSize = ReadCompactSize(is);
 688     unsigned int i = 0;
 689     unsigned int nMid = 0;
 690     while (nMid < nSize)
 691     {
 692         nMid += 5000000 / sizeof(T);
 693         if (nMid > nSize)
 694             nMid = nSize;
 695         v.resize(nMid);
 696         for (; i < nMid; i++)
 697             Unserialize(is, v[i]);
 698     }
 699 }
 700
 701 template<typename Stream, typename T, typename A>
 702 inline void Unserialize(Stream& is, std::vector<T, A>& v)
 703 {
 704     Unserialize_impl(is, v, T());
 705 }
 706
 707
 708
 709 /**
 710  * pair
 711  */
 712 template<typename Stream, typename K, typename T>
 713 void Serialize(Stream& os, const std::pair<K, T>& item)
 714 {
 715     Serialize(os, item.first);
 716     Serialize(os, item.second);
 717 }
 718
 719 template<typename Stream, typename K, typename T>
 720 void Unserialize(Stream& is, std::pair<K, T>& item)
 721 {
 722     Unserialize(is, item.first);
 723     Unserialize(is, item.second);
 724 }
 725
 726
 727
 728 /**
 729  * map
 730  */
 731 template<typename Stream, typename K, typename T, typename Pred, typename A>
 732 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m)
 733 {
 734     WriteCompactSize(os, m.size());
 735     for (const auto& entry : m)
 736         Serialize(os, entry);
 737 }
 738
 739 template<typename Stream, typename K, typename T, typename Pred, typename A>
 740 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m)
 741 {
 742     m.clear();
 743     unsigned int nSize = ReadCompactSize(is);
 744     typename std::map<K, T, Pred, A>::iterator mi = m.begin();
 745     for (unsigned int i = 0; i < nSize; i++)
 746     {
 747         std::pair<K, T> item;
 748         Unserialize(is, item);
 749         mi = m.insert(mi, item);
 750     }
 751 }
 752
 753
 754
 755 /**
 756  * set
 757  */
 758 template<typename Stream, typename K, typename Pred, typename A>
 759 void Serialize(Stream& os, const std::set<K, Pred, A>& m)
 760 {
 761     WriteCompactSize(os, m.size());
 762     for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
 763         Serialize(os, (*it));
 764 }
 765
 766 template<typename Stream, typename K, typename Pred, typename A>
 767 void Unserialize(Stream& is, std::set<K, Pred, A>& m)
 768 {
 769     m.clear();
 770     unsigned int nSize = ReadCompactSize(is);
 771     typename std::set<K, Pred, A>::iterator it = m.begin();
 772     for (unsigned int i = 0; i < nSize; i++)
 773     {
 774         K key;
 775         Unserialize(is, key);
 776         it = m.insert(it, key);
 777     }
 778 }
 779
 780
 781
 782 /**
 783  * unique_ptr
 784  */
 785 template<typename Stream, typename T> void
 786 Serialize(Stream& os, const std::unique_ptr<const T>& p)
 787 {
 788     Serialize(os, *p);
 789 }
 790
 791 template<typename Stream, typename T>
 792 void Unserialize(Stream& is, std::unique_ptr<const T>& p)
 793 {
 794     p.reset(new T(deserialize, is));
 795 }
 796
 797
 798
 799 /**
 800  * shared_ptr
 801  */
 802 template<typename Stream, typename T> void
 803 Serialize(Stream& os, const std::shared_ptr<const T>& p)
 804 {
 805     Serialize(os, *p);
 806 }
 807
 808 template<typename Stream, typename T>
 809 void Unserialize(Stream& is, std::shared_ptr<const T>& p)
 810 {
 811     p = std::make_shared<const T>(deserialize, is);
 812 }
 813
 814
 815
 816 /**
 817  * Support for ADD_SERIALIZE_METHODS and READWRITE macro
 818  */
 819 struct CSerActionSerialize
 820 {
 821     constexpr bool ForRead() const { return false; }
 822 };
 823 struct CSerActionUnserialize
 824 {
 825     constexpr bool ForRead() const { return true; }
 826 };
 827
 828 template<typename Stream, typename T>
 829 inline void SerReadWrite(Stream& s, const T& obj, CSerActionSerialize ser_action)
 830 {
 831     ::Serialize(s, obj);
 832 }
 833
 834 template<typename Stream, typename T>
 835 inline void SerReadWrite(Stream& s, T& obj, CSerActionUnserialize ser_action)
 836 {
 837     ::Unserialize(s, obj);
 838 }
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848 /* ::GetSerializeSize implementations
 849  *
 850  * Computing the serialized size of objects is done through a special stream
 851  * object of type CSizeComputer, which only records the number of bytes written
 852  * to it.
 853  *
 854  * If your Serialize or SerializationOp method has non-trivial overhead for
 855  * serialization, it may be worthwhile to implement a specialized version for
 856  * CSizeComputer, which uses the s.seek() method to record bytes that would
 857  * be written instead.
 858  */
 859 class CSizeComputer
 860 {
 861 protected:
 862     size_t nSize;
 863
 864     const int nType;
 865     const int nVersion;
 866 public:
 867     CSizeComputer(int nTypeIn, int nVersionIn) : nSize(0), nType(nTypeIn), nVersion(nVersionIn) {}
 868
 869     void write(const char *psz, size_t _nSize)
 870     {
 871         this->nSize += _nSize;
 872     }
 873
 874     /** Pretend _nSize bytes are written, without specifying them. */
 875     void seek(size_t _nSize)
 876     {
 877         this->nSize += _nSize;
 878     }
 879
 880     template<typename T>
 881     CSizeComputer& operator<<(const T& obj)
 882     {
 883         ::Serialize(*this, obj);
 884         return (*this);
 885     }
 886
 887     size_t size() const {
 888         return nSize;
 889     }
 890
 891     int GetVersion() const { return nVersion; }
 892     int GetType() const { return nType; }
 893 };
 894
 895 template<typename Stream>
 896 void SerializeMany(Stream& s)
 897 {
 898 }
 899
 900 template<typename Stream, typename Arg>
 901 void SerializeMany(Stream& s, Arg&& arg)
 902 {
 903     ::Serialize(s, std::forward<Arg>(arg));
 904 }
 905
 906 template<typename Stream, typename Arg, typename... Args>
 907 void SerializeMany(Stream& s, Arg&& arg, Args&&... args)
 908 {
 909     ::Serialize(s, std::forward<Arg>(arg));
 910     ::SerializeMany(s, std::forward<Args>(args)...);
 911 }
 912
 913 template<typename Stream>
 914 inline void UnserializeMany(Stream& s)
 915 {
 916 }
 917
 918 template<typename Stream, typename Arg>
 919 inline void UnserializeMany(Stream& s, Arg& arg)
 920 {
 921     ::Unserialize(s, arg);
 922 }
 923
 924 template<typename Stream, typename Arg, typename... Args>
 925 inline void UnserializeMany(Stream& s, Arg& arg, Args&... args)
 926 {
 927     ::Unserialize(s, arg);
 928     ::UnserializeMany(s, args...);
 929 }
 930
 931 template<typename Stream, typename... Args>
 932 inline void SerReadWriteMany(Stream& s, CSerActionSerialize ser_action, Args&&... args)
 933 {
 934     ::SerializeMany(s, std::forward<Args>(args)...);
 935 }
 936
 937 template<typename Stream, typename... Args>
 938 inline void SerReadWriteMany(Stream& s, CSerActionUnserialize ser_action, Args&... args)
 939 {
 940     ::UnserializeMany(s, args...);
 941 }
 942
 943 template<typename I>
 944 inline void WriteVarInt(CSizeComputer &s, I n)
 945 {
 946     s.seek(GetSizeOfVarInt<I>(n));
 947 }
 948
 949 inline void WriteCompactSize(CSizeComputer &s, uint64_t nSize)
 950 {
 951     s.seek(GetSizeOfCompactSize(nSize));
 952 }
 953
 954 template <typename T>
 955 size_t GetSerializeSize(const T& t, int nType, int nVersion = 0)
 956 {
 957     return (CSizeComputer(nType, nVersion) << t).size();
 958 }
 959
 960 template <typename S, typename T>
 961 size_t GetSerializeSize(const S& s, const T& t)
 962 {
 963     return (CSizeComputer(s.GetType(), s.GetVersion()) << t).size();
 964 }
 965
 966 #endif // BITCOIN_SERIALIZE_H