library/std/src/sys/unix/process/process_unix.rs

   1 use crate::convert::{TryFrom, TryInto};
   2 use crate::fmt;
   3 use crate::io::{self, Error, ErrorKind};
   4 use crate::mem;
   5 use crate::num::NonZeroI32;
   6 use crate::os::raw::NonZero_c_int;
   7 use crate::ptr;
   8 use crate::sys;
   9 use crate::sys::cvt;
  10 use crate::sys::process::process_common::*;
  11
  12 #[cfg(target_os = "linux")]
  13 use crate::os::linux::process::PidFd;
  14
  15 #[cfg(target_os = "linux")]
  16 use crate::sys::weak::syscall;
  17
  18 #[cfg(any(
  19     target_os = "macos",
  20     target_os = "freebsd",
  21     all(target_os = "linux", target_env = "gnu"),
  22     all(target_os = "linux", target_env = "musl"),
  23 ))]
  24 use crate::sys::weak::weak;
  25
  26 #[cfg(target_os = "vxworks")]
  27 use libc::RTP_ID as pid_t;
  28
  29 #[cfg(not(target_os = "vxworks"))]
  30 use libc::{c_int, gid_t, pid_t, uid_t};
  31
  32 ////////////////////////////////////////////////////////////////////////////////
  33 // Command
  34 ////////////////////////////////////////////////////////////////////////////////
  35
  36 impl Command {
  37     pub fn spawn(
  38         &mut self,
  39         default: Stdio,
  40         needs_stdin: bool,
  41     ) -> io::Result<(Process, StdioPipes)> {
  42         const CLOEXEC_MSG_FOOTER: [u8; 4] = *b"NOEX";
  43
  44         let envp = self.capture_env();
  45
  46         if self.saw_nul() {
  47             return Err(io::Error::new_const(
  48                 ErrorKind::InvalidInput,
  49                 &"nul byte found in provided data",
  50             ));
  51         }
  52
  53         let (ours, theirs) = self.setup_io(default, needs_stdin)?;
  54
  55         if let Some(ret) = self.posix_spawn(&theirs, envp.as_ref())? {
  56             return Ok((ret, ours));
  57         }
  58
  59         let (input, output) = sys::pipe::anon_pipe()?;
  60
  61         // Whatever happens after the fork is almost for sure going to touch or
  62         // look at the environment in one way or another (PATH in `execvp` or
  63         // accessing the `environ` pointer ourselves). Make sure no other thread
  64         // is accessing the environment when we do the fork itself.
  65         //
  66         // Note that as soon as we're done with the fork there's no need to hold
  67         // a lock any more because the parent won't do anything and the child is
  68         // in its own process. Thus the parent drops the lock guard while the child
  69         // forgets it to avoid unlocking it on a new thread, which would be invalid.
  70         let env_lock = sys::os::env_read_lock();
  71         let (pid, pidfd) = unsafe { self.do_fork()? };
  72
  73         if pid == 0 {
  74             crate::panic::always_abort();
  75             mem::forget(env_lock);
  76             drop(input);
  77             let Err(err) = unsafe { self.do_exec(theirs, envp.as_ref()) };
  78             let errno = err.raw_os_error().unwrap_or(libc::EINVAL) as u32;
  79             let errno = errno.to_be_bytes();
  80             let bytes = [
  81                 errno[0],
  82                 errno[1],
  83                 errno[2],
  84                 errno[3],
  85                 CLOEXEC_MSG_FOOTER[0],
  86                 CLOEXEC_MSG_FOOTER[1],
  87                 CLOEXEC_MSG_FOOTER[2],
  88                 CLOEXEC_MSG_FOOTER[3],
  89             ];
  90             // pipe I/O up to PIPE_BUF bytes should be atomic, and then
  91             // we want to be sure we *don't* run at_exit destructors as
  92             // we're being torn down regardless
  93             rtassert!(output.write(&bytes).is_ok());
  94             unsafe { libc::_exit(1) }
  95         }
  96
  97         drop(env_lock);
  98         drop(output);
  99
 100         // Safety: We obtained the pidfd from calling `clone3` with
 101         // `CLONE_PIDFD` so it's valid an otherwise unowned.
 102         let mut p = unsafe { Process::new(pid, pidfd) };
 103         let mut bytes = [0; 8];
 104
 105         // loop to handle EINTR
 106         loop {
 107             match input.read(&mut bytes) {
 108                 Ok(0) => return Ok((p, ours)),
 109                 Ok(8) => {
 110                     let (errno, footer) = bytes.split_at(4);
 111                     assert_eq!(
 112                         CLOEXEC_MSG_FOOTER, footer,
 113                         "Validation on the CLOEXEC pipe failed: {:?}",
 114                         bytes
 115                     );
 116                     let errno = i32::from_be_bytes(errno.try_into().unwrap());
 117                     assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
 118                     return Err(Error::from_raw_os_error(errno));
 119                 }
 120                 Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
 121                 Err(e) => {
 122                     assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
 123                     panic!("the CLOEXEC pipe failed: {:?}", e)
 124                 }
 125                 Ok(..) => {
 126                     // pipe I/O up to PIPE_BUF bytes should be atomic
 127                     assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
 128                     panic!("short read on the CLOEXEC pipe")
 129                 }
 130             }
 131         }
 132     }
 133
 134     // Attempts to fork the process. If successful, returns Ok((0, -1))
 135     // in the child, and Ok((child_pid, -1)) in the parent.
 136     #[cfg(not(target_os = "linux"))]
 137     unsafe fn do_fork(&mut self) -> Result<(pid_t, pid_t), io::Error> {
 138         cvt(libc::fork()).map(|res| (res, -1))
 139     }
 140
 141     // Attempts to fork the process. If successful, returns Ok((0, -1))
 142     // in the child, and Ok((child_pid, child_pidfd)) in the parent.
 143     #[cfg(target_os = "linux")]
 144     unsafe fn do_fork(&mut self) -> Result<(pid_t, pid_t), io::Error> {
 145         use crate::sync::atomic::{AtomicBool, Ordering};
 146
 147         static HAS_CLONE3: AtomicBool = AtomicBool::new(true);
 148         const CLONE_PIDFD: u64 = 0x00001000;
 149
 150         #[repr(C)]
 151         struct clone_args {
 152             flags: u64,
 153             pidfd: u64,
 154             child_tid: u64,
 155             parent_tid: u64,
 156             exit_signal: u64,
 157             stack: u64,
 158             stack_size: u64,
 159             tls: u64,
 160             set_tid: u64,
 161             set_tid_size: u64,
 162             cgroup: u64,
 163         }
 164
 165         syscall! {
 166             fn clone3(cl_args: *mut clone_args, len: libc::size_t) -> libc::c_long
 167         }
 168
 169         // If we fail to create a pidfd for any reason, this will
 170         // stay as -1, which indicates an error.
 171         let mut pidfd: pid_t = -1;
 172
 173         // Attempt to use the `clone3` syscall, which supports more arguments
 174         // (in particular, the ability to create a pidfd). If this fails,
 175         // we will fall through this block to a call to `fork()`
 176         if HAS_CLONE3.load(Ordering::Relaxed) {
 177             let mut flags = 0;
 178             if self.get_create_pidfd() {
 179                 flags |= CLONE_PIDFD;
 180             }
 181
 182             let mut args = clone_args {
 183                 flags,
 184                 pidfd: &mut pidfd as *mut pid_t as u64,
 185                 child_tid: 0,
 186                 parent_tid: 0,
 187                 exit_signal: libc::SIGCHLD as u64,
 188                 stack: 0,
 189                 stack_size: 0,
 190                 tls: 0,
 191                 set_tid: 0,
 192                 set_tid_size: 0,
 193                 cgroup: 0,
 194             };
 195
 196             let args_ptr = &mut args as *mut clone_args;
 197             let args_size = crate::mem::size_of::<clone_args>();
 198
 199             let res = cvt(clone3(args_ptr, args_size));
 200             match res {
 201                 Ok(n) => return Ok((n as pid_t, pidfd)),
 202                 Err(e) => match e.raw_os_error() {
 203                     // Multiple threads can race to execute this store,
 204                     // but that's fine - that just means that multiple threads
 205                     // will have tried and failed to execute the same syscall,
 206                     // with no other side effects.
 207                     Some(libc::ENOSYS) => HAS_CLONE3.store(false, Ordering::Relaxed),
 208                     // Fallback to fork if `EPERM` is returned. (e.g. blocked by seccomp)
 209                     Some(libc::EPERM) => {}
 210                     _ => return Err(e),
 211                 },
 212             }
 213         }
 214
 215         // If we get here, the 'clone3' syscall does not exist
 216         // or we do not have permission to call it
 217         cvt(libc::fork()).map(|res| (res, pidfd))
 218     }
 219
 220     pub fn exec(&mut self, default: Stdio) -> io::Error {
 221         let envp = self.capture_env();
 222
 223         if self.saw_nul() {
 224             return io::Error::new_const(
 225                 ErrorKind::InvalidInput,
 226                 &"nul byte found in provided data",
 227             );
 228         }
 229
 230         match self.setup_io(default, true) {
 231             Ok((_, theirs)) => {
 232                 unsafe {
 233                     // Similar to when forking, we want to ensure that access to
 234                     // the environment is synchronized, so make sure to grab the
 235                     // environment lock before we try to exec.
 236                     let _lock = sys::os::env_read_lock();
 237
 238                     let Err(e) = self.do_exec(theirs, envp.as_ref());
 239                     e
 240                 }
 241             }
 242             Err(e) => e,
 243         }
 244     }
 245
 246     // And at this point we've reached a special time in the life of the
 247     // child. The child must now be considered hamstrung and unable to
 248     // do anything other than syscalls really. Consider the following
 249     // scenario:
 250     //
 251     //      1. Thread A of process 1 grabs the malloc() mutex
 252     //      2. Thread B of process 1 forks(), creating thread C
 253     //      3. Thread C of process 2 then attempts to malloc()
 254     //      4. The memory of process 2 is the same as the memory of
 255     //         process 1, so the mutex is locked.
 256     //
 257     // This situation looks a lot like deadlock, right? It turns out
 258     // that this is what pthread_atfork() takes care of, which is
 259     // presumably implemented across platforms. The first thing that
 260     // threads to *before* forking is to do things like grab the malloc
 261     // mutex, and then after the fork they unlock it.
 262     //
 263     // Despite this information, libnative's spawn has been witnessed to
 264     // deadlock on both macOS and FreeBSD. I'm not entirely sure why, but
 265     // all collected backtraces point at malloc/free traffic in the
 266     // child spawned process.
 267     //
 268     // For this reason, the block of code below should contain 0
 269     // invocations of either malloc of free (or their related friends).
 270     //
 271     // As an example of not having malloc/free traffic, we don't close
 272     // this file descriptor by dropping the FileDesc (which contains an
 273     // allocation). Instead we just close it manually. This will never
 274     // have the drop glue anyway because this code never returns (the
 275     // child will either exec() or invoke libc::exit)
 276     unsafe fn do_exec(
 277         &mut self,
 278         stdio: ChildPipes,
 279         maybe_envp: Option<&CStringArray>,
 280     ) -> Result<!, io::Error> {
 281         use crate::sys::{self, cvt_r};
 282
 283         if let Some(fd) = stdio.stdin.fd() {
 284             cvt_r(|| libc::dup2(fd, libc::STDIN_FILENO))?;
 285         }
 286         if let Some(fd) = stdio.stdout.fd() {
 287             cvt_r(|| libc::dup2(fd, libc::STDOUT_FILENO))?;
 288         }
 289         if let Some(fd) = stdio.stderr.fd() {
 290             cvt_r(|| libc::dup2(fd, libc::STDERR_FILENO))?;
 291         }
 292
 293         #[cfg(not(target_os = "l4re"))]
 294         {
 295             if let Some(_g) = self.get_groups() {
 296                 //FIXME: Redox kernel does not support setgroups yet
 297                 #[cfg(not(target_os = "redox"))]
 298                 cvt(libc::setgroups(_g.len().try_into().unwrap(), _g.as_ptr()))?;
 299             }
 300             if let Some(u) = self.get_gid() {
 301                 cvt(libc::setgid(u as gid_t))?;
 302             }
 303             if let Some(u) = self.get_uid() {
 304                 // When dropping privileges from root, the `setgroups` call
 305                 // will remove any extraneous groups. We only drop groups
 306                 // if the current uid is 0 and we weren't given an explicit
 307                 // set of groups. If we don't call this, then even though our
 308                 // uid has dropped, we may still have groups that enable us to
 309                 // do super-user things.
 310                 //FIXME: Redox kernel does not support setgroups yet
 311                 #[cfg(not(target_os = "redox"))]
 312                 if libc::getuid() == 0 && self.get_groups().is_none() {
 313                     cvt(libc::setgroups(0, ptr::null()))?;
 314                 }
 315                 cvt(libc::setuid(u as uid_t))?;
 316             }
 317         }
 318         if let Some(ref cwd) = *self.get_cwd() {
 319             cvt(libc::chdir(cwd.as_ptr()))?;
 320         }
 321
 322         // emscripten has no signal support.
 323         #[cfg(not(target_os = "emscripten"))]
 324         {
 325             use crate::mem::MaybeUninit;
 326             // Reset signal handling so the child process starts in a
 327             // standardized state. libstd ignores SIGPIPE, and signal-handling
 328             // libraries often set a mask. Child processes inherit ignored
 329             // signals and the signal mask from their parent, but most
 330             // UNIX programs do not reset these things on their own, so we
 331             // need to clean things up now to avoid confusing the program
 332             // we're about to run.
 333             let mut set = MaybeUninit::<libc::sigset_t>::uninit();
 334             cvt(sigemptyset(set.as_mut_ptr()))?;
 335             cvt(libc::pthread_sigmask(libc::SIG_SETMASK, set.as_ptr(), ptr::null_mut()))?;
 336
 337             #[cfg(target_os = "android")] // see issue #88585
 338             {
 339                 let mut action: libc::sigaction = mem::zeroed();
 340                 action.sa_sigaction = libc::SIG_DFL;
 341                 cvt(libc::sigaction(libc::SIGPIPE, &action, ptr::null_mut()))?;
 342             }
 343             #[cfg(not(target_os = "android"))]
 344             {
 345                 let ret = sys::signal(libc::SIGPIPE, libc::SIG_DFL);
 346                 if ret == libc::SIG_ERR {
 347                     return Err(io::Error::last_os_error());
 348                 }
 349             }
 350         }
 351
 352         for callback in self.get_closures().iter_mut() {
 353             callback()?;
 354         }
 355
 356         // Although we're performing an exec here we may also return with an
 357         // error from this function (without actually exec'ing) in which case we
 358         // want to be sure to restore the global environment back to what it
 359         // once was, ensuring that our temporary override, when free'd, doesn't
 360         // corrupt our process's environment.
 361         let mut _reset = None;
 362         if let Some(envp) = maybe_envp {
 363             struct Reset(*const *const libc::c_char);
 364
 365             impl Drop for Reset {
 366                 fn drop(&mut self) {
 367                     unsafe {
 368                         *sys::os::environ() = self.0;
 369                     }
 370                 }
 371             }
 372
 373             _reset = Some(Reset(*sys::os::environ()));
 374             *sys::os::environ() = envp.as_ptr();
 375         }
 376
 377         libc::execvp(self.get_program_cstr().as_ptr(), self.get_argv().as_ptr());
 378         Err(io::Error::last_os_error())
 379     }
 380
 381     #[cfg(not(any(
 382         target_os = "macos",
 383         target_os = "freebsd",
 384         all(target_os = "linux", target_env = "gnu"),
 385         all(target_os = "linux", target_env = "musl"),
 386     )))]
 387     fn posix_spawn(
 388         &mut self,
 389         _: &ChildPipes,
 390         _: Option<&CStringArray>,
 391     ) -> io::Result<Option<Process>> {
 392         Ok(None)
 393     }
 394
 395     // Only support platforms for which posix_spawn() can return ENOENT
 396     // directly.
 397     #[cfg(any(
 398         target_os = "macos",
 399         target_os = "freebsd",
 400         all(target_os = "linux", target_env = "gnu"),
 401         all(target_os = "linux", target_env = "musl"),
 402     ))]
 403     fn posix_spawn(
 404         &mut self,
 405         stdio: &ChildPipes,
 406         envp: Option<&CStringArray>,
 407     ) -> io::Result<Option<Process>> {
 408         use crate::mem::MaybeUninit;
 409         use crate::sys::{self, cvt_nz};
 410
 411         if self.get_gid().is_some()
 412             || self.get_uid().is_some()
 413             || (self.env_saw_path() && !self.program_is_path())
 414             || !self.get_closures().is_empty()
 415             || self.get_groups().is_some()
 416             || self.get_create_pidfd()
 417         {
 418             return Ok(None);
 419         }
 420
 421         // Only glibc 2.24+ posix_spawn() supports returning ENOENT directly.
 422         #[cfg(all(target_os = "linux", target_env = "gnu"))]
 423         {
 424             if let Some(version) = sys::os::glibc_version() {
 425                 if version < (2, 24) {
 426                     return Ok(None);
 427                 }
 428             } else {
 429                 return Ok(None);
 430             }
 431         }
 432
 433         // Solaris, glibc 2.29+, and musl 1.24+ can set a new working directory,
 434         // and maybe others will gain this non-POSIX function too. We'll check
 435         // for this weak symbol as soon as it's needed, so we can return early
 436         // otherwise to do a manual chdir before exec.
 437         weak! {
 438             fn posix_spawn_file_actions_addchdir_np(
 439                 *mut libc::posix_spawn_file_actions_t,
 440                 *const libc::c_char
 441             ) -> libc::c_int
 442         }
 443         let addchdir = match self.get_cwd() {
 444             Some(cwd) => {
 445                 if cfg!(target_os = "macos") {
 446                     // There is a bug in macOS where a relative executable
 447                     // path like "../myprogram" will cause `posix_spawn` to
 448                     // successfully launch the program, but erroneously return
 449                     // ENOENT when used with posix_spawn_file_actions_addchdir_np
 450                     // which was introduced in macOS 10.15.
 451                     return Ok(None);
 452                 }
 453                 match posix_spawn_file_actions_addchdir_np.get() {
 454                     Some(f) => Some((f, cwd)),
 455                     None => return Ok(None),
 456                 }
 457             }
 458             None => None,
 459         };
 460
 461         // Safety: -1 indicates we don't have a pidfd.
 462         let mut p = unsafe { Process::new(0, -1) };
 463
 464         struct PosixSpawnFileActions<'a>(&'a mut MaybeUninit<libc::posix_spawn_file_actions_t>);
 465
 466         impl Drop for PosixSpawnFileActions<'_> {
 467             fn drop(&mut self) {
 468                 unsafe {
 469                     libc::posix_spawn_file_actions_destroy(self.0.as_mut_ptr());
 470                 }
 471             }
 472         }
 473
 474         struct PosixSpawnattr<'a>(&'a mut MaybeUninit<libc::posix_spawnattr_t>);
 475
 476         impl Drop for PosixSpawnattr<'_> {
 477             fn drop(&mut self) {
 478                 unsafe {
 479                     libc::posix_spawnattr_destroy(self.0.as_mut_ptr());
 480                 }
 481             }
 482         }
 483
 484         unsafe {
 485             let mut attrs = MaybeUninit::uninit();
 486             cvt_nz(libc::posix_spawnattr_init(attrs.as_mut_ptr()))?;
 487             let attrs = PosixSpawnattr(&mut attrs);
 488
 489             let mut file_actions = MaybeUninit::uninit();
 490             cvt_nz(libc::posix_spawn_file_actions_init(file_actions.as_mut_ptr()))?;
 491             let file_actions = PosixSpawnFileActions(&mut file_actions);
 492
 493             if let Some(fd) = stdio.stdin.fd() {
 494                 cvt_nz(libc::posix_spawn_file_actions_adddup2(
 495                     file_actions.0.as_mut_ptr(),
 496                     fd,
 497                     libc::STDIN_FILENO,
 498                 ))?;
 499             }
 500             if let Some(fd) = stdio.stdout.fd() {
 501                 cvt_nz(libc::posix_spawn_file_actions_adddup2(
 502                     file_actions.0.as_mut_ptr(),
 503                     fd,
 504                     libc::STDOUT_FILENO,
 505                 ))?;
 506             }
 507             if let Some(fd) = stdio.stderr.fd() {
 508                 cvt_nz(libc::posix_spawn_file_actions_adddup2(
 509                     file_actions.0.as_mut_ptr(),
 510                     fd,
 511                     libc::STDERR_FILENO,
 512                 ))?;
 513             }
 514             if let Some((f, cwd)) = addchdir {
 515                 cvt_nz(f(file_actions.0.as_mut_ptr(), cwd.as_ptr()))?;
 516             }
 517
 518             let mut set = MaybeUninit::<libc::sigset_t>::uninit();
 519             cvt(sigemptyset(set.as_mut_ptr()))?;
 520             cvt_nz(libc::posix_spawnattr_setsigmask(attrs.0.as_mut_ptr(), set.as_ptr()))?;
 521             cvt(sigaddset(set.as_mut_ptr(), libc::SIGPIPE))?;
 522             cvt_nz(libc::posix_spawnattr_setsigdefault(attrs.0.as_mut_ptr(), set.as_ptr()))?;
 523
 524             let flags = libc::POSIX_SPAWN_SETSIGDEF | libc::POSIX_SPAWN_SETSIGMASK;
 525             cvt_nz(libc::posix_spawnattr_setflags(attrs.0.as_mut_ptr(), flags as _))?;
 526
 527             // Make sure we synchronize access to the global `environ` resource
 528             let _env_lock = sys::os::env_read_lock();
 529             let envp = envp.map(|c| c.as_ptr()).unwrap_or_else(|| *sys::os::environ() as *const _);
 530             cvt_nz(libc::posix_spawnp(
 531                 &mut p.pid,
 532                 self.get_program_cstr().as_ptr(),
 533                 file_actions.0.as_ptr(),
 534                 attrs.0.as_ptr(),
 535                 self.get_argv().as_ptr() as *const _,
 536                 envp as *const _,
 537             ))?;
 538             Ok(Some(p))
 539         }
 540     }
 541 }
 542
 543 ////////////////////////////////////////////////////////////////////////////////
 544 // Processes
 545 ////////////////////////////////////////////////////////////////////////////////
 546
 547 /// The unique ID of the process (this should never be negative).
 548 pub struct Process {
 549     pid: pid_t,
 550     status: Option<ExitStatus>,
 551     // On Linux, stores the pidfd created for this child.
 552     // This is None if the user did not request pidfd creation,
 553     // or if the pidfd could not be created for some reason
 554     // (e.g. the `clone3` syscall was not available).
 555     #[cfg(target_os = "linux")]
 556     pidfd: Option<PidFd>,
 557 }
 558
 559 impl Process {
 560     #[cfg(target_os = "linux")]
 561     unsafe fn new(pid: pid_t, pidfd: pid_t) -> Self {
 562         use crate::os::unix::io::FromRawFd;
 563         use crate::sys_common::FromInner;
 564         // Safety: If `pidfd` is nonnegative, we assume it's valid and otherwise unowned.
 565         let pidfd = (pidfd >= 0).then(|| PidFd::from_inner(sys::fd::FileDesc::from_raw_fd(pidfd)));
 566         Process { pid, status: None, pidfd }
 567     }
 568
 569     #[cfg(not(target_os = "linux"))]
 570     unsafe fn new(pid: pid_t, _pidfd: pid_t) -> Self {
 571         Process { pid, status: None }
 572     }
 573
 574     pub fn id(&self) -> u32 {
 575         self.pid as u32
 576     }
 577
 578     pub fn kill(&mut self) -> io::Result<()> {
 579         // If we've already waited on this process then the pid can be recycled
 580         // and used for another process, and we probably shouldn't be killing
 581         // random processes, so just return an error.
 582         if self.status.is_some() {
 583             Err(Error::new_const(
 584                 ErrorKind::InvalidInput,
 585                 &"invalid argument: can't kill an exited process",
 586             ))
 587         } else {
 588             cvt(unsafe { libc::kill(self.pid, libc::SIGKILL) }).map(drop)
 589         }
 590     }
 591
 592     pub fn wait(&mut self) -> io::Result<ExitStatus> {
 593         use crate::sys::cvt_r;
 594         if let Some(status) = self.status {
 595             return Ok(status);
 596         }
 597         let mut status = 0 as c_int;
 598         cvt_r(|| unsafe { libc::waitpid(self.pid, &mut status, 0) })?;
 599         self.status = Some(ExitStatus::new(status));
 600         Ok(ExitStatus::new(status))
 601     }
 602
 603     pub fn try_wait(&mut self) -> io::Result<Option<ExitStatus>> {
 604         if let Some(status) = self.status {
 605             return Ok(Some(status));
 606         }
 607         let mut status = 0 as c_int;
 608         let pid = cvt(unsafe { libc::waitpid(self.pid, &mut status, libc::WNOHANG) })?;
 609         if pid == 0 {
 610             Ok(None)
 611         } else {
 612             self.status = Some(ExitStatus::new(status));
 613             Ok(Some(ExitStatus::new(status)))
 614         }
 615     }
 616 }
 617
 618 /// Unix exit statuses
 619 #[derive(PartialEq, Eq, Clone, Copy)]
 620 pub struct ExitStatus(c_int);
 621
 622 impl fmt::Debug for ExitStatus {
 623     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 624         f.debug_tuple("unix_wait_status").field(&self.0).finish()
 625     }
 626 }
 627
 628 impl ExitStatus {
 629     pub fn new(status: c_int) -> ExitStatus {
 630         ExitStatus(status)
 631     }
 632
 633     fn exited(&self) -> bool {
 634         libc::WIFEXITED(self.0)
 635     }
 636
 637     pub fn exit_ok(&self) -> Result<(), ExitStatusError> {
 638         // This assumes that WIFEXITED(status) && WEXITSTATUS==0 corresponds to status==0.  This is
 639         // true on all actual versions of Unix, is widely assumed, and is specified in SuS
 640         // https://pubs.opengroup.org/onlinepubs/9699919799/functions/wait.html .  If it is not
 641         // true for a platform pretending to be Unix, the tests (our doctests, and also
 642         // procsss_unix/tests.rs) will spot it.  `ExitStatusError::code` assumes this too.
 643         match NonZero_c_int::try_from(self.0) {
 644             /* was nonzero */ Ok(failure) => Err(ExitStatusError(failure)),
 645             /* was zero, couldn't convert */ Err(_) => Ok(()),
 646         }
 647     }
 648
 649     pub fn code(&self) -> Option<i32> {
 650         if self.exited() { Some(libc::WEXITSTATUS(self.0)) } else { None }
 651     }
 652
 653     pub fn signal(&self) -> Option<i32> {
 654         if libc::WIFSIGNALED(self.0) { Some(libc::WTERMSIG(self.0)) } else { None }
 655     }
 656
 657     pub fn core_dumped(&self) -> bool {
 658         libc::WIFSIGNALED(self.0) && libc::WCOREDUMP(self.0)
 659     }
 660
 661     pub fn stopped_signal(&self) -> Option<i32> {
 662         if libc::WIFSTOPPED(self.0) { Some(libc::WSTOPSIG(self.0)) } else { None }
 663     }
 664
 665     pub fn continued(&self) -> bool {
 666         libc::WIFCONTINUED(self.0)
 667     }
 668
 669     pub fn into_raw(&self) -> c_int {
 670         self.0
 671     }
 672 }
 673
 674 /// Converts a raw `c_int` to a type-safe `ExitStatus` by wrapping it without copying.
 675 impl From<c_int> for ExitStatus {
 676     fn from(a: c_int) -> ExitStatus {
 677         ExitStatus(a)
 678     }
 679 }
 680
 681 impl fmt::Display for ExitStatus {
 682     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 683         if let Some(code) = self.code() {
 684             write!(f, "exit status: {}", code)
 685         } else if let Some(signal) = self.signal() {
 686             if self.core_dumped() {
 687                 write!(f, "signal: {} (core dumped)", signal)
 688             } else {
 689                 write!(f, "signal: {}", signal)
 690             }
 691         } else if let Some(signal) = self.stopped_signal() {
 692             write!(f, "stopped (not terminated) by signal: {}", signal)
 693         } else if self.continued() {
 694             write!(f, "continued (WIFCONTINUED)")
 695         } else {
 696             write!(f, "unrecognised wait status: {} {:#x}", self.0, self.0)
 697         }
 698     }
 699 }
 700
 701 #[derive(PartialEq, Eq, Clone, Copy)]
 702 pub struct ExitStatusError(NonZero_c_int);
 703
 704 impl Into<ExitStatus> for ExitStatusError {
 705     fn into(self) -> ExitStatus {
 706         ExitStatus(self.0.into())
 707     }
 708 }
 709
 710 impl fmt::Debug for ExitStatusError {
 711     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 712         f.debug_tuple("unix_wait_status").field(&self.0).finish()
 713     }
 714 }
 715
 716 impl ExitStatusError {
 717     pub fn code(self) -> Option<NonZeroI32> {
 718         ExitStatus(self.0.into()).code().map(|st| st.try_into().unwrap())
 719     }
 720 }
 721
 722 #[cfg(target_os = "linux")]
 723 #[unstable(feature = "linux_pidfd", issue = "82971")]
 724 impl crate::os::linux::process::ChildExt for crate::process::Child {
 725     fn pidfd(&self) -> io::Result<&PidFd> {
 726         self.handle
 727             .pidfd
 728             .as_ref()
 729             .ok_or_else(|| Error::new(ErrorKind::Other, "No pidfd was created."))
 730     }
 731
 732     fn take_pidfd(&mut self) -> io::Result<PidFd> {
 733         self.handle
 734             .pidfd
 735             .take()
 736             .ok_or_else(|| Error::new(ErrorKind::Other, "No pidfd was created."))
 737     }
 738 }
 739
 740 #[cfg(test)]
 741 #[path = "process_unix/tests.rs"]
 742 mod tests;