com.oracle.svm.core.stack

Class JavaStackWalker

java.lang.Object

com.oracle.svm.core.stack.JavaStackWalker

public final class JavaStackWalker
extends Object

Applies a StackFrameVisitor to each of the Java frames in a thread stack. It skips native frames, i.e., it only visits frames where Java frame information is available.

The stack walking code is allocation free (so that it can be used during garbage collection) and stateless (so that multiple threads can walk their stacks concurrently).

Method Summary

Modifier and Type	Method and Description
static boolean	continueWalk(JavaStackWalk walk) Continue a started stack walk.
static boolean	initWalk(JavaStackWalk walk, org.graalvm.nativeimage.IsolateThread thread) Initialize a stack walk for the given thread.
static boolean	initWalk(JavaStackWalk walk, org.graalvm.word.Pointer startSP, org.graalvm.nativeimage.c.function.CodePointer startIP) Initialize a stack walk for the current thread.
static boolean	walkCurrentThread(org.graalvm.word.Pointer startSP, org.graalvm.nativeimage.c.function.CodePointer startIP, StackFrameVisitor visitor)
static boolean	walkThread(org.graalvm.nativeimage.IsolateThread thread, StackFrameVisitor visitor)

Methods inherited from class java.lang.Object

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

Method Detail

initWalk

public static boolean initWalk(JavaStackWalk walk,
                               org.graalvm.word.Pointer startSP,
                               org.graalvm.nativeimage.c.function.CodePointer startIP)

Initialize a stack walk for the current thread. The given walk parameter should normally be allocated on the stack.

The stack walker is only valid while the stack being walked is stable and existent.

Parameters:

walk - the stack-allocated walk base pointer

startSP - the starting SP

startIP - the starting IP

initWalk

public static boolean initWalk(JavaStackWalk walk,
                               org.graalvm.nativeimage.IsolateThread thread)

Initialize a stack walk for the given thread. The given walk parameter should normally be allocated on the stack.

Parameters:

walk - the stack-allocated walk base pointer

thread - the thread to examine

continueWalk

public static boolean continueWalk(JavaStackWalk walk)

Continue a started stack walk. This method must only be called after JavaStackWalker.initWalk(com.oracle.svm.core.stack.JavaStackWalk, org.graalvm.word.Pointer, org.graalvm.nativeimage.c.function.CodePointer) was called to start the walk. Once this method returns false, it will always return false.

Parameters:

walk - the initiated stack walk pointer

Returns:

true if there is another frame, or false if there are no more frames to iterate

walkCurrentThread

public static boolean walkCurrentThread(org.graalvm.word.Pointer startSP,
                                        org.graalvm.nativeimage.c.function.CodePointer startIP,
                                        StackFrameVisitor visitor)

walkThread

public static boolean walkThread(org.graalvm.nativeimage.IsolateThread thread,
                                 StackFrameVisitor visitor)