Struct procfs::PhysicalPageFlags

pub struct PhysicalPageFlags { /* private fields */ }

Represents the fields and flags in a page table entry for a memory page.

Implementations

impl PhysicalPageFlags

pub const LOCKED: Self = _

The page is being locked for exclusive access, e.g. by undergoing read/write IO

pub const ERROR: Self = _

IO error occurred

pub const REFERENCED: Self = _

The page has been referenced since last LRU list enqueue/requeue

pub const UPTODATE: Self = _

The page has up-to-date data. ie. for file backed page: (in-memory data revision >= on-disk one)

pub const DIRTY: Self = _

The page has been written to, hence contains new data. i.e. for file backed page: (in-memory data revision > on-disk one)

pub const LRU: Self = _

The page is in one of the LRU lists

pub const ACTIVE: Self = _

The page is in the active LRU list

pub const SLAB: Self = _

The page is managed by the SLAB/SLOB/SLUB/SLQB kernel memory allocator. When compound page is used, SLUB/SLQB will only set this flag on the head page; SLOB will not flag it at all

pub const WRITEBACK: Self = _

The page is being synced to disk

pub const RECLAIM: Self = _

The page will be reclaimed soon after its pageout IO completed

pub const BUDDY: Self = _

A free memory block managed by the buddy system allocator. The buddy system organizes free memory in blocks of various orders. An order N block has 2^N physically contiguous pages, with the BUDDY flag set for and only for the first page

pub const MMAP: Self = _

A memory mapped page

pub const ANON: Self = _

A memory mapped page that is not part of a file

pub const SWAPCACHE: Self = _

The page is mapped to swap space, i.e. has an associated swap entry

pub const SWAPBACKED: Self = _

The page is backed by swap/RAM

pub const COMPOUND_HEAD: Self = _

A compound page with order N consists of 2^N physically contiguous pages. A compound page with order 2 takes the form of “HTTT”, where H donates its head page and T donates its tail page(s). The major consumers of compound pages are hugeTLB pages (https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html#hugetlbpage), the SLUB etc. memory allocators and various device drivers. However in this interface, only huge/giga pages are made visible to end users

pub const COMPOUND_TAIL: Self = _

A compound page tail (see description above)

pub const HUGE: Self = _

This is an integral part of a HugeTLB page

pub const UNEVICTABLE: Self = _

The page is in the unevictable (non-)LRU list It is somehow pinned and not a candidate for LRU page reclaims, e.g. ramfs pages, shmctl(SHM_LOCK) and mlock() memory segments

pub const HWPOISON: Self = _

Hardware detected memory corruption on this page: don’t touch the data!

pub const NOPAGE: Self = _

No page frame exists at the requested address

pub const KSM: Self = _

Identical memory pages dynamically shared between one or more processes

pub const THP: Self = _

Contiguous pages which construct transparent hugepages

pub const OFFLINE: Self = _

The page is logically offline

pub const ZERO_PAGE: Self = _

Zero page for pfn_zero or huge_zero page

pub const IDLE: Self = _

The page has not been accessed since it was marked idle (see https://www.kernel.org/doc/html/latest/admin-guide/mm/idle_page_tracking.html#idle-page-tracking). Note that this flag may be stale in case the page was accessed via a PTE. To make sure the flag is up-to-date one has to read /sys/kernel/mm/page_idle/bitmap first

pub const PGTABLE: Self = _

The page is in use as a page table

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

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<Self>

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) -> Self

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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: Self) -> Self

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: Self) -> Self

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: Self) -> Self

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) -> Self

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 PhysicalPageFlags

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

Formats the value using the given formatter.

impl BitAnd<PhysicalPageFlags> for PhysicalPageFlags

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

Returns the intersection between the two sets of flags.

type Output = PhysicalPageFlags

The resulting type after applying the & operator.

impl BitAndAssign<PhysicalPageFlags> for PhysicalPageFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<PhysicalPageFlags> for PhysicalPageFlags

fn bitor(self, other: PhysicalPageFlags) -> Self

Returns the union of the two sets of flags.

type Output = PhysicalPageFlags

The resulting type after applying the | operator.

impl BitOrAssign<PhysicalPageFlags> for PhysicalPageFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<PhysicalPageFlags> for PhysicalPageFlags

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

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

type Output = PhysicalPageFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<PhysicalPageFlags> for PhysicalPageFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for PhysicalPageFlags

fn clone(&self) -> PhysicalPageFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicalPageFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PhysicalPageFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<PhysicalPageFlags> for PhysicalPageFlags

fn extend<T: IntoIterator<Item = Self>>(&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<PhysicalPageFlags> for PhysicalPageFlags

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

Creates a value from an iterator.

impl Hash for PhysicalPageFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for PhysicalPageFlags

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

Formats the value using the given formatter.

impl Not for PhysicalPageFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = PhysicalPageFlags

The resulting type after applying the ! operator.

impl Octal for PhysicalPageFlags

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

Formats the value using the given formatter.

impl Ord for PhysicalPageFlags

fn cmp(&self, other: &PhysicalPageFlags) -> 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<PhysicalPageFlags> for PhysicalPageFlags

fn eq(&self, other: &PhysicalPageFlags) -> 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<PhysicalPageFlags> for PhysicalPageFlags

fn partial_cmp(&self, other: &PhysicalPageFlags) -> 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 Serialize for PhysicalPageFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<PhysicalPageFlags> for PhysicalPageFlags

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

Returns the set difference of the two sets of flags.

type Output = PhysicalPageFlags

The resulting type after applying the - operator.

impl SubAssign<PhysicalPageFlags> for PhysicalPageFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for PhysicalPageFlags

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

Formats the value using the given formatter.

impl Copy for PhysicalPageFlags

impl Eq for PhysicalPageFlags

impl StructuralEq for PhysicalPageFlags

impl StructuralPartialEq for PhysicalPageFlags