refactor(s2n-quic-core): move ack::Transmission to core

aws · Feb 20, 2024 · 40ec608 · 40ec608
1 parent 14023eb
commit 40ec608
Show file tree

Hide file tree

Showing 108 changed files with 86 additions and 183 deletions.
diff --git a/quic/s2n-quic-core/src/ack.rs b/quic/s2n-quic-core/src/ack.rs
@@ -5,8 +5,13 @@
 pub mod ranges;
 pub mod set;
 pub mod settings;
+pub mod transmission;
 
 #[cfg(feature = "alloc")]
 pub use ranges::Ranges;
 pub use set::Set;
 pub use settings::Settings;
+pub use transmission::Transmission;
+
+#[cfg(any(test, feature = "testing"))]
+pub mod testing;
diff --git a/quic/s2n-quic-core/src/ack/snapshots/s2n_quic_core__ack__transmission__tests__Set.snap b/quic/s2n-quic-core/src/ack/snapshots/s2n_quic_core__ack__transmission__tests__Set.snap
@@ -0,0 +1,5 @@
+---
+source: quic/s2n-quic-core/src/ack/transmission.rs
+expression: "size_of::<Set>()"
+---
+32
diff --git a/...2n-quic-core/src/ack/snapshots/s2n_quic_core__ack__transmission__tests__Transmission.snap b/...2n-quic-core/src/ack/snapshots/s2n_quic_core__ack__transmission__tests__Transmission.snap
@@ -0,0 +1,5 @@
+---
+source: quic/s2n-quic-core/src/ack/transmission.rs
+expression: "size_of::<Transmission>()"
+---
+16
diff --git a/quic/s2n-quic-core/src/ack/testing.rs b/quic/s2n-quic-core/src/ack/testing.rs
@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+use crate::{
+    ack::transmission::Transmission,
+    packet::number::{PacketNumber, PacketNumberSpace},
+    varint::VarInt,
+};
+
+/// Generates AckElicitingTransmissions from increasing packet numbers
+pub fn transmissions_iter() -> impl Iterator<Item = Transmission> {
+    packet_numbers_iter().map(|pn| Transmission {
+        sent_in_packet: pn,
+        largest_received_packet_number_acked: pn,
+    })
+}
+
+/// Generates increasing packet numbers
+pub fn packet_numbers_iter() -> impl Iterator<Item = PacketNumber> {
+    Iterator::map(0u32.., |pn| {
+        PacketNumberSpace::ApplicationData.new_packet_number(VarInt::from_u32(pn))
+    })
+}
diff --git a/...ort/src/ack/ack_eliciting_transmission.rs → quic/s2n-quic-core/src/ack/transmission.rs b/...ort/src/ack/ack_eliciting_transmission.rs → quic/s2n-quic-core/src/ack/transmission.rs
@@ -1,13 +1,13 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+use crate::{ack, packet::number::PacketNumber};
 use core::ops::RangeInclusive;
-use s2n_quic_core::{ack, packet::number::PacketNumber};
 
 pub type AckRange = RangeInclusive<PacketNumber>;
 
 #[derive(Clone, Debug, Default)]
-pub struct AckElicitingTransmissionSet {
+pub struct Set {
     /// A stable ack-eliciting transmission
     ///
     /// In this case, "stable" means the oldest transmission that
@@ -17,15 +17,16 @@ pub struct AckElicitingTransmissionSet {
     /// are always either removed or declared lost. Without it,
     /// the TX packet number would be a moving target
     /// and packet number ranges would never be removed.
-    stable: Option<AckElicitingTransmission>,
+    stable: Option<Transmission>,
 
     /// The latest ack-eliciting transmission
-    latest: Option<AckElicitingTransmission>,
+    latest: Option<Transmission>,
 }
 
-impl AckElicitingTransmissionSet {
+impl Set {
     /// Called when an ACK frame is bundled with an ack eliciting packet
-    pub fn on_transmit(&mut self, transmission: AckElicitingTransmission) {
+    #[inline]
+    pub fn on_transmit(&mut self, transmission: Transmission) {
         self.latest = Some(transmission);
 
         // only set the stable transmission if it's not set
@@ -35,6 +36,7 @@ impl AckElicitingTransmissionSet {
     }
 
     /// Called when a set of packets was acknowledged or lost
+    #[inline]
     pub fn on_update<A: ack::Set>(&mut self, ack_set: &A) -> Option<AckRange> {
         if let Some(ack_range) = self
             .latest
@@ -69,13 +71,14 @@ impl AckElicitingTransmissionSet {
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd)]
-pub struct AckElicitingTransmission {
+pub struct Transmission {
     pub sent_in_packet: PacketNumber,
     pub largest_received_packet_number_acked: PacketNumber,
 }
 
-impl AckElicitingTransmission {
+impl Transmission {
     /// Called when a set of packets was acknowledged or lost
+    #[inline]
     pub fn ack_range<A: ack::Set>(&self, ack_set: &A) -> Option<AckRange> {
         //= https://www.rfc-editor.org/rfc/rfc9000#section-13.2.4
         //# When a packet containing an ACK frame is acknowledged, the receiver can stop
@@ -97,12 +100,13 @@ impl AckElicitingTransmission {
 
 #[cfg(test)]
 mod tests {
-    use super::{super::tests::transmissions_iter, *};
+    use super::*;
+    use crate::ack::testing::transmissions_iter;
 
     /// This test is meant to simulate an immediate ACK rate from a peer
     #[test]
     fn latest_ack_test() {
-        let mut set = AckElicitingTransmissionSet::default();
+        let mut set = Set::default();
         assert!(set.is_empty());
 
         let mut transmissions = transmissions_iter();
@@ -132,7 +136,7 @@ mod tests {
     /// This test is meant to simulate a delayed ACK rate from a peer
     #[test]
     fn stable_ack_test() {
-        let mut set = AckElicitingTransmissionSet::default();
+        let mut set = Set::default();
         assert!(set.is_empty());
 
         let mut transmissions = transmissions_iter();
@@ -168,17 +172,12 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)] // miri is unable to read the file system
     fn size_of_snapshots() {
         use core::mem::size_of;
         use insta::assert_debug_snapshot;
 
-        assert_debug_snapshot!(
-            "AckElicitingTransmission",
-            size_of::<AckElicitingTransmission>()
-        );
-        assert_debug_snapshot!(
-            "AckElicitingTransmissionSet",
-            size_of::<AckElicitingTransmissionSet>()
-        );
+        assert_debug_snapshot!("Transmission", size_of::<Transmission>());
+        assert_debug_snapshot!("Set", size_of::<Set>());
     }
 }
diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__ack.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__ack.snap
@@ -1,7 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
 expression: values
-
 ---
 [
     Ack(

diff --git a/.../s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__connection_close.snap b/.../s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__connection_close.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     ConnectionClose(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__crypto.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__crypto.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     Crypto(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__data_blocked.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__data_blocked.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     DataBlocked(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__datagram.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__datagram.snap
@@ -1,6 +1,5 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-assertion_line: 231
 expression: values
 ---
 [

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__handshake_done.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__handshake_done.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     HandshakeDone(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_data.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_data.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     MaxData(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_stream_data.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_stream_data.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     MaxStreamData(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_streams.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__max_streams.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     MaxStreams(

diff --git a/...s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__new_connection_id.snap b/...s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__new_connection_id.snap
@@ -1,7 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
 expression: values
-
 ---
 [
     NewConnectionId(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__new_token.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__new_token.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     NewToken(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__padding.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__padding.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     Padding(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__path_challenge.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__path_challenge.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     PathChallenge(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__path_response.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__path_response.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     PathResponse(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__ping.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__ping.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     Ping(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__reset_stream.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__reset_stream.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     ResetStream(

diff --git a/...-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__retire_connection_id.snap b/...-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__retire_connection_id.snap
@@ -1,7 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
 expression: values
-
 ---
 [
     RetireConnectionId(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stop_sending.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stop_sending.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     StopSending(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stream.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stream.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     Stream(

diff --git a/...n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stream_data_blocked.snap b/...n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__stream_data_blocked.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     StreamDataBlocked(

diff --git a/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__streams_blocked.snap b/quic/s2n-quic-core/src/frame/snapshots/s2n_quic_core__frame__snapshots__streams_blocked.snap
@@ -1,6 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/frame/mod.rs
-expression: frames
+expression: values
 ---
 [
     StreamsBlocked(

diff --git a/...-core/src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumber.snap b/...-core/src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumber.snap
@@ -1,6 +1,5 @@
 ---
-source: quic/s2n-quic-core/src/packet/number/mod.rs
+source: quic/s2n-quic-core/src/packet/number/tests.rs
 expression: "size_of::<PacketNumber>()"
-
 ---
 8
diff --git a/...re/src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumberLen.snap b/...re/src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumberLen.snap
@@ -1,6 +1,5 @@
 ---
-source: quic/s2n-quic-core/src/packet/number/mod.rs
+source: quic/s2n-quic-core/src/packet/number/tests.rs
 expression: "size_of::<PacketNumberLen>()"
-
 ---
 2
diff --git a/.../src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumberSpace.snap b/.../src/packet/number/snapshots/s2n_quic_core__packet__number__tests__PacketNumberSpace.snap
@@ -1,6 +1,5 @@
 ---
-source: quic/s2n-quic-core/src/packet/number/mod.rs
+source: quic/s2n-quic-core/src/packet/number/tests.rs
 expression: "size_of::<PacketNumberSpace>()"
-
 ---
 1
diff --git a/.../packet/number/snapshots/s2n_quic_core__packet__number__tests__ProtectedPacketNumber.snap b/.../packet/number/snapshots/s2n_quic_core__packet__number__tests__ProtectedPacketNumber.snap
@@ -1,6 +1,5 @@
 ---
-source: quic/s2n-quic-core/src/packet/number/mod.rs
+source: quic/s2n-quic-core/src/packet/number/tests.rs
 expression: "size_of::<ProtectedPacketNumber>()"
-
 ---
 0
diff --git a/.../packet/number/snapshots/s2n_quic_core__packet__number__tests__TruncatedPacketNumber.snap b/.../packet/number/snapshots/s2n_quic_core__packet__number__tests__TruncatedPacketNumber.snap
@@ -1,6 +1,5 @@
 ---
-source: quic/s2n-quic-core/src/packet/number/mod.rs
+source: quic/s2n-quic-core/src/packet/number/tests.rs
 expression: "size_of::<TruncatedPacketNumber>()"
-
 ---
 12
diff --git a/quic/s2n-quic-core/src/packet/snapshots/s2n_quic_core__packet__snapshots__zero_rtt.snap b/quic/s2n-quic-core/src/packet/snapshots/s2n_quic_core__packet__snapshots__zero_rtt.snap
@@ -1,7 +1,6 @@
 ---
 source: quic/s2n-quic-core/src/packet/mod.rs
 expression: values
-
 ---
 [
     ZeroRtt(

diff --git a/quic/s2n-quic-core/src/probe.rs b/quic/s2n-quic-core/src/probe.rs
@@ -23,7 +23,7 @@ macro_rules! __probe_define__ {
                     name: stringify!($fun),
                     target: concat!(module_path!(), "::", stringify!($fun)),
                     $(
-                        ?$arg,
+                        $arg = ?$arg,
                     )*
                 );
 

diff --git a/...apshots/s2n_quic_core__recovery__simulation__MinimumWindow-CubicCongestionController.snap b/...apshots/s2n_quic_core__recovery__simulation__MinimumWindow-CubicCongestionController.snap
@@ -1,6 +1,5 @@
 ---
 source: quic/s2n-quic-core/src/recovery/simulation.rs
-assertion_line: 149
 expression: self
 ---
 Simulation {

diff --git a/...ts/s2n_quic_core__recovery__simulation__SlowStartUnlimited-CubicCongestionController.snap b/...ts/s2n_quic_core__recovery__simulation__SlowStartUnlimited-CubicCongestionController.snap
@@ -1,6 +1,5 @@
 ---
 source: quic/s2n-quic-core/src/recovery/simulation.rs
-assertion_line: 149
 expression: self
 ---
 Simulation {
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,7 @@ macro_rules! __probe_define__ { @@
                         name: stringify!($fun),
                         target: concat!(module_path!(), "::", stringify!($fun)),
                         $(
-                            ?$arg,
+                            $arg = ?$arg,
                         )*
                     );
@@ Expand Down @@