src/tools/miri/src/lib.rs

   1 #![feature(rustc_private)]
   2 #![feature(map_first_last)]
   3 #![feature(map_try_insert)]
   4 #![feature(never_type)]
   5 #![feature(try_blocks)]
   6 #![feature(io_error_more)]
   7 #![feature(int_log)]
   8 #![feature(variant_count)]
   9 #![feature(yeet_expr)]
  10 #![feature(is_some_and)]
  11 #![feature(nonzero_ops)]
  12 #![feature(local_key_cell_methods)]
  13 // Configure clippy and other lints
  14 #![allow(
  15     clippy::collapsible_else_if,
  16     clippy::collapsible_if,
  17     clippy::comparison_chain,
  18     clippy::enum_variant_names,
  19     clippy::field_reassign_with_default,
  20     clippy::manual_map,
  21     clippy::new_without_default,
  22     clippy::single_match,
  23     clippy::useless_format,
  24     clippy::derive_partial_eq_without_eq,
  25     clippy::derive_hash_xor_eq,
  26     clippy::too_many_arguments,
  27     clippy::type_complexity,
  28     clippy::single_element_loop,
  29     clippy::needless_return,
  30     // We are not implementing queries here so it's fine
  31     rustc::potential_query_instability
  32 )]
  33 #![warn(
  34     rust_2018_idioms,
  35     clippy::cast_possible_wrap, // unsigned -> signed
  36     clippy::cast_sign_loss, // signed -> unsigned
  37     clippy::cast_lossless,
  38     clippy::cast_possible_truncation,
  39 )]
  40
  41 extern crate rustc_apfloat;
  42 extern crate rustc_ast;
  43 #[macro_use]
  44 extern crate rustc_middle;
  45 extern crate rustc_const_eval;
  46 extern crate rustc_data_structures;
  47 extern crate rustc_hir;
  48 extern crate rustc_index;
  49 extern crate rustc_session;
  50 extern crate rustc_span;
  51 extern crate rustc_target;
  52
  53 mod clock;
  54 mod concurrency;
  55 mod diagnostics;
  56 mod eval;
  57 mod helpers;
  58 mod intptrcast;
  59 mod machine;
  60 mod mono_hash_map;
  61 mod operator;
  62 mod range_map;
  63 mod shims;
  64 mod stacked_borrows;
  65 mod tag_gc;
  66
  67 // Establish a "crate-wide prelude": we often import `crate::*`.
  68
  69 // Make all those symbols available in the same place as our own.
  70 pub use rustc_const_eval::interpret::*;
  71 // Resolve ambiguity.
  72 pub use rustc_const_eval::interpret::{self, AllocMap, PlaceTy, Provenance as _};
  73
  74 pub use crate::shims::dlsym::{Dlsym, EvalContextExt as _};
  75 pub use crate::shims::env::{EnvVars, EvalContextExt as _};
  76 pub use crate::shims::foreign_items::EvalContextExt as _;
  77 pub use crate::shims::intrinsics::EvalContextExt as _;
  78 pub use crate::shims::os_str::EvalContextExt as _;
  79 pub use crate::shims::panic::{CatchUnwindData, EvalContextExt as _};
  80 pub use crate::shims::time::EvalContextExt as _;
  81 pub use crate::shims::tls::{EvalContextExt as _, TlsData};
  82 pub use crate::shims::EvalContextExt as _;
  83
  84 pub use crate::clock::{Clock, Instant};
  85 pub use crate::concurrency::{
  86     data_race::{
  87         AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd,
  88         EvalContextExt as DataRaceEvalContextExt,
  89     },
  90     sync::{CondvarId, EvalContextExt as SyncEvalContextExt, MutexId, RwLockId},
  91     thread::{
  92         EvalContextExt as ThreadsEvalContextExt, SchedulingAction, ThreadId, ThreadManager,
  93         ThreadState, Time,
  94     },
  95 };
  96 pub use crate::diagnostics::{
  97     report_error, EvalContextExt as DiagnosticsEvalContextExt, NonHaltingDiagnostic,
  98     TerminationInfo,
  99 };
 100 pub use crate::eval::{
 101     create_ecx, eval_entry, AlignmentCheck, BacktraceStyle, IsolatedOp, MiriConfig, RejectOpWith,
 102 };
 103 pub use crate::helpers::{CurrentSpan, EvalContextExt as HelpersEvalContextExt};
 104 pub use crate::intptrcast::ProvenanceMode;
 105 pub use crate::machine::{
 106     AllocExtra, FrameData, MiriInterpCx, MiriInterpCxExt, MiriMachine, MiriMemoryKind, Provenance,
 107     ProvenanceExtra, PAGE_SIZE, STACK_ADDR, STACK_SIZE,
 108 };
 109 pub use crate::mono_hash_map::MonoHashMap;
 110 pub use crate::operator::EvalContextExt as OperatorEvalContextExt;
 111 pub use crate::range_map::RangeMap;
 112 pub use crate::stacked_borrows::{
 113     CallId, EvalContextExt as StackedBorEvalContextExt, Item, Permission, SbTag, Stack, Stacks,
 114 };
 115 pub use crate::tag_gc::{EvalContextExt as _, VisitTags};
 116
 117 /// Insert rustc arguments at the beginning of the argument list that Miri wants to be
 118 /// set per default, for maximal validation power.
 119 pub const MIRI_DEFAULT_ARGS: &[&str] = &[
 120     "-Zalways-encode-mir",
 121     "-Zmir-emit-retag",
 122     "-Zmir-opt-level=0",
 123     "--cfg=miri",
 124     "-Cdebug-assertions=on",
 125     "-Zextra-const-ub-checks",
 126 ];