GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — binaryninja-api/python/function.py at dev · defunctio/binaryninja-api Expand file tree/ Copy pathfunction.pyMore file actions 3209 lines (2714 loc) · 101 KB / Copy pathfunction.pyFile metadata and controls3209 lines (2714 loc) · 101 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 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 # coding=utf-8 # Copyright (c) 2015-2020 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. from __future__ import absolute_import import threading import traceback import ctypes import numbers # Binary Ninja components import binaryninja from binaryninja import _binaryninjacore as core from binaryninja import associateddatastore # Required in the main scope due to being an argument for _FunctionAssociatedDataStore from binaryninja import highlight from binaryninja import log from binaryninja import types from binaryninja.enums import (AnalysisSkipReason, FunctionGraphType, BranchType, SymbolType, InstructionTextTokenType, HighlightStandardColor, HighlightColorStyle, RegisterValueType, ImplicitRegisterExtend, DisassemblyOption, IntegerDisplayType, InstructionTextTokenContext, VariableSourceType, FunctionAnalysisSkipOverride, MediumLevelILOperation) # 2-3 compatibility from binaryninja import range class LookupTableEntry(object): def __init__(self, from_values, to_value): self._from_values = from_values self._to_value = to_value def __repr__(self): return "[%s] -> %#x" % (', '.join(["%#x" % i for i in self.from_values]), self.to_value) @property def from_values(self): """ """ return self._from_values @from_values.setter def from_values(self, value): """ """ self._from_values = value @property def to_value(self): """ """ return self._to_value @to_value.setter def to_value(self, value): """ """ self._to_value = value class RegisterValue(object): def __init__(self, arch = None, value = None, confidence = types.max_confidence): self._is_constant = False self._value = None self._arch = None self._reg = None self._is_constant = False self._offset = None if value is None: self._type = RegisterValueType.UndeterminedValue else: self._type = RegisterValueType(value.state) if value.state == RegisterValueType.EntryValue: self._arch = arch if arch is not None: self._reg = arch.get_reg_name(value.value) else: self._reg = value.value elif (value.state == RegisterValueType.ConstantValue) or (value.state == RegisterValueType.ConstantPointerValue): self._value = value.value self._is_constant = True elif value.state == RegisterValueType.StackFrameOffset: self._offset = value.value elif value.state == RegisterValueType.ImportedAddressValue: self._value = value.value self._confidence = confidence def __repr__(self): if self._type == RegisterValueType.EntryValue: return "<entry %s>" % self._reg if self._type == RegisterValueType.ConstantValue: return "<const %#x>" % self._value if self._type == RegisterValueType.ConstantPointerValue: return "<const ptr %#x>" % self._value if self._type == RegisterValueType.StackFrameOffset: return "<stack frame offset %#x>" % self._offset if self._type == RegisterValueType.ReturnAddressValue: return "<return address>" if self._type == RegisterValueType.ImportedAddressValue: return "<imported address from entry %#x>" % self._value return "<undetermined>" def __hash__(self): if self._type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue, RegisterValueType.ImportedAddressValue, RegisterValueType.ReturnAddressValue]: return hash(self._value) elif self.type == RegisterValueType.EntryValue: return hash(self._reg) elif self._type == RegisterValueType.StackFrameOffset: return hash(self._offset) def __eq__(self, other): if self._type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue, RegisterValueType.ImportedAddressValue, RegisterValueType.ReturnAddressValue] and isinstance(other, numbers.Integral): return self._value == other elif self._type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantPointerValue, RegisterValueType.ImportedAddressValue, RegisterValueType.ReturnAddressValue] and hasattr(other, 'type') and other.type == self._type: return self._value == other.value elif self._type == RegisterValueType.EntryValue and hasattr(other, "type") and other.type == self._type: return self._reg == other.reg elif self._type == RegisterValueType.StackFrameOffset and hasattr(other, 'type') and other.type == self._type: return self._offset == other.offset elif self._type == RegisterValueType.StackFrameOffset and isinstance(other, numbers.Integral): return self._offset == other else: raise TypeError("'%s' is not valid for comparison to '%s'" % (other, self)) def _to_api_object(self): result = core.BNRegisterValue() result.type = self._type result._value = 0 if self._type == RegisterValueType.EntryValue: if self._arch is not None: result._value = self._arch.get_reg_index(self._reg) else: result._value = self._reg elif (self._type == RegisterValueType.ConstantValue) or (self._type == RegisterValueType.ConstantPointerValue): result._value = self._value elif self._type == RegisterValueType.StackFrameOffset: result._value = self._offset elif self._type == RegisterValueType.ImportedAddressValue: result._value = self._value return result @classmethod def undetermined(self): return RegisterValue() @classmethod def entry_value(self, arch, reg): result = RegisterValue() result._type = RegisterValueType.EntryValue result._arch = arch result._reg = reg return result @classmethod def constant(self, value): result = RegisterValue() result._type = RegisterValueType.ConstantValue result._value = value result._is_constant = True return result @classmethod def constant_ptr(self, value): result = RegisterValue() result._type = RegisterValueType.ConstantPointerValue result._value = value result._is_constant = True return result @classmethod def stack_frame_offset(self, offset): result = RegisterValue() result._type = RegisterValueType.StackFrameOffset result._offset = offset return result @classmethod def imported_address(self, value): result = RegisterValue() result._type = RegisterValueType.ImportedAddressValue result._value = value return result @classmethod def return_address(self): result = RegisterValue() result._type = RegisterValueType.ReturnAddressValue return result @property def is_constant(self): """Boolean for whether the RegisterValue is known to be constant (read-only)""" return self._is_constant @property def type(self): """:class:`~enums.RegisterValueType` (read-only)""" return self._type @property def arch(self): """Architecture where it exists, None otherwise (read-only)""" return self._arch @property def reg(self): """Register where the Architecture exists, None otherwise (read-only)""" return self._reg @property def value(self): """Value where it exists, None otherwise (read-only)""" return self._value @property def offset(self): """Offset where it exists, None otherwise (read-only)""" return self._offset @property def confidence(self): """Confidence where it exists, None otherwise (read-only)""" return self._confidence class ValueRange(object): def __init__(self, start, end, step): self._start = start self._end = end self._step = step def __repr__(self): if self.step == 1: return "<range: %#x to %#x>" % (self.start, self.end) return "<range: %#x to %#x, step %#x>" % (self.start, self.end, self.step) @property def start(self): """ """ return self._start @start.setter def start(self, value): """ """ self._start = value @property def end(self): """ """ return self._end @end.setter def end(self, value): """ """ self._end = value @property def step(self): """ """ return self._step @step.setter def step(self, value): """ """ self._step = value class PossibleValueSet(object): def __init__(self, arch, value): self._type = RegisterValueType(value.state) if value.state == RegisterValueType.EntryValue: 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]) def __repr__(self): if self._type == RegisterValueType.EntryValue: return "<entry %s>" % self.reg if self._type == RegisterValueType.ConstantValue: return "<const %#x>" % self.value if self._type == RegisterValueType.ConstantPointerValue: return "<const ptr %#x>" % self.value if self._type == RegisterValueType.StackFrameOffset: return "<stack frame offset %#x>" % self.offset if self._type == RegisterValueType.SignedRangeValue: return "<signed ranges: %s>" % repr(self.ranges) if self._type == RegisterValueType.UnsignedRangeValue: return "<unsigned ranges: %s>" % repr(self.ranges) if self._type == RegisterValueType.LookupTableValue: return "<table: %s>" % ', '.join([repr(i) for i in self.table]) if self._type == RegisterValueType.InSetOfValues: return "<in set(%s)>" % '[{}]'.format(', '.join(hex(i) for i in sorted(self.values))) if self._type == RegisterValueType.NotInSetOfValues: return "<not in set(%s)>" % '[{}]'.format(', '.join(hex(i) for i in sorted(self.values))) if self._type == RegisterValueType.ReturnAddressValue: return "<return address>" return "<undetermined>" @property def type(self): """ """ return self._type @type.setter def type(self, value): """ """ self._type = value @property def reg(self): """ """ return self._reg @reg.setter def reg(self, value): """ """ self._reg = value @property def value(self): """ """ return self._value @value.setter def value(self, value): """ """ self._value = value @property def offset(self): """ """ return self._offset @offset.setter def offset(self, value): """ """ self._offset = value @property def ranges(self): """ """ return self._ranges @ranges.setter def ranges(self, value): """ """ self._ranges = value @property def table(self): """ """ return self._table @table.setter def table(self, value): """ """ self._table = value @property def mapping(self): """ """ return self._mapping @mapping.setter def mapping(self, value): """ """ self._mapping = value @property def values(self): """ """ return self._values @values.setter def values(self, value): """ """ self._values = value def __eq__(self, other): if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantValue] and isinstance(other, numbers.Integral): return self.value == other if self.type in [RegisterValueType.ConstantValue, RegisterValueType.ConstantValue] and hasattr(other, 'type') and other.type == self.type: return self.value == other.value else: return self == other class StackVariableReference(object): def __init__(self, src_operand, t, name, var, ref_ofs, size): self._source_operand = src_operand self._type = t self._name = name self._var = var self._referenced_offset = ref_ofs self._size = size if self._source_operand == 0xffffffff: self._source_operand = None def __repr__(self): if self._source_operand is None: if self._referenced_offset != self._var.storage: return "<ref to %s%+#x>" % (self._name, self._referenced_offset - self._var.storage) return "<ref to %s>" % self._name if self._referenced_offset != self._var.storage: return "<operand %d ref to %s%+#x>" % (self._source_operand, self._name, self._var.storage) return "<operand %d ref to %s>" % (self._source_operand, self._name) @property def source_operand(self): """ """ return self._source_operand @source_operand.setter def source_operand(self, value): self._source_operand = value @property def type(self): """ """ return self._type @type.setter def type(self, value): self._type = value @property def name(self): """ """ return self._name @name.setter def name(self, value): self._name = value @property def var(self): """ """ return self._var @var.setter def var(self, value): self._var = value @property def referenced_offset(self): """ """ return self._referenced_offset @referenced_offset.setter def referenced_offset(self, value): self._referenced_offset = value @property def size(self): """ """ return self._size @size.setter def size(self, value): self._size = value class Variable(object): def __init__(self, func, source_type, index, storage, name = None, var_type = None): self._function = func self._source_type = VariableSourceType(source_type) self._index = index self._storage = storage var = core.BNVariable() var.type = source_type var.index = index var.storage = storage self._identifier = core.BNToVariableIdentifier(var) if func is not None: if name is None: name = core.BNGetVariableName(func.handle, var) if var_type is None: var_type_conf = core.BNGetVariableType(func.handle, var) if var_type_conf.type: var_type = types.Type(var_type_conf.type, platform = func.platform, confidence = var_type_conf.confidence) else: var_type = None self._name = name self._type = var_type @property def function(self): """Function where the variable is defined""" return self._function @function.setter def function(self, value): self._function = value @property def source_type(self): """:class:`~enums.VariableSourceType`""" return self._source_type @source_type.setter def source_type(self, value): self._source_type = value @property def index(self): """ """ return self._index @index.setter def index(self, value): self._index = value @property def storage(self): """Stack offset for StackVariableSourceType, register index for RegisterVariableSourceType""" return self._storage @storage.setter def storage(self, value): self._storage = value @property def identifier(self): """ """ return self._identifier @identifier.setter def identifier(self, value): self._identifier = value @property def name(self): """Name of the variable""" return self._name @name.setter def name(self, value): self._name = value @property def type(self): """ """ return self._type @type.setter def type(self, value): self._type = value @classmethod def from_identifier(self, func, identifier, name = None, var_type = None): var = core.BNFromVariableIdentifier(identifier) return Variable(func, VariableSourceType(var.type), var.index, var.storage, name, var_type) def __repr__(self): if self._type is None: return "<var %s>" % self.name return "<var %s %s%s>" % (self._type.get_string_before_name(), self.name, self._type.get_string_after_name()) def __str__(self): return self.name def __eq__(self, other): if not isinstance(other, Variable): return False return (self.identifier, self.function) == (other.identifier, other.function) def __hash__(self): return hash((self.identifier, self.function)) class ConstantReference(object): def __init__(self, val, size, ptr, intermediate): self._value = val self._size = size self._pointer = ptr self._intermediate = intermediate 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) @property def value(self): """ """ return self._value @value.setter def value(self, value): self._value = value @property def size(self): """ """ return self._size @size.setter def size(self, value): self._size = value @property def pointer(self): """ """ return self._pointer @pointer.setter def pointer(self, value): self._pointer = value @property def intermediate(self): """ """ return self._intermediate @intermediate.setter def intermediate(self, value): self._intermediate = value class IndirectBranchInfo(object): def __init__(self, source_arch, source_addr, dest_arch, dest_addr, auto_defined): self.source_arch = source_arch self.source_addr = source_addr self.dest_arch = dest_arch self.dest_addr = dest_addr self.auto_defined = auto_defined def __repr__(self): return "<branch %s:%#x -> %s:%#x>" % (self.source_arch.name, self.source_addr, self.dest_arch.name, self.dest_addr) class ParameterVariables(object): def __init__(self, var_list, confidence = types.max_confidence): self._vars = var_list self._confidence = confidence def __repr__(self): return repr(self._vars) def __iter__(self): for var in self._vars: yield var def __getitem__(self, idx): return self._vars[idx] def __len__(self): return len(self._vars) def with_confidence(self, confidence): return ParameterVariables(list(self._vars), confidence = confidence) @property def vars(self): """ """ return self._vars @vars.setter def vars(self, value): self._vars = value @property def confidence(self): """ """ return self._confidence @confidence.setter def confidence(self, value): self._confidence = value class _FunctionAssociatedDataStore(associateddatastore._AssociatedDataStore): _defaults = {} class Function(object): _associated_data = {} def __init__(self, view = None, handle = None): self._advanced_analysis_requests = 0 if handle is None: self.handle = None raise NotImplementedError("creation of standalone 'Function' objects is not implemented") self.handle = core.handle_of_type(handle, core.BNFunction) if view is None: self._view = binaryninja.binaryview.BinaryView(handle = core.BNGetFunctionData(self.handle)) else: self._view = view self._arch = None self._platform = None def __del__(self): if self.handle is not None: if self._advanced_analysis_requests > 0: core.BNReleaseAdvancedFunctionAnalysisDataMultiple(self.handle, self._advanced_analysis_requests) core.BNFreeFunction(self.handle) def __eq__(self, value): if not isinstance(value, Function): return False return ctypes.addressof(self.handle.contents) == ctypes.addressof(value.handle.contents) def __ne__(self, value): if not isinstance(value, Function): return True return ctypes.addressof(self.handle.contents) != ctypes.addressof(value.handle.contents) def __hash__(self): return hash((self.start, self.arch.name, self.platform.name)) def __getitem__(self, i): count = ctypes.c_ulonglong() blocks = core.BNGetFunctionBasicBlockList(self.handle, count) try: if i < 0: i = count.value + i if i < -len(self.basic_blocks) or i >= count.value: raise IndexError("index out of range") if i < 0: i = len(self.basic_blocks) + i block = binaryninja.basicblock.BasicBlock(core.BNNewBasicBlockReference(blocks[i]), self._view) return block finally: core.BNFreeBasicBlockList(blocks, count.value) def __iter__(self): count = ctypes.c_ulonglong() blocks = core.BNGetFunctionBasicBlockList(self.handle, count) try: for i in range(0, count.value): yield binaryninja.basicblock.BasicBlock(core.BNNewBasicBlockReference(blocks[i]), self._view) finally: core.BNFreeBasicBlockList(blocks, count.value) def __setattr__(self, name, value): try: object.__setattr__(self, name, value) except AttributeError: raise AttributeError("attribute '%s' is read only" % name) def __repr__(self): arch = self.arch if arch: return "<func: %s@%#x>" % (arch.name, self.start) else: return "<func: %#x>" % self.start @classmethod def _unregister(cls, func): handle = ctypes.cast(func, ctypes.c_void_p) if handle.value in cls._associated_data: del cls._associated_data[handle.value] @classmethod def set_default_session_data(cls, name, value): _FunctionAssociatedDataStore.set_default(name, value) @property def name(self): """Symbol name for the function""" return self.symbol.name @name.setter def name(self, value): if value is None: if self.symbol is not None: self.view.undefine_user_symbol(self.symbol) else: symbol = types.Symbol(SymbolType.FunctionSymbol, self.start, value) self.view.define_user_symbol(symbol) @property def view(self): """Function view (read-only)""" return self._view @property def arch(self): """Function architecture (read-only)""" if self._arch: return self._arch else: arch = core.BNGetFunctionArchitecture(self.handle) if arch is None: return None self._arch = binaryninja.architecture.CoreArchitecture._from_cache(arch) return self._arch @property def platform(self): """Function platform (read-only)""" if self._platform: return self._platform else: plat = core.BNGetFunctionPlatform(self.handle) if plat is None: return None self._platform = binaryninja.platform.Platform(handle = plat) return self._platform @property def start(self): """Function start address (read-only)""" return core.BNGetFunctionStart(self.handle) @property def total_bytes(self): """Total bytes of a function calculated by summing each basic_block. Because basic blocks can overlap and have gaps between them this may or may not be equivalent to a .size property.""" return sum(map(len, self)) @property def highest_address(self): "The highest virtual address contained in a function.""" return max(self, key=lambda block:block.end).end - 1 @property def lowest_address(self): """The lowest virtual address contained in a function.""" return min(self, key=lambda block:block.start).start @property def symbol(self): """Function symbol(read-only)""" sym = core.BNGetFunctionSymbol(self.handle) if sym is None: return None return types.Symbol(None, None, None, handle = sym) @property def auto(self): """Whether function was automatically discovered (read-only)""" return core.BNWasFunctionAutomaticallyDiscovered(self.handle) @property def can_return(self): """Whether function can return""" result = core.BNCanFunctionReturn(self.handle) return types.BoolWithConfidence(result.value, confidence = result.confidence) @can_return.setter def can_return(self, value): bc = core.BNBoolWithConfidence() bc.value = bool(value) if hasattr(value, 'confidence'): bc.confidence = value.confidence else: bc.confidence = types.max_confidence core.BNSetUserFunctionCanReturn(self.handle, bc) @property def explicitly_defined_type(self): """Whether function has explicitly defined types (read-only)""" return core.BNFunctionHasExplicitlyDefinedType(self.handle) @property def needs_update(self): """Whether the function has analysis that needs to be updated (read-only)""" return core.BNIsFunctionUpdateNeeded(self.handle) @property def basic_blocks(self): """List of basic blocks (read-only)""" count = ctypes.c_ulonglong() blocks = core.BNGetFunctionBasicBlockList(self.handle, count) result = [] for i in range(0, count.value): result.append(binaryninja.basicblock.BasicBlock(core.BNNewBasicBlockReference(blocks[i]), self._view)) core.BNFreeBasicBlockList(blocks, count.value) return result @property def comments(self): """Dict of comments (read-only)""" count = ctypes.c_ulonglong() addrs = core.BNGetCommentedAddresses(self.handle, count) result = {} for i in range(0, count.value): result[addrs[i]] = self.get_comment_at(addrs[i]) core.BNFreeAddressList(addrs) return result def create_user_tag(self, type, data): return self.create_tag(type, data, True) def create_auto_tag(self, type, data): return self.create_tag(type, data, False) def create_tag(self, type, data, user=True): """ ``create_tag`` creates a new Tag object but does not add it anywhere. Use :py:meth:`create_user_address_tag` or :py:meth:`create_user_function_tag` to create and add in one step. :param TagType type: The Tag Type for this Tag :param str data: Additional data for the Tag :return: The created Tag :rtype: Tag :Example: >>> tt = bv.tag_types["Crashes"] >>> tag = current_function.create_tag(tt, "Null pointer dereference", True) >>> current_function.add_user_address_tag(here, tag) >>> """ return self.view.create_tag(type, data, user) @property def address_tags(self): """ ``address_tags`` gets a list of all address Tags in the function. Tags are returned as a list of (arch, address, Tag) tuples. :rtype: list((Architecture, int, Tag)) """ count = ctypes.c_ulonglong() tags = core.BNGetAddressTagReferences(self.handle, count) result = [] for i in range(0, count.value): arch = binaryninja.architecture.CoreArchitecture(tags[i].arch) tag = binaryninja.binaryview.Tag(core.BNNewTagReference(tags[i].tag)) result.append((arch, tags[i].addr, tag)) core.BNFreeTagReferences(tags, count.value) return result def get_address_tags_at(self, addr, arch=None): """ ``get_address_tags_at`` gets a list of all Tags in the function at a given address. :param int addr: Address to get tags at :param Architecture arch: Architecture for the block in which the Tag is added (optional) :return: A list of Tags :rtype: list(Tag) """ if arch is None: arch = self.arch count = ctypes.c_ulonglong() tags = core.BNGetAddressTags(self.handle, arch.handle, addr, count) result = [] for i in range(0, count.value): result.append(binaryninja.binaryview.Tag(core.BNNewTagReference(tags[i]))) core.BNFreeTagList(tags, count.value) return result def add_user_address_tag(self, addr, tag, arch=None): """ |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |