#![forbid(unsafe_code)]
#![deny(missing_docs)]
#[cfg(panic = "abort")]
const _: () = {
compile_error!("vthread requires panic=unwind");
};
#[cfg(not(any(
all(target_os = "linux", target_arch = "x86_64"),
all(target_os = "macos", target_arch = "aarch64"),
)))]
const _: () = {
compile_error!("vthread supports Linux x86_64 and macOS ARM64");
};
pub mod blocking;
mod cancellation;
mod carrier;
pub mod channel;
mod completion;
mod config;
mod context;
mod control;
mod diagnostic_text;
pub mod diagnostics;
mod diagnostics_accessors;
mod dump;
pub mod error;
pub mod fs;
#[cfg(feature = "handoff-profiling")]
mod handoff_channel;
#[cfg(feature = "handoff-profiling")]
mod handoff_mutex;
#[cfg(feature = "handoff-profiling")]
mod handoff_profile;
#[cfg(feature = "handoff-profiling")]
mod handoff_span;
mod id_map;
mod identity;
mod inbox;
mod join;
mod join_slot;
mod join_wait;
mod kernel;
mod kernel_tasks;
pub mod lifecycle;
mod lifecycle_owner;
#[cfg(feature = "lifecycle-profiling")]
mod lifecycle_probe;
mod lifecycle_resources;
mod local_carrier;
mod local_join;
mod local_scope;
mod metrics_accessors;
pub mod net;
mod options;
pub mod parking;
mod readiness;
mod ready_queue;
mod runner;
mod runtime;
#[cfg(feature = "scheduler-profiling")]
mod scheduler_probe;
mod scope;
mod scope_failure;
mod scope_failure_report;
mod services;
mod signal;
mod spawner;
mod stall_policy;
mod supervisor;
pub mod sync;
mod task;
mod task_accessors;
mod task_body;
mod task_context;
mod task_fiber;
mod task_progress;
mod task_progress_state;
mod task_slab;
mod thread_failure;
mod time;
mod timer;
mod wait;
mod wait_hub;
mod wake_queue;
mod worker_context;
pub use cancellation::CancellationToken;
pub use config::{RuntimeBuilder, RuntimeConfig};
pub use context::{cancellation_token, checkpoint, deadline};
pub(crate) use diagnostics::{
CarrierSnapshot, CarrierStatus, RuntimeSnapshot, RuntimeStats, ShutdownPhase, StackSnapshot,
StallSnapshot,
};
pub(crate) use error::PanicReport;
pub use error::{Error, Result};
pub use join::JoinHandle;
pub use local_join::LocalJoinHandle;
pub use local_scope::{
LocalScope, local_scope, local_scope_with_deadline, try_local_scope,
try_local_scope_with_deadline,
};
pub use options::{ScopeOptions, SpawnOptions};
pub(crate) use parking::{ParkOutcome, Parker, park_pair};
#[cfg(test)]
use parking::{UnparkResult, Unparker};
pub use runtime::Runtime;
#[cfg(test)]
use runtime::ShutdownOutcome;
pub use scope::Scope;
pub(crate) use scope_failure::ScopeFailure;
pub(crate) use services::ServiceSnapshot;
pub use spawner::Spawner;
pub use stall_policy::StallPolicy;
pub(crate) use supervisor::ShutdownReport;
#[cfg(test)]
use supervisor::SupervisorShutdownOutcome;
pub(crate) use task::{
CarrierId, SuspensionReason, TaskFailure, TaskId, TaskSnapshot, TaskStatus, WakeReason,
};
pub use task_context::TaskLocal;
pub(crate) use thread_failure::{FailurePhase, ThreadComponent, ThreadFailure, ThreadFailures};
pub use time::{sleep, sleep_until};
pub fn yield_now() -> Result<()> {
match vthread_stack::suspend(vthread_stack::Suspension::YieldNow).map_err(Error::from)? {
vthread_stack::Resume::Continue => Ok(()),
vthread_stack::Resume::Interrupt => checkpoint(),
}
}
pub fn run<R>(body: impl FnOnce(&Scope<'_>) -> Result<R>) -> Result<R> {
if context::current().is_some() {
return Err(Error::InsideVThread);
}
runner::run(Runtime::new()?, body)
}
pub fn try_run<R, E>(
body: impl FnOnce(&Scope<'_>) -> std::result::Result<R, E>,
) -> std::result::Result<R, error::ApplicationRunFailure<E>> {
if context::current().is_some() {
return Err(error::ApplicationRunFailure::runtime(Error::InsideVThread));
}
let runtime = Runtime::new().map_err(error::ApplicationRunFailure::runtime)?;
runner::try_run(runtime, body)
}
#[cfg(test)]
#[path = "lib_test.rs"]
mod lib_test;
#[cfg(test)]
#[path = "support_test.rs"]
mod support_test;
#[cfg(test)]
#[path = "multicarrier_test.rs"]
mod multicarrier_test;
#[cfg(test)]
#[path = "shutdown_test.rs"]
mod shutdown_test;
#[cfg(test)]
#[path = "child_control_test.rs"]
mod child_control_test;
#[cfg(test)]
#[path = "panic_suspension_test.rs"]
mod panic_suspension_test;
#[cfg(test)]
#[path = "panic_parking_test.rs"]
mod panic_parking_test;