Files
STM32F4-Base/docs/门禁说明/cubemx-survival.md
T
wandering1 4a4ad6bc5f chore(全仓): @build/@test 旧文档别名清退为技能调用名
现状口径:/keil-build 与 /serial-boot-test 是 DSH 会话的技能调用名,
不是 shell 命令;「名 + 命令行参数」的命令形态改为可执行体
run_boot_test.py 的真实调用。

- AGENTS.md:别名说明重写为「技能调用名不是 shell 命令」,两条目改
  「编译(/keil-build)」「串口回归(/serial-boot-test)」
- keil-build / serial-boot-test 两 skill 调用名与示例同步;task-worktree
  方案文档去掉 @build/@test 惯例从句;@task 保留(不在点名范围)
- 123 文件现状陈述全改;台架捕获、变更记录/时间线、rename 映射输入
  等 41 行历史证据保留旧名
- gen_memory_svg.py 6 处措辞随改,3 张 SVG 产物同批重跑
- 顺手补并行方案同行漏网计数 51→52 钩子

验证:提交期快钩子对 123 文件实跑全 Passed;check_doc_links --all
rc=0(3038 处、无法判定 0);check_mermaid --all rc=0;YAML 解析 52
钩子不变;skill-size rc=0;py_compile 全过;字节卫生零漂移。
2026-10-30 13:03:12 +08:00

5.9 KiB
Raw Blame History

cubemx-survival — CubeMX 重生成的定制存活审计 + 漂移检测

一句话:CubeMX 重生成会静默覆盖 USER CODE 标记区之外的一切定制,而且多数不报编译错, 只在真出故障时才暴露。这一门把"易失清单 + 关键位置哈希"钉成基线,重生成后一眼看出被改了什么。

  • 配置:entry: python scripts/check_cubemx_survival.py --check、pass_filenames: false、 files: 覆盖 .ioc、Src/**、Inc/**。方法论:docs/子系统设计/看门狗设计说明.md §10.2 与 §10.3。

1. 它在查什么

  1. 存活审计:逐项检查"重生成易失清单"里的定制是否仍在预期位置(清单以 must_contain 等 断言表达),标记区外的存量给出显式警告;
  2. 漂移检测:把关键位置哈希写进 .cubemx_survival_baseline.json,--check 逐项比对, 任一项变化即 FAIL。
  • 清单项共 16 项:IWDG 延后启动、崩溃采集 ×2、栈溢出检测、堆失败钩子、断言改造 ×2、看门狗模块 与工程挂载、复位原因锁存、HAL 驱动与使能宏、.ioc 关键项 ×3 等(清单本体在脚本里)。
  • 触发面还包括 App/util/task_watchdog.* 与 MDK-ARM/*.uvprojx(后者只跑 must_contain,见 §3)。
  • 防误报实现:断言之前先剥掉 C 注释——本仓多处注释刻意引用被替换掉的历史代码(例如 "原为 HAL_IWDG_Init(&hiwdg) 直呼"),不过滤就会恒定误报。

2. 为什么要它

  • 实测记录:.ioc 里 ProjectManager.KeepUserCode=true 只保护 USER CODE BEGIN/END 之间; 2026-09-29 一次重生成覆盖了 4 处定制(P0×1 + P1×2 + P2×1)。典型形态:崩溃采集函数被打回 空 while(1)、加固宏被整块删除——不报错,只在真崩的时候才发现没日志。

  • AGENTS 把防丢失排成三层(写进 .ioc → 搬进 USER CODE 区 → 本门当审计兜底)。

  • 那一次被覆盖的具体内容:HardFault_Handler 的崩溃采集被打回空 while(1)、两个 FreeRTOS 加固宏被整块删除——两处都不报编译错,只在真出故障时才暴露。

3. 触发面 / 看不见什么

  • MDK-ARM/*.uvprojx 不参与漂移检测(no_baseline=True):该文件每次 /keil-build 后都被 UV4 自动改写(XML 归一化 + PackID 降到本机 DFP 版本),参与检测等于每次构建后提交都被拦; 对本项只保留 must_contain 断言("源文件仍挂载")。
  • 只查清单里列了的东西:没写进清单的新定制 = 不受保护(这是清单式门禁的固有代价)。

4. 报错怎么读

CubeMX 重生成存活审计.......Failed
  [FAIL] Src/main.c 缺少定制片段断言: fault_handler_enable
  • 单独跑:--report 只看审计报告(不比对基线);确认改动无误后 --write 重建基线。
  • 正确动作:先把定制搬回正确位置(优先写进 .ioc 与搬进 USER CODE 区),再 --write;直接 --write 等于宣布 "被覆盖掉的样子是新的正确答案"。
  • 每次重生成后立刻跑(AGENTS 铁律),别等到提交时才发现。

5. 好处

  • 把"重生成到底动了什么"从人肉 diff 变成一条命令的 FAIL 清单;
  • 基线是位置哈希而不是内容全文,重排注释不炸、删掉定制必炸。

6. 限制与盲区

  1. 清单驱动:只保护登记过的定制。新写的标记区外定制不在清单里 → 静默丢失且不会报。
  2. 标记区内的内容不受本门保护(CubeMX 不动它,但如果我们自己写错,它也不判对错)。
  3. 不检测 .ioc 配置项与生成结果是否自洽(比如某个外设被关掉,它不会告诉你)。
  4. uvprojx 无漂移检测(见 §3)→ 工程文件里被 UV4 抹掉的东西照不出;那条只能靠"改动不入库"的约定。
  5. 基线文件是 .cubemx_survival_baseline.json(仓库根):它若被顺手 --write,门禁当场失效且看不出来。 --write 必须与"确认过的改动"写在同一个提交里并说明。
  6. 它不判断定制是否仍然正确,只判断"还在不在原来的位置"。
  7. 基线漏项 = 静默不检(2026-10-25 实证):--check 只比对基线里已登记的条目——一条定制 若从未进过基线,检查面再全也不会报它。专项文档(原 docs/任务规划/测试与架构专项.md,已删除 2026-10-28)那次返工时 --write 顺带补出了原本缺失的 net-msgq-adopt(Src/freertos.c RTOS_QUEUES 区须含 net_msg_queue_adopt),该条目此前 处于"不存在于基线 → 永不检查"态。新增标记区外定制时,登记必须与代码同提交(同 §5 的 --write 同提交纪律),收口时值得跑一次"--write 后看 diff 有没有新增条目"的抽查。
  • 标记区外的存量只给 WARN(本仓现存:Src/stm32f4xx_it.c 的 3 个 Fault 处理函数、 Src/freertos.c 的栈注释)——CubeMX 不保护它们,只能人工盯。
  • 原手册在这里建议"仿照 HardFault_Handler 自造 USER CODE 标记区"把它们升级成受保护内容; ⚠ 而 docs/子系统设计/看门狗设计说明.md §10 记的实测教训是自造标记区会被模板换代抹掉。 两条不打架但优先级不同:能落 .ioc 或官方标记区,就别自造标记。

7. 豁免与基线

  • 基线 = .cubemx_survival_baseline.json,语义与 bsp-err/layer-deps 的"只减不增"相反: 它是"确认后的快照",允许被 --write 前滚。因此它防的是意外,不防"有意改掉"。

8. 改这个门禁本身

  • 新增受保护项:先想能不能落到 USER CODE 区或 .ioc——清单越长,人工维护越重;
  • 自造标记区(自定义 BEGIN/END 名字)会被官方模板换代抹掉,别拿它当保护手段。