use std::cell::RefCell;
use std::collections::hash_map::Entry;
-use std::convert::TryFrom;
use std::num::TryFromIntError;
-use std::rc::Rc;
use std::time::{Duration, Instant, SystemTime};
use log::trace;
use rustc_data_structures::fx::FxHashMap;
use rustc_hir::def_id::DefId;
use rustc_index::vec::{Idx, IndexVec};
+use rustc_middle::mir::Mutability;
+use crate::concurrency::data_race;
use crate::sync::SynchronizationState;
use crate::*;
impl TryFrom<u64> for ThreadId {
type Error = TryFromIntError;
fn try_from(id: u64) -> Result<Self, Self::Error> {
- u32::try_from(id).map(|id_u32| Self(id_u32))
+ u32::try_from(id).map(Self)
}
}
}
impl ThreadId {
- pub fn to_u32_scalar<'tcx>(&self) -> Scalar<Tag> {
- Scalar::from_u32(u32::try_from(self.0).unwrap())
+ pub fn to_u32_scalar(&self) -> Scalar<Provenance> {
+ Scalar::from_u32(self.0)
}
}
thread_name: Option<Vec<u8>>,
/// The virtual call stack.
- stack: Vec<Frame<'mir, 'tcx, Tag, FrameData<'tcx>>>,
+ stack: Vec<Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>>,
/// The join status.
join_status: ThreadJoinStatus,
/// The temporary used for storing the argument of
/// the call to `miri_start_panic` (the panic payload) when unwinding.
/// This is pointer-sized, and matches the `Payload` type in `src/libpanic_unwind/miri.rs`.
- pub(crate) panic_payload: Option<Scalar<Tag>>,
+ pub(crate) panic_payload: Option<Scalar<Provenance>>,
/// Last OS error location in memory. It is a 32-bit integer.
- pub(crate) last_error: Option<MPlaceTy<'tcx, Tag>>,
+ pub(crate) last_error: Option<MPlaceTy<'tcx, Provenance>>,
}
impl<'mir, 'tcx> Thread<'mir, 'tcx> {
}
}
+impl<'mir, 'tcx> Thread<'mir, 'tcx> {
+ fn new(name: &str) -> Self {
+ let mut thread = Thread::default();
+ thread.thread_name = Some(Vec::from(name.as_bytes()));
+ thread
+ }
+}
+
/// A specific moment in time.
#[derive(Debug)]
pub enum Time {
pub(crate) sync: SynchronizationState,
/// A mapping from a thread-local static to an allocation id of a thread
/// specific allocation.
- thread_local_alloc_ids: RefCell<FxHashMap<(DefId, ThreadId), AllocId>>,
+ thread_local_alloc_ids: RefCell<FxHashMap<(DefId, ThreadId), Pointer<Provenance>>>,
/// A flag that indicates that we should change the active thread.
yield_active_thread: bool,
/// Callbacks that are called once the specified time passes.
fn default() -> Self {
let mut threads = IndexVec::new();
// Create the main thread and add it to the list of threads.
- let mut main_thread = Thread::default();
+ let mut main_thread = Thread::new("main");
// The main thread can *not* be joined on.
main_thread.join_status = ThreadJoinStatus::Detached;
threads.push(main_thread);
Self {
active_thread: ThreadId::new(0),
- threads: threads,
+ threads,
sync: SynchronizationState::default(),
thread_local_alloc_ids: Default::default(),
yield_active_thread: false,
impl<'mir, 'tcx: 'mir> ThreadManager<'mir, 'tcx> {
/// Check if we have an allocation for the given thread local static for the
/// active thread.
- fn get_thread_local_alloc_id(&self, def_id: DefId) -> Option<AllocId> {
+ fn get_thread_local_alloc_id(&self, def_id: DefId) -> Option<Pointer<Provenance>> {
self.thread_local_alloc_ids.borrow().get(&(def_id, self.active_thread)).cloned()
}
- /// Set the allocation id as the allocation id of the given thread local
+ /// Set the pointer for the allocation of the given thread local
/// static for the active thread.
///
/// Panics if a thread local is initialized twice for the same thread.
- fn set_thread_local_alloc_id(&self, def_id: DefId, new_alloc_id: AllocId) {
+ fn set_thread_local_alloc(&self, def_id: DefId, ptr: Pointer<Provenance>) {
self.thread_local_alloc_ids
.borrow_mut()
- .try_insert((def_id, self.active_thread), new_alloc_id)
+ .try_insert((def_id, self.active_thread), ptr)
.unwrap();
}
/// Borrow the stack of the active thread.
- fn active_thread_stack(&self) -> &[Frame<'mir, 'tcx, Tag, FrameData<'tcx>>] {
+ pub fn active_thread_stack(&self) -> &[Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>] {
&self.threads[self.active_thread].stack
}
/// Mutably borrow the stack of the active thread.
- fn active_thread_stack_mut(&mut self) -> &mut Vec<Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
+ fn active_thread_stack_mut(
+ &mut self,
+ ) -> &mut Vec<Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>> {
&mut self.threads[self.active_thread].stack
}
+ pub fn all_stacks(
+ &self,
+ ) -> impl Iterator<Item = &[Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>]> {
+ self.threads.iter().map(|t| &t.stack[..])
+ }
+
/// Create a new thread and returns its id.
fn create_thread(&mut self) -> ThreadId {
let new_thread_id = ThreadId::new(self.threads.len());
}
/// Get the id of the currently active thread.
- fn get_active_thread_id(&self) -> ThreadId {
+ pub fn get_active_thread_id(&self) -> ThreadId {
self.active_thread
}
/// Get the total number of threads that were ever spawn by this program.
- fn get_total_thread_count(&self) -> usize {
+ pub fn get_total_thread_count(&self) -> usize {
self.threads.len()
}
+ /// Get the total of threads that are currently live, i.e., not yet terminated.
+ /// (They might be blocked.)
+ pub fn get_live_thread_count(&self) -> usize {
+ self.threads.iter().filter(|t| !matches!(t.state, ThreadState::Terminated)).count()
+ }
+
/// Has the given thread terminated?
fn has_terminated(&self, thread_id: ThreadId) -> bool {
self.threads[thread_id].state == ThreadState::Terminated
}
+ /// Have all threads terminated?
+ fn have_all_terminated(&self) -> bool {
+ self.threads.iter().all(|thread| thread.state == ThreadState::Terminated)
+ }
+
/// Enable the thread for execution. The thread must be terminated.
fn enable_thread(&mut self, thread_id: ThreadId) {
assert!(self.has_terminated(thread_id));
fn join_thread(
&mut self,
joined_thread_id: ThreadId,
- data_race: &Option<Rc<data_race::GlobalState>>,
+ data_race: Option<&mut data_race::GlobalState>,
) -> InterpResult<'tcx> {
if self.threads[joined_thread_id].join_status != ThreadJoinStatus::Joinable {
throw_ub_format!("trying to join a detached or already joined thread");
} else {
// The thread has already terminated - mark join happens-before
if let Some(data_race) = data_race {
- data_race.thread_joined(self.active_thread, joined_thread_id);
+ data_race.thread_joined(self, self.active_thread, joined_thread_id);
}
}
Ok(())
}
/// Set the name of the active thread.
- fn set_thread_name(&mut self, new_thread_name: Vec<u8>) {
+ fn set_active_thread_name(&mut self, new_thread_name: Vec<u8>) {
self.active_thread_mut().thread_name = Some(new_thread_name);
}
/// Get the name of the active thread.
- fn get_thread_name(&self) -> &[u8] {
+ pub fn get_active_thread_name(&self) -> &[u8] {
self.active_thread_ref().thread_name()
}
+ /// Get the name of the given thread.
+ pub fn get_thread_name(&self, thread: ThreadId) -> &[u8] {
+ self.threads[thread].thread_name()
+ }
+
/// Put the thread into the blocked state.
fn block_thread(&mut self, thread: ThreadId) {
let state = &mut self.threads[thread].state;
}
/// Wakes up threads joining on the active one and deallocates thread-local statics.
- /// The `AllocId` that can now be freed is returned.
+ /// The `AllocId` that can now be freed are returned.
fn thread_terminated(
&mut self,
- data_race: &Option<Rc<data_race::GlobalState>>,
- ) -> Vec<AllocId> {
+ mut data_race: Option<&mut data_race::GlobalState>,
+ ) -> Vec<Pointer<Provenance>> {
let mut free_tls_statics = Vec::new();
{
let mut thread_local_statics = self.thread_local_alloc_ids.borrow_mut();
// Delete this static from the map and from memory.
// We cannot free directly here as we cannot use `?` in this context.
free_tls_statics.push(alloc_id);
- return false;
+ false
});
}
- // Set the thread into a terminated state in the data-race detector
- if let Some(data_race) = data_race {
- data_race.thread_terminated();
+ // Set the thread into a terminated state in the data-race detector.
+ if let Some(ref mut data_race) = data_race {
+ data_race.thread_terminated(self);
}
// Check if we need to unblock any threads.
+ let mut joined_threads = vec![]; // store which threads joined, we'll need it
for (i, thread) in self.threads.iter_enumerated_mut() {
if thread.state == ThreadState::BlockedOnJoin(self.active_thread) {
// The thread has terminated, mark happens-before edge to joining thread
- if let Some(data_race) = data_race {
- data_race.thread_joined(i, self.active_thread);
+ if data_race.is_some() {
+ joined_threads.push(i);
}
trace!("unblocking {:?} because {:?} terminated", i, self.active_thread);
thread.state = ThreadState::Enabled;
}
}
- return free_tls_statics;
+ for &i in &joined_threads {
+ data_race.as_mut().unwrap().thread_joined(self, i, self.active_thread);
+ }
+ free_tls_statics
}
/// Decide which action to take next and on which thread.
/// used in stateless model checkers such as Loom: run the active thread as
/// long as we can and switch only when we have to (the active thread was
/// blocked, terminated, or has explicitly asked to be preempted).
- fn schedule(
- &mut self,
- data_race: &Option<Rc<data_race::GlobalState>>,
- ) -> InterpResult<'tcx, SchedulingAction> {
+ fn schedule(&mut self) -> InterpResult<'tcx, SchedulingAction> {
// Check whether the thread has **just** terminated (`check_terminated`
// checks whether the thread has popped all its stack and if yes, sets
// the thread state to terminated).
// If we get here again and the thread is *still* terminated, there are no more dtors to run.
if self.threads[MAIN_THREAD].state == ThreadState::Terminated {
// The main thread terminated; stop the program.
- if self.threads.iter().any(|thread| thread.state != ThreadState::Terminated) {
- // FIXME: This check should be either configurable or just emit
- // a warning. For example, it seems normal for a program to
- // terminate without waiting for its detached threads to
- // terminate. However, this case is not trivial to support
- // because we also probably do not want to consider the memory
- // owned by these threads as leaked.
- throw_unsup_format!("the main thread terminated without waiting for other threads");
- }
+ // We do *not* run TLS dtors of remaining threads, which seems to match rustc behavior.
return Ok(SchedulingAction::Stop);
}
// This thread and the program can keep going.
return Ok(SchedulingAction::ExecuteTimeoutCallback);
}
// No callbacks scheduled, pick a regular thread to execute.
- // We need to pick a new thread for execution.
- for (id, thread) in self.threads.iter_enumerated() {
+ // The active thread blocked or yielded. So we go search for another enabled thread.
+ // Curcially, we start searching at the current active thread ID, rather than at 0, since we
+ // want to avoid always scheduling threads 0 and 1 without ever making progress in thread 2.
+ //
+ // `skip(N)` means we start iterating at thread N, so we skip 1 more to start just *after*
+ // the active thread. Then after that we look at `take(N)`, i.e., the threads *before* the
+ // active thread.
+ let threads = self
+ .threads
+ .iter_enumerated()
+ .skip(self.active_thread.index() + 1)
+ .chain(self.threads.iter_enumerated().take(self.active_thread.index()));
+ for (id, thread) in threads {
+ debug_assert_ne!(self.active_thread, id);
if thread.state == ThreadState::Enabled {
- if !self.yield_active_thread || id != self.active_thread {
- self.active_thread = id;
- if let Some(data_race) = data_race {
- data_race.thread_set_active(self.active_thread);
- }
- break;
- }
+ self.active_thread = id;
+ break;
}
}
self.yield_active_thread = false;
pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
/// Get a thread-specific allocation id for the given thread-local static.
/// If needed, allocate a new one.
- fn get_or_create_thread_local_alloc_id(
+ fn get_or_create_thread_local_alloc(
&mut self,
def_id: DefId,
- ) -> InterpResult<'tcx, AllocId> {
+ ) -> InterpResult<'tcx, Pointer<Provenance>> {
let this = self.eval_context_mut();
let tcx = this.tcx;
- if let Some(new_alloc_id) = this.machine.threads.get_thread_local_alloc_id(def_id) {
+ if let Some(old_alloc) = this.machine.threads.get_thread_local_alloc_id(def_id) {
// We already have a thread-specific allocation id for this
// thread-local static.
- Ok(new_alloc_id)
+ Ok(old_alloc)
} else {
// We need to allocate a thread-specific allocation id for this
// thread-local static.
throw_unsup_format!("foreign thread-local statics are not supported");
}
let allocation = tcx.eval_static_initializer(def_id)?;
+ let mut allocation = allocation.inner().clone();
+ // This allocation will be deallocated when the thread dies, so it is not in read-only memory.
+ allocation.mutability = Mutability::Mut;
// Create a fresh allocation with this content.
- let new_alloc_id =
- this.memory.allocate_with(allocation.clone(), MiriMemoryKind::Tls.into()).alloc_id;
- this.machine.threads.set_thread_local_alloc_id(def_id, new_alloc_id);
- Ok(new_alloc_id)
+ let new_alloc = this.allocate_raw_ptr(allocation, MiriMemoryKind::Tls.into())?;
+ this.machine.threads.set_thread_local_alloc(def_id, new_alloc);
+ Ok(new_alloc)
}
}
fn create_thread(&mut self) -> ThreadId {
let this = self.eval_context_mut();
let id = this.machine.threads.create_thread();
- if let Some(data_race) = &this.memory.extra.data_race {
- data_race.thread_created(id);
+ if let Some(data_race) = &mut this.machine.data_race {
+ data_race.thread_created(&this.machine.threads, id);
}
id
}
#[inline]
fn join_thread(&mut self, joined_thread_id: ThreadId) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
- let data_race = &this.memory.extra.data_race;
- this.machine.threads.join_thread(joined_thread_id, data_race)?;
+ this.machine.threads.join_thread(joined_thread_id, this.machine.data_race.as_mut())?;
Ok(())
}
#[inline]
fn set_active_thread(&mut self, thread_id: ThreadId) -> ThreadId {
let this = self.eval_context_mut();
- if let Some(data_race) = &this.memory.extra.data_race {
- data_race.thread_set_active(thread_id);
- }
this.machine.threads.set_active_thread_id(thread_id)
}
this.machine.threads.has_terminated(thread_id)
}
+ #[inline]
+ fn have_all_terminated(&self) -> bool {
+ let this = self.eval_context_ref();
+ this.machine.threads.have_all_terminated()
+ }
+
#[inline]
fn enable_thread(&mut self, thread_id: ThreadId) {
let this = self.eval_context_mut();
}
#[inline]
- fn active_thread_stack(&self) -> &[Frame<'mir, 'tcx, Tag, FrameData<'tcx>>] {
+ fn active_thread_stack(&self) -> &[Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>] {
let this = self.eval_context_ref();
this.machine.threads.active_thread_stack()
}
#[inline]
- fn active_thread_stack_mut(&mut self) -> &mut Vec<Frame<'mir, 'tcx, Tag, FrameData<'tcx>>> {
+ fn active_thread_stack_mut(
+ &mut self,
+ ) -> &mut Vec<Frame<'mir, 'tcx, Provenance, FrameData<'tcx>>> {
let this = self.eval_context_mut();
this.machine.threads.active_thread_stack_mut()
}
#[inline]
fn set_active_thread_name(&mut self, new_thread_name: Vec<u8>) {
let this = self.eval_context_mut();
- if let Some(data_race) = &this.memory.extra.data_race {
- if let Ok(string) = String::from_utf8(new_thread_name.clone()) {
- data_race.thread_set_name(this.machine.threads.active_thread, string);
- }
- }
- this.machine.threads.set_thread_name(new_thread_name);
+ this.machine.threads.set_active_thread_name(new_thread_name);
}
#[inline]
'mir: 'c,
{
let this = self.eval_context_ref();
- this.machine.threads.get_thread_name()
+ this.machine.threads.get_active_thread_name()
}
#[inline]
this.machine.threads.yield_active_thread();
}
+ #[inline]
+ fn maybe_preempt_active_thread(&mut self) {
+ use rand::Rng as _;
+
+ let this = self.eval_context_mut();
+ if this.machine.rng.get_mut().gen_bool(this.machine.preemption_rate) {
+ this.yield_active_thread();
+ }
+ }
+
#[inline]
fn register_timeout_callback(
&mut self,
#[inline]
fn schedule(&mut self) -> InterpResult<'tcx, SchedulingAction> {
let this = self.eval_context_mut();
- let data_race = &this.memory.extra.data_race;
- this.machine.threads.schedule(data_race)
+ this.machine.threads.schedule()
}
/// Handles thread termination of the active thread: wakes up threads joining on this one,
#[inline]
fn thread_terminated(&mut self) -> InterpResult<'tcx> {
let this = self.eval_context_mut();
- let data_race = &this.memory.extra.data_race;
- for alloc_id in this.machine.threads.thread_terminated(data_race) {
- let ptr = this.memory.global_base_pointer(alloc_id.into())?;
- this.memory.deallocate(ptr, None, MiriMemoryKind::Tls.into())?;
+ for ptr in this.machine.threads.thread_terminated(this.machine.data_race.as_mut()) {
+ this.deallocate_ptr(ptr.into(), None, MiriMemoryKind::Tls.into())?;
}
Ok(())
}