Skip to main content

PagePolicy

Enum PagePolicy 

Source
pub enum PagePolicy {
    Resident,
    LazyRowGranular,
    OnDemand,
}
Expand description

What the loader should do with a section’s pages.

This is the decision layer: a total, pure function of the access class, unit-testable with no syscalls and no unsafe. Applying it — mmap plus the matching madvise — belongs to the audited unsafe island in ftts-kernels, because ftts-artifacts is forbid(unsafe_code). Keeping the two apart means the policy can be argued about and tested here, where getting it wrong is cheap, rather than inside a syscall wrapper where it is not.

Variants§

§

Resident

Fault in eagerly and keep resident: MADV_WILLNEED.

Only for sections read every frame. The microdecoder pack is the whole reason this variant exists — it is reread 15× per frame and its residency is the project’s #1 design center.

§

LazyRowGranular

Map lazily and let the kernel fault pages in as they are touched, a row at a time.

Never MADV_WILLNEED. The text embedding is ~622 MB of which one synthesis touches a few kilobytes; prefetching it wholesale would dominate startup and evict the very pages PagePolicy::Resident exists to protect.

§

OnDemand

Map lazily, no advice. Enrollment sections a synthesis run never touches.

Implementations§

Source§

impl PagePolicy

Source

pub const fn as_str(self) -> &'static str

The stable wire string, for ftts inspect and the loader’s trace events.

Source

pub const fn may_prefetch(self) -> bool

Whether the loader may issue MADV_WILLNEED for this policy.

The single invariant the whole policy exists to enforce. Expressed as its own predicate so the syscall island can assert on it directly rather than re-deriving it from the class.

Trait Implementations§

Source§

impl Clone for PagePolicy

Source§

fn clone(&self) -> PagePolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for PagePolicy

Source§

impl Debug for PagePolicy

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for PagePolicy

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for PagePolicy

Source§

impl Ord for PagePolicy

Source§

fn cmp(&self, other: &PagePolicy) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for PagePolicy

Source§

fn eq(&self, other: &PagePolicy) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for PagePolicy

Source§

fn partial_cmp(&self, other: &PagePolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for PagePolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.