cubecl-spirv 0.11.2

SPIR-V compiler for CubeCL
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
use cubecl_core::{
    define_scalar,
    frontend::{AddNativeExpand, PartialOrdNativeExpand},
    ir::{dialect::branch::YieldOp, prelude::*},
};
use cubecl_ir::{
    NamedRewrite, Scope,
    dialect::{
        BlockPtrExt,
        branch::{self, ConditionOp, IsExitTerminator},
        cf::BranchConditionalOp,
        scf,
    },
    ident,
};
use pliron::{
    basic_block::BasicBlock,
    builtin::attributes::VecAttr,
    irbuild::inserter::{BlockInsertionPoint, Inserter},
};
use pliron_spirv::ops::{self, BranchOp, LoopOp, MergeOp, SelectionOp};

use crate::{ops::to_spirv_dialect::ToSpirvDialectOp, types::ty_to_spirv_dialect};

#[op_interface_impl]
impl ToSpirvDialectOp for BranchConditionalOp {
    fn to_spirv_dialect(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let cond = self.get_operand_condition(ctx);
        let true_dest = self.get_operation().deref(ctx).get_successor(0);
        let true_opds = self.successor_operands(ctx, 0);
        let false_dest = self.get_operation().deref(ctx).get_successor(1);
        let false_opds = self.successor_operands(ctx, 1);
        let op =
            ops::BranchConditionalOp::new(ctx, cond, true_dest, true_opds, false_dest, false_opds);
        rewriter.append_op(ctx, &op);
        rewriter.replace_operation(ctx, self.get_operation(), op.get_operation());
        Ok(())
    }
}

#[op_interface]
pub trait ToSpirvCFDialect {
    verify_op_succ!();
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        operands_info: &OperandsInfo,
    ) -> Result<()>;
}

#[op_interface_impl]
impl ToSpirvCFDialect for scf::IfOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let result_types = self.result_types(ctx);

        let selection = SelectionOp::new(ctx, result_types);
        let select_region = selection.region(ctx);
        let entry = selection.entry_block(ctx);
        rewriter.set_insertion_point_to_block_end(entry);

        let then_region = self.then_region(ctx);
        let then_block = self.then_block(ctx);
        let then_term = then_block.deref(ctx).get_terminator(ctx).unwrap();
        let else_region = self.else_region(ctx);
        let else_block = self.else_block(ctx);
        let else_term = else_block.deref(ctx).get_terminator(ctx).unwrap();

        let merge = BasicBlock::new(ctx, None, vec![]);

        let branch_cond = BranchConditionalOp::new(
            ctx,
            self.condition(ctx),
            then_block,
            vec![],
            else_block,
            vec![],
        );
        rewriter.append_op(ctx, &branch_cond);

        rewriter.set_insertion_point_before_operation(then_term);
        if then_term.is_op::<YieldOp>(ctx) {
            let args = then_term.operands(ctx);
            let then_branch = BranchOp::new(ctx, merge, args);
            rewriter.append_op(ctx, &then_branch);
            rewriter.erase_operation(ctx, then_term);
        } else if then_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `IfOp`")
        }

        rewriter.inline_region(ctx, then_region, BlockInsertionPoint::AfterBlock(entry));

        rewriter.set_insertion_point_before_operation(else_term);
        if else_term.is_op::<YieldOp>(ctx) {
            let args = else_term.operands(ctx);
            let else_branch = BranchOp::new(ctx, merge, args);
            rewriter.append_op(ctx, &else_branch);
            rewriter.erase_operation(ctx, else_term);
        } else if else_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `IfOp`")
        }

        rewriter.inline_region(
            ctx,
            else_region,
            BlockInsertionPoint::AfterBlock(then_block),
        );

        rewriter.insert_block(ctx, BlockInsertionPoint::AtRegionEnd(select_region), merge);
        rewriter.set_insertion_point_to_block_end(merge);

        let results = self.results(ctx);
        for result in results {
            BasicBlock::push_argument(merge, ctx, result.get_type(ctx));
        }

        let results = merge.arguments(ctx);
        let merge_op = MergeOp::new(ctx, results);
        rewriter.append_op(ctx, &merge_op);

        rewriter.set_insertion_point_before_operation(self.get_operation());
        rewriter.append_op(ctx, &selection);
        rewriter.replace_operation(ctx, self.get_operation(), selection.get_operation());

        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvCFDialect for scf::SwitchOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let result_types = self.result_types(ctx);

        let selection = SelectionOp::new(ctx, result_types);
        let select_region = selection.region(ctx);
        let entry = selection.entry_block(ctx);
        rewriter.set_insertion_point_to_block_end(entry);

        let default_region = self.default_region(ctx);
        let default_block = self.default_block(ctx);
        let default_term = default_block.deref(ctx).get_terminator(ctx).unwrap();
        let cases = self.get_attr_scf_switch_cases(ctx).unwrap().clone();
        let case_dests = self.get_case_destinations(ctx);

        let merge = BasicBlock::new(ctx, None, vec![]);

        let switch = ops::SwitchOp::new(
            ctx,
            self.value(ctx),
            default_block,
            vec![],
            VecAttr(cases.0.into_iter().map(Into::into).collect()),
            case_dests.clone(),
            vec![Vec::new(); case_dests.len()],
        );
        rewriter.append_op(ctx, &switch);

        rewriter.set_insertion_point_before_operation(default_term);
        if default_term.is_op::<YieldOp>(ctx) {
            let args = default_term.operands(ctx);
            let default_branch = BranchOp::new(ctx, merge, args);
            rewriter.append_op(ctx, &default_branch);
            rewriter.erase_operation(ctx, default_term);
        } else if default_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `SwitchOp`")
        }

        rewriter.inline_region(ctx, default_region, BlockInsertionPoint::AfterBlock(entry));

        for case_dest in case_dests {
            let case_term = case_dest.deref(ctx).get_terminator(ctx).unwrap();
            rewriter.set_insertion_point_before_operation(case_term);
            if case_term.is_op::<YieldOp>(ctx) {
                let args = case_term.operands(ctx);
                let case_branch = BranchOp::new(ctx, merge, args);
                rewriter.append_op(ctx, &case_branch);
                rewriter.erase_operation(ctx, case_term);
            } else if case_term.impls::<dyn IsExitTerminator>(ctx) {
                // Keep terminator, it's a valid terminator in SPIR-V
            } else {
                panic!("Unsupported terminator found in `SwitchOp`")
            }

            let region = case_dest.deref(ctx).get_parent_region().unwrap();
            rewriter.inline_region(ctx, region, BlockInsertionPoint::AtRegionEnd(select_region));
        }

        rewriter.insert_block(ctx, BlockInsertionPoint::AtRegionEnd(select_region), merge);
        rewriter.set_insertion_point_to_block_end(merge);

        let results = self.results(ctx);
        for result in results {
            BasicBlock::push_argument(merge, ctx, result.get_type(ctx));
        }

        let results = merge.arguments(ctx);
        let merge_op = MergeOp::new(ctx, results);
        rewriter.append_op(ctx, &merge_op);

        rewriter.set_insertion_point_before_operation(self.get_operation());
        rewriter.append_op(ctx, &selection);
        rewriter.replace_operation(ctx, self.get_operation(), selection.get_operation());

        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvCFDialect for scf::ForOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        define_scalar!(I);
        let scope = Scope::from_context_and_inserter(ctx, rewriter);

        let result_types = self.result_types(ctx);

        let old_iter_var = self.iter_var(ctx);
        let start = self.start(ctx);
        let end = self.end(ctx);
        let step = self.step(ctx);
        let mut header_args = self.initial_carried_values(ctx);
        header_args.insert(0, start);

        let header_arg_types = header_args.iter().map(|it| it.get_type(ctx)).collect();

        scope.register_value_type::<I, ()>(start);

        let r#loop = LoopOp::new(ctx, result_types);
        let loop_region = r#loop.region(ctx);
        let entry = r#loop.entry_block(ctx);
        rewriter.set_insertion_point_to_block_end(entry);

        let body_region = self.get_region(ctx);
        let body_block = self.loop_body(ctx);
        let body_term = body_block.deref(ctx).get_terminator(ctx).unwrap();

        let header = BasicBlock::new(ctx, Some(ident("header")), header_arg_types);
        let header_branch = BranchOp::new(ctx, header, header_args);
        rewriter.append_op(ctx, &header_branch);
        rewriter.insert_block(ctx, BlockInsertionPoint::AfterBlock(entry), header);
        rewriter.set_insertion_point_to_block_end(header);

        let iter_var = header.deref(ctx).get_argument(0);
        rewriter.replace_value_uses_with(ctx, old_iter_var, iter_var);

        let merge = BasicBlock::new(ctx, Some(ident("merge")), vec![]);

        let should_continue =
            I::__expand_native_lt(&scope, iter_var.into(), end.into()).read_value(&scope);

        let loop_branch =
            BranchConditionalOp::new(ctx, should_continue, body_block, vec![], merge, vec![]);
        rewriter.append_op(ctx, &loop_branch);

        rewriter.set_insertion_point_before_operation(body_term);
        let next_value =
            I::__expand_native_add(&scope, iter_var.into(), step.into()).read_value(&scope);

        if let Some(yield_op) = body_term.as_op::<YieldOp>(ctx) {
            let mut args = yield_op.yield_values(ctx);
            args.insert(0, next_value);

            let header_branch = BranchOp::new(ctx, header, args);
            rewriter.append_op(ctx, &header_branch);
            rewriter.erase_operation(ctx, body_term);
        } else if body_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `WhileOp`")
        }

        rewriter.inline_region(ctx, body_region, BlockInsertionPoint::AfterBlock(header));

        rewriter.insert_block(ctx, BlockInsertionPoint::AtRegionEnd(loop_region), merge);
        rewriter.set_insertion_point_to_block_end(merge);

        let num_body_args = body_block.deref(ctx).get_num_arguments();
        for i in (0..num_body_args).rev() {
            let old_value = body_block.deref(ctx).get_argument(i);
            let value = header.deref(ctx).get_argument(i);
            rewriter.replace_value_uses_with(ctx, old_value, value);
            BasicBlock::remove_argument(body_block, ctx, i);
        }

        let results = header.arguments(ctx).into_iter().skip(1);
        let merge_op = MergeOp::new(ctx, results.collect());
        rewriter.append_op(ctx, &merge_op);

        rewriter.set_insertion_point_before_operation(self.get_operation());
        rewriter.append_op(ctx, &r#loop);
        rewriter.replace_operation(ctx, self.get_operation(), r#loop.get_operation());

        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvCFDialect for scf::WhileOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let result_types = self.result_types(ctx);

        let r#loop = LoopOp::new(ctx, result_types);
        let entry = r#loop.entry_block(ctx);

        let before_region = self.before_region(ctx);
        let after_region = self.after_region(ctx);
        let before = self.before_block(ctx);
        let after = self.after_block(ctx);
        let merge = BasicBlock::new(ctx, Some(ident("merge")), vec![]);

        rewriter.inline_region(ctx, before_region, BlockInsertionPoint::AfterBlock(entry));
        rewriter.inline_region(ctx, after_region, BlockInsertionPoint::AfterBlock(before));
        rewriter.insert_block(ctx, BlockInsertionPoint::AfterBlock(after), merge);

        rewriter.set_insertion_point_to_block_end(entry);
        let before_args = self.initial_carried_values(ctx);
        let before_branch = BranchOp::new(ctx, before, before_args);
        rewriter.append_op(ctx, &before_branch);

        let before_term = before.deref(ctx).get_terminator(ctx).unwrap();
        rewriter.set_insertion_point_before_operation(before_term);

        if let Some(cond_op) = before_term.as_op::<ConditionOp>(ctx) {
            let cond = cond_op.condition(ctx);
            let after_branch = BranchConditionalOp::new(ctx, cond, after, vec![], merge, vec![]);
            rewriter.append_op(ctx, &after_branch);
            rewriter.erase_operation(ctx, before_term);
        } else if before_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `WhileOp`")
        }

        let after_term = after.deref(ctx).get_terminator(ctx).unwrap();
        rewriter.set_insertion_point_before_operation(after_term);
        if let Some(yield_op) = after_term.as_op::<YieldOp>(ctx) {
            let args = yield_op.yield_values(ctx);
            let back_branch = BranchOp::new(ctx, before, args);
            rewriter.append_op(ctx, &back_branch);
            rewriter.erase_operation(ctx, after_term);
        } else if after_term.impls::<dyn IsExitTerminator>(ctx) {
            // Keep terminator, it's a valid terminator in SPIR-V
        } else {
            panic!("Unsupported terminator found in `WhileOp`")
        }

        let num_after_args = after.deref(ctx).get_num_arguments();
        for i in (0..num_after_args).rev() {
            let old_value = after.deref(ctx).get_argument(i);
            let value = before.deref(ctx).get_argument(i);
            rewriter.replace_value_uses_with(ctx, old_value, value);
            BasicBlock::remove_argument(after, ctx, i);
        }

        rewriter.set_insertion_point_to_block_end(merge);
        let results = before.arguments(ctx);
        let merge_op = MergeOp::new(ctx, results);
        rewriter.append_op(ctx, &merge_op);

        rewriter.set_insertion_point_before_operation(self.get_operation());
        rewriter.append_op(ctx, &r#loop);
        rewriter.replace_operation(ctx, self.get_operation(), r#loop.get_operation());

        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvDialectOp for SelectionOp {
    fn to_spirv_dialect(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let results = self.get_operation().results(ctx);
        for res in results {
            let ty = ty_to_spirv_dialect(ctx, res.get_type(ctx));
            rewriter.set_value_type(ctx, res, ty);
        }
        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvDialectOp for LoopOp {
    fn to_spirv_dialect(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let results = self.get_operation().results(ctx);
        for res in results {
            let ty = ty_to_spirv_dialect(ctx, res.get_type(ctx));
            rewriter.set_value_type(ctx, res, ty);
        }
        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvCFDialect for branch::ReturnOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let op = self.get_operation();
        let opds = op.operands(ctx);
        let return_ = ops::ReturnOp::new(ctx, opds.into_iter().next());
        rewriter.append_op(ctx, &return_);
        rewriter.replace_operation(ctx, op, return_.get_operation());

        Ok(())
    }
}

#[op_interface_impl]
impl ToSpirvCFDialect for branch::UnreachableOp {
    fn rewrite(
        &self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        _operands_info: &OperandsInfo,
    ) -> Result<()> {
        let op = self.get_operation();
        let unreachable = ops::UnreachableOp::new(ctx);
        rewriter.append_op(ctx, &unreachable);
        rewriter.replace_operation(ctx, op, unreachable.get_operation());

        Ok(())
    }
}

pub type BranchToSpirvConversionPass = DialectConversionPass<BranchToSpirvConversion>;

#[derive(Default, NamedRewrite)]
pub struct BranchToSpirvConversion;

impl DialectConversion for BranchToSpirvConversion {
    fn can_convert_op(&self, ctx: &Context, op: Ptr<Operation>) -> bool {
        op.impls::<dyn ToSpirvCFDialect>(ctx)
    }

    fn rewrite(
        &mut self,
        ctx: &mut Context,
        rewriter: &mut DialectConversionRewriter,
        op: Ptr<Operation>,
        operands_info: &OperandsInfo,
    ) -> Result<()> {
        op_cast::<dyn ToSpirvCFDialect>(&*op.dyn_op(ctx))
            .unwrap()
            .rewrite(ctx, rewriter, operands_info)
    }
}