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
#![doc = include_str!("../README.md")]

use std::sync::{
    atomic::{AtomicBool, Ordering::SeqCst},
    Arc,
};

mod parallel_map;
pub use self::parallel_map::ParallelMap;

mod readahead;
pub use self::readahead::Readahead;

mod parallel_filter;
pub use self::parallel_filter::ParallelFilter;

use lazy_static::lazy_static;

type DefaultThreadPool = rusty_pool::ThreadPool;

lazy_static! {
    static ref DEFAULT_POOL: rusty_pool::ThreadPool = rusty_pool::ThreadPool::new(
        num_cpus::get(),
        rusty_pool::MAX_SIZE,
        std::time::Duration::from_secs(1)
    );
}

/// An interface for any thread pool to be used with parallel iterator
pub trait ThreadPool {
    /// A thread-handle
    ///
    /// ParallelMap and other iterators will hold on to it, until they drop
    type JoinHandle;

    /// Submit a function to the thread pool
    fn submit<F>(&mut self, f: F) -> Self::JoinHandle
    where
        F: FnOnce() + Send + 'static;
}

impl ThreadPool for rusty_pool::ThreadPool {
    type JoinHandle = rusty_pool::JoinHandle<()>;

    fn submit<F>(&mut self, f: F) -> Self::JoinHandle
    where
        F: FnOnce() + Send + 'static,
    {
        self.evaluate(f)
    }
}

/// Extension trait for [`std::iter::Iterator`] bringing parallel operations
///
/// # TODO
///
/// * `parallel_for_each`
/// * `parallel_flat_map`
/// * possibly others
///
/// PRs welcome
pub trait IteratorExt {
    /// Run `map` function in parallel on multiple threads
    ///
    /// Results will be returned in order.
    ///
    /// No worker threads will be started and no items will be pulled unless [`ParallelMap::started`]
    /// was called, or until first time [`ParallelMap`] is pulled for elements with [`ParallelMap::next`].
    /// In that respect, `ParallelMap` behaves like every other iterator and is lazy.
    ///
    /// Default built-in thread pool will be used unless [`ParallelMap::threads`] is used.
    fn parallel_map<F, O>(self, f: F) -> ParallelMap<Self, O, F, DefaultThreadPool>
    where
        Self: Sized,
        Self: Iterator,
        F: FnMut(Self::Item) -> O;

    /// Run `filter` function in parallel on multiple threads
    ///
    /// A wrapper around [`IteratorExt::parallel_map`] really, so it has similiar properties.
    fn parallel_filter<F>(self, f: F) -> ParallelFilter<Self, DefaultThreadPool>
    where
        Self: Sized,
        Self: Iterator + Send,
        F: FnMut(&Self::Item) -> bool + Send + 'static + Clone,
        Self::Item: Send + 'static;

    // Run the current iterator in another thread and return elements
    // through a buffered channel.
    //
    // `buffer_size` defines the size of the output channel connecting
    // current and the inner thread.
    //
    // It's a common mistake to use large channel sizes needlessly
    // in hopes of achieving higher performance. The only benefit
    // large buffer size value provides is smooting out the variance
    // of the inner iterator. The cost - wasting memory. In normal
    // circumstances `0` is recommended.
    fn readahead(self, buffer_size: usize) -> Readahead<Self, DefaultThreadPool>
    where
        Self: Iterator,
        Self: Sized,
        Self: Send + 'static,
        Self::Item: Send + 'static;
}

impl<I> IteratorExt for I
where
    I: Iterator,
{
    fn parallel_map<F, O>(self, f: F) -> ParallelMap<Self, O, F, DefaultThreadPool>
    where
        Self: Sized,
        Self: Iterator,
        F: FnMut(I::Item) -> O,
    {
        ParallelMap::new(self, DEFAULT_POOL.clone(), f)
    }

    fn readahead(self, buffer_size: usize) -> Readahead<Self, DefaultThreadPool>
    where
        Self: Iterator,
        Self: Sized,
        Self: Send + 'static,
        <Self as Iterator>::Item: Send + 'static,
    {
        Readahead::new(self, buffer_size, DEFAULT_POOL.clone())
    }

    fn parallel_filter<F>(self, f: F) -> ParallelFilter<Self, DefaultThreadPool>
    where
        Self: Sized,
        Self: Iterator + Send,
        F: FnMut(&I::Item) -> bool + Send + 'static + Clone,
        <Self as Iterator>::Item: Send + 'static,
    {
        ParallelFilter::new(self, DEFAULT_POOL.clone(), f)
    }
}

struct DropIndicator {
    canceled: bool,
    indicator: Arc<AtomicBool>,
}

impl DropIndicator {
    fn new(indicator: Arc<AtomicBool>) -> Self {
        Self {
            canceled: false,
            indicator,
        }
    }

    fn cancel(mut self) {
        self.canceled = true;
    }
}

impl Drop for DropIndicator {
    fn drop(&mut self) {
        if !self.canceled {
            self.indicator.store(true, SeqCst);
        }
    }
}

#[cfg(test)]
mod tests;