Wait

功能说明

阻塞AI Core，等待handleId对应的通信任务完成，本接口的调用次数应该与Prepare接口的repeat次数一致，handleId调用Wait接口的顺序，须和Prepare接口一致。该接口默认在所有核上工作，用户也可以在调用前通过GetBlockIdx指定其在某一个核上运行。

函数原型

      
           __aicore__ inline int32_t Wait(HcclHandle handleId)

参数说明

表1 接口参数说明

参数名

输入/输出

描述

handleId

输入

对应通信任务的标识ID，只能使用Prepare原语接口的返回值。

           
                using HcclHandle = int8_t;

返回值

0，表示成功
-1，表示失败

支持的型号

Atlas A2训练系列产品/Atlas 800I A2推理产品

注意事项

调用本接口前确保已调用过Init接口
入参handleId只能使用Prepare原语对应接口的返回值
本接口的调用次数应该与Prepare的repeat次数一致，handleId调用Wait接口的顺序，须和Prepare接口一致
该接口只能在AI Cube核或者AI Vector核两者之一上调用

调用示例

      
           // 假设已构造好HcclCombineOpParam对象hcclCombineOpParam，以及recvBuf和sendBuf
Hccl hccl;
hccl.Init(reinterpret_cast<GM_ADDR>(&hcclCombineOpParam));
if (g_coreType == AIC) {
    HcclHandle handleId = hccl.ReduceScatter(sendBuf, recvBuf, 100, HcclDataType::HCCL_DATA_TYPE_INT8, HcclReduceOp::HCCL_REDUCE_SUM, 10);
    hccl.Commit(handleId ); // 通知服务端可以执行上述的ReduceScatter任务
    int32_t ret = hccl.Wait(handleId); // 阻塞接口，需等待上述ReduceScatter任务执行完毕
    hccl.Finalize(); // 后续无其他通信任务，通知服务端执行上述ReduceScatter任务之后即可以退出
}

父主题： Hccl