rustix/
prctl.rs

1//! Helper functions for `prctl` syscalls.
2
3#![allow(unsafe_code)]
4
5use crate::backend::prctl::syscalls;
6use crate::ffi::{c_int, c_void};
7use crate::io;
8use crate::utils::as_mut_ptr;
9use bitflags::bitflags;
10use core::mem::MaybeUninit;
11use core::ptr::null_mut;
12
13#[cfg(linux_raw_dep)]
14bitflags! {
15    /// `PR_PAC_AP*`
16    #[repr(transparent)]
17    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
18    pub struct PointerAuthenticationKeys: u32 {
19        /// `PR_PAC_APIAKEY`—Instruction authentication key `A`.
20        const INSTRUCTION_AUTHENTICATION_KEY_A = linux_raw_sys::prctl::PR_PAC_APIAKEY;
21        /// `PR_PAC_APIBKEY`—Instruction authentication key `B`.
22        const INSTRUCTION_AUTHENTICATION_KEY_B = linux_raw_sys::prctl::PR_PAC_APIBKEY;
23        /// `PR_PAC_APDAKEY`—Data authentication key `A`.
24        const DATA_AUTHENTICATION_KEY_A = linux_raw_sys::prctl::PR_PAC_APDAKEY;
25        /// `PR_PAC_APDBKEY`—Data authentication key `B`.
26        const DATA_AUTHENTICATION_KEY_B = linux_raw_sys::prctl::PR_PAC_APDBKEY;
27        /// `PR_PAC_APGAKEY`—Generic authentication `A` key.
28        const GENERIC_AUTHENTICATION_KEY_A = linux_raw_sys::prctl::PR_PAC_APGAKEY;
29
30        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
31        const _ = !0;
32    }
33}
34
35#[inline]
36pub(crate) unsafe fn prctl_1arg(option: c_int) -> io::Result<c_int> {
37    const NULL: *mut c_void = null_mut();
38    syscalls::prctl(option, NULL, NULL, NULL, NULL)
39}
40
41#[inline]
42pub(crate) unsafe fn prctl_2args(option: c_int, arg2: *mut c_void) -> io::Result<c_int> {
43    const NULL: *mut c_void = null_mut();
44    syscalls::prctl(option, arg2, NULL, NULL, NULL)
45}
46
47#[inline]
48pub(crate) unsafe fn prctl_3args(
49    option: c_int,
50    arg2: *mut c_void,
51    arg3: *mut c_void,
52) -> io::Result<c_int> {
53    syscalls::prctl(option, arg2, arg3, null_mut(), null_mut())
54}
55
56#[inline]
57pub(crate) unsafe fn prctl_get_at_arg2_optional<P>(option: i32) -> io::Result<P> {
58    let mut value: MaybeUninit<P> = MaybeUninit::uninit();
59    prctl_2args(option, value.as_mut_ptr().cast())?;
60    Ok(value.assume_init())
61}
62
63#[inline]
64pub(crate) unsafe fn prctl_get_at_arg2<P, T>(option: i32) -> io::Result<T>
65where
66    P: Default,
67    T: TryFrom<P, Error = io::Errno>,
68{
69    let mut value: P = Default::default();
70    prctl_2args(option, as_mut_ptr(&mut value).cast())?;
71    TryFrom::try_from(value)
72}