com.oracle.svm.core.graal.snippets

Class CEntryPointSnippets

java.lang.Object

org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates

com.oracle.svm.core.graal.snippets.SubstrateTemplates

com.oracle.svm.core.graal.snippets.CEntryPointSnippets

All Implemented Interfaces:

org.graalvm.compiler.api.replacements.SnippetTemplateCache, org.graalvm.compiler.replacements.Snippets

public final class CEntryPointSnippets
extends SubstrateTemplates
implements org.graalvm.compiler.replacements.Snippets

Snippets for calling from C to Java. See CEntryPointActions and CEntryPointNativeFunctions for descriptions of the different ways of entering Java, and later returning to C. This class is the inverse of CFunctionSnippets. This code transitions thread states, handles when a safepoint is in progress, sets the thread register (if multi-threaded), and sets the heap base register (if enabled).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CEntryPointSnippets.EnterLowering
protected class	CEntryPointSnippets.LeaveLowering
protected class	CEntryPointSnippets.UtilityLowering

Field Summary

Fields

Modifier and Type	Field and Description
static SnippetRuntime.SubstrateForeignCallDescriptor	ATTACH_THREAD
static SnippetRuntime.SubstrateForeignCallDescriptor	CREATE_ISOLATE
static SnippetRuntime.SubstrateForeignCallDescriptor	DETACH_THREAD_MT
static SnippetRuntime.SubstrateForeignCallDescriptor	ENSURE_JAVA_THREAD
static SnippetRuntime.SubstrateForeignCallDescriptor	ENTER_ISOLATE_MT
static SnippetRuntime.SubstrateForeignCallDescriptor	FAIL_FATALLY
static SnippetRuntime.SubstrateForeignCallDescriptor[]	FOREIGN_CALLS
static SnippetRuntime.SubstrateForeignCallDescriptor	INITIALIZE_ISOLATE
static SnippetRuntime.SubstrateForeignCallDescriptor	IS_ATTACHED_MT
static SnippetRuntime.SubstrateForeignCallDescriptor	REPORT_EXCEPTION
static SnippetRuntime.SubstrateForeignCallDescriptor	TEAR_DOWN_ISOLATE
static SnippetRuntime.SubstrateForeignCallDescriptor	VERIFY_ISOLATE_THREAD

Fields inherited from class org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates

factories, options, providers, snippetReflection, target

Method Summary

Modifier and Type	Method and Description
static int	attachThreadSnippet(org.graalvm.nativeimage.Isolate isolate, boolean ensureJavaThread, int vmThreadSize)
static int	createIsolateSnippet(CEntryPointCreateIsolateParameters parameters, int vmThreadSize)
static int	detachThreadSnippet()
static int	enterIsolateSnippet(org.graalvm.nativeimage.Isolate isolate)
static int	enterSnippet(org.graalvm.nativeimage.IsolateThread thread)
static void	failFatallySnippet(int code, org.graalvm.nativeimage.c.type.CCharPointer message)
static boolean	isAttachedSnippet(org.graalvm.nativeimage.Isolate isolate)
static boolean	isIsolateInitialized()
static void	registerForeignCalls(RuntimeConfiguration runtimeConfig, org.graalvm.compiler.phases.util.Providers providers, org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflection, Map<SnippetRuntime.SubstrateForeignCallDescriptor,SubstrateForeignCallLinkage> foreignCalls, boolean hosted)
static void	registerLowerings(org.graalvm.compiler.options.OptionValues options, Iterable<org.graalvm.compiler.debug.DebugHandlersFactory> factories, org.graalvm.compiler.phases.util.Providers providers, org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflection, int vmThreadSize, Map<Class<? extends org.graalvm.compiler.graph.Node>,NodeLoweringProvider<?>> lowerings)
static int	reportExceptionSnippet(Throwable exception)
static int	returnFromJavaToCSnippet()
static int	runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, CEntryPointCreateIsolateParameters parameters, int vmThreadSize)
static int	runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, org.graalvm.nativeimage.Isolate isolate)
static int	runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, org.graalvm.nativeimage.Isolate isolate, int vmThreadSize)
static int	runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, org.graalvm.nativeimage.IsolateThread thread)
static int	runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, Throwable exception)
static void	runtimeCallEnsureJavaThread(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)
static void	runtimeCallFailFatally(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, int code, org.graalvm.nativeimage.c.type.CCharPointer message)
static int	runtimeCallInitializeIsolate(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)
static boolean	runtimeCallIsAttached(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor, org.graalvm.nativeimage.Isolate isolate)
static int	runtimeCallTearDownIsolate(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)
static void	setHeapBase(org.graalvm.word.PointerBase heapBase)
static int	tearDownIsolateSnippet()

Methods inherited from class com.oracle.svm.core.graal.snippets.SubstrateTemplates

snippet, snippet, snippet, snippet

Methods inherited from class org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates

findMethod, findMethod, getProviders, snippet, template

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_ISOLATE

public static final SnippetRuntime.SubstrateForeignCallDescriptor CREATE_ISOLATE

INITIALIZE_ISOLATE

public static final SnippetRuntime.SubstrateForeignCallDescriptor INITIALIZE_ISOLATE

ATTACH_THREAD

public static final SnippetRuntime.SubstrateForeignCallDescriptor ATTACH_THREAD

ENSURE_JAVA_THREAD

public static final SnippetRuntime.SubstrateForeignCallDescriptor ENSURE_JAVA_THREAD

ENTER_ISOLATE_MT

public static final SnippetRuntime.SubstrateForeignCallDescriptor ENTER_ISOLATE_MT

DETACH_THREAD_MT

public static final SnippetRuntime.SubstrateForeignCallDescriptor DETACH_THREAD_MT

REPORT_EXCEPTION

public static final SnippetRuntime.SubstrateForeignCallDescriptor REPORT_EXCEPTION

TEAR_DOWN_ISOLATE

public static final SnippetRuntime.SubstrateForeignCallDescriptor TEAR_DOWN_ISOLATE

IS_ATTACHED_MT

public static final SnippetRuntime.SubstrateForeignCallDescriptor IS_ATTACHED_MT

FAIL_FATALLY

public static final SnippetRuntime.SubstrateForeignCallDescriptor FAIL_FATALLY

VERIFY_ISOLATE_THREAD

public static final SnippetRuntime.SubstrateForeignCallDescriptor VERIFY_ISOLATE_THREAD

FOREIGN_CALLS

public static final SnippetRuntime.SubstrateForeignCallDescriptor[] FOREIGN_CALLS

Method Detail

runtimeCall

public static int runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                              CEntryPointCreateIsolateParameters parameters,
                              int vmThreadSize)

runtimeCall

public static int runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                              org.graalvm.nativeimage.Isolate isolate,
                              int vmThreadSize)

runtimeCall

public static int runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                              org.graalvm.nativeimage.Isolate isolate)

runtimeCall

public static int runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                              org.graalvm.nativeimage.IsolateThread thread)

runtimeCall

public static int runtimeCall(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                              Throwable exception)

runtimeCallInitializeIsolate

public static int runtimeCallInitializeIsolate(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)

runtimeCallTearDownIsolate

public static int runtimeCallTearDownIsolate(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)

runtimeCallIsAttached

public static boolean runtimeCallIsAttached(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                                            org.graalvm.nativeimage.Isolate isolate)

runtimeCallFailFatally

public static void runtimeCallFailFatally(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor,
                                          int code,
                                          org.graalvm.nativeimage.c.type.CCharPointer message)

setHeapBase

public static void setHeapBase(org.graalvm.word.PointerBase heapBase)

createIsolateSnippet

public static int createIsolateSnippet(CEntryPointCreateIsolateParameters parameters,
                                       int vmThreadSize)

isIsolateInitialized

public static boolean isIsolateInitialized()

attachThreadSnippet

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

runtimeCallEnsureJavaThread

public static void runtimeCallEnsureJavaThread(org.graalvm.compiler.core.common.spi.ForeignCallDescriptor descriptor)

detachThreadSnippet

public static int detachThreadSnippet()

tearDownIsolateSnippet

public static int tearDownIsolateSnippet()

enterIsolateSnippet

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

enterSnippet

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

reportExceptionSnippet

public static int reportExceptionSnippet(Throwable exception)

returnFromJavaToCSnippet

public static int returnFromJavaToCSnippet()

isAttachedSnippet

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

failFatallySnippet

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

registerForeignCalls

public static void registerForeignCalls(RuntimeConfiguration runtimeConfig,
                                        org.graalvm.compiler.phases.util.Providers providers,
                                        org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflection,
                                        Map<SnippetRuntime.SubstrateForeignCallDescriptor,SubstrateForeignCallLinkage> foreignCalls,
                                        boolean hosted)

registerLowerings

public static void registerLowerings(org.graalvm.compiler.options.OptionValues options,
                                     Iterable<org.graalvm.compiler.debug.DebugHandlersFactory> factories,
                                     org.graalvm.compiler.phases.util.Providers providers,
                                     org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflection,
                                     int vmThreadSize,
                                     Map<Class<? extends org.graalvm.compiler.graph.Node>,NodeLoweringProvider<?>> lowerings)