1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
//! [ArceOS](https://github.com/rcore-os/arceos) task management module.
//!
//! This module provides primitives for task management, including task
//! creation, scheduling, sleeping, termination, etc. The scheduler algorithm
//! is configurable by cargo features.
//!
//! # Cargo Features
//!
//! - `multitask`: Enable multi-task support. If it's enabled, complex task
//! management and scheduling is used, as well as more task-related APIs.
//! Otherwise, only a few APIs with naive implementation is available.
//! - `irq`: Interrupts are enabled. If this feature is enabled, timer-based
//! APIs can be used, such as [`sleep`], [`sleep_until`], and
//! [`WaitQueue::wait_timeout`].
//! - `preempt`: Enable preemptive scheduling.
//! - `sched_fifo`: Use the [FIFO cooperative scheduler][1]. It also enables the
//! `multitask` feature if it is enabled. This feature is enabled by default,
//! and it can be overriden by other scheduler features.
//! - `sched_rr`: Use the [Round-robin preemptive scheduler][2]. It also enables
//! the `multitask` and `preempt` features if it is enabled.
//! - `sched_cfs`: Use the [Completely Fair Scheduler][3]. It also enables the
//! the `multitask` and `preempt` features if it is enabled.
//!
//! [1]: scheduler::FifoScheduler
//! [2]: scheduler::RRScheduler
//! [3]: scheduler::CFScheduler
#![cfg_attr(not(test), no_std)]
#![feature(doc_cfg)]
#![feature(doc_auto_cfg)]
#![feature(stmt_expr_attributes)]
cfg_if::cfg_if! {
if #[cfg(feature = "multitask")] {
#[macro_use]
extern crate log;
extern crate alloc;
mod run_queue;
pub use run_queue::{IDLE_TASK, RUN_QUEUE, EXITED_TASKS};
mod task;
mod schedule;
mod api;
mod wait_queue;
pub use taskctx::{SchedPolicy, SchedStatus,TaskState};
#[cfg(feature = "irq")]
mod timers;
#[doc(cfg(feature = "multitask"))]
pub use self::api::*;
pub use self::api::{sleep, sleep_until, yield_now};
} else {
mod api_s;
pub use self::api_s::{sleep, sleep_until, yield_now};
}
}