evalit 0.2.0-beta.0

a toy interpreter
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
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
use std::{
    collections::{HashMap, HashSet},
    fmt,
    hash::Hash,
};

use log::trace;
use petgraph::Direction::Outgoing;

use super::ir::instruction::{Block, BlockId, ControlFlowGraph, Instruction, Value};
use crate::bytecode::{MIN_REQUIRED_REGISTER, Register};

#[derive(Debug, Clone)]
pub struct LiveRange {
    start: usize,
    end: usize,
}

#[derive(Debug, Clone)]
pub struct LiveInterval {
    var: Value,
    start: usize,
    end: usize,
    ranges: Vec<LiveRange>,
    reg: Option<Register>,
    stack: Option<usize>,
}

impl LiveInterval {
    pub fn new(var: Value) -> Self {
        LiveInterval {
            var,
            start: usize::MAX,
            end: 0,
            ranges: Vec::new(),
            reg: None,
            stack: None,
        }
    }

    pub fn active(&mut self, index: usize, at_block_start: bool) {
        match self.ranges.last_mut() {
            Some(last) => {
                if at_block_start {
                    self.ranges.push(LiveRange {
                        start: index,
                        end: index,
                    });
                } else if last.end == index - 1 {
                    last.end = last.end.max(index);
                } else {
                    self.ranges.push(LiveRange {
                        start: index,
                        end: index,
                    });
                }
            }
            None => {
                self.ranges.push(LiveRange {
                    start: index,
                    end: index,
                });
            }
        }
        self.start = self.start.min(index);
        self.end = self.end.max(index);
    }

    pub fn update_end(&mut self, index: usize) {
        self.end = self.end.max(index);
    }
}

#[derive(Debug, Clone)]
pub(crate) struct Liveness {
    intervals: HashMap<Value, LiveInterval>,
}

impl Liveness {
    fn new() -> Self {
        Liveness {
            intervals: HashMap::new(),
        }
    }

    fn intervals(&self) -> Vec<LiveInterval> {
        self.intervals.values().cloned().collect()
    }

    fn set_register(&mut self, var: Value, reg: Register) {
        self.intervals.get_mut(&var).unwrap().reg.replace(reg);
    }

    fn set_stack(&mut self, var: Value, stack: usize) {
        self.intervals.get_mut(&var).unwrap().stack.replace(stack);
    }

    fn stack_size(&self) -> usize {
        let stacks = self
            .intervals
            .values()
            .filter(|interval| interval.stack.is_some());

        if stacks.clone().count() == 0 {
            return 0;
        }

        stacks
            .map(|interval| interval.stack.unwrap())
            .max()
            .unwrap_or(0)
            + 1
    }
}

pub struct LiveIntervalAnalyzer {}

impl LiveIntervalAnalyzer {
    pub fn scan(cfg: &ControlFlowGraph) -> Liveness {
        // 1. 遍历一次控制流图,生成基本存活区间
        let mut liveness = Self::build_basic_intervals(cfg);

        // 第二遍:计算live_in和live_out集合
        let (_live_in_sets, live_out_sets) = Self::compute_liveness_sets(cfg);

        // 第三遍:更新变量存活周期
        Self::update_intervals(cfg, &live_out_sets, &mut liveness);

        liveness
    }

    /// 第一遍:扫描所有指令,建立基本的LiveInterval
    fn build_basic_intervals(cfg: &ControlFlowGraph) -> Liveness {
        let mut liveness = Liveness::new();
        let mut index = 0;

        for block in cfg.blocks.iter() {
            let block_start = index;

            for inst in block.instructions.iter() {
                Self::process_instruction(&mut liveness, index, inst, index == block_start);
                index += 1;
            }

            // let block_end = index - 1;
            // Self::leave_block(&mut liveness, block_start, block_end);
        }

        liveness
    }

    /// 处理指令中的变量,更新LiveInterval
    fn process_instruction(
        liveness: &mut Liveness,
        index: usize,
        inst: &Instruction,
        at_block_start: bool,
    ) {
        let (defined, used) = inst.defined_and_used_vars();

        // 处理使用的变量(在定义之前处理使用)
        for var in used {
            if matches!(var, Value::Variable(_)) {
                liveness
                    .intervals
                    .entry(var)
                    .or_insert(LiveInterval::new(var))
                    .active(index, at_block_start);
            }
        }

        // 处理定义的变量
        for var in defined {
            if matches!(var, Value::Variable(_)) {
                liveness
                    .intervals
                    .entry(var)
                    .or_insert(LiveInterval::new(var))
                    .active(index, at_block_start);
            }
        }
    }

    /// 第二遍:计算每个块的live_in和live_out集合
    fn compute_liveness_sets(
        cfg: &ControlFlowGraph,
    ) -> (
        HashMap<BlockId, HashSet<Value>>,
        HashMap<BlockId, HashSet<Value>>,
    ) {
        let mut live_in_sets = HashMap::new();
        let mut live_out_sets = HashMap::new();
        let mut changed = true;

        // 初始化每个块的live_in和live_out为空集合
        for block in cfg.blocks.iter() {
            live_in_sets.insert(block.id, HashSet::new());
            live_out_sets.insert(block.id, HashSet::new());
        }

        while changed {
            changed = false;

            // 从后向前遍历基本块
            for block in cfg.blocks.iter().rev() {
                // 计算当前块的live_out(从后继块的live_in获取)
                let mut new_live_out = Self::compute_block_liveness(cfg, block, &live_in_sets);

                // 从后向前扫描指令
                for inst in block.instructions.iter().rev() {
                    let (defined, used) = inst.defined_and_used_vars();

                    // 先从live_out中移除定义的变量
                    for var in defined {
                        if matches!(var, Value::Variable(_)) {
                            new_live_out.remove(&var);
                        }
                    }

                    // 添加使用的变量到live_out(这些变量在此指令之前必须是活跃的)
                    for var in used {
                        if matches!(var, Value::Variable(_)) {
                            new_live_out.insert(var);
                        }
                    }
                }

                // live_in就是扫描完所有指令后的live_out
                let new_live_in: HashSet<Value> = new_live_out.clone();

                // 检查是否有变化
                let old_live_in = live_in_sets.get(&block.id).unwrap();
                let old_live_out = live_out_sets.get(&block.id).unwrap();

                if &new_live_in != old_live_in || &new_live_out != old_live_out {
                    changed = true;
                    live_in_sets.insert(block.id, new_live_in);
                    live_out_sets.insert(block.id, new_live_out);
                }
            }
        }

        (live_in_sets, live_out_sets)
    }

    /// 计算单个基本块的live_out(从后继块的live_in获取)
    fn compute_block_liveness(
        cfg: &ControlFlowGraph,
        block: &Block,
        live_in_sets: &HashMap<BlockId, HashSet<Value>>,
    ) -> HashSet<Value> {
        let mut live_out = HashSet::new();

        // 获取当前块在图中的节点索引
        if let Some(&node_index) = cfg.block_node_map.get(&block.id) {
            // 获取所有后继块
            let successors = cfg
                .graph
                .neighbors_directed(node_index, petgraph::Direction::Outgoing);

            // 遍历所有后继块
            for succ_node in successors {
                // 获取后继块的BlockId
                let succ_block_id = cfg.graph[succ_node];

                // 将后继块的live_in中的所有变量添加到当前块的live_out中
                if let Some(succ_live_in) = live_in_sets.get(&succ_block_id) {
                    live_out.extend(succ_live_in.iter().cloned());
                }
            }
        }

        live_out
    }

    /// 第三遍:更新变量的存活周期
    fn update_intervals(
        cfg: &ControlFlowGraph,
        live_out_sets: &HashMap<BlockId, HashSet<Value>>,
        liveness: &mut Liveness,
    ) {
        // 计算每个块的起始和结束索引
        let mut block_starts = Vec::with_capacity(cfg.blocks.len());
        let mut current_index = 0;

        for block in cfg.blocks.iter() {
            block_starts.push(current_index);
            current_index += block.instructions.len();
        }

        // 遍历所有块,更新变量的存活周期
        for (block_id, block) in cfg.blocks.iter().enumerate() {
            let block_start = block_starts[block_id];
            let block_end = block_start + block.instructions.len();

            // 获取当前块的live_out集合
            if let Some(live_out) = live_out_sets.get(&block.id) {
                // 更新live_out中变量的存活周期
                for &var in live_out {
                    if let Some(interval) = liveness.intervals.get_mut(&var) {
                        // 检查块是否在循环中
                        if let Some(&node_index) = cfg.block_node_map.get(&block.id) {
                            let successors = cfg.graph.neighbors_directed(node_index, Outgoing);

                            let is_loop = successors.clone().any(|succ_node| {
                                let succ_block_id = cfg.graph[succ_node];
                                // 检查是否有后继指向自己或之前的块
                                if let Some(succ_block) =
                                    cfg.blocks.iter().position(|b| b.id == succ_block_id)
                                {
                                    succ_block <= block_id
                                } else {
                                    false
                                }
                            });

                            if is_loop {
                                // 在循环中,确保变量在整个循环范围内都是活跃的
                                interval.update_end(block_end);

                                // 对于循环中的每个后继块,延长变量的活跃期
                                for succ_node in successors {
                                    let succ_block_id = cfg.graph[succ_node];
                                    if let Some(succ_block) =
                                        cfg.blocks.iter().position(|b| b.id == succ_block_id)
                                    {
                                        if succ_block <= block_id {
                                            interval.update_end(block_starts[succ_block]);
                                        }
                                    }
                                }
                            } else {
                                interval.update_end(block_end);
                            }
                        }
                    }
                }
            }
        }
    }
}

#[derive(Debug, Clone)]
pub struct RegAlloc {
    liveness: Liveness,
    pub(super) reg_set: RegisterSet,
}

impl RegAlloc {
    pub fn new(registers: &[Register]) -> Self {
        if registers.len() <= MIN_REQUIRED_REGISTER {
            panic!("Not enough registers");
        }
        Self {
            liveness: Liveness::new(),
            reg_set: RegisterSet::new(registers),
        }
    }

    pub fn load_arg(&mut self, arg: usize) -> isize {
        0 - ((arg as isize) + 1)
    }

    pub fn in_use_registers(&self) -> Vec<Register> {
        self.reg_set
            .registers
            .iter()
            .filter(|reg| reg.variable.is_some())
            .map(|reg| reg.register)
            .collect()
    }

    pub fn stack_size(&self) -> usize {
        self.liveness.stack_size()
    }

    pub fn alloc(&mut self, value: Value, index: usize) -> (Register, Option<Action>) {
        trace!("allocating {value}");

        let interval = self.liveness.intervals.get(&value).unwrap();

        match self.reg_set.find(value) {
            Some(register) => (register, None),
            None => match interval.reg {
                Some(register) => {
                    self.reg_set.use_register(register, value, true);
                    (register, None)
                }
                None => {
                    let reg = self.reg_set.must_alloc(value);

                    if interval
                        .ranges
                        .iter()
                        .any(|range| range.start == index && interval.start != index)
                    {
                        let spill = Action::Restore {
                            stack: interval.stack.unwrap(),
                            register: reg,
                        };

                        return (reg, Some(spill));
                    }

                    (reg, None)
                }
            },
        }
    }

    pub fn release(&mut self, value: Value, index: usize) -> Option<Action> {
        trace!("releasing {value}");

        if !matches!(value, Value::Variable(_)) {
            return None;
        }

        let interval = self.liveness.intervals.get(&value).unwrap();
        if interval.ranges.iter().any(|range| range.end == index) {
            if let Some(stack) = interval.stack {
                if let Some(register) = self.reg_set.release(value) {
                    let spill = Action::Spill { register, stack };
                    return Some(spill);
                }
            }
        }

        None
    }

    pub fn arrange(&mut self, cfg: &ControlFlowGraph) {
        self.liveness = LiveIntervalAnalyzer::scan(cfg);

        let registers: Vec<Register> = self
            .reg_set
            .registers
            .iter()
            .map(|reg| reg.register)
            .collect();

        let mut intervals = self.liveness.intervals();

        // 按开始时间排序,优先处理长区间
        intervals.sort_by(|a, b| {
            let a_len = a.end - a.start;
            let b_len = b.end - b.start;
            a.start.cmp(&b.start).then(b_len.cmp(&a_len))
        });

        // 1. 分组
        let mut groups: Vec<Vec<LiveInterval>> = Vec::new();
        for interval in intervals {
            let mut placed = false;
            for group in groups.iter_mut() {
                if Self::can_join_group(&interval, group) {
                    group.push(interval.clone());
                    placed = true;
                    break;
                }
            }
            if !placed {
                groups.push(vec![interval.clone()]);
            }
        }

        // 2. 分配寄存器
        // 2.1 如果组数量不多于可用寄存器数量,则直接分配
        if groups.len() <= registers.len() {
            for (group, reg) in groups.into_iter().zip(registers.iter()) {
                for interval in group {
                    self.liveness.set_register(interval.var, *reg);
                }
            }
            return;
        }

        // 2.2 保留3个临时寄存器,其他的进行优先级分配
        let (_temp_regs, fixed_regs) = registers.split_at(3);

        // 排序
        groups.sort_by(|a, b| {
            // let a_len: usize = a.iter().map(|interval| interval.end - interval.start).sum();
            // let b_len: usize = b.iter().map(|interval| interval.end - interval.start).sum();
            // b_len.cmp(&a_len)

            let a_len: usize = a.iter().map(|interval| interval.ranges.len()).sum();
            let b_len: usize = b.iter().map(|interval| interval.ranges.len()).sum();
            b_len.cmp(&a_len)
        });

        for (i, group) in groups.iter().enumerate() {
            trace!("Group[{i}]: {group:?}");
            // let vars = group.iter().map(|interval| interval.var).collect::<Vec<_>>();
            // trace!("Group[{i}]: {vars:?}");
        }

        // 2.2.1 分配固定寄存器
        let (fixed_group, temp_group) = groups.split_at(fixed_regs.len());
        for (group, reg) in fixed_group.iter().zip(fixed_regs) {
            for interval in group {
                self.liveness.set_register(interval.var, *reg);
            }
        }

        // 2.2.2 分配临时寄存器,只分配栈上空间,不分配寄存器
        for (i, group) in temp_group.iter().enumerate() {
            for interval in group {
                self.liveness.set_stack(interval.var, i);
            }
        }
    }

    fn can_join_group(interval: &LiveInterval, group: &[LiveInterval]) -> bool {
        group
            .iter()
            .all(|existing| !Self::has_overlap(interval, existing))
    }

    fn has_overlap(interval_a: &LiveInterval, interval_b: &LiveInterval) -> bool {
        // 直接使用interval的start和end来判断重叠
        interval_a.start <= interval_b.end && interval_b.start <= interval_a.end
    }
}

#[derive(Debug, Clone)]
pub(super) struct RegisterSet {
    registers: Vec<RegisterHold>,
}

impl RegisterSet {
    fn new(registers: &[Register]) -> Self {
        let registers = registers
            .iter()
            .map(|addr| RegisterHold::new(*addr))
            .collect();
        Self { registers }
    }

    fn must_alloc(&mut self, value: Value) -> Register {
        let reg = self
            .registers
            .iter_mut()
            .find(|reg| reg.variable.is_none())
            .unwrap();
        reg.variable = Some(value);
        reg.register
    }

    fn release(&mut self, value: Value) -> Option<Register> {
        match self
            .registers
            .iter_mut()
            .find(|reg| reg.variable == Some(value))
        {
            Some(reg) => {
                reg.variable = None;
                Some(reg.register)
            }
            None => None,
        }
    }

    fn use_register(&mut self, register: Register, variable: Value, is_fixed: bool) {
        for reg in self.registers.iter_mut() {
            if reg.register == register {
                reg.variable = Some(variable);
                reg.is_fixed = is_fixed;
                return;
            }
        }
    }

    fn find(&self, variable: Value) -> Option<Register> {
        self.registers
            .iter()
            .find(|reg| reg.variable == Some(variable))
            .map(|reg| reg.register)
    }
}

impl fmt::Display for RegisterSet {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for register in self.registers.iter() {
            match register.variable {
                Some(var) => write!(f, "{var}"),
                None => write!(f, "-"),
            }?;
            write!(f, "\t|")?;
        }
        Ok(())
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
struct RegisterHold {
    register: Register,
    variable: Option<Value>,
    is_fixed: bool,
}

impl RegisterHold {
    fn new(register: Register) -> Self {
        Self {
            register,
            variable: None,
            is_fixed: false,
        }
    }
}

pub enum Action {
    Restore { stack: usize, register: Register },
    Spill { register: Register, stack: usize },
}