dinah 0.1.0

Rust-first modular runtime and high-performance compute foundation
Documentation
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
use super::{Executor, TaskQueue};

/// A small synchronous scheduler that dispatches each submitted task immediately.
///
/// This initial scheduler owns no queue and creates no threads. Submission
/// executes on the caller's thread, so it provides deterministic, sequential
/// dispatch without claiming FIFO ordering across concurrent callers, fairness,
/// cancellation, or background progress.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub struct Scheduler {
    executor: Executor,
}

/// Error returned when a task cannot be submitted to the scheduler.
///
/// The initial immediate scheduler has no capacity limit, so this type is
/// reserved for explicit scheduler-level rejection as queueing is introduced.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ScheduleError {
    /// The scheduler is not accepting work. The initial scheduler never emits
    /// this error; it is reserved for a future lifecycle-aware implementation.
    Closed,
}

impl core::fmt::Display for ScheduleError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::Closed => f.write_str("scheduler is closed"),
        }
    }
}

impl std::error::Error for ScheduleError {}

impl Scheduler {
    /// Creates a scheduler that immediately executes submitted tasks.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            executor: Executor::new(),
        }
    }

    /// Submits a one-shot task for immediate synchronous execution.
    ///
    /// The returned result is the task's own result; scheduler rejection is
    /// represented by [`ScheduleError`] separately in future queued variants.
    /// In this first implementation, submission always dispatches immediately
    /// and the scheduler-level error type is not produced.
    pub fn schedule<T, E, F>(&self, task: F) -> Result<Result<T, E>, ScheduleError>
    where
        F: FnOnce() -> Result<T, E>,
    {
        Ok(self.executor.execute(task))
    }

    /// Removes and executes the oldest queued task, if one is available.
    ///
    /// The queue item is removed before user code runs. The queue is borrowed
    /// only for the pop operation, so task execution does not occur while any
    /// queue borrow or internal queue lock is held. `None` means the queue was
    /// empty; `Some(Err(error))` is the task's own error.
    pub fn dispatch_next<T, E, F>(&self, queue: &mut TaskQueue<F>) -> Option<Result<T, E>>
    where
        F: FnOnce() -> Result<T, E>,
    {
        queue.pop().map(|task| self.executor.execute(task))
    }

    /// Executes queued tasks sequentially until the queue is empty.
    ///
    /// Results are returned in dispatch order, including task-level errors;
    /// an error does not stop later queued tasks from running. The queue is
    /// drained one item at a time, and user code runs after each item has been
    /// removed from the queue. This method does not add concurrency or a worker
    /// pool.
    pub fn run_until_empty<T, E, F>(&self, queue: &mut TaskQueue<F>) -> Vec<Result<T, E>>
    where
        F: FnOnce() -> Result<T, E>,
    {
        let mut results = Vec::with_capacity(queue.len());
        while let Some(result) = self.dispatch_next(queue) {
            results.push(result);
        }
        results
    }

    /// Executes queued tasks in parallel batches bounded by `max_workers`.
    ///
    /// A bounded set of scoped workers is created once per call and reused across
    /// batches. Each batch is removed from the queue before its tasks start, and
    /// results are returned in FIFO dispatch order regardless of completion
    /// order. Task-level `Err` is retained and does not stop later batches. If a
    /// task panics, all tasks in its current batch are allowed to finish, workers
    /// are shut down, and the panic is propagated; later batches remain queued.
    /// Workers are scoped to this call, not retained across calls, so closures may
    /// borrow data and no persistent scheduler lifecycle is implied.
    pub fn run_parallel<T, E, F>(
        &self,
        queue: &mut TaskQueue<F>,
        max_workers: core::num::NonZeroUsize,
    ) -> Vec<Result<T, E>>
    where
        T: Send,
        E: Send,
        F: FnOnce() -> Result<T, E> + Send,
    {
        use std::any::Any;
        use std::panic::{catch_unwind, AssertUnwindSafe};
        use std::sync::mpsc;

        if queue.is_empty() {
            return Vec::new();
        }

        let total_tasks = queue.len();
        let worker_count = max_workers.get().min(total_tasks);
        let mut results: Vec<Option<Result<T, E>>> =
            std::iter::repeat_with(|| None).take(total_tasks).collect();

        std::thread::scope(|scope| {
            let (result_sender, result_receiver) =
                mpsc::channel::<(usize, Result<Result<T, E>, Box<dyn Any + Send>>)>();
            let mut task_senders = Vec::with_capacity(worker_count);

            for _ in 0..worker_count {
                let (task_sender, task_receiver) = mpsc::channel::<Option<(usize, F)>>();
                let result_sender = result_sender.clone();
                task_senders.push(task_sender);
                scope.spawn(move || {
                    while let Ok(Some((index, task))) = task_receiver.recv() {
                        let outcome = catch_unwind(AssertUnwindSafe(task));
                        if result_sender.send((index, outcome)).is_err() {
                            break;
                        }
                    }
                });
            }
            drop(result_sender);

            let mut next_index = 0;
            // Reuse the batch allocation across iterations. Each batch must be
            // fully removed from the queue before any task is sent to a worker.
            let mut batch = Vec::with_capacity(worker_count);
            while !queue.is_empty() {
                let batch_size = queue.len().min(worker_count);
                batch.clear();
                for _ in 0..batch_size {
                    if let Some(task) = queue.pop() {
                        batch.push(task);
                    }
                }

                // Each batch has at most one task per worker, so dedicated
                // channels avoid serializing worker receive operations on a mutex.
                for (worker_index, task) in batch.drain(..).enumerate() {
                    task_senders[worker_index]
                        .send(Some((next_index, task)))
                        .expect("scoped worker accepts its assigned task");
                    next_index += 1;
                }

                let mut panics = Vec::new();
                for _ in 0..batch_size {
                    let (index, outcome) = result_receiver
                        .recv()
                        .expect("every dispatched task reports an outcome");
                    match outcome {
                        Ok(result) => results[index] = Some(result),
                        Err(payload) => panics.push((index, payload)),
                    }
                }

                if !panics.is_empty() {
                    for task_sender in &task_senders {
                        let _ = task_sender.send(None);
                    }
                    panics.sort_unstable_by_key(|(index, _)| *index);
                    std::panic::resume_unwind(panics.remove(0).1);
                }
            }

            for task_sender in &task_senders {
                task_sender
                    .send(None)
                    .expect("scoped worker accepts its shutdown message");
            }
        });

        results
            .into_iter()
            .map(|result| result.expect("every normally completed task has a result"))
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::{ScheduleError, Scheduler};
    use core::cell::Cell;

    #[test]
    fn schedules_task_immediately_and_returns_result() {
        let scheduler = Scheduler::new();
        assert_eq!(scheduler.schedule(|| Ok::<_, &'static str>(7)), Ok(Ok(7)));
    }

    #[test]
    fn executes_submitted_task_once() {
        let scheduler = Scheduler::new();
        let calls = Cell::new(0);

        let result = scheduler.schedule(|| {
            calls.set(calls.get() + 1);
            Ok::<_, ()>(())
        });

        assert_eq!(result, Ok(Ok(())));
        assert_eq!(calls.get(), 1);
    }

    #[test]
    fn preserves_task_error_separately_from_scheduler_error() {
        let scheduler = Scheduler::new();
        assert_eq!(
            scheduler.schedule(|| Err::<(), _>("task failed")),
            Ok(Err("task failed"))
        );
    }

    #[test]
    fn dispatch_next_returns_none_for_empty_queue() {
        let scheduler = Scheduler::new();
        let mut queue = super::super::TaskQueue::<fn() -> Result<(), ()>>::new(
            core::num::NonZeroUsize::new(1).expect("positive capacity"),
        );
        assert_eq!(scheduler.dispatch_next(&mut queue), None);
    }

    #[test]
    fn dispatch_next_executes_oldest_task_once() {
        fn first() -> Result<i32, ()> {
            Ok(1)
        }
        fn second() -> Result<i32, ()> {
            Ok(2)
        }

        let scheduler = Scheduler::new();
        let mut queue: super::super::TaskQueue<fn() -> Result<i32, ()>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(2).expect("positive capacity"),
            );
        assert!(queue.try_push(first).is_ok());
        assert!(queue.try_push(second).is_ok());

        assert_eq!(scheduler.dispatch_next(&mut queue), Some(Ok(1)));
        assert_eq!(queue.len(), 1);
        assert_eq!(scheduler.dispatch_next(&mut queue), Some(Ok(2)));
        assert_eq!(scheduler.dispatch_next(&mut queue), None);
    }

    #[test]
    fn run_until_empty_drains_in_fifo_order_and_preserves_errors() {
        fn first() -> Result<i32, &'static str> {
            Ok(1)
        }
        fn failed() -> Result<i32, &'static str> {
            Err("failed")
        }
        fn third() -> Result<i32, &'static str> {
            Ok(3)
        }

        let scheduler = Scheduler::new();
        let mut queue: super::super::TaskQueue<fn() -> Result<i32, &'static str>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(3).expect("positive capacity"),
            );
        assert!(queue.try_push(first).is_ok());
        assert!(queue.try_push(failed).is_ok());
        assert!(queue.try_push(third).is_ok());

        assert_eq!(
            scheduler.run_until_empty(&mut queue),
            vec![Ok(1), Err("failed"), Ok(3)]
        );
        assert!(queue.is_empty());
    }

    #[test]
    fn run_until_empty_returns_no_results_for_empty_queue() {
        let scheduler = Scheduler::new();
        let mut queue = super::super::TaskQueue::<fn() -> Result<(), ()>>::new(
            core::num::NonZeroUsize::new(1).expect("positive capacity"),
        );
        assert!(scheduler.run_until_empty(&mut queue).is_empty());
    }

    #[test]
    fn run_parallel_preserves_fifo_result_order_and_task_errors() {
        fn first() -> Result<i32, &'static str> {
            Ok(1)
        }
        fn failed() -> Result<i32, &'static str> {
            Err("failed")
        }
        fn third() -> Result<i32, &'static str> {
            Ok(3)
        }

        let scheduler = Scheduler::new();
        let mut queue: super::super::TaskQueue<fn() -> Result<i32, &'static str>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(3).expect("positive capacity"),
            );
        assert!(queue.try_push(first).is_ok());
        assert!(queue.try_push(failed).is_ok());
        assert!(queue.try_push(third).is_ok());

        assert_eq!(
            scheduler.run_parallel(
                &mut queue,
                core::num::NonZeroUsize::new(2).expect("positive worker limit"),
            ),
            vec![Ok(1), Err("failed"), Ok(3)]
        );
        assert!(queue.is_empty());
    }

    #[test]
    fn run_parallel_executes_tasks_concurrently_within_worker_limit() {
        use std::sync::{Arc, Barrier};
        let scheduler = Scheduler::new();
        let barrier = Arc::new(Barrier::new(2));
        let mut queue = super::super::TaskQueue::new(core::num::NonZeroUsize::new(4).unwrap());
        for value in 0..4 {
            let barrier = Arc::clone(&barrier);
            assert!(queue
                .try_push(move || {
                    barrier.wait();
                    Ok::<_, &'static str>(value)
                })
                .is_ok());
        }
        let results = scheduler.run_parallel(&mut queue, core::num::NonZeroUsize::new(2).unwrap());
        assert_eq!(results, vec![Ok(0), Ok(1), Ok(2), Ok(3)]);
        assert!(queue.is_empty());
    }

    #[test]
    fn run_parallel_continues_after_error_across_batch_boundaries() {
        fn first() -> Result<i32, &'static str> {
            Ok(10)
        }
        fn failed() -> Result<i32, &'static str> {
            Err("batch one failed")
        }
        fn third() -> Result<i32, &'static str> {
            Ok(30)
        }
        fn fourth() -> Result<i32, &'static str> {
            Ok(40)
        }

        let scheduler = Scheduler::new();
        let mut queue: super::super::TaskQueue<fn() -> Result<i32, &'static str>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(4).expect("positive capacity"),
            );
        for task in [first, failed, third, fourth] {
            assert!(queue.try_push(task).is_ok());
        }

        let results = scheduler.run_parallel(
            &mut queue,
            core::num::NonZeroUsize::new(2).expect("positive worker limit"),
        );
        assert_eq!(
            results,
            vec![Ok(10), Err("batch one failed"), Ok(30), Ok(40)]
        );
        assert!(queue.is_empty());
    }

    #[test]
    fn run_parallel_with_one_worker_preserves_fifo_across_batches() {
        fn task(value: i32) -> impl FnOnce() -> Result<i32, ()> {
            move || Ok(value)
        }

        let scheduler = Scheduler::new();
        let mut queue = super::super::TaskQueue::new(
            core::num::NonZeroUsize::new(3).expect("positive capacity"),
        );
        for value in 0..3 {
            assert!(queue.try_push(task(value)).is_ok());
        }

        assert_eq!(
            scheduler.run_parallel(
                &mut queue,
                core::num::NonZeroUsize::new(1).expect("positive worker limit"),
            ),
            vec![Ok(0), Ok(1), Ok(2)]
        );
        assert!(queue.is_empty());
    }

    #[test]
    fn run_parallel_reuses_workers_and_propagates_panic_after_current_batch() {
        use std::panic::{catch_unwind, AssertUnwindSafe};
        use std::sync::atomic::{AtomicUsize, Ordering};
        use std::sync::Arc;

        let scheduler = Scheduler::new();
        let completed = Arc::new(AtomicUsize::new(0));
        let mut queue: super::super::TaskQueue<Box<dyn FnOnce() -> Result<(), ()> + Send>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(3).expect("positive capacity"),
            );

        assert!(queue
            .try_push(Box::new(|| -> Result<(), ()> {
                panic!("expected task panic")
            }))
            .is_ok());
        let completed_in_batch = Arc::clone(&completed);
        assert!(queue
            .try_push(Box::new(move || {
                completed_in_batch.fetch_add(1, Ordering::SeqCst);
                Ok::<_, ()>(())
            }))
            .is_ok());
        let queued_for_later = Arc::clone(&completed);
        assert!(queue
            .try_push(Box::new(move || {
                queued_for_later.fetch_add(1, Ordering::SeqCst);
                Ok::<_, ()>(())
            }))
            .is_ok());

        let outcome = catch_unwind(AssertUnwindSafe(|| {
            scheduler.run_parallel(
                &mut queue,
                core::num::NonZeroUsize::new(2).expect("positive worker limit"),
            )
        }));

        assert!(outcome.is_err());
        assert_eq!(completed.load(Ordering::SeqCst), 1);
        assert_eq!(queue.len(), 1, "later batches remain queued after a panic");
        assert_eq!(scheduler.run_until_empty(&mut queue), vec![Ok(())]);
        assert_eq!(completed.load(Ordering::SeqCst), 2);
    }

    #[test]
    fn run_parallel_handles_empty_queue() {
        let scheduler = Scheduler::new();
        let mut queue = super::super::TaskQueue::<fn() -> Result<(), ()>>::new(
            core::num::NonZeroUsize::new(1).expect("positive capacity"),
        );
        assert!(scheduler
            .run_parallel(
                &mut queue,
                core::num::NonZeroUsize::new(2).expect("positive worker limit"),
            )
            .is_empty());
    }

    #[test]
    fn dispatch_next_preserves_task_error() {
        fn failed() -> Result<(), &'static str> {
            Err("queued task failed")
        }

        let scheduler = Scheduler::new();
        let mut queue: super::super::TaskQueue<fn() -> Result<(), &'static str>> =
            super::super::TaskQueue::new(
                core::num::NonZeroUsize::new(1).expect("positive capacity"),
            );
        assert!(queue.try_push(failed).is_ok());
        assert_eq!(
            scheduler.dispatch_next(&mut queue),
            Some(Err("queued task failed"))
        );
    }

    #[test]
    fn closed_error_has_stable_display() {
        assert_eq!(ScheduleError::Closed.to_string(), "scheduler is closed");
    }
}