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 at_exit_imp;
  42 #[cfg(feature = "backtrace")]
  43 pub mod backtrace;
  44 pub mod condvar;
  45 pub mod io;
  46 pub mod mutex;
  47 pub mod poison;
  48 pub mod remutex;
  49 pub mod rwlock;
  50 pub mod thread;
  51 pub mod thread_info;
  52 pub mod thread_local;
  53 pub mod util;
  54 pub mod wtf8;
  55 pub mod bytestring;
  56 pub mod process;
  57
  58 cfg_if! {
  59     if #[cfg(any(target_os = "cloudabi", target_os = "l4re", target_os = "redox"))] {
  60         pub use sys::net;
  61     } else if #[cfg(all(target_arch = "wasm32", not(target_os = "emscripten")))] {
  62         pub use sys::net;
  63     } else {
  64         pub mod net;
  65     }
  66 }
  67
  68 #[cfg(feature = "backtrace")]
  69 #[cfg(any(all(unix, not(target_os = "emscripten")),
  70           all(windows, target_env = "gnu"),
  71           target_os = "redox"))]
  72 pub mod gnu;
  73
  74 // common error constructors
  75
  76 /// A trait for viewing representations from std types
  77 #[doc(hidden)]
  78 pub trait AsInner<Inner: ?Sized> {
  79     fn as_inner(&self) -> &Inner;
  80 }
  81
  82 /// A trait for viewing representations from std types
  83 #[doc(hidden)]
  84 pub trait AsInnerMut<Inner: ?Sized> {
  85     fn as_inner_mut(&mut self) -> &mut Inner;
  86 }
  87
  88 /// A trait for extracting representations from std types
  89 #[doc(hidden)]
  90 pub trait IntoInner<Inner> {
  91     fn into_inner(self) -> Inner;
  92 }
  93
  94 /// A trait for creating std types from internal representations
  95 #[doc(hidden)]
  96 pub trait FromInner<Inner> {
  97     fn from_inner(inner: Inner) -> Self;
  98 }
  99
 100 /// Enqueues a procedure to run when the main thread exits.
 101 ///
 102 /// Currently these closures are only run once the main *Rust* thread exits.
 103 /// Once the `at_exit` handlers begin running, more may be enqueued, but not
 104 /// infinitely so. Eventually a handler registration will be forced to fail.
 105 ///
 106 /// Returns `Ok` if the handler was successfully registered, meaning that the
 107 /// closure will be run once the main thread exits. Returns `Err` to indicate
 108 /// that the closure could not be registered, meaning that it is not scheduled
 109 /// to be run.
 110 pub fn at_exit<F: FnOnce() + Send + 'static>(f: F) -> Result<(), ()> {
 111     if at_exit_imp::push(Box::new(f)) {Ok(())} else {Err(())}
 112 }
 113
 114 /// One-time runtime cleanup.
 115 pub fn cleanup() {
 116     static CLEANUP: Once = Once::new();
 117     CLEANUP.call_once(|| unsafe {
 118         sys::args::cleanup();
 119         sys::stack_overflow::cleanup();
 120         at_exit_imp::cleanup();
 121     });
 122 }
 123
 124 // Computes (value*numer)/denom without overflow, as long as both
 125 // (numer*denom) and the overall result fit into i64 (which is the case
 126 // for our time conversions).
 127 #[allow(dead_code)] // not used on all platforms
 128 pub fn mul_div_u64(value: u64, numer: u64, denom: u64) -> u64 {
 129     let q = value / denom;
 130     let r = value % denom;
 131     // Decompose value as (value/denom*denom + value%denom),
 132     // substitute into (value*numer)/denom and simplify.
 133     // r < denom, so (denom*numer) is the upper bound of (r*numer)
 134     q * numer + r * numer / denom
 135 }
 136
 137 #[test]
 138 fn test_muldiv() {
 139     assert_eq!(mul_div_u64( 1_000_000_000_001, 1_000_000_000, 1_000_000),
 140                1_000_000_000_001_000);
 141 }