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
use super::{compat, idle, Builder}; use tokio_02::{ runtime::Handle as Handle02, task::{JoinHandle, LocalSet}, }; use tokio_executor_01 as executor_01; use tokio_reactor_01 as reactor_01; use tokio_timer_02 as timer_02; use futures_01::future::Future as Future01; use futures_util::{compat::Future01CompatExt, future::FutureExt}; use std::cell::RefCell; use std::error::Error; use std::fmt; use std::future::Future; use std::io; /// Single-threaded runtime provides a way to start reactor /// and executor on the current thread. /// /// See [module level][mod] documentation for more details. /// /// [mod]: index.html #[cfg_attr(docsrs, doc(cfg(feature = "rt-current-thread")))] #[derive(Debug)] pub struct Runtime { /// The inner `tokio` 0.2 runtime. inner: tokio_02::runtime::Runtime, /// Runs local futures to re-implement `tokio` 0.1's /// `current_thread::Runtime::spawn_local`. local: LocalSet, /// Idleness tracking for `shutdown_on_idle`. idle: idle::Idle, idle_rx: idle::Rx, /// Compatibility background thread. /// /// This maintains a `tokio` 0.1 timer and reactor to support running /// futures that use older tokio APIs. compat: compat::Background, } /// Handle to spawn a future on the corresponding `CurrentThread` runtime instance #[cfg_attr(docsrs, doc(cfg(feature = "rt-current-thread")))] #[derive(Debug, Clone)] pub struct Handle { inner: Handle02, idle: idle::Idle, } thread_local! { static CURRENT_IDLE: RefCell<Option<idle::Idle>> = RefCell::new(None); } impl Handle { /// Spawn a `futures` 0.1 future onto the `CurrentThread` runtime instance /// corresponding to this handle. /// /// Note that unlike the `tokio` 0.1 version of this function, this method /// never actually returns `Err` — it returns `Result` only for API /// compatibility. pub fn spawn<F>(&self, future: F) -> Result<(), executor_01::SpawnError> where F: Future01<Item = (), Error = ()> + Send + 'static, { let future = future.compat().map(|_| ()); self.spawn_std(future) } /// Spawn a `std::future` future onto the `CurrentThread` runtime instance /// corresponding to this handle. pub fn spawn_std<F>(&self, future: F) -> Result<(), executor_01::SpawnError> where F: Future<Output = ()> + Send + 'static, { let idle = self.idle.reserve(); self.inner.spawn(idle.with(future)); Ok(()) } /// Spawn a `futures` 0.1 future onto the Tokio runtime, returning a /// `JoinHandle` that can be used to await its result. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// See [module level][mod] documentation for more details. /// /// **Note** that futures spawned in this manner do not "count" towards /// keeping the runtime active for [`shutdown_on_idle`], since they are paired /// with a `JoinHandle` for awaiting their completion. See [here] for /// details on shutting down the compatibility runtime. /// /// [`shutdown_on_idle`]: struct.Runtime.html#method.shutdown_on_idle /// [here]: ../index.html#shutting-down /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `futures` 0.1 future onto the runtime /// executor.spawn(futures_01::future::lazy(|| { /// println!("now running on a worker thread"); /// Ok(()) /// })); /// # } /// ``` pub fn spawn_handle<F>(&self, future: F) -> JoinHandle<Result<F::Item, F::Error>> where F: Future01 + Send + 'static, F::Item: Send + 'static, F::Error: Send + 'static, { let future = Box::pin(future.compat()); self.spawn_handle_std(future) } /// Spawn a `std::future` future onto the Tokio runtime, returning a /// `JoinHandle` that can be used to await its result. /// /// This spawns the given future onto the runtime's executor, usually a /// thread pool. The thread pool is then responsible for polling the future /// until it completes. /// /// See [module level][mod] documentation for more details. /// **Note** that futures spawned in this manner do not "count" towards /// keeping the runtime active for [`shutdown_on_idle`], since they are paired /// with a `JoinHandle` for awaiting their completion. See [here] for /// details on shutting down the compatibility runtime. /// /// [`shutdown_on_idle`]: struct.Runtime.html#method.shutdown_on_idle /// [here]: ../index.html#shutting-down /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::Runtime; /// /// # fn dox() { /// // Create the runtime /// let rt = Runtime::new().unwrap(); /// let executor = rt.executor(); /// /// // Spawn a `std::future` future onto the runtime /// executor.spawn_std(async { /// println!("now running on a worker thread"); /// }); /// # } /// ``` pub fn spawn_handle_std<F>(&self, future: F) -> JoinHandle<F::Output> where F: Future + Send + 'static, F::Output: Send + 'static, { self.inner.spawn(future) } /// Provides a best effort **hint** to whether or not `spawn` will succeed. /// /// This function may return both false positives **and** false negatives. /// If `status` returns `Ok`, then a call to `spawn` will *probably* /// succeed, but may fail. If `status` returns `Err`, a call to `spawn` will /// *probably* fail, but may succeed. /// /// This allows a caller to avoid creating the task if the call to `spawn` /// has a high likelihood of failing. pub fn status(&self) -> Result<(), executor_01::SpawnError> { Ok(()) } } /// Error returned by the `run` function. #[derive(Debug)] #[cfg_attr(docsrs, doc(cfg(feature = "rt-current-thread")))] pub struct RunError { inner: (), } impl fmt::Display for RunError { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { write!(fmt, "RunError") } } impl Error for RunError {} impl Runtime { /// Returns a new runtime initialized with default configuration values. pub fn new() -> io::Result<Runtime> { Builder::new().build() } pub(super) fn new2( inner: tokio_02::runtime::Runtime, idle: idle::Idle, idle_rx: idle::Rx, compat: compat::Background, ) -> Self { Self { inner, idle, idle_rx, compat, local: tokio_02::task::LocalSet::new(), } } /// Get a new handle to spawn futures on the single-threaded Tokio runtime /// /// Different to the runtime itself, the handle can be sent to different /// threads. /// /// Unlike the `tokio` 0.1 `current_thread::Handle`, this handle can spawn /// both `futures` 0.1 and `std::future` tasks. pub fn handle(&self) -> Handle { let inner = self.inner.handle().clone(); let idle = self.idle.clone(); Handle { inner, idle } } /// Spawn a `futures` 0.1 future onto the single-threaded Tokio runtime. /// /// See [module level][mod] documentation for more details. /// /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::current_thread::Runtime; /// /// # fn dox() { /// // Create the runtime /// let mut rt = Runtime::new().unwrap(); /// /// // Spawn a future onto the runtime /// rt.spawn(futures_01::future::lazy(|| { /// println!("now running on a worker thread"); /// Ok(()) /// })); /// # } /// ``` pub fn spawn<F>(&mut self, future: F) -> &mut Self where F: Future01<Item = (), Error = ()> + 'static, { let future = future.compat().map(|_| ()); self.spawn_std(future) } /// Spawn a `std::future` future onto the single-threaded Tokio runtime. /// /// See [module level][mod] documentation for more details. /// /// [mod]: index.html /// /// # Examples /// /// ``` /// use tokio_compat::runtime::current_thread::Runtime; /// /// # fn dox() { /// // Create the runtime /// let mut rt = Runtime::new().unwrap(); /// /// // Spawn a future onto the runtime /// rt.spawn_std(async { /// println!("now running on a worker thread"); /// }); /// # } /// ``` pub fn spawn_std<F>(&mut self, future: F) -> &mut Self where F: Future<Output = ()> + 'static, { let idle = self.idle.reserve(); self.local.spawn_local(idle.with(future)); self } /// Runs the provided `futures` 0.1 future, blocking the current thread /// until the future completes. /// /// This function can be used to synchronously block the current thread /// until the provided `future` has resolved either successfully or with an /// error. The result of the future is then returned from this function /// call. /// /// Note that this function will **also** execute any spawned futures on the /// current thread, but will **not** block until these other spawned futures /// have completed. Once the function returns, any uncompleted futures /// remain pending in the `Runtime` instance. These futures will not run /// until `block_on` or `run` is called again. /// /// The caller is responsible for ensuring that other spawned futures /// complete execution by calling `block_on` or `run`. pub fn block_on<F>(&mut self, f: F) -> Result<F::Item, F::Error> where F: Future01 + 'static, { self.block_on_std(f.compat()) } /// Runs the provided `std::future` future, blocking the current thread /// until the future completes. /// /// This function can be used to synchronously block the current thread /// until the provided `future` has resolved either successfully or with an /// error. The result of the future is then returned from this function /// call. /// /// Note that this function will **also** execute any spawned futures on the /// current thread, but will **not** block until these other spawned futures /// have completed. Once the function returns, any uncompleted futures /// remain pending in the `Runtime` instance. These futures will not run /// until `block_on` or `run` is called again. /// /// The caller is responsible for ensuring that other spawned futures /// complete execution by calling `block_on` or `run`. pub fn block_on_std<F>(&mut self, f: F) -> F::Output where F: Future + 'static, { let handle = self.inner.handle().clone(); let Runtime { ref mut local, ref mut inner, ref compat, ref idle, .. } = *self; let mut spawner = compat::CompatSpawner::new(handle, &idle); let mut enter = executor_01::enter().unwrap(); // Set the default tokio 0.1 reactor to the background compat reactor. let _reactor = reactor_01::set_default(compat.reactor()); let _timer = timer_02::timer::set_default(compat.timer()); let track = self.idle.reserve(); executor_01::with_default(&mut spawner, &mut enter, |_enter| { Self::with_idle(idle, move || local.block_on(inner, track.with(f))) }) } /// Run the executor to completion, blocking the thread until **all** /// spawned futures have completed. pub fn run(&mut self) -> Result<(), RunError> { let handle = self.inner.handle().clone(); let Runtime { ref mut local, ref mut inner, ref compat, ref mut idle_rx, ref idle, .. } = *self; let mut spawner = compat::CompatSpawner::new(handle, &idle); let mut enter = executor_01::enter().unwrap(); // Set the default tokio 0.1 reactor to the background compat reactor. let _reactor = reactor_01::set_default(compat.reactor()); let _timer = timer_02::timer::set_default(compat.timer()); executor_01::with_default(&mut spawner, &mut enter, |_enter| { Self::with_idle(idle, move || local.block_on(inner, idle_rx.recv())) }); Ok(()) } fn with_idle<T>(idle: &idle::Idle, f: impl FnOnce() -> T) -> T { struct Reset<'a>(&'a RefCell<Option<idle::Idle>>); impl<'a> Drop for Reset<'a> { fn drop(&mut self) { self.0.borrow_mut().take(); } } let idle = idle.clone(); CURRENT_IDLE.with(move |c| { let was_empty = c.borrow_mut().replace(idle).is_none(); assert!(was_empty, "entered current_thread runtime twice!"); let _reset = Reset(c); f() }) } pub(super) fn reserve_idle() -> Option<idle::Track> { CURRENT_IDLE .try_with(|c| { let idle = c.borrow(); Some(idle.as_ref()?.reserve()) }) .ok() .and_then(|x| x) } pub(super) fn is_current() -> bool { CURRENT_IDLE .try_with(|c| c.borrow().is_some()) .unwrap_or(false) } }