smxdasm 0.2.0

A library for disassembling SMX
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

use std::rc::Rc;
use std::cell::RefCell;
use crate::headers::{SMXHeader, SectionEntry};
use crate::sections::*;
use crate::rtti::*;
use crate::v1disassembler::V1Disassembler;
use crate::errors::Result;

#[derive(Default)]
pub struct SMXFile {
    pub header: Rc<SMXHeader>,
    pub unknown_sections: Vec<Rc<SectionEntry>>,

    pub names: Option<Rc<RefCell<SMXNameTable>>>,
    pub debug_names: Option<Rc<RefCell<SMXNameTable>>>,
    pub natives: Option<Rc<SMXNativeTable>>,
    pub publics: Option<Rc<SMXPublicTable>>,
    pub pubvars: Option<Rc<SMXPubvarTable>>,
    pub tags: Option<Rc<SMXTagTable>>,
    pub data: Option<Rc<SMXDataSection>>,
    pub codev1: Option<Rc<SMXCodeV1Section>>,
    pub called_functions: Option<Rc<RefCell<SMXCalledFunctionsTable>>>,

    pub debug_info: Option<Rc<SMXDebugInfoSection>>,
    pub debug_files: Option<Rc<SMXDebugFilesTable>>,
    pub debug_lines: Option<Rc<SMXDebugLinesTable>>,

    pub rtti_data: Option<Rc<SMXRTTIData>>,
    pub rtti_enums: Option<Rc<SMXRTTIEnumTable>>,
    pub rtti_enum_structs: Option<Rc<SMXRTTIEnumStructTable>>,
    pub rtti_enum_struct_fields: Option<Rc<SMXRTTIEnumStructFieldTable>>,
    pub rtti_classdefs: Option<Rc<SMXRTTIClassDefTable>>,
    pub rtti_fields:  Option<Rc<SMXRTTIFieldTable>>,
    pub rtti_methods: Option<Rc<SMXRTTIMethodTable>>,
    pub rtti_natives: Option<Rc<SMXRTTINativeTable>>,
    pub rtti_typedefs: Option<Rc<SMXRTTITypedefTable>>,
    pub rtti_typesets: Option<Rc<SMXRTTITypesetTable>>,

    pub debug_methods: Option<Rc<SMXDebugMethods>>,
    pub debug_globals: Option<Rc<RefCell<SMXDebugGlobals>>>,
    pub debug_locals: Option<Rc<SMXDebugLocals>>,
}

impl SMXFile {
    pub fn new<T>(data: T) -> Result<Rc<RefCell<SMXFile>>>
    where
        T: AsRef<[u8]>,
    {
        let file: Rc<RefCell<SMXFile>> = Rc::new(RefCell::new(Default::default()));

        {
            {
                let file_mut = &mut *file.borrow_mut();

                file_mut.header = Rc::new(SMXHeader::new(&data)?);
                file_mut.unknown_sections = Vec::new();
                file_mut.called_functions = Some(Rc::new(RefCell::new(SMXCalledFunctionsTable::new())));

                for section in &file_mut.header.sections {
                    match section.name.as_ref() {
                        ".names"  => file_mut.names = Some(Rc::new(RefCell::new(SMXNameTable::new(Rc::clone(&file_mut.header), Rc::clone(&section))))),
                        ".dbg.strings" => file_mut.debug_names = Some(Rc::new(RefCell::new(SMXNameTable::new(Rc::clone(&file_mut.header), Rc::clone(&section))))),
                        ".dbg.info" => file_mut.debug_info = Some(Rc::new(SMXDebugInfoSection::new(Rc::clone(&file_mut.header), Rc::clone(&section))?)),
                        _ => (),
                    }
                }

                if file_mut.debug_names.is_none() {
                    file_mut.debug_names = file_mut.names.clone();
                }

                // After first pass, we have the name tables
                for section in &file_mut.header.sections {
                    match section.name.as_ref() {
                        ".names" | ".dbg.strings" | ".dbg.info" => (),
                        ".natives" => file_mut.natives = Some(Rc::new(SMXNativeTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        ".publics" => file_mut.publics = Some(Rc::new(SMXPublicTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        ".pubvars" => file_mut.pubvars = Some(Rc::new(SMXPubvarTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        ".tags" => file_mut.tags = Some(Rc::new(SMXTagTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        ".data" => file_mut.data = Some(Rc::new(SMXDataSection::new(Rc::clone(&file_mut.header), Rc::clone(&section))?)),
                        ".code" => file_mut.codev1 = Some(Rc::new(SMXCodeV1Section::new(Rc::clone(&file_mut.header), Rc::clone(&section))?)),
                        ".dbg.files" => file_mut.debug_files = Some(Rc::new(SMXDebugFilesTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        ".dbg.lines" => file_mut.debug_lines = Some(Rc::new(SMXDebugLinesTable::new(Rc::clone(&file_mut.header), Rc::clone(&section))?)),
                        // .dbg.natives and .dbg.symbols is unimplemented due to being legacy
                        ".dbg.methods" => file_mut.debug_methods = Some(Rc::new(SMXDebugMethods::new(Rc::clone(&file_mut.header), Rc::clone(&section))?)), // names param is excluded as it's not used
                        ".dbg.globals" => file_mut.debug_globals = Some(Rc::new(RefCell::new(SMXDebugGlobals::new(Rc::clone(&file_mut.header), Rc::clone(&section))?))),
                        ".dbg.locals" => file_mut.debug_locals = Some(Rc::new(SMXDebugLocals::new(Rc::clone(&file), Rc::clone(&file_mut.header), Rc::clone(&section))?)),
                        "rtti.data" => file_mut.rtti_data = Some(Rc::new(SMXRTTIData::new(Rc::clone(&file), Rc::clone(&file_mut.header), Rc::clone(&section)))),
                        "rtti.classdefs" => file_mut.rtti_classdefs = Some(Rc::new(SMXRTTIClassDefTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.enumstructs" => file_mut.rtti_enum_structs = Some(Rc::new(SMXRTTIEnumStructTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.enumstruct_fields" => file_mut.rtti_enum_struct_fields = Some(Rc::new(SMXRTTIEnumStructFieldTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.fields" => file_mut.rtti_fields = Some(Rc::new(SMXRTTIFieldTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.methods" => file_mut.rtti_methods = Some(Rc::new(SMXRTTIMethodTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.natives" => file_mut.rtti_natives = Some(Rc::new(SMXRTTINativeTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.enums" => file_mut.rtti_enums = Some(Rc::new(SMXRTTIEnumTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.typedefs" => file_mut.rtti_typedefs = Some(Rc::new(SMXRTTITypedefTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        "rtti.typesets" => file_mut.rtti_typesets = Some(Rc::new(SMXRTTITypesetTable::new(Rc::clone(&file_mut.header), Rc::clone(&section), Rc::clone(file_mut.names.as_ref().unwrap()))?)),
                        _ =>  file_mut.unknown_sections.push(Rc::clone(&section)),
                    }
                }
            }

            // Legacy debug symbols table is skipped

            if file.borrow_mut().publics.is_some() {
                for pubfun in file.borrow().publics.as_ref().unwrap().entries_ref() {
                    V1Disassembler::diassemble(Rc::clone(&file), file.borrow().header.data.clone(), Rc::clone(file.borrow().codev1.as_ref().unwrap()), pubfun.address as i32)?;
                }
            }

            if file.borrow().called_functions.is_some() {
                for fun in file.borrow().called_functions.as_ref().unwrap().borrow().entries_ref() {
                    V1Disassembler::diassemble(Rc::clone(&file), file.borrow().header.data.clone(), Rc::clone(file.borrow().codev1.as_ref().unwrap()), fun.address as i32)?;
                }
            }
        }

        Ok(file)
    }

    pub fn find_global_name(&mut self, addr: i32) -> Option<String> {
        if self.debug_globals.is_some() {
            let sym = self.debug_globals.as_mut().unwrap().borrow_mut().find_global(addr);

            if let Some(symsome) = sym {
                return Some(self.names.as_mut().unwrap().borrow_mut().string_at(symsome.name_offset).unwrap());
            }
        }

        None
    }

    pub fn find_local_name(&mut self, code_addr: i32, addr: i32) -> Option<String> {
        if self.debug_locals.is_some() {
            let entry = self.debug_locals.as_ref().unwrap().find_local(code_addr, addr);

            if let Some(entrysome) = entry {
                return Some(self.names.as_mut().unwrap().borrow_mut().string_at(entrysome.name_offset).unwrap());
            }
        }

        None
    }

    pub fn find_function_name(&self, addr: i32) -> String {
        if self.publics.is_some() {
            for pubfun in self.publics.as_ref().unwrap().entries_ref() {
                if pubfun.address == addr as u32 {
                    return pubfun.name.clone();
                }
            }
        }

        if self.called_functions.is_some() {
            for fun in self.called_functions.as_ref().unwrap().borrow().entries_ref() {
                if fun.address == addr as u32 {
                    return fun.name.clone();
                }
            }
        }

        "unknown".into()
    }

    pub fn is_function_at_address(&self, addr: i32) -> bool {
        // Legacy debug symbols is unimplemented

        if self.publics.is_some() {
            for pubfun in self.publics.as_ref().unwrap().entries_ref() {
                if pubfun.address == addr as u32 {
                    return true;
                }
            }
        }

        if self.called_functions.is_some() {
            for fun in self.called_functions.as_ref().unwrap().borrow().entries_ref() {
                if fun.address == addr as u32 {
                    return true;
                }
            }
        }

        false
    }
}