compiler/rustc_middle/src/mir/interpret/error.rs

   1 use super::{AllocId, ConstAlloc, Pointer, Scalar};
   2
   3 use crate::mir::interpret::ConstValue;
   4 use crate::ty::{layout, query::TyCtxtAt, tls, FnSig, Ty};
   5
   6 use rustc_data_structures::sync::Lock;
   7 use rustc_errors::{pluralize, struct_span_err, DiagnosticBuilder, ErrorReported};
   8 use rustc_macros::HashStable;
   9 use rustc_session::CtfeBacktrace;
  10 use rustc_span::def_id::DefId;
  11 use rustc_target::abi::{Align, Size};
  12 use std::{any::Any, backtrace::Backtrace, fmt};
  13
  14 #[derive(Debug, Copy, Clone, PartialEq, Eq, HashStable, TyEncodable, TyDecodable)]
  15 pub enum ErrorHandled {
  16     /// Already reported an error for this evaluation, and the compilation is
  17     /// *guaranteed* to fail. Warnings/lints *must not* produce `Reported`.
  18     Reported(ErrorReported),
  19     /// Already emitted a lint for this evaluation.
  20     Linted,
  21     /// Don't emit an error, the evaluation failed because the MIR was generic
  22     /// and the substs didn't fully monomorphize it.
  23     TooGeneric,
  24 }
  25
  26 impl From<ErrorReported> for ErrorHandled {
  27     fn from(err: ErrorReported) -> ErrorHandled {
  28         ErrorHandled::Reported(err)
  29     }
  30 }
  31
  32 TrivialTypeFoldableAndLiftImpls! {
  33     ErrorHandled,
  34 }
  35
  36 pub type EvalToAllocationRawResult<'tcx> = Result<ConstAlloc<'tcx>, ErrorHandled>;
  37 pub type EvalToConstValueResult<'tcx> = Result<ConstValue<'tcx>, ErrorHandled>;
  38
  39 pub fn struct_error<'tcx>(tcx: TyCtxtAt<'tcx>, msg: &str) -> DiagnosticBuilder<'tcx> {
  40     struct_span_err!(tcx.sess, tcx.span, E0080, "{}", msg)
  41 }
  42
  43 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
  44 static_assert_size!(InterpErrorInfo<'_>, 8);
  45
  46 /// Packages the kind of error we got from the const code interpreter
  47 /// up with a Rust-level backtrace of where the error occurred.
  48 /// These should always be constructed by calling `.into()` on
  49 /// a `InterpError`. In `rustc_mir::interpret`, we have `throw_err_*`
  50 /// macros for this.
  51 #[derive(Debug)]
  52 pub struct InterpErrorInfo<'tcx>(Box<InterpErrorInfoInner<'tcx>>);
  53
  54 #[derive(Debug)]
  55 struct InterpErrorInfoInner<'tcx> {
  56     kind: InterpError<'tcx>,
  57     backtrace: Option<Box<Backtrace>>,
  58 }
  59
  60 impl fmt::Display for InterpErrorInfo<'_> {
  61     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  62         write!(f, "{}", self.0.kind)
  63     }
  64 }
  65
  66 impl InterpErrorInfo<'tcx> {
  67     pub fn print_backtrace(&self) {
  68         if let Some(backtrace) = self.0.backtrace.as_ref() {
  69             print_backtrace(backtrace);
  70         }
  71     }
  72
  73     pub fn into_kind(self) -> InterpError<'tcx> {
  74         let InterpErrorInfo(box InterpErrorInfoInner { kind, .. }) = self;
  75         kind
  76     }
  77
  78     #[inline]
  79     pub fn kind(&self) -> &InterpError<'tcx> {
  80         &self.0.kind
  81     }
  82 }
  83
  84 fn print_backtrace(backtrace: &Backtrace) {
  85     eprintln!("\n\nAn error occurred in miri:\n{}", backtrace);
  86 }
  87
  88 impl From<ErrorHandled> for InterpErrorInfo<'_> {
  89     fn from(err: ErrorHandled) -> Self {
  90         match err {
  91             ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted => {
  92                 err_inval!(ReferencedConstant)
  93             }
  94             ErrorHandled::TooGeneric => err_inval!(TooGeneric),
  95         }
  96         .into()
  97     }
  98 }
  99
 100 impl From<ErrorReported> for InterpErrorInfo<'_> {
 101     fn from(err: ErrorReported) -> Self {
 102         InterpError::InvalidProgram(InvalidProgramInfo::AlreadyReported(err)).into()
 103     }
 104 }
 105
 106 impl<'tcx> From<InterpError<'tcx>> for InterpErrorInfo<'tcx> {
 107     fn from(kind: InterpError<'tcx>) -> Self {
 108         let capture_backtrace = tls::with_opt(|tcx| {
 109             if let Some(tcx) = tcx {
 110                 *Lock::borrow(&tcx.sess.ctfe_backtrace)
 111             } else {
 112                 CtfeBacktrace::Disabled
 113             }
 114         });
 115
 116         let backtrace = match capture_backtrace {
 117             CtfeBacktrace::Disabled => None,
 118             CtfeBacktrace::Capture => Some(Box::new(Backtrace::force_capture())),
 119             CtfeBacktrace::Immediate => {
 120                 // Print it now.
 121                 let backtrace = Backtrace::force_capture();
 122                 print_backtrace(&backtrace);
 123                 None
 124             }
 125         };
 126
 127         InterpErrorInfo(Box::new(InterpErrorInfoInner { kind, backtrace }))
 128     }
 129 }
 130
 131 /// Error information for when the program we executed turned out not to actually be a valid
 132 /// program. This cannot happen in stand-alone Miri, but it can happen during CTFE/ConstProp
 133 /// where we work on generic code or execution does not have all information available.
 134 pub enum InvalidProgramInfo<'tcx> {
 135     /// Resolution can fail if we are in a too generic context.
 136     TooGeneric,
 137     /// Cannot compute this constant because it depends on another one
 138     /// which already produced an error.
 139     ReferencedConstant,
 140     /// Abort in case errors are already reported.
 141     AlreadyReported(ErrorReported),
 142     /// An error occurred during layout computation.
 143     Layout(layout::LayoutError<'tcx>),
 144     /// An invalid transmute happened.
 145     TransmuteSizeDiff(Ty<'tcx>, Ty<'tcx>),
 146     /// SizeOf of unsized type was requested.
 147     SizeOfUnsizedType(Ty<'tcx>),
 148 }
 149
 150 impl fmt::Display for InvalidProgramInfo<'_> {
 151     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 152         use InvalidProgramInfo::*;
 153         match self {
 154             TooGeneric => write!(f, "encountered overly generic constant"),
 155             ReferencedConstant => write!(f, "referenced constant has errors"),
 156             AlreadyReported(ErrorReported) => {
 157                 write!(f, "encountered constants with type errors, stopping evaluation")
 158             }
 159             Layout(ref err) => write!(f, "{}", err),
 160             TransmuteSizeDiff(from_ty, to_ty) => write!(
 161                 f,
 162                 "transmuting `{}` to `{}` is not possible, because these types do not have the same size",
 163                 from_ty, to_ty
 164             ),
 165             SizeOfUnsizedType(ty) => write!(f, "size_of called on unsized type `{}`", ty),
 166         }
 167     }
 168 }
 169
 170 /// Details of why a pointer had to be in-bounds.
 171 #[derive(Debug, Copy, Clone, TyEncodable, TyDecodable, HashStable)]
 172 pub enum CheckInAllocMsg {
 173     /// We are access memory.
 174     MemoryAccessTest,
 175     /// We are doing pointer arithmetic.
 176     PointerArithmeticTest,
 177     /// None of the above -- generic/unspecific inbounds test.
 178     InboundsTest,
 179 }
 180
 181 impl fmt::Display for CheckInAllocMsg {
 182     /// When this is printed as an error the context looks like this
 183     /// "{msg}pointer must be in-bounds at offset..."
 184     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 185         write!(
 186             f,
 187             "{}",
 188             match *self {
 189                 CheckInAllocMsg::MemoryAccessTest => "memory access failed: ",
 190                 CheckInAllocMsg::PointerArithmeticTest => "pointer arithmetic failed: ",
 191                 CheckInAllocMsg::InboundsTest => "",
 192             }
 193         )
 194     }
 195 }
 196
 197 /// Details of an access to uninitialized bytes where it is not allowed.
 198 #[derive(Debug)]
 199 pub struct UninitBytesAccess {
 200     /// Location of the original memory access.
 201     pub access_offset: Size,
 202     /// Size of the original memory access.
 203     pub access_size: Size,
 204     /// Location of the first uninitialized byte that was accessed.
 205     pub uninit_offset: Size,
 206     /// Number of consecutive uninitialized bytes that were accessed.
 207     pub uninit_size: Size,
 208 }
 209
 210 /// Error information for when the program caused Undefined Behavior.
 211 pub enum UndefinedBehaviorInfo<'tcx> {
 212     /// Free-form case. Only for errors that are never caught!
 213     Ub(String),
 214     /// Unreachable code was executed.
 215     Unreachable,
 216     /// A slice/array index projection went out-of-bounds.
 217     BoundsCheckFailed {
 218         len: u64,
 219         index: u64,
 220     },
 221     /// Something was divided by 0 (x / 0).
 222     DivisionByZero,
 223     /// Something was "remainded" by 0 (x % 0).
 224     RemainderByZero,
 225     /// Overflowing inbounds pointer arithmetic.
 226     PointerArithOverflow,
 227     /// Invalid metadata in a wide pointer (using `str` to avoid allocations).
 228     InvalidMeta(&'static str),
 229     /// Invalid drop function in vtable.
 230     InvalidDropFn(FnSig<'tcx>),
 231     /// Reading a C string that does not end within its allocation.
 232     UnterminatedCString(Pointer),
 233     /// Dereferencing a dangling pointer after it got freed.
 234     PointerUseAfterFree(AllocId),
 235     /// Used a pointer outside the bounds it is valid for.
 236     PointerOutOfBounds {
 237         ptr: Pointer,
 238         msg: CheckInAllocMsg,
 239         allocation_size: Size,
 240     },
 241     /// Using an integer as a pointer in the wrong way.
 242     DanglingIntPointer(u64, CheckInAllocMsg),
 243     /// Used a pointer with bad alignment.
 244     AlignmentCheckFailed {
 245         required: Align,
 246         has: Align,
 247     },
 248     /// Writing to read-only memory.
 249     WriteToReadOnly(AllocId),
 250     // Trying to access the data behind a function pointer.
 251     DerefFunctionPointer(AllocId),
 252     /// The value validity check found a problem.
 253     /// Should only be thrown by `validity.rs` and always point out which part of the value
 254     /// is the problem.
 255     ValidationFailure(String),
 256     /// Using a non-boolean `u8` as bool.
 257     InvalidBool(u8),
 258     /// Using a non-character `u32` as character.
 259     InvalidChar(u32),
 260     /// The tag of an enum does not encode an actual discriminant.
 261     InvalidTag(Scalar),
 262     /// Using a pointer-not-to-a-function as function pointer.
 263     InvalidFunctionPointer(Pointer),
 264     /// Using a string that is not valid UTF-8,
 265     InvalidStr(std::str::Utf8Error),
 266     /// Using uninitialized data where it is not allowed.
 267     InvalidUninitBytes(Option<(AllocId, UninitBytesAccess)>),
 268     /// Working with a local that is not currently live.
 269     DeadLocal,
 270     /// Data size is not equal to target size.
 271     ScalarSizeMismatch {
 272         target_size: u64,
 273         data_size: u64,
 274     },
 275 }
 276
 277 impl fmt::Display for UndefinedBehaviorInfo<'_> {
 278     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 279         use UndefinedBehaviorInfo::*;
 280         match self {
 281             Ub(msg) => write!(f, "{}", msg),
 282             Unreachable => write!(f, "entering unreachable code"),
 283             BoundsCheckFailed { ref len, ref index } => {
 284                 write!(f, "indexing out of bounds: the len is {} but the index is {}", len, index)
 285             }
 286             DivisionByZero => write!(f, "dividing by zero"),
 287             RemainderByZero => write!(f, "calculating the remainder with a divisor of zero"),
 288             PointerArithOverflow => write!(f, "overflowing in-bounds pointer arithmetic"),
 289             InvalidMeta(msg) => write!(f, "invalid metadata in wide pointer: {}", msg),
 290             InvalidDropFn(sig) => write!(
 291                 f,
 292                 "invalid drop function signature: got {}, expected exactly one argument which must be a pointer type",
 293                 sig
 294             ),
 295             UnterminatedCString(p) => write!(
 296                 f,
 297                 "reading a null-terminated string starting at {} with no null found before end of allocation",
 298                 p,
 299             ),
 300             PointerUseAfterFree(a) => {
 301                 write!(f, "pointer to {} was dereferenced after this allocation got freed", a)
 302             }
 303             PointerOutOfBounds { ptr, msg, allocation_size } => write!(
 304                 f,
 305                 "{}pointer must be in-bounds at offset {}, \
 306                            but is outside bounds of {} which has size {}",
 307                 msg,
 308                 ptr.offset.bytes(),
 309                 ptr.alloc_id,
 310                 allocation_size.bytes()
 311             ),
 312             DanglingIntPointer(0, CheckInAllocMsg::InboundsTest) => {
 313                 write!(f, "null pointer is not a valid pointer for this operation")
 314             }
 315             DanglingIntPointer(i, msg) => {
 316                 write!(f, "{}0x{:x} is not a valid pointer", msg, i)
 317             }
 318             AlignmentCheckFailed { required, has } => write!(
 319                 f,
 320                 "accessing memory with alignment {}, but alignment {} is required",
 321                 has.bytes(),
 322                 required.bytes()
 323             ),
 324             WriteToReadOnly(a) => write!(f, "writing to {} which is read-only", a),
 325             DerefFunctionPointer(a) => write!(f, "accessing {} which contains a function", a),
 326             ValidationFailure(ref err) => write!(f, "type validation failed: {}", err),
 327             InvalidBool(b) => {
 328                 write!(f, "interpreting an invalid 8-bit value as a bool: 0x{:02x}", b)
 329             }
 330             InvalidChar(c) => {
 331                 write!(f, "interpreting an invalid 32-bit value as a char: 0x{:08x}", c)
 332             }
 333             InvalidTag(val) => write!(f, "enum value has invalid tag: {}", val),
 334             InvalidFunctionPointer(p) => {
 335                 write!(f, "using {} as function pointer but it does not point to a function", p)
 336             }
 337             InvalidStr(err) => write!(f, "this string is not valid UTF-8: {}", err),
 338             InvalidUninitBytes(Some((alloc, access))) => write!(
 339                 f,
 340                 "reading {} byte{} of memory starting at {}, \
 341                  but {} byte{} {} uninitialized starting at {}, \
 342                  and this operation requires initialized memory",
 343                 access.access_size.bytes(),
 344                 pluralize!(access.access_size.bytes()),
 345                 Pointer::new(*alloc, access.access_offset),
 346                 access.uninit_size.bytes(),
 347                 pluralize!(access.uninit_size.bytes()),
 348                 if access.uninit_size.bytes() != 1 { "are" } else { "is" },
 349                 Pointer::new(*alloc, access.uninit_offset),
 350             ),
 351             InvalidUninitBytes(None) => write!(
 352                 f,
 353                 "using uninitialized data, but this operation requires initialized memory"
 354             ),
 355             DeadLocal => write!(f, "accessing a dead local variable"),
 356             ScalarSizeMismatch { target_size, data_size } => write!(
 357                 f,
 358                 "scalar size mismatch: expected {} bytes but got {} bytes instead",
 359                 target_size, data_size
 360             ),
 361         }
 362     }
 363 }
 364
 365 /// Error information for when the program did something that might (or might not) be correct
 366 /// to do according to the Rust spec, but due to limitations in the interpreter, the
 367 /// operation could not be carried out. These limitations can differ between CTFE and the
 368 /// Miri engine, e.g., CTFE does not support dereferencing pointers at integral addresses.
 369 pub enum UnsupportedOpInfo {
 370     /// Free-form case. Only for errors that are never caught!
 371     Unsupported(String),
 372     /// Could not find MIR for a function.
 373     NoMirFor(DefId),
 374     /// Encountered a pointer where we needed raw bytes.
 375     ReadPointerAsBytes,
 376     //
 377     // The variants below are only reachable from CTFE/const prop, miri will never emit them.
 378     //
 379     /// Encountered raw bytes where we needed a pointer.
 380     ReadBytesAsPointer,
 381     /// Accessing thread local statics
 382     ThreadLocalStatic(DefId),
 383     /// Accessing an unsupported extern static.
 384     ReadExternStatic(DefId),
 385 }
 386
 387 impl fmt::Display for UnsupportedOpInfo {
 388     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 389         use UnsupportedOpInfo::*;
 390         match self {
 391             Unsupported(ref msg) => write!(f, "{}", msg),
 392             ReadExternStatic(did) => write!(f, "cannot read from extern static ({:?})", did),
 393             NoMirFor(did) => write!(f, "no MIR body is available for {:?}", did),
 394             ReadPointerAsBytes => write!(f, "unable to turn pointer into raw bytes",),
 395             ReadBytesAsPointer => write!(f, "unable to turn bytes into a pointer"),
 396             ThreadLocalStatic(did) => write!(f, "cannot access thread local static ({:?})", did),
 397         }
 398     }
 399 }
 400
 401 /// Error information for when the program exhausted the resources granted to it
 402 /// by the interpreter.
 403 pub enum ResourceExhaustionInfo {
 404     /// The stack grew too big.
 405     StackFrameLimitReached,
 406     /// The program ran for too long.
 407     ///
 408     /// The exact limit is set by the `const_eval_limit` attribute.
 409     StepLimitReached,
 410 }
 411
 412 impl fmt::Display for ResourceExhaustionInfo {
 413     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 414         use ResourceExhaustionInfo::*;
 415         match self {
 416             StackFrameLimitReached => {
 417                 write!(f, "reached the configured maximum number of stack frames")
 418             }
 419             StepLimitReached => {
 420                 write!(f, "exceeded interpreter step limit (see `#[const_eval_limit]`)")
 421             }
 422         }
 423     }
 424 }
 425
 426 /// A trait to work around not having trait object upcasting.
 427 pub trait AsAny: Any {
 428     fn as_any(&self) -> &dyn Any;
 429 }
 430 impl<T: Any> AsAny for T {
 431     #[inline(always)]
 432     fn as_any(&self) -> &dyn Any {
 433         self
 434     }
 435 }
 436
 437 /// A trait for machine-specific errors (or other "machine stop" conditions).
 438 pub trait MachineStopType: AsAny + fmt::Display + Send {
 439     /// If `true`, emit a hard error instead of going through the `CONST_ERR` lint
 440     fn is_hard_err(&self) -> bool {
 441         false
 442     }
 443 }
 444
 445 impl dyn MachineStopType {
 446     #[inline(always)]
 447     pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
 448         self.as_any().downcast_ref()
 449     }
 450 }
 451
 452 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 453 static_assert_size!(InterpError<'_>, 64);
 454
 455 pub enum InterpError<'tcx> {
 456     /// The program caused undefined behavior.
 457     UndefinedBehavior(UndefinedBehaviorInfo<'tcx>),
 458     /// The program did something the interpreter does not support (some of these *might* be UB
 459     /// but the interpreter is not sure).
 460     Unsupported(UnsupportedOpInfo),
 461     /// The program was invalid (ill-typed, bad MIR, not sufficiently monomorphized, ...).
 462     InvalidProgram(InvalidProgramInfo<'tcx>),
 463     /// The program exhausted the interpreter's resources (stack/heap too big,
 464     /// execution takes too long, ...).
 465     ResourceExhaustion(ResourceExhaustionInfo),
 466     /// Stop execution for a machine-controlled reason. This is never raised by
 467     /// the core engine itself.
 468     MachineStop(Box<dyn MachineStopType>),
 469 }
 470
 471 pub type InterpResult<'tcx, T = ()> = Result<T, InterpErrorInfo<'tcx>>;
 472
 473 impl fmt::Display for InterpError<'_> {
 474     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 475         use InterpError::*;
 476         match *self {
 477             Unsupported(ref msg) => write!(f, "{}", msg),
 478             InvalidProgram(ref msg) => write!(f, "{}", msg),
 479             UndefinedBehavior(ref msg) => write!(f, "{}", msg),
 480             ResourceExhaustion(ref msg) => write!(f, "{}", msg),
 481             MachineStop(ref msg) => write!(f, "{}", msg),
 482         }
 483     }
 484 }
 485
 486 // Forward `Debug` to `Display`, so it does not look awful.
 487 impl fmt::Debug for InterpError<'_> {
 488     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 489         fmt::Display::fmt(self, f)
 490     }
 491 }
 492
 493 impl InterpError<'_> {
 494     /// Some errors to string formatting even if the error is never printed.
 495     /// To avoid performance issues, there are places where we want to be sure to never raise these formatting errors,
 496     /// so this method lets us detect them and `bug!` on unexpected errors.
 497     pub fn formatted_string(&self) -> bool {
 498         match self {
 499             InterpError::Unsupported(UnsupportedOpInfo::Unsupported(_))
 500             | InterpError::UndefinedBehavior(UndefinedBehaviorInfo::ValidationFailure(_))
 501             | InterpError::UndefinedBehavior(UndefinedBehaviorInfo::Ub(_)) => true,
 502             _ => false,
 503         }
 504     }
 505
 506     /// Should this error be reported as a hard error, preventing compilation, or a soft error,
 507     /// causing a deny-by-default lint?
 508     pub fn is_hard_err(&self) -> bool {
 509         use InterpError::*;
 510         match *self {
 511             MachineStop(ref err) => err.is_hard_err(),
 512             _ => false,
 513         }
 514     }
 515 }