tquic 1.6.0

A high-performance, lightweight, and cross-platform QUIC 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

// Copyright (c) 2023 The TQUIC Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::connection::path::PathMap;
use crate::connection::space::PacketNumSpaceMap;
use crate::connection::stream::StreamMap;
use crate::multipath_scheduler::MultipathScheduler;
use crate::Error;
use crate::MultipathConfig;
use crate::Path;
use crate::Result;

/// RoundRobinScheduler iterates over the available paths and select the next
/// one whose congestion window is open.
///
/// The simple scheduler aims to guarantee that the capacity of each path is
/// fully utilized as the distribution across all path is equal. It is for
/// testing purposes only.
pub struct RoundRobinScheduler {
    last: Option<usize>,
}

impl RoundRobinScheduler {
    pub fn new(_conf: &MultipathConfig) -> RoundRobinScheduler {
        RoundRobinScheduler { last: None }
    }
}

impl RoundRobinScheduler {
    /// Iterate and find the last used path
    fn find_last(&self, iter: &mut slab::IterMut<Path>, last: usize) -> bool {
        for (pid, _) in iter.by_ref() {
            if pid != last {
                continue;
            }
            return true;
        }
        false
    }

    /// Try to select an available path
    fn select(&mut self, iter: &mut slab::IterMut<Path>) -> Option<usize> {
        for (pid, path) in iter.by_ref() {
            // Skip the path that is not ready for sending non-probing packets.
            if !path.active() || !path.recovery.can_send() {
                continue;
            }

            self.last = Some(pid);
            return Some(pid);
        }
        None
    }
}

impl MultipathScheduler for RoundRobinScheduler {
    /// Select the next path with sufficient congestion window.
    fn on_select(
        &mut self,
        paths: &mut PathMap,
        spaces: &mut PacketNumSpaceMap,
        streams: &mut StreamMap,
    ) -> Result<usize> {
        let mut iter = paths.iter_mut();
        let mut exist_last = false;

        // Iterate and find the last used path
        if let Some(last) = self.last {
            if self.find_last(&mut iter, last) {
                exist_last = true;
            } else {
                // The last path has been abandoned
                iter = paths.iter_mut();
            }
        }

        // Find the next available path
        if let Some(pid) = self.select(&mut iter) {
            return Ok(pid);
        }
        if !exist_last {
            return Err(Error::Done);
        }

        let mut iter = paths.iter_mut();
        if let Some(pid) = self.select(&mut iter) {
            return Ok(pid);
        }
        Err(Error::Done)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::multipath_scheduler::tests::*;

    #[test]
    fn round_robin_single_available_path() -> Result<()> {
        let mut t = MultipathTester::new()?;

        let mut s = RoundRobinScheduler::new(&MultipathConfig::default());
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 0);
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 0);
        Ok(())
    }

    #[test]
    fn round_robin_multi_available_path() -> Result<()> {
        let mut t = MultipathTester::new()?;
        t.add_path("127.0.0.1:443", "127.0.0.2:8443", 50)?;
        t.add_path("127.0.0.1:443", "127.0.0.3:8443", 150)?;
        t.add_path("127.0.0.1:443", "127.0.0.4:8443", 100)?;

        let mut s = RoundRobinScheduler::new(&MultipathConfig::default());
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 0);
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 1);
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 2);
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 3);

        t.set_path_active(1, false)?;
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 0);
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 2);

        t.set_path_active(3, false)?;
        assert_eq!(s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams)?, 0);
        Ok(())
    }

    #[test]
    fn round_robin_no_available_path() -> Result<()> {
        let mut t = MultipathTester::new()?;
        t.set_path_active(0, false)?;

        let mut s = RoundRobinScheduler::new(&MultipathConfig::default());
        assert_eq!(
            s.on_select(&mut t.paths, &mut t.spaces, &mut t.streams),
            Err(Error::Done)
        );
        Ok(())
    }
}