src/libnative/lib.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 //! The native I/O and threading crate
  12 //!
  13 //! This crate contains an implementation of 1:1 scheduling for a "native"
  14 //! runtime. In addition, all I/O provided by this crate is the thread blocking
  15 //! version of I/O.
  16 //!
  17 //! # Starting with libnative
  18 //!
  19 //! ```rust
  20 //! extern crate native;
  21 //!
  22 //! #[start]
  23 //! fn start(argc: int, argv: **u8) -> int { native::start(argc, argv, main) }
  24 //!
  25 //! fn main() {
  26 //!     // this code is running on the main OS thread
  27 //! }
  28 //! ```
  29 //!
  30 //! # Force spawning a native task
  31 //!
  32 //! ```rust
  33 //! extern crate native;
  34 //!
  35 //! fn main() {
  36 //!     // We're not sure whether this main function is run in 1:1 or M:N mode.
  37 //!
  38 //!     native::task::spawn(proc() {
  39 //!         // this code is guaranteed to be run on a native thread
  40 //!     });
  41 //! }
  42 //! ```
  43
  44 #![crate_id = "native#0.11.0-pre"]
  45 #![license = "MIT/ASL2"]
  46 #![crate_type = "rlib"]
  47 #![crate_type = "dylib"]
  48 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  49        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
  50        html_root_url = "http://doc.rust-lang.org/")]
  51 #![deny(unused_result, unused_must_use)]
  52 #![allow(non_camel_case_types)]
  53 #![feature(macro_rules)]
  54
  55 // NB this crate explicitly does *not* allow glob imports, please seriously
  56 //    consider whether they're needed before adding that feature here (the
  57 //    answer is that you don't need them)
  58 #![feature(macro_rules)]
  59
  60 extern crate alloc;
  61 extern crate libc;
  62 #[cfg(test)] extern crate debug;
  63
  64 use std::os;
  65 use std::rt;
  66 use std::str;
  67
  68 pub mod io;
  69 pub mod task;
  70
  71 #[cfg(windows)]
  72 #[cfg(android)]
  73 static OS_DEFAULT_STACK_ESTIMATE: uint = 1 << 20;
  74 #[cfg(unix, not(android))]
  75 static OS_DEFAULT_STACK_ESTIMATE: uint = 2 * (1 << 20);
  76
  77 #[lang = "start"]
  78 #[cfg(not(test))]
  79 pub fn lang_start(main: *u8, argc: int, argv: **u8) -> int {
  80     use std::mem;
  81     start(argc, argv, proc() {
  82         let main: extern "Rust" fn() = unsafe { mem::transmute(main) };
  83         main();
  84     })
  85 }
  86
  87 /// Executes the given procedure after initializing the runtime with the given
  88 /// argc/argv.
  89 ///
  90 /// This procedure is guaranteed to run on the thread calling this function, but
  91 /// the stack bounds for this rust task will *not* be set. Care must be taken
  92 /// for this function to not overflow its stack.
  93 ///
  94 /// This function will only return once *all* native threads in the system have
  95 /// exited.
  96 pub fn start(argc: int, argv: **u8, main: proc()) -> int {
  97     let something_around_the_top_of_the_stack = 1;
  98     let addr = &something_around_the_top_of_the_stack as *int;
  99     let my_stack_top = addr as uint;
 100
 101     // FIXME #11359 we just assume that this thread has a stack of a
 102     // certain size, and estimate that there's at most 20KB of stack
 103     // frames above our current position.
 104     let my_stack_bottom = my_stack_top + 20000 - OS_DEFAULT_STACK_ESTIMATE;
 105
 106     // When using libgreen, one of the first things that we do is to turn off
 107     // the SIGPIPE signal (set it to ignore). By default, some platforms will
 108     // send a *signal* when a EPIPE error would otherwise be delivered. This
 109     // runtime doesn't install a SIGPIPE handler, causing it to kill the
 110     // program, which isn't exactly what we want!
 111     //
 112     // Hence, we set SIGPIPE to ignore when the program starts up in order to
 113     // prevent this problem.
 114     #[cfg(windows)] fn ignore_sigpipe() {}
 115     #[cfg(unix)] fn ignore_sigpipe() {
 116         use libc;
 117         use libc::funcs::posix01::signal::signal;
 118         unsafe {
 119             assert!(signal(libc::SIGPIPE, libc::SIG_IGN) != -1);
 120         }
 121     }
 122     ignore_sigpipe();
 123
 124     rt::init(argc, argv);
 125     let mut exit_code = None;
 126     let mut main = Some(main);
 127     let mut task = task::new((my_stack_bottom, my_stack_top));
 128     task.name = Some(str::Slice("<main>"));
 129     let t = task.run(|| {
 130         unsafe {
 131             rt::stack::record_stack_bounds(my_stack_bottom, my_stack_top);
 132         }
 133         exit_code = Some(run(main.take_unwrap()));
 134     });
 135     drop(t);
 136     unsafe { rt::cleanup(); }
 137     // If the exit code wasn't set, then the task block must have failed.
 138     return exit_code.unwrap_or(rt::DEFAULT_ERROR_CODE);
 139 }
 140
 141 /// Executes a procedure on the current thread in a Rust task context.
 142 ///
 143 /// This function has all of the same details as `start` except for a different
 144 /// number of arguments.
 145 pub fn run(main: proc()) -> int {
 146     main();
 147     os::get_exit_status()
 148 }