Struct libafl::bolts::llmp::LlmpSharedMap

pub struct LlmpSharedMap<SHM> where
    SHM: ShMem,  {
    pub shmem: SHM,
}

A page wrapper

Fields

shmem: SHM

Shmem containg the actual (unsafe) page, shared between one LlmpSender and one LlmpReceiver

Implementations

impl<SHM> LlmpSharedMap<SHM> where
    SHM: ShMem, 

The page struct, placed on a shared mem instance. A thin wrapper around a ShMem implementation, with special crate::bolts::llmp funcs

pub fn new(sender: ClientId, new_map: SHM) -> Self

Creates a new page, initializing the passed shared mem struct

pub fn existing(existing_map: SHM) -> Self

Maps and wraps an existing

pub fn mark_save_to_unmap(&mut self)

Marks the containing page as save_to_unmap. This indicates, that the page may safely be unmapped by the sender.

pub unsafe fn page_mut(&mut self) -> *mut LlmpPage

Get the unsafe ptr to this page, situated on the shared map

Safety

The unsafe page pointer is obviously unsafe.

pub unsafe fn page(&self) -> *const LlmpPage

Get the unsafe ptr to this page, situated on the shared map

Safety

The unsafe page pointer is obviously unsafe.

pub unsafe fn msg_to_offset(&self, msg: *const LlmpMsg) -> Result<u64, Error>

Gets the offset of a message on this here page. Will return crate::Error::IllegalArgument error if msg is not on page.

Safety

This dereferences msg, make sure to pass a proper pointer to it.

pub fn msg_from_env(
    &mut self,
    map_env_name: &str
) -> Result<*mut LlmpMsg, Error>

Retrieve the stored msg from env_name + _OFFSET. It will restore the stored offset by env_name and return the message.

pub unsafe fn msg_to_env(
    &self,
    msg: *const LlmpMsg,
    map_env_name: &str
) -> Result<(), Error>

Store this msg offset to env_name + _OFFSET env variable. It can be restored using LlmpSharedMap::msg_from_env() with the same env_name later.

Safety

This function will dereference the msg ptr, make sure it’s valid.

pub fn msg_from_offset(&mut self, offset: u64) -> Result<*mut LlmpMsg, Error>

Gets this message from this page, at the indicated offset. Will return crate::Error::IllegalArgument error if the offset is out of bounds.

Trait Implementations

impl<SHM: Clone> Clone for LlmpSharedMap<SHM> where
    SHM: ShMem, 

fn clone(&self) -> LlmpSharedMap<SHM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SHM: Debug> Debug for LlmpSharedMap<SHM> where
    SHM: ShMem, 

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

Formats the value using the given formatter.