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
//! A layer/frame of which gets *stacked* to form the database
pub mod mapper;
use std::{borrow::Cow, io::{BufWriter, Read, Seek, Write}, ops::Range};
use crate::errors::Error;
use mapper::Mapper;
pub type Section<'l> = (Range<u64>, Cow<'l, [u8]>);
/// Represents a layer (either in the heap or disk) in the stack-db that *stacks*
#[derive(Debug)]
pub struct Layer<'l, Stream: Write + Read + Seek> {
/// The bounds of the layer; the range of the layer
pub bounds: Option<Range<u64>>,
/// The mapper that maps to either the heap or disk
mapper: Mapper<'l>,
/// The total size of all the writes in the layer
pub size: u64,
/// The current read cursor to speed up sequential reads
pub read_cursor: (u64, usize),
/// The underlying file reader/writer
stream: Stream,
}
/// Grabs a u64 from a buffer
#[inline]
fn get_u64(buffer: &[u8], range: Range<usize>) -> Result<u64, Error> {
Ok(u64::from_be_bytes(
if let Some(Ok(x)) = buffer.get(range).map(|x| x.try_into())
{ x }
else {
return Err(Error::DBCorrupt(Box::new(Error::InvalidLayer)));
}
))
}
/// used for error handling in iterators
#[inline]
fn until_err<T, E>(err: &mut &mut Result<(), E>, item: Result<T, E>) -> Option<T> {
match item {
Ok(item) => Some(item),
Err(e) => {
**err = Err(e);
None
}
}
}
impl<'l, Stream: Write + Read + Seek> Layer<'l, Stream> {
#[inline]
pub fn new(stream: Stream) -> Self {
Self {
bounds: None,
mapper: Mapper::new(),
size: 0,
read_cursor: (0, 0),
stream,
}
}
#[inline]
pub fn load(mut stream: Stream) -> Result<Self, Error> {
let mut buffer = [0u8; (u64::BITS as usize/8) * 3]; // buffer for three `u64` values: `size`, `bounds.start`, `bounds.end`
stream.read_exact(&mut buffer)?;
// read metadata; return corruption error if failure
let size = get_u64(&buffer, 0..8)?;
let bounds = get_u64(&buffer, 8..16)?..get_u64(&buffer, 16..24)?;
Ok(Self {
bounds: Some(bounds),
mapper: Mapper::Disk,
size,
read_cursor: (0, 0),
stream,
})
}
/// Checks for collisions on the current layer
#[inline]
pub fn check_collisions(&mut self, range: &Range<u64>) -> Result<Box<[Range<u64>]>, Error> {
// if range not even in bounds or layer empty; return
match self.bounds.as_ref() {
Some(bounds) => if bounds.end < range.start || range.end < bounds.start { return Ok(Box::new([])) },
None => return Ok(Box::new([])),
}
let mut err = Ok(());
let out = self.mapper.iter(&mut self.stream, self.size, REWIND_IDX)?
.scan(&mut err, until_err) // handles the errors
.filter(|(r, _)| range.start < r.end && r.start < range.end)
.map(|(r, _)| range.start.max(r.start)..std::cmp::min(range.end, r.end))
.collect();
err?;
Ok(out)
}
/// Takes in the **ordered** output of the `check_collisions` function to find the inverse
#[inline]
pub fn check_non_collisions(&self, range: &Range<u64>, collisions: &[Range<u64>]) -> Box<[Range<u64>]> { // find a better purely functional solution
let mut output = Vec::new();
let mut last_end = range.start;
for r in collisions.iter() {
if r.start > last_end {
output.push(last_end..r.start);
} last_end = r.end;
}
if last_end != range.end {
output.push(last_end..range.end);
} output.into_boxed_slice()
}
/// Reads from the layer unchecked and returns the section data and the desired relative range within the section.
///
/// **warning:** will throw `out-of-bounds` error (or undefined behaviour) if the read is accross two sections *(each read can only be on one section of a layer)*
#[inline]
pub fn read_unchecked(&mut self, addr: &Range<u64>) -> Result<(Range<usize>, Cow<[u8]>), Error> {
let mut err = Ok(());
let out = self.mapper.iter(&mut self.stream, self.size, REWIND_IDX)? // todo: Actually use the read-cursor so that you don't have to iterate through everything to get to where you want
.scan(&mut err, until_err) // handles errors
.find(|(r, _)| r.start <= addr.start && addr.end <= r.end) // read must be equal to or within layer section
.map(|(r, x)| ((addr.start-r.start) as usize..(addr.end-r.start) as usize, x));
err?;
out
.map(Ok)
.unwrap_or(Err(Error::OutOfBounds))
}
/// Writes to the heap layer without checking for collisions
///
/// **WARNING:** the layer will be corrupt (due to undefined behaviour) if there are any collisions; this function is meant to be used internally
#[inline]
pub fn write_unchecked(&mut self, idx: u64, data: Cow<'l, [u8]>) -> Result<(), Error> {
// cannot write on read-only
let (mapper, write_cursor) = self.mapper.get_writer()?;
let range = idx..idx+data.len() as u64;
// get the idx ni the map to insert to
let map_idx = if write_cursor.0 == idx {
write_cursor.1
} else {
mapper
.iter()
.enumerate()
.find(|(_, (r, _))| r.start > idx)
.map(|(i, _)| i)
.unwrap_or(0) // if map is empty write to the first index
};
// insert data into the map and update write cursor & size
mapper.insert(map_idx, (range.clone(), data));
*write_cursor = (range.end, map_idx+1);
self.size += range.end - range.start;
// Update bounds
self.bounds = Some(match self.bounds {
Some(ref x) => std::cmp::min(x.start, range.start)..std::cmp::max(x.end, range.end),
None => range,
});
Ok(())
}
/// Moves the layer from the **heap** to **disk**
pub fn flush(&mut self) -> Result<(), Error> {
const BUFFER_SIZE: usize = 1024 * 1024 * 4; // 4MiB buffer size
// don't flush if it's an empty layer or in read-only mode
let (bounds, mapper) = if let (Some(b), Mapper::Heap { mapper, .. }) = (&self.bounds, &self.mapper) { (b, mapper) } else { return Ok(()) };
let mut file = BufWriter::with_capacity(BUFFER_SIZE, &mut self.stream);
// write from the start
file.rewind()?;
// write the bounds & size of the layer
file.write_all(&self.size.to_be_bytes())?;
file.write_all(&bounds.start.to_be_bytes())?;
file.write_all(&bounds.end.to_be_bytes())?;
// we assume that the map is already sorted
for (range, data) in mapper {
file.write_all(&range.start.to_be_bytes())?;
file.write_all(&range.end.to_be_bytes())?;
file.write_all(data)?;
}
// flush file and switch to disk layer
file.flush()?;
self.mapper = Mapper::Disk;
Ok(())
}
}
pub const REWIND_IDX: u64 = 8 + 8 + 8; // skip the `u64`s: `layer_size`, `layer_bound.start` and `layer_bound.end`