Trait libafl::observers::map::MapObserver

pub trait MapObserver: HasLen + Named + Serialize + DeserializeOwned + AsRef<Self> + AsMut<Self> {
    type Entry: Bounded + PartialEq + Default + Copy + Debug + 'static;

    // Required methods
    fn get(&self, idx: usize) -> &Self::Entry;
    fn get_mut(&mut self, idx: usize) -> &mut Self::Entry;
    fn usable_count(&self) -> usize;
    fn count_bytes(&self) -> u64;
    fn hash(&self) -> u64;
    fn initial(&self) -> Self::Entry;
    fn reset_map(&mut self) -> Result<(), Error>;
    fn to_vec(&self) -> Vec<Self::Entry>;
    fn how_many_set(&self, indexes: &[usize]) -> usize;
}

A MapObserver observes the static map, as oftentimes used for AFL-like coverage information

When referring to this type in a constraint (e.g. O: MapObserver), ensure that you only refer to instances of a second type, e.g. C: AsRef<O> or A: AsMut<O>. Map observer instances are passed around in a way that may be potentially wrapped by e.g. ExplicitTracking as a way to encode metadata into the type. This is an unfortunate additional requirement that we can’t get around without specialization.

See crate::require_index_tracking for an example of how to do so.

TODO: enforce iter() -> AssociatedTypeIter when generic associated types stabilize

Required Associated Types

type Entry: Bounded + PartialEq + Default + Copy + Debug + 'static

Type of each entry in this map

Required Methods

fn get(&self, idx: usize) -> &Self::Entry

Get the value at idx

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

Get the value at idx (mutable)

fn usable_count(&self) -> usize

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

fn count_bytes(&self) -> u64

Count the set bytes in the map

fn hash(&self) -> u64

Compute the hash of the map

fn initial(&self) -> Self::Entry

Get the initial value for reset()

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

Reset the map

fn to_vec(&self) -> Vec<Self::Entry>

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

Object Safety

This trait is not object safe.

Implementors

impl<'a, T> MapObserver for VariableMapObserver<'a, T>

where T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Entry = T

impl<'a, T, const DIFFERENTIAL: bool> MapObserver for MultiMapObserver<'a, T, DIFFERENTIAL>

where T: 'static + Bounded + PartialEq + Default + Copy + Serialize + DeserializeOwned + Debug,

type Entry = T

impl<'a, T, const DIFFERENTIAL: bool> MapObserver for StdMapObserver<'a, T, DIFFERENTIAL>

where T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Entry = T

impl<'a, T, const N: usize> MapObserver for ConstMapObserver<'a, T, N>

where T: Bounded + PartialEq + Default + Copy + 'static + Serialize + DeserializeOwned + Debug,

type Entry = T

impl<M> MapObserver for HitcountsIterableMapObserver<M>

where for<'it> M: MapObserver<Entry = u8> + AsIterMut<'it, Item = u8>,

type Entry = u8

impl<M> MapObserver for HitcountsMapObserver<M>

where M: MapObserver<Entry = u8>,

type Entry = u8

impl<T> MapObserver for OwnedMapObserver<T>

where T: 'static + Bounded + PartialEq + Default + Copy + Serialize + DeserializeOwned + Debug,

type Entry = T