Enum miri::interpret::UndefinedBehaviorInfo

pub enum UndefinedBehaviorInfo<'tcx> {
    Ub(String),
    Custom(CustomSubdiagnostic<'tcx>),
    ValidationError(ValidationErrorInfo<'tcx>),
    Unreachable,
    BoundsCheckFailed {
        len: u64,
        index: u64,
    },
    DivisionByZero,
    RemainderByZero,
    DivisionOverflow,
    RemainderOverflow,
    PointerArithOverflow,
    InvalidMeta(InvalidMetaKind),
    UnterminatedCString(Pointer<AllocId>),
    PointerUseAfterFree(AllocId, CheckInAllocMsg),
    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),
    DerefVTablePointer(AllocId),
    InvalidBool(u8),
    InvalidChar(u32),
    InvalidTag(Scalar<AllocId>),
    InvalidFunctionPointer(Pointer<AllocId>),
    InvalidVTablePointer(Pointer<AllocId>),
    InvalidStr(Utf8Error),
    InvalidUninitBytes(Option<(AllocId, BadBytesAccess)>),
    DeadLocal,
    ScalarSizeMismatch(ScalarSizeMismatch),
    UninhabitedEnumVariantWritten(VariantIdx),
    UninhabitedEnumVariantRead(VariantIdx),
    AbiMismatchArgument {
        caller_ty: Ty<'tcx>,
        callee_ty: Ty<'tcx>,
    },
    AbiMismatchReturn {
        caller_ty: Ty<'tcx>,
        callee_ty: Ty<'tcx>,
    },
}

Error information for when the program caused Undefined Behavior.

Variants

Ub(String)

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

Custom(CustomSubdiagnostic<'tcx>)

A custom (free-form) fluent-translated error, created by err_ub_custom!.

ValidationError(ValidationErrorInfo<'tcx>)

Validation error.

Unreachable

Unreachable code was executed.

BoundsCheckFailed

Fields

len: u64

index: u64

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

DivisionByZero

Something was divided by 0 (x / 0).

RemainderByZero

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

DivisionOverflow

Signed division overflowed (INT_MIN / -1).

RemainderOverflow

Signed remainder overflowed (INT_MIN % -1).

PointerArithOverflow

Overflowing inbounds pointer arithmetic.

InvalidMeta(InvalidMetaKind)

Invalid metadata in a wide pointer

UnterminatedCString(Pointer<AllocId>)

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

PointerUseAfterFree(AllocId, CheckInAllocMsg)

Using a pointer after it got freed.

PointerOutOfBounds

Fields

alloc_id: AllocId

alloc_size: Size

ptr_offset: i64

ptr_size: Size

msg: CheckInAllocMsg

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.)

DanglingIntPointer(u64, CheckInAllocMsg)

Using an integer as a pointer in the wrong way.

AlignmentCheckFailed

Fields

required: Align

has: Align

Used a pointer with bad alignment.

WriteToReadOnly(AllocId)

Writing to read-only memory.

DerefFunctionPointer(AllocId)

Trying to access the data behind a function pointer.

DerefVTablePointer(AllocId)

Trying to access the data behind a vtable pointer.

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.

InvalidVTablePointer(Pointer<AllocId>)

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

InvalidStr(Utf8Error)

Using a string that is not valid UTF-8,

InvalidUninitBytes(Option<(AllocId, BadBytesAccess)>)

Using uninitialized data where it is not allowed.

DeadLocal

Working with a local that is not currently live.

ScalarSizeMismatch(ScalarSizeMismatch)

Data size is not equal to target size.

UninhabitedEnumVariantWritten(VariantIdx)

A discriminant of an uninhabited enum variant is written.

UninhabitedEnumVariantRead(VariantIdx)

An uninhabited enum variant is projected.

AbiMismatchArgument

Fields

caller_ty: Ty<'tcx>

callee_ty: Ty<'tcx>

ABI-incompatible argument types.

AbiMismatchReturn

Fields

caller_ty: Ty<'tcx>

callee_ty: Ty<'tcx>

ABI-incompatible return types.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. 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: 112 bytes

Size for each variant:

• Ub: 32 bytes
• Custom: 32 bytes
• ValidationError: 112 bytes
• Unreachable: 0 bytes
• BoundsCheckFailed: 24 bytes
• DivisionByZero: 0 bytes
• RemainderByZero: 0 bytes
• DivisionOverflow: 0 bytes
• RemainderOverflow: 0 bytes
• PointerArithOverflow: 0 bytes
• InvalidMeta: 2 bytes
• UnterminatedCString: 24 bytes
• PointerUseAfterFree: 24 bytes
• PointerOutOfBounds: 48 bytes
• DanglingIntPointer: 24 bytes
• AlignmentCheckFailed: 3 bytes
• WriteToReadOnly: 16 bytes
• DerefFunctionPointer: 16 bytes
• DerefVTablePointer: 16 bytes
• InvalidBool: 2 bytes
• InvalidChar: 8 bytes
• InvalidTag: 32 bytes
• InvalidFunctionPointer: 24 bytes
• InvalidVTablePointer: 24 bytes
• InvalidStr: 24 bytes
• InvalidUninitBytes: 48 bytes
• DeadLocal: 0 bytes
• ScalarSizeMismatch: 24 bytes
• UninhabitedEnumVariantWritten: 8 bytes
• UninhabitedEnumVariantRead: 8 bytes
• AbiMismatchArgument: 24 bytes
• AbiMismatchReturn: 24 bytes