org.lwjgl.system.jemalloc.ChunkHooks Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-jemalloc Show documentation
Show all versions of lwjgl-jemalloc Show documentation
A general purpose malloc implementation that emphasizes fragmentation avoidance and scalable concurrency support.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.system.jemalloc;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Comprises function pointers which are described individually below. jemalloc uses these functions to manage chunk lifetime, which starts off with
* allocation of mapped committed memory, in the simplest case followed by deallocation. However, there are performance and platform reasons to retain chunks
* for later reuse. Cleanup attempts cascade from deallocation to decommit to purging, which gives the chunk management functions opportunities to reject the
* most permanent cleanup operations in favor of less permanent (and often less costly) operations. The chunk splitting and merging operations can also be
* opted out of, but this is mainly intended to support platforms on which virtual memory mappings provided by the operating system kernel do not
* automatically coalesce and split, e.g. Windows.
*
* Member documentation
*
*
* - {@code alloc} – the chunk allocation hook
* - {@code dalloc} – the chunk deallocation hook
* - {@code commit} – the chunk commit hook
* - {@code decommit} – the chunk decommit hook
* - {@code purge} – the chunk purge hook
* - {@code split} – the chunk split hook
* - {@code merge} – the chunk merge hook
*
*
* Layout
*
* struct chunk_hooks_t {
chunk_alloc_t alloc;
chunk_dalloc_t dalloc;
chunk_commit_t commit;
chunk_decommit_t decommit;
chunk_purge_t purge;
chunk_split_t split;
chunk_merge_t merge;
}
*/
public class ChunkHooks extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
ALLOC,
DALLOC,
COMMIT,
DECOMMIT,
PURGE,
SPLIT,
MERGE;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
ALLOC = layout.offsetof(0);
DALLOC = layout.offsetof(1);
COMMIT = layout.offsetof(2);
DECOMMIT = layout.offsetof(3);
PURGE = layout.offsetof(4);
SPLIT = layout.offsetof(5);
MERGE = layout.offsetof(6);
}
ChunkHooks(long address, ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link ChunkHooks} instance at the current position of the specified {@link ByteBuffer} container. Changes to the buffer's content will be
* visible to the struct instance and vice versa.
*
* The created instance holds a strong reference to the container object.
*/
public ChunkHooks(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the {@code ChunkAlloc} instance at the {@code alloc} field. */
public ChunkAlloc alloc() { return ChunkAlloc.create(nalloc(address())); }
/** Returns the {@code ChunkDalloc} instance at the {@code dalloc} field. */
public ChunkDalloc dalloc() { return ChunkDalloc.create(ndalloc(address())); }
/** Returns the {@code ChunkCommit} instance at the {@code commit} field. */
public ChunkCommit commit() { return ChunkCommit.create(ncommit(address())); }
/** Returns the {@code ChunkDecommit} instance at the {@code decommit} field. */
public ChunkDecommit decommit() { return ChunkDecommit.create(ndecommit(address())); }
/** Returns the {@code ChunkPurge} instance at the {@code purge} field. */
public ChunkPurge purge() { return ChunkPurge.create(npurge(address())); }
/** Returns the {@code ChunkSplit} instance at the {@code split} field. */
public ChunkSplit split() { return ChunkSplit.create(nsplit(address())); }
/** Returns the {@code ChunkMerge} instance at the {@code merge} field. */
public ChunkMerge merge() { return ChunkMerge.create(nmerge(address())); }
/** Sets the address of the specified {@link ChunkAllocI} to the {@code alloc} field. */
public ChunkHooks alloc(ChunkAllocI value) { nalloc(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkDallocI} to the {@code dalloc} field. */
public ChunkHooks dalloc(ChunkDallocI value) { ndalloc(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkCommitI} to the {@code commit} field. */
public ChunkHooks commit(ChunkCommitI value) { ncommit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkDecommitI} to the {@code decommit} field. */
public ChunkHooks decommit(ChunkDecommitI value) { ndecommit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkPurgeI} to the {@code purge} field. */
public ChunkHooks purge(ChunkPurgeI value) { npurge(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkSplitI} to the {@code split} field. */
public ChunkHooks split(ChunkSplitI value) { nsplit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkMergeI} to the {@code merge} field. */
public ChunkHooks merge(ChunkMergeI value) { nmerge(address(), addressSafe(value)); return this; }
/** Initializes this struct with the specified values. */
public ChunkHooks set(
ChunkAllocI alloc,
ChunkDallocI dalloc,
ChunkCommitI commit,
ChunkDecommitI decommit,
ChunkPurgeI purge,
ChunkSplitI split,
ChunkMergeI merge
) {
alloc(alloc);
dalloc(dalloc);
commit(commit);
decommit(decommit);
purge(purge);
split(split);
merge(merge);
return this;
}
/** Unsafe version of {@link #set(ChunkHooks) set}. */
public ChunkHooks nset(long struct) {
memCopy(struct, address(), SIZEOF);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public ChunkHooks set(ChunkHooks src) {
return nset(src.address());
}
// -----------------------------------
/** Returns a new {@link ChunkHooks} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static ChunkHooks malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link ChunkHooks} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static ChunkHooks calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link ChunkHooks} instance allocated with {@link BufferUtils}. */
public static ChunkHooks create() {
return new ChunkHooks(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link ChunkHooks} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static ChunkHooks create(long address) {
return address == NULL ? null : new ChunkHooks(address, null);
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(nmemAlloc(capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(BufferUtils.createByteBuffer(capacity * SIZEOF));
}
/**
* Create a {@link ChunkHooks.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link ChunkHooks} instance allocated on the thread-local {@link MemoryStack}. */
public static ChunkHooks mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link ChunkHooks} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static ChunkHooks callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link ChunkHooks} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static ChunkHooks mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link ChunkHooks} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static ChunkHooks callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link ChunkHooks.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #alloc}. */
public static long nalloc(long struct) { return memGetAddress(struct + ChunkHooks.ALLOC); }
/** Unsafe version of {@link #dalloc}. */
public static long ndalloc(long struct) { return memGetAddress(struct + ChunkHooks.DALLOC); }
/** Unsafe version of {@link #commit}. */
public static long ncommit(long struct) { return memGetAddress(struct + ChunkHooks.COMMIT); }
/** Unsafe version of {@link #decommit}. */
public static long ndecommit(long struct) { return memGetAddress(struct + ChunkHooks.DECOMMIT); }
/** Unsafe version of {@link #purge}. */
public static long npurge(long struct) { return memGetAddress(struct + ChunkHooks.PURGE); }
/** Unsafe version of {@link #split}. */
public static long nsplit(long struct) { return memGetAddress(struct + ChunkHooks.SPLIT); }
/** Unsafe version of {@link #merge}. */
public static long nmerge(long struct) { return memGetAddress(struct + ChunkHooks.MERGE); }
/** Unsafe version of {@link #alloc(ChunkAllocI) alloc}. */
public static void nalloc(long struct, long value) { memPutAddress(struct + ChunkHooks.ALLOC, checkPointer(value)); }
/** Unsafe version of {@link #dalloc(ChunkDallocI) dalloc}. */
public static void ndalloc(long struct, long value) { memPutAddress(struct + ChunkHooks.DALLOC, checkPointer(value)); }
/** Unsafe version of {@link #commit(ChunkCommitI) commit}. */
public static void ncommit(long struct, long value) { memPutAddress(struct + ChunkHooks.COMMIT, checkPointer(value)); }
/** Unsafe version of {@link #decommit(ChunkDecommitI) decommit}. */
public static void ndecommit(long struct, long value) { memPutAddress(struct + ChunkHooks.DECOMMIT, checkPointer(value)); }
/** Unsafe version of {@link #purge(ChunkPurgeI) purge}. */
public static void npurge(long struct, long value) { memPutAddress(struct + ChunkHooks.PURGE, checkPointer(value)); }
/** Unsafe version of {@link #split(ChunkSplitI) split}. */
public static void nsplit(long struct, long value) { memPutAddress(struct + ChunkHooks.SPLIT, checkPointer(value)); }
/** Unsafe version of {@link #merge(ChunkMergeI) merge}. */
public static void nmerge(long struct, long value) { memPutAddress(struct + ChunkHooks.MERGE, checkPointer(value)); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
checkPointer(memGetAddress(struct + ChunkHooks.ALLOC));
checkPointer(memGetAddress(struct + ChunkHooks.DALLOC));
checkPointer(memGetAddress(struct + ChunkHooks.COMMIT));
checkPointer(memGetAddress(struct + ChunkHooks.DECOMMIT));
checkPointer(memGetAddress(struct + ChunkHooks.PURGE));
checkPointer(memGetAddress(struct + ChunkHooks.SPLIT));
checkPointer(memGetAddress(struct + ChunkHooks.MERGE));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for ( int i = 0; i < count; i++ )
validate(array + i * SIZEOF);
}
// -----------------------------------
/** An array of {@link ChunkHooks} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link ChunkHooks.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link ChunkHooks#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected ChunkHooks newInstance(long address) {
return new ChunkHooks(address, container);
}
@Override
protected int sizeof() {
return SIZEOF;
}
/** Returns the {@code ChunkAlloc} instance at the {@code alloc} field. */
public ChunkAlloc alloc() { return ChunkAlloc.create(ChunkHooks.nalloc(address())); }
/** Returns the {@code ChunkDalloc} instance at the {@code dalloc} field. */
public ChunkDalloc dalloc() { return ChunkDalloc.create(ChunkHooks.ndalloc(address())); }
/** Returns the {@code ChunkCommit} instance at the {@code commit} field. */
public ChunkCommit commit() { return ChunkCommit.create(ChunkHooks.ncommit(address())); }
/** Returns the {@code ChunkDecommit} instance at the {@code decommit} field. */
public ChunkDecommit decommit() { return ChunkDecommit.create(ChunkHooks.ndecommit(address())); }
/** Returns the {@code ChunkPurge} instance at the {@code purge} field. */
public ChunkPurge purge() { return ChunkPurge.create(ChunkHooks.npurge(address())); }
/** Returns the {@code ChunkSplit} instance at the {@code split} field. */
public ChunkSplit split() { return ChunkSplit.create(ChunkHooks.nsplit(address())); }
/** Returns the {@code ChunkMerge} instance at the {@code merge} field. */
public ChunkMerge merge() { return ChunkMerge.create(ChunkHooks.nmerge(address())); }
/** Sets the address of the specified {@link ChunkAllocI} to the {@code alloc} field. */
public ChunkHooks.Buffer alloc(ChunkAllocI value) { ChunkHooks.nalloc(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkDallocI} to the {@code dalloc} field. */
public ChunkHooks.Buffer dalloc(ChunkDallocI value) { ChunkHooks.ndalloc(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkCommitI} to the {@code commit} field. */
public ChunkHooks.Buffer commit(ChunkCommitI value) { ChunkHooks.ncommit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkDecommitI} to the {@code decommit} field. */
public ChunkHooks.Buffer decommit(ChunkDecommitI value) { ChunkHooks.ndecommit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkPurgeI} to the {@code purge} field. */
public ChunkHooks.Buffer purge(ChunkPurgeI value) { ChunkHooks.npurge(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkSplitI} to the {@code split} field. */
public ChunkHooks.Buffer split(ChunkSplitI value) { ChunkHooks.nsplit(address(), addressSafe(value)); return this; }
/** Sets the address of the specified {@link ChunkMergeI} to the {@code merge} field. */
public ChunkHooks.Buffer merge(ChunkMergeI value) { ChunkHooks.nmerge(address(), addressSafe(value)); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy