trace-recorder-parser 0.19.0

A Rust library to parse Percepio's TraceRecorder data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::streaming::event::{Event, EventCode, EventId, EventParser};
use crate::streaming::{EntryTable, Error, HeaderInfo, TimestampInfo};
use crate::types::{Endianness, Heap, Protocol};
use std::io::Read;
use tracing::debug;

/// Encapsulates all of the startup data needed to materialize the events
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub struct RecorderData {
    pub protocol: Protocol,
    pub header: HeaderInfo,
    pub timestamp_info: TimestampInfo,
    pub entry_table: EntryTable,
    parser: EventParser,
}

impl RecorderData {
    pub fn find<R: Read>(r: &mut R) -> Result<Self, Error> {
        debug!("Finding header info");
        let header = HeaderInfo::find(r)?;

        Self::read_common(header, r)
    }

    pub fn read<R: Read>(r: &mut R) -> Result<Self, Error> {
        debug!("Reading header info");
        let header = HeaderInfo::read(r)?;

        Self::read_common(header, r)
    }

    /// Assumes the PSF word (u32) has already been read from the input
    pub fn read_with_endianness<R: Read>(endianness: Endianness, r: &mut R) -> Result<Self, Error> {
        debug!("Reading header info");
        let header = HeaderInfo::read_with_endianness(endianness, r)?;

        Self::read_common(header, r)
    }

    fn read_common<R: Read>(header: HeaderInfo, r: &mut R) -> Result<Self, Error> {
        debug!("Reading timestamp info");
        let timestamp_info = TimestampInfo::read(r, header.endianness, header.format_version)?;

        debug!("Reading entry table");
        let entry_table = EntryTable::read(r, header.endianness)?;

        let parser = EventParser::new(
            header.endianness,
            entry_table.system_heap().unwrap_or_default(),
        );

        Ok(Self {
            protocol: Protocol::Streaming,
            header,
            timestamp_info,
            entry_table,
            parser,
        })
    }

    pub fn system_heap(&self) -> &Heap {
        self.parser.system_heap()
    }

    pub fn set_custom_printf_event_id(&mut self, custom_printf_event_id: EventId) {
        self.parser
            .set_custom_printf_event_id(custom_printf_event_id);
    }

    pub fn read_event<R: Read>(&mut self, r: &mut R) -> Result<Option<(EventCode, Event)>, Error> {
        self.parser.next_event(r, &mut self.entry_table)
    }
}