Struct ProgramData

pub struct ProgramData { /* private fields */ }

ProgramData stores information about bpf programs that are loaded and managed by bpfman.

Implementations

impl ProgramData

pub fn new( location: Location, name: String, metadata: HashMap<String, String>, global_data: HashMap<String, Vec<u8>>, map_owner_id: Option<u32>, ) -> Result<Self, BpfmanError>

Creates a new ProgramData instance.

Arguments

• location - The location of the BPF program (file or image).
• name - The name of the BPF program.
• metadata - Metadata associated with the BPF program.
• global_data - Global data required by the BPF program.
• map_owner_id - Optional owner ID of the map.

Returns

Returns Result<Self, BpfmanError> - An instance of ProgramData or a BpfmanError.

Errors

This function will return an error if:

• The temporary database cannot be opened.
• The program database tree cannot be opened.
• Any of the subsequent setting operations fail (ID, location, name, metadata, global data, map owner ID).

Example

use bpfman::types::{Location, ProgramData};
use bpfman::errors::BpfmanError;
use std::collections::HashMap;

fn main() -> Result<(), BpfmanError> {
    let location = Location::File(String::from("kprobe.o"));
    let metadata = HashMap::new();
    let global_data = HashMap::new();
    let map_owner_id = None;
    let program_data = ProgramData::new(
        location,
        String::from("kprobe_do_sys_open"),
        metadata,
        global_data,
        map_owner_id
    )?;
    println!("program_data: {:?}", program_data);
    Ok(())
}

pub fn get_kind(&self) -> Result<Option<ProgramType>, BpfmanError>

Retrieves the kind of program, which is represented by the ProgramType structure.

Returns

Returns Result<Option<ProgramType>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kind from the database.

pub fn get_name(&self) -> Result<String, BpfmanError>

Retrieves the name of the program.

Returns

Returns Result<String, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the name from the database.

pub fn get_id(&self) -> Result<u32, BpfmanError>

Retrieves the kernel ID of the program.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the ID from the database.

pub fn get_location(&self) -> Result<Location, BpfmanError>

Retrieves the location of the program.

Returns

Returns Result<Location, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the location from the database.

pub fn get_global_data(&self) -> Result<HashMap<String, Vec<u8>>, BpfmanError>

Retrieves the global data of the program.

Returns

Returns Result<HashMap<String, Vec<u8>>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the global data from the database.

pub fn get_metadata(&self) -> Result<HashMap<String, String>, BpfmanError>

Retrieves the metadata of the program.

Returns

Returns Result<HashMap<String, String>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the metadata from the database.

pub fn get_map_owner_id(&self) -> Result<Option<u32>, BpfmanError>

Retrieves the owner ID of the map.

Returns

Returns Result<Option<u32>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the map owner ID from the database.

pub fn get_map_pin_path(&self) -> Result<Option<PathBuf>, BpfmanError>

Retrieves the map pin path.

Returns

Returns Result<Option<PathBuf>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the map pin path from the database.

pub fn get_maps_used_by(&self) -> Result<Vec<u32>, BpfmanError>

Retrieves the IDs of maps used by the program.

Returns

Returns Result<Vec<u32>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the maps used by from the database.

pub fn get_kernel_name(&self) -> Result<String, BpfmanError>

Retrieves the name of the program.

Returns

Returns Result<String, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel name from the database.

pub fn get_kernel_program_type(&self) -> Result<u32, BpfmanError>

Retrieves the kernel program type.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel program type from the database.

pub fn get_kernel_loaded_at(&self) -> Result<String, BpfmanError>

Retrieves the kernel loaded timestamp.

Returns

Returns Result<String, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel loaded timestamp from the database.

pub fn get_kernel_tag(&self) -> Result<String, BpfmanError>

Retrieves the kernel tag.

Returns

Returns Result<String, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel tag from the database.

pub fn get_kernel_gpl_compatible(&self) -> Result<bool, BpfmanError>

Retrieves whether the kernel is GPL compatible.

Returns

Returns Result<bool, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel GPL compatibility status from the database.

pub fn get_kernel_map_ids(&self) -> Result<Vec<u32>, BpfmanError>

Retrieves the IDs of kernel maps.

Returns

Returns Result<Vec<u32>, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel map IDs from the database.

pub fn get_kernel_btf_id(&self) -> Result<u32, BpfmanError>

Retrieves the BTF ID of the kernel.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel BTF ID from the database.

pub fn get_kernel_bytes_xlated(&self) -> Result<u32, BpfmanError>

Retrieves the translated bytes of the kernel program.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel translated bytes from the database.

pub fn get_kernel_jited(&self) -> Result<bool, BpfmanError>

Retrieves whether the kernel program is JIT compiled.

Returns

Returns Result<bool, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel JIT status from the database.

pub fn get_kernel_bytes_jited(&self) -> Result<u32, BpfmanError>

Retrieves the JIT compiled bytes of the kernel program.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel JIT compiled bytes from the database.

pub fn get_kernel_bytes_memlock(&self) -> Result<u32, BpfmanError>

Retrieves the memory lock bytes of the kernel program.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel memory lock bytes from the database.

pub fn get_kernel_verified_insns(&self) -> Result<u32, BpfmanError>

Retrieves the number of verified instructions of the kernel program.

Returns

Returns Result<u32, BpfmanError>.

Errors

This function will return an error if:

• There is an issue fetching the kernel verified instructions count from the database.

Trait Implementations

impl Clone for ProgramData

fn clone(&self) -> ProgramData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgramData

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

Formats the value using the given formatter.