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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
use crate::peer_store::PeerStore;
use crate::{
errors::{Error, PeerError},
extract_peer_id, Peer, PeerId, SessionType,
};
use ckb_logger::debug;
use p2p::{multiaddr::Multiaddr, SessionId};
use rand::seq::SliceRandom;
use rand::thread_rng;
use std::collections::{HashMap, HashSet};
pub(crate) const EVICTION_PROTECT_PEERS: usize = 8;
pub struct PeerRegistry {
peers: HashMap<SessionId, Peer>,
max_inbound: u32,
max_outbound: u32,
whitelist_only: bool,
whitelist_peers: HashSet<PeerId>,
feeler_peers: HashSet<PeerId>,
}
#[derive(Clone, Copy, Debug)]
pub struct ConnectionStatus {
pub total: u32,
pub non_whitelist_inbound: u32,
pub non_whitelist_outbound: u32,
pub max_inbound: u32,
pub max_outbound: u32,
}
fn sort_then_drop<T, F>(list: &mut Vec<T>, n: usize, compare: F)
where
F: FnMut(&T, &T) -> std::cmp::Ordering,
{
list.sort_by(compare);
if list.len() > n {
list.truncate(list.len() - n);
}
}
impl PeerRegistry {
pub fn new(
max_inbound: u32,
max_outbound: u32,
whitelist_only: bool,
whitelist_peers: Vec<Multiaddr>,
) -> Self {
PeerRegistry {
peers: HashMap::with_capacity_and_hasher(20, Default::default()),
whitelist_peers: whitelist_peers.iter().filter_map(extract_peer_id).collect(),
feeler_peers: HashSet::default(),
max_inbound,
max_outbound,
whitelist_only,
}
}
pub(crate) fn accept_peer(
&mut self,
remote_addr: Multiaddr,
session_id: SessionId,
session_type: SessionType,
peer_store: &mut PeerStore,
) -> Result<Option<Peer>, Error> {
if self.peers.contains_key(&session_id) {
return Err(PeerError::SessionExists(session_id).into());
}
let peer_id = extract_peer_id(&remote_addr).expect("opened session should have peer id");
if self.get_key_by_peer_id(&peer_id).is_some() {
return Err(PeerError::PeerIdExists(peer_id).into());
}
let is_whitelist = self.whitelist_peers.contains(&peer_id);
let mut evicted_peer: Option<Peer> = None;
if !is_whitelist {
if self.whitelist_only {
return Err(PeerError::NonReserved.into());
}
if peer_store.is_addr_banned(&remote_addr) {
return Err(PeerError::Banned.into());
}
let connection_status = self.connection_status();
if session_type.is_inbound() {
if connection_status.non_whitelist_inbound >= self.max_inbound {
if let Some(evicted_session) = self.try_evict_inbound_peer(peer_store) {
evicted_peer = self.remove_peer(evicted_session);
} else {
return Err(PeerError::ReachMaxInboundLimit.into());
}
}
} else if connection_status.non_whitelist_outbound >= self.max_outbound {
return Err(PeerError::ReachMaxOutboundLimit.into());
}
}
peer_store.add_connected_peer(remote_addr.clone(), session_type)?;
let peer = Peer::new(session_id, session_type, remote_addr, is_whitelist);
self.peers.insert(session_id, peer);
Ok(evicted_peer)
}
fn try_evict_inbound_peer(&self, _peer_store: &PeerStore) -> Option<SessionId> {
let mut candidate_peers = {
self.peers
.values()
.filter(|peer| peer.is_inbound() && !peer.is_whitelist)
.collect::<Vec<_>>()
};
sort_then_drop(
&mut candidate_peers,
EVICTION_PROTECT_PEERS,
|peer1, peer2| {
let peer1_ping = peer1
.ping_rtt
.map(|p| p.as_secs())
.unwrap_or_else(|| std::u64::MAX);
let peer2_ping = peer2
.ping_rtt
.map(|p| p.as_secs())
.unwrap_or_else(|| std::u64::MAX);
peer2_ping.cmp(&peer1_ping)
},
);
sort_then_drop(
&mut candidate_peers,
EVICTION_PROTECT_PEERS,
|peer1, peer2| {
let peer1_last_message = peer1
.last_ping_protocol_message_received_at
.map(|t| t.elapsed().as_secs())
.unwrap_or_else(|| std::u64::MAX);
let peer2_last_message = peer2
.last_ping_protocol_message_received_at
.map(|t| t.elapsed().as_secs())
.unwrap_or_else(|| std::u64::MAX);
peer2_last_message.cmp(&peer1_last_message)
},
);
let protect_peers = candidate_peers.len() >> 1;
sort_then_drop(&mut candidate_peers, protect_peers, |peer1, peer2| {
peer2.connected_time.cmp(&peer1.connected_time)
});
let evict_group = candidate_peers
.into_iter()
.fold(HashMap::new(), |mut groups, peer| {
groups
.entry(peer.network_group())
.or_insert_with(Vec::new)
.push(peer);
groups
})
.values()
.max_by_key(|group| group.len())
.cloned()
.unwrap_or_else(Vec::new);
let mut rng = thread_rng();
evict_group.choose(&mut rng).map(|peer| {
debug!("evict inbound peer {:?}", peer.connected_addr);
peer.session_id
})
}
pub fn add_feeler(&mut self, addr: &Multiaddr) {
if let Some(peer_id) = extract_peer_id(addr) {
self.feeler_peers.insert(peer_id);
}
}
pub fn remove_feeler(&mut self, addr: &Multiaddr) {
if let Some(peer_id) = extract_peer_id(addr) {
self.feeler_peers.remove(&peer_id);
}
}
pub fn is_feeler(&self, addr: &Multiaddr) -> bool {
extract_peer_id(addr)
.map(|peer_id| self.feeler_peers.contains(&peer_id))
.unwrap_or_default()
}
pub fn get_peer(&self, session_id: SessionId) -> Option<&Peer> {
self.peers.get(&session_id)
}
pub fn get_peer_mut(&mut self, session_id: SessionId) -> Option<&mut Peer> {
self.peers.get_mut(&session_id)
}
pub(crate) fn remove_peer(&mut self, session_id: SessionId) -> Option<Peer> {
self.peers.remove(&session_id)
}
pub fn get_key_by_peer_id(&self, peer_id: &PeerId) -> Option<SessionId> {
self.peers.iter().find_map(|(session_id, peer)| {
extract_peer_id(&peer.connected_addr).and_then(|pid| {
if &pid == peer_id {
Some(*session_id)
} else {
None
}
})
})
}
pub fn peers(&self) -> &HashMap<SessionId, Peer> {
&self.peers
}
pub fn connected_peers(&self) -> Vec<SessionId> {
self.peers.keys().cloned().collect()
}
pub(crate) fn connection_status(&self) -> ConnectionStatus {
let total = self.peers.len() as u32;
let mut non_whitelist_inbound: u32 = 0;
let mut non_whitelist_outbound: u32 = 0;
for peer in self.peers.values().filter(|peer| !peer.is_whitelist) {
if peer.is_outbound() {
non_whitelist_outbound += 1;
} else {
non_whitelist_inbound += 1;
}
}
ConnectionStatus {
total,
non_whitelist_inbound,
non_whitelist_outbound,
max_inbound: self.max_inbound,
max_outbound: self.max_outbound,
}
}
}