tcp_ip 0.1.10

User-space TCP/IP stack
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
use std::io;
use std::io::Error;
use std::ops::Add;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;

use bytes::{Buf, BytesMut};
use pnet_packet::ip::IpNextHeaderProtocols;
use tokio::sync::mpsc::error::TrySendError;
use tokio::sync::mpsc::{Receiver, Sender};
use tokio::sync::Notify;
use tokio::time::Instant;

use crate::ip_stack::{BindAddr, IpStack, NetworkTuple, TransportPacket};
use crate::tcp::tcb::Tcb;

#[derive(Debug)]
pub struct TcpStreamTask {
    _bind_addr: Option<BindAddr>,
    quick_end: bool,
    tcb: Tcb,
    ip_stack: IpStack,
    application_layer_receiver: Receiver<BytesMut>,
    last_buffer: Option<BytesMut>,
    packet_receiver: Receiver<TransportPacket>,
    application_layer_sender: Option<Sender<BytesMut>>,
    write_half_closed: bool,
    retransmission: bool,
    read_notify: ReadNotify,
}

#[derive(Clone, Default, Debug)]
pub struct ReadNotify {
    readable: Arc<AtomicBool>,
    notify: Arc<Notify>,
}

impl ReadNotify {
    pub fn notify(&self) {
        if self.readable.load(Ordering::Acquire) {
            self.notify.notify_one();
        }
    }
    pub fn close(&self) {
        self.notify.notify_one();
    }
    async fn notified(&self) {
        self.notify.notified().await
    }
    fn set_state(&self, readable: bool) {
        self.readable.store(readable, Ordering::Release);
    }
}

impl Drop for TcpStreamTask {
    fn drop(&mut self) {
        let peer_addr = self.tcb.peer_addr();
        let local_addr = self.tcb.local_addr();
        let network_tuple = NetworkTuple::new(peer_addr, local_addr, IpNextHeaderProtocols::Tcp);
        self.ip_stack.remove_tcp_socket(&network_tuple);
    }
}

impl TcpStreamTask {
    pub fn new(
        _bind_addr: Option<BindAddr>,
        tcb: Tcb,
        ip_stack: IpStack,
        application_layer_sender: Sender<BytesMut>,
        application_layer_receiver: Receiver<BytesMut>,
        packet_receiver: Receiver<TransportPacket>,
    ) -> Self {
        Self {
            _bind_addr,
            quick_end: ip_stack.config.tcp_config.quick_end,
            tcb,
            ip_stack,
            application_layer_receiver,
            last_buffer: None,
            packet_receiver,
            application_layer_sender: Some(application_layer_sender),
            write_half_closed: false,
            retransmission: false,
            read_notify: Default::default(),
        }
    }
    pub fn read_notify(&self) -> ReadNotify {
        self.read_notify.clone()
    }
}

impl TcpStreamTask {
    pub async fn run(&mut self) -> io::Result<()> {
        let result = self.run0().await;
        self.push_application_layer();
        result
    }
    pub async fn run0(&mut self) -> io::Result<()> {
        loop {
            if self.tcb.is_close() {
                return Ok(());
            }
            if self.quick_end && self.read_half_closed() && self.write_half_closed {
                return Ok(());
            }
            if !self.write_half_closed && !self.retransmission {
                self.flush().await?;
            }
            let data = self.recv_data().await;

            match data {
                TaskRecvData::In(mut buf) => {
                    let mut count = 0;
                    loop {
                        if let Some(reply_packet) = self.tcb.push_packet(buf) {
                            self.send_packet(reply_packet).await?;
                        }

                        if self.tcb.is_close() {
                            return Ok(());
                        }
                        if !self.tcb.readable_state() {
                            break;
                        }
                        count += 1;
                        if count >= 10 {
                            break;
                        }
                        if let Some(v) = self.try_recv_in() {
                            buf = v
                        } else {
                            break;
                        }
                    }
                    self.push_application_layer();
                    // if self.tcb.readable_state() && self.application_layer_sender.is_some() && self.tcb.readable() && self.tcb.recv_busy() {
                    //     // The window is too small and requires blocking to wait; otherwise, it will lead to severe packet loss
                    //     self.read_notify.notified().await;
                    //     self.push_application_layer();
                    // }
                }
                TaskRecvData::Out(buf) => {
                    self.write(buf).await?;
                }
                TaskRecvData::InClose => return Err(Error::new(io::ErrorKind::Other, "NetworkDown")),
                TaskRecvData::OutClose => {
                    assert!(self.last_buffer.is_none());
                    self.write_half_closed = true;
                    let packet = self.tcb.fin_packet();
                    self.send_packet(packet).await?;
                    self.tcb.sent_fin();
                }
                TaskRecvData::Timeout => {
                    self.tcb.timeout();
                    if self.tcb.is_close() {
                        return Ok(());
                    }
                    if self.tcb.cannot_write() {
                        let packet = self.tcb.fin_packet();
                        self.send_packet(packet).await?;
                    }
                    if self.read_half_closed() && self.write_half_closed {
                        return Ok(());
                    }
                }
                TaskRecvData::ReadNotify => {
                    self.push_application_layer();
                    self.try_send_ack().await?;
                }
            }
            self.retransmission = self.try_retransmission().await?;
            self.try_send_ack().await?;
            self.tcb.perform_post_ack_action();
            if !self.read_half_closed() && self.tcb.cannot_read() {
                self.close_read();
            }
        }
    }
    async fn send_packet(&mut self, transport_packet: TransportPacket) -> io::Result<()> {
        self.ip_stack.send_packet(transport_packet).await?;
        self.tcb.perform_post_ack_action();
        Ok(())
    }
    fn read_half_closed(&self) -> bool {
        if let Some(v) = self.application_layer_sender.as_ref() {
            v.is_closed()
        } else {
            true
        }
    }
    pub fn mss(&self) -> u16 {
        self.tcb.mss()
    }
    fn only_recv_in(&self) -> bool {
        self.retransmission || self.last_buffer.is_some() || self.write_half_closed || self.tcb.limit()
    }
    fn push_application_layer(&mut self) {
        if let Some(sender) = self.application_layer_sender.as_ref() {
            let mut read_half_closed = false;
            while self.tcb.readable() {
                match sender.try_reserve() {
                    Ok(sender) => {
                        if let Some(buffer) = self.tcb.read() {
                            sender.send(buffer);
                        }
                    }
                    Err(e) => match e {
                        TrySendError::Full(_) => break,
                        TrySendError::Closed(_) => {
                            read_half_closed = true;
                            break;
                        }
                    },
                }
                self.read_notify.set_state(self.tcb.readable());
            }
            if self.tcb.cannot_read() || read_half_closed {
                self.close_read();
            }
        } else {
            self.tcb.read_none();
        }
    }
    fn close_read(&mut self) {
        if let Some(sender) = self.application_layer_sender.take() {
            _ = sender.try_send(BytesMut::new());
        }
    }
    async fn write_slice0(tcb: &mut Tcb, ip_stack: &IpStack, mut buf: &[u8]) -> io::Result<usize> {
        let len = buf.len();
        while !buf.is_empty() {
            if let Some((packet, len)) = tcb.write(buf) {
                if len == 0 {
                    break;
                }
                ip_stack.send_packet(packet).await?;
                tcb.perform_post_ack_action();
                buf = &buf[len..];
            } else {
                break;
            }
        }
        Ok(len - buf.len())
    }
    async fn write_slice(&mut self, buf: &[u8]) -> io::Result<usize> {
        Self::write_slice0(&mut self.tcb, &self.ip_stack, buf).await
    }
    async fn write(&mut self, mut buf: BytesMut) -> io::Result<usize> {
        let len = self.write_slice(&buf).await?;
        if len != buf.len() {
            // Buffer is full
            buf.advance(len);
            self.last_buffer.replace(buf);
        }
        Ok(len)
    }
    async fn flush(&mut self) -> io::Result<()> {
        if let Some(buf) = self.last_buffer.as_mut() {
            let len = Self::write_slice0(&mut self.tcb, &self.ip_stack, buf).await?;
            if buf.len() == len {
                self.last_buffer.take();
            } else {
                buf.advance(len);
            }
        }
        Ok(())
    }

    async fn try_retransmission(&mut self) -> io::Result<bool> {
        if self.write_half_closed {
            return Ok(false);
        }
        if let Some(v) = self.tcb.retransmission() {
            self.send_packet(v).await?;
            return Ok(true);
        }
        if self.tcb.no_inflight_packet() {
            return Ok(false);
        }
        if self.tcb.need_retransmission() {
            if let Some(v) = self.tcb.retransmission() {
                self.send_packet(v).await?;
                return Ok(true);
            }
        }
        Ok(false)
    }
    async fn try_send_ack(&mut self) -> io::Result<()> {
        if self.tcb.need_ack() {
            let packet = self.tcb.ack_packet();
            self.ip_stack.send_packet(packet).await?;
        }
        Ok(())
    }

    async fn recv_data(&mut self) -> TaskRecvData {
        let deadline = if let Some(v) = self.tcb.time_wait() {
            Some(v.into())
        } else {
            self.tcb.write_timeout().map(|v| v.into())
        };

        if let Some(deadline) = deadline {
            if self.only_recv_in() {
                self.recv_in_timeout_at(deadline).await
            } else {
                self.recv_timeout_at(deadline).await
            }
        } else if self.write_half_closed {
            let timeout_at = Instant::now().add(self.ip_stack.config.tcp_config.time_wait_timeout);
            self.recv_in_timeout_at(timeout_at).await
        } else {
            self.recv().await
        }
    }
    async fn recv(&mut self) -> TaskRecvData {
        tokio::select! {
            rs=self.packet_receiver.recv()=>{
                rs.map(|v| TaskRecvData::In(v.buf)).unwrap_or(TaskRecvData::InClose)
            }
            rs=self.application_layer_receiver.recv()=>{
                rs.map(TaskRecvData::Out).unwrap_or(TaskRecvData::OutClose)
            }
            _=self.read_notify.notified()=>{
                TaskRecvData::ReadNotify
            }
        }
    }
    async fn recv_timeout_at(&mut self, deadline: Instant) -> TaskRecvData {
        tokio::select! {
            rs=self.packet_receiver.recv()=>{
                rs.map(|v| TaskRecvData::In(v.buf)).unwrap_or(TaskRecvData::InClose)
            }
            rs=self.application_layer_receiver.recv()=>{
                rs.map(TaskRecvData::Out).unwrap_or(TaskRecvData::OutClose)
            }
            _=tokio::time::sleep_until(deadline)=>{
                TaskRecvData::Timeout
            }
            _=self.read_notify.notified()=>{
                TaskRecvData::ReadNotify
            }
        }
    }

    async fn recv_in_timeout_at(&mut self, deadline: Instant) -> TaskRecvData {
        tokio::select! {
            rs=self.packet_receiver.recv()=>{
                rs.map(|v| TaskRecvData::In(v.buf)).unwrap_or(TaskRecvData::InClose)
            }
            _=tokio::time::sleep_until(deadline)=>{
                TaskRecvData::Timeout
            }
            _=self.read_notify.notified()=>{
                TaskRecvData::ReadNotify
            }
        }
    }
    async fn recv_in_timeout(&mut self, duration: Duration) -> TaskRecvData {
        self.recv_in_timeout_at(Instant::now().add(duration)).await
    }

    fn try_recv_in(&mut self) -> Option<BytesMut> {
        self.packet_receiver.try_recv().map(|v| v.buf).ok()
    }
}

impl TcpStreamTask {
    pub async fn connect(&mut self) -> io::Result<()> {
        let mut count = 0;
        let mut time = 50;
        while let Some(packet) = self.tcb.try_syn_sent() {
            count += 1;
            if count > 50 {
                break;
            }
            self.send_packet(packet).await?;
            time *= 2;
            return match self.recv_in_timeout(Duration::from_millis(time.min(3000))).await {
                TaskRecvData::In(buf) => {
                    if let Some(relay) = self.tcb.try_syn_sent_to_established(buf) {
                        self.send_packet(relay).await?;
                        Ok(())
                    } else {
                        Err(io::Error::from(io::ErrorKind::ConnectionRefused))
                    }
                }
                TaskRecvData::InClose => Err(io::Error::from(io::ErrorKind::ConnectionRefused)),
                TaskRecvData::Timeout => continue,
                _ => {
                    unreachable!()
                }
            };
        }
        Err(io::Error::from(io::ErrorKind::ConnectionRefused))
    }
}

enum TaskRecvData {
    In(BytesMut),
    Out(BytesMut),
    ReadNotify,
    InClose,
    OutClose,
    Timeout,
}