miri/
lib.rs

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

miri/
lib.rs
