makefile(08)_打造專業的編譯環境
20.0. 實驗材料
項目架構:
其中各個文件的內容請自己填寫。
20.1.大型項目的目錄結構(無第三方庫)
20.2.項目架構設計分析
項目被劃分為不同的多個模塊:
每個模塊用一個文件夾進行管理,文件由inc, src, makefile構成
每個模塊的對外函數統一放置於common/inc中,如common.h xxxfunc.h
20.3.項目目標
工程項目中不希望源文件夾在編譯時被改動(只讀文件夾)
在編譯時自動創建文件夾(build)用於存放編譯結果
編譯過程中能夠自動生成依賴關系,自動搜索到需要的文件
每個模塊可以擁有自己獨立的編譯方式
支持調試版本和編譯選項
20.4.解決方案
第一階段:將每個模塊中的代碼編譯稱為靜態庫文件(compile)
第二階段:將每個模塊的靜態庫文件最終鏈接成最終的可執行程序(link)
20.5.第一階段任務
完成可用於各個模塊編譯的makefile文件
完成模塊的編譯結果為靜態庫文件(.a文件)
20.5.1.關鍵的實現要點
自動生成依賴關系(gcc -MM)
自動搜索需要的文件(vpath)
將目標文件打包為靜態庫文件(ar crs)
20.5.2.模塊makefile中的構成
20.6.最終結果
大幅度
.PHONY : all DIR_BUILD := /root/w_share/DT/ToBeMaster/makefile/20/build DIR_COMMON_INC := /root/w_share/DT/ToBeMaster/makefile/20/common/inc DIR_SRC := src DIR_INC := inc TYPE_INC := .h TYPE_SRC := .c TYPE_OBJ := .o TYPE_DEP := .dep AR := ar ARFLAGS := crs CC := gcc CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC) ifeq ($(DEBUG),true) CFLAGS += -g endif 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‘ > $@
註意:實驗過程中需要自己創建build及各模塊的文件夾,並將makefile中的絕對路徑改為自己代碼的路徑。
輸出結果:
這裏我們看到在build/common下成功生成了依賴文件和編譯後的文件,並將這些.o文件打包後放入build文件夾下。
思考:如何編寫項目makefile使其能夠觸發模塊makefile的調用,並最終生成可執行程序?
21.打造專業的編譯環境_鏈接
21.1.第二階段任務
完成整個工程的makefile文件;調用makefile編譯生成靜態庫文件;鏈接所有模塊的靜態庫文件,得到最終的可執行程序。
21.2.關鍵的實現要點
如何自動創建build文件夾及其子文件夾?
如何進入每一個模塊文件夾進行編譯?
21.3.開發中的經驗假設
項目中的各個模塊在設計階段就已經基本確定,因此,在之後的開發過程中不會頻繁的增加或減少
21.4.解決方案設計
1.定義變量保存模塊名
2.利用shell中的for循環遍歷模塊名變量
3.在for循環中進入模塊文件夾進行編譯
4.循環結束後連接所有的模塊靜態庫文件
21.4.1.Makefile中潛入shell的for循環
21.4.2. 註意事項
Makefile中嵌入shell代碼時,如果需要使用shell變量的值,必須在變量前面加$$,譬如$$dir,用於區分該變量是shell變量而非Makefile中定義的變量。
21.4.3. shell中for循環實驗
compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
@echo "Begin to compile ..."
@set -e; for dir in $(MODULES); do cd $$dir && $(MAKE) all DEBUG:=$(DEBUG) && cd .. ; done
@echo "Compile Success!"
工程makefile中的關鍵構成
編譯makefile:
.PHONY : all compile
MODULES := common module main
MKDIR := mkdir
RM := rm -fr
DIR_PROJECT := $(realpath .)
DIR_BUILD := build
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
@echo "Begin to compile ..."
@set -e; for dir in $(MODULES); do cd $$dir && $(MAKE) all DEBUG:=$(DEBUG) && cd .. ; done
@echo "Compile Success!"
$(DIR_BUILD) $(DIR_BUILD_SUB) :
$(MKDIR) $@
輸出結果:
編譯成功,在build文件夾下生成了各個模塊的打包文件。
21.5. 鏈接時的註意事項
gcc 在進行靜態庫連接時,必須遵守嚴格的依賴關系
gcc -o app.out x.a y.a
其中的依賴關必須為:x.a -> y.a , y.a -> z.a
默認情況下遵循自左向右的依賴關系
如果不清楚庫間的依賴,可以使用-Xlinker自動確定依賴關系
gcc -o app.out -Xlinker “-(”z.a y.a x.a -Xlinker”-)”
link $(APP) : $(MODULE_LIB)
@echo "Begin to link ..."
$(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
@echo "Link Success!"
21.6. 最終方案
.PHONY : all compile link clean rebuild
MODULES := common module main
MKDIR := mkdir
RM := rm -fr
CC := gcc
LFLAGS :=
DIR_PROJECT := $(realpath .)
DIR_BUILD := build
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
APP := app.out
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) && 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
思考:
當前整個項目的makefile是否存在潛在的問題?是否需要重構?
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重構)
所有模塊makefile的內容完全相同!
當模塊makefile需要改動時,將涉及多處相同的改動!
22.2.1.解決方案
將模塊makefile拆分為兩個模板文件
mod-cfg.mk : 定義可能改變的變量
mod-rule.mk : 定義相對穩定的變量和規則
默認情況下,模塊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也要考慮復用性和維護性等基本的程序特性
makefile(08)_打造專業的編譯環境