* 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 <gtest/gtest.h>
#include <mockcpp/mockcpp.hpp>
#include <memory>
#include <cstring>
#include <unordered_set>
#include "hccl/base.h"
#include "hccl/hccl_types.h"
#include "hcom_pub.h"
#include "hcom_common.h"
#include "comm_config_pub.h"
#include "common.h"
#include "hccl_communicator.h"
#define private public
#include "aclgraph_callback.h"
#undef private
#include "aclgraph/zero_copy_acl_graph.h"
#include "aicpu_operator_pub.h"
#include "stream_utils.h"
using namespace hccl;
rtError_t rtModelGetIdMock(rtModel_t model, uint32_t *modelId)
{
*modelId = 1;
return RT_ERROR_NONE;
}
HcclResult GetStreamCaptureInfoMock(aclrtStream stream, aclmdlRI &rtModel, bool &isCapture)
{
rtModel = reinterpret_cast<aclmdlRI>(0x1);
isCapture = true;
return HCCL_SUCCESS;
}
HcclResult GetModelIdMock(aclmdlRI &rtModel, u64 &modelId)
{
modelId = 1;
return HCCL_SUCCESS;
}
class AclgraphCallbackTest : public testing::Test {
protected:
void SetUp() override {
comm.reset(new (std::nothrow) hccl::hcclComm());
if (!comm) {
HCCL_ERROR("Failed to create hccl::hcclComm");
return;
}
}
void TearDown() override {
std::lock_guard<std::mutex> lock(AclgraphCallback::GetInstance().resMutex_);
AclgraphCallback::GetInstance().captureResMap_.clear();
AclgraphCallback::GetInstance().captureCallbackParamMap_.clear();
GlobalMockObject::reset();
}
std::shared_ptr<hccl::hcclComm> comm;
HcclCommunicator communicator1_;
HcclCommunicator communicator2_;
int mockModel_ = 0;
};
TEST_F(AclgraphCallbackTest, ut_InsertNewTagToCaptureResMap_When_Capture_Expect_SUCCESS)
{
MOCKER(rtModelGetId)
.stubs()
.will(invoke(rtModelGetIdMock));
std::string newTag = "tag";
OpParam opParam;
HcclResult ret = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(&communicator1_, newTag, opParam);
EXPECT_EQ(ret, HCCL_SUCCESS);
GlobalMockObject::verify();
}
TEST_F(AclgraphCallbackTest, ut_InsertNewTagToCaptureResMap_When_Comm_Invalid_Expect_Fail)
{
std::string newTag = "tag";
OpParam opParam;
HcclResult ret = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(nullptr, newTag, opParam);
EXPECT_EQ(ret, HCCL_E_PTR);
GlobalMockObject::verify();
}
TEST_F(AclgraphCallbackTest, ut_CleanCaptureRes_When_modelId_Invalid_Expect_Fail)
{
u64 modelId = 0;
HcclResult ret = AclgraphCallback::GetInstance().CleanCaptureRes(modelId);
EXPECT_EQ(ret, HCCL_E_NOT_FOUND);
GlobalMockObject::verify();
}
TEST_F(AclgraphCallbackTest, ut_CleanCaptureRes_By_Communicator_With_Multiple_Comms_Expect_Correct_Comm_Removed)
{
std::string newTag = "tag";
OpParam opParam;
HcclResult ret1 = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(&communicator1_, newTag, opParam);
EXPECT_EQ(ret1, HCCL_SUCCESS);
HcclResult ret2 = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(&communicator2_, newTag, opParam);
EXPECT_EQ(ret2, HCCL_SUCCESS);
bool foundComm1Before = false;
bool foundComm2Before = false;
for (const auto &modelEntry : AclgraphCallback::GetInstance().captureResMap_) {
if (modelEntry.second.find(&communicator1_) != modelEntry.second.end()) {
foundComm1Before = true;
}
if (modelEntry.second.find(&communicator2_) != modelEntry.second.end()) {
foundComm2Before = true;
}
}
EXPECT_TRUE(foundComm1Before) << "Communicator1 should be found in captureResMap_ before CleanCaptureRes";
EXPECT_TRUE(foundComm2Before) << "Communicator2 should be found in captureResMap_ before CleanCaptureRes";
AclgraphCallback::GetInstance().CleanCaptureRes(&communicator1_);
bool foundComm1After = false;
bool foundComm2After = false;
for (const auto &modelEntry : AclgraphCallback::GetInstance().captureResMap_) {
if (modelEntry.second.find(&communicator1_) != modelEntry.second.end()) {
foundComm1After = true;
}
if (modelEntry.second.find(&communicator2_) != modelEntry.second.end()) {
foundComm2After = true;
}
}
EXPECT_FALSE(foundComm1After) << "Communicator1 should NOT be found in captureResMap_ after CleanCaptureRes";
EXPECT_TRUE(foundComm2After) << "Communicator2 should still be found in captureResMap_ after CleanCaptureRes";
GlobalMockObject::verify();
}
TEST_F(AclgraphCallbackTest, ListCommonRemove_NormalNode)
{
ListCommon nodes[3];
for (int i = 0; i < 3; i++) {
ListCommonInit(&nodes[i], &nodes[i]);
}
ListCommonAddHead(&nodes[1], &nodes[1], &nodes[0], &nodes[0]);
ListCommonAddHead(&nodes[2], &nodes[2], &nodes[1], &nodes[1]);
ListCommonRemove(&nodes[1]);
EXPECT_EQ(reinterpret_cast<ListCommon*>(nodes[0].nextHost), &nodes[2]);
EXPECT_EQ(reinterpret_cast<ListCommon*>(nodes[2].preHost), &nodes[0]);
EXPECT_EQ(reinterpret_cast<ListCommon*>(nodes[1].nextHost), &nodes[1]);
EXPECT_EQ(reinterpret_cast<ListCommon*>(nodes[1].preHost), &nodes[1]);
}
TEST_F(AclgraphCallbackTest, ListCommonRemove_Nullptr)
{
ListCommonRemove(nullptr);
}
TEST_F(AclgraphCallbackTest, ListCommonRemove_SelfLoopNode)
{
ListCommon node;
ListCommonInit(&node, &node);
ListCommonRemove(&node);
EXPECT_EQ(reinterpret_cast<ListCommon*>(node.nextHost), &node);
EXPECT_EQ(reinterpret_cast<ListCommon*>(node.preHost), &node);
}
TEST_F(AclgraphCallbackTest, IsZeroCopyAvailable_NonReduceOp)
{
ZeroCopyAclGraph algo;
OpParam opParam;
opParam.aclGraphZeroCopyEnable = 0;
EXPECT_TRUE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_ALLGATHER, opParam));
EXPECT_TRUE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_BROADCAST, opParam));
EXPECT_TRUE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_ALLTOALLV, opParam));
}
TEST_F(AclgraphCallbackTest, IsZeroCopyAvailable_ReduceOp_Enabled)
{
ZeroCopyAclGraph algo;
OpParam opParam;
opParam.aclGraphZeroCopyEnable = 1;
EXPECT_TRUE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_ALLREDUCE, opParam));
EXPECT_TRUE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_REDUCE, opParam));
}
TEST_F(AclgraphCallbackTest, IsZeroCopyAvailable_ReduceOp_Disabled)
{
ZeroCopyAclGraph algo;
OpParam opParam;
opParam.aclGraphZeroCopyEnable = 0;
EXPECT_FALSE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_ALLREDUCE, opParam));
EXPECT_FALSE(algo.IsAclGraphZeroCopyAlgAvailable(HCCL_CMD_REDUCE_SCATTER, opParam));
}
TEST_F(AclgraphCallbackTest, CleanCaptureRes_ModelIdNotFound)
{
HcclResult ret = AclgraphCallback::GetInstance().CleanCaptureRes(999);
EXPECT_EQ(ret, HCCL_E_NOT_FOUND);
}
TEST_F(AclgraphCallbackTest, CleanCaptureRes_ThreePhase_SimplifiedFlow)
{
const u64 modelId = 42;
const std::string tag = "test_tag_Capture";
{
std::lock_guard<std::mutex> lock(AclgraphCallback::GetInstance().resMutex_);
AclgraphCallback::GetInstance().captureResMap_[modelId][&communicator1_].insert(tag);
AclgraphCallback::GetInstance().captureCallbackParamMap_[modelId].modelId = modelId;
}
communicator1_.tagsRequiringHostCleanup_.insert(tag);
HcclResult ret = AclgraphCallback::GetInstance().CleanCaptureRes(modelId);
EXPECT_EQ(ret, HCCL_SUCCESS);
{
std::lock_guard<std::mutex> lock(AclgraphCallback::GetInstance().resMutex_);
EXPECT_TRUE(AclgraphCallback::GetInstance().captureResMap_.empty());
EXPECT_TRUE(AclgraphCallback::GetInstance().captureCallbackParamMap_.empty());
}
EXPECT_EQ(communicator1_.tagsRequiringHostCleanup_.count(tag), 0U);
}
TEST_F(AclgraphCallbackTest, InsertNewTag_CallbackRegistration)
{
MOCKER(GetStreamCaptureInfo)
.stubs()
.will(invoke(GetStreamCaptureInfoMock));
MOCKER(GetModelId)
.stubs()
.will(invoke(GetModelIdMock));
MOCKER(aclmdlRIDestroyRegisterCallback)
.stubs()
.with(mockcpp::any(), mockcpp::any(), mockcpp::any())
.will(returnValue(ACL_SUCCESS));
OpParam opParam;
std::string tag1 = "tag1";
HcclResult ret = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(
&communicator1_, tag1, opParam);
EXPECT_EQ(ret, HCCL_SUCCESS);
bool found = false;
for (const auto &modelEntry : AclgraphCallback::GetInstance().captureResMap_) {
for (const auto &commEntry : modelEntry.second) {
if (commEntry.first == &communicator1_ &&
commEntry.second.find(tag1) != commEntry.second.end()) {
found = true;
}
}
}
EXPECT_TRUE(found);
GlobalMockObject::reset();
}
TEST_F(AclgraphCallbackTest, InsertNewTag_NoDuplicateCallback)
{
MOCKER(GetStreamCaptureInfo)
.stubs()
.will(invoke(GetStreamCaptureInfoMock));
MOCKER(GetModelId)
.stubs()
.will(invoke(GetModelIdMock));
MOCKER(aclmdlRIDestroyRegisterCallback)
.stubs()
.will(returnValue(ACL_SUCCESS));
OpParam opParam;
std::string tag1 = "tag1";
HcclResult ret1 = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(
&communicator1_, tag1, opParam);
EXPECT_EQ(ret1, HCCL_SUCCESS);
std::string tag2 = "tag2";
HcclResult ret2 = AclgraphCallback::GetInstance().InsertNewTagToCaptureResMap(
&communicator1_, tag2, opParam);
EXPECT_EQ(ret2, HCCL_SUCCESS);
bool foundTag1 = false;
bool foundTag2 = false;
for (const auto &modelEntry : AclgraphCallback::GetInstance().captureResMap_) {
for (const auto &commEntry : modelEntry.second) {
if (commEntry.first == &communicator1_) {
if (commEntry.second.find(tag1) != commEntry.second.end()) foundTag1 = true;
if (commEntry.second.find(tag2) != commEntry.second.end()) foundTag2 = true;
}
}
}
EXPECT_TRUE(foundTag1);
EXPECT_TRUE(foundTag2);
GlobalMockObject::reset();
}