yash_env/system/

real.rs

// This file is part of yash, an extended POSIX shell.
// Copyright (C) 2021 WATANABE Yuki
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! Implementation of system traits that actually interacts with the underlying system
//!
//! This module is implemented on Unix-like targets only. It provides [`RealSystem`],
//! an implementation of system traits that interact with the underlying
//! operating system. This implementation is intended to be used for the actual
//! shell environment.

mod errno;
mod fd_set;
mod file_system;
mod open_flag;
mod resource;
mod signal;

use super::AT_FDCWD;
use super::CaughtSignals;
use super::Chdir;
use super::Clock;
use super::Close;
use super::CpuTimes;
use super::Dir;
use super::DirEntry;
use super::Disposition;
use super::Dup;
use super::Errno;
use super::Exec;
use super::Exit;
use super::Fcntl;
use super::FdFlag;
use super::Fork;
use super::Fstat;
use super::GetCwd;
use super::GetPid;
use super::GetPw;
use super::GetRlimit;
use super::GetSigaction;
use super::GetUid;
use super::Gid;
use super::IsExecutableFile;
use super::Isatty;
use super::Mode;
use super::OfdAccess;
use super::Open;
use super::OpenFlag;
use super::Pipe;
use super::Read;
use super::Result;
use super::Seek;
use super::Select;
use super::SendSignal;
use super::SetPgid;
use super::SetRlimit;
use super::ShellPath;
use super::Sigaction;
use super::Sigmask;
use super::SigmaskOp;
use super::Signals;
use super::Stat as _;
use super::Sysconf;
use super::TcGetPgrp;
use super::TcSetPgrp;
use super::Times;
use super::Uid;
use super::Umask;
use super::Wait;
use super::Write;
use super::c_string::{AsCStrArray as _, IntoCStrArray};
use super::resource::LimitPair;
use super::resource::Resource;
#[cfg(doc)]
use crate::Env;
use crate::io::Fd;
use crate::job::Pid;
use crate::job::ProcessResult;
use crate::job::ProcessState;
use crate::path::Path;
use crate::path::PathBuf;
use crate::semantics::ExitStatus;
use crate::str::UnixStr;
use crate::str::UnixString;
use enumset::EnumSet;
pub use fd_set::FdSet;
pub use file_system::Stat;
use libc::DIR;
pub use signal::Sigset;
use std::convert::Infallible;
use std::convert::TryInto as _;
use std::ffi::CStr;
use std::ffi::CString;
use std::ffi::OsStr;
use std::ffi::c_int;
use std::future::ready;
use std::io::SeekFrom;
use std::mem::MaybeUninit;
use std::num::NonZero;
use std::ops::RangeInclusive;
use std::os::unix::ffi::OsStrExt as _;
use std::os::unix::io::IntoRawFd as _;
use std::pin::pin;
use std::ptr::NonNull;
use std::sync::atomic::AtomicIsize;
use std::sync::atomic::Ordering;
use std::sync::atomic::compiler_fence;
use std::task::Context;
use std::task::Waker;
use std::time::Duration;
use std::time::Instant;

trait ErrnoIfM1: PartialEq + Sized {
    const MINUS_1: Self;

    /// Convenience function to convert a result of -1 to an `Error` with the
    /// current `errno`.
    ///
    /// This function is intended to be used just after calling a function that
    /// returns -1 on error and sets `errno` to the error number. This function
    /// filters out the `-1` result and returns an error containing the current
    /// `errno`.
    fn errno_if_m1(self) -> Result<Self> {
        if self == Self::MINUS_1 {
            Err(Errno::last())
        } else {
            Ok(self)
        }
    }
}

impl ErrnoIfM1 for i8 {
    const MINUS_1: Self = -1;
}
impl ErrnoIfM1 for i16 {
    const MINUS_1: Self = -1;
}
impl ErrnoIfM1 for i32 {
    const MINUS_1: Self = -1;
}
impl ErrnoIfM1 for i64 {
    const MINUS_1: Self = -1;
}
impl ErrnoIfM1 for isize {
    const MINUS_1: Self = -1;
}

/// Converts a `Duration` to a `timespec`.
///
/// The return value is a `MaybeUninit` because the `timespec` struct may have
/// padding or extension fields that are not initialized by this function.
#[must_use]
fn to_timespec(duration: Duration) -> MaybeUninit<libc::timespec> {
    let seconds = duration.as_secs().try_into().unwrap_or(libc::time_t::MAX);
    let mut timespec = MaybeUninit::<libc::timespec>::uninit();
    unsafe {
        (&raw mut (*timespec.as_mut_ptr()).tv_sec).write(seconds);
        (&raw mut (*timespec.as_mut_ptr()).tv_nsec).write(duration.subsec_nanos() as _);
    }
    timespec
}

/// Array of slots to store caught signals.
///
/// This array is used to store caught signals. All slots are initialized with
/// 0, which indicates that the slot is available. When a signal is caught, the
/// signal number is written into one of unoccupied slots.
static CAUGHT_SIGNALS: [AtomicIsize; 8] = [const { AtomicIsize::new(0) }; 8];

/// Signal catching function.
///
/// This function is set as a signal handler for all signals that the shell
/// wants to catch. When a signal is caught, the signal number is written into
/// one of the slots in [`CAUGHT_SIGNALS`].
extern "C" fn catch_signal(signal: c_int) {
    // This function can only perform async-signal-safe operations.
    // Performing unsafe operations is undefined behavior!

    // Find an unused slot (having a value of 0) in CAUGHT_SIGNALS and write the
    // signal number into it.
    // If there is a slot having a value of the signal already, do nothing.
    // If there is no available slot, the signal will be lost!
    let signal = signal as isize;
    for slot in &CAUGHT_SIGNALS {
        match slot.compare_exchange(0, signal, Ordering::Relaxed, Ordering::Relaxed) {
            Ok(_) => break,
            Err(slot_value) if slot_value == signal => break,
            _ => continue,
        }
    }
}

fn sigaction_impl(signal: signal::Number, disposition: Option<Disposition>) -> Result<Disposition> {
    let new_action = disposition.map(Disposition::to_sigaction);
    let new_action_ptr = new_action
        .as_ref()
        .map_or(std::ptr::null(), |action| action.as_ptr());

    let mut old_action = MaybeUninit::<libc::sigaction>::uninit();
    // SAFETY: We're just creating a new raw pointer to the struct field.
    // Nothing is dereferenced.
    let old_mask_ptr = unsafe { &raw mut (*old_action.as_mut_ptr()).sa_mask };
    // POSIX requires *all* sigset_t objects to be initialized before use,
    // even if they are output parameters.
    unsafe { libc::sigemptyset(old_mask_ptr) }.errno_if_m1()?;

    unsafe { libc::sigaction(signal.as_raw(), new_action_ptr, old_action.as_mut_ptr()) }
        .errno_if_m1()?;

    // SAFETY: the `old_action` has been initialized by `sigaction`.
    let old_disposition = unsafe { Disposition::from_sigaction(&old_action) };
    Ok(old_disposition)
}

/// Implementation of system traits that actually interact with the underlying system
///
/// `RealSystem` is an empty `struct` because the underlying operating system
/// manages the system's internal state.
///
/// Some trait methods implemented by `RealSystem` (such as [`SendSignal::kill`])
/// return futures, but the returned futures do not perform asynchronous operations.
/// Those methods block the current thread until the underlying system calls
/// complete and then return ready futures.
/// See also the [`system` module](super) documentation.
#[derive(Debug)]
pub struct RealSystem(());

impl RealSystem {
    /// Returns an instance of `RealSystem`.
    ///
    /// # Safety
    ///
    /// This function is marked `unsafe` because improper use of `RealSystem`
    /// may lead to undefined behavior. Remember that most operations performed
    /// on the system by [`Env`] are not thread-safe. You should never use
    /// `RealSystem` in a multi-threaded program, and it is your responsibility
    /// to make sure you are using only one instance of `ReadSystem` in the
    /// process.
    pub unsafe fn new() -> Self {
        RealSystem(())
    }

    // TODO Should use AT_EACCESS on all platforms
    #[cfg(not(target_os = "redox"))]
    fn has_execute_permission(&self, path: &CStr) -> bool {
        (unsafe { libc::faccessat(libc::AT_FDCWD, path.as_ptr(), libc::X_OK, libc::AT_EACCESS) })
            != -1
    }
    #[cfg(target_os = "redox")]
    fn has_execute_permission(&self, path: &CStr) -> bool {
        (unsafe { libc::access(path.as_ptr(), libc::X_OK) }) != -1
    }
}

impl Fstat for RealSystem {
    type Stat = file_system::Stat;

    fn fstat(&self, fd: Fd) -> Result<file_system::Stat> {
        let mut stat = MaybeUninit::<libc::stat>::uninit();
        unsafe { libc::fstat(fd.0, stat.as_mut_ptr()) }.errno_if_m1()?;
        let stat = unsafe { file_system::Stat::from_raw(stat) };
        Ok(stat)
    }

    fn fstatat(&self, dir_fd: Fd, path: &CStr, follow_symlinks: bool) -> Result<file_system::Stat> {
        let flags = if follow_symlinks {
            0
        } else {
            libc::AT_SYMLINK_NOFOLLOW
        };

        let mut stat = MaybeUninit::<libc::stat>::uninit();
        unsafe { libc::fstatat(dir_fd.0, path.as_ptr(), stat.as_mut_ptr(), flags) }
            .errno_if_m1()?;
        let stat = unsafe { file_system::Stat::from_raw(stat) };
        Ok(stat)
    }
}

impl IsExecutableFile for RealSystem {
    fn is_executable_file(&self, path: &CStr) -> bool {
        self.fstatat(AT_FDCWD, path, true)
            .is_ok_and(|stat| stat.is_regular_file())
            && self.has_execute_permission(path)
    }
}

impl Pipe for RealSystem {
    fn pipe(&self) -> Result<(Fd, Fd)> {
        let mut fds = MaybeUninit::<[c_int; 2]>::uninit();
        // TODO Use as_mut_ptr rather than cast when array_ptr_get is stabilized
        unsafe { libc::pipe(fds.as_mut_ptr().cast()) }.errno_if_m1()?;
        let fds = unsafe { fds.assume_init() };
        Ok((Fd(fds[0]), Fd(fds[1])))
    }
}

impl Dup for RealSystem {
    fn dup(&self, from: Fd, to_min: Fd, flags: EnumSet<FdFlag>) -> Result<Fd> {
        let command = if flags.contains(FdFlag::CloseOnExec) {
            libc::F_DUPFD_CLOEXEC
        } else {
            libc::F_DUPFD
        };
        unsafe { libc::fcntl(from.0, command, to_min.0) }
            .errno_if_m1()
            .map(Fd)
    }

    fn dup2(&self, from: Fd, to: Fd) -> Result<Fd> {
        loop {
            let result = unsafe { libc::dup2(from.0, to.0) }.errno_if_m1().map(Fd);
            if result != Err(Errno::EINTR) {
                return result;
            }
        }
    }
}

impl Open for RealSystem {
    fn open(
        &self,
        path: &CStr,
        access: OfdAccess,
        flags: EnumSet<OpenFlag>,
        mode: Mode,
    ) -> impl Future<Output = Result<Fd>> + use<> {
        ready((|| {
            let mut raw_flags = access.to_real_flag().ok_or(Errno::EINVAL)?;
            for flag in flags {
                raw_flags |= flag.to_real_flag().ok_or(Errno::EINVAL)?;
            }

            // Rust does not perform default argument promotion for C variadic
            // functions, so we need to promote manually.
            #[cfg(not(target_os = "redox"))]
            let mode_bits = mode.bits() as std::ffi::c_uint;
            #[cfg(target_os = "redox")]
            let mode_bits = mode.bits() as c_int;

            let result = unsafe { libc::open(path.as_ptr(), raw_flags, mode_bits) };
            result.errno_if_m1().map(Fd)
        })())
    }

    fn open_tmpfile(&self, parent_dir: &Path) -> Result<Fd> {
        let parent_dir = OsStr::from_bytes(parent_dir.as_unix_str().as_bytes());
        let file = tempfile::tempfile_in(parent_dir)
            .map_err(|errno| Errno(errno.raw_os_error().unwrap_or(0)))?;
        let fd = Fd(file.into_raw_fd());

        // Clear the CLOEXEC flag
        _ = self.fcntl_setfd(fd, EnumSet::empty());

        Ok(fd)
    }

    fn fdopendir(&self, fd: Fd) -> Result<impl Dir + use<>> {
        let dir = unsafe { libc::fdopendir(fd.0) };
        let dir = NonNull::new(dir).ok_or_else(Errno::last)?;
        Ok(RealDir(dir))
    }

    fn opendir(&self, path: &CStr) -> Result<impl Dir + use<>> {
        let dir = unsafe { libc::opendir(path.as_ptr()) };
        let dir = NonNull::new(dir).ok_or_else(Errno::last)?;
        Ok(RealDir(dir))
    }
}

impl Close for RealSystem {
    fn close(&self, fd: Fd) -> Result<()> {
        // TODO: Use posix_close when available
        loop {
            let result = unsafe { libc::close(fd.0) }.errno_if_m1().map(drop);
            match result {
                Err(Errno::EBADF) => return Ok(()),
                Err(Errno::EINTR) => continue,
                other => return other,
            }
        }
    }
}

impl Fcntl for RealSystem {
    fn ofd_access(&self, fd: Fd) -> Result<OfdAccess> {
        let flags = unsafe { libc::fcntl(fd.0, libc::F_GETFL) }.errno_if_m1()?;
        Ok(OfdAccess::from_real_flag(flags))
    }

    fn get_and_set_nonblocking(&self, fd: Fd, nonblocking: bool) -> Result<bool> {
        let old_flags = unsafe { libc::fcntl(fd.0, libc::F_GETFL) }.errno_if_m1()?;
        let new_flags = if nonblocking {
            old_flags | libc::O_NONBLOCK
        } else {
            old_flags & !libc::O_NONBLOCK
        };
        if new_flags != old_flags {
            unsafe { libc::fcntl(fd.0, libc::F_SETFL, new_flags) }.errno_if_m1()?;
        }
        let was_nonblocking = old_flags & libc::O_NONBLOCK != 0;
        Ok(was_nonblocking)
    }

    fn fcntl_getfd(&self, fd: Fd) -> Result<EnumSet<FdFlag>> {
        let bits = unsafe { libc::fcntl(fd.0, libc::F_GETFD) }.errno_if_m1()?;
        let mut flags = EnumSet::empty();
        if bits & libc::FD_CLOEXEC != 0 {
            flags.insert(FdFlag::CloseOnExec);
        }
        Ok(flags)
    }

    fn fcntl_setfd(&self, fd: Fd, flags: EnumSet<FdFlag>) -> Result<()> {
        let mut bits = 0 as c_int;
        if flags.contains(FdFlag::CloseOnExec) {
            bits |= libc::FD_CLOEXEC;
        }
        unsafe { libc::fcntl(fd.0, libc::F_SETFD, bits) }
            .errno_if_m1()
            .map(drop)
    }
}

impl Read for RealSystem {
    /// Reads data from the file descriptor into the buffer.
    fn read<'a>(
        &self,
        fd: Fd,
        buffer: &'a mut [u8],
    ) -> impl Future<Output = Result<usize>> + use<'a> {
        let result =
            unsafe { libc::read(fd.0, buffer.as_mut_ptr().cast(), buffer.len()) }.errno_if_m1();
        ready(result.map(|len| len.try_into().unwrap()))
    }
}

impl Write for RealSystem {
    /// Writes data from the buffer to the file descriptor.
    fn write<'a>(&self, fd: Fd, buffer: &'a [u8]) -> impl Future<Output = Result<usize>> + use<'a> {
        let result =
            unsafe { libc::write(fd.0, buffer.as_ptr().cast(), buffer.len()) }.errno_if_m1();
        ready(result.map(|len| len.try_into().unwrap()))
    }
}

impl Seek for RealSystem {
    fn lseek(&self, fd: Fd, position: SeekFrom) -> Result<u64> {
        let (offset, whence) = match position {
            SeekFrom::Start(offset) => {
                let offset = offset.try_into().map_err(|_| Errno::EOVERFLOW)?;
                (offset, libc::SEEK_SET)
            }
            SeekFrom::End(offset) => (offset, libc::SEEK_END),
            SeekFrom::Current(offset) => (offset, libc::SEEK_CUR),
        };
        let new_offset = unsafe { libc::lseek(fd.0, offset, whence) }.errno_if_m1()?;
        Ok(new_offset.try_into().unwrap())
    }
}

impl Umask for RealSystem {
    fn umask(&self, new_mask: Mode) -> Mode {
        Mode::from_bits_retain(unsafe { libc::umask(new_mask.bits()) })
    }
}

impl GetCwd for RealSystem {
    fn getcwd(&self) -> Result<PathBuf> {
        // Some getcwd implementations allocate a buffer for the path if the
        // first argument is null, but we cannot use that feature because Vec's
        // allocator may not be compatible with the system's allocator.

        // Since there is no way to know the required buffer size, we try
        // several buffer sizes.
        let mut buffer = Vec::<u8>::new();
        for capacity in [1 << 10, 1 << 12, 1 << 14, 1 << 16] {
            buffer.reserve_exact(capacity);

            let result = unsafe { libc::getcwd(buffer.as_mut_ptr().cast(), capacity) };
            if !result.is_null() {
                // len does not include the null terminator
                let len = unsafe { CStr::from_ptr(buffer.as_ptr().cast()) }.count_bytes();
                unsafe { buffer.set_len(len) }
                buffer.shrink_to_fit();
                return Ok(PathBuf::from(UnixString::from_vec(buffer)));
            }
            let errno = Errno::last();
            if errno != Errno::ERANGE {
                return Err(errno);
            }
        }
        Err(Errno::ERANGE)
    }
}

impl Chdir for RealSystem {
    fn chdir(&self, path: &CStr) -> Result<()> {
        let result = unsafe { libc::chdir(path.as_ptr()) };
        result.errno_if_m1().map(drop)
    }
}

impl Clock for RealSystem {
    fn now(&self) -> Instant {
        Instant::now()
    }
}

impl Times for RealSystem {
    /// Returns consumed CPU times.
    ///
    /// This function actually uses `getrusage` rather than `times` because it
    /// provides better resolution on many systems.
    fn times(&self) -> Result<CpuTimes> {
        let mut usage = MaybeUninit::<libc::rusage>::uninit();

        unsafe { libc::getrusage(libc::RUSAGE_SELF, usage.as_mut_ptr()) }.errno_if_m1()?;
        let self_user = unsafe {
            (*usage.as_ptr()).ru_utime.tv_sec as f64
                + (*usage.as_ptr()).ru_utime.tv_usec as f64 * 1e-6
        };
        let self_system = unsafe {
            (*usage.as_ptr()).ru_stime.tv_sec as f64
                + (*usage.as_ptr()).ru_stime.tv_usec as f64 * 1e-6
        };

        unsafe { libc::getrusage(libc::RUSAGE_CHILDREN, usage.as_mut_ptr()) }.errno_if_m1()?;
        let children_user = unsafe {
            (*usage.as_ptr()).ru_utime.tv_sec as f64
                + (*usage.as_ptr()).ru_utime.tv_usec as f64 * 1e-6
        };
        let children_system = unsafe {
            (*usage.as_ptr()).ru_stime.tv_sec as f64
                + (*usage.as_ptr()).ru_stime.tv_usec as f64 * 1e-6
        };

        Ok(CpuTimes {
            self_user,
            self_system,
            children_user,
            children_system,
        })
    }
}

impl GetPid for RealSystem {
    fn getsid(&self, pid: Pid) -> Result<Pid> {
        unsafe { libc::getsid(pid.0) }.errno_if_m1().map(Pid)
    }

    fn getpid(&self) -> Pid {
        Pid(unsafe { libc::getpid() })
    }

    fn getppid(&self) -> Pid {
        Pid(unsafe { libc::getppid() })
    }

    fn getpgrp(&self) -> Pid {
        Pid(unsafe { libc::getpgrp() })
    }
}

impl SetPgid for RealSystem {
    fn setpgid(&self, pid: Pid, pgid: Pid) -> Result<()> {
        let result = unsafe { libc::setpgid(pid.0, pgid.0) };
        result.errno_if_m1().map(drop)
    }
}

const fn to_signal_number(sig: c_int) -> signal::Number {
    signal::Number::from_raw_unchecked(NonZero::new(sig).unwrap())
}

impl Signals for RealSystem {
    const SIGABRT: signal::Number = to_signal_number(libc::SIGABRT);
    const SIGALRM: signal::Number = to_signal_number(libc::SIGALRM);
    const SIGBUS: signal::Number = to_signal_number(libc::SIGBUS);
    const SIGCHLD: signal::Number = to_signal_number(libc::SIGCHLD);
    #[cfg(any(
        target_os = "aix",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "solaris",
    ))]
    const SIGCLD: Option<signal::Number> = Some(to_signal_number(libc::SIGCLD));
    #[cfg(not(any(
        target_os = "aix",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "solaris",
    )))]
    const SIGCLD: Option<signal::Number> = None;
    const SIGCONT: signal::Number = to_signal_number(libc::SIGCONT);
    #[cfg(not(any(
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "linux",
        target_os = "redox",
    )))]
    const SIGEMT: Option<signal::Number> = Some(to_signal_number(libc::SIGEMT));
    #[cfg(any(
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "linux",
        target_os = "redox",
    ))]
    const SIGEMT: Option<signal::Number> = None;
    const SIGFPE: signal::Number = to_signal_number(libc::SIGFPE);
    const SIGHUP: signal::Number = to_signal_number(libc::SIGHUP);
    const SIGILL: signal::Number = to_signal_number(libc::SIGILL);
    #[cfg(not(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "linux",
        target_os = "redox",
    )))]
    const SIGINFO: Option<signal::Number> = Some(to_signal_number(libc::SIGINFO));
    #[cfg(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "linux",
        target_os = "redox",
    ))]
    const SIGINFO: Option<signal::Number> = None;
    const SIGINT: signal::Number = to_signal_number(libc::SIGINT);
    #[cfg(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "solaris",
    ))]
    const SIGIO: Option<signal::Number> = Some(to_signal_number(libc::SIGIO));
    #[cfg(not(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "solaris",
    )))]
    const SIGIO: Option<signal::Number> = None;
    const SIGIOT: signal::Number = to_signal_number(libc::SIGIOT);
    const SIGKILL: signal::Number = to_signal_number(libc::SIGKILL);
    #[cfg(target_os = "horizon")]
    const SIGLOST: Option<signal::Number> = Some(to_signal_number(libc::SIGLOST));
    #[cfg(not(target_os = "horizon"))]
    const SIGLOST: Option<signal::Number> = None;
    const SIGPIPE: signal::Number = to_signal_number(libc::SIGPIPE);
    #[cfg(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "solaris",
    ))]
    const SIGPOLL: Option<signal::Number> = Some(to_signal_number(libc::SIGPOLL));
    #[cfg(not(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "haiku",
        target_os = "horizon",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "solaris",
    )))]
    const SIGPOLL: Option<signal::Number> = None;
    const SIGPROF: signal::Number = to_signal_number(libc::SIGPROF);
    #[cfg(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "redox",
        target_os = "solaris",
    ))]
    const SIGPWR: Option<signal::Number> = Some(to_signal_number(libc::SIGPWR));
    #[cfg(not(any(
        target_os = "aix",
        target_os = "android",
        target_os = "emscripten",
        target_os = "fuchsia",
        target_os = "illumos",
        target_os = "linux",
        target_os = "nto",
        target_os = "redox",
        target_os = "solaris",
    )))]
    const SIGPWR: Option<signal::Number> = None;
    const SIGQUIT: signal::Number = to_signal_number(libc::SIGQUIT);
    const SIGSEGV: signal::Number = to_signal_number(libc::SIGSEGV);
    #[cfg(all(
        any(
            target_os = "android",
            target_os = "emscripten",
            target_os = "fuchsia",
            target_os = "linux"
        ),
        not(any(target_arch = "mips", target_arch = "mips64", target_arch = "sparc64"))
    ))]
    const SIGSTKFLT: Option<signal::Number> = Some(to_signal_number(libc::SIGSTKFLT));
    #[cfg(not(all(
        any(
            target_os = "android",
            target_os = "emscripten",
            target_os = "fuchsia",
            target_os = "linux"
        ),
        not(any(target_arch = "mips", target_arch = "mips64", target_arch = "sparc64"))
    )))]
    const SIGSTKFLT: Option<signal::Number> = None;
    const SIGSTOP: signal::Number = to_signal_number(libc::SIGSTOP);
    const SIGSYS: signal::Number = to_signal_number(libc::SIGSYS);
    const SIGTERM: signal::Number = to_signal_number(libc::SIGTERM);
    #[cfg(target_os = "freebsd")]
    const SIGTHR: Option<signal::Number> = Some(to_signal_number(libc::SIGTHR));
    #[cfg(not(target_os = "freebsd"))]
    const SIGTHR: Option<signal::Number> = None;
    const SIGTRAP: signal::Number = to_signal_number(libc::SIGTRAP);
    const SIGTSTP: signal::Number = to_signal_number(libc::SIGTSTP);
    const SIGTTIN: signal::Number = to_signal_number(libc::SIGTTIN);
    const SIGTTOU: signal::Number = to_signal_number(libc::SIGTTOU);
    const SIGURG: signal::Number = to_signal_number(libc::SIGURG);
    const SIGUSR1: signal::Number = to_signal_number(libc::SIGUSR1);
    const SIGUSR2: signal::Number = to_signal_number(libc::SIGUSR2);
    const SIGVTALRM: signal::Number = to_signal_number(libc::SIGVTALRM);
    const SIGWINCH: signal::Number = to_signal_number(libc::SIGWINCH);
    const SIGXCPU: signal::Number = to_signal_number(libc::SIGXCPU);
    const SIGXFSZ: signal::Number = to_signal_number(libc::SIGXFSZ);

    fn sigrt_range(&self) -> Option<RangeInclusive<signal::Number>> {
        let raw_range = signal::rt_range();
        let start = signal::Number::from_raw_unchecked(NonZero::new(*raw_range.start())?);
        let end = signal::Number::from_raw_unchecked(NonZero::new(*raw_range.end())?);
        Some(start..=end).filter(|range| !range.is_empty())
    }

    // TODO: Implement sig2str and str2sig methods
}

impl Sigmask for RealSystem {
    type Sigset = Sigset;

    fn sigmask(
        &self,
        op: Option<(SigmaskOp, &Sigset)>,
        old_mask: Option<&mut Sigset>,
    ) -> impl Future<Output = Result<()>> + use<> {
        ready(unsafe {
            let (how, raw_mask) = match op {
                None => (libc::SIG_BLOCK, std::ptr::null()),
                Some((op, mask)) => {
                    let how = match op {
                        SigmaskOp::Add => libc::SIG_BLOCK,
                        SigmaskOp::Remove => libc::SIG_UNBLOCK,
                        SigmaskOp::Set => libc::SIG_SETMASK,
                    };
                    (how, mask.0.as_ptr())
                }
            };
            let raw_old_mask =
                old_mask.map_or(std::ptr::null_mut(), |old_mask| old_mask.0.as_mut_ptr());

            libc::sigprocmask(how, raw_mask, raw_old_mask)
                .errno_if_m1()
                .map(drop)
        })
    }
}

impl GetSigaction for RealSystem {
    fn get_sigaction(&self, signal: signal::Number) -> Result<Disposition> {
        sigaction_impl(signal, None)
    }
}

impl Sigaction for RealSystem {
    fn sigaction(&self, signal: signal::Number, handling: Disposition) -> Result<Disposition> {
        sigaction_impl(signal, Some(handling))
    }
}

impl CaughtSignals for RealSystem {
    fn caught_signals(&self) -> Vec<signal::Number> {
        let mut signals = Vec::new();
        for slot in &CAUGHT_SIGNALS {
            // Need a fence to ensure we examine the slots in order.
            compiler_fence(Ordering::Acquire);

            let number = slot.swap(0, Ordering::Relaxed);
            let Some(number) = NonZero::new(number as signal::RawNumber) else {
                // The `catch_signal` function always fills the first unused
                // slot, so there is no more slot filled with a signal.
                break;
            };
            signals.push(signal::Number::from_raw_unchecked(number));
        }
        signals
    }
}

impl SendSignal for RealSystem {
    fn kill(
        &self,
        target: Pid,
        signal: Option<signal::Number>,
    ) -> impl Future<Output = Result<()>> + use<> {
        let raw = signal.map_or(0, signal::Number::as_raw);
        let result = unsafe { libc::kill(target.0, raw) }.errno_if_m1().map(drop);
        ready(result)
    }

    fn raise(&self, signal: signal::Number) -> impl Future<Output = Result<()>> + use<> {
        let raw = signal.as_raw();
        let result = unsafe { libc::raise(raw) }.errno_if_m1().map(drop);
        ready(result)
    }
}

impl Select for RealSystem {
    type FdSet = FdSet;

    fn select<'a>(
        &self,
        readers: &'a mut FdSet,
        writers: &'a mut FdSet,
        timeout: Option<Duration>,
        signal_mask: Option<&Sigset>,
    ) -> impl Future<Output = Result<c_int>> + use<'a> {
        ready({
            use std::ptr::{null, null_mut};

            let upper_bound = readers.upper_bound().max(writers.upper_bound());
            let readers_ptr = readers.as_mut_ptr();
            let writers_ptr = writers.as_mut_ptr();
            let errors = null_mut();

            let timeout_spec = timeout.map(to_timespec);
            let timeout_ptr = timeout_spec.as_ref().map_or(null(), |spec| spec.as_ptr());

            let raw_mask_ptr = signal_mask.map_or(null(), |mask| mask.0.as_ptr());

            unsafe {
                libc::pselect(
                    upper_bound.0,
                    readers_ptr,
                    writers_ptr,
                    errors,
                    timeout_ptr,
                    raw_mask_ptr,
                )
            }
            .errno_if_m1()
        })
    }
}

impl Isatty for RealSystem {
    fn isatty(&self, fd: Fd) -> bool {
        (unsafe { libc::isatty(fd.0) } != 0)
    }
}

impl TcGetPgrp for RealSystem {
    fn tcgetpgrp(&self, fd: Fd) -> Result<Pid> {
        unsafe { libc::tcgetpgrp(fd.0) }.errno_if_m1().map(Pid)
    }
}

impl TcSetPgrp for RealSystem {
    fn tcsetpgrp(&self, fd: Fd, pgid: Pid) -> impl Future<Output = Result<()>> + use<> {
        let result = unsafe { libc::tcsetpgrp(fd.0, pgid.0) };
        ready(result.errno_if_m1().map(drop))
    }
}

impl Fork for RealSystem {
    /// Runs a task in a new child process.
    ///
    /// This implementation calls the `fork` system call to create a new
    /// process. The child task must run to completion without returning
    /// `Poll::Pending` and terminate the process by calling
    /// [`RealSystem::exit`] or signaling itself. If a [`Future::poll`] call
    /// for the child task returns, the child process will panic.
    fn run_in_child_process<D, F>(&self, shared_data: D, child_task: F) -> (Result<Pid>, D)
    where
        D: Clone + 'static,
        F: AsyncFnOnce(Self, D) + 'static,
    {
        match unsafe { libc::fork() }.errno_if_m1() {
            Ok(0) => {}                                            // Child process
            Ok(raw_pid) => return (Ok(Pid(raw_pid)), shared_data), // Parent process
            Err(e) => return (Err(e), shared_data),
        }

        // Child process
        let child_task = pin!(child_task(RealSystem(()), shared_data));
        let mut context = Context::from_waker(Waker::noop());
        _ = child_task.poll(&mut context);
        panic!("child task running in RealSystem should not return");
    }
}

impl Wait for RealSystem {
    fn wait(&self, target: Pid) -> Result<Option<(Pid, ProcessState)>> {
        let mut status = 0;
        let options = libc::WUNTRACED | libc::WCONTINUED | libc::WNOHANG;
        match unsafe { libc::waitpid(target.0, &mut status, options) } {
            -1 => Err(Errno::last()),
            0 => Ok(None),
            pid => {
                let state = if libc::WIFCONTINUED(status) {
                    ProcessState::Running
                } else if libc::WIFEXITED(status) {
                    let exit_status = libc::WEXITSTATUS(status);
                    ProcessState::exited(exit_status)
                } else if libc::WIFSIGNALED(status) {
                    let signal = libc::WTERMSIG(status);
                    let core_dump = libc::WCOREDUMP(status);
                    // SAFETY: The signal number is always a valid signal number, which is non-zero.
                    let raw_number = unsafe { NonZero::new_unchecked(signal) };
                    let signal = signal::Number::from_raw_unchecked(raw_number);
                    let process_result = ProcessResult::Signaled { signal, core_dump };
                    process_result.into()
                } else if libc::WIFSTOPPED(status) {
                    let signal = libc::WSTOPSIG(status);
                    // SAFETY: The signal number is always a valid signal number, which is non-zero.
                    let raw_number = unsafe { NonZero::new_unchecked(signal) };
                    let signal = signal::Number::from_raw_unchecked(raw_number);
                    ProcessState::stopped(signal)
                } else {
                    unreachable!()
                };
                Ok(Some((Pid(pid), state)))
            }
        }
    }
}

impl Exec for RealSystem {
    fn execve<A, E>(
        &self,
        path: &CStr,
        args: A,
        envs: E,
    ) -> impl Future<Output = Result<Infallible>> + use<A, E>
    where
        A: IntoCStrArray,
        E: IntoCStrArray,
    {
        let args = args.into_c_str_array();
        let envs = envs.into_c_str_array();
        loop {
            // SAFETY: `AsCStrArray::as_ptr` returns a pointer to a
            // null-terminated array of pointers to valid C-style strings, which
            // is exactly what `execve` expects. The strings remain valid because
            // `args` and `envs` are kept alive for the duration of the call.
            let _ = unsafe { libc::execve(path.as_ptr(), args.as_ptr(), envs.as_ptr()) };
            // TODO Uncomment when upgrading to libc 1.0
            // // `execve` requires mutable pointers in libc 1.0.
            // let _ = unsafe {
            //     libc::execve(path.as_ptr(), args.as_mut_ptr(), envs.as_mut_ptr())
            // };
            let errno = Errno::last();
            if errno != Errno::EINTR {
                return ready(Err(errno));
            }
        }
    }
}

impl Exit for RealSystem {
    fn exit(&self, exit_status: ExitStatus) -> impl Future<Output = Infallible> + use<> {
        (unsafe { libc::_exit(exit_status.0) }) as std::future::Ready<Infallible>
    }
}

impl GetUid for RealSystem {
    fn getuid(&self) -> Uid {
        Uid(unsafe { libc::getuid() })
    }

    fn geteuid(&self) -> Uid {
        Uid(unsafe { libc::geteuid() })
    }

    fn getgid(&self) -> Gid {
        Gid(unsafe { libc::getgid() })
    }

    fn getegid(&self) -> Gid {
        Gid(unsafe { libc::getegid() })
    }
}

impl GetPw for RealSystem {
    fn getpwnam_dir(&self, name: &CStr) -> Result<Option<PathBuf>> {
        Errno::clear();
        let passwd = unsafe { libc::getpwnam(name.as_ptr()) };
        if passwd.is_null() {
            let errno = Errno::last();
            return if errno == Errno::NO_ERROR {
                Ok(None)
            } else {
                Err(errno)
            };
        }

        let dir = unsafe { CStr::from_ptr((*passwd).pw_dir) };
        Ok(Some(UnixString::from_vec(dir.to_bytes().to_vec()).into()))
    }
}

impl Sysconf for RealSystem {
    fn confstr_path(&self) -> Result<UnixString> {
        // TODO Support other platforms
        cfg_select! {
            any(
                target_os = "linux",
                target_os = "macos",
                target_os = "ios",
                target_os = "tvos",
                target_os = "watchos"
            ) => {
                unsafe {
                    let size = libc::confstr(libc::_CS_PATH, std::ptr::null_mut(), 0);
                    if size == 0 {
                        return Err(Errno::last());
                    }
                    let mut buffer = Vec::<u8>::with_capacity(size);
                    let final_size =
                        libc::confstr(libc::_CS_PATH, buffer.as_mut_ptr() as *mut _, size);
                    if final_size == 0 {
                        return Err(Errno::last());
                    }
                    if final_size > size {
                        return Err(Errno::ERANGE);
                    }
                    buffer.set_len(final_size - 1); // The last byte is a null terminator.
                    Ok(UnixString::from_vec(buffer))
                }
            }

            _ => Err(Errno::ENOSYS),
        }
    }
}

impl ShellPath for RealSystem {
    /// Returns the path to the shell.
    ///
    /// On Linux, this function returns `/proc/self/exe`. On other platforms, it
    /// searches for an executable `sh` from the default PATH returned by
    /// [`confstr_path`](Self::confstr_path).
    fn shell_path(&self) -> CString {
        #[cfg(any(target_os = "linux", target_os = "android"))]
        if self.is_executable_file(c"/proc/self/exe") {
            return c"/proc/self/exe".to_owned();
        }
        // TODO Add optimization for other targets

        // Find an executable "sh" from the default PATH
        if let Ok(path) = self.confstr_path()
            && let Some(full_path) = path
                .as_bytes()
                .split(|b| *b == b':')
                .map(|dir| Path::new(UnixStr::from_bytes(dir)).join("sh"))
                .filter(|full_path| full_path.is_absolute())
                .filter_map(|full_path| CString::new(full_path.into_unix_string().into_vec()).ok())
                .find(|full_path| self.is_executable_file(full_path))
        {
            return full_path;
        }

        // The last resort
        c"/bin/sh".to_owned()
    }
}

impl GetRlimit for RealSystem {
    fn getrlimit(&self, resource: Resource) -> Result<LimitPair> {
        let raw_resource = resource.as_raw_type().ok_or(Errno::EINVAL)?;

        let mut limits = MaybeUninit::<libc::rlimit>::uninit();
        unsafe { libc::getrlimit(raw_resource as _, limits.as_mut_ptr()) }.errno_if_m1()?;

        // SAFETY: These two fields of `limits` have been initialized by `getrlimit`.
        // (But that does not mean *all* fields are initialized,
        // so we cannot use `assume_init` here.)
        Ok(LimitPair {
            soft: unsafe { (*limits.as_ptr()).rlim_cur },
            hard: unsafe { (*limits.as_ptr()).rlim_max },
        })
    }
}

impl SetRlimit for RealSystem {
    fn setrlimit(&self, resource: Resource, limits: LimitPair) -> Result<()> {
        let raw_resource = resource.as_raw_type().ok_or(Errno::EINVAL)?;

        let mut rlimit = MaybeUninit::<libc::rlimit>::uninit();
        unsafe {
            (&raw mut (*rlimit.as_mut_ptr()).rlim_cur).write(limits.soft);
            (&raw mut (*rlimit.as_mut_ptr()).rlim_max).write(limits.hard);
        }

        unsafe { libc::setrlimit(raw_resource as _, rlimit.as_ptr()) }.errno_if_m1()?;
        Ok(())
    }
}

/// Implementor of [`Dir`] that iterates on a real directory
#[derive(Debug)]
struct RealDir(NonNull<DIR>);

impl Drop for RealDir {
    fn drop(&mut self) {
        unsafe {
            libc::closedir(self.0.as_ptr());
        }
    }
}

impl Dir for RealDir {
    fn next(&mut self) -> Result<Option<DirEntry<'_>>> {
        Errno::clear();
        let entry = unsafe { libc::readdir(self.0.as_ptr()) };
        let errno = Errno::last();
        if entry.is_null() {
            if errno == Errno::NO_ERROR {
                Ok(None)
            } else {
                Err(errno)
            }
        } else {
            // TODO Use as_ptr rather than cast when array_ptr_get is stabilized
            let name = unsafe { CStr::from_ptr((&raw const (*entry).d_name).cast()) };
            let name = UnixStr::from_bytes(name.to_bytes());
            Ok(Some(DirEntry { name }))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn real_system_directory_entries() {
        let system = unsafe { RealSystem::new() };
        let mut dir = system.opendir(c".").unwrap();
        let mut count = 0;
        while dir.next().unwrap().is_some() {
            count += 1;
        }
        assert!(count > 0);
    }

    // This test depends on static variables.
    #[test]
    fn real_system_caught_signals() {
        unsafe {
            let system = RealSystem::new();
            let result = system.caught_signals();
            assert_eq!(result, []);

            catch_signal(libc::SIGINT);
            catch_signal(libc::SIGTERM);
            catch_signal(libc::SIGTERM);
            catch_signal(libc::SIGCHLD);

            let sigint = signal::Number::from_raw_unchecked(NonZero::new(libc::SIGINT).unwrap());
            let sigterm = signal::Number::from_raw_unchecked(NonZero::new(libc::SIGTERM).unwrap());
            let sigchld = signal::Number::from_raw_unchecked(NonZero::new(libc::SIGCHLD).unwrap());

            let result = system.caught_signals();
            assert_eq!(result, [sigint, sigterm, sigchld]);
            let result = system.caught_signals();
            assert_eq!(result, []);
        }
    }
}