miri/
lib.rs

1#![feature(cfg_select)]
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(strict_overflow_ops)]
13#![feature(pointer_is_aligned_to)]
14#![feature(ptr_metadata)]
15#![feature(unqualified_local_imports)]
16#![feature(derive_coerce_pointee)]
17#![feature(arbitrary_self_types)]
18#![feature(iter_advance_by)]
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    // We don't use translatable diagnostics
41    rustc::diagnostic_outside_of_impl,
42    // We are not implementing queries here so it's fine
43    rustc::potential_query_instability,
44    rustc::untranslatable_diagnostic,
45)]
46#![warn(rust_2018_idioms, unqualified_local_imports, clippy::as_conversions)]
47// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
48#![recursion_limit = "256"]
49
50// Some "regular" crates we want to share with rustc
51extern crate either;
52extern crate tracing;
53
54// The rustc crates we need
55extern crate rustc_abi;
56extern crate rustc_apfloat;
57extern crate rustc_ast;
58extern crate rustc_attr_data_structures;
59extern crate rustc_const_eval;
60extern crate rustc_data_structures;
61extern crate rustc_errors;
62extern crate rustc_hir;
63extern crate rustc_index;
64extern crate rustc_middle;
65extern crate rustc_session;
66extern crate rustc_span;
67extern crate rustc_symbol_mangling;
68extern crate rustc_target;
69// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
70// shipped only as rmeta files.
71#[allow(unused_extern_crates)]
72extern crate rustc_driver;
73
74mod alloc;
75mod alloc_addresses;
76mod borrow_tracker;
77mod clock;
78mod concurrency;
79mod data_structures;
80mod diagnostics;
81mod eval;
82mod helpers;
83mod intrinsics;
84mod machine;
85mod math;
86mod operator;
87mod provenance_gc;
88mod shims;
89
90// Establish a "crate-wide prelude": we often import `crate::*`.
91// Make all those symbols available in the same place as our own.
92#[doc(no_inline)]
93pub use rustc_const_eval::interpret::*;
94// Resolve ambiguity.
95#[doc(no_inline)]
96pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
97use rustc_middle::{bug, span_bug};
98use tracing::{info, trace};
99
100#[cfg(target_os = "linux")]
101pub mod native_lib {
102    pub use crate::shims::{init_sv, register_retcode_sv};
103}
104
105// Type aliases that set the provenance parameter.
106pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
107pub type StrictPointer = interpret::Pointer<machine::Provenance>;
108pub type Scalar = interpret::Scalar<machine::Provenance>;
109pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
110pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
111pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
112pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
113
114pub use crate::alloc::MiriAllocBytes;
115pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
116pub use crate::borrow_tracker::stacked_borrows::{
117    EvalContextExt as _, Item, Permission, Stack, Stacks,
118};
119pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
120pub use crate::borrow_tracker::{
121    BorTag, BorrowTrackerMethod, EvalContextExt as _, RetagFields, TreeBorrowsParams,
122};
123pub use crate::clock::{Instant, MonotonicClock};
124pub use crate::concurrency::cpu_affinity::MAX_CPUS;
125pub use crate::concurrency::data_race::{
126    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
127};
128pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceRef};
129pub use crate::concurrency::sync::{CondvarRef, EvalContextExt as _, MutexRef, RwLockRef};
130pub use crate::concurrency::thread::{
131    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
132    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
133};
134pub use crate::concurrency::{GenmcConfig, GenmcCtx};
135pub use crate::data_structures::dedup_range_map::DedupRangeMap;
136pub use crate::data_structures::mono_hash_map::MonoHashMap;
137pub use crate::diagnostics::{
138    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_error,
139};
140pub use crate::eval::{
141    AlignmentCheck, BacktraceStyle, IsolatedOp, MiriConfig, MiriEntryFnType, RejectOpWith,
142    ValidationMode, create_ecx, eval_entry,
143};
144pub use crate::helpers::{
145    AccessKind, EvalContextExt as _, MaybeEnteredTraceSpan, ToU64 as _, ToUsize as _,
146};
147pub use crate::intrinsics::EvalContextExt as _;
148pub use crate::machine::{
149    AllocExtra, DynMachineCallback, FrameExtra, MachineCallback, MemoryKind, MiriInterpCx,
150    MiriInterpCxExt, MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra,
151};
152pub use crate::operator::EvalContextExt as _;
153pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
154pub use crate::shims::EmulateItemResult;
155pub use crate::shims::env::{EnvVars, EvalContextExt as _};
156pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
157pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
158pub use crate::shims::os_str::EvalContextExt as _;
159pub use crate::shims::panic::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
