Module - Extensions

oneAPI Level Zero Specification - Version 1.18.31

Module - Extension Functions

zeModuleInspectLinkageExt

Added in version 1.3

ZE_APIEXPORT ze_result_t ZE_APICALL zeModuleInspectLinkageExt(ze_linkage_inspection_ext_desc_t *pInspectDesc, uint32_t numModules, ze_module_handle_t *phModules, ze_module_build_log_handle_t *phLog)

List Imports & Exports.

• List all the import & unresolveable import dependencies & exports of a set of modules

Remark

Analogues

• None

Parameters:

• pInspectDesc – [in] pointer to linkage inspection descriptor structure.

• numModules – [in] number of modules to be inspected pointed to by phModules.

• phModules – [in][range(0, numModules)] pointer to an array of modules to be inspected for import dependencies.

• phLog – [out] pointer to handle of linkage inspection log. Log object will contain separate lists of imports, un-resolvable imports, and exports.

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_POINTER

  • nullptr == pInspectDesc

  • nullptr == phModules

  • nullptr == phLog

• ZE_RESULT_ERROR_INVALID_ENUMERATION

  • 0x7 < pInspectDesc->flags

• ZE_RESULT_ERROR_UNSUPPORTED_ENUMERATION

Module - Extension Enums

ze_linkage_inspection_ext_flags_t

Added in version 1.3

enum ze_linkage_inspection_ext_flag_t

Values:

enumerator ZE_LINKAGE_INSPECTION_EXT_FLAG_IMPORTS

List all imports of modules.

enumerator ZE_LINKAGE_INSPECTION_EXT_FLAG_UNRESOLVABLE_IMPORTS

List all imports of modules that do not have a corresponding export.

enumerator ZE_LINKAGE_INSPECTION_EXT_FLAG_EXPORTS

List all exports of modules.

enumerator ZE_LINKAGE_INSPECTION_EXT_FLAG_FORCE_UINT32

Value marking end of ZE_LINKAGE_INSPECTION_EXT_FLAG_* ENUMs.

Module - Extension Structures

ze_linkage_inspection_ext_desc_t

Added in version 1.3

struct ze_linkage_inspection_ext_desc_t

Module linkage inspection descriptor.

• This structure may be passed to zeModuleInspectLinkageExt.

Public Members

ze_structure_type_t stype

[in] type of this structure

const void *pNext

[in][optional] must be null or a pointer to an extension-specific structure (i.e. contains stype and pNext).

ze_linkage_inspection_ext_flags_t flags

[in] flags specifying module linkage inspection. must be 0 (default) or a valid combination of ze_linkage_inspection_ext_flag_t.