1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
use std::borrow::Borrow;
use std::convert::TryInto;
use std::fs::File;
use std::io::{self, BufRead, Read, Seek, SeekFrom};
#[cfg(target_family = "unix")]
use std::os::unix::fs::FileExt;
#[track_caller]
fn to_usize(x: u64) -> usize {
x.try_into().expect("u64->usize overflow")
}
pub struct BoundedReader<R> {
reader: R,
start: u64,
length: u64,
pos: Option<u64>,
}
impl<R> BoundedReader<R> {
pub fn new(reader: R, start: u64, length: u64) -> Self {
BoundedReader {
reader,
start,
length,
pos: None,
}
}
pub(crate) fn empty(reader: R) -> Self {
BoundedReader {
reader,
start: 0,
length: 0,
pos: None,
}
}
pub fn len(&self) -> u64 {
self.length
}
}
impl<R> BoundedReader<R>
where
R: Read + Seek,
{
fn initialize_pos(&mut self) -> io::Result<u64> {
match &self.pos {
None => {
self.seek(SeekFrom::Start(0))?;
self.pos = Some(0);
Ok(0)
}
Some(p) => Ok(*p),
}
}
fn move_pos(&mut self, delta: usize) {
*self.pos.as_mut().expect("uninitialized pos") += delta as u64;
}
}
impl<R> Read for BoundedReader<R>
where
R: Read + Seek,
{
fn read(&mut self, mut buf: &mut [u8]) -> io::Result<usize> {
if self.length == 0 {
return Ok(0);
}
let pos = self.initialize_pos()?;
if pos == self.length {
return Ok(0);
}
if pos > self.length {
panic!("BoundedReader pos went out of bounds");
}
let max_len = self.length - pos;
if buf.len() as u64 > max_len {
buf = &mut buf[..to_usize(max_len)];
}
let bytes_read = self.reader.read(buf)?;
self.move_pos(bytes_read);
Ok(bytes_read)
}
}
impl<R> Seek for BoundedReader<R>
where
R: Seek,
{
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
fn seek_error() -> io::Error {
io::Error::new(io::ErrorKind::InvalidInput, "seek out of bounds")
}
let real_pos = match pos {
SeekFrom::Start(s) => self.start.checked_add(s).ok_or_else(seek_error)?,
SeekFrom::End(e) => {
let end = self.start + self.length;
let e: u64 = (-e).try_into().map_err(|_| seek_error())?;
end.checked_sub(e).ok_or_else(seek_error)?
}
SeekFrom::Current(c) => {
let real_pos = self.reader.stream_position()?;
let real_pos: i64 = real_pos.try_into().map_err(|_| seek_error())?;
let real_pos = real_pos.checked_add(c).ok_or_else(seek_error)?;
let real_pos: u64 = real_pos.try_into().map_err(|_| seek_error())?;
real_pos
}
};
if real_pos > self.start + self.length {
return Err(seek_error());
}
self.reader.seek(SeekFrom::Start(real_pos)).map(|new_pos| {
let bounded_pos = new_pos
.checked_sub(self.start)
.expect("allowed seek to bad position");
self.pos = Some(bounded_pos);
bounded_pos
})
}
}
impl<R> BufRead for BoundedReader<R>
where
R: BufRead + Seek,
{
fn fill_buf(&mut self) -> io::Result<&[u8]> {
let pos = self.initialize_pos()?;
let buf = self.reader.fill_buf()?;
let max_len = self.length - pos;
if buf.len() as u64 > max_len {
let max_len: usize = max_len.try_into().unwrap();
Ok(&buf[..max_len])
} else {
Ok(buf)
}
}
fn consume(&mut self, amt: usize) {
let max_len = self.length - self.pos.unwrap();
if amt as u64 > max_len {
panic!(
"consume({}) exceeds bound; only {} bytes until end",
amt, max_len
);
}
self.reader.consume(amt);
self.move_pos(amt);
}
}
#[cfg(target_family = "unix")]
impl<R> BoundedReader<R>
where
R: Borrow<File>,
{
fn cap_length(&self, len: usize, offset: u64) -> usize {
let bound_end = self.start.checked_add(self.length).unwrap();
if offset > bound_end {
return 0;
}
let requested_end = self.start + offset + len as u64;
let end_reduction = requested_end.saturating_sub(bound_end);
let end_reduction: usize = end_reduction.try_into().unwrap();
let capped_len: usize = len.checked_sub(end_reduction).unwrap();
capped_len
}
pub fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
let capped_len = self.cap_length(buf.len(), offset);
if capped_len == 0 {
return Ok(0);
}
let capped_buf = &mut buf[..capped_len];
let adjusted_offset = self.start.checked_add(offset).unwrap();
let f: &File = self.reader.borrow();
f.read_at(capped_buf, adjusted_offset)
}
pub fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> io::Result<()> {
let capped_len = self.cap_length(buf.len(), offset);
if capped_len != buf.len() {
return Err(io::Error::new(
io::ErrorKind::UnexpectedEof,
"BoundedReader read_exact_at exceeded bound",
));
}
let adjusted_offset = self.start.checked_add(offset).unwrap();
let f: &File = self.reader.borrow();
f.read_exact_at(buf, adjusted_offset)
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::{BufReader, Cursor, ErrorKind, Write};
#[test]
fn bounds_test() {
let mut buf = Vec::<u8>::new();
for ii in 0..128 {
buf.push(ii);
}
let mut cursor = Cursor::new(buf);
let mut subcursor = BoundedReader::new(&mut cursor, 5, 5);
let mut read_buf = [0u8; 8];
let bytes_read = subcursor.read(&mut read_buf).unwrap();
assert_eq!(bytes_read, 5);
assert_eq!(read_buf, [5, 6, 7, 8, 9, 0, 0, 0]);
subcursor.seek(SeekFrom::Start(5)).unwrap();
let mut read_buf = [0u8; 2];
let bytes_read = subcursor.read(&mut read_buf).unwrap();
assert_eq!(bytes_read, 0);
assert_eq!(read_buf, [0, 0]);
let err = subcursor.seek(SeekFrom::Start(6)).unwrap_err();
assert_eq!(err.kind(), ErrorKind::InvalidInput);
subcursor.seek(SeekFrom::End(-4)).unwrap();
let mut read_buf = [0u8; 4];
let bytes_read = subcursor.read(&mut read_buf).unwrap();
assert_eq!(bytes_read, 4);
assert_eq!(read_buf, [6, 7, 8, 9]);
subcursor.seek(SeekFrom::Current(-2)).unwrap();
subcursor.seek(SeekFrom::Current(-2)).unwrap();
let mut read_buf = [0u8; 4];
let bytes_read = subcursor.read(&mut read_buf).unwrap();
assert_eq!(bytes_read, 4);
assert_eq!(read_buf, [6, 7, 8, 9]);
}
#[test]
fn bufread() {
let mut buf = Vec::<u8>::new();
for ii in 0..128 {
buf.push(ii);
}
let cursor = Cursor::new(buf);
let mut bufreader = BufReader::new(cursor);
let mut reader = BoundedReader::new(&mut bufreader, 5, 5);
let buffered = reader.fill_buf().unwrap();
assert_eq!(buffered, [5, 6, 7, 8, 9]);
reader.consume(3);
let buffered = reader.fill_buf().unwrap();
assert_eq!(buffered, [8, 9]);
}
#[test]
fn read_at() {
let mut buf = Vec::<u8>::new();
for ii in 0..128 {
buf.push(ii);
}
let mut file = tempfile::tempfile().unwrap();
file.write_all(&buf).unwrap();
let reader = BoundedReader::new(file, 5, 5);
let mut read_buf = [0u8; 3];
let bytes_read = reader.read_at(&mut read_buf, 1).unwrap();
assert_eq!(bytes_read, 3);
assert_eq!(read_buf, [6, 7, 8]);
let mut read_buf = [0u8; 8];
let bytes_read = reader.read_at(&mut read_buf, 0).unwrap();
assert_eq!(bytes_read, 5);
assert_eq!(read_buf, [5, 6, 7, 8, 9, 0, 0, 0]);
let mut read_buf = [0u8; 2];
let bytes_read = reader.read_at(&mut read_buf, 5).unwrap();
assert_eq!(bytes_read, 0);
assert_eq!(read_buf, [0, 0]);
}
}