3 use rustc_ast::ast::InlineAsmOptions;
4 use rustc_middle::ty::layout::{FnAbiOf, LayoutOf};
5 use rustc_middle::ty::Instance;
10 use rustc_target::abi;
11 use rustc_target::abi::call::{ArgAbi, ArgAttribute, ArgAttributes, FnAbi, PassMode};
12 use rustc_target::spec::abi::Abi;
15 FnVal, ImmTy, Immediate, InterpCx, InterpResult, MPlaceTy, Machine, MemoryKind, OpTy, Operand,
16 PlaceTy, Scalar, StackPopCleanup, StackPopUnwind,
19 impl<'mir, 'tcx: 'mir, M: Machine<'mir, 'tcx>> InterpCx<'mir, 'tcx, M> {
20 pub(super) fn eval_terminator(
22 terminator: &mir::Terminator<'tcx>,
23 ) -> InterpResult<'tcx> {
24 use rustc_middle::mir::TerminatorKind::*;
25 match terminator.kind {
27 self.pop_stack_frame(/* unwinding */ false)?
30 Goto { target } => self.go_to_block(target),
32 SwitchInt { ref discr, ref targets } => {
33 let discr = self.read_immediate(&self.eval_operand(discr, None)?)?;
34 trace!("SwitchInt({:?})", *discr);
36 // Branch to the `otherwise` case by default, if no match is found.
37 let mut target_block = targets.otherwise();
39 for (const_int, target) in targets.iter() {
40 // Compare using MIR BinOp::Eq, to also support pointer values.
41 // (Avoiding `self.binary_op` as that does some redundant layout computation.)
43 .overflowing_binary_op(
46 &ImmTy::from_uint(const_int, discr.layout),
50 target_block = target;
55 self.go_to_block(target_block);
67 let old_stack = self.frame_idx();
68 let old_loc = self.frame().loc;
69 let func = self.eval_operand(func, None)?;
70 let args = self.eval_operands(args)?;
72 let fn_sig_binder = func.layout.ty.fn_sig(*self.tcx);
74 self.tcx.normalize_erasing_late_bound_regions(self.param_env, fn_sig_binder);
75 let extra_args = &args[fn_sig.inputs().len()..];
76 let extra_args = self.tcx.mk_type_list(extra_args.iter().map(|arg| arg.layout.ty));
78 let (fn_val, fn_abi, with_caller_location) = match *func.layout.ty.kind() {
80 let fn_ptr = self.read_pointer(&func)?;
81 let fn_val = self.get_ptr_fn(fn_ptr)?;
82 (fn_val, self.fn_abi_of_fn_ptr(fn_sig_binder, extra_args)?, false)
84 ty::FnDef(def_id, substs) => {
86 self.resolve(ty::WithOptConstParam::unknown(def_id), substs)?;
88 FnVal::Instance(instance),
89 self.fn_abi_of_instance(instance, extra_args)?,
90 instance.def.requires_caller_location(*self.tcx),
94 terminator.source_info.span,
95 "invalid callee of type {:?}",
100 let destination = self.eval_place(destination)?;
103 (fn_sig.abi, fn_abi),
105 with_caller_location,
108 match (cleanup, fn_abi.can_unwind) {
109 (Some(cleanup), true) => StackPopUnwind::Cleanup(*cleanup),
110 (None, true) => StackPopUnwind::Skip,
111 (_, false) => StackPopUnwind::NotAllowed,
114 // Sanity-check that `eval_fn_call` either pushed a new frame or
115 // did a jump to another block.
116 if self.frame_idx() == old_stack && self.frame().loc == old_loc {
117 span_bug!(terminator.source_info.span, "evaluating this call made no progress");
121 Drop { place, target, unwind } => {
122 let place = self.eval_place(place)?;
123 let ty = place.layout.ty;
124 trace!("TerminatorKind::drop: {:?}, type {}", place, ty);
126 let instance = Instance::resolve_drop_in_place(*self.tcx, ty);
127 self.drop_in_place(&place, instance, target, unwind)?;
130 Assert { ref cond, expected, ref msg, target, cleanup } => {
131 let cond_val = self.read_scalar(&self.eval_operand(cond, None)?)?.to_bool()?;
132 if expected == cond_val {
133 self.go_to_block(target);
135 M::assert_panic(self, msg, cleanup)?;
140 M::abort(self, "the program aborted execution".to_owned())?;
143 // When we encounter Resume, we've finished unwinding
144 // cleanup for the current stack frame. We pop it in order
145 // to continue unwinding the next frame
147 trace!("unwinding: resuming from cleanup");
148 // By definition, a Resume terminator means
149 // that we're unwinding
150 self.pop_stack_frame(/* unwinding */ true)?;
154 // It is UB to ever encounter this.
155 Unreachable => throw_ub!(Unreachable),
157 // These should never occur for MIR we actually run.
158 DropAndReplace { .. }
162 | GeneratorDrop => span_bug!(
163 terminator.source_info.span,
164 "{:#?} should have been eliminated by MIR pass",
168 InlineAsm { template, ref operands, options, destination, .. } => {
169 M::eval_inline_asm(self, template, operands, options)?;
170 if options.contains(InlineAsmOptions::NORETURN) {
171 throw_ub_format!("returned from noreturn inline assembly");
175 .expect("InlineAsm terminators without noreturn must have a destination"),
183 fn check_argument_compat(
184 caller_abi: &ArgAbi<'tcx, Ty<'tcx>>,
185 callee_abi: &ArgAbi<'tcx, Ty<'tcx>>,
187 // Heuristic for type comparison.
188 let layout_compat = || {
189 if caller_abi.layout.ty == callee_abi.layout.ty {
193 if caller_abi.layout.is_unsized() || callee_abi.layout.is_unsized() {
194 // No, no, no. We require the types to *exactly* match for unsized arguments. If
195 // these are somehow unsized "in a different way" (say, `dyn Trait` vs `[i32]`),
196 // then who knows what happens.
199 if caller_abi.layout.size != callee_abi.layout.size
200 || caller_abi.layout.align.abi != callee_abi.layout.align.abi
202 // This cannot go well...
205 // The rest *should* be okay, but we are extra conservative.
206 match (caller_abi.layout.abi, callee_abi.layout.abi) {
207 // Different valid ranges are okay (once we enforce validity,
208 // that will take care to make it UB to leave the range, just
209 // like for transmute).
210 (abi::Abi::Scalar(caller), abi::Abi::Scalar(callee)) => {
211 caller.primitive() == callee.primitive()
214 abi::Abi::ScalarPair(caller1, caller2),
215 abi::Abi::ScalarPair(callee1, callee2),
217 caller1.primitive() == callee1.primitive()
218 && caller2.primitive() == callee2.primitive()
224 // When comparing the PassMode, we have to be smart about comparing the attributes.
225 let arg_attr_compat = |a1: &ArgAttributes, a2: &ArgAttributes| {
226 // There's only one regular attribute that matters for the call ABI: InReg.
227 // Everything else is things like noalias, dereferenceable, nonnull, ...
228 // (This also applies to pointee_size, pointee_align.)
229 if a1.regular.contains(ArgAttribute::InReg) != a2.regular.contains(ArgAttribute::InReg)
233 // We also compare the sign extension mode -- this could let the callee make assumptions
234 // about bits that conceptually were not even passed.
235 if a1.arg_ext != a2.arg_ext {
240 let mode_compat = || match (&caller_abi.mode, &callee_abi.mode) {
241 (PassMode::Ignore, PassMode::Ignore) => true,
242 (PassMode::Direct(a1), PassMode::Direct(a2)) => arg_attr_compat(a1, a2),
243 (PassMode::Pair(a1, b1), PassMode::Pair(a2, b2)) => {
244 arg_attr_compat(a1, a2) && arg_attr_compat(b1, b2)
246 (PassMode::Cast(c1, pad1), PassMode::Cast(c2, pad2)) => c1 == c2 && pad1 == pad2,
248 PassMode::Indirect { attrs: a1, extra_attrs: None, on_stack: s1 },
249 PassMode::Indirect { attrs: a2, extra_attrs: None, on_stack: s2 },
250 ) => arg_attr_compat(a1, a2) && s1 == s2,
252 PassMode::Indirect { attrs: a1, extra_attrs: Some(e1), on_stack: s1 },
253 PassMode::Indirect { attrs: a2, extra_attrs: Some(e2), on_stack: s2 },
254 ) => arg_attr_compat(a1, a2) && arg_attr_compat(e1, e2) && s1 == s2,
258 if layout_compat() && mode_compat() {
262 "check_argument_compat: incompatible ABIs:\ncaller: {:?}\ncallee: {:?}",
269 /// Initialize a single callee argument, checking the types for compatibility.
270 fn pass_argument<'x, 'y>(
272 caller_args: &mut impl Iterator<
273 Item = (&'x OpTy<'tcx, M::Provenance>, &'y ArgAbi<'tcx, Ty<'tcx>>),
275 callee_abi: &ArgAbi<'tcx, Ty<'tcx>>,
276 callee_arg: &PlaceTy<'tcx, M::Provenance>,
277 ) -> InterpResult<'tcx>
282 if matches!(callee_abi.mode, PassMode::Ignore) {
283 // This one is skipped.
286 // Find next caller arg.
287 let (caller_arg, caller_abi) = caller_args.next().ok_or_else(|| {
288 err_ub_format!("calling a function with fewer arguments than it requires")
291 if !Self::check_argument_compat(caller_abi, callee_abi) {
293 "calling a function with argument of type {:?} passing data of type {:?}",
294 callee_arg.layout.ty,
298 // Special handling for unsized parameters.
299 if caller_arg.layout.is_unsized() {
300 // `check_argument_compat` ensures that both have the same type, so we know they will use the metadata the same way.
301 assert_eq!(caller_arg.layout.ty, callee_arg.layout.ty);
302 // We have to properly pre-allocate the memory for the callee.
303 // So let's tear down some wrappers.
304 // This all has to be in memory, there are no immediate unsized values.
305 let src = caller_arg.assert_mem_place();
306 // The destination cannot be one of these "spread args".
307 let (dest_frame, dest_local) = callee_arg.assert_local();
308 // We are just initializing things, so there can't be anything here yet.
310 *self.local_to_op(&self.stack()[dest_frame], dest_local, None)?,
311 Operand::Immediate(Immediate::Uninit)
313 // Allocate enough memory to hold `src`.
314 let Some((size, align)) = self.size_and_align_of_mplace(&src)? else {
315 span_bug!(self.cur_span(), "unsized fn arg with `extern` type tail should not be allowed")
317 let ptr = self.allocate_ptr(size, align, MemoryKind::Stack)?;
319 MPlaceTy::from_aligned_ptr_with_meta(ptr.into(), callee_arg.layout, src.meta);
320 // Update the local to be that new place.
321 *M::access_local_mut(self, dest_frame, dest_local)? = Operand::Indirect(*dest_place);
323 // We allow some transmutes here.
324 // FIXME: Depending on the PassMode, this should reset some padding to uninitialized. (This
325 // is true for all `copy_op`, but there are a lot of special cases for argument passing
327 self.copy_op(&caller_arg, callee_arg, /*allow_transmute*/ true)
330 /// Call this function -- pushing the stack frame and initializing the arguments.
332 /// `caller_fn_abi` is used to determine if all the arguments are passed the proper way.
333 /// However, we also need `caller_abi` to determine if we need to do untupling of arguments.
335 /// `with_caller_location` indicates whether the caller passed a caller location. Miri
336 /// implements caller locations without argument passing, but to match `FnAbi` we need to know
337 /// when those arguments are present.
338 pub(crate) fn eval_fn_call(
340 fn_val: FnVal<'tcx, M::ExtraFnVal>,
341 (caller_abi, caller_fn_abi): (Abi, &FnAbi<'tcx, Ty<'tcx>>),
342 args: &[OpTy<'tcx, M::Provenance>],
343 with_caller_location: bool,
344 destination: &PlaceTy<'tcx, M::Provenance>,
345 target: Option<mir::BasicBlock>,
346 mut unwind: StackPopUnwind,
347 ) -> InterpResult<'tcx> {
348 trace!("eval_fn_call: {:#?}", fn_val);
350 let instance = match fn_val {
351 FnVal::Instance(instance) => instance,
352 FnVal::Other(extra) => {
353 return M::call_extra_fn(
366 ty::InstanceDef::Intrinsic(def_id) => {
367 assert!(self.tcx.is_intrinsic(def_id));
368 // caller_fn_abi is not relevant here, we interpret the arguments directly for each intrinsic.
369 M::call_intrinsic(self, instance, args, destination, target, unwind)
371 ty::InstanceDef::VTableShim(..)
372 | ty::InstanceDef::ReifyShim(..)
373 | ty::InstanceDef::ClosureOnceShim { .. }
374 | ty::InstanceDef::FnPtrShim(..)
375 | ty::InstanceDef::DropGlue(..)
376 | ty::InstanceDef::CloneShim(..)
377 | ty::InstanceDef::Item(_) => {
378 // We need MIR for this fn
379 let Some((body, instance)) =
380 M::find_mir_or_eval_fn(self, instance, caller_abi, args, destination, target, unwind)? else {
384 // Compute callee information using the `instance` returned by
385 // `find_mir_or_eval_fn`.
386 // FIXME: for variadic support, do we have to somehow determine callee's extra_args?
387 let callee_fn_abi = self.fn_abi_of_instance(instance, ty::List::empty())?;
389 if callee_fn_abi.c_variadic || caller_fn_abi.c_variadic {
390 throw_unsup_format!("calling a c-variadic function is not supported");
393 if M::enforce_abi(self) {
394 if caller_fn_abi.conv != callee_fn_abi.conv {
396 "calling a function with calling convention {:?} using calling convention {:?}",
403 if !matches!(unwind, StackPopUnwind::NotAllowed) && !callee_fn_abi.can_unwind {
404 // The callee cannot unwind.
405 unwind = StackPopUnwind::NotAllowed;
408 self.push_stack_frame(
412 StackPopCleanup::Goto { ret: target, unwind },
415 // If an error is raised here, pop the frame again to get an accurate backtrace.
416 // To this end, we wrap it all in a `try` block.
417 let res: InterpResult<'tcx> = try {
419 "caller ABI: {:?}, args: {:#?}",
422 .map(|arg| (arg.layout.ty, format!("{:?}", **arg)))
426 "spread_arg: {:?}, locals: {:#?}",
431 self.layout_of_local(self.frame(), local, None).unwrap().ty
436 // In principle, we have two iterators: Where the arguments come from, and where
439 // For where they come from: If the ABI is RustCall, we untuple the
440 // last incoming argument. These two iterators do not have the same type,
441 // so to keep the code paths uniform we accept an allocation
442 // (for RustCall ABI only).
443 let caller_args: Cow<'_, [OpTy<'tcx, M::Provenance>]> =
444 if caller_abi == Abi::RustCall && !args.is_empty() {
446 let (untuple_arg, args) = args.split_last().unwrap();
447 trace!("eval_fn_call: Will pass last argument by untupling");
450 .map(|a| Ok(a.clone()))
452 (0..untuple_arg.layout.fields.count())
453 .map(|i| self.operand_field(untuple_arg, i)),
455 .collect::<InterpResult<'_, Vec<OpTy<'tcx, M::Provenance>>>>(
462 // If `with_caller_location` is set we pretend there is an extra argument (that
463 // we will not pass).
465 caller_args.len() + if with_caller_location { 1 } else { 0 },
466 caller_fn_abi.args.len(),
467 "mismatch between caller ABI and caller arguments",
469 let mut caller_args = caller_args
471 .zip(caller_fn_abi.args.iter())
472 .filter(|arg_and_abi| !matches!(arg_and_abi.1.mode, PassMode::Ignore));
474 // Now we have to spread them out across the callee's locals,
475 // taking into account the `spread_arg`. If we could write
476 // this is a single iterator (that handles `spread_arg`), then
477 // `pass_argument` would be the loop body. It takes care to
478 // not advance `caller_iter` for ZSTs.
479 let mut callee_args_abis = callee_fn_abi.args.iter();
480 for local in body.args_iter() {
481 let dest = self.eval_place(mir::Place::from(local))?;
482 if Some(local) == body.spread_arg {
484 for i in 0..dest.layout.fields.count() {
485 let dest = self.place_field(&dest, i)?;
486 let callee_abi = callee_args_abis.next().unwrap();
487 self.pass_argument(&mut caller_args, callee_abi, &dest)?;
491 let callee_abi = callee_args_abis.next().unwrap();
492 self.pass_argument(&mut caller_args, callee_abi, &dest)?;
495 // If the callee needs a caller location, pretend we consume one more argument from the ABI.
496 if instance.def.requires_caller_location(*self.tcx) {
497 callee_args_abis.next().unwrap();
499 // Now we should have no more caller args or callee arg ABIs
501 callee_args_abis.next().is_none(),
502 "mismatch between callee ABI and callee body arguments"
504 if caller_args.next().is_some() {
505 throw_ub_format!("calling a function with more arguments than it expected")
507 // Don't forget to check the return type!
508 if !Self::check_argument_compat(&caller_fn_abi.ret, &callee_fn_abi.ret) {
510 "calling a function with return type {:?} passing \
511 return place of type {:?}",
512 callee_fn_abi.ret.layout.ty,
513 caller_fn_abi.ret.layout.ty,
519 self.stack_mut().pop();
525 // cannot use the shim here, because that will only result in infinite recursion
526 ty::InstanceDef::Virtual(def_id, idx) => {
527 let mut args = args.to_vec();
528 // We have to implement all "object safe receivers". So we have to go search for a
529 // pointer or `dyn Trait` type, but it could be wrapped in newtypes. So recursively
530 // unwrap those newtypes until we are there.
531 let mut receiver = args[0].clone();
532 let receiver_place = loop {
533 match receiver.layout.ty.kind() {
534 ty::Ref(..) | ty::RawPtr(..) => break self.deref_operand(&receiver)?,
535 ty::Dynamic(..) => break receiver.assert_mem_place(), // no immediate unsized values
537 // Not there yet, search for the only non-ZST field.
538 let mut non_zst_field = None;
539 for i in 0..receiver.layout.fields.count() {
540 let field = self.operand_field(&receiver, i)?;
542 field.layout.is_zst() && field.layout.align.abi.bytes() == 1;
545 non_zst_field.is_none(),
546 "multiple non-ZST fields in dyn receiver type {}",
549 non_zst_field = Some(field);
552 receiver = non_zst_field.unwrap_or_else(|| {
554 "no non-ZST fields in dyn receiver type {}",
561 // Obtain the underlying trait we are working on.
562 let receiver_tail = self
564 .struct_tail_erasing_lifetimes(receiver_place.layout.ty, self.param_env);
565 let ty::Dynamic(data, ..) = receiver_tail.kind() else {
566 span_bug!(self.cur_span(), "dynamic call on non-`dyn` type {}", receiver_tail)
569 // Get the required information from the vtable.
570 let vptr = receiver_place.meta.unwrap_meta().to_pointer(self)?;
571 let (dyn_ty, dyn_trait) = self.get_ptr_vtable(vptr)?;
572 if dyn_trait != data.principal() {
574 "`dyn` call on a pointer whose vtable does not match its type"
578 // Now determine the actual method to call. We can do that in two different ways and
579 // compare them to ensure everything fits.
580 let Some(ty::VtblEntry::Method(fn_inst)) = self.get_vtable_entries(vptr)?.get(idx).copied() else {
581 throw_ub_format!("`dyn` call trying to call something that is not a method")
583 if cfg!(debug_assertions) {
586 let trait_def_id = tcx.trait_of_item(def_id).unwrap();
587 let virtual_trait_ref =
588 ty::TraitRef::from_method(tcx, trait_def_id, instance.substs);
591 virtual_trait_ref.self_ty(),
592 "mismatch in underlying dyn trait computation within Miri and MIR building",
594 let existential_trait_ref =
595 ty::ExistentialTraitRef::erase_self_ty(tcx, virtual_trait_ref);
596 let concrete_trait_ref = existential_trait_ref.with_self_ty(tcx, dyn_ty);
598 let concrete_method = Instance::resolve_for_vtable(
602 instance.substs.rebase_onto(tcx, trait_def_id, concrete_trait_ref.substs),
605 assert_eq!(fn_inst, concrete_method);
608 // `*mut receiver_place.layout.ty` is almost the layout that we
609 // want for args[0]: We have to project to field 0 because we want
611 assert!(receiver_place.layout.is_unsized());
612 let receiver_ptr_ty = self.tcx.mk_mut_ptr(receiver_place.layout.ty);
613 let this_receiver_ptr = self.layout_of(receiver_ptr_ty)?.field(self, 0);
614 // Adjust receiver argument.
615 args[0] = OpTy::from(ImmTy::from_immediate(
616 Scalar::from_maybe_pointer(receiver_place.ptr, self).into(),
619 trace!("Patched receiver operand to {:#?}", args[0]);
620 // recurse with concrete function
622 FnVal::Instance(fn_inst),
623 (caller_abi, caller_fn_abi),
625 with_caller_location,
636 place: &PlaceTy<'tcx, M::Provenance>,
637 instance: ty::Instance<'tcx>,
638 target: mir::BasicBlock,
639 unwind: Option<mir::BasicBlock>,
640 ) -> InterpResult<'tcx> {
641 trace!("drop_in_place: {:?},\n {:?}, {:?}", *place, place.layout.ty, instance);
642 // We take the address of the object. This may well be unaligned, which is fine
643 // for us here. However, unaligned accesses will probably make the actual drop
644 // implementation fail -- a problem shared by rustc.
645 let place = self.force_allocation(place)?;
647 let (instance, place) = match place.layout.ty.kind() {
649 // Dropping a trait object. Need to find actual drop fn.
650 let place = self.unpack_dyn_trait(&place)?;
651 let instance = ty::Instance::resolve_drop_in_place(*self.tcx, place.layout.ty);
654 _ => (instance, place),
656 let fn_abi = self.fn_abi_of_instance(instance, ty::List::empty())?;
658 let arg = ImmTy::from_immediate(
660 self.layout_of(self.tcx.mk_mut_ptr(place.layout.ty))?,
662 let ret = MPlaceTy::fake_alloc_zst(self.layout_of(self.tcx.types.unit)?);
665 FnVal::Instance(instance),
672 Some(cleanup) => StackPopUnwind::Cleanup(cleanup),
673 None => StackPopUnwind::Skip,