Package ghidra.test.processors.support

Class EmulatorTestRunner

java.lang.Object

ghidra.test.processors.support.EmulatorTestRunner

public class EmulatorTestRunner
extends Object

Nested Class Summary

Nested Classes

Change	Modifier and Type	Class	Description
	static enum	EmulatorTestRunner.DumpFormat

Constructor Summary

Constructors

Change	Constructor	Description
	EmulatorTestRunner(Program program, PCodeTestGroup testGroup, ExecutionListener executionListener)

Method Summary

Change	Modifier and Type	Method	Description
	void	addDumpPoint(Address breakAddr, Address dumpAddr, int dumpSize, int elementSize, EmulatorTestRunner.DumpFormat elementFormat, String comment)	Add memory dump point
	void	addDumpPoint(Address breakAddr, Register dumpAddrReg, int relativeOffset, AddressSpace dumpAddrSpace, int dumpSize, int elementSize, EmulatorTestRunner.DumpFormat elementFormat, String comment)	Add memory dump point
	void	dispose()
NEW	boolean	execute(int timeLimitMS)	Execute test group without instruction stepping/tracing
	boolean	executeSingleStep(int stepLimit)
	int	getCallOtherErrors()	Get number of CALLOTHER errors detected when a test pass was registered.
	Address	getCurrentAddress()
	Instruction	getCurrentInstruction()
	String	getEmuError()
NEW	PcodeThread<byte[]>	getEmulatorThread()
	Program	getProgram()
	RegisterValue	getRegisterValue(Register reg)
	String	getRegisterValueString(Register reg)
	PCodeTestGroup	getTestGroup()
NEW	boolean	runToBreakpoint()	Allows the emulator to run until it's interrupted, returning true if the interrupt is caused by a breakpoint.
	void	setContextRegister(RegisterValue ctxRegValue)
	void	setRegister(String regName, long value)
	void	setRegister(String regName, BigInteger value)
NEW	boolean	stepIgnoreBreakpoints()	Step the emulator one instruction, returning true if it's completed without interruption.
REMOVED	EmulatorHelper	getEmulatorHelper()	Removed
REMOVED	boolean	execute(int timeLimitMS, TaskMonitor monitor)	Removed

Methods inherited from class java.lang.Object

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

Constructor Details

EmulatorTestRunner

public EmulatorTestRunner(Program program,
 PCodeTestGroup testGroup,
 ExecutionListener executionListener)

Method Details

dispose

public void dispose()

getTestGroup

public PCodeTestGroup getTestGroup()

getProgram

public Program getProgram()

getEmulatorThread NEW

public PcodeThread<byte[]> getEmulatorThread()

setContextRegister

public void setContextRegister(RegisterValue ctxRegValue)

getCurrentAddress

public Address getCurrentAddress()

getCurrentInstruction

public Instruction getCurrentInstruction()

getRegisterValue

public RegisterValue getRegisterValue(Register reg)

getRegisterValueString

public String getRegisterValueString(Register reg)

setRegister

public void setRegister(String regName,
 long value)

setRegister

public void setRegister(String regName,
 BigInteger value)

addDumpPoint

public void addDumpPoint(Address breakAddr,
 Address dumpAddr,
 int dumpSize,
 int elementSize,
 EmulatorTestRunner.DumpFormat elementFormat,
 String comment)

Add memory dump point

Parameters:

breakAddr - instruction address at which execution should pause (before it is executed) so that the specified memory may be dumped to the log during trace execution mode.

dumpAddr - memory address which should be dumped

dumpSize - number elements which should be dumped

elementSize - size of each element in bytes (be reasonable!)

elementFormat - HEX, DECIMAL or FLOAT

comment - dump comment

addDumpPoint

public void addDumpPoint(Address breakAddr,
 Register dumpAddrReg,
 int relativeOffset,
 AddressSpace dumpAddrSpace,
 int dumpSize,
 int elementSize,
 EmulatorTestRunner.DumpFormat elementFormat,
 String comment)

Add memory dump point

Parameters:

breakAddr - instruction address at which execution should pause (before it is executed) so that the specified memory may be dumped to the log during trace execution mode.

dumpAddrReg - register containing the memory address offset which should be dumped

relativeOffset - dump register relative offset

dumpAddrSpace - address space to which memory offset should be applied

dumpSize - number elements which should be dumped

elementSize - size of each element in bytes (be reasonable!)

elementFormat - HEX, DECIMAL or FLOAT

comment - dump comment

getEmuError

public String getEmuError()

getCallOtherErrors

public int getCallOtherErrors()

Get number of CALLOTHER errors detected when a test pass was registered. This number should be subtracted from the pass count and possibly added to the failure count. Number does not reflect total number of CALLOTHER pcodeops encountered but only the number of passed tests affected. See log for all CALLOTHER executions detected.

Returns:

number of CALLOTHER errors

runToBreakpoint NEW

public boolean runToBreakpoint()

Allows the emulator to run until it's interrupted, returning true if the interrupt is caused by a breakpoint.

Returns:

true if interrupted by a breakpoint, false otherwise. This may also run indefinitely.

stepIgnoreBreakpoints NEW

public boolean stepIgnoreBreakpoints()

Step the emulator one instruction, returning true if it's completed without interruption.

Returns:

true if completed, false if interrupted. Though unlikely, this may also run indefinitely.

execute NEW

public boolean execute(int timeLimitMS)

Execute test group without instruction stepping/tracing

Parameters:

timeLimitMS - the maximum number of milliseconds to execute before suspending and terminating

Returns:

true if execution reached the "done" breakpoint

executeSingleStep

public boolean executeSingleStep(int stepLimit)