]> git.lizzy.rs Git - rust.git/blob - src/helpers.rs
Auto merge of #1786 - RalfJung:rustup, 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         caller_abi: Abi,
165         args: &[Immediate<Tag>],
166         dest: Option<&PlaceTy<'tcx, Tag>>,
167         stack_pop: StackPopCleanup,
168     ) -> InterpResult<'tcx> {
169         let this = self.eval_context_mut();
170         let param_env = ty::ParamEnv::reveal_all(); // in Miri this is always the param_env we use... and this.param_env is private.
171         let callee_abi = f.ty(*this.tcx, param_env).fn_sig(*this.tcx).abi();
172         if callee_abi != caller_abi {
173             throw_ub_format!("calling a function with ABI {} using caller ABI {}", callee_abi.name(), caller_abi.name())
174         }
175
176         // Push frame.
177         let mir = &*this.load_mir(f.def, None)?;
178         this.push_stack_frame(f, mir, dest, stack_pop)?;
179
180         // Initialize arguments.
181         let mut callee_args = this.frame().body.args_iter();
182         for arg in args {
183             let callee_arg = this.local_place(
184                 callee_args.next().ok_or_else(||
185                     err_ub_format!("callee has fewer arguments than expected")
186                 )?
187             )?;
188             this.write_immediate(*arg, &callee_arg)?;
189         }
190         if callee_args.next().is_some() {
191             throw_ub_format!("callee has more arguments than expected");
192         }
193
194         Ok(())
195     }
196
197     /// Visits the memory covered by `place`, sensitive to freezing: the 3rd parameter
198     /// will be true if this is frozen, false if this is in an `UnsafeCell`.
199     fn visit_freeze_sensitive(
200         &self,
201         place: &MPlaceTy<'tcx, Tag>,
202         size: Size,
203         mut action: impl FnMut(Pointer<Tag>, Size, bool) -> InterpResult<'tcx>,
204     ) -> InterpResult<'tcx> {
205         let this = self.eval_context_ref();
206         trace!("visit_frozen(place={:?}, size={:?})", *place, size);
207         debug_assert_eq!(
208             size,
209             this.size_and_align_of_mplace(place)?
210                 .map(|(size, _)| size)
211                 .unwrap_or_else(|| place.layout.size)
212         );
213         // Store how far we proceeded into the place so far. Everything to the left of
214         // this offset has already been handled, in the sense that the frozen parts
215         // have had `action` called on them.
216         let mut end_ptr = place.ptr.assert_ptr();
217         // Called when we detected an `UnsafeCell` at the given offset and size.
218         // Calls `action` and advances `end_ptr`.
219         let mut unsafe_cell_action = |unsafe_cell_ptr: Scalar<Tag>, unsafe_cell_size: Size| {
220             let unsafe_cell_ptr = unsafe_cell_ptr.assert_ptr();
221             debug_assert_eq!(unsafe_cell_ptr.alloc_id, end_ptr.alloc_id);
222             debug_assert_eq!(unsafe_cell_ptr.tag, end_ptr.tag);
223             // We assume that we are given the fields in increasing offset order,
224             // and nothing else changes.
225             let unsafe_cell_offset = unsafe_cell_ptr.offset;
226             let end_offset = end_ptr.offset;
227             assert!(unsafe_cell_offset >= end_offset);
228             let frozen_size = unsafe_cell_offset - end_offset;
229             // Everything between the end_ptr and this `UnsafeCell` is frozen.
230             if frozen_size != Size::ZERO {
231                 action(end_ptr, frozen_size, /*frozen*/ true)?;
232             }
233             // This `UnsafeCell` is NOT frozen.
234             if unsafe_cell_size != Size::ZERO {
235                 action(unsafe_cell_ptr, unsafe_cell_size, /*frozen*/ false)?;
236             }
237             // Update end end_ptr.
238             end_ptr = unsafe_cell_ptr.wrapping_offset(unsafe_cell_size, this);
239             // Done
240             Ok(())
241         };
242         // Run a visitor
243         {
244             let mut visitor = UnsafeCellVisitor {
245                 ecx: this,
246                 unsafe_cell_action: |place| {
247                     trace!("unsafe_cell_action on {:?}", place.ptr);
248                     // We need a size to go on.
249                     let unsafe_cell_size = this
250                         .size_and_align_of_mplace(&place)?
251                         .map(|(size, _)| size)
252                         // for extern types, just cover what we can
253                         .unwrap_or_else(|| place.layout.size);
254                     // Now handle this `UnsafeCell`, unless it is empty.
255                     if unsafe_cell_size != Size::ZERO {
256                         unsafe_cell_action(place.ptr, unsafe_cell_size)
257                     } else {
258                         Ok(())
259                     }
260                 },
261             };
262             visitor.visit_value(place)?;
263         }
264         // The part between the end_ptr and the end of the place is also frozen.
265         // So pretend there is a 0-sized `UnsafeCell` at the end.
266         unsafe_cell_action(place.ptr.ptr_wrapping_offset(size, this), Size::ZERO)?;
267         // Done!
268         return Ok(());
269
270         /// Visiting the memory covered by a `MemPlace`, being aware of
271         /// whether we are inside an `UnsafeCell` or not.
272         struct UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
273         where
274             F: FnMut(&MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
275         {
276             ecx: &'ecx MiriEvalContext<'mir, 'tcx>,
277             unsafe_cell_action: F,
278         }
279
280         impl<'ecx, 'mir, 'tcx: 'mir, F> ValueVisitor<'mir, 'tcx, Evaluator<'mir, 'tcx>>
281             for UnsafeCellVisitor<'ecx, 'mir, 'tcx, F>
282         where
283             F: FnMut(&MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx>,
284         {
285             type V = MPlaceTy<'tcx, Tag>;
286
287             #[inline(always)]
288             fn ecx(&self) -> &MiriEvalContext<'mir, 'tcx> {
289                 &self.ecx
290             }
291
292             // Hook to detect `UnsafeCell`.
293             fn visit_value(&mut self, v: &MPlaceTy<'tcx, Tag>) -> InterpResult<'tcx> {
294                 trace!("UnsafeCellVisitor: {:?} {:?}", *v, v.layout.ty);
295                 let is_unsafe_cell = match v.layout.ty.kind() {
296                     ty::Adt(adt, _) =>
297                         Some(adt.did) == self.ecx.tcx.lang_items().unsafe_cell_type(),
298                     _ => false,
299                 };
300                 if is_unsafe_cell {
301                     // We do not have to recurse further, this is an `UnsafeCell`.
302                     (self.unsafe_cell_action)(v)
303                 } else if self.ecx.type_is_freeze(v.layout.ty) {
304                     // This is `Freeze`, there cannot be an `UnsafeCell`
305                     Ok(())
306                 } else if matches!(v.layout.fields, FieldsShape::Union(..)) {
307                     // A (non-frozen) union. We fall back to whatever the type says.
308                     (self.unsafe_cell_action)(v)
309                 } else {
310                     // We want to not actually read from memory for this visit. So, before
311                     // walking this value, we have to make sure it is not a
312                     // `Variants::Multiple`.
313                     match v.layout.variants {
314                         Variants::Multiple { .. } => {
315                             // A multi-variant enum, or generator, or so.
316                             // Treat this like a union: without reading from memory,
317                             // we cannot determine the variant we are in. Reading from
318                             // memory would be subject to Stacked Borrows rules, leading
319                             // to all sorts of "funny" recursion.
320                             // We only end up here if the type is *not* freeze, so we just call the
321                             // `UnsafeCell` action.
322                             (self.unsafe_cell_action)(v)
323                         }
324                         Variants::Single { .. } => {
325                             // Proceed further, try to find where exactly that `UnsafeCell`
326                             // is hiding.
327                             self.walk_value(v)
328                         }
329                     }
330                 }
331             }
332
333             // Make sure we visit aggregrates in increasing offset order.
334             fn visit_aggregate(
335                 &mut self,
336                 place: &MPlaceTy<'tcx, Tag>,
337                 fields: impl Iterator<Item = InterpResult<'tcx, MPlaceTy<'tcx, Tag>>>,
338             ) -> InterpResult<'tcx> {
339                 match place.layout.fields {
340                     FieldsShape::Array { .. } => {
341                         // For the array layout, we know the iterator will yield sorted elements so
342                         // we can avoid the allocation.
343                         self.walk_aggregate(place, fields)
344                     }
345                     FieldsShape::Arbitrary { .. } => {
346                         // Gather the subplaces and sort them before visiting.
347                         let mut places =
348                             fields.collect::<InterpResult<'tcx, Vec<MPlaceTy<'tcx, Tag>>>>()?;
349                         places.sort_by_key(|place| place.ptr.assert_ptr().offset);
350                         self.walk_aggregate(place, places.into_iter().map(Ok))
351                     }
352                     FieldsShape::Union { .. } | FieldsShape::Primitive => {
353                         // Uh, what?
354                         bug!("unions/primitives are not aggregates we should ever visit")
355                     }
356                 }
357             }
358
359             fn visit_union(&mut self, _v: &MPlaceTy<'tcx, Tag>, _fields: NonZeroUsize) -> InterpResult<'tcx> {
360                 bug!("we should have already handled unions in `visit_value`")
361             }
362         }
363     }
364
365     // Writes several `ImmTy`s contiguously into memory. This is useful when you have to pack
366     // different values into a struct.
367     fn write_packed_immediates(
368         &mut self,
369         place: &MPlaceTy<'tcx, Tag>,
370         imms: &[ImmTy<'tcx, Tag>],
371     ) -> InterpResult<'tcx> {
372         let this = self.eval_context_mut();
373
374         let mut offset = Size::from_bytes(0);
375
376         for &imm in imms {
377             this.write_immediate_to_mplace(
378                 *imm,
379                 &place.offset(offset, MemPlaceMeta::None, imm.layout, &*this.tcx)?,
380             )?;
381             offset += imm.layout.size;
382         }
383         Ok(())
384     }
385
386     /// Helper function used inside the shims of foreign functions to check that isolation is
387     /// disabled. It returns an error using the `name` of the foreign function if this is not the
388     /// case.
389     fn check_no_isolation(&self, name: &str) -> InterpResult<'tcx> {
390         if !self.eval_context_ref().machine.communicate {
391             isolation_error(name)?;
392         }
393         Ok(())
394     }
395
396     /// Helper function used inside the shims of foreign functions to assert that the target OS
397     /// is `target_os`. It panics showing a message with the `name` of the foreign function
398     /// if this is not the case.
399     fn assert_target_os(&self, target_os: &str, name: &str) {
400         assert_eq!(
401             self.eval_context_ref().tcx.sess.target.os,
402             target_os,
403             "`{}` is only available on the `{}` target OS",
404             name,
405             target_os,
406         )
407     }
408
409     /// Get last error variable as a place, lazily allocating thread-local storage for it if
410     /// necessary.
411     fn last_error_place(&mut self) -> InterpResult<'tcx, MPlaceTy<'tcx, Tag>> {
412         let this = self.eval_context_mut();
413         if let Some(errno_place) = this.active_thread_ref().last_error {
414             Ok(errno_place)
415         } else {
416             // Allocate new place, set initial value to 0.
417             let errno_layout = this.machine.layouts.u32;
418             let errno_place = this.allocate(errno_layout, MiriMemoryKind::Machine.into());
419             this.write_scalar(Scalar::from_u32(0), &errno_place.into())?;
420             this.active_thread_mut().last_error = Some(errno_place);
421             Ok(errno_place)
422         }
423     }
424
425     /// Sets the last error variable.
426     fn set_last_error(&mut self, scalar: Scalar<Tag>) -> InterpResult<'tcx> {
427         let this = self.eval_context_mut();
428         let errno_place = this.last_error_place()?;
429         this.write_scalar(scalar, &errno_place.into())
430     }
431
432     /// Gets the last error variable.
433     fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Tag>> {
434         let this = self.eval_context_mut();
435         let errno_place = this.last_error_place()?;
436         this.read_scalar(&errno_place.into())?.check_init()
437     }
438
439     /// Sets the last OS error using a `std::io::Error`. This function tries to produce the most
440     /// similar OS error from the `std::io::ErrorKind` and sets it as the last OS error.
441     fn set_last_error_from_io_error(&mut self, e: std::io::Error) -> InterpResult<'tcx> {
442         use std::io::ErrorKind::*;
443         let this = self.eval_context_mut();
444         let target = &this.tcx.sess.target;
445         let target_os = &target.os;
446         let last_error = if target.families.contains(&"unix".to_owned()) {
447             this.eval_libc(match e.kind() {
448                 ConnectionRefused => "ECONNREFUSED",
449                 ConnectionReset => "ECONNRESET",
450                 PermissionDenied => "EPERM",
451                 BrokenPipe => "EPIPE",
452                 NotConnected => "ENOTCONN",
453                 ConnectionAborted => "ECONNABORTED",
454                 AddrNotAvailable => "EADDRNOTAVAIL",
455                 AddrInUse => "EADDRINUSE",
456                 NotFound => "ENOENT",
457                 Interrupted => "EINTR",
458                 InvalidInput => "EINVAL",
459                 TimedOut => "ETIMEDOUT",
460                 AlreadyExists => "EEXIST",
461                 WouldBlock => "EWOULDBLOCK",
462                 _ => {
463                     throw_unsup_format!("io error {} cannot be transformed into a raw os error", e)
464                 }
465             })?
466         } else if target.families.contains(&"windows".to_owned()) {
467             // FIXME: we have to finish implementing the Windows equivalent of this.
468             this.eval_windows("c", match e.kind() {
469                 NotFound => "ERROR_FILE_NOT_FOUND",
470                 _ => throw_unsup_format!("io error {} cannot be transformed into a raw os error", e)
471             })?
472         } else {
473             throw_unsup_format!("setting the last OS error from an io::Error is unsupported for {}.", target_os)
474         };
475         this.set_last_error(last_error)
476     }
477
478     /// Helper function that consumes an `std::io::Result<T>` and returns an
479     /// `InterpResult<'tcx,T>::Ok` instead. In case the result is an error, this function returns
480     /// `Ok(-1)` and sets the last OS error accordingly.
481     ///
482     /// This function uses `T: From<i32>` instead of `i32` directly because some IO related
483     /// functions return different integer types (like `read`, that returns an `i64`).
484     fn try_unwrap_io_result<T: From<i32>>(
485         &mut self,
486         result: std::io::Result<T>,
487     ) -> InterpResult<'tcx, T> {
488         match result {
489             Ok(ok) => Ok(ok),
490             Err(e) => {
491                 self.eval_context_mut().set_last_error_from_io_error(e)?;
492                 Ok((-1).into())
493             }
494         }
495     }
496
497     fn read_scalar_at_offset(
498         &self,
499         op: &OpTy<'tcx, Tag>,
500         offset: u64,
501         layout: TyAndLayout<'tcx>,
502     ) -> InterpResult<'tcx, ScalarMaybeUninit<Tag>> {
503         let this = self.eval_context_ref();
504         let op_place = this.deref_operand(op)?;
505         let offset = Size::from_bytes(offset);
506         // Ensure that the following read at an offset is within bounds
507         assert!(op_place.layout.size >= offset + layout.size);
508         let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
509         this.read_scalar(&value_place.into())
510     }
511
512     fn write_scalar_at_offset(
513         &mut self,
514         op: &OpTy<'tcx, Tag>,
515         offset: u64,
516         value: impl Into<ScalarMaybeUninit<Tag>>,
517         layout: TyAndLayout<'tcx>,
518     ) -> InterpResult<'tcx, ()> {
519         let this = self.eval_context_mut();
520         let op_place = this.deref_operand(op)?;
521         let offset = Size::from_bytes(offset);
522         // Ensure that the following read at an offset is within bounds
523         assert!(op_place.layout.size >= offset + layout.size);
524         let value_place = op_place.offset(offset, MemPlaceMeta::None, layout, this)?;
525         this.write_scalar(value, &value_place.into())
526     }
527
528     /// Parse a `timespec` struct and return it as a `std::time::Duration`. It returns `None`
529     /// if the value in the `timespec` struct is invalid. Some libc functions will return
530     /// `EINVAL` in this case.
531     fn read_timespec(
532         &mut self,
533         timespec_ptr_op: &OpTy<'tcx, Tag>,
534     ) -> InterpResult<'tcx, Option<Duration>> {
535         let this = self.eval_context_mut();
536         let tp = this.deref_operand(timespec_ptr_op)?;
537         let seconds_place = this.mplace_field(&tp, 0)?;
538         let seconds_scalar = this.read_scalar(&seconds_place.into())?;
539         let seconds = seconds_scalar.to_machine_isize(this)?;
540         let nanoseconds_place = this.mplace_field(&tp, 1)?;
541         let nanoseconds_scalar = this.read_scalar(&nanoseconds_place.into())?;
542         let nanoseconds = nanoseconds_scalar.to_machine_isize(this)?;
543
544         Ok(try {
545             // tv_sec must be non-negative.
546             let seconds: u64 = seconds.try_into().ok()?;
547             // tv_nsec must be non-negative.
548             let nanoseconds: u32 = nanoseconds.try_into().ok()?;
549             if nanoseconds >= 1_000_000_000 {
550                 // tv_nsec must not be greater than 999,999,999.
551                 None?
552             }
553             Duration::new(seconds, nanoseconds)
554         })
555     }
556 }
557
558 /// Check that the number of args is what we expect.
559 pub fn check_arg_count<'a, 'tcx, const N: usize>(args: &'a [OpTy<'tcx, Tag>]) -> InterpResult<'tcx, &'a [OpTy<'tcx, Tag>; N]>
560     where &'a [OpTy<'tcx, Tag>; N]: TryFrom<&'a [OpTy<'tcx, Tag>]> {
561     if let Ok(ops) = args.try_into() {
562         return Ok(ops);
563     }
564     throw_ub_format!("incorrect number of arguments: got {}, expected {}", args.len(), N)
565 }
566
567 /// Check that the ABI is what we expect.
568 pub fn check_abi<'a>(abi: Abi, exp_abi: Abi) -> InterpResult<'a, ()> {
569     if abi == exp_abi {
570         Ok(())
571     } else {
572         throw_ub_format!("calling a function with ABI {} using caller ABI {}", exp_abi.name(), abi.name())
573     }
574 }
575
576 pub fn isolation_error(name: &str) -> InterpResult<'static> {
577     throw_machine_stop!(TerminationInfo::UnsupportedInIsolation(format!(
578         "{} not available when isolation is enabled",
579         name,
580     )))
581 }
582
583 pub fn immty_from_int_checked<'tcx>(
584     int: impl Into<i128>,
585     layout: TyAndLayout<'tcx>,
586 ) -> InterpResult<'tcx, ImmTy<'tcx, Tag>> {
587     let int = int.into();
588     Ok(ImmTy::try_from_int(int, layout).ok_or_else(|| {
589         err_unsup_format!("signed value {:#x} does not fit in {} bits", int, layout.size.bits())
590     })?)
591 }
592
593 pub fn immty_from_uint_checked<'tcx>(
594     int: impl Into<u128>,
595     layout: TyAndLayout<'tcx>,
596 ) -> InterpResult<'tcx, ImmTy<'tcx, Tag>> {
597     let int = int.into();
598     Ok(ImmTy::try_from_uint(int, layout).ok_or_else(|| {
599         err_unsup_format!("unsigned value {:#x} does not fit in {} bits", int, layout.size.bits())
600     })?)
601 }