net.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2019 The Bitcoin Core developers
// Copyright (c) 2017-2019 The Bitcoin developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_NET_H
#define BITCOIN_NET_H
 
#include <avalanche/proofid.h>
#include <avalanche/proofradixtreeadapter.h>
#include <chainparams.h>
#include <common/bloom.h>
#include <compat/compat.h>
#include <consensus/amount.h>
#include <crypto/siphash.h>
#include <hash.h>
#include <i2p.h>
#include <kernel/cs_main.h>
#include <logging.h>
#include <net_permissions.h>
#include <netaddress.h>
#include <netbase.h>
#include <node/connection_types.h>
#include <node/eviction.h>
#include <node/protocol_version.h>
#include <nodeid.h>
#include <protocol.h>
#include <pubkey.h>
#include <radix.h>
#include <random.h>
#include <span.h>
#include <streams.h>
#include <sync.h>
#include <uint256.h>
#include <util/check.h>
#include <util/sock.h>
#include <util/time.h>
 
#include <atomic>
#include <condition_variable>
#include <cstdint>
#include <deque>
#include <functional>
#include <list>
#include <map>
#include <memory>
#include <optional>
#include <queue>
#include <thread>
#include <vector>
 
class AddrMan;
class BanMan;
class Config;
class CNode;
class CScheduler;
class CThreadInterrupt;
struct bilingual_str;
 
static constexpr std::chrono::minutes TIMEOUT_INTERVAL{20};
static constexpr auto FEELER_INTERVAL = 2min;
static constexpr auto EXTRA_BLOCK_RELAY_ONLY_PEER_INTERVAL = 5min;
static const unsigned int MAX_SUBVERSION_LENGTH = 256;
static const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS = 16;
static const int MAX_ADDNODE_CONNECTIONS = 8;
static const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS = 2;
static const int DEFAULT_MAX_AVALANCHE_OUTBOUND_CONNECTIONS = 300;
static const int MAX_FEELER_CONNECTIONS = 1;
static const bool DEFAULT_LISTEN = true;
static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS = 4096;
static constexpr uint64_t DEFAULT_MAX_UPLOAD_TARGET = 0;
static const bool DEFAULT_BLOCKSONLY = false;
static const int64_t DEFAULT_PEER_CONNECT_TIMEOUT = 60;
static const int NUM_FDS_MESSAGE_CAPTURE = 1;
 
static const bool DEFAULT_FORCEDNSSEED = false;
static const bool DEFAULT_DNSSEED = true;
static const bool DEFAULT_FIXEDSEEDS = true;
static const size_t DEFAULT_MAXRECEIVEBUFFER = 5 * 1000;
static const size_t DEFAULT_MAXSENDBUFFER = 1 * 1000;
 
struct AddedNodeInfo {
    std::string strAddedNode;
    CService resolvedAddress;
    bool fConnected;
    bool fInbound;
};
 
struct CNodeStats;
class CClientUIInterface;
 
struct CSerializedNetMsg {
    CSerializedNetMsg() = default;
    CSerializedNetMsg(CSerializedNetMsg &&) = default;
    CSerializedNetMsg &operator=(CSerializedNetMsg &&) = default;
    // No copying, only moves.
    CSerializedNetMsg(const CSerializedNetMsg &msg) = delete;
    CSerializedNetMsg &operator=(const CSerializedNetMsg &) = delete;
 
    CSerializedNetMsg Copy() const {
        CSerializedNetMsg copy;
        copy.data = data;
        copy.m_type = m_type;
        return copy;
    }
 
    std::vector<uint8_t> data;
    std::string m_type;
};
 
const std::vector<std::string> CONNECTION_TYPE_DOC{
    "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)"};
 
void Discover();
 
uint16_t GetListenPort();
 
enum {
    // unknown
    LOCAL_NONE,
    // address a local interface listens on
    LOCAL_IF,
    // address explicit bound to
    LOCAL_BIND,
    // address reported by PCP
    LOCAL_MAPPED,
    // address explicitly specified (-externalip=)
    LOCAL_MANUAL,
 
    LOCAL_MAX
};
 
bool IsPeerAddrLocalGood(CNode *pnode);
std::optional<CService> GetLocalAddrForPeer(CNode &node);
 
void SetReachable(enum Network net, bool reachable);
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);
CService GetLocalAddress(const CNetAddr &addrPeer);
 
extern bool fDiscover;
extern bool fListen;
 
struct LocalServiceInfo {
    int nScore;
    uint16_t nPort;
};
 
extern GlobalMutex g_maplocalhost_mutex;
extern std::map<CNetAddr, LocalServiceInfo>
    mapLocalHost GUARDED_BY(g_maplocalhost_mutex);
 
extern const std::string NET_MESSAGE_TYPE_OTHER;
typedef std::map</* message type */ std::string, /* total bytes */ uint64_t>
    mapMsgTypeSize;
 
struct CNodeStats {
    NodeId nodeid;
    std::chrono::seconds m_last_send;
    std::chrono::seconds m_last_recv;
    std::chrono::seconds m_last_tx_time;
    std::chrono::seconds m_last_proof_time;
    std::chrono::seconds m_last_block_time;
    std::chrono::seconds m_connected;
    int64_t nTimeOffset;
    std::string m_addr_name;
    int nVersion;
    std::string cleanSubVer;
    bool fInbound;
    // We requested high bandwidth connection to peer
    bool m_bip152_highbandwidth_to;
    // Peer requested high bandwidth connection
    bool m_bip152_highbandwidth_from;
    int m_starting_height;
    uint64_t nSendBytes;
    mapMsgTypeSize mapSendBytesPerMsgType;
    uint64_t nRecvBytes;
    mapMsgTypeSize mapRecvBytesPerMsgType;
    NetPermissionFlags m_permission_flags;
    std::chrono::microseconds m_last_ping_time;
    std::chrono::microseconds m_min_ping_time;
    // Our address, as reported by the peer
    std::string addrLocal;
    // Address of this peer
    CAddress addr;
    // Bind address of our side of the connection
    CAddress addrBind;
    // Network the peer connected through
    Network m_network;
    uint32_t m_mapped_as;
    ConnectionType m_conn_type;
    std::optional<double> m_availabilityScore;
};
 
class CNetMessage {
public:
    DataStream m_recv;
    std::chrono::microseconds m_time{0};
    uint32_t m_message_size{0};
    uint32_t m_raw_message_size{0};
    std::string m_type;
 
    CNetMessage(DataStream &&recv_in) : m_recv(std::move(recv_in)) {}
    // Only one CNetMessage object will exist for the same message on either
    // the receive or processing queue. For performance reasons we therefore
    // delete the copy constructor and assignment operator to avoid the
    // possibility of copying CNetMessage objects.
    CNetMessage(CNetMessage &&) = default;
    CNetMessage(const CNetMessage &) = delete;
    CNetMessage &operator=(CNetMessage &&) = default;
    CNetMessage &operator=(const CNetMessage &) = delete;
};
 
class TransportDeserializer {
public:
    // returns true if the current deserialization is complete
    virtual bool Complete() const = 0;
    virtual int Read(const Config &config, Span<const uint8_t> &msg_bytes) = 0;
    // decomposes a message from the context
    virtual std::optional<CNetMessage>
    GetMessage(std::chrono::microseconds time, uint32_t &out_err) = 0;
    virtual ~TransportDeserializer() {}
};
 
class V1TransportDeserializer final : public TransportDeserializer {
private:
    const Config &m_config;
    // Only for logging
    const NodeId m_node_id;
    mutable CHash256 hasher;
    mutable uint256 data_hash;
 
    // Parsing header (false) or data (true)
    bool in_data;
    // Partially received header.
    DataStream hdrbuf{};
    // Complete header.
    CMessageHeader hdr;
    // Received message data.
    DataStream vRecv{};
    uint32_t nHdrPos;
    uint32_t nDataPos;
 
    const uint256 &GetMessageHash() const;
    int readHeader(const Config &config, Span<const uint8_t> msg_bytes);
    int readData(Span<const uint8_t> msg_bytes);
 
    void Reset() {
        vRecv.clear();
        hdrbuf.clear();
        hdrbuf.resize(24);
        in_data = false;
        nHdrPos = 0;
        nDataPos = 0;
        data_hash.SetNull();
        hasher.Reset();
    }
 
public:
    explicit V1TransportDeserializer(const Config &config, const NodeId node_id)
        : m_config(config), m_node_id(node_id) {
        Reset();
    }
 
    bool Complete() const override {
        if (!in_data) {
            return false;
        }
 
        return (hdr.nMessageSize == nDataPos);
    }
 
    int Read(const Config &config, Span<const uint8_t> &msg_bytes) override {
        int ret = in_data ? readData(msg_bytes) : readHeader(config, msg_bytes);
        if (ret < 0) {
            Reset();
        } else {
            msg_bytes = msg_bytes.subspan(ret);
        }
        return ret;
    }
 
    std::optional<CNetMessage> GetMessage(std::chrono::microseconds time,
                                          uint32_t &out_err_raw_size) override;
};
 
class TransportSerializer {
public:
    // prepare message for transport (header construction, error-correction
    // computation, payload encryption, etc.)
    virtual void prepareForTransport(const Config &config,
                                     CSerializedNetMsg &msg,
                                     std::vector<uint8_t> &header) const = 0;
    virtual ~TransportSerializer() {}
};
 
class V1TransportSerializer : public TransportSerializer {
public:
    void prepareForTransport(const Config &config, CSerializedNetMsg &msg,
                             std::vector<uint8_t> &header) const override;
};
 
struct CNodeOptions {
    std::unique_ptr<i2p::sam::Session> i2p_sam_session = nullptr;
    NetPermissionFlags permission_flags = NetPermissionFlags::None;
    bool prefer_evict = false;
    size_t recv_flood_size{DEFAULT_MAXRECEIVEBUFFER * 1000};
};
 
class CNode {
public:
    // Used only by SocketHandler thread
    const std::unique_ptr<TransportDeserializer> m_deserializer;
    const std::unique_ptr<const TransportSerializer> m_serializer;
 
    const NetPermissionFlags m_permission_flags{NetPermissionFlags::None};
 
    std::shared_ptr<Sock> m_sock GUARDED_BY(m_sock_mutex);
 
    size_t nSendSize GUARDED_BY(cs_vSend){0};
    size_t nSendOffset GUARDED_BY(cs_vSend){0};
    uint64_t nSendBytes GUARDED_BY(cs_vSend){0};
    std::deque<std::vector<uint8_t>> vSendMsg GUARDED_BY(cs_vSend);
    Mutex cs_vSend;
    Mutex m_sock_mutex;
    Mutex cs_vRecv;
 
    uint64_t nRecvBytes GUARDED_BY(cs_vRecv){0};
 
    std::atomic<std::chrono::seconds> m_last_send{0s};
    std::atomic<std::chrono::seconds> m_last_recv{0s};
    const std::chrono::seconds m_connected;
    std::atomic<int64_t> nTimeOffset{0};
    // Address of this peer
    const CAddress addr;
    // Bind address of our side of the connection
    const CAddress addrBind;
    const std::string m_addr_name;
    const bool m_inbound_onion;
    std::atomic<int> nVersion{0};
    // The nonce provided by the remote host.
    uint64_t nRemoteHostNonce{0};
    // The extra entropy provided by the remote host.
    uint64_t nRemoteExtraEntropy{0};
    Mutex m_subver_mutex;
    std::string cleanSubVer GUARDED_BY(m_subver_mutex){};
    // This peer is preferred for eviction.
    const bool m_prefer_evict{false};
    bool HasPermission(NetPermissionFlags permission) const {
        return NetPermissions::HasFlag(m_permission_flags, permission);
    }
    std::atomic_bool fSuccessfullyConnected{false};
    // Setting fDisconnect to true will cause the node to be disconnected the
    // next time DisconnectNodes() runs
    std::atomic_bool fDisconnect{false};
    CSemaphoreGrant grantOutbound;
    std::atomic<int> nRefCount{0};
 
    const uint64_t nKeyedNetGroup;
    std::atomic_bool fPauseRecv{false};
    std::atomic_bool fPauseSend{false};
 
    const ConnectionType m_conn_type;
 
    void MarkReceivedMsgsForProcessing()
        EXCLUSIVE_LOCKS_REQUIRED(!m_msg_process_queue_mutex);
 
    std::optional<std::pair<CNetMessage, bool>> PollMessage()
        EXCLUSIVE_LOCKS_REQUIRED(!m_msg_process_queue_mutex);
 
    void AccountForSentBytes(const std::string &msg_type, size_t sent_bytes)
        EXCLUSIVE_LOCKS_REQUIRED(cs_vSend) {
        mapSendBytesPerMsgType[msg_type] += sent_bytes;
    }
 
    bool IsOutboundOrBlockRelayConn() const {
        switch (m_conn_type) {
            case ConnectionType::OUTBOUND_FULL_RELAY:
            case ConnectionType::BLOCK_RELAY:
            case ConnectionType::AVALANCHE_OUTBOUND:
                return true;
            case ConnectionType::INBOUND:
            case ConnectionType::MANUAL:
            case ConnectionType::ADDR_FETCH:
            case ConnectionType::FEELER:
                return false;
        } // no default case, so the compiler can warn about missing cases
 
        assert(false);
    }
 
    bool IsFullOutboundConn() const {
        return m_conn_type == ConnectionType::OUTBOUND_FULL_RELAY ||
               m_conn_type == ConnectionType::AVALANCHE_OUTBOUND;
    }
 
    bool IsManualConn() const { return m_conn_type == ConnectionType::MANUAL; }
 
    bool IsBlockOnlyConn() const {
        return m_conn_type == ConnectionType::BLOCK_RELAY;
    }
 
    bool IsFeelerConn() const { return m_conn_type == ConnectionType::FEELER; }
 
    bool IsAddrFetchConn() const {
        return m_conn_type == ConnectionType::ADDR_FETCH;
    }
 
    bool IsInboundConn() const {
        return m_conn_type == ConnectionType::INBOUND;
    }
 
    bool IsAvalancheOutboundConnection() const {
        return m_conn_type == ConnectionType::AVALANCHE_OUTBOUND;
    }
 
    bool ExpectServicesFromConn() const {
        switch (m_conn_type) {
            case ConnectionType::INBOUND:
            case ConnectionType::MANUAL:
            case ConnectionType::FEELER:
                return false;
            case ConnectionType::OUTBOUND_FULL_RELAY:
            case ConnectionType::BLOCK_RELAY:
            case ConnectionType::ADDR_FETCH:
            case ConnectionType::AVALANCHE_OUTBOUND:
                return true;
        } // no default case, so the compiler can warn about missing cases
 
        assert(false);
    }
 
    Network ConnectedThroughNetwork() const;
 
    // We selected peer as (compact blocks) high-bandwidth peer (BIP152)
    std::atomic<bool> m_bip152_highbandwidth_to{false};
    // Peer selected us as (compact blocks) high-bandwidth peer (BIP152)
    std::atomic<bool> m_bip152_highbandwidth_from{false};
 
    std::atomic_bool m_has_all_wanted_services{false};
 
    std::atomic_bool m_relays_txs{false};
 
    std::atomic_bool m_bloom_filter_loaded{false};
 
    // True if we know this peer is using Avalanche (at least polling)
    std::atomic<bool> m_avalanche_enabled{false};
 
    mutable Mutex cs_avalanche_pubkey;
    // Pubkey used to verify signatures on Avalanche messages from this peer
    std::optional<CPubKey> m_avalanche_pubkey GUARDED_BY(cs_avalanche_pubkey);
 
    void invsPolled(uint32_t count);
 
    void invsVoted(uint32_t count);
 
    void updateAvailabilityScore(double decayFactor);
    double getAvailabilityScore() const;
 
    // Store the next time we will consider a getavaaddr message from this peer
    std::chrono::seconds m_nextGetAvaAddr{0};
 
    // The last time the node sent us a faulty message
    std::atomic<std::chrono::seconds> m_avalanche_last_message_fault{0s};
    std::atomic<int> m_avalanche_message_fault_counter{0};
    std::atomic<int> m_avalanche_message_fault_score{0};
 
    SteadyMilliseconds m_last_poll{};
 
    std::atomic<std::chrono::seconds> m_last_block_time{0s};
 
    std::atomic<std::chrono::seconds> m_last_tx_time{0s};
 
    std::atomic<std::chrono::seconds> m_last_proof_time{0s};
 
    std::atomic<std::chrono::microseconds> m_last_ping_time{0us};
 
    std::atomic<std::chrono::microseconds> m_min_ping_time{
        std::chrono::microseconds::max()};
 
    CNode(NodeId id, std::shared_ptr<Sock> sock, const CAddress &addrIn,
          uint64_t nKeyedNetGroupIn, uint64_t nLocalHostNonceIn,
          uint64_t nLocalExtraEntropyIn, const CAddress &addrBindIn,
          const std::string &addrNameIn, ConnectionType conn_type_in,
          bool inbound_onion, CNodeOptions &&node_opts = {});
    CNode(const CNode &) = delete;
    CNode &operator=(const CNode &) = delete;
 
    void PongReceived(std::chrono::microseconds ping_time) {
        m_last_ping_time = ping_time;
        m_min_ping_time = std::min(m_min_ping_time.load(), ping_time);
    }
 
    NodeId GetId() const { return id; }
 
    uint64_t GetLocalNonce() const { return nLocalHostNonce; }
    uint64_t GetLocalExtraEntropy() const { return nLocalExtraEntropy; }
 
    int GetRefCount() const {
        assert(nRefCount >= 0);
        return nRefCount;
    }
 
    bool ReceiveMsgBytes(const Config &config, Span<const uint8_t> msg_bytes,
                         bool &complete) EXCLUSIVE_LOCKS_REQUIRED(!cs_vRecv);
 
    void SetCommonVersion(int greatest_common_version) {
        Assume(m_greatest_common_version == INIT_PROTO_VERSION);
        m_greatest_common_version = greatest_common_version;
    }
    int GetCommonVersion() const { return m_greatest_common_version; }
 
    CService GetAddrLocal() const EXCLUSIVE_LOCKS_REQUIRED(!m_addr_local_mutex);
    void SetAddrLocal(const CService &addrLocalIn)
        EXCLUSIVE_LOCKS_REQUIRED(!m_addr_local_mutex);
 
    CNode *AddRef() {
        nRefCount++;
        return this;
    }
 
    void Release() { nRefCount--; }
 
    void CloseSocketDisconnect() EXCLUSIVE_LOCKS_REQUIRED(!m_sock_mutex);
 
    void copyStats(CNodeStats &stats)
        EXCLUSIVE_LOCKS_REQUIRED(!m_subver_mutex, !m_addr_local_mutex,
                                 !cs_vSend, !cs_vRecv);
 
    std::string ConnectionTypeAsString() const {
        return ::ConnectionTypeAsString(m_conn_type);
    }
 
private:
    const NodeId id;
    const uint64_t nLocalHostNonce;
    const uint64_t nLocalExtraEntropy;
    std::atomic<int> m_greatest_common_version{INIT_PROTO_VERSION};
 
    const size_t m_recv_flood_size;
    // Used only by SocketHandler thread
    std::list<CNetMessage> vRecvMsg;
 
    Mutex m_msg_process_queue_mutex;
    std::list<CNetMessage>
        m_msg_process_queue GUARDED_BY(m_msg_process_queue_mutex);
    size_t m_msg_process_queue_size GUARDED_BY(m_msg_process_queue_mutex){0};
 
    // Our address, as reported by the peer
    mutable Mutex m_addr_local_mutex;
    CService addrLocal GUARDED_BY(m_addr_local_mutex);
 
    std::atomic<uint64_t> invCounters{0};
 
    std::atomic<double> availabilityScore{0.};
 
    mapMsgTypeSize mapSendBytesPerMsgType GUARDED_BY(cs_vSend);
    mapMsgTypeSize mapRecvBytesPerMsgType GUARDED_BY(cs_vRecv);
 
    std::unique_ptr<i2p::sam::Session>
        m_i2p_sam_session GUARDED_BY(m_sock_mutex);
};
 
class NetEventsInterface {
public:
    static Mutex g_msgproc_mutex;
 
    virtual void InitializeNode(const Config &config, CNode &node,
                                ServiceFlags our_services) = 0;
 
    virtual void FinalizeNode(const Config &config, const CNode &node) = 0;
 
    virtual bool ProcessMessages(const Config &config, CNode *pnode,
                                 std::atomic<bool> &interrupt)
        EXCLUSIVE_LOCKS_REQUIRED(g_msgproc_mutex) = 0;
 
    virtual bool SendMessages(const Config &config, CNode *pnode)
        EXCLUSIVE_LOCKS_REQUIRED(g_msgproc_mutex) = 0;
 
protected:
    ~NetEventsInterface() = default;
};
 
namespace {
struct CConnmanTest;
}
 
class NetEventsInterface;
class CConnman {
public:
    struct Options {
        ServiceFlags nLocalServices = NODE_NONE;
        int nMaxConnections = 0;
        int m_max_outbound_full_relay = 0;
        int m_max_outbound_block_relay = 0;
        int m_max_avalanche_outbound = 0;
        int nMaxAddnode = 0;
        int nMaxFeeler = 0;
        CClientUIInterface *uiInterface = nullptr;
        std::vector<NetEventsInterface *> m_msgproc;
        BanMan *m_banman = nullptr;
        unsigned int nSendBufferMaxSize = 0;
        unsigned int nReceiveFloodSize = 0;
        uint64_t nMaxOutboundLimit = 0;
        int64_t m_peer_connect_timeout = DEFAULT_PEER_CONNECT_TIMEOUT;
        std::vector<std::string> vSeedNodes;
        std::vector<NetWhitelistPermissions> vWhitelistedRangeIncoming;
        std::vector<NetWhitelistPermissions> vWhitelistedRangeOutgoing;
        std::vector<NetWhitebindPermissions> vWhiteBinds;
        std::vector<CService> vBinds;
        std::vector<CService> onion_binds;
        bool bind_on_any;
        bool m_use_addrman_outgoing = true;
        std::vector<std::string> m_specified_outgoing;
        std::vector<std::string> m_added_nodes;
        bool m_i2p_accept_incoming = true;
        bool whitelist_forcerelay = DEFAULT_WHITELISTFORCERELAY;
        bool whitelist_relay = DEFAULT_WHITELISTRELAY;
    };
 
    void Init(const Options &connOptions)
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex) {
        nLocalServices = connOptions.nLocalServices;
        nMaxConnections = connOptions.nMaxConnections;
        m_use_addrman_outgoing = connOptions.m_use_addrman_outgoing;
        nMaxAddnode = connOptions.nMaxAddnode;
        nMaxFeeler = connOptions.nMaxFeeler;
        {
            // Lock cs_main to prevent a potential race with the peer validation
            // logic thread.
            LOCK(::cs_main);
            m_max_outbound_full_relay =
                std::min(connOptions.m_max_outbound_full_relay,
                         connOptions.nMaxConnections);
            m_max_avalanche_outbound = connOptions.m_max_avalanche_outbound;
            m_max_outbound_block_relay = connOptions.m_max_outbound_block_relay;
            m_max_outbound = m_max_outbound_full_relay +
                             m_max_outbound_block_relay + nMaxFeeler +
                             m_max_avalanche_outbound;
        }
        m_client_interface = connOptions.uiInterface;
        m_banman = connOptions.m_banman;
        m_msgproc = connOptions.m_msgproc;
        nSendBufferMaxSize = connOptions.nSendBufferMaxSize;
        nReceiveFloodSize = connOptions.nReceiveFloodSize;
        m_peer_connect_timeout =
            std::chrono::seconds{connOptions.m_peer_connect_timeout};
        {
            LOCK(cs_totalBytesSent);
            nMaxOutboundLimit = connOptions.nMaxOutboundLimit;
        }
        vWhitelistedRangeIncoming = connOptions.vWhitelistedRangeIncoming;
        vWhitelistedRangeOutgoing = connOptions.vWhitelistedRangeOutgoing;
        {
            LOCK(m_added_nodes_mutex);
            m_added_nodes = connOptions.m_added_nodes;
        }
        m_onion_binds = connOptions.onion_binds;
        whitelist_forcerelay = connOptions.whitelist_forcerelay;
        whitelist_relay = connOptions.whitelist_relay;
    }
 
    CConnman(const Config &configIn, uint64_t seed0, uint64_t seed1,
             AddrMan &addrmanIn, bool network_active = true);
    virtual ~CConnman();
 
    bool Start(CScheduler &scheduler, const Options &options)
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex, !m_addr_fetches_mutex,
                                 !mutexMsgProc);
 
    void StopThreads();
    void StopNodes();
    void Stop() {
        StopThreads();
        StopNodes();
    };
 
    void Interrupt() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
    bool GetNetworkActive() const { return fNetworkActive; };
    bool GetUseAddrmanOutgoing() const { return m_use_addrman_outgoing; };
    void SetNetworkActive(bool active);
    void OpenNetworkConnection(const CAddress &addrConnect, bool fCountFailure,
                               CSemaphoreGrant *grantOutbound,
                               const char *strDest, ConnectionType conn_type)
        EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
    bool CheckIncomingNonce(uint64_t nonce);
 
    bool ForNode(NodeId id, std::function<bool(CNode *pnode)> func);
 
    void PushMessage(CNode *pnode, CSerializedNetMsg &&msg);
 
    using NodeFn = std::function<void(CNode *)>;
    void ForEachNode(const NodeFn &func) {
        LOCK(m_nodes_mutex);
        for (auto &&node : m_nodes) {
            if (NodeFullyConnected(node)) {
                func(node);
            }
        }
    };
 
    void ForEachNode(const NodeFn &func) const {
        LOCK(m_nodes_mutex);
        for (auto &&node : m_nodes) {
            if (NodeFullyConnected(node)) {
                func(node);
            }
        }
    };
 
    // Addrman functions
    std::vector<CAddress> GetAddresses(size_t max_addresses, size_t max_pct,
                                       std::optional<Network> network) const;
    std::vector<CAddress> GetAddresses(CNode &requestor, size_t max_addresses,
                                       size_t max_pct);
 
    // This allows temporarily exceeding m_max_outbound_full_relay, with the
    // goal of finding a peer that is better than all our current peers.
    void SetTryNewOutboundPeer(bool flag);
    bool GetTryNewOutboundPeer() const;
 
    void StartExtraBlockRelayPeers() {
        LogPrint(BCLog::NET, "net: enabling extra block-relay-only peers\n");
        m_start_extra_block_relay_peers = true;
    }
 
    // Return the number of outbound peers we have in excess of our target (eg,
    // if we previously called SetTryNewOutboundPeer(true), and have since set
    // to false, we may have extra peers that we wish to disconnect). This may
    // return a value less than (num_outbound_connections - num_outbound_slots)
    // in cases where some outbound connections are not yet fully connected, or
    // not yet fully disconnected.
    int GetExtraFullOutboundCount() const;
    // Count the number of block-relay-only peers we have over our limit.
    int GetExtraBlockRelayCount() const;
 
    bool AddNode(const std::string &node)
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
    bool RemoveAddedNode(const std::string &node)
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
    std::vector<AddedNodeInfo> GetAddedNodeInfo() const
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
 
    bool AddConnection(const std::string &address, ConnectionType conn_type)
        EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
 
    size_t GetNodeCount(ConnectionDirection) const;
    void GetNodeStats(std::vector<CNodeStats> &vstats) const;
    bool GetNodeStats(NodeId id, CNodeStats &stats) const;
    bool DisconnectNode(const std::string &node);
    bool DisconnectNode(const CSubNet &subnet);
    bool DisconnectNode(const CNetAddr &addr);
    bool DisconnectNode(NodeId id);
 
    ServiceFlags GetLocalServices() const;
 
    void AddLocalServices(ServiceFlags services) {
        nLocalServices = ServiceFlags(nLocalServices | services);
    };
    void RemoveLocalServices(ServiceFlags services) {
        nLocalServices = ServiceFlags(nLocalServices & ~services);
    }
 
    uint64_t GetMaxOutboundTarget() const;
    std::chrono::seconds GetMaxOutboundTimeframe() const;
 
    bool OutboundTargetReached(bool historicalBlockServingLimit) const;
 
    uint64_t GetOutboundTargetBytesLeft() const;
 
    std::chrono::seconds GetMaxOutboundTimeLeftInCycle() const;
 
    uint64_t GetTotalBytesRecv() const;
    uint64_t GetTotalBytesSent() const;
 
    CSipHasher GetDeterministicRandomizer(uint64_t id) const;
 
    void WakeMessageHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
 
    bool ShouldRunInactivityChecks(const CNode &node,
                                   std::chrono::seconds now) const;
 
private:
    struct ListenSocket {
    public:
        std::shared_ptr<Sock> sock;
        inline void AddSocketPermissionFlags(NetPermissionFlags &flags) const {
            NetPermissions::AddFlag(flags, m_permissions);
        }
        ListenSocket(std::shared_ptr<Sock> sock_,
                     NetPermissionFlags permissions_)
            : sock(sock_), m_permissions(permissions_) {}
 
    private:
        NetPermissionFlags m_permissions;
    };
 
    bool BindListenPort(const CService &bindAddr, bilingual_str &strError,
                        NetPermissionFlags permissions);
    bool Bind(const CService &addr, unsigned int flags,
              NetPermissionFlags permissions);
    bool InitBinds(const Options &options);
 
    void ThreadOpenAddedConnections()
        EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex,
                                 !m_unused_i2p_sessions_mutex);
    void AddAddrFetch(const std::string &strDest)
        EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex);
    void ProcessAddrFetch()
        EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex,
                                 !m_unused_i2p_sessions_mutex);
    void
    ThreadOpenConnections(std::vector<std::string> connect,
                          std::function<void(const CAddress &, ConnectionType)>
                              mockOpenConnection)
        EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex, !m_added_nodes_mutex,
                                 !m_nodes_mutex, !m_unused_i2p_sessions_mutex);
    void ThreadMessageHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
    void ThreadI2PAcceptIncoming();
    void AcceptConnection(const ListenSocket &hListenSocket);
 
    void CreateNodeFromAcceptedSocket(std::unique_ptr<Sock> &&sock,
                                      NetPermissionFlags permission_flags,
                                      const CAddress &addr_bind,
                                      const CAddress &addr);
 
    void DisconnectNodes();
    void NotifyNumConnectionsChanged();
    bool InactivityCheck(const CNode &node) const;
 
    Sock::EventsPerSock GenerateWaitSockets(Span<CNode *const> nodes);
 
    void SocketHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
 
    void SocketHandlerConnected(const std::vector<CNode *> &nodes,
                                const Sock::EventsPerSock &events_per_sock)
        EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
 
    void SocketHandlerListening(const Sock::EventsPerSock &events_per_sock);
 
    void ThreadSocketHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
    void ThreadDNSAddressSeed()
        EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex, !m_nodes_mutex);
 
    uint64_t CalculateKeyedNetGroup(const CAddress &ad) const;
 
    CNode *FindNode(const CNetAddr &ip);
    CNode *FindNode(const CSubNet &subNet);
    CNode *FindNode(const std::string &addrName);
    CNode *FindNode(const CService &addr);
 
    bool AlreadyConnectedToAddress(const CAddress &addr);
 
    bool AttemptToEvictConnection();
    CNode *ConnectNode(CAddress addrConnect, const char *pszDest,
                       bool fCountFailure, ConnectionType conn_type)
        EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
    ;
    void AddWhitelistPermissionFlags(
        NetPermissionFlags &flags, const CNetAddr &addr,
        const std::vector<NetWhitelistPermissions> &ranges) const;
 
    void DeleteNode(CNode *pnode);
 
    NodeId GetNewNodeId();
 
    std::pair<size_t, bool> SocketSendData(CNode &node) const
        EXCLUSIVE_LOCKS_REQUIRED(node.cs_vSend);
 
    void DumpAddresses();
 
    // Network stats
    void RecordBytesRecv(uint64_t bytes);
    void RecordBytesSent(uint64_t bytes);
 
    std::vector<CAddress> GetCurrentBlockRelayOnlyConns() const;
 
    // Whether the node should be passed out in ForEach* callbacks
    static bool NodeFullyConnected(const CNode *pnode);
 
    const Config *config;
 
    // Network usage totals
    mutable RecursiveMutex cs_totalBytesSent;
    std::atomic<uint64_t> nTotalBytesRecv{0};
    uint64_t nTotalBytesSent GUARDED_BY(cs_totalBytesSent){0};
 
    // outbound limit & stats
    uint64_t nMaxOutboundTotalBytesSentInCycle GUARDED_BY(cs_totalBytesSent){0};
    std::chrono::seconds
        nMaxOutboundCycleStartTime GUARDED_BY(cs_totalBytesSent){0};
    uint64_t nMaxOutboundLimit GUARDED_BY(cs_totalBytesSent);
 
    // P2P timeout in seconds
    std::chrono::seconds m_peer_connect_timeout;
 
    // Whitelisted ranges. Any node connecting from these is automatically
    // whitelisted (as well as those connecting to whitelisted binds).
    std::vector<NetWhitelistPermissions> vWhitelistedRangeIncoming;
    // Whitelisted ranges for outgoing connections.
    std::vector<NetWhitelistPermissions> vWhitelistedRangeOutgoing;
 
    unsigned int nSendBufferMaxSize{0};
    unsigned int nReceiveFloodSize{0};
 
    std::vector<ListenSocket> vhListenSocket;
    std::atomic<bool> fNetworkActive{true};
    bool fAddressesInitialized{false};
    AddrMan &addrman;
    std::deque<std::string> m_addr_fetches GUARDED_BY(m_addr_fetches_mutex);
    Mutex m_addr_fetches_mutex;
    std::vector<std::string> m_added_nodes GUARDED_BY(m_added_nodes_mutex);
    mutable Mutex m_added_nodes_mutex;
    std::vector<CNode *> m_nodes GUARDED_BY(m_nodes_mutex);
    std::list<CNode *> m_nodes_disconnected;
    mutable RecursiveMutex m_nodes_mutex;
    std::atomic<NodeId> nLastNodeId{0};
    unsigned int nPrevNodeCount{0};
 
    struct CachedAddrResponse {
        std::vector<CAddress> m_addrs_response_cache;
        std::chrono::microseconds m_cache_entry_expiration{0};
    };
 
    std::map<uint64_t, CachedAddrResponse> m_addr_response_caches;
 
    std::atomic<ServiceFlags> nLocalServices;
 
    std::unique_ptr<CSemaphore> semOutbound;
    std::unique_ptr<CSemaphore> semAddnode;
    int nMaxConnections;
 
    // How many full-relay (tx, block, addr) outbound peers we want
    int m_max_outbound_full_relay;
 
    // How many block-relay only outbound peers we want
    // We do not relay tx or addr messages with these peers
    int m_max_outbound_block_relay;
 
    // How many avalanche enabled outbound peers we want
    int m_max_avalanche_outbound;
 
    int nMaxAddnode;
    int nMaxFeeler;
    int m_max_outbound;
    bool m_use_addrman_outgoing;
    CClientUIInterface *m_client_interface;
    // FIXME m_msgproc is a terrible name
    std::vector<NetEventsInterface *> m_msgproc;
    BanMan *m_banman;
 
    std::vector<CAddress> m_anchors;
 
    const uint64_t nSeed0, nSeed1;
 
    bool fMsgProcWake GUARDED_BY(mutexMsgProc);
 
    std::condition_variable condMsgProc;
    Mutex mutexMsgProc;
    std::atomic<bool> flagInterruptMsgProc{false};
 
    CThreadInterrupt interruptNet;
 
    std::unique_ptr<i2p::sam::Session> m_i2p_sam_session;
 
    std::thread threadDNSAddressSeed;
    std::thread threadSocketHandler;
    std::thread threadOpenAddedConnections;
    std::thread threadOpenConnections;
    std::thread threadMessageHandler;
    std::thread threadI2PAcceptIncoming;
 
    std::atomic_bool m_try_another_outbound_peer;
 
    std::atomic_bool m_start_extra_block_relay_peers{false};
 
    std::vector<CService> m_onion_binds;
 
    Mutex m_unused_i2p_sessions_mutex;
 
    std::queue<std::unique_ptr<i2p::sam::Session>>
        m_unused_i2p_sessions GUARDED_BY(m_unused_i2p_sessions_mutex);
 
    static constexpr size_t MAX_UNUSED_I2P_SESSIONS_SIZE{10};
 
    bool whitelist_forcerelay;
 
    bool whitelist_relay;
 
    class NodesSnapshot {
    public:
        explicit NodesSnapshot(const CConnman &connman, bool shuffle) {
            {
                LOCK(connman.m_nodes_mutex);
                m_nodes_copy = connman.m_nodes;
                for (auto &node : m_nodes_copy) {
                    node->AddRef();
                }
            }
            if (shuffle) {
                Shuffle(m_nodes_copy.begin(), m_nodes_copy.end(),
                        FastRandomContext{});
            }
        }
 
        ~NodesSnapshot() {
            for (auto &node : m_nodes_copy) {
                node->Release();
            }
        }
 
        const std::vector<CNode *> &Nodes() const { return m_nodes_copy; }
 
    private:
        std::vector<CNode *> m_nodes_copy;
    };
 
    friend struct ::CConnmanTest;
    friend struct ConnmanTestMsg;
};
 
std::string getSubVersionEB(uint64_t MaxBlockSize);
std::string userAgent(const Config &config);
 
void CaptureMessageToFile(const CAddress &addr, const std::string &msg_type,
                          Span<const uint8_t> data, bool is_incoming);
 
extern std::function<void(const CAddress &addr, const std::string &msg_type,
                          Span<const uint8_t> data, bool is_incoming)>
    CaptureMessage;
 
#endif // BITCOIN_NET_H