레거시 임베디드 코드베이스 인수하기

핵심 요약: 레거시 펌웨어 인수는 있는 것을 확보하고 빌드를 재현 가능하게 만드는 데서 시작해, 보고된 현장 불량을 벤치 제품에서 재현하는 순서로 갑니다. 그다음에야 코드를 파악하고 리스크를 적고, 가장 안전하면서 효과가 큰 문제부터 고칩니다. 재작성은 기존 구조가 계속 새 불량을 만든다는 근거가 있을 때만 검토합니다.

레거시 펌웨어 인수의 5단계 흐름도: 자산 확보, 재현 가능한 빌드, 불량 재현, 파악과 평가, 수정과 릴리스. 평가 뒤의 분기점에서 표적 수정과 부분 재작성 중 하나를 고르며, 각 단계는 문서 산출물을 낸다.
그림 1. 인수 단계와 산출물. 수정이냐 재작성이냐의 결정은 평가 뒤에 하며, 그 전에 하지 않는다.

1.0 흔한 출발점

전형적인 인수 상황은 이렇습니다. 원래 개발자나 업체는 떠났습니다. 소스는 압축 파일 안에 있거나 일부가 누군가의 노트북에 있습니다. 빌드는 한 대의 PC에서만 되고, 그 툴체인을 누가 설치했는지 아무도 기억하지 못합니다. 디바이스는 현장에 나가 있고 리셋, 멈춤, 특정 스마트폰 기종에서만 실패하는 기능 같은 보고가 들어옵니다. 빨리 고치라는 압박이 있습니다.

곧바로 코드를 읽고 패치하고 싶어집니다. 하지만 재현 가능한 빌드와 재현된 불량 없이 엉뚱한 원인을 겨냥한 패치를 내보내면, 첫 번째 불량 옆에 두 번째 불량을 함께 출하하게 됩니다.

2.0 1단계: 자산 확보

사라지기 전에 모두 모읍니다.

자산중요한 이유
소스 코드, 모든 브랜치와 압축 파일당연한 항목. 사본이 여러 개인지 찾아 비교한다
툴체인 설치 파일과 정확한 버전컴파일러 버전에 따라 코드 생성과 타이밍이 바뀐다
빌드 스크립트, IDE 프로젝트 파일, 링커 스크립트소스에 없는 최적화 플래그, 메모리 배치, define이 들어 있다
현재 현장에 있는 바이너리와 버전어떤 소스가 어떤 제품에 해당하는지 입증한다
부트로더 소스와 키(있다면)없으면 제품을 업데이트하지 못할 수 있다
프로그래밍 도구와 생산 라인 절차새 제품을 만들 때 필요하다
보드 리비전별 하드웨어 설계 파일펌웨어가 보드 리비전에 따라 분기한다
이슈 보고, 현장 로그, 고객 이메일불량의 증거

소스가 아직 버전 관리 아래 있지 않다면 즉시 넣고, 압축 파일을 손대지 않은 채 첫 커밋으로 삼으세요. 서명 키와 자격 증명은 저장소가 아니라 제대로 된 키 저장소에 둡니다.

제품에 관여한 사람들과는 연락이 닿을 때 이야기해 두세요. 이전 개발자, 생산 라인, 지원 팀입니다. 이전 개발자와 한 시간만 이야기해도 코드에서 다시 찾아내려면 며칠이 걸릴 빌드의 특이점이나 현장 우회 방법을 알 수 있습니다. 들은 내용은 적어서 저장소와 함께 보관하세요.

3.0 2단계: 빌드를 재현 가능하게

목표는 소스에서 현장 바이너리와 동일한 바이너리를 만들거나, 다른 점을 하나하나 설명하는 것입니다.

  1. 컨테이너나 문서화된 VM에 툴체인을 다시 구성하고 버전을 고정한다.
  2. 빌드해서 결과를 현장 바이너리와 비교한다. 빌드 시각이나 경로가 내장되어 생기는 차이는 예상된 것이고, 코드의 차이는 그렇지 않다.
  3. 일치하지 않으면 일치하는 소스 리비전을 찾는다. 어떤 리비전도 맞지 않으면 그것을 발견 사항으로 기록한다. 현장 펌웨어에 커밋되지 않은 변경이 들어 있을 수 있다.
  4. 빌드 스크립트와 CI를 갖춰 누구나 명령 하나로 빌드할 수 있게 한다.

Reproducible Builds 프로젝트의 정의는 목표로 삼기 좋은 기준입니다. 부분적인 재현성만으로도 실제로 현장에서 돌아가는 코드를 다루고 있는지 알 수 있습니다.

4.0 3단계: 불량 재현

현장 하드웨어 리비전에 맞춘 벤치용 제품을 한 대 이상 준비합니다. 보고된 불량마다 다음을 합니다.

  • 보고된 증상과 조건을 적는다: 펌웨어 버전, 하드웨어 리비전, 환경, 조작 순서.
  • 펌웨어에 로깅이나 트레이싱이 없으면 추가한다. 그 외에는 현장 버전과 같은 별도 빌드로 한다.
  • 의심되는 조건을 바꿔 가며 재현을 시도한다: 전원 품질, 온도, 무선 환경, 장시간 동작, 특정 호스트 디바이스.
  • 무엇이 재현됐고 무엇이 안 됐는지, 얼마나 확신하는지 기록한다.

벤치에서 재현되지 않는 불량도 있습니다. 그 결과는 그대로 밝히고, 가설과 도움이 될 현장 데이터(예: 고객사가 고른 현장 제품의 로깅 빌드)를 함께 적습니다.

5.0 4단계: 파악과 평가

이제 목적을 갖고 코드를 읽습니다. 다음을 다루는 짧은 평가서를 씁니다.

영역살펴보는 것
구조모듈, 계층, 하드웨어 접근의 구성 방식
동시성인터럽트 핸들러, RTOS 태스크, 공유 데이터, 우선순위
메모리스택 크기, 힙 사용, 버퍼 처리, 정적 분석 결과
오류 처리주변장치 고장과 타임아웃 시 동작, 워치독 사용
업데이트 경로제품을 업데이트할 수 있는지, 얼마나 안전한지
테스트있는 것, 적은 비용으로 추가할 수 있는 것
하드웨어 결합보드 리비전 의존성, 부품에 묶인 매직 넘버

오래된 코드에 정적 분석 도구와 높은 수준의 컴파일러 경고를 돌리면 긴 목록이 나옵니다. 전부 없애려 하지 않고, 보고된 불량을 일으켰을 가능성이 높은 순으로 분류합니다.

6.0 5단계: 수정, 검증, 릴리스

효과 대비 리스크가 가장 좋은 문제부터 고칩니다. 각각 작고 리뷰된 변경으로 하고, 수정 전에는 불량을 재현하고 수정 후에는 통과하는 테스트를 붙입니다. 수정은 변경을 최소화한 버전으로 출하합니다. 릴리스를 언제 내고 언제 전체 제품에 배포할지는 저희가 제공하는 테스트 근거를 바탕으로 고객사 팀이 정합니다.

6.1 수정할까, 다시 쓸까?

징후가리키는 방향
불량이 몇 가지 구체적인 결함으로 좁혀진다표적 수정
제품이 현장에 있고 업데이트 경로가 동작한다표적 수정 후 점진적 리팩터링
태스크 간 보호되지 않은 공유 상태처럼 같은 구조적 원인에서 새 불량이 계속 나온다해당 서브시스템의 부분 재작성
어차피 하드웨어 플랫폼이 바뀐다새 플랫폼과 함께 재작성을 검토할 수 있다
재현 가능한 빌드가 없고 핵심 부분의 소스가 없다없는 부분의 재작성은 피할 수 없다

현장 펌웨어 전체를 다시 쓰는 데에는 그만의 리스크가 있습니다. 오래된 코드에는 아무도 적어 두지 않은 문제에 대한 수정이 담겨 있기 때문입니다. 시스템 일부의 재작성을 권할 때는 이유를 밝히고, 기존 동작을 테스트 기준으로 남겨 둡니다.

7.0 단계별로 받는 것

  • 자산 목록과, 원본 압축 파일을 기반으로 한 저장소.
  • 툴체인을 문서화하고 CI를 갖춘 재현 가능한 빌드.
  • 불량 재현 보고서.
  • 리스크 순위를 매긴 코드 평가서.
  • 테스트와 릴리스 노트가 딸린 수정.

이 산출물은 작업을 저희와 계속하든 아니든 쓸모가 있습니다. 의뢰가 어떻게 시작되는지는 레거시 펌웨어·현장 문제 해결 페이지에서, 새 펌웨어 작업은 임베디드 펌웨어에서 다룹니다. 상황을 설명하시려면 프로젝트 상담을 이용하세요.

참고 자료

자주 묻는 질문

이전 업체가 소스 코드를 주지 않습니다. 어떻게 해야 하나요?

가진 것부터 시작합니다. 바이너리, 디바이스, 남아 있는 문서입니다. 이것만으로 이해할 수 있는 동작도 있고, 평가를 하면 어느 부분을 다시 작성해야 하는지 드러납니다. 이전 업체와의 계약서도 확인하세요. 소스 코드 인도 조건이 이미 들어 있을 수 있습니다.

첫 버그를 고치기까지 얼마나 걸리나요?

빌드가 얼마나 빨리 재현 가능해지고 불량이 얼마나 빨리 재현되느냐에 달려 있습니다. 이 두 단계는 수정 자체보다 편차가 크기 때문에, 각 단계의 진행 상황을 보고하고 둘 다 끝나면 수정 일정을 추정해 드립니다.

현장 제품에 접근하지 않고도 작업할 수 있나요?

같은 하드웨어 리비전의 벤치용 제품으로 시작합니다. 현장 접근은 불량이 설치 상태, 배선, RF 환경에 좌우될 때만 필요합니다. 그때는 고객사가 고른 현장 제품에 로깅 빌드를 올리는 것이 데이터를 얻는 현실적인 방법입니다.

코드 스타일이나 구조를 바꾸나요?

리스크를 줄이는 곳만 바꿉니다. 초기 수정은 작게, 기존 스타일에 가깝게 유지해 리뷰할 수 있게 합니다. 큰 리팩터링은 테스트가 갖춰진 뒤 이유와 함께 따로 제안합니다.