Trait miri::helpers::EvalContextExt

source ·
pub trait EvalContextExt<'tcx>: MiriInterpCxExt<'tcx> {
Show 58 methods // Provided methods fn have_module(&self, path: &[&str]) -> bool { ... } fn try_resolve_path( &self, path: &[&str], namespace: Namespace ) -> Option<Instance<'tcx>> { ... } fn resolve_path( &self, path: &[&str], namespace: Namespace ) -> Instance<'tcx> { ... } fn eval_path(&self, path: &[&str]) -> OpTy<'tcx, Provenance> { ... } fn eval_path_scalar(&self, path: &[&str]) -> Scalar<Provenance> { ... } fn eval_libc(&self, name: &str) -> Scalar<Provenance> { ... } fn eval_libc_i32(&self, name: &str) -> i32 { ... } fn eval_libc_u32(&self, name: &str) -> u32 { ... } fn eval_windows(&self, module: &str, name: &str) -> Scalar<Provenance> { ... } fn eval_windows_u32(&self, module: &str, name: &str) -> u32 { ... } fn eval_windows_u64(&self, module: &str, name: &str) -> u64 { ... } fn libc_ty_layout(&self, name: &str) -> TyAndLayout<'tcx> { ... } fn windows_ty_layout(&self, name: &str) -> TyAndLayout<'tcx> { ... } fn project_field_named<P: Projectable<'tcx, Provenance>>( &self, base: &P, name: &str ) -> InterpResult<'tcx, P> { ... } fn projectable_has_field<P: Projectable<'tcx, Provenance>>( &self, base: &P, name: &str ) -> bool { ... } fn write_int( &mut self, i: impl Into<i128>, dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx> { ... } fn write_int_fields( &mut self, values: &[i128], dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx> { ... } fn write_int_fields_named( &mut self, values: &[(&str, i128)], dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx> { ... } fn write_null( &mut self, dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx> { ... } fn ptr_is_null( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, bool> { ... } fn gen_random( &mut self, ptr: Pointer<Option<Provenance>>, len: u64 ) -> InterpResult<'tcx> { ... } fn call_function( &mut self, f: Instance<'tcx>, caller_abi: Abi, args: &[Immediate<Provenance>], dest: Option<&MPlaceTy<'tcx, Provenance>>, stack_pop: StackPopCleanup ) -> InterpResult<'tcx> { ... } fn visit_freeze_sensitive( &self, place: &MPlaceTy<'tcx, Provenance>, size: Size, action: impl FnMut(AllocRange, bool) -> InterpResult<'tcx> ) -> InterpResult<'tcx> { ... } fn check_no_isolation(&self, name: &str) -> InterpResult<'tcx> { ... } fn reject_in_isolation( &self, op_name: &str, reject_with: RejectOpWith ) -> InterpResult<'tcx> { ... } fn assert_target_os(&self, target_os: &str, name: &str) { ... } fn assert_target_os_is_unix(&self, name: &str) { ... } fn target_os_is_unix(&self) -> bool { ... } fn last_error_place( &mut self ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> { ... } fn set_last_error( &mut self, scalar: Scalar<Provenance> ) -> InterpResult<'tcx> { ... } fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Provenance>> { ... } fn io_error_to_errnum( &self, err: Error ) -> InterpResult<'tcx, Scalar<Provenance>> { ... } fn try_errnum_to_io_error( &self, errnum: Scalar<Provenance> ) -> InterpResult<'tcx, Option<ErrorKind>> { ... } fn set_last_error_from_io_error(&mut self, err: Error) -> InterpResult<'tcx> { ... } fn try_unwrap_io_result<T: From<i32>>( &mut self, result: Result<T> ) -> InterpResult<'tcx, T> { ... } fn deref_pointer_as( &self, op: &impl Readable<'tcx, Provenance>, layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> { ... } fn deref_pointer_and_offset( &self, op: &impl Readable<'tcx, Provenance>, offset: u64, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>> { ... } fn deref_pointer_and_read( &self, op: &impl Readable<'tcx, Provenance>, offset: u64, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, Scalar<Provenance>> { ... } fn deref_pointer_and_write( &mut self, op: &impl Readable<'tcx, Provenance>, offset: u64, value: impl Into<Scalar<Provenance>>, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, ()> { ... } fn read_timespec( &mut self, tp: &MPlaceTy<'tcx, Provenance> ) -> InterpResult<'tcx, Option<Duration>> { ... } fn read_byte_slice<'a>( &'a self, slice: &ImmTy<'tcx, Provenance> ) -> InterpResult<'tcx, &'a [u8]> where 'tcx: 'a { ... } fn read_c_str<'a>( &'a self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, &'a [u8]> where 'tcx: 'a { ... } fn write_c_str( &mut self, c_str: &[u8], ptr: Pointer<Option<Provenance>>, size: u64 ) -> InterpResult<'tcx, (bool, u64)> { ... } fn read_c_str_with_char_size<T>( &self, ptr: Pointer<Option<Provenance>>, size: Size, align: Align ) -> InterpResult<'tcx, Vec<T>> where T: TryFrom<u128>, <T as TryFrom<u128>>::Error: Debug { ... } fn read_wide_str( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, Vec<u16>> { ... } fn write_wide_str( &mut self, wide_str: &[u16], ptr: Pointer<Option<Provenance>>, size: u64 ) -> InterpResult<'tcx, (bool, u64)> { ... } fn read_wchar_t_str( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, Vec<u32>> { ... } fn check_abi<'a>(&self, abi: Abi, exp_abi: Abi) -> InterpResult<'a, ()> { ... } fn frame_in_std(&self) -> bool { ... } fn handle_unsupported_foreign_item( &mut self, error_msg: String ) -> InterpResult<'tcx, ()> { ... } fn check_abi_and_shim_symbol_clash( &mut self, abi: Abi, exp_abi: Abi, link_name: Symbol ) -> InterpResult<'tcx, ()> { ... } fn check_shim<'a, const N: usize>( &mut self, abi: Abi, exp_abi: Abi, link_name: Symbol, args: &'a [OpTy<'tcx, Provenance>] ) -> InterpResult<'tcx, &'a [OpTy<'tcx, Provenance>; N]> where &'a [OpTy<'tcx, Provenance>; N]: TryFrom<&'a [OpTy<'tcx, Provenance>]> { ... } fn mark_immutable(&mut self, mplace: &MPlaceTy<'tcx, Provenance>) { ... } fn item_link_name(&self, def_id: DefId) -> Symbol { ... } fn float_to_int_checked( &self, src: &ImmTy<'tcx, Provenance>, cast_to: TyAndLayout<'tcx>, round: Round ) -> InterpResult<'tcx, Option<ImmTy<'tcx, Provenance>>> { ... } fn get_twice_wide_int_ty(&self, ty: Ty<'tcx>) -> Ty<'tcx> { ... } fn expect_target_feature_for_intrinsic( &self, intrinsic: Symbol, target_feature: &str ) -> InterpResult<'tcx, ()> { ... } fn lookup_link_section( &mut self, name: &str ) -> InterpResult<'tcx, Vec<ImmTy<'tcx, Provenance>>> { ... }
}

Provided Methods§

source

fn have_module(&self, path: &[&str]) -> bool

Checks if the given crate/module exists.

source

fn try_resolve_path( &self, path: &[&str], namespace: Namespace ) -> Option<Instance<'tcx>>

Gets an instance for a path; fails gracefully if the path does not exist.

source

fn resolve_path(&self, path: &[&str], namespace: Namespace) -> Instance<'tcx>

Gets an instance for a path.

source

fn eval_path(&self, path: &[&str]) -> OpTy<'tcx, Provenance>

Evaluates the scalar at the specified path.

source

fn eval_path_scalar(&self, path: &[&str]) -> Scalar<Provenance>

source

fn eval_libc(&self, name: &str) -> Scalar<Provenance>

Helper function to get a libc constant as a Scalar.

source

fn eval_libc_i32(&self, name: &str) -> i32

Helper function to get a libc constant as an i32.

source

fn eval_libc_u32(&self, name: &str) -> u32

Helper function to get a libc constant as an u32.

source

fn eval_windows(&self, module: &str, name: &str) -> Scalar<Provenance>

Helper function to get a windows constant as a Scalar.

source

fn eval_windows_u32(&self, module: &str, name: &str) -> u32

Helper function to get a windows constant as a u32.

source

fn eval_windows_u64(&self, module: &str, name: &str) -> u64

Helper function to get a windows constant as a u64.

source

fn libc_ty_layout(&self, name: &str) -> TyAndLayout<'tcx>

Helper function to get the TyAndLayout of a libc type

source

fn windows_ty_layout(&self, name: &str) -> TyAndLayout<'tcx>

Helper function to get the TyAndLayout of a windows type

source

fn project_field_named<P: Projectable<'tcx, Provenance>>( &self, base: &P, name: &str ) -> InterpResult<'tcx, P>

Project to the given named field (which must be a struct or union type).

source

fn projectable_has_field<P: Projectable<'tcx, Provenance>>( &self, base: &P, name: &str ) -> bool

Search if base (which must be a struct or union type) contains the name field.

source

fn write_int( &mut self, i: impl Into<i128>, dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx>

Write an int of the appropriate size to dest. The target type may be signed or unsigned, we try to do the right thing anyway. i128 can fit all integer types except for u128 so this method is fine for almost all integer types.

source

fn write_int_fields( &mut self, values: &[i128], dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx>

Write the first N fields of the given place.

source

fn write_int_fields_named( &mut self, values: &[(&str, i128)], dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx>

Write the given fields of the given place.

source

fn write_null( &mut self, dest: &impl Writeable<'tcx, Provenance> ) -> InterpResult<'tcx>

Write a 0 of the appropriate size to dest.

source

fn ptr_is_null( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, bool>

Test if this pointer equals 0.

source

fn gen_random( &mut self, ptr: Pointer<Option<Provenance>>, len: u64 ) -> InterpResult<'tcx>

Generate some random bytes, and write them to dest.

source

fn call_function( &mut self, f: Instance<'tcx>, caller_abi: Abi, args: &[Immediate<Provenance>], dest: Option<&MPlaceTy<'tcx, Provenance>>, stack_pop: StackPopCleanup ) -> InterpResult<'tcx>

Call a function: Push the stack frame and pass the arguments. For now, arguments must be scalars (so that the caller does not have to know the layout).

If you do not provide a return place, a dangling zero-sized place will be created for your convenience.

source

fn visit_freeze_sensitive( &self, place: &MPlaceTy<'tcx, Provenance>, size: Size, action: impl FnMut(AllocRange, bool) -> InterpResult<'tcx> ) -> InterpResult<'tcx>

Visits the memory covered by place, sensitive to freezing: the 2nd parameter of action will be true if this is frozen, false if this is in an UnsafeCell. The range is relative to place.

source

fn check_no_isolation(&self, name: &str) -> InterpResult<'tcx>

Helper function used inside the shims of foreign functions to check that isolation is disabled. It returns an error using the name of the foreign function if this is not the case.

source

fn reject_in_isolation( &self, op_name: &str, reject_with: RejectOpWith ) -> InterpResult<'tcx>

Helper function used inside the shims of foreign functions which reject the op when isolation is enabled. It is used to print a warning/backtrace about the rejection.

source

fn assert_target_os(&self, target_os: &str, name: &str)

Helper function used inside the shims of foreign functions to assert that the target OS is target_os. It panics showing a message with the name of the foreign function if this is not the case.

source

fn assert_target_os_is_unix(&self, name: &str)

Helper function used inside the shims of foreign functions to assert that the target OS is part of the UNIX family. It panics showing a message with the name of the foreign function if this is not the case.

source

fn target_os_is_unix(&self) -> bool

source

fn last_error_place(&mut self) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>>

Get last error variable as a place, lazily allocating thread-local storage for it if necessary.

source

fn set_last_error(&mut self, scalar: Scalar<Provenance>) -> InterpResult<'tcx>

Sets the last error variable.

source

fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Provenance>>

Gets the last error variable.

source

fn io_error_to_errnum( &self, err: Error ) -> InterpResult<'tcx, Scalar<Provenance>>

This function tries to produce the most similar OS error from the std::io::ErrorKind as a platform-specific errnum.

source

fn try_errnum_to_io_error( &self, errnum: Scalar<Provenance> ) -> InterpResult<'tcx, Option<ErrorKind>>

The inverse of io_error_to_errnum.

source

fn set_last_error_from_io_error(&mut self, err: Error) -> InterpResult<'tcx>

Sets the last OS error using a std::io::ErrorKind.

source

fn try_unwrap_io_result<T: From<i32>>( &mut self, result: Result<T> ) -> InterpResult<'tcx, T>

Helper function that consumes an std::io::Result<T> and returns an InterpResult<'tcx,T>::Ok instead. In case the result is an error, this function returns Ok(-1) and sets the last OS error accordingly.

This function uses T: From<i32> instead of i32 directly because some IO related functions return different integer types (like read, that returns an i64).

source

fn deref_pointer_as( &self, op: &impl Readable<'tcx, Provenance>, layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>>

Dereference a pointer operand to a place using layout instead of the pointer’s declared type

source

fn deref_pointer_and_offset( &self, op: &impl Readable<'tcx, Provenance>, offset: u64, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, MPlaceTy<'tcx, Provenance>>

Calculates the MPlaceTy given the offset and layout of an access on an operand

source

fn deref_pointer_and_read( &self, op: &impl Readable<'tcx, Provenance>, offset: u64, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, Scalar<Provenance>>

source

fn deref_pointer_and_write( &mut self, op: &impl Readable<'tcx, Provenance>, offset: u64, value: impl Into<Scalar<Provenance>>, base_layout: TyAndLayout<'tcx>, value_layout: TyAndLayout<'tcx> ) -> InterpResult<'tcx, ()>

source

fn read_timespec( &mut self, tp: &MPlaceTy<'tcx, Provenance> ) -> InterpResult<'tcx, Option<Duration>>

Parse a timespec struct and return it as a std::time::Duration. It returns None if the value in the timespec struct is invalid. Some libc functions will return EINVAL in this case.

source

fn read_byte_slice<'a>( &'a self, slice: &ImmTy<'tcx, Provenance> ) -> InterpResult<'tcx, &'a [u8]>
where 'tcx: 'a,

Read bytes from a byte slice.

source

fn read_c_str<'a>( &'a self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, &'a [u8]>
where 'tcx: 'a,

Read a sequence of bytes until the first null terminator.

source

fn write_c_str( &mut self, c_str: &[u8], ptr: Pointer<Option<Provenance>>, size: u64 ) -> InterpResult<'tcx, (bool, u64)>

Helper function to write a sequence of bytes with an added null-terminator, which is what the Unix APIs usually handle. This function returns Ok((false, length)) without trying to write if size is not large enough to fit the contents of c_str plus a null terminator. It returns Ok((true, length)) if the writing process was successful. The string length returned does include the null terminator.

source

fn read_c_str_with_char_size<T>( &self, ptr: Pointer<Option<Provenance>>, size: Size, align: Align ) -> InterpResult<'tcx, Vec<T>>
where T: TryFrom<u128>, <T as TryFrom<u128>>::Error: Debug,

Helper function to read a sequence of unsigned integers of the given size and alignment until the first null terminator.

source

fn read_wide_str( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, Vec<u16>>

Read a sequence of u16 until the first null terminator.

source

fn write_wide_str( &mut self, wide_str: &[u16], ptr: Pointer<Option<Provenance>>, size: u64 ) -> InterpResult<'tcx, (bool, u64)>

Helper function to write a sequence of u16 with an added 0x0000-terminator, which is what the Windows APIs usually handle. This function returns Ok((false, length)) without trying to write if size is not large enough to fit the contents of os_string plus a null terminator. It returns Ok((true, length)) if the writing process was successful. The string length returned does include the null terminator. Length is measured in units of u16.

source

fn read_wchar_t_str( &self, ptr: Pointer<Option<Provenance>> ) -> InterpResult<'tcx, Vec<u32>>

Read a sequence of wchar_t until the first null terminator. Always returns a Vec<u32> no matter the size of wchar_t.

source

fn check_abi<'a>(&self, abi: Abi, exp_abi: Abi) -> InterpResult<'a, ()>

Check that the ABI is what we expect.

source

fn frame_in_std(&self) -> bool

source

fn handle_unsupported_foreign_item( &mut self, error_msg: String ) -> InterpResult<'tcx, ()>

Handler that should be called when an unsupported foreign item is encountered. This function will either panic within the context of the emulated application or return an error in the Miri process context

source

fn check_abi_and_shim_symbol_clash( &mut self, abi: Abi, exp_abi: Abi, link_name: Symbol ) -> InterpResult<'tcx, ()>

source

fn check_shim<'a, const N: usize>( &mut self, abi: Abi, exp_abi: Abi, link_name: Symbol, args: &'a [OpTy<'tcx, Provenance>] ) -> InterpResult<'tcx, &'a [OpTy<'tcx, Provenance>; N]>
where &'a [OpTy<'tcx, Provenance>; N]: TryFrom<&'a [OpTy<'tcx, Provenance>]>,

source

fn mark_immutable(&mut self, mplace: &MPlaceTy<'tcx, Provenance>)

Mark a machine allocation that was just created as immutable.

source

fn float_to_int_checked( &self, src: &ImmTy<'tcx, Provenance>, cast_to: TyAndLayout<'tcx>, round: Round ) -> InterpResult<'tcx, Option<ImmTy<'tcx, Provenance>>>

Converts src from floating point to integer type dest_ty after rounding with mode round. Returns None if f is NaN or out of range.

source

fn get_twice_wide_int_ty(&self, ty: Ty<'tcx>) -> Ty<'tcx>

Returns an integer type that is twice wide as ty

source

fn expect_target_feature_for_intrinsic( &self, intrinsic: Symbol, target_feature: &str ) -> InterpResult<'tcx, ()>

Checks that target feature target_feature is enabled.

If not enabled, emits an UB error that states that the feature is required by intrinsic.

Lookup an array of immediates stored as a linker section of name name.

Object Safety§

This trait is not object safe.

Implementors§

source§

impl<'tcx> EvalContextExt<'tcx> for MiriInterpCx<'tcx>