Bitcoin Core  22.99.0
P2P Digital Currency
Classes | Macros | Functions
util.h File Reference
#include <arith_uint256.h>
#include <attributes.h>
#include <chainparamsbase.h>
#include <coins.h>
#include <compat.h>
#include <consensus/amount.h>
#include <consensus/consensus.h>
#include <merkleblock.h>
#include <net.h>
#include <netaddress.h>
#include <netbase.h>
#include <primitives/transaction.h>
#include <script/script.h>
#include <script/standard.h>
#include <serialize.h>
#include <streams.h>
#include <test/fuzz/FuzzedDataProvider.h>
#include <test/fuzz/fuzz.h>
#include <test/util/net.h>
#include <txmempool.h>
#include <uint256.h>
#include <version.h>
#include <algorithm>
#include <array>
#include <cstdint>
#include <cstdio>
#include <optional>
#include <string>
#include <vector>
Include dependency graph for util.h:

Go to the source code of this file.

Classes

class  FuzzedFileProvider
 
class  FuzzedAutoFileProvider
 
class  FuzzedSock
 

Macros

#define WRITE_TO_STREAM_CASE(type, consume)
 
#define READ_FROM_STREAM_CASE(type)
 

Functions

template<typename... Callables>
size_t CallOneOf (FuzzedDataProvider &fuzzed_data_provider, Callables... callables)
 
template<typename Collection >
auto & PickValue (FuzzedDataProvider &fuzzed_data_provider, Collection &col)
 
std::vector< uint8_t > ConsumeRandomLengthByteVector (FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
 
std::vector< bool > ConsumeRandomLengthBitVector (FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
 
CDataStream ConsumeDataStream (FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
 
std::vector< std::string > ConsumeRandomLengthStringVector (FuzzedDataProvider &fuzzed_data_provider, const size_t max_vector_size=16, const size_t max_string_length=16) noexcept
 
template<typename T >
std::vector< T > ConsumeRandomLengthIntegralVector (FuzzedDataProvider &fuzzed_data_provider, const size_t max_vector_size=16) noexcept
 
template<typename T >
std::optional< T > ConsumeDeserializable (FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
 
template<typename WeakEnumType , size_t size>
WeakEnumType ConsumeWeakEnum (FuzzedDataProvider &fuzzed_data_provider, const WeakEnumType(&all_types)[size]) noexcept
 
opcodetype ConsumeOpcodeType (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CAmount ConsumeMoney (FuzzedDataProvider &fuzzed_data_provider, const std::optional< CAmount > &max=std::nullopt) noexcept
 
int64_t ConsumeTime (FuzzedDataProvider &fuzzed_data_provider, const std::optional< int64_t > &min=std::nullopt, const std::optional< int64_t > &max=std::nullopt) noexcept
 
CMutableTransaction ConsumeTransaction (FuzzedDataProvider &fuzzed_data_provider, const std::optional< std::vector< uint256 >> &prevout_txids, const int max_num_in=10, const int max_num_out=10) noexcept
 
CScriptWitness ConsumeScriptWitness (FuzzedDataProvider &fuzzed_data_provider, const size_t max_stack_elem_size=32) noexcept
 
CScript ConsumeScript (FuzzedDataProvider &fuzzed_data_provider, const bool maybe_p2wsh=false) noexcept
 
uint32_t ConsumeSequence (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CScriptNum ConsumeScriptNum (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
uint160 ConsumeUInt160 (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
uint256 ConsumeUInt256 (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
arith_uint256 ConsumeArithUInt256 (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CTxMemPoolEntry ConsumeTxMemPoolEntry (FuzzedDataProvider &fuzzed_data_provider, const CTransaction &tx) noexcept
 
CTxDestination ConsumeTxDestination (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
template<typename T >
bool MultiplicationOverflow (const T i, const T j) noexcept
 
bool ContainsSpentInput (const CTransaction &tx, const CCoinsViewCache &inputs) noexcept
 
template<typename T , size_t size>
void SetFuzzedErrNo (FuzzedDataProvider &fuzzed_data_provider, const std::array< T, size > &errnos)
 Sets errno to a value selected from the given std::array errnos. More...
 
void SetFuzzedErrNo (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
std::vector< uint8_t > ConsumeFixedLengthByteVector (FuzzedDataProvider &fuzzed_data_provider, const size_t length) noexcept
 Returns a byte vector of specified size regardless of the number of remaining bytes available from the fuzzer. More...
 
CNetAddr ConsumeNetAddr (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CSubNet ConsumeSubNet (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CService ConsumeService (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CAddress ConsumeAddress (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
template<bool ReturnUniquePtr = false>
auto ConsumeNode (FuzzedDataProvider &fuzzed_data_provider, const std::optional< NodeId > &node_id_in=std::nullopt) noexcept
 
std::unique_ptr< CNodeConsumeNodeAsUniquePtr (FuzzedDataProvider &fdp, const std::optional< NodeId > &node_id_in=std::nullopt)
 
void FillNode (FuzzedDataProvider &fuzzed_data_provider, ConnmanTestMsg &connman, PeerManager &peerman, CNode &node) noexcept
 
FuzzedFileProvider ConsumeFile (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
FuzzedAutoFileProvider ConsumeAutoFile (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
template<typename Stream >
void WriteToStream (FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
 
template<typename Stream >
void ReadFromStream (FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
 
FuzzedSock ConsumeSock (FuzzedDataProvider &fuzzed_data_provider)
 

Macro Definition Documentation

◆ READ_FROM_STREAM_CASE

#define READ_FROM_STREAM_CASE (   type)
Value:
[&] { \
type o; \
stream >> o; \
}

Definition at line 348 of file util.h.

◆ WRITE_TO_STREAM_CASE

#define WRITE_TO_STREAM_CASE (   type,
  consume 
)
Value:
[&] { \
type o = consume; \
stream << o; \
}

Definition at line 318 of file util.h.

Function Documentation

◆ CallOneOf()

template<typename... Callables>
size_t CallOneOf ( FuzzedDataProvider fuzzed_data_provider,
Callables...  callables 
)

Definition at line 42 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeAddress()

CAddress ConsumeAddress ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 243 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeArithUInt256()

arith_uint256 ConsumeArithUInt256 ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 164 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeAutoFile()

FuzzedAutoFileProvider ConsumeAutoFile ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 313 of file util.h.

Here is the caller graph for this function:

◆ ConsumeDataStream()

CDataStream ConsumeDataStream ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< size_t > &  max_length = std::nullopt 
)
inlinenoexcept

Definition at line 76 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeDeserializable()

template<typename T >
std::optional<T> ConsumeDeserializable ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< size_t > &  max_length = std::nullopt 
)
inlinenoexcept

Definition at line 103 of file util.h.

Here is the call graph for this function:

◆ ConsumeFile()

FuzzedFileProvider ConsumeFile ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 292 of file util.h.

Here is the caller graph for this function:

◆ ConsumeFixedLengthByteVector()

std::vector<uint8_t> ConsumeFixedLengthByteVector ( FuzzedDataProvider fuzzed_data_provider,
const size_t  length 
)
inlinenoexcept

Returns a byte vector of specified size regardless of the number of remaining bytes available from the fuzzer.

Pads with zero value bytes if needed to achieve the specified size.

Definition at line 221 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeMoney()

CAmount ConsumeMoney ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< CAmount > &  max = std::nullopt 
)
noexcept

Definition at line 276 of file util.cpp.

Here is the caller graph for this function:

◆ ConsumeNetAddr()

CNetAddr ConsumeNetAddr ( FuzzedDataProvider fuzzed_data_provider)
noexcept

Definition at line 481 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeNode()

template<bool ReturnUniquePtr = false>
auto ConsumeNode ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< NodeId > &  node_id_in = std::nullopt 
)
noexcept

Definition at line 249 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeNodeAsUniquePtr()

std::unique_ptr<CNode> ConsumeNodeAsUniquePtr ( FuzzedDataProvider fdp,
const std::optional< NodeId > &  node_id_in = std::nullopt 
)
inline

Definition at line 267 of file util.h.

Here is the caller graph for this function:

◆ ConsumeOpcodeType()

opcodetype ConsumeOpcodeType ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 124 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeRandomLengthBitVector()

std::vector<bool> ConsumeRandomLengthBitVector ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< size_t > &  max_length = std::nullopt 
)
inlinenoexcept

Definition at line 71 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeRandomLengthByteVector()

std::vector<uint8_t> ConsumeRandomLengthByteVector ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< size_t > &  max_length = std::nullopt 
)
inlinenoexcept

Definition at line 63 of file util.h.

Here is the caller graph for this function:

◆ ConsumeRandomLengthIntegralVector()

template<typename T >
std::vector<T> ConsumeRandomLengthIntegralVector ( FuzzedDataProvider fuzzed_data_provider,
const size_t  max_vector_size = 16 
)
inlinenoexcept

Definition at line 92 of file util.h.

Here is the call graph for this function:

◆ ConsumeRandomLengthStringVector()

std::vector<std::string> ConsumeRandomLengthStringVector ( FuzzedDataProvider fuzzed_data_provider,
const size_t  max_vector_size = 16,
const size_t  max_string_length = 16 
)
inlinenoexcept

Definition at line 81 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeScript()

CScript ConsumeScript ( FuzzedDataProvider fuzzed_data_provider,
const bool  maybe_p2wsh = false 
)
noexcept

Definition at line 340 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeScriptNum()

CScriptNum ConsumeScriptNum ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 141 of file util.h.

Here is the caller graph for this function:

◆ ConsumeScriptWitness()

CScriptWitness ConsumeScriptWitness ( FuzzedDataProvider fuzzed_data_provider,
const size_t  max_stack_elem_size = 32 
)
noexcept

Definition at line 330 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeSequence()

uint32_t ConsumeSequence ( FuzzedDataProvider fuzzed_data_provider)
noexcept

Definition at line 406 of file util.cpp.

Here is the caller graph for this function:

◆ ConsumeService()

CService ConsumeService ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 238 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeSock()

FuzzedSock ConsumeSock ( FuzzedDataProvider fuzzed_data_provider)
inline

Definition at line 413 of file util.h.

Here is the caller graph for this function:

◆ ConsumeSubNet()

CSubNet ConsumeSubNet ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 233 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeTime()

int64_t ConsumeTime ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< int64_t > &  min = std::nullopt,
const std::optional< int64_t > &  max = std::nullopt 
)
noexcept

Definition at line 281 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeTransaction()

CMutableTransaction ConsumeTransaction ( FuzzedDataProvider fuzzed_data_provider,
const std::optional< std::vector< uint256 >> &  prevout_txids,
const int  max_num_in = 10,
const int  max_num_out = 10 
)
noexcept

Definition at line 289 of file util.cpp.

Here is the call graph for this function:

◆ ConsumeTxDestination()

CTxDestination ConsumeTxDestination ( FuzzedDataProvider fuzzed_data_provider)
noexcept

Definition at line 417 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeTxMemPoolEntry()

CTxMemPoolEntry ConsumeTxMemPoolEntry ( FuzzedDataProvider fuzzed_data_provider,
const CTransaction tx 
)
noexcept

Definition at line 455 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeUInt160()

uint160 ConsumeUInt160 ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 146 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeUInt256()

uint256 ConsumeUInt256 ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 155 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConsumeWeakEnum()

template<typename WeakEnumType , size_t size>
WeakEnumType ConsumeWeakEnum ( FuzzedDataProvider fuzzed_data_provider,
const WeakEnumType(&)  all_types[size] 
)
noexcept

Definition at line 117 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ContainsSpentInput()

bool ContainsSpentInput ( const CTransaction tx,
const CCoinsViewCache inputs 
)
noexcept

Definition at line 470 of file util.cpp.

Here is the call graph for this function:

◆ FillNode()

void FillNode ( FuzzedDataProvider fuzzed_data_provider,
ConnmanTestMsg connman,
PeerManager peerman,
CNode node 
)
noexcept

Definition at line 222 of file util.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MultiplicationOverflow()

template<typename T >
bool MultiplicationOverflow ( const T  i,
const T  j 
)
noexcept

Definition at line 174 of file util.h.

Here is the caller graph for this function:

◆ PickValue()

template<typename Collection >
auto& PickValue ( FuzzedDataProvider fuzzed_data_provider,
Collection &  col 
)

Definition at line 54 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadFromStream()

template<typename Stream >
void ReadFromStream ( FuzzedDataProvider fuzzed_data_provider,
Stream &  stream 
)
noexcept

Definition at line 354 of file util.h.

Here is the call graph for this function:

◆ SetFuzzedErrNo() [1/2]

void SetFuzzedErrNo ( FuzzedDataProvider fuzzed_data_provider)
inlinenoexcept

Definition at line 212 of file util.h.

Here is the call graph for this function:

◆ SetFuzzedErrNo() [2/2]

template<typename T , size_t size>
void SetFuzzedErrNo ( FuzzedDataProvider fuzzed_data_provider,
const std::array< T, size > &  errnos 
)

Sets errno to a value selected from the given std::array errnos.

Definition at line 202 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteToStream()

template<typename Stream >
void WriteToStream ( FuzzedDataProvider fuzzed_data_provider,
Stream &  stream 
)
noexcept

Definition at line 324 of file util.h.

Here is the call graph for this function:
Here is the caller graph for this function: