ipfrs-transport 0.2.0

Transport protocols and zero-copy data exchange for IPFRS distributed system
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
//! TCP fallback transport for universal compatibility
//!
//! Provides a simple TCP-based transport as a fallback when QUIC is not available.
//! Features:
//! - Automatic reconnection on connection loss
//! - Connection pooling for multiple peers
//! - Frame-based message protocol
//! - Keep-alive support

use crate::transport::{
    Connection, ConnectionMetrics, Transport, TransportCapabilities, TransportError,
    TransportStats, TransportType,
};
use async_trait::async_trait;
use bytes::Bytes;
use parking_lot::RwLock;
use std::collections::HashMap;
use std::io;
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, TcpStream};
use tokio::sync::Mutex;
use tracing::{debug, info};

/// Frame header size (4 bytes for length)
const FRAME_HEADER_SIZE: usize = 4;

/// Maximum frame size (16 MB)
const MAX_FRAME_SIZE: usize = 16 * 1024 * 1024;

/// TCP transport configuration
#[derive(Debug, Clone)]
pub struct TcpConfig {
    /// TCP keep-alive interval
    pub keepalive_interval: Duration,
    /// Connection timeout
    pub connect_timeout: Duration,
    /// Read timeout
    pub read_timeout: Duration,
    /// Write timeout
    pub write_timeout: Duration,
    /// TCP_NODELAY (disable Nagle's algorithm)
    pub nodelay: bool,
    /// SO_RCVBUF size
    pub recv_buffer_size: Option<usize>,
    /// SO_SNDBUF size
    pub send_buffer_size: Option<usize>,
}

impl Default for TcpConfig {
    fn default() -> Self {
        Self {
            keepalive_interval: Duration::from_secs(30),
            connect_timeout: Duration::from_secs(10),
            read_timeout: Duration::from_secs(60),
            write_timeout: Duration::from_secs(30),
            nodelay: true,
            recv_buffer_size: Some(256 * 1024), // 256 KB
            send_buffer_size: Some(256 * 1024), // 256 KB
        }
    }
}

/// TCP connection implementation
pub struct TcpConnection {
    stream: Mutex<TcpStream>,
    remote_addr: SocketAddr,
    metrics: Arc<RwLock<ConnectionMetrics>>,
    created_at: Instant,
    alive: Arc<RwLock<bool>>,
    config: TcpConfig,
}

impl TcpConnection {
    /// Create a new TCP connection
    pub async fn new(stream: TcpStream, config: TcpConfig) -> Result<Self, TransportError> {
        let remote_addr = stream.peer_addr().map_err(|e| {
            TransportError::ConnectionFailed(format!("Failed to get peer address: {}", e))
        })?;

        // Configure socket options
        if config.nodelay {
            stream.set_nodelay(true).map_err(|e| {
                TransportError::ConnectionFailed(format!("Failed to set TCP_NODELAY: {}", e))
            })?;
        }

        debug!("TCP connection established to {}", remote_addr);

        Ok(Self {
            stream: Mutex::new(stream),
            remote_addr,
            metrics: Arc::new(RwLock::new(ConnectionMetrics::default())),
            created_at: Instant::now(),
            alive: Arc::new(RwLock::new(true)),
            config,
        })
    }

    /// Read a framed message from the stream
    async fn read_frame(&self) -> Result<Bytes, TransportError> {
        let mut stream = self.stream.lock().await;

        // Read frame header (4 bytes length prefix)
        let mut header = [0u8; FRAME_HEADER_SIZE];
        tokio::time::timeout(self.config.read_timeout, stream.read_exact(&mut header))
            .await
            .map_err(|_| TransportError::Timeout(self.config.read_timeout))?
            .map_err(|e| {
                if e.kind() == io::ErrorKind::UnexpectedEof {
                    *self.alive.write() = false;
                    TransportError::ConnectionClosed("Remote closed connection".to_string())
                } else {
                    TransportError::ReceiveFailed(format!("Failed to read frame header: {}", e))
                }
            })?;

        let frame_len = u32::from_be_bytes(header) as usize;

        if frame_len == 0 {
            return Err(TransportError::ProtocolError(
                "Received zero-length frame".to_string(),
            ));
        }

        if frame_len > MAX_FRAME_SIZE {
            return Err(TransportError::ProtocolError(format!(
                "Frame size {} exceeds maximum {}",
                frame_len, MAX_FRAME_SIZE
            )));
        }

        // Read frame payload
        let mut buffer = vec![0u8; frame_len];
        tokio::time::timeout(self.config.read_timeout, stream.read_exact(&mut buffer))
            .await
            .map_err(|_| TransportError::Timeout(self.config.read_timeout))?
            .map_err(|e| {
                if e.kind() == io::ErrorKind::UnexpectedEof {
                    *self.alive.write() = false;
                    TransportError::ConnectionClosed("Remote closed connection".to_string())
                } else {
                    TransportError::ReceiveFailed(format!("Failed to read frame payload: {}", e))
                }
            })?;

        // Update metrics
        {
            let mut metrics = self.metrics.write();
            metrics.bytes_received += (FRAME_HEADER_SIZE + frame_len) as u64;
        }

        Ok(Bytes::from(buffer))
    }

    /// Write a framed message to the stream
    async fn write_frame(&self, data: Bytes) -> Result<(), TransportError> {
        let data_len = data.len();

        if data_len > MAX_FRAME_SIZE {
            return Err(TransportError::ProtocolError(format!(
                "Message size {} exceeds maximum {}",
                data_len, MAX_FRAME_SIZE
            )));
        }

        let mut stream = self.stream.lock().await;

        // Write frame header
        let header = (data_len as u32).to_be_bytes();

        tokio::time::timeout(self.config.write_timeout, stream.write_all(&header))
            .await
            .map_err(|_| TransportError::Timeout(self.config.write_timeout))?
            .map_err(|e| {
                *self.alive.write() = false;
                TransportError::SendFailed(format!("Failed to write frame header: {}", e))
            })?;

        // Write frame payload
        tokio::time::timeout(self.config.write_timeout, stream.write_all(&data))
            .await
            .map_err(|_| TransportError::Timeout(self.config.write_timeout))?
            .map_err(|e| {
                *self.alive.write() = false;
                TransportError::SendFailed(format!("Failed to write frame payload: {}", e))
            })?;

        // Flush
        tokio::time::timeout(self.config.write_timeout, stream.flush())
            .await
            .map_err(|_| TransportError::Timeout(self.config.write_timeout))?
            .map_err(|e| {
                *self.alive.write() = false;
                TransportError::SendFailed(format!("Failed to flush: {}", e))
            })?;

        // Update metrics
        {
            let mut metrics = self.metrics.write();
            metrics.bytes_sent += (FRAME_HEADER_SIZE + data_len) as u64;
        }

        Ok(())
    }
}

#[async_trait]
impl Connection for TcpConnection {
    async fn send(&mut self, data: Bytes) -> Result<(), TransportError> {
        self.write_frame(data).await
    }

    async fn receive(&mut self) -> Result<Bytes, TransportError> {
        self.read_frame().await
    }

    async fn close(&mut self) -> Result<(), TransportError> {
        *self.alive.write() = false;
        let mut stream = self.stream.lock().await;
        stream
            .shutdown()
            .await
            .map_err(|e| TransportError::ConnectionClosed(format!("Shutdown failed: {}", e)))?;
        debug!("TCP connection to {} closed", self.remote_addr);
        Ok(())
    }

    fn is_alive(&self) -> bool {
        *self.alive.read()
    }

    fn metrics(&self) -> ConnectionMetrics {
        let mut metrics = self.metrics.read().clone();
        metrics.uptime = self.created_at.elapsed();
        metrics.active_streams = 1; // TCP has single stream
        metrics
    }

    fn remote_addr(&self) -> SocketAddr {
        self.remote_addr
    }

    fn transport_type(&self) -> TransportType {
        TransportType::Tcp
    }
}

/// TCP transport implementation
pub struct TcpTransport {
    config: TcpConfig,
    listener: Arc<Mutex<Option<TcpListener>>>,
    stats: Arc<RwLock<TransportStats>>,
    connections: Arc<RwLock<HashMap<SocketAddr, Instant>>>,
}

impl TcpTransport {
    /// Create a new TCP transport
    pub fn new(config: TcpConfig) -> Self {
        Self {
            config,
            listener: Arc::new(Mutex::new(None)),
            stats: Arc::new(RwLock::new(TransportStats::default())),
            connections: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Create with default configuration
    pub fn default_config() -> Self {
        Self::new(TcpConfig::default())
    }
}

#[async_trait]
impl Transport for TcpTransport {
    fn transport_type(&self) -> TransportType {
        TransportType::Tcp
    }

    fn capabilities(&self) -> TransportCapabilities {
        TransportCapabilities::tcp()
    }

    fn is_available(&self) -> bool {
        // TCP is always available
        true
    }

    async fn connect(&self, addr: SocketAddr) -> Result<Box<dyn Connection>, TransportError> {
        debug!("Connecting to {} via TCP", addr);

        let stream = tokio::time::timeout(self.config.connect_timeout, TcpStream::connect(addr))
            .await
            .map_err(|_| TransportError::Timeout(self.config.connect_timeout))?
            .map_err(|e| {
                self.stats.write().connections_failed += 1;
                TransportError::ConnectionFailed(format!("TCP connect failed: {}", e))
            })?;

        let connection = TcpConnection::new(stream, self.config.clone()).await?;

        // Update stats
        {
            let mut stats = self.stats.write();
            stats.connections_established += 1;
            stats.active_connections += 1;
        }

        // Track connection
        self.connections.write().insert(addr, Instant::now());

        info!("TCP connection established to {}", addr);

        Ok(Box::new(connection))
    }

    async fn listen(&self, addr: SocketAddr) -> Result<(), TransportError> {
        let listener = TcpListener::bind(addr).await.map_err(|e| {
            TransportError::ConnectionFailed(format!("Failed to bind TCP listener: {}", e))
        })?;

        info!("TCP transport listening on {}", addr);

        *self.listener.lock().await = Some(listener);
        Ok(())
    }

    async fn accept(&self) -> Result<Box<dyn Connection>, TransportError> {
        let listener = self.listener.lock().await;
        let listener = listener
            .as_ref()
            .ok_or_else(|| TransportError::ProtocolError("No listener bound".to_string()))?;

        let (stream, addr) = listener
            .accept()
            .await
            .map_err(|e| TransportError::ConnectionFailed(format!("Accept failed: {}", e)))?;

        debug!("Accepted TCP connection from {}", addr);

        let connection = TcpConnection::new(stream, self.config.clone()).await?;

        // Update stats
        {
            let mut stats = self.stats.write();
            stats.connections_established += 1;
            stats.active_connections += 1;
        }

        // Track connection
        self.connections.write().insert(addr, Instant::now());

        Ok(Box::new(connection))
    }

    fn stats(&self) -> TransportStats {
        self.stats.read().clone()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_tcp_config_default() {
        let config = TcpConfig::default();
        assert_eq!(config.keepalive_interval, Duration::from_secs(30));
        assert!(config.nodelay);
        assert_eq!(config.recv_buffer_size, Some(256 * 1024));
    }

    #[test]
    fn test_frame_constants() {
        assert_eq!(FRAME_HEADER_SIZE, 4);
        assert_eq!(MAX_FRAME_SIZE, 16 * 1024 * 1024);
    }

    #[tokio::test]
    async fn test_tcp_transport_creation() {
        let transport = TcpTransport::default_config();
        assert_eq!(transport.transport_type(), TransportType::Tcp);
        assert!(transport.is_available());

        let caps = transport.capabilities();
        assert!(!caps.multiplexing);
        assert!(!caps.zero_rtt);
    }

    #[tokio::test]
    async fn test_tcp_listen_and_connect() {
        let transport = TcpTransport::default_config();

        // Bind to localhost
        let addr: SocketAddr = "127.0.0.1:0"
            .parse()
            .expect("test: valid loopback address literal");
        transport
            .listen(addr)
            .await
            .expect("test: listener should bind to loopback");

        // Get the actual bound address
        let listener = transport.listener.lock().await;
        let bound_addr = listener
            .as_ref()
            .expect("test: listener should be present after listen()")
            .local_addr()
            .expect("test: OS should provide bound local address");
        drop(listener);

        // Spawn accept task
        let transport_clone = Arc::new(transport);
        let accept_handle = {
            let transport = transport_clone.clone();
            tokio::spawn(async move { transport.accept().await })
        };

        // Give accept time to start
        tokio::time::sleep(Duration::from_millis(10)).await;

        // Connect
        let mut client_conn = transport_clone
            .connect(bound_addr)
            .await
            .expect("test: connect transport");
        let mut server_conn = accept_handle
            .await
            .expect("test: await accept")
            .expect("test: accept connection");

        // Test send/receive
        let test_data = Bytes::from("Hello, TCP!");
        client_conn
            .send(test_data.clone())
            .await
            .expect("test: send data");

        let received = server_conn.receive().await.expect("test: receive data");
        assert_eq!(received, test_data);

        // Check metrics
        let client_metrics = client_conn.metrics();
        assert!(client_metrics.bytes_sent > 0);

        let server_metrics = server_conn.metrics();
        assert!(server_metrics.bytes_received > 0);

        // Close connections
        client_conn.close().await.expect("test: close connection");
        server_conn.close().await.expect("test: close connection");
    }
}