oneAPI Level Zero: 0.95.0

• Introduction
  • Objective
    • Core
    • Tools
    • System Management
  • Fundamentals
    • Terminology
    • Naming Convention
    • Versioning
    • Error Handling
    • Multithreading and Concurrency
    • Extension Support
    • Application Binary Interface
• Core Programming Guide
  • Drivers and Devices
    • Drivers
    • Device
    • Initialization and Discovery
  • Memory and Images
    • Memory
      • Types
      • Cache Hints, Prefetch, and Memory Advice
    • Images
    • Device Cache Settings
  • Command Queues and Command Lists
    • Command Queues
      • Creation
      • Execution
      • Destruction
    • Command Lists
      • Creation
      • Appending
      • Submission
      • Recycling
      • Low-Latency Immediate Command Lists
  • Synchronization Primitives
    • Fences
    • Events
      • Kernel Timestamp Events
  • Barriers
    • Execution Barriers
    • Memory Barriers
    • Range-based Memory Barriers
  • Modules and Kernels
    • Modules
      • Module Build Options
      • Module Specialization Constants
      • Module Build Log
      • Module Caching with Native Binaries
      • Built-in Kernels
    • Kernels
      • Kernel Attributes and Properties
    • Execution
      • Kernel Group Size
      • Kernel Arguments
      • Kernel Launch
      • Cooperative Kernels
    • Sampler
  • Advanced
    • Environment Variables
      • Affinity Mask
    • Sub-Device Support
    • Device Residency
    • OpenCL Interoperability
      • cl_mem
      • cl_program
      • cl_command_queue
    • Inter-Process Communication
      • Memory
      • Events
    • Peer-to-Peer Access and Queries
• Tools Programming Guide
  • Initialization
    • Environment Variables
  • API Tracing
    • Introduction
    • Registration
    • Enabling/Disabling and Destruction
  • Metrics
    • Introduction
    • Metric Groups
      • Sampling Types
      • Domains
    • Enumeration
    • Configuration
    • Collection
      • Metric Streamer
      • Metric Query
    • Calculation
  • Program Instrumentation
    • Introduction
    • Inter-Function Instrumentation
    • Intra-Function Instrumentation
      • Compilation
      • Instrumentation
      • Execution
• Sysman Programming Guide
  • Introduction
  • High-level overview
    • Environment Variables
    • Initialization
    • Global device management
    • Device component management
    • Device component enumeration
    • Sub-device management
    • Events
  • Interface details
    • Global operations
      • Device Properties
      • Host Processes
      • Scheduler operations
      • Device reset
      • PCI link operations
    • Operations on power domains
    • Operations on frequency domains
      • Frequency/Voltage overclocking
    • Tuning workload performance
    • Operations on engine groups
    • Operations on standby domains
    • Operations on firmwares
    • Querying Memory Modules
    • Operations on Fabric ports
    • Querying temperature
    • Operations on power supplies
    • Operations on fans
    • Operations on LEDs
    • Querying RAS errors
    • Performing Diagnostics
    • Events
  • Security
    • Linux
    • Windows
    • Privileged Telemetry
    • Privileged controls
    • Virtualization
    • Function summary
• SPIR-V Programming Guide
  • Introduction
  • Common Properties
    • Supported SPIR-V Versions
    • Extended Instruction Sets
    • Source Language Encoding
    • Numerical Type Formats
    • Supported Types
      • Basic Scalar and Vector Types
      • Image-Related Data Types
    • Kernels
    • Kernel Return Types
    • Kernel Arguments
  • Required Capabilities
    • SPIR-V 1.0
    • SPIR-V 1.1
    • SPIR-V 1.2
  • Validation Rules
  • Extensions
    • SPV_INTEL_subgroups
      • Notes and Restrictions
    • Other Extensions to Consider:
  • Numerical Compliance
  • Image Addressing and Filtering
• API Documentation
  • Core API
    • Common
      • Common Enums
        • ze_result_t
        • ze_structure_type_t
      • Common Structures
        • ze_ipc_mem_handle_t
        • ze_ipc_event_pool_handle_t
        • ze_base_properties_t
        • ze_base_desc_t
    • Driver
      • Driver Functions
        • zeInit
        • zeDriverGet
        • zeDriverGetApiVersion
        • zeDriverGetProperties
        • zeDriverGetIpcProperties
        • zeDriverGetExtensionProperties
      • Driver Enums
        • ze_init_flag_t
        • ze_api_version_t
      • Driver Structures
        • ze_driver_uuid_t
        • ze_driver_properties_t
        • ze_driver_ipc_properties_t
        • ze_driver_extension_properties_t
    • Device
      • Device Functions
        • zeDeviceGet
        • zeDeviceGetSubDevices
        • zeDeviceGetProperties
        • zeDeviceGetComputeProperties
        • zeDeviceGetModuleProperties
        • zeDeviceGetCommandQueueGroupProperties
        • zeDeviceGetMemoryProperties
        • zeDeviceGetMemoryAccessProperties
        • zeDeviceGetCacheProperties
        • zeDeviceGetImageProperties
        • zeDeviceGetP2PProperties
        • zeDeviceCanAccessPeer
        • zeDeviceSetLastLevelCacheConfig
      • Device Enums
        • ze_device_type_t
        • ze_fp_caps_t
        • ze_memory_access_caps_t
        • ze_cache_config_t
      • Device Structures
        • ze_device_uuid_t
        • ze_device_properties_t
        • ze_device_compute_properties_t
        • ze_native_kernel_uuid_t
        • ze_device_module_properties_t
        • ze_command_queue_group_properties_t
        • ze_device_memory_properties_t
        • ze_device_memory_access_properties_t
        • ze_device_cache_properties_t
        • ze_device_image_properties_t
        • ze_device_p2p_properties_t
    • Cmdqueue
      • Cmdqueue Functions
        • zeCommandQueueCreate
        • zeCommandQueueDestroy
        • zeCommandQueueExecuteCommandLists
        • zeCommandQueueSynchronize
      • Cmdqueue Enums
        • ze_command_queue_flag_t
        • ze_command_queue_mode_t
        • ze_command_queue_priority_t
      • Cmdqueue Structures
        • ze_command_queue_desc_t
    • Cmdlist
      • Cmdlist Functions
        • zeCommandListCreate
        • zeCommandListCreateImmediate
        • zeCommandListDestroy
        • zeCommandListClose
        • zeCommandListReset
        • zeCommandListAppendWriteGlobalTimestamp
      • Cmdlist Enums
        • ze_command_list_flag_t
      • Cmdlist Structures
        • ze_command_list_desc_t
    • Barrier
      • Barrier Functions
        • zeCommandListAppendBarrier
        • zeCommandListAppendMemoryRangesBarrier
        • zeDeviceSystemBarrier
    • Copy
      • Copy Functions
        • zeCommandListAppendMemoryCopy
        • zeCommandListAppendMemoryFill
        • zeCommandListAppendMemoryCopyRegion
        • zeCommandListAppendImageCopy
        • zeCommandListAppendImageCopyRegion
        • zeCommandListAppendImageCopyToMemory
        • zeCommandListAppendImageCopyFromMemory
        • zeCommandListAppendMemoryPrefetch
        • zeCommandListAppendMemAdvise
      • Copy Enums
        • ze_memory_advice_t
      • Copy Structures
        • ze_copy_region_t
        • ze_image_region_t
    • Event
      • Event Functions
        • zeEventPoolCreate
        • zeEventPoolDestroy
        • zeEventCreate
        • zeEventDestroy
        • zeEventPoolGetIpcHandle
        • zeEventPoolOpenIpcHandle
        • zeEventPoolCloseIpcHandle
        • zeCommandListAppendSignalEvent
        • zeCommandListAppendWaitOnEvents
        • zeEventHostSignal
        • zeEventHostSynchronize
        • zeEventQueryStatus
        • zeCommandListAppendEventReset
        • zeEventHostReset
        • zeEventQueryKernelTimestamp
        • zeCommandListAppendQueryKernelTimestamps
      • Event Enums
        • ze_event_pool_flag_t
        • ze_event_scope_flag_t
      • Event Structures
        • ze_event_pool_desc_t
        • ze_event_desc_t
        • ze_kernel_timestamp_data_t
        • ze_kernel_timestamp_result_t
    • Fence
      • Fence Functions
        • zeFenceCreate
        • zeFenceDestroy
        • zeFenceHostSynchronize
        • zeFenceQueryStatus
        • zeFenceReset
      • Fence Enums
        • ze_fence_flag_t
      • Fence Structures
        • ze_fence_desc_t
    • Image
      • Image Functions
        • zeImageGetProperties
        • zeImageCreate
        • zeImageDestroy
      • Image Enums
        • ze_image_flag_t
        • ze_image_type_t
        • ze_image_format_layout_t
        • ze_image_format_type_t
        • ze_image_format_swizzle_t
        • ze_image_sampler_filter_flags_t
      • Image Structures
        • ze_image_format_desc_t
        • ze_image_desc_t
        • ze_image_properties_t
    • Memory
      • Memory Functions
        • zeDriverAllocSharedMem
        • zeDriverAllocDeviceMem
        • zeDriverAllocHostMem
        • zeDriverFreeMem
        • zeDriverGetMemAllocProperties
        • zeDriverGetMemAddressRange
        • zeDriverGetMemIpcHandle
        • zeDriverOpenMemIpcHandle
        • zeDriverCloseMemIpcHandle
      • Memory Enums
        • ze_device_mem_alloc_flag_t
        • ze_host_mem_alloc_flag_t
        • ze_memory_type_t
        • ze_ipc_memory_flag_t
      • Memory Structures
        • ze_device_mem_alloc_desc_t
        • ze_host_mem_alloc_desc_t
        • ze_memory_allocation_properties_t
    • Module
      • Module Functions
        • zeModuleCreate
        • zeModuleDestroy
        • zeModuleDynamicLink
        • zeModuleBuildLogDestroy
        • zeModuleBuildLogGetString
        • zeModuleGetNativeBinary
        • zeModuleGetGlobalPointer
        • zeModuleGetKernelNames
        • zeKernelCreate
        • zeKernelDestroy
        • zeModuleGetFunctionPointer
        • zeKernelSetGroupSize
        • zeKernelSuggestGroupSize
        • zeKernelSuggestMaxCooperativeGroupCount
        • zeKernelSetArgumentValue
        • zeKernelSetAttribute
        • zeKernelGetAttribute
        • zeKernelSetIntermediateCacheConfig
        • zeKernelGetProperties
        • zeCommandListAppendLaunchKernel
        • zeCommandListAppendLaunchCooperativeKernel
        • zeCommandListAppendLaunchKernelIndirect
        • zeCommandListAppendLaunchMultipleKernelsIndirect
      • Module Enums
        • ze_module_format_t
        • ze_kernel_flag_t
        • ze_kernel_attribute_t
      • Module Structures
        • ze_module_constants_t
        • ze_module_desc_t
        • ze_kernel_desc_t
        • ze_kernel_uuid_t
        • ze_kernel_properties_t
        • ze_group_count_t
    • Residency
      • Residency Functions
        • zeDeviceMakeMemoryResident
        • zeDeviceEvictMemory
        • zeDeviceMakeImageResident
        • zeDeviceEvictImage
    • Sampler
      • Sampler Functions
        • zeSamplerCreate
        • zeSamplerDestroy
      • Sampler Enums
        • ze_sampler_address_mode_t
        • ze_sampler_filter_mode_t
      • Sampler Structures
        • ze_sampler_desc_t
  • Tools API
    • Common
      • Common Enums
        • zet_structure_type_t
      • Common Structures
        • zet_base_properties_t
        • zet_base_desc_t
    • Metric
      • Metric Functions
        • zetMetricGroupGet
        • zetMetricGroupGetProperties
        • zetMetricGroupCalculateMetricValues
        • zetMetricGet
        • zetMetricGetProperties
        • zetDeviceActivateMetricGroups
        • zetMetricStreamerOpen
        • zetCommandListAppendMetricStreamerMarker
        • zetMetricStreamerClose
        • zetMetricStreamerReadData
        • zetMetricQueryPoolCreate
        • zetMetricQueryPoolDestroy
        • zetMetricQueryCreate
        • zetMetricQueryDestroy
        • zetMetricQueryReset
        • zetCommandListAppendMetricQueryBegin
        • zetCommandListAppendMetricQueryEnd
        • zetCommandListAppendMetricMemoryBarrier
        • zetMetricQueryGetData
      • Metric Enums
        • zet_metric_group_sampling_type_t
        • zet_metric_type_t
        • zet_value_type_t
        • zet_metric_query_pool_flag_t
      • Metric Structures
        • zet_metric_group_properties_t
        • zet_value_t
        • zet_typed_value_t
        • zet_metric_properties_t
        • zet_metric_streamer_desc_t
        • zet_metric_query_pool_desc_t
    • Module
      • Module Functions
        • zetModuleGetDebugInfo
      • Module Enums
        • zet_module_debug_info_format_t
    • Pin
      • Pin Functions
        • zetKernelGetProfileInfo
      • Pin Enums
        • zet_profile_flag_t
        • zet_profile_token_type_t
      • Pin Structures
        • zet_profile_properties_t
        • zet_profile_free_register_token_t
        • zet_profile_register_sequence_t
    • Tracing
      • Tracing Functions
        • zetTracerCreate
        • zetTracerDestroy
        • zetTracerSetPrologues
        • zetTracerSetEpilogues
        • zetTracerSetEnabled
      • Tracing Structures
        • zet_tracer_desc_t
  • Sysman API
    • Device
      • Device Functions
        • zesDeviceGetProperties
        • zesDeviceGetState
        • zesDeviceReset
        • zesDeviceProcessesGetState
        • zesDevicePciGetProperties
        • zesDevicePciGetState
        • zesDevicePciGetBars
        • zesDevicePciGetStats
      • Device Enums
        • zes_version_t
        • zes_engine_type_t
        • zes_repair_status_t
        • zes_reset_reasons_t
        • zes_pci_link_status_t
        • zes_pci_link_qual_issues_t
        • zes_pci_link_stab_issues_t
        • zes_pci_bar_type_t
      • Device Structures
        • zes_device_state_t
        • zes_device_properties_t
        • zes_process_state_t
        • zes_pci_address_t
        • zes_pci_speed_t
        • zes_pci_properties_t
        • zes_pci_state_t
        • zes_pci_bar_properties_t
        • zes_pci_stats_t
    • Diagnostics
      • Diagnostics Functions
        • zesDeviceEnumDiagnosticTestSuites
        • zesDiagnosticsGetProperties
        • zesDiagnosticsGetTests
        • zesDiagnosticsRunTests
      • Diagnostics Enums
        • zes_diag_type_t
        • zes_diag_result_t
      • Diagnostics Structures
        • zes_diag_test_t
        • zes_diag_properties_t
    • Engine
      • Engine Functions
        • zesDeviceEnumEngineGroups
        • zesEngineGetProperties
        • zesEngineGetActivity
      • Engine Enums
        • zes_engine_group_t
      • Engine Structures
        • zes_engine_properties_t
        • zes_engine_stats_t
    • Events
      • Events Functions
        • zesDeviceCreateEvents
        • zesEventGetConfig
        • zesEventSetConfig
        • zesEventGetState
        • zesEventListen
      • Events Enums
        • zes_event_type_t
      • Events Structures
        • zes_event_config_t
    • Fabric
      • Fabric Functions
        • zesDeviceEnumFabricPorts
        • zesFabricPortGetProperties
        • zesFabricPortGetLinkType
        • zesFabricPortGetConfig
        • zesFabricPortSetConfig
        • zesFabricPortGetState
        • zesFabricPortGetThroughput
      • Fabric Enums
        • zes_fabric_port_status_t
        • zes_fabric_port_qual_issues_t
        • zes_fabric_port_stab_issues_t
      • Fabric Structures
        • zes_fabric_port_id_t
        • zes_fabric_port_speed_t
        • zes_fabric_port_properties_t
        • zes_fabric_link_type_t
        • zes_fabric_port_config_t
        • zes_fabric_port_state_t
        • zes_fabric_port_throughput_t
    • Fan
      • Fan Functions
        • zesDeviceEnumFans
        • zesFanGetProperties
        • zesFanGetConfig
        • zesFanSetConfig
        • zesFanGetState
      • Fan Enums
        • zes_fan_speed_mode_t
        • zes_fan_speed_units_t
      • Fan Structures
        • zes_fan_temp_speed_t
        • zes_fan_properties_t
        • zes_fan_config_t
    • Firmware
      • Firmware Functions
        • zesDeviceEnumFirmwares
        • zesFirmwareGetProperties
        • zesFirmwareGetChecksum
        • zesFirmwareFlash
      • Firmware Structures
        • zes_firmware_properties_t
    • Frequency
      • Frequency Functions
        • zesDeviceEnumFrequencyDomains
        • zesFrequencyGetProperties
        • zesFrequencyGetAvailableClocks
        • zesFrequencyGetRange
        • zesFrequencySetRange
        • zesFrequencyGetState
        • zesFrequencyGetThrottleTime
        • zesFrequencyOcGetCapabilities
        • zesFrequencyOcGetConfig
        • zesFrequencyOcSetConfig
        • zesFrequencyOcGetIccMax
        • zesFrequencyOcSetIccMax
        • zesFrequencyOcGetTjMax
        • zesFrequencyOcSetTjMax
      • Frequency Enums
        • zes_freq_domain_t
        • zes_freq_throttle_reasons_t
        • zes_oc_mode_t
      • Frequency Structures
        • zes_freq_properties_t
        • zes_freq_range_t
        • zes_freq_state_t
        • zes_freq_throttle_time_t
        • zes_oc_capabilities_t
        • zes_oc_config_t
    • Led
      • Led Functions
        • zesDeviceEnumLeds
        • zesLedGetProperties
        • zesLedGetState
        • zesLedSetState
      • Led Structures
        • zes_led_properties_t
        • zes_led_state_t
    • Memory
      • Memory Functions
        • zesDeviceEnumMemoryModules
        • zesMemoryGetProperties
        • zesMemoryGetState
        • zesMemoryGetBandwidth
      • Memory Enums
        • zes_mem_type_t
        • zes_mem_health_t
      • Memory Structures
        • zes_mem_properties_t
        • zes_mem_state_t
        • zes_mem_bandwidth_t
    • Performance
      • Performance Functions
        • zesDeviceEnumPerformanceFactorDomains
        • zesPerformanceFactorGetProperties
        • zesPerformanceFactorGetConfig
        • zesPerformanceFactorSetConfig
      • Performance Structures
        • zes_perf_properties_t
    • Power
      • Power Functions
        • zesDeviceEnumPowerDomains
        • zesPowerGetProperties
        • zesPowerGetEnergyCounter
        • zesPowerGetLimits
        • zesPowerSetLimits
        • zesPowerGetEnergyThreshold
        • zesPowerSetEnergyThreshold
      • Power Structures
        • zes_power_properties_t
        • zes_power_energy_counter_t
        • zes_power_sustained_limit_t
        • zes_power_burst_limit_t
        • zes_power_peak_limit_t
        • zes_energy_threshold_t
    • Psu
      • Psu Functions
        • zesDeviceEnumPsus
        • zesPsuGetProperties
        • zesPsuGetState
      • Psu Enums
        • zes_psu_voltage_status_t
      • Psu Structures
        • zes_psu_properties_t
        • zes_psu_state_t
    • Ras
      • Ras Functions
        • zesDeviceEnumRasErrorSets
        • zesRasGetProperties
        • zesRasGetConfig
        • zesRasSetConfig
        • zesRasGetState
      • Ras Enums
        • zes_ras_error_type_t
        • zes_ras_error_cat_t
      • Ras Structures
        • zes_ras_properties_t
        • zes_ras_state_t
        • zes_ras_config_t
    • Scheduler
      • Scheduler Functions
        • zesDeviceEnumSchedulers
        • zesSchedulerGetProperties
        • zesSchedulerGetCurrentMode
        • zesSchedulerGetTimeoutModeProperties
        • zesSchedulerGetTimesliceModeProperties
        • zesSchedulerSetTimeoutMode
        • zesSchedulerSetTimesliceMode
        • zesSchedulerSetExclusiveMode
        • zesSchedulerSetComputeUnitDebugMode
      • Scheduler Enums
        • zes_sched_mode_t
      • Scheduler Structures
        • zes_sched_properties_t
        • zes_sched_timeout_properties_t
        • zes_sched_timeslice_properties_t
    • Standby
      • Standby Functions
        • zesDeviceEnumStandbyDomains
        • zesStandbyGetProperties
        • zesStandbyGetMode
        • zesStandbySetMode
      • Standby Enums
        • zes_standby_type_t
        • zes_standby_promo_mode_t
      • Standby Structures
        • zes_standby_properties_t
    • Temperature
      • Temperature Functions
        • zesDeviceEnumTemperatureSensors
        • zesTemperatureGetProperties
        • zesTemperatureGetConfig
        • zesTemperatureSetConfig
        • zesTemperatureGetState
      • Temperature Enums
        • zes_temp_sensors_t
      • Temperature Structures
        • zes_temp_properties_t
        • zes_temp_threshold_t
        • zes_temp_config_t
• Versions
  • Latest Release
  • Previous Releases