org.lwjgl.opencl.CL21 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-opencl Show documentation
Show all versions of lwjgl-opencl Show documentation
An open, royalty-free standard for cross-platform, parallel programming of diverse processors found in personal computers, servers, mobile devices and embedded platforms.
The newest version!
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.opencl;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.Pointer.*;
/** The core OpenCL 2.1 functionality. */
public class CL21 extends CL20 {
/** OpenCL Version. */
public static final int CL_VERSION_2_1 = 1;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetPlatformInfo GetPlatformInfo}, returns a {@code cl_ulong} value.
*
* Returns the resolution of the host timer in nanoseconds as used by {@link #clGetDeviceAndHostTimer GetDeviceAndHostTimer}.
*
* Support for device and host timer synchronization is required for platforms supporting OpenCL 2.1 or 2.2. This value must be 0 for devices that do not
* support device and host timer synchronization.
*/
public static final int CL_PLATFORM_HOST_TIMER_RESOLUTION = 0x905;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetDeviceInfo GetDeviceInfo}, returns a {@code char[]} value.
*
* The intermediate languages that can be supported by {@link #clCreateProgramWithIL CreateProgramWithIL} for this device. Returns a space-separated list of IL version strings of the
* form {@code _.}.
*
* For an OpenCL 2.1 or 2.2 device, SPIR-V is a required IL prefix.
*
* If the device does not support intermediate language programs, the value must be {@code ""} (an empty string).
*/
public static final int CL_DEVICE_IL_VERSION = 0x105B;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetDeviceInfo GetDeviceInfo}, returns a {@code cl_uint} value.
*
* Maximum number of sub-groups in a workgroup that a device is capable of executing on a single compute unit, for any given kernel instance running on
* the device.
*
* The minimum value is 1 if the device supports subgroups, and must be 0 for devices that do not support subgroups. Support for subgroups is required for
* an OpenCL 2.1 or 2.2 device.
*/
public static final int CL_DEVICE_MAX_NUM_SUB_GROUPS = 0x105C;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetDeviceInfo GetDeviceInfo}, returns a {@code cl_bool} value.
*
* Is {@link CL10#CL_TRUE TRUE} if this device supports independent forward progress of sub-groups, {@link CL10#CL_FALSE FALSE} otherwise.
*
* This query must return {@link CL10#CL_TRUE TRUE} for devices that support the {@code cl_khr_subgroups} extension, and must return {@link CL10#CL_FALSE FALSE} for devices that do not support
* subgroups.
*/
public static final int CL_DEVICE_SUB_GROUP_INDEPENDENT_FORWARD_PROGRESS = 0x105D;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetCommandQueueInfo GetCommandQueueInfo}, returns a {@code cl_command_queue} value.
*
* Return the current default command queue for the underlying device.
*/
public static final int CL_QUEUE_DEVICE_DEFAULT = 0x1095;
/** cl_channel_type */
public static final int CL_UNORM_INT_101010_2 = 0x10E0;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetProgramInfo GetProgramInfo}, returns a {@code char[]} value.
*
* Returns the program IL for programs created with {@link #clCreateProgramWithIL CreateProgramWithIL}.
*
* If program is created with {@link CL10#clCreateProgramWithSource CreateProgramWithSource}, {@link CL10#clCreateProgramWithBinary CreateProgramWithBinary} or {@link CL12#clCreateProgramWithBuiltInKernels CreateProgramWithBuiltInKernels} the memory pointed to by
* {@code param_value} will be unchanged and {@code param_value_size_ret} will be set to 0.
*/
public static final int CL_PROGRAM_IL = 0x1169;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetKernelInfo GetKernelInfo}, returns a {@code size_t} value.
*
* This provides a mechanism for the application to query the maximum number of sub-groups that may make up each workgroup to execute a kernel on a
* specific device given by device. The OpenCL implementation uses the resource requirements of the kernel (register usage etc.) to determine what this
* work-group size should be. The returned value may be used to compute a work-group size to enqueue the kernel with to give a round number of sub-groups
* for an enqueue.
*/
public static final int CL_KERNEL_MAX_NUM_SUB_GROUPS = 0x11B9;
/**
* Accepted as the {@code param_name} parameter of {@link CL10#clGetKernelInfo GetKernelInfo}, returns a {@code size_t} value.
*
* Returns the number of sub-groups per workgroup specified in the kernel source or IL. If the sub-group count is not specified then 0 is returned.
*/
public static final int CL_KERNEL_COMPILE_NUM_SUB_GROUPS = 0x11BA;
/**
* Accepted as the {@code param_name} parameter of {@link #clGetKernelSubGroupInfo GetKernelSubGroupInfo}, returns a {@code size_t} value.
*
* Returns the maximum sub-group size for this kernel. All sub-groups must be the same size, while the last subgroup in any work-group (i.e. the subgroup
* with the maximum index) could be the same or smaller size.
*
* The {@code input_value} must be an array of {@code size_t} values corresponding to the local work size parameter of the intended dispatch. The number
* of dimensions in the ND-range will be inferred from the value specified for {@code input_value_size}.
*/
public static final int CL_KERNEL_MAX_SUB_GROUP_SIZE_FOR_NDRANGE = 0x2033;
/**
* Accepted as the {@code param_name} parameter of {@link #clGetKernelSubGroupInfo GetKernelSubGroupInfo}, returns a {@code size_t} value.
*
* Returns the number of sub-groups that will be present in each workgroup for a given local work size. All workgroups, apart from the last workgroup in
* each dimension in the presence of nonuniform work-group sizes, will have the same number of subgroups.
*
* The {@code input_value} must be an array of {@code size_t} values corresponding to the local work size parameter of the intended dispatch. The number
* of dimensions in the ND-range will be inferred from the value specified for {@code input_value_size}.
*/
public static final int CL_KERNEL_SUB_GROUP_COUNT_FOR_NDRANGE = 0x2034;
/**
* Accepted as the {@code param_name} parameter of {@link #clGetKernelSubGroupInfo GetKernelSubGroupInfo}, returns a {@code size_t[]} value.
*
* Returns the local size that will generate the requested number of sub-groups for the kernel. The output array must be an array of {@code size_t} values
* corresponding to the local size parameter. Any returned workgroup will have one dimension. Other dimensions inferred from the value specified for
* {@code param_value_size} will be filled with the value 1. The returned value will produce an exact number of sub-groups and result in no partial groups
* for an executing kernel except in the case where the last work-group in a dimension has a size different from that of the other groups. If no
* work-group size can accommodate the requested number of sub-groups, 0 will be returned in each element of the return array.
*/
public static final int CL_KERNEL_LOCAL_SIZE_FOR_SUB_GROUP_COUNT = 0x2034;
protected CL21() {
throw new UnsupportedOperationException();
}
// --- [ clSetDefaultDeviceCommandQueue ] ---
/**
* Replaces a default device command queue created with {@link CL20#clCreateCommandQueueWithProperties CreateCommandQueueWithProperties} and the {@link CL20#CL_QUEUE_ON_DEVICE_DEFAULT QUEUE_ON_DEVICE_DEFAULT} flag.
*
* @param context a valid OpenCL context
* @param device a OpenCL device associated with {@code context}
* @param command_queue a valid command-queue for {@code device}
*
* @return {@link CL10#CL_SUCCESS SUCCESS} if the function is executed successfully. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_CONTEXT INVALID_CONTEXT} if {@code context} is not a valid context.
* - {@link CL10#CL_INVALID_DEVICE INVALID_DEVICE} if {@code device} is not a valid device or is not associated with {@code context}.
* - {@link CL10#CL_INVALID_COMMAND_QUEUE INVALID_COMMAND_QUEUE} if {@code command_queue} is not a valid command-queue.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clSetDefaultDeviceCommandQueue(@NativeType("cl_context") long context, @NativeType("cl_device_id") long device, @NativeType("cl_command_queue") long command_queue) {
long __functionAddress = CL.getICD().clSetDefaultDeviceCommandQueue;
if (CHECKS) {
check(__functionAddress);
check(context);
check(device);
check(command_queue);
}
return callPPPI(context, device, command_queue, __functionAddress);
}
// --- [ clGetDeviceAndHostTimer ] ---
/** Unsafe version of: {@link #clGetDeviceAndHostTimer GetDeviceAndHostTimer} */
public static int nclGetDeviceAndHostTimer(long device, long device_timestamp, long host_timestamp) {
long __functionAddress = CL.getICD().clGetDeviceAndHostTimer;
if (CHECKS) {
check(__functionAddress);
check(device);
}
return callPPPI(device, device_timestamp, host_timestamp, __functionAddress);
}
/**
* Returns a reasonably synchronized pair of timestamps from the device timer and the host timer as seen by device. Implementations may need to execute
* this query with a high latency in order to provide reasonable synchronization of the timestamps. The host timestamp and device timestamp returned by
* this function and {@link #clGetHostTimer GetHostTimer} each have an implementation defined timebase. The timestamps will always be in their respective timebases regardless
* of which query function is used. The timestamp returned from {@link CL10#clGetEventProfilingInfo GetEventProfilingInfo} for an event on a device and a device timestamp queried from
* the same device will always be in the same timebase.
*
* @param device a device returned by {@link CL10#clGetDeviceIDs GetDeviceIDs}
* @param device_timestamp will be updated with the value of the device timer in nanoseconds. The resolution of the timer is the same as the device profiling timer returned
* by {@link CL10#clGetDeviceInfo GetDeviceInfo} and the {@link CL10#CL_DEVICE_PROFILING_TIMER_RESOLUTION DEVICE_PROFILING_TIMER_RESOLUTION} query.
* @param host_timestamp will be updated with the value of the host timer in nanoseconds at the closest possible point in time to that at which {@code device_timestamp} was
* returned. The resolution of the timer may be queried via {@link CL10#clGetPlatformInfo GetPlatformInfo} and the flag {@link #CL_PLATFORM_HOST_TIMER_RESOLUTION PLATFORM_HOST_TIMER_RESOLUTION}.
*
* @return {@link CL10#CL_SUCCESS SUCCESS} with a time value in {@code host_timestamp} if provided. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_DEVICE INVALID_DEVICE} if {@code device} is not a valid OpenCL device.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code host_timestamp} or {@code device_timestamp} is {@code NULL}.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetDeviceAndHostTimer(@NativeType("cl_device_id") long device, @NativeType("cl_ulong *") LongBuffer device_timestamp, @NativeType("cl_ulong *") LongBuffer host_timestamp) {
if (CHECKS) {
check(device_timestamp, 1);
check(host_timestamp, 1);
}
return nclGetDeviceAndHostTimer(device, memAddress(device_timestamp), memAddress(host_timestamp));
}
// --- [ clGetHostTimer ] ---
/** Unsafe version of: {@link #clGetHostTimer GetHostTimer} */
public static int nclGetHostTimer(long device, long host_timestamp) {
long __functionAddress = CL.getICD().clGetHostTimer;
if (CHECKS) {
check(__functionAddress);
check(device);
}
return callPPI(device, host_timestamp, __functionAddress);
}
/**
* Returns the current value of the host clock as seen by device. This value is in the same timebase as the {@code host_timestamp} returned from
* {@link #clGetDeviceAndHostTimer GetDeviceAndHostTimer}. The implementation will return with as low a latency as possible to allow a correlation with a subsequent application sampled
* time. The host timestamp and device timestamp returned by this function and {@link #clGetDeviceAndHostTimer GetDeviceAndHostTimer} each have an implementation defined timebase. The
* timestamps will always be in their respective timebases regardless of which query function is used. The timestamp returned from
* {@link CL10#clGetEventProfilingInfo GetEventProfilingInfo} for an event on a device and a device timestamp queried from the same device will always be in the same timebase.
*
* @param device a device returned by {@link CL10#clGetDeviceIDs GetDeviceIDs}
* @param host_timestamp will be updated with the value of the current timer in nanoseconds. The resolution of the timer may be queried via {@link CL10#clGetPlatformInfo GetPlatformInfo} and the
* flag {@link #CL_PLATFORM_HOST_TIMER_RESOLUTION PLATFORM_HOST_TIMER_RESOLUTION}.
*
* @return {@link CL10#CL_SUCCESS SUCCESS} with a time value in {@code host_timestamp} if provided. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_DEVICE INVALID_DEVICE} if {@code device} is not a valid OpenCL device.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code host_timestamp} is {@code NULL}.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetHostTimer(@NativeType("cl_device_id") long device, @NativeType("cl_ulong *") LongBuffer host_timestamp) {
if (CHECKS) {
check(host_timestamp, 1);
}
return nclGetHostTimer(device, memAddress(host_timestamp));
}
// --- [ clCreateProgramWithIL ] ---
/**
* Unsafe version of: {@link #clCreateProgramWithIL CreateProgramWithIL}
*
* @param length the number of bytes in {@code il}
*/
public static long nclCreateProgramWithIL(long context, long il, long length, long errcode_ret) {
long __functionAddress = CL.getICD().clCreateProgramWithIL;
if (CHECKS) {
check(__functionAddress);
check(context);
}
return callPPPPP(context, il, length, errcode_ret, __functionAddress);
}
/**
* Creates a program object for a context, and loads the IL pointed to by {@code il} and with length in bytes {@code length} into the program object.
*
* @param context a valid OpenCL context
* @param il a pointer to a {@code length}-byte block of memory containing SPIR-V or an implementation-defined intermediate language
* @param errcode_ret will return an appropriate error code. If {@code errcode_ret} is {@code NULL}, no error code is returned.
*
* @return a valid non-zero program object and {@code errcode_ret} is set to {@link CL10#CL_SUCCESS SUCCESS} if the program object is created successfully. Otherwise, it returns a {@code NULL}
* value with one of the following error values returned in {@code errcode_ret}:
*
*
* - {@link CL10#CL_INVALID_CONTEXT INVALID_CONTEXT} if {@code context} is not a valid context.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code il} is {@code NULL} or if {@code length} is zero.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if the {@code length}-byte memory pointed to by {@code il} does not contain well-formed intermediate language input that can be
* consumed by the OpenCL runtime.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_program")
public static long clCreateProgramWithIL(@NativeType("cl_context") long context, @NativeType("void const *") ByteBuffer il, @Nullable @NativeType("cl_int *") IntBuffer errcode_ret) {
if (CHECKS) {
checkSafe(errcode_ret, 1);
}
return nclCreateProgramWithIL(context, memAddress(il), il.remaining(), memAddressSafe(errcode_ret));
}
// --- [ clCloneKernel ] ---
/** Unsafe version of: {@link #clCloneKernel CloneKernel} */
public static long nclCloneKernel(long source_kernel, long errcode_ret) {
long __functionAddress = CL.getICD().clCloneKernel;
if (CHECKS) {
check(__functionAddress);
check(source_kernel);
}
return callPPP(source_kernel, errcode_ret, __functionAddress);
}
/**
* Makes a shallow copy of the kernel object, its arguments and any information passed to the kernel object using {@link CL20#clSetKernelExecInfo SetKernelExecInfo}. If the kernel
* object was ready to be enqueued before copying it, the clone of the kernel object is ready to enqueue.
*
* The returned kernel object is an exact copy of {@code source_kernel}, with one caveat: the reference count on the returned kernel object is set as if
* it had been returned by {@link CL10#clCreateKernel CreateKernel}. The reference count of {@code source_kernel} will not be changed.
*
* The resulting kernel will be in the same state as if {@link CL10#clCreateKernel CreateKernel} is called to create the resultant kernel with the same arguments as those used
* to create {@code source_kernel}, the latest call to {@link CL10#clSetKernelArg SetKernelArg} or {@link CL20#clSetKernelArgSVMPointer SetKernelArgSVMPointer} for each argument index applied to kernel and
* the last call to {@link CL20#clSetKernelExecInfo SetKernelExecInfo} for each value of the param name parameter are applied to the new kernel object.
*
* All arguments of the new kernel object must be intact and it may be correctly used in the same situations as kernel except those that assume a
* pre-existing reference count. Setting arguments on the new kernel object will not affect {@code source_kernel} except insofar as the argument points to
* a shared underlying entity and in that situation behavior is as if two kernel objects had been created and the same argument applied to each. Only the
* data stored in the kernel object is copied; data referenced by the kernel's arguments are not copied. For example, if a buffer or pointer argument is
* set on a kernel object, the pointer is copied but the underlying memory allocation is not.
*
* @param source_kernel a valid {@code cl_kernel} object that will be copied. {@code source_kernel} will not be modified in any way by this function.
* @param errcode_ret will return an appropriate error code. If {@code errcode_ret} is {@code NULL}, no error code is returned.
*
* @return a valid non-zero kernel object and {@code errcode_ret} is set to {@link CL10#CL_SUCCESS SUCCESS} if the kernel is successfully copied. Otherwise it returns a {@code NULL} value with
* one of the following error values returned in {@code errcode_ret}:
*
*
* - {@link CL10#CL_INVALID_KERNEL INVALID_KERNEL} if {@code source_kernel} is not a valid kernel object.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_kernel")
public static long clCloneKernel(@NativeType("cl_kernel") long source_kernel, @Nullable @NativeType("cl_int *") IntBuffer errcode_ret) {
if (CHECKS) {
checkSafe(errcode_ret, 1);
}
return nclCloneKernel(source_kernel, memAddressSafe(errcode_ret));
}
// --- [ clGetKernelSubGroupInfo ] ---
/**
* Unsafe version of: {@link #clGetKernelSubGroupInfo GetKernelSubGroupInfo}
*
* @param input_value_size the size in bytes of memory pointed to by {@code input_value}
* @param param_value_size the size in bytes of memory pointed to by {@code param_value}. This size must be ≥ size of return type. If {@code param_value} is {@code NULL}, it is ignored.
*/
public static int nclGetKernelSubGroupInfo(long kernel, long device, int param_name, long input_value_size, long input_value, long param_value_size, long param_value, long param_value_size_ret) {
long __functionAddress = CL.getICD().clGetKernelSubGroupInfo;
if (CHECKS) {
check(__functionAddress);
check(kernel);
}
return callPPPPPPPI(kernel, device, param_name, input_value_size, input_value, param_value_size, param_value, param_value_size_ret, __functionAddress);
}
/**
* Returns information about the kernel object.
*
* @param kernel the kernel object being queried
* @param device a specific device in the list of devices associated with {@code kernel}. The list of devices is the list of devices in the OpenCL context that is
* associated with {@code kernel}. If the list of devices associated with kernel is a single device, device can be a {@code NULL} value.
* @param param_name the information to query. One of:
{@link #CL_KERNEL_MAX_NUM_SUB_GROUPS KERNEL_MAX_NUM_SUB_GROUPS} {@link #CL_KERNEL_COMPILE_NUM_SUB_GROUPS KERNEL_COMPILE_NUM_SUB_GROUPS} {@link #CL_KERNEL_MAX_SUB_GROUP_SIZE_FOR_NDRANGE KERNEL_MAX_SUB_GROUP_SIZE_FOR_NDRANGE} {@link #CL_KERNEL_SUB_GROUP_COUNT_FOR_NDRANGE KERNEL_SUB_GROUP_COUNT_FOR_NDRANGE} {@link #CL_KERNEL_LOCAL_SIZE_FOR_SUB_GROUP_COUNT KERNEL_LOCAL_SIZE_FOR_SUB_GROUP_COUNT}
* @param input_value a pointer to memory where the appropriate parameterization of the query is passed from. If {@code input_value} is {@code NULL}, it is ignored.
* @param param_value a pointer to memory where the appropriate result being queried is returned. If {@code param_value} is {@code NULL}, it is ignored.
* @param param_value_size_ret the actual size in bytes of data being queried by {@code param_value}. If {@code NULL}, it is ignored.
*
* @return {@link CL10#CL_SUCCESS SUCCESS} if the function is executed successfully. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_DEVICE INVALID_DEVICE} if {@code device} is not in the list of devices associated with {@code kernel} or if {@code device} is {@code NULL} but there is more than
* one device associated with {@code kernel}.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code param_name} is not valid, or if size in bytes specified by {@code param_value} is < size of return type and
* {@code param_value} is not {@code NULL}.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code param_name} is {@code KERNEL_SUB_GROUP_SIZE_FOR_NDRANGE} and the size in bytes specified by {@code input_value_size} is not valid
* or if {@code input_value} is {@code NULL}.
* - {@link CL10#CL_INVALID_KERNEL INVALID_KERNEL} if {@code kernel} is not a valid kernel object.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetKernelSubGroupInfo(@NativeType("cl_kernel") long kernel, @NativeType("cl_device_id") long device, @NativeType("cl_kernel_sub_group_info") int param_name, @Nullable @NativeType("void const *") ByteBuffer input_value, @Nullable @NativeType("void *") ByteBuffer param_value, @Nullable @NativeType("size_t *") PointerBuffer param_value_size_ret) {
if (CHECKS) {
checkSafe(param_value_size_ret, 1);
}
return nclGetKernelSubGroupInfo(kernel, device, param_name, remainingSafe(input_value), memAddressSafe(input_value), remainingSafe(param_value), memAddressSafe(param_value), memAddressSafe(param_value_size_ret));
}
/**
* Returns information about the kernel object.
*
* @param kernel the kernel object being queried
* @param device a specific device in the list of devices associated with {@code kernel}. The list of devices is the list of devices in the OpenCL context that is
* associated with {@code kernel}. If the list of devices associated with kernel is a single device, device can be a {@code NULL} value.
* @param param_name the information to query. One of:
{@link #CL_KERNEL_MAX_NUM_SUB_GROUPS KERNEL_MAX_NUM_SUB_GROUPS} {@link #CL_KERNEL_COMPILE_NUM_SUB_GROUPS KERNEL_COMPILE_NUM_SUB_GROUPS} {@link #CL_KERNEL_MAX_SUB_GROUP_SIZE_FOR_NDRANGE KERNEL_MAX_SUB_GROUP_SIZE_FOR_NDRANGE} {@link #CL_KERNEL_SUB_GROUP_COUNT_FOR_NDRANGE KERNEL_SUB_GROUP_COUNT_FOR_NDRANGE} {@link #CL_KERNEL_LOCAL_SIZE_FOR_SUB_GROUP_COUNT KERNEL_LOCAL_SIZE_FOR_SUB_GROUP_COUNT}
* @param input_value a pointer to memory where the appropriate parameterization of the query is passed from. If {@code input_value} is {@code NULL}, it is ignored.
* @param param_value a pointer to memory where the appropriate result being queried is returned. If {@code param_value} is {@code NULL}, it is ignored.
* @param param_value_size_ret the actual size in bytes of data being queried by {@code param_value}. If {@code NULL}, it is ignored.
*
* @return {@link CL10#CL_SUCCESS SUCCESS} if the function is executed successfully. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_DEVICE INVALID_DEVICE} if {@code device} is not in the list of devices associated with {@code kernel} or if {@code device} is {@code NULL} but there is more than
* one device associated with {@code kernel}.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code param_name} is not valid, or if size in bytes specified by {@code param_value} is < size of return type and
* {@code param_value} is not {@code NULL}.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code param_name} is {@code KERNEL_SUB_GROUP_SIZE_FOR_NDRANGE} and the size in bytes specified by {@code input_value_size} is not valid
* or if {@code input_value} is {@code NULL}.
* - {@link CL10#CL_INVALID_KERNEL INVALID_KERNEL} if {@code kernel} is not a valid kernel object.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetKernelSubGroupInfo(@NativeType("cl_kernel") long kernel, @NativeType("cl_device_id") long device, @NativeType("cl_kernel_sub_group_info") int param_name, @Nullable @NativeType("void const *") ByteBuffer input_value, @Nullable @NativeType("void *") PointerBuffer param_value, @Nullable @NativeType("size_t *") PointerBuffer param_value_size_ret) {
if (CHECKS) {
checkSafe(param_value_size_ret, 1);
}
return nclGetKernelSubGroupInfo(kernel, device, param_name, remainingSafe(input_value), memAddressSafe(input_value), Integer.toUnsignedLong(remainingSafe(param_value)) << POINTER_SHIFT, memAddressSafe(param_value), memAddressSafe(param_value_size_ret));
}
// --- [ clEnqueueSVMMigrateMem ] ---
/**
* Unsafe version of: {@link #clEnqueueSVMMigrateMem EnqueueSVMMigrateMem}
*
* @param num_svm_pointers the number of pointers in the specified {@code svm_pointers} array, and the number of sizes in the {@code sizes} array, if {@code sizes} is not
* {@code NULL}.
* @param num_events_in_wait_list the number of events in {@code event_wait_list}
*/
public static int nclEnqueueSVMMigrateMem(long command_queue, int num_svm_pointers, long svm_pointers, long sizes, long flags, int num_events_in_wait_list, long event_wait_list, long event) {
long __functionAddress = CL.getICD().clEnqueueSVMMigrateMem;
if (CHECKS) {
check(__functionAddress);
check(command_queue);
}
return callPPPJPPI(command_queue, num_svm_pointers, svm_pointers, sizes, flags, num_events_in_wait_list, event_wait_list, event, __functionAddress);
}
/**
* Enqueues a command to indicate which device a set of ranges of SVM allocations should be associated with. Once the event returned by
* {@code clEnqueueSVMMigrateMem} has become {@link CL10#CL_COMPLETE COMPLETE}, the ranges specified by svm pointers and sizes have been successfully migrated to the device
* associated with command queue.
*
* The user is responsible for managing the event dependencies associated with this command in order to avoid overlapping access to SVM allocations.
* Improperly specified event dependencies passed to {@code clEnqueueSVMMigrateMem} could result in undefined results.
*
* @param command_queue a valid host command queue. The specified set of allocation ranges will be migrated to the OpenCL device associated with {@code command_queue}.
* @param svm_pointers a pointer to an array of pointers. Each pointer in this array must be within an allocation produced by a call to {@link CL20#clSVMAlloc SVMAlloc}.
* @param sizes an array of sizes. The pair {@code svm_pointers[i]} and {@code sizes[i]} together define the starting address and number of bytes in a range to be
* migrated. {@code sizes} may be {@code NULL} indicating that every allocation containing any {@code svm_pointer[i]} is to be migrated. Also, if
* {@code sizes[i]} is zero, then the entire allocation containing {@code svm_pointer[i]} is migrated.
* @param flags a bit-field that is used to specify migration options
* @param event_wait_list a list of events that need to complete before this particular command can be executed. If {@code event_wait_list} is {@code NULL}, then this particular command
* does not wait on any event to complete. The events specified in {@code event_wait_list} act as synchronization points. The context associated with events in
* {@code event_wait_list} and {@code command_queue} must be the same.
* @param event Returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete.
* {@code event} can be {@code NULL} in which case it will not be possible for the application to query the status of this command or queue a wait for this command to
* complete. If the {@code event_wait_list} and the {@code event} arguments are not {@code NULL}, the event argument should not refer to an element of the
* {@code event_wait_list} array.
*
* @return {@link CL10#CL_SUCCESS SUCCESS} if the function is executed successfully. Otherwise, it returns one of the following errors:
*
*
* - {@link CL10#CL_INVALID_COMMAND_QUEUE INVALID_COMMAND_QUEUE} if {@code command_queue} is not a valid command-queue.
* - {@link CL10#CL_INVALID_CONTEXT INVALID_CONTEXT} if the context associated with {@code command_queue} and events in {@code event_wait_list} are not the same
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code num_svm_pointers} is zero or {@code svm_pointers} is {@code NULL}.
* - {@link CL10#CL_INVALID_VALUE INVALID_VALUE} if {@code sizes[i]} is non-zero range {@code [svm_pointers[i], svm_pointers[i]+sizes[i])} is not contained within an existing
* {@link CL20#clSVMAlloc SVMAlloc} allocation.
* - {@link CL10#CL_INVALID_EVENT_WAIT_LIST INVALID_EVENT_WAIT_LIST} if {@code event_wait_list} is {@code NULL} and {@code num_events_in_wait_list} > 0, or {@code event_wait_list} is not
* {@code NULL} and {@code num_events_in_wait_list} is 0, or if event objects in {@code event_wait_list} are not valid events.
* - {@link CL10#CL_OUT_OF_RESOURCES OUT_OF_RESOURCES} if there is a failure to allocate resources required by the OpenCL implementation on the device.
* - {@link CL10#CL_OUT_OF_HOST_MEMORY OUT_OF_HOST_MEMORY} if there is a failure to allocate resources required by the OpenCL implementation on the host.
*
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clEnqueueSVMMigrateMem(@NativeType("cl_command_queue") long command_queue, @NativeType("void const **") PointerBuffer svm_pointers, @Nullable @NativeType("size_t const *") PointerBuffer sizes, @NativeType("cl_mem_migration_flags") long flags, @Nullable @NativeType("cl_event const *") PointerBuffer event_wait_list, @Nullable @NativeType("cl_event *") PointerBuffer event) {
if (CHECKS) {
checkSafe(sizes, svm_pointers.remaining());
checkSafe(event, 1);
}
return nclEnqueueSVMMigrateMem(command_queue, svm_pointers.remaining(), memAddress(svm_pointers), memAddressSafe(sizes), flags, remainingSafe(event_wait_list), memAddressSafe(event_wait_list), memAddressSafe(event));
}
/**
* Array version of: {@link #clGetDeviceAndHostTimer GetDeviceAndHostTimer}
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetDeviceAndHostTimer(@NativeType("cl_device_id") long device, @NativeType("cl_ulong *") long[] device_timestamp, @NativeType("cl_ulong *") long[] host_timestamp) {
long __functionAddress = CL.getICD().clGetDeviceAndHostTimer;
if (CHECKS) {
check(__functionAddress);
check(device);
check(device_timestamp, 1);
check(host_timestamp, 1);
}
return callPPPI(device, device_timestamp, host_timestamp, __functionAddress);
}
/**
* Array version of: {@link #clGetHostTimer GetHostTimer}
*
* @see Reference Page
*/
@NativeType("cl_int")
public static int clGetHostTimer(@NativeType("cl_device_id") long device, @NativeType("cl_ulong *") long[] host_timestamp) {
long __functionAddress = CL.getICD().clGetHostTimer;
if (CHECKS) {
check(__functionAddress);
check(device);
check(host_timestamp, 1);
}
return callPPI(device, host_timestamp, __functionAddress);
}
/**
* Array version of: {@link #clCreateProgramWithIL CreateProgramWithIL}
*
* @see Reference Page
*/
@NativeType("cl_program")
public static long clCreateProgramWithIL(@NativeType("cl_context") long context, @NativeType("void const *") ByteBuffer il, @Nullable @NativeType("cl_int *") int[] errcode_ret) {
long __functionAddress = CL.getICD().clCreateProgramWithIL;
if (CHECKS) {
check(__functionAddress);
check(context);
checkSafe(errcode_ret, 1);
}
return callPPPPP(context, memAddress(il), (long)il.remaining(), errcode_ret, __functionAddress);
}
/**
* Array version of: {@link #clCloneKernel CloneKernel}
*
* @see Reference Page
*/
@NativeType("cl_kernel")
public static long clCloneKernel(@NativeType("cl_kernel") long source_kernel, @Nullable @NativeType("cl_int *") int[] errcode_ret) {
long __functionAddress = CL.getICD().clCloneKernel;
if (CHECKS) {
check(__functionAddress);
check(source_kernel);
checkSafe(errcode_ret, 1);
}
return callPPP(source_kernel, errcode_ret, __functionAddress);
}
}