昇腾社区首页
中文
注册
开发者
下载

HcclThreadAcquire

产品支持情况

产品

是否支持

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 异构子框。

功能说明

基于通信域获取通信线程。

函数原型

1
HcclResult HcclThreadAcquire(HcclComm comm, CommEngine engine, uint32_t threadNum, uint32_t notifyNumPerThread, ThreadHandle *threads)

参数说明

参数名

输入/输出

描述

comm

输入

通信域。

HcclComm类型的定义如下:

1
typedef void *HcclComm;

engine

输入

通信引擎类型。

CommEngine类型的定义可参见CommEngine

threadNum

输入

通信线程数量。一个通信域内最多申请40条流。

notifyNumPerThread

输入

每个通信线程中的同步资源(Notify)数量。一个通信域内最多申请64个同步资源。

threads

输出

返回的通信线程句柄。需传入threadNum大小的ThreadHandle类型数组。

ThreadHandle类型的定义可参见ThreadHandle

返回值

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

约束说明

返回的通信线程与同步资源由库内管理,调用者严禁释放。

调用示例

1
2
3
4
5
HcclComm comm;
CommEngine engine = COMM_ENGINE_AICPU_TS;
ThreadHandle threads[5];
// 申请5条流,每条流2个notify
HcclResult result = HcclThreadAcquire(comm, engine, 5, 2, threads);