//! The `timing` module provides std::time utility functions. use crate::unchecked_div_by_const; use std::sync::atomic::{AtomicU64, Ordering}; use std::time::{Duration, SystemTime, UNIX_EPOCH}; pub fn duration_as_ns(d: &Duration) -> u64 { d.as_secs() .saturating_mul(1_000_000_000) .saturating_add(u64::from(d.subsec_nanos())) } pub fn duration_as_us(d: &Duration) -> u64 { d.as_secs() .saturating_mul(1_000_000) .saturating_add(unchecked_div_by_const!(u64::from(d.subsec_nanos()), 1_000)) } pub fn duration_as_ms(d: &Duration) -> u64 { d.as_secs() .saturating_mul(1000) .saturating_add(unchecked_div_by_const!( u64::from(d.subsec_nanos()), 1_000_000 )) } pub fn duration_as_s(d: &Duration) -> f32 { d.as_secs() as f32 + (d.subsec_nanos() as f32 / 1_000_000_000.0) } pub fn timestamp() -> u64 { let now = SystemTime::now() .duration_since(UNIX_EPOCH) .expect("create timestamp in timing"); duration_as_ms(&now) } pub const SECONDS_PER_YEAR: f64 = 365.242_199 * 24.0 * 60.0 * 60.0; /// from years to slots pub fn years_as_slots(years: f64, tick_duration: &Duration, ticks_per_slot: u64) -> f64 { // slots is years * slots/year years * // slots/year is seconds/year ... SECONDS_PER_YEAR // * (ns/s)/(ns/tick) / ticks/slot = 1/s/1/tick = ticks/s * (1_000_000_000.0 / duration_as_ns(tick_duration) as f64) // / ticks/slot / ticks_per_slot as f64 } /// From slots per year to slot duration pub fn slot_duration_from_slots_per_year(slots_per_year: f64) -> Duration { // Recently, rust changed from infinity as usize being zero to 2^64-1; ensure it's zero here let slot_in_ns = if slots_per_year != 0.0 { (SECONDS_PER_YEAR * 1_000_000_000.0) / slots_per_year } else { 0.0 }; Duration::from_nanos(slot_in_ns as u64) } #[derive(Debug, Default)] pub struct AtomicInterval { last_update: AtomicU64, } impl AtomicInterval { pub fn should_update(&self, interval_time: u64) -> bool { self.should_update_ext(interval_time, true) } pub fn should_update_ext(&self, interval_time: u64, skip_first: bool) -> bool { let now = timestamp(); let last = self.last_update.load(Ordering::Relaxed); now.saturating_sub(last) > interval_time && self .last_update .compare_exchange(last, now, Ordering::Relaxed, Ordering::Relaxed) == Ok(last) && !(skip_first && last == 0) } } #[cfg(test)] mod test { use super::*; #[test] fn test_interval_update() { solana_logger::setup(); let i = AtomicInterval::default(); assert!(!i.should_update(1000)); let i = AtomicInterval::default(); assert!(i.should_update_ext(1000, false)); std::thread::sleep(Duration::from_millis(10)); assert!(i.should_update(9)); assert!(!i.should_update(100)); } #[test] #[allow(clippy::float_cmp)] fn test_years_as_slots() { let tick_duration = Duration::from_micros(1000 * 1000 / 160); // interestingly large numbers with 160 ticks/second assert_eq!(years_as_slots(0.0, &tick_duration, 4) as u64, 0); assert_eq!( years_as_slots(1.0 / 12f64, &tick_duration, 4) as u64, 105_189_753 ); assert_eq!(years_as_slots(1.0, &tick_duration, 4) as u64, 1_262_277_039); let tick_duration = Duration::from_micros(1000 * 1000); // one second in years with one tick per second + one tick per slot assert_eq!( years_as_slots(1.0 / SECONDS_PER_YEAR, &tick_duration, 1), 1.0 ); } #[test] fn test_slot_duration_from_slots_per_year() { let slots_per_year = 1_262_277_039.0; let ticks_per_slot = 4; assert_eq!( slot_duration_from_slots_per_year(slots_per_year), Duration::from_micros(1000 * 1000 / 160) * ticks_per_slot ); assert_eq!( slot_duration_from_slots_per_year(0.0), Duration::from_micros(0) * ticks_per_slot ); let slots_per_year = SECONDS_PER_YEAR; let ticks_per_slot = 1; assert_eq!( slot_duration_from_slots_per_year(slots_per_year), Duration::from_millis(1000) * ticks_per_slot ); } }