-
Notifications
You must be signed in to change notification settings - Fork 281
Expand file tree
/
Copy pathrtti.cpp
More file actions
300 lines (256 loc) · 12.3 KB
/
rtti.cpp
File metadata and controls
300 lines (256 loc) · 12.3 KB
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
#include "rtti.h"
using namespace BinaryNinja;
using namespace BinaryNinja::RTTI;
Ref<Symbol> RTTI::GetRealSymbol(BinaryView *view, uint64_t relocAddr, uint64_t symAddr)
{
if (view->IsOffsetExternSemantics(symAddr))
{
// Because bases in the extern section are not 8 byte width only they will
// overlap with other externs, until https://github.com/Vector35/binaryninja-api/issues/6387 is fixed.
// Check relocation at objectAddr for symbol
for (const auto& r : view->GetRelocationsAt(relocAddr))
if (auto relocSym = r->GetSymbol())
return relocSym;
}
return view->GetSymbolByAddress(symAddr);
}
std::optional<std::string> RTTI::DemangleNameMS(BinaryView* view, bool allowMangled, const std::string &mangledName)
{
QualifiedName demangledName = {};
Ref<Type> outType = {};
if (!DemangleMS(view->GetDefaultArchitecture(), mangledName, outType, demangledName, true))
return DemangleNameLLVM(allowMangled, mangledName);
return demangledName.GetString();
}
std::optional<std::string> RTTI::DemangleNameGNU3(BinaryView* view, bool allowMangled, const std::string &mangledName)
{
QualifiedName demangledName = {};
Ref<Type> outType = {};
std::string adjustedMangledName = mangledName;
// For some reason some of the names that start with ZN are not prefixed by `_`.
if (adjustedMangledName.rfind("ZN", 0) == 0)
adjustedMangledName = "_" + adjustedMangledName;
// GCC emits a leading * to indicate that the type info is internal and its
// name can be compared via pointer equality. It is not part of the type name.
if (adjustedMangledName.rfind("*", 0) == 0)
adjustedMangledName = adjustedMangledName.substr(1);
// All types at this point should have a _Z prefix, if not, we likely need to just call the demangler directly, as this
// function is specific to dealing with mangled _type_ names.
if (adjustedMangledName.rfind("_Z", 0) != 0)
adjustedMangledName = "_Z" + adjustedMangledName;
if (!DemangleGNU3(view->GetDefaultArchitecture(), adjustedMangledName, outType, demangledName, true))
return allowMangled ? std::optional(mangledName) : std::nullopt;
// Because we might have a generic name such as "PackageListGui::PackageListGui" returned, we must attempt to
// stringify the returned type IF its function type and then append that to the end of the demangled name.
// REAL: PackageListGui::PackageListGui(Filesystem::Path&&, PackageListGui::UnderSubheader, bool)::$_1[0x0]
// MANGLED: ZN14PackageListGuiC1EON10Filesystem4PathENS_14UnderSubheaderEbE3$_1
// GENERIC DEMANGLED: PackageListGui::PackageListGui
// UPDATED DEMANGLED: PackageListGui::PackageListGui(Filesystem::Path&&, PackageListGui::UnderSubheader, bool)
if (outType && outType->IsFunction())
demangledName.push_back(outType->GetStringAfterName(view->GetDefaultPlatform()));
return demangledName.GetString();
}
std::string RemoveItaniumPrefix(std::string &name)
{
// Remove numerical prefixes.
while (!name.empty() && std::isdigit(name[0]))
name = name.substr(1);
return name;
}
std::optional<std::string> RTTI::DemangleNameItanium(BinaryView* view, bool allowMangled, const std::string &mangledName)
{
// NOTE: Passing false to allowMangled to fallthrough to GNU3 demangler.
if (auto demangledName = DemangleNameLLVM(false, mangledName))
return RemoveItaniumPrefix(demangledName.value());
if (auto demangledName = DemangleNameGNU3(view, allowMangled, mangledName))
return RemoveItaniumPrefix(demangledName.value());
return std::nullopt;
}
std::optional<std::string> RTTI::DemangleNameLLVM(bool allowMangled, const std::string &mangledName)
{
QualifiedName demangledName = {};
Ref<Type> outType = {};
if (!DemangleLLVM(mangledName, demangledName, true))
return allowMangled ? std::optional(mangledName) : std::nullopt;
auto demangledNameStr = demangledName.GetString();
size_t beginFind = demangledNameStr.find_first_of(' ');
if (beginFind != std::string::npos)
demangledNameStr.erase(0, beginFind + 1);
size_t endFind = demangledNameStr.find(" `RTTI Type Descriptor Name'");
if (endFind != std::string::npos)
demangledNameStr.erase(endFind, demangledNameStr.length());
return demangledNameStr;
}
Ref<Metadata> BaseClassInfo::SerializedMetadata() const
{
std::map<std::string, Ref<Metadata>> baseClassMeta;
baseClassMeta["className"] = new Metadata(className);
baseClassMeta["classOffset"] = new Metadata(offset);
// NOTE: We omit base vft functions as it can be resolved manually and just bloats the size.
if (vft.has_value())
baseClassMeta["vft"] = vft->SerializedMetadata(false);
return new Metadata(baseClassMeta);
}
BaseClassInfo BaseClassInfo::DeserializedMetadata(const Ref<Metadata> &metadata)
{
std::map<std::string, Ref<Metadata>> baseClassMeta = metadata->GetKeyValueStore();
std::string className = baseClassMeta["className"]->GetString();
uint64_t offset = baseClassMeta["classOffset"]->GetUnsignedInteger();
BaseClassInfo baseClassInfo = {className, offset};
if (baseClassMeta.find("vft") != baseClassMeta.end())
baseClassInfo.vft = VirtualFunctionTableInfo::DeserializedMetadata(baseClassMeta["vft"]);
return baseClassInfo;
}
Ref<Metadata> ClassInfo::SerializedMetadata() const
{
std::map<std::string, Ref<Metadata>> classInfoMeta;
classInfoMeta["processor"] = new Metadata(static_cast<uint64_t>(processor));
classInfoMeta["className"] = new Metadata(className);
if (!baseClasses.empty())
{
std::vector<Ref<Metadata> > basesMeta;
basesMeta.reserve(baseClasses.size());
for (const auto& baseClass : baseClasses)
basesMeta.emplace_back(baseClass.SerializedMetadata());
classInfoMeta["bases"] = new Metadata(basesMeta);
}
if (vft.has_value())
classInfoMeta["vft"] = vft->SerializedMetadata();
return new Metadata(classInfoMeta);
}
ClassInfo ClassInfo::DeserializedMetadata(const Ref<Metadata> &metadata)
{
std::map<std::string, Ref<Metadata>> classInfoMeta = metadata->GetKeyValueStore();
std::string className = classInfoMeta["className"]->GetString();
RTTIProcessorType processor = static_cast<RTTIProcessorType>(classInfoMeta["processor"]->GetUnsignedInteger());
ClassInfo info = {processor, className};
if (classInfoMeta.find("bases") != classInfoMeta.end())
{
for (auto &entry: classInfoMeta["bases"]->GetArray())
info.baseClasses.emplace_back(BaseClassInfo::DeserializedMetadata(entry));
}
if (classInfoMeta.find("vft") != classInfoMeta.end())
info.vft = VirtualFunctionTableInfo::DeserializedMetadata(classInfoMeta["vft"]);
return info;
}
Ref<Metadata> VirtualFunctionTableInfo::SerializedMetadata(const bool serializeFunctions) const
{
std::map<std::string, Ref<Metadata>> vftMeta;
vftMeta["address"] = new Metadata(address);
// NOTE: We allow omitting baseVft functions as it can be resolved manually and just bloats the size.
if (serializeFunctions && !virtualFunctions.empty())
{
std::vector<Ref<Metadata> > funcsMeta;
funcsMeta.reserve(virtualFunctions.size());
for (auto &vFunc: virtualFunctions)
funcsMeta.emplace_back(vFunc.SerializedMetadata());
vftMeta["functions"] = new Metadata(funcsMeta);
}
return new Metadata(vftMeta);
}
VirtualFunctionTableInfo VirtualFunctionTableInfo::DeserializedMetadata(const Ref<Metadata> &metadata)
{
std::map<std::string, Ref<Metadata>> vftMeta = metadata->GetKeyValueStore();
VirtualFunctionTableInfo vftInfo = {vftMeta["address"]->GetUnsignedInteger()};
if (vftMeta.find("functions") != vftMeta.end())
{
for (auto &entry: vftMeta["functions"]->GetArray())
vftInfo.virtualFunctions.emplace_back(VirtualFunctionInfo::DeserializedMetadata(entry));
}
return vftInfo;
}
Ref<Metadata> VirtualFunctionInfo::SerializedMetadata() const
{
std::map<std::string, Ref<Metadata>> vFuncMeta;
vFuncMeta["address"] = new Metadata(funcAddr);
return new Metadata(vFuncMeta);
}
VirtualFunctionInfo VirtualFunctionInfo::DeserializedMetadata(const Ref<Metadata> &metadata)
{
std::map<std::string, Ref<Metadata>> vFuncMeta = metadata->GetKeyValueStore();
VirtualFunctionInfo vFuncInfo = {vFuncMeta["address"]->GetUnsignedInteger()};
return vFuncInfo;
}
Ref<Metadata> RTTIProcessor::SerializedMetadata()
{
std::map<std::string, Ref<Metadata>> classesMeta;
for (auto &[objectAddr, classInfo]: m_classInfo)
{
auto addrStr = std::to_string(objectAddr);
classesMeta[addrStr] = classInfo.SerializedMetadata();
}
for (auto &[objectAddr, classInfo]: m_unhandledClassInfo)
{
auto addrStr = std::to_string(objectAddr);
// Unhandled class info will be discarded if handled class info exists for the same address.
if (classesMeta.find(addrStr) == classesMeta.end())
classesMeta[addrStr] = classInfo.SerializedMetadata();
}
std::map<std::string, Ref<Metadata>> itaniumMeta;
itaniumMeta["classes"] = new Metadata(classesMeta);
return new Metadata(itaniumMeta);
}
bool RTTIProcessor::IsLikelyFunction(uint64_t addr) const
{
// Disassemble to just make a little extra certain this is a function.
auto vftPlatform = m_view->GetDefaultPlatform()->GetAssociatedPlatformByAddress(addr);
Ref<Architecture> arch = vftPlatform->GetArchitecture();
const size_t maxInstrLen = arch->GetMaxInstructionLength();
DataBuffer instrBuffer = m_view->ReadBuffer(addr, maxInstrLen);
InstructionInfo instrInfo;
const bool validInstr = arch->GetInstructionInfo(static_cast<uint8_t*>(instrBuffer.GetData()), addr, maxInstrLen, instrInfo);
return validInstr;
}
RTTIProcessor::FunctionDiscoverState RTTIProcessor::DiscoverVirtualFunction(uint64_t vftEntryAddr, uint64_t& vFuncAddr)
{
if (!m_view->IsValidOffset(vftEntryAddr))
return FunctionDiscoverState::Failed;
BinaryReader reader = BinaryReader(m_view);
reader.Seek(vftEntryAddr);
vFuncAddr = reader.ReadPointer();
auto funcs = m_view->GetAnalysisFunctionsForAddress(vFuncAddr);
if (!funcs.empty())
return FunctionDiscoverState::AlreadyExists;
// Handle external virtual functions, we won't have a backing function for them.
if (!m_view->IsOffsetCodeSemantics(vFuncAddr))
{
// TODO: Sometimes vFunc idx will be zeroed iirc.
// We allow vfuncs to point to extern functions.
// TODO: Until https://github.com/Vector35/binaryninja-api/issues/5982 is fixed we need to check extern sym relocs instead of the symbol directly
auto vFuncSym = GetRealSymbol(m_view, reader.GetOffset(), vFuncAddr);
if (!vFuncSym)
return FunctionDiscoverState::Failed;
DataVariable dv;
bool foundDv = m_view->GetDataVariableAtAddress(vFuncAddr, dv);
// Last virtual function, or hit the next vtable.
if (!foundDv || !dv.type->m_object)
return FunctionDiscoverState::Failed;
// Void externs are very likely to be a func.
// TODO: Add some sanity checks for this!
if (!dv.type->IsFunction() && !(dv.type->IsVoid() && vFuncSym->GetType() == ExternalSymbol))
return FunctionDiscoverState::Failed;
return FunctionDiscoverState::Extern;
}
if (!IsLikelyFunction(vFuncAddr))
return FunctionDiscoverState::Failed;
m_logger->LogDebugF("Discovered function from virtual function table... {:#x}", vFuncAddr);
Ref<Platform> vftPlatform = m_view->GetDefaultPlatform()->GetAssociatedPlatformByAddress(vFuncAddr);
m_view->AddFunctionForAnalysis(vftPlatform, vFuncAddr, true);
return FunctionDiscoverState::Discovered;
}
void RTTIProcessor::DeserializedMetadata(RTTIProcessorType type, const Ref<Metadata> &metadata)
{
std::map<std::string, Ref<Metadata>> msvcMeta = metadata->GetKeyValueStore();
if (msvcMeta.find("classes") != msvcMeta.end())
{
for (auto &[objectAddrStr, classInfoMeta]: msvcMeta["classes"]->GetKeyValueStore())
{
uint64_t objectAddr = std::stoull(objectAddrStr);
auto classInfo = ClassInfo::DeserializedMetadata(classInfoMeta);
if (classInfo.processor == type)
m_classInfo[objectAddr] = classInfo;
else
m_unhandledClassInfo[objectAddr] = classInfo;
}
}
}