perf-event-data 0.1.8

use std::borrow::Cow;
use std::ffi::OsStr;
use std::fmt;

use crate::prelude::*;

used_in_docs!(OsStr);

/// COMM records indicate changes in process names.
///
/// There are multiple ways that this could happen: [`execve(2)`],
/// [`prctl(PR_SET_NAME)`], as well as writing to `/proc/self/comm`.
///
/// Since Linux 3.10 the kernel will set the `COMM_EXEC` bit in the misc flags
/// if the record is due to an [`execve(2)`] syscall. You can set `comm_exec`
/// when building to detect whether this is supported.
///
/// This struct corresponds to `PERF_RECORD_COMM`. See the [manpage] for more
/// documentation.
///
/// [`execve(2)`]: https://man7.org/linux/man-pages/man2/execve.2.html
/// [`prctl(PR_SET_NAME)`]: https://man7.org/linux/man-pages/man2/prctl.2.html
/// [`COMM_EXEC`]: MiscFlags::COMM_EXEC
/// [manpage]: http://man7.org/linux/man-pages/man2/perf_event_open.2.html
#[derive(Clone)]
pub struct Comm<'a> {
    /// The process ID.
    pub pid: u32,

    /// The thread ID.
    pub tid: u32,

    /// The new name of the process.
    ///
    /// If on unix systems you can use `comm_os` to get this as an [`OsStr`].
    pub comm: Cow<'a, [u8]>,
}

impl<'a> Comm<'a> {
    /// The new name of the process, as an [`OsStr`].
    #[cfg(unix)]
    pub fn comm_os(&self) -> &OsStr {
        use std::os::unix::ffi::OsStrExt;

        OsStrExt::from_bytes(&self.comm)
    }

    /// Convert all the borrowed data in this `Comm` into owned data.
    pub fn into_owned(self) -> Comm<'static> {
        Comm {
            comm: self.comm.into_owned().into(),
            ..self
        }
    }
}

impl<'p> Parse<'p> for Comm<'p> {
    fn parse<B, E>(p: &mut Parser<B, E>) -> ParseResult<Self>
    where
        E: Endian,
        B: ParseBuf<'p>,
    {
        Ok(Self {
            pid: p.parse()?,
            tid: p.parse()?,
            comm: p.parse_rest_trim_nul()?,
        })
    }
}

impl fmt::Debug for Comm<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Comm")
            .field("pid", &self.pid)
            .field("tid", &self.tid)
            .field("comm", &crate::util::fmt::ByteStr(&self.comm))
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::endian::Little;

    #[test]
    fn test_parse() {
        #[rustfmt::skip]
        let bytes: &[u8] = &[
            0x10, 0x10, 0x00, 0x00, 0x00, 0x05, 0x00, 0x00,
            b't', b'e', b's', b't', 0x00, 0x00, 0x00, 0x00
        ];

        let mut parser: Parser<_, Little> = Parser::new(bytes, ParseConfig::default());
        let comm: Comm = parser.parse().unwrap();

        assert_eq!(comm.pid, 0x1010);
        assert_eq!(comm.tid, 0x0500);
        assert_eq!(&*comm.comm, b"test");
    }
}