Struct xdpsock::umem::UmemConfig

pub struct UmemConfig { /* fields omitted */ }

Config for a Umem instance.

fill_queue_size and comp_queue_size must be powers of two and frame size must not be less than 2048. If you have set use_huge_pages as true but are getting errors, check that the HugePages_Total setting is non-zero when you run cat /proc/meminfo.

It’s worth noting that the specified frame_size is not necessarily the buffer size that will be available to write data into. Some of this will be eaten up by XDP_PACKET_HEADROOM and any non-zero frame_headroom, so make sure to check that frame_size is large enough to hold the data you with to transmit (e.g. an ETH frame) plus XDP_PACKET_HEADROOM + frame_headroom bytes.

Implementations

impl UmemConfig

pub fn new(
    frame_count: u32,
    frame_size: u32,
    fill_queue_size: u32,
    comp_queue_size: u32,
    frame_headroom: u32,
    use_huge_pages: bool
) -> Result<Self, UmemConfigError>

pub fn frame_count(&self) -> u32

pub fn frame_size(&self) -> u32

pub fn fill_queue_size(&self) -> u32

pub fn comp_queue_size(&self) -> u32

pub fn frame_headroom(&self) -> u32

pub fn use_huge_pages(&self) -> bool

pub fn umem_len(&self) -> usize

Trait Implementations

impl Clone for UmemConfig

fn clone(&self) -> UmemConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UmemConfig

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

Formats the value using the given formatter.

impl Default for UmemConfig

fn default() -> Self

Default configuration based on constants set in the libbpf library.

impl PartialEq<UmemConfig> for UmemConfig

fn eq(&self, other: &UmemConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UmemConfig) -> bool

This method tests for !=.

impl StructuralPartialEq for UmemConfig