mod.rs.html -- source
Description: Source to the Rust file `src/libstd/sys_common/mod.rs`.
Keywords: rust, rustlang, rust-lang

      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

    //! Platform-independent platform abstraction
    //!
    //! This is the platform-independent portion of the standard library's
    //! platform abstraction layer, whereas `std::sys` is the
    //! platform-specific portion.
    //!
    //! The relationship between `std::sys_common`, `std::sys` and the
    //! rest of `std` is complex, with dependencies going in all
    //! directions: `std` depending on `sys_common`, `sys_common`
    //! depending on `sys`, and `sys` depending on `sys_common` and `std`.
    //! Ideally `sys_common` would be split into two and the dependencies
    //! between them all would form a dag, facilitating the extraction of
    //! `std::sys` from the standard library.

    #![allow(missing_docs)]
    #![allow(missing_debug_implementations)]

    use crate::sync::Once;
    use crate::sys;

    macro_rules! rtabort {
        ($($t:tt)*) => (crate::sys_common::util::abort(format_args!($($t)*)))
    }

    macro_rules! rtassert {
        ($e:expr) => (if !$e {
            rtabort!(concat!("assertion failed: ", stringify!($e)));
        })
    }

    #[allow(unused_macros)] // not used on all platforms
    macro_rules! rtunwrap {
        ($ok:ident, $e:expr) => (match $e {
            $ok(v) => v,
            ref err => {
                let err = err.as_ref().map(|_|()); // map Ok/Some which might not be Debug
                rtabort!(concat!("unwrap failed: ", stringify!($e), " = {:?}"), err)
            },
        })
    }

    pub mod alloc;
    pub mod at_exit_imp;
    pub mod backtrace;
    pub mod condvar;
    pub mod io;
    pub mod mutex;
    #[cfg(any(doc, // see `mod os`, docs are generated for multiple platforms
              unix,
              target_os = "redox",
              target_os = "cloudabi",
              target_os = "hermit",
              target_arch = "wasm32",
              all(target_vendor = "fortanix", target_env = "sgx")))]
    pub mod os_str_bytes;
    pub mod poison;
    pub mod remutex;
    pub mod rwlock;
    pub mod thread;
    pub mod thread_info;
    pub mod thread_local;
    pub mod util;
    pub mod wtf8;
    pub mod bytestring;
    pub mod process;
    pub mod fs;

    cfg_if::cfg_if! {
        if #[cfg(any(target_os = "cloudabi",
                     target_os = "l4re",
                     target_os = "hermit",
                     all(target_arch = "wasm32", not(target_os = "emscripten")),
                     all(target_vendor = "fortanix", target_env = "sgx")))] {
            pub use crate::sys::net;
        } else {
            pub mod net;
        }
    }

    // common error constructors

    /// A trait for viewing representations from std types
    #[doc(hidden)]
    pub trait AsInner<Inner: ?Sized> {
        fn as_inner(&self) -> &Inner;
    }

    /// A trait for viewing representations from std types
    #[doc(hidden)]
    pub trait AsInnerMut<Inner: ?Sized> {
        fn as_inner_mut(&mut self) -> &mut Inner;
    }

    /// A trait for extracting representations from std types
    #[doc(hidden)]
    pub trait IntoInner<Inner> {
        fn into_inner(self) -> Inner;
    }

    /// A trait for creating std types from internal representations
    #[doc(hidden)]
    pub trait FromInner<Inner> {
        fn from_inner(inner: Inner) -> Self;
    }

    /// Enqueues a procedure to run when the main thread exits.
    ///
    /// Currently these closures are only run once the main *Rust* thread exits.
    /// Once the `at_exit` handlers begin running, more may be enqueued, but not
    /// infinitely so. Eventually a handler registration will be forced to fail.
    ///
    /// Returns `Ok` if the handler was successfully registered, meaning that the
    /// closure will be run once the main thread exits. Returns `Err` to indicate
    /// that the closure could not be registered, meaning that it is not scheduled
    /// to be run.
    pub fn at_exit<F: FnOnce() + Send + 'static>(f: F) -> Result<(), ()> {
        if at_exit_imp::push(Box::new(f)) {Ok(())} else {Err(())}
    }

    /// One-time runtime cleanup.
    pub fn cleanup() {
        static CLEANUP: Once = Once::new();
        CLEANUP.call_once(|| unsafe {
            sys::args::cleanup();
            sys::stack_overflow::cleanup();
            at_exit_imp::cleanup();
        });
    }

    // Computes (value*numer)/denom without overflow, as long as both
    // (numer*denom) and the overall result fit into i64 (which is the case
    // for our time conversions).
    #[allow(dead_code)] // not used on all platforms
    pub fn mul_div_u64(value: u64, numer: u64, denom: u64) -> u64 {
        let q = value / denom;
        let r = value % denom;
        // Decompose value as (value/denom*denom + value%denom),
        // substitute into (value*numer)/denom and simplify.
        // r < denom, so (denom*numer) is the upper bound of (r*numer)
        q * numer + r * numer / denom
    }

    #[test]
    fn test_muldiv() {
        assert_eq!(mul_div_u64( 1_000_000_000_001, 1_000_000_000, 1_000_000),
                   1_000_000_000_001_000);
    }