ap_kcp 0.1.1

AP-KCP Protocol Library
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
use std::{
    collections::HashMap,
    collections::VecDeque,
    pin::Pin,
    sync::Arc,
    task::{Context, Poll},
    time::Duration,
};

use bytes::{Buf, Bytes};
use futures::{ready, AsyncRead, AsyncWrite, Future};
use smol::{
    channel::{bounded, Receiver, Sender},
    future::FutureExt,
    lock::{Mutex, MutexGuardArc},
    Task, Timer,
};

use crate::{
    core::{KcpConfig, KcpCore, KcpIo},
    error::{KcpError, KcpResult},
    segment::{KcpSegment, CMD_PING, CMD_PUSH, HEADER_SIZE},
};

type LockCoreFuture = Pin<Box<dyn Future<Output = MutexGuardArc<KcpCore>> + Send>>;

pub struct KcpStream {
    core: Arc<Mutex<KcpCore>>,
    read_buffer: Option<VecDeque<Bytes>>,
    recv_lock_future: Option<LockCoreFuture>,
    send_lock_future: Option<LockCoreFuture>,
    flush_lock_future: Option<LockCoreFuture>,
    close_lock_future: Option<LockCoreFuture>,
}

impl Drop for KcpStream {
    fn drop(&mut self) {
        smol::block_on(async {
            if let Err(e) = self.core.lock().await.try_close() {
                log::trace!("try_close failed {}", e);
            }
        });
        log::trace!("kcp stream dropped");
    }
}

impl KcpStream {
    #[inline]
    fn lock_core(
        cx: &mut Context<'_>,
        core: Arc<Mutex<KcpCore>>,
        future_storage: &mut Option<Pin<Box<dyn Future<Output = MutexGuardArc<KcpCore>> + Send>>>,
    ) -> Poll<MutexGuardArc<KcpCore>> {
        if future_storage.is_none() {
            if let Some(core) = core.try_lock_arc() {
                return Poll::Ready(core);
            }
            let fut = {
                let core = core.clone();
                async move { core.lock_arc().await }
            }
            .boxed();
            *future_storage = Some(fut);
        }
        let core = ready!(future_storage.as_mut().unwrap().poll(cx));
        *future_storage = None;
        Poll::Ready(core)
    }
}

impl AsyncRead for KcpStream {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut [u8],
    ) -> Poll<std::io::Result<usize>> {
        loop {
            if self.read_buffer.is_some() {
                if self.read_buffer.as_mut().unwrap().is_empty() {
                    self.read_buffer = None;
                } else {
                    let queue = self.read_buffer.as_mut().unwrap();
                    let payload = queue.front_mut().unwrap();
                    if payload.remaining() > buf.len() {
                        let buf_len = buf.len();
                        buf.copy_from_slice(&payload[..buf_len]);
                        payload.advance(buf_len);
                        return Poll::Ready(Ok(buf_len));
                    }
                    let len = payload.remaining();
                    payload.copy_to_slice(&mut buf[..len]);
                    queue.pop_front();
                    return Poll::Ready(Ok(len));
                }
            }
            let mut core = ready!(Self::lock_core(
                cx,
                self.core.clone(),
                &mut self.recv_lock_future
            ));
            let payload = ready!(core.poll_recv(cx))?;
            self.read_buffer = Some(payload);
        }
    }
}

impl AsyncWrite for KcpStream {
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<std::io::Result<usize>> {
        if buf.len() == 0 {
            // Never send an empty packet
            return Poll::Ready(Ok(0));
        }
        let mut core = ready!(Self::lock_core(
            cx,
            self.core.clone(),
            &mut self.send_lock_future,
        ));
        ready!(core.poll_send(cx, buf))?;
        Poll::Ready(Ok(buf.len()))
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<std::io::Result<()>> {
        let mut core = ready!(Self::lock_core(
            cx,
            self.core.clone(),
            &mut self.flush_lock_future,
        ));
        ready!(core.poll_flush(cx))?;
        Poll::Ready(Ok(()))
    }

    fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<std::io::Result<()>> {
        let mut core = ready!(Self::lock_core(
            cx,
            self.core.clone(),
            &mut self.close_lock_future,
        ));
        ready!(core.poll_close(cx))?;
        Poll::Ready(Ok(()))
    }
}

struct KcpSession {
    core: Arc<Mutex<KcpCore>>,
    _update_task: Task<KcpResult<()>>,
}

pub struct KcpHandle<T> {
    sessions: Arc<Mutex<HashMap<u16, KcpSession>>>,
    config: Arc<KcpConfig>,
    accept_rx: Receiver<KcpStream>,
    dead_tx: Sender<u16>,
    io: Arc<T>,
    _feed_packet_task: Task<KcpResult<()>>,
    _clean_task: Task<KcpResult<()>>,
}

impl<T> Drop for KcpHandle<T> {
    fn drop(&mut self) {
        smol::block_on(async move {
            self.accept_rx.close();
            let sessions = self.sessions.lock().await;
            for (_, session) in sessions.iter() {
                let _ = session.core.lock().await.force_close();
            }
        });
        log::trace!("kcp handle dropped");
    }
}

impl<IO: KcpIo + Send + Sync + 'static> KcpHandle<IO> {
    pub async fn get_stream_count(&self) -> usize {
        self.sessions.lock().await.len()
    }

    async fn find_new_stream_id(&self) -> KcpResult<u16> {
        let sessions = self.sessions.lock().await;
        if sessions.len() == 0xffff {
            return Err(KcpError::TooManyStreams);
        }
        let stream_id = rand::random();
        if !sessions.contains_key(&stream_id) {
            return Ok(stream_id);
        }
        for i in 0..0xffffu16 {
            if !sessions.contains_key(&i) {
                return Ok(i);
            }
        }
        Err(KcpError::TooManyStreams)
    }

    pub async fn connect(&self) -> KcpResult<KcpStream> {
        let stream_id = self.find_new_stream_id().await?;
        let (tx, rx) = bounded(1);
        let core = Arc::new(Mutex::new(KcpCore::new(
            stream_id,
            self.config.clone(),
            tx,
        )?));
        let stream = KcpStream {
            core: core.clone(),
            read_buffer: None,
            recv_lock_future: None,
            send_lock_future: None,
            flush_lock_future: None,
            close_lock_future: None,
        };
        let _update_task = smol::spawn(Self::update(
            core.clone(),
            self.io.clone(),
            rx,
            self.dead_tx.clone(),
        ));
        self.sessions
            .lock()
            .await
            .insert(stream_id, KcpSession { core, _update_task });
        Ok(stream)
    }

    pub async fn accept(&self) -> KcpResult<KcpStream> {
        match self.accept_rx.recv().await {
            Ok(stream) => {
                return Ok(stream);
            }
            Err(_) => {
                return Err(KcpError::Shutdown(
                    "accpeting but kcp handle is closed".to_string(),
                ));
            }
        }
    }

    async fn clean(
        sessions: Arc<Mutex<HashMap<u16, KcpSession>>>,
        dead_rx: Receiver<u16>,
    ) -> KcpResult<()> {
        loop {
            let stream_id = dead_rx.recv().await.map_err(|_| {
                KcpError::Shutdown("cleaning but the kcp handle is closed".to_string())
            })?;
            sessions.lock().await.remove(&stream_id);
            log::debug!("cleaned {}", stream_id);
        }
    }

    async fn update(
        core: Arc<Mutex<KcpCore>>,
        io: Arc<IO>,
        flush_notify_rx: Receiver<()>,
        dead_tx: Sender<u16>,
    ) -> KcpResult<()> {
        loop {
            let interval = {
                let mut core = core.lock().await;
                if let Err(e) = core.flush(&*io).await {
                    if let KcpError::Shutdown(ref s) = e {
                        let stream_id = core.get_stream_id();
                        // Release the mutex
                        drop(core);
                        log::warn!("kcp core is shutting down: {}", s);
                        let _ = dead_tx.send(stream_id).await;
                        return Err(e);
                    } else {
                        // Sleep and continue
                        log::error!("flush error: {}, retrying...", e);
                        let r = rand::random::<u32>() % core.config.max_interval;
                        core.config.max_interval + r
                    }
                } else {
                    core.get_interval()
                }
            };
            let notify = async {
                let _ = flush_notify_rx.recv().await;
                log::trace!("updater wake up now!");
            };
            let tick = async move {
                Timer::after(Duration::from_millis(interval as u64)).await;
            };

            notify.race(tick).await;
        }
    }

    async fn feed_packet(
        sessions: Arc<Mutex<HashMap<u16, KcpSession>>>,
        config: Arc<KcpConfig>,
        io: Arc<IO>,
        accept_tx: Sender<KcpStream>,
        dead_tx: Sender<u16>,
    ) -> KcpResult<()> {
        let mut buf = Vec::new();
        loop {
            buf.resize(2 * config.mtu, 0);
            if let Err(e) = io.recv_packet(&mut buf).await {
                log::error!("recv error: {}", e);
                return Err(KcpError::IoError(e));
            }
            if buf.len() < HEADER_SIZE {
                log::error!("short packet length {}", buf.len());
                continue;
            }

            let stream_id = KcpSegment::peek_stream_id(&buf);
            let mut cursor = buf.as_slice();
            let mut segments = Vec::new();
            let mut invalid_packet = false;
            let mut new_stream = false;

            while cursor.has_remaining() {
                match KcpSegment::decode(&cursor) {
                    Ok(segment) => {
                        if segment.stream_id != stream_id {
                            invalid_packet = true;
                            log::error!("invalid packet format");
                            break;
                        }
                        // First PUSH or PING packet
                        if (segment.command == CMD_PUSH || segment.command == CMD_PING)
                            && segment.sequence == 0
                        {
                            new_stream = true;
                        }
                        cursor.advance(segment.encoded_len());
                        segments.push(segment);
                    }
                    Err(e) => {
                        log::error!("malformed packet: {}", e);
                        invalid_packet = true;
                        break;
                    }
                }
            }

            if invalid_packet {
                continue;
            }

            let mut is_new_stream = false;

            let core = {
                let mut sessions = sessions.lock().await;

                if let Some(session) = sessions.get_mut(&stream_id) {
                    session.core.clone()
                } else {
                    if new_stream {
                        let (tx, rx) = bounded(1);
                        let core = Arc::new(Mutex::new(
                            KcpCore::new(stream_id, config.clone(), tx).unwrap(),
                        ));
                        let update_task = {
                            let core = core.clone();
                            let io = io.clone();
                            smol::spawn(Self::update(core, io, rx, dead_tx.clone()))
                        };
                        sessions.insert(
                            stream_id,
                            KcpSession {
                                core: core.clone(),
                                _update_task: update_task,
                            },
                        );
                        is_new_stream = true;
                        log::trace!("new kcp stream");
                        core
                    } else {
                        log::error!("unknown stream_id {}", stream_id);
                        continue;
                    }
                }
            };

            if is_new_stream {
                let stream = KcpStream {
                    core: core.clone(),
                    read_buffer: None,
                    recv_lock_future: None,
                    send_lock_future: None,
                    flush_lock_future: None,
                    close_lock_future: None,
                };
                if accept_tx.send(stream).await.is_err() {
                    log::error!("kcp handle closed");
                    return Ok(());
                };
            }

            if let Err(e) = core.lock().await.input(segments) {
                log::trace!("removing dead link {}", e);
                sessions.lock().await.remove(&stream_id);
            };
        }
    }

    pub fn new(io: IO, config: KcpConfig) -> KcpResult<Self> {
        config.check()?;

        let io = Arc::new(io);
        let config = Arc::new(config);
        let sessions = Arc::new(Mutex::new(HashMap::<u16, KcpSession>::new()));

        let (accept_tx, accept_rx) = bounded(0x10);
        let (dead_tx, dead_rx) = bounded(0x10);

        // The only task reading the socket
        let _feed_packet_task = smol::spawn(Self::feed_packet(
            sessions.clone(),
            config.clone(),
            io.clone(),
            accept_tx,
            dead_tx.clone(),
        ));

        let _clean_task = smol::spawn(Self::clean(sessions.clone(), dead_rx.clone()));

        Ok(Self {
            sessions,
            config,
            accept_rx,
            io,
            _feed_packet_task,
            _clean_task,
            dead_tx,
        })
    }
}