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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
use std::prelude::v1::*; use std::cell::Cell; use std::fmt; use std::sync::Arc; use std::sync::atomic::{Ordering, AtomicBool, AtomicUsize, ATOMIC_USIZE_INIT}; use std::thread; use {Poll, Future, Async}; use future::BoxFuture; use stream::Stream; mod unpark_mutex; use self::unpark_mutex::UnparkMutex; mod task_rc; mod data; #[allow(deprecated)] #[cfg(feature = "with-deprecated")] pub use self::task_rc::TaskRc; pub use self::data::LocalKey; thread_local!(static CURRENT_TASK: Cell<(*const Task, *const data::LocalMap)> = { Cell::new((0 as *const _, 0 as *const _)) }); fn fresh_task_id() -> usize { // TODO: this assert is a real bummer, need to figure out how to reuse // old IDs that are no longer in use. static NEXT_ID: AtomicUsize = ATOMIC_USIZE_INIT; let id = NEXT_ID.fetch_add(1, Ordering::Relaxed); assert!(id < usize::max_value() / 2, "too many previous tasks have been allocated"); id } fn set<F, R>(task: &Task, data: &data::LocalMap, f: F) -> R where F: FnOnce() -> R { struct Reset((*const Task, *const data::LocalMap)); impl Drop for Reset { fn drop(&mut self) { CURRENT_TASK.with(|c| c.set(self.0)); } } CURRENT_TASK.with(|c| { let _reset = Reset(c.get()); c.set((task as *const _, data as *const _)); f() }) } fn with<F: FnOnce(&Task, &data::LocalMap) -> R, R>(f: F) -> R { let (task, data) = CURRENT_TASK.with(|c| c.get()); assert!(!task.is_null(), "no Task is currently running"); debug_assert!(!data.is_null()); unsafe { f(&*task, &*data) } } /// A handle to a "task", which represents a single lightweight "thread" of /// execution driving a future to completion. /// /// In general, futures are composed into large units of work, which are then /// spawned as tasks onto an *executor*. The executor is responsible for polling /// the future as notifications arrive, until the future terminates. /// /// This is obtained by the `task::park` function. #[derive(Clone)] pub struct Task { id: usize, unpark: Arc<Unpark>, events: Events, } fn _assert_kinds() { fn _assert_send<T: Send>() {} _assert_send::<Task>(); } /// Returns a handle to the current task to call `unpark` at a later date. /// /// This function is similar to the standard library's `thread::park` function /// except that it won't block the current thread but rather the current future /// that is being executed. /// /// The returned handle implements the `Send` and `'static` bounds and may also /// be cheaply cloned. This is useful for squirreling away the handle into a /// location which is then later signaled that a future can make progress. /// /// Implementations of the `Future` trait typically use this function if they /// would otherwise perform a blocking operation. When something isn't ready /// yet, this `park` function is called to acquire a handle to the current /// task, and then the future arranges it such that when the block operation /// otherwise finishes (perhaps in the background) it will `unpark` the returned /// handle. /// /// It's sometimes necessary to pass extra information to the task when /// unparking it, so that the task knows something about *why* it was woken. See /// the `with_unpark_event` for details on how to do this. /// /// # Panics /// /// This function will panic if a task is not currently being executed. That /// is, this method can be dangerous to call outside of an implementation of /// `poll`. pub fn park() -> Task { with(|task, _| task.clone()) } impl Task { /// Indicate that the task should attempt to poll its future in a timely /// fashion. This is typically done when alerting a future that an event of /// interest has occurred through `Task::unpark`. /// /// It's typically guaranteed that, for each call to `notify`, `poll` will /// be called at least once subsequently (unless the task has terminated). /// If the task is currently polling its future when `notify` is called, it /// must poll the future *again* afterwards, ensuring that all relevant /// events are eventually observed by the future. pub fn unpark(&self) { self.events.trigger(); self.unpark.unpark(); } /// Returns `true` when called from within the context of the task. In /// other words, the task is currently running on the thread calling the /// function. pub fn is_current(&self) -> bool { with(|current, _| current.id == self.id) } } impl fmt::Debug for Task { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_struct("Task") .field("id", &self.id) .finish() } } /// For the duration of the given callback, add an "unpark event" to be /// triggered when the task handle is used to unpark the task. /// /// Unpark events are used to pass information about what event caused a task to /// be unparked. In some cases, tasks are waiting on a large number of possible /// events, and need precise information about the wakeup to avoid extraneous /// polling. /// /// Every `Task` handle comes with a set of unpark events which will fire when /// `unpark` is called. When fired, these events insert an identifer into a /// concurrent set, which the task can read from to determine what events /// occurred. /// /// This function immediately invokes the closure, `f`, but arranges things so /// that `task::park` will produce a `Task` handle that includes the given /// unpark event. /// /// # Panics /// /// This function will panic if a task is not currently being executed. That /// is, this method can be dangerous to call outside of an implementation of /// `poll`. pub fn with_unpark_event<F, R>(event: UnparkEvent, f: F) -> R where F: FnOnce() -> R { with(|task, data| { let new_task = Task { id: task.id, unpark: task.unpark.clone(), events: task.events.with_event(event), }; set(&new_task, data, f) }) } #[derive(Clone)] /// A set insertion to trigger upon `unpark`. /// /// Unpark events are used to communicate information about *why* an unpark /// occured, in particular populating sets with event identifiers so that the /// unparked task can avoid extraneous polling. See `with_unpark_event` for /// more. pub struct UnparkEvent { set: Arc<EventSet>, item: usize, } impl UnparkEvent { /// Construct an unpark event that will insert `id` into `set` when /// triggered. pub fn new(set: Arc<EventSet>, id: usize) -> UnparkEvent { UnparkEvent { set: set, item: id, } } } /// A concurrent set which allows for the insertion of `usize` values. /// /// `EventSet`s are used to communicate precise information about the event(s) /// that trigged a task notification. See `task::with_unpark_event` for details. pub trait EventSet: Send + Sync + 'static { /// Insert the given ID into the set fn insert(&self, id: usize); } // A collection of UnparkEvents to trigger on `unpark` #[derive(Clone)] enum Events { Zero, One(UnparkEvent), Lots(Vec<UnparkEvent>), } impl Events { fn new() -> Events { Events::Zero } fn trigger(&self) { match *self { Events::Zero => {} Events::One(ref event) => event.set.insert(event.item), Events::Lots(ref list) => { for event in list { event.set.insert(event.item); } } } } fn with_event(&self, event: UnparkEvent) -> Events { let mut list = match *self { Events::Zero => return Events::One(event), Events::One(ref event) => vec![event.clone()], Events::Lots(ref list) => list.clone(), }; list.push(event); Events::Lots(list) } } /// Representation of a spawned future/stream. /// /// This object is returned by the `spawn` function in this module. This /// represents a "fused task and future", storing all necessary pieces of a task /// and owning the top-level future that's being driven as well. /// /// A `Spawn` can be poll'd for completion or execution of the current thread /// can be blocked indefinitely until a notification arrives. This can be used /// with either futures or streams, with different methods being available on /// `Spawn` depending which is used. pub struct Spawn<T> { obj: T, id: usize, data: data::LocalMap, } /// Spawns a new future, returning the fused future and task. /// /// This function is the termination endpoint for running futures. This method /// will conceptually allocate a new task to run the given object, which is /// normally either a `Future` or `Stream`. /// /// This function is similar to the `thread::spawn` function but does not /// attempt to run code in the background. The future will not make progress /// until the methods on `Spawn` are called in turn. pub fn spawn<T>(obj: T) -> Spawn<T> { Spawn { obj: obj, id: fresh_task_id(), data: data::local_map(), } } impl<T> Spawn<T> { /// Get a shared reference to the object the Spawn is wrapping. pub fn get_ref(&self) -> &T { &self.obj } /// Get a mutable reference to the object the Spawn is wrapping. pub fn get_mut(&mut self) -> &mut T { &mut self.obj } /// Consume the Spawn, returning its inner object pub fn into_inner(self) -> T { self.obj } } impl<F: Future> Spawn<F> { /// Polls the internal future, scheduling notifications to be sent to the /// `unpark` argument. /// /// This method will poll the internal future, testing if it's completed /// yet. The `unpark` argument is used as a sink for notifications sent to /// this future. That is, while the future is being polled, any call to /// `task::park()` will return a handle that contains the `unpark` /// specified. /// /// If this function returns `NotReady`, then the `unpark` should have been /// scheduled to receive a notification when poll can be called again. /// Otherwise if `Ready` or `Err` is returned, the `Spawn` task can be /// safely destroyed. pub fn poll_future(&mut self, unpark: Arc<Unpark>) -> Poll<F::Item, F::Error> { self.enter(unpark, |f| f.poll()) } /// Waits for the internal future to complete, blocking this thread's /// execution until it does. /// /// This function will call `poll_future` in a loop, waiting for the future /// to complete. When a future cannot make progress it will use /// `thread::park` to block the current thread. pub fn wait_future(&mut self) -> Result<F::Item, F::Error> { let unpark = Arc::new(ThreadUnpark::new(thread::current())); loop { match try!(self.poll_future(unpark.clone())) { Async::NotReady => unpark.park(), Async::Ready(e) => return Ok(e), } } } /// A specialized function to request running a future to completion on the /// specified executor. /// /// This function only works for futures whose item and error types are `()` /// and also implement the `Send` and `'static` bounds. This will submit /// units of work (instances of `Run`) to the `exec` argument provided /// necessary to drive the future to completion. /// /// When the future would block, it's arranged that when the future is again /// ready it will submit another unit of work to the `exec` provided. This /// will happen in a loop until the future has completed. /// /// This method is not appropriate for all futures, and other kinds of /// executors typically provide a similar function with perhaps relaxed /// bounds as well. pub fn execute(self, exec: Arc<Executor>) where F: Future<Item=(), Error=()> + Send + 'static, { exec.clone().execute(Run { // Ideally this method would be defined directly on // `Spawn<BoxFuture<(), ()>>` so we wouldn't have to box here and // it'd be more explicit, but unfortunately that currently has a // link error on nightly: rust-lang/rust#36155 spawn: Spawn { id: self.id, data: self.data, obj: self.obj.boxed(), }, inner: Arc::new(Inner { exec: exec, mutex: UnparkMutex::new() }), }) } } impl<S: Stream> Spawn<S> { /// Like `poll_future`, except polls the underlying stream. pub fn poll_stream(&mut self, unpark: Arc<Unpark>) -> Poll<Option<S::Item>, S::Error> { self.enter(unpark, |stream| stream.poll()) } /// Like `wait_future`, except only waits for the next element to arrive on /// the underlying stream. pub fn wait_stream(&mut self) -> Option<Result<S::Item, S::Error>> { let unpark = Arc::new(ThreadUnpark::new(thread::current())); loop { match self.poll_stream(unpark.clone()) { Ok(Async::NotReady) => unpark.park(), Ok(Async::Ready(Some(e))) => return Some(Ok(e)), Ok(Async::Ready(None)) => return None, Err(e) => return Some(Err(e)), } } } } impl<T> Spawn<T> { fn enter<F, R>(&mut self, unpark: Arc<Unpark>, f: F) -> R where F: FnOnce(&mut T) -> R { let task = Task { id: self.id, unpark: unpark, events: Events::new(), }; let obj = &mut self.obj; set(&task, &self.data, || f(obj)) } } /// A trait which represents a sink of notifications that a future is ready to /// make progress. /// /// This trait is provided as an argument to the `Spawn::poll_future` and /// `Spawn::poll_stream` functions. It's transitively used as part of the /// `Task::unpark` method to internally deliver notifications of readiness of a /// future to move forward. pub trait Unpark: Send + Sync { /// Indicates that an associated future and/or task are ready to make /// progress. /// /// Typically this means that the receiver of the notification should /// arrange for the future to get poll'd in a prompt fashion. fn unpark(&self); } /// A trait representing requests to poll futures. /// /// This trait is an argument to the `Spawn::execute` which is used to run a /// future to completion. An executor will receive requests to run a future and /// an executor is responsible for ensuring that happens in a timely fashion. pub trait Executor: Send + Sync + 'static { /// Requests that `Run` is executed soon on the given executor. fn execute(&self, r: Run); } struct ThreadUnpark { thread: thread::Thread, ready: AtomicBool, } impl ThreadUnpark { fn new(thread: thread::Thread) -> ThreadUnpark { ThreadUnpark { thread: thread, ready: AtomicBool::new(false), } } fn park(&self) { if !self.ready.swap(false, Ordering::SeqCst) { thread::park(); } } } impl Unpark for ThreadUnpark { fn unpark(&self) { self.ready.store(true, Ordering::SeqCst); self.thread.unpark() } } /// Units of work submitted to an `Executor`, currently only created /// internally. pub struct Run { spawn: Spawn<BoxFuture<(), ()>>, inner: Arc<Inner>, } struct Inner { mutex: UnparkMutex<Run>, exec: Arc<Executor>, } impl Run { /// Actually run the task (invoking `poll` on its future) on the current /// thread. pub fn run(self) { let Run { mut spawn, inner } = self; // SAFETY: the ownership of this `Run` object is evidence that // we are in the `POLLING`/`REPOLL` state for the mutex. unsafe { inner.mutex.start_poll(); loop { match spawn.poll_future(inner.clone()) { Ok(Async::NotReady) => {} Ok(Async::Ready(())) | Err(()) => return inner.mutex.complete(), } let run = Run { spawn: spawn, inner: inner.clone() }; match inner.mutex.wait(run) { Ok(()) => return, // we've waited Err(r) => spawn = r.spawn, // someone's notified us } } } } } impl Unpark for Inner { fn unpark(&self) { match self.mutex.notify() { Ok(run) => self.exec.execute(run), Err(()) => {} } } }