2 convert::{TryFrom, TryInto},
8 use rustc_apfloat::Float;
11 def_id::{CrateNum, DefId, LOCAL_CRATE},
13 use rustc_middle::middle::{
14 codegen_fn_attrs::CodegenFnAttrFlags, dependency_format::Linkage,
15 exported_symbols::ExportedSymbol,
17 use rustc_middle::mir;
19 use rustc_session::config::CrateType;
20 use rustc_span::{symbol::sym, Symbol};
26 use super::backtrace::EvalContextExt as _;
29 /// Returned by `emulate_foreign_item_by_name`.
30 pub enum EmulateByNameResult {
31 /// The caller is expected to jump to the return block.
33 /// Jumping has already been taken care of.
35 /// The item is not supported.
39 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
40 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
41 /// Returns the minimum alignment for the target architecture for allocations of the given size.
42 fn min_align(&self, size: u64, kind: MiriMemoryKind) -> Align {
43 let this = self.eval_context_ref();
44 // List taken from `libstd/sys_common/alloc.rs`.
45 let min_align = match this.tcx.sess.target.arch.as_str() {
46 "x86" | "arm" | "mips" | "powerpc" | "powerpc64" | "asmjs" | "wasm32" => 8,
47 "x86_64" | "aarch64" | "mips64" | "s390x" | "sparc64" => 16,
48 arch => bug!("Unsupported target architecture: {}", arch),
50 // Windows always aligns, even small allocations.
51 // Source: <https://support.microsoft.com/en-us/help/286470/how-to-use-pageheap-exe-in-windows-xp-windows-2000-and-windows-server>
52 // But jemalloc does not, so for the C heap we only align if the allocation is sufficiently big.
53 if kind == MiriMemoryKind::WinHeap || size >= min_align {
54 return Align::from_bytes(min_align).unwrap();
56 // We have `size < min_align`. Round `size` *down* to the next power of two and use that.
57 fn prev_power_of_two(x: u64) -> u64 {
58 let next_pow2 = x.next_power_of_two();
60 // x *is* a power of two, just use that.
63 // x is between two powers, so next = 2*prev.
67 Align::from_bytes(prev_power_of_two(size)).unwrap()
75 ) -> InterpResult<'tcx, Scalar<Tag>> {
76 let this = self.eval_context_mut();
78 Ok(Scalar::null_ptr(this))
80 let align = this.min_align(size, kind);
81 let ptr = this.memory.allocate(Size::from_bytes(size), align, kind.into())?;
83 // We just allocated this, the access is definitely in-bounds.
84 this.memory.write_bytes(ptr.into(), iter::repeat(0u8).take(size as usize)).unwrap();
90 fn free(&mut self, ptr: Scalar<Tag>, kind: MiriMemoryKind) -> InterpResult<'tcx> {
91 let this = self.eval_context_mut();
92 if !this.is_null(ptr)? {
93 let ptr = this.force_ptr(ptr)?;
94 this.memory.deallocate(ptr, None, kind.into())?;
101 old_ptr: Scalar<Tag>,
103 kind: MiriMemoryKind,
104 ) -> InterpResult<'tcx, Scalar<Tag>> {
105 let this = self.eval_context_mut();
106 let new_align = this.min_align(new_size, kind);
107 if this.is_null(old_ptr)? {
109 Ok(Scalar::null_ptr(this))
112 this.memory.allocate(Size::from_bytes(new_size), new_align, kind.into())?;
113 Ok(Scalar::Ptr(new_ptr))
116 let old_ptr = this.force_ptr(old_ptr)?;
118 this.memory.deallocate(old_ptr, None, kind.into())?;
119 Ok(Scalar::null_ptr(this))
121 let new_ptr = this.memory.reallocate(
124 Size::from_bytes(new_size),
128 Ok(Scalar::Ptr(new_ptr))
133 /// Lookup the body of a function that has `link_name` as the symbol name.
134 fn lookup_exported_symbol(
137 ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
138 let this = self.eval_context_mut();
139 let tcx = this.tcx.tcx;
141 // If the result was cached, just return it.
142 if let Some(instance) = this.machine.exported_symbols_cache.get(&link_name) {
143 return instance.map(|instance| this.load_mir(instance.def, None)).transpose();
146 // Find it if it was not cached.
147 let mut instance_and_crate: Option<(ty::Instance<'_>, CrateNum)> = None;
148 // `dependency_formats` includes all the transitive informations needed to link a crate,
149 // which is what we need here since we need to dig out `exported_symbols` from all transitive
151 let dependency_formats = tcx.dependency_formats(());
152 let dependency_format = dependency_formats
154 .find(|(crate_type, _)| *crate_type == CrateType::Executable)
155 .expect("interpreting a non-executable crate");
157 iter::once(LOCAL_CRATE).chain(dependency_format.1.iter().enumerate().filter_map(
158 |(num, &linkage)| (linkage != Linkage::NotLinked).then_some(CrateNum::new(num + 1)),
161 // We can ignore `_export_level` here: we are a Rust crate, and everything is exported
162 // from a Rust crate.
163 for &(symbol, _export_level) in tcx.exported_symbols(cnum) {
164 if let ExportedSymbol::NonGeneric(def_id) = symbol {
165 let attrs = tcx.codegen_fn_attrs(def_id);
166 let symbol_name = if let Some(export_name) = attrs.export_name {
168 } else if attrs.flags.contains(CodegenFnAttrFlags::NO_MANGLE) {
169 tcx.item_name(def_id)
171 // Skip over items without an explicitly defined symbol name.
174 if symbol_name == link_name {
175 if let Some((instance, original_cnum)) = instance_and_crate {
176 throw_machine_stop!(TerminationInfo::MultipleSymbolDefinitions {
178 first: tcx.def_span(instance.def_id()).data(),
179 first_crate: tcx.crate_name(original_cnum),
180 second: tcx.def_span(def_id).data(),
181 second_crate: tcx.crate_name(cnum),
184 if !matches!(tcx.def_kind(def_id), DefKind::Fn | DefKind::AssocFn) {
186 "attempt to call an exported symbol that is not defined as a function"
189 instance_and_crate = Some((ty::Instance::mono(tcx, def_id), cnum));
195 let instance = instance_and_crate.map(|ic| ic.0);
196 // Cache it and load its MIR, if found.
197 this.machine.exported_symbols_cache.try_insert(link_name, instance).unwrap();
198 instance.map(|instance| this.load_mir(instance.def, None)).transpose()
201 /// Emulates calling a foreign item, failing if the item is not supported.
202 /// This function will handle `goto_block` if needed.
203 /// Returns Ok(None) if the foreign item was completely handled
204 /// by this function.
205 /// Returns Ok(Some(body)) if processing the foreign item
206 /// is delegated to another function.
207 fn emulate_foreign_item(
211 args: &[OpTy<'tcx, Tag>],
212 ret: Option<(&PlaceTy<'tcx, Tag>, mir::BasicBlock)>,
213 unwind: StackPopUnwind,
214 ) -> InterpResult<'tcx, Option<&'mir mir::Body<'tcx>>> {
215 let this = self.eval_context_mut();
216 let attrs = this.tcx.get_attrs(def_id);
220 .first_attr_value_str_by_name(&attrs, sym::link_name)
221 .unwrap_or_else(|| this.tcx.item_name(def_id));
222 let tcx = this.tcx.tcx;
224 // First: functions that diverge.
225 let (dest, ret) = match ret {
226 None => match &*link_name.as_str() {
227 "miri_start_panic" => {
228 // `check_shim` happens inside `handle_miri_start_panic`.
229 this.handle_miri_start_panic(abi, link_name, args, unwind)?;
232 // This matches calls to the foreign item `panic_impl`.
233 // The implementation is provided by the function with the `#[panic_handler]` attribute.
235 // We don't use `check_shim` here because we are just forwarding to the lang
236 // item. Argument count checking will be performed when the returned `Body` is
238 this.check_abi_and_shim_symbol_clash(abi, Abi::Rust, link_name)?;
239 let panic_impl_id = tcx.lang_items().panic_impl().unwrap();
240 let panic_impl_instance = ty::Instance::mono(tcx, panic_impl_id);
241 return Ok(Some(&*this.load_mir(panic_impl_instance.def, None)?));
247 let exp_abi = if link_name.as_str() == "exit" {
248 Abi::C { unwind: false }
250 Abi::System { unwind: false }
252 let &[ref code] = this.check_shim(abi, exp_abi, link_name, args)?;
253 // it's really u32 for ExitProcess, but we have to put it into the `Exit` variant anyway
254 let code = this.read_scalar(code)?.to_i32()?;
255 throw_machine_stop!(TerminationInfo::Exit(code.into()));
258 let &[] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
259 throw_machine_stop!(TerminationInfo::Abort(
260 "the program aborted execution".to_owned()
264 if let Some(body) = this.lookup_exported_symbol(link_name)? {
265 return Ok(Some(body));
267 this.handle_unsupported(format!(
268 "can't call (diverging) foreign function: {}",
277 // Second: functions that return.
278 match this.emulate_foreign_item_by_name(link_name, abi, args, dest, ret)? {
279 EmulateByNameResult::NeedsJumping => {
280 trace!("{:?}", this.dump_place(**dest));
281 this.go_to_block(ret);
283 EmulateByNameResult::AlreadyJumped => (),
284 EmulateByNameResult::NotSupported => {
285 if let Some(body) = this.lookup_exported_symbol(link_name)? {
286 return Ok(Some(body));
289 this.handle_unsupported(format!("can't call foreign function: {}", link_name))?;
297 /// Emulates calling a foreign item using its name.
298 fn emulate_foreign_item_by_name(
302 args: &[OpTy<'tcx, Tag>],
303 dest: &PlaceTy<'tcx, Tag>,
304 ret: mir::BasicBlock,
305 ) -> InterpResult<'tcx, EmulateByNameResult> {
306 let this = self.eval_context_mut();
308 // Here we dispatch all the shims for foreign functions. If you have a platform specific
309 // shim, add it to the corresponding submodule.
310 match &*link_name.as_str() {
311 // Miri-specific extern functions
312 "miri_static_root" => {
313 let &[ref ptr] = this.check_shim(abi, Abi::Rust, link_name, args)?;
314 let ptr = this.read_scalar(ptr)?.check_init()?;
315 let ptr = this.force_ptr(ptr)?;
316 if ptr.offset != Size::ZERO {
317 throw_unsup_format!("pointer passed to miri_static_root must point to beginning of an allocated block");
319 this.machine.static_roots.push(ptr.alloc_id);
322 // Obtains a Miri backtrace. See the README for details.
323 "miri_get_backtrace" => {
324 // `check_shim` happens inside `handle_miri_get_backtrace`.
325 this.handle_miri_get_backtrace(abi, link_name, args, dest)?;
328 // Resolves a Miri backtrace frame. See the README for details.
329 "miri_resolve_frame" => {
330 // `check_shim` happens inside `handle_miri_resolve_frame`.
331 this.handle_miri_resolve_frame(abi, link_name, args, dest)?;
335 // Standard C allocation
337 let &[ref size] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
338 let size = this.read_scalar(size)?.to_machine_usize(this)?;
339 let res = this.malloc(size, /*zero_init:*/ false, MiriMemoryKind::C)?;
340 this.write_scalar(res, dest)?;
343 let &[ref items, ref len] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
344 let items = this.read_scalar(items)?.to_machine_usize(this)?;
345 let len = this.read_scalar(len)?.to_machine_usize(this)?;
347 items.checked_mul(len).ok_or_else(|| err_ub_format!("overflow during calloc size computation"))?;
348 let res = this.malloc(size, /*zero_init:*/ true, MiriMemoryKind::C)?;
349 this.write_scalar(res, dest)?;
352 let &[ref ptr] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
353 let ptr = this.read_scalar(ptr)?.check_init()?;
354 this.free(ptr, MiriMemoryKind::C)?;
357 let &[ref old_ptr, ref new_size] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
358 let old_ptr = this.read_scalar(old_ptr)?.check_init()?;
359 let new_size = this.read_scalar(new_size)?.to_machine_usize(this)?;
360 let res = this.realloc(old_ptr, new_size, MiriMemoryKind::C)?;
361 this.write_scalar(res, dest)?;
365 // (Usually these would be forwarded to to `#[global_allocator]`; we instead implement a generic
366 // allocation that also checks that all conditions are met, such as not permitting zero-sized allocations.)
368 let &[ref size, ref align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
369 let size = this.read_scalar(size)?.to_machine_usize(this)?;
370 let align = this.read_scalar(align)?.to_machine_usize(this)?;
371 Self::check_alloc_request(size, align)?;
372 let ptr = this.memory.allocate(
373 Size::from_bytes(size),
374 Align::from_bytes(align).unwrap(),
375 MiriMemoryKind::Rust.into(),
377 this.write_scalar(ptr, dest)?;
379 "__rust_alloc_zeroed" => {
380 let &[ref size, ref align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
381 let size = this.read_scalar(size)?.to_machine_usize(this)?;
382 let align = this.read_scalar(align)?.to_machine_usize(this)?;
383 Self::check_alloc_request(size, align)?;
384 let ptr = this.memory.allocate(
385 Size::from_bytes(size),
386 Align::from_bytes(align).unwrap(),
387 MiriMemoryKind::Rust.into(),
389 // We just allocated this, the access is definitely in-bounds.
390 this.memory.write_bytes(ptr.into(), iter::repeat(0u8).take(usize::try_from(size).unwrap())).unwrap();
391 this.write_scalar(ptr, dest)?;
393 "__rust_dealloc" => {
394 let &[ref ptr, ref old_size, ref align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
395 let ptr = this.read_scalar(ptr)?.check_init()?;
396 let old_size = this.read_scalar(old_size)?.to_machine_usize(this)?;
397 let align = this.read_scalar(align)?.to_machine_usize(this)?;
398 // No need to check old_size/align; we anyway check that they match the allocation.
399 let ptr = this.force_ptr(ptr)?;
400 this.memory.deallocate(
402 Some((Size::from_bytes(old_size), Align::from_bytes(align).unwrap())),
403 MiriMemoryKind::Rust.into(),
406 "__rust_realloc" => {
407 let &[ref ptr, ref old_size, ref align, ref new_size] = this.check_shim(abi, Abi::Rust, link_name, args)?;
408 let ptr = this.force_ptr(this.read_scalar(ptr)?.check_init()?)?;
409 let old_size = this.read_scalar(old_size)?.to_machine_usize(this)?;
410 let align = this.read_scalar(align)?.to_machine_usize(this)?;
411 let new_size = this.read_scalar(new_size)?.to_machine_usize(this)?;
412 Self::check_alloc_request(new_size, align)?;
413 // No need to check old_size; we anyway check that they match the allocation.
414 let align = Align::from_bytes(align).unwrap();
415 let new_ptr = this.memory.reallocate(
417 Some((Size::from_bytes(old_size), align)),
418 Size::from_bytes(new_size),
420 MiriMemoryKind::Rust.into(),
422 this.write_scalar(new_ptr, dest)?;
425 // C memory handling functions
427 let &[ref left, ref right, ref n] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
428 let left = this.read_scalar(left)?.check_init()?;
429 let right = this.read_scalar(right)?.check_init()?;
430 let n = Size::from_bytes(this.read_scalar(n)?.to_machine_usize(this)?);
433 let left_bytes = this.memory.read_bytes(left, n)?;
434 let right_bytes = this.memory.read_bytes(right, n)?;
436 use std::cmp::Ordering::*;
437 match left_bytes.cmp(right_bytes) {
444 this.write_scalar(Scalar::from_i32(result), dest)?;
447 let &[ref ptr, ref val, ref num] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
448 let ptr = this.read_scalar(ptr)?.check_init()?;
449 let val = this.read_scalar(val)?.to_i32()? as u8;
450 let num = this.read_scalar(num)?.to_machine_usize(this)?;
451 if let Some(idx) = this
453 .read_bytes(ptr, Size::from_bytes(num))?
456 .position(|&c| c == val)
458 let new_ptr = ptr.ptr_offset(Size::from_bytes(num - idx as u64 - 1), this)?;
459 this.write_scalar(new_ptr, dest)?;
461 this.write_null(dest)?;
465 let &[ref ptr, ref val, ref num] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
466 let ptr = this.read_scalar(ptr)?.check_init()?;
467 let val = this.read_scalar(val)?.to_i32()? as u8;
468 let num = this.read_scalar(num)?.to_machine_usize(this)?;
471 .read_bytes(ptr, Size::from_bytes(num))?
473 .position(|&c| c == val);
474 if let Some(idx) = idx {
475 let new_ptr = ptr.ptr_offset(Size::from_bytes(idx as u64), this)?;
476 this.write_scalar(new_ptr, dest)?;
478 this.write_null(dest)?;
482 let &[ref ptr] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
483 let ptr = this.read_scalar(ptr)?.check_init()?;
484 let n = this.read_c_str(ptr)?.len();
485 this.write_scalar(Scalar::from_machine_usize(u64::try_from(n).unwrap(), this), dest)?;
498 let &[ref f] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
499 // FIXME: Using host floats.
500 let f = f32::from_bits(this.read_scalar(f)?.to_u32()?);
501 let f = match &*link_name.as_str() {
511 this.write_scalar(Scalar::from_u32(f.to_bits()), dest)?;
518 let &[ref f1, ref f2] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
519 // underscore case for windows, here and below
520 // (see https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/floating-point-primitives?view=vs-2019)
521 // FIXME: Using host floats.
522 let f1 = f32::from_bits(this.read_scalar(f1)?.to_u32()?);
523 let f2 = f32::from_bits(this.read_scalar(f2)?.to_u32()?);
524 let n = match &*link_name.as_str() {
525 "_hypotf" | "hypotf" => f1.hypot(f2),
526 "atan2f" => f1.atan2(f2),
529 this.write_scalar(Scalar::from_u32(n.to_bits()), dest)?;
540 let &[ref f] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
541 // FIXME: Using host floats.
542 let f = f64::from_bits(this.read_scalar(f)?.to_u64()?);
543 let f = match &*link_name.as_str() {
553 this.write_scalar(Scalar::from_u64(f.to_bits()), dest)?;
560 let &[ref f1, ref f2] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
561 // FIXME: Using host floats.
562 let f1 = f64::from_bits(this.read_scalar(f1)?.to_u64()?);
563 let f2 = f64::from_bits(this.read_scalar(f2)?.to_u64()?);
564 let n = match &*link_name.as_str() {
565 "_hypot" | "hypot" => f1.hypot(f2),
566 "atan2" => f1.atan2(f2),
569 this.write_scalar(Scalar::from_u64(n.to_bits()), dest)?;
576 let &[ref x, ref exp] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
577 // For radix-2 (binary) systems, `ldexp` and `scalbn` are the same.
578 let x = this.read_scalar(x)?.to_f64()?;
579 let exp = this.read_scalar(exp)?.to_i32()?;
581 // Saturating cast to i16. Even those are outside the valid exponent range to
582 // `scalbn` below will do its over/underflow handling.
583 let exp = if exp > i32::from(i16::MAX) {
585 } else if exp < i32::from(i16::MIN) {
588 exp.try_into().unwrap()
591 let res = x.scalbn(exp);
592 this.write_scalar(Scalar::from_f64(res), dest)?;
595 // Architecture-specific shims
596 "llvm.x86.sse2.pause" if this.tcx.sess.target.arch == "x86" || this.tcx.sess.target.arch == "x86_64" => {
597 let &[] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
598 this.yield_active_thread();
600 "llvm.aarch64.isb" if this.tcx.sess.target.arch == "aarch64" => {
601 let &[ref arg] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
602 let arg = this.read_scalar(arg)?.to_i32()?;
604 15 => { // SY ("full system scope")
605 this.yield_active_thread();
608 throw_unsup_format!("unsupported llvm.aarch64.isb argument {}", arg);
613 // Platform-specific shims
614 _ => match this.tcx.sess.target.os.as_str() {
615 "linux" | "macos" => return shims::posix::foreign_items::EvalContextExt::emulate_foreign_item_by_name(this, link_name, abi, args, dest, ret),
616 "windows" => return shims::windows::foreign_items::EvalContextExt::emulate_foreign_item_by_name(this, link_name, abi, args, dest, ret),
617 target => throw_unsup_format!("the target `{}` is not supported", target),
621 // We only fall through to here if we did *not* hit the `_` arm above,
622 // i.e., if we actually emulated the function.
623 Ok(EmulateByNameResult::NeedsJumping)
626 /// Check some basic requirements for this allocation request:
627 /// non-zero size, power-of-two alignment.
628 fn check_alloc_request(size: u64, align: u64) -> InterpResult<'tcx> {
630 throw_ub_format!("creating allocation with size 0");
632 if !align.is_power_of_two() {
633 throw_ub_format!("creating allocation with non-power-of-two alignment {}", align);