Struct fidl_fuchsia_fuzzer::Options

pub struct Options {

    pub runs: Option<u32>,
    pub max_total_time: Option<i64>,
    pub seed: Option<u32>,
    pub max_input_size: Option<u64>,
    pub mutation_depth: Option<u16>,
    pub dictionary_level: Option<u16>,
    pub detect_exits: Option<bool>,
    pub detect_leaks: Option<bool>,
    pub run_limit: Option<i64>,
    pub malloc_limit: Option<u64>,
    pub oom_limit: Option<u64>,
    pub purge_interval: Option<i64>,
    pub malloc_exitcode: Option<i32>,
    pub death_exitcode: Option<i32>,
    pub leak_exitcode: Option<i32>,
    pub oom_exitcode: Option<i32>,
    pub pulse_interval: Option<i64>,
    pub debug: Option<bool>,
    pub print_final_stats: Option<bool>,
    pub use_value_profile: Option<bool>,
    pub sanitizer_options: Option<SanitizerOptions>,
    pub output_flags: Option<OutputFlags>,
    /* private fields */
}

See fuchsia.fuzzer.Controller/Configure.

Fields

runs: Option<u32>

Perform this many fuzzing runs, then exit normally. If unset (or zero), fuzz indefinitely.

max_total_time: Option<i64>

If non-zero, fuzz for this duration and then exit normally. If zero, fuzz indefinitely. Defaults to 0.

seed: Option<u32>

PRNG seed to use when generating inputs. The same seed for the same target should produce the same inputs. If zero, the current ticks will be used. Defaults to 0.

max_input_size: Option<u64>

If non-zero, limit the maximum size of a test input to this size, in bytes. Use 0 to disable the limit. Defaults to 1 MB.

mutation_depth: Option<u16>

Maximum number of consecutive mutations to apply to an input. Defaults to 5.

dictionary_level: Option<u16>

If an AFL-style dictionary is supplied using Controller.WriteDictionary, include words up to this level. Defaults to 0, i.e. words without an explicit level.

detect_exits: Option<bool>

If true, treat instrumented process exits as fuzzing errors. Defaults to false.

detect_leaks: Option<bool>

If true, and ASan or LSan are available, try to detect memory leaks. Defaults to false. Leak detection can be expensive, so it is recommended to first develop a corpus that covers a reasonable amount of the code under test before attempting to detect leaks.

run_limit: Option<i64>

If non-zero, any run that takes longer than this duration will raise a TIMEOUT error. Use 0 to disable the limit. Defaults to 20 minutes.

malloc_limit: Option<u64>

If non-zero, any allocation over this size in bytes will raise a BAD_MALLOC error. Use 0 to disable the limit. Defaults to 2 GB.

oom_limit: Option<u64>

If non-zero, any process that uses more than this amount of memory in bytes will raise an OOM error. Use 0 to disable the limit. Defaults to 2 GB.

purge_interval: Option<i64>

If non-zero, purge the sanitizer’s allocator quarantine and reclaim memory periodically between runs after an interval of this many seconds. Use 0 to disable allocator purging. Defaults to 1 second.

malloc_exitcode: Option<i32>

Exit code used by the instrumented process if it encounters a bad allocation. Set this if the target already uses the default for another reason. Defaults to 2000.

death_exitcode: Option<i32>

Exit code used by the instrumented process if it encounters a sanitizer error. Set this if the target already uses the default for another reason. Defaults to 2001.

leak_exitcode: Option<i32>

Exit code used by the instrumented process if it encounters a leak. Set this if the target already uses the default for another reason. Defaults to 2002.

oom_exitcode: Option<i32>

Exit code used by the instrumented process if it exceeds the OOM limit. Set this if the target already uses the default for another reason. Defaults to 2003.

pulse_interval: Option<i64>

If non-zero, the engine will periodically update any added monitors after this duration. Defaults to 20 seconds.

debug: Option<bool>

If true, allow a debugger like zxdb to be attached to an instrumented process. This may interfere with the engine’s ability to detect exceptions and is not recommended when fuzzing. It can be useful when reproducing an error with a known error-causing input. Defaults to false.

print_final_stats: Option<bool>

If true, include ClusterFuzz-compatible final statistics in the output of a call to fuchsia.fuzzer.Controller/WatchArtifact.

use_value_profile: Option<bool>

If true, also use data flow traces as part of the fuzzing coverage data. See https://clang.llvm.org/docs/SanitizerCoverage.html#tracing-data-flow for more details.

sanitizer_options: Option<SanitizerOptions>

Sanitizer options. See SanitizerOptions.

output_flags: Option<OutputFlags>

Output flags. See OutputFlags.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Decode<Options> for Options

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Encode<Options> for &Options

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for Options

type Owned = Options

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for Options

type Borrowed<'a> = &'a Options

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for Options

impl StructuralPartialEq for Options