yo_common/
lib.rs

1//! Shared vocabulary for the whole engine: addresses, ids, the error model,
2//! the two hash families, and the cache hint the batch walk is built on.
3//!
4//! Everything here is used on the hot path, so the rules are strict. No
5//! allocation outside the error path, no dependencies, and every constant that
6//! another crate assumes is asserted in a test here rather than assumed twice.
7
8#![deny(missing_docs)]
9
10pub mod addr;
11pub mod blake3;
12pub mod crc;
13pub mod dtoa;
14pub mod eq;
15pub mod error;
16pub mod glob;
17pub mod lock;
18pub mod num;
19pub mod prefetch;
20pub mod re;
21pub mod rng;
22pub mod small;
23pub(crate) mod sync;
24pub mod wyhash;
25pub mod xxh3;
26
27pub use addr::{ADDR_BITS, Addr, MAX_OFFSET, OFFSET_BITS, SPACE_BITS, ShardId, Space};
28pub use crc::{SLOT_COUNT, crc16, crc32c, hash_tag, slot_of};
29pub use eq::bytes_eq;
30pub use error::{Code, Error, Result};
31pub use glob::matches as glob_matches;
32pub use lock::{Held, Lock};
33pub use num::{
34    DIGITS_MAX, i64_digits, i64_len, parse_i64, push_double, push_i64, push_u64, u64_digits,
35};
36pub use prefetch::{prefetch, prefetch_read};
37pub use rng::Rng;
38pub use small::Small;
39pub use wyhash::{hash_key, tag_of, wyhash};
40pub use xxh3::hash64;
41
42/// The size of an index bucket, and the cache line the engine is built around.
43///
44/// Everything that claims to be one cache line asserts against this rather than
45/// writing 64 twice.
46pub const CACHE_LINE: usize = 64;
47
48/// The largest batch the shard loop drains in one pass (`04` section 3).
49///
50/// This is also the C ABI's `BATCH_MAX` and the size of every `_many` form, so
51/// it is here rather than in the shard crate.
52pub const BATCH_MAX: usize = 64;
yo_common/lib.rs

yo_common/
lib.rs
