neyuki 0.6.1

A small Lua-like scripting language implemented in Rust
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

//! Common subexpression elimination for pure instructions.

use std::collections::HashMap;

use crate::compiler::ir::block::{ControlFlowGraph, IrModule};
use crate::compiler::ir::inst::IrInst;
use crate::compiler::ir::types::{IrBinaryOp, IrUnaryOp, IrVar};

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
enum ExpressionKey {
    BinOp(IrBinaryOp, IrVar, IrVar),
    UnOp(IrUnaryOp, IrVar),
}

fn canonical_binop_key(op: IrBinaryOp, lhs: IrVar, rhs: IrVar) -> ExpressionKey {
    match op {
        IrBinaryOp::Add
        | IrBinaryOp::Mul
        | IrBinaryOp::Eq
        | IrBinaryOp::Ne
        | IrBinaryOp::BitAnd
        | IrBinaryOp::BitOr
        | IrBinaryOp::BitXor => {
            if lhs.0 <= rhs.0 {
                ExpressionKey::BinOp(op, lhs, rhs)
            } else {
                ExpressionKey::BinOp(op, rhs, lhs)
            }
        }
        _ => ExpressionKey::BinOp(op, lhs, rhs),
    }
}

pub fn common_subexpression_elimination(module: &mut IrModule) {
    cse_slice(&mut module.main.instructions);
}

pub fn common_subexpression_elimination_cfg(cfg: &mut ControlFlowGraph) -> bool {
    let mut changed = false;
    for block in &mut cfg.blocks {
        if cse_slice(&mut block.instructions) {
            changed = true;
        }
    }
    changed
}

/// Operators whose result depends only on their operand values. `a .. b` on
/// a table consults state that a store or a call can change while the operand
/// variables stay the same, so it is never shared.
fn is_cse_candidate(op: IrBinaryOp) -> bool {
    !matches!(op, IrBinaryOp::Concat | IrBinaryOp::Coalesce)
}

/// Whether an instruction may run arbitrary code or change memory that an
/// earlier expression could have depended on (through a metamethod).
fn has_side_effects(inst: &IrInst) -> bool {
    matches!(
        inst,
        IrInst::Call { .. }
            | IrInst::Spread { .. }
            | IrInst::TForCall { .. }
            | IrInst::SetTable { .. }
            | IrInst::GetTable { .. }
            | IrInst::AppendArray { .. }
            | IrInst::SetGlobal { .. }
            | IrInst::SetUpval { .. }
    )
}

fn cse_slice(instructions: &mut [IrInst]) -> bool {
    let mut expr_map: HashMap<ExpressionKey, IrVar> = HashMap::new();
    let mut modified = false;

    for inst in instructions.iter_mut() {
        if has_side_effects(inst) {
            expr_map.clear();
        }
        match inst {
            IrInst::BinOp { dst, op, lhs, rhs } if is_cse_candidate(*op) => {
                let key = canonical_binop_key(*op, *lhs, *rhs);
                if let Some(&existing_var) = expr_map.get(&key) {
                    if existing_var != *dst {
                        *inst = IrInst::Move {
                            dst: *dst,
                            src: existing_var,
                        };
                        modified = true;
                    }
                } else {
                    let d = *dst;
                    invalidate_expressions(&mut expr_map, d);
                    expr_map.insert(key, d);
                    continue;
                }
            }
            // `#t` reads the table, which anything in between may have grown.
            IrInst::UnOp { dst, op, src } if *op != IrUnaryOp::Len => {
                let key = ExpressionKey::UnOp(*op, *src);
                if let Some(&existing_var) = expr_map.get(&key) {
                    if existing_var != *dst {
                        *inst = IrInst::Move {
                            dst: *dst,
                            src: existing_var,
                        };
                        modified = true;
                    }
                } else {
                    let d = *dst;
                    invalidate_expressions(&mut expr_map, d);
                    expr_map.insert(key, d);
                    continue;
                }
            }
            _ => {}
        }

        // Any instruction that modifies a variable invalidates expressions using or defining it
        for def in inst.def_vars() {
            invalidate_expressions(&mut expr_map, def);
        }
    }

    modified
}

fn invalidate_expressions(map: &mut HashMap<ExpressionKey, IrVar>, modified_var: IrVar) {
    map.retain(|key, &mut target_var| {
        if target_var == modified_var {
            return false;
        }
        match key {
            ExpressionKey::BinOp(_, lhs, rhs) => *lhs != modified_var && *rhs != modified_var,
            ExpressionKey::UnOp(_, src) => *src != modified_var,
        }
    });
}