seq-compiler 5.6.1

Compiler for the Seq programming language
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
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
//! Inline helpers for stack-shuffle, boolean, unary-integer, aux-slot, and
//! pick/roll operations. `dispatch::try_codegen_inline_op` dispatches to
//! these; they each take the current SP variable and return the new SP (or
//! the same one, for in-place ops).

use super::super::{CodeGen, CodeGenError};
use std::fmt::Write as _;

impl CodeGen {
    // =========================================================================
    // Stack shuffles
    // =========================================================================

    /// drop: ( a -- ). Calls the runtime so heap values are properly dropped.
    pub(super) fn codegen_inline_drop(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let result_var = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = call ptr @patch_seq_drop_op(ptr %{})",
            result_var, stack_var
        )?;
        Ok(Some(result_var))
    }

    /// dup: ( a -- a a ). Uses a fast raw-value copy when the top is known
    /// trivially copyable (literal or primitive), otherwise delegates to the
    /// runtime clone.
    pub(super) fn codegen_inline_dup(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let top_ptr = self.emit_stack_gep(stack_var, -1)?;

        let use_fast_path =
            self.prev_stmt_is_trivial_literal || self.is_trivially_copyable_at_current_stmt();

        if use_fast_path {
            let val = self.emit_load_value(&top_ptr)?;
            self.emit_store_value(stack_var, &val)?;
        } else {
            writeln!(
                &mut self.output,
                "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
                top_ptr, stack_var
            )?;
        }

        let result_var = self.emit_stack_gep(stack_var, 1)?;
        Ok(Some(result_var))
    }

    /// swap: ( a b -- b a )
    pub(super) fn codegen_inline_swap(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let ptr_b = self.emit_stack_gep(stack_var, -1)?;
        let ptr_a = self.emit_stack_gep(stack_var, -2)?;
        let val_a = self.emit_load_value(&ptr_a)?;
        let val_b = self.emit_load_value(&ptr_b)?;
        self.emit_store_value(&ptr_a, &val_b)?;
        self.emit_store_value(&ptr_b, &val_a)?;
        Ok(Some(stack_var.to_string()))
    }

    /// over: ( a b -- a b a )
    pub(super) fn codegen_inline_over(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let ptr_a = self.emit_stack_gep(stack_var, -2)?;
        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            ptr_a, stack_var
        )?;
        let result_var = self.emit_stack_gep(stack_var, 1)?;
        Ok(Some(result_var))
    }

    /// rot: ( a b c -- b c a )
    pub(super) fn codegen_inline_rot(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let ptr_c = self.emit_stack_gep(stack_var, -1)?;
        let ptr_b = self.emit_stack_gep(stack_var, -2)?;
        let ptr_a = self.emit_stack_gep(stack_var, -3)?;

        let val_a = self.emit_load_value(&ptr_a)?;
        let val_b = self.emit_load_value(&ptr_b)?;
        let val_c = self.emit_load_value(&ptr_c)?;

        self.emit_store_value(&ptr_a, &val_b)?;
        self.emit_store_value(&ptr_b, &val_c)?;
        self.emit_store_value(&ptr_c, &val_a)?;

        Ok(Some(stack_var.to_string()))
    }

    /// nip: ( a b -- b )
    pub(super) fn codegen_inline_nip(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let result_var = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = call ptr @patch_seq_nip(ptr %{})",
            result_var, stack_var
        )?;
        Ok(Some(result_var))
    }

    /// tuck: ( a b -- b a b )
    pub(super) fn codegen_inline_tuck(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let ptr_b = self.emit_stack_gep(stack_var, -1)?;
        let ptr_a = self.emit_stack_gep(stack_var, -2)?;

        let val_a = self.emit_load_value(&ptr_a)?;
        let val_b = self.emit_load_value(&ptr_b)?;

        // Clone b to the new top position
        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            ptr_b, stack_var
        )?;

        // Result: b a b
        self.emit_store_value(&ptr_a, &val_b)?;
        self.emit_store_value(&ptr_b, &val_a)?;

        let result_var = self.emit_stack_gep(stack_var, 1)?;
        Ok(Some(result_var))
    }

    /// 2dup: ( a b -- a b a b )
    pub(super) fn codegen_inline_two_dup(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let ptr_b = self.emit_stack_gep(stack_var, -1)?;
        let ptr_a = self.emit_stack_gep(stack_var, -2)?;

        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            ptr_a, stack_var
        )?;
        let new_ptr = self.emit_stack_gep(stack_var, 1)?;
        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            ptr_b, new_ptr
        )?;

        let result_var = self.emit_stack_gep(stack_var, 2)?;
        Ok(Some(result_var))
    }

    /// 3drop: ( a b c -- ). Three runtime drop calls in sequence.
    pub(super) fn codegen_inline_three_drop(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;

        let drop1 = self.fresh_temp();
        let drop2 = self.fresh_temp();
        let drop3 = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = call ptr @patch_seq_drop_op(ptr %{})",
            drop1, stack_var
        )?;
        writeln!(
            &mut self.output,
            "  %{} = call ptr @patch_seq_drop_op(ptr %{})",
            drop2, drop1
        )?;
        writeln!(
            &mut self.output,
            "  %{} = call ptr @patch_seq_drop_op(ptr %{})",
            drop3, drop2
        )?;
        Ok(Some(drop3))
    }

    // =========================================================================
    // Boolean logic
    // =========================================================================

    /// Boolean binary op (`and` / `or`) on two values. `llvm_op` is `"and"`
    /// or `"or"`. Result is normalised to 0/1 and stored as a Bool at the
    /// lower operand slot.
    pub(super) fn codegen_inline_bool_binary(
        &mut self,
        stack_var: &str,
        llvm_op: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let (ptr_a, val_a, val_b) = self.emit_load_two_int_operands(stack_var)?;

        let combined = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = {} i64 %{}, %{}",
            combined, llvm_op, val_a, val_b
        )?;
        let bool_result = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = icmp ne i64 %{}, 0",
            bool_result, combined
        )?;
        let zext = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = zext i1 %{} to i64",
            zext, bool_result
        )?;

        self.emit_store_bool(&ptr_a, &zext)?;
        let result_var = self.emit_stack_gep(stack_var, -1)?;
        Ok(Some(result_var))
    }

    /// not: ( a -- !a ). True iff a was zero.
    pub(super) fn codegen_inline_not(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let (top_ptr, val) = self.emit_load_top_int(stack_var)?;

        let is_zero = self.fresh_temp();
        writeln!(&mut self.output, "  %{} = icmp eq i64 %{}, 0", is_zero, val)?;
        let zext = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = zext i1 %{} to i64",
            zext, is_zero
        )?;

        self.emit_store_bool(&top_ptr, &zext)?;
        Ok(Some(stack_var.to_string()))
    }

    // =========================================================================
    // Integer unary
    // =========================================================================

    /// i.neg / negate: ( a -- -a ).
    pub(super) fn codegen_inline_negate(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let (top_ptr, val) = self.emit_load_top_int(stack_var)?;
        let neg_result = self.fresh_temp();
        writeln!(&mut self.output, "  %{} = sub i64 0, %{}", neg_result, val)?;
        self.emit_store_int_result_in_place(&top_ptr, &neg_result)?;
        Ok(Some(stack_var.to_string()))
    }

    /// bnot: ( a -- ~a ). Bitwise NOT via xor with -1.
    pub(super) fn codegen_inline_bnot(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let (top_ptr, val) = self.emit_load_top_int(stack_var)?;
        let not_result = self.fresh_temp();
        writeln!(&mut self.output, "  %{} = xor i64 %{}, -1", not_result, val)?;
        self.emit_store_int_result_in_place(&top_ptr, &not_result)?;
        Ok(Some(stack_var.to_string()))
    }

    // =========================================================================
    // Aux slot transfer
    // =========================================================================

    /// >aux: ( T -- ). Move top of main stack to the current aux slot.
    pub(super) fn codegen_inline_aux_push(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        let slot_idx = self.current_aux_sp;
        let slot_name = self.current_aux_slots[slot_idx].clone();

        let top_ptr = self.emit_stack_gep(stack_var, -1)?;
        let val = self.emit_load_value(&top_ptr)?;

        self.emit_store_value(&slot_name, &val)?;
        self.current_aux_sp += 1;

        // Reuse top_ptr as the new SP — it already points to sp-1 (the slot
        // we just consumed), so no additional GEP needed.
        Ok(Some(top_ptr))
    }

    /// aux>: ( -- T ). Move top of aux stack to main stack.
    pub(super) fn codegen_inline_aux_pop(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let stack_var = self.spill_virtual_stack(stack_var)?;
        let stack_var = stack_var.as_str();

        debug_assert!(
            self.current_aux_sp > 0,
            "aux>: aux stack underflow (typechecker should have caught this)"
        );
        self.current_aux_sp -= 1;
        let slot_idx = self.current_aux_sp;
        let slot_name = self.current_aux_slots[slot_idx].clone();

        let val = self.emit_load_value(&slot_name)?;
        self.emit_store_value(stack_var, &val)?;

        let result_var = self.emit_stack_gep(stack_var, 1)?;
        Ok(Some(result_var))
    }

    // =========================================================================
    // pick / roll
    // =========================================================================

    /// pick with runtime-N: ( ... xn ... x1 x0 n -- ... xn ... x1 x0 xn )
    pub(super) fn codegen_pick_dynamic(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let n_ptr = self.emit_stack_gep(stack_var, -1)?;
        let n_val = self.emit_load_int_payload(&n_ptr)?;

        // Calculate offset: -(n + 2) from stack_var
        let offset = self.fresh_temp();
        writeln!(&mut self.output, "  %{} = add i64 %{}, 2", offset, n_val)?;
        let neg_offset = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = sub i64 0, %{}",
            neg_offset, offset
        )?;

        let src_ptr = self.emit_dynamic_stack_gep(stack_var, &neg_offset)?;

        // Clone value from src to n_ptr (replacing n)
        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            src_ptr, n_ptr
        )?;

        Ok(Some(stack_var.to_string()))
    }

    /// pick with constant N known at compile time (Issue #192).
    pub(super) fn codegen_pick_constant(
        &mut self,
        stack_var: &str,
        n: usize,
    ) -> Result<Option<String>, CodeGenError> {
        // Destination: replace n at top of stack (sp - 1)
        let n_ptr = self.emit_stack_gep(stack_var, -1)?;

        // Source offset: -(n + 2) from stack_var
        let neg_offset = -((n + 2) as i64);
        let src_ptr = self.emit_stack_gep(stack_var, neg_offset)?;

        writeln!(
            &mut self.output,
            "  call void @patch_seq_clone_value(ptr %{}, ptr %{})",
            src_ptr, n_ptr
        )?;

        Ok(Some(stack_var.to_string()))
    }

    /// roll with runtime-N: ( ... xn xn-1 ... x1 x0 n -- ... xn-1 ... x1 x0 xn )
    pub(super) fn codegen_roll_dynamic(
        &mut self,
        stack_var: &str,
    ) -> Result<Option<String>, CodeGenError> {
        let n_ptr = self.emit_stack_gep(stack_var, -1)?;
        let n_val = self.emit_load_int_payload(&n_ptr)?;

        // Pop n: new SP is stack_var - 1
        let popped_sp = self.emit_stack_gep(stack_var, -1)?;

        // Calculate offset to xn: -(n + 1) from popped_sp
        let offset = self.fresh_temp();
        writeln!(&mut self.output, "  %{} = add i64 %{}, 1", offset, n_val)?;
        let neg_offset = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = sub i64 0, %{}",
            neg_offset, offset
        )?;

        let src_ptr = self.emit_dynamic_stack_gep(&popped_sp, &neg_offset)?;

        // Load the value to roll
        let rolled_val = self.emit_load_value(&src_ptr)?;

        // memmove: shift items down
        let src_plus_one = self.emit_stack_gep(&src_ptr, 1)?;

        // Size in bytes = n * value_size
        let value_size = self.value_size_bytes();
        let size_bytes = self.fresh_temp();
        writeln!(
            &mut self.output,
            "  %{} = mul i64 %{}, {}",
            size_bytes, n_val, value_size
        )?;

        writeln!(
            &mut self.output,
            "  call void @llvm.memmove.p0.p0.i64(ptr %{}, ptr %{}, i64 %{}, i1 false)",
            src_ptr, src_plus_one, size_bytes
        )?;

        // Store rolled value at top
        let top_ptr = self.emit_stack_gep(&popped_sp, -1)?;
        self.emit_store_value(&top_ptr, &rolled_val)?;

        Ok(Some(popped_sp))
    }

    /// roll with constant N known at compile time (Issue #192).
    pub(super) fn codegen_roll_constant(
        &mut self,
        stack_var: &str,
        n: usize,
    ) -> Result<Option<String>, CodeGenError> {
        // Pop the N value from stack
        let popped_sp = self.emit_stack_gep(stack_var, -1)?;

        match n {
            0 => Ok(Some(popped_sp)),
            1 => {
                // 1 roll = swap
                let ptr_b = self.emit_stack_gep(&popped_sp, -1)?;
                let ptr_a = self.emit_stack_gep(&popped_sp, -2)?;
                let val_a = self.emit_load_value(&ptr_a)?;
                let val_b = self.emit_load_value(&ptr_b)?;
                self.emit_store_value(&ptr_a, &val_b)?;
                self.emit_store_value(&ptr_b, &val_a)?;
                Ok(Some(popped_sp))
            }
            2 => {
                // 2 roll = rot
                let ptr_c = self.emit_stack_gep(&popped_sp, -1)?;
                let ptr_b = self.emit_stack_gep(&popped_sp, -2)?;
                let ptr_a = self.emit_stack_gep(&popped_sp, -3)?;
                let val_a = self.emit_load_value(&ptr_a)?;
                let val_b = self.emit_load_value(&ptr_b)?;
                let val_c = self.emit_load_value(&ptr_c)?;
                self.emit_store_value(&ptr_a, &val_b)?;
                self.emit_store_value(&ptr_b, &val_c)?;
                self.emit_store_value(&ptr_c, &val_a)?;
                Ok(Some(popped_sp))
            }
            _ => {
                // n >= 3: use memmove with constant offsets
                let neg_offset = -((n + 1) as i64);
                let src_ptr = self.emit_stack_gep(&popped_sp, neg_offset)?;

                let rolled_val = self.emit_load_value(&src_ptr)?;

                let src_plus_one = self.emit_stack_gep(&src_ptr, 1)?;
                let size_bytes = n as u64 * self.value_size_bytes();
                writeln!(
                    &mut self.output,
                    "  call void @llvm.memmove.p0.p0.i64(ptr %{}, ptr %{}, i64 {}, i1 false)",
                    src_ptr, src_plus_one, size_bytes
                )?;

                let top_ptr = self.emit_stack_gep(&popped_sp, -1)?;
                self.emit_store_value(&top_ptr, &rolled_val)?;

                Ok(Some(popped_sp))
            }
        }
    }
}