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};
96pub use memory::{
97 status as essence_status, CommitBatch, CommitReport, EssenceOp, EssenceOpKind, EssenceScope,
98 EssenceSection, ExportedTurn, Filter, FilterTerm, IngestReport, KeyScope, KeyedMemory, Memory,
99 MemoryPatch, MemoryType, Metric, Scope, ScoreWeights, ThreadTurn, TurnPolicy, WriteOutcome,
100 CONTINUATION_TIMELINE_ENTRIES, ESSENCE_DEFAULT_RENDER_BYTES, ESSENCE_SECTION_MAX_BYTES,
101 ESSENCE_TIMELINE_MAX_BYTES, ESSENCE_TRANSITIONS, FINDING_TRANSITIONS, MNEMO_META_CONTINUES,
102 MNEMO_META_INVALID_AT, MNEMO_META_KEY, MNEMO_META_KIND, MNEMO_META_KIND_ESSENCE,
103 MNEMO_META_KIND_THREAD_LINK, MNEMO_META_KIND_TURN, MNEMO_META_LENGTH, MNEMO_META_MARKERS_ONLY,
104 MNEMO_META_NS, MNEMO_META_PART, MNEMO_META_REFS, MNEMO_META_ROLE, MNEMO_META_SECTION,
105 MNEMO_META_SEQ, MNEMO_META_SHA256, MNEMO_META_STATUS, MNEMO_META_STATUS_HISTORY,
106 MNEMO_META_SUPERSEDED_BY, MNEMO_META_SUPERSEDES, MNEMO_META_THREAD, MNEMO_META_TURN_ID,
107 MNEMO_META_UPDATED_AT, TASK_TRANSITIONS, THREAD_TOOL_RESULT_TRUNCATE_BYTES,
108 THREAD_TURN_CHUNK_BYTES,
109};
110pub use result_cache::{
111 CacheBudget, CacheFlushPolicy, CachePutOpts, CacheStats, CachedValue, SemanticCachePutOpts,
112 DEFAULT_BATCH_MAX_AGE, DEFAULT_BATCH_MAX_DIRTY, DEFAULT_MAX_BYTES, DEFAULT_MAX_ENTRIES,
113 DEFAULT_SEMANTIC_THRESHOLD,
114};
115pub use session::{Role, Session, Turn};
116pub use shared::{CancelToken, SharedOptions};
117#[doc(hidden)]
118#[cfg(feature = "dev-hooks")]
119pub use store::BudgetReport;
120pub use store::{
121 CloseError, CompactReport, Mnemo, MnemoConfig, RecallMode, RecallRequest, RecallResponse,
122 RecallResult, ReembedReport, SharedMnemo, SnapshotInfo, Stats, StatsSummary, VerifyReport,
123 DEFAULT_KEYWORD_WEIGHT, DEFAULT_TEXT_KEYWORD_WEIGHT, DEFAULT_TURN_COMPRESS_AFTER_SECS,
124 DEFAULT_VECTOR_CACHE_BUDGET, INDEX_PERSIST_EVERY_CHANGES, INDEX_PERSIST_EVERY_COMMITS,
125 V9_ANN_MIN_FACTS, V9_RERANK_PER_HIT,
126};
127pub use text::{KeywordIndex, KeywordTokenizer};
128pub use transcript::{
129 read_transcript, read_transcript_with, ToolResults, TranscriptFormat, TranscriptOptions,
130};
131
132/// Re-export of [`ulid::Ulid`], the identifier type used for memories.
133pub use ulid::Ulid;
134
135// --- Fsync counter -----------------------------------------------------
136//
137// Instrumentation plumbing for the Phase 6 top-3 cost #2 fix: the
138// planner wants to know how many `sync_all` calls each `flush()` issues
139// before deciding whether to batch any of them. Every fsync call site
140// bumps a thread-local counter; `Mnemo::flush` snapshots it before and
141// after, exposing the delta on `Stats::fsyncs_last_flush`. Thread-local
142// so handles on separate threads don't poison each other's counts; the
143// engine's one-writer-at-a-time locking means a single handle sees a
144// coherent stream.
145
146mod fsync_counter {
147 use std::cell::Cell;
148
149 thread_local! {
150 static COUNT: Cell<u64> = const { Cell::new(0) };
151 }
152
153 /// Call once per `sync_all`.
154 pub(crate) fn bump() {
155 COUNT.with(|c| c.set(c.get().wrapping_add(1)));
156 }
157
158 /// Monotonic counter snapshot for this thread.
159 pub(crate) fn count() -> u64 {
160 COUNT.with(|c| c.get())
161 }
162}
163
164pub(crate) use fsync_counter::{bump as bump_fsync, count as fsync_count};
165
166/// Build-time cryptographic backend information.
167///
168/// Populated at compile time from the active `cfg` flags. On ARMv8
169/// builds compiled with `--cfg aes_armv8 --cfg polyval_armv8` (set by
170/// the repo's `.cargo/config.toml` and both CI workflows) the `aes`
171/// and `polyval` crates emit hardware AES + PMULL instructions; without
172/// those flags they fall back to a constant-time software path that
173/// runs at roughly 5× the cost per page.
174///
175/// Published through [`build_info`], exposed by `mnemo info` on the
176/// CLI and `mnemo.build_info()` from the Python binding. The point is
177/// verification — nobody should have to profile a release build to find
178/// out whether it's running software AES.
179#[derive(Debug, Clone, Copy, PartialEq, Eq)]
180pub struct BuildInfo {
181 /// Package version (`CARGO_PKG_VERSION`), e.g. `"0.5.1"`.
182 pub version: &'static str,
183 /// Target triple this binary was built for, e.g.
184 /// `"aarch64-apple-darwin"`.
185 pub target: &'static str,
186 /// Human-readable AES backend. One of:
187 /// - `"armv8 hardware"` — ARM with `cfg(aes_armv8)`
188 /// - `"armv8 software"` — ARM without the cfg; constant-time fallback
189 /// - `"x86_64 AES-NI (runtime detect)"` — x86_64 with runtime
190 /// AES-NI detection in the `aes` crate
191 /// - `"portable software"` — any other target
192 pub aes_backend: &'static str,
193 /// Human-readable PMULL/CLMUL backend used by GHASH (part of AES-GCM).
194 /// Same shape as `aes_backend` but for `polyval`.
195 pub polyval_backend: &'static str,
196}
197
198/// Report this build's cryptographic backend configuration.
199///
200/// Cheap — all fields are `&'static str` populated at compile time.
201/// Safe to call from a hot path if, for some reason, that's useful.
202pub fn build_info() -> BuildInfo {
203 BuildInfo {
204 version: env!("CARGO_PKG_VERSION"),
205 target: TARGET_TRIPLE,
206 aes_backend: aes_backend_name(),
207 polyval_backend: polyval_backend_name(),
208 }
209}
210
211/// Target triple baked in via the `TARGET` env var that `cargo` sets
212/// for the host compile. Falls back to `"unknown"` if the var isn't
213/// set at build time (shouldn't happen under cargo, but a build.rs-free
214/// implementation keeps this crate build-script-free, so we use a
215/// cfg-based dispatch as the second-best).
216const TARGET_TRIPLE: &str = {
217 // `env!("TARGET")` isn't set by cargo for crates; it's set by rustc
218 // only for `std` builds. We approximate from `target_arch` /
219 // `target_os` cfgs so this stays build-script-free. Good enough
220 // for an info line; precise triples are a `cargo` or build.rs job.
221 if cfg!(all(target_arch = "aarch64", target_os = "macos")) {
222 "aarch64-apple-darwin"
223 } else if cfg!(all(target_arch = "aarch64", target_os = "linux")) {
224 "aarch64-unknown-linux-gnu"
225 } else if cfg!(all(target_arch = "x86_64", target_os = "macos")) {
226 "x86_64-apple-darwin"
227 } else if cfg!(all(target_arch = "x86_64", target_os = "linux")) {
228 "x86_64-unknown-linux-gnu"
229 } else if cfg!(all(target_arch = "x86_64", target_os = "windows")) {
230 "x86_64-pc-windows-msvc"
231 } else {
232 "unknown"
233 }
234};
235
236const fn aes_backend_name() -> &'static str {
237 if cfg!(aes_armv8) {
238 "armv8 hardware"
239 } else if cfg!(target_arch = "aarch64") {
240 // Software fallback is the dangerous case this whole mechanism
241 // exists to surface — flag it clearly so `mnemo info` makes it
242 // easy to notice a build picked up the slow path by mistake.
243 "armv8 software (constant-time fallback)"
244 } else if cfg!(target_arch = "x86_64") {
245 // `aes` 0.8.4 on x86_64 picks AES-NI vs the software path at
246 // runtime via the `cpufeatures` crate, so we can't tell from
247 // cfg alone which path a given invocation takes. In practice
248 // every x86_64 CPU shipped since ~2010 has AES-NI.
249 "x86_64 AES-NI (runtime detect)"
250 } else {
251 "portable software"
252 }
253}
254
255const fn polyval_backend_name() -> &'static str {
256 if cfg!(polyval_armv8) {
257 "armv8 PMULL hardware"
258 } else if cfg!(target_arch = "aarch64") {
259 "armv8 software (constant-time fallback)"
260 } else if cfg!(target_arch = "x86_64") {
261 "x86_64 CLMUL (runtime detect)"
262 } else {
263 "portable software"
264 }
265}
266
267/// **Not a stable API** (`dev-hooks` builds only): how many `sync_all`
268/// calls this thread has made, for step 5's bench to count a write's
269/// fsyncs.
270#[cfg(feature = "dev-hooks")]
271#[doc(hidden)]
272pub fn __fsync_count() -> u64 {
273 fsync_count()
274}
275
276/// Test-only crash-injection surface used by the Phase 1.3 proptest
277/// (`mnemo/tests/proptest_store.rs`). Compiled in under `cfg(test)`
278/// and the `failpoints` feature only; absent from release builds.
279///
280/// **Not part of the stable public API.** The double-underscore
281/// convention makes the "internal" contract obvious at the call site.
282#[cfg(any(test, feature = "failpoints"))]
283#[doc(hidden)]
284pub mod __failpoints {
285 /// Arm the pager and WAL commit path to fail on the Nth
286 /// subsequent write. `n = 0` fails the very next write; `n = -1`
287 /// (or any negative) disables. One-shot — disarms on trigger.
288 ///
289 /// Every write is checked before the byte hits the file, so a
290 /// triggered failure is guaranteed torn-BEFORE, never
291 /// torn-AFTER — critical for the "either pre-flush or post-flush"
292 /// invariant the property test asserts.
293 pub fn set_writes_until_fail(n: i64) {
294 crate::pager::failpoints::set_writes_until_fail(n)
295 }
296
297 /// Like [`set_writes_until_fail`], but `count` writes in a row fail.
298 pub fn set_writes_until_fail_n(n: i64, count: u32) {
299 crate::pager::failpoints::set_writes_until_fail_n(n, count)
300 }
301
302 /// Fail exactly the writes numbered in `ns` (from 0, counting from this
303 /// call), consecutive or not; an empty set disarms it.
304 pub fn set_writes_failing(ns: &[u64]) {
305 crate::pager::failpoints::set_writes_failing(ns)
306 }
307
308 /// How many writes this thread has made since the last
309 /// [`set_writes_failing`].
310 pub fn writes_seen() -> u64 {
311 crate::pager::failpoints::writes_seen()
312 }
313
314 thread_local! {
315 static AFTER_SHARED_COMMIT: std::cell::RefCell<Option<Box<dyn FnOnce()>>> =
316 const { std::cell::RefCell::new(None) };
317 static BEFORE_SHARED_COMMIT: std::cell::RefCell<Option<Box<dyn FnOnce()>>> =
318 const { std::cell::RefCell::new(None) };
319 }
320
321 /// Run `f` once, inside this thread's next shared-mode write, after the
322 /// window's closure and before the window's commit (so after the
323 /// window's identity check, 12.4 protocol step 4). Lets a test rename a
324 /// file over the path the way an older build's compaction can.
325 pub fn before_next_shared_commit(f: impl FnOnce() + 'static) {
326 BEFORE_SHARED_COMMIT.with(|c| *c.borrow_mut() = Some(Box::new(f)));
327 }
328
329 pub(crate) fn run_before_shared_commit() {
330 if let Some(f) = BEFORE_SHARED_COMMIT.with(|c| c.borrow_mut().take()) {
331 f();
332 }
333 }
334
335 /// Run `f` once, inside this thread's next shared-mode write, after its
336 /// commit and before the identity check that follows (12.4 protocol
337 /// step 8). Lets a test rename a file over the path at that moment.
338 pub fn after_next_shared_commit(f: impl FnOnce() + 'static) {
339 AFTER_SHARED_COMMIT.with(|c| *c.borrow_mut() = Some(Box::new(f)));
340 }
341
342 pub(crate) fn run_after_shared_commit() {
343 if let Some(f) = AFTER_SHARED_COMMIT.with(|c| c.borrow_mut().take()) {
344 f();
345 }
346 }
347
348 thread_local! {
349 static NEXT_TEMP_NAME: std::cell::RefCell<Option<std::path::PathBuf>> =
350 const { std::cell::RefCell::new(None) };
351 }
352
353 /// Make the next temp file name this thread asks for (compaction,
354 /// `export_encrypted`, `export_rekeyed`) be `path`, once; the attempts
355 /// after it are generated as usual. Lets a test plant a file or a
356 /// symlink at the exact name the engine is about to use.
357 pub fn set_next_temp_name(path: impl Into<std::path::PathBuf>) {
358 NEXT_TEMP_NAME.with(|n| *n.borrow_mut() = Some(path.into()));
359 }
360
361 pub(crate) fn take_next_temp_name() -> Option<std::path::PathBuf> {
362 NEXT_TEMP_NAME.with(|n| n.borrow_mut().take())
363 }
364
365 thread_local! {
366 static SHARED_MAIN_TRIES: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
367 static SHARED_REPLACED: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
368 }
369
370 /// How many times this thread's shared-mode calls have tried the main
371 /// lock (each open, lock and identity check counts once).
372 pub fn shared_main_tries() -> u64 {
373 SHARED_MAIN_TRIES.with(|c| c.get())
374 }
375
376 pub(crate) fn count_shared_main_try() {
377 SHARED_MAIN_TRIES.with(|c| c.set(c.get() + 1));
378 }
379
380 /// Make this thread's next `n` shared-mode tries at the main lock find
381 /// the file replaced (as if a compaction renamed a new file over the
382 /// path between the open and the lock each time). `0` disarms.
383 pub fn set_shared_replaced(n: u64) {
384 SHARED_REPLACED.with(|c| c.set(n));
385 }
386
387 thread_local! {
388 static EUID_OVERRIDE: std::cell::Cell<Option<u32>> = const { std::cell::Cell::new(None) };
389 }
390
391 /// Make this thread's file-owner checks (the dead compaction temp
392 /// files' cleanup) compare against `uid` instead of the effective uid,
393 /// so a test can see a file as another user's without root. `None`
394 /// restores the real check.
395 pub fn set_euid_override(uid: Option<u32>) {
396 EUID_OVERRIDE.with(|c| c.set(uid));
397 }
398
399 // Read by the Unix owner check only.
400 #[cfg(unix)]
401 pub(crate) fn euid_override() -> Option<u32> {
402 EUID_OVERRIDE.with(|c| c.get())
403 }
404
405 thread_local! {
406 static PATH_CHECK_FAILURES: std::cell::Cell<u64> = const { std::cell::Cell::new(0) };
407 }
408
409 /// Make this thread's next `n` checks that a handle's path still names
410 /// its open file fail with a permission error (RB-008.2), as when the
411 /// process has lost access to the path. `0` disarms.
412 pub fn set_path_check_failures(n: u64) {
413 PATH_CHECK_FAILURES.with(|c| c.set(n));
414 }
415
416 /// How many armed path-check failures this thread has left.
417 pub fn path_check_failures_left() -> u64 {
418 PATH_CHECK_FAILURES.with(|c| c.get())
419 }
420
421 pub(crate) fn take_path_check_failure() -> bool {
422 PATH_CHECK_FAILURES.with(|c| {
423 let n = c.get();
424 if n > 0 {
425 c.set(n - 1);
426 }
427 n > 0
428 })
429 }
430
431 pub(crate) fn take_shared_replaced() -> bool {
432 SHARED_REPLACED.with(|c| {
433 let n = c.get();
434 if n > 0 {
435 c.set(n - 1);
436 }
437 n > 0
438 })
439 }
440}
441
442/// 12.4 step 2a: the shared lock layer, reached directly by its tests
443/// (`tests/shared_lock.rs`) until `Mnemo::open_shared` (step 2b) wraps it.
444/// Compiled in under `cfg(test)` and the `failpoints` feature only.
445///
446/// **Not part of the stable public API.**
447#[cfg(any(test, feature = "failpoints"))]
448#[doc(hidden)]
449pub mod __shared {
450 use std::path::{Path, PathBuf};
451
452 use crate::shared::{BrainLocks, Call, Held, LockKind};
453 use crate::{Result, SharedOptions};
454
455 /// The sidecar directory's suffix and its two file names.
456 pub const SUFFIX: &str = crate::shared::testing::SUFFIX;
457 pub const INTENT: &str = crate::shared::testing::INTENT;
458 pub const LOCK_INFO: &str = crate::shared::testing::LOCK_INFO;
459 /// LOCK-2's valve file name.
460 pub const VALVE: &str = crate::shared::testing::VALVE;
461
462 /// Whether this build refuses shared mode (Windows, Rust before 1.85).
463 pub const WINDOWS_OLD_RENAME: bool = crate::shared::WINDOWS_OLD_RENAME;
464
465 /// `<brain>.mnemo-shared` for a resolved brain path.
466 pub fn sidecar_path(brain: &Path) -> PathBuf {
467 crate::shared::testing::sidecar_path(brain)
468 }
469
470 /// The macOS synced-folder rule, as a pure function.
471 pub fn classify_synced(path: &Path, home: &Path) -> Option<String> {
472 crate::shared::testing::classify_synced(path, home)
473 }
474
475 /// Whether a Linux `statfs` magic number is allowed.
476 pub fn linux_fs_allowed(magic: u32) -> bool {
477 crate::shared::testing::linux_fs_allowed(magic)
478 }
479
480 /// The lock layer for one brain.
481 #[derive(Debug)]
482 pub struct Locks(BrainLocks);
483
484 impl Locks {
485 pub fn new(path: &Path, opts: &SharedOptions) -> Result<Self> {
486 BrainLocks::new(path, opts).map(Locks)
487 }
488 /// A plain long operation's layer, which never creates the sidecar.
489 pub fn for_plain(path: &Path, opts: &SharedOptions) -> Result<Self> {
490 BrainLocks::for_plain(path, opts).map(Locks)
491 }
492 /// LOCK-2: how many times this layer's writers took the valve.
493 pub fn valve_takes(&self) -> u64 {
494 self.0.valve_takes()
495 }
496 pub fn shared(&mut self, opts: &SharedOptions) -> Result<Lock> {
497 let mut call = Call::new(opts.deadline, opts.cancel.as_ref());
498 self.0.acquire(LockKind::Shared, &mut call).map(Lock)
499 }
500 pub fn exclusive(&mut self, opts: &SharedOptions) -> Result<Lock> {
501 let mut call = Call::new(opts.deadline, opts.cancel.as_ref());
502 self.0.acquire(LockKind::Exclusive, &mut call).map(Lock)
503 }
504 pub fn has_sidecar(&self) -> bool {
505 self.0.has_sidecar()
506 }
507 pub fn sidecar_path(&self) -> Option<PathBuf> {
508 self.0.sidecar_path().map(Path::to_path_buf)
509 }
510 pub fn notices(&self) -> Vec<String> {
511 self.0.notices().to_vec()
512 }
513 }
514
515 /// One call's main lock; dropping it unlocks.
516 pub struct Lock(Held);
517
518 impl Lock {
519 pub fn announce(&mut self, op: &str) {
520 self.0.announce(op)
521 }
522 pub fn file(&self) -> &std::fs::File {
523 self.0.file()
524 }
525 }
526}
527
528/// WAL entry points for the PERF-1 allocation test
529/// (`tests/wal_recover_alloc.rs`), which needs its own global allocator and
530/// so can't live in this `forbid(unsafe_code)` crate. Not a stable API.
531#[doc(hidden)]
532pub mod __wal {
533 /// Page size of the WAL region.
534 pub const PAGE_SIZE: usize = crate::format::PAGE_SIZE;
535
536 /// One WAL frame: a home page number and its page image.
537 pub type Frame = (u64, Vec<u8>);
538
539 /// Bytes a transaction of `n` page frames occupies.
540 pub fn txn_byte_len(n: usize) -> u64 {
541 crate::wal::txn_byte_len(n, PAGE_SIZE)
542 }
543
544 /// Commit `frames` as transaction `txn_id` at the start of a region.
545 pub fn commit(
546 file: &mut std::fs::File,
547 wal_pages: u64,
548 txn_id: u64,
549 frames: &[Frame],
550 ) -> crate::Result<()> {
551 crate::wal::commit(file, 0, wal_pages, txn_id, frames)
552 }
553
554 /// Run open-time recovery over a region starting at page 0; returns the
555 /// frames to replay, if any.
556 pub fn recover(
557 file: &mut std::fs::File,
558 wal_pages: u64,
559 wal_seq: u64,
560 ) -> crate::Result<Option<Vec<Frame>>> {
561 crate::wal::recover(file, 0, wal_pages, wal_seq)
562 }
563}
564
565/// Internal parse surfaces exposed for cargo-fuzz targets (Phase 1.2).
566///
567/// **Not part of the stable public API.** Each function feeds an
568/// arbitrary byte slice into a parse/decode path that a hostile
569/// `.mnemo` file (or a hostile MCP client) can send us, and returns
570/// `Result<()>` so a fuzz target only asserts "no panic." Marked
571/// `#[doc(hidden)]` so `cargo doc` doesn't advertise it; do not import
572/// from application code.
573#[doc(hidden)]
574pub mod __fuzz {
575 /// Parse a `.mnemo` header page (page 0, plaintext) from arbitrary
576 /// bytes. This is the pre-passphrase attack surface — a hostile
577 /// file hits it before any DEK exists.
578 pub fn parse_header(bytes: &[u8]) -> crate::Result<()> {
579 crate::format::Header::from_page(bytes).map(|_| ())
580 }
581
582 /// Replay the WAL scan over an arbitrary byte region. Delegates
583 /// to [`crate::wal::recover_bytes`]; a corrupt / truncated /
584 /// adversarial region must return `Err` or `Ok(None/Some(_))`,
585 /// never panic.
586 pub fn wal_recover_bytes(region: &[u8], wal_seq: u64) -> crate::Result<()> {
587 crate::wal::recover_bytes(region, wal_seq).map(|_| ())
588 }
589
590 /// Decode a `Memory` record body from arbitrary bytes.
591 pub fn decode_memory(bytes: &[u8]) -> crate::Result<()> {
592 rmp_serde::from_slice::<crate::Memory>(bytes)
593 .map(|_| ())
594 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
595 }
596
597 /// FMT-9e: decode a v9 `Memory` record body from arbitrary bytes: a
598 /// zstd frame (a compressed thread turn) is decompressed first, under
599 /// the same content-size bound the store applies.
600 pub fn decode_v9_memory(bytes: &[u8]) -> crate::Result<()> {
601 let plain = crate::store::plain_record(bytes)?;
602 rmp_serde::from_slice::<crate::Memory>(&plain)
603 .map(|_| ())
604 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
605 }
606
607 /// Decode a `CacheEntry` record body from arbitrary bytes. Type is
608 /// `pub(crate)`, so this wrapper hides it behind a unit return.
609 pub fn decode_cache_entry(bytes: &[u8]) -> crate::Result<()> {
610 rmp_serde::from_slice::<crate::result_cache::CacheEntry>(bytes)
611 .map(|_| ())
612 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
613 }
614
615 /// Decode a cache-directory page-run body (a `Vec<CacheDirectoryEntry>`)
616 /// from arbitrary bytes.
617 pub fn decode_cache_directory(bytes: &[u8]) -> crate::Result<()> {
618 rmp_serde::from_slice::<Vec<crate::result_cache::CacheDirectoryEntry>>(bytes)
619 .map(|_| ())
620 .map_err(|e| crate::MnemoError::Serialize(e.to_string()))
621 }
622
623 /// Parse a single MCP stdio JSON-RPC request line. Malformed
624 /// input returns `Err(String)`; the fuzz target only asserts
625 /// no panic and that the server would not die on this line.
626 pub fn parse_mcp_request_line(line: &str) -> Result<(), String> {
627 crate::mcp::__fuzz_parse_request_line(line)
628 }
629}