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(f16)]
13#![feature(float_gamma)]
14#![feature(float_erf)]
15#![feature(map_try_insert)]
16#![feature(never_type)]
17#![feature(try_blocks)]
18#![feature(io_error_more)]
19#![feature(io_error_inprogress)]
20#![feature(variant_count)]
21#![feature(yeet_expr)]
22#![feature(pointer_is_aligned_to)]
23#![feature(unqualified_local_imports)]
24#![feature(derive_coerce_pointee)]
25#![feature(arbitrary_self_types)]
26#![feature(macro_metavar_expr)]
27#![feature(uint_carryless_mul)]
28// Configure clippy and other lints
29#![allow(
30    clippy::collapsible_else_if,
31    clippy::collapsible_if,
32    clippy::if_same_then_else,
33    clippy::comparison_chain,
34    clippy::enum_variant_names,
35    clippy::field_reassign_with_default,
36    clippy::manual_map,
37    clippy::neg_cmp_op_on_partial_ord,
38    clippy::new_without_default,
39    clippy::single_match,
40    clippy::useless_format,
41    clippy::derive_partial_eq_without_eq,
42    clippy::derived_hash_with_manual_eq,
43    clippy::too_many_arguments,
44    clippy::type_complexity,
45    clippy::bool_to_int_with_if,
46    clippy::needless_question_mark,
47    clippy::needless_lifetimes,
48    clippy::too_long_first_doc_paragraph,
49    clippy::len_zero,
50    clippy::collapsible_match,
51    // We are not implementing queries here so it's fine
52    rustc::potential_query_instability,
53)]
54#![warn(
55    rust_2018_idioms,
56    unqualified_local_imports,
57    clippy::as_conversions,
58    clippy::manual_let_else
59)]
60// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
61#![recursion_limit = "256"]
62
63// The rustc crates we need
64extern crate rustc_abi;
65extern crate rustc_apfloat;
66extern crate rustc_ast;
67extern crate rustc_codegen_ssa;
68extern crate rustc_const_eval;
69extern crate rustc_data_structures;
70extern crate rustc_errors;
71extern crate rustc_hir;
72extern crate rustc_index;
73extern crate rustc_log;
74extern crate rustc_middle;
75extern crate rustc_session;
76extern crate rustc_span;
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 _};
108use rustc_log::tracing::{self, info, trace};
109use 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::{Instant, MonotonicClock};
136pub use crate::concurrency::blocking_io::{BlockingIoManager, EvalContextExt as _, WithSource};
137pub use crate::concurrency::cpu_affinity::MAX_CPUS;
138pub use crate::concurrency::data_race::{
139    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
140};
141pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
142pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
143pub use crate::concurrency::thread::{
144    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
145    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
146};
147pub use crate::concurrency::{GenmcConfig, GenmcCtx, run_genmc_mode};
148pub use crate::data_structures::dedup_range_map::DedupRangeMap;
149pub use crate::data_structures::mono_hash_map::MonoHashMap;
150pub use crate::diagnostics::{
151    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_result,
152};
153pub use crate::eval::{MiriConfig, MiriEntryFnType, create_ecx, eval_entry};
154pub use crate::helpers::{EvalContextExt as _, ToU64 as _, ToUsize as _};
155pub use crate::intrinsics::EvalContextExt as _;
156pub use crate::machine::{
157    AlignmentCheck, AllocExtra, BacktraceStyle, DynMachineCallback, FloatRoundingErrorMode,
158    FrameExtra, IsolatedOp, MachineCallback, MemoryKind, MiriInterpCx, MiriInterpCxExt,
159    MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra, RejectOpWith,
160    ValidationMode,
161};
162pub use crate::operator::EvalContextExt as _;
163pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
164pub use crate::shims::EmulateItemResult;
165pub use crate::shims::env::{EnvVars, EvalContextExt as _};
166pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
167pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
168pub use crate::shims::os_str::EvalContextExt as _;
169pub use crate::shims::panic::EvalContextExt as _;
170pub use crate::shims::sig::EvalContextExt as _;
171pub use crate::shims::time::EvalContextExt as _;
172pub use crate::shims::tls::TlsData;
173pub use crate::shims::unwind::{CatchUnwindData, EvalContextExt as _};
174
175/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
176/// set per default, for maximal validation power.
177/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
178/// does that too, and with a better error message.
179pub const MIRI_DEFAULT_ARGS: &[&str] = &[
180    "--cfg=miri",
181    "-Zalways-encode-mir",
182    "-Zextra-const-ub-checks",
183    "-Zmir-emit-retag",
184    "-Zmir-preserve-ub",
185    "-Zmir-opt-level=0",
186    "-Zmir-enable-passes=-CheckAlignment,-CheckNull,-CheckEnums",
187    // Deduplicating diagnostics means we miss events when tracking what happens during an
188    // execution. Let's not do that.
189    "-Zdeduplicate-diagnostics=no",
190];
miri/lib.rs

miri/
lib.rs
