Struct libbpf_rs::btf::Btf

pub struct Btf<'source> { /* private fields */ }

The btf information of a bpf object.

The lifetime bound protects against this object outliving its source. This can happen when it was derived from an Object, which owns the data this structs points too. When instead the Btf::from_path method is used, the lifetime will be 'static since it doesn’t borrow from anything.

Implementations

impl Btf<'static>

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Load the btf information from specified path.

pub fn from_vmlinux() -> Result<Self>

Load the vmlinux btf information from few well-known locations.

pub fn from_prog_id(id: u32) -> Result<Self>

Load the btf information of an bpf object from a program id.

impl<'btf> Btf<'btf>

pub fn from_bpf_object(obj: &'btf bpf_object) -> Result<Option<Self>>

Create a new Btf instance from the given libbpf_sys::bpf_object.

pub fn from_raw( name: &'btf str, object_file: &'btf [u8], ) -> Result<Option<Self>>

From raw bytes coming from an object file.

pub fn is_empty(&self) -> bool

Whether this btf instance has no types.

pub fn len(&self) -> usize

The number of BtfTypes in this object.

pub fn ptr_size(&self) -> Result<NonZeroUsize>

The btf pointer size.

pub fn type_by_name<'s, K>(&'s self, name: &str) -> Option<K>

where K: TryFrom<BtfType<'s>>,

Find a btf type by name

Panics

If name has null bytes.

pub fn type_by_id<'s, K>(&'s self, type_id: TypeId) -> Option<K>

where K: TryFrom<BtfType<'s>>,

Find a type by it’s TypeId.

pub fn type_by_kind<'s, K>(&'s self) -> impl Iterator<Item = K> + 's

where K: TryFrom<BtfType<'s>>,

Find all types of a specific type kind.

Trait Implementations

impl AsRawLibbpf for Btf<'_>

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

Retrieve the underlying libbpf_sys::btf object.

type LibbpfType = btf

The underlying libbpf type.

impl Debug for Btf<'_>

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

Formats the value using the given formatter.

impl Drop for Btf<'_>

fn drop(&mut self)

Executes the destructor for this type.