com.oracle.svm.core.c.function

Class CEntryPointActions

java.lang.Object

com.oracle.svm.core.c.function.CEntryPointActions

public final class CEntryPointActions
extends Object

Advanced entry and leave actions for entry point methods annotated with CEntryPoint. These methods are an alternative to automatically entering and leaving a context that is passed as a parameter, and they also enable creating an isolate or attaching a method on demand. The methods of this class must be called from the prologue or epilogue code of the entry point, or, if the entry point method is annotated with Uninterruptible, from that method itself.

See Also:

CEntryPointSetup

Method Summary

Modifier and Type	Method and Description
static void	bailoutInPrologue() In the prologue, stop execution and return to the entry point method's caller.
static void	bailoutInPrologue(boolean value) In the prologue, stop execution and return to the entry point method's caller with the given return value.
static void	bailoutInPrologue(double value) In the prologue, stop execution and return to the entry point method's caller with the given return value.
static void	bailoutInPrologue(long value) In the prologue, stop execution and return to the entry point method's caller with the given return value.
static void	bailoutInPrologue(org.graalvm.word.WordBase value) In the prologue, stop execution and return to the entry point method's caller with the given return value.
static int	enter(org.graalvm.nativeimage.IsolateThread thread) Enters an existing context for the current thread (for example, one created with CEntryPointActions.enterAttachThread(org.graalvm.nativeimage.Isolate, boolean)).
static int	enterAttachThread(org.graalvm.nativeimage.Isolate isolate, boolean ensureJavaThread) Creates a context for the current thread in the specified existing isolate, then enters that context.
static int	enterCreateIsolate(CEntryPointCreateIsolateParameters params) Creates a new isolate, then attaches the current thread to the created isolate, creating a context for the thread in the isolate, and then enters that context before returning.
static int	enterIsolate(org.graalvm.nativeimage.Isolate isolate) Enters an existing context for the current thread that has already been created in the given isolate.
static int	enterIsolateFromCrashHandler(org.graalvm.nativeimage.Isolate isolate) Enters an existing context for the current thread that has already been created in the given isolate, during the prologue of a segfault handler.
static void	failFatally(int code, org.graalvm.nativeimage.c.type.CCharPointer message) Fail in a fatal manner, such as by terminating the executing process.
static boolean	isCurrentThreadAttachedTo(org.graalvm.nativeimage.Isolate isolate)
static int	leave() Leaves the current thread's current context.
static int	leaveDetachThread() Leaves the current thread's current context, then discards that context.
static int	leaveTearDownIsolate() Leaves the current thread's current context, then waits for all attached threads in the context's isolate to detach and discards that isolate entirely.

Methods inherited from class java.lang.Object

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

Method Detail

enterCreateIsolate

public static int enterCreateIsolate(CEntryPointCreateIsolateParameters params)

Creates a new isolate, then attaches the current thread to the created isolate, creating a context for the thread in the isolate, and then enters that context before returning.

Parameters:

params - initialization parameters.

Returns:

0 on success, otherwise non-zero.

enterAttachThread

public static int enterAttachThread(org.graalvm.nativeimage.Isolate isolate,
                                    boolean ensureJavaThread)

Creates a context for the current thread in the specified existing isolate, then enters that context. If the thread has already been attached, this does not cause the operation to fail.

Parameters:

isolate - an existing isolate.

ensureJavaThread - when set to true, the method ensures that the Thread object for the newly attached thread is created. If the parameter is set to false, a later call to one of the JavaThreads.ensureJavaThread() methods early after the prologue must be used to do the initialization manually.

Returns:

0 on success, otherwise non-zero.

enter

public static int enter(org.graalvm.nativeimage.IsolateThread thread)

Enters an existing context for the current thread (for example, one created with CEntryPointActions.enterAttachThread(org.graalvm.nativeimage.Isolate, boolean)).

Parameters:

thread - existing context for the current thread.

Returns:

0 on success, otherwise non-zero.

enterIsolate

public static int enterIsolate(org.graalvm.nativeimage.Isolate isolate)

Enters an existing context for the current thread that has already been created in the given isolate.

Parameters:

isolate - isolate in which a context for the current thread exists.

Returns:

0 on success, otherwise non-zero.

enterIsolateFromCrashHandler

public static int enterIsolateFromCrashHandler(org.graalvm.nativeimage.Isolate isolate)

Enters an existing context for the current thread that has already been created in the given isolate, during the prologue of a segfault handler. Execution is not expected to resume normally from the thread.

Parameters:

isolate - isolate in which a context for the current thread exists.

Returns:

0 on success, otherwise non-zero.

bailoutInPrologue

public static void bailoutInPrologue(org.graalvm.word.WordBase value)

In the prologue, stop execution and return to the entry point method's caller with the given return value. The passed word is cast to the entry point method's return type, which must be a WordBase type.

bailoutInPrologue

public static void bailoutInPrologue(long value)

In the prologue, stop execution and return to the entry point method's caller with the given return value. The passed integer is narrowed to the entry point method's return type, which must be one of long, int, short, char, or byte.

bailoutInPrologue

public static void bailoutInPrologue(double value)

In the prologue, stop execution and return to the entry point method's caller with the given return value. The entry point method's return type must be double, or can also be float, in which case a cast is applied.

bailoutInPrologue

public static void bailoutInPrologue(boolean value)

In the prologue, stop execution and return to the entry point method's caller with the given return value. The entry point method's return type must be boolean.

bailoutInPrologue

public static void bailoutInPrologue()

In the prologue, stop execution and return to the entry point method's caller. The entry point method's return type must be void.

leave

public static int leave()

Leaves the current thread's current context.

Returns:

0 on success, otherwise non-zero.

leaveDetachThread

public static int leaveDetachThread()

Leaves the current thread's current context, then discards that context.

Returns:

0 on success, otherwise non-zero.

leaveTearDownIsolate

public static int leaveTearDownIsolate()

Leaves the current thread's current context, then waits for all attached threads in the context's isolate to detach and discards that isolate entirely.

Returns:

0 on success, otherwise non-zero.

failFatally

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

Fail in a fatal manner, such as by terminating the executing process. This method is intended for situations in which recovery is not possible, or in which reporting a severe error in any other way is not possible. This method does not return.

Parameters:

code - An integer representing the cause (should be non-zero by convention).

message - A message describing the cause (may be omitted by passing null).

isCurrentThreadAttachedTo

public static boolean isCurrentThreadAttachedTo(org.graalvm.nativeimage.Isolate isolate)

Returns:

whether the current thread is attached to the specified isolate.