makefile 介紹
make命令執(zhí)行時涕癣,需要一個 makefile 文件,以告訴make命令如何去編譯和鏈接程序前标。
首先坠韩,我們用一個示例來說明makefile的書寫規(guī)則距潘。以便給大家一個感性認(rèn)識。這個示例來源于gnu的make使用手冊只搁,在這個示例中音比,我們的工程有8個c文件,和3個頭文件氢惋,我們要寫一個makefile來告訴make命令如何編譯和鏈接這幾個文件洞翩。我們的規(guī)則是:
1)如果這個工程沒有編譯過,那么我們的所有c文件都要編譯并被鏈接明肮。
2)如果這個工程的某幾個c文件被修改菱农,那么我們只編譯被修改的c文件,并鏈接目標(biāo)程序柿估。
3)如果這個工程的頭文件被改變了循未,那么我們需要編譯引用了這幾個頭文件的c文件,并鏈接目標(biāo)程序秫舌。
只要我們的makefile寫得夠好的妖,所有的這一切,我們只用一個make命令就可以完成足陨,make命令會自動智能地根據(jù)當(dāng)前的文件修改的情況來確定哪些文件需要重編譯嫂粟,從而自己編譯所需要的文件和鏈接目標(biāo)程序。
makefile的規(guī)則
在講述這個makefile之前墨缘,還是讓我們先來粗略地看一看makefile的規(guī)則星虹。
target ... : prerequisites ...
command
...
...
target可以是一個object file(目標(biāo)文件),也可以是一個執(zhí)行文件镊讼,還可以是一個標(biāo)簽(label)宽涌。對于標(biāo)簽這種特性,在后續(xù)的“偽目標(biāo)”章節(jié)中會有敘述蝶棋。
prerequisites就是卸亮,要生成那個target所需要的文件或是目標(biāo)。
command也就是make需要執(zhí)行的命令玩裙。(任意的shell命令)
這是一個文件的依賴關(guān)系兼贸,也就是說,target這一個或多個的目標(biāo)文件依賴于prerequisites中的文件吃溅,其生成規(guī)則定義在 command中溶诞。說白一點(diǎn)就是說,prerequisites中如果有一個以上的文件比target文件要新的話决侈,command所定義的命令就會被執(zhí)行很澄。這就是makefile的規(guī)則。也就是makefile中最核心的內(nèi)容。
說到底甩苛,makefile的東西就是這樣一點(diǎn),好像我的這篇文檔也該結(jié)束了俏站。呵呵讯蒲。還不盡然,這是makefile的主線和核心肄扎,但要寫好一個makefile還不夠墨林,我會以后面一點(diǎn)一點(diǎn)地結(jié)合我的工作經(jīng)驗(yàn)給你慢慢道來。內(nèi)容還多著呢犯祠。:)
一個示例
正如前面所說的旭等,如果一個工程有3個頭文件,和8個c文件衡载,我們?yōu)榱送瓿汕懊嫠龅哪侨齻€規(guī)則搔耕,我們的makefile應(yīng)該是下面這個樣子的。
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o /*注釋:如果后面這些.o文件比edit可執(zhí)行文件新,那么才會去執(zhí)行下面這句命令*/
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的易讀弃榨。我們可以把這個內(nèi)容保存在名字為“makefile”或“Makefile” 的文件中,然后在該目錄下直接輸入命令“make”就可以生成執(zhí)行文件edit梨睁。如果要刪除執(zhí)行文件和所有的中間目標(biāo)文件鲸睛,那么,只要簡單地執(zhí)行一下 “make clean”就可以了坡贺。
在這個makefile中官辈,目標(biāo)文件(target)包含:執(zhí)行文件edit和中間目標(biāo)文件(*.o),依賴文件(prerequisites)就是冒號后面的那些 .c 文件和 .h文件遍坟。每一個 .o 文件都有一組依賴文件拳亿,而這些 .o 文件又是執(zhí)行文件 edit 的依賴文件。依賴關(guān)系的實(shí)質(zhì)上就是說明了目標(biāo)文件是由哪些文件生成的政鼠,換言之风瘦,目標(biāo)文件是哪些文件更新的。
在定義好依賴關(guān)系后公般,后續(xù)的那一行定義了如何生成目標(biāo)文件的操作系統(tǒng)命令万搔,一定要以一個tab鍵作為開頭。記住官帘,make并不管命令是怎么工作的瞬雹,他只管執(zhí)行所定義的命令。make會比較targets文件和prerequisites文件的修改日期刽虹,如果prerequisites文件的日期要比targets文件的日期要新酗捌,或者target不存在的話,那么,make就會執(zhí)行后續(xù)定義的命令胖缤。
這里要說明一點(diǎn)的是尚镰,clean不是一個文件,它只不過是一個動作名字哪廓,有點(diǎn)像c語言中的lable一樣狗唉,其冒號后什么也沒有,那么涡真,make就不會自動去找它的依賴性分俯,也就不會自動執(zhí)行其后所定義的命令。要執(zhí)行其后的命令(不僅用于clean哆料,其他lable同樣適用)缸剪,就要在make命令后明顯得指出這個lable的名字。這樣的方法非常有用东亦,我們可以在一個makefile中定義不用的編譯或是和編譯無關(guān)的命令杏节,比如程序的打包,程序的備份讥此,等等拢锹。
make是如何工作的
在默認(rèn)的方式下,也就是我們只輸入make命令萄喳。那么卒稳,
- make會在當(dāng)前目錄下找名字叫“Makefile”或“makefile”的文件。
- 如果找到他巨,它會找文件中的第一個目標(biāo)文件(target)充坑,在上面的例子中,他會找到“edit”這個文件染突,并把這個文件作為最終的目標(biāo)文件捻爷。
- 如果edit文件不存在,或是edit所依賴的后面的 .o 文件的文件修改時間要比edit這個文件新份企,那么也榄,他就會執(zhí)行后面所定義的命令來生成edit這個文件。
- 如果edit所依賴的.o文件也不存在司志,那么make會在當(dāng)前文件中找目標(biāo)為.o文件的依賴性甜紫,如果找到則再根據(jù)那一個規(guī)則生成.o文件。(這有點(diǎn)像一個堆棧的過程)
- 當(dāng)然骂远,你的C文件和H文件是存在的啦囚霸,于是make會生成 .o 文件,然后再用 .o 文件生成make的終極任務(wù)激才,也就是執(zhí)行文件edit了拓型。
這就是整個make的依賴性额嘿,make會一層又一層地去找文件的依賴關(guān)系,直到最終編譯出第一個目標(biāo)文件劣挫。在找尋的過程中册养,如果出現(xiàn)錯誤,比如最后被依賴的文件找不到压固,那么make就會直接退出捕儒,并報錯,而對于所定義的命令的錯誤邓夕,或是編譯不成功,make根本不理阎毅。make只管文件的依賴性焚刚,即,如果在我找了依賴關(guān)系之后扇调,冒號后面的文件還是不在矿咕,那么對不起,我就不工作啦狼钮。
通過上述分析碳柱,我們知道,像clean這種熬芜,沒有被第一個目標(biāo)文件直接或間接關(guān)聯(lián)莲镣,那么它后面所定義的命令將不會被自動執(zhí)行,不過涎拉,我們可以顯式要make執(zhí)行瑞侮。即命令——“make clean”,以此來清除所有的目標(biāo)文件鼓拧,以便重編譯半火。
于是在我們編程中,如果這個工程已被編譯過了季俩,當(dāng)我們修改了其中一個源文件钮糖,比如file.c,那么根據(jù)我們的依賴性酌住,我們的目標(biāo)file.o會被重編譯(也就是在這個依性關(guān)系后面所定義的命令)店归,于是file.o的文件也是最新的啦,于是file.o的文件修改時間要比edit要新赂韵,所以 edit也會被重新鏈接了(詳見edit目標(biāo)文件后定義的命令)娱节。
而如果我們改變了“command.h”,那么祭示,kdb.o肄满、command.o和files.o都會被重編譯谴古,并且,edit會被重鏈接稠歉。
makefile中使用變量
在上面的例子中掰担,先讓我們看看edit的規(guī)則:
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]文件的字符串被重復(fù)了兩次,如果我們的工程需要加入一個新的[.o]文件怒炸,那么我們需要在兩個地方加(應(yīng)該是三個地方带饱,還有一個地方在clean中)。當(dāng)然阅羹,我們的makefile并不復(fù)雜勺疼,所以在兩個地方加也不累,但如果makefile變得復(fù)雜捏鱼,那么我們就有可能會忘掉一個需要加入的地方执庐,而導(dǎo)致編譯失敗。所以导梆,為了makefile的易維護(hù)轨淌,在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變?yōu)槿缦拢?/p>
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即可北专。
更多關(guān)于變量的話題禀挫,我會在后續(xù)詳細(xì)介紹。
讓make自動推導(dǎo)
GNU的make很強(qiáng)大拓颓,它可以自動推導(dǎo)文件以及文件依賴關(guān)系后面的命令语婴,于是我們就沒必要去在每一個[.o]文件后都寫上類似的命令,因?yàn)槭荒溃覀兊膍ake會自動識別砰左,并自己推導(dǎo)命令。
只要make看到一個[.o]文件场航,它就會自動的把[.c]文件加在依賴關(guān)系中缠导,如果make找到一個whatever.o,那么 whatever.c溉痢,就會是whatever.o的依賴文件僻造。并且 cc -c whatever.c 也會被推導(dǎo)出來憋他,于是,我們的makefile 再也不用寫得這么復(fù)雜髓削。我們的新makefile又出爐了竹挡。
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc = gcc
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的“隱晦規(guī)則”立膛。這種規(guī)則對比顯示規(guī)則揪罕,其實(shí)只是隱藏了[.c]文件,顯得稍微清爽一點(diǎn)而已宝泵,上面文件內(nèi)容中好啰,“.PHONY”表示,clean是個偽目標(biāo)文件儿奶。
關(guān)于更為詳細(xì)的“隱晦規(guī)則”和“偽目標(biāo)文件”坎怪,我會在后續(xù)給你一一道來。
另類風(fēng)格的makefile
既然我們的make可以自動推導(dǎo)命令廓握,那么我看到那堆[.o]和[.h]的依賴就有點(diǎn)不爽,那么多的重復(fù)的[.h]嘁酿,能不能把其收攏起來隙券,好吧,沒有問題闹司,這個對于make來說很容易娱仔,誰叫它提供了自動推導(dǎo)命令和文件的功能呢?來看看最新風(fēng)格的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)
這種風(fēng)格牲迫,讓我們的makefile變得很簡單,但我們的文件依賴關(guān)系就顯得有點(diǎn)凌亂了借卧。魚和熊掌不可兼得盹憎。還看你的喜好了。我是不喜歡這種風(fēng)格的铐刘,一是文件的依賴關(guān)系看不清楚陪每,二是如果文件一多,要加入幾個新的.o文件镰吵,那就理不清楚了檩禾。
清空目標(biāo)文件的規(guī)則
每個Makefile中都應(yīng)該寫一個清空目標(biāo)文件(.o和執(zhí)行文件)的規(guī)則,這不僅便于重編譯疤祭,也很利于保持文件的清潔盼产。這是一個“修養(yǎng)”。一般的風(fēng)格都是:
clean:
rm edit $(objects)
更為穩(wěn)健的做法是:
.PHONY : clean
clean :
-rm edit $(objects)
前面說過勺馆,.PHONY意思表示clean是一個“偽目標(biāo)”戏售。哪怕當(dāng)前目錄下已經(jīng)存在了一個名為clean的文件侨核,make仍然會去執(zhí)行clean目標(biāo)下的命令。
而在rm命令前面加了一個小減號的意思就是蜈项,也許某些文件出現(xiàn)問題芹关,但不要管,繼續(xù)做后面的事紧卒。當(dāng)然侥衬,clean的規(guī)則不要放在文件的開頭,不然跑芳,這就會變成make的默認(rèn)目標(biāo)轴总,相信誰也不愿意這樣。不成文的規(guī)矩是——“clean從來都是放在文件的最后”博个。
上面就是一個makefile的概貌怀樟,也是makefile的基礎(chǔ),下面還有很多makefile的相關(guān)細(xì)節(jié)盆佣,準(zhǔn)備好了嗎往堡?準(zhǔn)備好了就來。
Makefile里有什么共耍?
Makefile里主要包含了五個東西:顯式規(guī)則虑灰、隱晦規(guī)則、變量定義痹兜、文件指示和注釋穆咐。
- 顯式規(guī)則。顯式規(guī)則說明了字旭,如何生成一個或多個目標(biāo)文件对湃。這是由Makefile的書寫者明顯指出,要生成的文件遗淳,文件的依賴文件拍柒,生成的命令。
- 隱晦規(guī)則屈暗。由于我們的make有自動推導(dǎo)的功能斤儿,所以隱晦的規(guī)則可以讓我們比較簡略地書寫Makefile,這是由make所支持的恐锦。
- 變量的定義往果。在Makefile中我們要定義一系列的變量,變量一般都是字符串一铅,這個有點(diǎn)像你C語言中的宏陕贮,當(dāng)Makefile被執(zhí)行時,其中的變量都會被擴(kuò)展到相應(yīng)的引用位置上潘飘。
- 文件指示肮之。其包括了三個部分掉缺,一個是在一個Makefile中引用另一個Makefile,就像C語言中的include一樣戈擒;另一個是指根據(jù)某些情況指定Makefile中的有效部分眶明,就像C語言中的預(yù)編譯#if一樣;還有就是定義一個多行的命令筐高。有關(guān)這一部分的內(nèi)容搜囱,我會在后續(xù)的部分中講述。
- 注釋柑土。Makefile中只有行注釋蜀肘,和UNIX的Shell腳本一樣,其注釋是用“#”字符稽屏,這個就像C/C++中的“//”一樣扮宠。如果你要在你的Makefile中使用“#”字符,可以用反斜杠進(jìn)行轉(zhuǎn)義狐榔,如:“#”坛增。
最后,還值得一提的是薄腻,在Makefile中的命令轿偎,必須要以[Tab]鍵開始。
Makefile的文件名
默認(rèn)的情況下被廓,make命令會在當(dāng)前目錄下按順序找尋文件名為“GNUmakefile”、“makefile”萝玷、“Makefile”的文件嫁乘,找到了解釋這個文件。在這三個文件名中球碉,最好使用“Makefile”這個文件名,因?yàn)椋@個文件名第一個字符為大寫舱权,這樣有一種顯目的感覺(好吧溉贿,其實(shí)這個理由我看到是有點(diǎn)呵呵的)。最好不要用 “GNUmakefile”豆拨,這個文件是GNU的make識別的直奋。有另外一些make只對全小寫的“makefile”文件名敏感,但是基本上來說施禾,大多數(shù)的make都支持“makefile”和“Makefile”這兩種默認(rèn)文件名脚线。
當(dāng)然,你可以使用別的文件名來書寫Makefile弥搞,比如:“Make.Linux”邮绿,“Make.Solaris”渠旁,“Make.AIX”等,如果要指定特定的Makefile船逮,你可以使用make的“-f”和“--file”參數(shù)顾腊,如:make -f Make.Linux或make --file Make.AIX。
總結(jié)文件名:“GNUmakefile”挖胃、“makefile”杂靶、“Makefile”支持這三種, 以Makefile為優(yōu)冠骄。
引用其它的Makefile
在Makefile使用include關(guān)鍵字可以把別的Makefile包含進(jìn)來伪煤,這很像C語言的#include,被包含的文件會原模原樣的放在當(dāng)前文件的包含位置凛辣。include的語法是:
include <filename>;
filename可以是當(dāng)前操作系統(tǒng)Shell的文件模式(可以包含路徑和通配符)
在include前面可以有一些空字符抱既,但是絕不能是[Tab]鍵開始。include和<filename>;可以用一個或多個空格隔開扁誓。舉個例子防泵,你有這樣幾個Makefile:a.mk、b.mk蝗敢、c.mk捷泞,還有一個文件叫foo.make,以及一個變量$(bar)寿谴,其包含了 e.mk和f.mk锁右,那么,下面的語句:
include foo.make *.mk $(bar)
等價于:
include foo.make [a.mk](http://a.mk) [b.mk](http://b.mk) [c.mk](http://c.mk) [e.mk](http://e.mk) [f.mk](http://f.mk)
make命令開始時讶泰,會找尋include所指出的其它Makefile咏瑟,并把其內(nèi)容安置在當(dāng)前的位置。就好像C/C++的#include指令一樣痪署。如果文件都沒有指定絕對路徑或是相對路徑的話码泞,make會在當(dāng)前目錄下首先尋找,如果當(dāng)前目錄下沒有找到狼犯,那么余寥,make還會在下面的幾個目錄下找:
- 如果make執(zhí)行時,有“-I”或“--include-dir”參數(shù)悯森,那么make就會在這個參數(shù)所指定的目錄下去尋找宋舷。
- 如果目錄<prefix>;/include(一般是:/usr/local/bin或/usr/include)存在的話,make也會去找瓢姻。
如果有文件沒有找到的話肥缔,make會生成一條警告信息,但不會馬上出現(xiàn)致命錯誤。它會繼續(xù)載入其它的文件续膳,一旦完成makefile的讀取改艇, make會再重試這些沒有找到,或是不能讀取的文件坟岔,如果還是不行谒兄,make才會出現(xiàn)一條致命信息。如果你想讓make不理那些無法讀取的文件社付,而繼續(xù)執(zhí)行承疲,你可以在include前加一個減號“-”。如:
-include <filename>;
其表示鸥咖,無論include過程中出現(xiàn)什么錯誤燕鸽,都不要報錯繼續(xù)執(zhí)行。和其它版本make兼容的相關(guān)命令是sinclude啼辣,其作用和這一個是一樣的啊研。
環(huán)境變量 MAKEFILES
如果你的當(dāng)前環(huán)境中定義了環(huán)境變量MAKEFILES,那么鸥拧,make會把這個變量中的值做一個類似于include的動作党远。這個變量中的值是其它的Makefile,用空格分隔富弦。只是沟娱,它和include不同的是,從這個環(huán)境變量中引入的Makefile的“目標(biāo)”不會起作用腕柜,如果環(huán)境變量中定義的文件發(fā)現(xiàn)錯誤济似,make也會不理。
但是在這里我還是建議不要使用這個環(huán)境變量盏缤,因?yàn)橹灰@個變量一被定義砰蠢,那么當(dāng)你使用make時,所有的Makefile都會受到它的影響蛾找,這絕不是你想看到的。在這里提這個事赵誓,只是為了告訴大家打毛,也許有時候你的Makefile出現(xiàn)了怪事,那么你可以看看當(dāng)前環(huán)境中有沒有定義這個變量俩功。
make的工作方式
GNU的make工作時的執(zhí)行步驟如下:(想來其它的make也是類似)
- 讀入所有的Makefile幻枉。
- 讀入被include的其它Makefile。
- 初始化文件中的變量诡蜓。
- 推導(dǎo)隱晦規(guī)則熬甫,并分析所有規(guī)則。
- 為所有的目標(biāo)文件創(chuàng)建依賴關(guān)系鏈蔓罚。
- 根據(jù)依賴關(guān)系椿肩,決定哪些目標(biāo)要重新生成瞻颂。
- 執(zhí)行生成命令。
1-5步為第一個階段郑象,6-7為第二個階段贡这。第一個階段中,如果定義的變量被使用了厂榛,那么盖矫,make會把其展開在使用的位置。但make并不會完全馬上展開击奶,make使用的是拖延戰(zhàn)術(shù)辈双,如果變量出現(xiàn)在依賴關(guān)系的規(guī)則中,那么僅當(dāng)這條依賴被決定要使用了柜砾,變量才會在其內(nèi)部展開湃望。
當(dāng)然,這個工作方式你不一定要清楚局义,但是知道這個方式你也會對make更為熟悉喜爷。有了這個基礎(chǔ),后續(xù)部分也就容易看懂了萄唇。