Interface SleighPcodeUseropDefinition

All Superinterfaces:

PcodeUseropLibrary.PcodeUseropDefinition<Object>

All Known Implementing Classes:

AbstractSleighPcodeUseropDefinition, FixedSleighPcodeUseropDefinition, OverloadedSleighPcodeUseropDefinition

public interface SleighPcodeUseropDefinition
extends PcodeUseropLibrary.PcodeUseropDefinition<Object>

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 enum	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
	static final List<Varnode>	EMPTY_ARGS	The varnode list containing only one null
	static final SleighPcodeUseropDefinition.Factory	FACTORY	The factory for defining userops with Sleigh
	static final String	OUT_SYMBOL_NAME	The name of the output symbol

Method Summary

Change	Modifier and Type	Method	Description
	default <T> PcodeUseropLibrary.PcodeUseropDefinition<T>	cast()	Cast this Sleigh p-code userop definition to one of the required type
	static SleighPcodeUseropDefinition	cast(PcodeUseropLibrary.PcodeUseropDefinition<?> def)	Cast a userop definition to a Sleigh-defined one
	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(SleighLanguage language, List<Varnode> args, PcodeUseropLibrary<?> library)	Get the p-code program implementing this userop for the given arguments and library.

Methods inherited from interface PcodeUseropLibrary.PcodeUseropDefinition

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

Field Details

FACTORY NEW

static final SleighPcodeUseropDefinition.Factory FACTORY

The factory for defining userops with Sleigh

OUT_SYMBOL_NAME

static final String OUT_SYMBOL_NAME

The name of the output symbol

See Also:

• Constant Field Values

EMPTY_ARGS

static final List<Varnode> EMPTY_ARGS

The varnode list containing only one null

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(SleighLanguage language,
 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:

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

cast NEW

default <T>
PcodeUseropLibrary.PcodeUseropDefinition<T> cast()

Cast this Sleigh p-code userop definition to one of the required type

Type Parameters:

T - the executor's, library's, etc. type

Returns:

this same definition

cast

static SleighPcodeUseropDefinition cast(PcodeUseropLibrary.PcodeUseropDefinition<?> def)

Cast a userop definition to a Sleigh-defined one

For some reason, the usual syntax in Java is forbidden, probably because it's of <T> and not <?>....

Parameters:

def - the userop definition

Returns:

the userop definition, if it is a Sleigh-defined one

Throws:

ClassCastException - if def is not a Sleigh-defined userop