목차
9천만 줄 Go 코드의 nil panic을 추적하는 NilAway (2023-11)
원문 정보
- 원문: NilAway: Practical Nil Panic Detection for Go
- 매체 · 게시일: Uber Engineering Blog · 2023-11-15
- 저자: Sonal Mahajan(Staff Engineer), Yuxin Wang(Senior Software Engineer), Lazaro Clapp(Former Staff Engineer), Raj Barik(Former Principal Engineer)
- 원문 내용을 바탕으로 재구성한 요약입니다.
하루 3,000건 넘는 nil panic을 일으킨 채널
우버의 한 서비스는 하루에 3,000건 넘는 nil panic을 로그에 남기고 있었습니다. nil 값을 역참조하다 생기는 실행 오류입니다. 문제의 코드는 t.s.foo(…)가 반환한 채널에서 값을 받아 변수 a에 담은 뒤, 곧장 a.Items[*id]에 접근하고 있었습니다.
놓친 경로는 함수 안에 있었습니다. 채널에 값을 하나도 쓰지 않고 닫는 경로입니다. Go에서는 이렇게 닫힌 채널에서도 값을 읽을 수 있으며, 이 예제에서는 해당 타입의 제로값인 nil을 받습니다. 호출부가 그 값을 그대로 역참조하면서 panic이 났습니다. NilAway는 채널에서 받은 값이 nil일 수 있다는 사실과 뒤따르는 역참조를 연결해 오류를 보고했습니다.
수신할 때 ok를 확인하는 if a, ok := <-t.s.foo(…); ok { … }를 쓰거나, 받은 값을 if a != nil { … }로 검사하면 이 문제를 피할 수 있었습니다. 개발자들은 보고를 받은 직후 nil 검사를 넣었습니다. 서비스의 nil panic은 하루 3,000건 이상에서 0으로 줄었습니다.
고친 코드는 nil 검사 하나였습니다. 하지만 오류를 찾으려면 역참조가 있는 줄에서 멈추지 않고, 값을 반환하는 함수 안으로 들어가 채널이 닫히는 경로까지 따라가야 했습니다.
nilness와 NullAway만으로 부족했던 Go 모노레포
우버에서 Go는 백엔드의 주력 언어입니다. Go 모노레포는 약 9천만 줄로 사내에서 가장 큰 코드베이스이며, 계속 커지고 있었습니다. 포인터는 데이터를 제자리에서 수정하거나 공유하는 일부터 동시성 처리, 메모리 절약, 인터페이스와 다형성까지 두루 쓰입니다. 그만큼 nil을 잘못 다룰 여지도 많았습니다.
피해는 로그에 그치지 않았습니다. 우버에서는 nil panic으로 잘못된 동작과 앱 장애가 발생해 고객에게 영향을 주었습니다. 원문은 nil panic이 보안 문제로도 이어질 수 있다며 외부 사례 하나를 듭니다. golang.org/x/crypto/ssh의 CVE-2020-29652는 nil 역참조를 이용해 원격에서 SSH 서버에 서비스 거부 공격을 가할 수 있었던 취약점입니다.
Go의 nilness 검사기는 가볍지만, if x == nil { print(*x) }처럼 명백한 패턴을 잡는 데 머뭅니다. 값이 함수와 인터페이스를 거쳐 이동하는 복잡한 흐름은 놓칩니다. Java에는 우버가 만든 NullAway가 있었지만, 이 도구는 @Nullable 어노테이션을 요구했습니다. Go에는 어노테이션 문법이 없고, 9천만 줄에 일일이 표시를 붙이는 일도 현실적이지 않았습니다.
NilAway는 개발자가 표시하지 않은 nil 가능성을 스스로 추론해야 했습니다. Go다운 코드를 그대로 분석하면서 로컬 빌드에서도 빠르게 결과를 내고, 개발자가 오탐을 검토하느라 시간을 낭비하지 않게 하는 것이 설계 조건이었습니다.
인터페이스 너머까지 추적하는 nil의 경로
Go 표준 라이브러리의 net 패키지에서도 비슷한 문제가 발견됐습니다. 호출부는 RemoteAddr()가 반환한 값에 곧바로 String()을 호출했습니다. 반환값이 nil일 수 있다는 가능성을 빠뜨린 코드였습니다.
여기에는 인터페이스가 끼어 있습니다. c.rwc의 타입은 net.Conn인데, 그 안에 담긴 구체 타입이 net.conn이면 RemoteAddr()의 반환값은 연결 상태에 따라 달라집니다. c.ok()가 false일 때는 nil 인터페이스를 반환합니다. 이 값에 String()을 호출하면 실행할 구체 메서드가 없으므로 panic이 납니다.
NilAway는 이런 흐름을 전역 타입 제약식으로 표현합니다. 구조체 필드, 함수 파라미터, 반환값 같은 지점마다 nil일 수 있다는 제약인 nilable과 nil이어서는 안 된다는 제약인 nonnil을 모읍니다. 초기화하지 않은 포인터 x를 return x로 반환하면 nilable의 증거가 됩니다. *x로 역참조하는 코드는 nonnil을 요구합니다.
제약들을 연결하면 전역 함의 그래프가 만들어집니다. 노드는 프로그램의 각 지점이고, 간선은 그 사이로 nil이 흐르는 관계입니다. nil이라는 증거는 흐름을 따라 앞으로 전파하고, nil이어서는 안 된다는 요구는 뒤로 전파합니다. 같은 지점 S에서 nilable(S)와 nonnil(S)가 함께 성립하면 모순입니다. nil의 출처에서 역참조까지 이어지는 위험한 경로가 있다는 뜻이며, NilAway는 2-SAT 방식의 알고리즘으로 이 모순을 찾습니다.
앞의 사례에서는 구체 구현인 net.conn.RemoteAddr()에서 인터페이스 선언 net.Conn.RemoteAddr()를 거쳐 역참조까지 이어지는 경로가 잡힙니다. 오류 메시지에도 이 경로를 담습니다. 개발자는 문제가 있다는 통보만 받는 대신, nil일 수 있다는 증거가 어디서 생겼고 어느 호출을 거쳐 역참조에 도달했는지 따라가며 수정할 수 있습니다.
함수별로 나눠 분석하는 NilAway의 엔진
분석이 정확해도 빌드가 느려지면 피드백이 늦습니다. 우버는 로컬 빌드를 포함한 개발 파이프라인의 모든 단계에서 NilAway를 실행하려 했으므로, 분석 비용도 설계의 제약이었습니다. 구현에는 Go와 go/analysis 프레임워크를 썼습니다. 대상 패키지 경로를 입력받아 잠재적인 nil panic을 출력하는 방식입니다.
분석은 함수 안에서 시작합니다. Analyzer Engine이 각 함수의 nil 흐름을 독립적으로 찾으면, Inference Engine은 프로그램 지점별로 모은 nil 가능성의 증거를 함의 그래프에 연결해 함수 사이로 전파합니다. Error Engine은 이 정보를 합쳐 각 흐름이 안전한지 판단하고, 위험한 흐름의 증거가 있을 때 오류를 보고합니다. 엔진이 수집한 제약으로 nil 가능성을 추론하므로 개발자가 어노테이션을 달거나 분석기에 맞춰 코드를 어색하게 바꿀 이유가 없습니다.
함수별 분석은 병렬로 실행합니다. 전역 함의 그래프도 매번 처음부터 만들지 않습니다. 빌드 캐시를 활용해 증분으로 구성하므로 의존성을 다시 분석하는 비용을 피합니다. 우버에서 측정한 오버헤드는 일반 빌드 대비 5% 미만이었습니다.
이 분석에도 한계는 있습니다. 예를 들어 공유 상태가 c.ok()를 항상 true로 유지한다면 앞의 net 사례에서 실제 panic은 발생하지 않습니다. NilAway가 함수 사이의 미묘한 불변식까지 파악하지 못하면, 오류가 없는 코드에도 경고를 낼 수 있습니다. 우버 팀은 이런 불변식에 기대는 코드 자체도 대체로 코드 냄새로 보았습니다.
우버 팀이 북극성으로 삼은 것은 실용적인 버그 탐지였습니다. NilAway는 건전성이나 완전성을 주장하지 않으며, 오탐과 미탐이 모두 가능합니다. 그 한계를 전제로 Go 관용구를 폭넓게 지원하고 위험한 흐름의 증거를 요구하는 데 집중했습니다. 실제 사용에서는 오탐률이 낮았고, 새 코드의 잠재적인 nil panic 대부분을 잡아냈다고 보고했습니다.
빌드 차단 여부를 고르는 서비스 팀
원문 게시 당시 NilAway는 우버의 Go 모노레포에 중앙 배포되어 Bazel과 nogo에 통합된 상태였습니다. CI와 로컬 빌드마다 기본 린터로 실행했습니다. 실행 범위와 오류를 보여 주는 범위는 달랐습니다. 오류 보고는 시험 단계여서 NilAway에 온보딩한 서비스에만 결과를 노출했습니다.
기존 문제까지 처리하려는 팀은 포괄적 차단 방식을 선택했습니다. 기존 코드와 새 코드에서 찾은 오류를 모두 보고하고, 하나라도 있으면 빌드를 실패시킵니다. //nolint:nilaway로 보고를 억제할 수 있습니다. 보고된 문제를 처리해야 빌드가 통과하므로 초기 비용이 크고, 서비스 팀과 마찰이 생길 수 있는 방식입니다.
출혈 방지 비차단 방식은 변경된 코드의 오류만 각 diff, 즉 풀 리퀘스트의 코멘트로 알립니다. 빌드를 막지는 않습니다. 새 nil panic이 들어오는 것을 막는 데 집중하면서 기존 문제는 점진적으로 고칠 수 있어, 도입 때 기존 코드를 한꺼번에 정리하는 부담을 피합니다.
여러 서비스가 각자 방식을 골라 도입했습니다. 한 팀은 문제를 일찍 잡아 배포 롤백을 막았다고 평가했고, 다른 사용자는 코멘트가 바로 조치할 수 있는 내용이며 불필요한 경고도 없었다고 전했습니다. 사용자들은 오탐과 개선 의견도 보냈습니다. 우버는 이 피드백을 도구에 반영하고 있었습니다.
NilAway는 https://github.com/uber-go/nilaway/ 에 오픈소스로 공개되어 있습니다. 독립 검사기로 실행하거나 기존 분석기 드라이버와 통합해 쓸 수 있습니다. 설정 방법은 저장소의 README와 위키에 있으며, 사용 경험의 공유와 커뮤니티 기여도 받고 있습니다.
원문의 수치와 보고 방식
| 항목 | 값 |
|---|---|
| Go 모노레포 규모 | 9천만 줄 |
| 빌드 오버헤드 | 일반 빌드 대비 5% 미만 |
| 사례 서비스의 nil panic | 하루 3,000건 이상에서 0건으로 |
| 포괄적 차단 방식 | 기존·새 코드 모두 보고, 에러 시 빌드 실패, //nolint:nilaway로 억제 |
| 출혈 방지 비차단 방식 | 변경된 코드만, diff마다 비차단 보고 |
| 구성 요소 | Analyzer Engine, Inference Engine, Error Engine |
| 빌드 연동 | Bazel + nogo, go/analysis 기반 |