miri/
lib.rs

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

miri/
lib.rs
