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

miri/
lib.rs
