Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_NET_H
7 : : #define BITCOIN_NET_H
8 : :
9 : : #include <bip324.h>
10 : : #include <chainparams.h>
11 : : #include <common/bloom.h>
12 : : #include <compat/compat.h>
13 : : #include <consensus/amount.h>
14 : : #include <crypto/siphash.h>
15 : : #include <hash.h>
16 : : #include <i2p.h>
17 : : #include <kernel/messagestartchars.h>
18 : : #include <net_permissions.h>
19 : : #include <netaddress.h>
20 : : #include <netbase.h>
21 : : #include <netgroup.h>
22 : : #include <node/connection_types.h>
23 : : #include <node/protocol_version.h>
24 : : #include <policy/feerate.h>
25 : : #include <protocol.h>
26 : : #include <random.h>
27 : : #include <semaphore_grant.h>
28 : : #include <span.h>
29 : : #include <streams.h>
30 : : #include <sync.h>
31 : : #include <uint256.h>
32 : : #include <util/check.h>
33 : : #include <util/sock.h>
34 : : #include <util/threadinterrupt.h>
35 : :
36 : : #include <atomic>
37 : : #include <condition_variable>
38 : : #include <cstdint>
39 : : #include <deque>
40 : : #include <functional>
41 : : #include <list>
42 : : #include <map>
43 : : #include <memory>
44 : : #include <optional>
45 : : #include <queue>
46 : : #include <thread>
47 : : #include <unordered_set>
48 : : #include <vector>
49 : :
50 : : class AddrMan;
51 : : class BanMan;
52 : : class CChainParams;
53 : : class CNode;
54 : : class CScheduler;
55 : : struct bilingual_str;
56 : :
57 : : /** Time after which to disconnect, after waiting for a ping response (or inactivity). */
58 : : static constexpr std::chrono::minutes TIMEOUT_INTERVAL{20};
59 : : /** Run the feeler connection loop once every 2 minutes. **/
60 : : static constexpr auto FEELER_INTERVAL = 2min;
61 : : /** Run the extra block-relay-only connection loop once every 5 minutes. **/
62 : : static constexpr auto EXTRA_BLOCK_RELAY_ONLY_PEER_INTERVAL = 5min;
63 : : /** Maximum length of incoming protocol messages (no message over 4 MB is currently acceptable). */
64 : : static const unsigned int MAX_PROTOCOL_MESSAGE_LENGTH = 4 * 1000 * 1000;
65 : : /** Maximum length of the user agent string in `version` message */
66 : : static const unsigned int MAX_SUBVERSION_LENGTH = 256;
67 : : /** Maximum number of automatic outgoing nodes over which we'll relay everything (blocks, tx, addrs, etc) */
68 : : static const int MAX_OUTBOUND_FULL_RELAY_CONNECTIONS = 8;
69 : : /** Maximum number of addnode outgoing nodes */
70 : : static const int MAX_ADDNODE_CONNECTIONS = 8;
71 : : /** Maximum number of block-relay-only outgoing connections */
72 : : static const int MAX_BLOCK_RELAY_ONLY_CONNECTIONS = 2;
73 : : /** Maximum number of feeler connections */
74 : : static const int MAX_FEELER_CONNECTIONS = 1;
75 : : /** -listen default */
76 : : static const bool DEFAULT_LISTEN = true;
77 : : /** The maximum number of peer connections to maintain. */
78 : : static const unsigned int DEFAULT_MAX_PEER_CONNECTIONS = 125;
79 : : /** The default for -maxuploadtarget. 0 = Unlimited */
80 : : static const std::string DEFAULT_MAX_UPLOAD_TARGET{"0M"};
81 : : /** Default for blocks only*/
82 : : static const bool DEFAULT_BLOCKSONLY = false;
83 : : /** -peertimeout default */
84 : : static const int64_t DEFAULT_PEER_CONNECT_TIMEOUT = 60;
85 : : /** Number of file descriptors required for message capture **/
86 : : static const int NUM_FDS_MESSAGE_CAPTURE = 1;
87 : : /** Interval for ASMap Health Check **/
88 : : static constexpr std::chrono::hours ASMAP_HEALTH_CHECK_INTERVAL{24};
89 : :
90 : : static constexpr bool DEFAULT_FORCEDNSSEED{false};
91 : : static constexpr bool DEFAULT_DNSSEED{true};
92 : : static constexpr bool DEFAULT_FIXEDSEEDS{true};
93 : : static const size_t DEFAULT_MAXRECEIVEBUFFER = 5 * 1000;
94 : : static const size_t DEFAULT_MAXSENDBUFFER = 1 * 1000;
95 : :
96 : : static constexpr bool DEFAULT_V2_TRANSPORT{true};
97 : :
98 : : typedef int64_t NodeId;
99 : :
100 [ # # ]: 120 : struct AddedNodeParams {
101 : : std::string m_added_node;
102 : : bool m_use_v2transport;
103 : : };
104 : :
105 : 52 : struct AddedNodeInfo {
106 : : AddedNodeParams m_params;
107 : : CService resolvedAddress;
108 : : bool fConnected;
109 : : bool fInbound;
110 : : };
111 : :
112 : : class CNodeStats;
113 : : class CClientUIInterface;
114 : :
115 : 569419 : struct CSerializedNetMsg {
116 [ + + ]: 282398 : CSerializedNetMsg() = default;
117 : 117326 : CSerializedNetMsg(CSerializedNetMsg&&) = default;
118 : 252375 : CSerializedNetMsg& operator=(CSerializedNetMsg&&) = default;
119 : : // No implicit copying, only moves.
120 : : CSerializedNetMsg(const CSerializedNetMsg& msg) = delete;
121 : : CSerializedNetMsg& operator=(const CSerializedNetMsg&) = delete;
122 : :
123 : 262292 : CSerializedNetMsg Copy() const
124 : : {
125 [ + - ]: 262292 : CSerializedNetMsg copy;
126 [ + - ]: 262292 : copy.data = data;
127 [ + - ]: 262292 : copy.m_type = m_type;
128 : 262292 : return copy;
129 : 0 : }
130 : :
131 : : std::vector<unsigned char> data;
132 : : std::string m_type;
133 : :
134 : : /** Compute total memory usage of this object (own memory + any dynamic memory). */
135 : : size_t GetMemoryUsage() const noexcept;
136 : : };
137 : :
138 : : /**
139 : : * Look up IP addresses from all interfaces on the machine and add them to the
140 : : * list of local addresses to self-advertise.
141 : : * The loopback interface is skipped.
142 : : */
143 : : void Discover();
144 : :
145 : : uint16_t GetListenPort();
146 : :
147 : : enum
148 : : {
149 : : LOCAL_NONE, // unknown
150 : : LOCAL_IF, // address a local interface listens on
151 : : LOCAL_BIND, // address explicit bound to
152 : : LOCAL_MAPPED, // address reported by PCP
153 : : LOCAL_MANUAL, // address explicitly specified (-externalip=)
154 : :
155 : : LOCAL_MAX
156 : : };
157 : :
158 : : /** Returns a local address that we should advertise to this peer. */
159 : : std::optional<CService> GetLocalAddrForPeer(CNode& node);
160 : :
161 : : void ClearLocal();
162 : : bool AddLocal(const CService& addr, int nScore = LOCAL_NONE);
163 : : bool AddLocal(const CNetAddr& addr, int nScore = LOCAL_NONE);
164 : : void RemoveLocal(const CService& addr);
165 : : bool SeenLocal(const CService& addr);
166 : : bool IsLocal(const CService& addr);
167 : : CService GetLocalAddress(const CNode& peer);
168 : :
169 : : extern bool fDiscover;
170 : : extern bool fListen;
171 : :
172 : : /** Subversion as sent to the P2P network in `version` messages */
173 : : extern std::string strSubVersion;
174 : :
175 : : struct LocalServiceInfo {
176 : : int nScore;
177 : : uint16_t nPort;
178 : : };
179 : :
180 : : extern GlobalMutex g_maplocalhost_mutex;
181 : : extern std::map<CNetAddr, LocalServiceInfo> mapLocalHost GUARDED_BY(g_maplocalhost_mutex);
182 : :
183 : : extern const std::string NET_MESSAGE_TYPE_OTHER;
184 : : using mapMsgTypeSize = std::map</* message type */ std::string, /* total bytes */ uint64_t>;
185 : :
186 : : class CNodeStats
187 : : {
188 : : public:
189 : : NodeId nodeid;
190 : : std::chrono::seconds m_last_send;
191 : : std::chrono::seconds m_last_recv;
192 : : std::chrono::seconds m_last_tx_time;
193 : : std::chrono::seconds m_last_block_time;
194 : : std::chrono::seconds m_connected;
195 : : std::string m_addr_name;
196 : : int nVersion;
197 : : std::string cleanSubVer;
198 : : bool fInbound;
199 : : // We requested high bandwidth connection to peer
200 : : bool m_bip152_highbandwidth_to;
201 : : // Peer requested high bandwidth connection
202 : : bool m_bip152_highbandwidth_from;
203 : : int m_starting_height;
204 : : uint64_t nSendBytes;
205 : : mapMsgTypeSize mapSendBytesPerMsgType;
206 : : uint64_t nRecvBytes;
207 : : mapMsgTypeSize mapRecvBytesPerMsgType;
208 : : NetPermissionFlags m_permission_flags;
209 : : std::chrono::microseconds m_last_ping_time;
210 : : std::chrono::microseconds m_min_ping_time;
211 : : // Our address, as reported by the peer
212 : : std::string addrLocal;
213 : : // Address of this peer
214 : : CAddress addr;
215 : : // Bind address of our side of the connection
216 : : CService addrBind;
217 : : // Network the peer connected through
218 : : Network m_network;
219 : : uint32_t m_mapped_as;
220 : : ConnectionType m_conn_type;
221 : : /** Transport protocol type. */
222 : : TransportProtocolType m_transport_type;
223 : : /** BIP324 session id string in hex, if any. */
224 : : std::string m_session_id;
225 : : };
226 : :
227 : :
228 : : /** Transport protocol agnostic message container.
229 : : * Ideally it should only contain receive time, payload,
230 : : * type and size.
231 : : */
232 : 476431 : class CNetMessage
233 : : {
234 : : public:
235 : : DataStream m_recv; //!< received message data
236 : : std::chrono::microseconds m_time{0}; //!< time of message receipt
237 : : uint32_t m_message_size{0}; //!< size of the payload
238 : : uint32_t m_raw_message_size{0}; //!< used wire size of the message (including header/checksum)
239 : : std::string m_type;
240 : :
241 [ + - ]: 232254 : explicit CNetMessage(DataStream&& recv_in) : m_recv(std::move(recv_in)) {}
242 : : // Only one CNetMessage object will exist for the same message on either
243 : : // the receive or processing queue. For performance reasons we therefore
244 : : // delete the copy constructor and assignment operator to avoid the
245 : : // possibility of copying CNetMessage objects.
246 : 244177 : CNetMessage(CNetMessage&&) = default;
247 : : CNetMessage(const CNetMessage&) = delete;
248 : : CNetMessage& operator=(CNetMessage&&) = default;
249 : : CNetMessage& operator=(const CNetMessage&) = delete;
250 : :
251 : : /** Compute total memory usage of this object (own memory + any dynamic memory). */
252 : : size_t GetMemoryUsage() const noexcept;
253 : : };
254 : :
255 : : /** The Transport converts one connection's sent messages to wire bytes, and received bytes back. */
256 : 33844 : class Transport {
257 : : public:
258 : : virtual ~Transport() = default;
259 : :
260 [ + + ]: 2511 : struct Info
261 : : {
262 : : TransportProtocolType transport_type;
263 : : std::optional<uint256> session_id;
264 : : };
265 : :
266 : : /** Retrieve information about this transport. */
267 : : virtual Info GetInfo() const noexcept = 0;
268 : :
269 : : // 1. Receiver side functions, for decoding bytes received on the wire into transport protocol
270 : : // agnostic CNetMessage (message type & payload) objects.
271 : :
272 : : /** Returns true if the current message is complete (so GetReceivedMessage can be called). */
273 : : virtual bool ReceivedMessageComplete() const = 0;
274 : :
275 : : /** Feed wire bytes to the transport.
276 : : *
277 : : * @return false if some bytes were invalid, in which case the transport can't be used anymore.
278 : : *
279 : : * Consumed bytes are chopped off the front of msg_bytes.
280 : : */
281 : : virtual bool ReceivedBytes(std::span<const uint8_t>& msg_bytes) = 0;
282 : :
283 : : /** Retrieve a completed message from transport.
284 : : *
285 : : * This can only be called when ReceivedMessageComplete() is true.
286 : : *
287 : : * If reject_message=true is returned the message itself is invalid, but (other than false
288 : : * returned by ReceivedBytes) the transport is not in an inconsistent state.
289 : : */
290 : : virtual CNetMessage GetReceivedMessage(std::chrono::microseconds time, bool& reject_message) = 0;
291 : :
292 : : // 2. Sending side functions, for converting messages into bytes to be sent over the wire.
293 : :
294 : : /** Set the next message to send.
295 : : *
296 : : * If no message can currently be set (perhaps because the previous one is not yet done being
297 : : * sent), returns false, and msg will be unmodified. Otherwise msg is enqueued (and
298 : : * possibly moved-from) and true is returned.
299 : : */
300 : : virtual bool SetMessageToSend(CSerializedNetMsg& msg) noexcept = 0;
301 : :
302 : : /** Return type for GetBytesToSend, consisting of:
303 : : * - std::span<const uint8_t> to_send: span of bytes to be sent over the wire (possibly empty).
304 : : * - bool more: whether there will be more bytes to be sent after the ones in to_send are
305 : : * all sent (as signaled by MarkBytesSent()).
306 : : * - const std::string& m_type: message type on behalf of which this is being sent
307 : : * ("" for bytes that are not on behalf of any message).
308 : : */
309 : : using BytesToSend = std::tuple<
310 : : std::span<const uint8_t> /*to_send*/,
311 : : bool /*more*/,
312 : : const std::string& /*m_type*/
313 : : >;
314 : :
315 : : /** Get bytes to send on the wire, if any, along with other information about it.
316 : : *
317 : : * As a const function, it does not modify the transport's observable state, and is thus safe
318 : : * to be called multiple times.
319 : : *
320 : : * @param[in] have_next_message If true, the "more" return value reports whether more will
321 : : * be sendable after a SetMessageToSend call. It is set by the caller when they know
322 : : * they have another message ready to send, and only care about what happens
323 : : * after that. The have_next_message argument only affects this "more" return value
324 : : * and nothing else.
325 : : *
326 : : * Effectively, there are three possible outcomes about whether there are more bytes
327 : : * to send:
328 : : * - Yes: the transport itself has more bytes to send later. For example, for
329 : : * V1Transport this happens during the sending of the header of a
330 : : * message, when there is a non-empty payload that follows.
331 : : * - No: the transport itself has no more bytes to send, but will have bytes to
332 : : * send if handed a message through SetMessageToSend. In V1Transport this
333 : : * happens when sending the payload of a message.
334 : : * - Blocked: the transport itself has no more bytes to send, and is also incapable
335 : : * of sending anything more at all now, if it were handed another
336 : : * message to send. This occurs in V2Transport before the handshake is
337 : : * complete, as the encryption ciphers are not set up for sending
338 : : * messages before that point.
339 : : *
340 : : * The boolean 'more' is true for Yes, false for Blocked, and have_next_message
341 : : * controls what is returned for No.
342 : : *
343 : : * @return a BytesToSend object. The to_send member returned acts as a stream which is only
344 : : * ever appended to. This means that with the exception of MarkBytesSent (which pops
345 : : * bytes off the front of later to_sends), operations on the transport can only append
346 : : * to what is being returned. Also note that m_type and to_send refer to data that is
347 : : * internal to the transport, and calling any non-const function on this object may
348 : : * invalidate them.
349 : : */
350 : : virtual BytesToSend GetBytesToSend(bool have_next_message) const noexcept = 0;
351 : :
352 : : /** Report how many bytes returned by the last GetBytesToSend() have been sent.
353 : : *
354 : : * bytes_sent cannot exceed to_send.size() of the last GetBytesToSend() result.
355 : : *
356 : : * If bytes_sent=0, this call has no effect.
357 : : */
358 : : virtual void MarkBytesSent(size_t bytes_sent) noexcept = 0;
359 : :
360 : : /** Return the memory usage of this transport attributable to buffered data to send. */
361 : : virtual size_t GetSendMemoryUsage() const noexcept = 0;
362 : :
363 : : // 3. Miscellaneous functions.
364 : :
365 : : /** Whether upon disconnections, a reconnect with V1 is warranted. */
366 : : virtual bool ShouldReconnectV1() const noexcept = 0;
367 : : };
368 : :
369 : : class V1Transport final : public Transport
370 : : {
371 : : private:
372 : : const MessageStartChars m_magic_bytes;
373 : : const NodeId m_node_id; // Only for logging
374 : : mutable Mutex m_recv_mutex; //!< Lock for receive state
375 : : mutable CHash256 hasher GUARDED_BY(m_recv_mutex);
376 : : mutable uint256 data_hash GUARDED_BY(m_recv_mutex);
377 : : bool in_data GUARDED_BY(m_recv_mutex); // parsing header (false) or data (true)
378 : : DataStream hdrbuf GUARDED_BY(m_recv_mutex){}; // partially received header
379 : : CMessageHeader hdr GUARDED_BY(m_recv_mutex); // complete header
380 : : DataStream vRecv GUARDED_BY(m_recv_mutex){}; // received message data
381 : : unsigned int nHdrPos GUARDED_BY(m_recv_mutex);
382 : : unsigned int nDataPos GUARDED_BY(m_recv_mutex);
383 : :
384 : : const uint256& GetMessageHash() const EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
385 : : int readHeader(std::span<const uint8_t> msg_bytes) EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
386 : : int readData(std::span<const uint8_t> msg_bytes) EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
387 : :
388 : 263032 : void Reset() EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex) {
389 : 263032 : AssertLockHeld(m_recv_mutex);
390 [ - + ]: 263032 : vRecv.clear();
391 [ - + ]: 263032 : hdrbuf.clear();
392 : 263032 : hdrbuf.resize(24);
393 : 263032 : in_data = false;
394 : 263032 : nHdrPos = 0;
395 : 263032 : nDataPos = 0;
396 : 263032 : data_hash.SetNull();
397 : 263032 : hasher.Reset();
398 : 263032 : }
399 : :
400 : 548092 : bool CompleteInternal() const noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex)
401 : : {
402 : 548092 : AssertLockHeld(m_recv_mutex);
403 [ + - ]: 548092 : if (!in_data) return false;
404 [ - + ]: 526193 : return hdr.nMessageSize == nDataPos;
405 : : }
406 : :
407 : : /** Lock for sending state. */
408 : : mutable Mutex m_send_mutex;
409 : : /** The header of the message currently being sent. */
410 : : std::vector<uint8_t> m_header_to_send GUARDED_BY(m_send_mutex);
411 : : /** The data of the message currently being sent. */
412 : : CSerializedNetMsg m_message_to_send GUARDED_BY(m_send_mutex);
413 : : /** Whether we're currently sending header bytes or message bytes. */
414 : : bool m_sending_header GUARDED_BY(m_send_mutex) {false};
415 : : /** How many bytes have been sent so far (from m_header_to_send, or from m_message_to_send.data). */
416 : : size_t m_bytes_sent GUARDED_BY(m_send_mutex) {0};
417 : :
418 : : public:
419 : : explicit V1Transport(const NodeId node_id) noexcept;
420 : :
421 : 347211 : bool ReceivedMessageComplete() const override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex)
422 : : {
423 : 347211 : AssertLockNotHeld(m_recv_mutex);
424 [ - - - - ]: 1019734 : return WITH_LOCK(m_recv_mutex, return CompleteInternal());
[ + - + +
+ - ]
425 : : }
426 : :
427 : : Info GetInfo() const noexcept override;
428 : :
429 : 378755 : bool ReceivedBytes(std::span<const uint8_t>& msg_bytes) override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex)
430 : : {
431 : 378755 : AssertLockNotHeld(m_recv_mutex);
432 : 378755 : LOCK(m_recv_mutex);
433 [ + + + - : 378755 : int ret = in_data ? readData(msg_bytes) : readHeader(msg_bytes);
+ - ]
434 [ + + ]: 378755 : if (ret < 0) {
435 [ + - ]: 31544 : Reset();
436 : : } else {
437 : 347211 : msg_bytes = msg_bytes.subspan(ret);
438 : : }
439 [ + - ]: 378755 : return ret >= 0;
440 : 378755 : }
441 : :
442 : : CNetMessage GetReceivedMessage(std::chrono::microseconds time, bool& reject_message) override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex);
443 : :
444 : : bool SetMessageToSend(CSerializedNetMsg& msg) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
445 : : BytesToSend GetBytesToSend(bool have_next_message) const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
446 : : void MarkBytesSent(size_t bytes_sent) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
447 : : size_t GetSendMemoryUsage() const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
448 : 0 : bool ShouldReconnectV1() const noexcept override { return false; }
449 : : };
450 : :
451 : : class V2Transport final : public Transport
452 : : {
453 : : private:
454 : : /** Contents of the version packet to send. BIP324 stipulates that senders should leave this
455 : : * empty, and receivers should ignore it. Future extensions can change what is sent as long as
456 : : * an empty version packet contents is interpreted as no extensions supported. */
457 : : static constexpr std::array<std::byte, 0> VERSION_CONTENTS = {};
458 : :
459 : : /** The length of the V1 prefix to match bytes initially received by responders with to
460 : : * determine if their peer is speaking V1 or V2. */
461 : : static constexpr size_t V1_PREFIX_LEN = 16;
462 : :
463 : : // The sender side and receiver side of V2Transport are state machines that are transitioned
464 : : // through, based on what has been received. The receive state corresponds to the contents of,
465 : : // and bytes received to, the receive buffer. The send state controls what can be appended to
466 : : // the send buffer and what can be sent from it.
467 : :
468 : : /** State type that defines the current contents of the receive buffer and/or how the next
469 : : * received bytes added to it will be interpreted.
470 : : *
471 : : * Diagram:
472 : : *
473 : : * start(responder)
474 : : * |
475 : : * | start(initiator) /---------\
476 : : * | | | |
477 : : * v v v |
478 : : * KEY_MAYBE_V1 -> KEY -> GARB_GARBTERM -> VERSION -> APP -> APP_READY
479 : : * |
480 : : * \-------> V1
481 : : */
482 : : enum class RecvState : uint8_t {
483 : : /** (Responder only) either v2 public key or v1 header.
484 : : *
485 : : * This is the initial state for responders, before data has been received to distinguish
486 : : * v1 from v2 connections. When that happens, the state becomes either KEY (for v2) or V1
487 : : * (for v1). */
488 : : KEY_MAYBE_V1,
489 : :
490 : : /** Public key.
491 : : *
492 : : * This is the initial state for initiators, during which the other side's public key is
493 : : * received. When that information arrives, the ciphers get initialized and the state
494 : : * becomes GARB_GARBTERM. */
495 : : KEY,
496 : :
497 : : /** Garbage and garbage terminator.
498 : : *
499 : : * Whenever a byte is received, the last 16 bytes are compared with the expected garbage
500 : : * terminator. When that happens, the state becomes VERSION. If no matching terminator is
501 : : * received in 4111 bytes (4095 for the maximum garbage length, and 16 bytes for the
502 : : * terminator), the connection aborts. */
503 : : GARB_GARBTERM,
504 : :
505 : : /** Version packet.
506 : : *
507 : : * A packet is received, and decrypted/verified. If that fails, the connection aborts. The
508 : : * first received packet in this state (whether it's a decoy or not) is expected to
509 : : * authenticate the garbage received during the GARB_GARBTERM state as associated
510 : : * authenticated data (AAD). The first non-decoy packet in this state is interpreted as
511 : : * version negotiation (currently, that means ignoring the contents, but it can be used for
512 : : * negotiating future extensions), and afterwards the state becomes APP. */
513 : : VERSION,
514 : :
515 : : /** Application packet.
516 : : *
517 : : * A packet is received, and decrypted/verified. If that succeeds, the state becomes
518 : : * APP_READY and the decrypted contents is kept in m_recv_decode_buffer until it is
519 : : * retrieved as a message by GetMessage(). */
520 : : APP,
521 : :
522 : : /** Nothing (an application packet is available for GetMessage()).
523 : : *
524 : : * Nothing can be received in this state. When the message is retrieved by GetMessage,
525 : : * the state becomes APP again. */
526 : : APP_READY,
527 : :
528 : : /** Nothing (this transport is using v1 fallback).
529 : : *
530 : : * All receive operations are redirected to m_v1_fallback. */
531 : : V1,
532 : : };
533 : :
534 : : /** State type that controls the sender side.
535 : : *
536 : : * Diagram:
537 : : *
538 : : * start(responder)
539 : : * |
540 : : * | start(initiator)
541 : : * | |
542 : : * v v
543 : : * MAYBE_V1 -> AWAITING_KEY -> READY
544 : : * |
545 : : * \-----> V1
546 : : */
547 : : enum class SendState : uint8_t {
548 : : /** (Responder only) Not sending until v1 or v2 is detected.
549 : : *
550 : : * This is the initial state for responders. The send buffer is empty.
551 : : * When the receiver determines whether this
552 : : * is a V1 or V2 connection, the sender state becomes AWAITING_KEY (for v2) or V1 (for v1).
553 : : */
554 : : MAYBE_V1,
555 : :
556 : : /** Waiting for the other side's public key.
557 : : *
558 : : * This is the initial state for initiators. The public key and garbage is sent out. When
559 : : * the receiver receives the other side's public key and transitions to GARB_GARBTERM, the
560 : : * sender state becomes READY. */
561 : : AWAITING_KEY,
562 : :
563 : : /** Normal sending state.
564 : : *
565 : : * In this state, the ciphers are initialized, so packets can be sent. When this state is
566 : : * entered, the garbage terminator and version packet are appended to the send buffer (in
567 : : * addition to the key and garbage which may still be there). In this state a message can be
568 : : * provided if the send buffer is empty. */
569 : : READY,
570 : :
571 : : /** This transport is using v1 fallback.
572 : : *
573 : : * All send operations are redirected to m_v1_fallback. */
574 : : V1,
575 : : };
576 : :
577 : : /** Cipher state. */
578 : : BIP324Cipher m_cipher;
579 : : /** Whether we are the initiator side. */
580 : : const bool m_initiating;
581 : : /** NodeId (for debug logging). */
582 : : const NodeId m_nodeid;
583 : : /** Encapsulate a V1Transport to fall back to. */
584 : : V1Transport m_v1_fallback;
585 : :
586 : : /** Lock for receiver-side fields. */
587 : : mutable Mutex m_recv_mutex ACQUIRED_BEFORE(m_send_mutex);
588 : : /** In {VERSION, APP}, the decrypted packet length, if m_recv_buffer.size() >=
589 : : * BIP324Cipher::LENGTH_LEN. Unspecified otherwise. */
590 : : uint32_t m_recv_len GUARDED_BY(m_recv_mutex) {0};
591 : : /** Receive buffer; meaning is determined by m_recv_state. */
592 : : std::vector<uint8_t> m_recv_buffer GUARDED_BY(m_recv_mutex);
593 : : /** AAD expected in next received packet (currently used only for garbage). */
594 : : std::vector<uint8_t> m_recv_aad GUARDED_BY(m_recv_mutex);
595 : : /** Buffer to put decrypted contents in, for converting to CNetMessage. */
596 : : std::vector<uint8_t> m_recv_decode_buffer GUARDED_BY(m_recv_mutex);
597 : : /** Current receiver state. */
598 : : RecvState m_recv_state GUARDED_BY(m_recv_mutex);
599 : :
600 : : /** Lock for sending-side fields. If both sending and receiving fields are accessed,
601 : : * m_recv_mutex must be acquired before m_send_mutex. */
602 : : mutable Mutex m_send_mutex ACQUIRED_AFTER(m_recv_mutex);
603 : : /** The send buffer; meaning is determined by m_send_state. */
604 : : std::vector<uint8_t> m_send_buffer GUARDED_BY(m_send_mutex);
605 : : /** How many bytes from the send buffer have been sent so far. */
606 : : uint32_t m_send_pos GUARDED_BY(m_send_mutex) {0};
607 : : /** The garbage sent, or to be sent (MAYBE_V1 and AWAITING_KEY state only). */
608 : : std::vector<uint8_t> m_send_garbage GUARDED_BY(m_send_mutex);
609 : : /** Type of the message being sent. */
610 : : std::string m_send_type GUARDED_BY(m_send_mutex);
611 : : /** Current sender state. */
612 : : SendState m_send_state GUARDED_BY(m_send_mutex);
613 : : /** Whether we've sent at least 24 bytes (which would trigger disconnect for V1 peers). */
614 : : bool m_sent_v1_header_worth GUARDED_BY(m_send_mutex) {false};
615 : :
616 : : /** Change the receive state. */
617 : : void SetReceiveState(RecvState recv_state) noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
618 : : /** Change the send state. */
619 : : void SetSendState(SendState send_state) noexcept EXCLUSIVE_LOCKS_REQUIRED(m_send_mutex);
620 : : /** Given a packet's contents, find the message type (if valid), and strip it from contents. */
621 : : static std::optional<std::string> GetMessageType(std::span<const uint8_t>& contents) noexcept;
622 : : /** Determine how many received bytes can be processed in one go (not allowed in V1 state). */
623 : : size_t GetMaxBytesToProcess() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
624 : : /** Put our public key + garbage in the send buffer. */
625 : : void StartSendingHandshake() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_send_mutex);
626 : : /** Process bytes in m_recv_buffer, while in KEY_MAYBE_V1 state. */
627 : : void ProcessReceivedMaybeV1Bytes() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex, !m_send_mutex);
628 : : /** Process bytes in m_recv_buffer, while in KEY state. */
629 : : bool ProcessReceivedKeyBytes() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex, !m_send_mutex);
630 : : /** Process bytes in m_recv_buffer, while in GARB_GARBTERM state. */
631 : : bool ProcessReceivedGarbageBytes() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
632 : : /** Process bytes in m_recv_buffer, while in VERSION/APP state. */
633 : : bool ProcessReceivedPacketBytes() noexcept EXCLUSIVE_LOCKS_REQUIRED(m_recv_mutex);
634 : :
635 : : public:
636 : : static constexpr uint32_t MAX_GARBAGE_LEN = 4095;
637 : :
638 : : /** Construct a V2 transport with securely generated random keys.
639 : : *
640 : : * @param[in] nodeid the node's NodeId (only for debug log output).
641 : : * @param[in] initiating whether we are the initiator side.
642 : : */
643 : : V2Transport(NodeId nodeid, bool initiating) noexcept;
644 : :
645 : : /** Construct a V2 transport with specified keys and garbage (test use only). */
646 : : V2Transport(NodeId nodeid, bool initiating, const CKey& key, std::span<const std::byte> ent32, std::vector<uint8_t> garbage) noexcept;
647 : :
648 : : // Receive side functions.
649 : : bool ReceivedMessageComplete() const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex);
650 : : bool ReceivedBytes(std::span<const uint8_t>& msg_bytes) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex, !m_send_mutex);
651 : : CNetMessage GetReceivedMessage(std::chrono::microseconds time, bool& reject_message) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex);
652 : :
653 : : // Send side functions.
654 : : bool SetMessageToSend(CSerializedNetMsg& msg) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
655 : : BytesToSend GetBytesToSend(bool have_next_message) const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
656 : : void MarkBytesSent(size_t bytes_sent) noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
657 : : size_t GetSendMemoryUsage() const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_send_mutex);
658 : :
659 : : // Miscellaneous functions.
660 : : bool ShouldReconnectV1() const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex, !m_send_mutex);
661 : : Info GetInfo() const noexcept override EXCLUSIVE_LOCKS_REQUIRED(!m_recv_mutex);
662 : : };
663 : :
664 [ + - ]: 25496 : struct CNodeOptions
665 : : {
666 : : NetPermissionFlags permission_flags = NetPermissionFlags::None;
667 : : std::unique_ptr<i2p::sam::Session> i2p_sam_session = nullptr;
668 : : bool prefer_evict = false;
669 : : size_t recv_flood_size{DEFAULT_MAXRECEIVEBUFFER * 1000};
670 : : bool use_v2transport = false;
671 : : };
672 : :
673 : : /** Information about a peer */
674 : : class CNode
675 : : {
676 : : public:
677 : : /** Transport serializer/deserializer. The receive side functions are only called under cs_vRecv, while
678 : : * the sending side functions are only called under cs_vSend. */
679 : : const std::unique_ptr<Transport> m_transport;
680 : :
681 : : const NetPermissionFlags m_permission_flags;
682 : :
683 : : /**
684 : : * Socket used for communication with the node.
685 : : * May not own a Sock object (after `CloseSocketDisconnect()` or during tests).
686 : : * `shared_ptr` (instead of `unique_ptr`) is used to avoid premature close of
687 : : * the underlying file descriptor by one thread while another thread is
688 : : * poll(2)-ing it for activity.
689 : : * @see https://github.com/bitcoin/bitcoin/issues/21744 for details.
690 : : */
691 : : std::shared_ptr<Sock> m_sock GUARDED_BY(m_sock_mutex);
692 : :
693 : : /** Sum of GetMemoryUsage of all vSendMsg entries. */
694 : : size_t m_send_memusage GUARDED_BY(cs_vSend){0};
695 : : /** Total number of bytes sent on the wire to this peer. */
696 : : uint64_t nSendBytes GUARDED_BY(cs_vSend){0};
697 : : /** Messages still to be fed to m_transport->SetMessageToSend. */
698 : : std::deque<CSerializedNetMsg> vSendMsg GUARDED_BY(cs_vSend);
699 : : Mutex cs_vSend;
700 : : Mutex m_sock_mutex;
701 : : Mutex cs_vRecv;
702 : :
703 : : uint64_t nRecvBytes GUARDED_BY(cs_vRecv){0};
704 : :
705 : : std::atomic<std::chrono::seconds> m_last_send{0s};
706 : : std::atomic<std::chrono::seconds> m_last_recv{0s};
707 : : //! Unix epoch time at peer connection
708 : : const std::chrono::seconds m_connected;
709 : : // Address of this peer
710 : : const CAddress addr;
711 : : // Bind address of our side of the connection
712 : : const CService addrBind;
713 : : const std::string m_addr_name;
714 : : /** The pszDest argument provided to ConnectNode(). Only used for reconnections. */
715 : : const std::string m_dest;
716 : : //! Whether this peer is an inbound onion, i.e. connected via our Tor onion service.
717 : : const bool m_inbound_onion;
718 : : std::atomic<int> nVersion{0};
719 : : Mutex m_subver_mutex;
720 : : /**
721 : : * cleanSubVer is a sanitized string of the user agent byte array we read
722 : : * from the wire. This cleaned string can safely be logged or displayed.
723 : : */
724 : : std::string cleanSubVer GUARDED_BY(m_subver_mutex){};
725 : : const bool m_prefer_evict{false}; // This peer is preferred for eviction.
726 : 76778 : bool HasPermission(NetPermissionFlags permission) const {
727 [ + + - - : 77779 : return NetPermissions::HasFlag(m_permission_flags, permission);
+ - + + -
- + + + -
- - + + +
+ + + + +
- - - - +
+ - - +
+ ][ + - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
728 : : }
729 : : /** fSuccessfullyConnected is set to true on receiving VERACK from the peer. */
730 : : std::atomic_bool fSuccessfullyConnected{false};
731 : : // Setting fDisconnect to true will cause the node to be disconnected the
732 : : // next time DisconnectNodes() runs
733 : : std::atomic_bool fDisconnect{false};
734 : : CountingSemaphoreGrant<> grantOutbound;
735 : : std::atomic<int> nRefCount{0};
736 : :
737 : : const uint64_t nKeyedNetGroup;
738 : : std::atomic_bool fPauseRecv{false};
739 : : std::atomic_bool fPauseSend{false};
740 : :
741 : : /** Network key used to prevent fingerprinting our node across networks.
742 : : * Influenced by the network and the bind address (+ bind port for inbounds) */
743 : : const uint64_t m_network_key;
744 : :
745 : : const ConnectionType m_conn_type;
746 : :
747 : : /** Move all messages from the received queue to the processing queue. */
748 : : void MarkReceivedMsgsForProcessing()
749 : : EXCLUSIVE_LOCKS_REQUIRED(!m_msg_process_queue_mutex);
750 : :
751 : : /** Poll the next message from the processing queue of this connection.
752 : : *
753 : : * Returns std::nullopt if the processing queue is empty, or a pair
754 : : * consisting of the message and a bool that indicates if the processing
755 : : * queue has more entries. */
756 : : std::optional<std::pair<CNetMessage, bool>> PollMessage()
757 : : EXCLUSIVE_LOCKS_REQUIRED(!m_msg_process_queue_mutex);
758 : :
759 : : /** Account for the total size of a sent message in the per msg type connection stats. */
760 : 45253 : void AccountForSentBytes(const std::string& msg_type, size_t sent_bytes)
761 : : EXCLUSIVE_LOCKS_REQUIRED(cs_vSend)
762 : : {
763 : 45253 : mapSendBytesPerMsgType[msg_type] += sent_bytes;
764 : 45253 : }
765 : :
766 : 22918 : bool IsOutboundOrBlockRelayConn() const {
767 [ + - + ]: 22918 : switch (m_conn_type) {
768 : : case ConnectionType::OUTBOUND_FULL_RELAY:
769 : : case ConnectionType::BLOCK_RELAY:
770 : : return true;
771 : 10333 : case ConnectionType::INBOUND:
772 : 10333 : case ConnectionType::MANUAL:
773 : 10333 : case ConnectionType::ADDR_FETCH:
774 : 10333 : case ConnectionType::FEELER:
775 : 10333 : return false;
776 : : } // no default case, so the compiler can warn about missing cases
777 : :
778 : 0 : assert(false);
779 : : }
780 : :
781 : 184 : bool IsFullOutboundConn() const {
782 [ - - - + : 184 : return m_conn_type == ConnectionType::OUTBOUND_FULL_RELAY;
# # ][ # #
# # # # ]
783 : : }
784 : :
785 : 0 : bool IsManualConn() const {
786 [ # # ]: 0 : return m_conn_type == ConnectionType::MANUAL;
787 : : }
788 : :
789 : 21972 : bool IsManualOrFullOutboundConn() const
790 : : {
791 [ + - + ]: 21972 : switch (m_conn_type) {
792 : : case ConnectionType::INBOUND:
793 : : case ConnectionType::FEELER:
794 : : case ConnectionType::BLOCK_RELAY:
795 : : case ConnectionType::ADDR_FETCH:
796 : : return false;
797 : 11075 : case ConnectionType::OUTBOUND_FULL_RELAY:
798 : 11075 : case ConnectionType::MANUAL:
799 : 11075 : return true;
800 : : } // no default case, so the compiler can warn about missing cases
801 : :
802 : 0 : assert(false);
803 : : }
804 : :
805 : 35770 : bool IsBlockOnlyConn() const {
806 [ + + + + : 35770 : return m_conn_type == ConnectionType::BLOCK_RELAY;
+ + - - +
+ + + ][ #
# # # # #
# # # # #
# ][ + + ]
807 : : }
808 : :
809 : 6854 : bool IsFeelerConn() const {
810 [ + + ]: 6854 : return m_conn_type == ConnectionType::FEELER;
811 : : }
812 : :
813 : 36228 : bool IsAddrFetchConn() const {
814 [ + + + + : 36228 : return m_conn_type == ConnectionType::ADDR_FETCH;
+ + + + ]
815 : : }
816 : :
817 : 708932 : bool IsInboundConn() const {
818 [ + + + + : 698989 : return m_conn_type == ConnectionType::INBOUND;
+ + + + +
+ + + + +
+ + + + +
+ + + + +
- - + + ]
[ + + + -
+ + + + -
- # # # #
# # # # #
# # # # #
# # # # ]
819 : : }
820 : :
821 : 9362 : bool ExpectServicesFromConn() const {
822 [ + - + ]: 9362 : switch (m_conn_type) {
823 : : case ConnectionType::INBOUND:
824 : : case ConnectionType::MANUAL:
825 : : case ConnectionType::FEELER:
826 : : return false;
827 : 2950 : case ConnectionType::OUTBOUND_FULL_RELAY:
828 : 2950 : case ConnectionType::BLOCK_RELAY:
829 : 2950 : case ConnectionType::ADDR_FETCH:
830 : 2950 : return true;
831 : : } // no default case, so the compiler can warn about missing cases
832 : :
833 : 0 : assert(false);
834 : : }
835 : :
836 : : /**
837 : : * Get network the peer connected through.
838 : : *
839 : : * Returns Network::NET_ONION for *inbound* onion connections,
840 : : * and CNetAddr::GetNetClass() otherwise. The latter cannot be used directly
841 : : * because it doesn't detect the former, and it's not the responsibility of
842 : : * the CNetAddr class to know the actual network a peer is connected through.
843 : : *
844 : : * @return network the peer connected through.
845 : : */
846 : : Network ConnectedThroughNetwork() const;
847 : :
848 : : /** Whether this peer connected through a privacy network. */
849 : : [[nodiscard]] bool IsConnectedThroughPrivacyNet() const;
850 : :
851 : : // We selected peer as (compact blocks) high-bandwidth peer (BIP152)
852 : : std::atomic<bool> m_bip152_highbandwidth_to{false};
853 : : // Peer selected us as (compact blocks) high-bandwidth peer (BIP152)
854 : : std::atomic<bool> m_bip152_highbandwidth_from{false};
855 : :
856 : : /** Whether this peer provides all services that we want. Used for eviction decisions */
857 : : std::atomic_bool m_has_all_wanted_services{false};
858 : :
859 : : /** Whether we should relay transactions to this peer. This only changes
860 : : * from false to true. It will never change back to false. */
861 : : std::atomic_bool m_relays_txs{false};
862 : :
863 : : /** Whether this peer has loaded a bloom filter. Used only in inbound
864 : : * eviction logic. */
865 : : std::atomic_bool m_bloom_filter_loaded{false};
866 : :
867 : : /** UNIX epoch time of the last block received from this peer that we had
868 : : * not yet seen (e.g. not already received from another peer), that passed
869 : : * preliminary validity checks and was saved to disk, even if we don't
870 : : * connect the block or it eventually fails connection. Used as an inbound
871 : : * peer eviction criterium in CConnman::AttemptToEvictConnection. */
872 : : std::atomic<std::chrono::seconds> m_last_block_time{0s};
873 : :
874 : : /** UNIX epoch time of the last transaction received from this peer that we
875 : : * had not yet seen (e.g. not already received from another peer) and that
876 : : * was accepted into our mempool. Used as an inbound peer eviction criterium
877 : : * in CConnman::AttemptToEvictConnection. */
878 : : std::atomic<std::chrono::seconds> m_last_tx_time{0s};
879 : :
880 : : /** Last measured round-trip time. Used only for RPC/GUI stats/debugging.*/
881 : : std::atomic<std::chrono::microseconds> m_last_ping_time{0us};
882 : :
883 : : /** Lowest measured round-trip time. Used as an inbound peer eviction
884 : : * criterium in CConnman::AttemptToEvictConnection. */
885 : : std::atomic<std::chrono::microseconds> m_min_ping_time{std::chrono::microseconds::max()};
886 : :
887 : : CNode(NodeId id,
888 : : std::shared_ptr<Sock> sock,
889 : : const CAddress& addrIn,
890 : : uint64_t nKeyedNetGroupIn,
891 : : uint64_t nLocalHostNonceIn,
892 : : const CService& addrBindIn,
893 : : const std::string& addrNameIn,
894 : : ConnectionType conn_type_in,
895 : : bool inbound_onion,
896 : : uint64_t network_key,
897 : : CNodeOptions&& node_opts = {});
898 : : CNode(const CNode&) = delete;
899 : : CNode& operator=(const CNode&) = delete;
900 : :
901 : 1402373 : NodeId GetId() const {
902 [ - - + - : 1385348 : return id;
- - - - -
- - - - -
+ - - - -
- - - - -
- - + - -
- - - - -
+ - + - +
- - - - -
+ - - - -
- + - - -
- - + - +
- - - - -
- - - - -
- - - - -
- - - - -
- + - + -
- - - - +
- - - - -
+ - + - -
- - - - -
- - - - -
- - - - -
+ - + - -
- - - - -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - +
- - - - -
+ - - - -
- + - + -
- + + - -
- - - ][ +
- - + - -
- - - - -
- - - # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - ]
903 : : }
904 : :
905 : 15240 : uint64_t GetLocalNonce() const {
906 [ + + ]: 15240 : return nLocalHostNonce;
907 : : }
908 : :
909 : 46598 : int GetRefCount() const
910 : : {
911 [ - + ]: 46598 : assert(nRefCount >= 0);
912 : 46598 : return nRefCount;
913 : : }
914 : :
915 : : /**
916 : : * Receive bytes from the buffer and deserialize them into messages.
917 : : *
918 : : * @param[in] msg_bytes The raw data
919 : : * @param[out] complete Set True if at least one message has been
920 : : * deserialized and is ready to be processed
921 : : * @return True if the peer should stay connected,
922 : : * False if the peer should be disconnected from.
923 : : */
924 : : bool ReceiveMsgBytes(std::span<const uint8_t> msg_bytes, bool& complete) EXCLUSIVE_LOCKS_REQUIRED(!cs_vRecv);
925 : :
926 : 7862 : void SetCommonVersion(int greatest_common_version)
927 : : {
928 : 7862 : Assume(m_greatest_common_version == INIT_PROTO_VERSION);
929 : 7862 : m_greatest_common_version = greatest_common_version;
930 : 7862 : }
931 : 39922 : int GetCommonVersion() const
932 : : {
933 [ + + + + : 39922 : return m_greatest_common_version;
+ + + + +
+ - - + +
- - ][ + + ]
934 : : }
935 : :
936 : : CService GetAddrLocal() const EXCLUSIVE_LOCKS_REQUIRED(!m_addr_local_mutex);
937 : : //! May not be called more than once
938 : : void SetAddrLocal(const CService& addrLocalIn) EXCLUSIVE_LOCKS_REQUIRED(!m_addr_local_mutex);
939 : :
940 : 22190 : CNode* AddRef()
941 : : {
942 [ - + ]: 7512 : nRefCount++;
943 [ - + ]: 22190 : return this;
944 : : }
945 : :
946 : 16946 : void Release()
947 : : {
948 [ # # ]: 2268 : nRefCount--;
949 : 2268 : }
950 : :
951 : : void CloseSocketDisconnect() EXCLUSIVE_LOCKS_REQUIRED(!m_sock_mutex);
952 : :
953 : : void CopyStats(CNodeStats& stats) EXCLUSIVE_LOCKS_REQUIRED(!m_subver_mutex, !m_addr_local_mutex, !cs_vSend, !cs_vRecv);
954 : :
955 [ + - - - : 2071 : std::string ConnectionTypeAsString() const { return ::ConnectionTypeAsString(m_conn_type); }
- - ][ # #
# # # # ]
956 : :
957 : : /**
958 : : * Helper function to optionally log the IP address.
959 : : *
960 : : * @param[in] log_ip whether to include the IP address
961 : : * @return " peeraddr=..." or ""
962 : : */
963 : : std::string LogIP(bool log_ip) const;
964 : :
965 : : /**
966 : : * Helper function to log disconnects.
967 : : *
968 : : * @param[in] log_ip whether to include the IP address
969 : : * @return "disconnecting peer=..." and optionally "peeraddr=..."
970 : : */
971 : : std::string DisconnectMsg(bool log_ip) const;
972 : :
973 : : /** A ping-pong round trip has completed successfully. Update latest and minimum ping times. */
974 : 0 : void PongReceived(std::chrono::microseconds ping_time) {
975 : 0 : m_last_ping_time = ping_time;
976 : 0 : m_min_ping_time = std::min(m_min_ping_time.load(), ping_time);
977 : 0 : }
978 : :
979 : : private:
980 : : const NodeId id;
981 : : const uint64_t nLocalHostNonce;
982 : : std::atomic<int> m_greatest_common_version{INIT_PROTO_VERSION};
983 : :
984 : : const size_t m_recv_flood_size;
985 : : std::list<CNetMessage> vRecvMsg; // Used only by SocketHandler thread
986 : :
987 : : Mutex m_msg_process_queue_mutex;
988 : : std::list<CNetMessage> m_msg_process_queue GUARDED_BY(m_msg_process_queue_mutex);
989 : : size_t m_msg_process_queue_size GUARDED_BY(m_msg_process_queue_mutex){0};
990 : :
991 : : // Our address, as reported by the peer
992 : : CService m_addr_local GUARDED_BY(m_addr_local_mutex);
993 : : mutable Mutex m_addr_local_mutex;
994 : :
995 : : mapMsgTypeSize mapSendBytesPerMsgType GUARDED_BY(cs_vSend);
996 : : mapMsgTypeSize mapRecvBytesPerMsgType GUARDED_BY(cs_vRecv);
997 : :
998 : : /**
999 : : * If an I2P session is created per connection (for outbound transient I2P
1000 : : * connections) then it is stored here so that it can be destroyed when the
1001 : : * socket is closed. I2P sessions involve a data/transport socket (in `m_sock`)
1002 : : * and a control socket (in `m_i2p_sam_session`). For transient sessions, once
1003 : : * the data socket is closed, the control socket is not going to be used anymore
1004 : : * and is just taking up resources. So better close it as soon as `m_sock` is
1005 : : * closed.
1006 : : * Otherwise this unique_ptr is empty.
1007 : : */
1008 : : std::unique_ptr<i2p::sam::Session> m_i2p_sam_session GUARDED_BY(m_sock_mutex);
1009 : : };
1010 : :
1011 : : /**
1012 : : * Interface for message handling
1013 : : */
1014 [ + - ]: 7530 : class NetEventsInterface
1015 : : {
1016 : : public:
1017 : : /** Mutex for anything that is only accessed via the msg processing thread */
1018 : : static Mutex g_msgproc_mutex;
1019 : :
1020 : : /** Initialize a peer (setup state) */
1021 : : virtual void InitializeNode(const CNode& node, ServiceFlags our_services) = 0;
1022 : :
1023 : : /** Handle removal of a peer (clear state) */
1024 : : virtual void FinalizeNode(const CNode& node) = 0;
1025 : :
1026 : : /**
1027 : : * Callback to determine whether the given set of service flags are sufficient
1028 : : * for a peer to be "relevant".
1029 : : */
1030 : : virtual bool HasAllDesirableServiceFlags(ServiceFlags services) const = 0;
1031 : :
1032 : : /**
1033 : : * Process protocol messages received from a given node
1034 : : *
1035 : : * @param[in] pnode The node which we have received messages from.
1036 : : * @param[in] interrupt Interrupt condition for processing threads
1037 : : * @return True if there is more work to be done
1038 : : */
1039 : : virtual bool ProcessMessages(CNode* pnode, std::atomic<bool>& interrupt) EXCLUSIVE_LOCKS_REQUIRED(g_msgproc_mutex) = 0;
1040 : :
1041 : : /**
1042 : : * Send queued protocol messages to a given node.
1043 : : *
1044 : : * @param[in] pnode The node which we are sending messages to.
1045 : : * @return True if there is more work to be done
1046 : : */
1047 : : virtual bool SendMessages(CNode* pnode) EXCLUSIVE_LOCKS_REQUIRED(g_msgproc_mutex) = 0;
1048 : :
1049 : :
1050 : : protected:
1051 : : /**
1052 : : * Protected destructor so that instances can only be deleted by derived classes.
1053 : : * If that restriction is no longer desired, this should be made public and virtual.
1054 : : */
1055 : : ~NetEventsInterface() = default;
1056 : : };
1057 : :
1058 : : class CConnman
1059 : : {
1060 : : public:
1061 : :
1062 : : struct Options
1063 : : {
1064 : : ServiceFlags m_local_services = NODE_NONE;
1065 : : int m_max_automatic_connections = 0;
1066 : : CClientUIInterface* uiInterface = nullptr;
1067 : : NetEventsInterface* m_msgproc = nullptr;
1068 : : BanMan* m_banman = nullptr;
1069 : : unsigned int nSendBufferMaxSize = 0;
1070 : : unsigned int nReceiveFloodSize = 0;
1071 : : uint64_t nMaxOutboundLimit = 0;
1072 : : int64_t m_peer_connect_timeout = DEFAULT_PEER_CONNECT_TIMEOUT;
1073 : : std::vector<std::string> vSeedNodes;
1074 : : std::vector<NetWhitelistPermissions> vWhitelistedRangeIncoming;
1075 : : std::vector<NetWhitelistPermissions> vWhitelistedRangeOutgoing;
1076 : : std::vector<NetWhitebindPermissions> vWhiteBinds;
1077 : : std::vector<CService> vBinds;
1078 : : std::vector<CService> onion_binds;
1079 : : /// True if the user did not specify -bind= or -whitebind= and thus
1080 : : /// we should bind on `0.0.0.0` (IPv4) and `::` (IPv6).
1081 : : bool bind_on_any;
1082 : : bool m_use_addrman_outgoing = true;
1083 : : std::vector<std::string> m_specified_outgoing;
1084 : : std::vector<std::string> m_added_nodes;
1085 : : bool m_i2p_accept_incoming;
1086 : : bool whitelist_forcerelay = DEFAULT_WHITELISTFORCERELAY;
1087 : : bool whitelist_relay = DEFAULT_WHITELISTRELAY;
1088 : : };
1089 : :
1090 : 3473 : void Init(const Options& connOptions) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex, !m_total_bytes_sent_mutex)
1091 : : {
1092 : 3473 : AssertLockNotHeld(m_total_bytes_sent_mutex);
1093 : :
1094 [ - + ]: 3473 : m_local_services = connOptions.m_local_services;
1095 : 3473 : m_max_automatic_connections = connOptions.m_max_automatic_connections;
1096 [ - + ]: 3473 : m_max_outbound_full_relay = std::min(MAX_OUTBOUND_FULL_RELAY_CONNECTIONS, m_max_automatic_connections);
1097 [ - + ]: 3473 : m_max_outbound_block_relay = std::min(MAX_BLOCK_RELAY_ONLY_CONNECTIONS, m_max_automatic_connections - m_max_outbound_full_relay);
1098 : 3473 : m_max_automatic_outbound = m_max_outbound_full_relay + m_max_outbound_block_relay + m_max_feeler;
1099 [ + - ]: 3473 : m_max_inbound = std::max(0, m_max_automatic_connections - m_max_automatic_outbound);
1100 : 3473 : m_use_addrman_outgoing = connOptions.m_use_addrman_outgoing;
1101 : 3473 : m_client_interface = connOptions.uiInterface;
1102 : 3473 : m_banman = connOptions.m_banman;
1103 : 3473 : m_msgproc = connOptions.m_msgproc;
1104 : 3473 : nSendBufferMaxSize = connOptions.nSendBufferMaxSize;
1105 : 3473 : nReceiveFloodSize = connOptions.nReceiveFloodSize;
1106 : 3473 : m_peer_connect_timeout = std::chrono::seconds{connOptions.m_peer_connect_timeout};
1107 : 3473 : {
1108 : 3473 : LOCK(m_total_bytes_sent_mutex);
1109 [ + - ]: 3473 : nMaxOutboundLimit = connOptions.nMaxOutboundLimit;
1110 : 3473 : }
1111 : 3473 : vWhitelistedRangeIncoming = connOptions.vWhitelistedRangeIncoming;
1112 : 3473 : vWhitelistedRangeOutgoing = connOptions.vWhitelistedRangeOutgoing;
1113 : 3473 : {
1114 : 3473 : LOCK(m_added_nodes_mutex);
1115 : : // Attempt v2 connection if we support v2 - we'll reconnect with v1 if our
1116 : : // peer doesn't support it or immediately disconnects us for another reason.
1117 [ + - ]: 3473 : const bool use_v2transport(GetLocalServices() & NODE_P2P_V2);
1118 [ - + ]: 3473 : for (const std::string& added_node : connOptions.m_added_nodes) {
1119 [ # # ]: 0 : m_added_node_params.push_back({added_node, use_v2transport});
1120 : : }
1121 : 3473 : }
1122 : 3473 : m_onion_binds = connOptions.onion_binds;
1123 : 3473 : whitelist_forcerelay = connOptions.whitelist_forcerelay;
1124 : 3473 : whitelist_relay = connOptions.whitelist_relay;
1125 [ - - ]: 3473 : }
1126 : :
1127 : : CConnman(uint64_t seed0,
1128 : : uint64_t seed1,
1129 : : AddrMan& addrman,
1130 : : const NetGroupManager& netgroupman,
1131 : : const CChainParams& params,
1132 : : bool network_active = true,
1133 : : std::shared_ptr<CThreadInterrupt> interrupt_net = std::make_shared<CThreadInterrupt>());
1134 : :
1135 : : ~CConnman();
1136 : :
1137 : : bool Start(CScheduler& scheduler, const Options& options) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex, !m_added_nodes_mutex, !m_addr_fetches_mutex, !mutexMsgProc);
1138 : :
1139 : : void StopThreads();
1140 : : void StopNodes();
1141 : 1736 : void Stop()
1142 : : {
1143 [ # # ]: 1736 : StopThreads();
1144 [ # # ]: 1736 : StopNodes();
1145 : 0 : };
1146 : :
1147 : : void Interrupt() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
1148 [ + - ]: 1716 : bool GetNetworkActive() const { return fNetworkActive; };
[ # # # # ]
1149 [ # # ]: 0 : bool GetUseAddrmanOutgoing() const { return m_use_addrman_outgoing; };
1150 : : void SetNetworkActive(bool active);
1151 : :
1152 : : /**
1153 : : * Open a new P2P connection and initialize it with the PeerManager at `m_msgproc`.
1154 : : * @param[in] addrConnect Address to connect to, if `pszDest` is `nullptr`.
1155 : : * @param[in] fCountFailure Increment the number of connection attempts to this address in Addrman.
1156 : : * @param[in] grant_outbound Take ownership of this grant, to be released later when the connection is closed.
1157 : : * @param[in] pszDest Address to resolve and connect to.
1158 : : * @param[in] conn_type Type of the connection to open, must not be `ConnectionType::INBOUND`.
1159 : : * @param[in] use_v2transport Use P2P encryption, (aka V2 transport, BIP324).
1160 : : * @param[in] proxy_override Optional proxy to use and override normal proxy selection.
1161 : : * @retval true The connection was opened successfully.
1162 : : * @retval false The connection attempt failed.
1163 : : */
1164 : : bool OpenNetworkConnection(const CAddress& addrConnect,
1165 : : bool fCountFailure,
1166 : : CountingSemaphoreGrant<>&& grant_outbound,
1167 : : const char* pszDest,
1168 : : ConnectionType conn_type,
1169 : : bool use_v2transport,
1170 [ # # # # : 1694 : const std::optional<Proxy>& proxy_override = std::nullopt)
# # # # #
# # # #
# ][ # # #
# # # # #
# # # # #
# ]
1171 : : EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
1172 : :
1173 : : bool CheckIncomingNonce(uint64_t nonce);
1174 : : void ASMapHealthCheck();
1175 : :
1176 : : // alias for thread safety annotations only, not defined
1177 : : RecursiveMutex& GetNodesMutex() const LOCK_RETURNED(m_nodes_mutex);
1178 : :
1179 : : bool ForNode(NodeId id, std::function<bool(CNode* pnode)> func);
1180 : :
1181 : : void PushMessage(CNode* pnode, CSerializedNetMsg&& msg) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1182 : :
1183 : : using NodeFn = std::function<void(CNode*)>;
1184 : 323 : void ForEachNode(const NodeFn& func)
1185 : : {
1186 : 323 : LOCK(m_nodes_mutex);
1187 [ + + ]: 31474 : for (auto&& node : m_nodes) {
1188 [ + - - + ]: 31151 : if (NodeFullyConnected(node))
1189 [ # # ]: 0 : func(node);
1190 : : }
1191 : 323 : };
1192 : :
1193 : : void ForEachNode(const NodeFn& func) const
1194 : : {
1195 : : LOCK(m_nodes_mutex);
1196 : : for (auto&& node : m_nodes) {
1197 : : if (NodeFullyConnected(node))
1198 : : func(node);
1199 : : }
1200 : : };
1201 : :
1202 : : // Addrman functions
1203 : : /**
1204 : : * Return randomly selected addresses. This function does not use the address response cache and
1205 : : * should only be used in trusted contexts.
1206 : : *
1207 : : * An untrusted caller (e.g. from p2p) should instead use @ref GetAddresses to use the cache.
1208 : : *
1209 : : * @param[in] max_addresses Maximum number of addresses to return (0 = all).
1210 : : * @param[in] max_pct Maximum percentage of addresses to return (0 = all). Value must be from 0 to 100.
1211 : : * @param[in] network Select only addresses of this network (nullopt = all).
1212 : : * @param[in] filtered Select only addresses that are considered high quality (false = all).
1213 : : */
1214 : : std::vector<CAddress> GetAddressesUnsafe(size_t max_addresses, size_t max_pct, std::optional<Network> network, const bool filtered = true) const;
1215 : : /**
1216 : : * Return addresses from the per-requestor cache. If no cache entry exists, it is populated with
1217 : : * randomly selected addresses. This function can be used in untrusted contexts.
1218 : : *
1219 : : * A trusted caller (e.g. from RPC or a peer with addr permission) can use
1220 : : * @ref GetAddressesUnsafe to avoid using the cache.
1221 : : *
1222 : : * @param[in] requestor The requesting peer. Used to key the cache to prevent privacy leaks.
1223 : : * @param[in] max_addresses Maximum number of addresses to return (0 = all). Ignored when cache
1224 : : * already contains an entry for requestor.
1225 : : * @param[in] max_pct Maximum percentage of addresses to return (0 = all). Value must be
1226 : : * from 0 to 100. Ignored when cache already contains an entry for
1227 : : * requestor.
1228 : : */
1229 : : std::vector<CAddress> GetAddresses(CNode& requestor, size_t max_addresses, size_t max_pct);
1230 : :
1231 : : // This allows temporarily exceeding m_max_outbound_full_relay, with the goal of finding
1232 : : // a peer that is better than all our current peers.
1233 : : void SetTryNewOutboundPeer(bool flag);
1234 : : bool GetTryNewOutboundPeer() const;
1235 : :
1236 : : void StartExtraBlockRelayPeers();
1237 : :
1238 : : // Count the number of full-relay peer we have.
1239 : : int GetFullOutboundConnCount() const;
1240 : : // Return the number of outbound peers we have in excess of our target (eg,
1241 : : // if we previously called SetTryNewOutboundPeer(true), and have since set
1242 : : // to false, we may have extra peers that we wish to disconnect). This may
1243 : : // return a value less than (num_outbound_connections - num_outbound_slots)
1244 : : // in cases where some outbound connections are not yet fully connected, or
1245 : : // not yet fully disconnected.
1246 : : int GetExtraFullOutboundCount() const;
1247 : : // Count the number of block-relay-only peers we have over our limit.
1248 : : int GetExtraBlockRelayCount() const;
1249 : :
1250 : : bool AddNode(const AddedNodeParams& add) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
1251 : : bool RemoveAddedNode(const std::string& node) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
1252 : : bool AddedNodesContain(const CAddress& addr) const EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
1253 : : std::vector<AddedNodeInfo> GetAddedNodeInfo(bool include_connected) const EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex);
1254 : :
1255 : : /**
1256 : : * Attempts to open a connection. Currently only used from tests.
1257 : : *
1258 : : * @param[in] address Address of node to try connecting to
1259 : : * @param[in] conn_type ConnectionType::OUTBOUND, ConnectionType::BLOCK_RELAY,
1260 : : * ConnectionType::ADDR_FETCH or ConnectionType::FEELER
1261 : : * @param[in] use_v2transport Set to true if node attempts to connect using BIP 324 v2 transport protocol.
1262 : : * @return bool Returns false if there are no available
1263 : : * slots for this connection:
1264 : : * - conn_type not a supported ConnectionType
1265 : : * - Max total outbound connection capacity filled
1266 : : * - Max connection capacity for type is filled
1267 : : */
1268 : : bool AddConnection(const std::string& address, ConnectionType conn_type, bool use_v2transport) EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
1269 : :
1270 : : size_t GetNodeCount(ConnectionDirection) const;
1271 : : std::map<CNetAddr, LocalServiceInfo> getNetLocalAddresses() const;
1272 : : uint32_t GetMappedAS(const CNetAddr& addr) const;
1273 : : void GetNodeStats(std::vector<CNodeStats>& vstats) const;
1274 : : bool DisconnectNode(const std::string& node);
1275 : : bool DisconnectNode(const CSubNet& subnet);
1276 : : bool DisconnectNode(const CNetAddr& addr);
1277 : : bool DisconnectNode(NodeId id);
1278 : :
1279 : : //! Used to convey which local services we are offering peers during node
1280 : : //! connection.
1281 : : //!
1282 : : //! The data returned by this is used in CNode construction,
1283 : : //! which is used to advertise which services we are offering
1284 : : //! that peer during `net_processing.cpp:PushNodeVersion()`.
1285 : : ServiceFlags GetLocalServices() const;
1286 : :
1287 : : //! Updates the local services that this node advertises to other peers
1288 : : //! during connection handshake.
1289 : 0 : void AddLocalServices(ServiceFlags services) { m_local_services = ServiceFlags(m_local_services | services); };
1290 : 0 : void RemoveLocalServices(ServiceFlags services) { m_local_services = ServiceFlags(m_local_services & ~services); }
1291 : :
1292 : : uint64_t GetMaxOutboundTarget() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1293 : : std::chrono::seconds GetMaxOutboundTimeframe() const;
1294 : :
1295 : : //! check if the outbound target is reached
1296 : : //! if param historicalBlockServingLimit is set true, the function will
1297 : : //! response true if the limit for serving historical blocks has been reached
1298 : : bool OutboundTargetReached(bool historicalBlockServingLimit) const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1299 : :
1300 : : //! response the bytes left in the current max outbound cycle
1301 : : //! in case of no limit, it will always response 0
1302 : : uint64_t GetOutboundTargetBytesLeft() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1303 : :
1304 : : std::chrono::seconds GetMaxOutboundTimeLeftInCycle() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1305 : :
1306 : : uint64_t GetTotalBytesRecv() const;
1307 : : uint64_t GetTotalBytesSent() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1308 : :
1309 : : /** Get a unique deterministic randomizer. */
1310 : : CSipHasher GetDeterministicRandomizer(uint64_t id) const;
1311 : :
1312 : : void WakeMessageHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
1313 : :
1314 : : /** Return true if we should disconnect the peer for failing an inactivity check. */
1315 : : bool ShouldRunInactivityChecks(const CNode& node, std::chrono::seconds now) const;
1316 : :
1317 : : bool MultipleManualOrFullOutboundConns(Network net) const EXCLUSIVE_LOCKS_REQUIRED(m_nodes_mutex);
1318 : :
1319 : : private:
1320 [ - + + - ]: 63 : struct ListenSocket {
1321 : : public:
1322 : : std::shared_ptr<Sock> sock;
1323 [ # # ]: 0 : inline void AddSocketPermissionFlags(NetPermissionFlags& flags) const { NetPermissions::AddFlag(flags, m_permissions); }
1324 : 23 : ListenSocket(std::shared_ptr<Sock> sock_, NetPermissionFlags permissions_)
1325 [ + - + - ]: 46 : : sock{sock_}, m_permissions{permissions_}
1326 : : {
1327 : : }
1328 : :
1329 : : private:
1330 : : NetPermissionFlags m_permissions;
1331 : : };
1332 : :
1333 : : //! returns the time left in the current max outbound cycle
1334 : : //! in case of no limit, it will always return 0
1335 : : std::chrono::seconds GetMaxOutboundTimeLeftInCycle_() const EXCLUSIVE_LOCKS_REQUIRED(m_total_bytes_sent_mutex);
1336 : :
1337 : : bool BindListenPort(const CService& bindAddr, bilingual_str& strError, NetPermissionFlags permissions);
1338 : : bool Bind(const CService& addr, unsigned int flags, NetPermissionFlags permissions);
1339 : : bool InitBinds(const Options& options);
1340 : :
1341 : : void ThreadOpenAddedConnections() EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex, !m_unused_i2p_sessions_mutex, !m_reconnections_mutex);
1342 : : void AddAddrFetch(const std::string& strDest) EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex);
1343 : : void ProcessAddrFetch() EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex, !m_unused_i2p_sessions_mutex);
1344 : : void ThreadOpenConnections(std::vector<std::string> connect, std::span<const std::string> seed_nodes) EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex, !m_added_nodes_mutex, !m_nodes_mutex, !m_unused_i2p_sessions_mutex, !m_reconnections_mutex);
1345 : : void ThreadMessageHandler() EXCLUSIVE_LOCKS_REQUIRED(!mutexMsgProc);
1346 : : void ThreadI2PAcceptIncoming();
1347 : : void AcceptConnection(const ListenSocket& hListenSocket);
1348 : :
1349 : : /**
1350 : : * Create a `CNode` object from a socket that has just been accepted and add the node to
1351 : : * the `m_nodes` member.
1352 : : * @param[in] sock Connected socket to communicate with the peer.
1353 : : * @param[in] permission_flags The peer's permissions.
1354 : : * @param[in] addr_bind The address and port at our side of the connection.
1355 : : * @param[in] addr The address and port at the peer's side of the connection.
1356 : : */
1357 : : void CreateNodeFromAcceptedSocket(std::unique_ptr<Sock>&& sock,
1358 : : NetPermissionFlags permission_flags,
1359 : : const CService& addr_bind,
1360 : : const CService& addr);
1361 : :
1362 : : void DisconnectNodes() EXCLUSIVE_LOCKS_REQUIRED(!m_reconnections_mutex, !m_nodes_mutex);
1363 : : void NotifyNumConnectionsChanged();
1364 : : /** Return true if the peer is inactive and should be disconnected. */
1365 : : bool InactivityCheck(const CNode& node) const;
1366 : :
1367 : : /**
1368 : : * Generate a collection of sockets to check for IO readiness.
1369 : : * @param[in] nodes Select from these nodes' sockets.
1370 : : * @return sockets to check for readiness
1371 : : */
1372 : : Sock::EventsPerSock GenerateWaitSockets(std::span<CNode* const> nodes);
1373 : :
1374 : : /**
1375 : : * Check connected and listening sockets for IO readiness and process them accordingly.
1376 : : */
1377 : : void SocketHandler() EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex, !mutexMsgProc);
1378 : :
1379 : : /**
1380 : : * Do the read/write for connected sockets that are ready for IO.
1381 : : * @param[in] nodes Nodes to process. The socket of each node is checked against `what`.
1382 : : * @param[in] events_per_sock Sockets that are ready for IO.
1383 : : */
1384 : : void SocketHandlerConnected(const std::vector<CNode*>& nodes,
1385 : : const Sock::EventsPerSock& events_per_sock)
1386 : : EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex, !mutexMsgProc);
1387 : :
1388 : : /**
1389 : : * Accept incoming connections, one from each read-ready listening socket.
1390 : : * @param[in] events_per_sock Sockets that are ready for IO.
1391 : : */
1392 : : void SocketHandlerListening(const Sock::EventsPerSock& events_per_sock);
1393 : :
1394 : : void ThreadSocketHandler() EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex, !mutexMsgProc, !m_nodes_mutex, !m_reconnections_mutex);
1395 : : void ThreadDNSAddressSeed() EXCLUSIVE_LOCKS_REQUIRED(!m_addr_fetches_mutex, !m_nodes_mutex);
1396 : :
1397 : : uint64_t CalculateKeyedNetGroup(const CNetAddr& ad) const;
1398 : :
1399 : : /**
1400 : : * Determine whether we're already connected to a given "host:port".
1401 : : * Note that for inbound connections, the peer is likely using a random outbound
1402 : : * port on their side, so this will likely not match any inbound connections.
1403 : : * @param[in] host String of the form "host[:port]", e.g. "localhost" or "localhost:8333" or "1.2.3.4:8333".
1404 : : * @return true if connected to `host`.
1405 : : */
1406 : : bool AlreadyConnectedToHost(const std::string& host) const;
1407 : :
1408 : : /**
1409 : : * Determine whether we're already connected to a given address:port.
1410 : : * Note that for inbound connections, the peer is likely using a random outbound
1411 : : * port on their side, so this will likely not match any inbound connections.
1412 : : * @param[in] addr_port Address and port to check.
1413 : : * @return true if connected to addr_port.
1414 : : */
1415 : : bool AlreadyConnectedToAddressPort(const CService& addr_port) const;
1416 : :
1417 : : /**
1418 : : * Determine whether we're already connected to a given address.
1419 : : */
1420 : : bool AlreadyConnectedToAddress(const CNetAddr& addr) const;
1421 : :
1422 : : bool AttemptToEvictConnection();
1423 : :
1424 : : /**
1425 : : * Open a new P2P connection.
1426 : : * @param[in] addrConnect Address to connect to, if `pszDest` is `nullptr`.
1427 : : * @param[in] pszDest Address to resolve and connect to.
1428 : : * @param[in] fCountFailure Increment the number of connection attempts to this address in Addrman.
1429 : : * @param[in] conn_type Type of the connection to open, must not be `ConnectionType::INBOUND`.
1430 : : * @param[in] use_v2transport Use P2P encryption, (aka V2 transport, BIP324).
1431 : : * @param[in] proxy_override Optional proxy to use and override normal proxy selection.
1432 : : * @return Newly created CNode object or nullptr if the connection failed.
1433 : : */
1434 : : CNode* ConnectNode(CAddress addrConnect,
1435 : : const char* pszDest,
1436 : : bool fCountFailure,
1437 : : ConnectionType conn_type,
1438 : : bool use_v2transport,
1439 : : const std::optional<Proxy>& proxy_override)
1440 : : EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex);
1441 : :
1442 : : void AddWhitelistPermissionFlags(NetPermissionFlags& flags, std::optional<CNetAddr> addr, const std::vector<NetWhitelistPermissions>& ranges) const;
1443 : :
1444 : : void DeleteNode(CNode* pnode);
1445 : :
1446 : : NodeId GetNewNodeId();
1447 : :
1448 : : /** (Try to) send data from node's vSendMsg. Returns (bytes_sent, data_left). */
1449 : : std::pair<size_t, bool> SocketSendData(CNode& node) const EXCLUSIVE_LOCKS_REQUIRED(node.cs_vSend);
1450 : :
1451 : : void DumpAddresses();
1452 : :
1453 : : // Network stats
1454 : : void RecordBytesRecv(uint64_t bytes);
1455 : : void RecordBytesSent(uint64_t bytes) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex);
1456 : :
1457 : : /**
1458 : : Return reachable networks for which we have no addresses in addrman and therefore
1459 : : may require loading fixed seeds.
1460 : : */
1461 : : std::unordered_set<Network> GetReachableEmptyNetworks() const;
1462 : :
1463 : : /**
1464 : : * Return vector of current BLOCK_RELAY peers.
1465 : : */
1466 : : std::vector<CAddress> GetCurrentBlockRelayOnlyConns() const;
1467 : :
1468 : : /**
1469 : : * Search for a "preferred" network, a reachable network to which we
1470 : : * currently don't have any OUTBOUND_FULL_RELAY or MANUAL connections.
1471 : : * There needs to be at least one address in AddrMan for a preferred
1472 : : * network to be picked.
1473 : : *
1474 : : * @param[out] network Preferred network, if found.
1475 : : *
1476 : : * @return bool Whether a preferred network was found.
1477 : : */
1478 : : bool MaybePickPreferredNetwork(std::optional<Network>& network);
1479 : :
1480 : : // Whether the node should be passed out in ForEach* callbacks
1481 : : static bool NodeFullyConnected(const CNode* pnode);
1482 : :
1483 : : uint16_t GetDefaultPort(Network net) const;
1484 : : uint16_t GetDefaultPort(const std::string& addr) const;
1485 : :
1486 : : // Network usage totals
1487 : : mutable Mutex m_total_bytes_sent_mutex;
1488 : : std::atomic<uint64_t> nTotalBytesRecv{0};
1489 : : uint64_t nTotalBytesSent GUARDED_BY(m_total_bytes_sent_mutex) {0};
1490 : :
1491 : : // outbound limit & stats
1492 : : uint64_t nMaxOutboundTotalBytesSentInCycle GUARDED_BY(m_total_bytes_sent_mutex) {0};
1493 : : std::chrono::seconds nMaxOutboundCycleStartTime GUARDED_BY(m_total_bytes_sent_mutex) {0};
1494 : : uint64_t nMaxOutboundLimit GUARDED_BY(m_total_bytes_sent_mutex);
1495 : :
1496 : : // P2P timeout in seconds
1497 : : std::chrono::seconds m_peer_connect_timeout;
1498 : :
1499 : : // Whitelisted ranges. Any node connecting from these is automatically
1500 : : // whitelisted (as well as those connecting to whitelisted binds).
1501 : : std::vector<NetWhitelistPermissions> vWhitelistedRangeIncoming;
1502 : : // Whitelisted ranges for outgoing connections.
1503 : : std::vector<NetWhitelistPermissions> vWhitelistedRangeOutgoing;
1504 : :
1505 : : unsigned int nSendBufferMaxSize{0};
1506 : : unsigned int nReceiveFloodSize{0};
1507 : :
1508 : : std::vector<ListenSocket> vhListenSocket;
1509 : : std::atomic<bool> fNetworkActive{true};
1510 : : bool fAddressesInitialized{false};
1511 : : AddrMan& addrman;
1512 : : const NetGroupManager& m_netgroupman;
1513 : : std::deque<std::string> m_addr_fetches GUARDED_BY(m_addr_fetches_mutex);
1514 : : Mutex m_addr_fetches_mutex;
1515 : :
1516 : : // connection string and whether to use v2 p2p
1517 : : std::vector<AddedNodeParams> m_added_node_params GUARDED_BY(m_added_nodes_mutex);
1518 : :
1519 : : mutable Mutex m_added_nodes_mutex;
1520 : : std::vector<CNode*> m_nodes GUARDED_BY(m_nodes_mutex);
1521 : : std::list<CNode*> m_nodes_disconnected;
1522 : : mutable RecursiveMutex m_nodes_mutex;
1523 : : std::atomic<NodeId> nLastNodeId{0};
1524 : : unsigned int nPrevNodeCount{0};
1525 : :
1526 : : // Stores number of full-tx connections (outbound and manual) per network
1527 : : std::array<unsigned int, Network::NET_MAX> m_network_conn_counts GUARDED_BY(m_nodes_mutex) = {};
1528 : :
1529 : : /**
1530 : : * Cache responses to addr requests to minimize privacy leak.
1531 : : * Attack example: scraping addrs in real-time may allow an attacker
1532 : : * to infer new connections of the victim by detecting new records
1533 : : * with fresh timestamps (per self-announcement).
1534 : : */
1535 [ + + ]: 285 : struct CachedAddrResponse {
1536 : : std::vector<CAddress> m_addrs_response_cache;
1537 : : std::chrono::microseconds m_cache_entry_expiration{0};
1538 : : };
1539 : :
1540 : : /**
1541 : : * Addr responses stored in different caches
1542 : : * per (network, local socket) prevent cross-network node identification.
1543 : : * If a node for example is multi-homed under Tor and IPv6,
1544 : : * a single cache (or no cache at all) would let an attacker
1545 : : * to easily detect that it is the same node by comparing responses.
1546 : : * Indexing by local socket prevents leakage when a node has multiple
1547 : : * listening addresses on the same network.
1548 : : *
1549 : : * The used memory equals to 1000 CAddress records (or around 40 bytes) per
1550 : : * distinct Network (up to 5) we have/had an inbound peer from,
1551 : : * resulting in at most ~196 KB. Every separate local socket may
1552 : : * add up to ~196 KB extra.
1553 : : */
1554 : : std::map<uint64_t, CachedAddrResponse> m_addr_response_caches;
1555 : :
1556 : : /**
1557 : : * Services this node offers.
1558 : : *
1559 : : * This data is replicated in each Peer instance we create.
1560 : : *
1561 : : * This data is not marked const, but after being set it should not
1562 : : * change. Unless AssumeUTXO is started, in which case, the peer
1563 : : * will be limited until the background chain sync finishes.
1564 : : *
1565 : : * \sa Peer::our_services
1566 : : */
1567 : : std::atomic<ServiceFlags> m_local_services;
1568 : :
1569 : : std::unique_ptr<std::counting_semaphore<>> semOutbound;
1570 : : std::unique_ptr<std::counting_semaphore<>> semAddnode;
1571 : :
1572 : : /**
1573 : : * Maximum number of automatic connections permitted, excluding manual
1574 : : * connections but including inbounds. May be changed by the user and is
1575 : : * potentially limited by the operating system (number of file descriptors).
1576 : : */
1577 : : int m_max_automatic_connections;
1578 : :
1579 : : /*
1580 : : * Maximum number of peers by connection type. Might vary from defaults
1581 : : * based on -maxconnections init value.
1582 : : */
1583 : :
1584 : : // How many full-relay (tx, block, addr) outbound peers we want
1585 : : int m_max_outbound_full_relay;
1586 : :
1587 : : // How many block-relay only outbound peers we want
1588 : : // We do not relay tx or addr messages with these peers
1589 : : int m_max_outbound_block_relay;
1590 : :
1591 : : int m_max_addnode{MAX_ADDNODE_CONNECTIONS};
1592 : : int m_max_feeler{MAX_FEELER_CONNECTIONS};
1593 : : int m_max_automatic_outbound;
1594 : : int m_max_inbound;
1595 : :
1596 : : bool m_use_addrman_outgoing;
1597 : : CClientUIInterface* m_client_interface;
1598 : : NetEventsInterface* m_msgproc;
1599 : : /** Pointer to this node's banman. May be nullptr - check existence before dereferencing. */
1600 : : BanMan* m_banman;
1601 : :
1602 : : /**
1603 : : * Addresses that were saved during the previous clean shutdown. We'll
1604 : : * attempt to make block-relay-only connections to them.
1605 : : */
1606 : : std::vector<CAddress> m_anchors;
1607 : :
1608 : : /** SipHasher seeds for deterministic randomness */
1609 : : const uint64_t nSeed0, nSeed1;
1610 : :
1611 : : /** flag for waking the message processor. */
1612 : : bool fMsgProcWake GUARDED_BY(mutexMsgProc);
1613 : :
1614 : : std::condition_variable condMsgProc;
1615 : : Mutex mutexMsgProc;
1616 : : std::atomic<bool> flagInterruptMsgProc{false};
1617 : :
1618 : : /**
1619 : : * This is signaled when network activity should cease.
1620 : : * A copy of this is saved in `m_i2p_sam_session`.
1621 : : */
1622 : : const std::shared_ptr<CThreadInterrupt> m_interrupt_net;
1623 : :
1624 : : /**
1625 : : * I2P SAM session.
1626 : : * Used to accept incoming and make outgoing I2P connections from a persistent
1627 : : * address.
1628 : : */
1629 : : std::unique_ptr<i2p::sam::Session> m_i2p_sam_session;
1630 : :
1631 : : std::thread threadDNSAddressSeed;
1632 : : std::thread threadSocketHandler;
1633 : : std::thread threadOpenAddedConnections;
1634 : : std::thread threadOpenConnections;
1635 : : std::thread threadMessageHandler;
1636 : : std::thread threadI2PAcceptIncoming;
1637 : :
1638 : : /** flag for deciding to connect to an extra outbound peer,
1639 : : * in excess of m_max_outbound_full_relay
1640 : : * This takes the place of a feeler connection */
1641 : : std::atomic_bool m_try_another_outbound_peer;
1642 : :
1643 : : /** flag for initiating extra block-relay-only peer connections.
1644 : : * this should only be enabled after initial chain sync has occurred,
1645 : : * as these connections are intended to be short-lived and low-bandwidth.
1646 : : */
1647 : : std::atomic_bool m_start_extra_block_relay_peers{false};
1648 : :
1649 : : /**
1650 : : * A vector of -bind=<address>:<port>=onion arguments each of which is
1651 : : * an address and port that are designated for incoming Tor connections.
1652 : : */
1653 : : std::vector<CService> m_onion_binds;
1654 : :
1655 : : /**
1656 : : * flag for adding 'forcerelay' permission to whitelisted inbound
1657 : : * and manual peers with default permissions.
1658 : : */
1659 : : bool whitelist_forcerelay;
1660 : :
1661 : : /**
1662 : : * flag for adding 'relay' permission to whitelisted inbound
1663 : : * and manual peers with default permissions.
1664 : : */
1665 : : bool whitelist_relay;
1666 : :
1667 : : /**
1668 : : * Mutex protecting m_i2p_sam_sessions.
1669 : : */
1670 : : Mutex m_unused_i2p_sessions_mutex;
1671 : :
1672 : : /**
1673 : : * A pool of created I2P SAM transient sessions that should be used instead
1674 : : * of creating new ones in order to reduce the load on the I2P network.
1675 : : * Creating a session in I2P is not cheap, thus if this is not empty, then
1676 : : * pick an entry from it instead of creating a new session. If connecting to
1677 : : * a host fails, then the created session is put to this pool for reuse.
1678 : : */
1679 : : std::queue<std::unique_ptr<i2p::sam::Session>> m_unused_i2p_sessions GUARDED_BY(m_unused_i2p_sessions_mutex);
1680 : :
1681 : : /**
1682 : : * Mutex protecting m_reconnections.
1683 : : */
1684 : : Mutex m_reconnections_mutex;
1685 : :
1686 : : /** Struct for entries in m_reconnections. */
1687 : : struct ReconnectionInfo
1688 : : {
1689 : : CAddress addr_connect;
1690 : : CountingSemaphoreGrant<> grant;
1691 : : std::string destination;
1692 : : ConnectionType conn_type;
1693 : : bool use_v2transport;
1694 : : };
1695 : :
1696 : : /**
1697 : : * List of reconnections we have to make.
1698 : : */
1699 : : std::list<ReconnectionInfo> m_reconnections GUARDED_BY(m_reconnections_mutex);
1700 : :
1701 : : /** Attempt reconnections, if m_reconnections non-empty. */
1702 : : void PerformReconnections() EXCLUSIVE_LOCKS_REQUIRED(!m_reconnections_mutex, !m_unused_i2p_sessions_mutex);
1703 : :
1704 : : /**
1705 : : * Cap on the size of `m_unused_i2p_sessions`, to ensure it does not
1706 : : * unexpectedly use too much memory.
1707 : : */
1708 : : static constexpr size_t MAX_UNUSED_I2P_SESSIONS_SIZE{10};
1709 : :
1710 : : /**
1711 : : * RAII helper to atomically create a copy of `m_nodes` and add a reference
1712 : : * to each of the nodes. The nodes are released when this object is destroyed.
1713 : : */
1714 : : class NodesSnapshot
1715 : : {
1716 : : public:
1717 : 193 : explicit NodesSnapshot(const CConnman& connman, bool shuffle)
1718 [ + - ]: 193 : {
1719 : 193 : {
1720 [ + - ]: 193 : LOCK(connman.m_nodes_mutex);
1721 [ + - ]: 193 : m_nodes_copy = connman.m_nodes;
1722 [ + + ]: 14871 : for (auto& node : m_nodes_copy) {
1723 : 14678 : node->AddRef();
1724 : : }
1725 : 0 : }
1726 [ - + ]: 193 : if (shuffle) {
1727 : 0 : std::shuffle(m_nodes_copy.begin(), m_nodes_copy.end(), FastRandomContext{});
1728 : : }
1729 : 193 : }
1730 : :
1731 : 193 : ~NodesSnapshot()
1732 : : {
1733 [ + + ]: 14871 : for (auto& node : m_nodes_copy) {
1734 : 14678 : node->Release();
1735 : : }
1736 : 193 : }
1737 : :
1738 : 193 : const std::vector<CNode*>& Nodes() const
1739 : : {
1740 [ + - ]: 193 : return m_nodes_copy;
1741 : : }
1742 : :
1743 : : private:
1744 : : std::vector<CNode*> m_nodes_copy;
1745 : : };
1746 : :
1747 : : const CChainParams& m_params;
1748 : :
1749 : : friend struct ConnmanTestMsg;
1750 : : };
1751 : :
1752 : : /** Defaults to `CaptureMessageToFile()`, but can be overridden by unit tests. */
1753 : : extern std::function<void(const CAddress& addr,
1754 : : const std::string& msg_type,
1755 : : std::span<const unsigned char> data,
1756 : : bool is_incoming)>
1757 : : CaptureMessage;
1758 : :
1759 : : #endif // BITCOIN_NET_H
|
