Enum MemoryObject 

pub enum MemoryObject {
    Vmo(VmoAndBasicInfo),
    RingBuf(VmoAndBasicInfo),
    MemoryMappedClock {
        koid: Koid,
        utc_clock: UtcClock,
    },
}

Variants

Vmo(VmoAndBasicInfo)

RingBuf(VmoAndBasicInfo)

The memory object is a bpf ring buffer. The layout it represents is: |Page1 - Page2 - Page3 .. PageN - Page3 .. PageN| where the vmo is |Page1 - Page2 - Page3 .. PageN|

MemoryMappedClock

A memory mapped clock is backed by kernel memory, not by a VMO. So it is handled specially. The lifecycle of this clock is:

• starts off as an empty unmapped thing.
• a MappedClock is created on map_in_vmar.
• a name is added on set_zx_name.
• most clone/resize operations return errors.
• unmapped at the end of the process lifetime.

Fields

koid: Koid

utc_clock: UtcClock

Implementations

impl MemoryObject

pub fn as_vmo(&self) -> Option<&Vmo>

pub fn is_clock(&self) -> bool

Returns true if this MemoryObject is a memory mapped clock.

pub fn into_vmo(self) -> Option<Vmo>

pub fn get_content_size(&self) -> u64

pub fn set_content_size(&self, size: u64) -> Result<(), Status>

pub fn get_size(&self) -> u64

pub fn set_size(&self, size: u64) -> Result<(), Status>

pub fn create_child( &self, option: VmoChildOptions, offset: u64, size: u64, ) -> Result<Self, Status>

pub fn create_private_child(&self) -> Result<Self, Status>

Creates a writable SNAPSHOT_AT_LEAST_ON_WRITE child spanning all of this memory, for use as the backing of a private mapping.

Zircon removes Rights::EXECUTE from snapshot children created without NO_WRITE (see zx_vmo_create_child). If this memory has Rights::EXECUTE, the right is restored on the child so that the private mapping can still be made executable.

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

pub fn read(&self, data: &mut [u8], offset: u64) -> Result<(), Status>

pub fn read_to_array<T: Copy + FromBytes, const N: usize>( &self, offset: u64, ) -> Result<[T; N], Status>

pub fn read_to_vec(&self, offset: u64, length: u64) -> Result<Vec<u8>, Status>

pub fn read_uninit<'a>( &self, data: &'a mut [MaybeUninit<u8>], offset: u64, ) -> Result<&'a mut [u8], Status>

pub unsafe fn read_raw( &self, buffer: *mut u8, buffer_length: usize, offset: u64, ) -> Result<(), Status>

Reads from the memory.

Safety

Callers must guarantee that the buffer is valid to write to.

Errors

Returns zx::Status::NOT_SUPPORTED where unsupported.

pub fn write(&self, data: &[u8], offset: u64) -> Result<(), Status>

Write to memory.

Errors

Returns zx::Status::NOT_SUPPORTED for read-only memory.

pub fn get_koid(&self) -> Koid

Returns the koid of the underlying memory-like object.

Should be cheap to call frequently.

pub fn get_rights(&self) -> Rights

Returns the rights of the underlying memory-like object.

pub fn info(&self) -> Result<VmoInfo, Errno>

Returns zx::VmoInfo for a memory object that supports it.

Panics

Calling info on a MemoryObject that is not represented by a VMO will panic. To avoid this in code, call is_clock before attempting.

pub fn set_zx_name(&self, name: &[u8])

pub fn with_zx_name(self, name: &[u8]) -> Self

pub fn op_range(&self, op: VmoOp, offset: u64, size: u64) -> Result<(), Status>

pub fn replace_as_executable(self, vmex: &Resource) -> Result<Self, Status>

pub fn map_in_vmar( &self, vmar: &Vmar, vmar_offset: usize, memory_offset: u64, len: usize, flags: VmarFlags, ) -> Result<usize, Status>

pub fn memmove( &self, options: TransferDataOptions, dst_offset: u64, src_offset: u64, size: u64, ) -> Result<(), Status>

pub fn clone_memory( self: &Arc<Self>, rights: Rights, options: MappingOptions, ) -> Result<Arc<Self>, Errno>

Trait Implementations

impl Debug for MemoryObject

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

Formats the value using the given formatter.

impl Eq for MemoryObject

impl From<Arc<Vmo>> for MemoryObject

fn from(vmo: Arc<Vmo>) -> Self

Converts to this type from the input type.

impl From<Clock<BootTimeline, UtcTimeline>> for MemoryObject

fn from(utc_clock: UtcClock) -> MemoryObject

Converts to this type from the input type.

impl From<Vmo> for MemoryObject

fn from(vmo: Vmo) -> Self

Converts to this type from the input type.

impl PartialEq for MemoryObject

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

Equality operator ==.

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

Inequality operator !=.

impl RcuDroppable for MemoryObject

where VmoAndBasicInfo: RcuDroppable, Koid: RcuDroppable, UtcClock: RcuDroppable,