To enqueue a command to execute a native C/C++ function not compiled using the OpenCL compiler, call the function
void (CL_CALLBACK* user_func)(void*),
const cl_mem* mem_list,
const void** args_mem_loc,
const cl_event* event_wait_list,
command_queue is a valid host command-queue. A native user function can only be executed on a command-queue created on a device that has
CL_EXEC_capability set in
CL_DEVICE_as specified in the Device Queries table.
user_func is a pointer to a host-callable user function. It is the application’s responsibility to ensure that the host-callable user function is thread-safe.
args is a pointer to the args list that user_func should be called with.
cb_args is the size in bytes of the args list that args points to.
num_mem_objects is the number of buffer objects that are passed in args.
mem_list is a list of valid buffer objects, if num_mem_objects > 0. The buffer object values specified in mem_list are memory object handles (
values) returned by clCreateBuffer or clCreateBufferWithProperties, or
args_mem_loc is a pointer to appropriate locations that args points to where memory object handles (
cl_memvalues) are stored. Before the user function is executed, the memory object handles are replaced by pointers to global memory.
event_wait_list, num_events_in_wait_list and event are as described in clEnqueueNDRangeKernel.
The data pointed to by args and cb_args bytes in size will be copied and
a pointer to this copied region will be passed to user_func.
The copy needs to be done because the memory objects (
cl_mem values) that
args may contain need to be modified and replaced by appropriate pointers
to global memory.
When clEnqueueNativeKernel returns, the memory region pointed to by args
can be reused by the application.
CL_SUCCESS if the user function execution
instance was successfully queued.
Otherwise, it returns one of the following errors:
CL_INVALID_if command_queue is not a valid host command-queue.
CL_INVALID_if context associated with command_queue and events in event_wait_list are not the same.
CL_INVALID_if user_func is
CL_INVALID_if args is a
NULLvalue and cb_args > 0, or if args is a
NULLvalue and num_mem_objects > 0.
CL_INVALID_if args is not
NULLand cb_args is 0.
CL_INVALID_if num_mem_objects > 0 and mem_list or args_mem_loc are
CL_INVALID_if num_mem_objects = 0 and mem_list or args_mem_loc are not
CL_INVALID_if the device associated with command_queue cannot execute the native kernel.
CL_INVALID_if one or more memory objects specified in mem_list are not valid or are not buffer objects.
CL_OUT_if there is a failure to queue the execution instance of kernel on the command-queue because of insufficient resources needed to execute the kernel.
CL_MEM_if there is a failure to allocate memory for data store associated with buffer objects specified as arguments to kernel.
OBJECT_ ALLOCATION_ FAILURE
CL_INVALID_if event_wait_list is
EVENT_ WAIT_ LIST
NULLand num_events_in_wait_list > 0, or event_wait_list is not
NULLand num_events_in_wait_list is 0, or if event objects in event_wait_list are not valid events.
CL_INVALID_if SVM pointers are passed as arguments to a kernel and the device does not support SVM or if system pointers are passed as arguments to a kernel and/or stored inside SVM allocations passed as kernel arguments and the device does not support fine grain system SVM allocations.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the host.
OF_ HOST_ MEMORY
The total number of read-only images specified as arguments to a kernel
The total number of read-write images specified as arguments to a kernel
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.