Struct zx::Vmar

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

An object representing a Zircon virtual memory address region.

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

Implementations

impl Vmar

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

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

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.

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.

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.

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.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_VMAR topic.

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

impl AsHandleRef for Vmar

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

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

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

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.

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

Waits on a handle. Wraps the zx_object_wait_one syscall.

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.

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

Get the Property::NAME property for this object.

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

Set the Property::NAME property for this object.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

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

impl Debug for Vmar

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

Formats the value using the given formatter.

impl From<Handle> for Vmar

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Vmar> for Handle

fn from(x: Vmar) -> Handle

Converts to this type from the input type.

impl HandleBased for Vmar

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

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

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.

fn into_handle(self) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

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

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

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

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

fn is_invalid_handle(&self) -> bool

impl Hash for Vmar

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 Ord for Vmar

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

Restrict a value to a certain interval.

impl PartialEq for Vmar

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

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

impl StructuralPartialEq for Vmar