Skip to content

Commit 3d3742f

Browse files
RossBruntonRossBrunton
authored
Merge pull request #2195 from RossBrunton/ross/specevent
Update spec to clarify event list contents
2 parents d9a01d2 + c3d795c commit 3d3742f

14 files changed

+496
-244
lines changed

‎include/ur_api.h

Lines changed: 66 additions & 30 deletions
Large diffs are not rendered by default.

‎scripts/core/enqueue.yml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ params:
5151
- type: $x_event_handle_t*
5252
name: phEvent
5353
desc: |
54-
[out][optional] return an event object that identifies this particular kernel execution instance.
54+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
5555
returns:
5656
- $X_RESULT_ERROR_INVALID_QUEUE
5757
- $X_RESULT_ERROR_INVALID_KERNEL
@@ -96,7 +96,7 @@ params:
9696
- type: $x_event_handle_t*
9797
name: phEvent
9898
desc: |
99-
[out][optional] return an event object that identifies this particular command instance.
99+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
100100
returns:
101101
- $X_RESULT_ERROR_INVALID_QUEUE
102102
- $X_RESULT_ERROR_INVALID_EVENT
@@ -137,7 +137,7 @@ params:
137137
- type: $x_event_handle_t*
138138
name: phEvent
139139
desc: |
140-
[out][optional] return an event object that identifies this particular command instance.
140+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
141141
returns:
142142
- $X_RESULT_ERROR_INVALID_QUEUE
143143
- $X_RESULT_ERROR_INVALID_EVENT
@@ -190,7 +190,7 @@ params:
190190
- type: $x_event_handle_t*
191191
name: phEvent
192192
desc: |
193-
[out][optional] return an event object that identifies this particular command instance.
193+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
194194
returns:
195195
- $X_RESULT_ERROR_INVALID_QUEUE
196196
- $X_RESULT_ERROR_INVALID_EVENT
@@ -245,7 +245,7 @@ params:
245245
- type: $x_event_handle_t*
246246
name: phEvent
247247
desc: |
248-
[out][optional] return an event object that identifies this particular command instance.
248+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
249249
returns:
250250
- $X_RESULT_ERROR_INVALID_QUEUE
251251
- $X_RESULT_ERROR_INVALID_EVENT
@@ -316,7 +316,7 @@ params:
316316
- type: $x_event_handle_t*
317317
name: phEvent
318318
desc: |
319-
[out][optional] return an event object that identifies this particular command instance.
319+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
320320
returns:
321321
- $X_RESULT_ERROR_INVALID_QUEUE
322322
- $X_RESULT_ERROR_INVALID_EVENT
@@ -394,7 +394,7 @@ params:
394394
- type: $x_event_handle_t*
395395
name: phEvent
396396
desc: |
397-
[out][optional] return an event object that identifies this particular command instance.
397+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
398398
returns:
399399
- $X_RESULT_ERROR_INVALID_QUEUE
400400
- $X_RESULT_ERROR_INVALID_EVENT
@@ -454,7 +454,7 @@ params:
454454
- type: $x_event_handle_t*
455455
name: phEvent
456456
desc: |
457-
[out][optional] return an event object that identifies this particular command instance.
457+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
458458
returns:
459459
- $X_RESULT_ERROR_INVALID_QUEUE
460460
- $X_RESULT_ERROR_INVALID_EVENT
@@ -520,7 +520,7 @@ params:
520520
- type: $x_event_handle_t*
521521
name: phEvent
522522
desc: |
523-
[out][optional] return an event object that identifies this particular command instance.
523+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
524524
returns:
525525
- $X_RESULT_ERROR_INVALID_QUEUE
526526
- $X_RESULT_ERROR_INVALID_EVENT
@@ -581,7 +581,7 @@ params:
581581
- type: $x_event_handle_t*
582582
name: phEvent
583583
desc: |
584-
[out][optional] return an event object that identifies this particular command instance.
584+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
585585
returns:
586586
- $X_RESULT_ERROR_INVALID_QUEUE
587587
- $X_RESULT_ERROR_INVALID_EVENT
@@ -647,7 +647,7 @@ params:
647647
- type: $x_event_handle_t*
648648
name: phEvent
649649
desc: |
650-
[out][optional] return an event object that identifies this particular command instance.
650+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
651651
returns:
652652
- $X_RESULT_ERROR_INVALID_QUEUE
653653
- $X_RESULT_ERROR_INVALID_EVENT
@@ -708,7 +708,7 @@ params:
708708
- type: $x_event_handle_t*
709709
name: phEvent
710710
desc: |
711-
[out][optional] return an event object that identifies this particular command instance.
711+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
712712
returns:
713713
- $X_RESULT_ERROR_INVALID_QUEUE
714714
- $X_RESULT_ERROR_INVALID_EVENT
@@ -761,7 +761,7 @@ params:
761761
- type: $x_event_handle_t*
762762
name: phEvent
763763
desc: |
764-
[out][optional] return an event object that identifies this particular command instance.
764+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
765765
returns:
766766
- $X_RESULT_ERROR_INVALID_QUEUE
767767
- $X_RESULT_ERROR_INVALID_EVENT
@@ -817,7 +817,7 @@ params:
817817
- type: $x_event_handle_t*
818818
name: phEvent
819819
desc: |
820-
[out][optional] return an event object that identifies this particular command instance.
820+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
821821
returns:
822822
- $X_RESULT_ERROR_INVALID_QUEUE
823823
- $X_RESULT_ERROR_INVALID_EVENT
@@ -896,7 +896,7 @@ params:
896896
- type: $x_event_handle_t*
897897
name: phEvent
898898
desc: |
899-
[out][optional] return an event object that identifies this particular command instance.
899+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
900900
- type: void**
901901
name: ppRetMap
902902
desc: "[out] return mapped pointer. TODO: move it before numEventsInWaitList?"
@@ -966,7 +966,7 @@ params:
966966
- type: $x_event_handle_t*
967967
name: phEvent
968968
desc: |
969-
[out][optional] return an event object that identifies this particular command instance.
969+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
970970
returns:
971971
- $X_RESULT_ERROR_INVALID_QUEUE
972972
- $X_RESULT_ERROR_INVALID_EVENT
@@ -1008,7 +1008,7 @@ params:
10081008
- type: $x_event_handle_t*
10091009
name: phEvent
10101010
desc: |
1011-
[out][optional] return an event object that identifies this particular command instance.
1011+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
10121012
returns:
10131013
- $X_RESULT_ERROR_INVALID_QUEUE
10141014
- $X_RESULT_ERROR_INVALID_EVENT
@@ -1054,7 +1054,7 @@ params:
10541054
- type: $x_event_handle_t*
10551055
name: phEvent
10561056
desc: |
1057-
[out][optional] return an event object that identifies this particular command instance.
1057+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
10581058
returns:
10591059
- $X_RESULT_ERROR_INVALID_QUEUE
10601060
- $X_RESULT_ERROR_INVALID_EVENT
@@ -1105,7 +1105,7 @@ params:
11051105
- type: $x_event_handle_t*
11061106
name: phEvent
11071107
desc: |
1108-
[out][optional] return an event object that identifies this particular command instance.
1108+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
11091109
returns:
11101110
- $X_RESULT_ERROR_INVALID_QUEUE
11111111
- $X_RESULT_ERROR_INVALID_EVENT
@@ -1153,7 +1153,7 @@ params:
11531153
- type: $x_event_handle_t*
11541154
name: phEvent
11551155
desc: |
1156-
[out][optional] return an event object that identifies this particular command instance.
1156+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
11571157
returns:
11581158
- $X_RESULT_ERROR_INVALID_QUEUE
11591159
- $X_RESULT_ERROR_INVALID_EVENT
@@ -1242,7 +1242,7 @@ params:
12421242
- type: $x_event_handle_t*
12431243
name: phEvent
12441244
desc: |
1245-
[out][optional] return an event object that identifies this particular kernel execution instance.
1245+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
12461246
returns:
12471247
- $X_RESULT_ERROR_INVALID_SIZE:
12481248
- "`pitch == 0`"
@@ -1306,7 +1306,7 @@ params:
13061306
- type: $x_event_handle_t*
13071307
name: phEvent
13081308
desc: |
1309-
[out][optional] return an event object that identifies this particular kernel execution instance.
1309+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
13101310
returns:
13111311
- $X_RESULT_ERROR_INVALID_SIZE:
13121312
- "`srcPitch == 0`"
@@ -1365,7 +1365,7 @@ params:
13651365
- type: $x_event_handle_t*
13661366
name: phEvent
13671367
desc: |
1368-
[out][optional] return an event object that identifies this particular kernel execution instance.
1368+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
13691369
returns:
13701370
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
13711371
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
@@ -1412,7 +1412,7 @@ params:
14121412
- type: $x_event_handle_t*
14131413
name: phEvent
14141414
desc: |
1415-
[out][optional] return an event object that identifies this particular kernel execution instance.
1415+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
14161416
returns:
14171417
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
14181418
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
@@ -1460,7 +1460,7 @@ params:
14601460
name: phEvent
14611461
desc: |
14621462
[out][optional] returns an event object that identifies this read command
1463-
and can be used to query or queue a wait for this command to complete.
1463+
and can be used to query or queue a wait for this command to complete. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
14641464
returns:
14651465
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
14661466
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
@@ -1508,7 +1508,7 @@ params:
15081508
name: phEvent
15091509
desc: |
15101510
[out][optional] returns an event object that identifies this write command
1511-
and can be used to query or queue a wait for this command to complete.
1511+
and can be used to query or queue a wait for this command to complete. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
15121512
returns:
15131513
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
15141514
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"

‎scripts/core/exp-bindless-images.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ params:
581581
- type: $x_event_handle_t*
582582
name: phEvent
583583
desc: |
584-
[out][optional] return an event object that identifies this particular command instance.
584+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
585585
returns:
586586
- $X_RESULT_ERROR_INVALID_QUEUE
587587
- $X_RESULT_ERROR_INVALID_VALUE
@@ -870,7 +870,7 @@ params:
870870
- type: $x_event_handle_t*
871871
name: phEvent
872872
desc: |
873-
[out][optional] return an event object that identifies this particular command instance.
873+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
874874
returns:
875875
- $X_RESULT_ERROR_INVALID_QUEUE
876876
- $X_RESULT_ERROR_INVALID_VALUE
@@ -909,7 +909,7 @@ params:
909909
- type: $x_event_handle_t*
910910
name: phEvent
911911
desc: |
912-
[out][optional] return an event object that identifies this particular command instance.
912+
[out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
913913
returns:
914914
- $X_RESULT_ERROR_INVALID_QUEUE
915915
- $X_RESULT_ERROR_INVALID_VALUE

‎scripts/core/exp-command-buffer.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1140,7 +1140,7 @@ params:
11401140
- type: $x_event_handle_t*
11411141
name: phEvent
11421142
desc: |
1143-
[out][optional] return an event object that identifies this particular command-buffer execution instance.
1143+
[out][optional] return an event object that identifies this particular command-buffer execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
11441144
returns:
11451145
- $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
11461146
- $X_RESULT_ERROR_INVALID_QUEUE

‎scripts/core/exp-cooperative-kernels.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ params:
5555
- type: $x_event_handle_t*
5656
name: phEvent
5757
desc: |
58-
[out][optional] return an event object that identifies this particular kernel execution instance.
58+
[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
5959
returns:
6060
- $X_RESULT_ERROR_INVALID_QUEUE
6161
- $X_RESULT_ERROR_INVALID_KERNEL

‎scripts/core/exp-enqueue-timestamp-recording.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ params:
5959
[in,out] return an event object that identifies this particular kernel execution instance. Profiling information can be queried
6060
from this event as if `hQueue` had profiling enabled. Querying `UR_PROFILING_INFO_COMMAND_QUEUED` or `UR_PROFILING_INFO_COMMAND_SUBMIT`
6161
reports the timestamp at the time of the call to this function. Querying `UR_PROFILING_INFO_COMMAND_START` or `UR_PROFILING_INFO_COMMAND_END`
62-
reports the timestamp recorded when the command is executed on the device.
62+
reports the timestamp recorded when the command is executed on the device. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
6363
returns:
6464
- $X_RESULT_ERROR_INVALID_NULL_HANDLE
6565
- $X_RESULT_ERROR_INVALID_NULL_POINTER

‎scripts/core/exp-launch-properties.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ params:
102102
desc: "[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. "
103103
- type: ur_event_handle_t*
104104
name: phEvent
105-
desc: "[out][optional] return an event object that identifies this particular kernel execution instance."
105+
desc: "[out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array."
106106
returns:
107107
- $X_RESULT_SUCCESS
108108
- $X_RESULT_ERROR_UNINITIALIZED

‎scripts/core/exp-native-enqueue.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ params:
112112
name: phEvent
113113
desc: |
114114
[out][optional] return an event object that identifies the work that has
115-
been enqueued in nativeEnqueueFunc.
115+
been enqueued in nativeEnqueueFunc. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
116116
returns:
117117
- $X_RESULT_ERROR_INVALID_NULL_HANDLE
118118
- $X_RESULT_ERROR_INVALID_NULL_POINTER

0 commit comments

Comments
 (0)