Skip to content

Commit f0d56e0

Browse files
committed
error consistency for clEnqueueMigrateMemObjects
1 parent e01c61d commit f0d56e0

1 file changed

Lines changed: 25 additions & 23 deletions

File tree

api/opencl_runtime_layer.asciidoc

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6545,32 +6545,34 @@ Improperly specified event dependencies passed to
65456545

65466546
// refError
65476547

6548-
{clEnqueueMigrateMemObjects} return {CL_SUCCESS} if the function is executed
6548+
{clEnqueueMigrateMemObjects} returns {CL_SUCCESS} if the function is executed
65496549
successfully.
65506550
Otherwise, it returns one of the following errors:
65516551

6552-
* {CL_INVALID_COMMAND_QUEUE} if _command_queue_ is not a valid host
6553-
command-queue.
6554-
* {CL_INVALID_CONTEXT} if the context associated with _command_queue_ and
6555-
memory objects in _mem_objects_ are not the same or if the context
6556-
associated with _command_queue_ and events in _event_wait_list_ are not
6557-
the same.
6558-
* {CL_INVALID_MEM_OBJECT} if any of the memory objects in _mem_objects_ is
6559-
not a valid memory object.
6560-
* {CL_INVALID_VALUE} if _num_mem_objects_ is zero or if _mem_objects_ is
6561-
`NULL`.
6562-
* {CL_INVALID_VALUE} if _flags_ is not 0 or is not any of the values
6563-
described in the table above.
6564-
* {CL_INVALID_EVENT_WAIT_LIST} if _event_wait_list_ is `NULL` and
6565-
_num_events_in_wait_list_ > 0, or _event_wait_list_ is not `NULL` and
6566-
_num_events_in_wait_list_ is 0, or if event objects in _event_wait_list_
6567-
are not valid events.
6568-
* {CL_MEM_OBJECT_ALLOCATION_FAILURE} if there is a failure to allocate
6569-
memory for the specified set of memory objects in _mem_objects_.
6570-
* {CL_OUT_OF_RESOURCES} if there is a failure to allocate resources required
6571-
by the OpenCL implementation on the device.
6572-
* {CL_OUT_OF_HOST_MEMORY} if there is a failure to allocate resources
6573-
required by the OpenCL implementation on the host.
6552+
* {CL_INVALID_COMMAND_QUEUE}
6553+
** if _command_queue_ is not a valid host command-queue
6554+
* {CL_INVALID_CONTEXT}
6555+
** if the context associated with _command_queue_ and memory objects in _mem_objects_ are not the same
6556+
** if the context associated with _command_queue_ and events in _event_wait_list_ are not the same
6557+
* {CL_INVALID_MEM_OBJECT}
6558+
** if any of the memory objects in _mem_objects_ is not a valid memory object
6559+
* {CL_INVALID_VALUE}
6560+
** if _num_mem_objects_ is zero
6561+
** if _mem_objects_ is `NULL`
6562+
** if _flags_ is not zero and is not a vakud combination of the values
6563+
described in the <<migration-flags-table,Memory migration Flags>> table
6564+
* {CL_INVALID_EVENT_WAIT_LIST}
6565+
** if _event_wait_list_ is `NULL` and _num_events_in_wait_list_ greater than zero
6566+
** if _event_wait_list_ is not `NULL` and _num_events_in_wait_list_ is zero
6567+
** if event objects in _event_wait_list_ are not valid events
6568+
* {CL_MEM_OBJECT_ALLOCATION_FAILURE}
6569+
** if there is a failure to allocate memory for the data store associated with a memory object in _mem_objects_
6570+
* {CL_OUT_OF_RESOURCES}
6571+
** if there is a failure to allocate resources required by the OpenCL
6572+
implementation on the device
6573+
* {CL_OUT_OF_HOST_MEMORY}
6574+
** if there is a failure to allocate resources required by the OpenCL
6575+
implementation on the host
65746576
--
65756577

65766578

0 commit comments

Comments
 (0)