1 use std::convert::TryInto;
3 use rustc::hir::def_id::DefId;
5 use rustc::ty::layout::{Align, LayoutOf, Size};
6 use rustc_apfloat::Float;
8 use syntax::symbol::sym;
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),
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();
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();
33 // x *is* a power of two, just use that.
36 // x is between two powers, so next = 2*prev.
40 Align::from_bytes(prev_power_of_two(size)).unwrap()
43 fn malloc(&mut self, size: u64, zero_init: bool, kind: MiriMemoryKind) -> Scalar<Tag> {
44 let this = self.eval_context_mut();
45 let tcx = &{ this.tcx.tcx };
47 Scalar::from_int(0, this.pointer_size())
49 let align = this.min_align(size, kind);
52 .allocate(Size::from_bytes(size), align, kind.into());
54 // We just allocated this, the access cannot fail
56 .get_mut(ptr.alloc_id)
58 .write_repeat(tcx, ptr, 0, Size::from_bytes(size))
65 fn free(&mut self, ptr: Scalar<Tag>, kind: MiriMemoryKind) -> InterpResult<'tcx> {
66 let this = self.eval_context_mut();
67 if !this.is_null(ptr)? {
68 let ptr = this.force_ptr(ptr)?;
69 this.memory_mut().deallocate(ptr, None, kind.into())?;
79 ) -> InterpResult<'tcx, Scalar<Tag>> {
80 let this = self.eval_context_mut();
81 let new_align = this.min_align(new_size, kind);
82 if this.is_null(old_ptr)? {
84 Ok(Scalar::from_int(0, this.pointer_size()))
88 .allocate(Size::from_bytes(new_size), new_align, kind.into());
89 Ok(Scalar::Ptr(new_ptr))
92 let old_ptr = this.force_ptr(old_ptr)?;
93 let memory = this.memory_mut();
95 memory.deallocate(old_ptr, None, kind.into())?;
96 Ok(Scalar::from_int(0, this.pointer_size()))
98 let new_ptr = memory.reallocate(
101 Size::from_bytes(new_size),
105 Ok(Scalar::Ptr(new_ptr))
110 /// Emulates calling a foreign item, failing if the item is not supported.
111 /// This function will handle `goto_block` if needed.
112 fn emulate_foreign_item(
115 args: &[OpTy<'tcx, Tag>],
116 dest: Option<PlaceTy<'tcx, Tag>>,
117 ret: Option<mir::BasicBlock>,
118 ) -> InterpResult<'tcx> {
119 let this = self.eval_context_mut();
120 let attrs = this.tcx.get_attrs(def_id);
121 let link_name = match attr::first_attr_value_str_by_name(&attrs, sym::link_name) {
122 Some(name) => name.as_str(),
123 None => this.tcx.item_name(def_id).as_str(),
125 // Strip linker suffixes (seen on 32-bit macOS).
126 let link_name = link_name.trim_end_matches("$UNIX2003");
127 let tcx = &{ this.tcx.tcx };
129 // First: functions that diverge.
131 "__rust_start_panic" | "panic_impl" => {
132 throw_unsup_format!("the evaluated program panicked");
134 "exit" | "ExitProcess" => {
135 // it's really u32 for ExitProcess, but we have to put it into the `Exit` error variant anyway
136 let code = this.read_scalar(args[0])?.to_i32()?;
137 return Err(InterpError::Exit(code).into());
141 throw_unsup_format!("can't call (diverging) foreign function: {}", link_name);
146 // Next: functions that assume a ret and dest.
147 let dest = dest.expect("we already checked for a dest");
148 let ret = ret.expect("dest is `Some` but ret is `None`");
151 let size = this.read_scalar(args[0])?.to_usize(this)?;
152 let res = this.malloc(size, /*zero_init:*/ false, MiriMemoryKind::C);
153 this.write_scalar(res, dest)?;
156 let items = this.read_scalar(args[0])?.to_usize(this)?;
157 let len = this.read_scalar(args[1])?.to_usize(this)?;
160 .ok_or_else(|| err_panic!(Overflow(mir::BinOp::Mul)))?;
161 let res = this.malloc(size, /*zero_init:*/ true, MiriMemoryKind::C);
162 this.write_scalar(res, dest)?;
164 "posix_memalign" => {
165 let ret = this.deref_operand(args[0])?;
166 let align = this.read_scalar(args[1])?.to_usize(this)?;
167 let size = this.read_scalar(args[2])?.to_usize(this)?;
168 // Align must be power of 2, and also at least ptr-sized (POSIX rules).
169 if !align.is_power_of_two() {
170 throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
172 if align < this.pointer_size().bytes() {
174 "posix_memalign: alignment must be at least the size of a pointer, but is {}",
180 this.write_null(ret.into())?;
182 let ptr = this.memory_mut().allocate(
183 Size::from_bytes(size),
184 Align::from_bytes(align).unwrap(),
185 MiriMemoryKind::C.into(),
187 this.write_scalar(Scalar::Ptr(ptr), ret.into())?;
189 this.write_null(dest)?;
192 let ptr = this.read_scalar(args[0])?.not_undef()?;
193 this.free(ptr, MiriMemoryKind::C)?;
196 let old_ptr = this.read_scalar(args[0])?.not_undef()?;
197 let new_size = this.read_scalar(args[1])?.to_usize(this)?;
198 let res = this.realloc(old_ptr, new_size, MiriMemoryKind::C)?;
199 this.write_scalar(res, dest)?;
203 let size = this.read_scalar(args[0])?.to_usize(this)?;
204 let align = this.read_scalar(args[1])?.to_usize(this)?;
206 throw_unsup!(HeapAllocZeroBytes);
208 if !align.is_power_of_two() {
209 throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
211 let ptr = this.memory_mut().allocate(
212 Size::from_bytes(size),
213 Align::from_bytes(align).unwrap(),
214 MiriMemoryKind::Rust.into(),
216 this.write_scalar(Scalar::Ptr(ptr), dest)?;
218 "__rust_alloc_zeroed" => {
219 let size = this.read_scalar(args[0])?.to_usize(this)?;
220 let align = this.read_scalar(args[1])?.to_usize(this)?;
222 throw_unsup!(HeapAllocZeroBytes);
224 if !align.is_power_of_two() {
225 throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
227 let ptr = this.memory_mut().allocate(
228 Size::from_bytes(size),
229 Align::from_bytes(align).unwrap(),
230 MiriMemoryKind::Rust.into(),
232 // We just allocated this, the access cannot fail
234 .get_mut(ptr.alloc_id)
236 .write_repeat(tcx, ptr, 0, Size::from_bytes(size))
238 this.write_scalar(Scalar::Ptr(ptr), dest)?;
240 "__rust_dealloc" => {
241 let ptr = this.read_scalar(args[0])?.not_undef()?;
242 let old_size = this.read_scalar(args[1])?.to_usize(this)?;
243 let align = this.read_scalar(args[2])?.to_usize(this)?;
245 throw_unsup!(HeapAllocZeroBytes);
247 if !align.is_power_of_two() {
248 throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
250 let ptr = this.force_ptr(ptr)?;
251 this.memory_mut().deallocate(
254 Size::from_bytes(old_size),
255 Align::from_bytes(align).unwrap(),
257 MiriMemoryKind::Rust.into(),
260 "__rust_realloc" => {
261 let ptr = this.read_scalar(args[0])?.to_ptr()?;
262 let old_size = this.read_scalar(args[1])?.to_usize(this)?;
263 let align = this.read_scalar(args[2])?.to_usize(this)?;
264 let new_size = this.read_scalar(args[3])?.to_usize(this)?;
265 if old_size == 0 || new_size == 0 {
266 throw_unsup!(HeapAllocZeroBytes);
268 if !align.is_power_of_two() {
269 throw_unsup!(HeapAllocNonPowerOfTwoAlignment(align));
271 let align = Align::from_bytes(align).unwrap();
272 let new_ptr = this.memory_mut().reallocate(
274 Some((Size::from_bytes(old_size), align)),
275 Size::from_bytes(new_size),
277 MiriMemoryKind::Rust.into(),
279 this.write_scalar(Scalar::Ptr(new_ptr), dest)?;
283 let sys_getrandom = this
284 .eval_path_scalar(&["libc", "SYS_getrandom"])?
285 .expect("Failed to get libc::SYS_getrandom")
288 // `libc::syscall(NR_GETRANDOM, buf.as_mut_ptr(), buf.len(), GRND_NONBLOCK)`
289 // is called if a `HashMap` is created the regular way (e.g. HashMap<K, V>).
290 match this.read_scalar(args[0])?.to_usize(this)? {
291 id if id == sys_getrandom => {
292 // The first argument is the syscall id,
294 linux_getrandom(this, &args[1..], dest)?;
296 id => throw_unsup_format!("miri does not support syscall ID {}", id),
301 linux_getrandom(this, args, dest)?;
305 let _handle = this.read_scalar(args[0])?;
306 let symbol = this.read_scalar(args[1])?.not_undef()?;
307 let symbol_name = this.memory().read_c_str(symbol)?;
308 let err = format!("bad c unicode symbol: {:?}", symbol_name);
309 let symbol_name = ::std::str::from_utf8(symbol_name).unwrap_or(&err);
310 if let Some(dlsym) = Dlsym::from_str(symbol_name)? {
311 let ptr = this.memory_mut().create_fn_alloc(FnVal::Other(dlsym));
312 this.write_scalar(Scalar::from(ptr), dest)?;
314 this.write_null(dest)?;
318 "__rust_maybe_catch_panic" => {
319 // fn __rust_maybe_catch_panic(
322 // data_ptr: *mut usize,
323 // vtable_ptr: *mut usize,
325 // We abort on panic, so not much is going on here, but we still have to call the closure.
326 let f = this.read_scalar(args[0])?.not_undef()?;
327 let data = this.read_scalar(args[1])?.not_undef()?;
328 let f_instance = this.memory().get_fn(f)?.as_instance()?;
329 this.write_null(dest)?;
330 trace!("__rust_maybe_catch_panic: {:?}", f_instance);
332 // Now we make a function call.
333 // TODO: consider making this reusable? `InterpCx::step` does something similar
334 // for the TLS destructors, and of course `eval_main`.
335 let mir = this.load_mir(f_instance.def, None)?;
337 MPlaceTy::dangling(this.layout_of(this.tcx.mk_unit())?, this).into();
338 this.push_stack_frame(
343 // Directly return to caller.
344 StackPopCleanup::Goto(Some(ret)),
346 let mut args = this.frame().body.args_iter();
350 .expect("Argument to __rust_maybe_catch_panic does not take enough arguments.");
351 let arg_dest = this.local_place(arg_local)?;
352 this.write_scalar(data, arg_dest)?;
355 args.next().is_none(),
356 "__rust_maybe_catch_panic argument has more arguments than expected"
359 // We ourselves will return `0`, eventually (because we will not return if we paniced).
360 this.write_null(dest)?;
362 // Don't fall through, we do *not* want to `goto_block`!
367 let left = this.read_scalar(args[0])?.not_undef()?;
368 let right = this.read_scalar(args[1])?.not_undef()?;
369 let n = Size::from_bytes(this.read_scalar(args[2])?.to_usize(this)?);
372 let left_bytes = this.memory().read_bytes(left, n)?;
373 let right_bytes = this.memory().read_bytes(right, n)?;
375 use std::cmp::Ordering::*;
376 match left_bytes.cmp(right_bytes) {
383 this.write_scalar(Scalar::from_int(result, Size::from_bits(32)), dest)?;
387 let ptr = this.read_scalar(args[0])?.not_undef()?;
388 let val = this.read_scalar(args[1])?.to_i32()? as u8;
389 let num = this.read_scalar(args[2])?.to_usize(this)?;
390 if let Some(idx) = this
392 .read_bytes(ptr, Size::from_bytes(num))?
395 .position(|&c| c == val)
397 let new_ptr = ptr.ptr_offset(Size::from_bytes(num - idx as u64 - 1), this)?;
398 this.write_scalar(new_ptr, dest)?;
400 this.write_null(dest)?;
405 let ptr = this.read_scalar(args[0])?.not_undef()?;
406 let val = this.read_scalar(args[1])?.to_i32()? as u8;
407 let num = this.read_scalar(args[2])?.to_usize(this)?;
410 .read_bytes(ptr, Size::from_bytes(num))?
412 .position(|&c| c == val);
413 if let Some(idx) = idx {
414 let new_ptr = ptr.ptr_offset(Size::from_bytes(idx as u64), this)?;
415 this.write_scalar(new_ptr, dest)?;
417 this.write_null(dest)?;
422 let result = this.getenv(args[0])?;
423 this.write_scalar(result, dest)?;
427 let result = this.unsetenv(args[0])?;
428 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
432 let result = this.setenv(args[0], args[1])?;
433 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
437 let result = this.getcwd(args[0], args[1])?;
438 this.write_scalar(result, dest)?;
442 let result = this.chdir(args[0])?;
443 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
446 "open" | "open64" => {
447 let result = this.open(args[0], args[1])?;
448 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
452 let result = this.fcntl(args[0], args[1], args.get(2).cloned())?;
453 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
456 "close" | "close$NOCANCEL" => {
457 let result = this.close(args[0])?;
458 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
462 let result = this.read(args[0], args[1], args[2])?;
463 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
467 let fd = this.read_scalar(args[0])?.to_i32()?;
468 let buf = this.read_scalar(args[1])?.not_undef()?;
469 let n = this.read_scalar(args[2])?.to_usize(&*this.tcx)?;
470 trace!("Called write({:?}, {:?}, {:?})", fd, buf, n);
471 let result = if fd == 1 || fd == 2 {
473 use std::io::{self, Write};
475 let buf_cont = this.memory().read_bytes(buf, Size::from_bytes(n))?;
476 // We need to flush to make sure this actually appears on the screen
477 let res = if fd == 1 {
478 // Stdout is buffered, flush to make sure it appears on the screen.
479 // This is the write() syscall of the interpreted program, we want it
480 // to correspond to a write() syscall on the host -- there is no good
481 // in adding extra buffering here.
482 let res = io::stdout().write(buf_cont);
483 io::stdout().flush().unwrap();
486 // No need to flush, stderr is not buffered.
487 io::stderr().write(buf_cont)
494 this.write(args[0], args[1], args[2])?
496 // Now, `result` is the value we return back to the program.
497 this.write_scalar(Scalar::from_int(result, dest.layout.size), dest)?;
501 let ptr = this.read_scalar(args[0])?.not_undef()?;
502 let n = this.memory().read_c_str(ptr)?.len();
503 this.write_scalar(Scalar::from_uint(n as u64, dest.layout.size), dest)?;
507 "cbrtf" | "coshf" | "sinhf" | "tanf" => {
508 // FIXME: Using host floats.
509 let f = f32::from_bits(this.read_scalar(args[0])?.to_u32()?);
510 let f = match link_name {
517 this.write_scalar(Scalar::from_u32(f.to_bits()), dest)?;
519 // underscore case for windows
520 "_hypotf" | "hypotf" | "atan2f" => {
521 // FIXME: Using host floats.
522 let f1 = f32::from_bits(this.read_scalar(args[0])?.to_u32()?);
523 let f2 = f32::from_bits(this.read_scalar(args[1])?.to_u32()?);
524 let n = match link_name {
525 "_hypotf" | "hypotf" => f1.hypot(f2),
526 "atan2f" => f1.atan2(f2),
529 this.write_scalar(Scalar::from_u32(n.to_bits()), dest)?;
532 "cbrt" | "cosh" | "sinh" | "tan" => {
533 // FIXME: Using host floats.
534 let f = f64::from_bits(this.read_scalar(args[0])?.to_u64()?);
535 let f = match link_name {
542 this.write_scalar(Scalar::from_u64(f.to_bits()), dest)?;
544 // underscore case for windows, here and below
545 // (see https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/floating-point-primitives?view=vs-2019)
546 "_hypot" | "hypot" | "atan2" => {
547 // FIXME: Using host floats.
548 let f1 = f64::from_bits(this.read_scalar(args[0])?.to_u64()?);
549 let f2 = f64::from_bits(this.read_scalar(args[1])?.to_u64()?);
550 let n = match link_name {
551 "_hypot" | "hypot" => f1.hypot(f2),
552 "atan2" => f1.atan2(f2),
555 this.write_scalar(Scalar::from_u64(n.to_bits()), dest)?;
557 // For radix-2 (binary) systems, `ldexp` and `scalbn` are the same.
558 "_ldexp" | "ldexp" | "scalbn" => {
559 let x = this.read_scalar(args[0])?.to_f64()?;
560 let exp = this.read_scalar(args[1])?.to_i32()?;
562 // Saturating cast to i16. Even those are outside the valid exponent range to
563 // `scalbn` below will do its over/underflow handling.
564 let exp = if exp > i16::max_value() as i32 {
566 } else if exp < i16::min_value() as i32 {
569 exp.try_into().unwrap()
572 let res = x.scalbn(exp);
573 this.write_scalar(Scalar::from_f64(res), dest)?;
576 // Some things needed for `sys::thread` initialization to go through.
577 "signal" | "sigaction" | "sigaltstack" => {
578 this.write_scalar(Scalar::from_int(0, dest.layout.size), dest)?;
582 let name = this.read_scalar(args[0])?.to_i32()?;
584 trace!("sysconf() called with name {}", name);
585 // TODO: Cache the sysconf integers via Miri's global cache.
588 &["libc", "_SC_PAGESIZE"],
589 Scalar::from_int(PAGE_SIZE, dest.layout.size),
592 &["libc", "_SC_GETPW_R_SIZE_MAX"],
593 Scalar::from_int(-1, dest.layout.size),
596 &["libc", "_SC_NPROCESSORS_ONLN"],
597 Scalar::from_int(NUM_CPUS, dest.layout.size),
600 let mut result = None;
601 for &(path, path_value) in paths {
602 if let Some(val) = this.eval_path_scalar(path)? {
603 let val = val.to_i32()?;
605 result = Some(path_value);
610 if let Some(result) = result {
611 this.write_scalar(result, dest)?;
613 throw_unsup_format!("Unimplemented sysconf name: {}", name)
617 "sched_getaffinity" => {
618 // Return an error; `num_cpus` then falls back to `sysconf`.
619 this.write_scalar(Scalar::from_int(-1, dest.layout.size), dest)?;
623 this.write_null(dest)?;
626 // Hook pthread calls that go to the thread-local storage memory subsystem.
627 "pthread_key_create" => {
628 let key_ptr = this.read_scalar(args[0])?.not_undef()?;
630 // Extract the function type out of the signature (that seems easier than constructing it ourselves).
631 let dtor = match this.test_null(this.read_scalar(args[1])?.not_undef()?)? {
632 Some(dtor_ptr) => Some(this.memory().get_fn(dtor_ptr)?.as_instance()?),
636 // Figure out how large a pthread TLS key actually is.
637 // This is `libc::pthread_key_t`.
638 let key_type = args[0].layout.ty
640 .ok_or_else(|| err_ub_format!(
641 "wrong signature used for `pthread_key_create`: first argument must be a raw pointer."
644 let key_layout = this.layout_of(key_type)?;
646 // Create key and write it into the memory where `key_ptr` wants it.
647 let key = this.machine.tls.create_tls_key(dtor) as u128;
648 if key_layout.size.bits() < 128 && key >= (1u128 << key_layout.size.bits() as u128)
650 throw_unsup!(OutOfTls);
655 .check_ptr_access(key_ptr, key_layout.size, key_layout.align.abi)?
656 .expect("cannot be a ZST");
657 this.memory_mut().get_mut(key_ptr.alloc_id)?.write_scalar(
660 Scalar::from_uint(key, key_layout.size).into(),
664 // Return success (`0`).
665 this.write_null(dest)?;
667 "pthread_key_delete" => {
668 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
669 this.machine.tls.delete_tls_key(key)?;
670 // Return success (0)
671 this.write_null(dest)?;
673 "pthread_getspecific" => {
674 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
675 let ptr = this.machine.tls.load_tls(key, tcx)?;
676 this.write_scalar(ptr, dest)?;
678 "pthread_setspecific" => {
679 let key = this.read_scalar(args[0])?.to_bits(args[0].layout.size)?;
680 let new_ptr = this.read_scalar(args[1])?.not_undef()?;
681 this.machine.tls.store_tls(key, this.test_null(new_ptr)?)?;
683 // Return success (`0`).
684 this.write_null(dest)?;
687 // Stack size/address stuff.
689 | "pthread_attr_destroy"
691 | "pthread_attr_setstacksize" => {
692 this.write_null(dest)?;
694 "pthread_attr_getstack" => {
695 let addr_place = this.deref_operand(args[1])?;
696 let size_place = this.deref_operand(args[2])?;
699 Scalar::from_uint(STACK_ADDR, addr_place.layout.size),
703 Scalar::from_uint(STACK_SIZE, size_place.layout.size),
707 // Return success (`0`).
708 this.write_null(dest)?;
711 // We don't support threading. (Also for Windows.)
712 "pthread_create" | "CreateThread" => {
713 throw_unsup_format!("Miri does not support threading");
716 // Stub out calls for condvar, mutex and rwlock, to just return `0`.
717 "pthread_mutexattr_init"
718 | "pthread_mutexattr_settype"
719 | "pthread_mutex_init"
720 | "pthread_mutexattr_destroy"
721 | "pthread_mutex_lock"
722 | "pthread_mutex_unlock"
723 | "pthread_mutex_destroy"
724 | "pthread_rwlock_rdlock"
725 | "pthread_rwlock_unlock"
726 | "pthread_rwlock_wrlock"
727 | "pthread_rwlock_destroy"
728 | "pthread_condattr_init"
729 | "pthread_condattr_setclock"
730 | "pthread_cond_init"
731 | "pthread_condattr_destroy"
732 | "pthread_cond_destroy" => {
733 this.write_null(dest)?;
736 // We don't support fork so we don't have to do anything for atfork.
737 "pthread_atfork" => {
738 this.write_null(dest)?;
742 // 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.
743 let addr = this.read_scalar(args[0])?.not_undef()?;
744 this.write_scalar(addr, dest)?;
747 this.write_null(dest)?;
751 "pthread_attr_get_np" | "pthread_getattr_np" => {
752 this.write_null(dest)?;
754 "pthread_get_stackaddr_np" => {
755 let stack_addr = Scalar::from_uint(STACK_ADDR, dest.layout.size);
756 this.write_scalar(stack_addr, dest)?;
758 "pthread_get_stacksize_np" => {
759 let stack_size = Scalar::from_uint(STACK_SIZE, dest.layout.size);
760 this.write_scalar(stack_size, dest)?;
763 // FIXME: register the destructor.
766 this.write_scalar(Scalar::Ptr(this.machine.argc.unwrap()), dest)?;
769 this.write_scalar(Scalar::Ptr(this.machine.argv.unwrap()), dest)?;
771 "SecRandomCopyBytes" => {
772 let len = this.read_scalar(args[1])?.to_usize(this)?;
773 let ptr = this.read_scalar(args[2])?.not_undef()?;
774 this.gen_random(ptr, len as usize)?;
775 this.write_null(dest)?;
778 // Windows API stubs.
780 // DWORD = ULONG = u32
782 "GetProcessHeap" => {
783 // Just fake a HANDLE
784 this.write_scalar(Scalar::from_int(1, this.pointer_size()), dest)?;
787 let _handle = this.read_scalar(args[0])?.to_isize(this)?;
788 let flags = this.read_scalar(args[1])?.to_u32()?;
789 let size = this.read_scalar(args[2])?.to_usize(this)?;
790 let zero_init = (flags & 0x00000008) != 0; // HEAP_ZERO_MEMORY
791 let res = this.malloc(size, zero_init, MiriMemoryKind::WinHeap);
792 this.write_scalar(res, dest)?;
795 let _handle = this.read_scalar(args[0])?.to_isize(this)?;
796 let _flags = this.read_scalar(args[1])?.to_u32()?;
797 let ptr = this.read_scalar(args[2])?.not_undef()?;
798 this.free(ptr, MiriMemoryKind::WinHeap)?;
799 this.write_scalar(Scalar::from_int(1, Size::from_bytes(4)), dest)?;
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 let size = this.read_scalar(args[3])?.to_usize(this)?;
806 let res = this.realloc(ptr, size, MiriMemoryKind::WinHeap)?;
807 this.write_scalar(res, dest)?;
811 this.set_last_error(this.read_scalar(args[0])?.not_undef()?)?;
814 let last_error = this.get_last_error()?;
815 this.write_scalar(last_error, dest)?;
818 "AddVectoredExceptionHandler" => {
819 // Any non zero value works for the stdlib. This is just used for stack overflows anyway.
820 this.write_scalar(Scalar::from_int(1, dest.layout.size), dest)?;
822 "InitializeCriticalSection"
823 | "EnterCriticalSection"
824 | "LeaveCriticalSection"
825 | "DeleteCriticalSection" => {
826 // Nothing to do, not even a return value.
830 | "TryEnterCriticalSection"
831 | "GetConsoleScreenBufferInfo"
832 | "SetConsoleTextAttribute" => {
833 // Pretend these do not exist / nothing happened, by returning zero.
834 this.write_null(dest)?;
837 let system_info = this.deref_operand(args[0])?;
838 let system_info_ptr = this
839 .check_mplace_access(system_info, None)?
840 .expect("cannot be a ZST");
841 // Initialize with `0`.
843 .get_mut(system_info_ptr.alloc_id)?
844 .write_repeat(tcx, system_info_ptr, 0, system_info.layout.size)?;
845 // Set number of processors.
846 let dword_size = Size::from_bytes(4);
847 let offset = 2 * dword_size + 3 * tcx.pointer_size();
849 .get_mut(system_info_ptr.alloc_id)?
852 system_info_ptr.offset(offset, tcx)?,
853 Scalar::from_int(NUM_CPUS, dword_size).into(),
859 // This just creates a key; Windows does not natively support TLS destructors.
861 // Create key and return it.
862 let key = this.machine.tls.create_tls_key(None) as u128;
864 // Figure out how large a TLS key actually is. This is `c::DWORD`.
865 if dest.layout.size.bits() < 128
866 && key >= (1u128 << dest.layout.size.bits() as u128)
868 throw_unsup!(OutOfTls);
870 this.write_scalar(Scalar::from_uint(key, dest.layout.size), dest)?;
873 let key = this.read_scalar(args[0])?.to_u32()? as u128;
874 let ptr = this.machine.tls.load_tls(key, tcx)?;
875 this.write_scalar(ptr, dest)?;
878 let key = this.read_scalar(args[0])?.to_u32()? as u128;
879 let new_ptr = this.read_scalar(args[1])?.not_undef()?;
880 this.machine.tls.store_tls(key, this.test_null(new_ptr)?)?;
882 // Return success (`1`).
883 this.write_scalar(Scalar::from_int(1, dest.layout.size), dest)?;
886 let which = this.read_scalar(args[0])?.to_i32()?;
887 // We just make this the identity function, so we know later in `WriteFile`
889 this.write_scalar(Scalar::from_int(which, this.pointer_size()), dest)?;
892 let handle = this.read_scalar(args[0])?.to_isize(this)?;
893 let buf = this.read_scalar(args[1])?.not_undef()?;
894 let n = this.read_scalar(args[2])?.to_u32()?;
895 let written_place = this.deref_operand(args[3])?;
896 // Spec says to always write `0` first.
897 this.write_null(written_place.into())?;
898 let written = if handle == -11 || handle == -12 {
900 use std::io::{self, Write};
904 .read_bytes(buf, Size::from_bytes(u64::from(n)))?;
905 let res = if handle == -11 {
906 io::stdout().write(buf_cont)
908 io::stderr().write(buf_cont)
910 res.ok().map(|n| n as u32)
912 eprintln!("Miri: Ignored output to handle {}", handle);
913 // Pretend it all went well.
916 // If there was no error, write back how much was written.
917 if let Some(n) = written {
918 this.write_scalar(Scalar::from_u32(n), written_place.into())?;
920 // Return whether this was a success.
922 Scalar::from_int(if written.is_some() { 1 } else { 0 }, dest.layout.size),
926 "GetConsoleMode" => {
927 // Everything is a pipe.
928 this.write_null(dest)?;
930 "GetEnvironmentVariableW" => {
931 // This is not the env var you are looking for.
932 this.set_last_error(Scalar::from_u32(203))?; // ERROR_ENVVAR_NOT_FOUND
933 this.write_null(dest)?;
935 "GetCommandLineW" => {
936 this.write_scalar(Scalar::Ptr(this.machine.cmd_line.unwrap()), dest)?;
938 // The actual name of 'RtlGenRandom'
939 "SystemFunction036" => {
940 let ptr = this.read_scalar(args[0])?.not_undef()?;
941 let len = this.read_scalar(args[1])?.to_u32()?;
942 this.gen_random(ptr, len as usize)?;
943 this.write_scalar(Scalar::from_bool(true), dest)?;
946 // We can't execute anything else.
947 _ => throw_unsup_format!("can't call foreign function: {}", link_name),
950 this.goto_block(Some(ret))?;
951 this.dump_place(*dest);
955 /// Evaluates the scalar at the specified path. Returns Some(val)
956 /// if the path could be resolved, and None otherwise
960 ) -> InterpResult<'tcx, Option<ScalarMaybeUndef<Tag>>> {
961 let this = self.eval_context_mut();
962 if let Ok(instance) = this.resolve_path(path) {
967 let const_val = this.const_eval_raw(cid)?;
968 let const_val = this.read_scalar(const_val.into())?;
969 return Ok(Some(const_val));
974 fn eval_libc(&mut self, name: &str) -> InterpResult<'tcx, Scalar<Tag>> {
975 self.eval_context_mut()
976 .eval_path_scalar(&["libc", name])?
977 .ok_or_else(|| err_unsup_format!("Path libc::{} cannot be resolved.", name).into())
978 .and_then(|scalar| scalar.not_undef())
981 fn eval_libc_i32(&mut self, name: &str) -> InterpResult<'tcx, i32> {
982 self.eval_libc(name).and_then(|scalar| scalar.to_i32())
985 fn set_last_error(&mut self, scalar: Scalar<Tag>) -> InterpResult<'tcx, ()> {
986 let this = self.eval_context_mut();
987 let tcx = &{ this.tcx.tcx };
988 let errno_ptr = this.machine.last_error.unwrap();
989 this.memory_mut().get_mut(errno_ptr.alloc_id)?.write_scalar(
997 fn get_last_error(&mut self) -> InterpResult<'tcx, Scalar<Tag>> {
998 let this = self.eval_context_mut();
999 let tcx = &{ this.tcx.tcx };
1000 let errno_ptr = this.machine.last_error.unwrap();
1002 .get(errno_ptr.alloc_id)?
1003 .read_scalar(tcx, errno_ptr, Size::from_bits(32))?
1008 // Shims the linux 'getrandom()' syscall.
1009 fn linux_getrandom<'tcx>(
1010 this: &mut MiriEvalContext<'_, 'tcx>,
1011 args: &[OpTy<'tcx, Tag>],
1012 dest: PlaceTy<'tcx, Tag>,
1013 ) -> InterpResult<'tcx> {
1014 let ptr = this.read_scalar(args[0])?.not_undef()?;
1015 let len = this.read_scalar(args[1])?.to_usize(this)?;
1017 // The only supported flags are GRND_RANDOM and GRND_NONBLOCK,
1018 // neither of which have any effect on our current PRNG.
1019 let _flags = this.read_scalar(args[2])?.to_i32()?;
1021 this.gen_random(ptr, len as usize)?;
1022 this.write_scalar(Scalar::from_uint(len, dest.layout.size), dest)?;