diff options
Diffstat (limited to 'src/iter/collect/mod.rs')
-rw-r--r-- | src/iter/collect/mod.rs | 159 |
1 files changed, 51 insertions, 108 deletions
diff --git a/src/iter/collect/mod.rs b/src/iter/collect/mod.rs index 7cbf215..4044a68 100644 --- a/src/iter/collect/mod.rs +++ b/src/iter/collect/mod.rs @@ -1,6 +1,4 @@ -use super::{IndexedParallelIterator, IntoParallelIterator, ParallelExtend, ParallelIterator}; -use std::mem::MaybeUninit; -use std::slice; +use super::{IndexedParallelIterator, ParallelIterator}; mod consumer; use self::consumer::CollectConsumer; @@ -19,7 +17,7 @@ where { v.truncate(0); // clear any old data let len = pi.len(); - Collect::new(v, len).with_consumer(|consumer| pi.drive(consumer)); + collect_with_consumer(v, len, |consumer| pi.drive(consumer)); } /// Collects the results of the iterator into the specified vector. @@ -33,12 +31,12 @@ where /// *any* `ParallelIterator` here, and `CollectConsumer` has to also implement /// `UnindexedConsumer`. That implementation panics `unreachable!` in case /// there's a bug where we actually do try to use this unindexed. -fn special_extend<I, T>(pi: I, len: usize, v: &mut Vec<T>) +pub(super) fn special_extend<I, T>(pi: I, len: usize, v: &mut Vec<T>) where I: ParallelIterator<Item = T>, T: Send, { - Collect::new(v, len).with_consumer(|consumer| pi.drive_unindexed(consumer)); + collect_with_consumer(v, len, |consumer| pi.drive_unindexed(consumer)); } /// Unzips the results of the exact iterator into the specified vectors. @@ -55,9 +53,9 @@ where right.truncate(0); let len = pi.len(); - Collect::new(right, len).with_consumer(|right_consumer| { + collect_with_consumer(right, len, |right_consumer| { let mut right_result = None; - Collect::new(left, len).with_consumer(|left_consumer| { + collect_with_consumer(left, len, |left_consumer| { let (left_r, right_r) = unzip_indexed(pi, left_consumer, right_consumer); right_result = Some(right_r); left_r @@ -66,108 +64,53 @@ where }); } -/// Manage the collection vector. -struct Collect<'c, T: Send> { - vec: &'c mut Vec<T>, - len: usize, -} - -impl<'c, T: Send + 'c> Collect<'c, T> { - fn new(vec: &'c mut Vec<T>, len: usize) -> Self { - Collect { vec, len } - } - - /// Create a consumer on the slice of memory we are collecting into. - /// - /// The consumer needs to be used inside the scope function, and the - /// complete collect result passed back. - /// - /// This method will verify the collect result, and panic if the slice - /// was not fully written into. Otherwise, in the successful case, - /// the vector is complete with the collected result. - fn with_consumer<F>(mut self, scope_fn: F) - where - F: FnOnce(CollectConsumer<'_, T>) -> CollectResult<'_, T>, - { - let slice = Self::reserve_get_tail_slice(&mut self.vec, self.len); - let result = scope_fn(CollectConsumer::new(slice)); - - // The CollectResult represents a contiguous part of the - // slice, that has been written to. - // On unwind here, the CollectResult will be dropped. - // If some producers on the way did not produce enough elements, - // partial CollectResults may have been dropped without - // being reduced to the final result, and we will see - // that as the length coming up short. - // - // Here, we assert that `slice` is fully initialized. This is - // checked by the following assert, which verifies if a - // complete CollectResult was produced; if the length is - // correct, it is necessarily covering the target slice. - // Since we know that the consumer cannot have escaped from - // `drive` (by parametricity, essentially), we know that any - // stores that will happen, have happened. Unless some code is buggy, - // that means we should have seen `len` total writes. - let actual_writes = result.len(); - assert!( - actual_writes == self.len, - "expected {} total writes, but got {}", - self.len, - actual_writes - ); - - // Release the result's mutable borrow and "proxy ownership" - // of the elements, before the vector takes it over. - result.release_ownership(); - - let new_len = self.vec.len() + self.len; - - unsafe { - self.vec.set_len(new_len); - } - } - - /// Reserve space for `len` more elements in the vector, - /// and return a slice to the uninitialized tail of the vector - fn reserve_get_tail_slice(vec: &mut Vec<T>, len: usize) -> &mut [MaybeUninit<T>] { - // Reserve the new space. - vec.reserve(len); - - // TODO: use `Vec::spare_capacity_mut` instead - // SAFETY: `MaybeUninit<T>` is guaranteed to have the same layout - // as `T`, and we already made sure to have the additional space. - let start = vec.len(); - let tail_ptr = vec[start..].as_mut_ptr() as *mut MaybeUninit<T>; - unsafe { slice::from_raw_parts_mut(tail_ptr, len) } - } -} - -/// Extends a vector with items from a parallel iterator. -impl<T> ParallelExtend<T> for Vec<T> +/// Create a consumer on the slice of memory we are collecting into. +/// +/// The consumer needs to be used inside the scope function, and the +/// complete collect result passed back. +/// +/// This method will verify the collect result, and panic if the slice +/// was not fully written into. Otherwise, in the successful case, +/// the vector is complete with the collected result. +fn collect_with_consumer<T, F>(vec: &mut Vec<T>, len: usize, scope_fn: F) where T: Send, + F: FnOnce(CollectConsumer<'_, T>) -> CollectResult<'_, T>, { - fn par_extend<I>(&mut self, par_iter: I) - where - I: IntoParallelIterator<Item = T>, - { - // See the vec_collect benchmarks in rayon-demo for different strategies. - let par_iter = par_iter.into_par_iter(); - match par_iter.opt_len() { - Some(len) => { - // When Rust gets specialization, we can get here for indexed iterators - // without relying on `opt_len`. Until then, `special_extend()` fakes - // an unindexed mode on the promise that `opt_len()` is accurate. - special_extend(par_iter, len, self); - } - None => { - // This works like `extend`, but `Vec::append` is more efficient. - let list = super::extend::collect(par_iter); - self.reserve(super::extend::len(&list)); - for mut vec in list { - self.append(&mut vec); - } - } - } + // Reserve space for `len` more elements in the vector, + vec.reserve(len); + + // Create the consumer and run the callback for collection. + let result = scope_fn(CollectConsumer::appender(vec, len)); + + // The `CollectResult` represents a contiguous part of the slice, that has + // been written to. On unwind here, the `CollectResult` will be dropped. If + // some producers on the way did not produce enough elements, partial + // `CollectResult`s may have been dropped without being reduced to the final + // result, and we will see that as the length coming up short. + // + // Here, we assert that added length is fully initialized. This is checked + // by the following assert, which verifies if a complete `CollectResult` + // was produced; if the length is correct, it is necessarily covering the + // target slice. Since we know that the consumer cannot have escaped from + // `drive` (by parametricity, essentially), we know that any stores that + // will happen, have happened. Unless some code is buggy, that means we + // should have seen `len` total writes. + let actual_writes = result.len(); + assert!( + actual_writes == len, + "expected {} total writes, but got {}", + len, + actual_writes + ); + + // Release the result's mutable borrow and "proxy ownership" + // of the elements, before the vector takes it over. + result.release_ownership(); + + let new_len = vec.len() + len; + + unsafe { + vec.set_len(new_len); } } |