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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use crossbeam::channel::tick;
use crossbeam::select;
use ip_rfc::global;
use massa_channel::{receiver::MassaReceiver, sender::MassaSender};
use massa_consensus_exports::ConsensusController;
use massa_metrics::MassaMetrics;
use massa_models::stats::NetworkStats;
use massa_pool_exports::PoolController;
use massa_pos_exports::SelectorController;
use massa_protocol_exports::{PeerCategoryInfo, PeerId, ProtocolConfig, ProtocolError};
use massa_storage::Storage;
use massa_versioning::versioning::MipStore;
use parking_lot::RwLock;
use peernet::peer::PeerConnectionType;
use std::net::SocketAddr;
use std::sync::Arc;
use std::{collections::HashMap, net::IpAddr};
use std::{thread::JoinHandle, time::Duration};
use tracing::{debug, warn};

use crate::handlers::peer_handler::models::ConnectionMetadata;
use crate::{
    handlers::peer_handler::models::{InitialPeers, PeerState, SharedPeerDB},
    ip::to_canonical,
    worker::ProtocolChannels,
};
use crate::{handlers::peer_handler::PeerManagementHandler, messages::MessagesHandler};
use crate::{
    handlers::{
        block_handler::{cache::BlockCache, BlockHandler},
        endorsement_handler::{cache::EndorsementCache, EndorsementHandler},
        operation_handler::{cache::OperationCache, OperationHandler},
        peer_handler::models::PeerMessageTuple,
    },
    wrap_network::NetworkController,
};

// protocol-connectivity
const THREAD_NAME: &str = "p-connectivity";
static_assertions::const_assert!(THREAD_NAME.len() < 16);

#[derive(Clone)]
pub enum ConnectivityCommand {
    Stop,
    GetStats {
        #[allow(clippy::type_complexity)]
        responder: MassaSender<(
            NetworkStats,
            HashMap<PeerId, (SocketAddr, PeerConnectionType)>,
        )>,
    },
}

#[allow(clippy::too_many_arguments)]
pub(crate) fn start_connectivity_thread(
    peer_id: PeerId,
    selector_controller: Box<dyn SelectorController>,
    mut network_controller: Box<dyn NetworkController>,
    consensus_controller: Box<dyn ConsensusController>,
    pool_controller: Box<dyn PoolController>,
    channel_blocks: (
        MassaSender<PeerMessageTuple>,
        MassaReceiver<PeerMessageTuple>,
    ),
    channel_endorsements: (
        MassaSender<PeerMessageTuple>,
        MassaReceiver<PeerMessageTuple>,
    ),
    channel_operations: (
        MassaSender<PeerMessageTuple>,
        MassaReceiver<PeerMessageTuple>,
    ),
    channel_peers: (
        MassaSender<PeerMessageTuple>,
        MassaReceiver<PeerMessageTuple>,
    ),
    initial_peers: InitialPeers,
    peer_db: SharedPeerDB,
    storage: Storage,
    protocol_channels: ProtocolChannels,
    messages_handler: MessagesHandler,
    peer_categories: HashMap<String, (Vec<IpAddr>, PeerCategoryInfo)>,
    _default_category: PeerCategoryInfo,
    config: ProtocolConfig,
    mip_store: MipStore,
    massa_metrics: MassaMetrics,
) -> Result<(MassaSender<ConnectivityCommand>, JoinHandle<()>), ProtocolError> {
    let handle = std::thread::Builder::new()
    .name(THREAD_NAME.to_string())
    .spawn({
        let sender_endorsements_propagation_ext = protocol_channels.endorsement_handler_propagation.0.clone();
        let sender_blocks_retrieval_ext = protocol_channels.block_handler_retrieval.0.clone();
        let sender_blocks_propagation_ext = protocol_channels.block_handler_propagation.0.clone();
        let sender_operations_propagation_ext = protocol_channels.operation_handler_propagation.0.clone();
        move || {
            for (addr, transport) in &config.listeners {
                network_controller
                    .start_listener(*transport, *addr)
                    .unwrap_or_else(|_| panic!(
                        "Failed to start listener {:?} of transport {:?} in protocol",
                        addr, transport
                    ));
            }

            // Little hack to be sure that listeners are started before trying to connect to peers
            std::thread::sleep(Duration::from_millis(100));

            // Create cache outside of the op handler because it could be used by other handlers
            let total_in_slots = config.peers_categories.values().map(|v| v.max_in_connections).sum::<usize>() + config.default_category_info.max_in_connections + 1;
            let total_out_slots = config.peers_categories.values().map(| v| v.target_out_connections).sum::<usize>() + config.default_category_info.target_out_connections + 1;
            let operation_cache = Arc::new(RwLock::new(OperationCache::new(
                config.max_known_ops_size.try_into().unwrap(),
                config.max_node_known_ops_size.try_into().unwrap()
            )));
            let endorsement_cache = Arc::new(RwLock::new(EndorsementCache::new(
                config.max_known_endorsements_size.try_into().unwrap(),
                (total_in_slots + total_out_slots).try_into().unwrap()
            )));

            let block_cache = Arc::new(RwLock::new(BlockCache::new(
                config.max_known_blocks_size.try_into().unwrap(),
                config.max_node_known_blocks_size.try_into().unwrap(),
            )));

            // Start handlers
            let mut peer_management_handler = PeerManagementHandler::new(
                initial_peers,
                peer_id,
                peer_db.clone(),
                channel_peers,
                protocol_channels.peer_management_handler,
                messages_handler,
                network_controller.get_active_connections(),
                peer_categories.iter().map(|(key, value)|(key.clone(), (value.0.clone(), value.1.target_out_connections))).collect(),
                config.default_category_info.target_out_connections,
                &config,
                massa_metrics.clone(),
            );

            let mut operation_handler = OperationHandler::new(
                pool_controller.clone(),
                storage.clone_without_refs(),
                config.clone(),
                operation_cache.clone(),
                network_controller.get_active_connections(),
                channel_operations.1,
                protocol_channels.operation_handler_retrieval.0.clone(),
                protocol_channels.operation_handler_retrieval.1.clone(),
                sender_operations_propagation_ext.clone(),
                protocol_channels.operation_handler_propagation.1.clone(),
                peer_management_handler.sender.command_sender.clone(),
                massa_metrics.clone(),
            );
            let mut endorsement_handler = EndorsementHandler::new(
                pool_controller.clone(),
                selector_controller.clone(),
                endorsement_cache.clone(),
                storage.clone_without_refs(),
                config.clone(),
                network_controller.get_active_connections(),
                channel_endorsements.1,
                protocol_channels.endorsement_handler_retrieval.0,
                protocol_channels.endorsement_handler_retrieval.1,
                sender_endorsements_propagation_ext.clone(),
                protocol_channels.endorsement_handler_propagation.1.clone(),
                peer_management_handler.sender.command_sender.clone(),
                massa_metrics.clone(),
            );
            let mut block_handler = BlockHandler::new(
                network_controller.get_active_connections(),
                selector_controller,
                consensus_controller,
                pool_controller,
                channel_blocks.1,
                sender_blocks_retrieval_ext,
                protocol_channels.block_handler_retrieval.1.clone(),
                protocol_channels.block_handler_propagation.1.clone(),
                sender_blocks_propagation_ext,
                sender_operations_propagation_ext,
                sender_endorsements_propagation_ext,
                peer_management_handler.sender.command_sender.clone(),
                config.clone(),
                endorsement_cache,
                operation_cache,
                block_cache,
                storage.clone_without_refs(),
                mip_store,
                massa_metrics.clone(),
            );

            let tick_metrics = tick(massa_metrics.tick_delay);
            let tick_try_connect = tick(config.try_connection_timer.to_duration());
            let tick_unban_everyone = tick(config.unban_everyone_timer.to_duration());

            //Try to connect to peers
            loop {
                select! {
                    recv(protocol_channels.connectivity_thread.1) -> msg => {
                        // update channel metrics
                        protocol_channels.connectivity_thread.1.update_metrics();
                        match msg {
                            Ok(ConnectivityCommand::Stop) => {
                                debug!("Stopping protocol");
                                drop(network_controller);
                                debug!("Stopped network controller");
                                operation_handler.stop();
                                debug!("Stopped operation handler");
                                endorsement_handler.stop();
                                debug!("Stopped endorsement handler");
                                block_handler.stop();
                                debug!("Stopped block handler");
                                peer_management_handler.stop();
                                debug!("Stopped peer handler");
                                break;
                            },
                            Ok(ConnectivityCommand::GetStats { responder }) => {
                                let active_node_count = network_controller.get_active_connections().get_peer_ids_connected().len() as u64;
                                let in_connection_count = network_controller.get_active_connections().get_nb_in_connections() as u64;
                                let out_connection_count = network_controller.get_active_connections().get_nb_out_connections() as u64;
                                let (banned_peer_count, known_peer_count) = {
                                    let peer_db_read = peer_db.read();
                                    (peer_db_read.get_banned_peer_count(), peer_db_read.get_known_peer_count())
                                };
                                let stats = NetworkStats {
                                    active_node_count,
                                    in_connection_count,
                                    out_connection_count,
                                    banned_peer_count,
                                    known_peer_count,
                                };
                                let peers: HashMap<PeerId, (SocketAddr, PeerConnectionType)> = network_controller.get_active_connections().get_peers_connected().into_iter().map(|(peer_id, peer)| {
                                    (peer_id, (peer.0, peer.1))
                                }).collect();
                                responder.try_send((stats, peers)).unwrap_or_else(|_| warn!("Failed to send stats to responder"));
                            }
                            Err(_) => {
                                warn!("Channel to connectivity thread is closed. Stopping the protocol");
                                break;
                            }
                        }
                    },
                    recv(tick_metrics) -> _ => {
                        massa_metrics.set_peernet_total_bytes_received(network_controller.get_total_bytes_received());
                        massa_metrics.set_peernet_total_bytes_sent(network_controller.get_total_bytes_sent());
                        let active_conn = network_controller.get_active_connections();
                        massa_metrics.set_active_connections(active_conn.get_nb_in_connections(), active_conn.get_nb_out_connections());
                        let peers_map = active_conn.get_peers_connections_bandwidth();
                        massa_metrics.update_peers_tx_rx(peers_map);
                        let peer_db_read = peer_db.read();
                        massa_metrics.set_known_peers(peer_db_read.get_known_peer_count() as usize);
                        massa_metrics.set_banned_peers(peer_db_read.get_banned_peer_count() as usize);
                    },
                    recv(tick_try_connect) -> _ => {
                        let active_conn = network_controller.get_active_connections();
                        let peers_connected = active_conn.get_peers_connected();
                        let peers_connection_queue = active_conn.get_peer_ids_out_connection_queue();

                        let mut connection_slots = HashMap::new();
                        connection_slots.insert("default", config.default_category_info.target_out_connections);
                        for (category, infos) in peer_categories.iter() {
                            connection_slots.insert(category, infos.1.target_out_connections);
                        }

                        // Get all the addresses we can connect to, without any filter or prioritization done yet
                        let mut addresses_can_connect  = Vec::new();
                        {
                            let peer_db_read = peer_db.read();
                            for (peer_id, peer_info) in peer_db_read.get_peers() {

                                // If peer already connected, decrement the slots for the given category, or default category if none
                                if let Some(peer) = peers_connected.get(peer_id) {
                                    if peer.1 == PeerConnectionType::OUT {
                                        if let Some(ref peer_category) = &peer.2 {
                                            if let Some(slots) = connection_slots.get_mut(peer_category.as_str()) {
                                                *slots = slots.saturating_sub(1);
                                            } else {
                                                tracing::warn!("Category of connected peer {peer_category} not known in configuration");
                                            }
                                        } else {
                                            let slots = connection_slots.get_mut("default").unwrap();
                                            *slots = slots.saturating_sub(1);
                                        }
                                    }
                                    continue;
                                }

                                if peer_info.state == PeerState::Trusted {
                                    if let Some(ref last_announce) = peer_info.last_announce {
                                        if last_announce.listeners.is_empty() {
                                            continue;
                                        }

                                        if let Some((addr, _)) = last_announce.listeners.iter().next() {
                                            let canonical_ip = to_canonical(addr.ip());
                                            let mut allowed_local_ips = false;
                                            // Check if the peer is in a category and we didn't reached out target yet
                                            let mut category_found = None;
                                            for (name, (ips, cat)) in &peer_categories {
                                                if ips.contains(&canonical_ip) {
                                                    category_found = Some(name);
                                                    allowed_local_ips = cat.allow_local_peers;
                                                }
                                            }

                                            if peers_connection_queue.contains(addr) {
                                                if let Some(peer_category) = category_found {
                                                    if let Some(slots) = connection_slots.get_mut(peer_category.as_str()) {
                                                        *slots = slots.saturating_sub(1);
                                                    }
                                                } else if let Some(v) = connection_slots.get_mut("default") {
                                                    *v = v.saturating_sub(1);
                                                }
                                                continue;
                                            }

                                            let connection_metadata = peer_db_read.get_connection_metadata_or_default(addr);

                                            // check if the peer last connect attempt has not been too recent
                                            if let ConnectionMetadata { last_try_connect: Some(lt), .. } = connection_metadata {
                                                let last_try_connect = lt.estimate_instant().expect("Time went backward");
                                                if last_try_connect.elapsed() < config.try_connection_timer_same_peer.to_duration() {
                                                    continue;
                                                }
                                            }

                                            if config.listeners.iter().any(|(local_addr, _transport)| addr == local_addr) {
                                                continue;
                                            }

                                            if !global(&canonical_ip) && !allowed_local_ips {
                                                continue;
                                            }

                                            addresses_can_connect.push((*addr, connection_metadata, category_found));
                                        } else {
                                            tracing::warn!("No listeners for the peer {peer_id}");
                                        }
                                    }
                                }
                            }
                        }

                        // Sort addresses using the metadata
                        addresses_can_connect.sort_by(|a, b| a.1.cmp(&b.1));

                        // Connect to the given addresses, trying to fill all the slots available
                        let mut addresses_connected = vec![];
                        for (addr, _, category) in addresses_can_connect.iter() {
                            if addresses_connected.contains(addr) {
                                continue;
                            }

                            // Connect to the peer
                            match category {
                                // In case has a special category
                                Some(cat) => {
                                    for (name, slots) in connection_slots.iter_mut() {
                                        if name == *cat && *slots > 0 {
                                            // In case the connection succeeds, we take a place in a slot
                                            if try_connect_peer(*addr, &mut network_controller, &peer_db, &config).is_ok() {
                                                *slots = slots.saturating_sub(1);
                                                addresses_connected.push(*addr);
                                            }
                                        }
                                    }
                                }

                                // Default category
                                None if connection_slots["default"] > 0 => {
                                    // In case the connection succeeds, we take a place in a slot
                                    if try_connect_peer(*addr, &mut network_controller, &peer_db, &config).is_err() {
                                        if let Some(v) = connection_slots.get_mut("default") {
                                            *v = v.saturating_sub(1);
                                        }
                                        addresses_connected.push(*addr);
                                    }
                                }
                                None => continue,
                            }

                            // IF all slots are filled, stop
                            if connection_slots.values().sum::<usize>() == 0 {
                                break;
                            }
                        }
                    }
                    recv(tick_unban_everyone) -> _ => {
                        debug!("Periodic unban of every peer");
                        let mut peer_db_write = peer_db.write();
                        for (peer_id, peer_status) in peer_db_write.get_peers().clone() {
                            if peer_status.state == PeerState::Banned {
                                peer_db_write.unban_peer(&peer_id);
                            }
                        }
                    }
                }
            }
        }
    }).expect("OS failed to start connectivity thread");

    // Start controller
    Ok((protocol_channels.connectivity_thread.0, handle))
}

// Attempt to connect to peer
fn try_connect_peer(
    addr: SocketAddr,
    network_controller: &mut Box<dyn NetworkController>,
    peer_db: &SharedPeerDB,
    config: &ProtocolConfig,
) -> Result<(), ProtocolError> {
    debug!("Trying to connect to addr {}", addr);

    let conn_res = network_controller.try_connect(addr, config.timeout_connection.to_duration());
    {
        let mut peer_db_write = peer_db.write();
        peer_db_write.set_try_connect_success_or_insert(&addr);
        if let Err(ref err) = conn_res {
            debug!("Failed to connect to peer {:?}: {:?}", addr, err);
            peer_db_write.set_try_connect_failure_or_insert(&addr);
        }
    }
    conn_res
}