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#![cfg_attr(bootstrap, feature(nonnull_provenance))]
14#![feature(strict_overflow_ops)]
15#![feature(pointer_is_aligned_to)]
16#![feature(ptr_metadata)]
17#![feature(unqualified_local_imports)]
18#![feature(derive_coerce_pointee)]
19#![feature(arbitrary_self_types)]
20#![cfg_attr(bootstrap, feature(file_lock))]
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(rust_2018_idioms, unqualified_local_imports, clippy::as_conversions)]
49// Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
50#![recursion_limit = "256"]
51
52// Some "regular" crates we want to share with rustc
53extern crate either;
54extern crate tracing;
55
56// The rustc crates we need
57extern crate rustc_abi;
58extern crate rustc_apfloat;
59extern crate rustc_ast;
60extern crate rustc_attr_data_structures;
61extern crate rustc_const_eval;
62extern crate rustc_data_structures;
63extern crate rustc_errors;
64extern crate rustc_hir;
65extern crate rustc_index;
66extern crate rustc_middle;
67extern crate rustc_session;
68extern crate rustc_span;
69extern crate rustc_symbol_mangling;
70extern crate rustc_target;
71// Linking `rustc_driver` pulls in the required  object code as the rest of the rustc crates are
72// shipped only as rmeta files.
73#[allow(unused_extern_crates)]
74extern crate rustc_driver;
75
76mod alloc;
77mod alloc_addresses;
78mod borrow_tracker;
79mod clock;
80mod concurrency;
81mod diagnostics;
82mod eval;
83mod helpers;
84mod intrinsics;
85mod machine;
86mod math;
87mod mono_hash_map;
88mod operator;
89mod provenance_gc;
90mod range_map;
91mod shims;
92
93// Establish a "crate-wide prelude": we often import `crate::*`.
94// Make all those symbols available in the same place as our own.
95#[doc(no_inline)]
96pub use rustc_const_eval::interpret::*;
97// Resolve ambiguity.
98#[doc(no_inline)]
99pub use rustc_const_eval::interpret::{self, AllocMap, Provenance as _};
100use rustc_middle::{bug, span_bug};
101use tracing::{info, trace};
102
103//#[cfg(target_os = "linux")]
104//pub mod native_lib {
105//    pub use crate::shims::{init_sv, register_retcode_sv};
106//}
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::MiriAllocBytes;
118pub use crate::alloc_addresses::{EvalContextExt as _, ProvenanceMode};
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::{
124    BorTag, BorrowTrackerMethod, EvalContextExt as _, RetagFields, TreeBorrowsParams,
125};
126pub use crate::clock::{Instant, MonotonicClock};
127pub use crate::concurrency::cpu_affinity::MAX_CPUS;
128pub use crate::concurrency::data_race::{
129    AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _,
130};
131pub use crate::concurrency::init_once::{EvalContextExt as _, InitOnceId};
132pub use crate::concurrency::sync::{
133    CondvarId, EvalContextExt as _, MutexRef, RwLockRef, SynchronizationObjects,
134};
135pub use crate::concurrency::thread::{
136    BlockReason, DynUnblockCallback, EvalContextExt as _, StackEmptyCallback, ThreadId,
137    ThreadManager, TimeoutAnchor, TimeoutClock, UnblockKind,
138};
139pub use crate::concurrency::{GenmcConfig, GenmcCtx};
140pub use crate::diagnostics::{
141    EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo, report_error,
142};
143pub use crate::eval::{
144    AlignmentCheck, BacktraceStyle, IsolatedOp, MiriConfig, MiriEntryFnType, RejectOpWith,
145    ValidationMode, create_ecx, eval_entry,
146};
147pub use crate::helpers::{AccessKind, EvalContextExt as _, ToU64 as _, ToUsize as _};
148pub use crate::intrinsics::EvalContextExt as _;
149pub use crate::machine::{
150    AllocExtra, DynMachineCallback, FrameExtra, MachineCallback, MemoryKind, MiriInterpCx,
151    MiriInterpCxExt, MiriMachine, MiriMemoryKind, PrimitiveLayouts, Provenance, ProvenanceExtra,
152};
153pub use crate::mono_hash_map::MonoHashMap;
154pub use crate::operator::EvalContextExt as _;
155pub use crate::provenance_gc::{EvalContextExt as _, LiveAllocs, VisitProvenance, VisitWith};
156pub use crate::range_map::RangeMap;
157pub use crate::shims::EmulateItemResult;
158pub use crate::shims::env::{EnvVars, EvalContextExt as _};
159pub use crate::shims::foreign_items::{DynSym, EvalContextExt as _};
160pub use crate::shims::io_error::{EvalContextExt as _, IoError, LibcError};
161pub use crate::shims::os_str::EvalContextExt as _;
162pub use crate::shims::panic::{CatchUnwindData, EvalContextExt as _};
163pub use crate::shims::time::EvalContextExt as _;
164pub use crate::shims::tls::TlsData;
165
166/// Insert rustc arguments at the beginning of the argument list that Miri wants to be
167/// set per default, for maximal validation power.
168/// Also disable the MIR pass that inserts an alignment check on every pointer dereference. Miri
169/// does that too, and with a better error message.
170pub const MIRI_DEFAULT_ARGS: &[&str] = &[
171    "--cfg=miri",
172    "-Zalways-encode-mir",
173    "-Zextra-const-ub-checks",
174    "-Zmir-emit-retag",
175    "-Zmir-preserve-ub",
176    "-Zmir-opt-level=0",
177    "-Zmir-enable-passes=-CheckAlignment,-CheckNull,-CheckEnums",
178    // Deduplicating diagnostics means we miss events when tracking what happens during an
179    // execution. Let's not do that.
180    "-Zdeduplicate-diagnostics=no",
181];
miri/lib.rs

miri/
lib.rs
