mod.rs - source
Description: Source of the Rust file `library/std/src/sys/unix/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
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290

    #![allow(missing_docs, nonstandard_style)]

    use crate::io::ErrorKind;

    #[cfg(any(doc, target_os = "linux"))]
    pub use crate::os::linux as platform;

    #[cfg(all(not(doc), target_os = "android"))]
    pub use crate::os::android as platform;
    #[cfg(all(not(doc), target_os = "dragonfly"))]
    pub use crate::os::dragonfly as platform;
    #[cfg(all(not(doc), target_os = "emscripten"))]
    pub use crate::os::emscripten as platform;
    #[cfg(all(not(doc), target_os = "freebsd"))]
    pub use crate::os::freebsd as platform;
    #[cfg(all(not(doc), target_os = "fuchsia"))]
    pub use crate::os::fuchsia as platform;
    #[cfg(all(not(doc), target_os = "haiku"))]
    pub use crate::os::haiku as platform;
    #[cfg(all(not(doc), target_os = "illumos"))]
    pub use crate::os::illumos as platform;
    #[cfg(all(not(doc), target_os = "ios"))]
    pub use crate::os::ios as platform;
    #[cfg(all(not(doc), target_os = "l4re"))]
    pub use crate::os::linux as platform;
    #[cfg(all(not(doc), target_os = "macos"))]
    pub use crate::os::macos as platform;
    #[cfg(all(not(doc), target_os = "netbsd"))]
    pub use crate::os::netbsd as platform;
    #[cfg(all(not(doc), target_os = "openbsd"))]
    pub use crate::os::openbsd as platform;
    #[cfg(all(not(doc), target_os = "redox"))]
    pub use crate::os::redox as platform;
    #[cfg(all(not(doc), target_os = "solaris"))]
    pub use crate::os::solaris as platform;

    pub use self::rand::hashmap_random_keys;
    pub use libc::strlen;

    #[macro_use]
    pub mod weak;

    pub mod alloc;
    pub mod android;
    pub mod args;
    pub mod cmath;
    pub mod condvar;
    pub mod env;
    pub mod ext;
    pub mod fd;
    pub mod fs;
    pub mod futex;
    pub mod io;
    #[cfg(any(target_os = "linux", target_os = "android"))]
    pub mod kernel_copy;
    #[cfg(target_os = "l4re")]
    mod l4re;
    pub mod memchr;
    pub mod mutex;
    #[cfg(not(target_os = "l4re"))]
    pub mod net;
    #[cfg(target_os = "l4re")]
    pub use self::l4re::net;
    pub mod os;
    pub mod path;
    pub mod pipe;
    pub mod process;
    pub mod rand;
    pub mod rwlock;
    pub mod stack_overflow;
    pub mod stdio;
    pub mod thread;
    pub mod thread_local_dtor;
    pub mod thread_local_key;
    pub mod time;

    pub use crate::sys_common::os_str_bytes as os_str;

    #[cfg(not(test))]
    pub fn init() {
        // The standard streams might be closed on application startup. To prevent
        // std::io::{stdin, stdout,stderr} objects from using other unrelated file
        // resources opened later, we reopen standards streams when they are closed.
        unsafe {
            sanitize_standard_fds();
        }

        // By default, some platforms will send a *signal* when an EPIPE error
        // would otherwise be delivered. This runtime doesn't install a SIGPIPE
        // handler, causing it to kill the program, which isn't exactly what we
        // want!
        //
        // Hence, we set SIGPIPE to ignore when the program starts up in order
        // to prevent this problem.
        unsafe {
            reset_sigpipe();
        }

        cfg_if::cfg_if! {
            if #[cfg(miri)] {
                // The standard fds are always available in Miri.
                unsafe fn sanitize_standard_fds() {}
            } else if #[cfg(not(any(
                target_os = "emscripten",
                target_os = "fuchsia",
                // The poll on Darwin doesn't set POLLNVAL for closed fds.
                target_os = "macos",
                target_os = "ios",
                target_os = "redox",
            )))] {
                // In the case when all file descriptors are open, the poll has been
                // observed to perform better than fcntl (on GNU/Linux).
                unsafe fn sanitize_standard_fds() {
                    use crate::sys::os::errno;
                    let pfds: &mut [_] = &mut [
                        libc::pollfd { fd: 0, events: 0, revents: 0 },
                        libc::pollfd { fd: 1, events: 0, revents: 0 },
                        libc::pollfd { fd: 2, events: 0, revents: 0 },
                    ];
                    while libc::poll(pfds.as_mut_ptr(), 3, 0) == -1 {
                        if errno() == libc::EINTR {
                            continue;
                        }
                        libc::abort();
                    }
                    for pfd in pfds {
                        if pfd.revents & libc::POLLNVAL == 0 {
                            continue;
                        }
                        if libc::open("/dev/null\0".as_ptr().cast(), libc::O_RDWR, 0) == -1 {
                            // If the stream is closed but we failed to reopen it, abort the
                            // process. Otherwise we wouldn't preserve the safety of
                            // operations on the corresponding Rust object Stdin, Stdout, or
                            // Stderr.
                            libc::abort();
                        }
                    }
                }
            } else if #[cfg(any(target_os = "macos", target_os = "ios", target_os = "redox"))] {
                unsafe fn sanitize_standard_fds() {
                    use crate::sys::os::errno;
                    for fd in 0..3 {
                        if libc::fcntl(fd, libc::F_GETFD) == -1 && errno() == libc::EBADF {
                            if libc::open("/dev/null\0".as_ptr().cast(), libc::O_RDWR, 0) == -1 {
                                libc::abort();
                            }
                        }
                    }
                }
            } else {
                unsafe fn sanitize_standard_fds() {}
            }
        }

        #[cfg(not(any(target_os = "emscripten", target_os = "fuchsia")))]
        unsafe fn reset_sigpipe() {
            assert!(signal(libc::SIGPIPE, libc::SIG_IGN) != libc::SIG_ERR);
        }
        #[cfg(any(target_os = "emscripten", target_os = "fuchsia"))]
        unsafe fn reset_sigpipe() {}
    }

    #[cfg(target_os = "android")]
    pub use crate::sys::android::signal;
    #[cfg(not(target_os = "android"))]
    pub use libc::signal;

    pub fn decode_error_kind(errno: i32) -> ErrorKind {
        match errno as libc::c_int {
            libc::ECONNREFUSED => ErrorKind::ConnectionRefused,
            libc::ECONNRESET => ErrorKind::ConnectionReset,
            libc::EPERM | libc::EACCES => ErrorKind::PermissionDenied,
            libc::EPIPE => ErrorKind::BrokenPipe,
            libc::ENOTCONN => ErrorKind::NotConnected,
            libc::ECONNABORTED => ErrorKind::ConnectionAborted,
            libc::EADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
            libc::EADDRINUSE => ErrorKind::AddrInUse,
            libc::ENOENT => ErrorKind::NotFound,
            libc::EINTR => ErrorKind::Interrupted,
            libc::EINVAL => ErrorKind::InvalidInput,
            libc::ETIMEDOUT => ErrorKind::TimedOut,
            libc::EEXIST => ErrorKind::AlreadyExists,

            // These two constants can have the same value on some systems,
            // but different values on others, so we can't use a match
            // clause
            x if x == libc::EAGAIN || x == libc::EWOULDBLOCK => ErrorKind::WouldBlock,

            _ => ErrorKind::Other,
        }
    }

    #[doc(hidden)]
    pub trait IsMinusOne {
        fn is_minus_one(&self) -> bool;
    }

    macro_rules! impl_is_minus_one {
        ($($t:ident)*) => ($(impl IsMinusOne for $t {
            fn is_minus_one(&self) -> bool {
                *self == -1
            }
        })*)
    }

    impl_is_minus_one! { i8 i16 i32 i64 isize }

    pub fn cvt<T: IsMinusOne>(t: T) -> crate::io::Result<T> {
        if t.is_minus_one() { Err(crate::io::Error::last_os_error()) } else { Ok(t) }
    }

    pub fn cvt_r<T, F>(mut f: F) -> crate::io::Result<T>
    where
        T: IsMinusOne,
        F: FnMut() -> T,
    {
        loop {
            match cvt(f()) {
                Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                other => return other,
            }
        }
    }

    pub fn cvt_nz(error: libc::c_int) -> crate::io::Result<()> {
        if error == 0 { Ok(()) } else { Err(crate::io::Error::from_raw_os_error(error)) }
    }

    // On Unix-like platforms, libc::abort will unregister signal handlers
    // including the SIGABRT handler, preventing the abort from being blocked, and
    // fclose streams, with the side effect of flushing them so libc buffered
    // output will be printed.  Additionally the shell will generally print a more
    // understandable error message like "Abort trap" rather than "Illegal
    // instruction" that intrinsics::abort would cause, as intrinsics::abort is
    // implemented as an illegal instruction.
    pub fn abort_internal() -> ! {
        unsafe { libc::abort() }
    }

    cfg_if::cfg_if! {
        if #[cfg(target_os = "android")] {
            #[link(name = "dl")]
            #[link(name = "log")]
            #[link(name = "gcc")]
            extern "C" {}
        } else if #[cfg(target_os = "freebsd")] {
            #[link(name = "execinfo")]
            #[link(name = "pthread")]
            extern "C" {}
        } else if #[cfg(target_os = "netbsd")] {
            #[link(name = "pthread")]
            #[link(name = "rt")]
            extern "C" {}
        } else if #[cfg(any(target_os = "dragonfly", target_os = "openbsd"))] {
            #[link(name = "pthread")]
            extern "C" {}
        } else if #[cfg(target_os = "solaris")] {
            #[link(name = "socket")]
            #[link(name = "posix4")]
            #[link(name = "pthread")]
            #[link(name = "resolv")]
            extern "C" {}
        } else if #[cfg(target_os = "illumos")] {
            #[link(name = "socket")]
            #[link(name = "posix4")]
            #[link(name = "pthread")]
            #[link(name = "resolv")]
            #[link(name = "nsl")]
            // Use libumem for the (malloc-compatible) allocator
            #[link(name = "umem")]
            extern "C" {}
        } else if #[cfg(target_os = "macos")] {
            #[link(name = "System")]
            // res_init and friends require -lresolv on macOS/iOS.
            // See #41582 and http://blog.achernya.com/2013/03/os-x-has-silly-libsystem.html
            #[link(name = "resolv")]
            extern "C" {}
        } else if #[cfg(target_os = "ios")] {
            #[link(name = "System")]
            #[link(name = "objc")]
            #[link(name = "Security", kind = "framework")]
            #[link(name = "Foundation", kind = "framework")]
            #[link(name = "resolv")]
            extern "C" {}
        } else if #[cfg(target_os = "fuchsia")] {
            #[link(name = "zircon")]
            #[link(name = "fdio")]
            extern "C" {}
        }
    }