OpenWrt Makefile 整体分析

90 阅读 0 评论 60 点赞

我是靠谱客的博主乐观音响，最近开发中收集的这篇文章主要介绍OpenWrt Makefile 整体分析，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

分析版本: svn://svn.openwrt.org.cn/openwrt/branches/backfire

OpenWrt基本结构
–target/linux/ 目录里面是各平台(arch)的相关代码
–target/linux/ /config 文件的配置文件
–package 目录里面包含了我们在配置文件里面设定的所有编译好的软件包
–scripts/feeds update 来对软件包进行更新
–scirpts/feeds search X 查找软件包X
–package/symlinks 估计意思是更新软件源之类的

=========================我是分割线=================
==以下部分参考：http://www.right.com.cn/forum/thread-73443-1-1.html===
=======================================================
OpenWrt的主Makefile文件只有100行，可以简单分为三部分，1~17行为前导部分，19~31为首次执行部分，33~101为再次执行部分。

前导部分
CURDIR为make默认变量，默认值为当前目录。
前导部分主要把变量TOPDIR赋值为当前目录，把变量LC_ALL、LANG赋值为C，并使用变量延伸指示符export，把上述三个变量延伸到下层Makefile。
使用文件使用指示符include引入$(TOPDIR)/include/host.mk。在OpenWrt的主Makefile文件使用了多次include指示符，说明主Makefile文件被拆分成多个文件，被拆分的文件放在不同的目录。拆分的目的是明确各部分的功能，而且增加其灵活性。
在前导部分比较费解的是使用world目标，在makefile中基本规则为：
TARGETS : PREREQUISITES
COMMAND
…
即makefile规则由目标、依赖、命令三部分组成，在OpenWrt的主Makefile文件的第一个目标world没有依赖和命令。它主要起到指示当make命令不带目标时所要执行的目标，没有设定依赖和命令部分表明此目标在此后将会有其他依赖关系或命令。world目标的命令需要进一步参考$(TOPDIR)/include/toplevel.mk和主Makefile文件的再次执行部分。

首次执行部分
OPENWRT_BUILD是区分首次执行与再次执行的变量。在首次执行时使用强制赋值指示符override把OPENWRT_BUILD赋值为1，并使用变量延伸指示符export把OPENWRT_BUILD延伸。在OPENWRT_BUILD使用强制赋值指示符override意味着make命令行可能引入OPENWRT_BUILD参数。
引入$(TOPDIR)/include/debug.mk、$(TOPDIR)/include/depends.mk、$(TOPDIR)/include/toplevel.mk三个文件，由于TOPDIR是固定的，所以三个文件也是固定的。其中$(TOPDIR)/include/toplevel.mk的135行%::有效解释首次执行时world目标的规则。

再次执行部分
引入rules.mk、$(INCLUDE_DIR)/depends.mk、$(INCLUDE_DIR)/subdir.mk、target/Makefile、package/Makefile、tools/Makefile、toolchain/Makefile七个文件，rules.mk没有目录名，即引入与主Makefile文件目录相同的rules.mk。在rules.mk定义了INCLUDE_DIR为$(TOPDIR)/include，所以$(INCLUDE_DIR)/depends.mk实际上与首次执行时引入的$(TOPDIR)/include/depends.mk是同一个文件。
四个子目录下的Makefile实际上是不能独立执行。主要利用$(INCLUDE_DIR)/subdir.mk动态建立规则，诸如$(toolchain/stamp-install)目标是靠$(INCLUDE_DIR)/subdir.mk的stampfile函数动态建立。在package/Makefile动态建立了$(package/ stamp-prereq)、$(package/ stamp-cleanup)、$(package/ stamp-compile)、$(package/ stamp-install)、$(package/ stamp-rootfs-prepare)目标。
定义一些使用变量命名的目标，其变量的赋值位置在$(INCLUDE_DIR)/subdir.mk的stampfile函数中。目标只有依赖关系，可能说明其工作顺序，在$(INCLUDE_DIR)/subdir.mk的stampfile函数中有进一步说明其目标执行的命令，并为目标建立一个空文件，即使用变量命名的目标为真实的文件。

定义一些使用固定的目标规则。
其中：clean是清除编译结果的目标，清除$(BUILD_DIR) $(BIN_DIR) $(BUILD_LOG_DIR)三个目录的用意是十分明确。暂时不知道为什么执行make target/linux/clean。
dirclean是删除所有编译过程产生的目录和文件的目标，执行dirclean目标依赖于clean，因此将执行clean目标所执行的命令，然后删除$(STAGING_DIR) $(STAGING_DIR_HOST) $(STAGING_DIR_TOOLCHAIN) $(TOOLCHAIN_DIR) $(BUILD_DIR_HOST) $(BUILD_DIR_TOOLCHAIN)目录，以及删除$(TMP_DIR)目录。上述目录的变量均在rules.mk定义。好像删除staging_dir目录就意味着删除staging_dir目录下的所有子目录，不知道为什么要强调删除$(STAGING_DIR_HOST) $(STAGING_DIR_TOOLCHAIN) $(TOOLCHAIN_DIR)目录。同样删除builde_dir目录就意味着删除builde_dir目录下的所有子目录，不知道为什么要强调删除$(BUILD_DIR_TOOLCHAIN)目录。
tmp/.prereq_packages目标是对所需软件包的预处理。目标依赖于.config，即执行make menuconfig后将会进行一次所需软件包的预处理。不知什么原因在编译前删除tmp目录，执行时无法建立tmp/.prereq_packages文件。
prereq应该是预请求目标，在OpenWrt执行Makefile时好像都要先执行prereq目标。
prepare应该是准备目标，是world依赖的一个伪目标。依赖于文件.config和$(tools/stamp-install) $(toolchain/stamp-install)目标。
world就是编译的目标。依赖于prepare为目标和前面提到的变量命名目标。采用取消隐含规则方式执行package/index目标。package/index目标在package/Makefile的92行定义。
package/symlinks和package/symlinks-install是更新或安装软件包来源的目标，使用$(SCRIPT_DIR)/feeds脚本文件完成。
package/symlinks-clean是清除软件包来源的目标，也是使用$(SCRIPT_DIR)/feeds脚本文件完成。
最后使用伪目标.PHONY说明clean dirclean prereq prepare world package/symlinks package/symlinks-install package/symlinks-clean属于伪目标。通过伪目标说明可以知道可以执行的目标。

===================我是分割线==================
====>Makefile:
TOPDIR:=${CURDIR} #定义直接变量取得当前make的工作目录
LC_ALL:=C
LANG:=C
export TOPDIR LC_ALL LANG #定义直接变量，把变量延伸，使得在包含的mk中也可用

world:
#指示make不带目标时要执行的命令，也就是默认执行的命令，由于其不带规则和依赖，所以表明此目标在此后将会有其他依赖关系或命令，当执行”~$ make”时，即跳转到toplevel.mk执行。======1======

include $(TOPDIR)/include/host.mk #引入文件

ifneq ($(OPENWRT_BUILD),1) #判断是否是首次执行OPENWRT_BUILD在toplevel.mk中定义为0
# XXX: these three lines are normally defined by rules.mk
# but we can’t include that file in this context
empty:=
space:= $(empty) $(empty)
_SINGLE=export MAKEFLAGS=$(space);

override OPENWRT_BUILD=1 #如果是首次执行，使用override强制openwrt_build为1
export OPENWRT_BUILD #延伸openwrt_build变量的使用
include $(TOPDIR)/include/debug.mk #引入文件
include $(TOPDIR)/include/depends.mk
include $(TOPDIR)/include/toplevel.mk
else
include rules.mk #不是首次执行，则引入以下文件
include $(INCLUDE_DIR)/depends.mk
include $(INCLUDE_DIR)/subdir.mk
include target/Makefile
include package/Makefile
include tools/Makefile
include toolchain/Makefile

$(toolchain/stamp-install): $(tools/stamp-install)
$(target/stamp-compile): $(toolchain/stamp-install) $(tools/stamp-install) $(BUILD_DIR)/.prepared
$(package/stamp-cleanup): $(target/stamp-compile)
$(package/stamp-compile): $(target/stamp-compile) $(package/stamp-cleanup)
$(package/stamp-install): $(package/stamp-compile)
$(package/stamp-rootfs-prepare): $(package/stamp-install)
$(target/stamp-install): $(package/stamp-compile) $(package/stamp-install) $(package/stamp-rootfs-prepare)
$(BUILD_DIR)/.prepared: Makefile
@mkdir -p $$(dirname $@)
@touch $@

prepare: $(target/stamp-compile)

clean: FORCE
$(_SINGLE)$(SUBMAKE) target/linux/clean
rm -rf $(BUILD_DIR) $(BIN_DIR) $(BUILD_LOG_DIR)

dirclean: clean
rm -rf $(STAGING_DIR) $(STAGING_DIR_HOST) $(STAGING_DIR_TOOLCHAIN) $(TOOLCHAIN_DIR) $(BUILD_DIR_HOST) $(BUILD_DIR_TOOLCHAIN)
rm -rf $(TMP_DIR)

#处理依赖问题===========9=========
tmp/.prereq_packages: .config
@echo “this is in main Makefile tmp/.prereq_packages”
unset ERROR;
for package in $(sort $(prereq-y) $(prereq-m)); do
$(_SINGLE)$(NO_TRACE_MAKE) -s -r -C package/$$package prereq || ERROR=1;
done;
if [ -n "$$ERROR" ]; then
echo “Package prerequisite check failed.”;
false;
fi
touch $@

# check prerequisites before starting to build

#在toplevel.mk中的prereq目标执行完之后，跳转回到主Makefile文件，执行其prereq目标的规则================8====================
prereq: $(target/stamp-prereq) tmp/.prereq_packages
@echo “this is in main Makefile”

prepare: .config $(tools/stamp-install) $(toolchain/stamp-install)

#当所有的依赖已经准备好之后，开始执行编译==============10=============
world: prepare $(target/stamp-compile) $(package/stamp-cleanup) $(package/stamp-compile) $(package/stamp-install) $(package/stamp-rootfs-prepare) $(target/stamp-install) FORCE
$(_SINGLE)$(SUBMAKE) -r package/index

# update all feeds, re-create index files, install symlinks
package/symlinks:
$(SCRIPT_DIR)/feeds update -a
$(SCRIPT_DIR)/feeds install -a

# re-create index files, install symlinks
package/symlinks-install:
$(SCRIPT_DIR)/feeds update -i
$(SCRIPT_DIR)/feeds install -a

# remove all symlinks, don’t touch ./feeds
package/symlinks-clean:
$(SCRIPT_DIR)/feeds uninstall -a

.PHONY: clean dirclean prereq prepare world package/symlinks package/symlinks-install package/symlinks-clean

endif

=====>./include/toplevel.mk:
RELEASE:=Backfire #为了避免出现循环
SHELL:=/usr/bin/env bash
PREP_MK= OPENWRT_BUILD= QUIET=0

include $(TOPDIR)/include/verbose.mk

ifeq ($(SDK),1)
include $(TOPDIR)/include/version.mk
else
REVISION:=$(shell $(TOPDIR)/scripts/getver.sh) #shell 执行操作系统的命令
endif

OPENWRTVERSION:=$(RELEASE)$(if $(REVISION), ($(REVISION)))
export RELEASE
export REVISION
export OPENWRTVERSION
export IS_TTY=$(shell tty -s && echo 1 || echo 0)
export LD_LIBRARY_PATH:=$(if $(LD_LIBRARY_PATH),$(LD_LIBRARY_PATH):)$(STAGING_DIR_HOST)/lib
export DYLD_LIBRARY_PATH:=$(if $(DYLD_LIBRARY_PATH),$(DYLD_LIBRARY_PATH):)$(STAGING_DIR_HOST)/lib

# prevent perforce from messing with the patch utility
unexport P4PORT P4USER P4CONFIG P4CLIENT

# prevent user defaults for quilt from interfering
unexport QUILT_PATCHES QUILT_PATCH_OPTS

# make sure that a predefined CFLAGS variable does not disturb packages
export CFLAGS=

ifeq ($(FORCE),)
.config scripts/config/conf scripts/config/mconf: tmp/.prereq-build
endif

SCAN_COOKIE?=$(shell echo $$$$)
export SCAN_COOKIE

SUBMAKE:=umask 022; $(SUBMAKE)

prepare-mk: FORCE ;

#依赖于FORCE保证及时目标存在也会执行此命令=================4=============
prepare-tmpinfo: FORCE
mkdir -p tmp/info #-r禁止使用任何隐含规则 -f制定需要执行的文件-j输出规则中的命令 -r命令运行时不输出命令的输出 mkdir –p 一次性创建多层目录
$(_SINGLE)$(NO_TRACE_MAKE) -j1 -r -s -f include/scan.mk SCAN_TARGET=”packageinfo” SCAN_DIR=”package” SCAN_NAME=”package” SCAN_DEPS=”$(TOPDIR)/include/package*.mk $(TOPDIR)/overlay/*/*.mk” SCAN_DEPTH=5 SCAN_EXTRA=”"
$(_SINGLE)$(NO_TRACE_MAKE) -j1 -r -s -f include/scan.mk SCAN_TARGET=”targetinfo” SCAN_DIR=”target/linux” SCAN_NAME=”target” SCAN_DEPS=”profiles/*.mk $(TOPDIR)/include/kernel*.mk $(TOPDIR)/include/target.mk” SCAN_DEPTH=2 SCAN_EXTRA=”" SCAN_MAKEOPTS=”TARGET_BUILD=1″
for type in package target; do
f=tmp/.$${type}info; t=tmp/.config-$${type}.in;
[ "$$t" -nt "$$f" ] || ./scripts/metadata.pl $${type}_config “$$f” > “$$t” || { rm -f “$$t”; echo “Failed to build $$t”; false; break; };
done
./scripts/metadata.pl package_mk tmp/.packageinfo > tmp/.packagedeps || { rm -f tmp/.packagedeps; false; }
touch $(TOPDIR)/tmp/.build

.config: ./scripts/config/conf $(if $(CONFIG_HAVE_DOT_CONFIG),,prepare-tmpinfo)
@+if [ ! -e .config ] || ! grep CONFIG_HAVE_DOT_CONFIG .config >/dev/null; then
#”+”无论如何这些命令都会被执行
[ -e $(HOME)/.openwrt/defconfig ] && cp $(HOME)/.openwrt/defconfig .config;
$(_SINGLE)$(NO_TRACE_MAKE) menuconfig $(PREP_MK);
fi

scripts/config/mconf:
@$(_SINGLE)$(SUBMAKE) -s -C scripts/config all

$(eval $(call rdep,scripts/config,scripts/config/mconf))

scripts/config/conf:
@$(_SINGLE)$(SUBMAKE) -s -C scripts/config conf
#-C 意思就是转到此目录下执行make -s全面禁止命令的显示，跳转到scripts/config下执行此目录下的Makefile文件的conf标签=============4=========

config: scripts/config/conf prepare-tmpinfo FORCE
$< Config.in #$< 描述了所有的依赖

config-clean: FORCE
$(_SINGLE)$(NO_TRACE_MAKE) -C scripts/config clean

defconfig: scripts/config/conf prepare-tmpinfo FORCE
touch .config
$< -D .config Config.in

oldconfig: scripts/config/conf prepare-tmpinfo FORCE
$< -$(if $(CONFDEFAULT),$(CONFDEFAULT),o) Config.in

menuconfig: scripts/config/mconf prepare-tmpinfo FORCE
if [ ! -e .config -a -e $(HOME)/.openwrt/defconfig ]; then
cp $(HOME)/.openwrt/defconfig .config;
fi
$< Config.in

prepare_kernel_conf: .config FORCE

ifeq ($(wildcard staging_dir/host/bin/sed),)
prepare_kernel_conf:
@+$(SUBMAKE) -r tools/sed/install
else
prepare_kernel_conf: ;
endif

kernel_oldconfig: prepare_kernel_conf
$(_SINGLE)$(NO_TRACE_MAKE) -C target/linux oldconfig

kernel_menuconfig: prepare_kernel_conf
$(_SINGLE)$(NO_TRACE_MAKE) -C target/linux menuconfig

#建立其依赖 ===========6==============转到include/prereq-build.mk下执行，主要就是检查各种依赖关系是否已经安装好。
tmp/.prereq-build: include/prereq-build.mk
mkdir -p tmp
rm -f tmp/.host.mk
@$(_SINGLE)$(NO_TRACE_MAKE) -j1 -r -s -f $(TOPDIR)/include/prereq-build.mk prereq 2>/dev/null || {
echo “Prerequisite check failed. Use FORCE=1 to override.”;
false;
}
touch $@

download: .config FORCE
@+$(SUBMAKE) tools/download
@+$(SUBMAKE) toolchain/download
@+$(SUBMAKE) package/download
@+$(SUBMAKE) target/download

clean dirclean: .config
@+$(SUBMAKE) -r $@

#再次找到prereq目标，然后建立其依赖prepare-tmpinfo .config========3=========
prereq:: prepare-tmpinfo .config
@+$(MAKE) -r -s tmp/.prereq-build $(PREP_MK)
#-r 不运行命令，也不输出，仅仅检查目标是否需要更新========5===========
@+$(NO_TRACE_MAKE) -r -s $@ #所有的准备完之后，跳转回主Makefile文件======7=======

#双::号规则允许在多个规则中为同一个目标创建不同命令，NO_TRACE_MAKE在include/verbose.mk中定义为 :=$(MAKE) V=99，PREP_MK在开始定义为0，+代表之后的命令都要执行，也就是表示执行-r禁止使用任何隐含规则-s禁止所有执行命令的显示 $ make prereq =========2=========
%::
@+$(PREP_MK) $(NO_TRACE_MAKE) -r -s prereq
@+$(SUBMAKE) -r $@

help:
cat README

docs docs/compile: FORCE
@$(_SINGLE)$(SUBMAKE) -C docs compile

docs/clean: FORCE
@$(_SINGLE)$(SUBMAKE) -C docs clean

distclean:
rm -rf tmp build_dir staging_dir dl .config* feeds package/feeds package/openwrt-packages bin
@$(_SINGLE)$(SUBMAKE) -C scripts/config clean

ifeq ($(findstring v,$(DEBUG)),)
.SILENT: symlinkclean clean dirclean distclean config-clean download help tmpinfo-clean .config scripts/config/mconf scripts/config/conf menuconfig tmp/.prereq-build tmp/.prereq-package prepare-tmpinfo
endif
.PHONY: help FORCE
.NOTPARALLEL: