Struct TypeInformation 

pub struct TypeInformation { /* private fields */ }

Type information acquired from the BTF data

Implementations

impl TypeInformation

pub fn new(readable: &dyn Readable) -> BTFResult<Self>

Creates a new TypeInformation object

Examples found in repository

examples/dump-btf.rs (line 44)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 2 {
        println!("Usage:\n\tdump-btf /path/to/btf/file\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();
    println!("{:?}", type_information.get());
}

examples/get-type-size.rs (line 46)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 3 {
        println!("Usage:\n\tget-type-size /path/to/btf/file <type_name>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();

    let type_id = type_information.id_of(btf_type_name).unwrap();
    let type_size = type_information.size_of(type_id).unwrap();
    println!("Type {btf_type_name} has ID {type_id} and requires {type_size} bytes in total");
}

examples/get-type-offset.rs (line 47)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 4 {
        println!("Usage:\n\tget-type-offset /path/to/btf/file <type_name> <path>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];
    let type_path = &argument_list[3];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();
    let offset = type_information
        .offset_of(type_information.id_of(btf_type_name).unwrap(), type_path)
        .unwrap();

    println!("{btf_type_name} => {type_path}: {offset:?}");
}

pub fn get(&self) -> &BTreeMap<u32, TypeVariant>

Returns the entire type map

Examples found in repository

examples/dump-btf.rs (line 45)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 2 {
        println!("Usage:\n\tdump-btf /path/to/btf/file\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();
    println!("{:?}", type_information.get());
}

pub fn id_of(&self, type_name: &str) -> Option<u32>

Returns the type id for the given type name

Examples found in repository

examples/get-type-size.rs (line 48)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 3 {
        println!("Usage:\n\tget-type-size /path/to/btf/file <type_name>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();

    let type_id = type_information.id_of(btf_type_name).unwrap();
    let type_size = type_information.size_of(type_id).unwrap();
    println!("Type {btf_type_name} has ID {type_id} and requires {type_size} bytes in total");
}

examples/get-type-offset.rs (line 49)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 4 {
        println!("Usage:\n\tget-type-offset /path/to/btf/file <type_name> <path>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];
    let type_path = &argument_list[3];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();
    let offset = type_information
        .offset_of(type_information.id_of(btf_type_name).unwrap(), type_path)
        .unwrap();

    println!("{btf_type_name} => {type_path}: {offset:?}");
}

pub fn from_id(&self, tid: u32) -> Option<TypeVariant>

Returns the type object for the given type id

pub fn name_of(&self, tid: u32) -> Option<String>

Returns the name of the given type id

pub fn pointee_tid(&self, tid: u32) -> BTFResult<u32>

Returns the pointee type id

pub fn size_of(&self, tid: u32) -> BTFResult<usize>

Returns the size of the given type id

Examples found in repository

examples/get-type-size.rs (line 49)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 3 {
        println!("Usage:\n\tget-type-size /path/to/btf/file <type_name>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();

    let type_id = type_information.id_of(btf_type_name).unwrap();
    let type_size = type_information.size_of(type_id).unwrap();
    println!("Type {btf_type_name} has ID {type_id} and requires {type_size} bytes in total");
}

pub fn offset_of(&self, tid: u32, path: &str) -> BTFResult<(u32, Offset)>

Returns a tuple containing the next type id and the current offset

Examples found in repository

examples/get-type-offset.rs (line 49)

fn main() {
    let argument_list: Vec<String> = env::args().collect();
    if argument_list.len() != 4 {
        println!("Usage:\n\tget-type-offset /path/to/btf/file <type_name> <path>\n");
        return;
    }

    let btf_file_path = Path::new(&argument_list[1]);
    let btf_type_name = &argument_list[2];
    let type_path = &argument_list[3];

    println!("Opening BTF file: {btf_file_path:?}");

    let vmlinux_btf_file = ReadableFile::new(btf_file_path);
    let type_information = TypeInformation::new(&vmlinux_btf_file).unwrap();
    let offset = type_information
        .offset_of(type_information.id_of(btf_type_name).unwrap(), type_path)
        .unwrap();

    println!("{btf_type_name} => {type_path}: {offset:?}");
}