miri/
lib.rs

Help
1#![cfg_attr(bootstrap, feature(trait_upcasting))]
2#![feature(rustc_private)]
3#![feature(cell_update)]
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(let_chains)]
14#![feature(strict_overflow_ops)]
15#![feature(pointer_is_aligned_to)]
16#![feature(unqualified_local_imports)]
17#![feature(derive_coerce_pointee)]
18#![feature(arbitrary_self_types)]
19#![feature(unsigned_is_multiple_of)]
20#![feature(extract_if)]
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(
49    rust_2018_idioms,
50    unqualified_local_imports,
51    clippy::cast_possible_wrap, // unsigned -> signed
52    clippy::cast_sign_loss, // signed -> unsigned
53    clippy::cast_lossless,
54    clippy::cast_possible_truncation,
55)]
56// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
57#![recursion_limit = "256"]
58
59// Some "regular" crates we want to share with rustc
60extern crate either;
61extern crate tracing;
62
63// The rustc crates we need
64extern crate rustc_abi;
65extern crate rustc_apfloat;
66extern crate rustc_ast;
67extern crate rustc_attr_parsing;
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_middle;
74extern crate rustc_session;
75extern crate rustc_span;
76extern crate rustc_target;
77// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
78// shipped only as rmeta files.
79#[allow(unused_extern_crates)]
80extern crate rustc_driver;
81
82mod alloc_addresses;
83mod alloc_bytes;
84mod borrow_tracker;
85mod clock;
86mod concurrency;
87mod diagnostics;
88mod eval;
89mod helpers;
90mod intrinsics;
91mod machine;
92mod math;
93mod mono_hash_map;
94mod operator;
95mod provenance_gc;
96mod range_map;
97mod shims;
98
99// Establish a "crate-wide prelude": we often import `crate::*`.
100// Make all those symbols available in the same place as our own.
101#[doc(no_inline)]
102pub use rustc_const_eval::interpret::*;
103// Resolve ambiguity.
104#[doc(no_inline)]
105pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
106use rustc_middle::{bug, span_bug};
107use tracing::{info, trace};
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 PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
116pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
117
118pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
119pub use crate::alloc_bytes::MiriAllocBytes;
120pub use crate::borrow_tracker::stacked_borrows::{
121    EvalContextExt as _, Item, Permission, Stack, Stacks,
122};
123pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
124pub use crate::borrow_tracker::{BorTag, BorrowTrackerMethod, EvalContextExt as _, RetagFields};
125pub use crate::clock::{Clock, Instant};
126pub use crate::concurrency::cpu_affinity::MAX_CPUS;
127pub use crate::concurrency::data_race::{
128    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
129};
130pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceId};
131pub use crate::concurrency::sync::{
132    CondvarId, EvalContextExt as _, MutexRef, RwLockId, SynchronizationObjects,
133};
134pub use crate::concurrency::thread::{
135    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
136    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
137};
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 _};
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::mono_hash_map::MonoHashMap;
152pub use crate::operator::EvalContextExt as _;
153pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
154pub use crate::range_map::RangeMap;
155pub use crate::shims::EmulateItemResult;
156pub use crate::shims::env::{EnvVars, EvalContextExt as _};
157pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
158pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
159pub use crate::shims::os_str::EvalContextExt as _;
160pub use crate::shims::panic::{CatchUnwindData, EvalContextExt as _};
161pub use crate::shims::time::EvalContextExt as _;
162pub use crate::shims::tls::TlsData;
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-keep-place-mention",
174    "-Zmir-opt-level=0",
175    "-Zmir-enable-passes=-CheckAlignment,-CheckNull",
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
