# Struct miri::eval::MiriConfig

source ·

    pub struct MiriConfig {Show 31 fields
        pub env: Vec<(OsString, OsString)>,
        pub validate: bool,
        pub borrow_tracker: Option<BorrowTrackerMethod>,
        pub unique_is_unique: bool,
        pub check_alignment: AlignmentCheck,
        pub isolated_op: IsolatedOp,
        pub ignore_leaks: bool,
        pub forwarded_env_vars: Vec<String>,
        pub args: Vec<String>,
        pub seed: Option<u64>,
        pub tracked_pointer_tags: FxHashSet<BorTag>,
        pub tracked_call_ids: FxHashSet<CallId>,
        pub tracked_alloc_ids: FxHashSet<AllocId>,
        pub track_alloc_accesses: bool,
        pub data_race_detector: bool,
        pub weak_memory_emulation: bool,
        pub track_outdated_loads: bool,
        pub cmpxchg_weak_failure_rate: f64,
        pub measureme_out: Option<String>,
        pub panic_on_unsupported: bool,
        pub backtrace_style: BacktraceStyle,
        pub provenance_mode: ProvenanceMode,
        pub mute_stdout_stderr: bool,
        pub preemption_rate: f64,
        pub report_progress: Option<u32>,
        pub retag_fields: RetagFields,
        pub external_so_file: Option<PathBuf>,
        pub gc_interval: u32,
        pub num_cpus: u32,
        pub page_size: Option<u64>,
        pub collect_leak_backtraces: bool,
    }

Expand description

Configuration needed to spawn a Miri instance.

## Fields§

§`env: Vec<(OsString, OsString)>`

The host environment snapshot to use as basis for what is provided to the interpreted program. (This is still subject to isolation as well as `forwarded_env_vars`.)

§`validate: bool`

Determine if validity checking is enabled.

§`borrow_tracker: Option<BorrowTrackerMethod>`

Determines if Stacked Borrows or Tree Borrows is enabled.

§`unique_is_unique: bool`

Whether `core::ptr::Unique` receives special treatment. If `true` then `Unique` is reborrowed with its own new tag and permission, otherwise `Unique` is just another raw pointer.

§`check_alignment: AlignmentCheck`

Controls alignment checking.

§`isolated_op: IsolatedOp`

Action for an op requiring communication with the host.

§`ignore_leaks: bool`

Determines if memory leaks should be ignored.

§`forwarded_env_vars: Vec<String>`

Environment variables that should always be forwarded from the host.

§`args: Vec<String>`

Command-line arguments passed to the interpreted program.

§`seed: Option<u64>`

The seed to use when non-determinism or randomness are required (e.g. ptr-to-int cast, `getrandom()`).

§`tracked_pointer_tags: FxHashSet<BorTag>`

The stacked borrows pointer ids to report about

§`tracked_call_ids: FxHashSet<CallId>`

The stacked borrows call IDs to report about

§`tracked_alloc_ids: FxHashSet<AllocId>`

The allocation ids to report about.

§`track_alloc_accesses: bool`

For the tracked alloc ids, also report read/write accesses.

§`data_race_detector: bool`

Determine if data race detection should be enabled

§`weak_memory_emulation: bool`

Determine if weak memory emulation should be enabled. Requires data race detection to be enabled

§`track_outdated_loads: bool`

Track when an outdated (weak memory) load happens.

§`cmpxchg_weak_failure_rate: f64`

Rate of spurious failures for compare_exchange_weak atomic operations, between 0.0 and 1.0, defaulting to 0.8 (80% chance of failure).

§`measureme_out: Option<String>`

If `Some`, enable the `measureme` profiler, writing results to a file with the specified prefix.

§`panic_on_unsupported: bool`

Panic when unsupported functionality is encountered.

§`backtrace_style: BacktraceStyle`

Which style to use for printing backtraces.

§`provenance_mode: ProvenanceMode`

Which provenance to use for int2ptr casts

§`mute_stdout_stderr: bool`

Whether to ignore any output by the program. This is helpful when debugging miri as its messages don’t get intermingled with the program messages.

§`preemption_rate: f64`

The probability of the active thread being preempted at the end of each basic block.

§`report_progress: Option<u32>`

Report the current instruction being executed every N basic blocks.

§`retag_fields: RetagFields`

Whether Stacked Borrows and Tree Borrows retagging should recurse into fields of datatypes.

§`external_so_file: Option<PathBuf>`

The location of a shared object file to load when calling external functions FIXME! consider allowing users to specify paths to multiple SO files, or to a directory

§`gc_interval: u32`

Run a garbage collector for BorTags every N basic blocks.

§`num_cpus: u32`

The number of CPUs to be reported by miri.

§`page_size: Option<u64>`

Requires Miri to emulate pages of a certain size

§`collect_leak_backtraces: bool`

Whether to collect a backtrace when each allocation is created, just in case it leaks.

## Trait Implementations§

source§

### impl Clone for MiriConfig

source§

#### fn clone(&self) -> MiriConfig

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 Default for MiriConfig

source§

#### fn default() -> MiriConfig

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

## Auto Trait Implementations§

§

### impl DynSend for MiriConfig

§

### impl DynSync for MiriConfig

§

### impl Freeze for MiriConfig

§

### impl RefUnwindSafe for MiriConfig

§

### impl Send for MiriConfig

§

### impl Sync for MiriConfig

§

### impl Unpin for MiriConfig

§

### impl UnwindSafe for MiriConfig

## Blanket Implementations§

source§

### impl<T> Aligned for T

source§

#### const ALIGN: Alignment = _

Alignment of `Self`.
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<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, R> CollectAndApply<T, R> for T

source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

§

#### type Output = R

§

### impl<T> Filterable for T

§

#### fn filterable( self, filter_name: &'static str ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. 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<P> IntoQueryParam<P> for P

source§

#### fn into_query_param(self) -> P

source§

### impl<T> MaybeResult<T> for T

§

#### type Error = !

source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

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

§

#### 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<'tcx, T> ToPredicate<'tcx, T> for T

source§

#### fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T

source§

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

§

#### 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>,

§

#### 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.
§

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

§

#### fn vzip(self) -> V

§

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

§

#### fn vzip(self) -> V

source§

### impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

source§

#### default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed ) -> T

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<'a, T> Captures<'a> for T
where T: ?Sized,

source§

### impl<'a, T> Captures<'a> for T
where T: ?Sized,

§

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

§

### impl<T> MaybeSendSync for T
where T: Send + Sync,

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 296 bytes