src/tools/miri/src/lib.rs

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