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(int_log)]
   7 #![feature(variant_count)]
   8 #![feature(yeet_expr)]
   9 #![feature(is_some_and)]
  10 #![feature(nonzero_ops)]
  11 #![feature(local_key_cell_methods)]
  12 #![feature(is_terminal)]
  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     clippy::bool_to_int_with_if,
  31     // We are not implementing queries here so it's fine
  32     rustc::potential_query_instability
  33 )]
  34 #![warn(
  35     rust_2018_idioms,
  36     clippy::cast_possible_wrap, // unsigned -> signed
  37     clippy::cast_sign_loss, // signed -> unsigned
  38     clippy::cast_lossless,
  39     clippy::cast_possible_truncation,
  40 )]
  41 // Needed for rustdoc from bootstrap (with `-Znormalize-docs`).
  42 #![recursion_limit = "256"]
  43
  44 extern crate rustc_apfloat;
  45 extern crate rustc_ast;
  46 #[macro_use]
  47 extern crate rustc_middle;
  48 extern crate rustc_const_eval;
  49 extern crate rustc_data_structures;
  50 extern crate rustc_hir;
  51 extern crate rustc_index;
  52 extern crate rustc_session;
  53 extern crate rustc_span;
  54 extern crate rustc_target;
  55
  56 mod clock;
  57 mod concurrency;
  58 mod diagnostics;
  59 mod eval;
  60 mod helpers;
  61 mod intptrcast;
  62 mod machine;
  63 mod mono_hash_map;
  64 mod operator;
  65 mod range_map;
  66 mod shims;
  67 mod stacked_borrows;
  68 mod tag_gc;
  69
  70 // Establish a "crate-wide prelude": we often import `crate::*`.
  71
  72 // Make all those symbols available in the same place as our own.
  73 pub use rustc_const_eval::interpret::*;
  74 // Resolve ambiguity.
  75 pub use rustc_const_eval::interpret::{self, AllocMap, PlaceTy, Provenance as _};
  76
  77 pub use crate::shims::dlsym::{Dlsym, EvalContextExt as _};
  78 pub use crate::shims::env::{EnvVars, EvalContextExt as _};
  79 pub use crate::shims::foreign_items::EvalContextExt as _;
  80 pub use crate::shims::intrinsics::EvalContextExt as _;
  81 pub use crate::shims::os_str::EvalContextExt as _;
  82 pub use crate::shims::panic::{CatchUnwindData, EvalContextExt as _};
  83 pub use crate::shims::time::EvalContextExt as _;
  84 pub use crate::shims::tls::{EvalContextExt as _, TlsData};
  85 pub use crate::shims::EvalContextExt as _;
  86
  87 pub use crate::clock::{Clock, Instant};
  88 pub use crate::concurrency::{
  89     data_race::{AtomicFenceOrd, AtomicReadOrd, AtomicRwOrd, AtomicWriteOrd, EvalContextExt as _},
  90     init_once::{EvalContextExt as _, InitOnceId},
  91     sync::{CondvarId, EvalContextExt as _, MutexId, RwLockId, SyncId},
  92     thread::{EvalContextExt as _, SchedulingAction, ThreadId, ThreadManager, ThreadState, Time},
  93 };
  94 pub use crate::diagnostics::{
  95     report_error, EvalContextExt as _, NonHaltingDiagnostic, TerminationInfo,
  96 };
  97 pub use crate::eval::{
  98     create_ecx, eval_entry, AlignmentCheck, BacktraceStyle, IsolatedOp, MiriConfig, RejectOpWith,
  99 };
 100 pub use crate::helpers::{CurrentSpan, EvalContextExt as _};
 101 pub use crate::intptrcast::ProvenanceMode;
 102 pub use crate::machine::{
 103     AllocExtra, FrameData, MiriInterpCx, MiriInterpCxExt, MiriMachine, MiriMemoryKind,
 104     PrimitiveLayouts, Provenance, ProvenanceExtra, PAGE_SIZE, STACK_ADDR, STACK_SIZE,
 105 };
 106 pub use crate::mono_hash_map::MonoHashMap;
 107 pub use crate::operator::EvalContextExt as _;
 108 pub use crate::range_map::RangeMap;
 109 pub use crate::stacked_borrows::{
 110     CallId, EvalContextExt as _, Item, Permission, RetagFields, SbTag, Stack, Stacks,
 111 };
 112 pub use crate::tag_gc::{EvalContextExt as _, VisitTags};
 113
 114 /// Insert rustc arguments at the beginning of the argument list that Miri wants to be
 115 /// set per default, for maximal validation power.
 116 pub const MIRI_DEFAULT_ARGS: &[&str] = &[
 117     "-Zalways-encode-mir",
 118     "-Zmir-emit-retag",
 119     "-Zmir-opt-level=0",
 120     "--cfg=miri",
 121     "-Cdebug-assertions=on",
 122     "-Zextra-const-ub-checks",
 123 ];