第22课

22.打造专业的编译环境_下(编译环境重构)

当前整个项目的makefile是否存在潜在的问题？是否需要重构？

22.1.绝对路径问题

所有makefile中使用的编译路径均为写死的绝对路径，一旦项目文件移动，编译必将失败！
　　

22.1.1.解决方案：

• 在工程makefile中获取项目的源码路径，根据项目源码路径：

• 拼接得到编译文件夹的路径（DIR_BUILD）

• 拼接得到全局包含路径（DIR_COMMON_INC）

• 通过命令行变量将路径传递给模块makefile

compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
    @echo "Begin to compile ..."
    @set -e; 
    for dir in $(MODULES); 
    do 
        cd $$dir && 
        $(MAKE) all 
                    DEBUG:=$(DEBUG) 
                    DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD)) 
                    DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC)) && 
        cd .. ; 
    done
    @echo "Compile Success!"

22.2.代码复用问题(模块makefile重构)

1.所有模块makefile的内容完全相同！
2.当模块makefile需要改动时，将涉及多处相同的改动！

22.2.1.解决方案

（1）将模块makefile拆分为两个模板文件

• • mod-cfg.mk : 定义可能改变的变量

  • mod-rule.mk : 定义相对稳定的变量和规则

（2）默认情况下，模块makefile复用模板文件实现功能(include)

22.2.2.解决方案

模块makefile如何指导模板文件的具体位置？
通过命令行变量进行模板文件位置的传递

$(MAKE) all 
                DEBUG:=$(DEBUG) 
                DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD)) 
                DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC)) 
                CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG)) 
                MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG)) 
                MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) && 

最终方案：
模块makefile:

include $(MOD_CFG)

# 此处之所以保留这些配置，而不是直接删除，是因为我们可能需要对某个模块进行特殊配置，此时只需该改定这里即可
# Custmization Begin
# 
# DIR_SRC := src
# DIR_INC := inc
#
# TYPE_INC := .h
# TYPE_SRC := .c
# TYPE_OBJ := .o
# TYPE_DEP := .dep
#
# Custmization End

include $(CMD_CFG)

include $(MOD_RULE)

模块makefile中include包含的子模块mod-cfg.mk：

DIR_SRC := src
DIR_INC := inc

TYPE_INC := .h
TYPE_SRC := .c
TYPE_OBJ := .o
TYPE_DEP := .dep

模块makefile中include包含的子模块mod-rule.mk：

#生成依赖文件，编译，打包
.PHONY : all

MODULE := $(realpath .)
MODULE := $(notdir $(MODULE))
DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE))

OUTPUT := $(MODULE).a
OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT))

SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC))
OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ))
OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS))
DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP))
DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS))

vpath %$(TYPE_INC) $(DIR_INC)
vpath %$(TYPE_INC) $(DIR_COMMON_INC)
vpath %$(TYPE_SRC) $(DIR_SRC)

-include $(DEPS)

all : $(OUTPUT)
    @echo "Success! Target ==> $(OUTPUT)"

$(OUTPUT) : $(OBJS)
    $(AR) $(ARFLAGS) $@ $^

$(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC)
    $(CC) $(CFLAGS) -o $@ -c $(filter %$(TYPE_SRC), $^)

$(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC)
    @echo "Creating $@ ..."
    @set -e; 
    $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,(.*).o[ :]*,$(DIR_OUTPUT)/1$(TYPE_OBJ) $@ : ,g' > $@

模块makefile中include包含的子模块cmd-cfg.mk：

AR := ar
ARFLAGS := crs

CC := gcc
LFLAGS := 
CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC)

ifeq ($(DEBUG),true)
CFLAGS += -g
endif

MKDIR := mkdir
RM := rm -fr

22.3.工程makefile的重构

拆分命令变量，项目变量，以及其他变量和规则到不同文件

• cmd-cfg.mk : 定义命令相关的变量

• pro-cfg.mk : 定义项目变量以及编译路径变量等

• pro-rule.mk : 定义其他变量和规则

• 最后的makefile通过包含拆分后的文件构成(include)

最终方案：

项目主makefile:

include pro-cfg.mk
include cmd-cfg.mk
include pro-rule.mk

项目makefile中include包含的子模块pro-cfg.mk：

MODULES := common 
           module 
           main

MOD_CFG := mod-cfg.mk
MOD_RULE := mod-rule.mk
CMD_CFG := cmd-cfg.mk

DIR_BUILD := build
DIR_COMMON_INC := common/inc

APP := app.out

项目makefile中include包含的子模块pro-rele.mk：

.PHONY : all compile link clean rebuild

DIR_PROJECT := $(realpath .)
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))

APP := $(addprefix $(DIR_BUILD)/, $(APP))

all : compile $(APP)
    @echo "Success! Target ==> $(APP)"

compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
    @echo "Begin to compile ..."
    @set -e; 
    for dir in $(MODULES); 
    do 
        cd $$dir && 
        $(MAKE) all 
                DEBUG:=$(DEBUG) 
                DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD)) 
                DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC)) 
                CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG)) 
                MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG)) 
                MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) && 
        cd .. ; 
    done
    @echo "Compile Success!"

link $(APP) : $(MODULE_LIB)
    @echo "Begin to link ..."
    $(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
    @echo "Link Success!"

$(DIR_BUILD) $(DIR_BUILD_SUB) : 
    $(MKDIR) $@

clean : 
    @echo "Begin to clean ..."
    $(RM) $(DIR_BUILD)
    @echo "Clean Success!"

rebuild : clean all

22.4.总结

• 大型项目的编译环境是由不同的makefile构成的

• 编译环境的设计需要根据项目的整体架构设计

• 整个项目的编译过程可以分解为不同阶段：编译 + 链接

• 根据不同的阶段由针对性的对makefile进行设计

• Makefile也要考虑复用性和维护性等基本的程序特性