Package ghidra.pcode.exec

Interface SleighPcodeUseropDefinition<T>

Type Parameters:

T - no type in particular, except to match any executor

All Superinterfaces:

PcodeUseropLibrary.PcodeUseropDefinition<T>

All Known Implementing Classes:

AbstractSleighPcodeUseropDefinition, FixedSleighPcodeUseropDefinition, OverloadedSleighPcodeUseropDefinition

public interface SleighPcodeUseropDefinition<T>
extends PcodeUseropLibrary.PcodeUseropDefinition<T>

A p-code userop defined using Sleigh source

Nested Class Summary

Nested Classes

Change	Modifier and Type	Interface	Description
	static interface	SleighPcodeUseropDefinition.BodyFunc	A function body, as it depends on the given arguments
	static interface	SleighPcodeUseropDefinition.BuilderStage1	Stage one of the builder, where any operation is allowed
	static interface	SleighPcodeUseropDefinition.BuilderStage2	Stage two of the builder, where parameters can no longer be added
	static class	SleighPcodeUseropDefinition.Factory	A factory for building SleighPcodeUseropDefinitions.
	static final record	SleighPcodeUseropDefinition.SignatureDef	One definition for a userop for a given signature (parameters, including output)

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	static final List<Varnode>	EMPTY_ARGS
	static final String	OUT_SYMBOL_NAME	The name of the output symbol

Method Summary

Change	Modifier and Type	Method	Description
	default String	getBody(Varnode... args)	Get the Sleigh source that defines this userop
	String	getBody(List<Varnode> args)	Get the Sleigh source that defines this userop
	PcodeProgram	programFor(List<Varnode> args, PcodeUseropLibrary<?> library)	Get the p-code program implementing this userop for the given arguments and library.
REMOVED	String	getName()	Removed
REMOVED	int	getInputCount()	Removed
REMOVED	List<String>	getInputs()	Removed
REMOVED	String	getBody()	Removed
REMOVED	boolean	isFunctional()	Removed
REMOVED	boolean	hasSideEffects()	Removed
REMOVED	boolean	modifiesContext()	Removed
REMOVED	boolean	canInlinePcode()	Removed
REMOVED	Class<?>	getOutputType()	Removed
REMOVED	Method	getJavaMethod()	Removed
REMOVED	PcodeUseropLibrary<T>	getDefiningLibrary()	Removed

Methods inherited from interface ghidra.pcode.exec.PcodeUseropLibrary.PcodeUseropDefinition

canInlinePcode, execute, execute, getDefiningLibrary, getInputCount, getJavaMethod, getName, getOutputType, hasSideEffects, isFunctional, modifiesContext

Field Details

OUT_SYMBOL_NAME

static final String OUT_SYMBOL_NAME

The name of the output symbol

See Also:

• Constant Field Values

EMPTY_ARGS NEW

static final List<Varnode> EMPTY_ARGS

Method Details

getBody

String getBody(List<Varnode> args)

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

getBody

default String getBody(Varnode... args)

Get the Sleigh source that defines this userop

Parameters:

args - the argument varnodes

Returns:

the body

See Also:

• getBody(List)

programFor

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

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:

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