Package ghidra.program.model.lang

Class InjectPayloadSleigh

java.lang.Object

ghidra.program.model.lang.InjectPayloadSleigh

All Implemented Interfaces:

InjectPayload

Direct Known Subclasses:

InjectPayloadCallfixup, InjectPayloadCallother

public class InjectPayloadSleigh
extends java.lang.Object
implements InjectPayload

InjectPayloadSleigh defines an InjectPayload of p-code which is defined via a String passed to the sleigh compiler

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.program.model.lang.InjectPayload

InjectPayload.InjectParameter

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	name
protected java.lang.String	source
protected int	type

Fields inherited from interface ghidra.program.model.lang.InjectPayload

CALLFIXUP_TYPE, CALLMECHANISM_TYPE, CALLOTHERFIXUP_TYPE, EXECUTABLEPCODE_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InjectPayloadSleigh(java.lang.String sourceName)	Constructor for use where restoreXml is overridden and provides name and type
	InjectPayloadSleigh(java.lang.String nm, int tp, java.lang.String sourceName)	Provide basic form, restoreXml fills in the rest

Method Summary

Modifier and Type	Method	Description
InjectPayloadSleigh	clone()
protected void	copy(InjectPayloadSleigh op2)
InjectPayload.InjectParameter[]	getInput()
java.lang.String	getName()
InjectPayload.InjectParameter[]	getOutput()
int	getParamShift()
PcodeOp[]	getPcode(Program program, InjectContext con)	A convenience function wrapping the inject method, to produce the final set of PcodeOp objects in an array
java.lang.String	getSource()
int	getType()
void	inject(InjectContext context, PcodeEmit emit)	Given a context, send the p-code payload to the emitter
boolean	isFallThru()
protected void	orderParameters()	All input and output parameters must have a unique index.
void	restoreXml(XmlPullParser parser)
protected void	setInputParameters(java.util.ArrayList<InjectPayload.InjectParameter> in)
protected void	setOutputParameters(java.util.ArrayList<InjectPayload.InjectParameter> out)
void	setTemplate(ConstructTpl ctl)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected java.lang.String name

type

protected int type

source

protected java.lang.String source

Constructor Detail

InjectPayloadSleigh

protected InjectPayloadSleigh(java.lang.String sourceName)

Constructor for use where restoreXml is overridden and provides name and type

Parameters:

sourceName -

InjectPayloadSleigh

public InjectPayloadSleigh(java.lang.String nm,
                           int tp,
                           java.lang.String sourceName)

Provide basic form, restoreXml fills in the rest

Parameters:

nm - must provide formal name

tp - must provide type

sourceName -

Method Detail

clone

public InjectPayloadSleigh clone()

Overrides:

clone in class java.lang.Object

copy

protected void copy(InjectPayloadSleigh op2)

getName

public java.lang.String getName()

Specified by:

getName in interface InjectPayload

Returns:

formal name for this injection

getType

public int getType()

Specified by:

getType in interface InjectPayload

Returns:

the type of this injection: CALLFIXUP_TYPE, CALLMECHANISM_TYPE, etc.

getSource

public java.lang.String getSource()

Specified by:

getSource in interface InjectPayload

Returns:

a String describing the source of this payload

getParamShift

public int getParamShift()

Specified by:

getParamShift in interface InjectPayload

Returns:

number of parameters from the original call which should be truncated

setInputParameters

protected void setInputParameters(java.util.ArrayList<InjectPayload.InjectParameter> in)

setOutputParameters

protected void setOutputParameters(java.util.ArrayList<InjectPayload.InjectParameter> out)

getInput

public InjectPayload.InjectParameter[] getInput()

Specified by:

getInput in interface InjectPayload

Returns:

array of any input parameters for this inject

getOutput

public InjectPayload.InjectParameter[] getOutput()

Specified by:

getOutput in interface InjectPayload

Returns:

array of any output parameters for this inject

inject

public void inject(InjectContext context,
                   PcodeEmit emit)

Description copied from interface: InjectPayload

Given a context, send the p-code payload to the emitter

Specified by:

inject in interface InjectPayload

Parameters:

context - is the context for injection

emit - is the object accumulating the final p-code

getPcode

public PcodeOp[] getPcode(Program program,
                          InjectContext con)

Description copied from interface: InjectPayload

A convenience function wrapping the inject method, to produce the final set of PcodeOp objects in an array

Specified by:

getPcode in interface InjectPayload

Parameters:

program - is the Program for which injection is happening

con - is the context for injection

Returns:

the array of PcodeOps

isFallThru

public boolean isFallThru()

Specified by:

isFallThru in interface InjectPayload

Returns:

true if the injected p-code falls thru

orderParameters

protected void orderParameters()

All input and output parameters must have a unique index. Order them so that inputs come first, then outputs

restoreXml

public void restoreXml(XmlPullParser parser)

setTemplate

public void setTemplate(ConstructTpl ctl)