* Copyright (c) 2026 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.
*/
* \file hccl_aicpu_common.h
* \brief
*/
#ifndef IMPL_COMMON_HCCL_AICPU_COMMON_H
#define IMPL_COMMON_HCCL_AICPU_COMMON_H
#include "hccl_utils.h"
namespace AscendC {
__aicore__ inline void CopyHcclMsg(const uint8_t *src, __gm__ HcclMsg *dst)
{
constexpr uint32_t HCCL_VALID_POS = 12U;
__gm__ DataBlock *tmpDst = reinterpret_cast<__gm__ DataBlock *>(dst);
volatile uint32_t xorCheck = 0U;
for (uint32_t i = 0; i < HCCL_MSG_DATA_CNT - 1U; ++i) {
if (i == HCCL_VALID_POS) {
xorCheck ^= HCCL_MSG_VALID_MASK;
} else {
xorCheck ^= tmpDst->data[i] = *(reinterpret_cast<const uint32_t *>(src));
}
src += sizeof(tmpDst->data[i]);
}
tmpDst->data[HCCL_MSG_DATA_CNT - 1U] = xorCheck;
tmpDst->data[HCCL_VALID_POS] = HCCL_MSG_VALID_MASK;
}
__aicore__ inline void AssembleHcclMsgExt(const AlltoAllVParamExt ¶m, uint32_t rankDim, __gm__ HcclMsgExt *dst)
{
uint64_t xorCheck = 0U;
for (uint32_t i = 0U; i < rankDim; ++i) {
xorCheck ^= dst->sendCounts[i] = param.sendCounts[i];
xorCheck ^= dst->sendOffset[i] = param.sdispls[i];
xorCheck ^= dst->recvCounts[i] = param.recvCounts[i];
xorCheck ^= dst->recvOffset[i] = param.rdispls[i];
}
dst->xorCheck = (xorCheck ^ HCCL_MSG_VALID_MASK);
dst->valid = HCCL_MSG_VALID_MASK;
}
constexpr uint32_t HCCL_CONTROL_RESERVED_PRIMITIVE_ID_IDX = 0U;
constexpr uint32_t HCCL_CONTROL_RESERVED_PRIMITIVE_RESET_IDX = 1U;
__aicore__ inline void ResetPrimitiveIdStateInControlMsg(__gm__ ControlHcclMsg *controlMsgGM)
{
ASCENDC_HCCL_API_ASSERT(controlMsgGM != nullptr, { return; }, "Control msg is nullptr.");
controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_ID_IDX] = 0U;
controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_RESET_IDX] = 0U;
FlushDataCache(controlMsgGM);
}
__aicore__ inline void ResetPrimitiveIdOnceInControlMsg(__gm__ ControlHcclMsg *controlMsgGM)
{
ASCENDC_HCCL_API_ASSERT(controlMsgGM != nullptr, { return; }, "Control msg is nullptr.");
FlushDataCache(controlMsgGM);
if (controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_RESET_IDX] == 0U) {
controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_ID_IDX] = 0U;
controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_RESET_IDX] = 1U;
FlushDataCache(controlMsgGM);
}
}
__aicore__ inline uint8_t FetchAndIncPrimitiveIdInControlMsg(__gm__ ControlHcclMsg *controlMsgGM)
{
ASCENDC_HCCL_API_ASSERT(controlMsgGM != nullptr, { return 0U; }, "Control msg is nullptr.");
FlushDataCache(controlMsgGM);
uint8_t seqNum = controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_ID_IDX];
controlMsgGM->reserved[HCCL_CONTROL_RESERVED_PRIMITIVE_ID_IDX] = static_cast<uint8_t>(seqNum + 1U);
FlushDataCache(controlMsgGM);
return seqNum;
}
__aicore__ inline void AssembleHcclMsgV2(const CommonPrepareParam ¶m, HcclTilingVersion ver, HcclHandle handle,
uint64_t tiling, __gm__ HcclMsg *dst, __gm__ ControlHcclMsg *controlMsgGM)
{
HcclMsg tmp{};
FlushDataCache(controlMsgGM);
if (controlMsgGM->resetSeq > 0) {
controlMsgGM->resetSeq = 0;
ResetPrimitiveIdOnceInControlMsg(controlMsgGM);
}
tmp.commType.msgType = param.commType.msgType;
if (param.commType.msgType == ControlMsgType::HCCL_CMD_FINALIZE) {
ResetPrimitiveIdStateInControlMsg(controlMsgGM);
} else {
tmp.opType = param.op;
tmp.sendBuffer = reinterpret_cast<uint64_t>(param.sendBuf);
tmp.recvBuffer = reinterpret_cast<uint64_t>(param.recvBuf);
tmp.dataCnt = param.count;
tmp.strideCount = param.strideCount;
if (ver == HcclTilingVersion::DEPRECATED_TILING_VERSION) {
tmp.addMsg.v0Msg.hcclDataType = param.dataType;
tmp.addMsg.v0Msg.repeatCnt = param.repeat;
tmp.addMsg.v0Msg.selfHandleID = handle;
tmp.addMsg.v0Msg.seqNum = FetchAndIncPrimitiveIdInControlMsg(controlMsgGM);
tmp.addMsg.v0Msg.version = ver;
} else {
tmp.addMsg.v1Msg.ccOpTilingData = tiling;
tmp.addMsg.v1Msg.hcclDataType = param.dataType;
tmp.addMsg.v1Msg.repeatCnt = param.repeat;
tmp.addMsg.v1Msg.selfHandleID = handle;
tmp.addMsg.v1Msg.seqNum = FetchAndIncPrimitiveIdInControlMsg(controlMsgGM);
tmp.addMsg.v1Msg.version = ver;
}
}
tmp.addMsg.v0Msg.valid = HCCL_MSG_VALID_MASK;
CopyHcclMsg(reinterpret_cast<const uint8_t *>(&tmp), dst);
}
__aicore__ inline void AssembleHcclMsg(const CommonPrepareParam ¶m, HcclTilingVersion ver, HcclHandle handle,
uint64_t tiling, __gm__ HcclMsg *dst, __gm__ ControlHcclMsg *controlMsgGM)
{
HcclMsg tmp{};
static uint8_t primitiveId = 0U;
static bool isResetPrimitiveId = false;
FlushDataCache(controlMsgGM);
if (controlMsgGM->resetSeq > 0) {
controlMsgGM->resetSeq = 0;
if (!isResetPrimitiveId) {
primitiveId = 0U;
isResetPrimitiveId = true;
}
}
tmp.commType.msgType = param.commType.msgType;
if (param.commType.msgType == ControlMsgType::HCCL_CMD_FINALIZE) {
primitiveId = 0U;
isResetPrimitiveId = false;
} else {
tmp.opType = param.op;
tmp.sendBuffer = reinterpret_cast<uint64_t>(param.sendBuf);
tmp.recvBuffer = reinterpret_cast<uint64_t>(param.recvBuf);
tmp.dataCnt = param.count;
tmp.strideCount = param.strideCount;
if (ver == HcclTilingVersion::DEPRECATED_TILING_VERSION) {
tmp.addMsg.v0Msg.hcclDataType = param.dataType;
tmp.addMsg.v0Msg.repeatCnt = param.repeat;
tmp.addMsg.v0Msg.selfHandleID = handle;
tmp.addMsg.v0Msg.seqNum = primitiveId++;
tmp.addMsg.v0Msg.version = ver;
} else {
tmp.addMsg.v1Msg.ccOpTilingData = tiling;
tmp.addMsg.v1Msg.hcclDataType = param.dataType;
tmp.addMsg.v1Msg.repeatCnt = param.repeat;
tmp.addMsg.v1Msg.selfHandleID = handle;
tmp.addMsg.v1Msg.seqNum = primitiveId++;
tmp.addMsg.v1Msg.version = ver;
}
}
tmp.addMsg.v0Msg.valid = HCCL_MSG_VALID_MASK;
CopyHcclMsg(reinterpret_cast<const uint8_t *>(&tmp), dst);
}
__aicore__ inline void AssembleHcclMsg(const CommonPrepareParam ¶m, int8_t srcGroupID,
HcclHandle srcHandleID, __gm__ HcclMsg *dst)
{
HcclMsg tmp{};
tmp.commType.msgType = param.commType.msgType;
tmp.addMsg.v0Msg.commDepGroupID = srcGroupID;
tmp.addMsg.v0Msg.commDepHandleID = srcHandleID;
tmp.addMsg.v0Msg.valid = HCCL_MSG_VALID_MASK;
CopyHcclMsg(reinterpret_cast<const uint8_t *>(&tmp), dst);
}
__aicore__ inline HcclContextDef::HcclRankRelationResV2 *GetRemoteRankAddrs(__gm__ HcclContextDef::HcclOpResParam *ctx,
uint32_t rankId)
{
const HcclContextDef::RemoteResPtr *remoteRes =
reinterpret_cast<const HcclContextDef::RemoteResPtr *>(reinterpret_cast<uintptr_t>(ctx) + ctx->rWinStart);
return remoteRes[rankId].nextDevicePtr;
}
__aicore__ inline void UpdateControlMsgCount(__gm__ HcclMsgArea *hcclMsgArea, ControlMsgType msg)
{
ASCENDC_HCCL_API_ASSERT(msg < ControlMsgType::HCCL_CMD_MAX, { return; },
"Invalid msg type %u.", static_cast<uint32_t>(msg));
__gm__ TurnCnt *apiInfo = &(hcclMsgArea->apiStats.msgStats[
static_cast<uint32_t>(msg) - static_cast<uint32_t>(ControlMsgType::HCCL_CMD_FINALIZE)]);
FlushDataCache(apiInfo);
++(apiInfo->cnt);
FlushDataCache(apiInfo);
}
}
#endif
