Package com.github.marschall.nativebytebuffers

Class Stdlib

java.lang.Object

com.github.marschall.nativebytebuffers.Stdlib

public final class Stdlib
extends Object

Provides access to memory management using stdlib.h.

Method Summary

Modifier and Type	Method	Description
static ByteBuffer	aligned_alloc(int alignment, int size)	Calls calloc() and wraps the result in a ByteBuffer
static ByteBuffer	calloc(int size)	Calls calloc() and wraps the result in a ByteBuffer
static void	free(ByteBuffer buffer)	Calls free() on the contents of the given ByteBuffer.
static ByteBuffer	malloc(int size)	Calls malloc() and wraps the result in a ByteBuffer

Methods inherited from class java.lang.Object

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

Method Details

malloc

public static ByteBuffer malloc(int size)

Calls malloc() and wraps the result in a ByteBuffer

Parameters:

size - the number of bytes to allocate, must be positive, int because ByteBuffer only supports int indices

Returns:

the new buffer, never null, the content is uninitialized as per malloc() contract, must be released with free(ByteBuffer)

Throws:

AllocationFailedException - if malloc returns NULL

IllegalArgumentException - if size is not positive

See Also:

• free(ByteBuffer)
• malloc(3)

calloc

public static ByteBuffer calloc(int size)

Calls calloc() and wraps the result in a ByteBuffer

Parameters:

size - the number of bytes to allocate, must be positive, int because ByteBuffer only supports int indices

Returns:

the new buffer, never null, the content is 0 as per calloc() contract, must be released with free(ByteBuffer)

Throws:

AllocationFailedException - if calloc returns NULL

IllegalArgumentException - if size is not positive

See Also:

• free(ByteBuffer)
• malloc(3)

aligned_alloc

public static ByteBuffer aligned_alloc(int alignment,
 int size)

Calls calloc() and wraps the result in a ByteBuffer

Parameters:

alignment - the alignment in bytes, must bet power of 2 and least as large as sizeof(void *)

size - the number of bytes to allocate, must be positive, an integral multiple of alignment int because ByteBuffer only supports int indices

Returns:

the new buffer, never null, the content is uninitialized as per aligned_alloc() contract, must be released with free(ByteBuffer)

Throws:

AllocationFailedException - if aligned_alloc returns NULL

IllegalArgumentException - if alignment is not positive, if size is not positive

See Also:

• free(ByteBuffer)
• posix_memalign(3)

free

public static void free(ByteBuffer buffer)

Calls free() on the contents of the given ByteBuffer.

This method may crash the JVM the buffer passed has not been created by malloc(int) or calloc(int) or has already been passed to this method.

Parameters:

buffer - the buffer to free, not null, must have been created with malloc(int), must not be accessed afterwards, must not be passed to this method again

Throws:

NullPointerException - if buffer is null

IllegalArgumentException - if buffer is not a direct buffer

See Also:

• malloc(3)