Core API
Contents
Core API#
oneAPI Unified Runtime Specification - Version 0.12
Registry#
Enumerations
Registry Enums#
ur_function_t#
-
enum ur_function_t#
Defines unique stable identifiers for all functions.
Values:
-
enumerator UR_FUNCTION_CONTEXT_CREATE#
Enumerator for urContextCreate.
-
enumerator UR_FUNCTION_CONTEXT_RETAIN#
Enumerator for urContextRetain.
-
enumerator UR_FUNCTION_CONTEXT_RELEASE#
Enumerator for urContextRelease.
-
enumerator UR_FUNCTION_CONTEXT_GET_INFO#
Enumerator for urContextGetInfo.
-
enumerator UR_FUNCTION_CONTEXT_GET_NATIVE_HANDLE#
Enumerator for urContextGetNativeHandle.
-
enumerator UR_FUNCTION_CONTEXT_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urContextCreateWithNativeHandle.
-
enumerator UR_FUNCTION_CONTEXT_SET_EXTENDED_DELETER#
Enumerator for urContextSetExtendedDeleter.
-
enumerator UR_FUNCTION_DEVICE_GET#
Enumerator for urDeviceGet.
-
enumerator UR_FUNCTION_DEVICE_GET_INFO#
Enumerator for urDeviceGetInfo.
-
enumerator UR_FUNCTION_DEVICE_RETAIN#
Enumerator for urDeviceRetain.
-
enumerator UR_FUNCTION_DEVICE_RELEASE#
Enumerator for urDeviceRelease.
-
enumerator UR_FUNCTION_DEVICE_PARTITION#
Enumerator for urDevicePartition.
-
enumerator UR_FUNCTION_DEVICE_SELECT_BINARY#
Enumerator for urDeviceSelectBinary.
-
enumerator UR_FUNCTION_DEVICE_GET_NATIVE_HANDLE#
Enumerator for urDeviceGetNativeHandle.
-
enumerator UR_FUNCTION_DEVICE_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urDeviceCreateWithNativeHandle.
-
enumerator UR_FUNCTION_DEVICE_GET_GLOBAL_TIMESTAMPS#
Enumerator for urDeviceGetGlobalTimestamps.
-
enumerator UR_FUNCTION_ENQUEUE_KERNEL_LAUNCH#
Enumerator for urEnqueueKernelLaunch.
-
enumerator UR_FUNCTION_ENQUEUE_EVENTS_WAIT#
Enumerator for urEnqueueEventsWait.
-
enumerator UR_FUNCTION_ENQUEUE_EVENTS_WAIT_WITH_BARRIER#
Enumerator for urEnqueueEventsWaitWithBarrier.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_READ#
Enumerator for urEnqueueMemBufferRead.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_WRITE#
Enumerator for urEnqueueMemBufferWrite.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_READ_RECT#
Enumerator for urEnqueueMemBufferReadRect.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_WRITE_RECT#
Enumerator for urEnqueueMemBufferWriteRect.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_COPY#
Enumerator for urEnqueueMemBufferCopy.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_COPY_RECT#
Enumerator for urEnqueueMemBufferCopyRect.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_FILL#
Enumerator for urEnqueueMemBufferFill.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_IMAGE_READ#
Enumerator for urEnqueueMemImageRead.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_IMAGE_WRITE#
Enumerator for urEnqueueMemImageWrite.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_IMAGE_COPY#
Enumerator for urEnqueueMemImageCopy.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_BUFFER_MAP#
Enumerator for urEnqueueMemBufferMap.
-
enumerator UR_FUNCTION_ENQUEUE_MEM_UNMAP#
Enumerator for urEnqueueMemUnmap.
-
enumerator UR_FUNCTION_ENQUEUE_USM_FILL#
Enumerator for urEnqueueUSMFill.
-
enumerator UR_FUNCTION_ENQUEUE_USM_MEMCPY#
Enumerator for urEnqueueUSMMemcpy.
-
enumerator UR_FUNCTION_ENQUEUE_USM_PREFETCH#
Enumerator for urEnqueueUSMPrefetch.
-
enumerator UR_FUNCTION_ENQUEUE_USM_ADVISE#
Enumerator for urEnqueueUSMAdvise.
-
enumerator UR_FUNCTION_ENQUEUE_DEVICE_GLOBAL_VARIABLE_WRITE#
Enumerator for urEnqueueDeviceGlobalVariableWrite.
-
enumerator UR_FUNCTION_ENQUEUE_DEVICE_GLOBAL_VARIABLE_READ#
Enumerator for urEnqueueDeviceGlobalVariableRead.
-
enumerator UR_FUNCTION_EVENT_GET_INFO#
Enumerator for urEventGetInfo.
-
enumerator UR_FUNCTION_EVENT_GET_PROFILING_INFO#
Enumerator for urEventGetProfilingInfo.
-
enumerator UR_FUNCTION_EVENT_WAIT#
Enumerator for urEventWait.
-
enumerator UR_FUNCTION_EVENT_RETAIN#
Enumerator for urEventRetain.
-
enumerator UR_FUNCTION_EVENT_RELEASE#
Enumerator for urEventRelease.
-
enumerator UR_FUNCTION_EVENT_GET_NATIVE_HANDLE#
Enumerator for urEventGetNativeHandle.
-
enumerator UR_FUNCTION_EVENT_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urEventCreateWithNativeHandle.
-
enumerator UR_FUNCTION_EVENT_SET_CALLBACK#
Enumerator for urEventSetCallback.
-
enumerator UR_FUNCTION_KERNEL_CREATE#
Enumerator for urKernelCreate.
-
enumerator UR_FUNCTION_KERNEL_SET_ARG_VALUE#
Enumerator for urKernelSetArgValue.
-
enumerator UR_FUNCTION_KERNEL_SET_ARG_LOCAL#
Enumerator for urKernelSetArgLocal.
-
enumerator UR_FUNCTION_KERNEL_GET_INFO#
Enumerator for urKernelGetInfo.
-
enumerator UR_FUNCTION_KERNEL_GET_GROUP_INFO#
Enumerator for urKernelGetGroupInfo.
-
enumerator UR_FUNCTION_KERNEL_GET_SUB_GROUP_INFO#
Enumerator for urKernelGetSubGroupInfo.
-
enumerator UR_FUNCTION_KERNEL_RETAIN#
Enumerator for urKernelRetain.
-
enumerator UR_FUNCTION_KERNEL_RELEASE#
Enumerator for urKernelRelease.
-
enumerator UR_FUNCTION_KERNEL_SET_ARG_POINTER#
Enumerator for urKernelSetArgPointer.
-
enumerator UR_FUNCTION_KERNEL_SET_EXEC_INFO#
Enumerator for urKernelSetExecInfo.
-
enumerator UR_FUNCTION_KERNEL_SET_ARG_SAMPLER#
Enumerator for urKernelSetArgSampler.
-
enumerator UR_FUNCTION_KERNEL_SET_ARG_MEM_OBJ#
Enumerator for urKernelSetArgMemObj.
-
enumerator UR_FUNCTION_KERNEL_SET_SPECIALIZATION_CONSTANTS#
Enumerator for urKernelSetSpecializationConstants.
-
enumerator UR_FUNCTION_KERNEL_GET_NATIVE_HANDLE#
Enumerator for urKernelGetNativeHandle.
-
enumerator UR_FUNCTION_KERNEL_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urKernelCreateWithNativeHandle.
-
enumerator UR_FUNCTION_MEM_IMAGE_CREATE#
Enumerator for urMemImageCreate.
-
enumerator UR_FUNCTION_MEM_BUFFER_CREATE#
Enumerator for urMemBufferCreate.
-
enumerator UR_FUNCTION_MEM_RETAIN#
Enumerator for urMemRetain.
-
enumerator UR_FUNCTION_MEM_RELEASE#
Enumerator for urMemRelease.
-
enumerator UR_FUNCTION_MEM_BUFFER_PARTITION#
Enumerator for urMemBufferPartition.
-
enumerator UR_FUNCTION_MEM_GET_NATIVE_HANDLE#
Enumerator for urMemGetNativeHandle.
-
enumerator UR_FUNCTION_ENQUEUE_READ_HOST_PIPE#
Enumerator for urEnqueueReadHostPipe.
-
enumerator UR_FUNCTION_MEM_GET_INFO#
Enumerator for urMemGetInfo.
-
enumerator UR_FUNCTION_MEM_IMAGE_GET_INFO#
Enumerator for urMemImageGetInfo.
-
enumerator UR_FUNCTION_PLATFORM_GET#
Enumerator for urPlatformGet.
-
enumerator UR_FUNCTION_PLATFORM_GET_INFO#
Enumerator for urPlatformGetInfo.
-
enumerator UR_FUNCTION_PLATFORM_GET_API_VERSION#
Enumerator for urPlatformGetApiVersion.
-
enumerator UR_FUNCTION_PLATFORM_GET_NATIVE_HANDLE#
Enumerator for urPlatformGetNativeHandle.
-
enumerator UR_FUNCTION_PLATFORM_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urPlatformCreateWithNativeHandle.
-
enumerator UR_FUNCTION_PROGRAM_CREATE_WITH_IL#
Enumerator for urProgramCreateWithIL.
-
enumerator UR_FUNCTION_PROGRAM_CREATE_WITH_BINARY#
Enumerator for urProgramCreateWithBinary.
-
enumerator UR_FUNCTION_PROGRAM_BUILD#
Enumerator for urProgramBuild.
-
enumerator UR_FUNCTION_PROGRAM_COMPILE#
Enumerator for urProgramCompile.
-
enumerator UR_FUNCTION_PROGRAM_LINK#
Enumerator for urProgramLink.
-
enumerator UR_FUNCTION_PROGRAM_RETAIN#
Enumerator for urProgramRetain.
-
enumerator UR_FUNCTION_PROGRAM_RELEASE#
Enumerator for urProgramRelease.
-
enumerator UR_FUNCTION_PROGRAM_GET_FUNCTION_POINTER#
Enumerator for urProgramGetFunctionPointer.
-
enumerator UR_FUNCTION_PROGRAM_GET_INFO#
Enumerator for urProgramGetInfo.
-
enumerator UR_FUNCTION_PROGRAM_GET_BUILD_INFO#
Enumerator for urProgramGetBuildInfo.
-
enumerator UR_FUNCTION_PROGRAM_SET_SPECIALIZATION_CONSTANTS#
Enumerator for urProgramSetSpecializationConstants.
-
enumerator UR_FUNCTION_PROGRAM_GET_NATIVE_HANDLE#
Enumerator for urProgramGetNativeHandle.
-
enumerator UR_FUNCTION_PROGRAM_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urProgramCreateWithNativeHandle.
-
enumerator UR_FUNCTION_QUEUE_GET_INFO#
Enumerator for urQueueGetInfo.
-
enumerator UR_FUNCTION_QUEUE_CREATE#
Enumerator for urQueueCreate.
-
enumerator UR_FUNCTION_QUEUE_RETAIN#
Enumerator for urQueueRetain.
-
enumerator UR_FUNCTION_QUEUE_RELEASE#
Enumerator for urQueueRelease.
-
enumerator UR_FUNCTION_QUEUE_GET_NATIVE_HANDLE#
Enumerator for urQueueGetNativeHandle.
-
enumerator UR_FUNCTION_QUEUE_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urQueueCreateWithNativeHandle.
-
enumerator UR_FUNCTION_QUEUE_FINISH#
Enumerator for urQueueFinish.
-
enumerator UR_FUNCTION_QUEUE_FLUSH#
Enumerator for urQueueFlush.
-
enumerator UR_FUNCTION_SAMPLER_CREATE#
Enumerator for urSamplerCreate.
-
enumerator UR_FUNCTION_SAMPLER_RETAIN#
Enumerator for urSamplerRetain.
-
enumerator UR_FUNCTION_SAMPLER_RELEASE#
Enumerator for urSamplerRelease.
-
enumerator UR_FUNCTION_SAMPLER_GET_INFO#
Enumerator for urSamplerGetInfo.
-
enumerator UR_FUNCTION_SAMPLER_GET_NATIVE_HANDLE#
Enumerator for urSamplerGetNativeHandle.
-
enumerator UR_FUNCTION_SAMPLER_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urSamplerCreateWithNativeHandle.
-
enumerator UR_FUNCTION_USM_HOST_ALLOC#
Enumerator for urUSMHostAlloc.
-
enumerator UR_FUNCTION_USM_DEVICE_ALLOC#
Enumerator for urUSMDeviceAlloc.
-
enumerator UR_FUNCTION_USM_SHARED_ALLOC#
Enumerator for urUSMSharedAlloc.
-
enumerator UR_FUNCTION_USM_GET_MEM_ALLOC_INFO#
Enumerator for urUSMGetMemAllocInfo.
-
enumerator UR_FUNCTION_USM_POOL_CREATE#
Enumerator for urUSMPoolCreate.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_CREATE_EXP#
Enumerator for urCommandBufferCreateExp.
-
enumerator UR_FUNCTION_PLATFORM_GET_BACKEND_OPTION#
Enumerator for urPlatformGetBackendOption.
-
enumerator UR_FUNCTION_MEM_BUFFER_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urMemBufferCreateWithNativeHandle.
-
enumerator UR_FUNCTION_MEM_IMAGE_CREATE_WITH_NATIVE_HANDLE#
Enumerator for urMemImageCreateWithNativeHandle.
-
enumerator UR_FUNCTION_ENQUEUE_WRITE_HOST_PIPE#
Enumerator for urEnqueueWriteHostPipe.
-
enumerator UR_FUNCTION_USM_POOL_RETAIN#
Enumerator for urUSMPoolRetain.
-
enumerator UR_FUNCTION_USM_POOL_RELEASE#
Enumerator for urUSMPoolRelease.
-
enumerator UR_FUNCTION_USM_POOL_GET_INFO#
Enumerator for urUSMPoolGetInfo.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_RETAIN_EXP#
Enumerator for urCommandBufferRetainExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_RELEASE_EXP#
Enumerator for urCommandBufferReleaseExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_FINALIZE_EXP#
Enumerator for urCommandBufferFinalizeExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_KERNEL_LAUNCH_EXP#
Enumerator for urCommandBufferAppendKernelLaunchExp.
-
enumerator UR_FUNCTION_USM_PITCHED_ALLOC_EXP#
Enumerator for urUSMPitchedAllocExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_UNSAMPLED_IMAGE_HANDLE_DESTROY_EXP#
Enumerator for urBindlessImagesUnsampledImageHandleDestroyExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_SAMPLED_IMAGE_HANDLE_DESTROY_EXP#
Enumerator for urBindlessImagesSampledImageHandleDestroyExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMAGE_ALLOCATE_EXP#
Enumerator for urBindlessImagesImageAllocateExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMAGE_FREE_EXP#
Enumerator for urBindlessImagesImageFreeExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_UNSAMPLED_IMAGE_CREATE_EXP#
Enumerator for urBindlessImagesUnsampledImageCreateExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_SAMPLED_IMAGE_CREATE_EXP#
Enumerator for urBindlessImagesSampledImageCreateExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMAGE_COPY_EXP#
Enumerator for urBindlessImagesImageCopyExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMAGE_GET_INFO_EXP#
Enumerator for urBindlessImagesImageGetInfoExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_MIPMAP_GET_LEVEL_EXP#
Enumerator for urBindlessImagesMipmapGetLevelExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_MIPMAP_FREE_EXP#
Enumerator for urBindlessImagesMipmapFreeExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_MAP_EXTERNAL_ARRAY_EXP#
Enumerator for urBindlessImagesMapExternalArrayExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_RELEASE_EXTERNAL_SEMAPHORE_EXP#
Enumerator for urBindlessImagesReleaseExternalSemaphoreExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_WAIT_EXTERNAL_SEMAPHORE_EXP#
Enumerator for urBindlessImagesWaitExternalSemaphoreExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_SIGNAL_EXTERNAL_SEMAPHORE_EXP#
Enumerator for urBindlessImagesSignalExternalSemaphoreExp.
-
enumerator UR_FUNCTION_ENQUEUE_USM_FILL_2D#
Enumerator for urEnqueueUSMFill2D.
-
enumerator UR_FUNCTION_ENQUEUE_USM_MEMCPY_2D#
Enumerator for urEnqueueUSMMemcpy2D.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_GRANULARITY_GET_INFO#
Enumerator for urVirtualMemGranularityGetInfo.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_RESERVE#
Enumerator for urVirtualMemReserve.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_FREE#
Enumerator for urVirtualMemFree.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_MAP#
Enumerator for urVirtualMemMap.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_UNMAP#
Enumerator for urVirtualMemUnmap.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_SET_ACCESS#
Enumerator for urVirtualMemSetAccess.
-
enumerator UR_FUNCTION_VIRTUAL_MEM_GET_INFO#
Enumerator for urVirtualMemGetInfo.
-
enumerator UR_FUNCTION_PHYSICAL_MEM_CREATE#
Enumerator for urPhysicalMemCreate.
-
enumerator UR_FUNCTION_PHYSICAL_MEM_RETAIN#
Enumerator for urPhysicalMemRetain.
-
enumerator UR_FUNCTION_PHYSICAL_MEM_RELEASE#
Enumerator for urPhysicalMemRelease.
-
enumerator UR_FUNCTION_USM_IMPORT_EXP#
Enumerator for urUSMImportExp.
-
enumerator UR_FUNCTION_USM_RELEASE_EXP#
Enumerator for urUSMReleaseExp.
-
enumerator UR_FUNCTION_USM_P2P_ENABLE_PEER_ACCESS_EXP#
Enumerator for urUsmP2PEnablePeerAccessExp.
-
enumerator UR_FUNCTION_USM_P2P_DISABLE_PEER_ACCESS_EXP#
Enumerator for urUsmP2PDisablePeerAccessExp.
-
enumerator UR_FUNCTION_USM_P2P_PEER_ACCESS_GET_INFO_EXP#
Enumerator for urUsmP2PPeerAccessGetInfoExp.
-
enumerator UR_FUNCTION_LOADER_CONFIG_CREATE#
Enumerator for urLoaderConfigCreate.
-
enumerator UR_FUNCTION_LOADER_CONFIG_RELEASE#
Enumerator for urLoaderConfigRelease.
-
enumerator UR_FUNCTION_LOADER_CONFIG_RETAIN#
Enumerator for urLoaderConfigRetain.
-
enumerator UR_FUNCTION_LOADER_CONFIG_GET_INFO#
Enumerator for urLoaderConfigGetInfo.
-
enumerator UR_FUNCTION_LOADER_CONFIG_ENABLE_LAYER#
Enumerator for urLoaderConfigEnableLayer.
-
enumerator UR_FUNCTION_ADAPTER_RELEASE#
Enumerator for urAdapterRelease.
-
enumerator UR_FUNCTION_ADAPTER_GET#
Enumerator for urAdapterGet.
-
enumerator UR_FUNCTION_ADAPTER_RETAIN#
Enumerator for urAdapterRetain.
-
enumerator UR_FUNCTION_ADAPTER_GET_LAST_ERROR#
Enumerator for urAdapterGetLastError.
-
enumerator UR_FUNCTION_ADAPTER_GET_INFO#
Enumerator for urAdapterGetInfo.
-
enumerator UR_FUNCTION_PROGRAM_BUILD_EXP#
Enumerator for urProgramBuildExp.
-
enumerator UR_FUNCTION_PROGRAM_COMPILE_EXP#
Enumerator for urProgramCompileExp.
-
enumerator UR_FUNCTION_PROGRAM_LINK_EXP#
Enumerator for urProgramLinkExp.
-
enumerator UR_FUNCTION_LOADER_CONFIG_SET_CODE_LOCATION_CALLBACK#
Enumerator for urLoaderConfigSetCodeLocationCallback.
-
enumerator UR_FUNCTION_LOADER_INIT#
Enumerator for urLoaderInit.
-
enumerator UR_FUNCTION_LOADER_TEAR_DOWN#
Enumerator for urLoaderTearDown.
-
enumerator UR_FUNCTION_ENQUEUE_COOPERATIVE_KERNEL_LAUNCH_EXP#
Enumerator for urEnqueueCooperativeKernelLaunchExp.
-
enumerator UR_FUNCTION_KERNEL_SUGGEST_MAX_COOPERATIVE_GROUP_COUNT_EXP#
Enumerator for urKernelSuggestMaxCooperativeGroupCountExp.
-
enumerator UR_FUNCTION_PROGRAM_GET_GLOBAL_VARIABLE_POINTER#
Enumerator for urProgramGetGlobalVariablePointer.
-
enumerator UR_FUNCTION_DEVICE_GET_SELECTED#
Enumerator for urDeviceGetSelected.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_RETAIN_COMMAND_EXP#
Enumerator for urCommandBufferRetainCommandExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_RELEASE_COMMAND_EXP#
Enumerator for urCommandBufferReleaseCommandExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_UPDATE_KERNEL_LAUNCH_EXP#
Enumerator for urCommandBufferUpdateKernelLaunchExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_GET_INFO_EXP#
Enumerator for urCommandBufferGetInfoExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_COMMAND_GET_INFO_EXP#
Enumerator for urCommandBufferCommandGetInfoExp.
-
enumerator UR_FUNCTION_ENQUEUE_TIMESTAMP_RECORDING_EXP#
Enumerator for urEnqueueTimestampRecordingExp.
-
enumerator UR_FUNCTION_ENQUEUE_KERNEL_LAUNCH_CUSTOM_EXP#
Enumerator for urEnqueueKernelLaunchCustomExp.
-
enumerator UR_FUNCTION_KERNEL_GET_SUGGESTED_LOCAL_WORK_SIZE#
Enumerator for urKernelGetSuggestedLocalWorkSize.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_MEMORY_EXP#
Enumerator for urBindlessImagesImportExternalMemoryExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_SEMAPHORE_EXP#
Enumerator for urBindlessImagesImportExternalSemaphoreExp.
-
enumerator UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP#
Enumerator for urEnqueueNativeCommandExp.
-
enumerator UR_FUNCTION_LOADER_CONFIG_SET_MOCKING_ENABLED#
Enumerator for urLoaderConfigSetMockingEnabled.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_RELEASE_EXTERNAL_MEMORY_EXP#
Enumerator for urBindlessImagesReleaseExternalMemoryExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_USM_MEMCPY_EXP#
Enumerator for urCommandBufferAppendUSMMemcpyExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_USM_FILL_EXP#
Enumerator for urCommandBufferAppendUSMFillExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_COPY_EXP#
Enumerator for urCommandBufferAppendMemBufferCopyExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_WRITE_EXP#
Enumerator for urCommandBufferAppendMemBufferWriteExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_READ_EXP#
Enumerator for urCommandBufferAppendMemBufferReadExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_COPY_RECT_EXP#
Enumerator for urCommandBufferAppendMemBufferCopyRectExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_WRITE_RECT_EXP#
Enumerator for urCommandBufferAppendMemBufferWriteRectExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_READ_RECT_EXP#
Enumerator for urCommandBufferAppendMemBufferReadRectExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_MEM_BUFFER_FILL_EXP#
Enumerator for urCommandBufferAppendMemBufferFillExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_USM_PREFETCH_EXP#
Enumerator for urCommandBufferAppendUSMPrefetchExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_APPEND_USM_ADVISE_EXP#
Enumerator for urCommandBufferAppendUSMAdviseExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_ENQUEUE_EXP#
Enumerator for urCommandBufferEnqueueExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_UPDATE_SIGNAL_EVENT_EXP#
Enumerator for urCommandBufferUpdateSignalEventExp.
-
enumerator UR_FUNCTION_COMMAND_BUFFER_UPDATE_WAIT_EVENTS_EXP#
Enumerator for urCommandBufferUpdateWaitEventsExp.
-
enumerator UR_FUNCTION_BINDLESS_IMAGES_MAP_EXTERNAL_LINEAR_MEMORY_EXP#
Enumerator for urBindlessImagesMapExternalLinearMemoryExp.
-
enumerator UR_FUNCTION_ENQUEUE_EVENTS_WAIT_WITH_BARRIER_EXT#
Enumerator for urEnqueueEventsWaitWithBarrierExt.
-
enumerator UR_FUNCTION_TENSOR_MAP_ENCODE_IM_2_COL_EXP#
Enumerator for urTensorMapEncodeIm2ColExp.
-
enumerator UR_FUNCTION_TENSOR_MAP_ENCODE_TILED_EXP#
Enumerator for urTensorMapEncodeTiledExp.
-
enumerator UR_FUNCTION_PHYSICAL_MEM_GET_INFO#
Enumerator for urPhysicalMemGetInfo
-
enumerator UR_FUNCTION_CONTEXT_CREATE#
ur_structure_type_t#
-
enum ur_structure_type_t#
Defines structure types.
Values:
-
enumerator UR_STRUCTURE_TYPE_CONTEXT_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_IMAGE_DESC#
-
enumerator UR_STRUCTURE_TYPE_BUFFER_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_BUFFER_REGION#
-
enumerator UR_STRUCTURE_TYPE_BUFFER_CHANNEL_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_BUFFER_ALLOC_LOCATION_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_PROGRAM_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_USM_DESC#
-
enumerator UR_STRUCTURE_TYPE_USM_HOST_DESC#
-
enumerator UR_STRUCTURE_TYPE_USM_DEVICE_DESC#
-
enumerator UR_STRUCTURE_TYPE_USM_POOL_DESC#
-
enumerator UR_STRUCTURE_TYPE_USM_POOL_LIMITS_DESC#
-
enumerator UR_STRUCTURE_TYPE_DEVICE_BINARY#
-
enumerator UR_STRUCTURE_TYPE_SAMPLER_DESC#
-
enumerator UR_STRUCTURE_TYPE_QUEUE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_QUEUE_INDEX_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_CONTEXT_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_QUEUE_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_MEM_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_EVENT_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_PLATFORM_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_DEVICE_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_PROGRAM_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_SAMPLER_NATIVE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_QUEUE_NATIVE_DESC#
-
enumerator UR_STRUCTURE_TYPE_DEVICE_PARTITION_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_ARG_MEM_OBJ_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_PHYSICAL_MEM_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_ARG_POINTER_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_ARG_SAMPLER_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_EXEC_INFO_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_ARG_VALUE_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_KERNEL_ARG_LOCAL_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_USM_ALLOC_LOCATION_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_KERNEL_LAUNCH_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_MEMOBJ_ARG_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_POINTER_ARG_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_VALUE_ARG_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_SAMPLER_MIP_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_EXP_EXTERNAL_MEM_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_EXTERNAL_SEMAPHORE_DESC#
-
enumerator UR_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR#
-
enumerator UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE#
-
enumerator UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES#
-
enumerator UR_STRUCTURE_TYPE_EXP_SAMPLER_CUBEMAP_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_EXP_IMAGE_COPY_REGION#
-
enumerator UR_STRUCTURE_TYPE_EXP_ENQUEUE_NATIVE_COMMAND_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_EXP_ENQUEUE_EXT_PROPERTIES#
-
enumerator UR_STRUCTURE_TYPE_CONTEXT_PROPERTIES#
Common#
Enumerations
Structures
Macros
Typedefs
Common Enums#
ur_result_t#
-
enum ur_result_t#
Defines Return/Error codes.
Values:
-
enumerator UR_RESULT_SUCCESS#
Success.
-
enumerator UR_RESULT_ERROR_INVALID_OPERATION#
Invalid operation.
-
enumerator UR_RESULT_ERROR_INVALID_QUEUE_PROPERTIES#
Invalid queue properties.
-
enumerator UR_RESULT_ERROR_INVALID_QUEUE#
Invalid queue.
-
enumerator UR_RESULT_ERROR_INVALID_VALUE#
Invalid Value.
-
enumerator UR_RESULT_ERROR_INVALID_CONTEXT#
Invalid context.
-
enumerator UR_RESULT_ERROR_INVALID_PLATFORM#
Invalid platform.
-
enumerator UR_RESULT_ERROR_INVALID_BINARY#
Invalid binary.
-
enumerator UR_RESULT_ERROR_INVALID_PROGRAM#
Invalid program.
-
enumerator UR_RESULT_ERROR_INVALID_SAMPLER#
Invalid sampler.
-
enumerator UR_RESULT_ERROR_INVALID_BUFFER_SIZE#
Invalid buffer size.
-
enumerator UR_RESULT_ERROR_INVALID_MEM_OBJECT#
Invalid memory object.
-
enumerator UR_RESULT_ERROR_INVALID_EVENT#
Invalid event.
-
enumerator UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST#
Returned when the event wait list or the events in the wait list are invalid.
-
enumerator UR_RESULT_ERROR_MISALIGNED_SUB_BUFFER_OFFSET#
Misaligned sub buffer offset.
-
enumerator UR_RESULT_ERROR_INVALID_WORK_GROUP_SIZE#
Invalid work group size.
-
enumerator UR_RESULT_ERROR_COMPILER_NOT_AVAILABLE#
Compiler not available.
-
enumerator UR_RESULT_ERROR_PROFILING_INFO_NOT_AVAILABLE#
Profiling info not available.
-
enumerator UR_RESULT_ERROR_DEVICE_NOT_FOUND#
Device not found.
-
enumerator UR_RESULT_ERROR_INVALID_DEVICE#
Invalid device.
-
enumerator UR_RESULT_ERROR_DEVICE_LOST#
Device hung, reset, was removed, or adapter update occurred.
-
enumerator UR_RESULT_ERROR_DEVICE_REQUIRES_RESET#
Device requires a reset.
-
enumerator UR_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE#
Device currently in low power state.
-
enumerator UR_RESULT_ERROR_DEVICE_PARTITION_FAILED#
Device partitioning failed.
-
enumerator UR_RESULT_ERROR_INVALID_DEVICE_PARTITION_COUNT#
Invalid counts provided with UR_DEVICE_PARTITION_BY_COUNTS.
-
enumerator UR_RESULT_ERROR_INVALID_WORK_ITEM_SIZE#
Invalid work item size.
-
enumerator UR_RESULT_ERROR_INVALID_WORK_DIMENSION#
Invalid work dimension.
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL_ARGS#
Invalid kernel args.
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL#
Invalid kernel.
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL_NAME#
[Validation] kernel name is not found in the program
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL_ARGUMENT_INDEX#
[Validation] kernel argument index is not valid for kernel
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL_ARGUMENT_SIZE#
[Validation] kernel argument size does not match kernel
-
enumerator UR_RESULT_ERROR_INVALID_KERNEL_ATTRIBUTE_VALUE#
[Validation] value of kernel attribute is not valid for the kernel or device
-
enumerator UR_RESULT_ERROR_INVALID_IMAGE_SIZE#
Invalid image size.
-
enumerator UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR#
Invalid image format descriptor.
-
enumerator UR_RESULT_ERROR_MEM_OBJECT_ALLOCATION_FAILURE#
Memory object allocation failure.
-
enumerator UR_RESULT_ERROR_INVALID_PROGRAM_EXECUTABLE#
Program object parameter is invalid.
-
enumerator UR_RESULT_ERROR_UNINITIALIZED#
[Validation] adapter is not initialized or specific entry-point is not implemented
-
enumerator UR_RESULT_ERROR_OUT_OF_HOST_MEMORY#
Insufficient host memory to satisfy call.
-
enumerator UR_RESULT_ERROR_OUT_OF_DEVICE_MEMORY#
Insufficient device memory to satisfy call.
-
enumerator UR_RESULT_ERROR_OUT_OF_RESOURCES#
Out of resources.
-
enumerator UR_RESULT_ERROR_PROGRAM_BUILD_FAILURE#
Error occurred when building program, see build log for details.
-
enumerator UR_RESULT_ERROR_PROGRAM_LINK_FAILURE#
Error occurred when linking programs, see build log for details.
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_VERSION#
[Validation] generic error code for unsupported versions
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_FEATURE#
[Validation] generic error code for unsupported features
-
enumerator UR_RESULT_ERROR_INVALID_ARGUMENT#
[Validation] generic error code for invalid arguments
-
enumerator UR_RESULT_ERROR_INVALID_NULL_HANDLE#
[Validation] handle argument is not valid
-
enumerator UR_RESULT_ERROR_HANDLE_OBJECT_IN_USE#
[Validation] object pointed to by handle still in-use by device
-
enumerator UR_RESULT_ERROR_INVALID_NULL_POINTER#
[Validation] pointer argument may not be nullptr
-
enumerator UR_RESULT_ERROR_INVALID_SIZE#
[Validation] invalid size or dimensions (e.g., must not be zero, or is out of bounds)
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_SIZE#
[Validation] size argument is not supported by the device (e.g., too large)
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_ALIGNMENT#
[Validation] alignment argument is not supported by the device (e.g., too small)
-
enumerator UR_RESULT_ERROR_INVALID_SYNCHRONIZATION_OBJECT#
[Validation] synchronization object in invalid state
-
enumerator UR_RESULT_ERROR_INVALID_ENUMERATION#
[Validation] enumerator argument is not valid
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION#
[Validation] enumerator argument is not supported by the device
-
enumerator UR_RESULT_ERROR_UNSUPPORTED_IMAGE_FORMAT#
[Validation] image format is not supported by the device
-
enumerator UR_RESULT_ERROR_INVALID_NATIVE_BINARY#
[Validation] native binary is not supported by the device
-
enumerator UR_RESULT_ERROR_INVALID_GLOBAL_NAME#
[Validation] global variable is not found in the program
-
enumerator UR_RESULT_ERROR_FUNCTION_ADDRESS_NOT_AVAILABLE#
[Validation] function name is in the program but its address could not be determined
-
enumerator UR_RESULT_ERROR_INVALID_GROUP_SIZE_DIMENSION#
[Validation] group size dimension is not valid for the kernel or device
-
enumerator UR_RESULT_ERROR_INVALID_GLOBAL_WIDTH_DIMENSION#
[Validation] global width dimension is not valid for the kernel or device
-
enumerator UR_RESULT_ERROR_PROGRAM_UNLINKED#
[Validation] compiled program or program with imports needs to be linked before kernels can be created from it.
-
enumerator UR_RESULT_ERROR_OVERLAPPING_REGIONS#
[Validation] copy operations do not support overlapping regions of memory
-
enumerator UR_RESULT_ERROR_INVALID_HOST_PTR#
Invalid host pointer.
-
enumerator UR_RESULT_ERROR_INVALID_USM_SIZE#
Invalid USM size.
-
enumerator UR_RESULT_ERROR_OBJECT_ALLOCATION_FAILURE#
Objection allocation failure.
-
enumerator UR_RESULT_ERROR_ADAPTER_SPECIFIC#
An adapter specific warning/error has been reported and can be retrieved via the urAdapterGetLastError entry point.
-
enumerator UR_RESULT_ERROR_LAYER_NOT_PRESENT#
A requested layer was not found by the loader.
-
enumerator UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS#
An event in the provided wait list has UR_EVENT_STATUS_ERROR.
-
enumerator UR_RESULT_ERROR_DEVICE_NOT_AVAILABLE#
Device in question has
UR_DEVICE_INFO_AVAILABLE == false
-
enumerator UR_RESULT_ERROR_INVALID_SPEC_ID#
A specialization constant identifier is not valid.
-
enumerator UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP#
Invalid Command-Buffer.
-
enumerator UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_EXP#
Sync point is not valid for the command-buffer.
-
enumerator UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP#
Sync point wait list is invalid.
-
enumerator UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_COMMAND_HANDLE_EXP#
Handle to command-buffer command is invalid.
-
enumerator UR_RESULT_ERROR_UNKNOWN#
Unknown or internal error
-
enumerator UR_RESULT_SUCCESS#
Common Structures#
ur_base_properties_t#
-
struct ur_base_properties_t#
Base for all properties types.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_base_desc_t#
-
struct ur_base_desc_t#
Base for all descriptor types.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
Loader#
Functions
Enumerations
Structures
Typedefs
Loader Functions#
urLoaderConfigCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigCreate(ur_loader_config_handle_t *phLoaderConfig)#
Create a loader config object.
- Parameters
phLoaderConfig – [out] Pointer to handle of loader config object created.
- Returns
urLoaderConfigRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigRetain(ur_loader_config_handle_t hLoaderConfig)#
Get a reference to the loader config object.
Get a reference to the loader config handle. Increment its reference count
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hLoaderConfig – [in][retain] loader config handle to retain
- Returns
urLoaderConfigRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigRelease(ur_loader_config_handle_t hLoaderConfig)#
Release config handle.
Decrement reference count and destroy the config handle if reference count becomes zero.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hLoaderConfig – [in][release] config handle to release
- Returns
urLoaderConfigGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigGetInfo(ur_loader_config_handle_t hLoaderConfig, ur_loader_config_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieves various information about the loader.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hLoaderConfig – [in] handle of the loader config object
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hLoaderConfig
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_LOADER_CONFIG_INFO_REFERENCE_COUNT < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the loader.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urLoaderConfigEnableLayer#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigEnableLayer(ur_loader_config_handle_t hLoaderConfig, const char *pLayerName)#
Enable a layer for the specified loader config.
- Parameters
hLoaderConfig – [in] Handle to config object the layer will be enabled for.
pLayerName – [in] Null terminated string containing the name of the layer to enable. Empty if none are enabled.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hLoaderConfig
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pLayerName
UR_RESULT_ERROR_LAYER_NOT_PRESENT
If layer specified with
pLayerName
can’t be found by the loader.
urLoaderConfigSetCodeLocationCallback#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigSetCodeLocationCallback(ur_loader_config_handle_t hLoaderConfig, ur_code_location_callback_t pfnCodeloc, void *pUserData)#
Set a function callback for use by the loader to retrieve code location information.
The code location callback is optional and provides additional information to the tracing layer about the entry point of the current execution flow.
This functionality can be used to match traced unified runtime function calls with higher-level user calls.
- Parameters
hLoaderConfig – [in] Handle to config object the layer will be enabled for.
pfnCodeloc – [in] Function pointer to code location callback.
pUserData – [in][out][optional] pointer to data to be passed to callback.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hLoaderConfig
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pfnCodeloc
urLoaderConfigSetMockingEnabled#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderConfigSetMockingEnabled(ur_loader_config_handle_t hLoaderConfig, ur_bool_t enable)#
The only adapter reported with mock enabled will be the mock adapter.
The mock adapter will default to returning UR_RESULT_SUCCESS for all entry points. It will also create and correctly reference count dummy handles where appropriate. Its behaviour can be modified by linking the mock library and using the object accessed via mock::getCallbacks().
- Parameters
hLoaderConfig – [in] Handle to config object mocking will be enabled for.
enable – [in] Handle to config object the layer will be enabled for.
- Returns
urLoaderInit#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderInit(ur_device_init_flags_t device_flags, ur_loader_config_handle_t hLoaderConfig)#
Initialize the ‘oneAPI’ loader.
The application must call this function before calling any other function.
If this function is not called then all other functions will return UR_RESULT_ERROR_UNINITIALIZED.
Only one instance of the loader will be initialized per process.
The application may call this function multiple times with different flags or environment variables enabled.
The application must call this function after forking new processes. Each forked process must call this function.
The application may call this function from simultaneous threads.
The implementation of this function must be thread-safe for scenarios where multiple libraries may initialize the loader simultaneously.
- Parameters
device_flags – [in] device initialization flags. must be 0 (default) or a combination of ur_device_init_flag_t.
hLoaderConfig – [in][optional] Handle of loader config handle.
- Returns
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_DEVICE_INIT_FLAGS_MASK & device_flags
urLoaderTearDown#
-
UR_APIEXPORT ur_result_t UR_APICALL urLoaderTearDown(void)#
Tear down the ‘oneAPI’ loader and release all its resources.
Loader Enums#
ur_device_init_flags_t#
-
enum ur_device_init_flag_t#
Values:
-
enumerator UR_DEVICE_INIT_FLAG_GPU#
initialize GPU device adapters.
-
enumerator UR_DEVICE_INIT_FLAG_CPU#
initialize CPU device adapters.
-
enumerator UR_DEVICE_INIT_FLAG_FPGA#
initialize FPGA device adapters.
-
enumerator UR_DEVICE_INIT_FLAG_MCA#
initialize MCA device adapters.
-
enumerator UR_DEVICE_INIT_FLAG_VPU#
initialize VPU device adapters.
-
enumerator UR_DEVICE_INIT_FLAG_GPU#
ur_loader_config_info_t#
Loader Typedefs#
ur_code_location_callback_t#
-
typedef ur_code_location_t (*ur_code_location_callback_t)(void *pUserData)#
Code location callback with user data.
Adapter#
Functions
Enumerations
Adapter Functions#
urAdapterGet#
-
UR_APIEXPORT ur_result_t UR_APICALL urAdapterGet(uint32_t NumEntries, ur_adapter_handle_t *phAdapters, uint32_t *pNumAdapters)#
Retrieves all available adapters.
Adapter implementations must return exactly one adapter handle from this entry point.
The loader may return more than one adapter handle when there are multiple available.
Each returned adapter has its reference count incremented and should be released with a subsequent call to urAdapterRelease.
Adapters may perform adapter-specific state initialization when the first reference to them is taken.
An application may call this entry point multiple times to acquire multiple references to the adapter handle(s).
- Parameters
NumEntries – [in] the number of adapters to be added to phAdapters. If phAdapters is not NULL, then NumEntries should be greater than zero, otherwise UR_RESULT_ERROR_INVALID_SIZE, will be returned.
phAdapters – [out][optional][range(0, NumEntries)] array of handle of adapters. If NumEntries is less than the number of adapters available, then urAdapterGet shall only retrieve that number of adapters.
pNumAdapters – [out][optional] returns the total number of adapters available.
- Returns
NumEntries == 0 && phAdapters != NULL
urAdapterRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urAdapterRelease(ur_adapter_handle_t hAdapter)#
Releases the adapter handle reference indicating end of its usage.
When the reference count of the adapter reaches zero, the adapter may perform adapter-specififc resource teardown. Resources must be left in a state where it safe for the adapter to be subsequently reinitialized with urAdapterGet
- Parameters
hAdapter – [in][release] Adapter handle to release
- Returns
urAdapterRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urAdapterRetain(ur_adapter_handle_t hAdapter)#
Get a reference to the adapter handle.
Get a reference to the adapter handle. Increment its reference count
- Parameters
hAdapter – [in][retain] Adapter handle to retain
- Returns
urAdapterGetLastError#
-
UR_APIEXPORT ur_result_t UR_APICALL urAdapterGetLastError(ur_adapter_handle_t hAdapter, const char **ppMessage, int32_t *pError)#
Get the last adapter specific error.
To be used after another entry-point has returned UR_RESULT_ERROR_ADAPTER_SPECIFIC in order to retrieve a message describing the circumstances of the underlying driver error and the error code returned by the failed driver entry-point.
Implementations must store the message and error code in thread-local storage prior to returning UR_RESULT_ERROR_ADAPTER_SPECIFIC.
The message and error code storage is will only be valid if a previously called entry-point returned UR_RESULT_ERROR_ADAPTER_SPECIFIC.
The memory pointed to by the C string returned in
ppMessage
is owned by the adapter and must be null terminated.The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Example usage:
if (::urQueueCreate(hContext, hDevice, nullptr, &hQueue) == ::UR_RESULT_ERROR_ADAPTER_SPECIFIC) { const char* pMessage; int32_t error; ::urAdapterGetLastError(hAdapter, &pMessage, &error); }
- Parameters
hAdapter – [in] handle of the adapter instance
ppMessage – [out] pointer to a C string where the adapter specific error message will be stored.
pError – [out] pointer to an integer where the adapter specific error code will be stored.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hAdapter
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppMessage
NULL == pError
urAdapterGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urAdapterGetInfo(ur_adapter_handle_t hAdapter, ur_adapter_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieves information about the adapter.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hAdapter – [in] handle of the adapter
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If Size is not equal to or greater to the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual number of bytes being queried by pPropValue.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hAdapter
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_ADAPTER_INFO_VERSION < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
Adapter Enums#
ur_adapter_info_t#
-
enum ur_adapter_info_t#
Supported adapter info.
Values:
-
enumerator UR_ADAPTER_INFO_BACKEND#
[ur_adapter_backend_t] Identifies the native backend supported by the adapter.
-
enumerator UR_ADAPTER_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the adapter. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_ADAPTER_INFO_VERSION#
[uint32_t] Specifies the adapter version, initial value of 1 and incremented unpon major changes, e.g. when multiple versions of an adapter may exist in parallel.
-
enumerator UR_ADAPTER_INFO_BACKEND#
ur_adapter_backend_t#
-
enum ur_adapter_backend_t#
Identifies backend of the adapter.
Values:
-
enumerator UR_ADAPTER_BACKEND_UNKNOWN#
The backend is not a recognized one.
-
enumerator UR_ADAPTER_BACKEND_LEVEL_ZERO#
The backend is Level Zero.
-
enumerator UR_ADAPTER_BACKEND_OPENCL#
The backend is OpenCL.
-
enumerator UR_ADAPTER_BACKEND_CUDA#
The backend is CUDA.
-
enumerator UR_ADAPTER_BACKEND_HIP#
The backend is HIP.
-
enumerator UR_ADAPTER_BACKEND_NATIVE_CPU#
The backend is Native CPU
-
enumerator UR_ADAPTER_BACKEND_UNKNOWN#
Platform#
Functions
Enumerations
Structures
Platform Functions#
urPlatformGet#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformGet(ur_adapter_handle_t *phAdapters, uint32_t NumAdapters, uint32_t NumEntries, ur_platform_handle_t *phPlatforms, uint32_t *pNumPlatforms)#
Retrieves all available platforms for the given adapters.
Multiple calls to this function will return identical platforms handles, in the same order.
The application may call this function from simultaneous threads, the implementation must be thread-safe
Remark
Analogues
clGetPlatformIDs
- Parameters
phAdapters – [in][range(0, NumAdapters)] array of adapters to query for platforms.
NumAdapters – [in] number of adapters pointed to by phAdapters
NumEntries – [in] the number of platforms to be added to phPlatforms. If phPlatforms is not NULL, then NumEntries should be greater than zero, otherwise UR_RESULT_ERROR_INVALID_SIZE, will be returned.
phPlatforms – [out][optional][range(0, NumEntries)] array of handle of platforms. If NumEntries is less than the number of platforms available, then urPlatformGet shall only retrieve that number of platforms.
pNumPlatforms – [out][optional] returns the total number of platforms available.
- Returns
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phAdapters
NumEntries == 0 && phPlatforms != NULL
pNumPlatforms == NULL && phPlatforms == NULL
urPlatformGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformGetInfo(ur_platform_handle_t hPlatform, ur_platform_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieves various information about platform.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clGetPlatformInfo
- Parameters
hPlatform – [in] handle of the platform
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes pointed to by pPlatformInfo.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If Size is not equal to or greater to the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPlatformInfo is not used.
pPropSizeRet – [out][optional] pointer to the actual number of bytes being queried by pPlatformInfo.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hPlatform
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_PLATFORM_INFO_ADAPTER < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urPlatformGetApiVersion#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformGetApiVersion(ur_platform_handle_t hPlatform, ur_api_version_t *pVersion)#
Returns the API version supported by the specified platform.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hPlatform – [in] handle of the platform
pVersion – [out] api version
- Returns
urPlatformGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformGetNativeHandle(ur_platform_handle_t hPlatform, ur_native_handle_t *phNativePlatform)#
Return platform native platform handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hPlatform – [in] handle of the platform.
phNativePlatform – [out] a pointer to the native handle of the platform.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hPlatform
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativePlatform
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urPlatformCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformCreateWithNativeHandle(ur_native_handle_t hNativePlatform, ur_adapter_handle_t hAdapter, const ur_platform_native_properties_t *pProperties, ur_platform_handle_t *phPlatform)#
Create runtime platform object from native platform handle.
Creates runtime platform handle from native driver platform handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativePlatform – [in][nocheck] the native handle of the platform.
hAdapter – [in] handle of the adapter associated with the native backend.
pProperties – [in][optional] pointer to native platform properties struct.
phPlatform – [out] pointer to the handle of the platform object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hAdapter
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phPlatform
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urPlatformGetBackendOption#
-
UR_APIEXPORT ur_result_t UR_APICALL urPlatformGetBackendOption(ur_platform_handle_t hPlatform, const char *pFrontendOption, const char **ppPlatformOption)#
Get the platform specific compiler backend option from a generic frontend option.
The string returned via the ppPlatformOption is a NULL terminated C style string.
The string returned via the ppPlatformOption is thread local.
The memory in the string returned via the ppPlatformOption is owned by the adapter.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hPlatform – [in] handle of the platform instance.
pFrontendOption – [in] string containing the frontend option.
ppPlatformOption – [out] returns the correct platform specific compiler option based on the frontend option.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hPlatform
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pFrontendOption
NULL == ppPlatformOption
If
pFrontendOption
is not a valid frontend option.
Platform Enums#
ur_platform_info_t#
-
enum ur_platform_info_t#
Supported platform info.
Values:
-
enumerator UR_PLATFORM_INFO_NAME#
[char[]] The string denoting name of the platform. The size of the info needs to be dynamically queried.
-
enumerator UR_PLATFORM_INFO_VENDOR_NAME#
[char[]] The string denoting name of the vendor of the platform. The size of the info needs to be dynamically queried.
-
enumerator UR_PLATFORM_INFO_VERSION#
[char[]] The string denoting the version of the platform. The size of the info needs to be dynamically queried.
-
enumerator UR_PLATFORM_INFO_EXTENSIONS#
[char[]] The string denoting extensions supported by the platform. The size of the info needs to be dynamically queried.
-
enumerator UR_PLATFORM_INFO_PROFILE#
[char[]] The string denoting profile of the platform. The size of the info needs to be dynamically queried.
-
enumerator UR_PLATFORM_INFO_BACKEND#
[ur_platform_backend_t] The backend of the platform. Identifies the native backend adapter implementing this platform.
-
enumerator UR_PLATFORM_INFO_ADAPTER#
[ur_adapter_handle_t] The adapter handle associated with the platform.
-
enumerator UR_PLATFORM_INFO_NAME#
ur_api_version_t#
-
enum ur_api_version_t#
Supported API versions.
API versions contain major and minor attributes, use UR_MAJOR_VERSION and UR_MINOR_VERSION
Values:
-
enumerator UR_API_VERSION_0_6#
version 0.6
-
enumerator UR_API_VERSION_0_7#
version 0.7
-
enumerator UR_API_VERSION_0_8#
version 0.8
-
enumerator UR_API_VERSION_0_9#
version 0.9
-
enumerator UR_API_VERSION_0_10#
version 0.10
-
enumerator UR_API_VERSION_0_11#
version 0.11
-
enumerator UR_API_VERSION_0_12#
version 0.12
-
enumerator UR_API_VERSION_CURRENT#
latest known version
ur_platform_backend_t#
-
enum ur_platform_backend_t#
Identifies native backend adapters.
Values:
-
enumerator UR_PLATFORM_BACKEND_UNKNOWN#
The backend is not a recognized one.
-
enumerator UR_PLATFORM_BACKEND_LEVEL_ZERO#
The backend is Level Zero.
-
enumerator UR_PLATFORM_BACKEND_OPENCL#
The backend is OpenCL.
-
enumerator UR_PLATFORM_BACKEND_CUDA#
The backend is CUDA.
-
enumerator UR_PLATFORM_BACKEND_HIP#
The backend is HIP.
-
enumerator UR_PLATFORM_BACKEND_NATIVE_CPU#
The backend is Native CPU
-
enumerator UR_PLATFORM_BACKEND_UNKNOWN#
Platform Structures#
ur_platform_native_properties_t#
-
struct ur_platform_native_properties_t#
Native platform creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_PLATFORM_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Device#
Functions
Enumerations
Structures
Macros
Device Functions#
urDeviceGet#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceGet(ur_platform_handle_t hPlatform, ur_device_type_t DeviceType, uint32_t NumEntries, ur_device_handle_t *phDevices, uint32_t *pNumDevices)#
Retrieves devices within a platform.
Multiple calls to this function will return identical device handles, in the same order.
The number and order of handles returned from this function can be affected by environment variables that filter devices exposed through API.
The returned devices are taken a reference of and must be released with a subsequent call to urDeviceRelease.
The application may call this function from simultaneous threads, the implementation must be thread-safe
Remark
Analogues
clGetDeviceIDs
- Parameters
hPlatform – [in] handle of the platform instance
DeviceType – [in] the type of the devices.
NumEntries – [in] the number of devices to be added to phDevices. If phDevices is not NULL, then NumEntries should be greater than zero. Otherwise UR_RESULT_ERROR_INVALID_SIZE will be returned.
phDevices – [out][optional][range(0, NumEntries)] array of handle of devices. If NumEntries is less than the number of devices available, then platform shall only retrieve that number of devices.
pNumDevices – [out][optional] pointer to the number of devices. pNumDevices will be updated with the total number of devices available.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hPlatform
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_DEVICE_TYPE_VPU < DeviceType
NumEntries == 0 && phDevices != NULL
UR_RESULT_ERROR_INVALID_NULL_POINTER
NumEntries > 0 && phDevices == NULL
urDeviceGetSelected#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceGetSelected(ur_platform_handle_t hPlatform, ur_device_type_t DeviceType, uint32_t NumEntries, ur_device_handle_t *phDevices, uint32_t *pNumDevices)#
Retrieves devices within a platform selected by ONEAPI_DEVICE_SELECTOR.
Multiple calls to this function will return identical device handles, in the same order.
The number and order of handles returned from this function will be affected by environment variables that filter or select which devices are exposed through this API.
A reference is taken for each returned device and must be released with a subsequent call to urDeviceRelease.
The application may call this function from simultaneous threads, the implementation must be thread-safe.
- Parameters
hPlatform – [in] handle of the platform instance
DeviceType – [in] the type of the devices.
NumEntries – [in] the number of devices to be added to phDevices. If phDevices in not NULL then NumEntries should be greater than zero, otherwise UR_RESULT_ERROR_INVALID_VALUE, will be returned.
phDevices – [out][optional][range(0, NumEntries)] array of handle of devices. If NumEntries is less than the number of devices available, then only that number of devices will be retrieved.
pNumDevices – [out][optional] pointer to the number of devices. pNumDevices will be updated with the total number of selected devices available for the given platform.
- Returns
urDeviceGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceGetInfo(ur_device_handle_t hDevice, ur_device_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieves various information about device.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clGetDeviceInfo
- Parameters
hDevice – [in] handle of the device instance
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urDeviceRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceRetain(ur_device_handle_t hDevice)#
Makes a reference of the device handle indicating it’s in use until paired urDeviceRelease is called.
Increments the device reference count if
hDevice
is a valid sub-device created by a call tourDevicePartition
. IfhDevice
is a root level device (e.g. obtained withurDeviceGet
), the reference count remains unchanged.It is not valid to use the device handle, which has all of its references released.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clRetainDevice
- Parameters
hDevice – [in][retain] handle of the device to get a reference of.
- Returns
urDeviceRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceRelease(ur_device_handle_t hDevice)#
Releases the device handle reference indicating end of its usage.
Decrements the device reference count if
hDevice
is a valid sub-device created by a call tourDevicePartition
. IfhDevice
is a root level device (e.g. obtained withurDeviceGet
), the reference count remains unchanged.The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clReleaseDevice
- Parameters
hDevice – [in][release] handle of the device to release.
- Returns
urDevicePartition#
-
UR_APIEXPORT ur_result_t UR_APICALL urDevicePartition(ur_device_handle_t hDevice, const ur_device_partition_properties_t *pProperties, uint32_t NumDevices, ur_device_handle_t *phSubDevices, uint32_t *pNumDevicesRet)#
Partition the device into sub-devices.
Repeated calls to this function with the same inputs will produce the same output in the same order.
The function may be called to request a further partitioning of a sub-device into sub-sub-devices, and so on.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clCreateSubDevices
- Parameters
hDevice – [in] handle of the device to partition.
pProperties – [in] Device partition properties.
NumDevices – [in] the number of sub-devices.
phSubDevices – [out][optional][range(0, NumDevices)] array of handle of devices. If NumDevices is less than the number of sub-devices available, then the function shall only retrieve that number of sub-devices.
pNumDevicesRet – [out][optional] pointer to the number of sub-devices the device can be partitioned into according to the partitioning property.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pProperties
NULL == pProperties->pProperties
urDeviceSelectBinary#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceSelectBinary(ur_device_handle_t hDevice, const ur_device_binary_t *pBinaries, uint32_t NumBinaries, uint32_t *pSelectedBinary)#
Selects the most appropriate device binary based on runtime information and the IR characteristics.
The input binaries are various AOT images, and possibly an IL binary for JIT compilation.
The selected binary will be able to be run on the target device.
If no suitable binary can be found then function returns ${X}_INVALID_BINARY.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
- Parameters
hDevice – [in] handle of the device to select binary for.
pBinaries – [in] the array of binaries to select from.
NumBinaries – [in] the number of binaries passed in ppBinaries. Must greater than or equal to zero otherwise UR_RESULT_ERROR_INVALID_VALUE is returned.
pSelectedBinary – [out] the index of the selected binary in the input array of binaries. If a suitable binary was not found the function returns UR_RESULT_ERROR_INVALID_BINARY.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pBinaries
NULL == pSelectedBinary
NumBinaries == 0
urDeviceGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceGetNativeHandle(ur_device_handle_t hDevice, ur_native_handle_t *phNativeDevice)#
Return platform native device handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hDevice – [in] handle of the device.
phNativeDevice – [out] a pointer to the native handle of the device.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeDevice
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urDeviceCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceCreateWithNativeHandle(ur_native_handle_t hNativeDevice, ur_adapter_handle_t hAdapter, const ur_device_native_properties_t *pProperties, ur_device_handle_t *phDevice)#
Create runtime device object from native device handle.
Creates runtime device handle from native driver device handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeDevice – [in][nocheck] the native handle of the device.
hAdapter – [in] handle of the adapter to which `hNativeDevice` belongs
pProperties – [in][optional] pointer to native device properties struct.
phDevice – [out] pointer to the handle of the device object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hAdapter
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevice
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urDeviceGetGlobalTimestamps#
-
UR_APIEXPORT ur_result_t UR_APICALL urDeviceGetGlobalTimestamps(ur_device_handle_t hDevice, uint64_t *pDeviceTimestamp, uint64_t *pHostTimestamp)#
Returns synchronized Host and Device global timestamps.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
Remark
Analogues
clGetDeviceAndHostTimer
- Parameters
hDevice – [in] handle of the device instance
pDeviceTimestamp – [out][optional] pointer to the Device’s global timestamp that correlates with the Host’s global timestamp value
pHostTimestamp – [out][optional] pointer to the Host’s global timestamp that correlates with the Device’s global timestamp value
- Returns
Device Enums#
ur_device_type_t#
-
enum ur_device_type_t#
Supported device types.
Values:
-
enumerator UR_DEVICE_TYPE_DEFAULT#
The default device type as preferred by the runtime.
-
enumerator UR_DEVICE_TYPE_ALL#
Devices of all types.
-
enumerator UR_DEVICE_TYPE_GPU#
Graphics Processing Unit.
-
enumerator UR_DEVICE_TYPE_CPU#
Central Processing Unit.
-
enumerator UR_DEVICE_TYPE_FPGA#
Field Programmable Gate Array.
-
enumerator UR_DEVICE_TYPE_MCA#
Memory Copy Accelerator.
-
enumerator UR_DEVICE_TYPE_VPU#
Vision Processing Unit
-
enumerator UR_DEVICE_TYPE_DEFAULT#
ur_device_info_t#
-
enum ur_device_info_t#
Supported device info.
Values:
-
enumerator UR_DEVICE_INFO_TYPE#
[ur_device_type_t] type of the device
-
enumerator UR_DEVICE_INFO_VENDOR_ID#
[uint32_t] vendor Id of the device
-
enumerator UR_DEVICE_INFO_DEVICE_ID#
[uint32_t][optional-query] Id of the device
-
enumerator UR_DEVICE_INFO_MAX_COMPUTE_UNITS#
[uint32_t] the number of compute units
-
enumerator UR_DEVICE_INFO_MAX_WORK_ITEM_DIMENSIONS#
[uint32_t] max work item dimensions
-
enumerator UR_DEVICE_INFO_MAX_WORK_ITEM_SIZES#
[size_t[]] return an array of max work item sizes
-
enumerator UR_DEVICE_INFO_MAX_WORK_GROUP_SIZE#
[size_t] max work group size
-
enumerator UR_DEVICE_INFO_SINGLE_FP_CONFIG#
[ur_device_fp_capability_flags_t] single precision floating point capability
-
enumerator UR_DEVICE_INFO_HALF_FP_CONFIG#
[ur_device_fp_capability_flags_t] half precision floating point capability
-
enumerator UR_DEVICE_INFO_DOUBLE_FP_CONFIG#
[ur_device_fp_capability_flags_t] double precision floating point capability
-
enumerator UR_DEVICE_INFO_QUEUE_PROPERTIES#
[ur_queue_flags_t] command queue properties supported by the device
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_CHAR#
[uint32_t] preferred vector width for char
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_SHORT#
[uint32_t] preferred vector width for short
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_INT#
[uint32_t] preferred vector width for int
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_LONG#
[uint32_t] preferred vector width for long
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_FLOAT#
[uint32_t] preferred vector width for float
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_DOUBLE#
[uint32_t] preferred vector width for double
-
enumerator UR_DEVICE_INFO_PREFERRED_VECTOR_WIDTH_HALF#
[uint32_t] preferred vector width for half float
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_CHAR#
[uint32_t] native vector width for char
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_SHORT#
[uint32_t] native vector width for short
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_INT#
[uint32_t] native vector width for int
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_LONG#
[uint32_t] native vector width for long
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_FLOAT#
[uint32_t] native vector width for float
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_DOUBLE#
[uint32_t] native vector width for double
-
enumerator UR_DEVICE_INFO_NATIVE_VECTOR_WIDTH_HALF#
[uint32_t] native vector width for half float
-
enumerator UR_DEVICE_INFO_MAX_CLOCK_FREQUENCY#
[uint32_t] max clock frequency in MHz
-
enumerator UR_DEVICE_INFO_MEMORY_CLOCK_RATE#
[uint32_t][optional-query] memory clock frequency in MHz
-
enumerator UR_DEVICE_INFO_ADDRESS_BITS#
[uint32_t] address bits
-
enumerator UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE#
[uint64_t] max memory allocation size
-
enumerator UR_DEVICE_INFO_MAX_READ_IMAGE_ARGS#
[uint32_t] max number of image objects arguments of a kernel declared with the read_only qualifier
-
enumerator UR_DEVICE_INFO_MAX_WRITE_IMAGE_ARGS#
[uint32_t] max number of image objects arguments of a kernel declared with the write_only qualifier
-
enumerator UR_DEVICE_INFO_MAX_READ_WRITE_IMAGE_ARGS#
[uint32_t] max number of image objects arguments of a kernel declared with the read_write qualifier
-
enumerator UR_DEVICE_INFO_IMAGE2D_MAX_WIDTH#
[size_t] max width of Image2D object
-
enumerator UR_DEVICE_INFO_IMAGE2D_MAX_HEIGHT#
[size_t] max height of Image2D object
-
enumerator UR_DEVICE_INFO_IMAGE3D_MAX_WIDTH#
[size_t] max width of Image3D object
-
enumerator UR_DEVICE_INFO_IMAGE3D_MAX_HEIGHT#
[size_t] max height of Image3D object
-
enumerator UR_DEVICE_INFO_IMAGE3D_MAX_DEPTH#
[size_t] max depth of Image3D object
-
enumerator UR_DEVICE_INFO_IMAGE_MAX_BUFFER_SIZE#
[size_t] max image buffer size
-
enumerator UR_DEVICE_INFO_IMAGE_MAX_ARRAY_SIZE#
[size_t] max image array size
-
enumerator UR_DEVICE_INFO_MAX_SAMPLERS#
[uint32_t] max number of samplers that can be used in a kernel
-
enumerator UR_DEVICE_INFO_MAX_PARAMETER_SIZE#
[size_t] max size in bytes of all arguments passed to a kernel
-
enumerator UR_DEVICE_INFO_MEM_BASE_ADDR_ALIGN#
[uint32_t] memory base address alignment
-
enumerator UR_DEVICE_INFO_GLOBAL_MEM_CACHE_TYPE#
[ur_device_mem_cache_type_t] global memory cache type
-
enumerator UR_DEVICE_INFO_GLOBAL_MEM_CACHELINE_SIZE#
[uint32_t] global memory cache line size in bytes
-
enumerator UR_DEVICE_INFO_GLOBAL_MEM_CACHE_SIZE#
[uint64_t] size of global memory cache in bytes
-
enumerator UR_DEVICE_INFO_GLOBAL_MEM_SIZE#
[uint64_t] size of global memory in bytes
-
enumerator UR_DEVICE_INFO_GLOBAL_MEM_FREE#
[uint64_t][optional-query] size of global memory which is free in bytes
-
enumerator UR_DEVICE_INFO_MAX_CONSTANT_BUFFER_SIZE#
[uint64_t] max constant buffer size in bytes
-
enumerator UR_DEVICE_INFO_MAX_CONSTANT_ARGS#
[uint32_t] max number of __const declared arguments in a kernel
-
enumerator UR_DEVICE_INFO_LOCAL_MEM_TYPE#
[ur_device_local_mem_type_t] local memory type
-
enumerator UR_DEVICE_INFO_LOCAL_MEM_SIZE#
[uint64_t] local memory size in bytes
-
enumerator UR_DEVICE_INFO_ERROR_CORRECTION_SUPPORT#
[ur_bool_t] support error correction to global and local memory
-
enumerator UR_DEVICE_INFO_PROFILING_TIMER_RESOLUTION#
[size_t] profiling timer resolution in nanoseconds
-
enumerator UR_DEVICE_INFO_EXECUTION_CAPABILITIES#
[ur_device_exec_capability_flags_t] device kernel execution capability bit-field
-
enumerator UR_DEVICE_INFO_QUEUE_ON_DEVICE_PROPERTIES#
[ur_queue_flags_t] device command queue property bit-field
-
enumerator UR_DEVICE_INFO_QUEUE_ON_HOST_PROPERTIES#
[ur_queue_flags_t] host queue property bit-field
-
enumerator UR_DEVICE_INFO_BUILT_IN_KERNELS#
[char[]] a semi-colon separated list of built-in kernels
-
enumerator UR_DEVICE_INFO_PLATFORM#
[ur_platform_handle_t] the platform associated with the device
-
enumerator UR_DEVICE_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the device object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_DEVICE_INFO_IL_VERSION#
[char[]] IL version
-
enumerator UR_DEVICE_INFO_NAME#
[char[]] Device name
-
enumerator UR_DEVICE_INFO_VENDOR#
[char[]] Device vendor
-
enumerator UR_DEVICE_INFO_DRIVER_VERSION#
[char[]] Driver version
-
enumerator UR_DEVICE_INFO_PROFILE#
[char[]] Device profile
-
enumerator UR_DEVICE_INFO_VERSION#
[char[]] Device version
-
enumerator UR_DEVICE_INFO_BACKEND_RUNTIME_VERSION#
[char[]] Version of backend runtime
-
enumerator UR_DEVICE_INFO_EXTENSIONS#
[char[]] Return a space separated list of extension names
-
enumerator UR_DEVICE_INFO_PRINTF_BUFFER_SIZE#
[size_t] Maximum size in bytes of internal printf buffer
-
enumerator UR_DEVICE_INFO_PREFERRED_INTEROP_USER_SYNC#
[ur_bool_t] prefer user synchronization when sharing object with other API
-
enumerator UR_DEVICE_INFO_PARENT_DEVICE#
[ur_device_handle_t] return parent device handle
-
enumerator UR_DEVICE_INFO_SUPPORTED_PARTITIONS#
[ur_device_partition_t[]] Returns an array of partition types supported by the device
-
enumerator UR_DEVICE_INFO_PARTITION_MAX_SUB_DEVICES#
[uint32_t] maximum number of sub-devices when the device is partitioned
-
enumerator UR_DEVICE_INFO_PARTITION_AFFINITY_DOMAIN#
[ur_device_affinity_domain_flags_t] Returns a bit-field of the supported affinity domains for partitioning. If the device does not support any affinity domains, then 0 will be returned.
-
enumerator UR_DEVICE_INFO_PARTITION_TYPE#
[ur_device_partition_property_t[]] return an array of ur_device_partition_property_t for properties specified in urDevicePartition
-
enumerator UR_DEVICE_INFO_MAX_NUM_SUB_GROUPS#
[uint32_t] max number of sub groups
-
enumerator UR_DEVICE_INFO_SUB_GROUP_INDEPENDENT_FORWARD_PROGRESS#
[ur_bool_t] support sub group independent forward progress
-
enumerator UR_DEVICE_INFO_SUB_GROUP_SIZES_INTEL#
[uint32_t[]] return an array of supported sub group sizes
-
enumerator UR_DEVICE_INFO_USM_HOST_SUPPORT#
[ur_device_usm_access_capability_flags_t] support USM host memory access
-
enumerator UR_DEVICE_INFO_USM_DEVICE_SUPPORT#
[ur_device_usm_access_capability_flags_t] support USM device memory access
-
enumerator UR_DEVICE_INFO_USM_SINGLE_SHARED_SUPPORT#
[ur_device_usm_access_capability_flags_t] support USM single device shared memory access
-
enumerator UR_DEVICE_INFO_USM_CROSS_SHARED_SUPPORT#
[ur_device_usm_access_capability_flags_t] support USM cross device shared memory access
-
enumerator UR_DEVICE_INFO_USM_SYSTEM_SHARED_SUPPORT#
[ur_device_usm_access_capability_flags_t] support USM system wide shared memory access
-
enumerator UR_DEVICE_INFO_UUID#
[uint8_t[]][optional-query] return device UUID
-
enumerator UR_DEVICE_INFO_PCI_ADDRESS#
[char[]][optional-query] return device PCI address
-
enumerator UR_DEVICE_INFO_GPU_EU_COUNT#
[uint32_t][optional-query] return Intel GPU EU count
-
enumerator UR_DEVICE_INFO_GPU_EU_SIMD_WIDTH#
[uint32_t][optional-query] return Intel GPU EU SIMD width
-
enumerator UR_DEVICE_INFO_GPU_EU_SLICES#
[uint32_t][optional-query] return Intel GPU number of slices
-
enumerator UR_DEVICE_INFO_GPU_EU_COUNT_PER_SUBSLICE#
[uint32_t][optional-query] return Intel GPU EU count per subslice
-
enumerator UR_DEVICE_INFO_GPU_SUBSLICES_PER_SLICE#
[uint32_t][optional-query] return Intel GPU number of subslices per slice
-
enumerator UR_DEVICE_INFO_GPU_HW_THREADS_PER_EU#
[uint32_t][optional-query] return Intel GPU number of threads per EU
-
enumerator UR_DEVICE_INFO_MAX_MEMORY_BANDWIDTH#
[uint32_t][optional-query] return max memory bandwidth in Mb/s
-
enumerator UR_DEVICE_INFO_BUILD_ON_SUBDEVICE#
[ur_bool_t] Return true if sub-device should do its own program build
-
enumerator UR_DEVICE_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES#
[ur_memory_order_capability_flags_t] return a bit-field of atomic memory order capabilities
-
enumerator UR_DEVICE_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES#
[ur_memory_scope_capability_flags_t] return a bit-field of atomic memory scope capabilities
-
enumerator UR_DEVICE_INFO_ATOMIC_FENCE_ORDER_CAPABILITIES#
[ur_memory_order_capability_flags_t] return a bit-field of atomic memory fence order capabilities
-
enumerator UR_DEVICE_INFO_ATOMIC_FENCE_SCOPE_CAPABILITIES#
[ur_memory_scope_capability_flags_t] return a bit-field of atomic memory fence scope capabilities
-
enumerator UR_DEVICE_INFO_MAX_COMPUTE_QUEUE_INDICES#
[uint32_t] Returns 1 if the device doesn’t have a notion of a queue index. Otherwise, returns the number of queue indices that are available for this device.
-
enumerator UR_DEVICE_INFO_KERNEL_SET_SPECIALIZATION_CONSTANTS#
[ur_bool_t] support the urKernelSetSpecializationConstants entry point
-
enumerator UR_DEVICE_INFO_MEMORY_BUS_WIDTH#
[uint32_t][optional-query] return the width in bits of the memory bus interface of the device.
-
enumerator UR_DEVICE_INFO_MAX_WORK_GROUPS_3D#
[size_t[3]] return max 3D work groups
-
enumerator UR_DEVICE_INFO_MEM_CHANNEL_SUPPORT#
[ur_bool_t] return true if specifying memory channels is supported
-
enumerator UR_DEVICE_INFO_HOST_PIPE_READ_WRITE_SUPPORTED#
[ur_bool_t] Return true if the device supports enqueueing commands to read and write pipes from the host.
-
enumerator UR_DEVICE_INFO_MAX_REGISTERS_PER_WORK_GROUP#
[uint32_t][optional-query] The maximum number of registers available per block.
-
enumerator UR_DEVICE_INFO_IP_VERSION#
[uint32_t][optional-query] The device IP version. The meaning of the device IP version is implementation-defined, but newer devices should have a higher version than older devices.
-
enumerator UR_DEVICE_INFO_VIRTUAL_MEMORY_SUPPORT#
[ur_bool_t] return true if the device supports virtual memory.
-
enumerator UR_DEVICE_INFO_COMPONENT_DEVICES#
[ur_device_handle_t[]][optional-query] The set of component devices contained by this composite device.
-
enumerator UR_DEVICE_INFO_COMPOSITE_DEVICE#
[ur_device_handle_t][optional-query] The composite device containing this component device.
-
enumerator UR_DEVICE_INFO_GLOBAL_VARIABLE_SUPPORT#
[ur_bool_t] return true if the device supports the
EnqueueDeviceGlobalVariableWrite
andEnqueueDeviceGlobalVariableRead
entry points.
-
enumerator UR_DEVICE_INFO_USM_POOL_SUPPORT#
[ur_bool_t] return true if the device supports USM pooling. Pertains to the
USMPool
entry points and usage of thepool
parameter of the USM alloc entry points.
-
enumerator UR_DEVICE_INFO_COMMAND_BUFFER_SUPPORT_EXP#
[ur_bool_t] Returns true if the device supports the use of command-buffers.
-
enumerator UR_DEVICE_INFO_COMMAND_BUFFER_UPDATE_CAPABILITIES_EXP#
[ur_device_command_buffer_update_capability_flags_t] Command-buffer update capabilities of the device
-
enumerator UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP#
[ur_bool_t] Returns true if the device supports using event objects for command synchronization outside of a command-buffer.
-
enumerator UR_DEVICE_INFO_CLUSTER_LAUNCH_EXP#
[ur_bool_t] return true if enqueue Cluster Launch is supported
-
enumerator UR_DEVICE_INFO_BINDLESS_IMAGES_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports the creation of bindless images
-
enumerator UR_DEVICE_INFO_BINDLESS_IMAGES_SHARED_USM_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports the creation of bindless images backed by shared USM
-
enumerator UR_DEVICE_INFO_BINDLESS_IMAGES_1D_USM_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports the creation of 1D bindless images backed by USM
-
enumerator UR_DEVICE_INFO_BINDLESS_IMAGES_2D_USM_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports the creation of 2D bindless images backed by USM
-
enumerator UR_DEVICE_INFO_IMAGE_PITCH_ALIGN_EXP#
[uint32_t] returns the required alignment of the pitch between two rows of an image in bytes
-
enumerator UR_DEVICE_INFO_MAX_IMAGE_LINEAR_WIDTH_EXP#
[size_t] returns the maximum linear width allowed for images allocated using USM
-
enumerator UR_DEVICE_INFO_MAX_IMAGE_LINEAR_HEIGHT_EXP#
[size_t] returns the maximum linear height allowed for images allocated using USM
-
enumerator UR_DEVICE_INFO_MAX_IMAGE_LINEAR_PITCH_EXP#
[size_t] returns the maximum linear pitch allowed for images allocated using USM
-
enumerator UR_DEVICE_INFO_MIPMAP_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports allocating mipmap resources
-
enumerator UR_DEVICE_INFO_MIPMAP_ANISOTROPY_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports sampling mipmap images with anisotropic filtering
-
enumerator UR_DEVICE_INFO_MIPMAP_MAX_ANISOTROPY_EXP#
[uint32_t] returns the maximum anisotropic ratio supported by the device
-
enumerator UR_DEVICE_INFO_MIPMAP_LEVEL_REFERENCE_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports using images created from individual mipmap levels
-
enumerator UR_DEVICE_INFO_EXTERNAL_MEMORY_IMPORT_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports importing external memory resources
-
enumerator UR_DEVICE_INFO_EXTERNAL_SEMAPHORE_IMPORT_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports importing external semaphore resources
-
enumerator UR_DEVICE_INFO_CUBEMAP_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports allocating and accessing cubemap resources
-
enumerator UR_DEVICE_INFO_CUBEMAP_SEAMLESS_FILTERING_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports sampling cubemapped images across face boundaries
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLED_IMAGE_FETCH_1D_USM_EXP#
[ur_bool_t] returns true if the device is capable of fetching USM backed 1D sampled image data.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLED_IMAGE_FETCH_1D_EXP#
[ur_bool_t] returns true if the device is capable of fetching non-USM backed 1D sampled image data.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLED_IMAGE_FETCH_2D_USM_EXP#
[ur_bool_t] returns true if the device is capable of fetching USM backed 2D sampled image data.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLED_IMAGE_FETCH_2D_EXP#
[ur_bool_t] returns true if the device is capable of fetching non-USM backed 2D sampled image data.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLED_IMAGE_FETCH_3D_EXP#
[ur_bool_t] returns true if the device is capable of fetching non-USM backed 3D sampled image data.
-
enumerator UR_DEVICE_INFO_TIMESTAMP_RECORDING_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports timestamp recording
-
enumerator UR_DEVICE_INFO_IMAGE_ARRAY_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports allocating and accessing image array resources.
-
enumerator UR_DEVICE_INFO_BINDLESS_UNIQUE_ADDRESSING_PER_DIM_EXP#
[ur_bool_t] returns true if the device supports unique addressing per dimension.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLE_1D_USM_EXP#
[ur_bool_t] returns true if the device is capable of sampling USM backed 1D sampled image data.
-
enumerator UR_DEVICE_INFO_BINDLESS_SAMPLE_2D_USM_EXP#
[ur_bool_t] returns true if the device is capable of sampling USM backed 2D sampled image data.
-
enumerator UR_DEVICE_INFO_ENQUEUE_NATIVE_COMMAND_SUPPORT_EXP#
[ur_bool_t] returns true if the device supports enqueueing of native work
-
enumerator UR_DEVICE_INFO_LOW_POWER_EVENTS_EXP#
[ur_bool_t] returns true if the device supports low-power events.
-
enumerator UR_DEVICE_INFO_2D_BLOCK_ARRAY_CAPABILITIES_EXP#
[ur_exp_device_2d_block_array_capability_flags_t] return a bit-field of Intel GPU 2D block array capabilities
-
enumerator UR_DEVICE_INFO_TYPE#
ur_device_affinity_domain_flags_t#
-
enum ur_device_affinity_domain_flag_t#
Values:
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA#
Split the device into sub devices comprised of compute units that share a NUMA node.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE#
Split the device into sub devices comprised of compute units that share a level 4 data cache.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE#
Split the device into sub devices comprised of compute units that share a level 3 data cache.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE#
Split the device into sub devices comprised of compute units that share a level 2 data cache.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE#
Split the device into sub devices comprised of compute units that share a level 1 data cache.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_NEXT_PARTITIONABLE#
Split the device along the next partitionable affinity domain. The implementation shall find the first level along which the device or sub device may be further subdivided in the order: UR_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, UR_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, UR_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE, and partition the device into sub devices comprised of compute units that share memory subsystems at this level.
-
enumerator UR_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA#
ur_device_partition_t#
-
enum ur_device_partition_t#
Partition Properties.
Values:
-
enumerator UR_DEVICE_PARTITION_EQUALLY#
Partition Equally.
-
enumerator UR_DEVICE_PARTITION_BY_COUNTS#
Partition by counts.
-
enumerator UR_DEVICE_PARTITION_BY_AFFINITY_DOMAIN#
Partition by affinity domain.
-
enumerator UR_DEVICE_PARTITION_BY_CSLICE#
Partition by c-slice
-
enumerator UR_DEVICE_PARTITION_EQUALLY#
ur_device_fp_capability_flags_t#
-
enum ur_device_fp_capability_flag_t#
Values:
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_CORRECTLY_ROUNDED_DIVIDE_SQRT#
Support correctly rounded divide and sqrt.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_ROUND_TO_NEAREST#
Support round to nearest.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_ROUND_TO_ZERO#
Support round to zero.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_ROUND_TO_INF#
Support round to infinity.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_INF_NAN#
Support INF to NAN.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_DENORM#
Support denorm.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_FMA#
Support FMA.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_SOFT_FLOAT#
Basic floating point operations implemented in software.
-
enumerator UR_DEVICE_FP_CAPABILITY_FLAG_CORRECTLY_ROUNDED_DIVIDE_SQRT#
ur_device_mem_cache_type_t#
ur_device_local_mem_type_t#
ur_device_exec_capability_flags_t#
ur_memory_order_capability_flags_t#
-
enum ur_memory_order_capability_flag_t#
Values:
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_RELAXED#
Relaxed memory ordering.
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_ACQUIRE#
Acquire memory ordering.
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_RELEASE#
Release memory ordering.
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_ACQ_REL#
Acquire/release memory ordering.
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_SEQ_CST#
Sequentially consistent memory ordering
-
enumerator UR_MEMORY_ORDER_CAPABILITY_FLAG_RELAXED#
ur_memory_scope_capability_flags_t#
-
enum ur_memory_scope_capability_flag_t#
Values:
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_WORK_ITEM#
Work item scope.
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_SUB_GROUP#
Sub group scope.
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_WORK_GROUP#
Work group scope.
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_DEVICE#
Device scope.
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_SYSTEM#
System scope
-
enumerator UR_MEMORY_SCOPE_CAPABILITY_FLAG_WORK_ITEM#
ur_device_usm_access_capability_flags_t#
-
enum ur_device_usm_access_capability_flag_t#
Values:
-
enumerator UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_ACCESS#
Memory can be accessed.
-
enumerator UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_ATOMIC_ACCESS#
Memory can be accessed atomically.
-
enumerator UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_CONCURRENT_ACCESS#
Memory can be accessed concurrently.
-
enumerator UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_ATOMIC_CONCURRENT_ACCESS#
Memory can be accessed atomically and concurrently
-
enumerator UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_ACCESS#
Device Structures#
ur_device_binary_t#
-
struct ur_device_binary_t#
Device Binary Type.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_DEVICE_BINARY
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
const char *pDeviceTargetSpec#
[in] null-terminated string representation of the device’s target architecture. For example:
-
ur_structure_type_t stype#
ur_device_partition_value_t#
-
union ur_device_partition_value_t#
- #include <>
Device partition value.
Public Members
-
uint32_t equally#
[in] Number of compute units per sub-device when partitioning with UR_DEVICE_PARTITION_EQUALLY.
-
uint32_t count#
[in] Number of compute units in a sub-device when partitioning with UR_DEVICE_PARTITION_BY_COUNTS.
-
ur_device_affinity_domain_flags_t affinity_domain#
[in] The affinity domain to partition for when partitioning with UR_DEVICE_PARTITION_BY_AFFINITY_DOMAIN.
-
uint32_t equally#
ur_device_partition_property_t#
-
struct ur_device_partition_property_t#
Device partition property.
Public Members
-
ur_device_partition_t type#
[in] The partitioning type to be used.
-
ur_device_partition_value_t value#
[in][tagged_by(type)] The partitioning value.
-
ur_device_partition_t type#
ur_device_partition_properties_t#
-
struct ur_device_partition_properties_t#
Device Partition Properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_DEVICE_PARTITION_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
const ur_device_partition_property_t *pProperties#
[in] Pointer to the beginning of the properties array.
-
size_t PropCount#
[in] The length of properties pointed to by
pProperties
.
-
ur_structure_type_t stype#
ur_device_native_properties_t#
-
struct ur_device_native_properties_t#
Native device creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_DEVICE_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Device Macros#
UR_DEVICE_BINARY_TARGET_UNKNOWN#
-
UR_DEVICE_BINARY_TARGET_UNKNOWN#
Target identification strings for ur_device_binary_t.pDeviceTargetSpec 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.
UR_DEVICE_BINARY_TARGET_SPIRV32#
-
UR_DEVICE_BINARY_TARGET_SPIRV32#
SPIR-V 32-bit image <-> “spir”, 32-bit OpenCL device.
UR_DEVICE_BINARY_TARGET_SPIRV64#
-
UR_DEVICE_BINARY_TARGET_SPIRV64#
SPIR-V 64-bit image <-> “spir64”, 64-bit OpenCL device.
UR_DEVICE_BINARY_TARGET_SPIRV64_X86_64#
-
UR_DEVICE_BINARY_TARGET_SPIRV64_X86_64#
Device-specific binary images produced from SPIR-V 64-bit <-> various “spir64_*” triples for specific 64-bit OpenCL CPU devices.
UR_DEVICE_BINARY_TARGET_SPIRV64_GEN#
-
UR_DEVICE_BINARY_TARGET_SPIRV64_GEN#
Generic GPU device (64-bit OpenCL)
UR_DEVICE_BINARY_TARGET_SPIRV64_FPGA#
-
UR_DEVICE_BINARY_TARGET_SPIRV64_FPGA#
64-bit OpenCL FPGA device
Context#
Functions
Enumerations
Structures
Typedefs
Context Functions#
urContextCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextCreate(uint32_t DeviceCount, const ur_device_handle_t *phDevices, const ur_context_properties_t *pProperties, ur_context_handle_t *phContext)#
Creates a context with the given devices.
All devices should be from the same platform.
Context is used for resource sharing between all the devices associated with it.
Context also serves for resource isolation such that resources do not cross context boundaries.
The returned context is a reference and must be released with a subsequent call to urContextRelease.
The application may call this function from simultaneous threads.
The implementation of this function must be thread-safe.
Remark
Analogues
clCreateContext
- Parameters
DeviceCount – [in] the number of devices given in phDevices
phDevices – [in][range(0, DeviceCount)] array of handle of devices.
pProperties – [in][optional] pointer to context creation properties.
phContext – [out] pointer to handle of context object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevices
NULL == phContext
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_CONTEXT_FLAGS_MASK & pProperties->flags
urContextRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextRetain(ur_context_handle_t hContext)#
Makes a reference of the context handle indicating it’s in use until paired urContextRelease is called.
It is not valid to use a context handle, which has all of its references released.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clRetainContext
- Parameters
hContext – [in][retain] handle of the context to get a reference of.
- Returns
urContextRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextRelease(ur_context_handle_t hContext)#
Releases the context handle reference indicating end of its usage.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
Remark
Analogues
clReleaseContext
- Parameters
hContext – [in][release] handle of the context to release.
- Returns
urContextGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextGetInfo(ur_context_handle_t hContext, ur_context_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieves various information about context.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clGetContextInfo
- Parameters
hContext – [in] handle of the context
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes of memory pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. if propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urContextGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextGetNativeHandle(ur_context_handle_t hContext, ur_native_handle_t *phNativeContext)#
Return platform native context handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hContext – [in] handle of the context.
phNativeContext – [out] a pointer to the native handle of the context.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeContext
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urContextCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextCreateWithNativeHandle(ur_native_handle_t hNativeContext, ur_adapter_handle_t hAdapter, uint32_t numDevices, const ur_device_handle_t *phDevices, const ur_context_native_properties_t *pProperties, ur_context_handle_t *phContext)#
Create runtime context object from native context handle.
Creates runtime context handle from native driver context handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeContext – [in][nocheck] the native handle of the context.
hAdapter – [in] handle of the adapter that owns the native handle
numDevices – [in] number of devices associated with the context
phDevices – [in][optional][range(0, numDevices)] list of devices associated with the context
pProperties – [in][optional] pointer to native context properties struct
phContext – [out] pointer to the handle of the context object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hAdapter
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phContext
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urContextSetExtendedDeleter#
-
UR_APIEXPORT ur_result_t UR_APICALL urContextSetExtendedDeleter(ur_context_handle_t hContext, ur_context_extended_deleter_t pfnDeleter, void *pUserData)#
Call extended deleter function as callback.
Calls extended deleter, a user-defined callback to delete context on some platforms.
This is done for performance reasons.
This API might be called directly by an application instead of a runtime backend.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hContext – [in] handle of the context.
pfnDeleter – [in] Function pointer to extended deleter.
pUserData – [in][out][optional] pointer to data to be passed to callback.
- Returns
Context Enums#
ur_context_flags_t#
ur_context_info_t#
-
enum ur_context_info_t#
Supported context info.
Values:
-
enumerator UR_CONTEXT_INFO_NUM_DEVICES#
[uint32_t] The number of the devices in the context
-
enumerator UR_CONTEXT_INFO_DEVICES#
[ur_device_handle_t[]] The array of the device handles in the context
-
enumerator UR_CONTEXT_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the context object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_CONTEXT_INFO_USM_MEMCPY2D_SUPPORT#
[ur_bool_t] to indicate if the urEnqueueUSMMemcpy2D entrypoint is supported.
-
enumerator UR_CONTEXT_INFO_USM_FILL2D_SUPPORT#
[ur_bool_t] to indicate if the urEnqueueUSMFill2D entrypoint is supported.
-
enumerator UR_CONTEXT_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES#
[ur_memory_order_capability_flags_t][optional-query] return a bit-field of atomic memory order capabilities.
-
enumerator UR_CONTEXT_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES#
[ur_memory_scope_capability_flags_t][optional-query] return a bit-field of atomic memory scope capabilities.
-
enumerator UR_CONTEXT_INFO_ATOMIC_FENCE_ORDER_CAPABILITIES#
[ur_memory_order_capability_flags_t][optional-query] return a bit-field of atomic memory fence order capabilities. Zero is returned if the backend does not support context-level fences.
-
enumerator UR_CONTEXT_INFO_ATOMIC_FENCE_SCOPE_CAPABILITIES#
[ur_memory_scope_capability_flags_t][optional-query] return a bit-field of atomic memory fence scope capabilities. Zero is returned if the backend does not support context-level fences.
-
enumerator UR_CONTEXT_INFO_NUM_DEVICES#
Context Structures#
ur_context_properties_t#
-
struct ur_context_properties_t#
Context creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_CONTEXT_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_context_flags_t flags#
[in] context creation flags.
-
ur_structure_type_t stype#
ur_context_native_properties_t#
-
struct ur_context_native_properties_t#
Properties for for urContextCreateWithNativeHandle.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_CONTEXT_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Memory#
Functions
Enumerations
Structures
Memory Functions#
urMemImageCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemImageCreate(ur_context_handle_t hContext, ur_mem_flags_t flags, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, void *pHost, ur_mem_handle_t *phMem)#
Create an image object.
The primary ur_image_format_t that must be supported by all the adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT32}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_HALF_FLOAT}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_FLOAT}.
Remark
Analogues
clCreateImage
- Parameters
hContext – [in] handle of the context object
flags – [in] allocation and usage information flags
pImageFormat – [in] pointer to image format specification
pImageDesc – [in] pointer to image description
pHost – [in][optional] pointer to the buffer data
phMem – [out] pointer to handle of image object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_MEM_FLAGS_MASK & flags
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phMem
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pImageDesc && UR_STRUCTURE_TYPE_IMAGE_DESC != pImageDesc->stype
pImageDesc && UR_MEM_TYPE_IMAGE1D_ARRAY < pImageDesc->type
pImageDesc && pImageDesc->numMipLevel != 0
pImageDesc && pImageDesc->numSamples != 0
pImageDesc && pImageDesc->rowPitch != 0 && pHost == nullptr
pImageDesc && pImageDesc->slicePitch != 0 && pHost == nullptr
UR_RESULT_ERROR_INVALID_HOST_PTR
pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0
pHost != NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) == 0
urMemBufferCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemBufferCreate(ur_context_handle_t hContext, ur_mem_flags_t flags, size_t size, const ur_buffer_properties_t *pProperties, ur_mem_handle_t *phBuffer)#
Create a memory buffer.
See also ur_buffer_channel_properties_t.
See also ur_buffer_alloc_location_properties_t.
Remark
Analogues
clCreateBuffer
- Parameters
hContext – [in] handle of the context object
flags – [in] allocation and usage information flags
size – [in] size in bytes of the memory object to be allocated
pProperties – [in][optional] pointer to buffer creation properties
phBuffer – [out] pointer to handle of the memory buffer created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_MEM_FLAGS_MASK & flags
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phBuffer
UR_RESULT_ERROR_INVALID_BUFFER_SIZE
size == 0
UR_RESULT_ERROR_INVALID_HOST_PTR
pProperties == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0
pProperties != NULL && pProperties->pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0
pProperties != NULL && pProperties->pHost != NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) == 0
urMemRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemRetain(ur_mem_handle_t hMem)#
Get a reference the memory object. Increment the memory object’s reference count.
Useful in library function to retain access to the memory object after the caller released the object
Remark
Analogues
clRetainMemoryObject
- Parameters
hMem – [in][retain] handle of the memory object to get access
- Returns
urMemRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemRelease(ur_mem_handle_t hMem)#
Decrement the memory object’s reference count and delete the object if the reference count becomes zero.
Remark
Analogues
clReleaseMemoryObject
- Parameters
hMem – [in][release] handle of the memory object to release
- Returns
urMemBufferPartition#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemBufferPartition(ur_mem_handle_t hBuffer, ur_mem_flags_t flags, ur_buffer_create_type_t bufferCreateType, const ur_buffer_region_t *pRegion, ur_mem_handle_t *phMem)#
Create a sub buffer representing a region in an existing buffer.
Remark
Analogues
clCreateSubBuffer
- Parameters
hBuffer – [in] handle of the buffer object to allocate from
flags – [in] allocation and usage information flags
bufferCreateType – [in] buffer creation type
pRegion – [in] pointer to buffer create region information
phMem – [out] pointer to the handle of sub buffer created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hBuffer
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_MEM_FLAGS_MASK & flags
UR_BUFFER_CREATE_TYPE_REGION < bufferCreateType
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pRegion
NULL == phMem
UR_RESULT_ERROR_INVALID_BUFFER_SIZE
pRegion && pRegion->size == 0
hBuffer allocation size < (pRegion->origin + pRegion->size)
urMemGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemGetNativeHandle(ur_mem_handle_t hMem, ur_device_handle_t hDevice, ur_native_handle_t *phNativeMem)#
Return platform native mem handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
The implementation may require a valid device handle to return the native mem handle
- Parameters
hMem – [in] handle of the mem.
hDevice – [in][optional] handle of the device that the native handle will be resident on.
phNativeMem – [out] a pointer to the native handle of the mem.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hMem
If
hDevice == NULL
and the implementation requires a valid device.
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeMem
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urMemBufferCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemBufferCreateWithNativeHandle(ur_native_handle_t hNativeMem, ur_context_handle_t hContext, const ur_mem_native_properties_t *pProperties, ur_mem_handle_t *phMem)#
Create runtime buffer memory object from native memory handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeMem – [in][nocheck] the native handle to the memory.
hContext – [in] handle of the context object.
pProperties – [in][optional] pointer to native memory creation properties.
phMem – [out] pointer to handle of buffer memory object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phMem
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urMemImageCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemImageCreateWithNativeHandle(ur_native_handle_t hNativeMem, ur_context_handle_t hContext, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, const ur_mem_native_properties_t *pProperties, ur_mem_handle_t *phMem)#
Create runtime image memory object from native memory handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeMem – [in][nocheck] the native handle to the memory.
hContext – [in] handle of the context object.
pImageFormat – [in] pointer to image format specification.
pImageDesc – [in] pointer to image description.
pProperties – [in][optional] pointer to native memory creation properties.
phMem – [out] pointer to handle of image memory object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phMem
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urMemGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemGetInfo(ur_mem_handle_t hMemory, ur_mem_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieve information about a memory object.
Query information that is common to all memory objects.
Remark
Analogues
clGetMemObjectInfo
- Parameters
hMemory – [in] handle to the memory object being queried.
propName – [in] type of the info to retrieve.
propSize – [in] the number of bytes of memory pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is less than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hMemory
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_MEM_INFO_REFERENCE_COUNT < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urMemImageGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urMemImageGetInfo(ur_mem_handle_t hMemory, ur_image_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Retrieve information about an image object.
Query information specific to an image object.
Remark
Analogues
clGetImageInfo
- Parameters
hMemory – [in] handle to the image object being queried.
propName – [in] type of image info to retrieve.
propSize – [in] the number of bytes of memory pointer to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is less than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hMemory
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_IMAGE_INFO_DEPTH < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
Memory Enums#
ur_mem_flags_t#
-
enum ur_mem_flag_t#
Values:
-
enumerator UR_MEM_FLAG_READ_WRITE#
The memory object will be read and written by a kernel. This is the default
-
enumerator UR_MEM_FLAG_WRITE_ONLY#
The memory object will be written but not read by a kernel.
-
enumerator UR_MEM_FLAG_READ_ONLY#
The memory object is a read-only inside a kernel.
-
enumerator UR_MEM_FLAG_USE_HOST_POINTER#
Use memory pointed by a host pointer parameter as the storage bits for the memory object
-
enumerator UR_MEM_FLAG_ALLOC_HOST_POINTER#
Allocate memory object from host accessible memory.
-
enumerator UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER#
Allocate memory and copy the data from host pointer pointed memory
-
enumerator UR_MEM_FLAG_READ_WRITE#
ur_mem_type_t#
-
enum ur_mem_type_t#
Memory types.
Values:
-
enumerator UR_MEM_TYPE_IMAGE2D#
2D image object
-
enumerator UR_MEM_TYPE_IMAGE3D#
3D image object
-
enumerator UR_MEM_TYPE_IMAGE2D_ARRAY#
2D image array object
-
enumerator UR_MEM_TYPE_IMAGE1D#
1D image object
-
enumerator UR_MEM_TYPE_IMAGE1D_ARRAY#
1D image array object
-
enumerator UR_MEM_TYPE_IMAGE_CUBEMAP_EXP#
Experimental cubemap image object
-
enumerator UR_MEM_TYPE_IMAGE2D#
ur_mem_info_t#
-
enum ur_mem_info_t#
Memory Information type.
Values:
-
enumerator UR_MEM_INFO_SIZE#
[size_t] actual size of the memory object in bytes
-
enumerator UR_MEM_INFO_CONTEXT#
[ur_context_handle_t] context in which the memory object was created
-
enumerator UR_MEM_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the memory object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_MEM_INFO_SIZE#
ur_image_channel_order_t#
-
enum ur_image_channel_order_t#
Image channel order info: number of channels and the channel layout.
Values:
-
enumerator UR_IMAGE_CHANNEL_ORDER_A#
channel order A
-
enumerator UR_IMAGE_CHANNEL_ORDER_R#
channel order R
-
enumerator UR_IMAGE_CHANNEL_ORDER_RG#
channel order RG
-
enumerator UR_IMAGE_CHANNEL_ORDER_RA#
channel order RA
-
enumerator UR_IMAGE_CHANNEL_ORDER_RGB#
channel order RGB
-
enumerator UR_IMAGE_CHANNEL_ORDER_RGBA#
channel order RGBA
-
enumerator UR_IMAGE_CHANNEL_ORDER_BGRA#
channel order BGRA
-
enumerator UR_IMAGE_CHANNEL_ORDER_ARGB#
channel order ARGB
-
enumerator UR_IMAGE_CHANNEL_ORDER_ABGR#
channel order ABGR
-
enumerator UR_IMAGE_CHANNEL_ORDER_INTENSITY#
channel order intensity
-
enumerator UR_IMAGE_CHANNEL_ORDER_LUMINANCE#
channel order luminance
-
enumerator UR_IMAGE_CHANNEL_ORDER_RX#
channel order Rx
-
enumerator UR_IMAGE_CHANNEL_ORDER_RGX#
channel order RGx
-
enumerator UR_IMAGE_CHANNEL_ORDER_RGBX#
channel order RGBx
-
enumerator UR_IMAGE_CHANNEL_ORDER_SRGBA#
channel order sRGBA
-
enumerator UR_IMAGE_CHANNEL_ORDER_A#
ur_image_channel_type_t#
-
enum ur_image_channel_type_t#
Image channel type info: describe the size of the channel data type.
Values:
-
enumerator UR_IMAGE_CHANNEL_TYPE_SNORM_INT8#
channel type snorm int8
-
enumerator UR_IMAGE_CHANNEL_TYPE_SNORM_INT16#
channel type snorm int16
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNORM_INT8#
channel type unorm int8
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNORM_INT16#
channel type unorm int16
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNORM_SHORT_565#
channel type unorm short 565
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNORM_SHORT_555#
channel type unorm short 555
-
enumerator UR_IMAGE_CHANNEL_TYPE_INT_101010#
channel type int 101010
-
enumerator UR_IMAGE_CHANNEL_TYPE_SIGNED_INT8#
channel type signed int8
-
enumerator UR_IMAGE_CHANNEL_TYPE_SIGNED_INT16#
channel type signed int16
-
enumerator UR_IMAGE_CHANNEL_TYPE_SIGNED_INT32#
channel type signed int32
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8#
channel type unsigned int8
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16#
channel type unsigned int16
-
enumerator UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32#
channel type unsigned int32
-
enumerator UR_IMAGE_CHANNEL_TYPE_HALF_FLOAT#
channel type half float
-
enumerator UR_IMAGE_CHANNEL_TYPE_FLOAT#
channel type float
-
enumerator UR_IMAGE_CHANNEL_TYPE_SNORM_INT8#
ur_image_info_t#
-
enum ur_image_info_t#
Image information types.
Values:
-
enumerator UR_IMAGE_INFO_FORMAT#
[ur_image_format_t] image format
-
enumerator UR_IMAGE_INFO_ELEMENT_SIZE#
[size_t] element size
-
enumerator UR_IMAGE_INFO_ROW_PITCH#
[size_t] row pitch
-
enumerator UR_IMAGE_INFO_SLICE_PITCH#
[size_t] slice pitch
-
enumerator UR_IMAGE_INFO_WIDTH#
[size_t] image width
-
enumerator UR_IMAGE_INFO_HEIGHT#
[size_t] image height
-
enumerator UR_IMAGE_INFO_DEPTH#
[size_t] image depth
-
enumerator UR_IMAGE_INFO_FORMAT#
Memory Structures#
ur_image_format_t#
-
struct ur_image_format_t#
Image format including channel layout and data type.
Public Members
-
ur_image_channel_order_t channelOrder#
[in] image channel order
-
ur_image_channel_type_t channelType#
[in] image channel type
-
ur_image_channel_order_t channelOrder#
ur_image_desc_t#
-
struct ur_image_desc_t#
Image descriptor type.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_IMAGE_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_mem_type_t type#
[in][nocheck] memory object type
-
size_t width#
[in] image width
-
size_t height#
[in] image height
-
size_t depth#
[in] image depth
-
size_t arraySize#
[in] image array size
-
size_t rowPitch#
[in] image row pitch
-
size_t slicePitch#
[in] image slice pitch
-
uint32_t numMipLevel#
[in] number of MIP levels, must be
0
-
uint32_t numSamples#
[in] number of samples, must be
0
-
ur_structure_type_t stype#
ur_buffer_properties_t#
-
struct ur_buffer_properties_t#
Buffer creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_BUFFER_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
void *pHost#
[in][optional] pointer to the buffer data
-
ur_structure_type_t stype#
ur_buffer_channel_properties_t#
-
struct ur_buffer_channel_properties_t#
Buffer memory channel creation properties.
Specify these properties in urMemBufferCreate via ur_buffer_properties_t as part of a
pNext
chain.
Remark
Analogues
cl_intel_mem_channel_property
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_BUFFER_CHANNEL_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
uint32_t channel#
[in] Identifies the channel/region to which the buffer should be mapped.
ur_buffer_alloc_location_properties_t#
-
struct ur_buffer_alloc_location_properties_t#
Buffer allocation location creation properties.
Specify these properties in urMemBufferCreate via ur_buffer_properties_t as part of a
pNext
chain.
Remark
Analogues
cl_intel_mem_alloc_buffer_location
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_BUFFER_ALLOC_LOCATION_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
uint32_t location#
[in] Identifies the ID of global memory partition to which the memory should be allocated.
ur_buffer_region_t#
-
struct ur_buffer_region_t#
Buffer region type, used to describe a sub buffer.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_BUFFER_REGION
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
size_t origin#
[in] buffer origin offset
-
size_t size#
[in] size of the buffer region
-
ur_structure_type_t stype#
ur_mem_native_properties_t#
-
struct ur_mem_native_properties_t#
Native memory object creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_MEM_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Sampler#
Functions
Enumerations
Structures
Sampler Functions#
urSamplerCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerCreate(ur_context_handle_t hContext, const ur_sampler_desc_t *pDesc, ur_sampler_handle_t *phSampler)#
Create a sampler object in a context.
The props parameter specifies a list of sampler property names and their corresponding values.
The list is terminated with 0. If the list is NULL, default values will be used.
Remark
Analogues
clCreateSamplerWithProperties
- Parameters
hContext – [in] handle of the context object
pDesc – [in] pointer to the sampler description
phSampler – [out] pointer to handle of sampler object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDesc
NULL == phSampler
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_SAMPLER_ADDRESSING_MODE_MIRRORED_REPEAT < pDesc->addressingMode
UR_SAMPLER_FILTER_MODE_LINEAR < pDesc->filterMode
urSamplerRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerRetain(ur_sampler_handle_t hSampler)#
Get a reference to the sampler object handle. Increment its reference count.
Remark
Analogues
clRetainSampler
- Parameters
hSampler – [in][retain] handle of the sampler object to get access
- Returns
urSamplerRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerRelease(ur_sampler_handle_t hSampler)#
Decrement the sampler’s reference count and delete the sampler if the reference count becomes zero.
Remark
Analogues
clReleaseSampler
- Parameters
hSampler – [in][release] handle of the sampler object to release
- Returns
urSamplerGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerGetInfo(ur_sampler_handle_t hSampler, ur_sampler_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query information about a sampler object.
Remark
Analogues
clGetSamplerInfo
- Parameters
hSampler – [in] handle of the sampler object
propName – [in] name of the sampler property to query
propSize – [in] size in bytes of the sampler property value provided
pPropValue – [out][typename(propName, propSize)][optional] value of the sampler property
pPropSizeRet – [out][optional] size in bytes returned in sampler property value
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hSampler
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_SAMPLER_INFO_FILTER_MODE < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urSamplerGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerGetNativeHandle(ur_sampler_handle_t hSampler, ur_native_handle_t *phNativeSampler)#
Return sampler native sampler handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability sampler extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hSampler – [in] handle of the sampler.
phNativeSampler – [out] a pointer to the native handle of the sampler.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hSampler
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeSampler
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urSamplerCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urSamplerCreateWithNativeHandle(ur_native_handle_t hNativeSampler, ur_context_handle_t hContext, const ur_sampler_native_properties_t *pProperties, ur_sampler_handle_t *phSampler)#
Create runtime sampler object from native sampler handle.
Creates runtime sampler handle from native driver sampler handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeSampler – [in][nocheck] the native handle of the sampler.
hContext – [in] handle of the context object
pProperties – [in][optional] pointer to native sampler properties struct.
phSampler – [out] pointer to the handle of the sampler object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phSampler
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
Sampler Enums#
ur_sampler_filter_mode_t#
ur_sampler_addressing_mode_t#
-
enum ur_sampler_addressing_mode_t#
Sampler addressing mode.
Values:
-
enumerator UR_SAMPLER_ADDRESSING_MODE_NONE#
None.
-
enumerator UR_SAMPLER_ADDRESSING_MODE_CLAMP_TO_EDGE#
Clamp to edge.
-
enumerator UR_SAMPLER_ADDRESSING_MODE_CLAMP#
Clamp.
-
enumerator UR_SAMPLER_ADDRESSING_MODE_REPEAT#
Repeat.
-
enumerator UR_SAMPLER_ADDRESSING_MODE_MIRRORED_REPEAT#
Mirrored Repeat
-
enumerator UR_SAMPLER_ADDRESSING_MODE_NONE#
ur_sampler_info_t#
-
enum ur_sampler_info_t#
Get sample object information.
Values:
-
enumerator UR_SAMPLER_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the sampler object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_SAMPLER_INFO_CONTEXT#
[ur_context_handle_t] Sampler context info
-
enumerator UR_SAMPLER_INFO_ADDRESSING_MODE#
[ur_sampler_addressing_mode_t] Sampler addressing mode setting
-
enumerator UR_SAMPLER_INFO_FILTER_MODE#
[ur_sampler_filter_mode_t] Sampler filter mode setting
-
enumerator UR_SAMPLER_INFO_REFERENCE_COUNT#
Sampler Structures#
ur_sampler_desc_t#
-
struct ur_sampler_desc_t#
Sampler description.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_SAMPLER_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
bool normalizedCoords#
[in] Specify if image coordinates are normalized (true) or not (false)
-
ur_sampler_addressing_mode_t addressingMode#
[in] Specify the address mode of the sampler
-
ur_sampler_filter_mode_t filterMode#
[in] Specify the filter mode of the sampler
-
ur_structure_type_t stype#
ur_sampler_native_properties_t#
-
struct ur_sampler_native_properties_t#
Native sampler creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_SAMPLER_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Usm#
Functions
Enumerations
Structures
Usm Functions#
urUSMHostAlloc#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMHostAlloc(ur_context_handle_t hContext, const ur_usm_desc_t *pUSMDesc, ur_usm_pool_handle_t pool, size_t size, void **ppMem)#
USM allocate host memory.
If pUSMDesc is not NULL and pUSMDesc->pool is not NULL the allocation will be served from a specified memory pool.
Otherwise, the behavior is implementation-defined.
Allocations served from different memory pools must be isolated and must not reside on the same page.
Any flags/hints passed through pUSMDesc only affect the single allocation.
See also ur_usm_host_desc_t.
See also ur_usm_alloc_location_desc_t.
- Parameters
hContext – [in] handle of the context object
pUSMDesc – [in][optional] USM memory allocation descriptor
pool – [in][optional] Pointer to a pool created using urUSMPoolCreate
size – [in] minimum size in bytes of the USM memory object to be allocated
ppMem – [out] pointer to USM host memory object
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pUSMDesc && UR_USM_ADVICE_FLAGS_MASK & pUSMDesc->hints
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppMem
UR_RESULT_ERROR_INVALID_OPERATION
If UR_DEVICE_INFO_USM_HOST_SUPPORT is false.
pUSMDesc && pUSMDesc->align != 0 && ((pUSMDesc->align & (pUSMDesc->align-1)) != 0)
If
align
is greater that the size of the largest data type supported byhDevice
.
UR_RESULT_ERROR_INVALID_USM_SIZE
size == 0
size
is greater than UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If any device associated with
hContext
reportsfalse
for UR_DEVICE_INFO_USM_POOL_SUPPORT
urUSMDeviceAlloc#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMDeviceAlloc(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_usm_desc_t *pUSMDesc, ur_usm_pool_handle_t pool, size_t size, void **ppMem)#
USM allocate device memory.
If pUSMDesc is not NULL and pUSMDesc->pool is not NULL the allocation will be served from a specified memory pool.
Otherwise, the behavior is implementation-defined.
Allocations served from different memory pools must be isolated and must not reside on the same page.
Any flags/hints passed through pUSMDesc only affect the single allocation.
See also ur_usm_device_desc_t.
See also ur_usm_alloc_location_desc_t.
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
pUSMDesc – [in][optional] USM memory allocation descriptor
pool – [in][optional] Pointer to a pool created using urUSMPoolCreate
size – [in] minimum size in bytes of the USM memory object to be allocated
ppMem – [out] pointer to USM device memory object
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pUSMDesc && UR_USM_ADVICE_FLAGS_MASK & pUSMDesc->hints
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppMem
UR_RESULT_ERROR_INVALID_OPERATION
If UR_DEVICE_INFO_USM_HOST_SUPPORT is false.
pUSMDesc && pUSMDesc->align != 0 && ((pUSMDesc->align & (pUSMDesc->align-1)) != 0)
If
align
is greater that the size of the largest data type supported byhDevice
.
UR_RESULT_ERROR_INVALID_USM_SIZE
size == 0
size
is greater than UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If any device associated with
hContext
reportsfalse
for UR_DEVICE_INFO_USM_POOL_SUPPORT
urUSMFree#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMFree(ur_context_handle_t hContext, void *pMem)#
Free the USM memory object.
Note that implementations are required to wait for previously enqueued commands that may be accessing
pMem
to finish before freeing the memory.
- Parameters
hContext – [in] handle of the context object
pMem – [in] pointer to USM memory object
- Returns
urUSMGetMemAllocInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMGetMemAllocInfo(ur_context_handle_t hContext, const void *pMem, ur_usm_alloc_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get USM memory object allocation information.
- Parameters
hContext – [in] handle of the context object
pMem – [in] pointer to USM memory object
propName – [in] the name of the USM allocation property to query
propSize – [in] size in bytes of the USM allocation property value
pPropValue – [out][optional][typename(propName, propSize)] value of the USM allocation property
pPropSizeRet – [out][optional] bytes returned in USM allocation property
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMem
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_ALLOC_INFO_POOL < propName
urUSMPoolCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMPoolCreate(ur_context_handle_t hContext, ur_usm_pool_desc_t *pPoolDesc, ur_usm_pool_handle_t *ppPool)#
Create USM memory pool with desired properties.
UR can create multiple instances of the pool depending on allocation requests.
See also ur_usm_pool_limits_desc_t.
- Parameters
hContext – [in] handle of the context object
pPoolDesc – [in] pointer to USM pool descriptor. Can be chained with ur_usm_pool_limits_desc_t
ppPool – [out] pointer to USM memory pool
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pPoolDesc
NULL == ppPool
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_POOL_FLAGS_MASK & pPoolDesc->flags
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If any device associated with
hContext
reportsfalse
for UR_DEVICE_INFO_USM_POOL_SUPPORT
urUSMPoolRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMPoolRetain(ur_usm_pool_handle_t pPool)#
Get a reference to the pool handle. Increment its reference count.
- Parameters
pPool – [in][retain] pointer to USM memory pool
- Returns
urUSMPoolRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMPoolRelease(ur_usm_pool_handle_t pPool)#
Decrement the pool’s reference count and delete the pool if the reference count becomes zero.
All allocation belonging to the pool must be freed prior to the the reference count becoming zero.
If the pool is deleted, this function returns all its reserved memory to the driver.
- Parameters
pPool – [in][release] pointer to USM memory pool
- Returns
urUSMPoolGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMPoolGetInfo(ur_usm_pool_handle_t hPool, ur_usm_pool_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query information about a USM memory pool.
- Parameters
hPool – [in] handle of the USM memory pool
propName – [in] name of the pool property to query
propSize – [in] size in bytes of the pool property value provided
pPropValue – [out][optional][typename(propName, propSize)] value of the pool property
pPropSizeRet – [out][optional] size in bytes returned in pool property value
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hPool
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_POOL_INFO_CONTEXT < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
Usm Enums#
ur_usm_host_mem_flags_t#
ur_usm_device_mem_flags_t#
-
enum ur_usm_device_mem_flag_t#
Values:
-
enumerator UR_USM_DEVICE_MEM_FLAG_WRITE_COMBINED#
Memory should be allocated write-combined (WC)
-
enumerator UR_USM_DEVICE_MEM_FLAG_INITIAL_PLACEMENT#
Optimize shared allocation for first access on the device.
-
enumerator UR_USM_DEVICE_MEM_FLAG_DEVICE_READ_ONLY#
Memory is only possibly modified from the host, but read-only in all device code
-
enumerator UR_USM_DEVICE_MEM_FLAG_WRITE_COMBINED#
ur_usm_pool_flags_t#
ur_usm_type_t#
ur_usm_alloc_info_t#
-
enum ur_usm_alloc_info_t#
USM memory allocation information type.
Values:
-
enumerator UR_USM_ALLOC_INFO_TYPE#
[ur_usm_type_t] Memory allocation type info
-
enumerator UR_USM_ALLOC_INFO_BASE_PTR#
[void *] Memory allocation base pointer info
-
enumerator UR_USM_ALLOC_INFO_SIZE#
[size_t] Memory allocation size info
-
enumerator UR_USM_ALLOC_INFO_DEVICE#
[ur_device_handle_t] Memory allocation device info
-
enumerator UR_USM_ALLOC_INFO_POOL#
[ur_usm_pool_handle_t][optional-query] Memory allocation pool info
-
enumerator UR_USM_ALLOC_INFO_TYPE#
ur_usm_advice_flags_t#
-
enum ur_usm_advice_flag_t#
Values:
-
enumerator UR_USM_ADVICE_FLAG_DEFAULT#
The USM memory advice is default.
-
enumerator UR_USM_ADVICE_FLAG_SET_READ_MOSTLY#
Hint that memory will be read from frequently and written to rarely.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_READ_MOSTLY#
Removes the affect of UR_USM_ADVICE_FLAG_SET_READ_MOSTLY.
-
enumerator UR_USM_ADVICE_FLAG_SET_PREFERRED_LOCATION#
Hint that the preferred memory location is the specified device.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_PREFERRED_LOCATION#
Removes the affect of UR_USM_ADVICE_FLAG_SET_PREFERRED_LOCATION.
-
enumerator UR_USM_ADVICE_FLAG_SET_NON_ATOMIC_MOSTLY#
Hint that memory will mostly be accessed non-atomically.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_NON_ATOMIC_MOSTLY#
Removes the affect of UR_USM_ADVICE_FLAG_SET_NON_ATOMIC_MOSTLY.
-
enumerator UR_USM_ADVICE_FLAG_BIAS_CACHED#
Hint that memory should be cached.
-
enumerator UR_USM_ADVICE_FLAG_BIAS_UNCACHED#
Hint that memory should be not be cached.
-
enumerator UR_USM_ADVICE_FLAG_SET_ACCESSED_BY_DEVICE#
Hint that memory will be mostly accessed by the specified device.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_ACCESSED_BY_DEVICE#
Removes the affect of UR_USM_ADVICE_FLAG_SET_ACCESSED_BY_DEVICE.
-
enumerator UR_USM_ADVICE_FLAG_SET_ACCESSED_BY_HOST#
Hint that memory will be mostly accessed by the host.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_ACCESSED_BY_HOST#
Removes the affect of UR_USM_ADVICE_FLAG_SET_ACCESSED_BY_HOST.
-
enumerator UR_USM_ADVICE_FLAG_SET_PREFERRED_LOCATION_HOST#
Hint that the preferred memory location is the host.
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_PREFERRED_LOCATION_HOST#
Removes the affect of UR_USM_ADVICE_FLAG_SET_PREFERRED_LOCATION_HOST.
-
enumerator UR_USM_ADVICE_FLAG_SET_NON_COHERENT_MEMORY#
Hint that memory coherence will be coarse-grained (up-to-date only at kernel boundaries)
-
enumerator UR_USM_ADVICE_FLAG_CLEAR_NON_COHERENT_MEMORY#
Removes the effect of UR_USM_ADVICE_FLAG_SET_NON_COHERENT_MEMORY
-
enumerator UR_USM_ADVICE_FLAG_DEFAULT#
ur_usm_pool_info_t#
-
enum ur_usm_pool_info_t#
Get USM memory pool information.
Values:
-
enumerator UR_USM_POOL_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the pool object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_USM_POOL_INFO_CONTEXT#
[ur_context_handle_t] USM memory pool context info
-
enumerator UR_USM_POOL_INFO_REFERENCE_COUNT#
Usm Structures#
ur_usm_desc_t#
-
struct ur_usm_desc_t#
USM allocation descriptor type.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_usm_advice_flags_t hints#
[in] Memory advice hints
-
uint32_t align#
[in] alignment of the USM memory object Must be zero or a power of 2. Must be equal to or smaller than the size of the largest data type supported by
hDevice
.
-
ur_structure_type_t stype#
ur_usm_host_desc_t#
-
struct ur_usm_host_desc_t#
USM host allocation descriptor type.
Specify these properties in urUSMHostAlloc and urUSMSharedAlloc via ur_usm_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_HOST_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_usm_host_mem_flags_t flags#
[in] host memory allocation flags
ur_usm_device_desc_t#
-
struct ur_usm_device_desc_t#
USM device allocation descriptor type.
Specify these properties in urUSMDeviceAlloc and urUSMSharedAlloc via ur_usm_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_DEVICE_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_usm_device_mem_flags_t flags#
[in] device memory allocation flags.
ur_usm_alloc_location_desc_t#
-
struct ur_usm_alloc_location_desc_t#
USM allocation location desc.
Specify these properties in urUSMHostAlloc, urUSMDeviceAlloc and urUSMSharedAlloc via ur_usm_desc_t as part of a
pNext
chain.
Remark
Analogues
cl_intel_mem_alloc_buffer_location
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_ALLOC_LOCATION_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
uint32_t location#
[in] Identifies the ID of global memory partition to which the memory should be allocated.
ur_usm_pool_desc_t#
-
struct ur_usm_pool_desc_t#
USM pool descriptor type.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_POOL_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_usm_pool_flags_t flags#
[in] memory allocation flags
-
ur_structure_type_t stype#
ur_usm_pool_limits_desc_t#
-
struct ur_usm_pool_limits_desc_t#
USM pool limits descriptor type.
Specify these properties in urUSMPoolCreate via ur_usm_pool_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_USM_POOL_LIMITS_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
size_t maxPoolableSize#
[in] Allocations up to this limit will be subject to pooling
-
size_t minDriverAllocSize#
[in] Minimum allocation size that will be requested from the driver
Virtual memory#
Functions
Enumerations
Structures
Virtual memory Functions#
urVirtualMemGranularityGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemGranularityGetInfo(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_virtual_mem_granularity_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get information about the minimum and recommended granularity of physical and virtual memory.
- Parameters
hContext – [in] handle of the context object.
hDevice – [in][optional] is the device to get the granularity from, if the device is null then the granularity is suitable for all devices in context.
propName – [in] type of the info to query.
propSize – [in] size in bytes of the memory pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is less than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.”
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_VIRTUAL_MEM_GRANULARITY_INFO_RECOMMENDED < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urVirtualMemReserve#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemReserve(ur_context_handle_t hContext, const void *pStart, size_t size, void **ppStart)#
Reserve a virtual memory range.
- Parameters
hContext – [in] handle of the context object.
pStart – [in][optional] pointer to the start of the virtual memory region to reserve, specifying a null value causes the implementation to select a start address.
size – [in] size in bytes of the virtual address range to reserve.
ppStart – [out] pointer to the returned address at the start of reserved virtual memory range.
- Returns
urVirtualMemFree#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemFree(ur_context_handle_t hContext, const void *pStart, size_t size)#
Free a virtual memory range.
- Parameters
hContext – [in] handle of the context object.
pStart – [in] pointer to the start of the virtual memory range to free.
size – [in] size in bytes of the virtual memory range to free.
- Returns
urVirtualMemMap#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemMap(ur_context_handle_t hContext, const void *pStart, size_t size, ur_physical_mem_handle_t hPhysicalMem, size_t offset, ur_virtual_mem_access_flags_t flags)#
Map a virtual memory range to a physical memory handle.
- Parameters
hContext – [in] handle to the context object.
pStart – [in] pointer to the start of the virtual memory range.
size – [in] size in bytes of the virtual memory range to map.
hPhysicalMem – [in] handle of the physical memory to map pStart to.
offset – [in] offset in bytes into the physical memory to map pStart to.
flags – [in] access flags for the physical memory mapping.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hPhysicalMem
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pStart
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_VIRTUAL_MEM_ACCESS_FLAGS_MASK & flags
urVirtualMemUnmap#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemUnmap(ur_context_handle_t hContext, const void *pStart, size_t size)#
Unmap a virtual memory range previously mapped in a context.
After a call to this function, the virtual memory range is left in a state ready to be remapped.
- Parameters
hContext – [in] handle to the context object.
pStart – [in] pointer to the start of the mapped virtual memory range
size – [in] size in bytes of the virtual memory range.
- Returns
urVirtualMemSetAccess#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemSetAccess(ur_context_handle_t hContext, const void *pStart, size_t size, ur_virtual_mem_access_flags_t flags)#
Set the access mode of a mapped virtual memory range.
- Parameters
hContext – [in] handle to the context object.
pStart – [in] pointer to the start of the virtual memory range.
size – [in] size in bytes of the virtual memory range.
flags – [in] access flags to set for the mapped virtual memory range.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pStart
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_VIRTUAL_MEM_ACCESS_FLAGS_MASK & flags
urVirtualMemGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urVirtualMemGetInfo(ur_context_handle_t hContext, const void *pStart, size_t size, ur_virtual_mem_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get information about a mapped virtual memory range.
- Parameters
hContext – [in] handle to the context object.
pStart – [in] pointer to the start of the virtual memory range.
size – [in] size in bytes of the virtual memory range.
propName – [in] type of the info to query.
propSize – [in] size in bytes of the memory pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is less than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.”
- Returns
urPhysicalMemCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urPhysicalMemCreate(ur_context_handle_t hContext, ur_device_handle_t hDevice, size_t size, const ur_physical_mem_properties_t *pProperties, ur_physical_mem_handle_t *phPhysicalMem)#
Create a physical memory handle that virtual memory can be mapped to.
- Parameters
hContext – [in] handle of the context object.
hDevice – [in] handle of the device object.
size – [in] size in bytes of physical memory to allocate, must be a multiple of UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM.
pProperties – [in][optional] pointer to physical memory creation properties.
phPhysicalMem – [out] pointer to handle of physical memory object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_PHYSICAL_MEM_FLAGS_MASK & pProperties->flags
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phPhysicalMem
If size is not a multiple of UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM.
urPhysicalMemRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urPhysicalMemRetain(ur_physical_mem_handle_t hPhysicalMem)#
Retain a physical memory handle, increment its reference count.
- Parameters
hPhysicalMem – [in][retain] handle of the physical memory object to retain.
- Returns
urPhysicalMemRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urPhysicalMemRelease(ur_physical_mem_handle_t hPhysicalMem)#
Release a physical memory handle, decrement its reference count.
- Parameters
hPhysicalMem – [in][release] handle of the physical memory object to release.
- Returns
urPhysicalMemGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPhysicalMemGetInfo(ur_physical_mem_handle_t hPhysicalMem, ur_physical_mem_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get information about a physical memory object.
- Parameters
hPhysicalMem – [in] handle of the physical memory object to query.
propName – [in] type of the info to query.
propSize – [in] size in bytes of the memory pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is less than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.”
- Returns
Virtual memory Enums#
ur_virtual_mem_granularity_info_t#
-
enum ur_virtual_mem_granularity_info_t#
Virtual memory granularity info.
Values:
-
enumerator UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM#
[size_t] size in bytes of the minimum virtual memory granularity.
-
enumerator UR_VIRTUAL_MEM_GRANULARITY_INFO_RECOMMENDED#
[size_t] size in bytes of the recommended virtual memory granularity.
-
enumerator UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM#
ur_virtual_mem_access_flags_t#
ur_virtual_mem_info_t#
ur_physical_mem_flags_t#
ur_physical_mem_info_t#
-
enum ur_physical_mem_info_t#
Physical memory range info queries.
Values:
-
enumerator UR_PHYSICAL_MEM_INFO_CONTEXT#
[ur_context_handle_t] context in which the physical memory object was created.
-
enumerator UR_PHYSICAL_MEM_INFO_DEVICE#
[ur_device_handle_t] device associated with this physical memory object.
-
enumerator UR_PHYSICAL_MEM_INFO_SIZE#
[size_t] actual size of the physical memory object in bytes.
-
enumerator UR_PHYSICAL_MEM_INFO_PROPERTIES#
[ur_physical_mem_properties_t] properties set when creating this physical memory object.
-
enumerator UR_PHYSICAL_MEM_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the physical memory object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_PHYSICAL_MEM_INFO_CONTEXT#
Virtual memory Structures#
ur_physical_mem_properties_t#
-
struct ur_physical_mem_properties_t#
Physical memory creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_PHYSICAL_MEM_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_physical_mem_flags_t flags#
[in] physical memory creation flags
-
ur_structure_type_t stype#
Program#
Functions
Enumerations
Structures
Program Functions#
urProgramCreateWithIL#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramCreateWithIL(ur_context_handle_t hContext, const void *pIL, size_t length, const ur_program_properties_t *pProperties, ur_program_handle_t *phProgram)#
Create a program object from input intermediate language.
The application may call this function from simultaneous threads.
The adapter may (but is not required to) perform validation of the provided module during this call.
Remark
Analogues
clCreateProgramWithIL
- Parameters
hContext – [in] handle of the context instance
pIL – [in] pointer to IL binary.
length – [in] length of `pIL` in bytes.
pProperties – [in][optional] pointer to program creation properties.
phProgram – [out] pointer to handle of program object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pIL
NULL == phProgram
NULL != pProperties && pProperties->count > 0 && NULL == pProperties->pMetadatas
NULL != pProperties && NULL != pProperties->pMetadatas && pProperties->count == 0
length == 0
UR_RESULT_ERROR_INVALID_BINARY
If
pIL
is not a valid IL binary for devices inhContext
.
UR_RESULT_ERROR_COMPILER_NOT_AVAILABLE
If devices in
hContext
don’t have the capability to compile an IL binary at runtime.
urProgramCreateWithBinary#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramCreateWithBinary(ur_context_handle_t hContext, uint32_t numDevices, ur_device_handle_t *phDevices, size_t *pLengths, const uint8_t **ppBinaries, const ur_program_properties_t *pProperties, ur_program_handle_t *phProgram)#
Create a program object from native binaries for the specified devices.
The application may call this function from simultaneous threads.
Following a successful call to this entry point,
phProgram
will contain binaries of type UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or UR_PROGRAM_BINARY_TYPE_LIBRARY for the specified devices inphDevices
.The devices specified by
phDevices
must be associated with the context.The adapter may (but is not required to) perform validation of the provided modules during this call.
Remark
Analogues
clCreateProgramWithBinary
- Parameters
hContext – [in] handle of the context instance
numDevices – [in] number of devices
phDevices – [in][range(0, numDevices)] a pointer to a list of device handles. The binaries are loaded for devices specified in this list.
pLengths – [in][range(0, numDevices)] array of sizes of program binaries specified by `pBinaries` (in bytes).
ppBinaries – [in][range(0, numDevices)] pointer to program binaries to be loaded for devices specified by `phDevices`.
pProperties – [in][optional] pointer to program creation properties.
phProgram – [out] pointer to handle of Program object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevices
NULL == pLengths
NULL == ppBinaries
NULL == phProgram
NULL != pProperties && pProperties->count > 0 && NULL == pProperties->pMetadatas
NULL != pProperties && NULL != pProperties->pMetadatas && pProperties->count == 0
numDevices == 0
UR_RESULT_ERROR_INVALID_NATIVE_BINARY
If any binary in
ppBinaries
isn’t a valid binary for the corresponding device inphDevices.
urProgramBuild#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramBuild(ur_context_handle_t hContext, ur_program_handle_t hProgram, const char *pOptions)#
Produces an executable program from one program, negates need for the linking step.
The application may call this function from simultaneous threads.
Following a successful call to this entry point, the program passed will contain a binary of the UR_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device in
hContext
.
Remark
Analogues
clBuildProgram
- Parameters
hContext – [in] handle of the context instance.
hProgram – [in] Handle of the program to build.
pOptions – [in][optional] pointer to build options null-terminated string.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hProgram
UR_RESULT_ERROR_INVALID_PROGRAM
If
hProgram
isn’t a valid program object.
UR_RESULT_ERROR_PROGRAM_BUILD_FAILURE
If an error occurred when building
hProgram
.
urProgramCompile#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramCompile(ur_context_handle_t hContext, ur_program_handle_t hProgram, const char *pOptions)#
Produces an executable program from one or more programs.
The application may call this function from simultaneous threads.
Following a successful call to this entry point
hProgram
will contain a binary of the UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT type for each device inhContext
.
Remark
Analogues
clCompileProgram
- Parameters
hContext – [in] handle of the context instance.
hProgram – [in][out] handle of the program to compile.
pOptions – [in][optional] pointer to build options null-terminated string.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hProgram
UR_RESULT_ERROR_INVALID_PROGRAM
If
hProgram
isn’t a valid program object.
UR_RESULT_ERROR_PROGRAM_BUILD_FAILURE
If an error occurred while compiling
hProgram
.
urProgramLink#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramLink(ur_context_handle_t hContext, uint32_t count, const ur_program_handle_t *phPrograms, const char *pOptions, ur_program_handle_t *phProgram)#
Produces an executable program from one or more programs.
The application may call this function from simultaneous threads.
Following a successful call to this entry point the program returned in
phProgram
will contain a binary of the UR_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device inhContext
.If a non-success code is returned and
phProgram
is notnullptr
, it will contain an unspecified program ornullptr
. Implementations may use the build log of this program (accessible via urProgramGetBuildInfo) to provide an error log for the linking failure.
Remark
Analogues
clLinkProgram
- Parameters
hContext – [in] handle of the context instance.
count – [in] number of program handles in `phPrograms`.
phPrograms – [in][range(0, count)] pointer to array of program handles.
pOptions – [in][optional] pointer to linker options null-terminated string.
phProgram – [out] pointer to handle of program object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phPrograms
NULL == phProgram
UR_RESULT_ERROR_INVALID_PROGRAM
If one of the programs in
phPrograms
isn’t a valid program object.
count == 0
UR_RESULT_ERROR_PROGRAM_LINK_FAILURE
If an error occurred while linking
phPrograms
.
urProgramRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramRetain(ur_program_handle_t hProgram)#
Get a reference to the Program object.
Get a reference to the Program object handle. Increment its reference count
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clRetainProgram
- Parameters
hProgram – [in][retain] handle for the Program to retain
- Returns
urProgramRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramRelease(ur_program_handle_t hProgram)#
Release Program.
Decrement reference count and destroy the Program if reference count becomes zero.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clReleaseProgram
- Parameters
hProgram – [in][release] handle for the Program to release
- Returns
urProgramGetFunctionPointer#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramGetFunctionPointer(ur_device_handle_t hDevice, ur_program_handle_t hProgram, const char *pFunctionName, void **ppFunctionPointer)#
Retrieves a device function pointer to a user-defined function.
Retrieves a pointer to the functions with the given name and defined in the given program.
UR_RESULT_ERROR_FUNCTION_ADDRESS_NOT_AVAILABLE is returned if the function can not be obtained.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clGetDeviceFunctionPointerINTEL
- Parameters
hDevice – [in] handle of the device to retrieve pointer for.
hProgram – [in] handle of the program to search for function in. The program must already be built to the specified device, or otherwise UR_RESULT_ERROR_INVALID_PROGRAM_EXECUTABLE is returned.
pFunctionName – [in] A null-terminates string denoting the mangled function name.
ppFunctionPointer – [out] Returns the pointer to the function if it is found in the program.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pFunctionName
NULL == ppFunctionPointer
UR_RESULT_ERROR_INVALID_KERNEL_NAME
If
pFunctionName
couldn’t be found inhProgram
.
UR_RESULT_ERROR_FUNCTION_ADDRESS_NOT_AVAILABLE
If
pFunctionName
could be located, but its address couldn’t be retrieved.
urProgramGetGlobalVariablePointer#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramGetGlobalVariablePointer(ur_device_handle_t hDevice, ur_program_handle_t hProgram, const char *pGlobalVariableName, size_t *pGlobalVariableSizeRet, void **ppGlobalVariablePointerRet)#
Retrieves a pointer to a device global variable.
Retrieves a pointer to a device global variable.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
Remark
Analogues
clGetDeviceGlobalVariablePointerINTEL
- Parameters
hDevice – [in] handle of the device to retrieve the pointer for.
hProgram – [in] handle of the program where the global variable is.
pGlobalVariableName – [in] mangled name of the global variable to retrieve the pointer for.
pGlobalVariableSizeRet – [out][optional] Returns the size of the global variable if it is found in the program.
ppGlobalVariablePointerRet – [out] Returns the pointer to the global variable if it is found in the program.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalVariableName
NULL == ppGlobalVariablePointerRet
name
is not a valid variable in the program.
urProgramGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramGetInfo(ur_program_handle_t hProgram, ur_program_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query information about a Program object.
Remark
Analogues
clGetProgramInfo
- Parameters
hProgram – [in] handle of the Program object
propName – [in] name of the Program property to query
propSize – [in] the size of the Program property.
pPropValue – [in,out][optional][typename(propName, propSize)] array of bytes of holding the program info property. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_PROGRAM_INFO_KERNEL_NAMES < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urProgramGetBuildInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramGetBuildInfo(ur_program_handle_t hProgram, ur_device_handle_t hDevice, ur_program_build_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query build information about a Program object for a Device.
Remark
Analogues
clGetProgramBuildInfo
- Parameters
hProgram – [in] handle of the Program object
hDevice – [in] handle of the Device object
propName – [in] name of the Program build info to query
propSize – [in] size of the Program build info property.
pPropValue – [in,out][optional][typename(propName, propSize)] value of the Program build property. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of data being queried by propName.
- Returns
urProgramSetSpecializationConstants#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramSetSpecializationConstants(ur_program_handle_t hProgram, uint32_t count, const ur_specialization_constant_info_t *pSpecConstants)#
Set an array of specialization constants on a Program.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
hProgram
must have been created with the urProgramCreateWithIL entry point.Any spec constants set with this entry point will apply only to subsequent calls to urProgramBuild or urProgramCompile.
- Parameters
hProgram – [in] handle of the Program object
count – [in] the number of elements in the pSpecConstants array
pSpecConstants – [in][range(0, count)] array of specialization constant value descriptions
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSpecConstants
count == 0
A pSpecConstant entry contains a size that does not match that of the specialization constant in the module.
A pSpecConstant entry contains a nullptr pValue.
UR_RESULT_ERROR_INVALID_SPEC_ID
Any id specified in a pSpecConstant entry is not a valid specialization constant identifier.
urProgramGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramGetNativeHandle(ur_program_handle_t hProgram, ur_native_handle_t *phNativeProgram)#
Return program native program handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability program extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hProgram – [in] handle of the program.
phNativeProgram – [out] a pointer to the native handle of the program.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeProgram
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urProgramCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramCreateWithNativeHandle(ur_native_handle_t hNativeProgram, ur_context_handle_t hContext, const ur_program_native_properties_t *pProperties, ur_program_handle_t *phProgram)#
Create runtime program object from native program handle.
Creates runtime program handle from native driver program handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeProgram – [in][nocheck] the native handle of the program.
hContext – [in] handle of the context instance
pProperties – [in][optional] pointer to native program properties struct.
phProgram – [out] pointer to the handle of the program object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phProgram
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
Program Enums#
ur_program_metadata_type_t#
-
enum ur_program_metadata_type_t#
Program metadata property type.
Values:
-
enumerator UR_PROGRAM_METADATA_TYPE_UINT32#
type is a 32-bit integer.
-
enumerator UR_PROGRAM_METADATA_TYPE_UINT64#
type is a 64-bit integer.
-
enumerator UR_PROGRAM_METADATA_TYPE_BYTE_ARRAY#
type is a byte array.
-
enumerator UR_PROGRAM_METADATA_TYPE_STRING#
type is a null-terminated string.
-
enumerator UR_PROGRAM_METADATA_TYPE_UINT32#
ur_program_info_t#
-
enum ur_program_info_t#
Get Program object information.
Values:
-
enumerator UR_PROGRAM_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the program object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_PROGRAM_INFO_CONTEXT#
[ur_context_handle_t] Program context info.
-
enumerator UR_PROGRAM_INFO_NUM_DEVICES#
[uint32_t] Return number of devices associated with Program.
-
enumerator UR_PROGRAM_INFO_DEVICES#
[ur_device_handle_t[]] Return list of devices associated with a program. This is either the list of devices associated with the context or a subset of those devices when the program is created using urProgramCreateWithBinary.
-
enumerator UR_PROGRAM_INFO_IL#
[char[]] Return program IL if the program was created with urProgramCreateWithIL, otherwise return size will be set to 0 and nothing will be returned.
-
enumerator UR_PROGRAM_INFO_BINARY_SIZES#
[size_t[]] Return program binary sizes for each device.
-
enumerator UR_PROGRAM_INFO_BINARIES#
[unsigned char[]] Return program binaries for all devices for this Program.
-
enumerator UR_PROGRAM_INFO_NUM_KERNELS#
[size_t][optional-query] Number of kernels in Program, return type size_t.
-
enumerator UR_PROGRAM_INFO_KERNEL_NAMES#
[char[]][optional-query] Return a null-terminated, semi-colon separated list of kernel names in Program.
-
enumerator UR_PROGRAM_INFO_REFERENCE_COUNT#
ur_program_build_status_t#
-
enum ur_program_build_status_t#
Program object build status.
Values:
-
enumerator UR_PROGRAM_BUILD_STATUS_NONE#
Program build status none.
-
enumerator UR_PROGRAM_BUILD_STATUS_ERROR#
Program build error.
-
enumerator UR_PROGRAM_BUILD_STATUS_SUCCESS#
Program build success.
-
enumerator UR_PROGRAM_BUILD_STATUS_IN_PROGRESS#
Program build in progress
-
enumerator UR_PROGRAM_BUILD_STATUS_NONE#
ur_program_binary_type_t#
-
enum ur_program_binary_type_t#
Program object binary type.
Values:
-
enumerator UR_PROGRAM_BINARY_TYPE_NONE#
No program binary is associated with device.
-
enumerator UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT#
Program binary is compiled object.
-
enumerator UR_PROGRAM_BINARY_TYPE_LIBRARY#
Program binary is library object.
-
enumerator UR_PROGRAM_BINARY_TYPE_EXECUTABLE#
Program binary is executable
-
enumerator UR_PROGRAM_BINARY_TYPE_NONE#
ur_program_build_info_t#
-
enum ur_program_build_info_t#
Get Program object build information.
Values:
-
enumerator UR_PROGRAM_BUILD_INFO_STATUS#
[ur_program_build_status_t] Program build status.
-
enumerator UR_PROGRAM_BUILD_INFO_OPTIONS#
[char[]] Null-terminated options string specified by last build, compile or link operation performed on the program.
-
enumerator UR_PROGRAM_BUILD_INFO_LOG#
[char[]] Null-terminated program build log.
-
enumerator UR_PROGRAM_BUILD_INFO_BINARY_TYPE#
[ur_program_binary_type_t] Program binary type.
-
enumerator UR_PROGRAM_BUILD_INFO_STATUS#
Program Structures#
ur_program_metadata_value_t#
-
union ur_program_metadata_value_t#
- #include <>
Program metadata value union.
Public Members
-
uint32_t data32#
[in] inline storage for the 32-bit data, type UR_PROGRAM_METADATA_TYPE_UINT32.
-
uint64_t data64#
[in] inline storage for the 64-bit data, type UR_PROGRAM_METADATA_TYPE_UINT64.
-
char *pString#
[in] pointer to null-terminated string data, type UR_PROGRAM_METADATA_TYPE_STRING.
-
void *pData#
[in] pointer to binary data, type UR_PROGRAM_METADATA_TYPE_BYTE_ARRAY.
-
uint32_t data32#
ur_program_metadata_t#
-
struct ur_program_metadata_t#
Program metadata property.
Public Members
-
const char *pName#
[in] null-terminated metadata name.
-
ur_program_metadata_type_t type#
[in] the type of metadata value.
-
size_t size#
[in] size in bytes of the data pointed to by value.pData, or 0 when value size is less than 64-bits and is stored directly in value.data.
-
ur_program_metadata_value_t value#
[in][tagged_by(type)] the metadata value storage.
-
const char *pName#
ur_program_properties_t#
-
struct ur_program_properties_t#
Program creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_PROGRAM_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
uint32_t count#
[in] the number of entries in pMetadatas, if count is greater than zero then pMetadatas must not be null.
-
const ur_program_metadata_t *pMetadatas#
[in][optional][range(0,count)] pointer to array of metadata entries.
-
ur_structure_type_t stype#
ur_specialization_constant_info_t#
-
struct ur_specialization_constant_info_t#
Specialization constant information.
ur_program_native_properties_t#
-
struct ur_program_native_properties_t#
Native program creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_PROGRAM_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Kernel#
Functions
Enumerations
Structures
Kernel Functions#
urKernelCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelCreate(ur_program_handle_t hProgram, const char *pKernelName, ur_kernel_handle_t *phKernel)#
Create kernel object from a program.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
- Parameters
hProgram – [in] handle of the program instance
pKernelName – [in] pointer to null-terminated string.
phKernel – [out] pointer to handle of kernel object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pKernelName
NULL == phKernel
UR_RESULT_ERROR_INVALID_KERNEL_NAME
If
pKernelName
wasn’t found inhProgram
.
urKernelSetArgValue#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgValue(ur_kernel_handle_t hKernel, uint32_t argIndex, size_t argSize, const ur_kernel_arg_value_properties_t *pProperties, const void *pArgValue)#
Set kernel argument to a value.
The application may call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
- Parameters
hKernel – [in] handle of the kernel object
argIndex – [in] argument index in range [0, num args - 1]
argSize – [in] size of argument type
pProperties – [in][optional] pointer to value properties.
pArgValue – [in] argument value represented as matching arg type. The data pointed to will be copied and therefore can be reused on return.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pArgValue
urKernelSetArgLocal#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgLocal(ur_kernel_handle_t hKernel, uint32_t argIndex, size_t argSize, const ur_kernel_arg_local_properties_t *pProperties)#
Set kernel argument to a local buffer.
The application may call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
- Parameters
hKernel – [in] handle of the kernel object
argIndex – [in] argument index in range [0, num args - 1]
argSize – [in] size of the local buffer to be allocated by the runtime
pProperties – [in][optional] pointer to local buffer properties.
- Returns
urKernelGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelGetInfo(ur_kernel_handle_t hKernel, ur_kernel_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query information about a Kernel object.
Remark
Analogues
clGetKernelInfo
- Parameters
hKernel – [in] handle of the Kernel object
propName – [in] name of the Kernel property to query
propSize – [in] the size of the Kernel property value.
pPropValue – [in,out][optional][typename(propName, propSize)] array of bytes holding the kernel info property. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of data being queried by propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_KERNEL_INFO_NUM_REGS < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urKernelGetGroupInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelGetGroupInfo(ur_kernel_handle_t hKernel, ur_device_handle_t hDevice, ur_kernel_group_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query work Group information about a Kernel object.
Remark
Analogues
clGetKernelWorkGroupInfo
- Parameters
hKernel – [in] handle of the Kernel object
hDevice – [in] handle of the Device object
propName – [in] name of the work Group property to query
propSize – [in] size of the Kernel Work Group property value
pPropValue – [in,out][optional][typename(propName, propSize)] value of the Kernel Work Group property.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of data being queried by propName.
- Returns
urKernelGetSubGroupInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelGetSubGroupInfo(ur_kernel_handle_t hKernel, ur_device_handle_t hDevice, ur_kernel_sub_group_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query SubGroup information about a Kernel object.
- Parameters
hKernel – [in] handle of the Kernel object
hDevice – [in] handle of the Device object
propName – [in] name of the SubGroup property to query
propSize – [in] size of the Kernel SubGroup property value
pPropValue – [in,out][optional][typename(propName, propSize)] value of the Kernel SubGroup property.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of data being queried by propName.
- Returns
urKernelRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelRetain(ur_kernel_handle_t hKernel)#
Get a reference to the Kernel object.
Get a reference to the Kernel object handle. Increment its reference count
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clRetainKernel
- Parameters
hKernel – [in][retain] handle for the Kernel to retain
- Returns
urKernelRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelRelease(ur_kernel_handle_t hKernel)#
Release Kernel.
Decrement reference count and destroy the Kernel if reference count becomes zero.
The application may call this function from simultaneous threads.
The implementation of this function should be lock-free.
Remark
Analogues
clReleaseKernel
- Parameters
hKernel – [in][release] handle for the Kernel to release
- Returns
urKernelSetArgPointer#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgPointer(ur_kernel_handle_t hKernel, uint32_t argIndex, const ur_kernel_arg_pointer_properties_t *pProperties, const void *pArgValue)#
Set a USM pointer as the argument value of a Kernel.
The application may call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
Remark
Analogues
clSetKernelArgSVMPointer
- Parameters
hKernel – [in] handle of the kernel object
argIndex – [in] argument index in range [0, num args - 1]
pProperties – [in][optional] pointer to USM pointer properties.
pArgValue – [in][optional] Pointer obtained by USM allocation or virtual memory mapping operation. If null then argument value is considered null.
- Returns
urKernelSetExecInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetExecInfo(ur_kernel_handle_t hKernel, ur_kernel_exec_info_t propName, size_t propSize, const ur_kernel_exec_info_properties_t *pProperties, const void *pPropValue)#
Set additional Kernel execution attributes.
The application must not call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
Remark
Analogues
clSetKernelExecInfo
- Parameters
hKernel – [in] handle of the kernel object
propName – [in] name of the execution attribute
propSize – [in] size in byte the attribute value
pProperties – [in][optional] pointer to execution info properties.
pPropValue – [in][typename(propName, propSize)] pointer to memory location holding the property value.
- Returns
urKernelSetArgSampler#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgSampler(ur_kernel_handle_t hKernel, uint32_t argIndex, const ur_kernel_arg_sampler_properties_t *pProperties, ur_sampler_handle_t hArgValue)#
Set a Sampler object as the argument value of a Kernel.
The application may call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
- Parameters
hKernel – [in] handle of the kernel object
argIndex – [in] argument index in range [0, num args - 1]
pProperties – [in][optional] pointer to sampler properties.
hArgValue – [in] handle of Sampler object.
- Returns
urKernelSetArgMemObj#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetArgMemObj(ur_kernel_handle_t hKernel, uint32_t argIndex, const ur_kernel_arg_mem_obj_properties_t *pProperties, ur_mem_handle_t hArgValue)#
Set a Memory object as the argument value of a Kernel.
The application may call this function from simultaneous threads with the same kernel handle.
The implementation of this function should be lock-free.
- Parameters
hKernel – [in] handle of the kernel object
argIndex – [in] argument index in range [0, num args - 1]
pProperties – [in][optional] pointer to Memory object properties.
hArgValue – [in][optional] handle of Memory object.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_MEM_FLAGS_MASK & pProperties->memoryAccess
urKernelSetSpecializationConstants#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSetSpecializationConstants(ur_kernel_handle_t hKernel, uint32_t count, const ur_specialization_constant_info_t *pSpecConstants)#
Set an array of specialization constants on a Kernel.
This entry point is optional, the application should query for support with device query UR_DEVICE_INFO_KERNEL_SET_SPECIALIZATION_CONSTANTS passed to urDeviceGetInfo.
Adapters which are capable of setting specialization constants immediately prior to urEnqueueKernelLaunch with low overhead should implement this entry point.
Otherwise, if setting specialization constants late requires recompiling or linking a program, adapters should not implement this entry point.
The application may call this function from simultaneous threads for the same device.
The implementation of this function should be thread-safe.
- Parameters
hKernel – [in] handle of the kernel object
count – [in] the number of elements in the pSpecConstants array
pSpecConstants – [in] array of specialization constant value descriptions
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSpecConstants
count == 0
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If UR_DEVICE_INFO_KERNEL_SET_SPECIALIZATION_CONSTANTS query is false
A pSpecConstant entry contains a size that does not match that of the specialization constant in the module.
A pSpecConstant entry contains a nullptr pValue.
UR_RESULT_ERROR_INVALID_SPEC_ID
Any id specified in a pSpecConstant entry is not a valid specialization constant identifier.
urKernelGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelGetNativeHandle(ur_kernel_handle_t hKernel, ur_native_handle_t *phNativeKernel)#
Return platform native kernel handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hKernel – [in] handle of the kernel.
phNativeKernel – [out] a pointer to the native handle of the kernel.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeKernel
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urKernelCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelCreateWithNativeHandle(ur_native_handle_t hNativeKernel, ur_context_handle_t hContext, ur_program_handle_t hProgram, const ur_kernel_native_properties_t *pProperties, ur_kernel_handle_t *phKernel)#
Create runtime kernel object from native kernel handle.
Creates runtime kernel handle from native driver kernel handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
The implementation may require a valid program handle to return the native kernel handle
- Parameters
hNativeKernel – [in][nocheck] the native handle of the kernel.
hContext – [in] handle of the context object
hProgram – [in][optional] handle of the program associated with the kernel
pProperties – [in][optional] pointer to native kernel properties struct
phKernel – [out] pointer to the handle of the kernel object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
If
hProgram == NULL
and the implementation requires a valid program.
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phKernel
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urKernelGetSuggestedLocalWorkSize#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelGetSuggestedLocalWorkSize(ur_kernel_handle_t hKernel, ur_queue_handle_t hQueue, uint32_t numWorkDim, const size_t *pGlobalWorkOffset, const size_t *pGlobalWorkSize, size_t *pSuggestedLocalWorkSize)#
Get the suggested local work size for a kernel.
Query a suggested local work size for a kernel given a global size for each dimension.
The application may call this function from simultaneous threads for the same context.
- Parameters
hKernel – [in] handle of the kernel
hQueue – [in] handle of the queue object
numWorkDim – [in] number of dimensions, from 1 to 3, to specify the global and work-group work-items
pGlobalWorkOffset – [in] pointer to an array of numWorkDim unsigned values that specify the offset used to calculate the global ID of a work-item
pGlobalWorkSize – [in] pointer to an array of numWorkDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function
pSuggestedLocalWorkSize – [out] pointer to an array of numWorkDim unsigned values that specify suggested local work size that will contain the result of the query
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalWorkOffset
NULL == pGlobalWorkSize
NULL == pSuggestedLocalWorkSize
Kernel Enums#
ur_kernel_info_t#
-
enum ur_kernel_info_t#
Get Kernel object information.
Values:
-
enumerator UR_KERNEL_INFO_FUNCTION_NAME#
[char[]] Return null-terminated kernel function name.
-
enumerator UR_KERNEL_INFO_NUM_ARGS#
[uint32_t] Return Kernel number of arguments.
-
enumerator UR_KERNEL_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the kernel object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_KERNEL_INFO_CONTEXT#
[ur_context_handle_t] Return Context object associated with Kernel.
-
enumerator UR_KERNEL_INFO_PROGRAM#
[ur_program_handle_t] Return Program object associated with Kernel.
-
enumerator UR_KERNEL_INFO_ATTRIBUTES#
[char[]] Return null-terminated kernel attributes string.
-
enumerator UR_KERNEL_INFO_NUM_REGS#
[uint32_t][optional-query] Return the number of registers used by the compiled kernel.
-
enumerator UR_KERNEL_INFO_FUNCTION_NAME#
ur_kernel_group_info_t#
-
enum ur_kernel_group_info_t#
Get Kernel Work Group information.
Values:
-
enumerator UR_KERNEL_GROUP_INFO_GLOBAL_WORK_SIZE#
[size_t[3]][optional-query] Return Work Group maximum global size
-
enumerator UR_KERNEL_GROUP_INFO_WORK_GROUP_SIZE#
[size_t] Return maximum Work Group size
-
enumerator UR_KERNEL_GROUP_INFO_COMPILE_WORK_GROUP_SIZE#
[size_t[3]] Return Work Group size required by the source code, such as attribute((required_work_group_size(X,Y,Z)), or (0, 0, 0) if unspecified
-
enumerator UR_KERNEL_GROUP_INFO_LOCAL_MEM_SIZE#
[size_t] Return local memory required by the Kernel
-
enumerator UR_KERNEL_GROUP_INFO_PREFERRED_WORK_GROUP_SIZE_MULTIPLE#
[size_t] Return preferred multiple of Work Group size for launch
-
enumerator UR_KERNEL_GROUP_INFO_PRIVATE_MEM_SIZE#
[size_t] Return minimum amount of private memory in bytes used by each work item in the Kernel
-
enumerator UR_KERNEL_GROUP_INFO_COMPILE_MAX_WORK_GROUP_SIZE#
[size_t[3]][optional-query] Return the maximum Work Group size guaranteed by the source code, or (0, 0, 0) if unspecified
-
enumerator UR_KERNEL_GROUP_INFO_COMPILE_MAX_LINEAR_WORK_GROUP_SIZE#
[size_t][optional-query] Return the maximum linearized Work Group size (X * Y * Z) guaranteed by the source code, or 0 if unspecified
-
enumerator UR_KERNEL_GROUP_INFO_GLOBAL_WORK_SIZE#
ur_kernel_sub_group_info_t#
-
enum ur_kernel_sub_group_info_t#
Get Kernel SubGroup information.
Values:
-
enumerator UR_KERNEL_SUB_GROUP_INFO_MAX_SUB_GROUP_SIZE#
[uint32_t] Return maximum SubGroup size
-
enumerator UR_KERNEL_SUB_GROUP_INFO_MAX_NUM_SUB_GROUPS#
[uint32_t] Return maximum number of SubGroup
-
enumerator UR_KERNEL_SUB_GROUP_INFO_COMPILE_NUM_SUB_GROUPS#
[uint32_t] Return number of SubGroup required by the source code or 0 if unspecified
-
enumerator UR_KERNEL_SUB_GROUP_INFO_SUB_GROUP_SIZE_INTEL#
[uint32_t] Return SubGroup size required by Intel
-
enumerator UR_KERNEL_SUB_GROUP_INFO_MAX_SUB_GROUP_SIZE#
ur_kernel_cache_config_t#
-
enum ur_kernel_cache_config_t#
Kernel Cache Configuration.
Values:
-
enumerator UR_KERNEL_CACHE_CONFIG_DEFAULT#
No preference for SLM or data cache.
-
enumerator UR_KERNEL_CACHE_CONFIG_LARGE_SLM#
Large Shared Local Memory (SLM) size.
-
enumerator UR_KERNEL_CACHE_CONFIG_LARGE_DATA#
Large General Data size.
-
enumerator UR_KERNEL_CACHE_CONFIG_DEFAULT#
ur_kernel_exec_info_t#
-
enum ur_kernel_exec_info_t#
Set additional Kernel execution information.
Values:
-
enumerator UR_KERNEL_EXEC_INFO_USM_INDIRECT_ACCESS#
[ur_bool_t] Kernel might access data through USM pointer.
-
enumerator UR_KERNEL_EXEC_INFO_USM_PTRS#
[void *[]] Provide an explicit array of USM pointers that the kernel will access.
-
enumerator UR_KERNEL_EXEC_INFO_CACHE_CONFIG#
[ur_kernel_cache_config_t] Provide the preferred cache configuration
-
enumerator UR_KERNEL_EXEC_INFO_USM_INDIRECT_ACCESS#
Kernel Structures#
ur_kernel_arg_value_properties_t#
-
struct ur_kernel_arg_value_properties_t#
Properties for for urKernelSetArgValue.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_ARG_VALUE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_kernel_arg_local_properties_t#
-
struct ur_kernel_arg_local_properties_t#
Properties for for urKernelSetArgLocal.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_ARG_LOCAL_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_kernel_arg_pointer_properties_t#
-
struct ur_kernel_arg_pointer_properties_t#
Properties for for urKernelSetArgPointer.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_ARG_POINTER_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_kernel_exec_info_properties_t#
-
struct ur_kernel_exec_info_properties_t#
Properties for for urKernelSetExecInfo.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_EXEC_INFO_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_kernel_arg_sampler_properties_t#
-
struct ur_kernel_arg_sampler_properties_t#
Properties for for urKernelSetArgSampler.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_ARG_SAMPLER_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_kernel_arg_mem_obj_properties_t#
-
struct ur_kernel_arg_mem_obj_properties_t#
Properties for for urKernelSetArgMemObj.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_ARG_MEM_OBJ_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_mem_flags_t memoryAccess#
[in] Memory access flag. Allowed values are: UR_MEM_FLAG_READ_WRITE, UR_MEM_FLAG_WRITE_ONLY, UR_MEM_FLAG_READ_ONLY.
-
ur_structure_type_t stype#
ur_kernel_native_properties_t#
-
struct ur_kernel_native_properties_t#
Properties for for urKernelCreateWithNativeHandle.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_KERNEL_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Queue#
Functions
Enumerations
Structures
Queue Functions#
urQueueGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueGetInfo(ur_queue_handle_t hQueue, ur_queue_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Query information about a command queue.
Remark
Analogues
clGetCommandQueueInfo
- Parameters
hQueue – [in] handle of the queue object
propName – [in] name of the queue property to query
propSize – [in] size in bytes of the queue property value provided
pPropValue – [out][optional][typename(propName, propSize)] value of the queue property
pPropSizeRet – [out][optional] size in bytes returned in queue property value
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_QUEUE_INFO_EMPTY < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
UR_RESULT_ERROR_INVALID_QUEUE - “If `hQueue` isn’t a valid queue handle or if `propName` isn’t supported by `hQueue`.”
urQueueCreate#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueCreate(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_queue_properties_t *pProperties, ur_queue_handle_t *phQueue)#
Create a command queue for a device in a context.
See also ur_queue_index_properties_t.
Remark
Analogues
clCreateCommandQueueWithProperties
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
pProperties – [in][optional] pointer to queue creation properties.
phQueue – [out] pointer to handle of queue object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_QUEUE_FLAGS_MASK & pProperties->flags
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phQueue
UR_RESULT_ERROR_INVALID_QUEUE_PROPERTIES
pProperties != NULL && pProperties->flags & UR_QUEUE_FLAG_PRIORITY_HIGH && pProperties->flags & UR_QUEUE_FLAG_PRIORITY_LOW
pProperties != NULL && pProperties->flags & UR_QUEUE_FLAG_SUBMISSION_BATCHED && pProperties->flags & UR_QUEUE_FLAG_SUBMISSION_IMMEDIATE
urQueueRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueRetain(ur_queue_handle_t hQueue)#
Get a reference to the command queue handle. Increment the command queue’s reference count.
Useful in library function to retain access to the command queue after the caller released the queue.
Remark
Analogues
clRetainCommandQueue
- Parameters
hQueue – [in][retain] handle of the queue object to get access
- Returns
urQueueRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueRelease(ur_queue_handle_t hQueue)#
Decrement the command queue’s reference count and delete the command queue if the reference count becomes zero.
After the command queue reference count becomes zero and all queued commands in the queue have finished, the queue is deleted.
It also performs an implicit flush to issue all previously queued commands in the queue.
Remark
Analogues
clReleaseCommandQueue
- Parameters
hQueue – [in][release] handle of the queue object to release
- Returns
urQueueGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueGetNativeHandle(ur_queue_handle_t hQueue, ur_queue_native_desc_t *pDesc, ur_native_handle_t *phNativeQueue)#
Return queue native queue handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability queue extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hQueue – [in] handle of the queue.
pDesc – [in][optional] pointer to native descriptor
phNativeQueue – [out] a pointer to the native handle of the queue.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeQueue
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urQueueCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueCreateWithNativeHandle(ur_native_handle_t hNativeQueue, ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_queue_native_properties_t *pProperties, ur_queue_handle_t *phQueue)#
Create runtime queue object from native queue handle.
Creates runtime queue handle from native driver queue handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeQueue – [in][nocheck] the native handle of the queue.
hContext – [in] handle of the context object
hDevice – [in][optional] handle of the device object
pProperties – [in][optional] pointer to native queue properties struct
phQueue – [out] pointer to the handle of the queue object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phQueue
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urQueueFinish#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueFinish(ur_queue_handle_t hQueue)#
Blocks until all previously issued commands to the command queue are finished.
Blocks until all previously issued commands to the command queue are issued and completed.
urQueueFinish does not return until all enqueued commands have been processed and finished.
urQueueFinish acts as a synchronization point.
Remark
Analogues
clFinish
- Parameters
hQueue – [in] handle of the queue to be finished.
- Returns
urQueueFlush#
-
UR_APIEXPORT ur_result_t UR_APICALL urQueueFlush(ur_queue_handle_t hQueue)#
Issues all previously enqueued commands in a command queue to the device.
Guarantees that all enqueued commands will be issued to the appropriate device.
There is no guarantee that they will be completed after urQueueFlush returns.
Remark
Analogues
clFlush
- Parameters
hQueue – [in] handle of the queue to be flushed.
- Returns
Queue Enums#
ur_queue_info_t#
-
enum ur_queue_info_t#
Query queue info.
Values:
-
enumerator UR_QUEUE_INFO_CONTEXT#
[ur_context_handle_t] context associated with this queue.
-
enumerator UR_QUEUE_INFO_DEVICE#
[ur_device_handle_t] device associated with this queue.
-
enumerator UR_QUEUE_INFO_DEVICE_DEFAULT#
[ur_queue_handle_t] the current default queue of the underlying device.
-
enumerator UR_QUEUE_INFO_FLAGS#
[ur_queue_flags_t] the properties associated with ur_queue_properties_t::flags.
-
enumerator UR_QUEUE_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the queue object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_QUEUE_INFO_SIZE#
[uint32_t] The size of the queue on the device. Only a valid query if the queue was created with the
ON_DEVICE
queue flag, otherwiseurQueueGetInfo
will returnUR_RESULT_ERROR_INVALID_QUEUE
.
-
enumerator UR_QUEUE_INFO_CONTEXT#
ur_queue_flags_t#
-
enum ur_queue_flag_t#
Values:
-
enumerator UR_QUEUE_FLAG_OUT_OF_ORDER_EXEC_MODE_ENABLE#
Enable/disable out of order execution.
-
enumerator UR_QUEUE_FLAG_PROFILING_ENABLE#
Enable/disable profiling.
-
enumerator UR_QUEUE_FLAG_ON_DEVICE#
Is a device queue. If this is enabled
OUT_OF_ORDER_EXEC_MODE_ENABLE
must also be enabled.
-
enumerator UR_QUEUE_FLAG_ON_DEVICE_DEFAULT#
Is the default queue for a device.
-
enumerator UR_QUEUE_FLAG_DISCARD_EVENTS#
Events will be discarded.
-
enumerator UR_QUEUE_FLAG_PRIORITY_LOW#
Low priority queue.
-
enumerator UR_QUEUE_FLAG_PRIORITY_HIGH#
High priority queue.
-
enumerator UR_QUEUE_FLAG_SUBMISSION_BATCHED#
Hint: enqueue and submit in a batch later. No change in queue semantics. Implementation chooses submission mode.
-
enumerator UR_QUEUE_FLAG_SUBMISSION_IMMEDIATE#
Hint: enqueue and submit immediately. No change in queue semantics. Implementation chooses submission mode.
-
enumerator UR_QUEUE_FLAG_USE_DEFAULT_STREAM#
Use the default stream. Only meaningful for CUDA. Other platforms may ignore this flag.
-
enumerator UR_QUEUE_FLAG_SYNC_WITH_DEFAULT_STREAM#
Synchronize with the default stream. Only meaningful for CUDA. Other platforms may ignore this flag.
-
enumerator UR_QUEUE_FLAG_LOW_POWER_EVENTS_EXP#
Hint: use low-power events. Only meaningful for Level Zero, where the implementation may use interrupt-driven events. May reduce CPU utilization at the cost of increased event completion latency. Other platforms may ignore this flag.
-
enumerator UR_QUEUE_FLAG_OUT_OF_ORDER_EXEC_MODE_ENABLE#
Queue Structures#
ur_queue_properties_t#
-
struct ur_queue_properties_t#
Queue creation properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_QUEUE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_queue_flags_t flags#
[in] Bitfield of queue creation flags
-
ur_structure_type_t stype#
ur_queue_index_properties_t#
-
struct ur_queue_index_properties_t#
Queue index creation properties.
Specify these properties in urQueueCreate via ur_queue_properties_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_QUEUE_INDEX_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
uint32_t computeIndex#
[in] Specifies the compute index as described in the sycl_ext_intel_queue_index extension.
ur_queue_native_desc_t#
-
struct ur_queue_native_desc_t#
Descriptor for urQueueGetNativeHandle and urQueueCreateWithNativeHandle.
Specify this descriptor in urQueueGetNativeHandle directly or urQueueCreateWithNativeHandle via ur_queue_native_properties_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_QUEUE_NATIVE_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
void *pNativeData#
[in][optional] Adapter-specific metadata needed to create the handle.
ur_queue_native_properties_t#
-
struct ur_queue_native_properties_t#
Properties for for urQueueCreateWithNativeHandle.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_QUEUE_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Event#
Functions
Enumerations
Structures
Typedefs
Event Functions#
urEventGetInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventGetInfo(ur_event_handle_t hEvent, ur_event_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get event object information.
Remark
Analogues
clGetEventInfo
- Parameters
hEvent – [in] handle of the event object
propName – [in] the name of the event property to query
propSize – [in] size in bytes of the event property value
pPropValue – [out][optional][typename(propName, propSize)] value of the event property
pPropSizeRet – [out][optional] bytes returned in event property
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hEvent
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EVENT_INFO_REFERENCE_COUNT < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urEventGetProfilingInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventGetProfilingInfo(ur_event_handle_t hEvent, ur_profiling_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get profiling information for the command associated with an event object.
Remark
Analogues
clGetEventProfilingInfo
- Parameters
hEvent – [in] handle of the event object
propName – [in] the name of the profiling property to query
propSize – [in] size in bytes of the profiling property value
pPropValue – [out][optional][typename(propName, propSize)] value of the profiling property
pPropSizeRet – [out][optional] pointer to the actual size in bytes returned in propValue
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hEvent
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_PROFILING_INFO_COMMAND_COMPLETE < propName
UR_RESULT_ERROR_PROFILING_INFO_NOT_AVAILABLE
If
hEvent
s associated queue was not created withUR_QUEUE_FLAG_PROFILING_ENABLE
.
pPropValue && propSize == 0
urEventWait#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventWait(uint32_t numEvents, const ur_event_handle_t *phEventWaitList)#
Wait for a list of events to finish.
Remark
Analogues
clWaitForEvent
- Parameters
numEvents – [in] number of events in the event list
phEventWaitList – [in][range(0, numEvents)] pointer to a list of events to wait for completion
- Returns
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phEventWaitList
numEvents == 0
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEventRetain#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventRetain(ur_event_handle_t hEvent)#
Get a reference to an event handle. Increment the event object’s reference count.
Remark
Analogues
clRetainEvent
- Parameters
hEvent – [in][retain] handle of the event object
- Returns
urEventRelease#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventRelease(ur_event_handle_t hEvent)#
Decrement the event object’s reference count and delete the event object if the reference count becomes zero.
Remark
Analogues
clReleaseEvent
- Parameters
hEvent – [in][release] handle of the event object
- Returns
urEventGetNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventGetNativeHandle(ur_event_handle_t hEvent, ur_native_handle_t *phNativeEvent)#
Return platform native event handle.
Retrieved native handle can be used for direct interaction with the native platform driver.
Use interoperability platform extensions to convert native handle to native type.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hEvent – [in] handle of the event.
phNativeEvent – [out] a pointer to the native handle of the event.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hEvent
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phNativeEvent
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urEventCreateWithNativeHandle#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventCreateWithNativeHandle(ur_native_handle_t hNativeEvent, ur_context_handle_t hContext, const ur_event_native_properties_t *pProperties, ur_event_handle_t *phEvent)#
Create runtime event object from native event handle.
Creates runtime event handle from native driver event handle.
The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hNativeEvent – [in][nocheck] the native handle of the event.
hContext – [in] handle of the context object
pProperties – [in][optional] pointer to native event properties struct
phEvent – [out] pointer to the handle of the event object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phEvent
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the adapter has no underlying equivalent handle.
urEventSetCallback#
-
UR_APIEXPORT ur_result_t UR_APICALL urEventSetCallback(ur_event_handle_t hEvent, ur_execution_info_t execStatus, ur_event_callback_t pfnNotify, void *pUserData)#
Register a user callback function for a specific command execution status.
The registered callback function will be called when the execution status of command associated with event changes to an execution status equal to or past the status specified by command_exec_status.
execStatus
must not beUR_EXECUTION_INFO_QUEUED
as this is the initial state of all events.The application may call this function from simultaneous threads for the same context.
The implementation of this function should be thread-safe.
- Parameters
hEvent – [in] handle of the event object
execStatus – [in] execution status of the event
pfnNotify – [in] execution status of the event
pUserData – [in][out][optional] pointer to data to be passed to callback.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hEvent
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXECUTION_INFO_QUEUED < execStatus
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pfnNotify
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
execStatus == UR_EXECUTION_INFO_QUEUED
Event Enums#
ur_command_t#
-
enum ur_command_t#
Command type.
Values:
-
enumerator UR_COMMAND_KERNEL_LAUNCH#
Event created by urEnqueueKernelLaunch.
-
enumerator UR_COMMAND_EVENTS_WAIT#
Event created by urEnqueueEventsWait.
-
enumerator UR_COMMAND_EVENTS_WAIT_WITH_BARRIER#
Event created by urEnqueueEventsWaitWithBarrier.
-
enumerator UR_COMMAND_MEM_BUFFER_READ#
Event created by urEnqueueMemBufferRead.
-
enumerator UR_COMMAND_MEM_BUFFER_WRITE#
Event created by urEnqueueMemBufferWrite.
-
enumerator UR_COMMAND_MEM_BUFFER_READ_RECT#
Event created by urEnqueueMemBufferReadRect.
-
enumerator UR_COMMAND_MEM_BUFFER_WRITE_RECT#
Event created by urEnqueueMemBufferWriteRect.
-
enumerator UR_COMMAND_MEM_BUFFER_COPY#
Event created by urEnqueueMemBufferCopy.
-
enumerator UR_COMMAND_MEM_BUFFER_COPY_RECT#
Event created by urEnqueueMemBufferCopyRect.
-
enumerator UR_COMMAND_MEM_BUFFER_FILL#
Event created by urEnqueueMemBufferFill.
-
enumerator UR_COMMAND_MEM_IMAGE_READ#
Event created by urEnqueueMemImageRead.
-
enumerator UR_COMMAND_MEM_IMAGE_WRITE#
Event created by urEnqueueMemImageWrite.
-
enumerator UR_COMMAND_MEM_IMAGE_COPY#
Event created by urEnqueueMemImageCopy.
-
enumerator UR_COMMAND_MEM_BUFFER_MAP#
Event created by urEnqueueMemBufferMap.
-
enumerator UR_COMMAND_MEM_UNMAP#
Event created by urEnqueueMemUnmap.
-
enumerator UR_COMMAND_USM_FILL#
Event created by urEnqueueUSMFill.
-
enumerator UR_COMMAND_USM_MEMCPY#
Event created by urEnqueueUSMMemcpy.
-
enumerator UR_COMMAND_USM_PREFETCH#
Event created by urEnqueueUSMPrefetch.
-
enumerator UR_COMMAND_USM_ADVISE#
Event created by urEnqueueUSMAdvise.
-
enumerator UR_COMMAND_USM_FILL_2D#
Event created by urEnqueueUSMFill2D.
-
enumerator UR_COMMAND_USM_MEMCPY_2D#
Event created by urEnqueueUSMMemcpy2D.
-
enumerator UR_COMMAND_DEVICE_GLOBAL_VARIABLE_WRITE#
Event created by urEnqueueDeviceGlobalVariableWrite.
-
enumerator UR_COMMAND_DEVICE_GLOBAL_VARIABLE_READ#
Event created by urEnqueueDeviceGlobalVariableRead.
-
enumerator UR_COMMAND_READ_HOST_PIPE#
Event created by urEnqueueReadHostPipe.
-
enumerator UR_COMMAND_WRITE_HOST_PIPE#
Event created by urEnqueueWriteHostPipe.
-
enumerator UR_COMMAND_COMMAND_BUFFER_ENQUEUE_EXP#
Event created by urCommandBufferEnqueueExp.
-
enumerator UR_COMMAND_EXTERNAL_SEMAPHORE_WAIT_EXP#
Event created by urBindlessImagesWaitExternalSemaphoreExp.
-
enumerator UR_COMMAND_EXTERNAL_SEMAPHORE_SIGNAL_EXP#
Event created by urBindlessImagesSignalExternalSemaphoreExp.
-
enumerator UR_COMMAND_TIMESTAMP_RECORDING_EXP#
Event created by urEnqueueTimestampRecordingExp.
-
enumerator UR_COMMAND_ENQUEUE_NATIVE_EXP#
Event created by urEnqueueNativeCommandExp
-
enumerator UR_COMMAND_KERNEL_LAUNCH#
ur_event_status_t#
-
enum ur_event_status_t#
Event Status.
Values:
-
enumerator UR_EVENT_STATUS_COMPLETE#
Command is complete.
-
enumerator UR_EVENT_STATUS_RUNNING#
Command is running.
-
enumerator UR_EVENT_STATUS_SUBMITTED#
Command is submitted.
-
enumerator UR_EVENT_STATUS_QUEUED#
Command is queued.
-
enumerator UR_EVENT_STATUS_ERROR#
Command was abnormally terminated
-
enumerator UR_EVENT_STATUS_COMPLETE#
ur_event_info_t#
-
enum ur_event_info_t#
Event query information type.
Values:
-
enumerator UR_EVENT_INFO_COMMAND_QUEUE#
[ur_queue_handle_t] Command queue information of an event object
-
enumerator UR_EVENT_INFO_CONTEXT#
[ur_context_handle_t] Context information of an event object
-
enumerator UR_EVENT_INFO_COMMAND_TYPE#
[ur_command_t] Command type information of an event object
-
enumerator UR_EVENT_INFO_COMMAND_EXECUTION_STATUS#
[ur_event_status_t] Command execution status of an event object
-
enumerator UR_EVENT_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the event object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_EVENT_INFO_COMMAND_QUEUE#
ur_profiling_info_t#
-
enum ur_profiling_info_t#
Profiling query information type.
Values:
-
enumerator UR_PROFILING_INFO_COMMAND_QUEUED#
[uint64_t] A 64-bit value of current device counter in nanoseconds when the event is enqueued
-
enumerator UR_PROFILING_INFO_COMMAND_SUBMIT#
[uint64_t] A 64-bit value of current device counter in nanoseconds when the event is submitted
-
enumerator UR_PROFILING_INFO_COMMAND_START#
[uint64_t] A 64-bit value of current device counter in nanoseconds when the event starts execution
-
enumerator UR_PROFILING_INFO_COMMAND_END#
[uint64_t] A 64-bit value of current device counter in nanoseconds when the event has finished execution
-
enumerator UR_PROFILING_INFO_COMMAND_COMPLETE#
[uint64_t] A 64-bit value of current device counter in nanoseconds when the event and any child events enqueued by this event on the device have finished execution
-
enumerator UR_PROFILING_INFO_COMMAND_QUEUED#
ur_execution_info_t#
-
enum ur_execution_info_t#
Event states for all events.
Values:
-
enumerator UR_EXECUTION_INFO_COMPLETE#
Indicates that the event has completed.
-
enumerator UR_EXECUTION_INFO_RUNNING#
Indicates that the device has started processing this event.
-
enumerator UR_EXECUTION_INFO_SUBMITTED#
Indicates that the event has been submitted by the host to the device.
-
enumerator UR_EXECUTION_INFO_QUEUED#
Indicates that the event has been queued, this is the initial state of events.
-
enumerator UR_EXECUTION_INFO_COMPLETE#
Event Structures#
ur_event_native_properties_t#
-
struct ur_event_native_properties_t#
Properties for for urEventCreateWithNativeHandle.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EVENT_NATIVE_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
bool isNativeHandleOwned#
[in] Indicates UR owns the native handle or if it came from an interoperability operation in the application that asked to not transfer the ownership to the unified-runtime.
-
ur_structure_type_t stype#
Event Typedefs#
ur_event_callback_t#
-
typedef void (*ur_event_callback_t)(ur_event_handle_t hEvent, ur_execution_info_t execStatus, void *pUserData)#
Event callback function that can be registered by the application.
Enqueue#
Functions
Enumerations
Enqueue Functions#
urEnqueueKernelLaunch#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueKernelLaunch(ur_queue_handle_t hQueue, ur_kernel_handle_t hKernel, uint32_t workDim, const size_t *pGlobalWorkOffset, const size_t *pGlobalWorkSize, const size_t *pLocalWorkSize, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to execute a kernel.
Remark
Analogues
clEnqueueNDRangeKernel
- Parameters
hQueue – [in] handle of the queue object
hKernel – [in] handle of the kernel object
workDim – [in] number of dimensions, from 1 to 3, to specify the global and work-group work-items
pGlobalWorkOffset – [in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item
pGlobalWorkSize – [in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function
pLocalWorkSize – [in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. If nullptr, the runtime implementation will choose the work-group size.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalWorkOffset
NULL == pGlobalWorkSize
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
UR_RESULT_ERROR_INVALID_KERNEL_ARGS - “The kernel argument values have not been specified.”
urEnqueueEventsWait#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueEventsWait(ur_queue_handle_t hQueue, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command which waits a list of events to complete before it completes.
If the event list is empty, it waits for all previously enqueued commands to complete.
It returns an event which can be waited on.
Remark
Analogues
clEnqueueMarkerWithWaitList
- Parameters
hQueue – [in] handle of the queue object
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueEventsWaitWithBarrier#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueEventsWaitWithBarrier(ur_queue_handle_t hQueue, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a barrier command which waits a list of events to complete before it completes.
If the event list is empty, it waits for all previously enqueued commands to complete.
It blocks command execution - any following commands enqueued after it do not execute until it completes.
It returns an event which can be waited on.
Remark
Analogues
clEnqueueBarrierWithWaitList
- Parameters
hQueue – [in] handle of the queue object
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueMemBufferRead#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferRead(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, bool blockingRead, size_t offset, size_t size, void *pDst, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to read from a buffer object to host memory.
Input parameter blockingRead indicates if the read is blocking or non-blocking.
Remark
Analogues
clEnqueueReadBuffer
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(offset, size)] handle of the buffer object
blockingRead – [in] indicates blocking (true), non-blocking (false)
offset – [in] offset in bytes in the buffer object
size – [in] size in bytes of data being read
pDst – [in] pointer to host memory where data is to be read into
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
If
offset + size
results in an out-of-bounds access.
urEnqueueMemBufferWrite#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferWrite(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, bool blockingWrite, size_t offset, size_t size, const void *pSrc, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to write into a buffer object from host memory.
Input parameter blockingWrite indicates if the write is blocking or non-blocking.
Remark
Analogues
clEnqueueWriteBuffer
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(offset, size)] handle of the buffer object
blockingWrite – [in] indicates blocking (true), non-blocking (false)
offset – [in] offset in bytes in the buffer object
size – [in] size in bytes of data being written
pSrc – [in] pointer to host memory where data is to be written from
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
If
offset + size
results in an out-of-bounds access.
urEnqueueMemBufferReadRect#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferReadRect(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, bool blockingRead, ur_rect_offset_t bufferOrigin, ur_rect_offset_t hostOrigin, ur_rect_region_t region, size_t bufferRowPitch, size_t bufferSlicePitch, size_t hostRowPitch, size_t hostSlicePitch, void *pDst, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to read a 2D or 3D rectangular region from a buffer object to host memory.
Input parameter blockingRead indicates if the read is blocking or non-blocking.
The buffer and host 2D or 3D rectangular regions can have different shapes.
Remark
Analogues
clEnqueueReadBufferRect
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(bufferOrigin, region)] handle of the buffer object
blockingRead – [in] indicates blocking (true), non-blocking (false)
bufferOrigin – [in] 3D offset in the buffer
hostOrigin – [in] 3D offset in the host region
region – [in] 3D rectangular region descriptor: width, height, depth
bufferRowPitch – [in] length of each row in bytes in the buffer object
bufferSlicePitch – [in] length of each 2D slice in bytes in the buffer object being read
hostRowPitch – [in] length of each row in bytes in the host memory region pointed by dst
hostSlicePitch – [in] length of each 2D slice in bytes in the host memory region pointed by dst
pDst – [in] pointer to host memory where data is to be read into
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.width == 0
bufferRowPitch != 0 && bufferRowPitch < region.width
hostRowPitch != 0 && hostRowPitch < region.width
bufferSlicePitch != 0 && bufferSlicePitch < region.height * (bufferRowPitch != 0 ? bufferRowPitch : region.width)
bufferSlicePitch != 0 && bufferSlicePitch % (bufferRowPitch != 0 ? bufferRowPitch : region.width) != 0
hostSlicePitch != 0 && hostSlicePitch < region.height * (hostRowPitch != 0 ? hostRowPitch : region.width)
hostSlicePitch != 0 && hostSlicePitch % (hostRowPitch != 0 ? hostRowPitch : region.width) != 0
If the combination of
bufferOrigin
,region
,bufferRowPitch
, andbufferSlicePitch
results in an out-of-bounds access.
urEnqueueMemBufferWriteRect#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferWriteRect(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, bool blockingWrite, ur_rect_offset_t bufferOrigin, ur_rect_offset_t hostOrigin, ur_rect_region_t region, size_t bufferRowPitch, size_t bufferSlicePitch, size_t hostRowPitch, size_t hostSlicePitch, void *pSrc, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to write a 2D or 3D rectangular region in a buffer object from host memory.
Input parameter blockingWrite indicates if the write is blocking or non-blocking.
The buffer and host 2D or 3D rectangular regions can have different shapes.
Remark
Analogues
clEnqueueWriteBufferRect
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(bufferOrigin, region)] handle of the buffer object
blockingWrite – [in] indicates blocking (true), non-blocking (false)
bufferOrigin – [in] 3D offset in the buffer
hostOrigin – [in] 3D offset in the host region
region – [in] 3D rectangular region descriptor: width, height, depth
bufferRowPitch – [in] length of each row in bytes in the buffer object
bufferSlicePitch – [in] length of each 2D slice in bytes in the buffer object being written
hostRowPitch – [in] length of each row in bytes in the host memory region pointed by src
hostSlicePitch – [in] length of each 2D slice in bytes in the host memory region pointed by src
pSrc – [in] pointer to host memory where data is to be written from
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] points to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.width == 0
bufferRowPitch != 0 && bufferRowPitch < region.width
hostRowPitch != 0 && hostRowPitch < region.width
bufferSlicePitch != 0 && bufferSlicePitch < region.height * (bufferRowPitch != 0 ? bufferRowPitch : region.width)
bufferSlicePitch != 0 && bufferSlicePitch % (bufferRowPitch != 0 ? bufferRowPitch : region.width) != 0
hostSlicePitch != 0 && hostSlicePitch < region.height * (hostRowPitch != 0 ? hostRowPitch : region.width)
hostSlicePitch != 0 && hostSlicePitch % (hostRowPitch != 0 ? hostRowPitch : region.width) != 0
If the combination of
bufferOrigin
,region
,bufferRowPitch
, andbufferSlicePitch
results in an out-of-bounds access.
urEnqueueMemBufferCopy#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferCopy(ur_queue_handle_t hQueue, ur_mem_handle_t hBufferSrc, ur_mem_handle_t hBufferDst, size_t srcOffset, size_t dstOffset, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to copy from a buffer object to another.
Remark
Analogues
clEnqueueCopyBuffer
- Parameters
hQueue – [in] handle of the queue object
hBufferSrc – [in][bounds(srcOffset, size)] handle of the src buffer object
hBufferDst – [in][bounds(dstOffset, size)] handle of the dest buffer object
srcOffset – [in] offset into hBufferSrc to begin copying from
dstOffset – [in] offset info hBufferDst to begin copying into
size – [in] size in bytes of data being copied
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBufferSrc
NULL == hBufferDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
If
srcOffset + size
results in an out-of-bounds access.If
dstOffset + size
results in an out-of-bounds access.
urEnqueueMemBufferCopyRect#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferCopyRect(ur_queue_handle_t hQueue, ur_mem_handle_t hBufferSrc, ur_mem_handle_t hBufferDst, ur_rect_offset_t srcOrigin, ur_rect_offset_t dstOrigin, ur_rect_region_t region, size_t srcRowPitch, size_t srcSlicePitch, size_t dstRowPitch, size_t dstSlicePitch, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to copy a 2D or 3D rectangular region from one buffer object to another.
Remark
Analogues
clEnqueueCopyBufferRect
- Parameters
hQueue – [in] handle of the queue object
hBufferSrc – [in][bounds(srcOrigin, region)] handle of the source buffer object
hBufferDst – [in][bounds(dstOrigin, region)] handle of the dest buffer object
srcOrigin – [in] 3D offset in the source buffer
dstOrigin – [in] 3D offset in the destination buffer
region – [in] source 3D rectangular region descriptor: width, height, depth
srcRowPitch – [in] length of each row in bytes in the source buffer object
srcSlicePitch – [in] length of each 2D slice in bytes in the source buffer object
dstRowPitch – [in] length of each row in bytes in the destination buffer object
dstSlicePitch – [in] length of each 2D slice in bytes in the destination buffer object
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBufferSrc
NULL == hBufferDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.depth == 0
srcRowPitch != 0 && srcRowPitch < region.width
dstRowPitch != 0 && dstRowPitch < region.width
srcSlicePitch != 0 && srcSlicePitch < region.height * (srcRowPitch != 0 ? srcRowPitch : region.width)
srcSlicePitch != 0 && srcSlicePitch % (srcRowPitch != 0 ? srcRowPitch : region.width) != 0
dstSlicePitch != 0 && dstSlicePitch < region.height * (dstRowPitch != 0 ? dstRowPitch : region.width)
dstSlicePitch != 0 && dstSlicePitch % (dstRowPitch != 0 ? dstRowPitch : region.width) != 0
If the combination of
srcOrigin
,region
,srcRowPitch
, andsrcSlicePitch
results in an out-of-bounds access.If the combination of
dstOrigin
,region
,dstRowPitch
, anddstSlicePitch
results in an out-of-bounds access.
urEnqueueMemBufferFill#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferFill(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, const void *pPattern, size_t patternSize, size_t offset, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to fill a buffer object with a pattern of a given size.
Remark
Analogues
clEnqueueFillBuffer
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(offset, size)] handle of the buffer object
pPattern – [in] pointer to the fill pattern
patternSize – [in] size in bytes of the pattern
offset – [in] offset into the buffer
size – [in] fill size in bytes, must be a multiple of patternSize
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pPattern
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
patternSize == 0 || size == 0
patternSize > size
(patternSize & (patternSize - 1)) != 0
size % patternSize != 0
offset % patternSize != 0
If
offset + size
results in an out-of-bounds access.
urEnqueueMemImageRead#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemImageRead(ur_queue_handle_t hQueue, ur_mem_handle_t hImage, bool blockingRead, ur_rect_offset_t origin, ur_rect_region_t region, size_t rowPitch, size_t slicePitch, void *pDst, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to read from an image or image array object to host memory.
Input parameter blockingRead indicates if the read is blocking or non-blocking.
Remark
Analogues
clEnqueueReadImage
- Parameters
hQueue – [in] handle of the queue object
hImage – [in][bounds(origin, region)] handle of the image object
blockingRead – [in] indicates blocking (true), non-blocking (false)
origin – [in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image
region – [in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image
rowPitch – [in] length of each row in bytes
slicePitch – [in] length of each 2D slice of the 3D image
pDst – [in] pointer to host memory where image is to be read into
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hImage
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.depth == 0
urEnqueueMemImageWrite#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemImageWrite(ur_queue_handle_t hQueue, ur_mem_handle_t hImage, bool blockingWrite, ur_rect_offset_t origin, ur_rect_region_t region, size_t rowPitch, size_t slicePitch, void *pSrc, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to write an image or image array object from host memory.
Input parameter blockingWrite indicates if the write is blocking or non-blocking.
Remark
Analogues
clEnqueueWriteImage
- Parameters
hQueue – [in] handle of the queue object
hImage – [in][bounds(origin, region)] handle of the image object
blockingWrite – [in] indicates blocking (true), non-blocking (false)
origin – [in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image
region – [in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image
rowPitch – [in] length of each row in bytes
slicePitch – [in] length of each 2D slice of the 3D image
pSrc – [in] pointer to host memory where image is to be read into
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hImage
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.depth == 0
urEnqueueMemImageCopy#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemImageCopy(ur_queue_handle_t hQueue, ur_mem_handle_t hImageSrc, ur_mem_handle_t hImageDst, ur_rect_offset_t srcOrigin, ur_rect_offset_t dstOrigin, ur_rect_region_t region, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to copy from an image object to another.
Remark
Analogues
clEnqueueCopyImage
- Parameters
hQueue – [in] handle of the queue object
hImageSrc – [in][bounds(srcOrigin, region)] handle of the src image object
hImageDst – [in][bounds(dstOrigin, region)] handle of the dest image object
srcOrigin – [in] defines the (x,y,z) offset in pixels in the source 1D, 2D, or 3D image
dstOrigin – [in] defines the (x,y,z) offset in pixels in the destination 1D, 2D, or 3D image
region – [in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hImageSrc
NULL == hImageDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
region.width == 0 || region.height == 0 || region.depth == 0
urEnqueueMemBufferMap#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemBufferMap(ur_queue_handle_t hQueue, ur_mem_handle_t hBuffer, bool blockingMap, ur_map_flags_t mapFlags, size_t offset, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent, void **ppRetMap)#
Enqueue a command to map a region of the buffer object into the host address space and return a pointer to the mapped region.
Input parameter blockingMap indicates if the map is blocking or non-blocking.
Currently, no direct support in Level Zero. Implemented as a shared allocation followed by copying on discrete GPU
TODO: add a driver function in Level Zero?
Remark
Analogues
clEnqueueMapBuffer
- Parameters
hQueue – [in] handle of the queue object
hBuffer – [in][bounds(offset, size)] handle of the buffer object
blockingMap – [in] indicates blocking (true), non-blocking (false)
mapFlags – [in] flags for read, write, readwrite mapping
offset – [in] offset in bytes of the buffer region being mapped
size – [in] size in bytes of the buffer region being mapped
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
ppRetMap – [out] return mapped pointer. TODO: move it before numEventsInWaitList?
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hBuffer
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_MAP_FLAGS_MASK & mapFlags
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppRetMap
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
If
offset + size
results in an out-of-bounds access.
urEnqueueMemUnmap#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueMemUnmap(ur_queue_handle_t hQueue, ur_mem_handle_t hMem, void *pMappedPtr, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to unmap a previously mapped region of a memory object.
Remark
Analogues
clEnqueueUnmapMemObject
- Parameters
hQueue – [in] handle of the queue object
hMem – [in] handle of the memory (buffer or image) object
pMappedPtr – [in] mapped host address
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hMem
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMappedPtr
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueUSMFill#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMFill(ur_queue_handle_t hQueue, void *pMem, size_t patternSize, const void *pPattern, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to fill USM memory.
- Parameters
hQueue – [in] handle of the queue object
pMem – [in][bounds(0, size)] pointer to USM memory object
patternSize – [in] the size in bytes of the pattern. Must be a power of 2 and less than or equal to width.
pPattern – [in] pointer with the bytes of the pattern to set.
size – [in] size in bytes to be set. Must be a multiple of patternSize.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMem
NULL == pPattern
patternSize == 0 || size == 0
patternSize > size
size % patternSize != 0
If
size
is higher than the allocation size ofptr
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueUSMMemcpy#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMMemcpy(ur_queue_handle_t hQueue, bool blocking, void *pDst, const void *pSrc, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to copy USM memory.
- Parameters
hQueue – [in] handle of the queue object
blocking – [in] blocking or non-blocking copy
pDst – [in][bounds(0, size)] pointer to the destination USM memory object
pSrc – [in][bounds(0, size)] pointer to the source USM memory object
size – [in] size in bytes to be copied
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
NULL == pSrc
size == 0
If
size
is higher than the allocation size ofpSrc
orpDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueUSMPrefetch#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMPrefetch(ur_queue_handle_t hQueue, const void *pMem, size_t size, ur_usm_migration_flags_t flags, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to prefetch USM memory.
Prefetching may not be supported for all devices or allocation types. If memory prefetching is not supported, the prefetch hint will be ignored.
- Parameters
hQueue – [in] handle of the queue object
pMem – [in][bounds(0, size)] pointer to the USM memory object
size – [in] size in bytes to be fetched
flags – [in] USM prefetch flags
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that this command does not wait on any event to complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMem
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_MIGRATION_FLAGS_MASK & flags
size == 0
If
size
is higher than the allocation size ofpMem
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueUSMAdvise#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMAdvise(ur_queue_handle_t hQueue, const void *pMem, size_t size, ur_usm_advice_flags_t advice, ur_event_handle_t *phEvent)#
Enqueue a command to set USM memory advice.
Not all memory advice hints may be supported for all devices or allocation types. If a memory advice hint is not supported, it will be ignored.
- Parameters
hQueue – [in] handle of the queue object
pMem – [in][bounds(0, size)] pointer to the USM memory object
size – [in] size in bytes to be advised
advice – [in] USM memory advice
phEvent – [out][optional] return an event object that identifies this particular command instance.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMem
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_ADVICE_FLAGS_MASK & advice
size == 0
If
size
is higher than the allocation size ofpMem
urEnqueueUSMFill2D#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMFill2D(ur_queue_handle_t hQueue, void *pMem, size_t pitch, size_t patternSize, const void *pPattern, size_t width, size_t height, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to fill 2D USM memory.
- Parameters
hQueue – [in] handle of the queue to submit to.
pMem – [in][bounds(0, pitch * height)] pointer to memory to be filled.
pitch – [in] the total width of the destination memory including padding.
patternSize – [in] the size in bytes of the pattern. Must be a power of 2 and less than or equal to width.
pPattern – [in] pointer with the bytes of the pattern to set.
width – [in] the width in bytes of each row to fill. Must be a multiple of patternSize.
height – [in] the height of the columns to fill.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMem
NULL == pPattern
pitch == 0
pitch < width
patternSize == 0
patternSize > width * height
patternSize != 0 && ((patternSize & (patternSize - 1)) != 0)
width == 0
height == 0
width * height % patternSize != 0
If
pitch * height
is higher than the allocation size ofpMem
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueUSMMemcpy2D#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueUSMMemcpy2D(ur_queue_handle_t hQueue, bool blocking, void *pDst, size_t dstPitch, const void *pSrc, size_t srcPitch, size_t width, size_t height, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to copy 2D USM memory.
- Parameters
hQueue – [in] handle of the queue to submit to.
blocking – [in] indicates if this operation should block the host.
pDst – [in][bounds(0, dstPitch * height)] pointer to memory where data will be copied.
dstPitch – [in] the total width of the source memory including padding.
pSrc – [in][bounds(0, srcPitch * height)] pointer to memory to be copied.
srcPitch – [in] the total width of the source memory including padding.
width – [in] the width in bytes of each row to be copied.
height – [in] the height of columns to be copied.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
NULL == pSrc
srcPitch == 0
dstPitch == 0
srcPitch < width
dstPitch < width
height == 0
If
srcPitch * height
is higher than the allocation size ofpSrc
If
dstPitch * height
is higher than the allocation size ofpDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueDeviceGlobalVariableWrite#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite(ur_queue_handle_t hQueue, ur_program_handle_t hProgram, const char *name, bool blockingWrite, size_t count, size_t offset, const void *pSrc, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to write data from the host to device global variable.
- Parameters
hQueue – [in] handle of the queue to submit to.
hProgram – [in] handle of the program containing the device global variable.
name – [in] the unique identifier for the device global variable.
blockingWrite – [in] indicates if this operation should block.
count – [in] the number of bytes to copy.
offset – [in] the byte offset into the device global variable to start copying.
pSrc – [in] pointer to where the data must be copied from.
numEventsInWaitList – [in] size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == name
NULL == pSrc
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueDeviceGlobalVariableRead#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead(ur_queue_handle_t hQueue, ur_program_handle_t hProgram, const char *name, bool blockingRead, size_t count, size_t offset, void *pDst, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to read data from a device global variable to the host.
- Parameters
hQueue – [in] handle of the queue to submit to.
hProgram – [in] handle of the program containing the device global variable.
name – [in] the unique identifier for the device global variable.
blockingRead – [in] indicates if this operation should block.
count – [in] the number of bytes to copy.
offset – [in] the byte offset into the device global variable to start copying.
pDst – [in] pointer to where the data must be copied to.
numEventsInWaitList – [in] size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == name
NULL == pDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueReadHostPipe#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueReadHostPipe(ur_queue_handle_t hQueue, ur_program_handle_t hProgram, const char *pipe_symbol, bool blocking, void *pDst, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to read from a pipe to the host.
- Parameters
hQueue – [in] a valid host command-queue in which the read command will be queued. hQueue and hProgram must be created with the same UR context.
hProgram – [in] a program object with a successfully built executable.
pipe_symbol – [in] the name of the program scope pipe global variable.
blocking – [in] indicate if the read operation is blocking or non-blocking.
pDst – [in] a pointer to buffer in host memory that will hold resulting data from pipe.
size – [in] size of the memory region to read, in bytes.
numEventsInWaitList – [in] number of events in the wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the host pipe read. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] returns an event object that identifies this read command and can be used to query or queue a wait for this command to complete. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pipe_symbol
NULL == pDst
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
urEnqueueWriteHostPipe#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueWriteHostPipe(ur_queue_handle_t hQueue, ur_program_handle_t hProgram, const char *pipe_symbol, bool blocking, void *pSrc, size_t size, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to write data from the host to a pipe.
- Parameters
hQueue – [in] a valid host command-queue in which the write command will be queued. hQueue and hProgram must be created with the same UR context.
hProgram – [in] a program object with a successfully built executable.
pipe_symbol – [in] the name of the program scope pipe global variable.
blocking – [in] indicate if the read and write operations are blocking or non-blocking.
pSrc – [in] a pointer to buffer in host memory that holds data to be written to the host pipe.
size – [in] size of the memory region to read or write, in bytes.
numEventsInWaitList – [in] number of events in the wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the host pipe write. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] returns an event object that identifies this write command and can be used to query or queue a wait for this command to complete. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pipe_symbol
NULL == pSrc
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
2d block array capabilities (experimental)#
Enumerations
Bindless images (experimental)#
Functions
Enumerations
Structures
Bindless images (experimental) Functions#
urUSMPitchedAllocExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMPitchedAllocExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_usm_desc_t *pUSMDesc, ur_usm_pool_handle_t pool, size_t widthInBytes, size_t height, size_t elementSizeBytes, void **ppMem, size_t *pResultPitch)#
USM allocate pitched memory.
This function must support memory pooling.
If pUSMDesc is not NULL and pUSMDesc->pool is not NULL the allocation will be served from a specified memory pool.
Otherwise, the behavior is implementation-defined.
Allocations served from different memory pools must be isolated and must not reside on the same page.
Any flags/hints passed through pUSMDesc only affect the single allocation.
See also ur_usm_host_desc_t.
See also ur_usm_device_desc_t.
Remark
Analogues
cuMemAllocPitch
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
pUSMDesc – [in][optional] Pointer to USM memory allocation descriptor.
pool – [in][optional] Pointer to a pool created using urUSMPoolCreate
widthInBytes – [in] width in bytes of the USM memory object to be allocated
height – [in] height of the USM memory object to be allocated
elementSizeBytes – [in] size in bytes of an element in the allocation
ppMem – [out] pointer to USM shared memory object
pResultPitch – [out] pitch of the allocation
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pUSMDesc && UR_USM_ADVICE_FLAGS_MASK & pUSMDesc->hints
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppMem
NULL == pResultPitch
pUSMDesc && pUSMDesc->align != 0 && ((pUSMDesc->align & (pUSMDesc->align-1)) != 0)
If
align
is greater that the size of the largest data type supported byhDevice
.
UR_RESULT_ERROR_INVALID_USM_SIZE
widthInBytes == 0
size
is greater than UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE.
UR_RESULT_ERROR_INVALID_OPERATION
If
UR_DEVICE_INFO_USM_SINGLE_SHARED_SUPPORT
andUR_DEVICE_INFO_USM_CROSS_SHARED_SUPPORT
are both false.
urBindlessImagesUnsampledImageHandleDestroyExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesUnsampledImageHandleDestroyExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_native_handle_t hImage)#
Destroy bindless unsampled image handles.
Remark
Analogues
cuSurfObjectDestroy
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImage – [in][release] pointer to handle of image object to destroy
- Returns
urBindlessImagesSampledImageHandleDestroyExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesSampledImageHandleDestroyExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_native_handle_t hImage)#
Destroy bindless sampled image handles.
Remark
Analogues
cuTexObjectDestroy
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImage – [in][release] pointer to handle of image object to destroy
- Returns
urBindlessImagesImageAllocateExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImageAllocateExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, ur_exp_image_mem_native_handle_t *phImageMem)#
Allocate memory for bindless images.
Remark
Analogues
cuArray3DCreate
cuMipmappedArrayCreate
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
pImageFormat – [in] pointer to image format specification
pImageDesc – [in] pointer to image description
phImageMem – [out] pointer to handle of image memory allocated
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phImageMem
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pImageDesc->type
urBindlessImagesImageFreeExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImageFreeExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_mem_native_handle_t hImageMem)#
Free memory for bindless images.
Remark
Analogues
cuArrayDestroy
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImageMem – [in][release] handle of image memory to be freed
- Returns
urBindlessImagesUnsampledImageCreateExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesUnsampledImageCreateExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_mem_native_handle_t hImageMem, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, ur_exp_image_native_handle_t *phImage)#
Create a bindless unsampled image handle.
Remark
Analogues
cuSurfObjectCreate
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImageMem – [in] handle to memory from which to create the image
pImageFormat – [in] pointer to image format specification
pImageDesc – [in] pointer to image description
phImage – [out] pointer to handle of image object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phImage
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pImageDesc->type
urBindlessImagesSampledImageCreateExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesSampledImageCreateExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_mem_native_handle_t hImageMem, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, ur_sampler_handle_t hSampler, ur_exp_image_native_handle_t *phImage)#
Create a bindless sampled image handle.
Remark
Analogues
cuTexObjectCreate
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImageMem – [in] handle to memory from which to create the image
pImageFormat – [in] pointer to image format specification
pImageDesc – [in] pointer to image description
hSampler – [in] sampler to be used
phImage – [out] pointer to handle of image object created
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
NULL == hSampler
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phImage
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pImageDesc->type
urBindlessImagesImageCopyExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImageCopyExp(ur_queue_handle_t hQueue, const void *pSrc, void *pDst, const ur_image_desc_t *pSrcImageDesc, const ur_image_desc_t *pDstImageDesc, const ur_image_format_t *pSrcImageFormat, const ur_image_format_t *pDstImageFormat, ur_exp_image_copy_region_t *pCopyRegion, ur_exp_image_copy_flags_t imageCopyFlags, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Copy image data Host to Device, Device to Host, or Device to Device.
Remark
Analogues
cuMemcpyHtoAAsync
cuMemcpyAtoHAsync
cuMemcpy2DAsync
cuMemcpy3DAsync
- Parameters
hQueue – [in] handle of the queue object
pSrc – [in] location the data will be copied from
pDst – [in] location the data will be copied to
pSrcImageDesc – [in] pointer to image description
pDstImageDesc – [in] pointer to image description
pSrcImageFormat – [in] pointer to image format specification
pDstImageFormat – [in] pointer to image format specification
pCopyRegion – [in] Pointer to structure describing the (sub-)regions of source and destination images
imageCopyFlags – [in] flags describing copy direction e.g. H2D or D2H
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
NULL == pDst
NULL == pSrcImageDesc
NULL == pDstImageDesc
NULL == pSrcImageFormat
NULL == pDstImageFormat
NULL == pCopyRegion
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_IMAGE_COPY_FLAGS_MASK & imageCopyFlags
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pSrcImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pSrcImageDesc->type
pDstImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pDstImageDesc->type
urBindlessImagesImageGetInfoExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImageGetInfoExp(ur_context_handle_t hContext, ur_exp_image_mem_native_handle_t hImageMem, ur_image_info_t propName, void *pPropValue, size_t *pPropSizeRet)#
Query an image memory handle for specific properties.
- Parameters
hContext – [in] handle of the context object
hImageMem – [in] handle to the image memory
propName – [in] queried info name
pPropValue – [out][optional] returned query value
pPropSizeRet – [out][optional] returned query value size
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_IMAGE_INFO_DEPTH < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
pPropValue == NULL && pPropSizeRet == NULL
urBindlessImagesMipmapGetLevelExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesMipmapGetLevelExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_mem_native_handle_t hImageMem, uint32_t mipmapLevel, ur_exp_image_mem_native_handle_t *phImageMem)#
Retrieve individual image from mipmap.
Remark
Analogues
cuMipmappedArrayGetLevel
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hImageMem – [in] memory handle to the mipmap image
mipmapLevel – [in] requested level of the mipmap
phImageMem – [out] returning memory handle to the individual image
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phImageMem
urBindlessImagesMipmapFreeExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesMipmapFreeExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_image_mem_native_handle_t hMem)#
Free mipmap memory for bindless images.
Remark
Analogues
cuMipmappedArrayDestroy
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hMem – [in][release] handle of image memory to be freed
- Returns
urBindlessImagesImportExternalMemoryExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImportExternalMemoryExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, size_t size, ur_exp_external_mem_type_t memHandleType, ur_exp_external_mem_desc_t *pExternalMemDesc, ur_exp_external_mem_handle_t *phExternalMem)#
Import external memory.
Remark
Analogues
cuImportExternalMemory
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
size – [in] size of the external memory
memHandleType – [in] type of external memory handle
pExternalMemDesc – [in] the external memory descriptor
phExternalMem – [out] external memory handle to the external memory
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX12_RESOURCE < memHandleType
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pExternalMemDesc
NULL == phExternalMem
urBindlessImagesMapExternalArrayExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesMapExternalArrayExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_image_format_t *pImageFormat, const ur_image_desc_t *pImageDesc, ur_exp_external_mem_handle_t hExternalMem, ur_exp_image_mem_native_handle_t *phImageMem)#
Map an external memory handle to an image memory handle.
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
pImageFormat – [in] pointer to image format specification
pImageDesc – [in] pointer to image description
hExternalMem – [in] external memory handle to the external memory
phImageMem – [out] image memory handle to the externally allocated memory
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
NULL == hExternalMem
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pImageFormat
NULL == pImageDesc
NULL == phImageMem
UR_RESULT_ERROR_INVALID_IMAGE_FORMAT_DESCRIPTOR
pImageDesc && UR_MEM_TYPE_IMAGE_CUBEMAP_EXP < pImageDesc->type
urBindlessImagesMapExternalLinearMemoryExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesMapExternalLinearMemoryExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, uint64_t offset, uint64_t size, ur_exp_external_mem_handle_t hExternalMem, void **ppRetMem)#
Map an external memory handle to a device memory region described by void*.
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
offset – [in] offset into memory region to map
size – [in] size of memory region to map
hExternalMem – [in] external memory handle to the external memory
ppRetMem – [out] pointer of the externally allocated memory
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
NULL == hExternalMem
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == ppRetMem
urBindlessImagesReleaseExternalMemoryExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesReleaseExternalMemoryExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_external_mem_handle_t hExternalMem)#
Release external memory.
Remark
Analogues
cuDestroyExternalMemory
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hExternalMem – [in][release] handle of external memory to be destroyed
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
NULL == hExternalMem
urBindlessImagesImportExternalSemaphoreExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesImportExternalSemaphoreExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_external_semaphore_type_t semHandleType, ur_exp_external_semaphore_desc_t *pExternalSemaphoreDesc, ur_exp_external_semaphore_handle_t *phExternalSemaphore)#
Import an external semaphore.
Remark
Analogues
cuImportExternalSemaphore
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
semHandleType – [in] type of external memory handle
pExternalSemaphoreDesc – [in] the external semaphore descriptor
phExternalSemaphore – [out] external semaphore handle to the external semaphore
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_EXTERNAL_SEMAPHORE_TYPE_WIN32_NT_DX12_FENCE < semHandleType
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pExternalSemaphoreDesc
NULL == phExternalSemaphore
urBindlessImagesReleaseExternalSemaphoreExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesReleaseExternalSemaphoreExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, ur_exp_external_semaphore_handle_t hExternalSemaphore)#
Release the external semaphore.
Remark
Analogues
cuDestroyExternalSemaphore
- Parameters
hContext – [in] handle of the context object
hDevice – [in] handle of the device object
hExternalSemaphore – [in][release] handle of external semaphore to be destroyed
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
NULL == hExternalSemaphore
urBindlessImagesWaitExternalSemaphoreExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesWaitExternalSemaphoreExp(ur_queue_handle_t hQueue, ur_exp_external_semaphore_handle_t hSemaphore, bool hasWaitValue, uint64_t waitValue, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Instruct the queue with a non-blocking wait on an external semaphore.
Remark
Analogues
cuWaitExternalSemaphoresAsync
- Parameters
hQueue – [in] handle of the queue object
hSemaphore – [in] external semaphore handle
hasWaitValue – [in] indicates whether the samephore is capable and should wait on a certain value. Otherwise the semaphore is treated like a binary state, and `waitValue` is ignored.
waitValue – [in] the value to be waited on
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
urBindlessImagesSignalExternalSemaphoreExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urBindlessImagesSignalExternalSemaphoreExp(ur_queue_handle_t hQueue, ur_exp_external_semaphore_handle_t hSemaphore, bool hasSignalValue, uint64_t signalValue, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Instruct the queue to signal the external semaphore handle once all previous commands have completed execution.
Remark
Analogues
cuSignalExternalSemaphoresAsync
- Parameters
hQueue – [in] handle of the queue object
hSemaphore – [in] external semaphore handle
hasSignalValue – [in] indicates whether the samephore is capable and should signal on a certain value. Otherwise the semaphore is treated like a binary state, and `signalValue` is ignored.
signalValue – [in] the value to be signalled
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
Bindless images (experimental) Enums#
ur_exp_image_copy_flags_t#
ur_exp_sampler_cubemap_filter_mode_t#
ur_exp_external_mem_type_t#
-
enum ur_exp_external_mem_type_t#
Dictates the type of external memory handle.
Values:
-
enumerator UR_EXP_EXTERNAL_MEM_TYPE_OPAQUE_FD#
Opaque file descriptor.
-
enumerator UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT#
Win32 NT handle.
-
enumerator UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX12_RESOURCE#
Win32 NT DirectX 12 resource handle
-
enumerator UR_EXP_EXTERNAL_MEM_TYPE_OPAQUE_FD#
ur_exp_external_semaphore_type_t#
-
enum ur_exp_external_semaphore_type_t#
Dictates the type of external semaphore handle.
Values:
-
enumerator UR_EXP_EXTERNAL_SEMAPHORE_TYPE_OPAQUE_FD#
Opaque file descriptor.
-
enumerator UR_EXP_EXTERNAL_SEMAPHORE_TYPE_WIN32_NT#
Win32 NT handle.
-
enumerator UR_EXP_EXTERNAL_SEMAPHORE_TYPE_WIN32_NT_DX12_FENCE#
Win32 NT DirectX 12 fence handle
-
enumerator UR_EXP_EXTERNAL_SEMAPHORE_TYPE_OPAQUE_FD#
Bindless images (experimental) Structures#
ur_exp_file_descriptor_t#
-
struct ur_exp_file_descriptor_t#
File descriptor.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
int fd#
[in] A file descriptor used for Linux and & MacOS operating systems.
-
ur_structure_type_t stype#
ur_exp_win32_handle_t#
-
struct ur_exp_win32_handle_t#
Windows specific file handle.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
void *handle#
[in] A win32 file handle.
-
ur_structure_type_t stype#
ur_exp_sampler_mip_properties_t#
-
struct ur_exp_sampler_mip_properties_t#
Describes mipmap sampler properties.
Specify these properties in urSamplerCreate via ur_sampler_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_SAMPLER_MIP_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
float minMipmapLevelClamp#
[in] minimum mipmap level from which we can sample, minimum value being 0
-
float maxMipmapLevelClamp#
[in] maximum mipmap level from which we can sample, maximum value being the number of levels
-
float maxAnisotropy#
[in] anisotropic ratio used when samplling the mipmap with anisotropic filtering
-
ur_sampler_filter_mode_t mipFilterMode#
[in] mipmap filter mode used for filtering between mipmap levels
ur_exp_sampler_addr_modes_t#
-
struct ur_exp_sampler_addr_modes_t#
Describes unique sampler addressing mode per dimension.
Specify these properties in urSamplerCreate via ur_sampler_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_sampler_addressing_mode_t addrModes[3]#
[in] Specify the address mode of the sampler per dimension
ur_exp_sampler_cubemap_properties_t#
-
struct ur_exp_sampler_cubemap_properties_t#
Describes cubemap sampler properties.
Specify these properties in urSamplerCreate via ur_sampler_desc_t as part of a
pNext
chain.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_SAMPLER_CUBEMAP_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_exp_sampler_cubemap_filter_mode_t cubemapFilterMode#
[in] enables or disables seamless cubemap filtering between cubemap faces
ur_exp_external_mem_desc_t#
-
struct ur_exp_external_mem_desc_t#
Describes an external memory resource descriptor.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_EXTERNAL_MEM_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_exp_external_semaphore_desc_t#
-
struct ur_exp_external_semaphore_desc_t#
Describes an external semaphore resource descriptor.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_EXTERNAL_SEMAPHORE_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_exp_image_copy_region_t#
-
struct ur_exp_image_copy_region_t#
Describes the (sub-)regions and the extent to be copied.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_IMAGE_COPY_REGION
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_rect_offset_t srcOffset#
[in] the offset into the source image
-
ur_rect_offset_t dstOffset#
[in] the offset into the destination image
-
ur_rect_region_t copyExtent#
[in] the extent (region) of the image to copy
-
ur_structure_type_t stype#
Command buffer (experimental)#
Functions
Enumerations
Structures
Macros
Typedefs
Command buffer (experimental) Functions#
urCommandBufferCreateExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferCreateExp(ur_context_handle_t hContext, ur_device_handle_t hDevice, const ur_exp_command_buffer_desc_t *pCommandBufferDesc, ur_exp_command_buffer_handle_t *phCommandBuffer)#
Create a Command-Buffer object.
Create a command-buffer object.
- Parameters
hContext – [in] Handle of the context object.
hDevice – [in] Handle of the device object.
pCommandBufferDesc – [in][optional] command-buffer descriptor.
phCommandBuffer – [out] Pointer to command-Buffer handle.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phCommandBuffer
UR_RESULT_ERROR_INVALID_OPERATION
If
pCommandBufferDesc->isUpdatable
is true andhDevice
does not support UR_DEVICE_INFO_COMMAND_BUFFER_UPDATE_SUPPORT_EXP.
urCommandBufferRetainExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferRetainExp(ur_exp_command_buffer_handle_t hCommandBuffer)#
Increment the command-buffer object’s reference count.
- Parameters
hCommandBuffer – [in][retain] Handle of the command-buffer object.
- Returns
urCommandBufferReleaseExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferReleaseExp(ur_exp_command_buffer_handle_t hCommandBuffer)#
Decrement the command-buffer object’s reference count and delete the command-buffer object if the reference count becomes zero.
- Parameters
hCommandBuffer – [in][release] Handle of the command-buffer object.
- Returns
urCommandBufferFinalizeExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferFinalizeExp(ur_exp_command_buffer_handle_t hCommandBuffer)#
Stop recording on a command-buffer object such that no more commands can be appended and make it ready to enqueue.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_OPERATION - “If `hCommandBuffer` has already been finalized”
urCommandBufferAppendKernelLaunchExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendKernelLaunchExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_kernel_handle_t hKernel, uint32_t workDim, const size_t *pGlobalWorkOffset, const size_t *pGlobalWorkSize, const size_t *pLocalWorkSize, uint32_t numKernelAlternatives, ur_kernel_handle_t *phKernelAlternatives, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a kernel execution command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hKernel – [in] Kernel to append.
workDim – [in] Dimension of the kernel execution.
pGlobalWorkOffset – [in] Offset to use when executing kernel.
pGlobalWorkSize – [in] Global work size to use when executing kernel.
pLocalWorkSize – [in][optional] Local work size to use when executing kernel. If this parameter is nullptr, then a local work size will be generated by the implementation.
numKernelAlternatives – [in] The number of kernel alternatives provided in phKernelAlternatives.
phKernelAlternatives – [in][optional][range(0, numKernelAlternatives)] List of kernel handles that might be used to update the kernel in this command after the command-buffer is finalized. The default kernel `hKernel` is implicitly marked as an alternative. It’s invalid to specify it as part of this list.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command. Only available if the command-buffer is updatable.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalWorkOffset
NULL == pGlobalWorkSize
phKernelAlternatives == NULL && numKernelAlternatives > 0
phKernelAlternatives != NULL && numKernelAlternatives == 0
If
phKernelAlternatives
containshKernel
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
UR_RESULT_ERROR_INVALID_OPERATION - “phCommand is not NULL and hCommandBuffer is not updatable.”
urCommandBufferAppendUSMMemcpyExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendUSMMemcpyExp(ur_exp_command_buffer_handle_t hCommandBuffer, void *pDst, const void *pSrc, size_t size, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a USM memcpy command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
pDst – [in] Location the data will be copied to.
pSrc – [in] The data to be copied.
size – [in] The number of bytes to copy.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
NULL == pSrc
size == 0
If
size
is higher than the allocation size ofpSrc
orpDst
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendUSMFillExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendUSMFillExp(ur_exp_command_buffer_handle_t hCommandBuffer, void *pMemory, const void *pPattern, size_t patternSize, size_t size, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a USM fill command to a command-buffer object.
- Parameters
hCommandBuffer – [in] handle of the command-buffer object.
pMemory – [in] pointer to USM allocated memory to fill.
pPattern – [in] pointer to the fill pattern.
patternSize – [in] size in bytes of the pattern.
size – [in] fill size in bytes, must be a multiple of patternSize.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMemory
NULL == pPattern
patternSize == 0 || size == 0
patternSize > size
size % patternSize != 0
If
size
is higher than the allocation size ofptr
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferCopyExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferCopyExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hSrcMem, ur_mem_handle_t hDstMem, size_t srcOffset, size_t dstOffset, size_t size, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a memory copy command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hSrcMem – [in] The data to be copied.
hDstMem – [in] The location the data will be copied to.
srcOffset – [in] Offset into the source memory.
dstOffset – [in] Offset into the destination memory
size – [in] The number of bytes to be copied.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hSrcMem
NULL == hDstMem
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferWriteExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferWriteExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hBuffer, size_t offset, size_t size, const void *pSrc, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a memory write command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hBuffer – [in] Handle of the buffer object.
offset – [in] Offset in bytes in the buffer object.
size – [in] Size in bytes of data being written.
pSrc – [in] Pointer to host memory where data is to be written from.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferReadExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferReadExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hBuffer, size_t offset, size_t size, void *pDst, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a memory read command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hBuffer – [in] Handle of the buffer object.
offset – [in] Offset in bytes in the buffer object.
size – [in] Size in bytes of data being written.
pDst – [in] Pointer to host memory where data is to be written to.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferCopyRectExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferCopyRectExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hSrcMem, ur_mem_handle_t hDstMem, ur_rect_offset_t srcOrigin, ur_rect_offset_t dstOrigin, ur_rect_region_t region, size_t srcRowPitch, size_t srcSlicePitch, size_t dstRowPitch, size_t dstSlicePitch, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a rectangular memory copy command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hSrcMem – [in] The data to be copied.
hDstMem – [in] The location the data will be copied to.
srcOrigin – [in] Origin for the region of data to be copied from the source.
dstOrigin – [in] Origin for the region of data to be copied to in the destination.
region – [in] The extents describing the region to be copied.
srcRowPitch – [in] Row pitch of the source memory.
srcSlicePitch – [in] Slice pitch of the source memory.
dstRowPitch – [in] Row pitch of the destination memory.
dstSlicePitch – [in] Slice pitch of the destination memory.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hSrcMem
NULL == hDstMem
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferWriteRectExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferWriteRectExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hBuffer, ur_rect_offset_t bufferOffset, ur_rect_offset_t hostOffset, ur_rect_region_t region, size_t bufferRowPitch, size_t bufferSlicePitch, size_t hostRowPitch, size_t hostSlicePitch, void *pSrc, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a rectangular memory write command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hBuffer – [in] Handle of the buffer object.
bufferOffset – [in] 3D offset in the buffer.
hostOffset – [in] 3D offset in the host region.
region – [in] 3D rectangular region descriptor: width, height, depth.
bufferRowPitch – [in] Length of each row in bytes in the buffer object.
bufferSlicePitch – [in] Length of each 2D slice in bytes in the buffer object being written.
hostRowPitch – [in] Length of each row in bytes in the host memory region pointed to by pSrc.
hostSlicePitch – [in] Length of each 2D slice in bytes in the host memory region pointed to by pSrc.
pSrc – [in] Pointer to host memory where data is to be written from.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pSrc
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferReadRectExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferReadRectExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hBuffer, ur_rect_offset_t bufferOffset, ur_rect_offset_t hostOffset, ur_rect_region_t region, size_t bufferRowPitch, size_t bufferSlicePitch, size_t hostRowPitch, size_t hostSlicePitch, void *pDst, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a rectangular memory read command to a command-buffer object.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hBuffer – [in] Handle of the buffer object.
bufferOffset – [in] 3D offset in the buffer.
hostOffset – [in] 3D offset in the host region.
region – [in] 3D rectangular region descriptor: width, height, depth.
bufferRowPitch – [in] Length of each row in bytes in the buffer object.
bufferSlicePitch – [in] Length of each 2D slice in bytes in the buffer object being read.
hostRowPitch – [in] Length of each row in bytes in the host memory region pointed to by pDst.
hostSlicePitch – [in] Length of each 2D slice in bytes in the host memory region pointed to by pDst.
pDst – [in] Pointer to host memory where data is to be read into.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] Sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pDst
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendMemBufferFillExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemBufferFillExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_mem_handle_t hBuffer, const void *pPattern, size_t patternSize, size_t offset, size_t size, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a memory fill command to a command-buffer object.
- Parameters
hCommandBuffer – [in] handle of the command-buffer object.
hBuffer – [in] handle of the buffer object.
pPattern – [in] pointer to the fill pattern.
patternSize – [in] size in bytes of the pattern.
offset – [in] offset into the buffer.
size – [in] fill size in bytes, must be a multiple of patternSize.
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pPattern
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
If
offset + size
results in an out-of-bounds access.
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendUSMPrefetchExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendUSMPrefetchExp(ur_exp_command_buffer_handle_t hCommandBuffer, const void *pMemory, size_t size, ur_usm_migration_flags_t flags, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a USM Prefetch command to a command-buffer object.
Prefetching may not be supported for all devices or allocation types. If memory prefetching is not supported, the prefetch hint will be ignored.
- Parameters
hCommandBuffer – [in] handle of the command-buffer object.
pMemory – [in] pointer to USM allocated memory to prefetch.
size – [in] size in bytes to be fetched.
flags – [in] USM prefetch flags
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMemory
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_MIGRATION_FLAGS_MASK & flags
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
size == 0
If
size
is higher than the allocation size ofpMemory
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferAppendUSMAdviseExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendUSMAdviseExp(ur_exp_command_buffer_handle_t hCommandBuffer, const void *pMemory, size_t size, ur_usm_advice_flags_t advice, uint32_t numSyncPointsInWaitList, const ur_exp_command_buffer_sync_point_t *pSyncPointWaitList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_exp_command_buffer_sync_point_t *pSyncPoint, ur_event_handle_t *phEvent, ur_exp_command_buffer_command_handle_t *phCommand)#
Append a USM Advise command to a command-buffer object.
Not all memory advice hints may be supported for all devices or allocation types. If a memory advice hint is not supported, it will be ignored.
- Parameters
hCommandBuffer – [in] handle of the command-buffer object.
pMemory – [in] pointer to the USM memory object.
size – [in] size in bytes to be advised.
advice – [in] USM memory advice
numSyncPointsInWaitList – [in] The number of sync points in the provided dependency list.
pSyncPointWaitList – [in][optional] A list of sync points that this command depends on. May be ignored if command-buffer is in-order.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
pSyncPoint – [out][optional] sync point associated with this command.
phEvent – [out][optional] return an event object that will be signaled by the completion of this command in the next execution of the command-buffer.
phCommand – [out][optional] Handle to this command.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pMemory
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_USM_ADVICE_FLAGS_MASK & advice
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_SYNC_POINT_WAIT_LIST_EXP
pSyncPointWaitList == NULL && numSyncPointsInWaitList > 0
pSyncPointWaitList != NULL && numSyncPointsInWaitList == 0
size == 0
If
size
is higher than the allocation size ofpMemory
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If the device associated with
hCommandBuffer
does not support UR_DEVICE_INFO_COMMAND_BUFFER_EVENT_SUPPORT_EXP and eitherphEvent
orphEventWaitList
are not NULL.
urCommandBufferEnqueueExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferEnqueueExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_queue_handle_t hQueue, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Submit a command-buffer for execution on a queue.
- Parameters
hCommandBuffer – [in] Handle of the command-buffer object.
hQueue – [in] The queue to submit this command-buffer for execution.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command-buffer execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
phEvent – [out][optional] return an event object that identifies this particular command-buffer execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
NULL == hQueue
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
urCommandBufferRetainCommandExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferRetainCommandExp(ur_exp_command_buffer_command_handle_t hCommand)#
Increment the command object’s reference count.
- Parameters
hCommand – [in][retain] Handle of the command-buffer command.
- Returns
urCommandBufferReleaseCommandExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferReleaseCommandExp(ur_exp_command_buffer_command_handle_t hCommand)#
Decrement the command object’s reference count and delete the command object if the reference count becomes zero.
- Parameters
hCommand – [in][release] Handle of the command-buffer command.
- Returns
urCommandBufferUpdateKernelLaunchExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferUpdateKernelLaunchExp(ur_exp_command_buffer_command_handle_t hCommand, const ur_exp_command_buffer_update_kernel_launch_desc_t *pUpdateKernelLaunch)#
Update a kernel launch command in a finalized command-buffer.
This entry-point is synchronous and may block if the command-buffer is executing when the entry-point is called.
- Parameters
hCommand – [in] Handle of the command-buffer kernel command to update.
pUpdateKernelLaunch – [in] Struct defining how the kernel command is to be updated.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommand
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pUpdateKernelLaunch
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If update functionality is not supported by the device.
UR_RESULT_ERROR_INVALID_OPERATION
If ur_exp_command_buffer_desc_t::isUpdatable was not set to true on creation of the command buffer
hCommand
belongs to.If the command-buffer
hCommand
belongs to has not been finalized.
UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_COMMAND_HANDLE_EXP - “If `hCommand` is not a kernel execution command.”
UR_RESULT_ERROR_INVALID_WORK_DIMENSION
pUpdateKernelLaunch->newWorkDim < 1 || pUpdateKernelLaunch->newWorkDim > 3
If
pUpdateKernelLaunch->hNewKernel
was not passed to thehKernel
orphKernelAlternatives
parameters of urCommandBufferAppendKernelLaunchExp when this command was created.If
pUpdateKernelLaunch->newWorkDim
is different from the current workDim inhCommand
and, pUpdateKernelLaunch->pNewGlobalWorkSize, or pUpdateKernelLaunch->pNewGlobalWorkOffset are nullptr.
urCommandBufferUpdateSignalEventExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferUpdateSignalEventExp(ur_exp_command_buffer_command_handle_t hCommand, ur_event_handle_t *phSignalEvent)#
Get a new event that will be signaled the next time the command in the command-buffer executes.
It is the users responsibility to release the returned
phSignalEvent
.- Parameters
hCommand – [in] Handle of the command-buffer command to update.
phSignalEvent – [out] Event to be signaled.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommand
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phSignalEvent
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_EVENTS is not supported by the device associated with
hCommand
.
UR_RESULT_ERROR_INVALID_OPERATION
If ur_exp_command_buffer_desc_t::isUpdatable was not set to true on creation of the command buffer
hCommand
belongs to.If the command-buffer
hCommand
belongs to has not been finalized.If no
phEvent
parameter was set on creation of the command associated withhCommand
.
urCommandBufferUpdateWaitEventsExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferUpdateWaitEventsExp(ur_exp_command_buffer_command_handle_t hCommand, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList)#
Set the list of wait events for a command to depend on to a list of new events.
- Parameters
hCommand – [in] Handle of the command-buffer command to update.
numEventsInWaitList – [in] Size of the event wait list.
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the command execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommand
UR_RESULT_ERROR_UNSUPPORTED_FEATURE
If UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_EVENTS is not supported by the device associated with
hCommand
.
UR_RESULT_ERROR_INVALID_OPERATION
If ur_exp_command_buffer_desc_t::isUpdatable was not set to true on creation of the command buffer
hCommand
belongs to.If the command-buffer
hCommand
belongs to has not been finalized.
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
If
numEventsInWaitList
does not match the number of wait events set when the command associated withhCommand
was created.
urCommandBufferGetInfoExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferGetInfoExp(ur_exp_command_buffer_handle_t hCommandBuffer, ur_exp_command_buffer_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get command-buffer object information.
- Parameters
hCommandBuffer – [in] handle of the command-buffer object
propName – [in] the name of the command-buffer property to query
propSize – [in] size in bytes of the command-buffer property value
pPropValue – [out][optional][typename(propName, propSize)] value of the command-buffer property
pPropSizeRet – [out][optional] bytes returned in command-buffer property
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommandBuffer
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_COMMAND_BUFFER_INFO_DESCRIPTOR < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
urCommandBufferCommandGetInfoExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferCommandGetInfoExp(ur_exp_command_buffer_command_handle_t hCommand, ur_exp_command_buffer_command_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Get command-buffer object information.
- Parameters
hCommand – [in] handle of the command-buffer command object
propName – [in] the name of the command-buffer command property to query
propSize – [in] size in bytes of the command-buffer command property value
pPropValue – [out][optional][typename(propName, propSize)] value of the command-buffer command property
pPropSizeRet – [out][optional] bytes returned in command-buffer command property
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hCommand
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
Command buffer (experimental) Enums#
ur_device_command_buffer_update_capability_flags_t#
-
enum ur_device_command_buffer_update_capability_flag_t#
Values:
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_KERNEL_ARGUMENTS#
Device supports updating the kernel arguments in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_LOCAL_WORK_SIZE#
Device supports updating the local work-group size in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_GLOBAL_WORK_SIZE#
Device supports updating the global work-group size in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_GLOBAL_WORK_OFFSET#
Device supports updating the global work offset in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_KERNEL_HANDLE#
Device supports updating the kernel handle in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_EVENTS#
Device supports updating the event parameters in command-buffer commands.
-
enumerator UR_DEVICE_COMMAND_BUFFER_UPDATE_CAPABILITY_FLAG_KERNEL_ARGUMENTS#
ur_exp_command_buffer_info_t#
-
enum ur_exp_command_buffer_info_t#
Command-buffer query information type.
Values:
-
enumerator UR_EXP_COMMAND_BUFFER_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the command-buffer object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_EXP_COMMAND_BUFFER_INFO_DESCRIPTOR#
[ur_exp_command_buffer_desc_t] Returns a ur_exp_command_buffer_desc_t with the properties of the command-buffer. Returned values may differ from those passed on construction if the property was ignored by the adapter.
-
enumerator UR_EXP_COMMAND_BUFFER_INFO_REFERENCE_COUNT#
ur_exp_command_buffer_command_info_t#
-
enum ur_exp_command_buffer_command_info_t#
Command-buffer command query information type.
Values:
-
enumerator UR_EXP_COMMAND_BUFFER_COMMAND_INFO_REFERENCE_COUNT#
[uint32_t] Reference count of the command-buffer object. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
-
enumerator UR_EXP_COMMAND_BUFFER_COMMAND_INFO_REFERENCE_COUNT#
Command buffer (experimental) Structures#
ur_exp_command_buffer_desc_t#
-
struct ur_exp_command_buffer_desc_t#
Command-Buffer Descriptor Type.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_structure_type_t stype#
ur_exp_command_buffer_update_memobj_arg_desc_t#
-
struct ur_exp_command_buffer_update_memobj_arg_desc_t#
Descriptor type for updating a kernel command memobj argument.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_MEMOBJ_ARG_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
uint32_t argIndex#
[in] Argument index.
-
const ur_kernel_arg_mem_obj_properties_t *pProperties#
[in][optional] Pointer to memory object properties.
-
ur_mem_handle_t hNewMemObjArg#
[in][optional] Handle of memory object to set at argument index.
-
ur_structure_type_t stype#
ur_exp_command_buffer_update_pointer_arg_desc_t#
-
struct ur_exp_command_buffer_update_pointer_arg_desc_t#
Descriptor type for updating a kernel command pointer argument.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_POINTER_ARG_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
uint32_t argIndex#
[in] Argument index.
-
const ur_kernel_arg_pointer_properties_t *pProperties#
[in][optional] Pointer to USM pointer properties.
-
const void *pNewPointerArg#
[in][optional] USM pointer to memory location holding the argument value to set at argument index.
-
ur_structure_type_t stype#
ur_exp_command_buffer_update_value_arg_desc_t#
-
struct ur_exp_command_buffer_update_value_arg_desc_t#
Descriptor type for updating a kernel command value argument.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_VALUE_ARG_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
uint32_t argIndex#
[in] Argument index.
-
size_t argSize#
[in] Argument size.
-
const ur_kernel_arg_value_properties_t *pProperties#
[in][optional] Pointer to value properties.
-
const void *pNewValueArg#
[in][optional] Argument value representing matching kernel arg type to set at argument index.
-
ur_structure_type_t stype#
ur_exp_command_buffer_update_kernel_launch_desc_t#
-
struct ur_exp_command_buffer_update_kernel_launch_desc_t#
Descriptor type for updating a kernel launch command.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_UPDATE_KERNEL_LAUNCH_DESC
-
const void *pNext#
[in][optional] pointer to extension-specific structure
-
ur_kernel_handle_t hNewKernel#
[in][optional] The new kernel handle. If this parameter is nullptr, the current kernel handle in
hCommand
will be used. If a kernel handle is passed, it must be a valid kernel alternative as defined in urCommandBufferAppendKernelLaunchExp.
-
uint32_t numNewMemObjArgs#
[in] Length of pNewMemObjArgList.
-
uint32_t numNewPointerArgs#
[in] Length of pNewPointerArgList.
-
uint32_t numNewValueArgs#
[in] Length of pNewValueArgList.
-
uint32_t newWorkDim#
[in] Number of work dimensions in the kernel ND-range, from 1-3.
-
const ur_exp_command_buffer_update_memobj_arg_desc_t *pNewMemObjArgList#
[in][optional][range(0, numNewMemObjArgs)] An array describing the new kernel mem obj arguments for the command.
-
const ur_exp_command_buffer_update_pointer_arg_desc_t *pNewPointerArgList#
[in][optional][range(0, numNewPointerArgs)] An array describing the new kernel pointer arguments for the command.
-
const ur_exp_command_buffer_update_value_arg_desc_t *pNewValueArgList#
[in][optional][range(0, numNewValueArgs)] An array describing the new kernel value arguments for the command.
-
size_t *pNewGlobalWorkOffset#
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the offset used to calculate the global ID. If this parameter is nullptr, the current global work offset will be used. This parameter is required if
newWorkDim
is different from the current work dimensions in the command.
-
size_t *pNewGlobalWorkSize#
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the number of global work-items. If this parameter is nullptr, the current global work size in
hCommand
will be used. This parameter is required ifnewWorkDim
is different from the current work dimensions in the command.
-
size_t *pNewLocalWorkSize#
[in][optional][range(0, newWorkDim)] Array of newWorkDim unsigned values that describe the number of work-items that make up a work-group. If
pNewGlobalWorkSize
is set andpNewLocalWorkSize
is nullptr, then the runtime implementation will choose the local work size. IfpNewGlobalWorkSize
is nullptr andpNewLocalWorkSize
is nullptr, the current local work size in the command will be used.
-
ur_structure_type_t stype#
Command buffer (experimental) Macros#
Cooperative kernels (experimental)#
Functions
Macros
Cooperative kernels (experimental) Functions#
urEnqueueCooperativeKernelLaunchExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp(ur_queue_handle_t hQueue, ur_kernel_handle_t hKernel, uint32_t workDim, const size_t *pGlobalWorkOffset, const size_t *pGlobalWorkSize, const size_t *pLocalWorkSize, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command to execute a cooperative kernel.
- Parameters
hQueue – [in] handle of the queue object
hKernel – [in] handle of the kernel object
workDim – [in] number of dimensions, from 1 to 3, to specify the global and work-group work-items
pGlobalWorkOffset – [in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item
pGlobalWorkSize – [in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function
pLocalWorkSize – [in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. If nullptr, the runtime implementation will choose the work-group size.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalWorkOffset
NULL == pGlobalWorkSize
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
urKernelSuggestMaxCooperativeGroupCountExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urKernelSuggestMaxCooperativeGroupCountExp(ur_kernel_handle_t hKernel, ur_device_handle_t hDevice, uint32_t workDim, const size_t *pLocalWorkSize, size_t dynamicSharedMemorySize, uint32_t *pGroupCountRet)#
Query the maximum number of work groups for a cooperative kernel.
- Parameters
hKernel – [in] handle of the kernel object
hDevice – [in] handle of the device object
workDim – [in] number of dimensions, from 1 to 3, to specify the work-group work-items
pLocalWorkSize – [in] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function.
dynamicSharedMemorySize – [in] size of dynamic shared memory, for each work-group, in bytes, that will be used when the kernel is launched
pGroupCountRet – [out] pointer to maximum number of groups
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hKernel
NULL == hDevice
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pLocalWorkSize
NULL == pGroupCountRet
Enqueue timestamp recording (experimental)#
Functions
Enqueue timestamp recording (experimental) Functions#
urEnqueueTimestampRecordingExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueTimestampRecordingExp(ur_queue_handle_t hQueue, bool blocking, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a command for recording the device timestamp.
- Parameters
hQueue – [in] handle of the queue object
blocking – [in] indicates whether the call to this function should block until until the device timestamp recording command has executed on the device.
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
phEvent – [in,out] return an event object that identifies this particular kernel execution instance. Profiling information can be queried from this event as if `hQueue` had profiling enabled. Querying `UR_PROFILING_INFO_COMMAND_QUEUED` or `UR_PROFILING_INFO_COMMAND_SUBMIT` reports the timestamp at the time of the call to this function. Querying `UR_PROFILING_INFO_COMMAND_START` or `UR_PROFILING_INFO_COMMAND_END` reports the timestamp recorded when the command is executed on the device. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phEvent
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
Launch properties (experimental)#
Functions
Enumerations
Structures
Macros
Launch properties (experimental) Functions#
urEnqueueKernelLaunchCustomExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueKernelLaunchCustomExp(ur_queue_handle_t hQueue, ur_kernel_handle_t hKernel, uint32_t workDim, const size_t *pGlobalWorkOffset, const size_t *pGlobalWorkSize, const size_t *pLocalWorkSize, uint32_t numPropsInLaunchPropList, const ur_exp_launch_property_t *launchPropList, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Launch kernel with custom launch properties.
Launches the kernel using the specified launch properties
If numPropsInLaunchPropList == 0 then a regular kernel launch is used:
urEnqueueKernelLaunch
Consult the appropriate adapter driver documentation for details of adapter specific behavior and native error codes that may be returned.
Remark
Analogues
cuLaunchKernelEx
- Parameters
hQueue – [in] handle of the queue object
hKernel – [in] handle of the kernel object
workDim – [in] number of dimensions, from 1 to 3, to specify the global and work-group work-items
pGlobalWorkOffset – [in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item
pGlobalWorkSize – [in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function
pLocalWorkSize – [in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. If nullptr, the runtime implementation will choose the work-group size.
numPropsInLaunchPropList – [in] size of the launch prop list
launchPropList – [in][range(0, numPropsInLaunchPropList)] pointer to a list of launch properties
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event.
phEvent – [out][optional] return an event object that identifies this particular kernel execution instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
NULL == hKernel
NULL == hQueue
NULL == hKernel
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pGlobalWorkOffset
NULL == pGlobalWorkSize
NULL == launchPropList
NULL == pGlobalWorkSize
numPropsInLaunchpropList != 0 && launchPropList == NULL
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in phEventWaitList has UR_EVENT_STATUS_ERROR
Launch properties (experimental) Enums#
ur_exp_launch_property_id_t#
-
enum ur_exp_launch_property_id_t#
Specifies a launch property id.
Remark
Analogues
CUlaunchAttributeID
Values:
-
enumerator UR_EXP_LAUNCH_PROPERTY_ID_IGNORE#
The property has no effect.
-
enumerator UR_EXP_LAUNCH_PROPERTY_ID_COOPERATIVE#
Whether to launch a cooperative kernel.
-
enumerator UR_EXP_LAUNCH_PROPERTY_ID_CLUSTER_DIMENSION#
work-group cluster dimensions
-
enumerator UR_EXP_LAUNCH_PROPERTY_ID_WORK_GROUP_MEMORY#
Implicit work group memory allocation
Launch properties (experimental) Structures#
ur_exp_launch_property_value_t#
-
union ur_exp_launch_property_value_t#
- #include <>
Specifies a launch property value.
Remark
Analogues
CUlaunchAttributeValue
Public Members
-
uint32_t clusterDim[3]#
[in] dimensions of the cluster (units of work-group) (x, y, z). Each value must be a divisor of the corresponding global work-size dimension (in units of work-group).
-
int cooperative#
[in] non-zero value indicates a cooperative kernel
-
size_t workgroup_mem_size#
[in] non-zero value indicates the amount of work group memory to allocate in bytes
ur_exp_launch_property_t#
-
struct ur_exp_launch_property_t#
Kernel launch property.
Remark
Analogues
cuLaunchAttribute
Public Members
-
ur_exp_launch_property_id_t id#
[in] launch property id
-
ur_exp_launch_property_value_t value#
[in][tagged_by(id)] launch property value
Multi device compile (experimental)#
Functions
Macros
Multi device compile (experimental) Functions#
urProgramBuildExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramBuildExp(ur_program_handle_t hProgram, uint32_t numDevices, ur_device_handle_t *phDevices, const char *pOptions)#
Produces an executable program from one program, negates need for the linking step.
The application may call this function from simultaneous threads.
Following a successful call to this entry point, the program passed will contain a binary of the UR_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device in
phDevices
.
Remark
Analogues
clBuildProgram
- Parameters
hProgram – [in] Handle of the program to build.
numDevices – [in] number of devices
phDevices – [in][range(0, numDevices)] pointer to array of device handles
pOptions – [in][optional] pointer to build options null-terminated string.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevices
UR_RESULT_ERROR_INVALID_PROGRAM
If
hProgram
isn’t a valid program object.
UR_RESULT_ERROR_PROGRAM_BUILD_FAILURE
If an error occurred when building
hProgram
.
urProgramCompileExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramCompileExp(ur_program_handle_t hProgram, uint32_t numDevices, ur_device_handle_t *phDevices, const char *pOptions)#
Produces an executable program from one or more programs.
The application may call this function from simultaneous threads.
Following a successful call to this entry point
hProgram
will contain a binary of the UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT type for each device inphDevices
.
Remark
Analogues
clCompileProgram
- Parameters
hProgram – [in][out] handle of the program to compile.
numDevices – [in] number of devices
phDevices – [in][range(0, numDevices)] pointer to array of device handles
pOptions – [in][optional] pointer to build options null-terminated string.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hProgram
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevices
UR_RESULT_ERROR_INVALID_PROGRAM
If
hProgram
isn’t a valid program object.
UR_RESULT_ERROR_PROGRAM_BUILD_FAILURE
If an error occurred while compiling
hProgram
.
urProgramLinkExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urProgramLinkExp(ur_context_handle_t hContext, uint32_t numDevices, ur_device_handle_t *phDevices, uint32_t count, const ur_program_handle_t *phPrograms, const char *pOptions, ur_program_handle_t *phProgram)#
Produces an executable program from one or more programs.
The application may call this function from simultaneous threads.
Following a successful call to this entry point the program returned in
phProgram
will contain a binary of the UR_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device inphDevices
.If a non-success code is returned and
phProgram
is notnullptr
, it will contain an unspecified program ornullptr
. Implementations may use the build log of this program (accessible via urProgramGetBuildInfo) to provide an error log for the linking failure.
Remark
Analogues
clLinkProgram
- Parameters
hContext – [in] handle of the context instance.
numDevices – [in] number of devices
phDevices – [in][range(0, numDevices)] pointer to array of device handles
count – [in] number of program handles in `phPrograms`.
phPrograms – [in][range(0, count)] pointer to array of program handles.
pOptions – [in][optional] pointer to linker options null-terminated string.
phProgram – [out] pointer to handle of program object created.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hContext
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == phDevices
NULL == phPrograms
NULL == phProgram
UR_RESULT_ERROR_INVALID_PROGRAM
If one of the programs in
phPrograms
isn’t a valid program object.
count == 0
UR_RESULT_ERROR_PROGRAM_LINK_FAILURE
If an error occurred while linking
phPrograms
.
Usm import release (experimental)#
Functions
Usm import release (experimental) Functions#
urUSMImportExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMImportExp(ur_context_handle_t hContext, void *pMem, size_t size)#
Import memory into USM.
Import memory into USM
- Parameters
hContext – [in] handle of the context object
pMem – [in] pointer to host memory object
size – [in] size in bytes of the host memory object to be imported
- Returns
urUSMReleaseExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUSMReleaseExp(ur_context_handle_t hContext, void *pMem)#
Release memory from USM.
Release memory from USM
- Parameters
hContext – [in] handle of the context object
pMem – [in] pointer to host memory object
- Returns
Usm p2p (experimental)#
Functions
Enumerations
Macros
Usm p2p (experimental) Functions#
urUsmP2PEnablePeerAccessExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUsmP2PEnablePeerAccessExp(ur_device_handle_t commandDevice, ur_device_handle_t peerDevice)#
Enable access to peer device memory.
Enables the command device to access and write device memory allocations located on the peer device, provided that a P2P link between the two devices is available.
When Peer Access is successfully enabled, P2P memory accesses are guaranteed to be allowed on the peer device until urUsmP2PDisablePeerAccessExp is called.
Note that the function operands may, but aren’t guaranteed to, commute for a given adapter: the peer device is not guaranteed to have access to device memory allocations located on the command device.
It is not guaranteed that the commutation relations of the function arguments are identical for peer access and peer copies: For example, for a given adapter the peer device may be able to copy data from the command device, but not access and write the same data on the command device.
Consult the appropriate adapter driver documentation for details of adapter specific behavior and native error codes that may be returned.
Remark
Analogues
cuCtxEnablePeerAccess
- Parameters
commandDevice – [in] handle of the command device object
peerDevice – [in] handle of the peer device object
- Returns
urUsmP2PDisablePeerAccessExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUsmP2PDisablePeerAccessExp(ur_device_handle_t commandDevice, ur_device_handle_t peerDevice)#
Disable access to peer device memory.
Disables the ability of the command device to access and write device memory allocations located on the peer device, provided that a P2P link between the two devices was enabled prior to the call.
Note that the function operands may, but aren’t guaranteed to, commute for a given adapter. If, prior to the function call, the peer device had access to device memory allocations on the command device, it is not guaranteed to still have such access following the function return.
It is not guaranteed that the commutation relations of the function arguments are identical for peer access and peer copies: For example for a given adapter, if, prior to the call, the peer device had access to device memory allocations on the command device, the peer device may still, following the function call, be able to copy data from the command device, but not access and write the same data on the command device.
Consult the appropriate adapter driver documentation for details of adapter specific behavior and native error codes that may be returned.
Remark
Analogues
cuCtxDisablePeerAccess
- Parameters
commandDevice – [in] handle of the command device object
peerDevice – [in] handle of the peer device object
- Returns
urUsmP2PPeerAccessGetInfoExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urUsmP2PPeerAccessGetInfoExp(ur_device_handle_t commandDevice, ur_device_handle_t peerDevice, ur_exp_peer_info_t propName, size_t propSize, void *pPropValue, size_t *pPropSizeRet)#
Disable access to peer device memory.
Queries the peer access capabilities from the command device to the peer device according to the query
propName
.
Remark
Analogues
cuDeviceGetP2PAttribute
- Parameters
commandDevice – [in] handle of the command device object
peerDevice – [in] handle of the peer device object
propName – [in] type of the info to retrieve
propSize – [in] the number of bytes pointed to by pPropValue.
pPropValue – [out][optional][typename(propName, propSize)] array of bytes holding the info. If propSize is not equal to or greater than the real number of bytes needed to return the info then the UR_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used.
pPropSizeRet – [out][optional] pointer to the actual size in bytes of the queried propName.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == commandDevice
NULL == peerDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_PEER_INFO_UR_PEER_ATOMICS_SUPPORTED < propName
UR_RESULT_ERROR_UNSUPPORTED_ENUMERATION
If
propName
is not supported by the adapter.
propSize == 0 && pPropValue != NULL
If
propSize
is less than the real number of bytes needed to return the info.
UR_RESULT_ERROR_INVALID_NULL_POINTER
propSize != 0 && pPropValue == NULL
pPropValue == NULL && pPropSizeRet == NULL
Usm p2p (experimental) Enums#
ur_exp_peer_info_t#
-
enum ur_exp_peer_info_t#
Supported peer info.
Values:
-
enumerator UR_EXP_PEER_INFO_UR_PEER_ACCESS_SUPPORTED#
[int] 1 if P2P access is supported otherwise P2P access is not supported.
-
enumerator UR_EXP_PEER_INFO_UR_PEER_ATOMICS_SUPPORTED#
[int] 1 if atomic operations are supported over the P2P link, otherwise such operations are not supported.
-
enumerator UR_EXP_PEER_INFO_UR_PEER_ACCESS_SUPPORTED#
Low power events (experimental)#
Functions
Enumerations
Structures
Low power events (experimental) Functions#
urEnqueueEventsWaitWithBarrierExt#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueEventsWaitWithBarrierExt(ur_queue_handle_t hQueue, const ur_exp_enqueue_ext_properties_t *pProperties, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Enqueue a barrier command which waits a list of events to complete before it completes, with optional extended properties.
If the event list is empty, it waits for all previously enqueued commands to complete.
It blocks command execution - any following commands enqueued after it do not execute until it completes.
It returns an event which can be waited on.
Remark
Analogues
clEnqueueBarrierWithWaitList
- Parameters
hQueue – [in] handle of the queue object
pProperties – [in][optional] pointer to the extended enqueue properties
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands must be complete.
phEvent – [out][optional] return an event object that identifies this particular command instance. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_EXP_ENQUEUE_EXT_FLAGS_MASK & pProperties->flags
UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
phEventWaitList == NULL && numEventsInWaitList > 0
phEventWaitList != NULL && numEventsInWaitList == 0
If event objects in phEventWaitList are not valid events.
UR_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS
An event in
phEventWaitList
has UR_EVENT_STATUS_ERROR.
Low power events (experimental) Enums#
ur_exp_enqueue_ext_flags_t#
-
enum ur_exp_enqueue_ext_flag_t#
Values:
-
enumerator UR_EXP_ENQUEUE_EXT_FLAG_LOW_POWER_EVENTS#
Hint: use low-power events. Only meaningful for Level Zero, where the implementation may use interrupt-driven events. May reduce CPU utilization at the cost of increased event completion latency. Other platforms may ignore this flag.
-
enumerator UR_EXP_ENQUEUE_EXT_FLAG_LOW_POWER_EVENTS#
Low power events (experimental) Structures#
ur_exp_enqueue_ext_properties_t#
-
struct ur_exp_enqueue_ext_properties_t#
Extended enqueue properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_ENQUEUE_EXT_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_exp_enqueue_ext_flags_t flags#
[in] extended enqueue flags
-
ur_structure_type_t stype#
Native enqueue (experimental)#
Functions
Enumerations
Structures
Typedefs
Native enqueue (experimental) Functions#
urEnqueueNativeCommandExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urEnqueueNativeCommandExp(ur_queue_handle_t hQueue, ur_exp_enqueue_native_command_function_t pfnNativeEnqueue, void *data, uint32_t numMemsInMemList, const ur_mem_handle_t *phMemList, const ur_exp_enqueue_native_command_properties_t *pProperties, uint32_t numEventsInWaitList, const ur_event_handle_t *phEventWaitList, ur_event_handle_t *phEvent)#
Immediately enqueue work through a native backend API.
- Parameters
hQueue – [in] handle of the queue object
pfnNativeEnqueue – [in] function calling the native underlying API, to be executed immediately.
data – [in][optional] data used by pfnNativeEnqueue
numMemsInMemList – [in] size of the mem list
phMemList – [in][optional][range(0, numMemsInMemList)] mems that are used within pfnNativeEnqueue using urMemGetNativeHandle. If nullptr, the numMemsInMemList must be 0, indicating that no mems are accessed with urMemGetNativeHandle within pfnNativeEnqueue.
pProperties – [in][optional] pointer to the native enqueue properties
numEventsInWaitList – [in] size of the event wait list
phEventWaitList – [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. If nullptr, the numEventsInWaitList must be 0, indicating no wait events.
phEvent – [out][optional] return an event object that identifies the work that has been enqueued in nativeEnqueueFunc. If phEventWaitList and phEvent are not NULL, phEvent must not refer to an element of the phEventWaitList array.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hQueue
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == pfnNativeEnqueue
UR_RESULT_ERROR_INVALID_ENUMERATION
NULL != pProperties && UR_EXP_ENQUEUE_NATIVE_COMMAND_FLAGS_MASK & pProperties->flags
Native enqueue (experimental) Enums#
Native enqueue (experimental) Structures#
ur_exp_enqueue_native_command_properties_t#
-
struct ur_exp_enqueue_native_command_properties_t#
Native enqueue properties.
Public Members
-
ur_structure_type_t stype#
[in] type of this structure, must be UR_STRUCTURE_TYPE_EXP_ENQUEUE_NATIVE_COMMAND_PROPERTIES
-
void *pNext#
[in,out][optional] pointer to extension-specific structure
-
ur_exp_enqueue_native_command_flags_t flags#
[in] native enqueue flags
-
ur_structure_type_t stype#
Tensor map (experimental)#
Functions
Enumerations
Tensor map (experimental) Functions#
urTensorMapEncodeIm2ColExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urTensorMapEncodeIm2ColExp(ur_device_handle_t hDevice, ur_exp_tensor_map_data_type_flags_t TensorMapType, uint32_t TensorRank, void *GlobalAddress, const uint64_t *GlobalDim, const uint64_t *GlobalStrides, const int *PixelBoxLowerCorner, const int *PixelBoxUpperCorner, uint32_t ChannelsPerPixel, uint32_t PixelsPerColumn, const uint32_t *ElementStrides, ur_exp_tensor_map_interleave_flags_t Interleave, ur_exp_tensor_map_swizzle_flags_t Swizzle, ur_exp_tensor_map_l2_promotion_flags_t L2Promotion, ur_exp_tensor_map_oob_fill_flags_t OobFill, ur_exp_tensor_map_handle_t *hTensorMap)#
Encode tensor map with image data.
Map encode using im2col.
- Parameters
hDevice – [in] Handle of the device object.
TensorMapType – [in] Data type of the tensor object.
TensorRank – [in] Dimensionality of tensor; must be at least 3.
GlobalAddress – [in] Starting address of memory region described by tensor.
GlobalDim – [in] Array containing tensor size (number of elements) along each of the TensorRank dimensions.
GlobalStrides – [in] Array containing stride size (in bytes) along each of the TensorRank - 1 dimensions.
PixelBoxLowerCorner – [in] Array containing DHW dimensions of lower box corner.
PixelBoxUpperCorner – [in] Array containing DHW dimensions of upper box corner.
ChannelsPerPixel – [in] Number of channels per pixel.
PixelsPerColumn – [in] Number of pixels per column.
ElementStrides – [in] Array containing traversal stride in each of the TensorRank dimensions.
Interleave – [in] Type of interleaved layout the tensor addresses
Swizzle – [in] Bank swizzling pattern inside shared memory
L2Promotion – [in] L2 promotion size.
OobFill – [in] Indicates whether zero or special NaN constant will be used to fill out-of-bounds elements.
hTensorMap – [out] Handle of the tensor map object.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_TENSOR_MAP_DATA_TYPE_FLAGS_MASK & TensorMapType
UR_EXP_TENSOR_MAP_INTERLEAVE_FLAGS_MASK & Interleave
UR_EXP_TENSOR_MAP_SWIZZLE_FLAGS_MASK & Swizzle
UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAGS_MASK & L2Promotion
UR_EXP_TENSOR_MAP_OOB_FILL_FLAGS_MASK & OobFill
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == GlobalAddress
NULL == GlobalDim
NULL == GlobalStrides
NULL == PixelBoxLowerCorner
NULL == PixelBoxUpperCorner
NULL == ElementStrides
NULL == hTensorMap
UR_RESULT_ERROR_INVALID_ARGUMENT
TensorRank < 3
urTensorMapEncodeTiledExp#
-
UR_APIEXPORT ur_result_t UR_APICALL urTensorMapEncodeTiledExp(ur_device_handle_t hDevice, ur_exp_tensor_map_data_type_flags_t TensorMapType, uint32_t TensorRank, void *GlobalAddress, const uint64_t *GlobalDim, const uint64_t *GlobalStrides, const uint32_t *BoxDim, const uint32_t *ElementStrides, ur_exp_tensor_map_interleave_flags_t Interleave, ur_exp_tensor_map_swizzle_flags_t Swizzle, ur_exp_tensor_map_l2_promotion_flags_t L2Promotion, ur_exp_tensor_map_oob_fill_flags_t OobFill, ur_exp_tensor_map_handle_t *hTensorMap)#
Encode tensor map with tiled data.
Tiled map encode.
- Parameters
hDevice – [in] Handle of the device object.
TensorMapType – [in] Data type of the tensor object.
TensorRank – [in] Dimensionality of tensor; must be at least 3.
GlobalAddress – [in] Starting address of memory region described by tensor.
GlobalDim – [in] Array containing tensor size (number of elements) along each of the TensorRank dimensions.
GlobalStrides – [in] Array containing stride size (in bytes) along each of the TensorRank - 1 dimensions.
BoxDim – [in] Array containing traversal box size (number of elments) along each of the TensorRank dimensions. Specifies how many elements to be traversed along each tensor dimension.
ElementStrides – [in] Array containing traversal stride in each of the TensorRank dimensions.
Interleave – [in] Type of interleaved layout the tensor addresses
Swizzle – [in] Bank swizzling pattern inside shared memory
L2Promotion – [in] L2 promotion size.
OobFill – [in] Indicates whether zero or special NaN constant will be used to fill out-of-bounds elements.
hTensorMap – [out] Handle of the tensor map object.
- Returns
UR_RESULT_ERROR_INVALID_NULL_HANDLE
NULL == hDevice
UR_RESULT_ERROR_INVALID_ENUMERATION
UR_EXP_TENSOR_MAP_DATA_TYPE_FLAGS_MASK & TensorMapType
UR_EXP_TENSOR_MAP_INTERLEAVE_FLAGS_MASK & Interleave
UR_EXP_TENSOR_MAP_SWIZZLE_FLAGS_MASK & Swizzle
UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAGS_MASK & L2Promotion
UR_EXP_TENSOR_MAP_OOB_FILL_FLAGS_MASK & OobFill
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == GlobalAddress
NULL == GlobalDim
NULL == GlobalStrides
NULL == BoxDim
NULL == ElementStrides
NULL == hTensorMap
UR_RESULT_ERROR_INVALID_ARGUMENT
TensorRank < 3
Tensor map (experimental) Enums#
ur_exp_tensor_map_data_type_flags_t#
-
enum ur_exp_tensor_map_data_type_flag_t#
Values:
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_UINT8#
1 byte
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_UINT16#
2 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_UINT32#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_INT32#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_UINT64#
8 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_INT64#
8 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_FLOAT16#
2 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_FLOAT32#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_FLOAT64#
8 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_BFLOAT16#
2 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_FLOAT32_FTZ#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_TFLOAT32#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_TFLOAT32_FTZ#
4 bytes
-
enumerator UR_EXP_TENSOR_MAP_DATA_TYPE_FLAG_UINT8#
ur_exp_tensor_map_interleave_flags_t#
ur_exp_tensor_map_l2_promotion_flags_t#
-
enum ur_exp_tensor_map_l2_promotion_flag_t#
Values:
-
enumerator UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_NONE#
No promotion type.
-
enumerator UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_64B#
64B promotion type
-
enumerator UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_128B#
128B promotion type
-
enumerator UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_256B#
256B promotion type
-
enumerator UR_EXP_TENSOR_MAP_L2_PROMOTION_FLAG_NONE#
ur_exp_tensor_map_swizzle_flags_t#
Print C API#
The Print API functions are helpful for printing Unified Runtime API objects’ values as human-readable strings using C interface. Those functions are complimentary to the set of operators in the Print C++ API.
Each function is named in the same style based on the Unified Runtime object name to be printed. See examples:
- To print the
ur_function_t
object’s value, call: - To print the
ur_kernel_arg_local_properties_t
object’s value, call:
There is also one ‘extras’ function in this API, which can be used for printing
all values of given function’s parameters - urPrintFunctionParams()
.
See Print C Functions for the description of common parameters of Print API functions.
- Functions
Print C Functions#
All functions output strings to print to the buffer
of a given
size buff_size
. The outputted string’s size is retrieved
with the out_size
parameter.
It is required for buff_size
to be less than out_size
in order
to write the output string to the buffer
. Otherwise, buffer
will not be modified.
urPrintFunction#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintFunction(enum ur_function_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_function_t enum.
- Returns
buff_size < out_size
urPrintStructureType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintStructureType(enum ur_structure_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_structure_type_t enum.
- Returns
buff_size < out_size
urPrintResult#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintResult(enum ur_result_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_result_t enum.
- Returns
buff_size < out_size
urPrintBaseProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBaseProperties(const struct ur_base_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_base_properties_t struct.
- Returns
buff_size < out_size
urPrintBaseDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBaseDesc(const struct ur_base_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_base_desc_t struct.
- Returns
buff_size < out_size
urPrintRectOffset#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintRectOffset(const struct ur_rect_offset_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_rect_offset_t struct.
- Returns
buff_size < out_size
urPrintRectRegion#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintRectRegion(const struct ur_rect_region_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_rect_region_t struct.
- Returns
buff_size < out_size
urPrintDeviceInitFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceInitFlags(enum ur_device_init_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_init_flag_t enum.
- Returns
buff_size < out_size
urPrintLoaderConfigInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigInfo(enum ur_loader_config_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_info_t enum.
- Returns
buff_size < out_size
urPrintCodeLocation#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCodeLocation(const struct ur_code_location_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_code_location_t struct.
- Returns
buff_size < out_size
urPrintAdapterInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterInfo(enum ur_adapter_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_info_t enum.
- Returns
buff_size < out_size
urPrintAdapterBackend#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterBackend(enum ur_adapter_backend_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_backend_t enum.
- Returns
buff_size < out_size
urPrintPlatformInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformInfo(enum ur_platform_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_info_t enum.
- Returns
buff_size < out_size
urPrintApiVersion#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintApiVersion(enum ur_api_version_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_api_version_t enum.
- Returns
buff_size < out_size
urPrintPlatformNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformNativeProperties(const struct ur_platform_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_native_properties_t struct.
- Returns
buff_size < out_size
urPrintPlatformBackend#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformBackend(enum ur_platform_backend_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_backend_t enum.
- Returns
buff_size < out_size
urPrintDeviceBinary#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceBinary(const struct ur_device_binary_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_binary_t struct.
- Returns
buff_size < out_size
urPrintDeviceType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceType(enum ur_device_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_type_t enum.
- Returns
buff_size < out_size
urPrintDeviceInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceInfo(enum ur_device_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_info_t enum.
- Returns
buff_size < out_size
urPrintDeviceAffinityDomainFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceAffinityDomainFlags(enum ur_device_affinity_domain_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_affinity_domain_flag_t enum.
- Returns
buff_size < out_size
urPrintDevicePartition#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDevicePartition(enum ur_device_partition_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_partition_t enum.
- Returns
buff_size < out_size
urPrintDevicePartitionProperty#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDevicePartitionProperty(const struct ur_device_partition_property_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_partition_property_t struct.
- Returns
buff_size < out_size
urPrintDevicePartitionProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDevicePartitionProperties(const struct ur_device_partition_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_partition_properties_t struct.
- Returns
buff_size < out_size
urPrintDeviceFpCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceFpCapabilityFlags(enum ur_device_fp_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_fp_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintDeviceMemCacheType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceMemCacheType(enum ur_device_mem_cache_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_mem_cache_type_t enum.
- Returns
buff_size < out_size
urPrintDeviceLocalMemType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceLocalMemType(enum ur_device_local_mem_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_local_mem_type_t enum.
- Returns
buff_size < out_size
urPrintDeviceExecCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceExecCapabilityFlags(enum ur_device_exec_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_exec_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintDeviceNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceNativeProperties(const struct ur_device_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_native_properties_t struct.
- Returns
buff_size < out_size
urPrintMemoryOrderCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemoryOrderCapabilityFlags(enum ur_memory_order_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_memory_order_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintMemoryScopeCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemoryScopeCapabilityFlags(enum ur_memory_scope_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_memory_scope_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintDeviceUsmAccessCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceUsmAccessCapabilityFlags(enum ur_device_usm_access_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_usm_access_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintContextFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextFlags(enum ur_context_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_flag_t enum.
- Returns
buff_size < out_size
urPrintContextProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextProperties(const struct ur_context_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_properties_t struct.
- Returns
buff_size < out_size
urPrintContextInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextInfo(enum ur_context_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_info_t enum.
- Returns
buff_size < out_size
urPrintContextNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextNativeProperties(const struct ur_context_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_native_properties_t struct.
- Returns
buff_size < out_size
urPrintMemFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemFlags(enum ur_mem_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_flag_t enum.
- Returns
buff_size < out_size
urPrintMemType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemType(enum ur_mem_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_type_t enum.
- Returns
buff_size < out_size
urPrintMemInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemInfo(enum ur_mem_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_info_t enum.
- Returns
buff_size < out_size
urPrintImageChannelOrder#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintImageChannelOrder(enum ur_image_channel_order_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_image_channel_order_t enum.
- Returns
buff_size < out_size
urPrintImageChannelType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintImageChannelType(enum ur_image_channel_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_image_channel_type_t enum.
- Returns
buff_size < out_size
urPrintImageInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintImageInfo(enum ur_image_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_image_info_t enum.
- Returns
buff_size < out_size
urPrintImageFormat#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintImageFormat(const struct ur_image_format_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_image_format_t struct.
- Returns
buff_size < out_size
urPrintImageDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintImageDesc(const struct ur_image_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_image_desc_t struct.
- Returns
buff_size < out_size
urPrintBufferProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBufferProperties(const struct ur_buffer_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_buffer_properties_t struct.
- Returns
buff_size < out_size
urPrintBufferChannelProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBufferChannelProperties(const struct ur_buffer_channel_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_buffer_channel_properties_t struct.
- Returns
buff_size < out_size
urPrintBufferAllocLocationProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBufferAllocLocationProperties(const struct ur_buffer_alloc_location_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_buffer_alloc_location_properties_t struct.
- Returns
buff_size < out_size
urPrintBufferRegion#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBufferRegion(const struct ur_buffer_region_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_buffer_region_t struct.
- Returns
buff_size < out_size
urPrintBufferCreateType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBufferCreateType(enum ur_buffer_create_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_buffer_create_type_t enum.
- Returns
buff_size < out_size
urPrintMemNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemNativeProperties(const struct ur_mem_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_native_properties_t struct.
- Returns
buff_size < out_size
urPrintSamplerFilterMode#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerFilterMode(enum ur_sampler_filter_mode_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_filter_mode_t enum.
- Returns
buff_size < out_size
urPrintSamplerAddressingMode#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerAddressingMode(enum ur_sampler_addressing_mode_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_addressing_mode_t enum.
- Returns
buff_size < out_size
urPrintSamplerInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerInfo(enum ur_sampler_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_info_t enum.
- Returns
buff_size < out_size
urPrintSamplerDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerDesc(const struct ur_sampler_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_desc_t struct.
- Returns
buff_size < out_size
urPrintSamplerNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerNativeProperties(const struct ur_sampler_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_native_properties_t struct.
- Returns
buff_size < out_size
urPrintUsmHostMemFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmHostMemFlags(enum ur_usm_host_mem_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_host_mem_flag_t enum.
- Returns
buff_size < out_size
urPrintUsmDeviceMemFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmDeviceMemFlags(enum ur_usm_device_mem_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_device_mem_flag_t enum.
- Returns
buff_size < out_size
urPrintUsmPoolFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolFlags(enum ur_usm_pool_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_flag_t enum.
- Returns
buff_size < out_size
urPrintUsmType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmType(enum ur_usm_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_type_t enum.
- Returns
buff_size < out_size
urPrintUsmAllocInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmAllocInfo(enum ur_usm_alloc_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_alloc_info_t enum.
- Returns
buff_size < out_size
urPrintUsmAdviceFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmAdviceFlags(enum ur_usm_advice_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_advice_flag_t enum.
- Returns
buff_size < out_size
urPrintUsmDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmDesc(const struct ur_usm_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmHostDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmHostDesc(const struct ur_usm_host_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_host_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmDeviceDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmDeviceDesc(const struct ur_usm_device_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_device_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmAllocLocationDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmAllocLocationDesc(const struct ur_usm_alloc_location_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_alloc_location_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolDesc(const struct ur_usm_pool_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolLimitsDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolLimitsDesc(const struct ur_usm_pool_limits_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_limits_desc_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolInfo(enum ur_usm_pool_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_info_t enum.
- Returns
buff_size < out_size
urPrintVirtualMemGranularityInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemGranularityInfo(enum ur_virtual_mem_granularity_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_granularity_info_t enum.
- Returns
buff_size < out_size
urPrintVirtualMemAccessFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemAccessFlags(enum ur_virtual_mem_access_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_access_flag_t enum.
- Returns
buff_size < out_size
urPrintVirtualMemInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemInfo(enum ur_virtual_mem_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_info_t enum.
- Returns
buff_size < out_size
urPrintPhysicalMemFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemFlags(enum ur_physical_mem_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_flag_t enum.
- Returns
buff_size < out_size
urPrintPhysicalMemProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemProperties(const struct ur_physical_mem_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_properties_t struct.
- Returns
buff_size < out_size
urPrintPhysicalMemInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemInfo(enum ur_physical_mem_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_info_t enum.
- Returns
buff_size < out_size
urPrintProgramMetadataType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramMetadataType(enum ur_program_metadata_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_metadata_type_t enum.
- Returns
buff_size < out_size
urPrintProgramMetadata#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramMetadata(const struct ur_program_metadata_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_metadata_t struct.
- Returns
buff_size < out_size
urPrintProgramProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramProperties(const struct ur_program_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_properties_t struct.
- Returns
buff_size < out_size
urPrintProgramInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramInfo(enum ur_program_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_info_t enum.
- Returns
buff_size < out_size
urPrintProgramBuildStatus#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramBuildStatus(enum ur_program_build_status_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_build_status_t enum.
- Returns
buff_size < out_size
urPrintProgramBinaryType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramBinaryType(enum ur_program_binary_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_binary_type_t enum.
- Returns
buff_size < out_size
urPrintProgramBuildInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramBuildInfo(enum ur_program_build_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_build_info_t enum.
- Returns
buff_size < out_size
urPrintSpecializationConstantInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSpecializationConstantInfo(const struct ur_specialization_constant_info_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_specialization_constant_info_t struct.
- Returns
buff_size < out_size
urPrintProgramNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramNativeProperties(const struct ur_program_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_native_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelArgValueProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelArgValueProperties(const struct ur_kernel_arg_value_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_arg_value_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelArgLocalProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelArgLocalProperties(const struct ur_kernel_arg_local_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_arg_local_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelInfo(enum ur_kernel_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_info_t enum.
- Returns
buff_size < out_size
urPrintKernelGroupInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGroupInfo(enum ur_kernel_group_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_group_info_t enum.
- Returns
buff_size < out_size
urPrintKernelSubGroupInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSubGroupInfo(enum ur_kernel_sub_group_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_sub_group_info_t enum.
- Returns
buff_size < out_size
urPrintKernelCacheConfig#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelCacheConfig(enum ur_kernel_cache_config_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_cache_config_t enum.
- Returns
buff_size < out_size
urPrintKernelExecInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelExecInfo(enum ur_kernel_exec_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_exec_info_t enum.
- Returns
buff_size < out_size
urPrintKernelArgPointerProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelArgPointerProperties(const struct ur_kernel_arg_pointer_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_arg_pointer_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelExecInfoProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelExecInfoProperties(const struct ur_kernel_exec_info_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_exec_info_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelArgSamplerProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelArgSamplerProperties(const struct ur_kernel_arg_sampler_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_arg_sampler_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelArgMemObjProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelArgMemObjProperties(const struct ur_kernel_arg_mem_obj_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_arg_mem_obj_properties_t struct.
- Returns
buff_size < out_size
urPrintKernelNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelNativeProperties(const struct ur_kernel_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_native_properties_t struct.
- Returns
buff_size < out_size
urPrintQueueInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueInfo(enum ur_queue_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_info_t enum.
- Returns
buff_size < out_size
urPrintQueueFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueFlags(enum ur_queue_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_flag_t enum.
- Returns
buff_size < out_size
urPrintQueueProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueProperties(const struct ur_queue_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_properties_t struct.
- Returns
buff_size < out_size
urPrintQueueIndexProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueIndexProperties(const struct ur_queue_index_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_index_properties_t struct.
- Returns
buff_size < out_size
urPrintQueueNativeDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueNativeDesc(const struct ur_queue_native_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_native_desc_t struct.
- Returns
buff_size < out_size
urPrintQueueNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueNativeProperties(const struct ur_queue_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_native_properties_t struct.
- Returns
buff_size < out_size
urPrintCommand#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommand(enum ur_command_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_t enum.
- Returns
buff_size < out_size
urPrintEventStatus#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventStatus(enum ur_event_status_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_status_t enum.
- Returns
buff_size < out_size
urPrintEventInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventInfo(enum ur_event_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_info_t enum.
- Returns
buff_size < out_size
urPrintProfilingInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProfilingInfo(enum ur_profiling_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_profiling_info_t enum.
- Returns
buff_size < out_size
urPrintEventNativeProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventNativeProperties(const struct ur_event_native_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_native_properties_t struct.
- Returns
buff_size < out_size
urPrintExecutionInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExecutionInfo(enum ur_execution_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_execution_info_t enum.
- Returns
buff_size < out_size
urPrintMapFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMapFlags(enum ur_map_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_map_flag_t enum.
- Returns
buff_size < out_size
urPrintUsmMigrationFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmMigrationFlags(enum ur_usm_migration_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_migration_flag_t enum.
- Returns
buff_size < out_size
urPrintExpDevice_2dBlockArrayCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpDevice_2dBlockArrayCapabilityFlags(enum ur_exp_device_2d_block_array_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_device_2d_block_array_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintExpImageCopyFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpImageCopyFlags(enum ur_exp_image_copy_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_image_copy_flag_t enum.
- Returns
buff_size < out_size
urPrintExpSamplerCubemapFilterMode#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpSamplerCubemapFilterMode(enum ur_exp_sampler_cubemap_filter_mode_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_sampler_cubemap_filter_mode_t enum.
- Returns
buff_size < out_size
urPrintExpExternalMemType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpExternalMemType(enum ur_exp_external_mem_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_external_mem_type_t enum.
- Returns
buff_size < out_size
urPrintExpExternalSemaphoreType#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpExternalSemaphoreType(enum ur_exp_external_semaphore_type_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_external_semaphore_type_t enum.
- Returns
buff_size < out_size
urPrintExpFileDescriptor#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpFileDescriptor(const struct ur_exp_file_descriptor_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_file_descriptor_t struct.
- Returns
buff_size < out_size
urPrintExpWin32Handle#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpWin32Handle(const struct ur_exp_win32_handle_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_win32_handle_t struct.
- Returns
buff_size < out_size
urPrintExpSamplerMipProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpSamplerMipProperties(const struct ur_exp_sampler_mip_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_sampler_mip_properties_t struct.
- Returns
buff_size < out_size
urPrintExpSamplerAddrModes#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpSamplerAddrModes(const struct ur_exp_sampler_addr_modes_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_sampler_addr_modes_t struct.
- Returns
buff_size < out_size
urPrintExpSamplerCubemapProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpSamplerCubemapProperties(const struct ur_exp_sampler_cubemap_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_sampler_cubemap_properties_t struct.
- Returns
buff_size < out_size
urPrintExpExternalMemDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpExternalMemDesc(const struct ur_exp_external_mem_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_external_mem_desc_t struct.
- Returns
buff_size < out_size
urPrintExpExternalSemaphoreDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpExternalSemaphoreDesc(const struct ur_exp_external_semaphore_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_external_semaphore_desc_t struct.
- Returns
buff_size < out_size
urPrintExpImageCopyRegion#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpImageCopyRegion(const struct ur_exp_image_copy_region_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_image_copy_region_t struct.
- Returns
buff_size < out_size
urPrintDeviceCommandBufferUpdateCapabilityFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceCommandBufferUpdateCapabilityFlags(enum ur_device_command_buffer_update_capability_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_command_buffer_update_capability_flag_t enum.
- Returns
buff_size < out_size
urPrintExpCommandBufferInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferInfo(enum ur_exp_command_buffer_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_info_t enum.
- Returns
buff_size < out_size
urPrintExpCommandBufferCommandInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferCommandInfo(enum ur_exp_command_buffer_command_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_command_info_t enum.
- Returns
buff_size < out_size
urPrintExpCommandBufferDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferDesc(const struct ur_exp_command_buffer_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_desc_t struct.
- Returns
buff_size < out_size
urPrintExpCommandBufferUpdateMemobjArgDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferUpdateMemobjArgDesc(const struct ur_exp_command_buffer_update_memobj_arg_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_update_memobj_arg_desc_t struct.
- Returns
buff_size < out_size
urPrintExpCommandBufferUpdatePointerArgDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferUpdatePointerArgDesc(const struct ur_exp_command_buffer_update_pointer_arg_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_update_pointer_arg_desc_t struct.
- Returns
buff_size < out_size
urPrintExpCommandBufferUpdateValueArgDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferUpdateValueArgDesc(const struct ur_exp_command_buffer_update_value_arg_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_update_value_arg_desc_t struct.
- Returns
buff_size < out_size
urPrintExpCommandBufferUpdateKernelLaunchDesc#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpCommandBufferUpdateKernelLaunchDesc(const struct ur_exp_command_buffer_update_kernel_launch_desc_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_command_buffer_update_kernel_launch_desc_t struct.
- Returns
buff_size < out_size
urPrintExpLaunchPropertyId#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpLaunchPropertyId(enum ur_exp_launch_property_id_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_launch_property_id_t enum.
- Returns
buff_size < out_size
urPrintExpLaunchProperty#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpLaunchProperty(const struct ur_exp_launch_property_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_launch_property_t struct.
- Returns
buff_size < out_size
urPrintExpPeerInfo#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpPeerInfo(enum ur_exp_peer_info_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_peer_info_t enum.
- Returns
buff_size < out_size
urPrintExpEnqueueExtFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpEnqueueExtFlags(enum ur_exp_enqueue_ext_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_enqueue_ext_flag_t enum.
- Returns
buff_size < out_size
urPrintExpEnqueueExtProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpEnqueueExtProperties(const struct ur_exp_enqueue_ext_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_enqueue_ext_properties_t struct.
- Returns
buff_size < out_size
urPrintExpEnqueueNativeCommandFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpEnqueueNativeCommandFlags(enum ur_exp_enqueue_native_command_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_enqueue_native_command_flag_t enum.
- Returns
buff_size < out_size
urPrintExpEnqueueNativeCommandProperties#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpEnqueueNativeCommandProperties(const struct ur_exp_enqueue_native_command_properties_t params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_enqueue_native_command_properties_t struct.
- Returns
buff_size < out_size
urPrintExpTensorMapDataTypeFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpTensorMapDataTypeFlags(enum ur_exp_tensor_map_data_type_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_tensor_map_data_type_flag_t enum.
- Returns
buff_size < out_size
urPrintExpTensorMapInterleaveFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpTensorMapInterleaveFlags(enum ur_exp_tensor_map_interleave_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_tensor_map_interleave_flag_t enum.
- Returns
buff_size < out_size
urPrintExpTensorMapL2PromotionFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpTensorMapL2PromotionFlags(enum ur_exp_tensor_map_l2_promotion_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_tensor_map_l2_promotion_flag_t enum.
- Returns
buff_size < out_size
urPrintExpTensorMapSwizzleFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpTensorMapSwizzleFlags(enum ur_exp_tensor_map_swizzle_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_tensor_map_swizzle_flag_t enum.
- Returns
buff_size < out_size
urPrintExpTensorMapOobFillFlags#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintExpTensorMapOobFillFlags(enum ur_exp_tensor_map_oob_fill_flag_t value, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_exp_tensor_map_oob_fill_flag_t enum.
- Returns
buff_size < out_size
urPrintLoaderConfigCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigCreateParams(const struct ur_loader_config_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_create_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigRetainParams(const struct ur_loader_config_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_retain_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigReleaseParams(const struct ur_loader_config_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_release_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigGetInfoParams(const struct ur_loader_config_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigEnableLayerParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigEnableLayerParams(const struct ur_loader_config_enable_layer_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_enable_layer_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigSetCodeLocationCallbackParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigSetCodeLocationCallbackParams(const struct ur_loader_config_set_code_location_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_set_code_location_callback_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderConfigSetMockingEnabledParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigSetMockingEnabledParams(const struct ur_loader_config_set_mocking_enabled_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_config_set_mocking_enabled_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformGetParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformGetParams(const struct ur_platform_get_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_get_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformGetInfoParams(const struct ur_platform_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformGetNativeHandleParams(const struct ur_platform_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformCreateWithNativeHandleParams(const struct ur_platform_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformGetApiVersionParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformGetApiVersionParams(const struct ur_platform_get_api_version_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_get_api_version_params_t struct.
- Returns
buff_size < out_size
urPrintPlatformGetBackendOptionParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPlatformGetBackendOptionParams(const struct ur_platform_get_backend_option_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_platform_get_backend_option_params_t struct.
- Returns
buff_size < out_size
urPrintContextCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextCreateParams(const struct ur_context_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_create_params_t struct.
- Returns
buff_size < out_size
urPrintContextRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextRetainParams(const struct ur_context_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_retain_params_t struct.
- Returns
buff_size < out_size
urPrintContextReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextReleaseParams(const struct ur_context_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_release_params_t struct.
- Returns
buff_size < out_size
urPrintContextGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextGetInfoParams(const struct ur_context_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintContextGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextGetNativeHandleParams(const struct ur_context_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintContextCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextCreateWithNativeHandleParams(const struct ur_context_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintContextSetExtendedDeleterParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintContextSetExtendedDeleterParams(const struct ur_context_set_extended_deleter_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_context_set_extended_deleter_params_t struct.
- Returns
buff_size < out_size
urPrintEventGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventGetInfoParams(const struct ur_event_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintEventGetProfilingInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventGetProfilingInfoParams(const struct ur_event_get_profiling_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_get_profiling_info_params_t struct.
- Returns
buff_size < out_size
urPrintEventWaitParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventWaitParams(const struct ur_event_wait_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_wait_params_t struct.
- Returns
buff_size < out_size
urPrintEventRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventRetainParams(const struct ur_event_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_retain_params_t struct.
- Returns
buff_size < out_size
urPrintEventReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventReleaseParams(const struct ur_event_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_release_params_t struct.
- Returns
buff_size < out_size
urPrintEventGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventGetNativeHandleParams(const struct ur_event_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintEventCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventCreateWithNativeHandleParams(const struct ur_event_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintEventSetCallbackParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEventSetCallbackParams(const struct ur_event_set_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_event_set_callback_params_t struct.
- Returns
buff_size < out_size
urPrintProgramCreateWithIlParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramCreateWithIlParams(const struct ur_program_create_with_il_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_create_with_il_params_t struct.
- Returns
buff_size < out_size
urPrintProgramCreateWithBinaryParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramCreateWithBinaryParams(const struct ur_program_create_with_binary_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_create_with_binary_params_t struct.
- Returns
buff_size < out_size
urPrintProgramBuildParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramBuildParams(const struct ur_program_build_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_build_params_t struct.
- Returns
buff_size < out_size
urPrintProgramBuildExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramBuildExpParams(const struct ur_program_build_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_build_exp_params_t struct.
- Returns
buff_size < out_size
urPrintProgramCompileParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramCompileParams(const struct ur_program_compile_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_compile_params_t struct.
- Returns
buff_size < out_size
urPrintProgramCompileExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramCompileExpParams(const struct ur_program_compile_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_compile_exp_params_t struct.
- Returns
buff_size < out_size
urPrintProgramLinkParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramLinkParams(const struct ur_program_link_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_link_params_t struct.
- Returns
buff_size < out_size
urPrintProgramLinkExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramLinkExpParams(const struct ur_program_link_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_link_exp_params_t struct.
- Returns
buff_size < out_size
urPrintProgramRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramRetainParams(const struct ur_program_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_retain_params_t struct.
- Returns
buff_size < out_size
urPrintProgramReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramReleaseParams(const struct ur_program_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_release_params_t struct.
- Returns
buff_size < out_size
urPrintProgramGetFunctionPointerParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramGetFunctionPointerParams(const struct ur_program_get_function_pointer_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_get_function_pointer_params_t struct.
- Returns
buff_size < out_size
urPrintProgramGetGlobalVariablePointerParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramGetGlobalVariablePointerParams(const struct ur_program_get_global_variable_pointer_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_get_global_variable_pointer_params_t struct.
- Returns
buff_size < out_size
urPrintProgramGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramGetInfoParams(const struct ur_program_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintProgramGetBuildInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramGetBuildInfoParams(const struct ur_program_get_build_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_get_build_info_params_t struct.
- Returns
buff_size < out_size
urPrintProgramSetSpecializationConstantsParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramSetSpecializationConstantsParams(const struct ur_program_set_specialization_constants_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_set_specialization_constants_params_t struct.
- Returns
buff_size < out_size
urPrintProgramGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramGetNativeHandleParams(const struct ur_program_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintProgramCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintProgramCreateWithNativeHandleParams(const struct ur_program_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_program_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintKernelCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelCreateParams(const struct ur_kernel_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_create_params_t struct.
- Returns
buff_size < out_size
urPrintKernelGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGetInfoParams(const struct ur_kernel_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintKernelGetGroupInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGetGroupInfoParams(const struct ur_kernel_get_group_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_get_group_info_params_t struct.
- Returns
buff_size < out_size
urPrintKernelGetSubGroupInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGetSubGroupInfoParams(const struct ur_kernel_get_sub_group_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_get_sub_group_info_params_t struct.
- Returns
buff_size < out_size
urPrintKernelRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelRetainParams(const struct ur_kernel_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_retain_params_t struct.
- Returns
buff_size < out_size
urPrintKernelReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelReleaseParams(const struct ur_kernel_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_release_params_t struct.
- Returns
buff_size < out_size
urPrintKernelGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGetNativeHandleParams(const struct ur_kernel_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintKernelCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelCreateWithNativeHandleParams(const struct ur_kernel_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintKernelGetSuggestedLocalWorkSizeParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelGetSuggestedLocalWorkSizeParams(const struct ur_kernel_get_suggested_local_work_size_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_get_suggested_local_work_size_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetArgValueParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetArgValueParams(const struct ur_kernel_set_arg_value_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_arg_value_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetArgLocalParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetArgLocalParams(const struct ur_kernel_set_arg_local_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_arg_local_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetArgPointerParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetArgPointerParams(const struct ur_kernel_set_arg_pointer_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_arg_pointer_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetExecInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetExecInfoParams(const struct ur_kernel_set_exec_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_exec_info_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetArgSamplerParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetArgSamplerParams(const struct ur_kernel_set_arg_sampler_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_arg_sampler_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetArgMemObjParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetArgMemObjParams(const struct ur_kernel_set_arg_mem_obj_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_arg_mem_obj_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSetSpecializationConstantsParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSetSpecializationConstantsParams(const struct ur_kernel_set_specialization_constants_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_set_specialization_constants_params_t struct.
- Returns
buff_size < out_size
urPrintKernelSuggestMaxCooperativeGroupCountExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintKernelSuggestMaxCooperativeGroupCountExpParams(const struct ur_kernel_suggest_max_cooperative_group_count_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_kernel_suggest_max_cooperative_group_count_exp_params_t struct.
- Returns
buff_size < out_size
urPrintQueueGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueGetInfoParams(const struct ur_queue_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintQueueCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueCreateParams(const struct ur_queue_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_create_params_t struct.
- Returns
buff_size < out_size
urPrintQueueRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueRetainParams(const struct ur_queue_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_retain_params_t struct.
- Returns
buff_size < out_size
urPrintQueueReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueReleaseParams(const struct ur_queue_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_release_params_t struct.
- Returns
buff_size < out_size
urPrintQueueGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueGetNativeHandleParams(const struct ur_queue_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintQueueCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueCreateWithNativeHandleParams(const struct ur_queue_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintQueueFinishParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueFinishParams(const struct ur_queue_finish_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_finish_params_t struct.
- Returns
buff_size < out_size
urPrintQueueFlushParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintQueueFlushParams(const struct ur_queue_flush_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_queue_flush_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerCreateParams(const struct ur_sampler_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_create_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerRetainParams(const struct ur_sampler_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_retain_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerReleaseParams(const struct ur_sampler_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_release_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerGetInfoParams(const struct ur_sampler_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerGetNativeHandleParams(const struct ur_sampler_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintSamplerCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSamplerCreateWithNativeHandleParams(const struct ur_sampler_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_sampler_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintMemImageCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemImageCreateParams(const struct ur_mem_image_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_image_create_params_t struct.
- Returns
buff_size < out_size
urPrintMemBufferCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemBufferCreateParams(const struct ur_mem_buffer_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_buffer_create_params_t struct.
- Returns
buff_size < out_size
urPrintMemRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemRetainParams(const struct ur_mem_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_retain_params_t struct.
- Returns
buff_size < out_size
urPrintMemReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemReleaseParams(const struct ur_mem_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_release_params_t struct.
- Returns
buff_size < out_size
urPrintMemBufferPartitionParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemBufferPartitionParams(const struct ur_mem_buffer_partition_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_buffer_partition_params_t struct.
- Returns
buff_size < out_size
urPrintMemGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemGetNativeHandleParams(const struct ur_mem_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintMemBufferCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemBufferCreateWithNativeHandleParams(const struct ur_mem_buffer_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_buffer_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintMemImageCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemImageCreateWithNativeHandleParams(const struct ur_mem_image_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_image_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintMemGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemGetInfoParams(const struct ur_mem_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintMemImageGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintMemImageGetInfoParams(const struct ur_mem_image_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_mem_image_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintPhysicalMemCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemCreateParams(const struct ur_physical_mem_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_create_params_t struct.
- Returns
buff_size < out_size
urPrintPhysicalMemRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemRetainParams(const struct ur_physical_mem_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_retain_params_t struct.
- Returns
buff_size < out_size
urPrintPhysicalMemReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemReleaseParams(const struct ur_physical_mem_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_release_params_t struct.
- Returns
buff_size < out_size
urPrintPhysicalMemGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintPhysicalMemGetInfoParams(const struct ur_physical_mem_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_physical_mem_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintAdapterGetParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetParams(const struct ur_adapter_get_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_get_params_t struct.
- Returns
buff_size < out_size
urPrintAdapterReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterReleaseParams(const struct ur_adapter_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_release_params_t struct.
- Returns
buff_size < out_size
urPrintAdapterRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterRetainParams(const struct ur_adapter_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_retain_params_t struct.
- Returns
buff_size < out_size
urPrintAdapterGetLastErrorParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetLastErrorParams(const struct ur_adapter_get_last_error_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_get_last_error_params_t struct.
- Returns
buff_size < out_size
urPrintAdapterGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetInfoParams(const struct ur_adapter_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_adapter_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueKernelLaunchParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueKernelLaunchParams(const struct ur_enqueue_kernel_launch_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_kernel_launch_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueEventsWaitParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueEventsWaitParams(const struct ur_enqueue_events_wait_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_events_wait_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueEventsWaitWithBarrierParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueEventsWaitWithBarrierParams(const struct ur_enqueue_events_wait_with_barrier_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_events_wait_with_barrier_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferReadParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferReadParams(const struct ur_enqueue_mem_buffer_read_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_read_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferWriteParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferWriteParams(const struct ur_enqueue_mem_buffer_write_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_write_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferReadRectParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferReadRectParams(const struct ur_enqueue_mem_buffer_read_rect_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_read_rect_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferWriteRectParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferWriteRectParams(const struct ur_enqueue_mem_buffer_write_rect_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_write_rect_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferCopyParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferCopyParams(const struct ur_enqueue_mem_buffer_copy_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_copy_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferCopyRectParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferCopyRectParams(const struct ur_enqueue_mem_buffer_copy_rect_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_copy_rect_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferFillParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferFillParams(const struct ur_enqueue_mem_buffer_fill_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_fill_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemImageReadParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemImageReadParams(const struct ur_enqueue_mem_image_read_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_image_read_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemImageWriteParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemImageWriteParams(const struct ur_enqueue_mem_image_write_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_image_write_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemImageCopyParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemImageCopyParams(const struct ur_enqueue_mem_image_copy_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_image_copy_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemBufferMapParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemBufferMapParams(const struct ur_enqueue_mem_buffer_map_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_buffer_map_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueMemUnmapParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueMemUnmapParams(const struct ur_enqueue_mem_unmap_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_mem_unmap_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmFillParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmFillParams(const struct ur_enqueue_usm_fill_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_fill_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmMemcpyParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmMemcpyParams(const struct ur_enqueue_usm_memcpy_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_memcpy_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmPrefetchParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmPrefetchParams(const struct ur_enqueue_usm_prefetch_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_prefetch_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmAdviseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmAdviseParams(const struct ur_enqueue_usm_advise_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_advise_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmFill_2dParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmFill_2dParams(const struct ur_enqueue_usm_fill_2d_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_fill_2d_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueUsmMemcpy_2dParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueUsmMemcpy_2dParams(const struct ur_enqueue_usm_memcpy_2d_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_usm_memcpy_2d_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueDeviceGlobalVariableWriteParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueDeviceGlobalVariableWriteParams(const struct ur_enqueue_device_global_variable_write_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_device_global_variable_write_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueDeviceGlobalVariableReadParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueDeviceGlobalVariableReadParams(const struct ur_enqueue_device_global_variable_read_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_device_global_variable_read_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueReadHostPipeParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueReadHostPipeParams(const struct ur_enqueue_read_host_pipe_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_read_host_pipe_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueWriteHostPipeParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueWriteHostPipeParams(const struct ur_enqueue_write_host_pipe_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_write_host_pipe_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueKernelLaunchCustomExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueKernelLaunchCustomExpParams(const struct ur_enqueue_kernel_launch_custom_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_kernel_launch_custom_exp_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueEventsWaitWithBarrierExtParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueEventsWaitWithBarrierExtParams(const struct ur_enqueue_events_wait_with_barrier_ext_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_events_wait_with_barrier_ext_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueCooperativeKernelLaunchExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueCooperativeKernelLaunchExpParams(const struct ur_enqueue_cooperative_kernel_launch_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_cooperative_kernel_launch_exp_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueTimestampRecordingExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueTimestampRecordingExpParams(const struct ur_enqueue_timestamp_recording_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_timestamp_recording_exp_params_t struct.
- Returns
buff_size < out_size
urPrintEnqueueNativeCommandExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintEnqueueNativeCommandExpParams(const struct ur_enqueue_native_command_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_enqueue_native_command_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesUnsampledImageHandleDestroyExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesUnsampledImageHandleDestroyExpParams(const struct ur_bindless_images_unsampled_image_handle_destroy_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_unsampled_image_handle_destroy_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesSampledImageHandleDestroyExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesSampledImageHandleDestroyExpParams(const struct ur_bindless_images_sampled_image_handle_destroy_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_sampled_image_handle_destroy_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImageAllocateExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImageAllocateExpParams(const struct ur_bindless_images_image_allocate_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_image_allocate_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImageFreeExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImageFreeExpParams(const struct ur_bindless_images_image_free_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_image_free_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesUnsampledImageCreateExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesUnsampledImageCreateExpParams(const struct ur_bindless_images_unsampled_image_create_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_unsampled_image_create_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesSampledImageCreateExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesSampledImageCreateExpParams(const struct ur_bindless_images_sampled_image_create_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_sampled_image_create_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImageCopyExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImageCopyExpParams(const struct ur_bindless_images_image_copy_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_image_copy_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImageGetInfoExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImageGetInfoExpParams(const struct ur_bindless_images_image_get_info_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_image_get_info_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesMipmapGetLevelExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesMipmapGetLevelExpParams(const struct ur_bindless_images_mipmap_get_level_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_mipmap_get_level_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesMipmapFreeExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesMipmapFreeExpParams(const struct ur_bindless_images_mipmap_free_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_mipmap_free_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImportExternalMemoryExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImportExternalMemoryExpParams(const struct ur_bindless_images_import_external_memory_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_import_external_memory_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesMapExternalArrayExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesMapExternalArrayExpParams(const struct ur_bindless_images_map_external_array_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_map_external_array_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesMapExternalLinearMemoryExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesMapExternalLinearMemoryExpParams(const struct ur_bindless_images_map_external_linear_memory_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_map_external_linear_memory_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesReleaseExternalMemoryExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesReleaseExternalMemoryExpParams(const struct ur_bindless_images_release_external_memory_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_release_external_memory_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesImportExternalSemaphoreExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesImportExternalSemaphoreExpParams(const struct ur_bindless_images_import_external_semaphore_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_import_external_semaphore_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesReleaseExternalSemaphoreExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesReleaseExternalSemaphoreExpParams(const struct ur_bindless_images_release_external_semaphore_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_release_external_semaphore_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesWaitExternalSemaphoreExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesWaitExternalSemaphoreExpParams(const struct ur_bindless_images_wait_external_semaphore_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_wait_external_semaphore_exp_params_t struct.
- Returns
buff_size < out_size
urPrintBindlessImagesSignalExternalSemaphoreExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintBindlessImagesSignalExternalSemaphoreExpParams(const struct ur_bindless_images_signal_external_semaphore_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_bindless_images_signal_external_semaphore_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmHostAllocParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmHostAllocParams(const struct ur_usm_host_alloc_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_host_alloc_params_t struct.
- Returns
buff_size < out_size
urPrintUsmDeviceAllocParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmDeviceAllocParams(const struct ur_usm_device_alloc_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_device_alloc_params_t struct.
- Returns
buff_size < out_size
urPrintUsmFreeParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmFreeParams(const struct ur_usm_free_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_free_params_t struct.
- Returns
buff_size < out_size
urPrintUsmGetMemAllocInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmGetMemAllocInfoParams(const struct ur_usm_get_mem_alloc_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_get_mem_alloc_info_params_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolCreateParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolCreateParams(const struct ur_usm_pool_create_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_create_params_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolRetainParams(const struct ur_usm_pool_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_retain_params_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolReleaseParams(const struct ur_usm_pool_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_release_params_t struct.
- Returns
buff_size < out_size
urPrintUsmPoolGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPoolGetInfoParams(const struct ur_usm_pool_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pool_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintUsmPitchedAllocExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmPitchedAllocExpParams(const struct ur_usm_pitched_alloc_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_pitched_alloc_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmImportExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmImportExpParams(const struct ur_usm_import_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_import_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmReleaseExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmReleaseExpParams(const struct ur_usm_release_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_release_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferCreateExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferCreateExpParams(const struct ur_command_buffer_create_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_create_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferRetainExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferRetainExpParams(const struct ur_command_buffer_retain_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_retain_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferReleaseExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferReleaseExpParams(const struct ur_command_buffer_release_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_release_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferFinalizeExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferFinalizeExpParams(const struct ur_command_buffer_finalize_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_finalize_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendKernelLaunchExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendKernelLaunchExpParams(const struct ur_command_buffer_append_kernel_launch_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_kernel_launch_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendUsmMemcpyExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendUsmMemcpyExpParams(const struct ur_command_buffer_append_usm_memcpy_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_usm_memcpy_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendUsmFillExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendUsmFillExpParams(const struct ur_command_buffer_append_usm_fill_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_usm_fill_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferCopyExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferCopyExpParams(const struct ur_command_buffer_append_mem_buffer_copy_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_copy_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferWriteExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferWriteExpParams(const struct ur_command_buffer_append_mem_buffer_write_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_write_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferReadExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferReadExpParams(const struct ur_command_buffer_append_mem_buffer_read_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_read_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferCopyRectExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferCopyRectExpParams(const struct ur_command_buffer_append_mem_buffer_copy_rect_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_copy_rect_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferWriteRectExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferWriteRectExpParams(const struct ur_command_buffer_append_mem_buffer_write_rect_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_write_rect_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferReadRectExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferReadRectExpParams(const struct ur_command_buffer_append_mem_buffer_read_rect_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_read_rect_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendMemBufferFillExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendMemBufferFillExpParams(const struct ur_command_buffer_append_mem_buffer_fill_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_mem_buffer_fill_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendUsmPrefetchExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendUsmPrefetchExpParams(const struct ur_command_buffer_append_usm_prefetch_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_usm_prefetch_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferAppendUsmAdviseExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferAppendUsmAdviseExpParams(const struct ur_command_buffer_append_usm_advise_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_append_usm_advise_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferEnqueueExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferEnqueueExpParams(const struct ur_command_buffer_enqueue_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_enqueue_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferRetainCommandExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferRetainCommandExpParams(const struct ur_command_buffer_retain_command_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_retain_command_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferReleaseCommandExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferReleaseCommandExpParams(const struct ur_command_buffer_release_command_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_release_command_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferUpdateKernelLaunchExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferUpdateKernelLaunchExpParams(const struct ur_command_buffer_update_kernel_launch_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_update_kernel_launch_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferUpdateSignalEventExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferUpdateSignalEventExpParams(const struct ur_command_buffer_update_signal_event_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_update_signal_event_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferUpdateWaitEventsExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferUpdateWaitEventsExpParams(const struct ur_command_buffer_update_wait_events_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_update_wait_events_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferGetInfoExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferGetInfoExpParams(const struct ur_command_buffer_get_info_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_get_info_exp_params_t struct.
- Returns
buff_size < out_size
urPrintCommandBufferCommandGetInfoExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintCommandBufferCommandGetInfoExpParams(const struct ur_command_buffer_command_get_info_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_command_buffer_command_get_info_exp_params_t struct.
- Returns
buff_size < out_size
urPrintTensorMapEncodeIm_2ColExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintTensorMapEncodeIm_2ColExpParams(const struct ur_tensor_map_encode_im_2_col_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_tensor_map_encode_im_2_col_exp_params_t struct.
- Returns
buff_size < out_size
urPrintTensorMapEncodeTiledExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintTensorMapEncodeTiledExpParams(const struct ur_tensor_map_encode_tiled_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_tensor_map_encode_tiled_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmP2pEnablePeerAccessExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmP2pEnablePeerAccessExpParams(const struct ur_usm_p2p_enable_peer_access_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_p2p_enable_peer_access_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmP2pDisablePeerAccessExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmP2pDisablePeerAccessExpParams(const struct ur_usm_p2p_disable_peer_access_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_p2p_disable_peer_access_exp_params_t struct.
- Returns
buff_size < out_size
urPrintUsmP2pPeerAccessGetInfoExpParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintUsmP2pPeerAccessGetInfoExpParams(const struct ur_usm_p2p_peer_access_get_info_exp_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_usm_p2p_peer_access_get_info_exp_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderInitParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderInitParams(const struct ur_loader_init_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_init_params_t struct.
- Returns
buff_size < out_size
urPrintLoaderTearDownParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderTearDownParams(const struct ur_loader_tear_down_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_loader_tear_down_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemGranularityGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemGranularityGetInfoParams(const struct ur_virtual_mem_granularity_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_granularity_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemReserveParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemReserveParams(const struct ur_virtual_mem_reserve_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_reserve_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemFreeParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemFreeParams(const struct ur_virtual_mem_free_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_free_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemMapParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemMapParams(const struct ur_virtual_mem_map_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_map_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemUnmapParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemUnmapParams(const struct ur_virtual_mem_unmap_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_unmap_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemSetAccessParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemSetAccessParams(const struct ur_virtual_mem_set_access_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_set_access_params_t struct.
- Returns
buff_size < out_size
urPrintVirtualMemGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintVirtualMemGetInfoParams(const struct ur_virtual_mem_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_virtual_mem_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceGetParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceGetParams(const struct ur_device_get_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_get_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceGetSelectedParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceGetSelectedParams(const struct ur_device_get_selected_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_get_selected_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceGetInfoParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceGetInfoParams(const struct ur_device_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_get_info_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceRetainParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceRetainParams(const struct ur_device_retain_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_retain_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceReleaseParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceReleaseParams(const struct ur_device_release_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_release_params_t struct.
- Returns
buff_size < out_size
urPrintDevicePartitionParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDevicePartitionParams(const struct ur_device_partition_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_partition_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceSelectBinaryParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceSelectBinaryParams(const struct ur_device_select_binary_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_select_binary_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceGetNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceGetNativeHandleParams(const struct ur_device_get_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_get_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceCreateWithNativeHandleParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceCreateWithNativeHandleParams(const struct ur_device_create_with_native_handle_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_create_with_native_handle_params_t struct.
- Returns
buff_size < out_size
urPrintDeviceGetGlobalTimestampsParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintDeviceGetGlobalTimestampsParams(const struct ur_device_get_global_timestamps_params_t *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print ur_device_get_global_timestamps_params_t struct.
- Returns
buff_size < out_size
urPrintFunctionParams#
-
UR_APIEXPORT ur_result_t UR_APICALL urPrintFunctionParams(enum ur_function_t function, const void *params, char *buffer, const size_t buff_size, size_t *out_size)#
Print function parameters.
- Returns
UR_RESULT_ERROR_INVALID_NULL_POINTER
NULL == params
buff_size < out_size
Print C++ API#
This part of the Unified Runtime API consists mainly of the std::ostream
print operators. Those are defined for all Unified Runtime objects described
in the specification.
Currently, there is also one non-operator ‘extras’ function which can be used for printing all parameters of a given UR API function.
- Functions
Print C++ Functions#
printFunctionParams#
-
inline ur_result_t UR_APICALL ur::extras::printFunctionParams(std::ostream &os, ur_function_t function, const void *params)#
Print function parameters.
- Returns
Print Operators#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_function_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_structure_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_result_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_base_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_base_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_rect_offset_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_rect_region_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_init_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_loader_config_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_code_location_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_adapter_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_adapter_backend_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_platform_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_api_version_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_platform_backend_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_binary_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_affinity_domain_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_partition_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_partition_property_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_partition_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_fp_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_mem_cache_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_local_mem_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_exec_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_memory_order_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_memory_scope_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_usm_access_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_context_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_context_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_mem_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_mem_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_mem_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_image_channel_order_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_image_channel_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_image_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_image_format_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_image_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_buffer_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_buffer_channel_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_buffer_alloc_location_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_buffer_region_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_buffer_create_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_sampler_filter_mode_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_sampler_addressing_mode_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_sampler_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_host_mem_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_device_mem_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_pool_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_alloc_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_advice_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_host_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_device_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_alloc_location_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_limits_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_pool_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_virtual_mem_granularity_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_virtual_mem_access_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_virtual_mem_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_physical_mem_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_physical_mem_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_physical_mem_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_program_metadata_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_metadata_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_program_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_program_build_status_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_program_binary_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_program_build_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_specialization_constant_info_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_arg_value_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_arg_local_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_kernel_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_kernel_group_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_kernel_sub_group_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_kernel_cache_config_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_kernel_exec_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_arg_pointer_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_exec_info_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_arg_sampler_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_arg_mem_obj_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_queue_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_queue_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_index_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_native_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_command_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_event_status_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_event_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_profiling_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_native_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_execution_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_map_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_usm_migration_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_device_2d_block_array_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_image_copy_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_sampler_cubemap_filter_mode_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_external_mem_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_external_semaphore_type_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_file_descriptor_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_win32_handle_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_sampler_mip_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_sampler_addr_modes_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_sampler_cubemap_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_external_mem_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_external_semaphore_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_image_copy_region_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_device_command_buffer_update_capability_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_command_buffer_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_command_buffer_command_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_update_memobj_arg_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_update_pointer_arg_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_update_value_arg_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_update_kernel_launch_desc_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_launch_property_id_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_launch_property_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_peer_info_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_enqueue_ext_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_enqueue_ext_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_enqueue_native_command_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_enqueue_native_command_properties_t params)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_tensor_map_data_type_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_tensor_map_interleave_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_tensor_map_l2_promotion_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_tensor_map_swizzle_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, enum ur_exp_tensor_map_oob_fill_flag_t value)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_enable_layer_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_set_code_location_callback_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_set_mocking_enabled_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_get_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_get_api_version_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_platform_get_backend_option_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_context_set_extended_deleter_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_get_profiling_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_wait_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_event_set_callback_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_create_with_il_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_create_with_binary_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_build_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_build_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_compile_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_compile_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_link_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_link_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_get_function_pointer_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_get_global_variable_pointer_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_get_build_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_set_specialization_constants_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_program_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_get_group_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_get_sub_group_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_get_suggested_local_work_size_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_arg_value_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_arg_local_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_arg_pointer_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_exec_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_arg_sampler_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_arg_mem_obj_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_set_specialization_constants_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_kernel_suggest_max_cooperative_group_count_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_finish_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_queue_flush_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_sampler_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_image_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_buffer_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_buffer_partition_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_buffer_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_image_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_mem_image_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_physical_mem_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_physical_mem_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_physical_mem_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_physical_mem_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_get_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_get_last_error_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_kernel_launch_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_events_wait_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_events_wait_with_barrier_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_read_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_write_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_read_rect_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_write_rect_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_copy_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_copy_rect_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_fill_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_image_read_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_image_write_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_image_copy_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_buffer_map_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_mem_unmap_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_fill_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_memcpy_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_prefetch_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_advise_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_fill_2d_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_usm_memcpy_2d_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_device_global_variable_write_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_device_global_variable_read_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_read_host_pipe_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_write_host_pipe_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_kernel_launch_custom_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_events_wait_with_barrier_ext_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_cooperative_kernel_launch_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_timestamp_recording_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_enqueue_native_command_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_unsampled_image_handle_destroy_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_sampled_image_handle_destroy_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_image_allocate_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_image_free_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_unsampled_image_create_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_sampled_image_create_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_image_copy_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_image_get_info_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_mipmap_get_level_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_mipmap_free_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_import_external_memory_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_map_external_array_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_map_external_linear_memory_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_release_external_memory_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_import_external_semaphore_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_release_external_semaphore_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_wait_external_semaphore_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_bindless_images_signal_external_semaphore_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_host_alloc_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_device_alloc_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_free_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_get_mem_alloc_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_create_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pool_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_pitched_alloc_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_import_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_release_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_create_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_retain_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_release_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_finalize_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_kernel_launch_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_usm_memcpy_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_usm_fill_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_copy_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_write_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_read_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_copy_rect_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_write_rect_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_read_rect_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_mem_buffer_fill_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_usm_prefetch_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_append_usm_advise_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_enqueue_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_retain_command_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_release_command_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_update_kernel_launch_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_update_signal_event_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_update_wait_events_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_get_info_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_command_buffer_command_get_info_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_tensor_map_encode_im_2_col_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_tensor_map_encode_tiled_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_p2p_enable_peer_access_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_p2p_disable_peer_access_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_usm_p2p_peer_access_get_info_exp_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_init_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_tear_down_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_granularity_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_reserve_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_free_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_map_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_unmap_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_set_access_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_virtual_mem_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_get_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_get_selected_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_get_info_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_retain_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_release_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_partition_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_select_binary_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_get_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_create_with_native_handle_params_t *params)#
-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_device_get_global_timestamps_params_t *params)#