src/tools/miri/src/shims/foreign_items.rs

   1 use std::{collections::hash_map::Entry, io::Write, iter};
   2
   3 use log::trace;
   4
   5 use rustc_apfloat::Float;
   6 use rustc_ast::expand::allocator::AllocatorKind;
   7 use rustc_hir::{
   8     def::DefKind,
   9     def_id::{CrateNum, DefId, LOCAL_CRATE},
  10 };
  11 use rustc_middle::middle::{
  12     codegen_fn_attrs::CodegenFnAttrFlags, dependency_format::Linkage,
  13     exported_symbols::ExportedSymbol,
  14 };
  15 use rustc_middle::mir;
  16 use rustc_middle::ty;
  17 use rustc_session::config::CrateType;
  18 use rustc_span::Symbol;
  19 use rustc_target::{
  20     abi::{Align, Size},
  21     spec::abi::Abi,
  22 };
  23
  24 use super::backtrace::EvalContextExt as _;
  25 use crate::helpers::{convert::Truncate, target_os_is_unix};
  26 use crate::*;
  27
  28 /// Returned by `emulate_foreign_item_by_name`.
  29 pub enum EmulateByNameResult<'mir, 'tcx> {
  30     /// The caller is expected to jump to the return block.
  31     NeedsJumping,
  32     /// Jumping has already been taken care of.
  33     AlreadyJumped,
  34     /// A MIR body has been found for the function.
  35     MirBody(&'mir mir::Body<'tcx>, ty::Instance<'tcx>),
  36     /// The item is not supported.
  37     NotSupported,
  38 }
  39
  40 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriInterpCx<'mir, 'tcx> {}
  41 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
  42     /// Returns the minimum alignment for the target architecture for allocations of the given size.
  43     fn min_align(&self, size: u64, kind: MiriMemoryKind) -> Align {
  44         let this = self.eval_context_ref();
  45         // List taken from `library/std/src/sys/common/alloc.rs`.
  46         // This list should be kept in sync with the one from libstd.
  47         let min_align = match this.tcx.sess.target.arch.as_ref() {
  48             "x86" | "arm" | "mips" | "powerpc" | "powerpc64" | "asmjs" | "wasm32" => 8,
  49             "x86_64" | "aarch64" | "mips64" | "s390x" | "sparc64" => 16,
  50             arch => bug!("Unsupported target architecture: {}", arch),
  51         };
  52         // Windows always aligns, even small allocations.
  53         // Source: <https://support.microsoft.com/en-us/help/286470/how-to-use-pageheap-exe-in-windows-xp-windows-2000-and-windows-server>
  54         // But jemalloc does not, so for the C heap we only align if the allocation is sufficiently big.
  55         if kind == MiriMemoryKind::WinHeap || size >= min_align {
  56             return Align::from_bytes(min_align).unwrap();
  57         }
  58         // We have `size < min_align`. Round `size` *down* to the next power of two and use that.
  59         fn prev_power_of_two(x: u64) -> u64 {
  60             let next_pow2 = x.next_power_of_two();
  61             if next_pow2 == x {
  62                 // x *is* a power of two, just use that.
  63                 x
  64             } else {
  65                 // x is between two powers, so next = 2*prev.
  66                 next_pow2 / 2
  67             }
  68         }
  69         Align::from_bytes(prev_power_of_two(size)).unwrap()
  70     }
  71
  72     fn malloc(
  73         &mut self,
  74         size: u64,
  75         zero_init: bool,
  76         kind: MiriMemoryKind,
  77     ) -> InterpResult<'tcx, Pointer<Option<Provenance>>> {
  78         let this = self.eval_context_mut();
  79         if size == 0 {
  80             Ok(Pointer::null())
  81         } else {
  82             let align = this.min_align(size, kind);
  83             let ptr = this.allocate_ptr(Size::from_bytes(size), align, kind.into())?;
  84             if zero_init {
  85                 // We just allocated this, the access is definitely in-bounds and fits into our address space.
  86                 this.write_bytes_ptr(
  87                     ptr.into(),
  88                     iter::repeat(0u8).take(usize::try_from(size).unwrap()),
  89                 )
  90                 .unwrap();
  91             }
  92             Ok(ptr.into())
  93         }
  94     }
  95
  96     fn free(
  97         &mut self,
  98         ptr: Pointer<Option<Provenance>>,
  99         kind: MiriMemoryKind,
 100     ) -> InterpResult<'tcx> {
 101         let this = self.eval_context_mut();
 102         if !this.ptr_is_null(ptr)? {
 103             this.deallocate_ptr(ptr, None, kind.into())?;
 104         }
 105         Ok(())
 106     }
 107
 108     fn realloc(
 109         &mut self,
 110         old_ptr: Pointer<Option<Provenance>>,
 111         new_size: u64,
 112         kind: MiriMemoryKind,
 113     ) -> InterpResult<'tcx, Pointer<Option<Provenance>>> {
 114         let this = self.eval_context_mut();
 115         let new_align = this.min_align(new_size, kind);
 116         if this.ptr_is_null(old_ptr)? {
 117             if new_size == 0 {
 118                 Ok(Pointer::null())
 119             } else {
 120                 let new_ptr =
 121                     this.allocate_ptr(Size::from_bytes(new_size), new_align, kind.into())?;
 122                 Ok(new_ptr.into())
 123             }
 124         } else {
 125             if new_size == 0 {
 126                 this.deallocate_ptr(old_ptr, None, kind.into())?;
 127                 Ok(Pointer::null())
 128             } else {
 129                 let new_ptr = this.reallocate_ptr(
 130                     old_ptr,
 131                     None,
 132                     Size::from_bytes(new_size),
 133                     new_align,
 134                     kind.into(),
 135                 )?;
 136                 Ok(new_ptr.into())
 137             }
 138         }
 139     }
 140
 141     /// Lookup the body of a function that has `link_name` as the symbol name.
 142     fn lookup_exported_symbol(
 143         &mut self,
 144         link_name: Symbol,
 145     ) -> InterpResult<'tcx, Option<(&'mir mir::Body<'tcx>, ty::Instance<'tcx>)>> {
 146         let this = self.eval_context_mut();
 147         let tcx = this.tcx.tcx;
 148
 149         // If the result was cached, just return it.
 150         // (Cannot use `or_insert` since the code below might have to throw an error.)
 151         let entry = this.machine.exported_symbols_cache.entry(link_name);
 152         let instance = *match entry {
 153             Entry::Occupied(e) => e.into_mut(),
 154             Entry::Vacant(e) => {
 155                 // Find it if it was not cached.
 156                 let mut instance_and_crate: Option<(ty::Instance<'_>, CrateNum)> = None;
 157                 // `dependency_formats` includes all the transitive informations needed to link a crate,
 158                 // which is what we need here since we need to dig out `exported_symbols` from all transitive
 159                 // dependencies.
 160                 let dependency_formats = tcx.dependency_formats(());
 161                 let dependency_format = dependency_formats
 162                     .iter()
 163                     .find(|(crate_type, _)| *crate_type == CrateType::Executable)
 164                     .expect("interpreting a non-executable crate");
 165                 for cnum in iter::once(LOCAL_CRATE).chain(
 166                     dependency_format.1.iter().enumerate().filter_map(|(num, &linkage)| {
 167                         // We add 1 to the number because that's what rustc also does everywhere it
 168                         // calls `CrateNum::new`...
 169                         #[allow(clippy::integer_arithmetic)]
 170                         (linkage != Linkage::NotLinked).then_some(CrateNum::new(num + 1))
 171                     }),
 172                 ) {
 173                     // We can ignore `_export_info` here: we are a Rust crate, and everything is exported
 174                     // from a Rust crate.
 175                     for &(symbol, _export_info) in tcx.exported_symbols(cnum) {
 176                         if let ExportedSymbol::NonGeneric(def_id) = symbol {
 177                             let attrs = tcx.codegen_fn_attrs(def_id);
 178                             let symbol_name = if let Some(export_name) = attrs.export_name {
 179                                 export_name
 180                             } else if attrs.flags.contains(CodegenFnAttrFlags::NO_MANGLE) {
 181                                 tcx.item_name(def_id)
 182                             } else {
 183                                 // Skip over items without an explicitly defined symbol name.
 184                                 continue;
 185                             };
 186                             if symbol_name == link_name {
 187                                 if let Some((original_instance, original_cnum)) = instance_and_crate
 188                                 {
 189                                     // Make sure we are consistent wrt what is 'first' and 'second'.
 190                                     let original_span =
 191                                         tcx.def_span(original_instance.def_id()).data();
 192                                     let span = tcx.def_span(def_id).data();
 193                                     if original_span < span {
 194                                         throw_machine_stop!(
 195                                             TerminationInfo::MultipleSymbolDefinitions {
 196                                                 link_name,
 197                                                 first: original_span,
 198                                                 first_crate: tcx.crate_name(original_cnum),
 199                                                 second: span,
 200                                                 second_crate: tcx.crate_name(cnum),
 201                                             }
 202                                         );
 203                                     } else {
 204                                         throw_machine_stop!(
 205                                             TerminationInfo::MultipleSymbolDefinitions {
 206                                                 link_name,
 207                                                 first: span,
 208                                                 first_crate: tcx.crate_name(cnum),
 209                                                 second: original_span,
 210                                                 second_crate: tcx.crate_name(original_cnum),
 211                                             }
 212                                         );
 213                                     }
 214                                 }
 215                                 if !matches!(tcx.def_kind(def_id), DefKind::Fn | DefKind::AssocFn) {
 216                                     throw_ub_format!(
 217                                         "attempt to call an exported symbol that is not defined as a function"
 218                                     );
 219                                 }
 220                                 instance_and_crate = Some((ty::Instance::mono(tcx, def_id), cnum));
 221                             }
 222                         }
 223                     }
 224                 }
 225
 226                 e.insert(instance_and_crate.map(|ic| ic.0))
 227             }
 228         };
 229         match instance {
 230             None => Ok(None), // no symbol with this name
 231             Some(instance) => Ok(Some((this.load_mir(instance.def, None)?, instance))),
 232         }
 233     }
 234
 235     /// Emulates calling a foreign item, failing if the item is not supported.
 236     /// This function will handle `goto_block` if needed.
 237     /// Returns Ok(None) if the foreign item was completely handled
 238     /// by this function.
 239     /// Returns Ok(Some(body)) if processing the foreign item
 240     /// is delegated to another function.
 241     fn emulate_foreign_item(
 242         &mut self,
 243         def_id: DefId,
 244         abi: Abi,
 245         args: &[OpTy<'tcx, Provenance>],
 246         dest: &PlaceTy<'tcx, Provenance>,
 247         ret: Option<mir::BasicBlock>,
 248         unwind: StackPopUnwind,
 249     ) -> InterpResult<'tcx, Option<(&'mir mir::Body<'tcx>, ty::Instance<'tcx>)>> {
 250         let this = self.eval_context_mut();
 251         let link_name = this.item_link_name(def_id);
 252         let tcx = this.tcx.tcx;
 253
 254         // First: functions that diverge.
 255         let ret = match ret {
 256             None =>
 257                 match link_name.as_str() {
 258                     "miri_start_panic" => {
 259                         // `check_shim` happens inside `handle_miri_start_panic`.
 260                         this.handle_miri_start_panic(abi, link_name, args, unwind)?;
 261                         return Ok(None);
 262                     }
 263                     // This matches calls to the foreign item `panic_impl`.
 264                     // The implementation is provided by the function with the `#[panic_handler]` attribute.
 265                     "panic_impl" => {
 266                         // We don't use `check_shim` here because we are just forwarding to the lang
 267                         // item. Argument count checking will be performed when the returned `Body` is
 268                         // called.
 269                         this.check_abi_and_shim_symbol_clash(abi, Abi::Rust, link_name)?;
 270                         let panic_impl_id = tcx.lang_items().panic_impl().unwrap();
 271                         let panic_impl_instance = ty::Instance::mono(tcx, panic_impl_id);
 272                         return Ok(Some((
 273                             this.load_mir(panic_impl_instance.def, None)?,
 274                             panic_impl_instance,
 275                         )));
 276                     }
 277                     #[rustfmt::skip]
 278                     | "exit"
 279                     | "ExitProcess"
 280                     => {
 281                         let exp_abi = if link_name.as_str() == "exit" {
 282                             Abi::C { unwind: false }
 283                         } else {
 284                             Abi::System { unwind: false }
 285                         };
 286                         let [code] = this.check_shim(abi, exp_abi, link_name, args)?;
 287                         // it's really u32 for ExitProcess, but we have to put it into the `Exit` variant anyway
 288                         let code = this.read_scalar(code)?.to_i32()?;
 289                         throw_machine_stop!(TerminationInfo::Exit(code.into()));
 290                     }
 291                     "abort" => {
 292                         let [] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 293                         throw_machine_stop!(TerminationInfo::Abort(
 294                             "the program aborted execution".to_owned()
 295                         ))
 296                     }
 297                     _ => {
 298                         if let Some(body) = this.lookup_exported_symbol(link_name)? {
 299                             return Ok(Some(body));
 300                         }
 301                         this.handle_unsupported(format!(
 302                             "can't call (diverging) foreign function: {}",
 303                             link_name
 304                         ))?;
 305                         return Ok(None);
 306                     }
 307                 },
 308             Some(p) => p,
 309         };
 310
 311         // Second: functions that return immediately.
 312         match this.emulate_foreign_item_by_name(link_name, abi, args, dest)? {
 313             EmulateByNameResult::NeedsJumping => {
 314                 trace!("{:?}", this.dump_place(**dest));
 315                 this.go_to_block(ret);
 316             }
 317             EmulateByNameResult::AlreadyJumped => (),
 318             EmulateByNameResult::MirBody(mir, instance) => return Ok(Some((mir, instance))),
 319             EmulateByNameResult::NotSupported => {
 320                 if let Some(body) = this.lookup_exported_symbol(link_name)? {
 321                     return Ok(Some(body));
 322                 }
 323
 324                 this.handle_unsupported(format!("can't call foreign function: {link_name}"))?;
 325                 return Ok(None);
 326             }
 327         }
 328
 329         Ok(None)
 330     }
 331
 332     /// Emulates calling the internal __rust_* allocator functions
 333     fn emulate_allocator(
 334         &mut self,
 335         symbol: Symbol,
 336         default: impl FnOnce(&mut MiriInterpCx<'mir, 'tcx>) -> InterpResult<'tcx>,
 337     ) -> InterpResult<'tcx, EmulateByNameResult<'mir, 'tcx>> {
 338         let this = self.eval_context_mut();
 339
 340         let allocator_kind = if let Some(allocator_kind) = this.tcx.allocator_kind(()) {
 341             allocator_kind
 342         } else {
 343             // in real code, this symbol does not exist without an allocator
 344             return Ok(EmulateByNameResult::NotSupported);
 345         };
 346
 347         match allocator_kind {
 348             AllocatorKind::Global => {
 349                 let (body, instance) = this
 350                     .lookup_exported_symbol(symbol)?
 351                     .expect("symbol should be present if there is a global allocator");
 352
 353                 Ok(EmulateByNameResult::MirBody(body, instance))
 354             }
 355             AllocatorKind::Default => {
 356                 default(this)?;
 357                 Ok(EmulateByNameResult::NeedsJumping)
 358             }
 359         }
 360     }
 361
 362     /// Emulates calling a foreign item using its name.
 363     fn emulate_foreign_item_by_name(
 364         &mut self,
 365         link_name: Symbol,
 366         abi: Abi,
 367         args: &[OpTy<'tcx, Provenance>],
 368         dest: &PlaceTy<'tcx, Provenance>,
 369     ) -> InterpResult<'tcx, EmulateByNameResult<'mir, 'tcx>> {
 370         let this = self.eval_context_mut();
 371
 372         // First deal with any external C functions in linked .so file.
 373         #[cfg(target_os = "linux")]
 374         if this.machine.external_so_lib.as_ref().is_some() {
 375             use crate::shims::ffi_support::EvalContextExt as _;
 376             // An Ok(false) here means that the function being called was not exported
 377             // by the specified `.so` file; we should continue and check if it corresponds to
 378             // a provided shim.
 379             if this.call_external_c_fct(link_name, dest, args)? {
 380                 return Ok(EmulateByNameResult::NeedsJumping);
 381             }
 382         }
 383
 384         // When adding a new shim, you should follow the following pattern:
 385         // ```
 386         // "shim_name" => {
 387         //     let [arg1, arg2, arg3] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 388         //     let result = this.shim_name(arg1, arg2, arg3)?;
 389         //     this.write_scalar(result, dest)?;
 390         // }
 391         // ```
 392         // and then define `shim_name` as a helper function in an extension trait in a suitable file
 393         // (see e.g. `unix/fs.rs`):
 394         // ```
 395         // fn shim_name(
 396         //     &mut self,
 397         //     arg1: &OpTy<'tcx, Provenance>,
 398         //     arg2: &OpTy<'tcx, Provenance>,
 399         //     arg3: &OpTy<'tcx, Provenance>)
 400         // -> InterpResult<'tcx, Scalar<Provenance>> {
 401         //     let this = self.eval_context_mut();
 402         //
 403         //     // First thing: load all the arguments. Details depend on the shim.
 404         //     let arg1 = this.read_scalar(arg1)?.to_u32()?;
 405         //     let arg2 = this.read_pointer(arg2)?; // when you need to work with the pointer directly
 406         //     let arg3 = this.deref_operand(arg3)?; // when you want to load/store through the pointer at its declared type
 407         //
 408         //     // ...
 409         //
 410         //     Ok(Scalar::from_u32(42))
 411         // }
 412         // ```
 413         // You might find existing shims not following this pattern, most
 414         // likely because they predate it or because for some reason they cannot be made to fit.
 415
 416         // Here we dispatch all the shims for foreign functions. If you have a platform specific
 417         // shim, add it to the corresponding submodule.
 418         match link_name.as_str() {
 419             // Miri-specific extern functions
 420             "miri_get_alloc_id" => {
 421                 let [ptr] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 422                 let ptr = this.read_pointer(ptr)?;
 423                 let (alloc_id, _, _) = this.ptr_get_alloc_id(ptr).map_err(|_e| {
 424                     err_machine_stop!(TerminationInfo::Abort(
 425                         format!("pointer passed to miri_get_alloc_id must not be dangling, got {ptr:?}")
 426                     ))
 427                 })?;
 428                 this.write_scalar(Scalar::from_u64(alloc_id.0.get()), dest)?;
 429             }
 430             "miri_print_borrow_stacks" => {
 431                 let [id] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 432                 let id = this.read_scalar(id)?.to_u64()?;
 433                 if let Some(id) = std::num::NonZeroU64::new(id) {
 434                     this.print_stacks(AllocId(id))?;
 435                 }
 436             }
 437             "miri_static_root" => {
 438                 let [ptr] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 439                 let ptr = this.read_pointer(ptr)?;
 440                 let (alloc_id, offset, _) = this.ptr_get_alloc_id(ptr)?;
 441                 if offset != Size::ZERO {
 442                     throw_unsup_format!("pointer passed to miri_static_root must point to beginning of an allocated block");
 443                 }
 444                 this.machine.static_roots.push(alloc_id);
 445             }
 446
 447             // Obtains the size of a Miri backtrace. See the README for details.
 448             "miri_backtrace_size" => {
 449                 this.handle_miri_backtrace_size(abi, link_name, args, dest)?;
 450             }
 451
 452             // Obtains a Miri backtrace. See the README for details.
 453             "miri_get_backtrace" => {
 454                 // `check_shim` happens inside `handle_miri_get_backtrace`.
 455                 this.handle_miri_get_backtrace(abi, link_name, args, dest)?;
 456             }
 457
 458             // Resolves a Miri backtrace frame. See the README for details.
 459             "miri_resolve_frame" => {
 460                 // `check_shim` happens inside `handle_miri_resolve_frame`.
 461                 this.handle_miri_resolve_frame(abi, link_name, args, dest)?;
 462             }
 463
 464             // Writes the function and file names of a Miri backtrace frame into a user provided buffer. See the README for details.
 465             "miri_resolve_frame_names" => {
 466                 this.handle_miri_resolve_frame_names(abi, link_name, args)?;
 467             }
 468
 469             // Writes some bytes to the interpreter's stdout/stderr. See the
 470             // README for details.
 471             "miri_write_to_stdout" | "miri_write_to_stderr" => {
 472                 let [bytes] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 473                 let (ptr, len) = this.read_immediate(bytes)?.to_scalar_pair();
 474                 let ptr = ptr.to_pointer(this)?;
 475                 let len = len.to_machine_usize(this)?;
 476                 let msg = this.read_bytes_ptr_strip_provenance(ptr, Size::from_bytes(len))?;
 477
 478                 // Note: we're ignoring errors writing to host stdout/stderr.
 479                 let _ignore = match link_name.as_str() {
 480                     "miri_write_to_stdout" => std::io::stdout().write_all(msg),
 481                     "miri_write_to_stderr" => std::io::stderr().write_all(msg),
 482                     _ => unreachable!(),
 483                 };
 484             }
 485
 486             // Standard C allocation
 487             "malloc" => {
 488                 let [size] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 489                 let size = this.read_scalar(size)?.to_machine_usize(this)?;
 490                 let res = this.malloc(size, /*zero_init:*/ false, MiriMemoryKind::C)?;
 491                 this.write_pointer(res, dest)?;
 492             }
 493             "calloc" => {
 494                 let [items, len] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 495                 let items = this.read_scalar(items)?.to_machine_usize(this)?;
 496                 let len = this.read_scalar(len)?.to_machine_usize(this)?;
 497                 let size =
 498                     items.checked_mul(len).ok_or_else(|| err_ub_format!("overflow during calloc size computation"))?;
 499                 let res = this.malloc(size, /*zero_init:*/ true, MiriMemoryKind::C)?;
 500                 this.write_pointer(res, dest)?;
 501             }
 502             "free" => {
 503                 let [ptr] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 504                 let ptr = this.read_pointer(ptr)?;
 505                 this.free(ptr, MiriMemoryKind::C)?;
 506             }
 507             "realloc" => {
 508                 let [old_ptr, new_size] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 509                 let old_ptr = this.read_pointer(old_ptr)?;
 510                 let new_size = this.read_scalar(new_size)?.to_machine_usize(this)?;
 511                 let res = this.realloc(old_ptr, new_size, MiriMemoryKind::C)?;
 512                 this.write_pointer(res, dest)?;
 513             }
 514
 515             // Rust allocation
 516             "__rust_alloc" | "miri_alloc" => {
 517                 let [size, align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 518                 let size = this.read_scalar(size)?.to_machine_usize(this)?;
 519                 let align = this.read_scalar(align)?.to_machine_usize(this)?;
 520
 521                 let default = |this: &mut MiriInterpCx<'mir, 'tcx>| {
 522                     Self::check_alloc_request(size, align)?;
 523
 524                     let memory_kind = match link_name.as_str() {
 525                         "__rust_alloc" => MiriMemoryKind::Rust,
 526                         "miri_alloc" => MiriMemoryKind::Miri,
 527                         _ => unreachable!(),
 528                     };
 529
 530                     let ptr = this.allocate_ptr(
 531                         Size::from_bytes(size),
 532                         Align::from_bytes(align).unwrap(),
 533                         memory_kind.into(),
 534                     )?;
 535
 536                     this.write_pointer(ptr, dest)
 537                 };
 538
 539                 match link_name.as_str() {
 540                     "__rust_alloc" => return this.emulate_allocator(Symbol::intern("__rg_alloc"), default),
 541                     "miri_alloc" => {
 542                         default(this)?;
 543                         return Ok(EmulateByNameResult::NeedsJumping);
 544                     },
 545                     _ => unreachable!(),
 546                 }
 547             }
 548             "__rust_alloc_zeroed" => {
 549                 let [size, align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 550                 let size = this.read_scalar(size)?.to_machine_usize(this)?;
 551                 let align = this.read_scalar(align)?.to_machine_usize(this)?;
 552
 553                 return this.emulate_allocator(Symbol::intern("__rg_alloc_zeroed"), |this| {
 554                     Self::check_alloc_request(size, align)?;
 555
 556                     let ptr = this.allocate_ptr(
 557                         Size::from_bytes(size),
 558                         Align::from_bytes(align).unwrap(),
 559                         MiriMemoryKind::Rust.into(),
 560                     )?;
 561
 562                     // We just allocated this, the access is definitely in-bounds.
 563                     this.write_bytes_ptr(ptr.into(), iter::repeat(0u8).take(usize::try_from(size).unwrap())).unwrap();
 564                     this.write_pointer(ptr, dest)
 565                 });
 566             }
 567             "__rust_dealloc" | "miri_dealloc" => {
 568                 let [ptr, old_size, align] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 569                 let ptr = this.read_pointer(ptr)?;
 570                 let old_size = this.read_scalar(old_size)?.to_machine_usize(this)?;
 571                 let align = this.read_scalar(align)?.to_machine_usize(this)?;
 572
 573                 let default = |this: &mut MiriInterpCx<'mir, 'tcx>| {
 574                     let memory_kind = match link_name.as_str() {
 575                         "__rust_dealloc" => MiriMemoryKind::Rust,
 576                         "miri_dealloc" => MiriMemoryKind::Miri,
 577                         _ => unreachable!(),
 578                     };
 579
 580                     // No need to check old_size/align; we anyway check that they match the allocation.
 581                     this.deallocate_ptr(
 582                         ptr,
 583                         Some((Size::from_bytes(old_size), Align::from_bytes(align).unwrap())),
 584                         memory_kind.into(),
 585                     )
 586                 };
 587
 588                 match link_name.as_str() {
 589                     "__rust_dealloc" => return this.emulate_allocator(Symbol::intern("__rg_dealloc"), default),
 590                     "miri_dealloc" => {
 591                         default(this)?;
 592                         return Ok(EmulateByNameResult::NeedsJumping);
 593                     }
 594                     _ => unreachable!(),
 595                 }
 596             }
 597             "__rust_realloc" => {
 598                 let [ptr, old_size, align, new_size] = this.check_shim(abi, Abi::Rust, link_name, args)?;
 599                 let ptr = this.read_pointer(ptr)?;
 600                 let old_size = this.read_scalar(old_size)?.to_machine_usize(this)?;
 601                 let align = this.read_scalar(align)?.to_machine_usize(this)?;
 602                 let new_size = this.read_scalar(new_size)?.to_machine_usize(this)?;
 603                 // No need to check old_size; we anyway check that they match the allocation.
 604
 605                 return this.emulate_allocator(Symbol::intern("__rg_realloc"), |this| {
 606                     Self::check_alloc_request(new_size, align)?;
 607
 608                     let align = Align::from_bytes(align).unwrap();
 609                     let new_ptr = this.reallocate_ptr(
 610                         ptr,
 611                         Some((Size::from_bytes(old_size), align)),
 612                         Size::from_bytes(new_size),
 613                         align,
 614                         MiriMemoryKind::Rust.into(),
 615                     )?;
 616                     this.write_pointer(new_ptr, dest)
 617                 });
 618             }
 619
 620             // C memory handling functions
 621             "memcmp" => {
 622                 let [left, right, n] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 623                 let left = this.read_pointer(left)?;
 624                 let right = this.read_pointer(right)?;
 625                 let n = Size::from_bytes(this.read_scalar(n)?.to_machine_usize(this)?);
 626
 627                 let result = {
 628                     let left_bytes = this.read_bytes_ptr_strip_provenance(left, n)?;
 629                     let right_bytes = this.read_bytes_ptr_strip_provenance(right, n)?;
 630
 631                     use std::cmp::Ordering::*;
 632                     match left_bytes.cmp(right_bytes) {
 633                         Less => -1i32,
 634                         Equal => 0,
 635                         Greater => 1,
 636                     }
 637                 };
 638
 639                 this.write_scalar(Scalar::from_i32(result), dest)?;
 640             }
 641             "memrchr" => {
 642                 let [ptr, val, num] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 643                 let ptr = this.read_pointer(ptr)?;
 644                 let val = this.read_scalar(val)?.to_i32()?;
 645                 let num = this.read_scalar(num)?.to_machine_usize(this)?;
 646                 // The docs say val is "interpreted as unsigned char".
 647                 #[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
 648                 let val = val as u8;
 649
 650                 if let Some(idx) = this
 651                     .read_bytes_ptr_strip_provenance(ptr, Size::from_bytes(num))?
 652                     .iter()
 653                     .rev()
 654                     .position(|&c| c == val)
 655                 {
 656                     let idx = u64::try_from(idx).unwrap();
 657                     #[allow(clippy::integer_arithmetic)] // idx < num, so this never wraps
 658                     let new_ptr = ptr.offset(Size::from_bytes(num - idx - 1), this)?;
 659                     this.write_pointer(new_ptr, dest)?;
 660                 } else {
 661                     this.write_null(dest)?;
 662                 }
 663             }
 664             "memchr" => {
 665                 let [ptr, val, num] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 666                 let ptr = this.read_pointer(ptr)?;
 667                 let val = this.read_scalar(val)?.to_i32()?;
 668                 let num = this.read_scalar(num)?.to_machine_usize(this)?;
 669                 // The docs say val is "interpreted as unsigned char".
 670                 #[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
 671                 let val = val as u8;
 672
 673                 let idx = this
 674                     .read_bytes_ptr_strip_provenance(ptr, Size::from_bytes(num))?
 675                     .iter()
 676                     .position(|&c| c == val);
 677                 if let Some(idx) = idx {
 678                     let new_ptr = ptr.offset(Size::from_bytes(idx as u64), this)?;
 679                     this.write_pointer(new_ptr, dest)?;
 680                 } else {
 681                     this.write_null(dest)?;
 682                 }
 683             }
 684             "strlen" => {
 685                 let [ptr] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 686                 let ptr = this.read_pointer(ptr)?;
 687                 let n = this.read_c_str(ptr)?.len();
 688                 this.write_scalar(Scalar::from_machine_usize(u64::try_from(n).unwrap(), this), dest)?;
 689             }
 690
 691             // math functions (note that there are also intrinsics for some other functions)
 692             #[rustfmt::skip]
 693             | "cbrtf"
 694             | "coshf"
 695             | "sinhf"
 696             | "tanf"
 697             | "tanhf"
 698             | "acosf"
 699             | "asinf"
 700             | "atanf"
 701             | "log1pf"
 702             | "expm1f"
 703             => {
 704                 let [f] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 705                 // FIXME: Using host floats.
 706                 let f = f32::from_bits(this.read_scalar(f)?.to_u32()?);
 707                 let res = match link_name.as_str() {
 708                     "cbrtf" => f.cbrt(),
 709                     "coshf" => f.cosh(),
 710                     "sinhf" => f.sinh(),
 711                     "tanf" => f.tan(),
 712                     "tanhf" => f.tanh(),
 713                     "acosf" => f.acos(),
 714                     "asinf" => f.asin(),
 715                     "atanf" => f.atan(),
 716                     "log1pf" => f.ln_1p(),
 717                     "expm1f" => f.exp_m1(),
 718                     _ => bug!(),
 719                 };
 720                 this.write_scalar(Scalar::from_u32(res.to_bits()), dest)?;
 721             }
 722             #[rustfmt::skip]
 723             | "_hypotf"
 724             | "hypotf"
 725             | "atan2f"
 726             | "fdimf"
 727             => {
 728                 let [f1, f2] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 729                 // underscore case for windows, here and below
 730                 // (see https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/floating-point-primitives?view=vs-2019)
 731                 // FIXME: Using host floats.
 732                 let f1 = f32::from_bits(this.read_scalar(f1)?.to_u32()?);
 733                 let f2 = f32::from_bits(this.read_scalar(f2)?.to_u32()?);
 734                 let res = match link_name.as_str() {
 735                     "_hypotf" | "hypotf" => f1.hypot(f2),
 736                     "atan2f" => f1.atan2(f2),
 737                     #[allow(deprecated)]
 738                     "fdimf" => f1.abs_sub(f2),
 739                     _ => bug!(),
 740                 };
 741                 this.write_scalar(Scalar::from_u32(res.to_bits()), dest)?;
 742             }
 743             #[rustfmt::skip]
 744             | "cbrt"
 745             | "cosh"
 746             | "sinh"
 747             | "tan"
 748             | "tanh"
 749             | "acos"
 750             | "asin"
 751             | "atan"
 752             | "log1p"
 753             | "expm1"
 754             => {
 755                 let [f] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 756                 // FIXME: Using host floats.
 757                 let f = f64::from_bits(this.read_scalar(f)?.to_u64()?);
 758                 let res = match link_name.as_str() {
 759                     "cbrt" => f.cbrt(),
 760                     "cosh" => f.cosh(),
 761                     "sinh" => f.sinh(),
 762                     "tan" => f.tan(),
 763                     "tanh" => f.tanh(),
 764                     "acos" => f.acos(),
 765                     "asin" => f.asin(),
 766                     "atan" => f.atan(),
 767                     "log1p" => f.ln_1p(),
 768                     "expm1" => f.exp_m1(),
 769                     _ => bug!(),
 770                 };
 771                 this.write_scalar(Scalar::from_u64(res.to_bits()), dest)?;
 772             }
 773             #[rustfmt::skip]
 774             | "_hypot"
 775             | "hypot"
 776             | "atan2"
 777             | "fdim"
 778             => {
 779                 let [f1, f2] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 780                 // FIXME: Using host floats.
 781                 let f1 = f64::from_bits(this.read_scalar(f1)?.to_u64()?);
 782                 let f2 = f64::from_bits(this.read_scalar(f2)?.to_u64()?);
 783                 let res = match link_name.as_str() {
 784                     "_hypot" | "hypot" => f1.hypot(f2),
 785                     "atan2" => f1.atan2(f2),
 786                     #[allow(deprecated)]
 787                     "fdim" => f1.abs_sub(f2),
 788                     _ => bug!(),
 789                 };
 790                 this.write_scalar(Scalar::from_u64(res.to_bits()), dest)?;
 791             }
 792             #[rustfmt::skip]
 793             | "_ldexp"
 794             | "ldexp"
 795             | "scalbn"
 796             => {
 797                 let [x, exp] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 798                 // For radix-2 (binary) systems, `ldexp` and `scalbn` are the same.
 799                 let x = this.read_scalar(x)?.to_f64()?;
 800                 let exp = this.read_scalar(exp)?.to_i32()?;
 801
 802                 // Saturating cast to i16. Even those are outside the valid exponent range so
 803                 // `scalbn` below will do its over/underflow handling.
 804                 let exp = if exp > i32::from(i16::MAX) {
 805                     i16::MAX
 806                 } else if exp < i32::from(i16::MIN) {
 807                     i16::MIN
 808                 } else {
 809                     exp.try_into().unwrap()
 810                 };
 811
 812                 let res = x.scalbn(exp);
 813                 this.write_scalar(Scalar::from_f64(res), dest)?;
 814             }
 815
 816             // Architecture-specific shims
 817             "llvm.x86.addcarry.64" if this.tcx.sess.target.arch == "x86_64" => {
 818                 // Computes u8+u64+u64, returning tuple (u8,u64) comprising the output carry and truncated sum.
 819                 let [c_in, a, b] = this.check_shim(abi, Abi::Unadjusted, link_name, args)?;
 820                 let c_in = this.read_scalar(c_in)?.to_u8()?;
 821                 let a = this.read_scalar(a)?.to_u64()?;
 822                 let b = this.read_scalar(b)?.to_u64()?;
 823
 824                 #[allow(clippy::integer_arithmetic)] // adding two u64 and a u8 cannot wrap in a u128
 825                 let wide_sum = u128::from(c_in) + u128::from(a) + u128::from(b);
 826                 #[allow(clippy::integer_arithmetic)] // it's a u128, we can shift by 64
 827                 let (c_out, sum) = ((wide_sum >> 64).truncate::<u8>(), wide_sum.truncate::<u64>());
 828
 829                 let c_out_field = this.place_field(dest, 0)?;
 830                 this.write_scalar(Scalar::from_u8(c_out), &c_out_field)?;
 831                 let sum_field = this.place_field(dest, 1)?;
 832                 this.write_scalar(Scalar::from_u64(sum), &sum_field)?;
 833             }
 834             "llvm.x86.sse2.pause" if this.tcx.sess.target.arch == "x86" || this.tcx.sess.target.arch == "x86_64" => {
 835                 let [] = this.check_shim(abi, Abi::C { unwind: false }, link_name, args)?;
 836                 this.yield_active_thread();
 837             }
 838             "llvm.aarch64.isb" if this.tcx.sess.target.arch == "aarch64" => {
 839                 let [arg] = this.check_shim(abi, Abi::Unadjusted, link_name, args)?;
 840                 let arg = this.read_scalar(arg)?.to_i32()?;
 841                 match arg {
 842                     15 => { // SY ("full system scope")
 843                         this.yield_active_thread();
 844                     }
 845                     _ => {
 846                         throw_unsup_format!("unsupported llvm.aarch64.isb argument {}", arg);
 847                     }
 848                 }
 849             }
 850
 851             // Platform-specific shims
 852             _ => match this.tcx.sess.target.os.as_ref() {
 853                 target if target_os_is_unix(target) => return shims::unix::foreign_items::EvalContextExt::emulate_foreign_item_by_name(this, link_name, abi, args, dest),
 854                 "windows" => return shims::windows::foreign_items::EvalContextExt::emulate_foreign_item_by_name(this, link_name, abi, args, dest),
 855                 target => throw_unsup_format!("the target `{}` is not supported", target),
 856             }
 857         };
 858         // We only fall through to here if we did *not* hit the `_` arm above,
 859         // i.e., if we actually emulated the function with one of the shims.
 860         Ok(EmulateByNameResult::NeedsJumping)
 861     }
 862
 863     /// Check some basic requirements for this allocation request:
 864     /// non-zero size, power-of-two alignment.
 865     fn check_alloc_request(size: u64, align: u64) -> InterpResult<'tcx> {
 866         if size == 0 {
 867             throw_ub_format!("creating allocation with size 0");
 868         }
 869         if !align.is_power_of_two() {
 870             throw_ub_format!("creating allocation with non-power-of-two alignment {}", align);
 871         }
 872         Ok(())
 873     }
 874 }