Struct AttributeDescription

pub struct AttributeDescription {
    pub attr: PerfEventAttr,
    pub name: Option<String>,
    pub event_ids: Vec<u64>,
}

A single event attr with name and corresponding event IDs.

Fields

attr: PerfEventAttr

name: Option<String>

event_ids: Vec<u64>

Implementations

impl AttributeDescription

pub fn parse_event_desc_section<C: Read + Seek, T: ByteOrder>( cursor: C, ) -> Result<Vec<Self>, Error>

Parse the HEADER_EVENT_DESC section of a perf.data file into a Vec of AttributeDescription structs.

pub fn parse_event_types_section<C: Read + Seek, T: ByteOrder>( cursor: C, event_types_section: &PerfFileSection, attr_size: u64, ) -> Result<Vec<Self>, Error>

Parse the event_types section of a perf.data file into a Vec of AttributeDescription structs. This section was used in the past but is no longer used. Only call this function if event_types_section.size is non-zero.

pub fn parse_simpleperf_attr_section<C: Read + Seek, T: ByteOrder>( cursor: C, attr_section: &PerfFileSection, attr_size: u64, event_types: &[SimplePerfEventType], ) -> Result<Vec<Self>, Error>

Parse the attr section of a perf.data file into a Vec of AttributeDescription structs, for files from Simpleperf. These files pack event ID information into the attr section and contain event names in the SIMPLEPERF_META_INFO section.

pub fn parse_attr_section<C: Read + Seek, T: ByteOrder>( cursor: C, attr_section: &PerfFileSection, attr_size: u64, ) -> Result<Vec<Self>, Error>

Parse the attr section of a perf.data file into a Vec of AttributeDescription structs. This section is used as a last resort because it does not have any information about event IDs. If multiple events are observed, we will not be able to know which event record belongs to which attr.

pub fn attributes(&self) -> &PerfEventAttr

The event attributes.

pub fn name(&self) -> Option<&str>

The event name.

pub fn ids(&self) -> &[u64]

The IDs for this event.

Trait Implementations

impl Clone for AttributeDescription

fn clone(&self) -> AttributeDescription

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AttributeDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.