Coverage Report

Created: 2026-07-16 07:11

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/rust/registry/src/index.crates.io-1949cf8c6b5b557f/tokio-1.52.3/src/runtime/handle.rs
Line
Count
Source
1
use crate::runtime;
2
use crate::runtime::{context, scheduler, RuntimeFlavor, RuntimeMetrics};
3
4
/// Handle to the runtime.
5
///
6
/// The handle is internally reference-counted and can be freely cloned. A handle can be
7
/// obtained using the [`Runtime::handle`] method.
8
///
9
/// [`Runtime::handle`]: crate::runtime::Runtime::handle()
10
#[derive(Debug, Clone)]
11
// When the `rt` feature is *not* enabled, this type is still defined, but not
12
// included in the public API.
13
pub struct Handle {
14
    pub(crate) inner: scheduler::Handle,
15
}
16
17
use crate::runtime::task::JoinHandle;
18
use crate::runtime::BOX_FUTURE_THRESHOLD;
19
use crate::util::error::{CONTEXT_MISSING_ERROR, THREAD_LOCAL_DESTROYED_ERROR};
20
use crate::util::trace::SpawnMeta;
21
22
use std::future::Future;
23
use std::marker::PhantomData;
24
use std::{error, fmt, mem};
25
26
/// Runtime context guard.
27
///
28
/// Returned by [`Runtime::enter`] and [`Handle::enter`], the context guard exits
29
/// the runtime context on drop.
30
///
31
/// [`Runtime::enter`]: fn@crate::runtime::Runtime::enter
32
#[derive(Debug)]
33
#[must_use = "Creating and dropping a guard does nothing"]
34
pub struct EnterGuard<'a> {
35
    _guard: context::SetCurrentGuard,
36
    _handle_lifetime: PhantomData<&'a Handle>,
37
}
38
39
impl Handle {
40
    /// Enters the runtime context. This allows you to construct types that must
41
    /// have an executor available on creation such as [`Sleep`] or
42
    /// [`TcpStream`]. It will also allow you to call methods such as
43
    /// [`tokio::spawn`] and [`Handle::current`] without panicking.
44
    ///
45
    /// # Panics
46
    ///
47
    /// When calling `Handle::enter` multiple times, the returned guards
48
    /// **must** be dropped in the reverse order that they were acquired.
49
    /// Failure to do so will result in a panic and possible memory leaks.
50
    ///
51
    /// # Examples
52
    ///
53
    /// ```
54
    /// # #[cfg(not(target_family = "wasm"))]
55
    /// # {
56
    /// use tokio::runtime::Runtime;
57
    ///
58
    /// let rt = Runtime::new().unwrap();
59
    ///
60
    /// let _guard = rt.enter();
61
    /// tokio::spawn(async {
62
    ///     println!("Hello world!");
63
    /// });
64
    /// # }
65
    /// ```
66
    ///
67
    /// Do **not** do the following, this shows a scenario that will result in a
68
    /// panic and possible memory leak.
69
    ///
70
    /// ```should_panic,ignore-wasm
71
    /// use tokio::runtime::Runtime;
72
    ///
73
    /// let rt1 = Runtime::new().unwrap();
74
    /// let rt2 = Runtime::new().unwrap();
75
    ///
76
    /// let enter1 = rt1.enter();
77
    /// let enter2 = rt2.enter();
78
    ///
79
    /// drop(enter1);
80
    /// drop(enter2);
81
    /// ```
82
    ///
83
    /// [`Sleep`]: struct@crate::time::Sleep
84
    /// [`TcpStream`]: struct@crate::net::TcpStream
85
    /// [`tokio::spawn`]: fn@crate::spawn
86
0
    pub fn enter(&self) -> EnterGuard<'_> {
87
        EnterGuard {
88
0
            _guard: match context::try_set_current(&self.inner) {
89
0
                Some(guard) => guard,
90
0
                None => panic!("{}", crate::util::error::THREAD_LOCAL_DESTROYED_ERROR),
91
            },
92
0
            _handle_lifetime: PhantomData,
93
        }
94
0
    }
95
96
    /// Returns a `Handle` view over the currently running `Runtime`.
97
    ///
98
    /// # Panics
99
    ///
100
    /// This will panic if called outside the context of a Tokio runtime. That means that you must
101
    /// call this on one of the threads **being run by the runtime**, or from a thread with an active
102
    /// `EnterGuard`. Calling this from within a thread created by `std::thread::spawn` (for example)
103
    /// will cause a panic unless that thread has an active `EnterGuard`.
104
    ///
105
    /// # Examples
106
    ///
107
    /// This can be used to obtain the handle of the surrounding runtime from an async
108
    /// block or function running on that runtime.
109
    ///
110
    /// ```
111
    /// # #[cfg(not(target_family = "wasm"))]
112
    /// # {
113
    /// # use std::thread;
114
    /// # use tokio::runtime::Runtime;
115
    /// # fn dox() {
116
    /// # let rt = Runtime::new().unwrap();
117
    /// # rt.spawn(async {
118
    /// use tokio::runtime::Handle;
119
    ///
120
    /// // Inside an async block or function.
121
    /// let handle = Handle::current();
122
    /// handle.spawn(async {
123
    ///     println!("now running in the existing Runtime");
124
    /// });
125
    ///
126
    /// # let handle =
127
    /// thread::spawn(move || {
128
    ///     // Notice that the handle is created outside of this thread and then moved in
129
    ///     handle.spawn(async { /* ... */ });
130
    ///     // This next line would cause a panic because we haven't entered the runtime
131
    ///     // and created an EnterGuard
132
    ///     // let handle2 = Handle::current(); // panic
133
    ///     // So we create a guard here with Handle::enter();
134
    ///     let _guard = handle.enter();
135
    ///     // Now we can call Handle::current();
136
    ///     let handle2 = Handle::current();
137
    /// });
138
    /// # handle.join().unwrap();
139
    /// # });
140
    /// # }
141
    /// # }
142
    /// ```
143
    #[track_caller]
144
0
    pub fn current() -> Self {
145
0
        Handle {
146
0
            inner: scheduler::Handle::current(),
147
0
        }
148
0
    }
149
150
    /// Returns a Handle view over the currently running Runtime
151
    ///
152
    /// Returns an error if no Runtime has been started
153
    ///
154
    /// Contrary to `current`, this never panics
155
0
    pub fn try_current() -> Result<Self, TryCurrentError> {
156
0
        context::with_current(|inner| Handle {
157
0
            inner: inner.clone(),
158
0
        })
159
0
    }
160
161
    /// Spawns a future onto the Tokio runtime.
162
    ///
163
    /// This spawns the given future onto the runtime's executor, usually a
164
    /// thread pool. The thread pool is then responsible for polling the future
165
    /// until it completes.
166
    ///
167
    /// The provided future will start running in the background immediately
168
    /// when `spawn` is called, even if you don't await the returned
169
    /// `JoinHandle` (assuming that the runtime [is running][running-runtime]).
170
    ///
171
    /// See [module level][mod] documentation for more details.
172
    ///
173
    /// [mod]: index.html
174
    /// [running-runtime]: index.html#driving-the-runtime
175
    ///
176
    /// # Examples
177
    ///
178
    /// ```
179
    /// # #[cfg(not(target_family = "wasm"))]
180
    /// # {
181
    /// use tokio::runtime::Runtime;
182
    ///
183
    /// # fn dox() {
184
    /// // Create the runtime
185
    /// let rt = Runtime::new().unwrap();
186
    /// // Get a handle from this runtime
187
    /// let handle = rt.handle();
188
    ///
189
    /// // Spawn a future onto the runtime using the handle
190
    /// handle.spawn(async {
191
    ///     println!("now running on a worker thread");
192
    /// });
193
    /// # }
194
    /// # }
195
    /// ```
196
    #[track_caller]
197
0
    pub fn spawn<F>(&self, future: F) -> JoinHandle<F::Output>
198
0
    where
199
0
        F: Future + Send + 'static,
200
0
        F::Output: Send + 'static,
201
    {
202
0
        let fut_size = mem::size_of::<F>();
203
0
        if fut_size > BOX_FUTURE_THRESHOLD {
204
0
            self.spawn_named(Box::pin(future), SpawnMeta::new_unnamed(fut_size))
205
        } else {
206
0
            self.spawn_named(future, SpawnMeta::new_unnamed(fut_size))
207
        }
208
0
    }
209
210
    /// Runs the provided function on an executor dedicated to blocking
211
    /// operations.
212
    ///
213
    /// # Examples
214
    ///
215
    /// ```
216
    /// # #[cfg(not(target_family = "wasm"))]
217
    /// # {
218
    /// use tokio::runtime::Runtime;
219
    ///
220
    /// # fn dox() {
221
    /// // Create the runtime
222
    /// let rt = Runtime::new().unwrap();
223
    /// // Get a handle from this runtime
224
    /// let handle = rt.handle();
225
    ///
226
    /// // Spawn a blocking function onto the runtime using the handle
227
    /// handle.spawn_blocking(|| {
228
    ///     println!("now running on a worker thread");
229
    /// });
230
    /// # }
231
    /// # }
232
    /// ```
233
    #[track_caller]
234
0
    pub fn spawn_blocking<F, R>(&self, func: F) -> JoinHandle<R>
235
0
    where
236
0
        F: FnOnce() -> R + Send + 'static,
237
0
        R: Send + 'static,
238
    {
239
0
        self.inner.blocking_spawner().spawn_blocking(self, func)
240
0
    }
241
242
    /// Runs a future to completion on this `Handle`'s associated `Runtime`.
243
    ///
244
    /// This runs the given future on the current thread, blocking until it is
245
    /// complete, and yielding its resolved result. Any tasks or timers which
246
    /// the future spawns internally will be executed on the runtime.
247
    ///
248
    /// When this is used on a `current_thread` runtime, only the
249
    /// [`Runtime::block_on`] method can drive the IO and timer drivers, but the
250
    /// `Handle::block_on` method cannot drive them. This means that, when using
251
    /// this method on a `current_thread` runtime, anything that relies on IO or
252
    /// timers will not work unless there is another thread currently calling
253
    /// [`Runtime::block_on`] on the same runtime.
254
    ///
255
    /// # If the runtime has been shut down
256
    ///
257
    /// If the `Handle`'s associated `Runtime` has been shut down (through
258
    /// [`Runtime::shutdown_background`], [`Runtime::shutdown_timeout`], or by
259
    /// dropping it) and `Handle::block_on` is used it might return an error or
260
    /// panic. Specifically IO resources will return an error and timers will
261
    /// panic. Runtime independent futures will run as normal.
262
    ///
263
    /// # Panics
264
    ///
265
    /// This function will panic if any of the following conditions are met:
266
    /// - The provided future panics.
267
    /// - It is called from within an asynchronous context, such as inside
268
    ///   [`Runtime::block_on`], `Handle::block_on`, or from a function annotated
269
    ///   with [`tokio::main`].
270
    /// - A timer future is executed on a runtime that has been shut down.
271
    ///
272
    /// # Examples
273
    ///
274
    /// ```
275
    /// # #[cfg(not(target_family = "wasm"))]
276
    /// # {
277
    /// use tokio::runtime::Runtime;
278
    ///
279
    /// // Create the runtime
280
    /// let rt  = Runtime::new().unwrap();
281
    ///
282
    /// // Get a handle from this runtime
283
    /// let handle = rt.handle();
284
    ///
285
    /// // Execute the future, blocking the current thread until completion
286
    /// handle.block_on(async {
287
    ///     println!("hello");
288
    /// });
289
    /// # }
290
    /// ```
291
    ///
292
    /// Or using `Handle::current`:
293
    ///
294
    /// ```
295
    /// # #[cfg(not(target_family = "wasm"))]
296
    /// # {
297
    /// use tokio::runtime::Handle;
298
    ///
299
    /// #[tokio::main]
300
    /// async fn main () {
301
    ///     let handle = Handle::current();
302
    ///     std::thread::spawn(move || {
303
    ///         // Using Handle::block_on to run async code in the new thread.
304
    ///         handle.block_on(async {
305
    ///             println!("hello");
306
    ///         });
307
    ///     });
308
    /// }
309
    /// # }
310
    /// ```
311
    ///
312
    /// `Handle::block_on` may be combined with [`task::block_in_place`] to
313
    /// re-enter the async context of a multi-thread scheduler runtime:
314
    /// ```
315
    /// # #[cfg(not(target_family = "wasm"))]
316
    /// # {
317
    /// use tokio::task;
318
    /// use tokio::runtime::Handle;
319
    ///
320
    /// # async fn docs() {
321
    /// task::block_in_place(move || {
322
    ///     Handle::current().block_on(async move {
323
    ///         // do something async
324
    ///     });
325
    /// });
326
    /// # }
327
    /// # }
328
    /// ```
329
    ///
330
    /// [`JoinError`]: struct@crate::task::JoinError
331
    /// [`JoinHandle`]: struct@crate::task::JoinHandle
332
    /// [`Runtime::block_on`]: fn@crate::runtime::Runtime::block_on
333
    /// [`Runtime::shutdown_background`]: fn@crate::runtime::Runtime::shutdown_background
334
    /// [`Runtime::shutdown_timeout`]: fn@crate::runtime::Runtime::shutdown_timeout
335
    /// [`spawn_blocking`]: crate::task::spawn_blocking
336
    /// [`tokio::fs`]: crate::fs
337
    /// [`tokio::net`]: crate::net
338
    /// [`tokio::time`]: crate::time
339
    /// [`tokio::main`]: ../attr.main.html
340
    /// [`task::block_in_place`]: crate::task::block_in_place
341
    #[track_caller]
342
0
    pub fn block_on<F: Future>(&self, future: F) -> F::Output {
343
0
        let fut_size = mem::size_of::<F>();
344
0
        if fut_size > BOX_FUTURE_THRESHOLD {
345
0
            self.block_on_inner(Box::pin(future), SpawnMeta::new_unnamed(fut_size))
346
        } else {
347
0
            self.block_on_inner(future, SpawnMeta::new_unnamed(fut_size))
348
        }
349
0
    }
350
351
    #[track_caller]
352
0
    fn block_on_inner<F: Future>(&self, future: F, _meta: SpawnMeta<'_>) -> F::Output {
353
        #[cfg(all(
354
            tokio_unstable,
355
            feature = "taskdump",
356
            feature = "rt",
357
            target_os = "linux",
358
            any(target_arch = "aarch64", target_arch = "x86", target_arch = "x86_64")
359
        ))]
360
        let future = super::task::trace::Trace::root(future);
361
362
        #[cfg(all(tokio_unstable, feature = "tracing"))]
363
        let future =
364
            crate::util::trace::task(future, "block_on", _meta, super::task::Id::next().as_u64());
365
366
        // Enter the runtime context. This sets the current driver handles and
367
        // prevents blocking an existing runtime.
368
0
        context::enter_runtime(&self.inner, true, |blocking| {
369
0
            blocking.block_on(future).expect("failed to park thread")
370
0
        })
371
0
    }
372
373
    #[track_caller]
374
0
    pub(crate) fn spawn_named<F>(&self, future: F, meta: SpawnMeta<'_>) -> JoinHandle<F::Output>
375
0
    where
376
0
        F: Future + Send + 'static,
377
0
        F::Output: Send + 'static,
378
    {
379
0
        let id = crate::runtime::task::Id::next();
380
        #[cfg(all(
381
            tokio_unstable,
382
            feature = "taskdump",
383
            feature = "rt",
384
            target_os = "linux",
385
            any(target_arch = "aarch64", target_arch = "x86", target_arch = "x86_64")
386
        ))]
387
        let future = super::task::trace::Trace::root(future);
388
        #[cfg(all(tokio_unstable, feature = "tracing"))]
389
        let future = crate::util::trace::task(future, "task", meta, id.as_u64());
390
0
        self.inner.spawn(future, id, meta.spawned_at)
391
0
    }
392
393
    #[track_caller]
394
    #[allow(dead_code)]
395
    /// # Safety
396
    ///
397
    /// This must only be called in `LocalRuntime` if the runtime has been verified to be owned
398
    /// by the current thread.
399
0
    pub(crate) unsafe fn spawn_local_named<F>(
400
0
        &self,
401
0
        future: F,
402
0
        meta: SpawnMeta<'_>,
403
0
    ) -> JoinHandle<F::Output>
404
0
    where
405
0
        F: Future + 'static,
406
0
        F::Output: 'static,
407
    {
408
0
        let id = crate::runtime::task::Id::next();
409
        #[cfg(all(
410
            tokio_unstable,
411
            feature = "taskdump",
412
            feature = "rt",
413
            target_os = "linux",
414
            any(target_arch = "aarch64", target_arch = "x86", target_arch = "x86_64")
415
        ))]
416
        let future = super::task::trace::Trace::root(future);
417
        #[cfg(all(tokio_unstable, feature = "tracing"))]
418
        let future = crate::util::trace::task(future, "task", meta, id.as_u64());
419
0
        unsafe { self.inner.spawn_local(future, id, meta.spawned_at) }
420
0
    }
421
422
    /// Returns the flavor of the current `Runtime`.
423
    ///
424
    /// # Examples
425
    ///
426
    /// ```
427
    /// use tokio::runtime::{Handle, RuntimeFlavor};
428
    ///
429
    /// #[tokio::main(flavor = "current_thread")]
430
    /// async fn main() {
431
    ///   assert_eq!(RuntimeFlavor::CurrentThread, Handle::current().runtime_flavor());
432
    /// }
433
    /// ```
434
    ///
435
    /// ```
436
    /// # #[cfg(not(target_family = "wasm"))]
437
    /// # {
438
    /// use tokio::runtime::{Handle, RuntimeFlavor};
439
    ///
440
    /// #[tokio::main(flavor = "multi_thread", worker_threads = 4)]
441
    /// async fn main() {
442
    ///   assert_eq!(RuntimeFlavor::MultiThread, Handle::current().runtime_flavor());
443
    /// }
444
    /// # }
445
    /// ```
446
0
    pub fn runtime_flavor(&self) -> RuntimeFlavor {
447
0
        match self.inner {
448
0
            scheduler::Handle::CurrentThread(_) => RuntimeFlavor::CurrentThread,
449
            #[cfg(feature = "rt-multi-thread")]
450
            scheduler::Handle::MultiThread(_) => RuntimeFlavor::MultiThread,
451
        }
452
0
    }
453
454
    /// Returns the [`Id`] of the current `Runtime`.
455
    ///
456
    /// # Examples
457
    ///
458
    /// ```
459
    /// use tokio::runtime::Handle;
460
    ///
461
    /// #[tokio::main(flavor = "current_thread")]
462
    /// async fn main() {
463
    ///   println!("Current runtime id: {}", Handle::current().id());
464
    /// }
465
    /// ```
466
    ///
467
    /// [`Id`]: struct@crate::runtime::Id
468
0
    pub fn id(&self) -> runtime::Id {
469
0
        let owned_id = match &self.inner {
470
0
            scheduler::Handle::CurrentThread(handle) => handle.owned_id(),
471
            #[cfg(feature = "rt-multi-thread")]
472
            scheduler::Handle::MultiThread(handle) => handle.owned_id(),
473
        };
474
0
        runtime::Id::new(owned_id)
475
0
    }
476
477
    /// Returns the name of the current `Runtime`.
478
    ///
479
    /// # Examples
480
    ///
481
    /// ```
482
    /// use tokio::runtime::Handle;
483
    ///
484
    /// #[tokio::main(flavor = "current_thread", name = "my-runtime")]
485
    /// async fn main() {
486
    ///   println!("Current runtime name: {}", Handle::current().name().unwrap());
487
    /// }
488
    /// ```
489
    ///
490
0
    pub fn name(&self) -> Option<&str> {
491
0
        match &self.inner {
492
0
            scheduler::Handle::CurrentThread(handle) => handle.name(),
493
            #[cfg(feature = "rt-multi-thread")]
494
            scheduler::Handle::MultiThread(handle) => handle.name(),
495
        }
496
0
    }
497
498
    /// Returns a view that lets you get information about how the runtime
499
    /// is performing.
500
0
    pub fn metrics(&self) -> RuntimeMetrics {
501
0
        RuntimeMetrics::new(self.clone())
502
0
    }
503
}
504
505
impl std::panic::UnwindSafe for Handle {}
506
507
impl std::panic::RefUnwindSafe for Handle {}
508
509
cfg_taskdump! {
510
    impl Handle {
511
        /// Captures a snapshot of the runtime's state.
512
        ///
513
        /// If you only want to capture a snapshot of a single future's state, you can use
514
        /// [`Trace::capture`][crate::runtime::dump::Trace].
515
        ///
516
        /// This functionality is experimental, and comes with a number of
517
        /// requirements and limitations.
518
        ///
519
        /// # Examples
520
        ///
521
        /// This can be used to get call traces of each task in the runtime.
522
        /// Calls to `Handle::dump` should usually be enclosed in a
523
        /// [timeout][crate::time::timeout], so that dumping does not escalate a
524
        /// single blocked runtime thread into an entirely blocked runtime.
525
        ///
526
        /// ```
527
        /// # use tokio::runtime::Runtime;
528
        /// # fn dox() {
529
        /// # let rt = Runtime::new().unwrap();
530
        /// # rt.spawn(async {
531
        /// use tokio::runtime::Handle;
532
        /// use tokio::time::{timeout, Duration};
533
        ///
534
        /// // Inside an async block or function.
535
        /// let handle = Handle::current();
536
        /// if let Ok(dump) = timeout(Duration::from_secs(2), handle.dump()).await {
537
        ///     for (i, task) in dump.tasks().iter().enumerate() {
538
        ///         let trace = task.trace();
539
        ///         println!("TASK {i}:");
540
        ///         println!("{trace}\n");
541
        ///     }
542
        /// }
543
        /// # });
544
        /// # }
545
        /// ```
546
        ///
547
        /// This produces highly detailed traces of tasks; e.g.:
548
        ///
549
        /// ```plain
550
        /// TASK 0:
551
        /// ╼ dump::main::{{closure}}::a::{{closure}} at /tokio/examples/dump.rs:18:20
552
        /// └╼ dump::main::{{closure}}::b::{{closure}} at /tokio/examples/dump.rs:23:20
553
        ///    └╼ dump::main::{{closure}}::c::{{closure}} at /tokio/examples/dump.rs:28:24
554
        ///       └╼ tokio::sync::barrier::Barrier::wait::{{closure}} at /tokio/tokio/src/sync/barrier.rs:129:10
555
        ///          └╼ <tokio::util::trace::InstrumentedAsyncOp<F> as core::future::future::Future>::poll at /tokio/tokio/src/util/trace.rs:77:46
556
        ///             └╼ tokio::sync::barrier::Barrier::wait_internal::{{closure}} at /tokio/tokio/src/sync/barrier.rs:183:36
557
        ///                └╼ tokio::sync::watch::Receiver<T>::changed::{{closure}} at /tokio/tokio/src/sync/watch.rs:604:55
558
        ///                   └╼ tokio::sync::watch::changed_impl::{{closure}} at /tokio/tokio/src/sync/watch.rs:755:18
559
        ///                      └╼ <tokio::sync::notify::Notified as core::future::future::Future>::poll at /tokio/tokio/src/sync/notify.rs:1103:9
560
        ///                         └╼ tokio::sync::notify::Notified::poll_notified at /tokio/tokio/src/sync/notify.rs:996:32
561
        /// ```
562
        ///
563
        /// # Requirements
564
        ///
565
        /// ## Debug Info Must Be Available
566
        ///
567
        /// To produce task traces, the application must **not** be compiled
568
        /// with `split debuginfo`. On Linux, including `debuginfo` within the
569
        /// application binary is the (correct) default. You can further ensure
570
        /// this behavior with the following directive in your `Cargo.toml`:
571
        ///
572
        /// ```toml
573
        /// [profile.*]
574
        /// split-debuginfo = "off"
575
        /// ```
576
        ///
577
        /// ## Unstable Features
578
        ///
579
        /// This functionality is **unstable**, and requires both the
580
        /// `--cfg tokio_unstable` and cargo feature `taskdump` to be set.
581
        ///
582
        /// You can do this by setting the `RUSTFLAGS` environment variable
583
        /// before invoking `cargo`; e.g.:
584
        /// ```bash
585
        /// RUSTFLAGS="--cfg tokio_unstable" cargo run --example dump
586
        /// ```
587
        ///
588
        /// Or by [configuring][cargo-config] `rustflags` in
589
        /// `.cargo/config.toml`:
590
        /// ```text
591
        /// [build]
592
        /// rustflags = ["--cfg", "tokio_unstable"]
593
        /// ```
594
        ///
595
        /// [cargo-config]:
596
        ///     https://doc.rust-lang.org/cargo/reference/config.html
597
        ///
598
        /// ## Platform Requirements
599
        ///
600
        /// Task dumps are supported on Linux atop `aarch64`, `x86` and `x86_64`.
601
        ///
602
        /// ## Current Thread Runtime Requirements
603
        ///
604
        /// On the `current_thread` runtime, task dumps may only be requested
605
        /// from *within* the context of the runtime being dumped. Do not, for
606
        /// example, await `Handle::dump()` on a different runtime.
607
        ///
608
        /// # Limitations
609
        ///
610
        /// ## Performance
611
        ///
612
        /// Although enabling the `taskdump` feature imposes virtually no
613
        /// additional runtime overhead, actually calling `Handle::dump` is
614
        /// expensive. The runtime must synchronize and pause its workers, then
615
        /// re-poll every task in a special tracing mode. Avoid requesting dumps
616
        /// often.
617
        ///
618
        /// ## Local Executors
619
        ///
620
        /// Tasks managed by local executors (e.g., `FuturesUnordered` and
621
        /// [`LocalSet`][crate::task::LocalSet]) may not appear in task dumps.
622
        ///
623
        /// ## Non-Termination When Workers Are Blocked
624
        ///
625
        /// The future produced by `Handle::dump` may never produce `Ready` if
626
        /// another runtime worker is blocked for more than 250ms. This may
627
        /// occur if a dump is requested during shutdown, or if another runtime
628
        /// worker is infinite looping or synchronously deadlocked. For these
629
        /// reasons, task dumping should usually be paired with an explicit
630
        /// [timeout][crate::time::timeout].
631
        pub async fn dump(&self) -> crate::runtime::Dump {
632
            match &self.inner {
633
                scheduler::Handle::CurrentThread(handle) => handle.dump(),
634
                #[cfg(all(feature = "rt-multi-thread", not(target_os = "wasi")))]
635
                scheduler::Handle::MultiThread(handle) => {
636
                    // perform the trace in a separate thread so that the
637
                    // trace itself does not appear in the taskdump.
638
                    let handle = handle.clone();
639
                    spawn_thread(async {
640
                        let handle = handle;
641
                        handle.dump().await
642
                    }).await
643
                },
644
            }
645
        }
646
647
        /// Produces `true` if the current task is being traced for a dump;
648
        /// otherwise false. This function is only public for integration
649
        /// testing purposes. Do not rely on it.
650
        #[doc(hidden)]
651
        pub fn is_tracing() -> bool {
652
            super::task::trace::Context::is_tracing()
653
        }
654
    }
655
656
    cfg_rt_multi_thread! {
657
        /// Spawn a new thread and asynchronously await on its result.
658
        async fn spawn_thread<F>(f: F) -> <F as Future>::Output
659
        where
660
            F: Future + Send + 'static,
661
            <F as Future>::Output: Send + 'static
662
        {
663
            let (tx, rx) = crate::sync::oneshot::channel();
664
            crate::loom::thread::spawn(|| {
665
                let rt = crate::runtime::Builder::new_current_thread().build().unwrap();
666
                rt.block_on(async {
667
                    let _ = tx.send(f.await);
668
                });
669
            });
670
            rx.await.unwrap()
671
        }
672
    }
673
}
674
675
/// Error returned by `try_current` when no Runtime has been started
676
#[derive(Debug)]
677
pub struct TryCurrentError {
678
    kind: TryCurrentErrorKind,
679
}
680
681
impl TryCurrentError {
682
0
    pub(crate) fn new_no_context() -> Self {
683
0
        Self {
684
0
            kind: TryCurrentErrorKind::NoContext,
685
0
        }
686
0
    }
687
688
0
    pub(crate) fn new_thread_local_destroyed() -> Self {
689
0
        Self {
690
0
            kind: TryCurrentErrorKind::ThreadLocalDestroyed,
691
0
        }
692
0
    }
693
694
    /// Returns true if the call failed because there is currently no runtime in
695
    /// the Tokio context.
696
0
    pub fn is_missing_context(&self) -> bool {
697
0
        matches!(self.kind, TryCurrentErrorKind::NoContext)
698
0
    }
699
700
    /// Returns true if the call failed because the Tokio context thread-local
701
    /// had been destroyed. This can usually only happen if in the destructor of
702
    /// other thread-locals.
703
0
    pub fn is_thread_local_destroyed(&self) -> bool {
704
0
        matches!(self.kind, TryCurrentErrorKind::ThreadLocalDestroyed)
705
0
    }
706
}
707
708
enum TryCurrentErrorKind {
709
    NoContext,
710
    ThreadLocalDestroyed,
711
}
712
713
impl fmt::Debug for TryCurrentErrorKind {
714
0
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
715
0
        match self {
716
0
            TryCurrentErrorKind::NoContext => f.write_str("NoContext"),
717
0
            TryCurrentErrorKind::ThreadLocalDestroyed => f.write_str("ThreadLocalDestroyed"),
718
        }
719
0
    }
720
}
721
722
impl fmt::Display for TryCurrentError {
723
0
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
724
        use TryCurrentErrorKind as E;
725
0
        match self.kind {
726
0
            E::NoContext => f.write_str(CONTEXT_MISSING_ERROR),
727
0
            E::ThreadLocalDestroyed => f.write_str(THREAD_LOCAL_DESTROYED_ERROR),
728
        }
729
0
    }
730
}
731
732
impl error::Error for TryCurrentError {}