Skip to content

Commit 4cb7ef0

Browse files
committed
Auto merge of #77455 - asm89:faster-spawn, r=kennytm
Use posix_spawn() on unix if program is a path Previously `Command::spawn` would fall back to the non-posix_spawn based implementation if the `PATH` environment variable was possibly changed. On systems with a modern (g)libc `posix_spawn()` can be significantly faster. If program is a path itself the `PATH` environment variable is not used for the lookup and it should be safe to use the `posix_spawnp()` method. [1] We found this, because we have a cli application that effectively runs a lot of subprocesses. It would sometimes noticeably hang while printing output. Profiling showed that the process was spending the majority of time in the kernel's `copy_page_range` function while spawning subprocesses. During this time the process is completely blocked from running, explaining why users were reporting the cli app hanging. Through this we discovered that `std::process::Command` has a fast and slow path for process execution. The fast path is backed by `posix_spawnp()` and the slow path by fork/exec syscalls being called explicitly. Using fork for process creation is supposed to be fast, but it slows down as your process uses more memory. It's not because the kernel copies the actual memory from the parent, but it does need to copy the references to it (see `copy_page_range` above!). We ended up using the slow path, because the command spawn implementation in falls back to the slow path if it suspects the PATH environment variable was changed. Here is a smallish program demonstrating the slowdown before this code change: ``` use std::process::Command; use std::time::Instant; fn main() { let mut args = std::env::args().skip(1); if let Some(size) = args.next() { // Allocate some memory let _xs: Vec<_> = std::iter::repeat(0) .take(size.parse().expect("valid number")) .collect(); let mut command = Command::new("/bin/sh"); command .arg("-c") .arg("echo hello"); if args.next().is_some() { println!("Overriding PATH"); command.env("PATH", std::env::var("PATH").expect("PATH env var")); } let now = Instant::now(); let child = command .spawn() .expect("failed to execute process"); println!("Spawn took: {:?}", now.elapsed()); let output = child.wait_with_output().expect("failed to wait on process"); println!("Output: {:?}", output); } else { eprintln!("Usage: prog [size]"); std::process::exit(1); } () } ``` Running it and passing different amounts of elements to use to allocate memory shows that the time taken for `spawn()` can differ quite significantly. In latter case the `posix_spawnp()` implementation is 30x faster: ``` $ cargo run --release 10000000 ... Spawn took: 324.275µs hello $ cargo run --release 10000000 changepath ... Overriding PATH Spawn took: 2.346809ms hello $ cargo run --release 100000000 ... Spawn took: 387.842µs hello $ cargo run --release 100000000 changepath ... Overriding PATH Spawn took: 13.434677ms hello ``` [1]: https://github.com/bminor/glibc/blob/5f72f9800b250410cad3abfeeb09469ef12b2438/posix/execvpe.c#L81
2 parents 66e37b6 + 8fe6154 commit 4cb7ef0

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

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

+6
Original file line numberDiff line numberDiff line change
@@ -255,11 +255,17 @@ impl Command {
255255
let maybe_env = self.env.capture_if_changed();
256256
maybe_env.map(|env| construct_envp(env, &mut self.saw_nul))
257257
}
258+
258259
#[allow(dead_code)]
259260
pub fn env_saw_path(&self) -> bool {
260261
self.env.have_changed_path()
261262
}
262263

264+
#[allow(dead_code)]
265+
pub fn program_is_path(&self) -> bool {
266+
self.program.to_bytes().contains(&b'/')
267+
}
268+
263269
pub fn setup_io(
264270
&self,
265271
default: Stdio,

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ impl Command {
285285

286286
if self.get_gid().is_some()
287287
|| self.get_uid().is_some()
288-
|| self.env_saw_path()
288+
|| (self.env_saw_path() && !self.program_is_path())
289289
|| !self.get_closures().is_empty()
290290
{
291291
return Ok(None);

0 commit comments

Comments
 (0)