Closed
[Documentation|文档反馈]: build.md记载的--valgrind参数在build.sh中不存在,按文档操作必然失败 #6536
liuhanwen8Add on  Oct 12Closed at  9 days ago
liuhanwen8
liuhanwen8
Oct 12 Create

Document Link(文档链接)

https://gitcode.com/cann/ops-nn/blob/master/docs/zh/install/build.md#L55

Issues Section(问题文档片段)

build.md:55 参数表行:

| --valgrind | 可选 | 使用valgrind运行单元测试进行内存检测(需配合-u使用),启用后会禁用ASAN和--noexec。 |

Existing Issues(存在的问题)

文档记载的 --valgrind 参数在 build.sh 中无解析通路,按文档执行 bash build.sh --valgrind -u 必然失败(当前 master 可达,已实测复现):

  1. SUPPORTED_LONG_OPTS 白名单(build.sh:28-34,共43项)不含 valgrind,脚本自身的 --help 也未列出该参数;
  2. check_option_validity() 对白名单外的长选项报 Invalid long option 并返回失败(build.sh:119),参数校验调用点(build.sh:770-778)随即 usage; exit 1,编译不会启动;
  3. 已排除其它消费路径:-v 映射为 VERBOSE=1(build.sh:855);install_deps.sh 不解析该参数;- 开头的未知参数不会透传给 cmake。

实测复现(master @ f247ec2f):输出 [ERROR] Invalid long option: --valgrind,打印 usage 后以 exit 1 退出。

补充:build.sh:714 初始化 ENABLE_VALGRIND=FALSE,build.sh:1070 将其传给 cmake,tests/ut 下多个 CMakeLists 在 TRUE 时以 valgrind 执行 UT,cmake 侧能力链完整、仅缺 CLI 入口。建议在白名单与 case 分支补入 valgrind(含与 --asan/--noexec 的互斥逻辑);若该能力已下线,则删除 build.md:55 对应行。

likedislike
liuhanwen8liuhanwen8
Oct 12 Added label: documentation
yuning_chen
yuning_chenCollaborators
Oct 12 Comments:

初步分析

感谢反馈,我们已开始核对这个问题。

现象理解:build.md 写了可选参数 --valgrind,但 build.sh 的长选项白名单里可能没有它,按文档执行会报无效参数并退出。
当前判断:初步判断,待复现确认。文档和脚本入口不一致的可能性存在;cmake 侧是否已有 valgrind 开关,需对照当前脚本核实。
涉及范围:docs/zh/install/build.md 与 build.sh 的参数解析。
下一步:我们会核对白名单和帮助信息,评估补上该参数或从文档删除。

likedislike
yuning_chenyuning_chenCollaborators
Oct 12 Assign cong-jiyu as responsible person
yuning_chen
yuning_chenCollaborators
Oct 12 Comments:

您好,问题已收到,当前 @cong-jiyu 正在处理中。

likedislike
chenjiayi_
chenjiayi_Collaborators
9 days ago Comments:

补充当前 master 的核对结果(2026-11-12):

  • docs/zh/install/build.md:55 当前列出 --valgrind 参数。
  • build.sh 的 SUPPORTED_LONG_OPTS(:28 起)当前包含 43 项,valgrind 可作为下一项补入;ENABLE_VALGRIND 在 build.sh:714 初始化、:1070 传给 cmake,cmake 侧能力链完整。
  • 当前执行 bash build.sh --valgrind -u 会在参数校验阶段报 Invalid long option 并退出。

建议:在 SUPPORTED_LONG_OPTS 与 case 分支补入 valgrind,并补上与 --asan、--noexec 的互斥处理;同步更新 --help。若该能力计划下线,则删除 build.md:55 对应行。

likedislike
CANN-robotCANN-robotCollaborators
9 days ago Close issue
CANN-robotCANN-robotCollaborators
9 days ago changed custom state from 进行中 to 已完成
CANN-robotCANN-robotCollaborators
9 days ago Added label: resolved
chenjiayi_chenjiayi_Collaborators
9 days ago Assign chenjiayi_ as responsible person
chenjiayi_
chenjiayi_Collaborators
4 days ago Comments:

补充说明本问题的后续处理:

--valgrind 已补齐到构建脚本,按文档执行该参数可以进入 valgrind UT 流程。

处理结果:

  • build.sh 的 SUPPORTED_LONG_OPTS 加入 valgrind(:30),checkopts() 将 ENABLE_VALGRIND 置 TRUE 并关闭默认 UT 直接执行(:935-937);check_param() 在 --valgrind 与 --asan 同时出现时自动关闭 ASAN(:502-504);usage() 补充参数说明(:396)。
  • tests/ut/op_host/CMakeLists.txt:164、tests/ut/op_graph/CMakeLists.txt:132 等路径在 ENABLE_VALGRIND=TRUE 时以 valgrind 执行 UT。
  • PR:!14047。

验证:

  • 基于 master 源码核对参数解析与 CMake 分支;PR !14047 描述记录“本地编译成功”。
  • 本环境以源码核对为主,未执行完整 valgrind UT。

说明:docs/zh/install/build.md:55 仍写“启用后会禁用ASAN和--noexec”,脚本实际行为是关闭 ASAN 并关闭 UT 直接执行(效果等同 --noexec),该句措辞可在后续文档整改中顺手对齐。

如果还有后续需要,请重新提 issue。

MR 链接:https://gitcode.com/cann/ops-nn/pull/14047

likedislike
chenjiayi_chenjiayi_Collaborators
12 hours ago Removed responsible person chenjiayi_