1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
use core::sync::atomic::Ordering;
use std::time::SystemTime;
use crate::AtomicOptionDuration;
/// An atomic version of [`Option<std::time::SystemTime>`].
#[repr(transparent)]
pub struct AtomicOptionSystemTime(AtomicOptionDuration);
impl Default for AtomicOptionSystemTime {
/// Equivalent to `Option::<SystemTime>>::None`.
#[inline]
fn default() -> Self {
Self::none()
}
}
impl AtomicOptionSystemTime {
/// Equivalent to atomic version `Option::<SystemTime>>::None`.
///
/// # Examples
///
/// ```rust
/// use atomic_time::AtomicOptionSystemTime;
///
/// let none = AtomicOptionSystemTime::none();
/// assert_eq!(none.load(std::sync::atomic::Ordering::SeqCst), None);
/// ```
#[inline]
pub const fn none() -> Self {
Self(AtomicOptionDuration::new(None))
}
/// Returns the system time corresponding to "now".
///
/// # Examples
/// ```
/// use atomic_time::AtomicOptionSystemTime;
///
/// let sys_time = AtomicOptionSystemTime::now();
/// ```
pub fn now() -> Self {
Self::new(Some(SystemTime::now()))
}
/// Creates a new `AtomicOptionSystemTime` with the given `SystemTime` value.
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
pub fn new(system_time: Option<SystemTime>) -> Self {
Self(AtomicOptionDuration::new(
system_time.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
))
}
/// Loads a value from the atomic system time.
pub fn load(&self, order: Ordering) -> Option<SystemTime> {
self.0.load(order).map(|val| SystemTime::UNIX_EPOCH + val)
}
/// Stores a value into the atomic system time.
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
pub fn store(&self, system_time: Option<SystemTime>, order: Ordering) {
self.0.store(
system_time.map(|val| val.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
order,
)
}
/// Stores a value into the atomic system time, returning the previous value.
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
pub fn swap(&self, system_time: Option<SystemTime>, order: Ordering) -> Option<SystemTime> {
self
.0
.swap(
system_time.map(|val| val.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
order,
)
.map(|val| SystemTime::UNIX_EPOCH + val)
}
/// Stores a value into the atomic system time if the current value is the same as the `current`
/// value.
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
pub fn compare_exchange(
&self,
current: Option<SystemTime>,
new: Option<SystemTime>,
success: Ordering,
failure: Ordering,
) -> Result<Option<SystemTime>, Option<SystemTime>> {
match self.0.compare_exchange(
current.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
new.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
success,
failure,
) {
Ok(duration) => Ok(duration.map(|d| SystemTime::UNIX_EPOCH + d)),
Err(duration) => Err(duration.map(|d| SystemTime::UNIX_EPOCH + d)),
}
}
/// Stores a value into the atomic system time if the current value is the same as the `current`
/// value.
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
pub fn compare_exchange_weak(
&self,
current: Option<SystemTime>,
new: Option<SystemTime>,
success: Ordering,
failure: Ordering,
) -> Result<Option<SystemTime>, Option<SystemTime>> {
match self.0.compare_exchange_weak(
current.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
new.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()),
success,
failure,
) {
Ok(duration) => Ok(duration.map(|d| SystemTime::UNIX_EPOCH + d)),
Err(duration) => Err(duration.map(|d| SystemTime::UNIX_EPOCH + d)),
}
}
/// Fetches the value, and applies a function to it that returns an optional
/// new value. Returns a `Result` of `Ok(previous_value)` if the function returned `Some(_)`, else
/// `Err(previous_value)`.
///
/// Note: This may call the function multiple times if the value has been changed from other threads in
/// the meantime, as long as the function returns `Some(_)`, but the function will have been applied
/// only once to the stored value.
///
/// `fetch_update` takes two [`Ordering`] arguments to describe the memory ordering of this operation.
/// The first describes the required ordering for when the operation finally succeeds while the second
/// describes the required ordering for loads. These correspond to the success and failure orderings of
/// [`compare_exchange`] respectively.
///
/// Using [`Acquire`](Ordering::Acquire) as success ordering makes the store part
/// of this operation [`Relaxed`](Ordering::Relaxed), and using [`Release`](Ordering::Release) makes the final successful load
/// [`Relaxed`](Ordering::Relaxed). The (failed) load ordering can only be [`SeqCst`](Ordering::SeqCst), [`Acquire`](Ordering::Acquire) or [`Relaxed`](Ordering::Release)
/// and must be equivalent to or weaker than the success ordering.
///
/// [`compare_exchange`]: #method.compare_exchange
///
/// # Panics
///
/// If the given `SystemTime` value is earlier than the [`UNIX_EPOCH`](SystemTime::UNIX_EPOCH).
///
/// # Examples
///
/// ```rust
/// use atomic_time::AtomicOptionSystemTime;
/// use std::{time::{Duration, SystemTime}, sync::atomic::Ordering};
///
/// let now = SystemTime::now();
/// let x = AtomicOptionSystemTime::none();
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(None));
/// x.store(Some(now), Ordering::SeqCst);
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x.map(|val| val + Duration::from_secs(1)))), Ok(Some(now)));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x.map(|val| val + Duration::from_secs(1)))), Ok(Some(now + Duration::from_secs(1))));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x.map(|val| val + Duration::from_secs(1)))), Ok(Some(now + Duration::from_secs(2))));
/// assert_eq!(x.load(Ordering::SeqCst), Some(now + Duration::from_secs(3)));
/// ```
pub fn fetch_update<F>(
&self,
set_order: Ordering,
fetch_order: Ordering,
mut f: F,
) -> Result<Option<SystemTime>, Option<SystemTime>>
where
F: FnMut(Option<SystemTime>) -> Option<Option<SystemTime>>,
{
self
.0
.fetch_update(set_order, fetch_order, |duration| {
f(duration.map(|d| SystemTime::UNIX_EPOCH + d))
.map(|system_time| system_time.map(|d| d.duration_since(SystemTime::UNIX_EPOCH).unwrap()))
})
.map(|duration| duration.map(|d| SystemTime::UNIX_EPOCH + d))
.map_err(|duration| duration.map(|d| SystemTime::UNIX_EPOCH + d))
}
/// Returns `true` if operations on values of this type are lock-free.
/// If the compiler or the platform doesn't support the necessary
/// atomic instructions, global locks for every potentially
/// concurrent atomic operation will be used.
///
/// # Examples
/// ```
/// use atomic_time::AtomicOptionSystemTime;
///
/// let is_lock_free = AtomicOptionSystemTime::is_lock_free();
/// ```
#[inline]
pub fn is_lock_free() -> bool {
AtomicOptionDuration::is_lock_free()
}
}
#[cfg(feature = "serde")]
const _: () = {
use serde::{Deserialize, Serialize};
impl Serialize for AtomicOptionSystemTime {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
self.load(Ordering::SeqCst).serialize(serializer)
}
}
impl<'de> Deserialize<'de> for AtomicOptionSystemTime {
fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
Ok(Self::new(Option::<SystemTime>::deserialize(deserializer)?))
}
}
};
#[cfg(test)]
mod tests {
use super::*;
use std::sync::atomic::Ordering;
use std::time::{Duration, SystemTime};
#[test]
fn test_atomic_option_system_time_now() {
let atomic_time = AtomicOptionSystemTime::now();
// Check that the time is not None and close to the current time.
assert!(atomic_time.load(Ordering::SeqCst).is_some());
}
#[test]
fn test_atomic_option_system_time_none() {
let atomic_time = AtomicOptionSystemTime::none();
assert_eq!(atomic_time.load(Ordering::SeqCst), None);
}
#[test]
fn test_atomic_option_system_time_new_and_load() {
let now = SystemTime::now();
let atomic_time = AtomicOptionSystemTime::new(Some(now));
assert_eq!(atomic_time.load(Ordering::SeqCst), Some(now));
}
#[test]
fn test_atomic_option_system_time_store_and_load() {
let now = SystemTime::now();
let after_one_sec = now + Duration::from_secs(1);
let atomic_time = AtomicOptionSystemTime::new(Some(now));
atomic_time.store(Some(after_one_sec), Ordering::SeqCst);
assert_eq!(atomic_time.load(Ordering::SeqCst), Some(after_one_sec));
}
#[test]
fn test_atomic_option_system_time_swap() {
let now = SystemTime::now();
let after_one_sec = now + Duration::from_secs(1);
let atomic_time = AtomicOptionSystemTime::new(Some(now));
let prev_time = atomic_time.swap(Some(after_one_sec), Ordering::SeqCst);
assert_eq!(prev_time, Some(now));
assert_eq!(atomic_time.load(Ordering::SeqCst), Some(after_one_sec));
}
#[test]
fn test_atomic_option_system_time_compare_exchange() {
let now = SystemTime::now();
let after_one_sec = now + Duration::from_secs(1);
let atomic_time = AtomicOptionSystemTime::new(Some(now));
let result = atomic_time.compare_exchange(
Some(now),
Some(after_one_sec),
Ordering::SeqCst,
Ordering::SeqCst,
);
assert!(result.is_ok());
assert_eq!(atomic_time.load(Ordering::SeqCst), Some(after_one_sec));
}
#[test]
fn test_atomic_option_system_time_compare_exchange_weak() {
let now = SystemTime::now();
let after_one_sec = now + Duration::from_secs(1);
let atomic_time = AtomicOptionSystemTime::new(Some(now));
let mut result;
loop {
result = atomic_time.compare_exchange_weak(
Some(now),
Some(after_one_sec),
Ordering::SeqCst,
Ordering::SeqCst,
);
if result.is_ok() || result.unwrap_err() != Some(now) {
break;
}
}
assert!(result.is_ok());
assert_eq!(atomic_time.load(Ordering::SeqCst), Some(after_one_sec));
}
#[test]
fn test_atomic_option_system_time_fetch_update() {
let now = SystemTime::now();
let atomic_time = AtomicOptionSystemTime::new(Some(now));
let result = atomic_time.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |prev| {
Some(prev.map(|val| val + Duration::from_secs(1)))
});
assert!(result.is_ok());
assert_eq!(result.unwrap(), Some(now));
assert_eq!(
atomic_time.load(Ordering::SeqCst),
Some(now + Duration::from_secs(1))
);
}
#[test]
fn test_atomic_option_system_time_thread_safety() {
use std::sync::Arc;
use std::thread;
let atomic_time = Arc::new(AtomicOptionSystemTime::now());
let mut handles = vec![];
// Spawn multiple threads to update the time
for _ in 0..4 {
let atomic_clone = Arc::clone(&atomic_time);
let handle = thread::spawn(move || {
let current = atomic_clone.load(Ordering::SeqCst);
if let Some(current_time) = current {
// Adding 1 second to the current time
let new_time = current_time + Duration::from_secs(1);
atomic_clone.store(Some(new_time), Ordering::SeqCst);
}
});
handles.push(handle);
}
// Wait for all threads to complete
for handle in handles {
handle.join().unwrap();
}
// Verify that the time has been updated
if let Some(updated_time) = atomic_time.load(Ordering::SeqCst) {
assert!(updated_time > SystemTime::now() - Duration::from_secs(4));
} else {
panic!("AtomicOptionSystemTime should not be None");
}
}
#[cfg(feature = "serde")]
#[test]
fn test_atomic_system_time_serde() {
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize)]
struct Test {
time: AtomicOptionSystemTime,
}
let now = SystemTime::now();
let test = Test {
time: AtomicOptionSystemTime::new(Some(now)),
};
let serialized = serde_json::to_string(&test).unwrap();
let deserialized: Test = serde_json::from_str(&serialized).unwrap();
assert_eq!(deserialized.time.load(Ordering::SeqCst), Some(now));
}
}