compiler/rustc_const_eval/src/interpret/validity.rs

   1 //! Check the validity invariant of a given value, and tell the user
   2 //! where in the value it got violated.
   3 //! In const context, this goes even further and tries to approximate const safety.
   4 //! That's useful because it means other passes (e.g. promotion) can rely on `const`s
   5 //! to be const-safe.
   6
   7 use std::convert::TryFrom;
   8 use std::fmt::Write;
   9 use std::num::NonZeroUsize;
  10
  11 use rustc_data_structures::fx::FxHashSet;
  12 use rustc_hir as hir;
  13 use rustc_middle::mir::interpret::InterpError;
  14 use rustc_middle::ty;
  15 use rustc_middle::ty::layout::{LayoutOf, TyAndLayout};
  16 use rustc_span::symbol::{sym, Symbol};
  17 use rustc_span::DUMMY_SP;
  18 use rustc_target::abi::{Abi, Scalar as ScalarAbi, Size, VariantIdx, Variants, WrappingRange};
  19
  20 use std::hash::Hash;
  21
  22 use super::{
  23     alloc_range, CheckInAllocMsg, GlobalAlloc, Immediate, InterpCx, InterpResult, MPlaceTy,
  24     Machine, MemPlaceMeta, OpTy, Scalar, ScalarMaybeUninit, ValueVisitor,
  25 };
  26
  27 macro_rules! throw_validation_failure {
  28     ($where:expr, { $( $what_fmt:expr ),+ } $( expected { $( $expected_fmt:expr ),+ } )?) => {{
  29         let mut msg = String::new();
  30         msg.push_str("encountered ");
  31         write!(&mut msg, $($what_fmt),+).unwrap();
  32         $(
  33             msg.push_str(", but expected ");
  34             write!(&mut msg, $($expected_fmt),+).unwrap();
  35         )?
  36         let path = rustc_middle::ty::print::with_no_trimmed_paths!({
  37             let where_ = &$where;
  38             if !where_.is_empty() {
  39                 let mut path = String::new();
  40                 write_path(&mut path, where_);
  41                 Some(path)
  42             } else {
  43                 None
  44             }
  45         });
  46         throw_ub!(ValidationFailure { path, msg })
  47     }};
  48 }
  49
  50 /// If $e throws an error matching the pattern, throw a validation failure.
  51 /// Other errors are passed back to the caller, unchanged -- and if they reach the root of
  52 /// the visitor, we make sure only validation errors and `InvalidProgram` errors are left.
  53 /// This lets you use the patterns as a kind of validation list, asserting which errors
  54 /// can possibly happen:
  55 ///
  56 /// ```
  57 /// let v = try_validation!(some_fn(), some_path, {
  58 ///     Foo | Bar | Baz => { "some failure" },
  59 /// });
  60 /// ```
  61 ///
  62 /// An additional expected parameter can also be added to the failure message:
  63 ///
  64 /// ```
  65 /// let v = try_validation!(some_fn(), some_path, {
  66 ///     Foo | Bar | Baz => { "some failure" } expected { "something that wasn't a failure" },
  67 /// });
  68 /// ```
  69 ///
  70 /// An additional nicety is that both parameters actually take format args, so you can just write
  71 /// the format string in directly:
  72 ///
  73 /// ```
  74 /// let v = try_validation!(some_fn(), some_path, {
  75 ///     Foo | Bar | Baz => { "{:?}", some_failure } expected { "{}", expected_value },
  76 /// });
  77 /// ```
  78 ///
  79 macro_rules! try_validation {
  80     ($e:expr, $where:expr,
  81     $( $( $p:pat_param )|+ => { $( $what_fmt:expr ),+ } $( expected { $( $expected_fmt:expr ),+ } )? ),+ $(,)?
  82     ) => {{
  83         match $e {
  84             Ok(x) => x,
  85             // We catch the error and turn it into a validation failure. We are okay with
  86             // allocation here as this can only slow down builds that fail anyway.
  87             Err(e) => match e.kind() {
  88                 $(
  89                     $($p)|+ =>
  90                        throw_validation_failure!(
  91                             $where,
  92                             { $( $what_fmt ),+ } $( expected { $( $expected_fmt ),+ } )?
  93                         )
  94                 ),+,
  95                 #[allow(unreachable_patterns)]
  96                 _ => Err::<!, _>(e)?,
  97             }
  98         }
  99     }};
 100 }
 101
 102 /// We want to show a nice path to the invalid field for diagnostics,
 103 /// but avoid string operations in the happy case where no error happens.
 104 /// So we track a `Vec<PathElem>` where `PathElem` contains all the data we
 105 /// need to later print something for the user.
 106 #[derive(Copy, Clone, Debug)]
 107 pub enum PathElem {
 108     Field(Symbol),
 109     Variant(Symbol),
 110     GeneratorState(VariantIdx),
 111     CapturedVar(Symbol),
 112     ArrayElem(usize),
 113     TupleElem(usize),
 114     Deref,
 115     EnumTag,
 116     GeneratorTag,
 117     DynDowncast,
 118 }
 119
 120 /// Extra things to check for during validation of CTFE results.
 121 pub enum CtfeValidationMode {
 122     /// Regular validation, nothing special happening.
 123     Regular,
 124     /// Validation of a `const`.
 125     /// `inner` says if this is an inner, indirect allocation (as opposed to the top-level const
 126     /// allocation). Being an inner allocation makes a difference because the top-level allocation
 127     /// of a `const` is copied for each use, but the inner allocations are implicitly shared.
 128     /// `allow_static_ptrs` says if pointers to statics are permitted (which is the case for promoteds in statics).
 129     Const { inner: bool, allow_static_ptrs: bool },
 130 }
 131
 132 /// State for tracking recursive validation of references
 133 pub struct RefTracking<T, PATH = ()> {
 134     pub seen: FxHashSet<T>,
 135     pub todo: Vec<(T, PATH)>,
 136 }
 137
 138 impl<T: Copy + Eq + Hash + std::fmt::Debug, PATH: Default> RefTracking<T, PATH> {
 139     pub fn empty() -> Self {
 140         RefTracking { seen: FxHashSet::default(), todo: vec![] }
 141     }
 142     pub fn new(op: T) -> Self {
 143         let mut ref_tracking_for_consts =
 144             RefTracking { seen: FxHashSet::default(), todo: vec![(op, PATH::default())] };
 145         ref_tracking_for_consts.seen.insert(op);
 146         ref_tracking_for_consts
 147     }
 148
 149     pub fn track(&mut self, op: T, path: impl FnOnce() -> PATH) {
 150         if self.seen.insert(op) {
 151             trace!("Recursing below ptr {:#?}", op);
 152             let path = path();
 153             // Remember to come back to this later.
 154             self.todo.push((op, path));
 155         }
 156     }
 157 }
 158
 159 /// Format a path
 160 fn write_path(out: &mut String, path: &[PathElem]) {
 161     use self::PathElem::*;
 162
 163     for elem in path.iter() {
 164         match elem {
 165             Field(name) => write!(out, ".{}", name),
 166             EnumTag => write!(out, ".<enum-tag>"),
 167             Variant(name) => write!(out, ".<enum-variant({})>", name),
 168             GeneratorTag => write!(out, ".<generator-tag>"),
 169             GeneratorState(idx) => write!(out, ".<generator-state({})>", idx.index()),
 170             CapturedVar(name) => write!(out, ".<captured-var({})>", name),
 171             TupleElem(idx) => write!(out, ".{}", idx),
 172             ArrayElem(idx) => write!(out, "[{}]", idx),
 173             // `.<deref>` does not match Rust syntax, but it is more readable for long paths -- and
 174             // some of the other items here also are not Rust syntax.  Actually we can't
 175             // even use the usual syntax because we are just showing the projections,
 176             // not the root.
 177             Deref => write!(out, ".<deref>"),
 178             DynDowncast => write!(out, ".<dyn-downcast>"),
 179         }
 180         .unwrap()
 181     }
 182 }
 183
 184 // Formats such that a sentence like "expected something {}" to mean
 185 // "expected something <in the given range>" makes sense.
 186 fn wrapping_range_format(r: WrappingRange, max_hi: u128) -> String {
 187     let WrappingRange { start: lo, end: hi } = r;
 188     assert!(hi <= max_hi);
 189     if lo > hi {
 190         format!("less or equal to {}, or greater or equal to {}", hi, lo)
 191     } else if lo == hi {
 192         format!("equal to {}", lo)
 193     } else if lo == 0 {
 194         assert!(hi < max_hi, "should not be printing if the range covers everything");
 195         format!("less or equal to {}", hi)
 196     } else if hi == max_hi {
 197         assert!(lo > 0, "should not be printing if the range covers everything");
 198         format!("greater or equal to {}", lo)
 199     } else {
 200         format!("in the range {:?}", r)
 201     }
 202 }
 203
 204 struct ValidityVisitor<'rt, 'mir, 'tcx, M: Machine<'mir, 'tcx>> {
 205     /// The `path` may be pushed to, but the part that is present when a function
 206     /// starts must not be changed!  `visit_fields` and `visit_array` rely on
 207     /// this stack discipline.
 208     path: Vec<PathElem>,
 209     ref_tracking: Option<&'rt mut RefTracking<MPlaceTy<'tcx, M::PointerTag>, Vec<PathElem>>>,
 210     /// `None` indicates this is not validating for CTFE (but for runtime).
 211     ctfe_mode: Option<CtfeValidationMode>,
 212     ecx: &'rt InterpCx<'mir, 'tcx, M>,
 213 }
 214
 215 impl<'rt, 'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> ValidityVisitor<'rt, 'mir, 'tcx, M> {
 216     fn aggregate_field_path_elem(&mut self, layout: TyAndLayout<'tcx>, field: usize) -> PathElem {
 217         // First, check if we are projecting to a variant.
 218         match layout.variants {
 219             Variants::Multiple { tag_field, .. } => {
 220                 if tag_field == field {
 221                     return match layout.ty.kind() {
 222                         ty::Adt(def, ..) if def.is_enum() => PathElem::EnumTag,
 223                         ty::Generator(..) => PathElem::GeneratorTag,
 224                         _ => bug!("non-variant type {:?}", layout.ty),
 225                     };
 226                 }
 227             }
 228             Variants::Single { .. } => {}
 229         }
 230
 231         // Now we know we are projecting to a field, so figure out which one.
 232         match layout.ty.kind() {
 233             // generators and closures.
 234             ty::Closure(def_id, _) | ty::Generator(def_id, _, _) => {
 235                 let mut name = None;
 236                 // FIXME this should be more descriptive i.e. CapturePlace instead of CapturedVar
 237                 // https://github.com/rust-lang/project-rfc-2229/issues/46
 238                 if let Some(local_def_id) = def_id.as_local() {
 239                     let tables = self.ecx.tcx.typeck(local_def_id);
 240                     if let Some(captured_place) =
 241                         tables.closure_min_captures_flattened(*def_id).nth(field)
 242                     {
 243                         // Sometimes the index is beyond the number of upvars (seen
 244                         // for a generator).
 245                         let var_hir_id = captured_place.get_root_variable();
 246                         let node = self.ecx.tcx.hir().get(var_hir_id);
 247                         if let hir::Node::Binding(pat) = node {
 248                             if let hir::PatKind::Binding(_, _, ident, _) = pat.kind {
 249                                 name = Some(ident.name);
 250                             }
 251                         }
 252                     }
 253                 }
 254
 255                 PathElem::CapturedVar(name.unwrap_or_else(|| {
 256                     // Fall back to showing the field index.
 257                     sym::integer(field)
 258                 }))
 259             }
 260
 261             // tuples
 262             ty::Tuple(_) => PathElem::TupleElem(field),
 263
 264             // enums
 265             ty::Adt(def, ..) if def.is_enum() => {
 266                 // we might be projecting *to* a variant, or to a field *in* a variant.
 267                 match layout.variants {
 268                     Variants::Single { index } => {
 269                         // Inside a variant
 270                         PathElem::Field(def.variant(index).fields[field].name)
 271                     }
 272                     Variants::Multiple { .. } => bug!("we handled variants above"),
 273                 }
 274             }
 275
 276             // other ADTs
 277             ty::Adt(def, _) => PathElem::Field(def.non_enum_variant().fields[field].name),
 278
 279             // arrays/slices
 280             ty::Array(..) | ty::Slice(..) => PathElem::ArrayElem(field),
 281
 282             // dyn traits
 283             ty::Dynamic(..) => PathElem::DynDowncast,
 284
 285             // nothing else has an aggregate layout
 286             _ => bug!("aggregate_field_path_elem: got non-aggregate type {:?}", layout.ty),
 287         }
 288     }
 289
 290     fn with_elem<R>(
 291         &mut self,
 292         elem: PathElem,
 293         f: impl FnOnce(&mut Self) -> InterpResult<'tcx, R>,
 294     ) -> InterpResult<'tcx, R> {
 295         // Remember the old state
 296         let path_len = self.path.len();
 297         // Record new element
 298         self.path.push(elem);
 299         // Perform operation
 300         let r = f(self)?;
 301         // Undo changes
 302         self.path.truncate(path_len);
 303         // Done
 304         Ok(r)
 305     }
 306
 307     fn check_wide_ptr_meta(
 308         &mut self,
 309         meta: MemPlaceMeta<M::PointerTag>,
 310         pointee: TyAndLayout<'tcx>,
 311     ) -> InterpResult<'tcx> {
 312         let tail = self.ecx.tcx.struct_tail_erasing_lifetimes(pointee.ty, self.ecx.param_env);
 313         match tail.kind() {
 314             ty::Dynamic(..) => {
 315                 let vtable = self.ecx.scalar_to_ptr(meta.unwrap_meta())?;
 316                 // Direct call to `check_ptr_access_align` checks alignment even on CTFE machines.
 317                 try_validation!(
 318                     self.ecx.check_ptr_access_align(
 319                         vtable,
 320                         3 * self.ecx.tcx.data_layout.pointer_size, // drop, size, align
 321                         self.ecx.tcx.data_layout.pointer_align.abi,
 322                         CheckInAllocMsg::InboundsTest, // will anyway be replaced by validity message
 323                     ),
 324                     self.path,
 325                     err_ub!(DanglingIntPointer(..)) |
 326                     err_ub!(PointerUseAfterFree(..)) =>
 327                         { "dangling vtable pointer in wide pointer" },
 328                     err_ub!(AlignmentCheckFailed { .. }) =>
 329                         { "unaligned vtable pointer in wide pointer" },
 330                     err_ub!(PointerOutOfBounds { .. }) =>
 331                         { "too small vtable" },
 332                 );
 333                 try_validation!(
 334                     self.ecx.read_drop_type_from_vtable(vtable),
 335                     self.path,
 336                     err_ub!(DanglingIntPointer(..)) |
 337                     err_ub!(InvalidFunctionPointer(..)) =>
 338                         { "invalid drop function pointer in vtable (not pointing to a function)" },
 339                     err_ub!(InvalidVtableDropFn(..)) =>
 340                         { "invalid drop function pointer in vtable (function has incompatible signature)" },
 341                     // Stacked Borrows errors can happen here, see https://github.com/rust-lang/miri/issues/2123.
 342                     // (We assume there are no other MachineStop errors possible here.)
 343                     InterpError::MachineStop(_) =>
 344                         { "vtable pointer does not have permission to read drop function pointer" },
 345                 );
 346                 try_validation!(
 347                     self.ecx.read_size_and_align_from_vtable(vtable),
 348                     self.path,
 349                     err_ub!(InvalidVtableSize) =>
 350                         { "invalid vtable: size is bigger than largest supported object" },
 351                     err_ub!(InvalidVtableAlignment(msg)) =>
 352                         { "invalid vtable: alignment {}", msg },
 353                     err_unsup!(ReadPointerAsBytes) => { "invalid size or align in vtable" },
 354                     // Stacked Borrows errors can happen here, see https://github.com/rust-lang/miri/issues/2123.
 355                     // (We assume there are no other MachineStop errors possible here.)
 356                     InterpError::MachineStop(_) =>
 357                         { "vtable pointer does not have permission to read size and alignment" },
 358                 );
 359                 // FIXME: More checks for the vtable.
 360             }
 361             ty::Slice(..) | ty::Str => {
 362                 let _len = try_validation!(
 363                     meta.unwrap_meta().to_machine_usize(self.ecx),
 364                     self.path,
 365                     err_unsup!(ReadPointerAsBytes) => { "non-integer slice length in wide pointer" },
 366                 );
 367                 // We do not check that `len * elem_size <= isize::MAX`:
 368                 // that is only required for references, and there it falls out of the
 369                 // "dereferenceable" check performed by Stacked Borrows.
 370             }
 371             ty::Foreign(..) => {
 372                 // Unsized, but not wide.
 373             }
 374             _ => bug!("Unexpected unsized type tail: {:?}", tail),
 375         }
 376
 377         Ok(())
 378     }
 379
 380     /// Check a reference or `Box`.
 381     fn check_safe_pointer(
 382         &mut self,
 383         value: &OpTy<'tcx, M::PointerTag>,
 384         kind: &str,
 385     ) -> InterpResult<'tcx> {
 386         let value = try_validation!(
 387             self.ecx.read_immediate(value),
 388             self.path,
 389             err_unsup!(ReadPointerAsBytes) => { "part of a pointer" } expected { "a proper pointer or integer value" },
 390         );
 391         // Handle wide pointers.
 392         // Check metadata early, for better diagnostics
 393         let place = try_validation!(
 394             self.ecx.ref_to_mplace(&value),
 395             self.path,
 396             err_ub!(InvalidUninitBytes(None)) => { "uninitialized {}", kind },
 397         );
 398         if place.layout.is_unsized() {
 399             self.check_wide_ptr_meta(place.meta, place.layout)?;
 400         }
 401         // Make sure this is dereferenceable and all.
 402         let size_and_align = try_validation!(
 403             self.ecx.size_and_align_of_mplace(&place),
 404             self.path,
 405             err_ub!(InvalidMeta(msg)) => { "invalid {} metadata: {}", kind, msg },
 406         );
 407         let (size, align) = size_and_align
 408             // for the purpose of validity, consider foreign types to have
 409             // alignment and size determined by the layout (size will be 0,
 410             // alignment should take attributes into account).
 411             .unwrap_or_else(|| (place.layout.size, place.layout.align.abi));
 412         // Direct call to `check_ptr_access_align` checks alignment even on CTFE machines.
 413         try_validation!(
 414             self.ecx.check_ptr_access_align(
 415                 place.ptr,
 416                 size,
 417                 align,
 418                 CheckInAllocMsg::InboundsTest, // will anyway be replaced by validity message
 419             ),
 420             self.path,
 421             err_ub!(AlignmentCheckFailed { required, has }) =>
 422                 {
 423                     "an unaligned {kind} (required {} byte alignment but found {})",
 424                     required.bytes(),
 425                     has.bytes()
 426                 },
 427             err_ub!(DanglingIntPointer(0, _)) =>
 428                 { "a null {kind}" },
 429             err_ub!(DanglingIntPointer(i, _)) =>
 430                 { "a dangling {kind} (address 0x{i:x} is unallocated)" },
 431             err_ub!(PointerOutOfBounds { .. }) =>
 432                 { "a dangling {kind} (going beyond the bounds of its allocation)" },
 433             // This cannot happen during const-eval (because interning already detects
 434             // dangling pointers), but it can happen in Miri.
 435             err_ub!(PointerUseAfterFree(..)) =>
 436                 { "a dangling {kind} (use-after-free)" },
 437         );
 438         // Do not allow pointers to uninhabited types.
 439         if place.layout.abi.is_uninhabited() {
 440             throw_validation_failure!(self.path,
 441                 { "a {kind} pointing to uninhabited type {}", place.layout.ty }
 442             )
 443         }
 444         // Recursive checking
 445         if let Some(ref mut ref_tracking) = self.ref_tracking {
 446             // Proceed recursively even for ZST, no reason to skip them!
 447             // `!` is a ZST and we want to validate it.
 448             if let Ok((alloc_id, _offset, _tag)) = self.ecx.ptr_try_get_alloc_id(place.ptr) {
 449                 // Special handling for pointers to statics (irrespective of their type).
 450                 let alloc_kind = self.ecx.tcx.get_global_alloc(alloc_id);
 451                 if let Some(GlobalAlloc::Static(did)) = alloc_kind {
 452                     assert!(!self.ecx.tcx.is_thread_local_static(did));
 453                     assert!(self.ecx.tcx.is_static(did));
 454                     if matches!(
 455                         self.ctfe_mode,
 456                         Some(CtfeValidationMode::Const { allow_static_ptrs: false, .. })
 457                     ) {
 458                         // See const_eval::machine::MemoryExtra::can_access_statics for why
 459                         // this check is so important.
 460                         // This check is reachable when the const just referenced the static,
 461                         // but never read it (so we never entered `before_access_global`).
 462                         throw_validation_failure!(self.path,
 463                             { "a {} pointing to a static variable", kind }
 464                         );
 465                     }
 466                     // We skip checking other statics. These statics must be sound by
 467                     // themselves, and the only way to get broken statics here is by using
 468                     // unsafe code.
 469                     // The reasons we don't check other statics is twofold. For one, in all
 470                     // sound cases, the static was already validated on its own, and second, we
 471                     // trigger cycle errors if we try to compute the value of the other static
 472                     // and that static refers back to us.
 473                     // We might miss const-invalid data,
 474                     // but things are still sound otherwise (in particular re: consts
 475                     // referring to statics).
 476                     return Ok(());
 477                 }
 478             }
 479             let path = &self.path;
 480             ref_tracking.track(place, || {
 481                 // We need to clone the path anyway, make sure it gets created
 482                 // with enough space for the additional `Deref`.
 483                 let mut new_path = Vec::with_capacity(path.len() + 1);
 484                 new_path.extend(path);
 485                 new_path.push(PathElem::Deref);
 486                 new_path
 487             });
 488         }
 489         Ok(())
 490     }
 491
 492     fn read_scalar(
 493         &self,
 494         op: &OpTy<'tcx, M::PointerTag>,
 495     ) -> InterpResult<'tcx, ScalarMaybeUninit<M::PointerTag>> {
 496         Ok(try_validation!(
 497             self.ecx.read_scalar(op),
 498             self.path,
 499             err_unsup!(ReadPointerAsBytes) => { "(potentially part of) a pointer" } expected { "plain (non-pointer) bytes" },
 500         ))
 501     }
 502
 503     fn read_immediate_forced(
 504         &self,
 505         op: &OpTy<'tcx, M::PointerTag>,
 506     ) -> InterpResult<'tcx, Immediate<M::PointerTag>> {
 507         Ok(*try_validation!(
 508             self.ecx.read_immediate_raw(op, /*force*/ true),
 509             self.path,
 510             err_unsup!(ReadPointerAsBytes) => { "(potentially part of) a pointer" } expected { "plain (non-pointer) bytes" },
 511         ).unwrap())
 512     }
 513
 514     /// Check if this is a value of primitive type, and if yes check the validity of the value
 515     /// at that type.  Return `true` if the type is indeed primitive.
 516     fn try_visit_primitive(
 517         &mut self,
 518         value: &OpTy<'tcx, M::PointerTag>,
 519     ) -> InterpResult<'tcx, bool> {
 520         // Go over all the primitive types
 521         let ty = value.layout.ty;
 522         match ty.kind() {
 523             ty::Bool => {
 524                 let value = self.read_scalar(value)?;
 525                 try_validation!(
 526                     value.to_bool(),
 527                     self.path,
 528                     err_ub!(InvalidBool(..)) | err_ub!(InvalidUninitBytes(None)) =>
 529                         { "{:x}", value } expected { "a boolean" },
 530                 );
 531                 Ok(true)
 532             }
 533             ty::Char => {
 534                 let value = self.read_scalar(value)?;
 535                 try_validation!(
 536                     value.to_char(),
 537                     self.path,
 538                     err_ub!(InvalidChar(..)) | err_ub!(InvalidUninitBytes(None)) =>
 539                         { "{:x}", value } expected { "a valid unicode scalar value (in `0..=0x10FFFF` but not in `0xD800..=0xDFFF`)" },
 540                 );
 541                 Ok(true)
 542             }
 543             ty::Float(_) | ty::Int(_) | ty::Uint(_) => {
 544                 let value = self.read_scalar(value)?;
 545                 // NOTE: Keep this in sync with the array optimization for int/float
 546                 // types below!
 547                 if M::enforce_number_init(self.ecx) {
 548                     try_validation!(
 549                         value.check_init(),
 550                         self.path,
 551                         err_ub!(InvalidUninitBytes(..)) =>
 552                             { "{:x}", value } expected { "initialized bytes" }
 553                     );
 554                 }
 555                 if M::enforce_number_no_provenance(self.ecx) {
 556                     // As a special exception we *do* match on a `Scalar` here, since we truly want
 557                     // to know its underlying representation (and *not* cast it to an integer).
 558                     let is_ptr = value.check_init().map_or(false, |v| matches!(v, Scalar::Ptr(..)));
 559                     if is_ptr {
 560                         throw_validation_failure!(self.path,
 561                             { "{:x}", value } expected { "plain (non-pointer) bytes" }
 562                         )
 563                     }
 564                 }
 565                 Ok(true)
 566             }
 567             ty::RawPtr(..) => {
 568                 // We are conservative with uninit for integers, but try to
 569                 // actually enforce the strict rules for raw pointers (mostly because
 570                 // that lets us re-use `ref_to_mplace`).
 571                 let place = try_validation!(
 572                     self.ecx.read_immediate(value).and_then(|ref i| self.ecx.ref_to_mplace(i)),
 573                     self.path,
 574                     err_ub!(InvalidUninitBytes(None)) => { "uninitialized raw pointer" },
 575                     err_unsup!(ReadPointerAsBytes) => { "part of a pointer" } expected { "a proper pointer or integer value" },
 576                 );
 577                 if place.layout.is_unsized() {
 578                     self.check_wide_ptr_meta(place.meta, place.layout)?;
 579                 }
 580                 Ok(true)
 581             }
 582             ty::Ref(_, ty, mutbl) => {
 583                 if matches!(self.ctfe_mode, Some(CtfeValidationMode::Const { .. }))
 584                     && *mutbl == hir::Mutability::Mut
 585                 {
 586                     // A mutable reference inside a const? That does not seem right (except if it is
 587                     // a ZST).
 588                     let layout = self.ecx.layout_of(*ty)?;
 589                     if !layout.is_zst() {
 590                         throw_validation_failure!(self.path, { "mutable reference in a `const`" });
 591                     }
 592                 }
 593                 self.check_safe_pointer(value, "reference")?;
 594                 Ok(true)
 595             }
 596             ty::Adt(def, ..) if def.is_box() => {
 597                 let unique = self.ecx.operand_field(value, 0)?;
 598                 let nonnull = self.ecx.operand_field(&unique, 0)?;
 599                 let ptr = self.ecx.operand_field(&nonnull, 0)?;
 600                 self.check_safe_pointer(&ptr, "box")?;
 601
 602                 // Check other fields of Box
 603                 self.walk_value(value)?;
 604                 Ok(true)
 605             }
 606             ty::FnPtr(_sig) => {
 607                 let value = try_validation!(
 608                     self.ecx.read_scalar(value).and_then(|v| v.check_init()),
 609                     self.path,
 610                     err_unsup!(ReadPointerAsBytes) => { "part of a pointer" } expected { "a proper pointer or integer value" },
 611                     err_ub!(InvalidUninitBytes(None)) => { "uninitialized bytes" } expected { "a proper pointer or integer value" },
 612                 );
 613
 614                 // If we check references recursively, also check that this points to a function.
 615                 if let Some(_) = self.ref_tracking {
 616                     let ptr = self.ecx.scalar_to_ptr(value)?;
 617                     let _fn = try_validation!(
 618                         self.ecx.get_ptr_fn(ptr),
 619                         self.path,
 620                         err_ub!(DanglingIntPointer(0, _)) =>
 621                             { "a null function pointer" },
 622                         err_ub!(DanglingIntPointer(..)) |
 623                         err_ub!(InvalidFunctionPointer(..)) =>
 624                             { "{:x}", value } expected { "a function pointer" },
 625                     );
 626                     // FIXME: Check if the signature matches
 627                 } else {
 628                     // Otherwise (for standalone Miri), we have to still check it to be non-null.
 629                     if self.ecx.scalar_may_be_null(value)? {
 630                         throw_validation_failure!(self.path, { "a null function pointer" });
 631                     }
 632                 }
 633                 Ok(true)
 634             }
 635             ty::Never => throw_validation_failure!(self.path, { "a value of the never type `!`" }),
 636             ty::Foreign(..) | ty::FnDef(..) => {
 637                 // Nothing to check.
 638                 Ok(true)
 639             }
 640             // The above should be all the primitive types. The rest is compound, we
 641             // check them by visiting their fields/variants.
 642             ty::Adt(..)
 643             | ty::Tuple(..)
 644             | ty::Array(..)
 645             | ty::Slice(..)
 646             | ty::Str
 647             | ty::Dynamic(..)
 648             | ty::Closure(..)
 649             | ty::Generator(..) => Ok(false),
 650             // Some types only occur during typechecking, they have no layout.
 651             // We should not see them here and we could not check them anyway.
 652             ty::Error(_)
 653             | ty::Infer(..)
 654             | ty::Placeholder(..)
 655             | ty::Bound(..)
 656             | ty::Param(..)
 657             | ty::Opaque(..)
 658             | ty::Projection(..)
 659             | ty::GeneratorWitness(..) => bug!("Encountered invalid type {:?}", ty),
 660         }
 661     }
 662
 663     fn visit_scalar(
 664         &mut self,
 665         scalar: ScalarMaybeUninit<M::PointerTag>,
 666         scalar_layout: ScalarAbi,
 667     ) -> InterpResult<'tcx> {
 668         // We check `is_full_range` in a slightly complicated way because *if* we are checking
 669         // number validity, then we want to ensure that `Scalar::Initialized` is indeed initialized,
 670         // i.e. that we go over the `check_init` below.
 671         let size = scalar_layout.size(self.ecx);
 672         let is_full_range = match scalar_layout {
 673             ScalarAbi::Initialized { .. } => {
 674                 if M::enforce_number_init(self.ecx) {
 675                     false // not "full" since uninit is not accepted
 676                 } else {
 677                     scalar_layout.is_always_valid(self.ecx)
 678                 }
 679             }
 680             ScalarAbi::Union { .. } => true,
 681         };
 682         if is_full_range {
 683             // Nothing to check. Cruciall we don't even `read_scalar` until here, since that would
 684             // fail for `Union` scalars!
 685             return Ok(());
 686         }
 687         // We have something to check: it must at least be initialized.
 688         let valid_range = scalar_layout.valid_range(self.ecx);
 689         let WrappingRange { start, end } = valid_range;
 690         let max_value = size.unsigned_int_max();
 691         assert!(end <= max_value);
 692         let value = try_validation!(
 693             scalar.check_init(),
 694             self.path,
 695             err_ub!(InvalidUninitBytes(None)) => { "{:x}", scalar }
 696                 expected { "something {}", wrapping_range_format(valid_range, max_value) },
 697         );
 698         let bits = match value.try_to_int() {
 699             Ok(int) => int.assert_bits(size),
 700             Err(_) => {
 701                 // So this is a pointer then, and casting to an int failed.
 702                 // Can only happen during CTFE.
 703                 // We support 2 kinds of ranges here: full range, and excluding zero.
 704                 if start == 1 && end == max_value {
 705                     // Only null is the niche.  So make sure the ptr is NOT null.
 706                     if self.ecx.scalar_may_be_null(value)? {
 707                         throw_validation_failure!(self.path,
 708                             { "a potentially null pointer" }
 709                             expected {
 710                                 "something that cannot possibly fail to be {}",
 711                                 wrapping_range_format(valid_range, max_value)
 712                             }
 713                         )
 714                     } else {
 715                         return Ok(());
 716                     }
 717                 } else if scalar_layout.is_always_valid(self.ecx) {
 718                     // Easy. (This is reachable if `enforce_number_validity` is set.)
 719                     return Ok(());
 720                 } else {
 721                     // Conservatively, we reject, because the pointer *could* have a bad
 722                     // value.
 723                     throw_validation_failure!(self.path,
 724                         { "a pointer" }
 725                         expected {
 726                             "something that cannot possibly fail to be {}",
 727                             wrapping_range_format(valid_range, max_value)
 728                         }
 729                     )
 730                 }
 731             }
 732         };
 733         // Now compare.
 734         if valid_range.contains(bits) {
 735             Ok(())
 736         } else {
 737             throw_validation_failure!(self.path,
 738                 { "{}", bits }
 739                 expected { "something {}", wrapping_range_format(valid_range, max_value) }
 740             )
 741         }
 742     }
 743 }
 744
 745 impl<'rt, 'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> ValueVisitor<'mir, 'tcx, M>
 746     for ValidityVisitor<'rt, 'mir, 'tcx, M>
 747 {
 748     type V = OpTy<'tcx, M::PointerTag>;
 749
 750     #[inline(always)]
 751     fn ecx(&self) -> &InterpCx<'mir, 'tcx, M> {
 752         &self.ecx
 753     }
 754
 755     fn read_discriminant(
 756         &mut self,
 757         op: &OpTy<'tcx, M::PointerTag>,
 758     ) -> InterpResult<'tcx, VariantIdx> {
 759         self.with_elem(PathElem::EnumTag, move |this| {
 760             Ok(try_validation!(
 761                 this.ecx.read_discriminant(op),
 762                 this.path,
 763                 err_ub!(InvalidTag(val)) =>
 764                     { "{:x}", val } expected { "a valid enum tag" },
 765                 err_ub!(InvalidUninitBytes(None)) =>
 766                     { "uninitialized bytes" } expected { "a valid enum tag" },
 767                 err_unsup!(ReadPointerAsBytes) =>
 768                     { "a pointer" } expected { "a valid enum tag" },
 769             )
 770             .1)
 771         })
 772     }
 773
 774     #[inline]
 775     fn visit_field(
 776         &mut self,
 777         old_op: &OpTy<'tcx, M::PointerTag>,
 778         field: usize,
 779         new_op: &OpTy<'tcx, M::PointerTag>,
 780     ) -> InterpResult<'tcx> {
 781         let elem = self.aggregate_field_path_elem(old_op.layout, field);
 782         self.with_elem(elem, move |this| this.visit_value(new_op))
 783     }
 784
 785     #[inline]
 786     fn visit_variant(
 787         &mut self,
 788         old_op: &OpTy<'tcx, M::PointerTag>,
 789         variant_id: VariantIdx,
 790         new_op: &OpTy<'tcx, M::PointerTag>,
 791     ) -> InterpResult<'tcx> {
 792         let name = match old_op.layout.ty.kind() {
 793             ty::Adt(adt, _) => PathElem::Variant(adt.variant(variant_id).name),
 794             // Generators also have variants
 795             ty::Generator(..) => PathElem::GeneratorState(variant_id),
 796             _ => bug!("Unexpected type with variant: {:?}", old_op.layout.ty),
 797         };
 798         self.with_elem(name, move |this| this.visit_value(new_op))
 799     }
 800
 801     #[inline(always)]
 802     fn visit_union(
 803         &mut self,
 804         op: &OpTy<'tcx, M::PointerTag>,
 805         _fields: NonZeroUsize,
 806     ) -> InterpResult<'tcx> {
 807         // Special check preventing `UnsafeCell` inside unions in the inner part of constants.
 808         if matches!(self.ctfe_mode, Some(CtfeValidationMode::Const { inner: true, .. })) {
 809             if !op.layout.ty.is_freeze(self.ecx.tcx.at(DUMMY_SP), self.ecx.param_env) {
 810                 throw_validation_failure!(self.path, { "`UnsafeCell` in a `const`" });
 811             }
 812         }
 813         Ok(())
 814     }
 815
 816     #[inline]
 817     fn visit_value(&mut self, op: &OpTy<'tcx, M::PointerTag>) -> InterpResult<'tcx> {
 818         trace!("visit_value: {:?}, {:?}", *op, op.layout);
 819
 820         // Check primitive types -- the leaves of our recursive descent.
 821         if self.try_visit_primitive(op)? {
 822             return Ok(());
 823         }
 824         // Sanity check: `builtin_deref` does not know any pointers that are not primitive.
 825         assert!(op.layout.ty.builtin_deref(true).is_none());
 826
 827         // Special check preventing `UnsafeCell` in the inner part of constants
 828         if let Some(def) = op.layout.ty.ty_adt_def() {
 829             if matches!(self.ctfe_mode, Some(CtfeValidationMode::Const { inner: true, .. }))
 830                 && Some(def.did()) == self.ecx.tcx.lang_items().unsafe_cell_type()
 831             {
 832                 throw_validation_failure!(self.path, { "`UnsafeCell` in a `const`" });
 833             }
 834         }
 835
 836         // Recursively walk the value at its type.
 837         self.walk_value(op)?;
 838
 839         // *After* all of this, check the ABI.  We need to check the ABI to handle
 840         // types like `NonNull` where the `Scalar` info is more restrictive than what
 841         // the fields say (`rustc_layout_scalar_valid_range_start`).
 842         // But in most cases, this will just propagate what the fields say,
 843         // and then we want the error to point at the field -- so, first recurse,
 844         // then check ABI.
 845         //
 846         // FIXME: We could avoid some redundant checks here. For newtypes wrapping
 847         // scalars, we do the same check on every "level" (e.g., first we check
 848         // MyNewtype and then the scalar in there).
 849         match op.layout.abi {
 850             Abi::Uninhabited => {
 851                 throw_validation_failure!(self.path,
 852                     { "a value of uninhabited type {:?}", op.layout.ty }
 853                 );
 854             }
 855             Abi::Scalar(scalar_layout) => {
 856                 let scalar = self.read_immediate_forced(op)?.to_scalar_or_uninit();
 857                 self.visit_scalar(scalar, scalar_layout)?;
 858             }
 859             Abi::ScalarPair(a_layout, b_layout) => {
 860                 // We would validate these things as we descend into the fields,
 861                 // but that can miss bugs in layout computation. Layout computation
 862                 // is subtle due to enums having ScalarPair layout, where one field
 863                 // is the discriminant.
 864                 if cfg!(debug_assertions) {
 865                     let (a, b) = self.read_immediate_forced(op)?.to_scalar_or_uninit_pair();
 866                     self.visit_scalar(a, a_layout)?;
 867                     self.visit_scalar(b, b_layout)?;
 868                 }
 869             }
 870             Abi::Vector { .. } => {
 871                 // No checks here, we assume layout computation gets this right.
 872                 // (This is harder to check since Miri does not represent these as `Immediate`.)
 873             }
 874             Abi::Aggregate { .. } => {
 875                 // Nothing to do.
 876             }
 877         }
 878
 879         Ok(())
 880     }
 881
 882     fn visit_aggregate(
 883         &mut self,
 884         op: &OpTy<'tcx, M::PointerTag>,
 885         fields: impl Iterator<Item = InterpResult<'tcx, Self::V>>,
 886     ) -> InterpResult<'tcx> {
 887         match op.layout.ty.kind() {
 888             ty::Str => {
 889                 let mplace = op.assert_mem_place(); // strings are never immediate
 890                 let len = mplace.len(self.ecx)?;
 891                 try_validation!(
 892                     self.ecx.read_bytes_ptr(mplace.ptr, Size::from_bytes(len)),
 893                     self.path,
 894                     err_ub!(InvalidUninitBytes(..)) => { "uninitialized data in `str`" },
 895                     err_unsup!(ReadPointerAsBytes) => { "a pointer in `str`" },
 896                 );
 897             }
 898             ty::Array(tys, ..) | ty::Slice(tys)
 899                 // This optimization applies for types that can hold arbitrary bytes (such as
 900                 // integer and floating point types) or for structs or tuples with no fields.
 901                 // FIXME(wesleywiser) This logic could be extended further to arbitrary structs
 902                 // or tuples made up of integer/floating point types or inhabited ZSTs with no
 903                 // padding.
 904                 if matches!(tys.kind(), ty::Int(..) | ty::Uint(..) | ty::Float(..))
 905                 =>
 906             {
 907                 // Optimized handling for arrays of integer/float type.
 908
 909                 // Arrays cannot be immediate, slices are never immediate.
 910                 let mplace = op.assert_mem_place();
 911                 // This is the length of the array/slice.
 912                 let len = mplace.len(self.ecx)?;
 913                 // This is the element type size.
 914                 let layout = self.ecx.layout_of(*tys)?;
 915                 // This is the size in bytes of the whole array. (This checks for overflow.)
 916                 let size = layout.size * len;
 917
 918                 // Optimization: we just check the entire range at once.
 919                 // NOTE: Keep this in sync with the handling of integer and float
 920                 // types above, in `visit_primitive`.
 921                 // In run-time mode, we accept pointers in here.  This is actually more
 922                 // permissive than a per-element check would be, e.g., we accept
 923                 // a &[u8] that contains a pointer even though bytewise checking would
 924                 // reject it.  However, that's good: We don't inherently want
 925                 // to reject those pointers, we just do not have the machinery to
 926                 // talk about parts of a pointer.
 927                 // We also accept uninit, for consistency with the slow path.
 928                 let Some(alloc) = self.ecx.get_ptr_alloc(mplace.ptr, size, mplace.align)? else {
 929                     // Size 0, nothing more to check.
 930                     return Ok(());
 931                 };
 932
 933                 match alloc.check_bytes(
 934                     alloc_range(Size::ZERO, size),
 935                     /*allow_uninit*/ !M::enforce_number_init(self.ecx),
 936                     /*allow_ptr*/ !M::enforce_number_no_provenance(self.ecx),
 937                 ) {
 938                     // In the happy case, we needn't check anything else.
 939                     Ok(()) => {}
 940                     // Some error happened, try to provide a more detailed description.
 941                     Err(err) => {
 942                         // For some errors we might be able to provide extra information.
 943                         // (This custom logic does not fit the `try_validation!` macro.)
 944                         match err.kind() {
 945                             err_ub!(InvalidUninitBytes(Some((_alloc_id, access)))) => {
 946                                 // Some byte was uninitialized, determine which
 947                                 // element that byte belongs to so we can
 948                                 // provide an index.
 949                                 let i = usize::try_from(
 950                                     access.uninit_offset.bytes() / layout.size.bytes(),
 951                                 )
 952                                 .unwrap();
 953                                 self.path.push(PathElem::ArrayElem(i));
 954
 955                                 throw_validation_failure!(self.path, { "uninitialized bytes" })
 956                             }
 957                             err_unsup!(ReadPointerAsBytes) => {
 958                                 throw_validation_failure!(self.path, { "a pointer" } expected { "plain (non-pointer) bytes" })
 959                             }
 960
 961                             // Propagate upwards (that will also check for unexpected errors).
 962                             _ => return Err(err),
 963                         }
 964                     }
 965                 }
 966             }
 967             // Fast path for arrays and slices of ZSTs. We only need to check a single ZST element
 968             // of an array and not all of them, because there's only a single value of a specific
 969             // ZST type, so either validation fails for all elements or none.
 970             ty::Array(tys, ..) | ty::Slice(tys) if self.ecx.layout_of(*tys)?.is_zst() => {
 971                 // Validate just the first element (if any).
 972                 self.walk_aggregate(op, fields.take(1))?
 973             }
 974             _ => {
 975                 self.walk_aggregate(op, fields)? // default handler
 976             }
 977         }
 978         Ok(())
 979     }
 980 }
 981
 982 impl<'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
 983     fn validate_operand_internal(
 984         &self,
 985         op: &OpTy<'tcx, M::PointerTag>,
 986         path: Vec<PathElem>,
 987         ref_tracking: Option<&mut RefTracking<MPlaceTy<'tcx, M::PointerTag>, Vec<PathElem>>>,
 988         ctfe_mode: Option<CtfeValidationMode>,
 989     ) -> InterpResult<'tcx> {
 990         trace!("validate_operand_internal: {:?}, {:?}", *op, op.layout.ty);
 991
 992         // Construct a visitor
 993         let mut visitor = ValidityVisitor { path, ref_tracking, ctfe_mode, ecx: self };
 994
 995         // Run it.
 996         match visitor.visit_value(&op) {
 997             Ok(()) => Ok(()),
 998             // Pass through validation failures.
 999             Err(err) if matches!(err.kind(), err_ub!(ValidationFailure { .. })) => Err(err),
1000             // Also pass through InvalidProgram, those just indicate that we could not
1001             // validate and each caller will know best what to do with them.
1002             Err(err) if matches!(err.kind(), InterpError::InvalidProgram(_)) => Err(err),
1003             // Avoid other errors as those do not show *where* in the value the issue lies.
1004             Err(err) => {
1005                 err.print_backtrace();
1006                 bug!("Unexpected error during validation: {}", err);
1007             }
1008         }
1009     }
1010
1011     /// This function checks the data at `op` to be const-valid.
1012     /// `op` is assumed to cover valid memory if it is an indirect operand.
1013     /// It will error if the bits at the destination do not match the ones described by the layout.
1014     ///
1015     /// `ref_tracking` is used to record references that we encounter so that they
1016     /// can be checked recursively by an outside driving loop.
1017     ///
1018     /// `constant` controls whether this must satisfy the rules for constants:
1019     /// - no pointers to statics.
1020     /// - no `UnsafeCell` or non-ZST `&mut`.
1021     #[inline(always)]
1022     pub fn const_validate_operand(
1023         &self,
1024         op: &OpTy<'tcx, M::PointerTag>,
1025         path: Vec<PathElem>,
1026         ref_tracking: &mut RefTracking<MPlaceTy<'tcx, M::PointerTag>, Vec<PathElem>>,
1027         ctfe_mode: CtfeValidationMode,
1028     ) -> InterpResult<'tcx> {
1029         self.validate_operand_internal(op, path, Some(ref_tracking), Some(ctfe_mode))
1030     }
1031
1032     /// This function checks the data at `op` to be runtime-valid.
1033     /// `op` is assumed to cover valid memory if it is an indirect operand.
1034     /// It will error if the bits at the destination do not match the ones described by the layout.
1035     #[inline(always)]
1036     pub fn validate_operand(&self, op: &OpTy<'tcx, M::PointerTag>) -> InterpResult<'tcx> {
1037         self.validate_operand_internal(op, vec![], None, None)
1038     }
1039 }