Sets the execution status of a user event object.
cl_int clSetUserEventStatus(cl_event event, cl_int execution_status)
A user event object created using
Specifies the new execution status to be set and can be
CL_COMPLETEor a negative integer value to indicate an error. A negative integer value causes all enqueued commands that wait on this user event to be terminated.
clSetUserEventStatuscan only be called once to change the execution status of
If there are enqueued commands with user events in the
event_wait_list argument of
clEnqueue*** commands, the user must ensure that the status of these user events being waited on are set using
clSetUserEventStatus before any OpenCL APIs that release OpenCL objects except for event objects are called; otherwise the behavior is undefined.
CL_SUCCESS if the function was executed successfully.
Otherwise, it returns one of the following errors
eventis not a valid user event.
CL_COMPLETEor a negative integer value.
eventhas already been changed by a previous call to
CL_OUT_OF_RESOURCESif there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.
For example, the following code sequence will result in undefined behavior of
ev1 = clCreateUserEvent(ctx, NULL); clEnqueueWriteBuffer(cq, buf1, CL_FALSE, ..., 1, &ev1, NULL; clEnqueueWriteBuffer(cq, buf2, CL_FALSE,...); clReleaseMemObject(buf2); clSetUserEventStatus(ev1, CL_COMPLETE);
The following code sequence, however, works correctly.
ev1 = clCreateUserEvent(ctx, NULL); clEnqueueWriteBuffer(cq, buf1, CL_FALSE, ..., 1, &ev1, NULL; clEnqueueWriteBuffer(cq, buf2, CL_FALSE,...); clSetUserEventStatus(ev1, CL_COMPLETE); clReleaseMemObject(buf2);