ax_memory_set/
lib.rs

1#![cfg_attr(not(test), no_std)]
2#![doc = include_str!("../README.md")]
3
4extern crate alloc;
5
6mod area;
7mod backend;
8mod set;
9
10#[cfg(test)]
11mod tests;
12
13pub use self::{area::MemoryArea, backend::MappingBackend, set::MemorySet};
14
15/// Error type for memory mapping operations.
16#[derive(Debug, Eq, PartialEq, thiserror::Error)]
17pub enum MappingError {
18    /// Invalid parameter (e.g., `addr`, `size`, `flags`, etc.)
19    #[error("invalid mapping parameter")]
20    InvalidParam,
21    /// The given range overlaps with an existing mapping.
22    #[error("mapping already exists")]
23    AlreadyExists,
24    /// The backend page table is in a bad state.
25    #[error("mapping backend is in a bad state")]
26    BadState,
27    /// A fallible operation changed part of the materialized page table but
28    /// could not prove that its inverse restored every preimage.  Callers must
29    /// quarantine the address-space range and repair it before reuse.
30    #[error("mapping operation requires repair")]
31    NeedsRepair,
32}
33
34/// A [`Result`] type with [`MappingError`] as the error type.
35pub type MappingResult<T = ()> = Result<T, MappingError>;
ax_memory_set/lib.rs

ax_memory_set/
lib.rs
