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
use crate::{
iter::{
atomic_counter::AtomicCounter,
atomic_iter::AtomicIter,
buffered::{buffered_iter::BufferedIter, iter::BufferIter},
},
next::NextChunk,
ConcurrentIter, Next,
};
use std::{
cell::UnsafeCell,
cmp::Ordering,
sync::atomic::{self, AtomicBool},
};
/// A regular `Iter: Iterator` ascended to the concurrent programs with use of atomics.
///
/// Since `ConIterOfIter` can wrap up any `Iterator` and enable concurrent iteration,
/// it might be considered as the most general `ConcurrentIter` implementation.
///
/// In performance critical scenarios and whenever possible, it might be preferable to use a more specific implementation such as [`crate::ConIterOfSlice`].
#[derive(Debug)]
pub struct ConIterOfIter<T: Send + Sync, Iter>
where
Iter: Iterator<Item = T>,
{
iter: UnsafeCell<Iter>,
reserved_counter: AtomicCounter,
yielded_counter: AtomicCounter,
completed: AtomicBool,
}
impl<T: Send + Sync, Iter> ConIterOfIter<T, Iter>
where
Iter: Iterator<Item = T>,
{
/// Creates a concurrent iterator for the given `iter`.
pub fn new(iter: Iter) -> Self {
Self {
iter: iter.into(),
reserved_counter: AtomicCounter::new(),
yielded_counter: AtomicCounter::new(),
completed: false.into(),
}
}
#[inline(always)]
#[allow(clippy::mut_from_ref)]
pub(crate) unsafe fn mut_iter(&self) -> &mut Iter {
unsafe { &mut *self.iter.get() }
}
#[inline(always)]
pub(crate) fn progress_yielded_counter(&self, num_yielded: usize) -> usize {
self.yielded_counter.fetch_and_add(num_yielded)
}
}
impl<T: Send + Sync, Iter> From<Iter> for ConIterOfIter<T, Iter>
where
Iter: Iterator<Item = T>,
{
fn from(iter: Iter) -> Self {
Self::new(iter)
}
}
impl<T: Send + Sync, Iter> AtomicIter<T> for ConIterOfIter<T, Iter>
where
Iter: Iterator<Item = T>,
{
#[inline(always)]
fn counter(&self) -> &AtomicCounter {
&self.reserved_counter
}
#[inline(always)]
fn progress_and_get_begin_idx(&self, number_to_fetch: usize) -> Option<usize> {
let begin_idx = self.counter().fetch_and_add(number_to_fetch);
loop {
let yielded_count = self.yielded_counter.current();
match begin_idx.cmp(&yielded_count) {
// begin_idx==yielded_count => it is our job to provide the items
Ordering::Equal => return Some(begin_idx),
Ordering::Less => return None,
// begin_idx > yielded_count => we need the other items to be yielded
Ordering::Greater => {
if self.completed.load(atomic::Ordering::Relaxed) {
return None;
}
}
}
}
}
fn get(&self, item_idx: usize) -> Option<T> {
loop {
let yielded_count = self.yielded_counter.current();
match item_idx.cmp(&yielded_count) {
// item_idx==yielded_count => it is our job to provide the item
Ordering::Equal => {
// SAFETY: no other thread has the valid condition to iterate, they are waiting
let next = unsafe { self.mut_iter() }.next();
match next.is_some() {
true => {
_ = self.yielded_counter.fetch_and_increment();
}
false => self.completed.store(true, atomic::Ordering::SeqCst),
};
return next;
}
Ordering::Less => return None,
// item_idx > yielded_count => we need the other items to be yielded
Ordering::Greater => {
if self.completed.load(atomic::Ordering::Relaxed) {
return None;
}
}
}
}
}
fn fetch_n(&self, n: usize) -> Option<NextChunk<T, impl ExactSizeIterator<Item = T>>> {
self.progress_and_get_begin_idx(n).and_then(|begin_idx| {
// SAFETY: no other thread has the valid condition to iterate, they are waiting
let iter = unsafe { self.mut_iter() };
let end_idx = begin_idx + n;
let buffer = (begin_idx..end_idx)
.map(|_| iter.next())
.take_while(|x| x.is_some())
.map(|x| x.expect("is_some is checked"))
.collect::<Vec<_>>();
match buffer.len() {
0 => {
self.completed.store(true, atomic::Ordering::SeqCst);
let older_count = self.progress_yielded_counter(n);
assert_eq!(older_count, begin_idx);
None
}
_ => {
let values = buffer.into_iter();
let older_count = self.progress_yielded_counter(n);
assert_eq!(older_count, begin_idx);
Some(NextChunk { begin_idx, values })
}
}
})
}
fn early_exit(&self) {
self.counter().store(usize::MAX);
self.completed.store(true, atomic::Ordering::SeqCst);
}
}
unsafe impl<T: Send + Sync, Iter> Sync for ConIterOfIter<T, Iter> where Iter: Iterator<Item = T> {}
unsafe impl<T: Send + Sync, Iter> Send for ConIterOfIter<T, Iter> where Iter: Iterator<Item = T> {}
// AtomicIter -> ConcurrentIter
impl<T: Send + Sync, Iter> ConcurrentIter for ConIterOfIter<T, Iter>
where
Iter: Iterator<Item = T>,
{
type Item = T;
type BufferedIter = BufferIter<T, Iter>;
type SeqIter = Iter;
/// Converts the concurrent iterator back to the original wrapped type which is the source of the elements to be iterated.
/// Already progressed elements are skipped.
///
/// # Examples
///
/// ```rust
/// use orx_concurrent_iter::*;
///
/// let iter = (0..1024).map(|x| x.to_string());
/// let con_iter = iter.into_con_iter();
///
/// std::thread::scope(|s| {
/// s.spawn(|| {
/// for _ in 0..42 {
/// _ = con_iter.next();
/// }
///
/// let mut buffered = con_iter.buffered_iter(32);
/// let _chunk = buffered.next().unwrap();
/// });
/// });
///
/// let num_used = 42 + 32;
///
/// // converts the remaining elements into a sequential iterator
/// let seq_iter = con_iter.into_seq_iter();
///
/// assert_eq!(seq_iter.len(), 1024 - num_used);
/// for (i, x) in seq_iter.enumerate() {
/// assert_eq!(x, (num_used + i).to_string());
/// }
/// ```
fn into_seq_iter(self) -> Self::SeqIter {
self.iter.into_inner()
}
#[inline(always)]
fn next_id_and_value(&self) -> Option<Next<Self::Item>> {
self.fetch_one()
}
#[inline(always)]
fn next_chunk(
&self,
chunk_size: usize,
) -> Option<NextChunk<Self::Item, impl ExactSizeIterator<Item = Self::Item>>> {
self.fetch_n(chunk_size)
}
fn buffered_iter(&self, chunk_size: usize) -> BufferedIter<Self::Item, Self::BufferedIter> {
let buffered_iter = Self::BufferedIter::new(chunk_size);
BufferedIter::new(buffered_iter, self)
}
#[inline(always)]
fn try_get_len(&self) -> Option<usize> {
match self.completed.load(atomic::Ordering::SeqCst) {
true => Some(0),
false => None,
}
}
fn skip_to_end(&self) {
self.early_exit()
}
}