Skip to content

Avoid SeqCst or static mut in mach_timebase_info and QueryPerformanceFrequency caches #77727

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 4 commits into from
Oct 11, 2020
Merged
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
58 changes: 36 additions & 22 deletions library/std/src/sys/unix/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,7 @@ impl Hash for Timespec {
#[cfg(any(target_os = "macos", target_os = "ios"))]
mod inner {
use crate::fmt;
use crate::mem;
use crate::sync::atomic::{AtomicUsize, Ordering::SeqCst};
use crate::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use crate::sys::cvt;
use crate::sys_common::mul_div_u64;
use crate::time::Duration;
Expand Down Expand Up @@ -233,31 +232,46 @@ mod inner {
}

fn info() -> mach_timebase_info {
static mut INFO: mach_timebase_info = mach_timebase_info { numer: 0, denom: 0 };
static STATE: AtomicUsize = AtomicUsize::new(0);
static INITIALIZED: AtomicBool = AtomicBool::new(false);
static INFO_BITS: AtomicU64 = AtomicU64::new(0);

// If a previous thread has filled in this global INITIALIZED, use that.
if INITIALIZED.load(Ordering::Acquire) {
// The Acquire/Release pair used for INITIALIZED ensures that this
// load can see the corresponding `INFO_BITS` store, despite them
// both being Relaxed.
return info_from_bits(INFO_BITS.load(Ordering::Relaxed));
}

// ... otherwise learn for ourselves ...
extern "C" {
fn mach_timebase_info(info: mach_timebase_info_t) -> kern_return_t;
}

let mut info = info_from_bits(0);
unsafe {
// If a previous thread has filled in this global state, use that.
if STATE.load(SeqCst) == 2 {
return INFO;
}
mach_timebase_info(&mut info);
}

// ... otherwise learn for ourselves ...
let mut info = mem::zeroed();
extern "C" {
fn mach_timebase_info(info: mach_timebase_info_t) -> kern_return_t;
}
// Note: This is racy, but the race is against other threads trying to
// write the same value.
INFO_BITS.store(info_to_bits(info), Ordering::Relaxed);

mach_timebase_info(&mut info);
// The `Release` here "publishes" the store of `INFO_BITS` to other
// threads (which do a `INITIALIZED.load(Acquire)`) despite it being
// read/written w/ `Relaxed`.
INITIALIZED.store(true, Ordering::Release);
info
}

// ... and attempt to be the one thread that stores it globally for
// all other threads
if STATE.compare_exchange(0, 1, SeqCst, SeqCst).is_ok() {
INFO = info;
STATE.store(2, SeqCst);
}
return info;
}
#[inline]
fn info_to_bits(info: mach_timebase_info) -> u64 {
((info.denom as u64) << 32) | (info.numer as u64)
}

#[inline]
fn info_from_bits(bits: u64) -> mach_timebase_info {
mach_timebase_info { numer: bits as u32, denom: (bits >> 32) as u32 }
}
}

Expand Down