Struct aya::maps::perf::PerfEventArrayBuffer

pub struct PerfEventArrayBuffer<T: DerefMut<Target = Map>> { /* private fields */ }

A ring buffer that can receive events from eBPF programs.

PerfEventArrayBuffer is a ring buffer that can receive events from eBPF programs that use bpf_perf_event_output(). It’s returned by PerfEventArray::open.

See the PerfEventArray documentation for an overview of how to use perf buffers.

Implementations

impl<T: DerefMut<Target = Map>> PerfEventArrayBuffer<T>

pub fn readable(&self) -> bool

Returns true if the buffer contains events that haven’t been read.

pub fn read_events(
    &mut self,
    out_bufs: &mut [BytesMut]
) -> Result<Events, PerfBufferError>

Reads events from the buffer.

This method reads events into the provided slice of buffers, filling each buffer in order stopping when there are no more events to read or all the buffers have been filled.

Returns the number of events read and the number of events lost. Events are lost when user space doesn’t read events fast enough and the ring buffer fills up.

Errors

PerfBufferError::NoBuffers is returned when out_bufs is empty.

Trait Implementations

impl<T: DerefMut<Target = Map>> AsRawFd for PerfEventArrayBuffer<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.