org.lwjgl.system.rpmalloc.RPmallocThreadStatistics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-rpmalloc Show documentation
Show all versions of lwjgl-rpmalloc Show documentation
A public domain cross platform lock free thread caching 16-byte aligned memory allocator implemented in C.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.system.rpmalloc;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Member documentation
*
*
* - {@code active} – Current number of bytes available for allocation from active spans
* - {@code sizecache} – Current number of bytes available in thread size class caches
* - {@code spancache} – Current number of bytes available in thread span caches
* - {@code deferred} – Current number of bytes in pending deferred deallocations
* - {@code thread_to_global} – Total number of bytes transitioned from thread cache to global cache
* - {@code global_to_thread} – Total number of bytes transitioned from global cache to thread cache
*
*
* Layout
*
*
* struct rpmalloc_thread_statistics_t {
* size_t active;
* size_t sizecache;
* size_t spancache;
* size_t deferred;
* size_t thread_to_global;
* size_t global_to_thread;
* }
*/
@NativeType("struct rpmalloc_thread_statistics_t")
public class RPmallocThreadStatistics extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
ACTIVE,
SIZECACHE,
SPANCACHE,
DEFERRED,
THREAD_TO_GLOBAL,
GLOBAL_TO_THREAD;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
ACTIVE = layout.offsetof(0);
SIZECACHE = layout.offsetof(1);
SPANCACHE = layout.offsetof(2);
DEFERRED = layout.offsetof(3);
THREAD_TO_GLOBAL = layout.offsetof(4);
GLOBAL_TO_THREAD = layout.offsetof(5);
}
RPmallocThreadStatistics(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link RPmallocThreadStatistics} 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 RPmallocThreadStatistics(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code active} field. */
@NativeType("size_t")
public long active() { return nactive(address()); }
/** Returns the value of the {@code sizecache} field. */
@NativeType("size_t")
public long sizecache() { return nsizecache(address()); }
/** Returns the value of the {@code spancache} field. */
@NativeType("size_t")
public long spancache() { return nspancache(address()); }
/** Returns the value of the {@code deferred} field. */
@NativeType("size_t")
public long deferred() { return ndeferred(address()); }
/** Returns the value of the {@code thread_to_global} field. */
@NativeType("size_t")
public long thread_to_global() { return nthread_to_global(address()); }
/** Returns the value of the {@code global_to_thread} field. */
@NativeType("size_t")
public long global_to_thread() { return nglobal_to_thread(address()); }
// -----------------------------------
/** Returns a new {@link RPmallocThreadStatistics} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static RPmallocThreadStatistics malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link RPmallocThreadStatistics} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static RPmallocThreadStatistics calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link RPmallocThreadStatistics} instance allocated with {@link BufferUtils}. */
public static RPmallocThreadStatistics create() {
return new RPmallocThreadStatistics(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link RPmallocThreadStatistics} instance for the specified memory address. */
public static RPmallocThreadStatistics create(long address) {
return new RPmallocThreadStatistics(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static RPmallocThreadStatistics createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link RPmallocThreadStatistics.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static RPmallocThreadStatistics.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link RPmallocThreadStatistics} instance allocated on the thread-local {@link MemoryStack}. */
public static RPmallocThreadStatistics mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link RPmallocThreadStatistics} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static RPmallocThreadStatistics callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link RPmallocThreadStatistics} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static RPmallocThreadStatistics mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link RPmallocThreadStatistics} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static RPmallocThreadStatistics callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link RPmallocThreadStatistics.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static RPmallocThreadStatistics.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link RPmallocThreadStatistics.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 RPmallocThreadStatistics.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #active}. */
public static long nactive(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.ACTIVE); }
/** Unsafe version of {@link #sizecache}. */
public static long nsizecache(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.SIZECACHE); }
/** Unsafe version of {@link #spancache}. */
public static long nspancache(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.SPANCACHE); }
/** Unsafe version of {@link #deferred}. */
public static long ndeferred(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.DEFERRED); }
/** Unsafe version of {@link #thread_to_global}. */
public static long nthread_to_global(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.THREAD_TO_GLOBAL); }
/** Unsafe version of {@link #global_to_thread}. */
public static long nglobal_to_thread(long struct) { return memGetAddress(struct + RPmallocThreadStatistics.GLOBAL_TO_THREAD); }
// -----------------------------------
/** An array of {@link RPmallocThreadStatistics} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link RPmallocThreadStatistics.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 RPmallocThreadStatistics#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);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable 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, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected RPmallocThreadStatistics newInstance(long address) {
return new RPmallocThreadStatistics(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code active} field. */
@NativeType("size_t")
public long active() { return RPmallocThreadStatistics.nactive(address()); }
/** Returns the value of the {@code sizecache} field. */
@NativeType("size_t")
public long sizecache() { return RPmallocThreadStatistics.nsizecache(address()); }
/** Returns the value of the {@code spancache} field. */
@NativeType("size_t")
public long spancache() { return RPmallocThreadStatistics.nspancache(address()); }
/** Returns the value of the {@code deferred} field. */
@NativeType("size_t")
public long deferred() { return RPmallocThreadStatistics.ndeferred(address()); }
/** Returns the value of the {@code thread_to_global} field. */
@NativeType("size_t")
public long thread_to_global() { return RPmallocThreadStatistics.nthread_to_global(address()); }
/** Returns the value of the {@code global_to_thread} field. */
@NativeType("size_t")
public long global_to_thread() { return RPmallocThreadStatistics.nglobal_to_thread(address()); }
}
}