/rust/registry/src/index.crates.io-1949cf8c6b5b557f/rustls-0.23.35/src/vecbuf.rs
Line | Count | Source |
1 | | use alloc::collections::VecDeque; |
2 | | use alloc::vec::Vec; |
3 | | use core::{cmp, mem}; |
4 | | #[cfg(feature = "std")] |
5 | | use std::io; |
6 | | #[cfg(feature = "std")] |
7 | | use std::io::Read; |
8 | | |
9 | | #[cfg(feature = "std")] |
10 | | use crate::msgs::message::OutboundChunks; |
11 | | |
12 | | /// This is a byte buffer that is built from a deque of byte vectors. |
13 | | /// |
14 | | /// This avoids extra copies when appending a new byte vector, |
15 | | /// at the expense of more complexity when reading out. |
16 | | pub(crate) struct ChunkVecBuffer { |
17 | | /// How many bytes have been consumed in the first chunk. |
18 | | /// |
19 | | /// Invariant: zero if `chunks.is_empty()` |
20 | | /// Invariant: 0 <= `prefix_used` < `chunks[0].len()` |
21 | | prefix_used: usize, |
22 | | |
23 | | chunks: VecDeque<Vec<u8>>, |
24 | | |
25 | | /// The total upper limit (in bytes) of this object. |
26 | | limit: Option<usize>, |
27 | | } |
28 | | |
29 | | impl ChunkVecBuffer { |
30 | 0 | pub(crate) fn new(limit: Option<usize>) -> Self { |
31 | 0 | Self { |
32 | 0 | prefix_used: 0, |
33 | 0 | chunks: VecDeque::new(), |
34 | 0 | limit, |
35 | 0 | } |
36 | 0 | } |
37 | | |
38 | | /// Sets the upper limit on how many bytes this |
39 | | /// object can store. |
40 | | /// |
41 | | /// Setting a lower limit than the currently stored |
42 | | /// data is not an error. |
43 | | /// |
44 | | /// A [`None`] limit is interpreted as no limit. |
45 | 0 | pub(crate) fn set_limit(&mut self, new_limit: Option<usize>) { |
46 | 0 | self.limit = new_limit; |
47 | 0 | } |
48 | | |
49 | | /// If we're empty |
50 | 0 | pub(crate) fn is_empty(&self) -> bool { |
51 | 0 | self.chunks.is_empty() |
52 | 0 | } |
53 | | |
54 | | /// How many bytes we're storing |
55 | 0 | pub(crate) fn len(&self) -> usize { |
56 | 0 | self.chunks |
57 | 0 | .iter() |
58 | 0 | .fold(0usize, |acc, chunk| acc + chunk.len()) |
59 | 0 | - self.prefix_used |
60 | 0 | } |
61 | | |
62 | | /// For a proposed append of `len` bytes, how many |
63 | | /// bytes should we actually append to adhere to the |
64 | | /// currently set `limit`? |
65 | 0 | pub(crate) fn apply_limit(&self, len: usize) -> usize { |
66 | 0 | if let Some(limit) = self.limit { |
67 | 0 | let space = limit.saturating_sub(self.len()); |
68 | 0 | cmp::min(len, space) |
69 | | } else { |
70 | 0 | len |
71 | | } |
72 | 0 | } |
73 | | |
74 | | /// Take and append the given `bytes`. |
75 | 0 | pub(crate) fn append(&mut self, bytes: Vec<u8>) -> usize { |
76 | 0 | let len = bytes.len(); |
77 | | |
78 | 0 | if !bytes.is_empty() { |
79 | 0 | if self.chunks.is_empty() { |
80 | 0 | debug_assert_eq!(self.prefix_used, 0); |
81 | 0 | } |
82 | | |
83 | 0 | self.chunks.push_back(bytes); |
84 | 0 | } |
85 | | |
86 | 0 | len |
87 | 0 | } |
88 | | |
89 | | /// Take one of the chunks from this object. |
90 | | /// |
91 | | /// This function returns `None` if the object `is_empty`. |
92 | 0 | pub(crate) fn pop(&mut self) -> Option<Vec<u8>> { |
93 | 0 | let mut first = self.chunks.pop_front(); |
94 | | |
95 | 0 | if let Some(first) = &mut first { |
96 | 0 | // slice off `prefix_used` if needed (uncommon) |
97 | 0 | let prefix = mem::take(&mut self.prefix_used); |
98 | 0 | first.drain(0..prefix); |
99 | 0 | } |
100 | | |
101 | 0 | first |
102 | 0 | } |
103 | | |
104 | | #[cfg(read_buf)] |
105 | | /// Read data out of this object, writing it into `cursor`. |
106 | | pub(crate) fn read_buf(&mut self, mut cursor: core::io::BorrowedCursor<'_>) -> io::Result<()> { |
107 | | while !self.is_empty() && cursor.capacity() > 0 { |
108 | | let chunk = &self.chunks[0][self.prefix_used..]; |
109 | | let used = cmp::min(chunk.len(), cursor.capacity()); |
110 | | cursor.append(&chunk[..used]); |
111 | | self.consume(used); |
112 | | } |
113 | | |
114 | | Ok(()) |
115 | | } |
116 | | |
117 | | /// Inspect the first chunk from this object. |
118 | 0 | pub(crate) fn peek(&self) -> Option<&[u8]> { |
119 | 0 | self.chunks |
120 | 0 | .front() |
121 | 0 | .map(|ch| ch.as_slice()) |
122 | 0 | } |
123 | | } |
124 | | |
125 | | #[cfg(feature = "std")] |
126 | | impl ChunkVecBuffer { |
127 | 0 | pub(crate) fn is_full(&self) -> bool { |
128 | 0 | self.limit |
129 | 0 | .map(|limit| self.len() > limit) |
130 | 0 | .unwrap_or_default() |
131 | 0 | } |
132 | | |
133 | | /// Append a copy of `bytes`, perhaps a prefix if |
134 | | /// we're near the limit. |
135 | 0 | pub(crate) fn append_limited_copy(&mut self, payload: OutboundChunks<'_>) -> usize { |
136 | 0 | let take = self.apply_limit(payload.len()); |
137 | 0 | self.append(payload.split_at(take).0.to_vec()); |
138 | 0 | take |
139 | 0 | } |
140 | | |
141 | | /// Read data out of this object, writing it into `buf` |
142 | | /// and returning how many bytes were written there. |
143 | 0 | pub(crate) fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> { |
144 | 0 | let mut offs = 0; |
145 | | |
146 | 0 | while offs < buf.len() && !self.is_empty() { |
147 | 0 | let used = (&self.chunks[0][self.prefix_used..]).read(&mut buf[offs..])?; |
148 | | |
149 | 0 | self.consume(used); |
150 | 0 | offs += used; |
151 | | } |
152 | | |
153 | 0 | Ok(offs) |
154 | 0 | } |
155 | | |
156 | 0 | pub(crate) fn consume_first_chunk(&mut self, used: usize) { |
157 | | // this backs (infallible) `BufRead::consume`, where `used` is |
158 | | // user-supplied. |
159 | 0 | assert!( |
160 | 0 | used <= self |
161 | 0 | .chunk() |
162 | 0 | .map(|ch| ch.len()) |
163 | 0 | .unwrap_or_default(), |
164 | 0 | "illegal `BufRead::consume` usage", |
165 | | ); |
166 | 0 | self.consume(used); |
167 | 0 | } |
168 | | |
169 | 0 | fn consume(&mut self, used: usize) { |
170 | | // first, mark the rightmost extent of the used buffer |
171 | 0 | self.prefix_used += used; |
172 | | |
173 | | // then reduce `prefix_used` by discarding wholly-covered |
174 | | // buffers |
175 | 0 | while let Some(buf) = self.chunks.front() { |
176 | 0 | if self.prefix_used < buf.len() { |
177 | 0 | return; |
178 | 0 | } else { |
179 | 0 | self.prefix_used -= buf.len(); |
180 | 0 | self.chunks.pop_front(); |
181 | 0 | } |
182 | | } |
183 | | |
184 | 0 | debug_assert_eq!( |
185 | | self.prefix_used, 0, |
186 | 0 | "attempted to `ChunkVecBuffer::consume` more than available" |
187 | | ); |
188 | 0 | } |
189 | | |
190 | | /// Read data out of this object, passing it `wr` |
191 | 0 | pub(crate) fn write_to(&mut self, wr: &mut dyn io::Write) -> io::Result<usize> { |
192 | 0 | if self.is_empty() { |
193 | 0 | return Ok(0); |
194 | 0 | } |
195 | | |
196 | 0 | let mut prefix = self.prefix_used; |
197 | 0 | let mut bufs = [io::IoSlice::new(&[]); 64]; |
198 | 0 | for (iov, chunk) in bufs.iter_mut().zip(self.chunks.iter()) { |
199 | 0 | *iov = io::IoSlice::new(&chunk[prefix..]); |
200 | 0 | prefix = 0; |
201 | 0 | } |
202 | 0 | let len = cmp::min(bufs.len(), self.chunks.len()); |
203 | 0 | let bufs = &bufs[..len]; |
204 | 0 | let used = wr.write_vectored(bufs)?; |
205 | 0 | let available_bytes = bufs.iter().map(|ch| ch.len()).sum(); |
206 | | |
207 | 0 | if used > available_bytes { |
208 | | // This is really unrecoverable, since the amount of data written |
209 | | // is now unknown. Consume all the potentially-written data in |
210 | | // case the caller ignores the error. |
211 | | // See <https://github.com/rustls/rustls/issues/2316> for background. |
212 | 0 | self.consume(available_bytes); |
213 | 0 | return Err(io::Error::new( |
214 | 0 | io::ErrorKind::Other, |
215 | 0 | std::format!("illegal write_vectored return value ({used} > {available_bytes})"), |
216 | 0 | )); |
217 | 0 | } |
218 | 0 | self.consume(used); |
219 | 0 | Ok(used) |
220 | 0 | } |
221 | | |
222 | | /// Returns the first contiguous chunk of data, or None if empty. |
223 | 0 | pub(crate) fn chunk(&self) -> Option<&[u8]> { |
224 | 0 | self.chunks |
225 | 0 | .front() |
226 | 0 | .map(|chunk| &chunk[self.prefix_used..]) |
227 | 0 | } |
228 | | } |
229 | | |
230 | | #[cfg(all(test, feature = "std"))] |
231 | | mod tests { |
232 | | use alloc::vec; |
233 | | use alloc::vec::Vec; |
234 | | |
235 | | use super::ChunkVecBuffer; |
236 | | |
237 | | #[test] |
238 | | fn short_append_copy_with_limit() { |
239 | | let mut cvb = ChunkVecBuffer::new(Some(12)); |
240 | | assert_eq!(cvb.append_limited_copy(b"hello"[..].into()), 5); |
241 | | assert_eq!(cvb.append_limited_copy(b"world"[..].into()), 5); |
242 | | assert_eq!(cvb.append_limited_copy(b"hello"[..].into()), 2); |
243 | | assert_eq!(cvb.append_limited_copy(b"world"[..].into()), 0); |
244 | | |
245 | | let mut buf = [0u8; 12]; |
246 | | assert_eq!(cvb.read(&mut buf).unwrap(), 12); |
247 | | assert_eq!(buf.to_vec(), b"helloworldhe".to_vec()); |
248 | | } |
249 | | |
250 | | #[test] |
251 | | fn read_byte_by_byte() { |
252 | | let mut cvb = ChunkVecBuffer::new(None); |
253 | | cvb.append(b"test fixture data".to_vec()); |
254 | | assert!(!cvb.is_empty()); |
255 | | for expect in b"test fixture data" { |
256 | | let mut byte = [0]; |
257 | | assert_eq!(cvb.read(&mut byte).unwrap(), 1); |
258 | | assert_eq!(byte[0], *expect); |
259 | | } |
260 | | |
261 | | assert_eq!(cvb.read(&mut [0]).unwrap(), 0); |
262 | | } |
263 | | |
264 | | #[test] |
265 | | fn every_possible_chunk_interleaving() { |
266 | | let input = (0..=0xffu8) |
267 | | .cycle() |
268 | | .take(4096) |
269 | | .collect::<Vec<u8>>(); |
270 | | |
271 | | for input_chunk_len in 1..64usize { |
272 | | for output_chunk_len in 1..65usize { |
273 | | std::println!("check input={input_chunk_len} output={output_chunk_len}"); |
274 | | let mut cvb = ChunkVecBuffer::new(None); |
275 | | for chunk in input.chunks(input_chunk_len) { |
276 | | cvb.append(chunk.to_vec()); |
277 | | } |
278 | | |
279 | | assert_eq!(cvb.len(), input.len()); |
280 | | let mut buf = vec![0u8; output_chunk_len]; |
281 | | |
282 | | for expect in input.chunks(output_chunk_len) { |
283 | | assert_eq!(expect.len(), cvb.read(&mut buf).unwrap()); |
284 | | assert_eq!(expect, &buf[..expect.len()]); |
285 | | } |
286 | | |
287 | | assert_eq!(cvb.read(&mut [0]).unwrap(), 0); |
288 | | } |
289 | | } |
290 | | } |
291 | | |
292 | | #[cfg(read_buf)] |
293 | | #[test] |
294 | | fn read_buf() { |
295 | | use core::io::BorrowedBuf; |
296 | | use core::mem::MaybeUninit; |
297 | | |
298 | | { |
299 | | let mut cvb = ChunkVecBuffer::new(None); |
300 | | cvb.append(b"test ".to_vec()); |
301 | | cvb.append(b"fixture ".to_vec()); |
302 | | cvb.append(b"data".to_vec()); |
303 | | |
304 | | let mut buf = [MaybeUninit::<u8>::uninit(); 8]; |
305 | | let mut buf: BorrowedBuf<'_> = buf.as_mut_slice().into(); |
306 | | cvb.read_buf(buf.unfilled()).unwrap(); |
307 | | assert_eq!(buf.filled(), b"test fix"); |
308 | | buf.clear(); |
309 | | cvb.read_buf(buf.unfilled()).unwrap(); |
310 | | assert_eq!(buf.filled(), b"ture dat"); |
311 | | buf.clear(); |
312 | | cvb.read_buf(buf.unfilled()).unwrap(); |
313 | | assert_eq!(buf.filled(), b"a"); |
314 | | } |
315 | | |
316 | | { |
317 | | let mut cvb = ChunkVecBuffer::new(None); |
318 | | cvb.append(b"short message".to_vec()); |
319 | | |
320 | | let mut buf = [MaybeUninit::<u8>::uninit(); 1024]; |
321 | | let mut buf: BorrowedBuf<'_> = buf.as_mut_slice().into(); |
322 | | cvb.read_buf(buf.unfilled()).unwrap(); |
323 | | assert_eq!(buf.filled(), b"short message"); |
324 | | } |
325 | | } |
326 | | } |
327 | | |
328 | | #[cfg(bench)] |
329 | | mod benchmarks { |
330 | | use alloc::vec; |
331 | | |
332 | | use super::ChunkVecBuffer; |
333 | | |
334 | | #[bench] |
335 | | fn read_one_byte_from_large_message(b: &mut test::Bencher) { |
336 | | b.iter(|| { |
337 | | let mut cvb = ChunkVecBuffer::new(None); |
338 | | cvb.append(vec![0u8; 16_384]); |
339 | | assert_eq!(1, cvb.read(&mut [0u8]).unwrap()); |
340 | | }); |
341 | | } |
342 | | |
343 | | #[bench] |
344 | | fn read_all_individual_from_large_message(b: &mut test::Bencher) { |
345 | | b.iter(|| { |
346 | | let mut cvb = ChunkVecBuffer::new(None); |
347 | | cvb.append(vec![0u8; 16_384]); |
348 | | loop { |
349 | | if let Ok(0) = cvb.read(&mut [0u8]) { |
350 | | break; |
351 | | } |
352 | | } |
353 | | }); |
354 | | } |
355 | | |
356 | | #[bench] |
357 | | fn read_half_bytes_from_large_message(b: &mut test::Bencher) { |
358 | | b.iter(|| { |
359 | | let mut cvb = ChunkVecBuffer::new(None); |
360 | | cvb.append(vec![0u8; 16_384]); |
361 | | assert_eq!(8192, cvb.read(&mut [0u8; 8192]).unwrap()); |
362 | | assert_eq!(8192, cvb.read(&mut [0u8; 8192]).unwrap()); |
363 | | }); |
364 | | } |
365 | | |
366 | | #[bench] |
367 | | fn read_entire_large_message(b: &mut test::Bencher) { |
368 | | b.iter(|| { |
369 | | let mut cvb = ChunkVecBuffer::new(None); |
370 | | cvb.append(vec![0u8; 16_384]); |
371 | | assert_eq!(16_384, cvb.read(&mut [0u8; 16_384]).unwrap()); |
372 | | }); |
373 | | } |
374 | | } |