Bitcoin Core  24.1.0
P2P Digital Currency
integer.cpp
Go to the documentation of this file.
1 // Copyright (c) 2019-2021 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 <arith_uint256.h>
6 #include <compressor.h>
7 #include <consensus/amount.h>
8 #include <consensus/merkle.h>
9 #include <core_io.h>
10 #include <crypto/common.h>
11 #include <crypto/siphash.h>
12 #include <key_io.h>
13 #include <memusage.h>
14 #include <netbase.h>
15 #include <policy/settings.h>
16 #include <pow.h>
17 #include <protocol.h>
18 #include <pubkey.h>
19 #include <script/standard.h>
20 #include <serialize.h>
21 #include <streams.h>
23 #include <test/fuzz/fuzz.h>
24 #include <test/fuzz/util.h>
25 #include <uint256.h>
26 #include <univalue.h>
27 #include <util/check.h>
28 #include <util/moneystr.h>
29 #include <util/overflow.h>
30 #include <util/strencodings.h>
31 #include <util/string.h>
32 #include <util/system.h>
33 #include <version.h>
34 
35 #include <cassert>
36 #include <chrono>
37 #include <limits>
38 #include <set>
39 #include <vector>
40 
42 {
44 }
45 
47 {
48  if (buffer.size() < sizeof(uint256) + sizeof(uint160)) {
49  return;
50  }
51  FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
52  const uint256 u256(fuzzed_data_provider.ConsumeBytes<unsigned char>(sizeof(uint256)));
53  const uint160 u160(fuzzed_data_provider.ConsumeBytes<unsigned char>(sizeof(uint160)));
54  const uint64_t u64 = fuzzed_data_provider.ConsumeIntegral<uint64_t>();
55  const int64_t i64 = fuzzed_data_provider.ConsumeIntegral<int64_t>();
56  const uint32_t u32 = fuzzed_data_provider.ConsumeIntegral<uint32_t>();
57  const int32_t i32 = fuzzed_data_provider.ConsumeIntegral<int32_t>();
58  const uint16_t u16 = fuzzed_data_provider.ConsumeIntegral<uint16_t>();
59  const int16_t i16 = fuzzed_data_provider.ConsumeIntegral<int16_t>();
60  const uint8_t u8 = fuzzed_data_provider.ConsumeIntegral<uint8_t>();
61  const int8_t i8 = fuzzed_data_provider.ConsumeIntegral<int8_t>();
62  // We cannot assume a specific value of std::is_signed<char>::value:
63  // ConsumeIntegral<char>() instead of casting from {u,}int8_t.
64  const char ch = fuzzed_data_provider.ConsumeIntegral<char>();
65  const bool b = fuzzed_data_provider.ConsumeBool();
66 
67  const Consensus::Params& consensus_params = Params().GetConsensus();
68  (void)CheckProofOfWork(u256, u32, consensus_params);
69  if (u64 <= MAX_MONEY) {
70  const uint64_t compressed_money_amount = CompressAmount(u64);
71  assert(u64 == DecompressAmount(compressed_money_amount));
72  static const uint64_t compressed_money_amount_max = CompressAmount(MAX_MONEY - 1);
73  assert(compressed_money_amount <= compressed_money_amount_max);
74  } else {
75  (void)CompressAmount(u64);
76  }
77  static const uint256 u256_min(uint256S("0000000000000000000000000000000000000000000000000000000000000000"));
78  static const uint256 u256_max(uint256S("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"));
79  const std::vector<uint256> v256{u256, u256_min, u256_max};
80  (void)ComputeMerkleRoot(v256);
81  (void)CountBits(u64);
82  (void)DecompressAmount(u64);
83  {
84  if (std::optional<CAmount> parsed = ParseMoney(FormatMoney(i64))) {
85  assert(parsed.value() == i64);
86  }
87  }
88  (void)GetSizeOfCompactSize(u64);
90  if (!MultiplicationOverflow(i64, static_cast<int64_t>(u32)) && !AdditionOverflow(i64, static_cast<int64_t>(4)) && !AdditionOverflow(i64 * u32, static_cast<int64_t>(4))) {
91  (void)GetVirtualTransactionSize(i64, i64, u32);
92  }
93  (void)HexDigit(ch);
94  (void)MoneyRange(i64);
95  (void)ToString(i64);
96  (void)IsDigit(ch);
97  (void)IsSpace(ch);
98  (void)IsSwitchChar(ch);
99  (void)memusage::DynamicUsage(ch);
100  (void)memusage::DynamicUsage(i16);
101  (void)memusage::DynamicUsage(i32);
102  (void)memusage::DynamicUsage(i64);
103  (void)memusage::DynamicUsage(i8);
104  (void)memusage::DynamicUsage(u16);
106  (void)memusage::DynamicUsage(u64);
107  (void)memusage::DynamicUsage(u8);
108  const unsigned char uch = static_cast<unsigned char>(u8);
109  (void)memusage::DynamicUsage(uch);
110  {
111  const std::set<int64_t> i64s{i64, static_cast<int64_t>(u64)};
112  const size_t dynamic_usage = memusage::DynamicUsage(i64s);
113  const size_t incremental_dynamic_usage = memusage::IncrementalDynamicUsage(i64s);
114  assert(dynamic_usage == incremental_dynamic_usage * i64s.size());
115  }
116  (void)MillisToTimeval(i64);
117  (void)SighashToStr(uch);
118  (void)SipHashUint256(u64, u64, u256);
119  (void)SipHashUint256Extra(u64, u64, u256, u32);
120  (void)ToLower(ch);
121  (void)ToUpper(ch);
122  {
123  if (std::optional<CAmount> parsed = ParseMoney(ValueFromAmount(i64).getValStr())) {
124  assert(parsed.value() == i64);
125  }
126  }
127  if (i32 >= 0 && i32 <= 16) {
129  }
130 
131  const std::chrono::seconds seconds{i64};
132  assert(count_seconds(seconds) == i64);
133 
134  const CScriptNum script_num{i64};
135  (void)script_num.getint();
136  (void)script_num.getvch();
137 
138  const arith_uint256 au256 = UintToArith256(u256);
139  assert(ArithToUint256(au256) == u256);
140  assert(uint256S(au256.GetHex()) == u256);
141  (void)au256.bits();
142  (void)au256.GetCompact(/* fNegative= */ false);
143  (void)au256.GetCompact(/* fNegative= */ true);
144  (void)au256.getdouble();
145  (void)au256.GetHex();
146  (void)au256.GetLow64();
147  (void)au256.size();
148  (void)au256.ToString();
149 
150  const CKeyID key_id{u160};
151  const CScriptID script_id{u160};
152 
153  {
155 
156  uint256 deserialized_u256;
157  stream << u256;
158  stream >> deserialized_u256;
159  assert(u256 == deserialized_u256 && stream.empty());
160 
161  uint160 deserialized_u160;
162  stream << u160;
163  stream >> deserialized_u160;
164  assert(u160 == deserialized_u160 && stream.empty());
165 
166  uint64_t deserialized_u64;
167  stream << u64;
168  stream >> deserialized_u64;
169  assert(u64 == deserialized_u64 && stream.empty());
170 
171  int64_t deserialized_i64;
172  stream << i64;
173  stream >> deserialized_i64;
174  assert(i64 == deserialized_i64 && stream.empty());
175 
176  uint32_t deserialized_u32;
177  stream << u32;
178  stream >> deserialized_u32;
179  assert(u32 == deserialized_u32 && stream.empty());
180 
181  int32_t deserialized_i32;
182  stream << i32;
183  stream >> deserialized_i32;
184  assert(i32 == deserialized_i32 && stream.empty());
185 
186  uint16_t deserialized_u16;
187  stream << u16;
188  stream >> deserialized_u16;
189  assert(u16 == deserialized_u16 && stream.empty());
190 
191  int16_t deserialized_i16;
192  stream << i16;
193  stream >> deserialized_i16;
194  assert(i16 == deserialized_i16 && stream.empty());
195 
196  uint8_t deserialized_u8;
197  stream << u8;
198  stream >> deserialized_u8;
199  assert(u8 == deserialized_u8 && stream.empty());
200 
201  int8_t deserialized_i8;
202  stream << i8;
203  stream >> deserialized_i8;
204  assert(i8 == deserialized_i8 && stream.empty());
205 
206  bool deserialized_b;
207  stream << b;
208  stream >> deserialized_b;
209  assert(b == deserialized_b && stream.empty());
210  }
211 
212  {
213  const ServiceFlags service_flags = (ServiceFlags)u64;
214  (void)HasAllDesirableServiceFlags(service_flags);
215  (void)MayHaveUsefulAddressDB(service_flags);
216  }
217 
218  {
220 
221  ser_writedata64(stream, u64);
222  const uint64_t deserialized_u64 = ser_readdata64(stream);
223  assert(u64 == deserialized_u64 && stream.empty());
224 
225  ser_writedata32(stream, u32);
226  const uint32_t deserialized_u32 = ser_readdata32(stream);
227  assert(u32 == deserialized_u32 && stream.empty());
228 
229  ser_writedata32be(stream, u32);
230  const uint32_t deserialized_u32be = ser_readdata32be(stream);
231  assert(u32 == deserialized_u32be && stream.empty());
232 
233  ser_writedata16(stream, u16);
234  const uint16_t deserialized_u16 = ser_readdata16(stream);
235  assert(u16 == deserialized_u16 && stream.empty());
236 
237  ser_writedata16be(stream, u16);
238  const uint16_t deserialized_u16be = ser_readdata16be(stream);
239  assert(u16 == deserialized_u16be && stream.empty());
240 
241  ser_writedata8(stream, u8);
242  const uint8_t deserialized_u8 = ser_readdata8(stream);
243  assert(u8 == deserialized_u8 && stream.empty());
244  }
245 
246  {
248 
249  WriteCompactSize(stream, u64);
250  try {
251  const uint64_t deserialized_u64 = ReadCompactSize(stream);
252  assert(u64 == deserialized_u64 && stream.empty());
253  } catch (const std::ios_base::failure&) {
254  }
255  }
256 
257  try {
258  CHECK_NONFATAL(b);
259  } catch (const NonFatalCheckError&) {
260  }
261 }
uint64_t SipHashUint256(uint64_t k0, uint64_t k1, const uint256 &val)
Optimized SipHash-2-4 implementation for uint256.
Definition: siphash.cpp:94
uint64_t CompressAmount(uint64_t n)
Compress amount.
Definition: compressor.cpp:149
bool AdditionOverflow(const T i, const T j) noexcept
Definition: overflow.h:13
std::string ToString() const
static int DecodeOP_N(opcodetype opcode)
Encode/decode small integers:
Definition: script.h:503
signed char HexDigit(char c)
ServiceFlags
nServices flags
Definition: protocol.h:267
int getint() const
Definition: script.h:329
assert(!tx.IsCoinBase())
uint8_t ser_readdata8(Stream &s)
Definition: serialize.h:82
static const std::string REGTEST
void ser_writedata64(Stream &s, uint64_t obj)
Definition: serialize.h:77
uint64_t ReadCompactSize(Stream &is, bool range_check=true)
Decode a CompactSize-encoded variable-length integer.
Definition: serialize.h:275
void WriteCompactSize(CSizeComputer &os, uint64_t nSize)
Definition: serialize.h:1103
static size_t DynamicUsage(const int8_t &v)
Dynamic memory usage for built-in types is zero.
Definition: memusage.h:29
bool MoneyRange(const CAmount &nValue)
Definition: amount.h:27
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:47
void ser_writedata32(Stream &s, uint32_t obj)
Definition: serialize.h:67
unsigned int GetSizeOfCompactSize(uint64_t nSize)
Compact Size size < 253 – 1 byte size <= USHRT_MAX – 3 bytes (253 + 2 bytes) size <= UINT_MAX – 5 ...
Definition: serialize.h:233
constexpr bool IsDigit(char c)
Tests if the given character is a decimal digit.
Definition: strencodings.h:137
void initialize_integer()
Definition: integer.cpp:41
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:185
bool empty() const
Definition: streams.h:238
int64_t GetVirtualTransactionSize(int64_t nWeight, int64_t nSigOpCost, unsigned int bytes_per_sigop)
Compute the virtual transaction size (weight reinterpreted as bytes).
Definition: policy.cpp:295
const std::string & getValStr() const
Definition: univalue.h:62
uint32_t GetCompact(bool fNegative=false) const
arith_uint256 UintToArith256(const uint256 &a)
bool MultiplicationOverflow(const T i, const T j) noexcept
Definition: util.h:221
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:109
uint16_t ser_readdata16(Stream &s)
Definition: serialize.h:88
uint32_t ser_readdata32(Stream &s)
Definition: serialize.h:100
static bool HasAllDesirableServiceFlags(ServiceFlags services)
A shortcut for (services & GetDesirableServiceFlags(services)) == GetDesirableServiceFlags(services)...
Definition: protocol.h:339
void SelectParams(const std::string &network)
Sets the params returned by Params() to those for the given chain name.
static const int INIT_PROTO_VERSION
initial proto version, to be increased after version/verack negotiation
Definition: version.h:15
void ser_writedata16(Stream &s, uint16_t obj)
Definition: serialize.h:57
uint256 uint256S(const char *str)
Definition: uint256.h:132
FUZZ_TARGET_INIT(integer, initialize_integer)
Definition: integer.cpp:46
std::optional< CAmount > ParseMoney(const std::string &money_string)
Parse an amount denoted in full coins.
Definition: moneystr.cpp:42
std::string SighashToStr(unsigned char sighash_type)
Definition: core_write.cpp:84
static uint64_t CountBits(uint64_t x)
Return the smallest number n such that (x >> n) == 0 (or 64 if the highest bit in x is set...
Definition: common.h:90
void ser_writedata32be(Stream &s, uint32_t obj)
Definition: serialize.h:72
Parameters that influence chain consensus.
Definition: params.h:73
bool CheckProofOfWork(uint256 hash, unsigned int nBits, const Consensus::Params &params)
Check whether a block hash satisfies the proof-of-work requirement specified by nBits.
Definition: pow.cpp:125
uint64_t SipHashUint256Extra(uint64_t k0, uint64_t k1, const uint256 &val, uint32_t extra)
Definition: siphash.cpp:134
256-bit unsigned big integer.
uint64_t ser_readdata64(Stream &s)
Definition: serialize.h:112
static bool MayHaveUsefulAddressDB(ServiceFlags services)
Checks if a peer with the given service flags may be capable of having a robust address-storage DB...
Definition: protocol.h:348
unsigned int u32
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:54
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:16
256-bit opaque blob.
Definition: uint256.h:119
uint16_t ser_readdata16be(Stream &s)
Definition: serialize.h:94
uint256 ComputeMerkleRoot(std::vector< uint256 > hashes, bool *mutated)
Definition: merkle.cpp:45
uint256 ArithToUint256(const arith_uint256 &a)
static opcodetype EncodeOP_N(int n)
Definition: script.h:510
const CChainParams & Params()
Return the currently selected parameters.
uint64_t GetLow64() const
constexpr bool IsSpace(char c) noexcept
Tests if the given character is a whitespace character.
Definition: strencodings.h:153
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:23
uint32_t ser_readdata32be(Stream &s)
Definition: serialize.h:106
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
160-bit opaque blob.
Definition: uint256.h:108
static constexpr CAmount MAX_MONEY
No amount larger than this (in satoshi) is valid.
Definition: amount.h:26
struct timeval MillisToTimeval(int64_t nTimeout)
Convert milliseconds to a struct timeval for e.g.
Definition: time.cpp:159
static size_t IncrementalDynamicUsage(const std::set< X, Y > &s)
Definition: memusage.h:105
void ser_writedata16be(Stream &s, uint16_t obj)
Definition: serialize.h:62
A reference to a CScript: the Hash160 of its serialization (see script.h)
Definition: standard.h:26
unsigned int GetSpecialScriptSize(unsigned int nSize)
Definition: compressor.cpp:86
bool IsSwitchChar(char c)
Definition: system.h:129
unsigned char u8
std::string GetHex() const
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:82
uint64_t DecompressAmount(uint64_t x)
Definition: compressor.cpp:168
unsigned int size() const
double getdouble() const
void ser_writedata8(Stream &s, uint8_t obj)
Definition: serialize.h:53
unsigned int bits() const
Returns the position of the highest bit set plus one, or zero if the value is zero.
std::string ToUpper(std::string_view str)
Returns the uppercase equivalent of the given string.