HcclBarrier

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	☓
Atlas inference product	☓
Atlas training product	√

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

Blocks the streams of all ranks in the specified communicator.

Prototype

HcclResult HcclBarrier(HcclComm comm, aclrtStream stream)

Parameters

Parameter	Input/Output	Description
comm	Input	Communicator where the operation is performed.
stream	Input	Stream of the rank.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Constraints

None.

Call Example

HcclComm comm;
aclrtStream stream;
aclrtCreateStream(&stream);

// Dispatch a communication task (for example, HcclAllReduce) to the stream.
// ...

// Wait until all ranks perform the Barrier operation.
HcclBarrier(comm, stream);

Parent topic: C APIs