Struct EbpfPtr 

pub struct EbpfPtr<'a, T> { /* private fields */ }

Pointer to a buffer that may be shared between eBPF programs. It allows to safely pass around pointers to the data stored in eBPF maps and access the data referenced by the pointer.

Implementations

impl<'a, T> EbpfPtr<'a, T>

where T: Sized,

pub unsafe fn new(ptr: *mut T) -> Self

Creates a new EbpfPtr from the specified pointer.

Safety

Caller must ensure that the buffer referenced by ptr is valid for lifetime 'a and there are no other mutable references to the same memory.

pub unsafe fn deref(&self) -> &'a T

Safety

Caller must ensure that the value cannot be updated by other threads while the returned reference is live.

pub unsafe fn deref_mut(&self) -> &'a mut T

Safety

Caller must ensure that the value is not being used by other threads.

pub fn get_field<F, const OFFSET: usize>(&self) -> EbpfPtr<'a, F>

pub fn ptr(&self) -> *mut T

impl EbpfPtr<'_, u64>

pub fn load_relaxed(&self) -> u64

Loads the value referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 8-byte aligned.

pub fn store_relaxed(&self, value: u64)

Stores the value at the memory referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 8-byte aligned.

impl EbpfPtr<'_, u32>

pub fn load_relaxed(&self) -> u32

Loads the value referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 4-byte aligned.

pub fn store_relaxed(&self, value: u32)

Stores the value at the memory referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 4-byte aligned.

impl EbpfPtr<'_, i32>

pub fn load_relaxed(&self) -> i32

Loads the value referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 4-byte aligned.

pub fn store_relaxed(&self, value: i32)

Stores the value at the memory referenced by the pointer. Atomicity is guaranteed if and only if the pointer is 4-byte aligned.

Trait Implementations

impl<'a, T> Clone for EbpfPtr<'a, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> From<&'a mut T> for EbpfPtr<'a, T>

where T: IntoBytes + FromBytes + Sized,

fn from(value: &'a mut T) -> Self

Converts to this type from the input type.

impl<'a, T> From<EbpfPtr<'a, T>> for BpfValue

fn from(value: EbpfPtr<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> ProgramArgument for EbpfPtr<'a, T>

where &'a mut T: ProgramArgument,

Implements ProgramArgument for EbpfPtr when it’s implemented for &'a mut T.

fn get_type() -> &'static Type

Returns eBPF type that corresponds to Self. Used when program argument types are checked statically.

fn field_mappings() -> &'static [FieldMapping]

Returns the list of field mappings that should be applied with this argument. If not empty then get_type() must be a PtrToStruct.

fn struct_mapping() -> Option<StructMapping>

Returns the StructMapping that should be applied with this argument. Implementations should override field_mappings() and keep default implementation of struct_mapping().

fn get_value_type(&self) -> Type

Returns eBPF type for a specific value of Self. For most types this is the same type that’s returned by get_type(), but that’s not always the case. In particular for scalar values this will return Type::ScalarValue with the actual value of the scalar and with unknown_mask = 0.

impl<'a, T> Copy for EbpfPtr<'a, T>

impl<'a, T> Send for EbpfPtr<'a, T>

impl<'a, T> Sync for EbpfPtr<'a, T>