openwrt subdir函数分析
一. 前言
subdir严格来说是一个命令包,本文接下来都以函数称呼。openwrt的subdir函数非常重要,它位于openwrt/include/subdir.mk文件下,tools,toolchain,target和package模块的编译都使用到了subdir,如下:
openwrt/tools/Makefile:
curdir:=tools
......$(eval $(call subdir,$(curdir)))
openwrt/toolchain/Makefile:
curdir:=toolchain
.....$(eval $(call subdir,$(curdir)))
openwrt/package/Makefile和openwrt/target/Makefile也是一样的格式,就不举例了。接下来大致分析下subdir函数的工作原理。
二. subdir分析
subdir位于openwrt/include/subdir.mk里面,源码如下:
# Parameters: <subdir>
define subdir$(call warn,$(1),d,D $(1))$(foreach bd,$($(1)/builddirs),$(call warn,$(1),d,BD $(1)/$(bd))$(foreach target,$(SUBTARGETS) $($(1)/subtargets),$(foreach btype,$(buildtypes-$(bd)),$(call warn_eval,$(1)/$(bd),t,T,$(1)/$(bd)/$(btype)/$(target): $(if $(NO_DEPS)$(QUILT),,$($(1)/$(bd)/$(btype)/$(target)) $(call $(1)//$(btype)/$(target),$(1)/$(bd)/$(btype))))$(call log_make,$(1)/$(bd),$(target),$(btype),$(filter-out __default,$(variant))) \\$(if $(findstring $(bd),$($(1)/builddirs-ignore-$(btype)-$(target))), || $(call ERROR,$(1), ERROR: $(1)/$(bd) [$(btype)] failed to build.))$(if $(call diralias,$(bd)),$(call warn_eval,$(1)/$(bd),l,T,$(1)/$(call diralias,$(bd))/$(btype)/$(target): $(1)/$(bd)/$(btype)/$(target))))$(call warn_eval,$(1)/$(bd),t,T,$(1)/$(bd)/$(target): $(if $(NO_DEPS)$(QUILT),,$($(1)/$(bd)/$(target)) $(call $(1)//$(target),$(1)/$(bd))))$(foreach variant,$(if $(BUILD_VARIANT),$(BUILD_VARIANT),$(if $(strip $($(1)/$(bd)/variants)),$($(1)/$(bd)/variants),$(if $($(1)/$(bd)/default-variant),$($(1)/$(bd)/default-variant),__default))),$(if $(BUILD_LOG),@mkdir -p $(BUILD_LOG_DIR)/$(1)/$(bd)/$(filter-out __default,$(variant)))$(if $($(1)/autoremove),$(call rebuild_check,$(1)/$(bd),$(target),,$(filter-out __default,$(variant))))$(call log_make,$(1)/$(bd),$(target),,$(filter-out __default,$(variant))) \\$(if $(findstring $(bd),$($(1)/builddirs-ignore-$(target))), || $(call ERROR,$(1), ERROR: $(1)/$(bd) failed to build$(if $(filter-out __default,$(variant)), (build variant: $(variant))).)))$(if $(PREREQ_ONLY)$(DUMP_TARGET_DB),,# aliases$(if $(call diralias,$(bd)),$(call warn_eval,$(1)/$(bd),l,T,$(1)/$(call diralias,$(bd))/$(target): $(1)/$(bd)/$(target))))))$(foreach target,$(SUBTARGETS) $($(1)/subtargets),$(call subtarget,$(1),$(target)))
endef
分析之前,我们假设我们当前在编译tools,并以tools下的bison为例。
接下来,我将逐行分析源码:
$(call warn,$(1),d,D $(1))
该行调用了warn函数,warn函数在openwrt/include/debug.mk中,这句用于调试,可忽略。
$(foreach bd,$($(1)/builddirs),
......
)
该行foreach函数结束的括号为subdir函数的倒数第三行的括号。因为$(1)表示tools,所以展开为$(foreach bd,$(tools/builddirs)),从分析tools/Makefile可知,tools/builddirs的值如下:
gmp mpfr mpc libelf m4 libtool autoconf automake flex bison pkg-config sed mklibs sstrip make-ext4fs e2fsprogs mtd-utils mkimage firmware-utils patch-image patch quilt yaffs2 flock padjffs2 mm-macros missing-macros xz cmake scons bc findutils gengetopt patchelf lzma squashfs4 wrt350nv2-builder upslug2 upx qemu elftosb mtools dosfstools lzma-old squashfs b43-tools ppl cloog sparse
所以,bd依次为以上各个工具的名称。
$(call warn,$(1),d,BD $(1)/$(bd))
该行是调试信息,也可暂时跳过。
$(foreach target,$(SUBTARGETS) $($(1)/subtargets),
......
)
该行foreach函数结束的括号为subdir函数的倒数第四行的括号。由于SUBTARGETS:=$(DEFAULT_SUBDIR_TARGETS),而DEFAULT_SUBDIR_TARGETS的定义在openwrt/rules.mk里面,如下:
DEFAULT_SUBDIR_TARGETS:=clean download prepare compile update refresh prereq dist distcheck configure check check-depends
由于tools/subtargets没有定义,所以为空。所以该行代码展开如下:
$(foreach target,clean download prepare compile update refresh prereq dist distcheck configure check check-depends,
......
)
target依次为clean,download直到check-depends。
$(foreach btype,$(buildtypes-$(bd)),
......
)
此处,bd以bison为例,展开为$(foreach btype,$(buildtypes-bison)),由于buildtypes-bison未定义,所以此处foreach函数展开为空。
注意:在openwrt/tmp/.packageinfo文件中,拥有Build-Types的字段,该package的$(buildtype-$(package))不为空,具体机制后续分析。
$(call warn_eval,$(1)/$(bd),t,T,$(1)/$(bd)/$(target): $(if $(NO_DEPS)$(QUILT),,$($(1)/$(bd)/$(target)) $(call $(1)//$(target),$(1)/$(bd))))
warn_eval函数的定义在openwrt/include/debug.mk文件中,如下:
define warn_eval
$(call warn,$(1),$(2),$(3) $(4))
$(4)
endef
warn_eval函数是由warn函数和第四个参数组成,所以这里只需关心第四个参数即可。NO_DEPS和QUILT未定义,所以,整句代码展开为如下:
tools/bison/compile: $(tools/bison/compile) $(call tools//compile,tools/bison)
分析openwrt/tools/Makefile可知,tools/bison/compile=tools/flex/install tools/patch/install。tools//compile=$(STAGING_DIR)/.prepared $(STAGING_DIR_HOST)/.prepared。STAGING_DIR=openwrt/staging_dir/target-mipsel_24kc_musl/,STAGING_DIR_HOST=openwrt/staging_dir/host。注意,STAGING_DIR和STAGING_DIR_HOST都是绝对路径。所以,整句展开为,如下:
tools/bison/compile: tools/flex/install tools/patch/install openwrt/staging_dir/target-mipsel_24kc_musl openwrt/staging_dir/host
这里表示,在编译bison之前,需要先编译flex和patch,并且staging_dir/target_xxx和staging_dir/host存在。
$(foreach variant,$(if $(BUILD_VARIANT),$(BUILD_VARIANT),$(if $(strip $($(1)/$(bd)/variants)),$($(1)/$(bd)/variants),$(if $($(1)/$(bd)/default-variant),$($(1)/$(bd)/default-variant),__default))),
......
)
此处,BUILD_VARIANT为空,所以此处展开为:
$(foreach variant, $(if $(strip $(tools/bison/variants)),$(tools/bison/variants),$(if tools/bison/default-variant),$(tools/bison/default-variant),default))
上面代码表示,如果tools/bison/variants有定义,则取tools/bison/variants变量的值,否则,查看tools/bison/default-variant变量是否有值,如果没有则取__default,对于bison,则取__default。
$(if $(BUILD_LOG),@mkdir -p $(BUILD_LOG_DIR)/$(1)/$(bd)/$(filter-out __default,$(variant)))
BUILD_LOG在rule.mk中定义,由CONFIG_BUILD_LOG变量控制,由于CONFIG_BUILD_LOG没有定义,则此行代码忽略。
$(if $($(1)/autoremove),$(call rebuild_check,$(1)/$(bd),$(target),,$(filter-out __default,$(variant))))
bison/autoremove未定义,则此行代码不执行。
$(call log_make,$(1)/$(bd),$(target),,$(filter-out __default,$(variant)))
展开为,如下:
$(call log_make,tools/bison,compile,,)
log_make定义如下:
log_make = \\$(if $(call debug,$(1),v),,@)+ \\$(if $(BUILD_LOG), \\set -o pipefail; \\mkdir -p $(BUILD_LOG_DIR)/$(1)$(if $(4),/$(4));) \\$(SCRIPT_DIR)/time.pl "time: $(1)$(if $(4),/$(4))/$(if $(3),$(3)-)$(2)" \\$$(SUBMAKE) $(subdir_make_opts) $(if $(3),$(3)-)$(2) \\$(if $(BUILD_LOG),SILENT= 2>&1 | tee $(BUILD_LOG_DIR)/$(1)$(if $(4),/$(4))/$(if $(3),$(3)-)$(2).txt)
debug函数先不管,由于BUILD_LOG未定义,time.pl处理先不管。subdir_make_opts定义为
subdir_make_opts = \\-r -C $(1) \\BUILD_SUBDIR="$(1)" \\BUILD_VARIANT="$(4)"
所以,整行代码展开为:
make -r -C tools/bison compile
三. 总结
subdir总的来说就是使用了一个双层的foreach循环,将所有的bd都加上target的所有目标,为每一个不管是tools,toolchain,package还是target,都建立完整的目标和依赖关系。最终编译完整个工程。