Übernahme einer Legacy-Embedded-Codebasis
KURZ GESAGT: Die Übernahme von Legacy-Firmware beginnt damit, das Vorhandene zu sichern und den Build reproduzierbar zu machen; danach werden die gemeldeten Feldfehler an einem Gerät am Messplatz nachgestellt. Erst dann kartieren wir den Code, schreiben die Risiken auf und beheben zuerst die sichersten Probleme mit hohem Nutzen. Eine Neuentwicklung ziehen wir nur in Betracht, wenn die Belege zeigen, dass die alte Struktur immer neue Fehler hervorbringt.
1.0 Die übliche Ausgangslage
Eine typische Übernahme: Der ursprüngliche Entwickler oder Dienstleister ist weg. Der Quellcode liegt in einem Archiv oder zum Teil auf jemandes Laptop. Der Build läuft auf einem Rechner, mit einer Toolchain, an deren Installation sich niemand erinnert. Geräte sind im Feld, und es kommen Meldungen: Resets, Hänger, eine Funktion, die mit einem bestimmten Smartphone-Modell versagt. Der Fehler soll schnell weg.
Die Versuchung ist groß, sofort Code zu lesen und zu patchen. Ohne reproduzierbaren Build und nachgestellten Fehler liefert ein Patch, der auf die falsche Ursache zielt, einen zweiten Fehler neben dem ersten aus.
2.0 Phase 1: Bestände sichern
Sammeln Sie alles ein, bevor es verschwindet:
| Bestand | Warum er zählt |
|---|---|
| Quellcode, alle Branches und Archive | Das Offensichtliche; nach mehr als einer Kopie suchen und vergleichen |
| Toolchain-Installer und exakte Versionen | Compiler-Versionen verändern Codeerzeugung und Timing |
| Build-Skripte, IDE-Projektdateien, Linker-Skripte | Enthalten Optimierungsflags, Speicherlayout und Defines, die nicht im Quellcode stehen |
| Binärdateien, die derzeit im Feld sind, mit Versionen | Belegt, welcher Quellstand zu welchen Geräten gehört |
| Bootloader-Quellcode und Schlüssel, falls vorhanden | Ohne sie lassen sich Geräte womöglich nicht aktualisieren |
| Programmierwerkzeuge und Ablauf an der Fertigungslinie | Nötig, um neue Geräte zu bauen |
| Hardware-Designdaten zu jeder Board-Revision | Die Firmware verzweigt nach Board-Revision |
| Fehlermeldungen, Feldprotokolle, Kunden-E-Mails | Die Belege für die Fehler |
Stellen Sie den Quellcode sofort unter Versionsverwaltung, falls das noch nicht geschehen ist, mit dem Archiv unverändert als erstem Commit. Signaturschlüssel und Zugangsdaten gehören in eine ordentliche Schlüsselverwaltung, nicht ins Repository.
Sprechen Sie mit allen, die am Produkt gearbeitet haben, solange sie erreichbar sind: dem früheren Entwickler, der Fertigungslinie, dem Support-Team. Eine Stunde mit dem früheren Entwickler kann eine Eigenheit im Build oder einen Workaround im Feld erklären, die man aus dem Code erst nach Tagen wieder herausfände. Schreiben Sie die Notizen auf und legen Sie sie zum Repository.
3.0 Phase 2: Den Build reproduzierbar machen
Ziel ist, aus dem Quellcode ein Binary zu erzeugen, das mit dem im Feld identisch ist, oder jeden Unterschied zu erklären.
- Die Toolchain in einem Container oder einer dokumentierten VM nachbauen und die Versionen festschreiben.
- Bauen und die Ausgabe mit dem Feld-Binary vergleichen. Unterschiede durch eingebettete Build-Zeitstempel oder Pfade sind zu erwarten, Unterschiede im Code nicht.
- Stimmen sie nicht überein, nach dem Quellstand suchen, der passt. Passt keiner, das als Befund festhalten: Die Feld-Firmware enthält womöglich Änderungen, die nie eingecheckt wurden.
- Ein Build-Skript und Continuous Integration einrichten, damit jeder mit einem Befehl bauen kann.
Die Definition des Projekts Reproducible Builds ist ein nützlicher Maßstab. Schon teilweise Reproduzierbarkeit zeigt, ob Sie an dem Code arbeiten, der im Feld tatsächlich läuft.
4.0 Phase 3: Die Fehler nachstellen
Richten Sie ein oder mehrere Geräte am Messplatz ein, die den Hardware-Revisionen im Feld entsprechen. Für jeden gemeldeten Fehler:
- Gemeldete Symptome und Bedingungen notieren: Firmware-Version, Hardware-Revision, Umgebung, Abfolge der Bedienschritte.
- Logging oder Tracing ergänzen, wenn die Firmware keins hat, in einem eigenen Build, der sonst der Feldversion entspricht.
- Nachstellen und dabei die verdächtigen Bedingungen variieren: Qualität der Versorgung, Temperatur, Funkumgebung, lange Laufzeit, bestimmte Host-Geräte.
- Festhalten, was sich nachstellen ließ, was nicht und wie sicher Sie sind.
Manche Fehler lassen sich am Messplatz nicht nachstellen. Das steht dann klar im Bericht, zusammen mit den Hypothesen und den Felddaten, die weiterhelfen würden, etwa ein Logging-Build auf von Ihnen ausgewählten Feldgeräten.
5.0 Phase 4: Kartieren und bewerten
Jetzt wird der Code gezielt gelesen. Wir schreiben eine kurze Bewertung, die Folgendes abdeckt:
| Bereich | Worauf wir achten |
|---|---|
| Struktur | Module, Schichten, wie der Hardwarezugriff organisiert ist |
| Nebenläufigkeit | Interrupt-Handler, RTOS-Tasks, gemeinsam genutzte Daten, Prioritäten |
| Speicher | Stackgrößen, Heap-Nutzung, Pufferbehandlung, Befunde der statischen Analyse |
| Fehlerbehandlung | Was bei Peripherieausfall und Timeouts passiert, Einsatz des Watchdogs |
| Update-Pfad | Ob sich Geräte aktualisieren lassen und wie sicher |
| Tests | Was vorhanden ist, was sich günstig ergänzen lässt |
| Hardwarekopplung | Abhängigkeiten von der Board-Revision, an Bauteile gebundene magische Zahlen |
Statische Analyse und Compiler-Warnungen auf höheren Stufen erzeugen bei altem Code lange Listen. Wir sortieren sie danach, wie wahrscheinlich sie die gemeldeten Fehler verursachen, statt alle abarbeiten zu wollen.
6.0 Phase 5: Beheben, verifizieren, freigeben
Beheben Sie zuerst die Probleme mit dem besten Verhältnis von Wirkung zu Risiko, jedes als kleine, geprüfte Änderung mit einem Test, der den Fehler vor der Korrektur auslöst und danach besteht. Liefern Sie Korrekturen in Versionen aus, die so wenig wie möglich ändern. Ihr Team entscheidet anhand der Testbelege, die wir liefern, wann ein Release erscheint und wann es die Geräteflotte erreicht.
6.1 Korrigieren oder neu schreiben?
| Anzeichen | Spricht für |
|---|---|
| Fehler lassen sich auf wenige konkrete Defekte zurückführen | Gezielte Korrekturen |
| Produkt im Feld, Update-Pfad funktioniert | Gezielte Korrekturen, danach schrittweises Refactoring |
| Neue Fehler entstehen immer wieder aus derselben strukturellen Ursache, etwa ungeschütztem gemeinsamem Zustand zwischen Tasks | Teilweise Neuentwicklung dieses Subsystems |
| Die Hardwareplattform wechselt ohnehin | Neuentwicklung kann zusammen mit der neuen Plattform erwogen werden |
| Kein reproduzierbarer Build, Quellcode für zentrale Teile fehlt | Neuentwicklung der fehlenden Teile ist unumgänglich |
Eine vollständige Neuentwicklung von Feld-Firmware hat ihr eigenes Risiko: Im alten Code stecken Korrekturen für Probleme, die nie jemand aufgeschrieben hat. Wenn wir empfehlen, einen Teil des Systems neu zu schreiben, begründen wir das und behalten das alte Verhalten als Testreferenz.
7.0 Was Sie in jeder Phase bekommen
- Bestandsverzeichnis und Repository mit dem Originalarchiv als Basis.
- Reproduzierbarer Build mit dokumentierter Toolchain und CI.
- Bericht zur Fehlernachstellung.
- Code-Bewertung mit gewichteten Risiken.
- Korrekturen mit Tests und Release Notes.
Diese Ergebnisse sind nützlich, ob die Arbeit mit uns weitergeht oder nicht. Die Seite Legacy-Firmware und Hilfe bei Feldproblemen beschreibt, wie ein Auftrag beginnt, und Embedded-Firmware behandelt neue Firmware-Arbeit. Um Ihre Lage zu schildern, nutzen Sie Projekt besprechen.
Quellen
- Reproducible Builds, definition: https://reproducible-builds.org/docs/definition/
Häufige Fragen
Der frühere Dienstleister gibt uns den Quellcode nicht. Was lässt sich tun?
Beginnen Sie mit dem, was da ist: Binärdateien, Geräte und vorhandene Dokumentation. Manches Verhalten lässt sich daraus verstehen, und die Bewertung zeigt, welche Teile neu geschrieben werden müssten. Prüfen Sie auch den Vertrag mit dem früheren Dienstleister; er enthält womöglich schon Regelungen zur Herausgabe des Quellcodes.
Wie lange dauert es, bis Sie den ersten Fehler beheben können?
Das hängt davon ab, wie schnell der Build reproduzierbar wird und der Fehler sich nachstellen lässt. Diese beiden Schritte schwanken stärker als die Korrektur selbst. Deshalb berichten wir den Fortschritt zu jedem und schätzen die Korrekturen, sobald beide erledigt sind.
Können Sie ohne Zugriff auf Feldgeräte arbeiten?
Wir beginnen mit Geräten am Messplatz im selben Hardware-Revisionsstand; Zugriff im Feld braucht es nur, wenn der Fehler von Installation, Verkabelung oder Funkumgebung abhängt. Dann ist ein Logging-Build auf von Ihnen ausgewählten Feldgeräten der praktikable Weg zu Daten.
Ändern Sie Codestil oder Struktur?
Nur wo es das Risiko senkt. Frühe Korrekturen bleiben klein und nah am vorhandenen Stil, damit sie sich prüfen lassen. Größeres Refactoring schlagen wir separat vor, mit Begründung, sobald Tests vorhanden sind.