LK의 project와 module 빌드 그래프

QUESTION

LK의 project와 module 빌드 그래프 단계에서 실제로 바뀌는 상태는 무엇인가?

STRUCTURE

객체와 주소가 놓이는 구조

CALL PATH

실행 흐름

STATE LEDGER

단계별 입력과 출력

각 단계의 입력과 처리 후 바뀌는 상태를 정리한 표다. 사용 중인 소스 버전에서 다른 필드를 변경한다면 그에 맞춰 표도 수정한다.

분석 범위의 전제와 비교해, 다음 단계에 잘못된 입력을 넘긴 부분부터 조사한다.

VISUAL WALKTHROUGH

주소와 객체의 이동을 그림으로 읽기

아래 그림은 주소, 객체를 사용하는 기간, 제어권을 넘기는 시점을 중심으로 정리했다. 실제 주소와 크기는 사용 중인 보드의 bdinfo, 맵 파일과 링커 심벌로 확인한다.

UPSTREAM SOURCE

원본 코드

아래 코드는 LK upstream 1eb9917의 make/module.mk에서 7-95줄을 그대로 가져온 것이다. 설명을 위해 실제 코드를 가짜 의사 코드로 바꾸지 않았다.

7# MODULE_FLOAT_SRCS : list of source files compiled with floating point support (if available)
8# MODULE_DEPS : other modules that this one depends on
9# MODULE_DEFINES : #defines local to this module
10# MODULE_OPTFLAGS : OPTFLAGS local to this module
11# MODULE_COMPILEFLAGS : COMPILEFLAGS local to this module
12# MODULE_CFLAGS : CFLAGS local to this module
13# MODULE_CPPFLAGS : CPPFLAGS local to this module
14# MODULE_ASMFLAGS : ASMFLAGS local to this module
15# MODULE_INCLUDES : include directories local to this module
16# MODULE_SRCDEPS : extra dependencies that all of this module's files depend on
17# MODULE_EXTRA_OBJS : extra .o files that should be linked with the module
18
19# MODULE_ARM_OVERRIDE_SRCS : list of source files, local path that should be force compiled with ARM (if applicable)
20
21# MODULE_OPTIONS : space delimited list of options
22# currently defined options:
23#   extra_warnings - add additional warnings to the front of the module deps
24#   float - module uses floating point instructions/code
25
26# the minimum module rules.mk file is as follows:
27#
28# LOCAL_DIR := $(GET_LOCAL_DIR)
29# MODULE := $(LOCAL_DIR)
30#
31# MODULE_SRCS := $(LOCAL_DIR)/at_least_one_source_file.c
32#
33# include make/module.mk
34
35# test for old style rules.mk
36ifneq ($(flavor MODULE_OBJS),undefined)
37ifneq ($(MODULE_OBJS),)
38$(warning MODULE_OBJS = $(MODULE_OBJS))
39$(error MODULE $(MODULE) is setting MODULE_OBJS, change to MODULE_SRCS)
40endif
41endif
42ifneq ($(flavor OBJS),undefined)
43ifneq ($(OBJS),)
44$(warning OBJS = $(OBJS))
45$(error MODULE $(MODULE) is probably setting OBJS, change to MODULE_SRCS)
46endif
47endif
48
49MODULE_SRCDIR := $(MODULE)
50MODULE_BUILDDIR := $(call TOBUILDDIR,$(MODULE_SRCDIR))
51
52# add a local include dir to the global include path
53GLOBAL_INCLUDES += $(MODULE_SRCDIR)/include
54
55# add the listed module deps to the global list
56MODULES += $(MODULE_DEPS)
57
58# parse options
59MODULE_OPTIONS_COPY := $(sort $(MODULE_OPTIONS))
60ifneq (,$(findstring float,$(MODULE_OPTIONS)))
61# floating point option just forces all files in the module to be
62# compiled with floating point compiler flags.
63#$(info MODULE $(MODULE) has float option)
64MODULE_FLOAT_SRCS := $(sort $(MODULE_FLOAT_SRCS) $(MODULE_SRCS))
65MODULE_SRCS :=
66MODULE_OPTIONS_COPY := $(filter-out float,$(MODULE_OPTIONS_COPY))
67endif
68ifneq (,$(findstring extra_warnings,$(MODULE_OPTIONS)))
69# add some extra warnings to the various module compiler switches.
70# add these extra switches first so it's possible for the rules.mk file
71# that invoked us to override with a -Wno-...
72MODULE_COMPILEFLAGS := $(EXTRA_MODULE_COMPILEFLAGS) $(MODULE_COMPILEFLAGS)
73MODULE_CFLAGS := $(EXTRA_MODULE_CFLAGS) $(MODULE_CFLAGS)
74MODULE_CPPFLAGS := $(EXTRA_MODULE_CPPFLAGS) $(MODULE_CPPFLAGS)
75MODULE_ASMFLAGS := $(EXTRA_MODULE_ASMFLAGS) $(MODULE_ASMFLAGS)
76MODULE_OPTIONS_COPY := $(filter-out extra_warnings,$(MODULE_OPTIONS_COPY))
77endif
78
79ifneq ($(MODULE_OPTIONS_COPY),)
80$(error MODULE $(MODULE) has unrecognized option(s) $(MODULE_OPTIONS_COPY))
81endif
82
83
84#$(info module $(MODULE))
85#$(info MODULE_COMPILEFLAGS = $(MODULE_COMPILEFLAGS))
86#$(info MODULE_SRCDIR $(MODULE_SRCDIR))
87#$(info MODULE_BUILDDIR $(MODULE_BUILDDIR))
88#$(info MODULE_DEPS $(MODULE_DEPS))
89#$(info MODULE_SRCS $(MODULE_SRCS))
90#$(info MODULE_FLOAT_SRCS $(MODULE_SRCS))
91#$(info MODULE_OPTIONS $(MODULE_OPTIONS))
92
93MODULE_DEFINES += MODULE_NAME=\"$(subst $(SPACE),_,$(MODULE))\"
94MODULE_DEFINES += MODULE_OPTIONS=\"$(subst $(SPACE),_,$(MODULE_OPTIONS))\"
95MODULE_DEFINES += MODULE_COMPILEFLAGS=\"$(subst $(SPACE),_,$(MODULE_COMPILEFLAGS))\"

READING CONTRACT

발췌 범위와 읽기 기준

원문 7-95줄에는 앞뒤 문맥이 포함됩니다. 기준 구문 MODULE_SRCS :=은 L31에 있습니다. 발췌 첫 줄을 함수 정의의 시작으로 해석하지 않습니다.

LK 빌드는 디렉터리를 자동으로 전부 모으지 않는다. MODULE_DEPS와 MODULE_SRCS가 실제 포함 경계를 결정하며 app descriptor도 linker section으로 들어간다.

RELATED SOURCE

함께 읽어야 하는 원본 코드

첫 코드 조각만으로 동작이 완성되지 않는 경우 호출 매크로, 객체 정의와 실제 실행 목록을 같은 페이지에 묶었다. 각 조각은 같은 기준 commit에서 가져왔다.

138ALLOBJS += $(MODULE_OBJS)
139
140# track the module object for make clean
141GENERATED += $(MODULE_OBJECT)
142
143# make the rest of the build depend on our output
144ALLMODULE_OBJS := $(ALLMODULE_OBJS) $(MODULE_OBJECT)
145
146# empty out any vars set here
147MODULE :=
148MODULE_SRCDIR :=
149MODULE_BUILDDIR :=
150MODULE_DEPS :=
151MODULE_SRCS :=
152MODULE_FLOAT_SRCS :=
153MODULE_OBJS :=
154MODULE_DEFINES :=
155MODULE_OPTFLAGS :=
156MODULE_COMPILEFLAGS :=
157MODULE_CFLAGS :=
158MODULE_CPPFLAGS :=
159MODULE_ASMFLAGS :=
160MODULE_SRCDEPS :=
161MODULE_INCLUDES :=
162MODULE_EXTRA_OBJS :=
163MODULE_CONFIG :=
164MODULE_OBJECT :=
165MODULE_ARM_OVERRIDE_SRCS :=
166MODULE_OPTIONS :=

DETAILS

내부 동작을 더 깊게 읽기

IMPLEMENTATION NOTES

구현을 읽을 때 놓치기 쉬운 부분

OBJECT LIFETIME

객체와 수명

FAILURE PATH

실패 지점과 증상

로그가 끊긴 함수뿐 아니라 그 함수에 주소, 크기, 플래그를 전달한 앞 단계도 조사한다. 오류 처리 후 등록된 객체나 하드웨어 설정이 그대로 남아 있는지도 확인한다.

EVIDENCE

소스 밖에서 확인할 증거

소스에서 파악한 동작을 실제 빌드 결과와 대상 보드의 로그로 확인한다. 아래 명령의 보드 이름과 툴체인 접두사는 사용 중인 빌드 환경에 맞게 바꾼다.

LAB

직접 확인할 실험

1. 01
   make PROJECT=qemu-virt-arm64 V=1 기록

   module dependencies 진입 전후에 project variables의 주소·크기·반환값과 timestamp를 함께 남긴다.

2. 02
   map 파일에서 app descriptor section 확인

   source lists 진입 전후에 module graph의 주소·크기·반환값과 timestamp를 함께 남긴다.

3. 03
   MODULE_DEPS 하나를 제거해 링크 오류 경계 확인

   lk ELF 진입 전후에 linker script의 주소·크기·반환값과 timestamp를 함께 남긴다.

PRIMARY REFERENCES

원문과 다음 글