mnemo_engine/lib.rs
1//! # Mnemo
2//!
3//! Mnemo is an **encrypted, single-file, portable agent-memory engine**.
4//!
5//! A whole memory store — vectors, content, metadata, and the multi-signal
6//! recall machinery an agent needs — lives in one file you can copy, back up,
7//! or hand to another process. The file is encrypted at rest with a two-tier
8//! key hierarchy: an Argon2id key-encryption key (KEK) derived from a
9//! passphrase wraps a random data-encryption key (DEK), and the DEK encrypts
10//! every page with AES-256-GCM.
11//!
12//! ## Quick start
13//!
14//! ```no_run
15//! use mnemo_engine::{Mnemo, MnemoConfig, Memory, MemoryType, RecallRequest};
16//!
17//! # fn main() -> mnemo_engine::Result<()> {
18//! let cfg = MnemoConfig { dimensions: 3, ..Default::default() };
19//! let mut db = Mnemo::create("agent.mnemo", "correct horse battery", cfg)?;
20//!
21//! db.remember(
22//! Memory::new("the user prefers dark mode", MemoryType::Semantic, vec![0.1, 0.2, 0.9])
23//! .with_agent("assistant-1")
24//! .with_importance(0.8),
25//! )?;
26//! db.flush()?;
27//!
28//! let hits = db.recall(&RecallRequest::new(vec![0.1, 0.2, 0.9]).top_k(5))?;
29//! for h in hits {
30//! println!("{:.3} {}", h.score, h.memory.content);
31//! }
32//! # Ok(())
33//! # }
34//! ```
35//!
36//! ## What is and is not built
37//!
38//! This crate implements a real, tested core: the encrypted single-file
39//! storage engine, the crypto layer, the agent-memory model, multi-signal
40//! recall, an IVF+PQ approximate-nearest-neighbour index, a write-ahead log,
41//! snapshot-based point-in-time recovery, a bounded LRU page cache, and the
42//! [`Session`] conversation wrapper. Exact brute-force search remains
43//! available as the ground-truth baseline; a built index makes
44//! [`Mnemo::recall`] sub-linear. Each [`Mnemo::flush`] is one atomic,
45//! WAL-committed transaction and a restorable snapshot — [`Mnemo::restore_to`]
46//! rewinds the database to any past transaction. Python and TypeScript
47//! language bindings are the one documented roadmap item — see the README.
48
49#![forbid(unsafe_code)]
50#![warn(missing_docs)]
51// Since step 5a (MSRV 1.92, now 1.94): `as_chunks` (stable since 1.88) is within the
52// MSRV, so clippy suggests it for every constant-size `chunks_exact`. Those
53// are the hot kernels (PQ distance tables, fp16 vectors, the WAL checksum);
54// rewriting them waits for a change that measures them with the benches.
55// `unknown_lints` first, so a clippy older than the lint (before 1.100)
56// doesn't fail on its name.
57#![allow(unknown_lints)]
58#![allow(clippy::chunks_exact_to_as_chunks)]
59
60/// 12.3 step 5 (v0.15): the built-in embedder (snowflake-arctic-embed-xs on
61/// candle), behind the `embed-candle` feature.
62#[cfg(feature = "embed-candle")]
63pub mod builtin;
64mod cache;
65mod crypto;
66mod embed;
67mod embed_cmd;
68mod error;
69mod format;
70mod freelist;
71pub mod guide;
72mod ident;
73mod index;
74pub mod keys;
75mod keyslot;
76pub mod mcp;
77mod memory;
78mod pager;
79pub mod redact;
80mod result_cache;
81mod session;
82mod shared;
83mod store;
84mod text;
85mod transcript;
86mod veccol;
87mod wal;
88
89#[cfg(feature = "embed-candle")]
90pub use builtin::BuiltinEmbedder;
91pub use crypto::{KdfParams, SecretKind};
92pub use embed::{Embedder, EmbedderIdentity};
93pub use embed_cmd::{EmbedCmd, DEFAULT_EMBED_TIMEOUT};
94pub use error::{MnemoError, Result};
95pub use index::{IndexConfig, IndexInfo};
96/// 13a: the coordination kinds and the reserved keys a caller may set.
97pub use memory::{
98 check_caller_key, is_caller_key, is_coordination, valid_agent_id, CALLER_KEYS,
99 COORDINATION_KINDS, MNEMO_META_AS_OF, MNEMO_META_AUTHOR, MNEMO_META_DEFAULT_AGENT,
100 MNEMO_META_KIND_CLAIM, MNEMO_META_KIND_MESSAGE, MNEMO_META_KIND_PRESENCE, MNEMO_META_KIND_TASK,
101 MNEMO_META_REVIEW_BY, MNEMO_META_VISIBILITY, VISIBILITY_LEVELS,
102};
103/// 13a (13.5, 13.6): visibility and freshness.
104pub use memory::{date_of, stale_after, stale_since, visibility_of, VisibilitySet};
105/// 13a (13.1): messages between agents.
106pub use memory::{
107 delivery, MESSAGE_ACKED, MESSAGE_ACKED_KEEP_SECS, MESSAGE_BODY_MAX, MESSAGE_PAIR_CARRY_SECS,
108 MESSAGE_SUBJECT_MAX, MESSAGE_UNREAD, MNEMO_META_ACKED_AT, MNEMO_META_CONVERSATION,
109 MNEMO_META_DELIVERY, MNEMO_META_FROM, MNEMO_META_HOPS, MNEMO_META_TO,
110};
111pub use memory::{
112 status as essence_status, CommitBatch, CommitReport, EssenceOp, EssenceOpKind, EssenceScope,
113 EssenceSection, ExportedTurn, Filter, FilterTerm, IngestReport, KeyScope, KeyedMemory, Memory,
114 MemoryPatch, MemoryType, Metric, Scope, ScoreWeights, ThreadTurn, TurnPolicy, WriteOutcome,
115 CONTINUATION_TIMELINE_ENTRIES, ESSENCE_DEFAULT_RENDER_BYTES, ESSENCE_SECTION_MAX_BYTES,
116 ESSENCE_TIMELINE_MAX_BYTES, ESSENCE_TRANSITIONS, FINDING_TRANSITIONS, MNEMO_META_CONTINUES,
117 MNEMO_META_INVALID_AT, MNEMO_META_KEY, MNEMO_META_KIND, MNEMO_META_KIND_ESSENCE,
118 MNEMO_META_KIND_THREAD_LINK, MNEMO_META_KIND_TURN, MNEMO_META_LENGTH, MNEMO_META_MARKERS_ONLY,
119 MNEMO_META_NS, MNEMO_META_PART, MNEMO_META_REFS, MNEMO_META_ROLE, MNEMO_META_SECTION,
120 MNEMO_META_SEQ, MNEMO_META_SHA256, MNEMO_META_STATUS, MNEMO_META_STATUS_HISTORY,
121 MNEMO_META_SUPERSEDED_BY, MNEMO_META_SUPERSEDES, MNEMO_META_THREAD, MNEMO_META_TURN_ID,
122 MNEMO_META_UPDATED_AT, TASK_TRANSITIONS, THREAD_TOOL_RESULT_TRUNCATE_BYTES,
123 THREAD_TURN_CHUNK_BYTES,
124};
125/// 13a (13.1): tasks.
126pub use memory::{
127 task_status, MNEMO_META_AFTER, MNEMO_META_CREATOR, MNEMO_META_OWNER, MNEMO_META_PRE_APPROVED,
128 MNEMO_META_SLUG, TASK_CLAIM_TTL, TASK_CLAIM_WARN_SECS, TASK_DONE_EXPORT_KEEP_SECS,
129 TASK_SLUG_MAX,
130};
131/// 13a (13.3): claims and presence.
132pub use memory::{
133 CLAIM_LAPSE_GRACE_SECS, CLAIM_TOPIC_MAX, CLAIM_TTL_DEFAULT, CLAIM_TTL_MAX, CLAIM_TTL_MIN,
134 PRESENCE_EVERY_SECS,
135};
136/// 13a (13.1b): the wake-up guardrails.
137pub use memory::{
138 HOP_CAP, MNEMO_META_WAKE_PAUSED, PAIR_BURST, PAIR_BURST_SECS, WAKE_COOLDOWN_SECS, WAKE_PER_HOUR,
139};
140pub use result_cache::{
141 CacheBudget, CacheFlushPolicy, CachePutOpts, CacheStats, CachedValue, SemanticCachePutOpts,
142 DEFAULT_BATCH_MAX_AGE, DEFAULT_BATCH_MAX_DIRTY, DEFAULT_MAX_BYTES, DEFAULT_MAX_ENTRIES,
143 DEFAULT_SEMANTIC_THRESHOLD,
144};
145pub use session::{Role, Session, Turn};
146pub use shared::{sidecar_notes, CancelToken, SharedOptions};
147#[doc(hidden)]
148#[cfg(feature = "dev-hooks")]
149pub use store::BudgetReport;
150pub use store::{
151 slug_of, Alive, Claim, ClaimOutcome, ClaimStatus, KindCounts, Message, NewWork, Presence,
152 Stale, Task, TaskClaim, TaskLost, TaskOutcome, TaskSpec, TaskTaken, Wake,
153};
154pub use store::{
155 CloseError, CompactReport, Mnemo, MnemoConfig, RecallMode, RecallRequest, RecallResponse,
156 RecallResult, ReembedReport, SharedMnemo, SnapshotInfo, Stats, StatsSummary, VerifyReport,
157 DEFAULT_KEYWORD_WEIGHT, DEFAULT_TEXT_KEYWORD_WEIGHT, DEFAULT_TURN_COMPRESS_AFTER_SECS,
158 DEFAULT_VECTOR_CACHE_BUDGET, INDEX_PERSIST_EVERY_CHANGES, INDEX_PERSIST_EVERY_COMMITS,
159 V9_ANN_MIN_FACTS, V9_RERANK_PER_HIT,
160};
161pub use text::{KeywordIndex, KeywordTokenizer};
162pub use transcript::{
163 read_transcript, read_transcript_with, ToolResults, TranscriptFormat, TranscriptOptions,
164};
165
166/// Re-export of [`ulid::Ulid`], the identifier type used for memories.
167pub use ulid::Ulid;
168
169// --- Fsync counter -----------------------------------------------------
170//
171// Instrumentation plumbing for the Phase 6 top-3 cost #2 fix: the
172// planner wants to know how many `sync_all` calls each `flush()` issues
173// before deciding whether to batch any of them. Every fsync call site
174// bumps a thread-local counter; `Mnemo::flush` snapshots it before and
175// after, exposing the delta on `Stats::fsyncs_last_flush`. Thread-local
176// so handles on separate threads don't poison each other's counts; the
177// engine's one-writer-at-a-time locking means a single handle sees a
178// coherent stream.
179
180mod fsync_counter {
181 use std::cell::Cell;
182
183 thread_local! {
184 static COUNT: Cell<u64> = const { Cell::new(0) };
185 }
186
187 /// Call once per `sync_all`.
188 pub(crate) fn bump() {
189 COUNT.with(|c| c.set(c.get().wrapping_add(1)));
190 }
191
192 /// Monotonic counter snapshot for this thread.
193 pub(crate) fn count() -> u64 {
194 COUNT.with(|c| c.get())
195 }
196}
197
198pub(crate) use fsync_counter::{bump as bump_fsync, count as fsync_count};
199
200/// Build-time cryptographic backend information.
201///
202/// Populated at compile time from the active `cfg` flags. On ARMv8
203/// builds compiled with `--cfg aes_armv8 --cfg polyval_armv8` (set by
204/// the repo's `.cargo/config.toml` and both CI workflows) the `aes`
205/// and `polyval` crates emit hardware AES + PMULL instructions; without
206/// those flags they fall back to a constant-time software path that
207/// runs at roughly 5× the cost per page.
208///
209/// Published through [`build_info`], exposed by `mnemo info` on the
210/// CLI and `mnemo.build_info()` from the Python binding. The point is
211/// verification — nobody should have to profile a release build to find
212/// out whether it's running software AES.
213#[derive(Debug, Clone, Copy, PartialEq, Eq)]
214pub struct BuildInfo {
215 /// Package version (`CARGO_PKG_VERSION`), e.g. `"0.5.1"`.
216 pub version: &'static str,
217 /// Target triple this binary was built for, e.g.
218 /// `"aarch64-apple-darwin"`.
219 pub target: &'static str,
220 /// Human-readable AES backend. One of:
221 /// - `"armv8 hardware"` — ARM with `cfg(aes_armv8)`
222 /// - `"armv8 software"` — ARM without the cfg; constant-time fallback
223 /// - `"x86_64 AES-NI (runtime detect)"` — x86_64 with runtime
224 /// AES-NI detection in the `aes` crate
225 /// - `"portable software"` — any other target
226 pub aes_backend: &'static str,
227 /// Human-readable PMULL/CLMUL backend used by GHASH (part of AES-GCM).
228 /// Same shape as `aes_backend` but for `polyval`.
229 pub polyval_backend: &'static str,
230}
231
232/// Report this build's cryptographic backend configuration.
233///
234/// Cheap — all fields are `&'static str` populated at compile time.
235/// Safe to call from a hot path if, for some reason, that's useful.
236pub fn build_info() -> BuildInfo {
237 BuildInfo {
238 version: env!("CARGO_PKG_VERSION"),
239 target: TARGET_TRIPLE,
240 aes_backend: aes_backend_name(),
241 polyval_backend: polyval_backend_name(),
242 }
243}
244
245/// Target triple baked in via the `TARGET` env var that `cargo` sets
246/// for the host compile. Falls back to `"unknown"` if the var isn't
247/// set at build time (shouldn't happen under cargo, but a build.rs-free
248/// implementation keeps this crate build-script-free, so we use a
249/// cfg-based dispatch as the second-best).
250const TARGET_TRIPLE: &str = {
251 // `env!("TARGET")` isn't set by cargo for crates; it's set by rustc
252 // only for `std` builds. We approximate from `target_arch` /
253 // `target_os` cfgs so this stays build-script-free. Good enough
254 // for an info line; precise triples are a `cargo` or build.rs job.
255 if cfg!(all(target_arch = "aarch64", target_os = "macos")) {
256 "aarch64-apple-darwin"
257 } else if cfg!(all(target_arch = "aarch64", target_os = "linux")) {
258 "aarch64-unknown-linux-gnu"
259 } else if cfg!(all(target_arch = "x86_64", target_os = "macos")) {
260 "x86_64-apple-darwin"
261 } else if cfg!(all(target_arch = "x86_64", target_os = "linux")) {
262 "x86_64-unknown-linux-gnu"
263 } else if cfg!(all(target_arch = "x86_64", target_os = "windows")) {
264 "x86_64-pc-windows-msvc"
265 } else {
266 "unknown"
267 }
268};
269
270const fn aes_backend_name() -> &'static str {
271 if cfg!(aes_armv8) {
272 "armv8 hardware"
273 } else if cfg!(target_arch = "aarch64") {
274 // Software fallback is the dangerous case this whole mechanism
275 // exists to surface — flag it clearly so `mnemo info` makes it
276 // easy to notice a build picked up the slow path by mistake.
277 "armv8 software (constant-time fallback)"
278 } else if cfg!(target_arch = "x86_64") {
279 // `aes` 0.8.4 on x86_64 picks AES-NI vs the software path at
280 // runtime via the `cpufeatures` crate, so we can't tell from
281 // cfg alone which path a given invocation takes. In practice
282 // every x86_64 CPU shipped since ~2010 has AES-NI.
283 "x86_64 AES-NI (runtime detect)"
284 } else {
285 "portable software"
286 }
287}
288
289const fn polyval_backend_name() -> &'static str {
290 if cfg!(polyval_armv8) {
291 "armv8 PMULL hardware"
292 } else if cfg!(target_arch = "aarch64") {
293 "armv8 software (constant-time fallback)"
294 } else if cfg!(target_arch = "x86_64") {
295 "x86_64 CLMUL (runtime detect)"
296 } else {
297 "portable software"
298 }
299}
300
301/// **Not a stable API** (`dev-hooks` builds only): how many `sync_all`
302/// calls this thread has made, for step 5's bench to count a write's
303/// fsyncs.
304#[cfg(feature = "dev-hooks")]
305#[doc(hidden)]
306pub fn __fsync_count() -> u64 {
307 fsync_count()
308}
309
310/// Test-only crash-injection surface used by the Phase 1.3 proptest
311/// (`mnemo/tests/proptest_store.rs`). Compiled in under `cfg(test)`
312/// and the `failpoints` feature only; absent from release builds.
313///
314/// **Not part of the stable public API.** The double-underscore
315/// convention makes the "internal" contract obvious at the call site.
316#[cfg(any(test, feature = "failpoints"))]
317#[doc(hidden)]
318pub mod __failpoints {
319 /// Arm the pager and WAL commit path to fail on the Nth
320 /// subsequent write. `n = 0` fails the very next write; `n = -1`
321 /// (or any negative) disables. One-shot — disarms on trigger.
322 ///
323 /// Every write is checked before the byte hits the file, so a
324 /// triggered failure is guaranteed torn-BEFORE, never
325 /// torn-AFTER — critical for the "either pre-flush or post-flush"
326 /// invariant the property test asserts.
327 pub fn set_writes_until_fail(n: i64) {
328 crate::pager::failpoints::set_writes_until_fail(n)
329 }
330
331 /// Like [`set_writes_until_fail`], but `count` writes in a row fail.
332 pub fn set_writes_until_fail_n(n: i64, count: u32) {
333 crate::pager::failpoints::set_writes_until_fail_n(n, count)
334 }
335
336 /// Fail exactly the writes numbered in `ns` (from 0, counting from this
337 /// call), consecutive or not; an empty set disarms it.
338 pub fn set_writes_failing(ns: &[u64]) {
339 crate::pager::failpoints::set_writes_failing(ns)
340 }
341
342 /// How many writes this thread has made since the last
343 /// [`set_writes_failing`].
344 pub fn writes_seen() -> u64 {
345 crate::pager::failpoints::writes_seen()
346 }
347
348 thread_local! {
349 static AFTER_SHARED_COMMIT: std::cell::RefCell<Option<Box<dyn FnOnce()>>> =
350 const { std::cell::RefCell::new(None) };
351 static BEFORE_SHARED_COMMIT: std::cell::RefCell<Option<Box<dyn FnOnce()>>> =
352 const { std::cell::RefCell::new(None) };
353 }
354
355 /// Run `f` once, inside this thread's next shared-mode write, after the
356 /// window's closure and before the window's commit (so after the
357 /// window's identity check, 12.4 protocol step 4). Lets a test rename a
358 /// file over the path the way an older build's compaction can.
359 pub fn before_next_shared_commit(f: impl FnOnce() + 'static) {
360 BEFORE_SHARED_COMMIT.with(|c| *c.borrow_mut() = Some(Box::new(f)));
361 }
362
363 pub(crate) fn run_before_shared_commit() {
364 if let Some(f) = BEFORE_SHARED_COMMIT.with(|c| c.borrow_mut().take()) {
365 f();
366 }
367 }
368
369 /// Run `f` once, inside this thread's next shared-mode write, after its
370 /// commit and before the identity check that follows (12.4 protocol
371 /// step 8). Lets a test rename a file over the path at that moment.
372 pub fn after_next_shared_commit(f: impl FnOnce() + 'static) {
373 AFTER_SHARED_COMMIT.with(|c| *c.borrow_mut() = Some(Box::new(f)));
374 }
375
376 pub(crate) fn run_after_shared_commit() {
377 if let Some(f) = AFTER_SHARED_COMMIT.with(|c| c.borrow_mut().take()) {
378 f();
379 }
380 }
381
382 thread_local! {
383 static NEXT_TEMP_NAME: std::cell::RefCell<Option<std::path::PathBuf>> =
384 const { std::cell::RefCell::new(None) };
385 }
386
387 /// Make the next temp file name this thread asks for (compaction,
388 /// `export_encrypted`, `export_rekeyed`) be `path`, once; the attempts
389 /// after it are generated as usual. Lets a test plant a file or a
390 /// symlink at the exact name the engine is about to use.
391 pub fn set_next_temp_name(path: impl Into<std::path::PathBuf>) {
392 NEXT_TEMP_NAME.with(|n| *n.borrow_mut() = Some(path.into()));
393 }
394
395 pub(crate) fn take_next_temp_name() -> Option<std::path::PathBuf> {
396 NEXT_TEMP_NAME.with(|n| n.borrow_mut().take())
397 }
398
399 thread_local! {
400 static SHARED_MAIN_TRIES: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
401 static SHARED_REPLACED: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
402 }
403
404 /// How many times this thread's shared-mode calls have tried the main
405 /// lock (each open, lock and identity check counts once).
406 pub fn shared_main_tries() -> u64 {
407 SHARED_MAIN_TRIES.with(|c| c.get())
408 }
409
410 pub(crate) fn count_shared_main_try() {
411 SHARED_MAIN_TRIES.with(|c| c.set(c.get() + 1));
412 }
413
414 /// Make this thread's next `n` shared-mode tries at the main lock find
415 /// the file replaced (as if a compaction renamed a new file over the
416 /// path between the open and the lock each time). `0` disarms.
417 pub fn set_shared_replaced(n: u64) {
418 SHARED_REPLACED.with(|c| c.set(n));
419 }
420
421 thread_local! {
422 static EUID_OVERRIDE: std::cell::Cell<Option<u32>> = const { std::cell::Cell::new(None) };
423 }
424
425 /// Make this thread's file-owner checks (the dead compaction temp
426 /// files' cleanup) compare against `uid` instead of the effective uid,
427 /// so a test can see a file as another user's without root. `None`
428 /// restores the real check.
429 pub fn set_euid_override(uid: Option<u32>) {
430 EUID_OVERRIDE.with(|c| c.set(uid));
431 }
432
433 // Read by the Unix owner check only.
434 #[cfg(unix)]
435 pub(crate) fn euid_override() -> Option<u32> {
436 EUID_OVERRIDE.with(|c| c.get())
437 }
438
439 thread_local! {
440 static PATH_CHECK_FAILURES: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
441 }
442
443 /// Make this thread's next `n` checks that a handle's path still names
444 /// its open file fail with a permission error (RB-008.2), as when the
445 /// process has lost access to the path. `0` disarms.
446 pub fn set_path_check_failures(n: u64) {
447 PATH_CHECK_FAILURES.with(|c| c.set(n));
448 }
449
450 /// How many armed path-check failures this thread has left.
451 pub fn path_check_failures_left() -> u64 {
452 PATH_CHECK_FAILURES.with(|c| c.get())
453 }
454
455 pub(crate) fn take_path_check_failure() -> bool {
456 PATH_CHECK_FAILURES.with(|c| {
457 let n = c.get();
458 if n > 0 {
459 c.set(n - 1);
460 }
461 n > 0
462 })
463 }
464
465 pub(crate) fn take_shared_replaced() -> bool {
466 SHARED_REPLACED.with(|c| {
467 let n = c.get();
468 if n > 0 {
469 c.set(n - 1);
470 }
471 n > 0
472 })
473 }
474}
475
476/// 12.4 step 2a: the shared lock layer, reached directly by its tests
477/// (`tests/shared_lock.rs`) until `Mnemo::open_shared` (step 2b) wraps it.
478/// Compiled in under `cfg(test)` and the `failpoints` feature only.
479///
480/// **Not part of the stable public API.**
481#[cfg(any(test, feature = "failpoints"))]
482#[doc(hidden)]
483pub mod __shared {
484 use std::path::{Path, PathBuf};
485
486 use crate::shared::{BrainLocks, Call, Held, LockKind};
487 use crate::{Result, SharedOptions};
488
489 /// The sidecar directory's suffix and its two file names.
490 pub const SUFFIX: &str = crate::shared::testing::SUFFIX;
491 pub const INTENT: &str = crate::shared::testing::INTENT;
492 pub const LOCK_INFO: &str = crate::shared::testing::LOCK_INFO;
493 /// LOCK-2's valve file name.
494 pub const VALVE: &str = crate::shared::testing::VALVE;
495
496 /// Whether this build refuses shared mode (Windows, Rust before 1.85).
497 pub const WINDOWS_OLD_RENAME: bool = crate::shared::WINDOWS_OLD_RENAME;
498
499 /// `<brain>.mnemo-shared` for a resolved brain path.
500 pub fn sidecar_path(brain: &Path) -> PathBuf {
501 crate::shared::testing::sidecar_path(brain)
502 }
503
504 /// The macOS synced-folder rule, as a pure function.
505 pub fn classify_synced(path: &Path, home: &Path) -> Option<String> {
506 crate::shared::testing::classify_synced(path, home)
507 }
508
509 /// Whether a Linux `statfs` magic number is allowed.
510 pub fn linux_fs_allowed(magic: u32) -> bool {
511 crate::shared::testing::linux_fs_allowed(magic)
512 }
513
514 /// The lock layer for one brain.
515 #[derive(Debug)]
516 pub struct Locks(BrainLocks);
517
518 impl Locks {
519 pub fn new(path: &Path, opts: &SharedOptions) -> Result<Self> {
520 BrainLocks::new(path, opts).map(Locks)
521 }
522 /// A plain long operation's layer, which never creates the sidecar.
523 pub fn for_plain(path: &Path, opts: &SharedOptions) -> Result<Self> {
524 BrainLocks::for_plain(path, opts).map(Locks)
525 }
526 /// LOCK-2: how many times this layer's writers took the valve.
527 pub fn valve_takes(&self) -> u64 {
528 self.0.valve_takes()
529 }
530 pub fn shared(&mut self, opts: &SharedOptions) -> Result<Lock> {
531 let mut call = Call::new(opts.deadline, opts.cancel.as_ref());
532 self.0.acquire(LockKind::Shared, &mut call).map(Lock)
533 }
534 pub fn exclusive(&mut self, opts: &SharedOptions) -> Result<Lock> {
535 let mut call = Call::new(opts.deadline, opts.cancel.as_ref());
536 self.0.acquire(LockKind::Exclusive, &mut call).map(Lock)
537 }
538 pub fn has_sidecar(&self) -> bool {
539 self.0.has_sidecar()
540 }
541 pub fn sidecar_path(&self) -> Option<PathBuf> {
542 self.0.sidecar_path().map(Path::to_path_buf)
543 }
544 pub fn notices(&self) -> Vec<String> {
545 self.0.notices().to_vec()
546 }
547 }
548
549 /// One call's main lock; dropping it unlocks.
550 pub struct Lock(Held);
551
552 impl Lock {
553 pub fn announce(&mut self, op: &str) {
554 self.0.announce(op)
555 }
556 pub fn file(&self) -> &std::fs::File {
557 self.0.file()
558 }
559 }
560}
561
562/// WAL entry points for the PERF-1 allocation test
563/// (`tests/wal_recover_alloc.rs`), which needs its own global allocator and
564/// so can't live in this `forbid(unsafe_code)` crate. Not a stable API.
565#[doc(hidden)]
566pub mod __wal {
567 /// Page size of the WAL region.
568 pub const PAGE_SIZE: usize = crate::format::PAGE_SIZE;
569
570 /// One WAL frame: a home page number and its page image.
571 pub type Frame = (u64, Vec<u8>);
572
573 /// Bytes a transaction of `n` page frames occupies.
574 pub fn txn_byte_len(n: usize) -> u64 {
575 crate::wal::txn_byte_len(n, PAGE_SIZE)
576 }
577
578 /// Commit `frames` as transaction `txn_id` at the start of a region.
579 pub fn commit(
580 file: &mut std::fs::File,
581 wal_pages: u64,
582 txn_id: u64,
583 frames: &[Frame],
584 ) -> crate::Result<()> {
585 crate::wal::commit(file, 0, wal_pages, txn_id, frames)
586 }
587
588 /// Run open-time recovery over a region starting at page 0; returns the
589 /// frames to replay, if any.
590 pub fn recover(
591 file: &mut std::fs::File,
592 wal_pages: u64,
593 wal_seq: u64,
594 ) -> crate::Result<Option<Vec<Frame>>> {
595 crate::wal::recover(file, 0, wal_pages, wal_seq)
596 }
597}
598
599/// Internal parse surfaces exposed for cargo-fuzz targets (Phase 1.2).
600///
601/// **Not part of the stable public API.** Each function feeds an
602/// arbitrary byte slice into a parse/decode path that a hostile
603/// `.mnemo` file (or a hostile MCP client) can send us, and returns
604/// `Result<()>` so a fuzz target only asserts "no panic." Marked
605/// `#[doc(hidden)]` so `cargo doc` doesn't advertise it; do not import
606/// from application code.
607#[doc(hidden)]
608pub mod __fuzz {
609 /// Parse a `.mnemo` header page (page 0, plaintext) from arbitrary
610 /// bytes. This is the pre-passphrase attack surface — a hostile
611 /// file hits it before any DEK exists.
612 pub fn parse_header(bytes: &[u8]) -> crate::Result<()> {
613 crate::format::Header::from_page(bytes).map(|_| ())
614 }
615
616 /// Replay the WAL scan over an arbitrary byte region. Delegates
617 /// to [`crate::wal::recover_bytes`]; a corrupt / truncated /
618 /// adversarial region must return `Err` or `Ok(None/Some(_))`,
619 /// never panic.
620 pub fn wal_recover_bytes(region: &[u8], wal_seq: u64) -> crate::Result<()> {
621 crate::wal::recover_bytes(region, wal_seq).map(|_| ())
622 }
623
624 /// Decode a `Memory` record body from arbitrary bytes.
625 pub fn decode_memory(bytes: &[u8]) -> crate::Result<()> {
626 rmp_serde::from_slice::<crate::Memory>(bytes)
627 .map(|_| ())
628 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
629 }
630
631 /// FMT-9e: decode a v9 `Memory` record body from arbitrary bytes: a
632 /// zstd frame (a compressed thread turn) is decompressed first, under
633 /// the same content-size bound the store applies.
634 pub fn decode_v9_memory(bytes: &[u8]) -> crate::Result<()> {
635 let plain = crate::store::plain_record(bytes)?;
636 rmp_serde::from_slice::<crate::Memory>(&plain)
637 .map(|_| ())
638 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
639 }
640
641 /// Decode a `CacheEntry` record body from arbitrary bytes. Type is
642 /// `pub(crate)`, so this wrapper hides it behind a unit return.
643 pub fn decode_cache_entry(bytes: &[u8]) -> crate::Result<()> {
644 rmp_serde::from_slice::<crate::result_cache::CacheEntry>(bytes)
645 .map(|_| ())
646 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
647 }
648
649 /// Decode a cache-directory page-run body (a `Vec<CacheDirectoryEntry>`)
650 /// from arbitrary bytes.
651 pub fn decode_cache_directory(bytes: &[u8]) -> crate::Result<()> {
652 rmp_serde::from_slice::<Vec<crate::result_cache::CacheDirectoryEntry>>(bytes)
653 .map(|_| ())
654 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
655 }
656
657 /// Parse a single MCP stdio JSON-RPC request line. Malformed
658 /// input returns `Err(String)`; the fuzz target only asserts
659 /// no panic and that the server would not die on this line.
660 pub fn parse_mcp_request_line(line: &str) -> Result<(), String> {
661 crate::mcp::__fuzz_parse_request_line(line)
662 }
663}