]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
QUIC: Glossary updates
authorHugo Landau <hlandau@openssl.org>
Mon, 13 May 2024 19:20:23 +0000 (20:20 +0100)
committerNeil Horman <nhorman@openssl.org>
Mon, 17 Feb 2025 16:27:33 +0000 (11:27 -0500)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25416)

doc/designs/quic-design/glossary.md

index ffd2fa0193384bb68f0eddbe08c9d94ae66a13e3..50a9d5ae2f7fa4773e75a7a458cf7031ca4d5842 100644 (file)
@@ -21,28 +21,28 @@ stream.
 **CC:** Congestion controller. Estimates network channel capacity and imposes
 limits on transmissions accordingly.
 
-**CFQ:** Control Frame Queue. Considered part of the FIFM, this implements
-the CFQ strategy for frame in flight management. For details, see FIFM
-design document.
+**CFQ:** Control Frame Queue. Considered part of the FIFM, this implements the
+GCR strategy for frame in flight management. For details, see FIFM design
+document.
 
 **Channel:** See `QUIC_CHANNEL`.
 
 **CID:** Connection ID.
 
-**CMPL:** The maximum number of bytes left to serialize another QUIC packet into
-the same datagram as one or more previous packets. This is just the MDPL minus
-the total size of all previous packets already serialized into to the same
-datagram.
+**CMPL:** Coalescing Maximum Packet Length. The maximum number of bytes left to
+serialize another QUIC packet into the same datagram as one or more previous
+packets. This is just the MDPL minus the total size of all previous packets
+already serialized into to the same datagram.
 
-**CMPPL:** The maximum number of payload bytes we can put in the payload of
-another QUIC packet which is to be coalesced with one or more previous QUIC
-packets and placed into the same datagram. Essentially, this is the room we have
-left for another packet payload.
+**CMPPL:** Coalescing Maximum Packet Payload Length. The maximum number of
+payload bytes we can put in the payload of another QUIC packet which is to be
+coalesced with one or more previous QUIC packets and placed into the same
+datagram. Essentially, this is the room we have left for another packet payload.
 
 **CSM:** Connection state machine. Refers to some aspects of a QUIC channel. Not
 implemented as an explicit state machine.
 
-**DCID:** Destination Connection ID. Found in most QUIC packet headers.
+**DCID:** Destination Connection ID. Found in all QUIC packet headers.
 
 **DEMUX:** The demuxer routes incoming packets to the correct connection QRX by
 DCID.
@@ -72,7 +72,7 @@ retransmitted if necessary. Comprises the CFQ, TXPIM and FIFD.
 
 **GCR:** Generic Control Frame Retransmission. A strategy for regenerating lost
 frames. Stores raw frame in a queue so that it can be retransmitted if lost. See
-FIFM design document for details.
+FIFM design document for details. Implemented by the CFQ.
 
 **Key epoch:** Non-negative number designating a generation of QUIC keys used to
 encrypt or decrypt packets, starting at 0. This increases by 1 when a QUIC key
@@ -105,27 +105,28 @@ is also the maximum size of a single QUIC packet if we place only one packet in
 a datagram. The MDPL may vary based on both local source IP and destination IP
 due to different path MTUs.
 
-**MinDPL:** In some cases we must ensure a datagram has a minimum size of a
-certain number of bytes. This does not need to be accomplished with a single
-packet, but we may need to add PADDING frames to the final packet added to a
-datagram in this case.
+**MinDPL:** Minimum Datagram Payload Length. In some cases we must ensure a
+datagram has a minimum size of a certain number of bytes. This does not need to
+be accomplished with a single packet, but we may need to add PADDING frames to
+the final packet added to a datagram in this case.
 
-**MinPL:** The minimum serialized packet length we are using while serializing a
-given packet. May often be 0. Used to meet MinDPL requirements, and thus equal
-to MinDPL minus the length of any packets we have already encoded into the
-datagram.
+**MinPL:** Minimum Packet Length. The minimum serialized packet length we are
+using while serializing a given packet. May often be 0. Used to meet MinDPL
+requirements, and thus equal to MinDPL minus the length of any packets we have
+already encoded into the datagram.
 
-**MinPPL:** The minimum number of bytes which must be placed into a packet
-payload in order to meet the MinPL minimum size when the packet is encoded.
+**MinPPL:** Minimum Packet Payload Length. The minimum number of bytes which
+must be placed into a packet payload in order to meet the MinPL minimum size
+when the packet is encoded.
 
 **MPL:** Maximum Packet Length. The maximum size of a fully encrypted and
 serialized QUIC packet in bytes in some given context. Typically equal to the
 MDPL and never greater than it.
 
-**MPPL:** The maximum number of plaintext bytes we can put in the payload of a
-QUIC packet. This is related to the MDPL by the size of the encoded header and
-the size of any AEAD authentication tag which will be attached to the
-ciphertext.
+**MPPL:** Maximum Packet Payload Length. The maximum number of plaintext bytes
+we can put in the payload of a QUIC packet. This is related to the MDPL by the
+size of the encoded header and the size of any AEAD authentication tag which
+will be attached to the ciphertext.
 
 **MSMT:** Multi-stream multi-thread. Refers to a type of multi-stream QUIC usage
 in which API calls can be made on different threads.
@@ -159,8 +160,9 @@ This may be a QCSO or a QLSO. See [the server API design](server/quic-server-api
 `SSL_new` using a QUIC method, or by a QLSO.
 
 **QCTX**: QUIC Context. This is a utility object defined within the QUIC APL
-which helps to unwrap an SSL object pointer (a QCSO or QSSO) into the relevant
-structure pointers such as `QUIC_CONNECTION` or `QUIC_XSO`.
+which helps to unwrap an SSL object pointer (a QLSO, QCSO or QSSO) into the
+relevant structure pointers such as `QUIC_LISTENER`, `QUIC_CONNECTION` or
+`QUIC_XSO`.
 
 **QL:** See `QUIC_LISTENER`.
 
@@ -264,8 +266,9 @@ Causes a solicited TXKU. See also TXKU.
 
 **RXL:** RXE list. See RXE.
 
-**RCMPPL:** The number of bytes left in a packet whose payload we are currently
-forming. This is the CMPPL minus any bytes we have already put into the payload.
+**RCMPPL:** Remaining CMPPL. The number of bytes left in a packet whose payload
+we are currently forming. This is the CMPPL minus any bytes we have already put
+into the payload.
 
 **SCID:** Source Connection ID. Found in some QUIC packet headers.
 
@@ -282,7 +285,7 @@ transmitted, or not yet been acknowledged.
 
 **TA:** Thread assisted mode.
 
-**TPARAM:** Transport parameter.  See RFC 9000.
+**TPARAM:** Transport parameter. See RFC 9000.
 
 **TSERVER:** Test server. Internal test server object built around a channel.