loader/icd_dispatch.h

/*
 * Copyright (c) 2016-2026 The Khronos Group Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * OpenCL is a trademark of Apple Inc. used under license by Khronos.
 */

#ifndef _ICD_DISPATCH_H_
#define _ICD_DISPATCH_H_

#ifndef CL_USE_DEPRECATED_OPENCL_1_0_APIS
#define CL_USE_DEPRECATED_OPENCL_1_0_APIS
#endif

#ifndef CL_USE_DEPRECATED_OPENCL_1_1_APIS
#define CL_USE_DEPRECATED_OPENCL_1_1_APIS
#endif

#ifndef CL_USE_DEPRECATED_OPENCL_1_2_APIS
#define CL_USE_DEPRECATED_OPENCL_1_2_APIS
#endif

#ifndef CL_USE_DEPRECATED_OPENCL_2_0_APIS
#define CL_USE_DEPRECATED_OPENCL_2_0_APIS
#endif

#ifndef CL_USE_DEPRECATED_OPENCL_2_1_APIS
#define CL_USE_DEPRECATED_OPENCL_2_1_APIS
#endif

#ifndef CL_USE_DEPRECATED_OPENCL_2_2_APIS
#define CL_USE_DEPRECATED_OPENCL_2_2_APIS
#endif

// cl.h
#include <CL/cl.h>

// cl_gl.h and required files
#ifdef _WIN32
#include <windows.h>
#include <d3d9.h>
#include <d3d10_1.h>
#include <CL/cl_d3d10.h>
#include <CL/cl_d3d11.h>
#include <CL/cl_dx9_media_sharing.h>
#endif
#include <CL/cl_gl.h>
#include <CL/cl_ext.h>
#include <CL/cl_egl.h>
#include <CL/cl_icd.h>
#include "cl_khr_icd2.h"

#if defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)

extern void khrIcd2PopulateDispatchTable(
    cl_platform_id platform,
    clIcdGetFunctionAddressForPlatformKHR_fn p_clIcdGetFunctionAddressForPlatform,
    struct _cl_icd_dispatch* dispatch);

struct KHRDisp
{
    struct _cl_icd_dispatch dispatch;
};

#if __CL_HAS_ANON_UNION__
#define KHR_ICD2_HAS_TAG(object)                                               \
((object)->dispatch->clGetPlatformIDs_icd2_tag == CL_ICD2_TAG_KHR)
#define KHR_ICD2_HAS_TAG2(object)                                              \
((object)->dispatch->clUnloadCompiler_icd2_tag == CL_ICD2_TAG_KHR)
#else
#define KHR_ICD2_HAS_TAG(object)                                               \
(((intptr_t)((object)->dispatch->clGetPlatformIDs)) == CL_ICD2_TAG_KHR)
#define KHR_ICD2_HAS_TAG2(object)                                              \
(((intptr_t)((object)->dispatch->clUnloadCompiler)) == CL_ICD2_TAG_KHR)
#endif

#define KHR_ICD2_DISPATCH(object)                                              \
(KHR_ICD2_HAS_TAG(object) ?                                                    \
    &(object)->dispData->dispatch :                                            \
    (object)->dispatch)

#define KHR_ICD_OBJECT_BODY {                                                  \
    cl_icd_dispatch *dispatch;                                                 \
    struct KHRDisp  *dispData;                                                 \
}

#else // ! defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)

#define KHR_ICD2_DISPATCH(object) ((object)->dispatch)

#define KHR_ICD_OBJECT_BODY {                                                  \
    cl_icd_dispatch *dispatch;                                                 \
}

#endif // defined(CL_ENABLE_LOADER_MANAGED_DISPATCH)

/*
 *
 * vendor dispatch table structure
 *
 */

struct _cl_platform_id
KHR_ICD_OBJECT_BODY;

struct _cl_device_id
KHR_ICD_OBJECT_BODY;

struct _cl_context
KHR_ICD_OBJECT_BODY;

struct _cl_command_queue
KHR_ICD_OBJECT_BODY;

struct _cl_mem
KHR_ICD_OBJECT_BODY;

struct _cl_program
KHR_ICD_OBJECT_BODY;

struct _cl_kernel
KHR_ICD_OBJECT_BODY;

struct _cl_event
KHR_ICD_OBJECT_BODY;

struct _cl_sampler
KHR_ICD_OBJECT_BODY;

#endif // _ICD_DISPATCH_H_