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
use bytemuck::cast_slice_mut;
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use std::convert::{Infallible, TryFrom};
use std::error::Error;
use std::io;
use std::ops::RangeInclusive;
use crate::bitmap::container::{Container, ARRAY_LIMIT};
use crate::bitmap::store::{ArrayStore, BitmapStore, Store, BITMAP_LENGTH};
use crate::RoaringBitmap;
const SERIAL_COOKIE_NO_RUNCONTAINER: u32 = 12346;
const SERIAL_COOKIE: u16 = 12347;
const NO_OFFSET_THRESHOLD: usize = 4;
// Sizes of header structures
const DESCRIPTION_BYTES: usize = 4;
const OFFSET_BYTES: usize = 4;
impl RoaringBitmap {
/// Return the size in bytes of the serialized output.
/// This is compatible with the official C/C++, Java and Go implementations.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let rb1: RoaringBitmap = (1..4).collect();
/// let mut bytes = Vec::with_capacity(rb1.serialized_size());
/// rb1.serialize_into(&mut bytes).unwrap();
/// let rb2 = RoaringBitmap::deserialize_from(&bytes[..]).unwrap();
///
/// assert_eq!(rb1, rb2);
/// ```
pub fn serialized_size(&self) -> usize {
let container_sizes: usize = self
.containers
.iter()
.map(|container| match container.store {
Store::Array(ref values) => 8 + values.len() as usize * 2,
Store::Bitmap(..) => 8 + 8 * 1024,
})
.sum();
// header + container sizes
8 + container_sizes
}
/// Serialize this bitmap into [the standard Roaring on-disk format][format].
/// This is compatible with the official C/C++, Java and Go implementations.
///
/// [format]: https://github.com/RoaringBitmap/RoaringFormatSpec
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let rb1: RoaringBitmap = (1..4).collect();
/// let mut bytes = vec![];
/// rb1.serialize_into(&mut bytes).unwrap();
/// let rb2 = RoaringBitmap::deserialize_from(&bytes[..]).unwrap();
///
/// assert_eq!(rb1, rb2);
/// ```
pub fn serialize_into<W: io::Write>(&self, mut writer: W) -> io::Result<()> {
writer.write_u32::<LittleEndian>(SERIAL_COOKIE_NO_RUNCONTAINER)?;
writer.write_u32::<LittleEndian>(self.containers.len() as u32)?;
for container in &self.containers {
writer.write_u16::<LittleEndian>(container.key)?;
writer.write_u16::<LittleEndian>((container.len() - 1) as u16)?;
}
let mut offset = 8 + 8 * self.containers.len() as u32;
for container in &self.containers {
writer.write_u32::<LittleEndian>(offset)?;
match container.store {
Store::Array(ref values) => {
offset += values.len() as u32 * 2;
}
Store::Bitmap(..) => {
offset += 8 * 1024;
}
}
}
for container in &self.containers {
match container.store {
Store::Array(ref values) => {
for &value in values.iter() {
writer.write_u16::<LittleEndian>(value)?;
}
}
Store::Bitmap(ref bits) => {
for &value in bits.as_array() {
writer.write_u64::<LittleEndian>(value)?;
}
}
}
}
Ok(())
}
/// Deserialize a bitmap into memory from [the standard Roaring on-disk
/// format][format]. This is compatible with the official C/C++, Java and
/// Go implementations. This method checks that all of the internal values
/// are valid. If deserializing from a trusted source consider
/// [RoaringBitmap::deserialize_unchecked_from]
///
/// [format]: https://github.com/RoaringBitmap/RoaringFormatSpec
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let rb1: RoaringBitmap = (1..4).collect();
/// let mut bytes = vec![];
/// rb1.serialize_into(&mut bytes).unwrap();
/// let rb2 = RoaringBitmap::deserialize_from(&bytes[..]).unwrap();
///
/// assert_eq!(rb1, rb2);
/// ```
pub fn deserialize_from<R: io::Read>(reader: R) -> io::Result<RoaringBitmap> {
RoaringBitmap::deserialize_from_impl(reader, ArrayStore::try_from, BitmapStore::try_from)
}
/// Deserialize a bitmap into memory from [the standard Roaring on-disk
/// format][format]. This is compatible with the official C/C++, Java and
/// Go implementations. This method is memory safe but will not check if
/// the data is a valid bitmap.
///
/// [format]: https://github.com/RoaringBitmap/RoaringFormatSpec
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let rb1: RoaringBitmap = (1..4).collect();
/// let mut bytes = vec![];
/// rb1.serialize_into(&mut bytes).unwrap();
/// let rb2 = RoaringBitmap::deserialize_unchecked_from(&bytes[..]).unwrap();
///
/// assert_eq!(rb1, rb2);
/// ```
pub fn deserialize_unchecked_from<R: io::Read>(reader: R) -> io::Result<RoaringBitmap> {
RoaringBitmap::deserialize_from_impl::<R, _, Infallible, _, Infallible>(
reader,
|values| Ok(ArrayStore::from_vec_unchecked(values)),
|len, values| Ok(BitmapStore::from_unchecked(len, values)),
)
}
fn deserialize_from_impl<R, A, AErr, B, BErr>(
mut reader: R,
a: A,
b: B,
) -> io::Result<RoaringBitmap>
where
R: io::Read,
A: Fn(Vec<u16>) -> Result<ArrayStore, AErr>,
AErr: Error + Send + Sync + 'static,
B: Fn(u64, Box<[u64; 1024]>) -> Result<BitmapStore, BErr>,
BErr: Error + Send + Sync + 'static,
{
// First read the cookie to determine which version of the format we are reading
let (size, has_offsets, has_run_containers) = {
let cookie = reader.read_u32::<LittleEndian>()?;
if cookie == SERIAL_COOKIE_NO_RUNCONTAINER {
(reader.read_u32::<LittleEndian>()? as usize, true, false)
} else if (cookie as u16) == SERIAL_COOKIE {
let size = ((cookie >> 16) + 1) as usize;
(size, size >= NO_OFFSET_THRESHOLD, true)
} else {
return Err(io::Error::new(io::ErrorKind::Other, "unknown cookie value"));
}
};
// Read the run container bitmap if necessary
let run_container_bitmap = if has_run_containers {
let mut bitmap = vec![0u8; (size + 7) / 8];
reader.read_exact(&mut bitmap)?;
Some(bitmap)
} else {
None
};
if size > u16::MAX as usize + 1 {
return Err(io::Error::new(io::ErrorKind::Other, "size is greater than supported"));
}
// Read the container descriptions
let mut description_bytes = vec![0u8; size * DESCRIPTION_BYTES];
reader.read_exact(&mut description_bytes)?;
let mut description_bytes = &description_bytes[..];
if has_offsets {
let mut offsets = vec![0u8; size * OFFSET_BYTES];
reader.read_exact(&mut offsets)?;
drop(offsets); // Not useful when deserializing into memory
}
let mut containers = Vec::with_capacity(size);
// Read each container
for i in 0..size {
let key = description_bytes.read_u16::<LittleEndian>()?;
let cardinality = u64::from(description_bytes.read_u16::<LittleEndian>()?) + 1;
// If the run container bitmap is present, check if this container is a run container
let is_run_container =
run_container_bitmap.as_ref().map_or(false, |bm| bm[i / 8] & (1 << (i % 8)) != 0);
let store = if is_run_container {
let runs = reader.read_u16::<LittleEndian>()?;
let mut intervals = vec![[0, 0]; runs as usize];
reader.read_exact(cast_slice_mut(&mut intervals))?;
intervals.iter_mut().for_each(|[s, len]| {
*s = u16::from_le(*s);
*len = u16::from_le(*len);
});
let cardinality = intervals.iter().map(|[_, len]| *len as usize).sum();
let mut store = Store::with_capacity(cardinality);
intervals.into_iter().for_each(|[s, len]| {
store.insert_range(RangeInclusive::new(s, s + len));
});
store
} else if cardinality <= ARRAY_LIMIT {
let mut values = vec![0; cardinality as usize];
reader.read_exact(cast_slice_mut(&mut values))?;
values.iter_mut().for_each(|n| *n = u16::from_le(*n));
let array = a(values).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))?;
Store::Array(array)
} else {
let mut values = Box::new([0; BITMAP_LENGTH]);
reader.read_exact(cast_slice_mut(&mut values[..]))?;
values.iter_mut().for_each(|n| *n = u64::from_le(*n));
let bitmap = b(cardinality, values)
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))?;
Store::Bitmap(bitmap)
};
containers.push(Container { key, store });
}
Ok(RoaringBitmap { containers })
}
}
#[cfg(test)]
mod test {
use crate::RoaringBitmap;
use proptest::prelude::*;
proptest! {
#[test]
fn test_serialization(
bitmap in RoaringBitmap::arbitrary(),
) {
let mut buffer = Vec::new();
bitmap.serialize_into(&mut buffer).unwrap();
prop_assert_eq!(bitmap, RoaringBitmap::deserialize_from(buffer.as_slice()).unwrap());
}
}
}