1. 程式人生 > >make之makefile 一 介紹

make之makefile 一 介紹

大家都知道make是Linux上面的程式碼編譯工具,說白了make其實就是一種指令碼,而makefile就是這樣的一個指令碼檔案,指令碼檔案是將我們想要做的事情集合起來,然後統一執行,這樣可以提供效率,以後執行不需要再一個一個去執行,只需要執行指令碼檔案makefile即可。好了,我們開始吧,由於我是初學者,所以記錄的東西都是比較基本的,請大家多多理解。

此文章是我從另一篇文章中提取出來的,分類出來,便於初學者學習檢視,該文章地址:https://www.cnblogs.com/mfryf/p/3305778.html

什麼是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來說非常easy,誰叫它提供了自己主動推導命令和檔案的功能呢?來看看最新風格的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變得非常easy,但我們的檔案依賴關係就顯得有點凌亂了。魚和熊掌不可兼得。還看你的喜好了。我是不喜歡這樣的風格的,一是檔案的依賴關係看不清晰,二是假設檔案一多,要新增幾個新的.o檔案,那就理不清晰了。

七、清空目標檔案的規則

每一個Makefile中都應該寫一個清空目標檔案(.o和執行檔案)的規則,這不僅便於重編譯,也非常利於保持檔案的清潔。這是一個“修養”(呵呵,還記得我的《程式設計修養》嗎)。一般的風格都是:

clean:
rm edit $(objects)

更為穩健的做法是:

.PHONY : clean
clean :
-rm edit $(objects)

前面說過,.PHONY意思表示clean是一個“偽目標”,。而在rm命令前面加了一個小減號的意思就是,或許某些檔案出現故障,但不要管,繼續做後面的事。當然,clean的規則不要放在檔案的開頭,不然,這就會變成make的預設目標,相信誰也不願意這樣。不成文的規矩是——“clean從來都是放在檔案的最後”。