com.oracle.svm.core.thread

Class VMThreads

java.lang.Object

com.oracle.svm.core.thread.VMThreads

Direct Known Subclasses:

PosixVMThreads, WindowsVMThreads

public abstract class VMThreads
extends Object

Utility methods for the manipulation and iteration of IsolateThreads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VMThreads.StatusSupport A thread-local enum giving the thread status of a VMThread.

Field Summary

Fields

Modifier and Type	Field and Description
static FastThreadLocalWord<org.graalvm.nativeimage.Isolate>	IsolateTL
static VMCondition	THREAD_LIST_CONDITION A condition variable for waiting for and notifying on changes to the IsolateThread list.
static VMMutex	THREAD_MUTEX A mutex for operations on IsolateThreads.

Constructor Summary

Constructors

Constructor and Description
VMThreads()

Method Summary

Modifier and Type	Method and Description
abstract org.graalvm.nativeimage.IsolateThread	allocateIsolateThread(int isolateThreadSize) Allocate native memory for a IsolateThread.
void	attachThread(org.graalvm.nativeimage.IsolateThread thread) Creates a new IsolateThread and adds it to the list of running threads.
static void	detachThread(org.graalvm.nativeimage.IsolateThread current) Remove a IsolateThread from the list of VMThreads.
static void	detachThreads(org.graalvm.nativeimage.IsolateThread[] threads)
static boolean	ensureInitialized() Make sure the runtime is initialized for threading.
abstract void	failFatally(int code, org.graalvm.nativeimage.c.type.CCharPointer message) Report a fatal error to the user and exit.
org.graalvm.nativeimage.IsolateThread	findIsolateThreadforCurrentOSThread()
static org.graalvm.nativeimage.IsolateThread	firstThread() Iteration of all IsolateThreads that are currently running.
abstract void	freeIsolateThread(org.graalvm.nativeimage.IsolateThread thread) Free the native memorry allocated by VMThreads.allocateIsolateThread(int).
protected abstract org.graalvm.word.ComparableWord	getCurrentOSThreadId()
protected abstract boolean	initializeOnce() Invoked exactly once early during the startup of an isolate.
static boolean	isInitialized()
static boolean	isNonNullThread(org.graalvm.nativeimage.IsolateThread vmThread) A predicate for the non-null IsolateThread.
static boolean	isNullThread(org.graalvm.nativeimage.IsolateThread vmThread) A predicate for the null IsolateThread.
static boolean	isTearingDown() Is threading being torn down?
static org.graalvm.nativeimage.IsolateThread	nextThread(org.graalvm.nativeimage.IsolateThread cur) Iteration of all IsolateThreads that are currently running.
static org.graalvm.nativeimage.IsolateThread	nullThread() The value of a null IsolateThread.
protected static void	setTearingDown() Note that threading is being torn down.
static VMThreads	singleton()

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_MUTEX

public static final VMMutex THREAD_MUTEX

A mutex for operations on IsolateThreads.

THREAD_LIST_CONDITION

public static final VMCondition THREAD_LIST_CONDITION

A condition variable for waiting for and notifying on changes to the IsolateThread list.

IsolateTL

public static final FastThreadLocalWord<org.graalvm.nativeimage.Isolate> IsolateTL

Constructor Detail

VMThreads

public VMThreads()

Method Detail

singleton

public static VMThreads singleton()

isInitialized

public static boolean isInitialized()

isTearingDown

public static boolean isTearingDown()

Is threading being torn down?

setTearingDown

protected static void setTearingDown()

Note that threading is being torn down.

ensureInitialized

public static boolean ensureInitialized()

Make sure the runtime is initialized for threading.

initializeOnce

protected abstract boolean initializeOnce()

Invoked exactly once early during the startup of an isolate. Subclasses can perform initialization of native OS resources.

allocateIsolateThread

public abstract org.graalvm.nativeimage.IsolateThread allocateIsolateThread(int isolateThreadSize)

Allocate native memory for a IsolateThread. The returned memory must be initialized to 0.

freeIsolateThread

public abstract void freeIsolateThread(org.graalvm.nativeimage.IsolateThread thread)

Free the native memorry allocated by VMThreads.allocateIsolateThread(int).

failFatally

public abstract void failFatally(int code,
                                 org.graalvm.nativeimage.c.type.CCharPointer message)

Report a fatal error to the user and exit. This method must not return.

nullThread

public static org.graalvm.nativeimage.IsolateThread nullThread()

The value of a null IsolateThread.

isNullThread

public static boolean isNullThread(org.graalvm.nativeimage.IsolateThread vmThread)

A predicate for the null IsolateThread.

isNonNullThread

public static boolean isNonNullThread(org.graalvm.nativeimage.IsolateThread vmThread)

A predicate for the non-null IsolateThread.

firstThread

public static org.graalvm.nativeimage.IsolateThread firstThread()

Iteration of all IsolateThreads that are currently running. VMThreads.THREAD_MUTEX should be held when iterating the list. Use the following pattern to iterate all running threads. It is allocation free and can therefore be used during GC:

 for (VMThread thread = VMThreads.firstThread(); VMThreads.isNonNullThread(thread); thread = VMThreads.nextThread(thread)) {
 

nextThread

public static org.graalvm.nativeimage.IsolateThread nextThread(org.graalvm.nativeimage.IsolateThread cur)

Iteration of all IsolateThreads that are currently running. See VMThreads.firstThread() for details.

attachThread

public void attachThread(org.graalvm.nativeimage.IsolateThread thread)

Creates a new IsolateThread and adds it to the list of running threads. This method must be the first method called in every thread.

detachThread

public static void detachThread(org.graalvm.nativeimage.IsolateThread current)

Remove a IsolateThread from the list of VMThreads. This method must be the last method called in every thread.

detachThreads

public static void detachThreads(org.graalvm.nativeimage.IsolateThread[] threads)

getCurrentOSThreadId

protected abstract org.graalvm.word.ComparableWord getCurrentOSThreadId()

findIsolateThreadforCurrentOSThread

public org.graalvm.nativeimage.IsolateThread findIsolateThreadforCurrentOSThread()