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

HcclEngineCtxCreate

产品支持情况

产品

是否支持

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 HcclEngineCtxCreate(HcclComm comm, const char *ctxTag, CommEngine engine, uint64_t size, void **ctx)

参数说明

参数名

输入/输出

描述

comm

输入

通信域句柄。

HcclComm类型的定义如下:

1
typedef void *HcclComm;

ctxTag

输入

通信引擎上下文标签,最大字符长度为HCCL_OP_TAG_LEN_MAX。

const uint32_t HCCL_OP_TAG_LEN_MAX = 255;

engine

输入

通信引擎类型。

CommEngine的定义可参见CommEngine

size

输入

ctx内存大小。

ctx

输出

通信引擎上下文。

返回值

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

约束说明

调用示例

1
2
3
4
5
6
HcclComm comm;
uint64_t size = 16;
void *ctx = nullptr;
string ctxTag = "ctxTag";
CommEngine engine = CommEngine::COMM_ENGINE_CPU_TS;
HcclResult ret = HcclEngineCtxCreate(comm, ctxTag, engine, size, &ctx);