net.h File Reference

#include <addrdb.h>
#include <addrman.h>
#include <amount.h>
#include <bloom.h>
#include <chainparams.h>
#include <compat.h>
#include <crypto/siphash.h>
#include <hash.h>
#include <net_permissions.h>
#include <netaddress.h>
#include <optional.h>
#include <policy/feerate.h>
#include <protocol.h>
#include <random.h>
#include <streams.h>
#include <sync.h>
#include <threadinterrupt.h>
#include <uint256.h>
#include <atomic>
#include <cstdint>
#include <deque>
#include <map>
#include <thread>
#include <memory>
#include <condition_variable>
#include <arpa/inet.h>

Include dependency graph for net.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	AddedNodeInfo
struct	CSerializedNetMsg
class	CConnman
struct	CConnman::Options
struct	CConnman::ListenSocket
struct	CConnman::CachedAddrResponse
	Cache responses to addr requests to minimize privacy leak. More...
class	NetEventsInterface
	Interface for message handling. More...
struct	LocalServiceInfo
class	CNodeStats
class	CNetMessage
	Transport protocol agnostic message container. More...
class	TransportDeserializer
	The TransportDeserializer takes care of holding and deserializing the network receive buffer. More...
class	V1TransportDeserializer
class	TransportSerializer
	The TransportSerializer prepares messages for the network transport. More...
class	V1TransportSerializer
class	CNode
	Information about a peer. More...
struct	CNode::TxRelay

Typedefs
typedef int64_t	NodeId
typedef std::map< std::string, uint64_t >	mapMsgCmdSize

Enumerations
enum	ConnectionType {   ConnectionType::INBOUND, ConnectionType::OUTBOUND_FULL_RELAY, ConnectionType::MANUAL, ConnectionType::FEELER,   ConnectionType::BLOCK_RELAY, ConnectionType::ADDR_FETCH }
	Different types of connections to a peer. More...
enum	{   LOCAL_NONE, LOCAL_IF, LOCAL_BIND, LOCAL_UPNP,   LOCAL_MANUAL, LOCAL_MAX }

Functions
void	Discover ()
void	StartMapPort ()
void	InterruptMapPort ()
void	StopMapPort ()
uint16_t	GetListenPort ()
bool	IsPeerAddrLocalGood (CNode *pnode)
void	AdvertiseLocal (CNode *pnode)
void	SetReachable (enum Network net, bool reachable)
	Mark a network as reachable or unreachable (no automatic connects to it) More...
bool	IsReachable (enum Network net)
bool	IsReachable (const CNetAddr &addr)
bool	AddLocal (const CService &addr, int nScore=LOCAL_NONE)
bool	AddLocal (const CNetAddr &addr, int nScore=LOCAL_NONE)
void	RemoveLocal (const CService &addr)
bool	SeenLocal (const CService &addr)
bool	IsLocal (const CService &addr)
bool	GetLocal (CService &addr, const CNetAddr *paddrPeer=nullptr)
CAddress	GetLocalAddress (const CNetAddr *paddrPeer, ServiceFlags nLocalServices)
std::map< CNetAddr, LocalServiceInfo > mapLocalHost	GUARDED_BY (cs_mapLocalHost)
int64_t	PoissonNextSend (int64_t now, int average_interval_seconds)
	Return a timestamp in the future (in microseconds) for exponentially distributed events. More...
std::chrono::microseconds	PoissonNextSend (std::chrono::microseconds now, std::chrono::seconds average_interval)
	Wrapper to return mockable type. More...

Variables
static const bool	DEFAULT_WHITELISTRELAY = true
	Default for -whitelistrelay. More...
static const bool	DEFAULT_WHITELISTFORCERELAY = false
	Default for -whitelistforcerelay. More...
static const int	TIMEOUT_INTERVAL = 20 * 60
	Time after which to disconnect, after waiting for a ping response (or inactivity). More...
static const int	FEELER_INTERVAL = 120
	Run the feeler connection loop once every 2 minutes or 120 seconds. More...
static constexpr size_t	MAX_ADDR_TO_SEND = 1000
	The maximum number of addresses from our addrman to return in response to a getaddr message. More...
static const unsigned int	MAX_PROTOCOL_MESSAGE_LENGTH = 4 * 1000 * 1000
	Maximum length of incoming protocol messages (no message over 4 MB is currently acceptable). More...
static const unsigned int	MAX_SUBVERSION_LENGTH = 256
	Maximum length of the user agent string in version message. More...
static const int	MAX_OUTBOUND_FULL_RELAY_CONNECTIONS = 8
	Maximum number of automatic outgoing nodes over which we'll relay everything (blocks, tx, addrs, etc) More...
static const int	MAX_ADDNODE_CONNECTIONS = 8
	Maximum number of addnode outgoing nodes. More...
static const int	MAX_BLOCK_RELAY_ONLY_CONNECTIONS = 2
	Maximum number of block-relay-only outgoing connections. More...
static const int	MAX_FEELER_CONNECTIONS = 1
	Maximum number of feeler connections. More...
static const bool	DEFAULT_LISTEN = true
	-listen default More...
static const bool	DEFAULT_UPNP = USE_UPNP
	-upnp default More...
static const unsigned int	DEFAULT_MAX_PEER_CONNECTIONS = 125
	The maximum number of peer connections to maintain. More...
static const uint64_t	DEFAULT_MAX_UPLOAD_TARGET = 0
	The default for -maxuploadtarget. More...
static const uint64_t	MAX_UPLOAD_TIMEFRAME = 60 * 60 * 24
	The default timeframe for -maxuploadtarget. More...
static const bool	DEFAULT_BLOCKSONLY = false
	Default for blocks only. More...
static const int64_t	DEFAULT_PEER_CONNECT_TIMEOUT = 60
	-peertimeout default More...
static const bool	DEFAULT_FORCEDNSSEED = false
static const size_t	DEFAULT_MAXRECEIVEBUFFER = 5 * 1000
static const size_t	DEFAULT_MAXSENDBUFFER = 1 * 1000
bool	fDiscover
bool	fListen
bool	g_relay_txes
std::string	strSubVersion
	Subversion as sent to the P2P network in version messages. More...
RecursiveMutex	cs_mapLocalHost
const std::string	NET_MESSAGE_COMMAND_OTHER

Typedef Documentation

typedef std::map<std::string, uint64_t> mapMsgCmdSize

Definition at line 686 of file net.h.

typedef int64_t NodeId

Definition at line 92 of file net.h.

Enumeration Type Documentation

anonymous enum

Enumerator
LOCAL_NONE
LOCAL_IF
LOCAL_BIND
LOCAL_UPNP
LOCAL_MANUAL
LOCAL_MAX

Definition at line 637 of file net.h.

enum ConnectionType

strong

Different types of connections to a peer.

This enum encapsulates the information we have available at the time of opening or accepting the connection. Aside from INBOUND, all types are initiated by us.

If adding or removing types, please update CONNECTION_TYPE_DOC in src/rpc/net.cpp.

Enumerator
INBOUND	Inbound connections are those initiated by a peer. This is the only property we know at the time of connection, until P2P messages are exchanged.
OUTBOUND_FULL_RELAY	These are the default connections that we use to connect with the network. There is no restriction on what is relayed- by default we relay blocks, addresses & transactions. We automatically attempt to open MAX_OUTBOUND_FULL_RELAY_CONNECTIONS using addresses from our AddrMan.
MANUAL	We open manual connections to addresses that users explicitly inputted via the addnode RPC, or the -connect command line argument. Even if a manual connection is misbehaving, we do not automatically disconnect or add it to our discouragement filter.
FEELER	Feeler connections are short-lived connections made to check that a node is alive. They can be useful for: test-before-evict: if one of the peers is considered for eviction from our AddrMan because another peer is mapped to the same slot in the tried table, evict only if this longer-known peer is offline. move node addresses from New to Tried table, so that we have more connectable addresses in our AddrMan. Note that in the literature ("Eclipse Attacks on Bitcoin’s Peer-to-Peer Network") only the latter feature is referred to as "feeler connections", although in our codebase feeler connections encompass test-before-evict as well. We make these connections approximately every FEELER_INTERVAL: first we resolve previously found collisions if they exist (test-before-evict), otherwise connect to a node from the new table.
BLOCK_RELAY	We use block-relay-only connections to help prevent against partition attacks. By not relaying transactions or addresses, these connections are harder to detect by a third party, thus helping obfuscate the network topology. We automatically attempt to open MAX_BLOCK_RELAY_ONLY_ANCHORS using addresses from our anchors.dat. Then addresses from our AddrMan if MAX_BLOCK_RELAY_ONLY_CONNECTIONS isn't reached yet.
ADDR_FETCH	AddrFetch connections are short lived connections used to solicit addresses from peers. These are initiated to addresses submitted via the -seednode command line argument, or under certain conditions when the AddrMan is empty.

Definition at line 124 of file net.h.

Function Documentation

bool AddLocal	(	const CService &	addr,
		int	nScore = LOCAL_NONE
	)

Here is the caller graph for this function:

bool AddLocal	(	const CNetAddr &	addr,
		int	nScore = LOCAL_NONE
	)

void AdvertiseLocal

(

CNode *

pnode

)

void Discover

(

)

Here is the caller graph for this function:

uint16_t GetListenPort

(

)

Here is the caller graph for this function:

bool GetLocal	(	CService &	addr,
		const CNetAddr *	paddrPeer = nullptr
	)

CAddress GetLocalAddress	(	const CNetAddr *	paddrPeer,
		ServiceFlags	nLocalServices
	)

std::map<CNetAddr, LocalServiceInfo> mapLocalHost GUARDED_BY

(

cs_mapLocalHost

)

void InterruptMapPort

(

)

Here is the caller graph for this function:

bool IsLocal

(

const CService &

addr

)

bool IsPeerAddrLocalGood

(

CNode *

pnode

)

bool IsReachable

(

enum Network

net

)

Returns

true if the network is reachable, false otherwise

Here is the caller graph for this function:

bool IsReachable

(

const CNetAddr &

addr

)

Returns

true if the address is in a reachable network, false otherwise

int64_t PoissonNextSend	(	int64_t	now,
		int	average_interval_seconds
	)

Return a timestamp in the future (in microseconds) for exponentially distributed events.

Here is the caller graph for this function:

std::chrono::microseconds PoissonNextSend ( std::chrono::microseconds  now, std::chrono::seconds  average_interval  )

inline

Wrapper to return mockable type.

Definition at line 1213 of file net.h.

Here is the call graph for this function:

void RemoveLocal

(

const CService &

addr

)

Here is the caller graph for this function:

bool SeenLocal

(

const CService &

addr

)

void SetReachable	(	enum Network	net,
		bool	reachable
	)

Mark a network as reachable or unreachable (no automatic connects to it)

Note

Networks are reachable by default

Here is the caller graph for this function:

void StartMapPort

(

)

Here is the caller graph for this function:

void StopMapPort

(

)

Here is the caller graph for this function:

Variable Documentation

RecursiveMutex cs_mapLocalHost

const bool DEFAULT_BLOCKSONLY = false

static

Default for blocks only.

Definition at line 84 of file net.h.

const bool DEFAULT_FORCEDNSSEED = false

static

Definition at line 88 of file net.h.

const bool DEFAULT_LISTEN = true

static

-listen default

Definition at line 70 of file net.h.

const unsigned int DEFAULT_MAX_PEER_CONNECTIONS = 125

static

The maximum number of peer connections to maintain.

Definition at line 78 of file net.h.

const uint64_t DEFAULT_MAX_UPLOAD_TARGET = 0

static

The default for -maxuploadtarget.

0 = Unlimited

Definition at line 80 of file net.h.

const size_t DEFAULT_MAXRECEIVEBUFFER = 5 * 1000

static

Definition at line 89 of file net.h.

const size_t DEFAULT_MAXSENDBUFFER = 1 * 1000

static

Definition at line 90 of file net.h.

const int64_t DEFAULT_PEER_CONNECT_TIMEOUT = 60

static

-peertimeout default

Definition at line 86 of file net.h.

const bool DEFAULT_UPNP = USE_UPNP

static

-upnp default

Definition at line 73 of file net.h.

const bool DEFAULT_WHITELISTFORCERELAY = false

static

Default for -whitelistforcerelay.

Definition at line 49 of file net.h.

const bool DEFAULT_WHITELISTRELAY = true

static

Default for -whitelistrelay.

Definition at line 47 of file net.h.

bool fDiscover

const int FEELER_INTERVAL = 120

static

Run the feeler connection loop once every 2 minutes or 120 seconds.

Definition at line 54 of file net.h.

bool fListen

bool g_relay_txes

const int MAX_ADDNODE_CONNECTIONS = 8

static

Maximum number of addnode outgoing nodes.

Definition at line 64 of file net.h.

constexpr size_t MAX_ADDR_TO_SEND = 1000

static

The maximum number of addresses from our addrman to return in response to a getaddr message.

Definition at line 56 of file net.h.

const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS = 2

static

Maximum number of block-relay-only outgoing connections.

Definition at line 66 of file net.h.

const int MAX_FEELER_CONNECTIONS = 1

static

Maximum number of feeler connections.

Definition at line 68 of file net.h.

const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS = 8

static

Maximum number of automatic outgoing nodes over which we'll relay everything (blocks, tx, addrs, etc)

Definition at line 62 of file net.h.

const unsigned int MAX_PROTOCOL_MESSAGE_LENGTH = 4 * 1000 * 1000

static

Maximum length of incoming protocol messages (no message over 4 MB is currently acceptable).

Definition at line 58 of file net.h.

const unsigned int MAX_SUBVERSION_LENGTH = 256

static

Maximum length of the user agent string in version message.

Definition at line 60 of file net.h.

const uint64_t MAX_UPLOAD_TIMEFRAME = 60 * 60 * 24

static

The default timeframe for -maxuploadtarget.

1 day.

Definition at line 82 of file net.h.

const std::string NET_MESSAGE_COMMAND_OTHER

std::string strSubVersion

Subversion as sent to the P2P network in version messages.

const int TIMEOUT_INTERVAL = 20 * 60

static

Time after which to disconnect, after waiting for a ping response (or inactivity).

Definition at line 52 of file net.h.