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