Line data    Source code

       1              : /**
       2              :  * Copyright (c) 2025 Huawei Technologies Co., Ltd.
       3              :  * This program is free software, you can redistribute it and/or modify it under the terms and conditions of
       4              :  * CANN Open Software License Agreement Version 2.0 (the "License").
       5              :  * Please refer to the License for details. You may not use this file except in compliance with the License.
       6              :  * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
       7              :  * INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
       8              :  * See LICENSE in the root of the software repository for the full text of the License.
       9              :  */
      10              : 
      11              : #ifndef HCCLV2_INS_TEMP_SCATTER_MESH_1D
      12              : #define HCCLV2_INS_TEMP_SCATTER_MESH_1D
      13              : 
      14              : #include "string_util.h"
      15              : 
      16              : #include "ins_alg_template_base.h"
      17              : #include "executor_utils.h"
      18              : 
      19              : namespace Hccl {
      20              : 
      21              : class InsTempScatterMesh1D : public InsAlgTemplateBase {
      22              : public:
      23              :     explicit InsTempScatterMesh1D(
      24              :         const RankId virtualRank, const u32 tempRankSize, const std::vector<std::vector<RankId>>& tempVTopo,
      25              :         const std::map<RankId, u32>& tempVirtRankMap);
      26              :     ~InsTempScatterMesh1D() override;
      27              : 
      28            0 :     std::string Describe() const override
      29              :     {
      30            0 :         return StringFormat("Instruction based Template of scatter mesh with tempRankSize [%u].", tempRankSize_);
      31              :     }
      32              : 
      33              :     HcclResult GenExtIns(
      34              :         TempFuncs& tempFuncs, TemplateDataParams& tempAlgParams, ResLinks& tempResLinks,
      35              :         std::vector<InsQuePtr>& tempInsQues);
      36              :     u32 CalcScratchMultiple(BufferType inBuffType, BufferType outBuffType);
      37              :     HcclResult CalcRes(AlgTempResReq& tempResReq) override;
      38              :     uint64_t GetExpandedMode() const;
      39              : 
      40              : private:
      41              :     HcclResult RunMesh(TemplateDataParams& tempAlgParams, ResLinks& tempResLinks, std::vector<InsQuePtr>& tempInsQues);
      42              :     HcclResult RunMeshTx(
      43              :         u32 myAlgRank, u32 repeatTimes, const TemplateDataParams& tempAlgParams, ResLinks& tempResLinks,
      44              :         std::vector<InsQuePtr>& tempInsQues);
      45              :     HcclResult RunMeshRx(
      46              :         u32 myAlgRank, u32 repeatTimes, const TemplateDataParams& tempAlgParams, ResLinks& tempResLinks,
      47              :         std::vector<InsQuePtr>& tempInsQues);
      48              :     HcclResult PreCopy(TemplateDataParams& tempAlgParams, std::vector<InsQuePtr>& tempInsQues);
      49              :     HcclResult PostCopy(const TemplateDataParams& tempAlgParams, std::vector<InsQuePtr>& tempInsQues);
      50              :     u32 majorQueNum_ = 0;
      51              :     u32 queNumPerNeighbor_ = 1;
      52              :     bool enableInterRankCounterNotify_ = false;
      53              :     bool isZeroCopy_ = false;
      54              : };
      55              : 
      56              : } // namespace Hccl
      57              : 
      58              : #endif // !HCCLV2_INS_TEMP_SCATTER_MESH