Ghidra Decompiler Analysis Engine
Public Member Functions | List of all members
ExecutablePcode Class Reference

A snippet of p-code that can be executed outside of normal analysis. More...

#include <pcodeinject.hh>

Inheritance diagram for ExecutablePcode:
Inheritance graph
[legend]
Collaboration diagram for ExecutablePcode:
Collaboration graph
[legend]

Public Member Functions

 ExecutablePcode (Architecture *g, const string &src, const string &nm)
 Constructor. More...
 
virtual string getSource (void) const
 Return a string describing the source of the injection (.cspec, prototype model, etc.)
 
uintb evaluate (const vector< uintb > &input)
 Evaluate the snippet on the given inputs. More...
 
- Public Member Functions inherited from InjectPayload
virtual void inject (InjectContext &context, PcodeEmit &emit) const =0
 
virtual void restoreXml (const Element *el)
 Restore this payload from an XML stream. More...
 
virtual void printTemplate (ostream &s) const =0
 Print the p-code ops of the injection to a stream (for debugging)
 

Additional Inherited Members

- Public Types inherited from InjectPayload
enum  { CALLFIXUP_TYPE = 1, CALLOTHERFIXUP_TYPE = 2, CALLMECHANISM_TYPE = 3, EXECUTABLEPCODE_TYPE = 4 }
 
- Protected Member Functions inherited from InjectPayload
void orderParameters (void)
 Assign an index to parameters. More...
 
- Static Protected Member Functions inherited from InjectPayload
static void readParameter (const Element *el, string &name, uint4 &size)
 Read in an <input> or <output> XML tag describing an injection parameter. More...
 
- Protected Attributes inherited from InjectPayload
string name
 Formal name of the payload.
 
int4 type
 Type of this payload: CALLFIXUP_TYPE, CALLOTHERFIXUP_TYPE, etc.
 
bool dynamic
 True if the injection is generated dynamically.
 
bool incidentalCopy
 True if injected COPYs are considered incidental.
 
int4 paramshift
 Number of parameters shifted in the original call.
 
vector< InjectParameterinputlist
 List of input parameters to this payload.
 
vector< InjectParameteroutput
 List of output parameters.
 

Detailed Description

A snippet of p-code that can be executed outside of normal analysis.

Essentially a p-code script. The p-code contained in this snippet needs to be processor agnostic, so any register Varnodes must be temporary (out of the unique space) and any control-flow operations must be contained within the snippet (p-code relative addressing). Input and output to the snippet/script is provided by standard injection parameters. The class contains, as a field, a stripped down emulator to run the script and a convenience method evaluate() to feed in concrete values to the input parameters and return a value from a single output parameter.

Constructor & Destructor Documentation

◆ ExecutablePcode()

ExecutablePcode::ExecutablePcode ( Architecture g,
const string &  src,
const string &  nm 
)

Constructor.

Parameters
gis the Architecture owning snippet
srcis a string describing the source of the snippet
nmis the formal name of the snippet

Member Function Documentation

◆ evaluate()

uintb ExecutablePcode::evaluate ( const vector< uintb > &  input)

Evaluate the snippet on the given inputs.

The caller provides a list of concrete values that are assigned to the input parameters. The number of values and input parameters must match, and values are assigned in order. Input parameter order is determined either by the order of tags in the defining XML. This method assumes there is exactly 1 relevant output parameter. Once the snippet is executed the value of this parameter is read from the emulator state and returned.

Parameters
inputis the ordered list of input values to feed to this script
Returns
the value of the output parameter after script execution

The documentation for this class was generated from the following files: