1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
use parking_lot::{RwLock, RwLockReadGuard, RwLockWriteGuard};
use fxhash::FxHashMap;
use std::{net::SocketAddr, time::Instant};
/// Contains statistics related to node's connections.
#[derive(Default)]
pub struct KnownPeers(RwLock<FxHashMap<SocketAddr, PeerStats>>);
impl KnownPeers {
/// Adds an address to the list of known peers.
pub fn add(&self, addr: SocketAddr) {
self.write().entry(addr).or_default().new_connection();
}
/// Removes an address to the list of known peers.
pub fn remove(&self, addr: SocketAddr) -> Option<PeerStats> {
self.write().remove(&addr)
}
/// Registers a connection to the given address, adding a peer if it hasn't been known.
pub fn register_connection(&self, addr: SocketAddr) {
self.write().entry(addr).or_default().new_connection();
}
/// Updates the "last seen" timestamp of the given address, adding a peer if it hasn't been known.
pub fn update_last_seen(&self, addr: SocketAddr) {
self.write().entry(addr).or_default().update_last_seen();
}
/// Registers a submission of a message to the given address, adding a peer if it hasn't been known.
pub fn register_sent_message(&self, to: SocketAddr, len: usize) {
self.write().entry(to).or_default().sent_message(len);
}
/// Registers a receipt of a message to the given address, adding a peer if it hasn't been known.
pub fn register_received_message(&self, from: SocketAddr, len: usize) {
self.write().entry(from).or_default().received_message(len);
}
/// Registers a failure associated with the given address, adding a peer if it hasn't been known.
pub fn register_failure(&self, addr: SocketAddr) {
self.write().entry(addr).or_default().register_failure();
}
/// Acquires a read lock over the collection of known peers.
pub fn read(&self) -> RwLockReadGuard<'_, FxHashMap<SocketAddr, PeerStats>> {
self.0.read()
}
/// Acquires a write lock over the collection of known peers.
pub fn write(&self) -> RwLockWriteGuard<'_, FxHashMap<SocketAddr, PeerStats>> {
self.0.write()
}
}
/// Contains statistics related to a single connection.
#[derive(Debug, Clone)]
pub struct PeerStats {
/// The number of times the connection has been established.
pub times_connected: usize,
/// The timestamp of the first connection.
pub first_seen: Instant,
/// The timestamp of the current connection.
pub last_connected: Instant,
/// The timestamp of the connection's last activity.
pub last_seen: Instant,
/// The number of messages sent to the connection.
pub msgs_sent: usize,
/// The number of messages received from the connection.
pub msgs_received: usize,
/// The number of bytes sent to the connection.
pub bytes_sent: u64,
/// The number of bytes received from the connection.
pub bytes_received: u64,
/// The number of failures related to the connection.
pub failures: u8,
}
impl Default for PeerStats {
fn default() -> Self {
let now = Instant::now();
Self {
times_connected: 1,
first_seen: now,
last_connected: now,
last_seen: now,
msgs_sent: 0,
msgs_received: 0,
bytes_sent: 0,
bytes_received: 0,
failures: 0,
}
}
}
impl PeerStats {
pub(crate) fn update_last_seen(&mut self) {
// last_seen is not updated automatically, as many messages can be read
// from the stream at once, and each one would cause a costly system call;
// since it is a costly operation, it is opt-in; it can be included in
// one of the methods provided by the Messaging protocol
self.last_seen = Instant::now();
}
pub(crate) fn new_connection(&mut self) {
self.last_connected = Instant::now();
self.times_connected += 1;
}
pub(crate) fn sent_message(&mut self, msg_len: usize) {
self.msgs_sent += 1;
self.bytes_sent += msg_len as u64;
}
pub(crate) fn received_message(&mut self, msg_len: usize) {
self.msgs_received += 1;
self.bytes_received += msg_len as u64;
}
pub(crate) fn register_failure(&mut self) {
self.failures += 1;
}
}