ESP8266工程Makefile分析
最近重新温习了一下《跟我一起学Makefile》的文档，刚好又做了ESP8266的开发，正所谓学而不思则罔，时而不学者殆，所以就来总结下ESP8266里面工程是怎么编译的，Makefile是怎么玩的。当然我也没全部搞懂，好多知识也是别人这样说的我也就这么说了。有什么不对的地方望大家指出，交流学习学习，我菜鸟一枚哈
首先说一下我的工程目录结构：
Project
|--bin
|--upgrade 存放编译出来的升级文件
|--sdk 直接将原版SDK放到这里的
|--app 存放用户代码
|--app 真正的用户代码
|--driver 驱动代码，官网上也有
|--include 头文件
|--user 只放了user_main.c文件（用户函数入口），本来所有的用户代码应该放在这里，但是我是移植旧的项目，就另起了一个app目录
说完了目录结构，再来讲讲编译，很简单，就是进入app目录（第一级），shell下敲 ./gen_misc.sh就可以编出升级文件了（实际我是在总目录起了一个shell来完成）。当然我对这个脚本做了些改动的，原本的例子是需要首先修改两个宏：
export SDK_PATH=$(pwd)/../sdk
export BIN_PATH=$(pwd)/../bin
另外，运行过程中会有些选项。我将这选项固定了，下面贴其中一个改动：
echo "Please check SDK_PATH & BIN_PATH, enter (Y/y) to continue:"
#read input
input=Y
if [[ $input != Y ]] && [[ $input != y ]]; then
exit
fi
这说完，该言归正传了，直接看到gen_misc.sh脚本最后的，首先make clean，然后make，并且将前面选项参数传递给该目录下的makefile。
echo "start..."
echo ""
make clean
make BOOT=$boot APP=$app SPI_SPEED=$spi_speed SPI_MODE=$spi_mode SPI_SIZE_MAP=$spi_size_map
刚开始接触的时候（很久没摸makefile了），我去找makefile我是有点蒙的，app目录（第一级）下makefile没有一个目标文件，伪目标都没有，只是定义了写变量而已，看到最后才知道，原来是引用了sdk下的makefile：
INCLUDES := $(INCLUDES) -I $(PDIR)include -I $(PDIR)include/driver -I $(PDIR)include/app
sinclude $(SDK_PATH)/Makefile
正似懂非懂的时候，懵逼的又来了，user目录的下makefie还有app目录（第二级）（我抄user目录的）和driver目录的下的makefile都是简单到令人咋舌：
ifndef PDIR
GEN_LIBS = libapp.a
endif
INCLUDES := $(INCLUDES) -I $(PDIR)include
PDIR := ../$(PDIR)
sinclude $(PDIR)Makefile
可以看到唯一不同的只是GEN_LIBS这个变量，那么问题来，全部都引用SDK目录下的一个makefile（后面统称主makefile），怎么做到的呢，这就是今天的重点了。重点就是SDK目录下这个主makefile，终于找到个稍微正常点的makefile了，虽然也是一堆看不到的东西，但是至少有伪目标，熟悉的all，clean：
all: .subdirs $(OBJS) $(OLIBS) $(OIMAGES) $(OBINS) $(SPECIAL_MKTARGETS)
clean:
$(foreach d, $(SUBDIRS), $(MAKE) -C $(d) clean;)
$(RM) -r $(ODIR)/$(TARGET)/$(FLAVOR)
clobber: $(SPECIAL_CLOBBER)
$(foreach d, $(SUBDIRS), $(MAKE) -C $(d) clobber;)
$(RM) -r $(ODIR)
.subdirs:
set -e; $(foreach d, $(SUBDIRS), $(MAKE) -C $(d);)
回到刚才讲的前面app目录（第一级），先执行make clean,跳转到SDK目录下的clean伪目标，先执行：
$(foreach d, $(SUBDIRS), $(MAKE) -C $(d) clean;)
这是一个for循环，将变量SUBDIRS中的参数依次代入到临时变量d中，去执行$(MAKE) -C $(d) clean。我们可以在app目录（第一级）中找到变量的定义：
ifndef PDIR # {
GEN_IMAGES= eagle.app.v6.out
GEN_BINS= eagle.app.v6.bin
SPECIAL_MKTARGETS=$(APP_MKTARGETS)
SUBDIRS= \
user \
driver \
app
endif # } PDIR
也就是分别在这三个目录执行了make clean。正如前面所讲，这三个目录其实还是引用的主makefile，也就是继续执行伪目标clean下的操作，但是第一个for循环不会再执行了，精妙之处就在于，SUBDIRS在makefile引用的过程中并未定义。我们来看user下的makefile最后两句：
PDIR := ../$(PDIR)
sinclude $(PDIR)Makefile
PDIR被定义为上一级目录，所以include了上一级目录的makefile，也即是app目录（第一级），注意看我前面贴出的代码，SUBDIRS变量是在PDIR变量没定义时候才被定义，而此时PDIR已被定义，所以app目录（第一级）下的makefile再次跳转到主makefile时，$(SUBDIRS)为空。所以for就不执行，而继续执行rm操作，将编译参数的文件夹.output删除
这里我们回想一下，这几个makefile的调用相当于转了一圈又回来了，而且中间夹着这变量控制，以前没见过（可能我见识短浅吧），简直秀的我头皮发麻：
gen_misc.sh -> app目录（第一级） -> 主makefile -> user下makefile -> app目录（第一级） -> 主makefile
讲完make clean执行流程，再来说make。make会找到第一个目标，也就是all来执行，all的依赖有很多，先说下第一个.subdirs这个依赖的伪目标，主要也是一个for循环：
$(foreach d, $(SUBDIRS), $(MAKE) -C $(d);)
跟前面的clean很像，也是分别进入三个目录进行make，那么它们最终会执行主makefile中的第一个目标all，还是一样SUBDIRS未定义，所以.subdirs相当于没用，接着执行到$(OBJS)：
CSRCS ?= $(wildcard *.c)
CPPSRCS ?= $(wildcard *.cpp)
ASRCs ?= $(wildcard *.s)
ASRCS ?= $(wildcard *.S)
SUBDIRS ?= $(patsubst %/,%,$(dir $(wildcard */Makefile)))
ODIR := .output
OBJODIR := $(ODIR)/$(TARGET)/$(FLAVOR)/obj
OBJS := $(CSRCS:%.c=$(OBJODIR)/%.o) \
$(CPPSRCS:%.cpp=$(OBJODIR)/%.o) \
$(ASRCs:%.s=$(OBJODIR)/%.o) \
$(ASRCS:%.S=$(OBJODIR)/%.o)
DEPS := $(CSRCS:%.c=$(OBJODIR)/%.d) \
$(CPPSRCS:%.cpp=$(OBJODIR)/%.d) \
$(ASRCs:%.s=$(OBJODIR)/%.d) \
$(ASRCS:%.S=$(OBJODIR)/%.d)
看到这里可能有人会说SUBDIRS不是在这里定义了吗，但是patsubst函数执行完后还是为空的。回到$(OBJS)，这里用到静态模式，简单的说就是将该目录下的.c都找出来，替换成.o，编译.o之前呢，首先需要include .d文件:
ifneq ($(MAKECMDGOALS),clean)
ifneq ($(MAKECMDGOALS),clobber)
ifdef DEPS
sinclude $(DEPS)
endif
endif
endif
非clean和clobber目标时都会去include，此时就用下面的代码自动生成依赖的 .d文件:
$(OBJODIR)/%.d: %.c
@mkdir -p $(OBJODIR);
@echo DEPEND: $(CC) -M $(CFLAGS) $<
@set -e; rm -f [email protected]; \
$(CC) -M $(CFLAGS) $< > [email protected]$$$$; \
sed 's,\($*\.o\)[ :]*,$(OBJODIR)/\1 [email protected] : ,g' < [email protected]$$$$ > [email protected]; \
rm -f [email protected]$$$$
这是标准的生成流程哈，大致就是 -M参数生成依赖关系导入到文件中，至于里面的随机文件名，sed替换，删除中间文件啥的操作,别问我哈。。。
然后就编译.o了，使用隐含规则和自动化变量:
$(OBJODIR)/%.o: %.c
@mkdir -p $(OBJODIR);
$(CC) $(if $(findstring $<,$(DSRCS)),$(DFLAGS),$(CFLAGS)) $(COPTS_$(*F)) -o [email protected] -c $<
OBJS运行完了，接着是$(OLIBS)，根据下面的代码可得结果是.output/eagle/debug/lib/libuser.a:
LIBODIR := $(ODIR)/$(TARGET)/$(FLAVOR)/lib
OLIBS := $(GEN_LIBS:%=$(LIBODIR)/%)
但是Makefile没有libuser.a这个目标啊，我又蒙了一会，然后看到这里:
$(foreach lib,$(GEN_LIBS),$(eval $(call MakeLibrary,$(basename $(lib)))))
$(foreach image,$(GEN_IMAGES),$(eval $(call MakeImage,$(basename $(image)))))
有一个以前没见过的高级函数eval函数，函数原型 $(eval text)，它的意思是 text 的内容将作为makefile的一部分而被make解析和执行。call调用的MakeLibrary就会被展开在makefile里面:
define MakeLibrary
DEP_LIBS_$(1) = $$(foreach lib,$$(filter %.a,$$(COMPONENTS_$(1))),$$(dir $$(lib))$$(LIBODIR)/$$(notdir $$(lib)))
DEP_OBJS_$(1) = $$(foreach obj,$$(filter %.o,$$(COMPONENTS_$(1))),$$(dir $$(obj))$$(OBJODIR)/$$(notdir $$(obj)))
$$(LIBODIR)/$(1).a: $$(OBJS) $$(DEP_OBJS_$(1)) $$(DEP_LIBS_$(1)) $$(DEPENDS_$(1))
@mkdir -p $$(LIBODIR)
$$(if $$(filter %.a,$$?),mkdir -p $$(EXTRACT_DIR)_$(1))
$$(if $$(filter %.a,$$?),cd $$(EXTRACT_DIR)_$(1); $$(foreach lib,$$(filter %.a,$$?),$$(AR) xo $$(UP_EXTRACT_DIR)/$$(lib);))
$$(AR) ru [email protected] $$(filter %.o,$$?) $$(if $$(filter %.a,$$?),$$(EXTRACT_DIR)_$(1)/*.o)
$$(if $$(filter %.a,$$?),$$(RM) -r $$(EXTRACT_DIR)_$(1))
endef
这时，一个红色字体.a映入眼帘，大概就能知道目标在这里了，根据这段代码来编出lib文件
那另外剩下的三个依赖目标呢OIMAGES OBINS SPECIAL_MKTARGETS，其实这三个都是空字符串，道理跟之前一样。所以连续循环三遍后，三个用户目录就搞定了，都编出lib出来了
这时又回到主makefile需要编译下一个目标$(OIMAGES)了，同样是采用了eval函数，代码上面已经截图过，调用的MakeImage
define MakeImage
DEP_LIBS_$(1) = $$(foreach lib,$$(filter %.a,$$(COMPONENTS_$(1))),$$(dir $$(lib))$$(LIBODIR)/$$(notdir $$(lib)))
DEP_OBJS_$(1) = $$(foreach obj,$$(filter %.o,$$(COMPONENTS_$(1))),$$(dir $$(obj))$$(OBJODIR)/$$(notdir $$(obj)))
$$(IMAGEODIR)/$(1).out: $$(OBJS) $$(DEP_OBJS_$(1)) $$(DEP_LIBS_$(1)) $$(DEPENDS_$(1))
@mkdir -p $$(IMAGEODIR)
$$(CC) $$(LDFLAGS) $$(if $$(LINKFLAGS_$(1)),$$(LINKFLAGS_$(1)),$$(LINKFLAGS_DEFAULT) $$(OBJS) $$(DEP_OBJS_$(1)) $$(DEP_LIBS_$(1))) -o [email protected]
endef
执行了.output/eagle/debug/image/eagle.app.v6.out这个目标
接就是$(OBINS)这个目标了.output/eagle/debug/bin/eagle.app.v6.bin，代码入口比较直接，代码有很多，贴一点吧
$(BINODIR)/%.bin: $(IMAGEODIR)/%.out
@mkdir -p $(BIN_PATH)
@mkdir -p $(BINODIR)
到这里，整个工程就编完了。讲到这里也差不多了，主要突出一个流程，里面还有很多变量怎么来，函数怎么用的，都没去细说，因为我也没有的一个个分析。有兴趣的可以看看里面几个函数的实现。