Class PcodeProgram

java.lang.Object

ghidra.pcode.exec.PcodeProgram

Direct Known Subclasses:

JitControlFlowModel.JitBlock, JitPassage, PcodeExpression

public class PcodeProgram
extends Object

A p-code program to be executed by a PcodeExecutor

This is a list of p-code operations together with a map of expected userops.

Nested Class Summary

Nested Classes

Change	Modifier and Type	Class	Description
	protected static class	PcodeProgram.MyAppender
	protected static class	PcodeProgram.MyFormatter

Field Summary

Fields

Change	Modifier and Type	Field	Description
	protected final List<PcodeOp>	code
	protected final SleighLanguage	language
	protected final PcodeUseropLibrary.PcodeUseropSymbolMap	userops
REMOVED		useropNames()	Removed

Constructor Summary

Constructors

Change	Modifier	Constructor	Description
	protected	PcodeProgram(SleighLanguage language, List<PcodeOp> code, PcodeUseropLibrary.PcodeUseropSymbolMap userops)	Construct a p-code program with the given bindings
		PcodeProgram(PcodeProgram program, List<PcodeOp> code)	Construct a p-code program from a derivative of the given one

Method Summary

Change	Modifier and Type	Method	Description
	<T> void	execute(PcodeExecutor<T> executor, PcodeUseropLibrary<T> library)	Execute this program using the given executor and library
	String	format()	For display purposes, list the code without op numbers
	String	format(boolean numberOps)	For display purposes, list the code
	static PcodeProgram	fromInject(Program program, String name, int type)	Generate a p-code program from a given program's inject library
	static PcodeProgram	fromInstruction(Instruction instruction)	Generate a p-code program from the given instruction, without overrides
	static PcodeProgram	fromInstruction(Instruction instruction, boolean includeOverrides)	Generate a p-code program from the given instruction
	List<PcodeOp>	getCode()	Returns the p-code ops of this program.
	protected String	getHead()	For display purposes, get the header above the frame, usually the class name
	SleighLanguage	getLanguage()	Get the language generating this program
	String	getUseropName(int opNo)	Get the name of a userop by number
	int	getUseropNumber(String name)	Get the userop index for a given name
	String	toString()

Methods inherited from class Object

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

Field Details

language

protected final SleighLanguage language

code

protected final List<PcodeOp> code

userops NEW

protected final PcodeUseropLibrary.PcodeUseropSymbolMap userops

Constructor Details

PcodeProgram

protected PcodeProgram(SleighLanguage language,
 List<PcodeOp> code,
 PcodeUseropLibrary.PcodeUseropSymbolMap userops)

Construct a p-code program with the given bindings

Parameters:

language - the language that generated the p-code

code - the list of p-code ops

userops - a map of expected userop symbols

PcodeProgram

public PcodeProgram(PcodeProgram program,
 List<PcodeOp> code)

Construct a p-code program from a derivative of the given one

Parameters:

program - the original program

code - the code portion for this program

Method Details

fromInstruction

public static PcodeProgram fromInstruction(Instruction instruction)

Generate a p-code program from the given instruction, without overrides

Parameters:

instruction - the instruction

Returns:

the p-code program

fromInstruction

public static PcodeProgram fromInstruction(Instruction instruction,
 boolean includeOverrides)

Generate a p-code program from the given instruction

Parameters:

instruction - the instruction

includeOverrides - as in Instruction.getPcode(boolean)

Returns:

the p-code program

fromInject

public static PcodeProgram fromInject(Program program,
 String name,
 int type)
                               throws MemoryAccessException,
UnknownInstructionException,
NotFoundException,
IOException

Generate a p-code program from a given program's inject library

Parameters:

program - the program

name - the name of the snippet

type - the type of the snippet

Returns:

the p-code program

Throws:

MemoryAccessException - for problems establishing the injection context

IOException - for problems while emitting the injection p-code

UnknownInstructionException - if there is no underlying instruction being injected

NotFoundException - if an expected aspect of the injection is not present in context

getLanguage

public SleighLanguage getLanguage()

Get the language generating this program

Returns:

the language

getCode

public List<PcodeOp> getCode()

Returns the p-code ops of this program.

Returns:

the p-code ops of this program

execute

public <T> void execute(PcodeExecutor<T> executor,
 PcodeUseropLibrary<T> library)

Execute this program using the given executor and library

Type Parameters:

T - the type of values to be operated on

Parameters:

executor - the executor

library - the library

getHead

protected String getHead()

For display purposes, get the header above the frame, usually the class name

Returns:

the frame's display header

toString

public String toString()

Overrides:

toString in class Object

format

public String format(boolean numberOps)

For display purposes, list the code

Parameters:

numberOps - true to include op numbers

Returns:

the formatted listing

format

public String format()

For display purposes, list the code without op numbers

Returns:

the formatted listing

getUseropName

public String getUseropName(int opNo)

Get the name of a userop by number

Parameters:

opNo - the userop number

Returns:

the name

getUseropNumber

public int getUseropNumber(String name)

Get the userop index for a given name

Parameters:

name - the name

Returns:

the index, or -1 if not found