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 HCCL_ALG_ENV_CONFIG_H
      12              : #define HCCL_ALG_ENV_CONFIG_H
      13              : 
      14              : #include <vector>
      15              : #include <map>
      16              : #include <hccl/hccl_types.h>
      17              : #include "hccl/base.h"
      18              : #include "common.h"
      19              : 
      20              : /*************** For Internal Use ***************/
      21              : struct AlgEnvConfig {
      22              :     // 初始化标识
      23              :     bool initialized;
      24              : 
      25              :     std::map<HcclCMDType, std::vector<HcclAlgoType>> hcclAlgoConfig;
      26              : 
      27        18106 :     AlgEnvConfig() { SetDefaultParams(); }
      28        18106 :     void SetDefaultParams()
      29              :     {
      30        18106 :         initialized = false;
      31              :         // 环境变量参数
      32      1901130 :         for (u32 opType = 0; opType < static_cast<u32>(HcclCMDType::HCCL_CMD_MAX); opType++) {
      33      1924000 :             hcclAlgoConfig[static_cast<HcclCMDType>(opType)]
      34      3766048 :                 = std::vector<HcclAlgoType>(HCCL_ALGO_LEVEL_NUM, HcclAlgoType::HCCL_ALGO_TYPE_DEFAULT);
      35              :         }
      36        18106 :     }
      37              : };
      38              : 
      39              : static AlgEnvConfig g_algEnvConfig;
      40              : 
      41              : const std::map<HcclAlgoType, std::string> HcclAlgoTypeMap = {
      42              :     {HcclAlgoType::HCCL_ALGO_TYPE_DEFAULT, "default"},
      43              :     {HcclAlgoType::HCCL_ALGO_TYPE_RING, "ring"},
      44              :     {HcclAlgoType::HCCL_ALGO_TYPE_PIPELINE, "pipeline"},
      45              :     {HcclAlgoType::HCCL_ALGO_TYPE_FULLMESH, "fullmesh"},
      46              :     {HcclAlgoType::HCCL_ALGO_TYPE_HDR, "H-D_R"},
      47              :     {HcclAlgoType::HCCL_ALGO_TYPE_PAIRWISE, "pairwise"},
      48              :     {HcclAlgoType::HCCL_ALGO_TYPE_NHR, "NHR"},
      49              :     {HcclAlgoType::HCCL_ALGO_TYPE_NHR_V1, "NHR_V1"},
      50              :     {HcclAlgoType::HCCL_ALGO_TYPE_AHC, "AHC"},
      51              :     {HcclAlgoType::HCCL_ALGO_TYPE_AHC_BROKE, "AHC_BROKE"},
      52              :     {HcclAlgoType::HCCL_ALGO_TYPE_NB, "NB"},
      53              :     {HcclAlgoType::HCCL_ALGO_TYPE_NULL, "null"},
      54              :     {HcclAlgoType::HCCL_ALGO_TYPE_NA, "NA"},
      55              : };
      56              : 
      57              : HcclResult ResetAlgEnvConfigInitState();
      58              : 
      59              : const std::vector<HcclAlgoType> GetExternalInputHcclAlgoConfig(HcclCMDType opType = HcclCMDType::HCCL_CMD_ALL);
      60              : 
      61              : HcclResult SetCommonAlgType(std::vector<std::string>& algos);
      62              : 
      63              : HcclResult SetSpecificAlgType(std::vector<std::string>& algos);
      64              : 
      65              : HcclResult ParserHcclAlgoLevel(const std::string& algoLevel, u32& level, HcclAlgoType& algoType);
      66              : 
      67              : HcclResult ParseAlgoString(std::string opName, std::string& algoString, std::vector<HcclAlgoType>& algType);
      68              : 
      69              : HcclResult SplitHcclOpType(const std::string& algoConfig, std::vector<std::string>& algos);
      70              : 
      71              : HcclResult CheckAlgoConfigValid(std::vector<std::string>& algos, bool& anyCommonConfig, bool& anySpecificConfig);
      72              : 
      73              : HcclResult SplitHcclAlgoLevel(const std::string& algoConfig, std::vector<std::string>& algos);
      74              : 
      75              : s32 GetInternalExecTimeOut();
      76              : #endif // HCCL_ALG_ENV_CONFIG_H