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
//! An append-only list data structure, also known as log.
//!
//! It supports arbitrary-sized entries and dynamic sizing to arbitrary number of entries (as long as the underlying memory offers enough space).
//! This requires two _independently growable_ Memory trait objects. For canister development it is recommended to use a [crate::memory_manager].
//!
//! # V1 layout
//!
//! This log uses two [crate::Memory] trait objects:
//! * index memory to store the memory addresses of each entry
//! * data memory to store the entries themselves
//!
//! ## Index memory
//!
//! ```text
//! ---------------------------------------- <- Address 0
//! Magic "GLI" ↕ 3 bytes
//! ----------------------------------------
//! Layout version ↕ 1 byte
//! ----------------------------------------
//! Reserved space ↕ 28 bytes
//! ---------------------------------------- <- Address 32 (HEADER_OFFSET)
//! Number of entries = L ↕ 8 bytes
//! ---------------------------------------- <- Address 40
//! E_0 ↕ 8 bytes
//! ----------------------------------------
//! E_0 + E_1 ↕ 8 bytes
//! ----------------------------------------
//! ...
//! ----------------------------------------
//! E_0 + ... + E_(L-1) ↕ 8 bytes
//! ----------------------------------------
//! Unused index entries ↕ 8×(N-L) bytes
//! ----------------------------------------
//! Unallocated space
//! ```
//!
//! ## Data memory
//!
//! ```text
//! ---------------------------------------- <- Address 0
//! Magic "GLD" ↕ 3 bytes
//! ----------------------------------------
//! Layout version ↕ 1 byte
//! ----------------------------------------
//! Reserved space ↕ 28 bytes
//! ---------------------------------------- <- Address 32 (HEADER_OFFSET)
//! Entry 0 bytes ↕ E_0 bytes
//! ----------------------------------------
//! Entry 1 bytes ↕ E_1 bytes
//! ----------------------------------------
//! ...
//! ----------------------------------------
//! Entry (L-1) bytes ↕ E_(L-1) bytes
//! ----------------------------------------
//! Unallocated space
//! ```
use crate::{read_u64, safe_write, write_u64, Address, GrowFailed, Memory, Storable};
use std::borrow::Cow;
use std::cell::RefCell;
use std::fmt;
use std::marker::PhantomData;
use std::thread::LocalKey;
#[cfg(test)]
mod tests;
/// The magic number: Growable Log Index.
pub const INDEX_MAGIC: &[u8; 3] = b"GLI";
/// The magic number: Growable Log Data.
pub const DATA_MAGIC: &[u8; 3] = b"GLD";
/// The current version of the layout.
const LAYOUT_VERSION: u8 = 1;
/// The size of the V1 layout header.
const HEADER_V1_SIZE: u64 = 4;
/// The number of header bytes reserved for future extensions.
const RESERVED_HEADER_SIZE: u64 = 28;
/// Header offset to write data to.
const HEADER_OFFSET: u64 = HEADER_V1_SIZE + RESERVED_HEADER_SIZE;
struct HeaderV1 {
magic: [u8; 3],
version: u8,
}
#[derive(Debug, PartialEq, Eq)]
pub enum InitError {
IncompatibleDataVersion {
last_supported_version: u8,
decoded_version: u8,
},
IncompatibleIndexVersion {
last_supported_version: u8,
decoded_version: u8,
},
InvalidIndex,
}
impl fmt::Display for InitError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
InitError::IncompatibleDataVersion {
last_supported_version,
decoded_version,
} => write!(
f,
"Incompatible data version: last supported version is {}, but decoded version is {}",
last_supported_version, decoded_version
),
InitError::IncompatibleIndexVersion {
last_supported_version,
decoded_version,
} => write!(
f,
"Incompatible index version: last supported version is {}, but decoded version is {}",
last_supported_version, decoded_version
),
InitError::InvalidIndex => write!(f, "Invalid index"),
}
}
}
#[derive(Debug, PartialEq, Eq)]
pub enum WriteError {
GrowFailed { current_size: u64, delta: u64 },
}
impl From<GrowFailed> for WriteError {
fn from(
GrowFailed {
current_size,
delta,
}: GrowFailed,
) -> Self {
Self::GrowFailed {
current_size,
delta,
}
}
}
#[derive(Debug, PartialEq, Eq)]
pub struct NoSuchEntry;
/// Append-only list of variable-size entries stored in stable memory.
pub struct Log<T: Storable, INDEX: Memory, DATA: Memory> {
index_memory: INDEX,
data_memory: DATA,
_marker: PhantomData<T>,
}
impl<T: Storable, INDEX: Memory, DATA: Memory> Log<T, INDEX, DATA> {
/// Creates a new empty growable stable log backed by the memory trait objects, overwriting the previous contents.
pub fn new(index_memory: INDEX, data_memory: DATA) -> Self {
let log = Self {
index_memory,
data_memory,
_marker: PhantomData,
};
Self::write_header(
&log.index_memory,
&HeaderV1 {
magic: *INDEX_MAGIC,
version: LAYOUT_VERSION,
},
);
Self::write_header(
&log.data_memory,
&HeaderV1 {
magic: *DATA_MAGIC,
version: LAYOUT_VERSION,
},
);
// number of entries
write_u64(&log.index_memory, Address::from(HEADER_OFFSET), 0);
log
}
/// Initializes the log based on the contents of the provided memory trait objects.
/// If the memory trait objects already contain a stable log, this function recovers it from the stable
/// memory. Otherwise, this function allocates a new empty log.
pub fn init(index_memory: INDEX, data_memory: DATA) -> Result<Self, InitError> {
// if the data memory is not containing expected data, the index is useless anyway.
if data_memory.size() == 0 {
return Ok(Self::new(index_memory, data_memory));
}
let data_header = Self::read_header(&data_memory);
if &data_header.magic != DATA_MAGIC {
return Ok(Self::new(index_memory, data_memory));
}
if data_header.version != LAYOUT_VERSION {
return Err(InitError::IncompatibleDataVersion {
last_supported_version: LAYOUT_VERSION,
decoded_version: data_header.version,
});
}
let index_header = Self::read_header(&index_memory);
if &index_header.magic != INDEX_MAGIC {
return Err(InitError::InvalidIndex);
}
if index_header.version != LAYOUT_VERSION {
return Err(InitError::IncompatibleIndexVersion {
last_supported_version: LAYOUT_VERSION,
decoded_version: index_header.version,
});
}
#[cfg(debug_assertions)]
{
assert_eq!(Ok(()), Self::validate_v1_index(&index_memory));
}
Ok(Self {
index_memory,
data_memory,
_marker: PhantomData,
})
}
/// Writes the stable log header to memory.
fn write_header(memory: &impl Memory, header: &HeaderV1) {
if memory.size() < 1 {
assert!(
memory.grow(1) != -1,
"failed to allocate the first memory page"
);
}
memory.write(0, &header.magic);
memory.write(3, &[header.version]);
}
/// Reads the stable log header from the memory.
/// PRECONDITION: memory.size() > 0
fn read_header(memory: &impl Memory) -> HeaderV1 {
let mut magic = [0u8; 3];
let mut version = [0u8; 1];
memory.read(0, &mut magic);
memory.read(3, &mut version);
HeaderV1 {
magic,
version: version[0],
}
}
#[cfg(debug_assertions)]
fn validate_v1_index(memory: &INDEX) -> Result<(), String> {
let num_entries = read_u64(memory, Address::from(HEADER_OFFSET));
if num_entries == 0 {
return Ok(());
}
// Check that the index entries are non-decreasing.
let mut prev_entry = read_u64(memory, Address::from(HEADER_OFFSET + 8));
for i in 1..num_entries {
let entry = read_u64(memory, Address::from(HEADER_OFFSET + 8 + i * 8));
if entry < prev_entry {
return Err(format!("invalid entry I[{i}]: {entry} < {prev_entry}"));
}
prev_entry = entry;
}
Ok(())
}
/// Returns the underlying memory trait objects of the log.
pub fn into_memories(self) -> (INDEX, DATA) {
(self.index_memory, self.data_memory)
}
/// Returns true iff this log does not have any entries.
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Returns the number of index memory bytes in use.
pub fn index_size_bytes(&self) -> u64 {
let num_entries = read_u64(&self.index_memory, Address::from(HEADER_OFFSET));
self.index_entry_offset(num_entries).get()
}
/// Returns the number of data memory bytes in use.
pub fn data_size_bytes(&self) -> u64 {
self.log_size_bytes() + HEADER_OFFSET
}
/// Returns the total size of all logged entries in bytes.
pub fn log_size_bytes(&self) -> u64 {
let num_entries = self.len();
if num_entries == 0 {
0
} else {
read_u64(&self.index_memory, self.index_entry_offset(num_entries - 1))
}
}
/// Returns the number of entries in the log.
pub fn len(&self) -> u64 {
read_u64(&self.index_memory, Address::from(HEADER_OFFSET))
}
/// Returns the entry at the specified index.
/// Returns None if the entry does not exist.
pub fn get(&self, idx: u64) -> Option<T> {
let mut buf = vec![];
self.read_entry(idx, &mut buf).ok()?;
Some(T::from_bytes(Cow::Owned(buf)))
}
/// Returns an iterator over log entries.
pub fn iter(&self) -> Iter<'_, T, INDEX, DATA> {
Iter {
log: self,
buf: vec![],
pos: 0,
}
}
/// Reads the contents of the entry with the specified index into
/// a byte vector.
///
/// NOTE: if the entry exists, this function resizes `buf` to match the entry size.
///
/// NOTE: this function returns a Result to make the compiler emit a warning if the caller
/// ignores the result.
pub fn read_entry(&self, idx: u64, buf: &mut Vec<u8>) -> Result<(), NoSuchEntry> {
let (offset, len) = self.entry_meta(idx).ok_or(NoSuchEntry)?;
buf.resize(len, 0);
self.data_memory.read(HEADER_OFFSET + offset, buf);
Ok(())
}
/// Appends a new entry to the log.
/// If successful, returns the index of the entry.
///
/// POST-CONDITION: Ok(idx) = log.append(E) ⇒ log.get(idx) = Some(E)
pub fn append(&self, item: &T) -> Result<u64, WriteError> {
let idx = self.len();
let data_offset = if idx == 0 {
0
} else {
read_u64(&self.index_memory, self.index_entry_offset(idx - 1))
};
let bytes = item.to_bytes();
let new_offset = data_offset
.checked_add(bytes.len() as u64)
.expect("address overflow");
let entry_offset = HEADER_OFFSET
.checked_add(data_offset)
.expect("address overflow");
debug_assert!(new_offset >= data_offset);
// NB. we attempt to write the data first so we won't need to undo changes to the index if the write fails.
safe_write(&self.data_memory, entry_offset, &bytes[..])?;
// NB. append to index first as it might need to grow the index memory.
safe_write(
&self.index_memory,
self.index_entry_offset(idx).get(),
&new_offset.to_le_bytes(),
)?;
// update number of entries
write_u64(&self.index_memory, Address::from(HEADER_OFFSET), idx + 1);
debug_assert_eq!(self.get(idx).unwrap().to_bytes(), bytes);
Ok(idx)
}
/// Returns the offset and the length of the specified entry.
fn entry_meta(&self, idx: u64) -> Option<(u64, usize)> {
if self.len() <= idx {
return None;
}
if idx == 0 {
Some((
0,
read_u64(&self.index_memory, self.index_entry_offset(0)) as usize,
))
} else {
let offset = read_u64(&self.index_memory, self.index_entry_offset(idx - 1));
let next = read_u64(&self.index_memory, self.index_entry_offset(idx));
debug_assert!(offset <= next);
Some((offset, (next - offset) as usize))
}
}
/// Returns the absolute offset of the specified index entry in memory.
fn index_entry_offset(&self, idx: u64) -> Address {
Address::from(
HEADER_OFFSET + std::mem::size_of::<u64>() as u64 // skip over u64 storing the number of entries
+ idx * (std::mem::size_of::<u64>() as u64), // memory addresses for idx many entries
)
}
}
pub struct Iter<'a, T, I, D>
where
T: Storable,
I: Memory,
D: Memory,
{
log: &'a Log<T, I, D>,
buf: Vec<u8>,
pos: u64,
}
impl<T, I, D> Iterator for Iter<'_, T, I, D>
where
T: Storable,
I: Memory,
D: Memory,
{
type Item = T;
fn next(&mut self) -> Option<T> {
match self.log.read_entry(self.pos, &mut self.buf) {
Ok(()) => {
self.pos = self.pos.saturating_add(1);
Some(T::from_bytes(Cow::Borrowed(&self.buf)))
}
Err(NoSuchEntry) => None,
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.log.len().saturating_sub(self.pos) as usize, None)
}
fn count(self) -> usize {
let n = self.log.len().saturating_sub(self.pos);
if n > usize::MAX as u64 {
panic!("The number of items in the log {n} does not fit into usize");
}
n as usize
}
fn nth(&mut self, n: usize) -> Option<T> {
self.pos = self.pos.saturating_add(n as u64);
self.next()
}
}
/// Returns an iterator over entries in the log stored in a thread-local variable.
pub fn iter_thread_local<T, I, D>(
local_key: &'static LocalKey<RefCell<Log<T, I, D>>>,
) -> ThreadLocalRefIterator<T, I, D>
where
T: Storable,
I: Memory,
D: Memory,
{
ThreadLocalRefIterator {
log: local_key,
buf: vec![],
pos: 0,
}
}
pub struct ThreadLocalRefIterator<T, I, D>
where
T: Storable + 'static,
I: Memory + 'static,
D: Memory + 'static,
{
log: &'static LocalKey<RefCell<Log<T, I, D>>>,
buf: Vec<u8>,
pos: u64,
}
impl<T, I, D> Iterator for ThreadLocalRefIterator<T, I, D>
where
T: Storable,
I: Memory,
D: Memory,
{
type Item = T;
fn next(&mut self) -> Option<T> {
self.log.with(
|log| match log.borrow().read_entry(self.pos, &mut self.buf) {
Ok(()) => {
self.pos = self.pos.saturating_add(1);
Some(T::from_bytes(Cow::Borrowed(&self.buf)))
}
Err(NoSuchEntry) => None,
},
)
}
fn size_hint(&self) -> (usize, Option<usize>) {
let count = self.log.with(|cell| cell.borrow().len());
(count.saturating_sub(self.pos) as usize, None)
}
fn count(self) -> usize {
self.size_hint().0
}
fn nth(&mut self, n: usize) -> Option<T> {
self.pos = self.pos.saturating_add(n as u64);
self.next()
}
}