Bitcoin Core  21.99.0
P2P Digital Currency
Classes | Macros | Enumerations | Functions | Variables
net.cpp File Reference
#include <net.h>
#include <banman.h>
#include <clientversion.h>
#include <compat.h>
#include <consensus/consensus.h>
#include <crypto/sha256.h>
#include <i2p.h>
#include <net_permissions.h>
#include <netbase.h>
#include <node/ui_interface.h>
#include <protocol.h>
#include <random.h>
#include <scheduler.h>
#include <util/sock.h>
#include <util/strencodings.h>
#include <util/translation.h>
#include <fcntl.h>
#include <algorithm>
#include <cstdint>
#include <functional>
#include <optional>
#include <unordered_map>
#include <math.h>
Include dependency graph for net.cpp:

Go to the source code of this file.

Classes

class  CNetCleanup
 

Macros

#define FEELER_SLEEP_WINDOW   1
 
#define X(name)   stats.name = name
 

Enumerations

enum  BindFlags { BF_NONE = 0, BF_EXPLICIT = (1U << 0), BF_REPORT_ERROR = (1U << 1), BF_DONT_ADVERTISE = (1U << 2) }
 Used to pass flags to the Bind() function. More...
 

Functions

std::map< CNetAddr, LocalServiceInfo > mapLocalHost GUARDED_BY (cs_mapLocalHost)
 
uint16_t GetListenPort ()
 
bool GetLocal (CService &addr, const CNetAddr *paddrPeer)
 
static std::vector< CAddressConvertSeeds (const std::vector< uint8_t > &vSeedsIn)
 Convert the serialized seeds into usable address objects. More...
 
CAddress GetLocalAddress (const CNetAddr *paddrPeer, ServiceFlags nLocalServices)
 
static int GetnScore (const CService &addr)
 
bool IsPeerAddrLocalGood (CNode *pnode)
 
std::optional< CAddressGetLocalAddrForPeer (CNode *pnode)
 Returns a local address that we should advertise to this peer. More...
 
bool AddLocal (const CService &addr, int nScore)
 
bool AddLocal (const CNetAddr &addr, int nScore)
 
void RemoveLocal (const CService &addr)
 
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 SeenLocal (const CService &addr)
 vote for a local address More...
 
bool IsLocal (const CService &addr)
 check whether a given address is potentially local More...
 
static CAddress GetBindAddress (SOCKET sock)
 Get the bind address for a socket as CAddress. More...
 
std::string ConnectionTypeAsString (ConnectionType conn_type)
 Convert ConnectionType enum to a string value. More...
 
static bool ReverseCompareNodeMinPingTime (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool ReverseCompareNodeTimeConnected (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareLocalHostTimeConnected (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareOnionTimeConnected (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareNetGroupKeyed (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareNodeBlockTime (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareNodeTXTime (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
static bool CompareNodeBlockRelayOnlyTime (const NodeEvictionCandidate &a, const NodeEvictionCandidate &b)
 
template<typename T , typename Comparator >
static void EraseLastKElements (std::vector< T > &elements, Comparator comparator, size_t k, std::function< bool(const NodeEvictionCandidate &)> predicate=[](const NodeEvictionCandidate &n) { return true;})
 Sort an array by the specified comparator, then erase the last K elements where predicate is true. More...
 
void ProtectEvictionCandidatesByRatio (std::vector< NodeEvictionCandidate > &vEvictionCandidates)
 Protect desirable or disadvantaged inbound peers from eviction by ratio. More...
 
std::optional< NodeIdSelectNodeToEvict (std::vector< NodeEvictionCandidate > &&vEvictionCandidates)
 Select an inbound peer to evict after filtering out (protecting) peers having distinct, difficult-to-forge characteristics. More...
 
void Discover ()
 
std::chrono::microseconds PoissonNextSend (std::chrono::microseconds now, std::chrono::seconds average_interval)
 Return a timestamp in the future (in microseconds) for exponentially distributed events. More...
 
void CaptureMessage (const CAddress &addr, const std::string &msg_type, const Span< const unsigned char > &data, bool is_incoming)
 Dump binary message to file, with timestamp. More...
 

Variables

static constexpr size_t MAX_BLOCK_RELAY_ONLY_ANCHORS = 2
 Maximum number of block-relay-only anchor connections. More...
 
const char *const ANCHORS_DATABASE_FILENAME = "anchors.dat"
 Anchor IP address database file name. More...
 
static constexpr std::chrono::minutes DUMP_PEERS_INTERVAL {15}
 
static constexpr int DNSSEEDS_TO_QUERY_AT_ONCE = 3
 Number of DNS seeds to query when the number of connections is low. More...
 
static constexpr std::chrono::seconds DNSSEEDS_DELAY_FEW_PEERS {11}
 How long to delay before querying DNS seeds. More...
 
static constexpr std::chrono::minutes DNSSEEDS_DELAY_MANY_PEERS {5}
 
static constexpr int DNSSEEDS_DELAY_PEER_THRESHOLD = 1000
 
static constexpr std::chrono::seconds MAX_UPLOAD_TIMEFRAME {60 * 60 * 24}
 The default timeframe for -maxuploadtarget. More...
 
static const uint64_t SELECT_TIMEOUT_MILLISECONDS = 50
 
const std::string NET_MESSAGE_COMMAND_OTHER = "*other*"
 
static const uint64_t RANDOMIZER_ID_NETGROUP = 0x6c0edd8036ef4036ULL
 
static const uint64_t RANDOMIZER_ID_LOCALHOSTNONCE = 0xd93e69e2bbfa5735ULL
 
static const uint64_t RANDOMIZER_ID_ADDRCACHE = 0x1cf2e4ddd306dda9ULL
 
bool fDiscover = true
 
bool fListen = true
 
RecursiveMutex cs_mapLocalHost
 
std::string strSubVersion
 Subversion as sent to the P2P network in version messages. More...
 
static CNetCleanup instance_of_cnetcleanup
 

Macro Definition Documentation

◆ FEELER_SLEEP_WINDOW

#define FEELER_SLEEP_WINDOW   1

Definition at line 79 of file net.cpp.

◆ X

#define X (   name)    stats.name = name

Definition at line 564 of file net.cpp.

Enumeration Type Documentation

◆ BindFlags

enum BindFlags

Used to pass flags to the Bind() function.

Enumerator
BF_NONE 
BF_EXPLICIT 
BF_REPORT_ERROR 
BF_DONT_ADVERTISE 

Do not call AddLocal() for our special addresses, e.g., for incoming Tor connections, to prevent gossiping them over the network.

Definition at line 82 of file net.cpp.

Function Documentation

◆ AddLocal() [1/2]

bool AddLocal ( const CNetAddr addr,
int  nScore 
)

Definition at line 253 of file net.cpp.

Here is the call graph for this function:

◆ AddLocal() [2/2]

bool AddLocal ( const CService addr,
int  nScore 
)

Definition at line 227 of file net.cpp.

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

◆ CaptureMessage()

void CaptureMessage ( const CAddress addr,
const std::string &  msg_type,
const Span< const unsigned char > &  data,
bool  is_incoming 
)

Dump binary message to file, with timestamp.

Definition at line 3035 of file net.cpp.

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

◆ CompareLocalHostTimeConnected()

static bool CompareLocalHostTimeConnected ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 842 of file net.cpp.

Here is the caller graph for this function:

◆ CompareNetGroupKeyed()

static bool CompareNetGroupKeyed ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 854 of file net.cpp.

Here is the caller graph for this function:

◆ CompareNodeBlockRelayOnlyTime()

static bool CompareNodeBlockRelayOnlyTime ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 876 of file net.cpp.

Here is the caller graph for this function:

◆ CompareNodeBlockTime()

static bool CompareNodeBlockTime ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 858 of file net.cpp.

Here is the caller graph for this function:

◆ CompareNodeTXTime()

static bool CompareNodeTXTime ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 866 of file net.cpp.

Here is the caller graph for this function:

◆ CompareOnionTimeConnected()

static bool CompareOnionTimeConnected ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 848 of file net.cpp.

Here is the caller graph for this function:

◆ ConnectionTypeAsString()

std::string ConnectionTypeAsString ( ConnectionType  conn_type)

Convert ConnectionType enum to a string value.

Definition at line 512 of file net.cpp.

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

◆ ConvertSeeds()

static std::vector<CAddress> ConvertSeeds ( const std::vector< uint8_t > &  vSeedsIn)
static

Convert the serialized seeds into usable address objects.

Definition at line 149 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 2330 of file net.cpp.

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

◆ EraseLastKElements()

template<typename T , typename Comparator >
static void EraseLastKElements ( std::vector< T > &  elements,
Comparator  comparator,
size_t  k,
std::function< bool(const NodeEvictionCandidate &)>  predicate = [](const NodeEvictionCandidate& n) { return true; } 
)
static

Sort an array by the specified comparator, then erase the last K elements where predicate is true.

Definition at line 886 of file net.cpp.

Here is the caller graph for this function:

◆ GetBindAddress()

static CAddress GetBindAddress ( SOCKET  sock)
static

Get the bind address for a socket as CAddress.

Definition at line 364 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 118 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 
)

Definition at line 124 of file net.cpp.

Here is the caller graph for this function:

◆ GetLocalAddress()

CAddress GetLocalAddress ( const CNetAddr paddrPeer,
ServiceFlags  nLocalServices 
)

Definition at line 174 of file net.cpp.

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

◆ GetLocalAddrForPeer()

std::optional<CAddress> GetLocalAddrForPeer ( CNode pnode)

Returns a local address that we should advertise to this peer.

Definition at line 201 of file net.cpp.

Here is the call graph for this function:

◆ GetnScore()

static int GetnScore ( const CService addr)
static

Definition at line 186 of file net.cpp.

Here is the caller graph for this function:

◆ GUARDED_BY()

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

◆ IsLocal()

bool IsLocal ( const CService addr)

check whether a given address is potentially local

Definition at line 298 of file net.cpp.

Here is the caller graph for this function:

◆ IsPeerAddrLocalGood()

bool IsPeerAddrLocalGood ( CNode pnode)

Definition at line 194 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 279 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 273 of file net.cpp.

Here is the caller graph for this function:

◆ PoissonNextSend()

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

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

Definition at line 3017 of file net.cpp.

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

◆ ProtectEvictionCandidatesByRatio()

void ProtectEvictionCandidatesByRatio ( std::vector< NodeEvictionCandidate > &  vEvictionCandidates)

Protect desirable or disadvantaged inbound peers from eviction by ratio.

This function protects half of the peers which have been connected the longest, to replicate the non-eviction implicit behavior and preclude attacks that start later.

Half of these protected spots (1/4 of the total) are reserved for onion peers connected via our tor control service, if any, sorted by longest uptime, even if they're not longest uptime overall. Any remaining slots of the 1/4 are then allocated to protect localhost peers, if any (or up to 2 localhost peers if no slots remain and 2 or more onion peers were protected), sorted by longest uptime, as manually configured hidden services not using -bind=addr[:port]=onion will not be detected as inbound onion connections.

This helps protect onion peers, which tend to be otherwise disadvantaged under our eviction criteria for their higher min ping times relative to IPv4 and IPv6 peers, and favorise the diversity of peer connections.

This function was extracted from SelectNodeToEvict() to be able to test the ratio-based protection logic deterministically.

Definition at line 895 of file net.cpp.

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

◆ RemoveLocal()

void RemoveLocal ( const CService addr)

Definition at line 258 of file net.cpp.

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

◆ ReverseCompareNodeMinPingTime()

static bool ReverseCompareNodeMinPingTime ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 832 of file net.cpp.

Here is the caller graph for this function:

◆ ReverseCompareNodeTimeConnected()

static bool ReverseCompareNodeTimeConnected ( const NodeEvictionCandidate a,
const NodeEvictionCandidate b 
)
static

Definition at line 837 of file net.cpp.

Here is the caller graph for this function:

◆ SeenLocal()

bool SeenLocal ( const CService addr)

vote for a local address

Definition at line 285 of file net.cpp.

◆ SelectNodeToEvict()

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

Select an inbound peer to evict after filtering out (protecting) peers having distinct, difficult-to-forge characteristics.

The protection logic picks out fixed numbers of desirable peers per various criteria, followed by (mostly) ratios of desirable or disadvantaged peers. If any eviction candidates remain, the selection logic chooses a peer to evict.

Definition at line 931 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 265 of file net.cpp.

Here is the caller graph for this function:

Variable Documentation

◆ ANCHORS_DATABASE_FILENAME

const char* const ANCHORS_DATABASE_FILENAME = "anchors.dat"

Anchor IP address database file name.

Definition at line 54 of file net.cpp.

◆ cs_mapLocalHost

RecursiveMutex cs_mapLocalHost

Definition at line 107 of file net.cpp.

◆ DNSSEEDS_DELAY_FEW_PEERS

constexpr std::chrono::seconds DNSSEEDS_DELAY_FEW_PEERS {11}
staticconstexpr

How long to delay before querying DNS seeds.

If we have more than THRESHOLD entries in addrman, then it's likely that we got those addresses from having previously connected to the P2P network, and that we'll be able to successfully reconnect to the P2P network via contacting one of them. So if that's the case, spend a little longer trying to connect to known peers before querying the DNS seeds.

Definition at line 71 of file net.cpp.

◆ DNSSEEDS_DELAY_MANY_PEERS

constexpr std::chrono::minutes DNSSEEDS_DELAY_MANY_PEERS {5}
staticconstexpr

Definition at line 72 of file net.cpp.

◆ DNSSEEDS_DELAY_PEER_THRESHOLD

constexpr int DNSSEEDS_DELAY_PEER_THRESHOLD = 1000
staticconstexpr

Definition at line 73 of file net.cpp.

◆ DNSSEEDS_TO_QUERY_AT_ONCE

constexpr int DNSSEEDS_TO_QUERY_AT_ONCE = 3
staticconstexpr

Number of DNS seeds to query when the number of connections is low.

Definition at line 60 of file net.cpp.

◆ DUMP_PEERS_INTERVAL

constexpr std::chrono::minutes DUMP_PEERS_INTERVAL {15}
staticconstexpr

Definition at line 57 of file net.cpp.

◆ fDiscover

bool fDiscover = true

Definition at line 105 of file net.cpp.

◆ fListen

bool fListen = true

Definition at line 106 of file net.cpp.

◆ instance_of_cnetcleanup

CNetCleanup instance_of_cnetcleanup
static

Definition at line 2579 of file net.cpp.

◆ MAX_BLOCK_RELAY_ONLY_ANCHORS

constexpr size_t MAX_BLOCK_RELAY_ONLY_ANCHORS = 2
staticconstexpr

Maximum number of block-relay-only anchor connections.

Definition at line 51 of file net.cpp.

◆ MAX_UPLOAD_TIMEFRAME

constexpr std::chrono::seconds MAX_UPLOAD_TIMEFRAME {60 * 60 * 24}
staticconstexpr

The default timeframe for -maxuploadtarget.

1 day.

Definition at line 76 of file net.cpp.

◆ NET_MESSAGE_COMMAND_OTHER

const std::string NET_MESSAGE_COMMAND_OTHER = "*other*"

Definition at line 97 of file net.cpp.

◆ RANDOMIZER_ID_ADDRCACHE

const uint64_t RANDOMIZER_ID_ADDRCACHE = 0x1cf2e4ddd306dda9ULL
static

Definition at line 101 of file net.cpp.

◆ RANDOMIZER_ID_LOCALHOSTNONCE

const uint64_t RANDOMIZER_ID_LOCALHOSTNONCE = 0xd93e69e2bbfa5735ULL
static

Definition at line 100 of file net.cpp.

◆ RANDOMIZER_ID_NETGROUP

const uint64_t RANDOMIZER_ID_NETGROUP = 0x6c0edd8036ef4036ULL
static

Definition at line 99 of file net.cpp.

◆ SELECT_TIMEOUT_MILLISECONDS

const uint64_t SELECT_TIMEOUT_MILLISECONDS = 50
static

Definition at line 95 of file net.cpp.

◆ strSubVersion

std::string strSubVersion

Subversion as sent to the P2P network in version messages.

Definition at line 110 of file net.cpp.