]> git.lizzy.rs Git - rust.git/blob - src/helpers.rs
Auto merge of #1670 - unseddd:abi, r=RalfJung
[rust.git] / src / helpers.rs
1 use std::convert::{TryFrom, TryInto};
2 use std::mem;
3 use std::num::NonZeroUsize;
4 use std::time::Duration;
5
6 use log::trace;
7
8 use rustc_middle::mir;
9 use rustc_middle::ty::{self, List, TyCtxt, layout::TyAndLayout};
10 use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX};
11 use rustc_target::abi::{LayoutOf, Size, FieldsShape, Variants};
12 use rustc_target::spec::abi::Abi;
13
14 use rand::RngCore;
15
16 use crate::*;
17
18 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
19
20 /// Gets an instance for a path.
21 fn try_resolve_did<'mir, 'tcx>(tcx: TyCtxt<'tcx>, path: &[&str]) -> Option<DefId> {
22     tcx.crates()
23         .iter()
24         .find(|&&krate| tcx.original_crate_name(krate).as_str() == path[0])
25         .and_then(|krate| {
26             let krate = DefId { krate: *krate, index: CRATE_DEF_INDEX };
27             let mut items = tcx.item_children(krate);
28             let mut path_it = path.iter().skip(1).peekable();
29
30             while let Some(segment) = path_it.next() {
31                 for item in mem::replace(&mut items, Default::default()).iter() {
32                     if item.ident.name.as_str() == *segment {
33                         if path_it.peek().is_none() {
34                             return Some(item.res.def_id());
35                         }
36
37                         items = tcx.item_children(item.res.def_id());
38                         break;
39                     }
40                 }
41             }
42             None
43         })
44 }
45
46 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
47     /// Gets an instance for a path.
48     fn resolve_path(&self, path: &[&str]) -> ty::Instance<'tcx> {
49         let did = try_resolve_did(self.eval_context_ref().tcx.tcx, path)
50             .unwrap_or_else(|| panic!("failed to find required Rust item: {:?}", path));
51         ty::Instance::mono(self.eval_context_ref().tcx.tcx, did)
52     }
53
54     /// Evaluates the scalar at the specified path. Returns Some(val)
55     /// if the path could be resolved, and None otherwise
56     fn eval_path_scalar(
57         &mut self,
58         path: &[&str],
59     ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
60         let this = self.eval_context_mut();
61         let instance = this.resolve_path(path);
62         let cid = GlobalId { instance, promoted: None };
63         let const_val = this.eval_to_allocation(cid)?;
64         let const_val = this.read_scalar(const_val.into())?;
65         return Ok(const_val);
66     }
67
68     /// Helper function to get a `libc` constant as a `Scalar`.
69     fn eval_libc(&mut self, name: &str) -> InterpResult<'tcx, Scalar<Tag>> {
70         self.eval_context_mut()
71             .eval_path_scalar(&["libc", name])?
72             .check_init()
73     }
74
75     /// Helper function to get a `libc` constant as an `i32`.
76     fn eval_libc_i32(&mut self, name: &str) -> InterpResult<'tcx, i32> {
77         // TODO: Cache the result.
78         self.eval_libc(name)?.to_i32()
79     }
80
81     /// Helper function to get a `windows` constant as a `Scalar`.
82     fn eval_windows(&mut self, module: &str, name: &str) -> InterpResult<'tcx, Scalar<Tag>> {
83         self.eval_context_mut()
84             .eval_path_scalar(&["std", "sys", "windows", module, name])?
85             .check_init()
86     }
87
88     /// Helper function to get a `windows` constant as an `u64`.
89     fn eval_windows_u64(&mut self, module: &str, name: &str) -> InterpResult<'tcx, u64> {
90         // TODO: Cache the result.
91         self.eval_windows(module, name)?.to_u64()
92     }
93
94     /// Helper function to get the `TyAndLayout` of a `libc` type
95     fn libc_ty_layout(&mut self, name: &str) -> InterpResult<'tcx, TyAndLayout<'tcx>> {
96         let this = self.eval_context_mut();
97         let ty = this.resolve_path(&["libc", name]).ty(*this.tcx, ty::ParamEnv::reveal_all());
98         this.layout_of(ty)
99     }
100
101     /// Helper function to get the `TyAndLayout` of a `windows` type
102     fn windows_ty_layout(&mut self, name: &str) -> InterpResult<'tcx, TyAndLayout<'tcx>> {
103         let this = self.eval_context_mut();
104         let ty = this.resolve_path(&["std", "sys", "windows", "c", name]).ty(*this.tcx, ty::ParamEnv::reveal_all());
105         this.layout_of(ty)
106     }
107
108     /// Write a 0 of the appropriate size to `dest`.
109     fn write_null(&mut self, dest: PlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
110         self.eval_context_mut().write_scalar(Scalar::from_int(0, dest.layout.size), dest)
111     }
112
113     /// Test if this immediate equals 0.
114     fn is_null(&self, val: Scalar<Tag>) -> InterpResult<'tcx, bool> {
115         let this = self.eval_context_ref();
116         let null = Scalar::null_ptr(this);
117         this.ptr_eq(val, null)
118     }
119
120     /// Turn a Scalar into an Option<NonNullScalar>
121     fn test_null(&self, val: Scalar<Tag>) -> InterpResult<'tcx, Option<Scalar<Tag>>> {
122         let this = self.eval_context_ref();
123         Ok(if this.is_null(val)? { None } else { Some(val) })
124     }
125
126     /// Get the `Place` for a local
127     fn local_place(&mut self, local: mir::Local) -> InterpResult<'tcx, PlaceTy<'tcx, Tag>> {
128         let this = self.eval_context_mut();
129         let place = mir::Place { local: local, projection: List::empty() };
130         this.eval_place(place)
131     }
132
133     /// Generate some random bytes, and write them to `dest`.
134     fn gen_random(&mut self, ptr: Scalar<Tag>, len: u64) -> InterpResult<'tcx> {
135         // Some programs pass in a null pointer and a length of 0
136         // to their platform's random-generation function (e.g. getrandom())
137         // on Linux. For compatibility with these programs, we don't perform
138         // any additional checks - it's okay if the pointer is invalid,
139         // since we wouldn't actually be writing to it.
140         if len == 0 {
141             return Ok(());
142         }
143         let this = self.eval_context_mut();
144
145         let mut data = vec![0; usize::try_from(len).unwrap()];
146
147         if this.machine.communicate {
148             // Fill the buffer using the host's rng.
149             getrandom::getrandom(&mut data)
150                 .map_err(|err| err_unsup_format!("host getrandom failed: {}", err))?;
151         } else {
152             let rng = this.memory.extra.rng.get_mut();
153             rng.fill_bytes(&mut data);
154         }
155
156         this.memory.write_bytes(ptr, data.iter().copied())
157     }
158
159     /// Call a function: Push the stack frame and pass the arguments.
160     /// For now, arguments must be scalars (so that the caller does not have to know the layout).
161     fn call_function(
162         &mut self,
163         f: ty::Instance<'tcx>,
164         args: &[Immediate<Tag>],
165         dest: Option<PlaceTy<'tcx, Tag>>,
166         stack_pop: StackPopCleanup,
167     ) -> InterpResult<'tcx> {
168         let this = self.eval_context_mut();
169
170         // Push frame.
171         let mir = &*this.load_mir(f.def, None)?;
172         this.push_stack_frame(f, mir, dest, stack_pop)?;
173
174         // Initialize arguments.
175         let mut callee_args = this.frame().body.args_iter();
176         for arg in args {
177             let callee_arg = this.local_place(
178                 callee_args.next().expect("callee has fewer arguments than expected"),
179             )?;
180             this.write_immediate(*arg, callee_arg)?;
181         }
182         callee_args.next().expect_none("callee has more arguments than expected");
183
184         Ok(())
185     }
186
187     /// Visits the memory covered by `place`, sensitive to freezing: the 3rd parameter
188     /// will be true if this is frozen, false if this is in an `UnsafeCell`.
189     fn visit_freeze_sensitive(
190         &self,
191         place: MPlaceTy<'tcx, Tag>,
192         size: Size,
193         mut action: impl FnMut(Pointer<Tag>, Size, bool) -> InterpResult<'tcx>,
194     ) -> InterpResult<'tcx> {
195         let this = self.eval_context_ref();
196         trace!("visit_frozen(place={:?}, size={:?})", *place, size);
197         debug_assert_eq!(
198             size,
199             this.size_and_align_of_mplace(place)?
200                 .map(|(size, _)| size)
201                 .unwrap_or_else(|| place.layout.size)
202         );
203         // Store how far we proceeded into the place so far. Everything to the left of
204         // this offset has already been handled, in the sense that the frozen parts
205         // have had `action` called on them.
206         let mut end_ptr = place.ptr.assert_ptr();
207         // Called when we detected an `UnsafeCell` at the given offset and size.
208         // Calls `action` and advances `end_ptr`.
209         let mut unsafe_cell_action = |unsafe_cell_ptr: Scalar<Tag>, unsafe_cell_size: Size| {
210             let unsafe_cell_ptr = unsafe_cell_ptr.assert_ptr();
211             debug_assert_eq!(unsafe_cell_ptr.alloc_id, end_ptr.alloc_id);
212             debug_assert_eq!(unsafe_cell_ptr.tag, end_ptr.tag);
213             // We assume that we are given the fields in increasing offset order,
214             // and nothing else changes.
215             let unsafe_cell_offset = unsafe_cell_ptr.offset;
216             let end_offset = end_ptr.offset;
217             assert!(unsafe_cell_offset >= end_offset);
218             let frozen_size = unsafe_cell_offset - end_offset;
219             // Everything between the end_ptr and this `UnsafeCell` is frozen.
220             if frozen_size != Size::ZERO {
221                 action(end_ptr, frozen_size, /*frozen*/ true)?;
222             }
223             // This `UnsafeCell` is NOT frozen.
224             if unsafe_cell_size != Size::ZERO {
225                 action(unsafe_cell_ptr, unsafe_cell_size, /*frozen*/ false)?;
226             }
227             // Update end end_ptr.
228             end_ptr = unsafe_cell_ptr.wrapping_offset(unsafe_cell_size, this);
229             // Done
230             Ok(())
231         };
232         // Run a visitor
233         {
234             let mut visitor = UnsafeCellVisitor {
235                 ecx: this,
236                 unsafe_cell_action: |place| {
237                     trace!("unsafe_cell_action on {:?}", place.ptr);
238                     // We need a size to go on.
239                     let unsafe_cell_size = this
240                         .size_and_align_of_mplace(place)?
241                         .map(|(size, _)| size)
242                         // for extern types, just cover what we can
243                         .unwrap_or_else(|| place.layout.size);
244                     // Now handle this `UnsafeCell`, unless it is empty.
245                     if unsafe_cell_size != Size::ZERO {
246                         unsafe_cell_action(place.ptr, unsafe_cell_size)
247                     } else {
248                         Ok(())
249                     }
250                 },
251             };
252             visitor.visit_value(place)?;
253         }
254         // The part between the end_ptr and the end of the place is also frozen.
255         // So pretend there is a 0-sized `UnsafeCell` at the end.
256         unsafe_cell_action(place.ptr.ptr_wrapping_offset(size, this), Size::ZERO)?;
257         // Done!
258         return Ok(());
259
260         /// Visiting the memory covered by a `MemPlace`, being aware of
261         /// whether we are inside an `UnsafeCell` or not.
262         struct UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
263         where
264             F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
265         {
266             ecx: &'ecx MiriEvalContext<'mir, 'tcx>,
267             unsafe_cell_action: F,
268         }
269
270         impl<'ecx, 'mir, 'tcx: 'mir, F> ValueVisitor<'mir, 'tcx, Evaluator<'mir, 'tcx>>
271             for UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
272         where
273             F: FnMut(MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
274         {
275             type V = MPlaceTy<'tcx, Tag>;
276
277             #[inline(always)]
278             fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
279                 &self.ecx
280             }
281
282             // Hook to detect `UnsafeCell`.
283             fn visit_value(&mut self, v: MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
284                 trace!("UnsafeCellVisitor: {:?} {:?}", *v, v.layout.ty);
285                 let is_unsafe_cell = match v.layout.ty.kind() {
286                     ty::Adt(adt, _) =>
287                         Some(adt.did) == self.ecx.tcx.lang_items().unsafe_cell_type(),
288                     _ => false,
289                 };
290                 if is_unsafe_cell {
291                     // We do not have to recurse further, this is an `UnsafeCell`.
292                     (self.unsafe_cell_action)(v)
293                 } else if self.ecx.type_is_freeze(v.layout.ty) {
294                     // This is `Freeze`, there cannot be an `UnsafeCell`
295                     Ok(())
296                 } else if matches!(v.layout.fields, FieldsShape::Union(..)) {
297                     // A (non-frozen) union. We fall back to whatever the type says.
298                     (self.unsafe_cell_action)(v)
299                 } else {
300                     // We want to not actually read from memory for this visit. So, before
301                     // walking this value, we have to make sure it is not a
302                     // `Variants::Multiple`.
303                     match v.layout.variants {
304                         Variants::Multiple { .. } => {
305                             // A multi-variant enum, or generator, or so.
306                             // Treat this like a union: without reading from memory,
307                             // we cannot determine the variant we are in. Reading from
308                             // memory would be subject to Stacked Borrows rules, leading
309                             // to all sorts of "funny" recursion.
310                             // We only end up here if the type is *not* freeze, so we just call the
311                             // `UnsafeCell` action.
312                             (self.unsafe_cell_action)(v)
313                         }
314                         Variants::Single { .. } => {
315                             // Proceed further, try to find where exactly that `UnsafeCell`
316                             // is hiding.
317                             self.walk_value(v)
318                         }
319                     }
320                 }
321             }
322
323             // Make sure we visit aggregrates in increasing offset order.
324             fn visit_aggregate(
325                 &mut self,
326                 place: MPlaceTy<'tcx, Tag>,
327                 fields: impl Iterator<Item = InterpResult<'tcx, MPlaceTy<'tcx, Tag>>>,
328             ) -> InterpResult<'tcx> {
329                 match place.layout.fields {
330                     FieldsShape::Array { .. } => {
331                         // For the array layout, we know the iterator will yield sorted elements so
332                         // we can avoid the allocation.
333                         self.walk_aggregate(place, fields)
334                     }
335                     FieldsShape::Arbitrary { .. } => {
336                         // Gather the subplaces and sort them before visiting.
337                         let mut places =
338                             fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
339                         places.sort_by_key(|place| place.ptr.assert_ptr().offset);
340                         self.walk_aggregate(place, places.into_iter().map(Ok))
341                     }
342                     FieldsShape::Union { .. } | FieldsShape::Primitive => {
343                         // Uh, what?
344                         bug!("unions/primitives are not aggregates we should ever visit")
345                     }
346                 }
347             }
348
349             fn visit_union(&mut self, _v: MPlaceTy<'tcx, Tag>, _fields: NonZeroUsize) -> InterpResult<'tcx> {
350                 bug!("we should have already handled unions in `visit_value`")
351             }
352         }
353     }
354
355     // Writes several `ImmTy`s contiguously into memory. This is useful when you have to pack
356     // different values into a struct.
357     fn write_packed_immediates(
358         &mut self,
359         place: MPlaceTy<'tcx, Tag>,
360         imms: &[ImmTy<'tcx, Tag>],
361     ) -> InterpResult<'tcx> {
362         let this = self.eval_context_mut();
363
364         let mut offset = Size::from_bytes(0);
365
366         for &imm in imms {
367             this.write_immediate_to_mplace(
368                 *imm,
369                 place.offset(offset, MemPlaceMeta::None, imm.layout, &*this.tcx)?,
370             )?;
371             offset += imm.layout.size;
372         }
373         Ok(())
374     }
375
376     /// Helper function used inside the shims of foreign functions to check that isolation is
377     /// disabled. It returns an error using the `name` of the foreign function if this is not the
378     /// case.
379     fn check_no_isolation(&self, name: &str) -> InterpResult<'tcx> {
380         if !self.eval_context_ref().machine.communicate {
381             isolation_error(name)?;
382         }
383         Ok(())
384     }
385
386     /// Helper function used inside the shims of foreign functions to assert that the target OS
387     /// is `target_os`. It panics showing a message with the `name` of the foreign function
388     /// if this is not the case.
389     fn assert_target_os(&self, target_os: &str, name: &str) {
390         assert_eq!(
391             self.eval_context_ref().tcx.sess.target.os,
392             target_os,
393             "`{}` is only available on the `{}` target OS",
394             name,
395             target_os,
396         )
397     }
398
399     /// Get last error variable as a place, lazily allocating thread-local storage for it if
400     /// necessary.
401     fn last_error_place(&mut self) -> InterpResult<'tcx, MPlaceTy<'tcx, Tag>> {
402         let this = self.eval_context_mut();
403         if let Some(errno_place) = this.active_thread_ref().last_error {
404             Ok(errno_place)
405         } else {
406             // Allocate new place, set initial value to 0.
407             let errno_layout = this.machine.layouts.u32;
408             let errno_place = this.allocate(errno_layout, MiriMemoryKind::Machine.into());
409             this.write_scalar(Scalar::from_u32(0), errno_place.into())?;
410             this.active_thread_mut().last_error = Some(errno_place);
411             Ok(errno_place)
412         }
413     }
414
415     /// Sets the last error variable.
416     fn set_last_error(&mut self, scalar: Scalar<Tag>) -> InterpResult<'tcx> {
417         let this = self.eval_context_mut();
418         let errno_place = this.last_error_place()?;
419         this.write_scalar(scalar, errno_place.into())
420     }
421
422     /// Gets the last error variable.
423     fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Tag>> {
424         let this = self.eval_context_mut();
425         let errno_place = this.last_error_place()?;
426         this.read_scalar(errno_place.into())?.check_init()
427     }
428
429     /// Sets the last OS error using a `std::io::Error`. This function tries to produce the most
430     /// similar OS error from the `std::io::ErrorKind` and sets it as the last OS error.
431     fn set_last_error_from_io_error(&mut self, e: std::io::Error) -> InterpResult<'tcx> {
432         use std::io::ErrorKind::*;
433         let this = self.eval_context_mut();
434         let target = &this.tcx.sess.target;
435         let target_os = &target.os;
436         let last_error = if target.os_family == Some("unix".to_owned()) {
437             this.eval_libc(match e.kind() {
438                 ConnectionRefused => "ECONNREFUSED",
439                 ConnectionReset => "ECONNRESET",
440                 PermissionDenied => "EPERM",
441                 BrokenPipe => "EPIPE",
442                 NotConnected => "ENOTCONN",
443                 ConnectionAborted => "ECONNABORTED",
444                 AddrNotAvailable => "EADDRNOTAVAIL",
445                 AddrInUse => "EADDRINUSE",
446                 NotFound => "ENOENT",
447                 Interrupted => "EINTR",
448                 InvalidInput => "EINVAL",
449                 TimedOut => "ETIMEDOUT",
450                 AlreadyExists => "EEXIST",
451                 WouldBlock => "EWOULDBLOCK",
452                 _ => {
453                     throw_unsup_format!("io error {} cannot be transformed into a raw os error", e)
454                 }
455             })?
456         } else if target_os == "windows" {
457             // FIXME: we have to finish implementing the Windows equivalent of this.
458             this.eval_windows("c", match e.kind() {
459                 NotFound => "ERROR_FILE_NOT_FOUND",
460                 _ => throw_unsup_format!("io error {} cannot be transformed into a raw os error", e)
461             })?
462         } else {
463             throw_unsup_format!("setting the last OS error from an io::Error is unsupported for {}.", target_os)
464         };
465         this.set_last_error(last_error)
466     }
467
468     /// Helper function that consumes an `std::io::Result<T>` and returns an
469     /// `InterpResult<'tcx,T>::Ok` instead. In case the result is an error, this function returns
470     /// `Ok(-1)` and sets the last OS error accordingly.
471     ///
472     /// This function uses `T: From<i32>` instead of `i32` directly because some IO related
473     /// functions return different integer types (like `read`, that returns an `i64`).
474     fn try_unwrap_io_result<T: From<i32>>(
475         &mut self,
476         result: std::io::Result<T>,
477     ) -> InterpResult<'tcx, T> {
478         match result {
479             Ok(ok) => Ok(ok),
480             Err(e) => {
481                 self.eval_context_mut().set_last_error_from_io_error(e)?;
482                 Ok((-1).into())
483             }
484         }
485     }
486
487     fn read_scalar_at_offset(
488         &self,
489         op: OpTy<'tcx, Tag>,
490         offset: u64,
491         layout: TyAndLayout<'tcx>,
492     ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
493         let this = self.eval_context_ref();
494         let op_place = this.deref_operand(op)?;
495         let offset = Size::from_bytes(offset);
496         // Ensure that the following read at an offset is within bounds
497         assert!(op_place.layout.size >= offset + layout.size);
498         let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
499         this.read_scalar(value_place.into())
500     }
501
502     fn write_scalar_at_offset(
503         &mut self,
504         op: OpTy<'tcx, Tag>,
505         offset: u64,
506         value: impl Into<ScalarMaybeUninit<Tag>>,
507         layout: TyAndLayout<'tcx>,
508     ) -> InterpResult<'tcx, ()> {
509         let this = self.eval_context_mut();
510         let op_place = this.deref_operand(op)?;
511         let offset = Size::from_bytes(offset);
512         // Ensure that the following read at an offset is within bounds
513         assert!(op_place.layout.size >= offset + layout.size);
514         let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
515         this.write_scalar(value, value_place.into())
516     }
517
518     /// Parse a `timespec` struct and return it as a `std::time::Duration`. It returns `None`
519     /// if the value in the `timespec` struct is invalid. Some libc functions will return
520     /// `EINVAL` in this case.
521     fn read_timespec(
522         &mut self,
523         timespec_ptr_op: OpTy<'tcx, Tag>,
524     ) -> InterpResult<'tcx, Option<Duration>> {
525         let this = self.eval_context_mut();
526         let tp = this.deref_operand(timespec_ptr_op)?;
527         let seconds_place = this.mplace_field(tp, 0)?;
528         let seconds_scalar = this.read_scalar(seconds_place.into())?;
529         let seconds = seconds_scalar.to_machine_isize(this)?;
530         let nanoseconds_place = this.mplace_field(tp, 1)?;
531         let nanoseconds_scalar = this.read_scalar(nanoseconds_place.into())?;
532         let nanoseconds = nanoseconds_scalar.to_machine_isize(this)?;
533
534         Ok(try {
535             // tv_sec must be non-negative.
536             let seconds: u64 = seconds.try_into().ok()?;
537             // tv_nsec must be non-negative.
538             let nanoseconds: u32 = nanoseconds.try_into().ok()?;
539             if nanoseconds >= 1_000_000_000 {
540                 // tv_nsec must not be greater than 999,999,999.
541                 None?
542             }
543             Duration::new(seconds, nanoseconds)
544         })
545     }
546 }
547
548 /// Check that the number of args is what we expect.
549 pub fn check_arg_count<'a, 'tcx, const N: usize>(args: &'a [OpTy<'tcx, Tag>]) -> InterpResult<'tcx, &'a [OpTy<'tcx, Tag>; N]>
550     where &'a [OpTy<'tcx, Tag>; N]: TryFrom<&'a [OpTy<'tcx, Tag>]> {
551     if let Ok(ops) = args.try_into() {
552         return Ok(ops);
553     }
554     throw_ub_format!("incorrect number of arguments: got {}, expected {}", args.len(), N)
555 }
556
557 /// Check that the ABI is what we expect.
558 pub fn check_abi<'a>(abi: Abi, exp_abi: Abi) -> InterpResult<'a, ()> {
559     if abi == exp_abi {
560         Ok(())
561     } else {
562         throw_ub_format!("calling a function with ABI {:?} using caller ABI {:?}", exp_abi, abi)
563     }
564 }
565
566 pub fn isolation_error(name: &str) -> InterpResult<'static> {
567     throw_machine_stop!(TerminationInfo::UnsupportedInIsolation(format!(
568         "{} not available when isolation is enabled",
569         name,
570     )))
571 }
572
573 pub fn immty_from_int_checked<'tcx>(
574     int: impl Into<i128>,
575     layout: TyAndLayout<'tcx>,
576 ) -> InterpResult<'tcx, ImmTy<'tcx, Tag>> {
577     let int = int.into();
578     Ok(ImmTy::try_from_int(int, layout).ok_or_else(|| {
579         err_unsup_format!("signed value {:#x} does not fit in {} bits", int, layout.size.bits())
580     })?)
581 }
582
583 pub fn immty_from_uint_checked<'tcx>(
584     int: impl Into<u128>,
585     layout: TyAndLayout<'tcx>,
586 ) -> InterpResult<'tcx, ImmTy<'tcx, Tag>> {
587     let int = int.into();
588     Ok(ImmTy::try_from_uint(int, layout).ok_or_else(|| {
589         err_unsup_format!("unsigned value {:#x} does not fit in {} bits", int, layout.size.bits())
590     })?)
591 }