前言

Makefile自動生成標頭檔案依賴是很常用的功能，本文的目的是想盡量詳細說明其中的原理和過程。

Makefile模板

首先給出一個本人在小專案中常用的Makefile模板，支援自動生成標頭檔案依賴。

CC      = gcc 
CFLAGS  = -Wall -O
INCLUDEFLAGS = 
LDFLAGS = 
OBJS    = seq.o
TARGETS = test_seq 

.PHONY:all 
all : $(TARGETS)

test_seq:test_seq.o $(OBJS)
    $(CC) -o [email protected] $^ $(LDFLAGS)

%.o:%.c
    $(CC) -o 
 
[email protected] -c $< $(CFLAGS) $(INCLUDEFLAGS)

%.d:%.c
    @set -e; rm -f [email protected]; $(CC) -MM $< $(INCLUDEFLAGS) > [email protected]$$$$; \
    sed 's,\($*\)\.o[ :]*,\1.o [email protected] : ,g' < [email protected]$$$$ > [email protected]; \
    rm -f 
 
[email protected]$$$$

-include $(OBJS:.o=.d)

.PHONY:clean 
clean:
    rm -f $(TARGETS) *.o *.d *.d.*

基礎知識

在進行下一步之前，首先需要了解make的執行步驟：

1. 讀入Makefile
2. 讀入被include的其它Makefile
3. 初始化Makefile中的變數
4. 推導隱晦規則，並分析所有規則
5. 為所有目標建立依賴關係鏈
6. 根據依賴關係，決定哪些目標需要重新生成
7. 執行生成命令

如何動態生成依賴關係？

從上面make的執行過程中可看出，要動態生成依賴關係，只能利用第2步讀入其它Makefile的機制。那麼，我們是否可以先把生成的依賴關係儲存到檔案，然後再把該檔案的內容包含進來？ 答案是Yes! 只要利用include的機制。

include關鍵字是用於讀入其它Makefile檔案。當該檔案不存在時，make會尋找是否有生成它的規則，如果有，則執行其生成命令，然後再嘗試讀入。在include前加減號"-"可以上make忽略其產生的錯誤，並不輸出任何錯誤資訊。

即是說，我們需要提供生成規則檔案的規則。例如，我們可以這樣動態生成標頭檔案依賴關係：

seq.d : seq.c
    @echo “seq.o seq.d : seq.c seq.h" > [email protected]

-include seq.d

當make執行時，Makefile中的內容將是這樣子（指記憶體上的資料）：

seq.d : seq.c
    @echo “seq.o seq.d : seq.c seq.h" > [email protected]

seq.o seq.d : seq.c seq.h

特別注意的是，由於對seq.c和seq.h的修改需要更新seq.d的內容（因為依賴關係可能已變化），因此seq.d也要在依賴關係的目標列表中。

自動生成標頭檔案依賴

基於上面的例子，現在可以開始討論如何自動生成標頭檔案依賴。

自動生成依賴關係

大多數c/c++編譯器提供了-M選項，可自動尋找原始檔依賴的標頭檔案，並生成依賴規則。對於gcc，需要使用-MM選項，否則它會把系統依賴的標頭檔案也包含進來。例如執行下面一個命令：

    gcc -MM seq.c

將輸出：

    seq.o : seq.c seq.h

但我們需要結果是seq.d也要包含在目標列表中，所以還需要對它進行文字處理。因此，上面的例子可改為：

seq.d : seq.c
    @set -e; \
    gcc -MM $< > [email protected]$$$$; \
    sed 's,\($*\)\.o[ :]*,\1.o [email protected] : ,g' < [email protected]$$$$ > [email protected]; \
    rm -f [email protected]$$$$

-include seq.d

生成規則中的執行命令解釋

第一個命令@set -e。@關鍵字告訴make不輸出該行命令；set -e的作用是，當後面的命令的返回值非0時，立即退出。

那麼為什麼要把幾個命令寫在”同一行“（是對於make來說，因為\的作用就是連線行），並用分號隔開每個命令？因為在Makefile這樣做才能使上一個命令作用於下一個命令。這裡是想要set -e作用於後面的命令。

第二個命令gcc -MM $< > [email protected]$$$$, 作用是根據原始檔生成依賴關係，並儲存到臨時檔案中。內建變數$<的值為第一個依賴檔案（那seq.c)，$$$$為字串"$$"，由於makefile中所有的$字元都是特殊字元（即使在單引號之中！），要得到普通字元$，需要用$$來轉義; 而$$是shell的特殊變數，它的值為當前程序號；使用程序號為字尾的名稱建立臨時檔案，是shell程式設計常用做法，這樣可保證檔案唯一性。

第三個命令作用是將目標檔案加入依賴關係的目錄列表中，並儲存到目標檔案。關於正則表示式部分就不說了，唯一要注意的是內建變數$*，$*的值為第一個依賴檔案去掉字尾的名稱（這裡即是seq)。

第四個命令是將該臨時檔案刪除。

如果把內建變數都替換成其值後，實際內容是這樣子：

seq.d : seq.c
    @set -e; \
    gcc -MM seq.c > seq.d.$$$$; \
    sed 's,\(seq\)\.o[ :]*,\1.o seq.d : ,g' < seq.d.$$$$ > seq.d; \
    rm -f seq.d.$$$$

-include seq.d

Makefile的模式匹配

最後，再把Makefile的模式匹配應用上，就完成自動生成標頭檔案依賴功能了：

%.d : %.c
    @set -e; \
    gcc -MM [email protected] > [email protected]$$$$; \
    sed 's,\($*\)\.o[ :]*,\1.o [email protected] : ,g' < [email protected]$$$$ > [email protected]; \
    rm -f [email protected]$$$$

-include seq.d

參考資料