miri/
lib.rs

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

miri/
lib.rs
