Skip to main content

coreshift_core/
process.rs

1// This Source Code Form is subject to the terms of the Mozilla Public
2// License, v. 2.0. If a copy of the MPL was not distributed with this
3// file, You can obtain one at https://mozilla.org/MPL/2.0/
4
5//! Low-level process management primitives.
6//!
7//! Safe wrappers around `fork`, `setsid`, `setpgid`, `dup2`, `prctl`,
8//! and fd-range close — building blocks for double-fork supervisor patterns.
9
10use crate::CoreError;
11use crate::error::syscall_ret;
12
13/// Result of a [`fork`] call.
14pub enum ForkResult {
15    /// Returned in the parent with the child's PID.
16    Parent(i32),
17    /// Returned in the child (PID = 0).
18    Child,
19}
20
21/// Fork the current process.
22///
23/// # Safety
24/// After `fork`, only async-signal-safe operations are safe in the child
25/// before `exec`. Rust's allocator is not async-signal-safe; use this only
26/// in the narrow pattern of fork → exec or fork → immediate `_exit`.
27pub unsafe fn fork() -> Result<ForkResult, CoreError> {
28    let pid = unsafe { libc::fork() };
29    if pid < 0 {
30        return Err(CoreError::sys(
31            std::io::Error::last_os_error().raw_os_error().unwrap_or(-1),
32            "fork",
33        ));
34    }
35    if pid == 0 {
36        Ok(ForkResult::Child)
37    } else {
38        Ok(ForkResult::Parent(pid))
39    }
40}
41
42/// Create a new session and set the calling process as leader.
43pub fn setsid() -> Result<(), CoreError> {
44    let ret = unsafe { libc::setsid() };
45    if ret < 0 {
46        return Err(CoreError::sys(
47            std::io::Error::last_os_error().raw_os_error().unwrap_or(-1),
48            "setsid",
49        ));
50    }
51    Ok(())
52}
53
54/// Set the process group ID of `pid` to `pgid` (use 0 for self).
55pub fn setpgid(pid: i32, pgid: i32) -> Result<(), CoreError> {
56    syscall_ret(unsafe { libc::setpgid(pid, pgid) }, "setpgid")
57}
58
59/// Redirect stdin, stdout, and stderr to `/dev/null`.
60///
61/// # Safety
62/// Uses `dup2` on file descriptors 0/1/2.
63pub unsafe fn redirect_stdio_to_devnull() -> Result<(), CoreError> {
64    let fd = unsafe { libc::open(c"/dev/null".as_ptr(), libc::O_RDWR) };
65    if fd < 0 {
66        return Err(CoreError::sys(
67            std::io::Error::last_os_error().raw_os_error().unwrap_or(-1),
68            "open:/dev/null",
69        ));
70    }
71    unsafe {
72        libc::dup2(fd, 0);
73        libc::dup2(fd, 1);
74        libc::dup2(fd, 2);
75        if fd > 2 {
76            libc::close(fd);
77        }
78    }
79    Ok(())
80}
81
82/// Set the signal sent to this process when its parent dies (`PR_SET_PDEATHSIG`).
83pub fn set_pdeathsig(sig: i32) -> Result<(), CoreError> {
84    syscall_ret(
85        unsafe { libc::prctl(libc::PR_SET_PDEATHSIG, sig as libc::c_ulong, 0, 0, 0) },
86        "prctl:PR_SET_PDEATHSIG",
87    )
88}
89
90/// Duplicate `src_fd` onto `dst_fd` and close `src_fd`.
91///
92/// Equivalent to `dup2(src_fd, dst_fd); close(src_fd)`.
93///
94/// # Safety
95/// Manipulates raw file descriptors.
96pub unsafe fn redirect_fd_to(src_fd: i32, dst_fd: i32) {
97    unsafe {
98        libc::dup2(src_fd, dst_fd);
99        libc::close(src_fd);
100    }
101}
102
103pub fn getuid() -> u32 {
104    unsafe { libc::getuid() }
105}
106pub fn getgid() -> u32 {
107    unsafe { libc::getgid() }
108}
109
110/// Drop process privileges to the given UID (`setresuid`).
111///
112/// Sets real, effective, and saved UID to `uid`.
113pub fn setuid(uid: u32) -> Result<(), CoreError> {
114    syscall_ret(unsafe { libc::setresuid(uid, uid, uid) }, "setresuid")
115}
116
117/// Drop process privileges to the given GID (`setresgid`).
118///
119/// Sets real, effective, and saved GID to `gid`.
120pub fn setgid(gid: u32) -> Result<(), CoreError> {
121    syscall_ret(unsafe { libc::setresgid(gid, gid, gid) }, "setresgid")
122}
123
124/// Close all file descriptors >= `start`.
125///
126/// Enumerates `/proc/self/fd` to avoid EBADF on sparse fd tables.
127/// Falls back to a blind 3..1024 scan if `/proc/self/fd` is unreadable.
128pub fn close_fds_from(start: i32) {
129    if let Ok(entries) = std::fs::read_dir("/proc/self/fd") {
130        let fds: Vec<i32> = entries
131            .filter_map(|e| e.ok())
132            .filter_map(|e| e.file_name().to_str()?.parse::<i32>().ok())
133            .filter(|&fd| fd >= start)
134            .collect();
135        // entries is dropped here, closing the readdir fd before we iterate fds
136        for fd in fds {
137            unsafe { libc::close(fd) };
138        }
139    } else {
140        for fd in start..1024 {
141            unsafe { libc::close(fd) };
142        }
143    }
144}