Struct libafl::observers::map::StdMapObserver

pub struct StdMapObserver<'a, T, const DIFFERENTIAL: bool>where
    T: Default + Copy + 'static + Serialize,{ /* private fields */ }

The Map Observer retrieves the state of a map, that will get updated by the target. A well-known example is the AFL-Style coverage map.

Implementations

impl<'a, T, const DIFFERENTIAL: bool> StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

pub fn map(&self) -> &OwnedMutSlice<'a, T>

Gets the backing for this map

pub fn map_mut(&mut self) -> &mut OwnedMutSlice<'a, T>

Gets the backing for this map mutably

impl<'a, T> StdMapObserver<'a, T, false>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

pub unsafe fn new<S>(name: S, map: &'a mut [T]) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver

Safety

The observer will keep a pointer to the map. Hence, the map may never move in memory.

pub fn from_mut_slice<S>(name: S, map: OwnedMutSlice<'a, T>) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver from an OwnedMutSlice

pub fn new_owned<S>(name: S, map: Vec<T>) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver with an owned map

pub fn from_ownedref<S>(name: S, map: OwnedMutSlice<'a, T>) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver from an OwnedMutSlice map.

Note

Will dereference the owned slice with up to len elements.

pub unsafe fn from_mut_ptr<S>(name: S, map_ptr: *mut T, len: usize) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver from a raw pointer

Safety

Will dereference the map_ptr with up to len elements.

impl<'a, T> StdMapObserver<'a, T, true>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

pub unsafe fn differential<S>(name: S, map: &'a mut [T]) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver in differential mode

Safety

Will get a pointer to the map and dereference it at any point in time. The map must not move in memory!

pub fn differential_owned<S>(name: S, map: Vec<T>) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver with an owned map in differential mode

pub fn differential_from_ownedref<S>(name: S, map: OwnedMutSlice<'a, T>) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver from an OwnedMutSlice map in differential mode.

Note

Will dereference the owned slice with up to len elements.

pub unsafe fn differential_from_mut_ptr<S>(
    name: S,
    map_ptr: *mut T,
    len: usize
) -> Selfwhere
    S: Into<String>,

Creates a new MapObserver from a raw pointer in differential mode

Safety

Will dereference the map_ptr with up to len elements.

Trait Implementations

impl<'a, 'it, T, const DIFFERENTIAL: bool> AsIter<'it> for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Item = T

The item type

type IntoIter = Iter<'it, T>

The iterator type

fn as_iter(&'it self) -> Self::IntoIter

Create an iterator from &self

impl<'a, 'it, T, const DIFFERENTIAL: bool> AsIterMut<'it> for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Item = T

The item type

type IntoIter = IterMut<'it, T>

The iterator type

fn as_iter_mut(&'it mut self) -> Self::IntoIter

Create an iterator from &mut self

impl<'a, T, const DIFFERENTIAL: bool> AsMutSlice for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Entry = T

Type of the entries in this mut slice

fn as_mut_slice(&mut self) -> &mut [T]

Convert to a slice

impl<'a, T, const DIFFERENTIAL: bool> AsSlice for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Entry = T

Type of the entries in this slice

fn as_slice(&self) -> &[T]

Convert to a slice

impl<'a, T, const DIFFERENTIAL: bool> Clone for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + Clone,

fn clone(&self) -> StdMapObserver<'a, T, DIFFERENTIAL>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T, const DIFFERENTIAL: bool> Debug for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + Debug,

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

Formats the value using the given formatter.

impl<'de, 'a, T, const DIFFERENTIAL: bool> Deserialize<'de> for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, OTA, OTB, S, T> DifferentialObserver<OTA, OTB, S> for StdMapObserver<'a, T, true>where
    OTA: ObserversTuple<S>,
    OTB: ObserversTuple<S>,
    S: UsesInput,
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

fn pre_observe_first(&mut self, observers: &mut OTA) -> Result<(), Error>

Perform an operation with the first set of observers before they are pre_exec’d.

fn post_observe_first(&mut self, observers: &mut OTA) -> Result<(), Error>

Perform an operation with the first set of observers after they are post_exec’d.

fn pre_observe_second(&mut self, observers: &mut OTB) -> Result<(), Error>

Perform an operation with the second set of observers before they are pre_exec’d.

fn post_observe_second(&mut self, observers: &mut OTB) -> Result<(), Error>

Perform an operation with the second set of observers after they are post_exec’d.

impl<'a, T, const DIFFERENTIAL: bool> HasLen for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

fn len(&self) -> usize

The length

fn is_empty(&self) -> bool

Returns true if it has no elements.

impl<'a, 'it, T, const DIFFERENTIAL: bool> IntoIterator for &'it StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Item = <Iter<'it, T> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = Iter<'it, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'it, T, const DIFFERENTIAL: bool> IntoIterator for &'it mut StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Item = <IterMut<'it, T> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = IterMut<'it, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const DIFFERENTIAL: bool> MapObserver for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

fn count_bytes(&self) -> u64

Count the set bytes in the map

fn reset_map(&mut self) -> Result<(), Error>

Reset the map

type Entry = T

Type of each entry in this map

fn get(&self, pos: usize) -> &T

Get the value at idx

fn get_mut(&mut self, idx: usize) -> &mut T

Get the value at idx (mutable)

fn usable_count(&self) -> usize

Get the number of usable entries in the map (all by default)

fn hash(&self) -> u64

Compute the hash of the map

fn initial(&self) -> T

Get the initial value for reset()

fn to_vec(&self) -> Vec<T>

Get these observer’s contents as Vec

fn how_many_set(&self, indexes: &[usize]) -> usize

Get the number of set entries with the specified indexes

fn downsize_map(&mut self, new_len: usize) -> Option<usize>

Resize the inner map to be smaller (and thus faster to process) It returns Some(old size) on success, None on failure

impl<'a, T, const DIFFERENTIAL: bool> Named for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

fn name(&self) -> &str

Provide the name of this element.

impl<'a, S, T> Observer<S> for StdMapObserver<'a, T, false>where
    S: UsesInput,
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

fn pre_exec(&mut self, _state: &mut S, _input: &S::Input) -> Result<(), Error>

Called right before execution starts.

fn flush(&mut self) -> Result<(), Error>

The testcase finished execution, calculate any changes. Reserved for future use.

fn post_exec(
    &mut self,
    _state: &mut S,
    _input: &S::Input,
    _exit_kind: &ExitKind
) -> Result<(), Error>

Called right after execution finishes.

fn pre_exec_child(
    &mut self,
    _state: &mut S,
    _input: &S::Input
) -> Result<(), Error>

Called right before execution starts in the child process, if any.

fn post_exec_child(
    &mut self,
    _state: &mut S,
    _input: &S::Input,
    _exit_kind: &ExitKind
) -> Result<(), Error>

Called right after execution finishes in the child process, if any.

fn observes_stdout(&self) -> bool

If this observer observes stdout

fn observes_stderr(&self) -> bool

If this observer observes stderr

fn observe_stdout(&mut self, stdout: &[u8])

React to new stdout To use this, always return true from observes_stdout

fn observe_stderr(&mut self, stderr: &[u8])

React to new stderr To use this, always return true from observes_stderr

impl<'a, S, T> Observer<S> for StdMapObserver<'a, T, true>where
    S: UsesInput,
    T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

fn flush(&mut self) -> Result<(), Error>

The testcase finished execution, calculate any changes. Reserved for future use.

fn pre_exec(&mut self, _state: &mut S, _input: &S::Input) -> Result<(), Error>

Called right before execution starts.

fn post_exec(
    &mut self,
    _state: &mut S,
    _input: &S::Input,
    _exit_kind: &ExitKind
) -> Result<(), Error>

Called right after execution finishes.

fn pre_exec_child(
    &mut self,
    _state: &mut S,
    _input: &S::Input
) -> Result<(), Error>

Called right before execution starts in the child process, if any.

fn post_exec_child(
    &mut self,
    _state: &mut S,
    _input: &S::Input,
    _exit_kind: &ExitKind
) -> Result<(), Error>

Called right after execution finishes in the child process, if any.

fn observes_stdout(&self) -> bool

If this observer observes stdout

fn observes_stderr(&self) -> bool

If this observer observes stderr

fn observe_stdout(&mut self, stdout: &[u8])

React to new stdout To use this, always return true from observes_stdout

fn observe_stderr(&mut self, stderr: &[u8])

React to new stderr To use this, always return true from observes_stderr

impl<'a, T, const DIFFERENTIAL: bool> Serialize for StdMapObserver<'a, T, DIFFERENTIAL>where
    T: Default + Copy + 'static + Serialize + DeserializeOwned,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.