Package com.oracle.svm.core.option

Substrate VM re-uses much of the Graal option system for handling its own options.

See: Description

Class Summary

Class	Description
APIOption.Utils
HostedOptionKey<T>	Defines a hosted Option that is used during native image generation, in contrast to a runtime option.
HostedOptionValues	The singleton holder of hosted options.
OptionUtils	This class contains static helper methods related to options.
RuntimeOptionKey<T>	Defines a runtime Option, in contrast to a hosted option.
RuntimeOptionParser	Option parser to be used by an application that runs on Substrate VM.
RuntimeOptionValues	The singleton holder of runtime options.
SubstrateOptionsParser	This class contains methods for parsing options and matching them against OptionDescriptors.
XOptions	A parser for the HotSpot-like memory sizing options "-Xmn", "-Xms", "-Xmx", "-Xss".
XOptions.XFlag	An X flag.

Enum Summary

Enum	Description
APIOption.APIOptionKind	APIOptionKind can be used to customize how an APIOption gets rewritten to its Option counterpart.
SubstrateOptionsParser.BooleanOptionFormat	Constants denoting supported boolean option formats.

Annotation Types Summary

Annotation Type	Description
APIOption	If an Option is additionally annotated with APIOption it will be exposed as native-image option with the given name.
APIOption.List

Package com.oracle.svm.core.option Description

Substrate VM re-uses much of the Graal option system for handling its own options. In the Graal option system, an option is declared as a static final field that is annotated with the annotation Option. Values are stored in OptionValues.

Substrate VM has two distinct kinds of options:

• Hosted options: configure the native image generation, i.e., influence what is put into the image and how the image is built. They are set using the prefix -H: on the command line. Options are defined using fields of the class HostedOptionKey. The option values are maintained by HostedOptionValues. The most convenient access to the value of a hosted option is HostedOptionKey.getValue().

  Hosted options cannot be changed at run time. Instead they are guaranteed to be constant folded in the image. This is implemented using the Fold annotation on HostedOptionKey.getValue().

• Runtime options: get their initial value during native image generation, using the prefix -R: on the command line. Options are defined using fields of the class RuntimeOptionKey. The option values are maintained by RuntimeOptionValues. The most convenient access to the value of a runtime option is RuntimeOptionKey.getValue().

  Runtime options can be changed at run time. RuntimeOptionParser.parse(java.lang.String[], java.lang.String) is a convenient helper to do option parsing at run time.

Substrate VM re-uses much of the Graal option system for handling. However, Graal itself is stateless, i.e, every Graal compilation can be configured with its own set of OptionValues. Therefore, access of a Graal option using OptionKey.getValue(org.graalvm.compiler.options.OptionValues) requires to explicitly specify one of the two option values of Substrate VM: HostedOptionValues.singleton() or RuntimeOptionValues.singleton().