HcclRankGraphGetLayers

产品支持情况

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

针对 Atlas A2 训练系列产品 / Atlas A2 推理系列产品，仅支持Atlas 800T A2 训练服务器、Atlas 900 A2 PoD 集群基础单元、Atlas 200T A2 Box16 异构子框。

功能说明

查询包含当前rank的拓扑层级编号列表以及拓扑层级数量。

以上述拓扑模型为例，包含Layer 0和Layer 1两级拓扑，调用此接口后返回的拓扑层级编号列表为[0,1]，拓扑层级数量为2。

函数原型

      
           HcclResult HcclRankGraphGetLayers(HcclComm comm, uint32_t **netLayers, uint32_t *netLayerNum)

参数说明

参数名

输入/输出

描述

comm

输入

当前rank所在的通信域。

HcclComm类型的定义如下：

           
                typedef void *HcclComm;

netLayers

输出

拓扑层级编号列表。

netLayerNum

输出

拓扑层级编号数量。

返回值

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

约束说明

无

调用示例

以功能说明的拓扑模型为例：

      
           HcclComm comm;
uint32_t *netLayers;
uint32_t layerNum;
HcclRankGraphGetLayers(comm, &netLayers, &layerNum);
// netLayers=[0,1], layerNum=2

父主题： 拓扑信息查询