src/libstd/sys_common/mod.rs

   1 // Copyright 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 //! Platform-independent platform abstraction
  12 //!
  13 //! This is the platform-independent portion of the standard library's
  14 //! platform abstraction layer, whereas `std::sys` is the
  15 //! platform-specific portion.
  16 //!
  17 //! The relationship between `std::sys_common`, `std::sys` and the
  18 //! rest of `std` is complex, with dependencies going in all
  19 //! directions: `std` depending on `sys_common`, `sys_common`
  20 //! depending on `sys`, and `sys` depending on `sys_common` and `std`.
  21 //! Ideally `sys_common` would be split into two and the dependencies
  22 //! between them all would form a dag, facilitating the extraction of
  23 //! `std::sys` from the standard library.
  24
  25 #![allow(missing_docs)]
  26 #![allow(missing_debug_implementations)]
  27
  28 use sync::Once;
  29 use sys;
  30
  31 macro_rules! rtabort {
  32     ($($t:tt)*) => (::sys_common::util::abort(format_args!($($t)*)))
  33 }
  34
  35 macro_rules! rtassert {
  36     ($e:expr) => (if !$e {
  37         rtabort!(concat!("assertion failed: ", stringify!($e)));
  38     })
  39 }
  40
  41 pub mod alloc;
  42 pub mod at_exit_imp;
  43 #[cfg(feature = "backtrace")]
  44 pub mod backtrace;
  45 pub mod condvar;
  46 pub mod io;
  47 pub mod mutex;
  48 pub mod poison;
  49 pub mod remutex;
  50 pub mod rwlock;
  51 pub mod thread;
  52 pub mod thread_info;
  53 pub mod thread_local;
  54 pub mod util;
  55 pub mod wtf8;
  56 pub mod bytestring;
  57 pub mod process;
  58
  59 cfg_if! {
  60     if #[cfg(any(target_os = "cloudabi",
  61                  target_os = "l4re",
  62                  target_os = "redox",
  63                  all(target_arch = "wasm32", not(target_os = "emscripten")),
  64                  target_env = "sgx"))] {
  65         pub use sys::net;
  66     } else {
  67         pub mod net;
  68     }
  69 }
  70
  71 #[cfg(feature = "backtrace")]
  72 #[cfg(any(all(unix, not(target_os = "emscripten")),
  73           all(windows, target_env = "gnu"),
  74           target_os = "redox"))]
  75 pub mod gnu;
  76
  77 // common error constructors
  78
  79 /// A trait for viewing representations from std types
  80 #[doc(hidden)]
  81 pub trait AsInner<Inner: ?Sized> {
  82     fn as_inner(&self) -> &Inner;
  83 }
  84
  85 /// A trait for viewing representations from std types
  86 #[doc(hidden)]
  87 pub trait AsInnerMut<Inner: ?Sized> {
  88     fn as_inner_mut(&mut self) -> &mut Inner;
  89 }
  90
  91 /// A trait for extracting representations from std types
  92 #[doc(hidden)]
  93 pub trait IntoInner<Inner> {
  94     fn into_inner(self) -> Inner;
  95 }
  96
  97 /// A trait for creating std types from internal representations
  98 #[doc(hidden)]
  99 pub trait FromInner<Inner> {
 100     fn from_inner(inner: Inner) -> Self;
 101 }
 102
 103 /// Enqueues a procedure to run when the main thread exits.
 104 ///
 105 /// Currently these closures are only run once the main *Rust* thread exits.
 106 /// Once the `at_exit` handlers begin running, more may be enqueued, but not
 107 /// infinitely so. Eventually a handler registration will be forced to fail.
 108 ///
 109 /// Returns `Ok` if the handler was successfully registered, meaning that the
 110 /// closure will be run once the main thread exits. Returns `Err` to indicate
 111 /// that the closure could not be registered, meaning that it is not scheduled
 112 /// to be run.
 113 pub fn at_exit<F: FnOnce() + Send + 'static>(f: F) -> Result<(), ()> {
 114     if at_exit_imp::push(Box::new(f)) {Ok(())} else {Err(())}
 115 }
 116
 117 /// One-time runtime cleanup.
 118 pub fn cleanup() {
 119     static CLEANUP: Once = Once::new();
 120     CLEANUP.call_once(|| unsafe {
 121         sys::args::cleanup();
 122         sys::stack_overflow::cleanup();
 123         at_exit_imp::cleanup();
 124     });
 125 }
 126
 127 // Computes (value*numer)/denom without overflow, as long as both
 128 // (numer*denom) and the overall result fit into i64 (which is the case
 129 // for our time conversions).
 130 #[allow(dead_code)] // not used on all platforms
 131 pub fn mul_div_u64(value: u64, numer: u64, denom: u64) -> u64 {
 132     let q = value / denom;
 133     let r = value % denom;
 134     // Decompose value as (value/denom*denom + value%denom),
 135     // substitute into (value*numer)/denom and simplify.
 136     // r < denom, so (denom*numer) is the upper bound of (r*numer)
 137     q * numer + r * numer / denom
 138 }
 139
 140 #[test]
 141 fn test_muldiv() {
 142     assert_eq!(mul_div_u64( 1_000_000_000_001, 1_000_000_000, 1_000_000),
 143                1_000_000_000_001_000);
 144 }