/
window.rs
265 lines (216 loc) · 7.6 KB
/
window.rs
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
use crate::{
adler32::{adler32, adler32_fold_copy},
allocate::Allocator,
crc32::Crc32Fold,
};
use std::mem::MaybeUninit;
// translation guide:
//
// wsize -> buf.capacity()
// wnext -> buf.ptr
// whave -> buf.filled.len()
#[derive(Debug)]
pub struct Window<'a> {
buf: &'a mut [MaybeUninit<u8>],
have: usize, // number of bytes logically written to the window. this can be higher than
// buf.len() if we run out of space in the window
next: usize, // write head
}
impl<'a> Window<'a> {
pub fn from_slice(slice: &'a mut [u8]) -> Self {
Self {
buf: unsafe { slice_to_uninit_mut(slice) },
have: 0,
next: 0,
}
}
pub fn is_empty(&self) -> bool {
self.buf.len() == 0
}
pub fn size(&self) -> usize {
self.buf.len()
}
/// number of bytes in the window. Saturates at `Self::capacity`.
pub fn have(&self) -> usize {
self.have
}
/// Position where the next byte will be written
pub fn next(&self) -> usize {
self.next
}
pub fn empty() -> Self {
Self::from_slice(&mut [])
}
pub fn clear(&mut self) {
self.have = 0;
self.next = 0;
}
pub fn copy(&self, copy: usize) -> &[u8] {
let start = if copy > self.next {
self.size() - (copy - self.next)
} else {
self.next - copy
};
// safety: the slice is always from the initialized part of buf
unsafe { slice_assume_init(&self.buf[start..self.have]) }
}
#[cfg(test)]
fn extend_adler32(&mut self, slice: &[u8], checksum: &mut u32) {
self.extend(slice, 0, true, checksum, &mut Crc32Fold::new());
}
pub fn extend(
&mut self,
slice: &[u8],
flags: i32,
update_checksum: bool,
checksum: &mut u32,
crc_fold: &mut Crc32Fold,
) {
let len = slice.len();
let wsize = self.size();
if len >= wsize {
// We have to split the checksum over non-copied and copied bytes
let pos = len.saturating_sub(self.size());
let (non_window_slice, window_slice) = slice.split_at(pos);
if update_checksum {
if flags != 0 {
crc_fold.fold(non_window_slice, 0);
crc_fold.fold_copy(self.buf, window_slice);
} else {
*checksum = adler32(*checksum, non_window_slice);
*checksum = adler32_fold_copy(*checksum, self.buf, window_slice);
}
} else {
self.buf
.copy_from_slice(unsafe { slice_to_uninit(window_slice) });
}
self.next = 0;
self.have = self.size();
} else {
let dist = Ord::min(wsize - self.next, slice.len());
// the end part goes onto the end of the window. The start part wraps around and is
// written to the start of the window.
let (end_part, start_part) = slice.split_at(dist);
if update_checksum {
let dst = &mut self.buf[self.next..][..end_part.len()];
if flags != 0 {
crc_fold.fold_copy(dst, end_part);
} else {
*checksum = adler32_fold_copy(*checksum, dst, end_part);
}
} else {
let end_part = unsafe { slice_to_uninit(end_part) };
self.buf[self.next..][..end_part.len()].copy_from_slice(end_part);
}
if !start_part.is_empty() {
if update_checksum {
let dst = &mut self.buf[..start_part.len()];
if flags != 0 {
crc_fold.fold_copy(dst, start_part);
} else {
*checksum = adler32_fold_copy(*checksum, dst, start_part);
}
} else {
let start_part = unsafe { slice_to_uninit(start_part) };
self.buf[..start_part.len()].copy_from_slice(start_part);
}
self.next = start_part.len();
self.have = self.size();
} else {
self.next += dist;
if self.next == self.size() {
self.next = 0;
}
if self.have < self.size() {
self.have += dist;
}
}
}
}
pub fn new_in(alloc: &Allocator<'a>, window_bits: usize) -> Option<Self> {
let buf = alloc.allocate_slice::<u8>((1 << window_bits) + Self::padding())?;
Some(Self {
buf,
have: 0,
next: 0,
})
}
pub fn clone_in(&self, alloc: &Allocator<'a>) -> Option<Self> {
let buf = alloc.allocate_slice::<u8>(self.buf.len())?;
Some(Self {
buf,
have: self.have,
next: self.next,
})
}
pub unsafe fn drop_in(mut self, alloc: &Allocator) {
if !self.buf.is_empty() {
let buf = core::mem::take(&mut self.buf);
alloc.deallocate(buf.as_mut_ptr(), buf.len());
}
}
// padding required so that SIMD operations going out-of-bounds are not a problem
pub fn padding() -> usize {
64 // very conservative
}
}
unsafe fn slice_to_uninit(slice: &[u8]) -> &[MaybeUninit<u8>] {
&*(slice as *const [u8] as *const [MaybeUninit<u8>])
}
unsafe fn slice_to_uninit_mut(slice: &mut [u8]) -> &mut [MaybeUninit<u8>] {
&mut *(slice as *mut [u8] as *mut [MaybeUninit<u8>])
}
// TODO: This could use `MaybeUninit::slice_assume_init` when it is stable.
unsafe fn slice_assume_init(slice: &[MaybeUninit<u8>]) -> &[u8] {
&*(slice as *const [MaybeUninit<u8>] as *const [u8])
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn extend_in_bounds() {
let mut checksum = 0;
let mut buf = [0; 12];
let mut window = Window::from_slice(&mut buf);
window.extend_adler32(&[1; 5], &mut checksum);
assert_eq!(window.have, 5);
assert_eq!(window.next, 5);
let slice = unsafe { slice_assume_init(window.buf) };
assert_eq!(&[1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0], slice);
window.extend_adler32(&[2; 7], &mut checksum);
assert_eq!(window.have, 12);
assert_eq!(window.next, 0);
let slice = unsafe { slice_assume_init(window.buf) };
assert_eq!(&[1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2], slice);
assert_eq!(checksum, 6946835);
}
#[test]
fn extend_crosses_bounds() {
let mut checksum = 0;
let mut buf = [0; 5];
let mut window = Window::from_slice(&mut buf);
window.extend_adler32(&[1; 3], &mut checksum);
assert_eq!(window.have, 3);
assert_eq!(window.next, 3);
let slice = unsafe { slice_assume_init(window.buf) };
assert_eq!(&[1, 1, 1, 0, 0], slice);
window.extend_adler32(&[2; 4], &mut checksum);
assert_eq!(window.have, 5);
assert_eq!(window.next, 2);
let slice = unsafe { slice_assume_init(window.buf) };
assert_eq!(&[2, 2, 1, 2, 2], slice);
assert_eq!(checksum, 2490379);
}
#[test]
fn extend_out_of_bounds() {
let mut checksum = 0;
let mut buf = [0; 5];
let mut window = Window::from_slice(&mut buf);
window.extend_adler32(&[1, 2, 3, 4, 5, 6, 7], &mut checksum);
assert_eq!(window.have, 5);
assert_eq!(window.next, 0);
let slice = unsafe { slice_assume_init(window.buf) };
assert_eq!(&[3, 4, 5, 6, 7], slice);
assert_eq!(checksum, 5505052);
}
}