Struct VirtAddr

pub struct VirtAddr(/* private fields */);

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 criterion are called “canonical”. This type guarantees that it always represents a canonical address.

Implementations

impl VirtAddr

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

Creates a new address, without any checks.

Safety

If addr does not comply with the platforms requirements for this address type, this can lead to UB in functions relying on the compliance or when using the requirements.

pub const fn is_null(self) -> bool

Convenience method for checking if an address is null.

pub const fn zero() -> VirtAddr

Creates an address that points to 0.

pub const fn as_u64(self) -> u64

Converts the address to an u64.

impl VirtAddr

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

Creates a new canonical virtual address.

The provided address should already be canonical. If you want to check whether an address is canonical, use try_new.

Panics

This function panics if the bits in the range 48 to 64 are invalid (i.e. are not a proper sign extension of bit 47).

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

Tries to create a new canonical virtual address.

This function checks wether the given address is canonical and returns an error otherwise. An address is canonical if bits 48 to 64 are a correct sign extension (i.e. copies of bit 47).

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, overwriting bits 48 to 64. If you want to check whether an address is canonical, use new or try_new.

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

where T: ?Sized,

Creates a virtual address from the given pointer

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

Converts the address to a raw pointer.

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

Converts the address to a mutable raw pointer.

pub const fn as_usize(&self) -> usize

pub fn is_aligned(self, align: u64) -> bool

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.

pub const fn page_table_index(self, level: PageTableLevel) -> PageTableIndex

Returns the 9-bit level page table index.

Trait Implementations

impl Add<u64> for VirtAddr

type Output = VirtAddr

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <VirtAddr as Add<u64>>::Output

Performs the + operation.

impl Add<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> <VirtAddr as Add<usize>>::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 Align<u64> for VirtAddr

fn align_down(self, align: u64) -> VirtAddr

Align address downwards.

fn align_up(self, align: u64) -> VirtAddr

Align address upwards.

fn is_aligned_to(self, align: A) -> bool

Checks whether the address has the demanded alignment.

impl Binary for VirtAddr

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

Formats the value using the given formatter.

impl BitAnd<u64> for VirtAddr

type Output = u64

The resulting type after applying the & operator.

fn bitand(self, rhs: u64) -> <VirtAddr as BitAnd<u64>>::Output

Performs the & operation.

impl BitAndAssign<u64> for VirtAddr

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitOr<u64> for VirtAddr

type Output = u64

The resulting type after applying the | operator.

fn bitor(self, rhs: u64) -> <VirtAddr as BitOr<u64>>::Output

Performs the | operation.

impl BitOrAssign<u64> for VirtAddr

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitXor<u64> for VirtAddr

type Output = u64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u64) -> <VirtAddr as BitXor<u64>>::Output

Performs the ^ operation.

impl BitXorAssign<u64> for VirtAddr

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

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

Formats the value using the given formatter.

impl From<&VirtAddr> for VirtAddr

fn from(addr: &VirtAddr) -> VirtAddr

Converts to this type from the input type.

impl From<VirtAddr> for VirtAddr

fn from(addr: VirtAddr) -> VirtAddr

Converts to this type from the input type.

impl From<u64> for VirtAddr

fn from(addr: u64) -> VirtAddr

Converts to this type from the input type.

impl From<usize> for VirtAddr

fn from(addr: usize) -> VirtAddr

Converts to this type from the input type.

impl Hash for VirtAddr

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 VirtAddr

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

Formats the value using the given formatter.

impl MemoryAddress for VirtAddr

type RAW = u64

Inner address type

fn raw(self) -> <VirtAddr as MemoryAddress>::RAW

Get the raw underlying address value.

impl Octal for VirtAddr

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

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.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VirtAddr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for VirtAddr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

Formats the value using the given formatter.

impl Shl<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> <VirtAddr as Shl<usize>>::Output

Performs the << operation.

impl ShlAssign<usize> for VirtAddr

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> <VirtAddr as Shr<usize>>::Output

Performs the >> operation.

impl ShrAssign<usize> for VirtAddr

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u64> for VirtAddr

type Output = VirtAddr

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <VirtAddr as Sub<u64>>::Output

Performs the - operation.

impl Sub<usize> for VirtAddr

type Output = VirtAddr

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> <VirtAddr as Sub<usize>>::Output

Performs the - operation.

impl Sub for VirtAddr

type Output = u64

The resulting type after applying the - operator.

fn sub(self, rhs: VirtAddr) -> <VirtAddr as Sub>::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<(), Error>

Formats the value using the given formatter.

impl Copy for VirtAddr

impl Eq for VirtAddr

impl StructuralPartialEq for VirtAddr