HcclGetRootInfo

函数原型

HcclResult HcclGetRootInfo(HcclRootInfo *rootInfo);

功能说明

在初始化HCCL(HcclCommInitRootInfo)前应调用HcclGetRootInfo,生成此rank的标识信息(HcclRootInfo)。然后以此rank为root节点,将此rank的标识信息广播至集群中的所有rank,使用接收到的rootInfo进行HCCL初始化(HcclCommInitRootInfo)。

参数说明

参数名

输入/输出

描述

rootInfo

输出

本rank的标识信息,主要包含device ip,device id等信息,此信息需广播至集群内所有rank用来进行HCCL初始化。

返回值

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

约束说明

  1. 多机集合通信场景,调用HcclGetRootInfo前,需要配置环境变量HCCL_IF_IP、HCCL_WHITELIST_DISABLE、HCCL_WHITELIST_FILE。
  2. 该接口和HcclCommInitRootInfo配对使用,不能单独使用。