1. 程式人生 > >make之makefile 三 書寫規則

make之makefile 三 書寫規則

makefile的規則包括兩個部分,一個是依賴關係,一個是生成目標的方法。

在Makefile中,規則的順序是非常重要的,由於,Makefile中僅僅應該有一個最終目標,其他的目標都是被這個目標所連帶出來的,所以一定要讓make知道你的最終目標是什麼。一般來說,定義在Makefile中的目標可能會有非常多,可是第一條規則中的目標將被確立為最終的目標。假設第一條規則中的目標有非常多個,那麼,第一個目標會成為最終的目標。make所完成的也就是這個目標。

好了,還是讓我們來看一看怎樣書寫規則。


一、規則舉例

foo.o : foo.c defs.h # foo模組
    cc -c -g foo.c

看到這個樣例,各位應該不是非常陌生了,前面也已說過,foo.o是我們的目標,foo.c和defs.h是目標所依賴的原始檔,而唯獨一個命令“cc -c -g foo.c”(以Tab鍵開頭)。這個規則告訴我們兩件事:

1、檔案的依賴關係,foo.o依賴於foo.c和defs.h的檔案,假設foo.c和defs.h的檔案日期要比foo.o檔案日期要新,或是foo.o不存在,那麼依賴關係發生。
2、假設生成(或更新)foo.o檔案。也就是那個cc命令,其說明了,怎樣生成foo.o這個檔案。(當然foo.c檔案include了defs.h檔案)


二、規則的語法

targets : prerequisites
command
...

或是這樣: 

targets : prerequisites ; command
command
...

targets是檔名稱,以空格分開,能夠使用萬用字元。一般來說,我們的目標基本上是一個檔案,但也有可能是多個檔案。

command是命令列,假設其不跟“targets : rerequisites”在同一行,那麼,必須以[Tab鍵]開頭,假設和prerequisites在一行,那麼能夠用分號做為分隔。(見上)

prerequisites也就是目標所依賴的檔案(或依賴目標)。假設當中的某個檔案要比目標檔案要新,那麼,目標就被覺得是“過時的”,被覺得是須要重生成的。這個在前面已經講過了。

假設命令太長,你能夠使用反斜框(‘/’)作為換行符。make對一行上有多少個字元沒有限制。規則告訴make兩件事,檔案的依賴關係和怎樣成成目標檔案。

一般來說,make會以UNIX的標準Shell,也就是/bin/sh來執行命令。


三、在規則中使用萬用字元

假設我們想定義一系列比較相似的檔案,我們非常自然地就想起使用萬用字元。make支援三種萬用字元:“*”,“?”和“[...]”。這是和Unix的B-Shell是相同的。

波浪號(“~”)字元在檔名稱中也有比較特殊的用途。假設是“~/test”,這就表示當前使用者的$(HOME)資料夾下的test資料夾。而“~hchen/test”則表示使用者hchen的宿主資料夾下的test資料夾。(這些都是Unix下的小知識了,make也支援)而在Windows或是MS-DOS下,使用者沒有宿主資料夾,那麼波浪號所指的資料夾則依據環境變數“HOME”而定。

萬用字元代替了你一系列的檔案,如“*.c”表示所有後綴名為.c的檔案。一個需要我們注意的是,假設我們的檔名稱中有萬用字元,如:“*”,那麼能夠用轉義字元“/”,如“/*”來表示真實的“*”字元,而不是隨意長度的字串。

好吧,還是先來看幾個樣例吧:

clean:
    rm -f *.o

上面這個樣例我不不多說了,這是作業系統Shell所支援的萬用字元。這是在命令中的萬用字元。

print: *.c
lpr -p $?
touch print

上面這個樣例說明了萬用字元也能夠在我們的規則中,目標print依賴於全部的[.c]檔案。當中的“$?”是一個自己主動化變數,稍微後面會講解。

objects = *.o

上面這個樣例,表示了,通符相同能夠用在變數中。並非說[*.o]會展開,不!objects的值就是“*.o”。Makefile中的變數事實上就是C/C++中的巨集。假設你要讓萬用字元在變數中展開,也就是讓objects的值是全部[.o]的檔名稱的集合,那麼,你能夠這樣:

objects := $(wildcard *.o)

這樣的使用方法由keyword“wildcard”指出,關於Makefile的keyword,我們將在後面討論。


四、檔案搜尋

在一些大的工程中,有大量的原始檔,我們通常的做法是把這很多的原始檔分類,並存放在不同的資料夾中。所以,當make須要去找尋檔案的依賴關係時,你能夠在檔案前加上路徑,但最好的方法是把一個路徑告訴make,讓make在自己主動去找。

Makefile檔案裡的特殊變數“VPATH”就是完成這個功能的,假設沒有指明這個變數,make僅僅會在當前的資料夾中去找尋依賴檔案和目標檔案。假設定義了這個變數,那麼,make就會在噹噹前資料夾找不到的情況下,到所指定的資料夾中去找尋檔案了。

VPATH = src:../headers

上面的的定義指定兩個資料夾,“src”和“../headers”,make會依照這個順序進行搜尋。資料夾由“冒號”分隔。(當然,當前資料夾永遠是最高優先搜尋的地方)

另一個設定檔案搜尋路徑的方法是使用make的“vpath”keyword(注意,它是全小寫的),這不是變數,這是一個make的keyword,這和上面提到的那個VPATH變數非常相似,可是它更為靈活。它能夠指定不同的檔案在不同的搜尋資料夾中。這是一個非常靈活的功能。它的使用方法有三種:

1、vpath <pattern> <directories>

為符合模式<pattern>的檔案指定搜尋資料夾<directories>。

2、vpath <pattern>

清除符合模式<pattern>的檔案的搜尋資料夾。

3、vpath

清除全部已被設定好了的檔案搜尋資料夾。

vapth使用方法中的<pattern>須要包括“%”字元。“%”的意思是匹配零或若干字元,比如,“%.h”表示全部以“.h”結尾的檔案。<pattern>指定了要搜尋的檔案集,而<directories>則指定了<pattern>的檔案集的搜尋的資料夾。比如:

vpath %.h ../headers

該語句表示,要求make在“../headers”資料夾下搜尋全部以“.h”結尾的檔案。(假設某檔案在當前資料夾沒有找到的話)

我們能夠連續地使用vpath語句,以指定不同搜尋策略。假設連續的vpath語句中出現了相同的<pattern>,或是被反覆了的<pattern>,那麼,make會依照vpath語句的先後順序來執行搜尋。如:

vpath %.c foo
vpath % blish
vpath %.c bar

其表示“.c”結尾的檔案,先在“foo”資料夾,然後是“blish”,最後是“bar”資料夾。

vpath %.c foo:bar
vpath % blish

而上面的語句則表示“.c”結尾的檔案,先在“foo”資料夾,然後是“bar”資料夾,最後才是“blish”資料夾。

我做了個簡單的例子工程目錄檔案如下

├── Makefile
├── Makefile.mk
├── include
│   ├── include.h
│   └── include.h.gch
└── src
    ├── include.c
    └── main.c

此時我在外面的makefile檔案的內容如下

#makefile demo
vpath %.h include   #make的時候會去該資料夾找尋所缺檔案
vpath %.c src       #同上

OBJ_FILE=main.o include.o
CC=gcc

main:$(OBJ_FILE)
    $(CC) -o [email protected] $(OBJ_FILE) 
include.o:include.c include.h
    $(CC) -c $^ -Iinclude
main.o:main.c include.h
    $(CC) -c $^ -Iinclude 

include ./Makefile.mk

以上示例是使用vpath的使用示例。

注:Makefile.mk檔案裡面是clean的東西,所以無關緊要。


五、偽目標

最早先的一個樣例中,我們提到過一個“clean”的目標,這是一個“偽目標”,

clean:
    rm *.o temp

正像我們前面樣例中的“clean”一樣,即然我們生成了很多檔案編譯檔案,我們也應該提供一個清除它們的“目標”以備完整地重編譯而用。 (以“make clean”來使用該目標)

由於,我們並不生成“clean”這個檔案。“偽目標”並非一個檔案,僅僅是一個標籤,由於“偽目標”不是檔案,所以make無法生成它的依賴關係和決定它是否要執行。我們唯獨通過顯示地指明這個“目標”才幹讓其生效。當然,“偽目標”的取名不能和檔名稱重名,不然其就失去了“偽目標”的意義了。

當然,為了避免和檔案重名的這樣的情況,我們能夠使用一個特殊的標記“.PHONY”來顯示地指明一個目標是“偽目標”,向make說明,無論是否有這個檔案,這個目標就是“偽目標”。

.PHONY : clean

僅僅要有這個宣告,無論是否有“clean”檔案,要執行“clean”這個目標,唯獨“make clean”這樣。於是整個過程能夠這樣寫:

.PHONY: clean
clean:
    rm *.o temp

偽目標一般沒有依賴的檔案。可是,我們也能夠為偽目標指定所依賴的檔案。偽目標相同能夠作為“預設目標”,僅僅要將其放在第一個。一個演示例子就是,假設你的Makefile須要一口氣生成若干個可執行檔案,但你僅僅想簡單地敲一個make完事,而且,全部的目標檔案都寫在一個Makefile中,那麼你能夠使用“偽目標”這個特性:

all : prog1 prog2 prog3
.PHONY : all

prog1 : prog1.o utils.o
    cc -o prog1 prog1.o utils.o

prog2 : prog2.o
    cc -o prog2 prog2.o

prog3 : prog3.o sort.o utils.o
    cc -o prog3 prog3.o sort.o utils.o

我們知道,Makefile中的第一個目標會被作為其預設目標。我們聲明瞭一個“all”的偽目標,其依賴於其他三個目標。由於偽目標的特性是,總是被執行的,所以其依賴的那三個目標就總是不如“all”這個目標新。所以,其他三個目標的規則總是會被決議。也就達到了我們一口氣生成多個目標的目的。“.PHONY : all”聲明瞭“all”這個目標為“偽目標”。

隨便提一句,從上面的樣例我們能夠看出,目標也能夠成為依賴。所以,偽目標相同也可成為依賴。看以下的樣例:

.PHONY: cleanall cleanobj cleandiff

cleanall : cleanobj cleandiff
    rm program

cleanobj :
    rm *.o

cleandiff :
    rm *.diff

“make clean”將清除全部要被清除的檔案。“cleanobj”和“cleandiff”這兩個偽目標有點像“子程式”的意思。我們能夠輸入“make cleanall”和“make cleanobj”和“make cleandiff”命令來達到清除不同種類檔案的目的。

六、多目標

Makefile的規則中的目標能夠不止一個,其支援多目標,有可能我們的多個目標同一時候依賴於一個檔案,而且其生成的命令大體相似。於是我們就能把其合併起來。當然,多個目標的生成規則的執行命令是同一個,這可能會給我們帶來麻煩,只是好在我們的能夠使用一個自己主動化變數“[email protected]”(關於自己主動化變數,將在後面講述),這個變量表示著眼下規則中全部的目標的集合,這樣說可能非常抽象,還是看一個樣例吧。

bigoutput littleoutput : text.g
    generate text.g -$(subst output,,[email protected]) > [email protected]

上述規則等效於:

bigoutput : text.g
    generate text.g -big > bigoutput
littleoutput : text.g
    generate text.g -little > littleoutput

當中,-$(subst output,,[email protected])中的“$”表示執行一個Makefile的函式,函式名為subst,後面的為引數。關於函式,將在後面講述。這裡的這個函式是擷取字串的意思,“[email protected]”表示目標的集合,就像一個數組,“[email protected]”依次取出目標,並執於命令。

(上面這節這段好高階,平時應該很少用到)


七、靜態模式

靜態模式能夠更加easy地定義多目標的規則,能夠讓我們的規則變得更加的有彈性和靈活。我們還是先來看一下語法:

<targets ...>: <target-pattern>: <prereq-patterns ...>
<commands>
...


targets定義了一系列的目標檔案,能夠有萬用字元。是目標的一個集合。

target-parrtern是指明瞭targets的模式,也就是的目標集模式。

prereq-parrterns是目標的依賴模式,它對target-parrtern形成的模式再進行一次依賴目標的定義。

這樣描寫敘述這三個東西,可能還是沒有說清晰,還是舉個樣例來說明一下吧。假設我們的<target-parrtern>定義成“%.o”,意思是我們的<target>集合中都是以“.o”結尾的,而假設我們的<prereq-parrterns>定義成“%.c”,意思是對<target-parrtern>所形成的目標集進行二次定義,其計算方法是,取<target-parrtern>模式中的“%”(也就是去掉了[.o]這個結尾),併為其加上[.c]這個結尾,形成的新集合。

所以,我們的“目標模式”或是“依賴模式”中都應該有“%”這個字元,假設你的檔名稱中有“%”那麼你能夠使用反斜槓“/”進行轉義,來標明真實的“%”字元。

看一個樣例:

objects = foo.o bar.o

all: $(objects)

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


上面的樣例中,指明瞭我們的目標從$object中獲取,“%.o”表明要全部以“.o”結尾的目標,也就是“foo.o bar.o”,也就是變數$object集合的模式,而依賴模式“%.c”則取模式“%.o”的“%”,也就是“foo bar”,併為其加下“.c”的字尾,於是,我們的依賴目標就是“foo.c bar.c”。而命令中的“$<”和“[email protected]”則是自己主動化變數,“$<”表示全部的依賴目標集(也就是“foo.c bar.c”),“[email protected]”表示目標集(也就是“foo.o bar.o”)。於是,上面的規則展開後等效於以下的規則:

foo.o : foo.c
$(CC) -c $(CFLAGS) foo.c -o foo.o
bar.o : bar.c
$(CC) -c $(CFLAGS) bar.c -o bar.o

試想,假設我們的“%.o”有幾百個,那種我們僅僅要用這樣的非常easy的“靜態模式規則”就能夠寫完一堆規則,實在是太有效率了。“靜態模式規則”的使用方法非常靈活,假設用得好,那會一個非常強大的功能。再看一個樣例:

files = foo.elc bar.o lose.o

$(filter %.o,$(files)): %.o: %.c
$(CC) -c $(CFLAGS) $< -o [email protected]
$(filter %.elc,$(files)): %.elc: %.el
emacs -f batch-byte-compile $<


$(filter %.o,$(files))表示呼叫Makefile的filter函式,過濾“$filter”集,僅僅要當中模式為“%.o”的內容。其的它內容,我就不用多說了吧。這個例字展示了Makefile中更大的彈性。


八、自己主動生成依賴性

在Makefile中,我們的依賴關係可能會須要包括一系列的標頭檔案,比方,假設我們的main.c中有一句“#include "defs.h"”,那麼我們的依賴關係應該是:

main.o : main.c defs.h

可是,假設是一個比較大型的工程,你必需清晰哪些C檔案包括了哪些標頭檔案,而且,你在新增或刪除標頭檔案時,也須要小心地改動Makefile,這是一個非常沒有維護性的工作。為了避免這樣的繁重而又easy出錯的事情,我們能夠使用C/C++編譯的一個功能。大多數的C/C++編譯器都支援一個“-M”的選項,即自己主動找尋原始檔裡包括的標頭檔案,並生成一個依賴關係。比如,假設我們執行以下的命令:

cc -M main.c

其輸出是:

main.o : main.c defs.h

於是由編譯器自己主動生成的依賴關係,這樣一來,你就不必再手動書寫若干檔案的依賴關係,而由編譯器自己主動生成了。須要提醒一句的是,假設你使用GNU的C/C++編譯器,你得用“-MM”引數,不然,“-M”引數會把一些標準庫的標頭檔案也包括進來。

gcc -M main.c的輸出是:

main.o: main.c defs.h /usr/include/stdio.h /usr/include/features.h /
/usr/include/sys/cdefs.h /usr/include/gnu/stubs.h /
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stddef.h /
/usr/include/bits/types.h /usr/include/bits/pthreadtypes.h /
/usr/include/bits/sched.h /usr/include/libio.h /
/usr/include/_G_config.h /usr/include/wchar.h /
/usr/include/bits/wchar.h /usr/include/gconv.h /
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stdarg.h /
/usr/include/bits/stdio_lim.h


gcc -MM main.c的輸出則是:

main.o: main.c defs.h

那麼,編譯器的這個功能怎樣與我們的Makefile聯絡在一起呢。由於這樣一來,我們的Makefile也要依據這些原始檔又一次生成,讓Makefile自已依賴於原始檔?這個功能並不現實,只是我們能夠有其他手段來迂迴地實現這一功能。GNU組織建議把編譯器為每一個原始檔的自己主動生成的依賴關係放到一個檔案裡,為每一個“name.c”的檔案都生成一個“name.d”的Makefile檔案,[.d]檔案裡就存放對應[.c]檔案的依賴關係。

於是,我們能夠寫出[.c]檔案和[.d]檔案的依賴關係,並讓make自己主動更新或自成[.d]檔案,並把其包括在我們的主Makefile中,這樣,我們就能夠自己主動化地生成每一個檔案的依賴關係了。

這裡,我們給出了一個模式規則來產生[.d]檔案:

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


這個規則的意思是,全部的[.d]檔案依賴於[.c]檔案,“rm -f [email protected]”的意思是刪除全部的目標,也就是[.d]檔案,第二行的意思是,為每一個依賴檔案“$<”,也就是[.c]檔案生成依賴檔案,“[email protected]”表示模式“%.d”檔案,假設有一個C檔案是name.c,那麼“%”就是“name”,“$$$$”意為一個隨機編號,第二行生成的檔案有可能是“name.d.12345”,第三行使用sed命令做了一個替換,關於sed命令的使用方法請參看相關的使用文件。第四行就是刪除暫時檔案。

總而言之,這個模式要做的事就是在編譯器生成的依賴關係中新增[.d]檔案的依賴,即把依賴關係:

main.o : main.c defs.h

轉成:

main.o main.d : main.c defs.h

於是,我們的[.d]檔案也會自己主動更新了,並會自己主動生成了,當然,你還能夠在這個[.d]檔案裡新增的不僅僅是依賴關係,包括生成的命令也可一併新增,讓每一個[.d]檔案都包括一個完賴的規則。一旦我們完成這個工作,接下來,我們就要把這些自己主動生成的規則放進我們的主Makefile中。我們能夠使用Makefile的“include”命令,來引入別的Makefile檔案(前面講過),比如:

sources = foo.c bar.c

include $(sources:.c=.d)

上述語句中的“$(sources:.c=.d)”中的“.c=.d”的意思是做一個替換,把變數$(sources)全部[.c]的字串都替換成[.d],關於這個“替換”的內容,在後面我會有更為具體的講述。當然,你得注意次序,由於include是按次來載入檔案,最先載入的[.d]檔案裡的目標會成為預設目標。