org.graalvm.nativeimage

Class UnmanagedMemory

java.lang.Object

org.graalvm.nativeimage.UnmanagedMemory

public final class UnmanagedMemory
extends Object

Contains static methods that allow allocate/free of unmanaged memory, i.e., memory that is not under the control of the garbage collector. In a typical C environment, these are the malloc/free functions of the standard C library, however this class makes no assumptions or guarantees about how the memory is managed. In particular, it is not allowed to free memory returned by these allocation function directly using the standard C library (or vice versa).

Since:

19.0

Method Summary

Modifier and Type	Method and Description
static <T extends org.graalvm.word.PointerBase> T	calloc(int size) Allocates size bytes of unmanaged memory.
static <T extends org.graalvm.word.PointerBase> T	calloc(org.graalvm.word.UnsignedWord size) Allocates size bytes of unmanaged memory.
static void	free(org.graalvm.word.PointerBase ptr) Frees unmanaged memory that was previously allocated using methods of this class.
static <T extends org.graalvm.word.PointerBase> T	malloc(int size) Allocates size bytes of unmanaged memory.
static <T extends org.graalvm.word.PointerBase> T	malloc(org.graalvm.word.UnsignedWord size) Allocates size bytes of unmanaged memory.
static <T extends org.graalvm.word.PointerBase> T	realloc(T ptr, org.graalvm.word.UnsignedWord size) Changes the size of the provided unmanaged memory to size bytes of unmanaged memory.

Methods inherited from class java.lang.Object

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

Method Detail

malloc

public static <T extends org.graalvm.word.PointerBase> T malloc(org.graalvm.word.UnsignedWord size)

Allocates size bytes of unmanaged memory. The content of the memory is undefined.

If size is 0, the method is allowed but not required to return the null pointer. This method never returns a the null pointer, but instead throws a OutOfMemoryError when allocation fails.

Since:

19.0

malloc

public static <T extends org.graalvm.word.PointerBase> T malloc(int size)

Allocates size bytes of unmanaged memory. The content of the memory is undefined.

If size is 0, the method is allowed but not required to return the null pointer. This method never returns a the null pointer, but instead throws a OutOfMemoryError when allocation fails.

Since:

19.0

calloc

public static <T extends org.graalvm.word.PointerBase> T calloc(org.graalvm.word.UnsignedWord size)

Allocates size bytes of unmanaged memory. The content of the memory is set to 0.

If size is 0, the method is allowed but not required to return the null pointer. This method never returns a the null pointer, but instead throws a OutOfMemoryError when allocation fails.

Since:

19.0

calloc

public static <T extends org.graalvm.word.PointerBase> T calloc(int size)

Allocates size bytes of unmanaged memory. The content of the memory is set to 0.

If size is 0, the method is allowed but not required to return the null pointer. This method never returns a the null pointer, but instead throws a OutOfMemoryError when allocation fails.

Since:

19.0

realloc

public static <T extends org.graalvm.word.PointerBase> T realloc(T ptr,
                                                                 org.graalvm.word.UnsignedWord size)

Changes the size of the provided unmanaged memory to size bytes of unmanaged memory. If the new size is larger than the old size, the content of the additional memory is undefined.

If size is 0, the method is allowed but not required to return the null pointer. This method never returns a the null pointer, but instead throws a OutOfMemoryError when allocation fails.

Since:

19.0

free

public static void free(org.graalvm.word.PointerBase ptr)

Frees unmanaged memory that was previously allocated using methods of this class.

Since:

19.0