Struct Process 

pub struct Process { /* private fields */ }

A process.

Implementations

impl Process

pub fn pid(&self) -> Pid

The Process ID.

pub fn is_init(self: &Arc<Self>) -> bool

Returns true if the Process is the init process.

This is a convenience method for checking if the Process Arc::ptr_eqs with the init process, which is cheaper than calling init_proc or testing if Process::parent is None.

pub fn is_child_subreaper(&self) -> bool

Returns true if this process acts as a child subreaper.

Linux keeps this flag per process: it is preserved across execve, applies to all threads in the thread group, and is not inherited by newly forked child processes.

pub fn set_child_subreaper(&self, enabled: bool)

Enables or disables child subreaper behavior for this process.

impl Process

Parent & children

pub fn parent(&self) -> Option<Arc<Process>>

The parent Process.

pub fn children(&self) -> Vec<Arc<Process>>

The child Processes.

impl Process

ProcessGroup & Session

pub fn group(&self) -> Arc<ProcessGroup>

The ProcessGroup that the Process belongs to.

pub fn create_session( self: &Arc<Self>, ) -> Option<(Arc<Session>, Arc<ProcessGroup>)>

Creates a new Session and new ProcessGroup and moves the Process to it.

If the Process is already a session leader, this method does nothing and returns None.

Otherwise, it returns the new Session and ProcessGroup.

The caller has to ensure that the new ProcessGroup does not conflict with any existing ProcessGroup. Thus, the Process must not be a ProcessGroup leader.

Checking Session conflicts is unnecessary.

pub fn create_group(self: &Arc<Self>) -> Option<Arc<ProcessGroup>>

Creates a new ProcessGroup and moves the Process to it.

If the Process is already a group leader, this method does nothing and returns None.

Otherwise, it returns the new ProcessGroup.

The caller has to ensure that the new ProcessGroup does not conflict with any existing ProcessGroup.

pub fn move_to_group(self: &Arc<Self>, group: &Arc<ProcessGroup>) -> bool

Moves the Process to a specified ProcessGroup.

Returns true if the move succeeded. The move failed if the ProcessGroup is not in the same Session as the Process.

If the Process is already in the specified ProcessGroup, this method does nothing and returns true.

impl Process

Threads

pub fn add_thread(self: &Arc<Self>, tid: Pid)

Adds a thread to this Process with the given thread ID.

pub fn exit_thread(self: &Arc<Self>, tid: Pid, exit_code: i32) -> bool

Removes a thread from this Process and sets the exit code if the group has not exited.

Returns true if this was the last thread in the process.

pub fn threads(&self) -> Vec<Pid>

Get all threads in this Process.

pub fn rename_thread(self: &Arc<Self>, old_tid: Pid, new_tid: Pid)

Renames a thread in the thread group.

Used by execve’s de_thread step when a non-leader thread successfully execves: the calling thread inherits the leader’s TID so that gettid() == getpid() holds in the new image. We swap old_tid for new_tid atomically inside the thread-group lock so there is no instant in which the caller is unrepresented in the group.

pub fn is_group_exited(&self) -> bool

Returns true if the Process is group exited.

pub fn group_exit(&self)

Marks the Process as group exited.

pub fn exit_code(&self) -> i32

The exit code of the Process.

impl Process

Status & exit

pub fn is_zombie(&self) -> bool

Returns true if the Process is a zombie process.

pub fn exit(self: &Arc<Self>)

Terminates the Process, marking it as a zombie process.

Child processes are inherited by the init process or by the nearest subreaper process.

This method does nothing if the Process is the init process.

pub fn free(&self)

Frees a zombie Process. Removes it from the parent.

This method panics if the Process is not a zombie.

impl Process

Builder

pub fn new_init(pid: Pid) -> Arc<Process>

Creates a init Process.

This function can be called multiple times, but [ProcessBuilder::build] on the the result must be called only once.

pub fn fork(self: &Arc<Process>, pid: Pid) -> Arc<Process>

Creates a child Process.

Trait Implementations

impl Debug for Process

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

Formats the value using the given formatter.