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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
//! Provides TokioTp executor specific functionality.
//
use
{
crate :: { SpawnHandle, JoinHandle, BlockingHandle } ,
std :: { fmt, sync::Arc, future::Future, convert::TryFrom } ,
futures_task :: { FutureObj, Spawn, SpawnError } ,
tokio::runtime :: { Runtime, RuntimeFlavor, Handle, Builder } ,
};
/// An executor that uses [`tokio::runtime::Runtime`].
///
/// ## Example
///
/// The following example shows how to pass an executor to a library function.
///
/// ```rust
/// use
/// {
/// futures :: { task::{ Spawn, SpawnExt } } ,
/// async_executors :: { TokioTp } ,
/// tokio::runtime :: { Builder } ,
/// std::convert :: { TryFrom } ,
/// futures::channel :: { oneshot, oneshot::Sender } ,
/// };
///
///
/// fn lib_function( exec: impl Spawn, tx: Sender<&'static str> )
/// {
/// exec.spawn( async
/// {
/// tx.send( "I can spawn from a library" ).expect( "send string" );
///
/// }).expect( "spawn task" );
/// }
///
///
/// fn main()
/// {
/// // This creates the runtime with defaults. It enables io and timers based on
/// // the features enabled on _async_executors_. You can also create `TokioTp` from
/// // a tokio `Runtime` or a `Handle`.
/// //
/// let exec = TokioTp::new().expect( "create tokio threadpool" );
///
/// let program = async
/// {
/// let (tx, rx) = oneshot::channel();
///
/// lib_function( &exec, tx );
/// assert_eq!( "I can spawn from a library", rx.await.expect( "receive on channel" ) );
/// };
///
/// exec.block_on( program );
/// }
/// ```
///
///
/// ## Unwind Safety.
///
/// You must only spawn futures to this API that are unwind safe. Tokio will wrap it in
/// [`std::panic::AssertUnwindSafe`] and wrap the poll invocation with [`std::panic::catch_unwind`].
///
/// They reason that this is fine because they require `Send + 'static` on the future. As far
/// as I can tell this is wrong. Unwind safety can be circumvented in several ways even with
/// `Send + 'static` (eg. `parking_lot::Mutex` is `Send + 'static` but `!UnwindSafe`).
///
/// You should make sure that if your future panics, no code that lives on after the spawned task has
/// unwound, nor any destructors called during the unwind can observe data in an inconsistent state.
///
/// If a future is run with `block_on` as opposed to `spawn`, the panic will not be caught and the
/// thread calling `block_on` will be unwound.
///
/// Note that unwind safety is related to logic errors, not related to the memory safety issues that cannot happen
/// in safe rust (memory safety, undefined behavior, unsoundness, data races, ...). See the relevant
/// [catch_unwind RFC](https://github.com/rust-lang/rfcs/blob/master/text/1236-stabilize-catch-panic.md)
/// and it's discussion threads for more info as well as the documentation of [`std::panic::UnwindSafe`].
//
#[ derive( Debug, Clone ) ]
//
#[ cfg_attr( nightly, doc(cfg( feature = "tokio_tp" )) ) ]
//
pub struct TokioTp
{
spawner: Spawner,
}
#[derive(Debug, Clone)]
enum Spawner
{
Runtime( Arc<Runtime> ) ,
Handle ( Handle ) ,
}
/// Allows to create a [`TokioTp`] from a [`Runtime`].
///
/// # Errors
///
/// Will fail if you pass a multithreaded runtime. In that case it will return your [`Runtime`].
//
impl TryFrom<Runtime> for TokioTp
{
type Error = Runtime;
fn try_from( rt: Runtime ) -> Result<Self, Runtime>
{
match rt.handle().runtime_flavor()
{
RuntimeFlavor::MultiThread => Ok( Self
{
spawner: Spawner::Runtime( Arc::new(rt) ) ,
}),
_ => Err( rt ),
}
}
}
/// Allows to create a [`TokioTp`] from a [`Handle`].
///
/// # Errors
///
/// Will fail if you pass a multithreaded runtime. In that case it will return your [`Handle`].
//
impl TryFrom<Handle> for TokioTp
{
type Error = Handle;
fn try_from( handle: Handle ) -> Result<Self, Handle>
{
match handle.runtime_flavor()
{
RuntimeFlavor::MultiThread => Ok( Self
{
spawner: Spawner::Handle( handle ) ,
}),
_ => Err( handle ),
}
}
}
impl TokioTp
{
/// Create a new [`TokioTp`]. Uses a default multithreaded [`Runtime`] setting timers and io depending
/// on the features enabled on _async_executors_.
//
pub fn new() -> Result<Self, TokioTpErr>
{
let mut builder = Builder::new_multi_thread();
#[ cfg( feature = "tokio_io" ) ]
//
builder.enable_io();
#[ cfg( feature = "tokio_timer" ) ]
//
builder.enable_time();
let rt = builder.build().map_err( |e| TokioTpErr::Builder(e.kind()) )?;
Ok(Self
{
spawner: Spawner::Runtime(Arc::new( rt )),
})
}
/// Try to construct a [`TokioTp`] from the currently entered [`Runtime`]. You can do this
/// if you want to construct your runtime with the tokio macros eg:
///
/// ```
/// #[tokio::main]
/// async fn main()
/// {
/// // ...
/// }
/// ```
///
/// # Warning
///
/// `TokioTp::new()` is preferred over this. It's brief, doesn't require macros and is
/// the intended behavior for this type. The whole library aims at a paradigm without
/// global executors.
///
/// The main footgun here is that you are now already in async context, so you must not
/// call [`TokioTp::block_on`]. `block_on` will panic when run from within an existing
/// async context.
///
/// # Errors
///
/// Will fail if trying to construct from a current thread runtime or if no runtime
/// is running.
//
pub fn try_current() -> Result< Self, TokioTpErr >
{
let handle = Handle::try_current()
.map_err(|_| TokioTpErr::NoRuntime )?;
Self::try_from( handle )
.map_err(|_| TokioTpErr::WrongFlavour )
}
/// Forwards to [`Runtime::block_on`] or [`Handle::block_on`].
///
/// # Panics
///
/// If called when a runtime is already entered (eg. in async context), like when you created this
/// executor with [`TokioTp::try_current`], this will panic.
//
pub fn block_on< F: Future >( &self, f: F ) -> F::Output
{
match &self.spawner
{
Spawner::Runtime( rt ) => rt .block_on( f ) ,
Spawner::Handle ( handle ) => handle.block_on( f ) ,
}
}
/// See: [`tokio::runtime::Runtime::shutdown_timeout`]
///
/// This tries to unwrap the `Arc<Runtime>` we hold, so that works only if no other clones are around. If this is not the
/// only reference, self will be returned to you as an error. It means you cannot shutdown the runtime because there are
/// other clones of the executor still alive.
///
/// # Errors
/// - [`TokioTpErr::Cloned`]: if the the [`TokioTp`] has been cloned. You can only shut down the last one.
/// - [`TokioTpErr::Handle`]: if the the [`TokioTp`] has been created from a handle. That is we don't own the [`Runtime`].
//
pub fn shutdown_timeout( self, duration: std::time::Duration ) -> Result<(), TokioTpErr>
{
let Self{ spawner } = self;
let arc = match spawner
{
Spawner::Handle ( handle ) => return Err( TokioTpErr::Handle(Self{ spawner: Spawner::Handle(handle) }) ) ,
Spawner::Runtime( arc ) => arc,
};
let rt = match Arc::try_unwrap(arc)
{
Ok(rt) => rt,
Err(arc) =>
{
let this = Self{ spawner: Spawner::Runtime(arc) };
return Err( TokioTpErr::Cloned(this) );
}
};
rt.shutdown_timeout( duration );
Ok(())
}
/// See: [`tokio::runtime::Runtime::shutdown_background`]
///
/// This tries to unwrap the `Arc<Runtime>` we hold, so that works only if no other clones are around. If this is not the
/// only reference, self will be returned to you as an error. It means you cannot shutdown the runtime because there are
/// other clones of the executor still alive.
///
/// # Errors
/// - [`TokioTpErr::Cloned`]: if the the [`TokioTp`] has been cloned. You can only shut down the last one.
/// - [`TokioTpErr::Handle`]: if the the [`TokioTp`] has been created from a handle. That is we don't own the [`Runtime`].
//
pub fn shutdown_background( self ) -> Result<(), TokioTpErr>
{
let Self{ spawner } = self;
let arc = match spawner
{
Spawner::Handle ( handle ) => return Err( TokioTpErr::Handle(Self{ spawner: Spawner::Handle(handle) }) ) ,
Spawner::Runtime( arc ) => arc,
};
let rt = match Arc::try_unwrap(arc)
{
Ok(rt) => rt,
Err(arc) =>
{
let this = Self{ spawner: Spawner::Runtime(arc) };
return Err( TokioTpErr::Cloned(this) );
}
};
rt.shutdown_background();
Ok(())
}
}
#[ cfg( feature = "tokio_io" ) ]
//
#[ cfg_attr( nightly, doc(cfg( feature = "tokio_io" )) ) ]
//
impl crate::TokioIo for TokioTp {}
impl Spawn for TokioTp
{
/// Never fails.
fn spawn_obj( &self, future: FutureObj<'static, ()> ) -> Result<(), SpawnError>
{
// We drop the JoinHandle, so the task becomes detached.
//
match &self.spawner
{
Spawner::Runtime( rt ) => drop( rt .spawn(future) ) ,
Spawner::Handle ( handle ) => drop( handle.spawn(future) ) ,
}
Ok(())
}
}
impl<Out: 'static + Send> SpawnHandle<Out> for TokioTp
{
fn spawn_handle_obj( &self, future: FutureObj<'static, Out> ) -> Result<JoinHandle<Out>, SpawnError>
{
let handle = match &self.spawner
{
Spawner::Runtime( rt ) => rt .spawn(future) ,
Spawner::Handle ( handle ) => handle.spawn(future) ,
};
Ok( JoinHandle::tokio(handle) )
}
}
impl crate::YieldNow for TokioTp {}
impl<R: Send + 'static> crate::SpawnBlocking<R> for TokioTp
{
fn spawn_blocking<F>( &self, f: F ) -> BlockingHandle<R>
where F: FnOnce() -> R + Send + 'static ,
{
let handle = match &self.spawner
{
Spawner::Runtime( rt ) => rt .spawn_blocking( f ) ,
Spawner::Handle ( handle ) => handle.spawn_blocking( f ) ,
};
BlockingHandle::tokio( handle )
}
fn spawn_blocking_dyn( &self, f: Box< dyn FnOnce()->R + Send > ) -> BlockingHandle<R>
{
self.spawn_blocking( f )
}
}
#[ cfg(all( feature = "timer", not(feature="tokio_timer" )) ) ]
//
#[ cfg_attr( nightly, doc(cfg(all( feature = "timer", feature = "tokio_tp" ))) ) ]
//
impl crate::Timer for TokioTp
{
fn sleep( &self, dur: std::time::Duration ) -> futures_core::future::BoxFuture<'static, ()>
{
Box::pin( futures_timer::Delay::new(dur) )
}
}
#[ cfg( feature = "tokio_timer" ) ]
//
#[ cfg_attr( nightly, doc(cfg(all( feature = "tokio_timer", feature = "tokio_tp" ))) ) ]
//
impl crate::Timer for TokioTp
{
fn sleep( &self, dur: std::time::Duration ) -> futures_core::future::BoxFuture<'static, ()>
{
Box::pin( tokio::time::sleep(dur) )
}
}
#[cfg( feature = "tokio_tp" )]
/// A few errors that can happen while using _tokio_ executors.
#[derive(Debug, Clone)]
pub enum TokioTpErr
{
/// The [`tokio::runtime::Builder`] returned an error when construting the [`Runtime`].
Builder( std::io::ErrorKind ),
/// There are other clones of the [`Runtime`], so we cannot shut it down.
Cloned ( TokioTp ),
/// This executor was constructed from the a [`Handle`], so cannot be shut down.
Handle ( TokioTp ),
/// Can't create from current runtime because no runtime currently entered.
NoRuntime,
/// Can't construct from a current thread runtime.
WrongFlavour,
}
impl fmt::Display for TokioTpErr
{
fn fmt( &self, f: &mut fmt::Formatter<'_> ) -> fmt::Result
{
use TokioTpErr::*;
match self
{
Builder(source) =>
write!( f, "tokio::runtime::Builder returned an error: {source}" ),
Cloned(_) => write!( f, "The TokioTp executor was cloned. Only the last copy can shut it down." ),
Handle(_) => write!( f, "The TokioTp was created from tokio::runtime::Handle. Only an owned executor (created from `Runtime`) can be shut down." ),
NoRuntime => write!( f, "Call to tokio::Handle::try_current failed, generally because no entered runtime is active." ),
WrongFlavour => write!( f, "Can't create TokioTp from a current thread `Runtime`." ),
}
}
}
impl std::error::Error for TokioTpErr {}