Class LibcArena

java.lang.Object

club.doki7.ffm.LibcArena

All Implemented Interfaces:

AutoCloseable, Arena, SegmentAllocator

public final class LibcArena
extends Object
implements Arena

Field Summary

Fields

Modifier and Type	Field	Description
static final LibcArena	INSTANCE

Method Summary

Modifier and Type	Method	Description
@NotNull MemorySegment	allocate(long byteSize, long byteAlignment)	Allocates memory using system libc aligned_alloc Note that you're in charge of freeing the memory using free(java.lang.foreign.MemorySegment), otherwise there will be a memory leak.
void	close()
void	free(@NotNull MemorySegment ms)
MemorySegment.Scope	scope()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.foreign.SegmentAllocator

allocate, allocate, allocate, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom, allocateFrom

Field Details

INSTANCE

public static final LibcArena INSTANCE

Method Details

free

public void free(@NotNull
 @NotNull MemorySegment ms)

allocate

@NotNull
public @NotNull MemorySegment allocate(long byteSize,
 long byteAlignment)

Allocates memory using system libc aligned_alloc

Note that you're in charge of freeing the memory using free(java.lang.foreign.MemorySegment), otherwise there will be a memory leak. Be extra careful when using LibcArena in combination with allocate series methods.

Specified by:

allocate in interface Arena

Specified by:

allocate in interface SegmentAllocator

Parameters:

byteSize - The size of the memory to allocate

byteAlignment - The alignment of the memory to allocate

Returns:

A MemorySegment representing the allocated memory with all bytes zeroed

Throws:

IllegalArgumentException - If the byte size or alignment is invalid

OutOfMemoryError - If the memory allocation fails

scope

@Nullable
public MemorySegment.Scope scope()

Specified by:

scope in interface Arena

close

public void close()

Specified by:

close in interface Arena

Specified by:

close in interface AutoCloseable