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.
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.
14 use collections::HashMap;
15 use collections::hash_map::Hasher;
18 use io::process::{ProcessExit, ExitStatus, ExitSignal};
19 use io::{self, IoResult, IoError, EndOfFile};
20 use libc::{self, pid_t, c_void, c_int};
23 use path::BytesContainer;
25 use sync::mpsc::{channel, Sender, Receiver};
26 use sys::fs::FileDesc;
27 use sys::{self, retry, c, wouldblock, set_nonblocking, ms_to_timeval};
28 use sys_common::helper_thread::Helper;
29 use sys_common::{AsInner, mkerr_libc, timeout};
31 pub use sys_common::ProcessConfig;
33 helper_init! { static HELPER: Helper<Req> }
35 /// The unique id of the process (this should never be negative).
41 NewChild(libc::pid_t, Sender<ProcessExit>, u64),
44 const CLOEXEC_MSG_FOOTER: &'static [u8] = b"NOEX";
47 pub fn id(&self) -> pid_t {
51 pub unsafe fn kill(&self, signal: int) -> IoResult<()> {
52 Process::killpid(self.pid, signal)
55 pub unsafe fn killpid(pid: pid_t, signal: int) -> IoResult<()> {
56 let r = libc::funcs::posix88::signal::kill(pid, signal as c_int);
60 pub fn spawn<K, V, C, P>(cfg: &C, in_fd: Option<P>,
61 out_fd: Option<P>, err_fd: Option<P>)
63 where C: ProcessConfig<K, V>, P: AsInner<FileDesc>,
64 K: BytesContainer + Eq + Hash<Hasher>, V: BytesContainer
66 use libc::funcs::posix88::unistd::{fork, dup2, close, chdir, execvp};
67 use libc::funcs::bsd44::getdtablesize;
71 pub fn rust_unset_sigprocmask();
75 #[cfg(target_os = "macos")]
76 unsafe fn set_environ(envp: *const c_void) {
77 extern { fn _NSGetEnviron() -> *mut *const c_void; }
79 *_NSGetEnviron() = envp;
81 #[cfg(not(target_os = "macos"))]
82 unsafe fn set_environ(envp: *const c_void) {
83 extern { static mut environ: *const c_void; }
87 unsafe fn set_cloexec(fd: c_int) {
88 let ret = c::ioctl(fd, c::FIOCLEX);
92 let dirp = cfg.cwd().map(|c| c.as_ptr()).unwrap_or(ptr::null());
94 // temporary until unboxed closures land
96 mem::transmute::<&ProcessConfig<K,V>,&'static ProcessConfig<K,V>>(cfg)
99 with_envp(cfg.env(), move|: envp: *const c_void| {
100 with_argv(cfg.program(), cfg.args(), move|: argv: *const *const libc::c_char| unsafe {
101 let (input, mut output) = try!(sys::os::pipe());
103 // We may use this in the child, so perform allocations before the
105 let devnull = b"/dev/null\0";
107 set_cloexec(output.fd());
111 return Err(super::last_error())
114 fn combine(arr: &[u8]) -> i32 {
115 let a = arr[0] as u32;
116 let b = arr[1] as u32;
117 let c = arr[2] as u32;
118 let d = arr[3] as u32;
120 ((a << 24) | (b << 16) | (c << 8) | (d << 0)) as i32
123 let p = Process{ pid: pid };
125 let mut bytes = [0; 8];
126 return match input.read(&mut bytes) {
128 assert!(combine(CLOEXEC_MSG_FOOTER) == combine(bytes.slice(4, 8)),
129 "Validation on the CLOEXEC pipe failed: {:?}", bytes);
130 let errno = combine(bytes.slice(0, 4));
131 assert!(p.wait(0).is_ok(), "wait(0) should either return Ok or panic");
132 Err(super::decode_error(errno))
134 Err(ref e) if e.kind == EndOfFile => Ok(p),
136 assert!(p.wait(0).is_ok(), "wait(0) should either return Ok or panic");
137 panic!("the CLOEXEC pipe failed: {:?}", e)
139 Ok(..) => { // pipe I/O up to PIPE_BUF bytes should be atomic
140 assert!(p.wait(0).is_ok(), "wait(0) should either return Ok or panic");
141 panic!("short read on the CLOEXEC pipe")
146 // And at this point we've reached a special time in the life of the
147 // child. The child must now be considered hamstrung and unable to
148 // do anything other than syscalls really. Consider the following
151 // 1. Thread A of process 1 grabs the malloc() mutex
152 // 2. Thread B of process 1 forks(), creating thread C
153 // 3. Thread C of process 2 then attempts to malloc()
154 // 4. The memory of process 2 is the same as the memory of
155 // process 1, so the mutex is locked.
157 // This situation looks a lot like deadlock, right? It turns out
158 // that this is what pthread_atfork() takes care of, which is
159 // presumably implemented across platforms. The first thing that
160 // threads to *before* forking is to do things like grab the malloc
161 // mutex, and then after the fork they unlock it.
163 // Despite this information, libnative's spawn has been witnessed to
164 // deadlock on both OSX and FreeBSD. I'm not entirely sure why, but
165 // all collected backtraces point at malloc/free traffic in the
166 // child spawned process.
168 // For this reason, the block of code below should contain 0
169 // invocations of either malloc of free (or their related friends).
171 // As an example of not having malloc/free traffic, we don't close
172 // this file descriptor by dropping the FileDesc (which contains an
173 // allocation). Instead we just close it manually. This will never
174 // have the drop glue anyway because this code never returns (the
175 // child will either exec() or invoke libc::exit)
176 let _ = libc::close(input.fd());
178 fn fail(output: &mut FileDesc) -> ! {
179 let errno = sys::os::errno() as u32;
185 CLOEXEC_MSG_FOOTER[0], CLOEXEC_MSG_FOOTER[1],
186 CLOEXEC_MSG_FOOTER[2], CLOEXEC_MSG_FOOTER[3]
188 // pipe I/O up to PIPE_BUF bytes should be atomic
189 assert!(output.write(&bytes).is_ok());
190 unsafe { libc::_exit(1) }
193 rustrt::rust_unset_sigprocmask();
195 // If a stdio file descriptor is set to be ignored (via a -1 file
196 // descriptor), then we don't actually close it, but rather open
197 // up /dev/null into that file descriptor. Otherwise, the first file
198 // descriptor opened up in the child would be numbered as one of the
199 // stdio file descriptors, which is likely to wreak havoc.
200 let setup = |&: src: Option<P>, dst: c_int| {
201 let src = match src {
203 let flags = if dst == libc::STDIN_FILENO {
208 libc::open(devnull.as_ptr() as *const _, flags, 0)
211 let fd = obj.as_inner().fd();
212 // Leak the memory and the file descriptor. We're in the
213 // child now an all our resources are going to be
214 // cleaned up very soon
219 src != -1 && retry(|| dup2(src, dst)) != -1
222 if !setup(in_fd, libc::STDIN_FILENO) { fail(&mut output) }
223 if !setup(out_fd, libc::STDOUT_FILENO) { fail(&mut output) }
224 if !setup(err_fd, libc::STDERR_FILENO) { fail(&mut output) }
226 // close all other fds
227 for fd in range(3, getdtablesize()).rev() {
228 if fd != output.fd() {
229 let _ = close(fd as c_int);
235 if libc::setgid(u as libc::gid_t) != 0 {
243 // When dropping privileges from root, the `setgroups` call
244 // will remove any extraneous groups. If we don't call this,
245 // then even though our uid has dropped, we may still have
246 // groups that enable us to do super-user things. This will
247 // fail if we aren't root, so don't bother checking the
248 // return value, this is just done as an optimistic
249 // privilege dropping function.
251 fn setgroups(ngroups: libc::c_int,
252 ptr: *const libc::c_void) -> libc::c_int;
254 let _ = setgroups(0, 0 as *const libc::c_void);
256 if libc::setuid(u as libc::uid_t) != 0 {
263 // Don't check the error of setsid because it fails if we're the
264 // process leader already. We just forked so it shouldn't return
265 // error, but ignore it anyway.
266 let _ = libc::setsid();
268 if !dirp.is_null() && chdir(dirp) == -1 {
274 let _ = execvp(*argv, argv as *mut _);
280 pub fn wait(&self, deadline: u64) -> IoResult<ProcessExit> {
282 use sync::mpsc::TryRecvError;
284 static mut WRITE_FD: libc::c_int = 0;
286 let mut status = 0 as c_int;
288 return match retry(|| unsafe { c::waitpid(self.pid, &mut status, 0) }) {
289 -1 => panic!("unknown waitpid error: {:?}", super::last_error()),
290 _ => Ok(translate_status(status)),
294 // On unix, wait() and its friends have no timeout parameters, so there is
295 // no way to time out a thread in wait(). From some googling and some
296 // thinking, it appears that there are a few ways to handle timeouts in
297 // wait(), but the only real reasonable one for a multi-threaded program is
298 // to listen for SIGCHLD.
300 // With this in mind, the waiting mechanism with a timeout barely uses
301 // waitpid() at all. There are a few times that waitpid() is invoked with
302 // WNOHANG, but otherwise all the necessary blocking is done by waiting for
303 // a SIGCHLD to arrive (and that blocking has a timeout). Note, however,
304 // that waitpid() is still used to actually reap the child.
306 // Signal handling is super tricky in general, and this is no exception. Due
307 // to the async nature of SIGCHLD, we use the self-pipe trick to transmit
308 // data out of the signal handler to the rest of the application. The first
309 // idea would be to have each thread waiting with a timeout to read this
310 // output file descriptor, but a write() is akin to a signal(), not a
311 // broadcast(), so it would only wake up one thread, and possibly the wrong
312 // thread. Hence a helper thread is used.
314 // The helper thread here is responsible for farming requests for a
315 // waitpid() with a timeout, and then processing all of the wait requests.
316 // By guaranteeing that only this helper thread is reading half of the
317 // self-pipe, we're sure that we'll never lose a SIGCHLD. This helper thread
318 // is also responsible for select() to wait for incoming messages or
319 // incoming SIGCHLD messages, along with passing an appropriate timeout to
320 // select() to wake things up as necessary.
322 // The ordering of the following statements is also very purposeful. First,
323 // we must be guaranteed that the helper thread is booted and available to
324 // receive SIGCHLD signals, and then we must also ensure that we do a
325 // nonblocking waitpid() at least once before we go ask the sigchld helper.
326 // This prevents the race where the child exits, we boot the helper, and
327 // then we ask for the child's exit status (never seeing a sigchld).
329 // The actual communication between the helper thread and this thread is
330 // quite simple, just a channel moving data around.
332 unsafe { HELPER.boot(register_sigchld, waitpid_helper) }
334 match self.try_wait() {
335 Some(ret) => return Ok(ret),
339 let (tx, rx) = channel();
340 unsafe { HELPER.send(NewChild(self.pid, tx, deadline)); }
341 return match rx.recv() {
343 Err(..) => Err(timeout("wait timed out")),
346 // Register a new SIGCHLD handler, returning the reading half of the
347 // self-pipe plus the old handler registered (return value of sigaction).
349 // Be sure to set up the self-pipe first because as soon as we register a
350 // handler we're going to start receiving signals.
351 fn register_sigchld() -> (libc::c_int, c::sigaction) {
353 let mut pipes = [0; 2];
354 assert_eq!(libc::pipe(pipes.as_mut_ptr()), 0);
355 set_nonblocking(pipes[0], true).ok().unwrap();
356 set_nonblocking(pipes[1], true).ok().unwrap();
359 let mut old: c::sigaction = mem::zeroed();
360 let mut new: c::sigaction = mem::zeroed();
361 new.sa_handler = sigchld_handler;
362 new.sa_flags = c::SA_NOCLDSTOP;
363 assert_eq!(c::sigaction(c::SIGCHLD, &new, &mut old), 0);
368 // Helper thread for processing SIGCHLD messages
369 fn waitpid_helper(input: libc::c_int,
370 messages: Receiver<Req>,
371 (read_fd, old): (libc::c_int, c::sigaction)) {
372 set_nonblocking(input, true).ok().unwrap();
373 let mut set: c::fd_set = unsafe { mem::zeroed() };
374 let mut tv: libc::timeval;
375 let mut active = Vec::<(libc::pid_t, Sender<ProcessExit>, u64)>::new();
376 let max = cmp::max(input, read_fd) + 1;
379 // Figure out the timeout of our syscall-to-happen. If we're waiting
380 // for some processes, then they'll have a timeout, otherwise we
381 // wait indefinitely for a message to arrive.
383 // FIXME: sure would be nice to not have to scan the entire array
384 let min = active.iter().map(|a| a.2).enumerate().min_by(|p| {
387 let (p, idx) = match min {
388 Some((idx, deadline)) => {
389 let now = sys::timer::now();
390 let ms = if now < deadline {deadline - now} else {0};
391 tv = ms_to_timeval(ms);
392 (&mut tv as *mut _, idx)
394 None => (ptr::null_mut(), -1),
397 // Wait for something to happen
398 c::fd_set(&mut set, input);
399 c::fd_set(&mut set, read_fd);
400 match unsafe { c::select(max, &mut set, ptr::null_mut(),
401 ptr::null_mut(), p) } {
402 // interrupted, retry
403 -1 if os::errno() == libc::EINTR as uint => continue,
405 // We read something, break out and process
408 // Timeout, the pending request is removed
410 drop(active.remove(idx));
414 n => panic!("error in select {:?} ({:?})", os::errno(), n),
417 // Process any pending messages
420 match messages.try_recv() {
421 Ok(NewChild(pid, tx, deadline)) => {
422 active.push((pid, tx, deadline));
424 Err(TryRecvError::Disconnected) => {
425 assert!(active.len() == 0);
428 Err(TryRecvError::Empty) => break,
433 // If a child exited (somehow received SIGCHLD), then poll all
434 // children to see if any of them exited.
436 // We also attempt to be responsible netizens when dealing with
437 // SIGCHLD by invoking any previous SIGCHLD handler instead of just
438 // ignoring any previous SIGCHLD handler. Note that we don't provide
439 // a 1:1 mapping of our handler invocations to the previous handler
440 // invocations because we drain the `read_fd` entirely. This is
441 // probably OK because the kernel is already allowed to coalesce
442 // simultaneous signals, we're just doing some extra coalescing.
444 // Another point of note is that this likely runs the signal handler
445 // on a different thread than the one that received the signal. I
446 // *think* this is ok at this time.
448 // The main reason for doing this is to allow stdtest to run native
449 // tests as well. Both libgreen and libnative are running around
450 // with process timeouts, but libgreen should get there first
451 // (currently libuv doesn't handle old signal handlers).
453 let i: uint = unsafe { mem::transmute(old.sa_handler) };
455 assert!(old.sa_flags & c::SA_SIGINFO == 0);
456 (old.sa_handler)(c::SIGCHLD);
459 // FIXME: sure would be nice to not have to scan the entire
461 active.retain(|&(pid, ref tx, _)| {
462 let pr = Process { pid: pid };
463 match pr.try_wait() {
464 Some(msg) => { tx.send(msg).unwrap(); false }
471 // Once this helper thread is done, we re-register the old sigchld
472 // handler and close our intermediate file descriptors.
474 assert_eq!(c::sigaction(c::SIGCHLD, &old, ptr::null_mut()), 0);
475 let _ = libc::close(read_fd);
476 let _ = libc::close(WRITE_FD);
481 // Drain all pending data from the file descriptor, returning if any data
482 // could be drained. This requires that the file descriptor is in
484 fn drain(fd: libc::c_int) -> bool {
487 let mut buf = [0u8; 1];
489 libc::read(fd, buf.as_mut_ptr() as *mut libc::c_void,
490 buf.len() as libc::size_t)
492 n if n > 0 => { ret = true; }
494 -1 if wouldblock() => return ret,
495 n => panic!("bad read {:?} ({:?})", os::last_os_error(), n),
500 // Signal handler for SIGCHLD signals, must be async-signal-safe!
502 // This function will write to the writing half of the "self pipe" to wake
503 // up the helper thread if it's waiting. Note that this write must be
504 // nonblocking because if it blocks and the reader is the thread we
505 // interrupted, then we'll deadlock.
507 // When writing, if the write returns EWOULDBLOCK then we choose to ignore
508 // it. At that point we're guaranteed that there's something in the pipe
509 // which will wake up the other end at some point, so we just allow this
510 // signal to be coalesced with the pending signals on the pipe.
511 extern fn sigchld_handler(_signum: libc::c_int) {
514 libc::write(WRITE_FD, &msg as *const _ as *const libc::c_void, 1)
517 -1 if wouldblock() => {} // see above comments
518 n => panic!("bad error on write fd: {:?} {:?}", n, os::errno()),
523 pub fn try_wait(&self) -> Option<ProcessExit> {
524 let mut status = 0 as c_int;
525 match retry(|| unsafe {
526 c::waitpid(self.pid, &mut status, c::WNOHANG)
528 n if n == self.pid => Some(translate_status(status)),
530 n => panic!("unknown waitpid error `{:?}`: {:?}", n,
531 super::last_error()),
536 fn with_argv<T,F>(prog: &CString, args: &[CString],
539 where F : FnOnce(*const *const libc::c_char) -> T
541 let mut ptrs: Vec<*const libc::c_char> = Vec::with_capacity(args.len()+1);
543 // Convert the CStrings into an array of pointers. Note: the
544 // lifetime of the various CStrings involved is guaranteed to be
545 // larger than the lifetime of our invocation of cb, but this is
546 // technically unsafe as the callback could leak these pointers
548 ptrs.push(prog.as_ptr());
549 ptrs.extend(args.iter().map(|tmp| tmp.as_ptr()));
551 // Add a terminating null pointer (required by libc).
552 ptrs.push(ptr::null());
557 fn with_envp<K,V,T,F>(env: Option<&HashMap<K, V>>,
560 where F : FnOnce(*const c_void) -> T,
561 K : BytesContainer + Eq + Hash<Hasher>,
564 // On posixy systems we can pass a char** for envp, which is a
565 // null-terminated array of "k=v\0" strings. Since we must create
566 // these strings locally, yet expose a raw pointer to them, we
567 // create a temporary vector to own the CStrings that outlives the
571 let mut tmps = Vec::with_capacity(env.len());
573 for pair in env.iter() {
574 let mut kv = Vec::new();
575 kv.push_all(pair.0.container_as_bytes());
577 kv.push_all(pair.1.container_as_bytes());
578 kv.push(0); // terminating null
582 // As with `with_argv`, this is unsafe, since cb could leak the pointers.
583 let mut ptrs: Vec<*const libc::c_char> =
585 .map(|tmp| tmp.as_ptr() as *const libc::c_char)
587 ptrs.push(ptr::null());
589 cb(ptrs.as_ptr() as *const c_void)
595 fn translate_status(status: c_int) -> ProcessExit {
596 #![allow(non_snake_case)]
597 #[cfg(any(target_os = "linux", target_os = "android"))]
599 pub fn WIFEXITED(status: i32) -> bool { (status & 0xff) == 0 }
600 pub fn WEXITSTATUS(status: i32) -> i32 { (status >> 8) & 0xff }
601 pub fn WTERMSIG(status: i32) -> i32 { status & 0x7f }
604 #[cfg(any(target_os = "macos",
606 target_os = "freebsd",
607 target_os = "dragonfly"))]
609 pub fn WIFEXITED(status: i32) -> bool { (status & 0x7f) == 0 }
610 pub fn WEXITSTATUS(status: i32) -> i32 { status >> 8 }
611 pub fn WTERMSIG(status: i32) -> i32 { status & 0o177 }
614 if imp::WIFEXITED(status) {
615 ExitStatus(imp::WEXITSTATUS(status) as int)
617 ExitSignal(imp::WTERMSIG(status) as int)