1. 程式人生 > >makefile(09)_擴展支持

makefile(09)_擴展支持

makefile 模塊編譯 第三方庫支持

23.獨立模塊的支持

23.1.問題:

一般而言,不同工程師負責不同模塊的開發,編譯環境中如何支持模塊的獨立編譯?

23.2.問題背景:

  • 大型項目的代碼成千上萬,完整編譯的時間較長,
  • 編寫模塊代碼時,可以通過編譯檢查語法錯誤;
  • 為了提高開發效率,需要支持指定模塊的獨立編譯
    技術分享圖片

    23.3.解決方案

  • 將模塊名(module)作為目標名(偽目標)建立規則
  • 目標(module)對應的依賴為build build/module
  • 規則中的命令進入對應的模塊文件夾進行編譯
  • 編譯結果存放於build文件夾下

    23.4.關鍵技術點

    如何獲取make命令行中指定編譯的模塊名?
    預定義變量:$(MAKECMDGOALS),命令行中指定的目標名(make的命令行參數)

    技術分享圖片
    編程實驗:

    $(MODULES) : $(DIR_BUILD) $(DIR_BUILD)/$(MAKECMDGOALS)
    @echo "Begin to compile $@"
    @set -e; 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 .. ;

    註意:自動變量只能在規則的命令中使用,不能在依賴中使用

    23.5.Makefile中的代碼復用

    當不同規則中的命令大量重復時,可以考慮自定義函數
    Makefile中的自定義函數是一種代碼復用的方式
    技術分享圖片

23.6.思路

將編譯模塊的命令集作為自定義函數的具體實現
函數參數作為模塊名,函數調用後編譯參數指定的模塊
在不同的規則中調用該函數
技術分享圖片
編程實驗:

define makemodule
    cd $(1) &&     $(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 .. ; 
endef

23.7.總結

  • 編寫模塊代碼時可以通過模塊獨立編譯快速檢查語法錯誤
  • 自動變量只能在規則的命令中使用,不能在依賴中使用
  • Makefile中的自定義函數是代碼復用的一種方式
  • 當不同規則中的命令大量重復時,可以考慮自定義函數

    24.第三方庫的支持

    24.1.問題

    當需要使用第三方庫文件時,編譯環境中的makefile如何修改?

    24.2.經驗假設

  • 第三方庫通過函數調用的方式提供庫中的功能
  • 庫文件發布時都附帶了聲明庫函數原型的頭文件
  • 編譯階段使用頭文件,鏈接階段使用庫文件

    24.3.第三方庫在項目中的位置

    技術分享圖片

    24.4.第三方庫的編譯階段

    定義變量DIR_LIBS_INC用於指示頭文件的存儲位置
    DIR_LIBS_INC := $(DIR_PROJECT)/libs/inc
    使用DIR_LIBS_INC提示make頭文件的存儲位置
    Vpath %$(TYPE_INC) $(DIR_LIBS_INC)
    使用DIR_LIBS_INC提示編譯器頭文件的存儲位置
    CFLAGS += -i$(DIR_LIBS_INC)
    編程實驗(改動如下):
    技術分享圖片

    24.5.註意事項

    定於DIR_LIBS_LIB := libs/lib (第三方庫所在位置)
    鏈接時不會直接鏈接DIR_LIBS_LIB中的庫文件,需要先將庫文件拷貝到DIR_BUILD文件夾
    必須考慮拷貝後的庫文件和原始庫文件的新舊關系

    $(DIR_BUILD)/% : $(DIR_LIBS_LIB)/%
    $(CP) $^ $@

    24.6.第三方庫鏈接的支持

    定義變量EXTERNAL_LIB用於保存第三方庫列表
    目標link需要依賴第三方庫列表
    技術分享圖片
    原因是,可能存在子模塊庫名和第三方庫名相同的情況,這時我們要優先鏈接子模塊。
    編程實驗(改動如下):
    技術分享圖片

最終方案:模塊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_INC) $(DIR_LIBS_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) -I$(DIR_LIBS_INC)

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

MKDIR := mkdir
RM := rm -fr
CP := cp

項目主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
DIR_LIBS_INC := libs/inc
DIR_LIBS_LIB := libs/lib

APP := app.out

項目makefile中include包含的子模塊pro-rele.mk:


.PHONY : all compile link clean rebuild $(MODULES)

DIR_PROJECT := $(realpath .)
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
EXTERNAL_LIB := $(wildcard $(DIR_LIBS_LIB)/*)
EXTERNAL_LIB := $(patsubst $(DIR_LIBS_LIB)/%, $(DIR_BUILD)/%, $(EXTERNAL_LIB))

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

define makemodule
    cd $(1) &&     $(MAKE) all             DEBUG:=$(DEBUG)             DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD))             DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC))             DIR_LIBS_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_LIBS_INC))             CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG))             MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG))             MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) &&     cd .. ; 
endef

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

compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
    @echo "Begin to compile ..."
    @set -e;     for dir in $(MODULES);     do         $(call makemodule, $$dir)     done
    @echo "Compile Success!"

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

$(DIR_BUILD)/% : $(DIR_LIBS_LIB)/%
    $(CP) $^ $@

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

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

rebuild : clean all

$(MODULES) : $(DIR_BUILD) $(DIR_BUILD)/$(MAKECMDGOALS)
    @echo "Begin to compile $@"
    @set -e;     $(call makemodule, $@)

24.7.總結

  • 編譯環境必須支持第三方庫的使用(靜態庫或動態庫)
  • 工程開發中一般會使用特殊的文件夾存放第三方庫
  • 第三方庫所附帶的頭文件用於聲明庫函數(編譯階段需要)
  • 在鏈接階段先將庫文件拷貝到build文件夾,再進行連接

makefile(09)_擴展支持