src/libstd/sys/unix/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 #![allow(missing_docs, nonstandard_style)]
  12
  13 use io::{self, ErrorKind};
  14 use libc;
  15
  16 #[cfg(any(rustdoc, target_os = "linux"))] pub use os::linux as platform;
  17
  18 #[cfg(all(not(rustdoc), target_os = "android"))]   pub use os::android as platform;
  19 #[cfg(all(not(rustdoc), target_os = "bitrig"))]    pub use os::bitrig as platform;
  20 #[cfg(all(not(rustdoc), target_os = "dragonfly"))] pub use os::dragonfly as platform;
  21 #[cfg(all(not(rustdoc), target_os = "freebsd"))]   pub use os::freebsd as platform;
  22 #[cfg(all(not(rustdoc), target_os = "haiku"))]     pub use os::haiku as platform;
  23 #[cfg(all(not(rustdoc), target_os = "ios"))]       pub use os::ios as platform;
  24 #[cfg(all(not(rustdoc), target_os = "macos"))]     pub use os::macos as platform;
  25 #[cfg(all(not(rustdoc), target_os = "netbsd"))]    pub use os::netbsd as platform;
  26 #[cfg(all(not(rustdoc), target_os = "openbsd"))]   pub use os::openbsd as platform;
  27 #[cfg(all(not(rustdoc), target_os = "solaris"))]   pub use os::solaris as platform;
  28 #[cfg(all(not(rustdoc), target_os = "emscripten"))] pub use os::emscripten as platform;
  29 #[cfg(all(not(rustdoc), target_os = "fuchsia"))]   pub use os::fuchsia as platform;
  30 #[cfg(all(not(rustdoc), target_os = "l4re"))]      pub use os::linux as platform;
  31 #[cfg(all(not(rustdoc), target_os = "hermit"))]    pub use os::hermit as platform;
  32
  33 pub use self::rand::hashmap_random_keys;
  34 pub use libc::strlen;
  35
  36 #[macro_use]
  37 pub mod weak;
  38
  39 pub mod alloc;
  40 pub mod args;
  41 pub mod android;
  42 #[cfg(feature = "backtrace")]
  43 pub mod backtrace;
  44 pub mod cmath;
  45 pub mod condvar;
  46 pub mod env;
  47 pub mod ext;
  48 pub mod fast_thread_local;
  49 pub mod fd;
  50 pub mod fs;
  51 pub mod memchr;
  52 pub mod mutex;
  53 #[cfg(not(target_os = "l4re"))]
  54 pub mod net;
  55 #[cfg(target_os = "l4re")]
  56 mod l4re;
  57 #[cfg(target_os = "l4re")]
  58 pub use self::l4re::net;
  59 pub mod os;
  60 pub mod os_str;
  61 pub mod path;
  62 pub mod pipe;
  63 pub mod process;
  64 pub mod rand;
  65 pub mod rwlock;
  66 pub mod stack_overflow;
  67 pub mod thread;
  68 pub mod thread_local;
  69 pub mod time;
  70 pub mod stdio;
  71
  72 #[cfg(not(test))]
  73 pub fn init() {
  74     // By default, some platforms will send a *signal* when an EPIPE error
  75     // would otherwise be delivered. This runtime doesn't install a SIGPIPE
  76     // handler, causing it to kill the program, which isn't exactly what we
  77     // want!
  78     //
  79     // Hence, we set SIGPIPE to ignore when the program starts up in order
  80     // to prevent this problem.
  81     unsafe {
  82         reset_sigpipe();
  83     }
  84
  85     #[cfg(not(any(target_os = "emscripten", target_os = "fuchsia")))]
  86     unsafe fn reset_sigpipe() {
  87         assert!(signal(libc::SIGPIPE, libc::SIG_IGN) != libc::SIG_ERR);
  88     }
  89     #[cfg(any(target_os = "emscripten", target_os = "fuchsia"))]
  90     unsafe fn reset_sigpipe() {}
  91 }
  92
  93 #[cfg(target_os = "android")]
  94 pub use sys::android::signal;
  95 #[cfg(not(target_os = "android"))]
  96 pub use libc::signal;
  97
  98 pub fn decode_error_kind(errno: i32) -> ErrorKind {
  99     match errno as libc::c_int {
 100         libc::ECONNREFUSED => ErrorKind::ConnectionRefused,
 101         libc::ECONNRESET => ErrorKind::ConnectionReset,
 102         libc::EPERM | libc::EACCES => ErrorKind::PermissionDenied,
 103         libc::EPIPE => ErrorKind::BrokenPipe,
 104         libc::ENOTCONN => ErrorKind::NotConnected,
 105         libc::ECONNABORTED => ErrorKind::ConnectionAborted,
 106         libc::EADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
 107         libc::EADDRINUSE => ErrorKind::AddrInUse,
 108         libc::ENOENT => ErrorKind::NotFound,
 109         libc::EINTR => ErrorKind::Interrupted,
 110         libc::EINVAL => ErrorKind::InvalidInput,
 111         libc::ETIMEDOUT => ErrorKind::TimedOut,
 112         libc::EEXIST => ErrorKind::AlreadyExists,
 113
 114         // These two constants can have the same value on some systems,
 115         // but different values on others, so we can't use a match
 116         // clause
 117         x if x == libc::EAGAIN || x == libc::EWOULDBLOCK =>
 118             ErrorKind::WouldBlock,
 119
 120         _ => ErrorKind::Other,
 121     }
 122 }
 123
 124 #[doc(hidden)]
 125 pub trait IsMinusOne {
 126     fn is_minus_one(&self) -> bool;
 127 }
 128
 129 macro_rules! impl_is_minus_one {
 130     ($($t:ident)*) => ($(impl IsMinusOne for $t {
 131         fn is_minus_one(&self) -> bool {
 132             *self == -1
 133         }
 134     })*)
 135 }
 136
 137 impl_is_minus_one! { i8 i16 i32 i64 isize }
 138
 139 pub fn cvt<T: IsMinusOne>(t: T) -> io::Result<T> {
 140     if t.is_minus_one() {
 141         Err(io::Error::last_os_error())
 142     } else {
 143         Ok(t)
 144     }
 145 }
 146
 147 pub fn cvt_r<T, F>(mut f: F) -> io::Result<T>
 148     where T: IsMinusOne,
 149           F: FnMut() -> T
 150 {
 151     loop {
 152         match cvt(f()) {
 153             Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
 154             other => return other,
 155         }
 156     }
 157 }
 158
 159 // On Unix-like platforms, libc::abort will unregister signal handlers
 160 // including the SIGABRT handler, preventing the abort from being blocked, and
 161 // fclose streams, with the side effect of flushing them so libc bufferred
 162 // output will be printed.  Additionally the shell will generally print a more
 163 // understandable error message like "Abort trap" rather than "Illegal
 164 // instruction" that intrinsics::abort would cause, as intrinsics::abort is
 165 // implemented as an illegal instruction.
 166 pub unsafe fn abort_internal() -> ! {
 167     ::libc::abort()
 168 }