#include <sycl/detail/export.hpp>
#include <cstddef>
#include <cstdint>
#include <sycl/detail/pi_error.def>
#include <sycl/detail/pi.def>

Include dependency graph for pi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_pi_offload_entry_struct

struct	_pi_device_binary_property_struct

struct	_pi_device_binary_property_set_struct

struct	pi_device_binary_struct
	This struct is a record of the device binary information. More...

struct	pi_buffer_region_struct

struct	pi_buff_rect_offset_struct

struct	pi_buff_rect_region_struct

struct	pi_image_offset_struct

struct	pi_image_region_struct

struct	pi_device_binaries_struct
	This struct is a record of all the device code that may be offloaded. More...

struct	_pi_image_format

struct	_pi_image_desc

struct	_pi_plugin

struct	_pi_plugin::FunctionPointers

Macros
#define	_PI_H_VERSION_MAJOR 10

#define	_PI_H_VERSION_MINOR 14

#define	_PI_STRING_HELPER(a) #a

#define	_PI_CONCAT(a, b) _PI_STRING_HELPER(a.b)

#define	_PI_TRIPLE_CONCAT(a, b, c) _PI_STRING_HELPER(a.b.c)

#define	_PI_PLUGIN_VERSION_STRING(PluginVersion) _PI_TRIPLE_CONCAT(_PI_H_VERSION_MAJOR, _PI_H_VERSION_MINOR, PluginVersion)

#define	_PI_H_VERSION_STRING _PI_CONCAT(_PI_H_VERSION_MAJOR, _PI_H_VERSION_MINOR)

#define	_PI_STRING_SUBSTITUTE(X) _PI_STRING_HELPER(X)

#define	_PI_PLUGIN_VERSION_CHECK(PI_API_VERSION, PI_PLUGIN_VERSION)

#define	_PI_ERRC(NAME, VAL) NAME = VAL,

#define	_PI_ERRC_WITH_MSG(NAME, VAL, MSG) NAME = VAL,

#define	__SYCL_PI_DEVICE_BINARY_TARGET_UNKNOWN "<unknown>"
	Target identification strings for pi_device_binary_struct.DeviceTargetSpec. More...

#define	__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV32 "spir"
	SPIR-V 32-bit image <-> "spir", 32-bit OpenCL device. More...

#define	__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64 "spir64"
	SPIR-V 64-bit image <-> "spir64", 64-bit OpenCL device. More...

#define	__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64 "spir64_x86_64"
	Device-specific binary images produced from SPIR-V 64-bit <-> various "spir64_*" triples for specific 64-bit OpenCL devices. More...

#define	__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN "spir64_gen"

#define	__SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA "spir64_fpga"

#define	__SYCL_PI_DEVICE_BINARY_TARGET_NVPTX64 "nvptx64"
	PTX 64-bit image <-> "nvptx64", 64-bit NVIDIA PTX device. More...

#define	__SYCL_PI_DEVICE_BINARY_TARGET_AMDGCN "amdgcn"

#define	PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT "pi_ext_intel_devicelib_assert"
	Extension to denote native support of assert feature by an arbitrary device piDeviceGetInfo call should return this extension when the device supports native asserts if supported extensions' names are requested. More...

#define	__SYCL_PI_PROPERTY_SET_SPEC_CONST_MAP "SYCL/specialization constants"
	Device binary image property set names recognized by the SYCL runtime. More...

#define	__SYCL_PI_PROPERTY_SET_SPEC_CONST_DEFAULT_VALUES_MAP "SYCL/specialization constants default values"
	PropertySetRegistry::SYCL_SPEC_CONSTANTS_DEFAULT_VALUES defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_DEVICELIB_REQ_MASK "SYCL/devicelib req mask"
	PropertySetRegistry::SYCL_DEVICELIB_REQ_MASK defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_KERNEL_PARAM_OPT_INFO "SYCL/kernel param opt"
	PropertySetRegistry::SYCL_KERNEL_PARAM_OPT_INFO defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_PROGRAM_METADATA "SYCL/program metadata"
	PropertySetRegistry::SYCL_KERNEL_PROGRAM_METADATA defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_SYCL_MISC_PROP "SYCL/misc properties"
	PropertySetRegistry::SYCL_MISC_PROP defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_SYCL_ASSERT_USED "SYCL/assert used"
	PropertySetRegistry::SYCL_ASSERT_USED defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_SYCL_EXPORTED_SYMBOLS "SYCL/exported symbols"
	PropertySetRegistry::SYCL_EXPORTED_SYMBOLS defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROPERTY_SET_SYCL_DEVICE_GLOBALS "SYCL/device globals"
	PropertySetRegistry::SYCL_DEVICE_GLOBALS defined in PropertySetIO.h. More...

#define	__SYCL_PI_PROGRAM_METADATA_TAG_REQD_WORK_GROUP_SIZE "@reqd_work_group_size"
	Program metadata tags recognized by the PI backends. More...

#define	_PI_API(api) decltype(::api) *api;

Typedefs
using	pi_int32 = int32_t

using	pi_uint32 = uint32_t

using	pi_uint64 = uint64_t

using	pi_bool = pi_uint32

using	pi_bitfield = pi_uint64

using	pi_native_handle = uintptr_t

using	pi_context_properties = intptr_t

using	pi_device_exec_capabilities = pi_bitfield

using	pi_sampler_properties = pi_bitfield

using	pi_memory_order_capabilities = pi_bitfield

using	pi_memory_scope_capabilities = pi_bitfield

using	pi_mem_flags = pi_bitfield

using	pi_map_flags = pi_bitfield

using	pi_mem_properties = pi_bitfield

using	pi_usm_mem_properties = pi_bitfield

using	pi_queue_properties = pi_bitfield

using	pi_result = _pi_result

using	pi_platform_info = _pi_platform_info

using	pi_device_type = _pi_device_type

using	pi_device_mem_cache_type = _pi_device_mem_cache_type

using	pi_device_local_mem_type = _pi_device_local_mem_type

using	pi_device_info = _pi_device_info

using	pi_program_info = _pi_program_info

using	pi_context_info = _pi_context_info

using	pi_queue_info = _pi_queue_info

using	pi_image_info = _pi_image_info

using	pi_kernel_info = _pi_kernel_info

using	pi_kernel_group_info = _pi_kernel_group_info

using	pi_kernel_sub_group_info = _pi_kernel_sub_group_info

using	pi_event_info = _pi_event_info

using	pi_command_type = _pi_command_type

using	pi_mem_type = _pi_mem_type

using	pi_mem_advice = _pi_mem_advice

using	pi_image_channel_order = _pi_image_channel_order

using	pi_image_channel_type = _pi_image_channel_type

using	pi_buffer_create_type = _pi_buffer_create_type

using	pi_sampler_addressing_mode = _pi_sampler_addressing_mode

using	pi_sampler_filter_mode = _pi_sampler_filter_mode

using	pi_sampler_info = _pi_sampler_info

using	pi_event_status = _pi_event_status

using	pi_program_build_info = _pi_program_build_info

using	pi_program_build_status = _pi_program_build_status

using	pi_program_binary_type = _pi_program_binary_type

using	pi_profiling_info = _pi_profiling_info

using	pi_device_partition_property = intptr_t

using	pi_device_affinity_domain = pi_bitfield

using	pi_device_fp_config = pi_bitfield

using	_pi_offload_entry = _pi_offload_entry_struct *

typedef _pi_device_binary_property_struct *	pi_device_binary_property

typedef _pi_device_binary_property_set_struct *	pi_device_binary_property_set

using	pi_device_binary_type = uint8_t
	Types of device binary. More...

using	pi_device_binary = pi_device_binary_struct *

using	pi_buffer_region = pi_buffer_region_struct *

using	pi_buff_rect_offset = pi_buff_rect_offset_struct *

using	pi_buff_rect_region = pi_buff_rect_region_struct *

using	pi_image_offset = pi_image_offset_struct *

using	pi_image_region = pi_image_region_struct *

using	pi_device_binaries = pi_device_binaries_struct *

using	pi_platform = _pi_platform *

using	pi_device = _pi_device *

using	pi_context = _pi_context *

using	pi_queue = _pi_queue *

using	pi_mem = _pi_mem *

using	pi_program = _pi_program *

using	pi_kernel = _pi_kernel *

using	pi_event = _pi_event *

using	pi_sampler = _pi_sampler *

using	pi_image_format = _pi_image_format

using	pi_image_desc = _pi_image_desc

using	pi_mem_info = _pi_mem_info

using	pi_plugin = _pi_plugin

typedef void(*	pi_context_extended_deleter) (void *user_data)

using	pi_kernel_exec_info = _pi_kernel_exec_info

using	pi_usm_capability_query = _pi_usm_capability_query

using	pi_usm_capabilities = _pi_usm_capabilities

using	pi_mem_alloc_info = _pi_mem_alloc_info

using	pi_usm_type = _pi_usm_type

using	pi_usm_migration_flags = _pi_usm_migration_flags

Enumerations
enum	_pi_result

enum	_pi_event_status { PI_EVENT_COMPLETE = 0x0, PI_EVENT_RUNNING = 0x1, PI_EVENT_SUBMITTED = 0x2, PI_EVENT_QUEUED = 0x3 }

enum	_pi_platform_info { PI_PLATFORM_INFO_EXTENSIONS = 0x0904, PI_PLATFORM_INFO_NAME = 0x0902, PI_PLATFORM_INFO_PROFILE = 0x0900, PI_PLATFORM_INFO_VENDOR = 0x0903, PI_PLATFORM_INFO_VERSION = 0x0901 }

enum	_pi_program_build_info { PI_PROGRAM_BUILD_INFO_STATUS = 0x1181, PI_PROGRAM_BUILD_INFO_OPTIONS = 0x1182, PI_PROGRAM_BUILD_INFO_LOG = 0x1183, PI_PROGRAM_BUILD_INFO_BINARY_TYPE = 0x1184 }

enum	_pi_program_build_status { PI_PROGRAM_BUILD_STATUS_NONE = -1, PI_PROGRAM_BUILD_STATUS_ERROR = -2, PI_PROGRAM_BUILD_STATUS_SUCCESS = 0, PI_PROGRAM_BUILD_STATUS_IN_PROGRESS = -3 }

enum	_pi_program_binary_type { PI_PROGRAM_BINARY_TYPE_NONE = 0x0, PI_PROGRAM_BINARY_TYPE_COMPILED_OBJECT = 0x1, PI_PROGRAM_BINARY_TYPE_LIBRARY = 0x2, PI_PROGRAM_BINARY_TYPE_EXECUTABLE = 0x4 }

enum	_pi_device_type : pi_uint64 { PI_DEVICE_TYPE_DEFAULT, PI_DEVICE_TYPE_ALL = 0xFFFFFFFF, PI_DEVICE_TYPE_CPU = (1 << 1), PI_DEVICE_TYPE_GPU = (1 << 2), PI_DEVICE_TYPE_ACC = (1 << 3), PI_DEVICE_TYPE_CUSTOM = (1 << 4) }

enum	_pi_device_mem_cache_type { PI_DEVICE_MEM_CACHE_TYPE_NONE = 0x0, PI_DEVICE_MEM_CACHE_TYPE_READ_ONLY_CACHE = 0x1, PI_DEVICE_MEM_CACHE_TYPE_READ_WRITE_CACHE = 0x2 }

enum	_pi_device_local_mem_type { PI_DEVICE_LOCAL_MEM_TYPE_LOCAL = 0x1, PI_DEVICE_LOCAL_MEM_TYPE_GLOBAL = 0x2 }

enum	_pi_device_info { PI_DEVICE_INFO_TYPE = 0x1000, PI_DEVICE_INFO_VENDOR_ID = 0x1001, PI_DEVICE_INFO_MAX_COMPUTE_UNITS = 0x1002, PI_DEVICE_INFO_MAX_WORK_ITEM_DIMENSIONS = 0x1003, PI_DEVICE_INFO_MAX_WORK_ITEM_SIZES = 0x1005, PI_DEVICE_INFO_MAX_WORK_GROUP_SIZE = 0x1004, PI_DEVICE_INFO_SINGLE_FP_CONFIG = 0x101B, PI_DEVICE_INFO_HALF_FP_CONFIG = 0x1033, PI_DEVICE_INFO_DOUBLE_FP_CONFIG = 0x1032, PI_DEVICE_INFO_QUEUE_PROPERTIES = 0x102A, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_CHAR = 0x1006, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_SHORT = 0x1007, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_INT = 0x1008, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_LONG = 0x1009, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_FLOAT = 0x100A, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_DOUBLE = 0x100B, PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_HALF = 0x1034, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_CHAR = 0x1036, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_SHORT = 0x1037, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_INT = 0x1038, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_LONG = 0x1039, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_FLOAT = 0x103A, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_DOUBLE = 0x103B, PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_HALF = 0x103C, PI_DEVICE_INFO_MAX_CLOCK_FREQUENCY = 0x100C, PI_DEVICE_INFO_ADDRESS_BITS = 0x100D, PI_DEVICE_INFO_MAX_MEM_ALLOC_SIZE = 0x1010, PI_DEVICE_INFO_IMAGE_SUPPORT = 0x1016, PI_DEVICE_INFO_MAX_READ_IMAGE_ARGS = 0x100E, PI_DEVICE_INFO_MAX_WRITE_IMAGE_ARGS = 0x100F, PI_DEVICE_INFO_IMAGE2D_MAX_WIDTH = 0x1011, PI_DEVICE_INFO_IMAGE2D_MAX_HEIGHT = 0x1012, PI_DEVICE_INFO_IMAGE3D_MAX_WIDTH = 0x1013, PI_DEVICE_INFO_IMAGE3D_MAX_HEIGHT = 0x1014, PI_DEVICE_INFO_IMAGE3D_MAX_DEPTH = 0x1015, PI_DEVICE_INFO_IMAGE_MAX_BUFFER_SIZE = 0x1040, PI_DEVICE_INFO_IMAGE_MAX_ARRAY_SIZE = 0x1041, PI_DEVICE_INFO_MAX_SAMPLERS = 0x1018, PI_DEVICE_INFO_MAX_PARAMETER_SIZE = 0x1017, PI_DEVICE_INFO_MEM_BASE_ADDR_ALIGN = 0x1019, PI_DEVICE_INFO_GLOBAL_MEM_CACHE_TYPE = 0x101C, PI_DEVICE_INFO_GLOBAL_MEM_CACHELINE_SIZE = 0x101D, PI_DEVICE_INFO_GLOBAL_MEM_CACHE_SIZE = 0x101E, PI_DEVICE_INFO_GLOBAL_MEM_SIZE = 0x101F, PI_DEVICE_INFO_MAX_CONSTANT_BUFFER_SIZE = 0x1020, PI_DEVICE_INFO_MAX_CONSTANT_ARGS = 0x1021, PI_DEVICE_INFO_LOCAL_MEM_TYPE = 0x1022, PI_DEVICE_INFO_LOCAL_MEM_SIZE = 0x1023, PI_DEVICE_INFO_ERROR_CORRECTION_SUPPORT = 0x1024, PI_DEVICE_INFO_HOST_UNIFIED_MEMORY = 0x1035, PI_DEVICE_INFO_PROFILING_TIMER_RESOLUTION = 0x1025, PI_DEVICE_INFO_ENDIAN_LITTLE = 0x1026, PI_DEVICE_INFO_AVAILABLE = 0x1027, PI_DEVICE_INFO_COMPILER_AVAILABLE = 0x1028, PI_DEVICE_INFO_LINKER_AVAILABLE = 0x103E, PI_DEVICE_INFO_EXECUTION_CAPABILITIES = 0x1029, PI_DEVICE_INFO_QUEUE_ON_DEVICE_PROPERTIES = 0x104E, PI_DEVICE_INFO_QUEUE_ON_HOST_PROPERTIES = 0x102A, PI_DEVICE_INFO_BUILT_IN_KERNELS = 0x103F, PI_DEVICE_INFO_PLATFORM = 0x1031, PI_DEVICE_INFO_REFERENCE_COUNT = 0x1047, PI_DEVICE_INFO_IL_VERSION = 0x105B, PI_DEVICE_INFO_NAME = 0x102B, PI_DEVICE_INFO_VENDOR = 0x102C, PI_DEVICE_INFO_DRIVER_VERSION = 0x102D, PI_DEVICE_INFO_PROFILE = 0x102E, PI_DEVICE_INFO_VERSION = 0x102F, PI_DEVICE_INFO_OPENCL_C_VERSION = 0x103D, PI_DEVICE_INFO_EXTENSIONS = 0x1030, PI_DEVICE_INFO_PRINTF_BUFFER_SIZE = 0x1049, PI_DEVICE_INFO_PREFERRED_INTEROP_USER_SYNC = 0x1048, PI_DEVICE_INFO_PARENT_DEVICE = 0x1042, PI_DEVICE_INFO_PARTITION_PROPERTIES = 0x1044, PI_DEVICE_INFO_PARTITION_MAX_SUB_DEVICES = 0x1043, PI_DEVICE_INFO_PARTITION_AFFINITY_DOMAIN = 0x1045, PI_DEVICE_INFO_PARTITION_TYPE = 0x1046, PI_DEVICE_INFO_MAX_NUM_SUB_GROUPS = 0x105C, PI_DEVICE_INFO_SUB_GROUP_INDEPENDENT_FORWARD_PROGRESS = 0x105D, PI_DEVICE_INFO_SUB_GROUP_SIZES_INTEL = 0x4108, PI_DEVICE_INFO_USM_HOST_SUPPORT = 0x4190, PI_DEVICE_INFO_USM_DEVICE_SUPPORT = 0x4191, PI_DEVICE_INFO_USM_SINGLE_SHARED_SUPPORT = 0x4192, PI_DEVICE_INFO_USM_CROSS_SHARED_SUPPORT = 0x4193, PI_DEVICE_INFO_USM_SYSTEM_SHARED_SUPPORT = 0x4194, PI_DEVICE_INFO_UUID = 0x106A, PI_DEVICE_INFO_PCI_ADDRESS = 0x10020, PI_DEVICE_INFO_GPU_EU_COUNT = 0x10021, PI_DEVICE_INFO_GPU_EU_SIMD_WIDTH = 0x10022, PI_DEVICE_INFO_GPU_SLICES = 0x10023, PI_DEVICE_INFO_GPU_SUBSLICES_PER_SLICE = 0x10024, PI_DEVICE_INFO_GPU_EU_COUNT_PER_SUBSLICE = 0x10025, PI_DEVICE_INFO_MAX_MEM_BANDWIDTH = 0x10026, PI_DEVICE_INFO_IMAGE_SRGB = 0x10027, PI_DEVICE_INFO_BUILD_ON_SUBDEVICE = 0x10028, PI_EXT_INTEL_DEVICE_INFO_FREE_MEMORY = 0x10029, PI_DEVICE_INFO_ATOMIC_64 = 0x10110, PI_DEVICE_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES = 0x10111, PI_DEVICE_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES = 0x11000, PI_DEVICE_INFO_GPU_HW_THREADS_PER_EU = 0x10112, PI_DEVICE_INFO_BACKEND_VERSION = 0x10113, PI_EXT_ONEAPI_DEVICE_INFO_BFLOAT16 = 0x1FFFF, PI_EXT_ONEAPI_DEVICE_INFO_MAX_GLOBAL_WORK_GROUPS = 0x20000, PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_1D = 0x20001, PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_2D = 0x20002, PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_3D = 0x20003, PI_EXT_ONEAPI_DEVICE_INFO_CUDA_ASYNC_BARRIER = 0x20004 }

enum	_pi_program_info { PI_PROGRAM_INFO_REFERENCE_COUNT = 0x1160, PI_PROGRAM_INFO_CONTEXT = 0x1161, PI_PROGRAM_INFO_NUM_DEVICES = 0x1162, PI_PROGRAM_INFO_DEVICES = 0x1163, PI_PROGRAM_INFO_SOURCE = 0x1164, PI_PROGRAM_INFO_BINARY_SIZES = 0x1165, PI_PROGRAM_INFO_BINARIES = 0x1166, PI_PROGRAM_INFO_NUM_KERNELS = 0x1167, PI_PROGRAM_INFO_KERNEL_NAMES = 0x1168 }

enum	_pi_context_info { PI_CONTEXT_INFO_DEVICES = 0x1081, PI_CONTEXT_INFO_PLATFORM = 0x1084, PI_CONTEXT_INFO_NUM_DEVICES = 0x1083, PI_CONTEXT_INFO_PROPERTIES = 0x1082, PI_CONTEXT_INFO_REFERENCE_COUNT = 0x1080, PI_CONTEXT_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES = 0x10010, PI_CONTEXT_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES = 0x10011 }

enum	_pi_queue_info { PI_QUEUE_INFO_CONTEXT = 0x1090, PI_QUEUE_INFO_DEVICE = 0x1091, PI_QUEUE_INFO_DEVICE_DEFAULT = 0x1095, PI_QUEUE_INFO_PROPERTIES = 0x1093, PI_QUEUE_INFO_REFERENCE_COUNT = 0x1092, PI_QUEUE_INFO_SIZE = 0x1094 }

enum	_pi_kernel_info { PI_KERNEL_INFO_FUNCTION_NAME = 0x1190, PI_KERNEL_INFO_NUM_ARGS = 0x1191, PI_KERNEL_INFO_REFERENCE_COUNT = 0x1192, PI_KERNEL_INFO_CONTEXT = 0x1193, PI_KERNEL_INFO_PROGRAM = 0x1194, PI_KERNEL_INFO_ATTRIBUTES = 0x1195 }

enum	_pi_kernel_group_info { PI_KERNEL_GROUP_INFO_GLOBAL_WORK_SIZE = 0x11B5, PI_KERNEL_GROUP_INFO_WORK_GROUP_SIZE = 0x11B0, PI_KERNEL_GROUP_INFO_COMPILE_WORK_GROUP_SIZE = 0x11B1, PI_KERNEL_GROUP_INFO_LOCAL_MEM_SIZE = 0x11B2, PI_KERNEL_GROUP_INFO_PREFERRED_WORK_GROUP_SIZE_MULTIPLE = 0x11B3, PI_KERNEL_GROUP_INFO_PRIVATE_MEM_SIZE = 0x11B4, PI_KERNEL_GROUP_INFO_NUM_REGS = 0x10112 }

enum	_pi_image_info { PI_IMAGE_INFO_FORMAT = 0x1110, PI_IMAGE_INFO_ELEMENT_SIZE = 0x1111, PI_IMAGE_INFO_ROW_PITCH = 0x1112, PI_IMAGE_INFO_SLICE_PITCH = 0x1113, PI_IMAGE_INFO_WIDTH = 0x1114, PI_IMAGE_INFO_HEIGHT = 0x1115, PI_IMAGE_INFO_DEPTH = 0x1116 }

enum	_pi_kernel_sub_group_info { PI_KERNEL_MAX_SUB_GROUP_SIZE = 0x2033, PI_KERNEL_MAX_NUM_SUB_GROUPS = 0x11B9, PI_KERNEL_COMPILE_NUM_SUB_GROUPS = 0x11BA, PI_KERNEL_COMPILE_SUB_GROUP_SIZE_INTEL = 0x410A }

enum	_pi_event_info { PI_EVENT_INFO_COMMAND_QUEUE = 0x11D0, PI_EVENT_INFO_CONTEXT = 0x11D4, PI_EVENT_INFO_COMMAND_TYPE = 0x11D1, PI_EVENT_INFO_COMMAND_EXECUTION_STATUS = 0x11D3, PI_EVENT_INFO_REFERENCE_COUNT = 0x11D2 }

enum	_pi_command_type { PI_COMMAND_TYPE_NDRANGE_KERNEL = 0x11F0, PI_COMMAND_TYPE_MEM_BUFFER_READ = 0x11F3, PI_COMMAND_TYPE_MEM_BUFFER_WRITE = 0x11F4, PI_COMMAND_TYPE_MEM_BUFFER_COPY = 0x11F5, PI_COMMAND_TYPE_MEM_BUFFER_MAP = 0x11FB, PI_COMMAND_TYPE_MEM_BUFFER_UNMAP = 0x11FD, PI_COMMAND_TYPE_MEM_BUFFER_READ_RECT = 0x1201, PI_COMMAND_TYPE_MEM_BUFFER_WRITE_RECT = 0x1202, PI_COMMAND_TYPE_MEM_BUFFER_COPY_RECT = 0x1203, PI_COMMAND_TYPE_USER = 0x1204, PI_COMMAND_TYPE_MEM_BUFFER_FILL = 0x1207, PI_COMMAND_TYPE_IMAGE_READ = 0x11F6, PI_COMMAND_TYPE_IMAGE_WRITE = 0x11F7, PI_COMMAND_TYPE_IMAGE_COPY = 0x11F8, PI_COMMAND_TYPE_NATIVE_KERNEL = 0x11F2, PI_COMMAND_TYPE_COPY_BUFFER_TO_IMAGE = 0x11FA, PI_COMMAND_TYPE_COPY_IMAGE_TO_BUFFER = 0x11F9, PI_COMMAND_TYPE_MAP_IMAGE = 0x11FC, PI_COMMAND_TYPE_MARKER = 0x11FE, PI_COMMAND_TYPE_ACQUIRE_GL_OBJECTS = 0x11FF, PI_COMMAND_TYPE_RELEASE_GL_OBJECTS = 0x1200, PI_COMMAND_TYPE_BARRIER = 0x1205, PI_COMMAND_TYPE_MIGRATE_MEM_OBJECTS = 0x1206, PI_COMMAND_TYPE_FILL_IMAGE = 0x1208, PI_COMMAND_TYPE_SVM_FREE = 0x1209, PI_COMMAND_TYPE_SVM_MEMCPY = 0x120A, PI_COMMAND_TYPE_SVM_MEMFILL = 0x120B, PI_COMMAND_TYPE_SVM_MAP = 0x120C, PI_COMMAND_TYPE_SVM_UNMAP = 0x120D }

enum	_pi_mem_type { PI_MEM_TYPE_BUFFER = 0x10F0, PI_MEM_TYPE_IMAGE2D = 0x10F1, PI_MEM_TYPE_IMAGE3D = 0x10F2, PI_MEM_TYPE_IMAGE2D_ARRAY = 0x10F3, PI_MEM_TYPE_IMAGE1D = 0x10F4, PI_MEM_TYPE_IMAGE1D_ARRAY = 0x10F5, PI_MEM_TYPE_IMAGE1D_BUFFER = 0x10F6 }

enum	_pi_mem_advice { PI_MEM_ADVICE_RESET = 0, PI_MEM_ADVICE_CUDA_SET_READ_MOSTLY = 101, PI_MEM_ADVICE_CUDA_UNSET_READ_MOSTLY = 102, PI_MEM_ADVICE_CUDA_SET_PREFERRED_LOCATION = 103, PI_MEM_ADVICE_CUDA_UNSET_PREFERRED_LOCATION = 104, PI_MEM_ADVICE_CUDA_SET_ACCESSED_BY = 105, PI_MEM_ADVICE_CUDA_UNSET_ACCESSED_BY = 106, PI_MEM_ADVICE_CUDA_SET_PREFERRED_LOCATION_HOST = 107, PI_MEM_ADVICE_CUDA_UNSET_PREFERRED_LOCATION_HOST = 108, PI_MEM_ADVICE_CUDA_SET_ACCESSED_BY_HOST = 109, PI_MEM_ADVICE_CUDA_UNSET_ACCESSED_BY_HOST = 110, PI_MEM_ADVICE_UNKNOWN = 999 }

enum	_pi_image_channel_order { PI_IMAGE_CHANNEL_ORDER_A = 0x10B1, PI_IMAGE_CHANNEL_ORDER_R = 0x10B0, PI_IMAGE_CHANNEL_ORDER_RG = 0x10B2, PI_IMAGE_CHANNEL_ORDER_RA = 0x10B3, PI_IMAGE_CHANNEL_ORDER_RGB = 0x10B4, PI_IMAGE_CHANNEL_ORDER_RGBA = 0x10B5, PI_IMAGE_CHANNEL_ORDER_BGRA = 0x10B6, PI_IMAGE_CHANNEL_ORDER_ARGB = 0x10B7, PI_IMAGE_CHANNEL_ORDER_ABGR = 0x10C3, PI_IMAGE_CHANNEL_ORDER_INTENSITY = 0x10B8, PI_IMAGE_CHANNEL_ORDER_LUMINANCE = 0x10B9, PI_IMAGE_CHANNEL_ORDER_Rx = 0x10BA, PI_IMAGE_CHANNEL_ORDER_RGx = 0x10BB, PI_IMAGE_CHANNEL_ORDER_RGBx = 0x10BC, PI_IMAGE_CHANNEL_ORDER_sRGBA = 0x10C1 }

enum	_pi_image_channel_type { PI_IMAGE_CHANNEL_TYPE_SNORM_INT8 = 0x10D0, PI_IMAGE_CHANNEL_TYPE_SNORM_INT16 = 0x10D1, PI_IMAGE_CHANNEL_TYPE_UNORM_INT8 = 0x10D2, PI_IMAGE_CHANNEL_TYPE_UNORM_INT16 = 0x10D3, PI_IMAGE_CHANNEL_TYPE_UNORM_SHORT_565 = 0x10D4, PI_IMAGE_CHANNEL_TYPE_UNORM_SHORT_555 = 0x10D5, PI_IMAGE_CHANNEL_TYPE_UNORM_INT_101010 = 0x10D6, PI_IMAGE_CHANNEL_TYPE_SIGNED_INT8 = 0x10D7, PI_IMAGE_CHANNEL_TYPE_SIGNED_INT16 = 0x10D8, PI_IMAGE_CHANNEL_TYPE_SIGNED_INT32 = 0x10D9, PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8 = 0x10DA, PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16 = 0x10DB, PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32 = 0x10DC, PI_IMAGE_CHANNEL_TYPE_HALF_FLOAT = 0x10DD, PI_IMAGE_CHANNEL_TYPE_FLOAT = 0x10DE }

enum	_pi_buffer_create_type { PI_BUFFER_CREATE_TYPE_REGION = 0x1220 }

enum	_pi_sampler_info { PI_SAMPLER_INFO_REFERENCE_COUNT = 0x1150, PI_SAMPLER_INFO_CONTEXT = 0x1151, PI_SAMPLER_INFO_NORMALIZED_COORDS = 0x1152, PI_SAMPLER_INFO_ADDRESSING_MODE = 0x1153, PI_SAMPLER_INFO_FILTER_MODE = 0x1154, PI_SAMPLER_INFO_MIP_FILTER_MODE = 0x1155, PI_SAMPLER_INFO_LOD_MIN = 0x1156, PI_SAMPLER_INFO_LOD_MAX = 0x1157 }

enum	_pi_sampler_addressing_mode { PI_SAMPLER_ADDRESSING_MODE_MIRRORED_REPEAT = 0x1134, PI_SAMPLER_ADDRESSING_MODE_REPEAT = 0x1133, PI_SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE = 0x1131, PI_SAMPLER_ADDRESSING_MODE_CLAMP = 0x1132, PI_SAMPLER_ADDRESSING_MODE_NONE = 0x1130 }

enum	_pi_sampler_filter_mode { PI_SAMPLER_FILTER_MODE_NEAREST = 0x1140, PI_SAMPLER_FILTER_MODE_LINEAR = 0x1141 }

enum	_pi_profiling_info { PI_PROFILING_INFO_COMMAND_QUEUED = 0x1280, PI_PROFILING_INFO_COMMAND_SUBMIT = 0x1281, PI_PROFILING_INFO_COMMAND_START = 0x1282, PI_PROFILING_INFO_COMMAND_END = 0x1283 }

enum	pi_property_type { PI_PROPERTY_TYPE_UNKNOWN, PI_PROPERTY_TYPE_UINT32, PI_PROPERTY_TYPE_BYTE_ARRAY, PI_PROPERTY_TYPE_STRING }

enum	_pi_mem_info { PI_MEM_CONTEXT = 0x1106, PI_MEM_SIZE = 0x1102 }

enum	_pi_kernel_exec_info { PI_USM_INDIRECT_ACCESS, PI_USM_PTRS = 0x4203 }

enum	_pi_usm_capability_query { PI_USM_HOST_SUPPORT = 0x4190, PI_USM_DEVICE_SUPPORT = 0x4191, PI_USM_SINGLE_SHARED_SUPPORT = 0x4192, PI_USM_CROSS_SHARED_SUPPORT = 0x4193, PI_USM_SYSTEM_SHARED_SUPPORT = 0x4194 }

enum	_pi_usm_capabilities : pi_bitfield { PI_USM_ACCESS = (1 << 0), PI_USM_ATOMIC_ACCESS = (1 << 1), PI_USM_CONCURRENT_ACCESS = (1 << 2), PI_USM_CONCURRENT_ATOMIC_ACCESS = (1 << 3) }

enum	_pi_mem_alloc_info { PI_MEM_ALLOC_TYPE = 0x419A, PI_MEM_ALLOC_BASE_PTR = 0x419B, PI_MEM_ALLOC_SIZE = 0x419C, PI_MEM_ALLOC_DEVICE = 0x419D }

enum	_pi_usm_type { PI_MEM_TYPE_UNKNOWN = 0x4196, PI_MEM_TYPE_HOST = 0x4197, PI_MEM_TYPE_DEVICE = 0x4198, PI_MEM_TYPE_SHARED = 0x4199 }

enum	_pi_usm_migration_flags : pi_bitfield { PI_USM_MIGRATION_TBD0 = (1 << 0) }

Functions
pi_result	piPluginInit (pi_plugin *plugin_info)

pi_result	piPlatformsGet (pi_uint32 num_entries, pi_platform platforms, pi_uint32 num_platforms)

pi_result	piPlatformGetInfo (pi_platform platform, pi_platform_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piextPlatformGetNativeHandle (pi_platform platform, pi_native_handle *nativeHandle)
	Gets the native handle of a PI platform object. More...

pi_result	piextPlatformCreateWithNativeHandle (pi_native_handle nativeHandle, pi_platform *platform)
	Creates PI platform object from a native handle. More...

pi_result	piDevicesGet (pi_platform platform, pi_device_type device_type, pi_uint32 num_entries, pi_device devices, pi_uint32 num_devices)

pi_result	piDeviceGetInfo (pi_device device, pi_device_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)
	Returns requested info for provided native device Return PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT for PI_DEVICE_INFO_EXTENSIONS query when the device supports native asserts. More...

pi_result	piDeviceRetain (pi_device device)

pi_result	piDeviceRelease (pi_device device)

pi_result	piDevicePartition (pi_device device, const pi_device_partition_property properties, pi_uint32 num_devices, pi_device out_devices, pi_uint32 *out_num_devices)

pi_result	piextDeviceGetNativeHandle (pi_device device, pi_native_handle *nativeHandle)
	Gets the native handle of a PI device object. More...

pi_result	piextDeviceCreateWithNativeHandle (pi_native_handle nativeHandle, pi_platform platform, pi_device *device)
	Creates PI device object from a native handle. More...

pi_result	piextDeviceSelectBinary (pi_device device, pi_device_binary binaries, pi_uint32 num_binaries, pi_uint32 selected_binary_ind)
	Selects the most appropriate device binary based on runtime information and the IR characteristics. More...

pi_result	piextGetDeviceFunctionPointer (pi_device device, pi_program program, const char function_name, pi_uint64 function_pointer_ret)
	Retrieves a device function pointer to a user-defined function. More...

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_data), void user_data, pi_context ret_context)

pi_result	piContextGetInfo (pi_context context, pi_context_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piContextRetain (pi_context context)

pi_result	piContextRelease (pi_context context)

pi_result	piextContextSetExtendedDeleter (pi_context context, pi_context_extended_deleter func, void *user_data)

pi_result	piextContextGetNativeHandle (pi_context context, pi_native_handle *nativeHandle)
	Gets the native handle of a PI context object. More...

pi_result	piextContextCreateWithNativeHandle (pi_native_handle nativeHandle, pi_uint32 numDevices, const pi_device devices, bool pluginOwnsNativeHandle, pi_context context)
	Creates PI context object from a native handle. More...

pi_result	piQueueCreate (pi_context context, pi_device device, pi_queue_properties properties, pi_queue *queue)

pi_result	piQueueGetInfo (pi_queue command_queue, pi_queue_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piQueueRetain (pi_queue command_queue)

pi_result	piQueueRelease (pi_queue command_queue)

pi_result	piQueueFinish (pi_queue command_queue)

pi_result	piQueueFlush (pi_queue command_queue)

pi_result	piextQueueGetNativeHandle (pi_queue queue, pi_native_handle *nativeHandle)
	Gets the native handle of a PI queue object. More...

pi_result	piextQueueCreateWithNativeHandle (pi_native_handle nativeHandle, pi_context context, pi_device device, bool pluginOwnsNativeHandle, pi_queue *queue)
	Creates PI queue object from a native handle. More...

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=nullptr)

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	piMemGetInfo (pi_mem mem, pi_mem_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piMemImageGetInfo (pi_mem image, pi_image_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piMemRetain (pi_mem mem)

pi_result	piMemRelease (pi_mem mem)

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	piextMemGetNativeHandle (pi_mem mem, pi_native_handle *nativeHandle)
	Gets the native handle of a PI mem object. More...

pi_result	piextMemCreateWithNativeHandle (pi_native_handle nativeHandle, pi_context context, bool ownNativeHandle, pi_mem *mem)
	Creates PI mem object from a native handle. More...

pi_result	piProgramCreate (pi_context context, const void il, size_t length, pi_program res_program)

pi_result	piclProgramCreateWithSource (pi_context context, pi_uint32 count, const char *strings, const size_t lengths, pi_program *ret_program)

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)
	Creates a PI program for a context and loads the given binary into it. More...

pi_result	piProgramGetInfo (pi_program program, pi_program_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

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	piProgramCompile (pi_program program, pi_uint32 num_devices, const pi_device device_list, const char options, pi_uint32 num_input_headers, const pi_program input_headers, const char header_include_names, void(pfn_notify)(pi_program program, void user_data), void user_data)

pi_result	piProgramBuild (pi_program program, pi_uint32 num_devices, const pi_device device_list, const char options, void(pfn_notify)(pi_program program, void user_data), void *user_data)

pi_result	piProgramGetBuildInfo (pi_program program, pi_device device, _pi_program_build_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piProgramRetain (pi_program program)

pi_result	piProgramRelease (pi_program program)

pi_result	piextProgramSetSpecializationConstant (pi_program prog, pi_uint32 spec_id, size_t spec_size, const void *spec_value)
	Sets a specialization constant to a specific value. More...

pi_result	piextProgramGetNativeHandle (pi_program program, pi_native_handle *nativeHandle)
	Gets the native handle of a PI program object. More...

pi_result	piextProgramCreateWithNativeHandle (pi_native_handle nativeHandle, pi_context context, bool pluginOwnsNativeHandle, pi_program *program)
	Creates PI program object from a native handle. More...

pi_result	piKernelCreate (pi_program program, const char kernel_name, pi_kernel ret_kernel)

pi_result	piKernelSetArg (pi_kernel kernel, pi_uint32 arg_index, size_t arg_size, const void *arg_value)

pi_result	piKernelGetInfo (pi_kernel kernel, pi_kernel_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

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)

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, size_t param_value_size, void param_value, size_t *param_value_size_ret)
	API to query information from the sub-group from a kernel. More...

pi_result	piKernelRetain (pi_kernel kernel)

pi_result	piKernelRelease (pi_kernel kernel)

pi_result	piextKernelSetArgPointer (pi_kernel kernel, pi_uint32 arg_index, size_t arg_size, const void *arg_value)
	Sets up pointer arguments for CL kernels. More...

pi_result	piKernelSetExecInfo (pi_kernel kernel, pi_kernel_exec_info value_name, size_t param_value_size, const void *param_value)
	API to set attributes controlling kernel execution. More...

pi_result	piextKernelCreateWithNativeHandle (pi_native_handle nativeHandle, pi_context context, pi_program program, bool pluginOwnsNativeHandle, pi_kernel *kernel)
	Creates PI kernel object from a native handle. More...

pi_result	piextKernelGetNativeHandle (pi_kernel kernel, pi_native_handle *nativeHandle)
	Gets the native handle of a PI kernel object. More...

pi_result	piEventCreate (pi_context context, pi_event *ret_event)

pi_result	piEventGetInfo (pi_event event, pi_event_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piEventGetProfilingInfo (pi_event event, pi_profiling_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piEventsWait (pi_uint32 num_events, const pi_event *event_list)

pi_result	piEventSetCallback (pi_event event, pi_int32 command_exec_callback_type, void(pfn_notify)(pi_event event, pi_int32 event_command_status, void user_data), void *user_data)

pi_result	piEventSetStatus (pi_event event, pi_int32 execution_status)

pi_result	piEventRetain (pi_event event)

pi_result	piEventRelease (pi_event event)

pi_result	piextEventGetNativeHandle (pi_event event, pi_native_handle *nativeHandle)
	Gets the native handle of a PI event object. More...

pi_result	piextEventCreateWithNativeHandle (pi_native_handle nativeHandle, pi_context context, bool ownNativeHandle, pi_event *event)
	Creates PI event object from a native handle. More...

pi_result	piSamplerCreate (pi_context context, const pi_sampler_properties sampler_properties, pi_sampler result_sampler)

pi_result	piSamplerGetInfo (pi_sampler sampler, pi_sampler_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret)

pi_result	piSamplerRetain (pi_sampler sampler)

pi_result	piSamplerRelease (pi_sampler sampler)

pi_result	piEnqueueKernelLaunch (pi_queue queue, pi_kernel kernel, pi_uint32 work_dim, const size_t global_work_offset, const size_t global_work_size, const size_t local_work_size, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueNativeKernel (pi_queue queue, void(user_func)(void ), void args, size_t cb_args, pi_uint32 num_mem_objects, const pi_mem mem_list, const void *args_mem_loc, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueEventsWait (pi_queue command_queue, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event)

pi_result	piEnqueueEventsWaitWithBarrier (pi_queue command_queue, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event)

pi_result	piEnqueueMemBufferRead (pi_queue queue, pi_mem buffer, pi_bool blocking_read, size_t offset, size_t size, void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemBufferReadRect (pi_queue command_queue, pi_mem buffer, pi_bool blocking_read, pi_buff_rect_offset buffer_offset, pi_buff_rect_offset host_offset, pi_buff_rect_region region, size_t buffer_row_pitch, size_t buffer_slice_pitch, size_t host_row_pitch, size_t host_slice_pitch, void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemBufferWrite (pi_queue command_queue, pi_mem buffer, pi_bool blocking_write, size_t offset, size_t size, const void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemBufferWriteRect (pi_queue command_queue, pi_mem buffer, pi_bool blocking_write, pi_buff_rect_offset buffer_offset, pi_buff_rect_offset host_offset, pi_buff_rect_region region, size_t buffer_row_pitch, size_t buffer_slice_pitch, size_t host_row_pitch, size_t host_slice_pitch, const void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemBufferCopy (pi_queue command_queue, pi_mem src_buffer, pi_mem dst_buffer, size_t src_offset, size_t dst_offset, size_t size, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event)

pi_result	piEnqueueMemBufferCopyRect (pi_queue command_queue, pi_mem src_buffer, pi_mem dst_buffer, pi_buff_rect_offset src_origin, pi_buff_rect_offset dst_origin, pi_buff_rect_region region, size_t src_row_pitch, size_t src_slice_pitch, size_t dst_row_pitch, size_t dst_slice_pitch, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event)

pi_result	piEnqueueMemBufferFill (pi_queue command_queue, pi_mem buffer, const void pattern, size_t pattern_size, size_t offset, size_t size, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemImageRead (pi_queue command_queue, pi_mem image, pi_bool blocking_read, pi_image_offset origin, pi_image_region region, size_t row_pitch, size_t slice_pitch, void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemImageWrite (pi_queue command_queue, pi_mem image, pi_bool blocking_write, pi_image_offset origin, pi_image_region region, size_t input_row_pitch, size_t input_slice_pitch, const void ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemImageCopy (pi_queue command_queue, pi_mem src_image, pi_mem dst_image, pi_image_offset src_origin, pi_image_offset dst_origin, pi_image_region region, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event)

pi_result	piEnqueueMemImageFill (pi_queue command_queue, pi_mem image, const void fill_color, const size_t origin, const size_t region, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piEnqueueMemBufferMap (pi_queue command_queue, pi_mem buffer, pi_bool blocking_map, pi_map_flags map_flags, size_t offset, size_t size, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event event, void **ret_map)

pi_result	piEnqueueMemUnmap (pi_queue command_queue, pi_mem memobj, void mapped_ptr, pi_uint32 num_events_in_wait_list, const pi_event event_wait_list, pi_event *event)

pi_result	piextKernelSetArgMemObj (pi_kernel kernel, pi_uint32 arg_index, const pi_mem *arg_value)

pi_result	piextKernelSetArgSampler (pi_kernel kernel, pi_uint32 arg_index, const pi_sampler *arg_value)

pi_result	piextUSMHostAlloc (void *result_ptr, pi_context context, pi_usm_mem_properties properties, size_t size, pi_uint32 alignment)
	Allocates host memory accessible by the device. More...

pi_result	piextUSMDeviceAlloc (void *result_ptr, pi_context context, pi_device device, pi_usm_mem_properties properties, size_t size, pi_uint32 alignment)
	Allocates device memory. More...

pi_result	piextUSMSharedAlloc (void *result_ptr, pi_context context, pi_device device, pi_usm_mem_properties properties, size_t size, pi_uint32 alignment)
	Allocates memory accessible on both host and device. More...

pi_result	piextUSMFree (pi_context context, void *ptr)
	Indicates that the allocated USM memory is no longer needed on the runtime side. More...

pi_result	piextUSMEnqueueMemset (pi_queue queue, void ptr, pi_int32 value, size_t count, pi_uint32 num_events_in_waitlist, const pi_event events_waitlist, pi_event *event)
	USM Memset API. More...

pi_result	piextUSMEnqueueMemcpy (pi_queue queue, pi_bool blocking, void dst_ptr, const void src_ptr, size_t size, pi_uint32 num_events_in_waitlist, const pi_event events_waitlist, pi_event event)
	USM Memcpy API. More...

pi_result	piextUSMEnqueuePrefetch (pi_queue queue, const void ptr, size_t size, pi_usm_migration_flags flags, pi_uint32 num_events_in_waitlist, const pi_event events_waitlist, pi_event *event)
	Hint to migrate memory to the device. More...

pi_result	piextUSMEnqueueMemAdvise (pi_queue queue, const void ptr, size_t length, pi_mem_advice advice, pi_event event)
	USM Memadvise API. More...

pi_result	piextUSMGetMemAllocInfo (pi_context context, const void ptr, pi_mem_alloc_info param_name, size_t param_value_size, void param_value, size_t *param_value_size_ret)
	API to query information about USM allocated pointers Valid Queries: PI_MEM_ALLOC_TYPE returns host/device/shared pi_host_usm value PI_MEM_ALLOC_BASE_PTR returns the base ptr of an allocation if the queried pointer fell inside an allocation. More...

pi_result	piextPluginGetOpaqueData (void opaque_data_param, void *opaque_data_return)
	API to get Plugin internal data, opaque to SYCL RT. More...

pi_result	piTearDown (void *PluginParameter)
	API to notify that the plugin should clean up its resources. More...

pi_result	piPluginGetLastError (char **message)
	API to get Plugin specific warning and error messages. More...

Variables
const pi_bool	PI_TRUE = 1

const pi_bool	PI_FALSE = 0

constexpr pi_device_exec_capabilities	PI_DEVICE_EXEC_CAPABILITIES_KERNEL

constexpr pi_device_exec_capabilities	PI_DEVICE_EXEC_CAPABILITIES_NATIVE_KERNEL = (1 << 1)

constexpr pi_sampler_properties	PI_SAMPLER_PROPERTIES_NORMALIZED_COORDS

constexpr pi_sampler_properties	PI_SAMPLER_PROPERTIES_ADDRESSING_MODE = 0x1153

constexpr pi_sampler_properties	PI_SAMPLER_PROPERTIES_FILTER_MODE = 0x1154

constexpr pi_memory_order_capabilities	PI_MEMORY_ORDER_RELAXED = 0x01

constexpr pi_memory_order_capabilities	PI_MEMORY_ORDER_ACQUIRE = 0x02

constexpr pi_memory_order_capabilities	PI_MEMORY_ORDER_RELEASE = 0x04

constexpr pi_memory_order_capabilities	PI_MEMORY_ORDER_ACQ_REL = 0x08

constexpr pi_memory_order_capabilities	PI_MEMORY_ORDER_SEQ_CST = 0x10

constexpr pi_memory_scope_capabilities	PI_MEMORY_SCOPE_WORK_ITEM = 0x01

constexpr pi_memory_scope_capabilities	PI_MEMORY_SCOPE_SUB_GROUP = 0x02

constexpr pi_memory_scope_capabilities	PI_MEMORY_SCOPE_WORK_GROUP = 0x04

constexpr pi_memory_scope_capabilities	PI_MEMORY_SCOPE_DEVICE = 0x08

constexpr pi_memory_scope_capabilities	PI_MEMORY_SCOPE_SYSTEM = 0x10

constexpr pi_mem_flags	PI_MEM_FLAGS_ACCESS_RW = (1 << 0)

constexpr pi_mem_flags	PI_MEM_ACCESS_READ_ONLY = (1 << 2)

constexpr pi_mem_flags	PI_MEM_FLAGS_HOST_PTR_USE = (1 << 3)

constexpr pi_mem_flags	PI_MEM_FLAGS_HOST_PTR_COPY = (1 << 5)

constexpr pi_mem_flags	PI_MEM_FLAGS_HOST_PTR_ALLOC = (1 << 4)

constexpr pi_map_flags	PI_MAP_READ = (1 << 0)

constexpr pi_map_flags	PI_MAP_WRITE = (1 << 1)

constexpr pi_map_flags	PI_MAP_WRITE_INVALIDATE_REGION = (1 << 2)

constexpr pi_mem_properties	PI_MEM_PROPERTIES_CHANNEL = 0x4213

constexpr pi_mem_properties	PI_MEM_PROPERTIES_ALLOC_BUFFER_LOCATION = 0x419E

constexpr pi_usm_mem_properties	PI_MEM_ALLOC_FLAGS = 0x4195

constexpr pi_usm_mem_properties	PI_MEM_ALLOC_WRTITE_COMBINED = (1 << 0)

constexpr pi_usm_mem_properties	PI_MEM_ALLOC_INITIAL_PLACEMENT_DEVICE

constexpr pi_usm_mem_properties	PI_MEM_ALLOC_INITIAL_PLACEMENT_HOST = (1 << 2)

constexpr pi_usm_mem_properties	PI_MEM_ALLOC_DEVICE_READ_ONLY = (1 << 3)

constexpr pi_usm_mem_properties	PI_MEM_USM_ALLOC_BUFFER_LOCATION = 0x419E

constexpr pi_queue_properties	PI_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE = (1 << 0)

constexpr pi_queue_properties	PI_QUEUE_PROFILING_ENABLE = (1 << 1)

constexpr pi_queue_properties	PI_QUEUE_ON_DEVICE = (1 << 2)

constexpr pi_queue_properties	PI_QUEUE_ON_DEVICE_DEFAULT = (1 << 3)

constexpr pi_queue_properties	PI_EXT_ONEAPI_QUEUE_DISCARD_EVENTS = (1 << 4)

static constexpr pi_device_partition_property	PI_DEVICE_PARTITION_EQUALLY

static constexpr pi_device_partition_property	PI_DEVICE_PARTITION_BY_COUNTS

static constexpr pi_device_partition_property	PI_DEVICE_PARTITION_BY_COUNTS_LIST_END = 0x0

static constexpr pi_device_partition_property	PI_DEVICE_PARTITION_BY_AFFINITY_DOMAIN = 0x1088

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_NUMA

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_L4_CACHE

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_L3_CACHE

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_L2_CACHE

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_L1_CACHE

static constexpr pi_device_affinity_domain	PI_DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE = (1 << 5)

static constexpr pi_device_fp_config	PI_FP_DENORM = (1 << 0)

static constexpr pi_device_fp_config	PI_FP_INF_NAN = (1 << 1)

static constexpr pi_device_fp_config	PI_FP_ROUND_TO_NEAREST = (1 << 2)

static constexpr pi_device_fp_config	PI_FP_ROUND_TO_ZERO = (1 << 3)

static constexpr pi_device_fp_config	PI_FP_ROUND_TO_INF = (1 << 4)

static constexpr pi_device_fp_config	PI_FP_FMA = (1 << 5)

static constexpr pi_device_fp_config	PI_FP_SOFT_FLOAT = (1 << 6)

static constexpr pi_device_fp_config	PI_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

static constexpr pi_device_exec_capabilities	PI_EXEC_KERNEL = (1 << 0)

static constexpr pi_device_exec_capabilities	PI_EXEC_NATIVE_KERNEL = (1 << 1)

static constexpr pi_device_binary_type	PI_DEVICE_BINARY_TYPE_NONE = 0

static constexpr pi_device_binary_type	PI_DEVICE_BINARY_TYPE_NATIVE = 1

static constexpr pi_device_binary_type	PI_DEVICE_BINARY_TYPE_SPIRV = 2

static constexpr pi_device_binary_type	PI_DEVICE_BINARY_TYPE_LLVMIR_BITCODE = 3

static const uint16_t	PI_DEVICE_BINARY_VERSION = 1

static const uint8_t	PI_DEVICE_BINARY_OFFLOAD_KIND_SYCL = 4

static const uint16_t	PI_DEVICE_BINARIES_VERSION = 1

Macro Definition Documentation

◆ __SYCL_PI_DEVICE_BINARY_TARGET_AMDGCN

#define __SYCL_PI_DEVICE_BINARY_TARGET_AMDGCN "amdgcn"

Definition at line 724 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_NVPTX64

#define __SYCL_PI_DEVICE_BINARY_TARGET_NVPTX64 "nvptx64"

PTX 64-bit image <-> "nvptx64", 64-bit NVIDIA PTX device.

Definition at line 723 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV32

#define __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV32 "spir"

SPIR-V 32-bit image <-> "spir", 32-bit OpenCL device.

Definition at line 714 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64

#define __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64 "spir64"

SPIR-V 64-bit image <-> "spir64", 64-bit OpenCL device.

Definition at line 716 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA

#define __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA "spir64_fpga"

Definition at line 721 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN

#define __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN "spir64_gen"

Definition at line 720 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64

#define __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64 "spir64_x86_64"

Device-specific binary images produced from SPIR-V 64-bit <-> various "spir64_*" triples for specific 64-bit OpenCL devices.

Definition at line 719 of file pi.h.

◆ __SYCL_PI_DEVICE_BINARY_TARGET_UNKNOWN

#define __SYCL_PI_DEVICE_BINARY_TARGET_UNKNOWN "<unknown>"

Target identification strings for pi_device_binary_struct.DeviceTargetSpec.

A device type represented by a particular target triple requires specific binary images. We need to map the image type onto the device target triple

Definition at line 712 of file pi.h.

◆ __SYCL_PI_PROGRAM_METADATA_TAG_REQD_WORK_GROUP_SIZE

#define __SYCL_PI_PROGRAM_METADATA_TAG_REQD_WORK_GROUP_SIZE "@reqd_work_group_size"

Program metadata tags recognized by the PI backends.

For kernels the tag must appear after the kernel name.

Definition at line 758 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_DEVICELIB_REQ_MASK

#define __SYCL_PI_PROPERTY_SET_DEVICELIB_REQ_MASK "SYCL/devicelib req mask"

PropertySetRegistry::SYCL_DEVICELIB_REQ_MASK defined in PropertySetIO.h.

Definition at line 742 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_KERNEL_PARAM_OPT_INFO

#define __SYCL_PI_PROPERTY_SET_KERNEL_PARAM_OPT_INFO "SYCL/kernel param opt"

PropertySetRegistry::SYCL_KERNEL_PARAM_OPT_INFO defined in PropertySetIO.h.

Definition at line 744 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_PROGRAM_METADATA

#define __SYCL_PI_PROPERTY_SET_PROGRAM_METADATA "SYCL/program metadata"

PropertySetRegistry::SYCL_KERNEL_PROGRAM_METADATA defined in PropertySetIO.h.

Definition at line 746 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SPEC_CONST_DEFAULT_VALUES_MAP

#define __SYCL_PI_PROPERTY_SET_SPEC_CONST_DEFAULT_VALUES_MAP "SYCL/specialization constants default values"

PropertySetRegistry::SYCL_SPEC_CONSTANTS_DEFAULT_VALUES defined in PropertySetIO.h.

Definition at line 739 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SPEC_CONST_MAP

#define __SYCL_PI_PROPERTY_SET_SPEC_CONST_MAP "SYCL/specialization constants"

Device binary image property set names recognized by the SYCL runtime.

Name must be consistent with PropertySetRegistry::SYCL_SPECIALIZATION_CONSTANTS defined in PropertySetIO.h

Definition at line 736 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SYCL_ASSERT_USED

#define __SYCL_PI_PROPERTY_SET_SYCL_ASSERT_USED "SYCL/assert used"

PropertySetRegistry::SYCL_ASSERT_USED defined in PropertySetIO.h.

Definition at line 750 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SYCL_DEVICE_GLOBALS

#define __SYCL_PI_PROPERTY_SET_SYCL_DEVICE_GLOBALS "SYCL/device globals"

PropertySetRegistry::SYCL_DEVICE_GLOBALS defined in PropertySetIO.h.

Definition at line 754 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SYCL_EXPORTED_SYMBOLS

#define __SYCL_PI_PROPERTY_SET_SYCL_EXPORTED_SYMBOLS "SYCL/exported symbols"

PropertySetRegistry::SYCL_EXPORTED_SYMBOLS defined in PropertySetIO.h.

Definition at line 752 of file pi.h.

◆ __SYCL_PI_PROPERTY_SET_SYCL_MISC_PROP

#define __SYCL_PI_PROPERTY_SET_SYCL_MISC_PROP "SYCL/misc properties"

PropertySetRegistry::SYCL_MISC_PROP defined in PropertySetIO.h.

Definition at line 748 of file pi.h.

◆ _PI_API

#define _PI_API ( api ) decltype(::api) *api;

Definition at line 1797 of file pi.h.

◆ _PI_CONCAT

#define _PI_CONCAT	(	a,
		b
	)	_PI_STRING_HELPER(a.b)

Definition at line 60 of file pi.h.

◆ _PI_ERRC

#define _PI_ERRC	(	NAME,
		VAL
	)	NAME = VAL,

Definition at line 111 of file pi.h.

◆ _PI_ERRC_WITH_MSG

#define _PI_ERRC_WITH_MSG	(	NAME,
		VAL,
		MSG
	)	NAME = VAL,

Definition at line 112 of file pi.h.

◆ _PI_H_VERSION_MAJOR

#define _PI_H_VERSION_MAJOR 10

Definition at line 56 of file pi.h.

◆ _PI_H_VERSION_MINOR

#define _PI_H_VERSION_MINOR 14

Definition at line 57 of file pi.h.

◆ _PI_H_VERSION_STRING

#define _PI_H_VERSION_STRING _PI_CONCAT(_PI_H_VERSION_MAJOR, _PI_H_VERSION_MINOR)

Definition at line 71 of file pi.h.

◆ _PI_PLUGIN_VERSION_CHECK

#define _PI_PLUGIN_VERSION_CHECK	(	PI_API_VERSION,
		PI_PLUGIN_VERSION
	)

Value:

  if (strncmp(PI_API_VERSION, PI_PLUGIN_VERSION,                               \
              sizeof(_PI_STRING_SUBSTITUTE(_PI_H_VERSION_MAJOR))) < 0) {       \
    return PI_ERROR_INVALID_OPERATION;                                         \
  }

Definition at line 77 of file pi.h.

◆ _PI_PLUGIN_VERSION_STRING

#define _PI_PLUGIN_VERSION_STRING ( PluginVersion ) _PI_TRIPLE_CONCAT(_PI_H_VERSION_MAJOR, _PI_H_VERSION_MINOR, PluginVersion)

Definition at line 68 of file pi.h.

◆ _PI_STRING_HELPER

#define _PI_STRING_HELPER ( a ) #a

Definition at line 59 of file pi.h.

◆ _PI_STRING_SUBSTITUTE

#define _PI_STRING_SUBSTITUTE ( X ) _PI_STRING_HELPER(X)

Definition at line 76 of file pi.h.

◆ _PI_TRIPLE_CONCAT

#define _PI_TRIPLE_CONCAT	(	a,
		b,
		c
	)	_PI_STRING_HELPER(a.b.c)

Definition at line 61 of file pi.h.

◆ PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT

#define PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT "pi_ext_intel_devicelib_assert"

Extension to denote native support of assert feature by an arbitrary device piDeviceGetInfo call should return this extension when the device supports native asserts if supported extensions' names are requested.

Definition at line 729 of file pi.h.

Typedef Documentation

◆ _pi_offload_entry

using _pi_offload_entry = _pi_offload_entry_struct *

Definition at line 655 of file pi.h.

◆ pi_bitfield

using pi_bitfield = pi_uint64

Definition at line 102 of file pi.h.

◆ pi_bool

using pi_bool = pi_uint32

Definition at line 101 of file pi.h.

◆ pi_buff_rect_offset

using pi_buff_rect_offset = pi_buff_rect_offset_struct *

Definition at line 828 of file pi.h.

◆ pi_buff_rect_region

using pi_buff_rect_region = pi_buff_rect_region_struct *

Definition at line 837 of file pi.h.

◆ pi_buffer_create_type

using pi_buffer_create_type = _pi_buffer_create_type

Definition at line 592 of file pi.h.

◆ pi_buffer_region

using pi_buffer_region = pi_buffer_region_struct *

Definition at line 819 of file pi.h.

◆ pi_command_type

using pi_command_type = _pi_command_type

Definition at line 587 of file pi.h.

◆ pi_context

using pi_context = _pi_context *

Definition at line 891 of file pi.h.

◆ pi_context_extended_deleter

typedef void(* pi_context_extended_deleter) (void *user_data)

Definition at line 1056 of file pi.h.

◆ pi_context_info

using pi_context_info = _pi_context_info

Definition at line 580 of file pi.h.

◆ pi_context_properties

using pi_context_properties = intptr_t

Definition at line 492 of file pi.h.

◆ pi_device

using pi_device = _pi_device *

Definition at line 890 of file pi.h.

◆ pi_device_affinity_domain

using pi_device_affinity_domain = pi_bitfield

Definition at line 615 of file pi.h.

◆ pi_device_binaries

using pi_device_binaries = pi_device_binaries_struct *

Definition at line 876 of file pi.h.

◆ pi_device_binary

using pi_device_binary = pi_device_binary_struct *

Definition at line 812 of file pi.h.

◆ pi_device_binary_property

typedef _pi_device_binary_property_struct* pi_device_binary_property

Definition at line 676 of file pi.h.

◆ pi_device_binary_property_set

typedef _pi_device_binary_property_set_struct* pi_device_binary_property_set

Definition at line 685 of file pi.h.

◆ pi_device_binary_type

using pi_device_binary_type = uint8_t

Types of device binary.

Definition at line 688 of file pi.h.

◆ pi_device_exec_capabilities

typedef pi_bitfield pi_device_exec_capabilities

Definition at line 494 of file pi.h.

◆ pi_device_fp_config

using pi_device_fp_config = pi_bitfield

Definition at line 630 of file pi.h.

◆ pi_device_info

using pi_device_info = _pi_device_info

Definition at line 578 of file pi.h.

◆ pi_device_local_mem_type

using pi_device_local_mem_type = _pi_device_local_mem_type

Definition at line 577 of file pi.h.

◆ pi_device_mem_cache_type

using pi_device_mem_cache_type = _pi_device_mem_cache_type

Definition at line 576 of file pi.h.

◆ pi_device_partition_property

using pi_device_partition_property = intptr_t

Definition at line 604 of file pi.h.

◆ pi_device_type

using pi_device_type = _pi_device_type

Definition at line 575 of file pi.h.

◆ pi_event

using pi_event = _pi_event *

Definition at line 896 of file pi.h.

◆ pi_event_info

using pi_event_info = _pi_event_info

Definition at line 586 of file pi.h.

◆ pi_event_status

using pi_event_status = _pi_event_status

Definition at line 596 of file pi.h.

◆ pi_image_channel_order

using pi_image_channel_order = _pi_image_channel_order

Definition at line 590 of file pi.h.

◆ pi_image_channel_type

using pi_image_channel_type = _pi_image_channel_type

Definition at line 591 of file pi.h.

◆ pi_image_desc

using pi_image_desc = _pi_image_desc

Definition at line 918 of file pi.h.

◆ pi_image_format

using pi_image_format = _pi_image_format

Definition at line 917 of file pi.h.

◆ pi_image_info

using pi_image_info = _pi_image_info

Definition at line 582 of file pi.h.

◆ pi_image_offset

using pi_image_offset = pi_image_offset_struct *

Definition at line 846 of file pi.h.

◆ pi_image_region

using pi_image_region = pi_image_region_struct *

Definition at line 855 of file pi.h.

◆ pi_int32

using pi_int32 = int32_t

Definition at line 98 of file pi.h.

◆ pi_kernel

using pi_kernel = _pi_kernel *

Definition at line 895 of file pi.h.

◆ pi_kernel_exec_info

using pi_kernel_exec_info = _pi_kernel_exec_info

Definition at line 1297 of file pi.h.

◆ pi_kernel_group_info

using pi_kernel_group_info = _pi_kernel_group_info

Definition at line 584 of file pi.h.

◆ pi_kernel_info

typedef _pi_kernel_info pi_kernel_info

Definition at line 583 of file pi.h.

◆ pi_kernel_sub_group_info

using pi_kernel_sub_group_info = _pi_kernel_sub_group_info

Definition at line 585 of file pi.h.

◆ pi_map_flags

using pi_map_flags = pi_bitfield

Definition at line 541 of file pi.h.

◆ pi_mem

using pi_mem = _pi_mem *

Definition at line 893 of file pi.h.

◆ pi_mem_advice

using pi_mem_advice = _pi_mem_advice

Definition at line 589 of file pi.h.

◆ pi_mem_alloc_info

using pi_mem_alloc_info = _pi_mem_alloc_info

Definition at line 1626 of file pi.h.

◆ pi_mem_flags

using pi_mem_flags = pi_bitfield

Definition at line 531 of file pi.h.

◆ pi_mem_info

using pi_mem_info = _pi_mem_info

Definition at line 922 of file pi.h.

◆ pi_mem_properties

using pi_mem_properties = pi_bitfield

Definition at line 547 of file pi.h.

◆ pi_mem_type

using pi_mem_type = _pi_mem_type

Definition at line 588 of file pi.h.

◆ pi_memory_order_capabilities

using pi_memory_order_capabilities = pi_bitfield

Definition at line 506 of file pi.h.

◆ pi_memory_scope_capabilities

using pi_memory_scope_capabilities = pi_bitfield

Definition at line 513 of file pi.h.

◆ pi_native_handle

using pi_native_handle = uintptr_t

Definition at line 103 of file pi.h.

◆ pi_platform

using pi_platform = _pi_platform *

Definition at line 889 of file pi.h.

◆ pi_platform_info

using pi_platform_info = _pi_platform_info

Definition at line 574 of file pi.h.

◆ pi_plugin

using pi_plugin = _pi_plugin

Definition at line 938 of file pi.h.

◆ pi_profiling_info

using pi_profiling_info = _pi_profiling_info

Definition at line 601 of file pi.h.

◆ pi_program

using pi_program = _pi_program *

Definition at line 894 of file pi.h.

◆ pi_program_binary_type

using pi_program_binary_type = _pi_program_binary_type

Definition at line 599 of file pi.h.

◆ pi_program_build_info

using pi_program_build_info = _pi_program_build_info

Definition at line 597 of file pi.h.

◆ pi_program_build_status

using pi_program_build_status = _pi_program_build_status

Definition at line 598 of file pi.h.

◆ pi_program_info

using pi_program_info = _pi_program_info

Definition at line 579 of file pi.h.

◆ pi_queue

using pi_queue = _pi_queue *

Definition at line 892 of file pi.h.

◆ pi_queue_info

using pi_queue_info = _pi_queue_info

Definition at line 581 of file pi.h.

◆ pi_queue_properties

using pi_queue_properties = pi_bitfield

Definition at line 566 of file pi.h.

◆ pi_result

using pi_result = _pi_result

Definition at line 573 of file pi.h.

◆ pi_sampler

using pi_sampler = _pi_sampler *

Definition at line 897 of file pi.h.

◆ pi_sampler_addressing_mode

using pi_sampler_addressing_mode = _pi_sampler_addressing_mode

Definition at line 593 of file pi.h.

◆ pi_sampler_filter_mode

using pi_sampler_filter_mode = _pi_sampler_filter_mode

Definition at line 594 of file pi.h.

◆ pi_sampler_info

using pi_sampler_info = _pi_sampler_info

Definition at line 595 of file pi.h.

◆ pi_sampler_properties

using pi_sampler_properties = pi_bitfield

Definition at line 500 of file pi.h.

◆ pi_uint32

using pi_uint32 = uint32_t

Definition at line 99 of file pi.h.

◆ pi_uint64

using pi_uint64 = uint64_t

Definition at line 100 of file pi.h.

◆ pi_usm_capabilities

using pi_usm_capabilities = _pi_usm_capabilities

Definition at line 1625 of file pi.h.

◆ pi_usm_capability_query

using pi_usm_capability_query = _pi_usm_capability_query

Definition at line 1624 of file pi.h.

◆ pi_usm_mem_properties

using pi_usm_mem_properties = pi_bitfield

Definition at line 553 of file pi.h.

◆ pi_usm_migration_flags

using pi_usm_migration_flags = _pi_usm_migration_flags

Definition at line 1628 of file pi.h.

◆ pi_usm_type

using pi_usm_type = _pi_usm_type

Definition at line 1627 of file pi.h.

Enumeration Type Documentation

◆ _pi_buffer_create_type

enum _pi_buffer_create_type

Enumerator
PI_BUFFER_CREATE_TYPE_REGION

Definition at line 463 of file pi.h.

◆ _pi_command_type

enum _pi_command_type

Enumerator
PI_COMMAND_TYPE_NDRANGE_KERNEL
PI_COMMAND_TYPE_MEM_BUFFER_READ
PI_COMMAND_TYPE_MEM_BUFFER_WRITE
PI_COMMAND_TYPE_MEM_BUFFER_COPY
PI_COMMAND_TYPE_MEM_BUFFER_MAP
PI_COMMAND_TYPE_MEM_BUFFER_UNMAP
PI_COMMAND_TYPE_MEM_BUFFER_READ_RECT
PI_COMMAND_TYPE_MEM_BUFFER_WRITE_RECT
PI_COMMAND_TYPE_MEM_BUFFER_COPY_RECT
PI_COMMAND_TYPE_USER
PI_COMMAND_TYPE_MEM_BUFFER_FILL
PI_COMMAND_TYPE_IMAGE_READ
PI_COMMAND_TYPE_IMAGE_WRITE
PI_COMMAND_TYPE_IMAGE_COPY
PI_COMMAND_TYPE_NATIVE_KERNEL
PI_COMMAND_TYPE_COPY_BUFFER_TO_IMAGE
PI_COMMAND_TYPE_COPY_IMAGE_TO_BUFFER
PI_COMMAND_TYPE_MAP_IMAGE
PI_COMMAND_TYPE_MARKER
PI_COMMAND_TYPE_ACQUIRE_GL_OBJECTS
PI_COMMAND_TYPE_RELEASE_GL_OBJECTS
PI_COMMAND_TYPE_BARRIER
PI_COMMAND_TYPE_MIGRATE_MEM_OBJECTS
PI_COMMAND_TYPE_FILL_IMAGE
PI_COMMAND_TYPE_SVM_FREE
PI_COMMAND_TYPE_SVM_MEMCPY
PI_COMMAND_TYPE_SVM_MEMFILL
PI_COMMAND_TYPE_SVM_MAP
PI_COMMAND_TYPE_SVM_UNMAP

Definition at line 369 of file pi.h.

◆ _pi_context_info

enum _pi_context_info

Enumerator
PI_CONTEXT_INFO_DEVICES
PI_CONTEXT_INFO_PLATFORM
PI_CONTEXT_INFO_NUM_DEVICES
PI_CONTEXT_INFO_PROPERTIES
PI_CONTEXT_INFO_REFERENCE_COUNT
PI_CONTEXT_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES
PI_CONTEXT_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES

Definition at line 304 of file pi.h.

◆ _pi_device_info

enum _pi_device_info

Enumerator
PI_DEVICE_INFO_TYPE
PI_DEVICE_INFO_VENDOR_ID
PI_DEVICE_INFO_MAX_COMPUTE_UNITS
PI_DEVICE_INFO_MAX_WORK_ITEM_DIMENSIONS
PI_DEVICE_INFO_MAX_WORK_ITEM_SIZES
PI_DEVICE_INFO_MAX_WORK_GROUP_SIZE
PI_DEVICE_INFO_SINGLE_FP_CONFIG
PI_DEVICE_INFO_HALF_FP_CONFIG
PI_DEVICE_INFO_DOUBLE_FP_CONFIG
PI_DEVICE_INFO_QUEUE_PROPERTIES
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_CHAR
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_SHORT
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_INT
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_LONG
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_FLOAT
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_DOUBLE
PI_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_HALF
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_CHAR
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_SHORT
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_INT
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_LONG
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_FLOAT
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_DOUBLE
PI_DEVICE_INFO_NATIVE_VECTOR_WIDTH_HALF
PI_DEVICE_INFO_MAX_CLOCK_FREQUENCY
PI_DEVICE_INFO_ADDRESS_BITS
PI_DEVICE_INFO_MAX_MEM_ALLOC_SIZE
PI_DEVICE_INFO_IMAGE_SUPPORT
PI_DEVICE_INFO_MAX_READ_IMAGE_ARGS
PI_DEVICE_INFO_MAX_WRITE_IMAGE_ARGS
PI_DEVICE_INFO_IMAGE2D_MAX_WIDTH
PI_DEVICE_INFO_IMAGE2D_MAX_HEIGHT
PI_DEVICE_INFO_IMAGE3D_MAX_WIDTH
PI_DEVICE_INFO_IMAGE3D_MAX_HEIGHT
PI_DEVICE_INFO_IMAGE3D_MAX_DEPTH
PI_DEVICE_INFO_IMAGE_MAX_BUFFER_SIZE
PI_DEVICE_INFO_IMAGE_MAX_ARRAY_SIZE
PI_DEVICE_INFO_MAX_SAMPLERS
PI_DEVICE_INFO_MAX_PARAMETER_SIZE
PI_DEVICE_INFO_MEM_BASE_ADDR_ALIGN
PI_DEVICE_INFO_GLOBAL_MEM_CACHE_TYPE
PI_DEVICE_INFO_GLOBAL_MEM_CACHELINE_SIZE
PI_DEVICE_INFO_GLOBAL_MEM_CACHE_SIZE
PI_DEVICE_INFO_GLOBAL_MEM_SIZE
PI_DEVICE_INFO_MAX_CONSTANT_BUFFER_SIZE
PI_DEVICE_INFO_MAX_CONSTANT_ARGS
PI_DEVICE_INFO_LOCAL_MEM_TYPE
PI_DEVICE_INFO_LOCAL_MEM_SIZE
PI_DEVICE_INFO_ERROR_CORRECTION_SUPPORT
PI_DEVICE_INFO_HOST_UNIFIED_MEMORY
PI_DEVICE_INFO_PROFILING_TIMER_RESOLUTION
PI_DEVICE_INFO_ENDIAN_LITTLE
PI_DEVICE_INFO_AVAILABLE
PI_DEVICE_INFO_COMPILER_AVAILABLE
PI_DEVICE_INFO_LINKER_AVAILABLE
PI_DEVICE_INFO_EXECUTION_CAPABILITIES
PI_DEVICE_INFO_QUEUE_ON_DEVICE_PROPERTIES
PI_DEVICE_INFO_QUEUE_ON_HOST_PROPERTIES
PI_DEVICE_INFO_BUILT_IN_KERNELS
PI_DEVICE_INFO_PLATFORM
PI_DEVICE_INFO_REFERENCE_COUNT
PI_DEVICE_INFO_IL_VERSION
PI_DEVICE_INFO_NAME
PI_DEVICE_INFO_VENDOR
PI_DEVICE_INFO_DRIVER_VERSION
PI_DEVICE_INFO_PROFILE
PI_DEVICE_INFO_VERSION
PI_DEVICE_INFO_OPENCL_C_VERSION
PI_DEVICE_INFO_EXTENSIONS
PI_DEVICE_INFO_PRINTF_BUFFER_SIZE
PI_DEVICE_INFO_PREFERRED_INTEROP_USER_SYNC
PI_DEVICE_INFO_PARENT_DEVICE
PI_DEVICE_INFO_PARTITION_PROPERTIES
PI_DEVICE_INFO_PARTITION_MAX_SUB_DEVICES
PI_DEVICE_INFO_PARTITION_AFFINITY_DOMAIN
PI_DEVICE_INFO_PARTITION_TYPE
PI_DEVICE_INFO_MAX_NUM_SUB_GROUPS
PI_DEVICE_INFO_SUB_GROUP_INDEPENDENT_FORWARD_PROGRESS
PI_DEVICE_INFO_SUB_GROUP_SIZES_INTEL
PI_DEVICE_INFO_USM_HOST_SUPPORT
PI_DEVICE_INFO_USM_DEVICE_SUPPORT
PI_DEVICE_INFO_USM_SINGLE_SHARED_SUPPORT
PI_DEVICE_INFO_USM_CROSS_SHARED_SUPPORT
PI_DEVICE_INFO_USM_SYSTEM_SHARED_SUPPORT
PI_DEVICE_INFO_UUID
PI_DEVICE_INFO_PCI_ADDRESS
PI_DEVICE_INFO_GPU_EU_COUNT
PI_DEVICE_INFO_GPU_EU_SIMD_WIDTH
PI_DEVICE_INFO_GPU_SLICES
PI_DEVICE_INFO_GPU_SUBSLICES_PER_SLICE
PI_DEVICE_INFO_GPU_EU_COUNT_PER_SUBSLICE
PI_DEVICE_INFO_MAX_MEM_BANDWIDTH
PI_DEVICE_INFO_IMAGE_SRGB
PI_DEVICE_INFO_BUILD_ON_SUBDEVICE
PI_EXT_INTEL_DEVICE_INFO_FREE_MEMORY
PI_DEVICE_INFO_ATOMIC_64
PI_DEVICE_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES
PI_DEVICE_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES
PI_DEVICE_INFO_GPU_HW_THREADS_PER_EU
PI_DEVICE_INFO_BACKEND_VERSION
PI_EXT_ONEAPI_DEVICE_INFO_BFLOAT16
PI_EXT_ONEAPI_DEVICE_INFO_MAX_GLOBAL_WORK_GROUPS
PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_1D
PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_2D
PI_EXT_ONEAPI_DEVICE_INFO_MAX_WORK_GROUPS_3D
PI_EXT_ONEAPI_DEVICE_INFO_CUDA_ASYNC_BARRIER

Definition at line 179 of file pi.h.

◆ _pi_device_local_mem_type

enum _pi_device_local_mem_type

Enumerator
PI_DEVICE_LOCAL_MEM_TYPE_LOCAL
PI_DEVICE_LOCAL_MEM_TYPE_GLOBAL

Definition at line 174 of file pi.h.

◆ _pi_device_mem_cache_type

enum _pi_device_mem_cache_type

Enumerator
PI_DEVICE_MEM_CACHE_TYPE_NONE
PI_DEVICE_MEM_CACHE_TYPE_READ_ONLY_CACHE
PI_DEVICE_MEM_CACHE_TYPE_READ_WRITE_CACHE

Definition at line 168 of file pi.h.

◆ _pi_device_type

enum _pi_device_type : pi_uint64

Enumerator
PI_DEVICE_TYPE_DEFAULT	The default device available in the PI plugin.
PI_DEVICE_TYPE_ALL	All devices available in the PI plugin.
PI_DEVICE_TYPE_CPU	A PI device that is the host processor.
PI_DEVICE_TYPE_GPU	A PI device that is a GPU.
PI_DEVICE_TYPE_ACC	A PI device that is a dedicated accelerator.
PI_DEVICE_TYPE_CUSTOM	A PI device that is a custom device.

Definition at line 157 of file pi.h.

◆ _pi_event_info

enum _pi_event_info

Enumerator
PI_EVENT_INFO_COMMAND_QUEUE
PI_EVENT_INFO_CONTEXT
PI_EVENT_INFO_COMMAND_TYPE
PI_EVENT_INFO_COMMAND_EXECUTION_STATUS
PI_EVENT_INFO_REFERENCE_COUNT

Definition at line 361 of file pi.h.

◆ _pi_event_status

enum _pi_event_status

Enumerator
PI_EVENT_COMPLETE
PI_EVENT_RUNNING
PI_EVENT_SUBMITTED
PI_EVENT_QUEUED

Definition at line 118 of file pi.h.

◆ _pi_image_channel_order

enum _pi_image_channel_order

Enumerator
PI_IMAGE_CHANNEL_ORDER_A
PI_IMAGE_CHANNEL_ORDER_R
PI_IMAGE_CHANNEL_ORDER_RG
PI_IMAGE_CHANNEL_ORDER_RA
PI_IMAGE_CHANNEL_ORDER_RGB
PI_IMAGE_CHANNEL_ORDER_RGBA
PI_IMAGE_CHANNEL_ORDER_BGRA
PI_IMAGE_CHANNEL_ORDER_ARGB
PI_IMAGE_CHANNEL_ORDER_ABGR
PI_IMAGE_CHANNEL_ORDER_INTENSITY
PI_IMAGE_CHANNEL_ORDER_LUMINANCE
PI_IMAGE_CHANNEL_ORDER_Rx
PI_IMAGE_CHANNEL_ORDER_RGx
PI_IMAGE_CHANNEL_ORDER_RGBx
PI_IMAGE_CHANNEL_ORDER_sRGBA

Definition at line 427 of file pi.h.

◆ _pi_image_channel_type

enum _pi_image_channel_type

Enumerator
PI_IMAGE_CHANNEL_TYPE_SNORM_INT8
PI_IMAGE_CHANNEL_TYPE_SNORM_INT16
PI_IMAGE_CHANNEL_TYPE_UNORM_INT8
PI_IMAGE_CHANNEL_TYPE_UNORM_INT16
PI_IMAGE_CHANNEL_TYPE_UNORM_SHORT_565
PI_IMAGE_CHANNEL_TYPE_UNORM_SHORT_555
PI_IMAGE_CHANNEL_TYPE_UNORM_INT_101010
PI_IMAGE_CHANNEL_TYPE_SIGNED_INT8
PI_IMAGE_CHANNEL_TYPE_SIGNED_INT16
PI_IMAGE_CHANNEL_TYPE_SIGNED_INT32
PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8
PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16
PI_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32
PI_IMAGE_CHANNEL_TYPE_HALF_FLOAT
PI_IMAGE_CHANNEL_TYPE_FLOAT

Definition at line 445 of file pi.h.

◆ _pi_image_info

enum _pi_image_info

Enumerator
PI_IMAGE_INFO_FORMAT
PI_IMAGE_INFO_ELEMENT_SIZE
PI_IMAGE_INFO_ROW_PITCH
PI_IMAGE_INFO_SLICE_PITCH
PI_IMAGE_INFO_WIDTH
PI_IMAGE_INFO_HEIGHT
PI_IMAGE_INFO_DEPTH

Definition at line 344 of file pi.h.

◆ _pi_kernel_exec_info

enum _pi_kernel_exec_info

Enumerator
PI_USM_INDIRECT_ACCESS	indicates that the kernel might access data through USM ptrs
PI_USM_PTRS	provides an explicit list of pointers that the kernel will access

Definition at line 1290 of file pi.h.

◆ _pi_kernel_group_info

enum _pi_kernel_group_info

Enumerator
PI_KERNEL_GROUP_INFO_GLOBAL_WORK_SIZE
PI_KERNEL_GROUP_INFO_WORK_GROUP_SIZE
PI_KERNEL_GROUP_INFO_COMPILE_WORK_GROUP_SIZE
PI_KERNEL_GROUP_INFO_LOCAL_MEM_SIZE
PI_KERNEL_GROUP_INFO_PREFERRED_WORK_GROUP_SIZE_MULTIPLE
PI_KERNEL_GROUP_INFO_PRIVATE_MEM_SIZE
PI_KERNEL_GROUP_INFO_NUM_REGS

Definition at line 333 of file pi.h.

◆ _pi_kernel_info

enum _pi_kernel_info

Enumerator
PI_KERNEL_INFO_FUNCTION_NAME
PI_KERNEL_INFO_NUM_ARGS
PI_KERNEL_INFO_REFERENCE_COUNT
PI_KERNEL_INFO_CONTEXT
PI_KERNEL_INFO_PROGRAM
PI_KERNEL_INFO_ATTRIBUTES

Definition at line 324 of file pi.h.

◆ _pi_kernel_sub_group_info

enum _pi_kernel_sub_group_info

Enumerator
PI_KERNEL_MAX_SUB_GROUP_SIZE
PI_KERNEL_MAX_NUM_SUB_GROUPS
PI_KERNEL_COMPILE_NUM_SUB_GROUPS
PI_KERNEL_COMPILE_SUB_GROUP_SIZE_INTEL

Definition at line 354 of file pi.h.

◆ _pi_mem_advice

enum _pi_mem_advice

Enumerator
PI_MEM_ADVICE_RESET
PI_MEM_ADVICE_CUDA_SET_READ_MOSTLY
PI_MEM_ADVICE_CUDA_UNSET_READ_MOSTLY
PI_MEM_ADVICE_CUDA_SET_PREFERRED_LOCATION
PI_MEM_ADVICE_CUDA_UNSET_PREFERRED_LOCATION
PI_MEM_ADVICE_CUDA_SET_ACCESSED_BY
PI_MEM_ADVICE_CUDA_UNSET_ACCESSED_BY
PI_MEM_ADVICE_CUDA_SET_PREFERRED_LOCATION_HOST
PI_MEM_ADVICE_CUDA_UNSET_PREFERRED_LOCATION_HOST
PI_MEM_ADVICE_CUDA_SET_ACCESSED_BY_HOST
PI_MEM_ADVICE_CUDA_UNSET_ACCESSED_BY_HOST
PI_MEM_ADVICE_UNKNOWN

Definition at line 411 of file pi.h.

◆ _pi_mem_alloc_info

enum _pi_mem_alloc_info

Enumerator
PI_MEM_ALLOC_TYPE
PI_MEM_ALLOC_BASE_PTR
PI_MEM_ALLOC_SIZE
PI_MEM_ALLOC_DEVICE

Definition at line 1603 of file pi.h.

◆ _pi_mem_info

enum _pi_mem_info

Enumerator
PI_MEM_CONTEXT
PI_MEM_SIZE

Definition at line 920 of file pi.h.

◆ _pi_mem_type

enum _pi_mem_type

Enumerator
PI_MEM_TYPE_BUFFER
PI_MEM_TYPE_IMAGE2D
PI_MEM_TYPE_IMAGE3D
PI_MEM_TYPE_IMAGE2D_ARRAY
PI_MEM_TYPE_IMAGE1D
PI_MEM_TYPE_IMAGE1D_ARRAY
PI_MEM_TYPE_IMAGE1D_BUFFER

Definition at line 401 of file pi.h.

◆ _pi_platform_info

enum _pi_platform_info

Enumerator
PI_PLATFORM_INFO_EXTENSIONS
PI_PLATFORM_INFO_NAME
PI_PLATFORM_INFO_PROFILE
PI_PLATFORM_INFO_VENDOR
PI_PLATFORM_INFO_VERSION

Definition at line 125 of file pi.h.

◆ _pi_profiling_info

enum _pi_profiling_info

Enumerator
PI_PROFILING_INFO_COMMAND_QUEUED
PI_PROFILING_INFO_COMMAND_SUBMIT
PI_PROFILING_INFO_COMMAND_START
PI_PROFILING_INFO_COMMAND_END

Definition at line 520 of file pi.h.

◆ _pi_program_binary_type

enum _pi_program_binary_type

Enumerator
PI_PROGRAM_BINARY_TYPE_NONE
PI_PROGRAM_BINARY_TYPE_COMPILED_OBJECT
PI_PROGRAM_BINARY_TYPE_LIBRARY
PI_PROGRAM_BINARY_TYPE_EXECUTABLE

Definition at line 147 of file pi.h.

◆ _pi_program_build_info

enum _pi_program_build_info

Enumerator
PI_PROGRAM_BUILD_INFO_STATUS
PI_PROGRAM_BUILD_INFO_OPTIONS
PI_PROGRAM_BUILD_INFO_LOG
PI_PROGRAM_BUILD_INFO_BINARY_TYPE

Definition at line 133 of file pi.h.

◆ _pi_program_build_status

enum _pi_program_build_status

Enumerator
PI_PROGRAM_BUILD_STATUS_NONE
PI_PROGRAM_BUILD_STATUS_ERROR
PI_PROGRAM_BUILD_STATUS_SUCCESS
PI_PROGRAM_BUILD_STATUS_IN_PROGRESS

Definition at line 140 of file pi.h.

◆ _pi_program_info

enum _pi_program_info

Enumerator
PI_PROGRAM_INFO_REFERENCE_COUNT
PI_PROGRAM_INFO_CONTEXT
PI_PROGRAM_INFO_NUM_DEVICES
PI_PROGRAM_INFO_DEVICES
PI_PROGRAM_INFO_SOURCE
PI_PROGRAM_INFO_BINARY_SIZES
PI_PROGRAM_INFO_BINARIES
PI_PROGRAM_INFO_NUM_KERNELS
PI_PROGRAM_INFO_KERNEL_NAMES

Definition at line 292 of file pi.h.

◆ _pi_queue_info

enum _pi_queue_info

Enumerator
PI_QUEUE_INFO_CONTEXT
PI_QUEUE_INFO_DEVICE
PI_QUEUE_INFO_DEVICE_DEFAULT
PI_QUEUE_INFO_PROPERTIES
PI_QUEUE_INFO_REFERENCE_COUNT
PI_QUEUE_INFO_SIZE

Definition at line 315 of file pi.h.

◆ _pi_result

enum _pi_result

Definition at line 110 of file pi.h.

◆ _pi_sampler_addressing_mode

enum _pi_sampler_addressing_mode

Enumerator
PI_SAMPLER_ADDRESSING_MODE_MIRRORED_REPEAT
PI_SAMPLER_ADDRESSING_MODE_REPEAT
PI_SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE
PI_SAMPLER_ADDRESSING_MODE_CLAMP
PI_SAMPLER_ADDRESSING_MODE_NONE

Definition at line 479 of file pi.h.

◆ _pi_sampler_filter_mode

enum _pi_sampler_filter_mode

Enumerator
PI_SAMPLER_FILTER_MODE_NEAREST
PI_SAMPLER_FILTER_MODE_LINEAR

Definition at line 487 of file pi.h.

◆ _pi_sampler_info

enum _pi_sampler_info

Enumerator
PI_SAMPLER_INFO_REFERENCE_COUNT
PI_SAMPLER_INFO_CONTEXT
PI_SAMPLER_INFO_NORMALIZED_COORDS
PI_SAMPLER_INFO_ADDRESSING_MODE
PI_SAMPLER_INFO_FILTER_MODE
PI_SAMPLER_INFO_MIP_FILTER_MODE
PI_SAMPLER_INFO_LOD_MIN
PI_SAMPLER_INFO_LOD_MAX

Definition at line 468 of file pi.h.

◆ _pi_usm_capabilities

enum _pi_usm_capabilities : pi_bitfield

Enumerator
PI_USM_ACCESS
PI_USM_ATOMIC_ACCESS
PI_USM_CONCURRENT_ACCESS
PI_USM_CONCURRENT_ATOMIC_ACCESS

Definition at line 1596 of file pi.h.

◆ _pi_usm_capability_query

enum _pi_usm_capability_query

Enumerator
PI_USM_HOST_SUPPORT
PI_USM_DEVICE_SUPPORT
PI_USM_SINGLE_SHARED_SUPPORT
PI_USM_CROSS_SHARED_SUPPORT
PI_USM_SYSTEM_SHARED_SUPPORT

Definition at line 1588 of file pi.h.

◆ _pi_usm_migration_flags

enum _pi_usm_migration_flags : pi_bitfield

Enumerator
PI_USM_MIGRATION_TBD0

Definition at line 1620 of file pi.h.

◆ _pi_usm_type

enum _pi_usm_type

Enumerator
PI_MEM_TYPE_UNKNOWN
PI_MEM_TYPE_HOST
PI_MEM_TYPE_DEVICE
PI_MEM_TYPE_SHARED

Definition at line 1610 of file pi.h.

◆ pi_property_type

enum pi_property_type

Enumerator
PI_PROPERTY_TYPE_UNKNOWN
PI_PROPERTY_TYPE_UINT32
PI_PROPERTY_TYPE_BYTE_ARRAY
PI_PROPERTY_TYPE_STRING

Definition at line 658 of file pi.h.

Function Documentation

◆ piclProgramCreateWithSource()

pi_result piclProgramCreateWithSource	(	pi_context	context,
		pi_uint32	count,
		const char **	strings,
		const size_t *	lengths,
		pi_program *	ret_program
	)

Definition at line 1298 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, and DIE_NO_IMPLEMENTATION.

Referenced by piPluginInit().

◆ piContextCreate()

pi_result piContextCreate	(	const pi_context_properties *	properties,
		pi_uint32	num_devices,
		const pi_device *	devices,
		void()(const char errinfo, const void private_info, size_t cb, void user_data)	pfn_notify,
		void *	user_data,
		pi_context *	ret_context
	)

Referenced by sycl::_V1::detail::context_impl::context_impl(), and piPluginInit().

◆ piContextGetInfo()

pi_result piContextGetInfo	(	pi_context	context,
		pi_context_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 859 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_context::Devices, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, PI_ASSERT, PI_CONTEXT_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES, PI_CONTEXT_INFO_DEVICES, PI_CONTEXT_INFO_NUM_DEVICES, and PI_CONTEXT_INFO_REFERENCE_COUNT.

Referenced by sycl::_V1::detail::context_impl::context_impl(), sycl::_V1::detail::context_impl::get_info< info::context::atomic_memory_order_capabilities >(), sycl::_V1::detail::context_impl::get_info< info::context::atomic_memory_scope_capabilities >(), sycl::_V1::detail::createBinaryProgram(), sycl::_V1::detail::get_context_info(), sycl::_V1::detail::get_context_info< info::context::atomic_memory_order_capabilities >(), and piPluginInit().

◆ piContextRelease()

pi_result piContextRelease ( pi_context context )

TODO : Encapsulating accesses (add/remove) for Addr2CmBufferSVM

Definition at line 889 of file pi_esimd_emulator.cpp.

References _pi_context::Addr2CmBufferSVM, _pi_context::Addr2CmBufferSVMLock, _pi_device::CmDevicePtr, _pi_queue::Context, ContextReleaseHelper(), _pi_platform::ContextsMutex, _pi_context::Device, and _pi_context::getPlatform().

Referenced by piKernelRelease(), piPluginInit(), and sycl::_V1::detail::context_impl::~context_impl().

◆ piContextRetain()

pi_result piContextRetain ( pi_context context )

Definition at line 879 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, and PI_ASSERT.

Referenced by sycl::_V1::detail::context_impl::context_impl(), sycl::_V1::detail::context_impl::get(), sycl::_V1::detail::context_impl::getNative(), _pi_kernel::initialize(), piextMemCreateWithNativeHandle(), piextUSMDeviceAlloc(), piextUSMHostAlloc(), piextUSMSharedAlloc(), piPluginInit(), ZeDeviceMemAllocHelper(), and ZeHostMemAllocHelper().

◆ piDeviceGetInfo()

pi_result piDeviceGetInfo	(	pi_device	device,
		pi_device_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Returns requested info for provided native device Return PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT for PI_DEVICE_INFO_EXTENSIONS query when the device supports native asserts.

Combination of ESIMDEmuPluginDataVersion and ESIMDEmuPluginInterfaceVersion : 0.a.b a : ESIMDEmuPluginInterfaceVersion b : ESIMDEmuPluginDataVersion

TODO : Check

TODO : Check. CM_MAX_1D_SURF_WIDTH from CM_EMU

TODO : Check

TODO : Check. CM_MAX_SAMPLERS_PER_KERNEL from CM_EMU

TODO : Check

TODO : Check. half_type.hpp from CM_EMU

Definition at line 592 of file pi_esimd_emulator.cpp.

◆ piDevicePartition()

pi_result piDevicePartition	(	pi_device	device,
		const pi_device_partition_property *	properties,
		pi_uint32	num_devices,
		pi_device *	out_devices,
		pi_uint32 *	out_num_devices
	)

Definition at line 814 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, PI_ASSERT, PI_CALL, PI_DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE, PI_DEVICE_AFFINITY_DOMAIN_NUMA, PI_DEVICE_PARTITION_BY_AFFINITY_DOMAIN, piDeviceRetain(), _pi_device::Platform, _pi_platform::populateDeviceCacheIfNeeded(), _pi_queue::Properties, and _pi_device::SubDevices.

Referenced by sycl::_V1::detail::device_impl::create_sub_devices(), and piPluginInit().

◆ piDeviceRelease()

pi_result piDeviceRelease ( pi_device device )

Definition at line 582 of file pi_esimd_emulator.cpp.

References Device, _pi_queue::Device, _pi_device::isSubDevice(), and PI_ASSERT.

Referenced by piPluginInit(), and sycl::_V1::detail::device_impl::~device_impl().

◆ piDeviceRetain()

pi_result piDeviceRetain ( pi_device device )

Definition at line 572 of file pi_esimd_emulator.cpp.

References Device, _pi_queue::Device, _pi_device::isSubDevice(), and PI_ASSERT.

Referenced by sycl::_V1::detail::device_impl::get(), sycl::_V1::detail::device_impl::getNative(), piDevicePartition(), and piPluginInit().

◆ piDevicesGet()

pi_result piDevicesGet	(	pi_platform	platform,
		pi_device_type	device_type,
		pi_uint32	num_entries,
		pi_device *	devices,
		pi_uint32 *	num_devices
	)

Runtime queries number of devices

No GPU entry to fill 'Devices' array

Definition at line 484 of file pi_esimd_emulator.cpp.

References PI_ASSERT, PI_DEVICE_TYPE_ACC, PI_DEVICE_TYPE_ALL, PI_DEVICE_TYPE_CPU, PI_DEVICE_TYPE_DEFAULT, PI_DEVICE_TYPE_GPU, _pi_platform::PiDeviceCache, _pi_platform::PiDevicesCache, _pi_platform::PiDevicesCacheMutex, PiTrace(), and _pi_platform::populateDeviceCacheIfNeeded().

Referenced by sycl::_V1::detail::platform_impl::get_devices(), and piPluginInit().

◆ piEnqueueEventsWait()

pi_result piEnqueueEventsWait	(	pi_queue	command_queue,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1477 of file pi_esimd_emulator.cpp.

References _pi_queue::CommandListMap, _pi_queue::Context, _pi_ze_event_list_t::createAndRetainPiZeEventList(), createEventAndAssociateQueue(), DIE_NO_IMPLEMENTATION, _pi_queue::executeCommandList(), _pi_context::getAvailableCommandList(), _pi_queue::LastCommandEvent, PI_ASSERT, PI_COMMAND_TYPE_USER, resetCommandLists(), _pi_queue::synchronize(), and ZE_CALL.

Referenced by sycl::_V1::detail::MemoryManager::copy_usm(), sycl::_V1::detail::MemoryManager::fill_usm(), piPluginInit(), and sycl::_V1::detail::Command::waitForEvents().

◆ piEnqueueEventsWaitWithBarrier()

pi_result piEnqueueEventsWaitWithBarrier	(	pi_queue	command_queue,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

◆ piEnqueueKernelLaunch()

pi_result piEnqueueKernelLaunch	(	pi_queue	queue,
		pi_kernel	kernel,
		pi_uint32	work_dim,
		const size_t *	global_work_offset,
		const size_t *	global_work_size,
		const size_t *	local_work_size,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

◆ piEnqueueMemBufferCopy()

pi_result piEnqueueMemBufferCopy	(	pi_queue	command_queue,
		pi_mem	src_buffer,
		pi_mem	dst_buffer,
		size_t	src_offset,
		size_t	dst_offset,
		size_t	size,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1567 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemCopyHelper(), _pi_mem::isImage(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_COPY, _pi_mem::read_only, and _pi_mem::write_only.

Referenced by sycl::_V1::detail::copyD2D(), and piPluginInit().

◆ piEnqueueMemBufferCopyRect()

pi_result piEnqueueMemBufferCopyRect	(	pi_queue	command_queue,
		pi_mem	src_buffer,
		pi_mem	dst_buffer,
		pi_buff_rect_offset	src_origin,
		pi_buff_rect_offset	dst_origin,
		pi_buff_rect_region	region,
		size_t	src_row_pitch,
		size_t	src_slice_pitch,
		size_t	dst_row_pitch,
		size_t	dst_slice_pitch,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1573 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemCopyRectHelper(), _pi_mem::isImage(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_COPY_RECT, _pi_mem::read_only, and _pi_mem::write_only.

Referenced by sycl::_V1::detail::copyD2D(), and piPluginInit().

◆ piEnqueueMemBufferFill()

pi_result piEnqueueMemBufferFill	(	pi_queue	command_queue,
		pi_mem	buffer,
		const void *	pattern,
		size_t	pattern_size,
		size_t	offset,
		size_t	size,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1581 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemFillHelper(), _pi_mem::getZeHandle(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_FILL, and _pi_mem::write_only.

Referenced by sycl::_V1::detail::MemoryManager::fill(), and piPluginInit().

◆ piEnqueueMemBufferMap()

pi_result piEnqueueMemBufferMap	(	pi_queue	command_queue,
		pi_mem	buffer,
		pi_bool	blocking_map,
		pi_map_flags	map_flags,
		size_t	offset,
		size_t	size,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event,
		void **	ret_map
	)

Definition at line 1587 of file pi_esimd_emulator.cpp.

References sycl::_V1::AccessMode, ARG_UNUSED, _pi_queue::CommandListMap, _pi_queue::Context, _pi_ze_event_list_t::createAndRetainPiZeEventList(), createEventAndAssociateQueue(), _pi_queue::Device, _pi_queue::executeCommandList(), _pi_context::getAvailableCommandList(), _pi_mem::isImage(), _pi_queue::isInOrderQueue(), _pi_mem::MapHostPtr, _pi_mem::Mappings, _pi_mem::MappingsMutex, sycl::_V1::detail::memcpy(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_MAP, PI_MAP_READ, PI_MAP_WRITE, PI_MAP_WRITE_INVALIDATE_REGION, piEventsWait(), piQueueFinish(), PiTrace(), _pi_mem::read_only, _pi_mem::read_write, _pi_event::release(), _pi_mem::unknown, _pi_mem::write_only, ZE_CALL, and ZeHostMemAllocHelper().

Referenced by sycl::_V1::detail::memBufferMapHelper(), and piPluginInit().

◆ piEnqueueMemBufferRead()

pi_result piEnqueueMemBufferRead	(	pi_queue	queue,
		pi_mem	buffer,
		pi_bool	blocking_read,
		size_t	offset,
		size_t	size,
		void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

TODO : Support Blocked read, 'Queue' handling

Definition at line 1487 of file pi_esimd_emulator.cpp.

References ARG_UNUSED, _pi_queue::Device, enqueueMemCopyHelper(), _pi_mem::getZeHandle(), _pi_buffer::MapHostPtr, sycl::_V1::detail::memcpy(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_READ, PiTrace(), _pi_mem::read_only, cm_surface_ptr_t::RegularBufPtr, _pi_event::release(), _pi_mem::SurfacePtr, cm_surface_ptr_t::tag, cm_surface_ptr_t::TypeRegularBuffer, and cm_surface_ptr_t::TypeUserProvidedBuffer.

Referenced by sycl::_V1::detail::copyD2H(), and piPluginInit().

◆ piEnqueueMemBufferReadRect()

pi_result piEnqueueMemBufferReadRect	(	pi_queue	command_queue,
		pi_mem	buffer,
		pi_bool	blocking_read,
		pi_buff_rect_offset	buffer_offset,
		pi_buff_rect_offset	host_offset,
		pi_buff_rect_region	region,
		size_t	buffer_row_pitch,
		size_t	buffer_slice_pitch,
		size_t	host_row_pitch,
		size_t	host_slice_pitch,
		void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1545 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemCopyRectHelper(), _pi_mem::getZeHandle(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_READ_RECT, and _pi_mem::read_only.

Referenced by sycl::_V1::detail::copyD2H(), and piPluginInit().

◆ piEnqueueMemBufferWrite()

pi_result piEnqueueMemBufferWrite	(	pi_queue	command_queue,
		pi_mem	buffer,
		pi_bool	blocking_write,
		size_t	offset,
		size_t	size,
		const void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1553 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemCopyHelper(), _pi_mem::getZeHandle(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_WRITE, and _pi_mem::write_only.

Referenced by sycl::_V1::detail::copyH2D(), and piPluginInit().

◆ piEnqueueMemBufferWriteRect()

pi_result piEnqueueMemBufferWriteRect	(	pi_queue	command_queue,
		pi_mem	buffer,
		pi_bool	blocking_write,
		pi_buff_rect_offset	buffer_offset,
		pi_buff_rect_offset	host_offset,
		pi_buff_rect_region	region,
		size_t	buffer_row_pitch,
		size_t	buffer_slice_pitch,
		size_t	host_row_pitch,
		size_t	host_slice_pitch,
		const void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1559 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, enqueueMemCopyRectHelper(), _pi_mem::getZeHandle(), PI_ASSERT, PI_CALL, PI_COMMAND_TYPE_MEM_BUFFER_WRITE_RECT, and _pi_mem::write_only.

Referenced by sycl::_V1::detail::copyH2D(), and piPluginInit().

◆ piEnqueueMemImageCopy()

pi_result piEnqueueMemImageCopy	(	pi_queue	command_queue,
		pi_mem	src_image,
		pi_mem	dst_image,
		pi_image_offset	src_origin,
		pi_image_offset	dst_origin,
		pi_image_region	region,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1741 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, enqueueMemImageCommandHelper(), PI_ASSERT, and PI_COMMAND_TYPE_IMAGE_COPY.

Referenced by sycl::_V1::detail::copyD2D(), and piPluginInit().

◆ piEnqueueMemImageFill()

pi_result piEnqueueMemImageFill	(	pi_queue	command_queue,
		pi_mem	image,
		const void *	fill_color,
		const size_t *	origin,
		const size_t *	region,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1747 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::detail::MemoryManager::fill(), and piPluginInit().

◆ piEnqueueMemImageRead()

pi_result piEnqueueMemImageRead	(	pi_queue	command_queue,
		pi_mem	image,
		pi_bool	blocking_read,
		pi_image_offset	origin,
		pi_image_region	region,
		size_t	row_pitch,
		size_t	slice_pitch,
		void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

TODO : Support Blocked read, 'Queue' handling

Definition at line 1670 of file pi_esimd_emulator.cpp.

References ARG_UNUSED, enqueueMemImageCommandHelper(), pi_image_region_struct::height, _pi_mem::MapHostPtr, sycl::_V1::detail::memcpy(), PI_ASSERT, PI_COMMAND_TYPE_IMAGE_READ, PiTrace(), cm_surface_ptr_t::RegularImgPtr, _pi_event::release(), _pi_mem::SurfacePtr, cm_surface_ptr_t::tag, cm_surface_ptr_t::TypeRegularImage, cm_surface_ptr_t::TypeUserProvidedImage, pi_image_offset_struct::x, pi_image_offset_struct::y, and pi_image_offset_struct::z.

Referenced by piPluginInit().

◆ piEnqueueMemImageWrite()

pi_result piEnqueueMemImageWrite	(	pi_queue	command_queue,
		pi_mem	image,
		pi_bool	blocking_write,
		pi_image_offset	origin,
		pi_image_region	region,
		size_t	input_row_pitch,
		size_t	input_slice_pitch,
		const void *	ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1735 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, enqueueMemImageCommandHelper(), PI_ASSERT, and PI_COMMAND_TYPE_IMAGE_WRITE.

Referenced by piPluginInit().

◆ piEnqueueMemUnmap()

pi_result piEnqueueMemUnmap	(	pi_queue	command_queue,
		pi_mem	memobj,
		void *	mapped_ptr,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

◆ piEnqueueNativeKernel()

pi_result piEnqueueNativeKernel	(	pi_queue	queue,
		void()(void )	user_func,
		void *	args,
		size_t	cb_args,
		pi_uint32	num_mem_objects,
		const pi_mem *	mem_list,
		const void **	args_mem_loc,
		pi_uint32	num_events_in_wait_list,
		const pi_event *	event_wait_list,
		pi_event *	event
	)

Definition at line 1829 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by piPluginInit().

◆ piEventCreate()

pi_result piEventCreate	(	pi_context	context,
		pi_event *	ret_event
	)

Definition at line 1380 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, and EventCreate().

Referenced by piPluginInit().

◆ piEventGetInfo()

pi_result piEventGetInfo	(	pi_event	event,
		pi_event_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

◆ piEventGetProfilingInfo()

pi_result piEventGetProfilingInfo	(	pi_event	event,
		pi_profiling_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

◆ piEventRelease()

pi_result piEventRelease ( pi_event event )

Definition at line 1434 of file pi_esimd_emulator.cpp.

References _pi_event::CmEventPtr, _pi_event::IsDummyEvent, _pi_event::OwnerQueue, PI_ASSERT, PI_CALL, piEventReleaseInternal(), and _pi_event::RefCountExternal.

Referenced by piPluginInit(), _pi_queue::synchronize(), and sycl::_V1::detail::event_impl::~event_impl().

◆ piEventRetain()

pi_result piEventRetain ( pi_event event )

Definition at line 1424 of file pi_esimd_emulator.cpp.

References PI_ASSERT, and _pi_event::RefCountExternal.

Referenced by sycl::_V1::detail::MemoryManager::allocateInteropMemObject(), createEventAndAssociateQueue(), sycl::_V1::detail::event_impl::getNative(), sycl::_V1::detail::make_event(), and piPluginInit().

◆ piEventSetCallback()

pi_result piEventSetCallback	(	pi_event	event,
		pi_int32	command_exec_callback_type,
		void()(pi_event event, pi_int32 event_command_status, void user_data)	pfn_notify,
		void *	user_data
	)

Referenced by piPluginInit().

◆ piEventSetStatus()

pi_result piEventSetStatus	(	pi_event	event,
		pi_int32	execution_status
	)

Definition at line 1422 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), and DIE_NO_IMPLEMENTATION.

Referenced by piPluginInit().

◆ piEventsWait()

pi_result piEventsWait	(	pi_uint32	num_events,
		const pi_event *	event_list
	)

Definition at line 1399 of file pi_esimd_emulator.cpp.

References CleanupCompletedEvent(), _pi_event::CmEventPtr, sycl::_V1::detail::pi::die(), _pi_event::HostVisibleEvent, OnDemandHostVisibleProxy, _pi_event::Queue, resetCommandLists(), and ZE_CALL.

Referenced by sycl::_V1::detail::memUnmapHelper(), piEnqueueMemBufferMap(), piEnqueueMemUnmap(), piPluginInit(), sycl::_V1::detail::waitForEvents(), sycl::_V1::detail::Command::waitForEvents(), and sycl::_V1::detail::event_impl::waitInternal().

◆ piextContextCreateWithNativeHandle()

pi_result piextContextCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_uint32	numDevices,
		const pi_device *	devices,
		bool	pluginOwnsNativeHandle,
		pi_context *	context
	)

Creates PI context object from a native handle.

NOTE: The created PI object takes ownership of the native handle. NOTE: The number of devices and the list of devices is needed for Level Zero backend because there is no possilibity to query this information from context handle for Level Zero. If backend has API to query a list of devices from the context native handle then these parameters are ignored.

Parameters

nativeHandle	is the native handle to create PI context from.
numDevices	is the number of devices in the context. Parameter is ignored if number of devices can be queried from the context native handle for a backend.
devices	is the list of devices in the context. Parameter is ignored if devices can be queried from the context native handle for a backend.
pluginOwnsNativeHandle	Indicates whether the created PI object should take ownership of the native handle.
context	is the PI context created from the native handle.

Returns: PI_SUCCESS if successfully created pi_context from the handle. PI_ERROR_OUT_OF_HOST_MEMORY if can't allocate memory for the pi_context object. PI_ERROR_INVALID_VALUE if numDevices == 0 or devices is NULL but backend doesn't have API to query a list of devices from the context native handle. PI_UNKNOWN_ERROR in case of another error.

Definition at line 873 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::ext::oneapi::level_zero::make_context(), sycl::_V1::detail::make_context(), and piPluginInit().

◆ piextContextGetNativeHandle()

pi_result piextContextGetNativeHandle	(	pi_context	context,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI context object.

Parameters

context	is the PI context to get the native handle of.
nativeHandle	is the native handle of context.

Definition at line 869 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, PI_ASSERT, piextGetNativeHandle(), and _pi_context::ZeContext.

Referenced by sycl::_V1::detail::context_impl::getNative(), and piPluginInit().

◆ piextContextSetExtendedDeleter()

pi_result piextContextSetExtendedDeleter	(	pi_context	context,
		pi_context_extended_deleter	func,
		void *	user_data
	)

Definition at line 864 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, sycl::_V1::detail::pi::die(), and DIE_NO_IMPLEMENTATION.

Referenced by sycl::_V1::detail::pi::contextSetExtendedDeleter(), and piPluginInit().

◆ piextDeviceCreateWithNativeHandle()

pi_result piextDeviceCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_platform	platform,
		pi_device *	device
	)

Creates PI device object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI device from.
platform	is the platform of the device (optional).
device	is the PI device created from the native handle.

Definition at line 823 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, PI_ASSERT, PiPlatformCachePopulated, PiPlatformsCache, and PiPlatformsCacheMutex.

Referenced by sycl::_V1::ext::oneapi::level_zero::make_device(), sycl::_V1::detail::make_device(), and piPluginInit().

◆ piextDeviceGetNativeHandle()

pi_result piextDeviceGetNativeHandle	(	pi_device	device,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI device object.

Parameters

device	is the PI device to get the native handle of.
nativeHandle	is the native handle of device.

Definition at line 819 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, DIE_NO_IMPLEMENTATION, PI_ASSERT, piextGetNativeHandle(), and _pi_device::ZeDevice.

Referenced by sycl::_V1::detail::device_impl::getNative(), and piPluginInit().

◆ piextDeviceSelectBinary()

pi_result piextDeviceSelectBinary	(	pi_device	device,
		pi_device_binary *	binaries,
		pi_uint32	num_binaries,
		pi_uint32 *	selected_binary_ind
	)

Selects the most appropriate device binary based on runtime information and the IR characteristics.

TODO : Support multiple images and enable selection algorithm for the images

Definition at line 1947 of file pi_esimd_emulator.cpp.

References __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64, __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA, __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN, __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64, _pi_queue::Device, max(), PI_ASSERT, and PiTrace().

Referenced by sycl::_V1::detail::compatibleWithDevice(), and piPluginInit().

◆ piextEventCreateWithNativeHandle()

pi_result piextEventCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_context	context,
		bool	ownNativeHandle,
		pi_event *	event
	)

Creates PI event object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI event from.
context	is the corresponding PI context
pluginOwnsNativeHandle	Indicates whether the created PI object should take ownership of the native handle.
event	is the PI event created from the native handle.

Definition at line 1459 of file pi_esimd_emulator.cpp.

References _pi_event::CleanedUp, _pi_queue::Context, DIE_NO_IMPLEMENTATION, PI_ASSERT, and PI_COMMAND_TYPE_USER.

Referenced by sycl::_V1::detail::make_event(), and piPluginInit().

◆ piextEventGetNativeHandle()

pi_result piextEventGetNativeHandle	(	pi_event	event,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI event object.

Parameters

event	is the PI event to get the native handle of.
nativeHandle	is the native handle of event.

Definition at line 1455 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, _pi_event::Queue, and _pi_event::ZeEvent.

Referenced by sycl::_V1::detail::event_impl::getNative(), and piPluginInit().

◆ piextGetDeviceFunctionPointer()

pi_result piextGetDeviceFunctionPointer	(	pi_device	device,
		pi_program	program,
		const char *	function_name,
		pi_uint64 *	function_pointer_ret
	)

Retrieves a device function pointer to a user-defined function.

function_name.
function_pointer_ret is set to 0 if query failed.

program must be built before calling this API.
device must present in the list of devices returned by get_device method for
program.

If a fallback method determines the function exists but the address is not available PI_ERROR_FUNCTION_ADDRESS_IS_NOT_AVAILABLE is returned. If the address does not exist PI_ERROR_INVALID_KERNEL_NAME is returned.

Definition at line 1835 of file pi_esimd_emulator.cpp.

References clGetDeviceFunctionPointerName, _pi_queue::Device, DIE_NO_IMPLEMENTATION, _pi_program::Exe, getExtFuncFromContext(), is_in_separated_string(), PI_ASSERT, PI_CALL, PI_PROGRAM_INFO_KERNEL_NAMES, piProgramGetInfo(), _pi_program::State, ZE_CALL_NOCHECK, and _pi_program::ZeModule.

Referenced by sycl::_V1::detail::program_impl::has_kernel(), and piPluginInit().

◆ piextKernelCreateWithNativeHandle()

pi_result piextKernelCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_context	context,
		pi_program	program,
		bool	pluginOwnsNativeHandle,
		pi_kernel *	kernel
	)

Creates PI kernel object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI kernel from.
context	is the PI context of the kernel.
program	is the PI program of the kernel.
pluginOwnsNativeHandle	Indicates whether the created PI object should take ownership of the native handle.
kernel	is the PI kernel created from the native handle.

Definition at line 1820 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, PI_ASSERT, and PI_CALL.

Referenced by sycl::_V1::detail::make_kernel(), and piPluginInit().

◆ piextKernelGetNativeHandle()

pi_result piextKernelGetNativeHandle	(	pi_kernel	kernel,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI kernel object.

Parameters

kernel	is the PI kernel to get the native handle of.
nativeHandle	is the native handle of kernel.

Definition at line 1825 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, piextGetNativeHandle(), and _pi_kernel::ZeKernel.

Referenced by sycl::_V1::detail::kernel_impl::getNative(), and piPluginInit().

◆ piextKernelSetArgMemObj()

pi_result piextKernelSetArgMemObj	(	pi_kernel	kernel,
		pi_uint32	arg_index,
		const pi_mem *	arg_value
	)

Definition at line 1352 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, _pi_kernel::PendingArguments, PI_ASSERT, and _pi_mem::read_write.

Referenced by piPluginInit(), and sycl::_V1::detail::SetKernelParamsAndLaunch().

◆ piextKernelSetArgPointer()

pi_result piextKernelSetArgPointer	(	pi_kernel	kernel,
		pi_uint32	arg_index,
		size_t	arg_size,
		const void *	arg_value
	)

Sets up pointer arguments for CL kernels.

An extra indirection is required due to CL argument conventions.

Parameters

kernel	is the kernel to be launched
arg_index	is the index of the kernel argument
arg_size	is the size in bytes of the argument (ignored in CL)
arg_value	is the pointer argument

Definition at line 1913 of file pi_esimd_emulator.cpp.

References clSetKernelArgMemPointerName, DIE_NO_IMPLEMENTATION, getExtFuncFromContext(), PI_CALL, and piKernelSetArg().

Referenced by piPluginInit(), and sycl::_V1::detail::SetKernelParamsAndLaunch().

◆ piextKernelSetArgSampler()

pi_result piextKernelSetArgSampler	(	pi_kernel	kernel,
		pi_uint32	arg_index,
		const pi_sampler *	arg_value
	)

Definition at line 1357 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, ZE_CALL, and _pi_kernel::ZeKernel.

Referenced by piPluginInit(), and sycl::_V1::detail::SetKernelParamsAndLaunch().

◆ piextMemCreateWithNativeHandle()

pi_result piextMemCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_context	context,
		bool	ownNativeHandle,
		pi_mem *	mem
	)

Creates PI mem object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI mem from.
context	The PI context of the memory allocation.
ownNativeHandle	Indicates if we own the native memory handle or it came from interop that asked to not transfer the ownership to SYCL RT.
mem	is the PI mem created from the native handle.

Definition at line 1276 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_platform::ContextsMutex, _pi_queue::Device, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, _pi_platform::getDeviceFromNativeHandle(), _pi_context::getPlatform(), _pi_context::ImmediateCommandListMutex, _pi_context::isValidDevice(), _pi_context::MemAllocs, PI_ASSERT, PI_CALL, piContextRetain(), _pi_mem::write_only, ZE_CALL, _pi_context::ZeCommandListInit, and _pi_context::ZeContext.

Referenced by piPluginInit(), and sycl::_V1::detail::SYCLMemObjT::SYCLMemObjT().

◆ piextMemGetNativeHandle()

pi_result piextMemGetNativeHandle	(	pi_mem	mem,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI mem object.

Parameters

mem	is the PI mem to get the native handle of.
nativeHandle	is the native handle of mem.

Definition at line 1272 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, _pi_mem::getZeHandle(), PI_ASSERT, PI_CALL, piextGetNativeHandle(), and _pi_mem::read_write.

Referenced by sycl::_V1::detail::buffer_impl::getNativeVector(), sycl::_V1::detail::memBufferCreateHelper(), sycl::_V1::detail::memReleaseHelper(), and piPluginInit().

◆ piextPlatformCreateWithNativeHandle()

pi_result piextPlatformCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_platform *	platform
	)

Creates PI platform object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI device from.
platform	is the PI platform created from the native handle.

Definition at line 480 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, PI_CALL, and piPlatformsGet().

Referenced by sycl::_V1::detail::make_platform(), and piPluginInit().

◆ piextPlatformGetNativeHandle()

pi_result piextPlatformGetNativeHandle	(	pi_platform	platform,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI platform object.

Parameters

platform	is the PI platform to get the native handle of.
nativeHandle	is the native handle of platform.

Definition at line 476 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, piextGetNativeHandle(), and _pi_platform::ZeDriver.

Referenced by sycl::_V1::detail::platform_impl::getNative(), and piPluginInit().

◆ piextPluginGetOpaqueData()

pi_result piextPluginGetOpaqueData	(	void *	opaque_data_param,
		void **	opaque_data_return
	)

API to get Plugin internal data, opaque to SYCL RT.

Some devices whose device code is compiled by the host compiler (e.g. CPU emulators) may use it to access some device code functionality implemented in/behind the plugin.

Parameters

opaque_data_param	- unspecified argument, interpretation is specific to a plugin
opaque_data_return	- placeholder for the returned opaque data.

Definition at line 1965 of file pi_esimd_emulator.cpp.

References PiESimdDeviceAccess.

Referenced by sycl::_V1::detail::getPluginOpaqueData().

◆ piextProgramCreateWithNativeHandle()

pi_result piextProgramCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_context	context,
		bool	pluginOwnsNativeHandle,
		pi_program *	program
	)

Creates PI program object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI program from.
context	is the PI context of the program.
pluginOwnsNativeHandle	Indicates whether the created PI object should take ownership of the native handle.
program	is the PI program created from the native handle.

Definition at line 1339 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, _pi_program::Exe, and PI_ASSERT.

Referenced by sycl::_V1::detail::make_kernel_bundle(), and piPluginInit().

◆ piextProgramGetNativeHandle()

pi_result piextProgramGetNativeHandle	(	pi_program	program,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI program object.

Parameters

program	is the PI program to get the native handle of.
nativeHandle	is the native handle of program.

Definition at line 1335 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, _pi_program::Exe, PI_ASSERT, piextGetNativeHandle(), _pi_program::State, and _pi_program::ZeModule.

Referenced by sycl::_V1::detail::device_image_impl::getNative(), sycl::_V1::detail::program_impl::getNative(), and piPluginInit().

◆ piextProgramSetSpecializationConstant()

pi_result piextProgramSetSpecializationConstant	(	pi_program	prog,
		pi_uint32	spec_id,
		size_t	spec_size,
		const void *	spec_value
	)

Sets a specialization constant to a specific value.

Note: Only used when specialization constants are natively supported (SPIR-V binaries), and not when they are emulated (AOT binaries).

Parameters

prog	the program object which will use the value
spec_id	integer ID of the constant
spec_size	size of the value
spec_value	bytes of the value

Definition at line 1942 of file pi_esimd_emulator.cpp.

References clSetProgramSpecializationConstantName, DIE_NO_IMPLEMENTATION, getExtFuncFromContext(), and _pi_program::SpecConstants.

Referenced by sycl::_V1::detail::ProgramManager::build(), sycl::_V1::detail::enableITTAnnotationsIfNeeded(), sycl::_V1::detail::program_impl::flush_spec_constants(), and piPluginInit().

◆ piextQueueCreateWithNativeHandle()

pi_result piextQueueCreateWithNativeHandle	(	pi_native_handle	nativeHandle,
		pi_context	context,
		pi_device	device,
		bool	pluginOwnsNativeHandle,
		pi_queue *	queue
	)

Creates PI queue object from a native handle.

NOTE: The created PI object takes ownership of the native handle.

Parameters

nativeHandle	is the native handle to create PI queue from.
context	is the PI context of the queue.
device	is the PI device associated with the native device used when creating the native queue. This parameter is optional but some backends may fail to create the right PI queue if omitted.
pluginOwnsNativeHandle	Indicates whether the created PI object should take ownership of the native handle.
queue	is the PI queue created from the native handle.

Definition at line 996 of file pi_esimd_emulator.cpp.

References _pi_queue::_pi_queue(), _pi_queue::Context, _pi_queue::Device, DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::detail::make_queue_impl(), and piPluginInit().

◆ piextQueueGetNativeHandle()

pi_result piextQueueGetNativeHandle	(	pi_queue	queue,
		pi_native_handle *	nativeHandle
	)

Gets the native handle of a PI queue object.

Parameters

queue	is the PI queue to get the native handle of.
nativeHandle	is the native handle of queue.

Definition at line 992 of file pi_esimd_emulator.cpp.

References _pi_queue::ComputeQueueGroup, DIE_NO_IMPLEMENTATION, PI_ASSERT, piextGetNativeHandle(), and _pi_queue::pi_queue_group_t::ZeQueues.

Referenced by sycl::_V1::detail::queue_impl::getNative(), and piPluginInit().

◆ piextUSMDeviceAlloc()

pi_result piextUSMDeviceAlloc	(	void **	result_ptr,
		pi_context	context,
		pi_device	device,
		pi_usm_mem_properties *	properties,
		size_t	size,
		pi_uint32	alignment
	)

Allocates device memory.

Parameters

result_ptr	contains the allocated memory
context	is the pi_context
device	is the device the memory will be allocated on
properties	are optional allocation properties
size	is the size of the allocation
alignment	is the desired alignment of the allocation
result_ptr	contains the allocated memory
context	is the pi_context
device	is the device the memory will be allocated on
pi_usm_mem_properties	are optional allocation properties
size_t	is the size of the allocation
alignment	is the desired alignment of the allocation

Definition at line 1845 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_platform::ContextsMutex, _pi_queue::Device, _pi_context::DeviceMemAllocContexts, DIE_NO_IMPLEMENTATION, UsmAllocationException::getError(), _pi_context::MemAllocs, PI_CALL, piContextRetain(), _pi_device::Platform, _pi_queue::Properties, UseUSMAllocator, and USMDeviceAllocImpl().

Referenced by sycl::_V1::detail::usm::alignedAlloc(), _pi_buffer::getZeHandle(), and piPluginInit().

◆ piextUSMEnqueueMemAdvise()

pi_result piextUSMEnqueueMemAdvise	(	pi_queue	queue,
		const void *	ptr,
		size_t	length,
		pi_mem_advice	advice,
		pi_event *	event
	)

USM Memadvise API.

Parameters

queue	is the queue to submit to
ptr	is the data to be advised
length	is the size in bytes of the memory to advise
advice	is device specific advice
event	is the event that represents this operation

USM Memadvise API.

Parameters

Queue	is the queue to submit to
Ptr	is the data to be advised
Length	is the size in bytes of the meory to advise
Advice	is device specific advice
Event	is the event that represents this operation
queue	is the queue to submit to
ptr	is the data to be advised
length	is the size in bytes of the meory to advise
advice	is device specific advice
event	is the event that represents this operation

Definition at line 1927 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_ze_event_list_t::createAndRetainPiZeEventList(), createEventAndAssociateQueue(), _pi_queue::Device, DIE_NO_IMPLEMENTATION, _pi_queue::executeCommandList(), _pi_context::getAvailableCommandList(), sycl::_V1::length(), PI_ASSERT, PI_COMMAND_TYPE_USER, ZE_CALL, and _pi_device::ZeDevice.

Referenced by sycl::_V1::detail::MemoryManager::advise_usm(), and piPluginInit().

◆ piextUSMEnqueueMemcpy()

pi_result piextUSMEnqueueMemcpy	(	pi_queue	queue,
		pi_bool	blocking,
		void *	dst_ptr,
		const void *	src_ptr,
		size_t	size,
		pi_uint32	num_events_in_waitlist,
		const pi_event *	events_waitlist,
		pi_event *	event
	)

USM Memcpy API.

Parameters

queue	is the queue to submit to
blocking	is whether this operation should block the host
src_ptr	is the data to be copied
dst_ptr	is the location the data will be copied
size	is number of bytes to copy
num_events_in_waitlist	is the number of events to wait on
events_waitlist	is an array of events to wait on
event	is the event that represents this operation

Definition at line 1922 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, enqueueMemCopyHelper(), IsDevicePointer(), PI_ASSERT, and PI_COMMAND_TYPE_MEM_BUFFER_COPY.

Referenced by sycl::_V1::detail::MemoryManager::copy_usm(), and piPluginInit().

◆ piextUSMEnqueueMemset()

pi_result piextUSMEnqueueMemset	(	pi_queue	queue,
		void *	ptr,
		pi_int32	value,
		size_t	count,
		pi_uint32	num_events_in_waitlist,
		const pi_event *	events_waitlist,
		pi_event *	event
	)

USM Memset API.

Parameters

queue	is the queue to submit to
ptr	is the ptr to memset
value	is value to set. It is interpreted as an 8-bit value and the upper 24 bits are ignored
count	is the size in bytes to memset
num_events_in_waitlist	is the number of events to wait on
events_waitlist	is an array of events to wait on
event	is the event that represents this operation
Queue	is the queue to submit to
Ptr	is the ptr to memset
Value	is value to set. It is interpreted as an 8-bit value and the upper 24 bits are ignored
Count	is the size in bytes to memset
NumEventsInWaitlist	is the number of events to wait on
EventsWaitlist	is an array of events to wait on
Event	is the event that represents this operation

Definition at line 1917 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, enqueueMemFillHelper(), PI_ASSERT, and PI_COMMAND_TYPE_MEM_BUFFER_FILL.

Referenced by sycl::_V1::detail::MemoryManager::fill_usm(), and piPluginInit().

◆ piextUSMEnqueuePrefetch()

pi_result piextUSMEnqueuePrefetch	(	pi_queue	queue,
		const void *	ptr,
		size_t	size,
		pi_usm_migration_flags	flags,
		pi_uint32	num_events_in_waitlist,
		const pi_event *	events_waitlist,
		pi_event *	event
	)

Hint to migrate memory to the device.

Parameters

queue	is the queue to submit to
ptr	points to the memory to migrate
size	is the number of bytes to migrate
flags	is a bitfield used to specify memory migration options
num_events_in_waitlist	is the number of events to wait on
events_waitlist	is an array of events to wait on
event	is the event that represents this operation
Queue	is the queue to submit to
Ptr	points to the memory to migrate
Size	is the number of bytes to migrate
Flags	is a bitfield used to specify memory migration options
NumEventsInWaitlist	is the number of events to wait on
EventsWaitlist	is an array of events to wait on
Event	is the event that represents this operation

Definition at line 1959 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_ze_event_list_t::createAndRetainPiZeEventList(), createEventAndAssociateQueue(), DIE_NO_IMPLEMENTATION, _pi_queue::executeCommandList(), _pi_context::getAvailableCommandList(), PI_ASSERT, PI_COMMAND_TYPE_USER, and ZE_CALL.

Referenced by piPluginInit(), and sycl::_V1::detail::MemoryManager::prefetch_usm().

◆ piextUSMFree()

pi_result piextUSMFree	(	pi_context	context,
		void *	ptr
	)

Indicates that the allocated USM memory is no longer needed on the runtime side.

The actual freeing of the memory may be done in a blocking or deferred manner, e.g. to avoid issues with indirect memory access from kernels.

Parameters

context	is the pi_context of the allocation
ptr	is the memory to be freed

Indicates that the allocated USM memory is no longer needed on the runtime side.

Parameters

context	is the pi_context of the allocation
ptr	is the memory to be freed

Definition at line 1889 of file pi_esimd_emulator.cpp.

References _pi_context::Addr2CmBufferSVM, _pi_context::Addr2CmBufferSVMLock, _pi_device::CmDevicePtr, _pi_queue::Context, _pi_platform::ContextsMutex, _pi_context::Device, _pi_context::getPlatform(), and USMFreeHelper().

Referenced by sycl::_V1::detail::usm::free(), and piPluginInit().

◆ piextUSMGetMemAllocInfo()

pi_result piextUSMGetMemAllocInfo	(	pi_context	context,
		const void *	ptr,
		pi_mem_alloc_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

API to query information about USM allocated pointers Valid Queries: PI_MEM_ALLOC_TYPE returns host/device/shared pi_host_usm value PI_MEM_ALLOC_BASE_PTR returns the base ptr of an allocation if the queried pointer fell inside an allocation.

Result must fit in void * PI_MEM_ALLOC_SIZE returns how big the queried pointer's allocation is in bytes. Result is a size_t. PI_MEM_ALLOC_DEVICE returns the pi_device this was allocated against

Parameters

context	is the pi_context
ptr	is the pointer to query
param_name	is the type of query to perform
param_value_size	is the size of the result in bytes
param_value	is the result
param_value_size_ret	is how many bytes were written

API to query information about USM allocated pointers Valid Queries: PI_MEM_ALLOC_TYPE returns host/device/shared pi_host_usm value PI_MEM_ALLOC_BASE_PTR returns the base ptr of an allocation if the queried pointer fell inside an allocation.

Valid Queries: PI_MEM_ALLOC_TYPE returns host/device/shared pi_usm_type value PI_MEM_ALLOC_BASE_PTR returns the base ptr of an allocation if the queried pointer fell inside an allocation. Result must fit in void * PI_MEM_ALLOC_SIZE returns how big the queried pointer's allocation is in bytes. Result is a size_t. PI_MEM_ALLOC_DEVICE returns the pi_device this was allocated against

Parameters

Context	is the pi_context
Ptr	is the pointer to query
ParamName	is the type of query to perform
ParamValueSize	is the size of the result in bytes
ParamValue	is the result
ParamValueRet	is how many bytes were written

Result must fit in void * PI_MEM_ALLOC_SIZE returns how big the queried pointer's allocation is in bytes. Result is a size_t. PI_MEM_ALLOC_DEVICE returns the pi_device this was allocated against

Parameters

context	is the pi_context
ptr	is the pointer to query
param_name	is the type of query to perform
param_value_size	is the size of the result in bytes
param_value	is the result
param_value_ret	is how many bytes were written

Definition at line 1932 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_queue::Device, DIE_NO_IMPLEMENTATION, _pi_context::getPlatform(), PI_ASSERT, PI_MEM_ALLOC_BASE_PTR, PI_MEM_ALLOC_DEVICE, PI_MEM_ALLOC_SIZE, PI_MEM_ALLOC_TYPE, PI_MEM_TYPE_DEVICE, PI_MEM_TYPE_HOST, PI_MEM_TYPE_SHARED, PI_MEM_TYPE_UNKNOWN, ZE_CALL, and _pi_context::ZeContext.

Referenced by sycl::_V1::get_pointer_device(), sycl::_V1::get_pointer_type(), and piPluginInit().

◆ piextUSMHostAlloc()

pi_result piextUSMHostAlloc	(	void **	result_ptr,
		pi_context	context,
		pi_usm_mem_properties *	properties,
		size_t	size,
		pi_uint32	alignment
	)

Allocates host memory accessible by the device.

Parameters

result_ptr	contains the allocated memory
context	is the pi_context
properties	are optional allocation properties
size	is the size of the allocation
alignment	is the desired alignment of the allocation
result_ptr	contains the allocated memory
context	is the pi_context
pi_usm_mem_properties	are optional allocation properties
size_t	is the size of the allocation
alignment	is the desired alignment of the allocation

Definition at line 1840 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_platform::ContextsMutex, DIE_NO_IMPLEMENTATION, UsmAllocationException::getError(), _pi_context::getPlatform(), _pi_context::HostMemAllocContext, _pi_context::MemAllocs, PI_CALL, piContextRetain(), _pi_queue::Properties, UseUSMAllocator, and USMHostAllocImpl().

Referenced by sycl::_V1::detail::usm::alignedAllocHost(), _pi_buffer::getZeHandle(), and piPluginInit().

◆ piextUSMSharedAlloc()

pi_result piextUSMSharedAlloc	(	void **	result_ptr,
		pi_context	context,
		pi_device	device,
		pi_usm_mem_properties *	properties,
		size_t	size,
		pi_uint32	alignment
	)

Allocates memory accessible on both host and device.

Parameters

result_ptr	contains the allocated memory
context	is the pi_context
device	is the device the memory will be allocated on
properties	are optional allocation properties
size	is the size of the allocation
alignment	is the desired alignment of the allocation
result_ptr	contains the allocated memory
context	is the pi_context
device	is the device the memory will be allocated on
pi_usm_mem_properties	are optional allocation properties
size_t	is the size of the allocation
alignment	is the desired alignment of the allocation

Definition at line 1850 of file pi_esimd_emulator.cpp.

References _pi_context::Addr2CmBufferSVM, _pi_context::Addr2CmBufferSVMLock, ARG_UNUSED, _pi_device::CmDevicePtr, _pi_queue::Context, _pi_platform::ContextsMutex, Device, _pi_context::Device, _pi_queue::Device, sycl::_V1::detail::DeviceReadOnly, UsmAllocationException::getError(), sycl::_V1::detail::getNextPowerOfTwo(), _pi_context::MemAllocs, PI_ASSERT, PI_CALL, PI_MEM_ALLOC_DEVICE_READ_ONLY, PI_MEM_ALLOC_FLAGS, piContextRetain(), _pi_device::Platform, _pi_queue::Properties, _pi_context::SharedMemAllocContexts, _pi_context::SharedReadOnlyAllocs, _pi_context::SharedReadOnlyMemAllocContexts, UseUSMAllocator, and USMSharedAllocImpl().

Referenced by sycl::_V1::detail::usm::alignedAlloc(), and piPluginInit().

◆ piKernelCreate()

pi_result piKernelCreate	(	pi_program	program,
		const char *	kernel_name,
		pi_kernel *	ret_kernel
	)

Definition at line 1344 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, _pi_program::Exe, PI_ASSERT, PI_CALL, _pi_program::State, ZE_CALL, and _pi_program::ZeModule.

Referenced by sycl::_V1::detail::ProgramManager::getOrCreateKernel(), and piPluginInit().

◆ piKernelGetGroupInfo()

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
	)

◆ piKernelGetInfo()

pi_result piKernelGetInfo	(	pi_kernel	kernel,
		pi_kernel_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

◆ piKernelGetSubGroupInfo()

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,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

API to query information from the sub-group from a kernel.

Parameters

kernel	is the pi_kernel to query
device	is the device the kernel is executed on
param_name	is a pi_kernel_sub_group_info enum value that specifies the informtation queried for.
input_value_size	is the size of input value passed in ptr input_value param
input_value	is the ptr to the input value passed.
param_value_size	is the size of the value in bytes.
param_value	is a pointer to the value to set.
param_value_size_ret	is a pointer to return the size of data in param_value ptr.

All queries expect a return of 4 bytes in param_value_size, param_value_size_ret, and a uint32_t value should to be written in param_value ptr. Note: This behaviour differs from OpenCL. OpenCL returns size_t.

Definition at line 1370 of file pi_esimd_emulator.cpp.

References _pi_queue::Device, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, PI_DEVICE_INFO_MAX_WORK_ITEM_DIMENSIONS, PI_DEVICE_INFO_MAX_WORK_ITEM_SIZES, PI_KERNEL_COMPILE_NUM_SUB_GROUPS, PI_KERNEL_COMPILE_SUB_GROUP_SIZE_INTEL, PI_KERNEL_MAX_NUM_SUB_GROUPS, PI_KERNEL_MAX_SUB_GROUP_SIZE, piDeviceGetInfo(), and _pi_kernel::ZeKernelProperties.

Referenced by sycl::_V1::detail::get_kernel_device_specific_info_helper(), sycl::_V1::detail::get_kernel_device_specific_info_with_input(), and piPluginInit().

◆ piKernelRelease()

pi_result piKernelRelease ( pi_kernel kernel )

◆ piKernelRetain()

pi_result piKernelRetain ( pi_kernel kernel )

Definition at line 1376 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::detail::kernel_impl::get(), sycl::_V1::detail::kernel_impl::getNative(), sycl::_V1::detail::kernel_impl::kernel_impl(), sycl::_V1::detail::make_kernel(), piEnqueueKernelLaunch(), and piPluginInit().

◆ piKernelSetArg()

pi_result piKernelSetArg	(	pi_kernel	kernel,
		pi_uint32	arg_index,
		size_t	arg_size,
		const void *	arg_value
	)

Definition at line 1348 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, ZE_CALL, and _pi_kernel::ZeKernel.

Referenced by piextKernelSetArgPointer(), piPluginInit(), and sycl::_V1::detail::SetKernelParamsAndLaunch().

◆ piKernelSetExecInfo()

pi_result piKernelSetExecInfo	(	pi_kernel	kernel,
		pi_kernel_exec_info	param_name,
		size_t	param_value_size,
		const void *	param_value
	)

API to set attributes controlling kernel execution.

Parameters

kernel	is the pi kernel to execute
param_name	is a pi_kernel_exec_info value that specifies the info passed to the kernel
param_value_size	is the size of the value in bytes
param_value	is a pointer to the value to set for the kernel

If param_name is PI_USM_INDIRECT_ACCESS, the value will be a ptr to the pi_bool value PI_TRUE If param_name is PI_USM_PTRS, the value will be an array of ptrs

Definition at line 1937 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, PI_TRUE, PI_USM_INDIRECT_ACCESS, USMSetIndirectAccess(), ZE_CALL, and _pi_kernel::ZeKernel.

Referenced by sycl::_V1::detail::ProgramManager::getOrCreateKernel(), sycl::_V1::detail::kernel_impl::kernel_impl(), and piPluginInit().

◆ piMemBufferCreate()

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 = `nullptr`
	)

Definition at line 1001 of file pi_esimd_emulator.cpp.

References ARG_UNUSED, _pi_context::checkSurfaceArgument(), clCreateBufferWithPropertiesName, _pi_device::CmDevicePtr, _pi_queue::Context, _pi_context::Device, sycl::_V1::detail::pi::die(), ZeUSMImportExtension::doZeUSMImport(), ZeUSMImportExtension::Enabled, getExtFuncFromContext(), _pi_context::getPlatform(), _pi_buffer::getZeHandle(), _pi_context::ImmediateCommandListMutex, sycl::_V1::detail::memcpy(), _pi_buffer::OnHost, PI_ASSERT, PI_CALL, PI_MEM_ACCESS_READ_ONLY, PI_MEM_FLAGS_ACCESS_RW, PI_MEM_FLAGS_HOST_PTR_ALLOC, PI_MEM_FLAGS_HOST_PTR_COPY, PI_MEM_FLAGS_HOST_PTR_USE, PiESimdSurfaceMap, PiESimdSurfaceMapLock, PiTrace(), cm_surface_ptr_t::RegularBufPtr, cm_surface_ptr_t::tag, cm_surface_ptr_t::TypeRegularBuffer, cm_surface_ptr_t::TypeUserProvidedBuffer, cm_surface_ptr_t::UPBufPtr, _pi_mem::write_only, ZE_CALL, _pi_context::ZeCommandListInit, _pi_context::ZeContext, _pi_platform::ZeDriver, and ZeUSMImport.

Referenced by sycl::_V1::detail::memBufferCreateHelper(), and piPluginInit().

◆ piMemBufferPartition()

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
	)

Definition at line 1753 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, _pi_mem::isImage(), PI_ASSERT, PI_BUFFER_CREATE_TYPE_REGION, and PI_MEM_FLAGS_ACCESS_RW.

Referenced by sycl::_V1::detail::MemoryManager::allocateMemSubBuffer(), and piPluginInit().

◆ piMemGetInfo()

pi_result piMemGetInfo	(	pi_mem	mem,
		pi_mem_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 1074 of file pi_esimd_emulator.cpp.

References _pi_mem::Context, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, _pi_mem::isImage(), PI_ASSERT, PI_MEM_CONTEXT, and PI_MEM_SIZE.

Referenced by sycl::_V1::detail::SYCLMemObjT::getBufSizeForContext(), piPluginInit(), and sycl::_V1::detail::SYCLMemObjT::SYCLMemObjT().

◆ piMemImageCreate()

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
	)

Definition at line 1153 of file pi_esimd_emulator.cpp.

Referenced by sycl::_V1::detail::MemoryManager::allocateImageObject(), and piPluginInit().

◆ piMemImageGetInfo()

pi_result piMemImageGetInfo	(	pi_mem	image,
		pi_image_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 1666 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), and DIE_NO_IMPLEMENTATION.

Referenced by sycl::_V1::detail::getImageInfo(), and piPluginInit().

◆ piMemRelease()

pi_result piMemRelease ( pi_mem mem )

Definition at line 1086 of file pi_esimd_emulator.cpp.

References _pi_buffer::free(), _pi_mem::getZeHandle(), _pi_mem::isImage(), PI_ASSERT, PI_CALL, PiESimdSurfaceMap, PiESimdSurfaceMapLock, PiTrace(), _pi_mem::SurfaceIndex, _pi_mem::write_only, and ZE_CALL.

Referenced by sycl::_V1::detail::memReleaseHelper(), piPluginInit(), and sycl::_V1::detail::SYCLMemObjT::updateHostMemory().

◆ piMemRetain()

pi_result piMemRetain ( pi_mem mem )

Definition at line 1078 of file pi_esimd_emulator.cpp.

References PI_ASSERT.

Referenced by sycl::_V1::detail::buffer_impl::addInteropObject(), sycl::_V1::detail::buffer_impl::getNativeVector(), piPluginInit(), and sycl::_V1::detail::SYCLMemObjT::SYCLMemObjT().

◆ piPlatformGetInfo()

pi_result piPlatformGetInfo	(	pi_platform	platform,
		pi_platform_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 444 of file pi_esimd_emulator.cpp.

References _pi_platform::CmEmuVersion, sycl::_V1::detail::pi::die(), PI_ASSERT, PI_PLATFORM_INFO_EXTENSIONS, PI_PLATFORM_INFO_NAME, PI_PLATFORM_INFO_PROFILE, PI_PLATFORM_INFO_VENDOR, PI_PLATFORM_INFO_VERSION, ZE_SUPPORTED_EXTENSIONS, _pi_platform::ZeDriverApiVersion, and _pi_platform::ZeDriverVersion.

Referenced by sycl::_V1::detail::get_platform_info_string_impl(), and piPluginInit().

◆ piPlatformsGet()

pi_result piPlatformsGet	(	pi_uint32	num_entries,
		pi_platform *	platforms,
		pi_uint32 *	num_platforms
	)

Runtime queries number of Platforms

Definition at line 401 of file pi_esimd_emulator.cpp.

References _pi_platform::CmEmuVersion, _pi_platform::initialize(), PI_ASSERT, PiPlatformCache, PiPlatformCacheLock, PiPlatformCachePopulated, PiPlatformsCache, PiPlatformsCacheMutex, PiTrace(), PrintPiTrace, setEnvVar(), ZE_CALL, and ZE_CALL_NOCHECK.

Referenced by sycl::_V1::detail::platform_impl::get_platforms(), piextPlatformCreateWithNativeHandle(), and piPluginInit().

◆ piPluginGetLastError()

pi_result piPluginGetLastError ( char ** message )

API to get Plugin specific warning and error messages.

Parameters

message is a returned address to the first element in the message the plugin owns the error message string. The string is thread-local. As a result, different threads may return different errors. A message is overwritten by the following error or warning that is produced within the given thread. The memory is cleaned up at the end of the thread's lifetime.

Returns: PI_SUCCESS if plugin is indicating non-fatal warning. Any other error code indicates that plugin considers this to be a fatal error and the runtime must handle it or end the application.

Definition at line 165 of file pi_esimd_emulator.cpp.

References ErrorMessage, and ErrorMessageCode.

Referenced by piPluginInit().

◆ piPluginInit()

pi_result piPluginInit ( pi_plugin * plugin_info )

Definition at line 5323 of file pi_cuda.cpp.

Referenced by sycl::_V1::detail::pi::bindPlugin().

◆ piProgramBuild()

pi_result piProgramBuild	(	pi_program	program,
		pi_uint32	num_devices,
		const pi_device *	device_list,
		const char *	options,
		void()(pi_program program, void user_data)	pfn_notify,
		void *	user_data
	)

Referenced by sycl::_V1::detail::make_kernel_bundle(), and piPluginInit().

◆ piProgramCompile()

pi_result piProgramCompile	(	pi_program	program,
		pi_uint32	num_devices,
		const pi_device *	device_list,
		const char *	options,
		pi_uint32	num_input_headers,
		const pi_program *	input_headers,
		const char **	header_include_names,
		void()(pi_program program, void user_data)	pfn_notify,
		void *	user_data
	)

Referenced by sycl::_V1::detail::ProgramManager::compile(), sycl::_V1::detail::loadDeviceLibFallback(), sycl::_V1::detail::make_kernel_bundle(), and piPluginInit().

◆ piProgramCreate()

pi_result piProgramCreate	(	pi_context	context,
		const void *	il,
		size_t	length,
		pi_program *	res_program
	)

Definition at line 1281 of file pi_esimd_emulator.cpp.

References CHECK_ERR_SET_NULL_RET, _pi_queue::Context, DIE_NO_IMPLEMENTATION, _pi_program::IL, sycl::_V1::length(), and PI_ASSERT.

Referenced by sycl::_V1::detail::createSpirvProgram(), and piPluginInit().

◆ piProgramCreateWithBinary()

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
	)

Creates a PI program for a context and loads the given binary into it.

Parameters

context	is the PI context to associate the program with.
num_devices	is the number of devices in device_list.
device_list	is a pointer to a list of devices. These devices must all be in context.
lengths	is an array of sizes in bytes of the binary in binaries.
binaries	is a pointer to a list of program binaries.
num_metadata_entries	is the number of metadata entries in metadata.
metadata	is a pointer to a list of program metadata entries. The use of metadata entries is backend-defined.
binary_status	returns whether the program binary was loaded succesfully or not, for each device in device_list. binary_status is ignored if it is null and otherwise it must be an array of num_devices elements.
ret_program	is the PI program created from the program binaries.

Definition at line 1285 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, DIE_NO_IMPLEMENTATION, _pi_program::Native, and PI_ASSERT.

Referenced by sycl::_V1::detail::createBinaryProgram(), and piPluginInit().

◆ piProgramGetBuildInfo()

pi_result piProgramGetBuildInfo	(	pi_program	program,
		pi_device	device,
		_pi_program_build_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

◆ piProgramGetInfo()

pi_result piProgramGetInfo	(	pi_program	program,
		pi_program_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 1303 of file pi_esimd_emulator.cpp.

References _pi_program::Code, _pi_program::CodeLength, _pi_program::Context, _pi_context::Devices, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, _pi_program::Exe, _pi_program::IL, sycl::_V1::detail::memcpy(), _pi_program::Native, _pi_program::Object, PI_ASSERT, PI_PROGRAM_INFO_BINARIES, PI_PROGRAM_INFO_BINARY_SIZES, PI_PROGRAM_INFO_DEVICES, PI_PROGRAM_INFO_KERNEL_NAMES, PI_PROGRAM_INFO_NUM_DEVICES, PI_PROGRAM_INFO_NUM_KERNELS, PI_PROGRAM_INFO_REFERENCE_COUNT, _pi_program::State, ZE_CALL, and _pi_program::ZeModule.

Referenced by sycl::_V1::detail::program_impl::get_binaries(), sycl::_V1::detail::ProgramManager::getProgramBuildLog(), sycl::_V1::detail::make_kernel_bundle(), piextGetDeviceFunctionPointer(), piPluginInit(), and sycl::_V1::detail::PersistentDeviceCodeCache::putItemToDisc().

◆ piProgramLink()

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()(pi_program program, void user_data)	pfn_notify,
		void *	user_data,
		pi_program *	ret_program
	)

Definition at line 808 of file pi_opencl.cpp.

References cast().

Referenced by sycl::_V1::detail::program_impl::link(), sycl::_V1::detail::ProgramManager::link(), sycl::_V1::detail::make_kernel_bundle(), piPluginInit(), and sycl::_V1::detail::program_impl::program_impl().

◆ piProgramRelease()

pi_result piProgramRelease ( pi_program program )

Definition at line 1333 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::detail::program_impl::link(), piKernelRelease(), piPluginInit(), sycl::_V1::detail::context_impl::~context_impl(), sycl::_V1::detail::device_image_impl::~device_image_impl(), sycl::_V1::detail::KernelProgramCache::~KernelProgramCache(), and sycl::_V1::detail::program_impl::~program_impl().

◆ piProgramRetain()

pi_result piProgramRetain ( pi_program program )

Definition at line 1331 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by sycl::_V1::detail::ProgramManager::build(), sycl::_V1::detail::program_impl::build_with_kernel_name(), sycl::_V1::detail::program_impl::get(), sycl::_V1::detail::program_impl::getNative(), _pi_kernel::initialize(), and piPluginInit().

◆ piQueueCreate()

pi_result piQueueCreate	(	pi_context	context,
		pi_device	device,
		pi_queue_properties	properties,
		pi_queue *	queue
	)

Definition at line 924 of file pi_esimd_emulator.cpp.

References _pi_queue::_pi_queue(), ARG_UNUSED, CHECK_ERR_SET_NULL_RET, _pi_device::CmDevicePtr, _pi_queue::ComputeQueueGroup, _pi_queue::Context, _pi_queue::CopyQueueGroup, _pi_queue::createCommandList(), Device, _pi_context::Device, _pi_queue::Device, _pi_queue::pi_queue_group_t::getImmCmdList(), _pi_queue::getQueueGroup(), _pi_device::hasLinkCopyEngine(), _pi_device::hasMainCopyEngine(), _pi_context::isValidDevice(), _pi_queue::pi_queue_group_t::LowerIndex, PI_ASSERT, PI_CALL, PI_EXT_ONEAPI_QUEUE_DISCARD_EVENTS, PI_QUEUE_ON_DEVICE, PI_QUEUE_ON_DEVICE_DEFAULT, PI_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE, PI_QUEUE_PROFILING_ENABLE, _pi_queue::Properties, _pi_device::QueueGroup, _pi_queue::resetCommandList(), _pi_queue::pi_queue_group_t::UpperIndex, _pi_queue::useCopyEngine(), and _pi_device::useImmediateCommandLists().

Referenced by sycl::_V1::detail::queue_impl::createQueue(), and piPluginInit().

◆ piQueueFinish()

pi_result piQueueFinish ( pi_queue command_queue )

Definition at line 978 of file pi_esimd_emulator.cpp.

References _pi_queue::ComputeQueueGroup, CONTINUE_NO_IMPLEMENTATION, _pi_queue::CopyQueueGroup, _pi_queue::Device, _pi_queue::executeAllOpenCommandLists(), _pi_queue::LastCommandEvent, PI_ASSERT, resetCommandLists(), _pi_queue::synchronize(), _pi_device::useImmediateCommandLists(), ZE_CALL, and _pi_queue::pi_queue_group_t::ZeQueues.

Referenced by sycl::_V1::detail::queue_impl::getExclusiveQueueHandleRef(), piEnqueueMemBufferMap(), piEnqueueMemUnmap(), piPluginInit(), and sycl::_V1::detail::queue_impl::wait().

◆ piQueueFlush()

pi_result piQueueFlush ( pi_queue command_queue )

Definition at line 985 of file pi_esimd_emulator.cpp.

References CONTINUE_NO_IMPLEMENTATION.

Referenced by sycl::_V1::detail::event_impl::flushIfNeeded(), and piPluginInit().

◆ piQueueGetInfo()

pi_result piQueueGetInfo	(	pi_queue	command_queue,
		pi_queue_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 952 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_queue::Device, sycl::_V1::detail::pi::die(), DIE_NO_IMPLEMENTATION, PI_ASSERT, PI_QUEUE_INFO_CONTEXT, PI_QUEUE_INFO_DEVICE, PI_QUEUE_INFO_DEVICE_DEFAULT, PI_QUEUE_INFO_PROPERTIES, PI_QUEUE_INFO_REFERENCE_COUNT, and PI_QUEUE_INFO_SIZE.

Referenced by piPluginInit(), and sycl::_V1::detail::queue_impl::get_info< info::queue::reference_count >().

◆ piQueueRelease()

pi_result piQueueRelease ( pi_queue command_queue )

Definition at line 964 of file pi_esimd_emulator.cpp.

References CleanupCompletedEvent(), _pi_queue::CmQueuePtr, _pi_queue::CommandListMap, _pi_queue::executeAllOpenCommandLists(), _pi_queue::Healthy, PI_ASSERT, PI_CALL, piEventReleaseInternal(), piQueueReleaseInternal(), _pi_queue::RefCountExternal, _pi_queue::resetCommandList(), _pi_queue::synchronize(), and ZE_CALL.

Referenced by piPluginInit(), and sycl::_V1::detail::queue_impl::~queue_impl().

◆ piQueueRetain()

pi_result piQueueRetain ( pi_queue command_queue )

Definition at line 956 of file pi_esimd_emulator.cpp.

References _pi_queue::RefCountExternal.

Referenced by sycl::_V1::detail::queue_impl::get(), sycl::_V1::detail::queue_impl::getNative(), and piPluginInit().

◆ piSamplerCreate()

pi_result piSamplerCreate	(	pi_context	context,
		const pi_sampler_properties *	sampler_properties,
		pi_sampler *	result_sampler
	)

Definition at line 1463 of file pi_esimd_emulator.cpp.

References _pi_queue::Context, _pi_queue::Device, _pi_context::Devices, DIE_NO_IMPLEMENTATION, _pi_context::getPlatform(), PI_ASSERT, PI_FALSE, PI_SAMPLER_ADDRESSING_MODE_CLAMP, PI_SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE, PI_SAMPLER_ADDRESSING_MODE_MIRRORED_REPEAT, PI_SAMPLER_ADDRESSING_MODE_NONE, PI_SAMPLER_ADDRESSING_MODE_REPEAT, PI_SAMPLER_FILTER_MODE_LINEAR, PI_SAMPLER_FILTER_MODE_NEAREST, PI_SAMPLER_INFO_ADDRESSING_MODE, PI_SAMPLER_INFO_FILTER_MODE, PI_SAMPLER_INFO_NORMALIZED_COORDS, PI_SAMPLER_PROPERTIES_ADDRESSING_MODE, PI_SAMPLER_PROPERTIES_FILTER_MODE, PI_SAMPLER_PROPERTIES_NORMALIZED_COORDS, PI_TRUE, ZE_CALL, _pi_platform::ZeApiVersion, _pi_context::ZeContext, and _pi_device::ZeDevice.

Referenced by sycl::_V1::detail::sampler_impl::getOrCreateSampler(), and piPluginInit().

◆ piSamplerGetInfo()

pi_result piSamplerGetInfo	(	pi_sampler	sampler,
		pi_sampler_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)

Definition at line 1468 of file pi_esimd_emulator.cpp.

References sycl::_V1::detail::pi::die(), and DIE_NO_IMPLEMENTATION.

Referenced by piPluginInit(), and sycl::_V1::detail::sampler_impl::sampler_impl().

◆ piSamplerRelease()

pi_result piSamplerRelease ( pi_sampler sampler )

Definition at line 1475 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, PI_ASSERT, ZE_CALL, and _pi_sampler::ZeSampler.

Referenced by piPluginInit(), and sycl::_V1::detail::sampler_impl::~sampler_impl().

◆ piSamplerRetain()

pi_result piSamplerRetain ( pi_sampler sampler )

Definition at line 1473 of file pi_esimd_emulator.cpp.

References DIE_NO_IMPLEMENTATION, and PI_ASSERT.

Referenced by piPluginInit(), and sycl::_V1::detail::sampler_impl::sampler_impl().

◆ piTearDown()

pi_result piTearDown ( void * PluginParameter )

API to notify that the plugin should clean up its resources.

constexpr pi_device_affinity_domain PI_DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE = (1 << 5)

staticconstexpr

Definition at line 627 of file pi.h.

Referenced by piDeviceGetInfo(), piDevicePartition(), and sycl::_V1::detail::read_domain_bitfield().

◆ PI_DEVICE_AFFINITY_DOMAIN_NUMA

constexpr pi_device_affinity_domain PI_DEVICE_AFFINITY_DOMAIN_NUMA

staticconstexpr

Initial value:

=

(1 << 0)

Definition at line 616 of file pi.h.

Referenced by sycl::_V1::detail::get_device_info_impl< info::partition_affinity_domain, info::device::partition_type_affinity_domain >::get(), piDeviceGetInfo(), piDevicePartition(), and sycl::_V1::detail::read_domain_bitfield().

const uint16_t PI_DEVICE_BINARY_VERSION = 1

static

Definition at line 700 of file pi.h.

Referenced by sycl::_V1::detail::DynRTDeviceBinaryImage::DynRTDeviceBinaryImage().

◆ PI_DEVICE_EXEC_CAPABILITIES_KERNEL

constexpr pi_device_exec_capabilities PI_DEVICE_EXEC_CAPABILITIES_KERNEL

constexpr

Initial value:

=

(1 << 0)

constexpr pi_device_exec_capabilities PI_EXEC_NATIVE_KERNEL = (1 << 1)

staticconstexpr

Definition at line 644 of file pi.h.

Referenced by sycl::_V1::detail::read_execution_bitfield().

◆ PI_EXT_ONEAPI_QUEUE_DISCARD_EVENTS

constexpr pi_queue_properties PI_EXT_ONEAPI_QUEUE_DISCARD_EVENTS = (1 << 4)

constexpr

Definition at line 571 of file pi.h.

Referenced by sycl::_V1::detail::queue_impl::createQueue(), _pi_queue::isDiscardEvents(), and piQueueCreate().

◆ PI_FALSE

const pi_bool PI_FALSE = 0

Definition at line 466 of file pi.h.

Referenced by sycl::_V1::detail::copyD2H(), sycl::_V1::detail::copyH2D(), cuda_piContextCreate(), cuda_piDeviceGetInfo(), hip_piContextCreate(), sycl::_V1::detail::MemoryManager::map(), piDeviceGetInfo(), and piSamplerCreate().

◆ PI_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

constexpr pi_device_fp_config PI_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

staticconstexpr

Initial value:

constexpr pi_usm_mem_properties PI_MEM_ALLOC_INITIAL_PLACEMENT_DEVICE

constexpr

Initial value:

=

(1 << 1)

Definition at line 556 of file pi.h.

◆ PI_MEM_ALLOC_INITIAL_PLACEMENT_HOST

constexpr pi_usm_mem_properties PI_MEM_ALLOC_INITIAL_PLACEMENT_HOST = (1 << 2)

constexpr

Definition at line 558 of file pi.h.

constexpr pi_sampler_properties PI_SAMPLER_PROPERTIES_NORMALIZED_COORDS

constexpr

Initial value:

=

0x1152

Definition at line 501 of file pi.h.

Referenced by cuda_piSamplerCreate(), hip_piSamplerCreate(), and piSamplerCreate().

◆ PI_TRUE

const pi_bool PI_TRUE = 1

Definition at line 465 of file pi.h.

Referenced by cuda_piContextCreate(), cuda_piDeviceGetInfo(), cuda_piSamplerCreate(), sycl::_V1::detail::ProgramManager::getBuiltPIProgram(), sycl::_V1::detail::ProgramManager::getOrCreateKernel(), hip_piContextCreate(), hip_piDeviceGetInfo(), hip_piSamplerCreate(), sycl::_V1::detail::kernel_impl::kernel_impl(), piKernelSetExecInfo(), and piSamplerCreate().

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ __SYCL_PI_DEVICE_BINARY_TARGET_AMDGCN

◆ __SYCL_PI_DEVICE_BINARY_TARGET_NVPTX64

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV32

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_FPGA

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_GEN

◆ __SYCL_PI_DEVICE_BINARY_TARGET_SPIRV64_X86_64

◆ __SYCL_PI_DEVICE_BINARY_TARGET_UNKNOWN

◆ __SYCL_PI_PROGRAM_METADATA_TAG_REQD_WORK_GROUP_SIZE

◆ __SYCL_PI_PROPERTY_SET_DEVICELIB_REQ_MASK

◆ __SYCL_PI_PROPERTY_SET_KERNEL_PARAM_OPT_INFO

◆ __SYCL_PI_PROPERTY_SET_PROGRAM_METADATA

◆ __SYCL_PI_PROPERTY_SET_SPEC_CONST_DEFAULT_VALUES_MAP

◆ __SYCL_PI_PROPERTY_SET_SPEC_CONST_MAP

◆ __SYCL_PI_PROPERTY_SET_SYCL_ASSERT_USED

◆ __SYCL_PI_PROPERTY_SET_SYCL_DEVICE_GLOBALS

◆ __SYCL_PI_PROPERTY_SET_SYCL_EXPORTED_SYMBOLS

◆ __SYCL_PI_PROPERTY_SET_SYCL_MISC_PROP

◆ _PI_API

◆ _PI_CONCAT

◆ _PI_ERRC

◆ _PI_ERRC_WITH_MSG

◆ _PI_H_VERSION_MAJOR

◆ _PI_H_VERSION_MINOR

◆ _PI_H_VERSION_STRING

◆ _PI_PLUGIN_VERSION_CHECK

◆ _PI_PLUGIN_VERSION_STRING

◆ _PI_STRING_HELPER

◆ _PI_STRING_SUBSTITUTE

◆ _PI_TRIPLE_CONCAT

◆ PI_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT

Typedef Documentation

◆ _pi_offload_entry

◆ pi_bitfield

◆ pi_bool

◆ pi_buff_rect_offset

◆ pi_buff_rect_region

◆ pi_buffer_create_type

◆ pi_buffer_region

◆ pi_command_type

◆ pi_context

◆ pi_context_extended_deleter

◆ pi_context_info

◆ pi_context_properties

◆ pi_device

◆ pi_device_affinity_domain

◆ pi_device_binaries

◆ pi_device_binary

◆ pi_device_binary_property

◆ pi_device_binary_property_set

◆ pi_device_binary_type

◆ pi_device_exec_capabilities

◆ pi_device_fp_config

◆ pi_device_info

◆ pi_device_local_mem_type

◆ pi_device_mem_cache_type

◆ pi_device_partition_property

◆ pi_device_type

◆ pi_event

◆ pi_event_info

◆ pi_event_status

◆ pi_image_channel_order

◆ pi_image_channel_type

◆ pi_image_desc

◆ pi_image_format

◆ pi_image_info

◆ pi_image_offset

◆ pi_image_region

◆ pi_int32

◆ pi_kernel

◆ pi_kernel_exec_info

◆ pi_kernel_group_info

◆ pi_kernel_info