Dogecoin Core  1.14.2
P2P Digital Currency
serialize.h
Go to the documentation of this file.
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 
39 struct deserialize_type {};
41 
46 template<typename T>
47 inline T& REF(const T& val)
48 {
49  return const_cast<T&>(val);
50 }
51 
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 
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 
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 
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 
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  n = (n << 7) | (chData & 0x7F);
340  if (chData & 0x80)
341  n++;
342  else
343  return n;
344  }
345 }
346 
347 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
348 #define VARINT(obj) REF(WrapVarInt(REF(obj)))
349 #define COMPACTSIZE(obj) REF(CCompactSize(REF(obj)))
350 #define LIMITED_STRING(obj,n) REF(LimitedString< n >(REF(obj)))
351 
356 {
357 protected:
358  char* pbegin;
359  char* pend;
360 public:
361  CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
362  template <class T, class TAl>
363  explicit CFlatData(std::vector<T,TAl> &v)
364  {
365  pbegin = (char*)v.data();
366  pend = (char*)(v.data() + v.size());
367  }
368  template <unsigned int N, typename T, typename S, typename D>
370  {
371  pbegin = (char*)v.data();
372  pend = (char*)(v.data() + v.size());
373  }
374  char* begin() { return pbegin; }
375  const char* begin() const { return pbegin; }
376  char* end() { return pend; }
377  const char* end() const { return pend; }
378 
379  template<typename Stream>
380  void Serialize(Stream& s) const
381  {
382  s.write(pbegin, pend - pbegin);
383  }
384 
385  template<typename Stream>
386  void Unserialize(Stream& s)
387  {
388  s.read(pbegin, pend - pbegin);
389  }
390 };
391 
392 template<typename I>
393 class CVarInt
394 {
395 protected:
396  I &n;
397 public:
398  CVarInt(I& nIn) : n(nIn) { }
399 
400  template<typename Stream>
401  void Serialize(Stream &s) const {
402  WriteVarInt<Stream,I>(s, n);
403  }
404 
405  template<typename Stream>
406  void Unserialize(Stream& s) {
407  n = ReadVarInt<Stream,I>(s);
408  }
409 };
410 
412 {
413 protected:
414  uint64_t &n;
415 public:
416  CCompactSize(uint64_t& nIn) : n(nIn) { }
417 
418  template<typename Stream>
419  void Serialize(Stream &s) const {
420  WriteCompactSize<Stream>(s, n);
421  }
422 
423  template<typename Stream>
424  void Unserialize(Stream& s) {
425  n = ReadCompactSize<Stream>(s);
426  }
427 };
428 
429 template<size_t Limit>
431 {
432 protected:
433  std::string& string;
434 public:
435  LimitedString(std::string& _string) : string(_string) {}
436 
437  template<typename Stream>
438  void Unserialize(Stream& s)
439  {
440  size_t size = ReadCompactSize(s);
441  if (size > Limit) {
442  throw std::ios_base::failure("String length limit exceeded");
443  }
444  string.resize(size);
445  if (size != 0)
446  s.read((char*)&string[0], size);
447  }
448 
449  template<typename Stream>
450  void Serialize(Stream& s) const
451  {
452  WriteCompactSize(s, string.size());
453  if (!string.empty())
454  s.write((char*)&string[0], string.size());
455  }
456 };
457 
458 template<typename I>
459 CVarInt<I> WrapVarInt(I& n) { return CVarInt<I>(n); }
460 
468 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str);
469 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str);
470 
475 template<typename Stream, unsigned int N, typename T> void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&);
476 template<typename Stream, unsigned int N, typename T, typename V> void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&);
477 template<typename Stream, unsigned int N, typename T> inline void Serialize(Stream& os, const prevector<N, T>& v);
478 template<typename Stream, unsigned int N, typename T> void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&);
479 template<typename Stream, unsigned int N, typename T, typename V> void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&);
480 template<typename Stream, unsigned int N, typename T> inline void Unserialize(Stream& is, prevector<N, T>& v);
481 
486 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&);
487 template<typename Stream, typename T, typename A, typename V> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&);
488 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v);
489 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&);
490 template<typename Stream, typename T, typename A, typename V> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&);
491 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v);
492 
496 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item);
497 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item);
498 
502 template<typename Stream, typename K, typename T, typename Pred, typename A> void Serialize(Stream& os, const std::map<K, T, Pred, A>& m);
503 template<typename Stream, typename K, typename T, typename Pred, typename A> void Unserialize(Stream& is, std::map<K, T, Pred, A>& m);
504 
508 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m);
509 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m);
510 
514 template<typename Stream, typename T> void Serialize(Stream& os, const std::shared_ptr<const T>& p);
515 template<typename Stream, typename T> void Unserialize(Stream& os, std::shared_ptr<const T>& p);
516 
520 template<typename Stream, typename T> void Serialize(Stream& os, const std::unique_ptr<const T>& p);
521 template<typename Stream, typename T> void Unserialize(Stream& os, std::unique_ptr<const T>& p);
522 
523 
524 
528 template<typename Stream, typename T>
529 inline void Serialize(Stream& os, const T& a)
530 {
531  a.Serialize(os);
532 }
533 
534 template<typename Stream, typename T>
535 inline void Unserialize(Stream& is, T& a)
536 {
537  a.Unserialize(is);
538 }
539 
540 
541 
542 
543 
547 template<typename Stream, typename C>
548 void Serialize(Stream& os, const std::basic_string<C>& str)
549 {
550  WriteCompactSize(os, str.size());
551  if (!str.empty())
552  os.write((char*)&str[0], str.size() * sizeof(str[0]));
553 }
554 
555 template<typename Stream, typename C>
556 void Unserialize(Stream& is, std::basic_string<C>& str)
557 {
558  unsigned int nSize = ReadCompactSize(is);
559  str.resize(nSize);
560  if (nSize != 0)
561  is.read((char*)&str[0], nSize * sizeof(str[0]));
562 }
563 
564 
565 
569 template<typename Stream, unsigned int N, typename T>
570 void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&)
571 {
572  WriteCompactSize(os, v.size());
573  if (!v.empty())
574  os.write((char*)&v[0], v.size() * sizeof(T));
575 }
576 
577 template<typename Stream, unsigned int N, typename T, typename V>
578 void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&)
579 {
580  WriteCompactSize(os, v.size());
581  for (typename prevector<N, T>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
582  ::Serialize(os, (*vi));
583 }
584 
585 template<typename Stream, unsigned int N, typename T>
586 inline void Serialize(Stream& os, const prevector<N, T>& v)
587 {
588  Serialize_impl(os, v, T());
589 }
590 
591 
592 template<typename Stream, unsigned int N, typename T>
593 void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&)
594 {
595  // Limit size per read so bogus size value won't cause out of memory
596  v.clear();
597  unsigned int nSize = ReadCompactSize(is);
598  unsigned int i = 0;
599  while (i < nSize)
600  {
601  unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
602  v.resize(i + blk);
603  is.read((char*)&v[i], blk * sizeof(T));
604  i += blk;
605  }
606 }
607 
608 template<typename Stream, unsigned int N, typename T, typename V>
609 void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&)
610 {
611  v.clear();
612  unsigned int nSize = ReadCompactSize(is);
613  unsigned int i = 0;
614  unsigned int nMid = 0;
615  while (nMid < nSize)
616  {
617  nMid += 5000000 / sizeof(T);
618  if (nMid > nSize)
619  nMid = nSize;
620  v.resize(nMid);
621  for (; i < nMid; i++)
622  Unserialize(is, v[i]);
623  }
624 }
625 
626 template<typename Stream, unsigned int N, typename T>
627 inline void Unserialize(Stream& is, prevector<N, T>& v)
628 {
629  Unserialize_impl(is, v, T());
630 }
631 
632 
633 
637 template<typename Stream, typename T, typename A>
638 void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&)
639 {
640  WriteCompactSize(os, v.size());
641  if (!v.empty())
642  os.write((char*)&v[0], v.size() * sizeof(T));
643 }
644 
645 template<typename Stream, typename T, typename A, typename V>
646 void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&)
647 {
648  WriteCompactSize(os, v.size());
649  for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
650  ::Serialize(os, (*vi));
651 }
652 
653 template<typename Stream, typename T, typename A>
654 inline void Serialize(Stream& os, const std::vector<T, A>& v)
655 {
656  Serialize_impl(os, v, T());
657 }
658 
659 
660 template<typename Stream, typename T, typename A>
661 void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&)
662 {
663  // Limit size per read so bogus size value won't cause out of memory
664  v.clear();
665  unsigned int nSize = ReadCompactSize(is);
666  unsigned int i = 0;
667  while (i < nSize)
668  {
669  unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
670  v.resize(i + blk);
671  is.read((char*)&v[i], blk * sizeof(T));
672  i += blk;
673  }
674 }
675 
676 template<typename Stream, typename T, typename A, typename V>
677 void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&)
678 {
679  v.clear();
680  unsigned int nSize = ReadCompactSize(is);
681  unsigned int i = 0;
682  unsigned int nMid = 0;
683  while (nMid < nSize)
684  {
685  nMid += 5000000 / sizeof(T);
686  if (nMid > nSize)
687  nMid = nSize;
688  v.resize(nMid);
689  for (; i < nMid; i++)
690  Unserialize(is, v[i]);
691  }
692 }
693 
694 template<typename Stream, typename T, typename A>
695 inline void Unserialize(Stream& is, std::vector<T, A>& v)
696 {
697  Unserialize_impl(is, v, T());
698 }
699 
700 
701 
705 template<typename Stream, typename K, typename T>
706 void Serialize(Stream& os, const std::pair<K, T>& item)
707 {
708  Serialize(os, item.first);
709  Serialize(os, item.second);
710 }
711 
712 template<typename Stream, typename K, typename T>
713 void Unserialize(Stream& is, std::pair<K, T>& item)
714 {
715  Unserialize(is, item.first);
716  Unserialize(is, item.second);
717 }
718 
719 
720 
724 template<typename Stream, typename K, typename T, typename Pred, typename A>
725 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m)
726 {
727  WriteCompactSize(os, m.size());
728  for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
729  Serialize(os, (*mi));
730 }
731 
732 template<typename Stream, typename K, typename T, typename Pred, typename A>
733 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m)
734 {
735  m.clear();
736  unsigned int nSize = ReadCompactSize(is);
737  typename std::map<K, T, Pred, A>::iterator mi = m.begin();
738  for (unsigned int i = 0; i < nSize; i++)
739  {
740  std::pair<K, T> item;
741  Unserialize(is, item);
742  mi = m.insert(mi, item);
743  }
744 }
745 
746 
747 
751 template<typename Stream, typename K, typename Pred, typename A>
752 void Serialize(Stream& os, const std::set<K, Pred, A>& m)
753 {
754  WriteCompactSize(os, m.size());
755  for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
756  Serialize(os, (*it));
757 }
758 
759 template<typename Stream, typename K, typename Pred, typename A>
760 void Unserialize(Stream& is, std::set<K, Pred, A>& m)
761 {
762  m.clear();
763  unsigned int nSize = ReadCompactSize(is);
764  typename std::set<K, Pred, A>::iterator it = m.begin();
765  for (unsigned int i = 0; i < nSize; i++)
766  {
767  K key;
768  Unserialize(is, key);
769  it = m.insert(it, key);
770  }
771 }
772 
773 
774 
778 template<typename Stream, typename T> void
779 Serialize(Stream& os, const std::unique_ptr<const T>& p)
780 {
781  Serialize(os, *p);
782 }
783 
784 template<typename Stream, typename T>
785 void Unserialize(Stream& is, std::unique_ptr<const T>& p)
786 {
787  p.reset(new T(deserialize, is));
788 }
789 
790 
791 
795 template<typename Stream, typename T> void
796 Serialize(Stream& os, const std::shared_ptr<const T>& p)
797 {
798  Serialize(os, *p);
799 }
800 
801 template<typename Stream, typename T>
802 void Unserialize(Stream& is, std::shared_ptr<const T>& p)
803 {
804  p = std::make_shared<const T>(deserialize, is);
805 }
806 
807 
808 
813 {
814  constexpr bool ForRead() const { return false; }
815 };
817 {
818  constexpr bool ForRead() const { return true; }
819 };
820 
821 template<typename Stream, typename T>
822 inline void SerReadWrite(Stream& s, const T& obj, CSerActionSerialize ser_action)
823 {
824  ::Serialize(s, obj);
825 }
826 
827 template<typename Stream, typename T>
828 inline void SerReadWrite(Stream& s, T& obj, CSerActionUnserialize ser_action)
829 {
830  ::Unserialize(s, obj);
831 }
832 
833 
834 
835 
836 
837 
838 
839 
840 
841 /* ::GetSerializeSize implementations
842  *
843  * Computing the serialized size of objects is done through a special stream
844  * object of type CSizeComputer, which only records the number of bytes written
845  * to it.
846  *
847  * If your Serialize or SerializationOp method has non-trivial overhead for
848  * serialization, it may be worthwhile to implement a specialized version for
849  * CSizeComputer, which uses the s.seek() method to record bytes that would
850  * be written instead.
851  */
853 {
854 protected:
855  size_t nSize;
856 
857  const int nType;
858  const int nVersion;
859 public:
860  CSizeComputer(int nTypeIn, int nVersionIn) : nSize(0), nType(nTypeIn), nVersion(nVersionIn) {}
861 
862  void write(const char *psz, size_t _nSize)
863  {
864  this->nSize += _nSize;
865  }
866 
868  void seek(size_t _nSize)
869  {
870  this->nSize += _nSize;
871  }
872 
873  template<typename T>
874  CSizeComputer& operator<<(const T& obj)
875  {
876  ::Serialize(*this, obj);
877  return (*this);
878  }
879 
880  size_t size() const {
881  return nSize;
882  }
883 
884  int GetVersion() const { return nVersion; }
885  int GetType() const { return nType; }
886 };
887 
888 template<typename Stream>
889 void SerializeMany(Stream& s)
890 {
891 }
892 
893 template<typename Stream, typename Arg>
894 void SerializeMany(Stream& s, Arg&& arg)
895 {
896  ::Serialize(s, std::forward<Arg>(arg));
897 }
898 
899 template<typename Stream, typename Arg, typename... Args>
900 void SerializeMany(Stream& s, Arg&& arg, Args&&... args)
901 {
902  ::Serialize(s, std::forward<Arg>(arg));
903  ::SerializeMany(s, std::forward<Args>(args)...);
904 }
905 
906 template<typename Stream>
907 inline void UnserializeMany(Stream& s)
908 {
909 }
910 
911 template<typename Stream, typename Arg>
912 inline void UnserializeMany(Stream& s, Arg& arg)
913 {
914  ::Unserialize(s, arg);
915 }
916 
917 template<typename Stream, typename Arg, typename... Args>
918 inline void UnserializeMany(Stream& s, Arg& arg, Args&... args)
919 {
920  ::Unserialize(s, arg);
921  ::UnserializeMany(s, args...);
922 }
923 
924 template<typename Stream, typename... Args>
925 inline void SerReadWriteMany(Stream& s, CSerActionSerialize ser_action, Args&&... args)
926 {
927  ::SerializeMany(s, std::forward<Args>(args)...);
928 }
929 
930 template<typename Stream, typename... Args>
931 inline void SerReadWriteMany(Stream& s, CSerActionUnserialize ser_action, Args&... args)
932 {
933  ::UnserializeMany(s, args...);
934 }
935 
936 template<typename I>
937 inline void WriteVarInt(CSizeComputer &s, I n)
938 {
939  s.seek(GetSizeOfVarInt<I>(n));
940 }
941 
942 inline void WriteCompactSize(CSizeComputer &s, uint64_t nSize)
943 {
944  s.seek(GetSizeOfCompactSize(nSize));
945 }
946 
947 template <typename T>
948 size_t GetSerializeSize(const T& t, int nType, int nVersion = 0)
949 {
950  return (CSizeComputer(nType, nVersion) << t).size();
951 }
952 
953 template <typename S, typename T>
954 size_t GetSerializeSize(const S& s, const T& t)
955 {
956  return (CSizeComputer(s.GetType(), s.GetVersion()) << t).size();
957 }
958 
959 #endif // BITCOIN_SERIALIZE_H
void Unserialize(Stream &s)
Definition: serialize.h:424
void Serialize(Stream &s) const
Definition: serialize.h:419
CCompactSize(uint64_t &nIn)
Definition: serialize.h:416
uint64_t & n
Definition: serialize.h:414
Wrapper for serializing arrays and POD.
Definition: serialize.h:356
void Unserialize(Stream &s)
Definition: serialize.h:386
CFlatData(prevector< N, T, S, D > &v)
Definition: serialize.h:369
const char * begin() const
Definition: serialize.h:375
void Serialize(Stream &s) const
Definition: serialize.h:380
CFlatData(std::vector< T, TAl > &v)
Definition: serialize.h:363
char * begin()
Definition: serialize.h:374
char * pbegin
Definition: serialize.h:358
char * pend
Definition: serialize.h:359
char * end()
Definition: serialize.h:376
const char * end() const
Definition: serialize.h:377
CFlatData(void *pbeginIn, void *pendIn)
Definition: serialize.h:361
CSizeComputer & operator<<(const T &obj)
Definition: serialize.h:874
void write(const char *psz, size_t _nSize)
Definition: serialize.h:862
size_t nSize
Definition: serialize.h:855
CSizeComputer(int nTypeIn, int nVersionIn)
Definition: serialize.h:860
size_t size() const
Definition: serialize.h:880
const int nVersion
Definition: serialize.h:858
void seek(size_t _nSize)
Pretend _nSize bytes are written, without specifying them.
Definition: serialize.h:868
int GetVersion() const
Definition: serialize.h:884
const int nType
Definition: serialize.h:857
int GetType() const
Definition: serialize.h:885
void Unserialize(Stream &s)
Definition: serialize.h:406
void Serialize(Stream &s) const
Definition: serialize.h:401
I & n
Definition: serialize.h:396
CVarInt(I &nIn)
Definition: serialize.h:398
std::string & string
Definition: serialize.h:433
void Serialize(Stream &s) const
Definition: serialize.h:450
LimitedString(std::string &_string)
Definition: serialize.h:435
void Unserialize(Stream &s)
Definition: serialize.h:438
Implements a drop-in replacement for std::vector<T> which stores up to N elements directly (without h...
Definition: prevector.h:35
bool empty() const
Definition: prevector.h:285
void clear()
Definition: prevector.h:338
size_type size() const
Definition: prevector.h:281
value_type * data()
Definition: prevector.h:494
iterator begin()
Definition: prevector.h:289
iterator end()
Definition: prevector.h:291
void resize(size_type new_size)
Definition: prevector.h:315
uint32_t le32toh(uint32_t little_endian_32bits)
Definition: endian.h:160
uint16_t le16toh(uint16_t little_endian_16bits)
Definition: endian.h:132
uint64_t htole64(uint64_t host_64bits)
Definition: endian.h:174
uint32_t htole32(uint32_t host_32bits)
Definition: endian.h:146
uint16_t htole16(uint16_t host_16bits)
Definition: endian.h:118
uint64_t le64toh(uint64_t little_endian_64bits)
Definition: endian.h:188
void SerReadWrite(Stream &s, const T &obj, CSerActionSerialize ser_action)
Definition: serialize.h:822
void SerializeMany(Stream &s)
Definition: serialize.h:889
uint8_t ser_readdata8(Stream &s)
Definition: serialize.h:85
float ser_uint32_to_float(uint32_t y)
Definition: serialize.h:127
void WriteVarInt(CSizeComputer &os, I n)
Definition: serialize.h:937
void ser_writedata32(Stream &s, uint32_t obj)
Definition: serialize.h:75
unsigned int GetSizeOfCompactSize(uint64_t nSize)
Compact Size size < 253 – 1 byte size <= USHRT_MAX – 3 bytes (253 + 2 bytes) size <= UINT_MAX – 5 byt...
Definition: serialize.h:209
constexpr deserialize_type deserialize
Definition: serialize.h:40
void Serialize(Stream &s, char a)
Definition: serialize.h:170
void ser_writedata16(Stream &s, uint16_t obj)
Definition: serialize.h:70
CVarInt< I > WrapVarInt(I &n)
Definition: serialize.h:459
uint32_t ser_float_to_uint32(float x)
Definition: serialize.h:115
void Serialize_impl(Stream &os, const prevector< N, T > &v, const unsigned char &)
prevector prevectors of unsigned char are a special case and are intended to be serialized as a singl...
Definition: serialize.h:570
I ReadVarInt(Stream &is)
Definition: serialize.h:334
void Unserialize_impl(Stream &is, prevector< N, T > &v, const unsigned char &)
Definition: serialize.h:593
@ SER_DISK
Definition: serialize.h:147
@ SER_NETWORK
Definition: serialize.h:146
@ SER_GETHASH
Definition: serialize.h:148
void Unserialize(Stream &s, char &a)
Definition: serialize.h:182
void SerReadWriteMany(Stream &s, CSerActionSerialize ser_action, Args &&... args)
Definition: serialize.h:925
uint16_t ser_readdata16(Stream &s)
Definition: serialize.h:91
uint64_t ser_readdata64(Stream &s)
Definition: serialize.h:103
double ser_uint64_to_double(uint64_t y)
Definition: serialize.h:121
void ser_writedata8(Stream &s, uint8_t obj)
Definition: serialize.h:66
T & REF(const T &val)
Used to bypass the rule against non-const reference to temporary where it makes sense with wrappers s...
Definition: serialize.h:47
uint32_t ser_readdata32(Stream &s)
Definition: serialize.h:97
void UnserializeMany(Stream &s)
Definition: serialize.h:907
uint64_t ser_double_to_uint64(double x)
Definition: serialize.h:109
uint64_t ReadCompactSize(Stream &is)
Definition: serialize.h:245
T * NCONST_PTR(const T *val)
Used to acquire a non-const pointer "this" to generate bodies of const serialization operations from ...
Definition: serialize.h:57
void ser_writedata64(Stream &s, uint64_t obj)
Definition: serialize.h:80
size_t GetSerializeSize(const T &t, int nType, int nVersion=0)
Definition: serialize.h:948
unsigned int GetSizeOfVarInt(I n)
Variable-length integers: bytes are a MSB base-128 encoding of the number.
Definition: serialize.h:301
void WriteCompactSize(CSizeComputer &os, uint64_t nSize)
Definition: serialize.h:942
Support for ADD_SERIALIZE_METHODS and READWRITE macro.
Definition: serialize.h:813
constexpr bool ForRead() const
Definition: serialize.h:814
constexpr bool ForRead() const
Definition: serialize.h:818
Dummy data type to identify deserializing constructors.
Definition: serialize.h:39