1. 1. Openwrt 目录结构
  2. 2. Openwrt 编译过程
    1. 2.1. main Makefile
    2. 2.2. 第一个逻辑
    3. 2.3. 第二逻辑
    4. 2.4. stampfile
    5. 2.5. OpenWrt 的主 Makefile 工作过程
    6. 2.6. subdir
    7. 2.7. 目录变量
    8. 2.8. kernel 编译:
    9. 2.9. 生成 firmware
    10. 2.10. 处理 vmlinux: Image/BuildKernel
    11. 2.11. lzma 压缩内核
    12. 2.12. MkImage
    13. 2.13. 制作 squashfs,生成.bin: $(call Image/mkfs/squashfs)
    14. 2.14. mkdir -p $(TARGET_DIR)/overlay
    15. 2.15. mksquashfs4
    16. 2.16. 制作 squashfs 文件系统,生成 root.squashfs:
  3. 3. 主 MakeFile 文件
    1. 3.1. 前导部分
    2. 3.2. 再次执行部分
    3. 3.3. 定义一些使用固定的目标规则

Openwrt 编译过程

摘要:本篇通过分析 Makefile,了解 Openwrt 编译过程,包括(1)Openwrt 目录结构(2)主 Makefile 的解析过程,各子目录的目标生成。(3)kernel 编译过程(4)firmware 的生成过程(5)软件包的编译过程

从 github 上 clone 了 openwrt 的代码仓库。

git clone https://github.com/openwrt-mirror/openwrt.git

Openwrt 目录结构

上图是 openwrt 目录结构,其中第一行是原始目录,第二行是编译过程中生成的目录。各目录的作用是:

tools - 编译时需要一些工具, tools 里包含了获取和编译这些工具的命令。里面是一些 Makefile,有的可能还有 patch。每个 Makefile 里都有一句:$(eval $(call HostBuild)),表示编译这个工具是为了在主机上使用的。
toolchain - 包含一些命令去获取 kernel headers, C library, bin-utils, compiler, debugger
target - 各平台在这个目录里定义了 firmware 和 kernel 的编译过程。
package - 包含针对各个软件包的 Makefile。openwrt 定义了一套 Makefile 模板,各软件包参照这个模板定义了自己的信息,如软件包的版本、下载地址、编译方式、安装地址等。
include - openwrt 的 Makefile 都存放在这里。
scripts - 一些 perl 脚本,用于软件包管理。
dl - 软件包下载后都放到这个目录里
build_dir - 软件包都解压到 build_dir/里,然后在此编译
staging_dir - 最终安装目录。tools, toolchain 被安装到这里,rootfs 也会放到这里。
feeds - feeds.conf 订阅的软件下载目录。
bin - 编译完成之后,firmware 和各 ipk 会放到此目录下。

Openwrt 编译过程

main Makefile

openwrt 根目录下的 Makefile 是执行 make 命令时的入口。从这里开始分析。

world:

ifndef ($(OPENWRT_BUILD),1)
  #  第一个逻辑
   ...
else
  #  第二个逻辑
   ...
endif

上面这段是主 Makefile 的结构,可以得知:

执行 make 时,若无任何目标指定,则默认目标是 world
执行 make 时,无参数指定,则会进入第一个逻辑。如果执行命令 make OPENWRT_BUILD=1,则直接进入第二个逻辑。

编译时一般直接使用make V=s -j 5这样的命令,不会指定 OPENWRT_BUILD 变量,显然这里 OPENWRT_BUILD 用于标记当前 openwrt BSP 是否已经编译过,因此第一次编译当然应该执行第一个逻辑,同时令 OPENWRT_BUILD 为1,标示 openwrt BSP 已经编译过了。

第一个逻辑

override OPENWRT_BUILD=1
export OPENWRT_BUILD

更改了 OPENWRT_BUILD 变量的值。这里起到的作用是下次执行 make 时,因为已经编译过,会进入到第二逻辑中。

第一个逻辑中会 include toplevel.mk,该文件中的 “%::” 用于解释 world 目标的规则:

prereq:: prepare-tmpinfo .config
    @+$(MAKE) -r -s tmp/.prereq-build $(PREP_MK)
    @+$(NO_TRACE_MAKE) -r -s $@

%::
    @+$(PREP_MK) $(NO_TRACE_MAKE) -r -s prereq
    @( \
        cp .config tmp/.config; \
        ./scripts/config/conf --defconfig=tmp/.config -w tmp/.config Config.in > /dev/null 2>&1; \
        if ./scripts/kconfig.pl '>' .config tmp/.config | grep -q CONFIG; then \
            printf "$(_R)WARNING: your configuration is out of sync. Please run make menuconfig, oldconfig or defconfig!$(_N)\n" >&2; \
        fi \
    )
    @+$(ULIMIT_FIX) $(SUBMAKE) -r $@

执行 make V=s 时,上面这段规则简化为:

prereq:: prepare-tmpinfo .config
    @make -r -s tmp/.prereq-build
    @make V=ss -r -s prereq

%::
    @make V=s -r -s prereq
    @make -w -r world

可见其中最终又执行了 prereq 和 world 目标,这两个目标都会进入到第二逻辑中。

第二逻辑

首先就引入了 target, package, tools, toolchain 这四个关键目录里的 Makefile 文件

include target/Makefile
include package/Makefile
include tools/Makefile
include toolchain/Makefile

这些子目录里的 Makefile 使用 include/subdir.mk 里定义的两个函数来动态生成规则,这两个函数是 subdir 和 stampfile

stampfile

拿 target/Makefile 举例:

(eval(call stampfile,$(curdir),target,prereq,.config))

会生成规则:

target/stamp-prereq:=$(STAGING_DIR)/stamp/.target_prereq

$$(target/stamp-prereq): $(TMP_DIR)/.build .config
  @+$(SCRIPT_DIR)/timestamp.pl -n $$(target/stamp-prereq) target .config || \
      make $$(target/flags-prereq) target/prereq
  @mkdir -p $$$$(dirname $$(target/stamp-prereq))
  @touch $$(target/stamp-prereq)

$$(if $(call debug,target,v),,.SILENT: $$(target/stamp-prereq))

.PRECIOUS: $$(target/stamp-prereq) #  work around a make bug

target//clean:=target/stamp-prereq/clean
target/stamp-prereq/clean: FORCE
  @rm -f $$(target/stamp-prereq)

所以可以简单的看作:(eval(call stampfile,(curdir),target,prereq,.config))生成了目标(target/stamp-prereq)

对于 target 分别生成了:(target/stamp-preq),(target/stamp-copile), $(target/stamp-install)
toolchain : $(toolchain/stamp-install)
package : (package/stamp-preq),(package/stamp-cleanup), (package/stamp-compile),(package/stamp-install)
tools : $(tools/stamp-install)

OpenWrt 的主 Makefile 工作过程

subdir

subdir 这个函数写了一大堆东西,看起来很复杂 。

$(call subdir, target) 会遍历下的子目录,执行 make -C 操作。这样就切入子目录中去了。

目录变量

几个重要的目录路径:

KERNEL_BUILD_DIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/linux-3.14.18

LINUX_DIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/linux-3.14.18

KDIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a

BIN_DIR

bin/ramips
Makefile 中包含了 rules.mk, target.mk 等.mk 文件,这些文件中定义了许多变量,有些是路径相关的,有些是软件相关的。这些变量在整个 Makefile 工程中经常被用到,

TARGET_ROOTFS_DIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2

BUILD_DIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2

STAGING_DIR_HOST

staging_dir/toolchain-mipsel_24kec+dsp_gcc-4.8-linaro_uClibc-0.9.33.2

TARGET_DIR

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/root-ramips

kernel 编译:

target/linux/ramips/Makefile: $(eval $(call BuildTarget))

target/linux/Makefile : export TARGET_BUILD=1

根目录中 Makefile:include target/Makefile -->
target/Makefile 中:$(curdir)/builddirs:=linux sdk imagebuilder toolchain -->
target/linux 中 Makefile: @+$(NO_TRACE_MAKE) -C $(BOARD) $@  -->显然这里 BOARD 是 ramips
target/linux/ramips 中 Makefile:    include $(INCLUDE_DIR)/target.mk

include/target.mk 中如下内容:

ifeq ($(TARGET_BUILD),1)
  include $(INCLUDE_DIR)/kernel-build.mk
  BuildTarget?=$(BuildKernel)
endif
BuildKernel 是 include/kernel-build.

mk 定义的一个多行变量,其中描述了如何编译内核, 主要关注其中 install 规则的依赖链:

  $(KERNEL_BUILD_DIR)/symtab.h: FORCE
    rm -f $(KERNEL_BUILD_DIR)/symtab.h
    touch $(KERNEL_BUILD_DIR)/symtab.h
    +$(MAKE) $(KERNEL_MAKEOPTS) vmlinux
    ...

  $(LINUX_DIR)/.image: $(STAMP_CONFIGURED) $(if $(CONFIG_STRIP_KERNEL_EXPORTS),$(KERNEL_BUILD_DIR)/symtab.h) FORCE
    $(Kernel/CompileImage)
    $(Kernel/CollectDebug)
    touch $$@


  install: $(LINUX_DIR)/.image
    +$(MAKE) -C image compile install TARGET_BUILD=
1. 触发 make vmlinux 命令生成 vmlinux: install --> $(LINUX_DIR)/.image --> $(KERNEL_BUILD_DIR)/symtab.h --> `$(MAKE) $(KERNEL_MAKEOPTS) vmlinux`

2. 对 vmlinux 做 objcopy, strip 操作: $(LINUX_DIR)/.image --> $(Kernel/CompileImage) --> $(call Kernel/CompileImage/Default) --> $(call Kernel/CompileImage/Default)

    $(KERNEL_CROSS)objcopy -O binary $(OBJCOPY_STRIP) -S $(LINUX_DIR)/vmlinux $(LINUX_KERNEL)$(1)
        --> build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/vmlinux

    $(KERNEL_CROSS)objcopy $(OBJCOPY_STRIP) -S $(LINUX_DIR)/vmlinux $(KERNEL_BUILD_DIR)/vmlinux$(1).elf
        --> build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/vmlinux.elf

    $(CP) $(LINUX_DIR)/vmlinux $(KERNEL_BUILD_DIR)/vmlinux.debug
        --> build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/vmlinux.debug

生成 firmware

firmware 由 kernel 和 rootfs 两个部分组成,要对两个部分先分别处理,然后再合并成一个.bin 文件。先看一下这个流程。

“target/linux/ramips/image/Makefile” 文件中的最后一句:$(eval $(call BuildImage)),将 BuildImage 展开在这里。BuildImage 定义在 include/image.mk 文件中,其中定义了数个目标的规则。

define BuildImage

    compile: compile-targets FORCE
        **$(call Build/Compile)**

    install: compile install-targets FORCE
        ...
        $(call Image/BuildKernel) ## 处理 vmlinux
        ...
        $(call Image/mkfs/squashfs) ## 生成 squashfs,并与 vmlinux 合并成一个.bin 文件
        ...

endef

处理 vmlinux: Image/BuildKernel

target/linux/ramips/image/Makefile:

define Image/BuildKernel
    cp $(KDIR)/vmlinux.elf $(BIN_DIR)/$(VMLINUX).elf
    cp $(KDIR)/vmlinux $(BIN_DIR)/$(VMLINUX).bin
    $(call CompressLzma,$(KDIR)/vmlinux,$(KDIR)/vmlinux.bin.lzma)
    $(call MkImage,lzma,$(KDIR)/vmlinux.bin.lzma,$(KDIR)/uImage.lzma)
    cp $(KDIR)/uImage.lzma $(BIN_DIR)/$(UIMAGE).bin
ifneq ($(CONFIG_TARGET_ROOTFS_INITRAMFS),)
    cp $(KDIR)/vmlinux-initramfs.elf $(BIN_DIR)/$(VMLINUX)-initramfs.elf
    cp $(KDIR)/vmlinux-initramfs $(BIN_DIR)/$(VMLINUX)-initramfs.bin
    $(call CompressLzma,$(KDIR)/vmlinux-initramfs,$(KDIR)/vmlinux-initramfs.bin.lzma)
    $(call MkImage,lzma,$(KDIR)/vmlinux-initramfs.bin.lzma,$(KDIR)/uImage-initramfs.lzma)
    cp $(KDIR)/uImage-initramfs.lzma $(BIN_DIR)/$(UIMAGE)-initramfs.bin
endif
    $(call Image/Build/Initramfs)
endef

lzma 压缩内核

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/ 目录中:

lzma e vmlinux -lc1 -lp2 -pb2 vmlinux.bin.lzma

MkImage

build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/ 目录中:

mkimage -A mips -O linux -T  kernel -C lzma -a 0x80000000 -e 0x80000000 -n "MIPS OpenWrt Linux-3.14.18" -d vmlinux.bin.lzma uImage.lzma
copy
VMLINUX:=$(IMG_PREFIX)-vmlinux --> openwrt-ramips-mt7620a-vmlinux
UIMAGE:=$(IMG_PREFIX)-uImage --> openwrt-ramips-mt7620a-uImage
cp $(KDIR)/uImage.lzma $(BIN_DIR)/$(UIMAGE).bin
把 uImage.lzma 复制到 bin/ramips/目录下:
cp $(KDIR)/uImage.lzma bin/ramips/openwrt-ramips-mt7620a-uImage

制作 squashfs,生成.bin: $(call Image/mkfs/squashfs)

define Image/mkfs/squashfs
    @mkdir -p $(TARGET_DIR)/overlay
    $(STAGING_DIR_HOST)/bin/mksquashfs4 $(TARGET_DIR) $(KDIR)/root.squashfs -nopad -noappend -root-owned -comp $(SQUASHFSCOMP) $(SQUASHFSOPT) -processors $(if $(CONFIG_PKG_BUILD_JOBS),$(CONFIG_PKG_BUILD_JOBS),1)
    $(call Image/Build,squashfs)
endif

mkdir -p $(TARGET_DIR)/overlay

mkdir -p build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/root-ramips/overlay

mksquashfs4

$(STAGING_DIR_HOST)/bin/mksquashfs4 $(TARGET_DIR) $(KDIR)/root.squashfs -nopad -noappend -root-owned -comp $(SQUASHFSCOMP) $(SQUASHFSOPT) -processors $(if $(CONFIG_PKG_BUILD_JOBS),$(CONFIG_PKG_BUILD_JOBS),1)

制作 squashfs 文件系统,生成 root.squashfs:

mksquashfs4 root-ramips root.squashfs -nopad -noappend -root-owned -comp gzip -b 256k -p '/dev d 755 0 0' -p '/dev/console c 600 0 0 5 1' -processors 1
$(call Image/Build,squashfs)

在 target/linux/ramips/image/Makefile 中:

define Image/Build
    $(call Image/Build/$(1))
    dd if=$(KDIR)/root.$(1) of=$(BIN_DIR)/$(IMG_PREFIX)-root.$(1) bs=128k conv=sync
    $(call Image/Build/Profile/$(PROFILE),$(1))
endef

dd if=(KDIR)/root.squashfsof=(BIN_DIR)/$(IMG_PREFIX)-root.squashfs bs=128k conv=sync
dd if=build_dir/target-mipsel_24kec+dsp_uClibc-0.9.33.2/linux-ramips_mt7620a/root.squashfs of=bin/ramips/openwrt-ramips-mt7620-root.squashfs bs=128k conv=sync

(callImage/Build/Profile/(PROFILE),squashfs)
target/linux/ramips/mt7620a/profiles/00-default.mk, 中调用 Profile 函数:$(eval $(call Profile,Default))

include/target.mk 中定义了 Profile 函数, 其中令 PROFILE=Default

define Image/Build/Profile/Default
    $(call Image/Build/Profile/MT7620a,$(1))
    ...
endef

规则依赖序列如下:

$(call Image/Build/Profile/$(PROFILE),squashfs)
  --> $(call BuildFirmware/Default8M/squashfs,squashfs,mt7620a,MT7620a)
      --> $(call BuildFirmware/OF,squashfs,mt7620a,MT7620a,8060928)
          --> $(call MkImageLzmaDtb,mt7620a,MT7620a)
              --> $(call PatchKernelLzmaDtb,mt7620a,MT7620a)
              --> $(call MkImage,lzma,$(KDIR)/vmlinux-mt7620a.bin.lzma,$(KDIR)/vmlinux-mt7620a.uImage)
      --> $(call MkImageSysupgrade/squashfs,squashfs,mt7620a,8060928)

其中的主要步骤:

  • 复制: cp (KDIR)/vmlinux(KDIR)/vmlinux-mt7620a
  • 生成 dtb 文件:(LINUXDIR)/scripts/dtc/dtc-Odtb-o(KDIR)/MT7620a.dtb ../dts/MT7620a.dts
  • 将内核与 dtb 文件合并:(STAGINGDIRHOST)/bin/patch-dtb(KDIR)/vmlinux-mt7620a $(KDIR)/MT
  • 使用 lzma 压缩:(callCompressLzma,(KDIR)/vmlinux-mt7620a,$(KDIR)/vmlinux-mt7620a.bin.lzma)
    将 lzma 压缩后的文件经过 mkimage 工具处理,即在头部添加 uboot 可识别的信息。
    接下来就是合并生成 firmware 固件了:

    MkImageSysupgrade/squashfs, squashfs, mt7620a,8060928

    cat vmlinux-mt7620a.uImage root.squashfs > openwrt-ramips-mt7620-mt7620a-squashfs-sysupgrade.bin
    –> 制作 squashfs bin 文档, 并确认它的大小 < 8060928 才是有效的,否则报错。

总结: 整个流程下来,其实最烦索的还是对内核生成文件 vmlinux 的操作,经过了 objcopy, patch-dtb, lzma, mkimage 等过程生成一个 uImage,再与 mksquashfs 工具制作的文件系统 rootfs.squashfs 合并。

主 MakeFile 文件

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 属于伪目标。通过伪目标说明可以知道可以执行的目标。