QUESTION
LK의 project와 module 빌드 그래프 단계에서 실제로 바뀌는 상태는 무엇인가?
LK 빌드는 디렉터리를 자동으로 전부 모으지 않는다. MODULE_DEPS가 MODULES를 확장하고, 선택된 module의 source가 object를 만든다. 최종 link에는 module별 *.mod.o가 들어간다.
선택된 project의 architecture, platform, target과 linker script가 같은 메모리 지도를 전제해야 한다. project 설정에서 의존 module, 중간 object, 최종 ELF로 이어지는 규칙을 따라가며 각 단계의 입력과 산출물을 확인한다.
STRUCTURE
객체와 주소가 놓이는 구조
선택된 module의 source는 compile.mk에서 개별 object가 되고, module.mk에서 ld -r로 묶인다. linker script와 함께 최종 ELF를 만들기 전까지의 중간 산출물을 구분한다.
BUILD GRAPH
Make 규칙이 산출물을 연결하는 순서
화살표는 runtime 함수 호출이나 성공 flag가 아니라 Make 변수·파일의 의존 관계다. module.mk는 module object를 ALLMODULE_OBJS에 추가하고, build.mk는 이를 ELF link 입력으로 사용한 뒤 objcopy -O binary를 실행한다.
STATE LEDGER
단계별 입력과 빌드 산출물
고정 LK 소스의 Make 변수와 target을 기준으로 추적한다. 각 행은 runtime 상태가 아니라 다음 규칙이 읽는 목록 또는 파일이다.
| # | 규칙 | 입력 | 생성·갱신 | 다음 소비자 |
|---|---|---|---|---|
| 01 | engine.mk | project, target, platform, arch | MODULES, linker script | make/recurse.mk |
| 02 | recurse.mk / module.mk | MODULES, MODULE_DEPS | 중복을 제외한 module 규칙 포함 | make/compile.mk |
| 03 | compile.mk | MODULE_SRCS 등 source 목록 | MODULE_OBJS (*.c.o 등) | make/module.mk |
| 04 | module.mk | MODULE_OBJS, MODULE_EXTRA_OBJS | ld -r로 *.mod.o; ALLMODULE_OBJS에 추가 | make/build.mk |
| 05 | build.mk link | ALLMODULE_OBJS, EXTRA_OBJS, linker script | lk.elf와 lk.elf.map | $(OUTBIN) 규칙 |
| 06 | build.mk image | lk.elf | objcopy -O binary로 lk.bin | 빌드 결과 |
선택 범위를 먼저 확인한 뒤 누락된 module, 개별 object, module object, 최종 link 입력 중 어느 경계가 끊겼는지 찾는다.
VISUAL WALKTHROUGH
source에서 module object와 최종 image까지
make/compile.mk, make/module.mk, make/build.mk의 실제 산출물 이름을 사용한다. 이 그림의 화살표는 보드에서 실행되는 코드의 제어권 이동이 아니다.
module의 source 목록과 최종 link 사이에 ld -r module object가 놓인다.
각 module의 개별 object는 archive가 아니라 ld -r로 하나의 *.mod.o가 된다.
engine.mk + rules.mk→MODULES→recurse.mkMODULE_DEPS→MODULES 확장→module rules.mkMODULE_SRCS→MODULE_OBJS (*.o)→ld -r: *.mod.oALLMODULE_OBJS + linker script→LD -T→lk.elflk.elf→objcopy -O binary→lk.binUPSTREAM 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에 있습니다. 발췌 첫 줄을 해당 빌드 규칙의 시작으로 해석하지 않습니다.
이 발췌의 MODULES += $(MODULE_DEPS)는 module 선택을 확장한다. 실제 개별 object·module object·최종 ELF 규칙은 아래 고정 보조 원문의 compile.mk, module.mk, build.mk에서 확인한다.
RELATED SOURCE
함께 읽어야 하는 원본 코드
이 발췌는 module.mk가 MODULE_OBJECT를 ALLMODULE_OBJS에 더하고 module-local 변수를 비우는 부분이다. MODULE_DEPS의 실제 추가는 같은 파일 55–56줄이며, 재귀 포함은 recurse.mk를 함께 봐야 한다.
01. module object 목록 추가와 변수 초기화
make/module.mk 138-166줄이다. 여기의 MODULE_DEPS :=는 재귀 동작이 아니라 module-local 변수의 초기화다.
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
Make 변수를 파일 산출물까지 따라가기
project의 선택 범위를 고정한다
engine.mk는 선택된 project/$(PROJECT).mk, target, platform, arch 규칙을 포함한다. 이 단계는 host의 Make 해석이며 보드 runtime의 interrupt·stack·heap 상태와 관계가 없다.
module dependency를 닫는다
module.mk의 MODULES += $(MODULE_DEPS) 뒤에 recurse.mk가 아직 포함하지 않은 module의 rules.mk를 반복해 포함한다. 빈 dependency나 누락된 module은 다음 compile·link 입력을 바꾼다.
source 목록과 object 파일을 구분한다
MODULE_SRCS는 Make 변수이며 runtime symbol이 아니다. compile.mk는 확장자별로 *.c.o, *.cpp.o, *.cc.o, *.S.o를 만들고 그 파일 목록을 MODULE_OBJS에 돌려준다.
module object를 합친다
module.mk는 MODULE_OBJS와 선택적 MODULE_EXTRA_OBJS를 LD -r로 *.mod.o에 묶는다. 이 module object가 ALLMODULE_OBJS에 추가되어 최종 link의 prerequisite가 된다.
ELF와 binary를 나눠 확인한다
build.mk는 module object, EXTRA_OBJS, linker script를 입력으로 lk.elf와 map을 만들고, 이어 objcopy -O binary로 lk.bin을 만든다. 이 Make target은 boot handoff가 아니다.
IMPLEMENTATION NOTES
구현을 읽을 때 놓치기 쉬운 부분
project, target, platform과 module은 다른 선택 층이다
engine.mk가 project와 target·platform·arch 규칙을 포함한 뒤 top/rules.mk와 recurse.mk로 module 목록을 확장한다. tree에 소스 파일이 있다는 사실만으로 해당 module이 link 입력이 되지 않는다.
dependency closure와 개별 object를 분리한다
MODULE_DEPS는 MODULES에 추가되고 recurse.mk는 이미 포함된 module을 제외한다. 선택된 module에서 compile.mk가 실제 source별 object를 계산한다. module이 포함되더라도 linker garbage collection 설정에 따라 최종 ELF의 개별 section 보존은 달라질 수 있다.
archive 없이 ELF와 raw image를 만든다
이 고정 빌드에서는 module마다 *.mod.o를 만들고 ALLMODULE_OBJS를 최종 link한다. build.mk의 $(OUTBIN): $(OUTELF) 규칙은 objcopy -O binary이므로 여기서 ROM header나 runtime 진입을 추가한다고 해석하면 안 된다.
BUILD ARTIFACTS
변수와 산출물의 수명
| 대상 | 만드는 규칙 | 다음 소비자 | 확인할 조건 |
|---|---|---|---|
MODULE_SRCS | module의 rules.mk | compile.mk | 선택된 module의 source 목록인지 확인 |
MODULE_OBJS | compile.mk의 확장자별 compile | module.mk의 LD -r | 개별 *.o와 compile 오류 |
MODULE_OBJECT (*.mod.o) | module.mk의 LD -r | ALLMODULE_OBJS | module별 object와 추가 object 포함 |
lk.elf / lk.elf.map | build.mk의 최종 LD | objcopy와 map 분석 | linker script, section, symbol 확인 |
lk.bin | objcopy -O binary | 빌드 결과 | ELF에서 생성됐는지 확인 |
FAILURE PATH
빌드 단계별 실패 지점
| # | 조건 | 관찰되는 증상 | 먼저 볼 단계 |
|---|---|---|---|
| 01 | MODULE_DEPS 누락 | 필요한 module의 object가 link 입력에서 빠져 undefined symbol이 날 수 있다 | recurse.mk 포함 목록 |
| 02 | source 목록·compile 오류 | 개별 *.o가 생성되지 않거나 ld -r prerequisite가 실패한다 | compile.mk, MODULE_OBJS |
| 03 | linker script·symbol 오류 | lk.elf link가 실패하거나 map의 section 배치가 예상과 다르다 | build.mk link 명령과 map |
실패를 runtime 초기화 실패로 해석하기 전에 *.o → *.mod.o → lk.elf → lk.bin 중 마지막으로 만들어진 파일과 build log를 확인한다.
EVIDENCE
빌드 결과에서 확인할 증거
다음 명령은 해당 project가 이미 빌드된 환경에서 산출물을 점검하는 예다. 실제 build 디렉터리와 툴체인 접두사는 선택한 project에 맞춘다.
| # | 목적 | 명령 또는 파일 | 판정 기준 |
|---|---|---|---|
| 01 | 선택 결과 | make <project> -j1 출력 | PROJECT, TARGET, PLATFORM, ARCH와 included module 확인 |
| 02 | source 목록 | build-<project>/srcfiles.txt | 선택된 source가 목록에 있는지 확인 |
| 03 | module object | build-<project>/**/*.mod.o | 예상 module별 ld -r 결과가 있는지 확인 |
| 04 | 최종 link | build-<project>/lk.elf.map | *.mod.o와 section·symbol의 위치 확인 |
| 05 | 바이너리 변환 | build-<project>/lk.elf, lk.bin | ELF 뒤 objcopy -O binary 산출물 확인 |
LAB
직접 확인할 실험
- 01선택한 project의 module 목록 기록
make <project> -j1의PROJECT/TARGET/PLATFORM/ARCH와including ...출력을 모아MODULE_DEPS로 추가된 module을 표시한다. - 02source에서 module object로 역추적
srcfiles.txt의 source 하나를 골라 대응*.c.o또는*.S.o와 module의*.mod.o를 찾는다.make/compile.mk와make/module.mk의 규칙을 대조한다. - 03ELF link와 binary 변환 대조
lk.elf.map에서 module object와 section을 찾고,build.mk의$(OUTELF)·$(OUTBIN)target 순서를 확인한다.lk.bin에 ELF symbol table이 있다고 가정하지 않는다.
PRIMARY REFERENCES