Struct axtask::TaskInner

pub struct TaskInner {
    pub page_table_token: UnsafeCell<usize>,
    pub cpu_set: AtomicU64,
    pub send_sigchld_when_exit: bool,
    pub sched_status: UnsafeCell<SchedStatus>,
    pub is_vforked_child: AtomicBool,
    /* private fields */
}

Available on crate feature multitask only.

The inner task structure used as the minimal unit of scheduling.

Fields

page_table_token: UnsafeCell<usize>

Available on crate feature monolithic only.

the page table token of the process which the task belongs to

cpu_set: AtomicU64

Available on crate feature monolithic only.

TODO: to support the sched_setaffinity

TODO: move to the upper layer

send_sigchld_when_exit: bool

Available on crate feature monolithic only.

退出时是否向父进程发送SIG_CHILD

sched_status: UnsafeCell<SchedStatus>

Available on crate feature monolithic only.

The scheduler status of the task, which defines the scheduling policy and priority

is_vforked_child: AtomicBool

Available on crate feature monolithic only.

Whether the task is a thread which is vforked by another task

Implementations

impl TaskInner

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)

Sets the name of the task.

pub fn id_name(&self) -> String

Get a combined string of the task ID and name.

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

获取内核栈栈顶

pub fn new<F>( entry: F, name: String, stack_size: usize, process_id: u64, page_table_token: usize, sig_child: bool, tls_area: (usize, usize) ) -> TaskInner

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

Available on crate feature monolithic only.

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

pub fn init_task_ctx( &mut self, entry: usize, kstack_top: VirtAddr, tls: VirtAddr )

To init the task context

Arguments

• entry - the entry point of the task

• kstack_top - the top of the kernel stack

• tls - the address of the thread local storage

impl TaskInner

Methods for time statistics

pub fn time_stat_from_user_to_kernel(&self, current_tick: usize)

update the time information when the task is switched from user mode to kernel mode

pub fn time_stat_from_kernel_to_user(&self, current_tick: usize)

update the time information when the task is switched from kernel mode to user mode

pub fn time_stat_when_switch_from(&self, current_tick: usize)

update the time information when the task is switched out

pub fn time_stat_when_switch_to(&self, current_tick: usize)

update the time information when the task is ready to be switched in

pub fn time_stat_output(&self) -> (usize, usize)

output the time statistics

The format is (user time, kernel time) in nanoseconds

pub fn timer_output(&self) -> (usize, usize)

输出计时器信息 (计时器周期，当前计时器剩余时间) 单位为us

pub fn set_timer( &self, timer_interval_ns: usize, timer_remained_ns: usize, timer_type: usize ) -> bool

设置计时器信息

若type不为None则返回成功

pub fn time_stat_reset(&self, current_tick: usize)

重置统计时间

impl TaskInner

pub fn set_child_tid(&self, tid: usize)

Available on crate feature monolithic only.

store the child thread ID at the location pointed to by child_tid in clone args

pub fn set_clear_child_tid(&self, tid: usize)

Available on crate feature monolithic only.

clear (zero) the child thread ID at the location pointed to by child_tid in clone args

pub fn get_clear_child_tid(&self) -> usize

Available on crate feature monolithic only.

get the pointer to the child thread ID

pub fn get_page_table_token(&self) -> usize

Available on crate feature monolithic only.

get the page table token of the process which the task belongs to

pub fn set_page_table_token(&self, token: usize)

Available on crate feature monolithic only.

force to set the page table token of the process UNSAFELY

pub fn get_process_id(&self) -> u64

Available on crate feature monolithic only.

get the process ID of the task

pub fn set_process_id(&self, process_id: u64)

Available on crate feature monolithic only.

set the process ID of the task

pub fn set_leader(&self, is_lead: bool)

Available on crate feature monolithic only.

set the flag whether the task is the main thread of the process

pub fn is_leader(&self) -> bool

Available on crate feature monolithic only.

whether the task is the main thread of the process

pub fn set_cpu_set(&self, mask: usize, set_size: usize, max_cpu_num: usize)

Available on crate feature monolithic only.

设置CPU set，其中set_size为bytes长度

pub fn get_cpu_set(&self) -> usize

Available on crate feature monolithic only.

to get the CPU set

pub fn set_sched_status(&self, status: SchedStatus)

Available on crate feature monolithic only.

set the scheduling policy and priority

pub fn get_sched_status(&self) -> SchedStatus

Available on crate feature monolithic only.

get the scheduling policy and priority

pub fn get_ctx(&self) -> &TaskContext

Available on crate feature monolithic only.

get the task context for task switch

pub fn get_sig_child(&self) -> bool

Available on crate feature monolithic only.

whether to send SIG_CHILD when the task exits

pub fn set_sig_child(&mut self, sig_child: bool)

Available on crate feature monolithic only.

set whether to send SIG_CHILD when the task exits

pub unsafe fn set_tls_force(&self, value: usize)

Available on crate feature monolithic and x86-64 only.

Safety

It is unsafe because it may cause undefined behavior if the fs_base is not a valid address.

pub fn set_vfork_child(&self, is_vfork_child: bool)

Available on crate feature monolithic only.

To set whether the task will be blocked by a vfork child

pub fn is_vfork_child(&self) -> bool

Available on crate feature monolithic only.

获取父进程blocked_by_vfork布尔值

impl TaskInner

pub fn new_init(name: String, tls_area: (usize, usize)) -> TaskInner

Creates an “init task” using the current CPU states, to use as the current task.

As it is the current task, no other task can switch to it until it switches out.

And there is no need to set the entry, kstack or tls fields, as they will be filled automatically when the task is switches out.

pub fn state(&self) -> TaskState

the state of the task

pub fn set_state(&self, state: TaskState)

set the state of the task

pub fn is_running(&self) -> bool

Whether the task is running

pub fn is_ready(&self) -> bool

Whether the task is ready to be scheduled

pub fn is_blocked(&self) -> bool

Whether the task is blocked

pub const fn is_init(&self) -> bool

Whether the task has been inited

pub const fn is_idle(&self) -> bool

Whether the task is the idle task

pub fn set_preempt_pending(&self, pending: bool)

Available on crate feature preempt only.

Set the task waiting for reschedule

pub fn get_preempt_pending(&self) -> bool

Available on crate feature preempt only.

Get whether the task is waiting for reschedule

pub fn can_preempt(&self, current_disable_count: usize) -> bool

Available on crate feature preempt only.

Whether the task can be preempted

pub fn disable_preempt(&self)

Available on crate feature preempt only.

Disable the preemption

pub fn enable_preempt(&self)

Available on crate feature preempt only.

Enable the preemption by increasing the disable count

Only when the count is zero, the task can be preempted

pub fn preempt_num(&self) -> usize

Available on crate feature preempt only.

Get the number of preempt disable counter

pub const unsafe fn ctx_mut_ptr(&self) -> *mut TaskContext

Get the task context pointer

Safety

The task context pointer is mutable, but it will be accessed by only one task at a time

pub fn get_exit_code(&self) -> i32

Get the exit code

pub fn set_exit_code(&self, code: i32)

Set the task exit code

pub fn get_entry(&self) -> Option<*mut dyn FnOnce()>

Get the task entry

pub fn get_tls_ptr(&self) -> usize

Available on crate feature tls only.

Get the task tls pointer

pub fn reset_time_stat(&self, current_timestamp: usize)

Reset the task time statistics

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

Check whether the timer triggered

If the timer has triggered, then reset it and return the signal number

Trait Implementations

impl Debug for TaskInner

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

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