U-BootMakefile分析.doc

2.1       U-Boot Makefile分析
2.1.1             U-Boot编译命令
对于mini2440开发板，编译U-Boot需要执行如下的命令：
$ make mini2440_config
$ make all
使用上面的命令编译U-Boot，编译生成的所有文件都保存在源代码目录中。为了保持源代码目录的干净，可以使用如下命令将编译生成的文件输出到一个外部目录，而不是在源代码目录中，下面的2种方法都将编译生成的文件输出到 /tmp/build目录：
$ export BUILD_DIR=/tmp/build
$ make mini2440_config
$ make all
或
$ make O=/tmp/build mini2440_config （注意是字母O，而不是数字0）
$ make all

为了简化分析过程，方便读者理解，这里主要针对第一种编译方式（目标输出到源代码所在目录）进行分析。
2.1.2             U-Boot配置、编译、连接过程
U-Boot开头有一些跟主机软硬件环境相关的代码，在每次执行make命令时这些代码都被执行一次。

1.      U-Boot 配置过程
（1）定义主机系统架构
HOSTARCH := $(shell uname -m | \
sed -e s/i.86/i386/ \
-e s/sun4u/sparc64/ \
-e s/arm.*/arm/ \
-e s/sa110/arm/ \
-e s/powerpc/ppc/ \
-e s/ppc64/ppc/ \
-e s/macppc/ppc/)
“sed –e”表示后面跟的是一串命令脚本，而表达式“s/abc/def/”表示要从标准输入中，查找到内容为“abc”的，然后替换成“def”。其中“abc”表达式用可以使用“.”作为通配符。
命令“uname –m”将输出主机CPU的体系架构类型。作者的电脑使用Intel Core2系列的CPU，因此“uname –m”输出“i686”。 “i686”可以匹配命令“sed -e s/i.86/i386/”中的“i.86”，因此在作者的机器上执行Makefile，HOSTARCH将被设置成“i386” 。
（2）定义主机操作系统类型
HOSTOS := $(shell uname -s | tr '[:upper:]' '[:lower:]' | \
sed -e 's/\(cygwin\).*/cygwin/')
“uname –s”输出主机内核名字，作者使用Linux发行版Ubuntu9.10，因此“uname –s”结果是“Linux”。“tr '[:upper:]' '[:lower:]'”作用是将标准输入中的所有大写字母转换为响应的小写字母。因此执行结果是将HOSTOS 设置为“linux”。
（3）定义执行shell脚本的shell
# Set shell to bash if possible, otherwise fall back to sh
SHELL := $(shell if [ -x "$$BASH" ]; then echo $$BASH; \
else if [ -x /bin/bash ]; then echo /bin/bash \
else echo sh; fi; fi)
"$$BASH"的作用实质上是生成了字符串“$BASH”（前一个$号的作用是指明第二个$是普通的字符）。若执行当前Makefile的shell中定义了“$BASH”环境变量，且文件“$BASH”是可执行文件，则SHELL的值为“$BASH”。否则，若“/bin/bash”是可执行文件，则SHELL值为“/bin/bash”。若以上两条都不成立，则将“sh”赋值给SHELL变量。
由于作者的机器安装了bash shell，且shell默认环境变量中定义了“$BASH”，因此SHELL 被设置为$BASH 。
（4）设定编译输出目录
ifdef O
ifeq ("$(origin O)", "command line")
BUILD_DIR := $(O)
endif
endif
函数$( origin, variable) 输出的结果是一个字符串，输出结果由变量variable定义的方式决定，若variable在命令行中定义过，则origin函数返回值为"command line"。假若在命令行中执行了“export BUILD_DIR=/tmp/build”的命令，则“$(origin O)”值为“command line”，而BUILD_DIR被设置为“/tmp/build”。
ifneq ($(BUILD_DIR),)
saved-output := $(BUILD_DIR)

# Attempt to create a output directory.
$(shell [ -d ${BUILD_DIR} ] || mkdir -p ${BUILD_DIR})
若${BUILD_DIR}表示的目录没有定义，则创建该目录。
# Verify if it was successful.
BUILD_DIR := $(shell cd $(BUILD_DIR) && /bin/pwd)
$(if $(BUILD_DIR),,$(error output directory "$(saved-output)" does not exist))
endif # ifneq ($(BUILD_DIR),)
若$(BUILD_DIR)为空，则将其赋值为当前目录路径（源代码目录）。并检查$(BUILD_DIR)目录是否存在。
OBJTREE := $(if $(BUILD_DIR),$(BUILD_DIR),$(CURDIR))
SRCTREE := $(CURDIR)
TOPDIR := $(SRCTREE)
LNDIR := $(OBJTREE)
… …
MKCONFIG := $(SRCTREE)/mkconfig
… …
ifneq ($(OBJTREE),$(SRCTREE))
obj := $(OBJTREE)/
src := $(SRCTREE)/
else
obj :=
src :=
endif
CURDIR变量指示Make当前的工作目录，由于当前Make在U-Boot顶层目录执行Makefile，因此CURDIR此时就是U-Boot顶层目录。
执行完上面的代码后， SRCTREE，src变量就是U-Boot代码顶层目录，而OBJTREE，obj变量就是输出目录，若没有定义BUILD_DIR环境变量，则SRCTREE，src变量与OBJTREE，obj变量都是U-Boot源代码目录。而MKCONFIG则表示U-Boot根目录下的mkconfig脚本。
2.      make mini2440_config命令执行过程
下面分析命令“make mini2440_config”执行过程，为了简化分析过程这里主要分析将编译目标输出到源代码目录的情况。
mini2440_config : unconfig
@$(MKCONFIG) $(@:_config=) arm arm920t mini2440 samsung s3c24x0
其中的依赖“unconfig”定义如下：
unconfig:
@rm -f $(obj)include/config.h $(obj)include/config.mk \
$(obj)board/*/config.tmp $(obj)board/*/*/config.tmp \
$(obj)include/autoconf.mk $(obj)include/autoconf.mk.dep
其中“@”的作用是执行该命令时不在shell显示。“obj”变量就是编译输出的目录，因此“unconfig”的作用就是清除上次执行make *_config命令生成的配置文件（如include/config.h，include/config.mk等）。
$(MKCONFIG)在上面指定为“$(SRCTREE)/mkconfig”。$(@:_config=)为将传进来的所有参数中的_config替换为空（其中“@”指规则的目标文件名，在这里就是“mini2440_config ”。$(text:patternA=patternB)，这样的语法表示把text变量每一个元素中结尾的patternA的文本替换为patternB，然后输出） 。因此$(@:_config=)的作用就是将mini2440_config中的_config去掉，得到mini2440。
因此“@$(MKCONFIG) $(@:_config=) arm arm920t mini2440 samsung s3c24x0”实际上就是执行了如下命令：
./mkconfig mini2440 arm arm920t mini2440 samsung s3c24x0
即将“mini2440 arm arm920t mini2440 samsung s3c24x0”作为参数传递给当前目录下的mkconfig脚本执行。
在mkconfig脚本中给出了mkconfig的用法：
# Parameters: Target Architecture CPU Board [VENDOR] [SOC]
因此传递给mkconfig的参数的意义分别是：
mini2440：Target（目标板型号）
arm：Architecture （目标板的CPU架构）
arm920t：CPU （具体使用的CPU型号）
mini2440：Board
samsung：VENDOR（生产厂家名）
s3c24x0：SOC
下面再来看看mkconfig脚本到底做了什么。
（1）确定开发板名称BOARD_NAME
在mkconfig脚本中有如下代码：
APPEND=no # no表示创建新的配置文件，yes表示追加到配置文件中
BOARD_NAME="" # Name to print in make output
TARGETS=""

while [ $# -gt 0 ] ; do
case "$1" in
--) shift ; break ;;
-a) shift ; APPEND=yes ;;
-n) shift ; BOARD_NAME="${1%%_config}" ; shift ;;
-t) shift ; TARGETS="`echo $1 | sed 's:_: :g'` ${TARGETS}" ; shift ;;
*) break ;;
esac
done

[ "${BOARD_NAME}" ] || BOARD_NAME="$1"
环境变量$#表示传递给脚本的参数个数，这里的命令有6个参数，因此$#是6 。shift的作用是使$1=$2，$2=$3，$3=$4….，而原来的$1将丢失。因此while循环的作用是，依次处理传递给mkconfig脚本的选项。由于我们并没有传递给mkconfig任何的选项，因此while循环中的代码不起作用。
最后将BOARD_NAME的值设置为$1的值，在这里就是“mini2440”。
（2）检查参数合法性
[ $# -lt 4 ] && exit 1
[ $# -gt 6 ] && exit 1

if [ "${ARCH}" -a "${ARCH}" != "$2" ]; then
echo "Failed: \ARCH=${ARCH}, should be '$2' for ${BOARD_NAME}" 1>&2
exit 1
fi
上面代码的作用是检查参数个数和参数是否正确，参数个数少于4个或多于6个都被认为是错误的。
（3）创建到目标板相关的目录的链接
#
# Create link to architecture specific headers
#
if [ "$SRCTREE" != "$OBJTREE" ] ; then #若编译目标输出到外部目录，则下面的代码有效
mkdir -p ${OBJTREE}/include
mkdir -p ${OBJTREE}/include2
cd ${OBJTREE}/include2
rm -f asm
ln -s ${SRCTREE}/include/asm-$2 asm
LNPREFIX="
cd ../include
rm -rf asm-$2
rm -f asm
mkdir asm-$2
ln -s asm-$2 asm
else
cd ./include
rm -f asm
ln -s asm-$2 asm
fi
若将目标文件设定为输出到源文件所在目录，则以上代码在include目录下建立了到asm-arm目录的符号链接asm。其中的ln -s asm-$2 asm即ln -s asm-arm asm 。
rm -f asm-$2/arch

if [ -z "$6" -o "$6" = "NULL" ] ; then
ln -s ${LNPREFIX}arch-$3 asm-$2/arch
else
ln -s ${LNPREFIX}arch-$6 asm-$2/arch
fi
建立符号链接include/asm-arm/arch ，若$6（SOC）为空，则使其链接到include/asm-arm/arch-arm920t目录，否则就使其链接到include/asm-arm/arch-s3c24x0目录。（事实上include/asm-arm/arch-arm920t并不存在，因此$6是不能为空的，否则会编译失败）
if [ "$2" = "arm" ] ; then
rm -f asm-$2/proc
ln -s ${LNPREFIX}proc-armv asm-$2/proc
fi
若目标板是arm架构，则上面的代码将建立符号连接include/asm-arm/proc，使其链接到目录proc-armv目录。
建立以上的链接的好处：编译U-Boot时直接进入链接文件指向的目录进行编译，而不必根据不同开发板来选择不同目录。
（4）构建include/configmk文件
#
# Create include file for Make
#
echo "ARCH = $2" > config.mk
echo "CPU = $3" >> config.mk
echo "BOARD = $4" >> config.mk

[ "$5" ] && [ "$5" != "NULL" ] && echo "VENDOR = $5" >> config.mk

[ "$6" ] && [ "$6" != "NULL" ] && echo "SOC = $6" >> config.mk
上面代码将会把如下内容写入文件inlcude/config.mk文件：
ARCH = arm
CPU = arm920t
BOARD = mini2440
VENDOR = samsung
SOC = s3c24x0
（5）指定开发板代码所在目录
# Assign board directory to BOARDIR variable
if [ -z "$5" -o "$5" = "NULL" ] ; then
BOARDDIR=$4
else
BOARDDIR=$5/$4
fi
以上代码指定board目录下的一个目录为当前开发板专有代码的目录。若$5（VENDOR）为空则BOARDDIR设置为$4（BOARD），否则设置为$5/$4（VENDOR/BOARD）。在这里由于$5不为空，因此BOARDDIR被设置为samsung/mini2440 。
（6）构建include/config.h文件
#
# Create board specific header file
#
if [ "$APPEND" = "yes" ] # Append to existing config file
then
echo >> config.h
else
> config.h # Create new config file
fi
echo "/* Automatically generated - do not edit */" >>config.h

for i in ${TARGETS} ; do
echo "#define CONFIG_MK_${i} 1" >>config.h ;
done

cat << EOF >> config.h
#define CONFIG_BOARDDIR board/$BOARDDIR
#include
#include
#include
EOF
exit 0
这里的“cat << EOF >> config.h”表示将输入的内容追加到config.h中，直到出现“EOF”这样的标识为止。
若APPEND为no，则创建新的include/config.h文件。若APPEND为yes，则将新的配置内容追加到include/config.h文件后面。由于APPEND的值保持“no”，因此config.h被创建了，并添加了如下的内容：
/* Automatically generated - do not edit */
#define CONFIG_BOARDDIR board/samsung/mini2440
#include
#include
#include
下面总结命令make mini2440_config执行的结果（仅针对编译目标输出到源代码目录的情况）：
（1）    创建到目标板相关的文件的链接
ln -s asm-arm asm
ln -s arch-s3c24x0 asm-arm/arch
ln -s proc-armv asm-arm/proc
（2）    创建include/config.mk文件，内容如下所示：
ARCH = arm
CPU = arm920t
BOARD = mini2440
VENDOR = samsung
SOC = s3c24x0
（3）    创建与目标板相关的文件include/config.h，如下所示：
/* Automatically generated - do not edit */
#define CONFIG_BOARDDIR board/samsung/mini2440
#include
#include
#include
3      make all命令执行过程
若没有执行过“make _config”命令就直接执行“make all”命令则会出现如下的才错误信息，然后停止编译：
System not configured - see README
U-Boot是如何知道用户没有执行过“make _config”命令的呢？阅读U-Boot源代码就可以发现了，Makefile中有如下代码：
ifeq ($(obj)include/config.mk,$(wildcard $(obj)include/config.mk)) # config.mk存在

all:
sinclude $(obj)include/autoconf.mk.dep
sinclude $(obj)include/autoconf.mk
… …
else # config.mk不存在
… …
@echo "System not configured - see README" >&2
@ exit 1
… …
endif # config.mk
若include/config.mk 文件存在，则$(wildcard $(obj)include/config.mk) 命令执行的结果是“$(obj)include/config.mk”展开的字符串，否则结果为空。由于include/config.mk是“make _config”命令执行过程生成的，若从没有执行过“make _config”命令则include/config.mk必然不存在。因此Make就执行else分支的代码，在输出“System not configured - see README”的信息后就返回了。
下面再来分析“make all”命令正常执行的过程，在Makefile中有如下代码：
（1）include/autoconf.mk生成过程
all:
sinclude $(obj)include/autoconf.mk.dep
sinclude $(obj)include/autoconf.mk
include/autoconf.mk文件中是与开发板相关的一些宏定义，在Makefile执行过程中需要根据某些宏来确定执行哪些操作。下面简要分析include/autoconf.mk生成的过程，include/autoconf.mk生成的规则如下：
$(obj)include/autoconf.mk: $(obj)include/config.h
@$(XECHO) Generating $@ ; \
set -e ; \
: Extract the config macros ; \
$(CPP) $(CFLAGS) -DDO_DEPS_ONLY -dM include/common.h | \
sed -n -f tools/scripts/define2mk.sed > $@.tmp && \
mv $@.tmp $@
include/autoconf.mk依赖于make _config 命令生成的include/config.h。因此执行make _config命令后再执行make all将更新include/autoconf.mk。
编译选项“-dM”的作用是输出include/commonh中定义的所有宏。根据上面的规则，编译器提取include/common.h中定义的宏，然后输出给tools/scripts/define2mk.sed脚本处理，处理的结果就是include/autoconf.mk文件。其中tools/scripts/define2mk.sed脚本的主要完成了在include/common.h中查找和处理以“CONFIG_”开头的宏定义的功能。
include/common.h文件包含了include/config.h文件，而include/config.h文件又包含了config_defaults.h，configs/mini2440.h，asm/config.h文件。因此include/autoconf.mk实质上就是config_defaults.h，configs/mini2440.h，asm/config.h三个文件中“CONFIG_”开头的有效的宏定义的集合。
下面接着分析Makefile的执行。
# load ARCH, BOARD, and CPU configuration
include $(obj)include/config.mk
export ARCH CPU BOARD VENDOR SOC
将make mini2440_config命令生成的include/config.mk包含进来。
# 若主机架构与开发板结构相同，就使用主机的编译器，而不是交叉编译器
ifeq ($(HOSTARCH),$(ARCH))
CROSS_COMPILE ?=
endif
若主机与目标机器体系架构相同，则使用gcc编译器而不是交叉编译器。
# load other configuration
include $(TOPDIR)/config.mk
最后将U-Boot顶层目录下的config.mk文件包含进来，该文件包含了对编译的一些设置。下面对U-Boot顶层目录下的config.mk文件进行分析：
（2）config.mk文件执行过程
1设置obj与src
在U-Boot顶层目录下的config.mk文件中有如下代码：
ifneq ($(OBJTREE),$(SRCTREE))
ifeq ($(CURDIR),$(SRCTREE))
dir :=
else
dir := $(subst $(SRCTREE)/,,$(CURDIR))
endif

obj := $(if $(dir),$(OBJTREE)/$(dir)/,$(OBJTREE)/)
src := $(if $(dir),$(SRCTREE)/$(dir)/,$(SRCTREE)/)

$(shell mkdir -p $(obj))
else
obj :=
src :=
endif
由于目标输出到源代码目录下，因此执行完上面的代码后，src和obj都是空。
2设置编译选项
PLATFORM_RELFLAGS =
PLATFORM_CPPFLAGS = #编译选项
PLATFORM_LDFLAGS = #连接选项
用这3个变量表示交叉编译器的编译选项，在后面Make会检查交叉编译器支持的编译选项，然后将适当的选项添加到这3个变量中。
#
# Option checker (courtesy linux kernel) to ensure
# only supported compiler options are used
#
cc-option = $(shell if $(CC) $(CFLAGS) $(1) -S -o /dev/null -xc /dev/null \
> /dev/null 2>&1; then echo "$(1)"; else echo "$(2)"; fi ;)
变量CC和CFLAGS在后面的代码定义为延时变量，其中的CC即arm-linux-gcc。函数cc-option用于检查编译器CC是否支持某选项。将2个选项作为参数传递给cc-option函数，该函数调用CC编译器检查参数1是否支持，若支持则函数返回参数1，否则返回参数2 （因此CC编译器必须支持参数1或参数2，若两个都不支持则会编译出错）。可以像下面这样调用cc-option函数，并将支持的选项添加到FLAGS中：
FLAGS +=$(call cc-option,option1,option2)
3指定交叉编译工具
#
# Include the make variables (CC, etc...)
#
AS = $(CROSS_COMPILE)as
LD = $(CROSS_COMPILE)ld
CC = $(CROSS_COMPILE)gcc
CPP = $(CC) -E
AR = $(CROSS_COMPILE)ar
NM = $(CROSS_COMPILE)nm
LDR = $(CROSS_COMPILE)ldr
STRIP = $(CROSS_COMPILE)strip
OBJCOPY = $(CROSS_COMPILE)objcopy
OBJDUMP = $(CROSS_COMPILE)objdump
RANLIB = $(CROSS_COMPILE)RANLIB
对于arm开发板，其中的CROSS_COMPILE在lib_arm/config.mk文件中定义：
CROSS_COMPILE ?= arm-linux-
因此以上代码指定了使用前缀为“arm-linux-”的编译工具，即arm-linux-gcc，arm-linux-ld等等。
4包含与开发板相关的配置文件
# Load generated board configuration
sinclude $(OBJTREE)/include/autoconf.mk

ifdef ARCH
sinclude $(TOPDIR)/lib_$(ARCH)/config.mk # include architecture dependend rules
endif
$(ARCH)的值是“arm”，因此将“lib_arm/config.mk”包含进来。lib_arm/config.mk脚本指定了交叉编译器，添加了一些跟CPU架构相关的编译选项，最后还指定了cpu/arm920t/u-boot.lds为U-Boot的连接脚本。
ifdef CPU
sinclude $(TOPDIR)/cpu/$(CPU)/config.mk # include CPU specific rules
endif
$(CPU)的值是“arm920t”，因此将“cpu/arm920t/config.mk”包含进来。这个脚本主要设定了跟arm920t处理器相关的编译选项。
ifdef SOC
sinclude $(TOPDIR)/cpu/$(CPU)/$(SOC)/config.mk # include SoC specific rules
endif
$(SOC)的值是s3c24x0，因此Make程序尝试将cpu/arm920t/s3c24x0/config.mk包含进来，而这个文件并不存在，但是由于用的是“sinclude”命令，所以并不会报错。
ifdef VENDOR
BOARDDIR = $(VENDOR)/$(BOARD)
else
BOARDDIR = $(BOARD)
endif
$(BOARD)的值是mini2440，VENDOR的值是samsung，因此BOARDDIR的值是samsung/mini2440。BOARDDIR变量表示开发板特有的代码所在的目录。
ifdef BOARD
sinclude $(TOPDIR)/board/$(BOARDDIR)/config.mk # include board specific rules
endif
Make将“board/samsung/mini2440/config.mk”包含进来。该脚本只有如下的一行代码：
TEXT_BASE = 0x33F80000
U-Boot编译时将使用TEXT_BASE作为代码段连接的起始地址。
LDFLAGS += -Bstatic -T $(obj)u-boot.lds $(PLATFORM_LDFLAGS)
ifneq ($(TEXT_BASE),)
LDFLAGS += -Ttext $(TEXT_BASE)
endif
执行完以上代码后，LDFLAGS中包含了“-Bstatic -T u-boot.lds ”和“-Ttext 0x33F80000”的字样。
5指定隐含的编译规则
# Allow boards to use custom optimize flags on a per dir/file basis
BCURDIR := $(notdir $(CURDIR))
$(obj)%.s: %.S
$(CPP) $(AFLAGS) $(AFLAGS_$(@F)) $(AFLAGS_$(BCURDIR)) -o $@ $<
$(obj)%.o: %.S
$(CC) $(AFLAGS) $(AFLAGS_$(@F)) $(AFLAGS_$(BCURDIR)) -o $@ $< -c
$(obj)%.o: %.c
$(CC) $(CFLAGS) $(CFLAGS_$(@F)) $(CFLAGS_$(BCURDIR)) -o $@ $< -c
$(obj)%.i: %.c
$(CPP) $(CFLAGS) $(CFLAGS_$(@F)) $(CFLAGS_$(BCURDIR)) -o $@ $< -c
$(obj)%.s: %.c
$(CC) $(CFLAGS) $(CFLAGS_$(@F)) $(CFLAGSBCURDIR)) -o $@ $< -c -S
例如：根据以上的定义，以“.s”结尾的目标文件将根据第一条规则由同名但后缀为“.S”的源文件来生成，若不存在“.S”结尾的同名文件则根据最后一条规则由同名的“.c”文件生成。
下面回来接着分析Makefile的内容：
# U-Boot objects....order is important (i.e. start must be first)

OBJS = cpu/$(CPU)/start.o
LIBS += cpu/$(CPU)/lib$(CPU).a
ifdef SOC
LIBS += cpu/$(CPU)/$(SOC)/lib$(SOC).a
endif
ifeq ($(CPU),ixp)
LIBS += cpu/ixp/npe/libnpe.a
endif
LIBS += lib_$(ARCH)/lib$(ARCH).a
LIBS += fs/cramfs/libcramfs.a fs/fat/libfat.a fs/fdos/libfdos.a fs/jffs2/libjffs2.a \
fs/reiserfs/libreiserfs.a fs/ext2/libext2fs.a fs/yaffs2/libyaffs2.a \
fs/ubifs/libubifs.a
… …
LIBS += common/libcommon.a
LIBS += libfdt/libfdt.a
LIBS += api/libapi.a
LIBS += post/libpost.a

LIBS := $(addprefix $(obj),$(LIBS))
LIBS变量指明了U-Boot需要的库文件，包括平台/开发板相关的目录、通用目录下相应的库，都通过相应的子目录编译得到的。
对于mini2440开发板，以上跟平台相关的有以下几个：
cpu/$(CPU)/start.o
board