Struct Btf

pub struct Btf { /* private fields */ }

Main representation of a parsed BTF object. Provides helpers to resolve types and their associated names.

Implementations

impl Btf

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Btf>

Parse a stand-alone BTF object file and construct a Rust representation for later use. Trying to open split BTF files using this function will fail. For split BTF files use Btf::from_split_file().

pub fn from_split_file<P: AsRef<Path>>(path: P, base: &Btf) -> Result<Btf>

Parse a split BTF object file and construct a Rust representation for later use. A base Btf object must be provided.

pub fn from_bytes(bytes: &[u8]) -> Result<Btf>

Performs the same actions as from_file(), but fed with a byte slice.

pub fn from_split_bytes(bytes: &[u8], base: &Btf) -> Result<Btf>

Performs the same actions as from_split_file(), but fed with a byte slice.

pub fn resolve_ids_by_name(&self, name: &str) -> Result<Vec<u32>>

Find a list of BTF ids using their name as a key.

pub fn resolve_type_by_id(&self, id: u32) -> Result<Type>

Find a BTF type using its id as a key.

pub fn resolve_types_by_name(&self, name: &str) -> Result<Vec<Type>>

Find a list of BTF types using their name as a key.

pub fn resolve_name<T: BtfType + ?Sized>(&self, type: &T) -> Result<String>

Resolve a name referenced by a Type which is defined in the current BTF object.

pub fn resolve_chained_type<T: BtfType + ?Sized>( &self, type: &T, ) -> Result<Type>

Types can have a reference to another one, e.g. Ptr -> Int. This helper resolve a Type referenced in an other one. It is the main helper to traverse the Type tree.

pub fn type_iter<'a, T: BtfType + ?Sized>(&'a self, type: &'a T) -> TypeIter<'_>

This helper returns an iterator that allow to resolve a Type referenced in another one all the way down to the chain. The helper makes use of Btf::resolve_chained_type().