wzp
2021-05-13 7d694a9113118daec5be7ac224dab46a3b20f106
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
/*
 * vasync.js: utilities for observable asynchronous control flow
 */
 
var mod_assert = require('assert');
var mod_events = require('events');
var mod_util = require('util');
var mod_verror = require('verror');
 
/*
 * Public interface
 */
exports.parallel = parallel;
exports.forEachParallel = forEachParallel;
exports.pipeline = pipeline;
exports.tryEach = tryEach;
exports.forEachPipeline = forEachPipeline;
exports.filter = filter;
exports.filterLimit = filterLimit;
exports.filterSeries = filterSeries;
exports.whilst = whilst;
exports.queue = queue;
exports.queuev = queuev;
exports.barrier = barrier;
exports.waterfall = waterfall;
 
if (!global.setImmediate) {
    global.setImmediate = function (func) {
        var args = Array.prototype.slice.call(arguments, 1);
        args.unshift(0);
        args.unshift(func);
        setTimeout.apply(this, args);
    };
}
 
/*
 * This is incorporated here from jsprim because jsprim ends up pulling in a lot
 * of dependencies.  If we end up needing more from jsprim, though, we should
 * add it back and rip out this function.
 */
function isEmpty(obj)
{
    var key;
    for (key in obj)
        return (false);
    return (true);
}
 
/*
 * Given a set of functions that complete asynchronously using the standard
 * callback(err, result) pattern, invoke them all and merge the results.  See
 * README.md for details.
 */
function parallel(args, callback)
{
    var funcs, rv, doneOne, i;
 
    mod_assert.equal(typeof (args), 'object', '"args" must be an object');
    mod_assert.ok(Array.isArray(args['funcs']),
        '"args.funcs" must be specified and must be an array');
    mod_assert.equal(typeof (callback), 'function',
        'callback argument must be specified and must be a function');
 
    funcs = args['funcs'].slice(0);
 
    rv = {
        'operations': new Array(funcs.length),
        'successes': [],
        'ndone': 0,
        'nerrors': 0
    };
 
    if (funcs.length === 0) {
        setImmediate(function () { callback(null, rv); });
        return (rv);
    }
 
    doneOne = function (entry) {
        return (function (err, result) {
            mod_assert.equal(entry['status'], 'pending');
 
            entry['err'] = err;
            entry['result'] = result;
            entry['status'] = err ? 'fail' : 'ok';
 
            if (err)
                rv['nerrors']++;
            else
                rv['successes'].push(result);
 
            if (++rv['ndone'] < funcs.length)
                return;
 
            var errors = rv['operations'].filter(function (ent) {
                return (ent['status'] == 'fail');
            }).map(function (ent) { return (ent['err']); });
 
            if (errors.length > 0)
                callback(new mod_verror.MultiError(errors), rv);
            else
                callback(null, rv);
        });
    };
 
    for (i = 0; i < funcs.length; i++) {
        rv['operations'][i] = {
            'func': funcs[i],
            'funcname': funcs[i].name || '(anon)',
            'status': 'pending'
        };
 
        funcs[i](doneOne(rv['operations'][i]));
    }
 
    return (rv);
}
 
/*
 * Exactly like parallel, except that the input is specified as a single
 * function to invoke on N different inputs (rather than N functions).  "args"
 * must have the following fields:
 *
 *    func        asynchronous function to invoke on each input value
 *
 *    inputs        array of input values
 */
function forEachParallel(args, callback)
{
    var func, funcs;
 
    mod_assert.equal(typeof (args), 'object', '"args" must be an object');
    mod_assert.equal(typeof (args['func']), 'function',
        '"args.func" must be specified and must be a function');
    mod_assert.ok(Array.isArray(args['inputs']),
        '"args.inputs" must be specified and must be an array');
 
    func = args['func'];
    funcs = args['inputs'].map(function (input) {
        return (function (subcallback) {
            return (func(input, subcallback));
        });
    });
 
    return (parallel({ 'funcs': funcs }, callback));
}
 
/*
 * Like parallel, but invokes functions in sequence rather than in parallel
 * and aborts if any function exits with failure.  Arguments include:
 *
 *    funcs    invoke the functions in parallel
 *
 *    arg    first argument to each pipeline function
 */
function pipeline(args, callback)
{
    mod_assert.equal(typeof (args), 'object', '"args" must be an object');
    mod_assert.ok(Array.isArray(args['funcs']),
        '"args.funcs" must be specified and must be an array');
 
    var opts = {
        'funcs': args['funcs'].slice(0),
        'callback': callback,
        'args': { impl: 'pipeline', uarg: args['arg'] },
        'stop_when': 'error',
        'res_type': 'rv'
    };
    return (waterfall_impl(opts));
}
 
function tryEach(funcs, callback)
{
    mod_assert.ok(Array.isArray(funcs),
        '"funcs" must be specified and must be an array');
    mod_assert.ok(arguments.length == 1 || typeof (callback) == 'function',
        '"callback" must be a function');
    var opts = {
        'funcs': funcs.slice(0),
        'callback': callback,
        'args': { impl: 'tryEach' },
        'stop_when': 'success',
        'res_type': 'array'
    };
    return (waterfall_impl(opts));
}
 
/*
 * Exactly like pipeline, except that the input is specified as a single
 * function to invoke on N different inputs (rather than N functions).  "args"
 * must have the following fields:
 *
 *    func        asynchronous function to invoke on each input value
 *
 *    inputs        array of input values
 */
function forEachPipeline(args, callback) {
    mod_assert.equal(typeof (args), 'object', '"args" must be an object');
    mod_assert.equal(typeof (args['func']), 'function',
        '"args.func" must be specified and must be a function');
    mod_assert.ok(Array.isArray(args['inputs']),
        '"args.inputs" must be specified and must be an array');
    mod_assert.equal(typeof (callback), 'function',
        'callback argument must be specified and must be a function');
 
    var func = args['func'];
 
    var funcs = args['inputs'].map(function (input) {
        return (function (_, subcallback) {
                return (func(input, subcallback));
            });
    });
 
    return (pipeline({'funcs': funcs}, callback));
}
 
/*
 * async.js compatible filter, filterLimit, and filterSeries.  Takes an input
 * array, optionally a limit, and a single function to filter an array and will
 * callback with a new filtered array. This is effectively an asynchronous
 * version of Array.prototype.filter.
 */
function filter(inputs, filterFunc, callback) {
    return (filterLimit(inputs, Infinity, filterFunc, callback));
}
 
function filterSeries(inputs, filterFunc, callback) {
    return (filterLimit(inputs, 1, filterFunc, callback));
}
 
function filterLimit(inputs, limit, filterFunc, callback) {
    mod_assert.ok(Array.isArray(inputs),
        '"inputs" must be specified and must be an array');
    mod_assert.equal(typeof (limit), 'number',
        '"limit" must be a number');
    mod_assert.equal(isNaN(limit), false,
        '"limit" must be a number');
    mod_assert.equal(typeof (filterFunc), 'function',
        '"filterFunc" must be specified and must be a function');
    mod_assert.equal(typeof (callback), 'function',
        '"callback" argument must be specified as a function');
 
    var errors = [];
    var q = queue(processInput, limit);
    var results = [];
 
    function processInput(input, cb) {
        /*
         * If the errors array has any members, an error was
         * encountered in a previous invocation of filterFunc, so all
         * future filtering will be skipped.
         */
        if (errors.length > 0) {
            cb();
            return;
        }
 
        filterFunc(input.elem, function inputFiltered(err, ans) {
            /*
             * We ensure here that a filterFunc callback is only
             * ever invoked once.
             */
            if (results.hasOwnProperty(input.idx)) {
                throw (new mod_verror.VError(
                    'vasync.filter*: filterFunc idx %d ' +
                    'invoked its callback twice', input.idx));
            }
 
            /*
             * The original element, as well as the answer "ans"
             * (truth value) is stored to later be filtered when
             * all outstanding jobs are finished.
             */
            results[input.idx] = {
                elem: input.elem,
                ans: !!ans
            };
 
            /*
             * Any error encountered while filtering will result in
             * all future operations being skipped, and the error
             * object being returned in the users callback.
             */
            if (err) {
                errors.push(err);
                cb();
                return;
            }
 
            cb();
        });
    }
 
    q.once('end', function queueDrained() {
        if (errors.length > 0) {
            callback(mod_verror.errorFromList(errors));
            return;
        }
 
        /*
         * results is now an array of objects in the same order of the
         * inputs array, where each object looks like:
         *
         * {
         *     "ans": <true|false>,
         *     "elem": <original input element>
         * }
         *
         * we filter out elements that have a false "ans" value, and
         * then map the array to contain only the input elements.
         */
        results = results.filter(function filterFalseInputs(input) {
            return (input.ans);
        }).map(function mapInputElements(input) {
            return (input.elem);
        });
        callback(null, results);
    });
 
    inputs.forEach(function iterateInput(elem, idx) {
        /*
         * We retain the array index to ensure that order is
         * maintained.
         */
        q.push({
            elem: elem,
            idx: idx
        });
    });
 
    q.close();
 
    return (q);
}
 
/*
 * async-compatible "whilst" function, with a few notable exceptions/addons.
 *
 * 1. More strict typing of arguments (functions *must* be supplied).
 * 2. A callback function is required, not optional.
 * 3. An object is returned, not undefined.
 */
function whilst(testFunc, iterateFunc, callback) {
    mod_assert.equal(typeof (testFunc), 'function',
        '"testFunc" must be specified and must be a function');
    mod_assert.equal(typeof (iterateFunc), 'function',
        '"iterateFunc" must be specified and must be a function');
    mod_assert.equal(typeof (callback), 'function',
        '"callback" argument must be specified as a function');
 
    /*
     * The object returned to the caller that provides a read-only
     * interface to introspect this specific invocation of "whilst".
     */
    var o = {
        'finished': false,
        'iterations': 0
    };
 
    /*
     * Store the last set of arguments from the final call to "iterateFunc".
     * The arguments will be passed to the final callback when an error is
     * encountered or when the testFunc returns false.
     */
    var args = [];
 
    function iterate() {
        var shouldContinue = testFunc();
 
        if (!shouldContinue) {
            /*
             * The test condition is false - break out of the loop.
             */
            done();
            return;
        }
 
        /* Bump iterations after testFunc but before iterateFunc. */
        o.iterations++;
 
        iterateFunc(function whilstIteration(err) {
            /* Store the latest set of arguments seen. */
            args = Array.prototype.slice.call(arguments);
 
            /* Any error with iterateFunc will break the loop. */
            if (err) {
                done();
                return;
            }
 
            /* Try again. */
            setImmediate(iterate);
        });
    }
 
    function done() {
        mod_assert.ok(!o.finished, 'whilst already finished');
        o.finished = true;
        callback.apply(this, args);
    }
 
    setImmediate(iterate);
 
    return (o);
}
 
/*
 * async-compatible "queue" function.
 */
function queue(worker, concurrency)
{
    return (new WorkQueue({
        'worker': worker,
        'concurrency': concurrency
    }));
}
 
function queuev(args)
{
    return (new WorkQueue(args));
}
 
function WorkQueue(args)
{
    mod_assert.ok(args.hasOwnProperty('worker'));
    mod_assert.equal(typeof (args['worker']), 'function');
    mod_assert.ok(args.hasOwnProperty('concurrency'));
    mod_assert.equal(typeof (args['concurrency']), 'number');
    mod_assert.equal(Math.floor(args['concurrency']), args['concurrency']);
    mod_assert.ok(args['concurrency'] > 0);
 
    mod_events.EventEmitter.call(this);
 
    this.nextid = 0;
    this.worker = args['worker'];
    this.worker_name = args['worker'].name || 'anon';
    this.npending = 0;
    this.pending = {};
    this.queued = [];
    this.closed = false;
    this.ended = false;
 
    /* user-settable fields inherited from "async" interface */
    this.concurrency = args['concurrency'];
    this.saturated = undefined;
    this.empty = undefined;
    this.drain = undefined;
}
 
mod_util.inherits(WorkQueue, mod_events.EventEmitter);
 
WorkQueue.prototype.push = function (tasks, callback)
{
    if (!Array.isArray(tasks))
        return (this.pushOne(tasks, callback));
 
    var wq = this;
    return (tasks.map(function (task) {
        return (wq.pushOne(task, callback));
    }));
};
 
WorkQueue.prototype.updateConcurrency = function (concurrency)
{
    if (this.closed)
        throw new mod_verror.VError(
            'update concurrency invoked after queue closed');
    this.concurrency = concurrency;
    this.dispatchNext();
};
 
WorkQueue.prototype.close = function ()
{
    var wq = this;
 
    if (wq.closed)
        return;
    wq.closed = true;
 
    /*
     * If the queue is already empty, just fire the "end" event on the
     * next tick.
     */
    if (wq.npending === 0 && wq.queued.length === 0) {
        setImmediate(function () {
            if (!wq.ended) {
                wq.ended = true;
                wq.emit('end');
            }
        });
    }
};
 
/* private */
WorkQueue.prototype.pushOne = function (task, callback)
{
    if (this.closed)
        throw new mod_verror.VError('push invoked after queue closed');
 
    var id = ++this.nextid;
    var entry = { 'id': id, 'task': task, 'callback': callback };
 
    this.queued.push(entry);
    this.dispatchNext();
 
    return (id);
};
 
/* private */
WorkQueue.prototype.dispatchNext = function ()
{
    var wq = this;
    if (wq.npending === 0 && wq.queued.length === 0) {
        if (wq.drain)
            wq.drain();
        wq.emit('drain');
        /*
         * The queue is closed; emit the final "end"
         * event before we come to rest:
         */
        if (wq.closed) {
            wq.ended = true;
            wq.emit('end');
        }
    } else if (wq.queued.length > 0) {
        while (wq.queued.length > 0 && wq.npending < wq.concurrency) {
            var next = wq.queued.shift();
            wq.dispatch(next);
 
            if (wq.queued.length === 0) {
                if (wq.empty)
                    wq.empty();
                wq.emit('empty');
            }
        }
    }
};
 
WorkQueue.prototype.dispatch = function (entry)
{
    var wq = this;
 
    mod_assert.ok(!this.pending.hasOwnProperty(entry['id']));
    mod_assert.ok(this.npending < this.concurrency);
    mod_assert.ok(!this.ended);
 
    this.npending++;
    this.pending[entry['id']] = entry;
 
    if (this.npending === this.concurrency) {
        if (this.saturated)
            this.saturated();
        this.emit('saturated');
    }
 
    /*
     * We invoke the worker function on the next tick so that callers can
     * always assume that the callback is NOT invoked during the call to
     * push() even if the queue is not at capacity.  It also avoids O(n)
     * stack usage when used with synchronous worker functions.
     */
    setImmediate(function () {
        wq.worker(entry['task'], function (err) {
            --wq.npending;
            delete (wq.pending[entry['id']]);
 
            if (entry['callback'])
                entry['callback'].apply(null, arguments);
 
            wq.dispatchNext();
        });
    });
};
 
WorkQueue.prototype.length = function ()
{
    return (this.queued.length);
};
 
WorkQueue.prototype.kill = function ()
{
    this.killed = true;
    this.queued = [];
    this.drain = undefined;
    this.close();
};
 
/*
 * Barriers coordinate multiple concurrent operations.
 */
function barrier(args)
{
    return (new Barrier(args));
}
 
function Barrier(args)
{
    mod_assert.ok(!args || !args['nrecent'] ||
        typeof (args['nrecent']) == 'number',
        '"nrecent" must have type "number"');
 
    mod_events.EventEmitter.call(this);
 
    var nrecent = args && args['nrecent'] ? args['nrecent'] : 10;
 
    if (nrecent > 0) {
        this.nrecent = nrecent;
        this.recent = [];
    }
 
    this.pending = {};
    this.scheduled = false;
}
 
mod_util.inherits(Barrier, mod_events.EventEmitter);
 
Barrier.prototype.start = function (name)
{
    mod_assert.ok(!this.pending.hasOwnProperty(name),
        'operation "' + name + '" is already pending');
    this.pending[name] = Date.now();
};
 
Barrier.prototype.done = function (name)
{
    mod_assert.ok(this.pending.hasOwnProperty(name),
        'operation "' + name + '" is not pending');
 
    if (this.recent) {
        this.recent.push({
            'name': name,
            'start': this.pending[name],
            'done': Date.now()
        });
 
        if (this.recent.length > this.nrecent)
            this.recent.shift();
    }
 
    delete (this.pending[name]);
 
    /*
     * If we executed at least one operation and we're now empty, we should
     * emit "drain".  But most code doesn't deal well with events being
     * processed while they're executing, so we actually schedule this event
     * for the next tick.
     *
     * We use the "scheduled" flag to avoid emitting multiple "drain" events
     * on consecutive ticks if the user starts and ends another task during
     * this tick.
     */
    if (!isEmpty(this.pending) || this.scheduled)
        return;
 
    this.scheduled = true;
 
    var self = this;
 
    setImmediate(function () {
        self.scheduled = false;
 
        /*
         * It's also possible that the user has started another task on
         * the previous tick, in which case we really shouldn't emit
         * "drain".
         */
        if (isEmpty(self.pending))
            self.emit('drain');
    });
};
 
/*
 * waterfall([ funcs ], callback): invoke each of the asynchronous functions
 * "funcs" in series.  Each function is passed any values emitted by the
 * previous function (none for the first function), followed by the callback to
 * invoke upon completion.  This callback must be invoked exactly once,
 * regardless of success or failure.  As conventional in Node, the first
 * argument to the callback indicates an error (if non-null).  Subsequent
 * arguments are passed to the next function in the "funcs" chain.
 *
 * If any function fails (i.e., calls its callback with an Error), then the
 * remaining functions are not invoked and "callback" is invoked with the error.
 *
 * The only difference between waterfall() and pipeline() are the arguments
 * passed to each function in the chain.  pipeline() always passes the same
 * argument followed by the callback, while waterfall() passes whatever values
 * were emitted by the previous function followed by the callback.
 */
function waterfall(funcs, callback)
{
    mod_assert.ok(Array.isArray(funcs),
        '"funcs" must be specified and must be an array');
    mod_assert.ok(arguments.length == 1 || typeof (callback) == 'function',
        '"callback" must be a function');
    var opts = {
        'funcs': funcs.slice(0),
        'callback': callback,
        'args': { impl: 'waterfall' },
        'stop_when': 'error',
        'res_type': 'values'
    };
    return (waterfall_impl(opts));
}
 
/*
 * This function is used to implement vasync-functions that need to execute a
 * list of functions in a sequence, but differ in how they make use of the
 * intermediate callbacks and finall callback, as well as under what conditions
 * they stop executing the functions in the list. Examples of such functions
 * are `pipeline`, `waterfall`, and `tryEach`. See the documentation for those
 * functions to see how they operate.
 *
 * This function's behavior is influenced via the `opts` object that we pass
 * in. This object has the following layout:
 *
 *     {
 *         'funcs': array of functions
 *         'callback': the final callback
 *         'args': {
 *             'impl': 'pipeline' or 'tryEach' or 'waterfall'
 *             'uarg': the arg passed to each func for 'pipeline'
 *             }
 *         'stop_when': 'error' or 'success'
 *         'res_type': 'values' or 'arrays' or 'rv'
 *     }
 *
 * In the object, 'res_type' is used to indicate what the type of the result
 * values(s) is that we pass to the final callback. We secondarily use
 * 'args.impl' to adjust this behavior in an implementation-specific way. For
 * example, 'tryEach' only returns an array if it has more than 1 result passed
 * to the final callback. Otherwise, it passes a solitary value to the final
 * callback.
 *
 * In case it's not clear, 'rv' in the `res_type` member, is just the
 * result-value that we also return. This is the convention in functions that
 * originated in `vasync` (pipeline), but not in functions that originated in
 * `async` (waterfall, tryEach).
 */
function waterfall_impl(opts)
{
    mod_assert.ok(typeof (opts) === 'object');
    var rv, current, next;
    var funcs = opts.funcs;
    var callback = opts.callback;
 
    mod_assert.ok(Array.isArray(funcs),
        '"opts.funcs" must be specified and must be an array');
    mod_assert.ok(arguments.length == 1,
        'Function "waterfall_impl" must take only 1 arg');
    mod_assert.ok(opts.res_type === 'values' ||
        opts.res_type === 'array' || opts.res_type == 'rv',
        '"opts.res_type" must either be "values", "array", or "rv"');
    mod_assert.ok(opts.stop_when === 'error' ||
        opts.stop_when === 'success',
        '"opts.stop_when" must either be "error" or "success"');
    mod_assert.ok(opts.args.impl === 'pipeline' ||
        opts.args.impl === 'waterfall' || opts.args.impl === 'tryEach',
        '"opts.args.impl" must be "pipeline", "waterfall", or "tryEach"');
    if (opts.args.impl === 'pipeline') {
        mod_assert.ok(typeof (opts.args.uarg) !== undefined,
            '"opts.args.uarg" should be defined when pipeline is used');
    }
 
    rv = {
        'operations': funcs.map(function (func) {
            return ({
            'func': func,
            'funcname': func.name || '(anon)',
            'status': 'waiting'
        });
        }),
        'successes': [],
        'ndone': 0,
        'nerrors': 0
    };
 
    if (funcs.length === 0) {
        if (callback)
            setImmediate(function () {
                var res = (opts.args.impl === 'pipeline') ? rv
                    : undefined;
                callback(null, res);
            });
        return (rv);
    }
 
    next = function (idx, err) {
        /*
         * Note that nfunc_args contains the args we will pass to the
         * next func in the func-list the user gave us. Except for
         * 'tryEach', which passes cb's. However, it will pass
         * 'nfunc_args' to its final callback -- see below.
         */
        var res_key, nfunc_args, entry, nextentry;
 
        if (err === undefined)
            err = null;
 
        if (idx != current) {
            throw (new mod_verror.VError(
                'vasync.waterfall: function %d ("%s") invoked ' +
                'its callback twice', idx,
                rv['operations'][idx].funcname));
        }
 
        mod_assert.equal(idx, rv['ndone'],
            'idx should be equal to ndone');
        entry = rv['operations'][rv['ndone']++];
        if (opts.args.impl === 'tryEach' ||
            opts.args.impl === 'waterfall') {
            nfunc_args = Array.prototype.slice.call(arguments, 2);
            res_key = 'results';
            entry['results'] = nfunc_args;
        } else if (opts.args.impl === 'pipeline') {
            nfunc_args = [ opts.args.uarg ];
            res_key = 'result';
            entry['result'] = arguments[2];
        }
 
        mod_assert.equal(entry['status'], 'pending',
            'status should be pending');
        entry['status'] = err ? 'fail' : 'ok';
        entry['err'] = err;
 
        if (err) {
            rv['nerrors']++;
        } else {
            rv['successes'].push(entry[res_key]);
        }
 
        if ((opts.stop_when === 'error' && err) ||
            (opts.stop_when === 'success' &&
            rv['successes'].length > 0) ||
            rv['ndone'] == funcs.length) {
            if (callback) {
                if (opts.res_type === 'values' ||
                    (opts.res_type === 'array' &&
                     nfunc_args.length <= 1)) {
                    nfunc_args.unshift(err);
                    callback.apply(null, nfunc_args);
                } else if (opts.res_type === 'array') {
                    callback(err, nfunc_args);
                } else if (opts.res_type === 'rv') {
                    callback(err, rv);
                }
            }
        } else {
            nextentry = rv['operations'][rv['ndone']];
            nextentry['status'] = 'pending';
            current++;
            nfunc_args.push(next.bind(null, current));
            setImmediate(function () {
                var nfunc = nextentry['func'];
                /*
                 * At first glance it may seem like this branch
                 * is superflous with the code above that
                 * branches on `opts.args.impl`. It may also
                 * seem like calling `nfunc.apply` is
                 * sufficient for both cases (after all we
                 * pushed `next.bind(null, current)` to the
                 * `nfunc_args` array), before we call
                 * `setImmediate()`. However, this is not the
                 * case, because the interface exposed by
                 * tryEach is different from the others. The
                 * others pass argument(s) from task to task.
                 * tryEach passes nothing but a callback
                 * (`next.bind` below). However, the callback
                 * itself _can_ be called with one or more
                 * results, which we collect into `nfunc_args`
                 * using the aformentioned `opts.args.impl`
                 * branch above, and which we pass to the
                 * callback via the `opts.res_type` branch
                 * above (where res_type is set to 'array').
                 */
                if (opts.args.impl !== 'tryEach') {
                    nfunc.apply(null, nfunc_args);
                } else {
                    nfunc(next.bind(null, current));
                }
            });
        }
    };
 
    rv['operations'][0]['status'] = 'pending';
    current = 0;
    if (opts.args.impl !== 'pipeline') {
        funcs[0](next.bind(null, current));
    } else {
        funcs[0](opts.args.uarg, next.bind(null, current));
    }
    return (rv);
}