miri/
lib.rs

1#![feature(abort_unwind)]
2#![feature(rustc_private)]
3#![feature(float_gamma)]
4#![feature(float_erf)]
5#![feature(map_try_insert)]
6#![feature(never_type)]
7#![feature(try_blocks)]
8#![feature(io_error_more)]
9#![feature(variant_count)]
10#![feature(yeet_expr)]
11#![feature(nonzero_ops)]
12#![feature(pointer_is_aligned_to)]
13#![feature(ptr_metadata)]
14#![feature(unqualified_local_imports)]
15#![feature(derive_coerce_pointee)]
16#![feature(arbitrary_self_types)]
17#![feature(iter_advance_by)]
18#![feature(macro_metavar_expr)]
19// Configure clippy and other lints
20#![allow(
21    clippy::collapsible_else_if,
22    clippy::collapsible_if,
23    clippy::if_same_then_else,
24    clippy::comparison_chain,
25    clippy::enum_variant_names,
26    clippy::field_reassign_with_default,
27    clippy::manual_map,
28    clippy::neg_cmp_op_on_partial_ord,
29    clippy::new_without_default,
30    clippy::single_match,
31    clippy::useless_format,
32    clippy::derive_partial_eq_without_eq,
33    clippy::derived_hash_with_manual_eq,
34    clippy::too_many_arguments,
35    clippy::type_complexity,
36    clippy::bool_to_int_with_if,
37    clippy::needless_question_mark,
38    clippy::needless_lifetimes,
39    clippy::too_long_first_doc_paragraph,
40    clippy::len_zero,
41    clippy::collapsible_match,
42    // We are not implementing queries here so it's fine
43    rustc::potential_query_instability,
44    // FIXME: Unused features should be removed in the future
45    unused_features,
46)]
47#![warn(
48    rust_2018_idioms,
49    unqualified_local_imports,
50    clippy::as_conversions,
51    clippy::manual_let_else
52)]
53// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
54#![recursion_limit = "256"]
55
56// The rustc crates we need
57extern crate rustc_abi;
58extern crate rustc_apfloat;
59extern crate rustc_ast;
60extern crate rustc_codegen_ssa;
61extern crate rustc_const_eval;
62extern crate rustc_data_structures;
63extern crate rustc_errors;
64extern crate rustc_hir;
65extern crate rustc_index;
66extern crate rustc_log;
67extern crate rustc_middle;
68extern crate rustc_session;
69extern crate rustc_span;
70extern crate rustc_symbol_mangling;
71extern crate rustc_target;
72// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
73// shipped only as rmeta files.
74#[allow(unused_extern_crates)]
75extern crate rustc_driver;
76
77mod alloc;
78mod alloc_addresses;
79mod borrow_tracker;
80mod clock;
81mod concurrency;
82mod data_structures;
83mod diagnostics;
84mod eval;
85mod helpers;
86mod intrinsics;
87mod machine;
88mod math;
89mod operator;
90mod provenance_gc;
91mod shims;
92pub mod sym;
93
94// Establish a "crate-wide prelude": we often import `crate::*`.
95// Make all those symbols available in the same place as our own.
96#[doc(no_inline)]
97pub use rustc_const_eval::interpret::*;
98// Resolve ambiguity.
99#[doc(no_inline)]
100pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
101use rustc_log::tracing::{self, info, trace};
102use rustc_middle::{bug, span_bug};
103
104#[cfg(all(unix, feature = "native-lib"))]
105pub mod native_lib {
106    pub use crate::shims::{init_sv, register_retcode_sv};
107}
108
109// Type aliases that set the provenance parameter.
110pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
111pub type StrictPointer = interpret::Pointer<machine::Provenance>;
112pub type Scalar = interpret::Scalar<machine::Provenance>;
113pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
114pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
115pub type FnArg<'tcx> = interpret::FnArg<'tcx, machine::Provenance>;
116pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
117pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
118
119pub use crate::alloc::MiriAllocBytes;
120pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
121pub use crate::borrow_tracker::stacked_borrows::{
122    EvalContextExt as _, Item, Permission, Stack, Stacks,
123};
124pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
125pub use crate::borrow_tracker::{
126    BorTag, BorrowTrackerMethod, EvalContextExt as _, TreeBorrowsParams,
127};
128pub use crate::clock::{Instant, MonotonicClock};
129pub use crate::concurrency::cpu_affinity::MAX_CPUS;
130pub use crate::concurrency::data_race::{
131    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
132};
133pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
134pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
135pub use crate::concurrency::thread::{
136    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
137    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
138};
139pub use crate::concurrency::{GenmcConfig, GenmcCtx, run_genmc_mode};
140pub use crate::data_structures::dedup_range_map::DedupRangeMap;
141pub use crate::data_structures::mono_hash_map::MonoHashMap;
142pub use crate::diagnostics::{
143    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_result,
144};
145pub use crate::eval::{MiriConfig, MiriEntryFnType, create_ecx, eval_entry};
146pub use crate::helpers::{EvalContextExt as _, ToU64 as _, ToUsize as _};
147pub use crate::intrinsics::EvalContextExt as _;
148pub use crate::machine::{
149    AlignmentCheck, AllocExtra, BacktraceStyle, DynMachineCallback, FloatRoundingErrorMode,
150    FrameExtra, IsolatedOp, MachineCallback, MemoryKind, MiriInterpCx, MiriInterpCxExt,
151    MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra, RejectOpWith,
152    ValidationMode,
153};
154pub use crate::operator::EvalContextExt as _;
155pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
156pub use crate::shims::EmulateItemResult;
157pub use crate::shims::env::{EnvVars, EvalContextExt as _};
158pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
159pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
160pub use crate::shims::os_str::EvalContextExt as _;
161pub use crate::shims::panic::EvalContextExt as _;
162pub use crate::shims::sig::EvalContextExt as _;
163pub use crate::shims::time::EvalContextExt as _;
164pub use crate::shims::tls::TlsData;
165pub use crate::shims::unwind::{CatchUnwindData, EvalContextExt as _};
166
167/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
168/// set per default, for maximal validation power.
169/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
170/// does that too, and with a better error message.
171pub const MIRI_DEFAULT_ARGS: &[&str] = &[
172    "--cfg=miri",
173    "-Zalways-encode-mir",
174    "-Zextra-const-ub-checks",
175    "-Zmir-emit-retag",
176    "-Zmir-preserve-ub",
177    "-Zmir-opt-level=0",
178    "-Zmir-enable-passes=-CheckAlignment,-CheckNull,-CheckEnums",
179    // Deduplicating diagnostics means we miss events when tracking what happens during an
180    // execution. Let's not do that.
181    "-Zdeduplicate-diagnostics=no",
182];
miri/lib.rs

miri/
lib.rs
