// Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-2020 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_SERIALIZE_H #define BITCOIN_SERIALIZE_H #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /** * The maximum size of a serialized object in bytes or number of elements * (for eg vectors) when the size is encoded as CompactSize. */ static constexpr uint64_t MAX_SIZE = 0x02000000; /** Maximum amount of memory (in bytes) to allocate at once when deserializing vectors. */ static const unsigned int MAX_VECTOR_ALLOCATE = 5000000; /** * Dummy data type to identify deserializing constructors. * * By convention, a constructor of a type T with signature * * template T::T(deserialize_type, Stream& s) * * is a deserializing constructor, which builds the type by * deserializing it from s. If T contains const fields, this * is likely the only way to do so. */ struct deserialize_type {}; constexpr deserialize_type deserialize {}; /* * Lowest-level serialization and conversion. */ template inline void ser_writedata8(Stream &s, uint8_t obj) { s.write(AsBytes(Span{&obj, 1})); } template inline void ser_writedata16(Stream &s, uint16_t obj) { obj = htole16(obj); s.write(AsBytes(Span{&obj, 1})); } template inline void ser_writedata16be(Stream &s, uint16_t obj) { obj = htobe16(obj); s.write(AsBytes(Span{&obj, 1})); } template inline void ser_writedata32(Stream &s, uint32_t obj) { obj = htole32(obj); s.write(AsBytes(Span{&obj, 1})); } template inline void ser_writedata32be(Stream &s, uint32_t obj) { obj = htobe32(obj); s.write(AsBytes(Span{&obj, 1})); } template inline void ser_writedata64(Stream &s, uint64_t obj) { obj = htole64(obj); s.write(AsBytes(Span{&obj, 1})); } template inline uint8_t ser_readdata8(Stream &s) { uint8_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return obj; } template inline uint16_t ser_readdata16(Stream &s) { uint16_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return le16toh(obj); } template inline uint16_t ser_readdata16be(Stream &s) { uint16_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return be16toh(obj); } template inline uint32_t ser_readdata32(Stream &s) { uint32_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return le32toh(obj); } template inline uint32_t ser_readdata32be(Stream &s) { uint32_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return be32toh(obj); } template inline uint64_t ser_readdata64(Stream &s) { uint64_t obj; s.read(AsWritableBytes(Span{&obj, 1})); return le64toh(obj); } ///////////////////////////////////////////////////////////////// // // Templates for serializing to anything that looks like a stream, // i.e. anything that supports .read(Span) and .write(Span) // class CSizeComputer; enum { // primary actions SER_NETWORK = (1 << 0), SER_DISK = (1 << 1), SER_GETHASH = (1 << 2), }; //! Convert the reference base type to X, without changing constness or reference type. template X& ReadWriteAsHelper(X& x) { return x; } template const X& ReadWriteAsHelper(const X& x) { return x; } #define READWRITE(...) (::SerReadWriteMany(s, ser_action, __VA_ARGS__)) #define READWRITEAS(type, obj) (::SerReadWriteMany(s, ser_action, ReadWriteAsHelper(obj))) #define SER_READ(obj, code) ::SerRead(s, ser_action, obj, [&](Stream& s, typename std::remove_const::type& obj) { code; }) #define SER_WRITE(obj, code) ::SerWrite(s, ser_action, obj, [&](Stream& s, const Type& obj) { code; }) /** * Implement the Ser and Unser methods needed for implementing a formatter (see Using below). * * Both Ser and Unser are delegated to a single static method SerializationOps, which is polymorphic * in the serialized/deserialized type (allowing it to be const when serializing, and non-const when * deserializing). * * Example use: * struct FooFormatter { * FORMATTER_METHODS(Class, obj) { READWRITE(obj.val1, VARINT(obj.val2)); } * } * would define a class FooFormatter that defines a serialization of Class objects consisting * of serializing its val1 member using the default serialization, and its val2 member using * VARINT serialization. That FooFormatter can then be used in statements like * READWRITE(Using(obj.bla)). */ #define FORMATTER_METHODS(cls, obj) \ template \ static void Ser(Stream& s, const cls& obj) { SerializationOps(obj, s, CSerActionSerialize()); } \ template \ static void Unser(Stream& s, cls& obj) { SerializationOps(obj, s, CSerActionUnserialize()); } \ template \ static inline void SerializationOps(Type& obj, Stream& s, Operation ser_action) \ /** * Implement the Serialize and Unserialize methods by delegating to a single templated * static method that takes the to-be-(de)serialized object as a parameter. This approach * has the advantage that the constness of the object becomes a template parameter, and * thus allows a single implementation that sees the object as const for serializing * and non-const for deserializing, without casts. */ #define SERIALIZE_METHODS(cls, obj) \ template \ void Serialize(Stream& s) const \ { \ static_assert(std::is_same::value, "Serialize type mismatch"); \ Ser(s, *this); \ } \ template \ void Unserialize(Stream& s) \ { \ static_assert(std::is_same::value, "Unserialize type mismatch"); \ Unser(s, *this); \ } \ FORMATTER_METHODS(cls, obj) // clang-format off #ifndef CHAR_EQUALS_INT8 template void Serialize(Stream&, char) = delete; // char serialization forbidden. Use uint8_t or int8_t #endif template void Serialize(Stream& s, std::byte a) { ser_writedata8(s, uint8_t(a)); } template inline void Serialize(Stream& s, int8_t a ) { ser_writedata8(s, a); } template inline void Serialize(Stream& s, uint8_t a ) { ser_writedata8(s, a); } template inline void Serialize(Stream& s, int16_t a ) { ser_writedata16(s, a); } template inline void Serialize(Stream& s, uint16_t a) { ser_writedata16(s, a); } template inline void Serialize(Stream& s, int32_t a ) { ser_writedata32(s, a); } template inline void Serialize(Stream& s, uint32_t a) { ser_writedata32(s, a); } template inline void Serialize(Stream& s, int64_t a ) { ser_writedata64(s, a); } template inline void Serialize(Stream& s, uint64_t a) { ser_writedata64(s, a); } template inline void Serialize(Stream& s, const char (&a)[N]) { s.write(MakeByteSpan(a)); } template inline void Serialize(Stream& s, const unsigned char (&a)[N]) { s.write(MakeByteSpan(a)); } template void Serialize(Stream& s, Span span) { (void)/* force byte-type */UCharCast(span.data()); s.write(AsBytes(span)); } #ifndef CHAR_EQUALS_INT8 template void Unserialize(Stream&, char) = delete; // char serialization forbidden. Use uint8_t or int8_t #endif template void Unserialize(Stream& s, std::byte& a) { a = std::byte{ser_readdata8(s)}; } template inline void Unserialize(Stream& s, int8_t& a ) { a = ser_readdata8(s); } template inline void Unserialize(Stream& s, uint8_t& a ) { a = ser_readdata8(s); } template inline void Unserialize(Stream& s, int16_t& a ) { a = ser_readdata16(s); } template inline void Unserialize(Stream& s, uint16_t& a) { a = ser_readdata16(s); } template inline void Unserialize(Stream& s, int32_t& a ) { a = ser_readdata32(s); } template inline void Unserialize(Stream& s, uint32_t& a) { a = ser_readdata32(s); } template inline void Unserialize(Stream& s, int64_t& a ) { a = ser_readdata64(s); } template inline void Unserialize(Stream& s, uint64_t& a) { a = ser_readdata64(s); } template inline void Unserialize(Stream& s, char (&a)[N]) { s.read(MakeWritableByteSpan(a)); } template inline void Unserialize(Stream& s, unsigned char (&a)[N]) { s.read(MakeWritableByteSpan(a)); } template void Unserialize(Stream& s, Span span) { (void)/* force byte-type */UCharCast(span.data()); s.read(AsWritableBytes(span)); } template inline void Serialize(Stream& s, bool a) { uint8_t f = a; ser_writedata8(s, f); } template inline void Unserialize(Stream& s, bool& a) { uint8_t f = ser_readdata8(s); a = f; } // clang-format on /** * Compact Size * size < 253 -- 1 byte * size <= USHRT_MAX -- 3 bytes (253 + 2 bytes) * size <= UINT_MAX -- 5 bytes (254 + 4 bytes) * size > UINT_MAX -- 9 bytes (255 + 8 bytes) */ inline unsigned int GetSizeOfCompactSize(uint64_t nSize) { if (nSize < 253) return sizeof(unsigned char); else if (nSize <= std::numeric_limits::max()) return sizeof(unsigned char) + sizeof(uint16_t); else if (nSize <= std::numeric_limits::max()) return sizeof(unsigned char) + sizeof(unsigned int); else return sizeof(unsigned char) + sizeof(uint64_t); } inline void WriteCompactSize(CSizeComputer& os, uint64_t nSize); template void WriteCompactSize(Stream& os, uint64_t nSize) { if (nSize < 253) { ser_writedata8(os, nSize); } else if (nSize <= std::numeric_limits::max()) { ser_writedata8(os, 253); ser_writedata16(os, nSize); } else if (nSize <= std::numeric_limits::max()) { ser_writedata8(os, 254); ser_writedata32(os, nSize); } else { ser_writedata8(os, 255); ser_writedata64(os, nSize); } return; } /** * Decode a CompactSize-encoded variable-length integer. * * As these are primarily used to encode the size of vector-like serializations, by default a range * check is performed. When used as a generic number encoding, range_check should be set to false. */ template uint64_t ReadCompactSize(Stream& is, bool range_check = true) { uint8_t chSize = ser_readdata8(is); uint64_t nSizeRet = 0; if (chSize < 253) { nSizeRet = chSize; } else if (chSize == 253) { nSizeRet = ser_readdata16(is); if (nSizeRet < 253) throw std::ios_base::failure("non-canonical ReadCompactSize()"); } else if (chSize == 254) { nSizeRet = ser_readdata32(is); if (nSizeRet < 0x10000u) throw std::ios_base::failure("non-canonical ReadCompactSize()"); } else { nSizeRet = ser_readdata64(is); if (nSizeRet < 0x100000000ULL) throw std::ios_base::failure("non-canonical ReadCompactSize()"); } if (range_check && nSizeRet > MAX_SIZE) { throw std::ios_base::failure("ReadCompactSize(): size too large"); } return nSizeRet; } /** * Variable-length integers: bytes are a MSB base-128 encoding of the number. * The high bit in each byte signifies whether another digit follows. To make * sure the encoding is one-to-one, one is subtracted from all but the last digit. * Thus, the byte sequence a[] with length len, where all but the last byte * has bit 128 set, encodes the number: * * (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1)) * * Properties: * * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes) * * Every integer has exactly one encoding * * Encoding does not depend on size of original integer type * * No redundancy: every (infinite) byte sequence corresponds to a list * of encoded integers. * * 0: [0x00] 256: [0x81 0x00] * 1: [0x01] 16383: [0xFE 0x7F] * 127: [0x7F] 16384: [0xFF 0x00] * 128: [0x80 0x00] 16511: [0xFF 0x7F] * 255: [0x80 0x7F] 65535: [0x82 0xFE 0x7F] * 2^32: [0x8E 0xFE 0xFE 0xFF 0x00] */ /** * Mode for encoding VarInts. * * Currently there is no support for signed encodings. The default mode will not * compile with signed values, and the legacy "nonnegative signed" mode will * accept signed values, but improperly encode and decode them if they are * negative. In the future, the DEFAULT mode could be extended to support * negative numbers in a backwards compatible way, and additional modes could be * added to support different varint formats (e.g. zigzag encoding). */ enum class VarIntMode { DEFAULT, NONNEGATIVE_SIGNED }; template struct CheckVarIntMode { constexpr CheckVarIntMode() { static_assert(Mode != VarIntMode::DEFAULT || std::is_unsigned::value, "Unsigned type required with mode DEFAULT."); static_assert(Mode != VarIntMode::NONNEGATIVE_SIGNED || std::is_signed::value, "Signed type required with mode NONNEGATIVE_SIGNED."); } }; template inline unsigned int GetSizeOfVarInt(I n) { CheckVarIntMode(); int nRet = 0; while(true) { nRet++; if (n <= 0x7F) break; n = (n >> 7) - 1; } return nRet; } template inline void WriteVarInt(CSizeComputer& os, I n); template void WriteVarInt(Stream& os, I n) { CheckVarIntMode(); unsigned char tmp[(sizeof(n)*8+6)/7]; int len=0; while(true) { tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00); if (n <= 0x7F) break; n = (n >> 7) - 1; len++; } do { ser_writedata8(os, tmp[len]); } while(len--); } template I ReadVarInt(Stream& is) { CheckVarIntMode(); I n = 0; while(true) { unsigned char chData = ser_readdata8(is); if (n > (std::numeric_limits::max() >> 7)) { throw std::ios_base::failure("ReadVarInt(): size too large"); } n = (n << 7) | (chData & 0x7F); if (chData & 0x80) { if (n == std::numeric_limits::max()) { throw std::ios_base::failure("ReadVarInt(): size too large"); } n++; } else { return n; } } } /** TODO: describe FixedBitSet */ inline unsigned int GetSizeOfFixedBitSet(size_t size) { return (size + 7) / 8; } template void WriteFixedBitSet(Stream& s, const std::vector& vec, size_t size) { std::vector vBytes((size + 7) / 8); size_t ms = std::min(size, vec.size()); for (size_t p = 0; p < ms; p++) vBytes[p / 8] |= vec[p] << (p % 8); s.write(AsBytes(Span{vBytes})); } template void ReadFixedBitSet(Stream& s, std::vector& vec, size_t size) { vec.resize(size); std::vector vBytes((size + 7) / 8); s.read(AsWritableBytes(Span{vBytes})); for (size_t p = 0; p < size; p++) vec[p] = (vBytes[p / 8] & (1 << (p % 8))) != 0; if (vBytes.size() * 8 != size) { size_t rem = vBytes.size() * 8 - size; uint8_t m = ~(uint8_t)(0xff >> rem); if (vBytes[vBytes.size() - 1] & m) { throw std::ios_base::failure("Out-of-range bits set"); } } } /** * Stores a fixed size bitset as a series of VarInts. Each VarInt is an offset from the last entry and the sum of the * last entry and the offset gives an index into the bitset for a set bit. The series of VarInts ends with a 0. */ template void WriteFixedVarIntsBitSet(Stream& s, const std::vector& vec, size_t size) { int32_t last = -1; for (int32_t i = 0; i < (int32_t)vec.size(); i++) { if (vec[i]) { WriteVarInt(s, (uint32_t)(i - last)); last = i; } } WriteVarInt(s, 0); // stopper } template void ReadFixedVarIntsBitSet(Stream& s, std::vector& vec, size_t size) { vec.assign(size, false); int32_t last = -1; while(true) { uint32_t offset = ReadVarInt(s); if (offset == 0) { break; } int32_t idx = last + offset; if (idx >= int32_t(size)) { throw std::ios_base::failure("out of bounds index"); } if (last != -1 && idx <= last) { throw std::ios_base::failure("offset overflow"); } vec[idx] = true; last = idx; } } /** * Serializes either as a CFixedBitSet or CFixedVarIntsBitSet, depending on which would give a smaller size */ typedef std::pair, size_t> autobitset_t; struct CFixedBitSet { const std::vector& vec; size_t size; CFixedBitSet(const std::vector& vecIn, size_t sizeIn) : vec(vecIn), size(sizeIn) {} template void Serialize(Stream& s) const { WriteFixedBitSet(s, vec, size); } }; struct CFixedVarIntsBitSet { const std::vector& vec; size_t size; CFixedVarIntsBitSet(const std::vector& vecIn, size_t sizeIn) : vec(vecIn), size(sizeIn) {} template void Serialize(Stream& s) const { WriteFixedVarIntsBitSet(s, vec, vec.size()); } }; /* Forward declaration for WriteAutoBitSet */ template size_t GetSerializeSize(const T& t, int nVersion = 0); template void WriteAutoBitSet(Stream& s, const autobitset_t& item) { auto& vec = item.first; auto& size = item.second; assert(vec.size() == size); size_t size1 = ::GetSerializeSize(CFixedBitSet(vec, size), s.GetVersion()); size_t size2 = ::GetSerializeSize(CFixedVarIntsBitSet(vec, size), s.GetVersion()); assert(size1 == GetSizeOfFixedBitSet(size)); if (size1 < size2) { ser_writedata8(s, 0); WriteFixedBitSet(s, vec, vec.size()); } else { ser_writedata8(s, 1); WriteFixedVarIntsBitSet(s, vec, vec.size()); } } template void ReadAutoBitSet(Stream& s, autobitset_t& item) { uint8_t isVarInts = ser_readdata8(s); if (isVarInts != 0 && isVarInts != 1) { throw std::ios_base::failure("invalid value for isVarInts byte"); } auto& vec = item.first; auto& size = item.second; if (!isVarInts) { ReadFixedBitSet(s, vec, size); } else { ReadFixedVarIntsBitSet(s, vec, size); } } /** Simple wrapper class to serialize objects using a formatter; used by Using(). */ template class Wrapper { static_assert(std::is_lvalue_reference::value, "Wrapper needs an lvalue reference type T"); protected: T m_object; public: explicit Wrapper(T obj) : m_object(obj) {} template void Serialize(Stream &s) const { Formatter().Ser(s, m_object); } template void Unserialize(Stream &s) { Formatter().Unser(s, m_object); } }; /** Cause serialization/deserialization of an object to be done using a specified formatter class. * * To use this, you need a class Formatter that has public functions Ser(stream, const object&) for * serialization, and Unser(stream, object&) for deserialization. Serialization routines (inside * READWRITE, or directly with << and >> operators), can then use Using(object). * * This works by constructing a Wrapper-wrapped version of object, where T is * const during serialization, and non-const during deserialization, which maintains const * correctness. */ template static inline Wrapper Using(T&& t) { return Wrapper(t); } #define DYNBITSET(obj) Using(obj) #define AUTOBITSET(obj) Using(obj) #define VARINT_MODE(obj, mode) Using>(obj) #define VARINT(obj) Using>(obj) #define COMPACTSIZE(obj) Using>(obj) #define LIMITED_STRING(obj,n) Using>(obj) /** TODO: describe DynamicBitSet */ struct DynamicBitSetFormatter { template void Ser(Stream& s, const std::vector& vec) const { WriteCompactSize(s, vec.size()); WriteFixedBitSet(s, vec, vec.size()); } template void Unser(Stream& s, std::vector& vec) { ReadFixedBitSet(s, vec, ReadCompactSize(s)); } }; /** * Serializes either as a CFixedBitSet or CFixedVarIntsBitSet, depending on which would give a smaller size */ struct AutoBitSetFormatter { template void Ser(Stream& s, const autobitset_t& item) const { WriteAutoBitSet(s, item); } template void Unser(Stream& s, autobitset_t& item) { ReadAutoBitSet(s, item); } }; /** Serialization wrapper class for integers in VarInt format. */ template struct VarIntFormatter { template void Ser(Stream &s, I v) { WriteVarInt::type>(s, v); } template void Unser(Stream& s, I& v) { v = ReadVarInt::type>(s); } }; /** Serialization wrapper class for custom integers and enums. * * It permits specifying the serialized size (1 to 8 bytes) and endianness. * * Use the big endian mode for values that are stored in memory in native * byte order, but serialized in big endian notation. This is only intended * to implement serializers that are compatible with existing formats, and * its use is not recommended for new data structures. */ template struct CustomUintFormatter { static_assert(Bytes > 0 && Bytes <= 8, "CustomUintFormatter Bytes out of range"); static constexpr uint64_t MAX = 0xffffffffffffffff >> (8 * (8 - Bytes)); template void Ser(Stream& s, I v) { if (v < 0 || v > MAX) throw std::ios_base::failure("CustomUintFormatter value out of range"); if (BigEndian) { uint64_t raw = htobe64(v); s.write({BytePtr(&raw) + 8 - Bytes, Bytes}); } else { uint64_t raw = htole64(v); s.write({BytePtr(&raw), Bytes}); } } template void Unser(Stream& s, I& v) { using U = typename std::conditional::value, std::underlying_type, std::common_type>::type::type; static_assert(std::numeric_limits::max() >= MAX && std::numeric_limits::min() <= 0, "Assigned type too small"); uint64_t raw = 0; if (BigEndian) { s.read({BytePtr(&raw) + 8 - Bytes, Bytes}); v = static_cast(be64toh(raw)); } else { s.read({BytePtr(&raw), Bytes}); v = static_cast(le64toh(raw)); } } }; template using BigEndianFormatter = CustomUintFormatter; /** Formatter for integers in CompactSize format. */ template struct CompactSizeFormatter { template void Unser(Stream& s, I& v) { uint64_t n = ReadCompactSize(s, RangeCheck); if (n < std::numeric_limits::min() || n > std::numeric_limits::max()) { throw std::ios_base::failure("CompactSize exceeds limit of type"); } v = n; } template void Ser(Stream& s, I v) { static_assert(std::is_unsigned::value, "CompactSize only supported for unsigned integers"); static_assert(std::numeric_limits::max() <= std::numeric_limits::max(), "CompactSize only supports 64-bit integers and below"); WriteCompactSize(s, v); } }; template struct LimitedStringFormatter { template void Unser(Stream& s, std::string& v) { size_t size = ReadCompactSize(s); if (size > Limit) { throw std::ios_base::failure("String length limit exceeded"); } v.resize(size); if (size != 0) s.read(MakeWritableByteSpan(v)); } template void Ser(Stream& s, const std::string& v) { s << v; } }; /** Formatter to serialize/deserialize vector elements using another formatter * * Example: * struct X { * std::vector v; * SERIALIZE_METHODS(X, obj) { READWRITE(Using>(obj.v)); } * }; * will define a struct that contains a vector of uint64_t, which is serialized * as a vector of VarInt-encoded integers. * * V is not required to be an std::vector type. It works for any class that * exposes a value_type, size, reserve, emplace_back, back, and const iterators. */ template struct VectorFormatter { template void Ser(Stream& s, const V& v) { Formatter formatter; WriteCompactSize(s, v.size()); for (const typename V::value_type& elem : v) { formatter.Ser(s, elem); } } template void Unser(Stream& s, V& v) { Formatter formatter; v.clear(); size_t size = ReadCompactSize(s); size_t allocated = 0; while (allocated < size) { // For DoS prevention, do not blindly allocate as much as the stream claims to contain. // Instead, allocate in 5MiB batches, so that an attacker actually needs to provide // X MiB of data to make us allocate X+5 Mib. static_assert(sizeof(typename V::value_type) <= MAX_VECTOR_ALLOCATE, "Vector element size too large"); allocated = std::min(size, allocated + MAX_VECTOR_ALLOCATE / sizeof(typename V::value_type)); v.reserve(allocated); while (v.size() < allocated) { v.emplace_back(); formatter.Unser(s, v.back()); } } }; }; /** * Forward declarations */ /** * string */ template void Serialize(Stream& os, const std::basic_string& str); template void Unserialize(Stream& is, std::basic_string& str); /** * prevector * prevectors of unsigned char are a special case and are intended to be serialized as a single opaque blob. */ template void Serialize_impl(Stream& os, const prevector& v, const unsigned char&); template void Serialize_impl(Stream& os, const prevector& v, const V&); template inline void Serialize(Stream& os, const prevector& v); template void Unserialize_impl(Stream& is, prevector& v, const unsigned char&); template void Unserialize_impl(Stream& is, prevector& v, const V&); template inline void Unserialize(Stream& is, prevector& v); /** * vector * vectors of unsigned char are a special case and are intended to be serialized as a single opaque blob. */ template void Serialize_impl(Stream& os, const std::vector& v, const unsigned char&); template void Serialize_impl(Stream& os, const std::vector& v, const bool&); template void Serialize_impl(Stream& os, const std::vector& v, const V&); template inline void Serialize(Stream& os, const std::vector& v); template void Unserialize_impl(Stream& is, std::vector& v, const unsigned char&); template void Unserialize_impl(Stream& is, std::vector& v, const V&); template inline void Unserialize(Stream& is, std::vector& v); /** * pair */ template void Serialize(Stream& os, const std::pair& item); template void Unserialize(Stream& is, std::pair& item); /** * pair */ template void Serialize(Stream& os, const std::tuple& item); template void Unserialize(Stream& is, std::tuple& item); /** * map */ template void Serialize(Stream& os, const std::map& m); template void Unserialize(Stream& is, std::map& m); template void Serialize(Stream& os, const std::unordered_map& m); template void Unserialize(Stream& is, std::unordered_map& m); /** * set */ template void Serialize(Stream& os, const std::set& m); template void Unserialize(Stream& is, std::set& m); template void Serialize(Stream& os, const std::unordered_set& m); template void Unserialize(Stream& is, std::unordered_set& m); /** * shared_ptr */ template void Serialize(Stream& os, const std::shared_ptr& p); template void Unserialize(Stream& os, std::shared_ptr& p); /** * unique_ptr */ template void Serialize(Stream& os, const std::unique_ptr& p); template void Unserialize(Stream& os, std::unique_ptr& p); /** * atomic */ template void Serialize(Stream& os, const std::atomic& a); template void Unserialize(Stream& is, std::atomic& a); /** * If none of the specialized versions above matched and T is a class, default to calling member function. */ template::value>::type* = nullptr> inline void Serialize(Stream& os, const T& a) { a.Serialize(os); } template >::value>::type* = nullptr> inline void Unserialize(Stream& is, T&& a) { a.Unserialize(is); } /** * If none of the specialized versions above matched and T is an enum, default to calling * Serialize/Unserialze with the underlying type. This is only allowed when a specialized struct of is_serializable_enum * is found which derives from std::true_type. This is to ensure that enums are not serialized with the wrong type by * accident. */ template struct is_serializable_enum; template struct is_serializable_enum : std::false_type {}; template::value>::type* = nullptr> inline void Serialize(Stream& s, const T& a ) { // If you ever get into this situation, it usaully means you forgot to declare is_serializable_enum for the desired enum type static_assert(is_serializable_enum::value, "Missing declararion of is_serializable_enum"); typedef typename std::underlying_type::type T2; T2 b = (T2)a; Serialize(s, b); } template::value>::type* = nullptr> inline void Unserialize(Stream& s, T& a ) { // If you ever get into this situation, it usaully means you forgot to declare is_serializable_enum for the desired enum type static_assert(is_serializable_enum::value, "Missing declararion of is_serializable_enum"); typedef typename std::underlying_type::type T2; T2 b; Unserialize(s, b); a = (T)b; } /** Default formatter. Serializes objects as themselves. * * The vector/prevector serialization code passes this to VectorFormatter * to enable reusing that logic. It shouldn't be needed elsewhere. */ struct DefaultFormatter { template static void Ser(Stream& s, const T& t) { Serialize(s, t); } template static void Unser(Stream& s, T& t) { Unserialize(s, t); } }; /** * string */ template void Serialize(Stream& os, const std::basic_string& str) { WriteCompactSize(os, str.size()); if (!str.empty()) os.write(MakeByteSpan(str)); } template void Unserialize(Stream& is, std::basic_string& str) { unsigned int nSize = ReadCompactSize(is); str.resize(nSize); if (nSize != 0) is.read(MakeWritableByteSpan(str)); } /** * string_view */ template void Serialize(Stream& os, const std::basic_string_view& str) { WriteCompactSize(os, str.size()); if (!str.empty()) os.write(AsBytes(Span{str.data(), str.size() * sizeof(C)})); } template void Unserialize(Stream& is, std::basic_string_view& str) { unsigned int nSize = ReadCompactSize(is); str.resize(nSize); if (nSize != 0) is.read(AsWritableBytes(Span{str.data(), nSize * sizeof(C)})); } /** * prevector */ template void Serialize_impl(Stream& os, const prevector& v, const unsigned char&) { WriteCompactSize(os, v.size()); if (!v.empty()) os.write(MakeByteSpan(v)); } template void Serialize_impl(Stream& os, const prevector& v, const V&) { Serialize(os, Using>(v)); } template inline void Serialize(Stream& os, const prevector& v) { Serialize_impl(os, v, T()); } template void Unserialize_impl(Stream& is, prevector& v, const unsigned char&) { // Limit size per read so bogus size value won't cause out of memory v.clear(); unsigned int nSize = ReadCompactSize(is); unsigned int i = 0; while (i < nSize) { unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T))); v.resize_uninitialized(i + blk); is.read(AsWritableBytes(Span{&v[i], blk})); i += blk; } } template void Unserialize_impl(Stream& is, prevector& v, const V&) { Unserialize(is, Using>(v)); } template inline void Unserialize(Stream& is, prevector& v) { Unserialize_impl(is, v, T()); } /** * vector */ template void Serialize_impl(Stream& os, const std::vector& v, const unsigned char&) { WriteCompactSize(os, v.size()); if (!v.empty()) os.write(MakeByteSpan(v)); } template void Serialize_impl(Stream& os, const std::vector& v, const bool&) { // A special case for std::vector, as dereferencing // std::vector::const_iterator does not result in a const bool& // due to std::vector's special casing for bool arguments. WriteCompactSize(os, v.size()); for (bool elem : v) { ::Serialize(os, elem); } } template void Serialize_impl(Stream& os, const std::vector& v, const V&) { Serialize(os, Using>(v)); } template inline void Serialize(Stream& os, const std::vector& v) { Serialize_impl(os, v, T()); } template void Unserialize_impl(Stream& is, std::vector& v, const unsigned char&) { // Limit size per read so bogus size value won't cause out of memory v.clear(); unsigned int nSize = ReadCompactSize(is); unsigned int i = 0; while (i < nSize) { unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T))); v.resize(i + blk); is.read(AsWritableBytes(Span{&v[i], blk})); i += blk; } } template void Unserialize_impl(Stream& is, std::vector& v, const V&) { Unserialize(is, Using>(v)); } template inline void Unserialize(Stream& is, std::vector& v) { Unserialize_impl(is, v, T()); } /** * pair */ template void Serialize(Stream& os, const std::pair& item) { Serialize(os, item.first); Serialize(os, item.second); } template void Unserialize(Stream& is, std::pair& item) { Unserialize(is, item.first); Unserialize(is, item.second); } /** * tuple */ template struct SerializeTuple { void operator() (Stream&s, std::tuple& t) { SerializeTuple{}(s, t); s << std::get(t); } }; template struct SerializeTuple { void operator() (Stream&s, std::tuple& t) { s << std::get<0>(t); } }; template struct DeserializeTuple { void operator() (Stream&s, std::tuple& t) { DeserializeTuple{}(s, t); s >> std::get(t); } }; template struct DeserializeTuple { void operator() (Stream&s, std::tuple& t) { s >> std::get<0>(t); } }; template void Serialize(Stream& os, const std::tuple& item) { const auto size = std::tuple_size>::value; SerializeTuple{}(os, const_cast&>(item)); } template void Unserialize(Stream& is, std::tuple& item) { const auto size = std::tuple_size>::value; DeserializeTuple{}(is, item); } /** * map */ template void SerializeMap(Stream& os, const Map& m) { WriteCompactSize(os, m.size()); for (const auto& entry : m) Serialize(os, entry); } template void UnserializeMap(Stream& is, Map& m) { m.clear(); unsigned int nSize = ReadCompactSize(is); auto mi = m.begin(); for (unsigned int i = 0; i < nSize; i++) { std::pair::type, typename std::remove_const::type> item; Unserialize(is, item); mi = m.insert(mi, item); } } template void Serialize(Stream& os, const std::map& m) { SerializeMap(os, m); } template void Unserialize(Stream& is, std::map& m) { UnserializeMap(is, m); } template void Serialize(Stream& os, const std::unordered_map& m) { SerializeMap(os, m); } template void Unserialize(Stream& is, std::unordered_map& m) { UnserializeMap(is, m); } /** * set */ template void SerializeSet(Stream& os, const Set& m) { WriteCompactSize(os, m.size()); for (auto it = m.begin(); it != m.end(); ++it) Serialize(os, (*it)); } template void UnserializeSet(Stream& is, Set& m) { m.clear(); unsigned int nSize = ReadCompactSize(is); auto it = m.begin(); for (unsigned int i = 0; i < nSize; i++) { typename std::remove_const::type key; Unserialize(is, key); it = m.insert(it, key); } } template void Serialize(Stream& os, const std::set& m) { SerializeSet(os, m); } template void Unserialize(Stream& is, std::set& m) { UnserializeSet(is, m); } template void Serialize(Stream& os, const std::unordered_set& m) { SerializeSet(os, m); } template void Unserialize(Stream& is, std::unordered_set& m) { UnserializeSet(is, m); } /** * list */ template void Serialize(Stream& os, const std::list& l) { WriteCompactSize(os, l.size()); for (typename std::list::const_iterator it = l.begin(); it != l.end(); ++it) Serialize(os, (*it)); } template void Unserialize(Stream& is, std::list& l) { l.clear(); unsigned int nSize = ReadCompactSize(is); for (unsigned int i = 0; i < nSize; i++) { T val; Unserialize(is, val); l.push_back(val); } } /** * unique_ptr */ template void Serialize(Stream& os, const std::unique_ptr& p) { Serialize(os, *p); } template void Unserialize(Stream& is, std::unique_ptr& p) { p.reset(new T(deserialize, is)); } /** * shared_ptr */ template void Serialize(Stream& os, const std::shared_ptr& p) { Serialize(os, *p); } template void Unserialize(Stream& is, std::shared_ptr& p) { p = std::make_shared(deserialize, is); } /** * atomic */ template void Serialize(Stream& os, const std::atomic& a) { Serialize(os, a.load()); } template void Unserialize(Stream& is, std::atomic& a) { T val; Unserialize(is, val); a.store(val); } /** * Support for SERIALIZE_METHODS and READWRITE macro. */ struct CSerActionSerialize { constexpr bool ForRead() const { return false; } }; struct CSerActionUnserialize { constexpr bool ForRead() const { return true; } }; /* ::GetSerializeSize implementations * * Computing the serialized size of objects is done through a special stream * object of type CSizeComputer, which only records the number of bytes written * to it. * * If your Serialize or SerializationOp method has non-trivial overhead for * serialization, it may be worthwhile to implement a specialized version for * CSizeComputer, which uses the s.seek() method to record bytes that would * be written instead. */ class CSizeComputer { protected: size_t nSize; const int nVersion; public: explicit CSizeComputer(int nVersionIn) : nSize(0), nVersion(nVersionIn) {} void write(Span src) { this->nSize += src.size(); } /** Pretend _nSize bytes are written, without specifying them. */ void seek(size_t _nSize) { this->nSize += _nSize; } template CSizeComputer& operator<<(const T& obj) { ::Serialize(*this, obj); return (*this); } size_t size() const { return nSize; } int GetVersion() const { return nVersion; } }; template void SerializeMany(Stream& s) { } template void SerializeMany(Stream& s, const Arg& arg, const Args&... args) { ::Serialize(s, arg); ::SerializeMany(s, args...); } template inline void UnserializeMany(Stream& s) { } template inline void UnserializeMany(Stream& s, Arg&& arg, Args&&... args) { ::Unserialize(s, arg); ::UnserializeMany(s, args...); } template inline void SerReadWriteMany(Stream& s, CSerActionSerialize ser_action, const Args&... args) { ::SerializeMany(s, args...); } template inline void SerReadWriteMany(Stream& s, CSerActionUnserialize ser_action, Args&&... args) { ::UnserializeMany(s, args...); } template inline void SerRead(Stream& s, CSerActionSerialize ser_action, Type&&, Fn&&) { } template inline void SerRead(Stream& s, CSerActionUnserialize ser_action, Type&& obj, Fn&& fn) { fn(s, std::forward(obj)); } template inline void SerWrite(Stream& s, CSerActionSerialize ser_action, Type&& obj, Fn&& fn) { fn(s, std::forward(obj)); } template inline void SerWrite(Stream& s, CSerActionUnserialize ser_action, Type&&, Fn&&) { } template inline void WriteVarInt(CSizeComputer &s, I n) { s.seek(GetSizeOfVarInt(n)); } inline void WriteCompactSize(CSizeComputer &s, uint64_t nSize) { s.seek(GetSizeOfCompactSize(nSize)); } template size_t GetSerializeSize(const T& t, int nVersion) { return (CSizeComputer(nVersion) << t).size(); } template size_t GetSerializeSizeMany(int nVersion, const T&... t) { CSizeComputer sc(nVersion); SerializeMany(sc, t...); return sc.size(); } #endif // BITCOIN_SERIALIZE_H