Makefile 就是爲這個問題而生的,它定義了一套規則,決定了哪些文件要先編譯,哪些文件後編譯,哪些文件要重新編譯。
-- 良許linux
轉自: https://zhuanlan.zhihu.com/p/56489231
作者: 良許linux
1、什麼是 Makefile
一個企業級項目,通常會有很多源文件,有時也會按功能、類型、模塊分門別類的放在不同的目錄中,有時候也會在一個目錄裏存放了多個程序的源代碼。
這時,如何對這些代碼的編譯就成了個問題。Makefile 就是爲這個問題而生的,它定義了一套規則,決定了哪些文件要先編譯,哪些文件後編譯,哪些文件要重新編譯。
整個工程通常只要一個 make 命令就可以完成編譯、鏈接,甚至更復雜的功能。可以說,任何一個 Linux 源程序都帶有一個Makefile 文件。
2、Makefile 的優點
- 管理代碼的編譯,決定該編譯什麼文件,編譯順序,以及是否需要重新編譯;
- 節省編譯時間。如果文件有更改,只需重新編譯此文件即可,無需重新編譯整個工程;
- 一勞永逸。Makefile 通常只需編寫一次,後期就不用過多更改。
3、命名規則
一般來說將 Makefile 命名爲 Makefile 或 makefile 都可以,但很多源文件的名字是小寫的,所以更多程序員採用的是 Makefile 的名字,因爲這樣可以將 Makefile 居前顯示。
如果將 Makefile 命爲其它名字,比如 Makefile_demo,也是允許的,但使用的時候應該採用以下方式:
make -f Makefile_demo
4、基本規則
Makefile 的基本格式爲:
目標: 依賴
(tab)規則
- 目標 --> 需要生成的目標文件
- 依賴 --> 生成該目標所需的一些文件
- 規則 --> 由依賴文件生成目標文件的手段
- tab --> 每條規則必須以 tab 開頭,使用空格不行
例如我們經常寫的 gcc test.c -o test,使用 Makefile 可以寫成:
test: test.c
gcc test.c -o test
其中,第一行中的 test 就是要生成的目標,test.c 就是依賴,第二行就是由 test.c 生成 test 的規則。
Makefile 中有時會有多個目標,但 Makefile 會將第一個目標定爲終極目標。
5、工作原理
目標的生成
- 檢查規則中的依賴文件是否存在;
- 若依賴文件不存在,則尋找是否有規則用來生成該依賴文件。
比如上圖中,生成 calculator 的規則是 gcc main.o add.o sub.o mul.o div.o -o,Makefile 會先檢查 main.o、add.o、sub.o、 mul.o、 div.o 是否存在,如果不存在,就會再尋找是否有規則可以生成該依賴文件。
比如缺少了 main.o 這個依賴,Makefile 就會在下面尋找是否有規則生成 main.o。當它發現 gcc main.c -o main.o這條規則可以生成 main.o 時,它就利用此規則生成 main.o,然後再生成終極目標 calculator。
整個過程是向下尋找依賴,再向上執行命令,生成終極目標。
目標的更新
- 檢查目標的所有依賴,任何一個依賴有更新時,就重新生成目標;
- 目標文件比依賴文件時間晚,則需要更新。
比如,修改了 main.c,則 main.o 目標會被重新編譯,當 main.o 更新時,終極目標 calculator 也會被重新編譯。其它文件的更新也是類推。
6、命令執行
make:使用此命令即可按預定的規則生成目標文件。 如果 Makefile 文件的名字不爲 Makefile 或 makefile,則應加上 -f 選項,比如:
make -f Makefile_demo
make clean:清除編譯過程中產生的中間文件(.o文件)及最終目標文件。
如果當前目錄下存在名爲 clean 的文件,則該命令不執行。
解決辦法是僞目標聲明:.PHONY:clean。
特殊符號:
- - :表示此命令即使執行出錯,也依然繼續執行後續命令。如:-rm a.o build/
- @:表示該命令只執行,不回顯。一般規則執行時會在終端打印出正在執行的規則,而加上此符號後將只執行命令,不回顯執行的規則。如:@echo $(SOURCE)
7、普通變量
變量定義及賦值:
變量直接採用賦值的方法即可完成定義,如:
INCLUDE = ./include/
變量取值:
用括號括起來再加個美元符,如:
FOO = $(OBJ)
系統自帶變量:
通常都是大寫,比如 CC、PWD、CFLAG,等等。
有些有默認值,有些沒有。比如常見的幾個:
- CPPFLAGS : 預處理器需要的選項 如:-I
- CFLAGS:編譯的時候使用的參數 –Wall –g -c
- LDFLAGS :鏈接庫使用的選項 –L -l
變量的默認值可以修改,比如 CC 默認值是 cc,但可以修改爲 gcc:CC=gcc
8、自動變量
常用自動變量:
Makefile 提供了很多自動變量,但常用的爲以下三個。這些自動變量只能在規則中的命令中使用,其它地方使用都不行。
- $@ --> 規則中的目標
- $< --> 規則中的第一個依賴條件
- $^ --> 規則中的所有依賴條件
例如:
app: main.c func1.c fun2.c gcc $^ - o $@
其中:$^ 表示 main.c func1.c fun2.c,$< 表示 main.c,$@ 表示 app。
模式規則:
模式規則是在目標及依賴條件中使用 % 來匹配對應的文件,比如在目錄下有 main.c、func1.c、func2.c 三個文件,對這三個文件的編譯可以由一條規則完成:
%.o:%.c $(CC) –c $< -o $@
這條模式規則表示:
main.o 由 main.c 生成, func1.o 由 func1.c 生成, func2.o 由 func2.c 生成。
這就是模式規則的作用,可以一次匹配目錄下的所有文件。
9、函數
Makefile 也爲我們提供了大量的函數,同樣經常使用到的函數爲以下兩個。需要注意的是,Makefile 中所有的函數必須都有返回值。在以下的例子中,假如目錄下有 main.c、func1.c、func2.c 三個文件。
通配符:
用於查找指定目錄下指定類型的文件,跟的參數就是目錄+文件類型,比如:
src = $(wildcard ./src/*.c)
這句話表示:找到 ./src 目錄下所有後綴爲 .c 的文件,並賦給變量 src。
命令執行完成後,src 的值爲:main.c func1.c fun2.c。
patsubst:
匹配替換,例如以下例子,用於從 src 目錄中找到所有 .c 結尾的文件,並將其替換爲 .o 文件,並賦值給 obj。
obj = $(patsubst %.c ,%.o ,$(src))
命令執行完成後,obj 的值爲 main.o func1.o func2.o。
特別地,如果要把所有 .o 文件放在 obj 目錄下,可用以下方法:
obj = $(patsubst ./src/%.c, ./obj/%.o, $(src))
10、小結
Makefile 其實提供了非常非常多的功能,但本文所寫的對於一般的企業應用完全夠用了。特別對於初學者,學習一些基礎知識(如本文),再輔一些案例(如本系列的幾個案例),完全可以達到企業用人標準了。正所謂要抓住事物的主要矛盾,可以先把基礎知識吃透再去延伸 Makefile 的其它知識。