Struct hermit::x86_64::mm::paging::PageTableEntryFlags

pub struct PageTableEntryFlags { /* fields omitted */ }

Possible flags for an entry in either table (PML4, PDPT, PD, PT)

See Intel Vol. 3A, Tables 4-14 through 4-19

Implementations

impl PageTableEntryFlags

pub const PRESENT: PageTableEntryFlags

Set if this entry is valid and points to a page or table.

pub const WRITABLE: PageTableEntryFlags

Set if memory referenced by this entry shall be writable.

pub const USER_ACCESSIBLE: PageTableEntryFlags

Set if memory referenced by this entry shall be accessible from user-mode (Ring 3).

pub const WRITE_THROUGH: PageTableEntryFlags

Set if Write-Through caching shall be enabled for memory referenced by this entry. Otherwise, Write-Back caching is used.

pub const CACHE_DISABLE: PageTableEntryFlags

Set if caching shall be disabled for memory referenced by this entry.

pub const ACCESSED: PageTableEntryFlags

Set if software has accessed this entry (for memory access or address translation).

pub const DIRTY: PageTableEntryFlags

Only for page entries: Set if software has written to the memory referenced by this entry.

pub const HUGE_PAGE: PageTableEntryFlags

Only for page entries in PDPT or PDT: Set if this entry references a 1 GiB (PDPT) or 2 MiB (PDT) page.

pub const GLOBAL: PageTableEntryFlags

Only for page entries: Set if this address translation is global for all tasks and does not need to be flushed from the TLB when CR3 is reset.

pub const EXECUTE_DISABLE: PageTableEntryFlags

Set if code execution shall be disabled for memory referenced by this entry.

pub const fn empty() -> PageTableEntryFlags

Returns an empty set of flags

pub const fn all() -> PageTableEntryFlags

Returns the set containing all flags.

pub const fn bits(&self) -> usize

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: usize) -> Option<PageTableEntryFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: usize) -> PageTableEntryFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: usize) -> PageTableEntryFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PageTableEntryFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: PageTableEntryFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PageTableEntryFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PageTableEntryFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PageTableEntryFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: PageTableEntryFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl PageTableEntryFlags

pub fn device(&mut self) -> &mut Self

pub fn normal(&mut self) -> &mut Self

pub fn read_only(&mut self) -> &mut Self

pub fn writable(&mut self) -> &mut Self

pub fn execute_disable(&mut self) -> &mut Self

Trait Implementations

impl Binary for PageTableEntryFlags

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

Formats the value using the given formatter.

impl BitAnd<PageTableEntryFlags> for PageTableEntryFlags

type Output = PageTableEntryFlags

The resulting type after applying the & operator.

fn bitand(self, other: PageTableEntryFlags) -> PageTableEntryFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<PageTableEntryFlags> for PageTableEntryFlags

fn bitand_assign(&mut self, other: PageTableEntryFlags)

Disables all flags disabled in the set.

impl BitOr<PageTableEntryFlags> for PageTableEntryFlags

type Output = PageTableEntryFlags

The resulting type after applying the | operator.

fn bitor(self, other: PageTableEntryFlags) -> PageTableEntryFlags

Returns the union of the two sets of flags.

impl BitOrAssign<PageTableEntryFlags> for PageTableEntryFlags

fn bitor_assign(&mut self, other: PageTableEntryFlags)

Adds the set of flags.

impl BitXor<PageTableEntryFlags> for PageTableEntryFlags

type Output = PageTableEntryFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: PageTableEntryFlags) -> PageTableEntryFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<PageTableEntryFlags> for PageTableEntryFlags

fn bitxor_assign(&mut self, other: PageTableEntryFlags)

Toggles the set of flags.

impl Clone for PageTableEntryFlags

fn clone(&self) -> PageTableEntryFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PageTableEntryFlags

impl Debug for PageTableEntryFlags

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

Formats the value using the given formatter.

impl Eq for PageTableEntryFlags

impl Extend<PageTableEntryFlags> for PageTableEntryFlags

fn extend<T: IntoIterator<Item = PageTableEntryFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<PageTableEntryFlags> for PageTableEntryFlags

fn from_iter<T: IntoIterator<Item = PageTableEntryFlags>>(
    iterator: T
) -> PageTableEntryFlags

Creates a value from an iterator.

impl Hash for PageTableEntryFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for PageTableEntryFlags

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

Formats the value using the given formatter.

impl Not for PageTableEntryFlags

type Output = PageTableEntryFlags

The resulting type after applying the ! operator.

fn not(self) -> PageTableEntryFlags

Returns the complement of this set of flags.

impl Octal for PageTableEntryFlags

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

Formats the value using the given formatter.

impl Ord for PageTableEntryFlags

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<PageTableEntryFlags> for PageTableEntryFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<PageTableEntryFlags> for PageTableEntryFlags

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for PageTableEntryFlags

impl StructuralPartialEq for PageTableEntryFlags

impl Sub<PageTableEntryFlags> for PageTableEntryFlags

type Output = PageTableEntryFlags

The resulting type after applying the - operator.

fn sub(self, other: PageTableEntryFlags) -> PageTableEntryFlags

Returns the set difference of the two sets of flags.

impl SubAssign<PageTableEntryFlags> for PageTableEntryFlags

fn sub_assign(&mut self, other: PageTableEntryFlags)

Disables all flags enabled in the set.

impl UpperHex for PageTableEntryFlags

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

Formats the value using the given formatter.