Define formal link between stack-pointer values before and after sub-function calls. More...
#include <coreaction.hh>
Public Member Functions | |
| ActionExtraPopSetup (const string &g, AddrSpace *ss) | |
| Constructor. | |
| virtual Action * | clone (const ActionGroupList &grouplist) const |
| Clone the Action. More... | |
| virtual int4 | apply (Funcdata &data) |
| Make a single attempt to apply this Action. More... | |
 Public Member Functions inherited from ghidra::Action | |
| Action (uint4 f, const string &nm, const string &g) | |
| Base constructor for an Action. More... | |
| virtual | ~Action (void) |
| Destructor. | |
| virtual void | printStatistics (ostream &s) const |
| Dump statistics to stream. More... | |
| int4 | perform (Funcdata &data) |
| Perform this action (if necessary) More... | |
| bool | setBreakPoint (uint4 tp, const string &specify) |
| Set a breakpoint on this action. More... | |
| virtual void | clearBreakPoints (void) |
| Clear all breakpoints set on this Action. | |
| bool | setWarning (bool val, const string &specify) |
| Set a warning on this action. More... | |
| bool | disableRule (const string &specify) |
| Disable a specific Rule within this. More... | |
| bool | enableRule (const string &specify) |
| Enable a specific Rule within this. More... | |
| const string & | getName (void) const |
| Get the Action's name. | |
| const string & | getGroup (void) const |
| Get the Action's group. | |
| uint4 | getStatus (void) const |
| Get the current status of this Action. | |
| uint4 | getNumTests (void) |
| Get the number of times apply() was invoked. | |
| uint4 | getNumApply (void) |
| virtual void | reset (Funcdata &data) |
| Reset the Action for a new function. More... | |
| virtual void | resetStats (void) |
| Reset all the counts to zero. More... | |
| virtual int4 | print (ostream &s, int4 num, int4 depth) const |
| Print a description of this Action to stream. More... | |
| virtual void | printState (ostream &s) const |
| Print status to stream. More... | |
| virtual Action * | getSubAction (const string &specify) |
| Retrieve a specific sub-action by name. More... | |
| virtual Rule * | getSubRule (const string &specify) |
| Retrieve a specific sub-rule by name. More... | |
Private Attributes | |
| AddrSpace * | stackspace |
| The stack space to analyze. | |
Additional Inherited Members | |
| Public Types inherited from ghidra::Action | |
| enum | ruleflags { rule_repeatapply = 4, rule_onceperfunc = 8, rule_oneactperfunc = 16, rule_debug = 32, rule_warnings_on = 64, rule_warnings_given = 128 } |
| Boolean behavior properties governing this particular Action. More... | |
| enum | statusflags { status_start =1, status_breakstarthit =2, status_repeat =4, status_mid =8, status_end =16, status_actionbreak =32 } |
| Boolean properties describing the status of an action. More... | |
| enum | breakflags { break_start = 1, tmpbreak_start = 2, break_action = 4, tmpbreak_action = 8 } |
| Break points associated with an Action. More... | |
| Protected Member Functions inherited from ghidra::Action | |
| void | issueWarning (Architecture *glb) |
| Warn that this Action has applied. More... | |
| bool | checkStartBreak (void) |
| Check start breakpoint. More... | |
| bool | checkActionBreak (void) |
| Check action breakpoint. More... | |
| void | turnOnWarnings (void) |
| Enable warnings for this Action. | |
| void | turnOffWarnings (void) |
| Disable warnings for this Action. | |
| Protected Attributes inherited from ghidra::Action | |
| int4 | lcount |
| Changes not including last call to apply() | |
| int4 | count |
| Number of changes made by this action so far. | |
| uint4 | status |
| Current status. | |
| uint4 | breakpoint |
| Breakpoint properties. | |
| uint4 | flags |
| Behavior properties. | |
| uint4 | count_tests |
| Number of times apply() has been called. | |
| uint4 | count_apply |
| Number of times apply() made changes. | |
| string | name |
| Name of the action. | |
| string | basegroup |
| Base group this action belongs to. | |
Detailed Description
Define formal link between stack-pointer values before and after sub-function calls.
Change to the stack-pointer across a sub-function is called extrapop. This class makes sure there is p-code relationship between the Varnode coming into a sub-function and the Varnode coming out. If the extrapop is known, the p-code will be a CPUI_COPY or CPUI_ADD. If it is unknown, a CPUI_INDIRECT will be inserted that gets filled in by ActionStackPtrFlow.
Member Function Documentation
◆ apply()
|
virtual |
Make a single attempt to apply this Action.
This is the main entry point for applying changes to a function that are specific to this Action. The method can inspect whatever it wants to decide if the Action does or does not apply. Changes are indicated by incrementing the count field.
- Parameters
-
data is the function to inspect/modify
- Returns
- 0 for a complete application, -1 for a partial completion (due to breakpoint)
Implements ghidra::Action.
References ghidra::CPUI_INDIRECT, ghidra::CPUI_INT_ADD, ghidra::ProtoModel::extrapop_unknown, ghidra::PcodeOp::getAddr(), ghidra::Funcdata::getCallSpecs(), ghidra::FuncProto::getExtraPop(), ghidra::FuncCallSpecs::getOp(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newVarnode(), ghidra::Funcdata::newVarnodeIop(), ghidra::Funcdata::newVarnodeOut(), ghidra::Funcdata::numCalls(), ghidra::Funcdata::opInsertAfter(), ghidra::Funcdata::opInsertBefore(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), and ghidra::FuncCallSpecs::setEffectiveExtraPop().
◆ clone()
|
inlinevirtual |
Clone the Action.
If this Action is a member of one of the groups in the grouplist, this returns a clone of the Action, otherwise NULL is returned.
- Parameters
-
grouplist is the list of groups being cloned
- Returns
- the cloned Action or NULL
Implements ghidra::Action.
References ghidra::ActionStart::apply(), ghidra::ActionGroupList::contains(), and ghidra::Action::getGroup().
The documentation for this class was generated from the following files:
- coreaction.hh
- coreaction.cc
