com.oracle.svm.core.stack

Class StackFrameVisitor

java.lang.Object

com.oracle.svm.core.stack.ParameterizedStackFrameVisitor<Void>

com.oracle.svm.core.stack.StackFrameVisitor

Direct Known Subclasses:

JavaStackFrameVisitor, PathExhibitor.FrameVisitor

public abstract class StackFrameVisitor
extends ParameterizedStackFrameVisitor<Void>

Given access to a thread stack frame, perform some computation on it.

Constructor Summary

Constructors

Constructor and Description
StackFrameVisitor()

Method Summary

Modifier and Type	Method and Description
protected boolean	unknownFrame(org.graalvm.word.Pointer sp, org.graalvm.nativeimage.c.function.CodePointer ip, DeoptimizedFrame deoptimizedFrame, Void data) Called when no frame metadata can be found for a frame.
protected abstract boolean	visitFrame(org.graalvm.word.Pointer sp, org.graalvm.nativeimage.c.function.CodePointer ip, CodeInfo codeInfo, DeoptimizedFrame deoptimizedFrame) Called for each frame that is visited.
protected boolean	visitFrame(org.graalvm.word.Pointer sp, org.graalvm.nativeimage.c.function.CodePointer ip, CodeInfo codeInfo, DeoptimizedFrame deoptimizedFrame, Void data) Called for each frame that is visited.

Methods inherited from class java.lang.Object

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

Constructor Detail

StackFrameVisitor

public StackFrameVisitor()

Method Detail

visitFrame

protected abstract boolean visitFrame(org.graalvm.word.Pointer sp,
                                      org.graalvm.nativeimage.c.function.CodePointer ip,
                                      CodeInfo codeInfo,
                                      DeoptimizedFrame deoptimizedFrame)

Called for each frame that is visited. Note that unless this method is annotated with Uninterruptible or executing within a safepoint, the frame on the stack could be deoptimized at any safepoint check. Nevertheless, the passed codeInfo remains valid for accessing information about the code at the (possibly outdated) instruction pointer (this is ensured by the caller).

Parameters:

sp - The stack pointer of the frame being visited.

ip - The instruction pointer of the frame being visited.

codeInfo - Information on the code at the IP, for use with CodeInfoAccess.

deoptimizedFrame - The information about a deoptimized frame, or null if the frame is not deoptimized.

Returns:

true if visiting should continue, false otherwise.

visitFrame

protected final boolean visitFrame(org.graalvm.word.Pointer sp,
                                   org.graalvm.nativeimage.c.function.CodePointer ip,
                                   CodeInfo codeInfo,
                                   DeoptimizedFrame deoptimizedFrame,
                                   Void data)

Description copied from class: ParameterizedStackFrameVisitor

Called for each frame that is visited. Note that unless this method is annotated with Uninterruptible or executing within a safepoint, the frame on the stack could be deoptimized at any safepoint check. Nevertheless, the passed codeInfo remains valid for accessing information about the code at the (possibly outdated) instruction pointer (this is ensured by the caller).

Specified by:

visitFrame in class ParameterizedStackFrameVisitor<Void>

Parameters:

sp - The stack pointer of the frame being visited.

ip - The instruction pointer of the frame being visited.

codeInfo - Information on the code at the IP, for use with CodeInfoAccess.

deoptimizedFrame - The information about a deoptimized frame, or null if the frame is not deoptimized.

data - An arbitrary data value passed through the stack walker.

Returns:

true if visiting should continue, false otherwise.

unknownFrame

protected final boolean unknownFrame(org.graalvm.word.Pointer sp,
                                     org.graalvm.nativeimage.c.function.CodePointer ip,
                                     DeoptimizedFrame deoptimizedFrame,
                                     Void data)

Description copied from class: ParameterizedStackFrameVisitor

Called when no frame metadata can be found for a frame. That usually means that the VM is in an inconsistent state. The default implementation therefore aborts VM execution with a fatal error. Stack walking for diagnostic purposes can override this method to just report a message.

Specified by:

unknownFrame in class ParameterizedStackFrameVisitor<Void>

Parameters:

sp - The stack pointer of the frame being visited.

ip - The instruction pointer of the frame being visited.

deoptimizedFrame - The information about a deoptimized frame, or null if the frame is not deoptimized.

data - An arbitrary data value passed through the stack walker.

Returns:

The value returned to the caller of stack walking. Note that walking of the thread is always aborted, regardless of the return value.