Struct zx::Vmar

source ·
pub struct Vmar(/* private fields */);
Expand description

An object representing a Zircon virtual memory address region.

As essentially a subtype of Handle, it can be freely interconverted.

Implementations§

source§

impl Vmar

source

pub fn allocate( &self, offset: usize, size: usize, flags: VmarFlags, ) -> Result<(Vmar, usize), Status>

source

pub fn map( &self, vmar_offset: usize, vmo: &Vmo, vmo_offset: u64, len: usize, flags: VmarFlags, ) -> Result<usize, Status>

source

pub unsafe fn map_unsafe( &self, vmar_offset: usize, vmo: &Vmo, vmo_offset: u64, len: usize, flags: VmarFlagsExtended, ) -> Result<usize, Status>

Directly call zx_vmar_map.

§Safety

This function is unsafe because certain flags to zx_vmar_map may replace an existing mapping which is referenced elsewhere.

source

pub unsafe fn unmap(&self, addr: usize, len: usize) -> Result<(), Status>

Directly call zx_vmar_unmap.

§Safety

This function is unsafe because unmapping memory regions can arbitrarily cause read, write, and execution errors. Among other things, the caller must ensure that:

  • The region being unmapped will not be accessed after unmapping.
  • All references to memory in the region must be dropped or forgotten prior to calling this method.
  • If the region contained executable code, then code in the region must not be currently executing and may not be executed in the future.

This is not an exhaustive list, as there are many ways to cause memory unsafety with memory mappings.

source

pub unsafe fn protect( &self, addr: usize, len: usize, flags: VmarFlags, ) -> Result<(), Status>

Directly call zx_vmar_protect.

§Safety

This function is unsafe because changing the access protections for memory regions can arbitrarily cause read, write, and execution errors. Among other things, the caller must ensure that if a read, write, or execute permission is removed from a memory region, it must not read, write, or execute it respetively.

This is not an exhaustive list, as there are many ways to cause memory unsafety with memory mappings.

source

pub unsafe fn destroy(&self) -> Result<(), Status>

Directly call zx_vmar_destroy.

§Safety

This function is unsafe because destroying a region unmaps all of the mappings within it. See Vmar::unmap for more details on how unmapping memory regions can cause memory unsafety.

source

pub fn info(&self) -> Result<VmarInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_VMAR topic.

source

pub fn info_maps_vec(&self) -> Result<Vec<MapInfo>, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_VMAR_MAPS topic.

Trait Implementations§

source§

impl AsHandleRef for Vmar

source§

fn as_handle_ref(&self) -> HandleRef<'_>

Get a reference to the handle. One important use of such a reference is for object_wait_many.
source§

fn raw_handle(&self) -> zx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).
source§

fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.
source§

fn wait_handle( &self, signals: Signals, deadline: MonotonicInstant, ) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.
source§

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object. Read more
source§

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object. Read more
source§

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.
source§

impl Debug for Vmar

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Handle> for Vmar

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Vmar> for Handle

source§

fn from(x: Vmar) -> Handle

Converts to this type from the input type.
source§

impl HandleBased for Vmar

source§

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.
source§

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation. Read more
source§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
source§

fn into_handle_based<H: HandleBased>(self) -> H

Creates an instance of another handle-based type from this value’s inner handle.
source§

fn from_handle_based<H: HandleBased>(h: H) -> Self

Creates an instance of this type from the inner handle of another handle-based type.
source§

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Vmar

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Vmar

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Vmar

source§

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

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

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.
source§

impl PartialOrd for Vmar

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Eq for Vmar

source§

impl StructuralPartialEq for Vmar

Auto Trait Implementations§

§

impl Freeze for Vmar

§

impl RefUnwindSafe for Vmar

§

impl Send for Vmar

§

impl Sync for Vmar

§

impl Unpin for Vmar

§

impl UnwindSafe for Vmar

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.