zrquic 0.1.6

A low-level quic library based on `quiche` focusing on non-blocking and masive connection management.
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
use std::{
    borrow::Cow,
    cell::RefCell,
    collections::HashMap,
    ops::DerefMut,
    time::{Duration, Instant},
};

use crossbeam_utils::sync::Unparker;
use parking_lot::{Mutex, RwLock};
use quiche::{ConnectionId, RecvInfo, SendInfo};

use crate::poll::{
    Error, Event, Readiness, Result, StreamKind, Token,
    conn::{LocKind, LockContext, QuicConn},
    utils::release_time,
};

static DEFAULT_RELEASE_TIMER_THRESHOLD: Duration = Duration::from_micros(250);

macro_rules! lock {
    ($self:ident, $token: ident, $kind: expr) => {{
        let state = $self.state.lock();

        let conn = state
            .conns
            .get(&$token)
            .ok_or_else(|| Error::NotFound)?
            .borrow_mut()
            .try_lock($kind, |ctx| $self.unlock(ctx))?;

        drop(state);

        conn
    }};
}

#[derive(Default)]
struct State {
    token_next: u32,
    conns: HashMap<Token, RefCell<QuicConn>>,
    readiness: RefCell<Readiness>,
    unparkers: HashMap<Token, Unparker>,
}

/// A group of `quiche:Connection`s.
pub struct Group {
    state: Mutex<State>,
    scids: RwLock<HashMap<ConnectionId<'static>, Token>>,
}

impl Default for Group {
    fn default() -> Self {
        Self {
            state: Default::default(),
            scids: Default::default(),
        }
    }
}

impl Group {
    /// Create a group with default parameters.
    pub fn new() -> Self {
        Self::default()
    }

    /// Wrap and register a new `quiche::Connection`.
    #[inline]
    pub fn register(&self, wrapped: quiche::Connection) -> Result<Token> {
        let mut state = self.state.lock();

        loop {
            let token = Token(state.token_next);

            (state.token_next, _) = state.token_next.overflowing_add(1);

            if state.conns.contains_key(&token) {
                continue;
            }

            assert!(
                self.scids
                    .write()
                    .insert(wrapped.source_id().into_owned(), token)
                    .is_none()
            );

            log::trace!(
                "register quic connection, token={:?}, trace_id={}",
                token,
                wrapped.trace_id()
            );

            let conn = RefCell::new(QuicConn::new(token, wrapped));

            let guard = conn.borrow_mut().try_lock(LocKind::ReadLock, |context| {
                conn.borrow_mut().unlock(
                    context.lock_count,
                    false,
                    state.readiness.borrow_mut().deref_mut(),
                );
            })?;

            drop(guard);

            state.conns.insert(token, conn);

            return Ok(token);
        }
    }

    /// Unwrap a bound `quiche::Connection`
    #[inline]
    pub fn deregister(&self, token: Token) -> Result<quiche::Connection> {
        let mut state = self.state.lock();

        let conn: quiche::Connection = state
            .conns
            .remove(&token)
            .ok_or_else(|| Error::NotFound)?
            .into_inner()
            .into();

        drop(state);

        assert_eq!(
            self.scids.write().remove(&conn.source_id().into_owned()),
            Some(token)
        );

        Ok(conn)
    }

    /// Returns number of connections in the group.
    #[inline]
    pub fn len(&self) -> usize {
        self.state.lock().conns.len()
    }

    fn unlock(&self, ctx: LockContext) {
        let mut state = self.state.lock();

        if let Some(unparker) = state.unparkers.remove(&ctx.token) {
            unparker.unpark();
        }

        if state
            .conns
            .get(&ctx.token)
            .expect("Unlock.")
            .borrow_mut()
            .unlock(
                ctx.lock_count,
                ctx.send_done,
                state.readiness.borrow_mut().deref_mut(),
            )
        {
            log::trace!(
                "automatic deregister closed connection, token={:?}",
                ctx.token
            );

            drop(state);
            _ = self.deregister(ctx.token);
        }
    }

    /// Process a packet recv.
    /// Processes QUIC packets received from the peer.
    pub(crate) fn recv_(
        &self,
        scid: &ConnectionId<'_>,
        buf: &mut [u8],
        info: RecvInfo,
        unparker: Option<&Unparker>,
    ) -> Result<(Token, usize)> {
        let token = self
            .scids
            .read()
            .get(&scid)
            .ok_or_else(|| Error::NotFound)?
            .clone();

        let mut state = self.state.lock();

        let Ok(mut conn) = state
            .conns
            .get(&token)
            .ok_or_else(|| Error::NotFound)?
            .borrow_mut()
            .try_lock(LocKind::Recv, |ctx| self.unlock(ctx))
        else {
            // insert unparker.
            if let Some(unparker) = unparker {
                state.unparkers.insert(token, unparker.clone());
            }

            return Err(Error::Busy);
        };

        drop(state);

        match conn.recv(buf, info) {
            Ok(recv_size) => {
                log::trace!(
                    "Connection recv, scid={:?}, len={}",
                    conn.source_id(),
                    recv_size
                );

                Ok((token, recv_size))
            }
            Err(err) => {
                log::error!("Connection recv, scid={:?}, err={}", conn.source_id(), err);
                Err(Error::Quiche(err))
            }
        }
    }

    /// Processes QUIC packets received from the peer.
    pub fn recv(&self, buf: &mut [u8], info: RecvInfo) -> Result<usize> {
        let header =
            quiche::Header::from_slice(buf, quiche::MAX_CONN_ID_LEN).map_err(Error::Quiche)?;

        self.recv_(&header.dcid, buf, info, None)
            .map(|(_, recv_size)| recv_size)
    }

    /// Writes a single QUIC packet to be sent to the peer.
    pub fn send(&self, token: Token, buf: &mut [u8]) -> Result<(usize, SendInfo)> {
        let mut conn = lock!(self, token, LocKind::Recv);

        if let Some(release_time) =
            release_time(&conn, Instant::now(), DEFAULT_RELEASE_TIMER_THRESHOLD)
        {
            log::trace!(
                "connection send, scid={:?}, next_release_time={:?}",
                conn.trace_id(),
                release_time,
            );
            return Err(Error::Retry);
        }

        // TODO: prevent frequent calls to on_timeout
        conn.on_timeout();

        match conn.send(buf) {
            Ok((send_size, send_info)) => {
                log::trace!(
                    "connection send, scid={:?}, send_size={}, send_info={:?}",
                    conn.trace_id(),
                    send_size,
                    send_info
                );
                return Ok((send_size, send_info));
            }
            Err(quiche::Error::Done) => {
                log::trace!("connection send, scid={:?}, done", conn.trace_id());
                conn.send_done();
                return Err(Error::Retry);
            }
            Err(err) => {
                log::error!("connection send, scid={:?}, err={}", conn.trace_id(), err);
                return Err(Error::Quiche(err));
            }
        }
    }

    /// Close one connection.
    pub fn close(
        &self,
        token: Token,
        app: bool,
        err: u64,
        reason: Cow<'static, [u8]>,
    ) -> Result<()> {
        let state = self.state.lock();
        let conn = state.conns.get(&token).ok_or_else(|| Error::NotFound)?;

        conn.borrow_mut()
            .close(app, err, reason, state.readiness.borrow_mut().deref_mut())
    }

    /// Open a outbound stream.
    pub fn stream_open(&self, token: Token, kind: StreamKind) -> Result<u64> {
        let state = self.state.lock();
        let conn = state.conns.get(&token).ok_or_else(|| Error::NotFound)?;

        conn.borrow_mut()
            .stream_open(kind, state.readiness.borrow_mut().deref_mut())
    }

    /// Shutdown a stream.
    pub fn stream_shutdown(&self, token: Token, stream_id: u64, err: u64) -> Result<()> {
        let state = self.state.lock();
        let conn = state.conns.get(&token).ok_or_else(|| Error::NotFound)?;

        conn.borrow_mut()
            .stream_close(stream_id, err, state.readiness.borrow_mut().deref_mut())
    }

    /// Writes data to a stream.
    pub fn stream_send(
        &self,
        token: Token,
        stream_id: u64,
        buf: &[u8],
        fin: bool,
    ) -> Result<usize> {
        let mut conn = lock!(
            self,
            token,
            LocKind::StreamSend {
                id: stream_id,
                len: buf.len()
            }
        );

        match conn.stream_send(stream_id, buf, fin) {
            Ok(send_size) => {
                log::trace!(
                    "stream send, scid={:?}, stream_id={}, len={}, fin={}",
                    conn.source_id(),
                    stream_id,
                    send_size,
                    fin
                );
                return Ok(send_size);
            }
            Err(quiche::Error::Done) => {
                log::trace!(
                    "stream send, scid={:?}, stream_id={}, fin={}, Done",
                    conn.source_id(),
                    stream_id,
                    fin
                );
                return Err(Error::Retry);
            }
            Err(err) => {
                log::error!(
                    "stream send, scid={:?}, stream_id={}, fin={}, err={}",
                    conn.source_id(),
                    stream_id,
                    fin,
                    err
                );

                return Err(Error::Quiche(err));
            }
        }
    }

    /// Reads contiguous data from a stream into the provided slice.
    pub fn stream_recv(
        &self,
        token: Token,
        stream_id: u64,
        buf: &mut [u8],
    ) -> Result<(usize, bool)> {
        let mut conn = lock!(self, token, LocKind::StreamRecv(stream_id));

        match conn.stream_recv(stream_id, buf) {
            Ok((recv_size, fin)) => {
                log::trace!(
                    "stream recv, scid={:?}, stream_id={}, len={}, fin={}",
                    conn.source_id(),
                    stream_id,
                    recv_size,
                    fin
                );
                return Ok((recv_size, fin));
            }
            Err(quiche::Error::Done) => {
                if conn.stream_finished(stream_id) {
                    log::trace!(
                        "stream recv, scid={:?}, stream_id={}, len={}, fin={}",
                        conn.source_id(),
                        stream_id,
                        0,
                        true
                    );

                    return Ok((0, true));
                }

                log::trace!(
                    "stream recv, scid={:?}, stream_id={}, Done",
                    conn.source_id(),
                    stream_id,
                );
                return Err(Error::Retry);
            }
            Err(err) => {
                log::error!(
                    "stream recv, scid={:?}, stream_id={}, err={}",
                    conn.source_id(),
                    stream_id,
                    err
                );

                return Err(Error::Quiche(err));
            }
        }
    }

    /// Waits for readiness events without blocking current thread and returns possible retry time duration.
    pub fn poll(&self, events: &mut Vec<Event>) -> Option<Instant> {
        let state = self.state.lock();

        state
            .readiness
            .borrow_mut()
            .poll(events, DEFAULT_RELEASE_TIMER_THRESHOLD)
    }

    #[cfg(test)]
    pub(crate) fn readiness(&self, event: Event, delay_to: Option<Instant>) {
        let state = self.state.lock();
        state.readiness.borrow_mut().insert(event, delay_to);
    }
}