src/libnative/task.rs

   1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Tasks implemented on top of OS threads
  12 //!
  13 //! This module contains the implementation of the 1:1 threading module required
  14 //! by rust tasks. This implements the necessary API traits laid out by std::rt
  15 //! in order to spawn new tasks and deschedule the current task.
  16
  17 use std::any::Any;
  18 use std::mem;
  19 use std::rt::bookkeeping;
  20 use std::rt::local::Local;
  21 use std::rt::mutex::NativeMutex;
  22 use std::rt::rtio;
  23 use std::rt::stack;
  24 use std::rt::task::{Task, BlockedTask, TaskOpts};
  25 use std::rt::thread::Thread;
  26 use std::rt;
  27
  28 use io;
  29 use task;
  30 use std::task::{TaskBuilder, Spawner};
  31
  32 /// Creates a new Task which is ready to execute as a 1:1 task.
  33 pub fn new(stack_bounds: (uint, uint)) -> Box<Task> {
  34     let mut task = box Task::new();
  35     let mut ops = ops();
  36     ops.stack_bounds = stack_bounds;
  37     task.put_runtime(ops);
  38     return task;
  39 }
  40
  41 fn ops() -> Box<Ops> {
  42     box Ops {
  43         lock: unsafe { NativeMutex::new() },
  44         awoken: false,
  45         io: io::IoFactory::new(),
  46         // these *should* get overwritten
  47         stack_bounds: (0, 0),
  48     }
  49 }
  50
  51 /// Spawns a function with the default configuration
  52 #[deprecated = "use the native method of NativeTaskBuilder instead"]
  53 pub fn spawn(f: proc():Send) {
  54     spawn_opts(TaskOpts { name: None, stack_size: None, on_exit: None }, f)
  55 }
  56
  57 /// Spawns a new task given the configuration options and a procedure to run
  58 /// inside the task.
  59 #[deprecated = "use the native method of NativeTaskBuilder instead"]
  60 pub fn spawn_opts(opts: TaskOpts, f: proc():Send) {
  61     let TaskOpts { name, stack_size, on_exit } = opts;
  62
  63     let mut task = box Task::new();
  64     task.name = name;
  65     task.death.on_exit = on_exit;
  66
  67     let stack = stack_size.unwrap_or(rt::min_stack());
  68     let task = task;
  69     let ops = ops();
  70
  71     // Note that this increment must happen *before* the spawn in order to
  72     // guarantee that if this task exits it will always end up waiting for the
  73     // spawned task to exit.
  74     bookkeeping::increment();
  75
  76     // Spawning a new OS thread guarantees that __morestack will never get
  77     // triggered, but we must manually set up the actual stack bounds once this
  78     // function starts executing. This raises the lower limit by a bit because
  79     // by the time that this function is executing we've already consumed at
  80     // least a little bit of stack (we don't know the exact byte address at
  81     // which our stack started).
  82     Thread::spawn_stack(stack, proc() {
  83         let something_around_the_top_of_the_stack = 1;
  84         let addr = &something_around_the_top_of_the_stack as *int;
  85         let my_stack = addr as uint;
  86         unsafe {
  87             stack::record_stack_bounds(my_stack - stack + 1024, my_stack);
  88         }
  89         let mut ops = ops;
  90         ops.stack_bounds = (my_stack - stack + 1024, my_stack);
  91
  92         let mut f = Some(f);
  93         let mut task = task;
  94         task.put_runtime(ops);
  95         drop(task.run(|| { f.take_unwrap()() }).destroy());
  96         bookkeeping::decrement();
  97     })
  98 }
  99
 100 /// A spawner for native tasks
 101 pub struct NativeSpawner;
 102
 103 impl Spawner for NativeSpawner {
 104     fn spawn(self, opts: TaskOpts, f: proc():Send) {
 105         spawn_opts(opts, f)
 106     }
 107 }
 108
 109 /// An extension trait adding a `native` configuration method to `TaskBuilder`.
 110 pub trait NativeTaskBuilder {
 111     fn native(self) -> TaskBuilder<NativeSpawner>;
 112 }
 113
 114 impl<S: Spawner> NativeTaskBuilder for TaskBuilder<S> {
 115     fn native(self) -> TaskBuilder<NativeSpawner> {
 116         self.spawner(NativeSpawner)
 117     }
 118 }
 119
 120 // This structure is the glue between channels and the 1:1 scheduling mode. This
 121 // structure is allocated once per task.
 122 struct Ops {
 123     lock: NativeMutex,       // native synchronization
 124     awoken: bool,      // used to prevent spurious wakeups
 125     io: io::IoFactory, // local I/O factory
 126
 127     // This field holds the known bounds of the stack in (lo, hi) form. Not all
 128     // native tasks necessarily know their precise bounds, hence this is
 129     // optional.
 130     stack_bounds: (uint, uint),
 131 }
 132
 133 impl rt::Runtime for Ops {
 134     fn yield_now(~self, mut cur_task: Box<Task>) {
 135         // put the task back in TLS and then invoke the OS thread yield
 136         cur_task.put_runtime(self);
 137         Local::put(cur_task);
 138         Thread::yield_now();
 139     }
 140
 141     fn maybe_yield(~self, mut cur_task: Box<Task>) {
 142         // just put the task back in TLS, on OS threads we never need to
 143         // opportunistically yield b/c the OS will do that for us (preemption)
 144         cur_task.put_runtime(self);
 145         Local::put(cur_task);
 146     }
 147
 148     fn wrap(~self) -> Box<Any> {
 149         self as Box<Any>
 150     }
 151
 152     fn stack_bounds(&self) -> (uint, uint) { self.stack_bounds }
 153
 154     fn can_block(&self) -> bool { true }
 155
 156     // This function gets a little interesting. There are a few safety and
 157     // ownership violations going on here, but this is all done in the name of
 158     // shared state. Additionally, all of the violations are protected with a
 159     // mutex, so in theory there are no races.
 160     //
 161     // The first thing we need to do is to get a pointer to the task's internal
 162     // mutex. This address will not be changing (because the task is allocated
 163     // on the heap). We must have this handle separately because the task will
 164     // have its ownership transferred to the given closure. We're guaranteed,
 165     // however, that this memory will remain valid because *this* is the current
 166     // task's execution thread.
 167     //
 168     // The next weird part is where ownership of the task actually goes. We
 169     // relinquish it to the `f` blocking function, but upon returning this
 170     // function needs to replace the task back in TLS. There is no communication
 171     // from the wakeup thread back to this thread about the task pointer, and
 172     // there's really no need to. In order to get around this, we cast the task
 173     // to a `uint` which is then used at the end of this function to cast back
 174     // to a `Box<Task>` object. Naturally, this looks like it violates
 175     // ownership semantics in that there may be two `Box<Task>` objects.
 176     //
 177     // The fun part is that the wakeup half of this implementation knows to
 178     // "forget" the task on the other end. This means that the awakening half of
 179     // things silently relinquishes ownership back to this thread, but not in a
 180     // way that the compiler can understand. The task's memory is always valid
 181     // for both tasks because these operations are all done inside of a mutex.
 182     //
 183     // You'll also find that if blocking fails (the `f` function hands the
 184     // BlockedTask back to us), we will `mem::forget` the handles. The
 185     // reasoning for this is the same logic as above in that the task silently
 186     // transfers ownership via the `uint`, not through normal compiler
 187     // semantics.
 188     //
 189     // On a mildly unrelated note, it should also be pointed out that OS
 190     // condition variables are susceptible to spurious wakeups, which we need to
 191     // be ready for. In order to accommodate for this fact, we have an extra
 192     // `awoken` field which indicates whether we were actually woken up via some
 193     // invocation of `reawaken`. This flag is only ever accessed inside the
 194     // lock, so there's no need to make it atomic.
 195     fn deschedule(mut ~self, times: uint, mut cur_task: Box<Task>,
 196                   f: |BlockedTask| -> Result<(), BlockedTask>) {
 197         let me = &mut *self as *mut Ops;
 198         cur_task.put_runtime(self);
 199
 200         unsafe {
 201             let cur_task_dupe = &*cur_task as *Task;
 202             let task = BlockedTask::block(cur_task);
 203
 204             if times == 1 {
 205                 let guard = (*me).lock.lock();
 206                 (*me).awoken = false;
 207                 match f(task) {
 208                     Ok(()) => {
 209                         while !(*me).awoken {
 210                             guard.wait();
 211                         }
 212                     }
 213                     Err(task) => { mem::forget(task.wake()); }
 214                 }
 215             } else {
 216                 let iter = task.make_selectable(times);
 217                 let guard = (*me).lock.lock();
 218                 (*me).awoken = false;
 219
 220                 // Apply the given closure to all of the "selectable tasks",
 221                 // bailing on the first one that produces an error. Note that
 222                 // care must be taken such that when an error is occurred, we
 223                 // may not own the task, so we may still have to wait for the
 224                 // task to become available. In other words, if task.wake()
 225                 // returns `None`, then someone else has ownership and we must
 226                 // wait for their signal.
 227                 match iter.map(f).filter_map(|a| a.err()).next() {
 228                     None => {}
 229                     Some(task) => {
 230                         match task.wake() {
 231                             Some(task) => {
 232                                 mem::forget(task);
 233                                 (*me).awoken = true;
 234                             }
 235                             None => {}
 236                         }
 237                     }
 238                 }
 239                 while !(*me).awoken {
 240                     guard.wait();
 241                 }
 242             }
 243             // re-acquire ownership of the task
 244             cur_task = mem::transmute(cur_task_dupe);
 245         }
 246
 247         // put the task back in TLS, and everything is as it once was.
 248         Local::put(cur_task);
 249     }
 250
 251     // See the comments on `deschedule` for why the task is forgotten here, and
 252     // why it's valid to do so.
 253     fn reawaken(mut ~self, mut to_wake: Box<Task>) {
 254         unsafe {
 255             let me = &mut *self as *mut Ops;
 256             to_wake.put_runtime(self);
 257             mem::forget(to_wake);
 258             let guard = (*me).lock.lock();
 259             (*me).awoken = true;
 260             guard.signal();
 261         }
 262     }
 263
 264     fn spawn_sibling(~self,
 265                      mut cur_task: Box<Task>,
 266                      opts: TaskOpts,
 267                      f: proc():Send) {
 268         cur_task.put_runtime(self);
 269         Local::put(cur_task);
 270
 271         task::spawn_opts(opts, f);
 272     }
 273
 274     fn local_io<'a>(&'a mut self) -> Option<rtio::LocalIo<'a>> {
 275         Some(rtio::LocalIo::new(&mut self.io as &mut rtio::IoFactory))
 276     }
 277 }
 278
 279 #[cfg(test)]
 280 mod tests {
 281     use std::rt::local::Local;
 282     use std::rt::task::{Task, TaskOpts};
 283     use std::task;
 284     use std::task::TaskBuilder;
 285     use super::{spawn, spawn_opts, Ops, NativeTaskBuilder};
 286
 287     #[test]
 288     fn smoke() {
 289         let (tx, rx) = channel();
 290         spawn(proc() {
 291             tx.send(());
 292         });
 293         rx.recv();
 294     }
 295
 296     #[test]
 297     fn smoke_fail() {
 298         let (tx, rx) = channel::<()>();
 299         spawn(proc() {
 300             let _tx = tx;
 301             fail!()
 302         });
 303         assert_eq!(rx.recv_opt(), Err(()));
 304     }
 305
 306     #[test]
 307     fn smoke_opts() {
 308         let mut opts = TaskOpts::new();
 309         opts.name = Some("test".into_maybe_owned());
 310         opts.stack_size = Some(20 * 4096);
 311         let (tx, rx) = channel();
 312         opts.on_exit = Some(proc(r) tx.send(r));
 313         spawn_opts(opts, proc() {});
 314         assert!(rx.recv().is_ok());
 315     }
 316
 317     #[test]
 318     fn smoke_opts_fail() {
 319         let mut opts = TaskOpts::new();
 320         let (tx, rx) = channel();
 321         opts.on_exit = Some(proc(r) tx.send(r));
 322         spawn_opts(opts, proc() { fail!() });
 323         assert!(rx.recv().is_err());
 324     }
 325
 326     #[test]
 327     fn yield_test() {
 328         let (tx, rx) = channel();
 329         spawn(proc() {
 330             for _ in range(0u, 10) { task::deschedule(); }
 331             tx.send(());
 332         });
 333         rx.recv();
 334     }
 335
 336     #[test]
 337     fn spawn_children() {
 338         let (tx1, rx) = channel();
 339         spawn(proc() {
 340             let (tx2, rx) = channel();
 341             spawn(proc() {
 342                 let (tx3, rx) = channel();
 343                 spawn(proc() {
 344                     tx3.send(());
 345                 });
 346                 rx.recv();
 347                 tx2.send(());
 348             });
 349             rx.recv();
 350             tx1.send(());
 351         });
 352         rx.recv();
 353     }
 354
 355     #[test]
 356     fn spawn_inherits() {
 357         let (tx, rx) = channel();
 358         spawn(proc() {
 359             spawn(proc() {
 360                 let mut task: Box<Task> = Local::take();
 361                 match task.maybe_take_runtime::<Ops>() {
 362                     Some(ops) => {
 363                         task.put_runtime(ops);
 364                     }
 365                     None => fail!(),
 366                 }
 367                 Local::put(task);
 368                 tx.send(());
 369             });
 370         });
 371         rx.recv();
 372     }
 373
 374     #[test]
 375     fn test_native_builder() {
 376         let res = TaskBuilder::new().native().try(proc() {
 377             "Success!".to_string()
 378         });
 379         assert_eq!(res.ok().unwrap(), "Success!".to_string());
 380     }
 381 }