tokio/runtime/scheduler/multi_thread/
mod.rs

1//! Multi-threaded runtime
2
3mod counters;
4use counters::Counters;
5
6mod handle;
7pub(crate) use handle::Handle;
8
9mod overflow;
10pub(crate) use overflow::Overflow;
11
12mod idle;
13use self::idle::Idle;
14
15mod stats;
16pub(crate) use stats::Stats;
17
18mod park;
19pub(crate) use park::{Parker, Unparker};
20
21pub(crate) mod queue;
22
23mod worker;
24pub(crate) use worker::{Context, Launch, Shared};
25
26cfg_taskdump! {
27    mod trace;
28    use trace::TraceStatus;
29
30    pub(crate) use worker::Synced;
31}
32
33cfg_not_taskdump! {
34    mod trace_mock;
35    use trace_mock::TraceStatus;
36}
37
38pub(crate) use worker::block_in_place;
39
40use crate::loom::sync::Arc;
41use crate::runtime::{
42    blocking,
43    driver::{self, Driver},
44    scheduler, Config, TimerFlavor,
45};
46use crate::util::RngSeedGenerator;
47
48use std::fmt;
49use std::future::Future;
50
51/// Work-stealing based thread pool for executing futures.
52pub(crate) struct MultiThread;
53
54// ===== impl MultiThread =====
55
56impl MultiThread {
57    pub(crate) fn new(
58        size: usize,
59        driver: Driver,
60        driver_handle: driver::Handle,
61        blocking_spawner: blocking::Spawner,
62        seed_generator: RngSeedGenerator,
63        config: Config,
64        timer_flavor: TimerFlavor,
65    ) -> (MultiThread, Arc<Handle>, Launch) {
66        let parker = Parker::new(driver);
67        let (handle, launch) = worker::create(
68            size,
69            parker,
70            driver_handle,
71            blocking_spawner,
72            seed_generator,
73            config,
74            timer_flavor,
75        );
76
77        (MultiThread, handle, launch)
78    }
79
80    /// Blocks the current thread waiting for the future to complete.
81    ///
82    /// The future will execute on the current thread, but all spawned tasks
83    /// will be executed on the thread pool.
84    pub(crate) fn block_on<F>(&self, handle: &scheduler::Handle, future: F) -> F::Output
85    where
86        F: Future,
87    {
88        crate::runtime::context::enter_runtime(handle, true, |blocking| {
89            blocking.block_on(future).expect("failed to park thread")
90        })
91    }
92
93    pub(crate) fn shutdown(&mut self, handle: &scheduler::Handle) {
94        match handle {
95            scheduler::Handle::MultiThread(handle) => handle.shutdown(),
96            _ => panic!("expected MultiThread scheduler"),
97        }
98    }
99}
100
101impl fmt::Debug for MultiThread {
102    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
103        fmt.debug_struct("MultiThread").finish()
104    }
105}