[轉]跟我一起寫 Makefile
2009/03/22 19:47
瀏覽11,564
迴響0
推薦0
引用0
[轉]跟我一起寫 Makefile
原文地址:http://blog.csdn.net/ugg/archive/2007/05/23/1622555.aspx(陳皓)
概述
——
什麼是makefile?或許很多Winodws的程式師都不知道這個東西,因為那些Windows的IDE都為你做了這個工作,但我覺得要作一個好的和 professional的程式師,makefile還是要懂。這就好像現在有這麼多的HTML的編輯器,但如果你想成為一個專業人士,你還是要瞭解 HTML的標識的含義。特別在Unix下的軟體編譯,你就不能不自己寫makefile了,會不會寫makefile,從一個側面說明了一個人是否具備完 成大型工程的能力。
因為,makefile關係到了整個工程的編譯規則。一個工程中的原始檔案不計數,其按類型、功能、模組分別放在若干個目錄中,makefile定義了一系 列的規則來指定,哪些檔需要先編譯,哪些檔需要後編譯,哪些檔需要重新編譯,甚至於進行更複雜的功能操作,因為makefile就像一個Shell 腳本一樣,其中也可以執行作業系統的命令。
makefile帶來的好處就是——“自動化編譯”,一旦寫好,只需要一個make命令,整個工程完全自動編譯,極大的提高了軟體發展的效率。make是 一個命令工具,是一個解釋makefile中指令的命令工具,一般來說,大多數的IDE都有這個命令,比如:Delphi的make,Visual C++的nmake,Linux下GNU的make。可見,makefile都成為了一種在工程方面的編譯方法。
現在講述如何寫makefile的文章比較少,這是我想寫這篇文章的原因。當然,不同產商的make各不相同,也有不同的語法,但其本質都是在“檔依賴 性”上做文章,這裏,我僅對GNU的make進行講述,我的環境是RedHat Linux 8.0,make的版本是3.80。必竟,這個make是應用最為廣泛的,也是用得最多的。而且其還是最遵循於IEEE 1003.2-1992 標準的(POSIX.2)。
在這篇文檔中,將以C/C++的源碼作為我們基礎,所以必然涉及一些關於C/C++的編譯的知識,相關於這方面的內容,還請各位查看相關的編譯器的文檔。這裏所默認的編譯器是UNIX下的GCC和CC。
關於程式的編譯和鏈結
——————————
在此,我想多說關於程式編譯的一些規範和方法,一般來說,無論是C、C++、還是pas,首先要把原始檔案編譯成中間代碼檔,在Windows下也就是 .obj 文件,UNIX下是 .o 檔,即 Object File,這個動作叫做編譯(compile)。然後再把大量的Object File合成執行檔,這個動作叫作鏈結(link)。
編譯時,編譯器需要的是語法的正確,函數與變數的聲明的正確。對於後者,通常是你需要告訴編譯器頭檔的所在位置(頭檔中應該只是聲明,而定義應該放在 C/C++檔中),只要所有的語法正確,編譯器就可以編譯出中間目標檔。一般來說,每個原始檔案都應該對應於一個中間目標檔(O檔或是OBJ文 件)。
鏈結時,主要是鏈結函數和總體變數,所以,我們可以使用這些中間目標檔(O檔或是OBJ檔)來鏈結我們的應用程式。鏈結器並不管函數所在的原始檔案, 只管函數的中間目標檔(Object File),在大多數時候,由於原始檔案太多,編譯生成的中間目標檔太多,而在鏈結時需要明顯地指出中間目標檔案名,這對於編譯很不方便,所以,我們要給 中間目標檔打個包,在Windows下這種包叫“庫檔”(Library File),也就是 .lib 檔,在UNIX下,是Archive File,也就是 .a 文件。
總結一下,原始檔案首先會生成中間目標檔,再由中間目標檔生成執行檔。在編譯時,編譯器只檢測程式語法,和函數、變數是否被聲明。如果函數未被聲明, 編譯器會給出一個警告,但可以生成Object File。而在鏈結程式時,鏈結器會在所有的Object File中找尋函數的實現,如果找不到,那到就會報鏈結錯誤碼(Linker Error),在VC下,這種錯誤一般是:Link 2001錯誤,意思說是說,鏈結器未能找到函數的實現。你需要指定函數的Object File.
好,言歸正傳,GNU的make有許多的內容,閑言少敘,還是讓我們開始吧。
Makefile 介紹
———————
make命令執行時,需要一個 Makefile 檔,以告訴make命令需要怎麼樣的去編譯和鏈結程式。
首先,我們用一個示例來說明Makefile的書寫規則。以便給大家一個感興認識。這個示例來源於GNU的make使用手冊,在這個示例中,我們的工程有8個C檔,和3個頭檔,我們要寫一個Makefile來告訴make命令如何編譯和鏈結這幾個檔。我們的規則是:
1)如果這個工程沒有編譯過,那麼我們的所有C檔都要編譯並被鏈結。
2)如果這個工程的某幾個C檔被修改,那麼我們只編譯被修改的C檔,並鏈結目的程式。
3)如果這個工程的頭檔被改變了,那麼我們需要編譯引用了這幾個頭檔的C檔,並鏈結目的程式。
只要我們的Makefile寫得夠好,所有的這一切,我們只用一個make命令就可以完成,make命令會自動智慧地根據當前的檔修改的情況來確定哪些檔需要重編譯,從而自己編譯所需要的檔和鏈結目的程式。
一、Makefile的規則
在講述這個Makefile之前,還是讓我們先來粗略地看一看Makefile的規則。
target ... : prerequisites ...
command
...
...
target也就是一個目標檔,可以是Object File,也可以是執行檔。還可以是一個標籤(Label),對於標籤這種特性,在後續的“偽目標”章節中會有敍述。
prerequisites就是,要生成那個target所需要的檔或是目標。
command也就是make需要執行的命令。(任意的Shell命令)
這是一個檔的依賴關係,也就是說,target這一個或多個的目標檔依賴於prerequisites中的檔,其生成規則定義在command中。 說白一點就是說,prerequisites中如果有一個以上的檔比target檔要新的話,command所定義的命令就會被執行。這就是 Makefile的規則。也就是Makefile中最核心的內容。
說到底,Makefile的東西就是這樣一點,好像我的這篇文檔也該結束了。呵呵。還不儘然,這是Makefile的主線和核心,但要寫好一個Makefile還不夠,我會以後面一點一點地結合我的工作經驗給你慢慢到來。內容還多著呢。:)
二、一個示例
正如前面所說的,如果一個工程有3個頭檔,和8個C檔,我們為了完成前面所述的那三個規則,我們的Makefile應該是下面的這個樣子的。
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
反斜杠(\)是換行符的意思。這樣比較便於Makefile的易讀。我們可以把這個內容保存在檔為“Makefile”或“makefile”的檔 中,然後在該目錄下直接輸入命令“make”就可以生成執行檔edit。如果要刪除執行檔和所有的中間目標檔,那麼,只要簡單地執行一下“make clean”就可以了。
在這個makefile中,目標檔(target)包含:執行檔edit和中間目標檔(*.o),依賴檔(prerequisites)就是冒號 後面的那些 .c 文件和 .h文件。每一個 .o 檔都有一組依賴檔,而這些 .o 檔又是執行檔 edit 的依賴檔。依賴關係的實質上就是說明了目標檔是由哪些檔生成的,換言之,目標檔是哪些檔更新的。
在定義好依賴關係後,後續的那一行定義了如何生成目標檔的作業系統命令,一定要以一個Tab鍵作為開頭。記住,make並不管命令是怎麼工作的,他只管 執行所定義的命令。make會比較targets檔和prerequisites檔的修改日期,如果prerequisites檔的日期要比 targets檔的日期要新,或者target不存在的話,那麼,make就會執行後續定義的命令。
這裏要說明一點的是,clean不是一個檔,它只不過是一個動作名字,有點像C語言中的lable一樣,其冒號後什麼也沒有,那麼,make就不會自動 去找檔的依賴性,也就不會自動執行其後所定義的命令。要執行其後的命令,就要在make命令後明顯得指出這個lable的名字。這樣的方法非常有用,我 們可以在一個makefile中定義不用的編譯或是和編譯無關的命令,比如程式的打包,程式的備份,等等。
三、make是如何工作的
在默認的方式下,也就是我們只輸入make命令。那麼,
1、make會在當前目錄下找名字叫“Makefile”或“makefile”的文件。
2、如果找到,它會找檔中的第一個目標檔(target),在上面的例子中,他會找到“edit”這個檔,並把這個檔作為最終的目標檔。
3、如果edit檔不存在,或是edit所依賴的後面的 .o 檔的檔修改時間要比edit這個檔新,那麼,他就會執行後面所定義的命令來生成edit這個檔。
4、如果edit所依賴的.o檔也存在,那麼make會在當前檔中找目標為.o檔的依賴性,如果找到則再根據那一個規則生成.o文件。(這有點像一個堆疊的過程)
5、當然,你的C檔和H檔是存在的啦,於是make會生成 .o 文件,然後再用 .o 檔生命make的終極任務,也就是執行檔edit了。
這就是整個make的依賴性,make會一層又一層地去找檔的依賴關係,直到最終編譯出第一個目標檔。在找尋的過程中,如果出現錯誤,比如最後被依賴 的檔找不到,那麼make就會直接退出,並報錯,而對於所定義的命令的錯誤,或是編譯不成功,make根本不理。make只管檔的依賴性,即,如果在 我找了依賴關係之後,冒號後面的檔還是不在,那麼對不起,我就不工作啦。
通過上述分析,我們知道,像clean這種,沒有被第一個目標檔直接或間接關聯,那麼它後面所定義的命令將不會被自動執行,不過,我們可以顯示要make執行。即命令——“make clean”,以此來清除所有的目標檔,以便重編譯。
於是在我們編程中,如果這個工程已被編譯過了,當我們修改了其中一個原始檔案,比如file.c,那麼根據我們的依賴性,我們的目標file.o會被重編譯 (也就是在這個依性關係後面所定義的命令),於是file.o的文件也是最新的啦,於是file.o的檔修改時間要比edit要新,所以edit也會被 重新鏈結了(詳見edit目標檔後定義的命令)。
而如果我們改變了“command.h”,那麼,kdb.o、command.o和files.o都會被重編譯,並且,edit會被重鏈結。
四、makefile中使用變數
在上面的例子中,先讓我們看看edit的規則:
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
我們可以看到[.o]檔的字串被重複了兩次,如果我們的工程需要加入一個新的[.o]檔,那麼我們需要在兩個地方加(應該是三個地方,還有一個地方 在clean中)。當然,我們的makefile並不複雜,所以在兩個地方加也不累,但如果makefile變得複雜,那麼我們就有可能會忘掉一個需要加 入的地方,而導致編譯失敗。所以,為了makefile的易維護,在makefile中我們可以使用變數。makefile的變數也就是一個字串,理解 成C語言中的巨集可能會更好。
比如,我們聲明一個變數,叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ,反正不管什麼啦,只要能夠表示obj檔就行了。我們在makefile一開始就這樣定義:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
於是,我們就可以很方便地在我們的makefile中以“$(objects)”的方式來使用這個變數了,於是我們的改良版makefile就變成下面這個樣子:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit $(objects)
於是如果有新的 .o 檔加入,我們只需簡單地修改一下 objects 變數就可以了。
關於變數更多的話題,我會在後續給你一一道來。
五、讓make自動推導
GNU的make很強大,它可以自動推導檔以及檔依賴關係後面的命令,於是我們就沒必要去在每一個[.o]檔後都寫上類似的命令,因為,我們的make會自動識別,並自己推導命令。
只要make看到一個[.o]檔,它就會自動的把[.c]檔加在依賴關係中,如果make找到一個whatever.o,那麼whatever.c, 就會是whatever.o的依賴檔。並且 cc -c whatever.c 也會被推導出來,於是,我們的makefile再也不用寫得這麼複雜。我們的是新的makefile又出爐了。
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
display.o : defs.h buffer.h
insert.o : defs.h buffer.h
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h
.PHONY : clean
clean :
rm edit $(objects)
這種方法,也就是make的“隱晦規則”。上面檔內容中,“.PHONY”表示,clean是個偽目標檔。
關於更為詳細的“隱晦規則”和“偽目標檔”,我會在後續給你一一道來。
六、另類風格的makefile
即然我們的make可以自動推導命令,那麼我看到那堆[.o]和[.h]的依賴就有點不爽,那麼多的重複的[.h],能不能把其收攏起來,好吧,沒有問題,這個對於make來說很容易,誰叫它提供了自動推導命令和檔的功能呢?來看看最新風格的makefile吧。
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h
.PHONY : clean
clean :
rm edit $(objects)
這種風格,讓我們的makefile變得很簡單,但我們的檔依賴關係就顯得有點淩亂了。魚和熊掌不可兼得。還看你的喜好了。我是不喜歡這種風格的,一是檔的依賴關係看不清楚,二是如果檔一多,要加入幾個新的.o檔,那就理不清楚了。
七、清空目標檔的規則
每個Makefile中都應該寫一個清空目標檔(.o和執行檔)的規則,這不僅便於重編譯,也很利於保持檔的清潔。這是一個“修養”(呵呵,還記得我的《編程修養》嗎)。一般的風格都是:
clean:
rm edit $(objects)
更為穩健的做法是:
.PHONY : clean
clean :
-rm edit $(objects)
前面說過,.PHONY意思表示clean是一個“偽目標”,。而在rm命令前面加了一個小減號的意思就是,也許某些檔出現問題,但不要管,繼續做後面 的事。當然,clean的規則不要放在檔的開頭,不然,這就會變成make的默認目標,相信誰也不願意這樣。不成文的規矩是——“clean從來都是放 在檔的最後”。
上面就是一個makefile的概貌,也是makefile的基礎,下面還有很多makefile的相關細節,準備好了嗎?準備好了就來。
一、Makefile裏有什麼?
Makefile裏主要包含了五個東西:顯式規則、隱晦規則、變數定義、檔指示和注釋。
1、顯式規則。顯式規則說明了,如何生成一個或多的的目標檔。這是由Makefile的書寫者明顯指出,要生成的檔,檔的依賴檔,生成的命令。
2、隱晦規則。由於我們的make有自動推導的功能,所以隱晦的規則可以讓我們比較粗糙地簡略地書寫Makefile,這是由make所支持的。
3、變數的定義。在Makefile中我們要定義一系列的變數,變數一般都是字串,這個有點你C語言中的巨集,當Makefile被執行時,其中的變數都會被擴展到相應的引用位置上。
4、檔指示。其包括了三個部分,一個是在一個Makefile中引用另一個Makefile,就像C語言中的include一樣;另一個是指根據某些情 況指定Makefile中的有效部分,就像C語言中的預編譯#if一樣;還有就是定義一個多行的命令。有關這一部分的內容,我會在後續的部分中講述。
5、注釋。Makefile中只有行注釋,和UNIX的Shell腳本一樣,其注釋是用“#”字元,這個就像C/C++中的“//”一樣。如果你要在你的Makefile中使用“#”字元,可以用反斜框進行轉義,如:“\#”。
最後,還值得一提的是,在Makefile中的命令,必須要以[Tab]鍵開始。
二、Makefile的檔案名
默認的情況下,make命令會在當前目錄下按順序找尋檔案名為“GNUmakefile”、“makefile”、“Makefile”的檔,找到瞭解 釋這個檔。在這三個檔案名中,最好使用“Makefile”這個檔案名,因為,這個檔案名第一個字元為大寫,這樣有一種顯目的感覺。最好不要用 “GNUmakefile”,這個檔是GNU的make識別的。有另外一些make只對全小寫的“makefile”檔案名敏感,但是基本上來說,大多 數的make都支持“makefile”和“Makefile”這兩種默認檔案名。
當然,你可以使用別的檔案名來書寫Makefile,比如:“Make.Linux”,“Make.Solaris”,“Make.AIX”等,如果要指 定特定的Makefile,你可以使用make的“-f”和“--file”參數,如:make -f Make.Linux或make --file Make.AIX。
三、引用其他的Makefile
在Makefile使用include關鍵字可以把別的Makefile包含進來,這很像C語言的#include,被包含的檔會原模原樣的放在當前檔的包含位置。include的語法是:
include ;
filename可以是當前作業系統Shell的檔模式(可以保含路徑和通配符)
在include前面可以有一些空字元,但是絕不能是[Tab]鍵開始。include和 ;可以用一個或多個空格隔開。 舉個例子,你有這樣幾個Makefile:a.mk、b.mk、c.mk,還有一個檔叫foo.make,以及一個變數$(bar),其包含了e.mk 和f.mk,那麼,下面的語句:
include foo.make *.mk $(bar)
等價於:
include foo.make a.mk b.mk c.mk e.mk f.mk
make命令開始時,會把找尋include所指出的其他Makefile,並把其內容安置在當前的位置。就好像C/C++的#include指令一樣。 如果檔都沒有指定絕對路徑或是相對路徑的話,make會在當前目錄下首先尋找,如果當前目錄下沒有找到,那麼,make還會在下面的幾個目錄下找:
1、如果make執行時,有“-I”或“--include-dir”參數,那麼make就會在這個參數所指定的目錄下去尋找。
2、如果目錄 ;/include(一般是:/usr/local/bin或/usr/include)存在的話,make也會去找。
如果有檔沒有找到的話,make會生成一條警告資訊,但不會馬上出現致命錯誤。它會繼續載入其他的文件,一旦完成makefile的讀取,make會再 重試這些沒有找到,或是不能讀取的檔,如果還是不行,make才會出現一條致命資訊。如果你想讓make不理那些無法讀取的檔,而繼續執行,你可以在 include前加一個減號“-”。如:
-include ;
其表示,無論include過程中出現什麼錯誤,都不要報錯繼續執行。和其他版本make相容的相關命令是sinclude,其作用和這一個是一樣的。
四、環境變數 MAKEFILES
如果你的當前環境中定義了環境變數MAKEFILES,那麼,make會把這個變數中的值做一個類似於include的動作。這個變數中的值是其他的 Makefile,用空格分隔。只是,它和include不同的是,從這個環境變中引入的Makefile的“目標”不會起作用,如果環境變數中定義的文 件發現錯誤,make也會不理。
但是在這裏我還是建議不要使用這個環境變數,因為只要這個變數一被定義,那麼當你使用make時,所有的Makefile都會受到它的影響,這絕不是你想 看到的。在這裏提這個事,只是為了告訴大家,也許有時候你的Makefile出現了怪事,那麼你可以看看當前環境中有沒有定義這個變數。
五、make的工作方式
GNU的make工作時的執行步驟入下:(想來其他的make也是類似)
1、讀入所有的Makefile。
2、讀入被include的其他Makefile。
3、初始化檔中的變數。
4、推導隱晦規則,並分析所有規則。
5、為所有的目標檔創建依賴關係鏈。
6、根據依賴關係,決定哪些目標要重新生成。
7、執行生成命令。
1-5步為第一個階段,6-7為第二個階段。第一個階段中,如果定義的變數被使用了,那麼,make會把其展開在使用的位置。但make並不會完全馬上展 開,make使用的是拖延戰術,如果變數出現在依賴關係的規則中,那麼僅當這條依賴被決定要使用了,變數才會在其內部展開。
當然,這個工作方式你不一定要清楚,但是知道這個方式你也會對make更為熟悉。有了這個基礎,後續部分也就容易看懂了。
書寫規則
————
規則包含兩個部分,一個是依賴關係,一個是生成目標的方法。
在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是命令行,如果其不與“target:prerequisites”在一行,那麼,必須以[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)
這種用法由關鍵字“wildcard”指出,關於Makefile的關鍵字,我們將在後面討論。
四、文件搜尋
在一些大的工程中,有大量的原始檔案,我們通常的做法是把這許多的原始檔案分類,並存放在不同的目錄中。所以,當make需要去找尋檔的依賴關係時,你可以在檔前加上路徑,但最好的方法是把一個路徑告訴make,讓make在自動去找。
Makefile檔中的特殊變數“VPATH”就是完成這個功能的,如果沒有指明這個變數,make只會在當前的目錄中去找尋依賴檔和目標檔。如果定義了這個變數,那麼,make就會在當當前目錄找不到的情況下,到所指定的目錄中去找尋檔了。
VPATH = src:../headers
上面的的定義指定兩個目錄,“src”和“../headers”,make會按照這個順序進行搜索。目錄由“冒號”分隔。(當然,當前目錄永遠是最高優先搜索的地方)
另一個設置檔搜索路徑的方法是使用make的“vpath”關鍵字(注意,它是全小寫的),這不是變數,這是一個make的關鍵字,這和上面提到的那個 VPATH變數很類似,但是它更為靈活。它可以指定不同的檔在不同的搜索目錄中。這是一個很靈活的功能。它的使用方法有三種:
1、vpath ; ;
為符合模式 ;的檔指定搜索目錄 ;。
2、vpath ;
清除符合模式 ;的檔的搜索目錄。
3、vpath
清除所有已被設置好了的檔搜索目錄。
vapth使用方法中的 ;需要包含“%”字元。“%”的意思是匹配零或若干字元,例如,“%.h”表示所有以“.h”結尾 的文件。 ;指定了要搜索的檔集,而 ;則指定了 ; 的檔集的搜索的目錄。例如:
vpath %.h ../headers
該語句表示,要求make在“../headers”目錄下搜索所有以“.h”結尾的文件。(如果某檔在當前目錄沒有找到的話)
我們可以連續地使用vpath語句,以指定不同搜索策略。如果連續的vpath語句中出現了相同的 ;,或是被重複了的 ;,那麼,make會按照vpath語句的先後順序來執行搜索。如:
vpath %.c foo
vpath % blish
vpath %.c bar
其表示“.c”結尾的檔,先在“foo”目錄,然後是“blish”,最後是“bar”目錄。
vpath %.c foo:bar
vpath % blish
而上面的語句則表示“.c”結尾的檔,先在“foo”目錄,然後是“bar”目錄,最後才是“blish”目錄。
五、偽目標
最早先的一個例子中,我們提到過一個“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的規則中的目標可以不止一個,其支援多目標,有可能我們的多個目標同時依賴於一個檔,並且其生成的命令大體類似。於是我們就能把其合併 起來。當然,多個目標的生成規則的執行命令是同一個,這可能會可我們帶來麻煩,不過好在我們的可以使用一個自動化變數“$@”(關於自動化變數,將在後面 講述),這個變數表示著目前規則中所有的目標的集合,這樣說可能很抽象,還是看一個例子吧。
bigoutput littleoutput : text.g
generate text.g -$(subst output,,$@) >; $@
上述規則等價於:
bigoutput : text.g
generate text.g -big >; bigoutput
littleoutput : text.g
generate text.g -little >; littleoutput
其中,-$(subst output,,$@)中的“$”表示執行一個Makefile的函數,函數名為subst,後面的為參數。關於函數,將在後面講述。這裏的這個函數是截 取字串的意思,“$@”表示目標的集合,就像一個陣列,“$@”依次取出目標,並執於命令。
七、靜態模式
靜態模式可以更加容易地定義多目標的規則,可以讓我們的規則變得更加的有彈性和靈活。我們還是先來看一下語法:
;: ;: ;
;
...
targets定義了一系列的目標檔,可以有通配符。是目標的一個集合。
target-parrtern是指明了targets的模式,也就是的目標集模式。
prereq-parrterns是目標的依賴模式,它對target-parrtern形成的模式再進行一次依賴目標的定義。
這樣描述這三個東西,可能還是沒有說清楚,還是舉個例子來說明一下吧。如果我們的 ;定義成“%.o”,意 思是我們的 ;集合中都是以“.o”結尾的,而如果我們的 ;定義成“%. c”,意思是對 ;所形成的目標集進行二次定義,其計算方法是,取 ;模式中的“%”(也就是去掉了[.o]這個結尾),並為其加上[.c]這個結尾,形成的新集合。
所以,我們的“目標模式”或是“依賴模式”中都應該有“%”這個字元,如果你的檔案名中有“%”那麼你可以使用反斜杠“\”進行轉義,來標明真實的“%”字元。
看一個例子:
objects = foo.o bar.o
all: $(objects)
$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
上面的例子中,指明了我們的目標從$object中獲取,“%.o”表明要所有以“.o”結尾的目標,也就是“foo.o bar.o”,也就是變數$object集合的模式,而依賴模式“%.c”則取模式“%.o”的“%”,也就是“foo bar”,並為其加下“.c”的尾碼,於是,我們的依賴目標就是“foo.c bar.c”。而命令中的“$<”和“$@”則是自動化變數,“$<”表示所有的依賴目標集(也就是“foo.c bar.c”),“$@”表示目標集(也就是“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”有幾百個,那種我們只要用這種很簡單的“靜態模式規則”就可以寫完一堆規則,實在是太有效率了。“靜態模式規則”的用法很靈活,如果用得好,那會一個很強大的功能。再看一個例子:
files = foo.elc bar.o lose.o
$(filter %.o,$(files)): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
$(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,這是一個很 沒有維護性的工作。為了避免這種繁重而又容易出錯的事情,我們可以使用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]檔的依
原文地址:http://blog.csdn.net/ugg/archive/2007/05/23/1622555.aspx(陳皓)
概述
——
什麼是makefile?或許很多Winodws的程式師都不知道這個東西,因為那些Windows的IDE都為你做了這個工作,但我覺得要作一個好的和 professional的程式師,makefile還是要懂。這就好像現在有這麼多的HTML的編輯器,但如果你想成為一個專業人士,你還是要瞭解 HTML的標識的含義。特別在Unix下的軟體編譯,你就不能不自己寫makefile了,會不會寫makefile,從一個側面說明了一個人是否具備完 成大型工程的能力。
因為,makefile關係到了整個工程的編譯規則。一個工程中的原始檔案不計數,其按類型、功能、模組分別放在若干個目錄中,makefile定義了一系 列的規則來指定,哪些檔需要先編譯,哪些檔需要後編譯,哪些檔需要重新編譯,甚至於進行更複雜的功能操作,因為makefile就像一個Shell 腳本一樣,其中也可以執行作業系統的命令。
makefile帶來的好處就是——“自動化編譯”,一旦寫好,只需要一個make命令,整個工程完全自動編譯,極大的提高了軟體發展的效率。make是 一個命令工具,是一個解釋makefile中指令的命令工具,一般來說,大多數的IDE都有這個命令,比如:Delphi的make,Visual C++的nmake,Linux下GNU的make。可見,makefile都成為了一種在工程方面的編譯方法。
現在講述如何寫makefile的文章比較少,這是我想寫這篇文章的原因。當然,不同產商的make各不相同,也有不同的語法,但其本質都是在“檔依賴 性”上做文章,這裏,我僅對GNU的make進行講述,我的環境是RedHat Linux 8.0,make的版本是3.80。必竟,這個make是應用最為廣泛的,也是用得最多的。而且其還是最遵循於IEEE 1003.2-1992 標準的(POSIX.2)。
在這篇文檔中,將以C/C++的源碼作為我們基礎,所以必然涉及一些關於C/C++的編譯的知識,相關於這方面的內容,還請各位查看相關的編譯器的文檔。這裏所默認的編譯器是UNIX下的GCC和CC。
關於程式的編譯和鏈結
——————————
在此,我想多說關於程式編譯的一些規範和方法,一般來說,無論是C、C++、還是pas,首先要把原始檔案編譯成中間代碼檔,在Windows下也就是 .obj 文件,UNIX下是 .o 檔,即 Object File,這個動作叫做編譯(compile)。然後再把大量的Object File合成執行檔,這個動作叫作鏈結(link)。
編譯時,編譯器需要的是語法的正確,函數與變數的聲明的正確。對於後者,通常是你需要告訴編譯器頭檔的所在位置(頭檔中應該只是聲明,而定義應該放在 C/C++檔中),只要所有的語法正確,編譯器就可以編譯出中間目標檔。一般來說,每個原始檔案都應該對應於一個中間目標檔(O檔或是OBJ文 件)。
鏈結時,主要是鏈結函數和總體變數,所以,我們可以使用這些中間目標檔(O檔或是OBJ檔)來鏈結我們的應用程式。鏈結器並不管函數所在的原始檔案, 只管函數的中間目標檔(Object File),在大多數時候,由於原始檔案太多,編譯生成的中間目標檔太多,而在鏈結時需要明顯地指出中間目標檔案名,這對於編譯很不方便,所以,我們要給 中間目標檔打個包,在Windows下這種包叫“庫檔”(Library File),也就是 .lib 檔,在UNIX下,是Archive File,也就是 .a 文件。
總結一下,原始檔案首先會生成中間目標檔,再由中間目標檔生成執行檔。在編譯時,編譯器只檢測程式語法,和函數、變數是否被聲明。如果函數未被聲明, 編譯器會給出一個警告,但可以生成Object File。而在鏈結程式時,鏈結器會在所有的Object File中找尋函數的實現,如果找不到,那到就會報鏈結錯誤碼(Linker Error),在VC下,這種錯誤一般是:Link 2001錯誤,意思說是說,鏈結器未能找到函數的實現。你需要指定函數的Object File.
好,言歸正傳,GNU的make有許多的內容,閑言少敘,還是讓我們開始吧。
Makefile 介紹
———————
make命令執行時,需要一個 Makefile 檔,以告訴make命令需要怎麼樣的去編譯和鏈結程式。
首先,我們用一個示例來說明Makefile的書寫規則。以便給大家一個感興認識。這個示例來源於GNU的make使用手冊,在這個示例中,我們的工程有8個C檔,和3個頭檔,我們要寫一個Makefile來告訴make命令如何編譯和鏈結這幾個檔。我們的規則是:
1)如果這個工程沒有編譯過,那麼我們的所有C檔都要編譯並被鏈結。
2)如果這個工程的某幾個C檔被修改,那麼我們只編譯被修改的C檔,並鏈結目的程式。
3)如果這個工程的頭檔被改變了,那麼我們需要編譯引用了這幾個頭檔的C檔,並鏈結目的程式。
只要我們的Makefile寫得夠好,所有的這一切,我們只用一個make命令就可以完成,make命令會自動智慧地根據當前的檔修改的情況來確定哪些檔需要重編譯,從而自己編譯所需要的檔和鏈結目的程式。
一、Makefile的規則
在講述這個Makefile之前,還是讓我們先來粗略地看一看Makefile的規則。
target ... : prerequisites ...
command
...
...
target也就是一個目標檔,可以是Object File,也可以是執行檔。還可以是一個標籤(Label),對於標籤這種特性,在後續的“偽目標”章節中會有敍述。
prerequisites就是,要生成那個target所需要的檔或是目標。
command也就是make需要執行的命令。(任意的Shell命令)
這是一個檔的依賴關係,也就是說,target這一個或多個的目標檔依賴於prerequisites中的檔,其生成規則定義在command中。 說白一點就是說,prerequisites中如果有一個以上的檔比target檔要新的話,command所定義的命令就會被執行。這就是 Makefile的規則。也就是Makefile中最核心的內容。
說到底,Makefile的東西就是這樣一點,好像我的這篇文檔也該結束了。呵呵。還不儘然,這是Makefile的主線和核心,但要寫好一個Makefile還不夠,我會以後面一點一點地結合我的工作經驗給你慢慢到來。內容還多著呢。:)
二、一個示例
正如前面所說的,如果一個工程有3個頭檔,和8個C檔,我們為了完成前面所述的那三個規則,我們的Makefile應該是下面的這個樣子的。
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
反斜杠(\)是換行符的意思。這樣比較便於Makefile的易讀。我們可以把這個內容保存在檔為“Makefile”或“makefile”的檔 中,然後在該目錄下直接輸入命令“make”就可以生成執行檔edit。如果要刪除執行檔和所有的中間目標檔,那麼,只要簡單地執行一下“make clean”就可以了。
在這個makefile中,目標檔(target)包含:執行檔edit和中間目標檔(*.o),依賴檔(prerequisites)就是冒號 後面的那些 .c 文件和 .h文件。每一個 .o 檔都有一組依賴檔,而這些 .o 檔又是執行檔 edit 的依賴檔。依賴關係的實質上就是說明了目標檔是由哪些檔生成的,換言之,目標檔是哪些檔更新的。
在定義好依賴關係後,後續的那一行定義了如何生成目標檔的作業系統命令,一定要以一個Tab鍵作為開頭。記住,make並不管命令是怎麼工作的,他只管 執行所定義的命令。make會比較targets檔和prerequisites檔的修改日期,如果prerequisites檔的日期要比 targets檔的日期要新,或者target不存在的話,那麼,make就會執行後續定義的命令。
這裏要說明一點的是,clean不是一個檔,它只不過是一個動作名字,有點像C語言中的lable一樣,其冒號後什麼也沒有,那麼,make就不會自動 去找檔的依賴性,也就不會自動執行其後所定義的命令。要執行其後的命令,就要在make命令後明顯得指出這個lable的名字。這樣的方法非常有用,我 們可以在一個makefile中定義不用的編譯或是和編譯無關的命令,比如程式的打包,程式的備份,等等。
三、make是如何工作的
在默認的方式下,也就是我們只輸入make命令。那麼,
1、make會在當前目錄下找名字叫“Makefile”或“makefile”的文件。
2、如果找到,它會找檔中的第一個目標檔(target),在上面的例子中,他會找到“edit”這個檔,並把這個檔作為最終的目標檔。
3、如果edit檔不存在,或是edit所依賴的後面的 .o 檔的檔修改時間要比edit這個檔新,那麼,他就會執行後面所定義的命令來生成edit這個檔。
4、如果edit所依賴的.o檔也存在,那麼make會在當前檔中找目標為.o檔的依賴性,如果找到則再根據那一個規則生成.o文件。(這有點像一個堆疊的過程)
5、當然,你的C檔和H檔是存在的啦,於是make會生成 .o 文件,然後再用 .o 檔生命make的終極任務,也就是執行檔edit了。
這就是整個make的依賴性,make會一層又一層地去找檔的依賴關係,直到最終編譯出第一個目標檔。在找尋的過程中,如果出現錯誤,比如最後被依賴 的檔找不到,那麼make就會直接退出,並報錯,而對於所定義的命令的錯誤,或是編譯不成功,make根本不理。make只管檔的依賴性,即,如果在 我找了依賴關係之後,冒號後面的檔還是不在,那麼對不起,我就不工作啦。
通過上述分析,我們知道,像clean這種,沒有被第一個目標檔直接或間接關聯,那麼它後面所定義的命令將不會被自動執行,不過,我們可以顯示要make執行。即命令——“make clean”,以此來清除所有的目標檔,以便重編譯。
於是在我們編程中,如果這個工程已被編譯過了,當我們修改了其中一個原始檔案,比如file.c,那麼根據我們的依賴性,我們的目標file.o會被重編譯 (也就是在這個依性關係後面所定義的命令),於是file.o的文件也是最新的啦,於是file.o的檔修改時間要比edit要新,所以edit也會被 重新鏈結了(詳見edit目標檔後定義的命令)。
而如果我們改變了“command.h”,那麼,kdb.o、command.o和files.o都會被重編譯,並且,edit會被重鏈結。
四、makefile中使用變數
在上面的例子中,先讓我們看看edit的規則:
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
我們可以看到[.o]檔的字串被重複了兩次,如果我們的工程需要加入一個新的[.o]檔,那麼我們需要在兩個地方加(應該是三個地方,還有一個地方 在clean中)。當然,我們的makefile並不複雜,所以在兩個地方加也不累,但如果makefile變得複雜,那麼我們就有可能會忘掉一個需要加 入的地方,而導致編譯失敗。所以,為了makefile的易維護,在makefile中我們可以使用變數。makefile的變數也就是一個字串,理解 成C語言中的巨集可能會更好。
比如,我們聲明一個變數,叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ,反正不管什麼啦,只要能夠表示obj檔就行了。我們在makefile一開始就這樣定義:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
於是,我們就可以很方便地在我們的makefile中以“$(objects)”的方式來使用這個變數了,於是我們的改良版makefile就變成下面這個樣子:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit $(objects)
於是如果有新的 .o 檔加入,我們只需簡單地修改一下 objects 變數就可以了。
關於變數更多的話題,我會在後續給你一一道來。
五、讓make自動推導
GNU的make很強大,它可以自動推導檔以及檔依賴關係後面的命令,於是我們就沒必要去在每一個[.o]檔後都寫上類似的命令,因為,我們的make會自動識別,並自己推導命令。
只要make看到一個[.o]檔,它就會自動的把[.c]檔加在依賴關係中,如果make找到一個whatever.o,那麼whatever.c, 就會是whatever.o的依賴檔。並且 cc -c whatever.c 也會被推導出來,於是,我們的makefile再也不用寫得這麼複雜。我們的是新的makefile又出爐了。
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
display.o : defs.h buffer.h
insert.o : defs.h buffer.h
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h
.PHONY : clean
clean :
rm edit $(objects)
這種方法,也就是make的“隱晦規則”。上面檔內容中,“.PHONY”表示,clean是個偽目標檔。
關於更為詳細的“隱晦規則”和“偽目標檔”,我會在後續給你一一道來。
六、另類風格的makefile
即然我們的make可以自動推導命令,那麼我看到那堆[.o]和[.h]的依賴就有點不爽,那麼多的重複的[.h],能不能把其收攏起來,好吧,沒有問題,這個對於make來說很容易,誰叫它提供了自動推導命令和檔的功能呢?來看看最新風格的makefile吧。
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h
.PHONY : clean
clean :
rm edit $(objects)
這種風格,讓我們的makefile變得很簡單,但我們的檔依賴關係就顯得有點淩亂了。魚和熊掌不可兼得。還看你的喜好了。我是不喜歡這種風格的,一是檔的依賴關係看不清楚,二是如果檔一多,要加入幾個新的.o檔,那就理不清楚了。
七、清空目標檔的規則
每個Makefile中都應該寫一個清空目標檔(.o和執行檔)的規則,這不僅便於重編譯,也很利於保持檔的清潔。這是一個“修養”(呵呵,還記得我的《編程修養》嗎)。一般的風格都是:
clean:
rm edit $(objects)
更為穩健的做法是:
.PHONY : clean
clean :
-rm edit $(objects)
前面說過,.PHONY意思表示clean是一個“偽目標”,。而在rm命令前面加了一個小減號的意思就是,也許某些檔出現問題,但不要管,繼續做後面 的事。當然,clean的規則不要放在檔的開頭,不然,這就會變成make的默認目標,相信誰也不願意這樣。不成文的規矩是——“clean從來都是放 在檔的最後”。
上面就是一個makefile的概貌,也是makefile的基礎,下面還有很多makefile的相關細節,準備好了嗎?準備好了就來。
一、Makefile裏有什麼?
Makefile裏主要包含了五個東西:顯式規則、隱晦規則、變數定義、檔指示和注釋。
1、顯式規則。顯式規則說明了,如何生成一個或多的的目標檔。這是由Makefile的書寫者明顯指出,要生成的檔,檔的依賴檔,生成的命令。
2、隱晦規則。由於我們的make有自動推導的功能,所以隱晦的規則可以讓我們比較粗糙地簡略地書寫Makefile,這是由make所支持的。
3、變數的定義。在Makefile中我們要定義一系列的變數,變數一般都是字串,這個有點你C語言中的巨集,當Makefile被執行時,其中的變數都會被擴展到相應的引用位置上。
4、檔指示。其包括了三個部分,一個是在一個Makefile中引用另一個Makefile,就像C語言中的include一樣;另一個是指根據某些情 況指定Makefile中的有效部分,就像C語言中的預編譯#if一樣;還有就是定義一個多行的命令。有關這一部分的內容,我會在後續的部分中講述。
5、注釋。Makefile中只有行注釋,和UNIX的Shell腳本一樣,其注釋是用“#”字元,這個就像C/C++中的“//”一樣。如果你要在你的Makefile中使用“#”字元,可以用反斜框進行轉義,如:“\#”。
最後,還值得一提的是,在Makefile中的命令,必須要以[Tab]鍵開始。
二、Makefile的檔案名
默認的情況下,make命令會在當前目錄下按順序找尋檔案名為“GNUmakefile”、“makefile”、“Makefile”的檔,找到瞭解 釋這個檔。在這三個檔案名中,最好使用“Makefile”這個檔案名,因為,這個檔案名第一個字元為大寫,這樣有一種顯目的感覺。最好不要用 “GNUmakefile”,這個檔是GNU的make識別的。有另外一些make只對全小寫的“makefile”檔案名敏感,但是基本上來說,大多 數的make都支持“makefile”和“Makefile”這兩種默認檔案名。
當然,你可以使用別的檔案名來書寫Makefile,比如:“Make.Linux”,“Make.Solaris”,“Make.AIX”等,如果要指 定特定的Makefile,你可以使用make的“-f”和“--file”參數,如:make -f Make.Linux或make --file Make.AIX。
三、引用其他的Makefile
在Makefile使用include關鍵字可以把別的Makefile包含進來,這很像C語言的#include,被包含的檔會原模原樣的放在當前檔的包含位置。include的語法是:
include ;
filename可以是當前作業系統Shell的檔模式(可以保含路徑和通配符)
在include前面可以有一些空字元,但是絕不能是[Tab]鍵開始。include和 ;可以用一個或多個空格隔開。 舉個例子,你有這樣幾個Makefile:a.mk、b.mk、c.mk,還有一個檔叫foo.make,以及一個變數$(bar),其包含了e.mk 和f.mk,那麼,下面的語句:
include foo.make *.mk $(bar)
等價於:
include foo.make a.mk b.mk c.mk e.mk f.mk
make命令開始時,會把找尋include所指出的其他Makefile,並把其內容安置在當前的位置。就好像C/C++的#include指令一樣。 如果檔都沒有指定絕對路徑或是相對路徑的話,make會在當前目錄下首先尋找,如果當前目錄下沒有找到,那麼,make還會在下面的幾個目錄下找:
1、如果make執行時,有“-I”或“--include-dir”參數,那麼make就會在這個參數所指定的目錄下去尋找。
2、如果目錄 ;/include(一般是:/usr/local/bin或/usr/include)存在的話,make也會去找。
如果有檔沒有找到的話,make會生成一條警告資訊,但不會馬上出現致命錯誤。它會繼續載入其他的文件,一旦完成makefile的讀取,make會再 重試這些沒有找到,或是不能讀取的檔,如果還是不行,make才會出現一條致命資訊。如果你想讓make不理那些無法讀取的檔,而繼續執行,你可以在 include前加一個減號“-”。如:
-include ;
其表示,無論include過程中出現什麼錯誤,都不要報錯繼續執行。和其他版本make相容的相關命令是sinclude,其作用和這一個是一樣的。
四、環境變數 MAKEFILES
如果你的當前環境中定義了環境變數MAKEFILES,那麼,make會把這個變數中的值做一個類似於include的動作。這個變數中的值是其他的 Makefile,用空格分隔。只是,它和include不同的是,從這個環境變中引入的Makefile的“目標”不會起作用,如果環境變數中定義的文 件發現錯誤,make也會不理。
但是在這裏我還是建議不要使用這個環境變數,因為只要這個變數一被定義,那麼當你使用make時,所有的Makefile都會受到它的影響,這絕不是你想 看到的。在這裏提這個事,只是為了告訴大家,也許有時候你的Makefile出現了怪事,那麼你可以看看當前環境中有沒有定義這個變數。
五、make的工作方式
GNU的make工作時的執行步驟入下:(想來其他的make也是類似)
1、讀入所有的Makefile。
2、讀入被include的其他Makefile。
3、初始化檔中的變數。
4、推導隱晦規則,並分析所有規則。
5、為所有的目標檔創建依賴關係鏈。
6、根據依賴關係,決定哪些目標要重新生成。
7、執行生成命令。
1-5步為第一個階段,6-7為第二個階段。第一個階段中,如果定義的變數被使用了,那麼,make會把其展開在使用的位置。但make並不會完全馬上展 開,make使用的是拖延戰術,如果變數出現在依賴關係的規則中,那麼僅當這條依賴被決定要使用了,變數才會在其內部展開。
當然,這個工作方式你不一定要清楚,但是知道這個方式你也會對make更為熟悉。有了這個基礎,後續部分也就容易看懂了。
書寫規則
————
規則包含兩個部分,一個是依賴關係,一個是生成目標的方法。
在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是命令行,如果其不與“target:prerequisites”在一行,那麼,必須以[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)
這種用法由關鍵字“wildcard”指出,關於Makefile的關鍵字,我們將在後面討論。
四、文件搜尋
在一些大的工程中,有大量的原始檔案,我們通常的做法是把這許多的原始檔案分類,並存放在不同的目錄中。所以,當make需要去找尋檔的依賴關係時,你可以在檔前加上路徑,但最好的方法是把一個路徑告訴make,讓make在自動去找。
Makefile檔中的特殊變數“VPATH”就是完成這個功能的,如果沒有指明這個變數,make只會在當前的目錄中去找尋依賴檔和目標檔。如果定義了這個變數,那麼,make就會在當當前目錄找不到的情況下,到所指定的目錄中去找尋檔了。
VPATH = src:../headers
上面的的定義指定兩個目錄,“src”和“../headers”,make會按照這個順序進行搜索。目錄由“冒號”分隔。(當然,當前目錄永遠是最高優先搜索的地方)
另一個設置檔搜索路徑的方法是使用make的“vpath”關鍵字(注意,它是全小寫的),這不是變數,這是一個make的關鍵字,這和上面提到的那個 VPATH變數很類似,但是它更為靈活。它可以指定不同的檔在不同的搜索目錄中。這是一個很靈活的功能。它的使用方法有三種:
1、vpath ; ;
為符合模式 ;的檔指定搜索目錄 ;。
2、vpath ;
清除符合模式 ;的檔的搜索目錄。
3、vpath
清除所有已被設置好了的檔搜索目錄。
vapth使用方法中的 ;需要包含“%”字元。“%”的意思是匹配零或若干字元,例如,“%.h”表示所有以“.h”結尾 的文件。 ;指定了要搜索的檔集,而 ;則指定了 ; 的檔集的搜索的目錄。例如:
vpath %.h ../headers
該語句表示,要求make在“../headers”目錄下搜索所有以“.h”結尾的文件。(如果某檔在當前目錄沒有找到的話)
我們可以連續地使用vpath語句,以指定不同搜索策略。如果連續的vpath語句中出現了相同的 ;,或是被重複了的 ;,那麼,make會按照vpath語句的先後順序來執行搜索。如:
vpath %.c foo
vpath % blish
vpath %.c bar
其表示“.c”結尾的檔,先在“foo”目錄,然後是“blish”,最後是“bar”目錄。
vpath %.c foo:bar
vpath % blish
而上面的語句則表示“.c”結尾的檔,先在“foo”目錄,然後是“bar”目錄,最後才是“blish”目錄。
五、偽目標
最早先的一個例子中,我們提到過一個“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的規則中的目標可以不止一個,其支援多目標,有可能我們的多個目標同時依賴於一個檔,並且其生成的命令大體類似。於是我們就能把其合併 起來。當然,多個目標的生成規則的執行命令是同一個,這可能會可我們帶來麻煩,不過好在我們的可以使用一個自動化變數“$@”(關於自動化變數,將在後面 講述),這個變數表示著目前規則中所有的目標的集合,這樣說可能很抽象,還是看一個例子吧。
bigoutput littleoutput : text.g
generate text.g -$(subst output,,$@) >; $@
上述規則等價於:
bigoutput : text.g
generate text.g -big >; bigoutput
littleoutput : text.g
generate text.g -little >; littleoutput
其中,-$(subst output,,$@)中的“$”表示執行一個Makefile的函數,函數名為subst,後面的為參數。關於函數,將在後面講述。這裏的這個函數是截 取字串的意思,“$@”表示目標的集合,就像一個陣列,“$@”依次取出目標,並執於命令。
七、靜態模式
靜態模式可以更加容易地定義多目標的規則,可以讓我們的規則變得更加的有彈性和靈活。我們還是先來看一下語法:
;: ;: ;
;
...
targets定義了一系列的目標檔,可以有通配符。是目標的一個集合。
target-parrtern是指明了targets的模式,也就是的目標集模式。
prereq-parrterns是目標的依賴模式,它對target-parrtern形成的模式再進行一次依賴目標的定義。
這樣描述這三個東西,可能還是沒有說清楚,還是舉個例子來說明一下吧。如果我們的 ;定義成“%.o”,意 思是我們的 ;集合中都是以“.o”結尾的,而如果我們的 ;定義成“%. c”,意思是對 ;所形成的目標集進行二次定義,其計算方法是,取 ;模式中的“%”(也就是去掉了[.o]這個結尾),並為其加上[.c]這個結尾,形成的新集合。
所以,我們的“目標模式”或是“依賴模式”中都應該有“%”這個字元,如果你的檔案名中有“%”那麼你可以使用反斜杠“\”進行轉義,來標明真實的“%”字元。
看一個例子:
objects = foo.o bar.o
all: $(objects)
$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
上面的例子中,指明了我們的目標從$object中獲取,“%.o”表明要所有以“.o”結尾的目標,也就是“foo.o bar.o”,也就是變數$object集合的模式,而依賴模式“%.c”則取模式“%.o”的“%”,也就是“foo bar”,並為其加下“.c”的尾碼,於是,我們的依賴目標就是“foo.c bar.c”。而命令中的“$<”和“$@”則是自動化變數,“$<”表示所有的依賴目標集(也就是“foo.c bar.c”),“$@”表示目標集(也就是“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”有幾百個,那種我們只要用這種很簡單的“靜態模式規則”就可以寫完一堆規則,實在是太有效率了。“靜態模式規則”的用法很靈活,如果用得好,那會一個很強大的功能。再看一個例子:
files = foo.elc bar.o lose.o
$(filter %.o,$(files)): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
$(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,這是一個很 沒有維護性的工作。為了避免這種繁重而又容易出錯的事情,我們可以使用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]檔的依
你可能會有興趣的文章:
限會員,要發表迴響,請先登入

