pidfd

Obtain file descriptors which refer to processes

2 releases

0.2.4 Dec 20, 2019
0.2.3 Dec 3, 2019
0.2.1 Nov 28, 2019
0.1.0 Nov 27, 2019

#996 in Unix APIs

Download history 1/week @ 2024-07-08 4/week @ 2024-07-15 3/week @ 2024-07-29 10/week @ 2024-08-26 1/week @ 2024-09-02 44/week @ 2024-09-23 7/week @ 2024-09-30

51 downloads per month
Used in pidfd_getfd

MIT/Apache

10KB
153 lines

pidfd

This Rust crate provides Linux (>= 5.3) PID file descriptor support. PID file descriptors are created from PIDs of processes, and are guaranteed to always reference the process from which the PID FD was created.

One of the benefits of using a PID FD is the ability to use poll(), select(), and epoll() to monitor when the process has terminated. This makes it ideal for use in asynchronous programming. This crate implements std::future::Future on the PidFd type so that multiple processes can be awaited concurrently.

Linux 5.4 is required to use the waitid feature, which enables fetching the exit status of a pidfd.

use pidfd::PidFd;
use std::{io, process::Command};

fn main() {
    futures::executor::block_on(async move {
        futures::try_join!(
            spawn_sleeper("1", "5"),
            spawn_sleeper("2", "4"),
            spawn_sleeper("3", "3"),
            spawn_sleeper("4", "2"),
            spawn_sleeper("5", "1"),
        )
        .unwrap();
    })
}

async fn spawn_sleeper(id: &str, timeout: &str) -> io::Result<()> {
    println!("started job {}", id);

    let exit_status = Command::new("/bin/sleep")
        .arg(timeout)
        .spawn()
        .map(PidFd::from)
        .unwrap()
        .into_future()
        .await?;

    println!("finished job {}: {}", id, exit_status);
    Ok(())
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~205KB