Skip to main content

store_io_engine/
lib.rs

1//! # store-io-engine
2//!
3//! The engine of store-io, generic over any `store-io-platform` backend.
4//!
5//! - [`domain`]: flush domains and the join rule: barriers share device
6//!   flushes with no timer, and a failed flush poisons the device forever.
7//! - [`frontier`]: lock-free append frontiers: atomic space reservation,
8//!   out-of-order completion, contiguous completed and durable prefixes.
9//! - [`Store`]: one container: create, open, read-only open, provisioning,
10//!   the device report, poisoning.
11//! - [`AppendRegion`], [`PageRegion`], [`Slot`]: the data surfaces.
12//! - [`AppendBatch`], [`PageBatch`]: many writes, one barrier.
13//! - [`Submitter`]: many reads and writes in flight from one thread,
14//!   without blocking; tickets from completions ([`completion`]).
15//! - [`AppendRegion::scan`], [`PageRegion::scan`]: the raw ordered recovery
16//!   read, which never stops at bad data.
17//! - [`receipt`]: positions, write tickets and durability receipts, which
18//!   only this crate can create.
19
20#![deny(warnings)]
21#![forbid(unsafe_code)]
22
23mod batch;
24pub mod completion;
25mod copy;
26mod create;
27mod directory;
28pub mod domain;
29mod exec;
30#[cfg(all(test, not(loom)))]
31mod flush_slot_tests;
32// The format-2 test helpers, shared with the in-crate tests, name the crate
33// from outside.
34#[cfg(all(test, not(loom)))]
35extern crate self as store_io_engine;
36mod flusher;
37mod footprint;
38mod force;
39pub mod frontier;
40mod gate;
41mod grow2;
42mod io;
43mod layout;
44mod lifecycle;
45mod lifecycle2;
46mod mapped;
47mod open;
48mod open2;
49mod optable;
50mod options;
51mod provision;
52mod provision2;
53pub(crate) mod queue_core;
54pub mod receipt;
55mod region;
56mod regionmap;
57mod repair;
58mod report;
59mod scan;
60mod settle;
61mod slot_handle;
62mod slots;
63mod space;
64mod stats;
65mod store;
66mod submitter;
67mod sync;
68mod v2;
69
70pub use batch::{AppendBatch, PageBatch};
71pub use completion::{SubmitterConfig, WriteMode};
72pub use copy::{COPY_LOCK, COPYING, CopyOptions, CopyReport, copy_store};
73pub use directory::Directory;
74pub use domain::DomainStats;
75pub use flusher::SubmitterWaker;
76pub use options::RegionOptions;
77pub use receipt::{DurableReceipt, RegionPos, WriteTicket};
78pub use region::{AppendRegion, PageRegion, Slot};
79pub use scan::{ScanItem, ScanSummary};
80pub use space::{Reservation, SpaceReport, TagSpace};
81pub use stats::Outstanding;
82pub use store::{
83    CONTAINER, DamagedSlot, Healed, MetadataReport, Repair, SlotDamage, Store, StoreOptions,
84    StoreReport, Unavailable, UnavailableRegion,
85};
86pub use store_io_format::meta::RegionKind;
87pub use submitter::{MAX_DEPTH, Submitter};