Class FixedSleighPcodeUseropDefinition

java.lang.Object

ghidra.pcode.exec.AbstractSleighPcodeUseropDefinition

ghidra.pcode.exec.FixedSleighPcodeUseropDefinition

All Implemented Interfaces:

PcodeUseropLibrary.PcodeUseropDefinition<Object>, SleighPcodeUseropDefinition

public class FixedSleighPcodeUseropDefinition
extends AbstractSleighPcodeUseropDefinition

A Sleigh userop definition with one signature

Nested Class Summary

Nested classes/interfaces inherited from class AbstractSleighPcodeUseropDefinition

AbstractSleighPcodeUseropDefinition.Builder

Nested classes/interfaces inherited from interface SleighPcodeUseropDefinition

SleighPcodeUseropDefinition.BodyFunc, SleighPcodeUseropDefinition.BuilderStage1, SleighPcodeUseropDefinition.BuilderStage2, SleighPcodeUseropDefinition.Factory, SleighPcodeUseropDefinition.SignatureDef

Field Summary

Fields

Change	Modifier and Type	Field	Description
	protected final SleighPcodeUseropDefinition.SignatureDef	definition

Fields inherited from class AbstractSleighPcodeUseropDefinition

cacheByArgs, name

Fields inherited from interface SleighPcodeUseropDefinition

EMPTY_ARGS, FACTORY, OUT_SYMBOL_NAME

Constructor Summary

Constructors

Change	Modifier	Constructor	Description
	protected	FixedSleighPcodeUseropDefinition(String name, SleighPcodeUseropDefinition.SignatureDef definition)

Method Summary

Change	Modifier and Type	Method	Description
	String	getBody(List<Varnode> args)	Get the Sleigh source that defines this userop
	int	getInputCount()	Get the number of input operands accepted by the userop.
	SleighPcodeUseropDefinition.SignatureDef	getSignatureDef()	Get the single signature and definition
	PcodeProgram	programFor(SleighLanguage language, List<Varnode> args, PcodeUseropLibrary<?> library)	Get the p-code program implementing this userop for the given arguments and library.
REMOVED	Class<?>	getOutputType()	Removed

Methods inherited from class AbstractSleighPcodeUseropDefinition

canInlinePcode, canInterrupt, execute, getDefiningLibrary, getJavaMethod, getName, getOutputType, hasSideEffects, isFunctional, isInSigned, isOutSigned, modifiesContext

Methods inherited from class Object

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

Methods inherited from interface PcodeUseropLibrary.PcodeUseropDefinition

execute

Methods inherited from interface SleighPcodeUseropDefinition

cast, getBody

Field Details

definition

protected final SleighPcodeUseropDefinition.SignatureDef definition

Constructor Details

FixedSleighPcodeUseropDefinition

protected FixedSleighPcodeUseropDefinition(String name,
 SleighPcodeUseropDefinition.SignatureDef definition)

Method Details

getInputCount

public int getInputCount()

Description copied from interface: PcodeUseropLibrary.PcodeUseropDefinition

Get the number of input operands accepted by the userop.

Returns:

the count or -1 if the userop is variadic

getSignatureDef

public SleighPcodeUseropDefinition.SignatureDef getSignatureDef()

Get the single signature and definition

Returns:

the definition

getBody

public String getBody(List<Varnode> args)

Description copied from interface: SleighPcodeUseropDefinition

Get the Sleigh source that defines this userop

The body may or may not actually depend on the arguments. Ideally, it does not, but sometimes the body may vary depending on the sizes of the arguments. In cases where it is known the body is fixed, the args parameter may be null or an empty list. When the arguments are required, index 0 must be the output varnode. If the userop has no output, index 0 may be null.

Parameters:

args - the argument varnodes

Returns:

the body

programFor

public PcodeProgram programFor(SleighLanguage language,
 List<Varnode> args,
 PcodeUseropLibrary<?> library)

Description copied from interface: SleighPcodeUseropDefinition

Get the p-code program implementing this userop for the given arguments and library.

This will compile and cache a program for each new combination of arguments seen.

Parameters:

language - the language of the executor

args - the operands, output at index 0, and inputs following

library - the complete userop library

Returns:

the p-code program to be fed to the same executor as invoked this userop, but in a new frame