Struct x86_64::structures::paging::PageTableFlags

pub struct PageTableFlags { /* fields omitted */ }

Possible flags for a page table entry.

Methods

impl PageTableFlags

pub const PRESENT: PageTableFlags

Specifies whether the mapped frame or page table is loaded in memory.

pub const WRITABLE: PageTableFlags

Controls whether writes to the mapped frames are allowed.

If this bit is unset in a level 1 page table entry, the mapped frame is read-only. If this bit is unset in a higher level page table entry the complete range of mapped pages is read-only.

pub const USER_ACCESSIBLE: PageTableFlags

Controls whether accesses from userspace (i.e. ring 3) are permitted.

pub const WRITE_THROUGH: PageTableFlags

If this bit is set, a “write-through” policy is used for the cache, else a “write-back” policy is used.

pub const NO_CACHE: PageTableFlags

Disables caching for the pointed entry is cacheable.

pub const ACCESSED: PageTableFlags

Set by the CPU when the mapped frame or page table is accessed.

pub const DIRTY: PageTableFlags

Set by the CPU on a write to the mapped frame.

pub const HUGE_PAGE: PageTableFlags

Specifies that the entry maps a huge frame instead of a page table. Only allowed in P2 or P3 tables.

pub const GLOBAL: PageTableFlags

Indicates that the mapping is present in all address spaces, so it isn't flushed from the TLB on an address space switch.

pub const BIT_9: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_10: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_11: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_52: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_53: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_54: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_55: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_56: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_57: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_58: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_59: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_60: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_61: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const BIT_62: PageTableFlags

Available to the OS, can be used to store additional data, e.g. custom flags.

pub const NO_EXECUTE: PageTableFlags

Forbid code execution from the mapped frames.

Can be only used when the no-execute page protection feature is enabled in the EFER register.

pub fn empty() -> PageTableFlags

Returns an empty set of flags.

pub fn all() -> PageTableFlags

Returns the set containing all flags.

pub fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<PageTableFlags>

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

pub fn from_bits_truncate(bits: u64) -> PageTableFlags

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Clone for PageTableFlags

fn clone(&self) -> PageTableFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageTableFlags

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

Formats the value using the given formatter.

impl PartialEq<PageTableFlags> for PageTableFlags

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

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

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

This method tests for !=.

impl Eq for PageTableFlags

impl Ord for PageTableFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialOrd<PageTableFlags> for PageTableFlags

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

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

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

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

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

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

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

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

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

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

impl Hash for PageTableFlags

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 Copy for PageTableFlags

impl Sub<PageTableFlags> for PageTableFlags

type Output = PageTableFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<PageTableFlags> for PageTableFlags

fn sub_assign(&mut self, other: PageTableFlags)

Disables all flags enabled in the set.

impl Not for PageTableFlags

type Output = PageTableFlags

The resulting type after applying the ! operator.

fn not(self) -> PageTableFlags

Returns the complement of this set of flags.

impl BitAnd<PageTableFlags> for PageTableFlags

type Output = PageTableFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<PageTableFlags> for PageTableFlags

type Output = PageTableFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<PageTableFlags> for PageTableFlags

type Output = PageTableFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<PageTableFlags> for PageTableFlags

fn bitand_assign(&mut self, other: PageTableFlags)

Disables all flags disabled in the set.

impl BitOrAssign<PageTableFlags> for PageTableFlags

fn bitor_assign(&mut self, other: PageTableFlags)

Adds the set of flags.

impl BitXorAssign<PageTableFlags> for PageTableFlags

fn bitxor_assign(&mut self, other: PageTableFlags)

Toggles the set of flags.

impl Extend<PageTableFlags> for PageTableFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<PageTableFlags> for PageTableFlags

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

Creates a value from an iterator.

impl Octal for PageTableFlags

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

Formats the value using the given formatter.

impl Binary for PageTableFlags

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

Formats the value using the given formatter.

impl LowerHex for PageTableFlags

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

Formats the value using the given formatter.

impl UpperHex for PageTableFlags

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

Formats the value using the given formatter.