libafl::corpus::inmemory_ondisk

Struct InMemoryOnDiskCorpus

Source 
pub struct InMemoryOnDiskCorpus<I> { /* private fields */ }
Expand description

A corpus able to store Testcases to disk, while also keeping all of them in memory.

Metadata is written to a .<filename>.metadata file in the same folder by default.

Implementations§

Source§

impl<I> InMemoryOnDiskCorpus<I>

Source

pub fn new<P>(dir_path: P) -> Result<Self, Error>
where P: AsRef<Path>,

Creates an InMemoryOnDiskCorpus.

This corpus stores all testcases to disk, and keeps all of them in memory, as well.

By default, it stores metadata for each Testcase as prettified json. Metadata will be written to a file named .<testcase>.metadata The metadata may include objective reason, specific information for a fuzz job, and more.

If you don’t want metadata, use InMemoryOnDiskCorpus::no_meta. To pick a different metadata format, use InMemoryOnDiskCorpus::with_meta_format.

Will error, if fs::create_dir_all() failed for dir_path.

Source

pub fn with_meta_format<P>( dir_path: P, meta_format: Option<OnDiskMetadataFormat>, ) -> Result<Self, Error>
where P: AsRef<Path>,

Creates the InMemoryOnDiskCorpus specifying the format in which Metadata will be saved to disk.

Will error, if fs::create_dir_all() failed for dir_path.

Source

pub fn with_meta_format_and_prefix<P>( dir_path: P, meta_format: Option<OnDiskMetadataFormat>, prefix: Option<String>, locking: bool, ) -> Result<Self, Error>
where P: AsRef<Path>,

Creates the InMemoryOnDiskCorpus specifying the format in which Metadata will be saved to disk and the prefix for the filenames.

Will error, if fs::create_dir_all() failed for dir_path.

Source

pub fn no_meta<P>(dir_path: P) -> Result<Self, Error>
where P: AsRef<Path>,

Creates an InMemoryOnDiskCorpus that will not store .metadata files

Will error, if fs::create_dir_all() failed for dir_path.

Source

pub fn rename_testcase( &self, testcase: &mut Testcase<I>, filename: String, id: Option<CorpusId>, ) -> Result<(), Error>
where I: Input,

Sets the filename for a Testcase. If an error gets returned from the corpus (i.e., file exists), we’ll have to retry with a different filename. Renaming testcases will most likely cause duplicate testcases to not be handled correctly if testcases with the same input are not given the same filename. Only rename when you know what you are doing.

Source

pub fn dir_path(&self) -> &PathBuf

Path to the corpus directory associated with this corpus

Trait Implementations§

Source§

impl<I: Clone> Clone for InMemoryOnDiskCorpus<I>

Source§

fn clone(&self) -> InMemoryOnDiskCorpus<I>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I> Corpus<I> for InMemoryOnDiskCorpus<I>
where I: Input,

Source§

fn count(&self) -> usize

Returns the number of all enabled entries

Source§

fn count_disabled(&self) -> usize

Returns the number of all disabled entries

Source§

fn count_all(&self) -> usize

Returns the number of elements including disabled entries

Source§

fn add(&mut self, testcase: Testcase<I>) -> Result<CorpusId, Error>

Add an enabled testcase to the corpus and return its index

Source§

fn add_disabled(&mut self, testcase: Testcase<I>) -> Result<CorpusId, Error>

Add a disabled testcase to the corpus and return its index

Source§

fn replace( &mut self, id: CorpusId, testcase: Testcase<I>, ) -> Result<Testcase<I>, Error>

Replaces the testcase at the given idx

Source§

fn remove(&mut self, id: CorpusId) -> Result<Testcase<I>, Error>

Removes an entry from the corpus, returning it if it was present; considers both enabled and disabled corpus

Source§

fn get(&self, id: CorpusId) -> Result<&RefCell<Testcase<I>>, Error>

Get by id; considers only enabled testcases

Source§

fn get_from_all(&self, id: CorpusId) -> Result<&RefCell<Testcase<I>>, Error>

Get by id; considers both enabled and disabled testcases

Source§

fn current(&self) -> &Option<CorpusId>

Current testcase scheduled

Source§

fn current_mut(&mut self) -> &mut Option<CorpusId>

Current testcase scheduled (mutable)

Source§

fn peek_free_id(&self) -> CorpusId

Peek the next free corpus id

Source§

fn nth(&self, nth: usize) -> CorpusId

Get the nth corpus id; considers only enabled testcases

Source§

fn nth_from_all(&self, nth: usize) -> CorpusId

Get the nth corpus id; considers both enabled and disabled testcases

Source§

fn next(&self, id: CorpusId) -> Option<CorpusId>

Get the next corpus id
Source§

fn prev(&self, id: CorpusId) -> Option<CorpusId>

Get the prev corpus id
Source§

fn first(&self) -> Option<CorpusId>

Get the first inserted corpus id
Source§

fn last(&self) -> Option<CorpusId>

Get the last inserted corpus id
Source§

fn load_input_into(&self, testcase: &mut Testcase<I>) -> Result<(), Error>

Method to load the input for this Testcase from persistent storage, if necessary, and if was not already loaded (== Some(input)). After this call, testcase.input() must always return Some(input).
Source§

fn store_input_from(&self, testcase: &Testcase<I>) -> Result<(), Error>

Method to store the input of this Testcase to persistent storage, if necessary.
Source§

fn is_empty(&self) -> bool

Returns true, if no elements are in this corpus yet
Source§

fn ids(&self) -> CorpusIdIterator<'_, Self, I> ⓘ

An iterator over very active corpus id
Source§

fn cloned_input_for_id(&self, id: CorpusId) -> Result<I, Error>
where I: Clone,

Loads the Input for a given CorpusId from the Corpus, and returns the clone.
Source§

impl<I: Debug> Debug for InMemoryOnDiskCorpus<I>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<I: Default> Default for InMemoryOnDiskCorpus<I>

Source§

fn default() -> InMemoryOnDiskCorpus<I>

Returns the “default value” for a type. Read more
Source§

impl<'de, I> Deserialize<'de> for InMemoryOnDiskCorpus<I>
where I: Deserialize<'de>,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<I> EnableDisableCorpus for InMemoryOnDiskCorpus<I>
where I: Input,

Source§

fn disable(&mut self, id: CorpusId) -> Result<(), Error>

Disables a testcase, moving it to the disabled map
Source§

fn enable(&mut self, id: CorpusId) -> Result<(), Error>

Enables a testcase, moving it to the enabled map
Source§

impl<I> HasTestcase<I> for InMemoryOnDiskCorpus<I>
where I: Input,

Source§

fn testcase(&self, id: CorpusId) -> Result<Ref<'_, Testcase<I>>, Error>

Shorthand to receive a Ref to a stored Testcase, by CorpusId. For a normal state, this should return a Testcase in the corpus, not the objectives.
Source§

fn testcase_mut(&self, id: CorpusId) -> Result<RefMut<'_, Testcase<I>>, Error>

Shorthand to receive a RefMut to a stored Testcase, by CorpusId. For a normal state, this should return a Testcase in the corpus, not the objectives.
Source§

impl<I> Serialize for InMemoryOnDiskCorpus<I>
where I: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<Head, T> Append<T> for Head

Source§

fn append(self, value: T) -> (Head, T)

Append Value and return the tuple
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<I, S> MutatedTransform<I, S> for I
where I: Clone, S: HasCorpus<I>,

Source§

type Post = ()

Type indicating actions to be taken after the post-transformation input is executed
Source§

fn try_transform_from(base: &mut Testcase<I>, state: &S) -> Result<I, Error>

Transform the provided testcase into this type
Source§

fn try_transform_into( self, _state: &S, ) -> Result<(I, <I as MutatedTransform<I, S>>::Post), Error>

Transform this instance back into the original input type
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<Tail, T> Prepend<T> for Tail

Source§

fn prepend(self, value: T) -> (T, Tail)

Prepend a value to this tuple, returning a new tuple with prepended value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSend for T