Struct TaskInner

pub struct TaskInner { /* private fields */ }

Available on crate feature multitask only.

The inner task structure.

Implementations

impl TaskInner

pub fn new<F>(entry: F, name: String, stack_size: usize) -> Self

where F: FnOnce() + Send + 'static,

Create a new task with the given entry function and stack size.

pub const fn id(&self) -> TaskId

Gets the ID of the task.

pub fn name(&self) -> &str

Gets the name of the task.

pub fn set_name(&self, name: &str)

Set the name of the task.

pub fn id_name(&self) -> String

Get a combined string of the task ID and name.

pub fn join(&self) -> Option<i32>

Wait for the task to exit, and return the exit code.

It will return immediately if the task has already exited (but not dropped).

pub unsafe fn task_ext_ptr(&self) -> *mut u8

Returns the pointer to the user-defined task extended data.

Safety

The caller should not access the pointer directly, use TaskExtRef::task_ext or TaskExtMut::task_ext_mut instead.

pub fn init_task_ext<T: Sized>(&mut self, data: T) -> Option<&T>

Initialize the user-defined task extended data.

Returns a reference to the task extended data if it has not been initialized yet (empty), otherwise returns None.

pub const fn ctx_mut(&mut self) -> &mut TaskContext

Returns a mutable reference to the task context.

pub const fn kernel_stack_top(&self) -> Option<VirtAddr>

Returns the top address of the kernel stack.

pub fn cpumask(&self) -> AxCpuMask

Gets the cpu affinity mask of the task.

Returns the cpu affinity mask of the task in type AxCpuMask.

pub fn set_cpumask(&self, cpumask: AxCpuMask)

Sets the cpu affinity mask of the task.

Arguments

cpumask - The cpu affinity mask to be set in type AxCpuMask.

pub fn get_kernel_stack_top(&self) -> Option<usize>

Read the top address of the kernel stack for the task.

pub fn exit_code(&self) -> i32

Returns the exit code of the task.

impl TaskInner

pub fn state(&self) -> TaskState

Returns the task’s current state.

pub fn set_state(&self, state: TaskState)

Set the task’s state.

Trait Implementations

impl Debug for TaskInner

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

Formats the value using the given formatter.

impl Drop for TaskInner

fn drop(&mut self)

Executes the destructor for this type.

impl Send for TaskInner

impl Sync for TaskInner