Fabric Edge - Experimental

oneAPI Level Zero Specification - Version 1.18.31

Fabric Edge - Experimental Functions

zeFabricEdgeGetExp

Added in version 1.4

ZE_APIEXPORT ze_result_t ZE_APICALL zeFabricEdgeGetExp(ze_fabric_vertex_handle_t hVertexA, ze_fabric_vertex_handle_t hVertexB, uint32_t *pCount, ze_fabric_edge_handle_t *phEdges)

Retrieves all fabric edges between provided pair of fabric vertices.

• A fabric edge represents one or more physical links between two fabric vertices.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

Parameters:

• hVertexA – [in] handle of first fabric vertex instance

• hVertexB – [in] handle of second fabric vertex instance

• pCount – [in,out] pointer to the number of fabric edges. if count is zero, then the driver shall update the value with the total number of fabric edges available. if count is greater than the number of fabric edges available, then the driver shall update the value with the correct number of fabric edges available.

• phEdges – [in,out][optional][range(0, *pCount)] array of handle of fabric edges. if count is less than the number of fabric edges available, then driver shall only retrieve that number of fabric edges.

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 == hVertexA

  • nullptr == hVertexB

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pCount

zeFabricEdgeGetVerticesExp

Added in version 1.4

ZE_APIEXPORT ze_result_t ZE_APICALL zeFabricEdgeGetVerticesExp(ze_fabric_edge_handle_t hEdge, ze_fabric_vertex_handle_t *phVertexA, ze_fabric_vertex_handle_t *phVertexB)

Retrieves fabric vertices connected by a fabric edge.

• A fabric vertex represents either a device or a switch connected to other fabric vertices via a fabric edge.

• The application may call this function from simultaneous threads.

• The implementation of this function must be thread-safe.

Parameters:

• hEdge – [in] handle of the fabric edge instance

• phVertexA – [out] fabric vertex connected to one end of the given fabric edge.

• phVertexB – [out] fabric vertex connected to other end of the given fabric edge.

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 == hEdge

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == phVertexA

  • nullptr == phVertexB

zeFabricEdgeGetPropertiesExp

Added in version 1.4

ZE_APIEXPORT ze_result_t ZE_APICALL zeFabricEdgeGetPropertiesExp(ze_fabric_edge_handle_t hEdge, ze_fabric_edge_exp_properties_t *pEdgeProperties)

Retrieves properties of the fabric edge.

• The application may call this function from simultaneous threads.

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

Parameters:

• hEdge – [in] handle of the fabric edge

• pEdgeProperties – [in,out] query result for fabric edge properties

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 == hEdge

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pEdgeProperties

Fabric Edge - Experimental Enums

ze_fabric_edge_exp_duplexity_t

Added in version 1.4

enum ze_fabric_edge_exp_duplexity_t

Fabric edge duplexity.

Values:

enumerator ZE_FABRIC_EDGE_EXP_DUPLEXITY_UNKNOWN

Fabric edge duplexity is unknown.

enumerator ZE_FABRIC_EDGE_EXP_DUPLEXITY_HALF_DUPLEX

Fabric edge is half duplex, i.e. stated bandwidth is obtained in only one direction at time

enumerator ZE_FABRIC_EDGE_EXP_DUPLEXITY_FULL_DUPLEX

Fabric edge is full duplex, i.e. stated bandwidth is supported in both directions simultaneously

enumerator ZE_FABRIC_EDGE_EXP_DUPLEXITY_FORCE_UINT32

Value marking end of ZE_FABRIC_EDGE_EXP_DUPLEXITY_* ENUMs.

Fabric Edge - Experimental Structures

ze_fabric_edge_exp_properties_t

Added in version 1.0

struct ze_fabric_edge_exp_properties_t

Fabric Edge properties.

Public Members

ze_structure_type_t stype

[in] type of this structure

void *pNext

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

ze_uuid_t uuid

[out] universal unique identifier.

char model[ZE_MAX_FABRIC_EDGE_MODEL_EXP_SIZE]

[out] Description of fabric edge technology. Will be set to the string “unknown” if this cannot be determined for this edge

uint32_t bandwidth

[out] design bandwidth

ze_bandwidth_unit_t bandwidthUnit

[out] bandwidth unit

uint32_t latency

[out] design latency

ze_latency_unit_t latencyUnit

[out] latency unit

ze_fabric_edge_exp_duplexity_t duplexity

[out] Duplexity of the fabric edge