Add documentation for InProcessForkExecutor for fuzzing rust (#2378)

This commit is contained in:
Max Ammann 2024-07-11 12:26:30 +01:00 committed by GitHub
parent d9a042e094
commit dbbd54169d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -40,7 +40,8 @@ pub mod inner;
/// A version of `InProcessForkExecutor` with a state accessible from the harness.
pub mod stateful;
/// The `InProcessForkExecutor` with no user hooks
/// The `InProcessForkExecutor` with no user hooks. On Linux, when fuzzing a Rust target, set `panic = "abort"` in your `Cargo.toml` (see [Cargo documentation](https://doc.rust-lang.org/cargo/reference/profiles.html#panic)).
/// Else panics can not be caught by LibAFL.
pub type InProcessForkExecutor<'a, H, OT, S, SP, EM, Z> =
GenericInProcessForkExecutor<'a, H, (), OT, S, SP, EM, Z>;
@ -79,7 +80,8 @@ where
}
}
/// [`GenericInProcessForkExecutor`] is an executor that forks the current process before each execution.
/// [`GenericInProcessForkExecutor`] is an executor that forks the current process before each execution. On Linux, when fuzzing a Rust target, set `panic = "abort"` in your `Cargo.toml` (see [Cargo documentation](https://doc.rust-lang.org/cargo/reference/profiles.html#panic)).
/// Else panics can not be caught by LibAFL.
pub struct GenericInProcessForkExecutor<'a, H, HT, OT, S, SP, EM, Z>
where
H: FnMut(&S::Input) -> ExitKind + ?Sized,