HcommWriteReduceOnThread

产品支持情况

产品	是否支持
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 异构子框。

功能说明

向channel上的指定内存写数据，将src中长度为count*sizeof(dataType)的内存数据，与dst所指向的相同长度的内存数据进行reduceOp操作，并将结果输出到dst中。接口调用方为src所在节点。

函数原型

int32_t HcommWriteReduceOnThread(ThreadHandle thread, ChannelHandle channel, void *dst, const void *src, uint64_t count, HcommDataType dataType, HcommReduceOp reduceOp)

参数说明

参数名	输入/输出	描述
thread	输入	通信线程句柄，为通过HcclThreadAcquire接口获取到的threads。 ThreadHandle类型的定义可参见ThreadHandle。
channel	输入	通信通道句柄，为通过HcclChannelAcquire接口获取到的channels。 ChannelHandle类型的定义可参见ChannelHandle。
dst	输出	目的内存地址。
src	输入	源内存地址。
count	输入	元素个数。
dataType	输入	数据类型。 HcommDataType类型的定义可参见HcommDataType。
reduceOp	输入	归约操作类型。 HcommReduceOp类型的定义可参见HcommReduceOp。

返回值

int32_t：接口成功返回0，其他失败。

约束说明

无

调用示例

资源初始化相关代码请参见HcommWriteOnThread的调用示例。

void Sample(HcclComm comm, ChannelHandle channel, HcclThread threadHandle, uint32_t rank)
{
    if (rank == 0) {
        CommBuffer localBuf;
        // 获取本端通信内存信息
        HcclGetHcclBuffer(comm, &localBuf.addr, &localBuf.size);
        CommBuffer remoteBuf;
        // 获取对端通信内存信息
        HcclChannelGetHcclBuffer(comm, channel, &remoteBuf.addr, &remoteBuf.size);
        uint64_t len = std::min(localBuf.size, remoteBuf.size);

        // 前同步，通知对端本端已准备完成，并接收对端准备完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 0);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 0, NOTIFY_TIMEOUT);
        // 将本端内存和对端内存数据进行reduce，输出到对端内存上
        HcommWriteReduceOnThread(threadHandle, channel, remoteBuf.addr, localBuf.addr, count, HCCL_DATA_TYPE_FP32, HCCL_REDUCE_SUM);
        // 数据写完成同步，通知对端本端数据写完成，并接收对端数据写完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 1);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 1, NOTIFY_TIMEOUT);
        // 后同步，通知对端本端已完成数据接收，并接收对端数据接收完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 2);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 2, NOTIFY_TIMEOUT);
    } else {
        // 前同步，通知对端本端已准备完成，并接收对端准备完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 0);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 0, NOTIFY_TIMEOUT);
        // 数据写完成同步，通知对端本端数据写完成，并接收对端数据写完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 1);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 1, NOTIFY_TIMEOUT);
        // 后同步，通知对端本端已完成数据接收，并接收对端数据接收完成信号
        HcommChannelNotifyRecordOnThread(threadHandle, channel, 2);
        HcommChannelNotifyWaitOnThread(threadHandle, channel, 2, NOTIFY_TIMEOUT);
    }
    return;
}

父主题： 通信操作