diff --git a/libafl/src/bolts/bindings.rs b/libafl/src/bolts/bindings.rs index a3fa41413e..1a4dad811f 100644 --- a/libafl/src/bolts/bindings.rs +++ b/libafl/src/bolts/bindings.rs @@ -1,2 +1,4 @@ +//! Generated bindings + #[cfg(all(windows, feature = "std"))] ::windows::include_bindings!(); diff --git a/libafl/src/bolts/os/mod.rs b/libafl/src/bolts/os/mod.rs index 7a45acb215..4ea718107f 100644 --- a/libafl/src/bolts/os/mod.rs +++ b/libafl/src/bolts/os/mod.rs @@ -1,3 +1,5 @@ +//! Operating System specific abstractions + #[cfg(unix)] pub mod unix_signals; #[cfg(windows)] diff --git a/libafl/src/bolts/os/unix_signals.rs b/libafl/src/bolts/os/unix_signals.rs index b388b7bd1f..1182798be9 100644 --- a/libafl/src/bolts/os/unix_signals.rs +++ b/libafl/src/bolts/os/unix_signals.rs @@ -1,3 +1,4 @@ +//! Signal handling for unix use alloc::vec::Vec; use core::{ cell::UnsafeCell, diff --git a/libafl/src/bolts/os/windows_exceptions.rs b/libafl/src/bolts/os/windows_exceptions.rs index 838d0d21cb..98bd392863 100644 --- a/libafl/src/bolts/os/windows_exceptions.rs +++ b/libafl/src/bolts/os/windows_exceptions.rs @@ -1,3 +1,5 @@ +//! Exception handling for Windows + pub use crate::bolts::bindings::windows::win32::debug::EXCEPTION_POINTERS; use crate::{bolts::bindings::windows::win32::debug::SetUnhandledExceptionFilter, Error}; diff --git a/libafl/src/events/llmp.rs b/libafl/src/events/llmp.rs index 1772aca5b8..ae85aebeb5 100644 --- a/libafl/src/events/llmp.rs +++ b/libafl/src/events/llmp.rs @@ -1,3 +1,5 @@ +//! LLMP-backed event manager for scalable multi-processed fuzzing + use alloc::{string::ToString, vec::Vec}; use core::{marker::PhantomData, time::Duration}; use serde::{de::DeserializeOwned, Serialize}; diff --git a/libafl/src/feedbacks/map.rs b/libafl/src/feedbacks/map.rs index c18d6b80e0..014550d0da 100644 --- a/libafl/src/feedbacks/map.rs +++ b/libafl/src/feedbacks/map.rs @@ -1,3 +1,5 @@ +//! Map feedback, maximizing or minimizing maps, for example the afl-style map observer. + use alloc::{ string::{String, ToString}, vec::Vec, diff --git a/libafl/src/fuzzer.rs b/libafl/src/fuzzer.rs index bcf75cf1f3..f24b2e5fc5 100644 --- a/libafl/src/fuzzer.rs +++ b/libafl/src/fuzzer.rs @@ -1,3 +1,5 @@ +//! The `Fuzzer` is the main struct for a fuzz campaign. + use crate::{ corpus::CorpusScheduler, events::{Event, EventManager}, diff --git a/libafl/src/mutators/scheduled.rs b/libafl/src/mutators/scheduled.rs index 70b02fe552..2a7e3f4b99 100644 --- a/libafl/src/mutators/scheduled.rs +++ b/libafl/src/mutators/scheduled.rs @@ -1,3 +1,5 @@ +//! The `ScheduledMutator` schedules multiple mutations internally. + use alloc::string::String; use alloc::vec::Vec; use core::{ diff --git a/libafl/src/observers/map.rs b/libafl/src/observers/map.rs index e92559551f..a32f3cf1e9 100644 --- a/libafl/src/observers/map.rs +++ b/libafl/src/observers/map.rs @@ -1,3 +1,5 @@ +//! The `MapObserver` provides access a map, usually injected into the target + use alloc::{ string::{String, ToString}, vec::Vec, diff --git a/libafl/src/observers/mod.rs b/libafl/src/observers/mod.rs index 26798fdaf1..2ff66ca5fc 100644 --- a/libafl/src/observers/mod.rs +++ b/libafl/src/observers/mod.rs @@ -1,3 +1,5 @@ +//! Observers give insights about runs of a target, such as coverage, timing, stack depth, and more. + pub mod map; pub use map::*;