miri/
lib.rs

Help
1#![feature(rustc_private)]
2#![feature(cfg_match)]
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// 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(
47    rust_2018_idioms,
48    unqualified_local_imports,
49    clippy::cast_possible_wrap, // unsigned -> signed
50    clippy::cast_sign_loss, // signed -> unsigned
51    clippy::cast_lossless,
52    clippy::cast_possible_truncation,
53)]
54// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
55#![recursion_limit = "256"]
56
57// Some "regular" crates we want to share with rustc
58extern crate either;
59extern crate tracing;
60
61// The rustc crates we need
62extern crate rustc_abi;
63extern crate rustc_apfloat;
64extern crate rustc_ast;
65extern crate rustc_attr_parsing;
66extern crate rustc_const_eval;
67extern crate rustc_data_structures;
68extern crate rustc_errors;
69extern crate rustc_hir;
70extern crate rustc_index;
71extern crate rustc_middle;
72extern crate rustc_session;
73extern crate rustc_span;
74extern crate rustc_symbol_mangling;
75extern crate rustc_target;
76// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
77// shipped only as rmeta files.
78#[allow(unused_extern_crates)]
79extern crate rustc_driver;
80
81mod alloc_addresses;
82mod alloc_bytes;
83mod borrow_tracker;
84mod clock;
85mod concurrency;
86mod diagnostics;
87mod eval;
88mod helpers;
89mod intrinsics;
90mod machine;
91mod math;
92mod mono_hash_map;
93mod operator;
94mod provenance_gc;
95mod range_map;
96mod shims;
97
98// Establish a "crate-wide prelude": we often import `crate::*`.
99// Make all those symbols available in the same place as our own.
100#[doc(no_inline)]
101pub use rustc_const_eval::interpret::*;
102// Resolve ambiguity.
103#[doc(no_inline)]
104pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
105use rustc_middle::{bug, span_bug};
106use tracing::{info, trace};
107
108// Type aliases that set the provenance parameter.
109pub type Pointer = interpret::Pointer<Option<machine::Provenance>>;
110pub type StrictPointer = interpret::Pointer<machine::Provenance>;
111pub type Scalar = interpret::Scalar<machine::Provenance>;
112pub type ImmTy<'tcx> = interpret::ImmTy<'tcx, machine::Provenance>;
113pub type OpTy<'tcx> = interpret::OpTy<'tcx, machine::Provenance>;
114pub type PlaceTy<'tcx> = interpret::PlaceTy<'tcx, machine::Provenance>;
115pub type MPlaceTy<'tcx> = interpret::MPlaceTy<'tcx, machine::Provenance>;
116
117pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
118pub use crate::alloc_bytes::MiriAllocBytes;
119pub use crate::borrow_tracker::stacked_borrows::{
120    EvalContextExt as _, Item, Permission, Stack, Stacks,
121};
122pub use crate::borrow_tracker::tree_borrows::{EvalContextExt as _, Tree};
123pub use crate::borrow_tracker::{BorTag, BorrowTrackerMethod, EvalContextExt as _, RetagFields};
124pub use crate::clock::{Clock, Instant};
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 _, InitOnceId};
130pub use crate::concurrency::sync::{
131    CondvarId, EvalContextExt as _, MutexRef, RwLockId, SynchronizationObjects,
132};
133pub use crate::concurrency::thread::{
134    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
135    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
136};
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::{AccessKind, EvalContextExt as _};
145pub use crate::intrinsics::EvalContextExt as _;
146pub use crate::machine::{
147    AllocExtra, DynMachineCallback, FrameExtra, MachineCallback, MemoryKind, MiriInterpCx,
148    MiriInterpCxExt, MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra,
149};
150pub use crate::mono_hash_map::MonoHashMap;
151pub use crate::operator::EvalContextExt as _;
152pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
153pub use crate::range_map::RangeMap;
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::{CatchUnwindData, EvalContextExt as _};
160pub use crate::shims::time::EvalContextExt as _;
161pub use crate::shims::tls::TlsData;
162
163/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
164/// set per default, for maximal validation power.
165/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
166/// does that too, and with a better error message.
167pub const MIRI_DEFAULT_ARGS: &[&str] = &[
168    "--cfg=miri",
169    "-Zalways-encode-mir",
170    "-Zextra-const-ub-checks",
171    "-Zmir-emit-retag",
172    "-Zmir-keep-place-mention",
173    "-Zmir-opt-level=0",
174    "-Zmir-enable-passes=-CheckAlignment,-CheckNull",
175    // Deduplicating diagnostics means we miss events when tracking what happens during an
176    // execution. Let's not do that.
177    "-Zdeduplicate-diagnostics=no",
178];
miri/lib.rs

miri/
lib.rs
