Skip to content

Commit 890ec15

Browse files
aarongreigaarongreig
committed
Add new ERROR status for events, and corresponding error code.
1 parent ed949ec commit 890ec15

File tree

9 files changed

+222
-3
lines changed

9 files changed

+222
-3
lines changed

‎include/ur_api.h

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ typedef enum ur_result_t {
492492
UR_RESULT_ERROR_ADAPTER_SPECIFIC = 67, ///< An adapter specific warning/error has been reported and can be
493493
///< retrieved via the urPlatformGetLastError entry point.
494494
UR_RESULT_ERROR_LAYER_NOT_PRESENT = 68, ///< A requested layer was not found by the loader.
495+
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS = 69, ///< An event in the provided wait list has ::UR_EVENT_STATUS_ERROR.
495496
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP = 0x1000, ///< Invalid Command-Buffer
496497
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP = 0x1001, ///< Sync point is not valid for the command-buffer
497498
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP = 0x1002, ///< Sync point wait list is invalid
@@ -5603,6 +5604,7 @@ typedef enum ur_event_status_t {
56035604
UR_EVENT_STATUS_RUNNING = 1, ///< Command is running
56045605
UR_EVENT_STATUS_SUBMITTED = 2, ///< Command is submitted
56055606
UR_EVENT_STATUS_QUEUED = 3, ///< Command is queued
5607+
UR_EVENT_STATUS_ERROR = 4, ///< Command was abnormally terminated
56065608
/// @cond
56075609
UR_EVENT_STATUS_FORCE_UINT32 = 0x7fffffff
56085610
/// @endcond
@@ -5734,6 +5736,8 @@ urEventGetProfilingInfo(
57345736
/// + `NULL == phEventWaitList`
57355737
/// - ::UR_RESULT_ERROR_INVALID_VALUE
57365738
/// + `numEvents == 0`
5739+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
5740+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
57375741
/// - ::UR_RESULT_ERROR_INVALID_EVENT
57385742
/// - ::UR_RESULT_ERROR_INVALID_CONTEXT
57395743
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
@@ -5949,6 +5953,8 @@ urEventSetCallback(
59495953
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
59505954
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
59515955
/// + If event objects in phEventWaitList are not valid events.
5956+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
5957+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
59525958
/// - ::UR_RESULT_ERROR_INVALID_WORK_DIMENSION
59535959
/// - ::UR_RESULT_ERROR_INVALID_WORK_GROUP_SIZE
59545960
/// - ::UR_RESULT_ERROR_INVALID_VALUE
@@ -6005,6 +6011,8 @@ urEnqueueKernelLaunch(
60056011
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
60066012
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
60076013
/// + If event objects in phEventWaitList are not valid events.
6014+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6015+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
60086016
/// - ::UR_RESULT_ERROR_INVALID_VALUE
60096017
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
60106018
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6049,6 +6057,8 @@ urEnqueueEventsWait(
60496057
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
60506058
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
60516059
/// + If event objects in phEventWaitList are not valid events.
6060+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6061+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
60526062
/// - ::UR_RESULT_ERROR_INVALID_VALUE
60536063
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
60546064
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6092,6 +6102,8 @@ urEnqueueEventsWaitWithBarrier(
60926102
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
60936103
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
60946104
/// + If event objects in phEventWaitList are not valid events.
6105+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6106+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
60956107
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
60966108
/// - ::UR_RESULT_ERROR_INVALID_SIZE
60976109
/// + If `offset + size` results in an out-of-bounds access.
@@ -6141,6 +6153,8 @@ urEnqueueMemBufferRead(
61416153
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
61426154
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
61436155
/// + If event objects in phEventWaitList are not valid events.
6156+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6157+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
61446158
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
61456159
/// - ::UR_RESULT_ERROR_INVALID_SIZE
61466160
/// + If `offset + size` results in an out-of-bounds access.
@@ -6193,7 +6207,8 @@ urEnqueueMemBufferWrite(
61936207
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
61946208
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
61956209
/// + If event objects in phEventWaitList are not valid events.
6196-
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
6210+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6211+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
61976212
/// - ::UR_RESULT_ERROR_INVALID_SIZE
61986213
/// + `region.width == 0 || region.height == 0 || region.width == 0`
61996214
/// + `bufferRowPitch != 0 && bufferRowPitch < region.width`
@@ -6259,6 +6274,8 @@ urEnqueueMemBufferReadRect(
62596274
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
62606275
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
62616276
/// + If event objects in phEventWaitList are not valid events.
6277+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6278+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
62626279
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
62636280
/// - ::UR_RESULT_ERROR_INVALID_SIZE
62646281
/// + `region.width == 0 || region.height == 0 || region.width == 0`
@@ -6318,6 +6335,8 @@ urEnqueueMemBufferWriteRect(
63186335
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
63196336
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
63206337
/// + If event objects in phEventWaitList are not valid events.
6338+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6339+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
63216340
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
63226341
/// - ::UR_RESULT_ERROR_INVALID_SIZE
63236342
/// + If `srcOffset + size` results in an out-of-bounds access.
@@ -6364,6 +6383,8 @@ urEnqueueMemBufferCopy(
63646383
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
63656384
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
63666385
/// + If event objects in phEventWaitList are not valid events.
6386+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6387+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
63676388
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
63686389
/// - ::UR_RESULT_ERROR_INVALID_SIZE
63696390
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6422,6 +6443,8 @@ urEnqueueMemBufferCopyRect(
64226443
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
64236444
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
64246445
/// + If event objects in phEventWaitList are not valid events.
6446+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6447+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
64256448
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
64266449
/// - ::UR_RESULT_ERROR_INVALID_SIZE
64276450
/// + `patternSize == 0 || size == 0`
@@ -6477,6 +6500,8 @@ urEnqueueMemBufferFill(
64776500
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
64786501
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
64796502
/// + If event objects in phEventWaitList are not valid events.
6503+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6504+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
64806505
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
64816506
/// - ::UR_RESULT_ERROR_INVALID_SIZE
64826507
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6530,6 +6555,8 @@ urEnqueueMemImageRead(
65306555
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
65316556
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
65326557
/// + If event objects in phEventWaitList are not valid events.
6558+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6559+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
65336560
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
65346561
/// - ::UR_RESULT_ERROR_INVALID_SIZE
65356562
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6577,6 +6604,8 @@ urEnqueueMemImageWrite(
65776604
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
65786605
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
65796606
/// + If event objects in phEventWaitList are not valid events.
6607+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6608+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
65806609
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
65816610
/// - ::UR_RESULT_ERROR_INVALID_SIZE
65826611
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6663,6 +6692,8 @@ typedef enum ur_usm_migration_flag_t {
66636692
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
66646693
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
66656694
/// + If event objects in phEventWaitList are not valid events.
6695+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6696+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
66666697
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
66676698
/// - ::UR_RESULT_ERROR_INVALID_SIZE
66686699
/// + If `offset + size` results in an out-of-bounds access.
@@ -6711,6 +6742,8 @@ urEnqueueMemBufferMap(
67116742
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67126743
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67136744
/// + If event objects in phEventWaitList are not valid events.
6745+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6746+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67146747
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67156748
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
67166749
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6753,6 +6786,8 @@ urEnqueueMemUnmap(
67536786
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67546787
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67556788
/// + If event objects in phEventWaitList are not valid events.
6789+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6790+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67566791
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67576792
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
67586793
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6795,6 +6830,8 @@ urEnqueueUSMFill(
67956830
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67966831
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67976832
/// + If event objects in phEventWaitList are not valid events.
6833+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6834+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67986835
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67996836
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
68006837
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6842,6 +6879,8 @@ urEnqueueUSMMemcpy(
68426879
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
68436880
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
68446881
/// + If event objects in phEventWaitList are not valid events.
6882+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6883+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
68456884
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
68466885
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
68476886
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6924,6 +6963,8 @@ urEnqueueUSMAdvise(
69246963
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
69256964
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
69266965
/// + If event objects in phEventWaitList are not valid events.
6966+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6967+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
69276968
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
69286969
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
69296970
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6973,6 +7014,8 @@ urEnqueueUSMFill2D(
69737014
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
69747015
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
69757016
/// + If event objects in phEventWaitList are not valid events.
7017+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7018+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
69767019
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
69777020
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
69787021
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -7016,6 +7059,8 @@ urEnqueueUSMMemcpy2D(
70167059
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70177060
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70187061
/// + If event objects in phEventWaitList are not valid events.
7062+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7063+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70197064
UR_APIEXPORT ur_result_t UR_APICALL
70207065
urEnqueueDeviceGlobalVariableWrite(
70217066
ur_queue_handle_t hQueue, ///< [in] handle of the queue to submit to.
@@ -7053,6 +7098,8 @@ urEnqueueDeviceGlobalVariableWrite(
70537098
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70547099
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70557100
/// + If event objects in phEventWaitList are not valid events.
7101+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7102+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70567103
UR_APIEXPORT ur_result_t UR_APICALL
70577104
urEnqueueDeviceGlobalVariableRead(
70587105
ur_queue_handle_t hQueue, ///< [in] handle of the queue to submit to.
@@ -7089,6 +7136,8 @@ urEnqueueDeviceGlobalVariableRead(
70897136
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70907137
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70917138
/// + If event objects in phEventWaitList are not valid events.
7139+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7140+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70927141
UR_APIEXPORT ur_result_t UR_APICALL
70937142
urEnqueueReadHostPipe(
70947143
ur_queue_handle_t hQueue, ///< [in] a valid host command-queue in which the read command
@@ -7127,6 +7176,8 @@ urEnqueueReadHostPipe(
71277176
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
71287177
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
71297178
/// + If event objects in phEventWaitList are not valid events.
7179+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7180+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
71307181
UR_APIEXPORT ur_result_t UR_APICALL
71317182
urEnqueueWriteHostPipe(
71327183
ur_queue_handle_t hQueue, ///< [in] a valid host command-queue in which the write command

‎include/ur_print.hpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1539,6 +1539,9 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_result_t value) {
15391539
case UR_RESULT_ERROR_LAYER_NOT_PRESENT:
15401540
os << "UR_RESULT_ERROR_LAYER_NOT_PRESENT";
15411541
break;
1542+
case UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
1543+
os << "UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS";
1544+
break;
15421545
case UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP:
15431546
os << "UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP";
15441547
break;
@@ -8673,6 +8676,9 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_event_status_t value)
86738676
case UR_EVENT_STATUS_QUEUED:
86748677
os << "UR_EVENT_STATUS_QUEUED";
86758678
break;
8679+
case UR_EVENT_STATUS_ERROR:
8680+
os << "UR_EVENT_STATUS_ERROR";
8681+
break;
86768682
default:
86778683
os << "unknown enumerator";
86788684
break;

‎scripts/core/common.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,8 @@ etors:
274274
via the urPlatformGetLastError entry point."
275275
- name: ERROR_LAYER_NOT_PRESENT
276276
desc: "A requested layer was not found by the loader."
277+
- name: ERROR_IN_EVENT_LIST_EXEC_STATUS
278+
desc: "An event in the provided wait list has $X_EVENT_STATUS_ERROR."
277279
- name: ERROR_UNKNOWN
278280
value: "0x7ffffffe"
279281
desc: "Unknown or internal error"

0 commit comments

Comments
 (0)