Struct bpf_script::TypeDatabase

source ·

pub struct TypeDatabase { /* private fields */ }

Expand description

Holds type information.

Implementations

source

impl TypeDatabase

source

pub fn add_btf_types(&mut self, btf: &Btf) -> Result<()>

Adds a parsed list of BTF types to this type database.

Arguments

name - The optional name of the type.
btf - The BTF types.

Example

use bpf_script::TypeDatabase;
use btf::Btf;

let btf = Btf::from_file("/sys/kernel/btf/vmlinux").expect("Failed to parse vmlinux btf");
let mut database = TypeDatabase::default();

database
    .add_btf_types(&btf)
    .expect("failed to add btf types");
database
    .get_type_by_name("task_struct")
    .expect("Couldn't find task_struct");

source

impl TypeDatabase

source

pub fn add_type(&mut self, name: Option<&str>, ty: &Type) -> Result<usize>

Adds a type to the type database.

Arguments

name - The name of the type.
ty - The type to add.

source

pub fn get_type_by_name(&self, name: &str) -> Option<&Type>

Finds a type in the database by name.

Arguments

name - The name of the type.

source

pub fn get_type_by_id(&self, id: usize) -> Option<&Type>

Finds a type in the database by id.

Arguments

id - The id of the type.

source

pub fn get_type_id_by_name(&self, name: &str) -> Option<usize>

Gets a type’s id by its name.

Arguments

name - The name of the type.

source

pub fn add_integer(
 &mut self,
 name: Option<&str>,
 bytes: u32,
 is_signed: bool
) -> Result<usize>

Convenience function for adding an integer type to the database.

Arguments

name - The name of the type.
bytes - The number of bits
is_signed - If the integer is signed.

source

pub fn add_float(&mut self, name: Option<&str>, bits: u32) -> Result<usize>

Convenience function for adding a float type to the database.

Arguments

name - The name of the type.
bits - The number of bits.

source

pub fn add_array(
 &mut self,
 name: Option<&str>,
 element_type_id: usize,
 num_elements: u32
) -> Result<usize>

Convenience function for adding an array to the database.

Arguments

name - The name of the type.
element_type_id - The type id of the element.
num_elements - The number of elements in the array.

source

pub fn add_struct(
 &mut self,
 name: Option<&str>,
 fields: &[(&str, Field)]
) -> Result<usize>

Convenience function for adding a struct to the database.

Arguments

name - The name of the type.
fields - The fields to add.

source

pub fn add_struct_by_names(
 &mut self,
 name: Option<&str>,
 fields: &[(&str, &str)]
) -> Result<usize>

Convenience function for adding a struct to the database using a slice of (field_name, type_name). Types are added in order, and packed together contiguously.