Inside Bitcoin

1// Copyright (c) 2012-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <hash.h>
6#include <serialize.h>
7#include <streams.h>
8#include <test/util/common.h>
9#include <test/util/setup_common.h>
10#include <util/strencodings.h>
11
12#include <algorithm>
13#include <cstdint>
14#include <string>
15
16#include <boost/test/unit_test.hpp>
17
18BOOST_FIXTURE_TEST_SUITE(serialize_tests, BasicTestingSetup)
19
20// For testing move-semantics, declare a version of datastream that can be moved
21// but is not copyable.
22class UncopyableStream : public DataStream
23{
24public:
25    using DataStream::DataStream;
26    UncopyableStream(const UncopyableStream&) = delete;
27    UncopyableStream& operator=(const UncopyableStream&) = delete;
28    UncopyableStream(UncopyableStream&&) noexcept = default;
29    UncopyableStream& operator=(UncopyableStream&&) noexcept = default;
30};
31
32class CSerializeMethodsTestSingle
33{
34protected:
35    int intval;
36    bool boolval;
37    std::string stringval;
38    char charstrval[16];
39    CTransactionRef txval;
40public:
41    CSerializeMethodsTestSingle() = default;
42    CSerializeMethodsTestSingle(int intvalin, bool boolvalin, std::string stringvalin, const uint8_t* charstrvalin, const CTransactionRef& txvalin) : intval(intvalin), boolval(boolvalin), stringval(std::move(stringvalin)), txval(txvalin)
43    {
44        memcpy(charstrval, charstrvalin, sizeof(charstrval));
45    }
46
47    SERIALIZE_METHODS(CSerializeMethodsTestSingle, obj)
48    {
49        READWRITE(obj.intval);
50        READWRITE(obj.boolval);
51        READWRITE(obj.stringval);
52        READWRITE(obj.charstrval);
53        READWRITE(TX_WITH_WITNESS(obj.txval));
54    }
55
56    bool operator==(const CSerializeMethodsTestSingle& rhs) const
57    {
58        return intval == rhs.intval &&
59               boolval == rhs.boolval &&
60               stringval == rhs.stringval &&
61               strcmp(charstrval, rhs.charstrval) == 0 &&
62               txval->Equals(*rhs.txval);
63    }
64};
65
66class CSerializeMethodsTestMany : public CSerializeMethodsTestSingle
67{
68public:
69    using CSerializeMethodsTestSingle::CSerializeMethodsTestSingle;
70
71    SERIALIZE_METHODS(CSerializeMethodsTestMany, obj)
72    {
73        READWRITE(obj.intval, obj.boolval, obj.stringval, obj.charstrval, TX_WITH_WITNESS(obj.txval));
74    }
75};
76
77BOOST_AUTO_TEST_CASE(sizes)
78{
79    BOOST_CHECK_EQUAL(sizeof(unsigned char), GetSerializeSize((unsigned char)0));
80    BOOST_CHECK_EQUAL(sizeof(int8_t), GetSerializeSize(int8_t(0)));
81    BOOST_CHECK_EQUAL(sizeof(uint8_t), GetSerializeSize(uint8_t(0)));
82    BOOST_CHECK_EQUAL(sizeof(int16_t), GetSerializeSize(int16_t(0)));
83    BOOST_CHECK_EQUAL(sizeof(uint16_t), GetSerializeSize(uint16_t(0)));
84    BOOST_CHECK_EQUAL(sizeof(int32_t), GetSerializeSize(int32_t(0)));
85    BOOST_CHECK_EQUAL(sizeof(uint32_t), GetSerializeSize(uint32_t(0)));
86    BOOST_CHECK_EQUAL(sizeof(int64_t), GetSerializeSize(int64_t(0)));
87    BOOST_CHECK_EQUAL(sizeof(uint64_t), GetSerializeSize(uint64_t(0)));
88    // Bool is serialized as uint8_t
89    BOOST_CHECK_EQUAL(sizeof(uint8_t), GetSerializeSize(bool(0)));
90
91    // Sanity-check GetSerializeSize and c++ type matching
92    BOOST_CHECK_EQUAL(GetSerializeSize((unsigned char)0), 1U);
93    BOOST_CHECK_EQUAL(GetSerializeSize(int8_t(0)), 1U);
94    BOOST_CHECK_EQUAL(GetSerializeSize(uint8_t(0)), 1U);
95    BOOST_CHECK_EQUAL(GetSerializeSize(int16_t(0)), 2U);
96    BOOST_CHECK_EQUAL(GetSerializeSize(uint16_t(0)), 2U);
97    BOOST_CHECK_EQUAL(GetSerializeSize(int32_t(0)), 4U);
98    BOOST_CHECK_EQUAL(GetSerializeSize(uint32_t(0)), 4U);
99    BOOST_CHECK_EQUAL(GetSerializeSize(int64_t(0)), 8U);
100    BOOST_CHECK_EQUAL(GetSerializeSize(uint64_t(0)), 8U);
101    BOOST_CHECK_EQUAL(GetSerializeSize(bool(0)), 1U);
102    BOOST_CHECK_EQUAL(GetSerializeSize(std::array<uint8_t, 1>{0}), 1U);
103    BOOST_CHECK_EQUAL(GetSerializeSize(std::array<uint8_t, 2>{0, 0}), 2U);
104}
105
106BOOST_AUTO_TEST_CASE(varints)
107{
108    // encode
109
110    DataStream ss{};
111    DataStream::size_type size = 0;
112    for (int i = 0; i < 100000; i++) {
113        ss << VARINT_MODE(i, VarIntMode::NONNEGATIVE_SIGNED);
114        size += ::GetSerializeSize(VARINT_MODE(i, VarIntMode::NONNEGATIVE_SIGNED));
115        BOOST_CHECK(size == ss.size());
116    }
117
118    for (uint64_t i = 0;  i < 100000000000ULL; i += 999999937) {
119        ss << VARINT(i);
120        size += ::GetSerializeSize(VARINT(i));
121        BOOST_CHECK(size == ss.size());
122    }
123
124    // decode
125    for (int i = 0; i < 100000; i++) {
126        int j = -1;
127        ss >> VARINT_MODE(j, VarIntMode::NONNEGATIVE_SIGNED);
128        BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
129    }
130
131    for (uint64_t i = 0;  i < 100000000000ULL; i += 999999937) {
132        uint64_t j = std::numeric_limits<uint64_t>::max();
133        ss >> VARINT(j);
134        BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
135    }
136}
137
138BOOST_AUTO_TEST_CASE(varints_bitpatterns)
139{
140    DataStream ss{};
141    ss << VARINT_MODE(0, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "00"); ss.clear();
142    ss << VARINT_MODE(0x7f, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "7f"); ss.clear();
143    ss << VARINT_MODE(int8_t{0x7f}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "7f"); ss.clear();
144    ss << VARINT_MODE(0x80, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "8000"); ss.clear();
145    ss << VARINT(uint8_t{0x80}); BOOST_CHECK_EQUAL(HexStr(ss), "8000"); ss.clear();
146    ss << VARINT_MODE(0x1234, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "a334"); ss.clear();
147    ss << VARINT_MODE(int16_t{0x1234}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "a334"); ss.clear();
148    ss << VARINT_MODE(0xffff, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "82fe7f"); ss.clear();
149    ss << VARINT(uint16_t{0xffff}); BOOST_CHECK_EQUAL(HexStr(ss), "82fe7f"); ss.clear();
150    ss << VARINT_MODE(0x123456, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "c7e756"); ss.clear();
151    ss << VARINT_MODE(int32_t{0x123456}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "c7e756"); ss.clear();
152    ss << VARINT(0x80123456U); BOOST_CHECK_EQUAL(HexStr(ss), "86ffc7e756"); ss.clear();
153    ss << VARINT(uint32_t{0x80123456U}); BOOST_CHECK_EQUAL(HexStr(ss), "86ffc7e756"); ss.clear();
154    ss << VARINT(0xffffffff); BOOST_CHECK_EQUAL(HexStr(ss), "8efefefe7f"); ss.clear();
155    ss << VARINT_MODE(0x7fffffffffffffffLL, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "fefefefefefefefe7f"); ss.clear();
156    ss << VARINT(0xffffffffffffffffULL); BOOST_CHECK_EQUAL(HexStr(ss), "80fefefefefefefefe7f"); ss.clear();
157}
158
159BOOST_AUTO_TEST_CASE(compactsize)
160{
161    DataStream ss{};
162    std::vector<char>::size_type i, j;
163
164    for (i = 1; i <= MAX_SIZE; i *= 2)
165    {
166        WriteCompactSize(ss, i-1);
167        WriteCompactSize(ss, i);
168    }
169    for (i = 1; i <= MAX_SIZE; i *= 2)
170    {
171        j = ReadCompactSize(ss);
172        BOOST_CHECK_MESSAGE((i-1) == j, "decoded:" << j << " expected:" << (i-1));
173        j = ReadCompactSize(ss);
174        BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
175    }
176}
177
178static bool isCanonicalException(const std::ios_base::failure& ex)
179{
180    std::ios_base::failure expectedException("non-canonical ReadCompactSize()");
181
182    // The string returned by what() can be different for different platforms.
183    // Instead of directly comparing the ex.what() with an expected string,
184    // create an instance of exception to see if ex.what() matches
185    // the expected explanatory string returned by the exception instance.
186    return strcmp(expectedException.what(), ex.what()) == 0;
187}
188
189BOOST_AUTO_TEST_CASE(vector_bool)
190{
191    std::vector<uint8_t> vec1{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
192    std::vector<bool> vec2{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
193
194    BOOST_CHECK(vec1 == std::vector<uint8_t>(vec2.begin(), vec2.end()));
195    BOOST_CHECK((HashWriter{} << vec1).GetHash() == (HashWriter{} << vec2).GetHash());
196}
197
198BOOST_AUTO_TEST_CASE(array)
199{
200    std::array<uint8_t, 32> array1{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
201    DataStream ds;
202    ds << array1;
203    std::array<uint8_t, 32> array2;
204    ds >> array2;
205    BOOST_CHECK(array1 == array2);
206}
207
208BOOST_AUTO_TEST_CASE(noncanonical)
209{
210    // Write some non-canonical CompactSize encodings, and
211    // make sure an exception is thrown when read back.
212    DataStream ss{};
213    std::vector<char>::size_type n;
214
215    // zero encoded with three bytes:
216    ss << std::span{"\xfd\x00\x00"}.first(3);
217    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
218
219    // 0xfc encoded with three bytes:
220    ss << std::span{"\xfd\xfc\x00"}.first(3);
221    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
222
223    // 0xfd encoded with three bytes is OK:
224    ss << std::span{"\xfd\xfd\x00"}.first(3);
225    n = ReadCompactSize(ss);
226    BOOST_CHECK(n == 0xfd);
227
228    // zero encoded with five bytes:
229    ss << std::span{"\xfe\x00\x00\x00\x00"}.first(5);
230    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
231
232    // 0xffff encoded with five bytes:
233    ss << std::span{"\xfe\xff\xff\x00\x00"}.first(5);
234    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
235
236    // zero encoded with nine bytes:
237    ss << std::span{"\xff\x00\x00\x00\x00\x00\x00\x00\x00"}.first(9);
238    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
239
240    // 0x01ffffff encoded with nine bytes:
241    ss << std::span{"\xff\xff\xff\xff\x01\x00\x00\x00\x00"}.first(9);
242    BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
243}
244
245BOOST_AUTO_TEST_CASE(string_view)
246{
247    const std::string_view sv{"hello, world"};
248    DataStream ss;
249    ss << sv;
250    std::string s;