Struct ProgramImpl

pub struct ProgramImpl<'obj, T = ()> { /* private fields */ }

Represents a loaded Program.

This struct is not safe to clone because the underlying libbpf resource cannot currently be protected from data races.

If you attempt to attach a Program with the wrong attach method, the attach_* method will fail with the appropriate error.

Implementations

impl<'obj> ProgramImpl<'obj>

pub fn new(prog: &'obj bpf_program) -> Self

Create a Program from a libbpf_sys::bpf_program

pub fn name(&self) -> &OsStr

Retrieve the name of this Program.

pub fn section(&self) -> &OsStr

Retrieve the name of the section this Program belongs to.

pub fn prog_type(&self) -> ProgramType

Retrieve the type of the program.

pub fn get_fd_by_id(id: u32) -> Result<OwnedFd>

👎Deprecated: renamed to Program::fd_from_id

pub fn fd_from_id(id: u32) -> Result<OwnedFd>

Returns program file descriptor given a program ID.

pub fn get_id_by_fd(fd: BorrowedFd<'_>) -> Result<u32>

👎Deprecated: renamed to Program::id_from_fd

pub fn id_from_fd(fd: BorrowedFd<'_>) -> Result<u32>

Returns program ID given a file descriptor.

pub fn fd_from_pinned_path<P: AsRef<Path>>(path: P) -> Result<OwnedFd>

Returns fd of a previously pinned program

Returns error, if the pinned path doesn’t represent an eBPF program.

pub fn flags(&self) -> u32

Returns flags that have been set for the program.

pub fn attach_type(&self) -> ProgramAttachType

Retrieve the attach type of the program.

pub fn autoload(&self) -> bool

Return true if the bpf program is set to autoload, false otherwise.

pub fn log_level(&self) -> u32

Return the bpf program’s log level.

pub fn insn_cnt(&self) -> usize

Returns the number of instructions that form the program.

Please see note in OpenProgram::insn_cnt.

pub fn insns(&self) -> &[bpf_insn]

Gives read-only access to BPF program’s underlying BPF instructions.

Please see note in OpenProgram::insns.

impl<'obj> ProgramImpl<'obj, Mut>

pub fn new_mut(prog: &'obj mut bpf_program) -> Self

Create a Program from a libbpf_sys::bpf_program

pub fn pin<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Pin this program to bpffs.

pub fn unpin<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Unpin this program from bpffs

pub fn attach(&self) -> Result<Link>

Auto-attach based on prog section

pub fn attach_cgroup(&self, cgroup_fd: i32) -> Result<Link>

Attach this program to a cgroup.

pub fn attach_perf_event(&self, pfd: i32) -> Result<Link>

Attach this program to a perf event.

pub fn attach_uprobe<T: AsRef<Path>>( &self, retprobe: bool, pid: i32, binary_path: T, func_offset: usize, ) -> Result<Link>

Attach this program to a userspace probe.

pub fn attach_uprobe_with_opts( &self, pid: i32, binary_path: impl AsRef<Path>, func_offset: usize, opts: UprobeOpts, ) -> Result<Link>

Attach this program to a userspace probe, providing additional options.

pub fn attach_kprobe<T: AsRef<str>>( &self, retprobe: bool, func_name: T, ) -> Result<Link>

Attach this program to a kernel probe.

pub fn attach_ksyscall<T: AsRef<str>>( &self, retprobe: bool, syscall_name: T, ) -> Result<Link>

Attach this program to the specified syscall

pub fn attach_tracepoint( &self, tp_category: impl AsRef<str>, tp_name: impl AsRef<str>, ) -> Result<Link>

Attach this program to a kernel tracepoint.

pub fn attach_tracepoint_with_opts( &self, tp_category: impl AsRef<str>, tp_name: impl AsRef<str>, tp_opts: TracepointOpts, ) -> Result<Link>

Attach this program to a kernel tracepoint, providing additional options.

pub fn attach_raw_tracepoint<T: AsRef<str>>(&self, tp_name: T) -> Result<Link>

Attach this program to a raw kernel tracepoint.

pub fn attach_lsm(&self) -> Result<Link>

Attach to an LSM hook

pub fn attach_trace(&self) -> Result<Link>

Attach to a fentry/fexit kernel probe

pub fn attach_sockmap(&self, map_fd: i32) -> Result<()>

Attach a verdict/parser to a sockmap/sockhash

pub fn attach_xdp(&self, ifindex: i32) -> Result<Link>

Attach this program to XDP

pub fn attach_netns(&self, netns_fd: i32) -> Result<Link>

Attach this program to netns-based programs

pub fn attach_netfilter_with_opts( &self, netfilter_opt: NetfilterOpts, ) -> Result<Link>

Attach this program to netfilter programs

pub fn attach_usdt( &self, pid: i32, binary_path: impl AsRef<Path>, usdt_provider: impl AsRef<str>, usdt_name: impl AsRef<str>, ) -> Result<Link>

Attach this program to a USDT probe point. The entry point of the program must be defined with SEC("usdt").

pub fn attach_usdt_with_opts( &self, pid: i32, binary_path: impl AsRef<Path>, usdt_provider: impl AsRef<str>, usdt_name: impl AsRef<str>, usdt_opts: UsdtOpts, ) -> Result<Link>

Attach this program to a USDT probe point, providing additional options. The entry point of the program must be defined with SEC("usdt").

pub fn attach_iter(&self, map_fd: BorrowedFd<'_>) -> Result<Link>

Attach this program to a BPF Iterator. The entry point of the program must be defined with SEC("iter") or SEC("iter.s").

pub fn test_run<'dat>(&self, input: Input<'dat>) -> Result<Output<'dat>>

Test run the program with the given input data.

This function uses the BPF_PROG_RUN facility.

Trait Implementations

impl<T> AsFd for ProgramImpl<'_, T>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<T> AsRawLibbpf for ProgramImpl<'_, T>

fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType>

Retrieve the underlying libbpf_sys::bpf_program.

type LibbpfType = bpf_program

The underlying libbpf type.

impl<'obj, T: Debug> Debug for ProgramImpl<'obj, T>

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

Formats the value using the given formatter.