Package com.oracle.truffle.api

Class TruffleStackTraceElement

java.lang.Object

com.oracle.truffle.api.TruffleStackTraceElement

public final class TruffleStackTraceElement
extends Object

Represents a guest stack trace element.

Since:

0.27

Method Summary

Modifier and Type	Method	Description
static TruffleStackTraceElement	create(Node location, RootCallTarget target, Frame frame)	Create a new stack trace element.
static TruffleStackTraceElement	create(Node location, RootCallTarget target, Frame frame, int bytecodeIndex)	Create a new stack trace element.
int	getBytecodeIndex()	Returns the bytecode index at the time when this frame was created.
Frame	getFrame()	Returns the read-only frame.
Object	getGuestObject()	Returns an interop object representing this TruffleStackTraceElement supporting the hasExecutableName and potentially hasDeclaringMetaObject and hasSourceLocation messages.
Node	getLocation()	Returns a node representing the callsite on the stack.
RootCallTarget	getTarget()	Returns the call target on the stack.
boolean	hasBytecodeIndex()	Returns true if the stack trace element contains a valid bytecode index, else false.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

create

public static TruffleStackTraceElement create(Node location,
 RootCallTarget target,
 Frame frame)

Create a new stack trace element.

Parameters:

location - See getLocation()

target - See getTarget()

frame - See getFrame()

Since:

20.1.0

create

public static TruffleStackTraceElement create(Node location,
 RootCallTarget target,
 Frame frame,
 int bytecodeIndex)

Create a new stack trace element.

Parameters:

location - See getLocation()

target - See getTarget()

frame - See getFrame()

bytecodeIndex - See getBytecodeIndex()

Since:

24.1

getLocation

public Node getLocation()

Returns a node representing the callsite on the stack.

Returns null if no detailed callsite information is available. This is the case when CallTarget.call(Object...) is used or for the top-of-the-stack element or if the exception is an internal exception or the AbstractTruffleException.getLocation() returned null.

See FrameInstance.getCallNode() for the relation between callsite and CallTarget.

Since:

0.27

getTarget

public RootCallTarget getTarget()

Returns the call target on the stack. Never returns null.

See FrameInstance.getCallNode() for the relation between callsite and CallTarget.

Since:

0.27

getFrame

public Frame getFrame()

Returns the read-only frame. Returns null if the initial RootNode that filled in the stack trace did not request frames to be captured by overriding RootNode.isCaptureFramesForTrace(Node).

Since:

0.31

hasBytecodeIndex

public boolean hasBytecodeIndex()

Returns true if the stack trace element contains a valid bytecode index, else false. If this method returns false then getBytecodeIndex() will return a negative int value.

Since:

24.1

getBytecodeIndex

public int getBytecodeIndex()

Returns the bytecode index at the time when this frame was created. If no bytecode index was captured then a negative int value is returned. When the stack trace element is captured RootNode.findBytecodeIndex(com.oracle.truffle.api.nodes.Node, com.oracle.truffle.api.frame.Frame) is invoked to resolve the byte code index returned by this method.

Since:

24.1

See Also:

• RootNode.findBytecodeIndex(com.oracle.truffle.api.nodes.Node, com.oracle.truffle.api.frame.Frame)

getGuestObject

public Object getGuestObject()

Returns an interop object representing this TruffleStackTraceElement supporting the hasExecutableName and potentially hasDeclaringMetaObject and hasSourceLocation messages.

This method must only be called on an interpreter thread with a valid entered. The current entered context can be accessed through the language or instrument environment.

Since:

20.3

toString

public String toString()

Overrides:

toString in class Object

Since:

24.0