trace-recorder-parser 0.19.0

use derive_more::{
    Add, AddAssign, Binary, Deref, Display, Into, LowerHex, MulAssign, Octal, Sub, Sum, UpperHex,
};
use std::ops;

/// Frequency of the clock/timer/counter used as time base
#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Display,
    Deref,
    Into,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
    Add,
    Sum,
    AddAssign,
    MulAssign,
)]
#[display(fmt = "{_0}")]
pub struct Frequency(pub(crate) u32);

impl Frequency {
    pub fn is_unitless(&self) -> bool {
        self.0 == 0
    }

    pub fn get_raw(&self) -> u32 {
        self.0
    }
}

#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Display,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
    Add,
    Sub,
    Sum,
    AddAssign,
    MulAssign,
    Into,
)]
#[display(fmt = "{_0}")]
pub struct Ticks(pub(crate) u32);

impl Ticks {
    pub const fn zero() -> Self {
        Self(0)
    }

    pub const fn get_raw(&self) -> u32 {
        self.0
    }

    pub fn new(ticks: u32) -> Self {
        Self(ticks)
    }
}

/// Timestamp (in ticks).
/// Stores accumulated differential timestamps in snapshot mode and device timer instant
/// in streaming mode.
///
/// Note that in streaming mode this can rollover. `StreamingInstant` can be used to
/// track the rollovers.
#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Display,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
    Add,
    Sub,
    Sum,
    AddAssign,
    MulAssign,
    Into,
)]
#[display(fmt = "{_0}")]
pub struct Timestamp(pub(crate) u64);

impl Timestamp {
    pub const fn zero() -> Self {
        Self(0)
    }

    pub const fn get_raw(&self) -> u64 {
        self.0
    }

    pub const fn ticks(&self) -> u64 {
        self.get_raw()
    }
}

impl From<Ticks> for Timestamp {
    fn from(t: Ticks) -> Self {
        Timestamp(t.0.into())
    }
}

impl ops::Add<DifferentialTimestamp> for Timestamp {
    type Output = Timestamp;

    fn add(self, dt: DifferentialTimestamp) -> Timestamp {
        Timestamp(
            self.0
                .checked_add(u64::from(dt.0))
                .expect("Overflow when adding differential time to timestamp"),
        )
    }
}

impl ops::AddAssign<DifferentialTimestamp> for Timestamp {
    fn add_assign(&mut self, dt: DifferentialTimestamp) {
        self.0 = self
            .0
            .checked_add(u64::from(dt.0))
            .expect("Overflow when adding differential time to timestamp")
    }
}

/// Time (in ticks) since the previous event in the recorder log.
/// Can be up to 4 bytes in size, depending on how many DTS bytes are
/// available in the event at hand and how much time has elapsed since
/// the previous event.
#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Display,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
    Add,
    Sum,
    AddAssign,
    MulAssign,
)]
#[display(fmt = "{_0}")]
pub struct DifferentialTimestamp(pub(crate) u32);

impl DifferentialTimestamp {
    pub fn ticks(&self) -> Ticks {
        Ticks(self.0)
    }
}

impl DifferentialTimestamp {
    /// Construct a differential timestamp from the data of an XTS8 event.
    /// XTS8 events contain the upper 3 bytes, and the event following contains
    /// the lower byte.
    pub(crate) fn from_xts8(xts_8: u8, xts_16: u16) -> Self {
        DifferentialTimestamp(u32::from(xts_8) << 24 | (u32::from(xts_16) << 8))
    }

    /// Construct a differential timestamp from the data of an XTS16 event.
    /// XTS16 events contain the upper 2 bytes, and the event following contains
    /// the lower 2 bytes.
    pub(crate) fn from_xts16(xts_16: u16) -> Self {
        DifferentialTimestamp(u32::from(xts_16) << 16)
    }

    pub const fn zero() -> Self {
        Self(0)
    }

    pub fn clear(&mut self) {
        self.0 = 0;
    }
}

impl ops::AddAssign<Dts8> for DifferentialTimestamp {
    fn add_assign(&mut self, dts: Dts8) {
        self.0 = self
            .0
            .checked_add(u32::from(dts.0))
            .expect("Overflow when adding DTS8 to differential time")
    }
}

impl ops::AddAssign<Dts16> for DifferentialTimestamp {
    fn add_assign(&mut self, dts: Dts16) {
        self.0 = self
            .0
            .checked_add(u32::from(dts.0))
            .expect("Overflow when adding DTS16 to differential time")
    }
}

/// The lower 8-bit portion of a differential timestamp recorded in an event
#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Into,
    Display,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
)]
#[display(fmt = "{_0}")]
pub struct Dts8(pub(crate) u8);

/// The lower 16-bit portion of a differential timestamp recorded in an event
#[derive(
    Copy,
    Clone,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Debug,
    Into,
    Display,
    Binary,
    Octal,
    LowerHex,
    UpperHex,
)]
#[display(fmt = "{_0}")]
pub struct Dts16(pub(crate) u16);

/// A monotonic clock measurement in ticks for tracking rollovers
/// of streaming protocol timestamps.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Display)]
#[display(fmt = "{}", "self.to_timestamp()")]
pub struct StreamingInstant {
    lower: u32,
    upper: u32,
}

impl StreamingInstant {
    pub const fn zero() -> Self {
        Self { lower: 0, upper: 0 }
    }

    pub const fn new(lower: u32, upper: u32) -> Self {
        Self { lower, upper }
    }

    pub const fn from_initial_value(initial_value: u64) -> Self {
        Self {
            lower: initial_value as u32,
            upper: (initial_value >> 32) as u32,
        }
    }

    pub fn elapsed(&mut self, now: Timestamp) -> Timestamp {
        // Streaming protocol timestamps are always 32 bits
        let now = now.0 as u32;

        // Check for rollover on the lower
        if now < self.lower {
            self.upper += 1;
        }

        self.lower = now;

        self.to_timestamp()
    }

    pub fn to_timestamp(&self) -> Timestamp {
        Timestamp(u64::from(self.upper) << 32 | u64::from(self.lower))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn differential_time_xts16() {
        let mut accumulated_time = Timestamp::zero();
        accumulated_time.0 += 0x0F;
        assert_eq!(accumulated_time.ticks(), 0x0F);

        let xts_16 = 0x00_03;
        let mut dts_for_next_event = DifferentialTimestamp::from_xts16(xts_16);
        assert_eq!(dts_for_next_event.ticks().0, 0x00_03_00_00);

        let dts = Dts16(0x5F_D5);
        dts_for_next_event += dts;
        assert_eq!(dts_for_next_event.ticks().0, 0x00_03_5F_D5);

        accumulated_time += dts_for_next_event;
        assert_eq!(accumulated_time.ticks(), 0x00_03_5F_D5 + 0x0F);
    }

    #[test]
    fn differential_time_xts8() {
        let mut accumulated_time = Timestamp::zero();
        accumulated_time.0 += 0x0F;
        assert_eq!(accumulated_time.ticks(), 0x0F);

        let xts_16 = 0x11_22;
        let xts_8 = 0xE1;
        let mut dts_for_next_event = DifferentialTimestamp::from_xts8(xts_8, xts_16);
        assert_eq!(dts_for_next_event.ticks().0, 0xE1_11_22_00);

        let dts = Dts8(0x33);
        dts_for_next_event += dts;
        assert_eq!(dts_for_next_event.ticks().0, 0xE1_11_22_33);

        accumulated_time += dts_for_next_event;
        assert_eq!(accumulated_time.ticks(), 0xE1_11_22_33 + 0x0F);
    }

    #[test]
    fn streaming_instant_rollover() {
        // 5 ms before rollover
        let t0 = Timestamp(4_294_967_290);

        // 10 ms after rollover
        let t1 = Timestamp(10);

        let mut instant = StreamingInstant::zero();
        assert_eq!(instant.elapsed(t0), t0);

        let t2 = instant.elapsed(t1);
        assert_eq!(t0.ticks() + 16, t2.ticks());
    }

    #[test]
    fn streaming_instant_construction() {
        let mut t = StreamingInstant::from_initial_value(u64::from(u32::MAX) + 1);
        assert_eq!(t.lower, 0);
        assert_eq!(t.upper, 1);
        let t0 = Timestamp(2);
        let instant = t.elapsed(t0);
        assert_eq!(t.lower, 2);
        assert_eq!(t.upper, 1);
        assert_eq!(instant.0, u64::from(u32::MAX) + 3);
    }
}