tokio_quiche/http3/
stats.rs

1// Copyright (C) 2025, Cloudflare, Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//
11//     * Redistributions in binary form must reproduce the above copyright
12//       notice, this list of conditions and the following disclaimer in the
13//       documentation and/or other materials provided with the distribution.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
16// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
17// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27use std::sync::atomic::AtomicI64;
28use std::sync::atomic::AtomicU64;
29use std::sync::atomic::Ordering;
30
31use crossbeam::atomic::AtomicCell;
32use datagram_socket::StreamClosureKind;
33
34/// Stream-level HTTP/3 audit statistics recorded by
35/// [H3Driver](crate::http3::driver::H3Driver).
36#[derive(Debug)]
37pub struct H3AuditStats {
38    /// The stream ID of this session.
39    stream_id: u64,
40    /// The number of bytes sent over the stream.
41    downstream_bytes_sent: AtomicU64,
42    /// The number of bytes received over the stream.
43    downstream_bytes_recvd: AtomicU64,
44    /// A STOP_SENDING error code received from the peer.
45    ///
46    /// -1 indicates that this error code was not received yet.
47    recvd_stop_sending_error_code: AtomicI64,
48    /// A RESET_STREAM error code received from the peer.
49    ///
50    /// -1 indicates that this error code was not received yet.
51    recvd_reset_stream_error_code: AtomicI64,
52    /// A STOP_SENDING error code sent to the peer.
53    ///
54    /// -1 indicates that this error code was not received yet.
55    sent_stop_sending_error_code: AtomicI64,
56    /// A RESET_STREAM error code sent to the peer.
57    ///
58    /// -1 indicates that this error code was not received yet.
59    sent_reset_stream_error_code: AtomicI64,
60    /// Stream FIN received from the peer.
61    recvd_stream_fin: AtomicCell<StreamClosureKind>,
62    /// Stream FIN sent to the peer.
63    sent_stream_fin: AtomicCell<StreamClosureKind>,
64}
65
66impl H3AuditStats {
67    pub fn new(stream_id: u64) -> Self {
68        Self {
69            stream_id,
70            downstream_bytes_sent: AtomicU64::new(0),
71            downstream_bytes_recvd: AtomicU64::new(0),
72            recvd_stop_sending_error_code: AtomicI64::new(-1),
73            recvd_reset_stream_error_code: AtomicI64::new(-1),
74            sent_stop_sending_error_code: AtomicI64::new(-1),
75            sent_reset_stream_error_code: AtomicI64::new(-1),
76            recvd_stream_fin: AtomicCell::new(StreamClosureKind::None),
77            sent_stream_fin: AtomicCell::new(StreamClosureKind::None),
78        }
79    }
80
81    /// The stream ID of this session.
82    #[inline]
83    pub fn stream_id(&self) -> u64 {
84        self.stream_id
85    }
86
87    /// The number of bytes sent over the stream.
88    #[inline]
89    pub fn downstream_bytes_sent(&self) -> u64 {
90        self.downstream_bytes_sent.load(Ordering::SeqCst)
91    }
92
93    /// The number of bytes received over the stream.
94    #[inline]
95    pub fn downstream_bytes_recvd(&self) -> u64 {
96        self.downstream_bytes_recvd.load(Ordering::SeqCst)
97    }
98
99    /// A STOP_SENDING error code received from the peer.
100    ///
101    /// -1 indicates that this error code was not received yet.
102    #[inline]
103    pub fn recvd_stop_sending_error_code(&self) -> i64 {
104        self.recvd_stop_sending_error_code.load(Ordering::SeqCst)
105    }
106
107    /// A RESET_STREAM error code received from the peer.
108    ///
109    /// -1 indicates that this error code was not received yet.
110    #[inline]
111    pub fn recvd_reset_stream_error_code(&self) -> i64 {
112        self.recvd_reset_stream_error_code.load(Ordering::SeqCst)
113    }
114
115    /// A STOP_SENDING error code sent to the peer.
116    ///
117    /// -1 indicates that this error code was not received yet.
118    #[inline]
119    pub fn sent_stop_sending_error_code(&self) -> i64 {
120        self.sent_stop_sending_error_code.load(Ordering::SeqCst)
121    }
122
123    /// A RESET_STREAM error code sent to the peer.
124    ///
125    /// -1 indicates that this error code was not received yet.
126    #[inline]
127    pub fn sent_reset_stream_error_code(&self) -> i64 {
128        self.sent_reset_stream_error_code.load(Ordering::SeqCst)
129    }
130
131    /// Stream FIN received from the peer.
132    #[inline]
133    pub fn recvd_stream_fin(&self) -> StreamClosureKind {
134        self.recvd_stream_fin.load()
135    }
136
137    /// Stream FIN sent to the peer.
138    #[inline]
139    pub fn sent_stream_fin(&self) -> StreamClosureKind {
140        self.sent_stream_fin.load()
141    }
142
143    #[inline]
144    pub fn add_downstream_bytes_sent(&self, bytes_sent: u64) {
145        self.downstream_bytes_sent
146            .fetch_add(bytes_sent, Ordering::SeqCst);
147    }
148
149    #[inline]
150    pub fn add_downstream_bytes_recvd(&self, bytes_recvd: u64) {
151        self.downstream_bytes_recvd
152            .fetch_add(bytes_recvd, Ordering::SeqCst);
153    }
154
155    #[inline]
156    pub fn set_recvd_stop_sending_error_code(
157        &self, recvd_stop_sending_error_code: i64,
158    ) {
159        self.recvd_stop_sending_error_code
160            .store(recvd_stop_sending_error_code, Ordering::SeqCst);
161    }
162
163    #[inline]
164    pub fn set_recvd_reset_stream_error_code(
165        &self, recvd_reset_stream_error_code: i64,
166    ) {
167        self.recvd_reset_stream_error_code
168            .store(recvd_reset_stream_error_code, Ordering::SeqCst);
169    }
170
171    #[inline]
172    pub fn set_sent_stop_sending_error_code(
173        &self, sent_stop_sending_error_code: i64,
174    ) {
175        self.sent_stop_sending_error_code
176            .store(sent_stop_sending_error_code, Ordering::SeqCst);
177    }
178
179    #[inline]
180    pub fn set_sent_reset_stream_error_code(
181        &self, sent_reset_stream_error_code: i64,
182    ) {
183        self.sent_reset_stream_error_code
184            .store(sent_reset_stream_error_code, Ordering::SeqCst);
185    }
186
187    #[inline]
188    pub fn set_recvd_stream_fin(&self, recvd_stream_fin: StreamClosureKind) {
189        self.recvd_stream_fin.store(recvd_stream_fin);
190    }
191
192    #[inline]
193    pub fn set_sent_stream_fin(&self, sent_stream_fin: StreamClosureKind) {
194        self.sent_stream_fin.store(sent_stream_fin);
195    }
196}
tokio_quiche/http3/stats.rs

tokio_quiche/http3/
stats.rs
