Skip to content

Add cl_khr_icd instance support. #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kerilk wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add cl_khr_icd instance support. #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c02e514
Add cl_khr_icd instance support.
Kerilk Dec 1, 2023
bf0ac1f
Remove extra include.
Kerilk Feb 11, 2026
7bd5930
Move the free out of the potential error path.
Kerilk Feb 11, 2026
66d74be
Directly rely on the function pointer to destroy the instance platform.
Kerilk Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions include/cl_khr_icd2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,25 @@ clIcdSetPlatformDispatchDataKHR_t(
typedef clIcdSetPlatformDispatchDataKHR_t *
clIcdSetPlatformDispatchDataKHR_fn;
#endif // !defined(CL_ICD2_TAG_KHR)

#if !defined(CL_INSTANCE_PLATFORM_PROPERTIES_LIST_END_KHR)
#define CL_INSTANCE_PLATFORM_PROPERTIES_LIST_END_KHR ((cl_instance_platform_properties_khr)0)

typedef cl_properties cl_instance_platform_properties_khr;

typedef cl_platform_id CL_API_CALL
clIcdCreateInstancePlatformKHR_t(
cl_platform_id platform,
const cl_instance_platform_properties_khr *properties,
cl_int *errcode_ret);

typedef clIcdCreateInstancePlatformKHR_t *
clIcdCreateInstancePlatformKHR_fn;

typedef cl_int CL_API_CALL
clIcdDestroyInstancePlatformKHR_t(
cl_platform_id platform);

typedef clIcdDestroyInstancePlatformKHR_t *
clIcdDestroyInstancePlatformKHR_fn;
#endif //!defined(CL_INSTANCE_PLATFORM_PROPERTIES_LIST_END_KHR)
128 changes: 81 additions & 47 deletions loader/icd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ void khrIcdVendorAdd(const char *libraryName)
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
clIcdGetFunctionAddressForPlatformKHR_fn p_clIcdGetFunctionAddressForPlatform = NULL;
clIcdSetPlatformDispatchDataKHR_fn p_clIcdSetPlatformDispatchData = NULL;
clIcdCreateInstancePlatformKHR_fn p_clIcdCreateInstancePlatform = NULL;
clIcdDestroyInstancePlatformKHR_fn p_clIcdDestroyInstancePlatform = NULL;
#endif
cl_uint i = 0;
cl_uint platformCount = 0;
Expand Down Expand Up @@ -127,6 +129,8 @@ void khrIcdVendorAdd(const char *libraryName)
// try to get clIcdGetFunctionAddressForPlatformKHR and clIcdSetPlatformDispatchDataKHR to detect cl_khr_icd2 support
p_clIcdGetFunctionAddressForPlatform = (clIcdGetFunctionAddressForPlatformKHR_fn)(size_t)p_clGetExtensionFunctionAddress("clIcdGetFunctionAddressForPlatformKHR");
p_clIcdSetPlatformDispatchData = (clIcdSetPlatformDispatchDataKHR_fn)(size_t)p_clGetExtensionFunctionAddress("clIcdSetPlatformDispatchDataKHR");
p_clIcdCreateInstancePlatform = (clIcdCreateInstancePlatformKHR_fn)(size_t)p_clGetExtensionFunctionAddress("clIcdCreateInstancePlatformKHR");
p_clIcdDestroyInstancePlatform = (clIcdDestroyInstancePlatformKHR_fn)(size_t)p_clGetExtensionFunctionAddress("clIcdDestroyInstancePlatformKHR");
#endif

// query the number of platforms available and allocate space to store them
Expand Down Expand Up @@ -154,32 +158,48 @@ void khrIcdVendorAdd(const char *libraryName)
for (i = 0; i < platformCount; ++i)
{
KHRicdVendor* vendor = NULL;
char *extensions;
size_t extensionsSize;
char *suffix;
size_t suffixSize;
char *extensions = NULL;
size_t extensionsSize = 0;
char *suffix = NULL;
size_t suffixSize = 0;
cl_platform_id platform = platforms[i];
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
cl_platform_id instance_platform = NULL;
#endif

// skip NULL platforms and non dispatchable platforms
if (!platforms[i] || !platforms[i]->dispatch)
if (!platform || !platform->dispatch)
{
continue;
KHR_ICD_TRACE("found null platform or non dispatchable platform\n");
goto Error;
}

#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
if (KHR_ICD2_HAS_TAG(platforms[i]) && !p_clIcdGetFunctionAddressForPlatform)
if (KHR_ICD2_HAS_TAG(platform) && !p_clIcdGetFunctionAddressForPlatform)
{
KHR_ICD_TRACE("found icd 2 object, but platform is missing clIcdGetFunctionAddressForPlatformKHR\n");
continue;
goto Error;
}
if (KHR_ICD2_HAS_TAG(platforms[i]) && !p_clIcdSetPlatformDispatchData)
if (KHR_ICD2_HAS_TAG(platform) && !p_clIcdSetPlatformDispatchData)
{
KHR_ICD_TRACE("found icd 2 object, but platform is missing clIcdSetPlatformDispatchDataKHR\n");
continue;
goto Error;
}
if (KHR_ICD2_HAS_TAG(platforms[i]) && !((intptr_t)((platforms[i])->dispatch->clUnloadCompiler) == CL_ICD2_TAG_KHR))
if (KHR_ICD2_HAS_TAG(platform) && !((intptr_t)((platform)->dispatch->clUnloadCompiler) == CL_ICD2_TAG_KHR))
{
KHR_ICD_TRACE("found icd 2 object, but platform is missing tag in clUnloadCompiler\n");
continue;
goto Error;
}
if (p_clIcdCreateInstancePlatform && p_clIcdDestroyInstancePlatform)
{
KHR_ICD_TRACE("found icd 2 object with instance support, creating instance platform\n");
instance_platform = p_clIcdCreateInstancePlatform(platform, NULL, &result);
if (CL_SUCCESS != result || !instance_platform)
{
KHR_ICD_TRACE("failed to create instance platform\n");
goto Error;
}
platform = instance_platform;
}
#endif

Expand All @@ -188,60 +208,62 @@ void khrIcdVendorAdd(const char *libraryName)
if (!vendor)
{
KHR_ICD_TRACE("failed to allocate memory\n");
continue;
goto Error;
}
memset(vendor, 0, sizeof(*vendor));

#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
// populate cl_khr_icd2 platform's loader managed dispatch tables
if (KHR_ICD2_HAS_TAG(platforms[i]))
if (KHR_ICD2_HAS_TAG(platform))
{
khrIcd2PopulateDispatchTable(platforms[i], p_clIcdGetFunctionAddressForPlatform, &vendor->dispData.dispatch);
p_clIcdSetPlatformDispatchData(platforms[i], &vendor->dispData);
khrIcd2PopulateDispatchTable(platform, p_clIcdGetFunctionAddressForPlatform, &vendor->dispData.dispatch);
p_clIcdSetPlatformDispatchData(platform, &vendor->dispData);
KHR_ICD_TRACE("found icd 2 platform, using loader managed dispatch\n");
if (p_clIcdCreateInstancePlatform && p_clIcdDestroyInstancePlatform)
{
vendor->clIcdSetPlatformDispatchData = p_clIcdSetPlatformDispatchData;
vendor->clIcdCreateInstancePlatform = p_clIcdCreateInstancePlatform;
vendor->clIcdDestroyInstancePlatform = p_clIcdDestroyInstancePlatform;
}
}
vendor->instance_platform = instance_platform;
#endif

// call clGetPlatformInfo on the returned platform to get the supported extensions
result = KHR_ICD2_DISPATCH(platforms[i])->clGetPlatformInfo(
platforms[i],
result = KHR_ICD2_DISPATCH(platform)->clGetPlatformInfo(
platform,
CL_PLATFORM_EXTENSIONS,
0,
NULL,
&extensionsSize);
if (CL_SUCCESS != result)
{
KHR_ICD_TRACE("failed query platform extensions\n");
free(vendor);
continue;
goto Error;
}
extensions = (char *)malloc(extensionsSize);
if (!extensions)
{
KHR_ICD_TRACE("failed to allocate memory\n");
free(vendor);
continue;
goto Error;
}
result = KHR_ICD2_DISPATCH(platforms[i])->clGetPlatformInfo(
platforms[i],
result = KHR_ICD2_DISPATCH(platform)->clGetPlatformInfo(
platform,
CL_PLATFORM_EXTENSIONS,
extensionsSize,
extensions,
NULL);
if (CL_SUCCESS != result)
{
KHR_ICD_TRACE("failed query platform extensions\n");
free(extensions);
free(vendor);
continue;
goto Error;
}

if (strstr(extensions, "cl_khr_icd_unloadable"))
{
KHR_ICD_TRACE("found cl_khr_icd_unloadable extension support\n");
free(extensions);
result = KHR_ICD2_DISPATCH(platforms[i])->clGetPlatformInfo(
platforms[i],
result = KHR_ICD2_DISPATCH(platform)->clGetPlatformInfo(
platform,
CL_PLATFORM_UNLOADABLE_KHR,
sizeof(vendor->unloadable),
&vendor->unloadable,
Expand All @@ -253,53 +275,46 @@ void khrIcdVendorAdd(const char *libraryName)
if (CL_SUCCESS != result)
{
KHR_ICD_TRACE("found cl_khr_icd_unloadable but clGetPlatformInfo CL_PLATFORM_UNLOADABLE_KHR query failed\n");
free(vendor);
continue;
goto Error;
}
}

// call clGetPlatformInfo on the returned platform to get the suffix
result = KHR_ICD2_DISPATCH(platforms[i])->clGetPlatformInfo(
platforms[i],
result = KHR_ICD2_DISPATCH(platform)->clGetPlatformInfo(
platform,
CL_PLATFORM_ICD_SUFFIX_KHR,
0,
NULL,
&suffixSize);
if (CL_SUCCESS != result)
{
KHR_ICD_TRACE("failed query platform ICD suffix\n");
free(vendor);
continue;
goto Error;
}
suffix = (char *)malloc(suffixSize);
if (!suffix)
{
KHR_ICD_TRACE("failed to allocate memory\n");
free(vendor);
continue;
goto Error;
}
result = KHR_ICD2_DISPATCH(platforms[i])->clGetPlatformInfo(
platforms[i],
result = KHR_ICD2_DISPATCH(platform)->clGetPlatformInfo(
platform,
CL_PLATFORM_ICD_SUFFIX_KHR,
suffixSize,
suffix,
NULL);
if (CL_SUCCESS != result)
{
KHR_ICD_TRACE("failed query platform ICD suffix\n");
free(suffix);
free(vendor);
continue;
goto Error;
}

// populate vendor data
vendor->library = khrIcdOsLibraryLoad(libraryName);
if (!vendor->library)
{
free(suffix);
free(vendor);
KHR_ICD_TRACE("failed get platform handle to library\n");
continue;
goto Error;
}
vendor->clGetExtensionFunctionAddress = p_clGetExtensionFunctionAddress;
vendor->platform = platforms[i];
Expand All @@ -314,8 +329,19 @@ void khrIcdVendorAdd(const char *libraryName)
}
lastVendor = vendor;

free(extensions);
KHR_ICD_TRACE("successfully added vendor %s with suffix %s\n", libraryName, suffix);

continue;
Error:
free(extensions);
free(suffix);
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
if (instance_platform)
{
p_clIcdDestroyInstancePlatform(instance_platform);
}
#endif
free(vendor);
}

Done:
Expand Down Expand Up @@ -564,7 +590,11 @@ void khrIcdContextPropertiesGetPlatform(const cl_context_properties *properties,
{
if (properties == NULL && khrIcdVendors != NULL)
{
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
*outPlatform = khrIcdVendors[0].instance_platform ? khrIcdVendors[0].instance_platform : khrIcdVendors[0].platform;
#else
*outPlatform = khrIcdVendors[0].platform;
#endif
}
else
{
Expand Down Expand Up @@ -626,6 +656,10 @@ void khrIcdDeinitialize(void) {
while (lastVendor) {
KHRicdVendor *cur = lastVendor;
free(cur->suffix);
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
if (cur->instance_platform)
cur->clIcdDestroyInstancePlatform(cur->instance_platform);
#endif
if (cur->unloadable && !khrDisableLibraryUnloading)
khrIcdOsLibraryUnload(cur->library);
lastVendor = cur->prev;
Expand Down
4 changes: 4 additions & 0 deletions loader/icd.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ struct KHRicdVendorRec
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
// the loader populated dispatch table for cl_khr_icd2 compliant platforms
struct KHRDisp dispData;
clIcdSetPlatformDispatchDataKHR_fn clIcdSetPlatformDispatchData;
clIcdCreateInstancePlatformKHR_fn clIcdCreateInstancePlatform;
clIcdDestroyInstancePlatformKHR_fn clIcdDestroyInstancePlatform;
cl_platform_id instance_platform;
#endif

// next vendor in the list vendors
Expand Down
4 changes: 4 additions & 0 deletions loader/icd_dispatch.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,11 @@ static inline cl_int clGetPlatformIDs_body(
{
if (num_entries && platforms)
{
#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)
*(platforms++) = vendor->instance_platform ? vendor->instance_platform : vendor->platform;
#else
*(platforms++) = vendor->platform;
#endif
--num_entries;
}
if (num_platforms)
Expand Down
Loading