接手遗留嵌入式代码的步骤

直接回答: 接手旧固件,先把现有资料保全,让构建可复现,然后在台架设备上复现现场报告的故障。做到这两步之后,才梳理代码、写下风险,从收益高又安全的问题开始修。只有证据表明旧结构不断制造新故障时,才考虑重写。

旧固件接手流程图,分五个阶段:保全资料、可复现构建、复现故障、梳理评估、修复发布。评估之后有一个决策点,在定点修复和局部重写之间选择;每个阶段都有书面产出。
图 1 接手的各阶段及产出。修还是重写,在评估之后决定,不在之前。

1.0 常见的起点

典型的接手场景:原来的开发者或供应商已经不在,源码在某个压缩包里,或者一部分在某人的笔记本上;构建只能在一台机器上跑,工具链是谁装的没人记得。设备在现场,问题报告不断:重启、死机、某个功能换了某款手机就失灵。所有人都希望赶紧修好。

这时最容易直接读代码、打补丁。可没有可复现的构建、没有复现的故障,补丁很可能打错了原因,发到现场后在原故障旁边再添一个新故障。

2.0 第 1 阶段:保全资料

趁还拿得到,全部收集起来:

资料为什么重要
源码,所有分支和压缩包显而易见;多找几份副本并比对
工具链安装包及确切版本编译器版本不同,生成的代码和时序都会变
构建脚本、IDE 工程文件、链接脚本带着源码里没有的优化选项、内存布局和宏定义
现场正在跑的固件及其版本用来证明哪份源码对应哪批设备
Bootloader 源码和密钥(如果有)没有它们可能无法升级设备
烧录工具和产线流程生产新设备要用
各版本硬件设计文件固件常有针对板子版本的行为
问题报告、现场日志、客户邮件故障证据

源码还没进版本库的,马上放进去,把原始压缩包原封不动作为第一次提交。签名密钥和凭据放进专门的密钥存储,不进仓库。

趁人还联系得上,和做过这个产品的人聊一聊:原开发者、产线、售后。和原开发者聊一小时,可能就讲清了某个构建怪癖或现场绕行办法,光看代码可能要花几天才能重新弄明白。谈话要点写下来,和仓库放在一起。

3.0 第 2 阶段:让构建可复现

目标是从源码编出和现场一模一样的固件,或者把每处差异解释清楚。

  1. 在容器或有文档的虚拟机里重建工具链,版本锁死。
  2. 编译后与现场固件比对。嵌入的构建时间戳或路径不同是正常的,代码不同就不正常。
  3. 对不上,就找能对上的那个源码版本。如果没有任何版本能对上,把这一点记为发现:现场固件里可能有从没提交过的改动。
  4. 加上构建脚本和持续集成,任何人一条命令就能编出来。

Reproducible Builds 项目给的定义是个好目标。哪怕只做到部分可复现,也能确认你改的是现场真正在跑的代码。

4.0 第 3 阶段:复现故障

准备一台或几台与现场硬件版本一致的台架设备。对每个报告的故障:

  • 写下报告的现象和条件:固件版本、硬件版本、环境、操作顺序。
  • 固件缺日志的,单独编一个加了日志或跟踪、其他与现场版本一致的构建。
  • 改变怀疑的条件尝试复现:电源质量、温度、射频环境、长时间运行、特定主机设备。
  • 记下哪些复现了、哪些没有,以及有多大把握。

有些故障在台架上复现不了。这个结论要直说,并附上推测,以及什么样的现场数据会有帮助,比如在你们选定的现场设备上跑带日志的构建。

5.0 第 4 阶段:梳理与评估

这时带着目的去读代码。我们写一份简短的评估,覆盖:

方面看什么
结构模块、分层、硬件访问怎么组织
并发中断处理、RTOS 任务、共享数据、优先级
内存栈大小、堆使用、缓冲区处理、静态分析结果
错误处理外设失败、超时时怎么办,看门狗怎么用
升级通道设备能不能升级,安不安全
测试已有什么,什么能便宜地补上
硬件耦合依赖板子版本的地方,和器件绑定的魔数

老代码开高告警级别、跑静态分析,会出一长串问题。我们按“导致已报告故障的可能性”排优先级,不追求全部清零。

6.0 第 5 阶段:修复、验证、发布

先修影响大、风险小的问题。每个修复都是一次小的、经过评审的改动,配一个测试:修之前能复现故障,修之后通过。发布的版本改动尽量少。什么时候发、什么时候推给全部设备,由你们团队根据我们提供的测试证据决定。

6.1 修还是重写?

迹象倾向
故障追到几个具体缺陷定点修复
产品在现场、升级通道可用先定点修复,再逐步重构
同一个结构性原因不断冒出新故障,比如多个任务间没保护的共享状态重写那个子系统
硬件平台反正要换可以结合新平台考虑重写
构建无法复现,关键部分源码缺失缺失部分只能重写

现场固件整体重写本身有风险:旧代码里藏着很多没人写下来的问题修复。建议重写某一部分时,我们会说明理由,并把旧行为保留下来作为测试参照。

7.0 每个阶段交付什么

  • 资料清单,以及以原始压缩包为起点的代码仓库。
  • 可复现的构建,带工具链说明和 CI。
  • 故障复现报告。
  • 代码评估和风险排序。
  • 修复、测试和发布说明。

不管后面是否继续和我们合作,这些产出都能用。合作怎么开始,见旧固件与现场接手;新固件开发见嵌入式固件。说说你们的情况,可以用聊聊项目。

参考资料

常见问题

前供应商不给源码,还能做什么?

从手上有的开始:固件二进制、设备和现有文档。有些行为可以从这些弄清楚,评估会说明哪些部分得重写。也看看和前供应商的合同,里面可能已经写了源码交付条款。

多久能修好第一个 bug?

取决于构建多快能复现、故障多快能复现。这两步的耗时比修复本身变化大得多,所以我们分别汇报进度,两步都完成后再给修复的估计。

拿不到现场设备能做吗?

我们先用硬件版本一致的台架设备;只有故障取决于安装、接线或射频环境时,才需要接触现场设备。那时在你们选定的现场设备上跑带日志的构建,是拿数据的实际办法。

你们会改代码风格或结构吗?

只在能降低风险的地方改。早期的修复保持小改动、贴近原有风格,方便评审。较大的重构另外提出,说明理由,并且在测试到位之后再做。