Ghidra Decompiler Analysis Engine
Public Member Functions | Protected Member Functions | List of all members
PcodeInjectLibrarySleigh Class Reference
Inheritance diagram for PcodeInjectLibrarySleigh:
Inheritance graph
[legend]
Collaboration diagram for PcodeInjectLibrarySleigh:
Collaboration graph
[legend]

Public Member Functions

 PcodeInjectLibrarySleigh (Architecture *g, uintb tmpbase)
 
virtual void restoreDebug (const Element *el)
 A method for reading in p-code generated externally for use in debugging. More...
 
virtual int4 manualCallFixup (const string &name, const string &snippetstring)
 Manually add a call-fixup payload given a compilable snippet of p-code source. More...
 
virtual int4 manualCallOtherFixup (const string &name, const string &outname, const vector< string > &inname, const string &snippet)
 Manually add a callother-fixup payload given a compilable snippet of p-code source. More...
 
virtual InjectContextgetCachedContext (void)
 Retrieve a reusable context object for this library. More...
 
virtual const vector< OpBehavior * > & getBehaviors (void)
 Get the array of op-code behaviors for initializing and emulator. More...
 
- Public Member Functions inherited from PcodeInjectLibrary
virtual ~PcodeInjectLibrary (void)
 Destructor.
 
int4 getPayloadId (int4 type, const string &nm) const
 Map name and type to the payload id. More...
 
string getCallFixupName (int4 injectid) const
 Get the call-fixup name associated with an id. More...
 
string getCallOtherTarget (int4 injectid) const
 Get the callother-fixup name associated with an id. More...
 
string getCallMechanismName (int4 injectid) const
 Get the call mechanism name associated with an id. More...
 
int4 restoreXmlInject (const string &src, const string &nm, int4 tp, const Element *el)
 Read in and register an injection payload from an XML stream. More...
 

Protected Member Functions

virtual int4 allocateInject (const string &sourceName, const string &name, int4 type)
 Allocate a new InjectPayload object. More...
 
virtual void registerInject (int4 injectid)
 Finalize a payload within the library, once the payload is initialized. More...
 
- Protected Member Functions inherited from PcodeInjectLibrary
void registerCallFixup (const string &fixupName, int4 injectid)
 Map a call-fixup name to a payload id. More...
 
void registerCallOtherFixup (const string &fixupName, int4 injectid)
 Map a callother-fixup name to a payload id. More...
 
void registerCallMechanism (const string &fixupName, int4 injectid)
 Map a call mechanism name to a payload id. More...
 
void registerExeScript (const string &scriptName, int4 injectid)
 Map a p-code script name to a payload id. More...
 

Additional Inherited Members

- Protected Attributes inherited from PcodeInjectLibrary
Architectureglb
 The Architecture to which the injection payloads apply.
 
uintb tempbase
 Offset within unique space for allocating temporaries within a payload.
 
vector< InjectPayload * > injection
 Registered injections.
 
map< string, int4 > callFixupMap
 Map of registered call-fixup names to injection id.
 
map< string, int4 > callOtherFixupMap
 Map of registered callother-fixup names to injection id.
 
map< string, int4 > callMechFixupMap
 Map of registered mechanism names to injection id.
 
map< string, int4 > scriptMap
 Map of registered script names to ExecutablePcode id.
 
vector< string > callFixupNames
 Map from injectid to call-fixup name.
 
vector< string > callOtherTarget
 Map from injectid to callother-fixup target-op name.
 
vector< string > callMechTarget
 Map from injectid to call-mech name.
 
vector< string > scriptNames
 Map from injectid to script name.
 

Member Function Documentation

◆ allocateInject()

int4 PcodeInjectLibrarySleigh::allocateInject ( const string &  sourceName,
const string &  name,
int4  type 
)
protectedvirtual

Allocate a new InjectPayload object.

This acts as an InjectPayload factory. The formal name and type of the payload are given, this library allocates a new object that fits with its storage scheme and returns the id.

Parameters
sourceNameis a string describing the source of the new payload
nameis the formal name of the payload
typeis the formal type (CALLFIXUP_TYPE, CALLOTHERFIXUP_TYPE, etc.) of the payload
Returns
the id associated with the new InjectPayload object

Implements PcodeInjectLibrary.

◆ getBehaviors()

const vector< OpBehavior * > & PcodeInjectLibrarySleigh::getBehaviors ( void  )
virtual

Get the array of op-code behaviors for initializing and emulator.

Behaviors are pulled from the underlying architecture in order to initialize the Emulate object which services the p-code script payloads.

Returns
the array of OpBehavior objects indexed by op-code

Implements PcodeInjectLibrary.

◆ getCachedContext()

virtual InjectContext& PcodeInjectLibrarySleigh::getCachedContext ( void  )
inlinevirtual

Retrieve a reusable context object for this library.

The object returned by this method gets passed to the payload inject() method. The clear() method must be called between uses.

Returns
the cached context object

Implements PcodeInjectLibrary.

◆ manualCallFixup()

int4 PcodeInjectLibrarySleigh::manualCallFixup ( const string &  name,
const string &  snippetstring 
)
virtual

Manually add a call-fixup payload given a compilable snippet of p-code source.

The snippet is compiled immediately to produce the payload.

Parameters
nameis the formal name of the new payload
snippetstringis the compilable snippet of p-code source
Returns
the id of the new payload

Implements PcodeInjectLibrary.

◆ manualCallOtherFixup()

int4 PcodeInjectLibrarySleigh::manualCallOtherFixup ( const string &  name,
const string &  outname,
const vector< string > &  inname,
const string &  snippet 
)
virtual

Manually add a callother-fixup payload given a compilable snippet of p-code source.

The snippet is compiled immediately to produce the payload. Symbol names for input and output parameters must be provided to the compiler.

Parameters
nameis the formal name of the new payload
outnameis the name of the output symbol
innameis the ordered list of input symbol names
snippetis the compilable snippet of p-code source
Returns
the id of the new payload

Implements PcodeInjectLibrary.

◆ registerInject()

void PcodeInjectLibrarySleigh::registerInject ( int4  injectid)
protectedvirtual

Finalize a payload within the library, once the payload is initialized.

This provides the derived class the opportunity to add the payload name to the symbol tables or do anything else it needs to once the InjectPayload object has been fully initialized.

Parameters
injectidis the id of the InjectPayload to finalize

Implements PcodeInjectLibrary.

◆ restoreDebug()

void PcodeInjectLibrarySleigh::restoreDebug ( const Element el)
virtual

A method for reading in p-code generated externally for use in debugging.

Instantiate a special InjectPayloadDynamic object initialized with an <injectdebug> tag. Within the library, this replaces the original InjectPayload, allowing its p-code to be replayed for debugging purposes.

Parameters
elis the <injectdebug> element

Reimplemented from PcodeInjectLibrary.


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