Package ghidra.trace.model.stack

Interface TraceStackFrame

All Superinterfaces:

TraceObjectInterface

All Known Implementing Classes:

DBTraceStackFrame

public interface TraceStackFrame
extends TraceObjectInterface

A frame in a TraceStack

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_PC

Fields inherited from interface ghidra.trace.model.target.iface.TraceObjectInterface

KEY_COMMENT, KEY_DISPLAY, KEY_KIND, KEY_MODIFIED, KEY_ORDER, KEY_SHORT_DISPLAY, KEY_TYPE, KEY_VALUE

Method Summary

Modifier and Type	Method	Description
String	getComment(long snap)	Get the user comment for the frame
int	getLevel()	Get the frame's position in the containing stack
Address	getProgramCounter(long snap)	Get the program counter at the given snap
TraceStack	getStack()	Get the containing stack
Trace	getTrace()	Get the trace containing this frame
void	setComment(long snap, String comment)	Set the user comment for the frame
void	setProgramCounter(Lifespan span, Address pc)	Set the program counter over the given span

Methods inherited from interface ghidra.trace.model.target.iface.TraceObjectInterface

getObject

Field Details

KEY_PC

static final String KEY_PC

See Also:

• Constant Field Values

Method Details

getTrace

Trace getTrace()

Get the trace containing this frame

Returns:

the trace

getStack

TraceStack getStack()

Get the containing stack

Returns:

the stack

getLevel

int getLevel()

Get the frame's position in the containing stack

0 represents the innermost frame or top of the stack.

Returns:

the frame's level

getProgramCounter

Address getProgramCounter(long snap)

Get the program counter at the given snap

Parameters:

snap - the snap (only relevant in the experimental objects mode. Ordinarily, the PC is fixed over the containing stack's lifetime)

Returns:

the program counter

setProgramCounter

void setProgramCounter(Lifespan span,
 Address pc)

Set the program counter over the given span

Parameters:

span - the span (only relevant in the experimental objects mode. Ordinarily, the PC is fixed over the containing stack's lifetime)

pc - the program counter

getComment

String getComment(long snap)

Get the user comment for the frame

In the experimental objects mode, this actually gets the comment in the listing at the frame's program counter for the given snap.

Parameters:

snap - the snap (only relevant in the experimental objects mode)

Returns:

the (nullable) comment

setComment

void setComment(long snap,
 String comment)

Set the user comment for the frame

In the experimental objects mode, this actually sets the comment in the listing at the frame's program counter for the given snap.

Parameters:

snap - the snap (only relevant in the experimental objects mode)

comment - the (nullable) comment