Enum rustc_mir::interpret::UndefinedBehaviorInfo

pub enum UndefinedBehaviorInfo<'tcx> {
    Ub(String),
    Unreachable,
    BoundsCheckFailed {
        len: u64,
        index: u64,
    },
    DivisionByZero,
    RemainderByZero,
    PointerArithOverflow,
    InvalidMeta(&'static str),
    InvalidVtableDropFn(FnSig<'tcx>),
    InvalidVtableSize,
    InvalidVtableAlignment(String),
    UnterminatedCString(Pointer<AllocId>),
    PointerUseAfterFree(AllocId),
    PointerOutOfBounds {
        alloc_id: AllocId,
        alloc_size: Size,
        ptr_offset: i64,
        ptr_size: Size,
        msg: CheckInAllocMsg,
    },
    DanglingIntPointer(u64, CheckInAllocMsg),
    AlignmentCheckFailed {
        required: Align,
        has: Align,
    },
    WriteToReadOnly(AllocId),
    DerefFunctionPointer(AllocId),
    ValidationFailure {
        path: Option<String>,
        msg: String,
    },
    InvalidBool(u8),
    InvalidChar(u32),
    InvalidTag(Scalar<AllocId>),
    InvalidFunctionPointer(Pointer<AllocId>),
    InvalidStr(Utf8Error),
    InvalidUninitBytes(Option<(AllocId, UninitBytesAccess)>),
    DeadLocal,
    ScalarSizeMismatch {
        target_size: u64,
        data_size: u64,
    },
}

Error information for when the program caused Undefined Behavior.

Variants

Ub(String)

Free-form case. Only for errors that are never caught!

Unreachable

Unreachable code was executed.

BoundsCheckFailed

A slice/array index projection went out-of-bounds.

Fields of BoundsCheckFailed

len: u64index: u64

DivisionByZero

Something was divided by 0 (x / 0).

RemainderByZero

Something was “remainded” by 0 (x % 0).

PointerArithOverflow

Overflowing inbounds pointer arithmetic.

InvalidMeta(&'static str)

Invalid metadata in a wide pointer (using str to avoid allocations).

InvalidVtableDropFn(FnSig<'tcx>)

Invalid drop function in vtable.

InvalidVtableSize

Invalid size in a vtable: too large.

InvalidVtableAlignment(String)

Invalid alignment in a vtable: too large, or not a power of 2.

UnterminatedCString(Pointer<AllocId>)

Reading a C string that does not end within its allocation.

PointerUseAfterFree(AllocId)

Dereferencing a dangling pointer after it got freed.

PointerOutOfBounds

Used a pointer outside the bounds it is valid for. (If ptr_size > 0, determines the size of the memory range that was expected to be in-bounds.)

Fields of PointerOutOfBounds

alloc_id: AllocIdalloc_size: Sizeptr_offset: i64ptr_size: Sizemsg: CheckInAllocMsg

DanglingIntPointer(u64, CheckInAllocMsg)

Using an integer as a pointer in the wrong way.

AlignmentCheckFailed

Used a pointer with bad alignment.

Fields of AlignmentCheckFailed

required: Alignhas: Align

WriteToReadOnly(AllocId)

Writing to read-only memory.

DerefFunctionPointer(AllocId)

ValidationFailure

The value validity check found a problem. Should only be thrown by validity.rs and always point out which part of the value is the problem.

Fields of ValidationFailure

path: Option<String>

The “path” to the value in question, e.g. .0[5].field for a struct field in the 6th element of an array that is the first element of a tuple.

msg: String

InvalidBool(u8)

Using a non-boolean u8 as bool.

InvalidChar(u32)

Using a non-character u32 as character.

InvalidTag(Scalar<AllocId>)

The tag of an enum does not encode an actual discriminant.

InvalidFunctionPointer(Pointer<AllocId>)

Using a pointer-not-to-a-function as function pointer.

InvalidStr(Utf8Error)

Using a string that is not valid UTF-8,

InvalidUninitBytes(Option<(AllocId, UninitBytesAccess)>)

Using uninitialized data where it is not allowed.

DeadLocal

Working with a local that is not currently live.

ScalarSizeMismatch

Data size is not equal to target size.

Fields of ScalarSizeMismatch

target_size: u64data_size: u64

Layout

Note: Most layout information is completely unstable and may be different between compiler versions and platforms. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes