-
Notifications
You must be signed in to change notification settings - Fork 730
/
pi_opencl.cpp
1944 lines (1689 loc) · 73.6 KB
/
pi_opencl.cpp
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
//==---------- pi_opencl.cpp - OpenCL Plugin -------------------------------==//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
/// \defgroup sycl_pi_ocl OpenCL Plugin
/// \ingroup sycl_pi
/// \file pi_opencl.cpp
/// Implementation of OpenCL Plugin. It is the interface between device-agnostic
/// SYCL runtime layer and underlying OpenCL runtime.
///
/// \ingroup sycl_pi_ocl
#define CL_USE_DEPRECATED_OPENCL_1_2_APIS
#include <pi_opencl.hpp>
#include <sycl/detail/cl.h>
#include <sycl/detail/iostream_proxy.hpp>
#include <sycl/detail/pi.h>
#include <algorithm>
#include <cassert>
#include <cstring>
#include <limits>
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <vector>
#define CHECK_ERR_SET_NULL_RET(err, ptr, reterr) \
if (err != CL_SUCCESS) { \
if (ptr != nullptr) \
*ptr = nullptr; \
return cast<pi_result>(reterr); \
}
// Want all the needed casts be explicit, do not define conversion operators.
template <class To, class From> To cast(From value) {
// TODO: see if more sanity checks are possible.
static_assert(sizeof(From) == sizeof(To), "cast failed size check");
return (To)(value);
}
// Older versions of GCC don't like "const" here
#if defined(__GNUC__) && (__GNUC__ < 7 || (__GNU__C == 7 && __GNUC_MINOR__ < 2))
#define CONSTFIX constexpr
#else
#define CONSTFIX const
#endif
// Names of USM functions that are queried from OpenCL
CONSTFIX char clHostMemAllocName[] = "clHostMemAllocINTEL";
CONSTFIX char clDeviceMemAllocName[] = "clDeviceMemAllocINTEL";
CONSTFIX char clSharedMemAllocName[] = "clSharedMemAllocINTEL";
CONSTFIX char clMemBlockingFreeName[] = "clMemBlockingFreeINTEL";
CONSTFIX char clCreateBufferWithPropertiesName[] =
"clCreateBufferWithPropertiesINTEL";
CONSTFIX char clSetKernelArgMemPointerName[] = "clSetKernelArgMemPointerINTEL";
CONSTFIX char clEnqueueMemsetName[] = "clEnqueueMemsetINTEL";
CONSTFIX char clEnqueueMemcpyName[] = "clEnqueueMemcpyINTEL";
CONSTFIX char clGetMemAllocInfoName[] = "clGetMemAllocInfoINTEL";
CONSTFIX char clSetProgramSpecializationConstantName[] =
"clSetProgramSpecializationConstant";
CONSTFIX char clGetDeviceFunctionPointerName[] =
"clGetDeviceFunctionPointerINTEL";
CONSTFIX char clEnqueueWriteGlobalVariableName[] =
"clEnqueueWriteGlobalVariableINTEL";
CONSTFIX char clEnqueueReadGlobalVariableName[] =
"clEnqueueReadGlobalVariableINTEL";
#undef CONSTFIX
// Global variables for PI_ERROR_PLUGIN_SPECIFIC_ERROR
constexpr size_t MaxMessageSize = 256;
thread_local pi_result ErrorMessageCode = PI_SUCCESS;
thread_local char ErrorMessage[MaxMessageSize];
// Utility function for setting a message and warning
[[maybe_unused]] static void setErrorMessage(const char *message,
pi_result error_code) {
assert(strlen(message) <= MaxMessageSize);
strcpy(ErrorMessage, message);
ErrorMessageCode = error_code;
}
// Returns plugin specific error and warning messages
pi_result piPluginGetLastError(char **message) {
*message = &ErrorMessage[0];
return ErrorMessageCode;
}
static cl_int getPlatformVersion(cl_platform_id plat,
OCLV::OpenCLVersion &version) {
cl_int ret_err = CL_INVALID_VALUE;
size_t platVerSize = 0;
ret_err =
clGetPlatformInfo(plat, CL_PLATFORM_VERSION, 0, nullptr, &platVerSize);
std::string platVer(platVerSize, '\0');
ret_err = clGetPlatformInfo(plat, CL_PLATFORM_VERSION, platVerSize,
platVer.data(), nullptr);
if (ret_err != CL_SUCCESS)
return ret_err;
version = OCLV::OpenCLVersion(platVer);
if (!version.isValid())
return CL_INVALID_PLATFORM;
return ret_err;
}
static cl_int getDeviceVersion(cl_device_id dev, OCLV::OpenCLVersion &version) {
cl_int ret_err = CL_INVALID_VALUE;
size_t devVerSize = 0;
ret_err = clGetDeviceInfo(dev, CL_DEVICE_VERSION, 0, nullptr, &devVerSize);
std::string devVer(devVerSize, '\0');
ret_err = clGetDeviceInfo(dev, CL_DEVICE_VERSION, devVerSize, devVer.data(),
nullptr);
if (ret_err != CL_SUCCESS)
return ret_err;
version = OCLV::OpenCLVersion(devVer);
if (!version.isValid())
return CL_INVALID_DEVICE;
return ret_err;
}
static cl_int checkDeviceExtensions(cl_device_id dev,
const std::vector<std::string> &exts,
bool &supported) {
cl_int ret_err = CL_INVALID_VALUE;
size_t extSize = 0;
ret_err = clGetDeviceInfo(dev, CL_DEVICE_EXTENSIONS, 0, nullptr, &extSize);
std::string extStr(extSize, '\0');
ret_err = clGetDeviceInfo(dev, CL_DEVICE_EXTENSIONS, extSize, extStr.data(),
nullptr);
if (ret_err != CL_SUCCESS)
return ret_err;
supported = true;
for (const std::string &ext : exts)
if (!(supported = (extStr.find(ext) != std::string::npos)))
break;
return ret_err;
}
// USM helper function to get an extension function pointer
template <const char *FuncName, typename T>
static pi_result getExtFuncFromContext(pi_context context, T *fptr) {
// TODO
// Potentially redo caching as PI interface changes.
thread_local static std::map<pi_context, T> FuncPtrs;
// if cached, return cached FuncPtr
auto It = FuncPtrs.find(context);
if (It != FuncPtrs.end()) {
auto F = It->second;
// if cached that extension is not available return nullptr and
// PI_ERROR_INVALID_VALUE
*fptr = F;
return F ? PI_SUCCESS : PI_ERROR_INVALID_VALUE;
}
cl_uint deviceCount;
cl_int ret_err =
clGetContextInfo(cast<cl_context>(context), CL_CONTEXT_NUM_DEVICES,
sizeof(cl_uint), &deviceCount, nullptr);
if (ret_err != CL_SUCCESS || deviceCount < 1) {
return PI_ERROR_INVALID_CONTEXT;
}
std::vector<cl_device_id> devicesInCtx(deviceCount);
ret_err = clGetContextInfo(cast<cl_context>(context), CL_CONTEXT_DEVICES,
deviceCount * sizeof(cl_device_id),
devicesInCtx.data(), nullptr);
if (ret_err != CL_SUCCESS) {
return PI_ERROR_INVALID_CONTEXT;
}
cl_platform_id curPlatform;
ret_err = clGetDeviceInfo(devicesInCtx[0], CL_DEVICE_PLATFORM,
sizeof(cl_platform_id), &curPlatform, nullptr);
if (ret_err != CL_SUCCESS) {
return PI_ERROR_INVALID_CONTEXT;
}
T FuncPtr =
(T)clGetExtensionFunctionAddressForPlatform(curPlatform, FuncName);
if (!FuncPtr) {
// Cache that the extension is not available
FuncPtrs[context] = nullptr;
return PI_ERROR_INVALID_VALUE;
}
*fptr = FuncPtr;
FuncPtrs[context] = FuncPtr;
return cast<pi_result>(ret_err);
}
/// Enables indirect access of pointers in kernels.
/// Necessary to avoid telling CL about every pointer that might be used.
///
/// \param kernel is the kernel to be launched
static pi_result USMSetIndirectAccess(pi_kernel kernel) {
// We test that each alloc type is supported before we actually try to
// set KernelExecInfo.
cl_bool TrueVal = CL_TRUE;
clHostMemAllocINTEL_fn HFunc = nullptr;
clSharedMemAllocINTEL_fn SFunc = nullptr;
clDeviceMemAllocINTEL_fn DFunc = nullptr;
cl_context CLContext;
cl_int CLErr = clGetKernelInfo(cast<cl_kernel>(kernel), CL_KERNEL_CONTEXT,
sizeof(cl_context), &CLContext, nullptr);
if (CLErr != CL_SUCCESS) {
return cast<pi_result>(CLErr);
}
getExtFuncFromContext<clHostMemAllocName, clHostMemAllocINTEL_fn>(
cast<pi_context>(CLContext), &HFunc);
if (HFunc) {
clSetKernelExecInfo(cast<cl_kernel>(kernel),
CL_KERNEL_EXEC_INFO_INDIRECT_HOST_ACCESS_INTEL,
sizeof(cl_bool), &TrueVal);
}
getExtFuncFromContext<clDeviceMemAllocName, clDeviceMemAllocINTEL_fn>(
cast<pi_context>(CLContext), &DFunc);
if (DFunc) {
clSetKernelExecInfo(cast<cl_kernel>(kernel),
CL_KERNEL_EXEC_INFO_INDIRECT_DEVICE_ACCESS_INTEL,
sizeof(cl_bool), &TrueVal);
}
getExtFuncFromContext<clSharedMemAllocName, clSharedMemAllocINTEL_fn>(
cast<pi_context>(CLContext), &SFunc);
if (SFunc) {
clSetKernelExecInfo(cast<cl_kernel>(kernel),
CL_KERNEL_EXEC_INFO_INDIRECT_SHARED_ACCESS_INTEL,
sizeof(cl_bool), &TrueVal);
}
return PI_SUCCESS;
}
extern "C" {
pi_result piDeviceGetInfo(pi_device device, pi_device_info paramName,
size_t paramValueSize, void *paramValue,
size_t *paramValueSizeRet) {
switch (paramName) {
// TODO: Check regularly to see if support in enabled in OpenCL.
// Intel GPU EU device-specific information extensions.
// Some of the queries are enabled by cl_intel_device_attribute_query
// extension, but it's not yet in the Registry.
case PI_DEVICE_INFO_PCI_ADDRESS:
case PI_DEVICE_INFO_GPU_EU_COUNT:
case PI_DEVICE_INFO_GPU_EU_SIMD_WIDTH:
case PI_DEVICE_INFO_GPU_SLICES:
case PI_DEVICE_INFO_GPU_SUBSLICES_PER_SLICE:
case PI_DEVICE_INFO_GPU_EU_COUNT_PER_SUBSLICE:
case PI_DEVICE_INFO_GPU_HW_THREADS_PER_EU:
case PI_DEVICE_INFO_MAX_MEM_BANDWIDTH:
// TODO: Check if device UUID extension is enabled in OpenCL.
// For details about Intel UUID extension, see
// sycl/doc/extensions/supported/sycl_ext_intel_device_info.md
case PI_DEVICE_INFO_UUID:
case PI_DEVICE_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES:
case PI_DEVICE_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES:
return PI_ERROR_INVALID_VALUE;
case PI_DEVICE_INFO_ATOMIC_64: {
cl_int ret_err = CL_SUCCESS;
cl_bool result = CL_FALSE;
bool supported = false;
ret_err = checkDeviceExtensions(
cast<cl_device_id>(device),
{"cl_khr_int64_base_atomics", "cl_khr_int64_extended_atomics"},
supported);
if (ret_err != CL_SUCCESS)
return static_cast<pi_result>(ret_err);
result = supported;
std::memcpy(paramValue, &result, sizeof(cl_bool));
return PI_SUCCESS;
}
case PI_EXT_ONEAPI_DEVICE_INFO_BFLOAT16_MATH_FUNCTIONS: {
// bfloat16 math functions are not yet supported on Intel GPUs.
cl_bool result = false;
std::memcpy(paramValue, &result, sizeof(cl_bool));
return PI_SUCCESS;
}
case PI_DEVICE_INFO_IMAGE_SRGB: {
cl_bool result = true;
std::memcpy(paramValue, &result, sizeof(cl_bool));
return PI_SUCCESS;
}
case PI_DEVICE_INFO_BUILD_ON_SUBDEVICE: {
cl_device_type devType = CL_DEVICE_TYPE_DEFAULT;
cl_int res = clGetDeviceInfo(cast<cl_device_id>(device), CL_DEVICE_TYPE,
sizeof(cl_device_type), &devType, nullptr);
// FIXME: here we assume that program built for a root GPU device can be
// used on its sub-devices without re-building
cl_bool result = (res == CL_SUCCESS) && (devType == CL_DEVICE_TYPE_GPU);
std::memcpy(paramValue, &result, sizeof(cl_bool));
return PI_SUCCESS;
}
case PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_3D:
// Returns the maximum sizes of a work group for each dimension one
// could use to submit a kernel. There is no such query defined in OpenCL
// so we'll return the maximum value.
{
if (paramValueSizeRet)
*paramValueSizeRet = paramValueSize;
static constexpr size_t Max = (std::numeric_limits<size_t>::max)();
size_t *out = cast<size_t *>(paramValue);
if (paramValueSize >= sizeof(size_t))
out[0] = Max;
if (paramValueSize >= 2 * sizeof(size_t))
out[1] = Max;
if (paramValueSize >= 3 * sizeof(size_t))
out[2] = Max;
return PI_SUCCESS;
}
case PI_EXT_INTEL_DEVICE_INFO_MAX_COMPUTE_QUEUE_INDICES: {
pi_int32 result = 1;
std::memcpy(paramValue, &result, sizeof(pi_int32));
return PI_SUCCESS;
}
default:
cl_int result = clGetDeviceInfo(
cast<cl_device_id>(device), cast<cl_device_info>(paramName),
paramValueSize, paramValue, paramValueSizeRet);
return static_cast<pi_result>(result);
}
}
pi_result piPlatformsGet(pi_uint32 num_entries, pi_platform *platforms,
pi_uint32 *num_platforms) {
cl_int result = clGetPlatformIDs(cast<cl_uint>(num_entries),
cast<cl_platform_id *>(platforms),
cast<cl_uint *>(num_platforms));
// Absorb the CL_PLATFORM_NOT_FOUND_KHR and just return 0 in num_platforms
if (result == CL_PLATFORM_NOT_FOUND_KHR) {
assert(num_platforms != 0);
*num_platforms = 0;
result = PI_SUCCESS;
}
return static_cast<pi_result>(result);
}
pi_result piextPlatformCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_platform *platform) {
assert(platform);
assert(nativeHandle);
*platform = reinterpret_cast<pi_platform>(nativeHandle);
return PI_SUCCESS;
}
pi_result piDevicesGet(pi_platform platform, pi_device_type device_type,
pi_uint32 num_entries, pi_device *devices,
pi_uint32 *num_devices) {
cl_int result = clGetDeviceIDs(
cast<cl_platform_id>(platform), cast<cl_device_type>(device_type),
cast<cl_uint>(num_entries), cast<cl_device_id *>(devices),
cast<cl_uint *>(num_devices));
// Absorb the CL_DEVICE_NOT_FOUND and just return 0 in num_devices
if (result == CL_DEVICE_NOT_FOUND) {
assert(num_devices != 0);
*num_devices = 0;
result = PI_SUCCESS;
}
return cast<pi_result>(result);
}
pi_result piextDeviceSelectBinary(pi_device device, pi_device_binary *images,
pi_uint32 num_images,
pi_uint32 *selected_image_ind) {
// TODO: this is a bare-bones implementation for choosing a device image
// that would be compatible with the targeted device. An AOT-compiled
// image is preferred over SPIR-V for known devices (i.e. Intel devices)
// The implementation makes no effort to differentiate between multiple images
// for the given device, and simply picks the first one compatible
// Real implementation will use the same mechanism OpenCL ICD dispatcher
// uses. Something like:
// PI_VALIDATE_HANDLE_RETURN_HANDLE(ctx, PI_ERROR_INVALID_CONTEXT);
// return context->dispatch->piextDeviceSelectIR(
// ctx, images, num_images, selected_image);
// where context->dispatch is set to the dispatch table provided by PI
// plugin for platform/device the ctx was created for.
// Choose the binary target for the provided device
const char *image_target = nullptr;
// Get the type of the device
cl_device_type device_type;
constexpr pi_uint32 invalid_ind = std::numeric_limits<pi_uint32>::max();
cl_int ret_err =
clGetDeviceInfo(cast<cl_device_id>(device), CL_DEVICE_TYPE,
sizeof(cl_device_type), &device_type, nullptr);
if (ret_err != CL_SUCCESS) {
*selected_image_ind = invalid_ind;
return cast<pi_result>(ret_err);
}
switch (device_type) {
// TODO: Factor out vendor specifics into a separate source
// E.g. sycl/source/detail/vendor/intel/detail/pi_opencl.cpp?
// We'll attempt to find an image that was AOT-compiled
// from a SPIR-V image into an image specific for:
case CL_DEVICE_TYPE_CPU: // OpenCL 64-bit CPU
image_target = __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64;
break;
case CL_DEVICE_TYPE_GPU: // OpenCL 64-bit GEN GPU
image_target = __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN;
break;
case CL_DEVICE_TYPE_ACCELERATOR: // OpenCL 64-bit FPGA
image_target = __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA;
break;
default:
// Otherwise, we'll attempt to find and JIT-compile
// a device-independent SPIR-V image
image_target = __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64;
break;
}
// Find the appropriate device image, fallback to spirv if not found
pi_uint32 fallback = invalid_ind;
for (pi_uint32 i = 0; i < num_images; ++i) {
if (strcmp(images[i]->DeviceTargetSpec, image_target) == 0) {
*selected_image_ind = i;
return PI_SUCCESS;
}
if (strcmp(images[i]->DeviceTargetSpec,
__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64) == 0)
fallback = i;
}
// Points to a spirv image, if such indeed was found
if ((*selected_image_ind = fallback) != invalid_ind)
return PI_SUCCESS;
// No image can be loaded for the given device
return PI_ERROR_INVALID_BINARY;
}
pi_result piextDeviceCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_platform, pi_device *piDevice) {
assert(piDevice != nullptr);
*piDevice = reinterpret_cast<pi_device>(nativeHandle);
return PI_SUCCESS;
}
pi_result piextQueueCreate(pi_context Context, pi_device Device,
pi_queue_properties *Properties, pi_queue *Queue) {
assert(Properties);
// Expect flags mask to be passed first.
assert(Properties[0] == PI_QUEUE_FLAGS);
if (Properties[0] != PI_QUEUE_FLAGS)
return PI_ERROR_INVALID_VALUE;
pi_queue_properties Flags = Properties[1];
// Extra data isn't supported yet.
assert(Properties[2] == 0);
if (Properties[2] != 0)
return PI_ERROR_INVALID_VALUE;
return piQueueCreate(Context, Device, Flags, Queue);
}
pi_result piQueueCreate(pi_context context, pi_device device,
pi_queue_properties properties, pi_queue *queue) {
assert(queue && "piQueueCreate failed, queue argument is null");
cl_platform_id curPlatform;
cl_int ret_err =
clGetDeviceInfo(cast<cl_device_id>(device), CL_DEVICE_PLATFORM,
sizeof(cl_platform_id), &curPlatform, nullptr);
CHECK_ERR_SET_NULL_RET(ret_err, queue, ret_err);
// Check that unexpected bits are not set.
assert(!(properties &
~(PI_QUEUE_FLAG_OUT_OF_ORDER_EXEC_MODE_ENABLE |
PI_QUEUE_FLAG_PROFILING_ENABLE | PI_QUEUE_FLAG_ON_DEVICE |
PI_QUEUE_FLAG_ON_DEVICE_DEFAULT |
PI_EXT_ONEAPI_QUEUE_FLAG_DISCARD_EVENTS)));
// Properties supported by OpenCL backend.
cl_command_queue_properties SupportByOpenCL =
CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE | CL_QUEUE_PROFILING_ENABLE |
CL_QUEUE_ON_DEVICE | CL_QUEUE_ON_DEVICE_DEFAULT;
OCLV::OpenCLVersion version;
ret_err = getPlatformVersion(curPlatform, version);
CHECK_ERR_SET_NULL_RET(ret_err, queue, ret_err);
if (version >= OCLV::V2_0) {
*queue = cast<pi_queue>(clCreateCommandQueue(
cast<cl_context>(context), cast<cl_device_id>(device),
cast<cl_command_queue_properties>(properties) & SupportByOpenCL,
&ret_err));
return cast<pi_result>(ret_err);
}
cl_queue_properties CreationFlagProperties[] = {
CL_QUEUE_PROPERTIES,
cast<cl_command_queue_properties>(properties) & SupportByOpenCL, 0};
*queue = cast<pi_queue>(clCreateCommandQueueWithProperties(
cast<cl_context>(context), cast<cl_device_id>(device),
CreationFlagProperties, &ret_err));
return cast<pi_result>(ret_err);
}
pi_result piQueueGetInfo(pi_queue queue, pi_queue_info param_name,
size_t param_value_size, void *param_value,
size_t *param_value_size_ret) {
if (queue == nullptr) {
return PI_ERROR_INVALID_QUEUE;
}
switch (param_name) {
case PI_EXT_ONEAPI_QUEUE_INFO_EMPTY:
// OpenCL doesn't provide API to check the status of the queue.
return PI_ERROR_INVALID_VALUE;
default:
cl_int CLErr = clGetCommandQueueInfo(
cast<cl_command_queue>(queue), cast<cl_command_queue_info>(param_name),
param_value_size, param_value, param_value_size_ret);
if (CLErr != CL_SUCCESS) {
return cast<pi_result>(CLErr);
}
}
return PI_SUCCESS;
}
pi_result piextQueueCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_context, pi_device,
bool ownNativeHandle,
pi_queue *piQueue) {
(void)ownNativeHandle;
assert(piQueue != nullptr);
*piQueue = reinterpret_cast<pi_queue>(nativeHandle);
clRetainCommandQueue(cast<cl_command_queue>(nativeHandle));
return PI_SUCCESS;
}
pi_result piProgramCreate(pi_context context, const void *il, size_t length,
pi_program *res_program) {
cl_uint deviceCount;
cl_int ret_err =
clGetContextInfo(cast<cl_context>(context), CL_CONTEXT_NUM_DEVICES,
sizeof(cl_uint), &deviceCount, nullptr);
std::vector<cl_device_id> devicesInCtx(deviceCount);
if (ret_err != CL_SUCCESS || deviceCount < 1) {
if (res_program != nullptr)
*res_program = nullptr;
return cast<pi_result>(CL_INVALID_CONTEXT);
}
ret_err = clGetContextInfo(cast<cl_context>(context), CL_CONTEXT_DEVICES,
deviceCount * sizeof(cl_device_id),
devicesInCtx.data(), nullptr);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
cl_platform_id curPlatform;
ret_err = clGetDeviceInfo(devicesInCtx[0], CL_DEVICE_PLATFORM,
sizeof(cl_platform_id), &curPlatform, nullptr);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
OCLV::OpenCLVersion platVer;
ret_err = getPlatformVersion(curPlatform, platVer);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
pi_result err = PI_SUCCESS;
if (platVer >= OCLV::V2_1) {
/* Make sure all devices support CL 2.1 or newer as well. */
for (cl_device_id dev : devicesInCtx) {
OCLV::OpenCLVersion devVer;
ret_err = getDeviceVersion(dev, devVer);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
/* If the device does not support CL 2.1 or greater, we need to make sure
* it supports the cl_khr_il_program extension.
*/
if (devVer < OCLV::V2_1) {
bool supported = false;
ret_err = checkDeviceExtensions(dev, {"cl_khr_il_program"}, supported);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
if (!supported)
return cast<pi_result>(CL_INVALID_OPERATION);
}
}
if (res_program != nullptr)
*res_program = cast<pi_program>(clCreateProgramWithIL(
cast<cl_context>(context), il, length, cast<cl_int *>(&err)));
return err;
}
/* If none of the devices conform with CL 2.1 or newer make sure they all
* support the cl_khr_il_program extension.
*/
for (cl_device_id dev : devicesInCtx) {
bool supported = false;
ret_err = checkDeviceExtensions(dev, {"cl_khr_il_program"}, supported);
CHECK_ERR_SET_NULL_RET(ret_err, res_program, CL_INVALID_CONTEXT);
if (!supported)
return cast<pi_result>(CL_INVALID_OPERATION);
}
using apiFuncT =
cl_program(CL_API_CALL *)(cl_context, const void *, size_t, cl_int *);
apiFuncT funcPtr =
reinterpret_cast<apiFuncT>(clGetExtensionFunctionAddressForPlatform(
curPlatform, "clCreateProgramWithILKHR"));
assert(funcPtr != nullptr);
if (res_program != nullptr)
*res_program = cast<pi_program>(
funcPtr(cast<cl_context>(context), il, length, cast<cl_int *>(&err)));
else
err = PI_ERROR_INVALID_VALUE;
return err;
}
pi_result piextProgramCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_context, bool,
pi_program *piProgram) {
assert(piProgram != nullptr);
*piProgram = reinterpret_cast<pi_program>(nativeHandle);
return PI_SUCCESS;
}
pi_result piSamplerCreate(pi_context context,
const pi_sampler_properties *sampler_properties,
pi_sampler *result_sampler) {
// Initialize properties according to OpenCL 2.1 spec.
pi_result error_code;
pi_bool normalizedCoords = PI_TRUE;
pi_sampler_addressing_mode addressingMode = PI_SAMPLER_ADDRESSING_MODE_CLAMP;
pi_sampler_filter_mode filterMode = PI_SAMPLER_FILTER_MODE_NEAREST;
// Unpack sampler properties
for (std::size_t i = 0; sampler_properties && sampler_properties[i] != 0;
++i) {
if (sampler_properties[i] == PI_SAMPLER_INFO_NORMALIZED_COORDS) {
normalizedCoords = static_cast<pi_bool>(sampler_properties[++i]);
} else if (sampler_properties[i] == PI_SAMPLER_INFO_ADDRESSING_MODE) {
addressingMode =
static_cast<pi_sampler_addressing_mode>(sampler_properties[++i]);
} else if (sampler_properties[i] == PI_SAMPLER_INFO_FILTER_MODE) {
filterMode = static_cast<pi_sampler_filter_mode>(sampler_properties[++i]);
} else {
assert(false && "Cannot recognize sampler property");
}
}
// Always call OpenCL 1.0 API
*result_sampler = cast<pi_sampler>(
clCreateSampler(cast<cl_context>(context), normalizedCoords,
addressingMode, filterMode, cast<cl_int *>(&error_code)));
return error_code;
}
pi_result piextKernelSetArgMemObj(pi_kernel kernel, pi_uint32 arg_index,
const pi_mem *arg_value) {
return cast<pi_result>(
clSetKernelArg(cast<cl_kernel>(kernel), cast<cl_uint>(arg_index),
sizeof(arg_value), cast<const cl_mem *>(arg_value)));
}
pi_result piextKernelSetArgSampler(pi_kernel kernel, pi_uint32 arg_index,
const pi_sampler *arg_value) {
return cast<pi_result>(
clSetKernelArg(cast<cl_kernel>(kernel), cast<cl_uint>(arg_index),
sizeof(cl_sampler), cast<const cl_sampler *>(arg_value)));
}
pi_result piextKernelCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_context, pi_program, bool,
pi_kernel *piKernel) {
assert(piKernel != nullptr);
*piKernel = reinterpret_cast<pi_kernel>(nativeHandle);
return PI_SUCCESS;
}
// Function gets characters between delimeter's in str
// then checks if they are equal to the sub_str.
// returns true if there is at least one instance
// returns false if there are no instances of the name
static bool is_in_separated_string(const std::string &str, char delimiter,
const std::string &sub_str) {
size_t beg = 0;
size_t length = 0;
for (const auto &x : str) {
if (x == delimiter) {
if (str.substr(beg, length) == sub_str)
return true;
beg += length + 1;
length = 0;
continue;
}
length++;
}
if (length != 0)
if (str.substr(beg, length) == sub_str)
return true;
return false;
}
typedef CL_API_ENTRY cl_int(CL_API_CALL *clGetDeviceFunctionPointer_fn)(
cl_device_id device, cl_program program, const char *FuncName,
cl_ulong *ret_ptr);
pi_result piextGetDeviceFunctionPointer(pi_device device, pi_program program,
const char *func_name,
pi_uint64 *function_pointer_ret) {
cl_context CLContext = nullptr;
cl_int ret_err =
clGetProgramInfo(cast<cl_program>(program), CL_PROGRAM_CONTEXT,
sizeof(CLContext), &CLContext, nullptr);
if (ret_err != CL_SUCCESS)
return cast<pi_result>(ret_err);
clGetDeviceFunctionPointer_fn FuncT = nullptr;
ret_err = getExtFuncFromContext<clGetDeviceFunctionPointerName,
clGetDeviceFunctionPointer_fn>(
cast<pi_context>(CLContext), &FuncT);
pi_result pi_ret_err = PI_SUCCESS;
// Check if kernel name exists, to prevent opencl runtime throwing exception
// with cpu runtime
// TODO: Use fallback search method if extension does not exist once CPU
// runtime no longer throws exceptions and prints messages when given
// unavailable functions.
*function_pointer_ret = 0;
size_t Size;
cl_int Res =
clGetProgramInfo(cast<cl_program>(program), PI_PROGRAM_INFO_KERNEL_NAMES,
0, nullptr, &Size);
if (Res != CL_SUCCESS)
return cast<pi_result>(Res);
std::string ClResult(Size, ' ');
Res =
clGetProgramInfo(cast<cl_program>(program), PI_PROGRAM_INFO_KERNEL_NAMES,
ClResult.size(), &ClResult[0], nullptr);
if (Res != CL_SUCCESS)
return cast<pi_result>(Res);
// Get rid of the null terminator and search for kernel_name
// If function cannot be found return error code to indicate it
// exists
ClResult.pop_back();
if (!is_in_separated_string(ClResult, ';', func_name))
return PI_ERROR_INVALID_KERNEL_NAME;
pi_ret_err = PI_ERROR_FUNCTION_ADDRESS_IS_NOT_AVAILABLE;
// If clGetDeviceFunctionPointer is in list of extensions
if (FuncT) {
pi_ret_err = cast<pi_result>(FuncT(cast<cl_device_id>(device),
cast<cl_program>(program), func_name,
function_pointer_ret));
// GPU runtime sometimes returns PI_ERROR_INVALID_ARG_VALUE if func address
// cannot be found even if kernel exits. As the kernel does exist return
// that the address is not available
if (pi_ret_err == CL_INVALID_ARG_VALUE) {
*function_pointer_ret = 0;
return PI_ERROR_FUNCTION_ADDRESS_IS_NOT_AVAILABLE;
}
}
return pi_ret_err;
}
pi_result piContextCreate(const pi_context_properties *properties,
pi_uint32 num_devices, const pi_device *devices,
void (*pfn_notify)(const char *errinfo,
const void *private_info,
size_t cb, void *user_data1),
void *user_data, pi_context *retcontext) {
pi_result ret = PI_ERROR_INVALID_OPERATION;
*retcontext = cast<pi_context>(
clCreateContext(properties, cast<cl_uint>(num_devices),
cast<const cl_device_id *>(devices), pfn_notify,
user_data, cast<cl_int *>(&ret)));
return ret;
}
pi_result piextContextCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_uint32 num_devices,
const pi_device *devices,
bool ownNativeHandle,
pi_context *piContext) {
(void)num_devices;
(void)devices;
(void)ownNativeHandle;
assert(piContext != nullptr);
assert(ownNativeHandle == false);
*piContext = reinterpret_cast<pi_context>(nativeHandle);
return PI_SUCCESS;
}
pi_result piContextGetInfo(pi_context context, pi_context_info paramName,
size_t paramValueSize, void *paramValue,
size_t *paramValueSizeRet) {
switch (paramName) {
case PI_EXT_ONEAPI_CONTEXT_INFO_USM_MEMCPY2D_SUPPORT:
case PI_EXT_ONEAPI_CONTEXT_INFO_USM_FILL2D_SUPPORT:
case PI_EXT_ONEAPI_CONTEXT_INFO_USM_MEMSET2D_SUPPORT: {
// 2D USM memops are not supported.
cl_bool result = false;
std::memcpy(paramValue, &result, sizeof(cl_bool));
return PI_SUCCESS;
}
default:
cl_int result = clGetContextInfo(
cast<cl_context>(context), cast<cl_context_info>(paramName),
paramValueSize, paramValue, paramValueSizeRet);
return static_cast<pi_result>(result);
}
}
pi_result piMemBufferCreate(pi_context context, pi_mem_flags flags, size_t size,
void *host_ptr, pi_mem *ret_mem,
const pi_mem_properties *properties) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
if (properties) {
// TODO: need to check if all properties are supported by OpenCL RT and
// ignore unsupported
clCreateBufferWithPropertiesINTEL_fn FuncPtr = nullptr;
// First we need to look up the function pointer
ret_err = getExtFuncFromContext<clCreateBufferWithPropertiesName,
clCreateBufferWithPropertiesINTEL_fn>(
context, &FuncPtr);
if (FuncPtr) {
*ret_mem = cast<pi_mem>(FuncPtr(cast<cl_context>(context), properties,
cast<cl_mem_flags>(flags), size, host_ptr,
cast<cl_int *>(&ret_err)));
return ret_err;
}
}
*ret_mem = cast<pi_mem>(clCreateBuffer(cast<cl_context>(context),
cast<cl_mem_flags>(flags), size,
host_ptr, cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piMemImageCreate(pi_context context, pi_mem_flags flags,
const pi_image_format *image_format,
const pi_image_desc *image_desc, void *host_ptr,
pi_mem *ret_mem) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_mem = cast<pi_mem>(
clCreateImage(cast<cl_context>(context), cast<cl_mem_flags>(flags),
cast<const cl_image_format *>(image_format),
cast<const cl_image_desc *>(image_desc), host_ptr,
cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piMemBufferPartition(pi_mem buffer, pi_mem_flags flags,
pi_buffer_create_type buffer_create_type,
void *buffer_create_info, pi_mem *ret_mem) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_mem = cast<pi_mem>(
clCreateSubBuffer(cast<cl_mem>(buffer), cast<cl_mem_flags>(flags),
cast<cl_buffer_create_type>(buffer_create_type),
buffer_create_info, cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piextMemCreateWithNativeHandle(pi_native_handle nativeHandle,
pi_context context,
bool ownNativeHandle, pi_mem *piMem) {
(void)context;
(void)ownNativeHandle;
assert(piMem != nullptr);
*piMem = reinterpret_cast<pi_mem>(nativeHandle);
return PI_SUCCESS;
}
pi_result piclProgramCreateWithSource(pi_context context, pi_uint32 count,
const char **strings,
const size_t *lengths,
pi_program *ret_program) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_program = cast<pi_program>(
clCreateProgramWithSource(cast<cl_context>(context), cast<cl_uint>(count),
strings, lengths, cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piProgramCreateWithBinary(
pi_context context, pi_uint32 num_devices, const pi_device *device_list,
const size_t *lengths, const unsigned char **binaries,
size_t num_metadata_entries, const pi_device_binary_property *metadata,
pi_int32 *binary_status, pi_program *ret_program) {
(void)metadata;
(void)num_metadata_entries;
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_program = cast<pi_program>(clCreateProgramWithBinary(
cast<cl_context>(context), cast<cl_uint>(num_devices),
cast<const cl_device_id *>(device_list), lengths, binaries,
cast<cl_int *>(binary_status), cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piProgramLink(pi_context context, pi_uint32 num_devices,
const pi_device *device_list, const char *options,
pi_uint32 num_input_programs,
const pi_program *input_programs,
void (*pfn_notify)(pi_program program, void *user_data),
void *user_data, pi_program *ret_program) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_program = cast<pi_program>(
clLinkProgram(cast<cl_context>(context), cast<cl_uint>(num_devices),
cast<const cl_device_id *>(device_list), options,
cast<cl_uint>(num_input_programs),
cast<const cl_program *>(input_programs),
cast<void (*)(cl_program, void *)>(pfn_notify), user_data,
cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piKernelCreate(pi_program program, const char *kernel_name,
pi_kernel *ret_kernel) {
pi_result ret_err = PI_ERROR_INVALID_OPERATION;
*ret_kernel = cast<pi_kernel>(clCreateKernel(
cast<cl_program>(program), kernel_name, cast<cl_int *>(&ret_err)));
return ret_err;
}
pi_result piKernelGetGroupInfo(pi_kernel kernel, pi_device device,
pi_kernel_group_info param_name,
size_t param_value_size, void *param_value,
size_t *param_value_size_ret) {
if (kernel == nullptr) {
return PI_ERROR_INVALID_KERNEL;
}
switch (param_name) {
case PI_KERNEL_GROUP_INFO_NUM_REGS:
return PI_ERROR_INVALID_VALUE;
default:
cl_int result = clGetKernelWorkGroupInfo(
cast<cl_kernel>(kernel), cast<cl_device_id>(device),
cast<cl_kernel_work_group_info>(param_name), param_value_size,
param_value, param_value_size_ret);
return static_cast<pi_result>(result);
}
}
pi_result piKernelGetSubGroupInfo(pi_kernel kernel, pi_device device,
pi_kernel_sub_group_info param_name,
size_t input_value_size,
const void *input_value,