diff options
Diffstat (limited to 'python')
| -rw-r--r-- | python/lowlevelil.py | 25 | ||||
| -rw-r--r-- | python/mediumlevelil.py | 12 |
2 files changed, 30 insertions, 7 deletions
diff --git a/python/lowlevelil.py b/python/lowlevelil.py index 65134939..7e941885 100644 --- a/python/lowlevelil.py +++ b/python/lowlevelil.py @@ -6136,7 +6136,8 @@ class LowLevelILFunction: def prepare_to_copy_function(self, src: 'LowLevelILFunction'): """ ``prepare_to_copy_function`` sets up state in this LLIL function in preparation - of copying instructions from ``src`` + of copying instructions from ``src``. + It enables use of :py:func:`get_label_for_source_instruction` during function transformation. :param LowLevelILFunction src: function about to be copied from """ @@ -6146,6 +6147,7 @@ class LowLevelILFunction: """ ``prepare_to_copy_block`` sets up state when copying a function in preparation of copying the instructions from the block ``src`` + It enables use of :py:func:`get_label_for_source_instruction` during function transformation. :param LowLevelILBasicBlock src: block about to be copied from """ @@ -6153,8 +6155,14 @@ class LowLevelILFunction: def get_label_for_source_instruction(self, i: InstructionIndex) -> Optional['LowLevelILLabel']: """ - Get the LowLevelILLabel for a given source instruction. The returned label is to an internal object with - the same lifetime as the containing LowLevelILFunction. + Get the LowLevelILLabel for a given source instruction. The source instruction must be + at the start of a basic block in the source function passed to :py:func:`prepare_to_copy_function`. + The label will be marked resolved when its source block is passed to :py:func:`prepare_to_copy_block`. + + .. warning:: The instruction index parameter for this pertains to the *source function* + passed to `prepare_to_copy_function`, not the current function. + + .. note:: The returned label is to an internal object with the same lifetime as the containing LowLevelILFunction. :param i: The source instruction index :return: The LowLevelILLabel for the source instruction @@ -6167,7 +6175,9 @@ class LowLevelILFunction: def add_label_for_address(self, arch: 'architecture.Architecture', addr: int) -> None: """ ``add_label_for_address`` adds a low-level IL label for the given architecture ``arch`` at the given virtual - address ``addr`` + address ``addr``. + This is generally called automatically by the core when Lifted IL is being generated, + and will be automatically called with the start address of every basic block found during disassembly. :param Architecture arch: Architecture to add labels for :param int addr: the IL address to add a label at @@ -6178,7 +6188,12 @@ class LowLevelILFunction: def get_label_for_address(self, arch: 'architecture.Architecture', addr: int) -> Optional[LowLevelILLabel]: """ - ``get_label_for_address`` returns the LowLevelILLabel for the given Architecture ``arch`` and IL address ``addr``. + ``get_label_for_address`` returns the LowLevelILLabel for the given Architecture ``arch`` and IL address ``addr`` + that has been previously added to the function with :py:func:`add_label_for_address`. + When lifting to Lifted IL, labels will be automatically added with :py:func:`add_label_for_address` + for the start address of every basic block found during disassembly. + + .. note:: The returned label is to an internal object with the same lifetime as the containing LowLevelILFunction. :param Architecture arch: :param int addr: IL Address label to retrieve diff --git a/python/mediumlevelil.py b/python/mediumlevelil.py index ba604aae..18e0f718 100644 --- a/python/mediumlevelil.py +++ b/python/mediumlevelil.py @@ -5903,6 +5903,7 @@ class MediumLevelILFunction: """ ``prepare_to_copy_function`` sets up state in this MLIL function in preparation of copying instructions from ``src`` + It enables use of :py:func:`get_label_for_source_instruction` during function transformation. :param MediumLevelILFunction src: function about to be copied from """ @@ -5912,6 +5913,7 @@ class MediumLevelILFunction: """ ``prepare_to_copy_block`` sets up state when copying a function in preparation of copying the instructions from the block ``src`` + It enables use of :py:func:`get_label_for_source_instruction` during function transformation. :param MediumLevelILBasicBlock src: block about to be copied from """ @@ -5919,8 +5921,14 @@ class MediumLevelILFunction: def get_label_for_source_instruction(self, i: InstructionIndex) -> Optional['MediumLevelILLabel']: """ - Get the MediumLevelILLabel for a given source instruction. The returned label is to an internal object with - the same lifetime as the containing MediumLevelILFunction. + Get the MediumLevelILLabel for a given source instruction. The source instruction must be + at the start of a basic block in the source function passed to :py:func:`prepare_to_copy_function`. + The label will be marked resolved when its source block is passed to :py:func:`prepare_to_copy_block`. + + .. warning:: The instruction index parameter for this pertains to the *source function* + passed to `prepare_to_copy_function`, not the current function. + + .. note:: The returned label is to an internal object with the same lifetime as the containing MediumLevelILFunction. :param i: The source instruction index :return: The MediumLevelILLabel for the source instruction |