luadec 0.2.0

A Lua 5.1 bytecode decompiler library, originated from lbcdec
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
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
use std;

#[derive(Debug, PartialOrd, PartialEq, Eq, Copy, Clone)]
pub struct Reg(pub u8);
impl Reg {
    pub fn is_at_or_above(&self, other: Reg) -> bool {
        self.0 >= other.0
    }

    pub fn is_above(&self, other: Reg) -> bool {
        self.0 > other.0
    }

    pub fn previous(&self) -> Option<Reg> {
        if self.0 == 0 {
            None
        } else {
            Some(Reg(self.0 - 1))
        }
    }

    pub fn next(&self) -> Reg {
        Reg(self.0 + 1)
    }
}

#[derive(Debug, PartialOrd, PartialEq, Copy, Clone)]
pub enum RegOrTop {
    Reg(Reg),
    Top
}

impl RegOrTop {
    pub fn as_reg(self) -> Option<Reg> {
        match self {
            RegOrTop::Reg(reg) => Some(reg),
            _ => None
        }
    }

    pub fn as_reg_mut(&mut self) -> Option<&mut Reg> {
        match self {
            RegOrTop::Reg(ref mut reg) => Some(reg),
            _ => None
        }
    }
}

impl From<Option<Reg>> for RegOrTop {
    fn from(v: Option<Reg>) -> RegOrTop {
        v.map(RegOrTop::Reg).unwrap_or(RegOrTop::Top)
    }
}

#[derive(Debug, Copy, Clone, PartialEq)]
pub struct Kst(pub u32);

#[derive(Debug, Copy, Clone, PartialEq)]
pub enum RK {
    R(Reg), K(Kst)
}

#[derive(Debug, Copy, Clone)]
pub struct Upvalue(pub u16);

#[derive(Debug, Copy, Clone)]
pub enum BinOp {
    Add, Sub, Mul, Div, Mod, Pow
}

#[derive(Debug, Copy, Clone)]
pub enum UnOp {
    Unm, Not, Len
}

#[derive(Debug, Copy, Clone)]
pub enum BinCondOp {
    Eq, Lt, Le
}

#[derive(PartialEq, Eq, Copy, Clone)]
pub struct Count(u16);
impl Count {
    pub fn raw(n: u16) -> Count {
        Count(n)
    }

    pub fn from(n: u16) -> Count {
        Count(n + 1)
    }

    pub fn is_empty(&self) -> bool {
        self.0 == 1
    }

    pub fn is_varargs(&self) -> bool {
        self.0 == 0
    }

    pub fn count(&self) -> Option<u16> {
        if self.0 != 0 {
            Some(self.0 - 1)
        } else {
            None
        }
    }

    pub fn add(&self, n: u16) -> Count {
        if self.is_varargs() {
            *self
        } else {
            Count(self.0 + n)
        }
    }

    // base: Reg(0), self: VARARGS or EMPTY => None
    // base: Reg(0), self: Count(n) => Reg(base.0 + n - 1)
    pub fn top(&self, base: Reg) -> Option<Reg> {
        if self.0 > 0 {
            if self.0 == 1 {
                // EMPTY
                return Some(base)
            }
            Some(Reg(base.0 + ((self.0 - 2) as u8)))
        } else {
            None
        }
    }

    pub const VARARGS: Count = Count(0);
    pub const EMPTY: Count = Count(1);
}
impl std::fmt::Debug for Count {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::result::Result<(), std::fmt::Error> {
        write!(f, "Count(")?;
        if self.0 == 0 {
            write!(f, "VarArgs)")
        } else {
            write!(f, "{})", self.0 - 1)
        }
    }
}

impl std::ops::Add<Count> for Reg {
    type Output = Option<Reg>;
    fn add(self, other: Count) -> Option<Reg> {
        if other.is_varargs() {
            None
        } else {
            Some(Reg(self.0 + ((other.0 - 1) as u8)))
        }
    }
}

#[derive(Debug, Copy, Clone)]
pub struct PCOffset(i32);
impl PCOffset {
    pub fn new(offset: i32) -> PCOffset {
        PCOffset(offset)
    }

    pub fn apply(&self, pc: u32) -> u32 {
        ((pc as i32) + self.0) as u32
    }

    pub fn is_forward(&self) -> bool {
        self.0 > 0
    }

    pub fn is_backward(&self) -> bool {
        !self.is_forward()
    }
}

#[derive(Debug, Clone)]
pub enum ClosureCapture {
    Register(Reg),
    Upvalue(Upvalue)
}

#[derive(Debug)]
pub enum LuaInstruction {
    Move { dest: Reg, source: Reg },
    LoadK { dest: Reg, kst: Kst },
    LoadBool { dest: Reg, value: bool, skip_next: bool },
    LoadNil { dest_start: Reg, dest_end: Reg },
    GetUpvalue { dest: Reg, upvalue: Upvalue },
    GetGlobal { dest: Reg, index: Kst },
    GetTable { dest: Reg, table: Reg, index: RK },
    SetGlobal { source: Reg, index: Kst },
    SetUpvalue { source: Reg, upvalue: Upvalue },
    SetTable { table: Reg, index: RK, source: RK },
    NewTable { dest: Reg, array_count: u32, hash_count: u32 },
    Self_ { base: Reg, object: Reg, method: RK },
    BinOp { dest: Reg, lhs: RK, op: BinOp, rhs: RK },
    UnOp { dest: Reg, op: UnOp, rhs: Reg },
    Concat { dest: Reg, source_start: Reg, source_end: Reg },
    Jump { offset: PCOffset },
    BinCondOp { inverted: bool, lhs: RK, op: BinCondOp, rhs: RK },
    Test { source: Reg, inverted: bool },
    TestSet { dest: Reg, source: Reg, inverted: bool },
    Call { base: Reg, args: Count, ret: Count },
    TailCall { base: Reg, args: Count, ret: Count },
    Return { base: Reg, count: Count },
    ForLoop { base: Reg, target: PCOffset },
    ForPrep { base: Reg, target: PCOffset },
    TForLoop { base: Reg, count: u16 },
    SetList { base: Reg, count: Count, set: u32 },
    Close { base: Reg },
    Closure { dest: Reg, prototype: u32, captures: Vec<ClosureCapture> },
    VarArg { base: Reg, count: Count },
    SemanticNoOp
}

pub enum InstructionIO {
    Stack(Count),
    Single(Reg),
    Range(std::ops::Range<Reg>),
}

#[derive(Debug)]
pub enum InstructionInfo {
    Stack {
        base: Reg,
        inputs: Count,
        outputs: Count,
    }
}

#[derive(Debug, PartialEq, Eq)]
pub enum UsageType {
    Read,
    ReadVarArgs,
    Write,
    WriteVarArgs,
}

impl LuaInstruction {
    pub fn fb2int(x: u16) -> u32 {
        let e = (x >> 3) & 31;
        if e == 0 {
            x.into()
        } else {
            (((x & 7) + 8) as u32) << (e - 1)
        }
    }

    pub fn base(&self) -> Option<Reg> {
        match self {
            LuaInstruction::Self_ { base, .. } => Some(base),
            LuaInstruction::Concat { source_start, .. } => Some(source_start),
            LuaInstruction::Call { base, .. } => Some(base),
            LuaInstruction::TailCall { base, .. } => Some(base),
            LuaInstruction::Return { base, count } if count.count().is_none() || count.count().unwrap() > 1 => Some(base),
            LuaInstruction::ForLoop { base, .. } => Some(base),
            LuaInstruction::ForPrep { base, .. } => Some(base),
            LuaInstruction::TForLoop { base, .. } => Some(base),
            LuaInstruction::SetList { base, .. } => Some(base),
            LuaInstruction::Close { base } => Some(base),
            LuaInstruction::VarArg { base, count } if count.count() != Some(1) => Some(base),
            _ => None,
        }.map(|base| *base)
    }

    pub fn info(&self) -> Option<InstructionInfo> {
        use InstructionInfo::*;

        match *self {
            LuaInstruction::LoadNil { dest_start, dest_end } if dest_end.is_above(dest_start) => Some(Stack { base: dest_start, inputs: Count::EMPTY, outputs: Count::from((dest_end.0 - dest_start.0 + 1) as u16) }),
            LuaInstruction::Self_ { base, object, .. } => Some(Stack { base, inputs: if object == base { Count::from(1) } else { Count::EMPTY }, outputs: Count::from(2) }),
            LuaInstruction::Concat { source_start, source_end, .. } => Some(Stack { base: source_start, inputs: Count::from((source_end.0 - source_start.0 + 1) as u16), outputs: Count::EMPTY }),
            LuaInstruction::Call { base, args, ret } => Some(Stack { base, inputs: args.add(1), outputs: ret }),
            LuaInstruction::TailCall { base, args, ret } => Some(Stack { base, inputs: args.add(1), outputs: ret }),
            LuaInstruction::Return { base, count } if count.count().is_none() || count.count().unwrap() > 1 => Some(Stack { base, inputs: count, outputs: Count::EMPTY }),
            // LuaInstruction::ForLoop { base, .. } => Some(Stack { base, inputs: Count::from(4), outputs: Count::from(4) }),
            LuaInstruction::ForPrep { base, .. } => Some(Stack { base, inputs: Count::from(3), outputs: Count::from(4) }),
            LuaInstruction::TForLoop { base, count } => Some(Stack { base, inputs: Count::from(3), outputs: Count::from(3 + count) }),
            LuaInstruction::SetList { base, count, .. } => Some(Stack { base, inputs: count.count().map(|x| x + 2).map(Count::from).unwrap_or(Count::VARARGS), outputs: Count::from(1) }),
            LuaInstruction::Close { base } => Some(Stack { base, inputs: Count::EMPTY, outputs: Count::EMPTY }),
            LuaInstruction::VarArg { base, count } if count.count() != Some(1) => Some(Stack { base, inputs: Count::EMPTY, outputs: count }),
            _ => None,
        }
    }

    pub fn does_use<F: FnMut(Reg) -> bool>(&self, mut func: F) -> bool {
        let mut res = false;
        self.fold_io((), |_, reg, usage| {
            if func(reg) {
                res = true;
                None
            } else {
                Some(())
            }
        });
        res
    }

    pub fn does_read(&self, r: Reg) -> bool {
        let mut res = false;
        self.fold_io((), |_, reg, usage| {
            if usage == UsageType::Read && reg == r {
                res = true;
                None
            } else if usage == UsageType::ReadVarArgs && r.is_at_or_above(reg) {
                res = true;
                None
            } else {
                Some(())
            }
        });
        res
    }

    pub fn does_read_at_or_above(&self, r: Reg) -> bool {
        let mut res = false;
        self.fold_io((), |_, reg, usage| {
            if usage == UsageType::Read && reg.is_at_or_above(r) {
                res = true;
                None
            } else if usage == UsageType::ReadVarArgs && reg.is_at_or_above(r) {
                res = true;
                None
            } else {
                Some(())
            }
        });
        res
    }

    pub fn does_write(&self, r: Reg) -> bool {
        let mut res = false;
        self.fold_io((), |_, reg, usage| {
            if usage == UsageType::Write && reg == r {
                res = true;
                None
            } else if usage == UsageType::WriteVarArgs && r.is_at_or_above(reg) {
                res = true;
                None
            } else {
                Some(())
            }
        });
        res
    }

    pub fn does_write_at_or_above(&self, r: Reg) -> bool {
        let mut res = false;
        self.fold_io((), |_, reg, usage| {
            if usage == UsageType::Write && reg.is_at_or_above(r) {
                res = true;
                None
            } else if usage == UsageType::WriteVarArgs && reg.is_at_or_above(r) {
                res = true;
                None
            } else {
                Some(())
            }
        });
        res
    }

    pub fn top_read(&self) -> Option<Reg> {
        self.fold_io(None, |current, reg, usage| {
            if let Some(current) = *current {
                if usage == UsageType::Read && reg.is_above(current) {
                    return Some(Some(reg))
                }
            } else {
                if usage == UsageType::Read {
                    return Some(Some(reg))
                }
            }

            return Some(*current)
        })
    }

    pub fn base_write(&self) -> Option<Reg> {
        self.fold_io(None, |current, reg, usage| {
            if let Some(current) = *current {
                if usage == UsageType::Write && current.is_above(reg) {
                    return Some(Some(reg))
                }
            } else {
                if usage == UsageType::Write {
                    return Some(Some(reg))
                }
            }

            return Some(*current)
        })
    }

    // Runs the given fn until it returns None, returns the last value before it returns None
    pub fn fold_io<T, F: FnMut(&T, Reg, UsageType) -> Option<T>>(&self, mut current: T, mut func: F) -> T {
        use LuaInstruction::*;

        macro_rules! handle_fold {
            ($($($pattern:pat_param)|* => { $($rest:tt)* })*) => {
                match *self {
                    $($($pattern)|* => {
                        handle_fold!(inner $($rest)*);
                    })*
                    _ => unimplemented!()
                }
            };
            (inner read $reg:expr, $($rest:tt)*) => {
                match func(&current, $reg, UsageType::Read) {
                    Some(c) => {
                        current = c;
                    },
                    None => return current
                }

                handle_fold!(inner $($rest)*);
            };
            (inner read_rk $reg:expr, $($rest:tt)*) => {
                match $reg {
                    RK::R(reg) => {
                        match func(&current, reg, UsageType::Read) {
                            Some(c) => {
                                current = c;
                            },
                            None => return current
                        }
                    },
                    _ => ()
                }

                handle_fold!(inner $($rest)*);
            };
            (inner read_range $range:expr, $($rest:tt)*) => {
                let range = $range;
                let mut reg = range.start;
                while reg != range.end {
                    match func(&current, reg, UsageType::Read) {
                        Some(c) => {
                            current = c;
                        },
                        None => return current
                    }
                    reg = reg.next();
                }

                handle_fold!(inner $($rest)*);
            };
            (inner read_count $ex:expr, $($rest:tt)*) => {
                let (base, count) = $ex;
                if let Some(top) = count.top(base) {
                    let top = top.next();
                    let mut reg = base;
                    while reg != top {
                        match func(&current, reg, UsageType::Read) {
                            Some(c) => {
                                current = c;
                            },
                            None => return current
                        }
                        reg = reg.next();
                    }
                } else {
                    match func(&current, base, UsageType::ReadVarArgs) {
                        Some(c) => {
                            current = c;
                        },
                        None => return current
                    }
                }

                handle_fold!(inner $($rest)*);
            };
            (inner write $reg:expr, $($rest:tt)*) => {
                match func(&current, $reg, UsageType::Write) {
                    Some(c) => {
                        current = c;
                    },
                    None => return current
                }

                handle_fold!(inner $($rest)*);
            };
            (inner write_range $range:expr, $($rest:tt)*) => {
                let range = $range;
                let mut reg = range.start;
                while reg != range.end {
                    match func(&current, reg, UsageType::Write) {
                        Some(c) => {
                            current = c;
                        },
                        None => return current
                    }
                    reg = reg.next();
                }

                handle_fold!(inner $($rest)*);
            };
            (inner write_count $ex:expr, $($rest:tt)*) => {
                let (base, count) = $ex;
                if let Some(top) = count.top(base) {
                    let top = top.next();
                    let mut reg = base;
                    while reg != top {
                        match func(&current, reg, UsageType::Write) {
                            Some(c) => {
                                current = c;
                            },
                            None => return current
                        }
                        reg = reg.next();
                    }
                } else {
                    match func(&current, base, UsageType::WriteVarArgs) {
                        Some(c) => {
                            current = c;
                        },
                        None => return current
                    }
                }

                handle_fold!(inner $($rest)*);
            };
            (inner closure_capture $ex:expr, $($rest:tt)*) => {
                let caps = $ex;
                for cap in caps {
                    match *cap {
                        ClosureCapture::Register(reg) => {
                            match func(&current, reg, UsageType::Read) {
                                Some(c) => {
                                    current = c;
                                },
                                None => return current
                            }
                        }
                        _ => {}
                    }
                }

                handle_fold!(inner $($rest)*);
            };
            (inner) => {};
        }

        handle_fold! {
            Move { dest, source } => {
                read source,
                write dest,
            }
            LoadK { dest, .. } | LoadBool { dest, .. } | GetUpvalue { dest, .. } | GetGlobal { dest, .. } | NewTable { dest, .. } => {
                write dest,
            }
            GetTable { dest, table, index } => {
                read table,
                read_rk index,
                write dest,
            }
            LoadNil { dest_start, dest_end } => {
                write_range dest_start..(dest_end.next()),
            }
            SetGlobal { source, .. } | SetUpvalue { source, .. } => {
                read source,
            }
            SetTable { table, index, source } => {
                read table,
                read_rk index,
                read_rk source,
            }
            Self_ { base, object, method } => {
                read object,
                read_rk method,
                write base,
                write base.next(),
            }
            BinOp { dest, lhs, rhs, .. } => {
                read_rk lhs,
                read_rk rhs,
                write dest,
            }
            UnOp { dest, rhs, .. } => {
                read rhs,
                write dest,
            }
            Concat { dest, source_start, source_end } => {
                read_range source_start..(source_end.next()),
                write dest,
            }
            Jump { .. } => {}
            BinCondOp { lhs, rhs, .. } => {
                read_rk lhs,
                read_rk rhs,
            }
            Test { source, .. } => {
                read source,
            }
            TestSet { dest, source, .. } => {
                read source,
                write dest,
            }
            Call { base, args, ret } => {
                read base,
                read_count (base.next(), args),
                write_count (base, ret),
            }
            TailCall { base, args, .. } => {
                read base,
                read_count (base.next(), args),
            }
            Return { base, count } => {
                read_count (base, count),
            }
            SetList { base, count, .. } => {
                read_count (base, count.count().map(|x| x + 2).map(Count::from).unwrap_or(Count::VARARGS)),
                write base, // Just so ralloc works correctly, can be used as an alias for the source table
            }
            TForLoop { base, count } => {
                read_count (base, Count::from(3)),
                write_count (base, Count::from(3 + count + 1)),
            }
            Closure { dest, ref captures, .. } => {
                closure_capture captures,
                write dest,
            }
            Close {..} => {}
            VarArg { base, count } => {
                write_count (base, count),
            }
            ForLoop {..} => {}
            ForPrep { base, .. } => {
                read_count (base, Count::from(3)),
                write_count (base, Count::from(4)),
            }
            // TODO: ForLoop, ForPrep
            SemanticNoOp => {}
        }

        current
    }
}