daedalus-planner 0.1.1

Planner that validates and schedules Daedalus dataflow graphs.
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
//! Planner passes and execution plan model scaffolding. See `PLAN.md` for staged tasks.
//! Exposes a deterministic pass pipeline from registry-sourced graphs to an `ExecutionPlan`.
//!
//! Pass order (stubs today, contract documented):
//! hydrate_registry -> typecheck -> convert -> align -> gpu -> schedule -> lint.

pub mod debug;
mod diagnostics;
mod graph;
pub mod helpers;
mod passes;

pub use diagnostics::{Diagnostic, DiagnosticCode, DiagnosticSpan};
pub use graph::{
    ComputeAffinity, DEFAULT_PLAN_VERSION, Edge, EdgeBufferInfo, ExecutionPlan, GpuSegment, Graph,
    NodeInstance, NodeRef, PortRef, StableHash,
};
pub use passes::{PlannerConfig, PlannerInput, PlannerOutput, build_plan};

#[cfg(test)]
mod tests {
    use super::*;
    use daedalus_data::model::{TypeExpr, ValueType};
    use daedalus_registry::store::NodeDescriptorBuilder;
    use daedalus_registry::store::Registry;

    #[test]
    fn stable_hash_changes_with_edges() {
        let mut graph = Graph::default();
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("n1"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("n2"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        let g1 = graph.clone();
        let p1 = build_plan(
            PlannerInput {
                graph: g1,
                registry: &Registry::new(),
            },
            PlannerConfig::default(),
        )
        .plan;

        graph.edges.push(Edge {
            from: PortRef {
                node: NodeRef(0),
                port: "out".into(),
            },
            to: PortRef {
                node: NodeRef(1),
                port: "in".into(),
            },
            metadata: Default::default(),
        });
        let p2 = build_plan(
            PlannerInput {
                graph,
                registry: &Registry::new(),
            },
            PlannerConfig::default(),
        )
        .plan;

        assert_ne!(p1.hash, p2.hash);
    }

    #[test]
    fn reports_missing_node_and_ports_and_converter_gap() {
        // Registry with node a (out:int) and b (in:bool)
        let mut registry = Registry::new();
        let a = NodeDescriptorBuilder::new("a")
            .output("out", TypeExpr::Scalar(ValueType::Int))
            .build()
            .unwrap();
        registry.register_node(a).unwrap();
        let b = NodeDescriptorBuilder::new("b")
            .input("in", TypeExpr::Scalar(ValueType::Bool))
            .build()
            .unwrap();
        registry.register_node(b).unwrap();

        let mut graph = Graph::default();
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("a"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("b"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        // Edge uses wrong output port name to trigger port missing + type mismatch
        graph.edges.push(Edge {
            from: PortRef {
                node: NodeRef(0),
                port: "missing".into(),
            },
            to: PortRef {
                node: NodeRef(1),
                port: "in".into(),
            },
            metadata: Default::default(),
        });

        let out = build_plan(
            PlannerInput {
                graph,
                registry: &registry,
            },
            PlannerConfig::default(),
        );

        // Expect port-missing on source, no type mismatch because missing source type.
        assert!(
            out.diagnostics
                .iter()
                .any(|d| matches!(d.code, DiagnosticCode::PortMissing)
                    && d.span.node.as_deref() == Some("a"))
        );

        // Now add a correct port but wrong type to trigger converter resolution.
        let mut registry2 = Registry::new();
        let a2 = NodeDescriptorBuilder::new("a")
            .output("out", TypeExpr::Scalar(ValueType::Int))
            .build()
            .unwrap();
        registry2.register_node(a2).unwrap();
        let b2 = NodeDescriptorBuilder::new("b")
            .input("in", TypeExpr::Scalar(ValueType::Bool))
            .build()
            .unwrap();
        registry2.register_node(b2).unwrap();
        let mut graph2 = Graph::default();
        graph2.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("a"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph2.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("b"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph2.edges.push(Edge {
            from: PortRef {
                node: NodeRef(0),
                port: "out".into(),
            },
            to: PortRef {
                node: NodeRef(1),
                port: "in".into(),
            },
            metadata: Default::default(),
        });

        let out2 = build_plan(
            PlannerInput {
                graph: graph2,
                registry: &registry2,
            },
            PlannerConfig::default(),
        );

        assert!(
            out2.diagnostics
                .iter()
                .any(|d| matches!(d.code, DiagnosticCode::ConverterMissing))
        );

        // Register a converter to remove the gap.
        struct IntToBool;
        impl daedalus_data::convert::Converter for IntToBool {
            fn id(&self) -> daedalus_data::convert::ConverterId {
                daedalus_data::convert::ConverterId("int_to_bool".into())
            }
            fn input(&self) -> &TypeExpr {
                static TY: once_cell::sync::Lazy<TypeExpr> =
                    once_cell::sync::Lazy::new(|| TypeExpr::Scalar(ValueType::Int));
                &TY
            }
            fn output(&self) -> &TypeExpr {
                static TY: once_cell::sync::Lazy<TypeExpr> =
                    once_cell::sync::Lazy::new(|| TypeExpr::Scalar(ValueType::Bool));
                &TY
            }
            fn convert(
                &self,
                _value: daedalus_data::model::Value,
            ) -> Result<daedalus_data::model::Value, daedalus_data::errors::DataError> {
                Ok(daedalus_data::model::Value::Bool(true))
            }
            fn cost(&self) -> u64 {
                1
            }
        }

        let mut registry3 = Registry::new();
        let a3 = NodeDescriptorBuilder::new("a")
            .output("out", TypeExpr::Scalar(ValueType::Int))
            .build()
            .unwrap();
        registry3.register_node(a3).unwrap();
        let b3 = NodeDescriptorBuilder::new("b")
            .input("in", TypeExpr::Scalar(ValueType::Bool))
            .build()
            .unwrap();
        registry3.register_node(b3).unwrap();
        registry3
            .register_converter(Box::new(IntToBool))
            .expect("converter registers");

        let mut graph3 = Graph::default();
        graph3.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("a"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph3.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("b"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph3.edges.push(Edge {
            from: PortRef {
                node: NodeRef(0),
                port: "out".into(),
            },
            to: PortRef {
                node: NodeRef(1),
                port: "in".into(),
            },
            metadata: Default::default(),
        });

        let out3 = build_plan(
            PlannerInput {
                graph: graph3,
                registry: &registry3,
            },
            PlannerConfig::default(),
        );

        assert!(
            !out3
                .diagnostics
                .iter()
                .any(|d| matches!(d.code, DiagnosticCode::ConverterMissing))
        );
    }

    #[test]
    fn detects_cycle_in_align() {
        let mut registry = Registry::new();
        let node_desc = NodeDescriptorBuilder::new("n")
            .input("in", TypeExpr::Scalar(ValueType::Int))
            .output("out", TypeExpr::Scalar(ValueType::Int))
            .build()
            .unwrap();
        registry.register_node(node_desc).unwrap();

        let mut graph = Graph::default();
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("n"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("n"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::CpuOnly,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });

        // Cycle: 0 -> 1 -> 0
        graph.edges.push(Edge {
            from: PortRef {
                node: NodeRef(0),
                port: "out".into(),
            },
            to: PortRef {
                node: NodeRef(1),
                port: "in".into(),
            },
            metadata: Default::default(),
        });
        graph.edges.push(Edge {
            from: PortRef {
                node: NodeRef(1),
                port: "out".into(),
            },
            to: PortRef {
                node: NodeRef(0),
                port: "in".into(),
            },
            metadata: Default::default(),
        });

        let out = build_plan(
            PlannerInput {
                graph,
                registry: &registry,
            },
            PlannerConfig {
                enable_lints: true,
                ..Default::default()
            },
        );

        assert!(
            out.diagnostics
                .iter()
                .any(|d| matches!(d.code, DiagnosticCode::ScheduleConflict))
        );
    }

    #[test]
    fn gpu_required_without_flag_reports() {
        let mut registry = Registry::new();
        let node_desc = NodeDescriptorBuilder::new("n")
            .input("in", TypeExpr::Scalar(ValueType::Int))
            .output("out", TypeExpr::Scalar(ValueType::Int))
            .build()
            .unwrap();
        registry.register_node(node_desc).unwrap();

        let mut graph = Graph::default();
        graph.nodes.push(NodeInstance {
            id: daedalus_registry::ids::NodeId::new("n"),
            bundle: None,
            label: None,
            inputs: vec![],
            outputs: vec![],
            compute: ComputeAffinity::GpuRequired,
            const_inputs: vec![],
            sync_groups: vec![],
            metadata: Default::default(),
        });

        let out = build_plan(
            PlannerInput {
                graph,
                registry: &registry,
            },
            PlannerConfig {
                enable_gpu: false,
                ..Default::default()
            },
        );

        assert!(
            out.diagnostics
                .iter()
                .any(|d| matches!(d.code, DiagnosticCode::GpuUnsupported))
        );
    }
}