unluac 1.1.1

Multi-dialect Lua decompiler written in Rust.
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
//! 这个文件实现 CFG 之上的第一层图事实分析。
//!
//! 这里故意只回答“图上发生了什么”,例如支配、回边和 natural loop;
//! 结构化 if/loop 的源码级判断仍然留给后续 StructureFacts。

use std::collections::{BTreeSet, VecDeque};

use super::common::{
    BlockRef, Cfg, CfgGraph, DominatorTree, EdgeRef, GraphFacts, NaturalLoop, PostDominatorTree,
};

struct DenseBlockSet {
    present: Vec<bool>,
}

impl DenseBlockSet {
    fn new(block_count: usize) -> Self {
        Self {
            present: vec![false; block_count],
        }
    }

    fn from_blocks<I>(block_count: usize, blocks: I) -> Self
    where
        I: IntoIterator<Item = BlockRef>,
    {
        let mut set = Self::new(block_count);
        for block in blocks {
            set.present[block.index()] = true;
        }
        set
    }

    fn contains(&self, block: BlockRef) -> bool {
        self.present[block.index()]
    }

    fn insert(&mut self, block: BlockRef) -> bool {
        let slot = &mut self.present[block.index()];
        let inserted = !*slot;
        *slot = true;
        inserted
    }
}

struct GraphAnalysis {
    rpo: Vec<BlockRef>,
    dominator_tree: DominatorTree,
    post_dominator_tree: PostDominatorTree,
    dominance_frontier: Vec<BTreeSet<BlockRef>>,
    backedges: Vec<EdgeRef>,
    loop_headers: BTreeSet<BlockRef>,
    natural_loops: Vec<NaturalLoop>,
}

impl GraphAnalysis {
    fn analyze(cfg: &Cfg) -> Self {
        let reachable =
            DenseBlockSet::from_blocks(cfg.blocks.len(), cfg.reachable_blocks.iter().copied());
        let rpo = compute_rpo(cfg, &reachable);
        let dominator_tree = compute_dominator_tree(cfg, &rpo);
        let reverse_reachable = compute_reverse_reachable(cfg, &reachable);
        let reverse_rpo = compute_reverse_rpo(cfg, &reverse_reachable);
        let post_dominator_tree = compute_post_dominator_tree(cfg, &reverse_rpo);
        let dominance_frontier = compute_dominance_frontier(cfg, &dominator_tree, &reachable);
        let backedges = compute_backedges(cfg, &dominator_tree, &reachable);
        let loop_headers = compute_loop_headers(cfg, &backedges);
        let natural_loops = compute_natural_loops(cfg, &backedges, &reachable);

        Self {
            rpo,
            dominator_tree,
            post_dominator_tree,
            dominance_frontier,
            backedges,
            loop_headers,
            natural_loops,
        }
    }

    fn into_graph_facts(self, children: Vec<GraphFacts>) -> GraphFacts {
        GraphFacts {
            rpo: self.rpo,
            dominator_tree: self.dominator_tree,
            post_dominator_tree: self.post_dominator_tree,
            dominance_frontier: self.dominance_frontier,
            backedges: self.backedges,
            loop_headers: self.loop_headers,
            natural_loops: self.natural_loops,
            children,
        }
    }
}

/// 对整个 CFG 树递归计算图事实。
pub fn analyze_graph_facts(cfg: &CfgGraph) -> GraphFacts {
    let analysis = GraphAnalysis::analyze(&cfg.cfg);
    let children = cfg.children.iter().map(analyze_graph_facts).collect();
    analysis.into_graph_facts(children)
}

fn compute_rpo(cfg: &Cfg, reachable: &DenseBlockSet) -> Vec<BlockRef> {
    if !reachable.contains(cfg.entry_block) {
        return Vec::new();
    }

    let mut visited = DenseBlockSet::new(cfg.blocks.len());
    let mut postorder = Vec::new();
    dfs_postorder(
        cfg,
        cfg.entry_block,
        reachable,
        &mut visited,
        &mut postorder,
    );
    postorder.reverse();
    postorder
}

fn compute_dominator_tree(cfg: &Cfg, rpo: &[BlockRef]) -> DominatorTree {
    compute_tree(cfg, rpo, cfg.entry_block, false)
}

fn compute_post_dominator_tree(cfg: &Cfg, reverse_rpo: &[BlockRef]) -> PostDominatorTree {
    let tree = compute_tree(cfg, reverse_rpo, cfg.exit_block, true);

    PostDominatorTree {
        parent: tree.parent,
        children: tree.children,
        order: tree.order,
    }
}

fn compute_dominance_frontier(
    cfg: &Cfg,
    dom_tree: &DominatorTree,
    reachable: &DenseBlockSet,
) -> Vec<BTreeSet<BlockRef>> {
    let mut frontier = vec![BTreeSet::new(); cfg.blocks.len()];

    for block in (0..cfg.blocks.len())
        .map(BlockRef)
        .filter(|block| reachable.contains(*block) && cfg.preds[block.index()].len() >= 2)
    {
        let Some(block_parent) = dom_tree.parent[block.index()] else {
            continue;
        };

        for edge_ref in &cfg.preds[block.index()] {
            let mut runner = cfg.edges[edge_ref.index()].from;

            while runner != block_parent {
                frontier[runner.index()].insert(block);
                let Some(next_runner) = dom_tree.parent[runner.index()] else {
                    break;
                };
                runner = next_runner;
            }
        }
    }

    frontier
}

fn compute_backedges(
    cfg: &Cfg,
    dom_tree: &DominatorTree,
    reachable: &DenseBlockSet,
) -> Vec<EdgeRef> {
    cfg.edges
        .iter()
        .enumerate()
        .filter_map(|(index, edge)| {
            let edge_ref = EdgeRef(index);
            if reachable.contains(edge.from)
                && reachable.contains(edge.to)
                && dom_tree.dominates(edge.to, edge.from)
            {
                Some(edge_ref)
            } else {
                None
            }
        })
        .collect()
}

fn compute_loop_headers(cfg: &Cfg, backedges: &[EdgeRef]) -> BTreeSet<BlockRef> {
    backedges
        .iter()
        .copied()
        .map(|edge_ref| cfg.edges[edge_ref.index()].to)
        .collect()
}

fn compute_natural_loops(
    cfg: &Cfg,
    backedges: &[EdgeRef],
    reachable: &DenseBlockSet,
) -> Vec<NaturalLoop> {
    backedges
        .iter()
        .copied()
        .map(|backedge| {
            let edge = cfg.edges[backedge.index()];
            let mut blocks = BTreeSet::from([edge.to]);
            let mut worklist = VecDeque::new();

            if edge.from != edge.to {
                blocks.insert(edge.from);
                worklist.push_back(edge.from);
            }

            while let Some(block) = worklist.pop_front() {
                for pred_edge in &cfg.preds[block.index()] {
                    let pred = cfg.edges[pred_edge.index()].from;
                    if reachable.contains(pred) && blocks.insert(pred) {
                        worklist.push_back(pred);
                    }
                }
            }

            NaturalLoop {
                header: edge.to,
                backedge,
                blocks,
            }
        })
        .collect()
}

fn compute_reverse_reachable(cfg: &Cfg, reachable: &DenseBlockSet) -> DenseBlockSet {
    let mut reverse_reachable = DenseBlockSet::new(cfg.blocks.len());
    let mut worklist = VecDeque::from([cfg.exit_block]);

    while let Some(block) = worklist.pop_front() {
        if !reverse_reachable.insert(block) {
            continue;
        }

        for edge_ref in &cfg.preds[block.index()] {
            let pred = cfg.edges[edge_ref.index()].from;
            if reachable.contains(pred) && !reverse_reachable.contains(pred) {
                worklist.push_back(pred);
            }
        }
    }

    reverse_reachable
}

fn compute_reverse_rpo(cfg: &Cfg, reverse_reachable: &DenseBlockSet) -> Vec<BlockRef> {
    if !reverse_reachable.contains(cfg.exit_block) {
        return Vec::new();
    }

    let mut visited = DenseBlockSet::new(cfg.blocks.len());
    let mut postorder = Vec::new();
    dfs_reverse_postorder(
        cfg,
        cfg.exit_block,
        reverse_reachable,
        &mut visited,
        &mut postorder,
    );
    postorder.reverse();
    postorder
}

fn compute_tree(cfg: &Cfg, rpo: &[BlockRef], root: BlockRef, reverse: bool) -> DominatorTree {
    let mut position = vec![None; cfg.blocks.len()];
    for (index, block) in rpo.iter().copied().enumerate() {
        position[block.index()] = Some(index);
    }

    let mut idom = vec![None; cfg.blocks.len()];
    if position[root.index()].is_some() {
        idom[root.index()] = Some(root);
    }

    let mut changed = true;
    while changed {
        changed = false;

        for block in rpo.iter().copied().filter(|block| *block != root) {
            let mut incoming = incoming_blocks(cfg, block, reverse)
                .into_iter()
                .filter(|pred| idom[pred.index()].is_some());

            let Some(first) = incoming.next() else {
                continue;
            };
            let mut new_idom = first;

            for pred in incoming {
                new_idom = intersect(&idom, &position, pred, new_idom);
            }

            if idom[block.index()] != Some(new_idom) {
                idom[block.index()] = Some(new_idom);
                changed = true;
            }
        }
    }

    let mut parent = vec![None; cfg.blocks.len()];
    let mut children = vec![Vec::new(); cfg.blocks.len()];

    for (index, maybe_idom) in idom.into_iter().enumerate() {
        let block = BlockRef(index);
        let Some(idom_block) = maybe_idom else {
            continue;
        };
        if block == root {
            continue;
        }

        parent[index] = Some(idom_block);
        children[idom_block.index()].push(block);
    }

    let mut order = Vec::new();
    if position[root.index()].is_some() {
        collect_tree_order(root, &children, &mut order);
    }

    DominatorTree {
        parent,
        children,
        order,
    }
}

fn incoming_blocks(cfg: &Cfg, block: BlockRef, reverse: bool) -> Vec<BlockRef> {
    let edge_refs = if reverse {
        &cfg.succs[block.index()]
    } else {
        &cfg.preds[block.index()]
    };

    edge_refs
        .iter()
        .map(|edge_ref| {
            let edge = cfg.edges[edge_ref.index()];
            if reverse { edge.to } else { edge.from }
        })
        .collect()
}

fn intersect(
    idom: &[Option<BlockRef>],
    position: &[Option<usize>],
    mut finger_a: BlockRef,
    mut finger_b: BlockRef,
) -> BlockRef {
    while finger_a != finger_b {
        while position[finger_a.index()] > position[finger_b.index()] {
            finger_a =
                idom[finger_a.index()].expect("dominator walk should stay inside computed tree");
        }

        while position[finger_b.index()] > position[finger_a.index()] {
            finger_b =
                idom[finger_b.index()].expect("dominator walk should stay inside computed tree");
        }
    }

    finger_a
}

fn collect_tree_order(block: BlockRef, children: &[Vec<BlockRef>], order: &mut Vec<BlockRef>) {
    order.push(block);
    for child in &children[block.index()] {
        collect_tree_order(*child, children, order);
    }
}

fn dfs_postorder(
    cfg: &Cfg,
    block: BlockRef,
    visible: &DenseBlockSet,
    visited: &mut DenseBlockSet,
    postorder: &mut Vec<BlockRef>,
) {
    if !visible.contains(block) || !visited.insert(block) {
        return;
    }

    for edge_ref in &cfg.succs[block.index()] {
        let edge = cfg.edges[edge_ref.index()];
        dfs_postorder(cfg, edge.to, visible, visited, postorder);
    }

    postorder.push(block);
}

fn dfs_reverse_postorder(
    cfg: &Cfg,
    block: BlockRef,
    visible: &DenseBlockSet,
    visited: &mut DenseBlockSet,
    postorder: &mut Vec<BlockRef>,
) {
    if !visible.contains(block) || !visited.insert(block) {
        return;
    }

    for edge_ref in &cfg.preds[block.index()] {
        let edge = cfg.edges[edge_ref.index()];
        dfs_reverse_postorder(cfg, edge.from, visible, visited, postorder);
    }

    postorder.push(block);
}