Merge pull request #481 from moka-rs/increase-time-accuracy

Replace most uses of `quanta::Instant` with `std::time::Instant` to increase the accuracy of time measurements

Author: tatsuya6502

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Changed
 
+- Replaced most uses of `quanta::Instant` with `std::time::Instant` to increase the
+  accuracy of time measurements. ([#481][gh-pull-0481])
 - Switched to `AtomicU64` of `portable-atomic` crate for the platforms where
   `AtomicU64` is not available in `std`. ([#480][gh-pull-0480])
     - `moka`'s `atomic64` feature no longer has any effect on the build as
@@ -948,6 +950,7 @@ The minimum supported Rust version (MSRV) is now 1.51.0 (Mar 25, 2021).
 [gh-issue-0034]: https://github.com/moka-rs/moka/issues/34/
 [gh-issue-0031]: https://github.com/moka-rs/moka/issues/31/
 
+[gh-pull-0481]: https://github.com/moka-rs/moka/pull/481/
 [gh-pull-0480]: https://github.com/moka-rs/moka/pull/480/
 [gh-pull-0474]: https://github.com/moka-rs/moka/pull/474/
 [gh-pull-0466]: https://github.com/moka-rs/moka/pull/466/

src/common/concurrent.rs

@@ -12,13 +12,6 @@ pub(crate) mod entry_info;
 #[cfg(feature = "sync")]
 pub(crate) mod housekeeper;
 
-#[cfg_attr(feature = "quanta", path = "concurrent/atomic_time/atomic_time.rs")]
-#[cfg_attr(
-    not(feature = "quanta"),
-    path = "concurrent/atomic_time/atomic_time_compat.rs"
-)]
-pub(crate) mod atomic_time;
-
 #[cfg(feature = "unstable-debug-counters")]
 pub(crate) mod debug_counters;
 

src/common/concurrent/atomic_time/atomic_time.rs

@@ -1,7 +1,7 @@
 use std::sync::atomic::{self, AtomicBool, AtomicU16, AtomicU32, Ordering};
 
 use super::{AccessTime, KeyHash};
-use crate::common::{concurrent::atomic_time::AtomicInstant, time::Instant};
+use crate::common::time::{AtomicInstant, Instant};
 
 #[derive(Debug)]
 pub(crate) struct EntryInfo<K> {
@@ -191,7 +191,6 @@ mod test {
         // e.g. "1.64"
         let ver =
             option_env!("RUSTC_SEMVER").expect("RUSTC_SEMVER env var was not set at compile time");
-        let is_quanta_enabled = cfg!(feature = "quanta");
         let arch = if cfg!(target_os = "linux") {
             if cfg!(target_pointer_width = "64") {
                 Linux64
@@ -214,14 +213,10 @@ mod test {
             panic!("Unsupported target architecture");
         };
 
-        let expected_sizes = match (arch, is_quanta_enabled) {
-            (Linux64 | Linux32Arm | Linux32Mips, true) => vec![("1.51", 56)],
-            (Linux32X86, true) => vec![("1.51", 48)],
-            (MacOS64, true) => vec![("1.62", 56)],
-            (Linux64, false) => vec![("1.66", 104), ("1.60", 128)],
-            (Linux32X86, false) => unimplemented!(),
-            (Linux32Arm | Linux32Mips, false) => vec![("1.66", 104), ("1.62", 128), ("1.60", 80)],
-            (MacOS64, false) => vec![("1.62", 104)],
+        let expected_sizes = match arch {
+            Linux64 | Linux32Arm | Linux32Mips => vec![("1.51", 56)],
+            Linux32X86 => vec![("1.51", 48)],
+            MacOS64 => vec![("1.62", 56)],
         };
 
         let mut expected = None;

src/common/concurrent/atomic_time/atomic_time_compat.rs

@@ -1,10 +1,7 @@
 use super::constants::LOG_SYNC_INTERVAL_MILLIS;
 
-use super::{
-    atomic_time::AtomicInstant,
-    constants::{READ_LOG_FLUSH_POINT, WRITE_LOG_FLUSH_POINT},
-};
-use crate::common::time::{CheckedTimeOps, Instant};
+use super::constants::{READ_LOG_FLUSH_POINT, WRITE_LOG_FLUSH_POINT};
+use crate::common::time::{AtomicInstant, Instant};
 use crate::common::HousekeeperConfig;
 
 use parking_lot::{Mutex, MutexGuard};
@@ -52,7 +49,11 @@ pub(crate) struct Housekeeper {
 }
 
 impl Housekeeper {
-    pub(crate) fn new(is_eviction_listener_enabled: bool, config: HousekeeperConfig) -> Self {
+    pub(crate) fn new(
+        is_eviction_listener_enabled: bool,
+        config: HousekeeperConfig,
+        now: Instant,
+    ) -> Self {
         let (more_entries_to_evict, maintenance_task_timeout) = if is_eviction_listener_enabled {
             (
                 Some(AtomicBool::new(false)),
@@ -64,7 +65,7 @@ impl Housekeeper {
 
         Self {
             run_lock: Mutex::default(),
-            run_after: AtomicInstant::new(Self::sync_after(Instant::now())),
+            run_after: AtomicInstant::new(Self::sync_after(now)),
             more_entries_to_evict,
             maintenance_task_timeout,
             max_log_sync_repeats: config.max_log_sync_repeats,
@@ -127,10 +128,7 @@ impl Housekeeper {
 
     fn sync_after(now: Instant) -> Instant {
         let dur = Duration::from_millis(LOG_SYNC_INTERVAL_MILLIS);
-        let ts = now.checked_add(dur);
-        // Assuming that `now` is current wall clock time, this should never fail at
-        // least next millions of years.
-        ts.expect("Timestamp overflow")
+        now.saturating_add(dur)
     }
 }
 
@@ -139,8 +137,4 @@ impl Housekeeper {
     pub(crate) fn disable_auto_run(&self) {
         self.auto_run_enabled.store(false, Ordering::Relaxed);
     }
-
-    pub(crate) fn reset_run_after(&self, now: Instant) {
-        self.run_after.set_instant(Self::sync_after(now));
-    }
 }

src/common/concurrent/entry_info.rs

@@ -1,53 +1,10 @@
-use std::time::Duration;
-
-#[cfg_attr(feature = "quanta", path = "time/clock_quanta.rs")]
-#[cfg_attr(not(feature = "quanta"), path = "time/clock_compat.rs")]
-pub(crate) mod clock;
+mod atomic_time;
+mod clock;
+mod instant;
 
+pub(crate) use atomic_time::AtomicInstant;
 pub(crate) use clock::Clock;
+pub(crate) use instant::Instant;
 
 #[cfg(test)]
 pub(crate) use clock::Mock;
-
-/// a wrapper type over Instant to force checked additions and prevent
-/// unintentional overflow. The type preserve the Copy semantics for the wrapped
-#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug)]
-pub(crate) struct Instant(clock::Instant);
-
-pub(crate) trait CheckedTimeOps {
-    fn checked_add(&self, duration: Duration) -> Option<Self>
-    where
-        Self: Sized;
-
-    fn checked_duration_since(&self, earlier: Self) -> Option<Duration>
-    where
-        Self: Sized;
-}
-
-impl Instant {
-    pub(crate) fn new(instant: clock::Instant) -> Instant {
-        Instant(instant)
-    }
-
-    pub(crate) fn now() -> Instant {
-        Instant(clock::Instant::now())
-    }
-
-    #[cfg(feature = "quanta")]
-    pub(crate) fn inner_clock(self) -> clock::Instant {
-        self.0
-    }
-}
-
-impl CheckedTimeOps for Instant {
-    fn checked_add(&self, duration: Duration) -> Option<Instant> {
-        self.0.checked_add(duration).map(Instant)
-    }
-
-    fn checked_duration_since(&self, earlier: Self) -> Option<Duration>
-    where
-        Self: Sized,
-    {
-        self.0.checked_duration_since(earlier.0)
-    }
-}

src/common/concurrent/housekeeper.rs

@@ -0,0 +1,62 @@
+use crate::common::time::Instant;
+
+use portable_atomic::AtomicU64;
+use std::sync::atomic::Ordering;
+
+/// `AtomicInstant` is a wrapper around `AtomicU64` that provides thread-safe access
+/// to an `Instant`.
+///
+/// `u64::MAX` is used to represent an unset `Instant`.
+#[derive(Debug)]
+pub(crate) struct AtomicInstant {
+    instant: AtomicU64,
+}
+
+impl Default for AtomicInstant {
+    /// Creates a new `AtomicInstant` with an unset `Instant`.
+    fn default() -> Self {
+        Self {
+            instant: AtomicU64::new(u64::MAX),
+        }
+    }
+}
+
+impl AtomicInstant {
+    /// Creates a new `AtomicInstant` with the given `Instant`.
+    pub(crate) fn new(instant: Instant) -> Self {
+        // Ensure the `Instant` is not `u64::MAX`, which means unset.
+        debug_assert!(instant.as_nanos() != u64::MAX);
+
+        Self {
+            instant: AtomicU64::new(instant.as_nanos()),
+        }
+    }
+
+    /// Clears the `Instant`.
+    pub(crate) fn clear(&self) {
+        self.instant.store(u64::MAX, Ordering::Release);
+    }
+
+    /// Returns `true` if the `Instant` is set.
+    pub(crate) fn is_set(&self) -> bool {
+        self.instant.load(Ordering::Acquire) != u64::MAX
+    }
+
+    /// Returns the `Instant` if it is set, otherwise `None`.
+    pub(crate) fn instant(&self) -> Option<Instant> {
+        let ts = self.instant.load(Ordering::Acquire);
+        if ts == u64::MAX {
+            None
+        } else {
+            Some(Instant::from_nanos(ts))
+        }
+    }
+
+    /// Sets the `Instant`.
+    pub(crate) fn set_instant(&self, instant: Instant) {
+        // Ensure the `Instant` is not `u64::MAX`, which means unset.
+        debug_assert!(instant.as_nanos() != u64::MAX);
+
+        self.instant.store(instant.as_nanos(), Ordering::Release);
+    }
+}