Branch data Line data Source code
# 1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
# 2 : : // Copyright (c) 2009-2020 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 <cstdint>
# 13 : : #include <cstring>
# 14 : : #include <ios>
# 15 : : #include <limits>
# 16 : : #include <map>
# 17 : : #include <memory>
# 18 : : #include <set>
# 19 : : #include <string>
# 20 : : #include <string.h>
# 21 : : #include <utility>
# 22 : : #include <vector>
# 23 : :
# 24 : : #include <prevector.h>
# 25 : : #include <span.h>
# 26 : :
# 27 : : static const unsigned int MAX_SIZE = 0x02000000;
# 28 : :
# 29 : : /** Maximum amount of memory (in bytes) to allocate at once when deserializing vectors. */
# 30 : : static const unsigned int MAX_VECTOR_ALLOCATE = 5000000;
# 31 : :
# 32 : : /**
# 33 : : * Dummy data type to identify deserializing constructors.
# 34 : : *
# 35 : : * By convention, a constructor of a type T with signature
# 36 : : *
# 37 : : * template <typename Stream> T::T(deserialize_type, Stream& s)
# 38 : : *
# 39 : : * is a deserializing constructor, which builds the type by
# 40 : : * deserializing it from s. If T contains const fields, this
# 41 : : * is likely the only way to do so.
# 42 : : */
# 43 : : struct deserialize_type {};
# 44 : : constexpr deserialize_type deserialize {};
# 45 : :
# 46 : : //! Safely convert odd char pointer types to standard ones.
# 47 : 0 : inline char* CharCast(char* c) { return c; }
# 48 : 505781 : inline char* CharCast(unsigned char* c) { return (char*)c; }
# 49 : 0 : inline const char* CharCast(const char* c) { return c; }
# 50 : 444016 : inline const char* CharCast(const unsigned char* c) { return (const char*)c; }
# 51 : :
# 52 : : /*
# 53 : : * Lowest-level serialization and conversion.
# 54 : : * @note Sizes of these types are verified in the tests
# 55 : : */
# 56 : : template<typename Stream> inline void ser_writedata8(Stream &s, uint8_t obj)
# 57 : 89157284 : {
# 58 : 89157284 : s.write((char*)&obj, 1);
# 59 : 89157284 : }
# 60 : : template<typename Stream> inline void ser_writedata16(Stream &s, uint16_t obj)
# 61 : 2868137 : {
# 62 : 2868137 : obj = htole16(obj);
# 63 : 2868137 : s.write((char*)&obj, 2);
# 64 : 2868137 : }
# 65 : : template<typename Stream> inline void ser_writedata16be(Stream &s, uint16_t obj)
# 66 : : {
# 67 : : obj = htobe16(obj);
# 68 : : s.write((char*)&obj, 2);
# 69 : : }
# 70 : : template<typename Stream> inline void ser_writedata32(Stream &s, uint32_t obj)
# 71 : 92055839 : {
# 72 : 92055839 : obj = htole32(obj);
# 73 : 92055839 : s.write((char*)&obj, 4);
# 74 : 92055839 : }
# 75 : : template<typename Stream> inline void ser_writedata32be(Stream &s, uint32_t obj)
# 76 : 10213 : {
# 77 : 10213 : obj = htobe32(obj);
# 78 : 10213 : s.write((char*)&obj, 4);
# 79 : 10213 : }
# 80 : : template<typename Stream> inline void ser_writedata64(Stream &s, uint64_t obj)
# 81 : 53340034 : {
# 82 : 53340034 : obj = htole64(obj);
# 83 : 53340034 : s.write((char*)&obj, 8);
# 84 : 53340034 : }
# 85 : : template<typename Stream> inline uint8_t ser_readdata8(Stream &s)
# 86 : 6103237 : {
# 87 : 6103237 : uint8_t obj;
# 88 : 6103237 : s.read((char*)&obj, 1);
# 89 : 6103237 : return obj;
# 90 : 6103237 : }
# 91 : : template<typename Stream> inline uint16_t ser_readdata16(Stream &s)
# 92 : 620704 : {
# 93 : 620704 : uint16_t obj;
# 94 : 620704 : s.read((char*)&obj, 2);
# 95 : 620704 : return le16toh(obj);
# 96 : 620704 : }
# 97 : : template<typename Stream> inline uint16_t ser_readdata16be(Stream &s)
# 98 : : {
# 99 : : uint16_t obj;
# 100 : : s.read((char*)&obj, 2);
# 101 : : return be16toh(obj);
# 102 : : }
# 103 : : template<typename Stream> inline uint32_t ser_readdata32(Stream &s)
# 104 : 2387725 : {
# 105 : 2387725 : uint32_t obj;
# 106 : 2387725 : s.read((char*)&obj, 4);
# 107 : 2387725 : return le32toh(obj);
# 108 : 2387725 : }
# 109 : : template<typename Stream> inline uint32_t ser_readdata32be(Stream &s)
# 110 : 2907 : {
# 111 : 2907 : uint32_t obj;
# 112 : 2907 : s.read((char*)&obj, 4);
# 113 : 2907 : return be32toh(obj);
# 114 : 2907 : }
# 115 : : template<typename Stream> inline uint64_t ser_readdata64(Stream &s)
# 116 : 7120224 : {
# 117 : 7120224 : uint64_t obj;
# 118 : 7120224 : s.read((char*)&obj, 8);
# 119 : 7120224 : return le64toh(obj);
# 120 : 7120224 : }
# 121 : : inline uint64_t ser_double_to_uint64(double x)
# 122 : 15054894 : {
# 123 : 15054894 : uint64_t tmp;
# 124 : 15054894 : std::memcpy(&tmp, &x, sizeof(x));
# 125 : 15054894 : static_assert(sizeof(tmp) == sizeof(x), "double and uint64_t assumed to have the same size");
# 126 : 15054894 : return tmp;
# 127 : 15054894 : }
# 128 : : inline uint32_t ser_float_to_uint32(float x)
# 129 : 2016 : {
# 130 : 2016 : uint32_t tmp;
# 131 : 2016 : std::memcpy(&tmp, &x, sizeof(x));
# 132 : 2016 : static_assert(sizeof(tmp) == sizeof(x), "float and uint32_t assumed to have the same size");
# 133 : 2016 : return tmp;
# 134 : 2016 : }
# 135 : : inline double ser_uint64_to_double(uint64_t y)
# 136 : 5948828 : {
# 137 : 5948828 : double tmp;
# 138 : 5948828 : std::memcpy(&tmp, &y, sizeof(y));
# 139 : 5948828 : static_assert(sizeof(tmp) == sizeof(y), "double and uint64_t assumed to have the same size");
# 140 : 5948828 : return tmp;
# 141 : 5948828 : }
# 142 : : inline float ser_uint32_to_float(uint32_t y)
# 143 : 2012 : {
# 144 : 2012 : float tmp;
# 145 : 2012 : std::memcpy(&tmp, &y, sizeof(y));
# 146 : 2012 : static_assert(sizeof(tmp) == sizeof(y), "float and uint32_t assumed to have the same size");
# 147 : 2012 : return tmp;
# 148 : 2012 : }
# 149 : :
# 150 : :
# 151 : : /////////////////////////////////////////////////////////////////
# 152 : : //
# 153 : : // Templates for serializing to anything that looks like a stream,
# 154 : : // i.e. anything that supports .read(char*, size_t) and .write(char*, size_t)
# 155 : : //
# 156 : :
# 157 : : class CSizeComputer;
# 158 : :
# 159 : : enum
# 160 : : {
# 161 : : // primary actions
# 162 : : SER_NETWORK = (1 << 0),
# 163 : : SER_DISK = (1 << 1),
# 164 : : SER_GETHASH = (1 << 2),
# 165 : : };
# 166 : :
# 167 : : /* Convert any argument to a reference to X, maintaining constness.
# 168 : : *
# 169 : : * This can be used in serialization code to invoke a base class's
# 170 : : * serialization routines.
# 171 : : *
# 172 : : * Example use:
# 173 : : * class Base { ... };
# 174 : : * class Child : public Base {
# 175 : : * int m_data;
# 176 : : * public:
# 177 : : * SERIALIZE_METHODS(Child, obj) {
# 178 : : * READWRITE(AsBase<Base>(obj), obj.m_data);
# 179 : : * }
# 180 : : * };
# 181 : : *
# 182 : : * static_cast cannot easily be used here, as the type of Obj will be const Child&
# 183 : : * during serialization and Child& during deserialization. AsBase will convert to
# 184 : : * const Base& and Base& appropriately.
# 185 : : */
# 186 : 1558326 : template<typename X> X& AsBase(X& x) { return x; }
# 187 : 42935570 : template<typename X> const X& AsBase(const X& x) { return x; }
# 188 : :
# 189 : 149041773 : #define READWRITE(...) (::SerReadWriteMany(s, ser_action, __VA_ARGS__))
# 190 : 13950 : #define SER_READ(obj, code) ::SerRead(s, ser_action, obj, [&](Stream& s, typename std::remove_const<Type>::type& obj) { code; })
# 191 : 8969 : #define SER_WRITE(obj, code) ::SerWrite(s, ser_action, obj, [&](Stream& s, const Type& obj) { code; })
# 192 : :
# 193 : : /**
# 194 : : * Implement the Ser and Unser methods needed for implementing a formatter (see Using below).
# 195 : : *
# 196 : : * Both Ser and Unser are delegated to a single static method SerializationOps, which is polymorphic
# 197 : : * in the serialized/deserialized type (allowing it to be const when serializing, and non-const when
# 198 : : * deserializing).
# 199 : : *
# 200 : : * Example use:
# 201 : : * struct FooFormatter {
# 202 : : * FORMATTER_METHODS(Class, obj) { READWRITE(obj.val1, VARINT(obj.val2)); }
# 203 : : * }
# 204 : : * would define a class FooFormatter that defines a serialization of Class objects consisting
# 205 : : * of serializing its val1 member using the default serialization, and its val2 member using
# 206 : : * VARINT serialization. That FooFormatter can then be used in statements like
# 207 : : * READWRITE(Using<FooFormatter>(obj.bla)).
# 208 : : */
# 209 : : #define FORMATTER_METHODS(cls, obj) \
# 210 : : template<typename Stream> \
# 211 : 143738992 : static void Ser(Stream& s, const cls& obj) { SerializationOps(obj, s, CSerActionSerialize()); } \
# 212 : : template<typename Stream> \
# 213 : 4033277 : static void Unser(Stream& s, cls& obj) { SerializationOps(obj, s, CSerActionUnserialize()); } \
# 214 : : template<typename Stream, typename Type, typename Operation> \
# 215 : : static inline void SerializationOps(Type& obj, Stream& s, Operation ser_action) \
# 216 : :
# 217 : : /** Variant of FORMATTER_METHODS that supports a declared parameter type.
# 218 : : *
# 219 : : * With a formatter has a declared parameter type, it must be invoked directly or
# 220 : : * indirectly with a parameter of that type. This permits making serialization
# 221 : : * depend on run-time context in a type-safe way.
# 222 : : *
# 223 : : * Example use:
# 224 : : * struct BarParameter { bool fancy; ... };
# 225 : : * struct Bar { ... };
# 226 : : * struct FooFormatter {
# 227 : : * FORMATTER_METHODS(Bar, obj, BarParameter, param) {
# 228 : : * if (param.fancy) {
# 229 : : * READWRITE(VARINT(obj.value));
# 230 : : * } else {
# 231 : : * READWRITE(obj.value);
# 232 : : * }
# 233 : : * }
# 234 : : * };
# 235 : : * which would then be invoked as
# 236 : : * READWRITE(WithParams(BarParameter{...}, Using<FooFormatter>(obj.foo)))
# 237 : : *
# 238 : : * Note that WithParams(parameter, obj) can be invoked anywhere in the call
# 239 : : * stack; it is passed down recursively into all serialization code, until
# 240 : : * another WithParams overrides it.
# 241 : : *
# 242 : : * Compilation will fail in any context where serialization is invoke but
# 243 : : * no parameter of a type convertible to BarParameter is provided.
# 244 : : */
# 245 : : #define FORMATTER_METHODS_PARAMS(cls, obj, paramcls, paramobj) \
# 246 : : template<typename Stream> \
# 247 : 1604 : static void Ser(Stream& s, const cls& obj) { SerializationOps(obj, s, CSerActionSerialize(), s.GetParams()); } \
# 248 : : template<typename Stream> \
# 249 : 2668 : static void Unser(Stream& s, cls& obj) { SerializationOps(obj, s, CSerActionUnserialize(), s.GetParams()); } \
# 250 : : template<typename Stream, typename Type, typename Operation> \
# 251 : : static inline void SerializationOps(Type& obj, Stream& s, Operation ser_action, const paramcls& paramobj) \
# 252 : :
# 253 : : #define BASE_SERIALIZE_METHODS(cls) \
# 254 : : template<typename Stream> \
# 255 : : void Serialize(Stream& s) const \
# 256 : 143311204 : { \
# 257 : 143311204 : static_assert(std::is_same<const cls&, decltype(*this)>::value, "Serialize type mismatch"); \
# 258 : 143311204 : Ser(s, *this); \
# 259 : 143311204 : } \
# 260 : : template<typename Stream> \
# 261 : : void Unserialize(Stream& s) \
# 262 : 3824402 : { \
# 263 : 3824402 : static_assert(std::is_same<cls&, decltype(*this)>::value, "Unserialize type mismatch"); \
# 264 : 3824402 : Unser(s, *this); \
# 265 : 3824402 : }
# 266 : :
# 267 : : /**
# 268 : : * Implement the Serialize and Unserialize methods by delegating to a single templated
# 269 : : * static method that takes the to-be-(de)serialized object as a parameter. This approach
# 270 : : * has the advantage that the constness of the object becomes a template parameter, and
# 271 : : * thus allows a single implementation that sees the object as const for serializing
# 272 : : * and non-const for deserializing, without casts.
# 273 : : */
# 274 : : #define SERIALIZE_METHODS(cls, obj) \
# 275 : : BASE_SERIALIZE_METHODS(cls) \
# 276 : : FORMATTER_METHODS(cls, obj)
# 277 : :
# 278 : : /** Variant of SERIALIZE_METHODS that supports a declared parameter type.
# 279 : : *
# 280 : : * See FORMATTER_METHODS_PARAMS for more information on parameters.
# 281 : : */
# 282 : : #define SERIALIZE_METHODS_PARAMS(cls, obj, paramcls, paramobj) \
# 283 : : BASE_SERIALIZE_METHODS(cls) \
# 284 : : FORMATTER_METHODS_PARAMS(cls, obj, paramcls, paramobj)
# 285 : :
# 286 : : #ifndef CHAR_EQUALS_INT8
# 287 : 10827426 : template<typename Stream> inline void Serialize(Stream& s, char a ) { ser_writedata8(s, a); } // TODO Get rid of bare char
# 288 : : #endif
# 289 : 4 : template<typename Stream> inline void Serialize(Stream& s, int8_t a ) { ser_writedata8(s, a); }
# 290 : 722289 : template<typename Stream> inline void Serialize(Stream& s, uint8_t a ) { ser_writedata8(s, a); }
# 291 : 4 : template<typename Stream> inline void Serialize(Stream& s, int16_t a ) { ser_writedata16(s, a); }
# 292 : 4 : template<typename Stream> inline void Serialize(Stream& s, uint16_t a) { ser_writedata16(s, a); }
# 293 : 16443766 : template<typename Stream> inline void Serialize(Stream& s, int32_t a ) { ser_writedata32(s, a); }
# 294 : 75607218 : template<typename Stream> inline void Serialize(Stream& s, uint32_t a) { ser_writedata32(s, a); }
# 295 : 38185093 : template<typename Stream> inline void Serialize(Stream& s, int64_t a ) { ser_writedata64(s, a); }
# 296 : 100099 : template<typename Stream> inline void Serialize(Stream& s, uint64_t a) { ser_writedata64(s, a); }
# 297 : 2004 : template<typename Stream> inline void Serialize(Stream& s, float a ) { ser_writedata32(s, ser_float_to_uint32(a)); }
# 298 : 15054882 : template<typename Stream> inline void Serialize(Stream& s, double a ) { ser_writedata64(s, ser_double_to_uint64(a)); }
# 299 : 151710 : template<typename Stream, int N> inline void Serialize(Stream& s, const char (&a)[N]) { s.write(a, N); }
# 300 : 191918 : template<typename Stream, int N> inline void Serialize(Stream& s, const unsigned char (&a)[N]) { s.write(CharCast(a), N); }
# 301 : 252098 : template<typename Stream> inline void Serialize(Stream& s, const Span<const unsigned char>& span) { s.write(CharCast(span.data()), span.size()); }
# 302 : 186351 : template<typename Stream> inline void Serialize(Stream& s, const Span<unsigned char>& span) { s.write(CharCast(span.data()), span.size()); }
# 303 : :
# 304 : : #ifndef CHAR_EQUALS_INT8
# 305 : 92741 : template<typename Stream> inline void Unserialize(Stream& s, char& a ) { a = ser_readdata8(s); } // TODO Get rid of bare char
# 306 : : #endif
# 307 : 2 : template<typename Stream> inline void Unserialize(Stream& s, int8_t& a ) { a = ser_readdata8(s); }
# 308 : 156793 : template<typename Stream> inline void Unserialize(Stream& s, uint8_t& a ) { a = ser_readdata8(s); }
# 309 : : template<typename Stream> inline void Unserialize(Stream& s, int16_t& a ) { a = ser_readdata16(s); }
# 310 : 2 : template<typename Stream> inline void Unserialize(Stream& s, uint16_t& a) { a = ser_readdata16(s); }
# 311 : 795314 : template<typename Stream> inline void Unserialize(Stream& s, int32_t& a ) { a = ser_readdata32(s); }
# 312 : 1587097 : template<typename Stream> inline void Unserialize(Stream& s, uint32_t& a) { a = ser_readdata32(s); }
# 313 : 1155709 : template<typename Stream> inline void Unserialize(Stream& s, int64_t& a ) { a = ser_readdata64(s); }
# 314 : 15694 : template<typename Stream> inline void Unserialize(Stream& s, uint64_t& a) { a = ser_readdata64(s); }
# 315 : 2000 : template<typename Stream> inline void Unserialize(Stream& s, float& a ) { a = ser_uint32_to_float(ser_readdata32(s)); }
# 316 : 5948816 : template<typename Stream> inline void Unserialize(Stream& s, double& a ) { a = ser_uint64_to_double(ser_readdata64(s)); }
# 317 : 156444 : template<typename Stream, int N> inline void Unserialize(Stream& s, char (&a)[N]) { s.read(a, N); }
# 318 : 107889 : template<typename Stream, int N> inline void Unserialize(Stream& s, unsigned char (&a)[N]) { s.read(CharCast(a), N); }
# 319 : 211541 : template<typename Stream> inline void Unserialize(Stream& s, Span<unsigned char>& span) { s.read(CharCast(span.data()), span.size()); }
# 320 : :
# 321 : 360555 : template<typename Stream> inline void Serialize(Stream& s, bool a) { char f=a; ser_writedata8(s, f); }
# 322 : 69356 : template<typename Stream> inline void Unserialize(Stream& s, bool& a) { char f=ser_readdata8(s); a=f; }
# 323 : :
# 324 : :
# 325 : :
# 326 : :
# 327 : :
# 328 : :
# 329 : : /**
# 330 : : * Compact Size
# 331 : : * size < 253 -- 1 byte
# 332 : : * size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
# 333 : : * size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
# 334 : : * size > UINT_MAX -- 9 bytes (255 + 8 bytes)
# 335 : : */
# 336 : : inline unsigned int GetSizeOfCompactSize(uint64_t nSize)
# 337 : 9351689 : {
# 338 : 9351689 : if (nSize < 253) return sizeof(unsigned char);
# 339 : 467467 : else if (nSize <= std::numeric_limits<uint16_t>::max()) return sizeof(unsigned char) + sizeof(uint16_t);
# 340 : 8827 : else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
# 341 : 0 : else return sizeof(unsigned char) + sizeof(uint64_t);
# 342 : 9351689 : }
# 343 : :
# 344 : : inline void WriteCompactSize(CSizeComputer& os, uint64_t nSize);
# 345 : :
# 346 : : template<typename Stream>
# 347 : : void WriteCompactSize(Stream& os, uint64_t nSize)
# 348 : 48061046 : {
# 349 : 48061046 : if (nSize < 253)
# 350 : 45188746 : {
# 351 : 45188746 : ser_writedata8(os, nSize);
# 352 : 45188746 : }
# 353 : 2872300 : else if (nSize <= std::numeric_limits<uint16_t>::max())
# 354 : 2868129 : {
# 355 : 2868129 : ser_writedata8(os, 253);
# 356 : 2868129 : ser_writedata16(os, nSize);
# 357 : 2868129 : }
# 358 : 4171 : else if (nSize <= std::numeric_limits<unsigned int>::max())
# 359 : 4402 : {
# 360 : 4402 : ser_writedata8(os, 254);
# 361 : 4402 : ser_writedata32(os, nSize);
# 362 : 4402 : }
# 363 :>1844*10^16 : else
# 364 :>1844*10^16 : {
# 365 :>1844*10^16 : ser_writedata8(os, 255);
# 366 :>1844*10^16 : ser_writedata64(os, nSize);
# 367 :>1844*10^16 : }
# 368 : 48061046 : return;
# 369 : 48061046 : }
# 370 : :
# 371 : : template<typename Stream>
# 372 : : uint64_t ReadCompactSize(Stream& is)
# 373 : 3058804 : {
# 374 : 3058804 : uint8_t chSize = ser_readdata8(is);
# 375 : 3058804 : uint64_t nSizeRet = 0;
# 376 : 3058804 : if (chSize < 253)
# 377 : 2434770 : {
# 378 : 2434770 : nSizeRet = chSize;
# 379 : 2434770 : }
# 380 : 624034 : else if (chSize == 253)
# 381 : 620702 : {
# 382 : 620702 : nSizeRet = ser_readdata16(is);
# 383 : 620702 : if (nSizeRet < 253)
# 384 : 4 : throw std::ios_base::failure("non-canonical ReadCompactSize()");
# 385 : 3332 : }
# 386 : 3332 : else if (chSize == 254)
# 387 : 3315 : {
# 388 : 3315 : nSizeRet = ser_readdata32(is);
# 389 : 3315 : if (nSizeRet < 0x10000u)
# 390 : 4 : throw std::ios_base::failure("non-canonical ReadCompactSize()");
# 391 : 17 : }
# 392 : 17 : else
# 393 : 17 : {
# 394 : 17 : nSizeRet = ser_readdata64(is);
# 395 : 17 : if (nSizeRet < 0x100000000ULL)
# 396 : 5 : throw std::ios_base::failure("non-canonical ReadCompactSize()");
# 397 : 3058791 : }
# 398 : 3058791 : if (nSizeRet > (uint64_t)MAX_SIZE)
# 399 : 0 : throw std::ios_base::failure("ReadCompactSize(): size too large");
# 400 : 3058791 : return nSizeRet;
# 401 : 3058791 : }
# 402 : :
# 403 : : /**
# 404 : : * Variable-length integers: bytes are a MSB base-128 encoding of the number.
# 405 : : * The high bit in each byte signifies whether another digit follows. To make
# 406 : : * sure the encoding is one-to-one, one is subtracted from all but the last digit.
# 407 : : * Thus, the byte sequence a[] with length len, where all but the last byte
# 408 : : * has bit 128 set, encodes the number:
# 409 : : *
# 410 : : * (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))
# 411 : : *
# 412 : : * Properties:
# 413 : : * * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
# 414 : : * * Every integer has exactly one encoding
# 415 : : * * Encoding does not depend on size of original integer type
# 416 : : * * No redundancy: every (infinite) byte sequence corresponds to a list
# 417 : : * of encoded integers.
# 418 : : *
# 419 : : * 0: [0x00] 256: [0x81 0x00]
# 420 : : * 1: [0x01] 16383: [0xFE 0x7F]
# 421 : : * 127: [0x7F] 16384: [0xFF 0x00]
# 422 : : * 128: [0x80 0x00] 16511: [0xFF 0x7F]
# 423 : : * 255: [0x80 0x7F] 65535: [0x82 0xFE 0x7F]
# 424 : : * 2^32: [0x8E 0xFE 0xFE 0xFF 0x00]
# 425 : : */
# 426 : :
# 427 : : /**
# 428 : : * Mode for encoding VarInts.
# 429 : : *
# 430 : : * Currently there is no support for signed encodings. The default mode will not
# 431 : : * compile with signed values, and the legacy "nonnegative signed" mode will
# 432 : : * accept signed values, but improperly encode and decode them if they are
# 433 : : * negative. In the future, the DEFAULT mode could be extended to support
# 434 : : * negative numbers in a backwards compatible way, and additional modes could be
# 435 : : * added to support different varint formats (e.g. zigzag encoding).
# 436 : : */
# 437 : : enum class VarIntMode { DEFAULT, NONNEGATIVE_SIGNED };
# 438 : :
# 439 : : template <VarIntMode Mode, typename I>
# 440 : : struct CheckVarIntMode {
# 441 : : constexpr CheckVarIntMode()
# 442 : 12554318 : {
# 443 : 12554318 : static_assert(Mode != VarIntMode::DEFAULT || std::is_unsigned<I>::value, "Unsigned type required with mode DEFAULT.");
# 444 : 12554318 : static_assert(Mode != VarIntMode::NONNEGATIVE_SIGNED || std::is_signed<I>::value, "Signed type required with mode NONNEGATIVE_SIGNED.");
# 445 : 12554318 : }
# 446 : : };
# 447 : :
# 448 : : template<VarIntMode Mode, typename I>
# 449 : : inline unsigned int GetSizeOfVarInt(I n)
# 450 : : {
# 451 : : CheckVarIntMode<Mode, I>();
# 452 : : int nRet = 0;
# 453 : : while(true) {
# 454 : : nRet++;
# 455 : : if (n <= 0x7F)
# 456 : : break;
# 457 : : n = (n >> 7) - 1;
# 458 : : }
# 459 : : return nRet;
# 460 : : }
# 461 : :
# 462 : : template<typename I>
# 463 : : inline void WriteVarInt(CSizeComputer& os, I n);
# 464 : :
# 465 : : template<typename Stream, VarIntMode Mode, typename I>
# 466 : : void WriteVarInt(Stream& os, I n)
# 467 : 11315540 : {
# 468 : 11315540 : CheckVarIntMode<Mode, I>();
# 469 : 11315540 : unsigned char tmp[(sizeof(n)*8+6)/7];
# 470 : 11315540 : int len=0;
# 471 : 29175634 : while(true) {
# 472 : 29175634 : tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00);
# 473 : 29175634 : if (n <= 0x7F)
# 474 : 11315540 : break;
# 475 : 17860094 : n = (n >> 7) - 1;
# 476 : 17860094 : len++;
# 477 : 17860094 : }
# 478 : 29175634 : do {
# 479 : 29175634 : ser_writedata8(os, tmp[len]);
# 480 : 29175634 : } while(len--);
# 481 : 11315540 : }
# 482 : :
# 483 : : template<typename Stream, VarIntMode Mode, typename I>
# 484 : : I ReadVarInt(Stream& is)
# 485 : 1238778 : {
# 486 : 1238778 : CheckVarIntMode<Mode, I>();
# 487 : 1238778 : I n = 0;
# 488 : 2722634 : while(true) {
# 489 : 2722634 : unsigned char chData = ser_readdata8(is);
# 490 : 2722634 : if (n > (std::numeric_limits<I>::max() >> 7)) {
# 491 : 0 : throw std::ios_base::failure("ReadVarInt(): size too large");
# 492 : 0 : }
# 493 : 2722634 : n = (n << 7) | (chData & 0x7F);
# 494 : 2722634 : if (chData & 0x80) {
# 495 : 1483856 : if (n == std::numeric_limits<I>::max()) {
# 496 : 0 : throw std::ios_base::failure("ReadVarInt(): size too large");
# 497 : 0 : }
# 498 : 1483856 : n++;
# 499 : 1483856 : } else {
# 500 : 1238778 : return n;
# 501 : 1238778 : }
# 502 : 2722634 : }
# 503 : 1238778 : }
# 504 : :
# 505 : : /** Simple wrapper class to serialize objects using a formatter; used by Using(). */
# 506 : : template<typename Formatter, typename T>
# 507 : : class Wrapper
# 508 : : {
# 509 : : static_assert(std::is_lvalue_reference<T>::value, "Wrapper needs an lvalue reference type T");
# 510 : : protected:
# 511 : : T m_object;
# 512 : : public:
# 513 : 25089085 : explicit Wrapper(T obj) : m_object(obj) {}
# 514 : 22176657 : template<typename Stream> void Serialize(Stream &s) const { Formatter().Ser(s, m_object); }
# 515 : 2912657 : template<typename Stream> void Unserialize(Stream &s) { Formatter().Unser(s, m_object); }
# 516 : : };
# 517 : :
# 518 : : /** Cause serialization/deserialization of an object to be done using a specified formatter class.
# 519 : : *
# 520 : : * To use this, you need a class Formatter that has public functions Ser(stream, const object&) for
# 521 : : * serialization, and Unser(stream, object&) for deserialization. Serialization routines (inside
# 522 : : * READWRITE, or directly with << and >> operators), can then use Using<Formatter>(object).
# 523 : : *
# 524 : : * This works by constructing a Wrapper<Formatter, T>-wrapped version of object, where T is
# 525 : : * const during serialization, and non-const during deserialization, which maintains const
# 526 : : * correctness.
# 527 : : */
# 528 : : template<typename Formatter, typename T>
# 529 : 25089314 : static inline Wrapper<Formatter, T&> Using(T&& t) { return Wrapper<Formatter, T&>(t); }
# 530 : :
# 531 : 600856 : #define VARINT_MODE(obj, mode) Using<VarIntFormatter<mode>>(obj)
# 532 : 1763822 : #define VARINT(obj) Using<VarIntFormatter<VarIntMode::DEFAULT>>(obj)
# 533 : : #define COMPACTSIZE(obj) Using<CompactSizeFormatter>(obj)
# 534 : 689 : #define LIMITED_STRING(obj,n) Using<LimitedStringFormatter<n>>(obj)
# 535 : :
# 536 : : /** Serialization wrapper class for integers in VarInt format. */
# 537 : : template<VarIntMode Mode>
# 538 : : struct VarIntFormatter
# 539 : : {
# 540 : : template<typename Stream, typename I> void Ser(Stream &s, I v)
# 541 : 11315540 : {
# 542 : 11315540 : WriteVarInt<Stream,Mode,typename std::remove_cv<I>::type>(s, v);
# 543 : 11315540 : }
# 544 : :
# 545 : : template<typename Stream, typename I> void Unser(Stream& s, I& v)
# 546 : 1238778 : {
# 547 : 1238778 : v = ReadVarInt<Stream,Mode,typename std::remove_cv<I>::type>(s);
# 548 : 1238778 : }
# 549 : : };
# 550 : :
# 551 : : /** Serialization wrapper class for custom integers and enums.
# 552 : : *
# 553 : : * It permits specifying the serialized size (1 to 8 bytes) and endianness.
# 554 : : *
# 555 : : * Use the big endian mode for values that are stored in memory in native
# 556 : : * byte order, but serialized in big endian notation. This is only intended
# 557 : : * to implement serializers that are compatible with existing formats, and
# 558 : : * its use is not recommended for new data structures.
# 559 : : */
# 560 : : template<int Bytes, bool BigEndian = false>
# 561 : : struct CustomUintFormatter
# 562 : : {
# 563 : : static_assert(Bytes > 0 && Bytes <= 8, "CustomUintFormatter Bytes out of range");
# 564 : : static constexpr uint64_t MAX = 0xffffffffffffffff >> (8 * (8 - Bytes));
# 565 : :
# 566 : : template <typename Stream, typename I> void Ser(Stream& s, I v)
# 567 : 34780 : {
# 568 : 34780 : if (v < 0 || v > MAX) throw std::ios_base::failure("CustomUintFormatter value out of range");
# 569 : 34780 : if (BigEndian) {
# 570 : 1604 : uint64_t raw = htobe64(v);
# 571 : 1604 : s.write(((const char*)&raw) + 8 - Bytes, Bytes);
# 572 : 33176 : } else {
# 573 : 33176 : uint64_t raw = htole64(v);
# 574 : 33176 : s.write((const char*)&raw, Bytes);
# 575 : 33176 : }
# 576 : 34780 : }
# 577 : :
# 578 : : template <typename Stream, typename I> void Unser(Stream& s, I& v)
# 579 : 24816 : {
# 580 : 24816 : using U = typename std::conditional<std::is_enum<I>::value, std::underlying_type<I>, std::common_type<I>>::type::type;
# 581 : 24816 : static_assert(std::numeric_limits<U>::max() >= MAX && std::numeric_limits<U>::min() <= 0, "Assigned type too small");
# 582 : 24816 : uint64_t raw = 0;
# 583 : 24816 : if (BigEndian) {
# 584 : 2664 : s.read(((char*)&raw) + 8 - Bytes, Bytes);
# 585 : 2664 : v = static_cast<I>(be64toh(raw));
# 586 : 22152 : } else {
# 587 : 22152 : s.read((char*)&raw, Bytes);
# 588 : 22152 : v = static_cast<I>(le64toh(raw));
# 589 : 22152 : }
# 590 : 24816 : }
# 591 : : };
# 592 : :
# 593 : : template<int Bytes> using BigEndianFormatter = CustomUintFormatter<Bytes, true>;
# 594 : :
# 595 : : /** Formatter for integers in CompactSize format. */
# 596 : : struct CompactSizeFormatter
# 597 : : {
# 598 : : template<typename Stream, typename I>
# 599 : : void Unser(Stream& s, I& v)
# 600 : 9109 : {
# 601 : 9109 : uint64_t n = ReadCompactSize<Stream>(s);
# 602 : 9109 : if (n < std::numeric_limits<I>::min() || n > std::numeric_limits<I>::max()) {
# 603 : 0 : throw std::ios_base::failure("CompactSize exceeds limit of type");
# 604 : 0 : }
# 605 : 9109 : v = n;
# 606 : 9109 : }
# 607 : :
# 608 : : template<typename Stream, typename I>
# 609 : : void Ser(Stream& s, I v)
# 610 : 15820 : {
# 611 : 15820 : static_assert(std::is_unsigned<I>::value, "CompactSize only supported for unsigned integers");
# 612 : 15820 : static_assert(std::numeric_limits<I>::max() <= std::numeric_limits<uint64_t>::max(), "CompactSize only supports 64-bit integers and below");
# 613 : 15820 :
# 614 : 15820 : WriteCompactSize<Stream>(s, v);
# 615 : 15820 : }
# 616 : : };
# 617 : :
# 618 : : template<size_t Limit>
# 619 : : struct LimitedStringFormatter
# 620 : : {
# 621 : : template<typename Stream>
# 622 : : void Unser(Stream& s, std::string& v)
# 623 : 687 : {
# 624 : 687 : size_t size = ReadCompactSize(s);
# 625 : 687 : if (size > Limit) {
# 626 : 0 : throw std::ios_base::failure("String length limit exceeded");
# 627 : 0 : }
# 628 : 687 : v.resize(size);
# 629 : 687 : if (size != 0) s.read((char*)v.data(), size);
# 630 : 687 : }
# 631 : :
# 632 : : template<typename Stream>
# 633 : : void Ser(Stream& s, const std::string& v)
# 634 : 6 : {
# 635 : 6 : s << v;
# 636 : 6 : }
# 637 : : };
# 638 : :
# 639 : : /** Formatter to serialize/deserialize vector elements using another formatter
# 640 : : *
# 641 : : * Example:
# 642 : : * struct X {
# 643 : : * std::vector<uint64_t> v;
# 644 : : * SERIALIZE_METHODS(X, obj) { READWRITE(Using<VectorFormatter<VarInt>>(obj.v)); }
# 645 : : * };
# 646 : : * will define a struct that contains a vector of uint64_t, which is serialized
# 647 : : * as a vector of VarInt-encoded integers.
# 648 : : *
# 649 : : * V is not required to be an std::vector type. It works for any class that
# 650 : : * exposes a value_type, size, reserve, emplace_back, back, and const iterators.
# 651 : : */
# 652 : : template<class Formatter>
# 653 : : struct VectorFormatter
# 654 : : {
# 655 : : template<typename Stream, typename V>
# 656 : : void Ser(Stream& s, const V& v)
# 657 : 9540994 : {
# 658 : 9540994 : Formatter formatter;
# 659 : 9540994 : WriteCompactSize(s, v.size());
# 660 : 38765929 : for (const typename V::value_type& elem : v) {
# 661 : 38765929 : formatter.Ser(s, elem);
# 662 : 38765929 : }
# 663 : 9540994 : }
# 664 : :
# 665 : : template<typename Stream, typename V>
# 666 : : void Unser(Stream& s, V& v)
# 667 : 1015017 : {
# 668 : 1015017 : Formatter formatter;
# 669 : 1015017 : v.clear();
# 670 : 1015017 : size_t size = ReadCompactSize(s);
# 671 : 1015017 : size_t allocated = 0;
# 672 : 1824550 : while (allocated < size) {
# 673 : 809533 : // For DoS prevention, do not blindly allocate as much as the stream claims to contain.
# 674 : 809533 : // Instead, allocate in 5MiB batches, so that an attacker actually needs to provide
# 675 : 809533 : // X MiB of data to make us allocate X+5 Mib.
# 676 : 809533 : static_assert(sizeof(typename V::value_type) <= MAX_VECTOR_ALLOCATE, "Vector element size too large");
# 677 : 809533 : allocated = std::min(size, allocated + MAX_VECTOR_ALLOCATE / sizeof(typename V::value_type));
# 678 : 809533 : v.reserve(allocated);
# 679 : 9070595 : while (v.size() < allocated) {
# 680 : 8261062 : v.emplace_back();
# 681 : 8261062 : formatter.Unser(s, v.back());
# 682 : 8261062 : }
# 683 : 809533 : }
# 684 : 1015017 : };
# 685 : : };
# 686 : :
# 687 : : /**
# 688 : : * Forward declarations
# 689 : : */
# 690 : :
# 691 : : /**
# 692 : : * string
# 693 : : */
# 694 : : template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str);
# 695 : : template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str);
# 696 : :
# 697 : : /**
# 698 : : * prevector
# 699 : : * prevectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.
# 700 : : */
# 701 : : template<typename Stream, unsigned int N, typename T> void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&);
# 702 : : template<typename Stream, unsigned int N, typename T, typename V> void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&);
# 703 : : template<typename Stream, unsigned int N, typename T> inline void Serialize(Stream& os, const prevector<N, T>& v);
# 704 : : template<typename Stream, unsigned int N, typename T> void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&);
# 705 : : template<typename Stream, unsigned int N, typename T, typename V> void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&);
# 706 : : template<typename Stream, unsigned int N, typename T> inline void Unserialize(Stream& is, prevector<N, T>& v);
# 707 : :
# 708 : : /**
# 709 : : * vector
# 710 : : * vectors of unsigned char are a special case and are intended to be serialized as a single opaque blob.
# 711 : : */
# 712 : : template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&);
# 713 : : template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const bool&);
# 714 : : template<typename Stream, typename T, typename A, typename V> void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&);
# 715 : : template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v);
# 716 : : template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&);
# 717 : : template<typename Stream, typename T, typename A, typename V> void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&);
# 718 : : template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v);
# 719 : :
# 720 : : /**
# 721 : : * pair
# 722 : : */
# 723 : : template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item);
# 724 : : template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item);
# 725 : :
# 726 : : /**
# 727 : : * map
# 728 : : */
# 729 : : template<typename Stream, typename K, typename T, typename Pred, typename A> void Serialize(Stream& os, const std::map<K, T, Pred, A>& m);
# 730 : : template<typename Stream, typename K, typename T, typename Pred, typename A> void Unserialize(Stream& is, std::map<K, T, Pred, A>& m);
# 731 : :
# 732 : : /**
# 733 : : * set
# 734 : : */
# 735 : : template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m);
# 736 : : template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m);
# 737 : :
# 738 : : /**
# 739 : : * shared_ptr
# 740 : : */
# 741 : : template<typename Stream, typename T> void Serialize(Stream& os, const std::shared_ptr<const T>& p);
# 742 : : template<typename Stream, typename T> void Unserialize(Stream& os, std::shared_ptr<const T>& p);
# 743 : :
# 744 : : /**
# 745 : : * unique_ptr
# 746 : : */
# 747 : : template<typename Stream, typename T> void Serialize(Stream& os, const std::unique_ptr<const T>& p);
# 748 : : template<typename Stream, typename T> void Unserialize(Stream& os, std::unique_ptr<const T>& p);
# 749 : :
# 750 : :
# 751 : :
# 752 : : /**
# 753 : : * If none of the specialized versions above matched, default to calling member function.
# 754 : : */
# 755 : : template<typename Stream, typename T>
# 756 : : inline void Serialize(Stream& os, const T& a)
# 757 : 231223806 : {
# 758 : 231223806 : a.Serialize(os);
# 759 : 231223806 : }
# 760 : :
# 761 : : template<typename Stream, typename T>
# 762 : : inline void Unserialize(Stream& is, T&& a)
# 763 : 8109759 : {
# 764 : 8109759 : a.Unserialize(is);
# 765 : 8109759 : }
# 766 : :
# 767 : : /** Default formatter. Serializes objects as themselves.
# 768 : : *
# 769 : : * The vector/prevector serialization code passes this to VectorFormatter
# 770 : : * to enable reusing that logic. It shouldn't be needed elsewhere.
# 771 : : */
# 772 : : struct DefaultFormatter
# 773 : : {
# 774 : : template<typename Stream, typename T>
# 775 : 38456877 : static void Ser(Stream& s, const T& t) { Serialize(s, t); }
# 776 : :
# 777 : : template<typename Stream, typename T>
# 778 : 8228939 : static void Unser(Stream& s, T& t) { Unserialize(s, t); }
# 779 : : };
# 780 : :
# 781 : :
# 782 : :
# 783 : :
# 784 : :
# 785 : : /**
# 786 : : * string
# 787 : : */
# 788 : : template<typename Stream, typename C>
# 789 : : void Serialize(Stream& os, const std::basic_string<C>& str)
# 790 : 1365433 : {
# 791 : 1365433 : WriteCompactSize(os, str.size());
# 792 : 1365433 : if (!str.empty())
# 793 : 1212373 : os.write((char*)str.data(), str.size() * sizeof(C));
# 794 : 1365433 : }
# 795 : :
# 796 : : template<typename Stream, typename C>
# 797 : : void Unserialize(Stream& is, std::basic_string<C>& str)
# 798 : 145141 : {
# 799 : 145141 : unsigned int nSize = ReadCompactSize(is);
# 800 : 145141 : str.resize(nSize);
# 801 : 145141 : if (nSize != 0)
# 802 : 131875 : is.read((char*)str.data(), nSize * sizeof(C));
# 803 : 145141 : }
# 804 : :
# 805 : :
# 806 : :
# 807 : : /**
# 808 : : * prevector
# 809 : : */
# 810 : : template<typename Stream, unsigned int N, typename T>
# 811 : : void Serialize_impl(Stream& os, const prevector<N, T>& v, const unsigned char&)
# 812 : 42504796 : {
# 813 : 42504796 : WriteCompactSize(os, v.size());
# 814 : 42504796 : if (!v.empty())
# 815 : 39395820 : os.write((char*)v.data(), v.size() * sizeof(T));
# 816 : 42504796 : }
# 817 : :
# 818 : : template<typename Stream, unsigned int N, typename T, typename V>
# 819 : : void Serialize_impl(Stream& os, const prevector<N, T>& v, const V&)
# 820 : 530944 : {
# 821 : 530944 : Serialize(os, Using<VectorFormatter<DefaultFormatter>>(v));
# 822 : 530944 : }
# 823 : :
# 824 : : template<typename Stream, unsigned int N, typename T>
# 825 : : inline void Serialize(Stream& os, const prevector<N, T>& v)
# 826 : 43035603 : {
# 827 : 43035603 : Serialize_impl(os, v, T());
# 828 : 43035603 : }
# 829 : :
# 830 : :
# 831 : : template<typename Stream, unsigned int N, typename T>
# 832 : : void Unserialize_impl(Stream& is, prevector<N, T>& v, const unsigned char&)
# 833 : 1441386 : {
# 834 : 1441386 : // Limit size per read so bogus size value won't cause out of memory
# 835 : 1441386 : v.clear();
# 836 : 1441386 : unsigned int nSize = ReadCompactSize(is);
# 837 : 1441386 : unsigned int i = 0;
# 838 : 2751522 : while (i < nSize)
# 839 : 1310136 : {
# 840 : 1310136 : unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
# 841 : 1310136 : v.resize_uninitialized(i + blk);
# 842 : 1310136 : is.read((char*)&v[i], blk * sizeof(T));
# 843 : 1310136 : i += blk;
# 844 : 1310136 : }
# 845 : 1441386 : }
# 846 : :
# 847 : : template<typename Stream, unsigned int N, typename T, typename V>
# 848 : : void Unserialize_impl(Stream& is, prevector<N, T>& v, const V&)
# 849 : : {
# 850 : : Unserialize(is, Using<VectorFormatter<DefaultFormatter>>(v));
# 851 : : }
# 852 : :
# 853 : : template<typename Stream, unsigned int N, typename T>
# 854 : : inline void Unserialize(Stream& is, prevector<N, T>& v)
# 855 : 1441386 : {
# 856 : 1441386 : Unserialize_impl(is, v, T());
# 857 : 1441386 : }
# 858 : :
# 859 : :
# 860 : :
# 861 : : /**
# 862 : : * vector
# 863 : : */
# 864 : : template<typename Stream, typename T, typename A>
# 865 : : void Serialize_impl(Stream& os, const std::vector<T, A>& v, const unsigned char&)
# 866 : 2842276 : {
# 867 : 2842276 : WriteCompactSize(os, v.size());
# 868 : 2842276 : if (!v.empty())
# 869 : 2838275 : os.write((char*)v.data(), v.size() * sizeof(T));
# 870 : 2842276 : }
# 871 : :
# 872 : : template<typename Stream, typename T, typename A>
# 873 : : void Serialize_impl(Stream& os, const std::vector<T, A>& v, const bool&)
# 874 : 28 : {
# 875 : 28 : // A special case for std::vector<bool>, as dereferencing
# 876 : 28 : // std::vector<bool>::const_iterator does not result in a const bool&
# 877 : 28 : // due to std::vector's special casing for bool arguments.
# 878 : 28 : WriteCompactSize(os, v.size());
# 879 : 12326 : for (bool elem : v) {
# 880 : 12326 : ::Serialize(os, elem);
# 881 : 12326 : }
# 882 : 28 : }
# 883 : :
# 884 : : template<typename Stream, typename T, typename A, typename V>
# 885 : : void Serialize_impl(Stream& os, const std::vector<T, A>& v, const V&)
# 886 : 8817127 : {
# 887 : 8817127 : Serialize(os, Using<VectorFormatter<DefaultFormatter>>(v));
# 888 : 8817127 : }
# 889 : :
# 890 : : template<typename Stream, typename T, typename A>
# 891 : : inline void Serialize(Stream& os, const std::vector<T, A>& v)
# 892 : 11659431 : {
# 893 : 11659431 : Serialize_impl(os, v, T());
# 894 : 11659431 : }
# 895 : :
# 896 : :
# 897 : : template<typename Stream, typename T, typename A>
# 898 : : void Unserialize_impl(Stream& is, std::vector<T, A>& v, const unsigned char&)
# 899 : 367691 : {
# 900 : 367691 : // Limit size per read so bogus size value won't cause out of memory
# 901 : 367691 : v.clear();
# 902 : 367691 : unsigned int nSize = ReadCompactSize(is);
# 903 : 367691 : unsigned int i = 0;
# 904 : 733327 : while (i < nSize)
# 905 : 365636 : {
# 906 : 365636 : unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
# 907 : 365636 : v.resize(i + blk);
# 908 : 365636 : is.read((char*)&v[i], blk * sizeof(T));
# 909 : 365636 : i += blk;
# 910 : 365636 : }
# 911 : 367691 : }
# 912 : :
# 913 : : template<typename Stream, typename T, typename A, typename V>
# 914 : : void Unserialize_impl(Stream& is, std::vector<T, A>& v, const V&)
# 915 : 989692 : {
# 916 : 989692 : Unserialize(is, Using<VectorFormatter<DefaultFormatter>>(v));
# 917 : 989692 : }
# 918 : :
# 919 : : template<typename Stream, typename T, typename A>
# 920 : : inline void Unserialize(Stream& is, std::vector<T, A>& v)
# 921 : 1357383 : {
# 922 : 1357383 : Unserialize_impl(is, v, T());
# 923 : 1357383 : }
# 924 : :
# 925 : :
# 926 : :
# 927 : : /**
# 928 : : * pair
# 929 : : */
# 930 : : template<typename Stream, typename K, typename T>
# 931 : : void Serialize(Stream& os, const std::pair<K, T>& item)
# 932 : 773505 : {
# 933 : 773505 : Serialize(os, item.first);
# 934 : 773505 : Serialize(os, item.second);
# 935 : 773505 : }
# 936 : :
# 937 : : template<typename Stream, typename K, typename T>
# 938 : : void Unserialize(Stream& is, std::pair<K, T>& item)
# 939 : 90521 : {
# 940 : 90521 : Unserialize(is, item.first);
# 941 : 90521 : Unserialize(is, item.second);
# 942 : 90521 : }
# 943 : :
# 944 : :
# 945 : :
# 946 : : /**
# 947 : : * map
# 948 : : */
# 949 : : template<typename Stream, typename K, typename T, typename Pred, typename A>
# 950 : : void Serialize(Stream& os, const std::map<K, T, Pred, A>& m)
# 951 : 141942 : {
# 952 : 141942 : WriteCompactSize(os, m.size());
# 953 : 141942 : for (const auto& entry : m)
# 954 : 421955 : Serialize(os, entry);
# 955 : 141942 : }
# 956 : :
# 957 : : template<typename Stream, typename K, typename T, typename Pred, typename A>
# 958 : : void Unserialize(Stream& is, std::map<K, T, Pred, A>& m)
# 959 : 10736 : {
# 960 : 10736 : m.clear();
# 961 : 10736 : unsigned int nSize = ReadCompactSize(is);
# 962 : 10736 : typename std::map<K, T, Pred, A>::iterator mi = m.begin();
# 963 : 41918 : for (unsigned int i = 0; i < nSize; i++)
# 964 : 31182 : {
# 965 : 31182 : std::pair<K, T> item;
# 966 : 31182 : Unserialize(is, item);
# 967 : 31182 : mi = m.insert(mi, item);
# 968 : 31182 : }
# 969 : 10736 : }
# 970 : :
# 971 : :
# 972 : :
# 973 : : /**
# 974 : : * set
# 975 : : */
# 976 : : template<typename Stream, typename K, typename Pred, typename A>
# 977 : : void Serialize(Stream& os, const std::set<K, Pred, A>& m)
# 978 : 467 : {
# 979 : 467 : WriteCompactSize(os, m.size());
# 980 : 667 : for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
# 981 : 200 : Serialize(os, (*it));
# 982 : 467 : }
# 983 : :
# 984 : : template<typename Stream, typename K, typename Pred, typename A>
# 985 : : void Unserialize(Stream& is, std::set<K, Pred, A>& m)
# 986 : 173 : {
# 987 : 173 : m.clear();
# 988 : 173 : unsigned int nSize = ReadCompactSize(is);
# 989 : 173 : typename std::set<K, Pred, A>::iterator it = m.begin();
# 990 : 212 : for (unsigned int i = 0; i < nSize; i++)
# 991 : 39 : {
# 992 : 39 : K key;
# 993 : 39 : Unserialize(is, key);
# 994 : 39 : it = m.insert(it, key);
# 995 : 39 : }
# 996 : 173 : }
# 997 : :
# 998 : :
# 999 : :
# 1000 : : /**
# 1001 : : * unique_ptr
# 1002 : : */
# 1003 : : template<typename Stream, typename T> void
# 1004 : : Serialize(Stream& os, const std::unique_ptr<const T>& p)
# 1005 : : {
# 1006 : : Serialize(os, *p);
# 1007 : : }
# 1008 : :
# 1009 : : template<typename Stream, typename T>
# 1010 : : void Unserialize(Stream& is, std::unique_ptr<const T>& p)
# 1011 : : {
# 1012 : : p.reset(new T(deserialize, is));
# 1013 : : }
# 1014 : :
# 1015 : :
# 1016 : :
# 1017 : : /**
# 1018 : : * shared_ptr
# 1019 : : */
# 1020 : : template<typename Stream, typename T> void
# 1021 : : Serialize(Stream& os, const std::shared_ptr<const T>& p)
# 1022 : 957656 : {
# 1023 : 957656 : Serialize(os, *p);
# 1024 : 957656 : }
# 1025 : :
# 1026 : : template<typename Stream, typename T>
# 1027 : : void Unserialize(Stream& is, std::shared_ptr<const T>& p)
# 1028 : 204045 : {
# 1029 : 204045 : p = std::make_shared<const T>(deserialize, is);
# 1030 : 204045 : }
# 1031 : :
# 1032 : :
# 1033 : :
# 1034 : : /**
# 1035 : : * Support for SERIALIZE_METHODS and READWRITE macro.
# 1036 : : */
# 1037 : : struct CSerActionSerialize
# 1038 : : {
# 1039 : 0 : constexpr bool ForRead() const { return false; }
# 1040 : : };
# 1041 : : struct CSerActionUnserialize
# 1042 : : {
# 1043 : 0 : constexpr bool ForRead() const { return true; }
# 1044 : : };
# 1045 : :
# 1046 : :
# 1047 : :
# 1048 : :
# 1049 : :
# 1050 : :
# 1051 : :
# 1052 : :
# 1053 : : /* ::GetSerializeSize implementations
# 1054 : : *
# 1055 : : * Computing the serialized size of objects is done through a special stream
# 1056 : : * object of type CSizeComputer, which only records the number of bytes written
# 1057 : : * to it.
# 1058 : : *
# 1059 : : * If your Serialize or SerializationOp method has non-trivial overhead for
# 1060 : : * serialization, it may be worthwhile to implement a specialized version for
# 1061 : : * CSizeComputer, which uses the s.seek() method to record bytes that would
# 1062 : : * be written instead.
# 1063 : : */
# 1064 : : class CSizeComputer
# 1065 : : {
# 1066 : : protected:
# 1067 : : size_t nSize;
# 1068 : :
# 1069 : : const int nVersion;
# 1070 : : public:
# 1071 : 1593286 : explicit CSizeComputer(int nVersionIn) : nSize(0), nVersion(nVersionIn) {}
# 1072 : :
# 1073 : : void write(const char *psz, size_t _nSize)
# 1074 : 20764917 : {
# 1075 : 20764917 : this->nSize += _nSize;
# 1076 : 20764917 : }
# 1077 : :
# 1078 : : /** Pretend _nSize bytes are written, without specifying them. */
# 1079 : : void seek(size_t _nSize)
# 1080 : 9350816 : {
# 1081 : 9350816 : this->nSize += _nSize;
# 1082 : 9350816 : }
# 1083 : :
# 1084 : : template<typename T>
# 1085 : : CSizeComputer& operator<<(const T& obj)
# 1086 : 6939427 : {
# 1087 : 6939427 : ::Serialize(*this, obj);
# 1088 : 6939427 : return (*this);
# 1089 : 6939427 : }
# 1090 : :
# 1091 : 1593286 : size_t size() const {
# 1092 : 1593286 : return nSize;
# 1093 : 1593286 : }
# 1094 : :
# 1095 : 1081066 : int GetVersion() const { return nVersion; }
# 1096 : : };
# 1097 : :
# 1098 : : template<typename Stream>
# 1099 : : void SerializeMany(Stream& s)
# 1100 : 144501778 : {
# 1101 : 144501778 : }
# 1102 : :
# 1103 : : template<typename Stream, typename Arg, typename... Args>
# 1104 : : void SerializeMany(Stream& s, const Arg& arg, const Args&... args)
# 1105 : 265628048 : {
# 1106 : 265628048 : ::Serialize(s, arg);
# 1107 : 265628048 : ::SerializeMany(s, args...);
# 1108 : 265628048 : }
# 1109 : :
# 1110 : : template<typename Stream>
# 1111 : : inline void UnserializeMany(Stream& s)
# 1112 : 4690192 : {
# 1113 : 4690192 : }
# 1114 : :
# 1115 : : template<typename Stream, typename Arg, typename... Args>
# 1116 : : inline void UnserializeMany(Stream& s, Arg&& arg, Args&&... args)
# 1117 : 8308611 : {
# 1118 : 8308611 : ::Unserialize(s, arg);
# 1119 : 8308611 : ::UnserializeMany(s, args...);
# 1120 : 8308611 : }
# 1121 : :
# 1122 : : template<typename Stream, typename... Args>
# 1123 : : inline void SerReadWriteMany(Stream& s, CSerActionSerialize ser_action, const Args&... args)
# 1124 : 144348133 : {
# 1125 : 144348133 : ::SerializeMany(s, args...);
# 1126 : 144348133 : }
# 1127 : :
# 1128 : : template<typename Stream, typename... Args>
# 1129 : : inline void SerReadWriteMany(Stream& s, CSerActionUnserialize ser_action, Args&&... args)
# 1130 : 4689408 : {
# 1131 : 4689408 : ::UnserializeMany(s, args...);
# 1132 : 4689408 : }
# 1133 : :
# 1134 : : template<typename Stream, typename Type, typename Fn>
# 1135 : : inline void SerRead(Stream& s, CSerActionSerialize ser_action, Type&&, Fn&&)
# 1136 : 10304 : {
# 1137 : 10304 : }
# 1138 : :
# 1139 : : template<typename Stream, typename Type, typename Fn>
# 1140 : : inline void SerRead(Stream& s, CSerActionUnserialize ser_action, Type&& obj, Fn&& fn)
# 1141 : 3646 : {
# 1142 : 3646 : fn(s, std::forward<Type>(obj));
# 1143 : 3646 : }
# 1144 : :
# 1145 : : template<typename Stream, typename Type, typename Fn>
# 1146 : : inline void SerWrite(Stream& s, CSerActionSerialize ser_action, Type&& obj, Fn&& fn)
# 1147 : 8345 : {
# 1148 : 8345 : fn(s, std::forward<Type>(obj));
# 1149 : 8345 : }
# 1150 : :
# 1151 : : template<typename Stream, typename Type, typename Fn>
# 1152 : : inline void SerWrite(Stream& s, CSerActionUnserialize ser_action, Type&&, Fn&&)
# 1153 : 624 : {
# 1154 : 624 : }
# 1155 : :
# 1156 : : template<typename I>
# 1157 : : inline void WriteVarInt(CSizeComputer &s, I n)
# 1158 : : {
# 1159 : : s.seek(GetSizeOfVarInt<I>(n));
# 1160 : : }
# 1161 : :
# 1162 : : inline void WriteCompactSize(CSizeComputer &s, uint64_t nSize)
# 1163 : 9350816 : {
# 1164 : 9350816 : s.seek(GetSizeOfCompactSize(nSize));
# 1165 : 9350816 : }
# 1166 : :
# 1167 : : template <typename T>
# 1168 : : size_t GetSerializeSize(const T& t, int nVersion = 0)
# 1169 : 1591265 : {
# 1170 : 1591265 : return (CSizeComputer(nVersion) << t).size();
# 1171 : 1591265 : }
# 1172 : :
# 1173 : : template <typename... T>
# 1174 : : size_t GetSerializeSizeMany(int nVersion, const T&... t)
# 1175 : 2021 : {
# 1176 : 2021 : CSizeComputer sc(nVersion);
# 1177 : 2021 : SerializeMany(sc, t...);
# 1178 : 2021 : return sc.size();
# 1179 : 2021 : }
# 1180 : :
# 1181 : : /** Wrapper that overrides the GetParams() function of a stream. */
# 1182 : : template<typename Params, typename Stream>
# 1183 : : class ParamsStream
# 1184 : : {
# 1185 : : const Params& m_params;
# 1186 : : Stream& m_substream;
# 1187 : : public:
# 1188 : 2990 : ParamsStream(const Params& params, Stream& substream) : m_params(params), m_substream(substream) {}
# 1189 : : template<typename U> inline ParamsStream& operator<<(const U& obj) { ::Serialize(*this, obj); return *this; }
# 1190 : : template<typename U> inline ParamsStream& operator>>(U&& obj) { ::Unserialize(*this, obj); return *this; }
# 1191 : 5175 : inline void write(const char* ptr, size_t size) { m_substream.write(ptr, size); }
# 1192 : 9335 : inline void read(char* ptr, size_t size) { m_substream.read(ptr, size); }
# 1193 : : inline size_t size() const { return m_substream.size(); }
# 1194 : 4272 : inline const Params& GetParams() { return m_params; }
# 1195 : : inline int GetVersion() const { return m_substream.GetVersion(); }
# 1196 : : inline int GetType() const { return m_substream.GetType(); }
# 1197 : : inline Stream& GetSubStream() const { return m_substream; }
# 1198 : : };
# 1199 : :
# 1200 : : /** Wrapper that serializes objects with the specified parameters. */
# 1201 : : template<typename Params, typename T>
# 1202 : : class ParamsWrapper
# 1203 : : {
# 1204 : : static_assert(std::is_lvalue_reference<T>::value, "ParamsWrapper needs an lvalue reference type T");
# 1205 : : const Params& m_params;
# 1206 : : T m_object;
# 1207 : :
# 1208 : : public:
# 1209 : 2990 : explicit ParamsWrapper(const Params& params, T obj) : m_params(params), m_object(obj) {}
# 1210 : :
# 1211 : : //! Serialize to another ParamsStream: optimize by skipping it.
# 1212 : : template<typename Stream, typename PrevParams>
# 1213 : : inline void Serialize(ParamsStream<PrevParams, Stream>& s) const
# 1214 : : {
# 1215 : : ParamsStream<Params, Stream> ss(m_params, s.GetSubStream());
# 1216 : : ::Serialize(ss, m_object);
# 1217 : : }
# 1218 : :
# 1219 : : //! Serialize to any other stream
# 1220 : : template<typename Stream>
# 1221 : : inline void Serialize(Stream& s) const
# 1222 : 1595 : {
# 1223 : 1595 : ParamsStream<Params, Stream> ss(m_params, s);
# 1224 : 1595 : ::Serialize(ss, m_object);
# 1225 : 1595 : }
# 1226 : :
# 1227 : : //! Deserialize from another ParamsStream: optimize by skipping it.
# 1228 : : template<typename Stream, typename PrevParams>
# 1229 : : inline void Unserialize(ParamsStream<PrevParams, Stream>& s)
# 1230 : : {
# 1231 : : ParamsStream<Params, Stream> ss(m_params, s.GetSubStream());
# 1232 : : ::Unserialize(ss, m_object);
# 1233 : : }
# 1234 : :
# 1235 : : //! Deserialize from any other stream
# 1236 : : template<typename Stream>
# 1237 : : inline void Unserialize(Stream& s)
# 1238 : 1395 : {
# 1239 : 1395 : ParamsStream<Params, Stream> ss(m_params, s);
# 1240 : 1395 : ::Unserialize(ss, m_object);
# 1241 : 1395 : }
# 1242 : : };
# 1243 : :
# 1244 : : /** Return a wrapper around t that (de)serializes it with specified parameter params.
# 1245 : : *
# 1246 : : * See FORMATTER_METHODS_PARAMS for more information on serialization parameters.
# 1247 : : */
# 1248 : : template<typename Params, typename T>
# 1249 : 2990 : static inline ParamsWrapper<Params, T&> WithParams(const Params& params, T&& t) { return ParamsWrapper<Params, T&>(params, t); }
# 1250 : :
# 1251 : : #endif // BITCOIN_SERIALIZE_H
|
