Skip to content
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

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

Merged
merged 4 commits into from
Oct 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
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
56 changes: 33 additions & 23 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::{AtomicU64, Ordering};
use crate::sys::cvt;
use crate::sys_common::mul_div_u64;
use crate::time::Duration;
Expand Down Expand Up @@ -233,31 +232,42 @@ 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);

unsafe {
// If a previous thread has filled in this global state, use that.
if STATE.load(SeqCst) == 2 {
return INFO;
}
// INFO_BITS conceptually is an `Option<mach_timebase_info>`. We can do
// this in 64 bits because we know 0 is never a valid value for the
// `denom` field.
//
// Encoding this as a single `AtomicU64` allows us to use `Relaxed`
// operations, as we are only interested in in the effects on a single
// memory location.
static INFO_BITS: AtomicU64 = AtomicU64::new(0);

// If a previous thread has initialized `INFO_BITS`, use it.
let info_bits = INFO_BITS.load(Ordering::Relaxed);
if info_bits != 0 {
return info_from_bits(info_bits);
}

// ... otherwise learn for ourselves ...
let mut info = mem::zeroed();
extern "C" {
fn mach_timebase_info(info: mach_timebase_info_t) -> kern_return_t;
}
// ... 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 {
mach_timebase_info(&mut 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;
}
INFO_BITS.store(info_to_bits(info), Ordering::Relaxed);
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
36 changes: 17 additions & 19 deletions library/std/src/sys/windows/time.rs
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ fn intervals2dur(intervals: u64) -> Duration {

mod perf_counter {
use super::NANOS_PER_SEC;
use crate::sync::atomic::{AtomicUsize, Ordering::SeqCst};
use crate::sync::atomic::{AtomicU64, Ordering};
use crate::sys::c;
use crate::sys::cvt;
use crate::sys_common::mul_div_u64;
Expand Down Expand Up @@ -197,27 +197,25 @@ mod perf_counter {
}

fn frequency() -> c::LARGE_INTEGER {
static mut FREQUENCY: c::LARGE_INTEGER = 0;
static STATE: AtomicUsize = AtomicUsize::new(0);

// Either the cached result of `QueryPerformanceFrequency` or `0` for
// uninitialized. Storing this as a single `AtomicU64` allows us to use
// `Relaxed` operations, as we are only interested in the effects on a
// single memory location.
static FREQUENCY: AtomicU64 = AtomicU64::new(0);
thomcc marked this conversation as resolved.
Show resolved Hide resolved

let cached = FREQUENCY.load(Ordering::Relaxed);
// If a previous thread has filled in this global state, use that.
if cached != 0 {
return cached as c::LARGE_INTEGER;
}
// ... otherwise learn for ourselves ...
let mut frequency = 0;
unsafe {
// If a previous thread has filled in this global state, use that.
if STATE.load(SeqCst) == 2 {
return FREQUENCY;
}

// ... otherwise learn for ourselves ...
let mut frequency = 0;
cvt(c::QueryPerformanceFrequency(&mut frequency)).unwrap();

// ... 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() {
FREQUENCY = frequency;
STATE.store(2, SeqCst);
}
frequency
}

FREQUENCY.store(frequency as u64, Ordering::Relaxed);
frequency
}

fn query() -> c::LARGE_INTEGER {
Expand Down