1 use crate::convert::TryInto;
3 use crate::io::{self, Error, ErrorKind};
7 use crate::sys::process::process_common::*;
9 #[cfg(target_os = "vxworks")]
10 use libc::RTP_ID as pid_t;
12 #[cfg(not(target_os = "vxworks"))]
13 use libc::{c_int, gid_t, pid_t, uid_t};
15 ////////////////////////////////////////////////////////////////////////////////
17 ////////////////////////////////////////////////////////////////////////////////
24 ) -> io::Result<(Process, StdioPipes)> {
25 const CLOEXEC_MSG_FOOTER: [u8; 4] = *b"NOEX";
27 let envp = self.capture_env();
30 return Err(io::Error::new(ErrorKind::InvalidInput, "nul byte found in provided data"));
33 let (ours, theirs) = self.setup_io(default, needs_stdin)?;
35 if let Some(ret) = self.posix_spawn(&theirs, envp.as_ref())? {
36 return Ok((ret, ours));
39 let (input, output) = sys::pipe::anon_pipe()?;
41 // Whatever happens after the fork is almost for sure going to touch or
42 // look at the environment in one way or another (PATH in `execvp` or
43 // accessing the `environ` pointer ourselves). Make sure no other thread
44 // is accessing the environment when we do the fork itself.
46 // Note that as soon as we're done with the fork there's no need to hold
47 // a lock any more because the parent won't do anything and the child is
48 // in its own process.
50 let _env_lock = sys::os::env_lock();
58 let Err(err) = self.do_exec(theirs, envp.as_ref());
59 let errno = err.raw_os_error().unwrap_or(libc::EINVAL) as u32;
60 let errno = errno.to_be_bytes();
66 CLOEXEC_MSG_FOOTER[0],
67 CLOEXEC_MSG_FOOTER[1],
68 CLOEXEC_MSG_FOOTER[2],
69 CLOEXEC_MSG_FOOTER[3],
71 // pipe I/O up to PIPE_BUF bytes should be atomic, and then
72 // we want to be sure we *don't* run at_exit destructors as
73 // we're being torn down regardless
74 rtassert!(output.write(&bytes).is_ok());
81 let mut p = Process { pid, status: None };
83 let mut bytes = [0; 8];
85 // loop to handle EINTR
87 match input.read(&mut bytes) {
88 Ok(0) => return Ok((p, ours)),
90 let (errno, footer) = bytes.split_at(4);
92 CLOEXEC_MSG_FOOTER, footer,
93 "Validation on the CLOEXEC pipe failed: {:?}",
96 let errno = i32::from_be_bytes(errno.try_into().unwrap());
97 assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
98 return Err(Error::from_raw_os_error(errno));
100 Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
102 assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
103 panic!("the CLOEXEC pipe failed: {:?}", e)
106 // pipe I/O up to PIPE_BUF bytes should be atomic
107 assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
108 panic!("short read on the CLOEXEC pipe")
114 pub fn exec(&mut self, default: Stdio) -> io::Error {
115 let envp = self.capture_env();
118 return io::Error::new(ErrorKind::InvalidInput, "nul byte found in provided data");
121 match self.setup_io(default, true) {
124 // Similar to when forking, we want to ensure that access to
125 // the environment is synchronized, so make sure to grab the
126 // environment lock before we try to exec.
127 let _lock = sys::os::env_lock();
129 let Err(e) = self.do_exec(theirs, envp.as_ref());
137 // And at this point we've reached a special time in the life of the
138 // child. The child must now be considered hamstrung and unable to
139 // do anything other than syscalls really. Consider the following
142 // 1. Thread A of process 1 grabs the malloc() mutex
143 // 2. Thread B of process 1 forks(), creating thread C
144 // 3. Thread C of process 2 then attempts to malloc()
145 // 4. The memory of process 2 is the same as the memory of
146 // process 1, so the mutex is locked.
148 // This situation looks a lot like deadlock, right? It turns out
149 // that this is what pthread_atfork() takes care of, which is
150 // presumably implemented across platforms. The first thing that
151 // threads to *before* forking is to do things like grab the malloc
152 // mutex, and then after the fork they unlock it.
154 // Despite this information, libnative's spawn has been witnessed to
155 // deadlock on both macOS and FreeBSD. I'm not entirely sure why, but
156 // all collected backtraces point at malloc/free traffic in the
157 // child spawned process.
159 // For this reason, the block of code below should contain 0
160 // invocations of either malloc of free (or their related friends).
162 // As an example of not having malloc/free traffic, we don't close
163 // this file descriptor by dropping the FileDesc (which contains an
164 // allocation). Instead we just close it manually. This will never
165 // have the drop glue anyway because this code never returns (the
166 // child will either exec() or invoke libc::exit)
170 maybe_envp: Option<&CStringArray>,
171 ) -> Result<!, io::Error> {
172 use crate::sys::{self, cvt_r};
174 if let Some(fd) = stdio.stdin.fd() {
175 cvt_r(|| libc::dup2(fd, libc::STDIN_FILENO))?;
177 if let Some(fd) = stdio.stdout.fd() {
178 cvt_r(|| libc::dup2(fd, libc::STDOUT_FILENO))?;
180 if let Some(fd) = stdio.stderr.fd() {
181 cvt_r(|| libc::dup2(fd, libc::STDERR_FILENO))?;
184 #[cfg(not(target_os = "l4re"))]
186 if let Some(u) = self.get_gid() {
187 cvt(libc::setgid(u as gid_t))?;
189 if let Some(u) = self.get_uid() {
190 // When dropping privileges from root, the `setgroups` call
191 // will remove any extraneous groups. If we don't call this,
192 // then even though our uid has dropped, we may still have
193 // groups that enable us to do super-user things. This will
194 // fail if we aren't root, so don't bother checking the
195 // return value, this is just done as an optimistic
196 // privilege dropping function.
197 //FIXME: Redox kernel does not support setgroups yet
198 #[cfg(not(target_os = "redox"))]
199 let _ = libc::setgroups(0, ptr::null());
200 cvt(libc::setuid(u as uid_t))?;
203 if let Some(ref cwd) = *self.get_cwd() {
204 cvt(libc::chdir(cwd.as_ptr()))?;
207 // emscripten has no signal support.
208 #[cfg(not(target_os = "emscripten"))]
210 use crate::mem::MaybeUninit;
211 // Reset signal handling so the child process starts in a
212 // standardized state. libstd ignores SIGPIPE, and signal-handling
213 // libraries often set a mask. Child processes inherit ignored
214 // signals and the signal mask from their parent, but most
215 // UNIX programs do not reset these things on their own, so we
216 // need to clean things up now to avoid confusing the program
217 // we're about to run.
218 let mut set = MaybeUninit::<libc::sigset_t>::uninit();
219 cvt(sigemptyset(set.as_mut_ptr()))?;
220 cvt(libc::pthread_sigmask(libc::SIG_SETMASK, set.as_ptr(), ptr::null_mut()))?;
221 let ret = sys::signal(libc::SIGPIPE, libc::SIG_DFL);
222 if ret == libc::SIG_ERR {
223 return Err(io::Error::last_os_error());
227 for callback in self.get_closures().iter_mut() {
231 // Although we're performing an exec here we may also return with an
232 // error from this function (without actually exec'ing) in which case we
233 // want to be sure to restore the global environment back to what it
234 // once was, ensuring that our temporary override, when free'd, doesn't
235 // corrupt our process's environment.
236 let mut _reset = None;
237 if let Some(envp) = maybe_envp {
238 struct Reset(*const *const libc::c_char);
240 impl Drop for Reset {
243 *sys::os::environ() = self.0;
248 _reset = Some(Reset(*sys::os::environ()));
249 *sys::os::environ() = envp.as_ptr();
252 libc::execvp(self.get_program_cstr().as_ptr(), self.get_argv().as_ptr());
253 Err(io::Error::last_os_error())
258 target_os = "freebsd",
259 all(target_os = "linux", target_env = "gnu"),
260 all(target_os = "linux", target_env = "musl"),
265 _: Option<&CStringArray>,
266 ) -> io::Result<Option<Process>> {
270 // Only support platforms for which posix_spawn() can return ENOENT
274 target_os = "freebsd",
275 all(target_os = "linux", target_env = "gnu"),
276 all(target_os = "linux", target_env = "musl"),
281 envp: Option<&CStringArray>,
282 ) -> io::Result<Option<Process>> {
283 use crate::mem::MaybeUninit;
284 use crate::sys::{self, cvt_nz};
286 if self.get_gid().is_some()
287 || self.get_uid().is_some()
288 || (self.env_saw_path() && !self.program_is_path())
289 || !self.get_closures().is_empty()
294 // Only glibc 2.24+ posix_spawn() supports returning ENOENT directly.
295 #[cfg(all(target_os = "linux", target_env = "gnu"))]
297 if let Some(version) = sys::os::glibc_version() {
298 if version < (2, 24) {
306 // Solaris, glibc 2.29+, and musl 1.24+ can set a new working directory,
307 // and maybe others will gain this non-POSIX function too. We'll check
308 // for this weak symbol as soon as it's needed, so we can return early
309 // otherwise to do a manual chdir before exec.
311 fn posix_spawn_file_actions_addchdir_np(
312 *mut libc::posix_spawn_file_actions_t,
316 let addchdir = match self.get_cwd() {
317 Some(cwd) => match posix_spawn_file_actions_addchdir_np.get() {
318 Some(f) => Some((f, cwd)),
319 None => return Ok(None),
324 let mut p = Process { pid: 0, status: None };
326 struct PosixSpawnFileActions<'a>(&'a mut MaybeUninit<libc::posix_spawn_file_actions_t>);
328 impl Drop for PosixSpawnFileActions<'_> {
331 libc::posix_spawn_file_actions_destroy(self.0.as_mut_ptr());
336 struct PosixSpawnattr<'a>(&'a mut MaybeUninit<libc::posix_spawnattr_t>);
338 impl Drop for PosixSpawnattr<'_> {
341 libc::posix_spawnattr_destroy(self.0.as_mut_ptr());
347 let mut attrs = MaybeUninit::uninit();
348 cvt_nz(libc::posix_spawnattr_init(attrs.as_mut_ptr()))?;
349 let attrs = PosixSpawnattr(&mut attrs);
351 let mut file_actions = MaybeUninit::uninit();
352 cvt_nz(libc::posix_spawn_file_actions_init(file_actions.as_mut_ptr()))?;
353 let file_actions = PosixSpawnFileActions(&mut file_actions);
355 if let Some(fd) = stdio.stdin.fd() {
356 cvt_nz(libc::posix_spawn_file_actions_adddup2(
357 file_actions.0.as_mut_ptr(),
362 if let Some(fd) = stdio.stdout.fd() {
363 cvt_nz(libc::posix_spawn_file_actions_adddup2(
364 file_actions.0.as_mut_ptr(),
369 if let Some(fd) = stdio.stderr.fd() {
370 cvt_nz(libc::posix_spawn_file_actions_adddup2(
371 file_actions.0.as_mut_ptr(),
376 if let Some((f, cwd)) = addchdir {
377 cvt_nz(f(file_actions.0.as_mut_ptr(), cwd.as_ptr()))?;
380 let mut set = MaybeUninit::<libc::sigset_t>::uninit();
381 cvt(sigemptyset(set.as_mut_ptr()))?;
382 cvt_nz(libc::posix_spawnattr_setsigmask(attrs.0.as_mut_ptr(), set.as_ptr()))?;
383 cvt(sigaddset(set.as_mut_ptr(), libc::SIGPIPE))?;
384 cvt_nz(libc::posix_spawnattr_setsigdefault(attrs.0.as_mut_ptr(), set.as_ptr()))?;
386 let flags = libc::POSIX_SPAWN_SETSIGDEF | libc::POSIX_SPAWN_SETSIGMASK;
387 cvt_nz(libc::posix_spawnattr_setflags(attrs.0.as_mut_ptr(), flags as _))?;
389 // Make sure we synchronize access to the global `environ` resource
390 let _env_lock = sys::os::env_lock();
391 let envp = envp.map(|c| c.as_ptr()).unwrap_or_else(|| *sys::os::environ() as *const _);
392 cvt_nz(libc::posix_spawnp(
394 self.get_program_cstr().as_ptr(),
395 file_actions.0.as_ptr(),
397 self.get_argv().as_ptr() as *const _,
405 ////////////////////////////////////////////////////////////////////////////////
407 ////////////////////////////////////////////////////////////////////////////////
409 /// The unique ID of the process (this should never be negative).
412 status: Option<ExitStatus>,
416 pub fn id(&self) -> u32 {
420 pub fn kill(&mut self) -> io::Result<()> {
421 // If we've already waited on this process then the pid can be recycled
422 // and used for another process, and we probably shouldn't be killing
423 // random processes, so just return an error.
424 if self.status.is_some() {
426 ErrorKind::InvalidInput,
427 "invalid argument: can't kill an exited process",
430 cvt(unsafe { libc::kill(self.pid, libc::SIGKILL) }).map(drop)
434 pub fn wait(&mut self) -> io::Result<ExitStatus> {
435 use crate::sys::cvt_r;
436 if let Some(status) = self.status {
439 let mut status = 0 as c_int;
440 cvt_r(|| unsafe { libc::waitpid(self.pid, &mut status, 0) })?;
441 self.status = Some(ExitStatus::new(status));
442 Ok(ExitStatus::new(status))
445 pub fn try_wait(&mut self) -> io::Result<Option<ExitStatus>> {
446 if let Some(status) = self.status {
447 return Ok(Some(status));
449 let mut status = 0 as c_int;
450 let pid = cvt(unsafe { libc::waitpid(self.pid, &mut status, libc::WNOHANG) })?;
454 self.status = Some(ExitStatus::new(status));
455 Ok(Some(ExitStatus::new(status)))
460 /// Unix exit statuses
461 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
462 pub struct ExitStatus(c_int);
465 pub fn new(status: c_int) -> ExitStatus {
469 fn exited(&self) -> bool {
470 libc::WIFEXITED(self.0)
473 pub fn success(&self) -> bool {
474 self.code() == Some(0)
477 pub fn code(&self) -> Option<i32> {
478 if self.exited() { Some(libc::WEXITSTATUS(self.0)) } else { None }
481 pub fn signal(&self) -> Option<i32> {
482 if libc::WIFSIGNALED(self.0) { Some(libc::WTERMSIG(self.0)) } else { None }
485 pub fn into_raw(&self) -> c_int {
490 /// Converts a raw `c_int` to a type-safe `ExitStatus` by wrapping it without copying.
491 impl From<c_int> for ExitStatus {
492 fn from(a: c_int) -> ExitStatus {
497 impl fmt::Display for ExitStatus {
498 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
499 if let Some(code) = self.code() {
500 write!(f, "exit code: {}", code)
502 let signal = self.signal().unwrap();
503 write!(f, "signal: {}", signal)