forked from Vector35/binaryninja-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvariable.py
More file actions
801 lines (668 loc) · 25.4 KB
/
variable.py
File metadata and controls
801 lines (668 loc) · 25.4 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
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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
# coding=utf-8
# Copyright (c) 2015-2021 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.
import ctypes
from typing import List, Generator, Optional, Union, Set, Mapping
from dataclasses import dataclass, field
import binaryninja
from . import _binaryninjacore as core
from . import decorators
from .enums import RegisterValueType, VariableSourceType, DeadStoreElimination
@dataclass(frozen=True)
class LookupTableEntry:
from_values:List[int]
to_value:int
def __repr__(self):
return f"[{', '.join([f'{i:#x}' for i in self.from_values])}] -> {self.to_value:#x}"
def type(self):
return RegisterValueType.LookupTableValue
@dataclass(frozen=True)
class RegisterValue:
value:int
offset:int
type:RegisterValueType = RegisterValueType.UndeterminedValue
confidence:int=core.max_confidence
def _to_core_struct(self) -> core.BNRegisterValue:
result = core.BNRegisterValue()
result.state = self.type
result.value = self.value
result.offset = self.offset
return result
def _to_core_struct_with_confidence(self):
result = core.BNRegisterValueWithConfidence()
result.value = self._to_core_struct()
result.confidence = self.confidence
return result
def __bool__(self):
return self.value != 0
def __int__(self):
return self.value
def __eq__(self, other):
if isinstance(other, int):
return int(self) == other
elif isinstance(other, bool):
return bool(self) == other
elif isinstance(other, self.__class__):
return (self.type, self.offset, self.type, self.confidence) == \
(other.type, other.offset, other.type, other.confidence)
assert False, f"no comparison for types {repr(self)} and {repr(other)}"
@classmethod
def from_BNRegisterValue(cls, reg_value:Union[core.BNRegisterValue, core.BNRegisterValueWithConfidence],
arch:Optional['binaryninja.architecture.Architecture']=None) -> 'RegisterValue':
confidence = core.max_confidence
if isinstance(reg_value, core.BNRegisterValueWithConfidence):
confidence = reg_value.confidence
reg_value = reg_value.value
if reg_value.state == RegisterValueType.EntryValue:
reg = None
if arch is not None:
reg = arch.get_reg_name(binaryninja.architecture.RegisterIndex(reg_value.value))
return EntryRegisterValue(reg_value.value, reg=reg, confidence=confidence)
elif reg_value.state == RegisterValueType.ConstantValue:
return ConstantRegisterValue(reg_value.value, confidence=confidence)
elif reg_value.state == RegisterValueType.ConstantPointerValue:
return ConstantPointerRegisterValue(reg_value.value, confidence=confidence)
elif reg_value.state == RegisterValueType.StackFrameOffset:
return StackFrameOffsetRegisterValue(reg_value.value, confidence=confidence)
elif reg_value.state == RegisterValueType.ImportedAddressValue:
return ImportedAddressRegisterValue(reg_value.value, confidence=confidence)
elif reg_value.state == RegisterValueType.UndeterminedValue:
return Undetermined()
elif reg_value.state == RegisterValueType.ReturnAddressValue:
return ReturnAddressRegisterValue(reg_value.value, confidence=confidence)
elif reg_value.state == RegisterValueType.ExternalPointerValue:
return ExternalPointerRegisterValue(reg_value.value, reg_value.offset, confidence=confidence)
assert False, f"RegisterValueType {reg_value.state} not handled"
@dataclass(frozen=True, eq=False)
class Undetermined(RegisterValue):
value:int = 0
offset:int = 0
type:RegisterValueType = RegisterValueType.UndeterminedValue
def __repr__(self):
return "<undetermined>"
@dataclass(frozen=True, eq=False)
class ConstantRegisterValue(RegisterValue):
offset:int = 0
type:RegisterValueType = RegisterValueType.ConstantValue
def __repr__(self):
return f"<const {self.value:#x}>"
@dataclass(frozen=True, eq=False)
class ConstantPointerRegisterValue(RegisterValue):
offset:int = 0
type:RegisterValueType = RegisterValueType.ConstantPointerValue
def __repr__(self):
return f"<const ptr {self.value:#x}>"
@dataclass(frozen=True, eq=False)
class ImportedAddressRegisterValue(RegisterValue):
offset:int = 0
type:RegisterValueType = RegisterValueType.ImportedAddressValue
def __repr__(self):
return f"<imported address from entry {self.value:#x}>"
@dataclass(frozen=True, eq=False)
class ReturnAddressRegisterValue(RegisterValue):
offset:int = 0
type:RegisterValueType = RegisterValueType.ReturnAddressValue
def __repr__(self):
return "<return address>"
@dataclass(frozen=True, eq=False)
class EntryRegisterValue(RegisterValue):
value:int = 0
offset:int = 0
type:RegisterValueType = RegisterValueType.EntryValue
reg:Optional['binaryninja.architecture.RegisterName'] = None
def __repr__(self):
if self.reg is not None:
return f"<entry {self.reg}>"
return f"<entry {self.value}>"
@dataclass(frozen=True, eq=False)
class StackFrameOffsetRegisterValue(RegisterValue):
offset:int = 0
type:RegisterValueType = RegisterValueType.StackFrameOffset
def __repr__(self):
return f"<stack frame offset {self.value:#x}>"
@dataclass(frozen=True, eq=False)
class ExternalPointerRegisterValue(RegisterValue):
type:RegisterValueType = RegisterValueType.ExternalPointerValue
def __repr__(self):
return f"<external {self.value:#x} + offset {self.offset:#x}>"
@dataclass(frozen=True)
class ValueRange:
start:int
end:int
step:int
def __repr__(self):
if self.step == 1:
return f"<range: {self.start:#x} to {self.end:#x}>"
return f"<range: {self.start:#x} to {self.end:#x}, step {self.step:#x}>"
def __contains__(self, other):
if not isinstance(other, int):
return NotImplemented
return other in range(self.start, self.end, self.step)
@decorators.passive
class PossibleValueSet:
"""
`class PossibleValueSet` PossibleValueSet is used to define possible values
that a variable can take. It contains methods to instantiate different
value sets such as Constant, Signed/Unsigned Ranges, etc.
"""
def __init__(self, arch = None, value = None):
if value is None:
self._type = RegisterValueType.UndeterminedValue
return
self._type = RegisterValueType(value.state)
if value.state == RegisterValueType.EntryValue:
if arch is None:
self._reg = value.value
else:
self._reg = arch.get_reg_name(value.value)
elif value.state == RegisterValueType.ConstantValue:
self._value = value.value
elif value.state == RegisterValueType.ConstantPointerValue:
self._value = value.value
elif value.state == RegisterValueType.StackFrameOffset:
self._offset = value.value
elif value.state == RegisterValueType.SignedRangeValue:
self._offset = value.value
self._ranges = []
for i in range(0, value.count):
start = value.ranges[i].start
end = value.ranges[i].end
step = value.ranges[i].step
if start & (1 << 63):
start |= ~((1 << 63) - 1)
if end & (1 << 63):
end |= ~((1 << 63) - 1)
self._ranges.append(ValueRange(start, end, step))
elif value.state == RegisterValueType.UnsignedRangeValue:
self._offset = value.value
self._ranges = []
for i in range(0, value.count):
start = value.ranges[i].start
end = value.ranges[i].end
step = value.ranges[i].step
self._ranges.append(ValueRange(start, end, step))
elif value.state == RegisterValueType.LookupTableValue:
self._table = []
self._mapping = {}
for i in range(0, value.count):
from_list = []
for j in range(0, value.table[i].fromCount):
from_list.append(value.table[i].fromValues[j])
self._mapping[value.table[i].fromValues[j]] = value.table[i].toValue
self._table.append(LookupTableEntry(from_list, value.table[i].toValue))
elif (value.state == RegisterValueType.InSetOfValues) or (value.state == RegisterValueType.NotInSetOfValues):
self._values = set()
for i in range(0, value.count):
self._values.add(value.valueSet[i])
self._count = value.count
def __repr__(self):
if self._type == RegisterValueType.EntryValue:
return f"<entry {self.reg}>"
if self._type == RegisterValueType.ConstantValue:
return f"<const {self.value:#x}>"
if self._type == RegisterValueType.ConstantPointerValue:
return f"<const ptr {self.value:#x}>"
if self._type == RegisterValueType.StackFrameOffset:
return f"<stack frame offset {self._offset:#x}>"
if self._type == RegisterValueType.SignedRangeValue:
return f"<signed ranges: {repr(self.ranges)}>"
if self._type == RegisterValueType.UnsignedRangeValue:
return f"<unsigned ranges: {repr(self.ranges)}>"
if self._type == RegisterValueType.LookupTableValue:
return f"<table: {', '.join([repr(i) for i in self.table])}>"
if self._type == RegisterValueType.InSetOfValues:
return f"<in set([{', '.join(hex(i) for i in sorted(self.values))}])>"
if self._type == RegisterValueType.NotInSetOfValues:
return f"<not in set([{', '.join(hex(i) for i in sorted(self.values))}])>"
if self._type == RegisterValueType.ReturnAddressValue:
return "<return address>"
return "<undetermined>"
def __contains__(self, other):
if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue] and isinstance(other, int):
return self.value == other
if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue] and hasattr(other, "value"):
return self.value == other.value
if not isinstance(other, int):
return NotImplemented
#Initial implementation only checks numbers, no set logic
if self.type == RegisterValueType.StackFrameOffset:
return NotImplemented
if self.type in [RegisterValueType.SignedRangeValue, RegisterValueType.UnsignedRangeValue]:
for rng in self.ranges:
if other in rng:
return True
return False
if self.type == RegisterValueType.InSetOfValues:
return other in self.values
if self.type == RegisterValueType.NotInSetOfValues:
return not other in self.values
return NotImplemented
def __eq__(self, other):
if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue] and isinstance(other, int):
return self.value == other
if not isinstance(other, self.__class__):
return NotImplemented
if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue]:
return self.value == other.value
elif self.type == RegisterValueType.StackFrameOffset:
return self.offset == other.offset
elif self.type in [RegisterValueType.SignedRangeValue, RegisterValueType.UnsignedRangeValue]:
return self.ranges == other.ranges
elif self.type in [RegisterValueType.InSetOfValues, RegisterValueType.NotInSetOfValues]:
return self.values == other.values
elif self.type == RegisterValueType.UndeterminedValue and hasattr(other, 'type'):
return self.type == other.type
else:
return self == other
def __ne__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return not (self == other)
def _to_core_struct(self) -> core.BNPossibleValueSet:
result = core.BNPossibleValueSet()
result.state = RegisterValueType(self.type)
if self.type == RegisterValueType.UndeterminedValue:
return result
elif self.type == RegisterValueType.ConstantValue:
result.value = self.value
elif self.type == RegisterValueType.ConstantPointerValue:
result.value = self.value
elif self.type == RegisterValueType.StackFrameOffset:
result.offset = self.value
elif self.type == RegisterValueType.SignedRangeValue:
result.offset = self.value
result.ranges = (core.BNValueRange * self.count)()
for i in range(0, self.count):
start = self.ranges[i].start
end = self.ranges[i].end
if start & (1 << 63):
start |= ~((1 << 63) - 1)
if end & (1 << 63):
end |= ~((1 << 63) - 1)
value_range = core.BNValueRange()
value_range.start = start
value_range.end = end
value_range.step = self.ranges[i].step
result.ranges[i] = value_range
result.count = self.count
elif self.type == RegisterValueType.UnsignedRangeValue:
result.offset = self.value
result.ranges = (core.BNValueRange * self.count)()
for i in range(0, self.count):
value_range = core.BNValueRange()
value_range.start = self.ranges[i].start
value_range.end = self.ranges[i].end
value_range.step = self.ranges[i].step
result.ranges[i] = value_range
result.count = self.count
elif self.type == RegisterValueType.LookupTableValue:
result.table = []
result.mapping = {}
for i in range(self.count):
from_list = []
for j in range(0, len(self.table[i].from_values)):
from_list.append(self.table[i].from_values[j])
result.mapping[self.table[i].from_values[j]] = result.table[i].to_value
result.table.append(LookupTableEntry(from_list, result.table[i].to_value))
result.count = self.count
elif (self.type == RegisterValueType.InSetOfValues) or (self.type == RegisterValueType.NotInSetOfValues):
values = (ctypes.c_longlong * self.count)()
i = 0
for value in self.values:
values[i] = value
i += 1
int_ptr = ctypes.POINTER(ctypes.c_longlong)
result.valueSet = ctypes.cast(values, int_ptr)
result.count = self.count
return result
@property
def type(self) -> RegisterValueType:
return self._type
@property
def reg(self) -> 'binaryninja.architecture.RegisterName':
return self._reg
@property
def value(self) -> int:
return self._value
@property
def offset(self) -> int:
return self._offset
@property
def ranges(self) -> List[ValueRange]:
return self._ranges
@property
def table(self) -> List[LookupTableEntry]:
return self._table
@property
def mapping(self) -> Mapping[int, int]:
return self._mapping
@property
def values(self) -> Set[int]:
return self._values
@property
def count(self) -> int:
return self._count
@staticmethod
def undetermined() -> 'PossibleValueSet':
"""
Create a PossibleValueSet object of type UndeterminedValue.
:return: PossibleValueSet object of type UndeterminedValue
:rtype: PossibleValueSet
"""
return PossibleValueSet()
@staticmethod
def constant(value:int) -> 'PossibleValueSet':
"""
Create a constant valued PossibleValueSet object.
:param int value: Integer value of the constant
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.ConstantValue
result._value = value
return result
@staticmethod
def constant_ptr(value:int) -> 'PossibleValueSet':
"""
Create constant pointer valued PossibleValueSet object.
:param int value: Integer value of the constant pointer
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.ConstantPointerValue
result._value = value
return result
@staticmethod
def stack_frame_offset(offset:int) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a stack frame offset.
:param int value: Integer value of the offset
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.StackFrameOffset
result._offset = offset
return result
@staticmethod
def signed_range_value(ranges:List[ValueRange]) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a signed range of values.
:param list(ValueRange) ranges: List of ValueRanges
:rtype: PossibleValueSet
:Example:
>>> v_1 = ValueRange(-5, -1, 1)
>>> v_2 = ValueRange(7, 10, 1)
>>> val = PossibleValueSet.signed_range_value([v_1, v_2])
<signed ranges: [<range: -0x5 to -0x1>, <range: 0x7 to 0xa>]>
"""
result = PossibleValueSet()
result._value = 0
result._type = RegisterValueType.SignedRangeValue
result._ranges = ranges
result._count = len(ranges)
return result
@staticmethod
def unsigned_range_value(ranges:List[ValueRange]) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a unsigned signed range of values.
:param list(ValueRange) ranges: List of ValueRanges
:rtype: PossibleValueSet
:Example:
>>> v_1 = ValueRange(0, 5, 1)
>>> v_2 = ValueRange(7, 10, 1)
>>> val = PossibleValueSet.unsigned_range_value([v_1, v_2])
<unsigned ranges: [<range: 0x0 to 0x5>, <range: 0x7 to 0xa>]>
"""
result = PossibleValueSet()
result._value = 0
result._type = RegisterValueType.UnsignedRangeValue
result._ranges = ranges
result._count = len(ranges)
return result
@staticmethod
def in_set_of_values(values:Union[List[int], Set[int]]) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a value in a set of values.
:param list(int) values: List of integer values
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.InSetOfValues
result._values = set(values)
result._count = len(values)
return result
@staticmethod
def not_in_set_of_values(values) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a value NOT in a set of values.
:param list(int) values: List of integer values
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.NotInSetOfValues
result._values = set(values)
result._count = len(values)
return result
@staticmethod
def lookup_table_value(lookup_table, mapping) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a value which is a member of a
lookuptable.
:param list(LookupTableEntry) lookup_table: List of table entries
:param dict of (int, int) mapping: Mapping used for resolution
:rtype: PossibleValueSet
"""
result = PossibleValueSet()
result._type = RegisterValueType.LookupTableValue
result._table = lookup_table
result._mapping = mapping
return result
@dataclass(frozen=True)
class StackVariableReference:
_source_operand:Optional[int]
type:'binaryninja.types.Type'
name:str
var:'Variable'
referenced_offset:int
size:int
def __repr__(self):
if self.source_operand is None:
if self.referenced_offset != self.var.storage:
return f"<ref to {self.name}{self.referenced_offset - self.var.storage:+#x}>"
return f"<ref to {self.name}>"
if self.referenced_offset != self.var.storage:
return f"<operand {self.source_operand} ref to {self.var.storage}{self.var.storage:+#x}>"
return f"<operand {self.source_operand} ref to {self.name}>"
@property
def source_operand(self):
if self._source_operand == 0xffffffff:
return None
return self._source_operand
@dataclass(frozen=True, order=True)
class CoreVariable:
_source_type:int
index:int
storage:int
@property
def identifier(self) -> int:
return core.BNToVariableIdentifier(self.to_BNVariable())
@property
def source_type(self) -> VariableSourceType:
return VariableSourceType(self._source_type)
def to_BNVariable(self):
v = core.BNVariable()
v.type = self._source_type
v.index = self.index
v.storage = self.storage
return v
@classmethod
def from_BNVariable(cls, var:core.BNVariable):
return cls(var.type, var.index, var.storage)
@classmethod
def from_identifier(cls, identifier):
var = core.BNFromVariableIdentifier(identifier)
return cls(var.type, var.index, var.storage)
@dataclass(frozen=True, order=True)
class VariableNameAndType(CoreVariable):
name:str
type:'binaryninja.types.Type'
@classmethod
def from_identifier(cls, identifier, name, type):
var = core.BNFromVariableIdentifier(identifier)
return cls(name, type, var.type, var.index, var.storage)
@classmethod
def from_core_variable(cls, var, name, type):
return cls(name, type, var.type, var.index, var.storage)
class Variable(CoreVariable):
def __init__(self, func:'binaryninja.function.Function', source_type:VariableSourceType, index:int, storage:int):
super(Variable, self).__init__(source_type, index, storage)
self._function = func
@classmethod
def from_variable_name_and_type(cls, func:'binaryninja.function.Function', var:VariableNameAndType):
return cls(func, VariableSourceType(var.type), var.index, var.storage)
@classmethod
def from_core_variable(cls, func:'binaryninja.function.Function', var:CoreVariable):
return cls(func, var.source_type, var.index, var.storage)
@classmethod
def from_BNVariable(cls, func:'binaryninja.function.Function', var:core.BNVariable):
return cls(func, var.type, var.index, var.storage)
@classmethod
def from_identifier(cls, func:'binaryninja.function.Function', identifier:int):
var = core.BNFromVariableIdentifier(identifier)
return cls(func, VariableSourceType(var.type), var.index, var.storage)
def __repr__(self):
if self.type is not None:
return f"<var {self.type.get_string_before_name()} {self.name}{self.type.get_string_after_name()}>"
else:
return repr(super(Variable, self))
def __str__(self):
return self.name
def __eq__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return (self.identifier, self._function) == (other.identifier, other._function)
def __ne__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return not (self == other)
def __lt__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return (self.identifier, self._function) < (other.identifier, other._function)
def __gt__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return (self.identifier, self._function) > (other.identifier, other._function)
def __le__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return (self.identifier, self._function) <= (other.identifier, other._function)
def __ge__(self, other):
if not isinstance(other, self.__class__):
return NotImplemented
return (self.identifier, self._function) >= (other.identifier, other._function)
def __hash__(self):
return hash((self._function, self.identifier))
@property
def var_name_and_type(self) -> VariableNameAndType:
return VariableNameAndType.from_core_variable(self, self.name, self.type)
@property
def name(self):
"""Name of the variable"""
return core.BNGetRealVariableName(self._function.handle, self._function.arch.handle, self.to_BNVariable())
@name.setter
def name(self, name:Optional[str]) -> None:
if name is None:
name = ""
self._function.create_user_var(self, self.type, name)
@property
def type(self) -> Optional['binaryninja.types.Type']:
var_type_conf = core.BNGetVariableType(self._function.handle, self.to_BNVariable())
if var_type_conf.type:
ref_handle = core.BNNewTypeReference(var_type_conf.type)
assert ref_handle is not None, f"core.BNNewTypeReference returned None {var_type_conf} {var_type_conf.type}"
return binaryninja.types.Type.create(ref_handle, self._function.platform, var_type_conf.confidence)
return None
@type.setter
def type(self, new_type:'binaryninja.types.Type') -> None:
self._function.create_user_var(self, new_type, self.name)
@property
def dead_store_elimination(self):
return DeadStoreElimination(core.BNGetFunctionVariableDeadStoreElimination(self._function.handle, self.to_BNVariable()))
@dead_store_elimination.setter
def dead_store_elimination(self, value):
core.BNSetFunctionVariableDeadStoreElimination(self._function.handle, self.to_BNVariable(), value)
@dataclass(frozen=True)
class ConstantReference:
value:int
size:int
pointer:bool
intermediate:bool
def __repr__(self):
if self.pointer:
return "<constant pointer %#x>" % self.value
if self.size == 0:
return "<constant %#x>" % self.value
return "<constant %#x size %d>" % (self.value, self.size)
@dataclass(frozen=True)
class IndirectBranchInfo:
source_arch:'binaryninja.architecture.Architecture'
source_addr:int
dest_arch:'binaryninja.architecture.Architecture'
dest_addr:int
auto_defined:bool
def __repr__(self):
return f"<branch {self.source_arch.name}:{self.source_addr:#x} -> {self.dest_arch.name}:{self.dest_addr:#x}>"
@decorators.passive
class ParameterVariables:
def __init__(self, var_list:List[Variable], confidence:int=core.max_confidence, func:Optional['binaryninja.function.Function']=None):
self._vars = var_list
self._confidence = confidence
self._func = func
def __repr__(self):
return repr(self._vars)
def __len__(self):
return len(self._vars)
def __iter__(self) -> Generator['Variable', None, None]:
for var in self._vars:
yield var
def __getitem__(self, idx) -> 'Variable':
return self._vars[idx]
def __setitem__(self, idx:int, value:'Variable'):
self._vars[idx] = value
if self._func is not None:
self._func.parameter_vars = self
def with_confidence(self, confidence:int) -> 'ParameterVariables':
return ParameterVariables(list(self._vars), confidence, self._func)
@property
def vars(self) -> List['Variable']:
return self._vars
@property
def confidence(self) -> int:
return self._confidence
@property
def function(self) -> Optional['binaryninja.function.Function']:
return self._func
@dataclass(frozen=True, order=True)
class AddressRange:
start:int # Inclusive starting address
end:int # Exclusive ending address
def __repr__(self):
return f"<{self.start:#x}-{self.end:#x}>"