Struct libbpf_rs::UserRingBuffer

pub struct UserRingBuffer { /* private fields */ }

Represents a user ring buffer. This is a special kind of map that is used to transfer data between user space and kernel space.

Implementations

impl UserRingBuffer

pub fn new(map: &MapHandle) -> Result<Self>

Create a new user ring buffer from a map.

Errors

• If the map is not a user ring buffer.
• If the underlying libbpf function fails.

pub fn reserve(&self, size: usize) -> Result<UserRingBufferSample<'_>>

Reserve a sample in the user ring buffer.

Returns a UserRingBufferSample that contains a mutable reference to sample that can be written to. The sample must be submitted via UserRingBuffer::submit before it is dropped.

Parameters

• size - The size of the sample in bytes.

This function is not thread-safe. It is necessary to synchronize amongst multiple producers when invoking this function.

pub fn submit(&self, sample: UserRingBufferSample<'_>) -> Result<()>

Submit a sample to the user ring buffer.

This function takes ownership of the sample and submits it to the ring buffer. After submission, the consumer will be able to read the sample from the ring buffer.

This function is thread-safe. It is not necessary to synchronize amongst multiple producers when invoking this function.

Trait Implementations

impl AsRawLibbpf for UserRingBuffer

fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType>

Retrieve the underlying libbpf_sys::user_ring_buffer.

type LibbpfType = user_ring_buffer

The underlying libbpf type.

impl Debug for UserRingBuffer

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

Formats the value using the given formatter.

impl Drop for UserRingBuffer

fn drop(&mut self)

Executes the destructor for this type.