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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
use error::Error;
use noise;
use packet::{EncryptedPacket, Frame};
use rand;
use recovery;
use replay;
use std::collections::HashMap;
use std::collections::VecDeque;
use std::time::Duration;

#[cfg(not(target_arch = "wasm32"))]
use std::time::Instant;

#[cfg(target_arch = "wasm32")]
use wasm_bindgen::prelude::*;
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen]
extern "C" {
    type Performance;
    static performance: Performance;
    #[wasm_bindgen(method)]
    fn now(this: &Performance) -> f64;
}

use stream;

//TODO: use mtu?
//careful, this must be bigger than the maximum mtu used in the entire network
//not the same number as used in shell/sft/etc..
pub const MAX_PACKET_SIZE: usize = 1500;
const DEFAULT_IDLE_TIMER: u64 = 30000;

pub struct Config {
    pub timeout:  Option<u16>,
    pub sleeping: bool,
}

pub struct Channel {
    pub debug_id: String,
    noise:        noise::Transport,

    //incomming
    replay:   replay::AntiReplay,
    recovery: recovery::QuicRecovery,
    streams:  HashMap<u32, stream::OrderedStream>,
    gone:     bool,

    //outgoing
    counters: HashMap<u32, u64>,
    outqueue: VecDeque<Frame>,

    sleeping:   bool,
    idle_time:  u64,
    deadline:   u64,
    last_seen:  u64,
    idle_count: u16,

    #[cfg(not(target_arch = "wasm32"))]
    basetime: Instant,
}

pub enum ChannelProgress {
    Later(Duration),
    SendPacket(Vec<u8>),
    ReceiveHeader(u32, Vec<u8>),
    ReceiveStream(u32, Vec<u8>),
    Close(u32),
    Disconnect,
}

impl Channel {
    pub fn new<S: Into<String>>(noise: noise::Transport, debug_id: S) -> Self {
        Channel {
            debug_id: debug_id.into(),
            noise:    noise,

            replay:   replay::AntiReplay::new(),
            recovery: recovery::QuicRecovery::new(),
            streams:  HashMap::new(),
            gone:     false,

            counters: HashMap::new(),
            outqueue: VecDeque::new(),

            sleeping:   false,
            idle_time:  DEFAULT_IDLE_TIMER,
            deadline:   DEFAULT_IDLE_TIMER,
            last_seen:  0,
            idle_count: 0,

            #[cfg(not(all(target_arch = "wasm32")))]
            basetime:                                          Instant::now(),
        }
    }

    pub fn bytes_in_flight(&self) -> usize {
        self.recovery.bytes_in_flight()
    }

    pub fn window(&self) -> usize {
        self.recovery.window()
    }

    pub fn is_initiator(&self) -> bool {
        self.noise.is_initiator()
    }

    fn now(&self) -> u64 {
        #[cfg(not(target_arch = "wasm32"))]
        {
            let elapsed = self.basetime.elapsed();
            elapsed.as_secs() * 1000 + elapsed.subsec_millis() as u64
        }
        #[cfg(target_arch = "wasm32")]
        {
            performance.now() as u64
        }
    }

    /// receive a packet from the wire
    pub fn recv(&mut self, pkt: EncryptedPacket) -> Result<(), Error> {
        let now = self.now();
        trace!(
            "[{}] incomming pkt {} with {} bytes at {}",
            self.debug_id,
            pkt.counter,
            pkt.payload.len(),
            now
        );
        self.last_seen = now;
        self.idle_count = 0;

        let counter = pkt.counter;

        if !self.replay.within_window(counter) {
            return Err(Error::AntiReplay.into());
        }

        let pkt = self.noise.recv(pkt)?;
        let frames = Frame::decode(pkt.as_slice())?;

        // packet authenticated from here

        self.replay.update_window(counter);

        let mut ackonly = true;
        for frame in frames {
            ackonly = ackonly && frame.is_ack();
            match frame {
                Frame::Header { stream, payload } => {
                    trace!("[{}] received header for stream {}", self.debug_id, stream);
                    trace!(
                        "[{}] LD1 currently holding {} streams",
                        self.debug_id,
                        self.streams.len()
                    );

                    if !self.streams.contains_key(&stream) && self.streams.len() > 1024 {
                        //TODO streams are currently not removed
                        error!("[{}] excessive number of streams", self.debug_id);
                        return Ok(());
                    }

                    let ordered = self.streams.entry(stream).or_insert(stream::OrderedStream::new());
                    ordered.push(Frame::Header { stream, payload })?;
                }
                Frame::Stream { stream, order, payload } => {
                    trace!("[{}] received message {}", self.debug_id, order);

                    if !self.streams.contains_key(&stream) && self.streams.len() > 1024 {
                        error!("[{}] excessive number of streams", self.debug_id);
                        return Ok(());
                    }

                    let ordered = self.streams.entry(stream).or_insert(stream::OrderedStream::new());
                    ordered.push(Frame::Stream { stream, order, payload })?;
                }
                Frame::Disconnect => {
                    trace!("[{}] disconnected", self.debug_id);
                    self.gone = true;
                }
                Frame::Ack { delay, acked } => {
                    let loss = self.recovery.on_ack_received(delay, acked.clone(), now);

                    trace!(
                        "[{}] received ack {:?} RTT is now {}. Lost packets: {:?}",
                        self.debug_id,
                        acked,
                        self.recovery.smoothed_rtt,
                        loss
                    );

                    self.handle_loss(loss);
                }
                Frame::Ping => {
                    trace!("[{}] received ping", self.debug_id);
                }
                Frame::Close { stream, order } => {
                    trace!("[{}] received close ", self.debug_id);

                    if !self.streams.contains_key(&stream) && self.streams.len() > 1024 {
                        error!("[{}] excessive number of streams", self.debug_id);
                        return Ok(());
                    }
                    let ordered = self.streams.entry(stream).or_insert(stream::OrderedStream::new());
                    ordered.push(Frame::Close { stream, order })?;
                }
                Frame::Config { timeout, sleeping } => {
                    if let Some(seconds) = timeout {
                        debug!("peer set timeout to {} seconds", seconds);
                        self.idle_time = seconds as u64 * 1000;
                    }
                    self.sleeping = sleeping;
                    if sleeping {
                        warn!(
                            "peer has indicated it is sleeping or unresponsive for {}ms",
                            self.idle_time
                        );
                    }
                }
            }
        }

        if !ackonly {
            self.outqueue.push_back(Frame::Ack {
                delay: now,
                acked: vec![counter],
            });
        }

        Ok(())
    }

    pub fn handle_loss(&mut self, loss: recovery::LossDetection) {
        match loss {
            recovery::LossDetection::None => (),
            recovery::LossDetection::Lost(lost) => {
                trace!(
                    "[{}] lost {} packets, window is {}, {:?}. at {}",
                    self.debug_id,
                    lost.len(),
                    self.recovery.window(),
                    lost,
                    self.now()
                );

                for frame in lost {
                    if !frame.is_ack() && !frame.is_ping() {
                        self.outqueue.push_back(frame);
                    }
                }
            }
            recovery::LossDetection::TailLossProbe(re) => {
                trace!(
                    "[{}] tail loss probe at {}. Retransmit: {}",
                    self.debug_id,
                    self.now(),
                    re.iter()
                        .map(|frame| format!("{:?}", frame))
                        .collect::<Vec<String>>()
                        .join(",")
                );
                for frame in re {
                    self.outqueue.push_back(frame);
                }
            }
            recovery::LossDetection::RetransmissionTimeout(re) => {
                trace!(
                    "[{}] retransmission timeout (retransmit {} frames, in flight: {}) at {}",
                    self.debug_id,
                    re.len(),
                    self.recovery.bytes_in_flight(),
                    self.now(),
                );
                for frame in re {
                    self.outqueue.push_front(frame);
                }
            }
            recovery::LossDetection::Unrecoverable => {
                warn!("[{}] connection is unrecoverable", self.debug_id);
                self.gone = true;
            }
        }
    }

    /// progress the channel and return something that happened
    /// this needs to be polled until it returns Later or Disconnectd
    pub fn progress(&mut self) -> Result<ChannelProgress, Error> {
        let now = self.now();

        trace!(
            "[{}] progress. now={}. deadline={}, in flight={},  last_seen={}, sleeping={}",
            self.debug_id,
            now,
            self.deadline,
            self.recovery.bytes_in_flight(),
            self.last_seen,
            self.sleeping,
        );

        if self.sleeping {
            if now >= self.last_seen + self.idle_time {
                self.sleeping = false;
            } else {
                self.deadline = self.last_seen + self.idle_time;
                trace!(
                    "[{}] peer is sleeping until {}. not counting any timers",
                    self.debug_id,
                    self.deadline,
                );
            }
        }

        // not an else branch. upper branch could set sleeping = false
        if !self.sleeping {
            if now >= self.last_seen + self.idle_time {
                self.outqueue.push_back(Frame::Ping);
                self.last_seen = now;
                self.idle_count += 1;
                if self.idle_count > 2 {
                    warn!(
                        "[{}] peer has exceeded idle timer * 3 and is marked dead",
                        self.debug_id
                    );
                    self.gone = true;
                }
            }

            if now >= self.deadline && self.recovery.bytes_in_flight() > 0 {
                let loss = self.recovery.on_loss_detection_alarm(now);
                self.handle_loss(loss);
            }

            self.deadline = if let Some(deadline) = self.recovery.loss_detection_alarm() {
                trace!("deadline from loss_detection_alarm");
                deadline
            } else {
                trace!(
                    "deadline from self.last_seen = {} + self.idle_time = {}",
                    self.last_seen,
                    self.idle_time
                );
                self.last_seen + self.idle_time
            };

            if self.deadline <= now {
                error!(
                    "[{}] upcoming deadline {} already expired at {}",
                    self.debug_id, self.deadline, now
                );
                self.deadline = now;
            }
        }

        // send out packets
        if !self.outqueue.is_empty() {
            let mut frames = Vec::new();
            let mut pkt = Vec::new();
            loop {
                let more = match self.outqueue.front() {
                    None => break,
                    Some(v) => v.len(),
                };

                let overhead = 36;
                let morelen = pkt.len() + overhead + more;
                let morelen = morelen + (256 - (morelen % 256));

                if morelen >= MAX_PACKET_SIZE {
                    break;
                }
                let mut frame = self.outqueue.pop_front().unwrap();
                if let Frame::Ack { acked, delay } = frame {
                    frame = Frame::Ack {
                        acked,
                        delay: now - delay,
                    };
                }
                frame.encode(&mut pkt)?;
                frames.push(frame);
            }
            assert_ne!(
                frames.len(),
                0,
                "bug: trying to send empty packet. outqueue is {}",
                self.outqueue.len()
            );

            let pkt = self.noise.send(&pkt)?;

            trace!(
                "[{}] sending pkt {} with {} frames, {} bytes [{}]",
                self.debug_id,
                pkt.counter,
                frames.len(),
                pkt.payload.len(),
                frames
                    .iter()
                    .map(|frame| format!("{:?}", frame))
                    .collect::<Vec<String>>()
                    .join(",")
            );

            self.recovery.on_packet_sent(pkt.counter, frames, now);

            let pkt = pkt.encode();
            assert!(pkt.len() < MAX_PACKET_SIZE);
            return Ok(ChannelProgress::SendPacket(pkt));
        }

        // receive assembled messages
        // TODO this unintentionally gives priority to earlier streams,
        // since the streams first in the hash are always polled first.
        // TODO unefficient iter
        for sid in &mut self.streams.keys().cloned().collect::<Vec<u32>>() {
            if let Some(msg) = self.streams.get_mut(&sid).unwrap().pop() {
                match msg {
                    Frame::Header { stream, payload, .. } => {
                        return Ok(ChannelProgress::ReceiveHeader(stream, payload));
                    }
                    Frame::Stream { stream, payload, .. } => {
                        return Ok(ChannelProgress::ReceiveStream(stream, payload));
                    }
                    Frame::Close { stream, .. } => {
                        trace!("LD1: stream {} closed", stream);
                        self.streams.remove(&stream);
                        return Ok(ChannelProgress::Close(stream));
                    }
                    _ => unreachable!(),
                }
            }
        }

        if self.gone {
            return Ok(ChannelProgress::Disconnect);
        }

        Ok(ChannelProgress::Later(Duration::from_millis(self.deadline - now)))
    }

    /// queue a message
    pub fn stream<M: Into<Vec<u8>>>(&mut self, stream: u32, msg: M) {
        let order = self.counters.entry(stream).or_insert(0);
        *order += 1;
        let order = *order;

        let msg = msg.into();
        assert!(msg.len() < 1200, "message too big {}", msg.len());
        self.outqueue.push_back(Frame::Stream {
            stream:  stream,
            order:   order,
            payload: msg.into(),
        });
    }

    /// open a new stream, given a header
    pub fn open<M: Into<Vec<u8>>>(&mut self, payload: M, are_we_initiator: bool) -> u32 {
        let payload = payload.into();
        assert!(payload.len() < 1200, "message too big {}", payload.len());

        assert!(self.counters.len() < <u32>::max_value() as usize);

        let stream = loop {
            let stream = rand::random::<u32>();
            match (are_we_initiator, stream) {
                (_, 0) => continue,
                (true, s) if s % 2 == 0 => continue,
                (false, s) if s % 2 == 1 => continue,
                (_, s) if self.streams.contains_key(&s) => continue,
                (_, s) if self.counters.contains_key(&s) => continue,
                (_, s) => break s,
            }
        };

        self.counters.insert(stream, 1);

        self.outqueue.push_back(Frame::Header {
            stream:  stream,
            payload: payload,
        });

        stream
    }

    /// send headers (as a response)
    pub fn header<M: Into<Vec<u8>>>(&mut self, stream: u32, payload: M) {
        let payload = payload.into();
        assert!(payload.len() < 1200, "message too big {}", payload.len());

        if let Some(_) = self.counters.get(&stream) {
            warn!(
                "[{}] attempting to send header twice on stream {}",
                self.debug_id, stream
            );
            return;
        }
        self.counters.insert(stream, 1);
        self.outqueue.push_back(Frame::Header { stream, payload });
    }

    /// queue a close, stream may still be able to receive (this is half close)
    pub fn close(&mut self, stream: u32) {
        let order = match self.counters.get_mut(&stream) {
            None => {
                warn!(
                    "[{}] sending close for stream {} before we sent any headers",
                    self.debug_id, stream
                );
                1
            }
            Some(order) => {
                //we're not removing the counrer yet because reuse of the stream id
                //may lead to corner cases where a header arrives before a close
                *order += 1;
                *order
            }
        };

        self.outqueue.push_back(Frame::Close { order, stream });
    }

    /// remove a stream (full close)
    pub fn remove(&mut self, stream: u32) {
        self.streams.remove(&stream);
        self.counters.remove(&stream);
    }

    /// create a disconnect packet
    pub fn disconnect(&mut self) -> Result<Vec<u8>, Error> {
        let mut pkt = Vec::new();
        Frame::Disconnect.encode(&mut pkt)?;
        let pkt = self.noise.send(&pkt)?;
        Ok(pkt.encode())
    }

    /// send probe packets
    pub fn probe(&mut self) {
        self.outqueue.push_back(Frame::Ping);
    }

    /// configure network
    pub fn config(&mut self, config: Config) {
        if let Some(seconds) = config.timeout {
            self.idle_time = seconds as u64 * 1000;
        }

        let fr = Frame::Config {
            timeout:  config.timeout,
            sleeping: config.sleeping,
        };
        self.outqueue.push_back(fr);
    }
}