Type Alias OpenMapMut

pub type OpenMapMut<'obj> = OpenMapImpl<'obj, Mut>;

A mutable parsed but not yet loaded BPF map.

Aliased Type

pub struct OpenMapMut<'obj> { /* private fields */ }

Implementations

impl<'obj> OpenMapMut<'obj>

pub fn new_mut(object: &'obj mut bpf_map) -> Self

Create a new OpenMapMut from a ptr to a libbpf_sys::bpf_map.

pub fn initial_value_mut(&mut self) -> Option<&mut [u8]>

Retrieve the initial value of the map.

pub fn set_map_ifindex(&mut self, idx: u32)

Bind map to a particular network device.

Used for offloading maps to hardware.

pub fn set_initial_value(&mut self, data: &[u8]) -> Result<()>

Set the initial value of the map.

pub fn set_type(&mut self, ty: MapType) -> Result<()>

Set the type of the map.

pub fn set_key_size(&mut self, size: u32) -> Result<()>

Set the key size of the map in bytes.

pub fn set_value_size(&mut self, size: u32) -> Result<()>

Set the value size of the map in bytes.

pub fn set_max_entries(&mut self, count: u32) -> Result<()>

Set the maximum number of entries this map can have.

pub fn set_map_flags(&mut self, flags: u32) -> Result<()>

Set flags on this map.

pub fn set_numa_node(&mut self, numa_node: u32) -> Result<()>

Set the NUMA node for this map.

This can be used to ensure that the map is allocated on a particular NUMA node, which can be useful for performance-critical applications.

pub fn set_inner_map_fd(&mut self, inner_map_fd: BorrowedFd<'_>) -> Result<()>

Set the inner map FD.

This is used for nested maps, where the value type of the outer map is a pointer to the inner map.

pub fn set_map_extra(&mut self, map_extra: u64) -> Result<()>

Set the map_extra field for this map.

Allows users to pass additional data to the kernel when loading the map. The kernel will store this value in the bpf_map_info struct associated with the map.

This can be used to pass data to the kernel that is not otherwise representable via the existing bpf_map_def fields.

pub fn set_autocreate(&mut self, autocreate: bool) -> Result<()>

Set whether or not libbpf should automatically create this map during load phase.

pub fn set_pin_path<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Set where the map should be pinned.

Note this does not actually create the pin.

pub fn reuse_fd(&mut self, fd: BorrowedFd<'_>) -> Result<()>

Reuse an fd for a BPF map

pub fn reuse_pinned_map<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Reuse an already-pinned map for self.

Methods from Deref<Target = OpenMap<'obj>>

pub fn name(&self) -> &OsStr

Retrieve the OpenMap’s name.

pub fn map_type(&self) -> MapType

Retrieve type of the map.

pub fn initial_value(&self) -> Option<&[u8]>

Retrieve the initial value of the map.

pub fn max_entries(&self) -> u32

Retrieve the maximum number of entries of the map.

Trait Implementations

impl<'obj> Deref for OpenMapMut<'obj>

type Target = OpenMapImpl<'obj>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.