Bitcoin ABC  0.24.10
P2P Digital Currency
Classes | Typedefs | Enumerations | Functions | Variables
net.h File Reference
#include <addrdb.h>
#include <addrman.h>
#include <amount.h>
#include <avalanche/delegation.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 <nodeid.h>
#include <protocol.h>
#include <random.h>
#include <streams.h>
#include <sync.h>
#include <threadinterrupt.h>
#include <uint256.h>
#include <util/check.h>
#include <validation.h>
#include <atomic>
#include <condition_variable>
#include <cstdint>
#include <deque>
#include <map>
#include <memory>
#include <thread>
#include <vector>
#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
 
struct  CNodeStats
 POD that contains various stats about a node. More...
 
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
 
struct  CNode::ProofRelay
 
class  CNode::AvalancheState
 
struct  NodeEvictionCandidate
 

Typedefs

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)
 vote for a local address More...
 
bool IsLocal (const CService &addr)
 check whether a given address is potentially local More...
 
bool GetLocal (CService &addr, const CNetAddr *paddrPeer=nullptr)
 
CAddress GetLocalAddress (const CNetAddr *paddrPeer, ServiceFlags nLocalServices)
 
std::map< CNetAddr, LocalServiceInfo > mapLocalHost GUARDED_BY (cs_mapLocalHost)
 
size_t GetMaxAddrToSend ()
 
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...
 
std::string getSubVersionEB (uint64_t MaxBlockSize)
 This function convert MaxBlockSize from byte to MB with a decimal precision one digit rounded down E.g. More...
 
std::string userAgent (const Config &config)
 
std::optional< NodeIdSelectNodeToEvict (std::vector< NodeEvictionCandidate > &&vEvictionCandidates)
 

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_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 = false
 -upnp default More...
 
static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS = 4096
 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
 
static constexpr std::chrono::minutes AVALANCHE_STATISTICS_REFRESH_PERIOD {10}
 Refresh period for the avalanche statistics computation. More...
 
static constexpr std::chrono::minutes AVALANCHE_STATISTICS_TIME_CONSTANT {10}
 Time constant for the avalanche statistics computation. More...
 
static const double AVALANCHE_STATISTICS_DECAY_FACTOR
 Pre-computed decay factor for the avalanche statistics computation. More...
 
const std::vector< std::string > CONNECTION_TYPE_DOC
 
bool fDiscover
 
bool fListen
 
bool g_relay_txes
 
RecursiveMutex cs_mapLocalHost
 
const std::string NET_MESSAGE_COMMAND_OTHER
 

Typedef Documentation

◆ mapMsgCmdSize

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

Definition at line 769 of file net.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
LOCAL_NONE 
LOCAL_IF 
LOCAL_BIND 
LOCAL_UPNP 
LOCAL_MANUAL 
LOCAL_MAX 

Definition at line 717 of file net.h.

◆ ConnectionType

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.

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 154 of file net.h.

Function Documentation

◆ AddLocal() [1/2]

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

Definition at line 279 of file net.cpp.

Here is the call graph for this function:

◆ AddLocal() [2/2]

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

Definition at line 251 of file net.cpp.

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

◆ AdvertiseLocal()

void AdvertiseLocal ( CNode pnode)

Definition at line 222 of file net.cpp.

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

◆ Discover()

void Discover ( )

Definition at line 2630 of file net.cpp.

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

◆ GetListenPort()

uint16_t GetListenPort ( )

Definition at line 143 of file net.cpp.

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

◆ GetLocal()

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

Definition at line 148 of file net.cpp.

Here is the caller graph for this function:

◆ GetLocalAddress()

CAddress GetLocalAddress ( const CNetAddr paddrPeer,
ServiceFlags  nLocalServices 
)

Definition at line 195 of file net.cpp.

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

◆ GetMaxAddrToSend()

size_t GetMaxAddrToSend ( )
inline

Definition at line 944 of file net.h.

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

◆ getSubVersionEB()

std::string getSubVersionEB ( uint64_t  MaxBlockSize)

This function convert MaxBlockSize from byte to MB with a decimal precision one digit rounded down E.g.

1660000 -> 1.6 2010000 -> 2.0 1000000 -> 1.0 230000 -> 0.2 50000 -> 0.0

NB behavior for EB<1MB not standardized yet still the function applies the same algo used for EB greater or equal to 1MB

Definition at line 3472 of file net.cpp.

Here is the caller graph for this function:

◆ GUARDED_BY()

std::map<CNetAddr, LocalServiceInfo> mapLocalHost GUARDED_BY ( cs_mapLocalHost  )

◆ InterruptMapPort()

void InterruptMapPort ( )

Definition at line 1897 of file net.cpp.

Here is the caller graph for this function:

◆ IsLocal()

bool IsLocal ( const CService addr)

check whether a given address is potentially local

Definition at line 317 of file net.cpp.

Here is the caller graph for this function:

◆ IsPeerAddrLocalGood()

bool IsPeerAddrLocalGood ( CNode pnode)

Definition at line 215 of file net.cpp.

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

◆ IsReachable() [1/2]

bool IsReachable ( const CNetAddr addr)
Returns
true if the address is in a reachable network, false otherwise

Definition at line 302 of file net.cpp.

Here is the call graph for this function:

◆ IsReachable() [2/2]

bool IsReachable ( enum Network  net)
Returns
true if the network is reachable, false otherwise

Definition at line 297 of file net.cpp.

Here is the caller graph for this function:

◆ PoissonNextSend() [1/2]

int64_t PoissonNextSend ( int64_t  now,
int  average_interval_seconds 
)

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

Definition at line 3439 of file net.cpp.

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

◆ PoissonNextSend() [2/2]

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

Wrapper to return mockable type.

Definition at line 1418 of file net.h.

Here is the call graph for this function:

◆ RemoveLocal()

void RemoveLocal ( const CService addr)

Definition at line 283 of file net.cpp.

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

◆ SeenLocal()

bool SeenLocal ( const CService addr)

vote for a local address

Definition at line 307 of file net.cpp.

Here is the caller graph for this function:

◆ SelectNodeToEvict()

std::optional<NodeId> SelectNodeToEvict ( std::vector< NodeEvictionCandidate > &&  vEvictionCandidates)

Definition at line 1007 of file net.cpp.

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

◆ SetReachable()

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

Definition at line 289 of file net.cpp.

Here is the caller graph for this function:

◆ StartMapPort()

void StartMapPort ( )

Definition at line 1894 of file net.cpp.

Here is the caller graph for this function:

◆ StopMapPort()

void StopMapPort ( )

Definition at line 1900 of file net.cpp.

Here is the caller graph for this function:

◆ userAgent()

std::string userAgent ( const Config config)

Definition at line 3486 of file net.cpp.

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

Variable Documentation

◆ AVALANCHE_STATISTICS_DECAY_FACTOR

const double AVALANCHE_STATISTICS_DECAY_FACTOR
static
Initial value:

Pre-computed decay factor for the avalanche statistics computation.

There is currently no constexpr variant of std::exp, so use a const.

Definition at line 115 of file net.h.

◆ AVALANCHE_STATISTICS_REFRESH_PERIOD

constexpr std::chrono::minutes AVALANCHE_STATISTICS_REFRESH_PERIOD {10}
staticconstexpr

Refresh period for the avalanche statistics computation.

Definition at line 108 of file net.h.

◆ AVALANCHE_STATISTICS_TIME_CONSTANT

constexpr std::chrono::minutes AVALANCHE_STATISTICS_TIME_CONSTANT {10}
staticconstexpr

Time constant for the avalanche statistics computation.

Definition at line 110 of file net.h.

◆ CONNECTION_TYPE_DOC

const std::vector<std::string> CONNECTION_TYPE_DOC
Initial value:
{
"outbound-full-relay (default automatic connections)",
"block-relay-only (does not relay transactions or addresses)",
"inbound (initiated by the peer)",
"manual (added via addnode RPC or -addnode/-connect configuration options)",
"addr-fetch (short-lived automatic connection for soliciting addresses)",
"feeler (short-lived automatic connection for testing addresses)"}

Definition at line 141 of file net.h.

◆ cs_mapLocalHost

RecursiveMutex cs_mapLocalHost

Definition at line 134 of file net.cpp.

◆ DEFAULT_BLOCKSONLY

const bool DEFAULT_BLOCKSONLY = false
static

Default for blocks only.

Definition at line 99 of file net.h.

◆ DEFAULT_FORCEDNSSEED

const bool DEFAULT_FORCEDNSSEED = false
static

Definition at line 103 of file net.h.

◆ DEFAULT_LISTEN

const bool DEFAULT_LISTEN = true
static

-listen default

Definition at line 81 of file net.h.

◆ DEFAULT_MAX_PEER_CONNECTIONS

const unsigned int DEFAULT_MAX_PEER_CONNECTIONS = 4096
static

The maximum number of peer connections to maintain.

This quantity might not be reachable on some systems, especially on platforms that do not provide a working poll() interface.

Definition at line 93 of file net.h.

◆ DEFAULT_MAX_UPLOAD_TARGET

const uint64_t DEFAULT_MAX_UPLOAD_TARGET = 0
static

The default for -maxuploadtarget.

0 = Unlimited

Definition at line 95 of file net.h.

◆ DEFAULT_MAXRECEIVEBUFFER

const size_t DEFAULT_MAXRECEIVEBUFFER = 5 * 1000
static

Definition at line 104 of file net.h.

◆ DEFAULT_MAXSENDBUFFER

const size_t DEFAULT_MAXSENDBUFFER = 1 * 1000
static

Definition at line 105 of file net.h.

◆ DEFAULT_PEER_CONNECT_TIMEOUT

const int64_t DEFAULT_PEER_CONNECT_TIMEOUT = 60
static

-peertimeout default

Definition at line 101 of file net.h.

◆ DEFAULT_UPNP

const bool DEFAULT_UPNP = false
static

-upnp default

Definition at line 86 of file net.h.

◆ DEFAULT_WHITELISTFORCERELAY

const bool DEFAULT_WHITELISTFORCERELAY = false
static

Default for -whitelistforcerelay.

Definition at line 53 of file net.h.

◆ DEFAULT_WHITELISTRELAY

const bool DEFAULT_WHITELISTRELAY = true
static

Default for -whitelistrelay.

Definition at line 51 of file net.h.

◆ fDiscover

bool fDiscover

Definition at line 131 of file net.cpp.

◆ FEELER_INTERVAL

const int FEELER_INTERVAL = 120
static

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

Definition at line 61 of file net.h.

◆ fListen

bool fListen

Definition at line 132 of file net.cpp.

◆ g_relay_txes

bool g_relay_txes

Definition at line 133 of file net.cpp.

◆ MAX_ADDNODE_CONNECTIONS

const int MAX_ADDNODE_CONNECTIONS = 8
static

Maximum number of addnode outgoing nodes.

Definition at line 75 of file net.h.

◆ MAX_ADDR_TO_SEND

constexpr size_t MAX_ADDR_TO_SEND = 1000
staticconstexpr

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

Definition at line 66 of file net.h.

◆ MAX_BLOCK_RELAY_ONLY_CONNECTIONS

const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS = 2
static

Maximum number of block-relay-only outgoing connections.

Definition at line 77 of file net.h.

◆ MAX_FEELER_CONNECTIONS

const int MAX_FEELER_CONNECTIONS = 1
static

Maximum number of feeler connections.

Definition at line 79 of file net.h.

◆ MAX_OUTBOUND_FULL_RELAY_CONNECTIONS

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 73 of file net.h.

◆ MAX_SUBVERSION_LENGTH

const unsigned int MAX_SUBVERSION_LENGTH = 256
static

Maximum length of the user agent string in version message.

Definition at line 68 of file net.h.

◆ MAX_UPLOAD_TIMEFRAME

const uint64_t MAX_UPLOAD_TIMEFRAME = 60 * 60 * 24
static

The default timeframe for -maxuploadtarget.

1 day.

Definition at line 97 of file net.h.

◆ NET_MESSAGE_COMMAND_OTHER

const std::string NET_MESSAGE_COMMAND_OTHER

Definition at line 118 of file net.cpp.

◆ TIMEOUT_INTERVAL

const int TIMEOUT_INTERVAL = 20 * 60
static

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

Definition at line 59 of file net.h.

AVALANCHE_STATISTICS_REFRESH_PERIOD
static constexpr std::chrono::minutes AVALANCHE_STATISTICS_REFRESH_PERIOD
Refresh period for the avalanche statistics computation.
Definition: net.h:108
AVALANCHE_STATISTICS_TIME_CONSTANT
static constexpr std::chrono::minutes AVALANCHE_STATISTICS_TIME_CONSTANT
Time constant for the avalanche statistics computation.
Definition: net.h:110