com.oracle.svm.core.c

Class CGlobalDataFactory

java.lang.Object

com.oracle.svm.core.c.CGlobalDataFactory

public final class CGlobalDataFactory
extends Object

A factory for pre-allocating and pre-initializing chunks of static global data that are located outside of the heap, or for creating references to symbols. The returned objects can be used to access the data by address at runtime. In order for the data to be actually allocated in the native image, it must be reachable during the static analysis.

All method of this class can only be used at native image build time, and not at run time. It is not possible to extend the data section of an executable or define new symbols in an executable at run time.

Method Summary

Modifier and Type	Method and Description
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createBytes(IntSupplier sizeSupplier) Create a chunk of zero-initialized bytes with at least the length that is provided by the specified supplier.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createBytes(IntSupplier sizeSupplier, String symbolName) Same as CGlobalDataFactory.createBytes(IntSupplier), and additionally creates a symbol with the provided name for the allocated bytes.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createBytes(Supplier<byte[]> contentSupplier) Create a chunk of bytes that is dimensioned and initialized to contain the bytes provided by the specified supplier.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createBytes(Supplier<byte[]> contentSupplier, String symbolName) Same as CGlobalDataFactory.createBytes(Supplier), and additionally creates a symbol with the provided name for the allocated bytes.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createCString(String content) Create a chunk of data that is dimensioned and initialized to contain the provided string's contents as zero-terminated modified UTF-8.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createCString(String content, String symbolName) Same as CGlobalDataFactory.createCString(String), and additionally creates a symbol with the provided name for the allocated string.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createWord() Create a single word that is initialized to zero.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createWord(String symbolName) Same as CGlobalDataFactory.createWord(), and additionally creates a symbol with the provided name for the allocated word.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createWord(org.graalvm.word.WordBase initialValue) Create a single word that is initialized to the specified value.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	createWord(org.graalvm.word.WordBase initialValue, String symbolName) Same as CGlobalDataFactory.createWord(WordBase), and additionally creates a symbol with the provided name for the allocated word.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	forSymbol(String symbolName) Create a reference to the symbol with the specified name.
static <T extends org.graalvm.word.PointerBase> CGlobalData<T>	forSymbol(String symbolName, boolean nonConstant) Create a reference to the symbol with the specified name.

Methods inherited from class java.lang.Object

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

Method Detail

forSymbol

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> forSymbol(String symbolName)

Create a reference to the symbol with the specified name. Calling CGlobalData.get() on the returned object at runtime returns the referenced symbol's address.

forSymbol

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> forSymbol(String symbolName,
                                                                                boolean nonConstant)

Create a reference to the symbol with the specified name. Calling CGlobalData.get() on the returned object at runtime returns the referenced symbol's address.

Parameters:

nonConstant - the provided object does not have to be used as a compile-time constant (for example, it can be retrieved from a map), but it will always introduce a linking dependency on that symbol in the image.

createCString

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createCString(String content)

Create a chunk of data that is dimensioned and initialized to contain the provided string's contents as zero-terminated modified UTF-8.

createCString

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createCString(String content,
                                                                                    String symbolName)

Same as CGlobalDataFactory.createCString(String), and additionally creates a symbol with the provided name for the allocated string.

createBytes

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createBytes(IntSupplier sizeSupplier)

Create a chunk of zero-initialized bytes with at least the length that is provided by the specified supplier.

createBytes

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createBytes(IntSupplier sizeSupplier,
                                                                                  String symbolName)

Same as CGlobalDataFactory.createBytes(IntSupplier), and additionally creates a symbol with the provided name for the allocated bytes.

createBytes

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createBytes(Supplier<byte[]> contentSupplier)

Create a chunk of bytes that is dimensioned and initialized to contain the bytes provided by the specified supplier.

createBytes

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createBytes(Supplier<byte[]> contentSupplier,
                                                                                  String symbolName)

Same as CGlobalDataFactory.createBytes(Supplier), and additionally creates a symbol with the provided name for the allocated bytes.

createWord

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createWord(org.graalvm.word.WordBase initialValue)

Create a single word that is initialized to the specified value.

createWord

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createWord(org.graalvm.word.WordBase initialValue,
                                                                                 String symbolName)

Same as CGlobalDataFactory.createWord(WordBase), and additionally creates a symbol with the provided name for the allocated word.

createWord

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createWord()

Create a single word that is initialized to zero.

createWord

public static <T extends org.graalvm.word.PointerBase> CGlobalData<T> createWord(String symbolName)

Same as CGlobalDataFactory.createWord(), and additionally creates a symbol with the provided name for the allocated word.