src/shims/foreign_items.rs

   1 use std::convert::TryInto;
   2
   3 use rustc::hir::def_id::DefId;
   4 use rustc::mir;
   5 use rustc::ty::layout::{Align, LayoutOf, Size};
   6 use rustc_apfloat::Float;
   7 use syntax::attr;
   8 use syntax::symbol::sym;
   9
  10 use crate::*;
  11
  12 impl<'mir, 'tcx> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
  13 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
  14     /// Returns the minimum alignment for the target architecture for allocations of the given size.
  15     fn min_align(&self, size: u64, kind: MiriMemoryKind) -> Align {
  16         let this = self.eval_context_ref();
  17         // List taken from `libstd/sys_common/alloc.rs`.
  18         let min_align = match this.tcx.tcx.sess.target.target.arch.as_str() {
  19             "x86" | "arm" | "mips" | "powerpc" | "powerpc64" | "asmjs" | "wasm32" => 8,
  20             "x86_64" | "aarch64" | "mips64" | "s390x" | "sparc64" => 16,
  21             arch => bug!("Unsupported target architecture: {}", arch),
  22         };
  23         // Windows always aligns, even small allocations.
  24         // Source: <https://support.microsoft.com/en-us/help/286470/how-to-use-pageheap-exe-in-windows-xp-windows-2000-and-windows-server>
  25         // But jemalloc does not, so for the C heap we only align if the allocation is sufficiently big.
  26         if kind == MiriMemoryKind::WinHeap || size >= min_align {
  27             return Align::from_bytes(min_align).unwrap();
  28         }
  29         // We have `size < min_align`. Round `size` *down* to the next power of two and use that.
  30         fn prev_power_of_two(x: u64) -> u64 {
  31             let next_pow2 = x.next_power_of_two();
  32             if next_pow2 == x {
  33                 // x *is* a power of two, just use that.
  34                 x
  35             } else {
  36                 // x is between two powers, so next = 2*prev.
  37                 next_pow2 / 2
  38             }
  39         }
  40         Align::from_bytes(prev_power_of_two(size)).unwrap()
  41     }
  42
  43     fn malloc(&mut self, size: u64, zero_init: bool, kind: MiriMemoryKind) -> Scalar<Tag> {
  44         let this = self.eval_context_mut();
  45         if size == 0 {
  46             Scalar::from_int(0, this.pointer_size())
  47         } else {
  48             let align = this.min_align(size, kind);
  49             let ptr = this
  50                 .memory
  51                 .allocate(Size::from_bytes(size), align, kind.into());
  52             if zero_init {
  53                 // We just allocated this, the access is definitely in-bounds.
  54                 this.memory
  55                     .get_mut(ptr.alloc_id)
  56                     .unwrap()
  57                     .write_repeat(&*this.tcx, ptr, 0, Size::from_bytes(size))
  58                     .unwrap();
  59             }
  60             Scalar::Ptr(ptr)
  61         }
  62     }
  63
  64     fn free(&mut self, ptr: Scalar<Tag>, kind: MiriMemoryKind) -> InterpResult<'tcx> {
  65         let this = self.eval_context_mut();
  66         if !this.is_null(ptr)? {
  67             let ptr = this.force_ptr(ptr)?;
  68             this.memory.deallocate(ptr, None, kind.into())?;
  69         }
  70         Ok(())
  71     }
  72
  73     fn realloc(
  74         &mut self,
  75         old_ptr: Scalar<Tag>,
  76         new_size: u64,
  77         kind: MiriMemoryKind,
  78     ) -> InterpResult<'tcx, Scalar<Tag>> {
  79         let this = self.eval_context_mut();
  80         let new_align = this.min_align(new_size, kind);
  81         if this.is_null(old_ptr)? {
  82             if new_size == 0 {
  83                 Ok(Scalar::from_int(0, this.pointer_size()))
  84             } else {
  85                 let new_ptr =
  86                     this.memory
  87                         .allocate(Size::from_bytes(new_size), new_align, kind.into());
  88                 Ok(Scalar::Ptr(new_ptr))
  89             }
  90         } else {
  91             let old_ptr = this.force_ptr(old_ptr)?;
  92             if new_size == 0 {
  93                 this.memory.deallocate(old_ptr, None, kind.into())?;
  94                 Ok(Scalar::from_int(0, this.pointer_size()))
  95             } else {
  96                 let new_ptr = this.memory.reallocate(
  97                     old_ptr,
  98                     None,
  99                     Size::from_bytes(new_size),
 100                     new_align,
 101                     kind.into(),
 102                 )?;
 103                 Ok(Scalar::Ptr(new_ptr))
 104             }
 105         }
 106     }
 107
 108     /// Emulates calling a foreign item, failing if the item is not supported.
 109     /// This function will handle `goto_block` if needed.
 110     fn emulate_foreign_item(
 111         &mut self,
 112         def_id: DefId,
 113         args: &[OpTy<'tcx, Tag>],
 114         dest: Option<PlaceTy<'tcx, Tag>>,
 115         ret: Option<mir::BasicBlock>,
 116     ) -> InterpResult<'tcx> {
 117         let this = self.eval_context_mut();
 118         let attrs = this.tcx.get_attrs(def_id);
 119         let link_name = match attr::first_attr_value_str_by_name(&attrs, sym::link_name) {
 120             Some(name) => name.as_str(),
 121             None => this.tcx.item_name(def_id).as_str(),
 122         };
 123         // Strip linker suffixes (seen on 32-bit macOS).
 124         let link_name = link_name.trim_end_matches("$UNIX2003");
 125         let tcx = &{ this.tcx.tcx };
 126
 127         // First: functions that diverge.
 128         match link_name {
 129             "__rust_start_panic" | "panic_impl" => {
 130                 throw_unsup_format!("the evaluated program panicked");
 131             }
 132             "exit" | "ExitProcess" => {
 133                 // it's really u32 for ExitProcess, but we have to put it into the `Exit` error variant anyway
 134                 let code = this.read_scalar(args[0])?.to_i32()?;
 135                 return Err(InterpError::Exit(code).into());
 136             }
 137             _ => {
 138                 if dest.is_none() {
 139                     throw_unsup_format!("can't call (diverging) foreign function: {}", link_name);
 140                 }
 141             }
 142         }
 143
 144         // Next: functions that assume a ret and dest.
 145         let dest = dest.expect("we already checked for a dest");
 146         let ret = ret.expect("dest is `Some` but ret is `None`");
 147         match link_name {
 148             "malloc" => {
 149                 let size = this.read_scalar(args[0])?.to_usize(this)?;
 150                 let res = this.malloc(size, /*zero_init:*/ false, MiriMemoryKind::C);
 151                 this.write_scalar(res, dest)?;
 152             }
 153             "calloc" => {
 154                 let items = this.read_scalar(args[0])?.to_usize(this)?;
 155                 let len = this.read_scalar(args[1])?.to_usize(this)?;
 156                 let size = items
 157                     .checked_mul(len)
 158                     .ok_or_else(|| err_panic!(Overflow(mir::BinOp::Mul)))?;
 159                 let res = this.malloc(size, /*zero_init:*/ true, MiriMemoryKind::C);
 160                 this.write_scalar(res, dest)?;
 161             }
 162             "posix_memalign" => {
 163                 let ret = this.deref_operand(args[0])?;
 164                 let align = this.read_scalar(args[1])?.to_usize(this)?;
 165                 let size = this.read_scalar(args[2])?.to_usize(this)?;
 166                 // Align must be power of 2, and also at least ptr-sized (POSIX rules).
 167                 if !align.is_power_of_two() {
 168                     throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
 169                 }
 170                 if align < this.pointer_size().bytes() {
 171                     throw_ub_format!(
 172                         "posix_memalign: alignment must be at least the size of a pointer, but is {}",
 173                         align,
 174                     );
 175                 }
 176
 177                 if size == 0 {
 178                     this.write_null(ret.into())?;
 179                 } else {
 180                     let ptr = this.memory.allocate(
 181                         Size::from_bytes(size),
 182                         Align::from_bytes(align).unwrap(),
 183                         MiriMemoryKind::C.into(),
 184                     );
 185                     this.write_scalar(Scalar::Ptr(ptr), ret.into())?;
 186                 }
 187                 this.write_null(dest)?;
 188             }
 189             "free" => {
 190                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 191                 this.free(ptr, MiriMemoryKind::C)?;
 192             }
 193             "realloc" => {
 194                 let old_ptr = this.read_scalar(args[0])?.not_undef()?;
 195                 let new_size = this.read_scalar(args[1])?.to_usize(this)?;
 196                 let res = this.realloc(old_ptr, new_size, MiriMemoryKind::C)?;
 197                 this.write_scalar(res, dest)?;
 198             }
 199
 200             "__rust_alloc" => {
 201                 let size = this.read_scalar(args[0])?.to_usize(this)?;
 202                 let align = this.read_scalar(args[1])?.to_usize(this)?;
 203                 if size == 0 {
 204                     throw_unsup!(HeapAllocZeroBytes);
 205                 }
 206                 if !align.is_power_of_two() {
 207                     throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
 208                 }
 209                 let ptr = this.memory.allocate(
 210                     Size::from_bytes(size),
 211                     Align::from_bytes(align).unwrap(),
 212                     MiriMemoryKind::Rust.into(),
 213                 );
 214                 this.write_scalar(Scalar::Ptr(ptr), dest)?;
 215             }
 216             "__rust_alloc_zeroed" => {
 217                 let size = this.read_scalar(args[0])?.to_usize(this)?;
 218                 let align = this.read_scalar(args[1])?.to_usize(this)?;
 219                 if size == 0 {
 220                     throw_unsup!(HeapAllocZeroBytes);
 221                 }
 222                 if !align.is_power_of_two() {
 223                     throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
 224                 }
 225                 let ptr = this.memory.allocate(
 226                     Size::from_bytes(size),
 227                     Align::from_bytes(align).unwrap(),
 228                     MiriMemoryKind::Rust.into(),
 229                 );
 230                 // We just allocated this, the access is definitely in-bounds.
 231                 this.memory
 232                     .get_mut(ptr.alloc_id)
 233                     .unwrap()
 234                     .write_repeat(tcx, ptr, 0, Size::from_bytes(size))
 235                     .unwrap();
 236                 this.write_scalar(Scalar::Ptr(ptr), dest)?;
 237             }
 238             "__rust_dealloc" => {
 239                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 240                 let old_size = this.read_scalar(args[1])?.to_usize(this)?;
 241                 let align = this.read_scalar(args[2])?.to_usize(this)?;
 242                 if old_size == 0 {
 243                     throw_unsup!(HeapAllocZeroBytes);
 244                 }
 245                 if !align.is_power_of_two() {
 246                     throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
 247                 }
 248                 let ptr = this.force_ptr(ptr)?;
 249                 this.memory.deallocate(
 250                     ptr,
 251                     Some((
 252                         Size::from_bytes(old_size),
 253                         Align::from_bytes(align).unwrap(),
 254                     )),
 255                     MiriMemoryKind::Rust.into(),
 256                 )?;
 257             }
 258             "__rust_realloc" => {
 259                 let ptr = this.read_scalar(args[0])?.to_ptr()?;
 260                 let old_size = this.read_scalar(args[1])?.to_usize(this)?;
 261                 let align = this.read_scalar(args[2])?.to_usize(this)?;
 262                 let new_size = this.read_scalar(args[3])?.to_usize(this)?;
 263                 if old_size == 0 || new_size == 0 {
 264                     throw_unsup!(HeapAllocZeroBytes);
 265                 }
 266                 if !align.is_power_of_two() {
 267                     throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
 268                 }
 269                 let align = Align::from_bytes(align).unwrap();
 270                 let new_ptr = this.memory.reallocate(
 271                     ptr,
 272                     Some((Size::from_bytes(old_size), align)),
 273                     Size::from_bytes(new_size),
 274                     align,
 275                     MiriMemoryKind::Rust.into(),
 276                 )?;
 277                 this.write_scalar(Scalar::Ptr(new_ptr), dest)?;
 278             }
 279
 280             "syscall" => {
 281                 let sys_getrandom = this
 282                     .eval_path_scalar(&["libc", "SYS_getrandom"])?
 283                     .expect("Failed to get libc::SYS_getrandom")
 284                     .to_usize(this)?;
 285
 286                 // `libc::syscall(NR_GETRANDOM, buf.as_mut_ptr(), buf.len(), GRND_NONBLOCK)`
 287                 // is called if a `HashMap` is created the regular way (e.g. HashMap<K, V>).
 288                 match this.read_scalar(args[0])?.to_usize(this)? {
 289                     id if id == sys_getrandom => {
 290                         // The first argument is the syscall id,
 291                         // so skip over it.
 292                         linux_getrandom(this, &args[1..], dest)?;
 293                     }
 294                     id => throw_unsup_format!("miri does not support syscall ID {}", id),
 295                 }
 296             }
 297
 298             "getrandom" => {
 299                 linux_getrandom(this, args, dest)?;
 300             }
 301
 302             "dlsym" => {
 303                 let _handle = this.read_scalar(args[0])?;
 304                 let symbol = this.read_scalar(args[1])?.not_undef()?;
 305                 let symbol_name = this.memory.read_c_str(symbol)?;
 306                 let err = format!("bad c unicode symbol: {:?}", symbol_name);
 307                 let symbol_name = ::std::str::from_utf8(symbol_name).unwrap_or(&err);
 308                 if let Some(dlsym) = Dlsym::from_str(symbol_name)? {
 309                     let ptr = this.memory.create_fn_alloc(FnVal::Other(dlsym));
 310                     this.write_scalar(Scalar::from(ptr), dest)?;
 311                 } else {
 312                     this.write_null(dest)?;
 313                 }
 314             }
 315
 316             "__rust_maybe_catch_panic" => {
 317                 // fn __rust_maybe_catch_panic(
 318                 //     f: fn(*mut u8),
 319                 //     data: *mut u8,
 320                 //     data_ptr: *mut usize,
 321                 //     vtable_ptr: *mut usize,
 322                 // ) -> u32
 323                 // We abort on panic, so not much is going on here, but we still have to call the closure.
 324                 let f = this.read_scalar(args[0])?.not_undef()?;
 325                 let data = this.read_scalar(args[1])?.not_undef()?;
 326                 let f_instance = this.memory.get_fn(f)?.as_instance()?;
 327                 this.write_null(dest)?;
 328                 trace!("__rust_maybe_catch_panic: {:?}", f_instance);
 329
 330                 // Now we make a function call.
 331                 // TODO: consider making this reusable? `InterpCx::step` does something similar
 332                 // for the TLS destructors, and of course `eval_main`.
 333                 let mir = this.load_mir(f_instance.def, None)?;
 334                 let ret_place =
 335                     MPlaceTy::dangling(this.layout_of(tcx.mk_unit())?, this).into();
 336                 this.push_stack_frame(
 337                     f_instance,
 338                     mir.span,
 339                     mir,
 340                     Some(ret_place),
 341                     // Directly return to caller.
 342                     StackPopCleanup::Goto(Some(ret)),
 343                 )?;
 344                 let mut args = this.frame().body.args_iter();
 345
 346                 let arg_local = args
 347                     .next()
 348                     .expect("Argument to __rust_maybe_catch_panic does not take enough arguments.");
 349                 let arg_dest = this.local_place(arg_local)?;
 350                 this.write_scalar(data, arg_dest)?;
 351
 352                 args.next().expect_none("__rust_maybe_catch_panic argument has more arguments than expected");
 353
 354                 // We ourselves will return `0`, eventually (because we will not return if we paniced).
 355                 this.write_null(dest)?;
 356
 357                 // Don't fall through, we do *not* want to `goto_block`!
 358                 return Ok(());
 359             }
 360
 361             "memcmp" => {
 362                 let left = this.read_scalar(args[0])?.not_undef()?;
 363                 let right = this.read_scalar(args[1])?.not_undef()?;
 364                 let n = Size::from_bytes(this.read_scalar(args[2])?.to_usize(this)?);
 365
 366                 let result = {
 367                     let left_bytes = this.memory.read_bytes(left, n)?;
 368                     let right_bytes = this.memory.read_bytes(right, n)?;
 369
 370                     use std::cmp::Ordering::*;
 371                     match left_bytes.cmp(right_bytes) {
 372                         Less => -1i32,
 373                         Equal => 0,
 374                         Greater => 1,
 375                     }
 376                 };
 377
 378                 this.write_scalar(Scalar::from_int(result, Size::from_bits(32)), dest)?;
 379             }
 380
 381             "memrchr" => {
 382                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 383                 let val = this.read_scalar(args[1])?.to_i32()? as u8;
 384                 let num = this.read_scalar(args[2])?.to_usize(this)?;
 385                 if let Some(idx) = this
 386                     .memory
 387                     .read_bytes(ptr, Size::from_bytes(num))?
 388                     .iter()
 389                     .rev()
 390                     .position(|&c| c == val)
 391                 {
 392                     let new_ptr = ptr.ptr_offset(Size::from_bytes(num - idx as u64 - 1), this)?;
 393                     this.write_scalar(new_ptr, dest)?;
 394                 } else {
 395                     this.write_null(dest)?;
 396                 }
 397             }
 398
 399             "memchr" => {
 400                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 401                 let val = this.read_scalar(args[1])?.to_i32()? as u8;
 402                 let num = this.read_scalar(args[2])?.to_usize(this)?;
 403                 let idx = this
 404                     .memory
 405                     .read_bytes(ptr, Size::from_bytes(num))?
 406                     .iter()
 407                     .position(|&c| c == val);
 408                 if let Some(idx) = idx {
 409                     let new_ptr = ptr.ptr_offset(Size::from_bytes(idx as u64), this)?;
 410                     this.write_scalar(new_ptr, dest)?;
 411                 } else {
 412                     this.write_null(dest)?;
 413                 }
 414             }
 415
 416             "__errno_location" | "__error" => {
 417                 let errno_place = this.machine.last_error.unwrap();
 418                 let errno_scalar: Scalar<Tag> = this.check_mplace_access(errno_place.into(), Some(Size::from_bits(32)))?.unwrap().into();
 419                 this.write_scalar(errno_scalar, dest)?;
 420             }
 421
 422             "getenv" => {
 423                 let result = this.getenv(args[0])?;
 424                 this.write_scalar(result, dest)?;
 425             }
 426
 427             "unsetenv" => {
 428                 let result = this.unsetenv(args[0])?;
 429                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 430             }
 431
 432             "setenv" => {
 433                 let result = this.setenv(args[0], args[1])?;
 434                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 435             }
 436
 437             "getcwd" => {
 438                 let result = this.getcwd(args[0], args[1])?;
 439                 this.write_scalar(result, dest)?;
 440             }
 441
 442             "chdir" => {
 443                 let result = this.chdir(args[0])?;
 444                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 445             }
 446
 447             "open" | "open64" => {
 448                 let result = this.open(args[0], args[1])?;
 449                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 450             }
 451
 452             "fcntl" => {
 453                 let result = this.fcntl(args[0], args[1], args.get(2).cloned())?;
 454                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 455             }
 456
 457             "close" | "close$NOCANCEL" => {
 458                 let result = this.close(args[0])?;
 459                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 460             }
 461
 462             "read" => {
 463                 let result = this.read(args[0], args[1], args[2])?;
 464                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 465             }
 466
 467             "write" => {
 468                 let fd = this.read_scalar(args[0])?.to_i32()?;
 469                 let buf = this.read_scalar(args[1])?.not_undef()?;
 470                 let n = this.read_scalar(args[2])?.to_usize(tcx)?;
 471                 trace!("Called write({:?}, {:?}, {:?})", fd, buf, n);
 472                 let result = if fd == 1 || fd == 2 {
 473                     // stdout/stderr
 474                     use std::io::{self, Write};
 475
 476                     let buf_cont = this.memory.read_bytes(buf, Size::from_bytes(n))?;
 477                     // We need to flush to make sure this actually appears on the screen
 478                     let res = if fd == 1 {
 479                         // Stdout is buffered, flush to make sure it appears on the screen.
 480                         // This is the write() syscall of the interpreted program, we want it
 481                         // to correspond to a write() syscall on the host -- there is no good
 482                         // in adding extra buffering here.
 483                         let res = io::stdout().write(buf_cont);
 484                         io::stdout().flush().unwrap();
 485                         res
 486                     } else {
 487                         // No need to flush, stderr is not buffered.
 488                         io::stderr().write(buf_cont)
 489                     };
 490                     match res {
 491                         Ok(n) => n as i64,
 492                         Err(_) => -1,
 493                     }
 494                 } else {
 495                     this.write(args[0], args[1], args[2])?
 496                 };
 497                 // Now, `result` is the value we return back to the program.
 498                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 499             }
 500
 501             "unlink" => {
 502                 let result = this.unlink(args[0])?;
 503                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 504             }
 505
 506             "clock_gettime" => {
 507                 let result = this.clock_gettime(args[0], args[1])?;
 508                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 509             }
 510
 511             "gettimeofday" => {
 512                 let result = this.gettimeofday(args[0], args[1])?;
 513                 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
 514             }
 515
 516             "strlen" => {
 517                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 518                 let n = this.memory.read_c_str(ptr)?.len();
 519                 this.write_scalar(Scalar::from_uint(n as u64, dest.layout.size), dest)?;
 520             }
 521
 522             // math functions
 523             "cbrtf" | "coshf" | "sinhf" | "tanf" => {
 524                 // FIXME: Using host floats.
 525                 let f = f32::from_bits(this.read_scalar(args[0])?.to_u32()?);
 526                 let f = match link_name {
 527                     "cbrtf" => f.cbrt(),
 528                     "coshf" => f.cosh(),
 529                     "sinhf" => f.sinh(),
 530                     "tanf" => f.tan(),
 531                     _ => bug!(),
 532                 };
 533                 this.write_scalar(Scalar::from_u32(f.to_bits()), dest)?;
 534             }
 535             // underscore case for windows
 536             "_hypotf" | "hypotf" | "atan2f" => {
 537                 // FIXME: Using host floats.
 538                 let f1 = f32::from_bits(this.read_scalar(args[0])?.to_u32()?);
 539                 let f2 = f32::from_bits(this.read_scalar(args[1])?.to_u32()?);
 540                 let n = match link_name {
 541                     "_hypotf" | "hypotf" => f1.hypot(f2),
 542                     "atan2f" => f1.atan2(f2),
 543                     _ => bug!(),
 544                 };
 545                 this.write_scalar(Scalar::from_u32(n.to_bits()), dest)?;
 546             }
 547
 548             "cbrt" | "cosh" | "sinh" | "tan" => {
 549                 // FIXME: Using host floats.
 550                 let f = f64::from_bits(this.read_scalar(args[0])?.to_u64()?);
 551                 let f = match link_name {
 552                     "cbrt" => f.cbrt(),
 553                     "cosh" => f.cosh(),
 554                     "sinh" => f.sinh(),
 555                     "tan" => f.tan(),
 556                     _ => bug!(),
 557                 };
 558                 this.write_scalar(Scalar::from_u64(f.to_bits()), dest)?;
 559             }
 560             // underscore case for windows, here and below
 561             // (see https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/floating-point-primitives?view=vs-2019)
 562             "_hypot" | "hypot" | "atan2" => {
 563                 // FIXME: Using host floats.
 564                 let f1 = f64::from_bits(this.read_scalar(args[0])?.to_u64()?);
 565                 let f2 = f64::from_bits(this.read_scalar(args[1])?.to_u64()?);
 566                 let n = match link_name {
 567                     "_hypot" | "hypot" => f1.hypot(f2),
 568                     "atan2" => f1.atan2(f2),
 569                     _ => bug!(),
 570                 };
 571                 this.write_scalar(Scalar::from_u64(n.to_bits()), dest)?;
 572             }
 573             // For radix-2 (binary) systems, `ldexp` and `scalbn` are the same.
 574             "_ldexp" | "ldexp" | "scalbn" => {
 575                 let x = this.read_scalar(args[0])?.to_f64()?;
 576                 let exp = this.read_scalar(args[1])?.to_i32()?;
 577
 578                 // Saturating cast to i16. Even those are outside the valid exponent range to
 579                 // `scalbn` below will do its over/underflow handling.
 580                 let exp = if exp > i16::max_value() as i32 {
 581                     i16::max_value()
 582                 } else if exp < i16::min_value() as i32 {
 583                     i16::min_value()
 584                 } else {
 585                     exp.try_into().unwrap()
 586                 };
 587
 588                 let res = x.scalbn(exp);
 589                 this.write_scalar(Scalar::from_f64(res), dest)?;
 590             }
 591
 592             // Some things needed for `sys::thread` initialization to go through.
 593             "signal" | "sigaction" | "sigaltstack" => {
 594                 this.write_scalar(Scalar::from_int(0, dest.layout.size), dest)?;
 595             }
 596
 597             "sysconf" => {
 598                 let name = this.read_scalar(args[0])?.to_i32()?;
 599
 600                 trace!("sysconf() called with name {}", name);
 601                 // TODO: Cache the sysconf integers via Miri's global cache.
 602                 let paths = &[
 603                     (
 604                         &["libc", "_SC_PAGESIZE"],
 605                         Scalar::from_int(PAGE_SIZE, dest.layout.size),
 606                     ),
 607                     (
 608                         &["libc", "_SC_GETPW_R_SIZE_MAX"],
 609                         Scalar::from_int(-1, dest.layout.size),
 610                     ),
 611                     (
 612                         &["libc", "_SC_NPROCESSORS_ONLN"],
 613                         Scalar::from_int(NUM_CPUS, dest.layout.size),
 614                     ),
 615                 ];
 616                 let mut result = None;
 617                 for &(path, path_value) in paths {
 618                     if let Some(val) = this.eval_path_scalar(path)? {
 619                         let val = val.to_i32()?;
 620                         if val == name {
 621                             result = Some(path_value);
 622                             break;
 623                         }
 624                     }
 625                 }
 626                 if let Some(result) = result {
 627                     this.write_scalar(result, dest)?;
 628                 } else {
 629                     throw_unsup_format!("Unimplemented sysconf name: {}", name)
 630                 }
 631             }
 632
 633             "sched_getaffinity" => {
 634                 // Return an error; `num_cpus` then falls back to `sysconf`.
 635                 this.write_scalar(Scalar::from_int(-1, dest.layout.size), dest)?;
 636             }
 637
 638             "isatty" => {
 639                 this.write_null(dest)?;
 640             }
 641
 642             // Hook pthread calls that go to the thread-local storage memory subsystem.
 643             "pthread_key_create" => {
 644                 let key_place = this.deref_operand(args[0])?;
 645
 646                 // Extract the function type out of the signature (that seems easier than constructing it ourselves).
 647                 let dtor = match this.test_null(this.read_scalar(args[1])?.not_undef()?)? {
 648                     Some(dtor_ptr) => Some(this.memory.get_fn(dtor_ptr)?.as_instance()?),
 649                     None => None,
 650                 };
 651
 652                 // Figure out how large a pthread TLS key actually is.
 653                 // This is `libc::pthread_key_t`.
 654                 let key_type = args[0].layout.ty
 655                     .builtin_deref(true)
 656                     .ok_or_else(|| err_ub_format!(
 657                         "wrong signature used for `pthread_key_create`: first argument must be a raw pointer."
 658                     ))?
 659                     .ty;
 660                 let key_layout = this.layout_of(key_type)?;
 661
 662                 // Create key and write it into the memory where `key_ptr` wants it.
 663                 let key = this.machine.tls.create_tls_key(dtor) as u128;
 664                 if key_layout.size.bits() < 128 && key >= (1u128 << key_layout.size.bits() as u128)
 665                 {
 666                     throw_unsup!(OutOfTls);
 667                 }
 668
 669                 this.write_scalar(Scalar::from_uint(key, key_layout.size), key_place.into())?;
 670
 671                 // Return success (`0`).
 672                 this.write_null(dest)?;
 673             }
 674             "pthread_key_delete" => {
 675                 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
 676                 this.machine.tls.delete_tls_key(key)?;
 677                 // Return success (0)
 678                 this.write_null(dest)?;
 679             }
 680             "pthread_getspecific" => {
 681                 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
 682                 let ptr = this.machine.tls.load_tls(key, tcx)?;
 683                 this.write_scalar(ptr, dest)?;
 684             }
 685             "pthread_setspecific" => {
 686                 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
 687                 let new_ptr = this.read_scalar(args[1])?.not_undef()?;
 688                 this.machine.tls.store_tls(key, this.test_null(new_ptr)?)?;
 689
 690                 // Return success (`0`).
 691                 this.write_null(dest)?;
 692             }
 693
 694             // Stack size/address stuff.
 695             "pthread_attr_init"
 696             | "pthread_attr_destroy"
 697             | "pthread_self"
 698             | "pthread_attr_setstacksize" => {
 699                 this.write_null(dest)?;
 700             }
 701             "pthread_attr_getstack" => {
 702                 let addr_place = this.deref_operand(args[1])?;
 703                 let size_place = this.deref_operand(args[2])?;
 704
 705                 this.write_scalar(
 706                     Scalar::from_uint(STACK_ADDR, addr_place.layout.size),
 707                     addr_place.into(),
 708                 )?;
 709                 this.write_scalar(
 710                     Scalar::from_uint(STACK_SIZE, size_place.layout.size),
 711                     size_place.into(),
 712                 )?;
 713
 714                 // Return success (`0`).
 715                 this.write_null(dest)?;
 716             }
 717
 718             // We don't support threading. (Also for Windows.)
 719             "pthread_create" | "CreateThread" => {
 720                 throw_unsup_format!("Miri does not support threading");
 721             }
 722
 723             // Stub out calls for condvar, mutex and rwlock, to just return `0`.
 724             "pthread_mutexattr_init"
 725             | "pthread_mutexattr_settype"
 726             | "pthread_mutex_init"
 727             | "pthread_mutexattr_destroy"
 728             | "pthread_mutex_lock"
 729             | "pthread_mutex_unlock"
 730             | "pthread_mutex_destroy"
 731             | "pthread_rwlock_rdlock"
 732             | "pthread_rwlock_unlock"
 733             | "pthread_rwlock_wrlock"
 734             | "pthread_rwlock_destroy"
 735             | "pthread_condattr_init"
 736             | "pthread_condattr_setclock"
 737             | "pthread_cond_init"
 738             | "pthread_condattr_destroy"
 739             | "pthread_cond_destroy" => {
 740                 this.write_null(dest)?;
 741             }
 742
 743             // We don't support fork so we don't have to do anything for atfork.
 744             "pthread_atfork" => {
 745                 this.write_null(dest)?;
 746             }
 747
 748             "mmap" => {
 749                 // This is a horrible hack, but since the guard page mechanism calls mmap and expects a particular return value, we just give it that value.
 750                 let addr = this.read_scalar(args[0])?.not_undef()?;
 751                 this.write_scalar(addr, dest)?;
 752             }
 753             "mprotect" => {
 754                 this.write_null(dest)?;
 755             }
 756
 757             // macOS API stubs.
 758             "pthread_attr_get_np" | "pthread_getattr_np" => {
 759                 this.write_null(dest)?;
 760             }
 761             "pthread_get_stackaddr_np" => {
 762                 let stack_addr = Scalar::from_uint(STACK_ADDR, dest.layout.size);
 763                 this.write_scalar(stack_addr, dest)?;
 764             }
 765             "pthread_get_stacksize_np" => {
 766                 let stack_size = Scalar::from_uint(STACK_SIZE, dest.layout.size);
 767                 this.write_scalar(stack_size, dest)?;
 768             }
 769             "_tlv_atexit" => {
 770                 // FIXME: register the destructor.
 771             }
 772             "_NSGetArgc" => {
 773                 this.write_scalar(Scalar::Ptr(this.machine.argc.unwrap()), dest)?;
 774             }
 775             "_NSGetArgv" => {
 776                 this.write_scalar(Scalar::Ptr(this.machine.argv.unwrap()), dest)?;
 777             }
 778             "SecRandomCopyBytes" => {
 779                 let len = this.read_scalar(args[1])?.to_usize(this)?;
 780                 let ptr = this.read_scalar(args[2])?.not_undef()?;
 781                 this.gen_random(ptr, len as usize)?;
 782                 this.write_null(dest)?;
 783             }
 784
 785             // Windows API stubs.
 786             // HANDLE = isize
 787             // DWORD = ULONG = u32
 788             // BOOL = i32
 789             "GetProcessHeap" => {
 790                 // Just fake a HANDLE
 791                 this.write_scalar(Scalar::from_int(1, this.pointer_size()), dest)?;
 792             }
 793             "HeapAlloc" => {
 794                 let _handle = this.read_scalar(args[0])?.to_isize(this)?;
 795                 let flags = this.read_scalar(args[1])?.to_u32()?;
 796                 let size = this.read_scalar(args[2])?.to_usize(this)?;
 797                 let zero_init = (flags & 0x00000008) != 0; // HEAP_ZERO_MEMORY
 798                 let res = this.malloc(size, zero_init, MiriMemoryKind::WinHeap);
 799                 this.write_scalar(res, dest)?;
 800             }
 801             "HeapFree" => {
 802                 let _handle = this.read_scalar(args[0])?.to_isize(this)?;
 803                 let _flags = this.read_scalar(args[1])?.to_u32()?;
 804                 let ptr = this.read_scalar(args[2])?.not_undef()?;
 805                 this.free(ptr, MiriMemoryKind::WinHeap)?;
 806                 this.write_scalar(Scalar::from_int(1, Size::from_bytes(4)), dest)?;
 807             }
 808             "HeapReAlloc" => {
 809                 let _handle = this.read_scalar(args[0])?.to_isize(this)?;
 810                 let _flags = this.read_scalar(args[1])?.to_u32()?;
 811                 let ptr = this.read_scalar(args[2])?.not_undef()?;
 812                 let size = this.read_scalar(args[3])?.to_usize(this)?;
 813                 let res = this.realloc(ptr, size, MiriMemoryKind::WinHeap)?;
 814                 this.write_scalar(res, dest)?;
 815             }
 816
 817             "SetLastError" => {
 818                 this.set_last_error(this.read_scalar(args[0])?.not_undef()?)?;
 819             }
 820             "GetLastError" => {
 821                 let last_error = this.get_last_error()?;
 822                 this.write_scalar(last_error, dest)?;
 823             }
 824
 825             "AddVectoredExceptionHandler" => {
 826                 // Any non zero value works for the stdlib. This is just used for stack overflows anyway.
 827                 this.write_scalar(Scalar::from_int(1, dest.layout.size), dest)?;
 828             }
 829             "InitializeCriticalSection"
 830             | "EnterCriticalSection"
 831             | "LeaveCriticalSection"
 832             | "DeleteCriticalSection" => {
 833                 // Nothing to do, not even a return value.
 834             }
 835             "GetModuleHandleW"
 836             | "GetProcAddress"
 837             | "TryEnterCriticalSection"
 838             | "GetConsoleScreenBufferInfo"
 839             | "SetConsoleTextAttribute" => {
 840                 // Pretend these do not exist / nothing happened, by returning zero.
 841                 this.write_null(dest)?;
 842             }
 843             "GetSystemInfo" => {
 844                 let system_info = this.deref_operand(args[0])?;
 845                 let system_info_ptr = this
 846                     .check_mplace_access(system_info, None)?
 847                     .expect("cannot be a ZST");
 848                 // We rely on `deref_operand` doing bounds checks for us.
 849                 // Initialize with `0`.
 850                 this.memory
 851                     .get_mut(system_info_ptr.alloc_id)?
 852                     .write_repeat(tcx, system_info_ptr, 0, system_info.layout.size)?;
 853                 // Set number of processors.
 854                 let dword_size = Size::from_bytes(4);
 855                 let offset = 2 * dword_size + 3 * tcx.pointer_size();
 856                 this.memory
 857                     .get_mut(system_info_ptr.alloc_id)?
 858                     .write_scalar(
 859                         tcx,
 860                         system_info_ptr.offset(offset, tcx)?,
 861                         Scalar::from_int(NUM_CPUS, dword_size).into(),
 862                         dword_size,
 863                     )?;
 864             }
 865
 866             "TlsAlloc" => {
 867                 // This just creates a key; Windows does not natively support TLS destructors.
 868
 869                 // Create key and return it.
 870                 let key = this.machine.tls.create_tls_key(None) as u128;
 871
 872                 // Figure out how large a TLS key actually is. This is `c::DWORD`.
 873                 if dest.layout.size.bits() < 128
 874                     && key >= (1u128 << dest.layout.size.bits() as u128)
 875                 {
 876                     throw_unsup!(OutOfTls);
 877                 }
 878                 this.write_scalar(Scalar::from_uint(key, dest.layout.size), dest)?;
 879             }
 880             "TlsGetValue" => {
 881                 let key = this.read_scalar(args[0])?.to_u32()? as u128;
 882                 let ptr = this.machine.tls.load_tls(key, tcx)?;
 883                 this.write_scalar(ptr, dest)?;
 884             }
 885             "TlsSetValue" => {
 886                 let key = this.read_scalar(args[0])?.to_u32()? as u128;
 887                 let new_ptr = this.read_scalar(args[1])?.not_undef()?;
 888                 this.machine.tls.store_tls(key, this.test_null(new_ptr)?)?;
 889
 890                 // Return success (`1`).
 891                 this.write_scalar(Scalar::from_int(1, dest.layout.size), dest)?;
 892             }
 893             "GetStdHandle" => {
 894                 let which = this.read_scalar(args[0])?.to_i32()?;
 895                 // We just make this the identity function, so we know later in `WriteFile`
 896                 // which one it is.
 897                 this.write_scalar(Scalar::from_int(which, this.pointer_size()), dest)?;
 898             }
 899             "WriteFile" => {
 900                 let handle = this.read_scalar(args[0])?.to_isize(this)?;
 901                 let buf = this.read_scalar(args[1])?.not_undef()?;
 902                 let n = this.read_scalar(args[2])?.to_u32()?;
 903                 let written_place = this.deref_operand(args[3])?;
 904                 // Spec says to always write `0` first.
 905                 this.write_null(written_place.into())?;
 906                 let written = if handle == -11 || handle == -12 {
 907                     // stdout/stderr
 908                     use std::io::{self, Write};
 909
 910                     let buf_cont = this
 911                         .memory
 912                         .read_bytes(buf, Size::from_bytes(u64::from(n)))?;
 913                     let res = if handle == -11 {
 914                         io::stdout().write(buf_cont)
 915                     } else {
 916                         io::stderr().write(buf_cont)
 917                     };
 918                     res.ok().map(|n| n as u32)
 919                 } else {
 920                     eprintln!("Miri: Ignored output to handle {}", handle);
 921                     // Pretend it all went well.
 922                     Some(n)
 923                 };
 924                 // If there was no error, write back how much was written.
 925                 if let Some(n) = written {
 926                     this.write_scalar(Scalar::from_u32(n), written_place.into())?;
 927                 }
 928                 // Return whether this was a success.
 929                 this.write_scalar(
 930                     Scalar::from_int(if written.is_some() { 1 } else { 0 }, dest.layout.size),
 931                     dest,
 932                 )?;
 933             }
 934             "GetConsoleMode" => {
 935                 // Everything is a pipe.
 936                 this.write_null(dest)?;
 937             }
 938             "GetEnvironmentVariableW" => {
 939                 // This is not the env var you are looking for.
 940                 this.set_last_error(Scalar::from_u32(203))?; // ERROR_ENVVAR_NOT_FOUND
 941                 this.write_null(dest)?;
 942             }
 943             "GetCommandLineW" => {
 944                 this.write_scalar(Scalar::Ptr(this.machine.cmd_line.unwrap()), dest)?;
 945             }
 946             // The actual name of 'RtlGenRandom'
 947             "SystemFunction036" => {
 948                 let ptr = this.read_scalar(args[0])?.not_undef()?;
 949                 let len = this.read_scalar(args[1])?.to_u32()?;
 950                 this.gen_random(ptr, len as usize)?;
 951                 this.write_scalar(Scalar::from_bool(true), dest)?;
 952             }
 953
 954             // We can't execute anything else.
 955             _ => throw_unsup_format!("can't call foreign function: {}", link_name),
 956         }
 957
 958         this.goto_block(Some(ret))?;
 959         this.dump_place(*dest);
 960         Ok(())
 961     }
 962
 963     /// Evaluates the scalar at the specified path. Returns Some(val)
 964     /// if the path could be resolved, and None otherwise
 965     fn eval_path_scalar(
 966         &mut self,
 967         path: &[&str],
 968     ) -> InterpResult<'tcx, Option<ScalarMaybeUndef<Tag>>> {
 969         let this = self.eval_context_mut();
 970         if let Ok(instance) = this.resolve_path(path) {
 971             let cid = GlobalId {
 972                 instance,
 973                 promoted: None,
 974             };
 975             let const_val = this.const_eval_raw(cid)?;
 976             let const_val = this.read_scalar(const_val.into())?;
 977             return Ok(Some(const_val));
 978         }
 979         return Ok(None);
 980     }
 981 }
 982
 983 // Shims the linux 'getrandom()' syscall.
 984 fn linux_getrandom<'tcx>(
 985     this: &mut MiriEvalContext<'_, 'tcx>,
 986     args: &[OpTy<'tcx, Tag>],
 987     dest: PlaceTy<'tcx, Tag>,
 988 ) -> InterpResult<'tcx> {
 989     let ptr = this.read_scalar(args[0])?.not_undef()?;
 990     let len = this.read_scalar(args[1])?.to_usize(this)?;
 991
 992     // The only supported flags are GRND_RANDOM and GRND_NONBLOCK,
 993     // neither of which have any effect on our current PRNG.
 994     let _flags = this.read_scalar(args[2])?.to_i32()?;
 995
 996     this.gen_random(ptr, len as usize)?;
 997     this.write_scalar(Scalar::from_uint(len, dest.layout.size), dest)?;
 998     Ok(())
 999 }