Vmar

Struct Vmar 

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§

§

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 fn op_range( &self, op: VmarOp, addr: usize, len: usize, ) -> Result<(), Status>

Perform an operation on VMOs mapped into this VMAR.

Wraps the zx_vmar_op_range syscall.

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<'a>( &self, buf: &'a mut [MaybeUninit<MapInfo>], ) -> Result<(&'a mut [MapInfo], &'a mut [MaybeUninit<MapInfo>], usize), Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_VMAR_MAPS topic.

Returns an initialized slice of MapInfos, any uninitialized trailing entries, and the total number of infos that the kernel had available.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_VMAR_MAPS topic.

pub fn map_iob( &self, options: VmarFlags, vmar_offset: usize, iob: &Iob, region_index: u32, region_offset: u64, region_len: usize, ) -> Result<usize, Status>

Wraps the zx_vmar_map_iob syscall.

pub fn map_clock<I, O>( &self, options: VmarFlags, vmar_offset: usize, clock: &Clock<I, O>, length: usize, ) -> Result<usize, Status>
where I: Timeline, O: Timeline,

Wraps the zx_vmar_map_clock syscall.

Trait Implementations§

§

impl AsHandleRef for Vmar

§

fn as_handle_ref(&self) -> Unowned<'_, Handle>

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

fn raw_handle(&self) -> u32

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: Instant<MonotonicTimeline>, ) -> WaitResult

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. Read more
§

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

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

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

impl CompatFrom<Vmar> for Vmar

Source§

fn compat_from(value: Vmar) -> Vmar

Converts value into a value of this type.
§

impl Debug for Vmar

§

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

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

impl Encodable for Vmar

Source§

type Encoded = WireVmar

The wire type for the value.
Source§

const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _

Whether the conversion from Self to Self::Encoded is equivalent to copying the raw bytes of Self. Read more
Source§

impl EncodableOption for Vmar

Source§

type EncodedOption = WireOptionalVmar

The wire type for the optional value.
Source§

impl<E> Encode<E> for Vmar
where E: HandleEncoder + ?Sized,

Source§

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<<Vmar as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.
Source§

impl<E> EncodeOption<E> for Vmar
where E: HandleEncoder + ?Sized,

Source§

fn encode_option( this: Option<Vmar>, encoder: &mut E, out: &mut MaybeUninit<<Vmar as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.
§

impl From<Handle> for Vmar

§

fn from(handle: Handle) -> Vmar

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

impl FromWire<WireVmar> for Vmar

Source§

fn from_wire(wire: WireVmar) -> Vmar

Converts the given wire to this type.
Source§

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W. Read more
Source§

impl FromWireOption<WireOptionalVmar> for Vmar

Source§

fn from_wire_option(wire: WireOptionalVmar) -> Option<Vmar>

Converts the given wire to an option of this 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. Read more
§

fn into_raw(self) -> u32

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

fn from_handle(handle: Handle) -> Self

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

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

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

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

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>(&self, state: &mut __H)
where __H: Hasher,

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
§

impl Ord for Vmar

§

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,

Restrict a value to a certain interval. Read more
§

impl PartialEq for Vmar

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Vmar

§

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

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

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

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

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

impl Eq for Vmar

§

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
§

impl<T> EncodableAsHandle for T
where T: HandleBased,

§

type Dialect = DefaultFuchsiaResourceDialect

What resource dialect can encode this object as a handle.
§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> FromWireOption<WireBox<'_, W>> for T
where T: FromWire<W>,

Source§

fn from_wire_option(wire: WireBox<'_, W>) -> Option<T>

Converts the given wire to an option of this type.
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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>,

Source§

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

impl<E> RunsTransport<Mpsc> for E

Source§

impl<E> RunsTransport<Mpsc> for E
where E: RunsTransport<Mpsc>,