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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
// Copyright 2020 Pierre Krieger // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. //! Wraps around futures and profiles them. //! //! # Usage //! //! ``` //! futures::executor::block_on(futures_diagnose::diagnose("task-name", async move { //! // ... //! })) //! ``` //! //! Wrap all your futures into `futures_diagnose::diagnose`. Then launch your program with //! the `PROFILE_DIR` environment variable set to a path name. CPU profiling will automatically //! be performed and JSON files written in the target directory. //! //! You can open the JSON files using the Chrome browser by opening the address //! `chrome://tracing`. //! use futures::future::FutureObj; use futures::task::{Spawn, SpawnError}; use std::{borrow::Cow, future::Future}; pub use fut_with_diag::{diagnose, DiagnoseFuture}; mod absolute_time; mod ctxt_with_diag; mod fut_with_diag; mod log_out; pub mod prelude { pub use crate::FutureExt as _; pub use crate::Future01Ext as _; } /// Extension trait on `Future`s. pub trait FutureExt: Future { fn with_diagnostics(self, name: impl Into<Cow<'static, str>>) -> DiagnoseFuture<Self> where Self: Sized, { fut_with_diag::diagnose(name, self) } } impl<T> FutureExt for T where T: Future {} /// Extension trait on `Future`s. pub trait Future01Ext: futures01::Future { fn with_diagnostics(self, name: impl Into<Cow<'static, str>>) -> DiagnoseFuture<Self> where Self: Sized, { fut_with_diag::diagnose(name, self) } } impl<T> Future01Ext for T where T: futures01::Future {} /// Wraps around a `T` and provides lots of diagnostics about tasks spawned through it. pub struct DiagSpawn<T> { inner: T, } impl<T> DiagSpawn<T> { /// Wraps around `inner`. pub fn new(inner: T) -> Self { DiagSpawn { inner } } } impl<T> Spawn for DiagSpawn<T> where T: Spawn, { fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError> { let wrapped = diagnose("unnamed", future); self.inner.spawn_obj(From::from(Box::pin(wrapped))) } fn status(&self) -> Result<(), SpawnError> { self.inner.status() } }