| // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| use prelude::v1::*; |
| |
| use ascii::*; |
| use collections::HashMap; |
| use collections; |
| use env::split_paths; |
| use env; |
| use ffi::{OsString, OsStr}; |
| use fmt; |
| use fs; |
| use io::{self, Error}; |
| use libc::{self, c_void}; |
| use mem; |
| use os::windows::ffi::OsStrExt; |
| use path::Path; |
| use ptr; |
| use sync::{StaticMutex, MUTEX_INIT}; |
| use sys::c; |
| use sys::fs2::{OpenOptions, File}; |
| use sys::handle::Handle; |
| use sys::pipe2::AnonPipe; |
| use sys::stdio; |
| use sys::{self, cvt}; |
| use sys_common::{AsInner, FromInner}; |
| |
| //////////////////////////////////////////////////////////////////////////////// |
| // Command |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| fn mk_key(s: &OsStr) -> OsString { |
| FromInner::from_inner(sys::os_str::Buf { |
| inner: s.as_inner().inner.to_ascii_uppercase() |
| }) |
| } |
| |
| #[derive(Clone)] |
| pub struct Command { |
| pub program: OsString, |
| pub args: Vec<OsString>, |
| pub env: Option<HashMap<OsString, OsString>>, |
| pub cwd: Option<OsString>, |
| pub detach: bool, // not currently exposed in std::process |
| } |
| |
| impl Command { |
| pub fn new(program: &OsStr) -> Command { |
| Command { |
| program: program.to_os_string(), |
| args: Vec::new(), |
| env: None, |
| cwd: None, |
| detach: false, |
| } |
| } |
| |
| pub fn arg(&mut self, arg: &OsStr) { |
| self.args.push(arg.to_os_string()) |
| } |
| pub fn args<'a, I: Iterator<Item = &'a OsStr>>(&mut self, args: I) { |
| self.args.extend(args.map(OsStr::to_os_string)) |
| } |
| fn init_env_map(&mut self){ |
| if self.env.is_none() { |
| self.env = Some(env::vars_os().map(|(key, val)| { |
| (mk_key(&key), val) |
| }).collect()); |
| } |
| } |
| pub fn env(&mut self, key: &OsStr, val: &OsStr) { |
| self.init_env_map(); |
| self.env.as_mut().unwrap().insert(mk_key(key), val.to_os_string()); |
| } |
| pub fn env_remove(&mut self, key: &OsStr) { |
| self.init_env_map(); |
| self.env.as_mut().unwrap().remove(&mk_key(key)); |
| } |
| pub fn env_clear(&mut self) { |
| self.env = Some(HashMap::new()) |
| } |
| pub fn cwd(&mut self, dir: &OsStr) { |
| self.cwd = Some(dir.to_os_string()) |
| } |
| } |
| |
| //////////////////////////////////////////////////////////////////////////////// |
| // Processes |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| /// A value representing a child process. |
| /// |
| /// The lifetime of this value is linked to the lifetime of the actual |
| /// process - the Process destructor calls self.finish() which waits |
| /// for the process to terminate. |
| pub struct Process { |
| handle: Handle, |
| } |
| |
| pub enum Stdio { |
| Inherit, |
| Piped(AnonPipe), |
| None, |
| } |
| |
| impl Process { |
| pub fn spawn(cfg: &Command, |
| in_handle: Stdio, |
| out_handle: Stdio, |
| err_handle: Stdio) -> io::Result<Process> |
| { |
| use libc::{TRUE, STARTF_USESTDHANDLES}; |
| use libc::{DWORD, STARTUPINFO, CreateProcessW}; |
| |
| // To have the spawning semantics of unix/windows stay the same, we need |
| // to read the *child's* PATH if one is provided. See #15149 for more |
| // details. |
| let program = cfg.env.as_ref().and_then(|env| { |
| for (key, v) in env { |
| if OsStr::new("PATH") != &**key { continue } |
| |
| // Split the value and test each path to see if the |
| // program exists. |
| for path in split_paths(&v) { |
| let path = path.join(cfg.program.to_str().unwrap()) |
| .with_extension(env::consts::EXE_EXTENSION); |
| if fs::metadata(&path).is_ok() { |
| return Some(path.into_os_string()) |
| } |
| } |
| break |
| } |
| None |
| }); |
| |
| let mut si = zeroed_startupinfo(); |
| si.cb = mem::size_of::<STARTUPINFO>() as DWORD; |
| si.dwFlags = STARTF_USESTDHANDLES; |
| |
| let stdin = try!(in_handle.to_handle(c::STD_INPUT_HANDLE)); |
| let stdout = try!(out_handle.to_handle(c::STD_OUTPUT_HANDLE)); |
| let stderr = try!(err_handle.to_handle(c::STD_ERROR_HANDLE)); |
| |
| si.hStdInput = stdin.raw(); |
| si.hStdOutput = stdout.raw(); |
| si.hStdError = stderr.raw(); |
| |
| let program = program.as_ref().unwrap_or(&cfg.program); |
| let mut cmd_str = make_command_line(program, &cfg.args); |
| cmd_str.push(0); // add null terminator |
| |
| // stolen from the libuv code. |
| let mut flags = libc::CREATE_UNICODE_ENVIRONMENT; |
| if cfg.detach { |
| flags |= libc::DETACHED_PROCESS | libc::CREATE_NEW_PROCESS_GROUP; |
| } |
| |
| let (envp, _data) = make_envp(cfg.env.as_ref()); |
| let (dirp, _data) = make_dirp(cfg.cwd.as_ref()); |
| let mut pi = zeroed_process_information(); |
| try!(unsafe { |
| // `CreateProcess` is racy! |
| // http://support.microsoft.com/kb/315939 |
| static CREATE_PROCESS_LOCK: StaticMutex = MUTEX_INIT; |
| let _lock = CREATE_PROCESS_LOCK.lock(); |
| |
| cvt(CreateProcessW(ptr::null(), |
| cmd_str.as_mut_ptr(), |
| ptr::null_mut(), |
| ptr::null_mut(), |
| TRUE, flags, envp, dirp, |
| &mut si, &mut pi)) |
| }); |
| |
| // We close the thread handle because we don't care about keeping |
| // the thread id valid, and we aren't keeping the thread handle |
| // around to be able to close it later. |
| drop(Handle::new(pi.hThread)); |
| |
| Ok(Process { handle: Handle::new(pi.hProcess) }) |
| } |
| |
| pub unsafe fn kill(&self) -> io::Result<()> { |
| try!(cvt(libc::TerminateProcess(self.handle.raw(), 1))); |
| Ok(()) |
| } |
| |
| pub fn wait(&self) -> io::Result<ExitStatus> { |
| use libc::{STILL_ACTIVE, INFINITE, WAIT_OBJECT_0}; |
| use libc::{GetExitCodeProcess, WaitForSingleObject}; |
| |
| unsafe { |
| loop { |
| let mut status = 0; |
| try!(cvt(GetExitCodeProcess(self.handle.raw(), &mut status))); |
| if status != STILL_ACTIVE { |
| return Ok(ExitStatus(status as i32)); |
| } |
| match WaitForSingleObject(self.handle.raw(), INFINITE) { |
| WAIT_OBJECT_0 => {} |
| _ => return Err(Error::last_os_error()), |
| } |
| } |
| } |
| } |
| } |
| |
| #[derive(PartialEq, Eq, Clone, Copy, Debug)] |
| pub struct ExitStatus(i32); |
| |
| impl ExitStatus { |
| pub fn success(&self) -> bool { |
| self.0 == 0 |
| } |
| pub fn code(&self) -> Option<i32> { |
| Some(self.0) |
| } |
| } |
| |
| impl fmt::Display for ExitStatus { |
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { |
| write!(f, "exit code: {}", self.0) |
| } |
| } |
| |
| fn zeroed_startupinfo() -> libc::types::os::arch::extra::STARTUPINFO { |
| libc::types::os::arch::extra::STARTUPINFO { |
| cb: 0, |
| lpReserved: ptr::null_mut(), |
| lpDesktop: ptr::null_mut(), |
| lpTitle: ptr::null_mut(), |
| dwX: 0, |
| dwY: 0, |
| dwXSize: 0, |
| dwYSize: 0, |
| dwXCountChars: 0, |
| dwYCountCharts: 0, |
| dwFillAttribute: 0, |
| dwFlags: 0, |
| wShowWindow: 0, |
| cbReserved2: 0, |
| lpReserved2: ptr::null_mut(), |
| hStdInput: libc::INVALID_HANDLE_VALUE, |
| hStdOutput: libc::INVALID_HANDLE_VALUE, |
| hStdError: libc::INVALID_HANDLE_VALUE, |
| } |
| } |
| |
| fn zeroed_process_information() -> libc::types::os::arch::extra::PROCESS_INFORMATION { |
| libc::types::os::arch::extra::PROCESS_INFORMATION { |
| hProcess: ptr::null_mut(), |
| hThread: ptr::null_mut(), |
| dwProcessId: 0, |
| dwThreadId: 0 |
| } |
| } |
| |
| // Produces a wide string *without terminating null* |
| fn make_command_line(prog: &OsStr, args: &[OsString]) -> Vec<u16> { |
| // Encode the command and arguments in a command line string such |
| // that the spawned process may recover them using CommandLineToArgvW. |
| let mut cmd: Vec<u16> = Vec::new(); |
| append_arg(&mut cmd, prog); |
| for arg in args { |
| cmd.push(' ' as u16); |
| append_arg(&mut cmd, arg); |
| } |
| return cmd; |
| |
| fn append_arg(cmd: &mut Vec<u16>, arg: &OsStr) { |
| // If an argument has 0 characters then we need to quote it to ensure |
| // that it actually gets passed through on the command line or otherwise |
| // it will be dropped entirely when parsed on the other end. |
| let arg_bytes = &arg.as_inner().inner.as_inner(); |
| let quote = arg_bytes.iter().any(|c| *c == b' ' || *c == b'\t') |
| || arg_bytes.is_empty(); |
| if quote { |
| cmd.push('"' as u16); |
| } |
| |
| let mut iter = arg.encode_wide(); |
| let mut backslashes: usize = 0; |
| while let Some(x) = iter.next() { |
| if x == '\\' as u16 { |
| backslashes += 1; |
| } else { |
| if x == '"' as u16 { |
| // Add n+1 backslashes to total 2n+1 before internal '"'. |
| for _ in 0..(backslashes+1) { |
| cmd.push('\\' as u16); |
| } |
| } |
| backslashes = 0; |
| } |
| cmd.push(x); |
| } |
| |
| if quote { |
| // Add n backslashes to total 2n before ending '"'. |
| for _ in 0..backslashes { |
| cmd.push('\\' as u16); |
| } |
| cmd.push('"' as u16); |
| } |
| } |
| } |
| |
| fn make_envp(env: Option<&collections::HashMap<OsString, OsString>>) |
| -> (*mut c_void, Vec<u16>) { |
| // On Windows we pass an "environment block" which is not a char**, but |
| // rather a concatenation of null-terminated k=v\0 sequences, with a final |
| // \0 to terminate. |
| match env { |
| Some(env) => { |
| let mut blk = Vec::new(); |
| |
| for pair in env { |
| blk.extend(pair.0.encode_wide()); |
| blk.push('=' as u16); |
| blk.extend(pair.1.encode_wide()); |
| blk.push(0); |
| } |
| blk.push(0); |
| (blk.as_mut_ptr() as *mut c_void, blk) |
| } |
| _ => (ptr::null_mut(), Vec::new()) |
| } |
| } |
| |
| fn make_dirp(d: Option<&OsString>) -> (*const u16, Vec<u16>) { |
| match d { |
| Some(dir) => { |
| let mut dir_str: Vec<u16> = dir.encode_wide().collect(); |
| dir_str.push(0); |
| (dir_str.as_ptr(), dir_str) |
| }, |
| None => (ptr::null(), Vec::new()) |
| } |
| } |
| |
| impl Stdio { |
| fn to_handle(&self, stdio_id: libc::DWORD) -> io::Result<Handle> { |
| use libc::DUPLICATE_SAME_ACCESS; |
| |
| match *self { |
| Stdio::Inherit => { |
| stdio::get(stdio_id).and_then(|io| { |
| io.handle().duplicate(0, true, DUPLICATE_SAME_ACCESS) |
| }) |
| } |
| Stdio::Piped(ref pipe) => { |
| pipe.handle().duplicate(0, true, DUPLICATE_SAME_ACCESS) |
| } |
| |
| // Similarly to unix, we don't actually leave holes for the |
| // stdio file descriptors, but rather open up /dev/null |
| // equivalents. These equivalents are drawn from libuv's |
| // windows process spawning. |
| Stdio::None => { |
| let size = mem::size_of::<libc::SECURITY_ATTRIBUTES>(); |
| let mut sa = libc::SECURITY_ATTRIBUTES { |
| nLength: size as libc::DWORD, |
| lpSecurityDescriptor: ptr::null_mut(), |
| bInheritHandle: 1, |
| }; |
| let mut opts = OpenOptions::new(); |
| opts.read(stdio_id == c::STD_INPUT_HANDLE); |
| opts.write(stdio_id != c::STD_INPUT_HANDLE); |
| opts.security_attributes(&mut sa); |
| File::open(Path::new("NUL"), &opts).map(|file| { |
| file.into_handle() |
| }) |
| } |
| } |
| } |
| } |
| |
| #[cfg(test)] |
| mod tests { |
| use prelude::v1::*; |
| use str; |
| use ffi::{OsStr, OsString}; |
| use super::make_command_line; |
| |
| #[test] |
| fn test_make_command_line() { |
| fn test_wrapper(prog: &str, args: &[&str]) -> String { |
| String::from_utf16( |
| &make_command_line(OsStr::new(prog), |
| &args.iter() |
| .map(|a| OsString::from(a)) |
| .collect::<Vec<OsString>>())).unwrap() |
| } |
| |
| assert_eq!( |
| test_wrapper("prog", &["aaa", "bbb", "ccc"]), |
| "prog aaa bbb ccc" |
| ); |
| |
| assert_eq!( |
| test_wrapper("C:\\Program Files\\blah\\blah.exe", &["aaa"]), |
| "\"C:\\Program Files\\blah\\blah.exe\" aaa" |
| ); |
| assert_eq!( |
| test_wrapper("C:\\Program Files\\test", &["aa\"bb"]), |
| "\"C:\\Program Files\\test\" aa\\\"bb" |
| ); |
| assert_eq!( |
| test_wrapper("echo", &["a b c"]), |
| "echo \"a b c\"" |
| ); |
| assert_eq!( |
| test_wrapper("echo", &["\" \\\" \\", "\\"]), |
| "echo \"\\\" \\\\\\\" \\\\\" \\" |
| ); |
| assert_eq!( |
| test_wrapper("\u{03c0}\u{042f}\u{97f3}\u{00e6}\u{221e}", &[]), |
| "\u{03c0}\u{042f}\u{97f3}\u{00e6}\u{221e}" |
| ); |
| } |
| } |
