voltlane 0.1.0

Voltlane TCP multiplexer, turning N TCP streams intoa a single "firehose" stream.
Documentation
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
pub mod config;
pub mod connection;
pub mod ids;
pub mod master;
pub use voltlane_enc as enc;
pub use voltlane_net as net;

use std::{
    collections::HashMap,
    sync::{
        atomic::{AtomicBool, Ordering},
        Arc,
    },
};


use connection::{client::Client, stale::StaleConnectionManager};
use ids::IdGenerator;
use log::{error, info};
use net::TaggedPacket;
use tokio::{
    net::{TcpListener, TcpStream},
    sync::{mpsc, Mutex},
};

use crate::master::MasterDuplex;

#[derive(Clone)]
pub enum Msg {
    Stop,
    Data(TaggedPacket),
}

pub struct ConnServer<T> {
    config: config::Config,
    _marker: std::marker::PhantomData<T>,
}

impl<T> ConnServer<T>
where
    T: MasterDuplex + Send + Sync + 'static,
{
    pub async fn new(config: config::Config) -> Self {
        ConnServer {
            config,
            _marker: std::marker::PhantomData,
        }
    }

    pub async fn run(&mut self, mut master_duplex: T) -> anyhow::Result<()> {
        let acceptor = TcpListener::bind(&self.config.listener.address).await?;
        info!("Listening on {}", acceptor.local_addr()?);

        let keys = Arc::new(enc::easy::Keys::new());
        let dead = Arc::new(AtomicBool::new(false));

        let id_gen = Arc::new(Mutex::new(IdGenerator::new()));

        let (master_send_sender, master_send_receiver) =
            mpsc::channel::<Msg>(self.config.master.channel_capacity);
        let (master_recv_sender, master_recv_receiver) =
            mpsc::channel::<Msg>(self.config.master.channel_capacity);

        let (removed_sender, removed_receiver) = mpsc::channel(2);

        let clients = Arc::new(Mutex::new(HashMap::<u64, mpsc::Sender<Msg>>::new()));
        let stale_conn_manager = StaleConnectionManager::new(self.config.clone());

        tokio::spawn({
            let dead = dead.clone();
            async move {
                if let Err(e) = handle_socket_duplex_master(
                    &mut master_duplex,
                    master_send_receiver,
                    master_recv_sender,
                    removed_receiver,
                )
                .await
                {
                    error!("Error handling master duplex: {}", e);
                    error!("FATAL: Master server is down, exiting to fail hard");
                    dead.store(true, Ordering::Relaxed);
                }
            }
        });

        tokio::spawn(stale_conn_manager.clone().run_cleanup(removed_sender));

        tokio::spawn({
            let clients = clients.clone();
            let master_send_sender = master_send_sender.clone();
            let stale_conn_manager = stale_conn_manager.clone();
            let config = self.config.clone();
            async move {
                if let Err(e) = master_recv_main_loop(
                    master_recv_receiver,
                    master_send_sender,
                    clients,
                    stale_conn_manager,
                    config,
                )
                .await
                {
                    error!("Error handling master recv: {}", e);
                }
            }
        });

        while !dead.load(Ordering::Relaxed) {
            if let Err(err) = self
                .accept_client(
                    &acceptor,
                    master_send_sender.clone(),
                    keys.clone(),
                    clients.clone(),
                    stale_conn_manager.clone(),
                    &id_gen,
                )
                .await
            {
                error!("Failed accepting client: {}", err);
            }
        }
        info!("Stopping server");
        let clients = clients.lock().await;
        let mut tmp = clients.values();
        while let Some(client_sender) = tmp.next() {
            if let Err(e) = client_sender.send(Msg::Stop).await {
                error!("Error sending stop message to client: {}", e);
            }
        }
        if let Err(e) = master_send_sender.send(Msg::Stop).await {
            error!("Error sending stop message to master: {}", e);
        }
        // NOTE(lion): This is a bad situation, and most likely the master server is down.
        // We should never reach this point, but if we do, we should exit with an error, so that any sane
        // monitoring system can pick it up and restart the server, and hopefully the master-server too.
        info!("Assuming this server should never go down, shutting down is considered an error, but something forced this server to shut down (probably an error)");
        Err(anyhow::format_err!("Unexpected server shutdown"))
    }

    async fn accept_client(
        &self,
        acceptor: &TcpListener,
        master_send_sender: mpsc::Sender<Msg>,
        keys: Arc<enc::easy::Keys>,
        clients: Arc<Mutex<HashMap<u64, mpsc::Sender<Msg>>>>,
        stale_conn_manager: StaleConnectionManager,
        id_gen: &Arc<Mutex<IdGenerator>>,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
        let (client, _) = match tokio::time::timeout(
            std::time::Duration::from_secs(1),
            acceptor.accept(),
        )
        .await
        {
            Ok(res) => res?,
            Err(_) => return Ok(()),
        };

        let client_id = id_gen.lock().await.next_id();
        info!(
            "Accepted client connection id={}, endpoint={:?}",
            client_id,
            client.peer_addr()
        );
        // these are messages from master to client
        let (client_sender, client_receiver) =
            mpsc::channel::<Msg>(self.config.clients.channel_capacity);
        {
            clients
                .lock()
                .await
                .insert(client_id, client_sender.clone());
        }
        tokio::spawn({
            let master_send_sender = master_send_sender.clone();
            let keys = keys.clone();
            let clients = clients.clone();
            let id_gen = id_gen.clone();
            let client_sender = client_sender.clone();
            async move {
                handle_client(
                    client,
                    master_send_sender,
                    client_receiver,
                    keys,
                    clients,
                    stale_conn_manager,
                    client_id,
                    id_gen,
                    client_sender,
                )
                .await
            }
        });
        Ok(())
    }
}

async fn handle_socket_duplex_master(
    master: &mut impl MasterDuplex,
    mut send_receiver: mpsc::Receiver<Msg>,
    recv_sender: mpsc::Sender<Msg>,
    mut removed_receiver: mpsc::Receiver<Vec<u64>>,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    loop {
        tokio::select! {
            removed_client_ids = removed_receiver.recv() => {
                if let Some(client_ids) = removed_client_ids {
                    for client_id in client_ids {
                        let packet = TaggedPacket::Failure { client_id, error: "Client disconnected".to_string() };
                        if let Err(e) = master.send_packet(packet).await {
                            error!("Master: Error sending message for client {}: {}", client_id, e);
                            return Err(e.into());
                        }
                    }
                } else {
                    error!("Master: Error receiving removed client IDs");
                    return Err(anyhow::format_err!("Error receiving removed client IDs").into());
                }
            }
            packet = master.recv_packet() => {
                match packet {
                    Ok(packet) => {
                        if let TaggedPacket::Data { client_id, .. } = packet {
                            if let Err(e) = recv_sender.send(Msg::Data(packet.clone())).await {
                                panic!("Master: Error sending message for client {}: {}", client_id, e);
                            }
                        } else {
                            error!("Master: Unexpected packet type from client {}: {:?}", packet.client_id(), packet);
                            continue;
                        }
                    }
                    Err(e) => {
                        error!("Master: Error receiving packet for client: {}", e);
                        return Err(e.into());
                    }
                }
            }
            Some(msg) = send_receiver.recv() => {
                match msg {
                    Msg::Data(packet) => {
                        if let Err(e) = master.send_packet(packet.clone()).await {
                            panic!("Master: Error sending message for client {}: {}", packet.client_id(), e);
                        }
                    }
                    Msg::Stop => {
                        info!("Stopping master duplex");
                        break;
                    }
                }
            }
        }
    }
    Ok(())
}

pub enum Either<T, U> {
    Left(T),
    Right(U),
}

async fn master_recv_main_loop(
    mut master_recv_receiver: mpsc::Receiver<Msg>,
    master_send_sender: mpsc::Sender<Msg>,
    clients: Arc<Mutex<HashMap<u64, mpsc::Sender<Msg>>>>,
    stale_conn_manager: StaleConnectionManager,
    config: config::Config,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    // take messages from the master_recv_receiver and send them to each client
    loop {
        if let Some(msg) = master_recv_receiver.recv().await {
            match msg {
                Msg::Data(packet) => match packet {
                    TaggedPacket::Data { client_id, .. } => {
                        let client = {
                            let clients = clients.lock().await;
                            clients.get(&client_id).cloned()
                        };
                        match client {
                            Some(client_sender) => {
                                if let Err(e) = client_sender.send(Msg::Data(packet.clone())).await
                                {
                                    error!("Error sending message to client {}: {}", client_id, e);
                                }
                            }
                            None => {
                                // Client not found, check if it's a stale client
                                // in that case we want to enqueue the packet if that's configured.
                                // if not, we fail the client right here.
                                if config.clients.missed_packets_buffer_size > 0
                                    && stale_conn_manager.has_client(client_id).await
                                {
                                    if let Err(e) = stale_conn_manager
                                        .add_missed_packet(
                                            client_id,
                                            packet,
                                            config.clients.missed_packets_buffer_size,
                                        )
                                        .await
                                    {
                                        error!(
                                            "Error adding missed packet for client {}: {}, this fails the client",
                                            client_id, e
                                        );
                                        stale_conn_manager.remove_stale_client(client_id).await;
                                        let packet = TaggedPacket::Failure {
                                            client_id,
                                            error: "Client disconnected".to_string(),
                                        };
                                        if let Err(e) =
                                            master_send_sender.send(Msg::Data(packet)).await
                                        {
                                            error!(
                                                "Error sending failure message to master: {}",
                                                e
                                            );
                                        }
                                    }
                                } else {
                                    error!("Client {} not found, missed packet buffering not enabled, failing client", client_id);
                                    stale_conn_manager.remove_stale_client(client_id).await;
                                    let packet = TaggedPacket::Failure {
                                        client_id,
                                        error: "Client not found".to_string(),
                                    };
                                    if let Err(e) = master_send_sender.send(Msg::Data(packet)).await
                                    {
                                        error!("Error sending failure message to master: {}", e);
                                    }
                                }
                            }
                        }
                    }
                    _ => {
                        error!("Unexpected packet type from master: {:?}", packet);
                        continue;
                    }
                },
                Msg::Stop => {
                    info!("Stopping master recv");
                    break Ok(());
                }
            }
        }
    }
}

async fn handle_client(
    client: TcpStream,
    master_send_sender: mpsc::Sender<Msg>,
    client_receiver: mpsc::Receiver<Msg>,
    keys: Arc<enc::easy::Keys>,
    clients: Arc<Mutex<HashMap<u64, mpsc::Sender<Msg>>>>,
    stale_conn_manager: StaleConnectionManager,
    mut client_id: u64,
    id_gen: Arc<Mutex<IdGenerator>>,
    send_sender: mpsc::Sender<Msg>,
) {
    let mut client = Client::new(client, client_receiver, master_send_sender, client_id);
    let client_id_before = client_id;
    let encryption = match client
        .try_reconnect(&keys, client_id, &stale_conn_manager)
        .await
    {
        Ok(Either::Left((enc, new_id))) => {
            client_id = new_id;
            info!("Client {} connected", client_id);
            enc
        }
        Ok(Either::Right(stale_client)) => {
            info!("Client {} reconnected", client_id);
            for packet in stale_client.missed_packets {
                send_sender.send(Msg::Data(packet)).await.unwrap();
            }
            stale_client.encryption
        }
        Err(e) => {
            error!("Error handling client {}: {}", client_id, e);
            return;
        }
    };
    if client_id != client_id_before {
        info!(
            "Client ID changed from {} to {} due to reconnect",
            client_id_before, client_id
        );
        let mut clients = clients.lock().await;
        let client_sender = match clients.remove(&client_id_before) {
            Some(sender) => sender,
            None => {
                error!(
                    "Client ID {} not found in clients, but must exist",
                    client_id_before
                );
                return;
            }
        };
        clients.insert(client_id, client_sender);
        id_gen.lock().await.release_id(client_id_before);
    }

    if let Err(e) = client.run().await {
        error!(
            "Error handling client duplex for client {}: {}",
            client_id, e
        );
        stale_conn_manager
            .add_stale_client(client_id, encryption, std::time::Instant::now())
            .await;
        let mut clients = clients.lock().await;
        clients.remove(&client_id);
    }
}