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_input_output_error))]
22#![cfg_attr(not(bootstrap), 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_symbol_mangling;
77extern crate rustc_target;
78// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
79// shipped only as rmeta files.
80#[allow(unused_extern_crates)]
81extern crate rustc_driver;
82
83mod alloc;
84mod alloc_addresses;
85mod borrow_tracker;
86mod clock;
87mod concurrency;
88mod data_structures;
89mod diagnostics;
90mod eval;
91mod helpers;
92mod intrinsics;
93mod machine;
94mod math;
95mod operator;
96mod provenance_gc;
97mod shims;
98pub mod sym;
99
100// Establish a "crate-wide prelude": we often import `crate::*`.
101// Make all those symbols available in the same place as our own.
102#[doc(no_inline)]
103pub use rustc_const_eval::interpret::*;
104// Resolve ambiguity.
105#[doc(no_inline)]
106pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
107pub use rustc_data_structures::either::Either;
108pub use rustc_log::tracing::{self, info, trace, warn};
109pub use rustc_middle::{bug, span_bug};
110
111#[cfg(all(feature = "native-lib", unix))]
112pub mod native_lib {
113    pub use crate::shims::{init_sv, register_retcode_sv};
114}
115
116// Type aliases that set the provenance parameter.
117pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
118pub type StrictPointer = interpret::Pointer<machine::Provenance>;
119pub type Scalar = interpret::Scalar<machine::Provenance>;
120pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
121pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
122pub type FnArg<'tcx> = interpret::FnArg<'tcx, machine::Provenance>;
123pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
124pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
125
126pub use crate::alloc::MiriAllocBytes;
127pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
128pub use crate::borrow_tracker::stacked_borrows::{
129    EvalContextExt as _, Item, Permission, Stack, Stacks,
130};
131pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
132pub use crate::borrow_tracker::{
133    BorTag, BorrowTrackerMethod, EvalContextExt as _, TreeBorrowsParams,
134};
135pub use crate::clock::{Deadline, Instant, MonotonicClock, TimeoutClock, TimeoutStyle};
136pub use crate::concurrency::blocking_io::{
137    BlockingIoInterest, BlockingIoManager, EvalContextExt as _, SourceFileDescription,
138};
139pub use crate::concurrency::cpu_affinity::MAX_CPUS;
140pub use crate::concurrency::data_race::{
141    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
142};
143pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
144pub use crate::concurrency::scheduler::EvalContextExt as _;
145pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
146pub use crate::concurrency::thread::{
147    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
148    ThreadManager, TlsAllocAction, UnblockKind,
149};
150pub use crate::concurrency::{GenmcConfig, GenmcCtx, run_genmc_mode};
151pub use crate::data_structures::dedup_range_map::DedupRangeMap;
152pub use crate::data_structures::mono_hash_map::MonoHashMap;
153pub use crate::diagnostics::{
154    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_result,
155};
156pub use crate::eval::{MiriConfig, MiriEntryFnType, create_ecx, entry_fn, eval_entry};
157pub use crate::helpers::{EvalContextExt as _, ToU64 as _, ToUsize as _};
158pub use crate::intrinsics::EvalContextExt as _;
159pub use crate::machine::{
160    AlignmentCheck, AllocExtra, BacktraceStyle, DynMachineCallback, FloatRoundingErrorMode,
161    FrameExtra, IsolatedOp, MachineCallback, MemoryKind, MiriInterpCx, MiriInterpCxExt,
162    MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra, RejectOpWith,
163    ValidationMode,
164};
165pub use crate::operator::EvalContextExt as _;
166pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
167pub use crate::shims::EmulateItemResult;
168pub use crate::shims::env::{EnvVars, EvalContextExt as _};
169pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
170pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
171pub use crate::shims::os_str::EvalContextExt as _;
172pub use crate::shims::panic::EvalContextExt as _;
173pub use crate::shims::readiness::{
174    EvalContextExt as _, Readiness, ReadinessInterest, ReadinessUpdateFlags, ReadinessWatched,
175    ReadinessWatcher,
176};
177pub use crate::shims::sig::EvalContextExt as _;
178pub use crate::shims::time::EvalContextExt as _;
179pub use crate::shims::tls::TlsData;
180pub use crate::shims::unwind::{CatchUnwindData, EvalContextExt as _};
181
182/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
183/// set per default, for maximal validation power.
184/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
185/// does that too, and with a better error message.
186pub const MIRI_DEFAULT_ARGS: &[&str] = &[
187    "--cfg=miri",
188    "-Zalways-encode-mir",
189    "-Zextra-const-ub-checks",
190    "-Zmir-preserve-ub",
191    "-Zmir-opt-level=0",
192    // Disable passes that add checks for language UB -- we get better diagnostics if
193    // we let Miri do these checks.
194    "-Zmir-enable-passes=-CheckAlignment,-CheckNull,-CheckEnums",
195    // FIXME: Disable some passes to make higher opt levels also work.
196    // - ReferencePropagation is incompatible with SB's ref-to-raw castb behavior.
197    //   The fix here is to ditch SB and use TB instead but we're not yet ready for that.
198    // - GVN is not yet adjusted for implicit retags during assignments.
199    "-Zmir-enable-passes=-ReferencePropagation,-GVN",
200    // Deduplicating diagnostics means we miss events when tracking what happens during an
201    // execution. Let's not do that.
202    "-Zdeduplicate-diagnostics=no",
203];
miri/lib.rs

miri/
lib.rs
