Trait KernelAuxiliaryOps 

pub trait KernelAuxiliaryOps:
    Send
    + Sync
    + 'static {
    type MapLock: RawMutex + 'static;

    // Required methods
    fn get_unified_map_from_ptr<F, R>(ptr: *const u8, func: F) -> BpfResult<R>
       where F: FnOnce(&UnifiedMap<Self::MapLock>) -> BpfResult<R>;
    fn get_unified_map_from_fd<F, R>(map_fd: u32, func: F) -> BpfResult<R>
       where F: FnOnce(&UnifiedMap<Self::MapLock>) -> BpfResult<R>;
    fn get_unified_map_ptr_from_fd(map_fd: u32) -> BpfResult<*const u8>;
    fn translate_instruction(
        instruction: Vec<u8>,
    ) -> BpfResult<Vec<impl EbpfInst>>;
    fn copy_from_user(
        src: *const u8,
        size: usize,
        dst: &mut [u8],
    ) -> BpfResult<()>;
    fn copy_to_user(dest: *mut u8, size: usize, src: &[u8]) -> BpfResult<()>;
    fn current_cpu_id() -> u32;
    fn perf_event_output(
        ctx: *mut c_void,
        fd: u32,
        flags: u32,
        data: &[u8],
    ) -> BpfResult<()>;
    fn string_from_user_cstr(ptr: *const u8) -> BpfResult<String>;
    fn ebpf_write_str(str: &str) -> BpfResult<()>;
    fn ebpf_time_ns() -> BpfResult<u64>;
    fn alloc_page() -> BpfResult<usize>;
    fn free_page(phys_addr: usize);
    fn vmap(phys_addrs: &[usize]) -> BpfResult<usize>;
    fn vunmap(vaddr: usize, num_pages: usize);
}

The KernelAuxiliaryOps trait provides auxiliary operations which should be implemented by the kernel or a kernel-like environment.

Required Associated Types

type MapLock: RawMutex + 'static

The associated type for the map lock, which must implement RawMutex.

Required Methods

fn get_unified_map_from_ptr<F, R>(ptr: *const u8, func: F) -> BpfResult<R>

where F: FnOnce(&UnifiedMap<Self::MapLock>) -> BpfResult<R>,

Get a unified map from a user space pointer.

fn get_unified_map_from_fd<F, R>(map_fd: u32, func: F) -> BpfResult<R>

where F: FnOnce(&UnifiedMap<Self::MapLock>) -> BpfResult<R>,

Get a unified map from a file descriptor.

fn get_unified_map_ptr_from_fd(map_fd: u32) -> BpfResult<*const u8>

Get a unified map pointer from a file descriptor.

fn translate_instruction(instruction: Vec<u8>) -> BpfResult<Vec<impl EbpfInst>>

Translate eBPF instructions, which may involve relocating map file descriptors.

fn copy_from_user(src: *const u8, size: usize, dst: &mut [u8]) -> BpfResult<()>

Copy data from a user space pointer to a kernel space buffer.

fn copy_to_user(dest: *mut u8, size: usize, src: &[u8]) -> BpfResult<()>

Copy data from a kernel space buffer to a user space pointer.

fn current_cpu_id() -> u32

Get the current CPU ID.

fn perf_event_output( ctx: *mut c_void, fd: u32, flags: u32, data: &[u8], ) -> BpfResult<()>

Output some data to a perf buf

fn string_from_user_cstr(ptr: *const u8) -> BpfResult<String>

Read a string from a user space pointer.

fn ebpf_write_str(str: &str) -> BpfResult<()>

For ebpf print helper functions

fn ebpf_time_ns() -> BpfResult<u64>

For ebpf ktime helper functions

fn alloc_page() -> BpfResult<usize>

Allocate pages in kernel space. Return the physical address of the allocated page.

fn free_page(phys_addr: usize)

Free the allocated page in kernel space.

fn vmap(phys_addrs: &[usize]) -> BpfResult<usize>

Create a virtual mapping for the given physical addresses. Return the virtual address.

fn vunmap(vaddr: usize, num_pages: usize)

Unmap the virtual address range corresponding to the given virtual address and number of pages.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors