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
use crate::crypto::Crypto;
use crate::endpoint::ConnectionChannel;
use async_io::Timer;
use fnv::FnvHashMap;
use futures::prelude::*;
use libp2p::core::muxing::{StreamMuxer, StreamMuxerEvent};
use libp2p::{Multiaddr, PeerId};
use parking_lot::Mutex;
use quinn_proto::generic::Connection;
use quinn_proto::{
ConnectionError, Dir, Event, FinishError, ReadError, ReadableError, StreamEvent, StreamId,
VarInt, WriteError,
};
use std::collections::VecDeque;
use std::io::Write;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::pin::Pin;
use std::task::{Context, Poll, Waker};
use std::time::Instant;
use thiserror::Error;
pub struct QuicMuxer<C: Crypto> {
inner: Mutex<QuicMuxerInner<C>>,
}
impl<C: Crypto> std::fmt::Debug for QuicMuxer<C> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "QuicMuxer")
}
}
struct QuicMuxerInner<C: Crypto> {
accept_incoming: bool,
endpoint: ConnectionChannel<C>,
connection: Connection<C::Session>,
waker: Option<Waker>,
timer: Option<Timer>,
substreams: FnvHashMap<StreamId, SubstreamState>,
pending_substreams: VecDeque<Waker>,
close_waker: Option<Waker>,
}
#[derive(Debug, Default)]
struct SubstreamState {
read_waker: Option<Waker>,
write_waker: Option<Waker>,
}
impl<C: Crypto> QuicMuxer<C> {
pub fn new(endpoint: ConnectionChannel<C>, connection: Connection<C::Session>) -> Self {
Self {
inner: Mutex::new(QuicMuxerInner {
accept_incoming: false,
endpoint,
connection,
waker: None,
timer: None,
substreams: Default::default(),
pending_substreams: Default::default(),
close_waker: None,
}),
}
}
pub fn is_handshaking(&self) -> bool {
self.inner.lock().connection.is_handshaking()
}
pub fn peer_id(&self) -> Option<PeerId> {
let inner = self.inner.lock();
let session = inner.connection.crypto_session();
C::peer_id(&session)
}
pub fn local_addr(&self) -> Multiaddr {
let inner = self.inner.lock();
let ip = inner
.connection
.local_ip()
.unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED));
let addr = SocketAddr::new(ip, inner.endpoint.port());
crate::transport::socketaddr_to_multiaddr(&addr)
}
pub fn remote_addr(&self) -> Multiaddr {
let inner = self.inner.lock();
let addr = inner.connection.remote_address();
crate::transport::socketaddr_to_multiaddr(&addr)
}
pub(crate) fn set_accept_incoming(&self, accept: bool) {
let mut inner = self.inner.lock();
inner.accept_incoming = accept;
}
}
impl<C: Crypto> StreamMuxer for QuicMuxer<C> {
type Substream = StreamId;
type OutboundSubstream = ();
type Error = QuicMuxerError;
fn poll_event(
&self,
cx: &mut Context,
) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Self::Error>> {
let mut inner = self.inner.lock();
let now = Instant::now();
while let Poll::Ready(event) = inner.endpoint.poll_channel_events(cx) {
inner.connection.handle_event(event);
}
let _max_datagrams = inner.endpoint.max_datagrams();
while let Some(transmit) = inner.connection.poll_transmit(now) {
inner.endpoint.send_transmit(transmit);
}
loop {
if let Some(timer) = inner.timer.as_mut() {
match Pin::new(timer).poll(cx) {
Poll::Ready(expired) => {
inner.connection.handle_timeout(expired);
inner.timer = None;
}
Poll::Pending => break,
}
} else if let Some(when) = inner.connection.poll_timeout() {
inner.timer = Some(Timer::at(when));
} else {
break;
}
}
while let Some(event) = inner.connection.poll_endpoint_events() {
inner.endpoint.send_endpoint_event(event);
}
while let Some(event) = inner.connection.poll() {
match event {
Event::HandshakeDataReady => {}
Event::Connected => {
return Poll::Pending;
}
Event::ConnectionLost { reason } => {
tracing::debug!("connection lost because of {}", reason);
inner.substreams.clear();
if let Some(waker) = inner.close_waker.take() {
waker.wake();
}
return Poll::Ready(Err(QuicMuxerError::ConnectionLost { reason }));
}
Event::Stream(StreamEvent::Opened { dir: Dir::Bi }) => {
}
Event::Stream(StreamEvent::Readable { id }) => {
tracing::trace!("stream readable {}", id);
if let Some(substream) = inner.substreams.get_mut(&id) {
if let Some(waker) = substream.read_waker.take() {
waker.wake();
}
}
}
Event::Stream(StreamEvent::Writable { id }) => {
tracing::trace!("stream writable {}", id);
if let Some(substream) = inner.substreams.get_mut(&id) {
if let Some(waker) = substream.write_waker.take() {
waker.wake();
}
}
}
Event::Stream(StreamEvent::Finished { id }) => {
tracing::trace!("stream finished {}", id);
if let Some(substream) = inner.substreams.get_mut(&id) {
if let Some(waker) = substream.read_waker.take() {
waker.wake();
}
if let Some(waker) = substream.write_waker.take() {
waker.wake();
}
}
}
Event::Stream(StreamEvent::Stopped { id, error_code }) => {
tracing::debug!("substream {} stopped with error {}", id, error_code);
inner.substreams.remove(&id);
return Poll::Ready(Err(QuicMuxerError::StreamStopped { id, error_code }));
}
Event::Stream(StreamEvent::Available { dir: Dir::Bi }) => {
tracing::trace!("stream available");
if let Some(waker) = inner.pending_substreams.pop_front() {
waker.wake();
}
}
Event::Stream(StreamEvent::Opened { dir: Dir::Uni })
| Event::Stream(StreamEvent::Available { dir: Dir::Uni })
| Event::DatagramReceived => {
inner
.connection
.close(Instant::now(), From::from(0u32), Default::default());
return Poll::Ready(Err(QuicMuxerError::ProtocolViolation));
}
}
}
if inner.accept_incoming {
if let Some(id) = inner.connection.streams().accept(Dir::Bi) {
inner.substreams.insert(id, Default::default());
tracing::trace!("opened incoming substream {}", id);
return Poll::Ready(Ok(StreamMuxerEvent::InboundSubstream(id)));
}
}
if inner.substreams.is_empty() {
if let Some(waker) = inner.close_waker.take() {
waker.wake();
}
}
inner.waker = Some(cx.waker().clone());
Poll::Pending
}
fn open_outbound(&self) -> Self::OutboundSubstream {}
fn poll_outbound(
&self,
cx: &mut Context,
_: &mut Self::OutboundSubstream,
) -> Poll<Result<Self::Substream, Self::Error>> {
let mut inner = self.inner.lock();
if let Some(id) = inner.connection.streams().open(Dir::Bi) {
tracing::trace!("opened outgoing substream {}", id);
inner.substreams.insert(id, Default::default());
if let Some(waker) = inner.pending_substreams.pop_front() {
waker.wake();
}
Poll::Ready(Ok(id))
} else {
inner.pending_substreams.push_back(cx.waker().clone());
Poll::Pending
}
}
fn destroy_outbound(&self, _: Self::OutboundSubstream) {}
fn read_substream(
&self,
cx: &mut Context,
id: &mut Self::Substream,
mut buf: &mut [u8],
) -> Poll<Result<usize, Self::Error>> {
let mut inner = self.inner.lock();
let mut stream = inner.connection.recv_stream(*id);
let mut chunks = match stream.read(true) {
Ok(chunks) => chunks,
Err(ReadableError::UnknownStream) => {
return Poll::Ready(Err(QuicMuxerError::UnknownStream { id: *id }))
}
Err(ReadableError::IllegalOrderedRead) => {
panic!("Illegal ordered read can only happen if `stream.read(false)` is used.");
}
};
let mut bytes = 0;
let mut pending = false;
loop {
if buf.is_empty() {
break;
}
match chunks.next(buf.len()) {
Ok(Some(chunk)) => {
buf.write_all(&chunk.bytes).expect("enough buffer space");
bytes += chunk.bytes.len();
}
Ok(None) => break,
Err(ReadError::Reset(error_code)) => {
tracing::debug!("substream {} was reset with error code {}", id, error_code);
bytes = 0;
break;
}
Err(ReadError::Blocked) => {
pending = true;
break;
}
}
}
if chunks.finalize().should_transmit() {
if let Some(waker) = inner.waker.take() {
waker.wake();
}
}
let substream = inner.substreams.get_mut(&id).unwrap();
if pending && bytes == 0 {
substream.read_waker = Some(cx.waker().clone());
Poll::Pending
} else {
Poll::Ready(Ok(bytes))
}
}
fn write_substream(
&self,
cx: &mut Context,
id: &mut Self::Substream,
buf: &[u8],
) -> Poll<Result<usize, Self::Error>> {
let mut inner = self.inner.lock();
match inner.connection.send_stream(*id).write(buf) {
Ok(bytes) => Poll::Ready(Ok(bytes)),
Err(WriteError::Blocked) => {
let mut substream = inner.substreams.get_mut(id).unwrap();
substream.write_waker = Some(cx.waker().clone());
Poll::Pending
}
Err(WriteError::Stopped(_)) => Poll::Ready(Ok(0)),
Err(WriteError::UnknownStream) => {
Poll::Ready(Err(QuicMuxerError::UnknownStream { id: *id }))
}
}
}
fn shutdown_substream(
&self,
_: &mut Context,
id: &mut Self::Substream,
) -> Poll<Result<(), Self::Error>> {
tracing::trace!("closing substream {}", id);
let mut inner = self.inner.lock();
match inner.connection.send_stream(*id).finish() {
Ok(()) => Poll::Ready(Ok(())),
Err(FinishError::Stopped(_)) => Poll::Ready(Ok(())),
Err(FinishError::UnknownStream) => {
Poll::Ready(Err(QuicMuxerError::UnknownStream { id: *id }))
}
}
}
fn destroy_substream(&self, id: Self::Substream) {
tracing::trace!("destroying substream {}", id);
let mut inner = self.inner.lock();
inner.substreams.remove(&id);
let mut stream = inner.connection.recv_stream(id);
let should_transmit = if let Ok(mut chunks) = stream.read(true) {
while let Ok(Some(_)) = chunks.next(usize::MAX) {}
chunks.finalize().should_transmit()
} else {
false
};
if should_transmit {
if let Some(waker) = inner.waker.take() {
waker.wake();
}
}
}
fn flush_substream(
&self,
_cx: &mut Context,
_id: &mut Self::Substream,
) -> Poll<Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn flush_all(&self, _cx: &mut Context) -> Poll<Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn close(&self, cx: &mut Context) -> Poll<Result<(), Self::Error>> {
tracing::trace!("closing muxer");
let mut inner = self.inner.lock();
if inner.substreams.is_empty() {
return Poll::Ready(Ok(()));
}
inner.close_waker = Some(cx.waker().clone());
let inner = &mut *inner;
for id in inner.substreams.keys() {
let _ = inner.connection.send_stream(*id).finish();
}
Poll::Pending
}
}
#[derive(Debug, Error)]
pub enum QuicMuxerError {
#[error("connection was lost because of {reason}")]
ConnectionLost { reason: ConnectionError },
#[error("unsupported quic feature used")]
ProtocolViolation,
#[error("stream {id} stopped with error {error_code}")]
StreamStopped { id: StreamId, error_code: VarInt },
#[error("unknown stream {id}")]
UnknownStream { id: StreamId },
}
impl From<QuicMuxerError> for std::io::Error {
fn from(err: QuicMuxerError) -> Self {
std::io::Error::new(std::io::ErrorKind::Other, err)
}
}