Struct Process

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

An object representing a Zircon process.

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

Implementations

impl Process

pub fn get_debug_addr(&self) -> Result<u64, Status>

impl Process

pub fn set_debug_addr(&self, val: &u64) -> Result<(), Status>

impl Process

pub fn get_break_on_load(&self) -> Result<u64, Status>

impl Process

pub fn set_break_on_load(&self, val: &u64) -> Result<(), Status>

impl Process

pub fn create( job: &Job, name: Name, options: ProcessOptions, ) -> Result<(Process, Vmar), Status>

Create a new process and its address space.

Wraps the zx_process_create syscall.

pub fn start( &self, thread: &Thread, entry: usize, stack: usize, arg1: Handle, arg2: usize, ) -> Result<(), Status>

Similar to Thread::start, but is used to start the first thread in a process.

Wraps the zx_process_start syscall.

pub fn create_thread(&self, name: &[u8]) -> Result<Thread, Status>

Create a thread inside a process.

Wraps the zx_thread_create syscall.

pub fn write_memory(&self, vaddr: usize, bytes: &[u8]) -> Result<usize, Status>

Write memory inside a process.

Wraps the zx_process_write_memory syscall.

pub fn read_memory( &self, vaddr: usize, bytes: &mut [u8], ) -> Result<usize, Status>

Read memory from inside a process.

Wraps the zx_process_read_memory syscall.

pub fn read_memory_uninit<'a>( &self, vaddr: usize, buffer: &'a mut [MaybeUninit<u8>], ) -> Result<(&'a mut [u8], &'a mut [MaybeUninit<u8>]), Status>

Read memory from inside a process without requiring the output buffer to be initialized.

Wraps the zx_process_read_memory syscall.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS topic.

pub fn threads(&self) -> Result<Vec<Koid>, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS_THREADS topic.

pub fn task_stats(&self) -> Result<TaskStatsInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_TASK_STATS topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS_MAPS topic.

pub fn exit(retcode: i64) -> !

Exit the current process with the given return code.

Wraps the zx_process_exit syscall.

pub fn handle_stats(&self) -> Result<ProcessHandleStats, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS_HANDLE_STATS topic.

pub fn get_child(&self, koid: &Koid, rights: Rights) -> Result<Thread, Status>

Wraps the zx_object_get_child syscall.

pub fn info_vmos_vec(&self) -> Result<Vec<VmoInfo>, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS_VMO topic.

pub fn info_maps<'a>( &self, info_out: &'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_PROCESS_MAPS topic. Contrarily to Process::info_vmos_vec, this method ensures that no intermediate copy of the data is made, at the price of a less convenient interface.

pub fn info_vmos<'a>( &self, info_out: &'a mut [MaybeUninit<VmoInfo>], ) -> Result<(&'a mut [VmoInfo], &'a mut [MaybeUninit<VmoInfo>], usize), Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_PROCESS_VMO topic. Contrarily to Process::info_vmos_vec, this method ensures that no intermediate copy of the data is made, at the price of a less convenient interface.

Trait Implementations

impl AsHandleRef for Process

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.

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 Process

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

Formats the value using the given formatter.

impl From<Handle> for Process

fn from(handle: Handle) -> Process

Converts to this type from the input type.

impl From<Process> for Handle

fn from(x: Process) -> Handle

Converts to this type from the input type.

impl FromWire<WireHandle> for Process

fn from_wire(wire: WireHandle) -> Process

Converts the given wire to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl FromWireOption<WireOptionalHandle> for Process

fn from_wire_option(wire: WireOptionalHandle) -> Option<Process>

Converts the given wire to an option of this type.

impl HandleBased for Process

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

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>(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 Process

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

where __H: Hasher,

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 Process

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

Restrict a value to a certain interval.

impl PartialEq for Process

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

Tests for self and other values to be equal, and is used by ==.

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 Process

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Task for Process

fn kill(&self) -> Result<(), Status>

Kill the given task (job, process, or thread).

fn suspend(&self) -> Result<Handle, Status>

Suspend the given task

fn create_exception_channel_with_opts( &self, opts: ExceptionChannelOptions, ) -> Result<Channel, Status>

Create an exception channel (with options) for the task.

fn create_exception_channel(&self) -> Result<Channel, Status>

Create an exception channel for the task.

fn get_runtime_info(&self) -> Result<TaskRuntimeInfo, Status>

Returns the runtime information for the task.

impl Eq for Process

impl StructuralPartialEq for Process