memfaultd 1.26.1

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use std::io::Read;

#[cfg(target_os = "linux")]
use std::path::PathBuf;

use eyre::{eyre, Result};
use lazy_static::lazy_static;
use libc::{clockid_t, timespec, CLOCK_MONOTONIC};

#[cfg(target_os = "linux")]
use libc::{sysconf, _SC_CLK_TCK, _SC_PAGE_SIZE};

#[cfg(target_os = "linux")]
use std::fs::{read_link, read_to_string, File};

use uuid::Uuid;

lazy_static! {
    static ref OS_RELEASE: Option<String> = read_osrelease().ok();
    static ref OS_TYPE: Option<String> = read_ostype().ok();
}

#[cfg(target_os = "linux")]
pub fn read_proc_cmdline<P: Read>(cmd_line_stream: &mut P) -> Result<String> {
    let mut cmd_line_buf = Vec::new();
    cmd_line_stream.read_to_end(&mut cmd_line_buf)?;

    Ok(String::from_utf8_lossy(&cmd_line_buf).into_owned())
}

#[cfg(target_os = "linux")]
pub fn read_system_boot_id() -> Result<Uuid> {
    use eyre::Context;
    use std::str::FromStr;

    const BOOT_ID_PATH: &str = "/proc/sys/kernel/random/boot_id";
    let boot_id = read_to_string(BOOT_ID_PATH);

    match boot_id {
        Ok(boot_id_str) => Uuid::from_str(boot_id_str.trim()).wrap_err("Invalid boot id"),
        Err(_) => Err(eyre!("Unable to read boot id from system.")),
    }
}

#[cfg(target_os = "linux")]
fn read_osrelease() -> Result<String> {
    let mut os_release = read_to_string("/proc/sys/kernel/osrelease")
        .map_err(|e| eyre!("Unable to read osrelease: {}", e))?;
    os_release.truncate(os_release.trim_end().len());
    Ok(os_release)
}

#[cfg(target_os = "linux")]
fn read_ostype() -> Result<String> {
    let mut os_type = read_to_string("/proc/sys/kernel/ostype")
        .map_err(|e| eyre!("Unable to read ostype: {}", e))?;
    os_type.truncate(os_type.trim_end().len());
    Ok(os_type)
}

#[cfg_attr(test, mockall::automock)]
pub trait OsInfo {
    fn get_osrelease(&self) -> Option<String>;
    fn get_ostype(&self) -> Option<String>;
}

pub struct OsInfoImpl;

impl OsInfo for OsInfoImpl {
    fn get_osrelease(&self) -> Option<String> {
        get_osrelease()
    }

    fn get_ostype(&self) -> Option<String> {
        get_ostype()
    }
}

/// Returns the value stored in /proc/sys/kernel/osrelease
/// The first time it is called we read and cache
/// the value from procfs. On subsequent calls the cached value
/// is returned. This is safe to do since this is a value set
/// at kernel build-time and cannot be altered at runtime.
fn get_osrelease() -> Option<String> {
    OS_RELEASE.clone()
}

/// Returns the value stored in /proc/sys/kernel/ostype
/// The first time it is called we read and cache
/// the value from procfs. On subsequent calls the cached value
/// is returned. This is safe to do since this is a value set
/// at kernel build-time and cannot be altered at runtime.
fn get_ostype() -> Option<String> {
    OS_TYPE.clone()
}

#[cfg(target_os = "linux")]
pub fn clock_ticks_per_second() -> u64 {
    unsafe { sysconf(_SC_CLK_TCK) as u64 }
}

#[cfg(target_os = "linux")]
pub fn bytes_per_page() -> u64 {
    unsafe { sysconf(_SC_PAGE_SIZE) as u64 }
}

/// Calls clock_gettime
/// Most interesting to us are:
/// CLOCK_MONOTONIC: "clock that increments monotonically, tracking the time
/// since an arbitrary point, and will continue to increment while the system is
/// asleep."
/// CLOCK_BOOTTIME  A  nonsettable system-wide clock that is identical to
/// CLOCK_MONOTONIC, except that it also includes any time that the system is
/// suspended.  This allows applications to get a suspend-aware monotonic clock
/// without having to deal with the complications of CLOCK_REALTIME, which may
/// have discontinuities if the time is changed using settimeofday(2) or
/// similar.
pub enum Clock {
    Monotonic,
    Boottime,
}
pub fn get_system_clock(clock: Clock) -> Result<std::time::Duration> {
    // Linux only so we define it here.
    const CLOCK_BOOTTIME: clockid_t = 7;

    let mut t = timespec {
        tv_sec: 0,
        tv_nsec: 0,
    };
    if unsafe {
        libc::clock_gettime(
            match clock {
                Clock::Monotonic => CLOCK_MONOTONIC,
                Clock::Boottime if cfg!(target_os = "linux") => CLOCK_BOOTTIME,
                // Falls back to monotonic if not linux
                Clock::Boottime => CLOCK_MONOTONIC,
            },
            &mut t,
        )
    } != 0
    {
        Err(eyre!("Error getting system clock."))
    } else {
        Ok(std::time::Duration::new(t.tv_sec as u64, t.tv_nsec as u32))
    }
}

pub trait ProcessNameMapper {
    fn get_process_name(pid: u32) -> Result<String>;
}

#[derive(Clone, Copy)]
pub struct ProcfsProcessNameMapper {}

impl ProcessNameMapper for ProcfsProcessNameMapper {
    fn get_process_name(pid: u32) -> Result<String> {
        get_process_name(pid)
    }
}

// Try to use basename of first string in /proc/<pid>/cmdline
// as process name.
// This is preferred over /proc/<pid>/comm because processes may change their comm
// string while running whereas cmdline is static.
#[cfg(target_os = "linux")]
pub fn get_process_name(pid: u32) -> Result<String> {
    let cmd_line_file_name = format!("/proc/{}/cmdline", pid);
    let mut cmd_line_file = File::open(cmd_line_file_name)?;
    let cmd_line = read_proc_cmdline(&mut cmd_line_file)?;

    process_name_from_cmdline(cmd_line)
}

#[cfg(target_os = "linux")]
pub fn get_process_path(pid: u32) -> Result<PathBuf> {
    use std::path::Path;

    let exe_file_name = format!("/proc/{}/exe", pid);
    let exe_file = Path::new(&exe_file_name);
    Ok(read_link(exe_file)?)
}

#[cfg(any(target_os = "linux", test))]
fn process_name_from_cmdline(cmd_line: String) -> Result<String> {
    use std::path::Path;

    // From https://man7.org/linux/man-pages/man5/proc_pid_cmdline.5.html
    // If the process is well-behaved, it is a
    // set of strings separated by null bytes ('\0'), with a
    // further null byte after the last string.
    let parts: Vec<&str> = cmd_line.split('\0').collect();

    let first_part = parts.first().ok_or(eyre!(
        "Couldn't parse process name from cmdline value: {}",
        cmd_line
    ))?;

    let first_filename = Path::new(first_part)
        .file_name()
        .and_then(|filename| filename.to_str())
        .ok_or(eyre!(
            "Couldn't parse process name from cmdline value: {}",
            cmd_line
        ))?;

    // For Python processes, we want to use the name of the entry point
    // file rather than the filename of the Python interpreter.
    if first_filename.starts_with("python") {
        let entry_point_path = parts.get(1).ok_or_else(|| {
            eyre!(
                "No string following {} in this process's cmd_line file",
                first_filename
            )
        })?;

        let entry_point_filename = Path::new(entry_point_path)
            .file_name()
            .ok_or_else(|| eyre!("Could not extract a filename from {}", entry_point_path))?
            .to_string_lossy()
            .to_string();

        Ok(entry_point_filename)
    } else {
        Ok(first_filename.to_string())
    }
}

/// Provide some mock implementations for non-Linux systems. Designed for development. Not actual use.

#[cfg(not(target_os = "linux"))]
pub fn read_system_boot_id() -> Result<Uuid> {
    use once_cell::sync::Lazy;
    static MOCK_BOOT_ID: Lazy<Uuid> = Lazy::new(Uuid::new_v4);
    Ok(*MOCK_BOOT_ID)
}

#[cfg(not(target_os = "linux"))]
pub fn read_osrelease() -> Result<String> {
    Ok("non-Linux-system".to_string())
}

#[cfg(not(target_os = "linux"))]
pub fn read_ostype() -> Result<String> {
    Ok("non-Linux-system".to_string())
}

#[cfg(not(target_os = "linux"))]
pub fn clock_ticks_per_second() -> u64 {
    10_000
}

#[cfg(not(target_os = "linux"))]
pub fn bytes_per_page() -> u64 {
    4096
}

#[cfg(not(target_os = "linux"))]
pub fn get_process_name(_pid: u32) -> Result<String> {
    Ok(String::default())
}

#[cfg(not(target_os = "linux"))]
pub fn read_proc_cmdline<P: Read>(_cmd_line_stream: &mut P) -> Result<String> {
    Ok(String::default())
}

#[cfg(test)]
mod test {

    use super::*;

    use rstest::rstest;

    #[rstest]
    #[case("/usr/bin/memfaultd\0--daemonize\0", "memfaultd")]
    #[case("/usr/bin/python3\0myPythonProgram.py\0", "myPythonProgram.py")]
    #[case("/usr/bin/wefaultd\0", "wefaultd")]
    fn test_cmdline_parsing(#[case] input: &str, #[case] process_name: &str) {
        assert_eq!(
            process_name_from_cmdline(input.to_string())
                .unwrap()
                .as_str(),
            process_name
        )
    }
}