rustpython-host_env 0.6.0

Host OS API abstractions for RustPython
Documentation
use std::io;

use crate::os::CheckLibcResult;

pub use libc::{
    RLIM_INFINITY, RLIMIT_AS, RLIMIT_CORE, RLIMIT_CPU, RLIMIT_DATA, RLIMIT_FSIZE, RLIMIT_MEMLOCK,
    RLIMIT_NOFILE, RLIMIT_NPROC, RLIMIT_RSS, RLIMIT_STACK, c_long, rlim_t, rlimit, timeval,
};

#[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
pub use libc::{RLIMIT_MSGQUEUE, RLIMIT_NICE, RLIMIT_RTPRIO, RLIMIT_SIGPENDING};

#[cfg(target_os = "linux")]
pub use libc::RLIMIT_RTTIME;

#[cfg(any(
    target_os = "freebsd",
    target_os = "netbsd",
    target_os = "solaris",
    target_os = "illumos"
))]
pub use libc::RLIMIT_SBSIZE;

#[cfg(any(target_os = "freebsd", target_os = "solaris", target_os = "illumos"))]
pub use libc::{RLIMIT_NPTS, RLIMIT_SWAP};

#[cfg(any(target_os = "solaris", target_os = "illumos"))]
pub use libc::RLIMIT_VMEM;

#[cfg(any(target_os = "linux", target_os = "emscripten", target_os = "freebsd"))]
pub use libc::RUSAGE_THREAD;

#[cfg(not(any(target_os = "windows", target_os = "redox")))]
pub use libc::{RUSAGE_CHILDREN, RUSAGE_SELF};

#[cfg(target_os = "android")]
pub const RLIM_NLIMITS: libc::c_int = 16;

#[derive(Debug, Clone, Copy)]
pub struct RUsage {
    pub ru_utime: libc::timeval,
    pub ru_stime: libc::timeval,
    pub ru_maxrss: libc::c_long,
    pub ru_ixrss: libc::c_long,
    pub ru_idrss: libc::c_long,
    pub ru_isrss: libc::c_long,
    pub ru_minflt: libc::c_long,
    pub ru_majflt: libc::c_long,
    pub ru_nswap: libc::c_long,
    pub ru_inblock: libc::c_long,
    pub ru_oublock: libc::c_long,
    pub ru_msgsnd: libc::c_long,
    pub ru_msgrcv: libc::c_long,
    pub ru_nsignals: libc::c_long,
    pub ru_nvcsw: libc::c_long,
    pub ru_nivcsw: libc::c_long,
}

impl RUsage {
    pub fn utime_secs(&self) -> f64 {
        timeval_to_secs(self.ru_utime)
    }

    pub fn stime_secs(&self) -> f64 {
        timeval_to_secs(self.ru_stime)
    }

    pub fn total_cpu_duration(&self) -> Option<core::time::Duration> {
        let utime = timeval_to_nanos(self.ru_utime)?;
        let stime = timeval_to_nanos(self.ru_stime)?;
        let total = utime.checked_add(stime)?;
        Some(core::time::Duration::from_nanos(total as u64))
    }
}

fn timeval_to_secs(tv: libc::timeval) -> f64 {
    tv.tv_sec as f64 + (tv.tv_usec as f64 / 1_000_000.0)
}

fn timeval_to_nanos(tv: libc::timeval) -> Option<i64> {
    let secs = widen_to_i64(tv.tv_sec)?.checked_mul(1_000_000_000)?;
    let usecs = widen_to_i64(tv.tv_usec)?.checked_mul(1_000)?;
    secs.checked_add(usecs)
}

fn widen_to_i64<T: Copy + TryInto<i64>>(v: T) -> Option<i64> {
    v.try_into().ok()
}

impl From<libc::rusage> for RUsage {
    fn from(rusage: libc::rusage) -> Self {
        Self {
            ru_utime: rusage.ru_utime,
            ru_stime: rusage.ru_stime,
            ru_maxrss: rusage.ru_maxrss,
            ru_ixrss: rusage.ru_ixrss,
            ru_idrss: rusage.ru_idrss,
            ru_isrss: rusage.ru_isrss,
            ru_minflt: rusage.ru_minflt,
            ru_majflt: rusage.ru_majflt,
            ru_nswap: rusage.ru_nswap,
            ru_inblock: rusage.ru_inblock,
            ru_oublock: rusage.ru_oublock,
            ru_msgsnd: rusage.ru_msgsnd,
            ru_msgrcv: rusage.ru_msgrcv,
            ru_nsignals: rusage.ru_nsignals,
            ru_nvcsw: rusage.ru_nvcsw,
            ru_nivcsw: rusage.ru_nivcsw,
        }
    }
}

pub fn getrusage(who: i32) -> io::Result<RUsage> {
    let mut rusage = core::mem::MaybeUninit::<libc::rusage>::uninit();
    unsafe { libc::getrusage(who, rusage.as_mut_ptr()) }.check_libc_neg()?;
    Ok(unsafe { rusage.assume_init() }.into())
}

pub fn getrlimit(resource: libc::rlim_t) -> io::Result<libc::rlimit> {
    let mut rlimit = core::mem::MaybeUninit::<libc::rlimit>::uninit();
    unsafe { libc::getrlimit(resource as _, rlimit.as_mut_ptr()) }.check_libc_neg()?;
    Ok(unsafe { rlimit.assume_init() })
}

pub fn setrlimit(resource: libc::rlim_t, limits: libc::rlimit) -> io::Result<()> {
    unsafe { libc::setrlimit(resource as _, &limits) }.check_libc_neg()?;
    Ok(())
}

#[cfg(not(any(target_os = "redox", target_os = "wasi")))]
pub fn disable_core_dumps() {
    let rl = libc::rlimit {
        rlim_cur: 0,
        rlim_max: 0,
    };
    unsafe {
        let _ = libc::setrlimit(libc::RLIMIT_CORE, &rl);
    }
}