Struct page_table_entry::x86_64::PTF

pub struct PTF { /* private fields */ }

Available on x86-64 only.

Possible flags for a page table entry.

Implementations

impl PageTableFlags

pub const PRESENT: PageTableFlags = Self{ bits: 1,}

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

pub const WRITABLE: PageTableFlags = Self{ bits: 1 << 1,}

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 = Self{ bits: 1 << 2,}

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

pub const WRITE_THROUGH: PageTableFlags = Self{ bits: 1 << 3,}

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 = Self{ bits: 1 << 4,}

Disables caching for the pointed entry is cacheable.

pub const ACCESSED: PageTableFlags = Self{ bits: 1 << 5,}

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

pub const DIRTY: PageTableFlags = Self{ bits: 1 << 6,}

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

pub const HUGE_PAGE: PageTableFlags = Self{ bits: 1 << 7,}

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

pub const GLOBAL: PageTableFlags = Self{ bits: 1 << 8,}

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 = Self{ bits: 1 << 9,}

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

pub const BIT_10: PageTableFlags = Self{ bits: 1 << 10,}

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

pub const BIT_11: PageTableFlags = Self{ bits: 1 << 11,}

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

pub const BIT_52: PageTableFlags = Self{ bits: 1 << 52,}

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

pub const BIT_53: PageTableFlags = Self{ bits: 1 << 53,}

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

pub const BIT_54: PageTableFlags = Self{ bits: 1 << 54,}

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

pub const BIT_55: PageTableFlags = Self{ bits: 1 << 55,}

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

pub const BIT_56: PageTableFlags = Self{ bits: 1 << 56,}

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

pub const BIT_57: PageTableFlags = Self{ bits: 1 << 57,}

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

pub const BIT_58: PageTableFlags = Self{ bits: 1 << 58,}

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

pub const BIT_59: PageTableFlags = Self{ bits: 1 << 59,}

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

pub const BIT_60: PageTableFlags = Self{ bits: 1 << 60,}

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

pub const BIT_61: PageTableFlags = Self{ bits: 1 << 61,}

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

pub const BIT_62: PageTableFlags = Self{ bits: 1 << 62,}

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

pub const NO_EXECUTE: PageTableFlags = Self{ bits: 1 << 63,}

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 const fn empty() -> PageTableFlags

Returns an empty set of flags.

pub const fn all() -> PageTableFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub const 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 const fn from_bits_truncate(bits: u64) -> PageTableFlags

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> PageTableFlags

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: PageTableFlags) -> bool

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

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

Returns true if 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.

pub const fn intersection(self, other: PageTableFlags) -> PageTableFlags

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: PageTableFlags) -> PageTableFlags

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: PageTableFlags) -> PageTableFlags

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: PageTableFlags) -> PageTableFlags

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> PageTableFlags

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for PageTableFlags

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

Formats the value using the given formatter.

impl BitAnd<PageTableFlags> for PageTableFlags

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

Returns the intersection between the two sets of flags.

type Output = PageTableFlags

The resulting type after applying the & operator.

impl BitAndAssign<PageTableFlags> for PageTableFlags

fn bitand_assign(&mut self, other: PageTableFlags)

Disables all flags disabled in the set.

impl BitOr<PageTableFlags> for PageTableFlags

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

Returns the union of the two sets of flags.

type Output = PageTableFlags

The resulting type after applying the | operator.

impl BitOrAssign<PageTableFlags> for PageTableFlags

fn bitor_assign(&mut self, other: PageTableFlags)

Adds the set of flags.

impl BitXor<PageTableFlags> for PageTableFlags

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

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

type Output = PageTableFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<PageTableFlags> for PageTableFlags

fn bitxor_assign(&mut self, other: PageTableFlags)

Toggles the set of flags.

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<(), Error>

Formats the value using the given formatter.

impl Extend<PageTableFlags> for PageTableFlags

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

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 From<MappingFlags> for PTF

fn from(f: MappingFlags) -> Self

Converts to this type from the input type.

impl From<PageTableFlags> for MappingFlags

fn from(f: PTF) -> Self

Converts to this type from the input type.

impl FromIterator<PageTableFlags> for PageTableFlags

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

Creates a value from an iterator.

impl Hash for PageTableFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for PageTableFlags

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

Formats the value using the given formatter.

impl Not for PageTableFlags

fn not(self) -> PageTableFlags

Returns the complement of this set of flags.

type Output = PageTableFlags

The resulting type after applying the ! operator.

impl Octal for PageTableFlags

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

Formats the value using the given formatter.

impl Ord for PageTableFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl Sub<PageTableFlags> for PageTableFlags

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

Returns the set difference of the two sets of flags.

type Output = PageTableFlags

The resulting type after applying the - operator.

impl SubAssign<PageTableFlags> for PageTableFlags

fn sub_assign(&mut self, other: PageTableFlags)

Disables all flags enabled in the set.

impl UpperHex for PageTableFlags

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

Formats the value using the given formatter.

impl Copy for PageTableFlags

impl Eq for PageTableFlags

impl StructuralEq for PageTableFlags

impl StructuralPartialEq for PageTableFlags