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#![feature(variant_count)]
22#![feature(yeet_expr)]
23#![feature(pointer_is_aligned_to)]
24#![feature(unqualified_local_imports)]
25#![feature(derive_coerce_pointee)]
26#![feature(arbitrary_self_types)]
27#![feature(macro_metavar_expr)]
28#![feature(uint_carryless_mul)]
29// Configure clippy and other lints
30#![allow(
31    clippy::collapsible_else_if,
32    clippy::collapsible_if,
33    clippy::if_same_then_else,
34    clippy::comparison_chain,
35    clippy::enum_variant_names,
36    clippy::field_reassign_with_default,
37    clippy::manual_map,
38    clippy::neg_cmp_op_on_partial_ord,
39    clippy::new_without_default,
40    clippy::single_match,
41    clippy::useless_format,
42    clippy::derive_partial_eq_without_eq,
43    clippy::derived_hash_with_manual_eq,
44    clippy::too_many_arguments,
45    clippy::type_complexity,
46    clippy::bool_to_int_with_if,
47    clippy::needless_question_mark,
48    clippy::needless_lifetimes,
49    clippy::too_long_first_doc_paragraph,
50    clippy::len_zero,
51    clippy::collapsible_match,
52    // We are not implementing queries here so it's fine
53    rustc::potential_query_instability,
54)]
55#![warn(
56    rust_2018_idioms,
57    unqualified_local_imports,
58    clippy::as_conversions,
59    clippy::manual_let_else
60)]
61// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
62#![recursion_limit = "256"]
63
64// The rustc crates we need
65extern crate rustc_abi;
66extern crate rustc_apfloat;
67extern crate rustc_ast;
68extern crate rustc_codegen_ssa;
69extern crate rustc_const_eval;
70extern crate rustc_data_structures;
71extern crate rustc_errors;
72extern crate rustc_hir;
73extern crate rustc_hir_analysis;
74extern crate rustc_index;
75extern crate rustc_log;
76extern crate rustc_middle;
77extern crate rustc_session;
78extern crate rustc_span;
79extern crate rustc_symbol_mangling;
80extern crate rustc_target;
81// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
82// shipped only as rmeta files.
83#[allow(unused_extern_crates)]
84extern crate rustc_driver;
85
86mod alloc;
87mod alloc_addresses;
88mod borrow_tracker;
89mod clock;
90mod concurrency;
91mod data_structures;
92mod diagnostics;
93mod eval;
94mod helpers;
95mod intrinsics;
96mod machine;
97mod math;
98mod operator;
99mod provenance_gc;
100mod shims;
101pub mod sym;
102
103// Establish a "crate-wide prelude": we often import `crate::*`.
104// Make all those symbols available in the same place as our own.
105#[doc(no_inline)]
106pub use rustc_const_eval::interpret::*;
107// Resolve ambiguity.
108#[doc(no_inline)]
109pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
110pub use rustc_data_structures::either::Either;
111pub use rustc_log::tracing::{self, info, trace};
112pub use rustc_middle::{bug, span_bug};
113
114#[cfg(all(feature = "native-lib", unix))]
115pub mod native_lib {
116    pub use crate::shims::{init_sv, register_retcode_sv};
117}
118
119// Type aliases that set the provenance parameter.
120pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
121pub type StrictPointer = interpret::Pointer<machine::Provenance>;
122pub type Scalar = interpret::Scalar<machine::Provenance>;
123pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
124pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
125pub type FnArg<'tcx> = interpret::FnArg<'tcx, machine::Provenance>;
126pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
127pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
128
129pub use crate::alloc::MiriAllocBytes;
130pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
131pub use crate::borrow_tracker::stacked_borrows::{
132    EvalContextExt as _, Item, Permission, Stack, Stacks,
133};
134pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
135pub use crate::borrow_tracker::{
136    BorTag, BorrowTrackerMethod, EvalContextExt as _, TreeBorrowsParams,
137};
138pub use crate::clock::{Deadline, Instant, MonotonicClock, TimeoutClock, TimeoutStyle};
139pub use crate::concurrency::blocking_io::{
140    BlockingIoInterest, BlockingIoManager, BlockingIoSourceReadiness, EvalContextExt as _,
141    SourceFileDescription,
142};
143pub use crate::concurrency::cpu_affinity::MAX_CPUS;
144pub use crate::concurrency::data_race::{
145    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
146};
147pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
148pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
149pub use crate::concurrency::thread::{
150    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
151    ThreadManager, TlsAllocAction, UnblockKind,
152};
153pub use crate::concurrency::{GenmcConfig, GenmcCtx, run_genmc_mode};
154pub use crate::data_structures::dedup_range_map::DedupRangeMap;
155pub use crate::data_structures::mono_hash_map::MonoHashMap;
156pub use crate::diagnostics::{
157    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_result,
158};
159pub use crate::eval::{MiriConfig, MiriEntryFnType, create_ecx, entry_fn, eval_entry};
160pub use crate::helpers::{EvalContextExt as _, ToU64 as _, ToUsize as _};
161pub use crate::intrinsics::EvalContextExt as _;
162pub use crate::machine::{
163    AlignmentCheck, AllocExtra, BacktraceStyle, DynMachineCallback, FloatRoundingErrorMode,
164    FrameExtra, IsolatedOp, MachineCallback, MemoryKind, MiriInterpCx, MiriInterpCxExt,
165    MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra, RejectOpWith,
166    ValidationMode,
167};
168pub use crate::operator::EvalContextExt as _;
169pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
170pub use crate::shims::EmulateItemResult;
171pub use crate::shims::env::{EnvVars, EvalContextExt as _};
172pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
173pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
174pub use crate::shims::os_str::EvalContextExt as _;
175pub use crate::shims::panic::EvalContextExt as _;
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
