HcclEngineCtxGet

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	x
Atlas inference product	x
Atlas training product	x

For Atlas A2 training product/Atlas A2 inference product, only the Atlas 800T A2 training server, Atlas 900 A2 PoD cluster basic unit, and Atlas 200T A2 Box16 heterogeneous subrack are supported.

Function

Obtains the corresponding communication engine context based on the communication engine context tag by specifying the communicator and communication engine.

Prototype

HcclResult HcclEngineCtxGet(HcclComm comm, const char *ctxTag, CommEngine engine, void **ctx, uint64_t *size)

Parameters

Parameter

Input/Output

Description

comm

Input

Communicator handle.

The HcclComm type is defined as follows:

typedef void *HcclComm;

ctxTag

Input

Communicator engine context tag. The maximum length is HCCL_OP_TAG_LEN_MAX.

const uint32_t HCCL_OP_TAG_LEN_MAX = 255;

engine

Input

Communication engine type.

ctx

Output

Communication engine context handle.

size

Output

Memory size corresponding to the communication engine context.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Restrictions

None

Example

HcclComm comm;
uint64_t size = 0;
void *ctx = nullptr;
string ctxTag = "ctxTag";
CommEngine engine = CommEngine::COMM_ENGINE_CPU_TS;
ret = HcclEngineCtxGet(comm, ctxTag, engine, &ctx, &size);

Parent topic: Communicator Resource Management