項(xiàng)目架構(gòu):
其中各個(gè)文件的內(nèi)容請(qǐng)自己填寫(xiě)。
項(xiàng)目被劃分為不同的多個(gè)模塊:
每個(gè)模塊用一個(gè)文件夾進(jìn)行管理,文件由inc, src, makefile構(gòu)成
每個(gè)模塊的對(duì)外函數(shù)統(tǒng)一放置于common/inc中,如common.h xxxfunc.h
工程項(xiàng)目中不希望源文件夾在編譯時(shí)被改動(dòng)(只讀文件夾)
在編譯時(shí)自動(dòng)創(chuàng)建文件夾(build)用于存放編譯結(jié)果
編譯過(guò)程中能夠自動(dòng)生成依賴關(guān)系,自動(dòng)搜索到需要的文件
每個(gè)模塊可以擁有自己獨(dú)立的編譯方式
支持調(diào)試版本和編譯選項(xiàng)
第一階段:將每個(gè)模塊中的代碼編譯稱為靜態(tài)庫(kù)文件(compile)
第二階段:將每個(gè)模塊的靜態(tài)庫(kù)文件最終鏈接成最終的可執(zhí)行程序(link)
完成可用于各個(gè)模塊編譯的makefile文件
完成模塊的編譯結(jié)果為靜態(tài)庫(kù)文件(.a文件)
自動(dòng)生成依賴關(guān)系(gcc -MM)
自動(dòng)搜索需要的文件(vpath)
將目標(biāo)文件打包為靜態(tài)庫(kù)文件(ar crs)
大幅度
.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' > $@
注意:實(shí)驗(yàn)過(guò)程中需要自己創(chuàng)建build及各模塊的文件夾,并將makefile中的絕對(duì)路徑改為自己代碼的路徑。
輸出結(jié)果:
這里我們看到在build/common下成功生成了依賴文件和編譯后的文件,并將這些.o文件打包后放入build文件夾下。
思考:如何編寫(xiě)項(xiàng)目makefile使其能夠觸發(fā)模塊makefile的調(diào)用,并最終生成可執(zhí)行程序?
完成整個(gè)工程的makefile文件;調(diào)用makefile編譯生成靜態(tài)庫(kù)文件;鏈接所有模塊的靜態(tài)庫(kù)文件,得到最終的可執(zhí)行程序。
如何自動(dòng)創(chuàng)建build文件夾及其子文件夾?
如何進(jìn)入每一個(gè)模塊文件夾進(jìn)行編譯?
編譯成功后如何連接所有模塊靜態(tài)庫(kù)?
項(xiàng)目中的各個(gè)模塊在設(shè)計(jì)階段就已經(jīng)基本確定,因此,在之后的開(kāi)發(fā)過(guò)程中不會(huì)頻繁的增加或減少
1.定義變量保存模塊名
2.利用shell中的for循環(huán)遍歷模塊名變量
3.在for循環(huán)中進(jìn)入模塊文件夾進(jìn)行編譯
4.循環(huán)結(jié)束后連接所有的模塊靜態(tài)庫(kù)文件
Makefile中嵌入shell代碼時(shí),如果需要使用shell變量的值,必須在變量前面加$$,譬如$$dir,用于區(qū)分該變量是shell變量而非Makefile中定義的變量。
21.4.3. shell中for循環(huán)實(shí)驗(yàn)
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中的關(guān)鍵構(gòu)成
編譯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) $@
輸出結(jié)果:
編譯成功,在build文件夾下生成了各個(gè)模塊的打包文件。
gcc 在進(jìn)行靜態(tài)庫(kù)連接時(shí),必須遵守嚴(yán)格的依賴關(guān)系
gcc -o app.out x.a y.a
其中的依賴關(guān)必須為:x.a -> y.a , y.a -> z.a
默認(rèn)情況下遵循自左向右的依賴關(guān)系
如果不清楚庫(kù)間的依賴,可以使用-Xlinker自動(dòng)確定依賴關(guān)系
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!"
.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
思考:
當(dāng)前整個(gè)項(xiàng)目的makefile是否存在潛在的問(wèn)題?是否需要重構(gòu)?
當(dāng)前整個(gè)項(xiàng)目的makefile是否存在潛在的問(wèn)題?是否需要重構(gòu)?
所有makefile中使用的編譯路徑均為寫(xiě)死的絕對(duì)路徑,一旦項(xiàng)目文件移動(dòng),編譯必將失?。?br/>
在工程makefile中獲取項(xiàng)目的源碼路徑,根據(jù)項(xiàng)目源碼路徑:
拼接得到編譯文件夾的路徑(DIR_BUILD)
拼接得到全局包含路徑(DIR_COMMON_INC)
通過(guò)命令行變量將路徑傳遞給模塊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!"
所有模塊makefile的內(nèi)容完全相同!
當(dāng)模塊makefile需要改動(dòng)時(shí),將涉及多處相同的改動(dòng)!
將模塊makefile拆分為兩個(gè)模板文件
mod-cfg.mk : 定義可能改變的變量
mod-rule.mk : 定義相對(duì)穩(wěn)定的變量和規(guī)則
默認(rèn)情況下,模塊makefile復(fù)用模板文件實(shí)現(xiàn)功能(include)
模塊makefile如何指導(dǎo)模板文件的具體位置?
通過(guò)命令行變量進(jìn)行模板文件位置的傳遞
$(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)
# 此處之所以保留這些配置,而不是直接刪除,是因?yàn)槲覀兛赡苄枰獙?duì)某個(gè)模塊進(jìn)行特殊配置,此時(shí)只需該改定這里即可
# 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
拆分命令變量,項(xiàng)目變量,以及其他變量和規(guī)則到不同文件
cmd-cfg.mk : 定義命令相關(guān)的變量
pro-cfg.mk : 定義項(xiàng)目變量以及編譯路徑變量等
pro-rule.mk : 定義其他變量和規(guī)則
最后的makefile通過(guò)包含拆分后的文件構(gòu)成(include)
最終方案:
項(xiàng)目主makefile:
include pro-cfg.mk
include cmd-cfg.mk
include pro-rule.mk
項(xiàng)目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
項(xiàng)目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
大型項(xiàng)目的編譯環(huán)境是由不同的makefile構(gòu)成的
編譯環(huán)境的設(shè)計(jì)需要根據(jù)項(xiàng)目的整體架構(gòu)設(shè)計(jì)
整個(gè)項(xiàng)目的編譯過(guò)程可以分解為不同階段
根據(jù)不同的階段由針對(duì)性的對(duì)makefile進(jìn)行設(shè)計(jì)
Makefile也要考慮復(fù)用性和維護(hù)性等基本的程序特性
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)cdcxhl.cn,海內(nèi)外云服務(wù)器15元起步,三天無(wú)理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì),專(zhuān)為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。