Skip to content

Commit 0c0f48d

Browse files
aarongreigaarongreig
authored
Merge pull request #1467 from aarongreig/aaron/eventExecStatusError
Add new ERROR status for events, and corresponding error code.
2 parents d7ce779 + d80a365 commit 0c0f48d

File tree

9 files changed

+222
-0
lines changed

9 files changed

+222
-0
lines changed

‎include/ur_api.h‎

Lines changed: 52 additions & 0 deletions
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,6 +6207,8 @@ urEnqueueMemBufferWrite(
61936207
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
61946208
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
61956209
/// + If event objects in phEventWaitList are not valid events.
6210+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6211+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
61966212
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
61976213
/// - ::UR_RESULT_ERROR_INVALID_SIZE
61986214
/// + `region.width == 0 || region.height == 0 || region.width == 0`
@@ -6259,6 +6275,8 @@ urEnqueueMemBufferReadRect(
62596275
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
62606276
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
62616277
/// + If event objects in phEventWaitList are not valid events.
6278+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6279+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
62626280
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
62636281
/// - ::UR_RESULT_ERROR_INVALID_SIZE
62646282
/// + `region.width == 0 || region.height == 0 || region.width == 0`
@@ -6318,6 +6336,8 @@ urEnqueueMemBufferWriteRect(
63186336
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
63196337
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
63206338
/// + If event objects in phEventWaitList are not valid events.
6339+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6340+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
63216341
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
63226342
/// - ::UR_RESULT_ERROR_INVALID_SIZE
63236343
/// + If `srcOffset + size` results in an out-of-bounds access.
@@ -6364,6 +6384,8 @@ urEnqueueMemBufferCopy(
63646384
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
63656385
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
63666386
/// + If event objects in phEventWaitList are not valid events.
6387+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6388+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
63676389
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
63686390
/// - ::UR_RESULT_ERROR_INVALID_SIZE
63696391
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6422,6 +6444,8 @@ urEnqueueMemBufferCopyRect(
64226444
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
64236445
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
64246446
/// + If event objects in phEventWaitList are not valid events.
6447+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6448+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
64256449
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
64266450
/// - ::UR_RESULT_ERROR_INVALID_SIZE
64276451
/// + `patternSize == 0 || size == 0`
@@ -6477,6 +6501,8 @@ urEnqueueMemBufferFill(
64776501
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
64786502
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
64796503
/// + If event objects in phEventWaitList are not valid events.
6504+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6505+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
64806506
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
64816507
/// - ::UR_RESULT_ERROR_INVALID_SIZE
64826508
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6530,6 +6556,8 @@ urEnqueueMemImageRead(
65306556
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
65316557
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
65326558
/// + If event objects in phEventWaitList are not valid events.
6559+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6560+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
65336561
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
65346562
/// - ::UR_RESULT_ERROR_INVALID_SIZE
65356563
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6577,6 +6605,8 @@ urEnqueueMemImageWrite(
65776605
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
65786606
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
65796607
/// + If event objects in phEventWaitList are not valid events.
6608+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6609+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
65806610
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
65816611
/// - ::UR_RESULT_ERROR_INVALID_SIZE
65826612
/// + `region.width == 0 || region.height == 0 || region.depth == 0`
@@ -6663,6 +6693,8 @@ typedef enum ur_usm_migration_flag_t {
66636693
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
66646694
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
66656695
/// + If event objects in phEventWaitList are not valid events.
6696+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6697+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
66666698
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
66676699
/// - ::UR_RESULT_ERROR_INVALID_SIZE
66686700
/// + If `offset + size` results in an out-of-bounds access.
@@ -6711,6 +6743,8 @@ urEnqueueMemBufferMap(
67116743
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67126744
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67136745
/// + If event objects in phEventWaitList are not valid events.
6746+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6747+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67146748
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67156749
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
67166750
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6753,6 +6787,8 @@ urEnqueueMemUnmap(
67536787
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67546788
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67556789
/// + If event objects in phEventWaitList are not valid events.
6790+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6791+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67566792
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67576793
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
67586794
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6795,6 +6831,8 @@ urEnqueueUSMFill(
67956831
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
67966832
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
67976833
/// + If event objects in phEventWaitList are not valid events.
6834+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6835+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
67986836
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
67996837
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
68006838
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6842,6 +6880,8 @@ urEnqueueUSMMemcpy(
68426880
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
68436881
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
68446882
/// + If event objects in phEventWaitList are not valid events.
6883+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6884+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
68456885
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
68466886
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
68476887
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6924,6 +6964,8 @@ urEnqueueUSMAdvise(
69246964
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
69256965
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
69266966
/// + If event objects in phEventWaitList are not valid events.
6967+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
6968+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
69276969
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
69286970
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
69296971
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -6973,6 +7015,8 @@ urEnqueueUSMFill2D(
69737015
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
69747016
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
69757017
/// + If event objects in phEventWaitList are not valid events.
7018+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7019+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
69767020
/// - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
69777021
/// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
69787022
/// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
@@ -7016,6 +7060,8 @@ urEnqueueUSMMemcpy2D(
70167060
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70177061
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70187062
/// + If event objects in phEventWaitList are not valid events.
7063+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7064+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70197065
UR_APIEXPORT ur_result_t UR_APICALL
70207066
urEnqueueDeviceGlobalVariableWrite(
70217067
ur_queue_handle_t hQueue, ///< [in] handle of the queue to submit to.
@@ -7053,6 +7099,8 @@ urEnqueueDeviceGlobalVariableWrite(
70537099
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70547100
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70557101
/// + If event objects in phEventWaitList are not valid events.
7102+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7103+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70567104
UR_APIEXPORT ur_result_t UR_APICALL
70577105
urEnqueueDeviceGlobalVariableRead(
70587106
ur_queue_handle_t hQueue, ///< [in] handle of the queue to submit to.
@@ -7089,6 +7137,8 @@ urEnqueueDeviceGlobalVariableRead(
70897137
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
70907138
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
70917139
/// + If event objects in phEventWaitList are not valid events.
7140+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7141+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
70927142
UR_APIEXPORT ur_result_t UR_APICALL
70937143
urEnqueueReadHostPipe(
70947144
ur_queue_handle_t hQueue, ///< [in] a valid host command-queue in which the read command
@@ -7127,6 +7177,8 @@ urEnqueueReadHostPipe(
71277177
/// + `phEventWaitList == NULL && numEventsInWaitList > 0`
71287178
/// + `phEventWaitList != NULL && numEventsInWaitList == 0`
71297179
/// + If event objects in phEventWaitList are not valid events.
7180+
/// - ::UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
7181+
/// + An event in `phEventWaitList` has ::UR_EVENT_STATUS_ERROR.
71307182
UR_APIEXPORT ur_result_t UR_APICALL
71317183
urEnqueueWriteHostPipe(
71327184
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)