make只是一個根據指定的Shell命令進行構建的工具
在linux和unix中,有一個強大的使用程式,叫make,可以用它來管理多模組程式的編譯和連結,直至生成可執行檔案
make使用程式讀取一個說明檔案,稱為Makefile,Makefile檔案中描述了整個軟體工程的 編譯規則和各個檔案之間的依賴關係;
Makefile就像是一個Shell指令碼一樣,其中可以執行作業系統的命令,它帶來的好處就是我們能夠實現“自動化編譯”,一旦寫好,只要一個make命令,整個軟體功能就完全自動編譯,極大的提高了軟體開發的效率;
make是一個命令工具,是一個解釋Makefile中指令的命令工具,一般來說大多數IDE都有這個命令
使用make可以是重新編譯的次數達到最小化;
格式
Makefile檔案由一系列規則(rules)構成。每條規則的形式如下。
<target> : <prerequisites>
[tab] <commands>
target
一個目標(target)就構成一條規則。目標通常是檔名,指明Make命令所要構建的物件,
目標可以是一個檔名,也可以是多個檔名,之間用空格分隔。
偽目標
除了檔名,目標還可以是某個操作的名字,這稱為"偽目標"(phony target)
clean:
rm *.o
clean不是檔名,而是操作的名字,屬於“偽目標”,作用是刪除物件檔案
$ make clean
注:如果當前目錄中,正好有一個檔案叫做clean,那麼此命令不會執行。因為make發現clean檔案已經存在,就沒有必要重新構建 了。就不會執行rm命令。
為了避免這種情況,可以宣告clean是“偽目標”。
.PHONY: clean
clean:
rm *.o temp
宣告clean是偽目標之後,make就不會去檢車是否存在一個叫做clean的檔案,而是每次執行都執行對應的命令。
如果Make命令執行時沒有指定目標,預設會執行Makefile檔案的第一個目標。
$ make
上面程式碼執行Makefile檔案的第一個目標。
prerequistites
前置條件通常是一組檔名,之間用空格分隔。它指定了"目標"是否重新構建的判斷標準:只要有一個前置檔案不存在,或者有過更新(前置檔案的last-modification時間戳比目標的時間戳新),"目標"就需要重新構建。
result.txt: source.txt
cp source.txt result.txt
上面程式碼中,構建 result.txt 的前置條件是 source.txt 。如果當前目錄中,source.txt 已經存在,那麼make result.txt
可以正常執行,否則必須再寫一條規則,來生成 source.txt 。
注:若前置檔案不存在,那麼make會自動尋找生成前置檔案的語句,會先生成前置檔案再生成目標檔案,如沒有生成前置檔案的語句,那麼則無法生成目標檔案。
source.txt:
echo "this is the source" > source.txt
上面程式碼中,source.txt後面沒有前置條件,就意味著它跟其他檔案都無關,只要這個檔案還不存在,每次呼叫make source.txt
,它都會生成。
注:多次執行生成同一檔案,若前置條件不變,則不會重複生成。
$ make result.txt
$ make result.txt
上面命令連續執行兩次make result.txt
。第一次執行會先新建 source.txt,然後再新建 result.txt。第二次執行,Make發現 source.txt 沒有變動(時間戳晚於 result.txt),就不會執行任何操作,result.txt 也不會重新生成。
多檔案
如果需要生成多個檔案,往往採用下面的寫法。
source: file1 file2 file3
上面程式碼中,source 是一個偽目標,只有三個前置檔案,沒有任何對應的命令。
$ make source
執行make source
命令後,就會一次性生成 file1,file2,file3 三個檔案。這比下面的寫法要方便很多。
$ make file1
$ make file2
$ make file3
commands
命令(commands)表示如何更新目標檔案,由一行或多行的Shell命令組成。它是構建"目標"的具體指令,它的執行結果通常就是生成目標檔案。
每行命令之前必須有一個tab鍵。如果想用其他鍵,可以用內建變數.RECIPEPREFIX宣告。
.RECIPEPREFIX = >
all:
> echo Hello, world
上面程式碼用.RECIPEPREFIX指定,大於號(>)替代tab鍵。所以,每一行命令的起首變成了大於號,而不是tab鍵。
注
需要注意的是,每行命令在一個單獨的shell中執行。這些Shell之間沒有繼承關係。
var-lost:
export foo=bar
echo "foo=[$$foo]"
上面程式碼執行後(make var-lost
),取不到foo的值。因為兩行命令在兩個不同的程式執行。
-
一個解決辦法是將兩行命令寫在一行,中間用分號分隔。
var-kept: export foo=bar; echo "foo=[$$foo]"
-
另一個解決辦法是在換行符前加反斜槓轉義。
var-kept: export foo=bar; \ echo "foo=[$$foo]"
-
最後一個方法是加上
.ONESHELL:
命令。.ONESHELL: var-kept: export foo=bar; echo "foo=[$$foo]"
語法
註釋
井號(#)在Makefile中表示註釋。
# 這是註釋
result.txt: source.txt
# 這是註釋
cp source.txt result.txt # 這也是註釋
echoing
正常情況下,make會列印每條命令,然後再執行,這就叫做回聲(echoing)。
test:
# 這是測試
執行上面的規則,會得到下面的結果。
$ make test
# 這是測試
在命令的前面加上@,就可以關閉回聲。
test:
@# 這是測試
注:由於在構建過程中,需要了解當前在執行哪條命令,所以通常只在註釋和純顯示的echo命令前面加上@。
test:
@# 這是測試
@echo TODO
萬用字元
萬用字元(wildcard)用來指定一組符合條件的檔名。Makefile 的萬用字元與 Bash 一致,主要有星號(*)、問號(?)和 [...] 。比如, *.o 表示所有字尾名為o的檔案。
模式匹配
Make命令允許對檔名,進行類似正則運算的匹配,主要用到的匹配符是%。比如,假定當前目錄下有 f1.c 和 f2.c 兩個原始碼檔案,需要將它們編譯為對應的物件檔案。
%.o: %.c
等同於下面的寫法。
f1.o: f1.c
f2.o: f2.c
使用匹配符%,可以將大量同型別的檔案,只用一條規則就完成構建。
變數和賦值符
Makefile 允許使用等號自定義變數。
txt = Hello World
test:
@echo $(txt)
上面程式碼中,變數 txt 等於 Hello World。呼叫時,變數需要放在 $( ) 之中。
呼叫Shell變數,需要在美元符號前,再加一個美元符號,這是因為Make命令會對美元符號轉義。
test:
@echo $$HOME
變數賦值
v1 = $(v2)
上面程式碼中,變數 v1 的值是另一個變數 v2。這時會產生一個問題,v1 的值到底在定義時擴充套件(靜態擴充套件),還是在執行時擴充套件(動態擴充套件)?如果 v2 的值是動態的,這兩種擴充套件方式的結果可能會差異很大。
靜態擴充套件是指v1的值是v2的初始值,而動態擴充套件是v1的值會隨著v2進行改變
為了解決類似問題,Makefile一共提供了四個賦值運算子 (=、:=、?=、+=),它們的區別請看StackOverflow
VARIABLE = value
# 在執行時擴充套件,允許遞迴擴充套件。動態擴充套件
VARIABLE := value
# 在定義時擴充套件。靜態擴充套件
VARIABLE ?= value
# 只有在該變數為空時才設定值。
VARIABLE += value
# 將值追加到變數的尾端。
example
/* Filename: Makefile*/
x := foo
y := $(x) bar
x := later
a = foo
b = $(a) bar
a = later
test:
@echo x - $(x)
@echo y - $(y)
@echo a - $(a)
@echo b - $(b)
make test
prints:
x - later
y - foo bar
a - later
b - later bar
y值中用的是x的初始值,而b值用的是a的最新值。
:= 靜態擴充套件
= 動態擴充套件
內建變數
Make命令提供一系列內建變數,比如,$(CC)
指向當前使用的編譯器,$(MAKE)
指向當前使用的Make工具。這主要是為了跨平臺的相容性,詳細的內建變數清單見手冊。
自動變數
1. $@
$@指代當前目標,就是Make命令當前構建的那個目標。比如,make foo
的 $@ 就指代foo。
a.txt b.txt:
touch $@
等同於下面的寫法。
a.txt:
touch a.txt
b.txt:
touch b.txt
2. $<
\(< 指代第一個前置條件。比如,規則為 t: p1 p2,那麼\)< 就指代p1。
a.txt: b.txt c.txt
cp $< $@
等同於下面的寫法。
a.txt: b.txt c.txt
cp b.txt a.txt
3. $?
\(? 指代比目標更新的所有前置條件,之間以空格分隔。比如,規則為 t: p1 p2,其中 p2 的時間戳比 t 新,\)?就指代p2。
4. $^
$^ 指代所有前置條件,之間以空格分隔。比如,規則為 t: p1 p2,那麼 $^ 就指代 p1 p2 。
5. $*
\(* 指代匹配符 % 匹配的部分, 比如% 匹配 f1.txt 中的f1 ,\)* 就表示 f1。
6. $(@D) 和 $(@F)
$(@D) 和 $(@F) 分別指向 $@ 的目錄名和檔名。
比如,\(@是 src/input.c,那麼\)(@D) 的值為 src ,$(@F) 的值為 input.c。
7. $(<D) 和 $(<F)
$(<D) 和 $(<F) 分別指向 $< 的目錄名和檔名。
example
dest/%.txt: src/%.txt
@[ -d dest ] || mkdir dest
cp $< $@
上面程式碼將 src 目錄下的 txt 檔案,拷貝到 dest 目錄下。首先判斷 dest 目錄是否存在,如果不存在就新建,然後,$< 指代前置檔案(src/%.txt), $@ 指代目標檔案(dest/%.txt)。
判斷和迴圈
Makefile使用 Bash 語法,完成判斷和迴圈。
ifeq ($(CC),gcc)
libs=$(libs_for_gcc)
else
libs=$(normal_libs)
endif
上面程式碼判斷當前編譯器是否 gcc ,然後指定不同的庫檔案。
LIST = one two three
all:
for i in $(LIST); do \
echo $$i; \
done
# 等同於
all:
for i in one two three; do \
echo $i; \
done
上面程式碼的執行結果。
one
two
three
函式
Makefile 還可以使用函式,格式如下。
$(function arguments)
# 或者
${function arguments}
Makefile提供了許多內建函式,可供呼叫。下面是幾個常用的內建函式。
1. shell 函式
shell 函式用來執行 shell 命令
srcfiles := $(shell echo src/{00..99}.txt)
2. wildcard 函式
wildcard 函式用來在 Makefile 中,替換 Bash 的萬用字元。
srcfiles := $(wildcard src/*.txt)
3. subst 函式
subst 函式用來文字替換,格式如下。
$(subst from,to,text)
下面的例子將字串"feet on the street"替換成"fEEt on the strEEt"。
$(subst ee,EE,feet on the street)
comma:= ,
empty:=
# space變數用兩個空變數作為識別符號,當中是一個空格
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))
# bar is now `a,b,c'.
4. patsubst函式
patsubst 函式用於模式匹配的替換,格式如下。
$(patsubst pattern,replacement,text)
下面的例子將檔名"x.c.c bar.c",替換成"x.c.o bar.o"。
$(patsubst %.c,%.o,x.c.c bar.c)
5. 替換字尾名
替換字尾名函式的寫法是:變數名 + 冒號 + 字尾名替換規則。它實際上patsubst函式的一種簡寫形式。
min: $(OUTPUT:.js=.min.js)
上面程式碼的意思是,將變數OUTPUT中的字尾名 .js 全部替換成 .min.js 。
注意
makefile書寫主要注意的是:
- 編譯規則
- 依賴關係
- 倒推原理
- 使用make命令去執行
- 如果已經是最新的檔案的時候,就不會再去編譯執行了
- make去讀取makefile的時候,是按照依賴檔案的順序去查詢並且執行命令的
- make在編譯的時候,如果發現被編譯的檔案已經是最新的了,就不會再去編譯(減少了編譯次數)
- make檔案是根據被編譯檔案的時間戳去判斷檔案是否是當前最新的檔案,如果是最新的,那麼就會去重新編譯,如果不是最新的,就不會去進行編譯;
- 千萬要注意makefile中編譯命令前面的分隔符
例項
#Sample
CC := gcc
scriptName := FMindex
$(scriptName): main.o FMindex.o getRank.o BWT.o
$(CC) -o $@ $^
@echo DONE!
BWT.o: BWT.c bwt.h
$(CC) -c $<
getRank.o: getRank.c getRank.h
$(CC) -c $<
FMindex.o: FMindex.c FMindex.h
$(CC) -c $<
main.o: main.c
$(CC) -c $<
.PHONY: clean
clean:
rm *.o
rm $(scriptName)
參考文章