Struct aya::programs::trace_point::TracePoint

pub struct TracePoint { /* private fields */ }

A program that can be attached at a pre-defined kernel trace point.

The kernel provides a set of pre-defined trace points that eBPF programs can be attached to. See /sys/kernel/debug/tracing/events for a list of which events can be traced.

Minimum kernel version

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

Examples

use std::convert::TryInto;
use aya::programs::TracePoint;

let prog: &mut TracePoint = bpf.program_mut("trace_context_switch").unwrap().try_into()?;
prog.load()?;
prog.attach("sched", "sched_switch")?;

Implementations

impl TracePoint

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

Loads the program inside the kernel.

pub fn attach(
    &mut self,
    category: &str,
    name: &str
) -> Result<TracePointLinkId, ProgramError>

Attaches to a given trace point.

For a list of the available event categories and names, see /sys/kernel/debug/tracing/events.

The returned value can be used to detach, see TracePoint::detach.

pub fn detach(&mut self, link_id: TracePointLinkId) -> Result<(), ProgramError>

Detaches from a trace point.

See TracePoint::attach.

pub fn take_link(
    &mut self,
    link_id: TracePointLinkId
) -> Result<OwnedLink<TracePointLink>, ProgramError>

Takes ownership of the link referenced by the provided link_id.

The link will be detached on Drop and the caller is now responsible for managing its lifetime.

impl TracePoint

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

Unloads the program from the kernel.

Links will be detached before unloading the program. Note that owned links obtained using take_link() will not be detached.

Trait Implementations

impl Debug for TracePoint

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

Formats the value using the given formatter.

impl ProgramFd for TracePoint

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

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

impl ProgramFd for &mut TracePoint

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 TracePoint

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.