-
Notifications
You must be signed in to change notification settings - Fork 111
/
enqueue.yml
1518 lines (1518 loc) · 63.8 KB
/
enqueue.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (C) 2021 Intel Corporation
#
# Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
# See LICENSE.TXT
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
# See YaML.md for syntax definition
#
--- #--------------------------------------------------------------------------
type: header
desc: "Intel $OneApi Unified Runtime APIs"
ordinal: "10"
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to execute a kernel"
class: $xEnqueue
name: KernelLaunch
ordinal: "0"
analogue:
- "**clEnqueueNDRangeKernel**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_kernel_handle_t
name: hKernel
desc: "[in] handle of the kernel object"
- type: uint32_t
name: workDim
desc: "[in] number of dimensions, from 1 to 3, to specify the global and work-group work-items"
- type: "const size_t*"
name: pGlobalWorkOffset
desc: "[in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item"
- type: "const size_t*"
name: pGlobalWorkSize
desc: "[in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function"
- type: "const size_t*"
name: pLocalWorkSize
desc: |
[in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function.
If nullptr, the runtime implementation will choose the work-group size.
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
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.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular kernel execution instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_KERNEL
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_WORK_DIMENSION
- $X_RESULT_ERROR_INVALID_WORK_GROUP_SIZE
- $X_RESULT_ERROR_INVALID_VALUE
- $X_RESULT_ERROR_INVALID_KERNEL_ARGS
- "The kernel argument values have not been specified."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command which waits a list of events to complete before it completes"
class: $xEnqueue
name: EventsWait
ordinal: "0"
details:
- "If the event list is empty, it waits for all previously enqueued commands to complete."
- "It returns an event which can be waited on."
analogue:
- "**clEnqueueMarkerWithWaitList**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands
must be complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_VALUE
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a barrier command which waits a list of events to complete before it completes"
class: $xEnqueue
name: EventsWaitWithBarrier
ordinal: "0"
details:
- "If the event list is empty, it waits for all previously enqueued commands to complete."
- "It blocks command execution - any following commands enqueued after it do not execute until it completes."
- "It returns an event which can be waited on."
analogue:
- "**clEnqueueBarrierWithWaitList**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands
must be complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_VALUE
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to read from a buffer object to host memory"
class: $xEnqueue
name: MemBufferRead
ordinal: "0"
details:
- "Input parameter blockingRead indicates if the read is blocking or non-blocking."
analogue:
- "**clEnqueueReadBuffer**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(offset, size)] handle of the buffer object"
- type: bool
name: blockingRead
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: size_t
name: offset
desc: "[in] offset in bytes in the buffer object"
- type: size_t
name: size
desc: "[in] size in bytes of data being read"
- type: void*
name: pDst
desc: "[in] pointer to host memory where data is to be read into"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "If `offset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to write into a buffer object from host memory"
class: $xEnqueue
name: MemBufferWrite
ordinal: "0"
details:
- "Input parameter blockingWrite indicates if the write is blocking or non-blocking."
analogue:
- "**clEnqueueWriteBuffer**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(offset, size)] handle of the buffer object"
- type: bool
name: blockingWrite
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: size_t
name: offset
desc: "[in] offset in bytes in the buffer object"
- type: size_t
name: size
desc: "[in] size in bytes of data being written"
- type: "const void*"
name: pSrc
desc: "[in] pointer to host memory where data is to be written from"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "If `offset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to read a 2D or 3D rectangular region from a buffer object to host memory"
class: $xEnqueue
name: MemBufferReadRect
ordinal: "0"
details:
- "Input parameter blockingRead indicates if the read is blocking or non-blocking."
- "The buffer and host 2D or 3D rectangular regions can have different shapes."
analogue:
- "**clEnqueueReadBufferRect**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(bufferOrigin, region)] handle of the buffer object"
- type: bool
name: blockingRead
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_rect_offset_t
name: bufferOrigin
desc: "[in] 3D offset in the buffer"
- type: $x_rect_offset_t
name: hostOrigin
desc: "[in] 3D offset in the host region"
- type: $x_rect_region_t
name: region
desc: "[in] 3D rectangular region descriptor: width, height, depth"
- type: size_t
name: bufferRowPitch
desc: "[in] length of each row in bytes in the buffer object"
- type: size_t
name: bufferSlicePitch
desc: "[in] length of each 2D slice in bytes in the buffer object being read"
- type: size_t
name: hostRowPitch
desc: "[in] length of each row in bytes in the host memory region pointed by dst"
- type: size_t
name: hostSlicePitch
desc: "[in] length of each 2D slice in bytes in the host memory region pointed by dst"
- type: void*
name: pDst
desc: "[in] pointer to host memory where data is to be read into"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.width == 0`"
- "`bufferRowPitch != 0 && bufferRowPitch < region.width`"
- "`hostRowPitch != 0 && hostRowPitch < region.width`"
- "`bufferSlicePitch != 0 && bufferSlicePitch < region.height * (bufferRowPitch != 0 ? bufferRowPitch : region.width)`"
- "`bufferSlicePitch != 0 && bufferSlicePitch % (bufferRowPitch != 0 ? bufferRowPitch : region.width) != 0`"
- "`hostSlicePitch != 0 && hostSlicePitch < region.height * (hostRowPitch != 0 ? hostRowPitch : region.width)`"
- "`hostSlicePitch != 0 && hostSlicePitch % (hostRowPitch != 0 ? hostRowPitch : region.width) != 0`"
- "If the combination of `bufferOrigin`, `region`, `bufferRowPitch`, and `bufferSlicePitch` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to write a 2D or 3D rectangular region in a buffer object from host memory"
class: $xEnqueue
name: MemBufferWriteRect
ordinal: "0"
details:
- "Input parameter blockingWrite indicates if the write is blocking or non-blocking."
- "The buffer and host 2D or 3D rectangular regions can have different shapes."
analogue:
- "**clEnqueueWriteBufferRect**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(bufferOrigin, region)] handle of the buffer object"
- type: bool
name: blockingWrite
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_rect_offset_t
name: bufferOrigin
desc: "[in] 3D offset in the buffer"
- type: $x_rect_offset_t
name: hostOrigin
desc: "[in] 3D offset in the host region"
- type: $x_rect_region_t
name: region
desc: "[in] 3D rectangular region descriptor: width, height, depth"
- type: size_t
name: bufferRowPitch
desc: "[in] length of each row in bytes in the buffer object"
- type: size_t
name: bufferSlicePitch
desc: "[in] length of each 2D slice in bytes in the buffer object being written"
- type: size_t
name: hostRowPitch
desc: "[in] length of each row in bytes in the host memory region pointed by src"
- type: size_t
name: hostSlicePitch
desc: "[in] length of each 2D slice in bytes in the host memory region pointed by src"
- type: void*
name: pSrc
desc: "[in] pointer to host memory where data is to be written from"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] points to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.width == 0`"
- "`bufferRowPitch != 0 && bufferRowPitch < region.width`"
- "`hostRowPitch != 0 && hostRowPitch < region.width`"
- "`bufferSlicePitch != 0 && bufferSlicePitch < region.height * (bufferRowPitch != 0 ? bufferRowPitch : region.width)`"
- "`bufferSlicePitch != 0 && bufferSlicePitch % (bufferRowPitch != 0 ? bufferRowPitch : region.width) != 0`"
- "`hostSlicePitch != 0 && hostSlicePitch < region.height * (hostRowPitch != 0 ? hostRowPitch : region.width)`"
- "`hostSlicePitch != 0 && hostSlicePitch % (hostRowPitch != 0 ? hostRowPitch : region.width) != 0`"
- "If the combination of `bufferOrigin`, `region`, `bufferRowPitch`, and `bufferSlicePitch` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to copy from a buffer object to another"
class: $xEnqueue
name: MemBufferCopy
ordinal: "0"
analogue:
- "**clEnqueueCopyBuffer**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBufferSrc
desc: "[in][bounds(srcOffset, size)] handle of the src buffer object"
- type: $x_mem_handle_t
name: hBufferDst
desc: "[in][bounds(dstOffset, size)] handle of the dest buffer object"
- type: size_t
name: srcOffset
desc: "[in] offset into hBufferSrc to begin copying from"
- type: size_t
name: dstOffset
desc: "[in] offset info hBufferDst to begin copying into"
- type: size_t
name: size
desc: "[in] size in bytes of data being copied"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "If `srcOffset + size` results in an out-of-bounds access."
- "If `dstOffset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to copy a 2D or 3D rectangular region from one buffer object to another"
class: $xEnqueue
name: MemBufferCopyRect
ordinal: "0"
analogue:
- "**clEnqueueCopyBufferRect**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBufferSrc
desc: "[in][bounds(srcOrigin, region)] handle of the source buffer object"
- type: $x_mem_handle_t
name: hBufferDst
desc: "[in][bounds(dstOrigin, region)] handle of the dest buffer object"
- type: $x_rect_offset_t
name: srcOrigin
desc: "[in] 3D offset in the source buffer"
- type: $x_rect_offset_t
name: dstOrigin
desc: "[in] 3D offset in the destination buffer"
- type: $x_rect_region_t
name: region
desc: "[in] source 3D rectangular region descriptor: width, height, depth"
- type: size_t
name: srcRowPitch
desc: "[in] length of each row in bytes in the source buffer object"
- type: size_t
name: srcSlicePitch
desc: "[in] length of each 2D slice in bytes in the source buffer object"
- type: size_t
name: dstRowPitch
desc: "[in] length of each row in bytes in the destination buffer object"
- type: size_t
name: dstSlicePitch
desc: "[in] length of each 2D slice in bytes in the destination buffer object"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.depth == 0`"
- "`srcRowPitch != 0 && srcRowPitch < region.width`"
- "`dstRowPitch != 0 && dstRowPitch < region.width`"
- "`srcSlicePitch != 0 && srcSlicePitch < region.height * (srcRowPitch != 0 ? srcRowPitch : region.width)`"
- "`srcSlicePitch != 0 && srcSlicePitch % (srcRowPitch != 0 ? srcRowPitch : region.width) != 0`"
- "`dstSlicePitch != 0 && dstSlicePitch < region.height * (dstRowPitch != 0 ? dstRowPitch : region.width)`"
- "`dstSlicePitch != 0 && dstSlicePitch % (dstRowPitch != 0 ? dstRowPitch : region.width) != 0`"
- "If the combination of `srcOrigin`, `region`, `srcRowPitch`, and `srcSlicePitch` results in an out-of-bounds access."
- "If the combination of `dstOrigin`, `region`, `dstRowPitch`, and `dstSlicePitch` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to fill a buffer object with a pattern of a given size"
class: $xEnqueue
name: MemBufferFill
ordinal: "0"
analogue:
- "**clEnqueueFillBuffer**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(offset, size)] handle of the buffer object"
- type: "const void*"
name: pPattern
desc: "[in] pointer to the fill pattern"
- type: size_t
name: patternSize
desc: "[in] size in bytes of the pattern"
- type: size_t
name: offset
desc: "[in] offset into the buffer"
- type: size_t
name: size
desc: "[in] fill size in bytes, must be a multiple of patternSize"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`patternSize == 0 || size == 0`"
- "`patternSize > size`"
- "`(patternSize & (patternSize - 1)) != 0`"
- "`size % patternSize != 0`"
- "`offset % patternSize != 0`"
- "If `offset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to read from an image or image array object to host memory"
class: $xEnqueue
name: MemImageRead
ordinal: "0"
details:
- "Input parameter blockingRead indicates if the read is blocking or non-blocking."
analogue:
- "**clEnqueueReadImage**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hImage
desc: "[in][bounds(origin, region)] handle of the image object"
- type: bool
name: blockingRead
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_rect_offset_t
name: origin
desc: "[in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image"
- type: $x_rect_region_t
name: region
desc: "[in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image"
- type: size_t
name: rowPitch
desc: "[in] length of each row in bytes"
- type: size_t
name: slicePitch
desc: "[in] length of each 2D slice of the 3D image"
- type: void*
name: pDst
desc: "[in] pointer to host memory where image is to be read into"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.depth == 0`"
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to write an image or image array object from host memory"
class: $xEnqueue
name: MemImageWrite
ordinal: "0"
details:
- "Input parameter blockingWrite indicates if the write is blocking or non-blocking."
analogue:
- "**clEnqueueWriteImage**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hImage
desc: "[in][bounds(origin, region)] handle of the image object"
- type: bool
name: blockingWrite
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_rect_offset_t
name: origin
desc: "[in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image"
- type: $x_rect_region_t
name: region
desc: "[in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image"
- type: size_t
name: rowPitch
desc: "[in] length of each row in bytes"
- type: size_t
name: slicePitch
desc: "[in] length of each 2D slice of the 3D image"
- type: void*
name: pSrc
desc: "[in] pointer to host memory where image is to be read into"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.depth == 0`"
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to copy from an image object to another"
class: $xEnqueue
name: MemImageCopy
ordinal: "0"
analogue:
- "**clEnqueueCopyImage**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hImageSrc
desc: "[in][bounds(srcOrigin, region)] handle of the src image object"
- type: $x_mem_handle_t
name: hImageDst
desc: "[in][bounds(dstOrigin, region)] handle of the dest image object"
- type: $x_rect_offset_t
name: srcOrigin
desc: "[in] defines the (x,y,z) offset in pixels in the source 1D, 2D, or 3D image"
- type: $x_rect_offset_t
name: dstOrigin
desc: "[in] defines the (x,y,z) offset in pixels in the destination 1D, 2D, or 3D image"
- type: $x_rect_region_t
name: region
desc: "[in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "`region.width == 0 || region.height == 0 || region.depth == 0`"
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to fill an image object with specified color"
class: $xEnqueue
name: MemImageFill
ordinal: "0"
version: "9999.0" # see #50
details:
- "Currently not implemented in Level Zero"
- "TODO: add a driver function in Level Zero?"
analogue:
- "**clEnqueueFillImage**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hImage
desc: "[in] handle of the image object"
- type: "const void*"
name: pFillColor
desc: |
[in] the color used to fill the image: single floating point value if the channel order is DEPTH,
otherwise, a four components RGBA values of various types depending on the image channel data type.
- type: "const size_t*"
name: pOrigin
desc: "[in] TODO change the type to $x_rect_offset_t"
- type: "const size_t*"
name: pRegion
desc: "[in] TODO: change the type to $x_rect_region_t"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: enum
desc: "Map flags"
class: $xDevice
name: $x_map_flags_t
etors:
- name: READ
desc: "Map for read access"
value: "$X_BIT(0)"
- name: WRITE
desc: "Map for write access"
value: "$X_BIT(1)"
- name: WRITE_INVALIDATE_REGION
desc: "Map for discard_write access"
value: "$X_BIT(2)"
--- #--------------------------------------------------------------------------
type: enum
desc: "Map flags"
class: $xDevice
name: $x_usm_migration_flags_t
etors:
- name: DEFAULT
desc: "Default migration TODO: Add more enums! "
value: "$X_BIT(0)"
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to map a region of the buffer object into the host address space and return a pointer to the mapped region"
class: $xEnqueue
name: MemBufferMap
ordinal: "0"
details:
- "Input parameter blockingMap indicates if the map is blocking or non-blocking."
- "Currently, no direct support in Level Zero. Implemented as a shared allocation followed by copying on discrete GPU"
- "TODO: add a driver function in Level Zero?"
analogue:
- "**clEnqueueMapBuffer**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hBuffer
desc: "[in][bounds(offset, size)] handle of the buffer object"
- type: bool
name: blockingMap
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_map_flags_t
name: mapFlags
desc: "[in] flags for read, write, readwrite mapping"
- type: size_t
name: offset
desc: "[in] offset in bytes of the buffer region being mapped"
- type: size_t
name: size
desc: "[in] size in bytes of the buffer region being mapped"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
- type: void**
name: ppRetMap
desc: "[out] return mapped pointer. TODO: move it before numEventsInWaitList?"
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_INVALID_SIZE:
- "If `offset + size` results in an out-of-bounds access."
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to map a region of the image object into the host address space and return a pointer to the mapped region"
class: $xEnqueue
name: MemImageMap
version: "9999.0" # See #50
ordinal: "0"
details:
- "Input parameter blockingMap indicates if the map is blocking or non-blocking."
- "TODO: Not implemented in PI and no direct support in Leverl Zero."
- "TODO: add a driver function in Level Zero?"
analogue:
- "**clEnqueueMapImage**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hImage
desc: "[in] handle of the image object"
- type: bool
name: blockingMap
desc: "[in] indicates blocking (true), non-blocking (false)"
- type: $x_map_flags_t
name: mapFlags
desc: "[in] flags for read, write, readwrite mapping"
- type: $x_rect_offset_t
name: origin
desc: "[in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image"
- type: $x_rect_region_t
name: region
desc: "[in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image"
- type: size_t
name: imageRowPitch
desc: "[in] length of each row in bytes"
- type: size_t
name: imageSlicePitch
desc: "[in] length of each 2D slice of the 3D image"
- type: void**
name: ppRetMap
desc: "[in,out] return mapped pointer"
- type: uint32_t
name: numEventsInWaitList
desc: "[in] size of the event wait list"
- type: "const $x_event_handle_t*"
name: phEventWaitList
desc: |
[in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed.
If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
- type: $x_event_handle_t*
name: phEvent
desc: |
[out][optional] return an event object that identifies this particular command instance.
returns:
- $X_RESULT_ERROR_INVALID_QUEUE
- $X_RESULT_ERROR_INVALID_EVENT
- $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
- "`phEventWaitList == NULL && numEventsInWaitList > 0`"
- "`phEventWaitList != NULL && numEventsInWaitList == 0`"
- "If event objects in phEventWaitList are not valid events."
- $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS:
- "An event in `phEventWaitList` has $X_EVENT_STATUS_ERROR."
- $X_RESULT_ERROR_INVALID_MEM_OBJECT
- $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
- $X_RESULT_ERROR_OUT_OF_RESOURCES
--- #--------------------------------------------------------------------------
type: function
desc: "Enqueue a command to unmap a previously mapped region of a memory object"
class: $xEnqueue
name: MemUnmap
ordinal: "0"
analogue:
- "**clEnqueueUnmapMemObject**"
params:
- type: $x_queue_handle_t
name: hQueue
desc: "[in] handle of the queue object"
- type: $x_mem_handle_t
name: hMem
desc: "[in] handle of the memory (buffer or image) object"
- type: void*
name: pMappedPtr
desc: "[in] mapped host address"
- type: uint32_t