Skip to content

InitOnce: synchronize with completion when already complete #2641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 17 additions & 18 deletions src/concurrency/init_once.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,11 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
// Wake up everyone.
// need to take the queue to avoid having `this` be borrowed multiple times
for waiter in std::mem::take(&mut init_once.waiters) {
// End of the wait happens-before woken-up thread.
if let Some(data_race) = &this.machine.data_race {
data_race.validate_lock_acquire(
&this.machine.threads.sync.init_onces[id].data_race,
waiter.thread,
);
}

this.unblock_thread(waiter.thread);

// Call callback, with the woken-up thread as `current`.
this.set_active_thread(waiter.thread);
this.init_once_acquire(id);
waiter.callback.call(this)?;
this.set_active_thread(current_thread);
}
Expand All @@ -172,26 +165,17 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
);

// Each complete happens-before the end of the wait
// FIXME: should this really induce synchronization? If we think of it as a lock, then yes,
// but the docs don't talk about such details.
if let Some(data_race) = &this.machine.data_race {
data_race.validate_lock_release(&mut init_once.data_race, current_thread);
}

// Wake up one waiting thread, so they can go ahead and try to init this.
if let Some(waiter) = init_once.waiters.pop_front() {
// End of the wait happens-before woken-up thread.
if let Some(data_race) = &this.machine.data_race {
data_race.validate_lock_acquire(
&this.machine.threads.sync.init_onces[id].data_race,
waiter.thread,
);
}

this.unblock_thread(waiter.thread);

// Call callback, with the woken-up thread as `current`.
this.set_active_thread(waiter.thread);
this.init_once_acquire(id);
waiter.callback.call(this)?;
this.set_active_thread(current_thread);
} else {
Expand All @@ -201,4 +185,19 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {

Ok(())
}

/// Synchronize with the previous completion or failure of an InitOnce.
/// This is required to prevent data races.
#[inline]
fn init_once_acquire(&mut self, id: InitOnceId) {
let this = self.eval_context_mut();
let current_thread = this.get_active_thread();

if let Some(data_race) = &this.machine.data_race {
data_race.validate_lock_acquire(
&this.machine.threads.sync.init_onces[id].data_race,
current_thread,
);
}
}
}
6 changes: 4 additions & 2 deletions src/shims/windows/sync.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,10 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
Box::new(Callback { init_once_id: id, pending_place }),
)
}
InitOnceStatus::Complete =>
this.write_scalar(this.eval_windows("c", "FALSE")?, &pending_place)?,
InitOnceStatus::Complete => {
this.init_once_acquire(id);
this.write_scalar(this.eval_windows("c", "FALSE")?, &pending_place)?;
}
}

// This always succeeds (even if the thread is blocked, we will succeed if we ever unblock).
Expand Down
38 changes: 38 additions & 0 deletions tests/pass/concurrency/windows_init_once.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,46 @@ fn retry_on_fail() {
waiter2.join().unwrap();
}

fn no_data_race_after_complete() {
let mut init_once = null_mut();
let mut pending = 0;

unsafe {
assert_eq!(InitOnceBeginInitialize(&mut init_once, 0, &mut pending, null_mut()), TRUE);
assert_eq!(pending, TRUE);
}

let init_once_ptr = SendPtr(&mut init_once);

let mut place = 0;
let place_ptr = SendPtr(&mut place);

let reader = thread::spawn(move || unsafe {
let mut pending = 0;

assert_eq!(InitOnceBeginInitialize(init_once_ptr.0, 0, &mut pending, null_mut()), TRUE);
assert_eq!(pending, FALSE);
// this should not data race
place_ptr.0.read()
});

unsafe {
// this should not data race
place_ptr.0.write(1);
}

unsafe {
assert_eq!(InitOnceComplete(init_once_ptr.0, 0, null_mut()), TRUE);
}
//println!("complete");

// run reader
assert_eq!(reader.join().unwrap(), 1);
}

fn main() {
single_thread();
block_until_complete();
retry_on_fail();
no_data_race_after_complete();
}