Struct x86_64::addr::VirtAddr[][src]

#[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[src]

pub fn new(addr: u64) -> VirtAddr[src]

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>[src]

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[src]

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[src]

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[src]

Creates a virtual address that points to 0.

pub const fn as_u64(self) -> u64[src]

Converts the address to an u64.

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

Creates a virtual address from the given pointer

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

Converts the address to a raw pointer.

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

Converts the address to a mutable raw pointer.

pub const fn is_null(self) -> bool[src]

Convenience method for checking if a virtual address is null.

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

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>, 
[src]

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>, 
[src]

Checks whether the virtual address has the demanded alignment.

pub const fn page_offset(self) -> PageOffset[src]

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

pub const fn p1_index(self) -> PageTableIndex[src]

Returns the 9-bit level 1 page table index.

pub const fn p2_index(self) -> PageTableIndex[src]

Returns the 9-bit level 2 page table index.

pub const fn p3_index(self) -> PageTableIndex[src]

Returns the 9-bit level 3 page table index.

pub const fn p4_index(self) -> PageTableIndex[src]

Returns the 9-bit level 4 page table index.

Trait Implementations

impl Add<u64> for VirtAddr[src]

type Output = Self

The resulting type after applying the + operator.

impl Add<usize> for VirtAddr[src]

type Output = Self

The resulting type after applying the + operator.

impl AddAssign<u64> for VirtAddr[src]

impl AddAssign<usize> for VirtAddr[src]

impl Clone for VirtAddr[src]

impl Copy for VirtAddr[src]

impl Debug for VirtAddr[src]

impl Eq for VirtAddr[src]

impl Ord for VirtAddr[src]

impl PartialEq<VirtAddr> for VirtAddr[src]

impl PartialOrd<VirtAddr> for VirtAddr[src]

impl StructuralEq for VirtAddr[src]

impl StructuralPartialEq for VirtAddr[src]

impl Sub<VirtAddr> for VirtAddr[src]

type Output = u64

The resulting type after applying the - operator.

impl Sub<u64> for VirtAddr[src]

type Output = Self

The resulting type after applying the - operator.

impl Sub<usize> for VirtAddr[src]

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<u64> for VirtAddr[src]

impl SubAssign<usize> for VirtAddr[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.