| [feat] rename UB protocol enums with backward compatibility Co-authored-by: z00940303<zhangzhuopan@huawei.com> # message auto-generated for no-merge-commit merge: !4370 merge master into master [feat] rename UB protocol enums with backward compatibility Created-by: zhangzhuopan Commit-by: z00940303 Merged-by: cann-robot Description: ## 描述 本次修改统一 UB 协议枚举命名，使协议名称与当前架构定义保持一致： - 新增 COMM_PROTOCOL_UB_CTP = 4，替代原有命名 COMM_PROTOCOL_UBC_CTP。 - 新增 COMM_PROTOCOL_UB_RTP = 9，替代原有命名 COMM_PROTOCOL_UBG。 - 保留旧枚举作为兼容别名： - COMM_PROTOCOL_UBC_CTP = COMM_PROTOCOL_UB_CTP - COMM_PROTOCOL_UBG = COMM_PROTOCOL_UB_RTP - 枚举数值保持不变，确保已有调用方的源码兼容性和接口 ABI 不受影响。 - 将 Endpoint、Channel、通信域资源管理、拓扑转换、NIC Plugin 等代码中的协议判断和日志统一为新名称。 - 在 AIV/AICPU 通信路径中补充并保留 UB_RTP 处理： - AIV + UB_RTP 使用 AivUrmaChannel。 - AICPU/AICPU_TS + UB_RTP 使用 AicpuTsUbgChannel。 - 支持 UB_RTP 的 Device ChannelEntity 创建、预分配及 Device Handle 转换。 - 更新相关中英文接口文档和通信算子开发文档，将旧协议名称替换为新协议名称。 ## 变更类型 请选择本次引入的变更类型： - [ ] 🐛 Bug修复 - [x] ✨ 新特性 - [ ] 🚀 性能优化 - [x] 📝 文档更新 - [ ] 📋 其他，请描述： ## 关联的Issue NA ## 测试 已完成的测试用例和场景： 1. 检查 COMM_PROTOCOL_UB_CTP 和 COMM_PROTOCOL_UB_RTP 在 Endpoint、Channel 创建、资源转换及拓扑映射等路径中的处理逻辑。 2. 检查 AIV/AICPU 场景下 UB_RTP Channel 创建及 Device ChannelEntity 转换流程，确认主线已有的 AIV 直驱 URMA 适配未在冲突解决过程中丢失。 3. 执行代码静态检查，确认无残留冲突标记，git diff --check 检查通过。 补充的UT用例： - 补充新旧协议枚举兼容性校验： - COMM_PROTOCOL_UBC_CTP == COMM_PROTOCOL_UB_CTP - COMM_PROTOCOL_UBG == COMM_PROTOCOL_UB_RTP - 更新 Endpoint、协议转换、NIC Plugin 等相关 UT，使其使用新的 UB_CTP、UB_RTP 协议名称。 已通过 A3、A5 RDV用例 ## 文档更新 更新了以下文档中的协议名称及说明： - CommProtocol 数据类型定义文档。 - HcommChannelCreate、HcommEndpointCreate 和 HcclChannelAcquire 接口文档。 - Hcomm Read、Write、Fence 等通信操作接口文档。 - CCU 通信算子开发指南及快速入门文档。 - NIC Plugin 中英文 README。 文档中将 UBC_CTP、UBG 分别更新为 UB_CTP、UB_RTP，同时保留旧枚举名称的兼容性说明。 ## 合入检查 <!-- 在正式合入前，请做好必要的代码测试，用例补充，软件代码风格检查等。提高合入效率。--> <!-- [x] 表示选中 --> - [ ] 🧐 已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 - [ ] 🔍 邀请 committer评论/lgtm前的必要检查 - [ ] 🏷️ 标题中使用了合适的类型标签（如：[feat], [fix]） - [ ] 📄 代码修改内容已简要描述，相关文档已更新 - [ ] 📝 代码注释已更新，代码遵循项目整体代码风格 - [ ] 🧪 代码UT测试已更新，覆盖率已达标 - [ ] 🔬 验证方法已更新到"测试"部分 - [ ] 🛠️ 代码已通过静态分析工具检查，无错误 - [ ] 👥 代码检视/code review/同行评议和必要的代码串讲，确保代码质量 - [ ] ✅ 代码检视意见已处理或答复，无未处理的检视意见 - [ ] 🚀 预约 前冒烟 用例前的必要检查 - [ ] ✔️ 代码已有committer的/lgtm 和 模块committer的/lgtm评论 - [ ] 🔧 代码已通过compile，编译无错误，无告警 - [ ] 🖥️ 代码已通过基本功能本地测试或者在线测试，确保基本功能正常 - [ ] 🎯 预约 approver评论/approve，正式合入前的必要检查 - [ ] 📊 前冒烟 用例已全量通过 - [ ] 📦 新增功能已同步补充基本功能测试用例到前冒烟里 See merge request: cann/hcomm!4370 | 1 个月前 |
