Implement functions from python Function #5378
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Tests being written at: https://github.com/rbran/binaryninja-test mostly on mlil_vars |
|
At least for basic blocks, the UI does the following with highlight colors: |
ElykDeer
added
Component: Architecture
rbran
force-pushed
the
function-functions
branch
2 times, most recently
from
9b7a012 to
7c82a00
Compare
|
I guess it all depends on the |
ElykDeer
requested changes
May 20, 2024
There was a problem hiding this comment.
This is tremendous! Thank you for your work. Just a couple changes requested:
- Rename
VariableDefinitions - Finish implementing
PossibleValueSet(or correct me if I'm wrong) - Squash your commits so there are approx. <=5. (though I do appreciate the small, well described commits, we prefer not to merge too many separate commits at one time...please retain their commit messages when you squash)
Squashed:
add Function::add_tag method
add Function::{add_user_code_ref,remove_user_code_ref} methods
add Function::{add_user_type_field_ref, remove_user_type_field_ref} methods
add Function::{add_user_type_ref, remove_user_type_ref} methods
add Function::apply_auto_discovered_type
add Function/MediumLevelILFunction user_var_values and related functions
simplify UserVariableValues::values_from_variable
cargo fmt fix
fix doc and QualifiedName params
fix MediumLevelILFunction::is_var_user_defined parameter
Remove unecessary Safety comment
add Function::{create_auto_stack_var,delete_auto_stack_var} methods
add MediumLevelILFunction::create_auto_var method
move Function::{create_auto_stack_var,delete_auto_stack_var} methods to MediumLevelILFunction
add MediumLevelILFunction::{create_user_stack_var,delete_user_stack_var} methods
add Function::block_annotations method
add Function::{call_stack_adjustment, call_type_adjustment} method
add Function::{constant_data, constants_referenced_by, constants_referenced_by_address_if_available} methods
add Function::function_tags method
add Function::{indirect_branches, indirect_branches_at} methods
add Function::instr_highlight method
add Function::instruction_containing_address method
add Function::{int_display_type,int_enum_display_typeid,int_display_type_and_typeid} methods
add MediumLevelILFunction::{var_refs, var_refs_from} methods
add Function::{parameter_at, parameter_at_low_level_il_instruction} methods
rebase GAT changes
add Function::{reg_value_at, reg_value_after, reg_value_at_exit} methods
Add alpha to HighlightColor::NoHighlightColor
add Function::{regs_read_by, regs_written_by} methods
add Function::{stack_contents_at, stack_contents_after} methods
add Function::{stack_vars_referenced_by, stack_vars_referenced_by_address_if_available} methods
add Function::{tags_at, tags_at_range} methods
add Function::type_tokens method
add Function::variables method
add Function::{is_call_instruction, is_var_user_defined} methods
add Function::{mark_updates_required, mark_caller_updates_required, mark_recent_use} methods
add Function::{merge_vars, unmerge_vars, split_var, unsplit_var} methods
add Function::reanalyze method
add Function::request_debug_report method
add Function::remove_tag method
add Function::remove_tags_of_type method
add Function::analysis_performance_info method
add Function::call_sites method
add Function::caller_sites method
add Function::{calling_convention, set_calling_convention} methods
add Function::{can_return, set_can_return} methods
add Function::comments method
add Function::{clobbered_regs, set_clobbered_regs} methods
add Function::{has_explicitly_defined_type, has_user_annotations, has_user_type, has_variable_arguments} methods
fix Function::set_can_return_user function
add Function::{high_level_il_if_available, medium_level_il_if_available, low_level_il_if_available, lifted_il_if_available} methods
add Function::{global_pointer_value, has_unresolved_indirect_branches} methods
add Function::lowest_address method
add Function::{inline_during_analysis, set_auto_inline_during_analysis, set_user_inline_during_analysis} methods
add Function::{is_pure, is_too_large, is_update_needed} methods
add Function::{provenance, stack_adjustment, set_user_stack_adjustment, set_auto_stack_adjustment} methods
add Function::{set_user_pure, set_auto_pure} methods
add Function::set_auto_type method
add Function::{return_regs, set_return_regs} methods
add Function::{set_auto_return_type, set_user_return_type} methods
add Function::unresolved_stack_adjustment_graph method
add Function::create_graph method
add Function::tags method
add Function::split_variables method
add Function::{reg_stack_adjustments, set_reg_stack_adjustments} methods
add Function::{mapped_medium_level_il, merged_variables} methods
add Function::{set_auto_instr_highlight, set_user_instr_highlight} methods
add stack_adjustments methods
add Function::set_user_call_stack_adjustment
add Function::set_auto_call_stack_adjustment
add Function::call_type_adjustment
add Function::set_user_call_type_adjustment
add Function::set_auto_call_type_adjustment
add Function::call_reg_stack_adjustment
add Function::set_user_call_reg_stack_adjustment
add Function::set_auto_call_reg_stack_adjustment
add Function::call_reg_stack_adjustment_for_reg_stack
add Function::set_user_call_reg_stack_adjustment_for_reg_stack
add Function::set_auto_call_reg_stack_adjustment_for_reg_stack
add Function::set_user_reg_stack_adjustments
add Function::set_auto_reg_stack_adjustments
add Function::set_auto_reg_stack_adjustments
add Function::set_auto_calling_convention method
add Function::set_auto_can_return method
add Function::{set_user_has_variable_arguments, set_auto_has_variable_arguments} methods
add Function::{set_user_indirect_branches, set_auto_indirect_branches} methods
add Function::set_int_display_type method
add Function::{set_user_parameter_variables, set_auto_parameter_variables} methods
fix documentation
add Function::unresolved_indirect_branches method
add Function::mapped_medium_level_il_if_available method
change methods `Function::{set_user_type, set_auto_type}` to receive `&Type`
merge RegisterList and RegisterSet into CoreRegister impl
fix function names
fix function names
fix documentation syntax
fix documentation syntax
fix Function documentation by adding MediumLevelILInstruction::get_split_var_for_definition
fix documentation links
rename `VariableDefinitions` to `MediumLevelILInstructionList`
fix `PossibleValueSet` switched `NotInSetOfValues` and `ReturnAddressValue`
ElykDeer
approved these changes
May 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
QualifiedNameAndTypetoFunction::add_user_type_refandFunction::remove_user_type_refBNHighlightColor{style: StandardHighlightColor, color: NoHighlightColor, alpha: value, ..zeroed}?RegisterListandRegisterSet, can both be merged? DoesBNFreeRegisterSetjust callsBNFreeRegisterList?Function::set_user_typereceive aTypeparameter, should it be&TypeorRef<Type>instead?int_display_type/int_enum_display_typeidandint_display_type_and_typeid?Implemented:
⭕: Deprecated
🔀: Belongs in other struct
🐍: Pythonism, shold not be part of rust
🟢: Implemented by this PR
🟡: Exists on dev
🔴: Will not implement on this PR
BNAddTagadd_tagadd_tagBNAddAutoFunctionTagadd_tagadd_tagBNAddAutoAddressTagadd_tagadd_tagBNAddUserFunctionTagadd_tagadd_tagBNAddUserAddressTagadd_tagadd_tagBNAddAutoFunctionTagadd_tagadd_tagBNGetFunctionAddressRangesaddress_rangesaddress_rangesBNGetAddressTagReferencestagstagsBNAddUserCodeReferenceadd_user_code_refadd_user_code_refBNAddUserTypeFieldReferenceadd_user_type_field_refadd_user_type_field_refBNAddUserTypeReferenceadd_user_type_refadd_user_type_refBNGetFunctionAnalysisPerformanceInfoanalysis_performance_infoanalysis_performance_infoBNGetFunctionAnalysisSkipOverrideanalysis_skip_overrideanalysis_skip_overrideBNSetFunctionAnalysisSkipOverrideanalysis_skip_overrideset_analysis_skip_overrideBNIsFunctionAnalysisSkippedanalysis_skippedanalysis_skippedBNSetFunctionAnalysisSkipOverrideanalysis_skippedset_analysis_skippedBNSetFunctionAnalysisSkipOverrideset_analysis_skip_overrideset_analysis_skip_overrideBNGetAnalysisSkipReasonanalysis_skip_reasonanalysis_skip_reasonBNApplyAutoDiscoveredFunctionTypeapply_auto_discovered_typeapply_auto_discovered_typeBNApplyImportedTypesapply_imported_typesapply_imported_typesBNGetFunctionArchitecturearcharchBNWasFunctionAutomaticallyDiscoveredautoautoBNGetAutoAddressTagReferencesauto_address_tagsBNGetFunctionBasicBlockListbasic_blocksbasic_blockscalleescallee_addressescallerscaller_sitesBNGetFunctionCallSitescall_sitescall_sitesBNGetFunctionCallingConventioncalling_conventioncalling_conventionBNSetUserFunctionCallingConventioncalling_conventionset_user_calling_conventionBNSetAutoFunctionCallingConventionset_auto_calling_conventionset_auto_calling_conventionBNGetFunctionCallSitescall_sitescall_sitesBNCanFunctionReturncan_returncan_returnBNSetUserFunctionCanReturncan_returnset_user_can_returnBNSetAutoFunctionCanReturnset_auto_can_returnset_auto_can_returnBNGetFunctionClobberedRegistersclobbered_regsclobbered_registersBNSetUserFunctionClobberedRegistersclobbered_regsset_clobbered_registersBNSetUserFunctionClobberedRegistersset_user_clobbered_regsset_user_clobbered_registersBNSetAutoFunctionClobberedRegistersset_auto_clobbered_regsset_auto_clobbered_registersBNGetFunctionCommentcommentcommentBNSetFunctionCommentcommentset_commentBNGetCommentedAddressescommentscommentscomponentsBNGetFunctionVariablescore_varsvariablesBNGetStackLayoutcore_var_stack_layoutstack_layoutBNCreateFunctionGraphcreate_graphcreate_graphBNGetFunctionBasicBlockAtAddressget_basic_block_atbasic_block_containingBNGetFunctionBlockAnnotationsget_block_annotationsblock_annotationsBNGetCallRegisterStackAdjustmentget_call_reg_stack_adjustmentcall_reg_stack_adjustmentBNGetCallRegisterStackAdjustmentForRegisterStackget_call_reg_stack_adjustment_for_reg_stackcall_reg_stack_adjustment_for_reg_stackBNGetCallStackAdjustmentget_call_stack_adjustmentcall_stack_adjustmentBNGetCallTypeAdjustmentget_call_type_adjustmentcall_type_adjustmentBNGetCommentForAddressget_comment_atcomment_atBNGetConstantDataget_constant_dataconstant_dataBNGetConstantsReferencedByInstructionget_constants_referenced_byconstants_referenced_byBNGetConstantsReferencedByInstructionIfAvailableget_constants_referenced_by_address_if_availableconstants_referenced_by_address_if_availableBNGetFlagsReadByLiftedILInstructionget_flags_read_by_lifted_il_instructionBNGetFlagsWrittenByLiftedILInstructionget_flags_written_by_lifted_il_instructionBNGetFunctionTagsOfTypeget_function_tagsfunction_tagsBNGetAutoFunctionTagsOfTypeget_function_tagsfunction_tagsBNGetUserFunctionTagsOfTypeget_function_tagsfunction_tagsBNGetFunctionTagsget_function_tagsfunction_tagsBNGetAutoFunctionTagsget_function_tagsfunction_tagsBNGetUserFunctionTagsget_function_tagsfunction_tagsBNGetHighLevelILVariableReferencesget_hlil_var_refsBNGetHighLevelILVariableReferencesFromget_hlil_var_refs_fromBNGetHighLevelILVariableReferencesInRangeget_hlil_var_refs_fromBNGetIndirectBranchesAtget_indirect_branches_atindirect_branches_atBNGetInstructionHighlightget_instr_highlightinstr_highlightBNGetInstructionContainingAddressget_instruction_containing_addressinstruction_containing_addressBNGetIntegerConstantDisplayTypeget_int_display_typeint_display_typeBNGetIntegerConstantDisplayTypeEnumerationTypeget_int_enum_display_typeidint_enum_display_typeidget_int_display_type_and_typeidint_display_type_and_typeidBNGetLiftedILForInstructionget_lifted_il_atBNGetLiftedILFlagDefinitionsForUseget_lifted_il_flag_definitions_for_useBNGetLiftedILFlagUsesForDefinitionget_lifted_il_flag_uses_for_definitionBNGetLiftedILInstructionsForAddressget_lifted_ils_atget_llil_atBNGetLowLevelILInstructionsForAddressget_llils_atBNGetLowLevelILForInstructionget_low_level_il_atBNGetLowLevelILExitsForInstructionget_low_level_il_exits_atBNGetParameterValueAtInstructionget_parameter_atparameter_atBNGetParameterValueAtLowLevelILInstructionget_parameter_at_low_level_il_instructionparameter_at_low_level_il_instructionBNGetRegistersReadByInstructionget_regs_read_byregisters_read_byBNGetRegistersWrittenByInstructionget_regs_written_byregisters_written_byBNGetRegisterValueAfterInstructionget_reg_value_afterreg_value_afterBNGetRegisterValueAtInstructionget_reg_value_atreg_value_atBNGetFunctionRegisterValueAtExitget_reg_value_at_exitreg_value_at_exitBNGetStackContentsAfterInstructionget_stack_contents_afterstack_contents_afterBNGetStackContentsAtInstructionget_stack_contents_atstack_contents_atBNGetStackVariableAtFrameOffsetget_stack_var_at_frame_offsetstack_var_at_frame_offsetBNGetStackVariablesReferencedByInstructionget_stack_vars_referenced_bystack_variables_referenced_byBNGetStackVariablesReferencedByInstructionIfAvailableget_stack_vars_referenced_by_address_if_availablestack_variables_referenced_by_address_if_availableBNGetAddressTagsget_tags_attags_atBNGetAutoAddressTagsget_tags_attags_atBNGetUserAddressTagsget_tags_attags_atBNGetAddressTagsInRangeget_tags_in_rangetags_in_rangeBNGetAutoAddressTagsInRangeget_tags_in_rangetags_in_rangeBNGetUserAddressTagsInRangeget_tags_in_rangetags_in_rangeBNGetFunctionTypeTokensget_type_tokenstype_tokensget_variable_by_nameBNGetFunctionGlobalPointerValueglobal_pointer_valueglobal_pointer_valueBNFunctionHasExplicitlyDefinedTypehas_explicitly_defined_typehas_explicitly_defined_typeBNHasUnresolvedIndirectBrancheshas_unresolved_indirect_brancheshas_unresolved_indirect_branchesBNFunctionHasUserAnnotationshas_user_annotationshas_user_annotationsBNFunctionHasUserTypehas_user_typehas_user_typeBNFunctionHasVariableArgumentshas_variable_argumentshas_variable_argumentsBNSetUserFunctionHasVariableArgumentshas_variable_argumentsset_user_has_variable_argumentsBNSetAutoFunctionHasVariableArgumentsset_auto_has_variable_argumentsset_auto_has_variable_argumentsBNGetFunctionLowestAddresslowest_addresslowest_addressBNGetFunctionHighestAddresshighest_addresshighest_addressBNGetFunctionLiftedILlifted_illifted_ilBNGetFunctionLiftedILIfAvailablelifted_il_if_availablelifted_il_if_availableBNGetFunctionMediumLevelILmedium_level_ilmedium_level_ilBNGetFunctionMappedMediumLevelILmapped_medium_level_ilmapped_medium_level_ilBNGetFunctionMappedMediumLevelILIfAvailablemmlil_if_availablemapped_medium_level_il_if_availableBNGetFunctionMediumLevelILIfAvailablemlil_if_availablemedium_level_il_if_availableBNGetFunctionHighLevelILhigh_level_ilhigh_level_ilBNGetFunctionHighLevelILIfAvailablehlil_if_availablehigh_level_il_if_availableBNGetIndirectBranchesindirect_branchesindirect_branchesBNIsFunctionInlinedDuringAnalysisinline_during_analysisinline_during_analysisBNSetUserFunctionInlinedDuringAnalysisset_user_inline_during_analysisset_user_inline_during_analysisBNSetAutoFunctionInlinedDuringAnalysisset_auto_inline_during_analysisset_auto_inline_during_analysisinstructionsBNIsCallInstructionis_call_instructionis_call_instructionBNIsFunctionPureis_pureis_pureBNSetUserFunctionPureis_pureset_is_pureis_thunkBNIsVariableUserDefinedis_var_user_definedis_variable_user_definedllil_basic_blocksllil_instructionsBNMarkCallerUpdatesRequiredmark_caller_updates_requiredmark_caller_updates_requiredBNMarkFunctionAsRecentlyUsedmark_recent_usemark_recent_useBNMarkUpdatesRequiredmark_updates_requiredmark_updates_requiredBNGetMergedVariablesmerged_varsmerged_variablesBNMergeVariablesmerge_varsmerge_variablesmlil_basic_blocksmlil_instructionsnameBNIsFunctionUpdateNeededneeds_updateis_update_neededBNGetFunctionParameterVariablesparameter_varsparameter_variablesBNSetUserFunctionParameterVariablesparameter_varsset_user_parameter_variablesBNSetAutoFunctionParameterVariablesset_auto_parameter_varsset_auto_parameter_variablesBNGetFunctionPlatformplatformplatformBNGetProvenanceStringprovenanceprovenanceBNReanalyzeFunctionreanalyzereanalyzeBNGetFunctionRegisterStackAdjustmentsreg_stack_adjustmentsreg_stack_adjustmentsBNSetUserFunctionRegisterStackAdjustmentsreg_stack_adjustmentsset_user_reg_stack_adjustmentsBNSetAutoFunctionRegisterStackAdjustmentsset_auto_reg_stack_adjustmentsset_auto_reg_stack_adjustmentsBNRequestAdvancedFunctionAnalysisDatarelease_advanced_analysis_dataBNReleaseAdvancedFunctionAnalysisDatarequest_advanced_analysis_dataBNRemoveAutoFunctionTagremove_auto_function_tagremove_tagBNRemoveAutoAddressTagremove_auto_address_tagremove_tagBNRemoveUserFunctionTagremove_user_function_tagremove_tagBNRemoveUserAddressTagremove_user_address_tagremove_tagBNRemoveAutoFunctionTagsOfTyperemove_auto_function_tags_of_typeremove_tags_of_typeBNRemoveAutoAddressTagsOfTyperemove_auto_address_tags_of_typeremove_tags_of_typeBNRemoveUserFunctionTagsOfTyperemove_user_function_tags_of_typeremove_tags_of_typeBNRemoveUserAddressTagsOfTyperemove_user_address_tags_of_typeremove_tags_of_typeBNRemoveUserCodeReferenceremove_user_code_refremove_user_code_refBNRemoveUserTypeReferenceremove_user_type_refremove_user_type_refBNRequestFunctionDebugReportrequest_debug_reportrequest_debug_reportBNGetFunctionReturnRegistersreturn_regsreturn_registersBNSetUserFunctionReturnRegistersreturn_regsset_user_return_registersBNSetAutoFunctionReturnRegistersset_auto_return_regsset_auto_return_registersBNGetFunctionReturnTypereturn_typereturn_typeBNSetUserFunctionReturnTypereturn_typeset_user_return_typeBNSetAutoFunctionReturnTypeset_auto_return_typeset_auto_return_typesession_dataset_default_session_dataBNSetAutoFunctionCallingConventionset_auto_calling_conventionset_auto_calling_conventionBNSetAutoCallRegisterStackAdjustmentset_auto_call_reg_stack_adjustmentset_auto_call_reg_stack_adjustmentBNSetAutoCallRegisterStackAdjustmentForRegisterStackset_auto_call_reg_stack_adjustment_for_reg_stackset_auto_call_reg_stack_adjustment_for_reg_stackBNSetAutoCallStackAdjustmentset_auto_call_stack_adjustmentset_auto_call_stack_adjustmentBNSetAutoFunctionCanReturnset_auto_can_returnset_auto_can_returnBNSetAutoFunctionHasVariableArgumentsset_auto_has_variable_argumentsset_auto_has_variable_argumentsBNSetAutoIndirectBranchesset_auto_indirect_branchesset_auto_indirect_branchesBNSetAutoFunctionInlinedDuringAnalysisset_auto_inline_during_analysisset_auto_inline_during_analysisBNSetAutoInstructionHighlightset_auto_instr_highlightset_auto_instr_highlightBNSetAutoFunctionParameterVariablesset_auto_parameter_varsset_auto_parameter_variablesBNSetAutoFunctionPureset_auto_pureset_auto_pureBNSetAutoFunctionRegisterStackAdjustmentsset_auto_reg_stack_adjustmentsset_auto_reg_stack_adjustmentsBNSetAutoFunctionReturnRegistersset_auto_return_regsset_auto_return_regsBNSetAutoFunctionReturnTypeset_auto_return_typeset_auto_return_typeBNSetAutoFunctionStackAdjustmentset_auto_stack_adjustmentset_auto_stack_adjustmentBNSetFunctionAutoTypeset_auto_typeset_auto_typeBNSetUserCallRegisterStackAdjustmentset_call_reg_stack_adjustmentset_user_call_reg_stack_adjustmentBNSetUserCallRegisterStackAdjustmentForRegisterStackset_call_reg_stack_adjustment_for_reg_stackset_user_call_reg_stack_adjustment_for_reg_stackBNSetUserCallStackAdjustmentset_call_stack_adjustmentset_user_call_stack_adjustmentBNSetUserCallTypeAdjustmentset_call_type_adjustmentset_user_call_type_adjustmentBNSetCommentForAddressset_comment_atset_comment_atBNSetIntegerConstantDisplayTypeset_int_display_typeset_int_display_typeBNSetUserIndirectBranchesset_user_indirect_branchesset_user_indirect_branchesBNSetUserFunctionInlinedDuringAnalysisset_user_inline_during_analysisset_user_inline_during_analysisBNSetUserInstructionHighlightset_user_instr_highlightset_user_instr_highlightBNGetSplitVariablessplit_varssplit_variablesBNSplitVariablesplit_varsplit_variableBNGetFunctionStackAdjustmentstack_adjustmentstack_adjustmentBNSetUserFunctionStackAdjustmentstack_adjustmentset_user_stack_adjustmentBNSetAutoFunctionStackAdjustmentset_auto_stack_adjustmentset_auto_stack_adjustmentBNGetStackLayoutstack_layoutstack_layoutBNGetFunctionStartstartstartBNGetFunctionSymbolsymbolsymbolBNGetAddressTagReferencestagstagsBNIsFunctionTooLargetoo_largetoo_largetotal_bytesBNGetFunctionTypetypetypeBNSetFunctionUserTypetypeset_user_typeBNGetFunctionTypeTokenstype_tokenstype_tokensBNUnmergeVariablesunmerge_varsunmerge_variablesBNGetUnresolvedIndirectBranchesunresolved_indirect_branchesunresolved_indirect_branchesBNGetUnresolvedStackAdjustmentGraphunresolved_stack_adjustment_graphunresolved_stack_adjustment_graphBNUnsplitVariableunsplit_varunsplit_variableBNGetUserAddressTagReferencesuser_address_tagsBNGetFunctionVariablesvarsvariablesBNGetFunctionDataviewviewBNGetWorkflowForFunctionworkflowMlil
Some functions belong to the mlil mod, and should not being part of this PR, but I only noticed that after those functions where written...