Struct aya::programs::perf_event::PerfEvent

pub struct PerfEvent { /* private fields */ }

A program that can be attached at a perf event.

Minimum kernel version

The minimum kernel version required to use this feature is 4.9.

Examples

use std::convert::TryInto;
use aya::util::online_cpus;
use aya::programs::perf_event::{
    perf_sw_ids::PERF_COUNT_SW_CPU_CLOCK, PerfEvent, PerfEventScope, PerfTypeId, SamplePolicy,
};

let prog: &mut PerfEvent = bpf.program_mut("observe_cpu_clock").unwrap().try_into()?;
prog.load()?;

for cpu in online_cpus()? {
    prog.attach(
        PerfTypeId::Software,
        PERF_COUNT_SW_CPU_CLOCK as u64,
        PerfEventScope::AllProcessesOneCpu { cpu },
        SamplePolicy::Period(1000000),
    )?;
}

Implementations

impl PerfEvent

pub fn load(&mut self) -> Result<(), ProgramError>

Loads the program inside the kernel.

See also Program::load.

pub fn attach(
    &mut self,
    perf_type: PerfTypeId,
    config: u64,
    scope: PerfEventScope,
    sample_policy: SamplePolicy
) -> Result<LinkRef, ProgramError>

Attaches to the given perf event.

The possible values and encoding of the config argument depends on the perf_type. See perf_sw_ids, perf_hw_id, perf_hw_cache_id, perf_hw_cache_op_id and perf_hw_cache_op_result_id.

Trait Implementations

impl Debug for PerfEvent

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

Formats the value using the given formatter.

impl ProgramFd for PerfEvent

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl ProgramFd for &mut PerfEvent

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl<'a> TryFrom<&'a Program> for &'a PerfEvent

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a Program) -> Result<&'a PerfEvent, ProgramError>

Performs the conversion.

impl<'a> TryFrom<&'a mut Program> for &'a mut PerfEvent

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a mut Program) -> Result<&'a mut PerfEvent, ProgramError>

Performs the conversion.