mirror of https://github.com/aya-rs/aya
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
2.5 KiB
Rust
88 lines
2.5 KiB
Rust
//! Kernel space probes.
|
|
use std::io;
|
|
use thiserror::Error;
|
|
|
|
use crate::{
|
|
generated::bpf_prog_type::BPF_PROG_TYPE_KPROBE,
|
|
programs::{
|
|
load_program,
|
|
probe::{attach, ProbeKind},
|
|
LinkRef, ProgramData, ProgramError,
|
|
},
|
|
};
|
|
|
|
/// A kernel probe.
|
|
///
|
|
/// Kernel probes are eBPF programs that can be attached to almost any function inside
|
|
/// the kernel. They can be of two kinds:
|
|
///
|
|
/// - `kprobe`: get attached to the *start* of the target functions
|
|
/// - `kretprobe`: get attached to the *return address* of the target functions
|
|
///
|
|
/// # Minimum kernel version
|
|
///
|
|
/// The minimum kernel version required to use this feature is 4.1.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```no_run
|
|
/// # let mut bpf = Bpf::load_file("ebpf_programs.o")?;
|
|
/// use aya::{Bpf, programs::KProbe};
|
|
/// use std::convert::TryInto;
|
|
///
|
|
/// let program: &mut KProbe = bpf.program_mut("intercept_wakeups")?.try_into()?;
|
|
/// program.load()?;
|
|
/// program.attach("try_to_wake_up", 0)?;
|
|
/// # Ok::<(), aya::BpfError>(())
|
|
/// ```
|
|
#[derive(Debug)]
|
|
#[doc(alias = "BPF_PROG_TYPE_KPROBE")]
|
|
pub struct KProbe {
|
|
pub(crate) data: ProgramData,
|
|
pub(crate) kind: ProbeKind,
|
|
}
|
|
|
|
impl KProbe {
|
|
/// Loads the program inside the kernel.
|
|
///
|
|
/// See also [`Program::load`](crate::programs::Program::load).
|
|
pub fn load(&mut self) -> Result<(), ProgramError> {
|
|
load_program(BPF_PROG_TYPE_KPROBE, &mut self.data)
|
|
}
|
|
|
|
/// Returns the name of the program.
|
|
pub fn name(&self) -> String {
|
|
self.data.name.to_string()
|
|
}
|
|
|
|
/// Returns `KProbe` if the program is a `kprobe`, or `KRetProbe` if the
|
|
/// program is a `kretprobe`.
|
|
pub fn kind(&self) -> ProbeKind {
|
|
self.kind
|
|
}
|
|
|
|
/// Attaches the program.
|
|
///
|
|
/// Attaches the probe to the given function name inside the kernel. If
|
|
/// `offset` is non-zero, it is added to the address of the target
|
|
/// function.
|
|
///
|
|
/// If the program is a `kprobe`, it is attached to the *start* address of the target function.
|
|
/// Conversely if the program is a `kretprobe`, it is attached to the return address of the
|
|
/// target function.
|
|
pub fn attach(&mut self, fn_name: &str, offset: u64) -> Result<LinkRef, ProgramError> {
|
|
attach(&mut self.data, self.kind, fn_name, offset, None)
|
|
}
|
|
}
|
|
|
|
/// The type returned when attaching a [`KProbe`] fails.
|
|
#[derive(Debug, Error)]
|
|
pub enum KProbeError {
|
|
#[error("`{filename}`")]
|
|
FileError {
|
|
filename: String,
|
|
#[source]
|
|
io_error: io::Error,
|
|
},
|
|
}
|