Skip to content

Commit a4bf6a0

Browse files
author
ID Bot
committed
Script updating gh-pages from 2dc5db8. [ci skip]
1 parent a66b0aa commit a4bf6a0

File tree

3 files changed

+62
-23
lines changed

3 files changed

+62
-23
lines changed

draft-ietf-quic-qlog-quic-events.html

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3993,37 +3993,55 @@ <h3 id="name-packetnumberspace">
39933993
<h3 id="name-packetheader">
39943994
<a href="#section-8.8" class="section-number selfRef">8.8. </a><a href="#name-packetheader" class="section-name selfRef">PacketHeader</a>
39953995
</h3>
3996-
<p id="section-8.8-1">If the packet_type numerical value does not map to a known packet_type string,
3997-
the packet_type value of "unknown" can be used and the raw value captured in the
3998-
packet_type_bytes field; a numerical value without variable-length integer
3999-
encoding.<a href="#section-8.8-1" class="pilcrow"></a></p>
4000-
<p id="section-8.8-2">For long header packets of type initial, handshake, and 0RTT, the length field
3996+
<p id="section-8.8-1">If the <code>packet_type</code> numerical value does not map to a known <code>$PacketType</code>
3997+
string, the <code>packet_type</code> value of "unknown" can be used and the raw value
3998+
captured in the <code>packet_type_bytes</code> field; a numerical value without
3999+
variable-length integer encoding.<a href="#section-8.8-1" class="pilcrow"></a></p>
4000+
<p id="section-8.8-2">The fixed and reserved bits are omitted here because they must be 0; see
4001+
<span>[<a href="#QUIC-TRANSPORT" class="cite xref">QUIC-TRANSPORT</a>]</span>. If these bits have an invalid value, the raw values can be
4002+
captured in the <code>raw.data</code> field of the event logging the PacketHeader.<a href="#section-8.8-2" class="pilcrow"></a></p>
4003+
<p id="section-8.8-3">QUIC extensions that do utilize these bits are expected to create new events
4004+
(analogous to <code>spin_bit_updated</code>) or use qlog extension mechanisms to reflect
4005+
that usage.<a href="#section-8.8-3" class="pilcrow"></a></p>
4006+
<p id="section-8.8-4">For long header packets of type initial, handshake, and 0RTT, the length field
40014007
of the packet header is logged in the qlog <code>raw.length</code> field, and the value
4002-
signifies the length of the packet number plus the payload.<a href="#section-8.8-2" class="pilcrow"></a></p>
4008+
signifies the length of the packet number plus the payload.<a href="#section-8.8-4" class="pilcrow"></a></p>
40034009
<span id="name-packetheader-definition"></span><div id="packetheader-def">
40044010
<figure id="figure-46">
4005-
<div class="lang-cddl sourcecode" id="section-8.8-3.1">
4011+
<div class="lang-cddl sourcecode" id="section-8.8-5.1">
40064012
<pre>
40074013
PacketHeader = {
4008-
? quic_bit: bool .default true
40094014
packet_type: $PacketType
40104015

40114016
; only if packet_type === "unknown"
40124017
? packet_type_bytes: uint64
40134018

4019+
; only if packet_type === "1RTT"
4020+
? spin_bit: bool
4021+
4022+
; only if packet_type === "1RTT", and if the key phase was
4023+
; determined from the key_phase_bit
4024+
? key_phase: uint64
4025+
4026+
; only if packet_type === "1RTT", and if key_phase is not set
4027+
? key_phase_bit: bool
4028+
40144029
; only if packet_type === "initial" || "handshake" || "0RTT" ||
40154030
; "1RTT"
4016-
? packet_number: uint64
4031+
? packet_number_length: uint8
40174032

4018-
; the bit flags of the packet headers (spin bit, key update bit,
4019-
; etc. up to and including the packet number length bits
4020-
; if present
4021-
? flags: uint8
4033+
; only if packet_type === "initial" || "handshake" || "0RTT" ||
4034+
; "1RTT"
4035+
? packet_number: uint64
40224036

40234037
; only if packet_type === "initial" || "retry"
40244038
? token: Token
40254039

4026-
; only if present in the header
4040+
; only if packet_type === "initial" || "handshake" || "0RTT"
4041+
; Signifies length of the packet_number plus the payload
4042+
? length: uint16
4043+
4044+
; only if present in the header.
40274045
; if correctly using transport:connection_id_updated events,
40284046
; dcid can be skipped for 1RTT packets
40294047
? version: QuicVersion

draft-ietf-quic-qlog-quic-events.txt

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2044,35 +2044,56 @@ Table of Contents
20442044
8.8. PacketHeader
20452045

20462046
If the packet_type numerical value does not map to a known
2047-
packet_type string, the packet_type value of "unknown" can be used
2047+
$PacketType string, the packet_type value of "unknown" can be used
20482048
and the raw value captured in the packet_type_bytes field; a
20492049
numerical value without variable-length integer encoding.
20502050

2051+
The fixed and reserved bits are omitted here because they must be 0;
2052+
see [QUIC-TRANSPORT]. If these bits have an invalid value, the raw
2053+
values can be captured in the raw.data field of the event logging the
2054+
PacketHeader.
2055+
2056+
QUIC extensions that do utilize these bits are expected to create new
2057+
events (analogous to spin_bit_updated) or use qlog extension
2058+
mechanisms to reflect that usage.
2059+
20512060
For long header packets of type initial, handshake, and 0RTT, the
20522061
length field of the packet header is logged in the qlog raw.length
20532062
field, and the value signifies the length of the packet number plus
20542063
the payload.
20552064

20562065
PacketHeader = {
2057-
? quic_bit: bool .default true
20582066
packet_type: $PacketType
20592067

20602068
; only if packet_type === "unknown"
20612069
? packet_type_bytes: uint64
20622070

2071+
; only if packet_type === "1RTT"
2072+
? spin_bit: bool
2073+
2074+
; only if packet_type === "1RTT", and if the key phase was
2075+
; determined from the key_phase_bit
2076+
? key_phase: uint64
2077+
2078+
; only if packet_type === "1RTT", and if key_phase is not set
2079+
? key_phase_bit: bool
2080+
20632081
; only if packet_type === "initial" || "handshake" || "0RTT" ||
20642082
; "1RTT"
2065-
? packet_number: uint64
2083+
? packet_number_length: uint8
20662084

2067-
; the bit flags of the packet headers (spin bit, key update bit,
2068-
; etc. up to and including the packet number length bits
2069-
; if present
2070-
? flags: uint8
2085+
; only if packet_type === "initial" || "handshake" || "0RTT" ||
2086+
; "1RTT"
2087+
? packet_number: uint64
20712088

20722089
; only if packet_type === "initial" || "retry"
20732090
? token: Token
20742091

2075-
; only if present in the header
2092+
; only if packet_type === "initial" || "handshake" || "0RTT"
2093+
; Signifies length of the packet_number plus the payload
2094+
? length: uint16
2095+
2096+
; only if present in the header.
20762097
; if correctly using transport:connection_id_updated events,
20772098
; dcid can be skipped for 1RTT packets
20782099
? version: QuicVersion

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ <h2>Preview for branch <a href="packet-header">packet-header</a></h2>
395395
<tr>
396396
<td><a href="packet-header/draft-ietf-quic-qlog-quic-events.html" class="html draft-ietf-quic-qlog-quic-events" title="QUIC event definitions for qlog (HTML)">QUIC event definitions for qlog</a></td>
397397
<td><a href="packet-header/draft-ietf-quic-qlog-quic-events.txt" class="txt draft-ietf-quic-qlog-quic-events" title="QUIC event definitions for qlog (Text)">plain text</a></td>
398-
<td><a href="https://author-tools.ietf.org/api/iddiff?url_1=https://quicwg.github.io/qlog/draft-ietf-quic-qlog-quic-events.txt&amp;url_2=https://quicwg.github.io/qlog/packet-header/draft-ietf-quic-qlog-quic-events.txt" class="diff draft-ietf-quic-qlog-quic-events">diff with main</a></td>
398+
<td>same as main</td>
399399
</tr>
400400
</table>
401401
<h2>Preview for branch <a href="capsule">capsule</a></h2>

0 commit comments

Comments
 (0)