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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
use crate::{error::Error, Node};
use std::collections::{HashMap, HashSet};
use std::ops;
use std::sync::{
    atomic::{AtomicUsize, Ordering},
    Arc, RwLock,
};
use std::thread;
use std::time::Duration;
use tracing::{debug, instrument, span, trace, Level};

const DEFAULT_TIMEOUT: Duration = Duration::from_secs(1);

type DependencySet<I> = Arc<RwLock<HashMap<I, HashSet<I>>>>;

/// Dependency graph resolver
#[derive(Clone, Debug)]
pub struct Resolver<N: Node> {
    timeout: Duration,

    counter: Arc<AtomicUsize>,
    ready_nodes: Vec<N::Inner>,
    /// Map of nodes to their dependencies
    deps: DependencySet<N::Inner>,
    /// Map of nodes to their reverse dependencies.
    ///
    /// Having a map of reverse dependencies speed up the process of looking up
    /// for nodes that are available. When a node is processed, we can look up
    /// its reverse dependencies directly and see which ones were only
    /// depending on that node.
    rdeps: DependencySet<N::Inner>,
    // nodes: Arc<RwLock<HashMap<N::Inner, N>>>,
}

impl<N: Node> Resolver<N> {
    #[instrument(skip(nodes))]
    pub fn new(nodes: &[N]) -> Resolver<N> {
        // Create ready channels
        // These need to be built in advance as processing the nodes will
        // create messages on the channel.

        // Create the resolver
        let mut resolver = Resolver {
            timeout: DEFAULT_TIMEOUT,

            counter: Default::default(),
            ready_nodes: Default::default(),
            // The capacity for deps and rdeps should be equal to the number of
            // nodes.
            deps: Arc::new(RwLock::new(HashMap::with_capacity(nodes.len()))),
            rdeps: Arc::new(RwLock::new(HashMap::with_capacity(nodes.len()))),
        };

        // Inject nodes
        nodes.iter().for_each(|node| resolver.push(node));

        // Return the resolver
        resolver
    }

    #[instrument(skip(self, node))]
    fn push(&mut self, node: &N) {
        // Insert the node in the dependencies map
        {
            self.deps
                .write()
                .unwrap()
                .insert(node.id().clone(), node.deps().clone());
        }

        // The node is immediately available. We can send it on the channel
        // and can skip
        if node.deps().is_empty() {
            self.ready_nodes.push(node.id().clone());
            return;
        }

        // Insert reverse dependencies of the node
        let mut rdeps = self.rdeps.write().unwrap();
        for node_dep in node.deps() {
            if !(*rdeps).contains_key(node_dep) {
                // If the reverse dependency does not exist, create the HashSet
                // in rdeps. Before processing, rdeps should not be bigger than
                // deps.
                let mut dep_rdeps = HashSet::new();
                dep_rdeps.insert(node.id().clone());
                rdeps.insert(node_dep.clone(), dep_rdeps.clone());
            } else {
                let dep_rdeps = rdeps.get_mut(node_dep).unwrap();
                dep_rdeps.insert(node.id().clone());
            }
        }
    }

    /// Sequential iteration over the list of dependencies, in correct
    /// order.
    pub fn for_each<F>(&self, mut func: F) -> Result<(), Error>
    where
        F: ops::FnMut(&N::Inner),
    {
        // Prepare communication channels
        let (node_ready_tx, node_ready_rx) = crossbeam_channel::unbounded::<N::Inner>();

        // Populate channel
        self.ready_nodes
            .iter()
            .for_each(|id| node_ready_tx.send(id.clone()).unwrap());

        loop {
            let span = span!(Level::INFO, "map_loop");
            let _enter = span.enter();
            debug!("Start next iteration");

            // Grab a node ID for work
            let id = match get_next_id::<N>(&node_ready_rx, self.timeout, &self.counter, &self.deps)
            {
                Ok(id) => id,
                Err(Error::EmptyListError) => return Ok(()),
                Err(Error::NoAvailableNodeError) => continue,
                Err(err) => return Err(err),
            };

            // Do work
            func(&id);

            // Remove the node from all reverse dependencies
            let next_nodes = remove_node_id::<N>(id, &self.deps, &self.rdeps)?;

            // Send the next available nodes to the channel.
            next_nodes
                .iter()
                .for_each(|node_id| node_ready_tx.send(node_id.clone()).unwrap());

            // If there are no more nodes, leave the loop
            if self.deps.read().unwrap().is_empty() {
                break;
            }
        }

        Ok(())
    }

    /// Parallel iteration over the list of dependencies, in correct
    /// order.
    pub fn par_for_each<F>(&self, func: &'static F) -> Result<(), Error>
    where
        F: Fn(&N::Inner) + Send + Sync + 'static,
    {
        // Create communication channel for processed nodes
        let (node_ready_tx, node_ready_rx) = crossbeam_channel::unbounded::<N::Inner>();
        let (node_done_tx, node_done_rx) = crossbeam_channel::unbounded::<N::Inner>();

        // Populate channel
        self.ready_nodes
            .iter()
            .for_each(|id| node_ready_tx.send(id.clone()).unwrap());

        // Start worker threads
        let handles: Vec<thread::JoinHandle<Result<(), Error>>> = (0..num_cpus::get())
            .map(|i| -> thread::JoinHandle<Result<(), Error>> {
                // Clone data for injection in the threads
                let deps = self.deps.clone();
                let node_ready_rx = node_ready_rx.clone();
                let node_done_tx = node_done_tx.clone();
                let counter = self.counter.clone();
                let timeout = self.timeout;

                // Spawn worker loop
                thread::spawn(move || {
                    let worker_id = i;
                    loop {
                        let span = span!(Level::DEBUG, "worker_loop", id = worker_id);
                        let _enter = span.enter();
                        debug!("Start next iteration for worker {}", worker_id);

                        // Grab a node ID for work
                        let id = match get_next_id::<N>(&node_ready_rx, timeout, &counter, &deps) {
                            Ok(id) => id,
                            Err(Error::EmptyListError) => return Ok(()),
                            Err(Error::NoAvailableNodeError) => continue,
                            Err(err) => return Err(err),
                        };

                        // Increment the counter
                        counter.fetch_add(1, Ordering::SeqCst);

                        // Do work
                        func(&id);

                        // Send confirmation that the node is processed
                        node_done_tx.send(id).unwrap();

                        // Decrement the counter
                        counter.fetch_sub(1, Ordering::SeqCst);

                        // If there are no more nodes, leave the loop
                        if deps.read().unwrap().is_empty() {
                            break;
                        }
                    }

                    Ok(())
                })
            })
            .collect();

        // Listens on processed node and remove their information
        loop {
            // Grab a processed node ID
            let id = match get_next_id::<N>(&node_done_rx, self.timeout, &self.counter, &self.deps)
            {
                Ok(id) => id,
                Err(Error::EmptyListError) => break,
                Err(Error::NoAvailableNodeError) => continue,
                Err(err) => return Err(err),
            };

            // Remove the node from all reverse dependencies
            let next_nodes = remove_node_id::<N>(id, &self.deps, &self.rdeps)?;

            // Send the next available nodes to the channel.
            next_nodes
                .iter()
                .for_each(|node_id| node_ready_tx.send(node_id.clone()).unwrap());

            // If there are no more nodes, leave the loop
            if self.deps.read().unwrap().is_empty() {
                break;
            }
        }

        // Drop channel
        drop(node_ready_tx);

        // Wait for threads to close
        for handle in handles {
            handle.join().unwrap().unwrap();
        }
        Ok(())
    }
}

/// Retrieve a node from a channel
///
/// # Errors
///
/// This can return one of the follow values from [`depgraph::error::Error`]:
///
/// * `EmptyListError`: there are no more dependencies to process, therefore
///   we cannot retrieve a node ID.
/// * `NoAvailableNodeError`: there are currently no available nodes, but there
///   might be in the future (retriable error).
/// * `ResolveGraphError`: there is probably a circular dependency in the list
///   of nodes, therefore it's not possible to retrieve a new node.
fn get_next_id<N: Node>(
    node_rx: &crossbeam_channel::Receiver<N::Inner>,
    timeout: Duration,
    counter: &Arc<AtomicUsize>,
    deps: &DependencySet<N::Inner>,
) -> Result<N::Inner, Error> {
    let span = span!(Level::TRACE, "next_node_id");
    let _enter = span.enter();
    trace!("Fetching next node ID");

    match node_rx.recv_timeout(timeout) {
        // Node received
        Ok(id) => Ok(id),
        // No node received. However, this could be for
        // multiple reasons:
        //
        // * There are no more nodes to process and we
        //   are done.
        // * Some nodes are still being processed and
        //   we need to wait until they are done.
        // * No nodes are being processed and we have a
        //   circular dependency.
        Err(_) => {
            let deps = deps.read().unwrap();
            let counter_val = counter.load(Ordering::SeqCst);
            if deps.is_empty() {
                Err(Error::EmptyListError)
            } else if counter_val > 0 {
                Err(Error::NoAvailableNodeError)
            } else {
                Err(Error::ResolveGraphError("circular dependency detected"))
            }
        }
    }
}

/// Remove all references to the node ID in the dependencies.
///
fn remove_node_id<N: Node>(
    id: N::Inner,
    deps: &DependencySet<N::Inner>,
    rdeps: &DependencySet<N::Inner>,
) -> Result<Vec<N::Inner>, Error> {
    let rdep_ids = {
        let span = span!(Level::TRACE, "remove_node_id");
        let _enter = span.enter();
        trace!("Fetching reverse dependencies for {}", id);

        match rdeps.read().unwrap().get(&id) {
            Some(node) => node.clone(),
            // If no node depends on a node, it will not appear
            // in rdeps.
            None => Default::default(),
        }
    };

    let span = span!(Level::TRACE, "remove_deps");
    let _enter = span.enter();
    trace!("Removing {} from reverse dependencies", id);

    let mut deps = deps.write().unwrap();
    let next_nodes = rdep_ids
        .iter()
        .filter_map(|rdep_id| {
            let rdep = match deps.get_mut(&rdep_id) {
                Some(rdep) => rdep,
                None => {
                    println!("{:?}", deps);
                    return None;
                }
            };

            rdep.remove(&id);

            if rdep.is_empty() {
                Some(rdep_id.clone())
            } else {
                None
            }
        })
        .collect();

    // Remove the current node from the list of dependencies.
    deps.remove(&id);

    Ok(next_nodes)
}

/// Test suite
#[cfg(test)]
mod tests {
    use super::*;
    use crate::StrNode;

    /// Run against a diamond graph
    ///
    /// ```no_run
    ///   1
    ///  / \
    /// 2   3
    ///  \ /
    ///   4
    /// ```
    #[test]
    fn diamond_graph() {
        let mut n1 = StrNode::new("1");
        let mut n2 = StrNode::new("2");
        let mut n3 = StrNode::new("3");
        let n4 = StrNode::new("4");

        n1.add_dep(n2.id());
        n1.add_dep(n3.id());
        n2.add_dep(n4.id());
        n3.add_dep(n4.id());

        let deps = vec![n1, n2, n3, n4];

        let r = Resolver::new(&deps);
        r.par_for_each(&|_node| {}).unwrap();
    }

    /// 1 000 nodes with 999 depending on one
    #[test]
    fn thousand_graph() {
        let mut nodes: Vec<StrNode> = (0..1000)
            .map(|i| StrNode::new(format!("{}", i).as_str()))
            .collect();
        for i in 1..1000 {
            nodes[i].add_dep(&"0".to_string());
        }

        let r = Resolver::new(&nodes);
        r.par_for_each(&|_node_id| {}).unwrap();
    }

    #[test]
    fn circular_graph() {
        let mut n1 = StrNode::new("1");
        let mut n2 = StrNode::new("2");
        let mut n3 = StrNode::new("3");

        n1.add_dep(n2.id());
        n2.add_dep(n3.id());
        n3.add_dep(n1.id());

        let deps = vec![n1, n2, n3];

        // This should return an exception
        let r = Resolver::new(&deps);
        r.par_for_each(&|node_id| {
            println!("{}", node_id);
        })
        .unwrap_err();
    }
}