unluac 1.2.2

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
414
415
416
417
418
419
420
421
422
423
424
425
426
//! 这个子模块负责把已确认的 `LoopCandidate` 真正降成 HIR 循环语句。
//!
//! 它依赖 StructureFacts 已区分好的 while/repeat/numeric-for/generic-for 形态和 override
//! 状态,不会在这里重新识别循环种类。
//! 例如:`NumericForLike` 的候选会在这里降成 `HirStmt::NumericFor`。

use super::*;

impl<'a, 'b> StructuredBodyLowerer<'a, 'b> {
    pub(crate) fn lower_loop(
        &mut self,
        block: BlockRef,
        stop: Option<BlockRef>,
        stmts: &mut Vec<HirStmt>,
        target_overrides: &BTreeMap<TempId, HirLValue>,
    ) -> Option<Option<BlockRef>> {
        let candidate = *self.loop_by_header.get(&block)?;
        if !candidate.reducible {
            return None;
        }

        match candidate.kind_hint {
            LoopKindHint::WhileLike => {
                self.lower_while_loop(candidate, stop, stmts, target_overrides)
            }
            LoopKindHint::RepeatLike => {
                self.lower_repeat_loop(candidate, stop, stmts, target_overrides)
            }
            LoopKindHint::NumericForLike => {
                self.try_lower_numeric_for_init(block, stop, stmts, target_overrides)
            }
            LoopKindHint::GenericForLike => {
                self.try_lower_generic_for_preheader(block, stop, stmts, target_overrides)
            }
            LoopKindHint::Unknown => None,
        }
    }

    fn lower_while_loop(
        &mut self,
        candidate: &LoopCandidate,
        stop: Option<BlockRef>,
        stmts: &mut Vec<HirStmt>,
        target_overrides: &BTreeMap<TempId, HirLValue>,
    ) -> Option<Option<BlockRef>> {
        let preheader = unique_loop_preheader(candidate);
        let (body_entry, branch_exit) =
            loop_branch_body_and_exit(self.lowering, candidate.header, &candidate.blocks)?;
        let exit = branch_exit;
        if let Some(stop) = stop
            && stop != exit
            && candidate.blocks.contains(&stop)
        {
            return None;
        }

        let plan = self.build_loop_state_plan(candidate, preheader, exit, &[], target_overrides)?;
        let combined_target_overrides =
            merge_target_overrides(target_overrides, &plan.backedge_target_overrides);
        let mut loop_context = self.build_active_loop_context(
            candidate,
            exit,
            &combined_target_overrides,
            &plan.states,
        )?;
        loop_context.loop_blocks = candidate.blocks.clone();
        loop_context.state_slots = plan.states.clone();
        stmts.extend(loop_state_init_stmts(&plan));
        self.visited.insert(candidate.header);
        self.install_loop_exit_bindings(candidate, exit, &plan, target_overrides);

        self.active_loops.push(loop_context.clone());
        let body = self.lower_region(
            body_entry,
            Some(candidate.header),
            &combined_target_overrides,
        )?;
        self.active_loops.pop();
        self.visited.extend(
            loop_context
                .break_exits
                .values()
                .flat_map(|break_exit| break_exit.blocks.iter().copied()),
        );
        if let Some(continue_target) = loop_context.continue_target {
            self.visited.insert(continue_target);
        }
        let mut cond = self.lower_branch_cond_for_target(candidate.header, body_entry)?;
        let (mut cond_expr_overrides, all_prefix_temps) =
            self.block_prefix_temp_expr_overrides(candidate.header);
        cond_expr_overrides.extend(temp_expr_overrides(&combined_target_overrides));
        rewrite_expr_temps(&mut cond, &cond_expr_overrides);

        // 只有当条件表达式引用了前缀中无法内联的 temp 时才需要回退。
        // 前缀中已成功内联的 temp 经 rewrite_expr_temps 处理后不再以 TempRef 出现;
        // 指向前缀外部(局部变量、upvalue 等)的 TempRef 是合法的,不触发回退。
        let unresolvable_prefix_temps: BTreeSet<TempId> = all_prefix_temps
            .into_iter()
            .filter(|t| !cond_expr_overrides.contains_key(t))
            .collect();

        // 循环头部存在无法内联到条件表达式的指令时(如多返回值调用),
        // 条件中会残留指向前缀内部的 TempRef。此时回退为 `while true do prefix; if-break; body end`,
        // 把原来的头部前缀显式作为循环体开头,条件取反作为 break 守卫。
        // 输入形状:header=[call multi_ret; branch ok] + body_entry=[short-circuit/continue]
        // 输出形状:while true do local ok,val=call(); if not ok then break end; <body> end
        if expr_has_temp_ref_in(&cond, &unresolvable_prefix_temps) {
            let prefix =
                self.lower_block_prefix(candidate.header, true, &combined_target_overrides)?;
            let break_cond = cond.negate();
            let mut full_body = prefix;
            full_body.push(HirStmt::If(Box::new(HirIf {
                cond: break_cond,
                then_block: HirBlock {
                    stmts: vec![HirStmt::Break],
                },
                else_block: None,
            })));
            full_body.extend(body.stmts);
            stmts.push(HirStmt::While(Box::new(HirWhile {
                cond: HirExpr::Boolean(true),
                body: HirBlock { stmts: full_body },
            })));
        } else {
            stmts.push(HirStmt::While(Box::new(HirWhile { cond, body })));
        }

        Some(Some(exit))
    }

    fn lower_repeat_loop(
        &mut self,
        candidate: &LoopCandidate,
        stop: Option<BlockRef>,
        stmts: &mut Vec<HirStmt>,
        target_overrides: &BTreeMap<TempId, HirLValue>,
    ) -> Option<Option<BlockRef>> {
        let preheader = unique_loop_preheader(candidate);
        let continue_block = candidate.continue_target?;
        let (loop_backedge_target, exit) =
            loop_branch_body_and_exit(self.lowering, continue_block, &candidate.blocks)?;
        if let Some(stop) = stop
            && stop != exit
            && candidate.blocks.contains(&stop)
        {
            return None;
        }

        let plan = self.build_loop_state_plan(candidate, preheader, exit, &[], target_overrides)?;
        let combined_target_overrides =
            merge_target_overrides(target_overrides, &plan.backedge_target_overrides);
        let mut loop_context = self.build_active_loop_context(
            candidate,
            exit,
            &combined_target_overrides,
            &plan.states,
        )?;
        loop_context.loop_blocks = candidate.blocks.clone();
        loop_context.state_slots = plan.states.clone();
        let backedge_pad = self.repeat_backedge_pad(
            candidate.header,
            loop_backedge_target,
            &combined_target_overrides,
        )?;
        let suppressed = plan
            .states
            .iter()
            .map(|state| state.phi_id)
            .collect::<Vec<_>>();
        for phi_id in &suppressed {
            self.overrides.suppress_phi(*phi_id);
        }

        self.active_loops.push(loop_context.clone());
        let mut body = self
            .lower_region_with_suppressed_loop(
                candidate.header,
                Some(continue_block),
                &combined_target_overrides,
                Some(candidate.header),
            )?
            .stmts;
        body.extend(self.lower_block_prefix(continue_block, true, &combined_target_overrides)?);
        self.active_loops.pop();
        for phi_id in suppressed {
            self.overrides.unsuppress_phi(phi_id);
        }

        stmts.extend(loop_state_init_stmts(&plan));
        self.visited.insert(continue_block);
        if let Some(backedge_pad) = backedge_pad {
            self.visited.insert(backedge_pad);
        }
        self.visited.extend(
            loop_context
                .break_exits
                .values()
                .flat_map(|break_exit| break_exit.blocks.iter().copied()),
        );
        self.install_loop_exit_bindings(candidate, exit, &plan, target_overrides);
        stmts.push(HirStmt::Repeat(Box::new(HirRepeat {
            body: HirBlock { stmts: body },
            cond: {
                let mut cond = self.lower_branch_cond_for_target(continue_block, exit)?;
                rewrite_expr_temps(&mut cond, &temp_expr_overrides(&combined_target_overrides));
                cond
            },
        })));

        Some(Some(exit))
    }

    pub(crate) fn try_lower_numeric_for_init(
        &mut self,
        block: BlockRef,
        stop: Option<BlockRef>,
        stmts: &mut Vec<HirStmt>,
        target_overrides: &BTreeMap<TempId, HirLValue>,
    ) -> Option<Option<BlockRef>> {
        let (instr_ref, instr) = self.block_terminator(block)?;
        let LowInstr::NumericForInit(init) = instr else {
            return None;
        };
        let init = *init;

        let header = self.lowering.cfg.instr_to_block[init.body_target.index()];
        let candidate = *self.loop_by_header.get(&header)?;
        if !candidate.reducible || candidate.kind_hint != LoopKindHint::NumericForLike {
            return None;
        }

        let exit = self.lowering.cfg.instr_to_block[init.exit_target.index()];
        if !candidate.exits.contains(&exit) {
            return None;
        }
        if let Some(stop) = stop
            && stop != exit
            && candidate.blocks.contains(&stop)
        {
            return None;
        }

        let binding = self
            .lowering
            .bindings
            .numeric_for_locals
            .get(&header)
            .copied()?;
        let plan = self.build_loop_state_plan(
            candidate,
            Some(block),
            exit,
            &[init.index],
            target_overrides,
        )?;
        let combined_target_overrides =
            merge_target_overrides(target_overrides, &plan.backedge_target_overrides);
        let mut suppressed = plan
            .states
            .iter()
            .map(|state| state.phi_id)
            .collect::<Vec<_>>();
        suppressed.extend(
            Self::header_values(candidate)
                .filter(|value| value.reg == init.index)
                .map(|value| value.phi_id),
        );

        self.visited.insert(block);
        stmts.extend(self.lower_block_prefix(block, false, target_overrides)?);
        stmts.extend(loop_state_init_stmts(&plan));

        for phi_id in &suppressed {
            self.overrides.suppress_phi(*phi_id);
        }
        let continue_block = candidate.continue_target.unwrap_or(header);
        let mut loop_context = self.build_active_loop_context(
            candidate,
            exit,
            &combined_target_overrides,
            &plan.states,
        )?;
        loop_context.loop_blocks = candidate.blocks.clone();
        loop_context.state_slots = plan.states.clone();
        self.active_loops.push(loop_context.clone());
        let body = if continue_block == header {
            let stmts = self.lower_block_prefix(header, false, &combined_target_overrides)?;
            HirBlock { stmts }
        } else {
            let mut stmts = self
                .lower_region_with_suppressed_loop(
                    header,
                    Some(continue_block),
                    &combined_target_overrides,
                    Some(header),
                )?
                .stmts;
            let prefix =
                self.lower_block_prefix(continue_block, false, &combined_target_overrides)?;
            stmts.extend(prefix);
            HirBlock { stmts }
        };
        self.active_loops.pop();
        for phi_id in suppressed {
            self.overrides.unsuppress_phi(phi_id);
        }

        self.visited.insert(continue_block);
        self.visited.extend(
            loop_context
                .break_exits
                .values()
                .flat_map(|break_exit| break_exit.blocks.iter().copied()),
        );
        self.install_loop_exit_bindings(candidate, exit, &plan, target_overrides);
        let mut start = expr_for_reg_use(self.lowering, block, instr_ref, init.index);
        let mut limit = expr_for_reg_use(self.lowering, block, instr_ref, init.limit);
        let mut step = expr_for_reg_use(self.lowering, block, instr_ref, init.step);
        if !target_overrides.is_empty() {
            let expr_overrides = temp_expr_overrides(target_overrides);
            rewrite_expr_temps(&mut start, &expr_overrides);
            rewrite_expr_temps(&mut limit, &expr_overrides);
            rewrite_expr_temps(&mut step, &expr_overrides);
        }
        stmts.push(HirStmt::NumericFor(Box::new(HirNumericFor {
            binding,
            start,
            limit,
            step,
            body,
        })));

        Some(Some(exit))
    }

    pub(crate) fn try_lower_generic_for_preheader(
        &mut self,
        block: BlockRef,
        stop: Option<BlockRef>,
        stmts: &mut Vec<HirStmt>,
        target_overrides: &BTreeMap<TempId, HirLValue>,
    ) -> Option<Option<BlockRef>> {
        let header = self.lowering.cfg.unique_reachable_successor(block)?;
        let candidate = *self.loop_by_header.get(&header)?;
        if !candidate.reducible
            || candidate.kind_hint != LoopKindHint::GenericForLike
            || candidate.continue_target != Some(header)
            || unique_loop_preheader(candidate)? != block
        {
            return None;
        }

        let (call_instr_ref, call, loop_instr) = self.generic_for_header_instrs(header)?;
        let exit = self.lowering.cfg.instr_to_block[loop_instr.exit_target.index()];
        if !candidate.exits.contains(&exit) {
            return None;
        }
        if let Some(stop) = stop
            && stop != exit
            && candidate.blocks.contains(&stop)
        {
            return None;
        }

        let body_entry = self.lowering.cfg.instr_to_block[loop_instr.body_target.index()];
        if !candidate.blocks.contains(&body_entry) || body_entry == header {
            return None;
        }

        let bindings = self
            .lowering
            .bindings
            .generic_for_locals
            .get(&header)?
            .clone();
        if bindings.len() != loop_instr.bindings.len {
            return None;
        }

        let mut excluded_regs = vec![loop_instr.control];
        excluded_regs.extend(
            (0..loop_instr.bindings.len)
                .map(|offset| Reg(loop_instr.bindings.start.index() + offset)),
        );
        let plan = self.build_loop_state_plan(
            candidate,
            Some(block),
            exit,
            &excluded_regs,
            target_overrides,
        )?;
        let combined_target_overrides =
            merge_target_overrides(target_overrides, &plan.backedge_target_overrides);

        self.visited.insert(block);
        stmts.extend(self.lower_block_prefix(block, false, target_overrides)?);
        stmts.extend(loop_state_init_stmts(&plan));

        let mut loop_context = self.build_active_loop_context(
            candidate,
            exit,
            &combined_target_overrides,
            &plan.states,
        )?;
        loop_context.loop_blocks = candidate.blocks.clone();
        loop_context.state_slots = plan.states.clone();
        self.active_loops.push(loop_context.clone());
        let body = self.lower_region(body_entry, Some(header), &combined_target_overrides)?;
        self.active_loops.pop();
        self.visited.insert(header);
        self.visited.extend(
            loop_context
                .break_exits
                .values()
                .flat_map(|break_exit| break_exit.blocks.iter().copied()),
        );
        self.install_loop_exit_bindings(candidate, exit, &plan, target_overrides);
        stmts.push(HirStmt::GenericFor(Box::new(HirGenericFor {
            bindings,
            iterator: self.lower_generic_for_iterator(header, call_instr_ref, call),
            body,
        })));

        Some(Some(exit))
    }
}