Module

oneAPI Level Zero Specification - Version 1.18.31

Module Functions

zetModuleGetDebugInfo

Added in version 1.0

ZE_APIEXPORT ze_result_t ZE_APICALL zetModuleGetDebugInfo(zet_module_handle_t hModule, zet_module_debug_info_format_t format, size_t *pSize, uint8_t *pDebugInfo)

Retrieve debug info from module.

• The caller can pass nullptr for pDebugInfo when querying only for size.

• The implementation will copy the native binary into a buffer supplied by the caller.

• The application may call this function from simultaneous threads.

• The implementation of this function should be lock-free.

Parameters:

• hModule – [in] handle of the module

• format – [in] debug info format requested

• pSize – [in,out] size of debug info in bytes

• pDebugInfo – [in,out][optional] byte pointer to debug info

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hModule

• ZE_RESULT_ERROR_INVALID_ENUMERATION

  • ZET_MODULE_DEBUG_INFO_FORMAT_ELF_DWARF < format

• ZE_RESULT_ERROR_UNSUPPORTED_ENUMERATION

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pSize

Module Enums

zet_module_debug_info_format_t

Added in version 1.0

enum zet_module_debug_info_format_t

Supported module debug info formats.

Values:

enumerator ZET_MODULE_DEBUG_INFO_FORMAT_ELF_DWARF

Format is ELF/DWARF.

enumerator ZET_MODULE_DEBUG_INFO_FORMAT_FORCE_UINT32

Value marking end of ZET_MODULE_DEBUG_INFO_FORMAT_* ENUMs.