HcclRankGraphGetEndpointDesc

产品支持情况

产品	是否支持
Atlas 350 加速卡	√
Atlas A3 训练系列产品/Atlas A3 推理系列产品	☓
Atlas A2 训练系列产品/Atlas A2 推理系列产品	☓
Atlas 200I/500 A2 推理产品	☓
Atlas 推理系列产品	☓
Atlas 训练系列产品	☓

功能说明

获取拓扑实例的EndPoint描述列表。

函数原型

HcclResult HcclRankGraphGetEndpointDesc(HcclComm comm, uint32_t layer, uint32_t topoInstId, uint32_t *descNum, EndpointDesc *endpointDesc);

参数说明

参数名

输入/输出

描述

comm

输入

通信域。

HcclComm类型的定义如下：

typedef void *HcclComm;

layer

输入

拓扑层级编号。

topoInstId

输入

拓扑实例ID。

descNum

输入/输出

要获取的通信设备描述数量。

作为输入时，需要等于HcclRankGraphGetEndpointNum接口的输出“num”的值。

endPointDesc

输出

EndPoint描述列表，需要调用方分配内存。

EndpointDesc类型的定义请参见EndPointDesc。

返回值

HcclResult：接口成功返回HCCL_SUCCESS，其他失败。

约束说明

无

调用示例

HcclComm comm;
uint32_t layer = 0;
uint32_t topoInstId = 0;
uint32_t num = 0;
HcclRankGraphGetEndpointNum(comm, layer, topoInstId, &num);
uint32_t descNum = num;
HcclRankGraphGetEndpointDesc(comm, layer, topoInstId, &descNum, endPointDesc);

父主题： 拓扑信息查询