/rust/registry/src/index.crates.io-1949cf8c6b5b557f/crossbeam-epoch-0.9.18/src/epoch.rs

Source
//! The global epoch
//!
//! The last bit in this number is unused and is always zero. Every so often the global epoch is
//! incremented, i.e. we say it "advances". A pinned participant may advance the global epoch only
//! if all currently pinned participants have been pinned in the current epoch.
//!
//! If an object became garbage in some epoch, then we can be sure that after two advancements no
//! participant will hold a reference to it. That is the crux of safe memory reclamation.

use crate::primitive::sync::atomic::{AtomicUsize, Ordering};

/// An epoch that can be marked as pinned or unpinned.
///
/// Internally, the epoch is represented as an integer that wraps around at some unspecified point
/// and a flag that represents whether it is pinned or unpinned.
#[derive(Copy, Clone, Default, Debug, Eq, PartialEq)]
pub(crate) struct Epoch {
    /// The least significant bit is set if pinned. The rest of the bits hold the epoch.
    data: usize,
}

impl Epoch {
    /// Returns the starting epoch in unpinned state.
    #[inline]
    pub(crate) fn starting() -> Self {
        Self::default()
    }

    /// Returns the number of epochs `self` is ahead of `rhs`.
    ///
    /// Internally, epochs are represented as numbers in the range `(isize::MIN / 2) .. (isize::MAX
    /// / 2)`, so the returned distance will be in the same interval.
    pub(crate) fn wrapping_sub(self, rhs: Self) -> isize {
        // The result is the same with `(self.data & !1).wrapping_sub(rhs.data & !1) as isize >> 1`,
        // because the possible difference of LSB in `(self.data & !1).wrapping_sub(rhs.data & !1)`
        // will be ignored in the shift operation.
        self.data.wrapping_sub(rhs.data & !1) as isize >> 1
    }

    /// Returns `true` if the epoch is marked as pinned.
    #[inline]
    pub(crate) fn is_pinned(self) -> bool {
        (self.data & 1) == 1
    }

    /// Returns the same epoch, but marked as pinned.
    #[inline]
    pub(crate) fn pinned(self) -> Epoch {
        Epoch {
            data: self.data | 1,
        }
    }

    /// Returns the same epoch, but marked as unpinned.
    #[inline]
    pub(crate) fn unpinned(self) -> Epoch {
        Epoch {
            data: self.data & !1,
        }
    }

    /// Returns the successor epoch.
    ///
    /// The returned epoch will be marked as pinned only if the previous one was as well.
    #[inline]
    pub(crate) fn successor(self) -> Epoch {
        Epoch {
            data: self.data.wrapping_add(2),
        }
    }
}

/// An atomic value that holds an `Epoch`.
#[derive(Default, Debug)]
pub(crate) struct AtomicEpoch {
    /// Since `Epoch` is just a wrapper around `usize`, an `AtomicEpoch` is similarly represented
    /// using an `AtomicUsize`.
    data: AtomicUsize,
}

impl AtomicEpoch {
    /// Creates a new atomic epoch.
    #[inline]
    pub(crate) fn new(epoch: Epoch) -> Self {
        let data = AtomicUsize::new(epoch.data);
        AtomicEpoch { data }
    }

    /// Loads a value from the atomic epoch.
    #[inline]
    pub(crate) fn load(&self, ord: Ordering) -> Epoch {
        Epoch {
            data: self.data.load(ord),
        }
    }

    /// Stores a value into the atomic epoch.
    #[inline]
    pub(crate) fn store(&self, epoch: Epoch, ord: Ordering) {
        self.data.store(epoch.data, ord);
    }

    /// Stores a value into the atomic epoch if the current value is the same as `current`.
    ///
    /// The return value is a result indicating whether the new value was written and containing
    /// the previous value. On success this value is guaranteed to be equal to `current`.
    ///
    /// This method takes two `Ordering` arguments to describe the memory
    /// ordering of this operation. `success` describes the required ordering for the
    /// read-modify-write operation that takes place if the comparison with `current` succeeds.
    /// `failure` describes the required ordering for the load operation that takes place when
    /// the comparison fails. Using `Acquire` as success ordering makes the store part
    /// of this operation `Relaxed`, and using `Release` makes the successful load
    /// `Relaxed`. The failure ordering can only be `SeqCst`, `Acquire` or `Relaxed`
    /// and must be equivalent to or weaker than the success ordering.
    #[inline]
    pub(crate) fn compare_exchange(
        &self,
        current: Epoch,
        new: Epoch,
        success: Ordering,
        failure: Ordering,
    ) -> Result<Epoch, Epoch> {
        match self
            .data
            .compare_exchange(current.data, new.data, success, failure)
        {
            Ok(data) => Ok(Epoch { data }),
            Err(data) => Err(Epoch { data }),
        }
    }
}

Line	Count	Source
1		//! The global epoch
2		//!
3		//! The last bit in this number is unused and is always zero. Every so often the global epoch is
4		//! incremented, i.e. we say it "advances". A pinned participant may advance the global epoch only
5		//! if all currently pinned participants have been pinned in the current epoch.
6		//!
7		//! If an object became garbage in some epoch, then we can be sure that after two advancements no
8		//! participant will hold a reference to it. That is the crux of safe memory reclamation.
9
10		use crate::primitive::sync::atomic::{AtomicUsize, Ordering};
11
12		/// An epoch that can be marked as pinned or unpinned.
13		///
14		/// Internally, the epoch is represented as an integer that wraps around at some unspecified point
15		/// and a flag that represents whether it is pinned or unpinned.
16		#[derive(Copy, Clone, Default, Debug, Eq, PartialEq)]
17		pub(crate) struct Epoch {
18		/// The least significant bit is set if pinned. The rest of the bits hold the epoch.
19		data: usize,
20		}
21
22		impl Epoch {
23		/// Returns the starting epoch in unpinned state.
24		#[inline]
25	3.83G	pub(crate) fn starting() -> Self {
26	3.83G	Self::default()
27	3.83G	}
28
29		/// Returns the number of epochs `self` is ahead of `rhs`.
30		///
31		/// Internally, epochs are represented as numbers in the range `(isize::MIN / 2) .. (isize::MAX
32		/// / 2)`, so the returned distance will be in the same interval.
33	1.71M	pub(crate) fn wrapping_sub(self, rhs: Self) -> isize {
34		// The result is the same with `(self.data & !1).wrapping_sub(rhs.data & !1) as isize >> 1`,
35		// because the possible difference of LSB in `(self.data & !1).wrapping_sub(rhs.data & !1)`
36		// will be ignored in the shift operation.
37	1.71M	self.data.wrapping_sub(rhs.data & !1) as isize >> 1
38	1.71M	}
39
40		/// Returns `true` if the epoch is marked as pinned.
41		#[inline]
42	689M	pub(crate) fn is_pinned(self) -> bool {
43	689M	(self.data & 1) == 1
44	689M	}
45
46		/// Returns the same epoch, but marked as pinned.
47		#[inline]
48	1.91G	pub(crate) fn pinned(self) -> Epoch {
49	1.91G	Epoch {
50	1.91G	data: self.data \| 1,
51	1.91G	}
52	1.91G	}
53
54		/// Returns the same epoch, but marked as unpinned.
55		#[inline]
56	50.5M	pub(crate) fn unpinned(self) -> Epoch {
57	50.5M	Epoch {
58	50.5M	data: self.data & !1,
59	50.5M	}
60	50.5M	}
61
62		/// Returns the successor epoch.
63		///
64		/// The returned epoch will be marked as pinned only if the previous one was as well.
65		#[inline]
66	12.5M	pub(crate) fn successor(self) -> Epoch {
67	12.5M	Epoch {
68	12.5M	data: self.data.wrapping_add(2),
69	12.5M	}
70	12.5M	}
71		}
72
73		/// An atomic value that holds an `Epoch`.
74		#[derive(Default, Debug)]
75		pub(crate) struct AtomicEpoch {
76		/// Since `Epoch` is just a wrapper around `usize`, an `AtomicEpoch` is similarly represented
77		/// using an `AtomicUsize`.
78		data: AtomicUsize,
79		}
80
81		impl AtomicEpoch {
82		/// Creates a new atomic epoch.
83		#[inline]
84	1.22M	pub(crate) fn new(epoch: Epoch) -> Self {
85	1.22M	let data = AtomicUsize::new(epoch.data);
86	1.22M	AtomicEpoch { data }
87	1.22M	}
88
89		/// Loads a value from the atomic epoch.
90		#[inline]
91	2.62G	pub(crate) fn load(&self, ord: Ordering) -> Epoch {
92	2.62G	Epoch {
93	2.62G	data: self.data.load(ord),
94	2.62G	}
95	2.62G	}
96
97		/// Stores a value into the atomic epoch.
98		#[inline]
99	1.92G	pub(crate) fn store(&self, epoch: Epoch, ord: Ordering) {
100	1.92G	self.data.store(epoch.data, ord);
101	1.92G	}
102
103		/// Stores a value into the atomic epoch if the current value is the same as `current`.
104		///
105		/// The return value is a result indicating whether the new value was written and containing
106		/// the previous value. On success this value is guaranteed to be equal to `current`.
107		///
108		/// This method takes two `Ordering` arguments to describe the memory
109		/// ordering of this operation. `success` describes the required ordering for the
110		/// read-modify-write operation that takes place if the comparison with `current` succeeds.
111		/// `failure` describes the required ordering for the load operation that takes place when
112		/// the comparison fails. Using `Acquire` as success ordering makes the store part
113		/// of this operation `Relaxed`, and using `Release` makes the successful load
114		/// `Relaxed`. The failure ordering can only be `SeqCst`, `Acquire` or `Relaxed`
115		/// and must be equivalent to or weaker than the success ordering.
116		#[inline]
117	1.91G	pub(crate) fn compare_exchange(
118	1.91G	&self,
119	1.91G	current: Epoch,
120	1.91G	new: Epoch,
121	1.91G	success: Ordering,
122	1.91G	failure: Ordering,
123	1.91G	) -> Result<Epoch, Epoch> {
124	1.91G	match self
125	1.91G	.data
126	1.91G	.compare_exchange(current.data, new.data, success, failure)
127		{
128	1.91G	Ok(data) => Ok(Epoch { data }),
129	0	Err(data) => Err(Epoch { data }),
130		}
131	1.91G	}
132		}

Coverage Report

Created: 2026-02-14 07:33