Struct x86_64::addr::VirtAddr

#[repr(transparent)]
pub struct VirtAddr(_);

A canonical 64-bit virtual memory address.

This is a wrapper type around an u64, so it is always 8 bytes, even when compiled on non 64-bit systems. The TryFrom trait can be used for performing conversions between u64 and usize.

On x86_64, only the 48 lower bits of a virtual address can be used. The top 16 bits need to be copies of bit 47, i.e. the most significant bit. Addresses that fulfil this criterium are called “canonical”. This type guarantees that it always represents a canonical address.

Implementations

impl VirtAddr

pub fn new(addr: u64) -> VirtAddr

Creates a new canonical virtual address.

This function performs sign extension of bit 47 to make the address canonical.

Panics

This function panics if the bits in the range 48 to 64 contain data (i.e. are not null and no sign extension).

pub fn try_new(addr: u64) -> Result<VirtAddr, VirtAddrNotValid>

Tries to create a new canonical virtual address.

This function tries to performs sign extension of bit 47 to make the address canonical. It succeeds if bits 48 to 64 are either a correct sign extension (i.e. copies of bit 47) or all null. Else, an error is returned.

pub const fn new_truncate(addr: u64) -> VirtAddr

Creates a new canonical virtual address, throwing out bits 48..64.

This function performs sign extension of bit 47 to make the address canonical, so bits 48 to 64 are overwritten. If you want to check that these bits contain no data, use new or try_new.

pub const unsafe fn new_unsafe(addr: u64) -> VirtAddr

Creates a new virtual address, without any checks.

Safety

You must make sure bits 48..64 are equal to bit 47. This is not checked.

pub const fn zero() -> VirtAddr

Creates a virtual address that points to 0.

pub const fn as_u64(self) -> u64

Converts the address to an u64.

pub fn from_ptr<T>(ptr: *const T) -> Self

Creates a virtual address from the given pointer

pub fn as_ptr<T>(self) -> *const T

Converts the address to a raw pointer.

pub fn as_mut_ptr<T>(self) -> *mut T

Converts the address to a mutable raw pointer.

pub const fn is_null(self) -> bool

Convenience method for checking if a virtual address is null.

pub fn align_up<U>(self, align: U) -> Self where
    U: Into<u64>, 

Aligns the virtual address upwards to the given alignment.

See the align_up function for more information.

pub fn align_down<U>(self, align: U) -> Self where
    U: Into<u64>, 

Aligns the virtual address downwards to the given alignment.

See the align_down function for more information.

pub fn is_aligned<U>(self, align: U) -> bool where
    U: Into<u64>, 

Checks whether the virtual address has the demanded alignment.

pub const fn page_offset(self) -> PageOffset

Returns the 12-bit page offset of this virtual address.

pub const fn p1_index(self) -> PageTableIndex

Returns the 9-bit level 1 page table index.

pub const fn p2_index(self) -> PageTableIndex

Returns the 9-bit level 2 page table index.

pub const fn p3_index(self) -> PageTableIndex

Returns the 9-bit level 3 page table index.

pub const fn p4_index(self) -> PageTableIndex

Returns the 9-bit level 4 page table index.

Trait Implementations

impl Add<u64> for VirtAddr

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Add<usize> for VirtAddr

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign<u64> for VirtAddr

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign<usize> for VirtAddr

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Binary for VirtAddr

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

Formats the value using the given formatter.

impl Clone for VirtAddr

fn clone(&self) -> VirtAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtAddr

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

Formats the value using the given formatter.

impl LowerHex for VirtAddr

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

Formats the value using the given formatter.

impl Octal for VirtAddr

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

Formats the value using the given formatter.

impl Ord for VirtAddr

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

Restrict a value to a certain interval.

impl PartialEq<VirtAddr> for VirtAddr

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

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

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

This method tests for !=.

impl PartialOrd<VirtAddr> for VirtAddr

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 Pointer for VirtAddr

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

Formats the value using the given formatter.

impl Sub<VirtAddr> for VirtAddr

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: VirtAddr) -> Self::Output

Performs the - operation.

impl Sub<u64> for VirtAddr

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl Sub<usize> for VirtAddr

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl SubAssign<u64> for VirtAddr

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign<usize> for VirtAddr

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl UpperHex for VirtAddr

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

Formats the value using the given formatter.

impl Copy for VirtAddr

impl Eq for VirtAddr

impl StructuralEq for VirtAddr

impl StructuralPartialEq for VirtAddr