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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
/*!
This library provides encoding/decoding primitives for Stream VByte encoding.
Stream VByte encoding is a SIMD accelerated algorithm of varint decompression. It is used in a search and database
systems as a way of efficiently store and stream large number of variable length integers from a disk or main memory.
The idea behind varint is to skip leading zero bytes of the number, so large amount of relatively small numbers can be
stored eficiently. Varint encoding is frequently used with delta-encoding if numbers are stored in the
ascending order. This way all the numbers are smaller by magnitude, hence better compression.
Stream VByte is a storage format and an algorithm which allows to vectorize compressing and decompressing of numbers
on a modern CPUs.
Main types of this crate are [`DecodeCursor`] and [`EncodeCursor`].
## Encoding
```rust,no_run
# use std::io::BufWriter;
# use std::fs::File;
# use svbyte::EncodeCursor;
# use std::io::{self, Write};
# fn main() -> io::Result<()> {
let output = BufWriter::new(File::create("./encoded.bin")?);
let mut encoder = EncodeCursor::new(output);
encoder.encode(&[1, 2, 3, 4]);
encoder.finish()?.flush()?;
# Ok(())
# }
```
## Decoding
```rust,no_run
# use std::fs::File;
# use std::io::{self, BufReader};
# use svbyte::{BufReadSegments, DecodeCursor, Decoder};
# fn main() -> io::Result<()> {
let segments = BufReadSegments::new(BufReader::new(File::open("./encoded.bin")?));
let mut decoder = DecodeCursor::new(segments)?;
let mut buffer = [0u32; 128];
let mut sum = 0u64;
loop {
let decoded = decoder.decode(&mut buffer)?;
if decoded == 0 {
break;
}
sum += buffer[..decoded].iter().sum::<u32>() as u64;
}
# Ok(())
# }
```
## Links
- [Stream VByte: Faster Byte-Oriented Integer Compression][pub] by Daniel Lemire, Nathan Kurz, and Christoph Rupp
- [Stream VByte: breaking new speed records for integer compression][blog-post] by Daniel Lemire
[pub]: https://arxiv.org/abs/1709.08990
[blog-post]: https://lemire.me/blog/2017/09/27/stream-vbyte-breaking-new-speed-records-for-integer-compression/
*/
use std::{
arch::x86_64::{_mm_loadu_si128, _mm_shuffle_epi8, _mm_storeu_si128},
debug_assert,
io::{self, BufRead, Write},
mem,
};
#[allow(non_camel_case_types)]
type u32x4 = [u32; 4];
/// Shuffle masks and correspinding length of encoded numbers
///
/// For more information see documentation to [`u32_shuffle_masks`]
///
/// [`u32_shuffle_masks`]: u32_shuffle_masks
const MASKS: [(u32x4, u8); 256] = u32_shuffle_masks();
/// Marker bytes of a [`SegmentHeader`]
const SEGMENT_MAGIC: u16 = 0x0B0D;
/// Lenth of [`SegmentHeader`] in bytes
const SEGMENT_HEADER_LENGTH: usize = 14;
/// Provides facility for reading segments
///
/// Each segment contains elements (integers) in encoded format. Each [`Segments::next`] method call
/// moves this objects to the next segment.
///
/// ## Motivation
/// This trait exists to abstract [`DecodeCursor`] from logic of reading segments. If all the segments are
/// in memory the most efficient way of decoding is decoding `[u8]` slices in memory. This maximize the
/// decoding speed because no memory copy is needed. In case segments data are on the file system,
/// some logic for reading next segment in a memory buffer is required. In this case it's more
/// appropriate to read segments one by one in a memory buffer of a predefined size. [`Segments`] trait
/// and its 2 base implementations: [`MemorySegments`] and [`BufReadSegments`] are providing those facilities.
pub trait Segments {
/// Moves to the next segment and return number of the elements encoded in the segment
fn next(&mut self) -> io::Result<usize>;
/// Returns the current segment's data stream
fn data_stream(&self) -> &[u8];
/// Returns the current segment's control stream
fn control_stream(&self) -> &[u8];
}
/// Reads a segment from an underlying [`BufRead`]
pub struct BufReadSegments<R> {
source: R,
control_stream: Vec<u8>,
data_stream: Vec<u8>,
}
impl<R> BufReadSegments<R> {
pub fn new(source: R) -> Self {
Self {
source,
control_stream: vec![],
data_stream: vec![],
}
}
}
impl<R: BufRead> Segments for BufReadSegments<R> {
fn next(&mut self) -> io::Result<usize> {
let result = read_segment(
&mut self.source,
&mut self.control_stream,
&mut self.data_stream,
);
match result {
Ok(elements) => Ok(elements),
Err(e) => {
if e.kind() == io::ErrorKind::UnexpectedEof {
Ok(0)
} else {
Err(e)
}
}
}
}
fn data_stream(&self) -> &[u8] {
self.control_stream.as_ref()
}
fn control_stream(&self) -> &[u8] {
self.data_stream.as_ref()
}
}
/// [`Segments`] implementation with all segment data in memory
pub struct MemorySegments<'a> {
data: &'a [u8],
control_stream: &'a [u8],
data_stream: &'a [u8],
}
impl<'a> MemorySegments<'a> {
pub fn new(data: &'a [u8]) -> Self {
Self {
data,
control_stream: &data[0..0],
data_stream: &data[0..0],
}
}
}
impl<'a> Segments for MemorySegments<'a> {
fn next(&mut self) -> io::Result<usize> {
if self.data.is_empty() {
return Ok(0);
}
let segment = SegmentHeader::parse(self.data);
self.control_stream =
&self.data[SEGMENT_HEADER_LENGTH..SEGMENT_HEADER_LENGTH + segment.cs_length];
self.data_stream = &self.data[SEGMENT_HEADER_LENGTH + segment.cs_length
..SEGMENT_HEADER_LENGTH + segment.cs_length + segment.ds_length];
self.data = &self.data[SEGMENT_HEADER_LENGTH + segment.cs_length + segment.ds_length..];
Ok(segment.count)
}
fn data_stream(&self) -> &[u8] {
self.data_stream
}
fn control_stream(&self) -> &[u8] {
self.control_stream
}
}
/// Decodes integers
///
/// Cursor allows to decode stream of elements using one of the [`Segments`] implementations as a source
/// of decoding data.
pub struct DecodeCursor<S: Segments> {
elements_left: usize,
control_stream_offset: usize,
data_stream_offset: usize,
segments: S,
}
impl<S: Segments> DecodeCursor<S> {
pub fn new(segments: S) -> io::Result<Self> {
Ok(Self {
elements_left: 0,
control_stream_offset: 0,
data_stream_offset: 0,
segments,
})
}
#[inline(never)]
fn refill(&mut self) -> io::Result<usize> {
debug_assert!(
self.elements_left == 0,
"Should be 0, got: {}",
self.elements_left
);
let elements = self.segments.next()?;
if elements > 0 {
let cs = self.segments.control_stream();
let ds = self.segments.data_stream();
assert!(
cs.len() * 4 >= elements,
"Invalid control stream length. Expected: {}, got: {}",
(elements + 3) / 4,
cs.len()
);
assert!(
ds.len() >= elements,
"Invalid data stream length. Expected: >={}, got: {}",
elements,
ds.len()
);
self.data_stream_offset = 0;
self.control_stream_offset = 0;
self.elements_left = elements;
}
Ok(elements)
}
}
/// Segment Header
///
/// Each segment starts with a header described in the [`EncodeCursor`] documentation.
#[derive(Debug, PartialEq)]
struct SegmentHeader {
count: usize,
cs_length: usize,
ds_length: usize,
}
impl SegmentHeader {
fn new(count: usize, cs_size: usize, ds_size: usize) -> Self {
Self {
count,
cs_length: cs_size,
ds_length: ds_size,
}
}
fn parse(input: &[u8]) -> Self {
assert!(
input.len() >= SEGMENT_HEADER_LENGTH,
"Expected slice of len >={}, got: {}",
SEGMENT_HEADER_LENGTH,
input.len()
);
let input = &input[..SEGMENT_HEADER_LENGTH];
let magic = u16::from_be_bytes(input[0..2].try_into().unwrap());
let count = u32::from_be_bytes(input[2..6].try_into().unwrap()) as usize;
let cs_length = u32::from_be_bytes(input[6..10].try_into().unwrap()) as usize;
let ds_length = u32::from_be_bytes(input[10..14].try_into().unwrap()) as usize;
assert!(
magic == SEGMENT_MAGIC,
"Expected magic: {}, got: {}",
SEGMENT_MAGIC,
magic,
);
Self {
count,
cs_length,
ds_length,
}
}
fn write(&self, out: &mut dyn Write) -> io::Result<()> {
out.write_all(&SEGMENT_MAGIC.to_be_bytes())?;
debug_assert!(self.count <= u32::MAX as usize);
let number_of_elements = (self.count as u32).to_be_bytes();
out.write_all(&number_of_elements)?;
debug_assert!(self.cs_length <= u32::MAX as usize);
let cs_len = (self.cs_length as u32).to_be_bytes();
out.write_all(&cs_len)?;
debug_assert!(self.ds_length <= u32::MAX as usize);
let ds_len = (self.ds_length as u32).to_be_bytes();
out.write_all(&ds_len)?;
Ok(())
}
}
/// Reads the segment, checks segment header and copies streams into corresponding buffers
///
/// Returns the number of elements encoded in the segment
fn read_segment(input: &mut impl BufRead, cs: &mut Vec<u8>, ds: &mut Vec<u8>) -> io::Result<usize> {
let mut buf = [0u8; SEGMENT_HEADER_LENGTH];
input.read_exact(&mut buf)?;
let header = SegmentHeader::parse(&buf);
cs.resize(header.cs_length, 0);
input.read_exact(&mut cs[..header.cs_length])?;
ds.resize(header.ds_length, 0);
input.read_exact(&mut ds[..header.ds_length])?;
Ok(header.count)
}
impl<S: Segments> Decoder<u32> for DecodeCursor<S> {
fn decode(&mut self, buffer: &mut [u32]) -> io::Result<usize> {
// Number of elements decoded per iteration
const DECODE_WIDTH: usize = 4;
assert!(
buffer.len() >= DECODE_WIDTH,
"Buffer should be at least {} elements long",
DECODE_WIDTH
);
if self.elements_left == 0 && self.refill()? == 0 {
return Ok(0);
}
let mut data_stream_offset = self.data_stream_offset;
let control_stream = &self.segments.control_stream()[self.control_stream_offset..];
let data_stream = &self.segments.data_stream()[data_stream_offset..];
let mut data_stream = data_stream.as_ptr();
/*
Safety considerations!
This code relies heavily on pointers. To make all pointer arithmetic safe several rules must be obeyed.
1. number of iterations should be limited by both output buffer length as well as the number of elements left
in the data and control streams
2. each iteration control stream and output buffer pointers are moved by 1. Therefore, all pointers should be
of the type which is consumed/produced in each iteration.
3. the only exception is the data stream whose type is `*const u8` because the data stream moved different
amounts of bytes each iteration.
*/
let mut iterations = buffer.len() / 4;
iterations = iterations.min(control_stream.len());
self.control_stream_offset += iterations;
let decoded = iterations * DECODE_WIDTH;
let mut buffer: *mut u32x4 = buffer.as_mut_ptr().cast();
let mut control_words = control_stream.as_ptr();
// Decode loop unrolling
const UNROLL_FACTOR: usize = 8;
while iterations >= UNROLL_FACTOR {
for _ in 0..UNROLL_FACTOR {
let encoded_len = unsafe {
debug_assert!(
self.segments.data_stream()[data_stream_offset..].len() >= 16,
"At least 16 bytes should be available in data stream"
);
let data_stream = mem::transmute(data_stream);
let output = mem::transmute(buffer);
simd_decode(data_stream, *control_words, output)
};
control_words = control_words.wrapping_add(1);
buffer = buffer.wrapping_add(1);
data_stream = data_stream.wrapping_add(encoded_len as usize);
data_stream_offset += encoded_len as usize;
}
iterations -= UNROLL_FACTOR;
}
// Tail decode
while iterations > 0 {
let encoded_len = unsafe {
debug_assert!(
self.segments.data_stream()[data_stream_offset..].len() >= 16,
"At least 16 bytes should be available in data stream"
);
let data_stream = mem::transmute(data_stream);
let output = mem::transmute(buffer);
simd_decode(data_stream, *control_words, output)
};
control_words = control_words.wrapping_add(1);
buffer = buffer.wrapping_add(1);
data_stream = data_stream.wrapping_add(encoded_len as usize);
data_stream_offset += encoded_len as usize;
iterations -= 1;
}
self.data_stream_offset = data_stream_offset;
let decoded = decoded.min(self.elements_left);
self.elements_left -= decoded;
Ok(decoded)
}
}
/// Decoding SIMD kernel using SSE intrinsics
///
/// Types of this function tries to implement safety guardrails as much as possible. Namely:
/// `output` - is a reference to the buffer of 4 u32 values;
/// `input` - is a reference to u8 array of unspecified length (`control_word` speciefies how much will be decoded);
//
/// Technically the encoded length can be calculated from control word directly using horizontal 2-bit sum
/// ```rust,ignore
/// let result = *control_word;
/// let result = ((result & 0b11001100) >> 2) + (result & 0b00110011);
/// let result = (result >> 4) + (result & 0b1111) + 4;
/// ```
/// Unfortunatley, this approach is slower then memoized length. There is a mention of this approach can be faster
/// when using `u32` control words, which implies decoding a batch of size 16[^1].
///
/// [^1]: [Bit hacking versus memoization: a Stream VByte example](https://lemire.me/blog/2017/11/28/bit-hacking-versus-memoization-a-stream-vbyte-example/)
#[inline]
fn simd_decode(input: &[u8; 16], control_word: u8, output: &mut u32x4) -> u8 {
let (ref mask, encoded_len) = MASKS[control_word as usize];
unsafe {
let mask = _mm_loadu_si128(mask.as_ptr().cast());
let input = _mm_loadu_si128(input.as_ptr().cast());
let answer = _mm_shuffle_epi8(input, mask);
_mm_storeu_si128(output.as_mut_ptr().cast(), answer);
}
encoded_len
}
/**
Prepares shuffle mask for decoding a single `u32` using `pshufb` instruction
`len` parameter is describing the length of decoded `u32` in the input register (1-4). `offset` parameter is
describing the base offset in the register. It is the sum of all previous number lengths loaded in the input register.
*/
const fn u32_shuffle_mask(len: usize, offset: usize) -> u32 {
const PZ: u8 = 0b10000000;
assert!(offset < 16, "Offset should be <16");
let offset = offset as u8;
let p1 = offset;
let p2 = offset + 1;
let p3 = offset + 2;
let p4 = offset + 3;
match len {
1 => u32::from_be_bytes([PZ, PZ, PZ, p1]),
2 => u32::from_be_bytes([PZ, PZ, p1, p2]),
3 => u32::from_be_bytes([PZ, p1, p2, p3]),
4 => u32::from_be_bytes([p1, p2, p3, p4]),
_ => panic!("Length of u32 is 1..=4 bytes"),
}
}
/**
Preparing shuffling masks for `pshufb` SSE instructions
`pshufb` (`_mm_shuffle_epi8()`) allows to shuffle bytes around in a `__mm128` register. Shuffle mask consist of 16
bytes. Each byte describe byte index in input register which should be copied to corresponding byte in the output
register. For addressing 16 bytes we need log(16) = 4 bits. So bits 0:3 of each byte are storing input register byte
index. MSB of each byte indicating if corresponding byte in output register should be zeroed out. 4 least significant
bits are non effective if MSB is set.
`pshufb` SSE instruction visualization.
```graph
Byte offsets: 0 1 2 3 4
┌────────┬────────┬────────┬────────┬────────┬───┐
Input Register: │ 0x03 │ 0x15 │ 0x22 │ 0x19 │ 0x08 │...│
└────▲───┴────────┴────▲───┴────▲───┴────▲───┴───┘
│ ┌────────┘ │ │
│ │ ┌─────────────────┘
│ │ │ │
└───────────────────────────────────┐
│ │ │ │
┌────────┬────┴───┬────┴───┬────┴───┬────┴───┬───┐
Mask Register: │ 0x80 │ 0x02 │ 0x04 │ 0x03 │ 0x00 │...│
├────────┼────────┼────────┼────────┼────────┼───┤
Output Register: │ 0x00 │ 0x22 │ 0x08 │ 0x19 │ 0x03 │...│
└────────┴────────┴────────┴────────┴────────┴───┘
```
See [`_mm_shuffle_epi8()`][_mm_shuffle_epi8] documentation.
[_mm_shuffle_epi8]: https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html#text=shuffle_epi8&ig_expand=6097
*/
const fn u32_shuffle_masks() -> [(u32x4, u8); 256] {
let mut masks = [([0u32; 4], 0u8); 256];
let mut a = 1;
while a <= 4 {
let mut b = 1;
while b <= 4 {
let mut c = 1;
while c <= 4 {
let mut d = 1;
while d <= 4 {
// Loading in reverse order because Intel is Little Endian Machine
let mask = [
u32_shuffle_mask(a, 0),
u32_shuffle_mask(b, a),
u32_shuffle_mask(c, a + b),
u32_shuffle_mask(d, a + b + c),
];
// counting in the index must be 0 based (eg. length of 1 is `00`, not `01`), hence `a - 1`
let idx = (a - 1) << 6 | (b - 1) << 4 | (c - 1) << 2 | (d - 1);
assert!(a + b + c + d <= 16);
masks[idx] = (mask, (a + b + c + d) as u8);
d += 1;
}
c += 1;
}
b += 1;
}
a += 1;
}
masks
}
/**
Stream VByte Encoder
Encodes a stream of numbers and saves them in a [`Write`] output stream.
Data format follows this structure:
```diagram
┌───────┬───────┬─────────┬─────────┬────────┬────────┐
│ MAGIC │ COUNT │ CS SIZE │ DS SIZE │ CS ... │ DS ... │
└───────┴───────┴─────────┴─────────┴────────┴────────┘
```
- `MAGIC` is always `0x0B0D`;
- `COUNT` the number of elements encoded in the segment (`u32`);
- `CS SIZE` is the size of control stream in bytes (`u32`);
- `DS SIZE` is the size of data stream in bytes (`u32`);
- `CS` and `DS` and control and data streams.
Segment header (`MAGIC`, `COUNT`, `CS SIZE`, `DS SIZE`) is enough to calculate the whole segment size.
Segments follows each other until EOF of a stream reached.
*/
pub struct EncodeCursor<W> {
data_stream: Vec<u8>,
control_stream: Vec<u8>,
output: Box<W>,
written: usize,
}
impl<W: Write> EncodeCursor<W> {
pub fn new(output: W) -> Self {
Self {
data_stream: vec![],
control_stream: vec![],
output: Box::new(output),
written: 0,
}
}
/// Compresses input data using stream algorithm
pub fn encode(&mut self, input: &[u32]) -> io::Result<()> {
for n in input {
let bytes: [u8; 4] = n.to_be_bytes();
let length = 4 - n.leading_zeros() as u8 / 8;
let length = length.max(1);
debug_assert!((1..=4).contains(&length));
let control_word = self.get_control_word();
*control_word <<= 2;
*control_word |= length - 1;
self.written += 1;
self.data_stream.write_all(&bytes[4 - length as usize..])?;
self.write_segment_if_needed()?;
}
Ok(())
}
fn get_control_word(&mut self) -> &mut u8 {
if self.written % 4 == 0 {
self.control_stream.push(0);
}
self.control_stream.last_mut().unwrap()
}
fn write_segment_if_needed(&mut self) -> io::Result<()> {
const MAX_SEGMENT_SIZE: usize = 8 * 1024;
let segment_size = 2 // magic size
+ 4 // stream size
+ 4 // control stream size
+ 4 // data stream size
+ self.data_stream.len() + self.control_stream.len();
if segment_size >= MAX_SEGMENT_SIZE {
self.write_segment()?;
self.written = 0;
self.data_stream.clear();
self.control_stream.clear();
}
Ok(())
}
fn write_segment(&mut self) -> io::Result<()> {
let tail = self.written % 4;
// we need to shift last control byte left if number of elements
// not multiple of 4, otherwise it will be misaligned
if tail > 0 {
let control_word = self.control_stream.last_mut().unwrap();
*control_word <<= 2 * (4 - tail);
}
// Next we need to pad the data stream so that last quadruple will have 16 bytes at the end.
// Otherwise algorithm can cause loads from partially allocated memory when loading from
// the data stream to SIMD vector
let control_word = self.control_stream.last().unwrap();
let quadruple_length =
byte_to_4_length(*control_word).iter().sum::<u8>() as usize - (4 - tail);
for _ in quadruple_length..16 {
self.data_stream.write_all(&[0])?;
}
let header = SegmentHeader::new(
self.written,
self.control_stream.len(),
self.data_stream.len(),
);
header.write(&mut self.output)?;
self.output.write_all(&self.control_stream)?;
self.output.write_all(&self.data_stream)?;
Ok(())
}
/// Finish pending writes
///
/// Write last segment to the output and return underlying [`Write`] to the client.
/// Writes are **not flushed**. It is a responsibility of a client to flush if needed.
pub fn finish(mut self) -> io::Result<W> {
self.write_segment()?;
Ok(*self.output)
}
}
/// Represents an object that can decode a stream of data into a buffer of fixed size. A type parameter `T` specifies /// the type of the elements in the buffer.
pub trait Decoder<T: Copy + From<u8>> {
/// Decodes next elements into the buffer
///
/// Decodes next elements and returns the number of decoded elements, or zero if the end of the
/// stream is reached. There is no guarantee about buffer element past the return value. They might be
/// left unchanged or zeroed out by this method.
fn decode(&mut self, buffer: &mut [T]) -> io::Result<usize>;
/// Returns the content of a stream in a Vec
fn to_vec(mut self) -> io::Result<Vec<T>>
where
Self: Sized,
{
let mut buffer = [0u8.into(); 128];
let mut result = vec![];
let mut len = self.decode(&mut buffer)?;
while len > 0 {
result.extend(&buffer[..len]);
len = self.decode(&mut buffer)?;
}
Ok(result)
}
}
/// Decoding control byte to 4 corresponding length
///
/// The length of each integer es encoded as 2 bits: from 00 (length 1) to 11 (length 4).
fn byte_to_4_length(input: u8) -> [u8; 4] {
[
(input.rotate_left(2) & 0b11) + 1,
(input.rotate_left(4) & 0b11) + 1,
(input.rotate_left(6) & 0b11) + 1,
(input.rotate_left(8) & 0b11) + 1,
]
}
#[cfg(test)]
mod tests {
use super::*;
use rand::{rngs::ThreadRng, thread_rng, Rng, RngCore};
use std::io::{Cursor, Seek, SeekFrom};
#[test]
fn check_encode() {
let (control, data, _) = encode_values(&[0x01, 0x0100, 0x010000, 0x01000000, 0x010000]);
assert_eq!(
data,
[
0x01, //
0x01, 0x00, //
0x01, 0x00, 0x00, //
0x01, 0x00, 0x00, 0x00, //
0x01, 0x00, 0x00, //
// 13 byte padding so last quadruple is 16 byte long
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
]
);
let len = byte_to_4_length(control[0]);
assert_eq!(len, [1, 2, 3, 4]);
let len = byte_to_4_length(control[1]);
assert_eq!(len, [3, 1, 1, 1]);
}
#[test]
fn check_small_functional_encode_decode() {
let mut rng = thread_rng();
for _ in 0..1000 {
let len = rng.gen_range(1..20);
check_encode_decode_cycle(&mut rng, len);
}
}
#[test]
fn check_large_functional_encode_decode() {
let mut rng = thread_rng();
for _ in 0..10 {
let len = rng.gen_range(10000..20000);
check_encode_decode_cycle(&mut rng, len);
}
}
fn check_encode_decode_cycle(rng: &mut ThreadRng, len: usize) {
let input: Vec<u32> = generate_random_data(rng, len);
let (_, _, encoded) = encode_values(&input);
let output = DecodeCursor::new(MemorySegments::new(&encoded.into_inner()))
.unwrap()
.to_vec()
.unwrap();
assert_eq!(input.len(), output.len());
let chunk_size = 4;
for (i, (input, output)) in input
.chunks(chunk_size)
.zip(output.chunks(chunk_size))
.enumerate()
{
assert_eq!(input, output, "Arrays differs position {}", i * chunk_size);
}
}
#[test]
fn check_decode() {
let input = [1, 255, 1024, 2048, 0xFF000000];
let (_, _, encoded) = encode_values(&input);
let output = DecodeCursor::new(MemorySegments::new(&encoded.into_inner()))
.unwrap()
.to_vec()
.unwrap();
assert_eq!(output.len(), output.len());
assert_eq!(output, input);
}
#[allow(clippy::unusual_byte_groupings)]
#[test]
fn check_create_mask() {
assert_eq!(u32_shuffle_mask(1, 0), 0x808080_00);
assert_eq!(u32_shuffle_mask(2, 0), 0x8080_0001);
assert_eq!(u32_shuffle_mask(1, 3), 0x808080_03);
assert_eq!(u32_shuffle_mask(2, 3), 0x8080_0304);
}
#[allow(clippy::unusual_byte_groupings)]
#[test]
fn check_shuffle_masks() {
let masks = u32_shuffle_masks();
assert_eq!(
// Lengths 1, 1, 1, 1
masks[0b_00_00_00_00],
([0x808080_00, 0x808080_01, 0x808080_02, 0x808080_03], 4)
);
assert_eq!(
// Lengths 4, 4, 4, 4
masks[0b_11_11_11_11],
([0x00010203, 0x04050607, 0x08090a0b, 0x0c0d0e0f], 16)
);
assert_eq!(
// Lengths 4, 1, 4, 1
masks[0b_11_00_11_00],
([0x00010203, 0x808080_04, 0x05060708, 0x808080_09], 10)
);
assert_eq!(
// Lengths 4, 3, 2, 1
masks[0b_11_10_01_00],
([0x00010203, 0x80_040506, 0x8080_0708, 0x808080_09], 10)
);
}
#[test]
fn check_header_format() {
let expected = SegmentHeader::new(3, 1, 2);
let mut out = vec![];
expected.write(&mut out).unwrap();
let header = SegmentHeader::parse(&out);
assert_eq!(header, expected);
}
/// Creates and returns control and data stream for a given slice of numbers
pub fn encode_values(input: &[u32]) -> (Vec<u8>, Vec<u8>, Cursor<Vec<u8>>) {
let mut encoder = EncodeCursor::new(Cursor::new(vec![]));
encoder.encode(input).unwrap();
let mut source = encoder.finish().unwrap();
let mut cs = vec![];
let mut ds = vec![];
source.seek(SeekFrom::Start(0)).unwrap();
read_segment(&mut source, &mut cs, &mut ds).unwrap();
source.seek(SeekFrom::Start(0)).unwrap();
(cs, ds, source)
}
/// Generates "weighed" dataset fortesting purposes
///
/// "Weighted" basically means that there is equal number of elements (in probabilistic terms)
/// with different length in varint encoding.
fn generate_random_data(rng: &mut ThreadRng, size: usize) -> Vec<u32> {
let mut input = vec![];
input.resize_with(size, || match rng.gen_range(1..=4) {
1 => rng.next_u32() % (0xFF + 1),
2 => rng.next_u32() % (0xFFFF + 1),
3 => rng.next_u32() % (0xFFFFFF + 1),
_ => rng.next_u32(),
});
input
}
}