Bitcoin Core 28.0.0
P2P Digital Currency
Loading...
Searching...
No Matches
util.h File Reference
#include <addresstype.h>
#include <arith_uint256.h>
#include <coins.h>
#include <compat/compat.h>
#include <consensus/amount.h>
#include <consensus/consensus.h>
#include <key.h>
#include <merkleblock.h>
#include <primitives/transaction.h>
#include <script/script.h>
#include <serialize.h>
#include <streams.h>
#include <test/fuzz/FuzzedDataProvider.h>
#include <test/fuzz/fuzz.h>
#include <uint256.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
 

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)
 
template<typename B = uint8_t>
std::vector< BConsumeRandomLengthByteVector (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
 
DataStream 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< TConsumeRandomLengthIntegralVector (FuzzedDataProvider &fuzzed_data_provider, const size_t max_vector_size=16) noexcept
 
template<typename P >
ConsumeDeserializationParams (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
template<typename T , typename P >
std::optional< TConsumeDeserializable (FuzzedDataProvider &fuzzed_data_provider, const P &params, const std::optional< size_t > &max_length=std::nullopt) noexcept
 
template<typename T >
std::optional< TConsumeDeserializable (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< Txid > > &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
 
std::map< COutPoint, CoinConsumeCoins (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CTxDestination ConsumeTxDestination (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
CKey ConsumePrivateKey (FuzzedDataProvider &fuzzed_data_provider, std::optional< bool > compressed=std::nullopt) 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.
 
void SetFuzzedErrNo (FuzzedDataProvider &fuzzed_data_provider) noexcept
 
template<typename B = uint8_t>
std::vector< BConsumeFixedLengthByteVector (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.
 
template<typename Stream >
void WriteToStream (FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
 
template<typename Stream >
void ReadFromStream (FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
 

Macro Definition Documentation

◆ READ_FROM_STREAM_CASE

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

Definition at line 296 of file util.h.

◆ WRITE_TO_STREAM_CASE

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

Definition at line 267 of file util.h.

Function Documentation

◆ CallOneOf()

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

Definition at line 35 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)
inlinenodiscardnoexcept

Definition at line 178 of file util.h.

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

◆ ConsumeCoins()

std::map< COutPoint, Coin > ConsumeCoins ( FuzzedDataProvider & fuzzed_data_provider)
nodiscardnoexcept

Definition at line 166 of file util.cpp.

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

◆ ConsumeDataStream()

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

Definition at line 73 of file util.h.

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

◆ ConsumeDeserializable() [1/2]

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

Definition at line 103 of file util.h.

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

◆ ConsumeDeserializable() [2/2]

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

Definition at line 117 of file util.h.

Here is the call graph for this function:

◆ ConsumeDeserializationParams()

template<typename P >
template CAddress::SerParams ConsumeDeserializationParams ( FuzzedDataProvider & fuzzed_data_provider)
nodiscardnoexcept

Definition at line 93 of file net.cpp.

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

◆ ConsumeFixedLengthByteVector()

template<typename B = uint8_t>
std::vector< B > ConsumeFixedLengthByteVector ( FuzzedDataProvider & fuzzed_data_provider,
const size_t length )
inlinenodiscardnoexcept

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 238 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 )
nodiscardnoexcept

Definition at line 29 of file util.cpp.

Here is the caller graph for this function:

◆ ConsumeOpcodeType()

opcodetype ConsumeOpcodeType ( FuzzedDataProvider & fuzzed_data_provider)
inlinenodiscardnoexcept

Definition at line 138 of file util.h.

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

◆ ConsumePrivateKey()

CKey ConsumePrivateKey ( FuzzedDataProvider & fuzzed_data_provider,
std::optional< bool > compressed = std::nullopt )
nodiscardnoexcept

Definition at line 230 of file util.cpp.

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 )
inlinenodiscardnoexcept

Definition at line 68 of file util.h.

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

◆ ConsumeRandomLengthByteVector()

template<typename B = uint8_t>
std::vector< B > ConsumeRandomLengthByteVector ( FuzzedDataProvider & fuzzed_data_provider,
const std::optional< size_t > & max_length = std::nullopt )
inlinenodiscardnoexcept

Definition at line 57 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 )
inlinenodiscardnoexcept

Definition at line 89 of file util.h.

Here is the call graph for this function:
Here is the caller 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 )
inlinenodiscardnoexcept

Definition at line 78 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 )
nodiscardnoexcept

Definition at line 93 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)
inlinenodiscardnoexcept

Definition at line 155 of file util.h.

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

◆ ConsumeScriptWitness()

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

Definition at line 83 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)
nodiscardnoexcept

Definition at line 155 of file util.cpp.

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 )
nodiscardnoexcept

Definition at line 34 of file util.cpp.

Here is the caller graph for this function:

◆ ConsumeTransaction()

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

Definition at line 42 of file util.cpp.

Here is the call graph for this function:

◆ ConsumeTxDestination()

CTxDestination ConsumeTxDestination ( FuzzedDataProvider & fuzzed_data_provider)
nodiscardnoexcept

Definition at line 184 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)
inlinenodiscardnoexcept

Definition at line 160 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)
inlinenodiscardnoexcept

Definition at line 169 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] )
nodiscardnoexcept

Definition at line 131 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 )
nodiscardnoexcept

Definition at line 240 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 )
nodiscardnoexcept

Definition at line 190 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 47 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 302 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 228 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 218 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 273 of file util.h.

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