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 CCU_DEVICE_PUB_H
12 : #define CCU_DEVICE_PUB_H
13 :
14 : #include <memory>
15 : #include <vector>
16 : #include <cstdint>
17 :
18 : #include "ccu_common.h"
19 : #include "ccu_device_res.h"
20 : #include "ccu_res_repo.h"
21 : #include "ccu_drv_handle.h"
22 :
23 : #include "hccl_types.h"
24 : #include "enum_factory.h"
25 : #include "hccl_rank_graph.h"
26 :
27 : // 支持新老通信域混跑，引入legacy数据结构
28 : #include "unified_platform/pub_inc/ccu/ccu_dev_mgr.h"
29 : #include "dev_type.h"
30 :
31 : namespace hcomm {
32 :
33 : // CcuAllocResHandleByResDescs 仅以 const CcuResDesc* 形式使用，前向声明即可，
34 : // 避免此处包含 ccu_res_desc.h（其会引入 ccu_dev_mgr_imp.h，造成循环包含）。
35 : class CcuResDesc;
36 :
37 : using CcuResHandle = void *;
38 :
39 : // 不复用legacy数据结构，对上层支持CommAddr，不使用Hccl::IpAddress
40 : struct CcuChannelPara {
41 : CommAddr commAddr{};
42 : uint32_t channelNum{0};
43 : uint32_t jettyNum{0};
44 : uint32_t sqSize{0};
45 :
46 : CcuChannelPara() = default;
47 15 : CcuChannelPara(const CommAddr &address, const uint32_t channelNum,
48 : const uint32_t jettyNum, const uint32_t sqSize)
49 15 : : commAddr(address), channelNum(channelNum), jettyNum(jettyNum), sqSize(sqSize) {
50 15 : }
51 : };
52 :
53 : using CcuJettyType = Hccl::CcuJettyType;
54 : /* 开源自定义算子CCU设备管理实现，当前支持新老通信域混跑，
55 : * 暂时改用legacy数据结构，避免反向依赖
56 : * MAKE_ENUM(CcuJettyType, CCUM_CACHED_JETTY, TA_CACHED_JETTY, INVALID_JETTY);
57 : */
58 :
59 : using CcuJettyInfo = Hccl::CcuJettyInfo;
60 : /* 开源自定义算子CCU设备管理实现，当前支持新老通信域混跑，
61 : * 暂时改用legacy数据结构，避免反向依赖
62 : * struct CcuJettyInfo {
63 : * CcuJettyType jettyType{CcuJettyType::INVALID_JETTY};
64 : * uint16_t jettyCtxId{0};
65 : * uint16_t taJettyId{0};
66 :
67 : * uint32_t sqDepth{0};
68 : * uint32_t wqeBBStartId{0};
69 :
70 : * uint64_t sqBufVa{0};
71 : * uint32_t sqBufSize{0};
72 : * };
73 : */
74 :
75 : using CcuChannelInfo = Hccl::CcuChannelInfo;
76 : /* 开源自定义算子CCU设备管理实现，当前支持新老通信域混跑，
77 : * 暂时改用legacy数据结构，避免反向依赖
78 : * struct CcuChannelInfo {
79 : * uint32_t channelId{0};
80 : * uint8_t dieId{0};
81 : * std::vector<CcuJettyInfo> jettyInfos;
82 : * };
83 : */
84 :
85 : /**
86 : * @brief 启用CCU特性，初始化CCU平台层
87 : *
88 : * @param deviceLogicId 设备逻辑ID
89 : * @param ccuDrvHandle CCU驱动句柄
90 : * @return HcclResult 返回HcclResult类型的结果
91 : * @note 资源不足时返回HCCL_E_UNAVIL，其余非HCCL_SUCCESS结果属于错误
92 : */
93 : CcuResult CcuInitFeature(const int32_t devLogicId, std::shared_ptr<CcuDrvHandle> &ccuDrvHandle);
94 :
95 : /**
96 : * @brief 关闭CCU特性，解初始化CCU平台层
97 : *
98 : * @param deviceLogicId 设备逻辑ID
99 : * @return HcclResult 返回HcclResult类型的结果
100 : * @note 资源不足时返回HCCL_E_UNAVIL，其余非HCCL_SUCCESS结果属于错误
101 : */
102 : CcuResult CcuDeinitFeature(const int32_t devLogicId);
103 :
104 : /**
105 : * @brief 获取指定die是否启用
106 : *
107 : * @param deviceLogicId device逻辑ID
108 : * @param dieId ccu channel 所属的 IO Die 编号
109 : * @param enableFlag 出参，表示该die是否启用
110 : * @return HcclResult 返回HcclResult类型的结果
111 : * @note dieId越界时返回HCCL_E_PARA
112 : */
113 : CcuResult CcuGetDieEnableInfo(int32_t deviceLogicId, uint8_t dieId, bool &enableFlag);
114 :
115 : /**
116 : * @brief 查询指定 ioDie 上各类资源总量，按block分的资源类型（LoopEngine、Ms、Cke）查询的是可以分配的总量（块大小*块总数）
117 : *
118 : * @param deviceLogicId 设备逻辑ID
119 : * @param dieId ioDie ID
120 : * @param num 出参，返回该 die 上对应资源类型的总量
121 : * @return CcuResult
122 : * @note dieId 越界或 die 未启用时返回错误
123 : */
124 : CcuResult CcuGetLoopEngineNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
125 : CcuResult CcuGetMsNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
126 : CcuResult CcuGetCkeNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
127 : CcuResult CcuGetXnNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
128 : CcuResult CcuGetGsaNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
129 : CcuResult CcuGetInstructionNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
130 : CcuResult CcuGetMissionNum(int32_t deviceLogicId, uint8_t dieId, uint32_t &num);
131 :
132 : /**
133 : * @brief 获取指定device的主板类型
134 : *
135 : * @param deviceLogicId device逻辑ID
136 : * @param hcclMainboardId 出参，返回该device的主板类型
137 : * @return HcclResult 返回HcclResult类型的结果
138 : */
139 : HcclResult CcuGetMainboardType(uint32_t deviceLogicId, Hccl::HcclMainboardId &hcclMainboardId);
140 :
141 : /**
142 : * @brief 基于资源描述符数组申请批量资源
143 : *
144 : * @param deviceLogicId 设备逻辑ID
145 : * @param descs 资源描述符指针数组（每个描述符携带 dieId 及各资源数量）
146 : * @param descNum 资源描述符数量
147 : * @param resHandle 返回的CCU批量资源句柄
148 : * @return HcclResult 返回HcclResult类型的结果
149 : * @note 资源不足时返回HCCL_E_UNAVIL，其余非HCCL_SUCCESS结果属于错误
150 : */
151 : CcuResult CcuAllocResHandleByResDescs(int32_t deviceLogicId,
152 : const CcuResDesc *descs[], uint32_t descNum, CcuResHandle &resHandle);
153 :
154 : /**
155 : * @brief 按加速引擎模式申请批量资源
156 : *
157 : * @param deviceLogicId 设备逻辑ID
158 : * @param ccuEngine CCU通信引擎类型
159 : * @param resHandle 返回的CCU批量资源句柄
160 : * @return HcclResult 返回HcclResult类型的结果
161 : * @note 资源不足时返回HCCL_E_UNAVIL，其余非HCCL_SUCCESS结果属于错误
162 : */
163 : CcuResult CcuAllocResHandleByInsType(int32_t deviceLogicId,
164 : CcuInstanceType ccuInsType, CcuResHandle &resHandle);
165 :
166 : /**
167 : * @brief 根据资源句柄查看对应资源信息
168 : *
169 : * @param deviceLogicId 设备逻辑ID
170 : * @param resHandle 查询的CCU批量资源句柄
171 : * @param resRepo 返回的CCU批量资源信息
172 : * @return HcclResult 返回HcclResult类型的结果
173 : * @note 资源句柄无法查找到时返回HCCL_E_NOT_FOUND，其余非HCCL_SUCCESS结果属于错误
174 : */
175 : CcuResult CcuCheckResource(const int32_t deviceLogicId,
176 : const CcuResHandle resHandle, CcuResRepository &resRepo);
177 :
178 : /**
179 : * @brief 根据资源句柄释放对应资源信息
180 : *
181 : * @param deviceLogicId 设备逻辑ID
182 : * @param resHandle 查询的CCU批量资源句柄
183 : * @note 资源句柄无法查找到时返回HCCL_E_NOT_FOUND，其余非HCCL_SUCCESS结果属于错误
184 : * @note 返回批量的channel资源总数可能超过申请数量，jettyNum为0时由平台层决定分配数量
185 : */
186 : HcclResult CcuReleaseResHandle(const int32_t deviceLogicId, const CcuResHandle handle);
187 :
188 : /**
189 : * @brief 申请批量ccu channel资源
190 : *
191 : * @param deviceLogicId device逻辑ID
192 : * @param ccuChannelPara ccu channel 申请参数
193 : * @param ccuChannelInfos 返回的channel资源信息
194 : * @return HcclResult 返回HcclResult类型的结果
195 : * @note 返回批量的channel资源总数可能超过申请数量，jettyNum为0时由平台层决定分配数量
196 : */
197 : HcclResult CcuAllocChannels(const int32_t deviceLogicId, const CcuChannelPara &ccuChannelPara,
198 : std::vector<CcuChannelInfo> &ccuChannelInfos);
199 :
200 : /**
201 : * @brief 释放ccu channel资源
202 : *
203 : * @param deviceLogicId device逻辑ID
204 : * @param dieId ccu channel 所属的 IO Die 编号
205 : * @param ccuChannelId ccu channel 编号
206 : * @return HcclResult 返回HcclResult类型的结果
207 : * @note 无
208 : */
209 : HcclResult CcuReleaseChannel(const int32_t deviceLogicId, const uint8_t dieId, const uint32_t ccuChannelId);
210 :
211 : /**
212 : * @brief 查询CCU设备是否已完成初始化
213 : *
214 : * @param deviceLogicId 设备逻辑ID
215 : * @return bool true表示已初始化，false表示未初始化或入参非法
216 : * @note 无
217 : */
218 : bool CcuIsInited(const int32_t deviceLogicId);
219 :
220 : /**
221 : * @brief 触发CCU Task Kill
222 : *
223 : * @param deviceLogicId device逻辑ID
224 : * @return HcclResult 返回HcclResult类型的结果
225 : * @note 该接口会处理全部die，未启用die将跳过
226 : */
227 : HcclResult CcuSetTaskKill(const int32_t deviceLogicId);
228 :
229 : /**
230 : * @brief 配置CCU Task Kill完成状态
231 : *
232 : * @param deviceLogicId device逻辑ID
233 : * @return HcclResult 返回HcclResult类型的结果
234 : * @note 该接口会处理全部die，未启用die将跳过
235 : */
236 : HcclResult CcuSetTaskKillDone(const int32_t deviceLogicId);
237 :
238 : /**
239 : * @brief 清空CCU Task Kill状态
240 : *
241 : * @param deviceLogicId device逻辑ID
242 : * @return HcclResult 返回HcclResult类型的结果
243 : * @note 该接口会处理全部die，未启用die将跳过
244 : */
245 : HcclResult CcuCleanTaskKillState(const int32_t deviceLogicId);
246 :
247 : /**
248 : * @brief 清理指定ioDie CCU的全部CKE资源，重置为0
249 : *
250 : * @param deviceLogicId device逻辑ID
251 : * @return HcclResult 返回HcclResult类型的结果
252 : * @note 未启用die无需清理将视为成功
253 : */
254 : HcclResult CcuCleanDieCkes(const int32_t deviceLogicId, const uint8_t dieId);
255 :
256 : }; // namespace hcomm
257 : #endif // CCU_DEVICE_PUB_H
|
