Bitcoin Core  24.99.0
P2P Digital Currency
Public Member Functions | Private Attributes | List of all members
FuzzedSock Class Reference

#include <net.h>

Inheritance diagram for FuzzedSock:
[legend]
Collaboration diagram for FuzzedSock:
[legend]

Public Member Functions

 FuzzedSock (FuzzedDataProvider &fuzzed_data_provider)
 
 ~FuzzedSock () override
 
FuzzedSockoperator= (Sock &&other) override
 Move assignment operator, grab the socket from another object and close ours (if set). More...
 
ssize_t Send (const void *data, size_t len, int flags) const override
 send(2) wrapper. More...
 
ssize_t Recv (void *buf, size_t len, int flags) const override
 recv(2) wrapper. More...
 
int Connect (const sockaddr *, socklen_t) const override
 connect(2) wrapper. More...
 
int Bind (const sockaddr *, socklen_t) const override
 bind(2) wrapper. More...
 
int Listen (int backlog) const override
 listen(2) wrapper. More...
 
std::unique_ptr< SockAccept (sockaddr *addr, socklen_t *addr_len) const override
 accept(2) wrapper. More...
 
int GetSockOpt (int level, int opt_name, void *opt_val, socklen_t *opt_len) const override
 getsockopt(2) wrapper. More...
 
int SetSockOpt (int level, int opt_name, const void *opt_val, socklen_t opt_len) const override
 setsockopt(2) wrapper. More...
 
int GetSockName (sockaddr *name, socklen_t *name_len) const override
 getsockname(2) wrapper. More...
 
bool SetNonBlocking () const override
 Set the non-blocking option on the socket. More...
 
bool IsSelectable () const override
 Check if the underlying socket can be used for select(2) (or the Wait() method). More...
 
bool Wait (std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const override
 Wait for readiness for input (recv) or output (send). More...
 
bool WaitMany (std::chrono::milliseconds timeout, EventsPerSock &events_per_sock) const override
 Same as Wait(), but wait on many sockets within the same timeout. More...
 
bool IsConnected (std::string &errmsg) const override
 Check if still connected. More...
 
- Public Member Functions inherited from Sock
 Sock ()
 Default constructor, creates an empty object that does nothing when destroyed. More...
 
 Sock (SOCKET s)
 Take ownership of an existent socket. More...
 
 Sock (const Sock &)=delete
 Copy constructor, disabled because closing the same socket twice is undesirable. More...
 
 Sock (Sock &&other)
 Move constructor, grab the socket from another object and close ours (if set). More...
 
virtual ~Sock ()
 Destructor, close the socket or do nothing if empty. More...
 
Sockoperator= (const Sock &)=delete
 Copy assignment operator, disabled because closing the same socket twice is undesirable. More...
 
virtual SOCKET Get () const
 Get the value of the contained socket. More...
 
virtual void SendComplete (const std::string &data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
 Send the given data, retrying on transient errors. More...
 
virtual std::string RecvUntilTerminator (uint8_t terminator, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt, size_t max_data) const
 Read from socket until a terminator character is encountered. More...
 

Private Attributes

FuzzedDataProviderm_fuzzed_data_provider
 
std::optional< uint8_t > m_peek_data
 Data to return when MSG_PEEK is used as a Recv() flag. More...
 
const bool m_selectable
 Whether to pretend that the socket is select(2)-able. More...
 

Additional Inherited Members

- Public Types inherited from Sock
using Event = uint8_t
 
using EventsPerSock = std::unordered_map< std::shared_ptr< const Sock >, Events, HashSharedPtrSock, EqualSharedPtrSock >
 On which socket to wait for what events in WaitMany(). More...
 
- Static Public Attributes inherited from Sock
static constexpr Event RECV = 0b001
 If passed to Wait(), then it will wait for readiness to read from the socket. More...
 
static constexpr Event SEND = 0b010
 If passed to Wait(), then it will wait for readiness to send to the socket. More...
 
static constexpr Event ERR = 0b100
 Ignored if passed to Wait(), but could be set in the occurred events if an exceptional condition has occurred on the socket or if it has been disconnected. More...
 
- Protected Attributes inherited from Sock
SOCKET m_socket
 Contained socket. More...
 

Detailed Description

Definition at line 29 of file net.h.

Constructor & Destructor Documentation

◆ FuzzedSock()

FuzzedSock::FuzzedSock ( FuzzedDataProvider fuzzed_data_provider)
explicit

Definition at line 58 of file net.cpp.

Here is the call graph for this function:

◆ ~FuzzedSock()

FuzzedSock::~FuzzedSock ( )
override

Definition at line 64 of file net.cpp.

Member Function Documentation

◆ Accept()

std::unique_ptr< Sock > FuzzedSock::Accept ( sockaddr *  addr,
socklen_t *  addr_len 
) const
overridevirtual

accept(2) wrapper.

Equivalent to std::make_unique<Sock>(accept(this->Get(), addr, addr_len)). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation. The returned unique_ptr is empty if accept() failed in which case errno will be set.

Reimplemented from Sock.

Definition at line 237 of file net.cpp.

Here is the call graph for this function:

◆ Bind()

int FuzzedSock::Bind ( const sockaddr *  addr,
socklen_t  addr_len 
) const
overridevirtual

bind(2) wrapper.

Equivalent to bind(this->Get(), addr, addr_len). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 198 of file net.cpp.

Here is the call graph for this function:

◆ Connect()

int FuzzedSock::Connect ( const sockaddr *  addr,
socklen_t  addr_len 
) const
overridevirtual

connect(2) wrapper.

Equivalent to connect(this->Get(), addr, addrlen). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 176 of file net.cpp.

Here is the call graph for this function:

◆ GetSockName()

int FuzzedSock::GetSockName ( sockaddr *  name,
socklen_t *  name_len 
) const
overridevirtual

getsockname(2) wrapper.

Equivalent to getsockname(this->Get(), name, name_len). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 283 of file net.cpp.

Here is the call graph for this function:

◆ GetSockOpt()

int FuzzedSock::GetSockOpt ( int  level,
int  opt_name,
void *  opt_val,
socklen_t *  opt_len 
) const
overridevirtual

getsockopt(2) wrapper.

Equivalent to getsockopt(this->Get(), level, opt_name, opt_val, opt_len). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 251 of file net.cpp.

Here is the call graph for this function:

◆ IsConnected()

bool FuzzedSock::IsConnected ( std::string &  errmsg) const
overridevirtual

Check if still connected.

Parameters
[out]errmsgThe error string, if the socket has been disconnected.
Returns
true if connected

Reimplemented from Sock.

Definition at line 341 of file net.cpp.

Here is the call graph for this function:

◆ IsSelectable()

bool FuzzedSock::IsSelectable ( ) const
overridevirtual

Check if the underlying socket can be used for select(2) (or the Wait() method).

Returns
true if selectable

Reimplemented from Sock.

Definition at line 310 of file net.cpp.

◆ Listen()

int FuzzedSock::Listen ( int  backlog) const
overridevirtual

listen(2) wrapper.

Equivalent to listen(this->Get(), backlog). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 218 of file net.cpp.

Here is the call graph for this function:

◆ operator=()

FuzzedSock & FuzzedSock::operator= ( Sock &&  other)
overridevirtual

Move assignment operator, grab the socket from another object and close ours (if set).

Reimplemented from Sock.

Definition at line 73 of file net.cpp.

Here is the call graph for this function:

◆ Recv()

ssize_t FuzzedSock::Recv ( void *  buf,
size_t  len,
int  flags 
) const
overridevirtual

recv(2) wrapper.

Equivalent to recv(this->Get(), buf, len, flags);. Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 111 of file net.cpp.

Here is the call graph for this function:

◆ Send()

ssize_t FuzzedSock::Send ( const void *  data,
size_t  len,
int  flags 
) const
overridevirtual

send(2) wrapper.

Equivalent to send(this->Get(), data, len, flags);. Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 79 of file net.cpp.

Here is the call graph for this function:

◆ SetNonBlocking()

bool FuzzedSock::SetNonBlocking ( ) const
overridevirtual

Set the non-blocking option on the socket.

Returns
true if set successfully

Reimplemented from Sock.

Definition at line 297 of file net.cpp.

Here is the call graph for this function:

◆ SetSockOpt()

int FuzzedSock::SetSockOpt ( int  level,
int  opt_name,
const void *  opt_val,
socklen_t  opt_len 
) const
overridevirtual

setsockopt(2) wrapper.

Equivalent to setsockopt(this->Get(), level, opt_name, opt_val, opt_len). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 270 of file net.cpp.

Here is the call graph for this function:

◆ Wait()

bool FuzzedSock::Wait ( std::chrono::milliseconds  timeout,
Event  requested,
Event occurred = nullptr 
) const
overridevirtual

Wait for readiness for input (recv) or output (send).

Parameters
[in]timeoutWait this much for at least one of the requested events to occur.
[in]requestedWait for those events, bitwise-or of RECV and SEND.
[out]occurredIf not nullptr and the function returns true, then this indicates which of the requested events occurred (ERR will be added, even if not requested, if an exceptional event occurs on the socket). A timeout is indicated by return value of true and occurred being set to 0.
Returns
true on success (or timeout, if occurred of 0 is returned), false otherwise

Reimplemented from Sock.

Definition at line 315 of file net.cpp.

Here is the call graph for this function:

◆ WaitMany()

bool FuzzedSock::WaitMany ( std::chrono::milliseconds  timeout,
EventsPerSock events_per_sock 
) const
overridevirtual

Same as Wait(), but wait on many sockets within the same timeout.

Parameters
[in]timeoutWait this long for at least one of the requested events to occur.
[in,out]events_per_sockWait for the requested events on these sockets and set occurred for the events that actually occurred.
Returns
true on success (or timeout, if all what[].occurred are returned as 0), false otherwise

Reimplemented from Sock.

Definition at line 332 of file net.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_fuzzed_data_provider

FuzzedDataProvider& FuzzedSock::m_fuzzed_data_provider
private

Definition at line 31 of file net.h.

◆ m_peek_data

std::optional<uint8_t> FuzzedSock::m_peek_data
mutableprivate

Data to return when MSG_PEEK is used as a Recv() flag.

If MSG_PEEK is used, then our Recv() returns some random data as usual, but on the next Recv() call we must return the same data, thus we remember it here.

Definition at line 38 of file net.h.

◆ m_selectable

const bool FuzzedSock::m_selectable
private

Whether to pretend that the socket is select(2)-able.

This is randomly set in the constructor. It should remain constant so that repeated calls to IsSelectable() return the same value.

Definition at line 45 of file net.h.


The documentation for this class was generated from the following files: