com.oracle.svm.core.c.function

Annotation Type CEntryPointOptions

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface CEntryPointOptions

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	epilogue Specifies a class with epilogue code that is executed when the entry point method returns to C in order to leave the execution context.
Class<? extends BooleanSupplier>	include If the supplier returns true, this entry point is added automatically when building a shared library.
Class<? extends Function<String,String>>	nameTransformation A function that is passed the name provided with CEntryPoint.name() and returns another string that will be used for the entry point's symbol name.
Class<?>	prologue Specifies a class with prologue code that is executed when the entry point method is called from C in order to establish an execution context.
CEntryPointOptions.Publish	publishAs

Element Detail

nameTransformation

public abstract Class<? extends Function<String,String>> nameTransformation

A function that is passed the name provided with CEntryPoint.name() and returns another string that will be used for the entry point's symbol name. A common use is to add prefixes or suffixes to entry point symbol names. When CEntryPoint.name() is not set, the function is passed a string that contains the mangled class and method names.

Default:

com.oracle.svm.core.c.function.CEntryPointOptions.DefaultNameTransformation.class

include

public abstract Class<? extends BooleanSupplier> include

If the supplier returns true, this entry point is added automatically when building a shared library. This means the method is a root method for compilation, and everything reachable from it is compiled too. The provided class must have a nullary constructor, which is used to instantiate the class. Then the supplier function is called on the newly instantiated instance.

Default:

com.oracle.svm.core.c.function.CEntryPointOptions.AlwaysIncluded.class

prologue

public abstract Class<?> prologue

Specifies a class with prologue code that is executed when the entry point method is called from C in order to establish an execution context. See CEntryPointOptions.AutomaticPrologue for the default behavior and CEntryPointSetup for commonly used prologues.

The given class must have exactly one static method with parameters that are a subsequence of the entry point method's parameters. In other words, individual parameters may be omitted, but must be in the same order. The entry point method's parameters are matched to the prologue method's parameters. The prologue method must then use CEntryPointActions for establishing the execution context.

Default:

com.oracle.svm.core.c.function.CEntryPointOptions.AutomaticPrologue.class

epilogue

public abstract Class<?> epilogue

Specifies a class with epilogue code that is executed when the entry point method returns to C in order to leave the execution context. See CEntryPointSetup for commonly used epilogues.

The given class must have exactly one static method with no parameters that must use the CEntryPointActions methods to leave the execution context.

Default:

com.oracle.svm.core.c.function.CEntryPointSetup.LeaveEpilogue.class

publishAs

public abstract CEntryPointOptions.Publish publishAs

Default:

com.oracle.svm.core.c.function.CEntryPointOptions.Publish.SymbolAndHeader