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

miri/
lib.rs
