miri/
lib.rs

1#![cfg_attr(all(feature = "native-lib", unix), feature(iter_advance_by))]
2#![cfg_attr(
3    all(
4        feature = "native-lib",
5        target_os = "linux",
6        target_env = "gnu",
7        any(target_arch = "x86", target_arch = "x86_64")
8    ),
9    feature(abort_unwind)
10)]
11#![feature(rustc_private)]
12#![feature(dirfd)]
13#![feature(f16)]
14#![feature(float_gamma)]
15#![feature(float_erf)]
16#![feature(map_try_insert)]
17#![feature(never_type)]
18#![feature(try_blocks)]
19#![feature(io_error_more)]
20#![feature(io_error_inprogress)]
21#![cfg_attr(not(bootstrap), feature(io_error_too_many_open_files))]
22#![feature(variant_count)]
23#![feature(yeet_expr)]
24#![feature(pointer_is_aligned_to)]
25#![feature(unqualified_local_imports)]
26#![feature(derive_coerce_pointee)]
27#![feature(arbitrary_self_types)]
28#![feature(macro_metavar_expr)]
29#![feature(uint_carryless_mul)]
30// Configure clippy and other lints
31#![allow(
32    clippy::collapsible_if,
33    clippy::enum_variant_names,
34    clippy::manual_map,
35    clippy::neg_cmp_op_on_partial_ord,
36    clippy::new_without_default,
37    clippy::single_match,
38    clippy::useless_format,
39    clippy::derive_partial_eq_without_eq,
40    clippy::derived_hash_with_manual_eq,
41    clippy::too_many_arguments,
42    clippy::type_complexity,
43    clippy::bool_to_int_with_if,
44    clippy::needless_question_mark,
45    clippy::needless_lifetimes,
46    clippy::too_long_first_doc_paragraph,
47    clippy::len_zero,
48    // We are not implementing queries here so it's fine
49    rustc::potential_query_instability,
50)]
51#![warn(
52    rust_2018_idioms,
53    unqualified_local_imports,
54    clippy::as_conversions,
55    clippy::manual_let_else
56)]
57// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
58#![recursion_limit = "256"]
59
60// The rustc crates we need
61extern crate rustc_abi;
62extern crate rustc_apfloat;
63extern crate rustc_ast;
64extern crate rustc_codegen_ssa;
65extern crate rustc_const_eval;
66extern crate rustc_data_structures;
67extern crate rustc_errors;
68extern crate rustc_hir;
69extern crate rustc_hir_analysis;
70extern crate rustc_index;
71extern crate rustc_log;
72extern crate rustc_middle;
73extern crate rustc_session;
74extern crate rustc_span;
75extern crate rustc_symbol_mangling;
76extern crate rustc_target;
77// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
78// shipped only as rmeta files.
79#[allow(unused_extern_crates)]
80extern crate rustc_driver;
81
82mod alloc;
83mod alloc_addresses;
84mod borrow_tracker;
85mod clock;
86mod concurrency;
87mod data_structures;
88mod diagnostics;
89mod eval;
90mod helpers;
91mod intrinsics;
92mod machine;
93mod math;
94mod operator;
95mod provenance_gc;
96mod shims;
97pub mod sym;
98
99// Establish a "crate-wide prelude": we often import `crate::*`.
100// Make all those symbols available in the same place as our own.
101#[doc(no_inline)]
102pub use rustc_const_eval::interpret::*;
103// Resolve ambiguity.
104#[doc(no_inline)]
105pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
106pub use rustc_data_structures::either::Either;
107pub use rustc_log::tracing::{self, info, trace, warn};
108pub use rustc_middle::{bug, span_bug};
109
110#[cfg(all(feature = "native-lib", unix))]
111pub mod native_lib {
112    pub use crate::shims::{init_sv, register_retcode_sv};
113}
114
115// Type aliases that set the provenance parameter.
116pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
117pub type StrictPointer = interpret::Pointer<machine::Provenance>;
118pub type Scalar = interpret::Scalar<machine::Provenance>;
119pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
120pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
121pub type FnArg<'tcx> = interpret::FnArg<'tcx, machine::Provenance>;
122pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
123pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
124
125pub use crate::alloc::MiriAllocBytes;
126pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
127pub use crate::borrow_tracker::stacked_borrows::{
128    EvalContextExt as _, Item, Permission, Stack, Stacks,
129};
130pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
131pub use crate::borrow_tracker::{
132    BorTag, BorrowTrackerMethod, EvalContextExt as _, TreeBorrowsParams,
133};
134pub use crate::clock::{Deadline, Instant, MonotonicClock, TimeoutClock, TimeoutStyle};
135pub use crate::concurrency::blocking_io::{
136    BlockingIoInterest, BlockingIoManager, EvalContextExt as _, SourceFileDescription,
137};
138pub use crate::concurrency::cpu_affinity::MAX_CPUS;
139pub use crate::concurrency::data_race::{
140    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
141};
142pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
143pub use crate::concurrency::scheduler::EvalContextExt as _;
144pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
145pub use crate::concurrency::thread::{
146    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
147    ThreadManager, TlsAllocAction, UnblockKind,
148};
149pub use crate::concurrency::{GenmcConfig, GenmcCtx, run_genmc_mode};
150pub use crate::data_structures::dedup_range_map::DedupRangeMap;
151pub use crate::data_structures::mono_hash_map::MonoHashMap;
152pub use crate::diagnostics::{
153    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_result,
154};
155pub use crate::eval::{MiriConfig, MiriEntryFnType, create_ecx, entry_fn, eval_entry};
156pub use crate::helpers::{EvalContextExt as _, ToU64 as _, ToUsize as _};
157pub use crate::intrinsics::EvalContextExt as _;
158pub use crate::machine::{
159    AlignmentCheck, AllocExtra, BacktraceStyle, DynMachineCallback, FloatRoundingErrorMode,
160    FrameExtra, IsolatedOp, MachineCallback, MemoryKind, MiriInterpCx, MiriInterpCxExt,
161    MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra, RejectOpWith,
162    ValidationMode,
163};
164pub use crate::operator::EvalContextExt as _;
165pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
166pub use crate::shims::EmulateItemResult;
167pub use crate::shims::env::{EnvVars, EvalContextExt as _};
168pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
169pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
170pub use crate::shims::os_str::EvalContextExt as _;
171pub use crate::shims::panic::EvalContextExt as _;
172pub use crate::shims::readiness::{
173    EvalContextExt as _, Readiness, ReadinessInterest, ReadinessUpdateFlags, ReadinessWatched,
174    ReadinessWatcher,
175};
176pub use crate::shims::sig::EvalContextExt as _;
177pub use crate::shims::time::EvalContextExt as _;
178pub use crate::shims::tls::TlsData;
179pub use crate::shims::unwind::{CatchUnwindData, EvalContextExt as _};
180
181/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
182/// set per default, for maximal validation power.
183/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
184/// does that too, and with a better error message.
185pub const MIRI_DEFAULT_ARGS: &[&str] = &[
186    "--cfg=miri",
187    "-Zalways-encode-mir",
188    "-Zextra-const-ub-checks",
189    "-Zmir-preserve-ub",
190    "-Zmir-opt-level=0",
191    // Disable passes that add checks for language UB -- we get better diagnostics if
192    // we let Miri do these checks.
193    "-Zmir-enable-passes=-CheckAlignment,-CheckNull,-CheckEnums",
194    // FIXME: Disable some passes to make higher opt levels also work.
195    // - ReferencePropagation is incompatible with SB's ref-to-raw castb behavior.
196    //   The fix here is to ditch SB and use TB instead but we're not yet ready for that.
197    // - GVN is not yet adjusted for implicit retags during assignments.
198    "-Zmir-enable-passes=-ReferencePropagation,-GVN",
199    // Deduplicating diagnostics means we miss events when tracking what happens during an
200    // execution. Let's not do that.
201    "-Zdeduplicate-diagnostics=no",
202];
miri/lib.rs

miri/
lib.rs
