Query

功能说明

查询handleId对应的通信任务已经完成的轮次,最多返回repeat轮。该接口默认在所有核上工作,用户也可以在调用前通过GetBlockIdx指定其在某一个核上运行。

函数原型

1
__aicore__ inline int32_t Query(HcclHandle handleId)

参数说明

表1 接口参数说明

参数名

输入/输出

描述

handleId

输入

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

1
using HcclHandle = int8_t;

返回值

支持的型号

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

注意事项

调用示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
// 假设已构造好HcclCombineOpParam对象hcclCombineOpParam,以及recvBuf和sendBuf
Hccl hccl;
hccl.Init(reinterpret_cast<GM_ADDR>(&hcclCombineOpParam));
if (g_coreType == AIC) {
    auto repeat = 10;
    HcclHandle handleId = hccl.ReduceScatter(sendBuf, recvBuf, 100, HcclDataType::HCCL_DATA_TYPE_INT8, HcclReduceOp::HCCL_REDUCE_SUM, repeat);
    hccl.Commit(handleId ); // 通知服务端可以执行上述的ReduceScatter任务
    int32_t finishedCount = hccl.Query(handleId);
    while (hccl.Query(handleId) < repeat) {} // 等待查询到handleId对应的通信任务执行repeat次
    hccl.Finalize(); // 后续无其他通信任务,通知服务端执行上述ReduceScatter任务之后即可以退出
}