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

miri/
lib.rs
