* Copyright (c) 2025 Huawei Technologies Co., Ltd.
* This program is free software, you can redistribute it and/or modify it under the terms and conditions of
* CANN Open Software License Agreement Version 2.0 (the "License").
* Please refer to the License for details. You may not use this file except in compliance with the License.
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
* See LICENSE in the root of the software repository for the full text of the License.
*/
#include "recv_op.h"
#include "op_common_ops.h"
#include <algorithm>
#include <future>
#include <map>
#include <string>
using namespace std;
using namespace ops_hccl;
extern "C" unsigned int LaunchAicpuKernel(OpParam *param);
HcclResult HcclRecvNext(
void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank, const HcclComm comm, aclrtStream stream)
{
HCCL_INFO("[HcclRecv] Start.");
HcclUs startut = TIME_NOW();
CHK_RET(InitEnvConfig());
u32 rankSize = INVALID_VALUE_RANKSIZE;
u32 userRank = INVALID_VALUE_RANKID;
std::string tag;
CHK_PRT_RET(count == 0, HCCL_WARNING("[HcclRecv] input count is 0, return recv success"), HcclResult::HCCL_SUCCESS);
CHK_RET(GetAndCheckRecvPara(comm, recvBuf, count, dataType, srcRank, rankSize, userRank, tag));
CHK_RET(RecvEntryLog(recvBuf, count, dataType, srcRank, stream, tag, "HcclRecv"));
CHK_RET_AND_PRINT_IDE(RecvExec(recvBuf, count, dataType, srcRank, comm, stream, rankSize, OpMode::OPBASE, tag),
tag.c_str());
CHK_RET(LogHcclExit("HcclRecv", tag.c_str(), startut));
HCCL_INFO("[HcclRecv][%d]<-[%d] Success.", userRank, srcRank);
return HcclResult::HCCL_SUCCESS;
}
HcclResult HcclRecv(
void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank, HcclComm comm, aclrtStream stream)
{
HCCL_INFO("[HcclRecv] Start.");
if (IsHostDpu(comm)) {
return HcclRecvNext(recvBuf, count, dataType, srcRank, comm, stream);
}
if (GetHcommVersion() < CANN_VERSION(9, 0, 0)) {
return HcclRecvInner(recvBuf, count, dataType, srcRank, comm, stream);
}
DevType deviceType = DevType::DEV_TYPE_COUNT;
CHK_RET(hrtGetDeviceType(deviceType));
#ifdef MACRO_DEV_TYPE_NEW
if (deviceType != DevType::DEV_TYPE_950) {
#else
if (deviceType != DevType::DEV_TYPE_910_95) {
#endif
return HcclRecvInner(recvBuf, count, dataType, srcRank, comm, stream);
}
return HcclRecvNext(recvBuf, count, dataType, srcRank, comm, stream);
}
HcclResult HcclRecvGraphMode(
void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank, const char* group, aclrtStream stream,
const char* tag, void **streams, size_t streamCount, void *scratchMemAddr, uint64_t scratchMemSize)
{
HCCL_INFO("[HcclRecvGraphMode] Start.");
CHK_PTR_NULL(group);
HcclComm comm = nullptr;
HCCL_INFO("[HcclRecvGraphMode] get group name: %s", group);
CHK_RET(HcomGetCommHandleByGroup(group, &comm));
HcclUs startut = TIME_NOW();
CHK_RET(InitEnvConfig());
u32 rankSize = INVALID_VALUE_RANKSIZE;
u32 userRank = INVALID_VALUE_RANKID;
std::string opTag(tag ? tag : "");
CHK_PRT_RET(count == 0, HCCL_WARNING("[HcclRecvGraphMode] input count is 0, return recv success"), HcclResult::HCCL_SUCCESS);
CHK_RET(GetAndCheckRecvPara(comm, recvBuf, count, dataType, srcRank, rankSize, userRank, opTag));
CHK_PTR_NULL(tag);
ResPackGraphMode resPack;
auto fillTagRet = strncpy_s(resPack.tag, sizeof(resPack.tag), tag, sizeof(resPack.tag) - 1);
CHK_PRT_RET(
fillTagRet != EOK,
HCCL_ERROR("[HcclRecvGraphMode] failed to fill resPack.tag, tag %s, return %d.", tag, fillTagRet),
HcclResult::HCCL_E_INTERNAL);
if (streams != nullptr && streamCount > 0) {
for (size_t i = 0; i < streamCount; i++) {
resPack.streams.push_back(static_cast<aclrtStream>(streams[i]));
}
}
resPack.scratchMemAddr = scratchMemAddr;
resPack.scratchMemSize = scratchMemSize;
CHK_RET(RecvEntryLog(recvBuf, count, dataType, srcRank, stream, opTag, "HcclRecvGraphMode", true));
CHK_RET_AND_PRINT_IDE(RecvExec(recvBuf, count, dataType, srcRank, comm, stream, rankSize, OpMode::OFFLOAD, opTag, resPack), opTag.c_str());
CHK_RET(LogHcclExit("HcclRecvGraphMode", opTag.c_str(), startut, true));
HCCL_INFO("[HcclRecvGraphMode][%d]<-[%d] Success.", userRank, srcRank);
return HcclResult::HCCL_SUCCESS;
}
namespace ops_hccl {
HcclResult GetAndCheckRecvPara(
const HcclComm comm, const void *recvBuf, const uint64_t count, const HcclDataType dataType,
const uint32_t srcRank, u32 &rankSize, u32 &userRank, std::string &tag)
{
RPT_INPUT_ERR(
comm == nullptr,
"EI0003",
std::vector<std::string>({"ccl_op", "value", "parameter", "expect"}),
std::vector<std::string>({"HcclRecv", "nullptr", "comm", "non-null pointer"}));
CHK_PTR_NULL(comm);
RPT_INPUT_ERR(
recvBuf == nullptr,
"EI0003",
std::vector<std::string>({"ccl_op", "value", "parameter", "expect"}),
std::vector<std::string>({"HcclRecv", "nullptr", "recvBuf", "non-null pointer"}));
CHK_PTR_NULL(recvBuf);
CHK_RET(CheckCount(count));
CHK_RET(CheckDataType(dataType, false));
CHK_RET(HcclGetRankSize(comm, &rankSize));
CHK_RET(HcclGetRankId(comm, &userRank));
CHK_PRT_RET(userRank == srcRank, HCCL_ERROR("[HcclRecv] srcRank cannot be equal to self."), HcclResult::HCCL_E_NOT_SUPPORT);
if (tag.empty()) {
char commName[COMM_INDENTIFIER_MAX_LENGTH];
CHK_RET(HcclGetCommName(comm, commName));
tag = "SendRecv_" + string(commName) + "_" + std::to_string(srcRank) + "_" + std::to_string(userRank);
}
CHK_RET(HcclCheckTag(tag.c_str()));
CHK_RET_AND_PRINT_IDE(HcomCheckUserRank(rankSize, userRank), tag.c_str());
CHK_RET_AND_PRINT_IDE(HcomCheckUserRank(rankSize, srcRank), tag.c_str());
return HcclResult::HCCL_SUCCESS;
}
HcclResult GenerateRecvOpParam(
OpParam ¶m, void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank,
const HcclComm comm, const aclrtStream stream, const std::string &tag)
{
CHK_RET(HcclGetCommName(comm, param.commName));
u32 dataTypeSize = DATATYPE_SIZE_TABLE[dataType];
u64 dataSize = count * dataTypeSize;
param.opType = HcclCMDType::HCCL_CMD_RECEIVE;
param.enableDetour = false;
DevType deviceType = DevType::DEV_TYPE_COUNT;
CHK_RET(hrtGetDeviceType(deviceType));
param.deviceType = deviceType;
auto fillTagRet = strncpy_s(param.tag, sizeof(param.tag), tag.c_str(), sizeof(param.tag) - 1);
CHK_PRT_RET(
fillTagRet != EOK,
HCCL_ERROR("[GenerateRecvOpParam] failed to fill param.tag, tag %s, return %d.", tag.c_str(), fillTagRet),
HcclResult::HCCL_E_INTERNAL);
param.stream = stream;
param.inputPtr = nullptr;
param.inputSize = 0;
param.sendRecvRemoteRank = srcRank;
param.outputPtr = recvBuf;
param.outputSize = dataSize;
param.DataDes.count = count;
param.DataDes.dataType = dataType;
return HcclResult::HCCL_SUCCESS;
}
HcclResult RecvExec(
void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank,
const HcclComm comm, const aclrtStream stream, const u32 &rankSize,
const OpMode &opMode, const std::string &tag, const ResPackGraphMode &resPack)
{
HCCL_DEBUG("[RecvExec][%s][%s] Start.", tag.c_str(), opMode == OpMode::OPBASE ? "OPBASE" : "OFFLOAD");
OpParam param;
CHK_RET(GenerateRecvOpParam(param, recvBuf, count, dataType, srcRank, comm, stream, tag));
param.opMode = opMode;
std::string algName;
std::unique_ptr<TopoInfoWithNetLayerDetails> topoInfo = std::make_unique<TopoInfoWithNetLayerDetails>();
CHK_RET(HcclGetOpExpansionMode(comm, param));
CHK_RET(Selector(comm, param, topoInfo, algName));
if (ShouldUseInnerOp(param.opExecuteConfig) && param.opMode == OpMode::OPBASE) {
return HcclRecvInner(recvBuf, count, dataType, srcRank, comm, stream);
}
if (rankSize == 1) {
HCCL_WARNING("[RecvExec][%s][%s] ranksize == 1, enter SingleRankProc", tag.c_str(),
opMode == OpMode::OPBASE ? "OPBASE" : "OFFLOAD");
CHK_RET(SingleRankProc(comm, param));
return HcclResult::HCCL_SUCCESS;
}
CHK_RET(HcclExecOp(comm, param, topoInfo, algName, resPack));
return HcclResult::HCCL_SUCCESS;
}
HcclResult RecvEntryLog(void *recvBuf, uint64_t count, HcclDataType dataType, uint32_t srcRank,
aclrtStream stream, const std::string &tag, const std::string &opName, bool forceLog)
{
if (forceLog || GetExternalInputHcclEnableEntryLog()) {
s32 deviceLogicId = 0;
ACLCHECK(aclrtGetDevice(&deviceLogicId));
s32 streamId = 0;
ACLCHECK(aclrtStreamGetId(stream, &streamId));
char stackLogBuffer[LOG_TMPBUF_SIZE];
s32 ret = snprintf_s(stackLogBuffer, LOG_TMPBUF_SIZE, LOG_TMPBUF_SIZE - 1U,
"tag[%s], recvBuf[%p], count[%llu], dataType[%s], srcRank[%u], streamId[%d], deviceLogicId[%d]",
tag.c_str(), recvBuf, count, GetDataTypeEnumStr(dataType).c_str(), srcRank, streamId, deviceLogicId);
CHK_PRT_CONT(ret == -1, HCCL_WARNING("Failed to build log info, tag[%s].", tag.c_str()));
std::string logInfo = "Entry-" + opName + ":" + std::string(stackLogBuffer);
HCCL_RUN_INFO("%s", logInfo.c_str());
}
return HCCL_SUCCESS;
}
}