-
Notifications
You must be signed in to change notification settings - Fork 200
/
highlevelil.cpp
570 lines (419 loc) · 14.6 KB
/
highlevelil.cpp
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
// Copyright (c) 2019 Vector 35 Inc
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
#include "binaryninjaapi.h"
#include "highlevelilinstruction.h"
using namespace BinaryNinja;
using namespace std;
HighLevelILFunction::HighLevelILFunction(Architecture* arch, Function* func)
{
m_object = BNCreateHighLevelILFunction(arch->GetObject(), func ? func->GetObject() : nullptr);
}
HighLevelILFunction::HighLevelILFunction(BNHighLevelILFunction* func)
{
m_object = func;
}
Ref<Function> HighLevelILFunction::GetFunction() const
{
BNFunction* func = BNGetHighLevelILOwnerFunction(m_object);
if (!func)
return nullptr;
return new Function(func);
}
Ref<Architecture> HighLevelILFunction::GetArchitecture() const
{
Ref<Function> func = GetFunction();
if (!func)
return nullptr;
return func->GetArchitecture();
}
uint64_t HighLevelILFunction::GetCurrentAddress() const
{
return BNHighLevelILGetCurrentAddress(m_object);
}
void HighLevelILFunction::SetCurrentAddress(Architecture* arch, uint64_t addr)
{
BNHighLevelILSetCurrentAddress(m_object, arch ? arch->GetObject() : nullptr, addr);
}
HighLevelILInstruction HighLevelILFunction::GetRootExpr()
{
return GetExpr(BNGetHighLevelILRootExpr(m_object));
}
void HighLevelILFunction::SetRootExpr(ExprId expr)
{
BNSetHighLevelILRootExpr(m_object, expr);
}
void HighLevelILFunction::SetRootExpr(const HighLevelILInstruction& expr)
{
BNSetHighLevelILRootExpr(m_object, expr.exprIndex);
}
ExprId HighLevelILFunction::AddExpr(
BNHighLevelILOperation operation, size_t size, ExprId a, ExprId b, ExprId c, ExprId d, ExprId e)
{
return BNHighLevelILAddExpr(m_object, operation, size, a, b, c, d, e);
}
ExprId HighLevelILFunction::AddExprWithLocation(BNHighLevelILOperation operation, uint64_t addr, uint32_t sourceOperand,
size_t size, ExprId a, ExprId b, ExprId c, ExprId d, ExprId e)
{
return BNHighLevelILAddExprWithLocation(m_object, operation, addr, sourceOperand, size, a, b, c, d, e);
}
ExprId HighLevelILFunction::AddExprWithLocation(BNHighLevelILOperation operation, const ILSourceLocation& loc,
size_t size, ExprId a, ExprId b, ExprId c, ExprId d, ExprId e)
{
if (loc.valid)
{
return BNHighLevelILAddExprWithLocation(
m_object, operation, loc.address, loc.sourceOperand, size, a, b, c, d, e);
}
return BNHighLevelILAddExpr(m_object, operation, size, a, b, c, d, e);
}
vector<uint64_t> HighLevelILFunction::GetOperandList(ExprId expr, size_t listOperand)
{
size_t count;
uint64_t* operands = BNHighLevelILGetOperandList(m_object, expr, listOperand, &count);
vector<uint64_t> result;
result.reserve(count);
for (size_t i = 0; i < count; i++)
result.push_back(operands[i]);
BNMediumLevelILFreeOperandList(operands);
return result;
}
ExprId HighLevelILFunction::AddOperandList(const vector<ExprId>& operands)
{
uint64_t* operandList = new uint64_t[operands.size()];
for (size_t i = 0; i < operands.size(); i++)
operandList[i] = operands[i];
ExprId result = (ExprId)BNHighLevelILAddOperandList(m_object, operandList, operands.size());
delete[] operandList;
return result;
}
ExprId HighLevelILFunction::AddIndexList(const vector<size_t>& operands)
{
uint64_t* operandList = new uint64_t[operands.size()];
for (size_t i = 0; i < operands.size(); i++)
operandList[i] = operands[i];
ExprId result = (ExprId)BNHighLevelILAddOperandList(m_object, operandList, operands.size());
delete[] operandList;
return result;
}
ExprId HighLevelILFunction::AddSSAVariableList(const vector<SSAVariable>& vars)
{
uint64_t* operandList = new uint64_t[vars.size() * 2];
for (size_t i = 0; i < vars.size(); i++)
{
operandList[i * 2] = vars[i].var.ToIdentifier();
operandList[(i * 2) + 1] = vars[i].version;
}
ExprId result = (ExprId)BNHighLevelILAddOperandList(m_object, operandList, vars.size() * 2);
delete[] operandList;
return result;
}
BNHighLevelILInstruction HighLevelILFunction::GetRawExpr(size_t i) const
{
return BNGetHighLevelILByIndex(m_object, i, true);
}
BNHighLevelILInstruction HighLevelILFunction::GetRawNonASTExpr(size_t i) const
{
return BNGetHighLevelILByIndex(m_object, i, false);
}
HighLevelILInstruction HighLevelILFunction::operator[](size_t i)
{
return GetInstruction(i);
}
HighLevelILInstruction HighLevelILFunction::GetInstruction(size_t i)
{
size_t expr = GetIndexForInstruction(i);
return HighLevelILInstruction(this, GetRawNonASTExpr(expr), expr, false, i);
}
HighLevelILInstruction HighLevelILFunction::GetExpr(size_t i, bool asFullAst)
{
if (asFullAst)
return HighLevelILInstruction(this, GetRawExpr(i), i, true, GetInstructionForExpr(i));
return HighLevelILInstruction(this, GetRawNonASTExpr(i), i, false, GetInstructionForExpr(i));
}
size_t HighLevelILFunction::GetIndexForInstruction(size_t i) const
{
return BNGetHighLevelILIndexForInstruction(m_object, i);
}
size_t HighLevelILFunction::GetInstructionForExpr(size_t expr) const
{
return BNGetHighLevelILInstructionForExpr(m_object, expr);
}
size_t HighLevelILFunction::GetInstructionCount() const
{
return BNGetHighLevelILInstructionCount(m_object);
}
size_t HighLevelILFunction::GetExprCount() const
{
return BNGetHighLevelILExprCount(m_object);
}
vector<Ref<BasicBlock>> HighLevelILFunction::GetBasicBlocks() const
{
size_t count;
BNBasicBlock** blocks = BNGetHighLevelILBasicBlockList(m_object, &count);
vector<Ref<BasicBlock>> result;
result.reserve(count);
for (size_t i = 0; i < count; i++)
result.push_back(new BasicBlock(BNNewBasicBlockReference(blocks[i])));
BNFreeBasicBlockList(blocks, count);
return result;
}
Ref<BasicBlock> HighLevelILFunction::GetBasicBlockForInstruction(size_t i) const
{
BNBasicBlock* block = BNGetHighLevelILBasicBlockForInstruction(m_object, i);
if (!block)
return nullptr;
return new BasicBlock(block);
}
Ref<HighLevelILFunction> HighLevelILFunction::GetSSAForm() const
{
BNHighLevelILFunction* func = BNGetHighLevelILSSAForm(m_object);
if (!func)
return nullptr;
return new HighLevelILFunction(func);
}
Ref<HighLevelILFunction> HighLevelILFunction::GetNonSSAForm() const
{
BNHighLevelILFunction* func = BNGetHighLevelILNonSSAForm(m_object);
if (!func)
return nullptr;
return new HighLevelILFunction(func);
}
size_t HighLevelILFunction::GetSSAInstructionIndex(size_t instr) const
{
return BNGetHighLevelILSSAInstructionIndex(m_object, instr);
}
size_t HighLevelILFunction::GetNonSSAInstructionIndex(size_t instr) const
{
return BNGetHighLevelILNonSSAInstructionIndex(m_object, instr);
}
size_t HighLevelILFunction::GetSSAExprIndex(size_t expr) const
{
return BNGetHighLevelILSSAExprIndex(m_object, expr);
}
size_t HighLevelILFunction::GetNonSSAExprIndex(size_t expr) const
{
return BNGetHighLevelILNonSSAExprIndex(m_object, expr);
}
size_t HighLevelILFunction::GetSSAVarDefinition(const SSAVariable& var) const
{
return BNGetHighLevelILSSAVarDefinition(m_object, &var.var, var.version);
}
size_t HighLevelILFunction::GetSSAMemoryDefinition(size_t version) const
{
return BNGetHighLevelILSSAMemoryDefinition(m_object, version);
}
set<size_t> HighLevelILFunction::GetSSAVarUses(const SSAVariable& var) const
{
size_t count;
size_t* instrs = BNGetHighLevelILSSAVarUses(m_object, &var.var, var.version, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(instrs[i]);
BNFreeILInstructionList(instrs);
return result;
}
set<size_t> HighLevelILFunction::GetSSAMemoryUses(size_t version) const
{
size_t count;
size_t* instrs = BNGetHighLevelILSSAMemoryUses(m_object, version, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(instrs[i]);
BNFreeILInstructionList(instrs);
return result;
}
bool HighLevelILFunction::IsSSAVarLive(const SSAVariable& var) const
{
return BNIsHighLevelILSSAVarLive(m_object, &var.var, var.version);
}
bool HighLevelILFunction::IsSSAVarLiveAt(const SSAVariable& var, const size_t instr) const
{
return BNIsHighLevelILSSAVarLiveAt(m_object, &var.var, var.version, instr);
}
bool HighLevelILFunction::IsVarLiveAt(const Variable& var, const size_t instr) const
{
return BNIsHighLevelILVarLiveAt(m_object, &var, instr);
}
set<size_t> HighLevelILFunction::GetVariableSSAVersions(const Variable& var) const
{
size_t count;
size_t* versions = BNGetHighLevelILVariableSSAVersions(m_object, &var, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(versions[i]);
BNFreeILInstructionList(versions);
return result;
}
set<size_t> HighLevelILFunction::GetVariableDefinitions(const Variable& var) const
{
size_t count;
size_t* instrs = BNGetHighLevelILVariableDefinitions(m_object, &var, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(instrs[i]);
BNFreeILInstructionList(instrs);
return result;
}
set<size_t> HighLevelILFunction::GetVariableUses(const Variable& var) const
{
size_t count;
size_t* instrs = BNGetHighLevelILVariableUses(m_object, &var, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(instrs[i]);
BNFreeILInstructionList(instrs);
return result;
}
size_t HighLevelILFunction::GetSSAVarVersionAtInstruction(const Variable& var, size_t instr) const
{
return BNGetHighLevelILSSAVarVersionAtILInstruction(m_object, &var, instr);
}
size_t HighLevelILFunction::GetSSAMemoryVersionAtInstruction(size_t instr) const
{
return BNGetHighLevelILSSAMemoryVersionAtILInstruction(m_object, instr);
}
Ref<MediumLevelILFunction> HighLevelILFunction::GetMediumLevelIL() const
{
BNMediumLevelILFunction* result = BNGetMediumLevelILForHighLevelILFunction(m_object);
if (!result)
return nullptr;
return new MediumLevelILFunction(result);
}
size_t HighLevelILFunction::GetMediumLevelILExprIndex(size_t expr) const
{
return BNGetMediumLevelILExprIndexFromHighLevelIL(m_object, expr);
}
set<size_t> HighLevelILFunction::GetMediumLevelILExprIndexes(size_t expr) const
{
size_t count;
size_t* exprs = BNGetMediumLevelILExprIndexesFromHighLevelIL(m_object, expr, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(exprs[i]);
BNFreeILInstructionList(exprs);
return result;
}
void HighLevelILFunction::UpdateInstructionOperand(size_t i, size_t operandIndex, ExprId value)
{
BNUpdateHighLevelILOperand(m_object, i, operandIndex, value);
}
void HighLevelILFunction::ReplaceExpr(size_t expr, size_t newExpr)
{
BNReplaceHighLevelILExpr(m_object, expr, newExpr);
}
void HighLevelILFunction::SetExprAttributes(size_t expr, uint32_t attributes)
{
BNSetHighLevelILExprAttributes(m_object, expr, attributes);
}
void HighLevelILFunction::Finalize()
{
BNFinalizeHighLevelILFunction(m_object);
}
void HighLevelILFunction::GenerateSSAForm(const set<Variable>& aliases)
{
BNVariable* aliasList = new BNVariable[aliases.size()];
size_t i = 0;
for (auto& alias : aliases)
{
aliasList[i].type = alias.type;
aliasList[i].index = alias.index;
aliasList[i].storage = alias.storage;
i++;
}
BNGenerateHighLevelILSSAForm(m_object, aliasList, aliases.size());
delete[] aliasList;
}
vector<DisassemblyTextLine> HighLevelILFunction::GetExprText(ExprId expr, bool asFullAst, DisassemblySettings* settings)
{
size_t count;
BNDisassemblyTextLine* lines =
BNGetHighLevelILExprText(m_object, expr, asFullAst, &count, settings ? settings->GetObject() : nullptr);
vector<DisassemblyTextLine> result;
result.reserve(count);
for (size_t i = 0; i < count; i++)
{
DisassemblyTextLine line;
line.addr = lines[i].addr;
line.instrIndex = lines[i].instrIndex;
line.highlight = lines[i].highlight;
line.tokens = InstructionTextToken::ConvertInstructionTextTokenList(lines[i].tokens, lines[i].count);
line.tags = Tag::ConvertTagList(lines[i].tags, lines[i].tagCount);
result.push_back(line);
}
BNFreeDisassemblyTextLines(lines, count);
return result;
}
vector<DisassemblyTextLine> HighLevelILFunction::GetExprText(
const HighLevelILInstruction& instr, bool asFullAst, DisassemblySettings* settings)
{
return GetExprText(instr.exprIndex, asFullAst, settings);
}
vector<DisassemblyTextLine> HighLevelILFunction::GetInstructionText(
size_t i, bool asFullAst, DisassemblySettings* settings)
{
HighLevelILInstruction instr = GetInstruction(i);
return GetExprText(instr, asFullAst, settings);
}
Confidence<Ref<Type>> HighLevelILFunction::GetExprType(size_t expr)
{
BNTypeWithConfidence result = BNGetHighLevelILExprType(m_object, expr);
if (!result.type)
return nullptr;
return Confidence<Ref<Type>>(new Type(result.type), result.confidence);
}
Confidence<Ref<Type>> HighLevelILFunction::GetExprType(const HighLevelILInstruction& expr)
{
return GetExprType(expr.exprIndex);
}
void HighLevelILFunction::SetExprType(size_t expr, const Confidence<Ref<Type>>& type)
{
BNTypeWithConfidence tc;
tc.type = type->GetObject();
tc.confidence = type.GetConfidence();
BNSetHighLevelILExprType(m_object, expr, &tc);
}
void HighLevelILFunction::SetExprType(const BinaryNinja::HighLevelILInstruction& expr,
const Confidence<Ref<BinaryNinja::Type>>& type)
{
SetExprType(expr.exprIndex, type);
}
void HighLevelILFunction::VisitAllExprs(const function<bool(const HighLevelILInstruction& expr)>& func)
{
GetRootExpr().VisitExprs([&](const HighLevelILInstruction& expr) { return func(expr); });
}
Ref<FlowGraph> HighLevelILFunction::CreateFunctionGraph(DisassemblySettings* settings)
{
BNFlowGraph* graph = BNCreateHighLevelILFunctionGraph(m_object, settings ? settings->GetObject() : nullptr);
return new CoreFlowGraph(graph);
}
size_t HighLevelILFunction::GetExprIndexForLabel(uint64_t label)
{
return BNGetHighLevelILExprIndexForLabel(m_object, label);
}
set<size_t> HighLevelILFunction::GetUsesForLabel(uint64_t label)
{
size_t count;
size_t* uses = BNGetHighLevelILUsesForLabel(m_object, label, &count);
set<size_t> result;
for (size_t i = 0; i < count; i++)
result.insert(uses[i]);
BNFreeILInstructionList(uses);
return result;
}