src/libstd/sys/unix/pipe.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use prelude::v1::*;
  12
  13 use cmp;
  14 use io;
  15 use libc::{self, c_int};
  16 use mem;
  17 use sys::cvt_r;
  18 use sys::fd::FileDesc;
  19
  20 ////////////////////////////////////////////////////////////////////////////////
  21 // Anonymous pipes
  22 ////////////////////////////////////////////////////////////////////////////////
  23
  24 pub struct AnonPipe(FileDesc);
  25
  26 pub fn anon_pipe() -> io::Result<(AnonPipe, AnonPipe)> {
  27     let mut fds = [0; 2];
  28
  29     // Unfortunately the only known way right now to create atomically set the
  30     // CLOEXEC flag is to use the `pipe2` syscall on Linux. This was added in
  31     // 2.6.27, however, and because we support 2.6.18 we must detect this
  32     // support dynamically.
  33     if cfg!(target_os = "linux") {
  34         weak! { fn pipe2(*mut c_int, c_int) -> c_int }
  35         if let Some(pipe) = pipe2.get() {
  36             match cvt_r(|| unsafe { pipe(fds.as_mut_ptr(), libc::O_CLOEXEC) }) {
  37                 Ok(_) => {
  38                     return Ok((AnonPipe(FileDesc::new(fds[0])),
  39                                AnonPipe(FileDesc::new(fds[1]))))
  40                 }
  41                 Err(ref e) if e.raw_os_error() == Some(libc::ENOSYS) => {}
  42                 Err(e) => return Err(e),
  43             }
  44         }
  45     }
  46     if unsafe { libc::pipe(fds.as_mut_ptr()) == 0 } {
  47         let fd0 = FileDesc::new(fds[0]);
  48         let fd1 = FileDesc::new(fds[1]);
  49         Ok((AnonPipe::from_fd(fd0)?, AnonPipe::from_fd(fd1)?))
  50     } else {
  51         Err(io::Error::last_os_error())
  52     }
  53 }
  54
  55 impl AnonPipe {
  56     pub fn from_fd(fd: FileDesc) -> io::Result<AnonPipe> {
  57         fd.set_cloexec()?;
  58         Ok(AnonPipe(fd))
  59     }
  60
  61     pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
  62         self.0.read(buf)
  63     }
  64
  65     pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
  66         self.0.read_to_end(buf)
  67     }
  68
  69     pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
  70         self.0.write(buf)
  71     }
  72
  73     pub fn fd(&self) -> &FileDesc { &self.0 }
  74     pub fn into_fd(self) -> FileDesc { self.0 }
  75 }
  76
  77 pub fn read2(p1: AnonPipe,
  78              v1: &mut Vec<u8>,
  79              p2: AnonPipe,
  80              v2: &mut Vec<u8>) -> io::Result<()> {
  81     // Set both pipes into nonblocking mode as we're gonna be reading from both
  82     // in the `select` loop below, and we wouldn't want one to block the other!
  83     let p1 = p1.into_fd();
  84     let p2 = p2.into_fd();
  85     p1.set_nonblocking(true)?;
  86     p2.set_nonblocking(true)?;
  87
  88     let max = cmp::max(p1.raw(), p2.raw());
  89     loop {
  90         // wait for either pipe to become readable using `select`
  91         cvt_r(|| unsafe {
  92             let mut read: libc::fd_set = mem::zeroed();
  93             libc::FD_SET(p1.raw(), &mut read);
  94             libc::FD_SET(p2.raw(), &mut read);
  95             libc::select(max + 1, &mut read, 0 as *mut _, 0 as *mut _,
  96                          0 as *mut _)
  97         })?;
  98
  99         // Read as much as we can from each pipe, ignoring EWOULDBLOCK or
 100         // EAGAIN. If we hit EOF, then this will happen because the underlying
 101         // reader will return Ok(0), in which case we'll see `Ok` ourselves. In
 102         // this case we flip the other fd back into blocking mode and read
 103         // whatever's leftover on that file descriptor.
 104         let read = |fd: &FileDesc, dst: &mut Vec<u8>| {
 105             match fd.read_to_end(dst) {
 106                 Ok(_) => Ok(true),
 107                 Err(e) => {
 108                     if e.raw_os_error() == Some(libc::EWOULDBLOCK) ||
 109                        e.raw_os_error() == Some(libc::EAGAIN) {
 110                         Ok(false)
 111                     } else {
 112                         Err(e)
 113                     }
 114                 }
 115             }
 116         };
 117         if read(&p1, v1)? {
 118             p2.set_nonblocking(false)?;
 119             return p2.read_to_end(v2).map(|_| ());
 120         }
 121         if read(&p2, v2)? {
 122             p1.set_nonblocking(false)?;
 123             return p1.read_to_end(v1).map(|_| ());
 124         }
 125     }
 126 }