Struct aya::programs::UProbe

pub struct UProbe { /* fields omitted */ }

An user space probe.

User probes are eBPF programs that can be attached to any userspace function. They can be of two kinds:

• uprobe: get attached to the start of the target functions
• uretprobe: get attached to the return address of the target functions

Implementations

impl UProbe

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

Loads the program inside the kernel.

See also Program::load.

pub fn name(&self) -> String

Returns the name of the program.

pub fn kind(&self) -> ProbeKind

Returns UProbe if the program is a uprobe, or URetProbe if the program is a uretprobe.

pub fn attach<T: AsRef<Path>>(
    &mut self,
    fn_name: Option<&str>,
    offset: u64,
    target: T,
    pid: Option<pid_t>
) -> Result<LinkRef, ProgramError>

Attaches the program.

Attaches the uprobe to the function fn_name defined in the target. If offset is non-zero, it is added to the address of the target function. If pid is not None, the program executes only when the target function is executed by the given pid.

The target argument can be an absolute path to a binary or library, or a library name (eg: "libc").

If the program is an uprobe, it is attached to the start address of the target function. Instead if the program is a kretprobe, it is attached to the return address of the target function.

Trait Implementations

impl Debug for UProbe

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

Formats the value using the given formatter.

impl ProgramFd for UProbe

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

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ProgramError

The type returned in the event of a conversion error.

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

Performs the conversion.