Prayer

陳皓

概述
——

什么是makefile？或許很多Winodws的程序員都不知道這個(gè)東西，因?yàn)槟切￤indows的IDE都為你做了這個(gè)工作，但我覺(jué)得要作一個(gè)好的和professional的程序員，makefile還是要懂。這就好像現(xiàn)在有這么多的HTML的編輯器，但如果你想成為一個(gè)專業(yè)人士，你還是要了解HTML的標(biāo)識(shí)的含義。特別在Unix下的軟件編譯，你就不能不自己寫makefile了，會(huì)不會(huì)寫makefile，從一個(gè)側(cè)面說(shuō)明了一個(gè)人是否具備完成大型工程的能力。

因?yàn)椋琺akefile關(guān)系到了整個(gè)工程的編譯規(guī)則。一個(gè)工程中的源文件不計(jì)數(shù)，其按類型、功能、模塊分別放在若干個(gè)目錄中，makefile定義了一系列的規(guī)則來(lái)指定，哪些文件需要先編譯，哪些文件需要后編譯，哪些文件需要重新編譯，甚至于進(jìn)行更復(fù)雜的功能操作，因?yàn)閙akefile就像一個(gè)Shell腳本一樣，其中也可以執(zhí)行操作系統(tǒng)的命令。

makefile帶來(lái)的好處就是——“自動(dòng)化編譯”，一旦寫好，只需要一個(gè)make命令，整個(gè)工程完全自動(dòng)編譯，極大的提高了軟件開(kāi)發(fā)的效率。make是一個(gè)命令工具，是一個(gè)解釋makefile中指令的命令工具，一般來(lái)說(shuō)，大多數(shù)的IDE都有這個(gè)命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可見(jiàn)，makefile都成為了一種在工程方面的編譯方法。

現(xiàn)在講述如何寫makefile的文章比較少，這是我想寫這篇文章的原因。當(dāng)然，不同產(chǎn)商的make各不相同，也有不同的語(yǔ)法，但其本質(zhì)都是在“文件依賴性”上做文章，這里，我僅對(duì)GNU的make進(jìn)行講述，我的環(huán)境是RedHat Linux 8.0，make的版本是3.80。必竟，這個(gè)make是應(yīng)用最為廣泛的，也是用得最多的。而且其還是最遵循于IEEE 1003.2-1992 標(biāo)準(zhǔn)的（POSIX.2）。

在這篇文檔中，將以C/C++的源碼作為我們基礎(chǔ)，所以必然涉及一些關(guān)于C/C++的編譯的知識(shí)，相關(guān)于這方面的內(nèi)容，還請(qǐng)各位查看相關(guān)的編譯器的文檔。這里所默認(rèn)的編譯器是UNIX下的GCC和CC。

 

關(guān)于程序的編譯和鏈接
——————————

在此，我想多說(shuō)關(guān)于程序編譯的一些規(guī)范和方法，一般來(lái)說(shuō)，無(wú)論是C、C++、還是pas，首先要把源文件編譯成中間代碼文件，在Windows下也就是 .obj 文件，UNIX下是 .o 文件，即 Object File，這個(gè)動(dòng)作叫做編譯（compile）。然后再把大量的Object File合成執(zhí)行文件，這個(gè)動(dòng)作叫作鏈接（link）。

編譯時(shí)，編譯器需要的是語(yǔ)法的正確，函數(shù)與變量的聲明的正確。對(duì)于后者，通常是你需要告訴編譯器頭文件的所在位置（頭文件中應(yīng)該只是聲明，而定義應(yīng)該放在C/C++文件中），只要所有的語(yǔ)法正確，編譯器就可以編譯出中間目標(biāo)文件。一般來(lái)說(shuō)，每個(gè)源文件都應(yīng)該對(duì)應(yīng)于一個(gè)中間目標(biāo)文件（O文件或是OBJ文件）。

鏈接時(shí)，主要是鏈接函數(shù)和全局變量，所以，我們可以使用這些中間目標(biāo)文件（O文件或是OBJ文件）來(lái)鏈接我們的應(yīng)用程序。鏈接器并不管函數(shù)所在的源文件，只管函數(shù)的中間目標(biāo)文件（Object File），在大多數(shù)時(shí)候，由于源文件太多，編譯生成的中間目標(biāo)文件太多，而在鏈接時(shí)需要明顯地指出中間目標(biāo)文件名，這對(duì)于編譯很不方便，所以，我們要給中間目標(biāo)文件打個(gè)包，在Windows下這種包叫“庫(kù)文件”（Library File)，也就是 .lib 文件，在UNIX下，是Archive File，也就是 .a 文件。

總結(jié)一下，源文件首先會(huì)生成中間目標(biāo)文件，再由中間目標(biāo)文件生成執(zhí)行文件。在編譯時(shí)，編譯器只檢測(cè)程序語(yǔ)法，和函數(shù)、變量是否被聲明。如果函數(shù)未被聲明，編譯器會(huì)給出一個(gè)警告，但可以生成Object File。而在鏈接程序時(shí)，鏈接器會(huì)在所有的Object File中找尋函數(shù)的實(shí)現(xiàn)，如果找不到，那到就會(huì)報(bào)鏈接錯(cuò)誤碼（Linker Error），在VC下，這種錯(cuò)誤一般是：Link 2001錯(cuò)誤，意思說(shuō)是說(shuō)，鏈接器未能找到函數(shù)的實(shí)現(xiàn)。你需要指定函數(shù)的Object File.

好，言歸正傳，GNU的make有許多的內(nèi)容，閑言少敘，還是讓我們開(kāi)始吧。

 

Makefile 介紹
———————

make命令執(zhí)行時(shí)，需要一個(gè) Makefile 文件，以告訴make命令需要怎么樣的去編譯和鏈接程序。

首先，我們用一個(gè)示例來(lái)說(shuō)明Makefile的書(shū)寫規(guī)則。以便給大家一個(gè)感興認(rèn)識(shí)。這個(gè)示例來(lái)源于GNU的make使用手冊(cè)，在這個(gè)示例中，我們的工程有8個(gè)C文件，和3個(gè)頭文件，我們要寫一個(gè)Makefile來(lái)告訴make命令如何編譯和鏈接這幾個(gè)文件。我們的規(guī)則是：
    1）如果這個(gè)工程沒(méi)有編譯過(guò)，那么我們的所有C文件都要編譯并被鏈接。
    2）如果這個(gè)工程的某幾個(gè)C文件被修改，那么我們只編譯被修改的C文件，并鏈接目標(biāo)程序。
    3）如果這個(gè)工程的頭文件被改變了，那么我們需要編譯引用了這幾個(gè)頭文件的C文件，并鏈接目標(biāo)程序。

只要我們的Makefile寫得夠好，所有的這一切，我們只用一個(gè)make命令就可以完成，make命令會(huì)自動(dòng)智能地根據(jù)當(dāng)前的文件修改的情況來(lái)確定哪些文件需要重編譯，從而自己編譯所需要的文件和鏈接目標(biāo)程序。


一、Makefile的規(guī)則

在講述這個(gè)Makefile之前，還是讓我們先來(lái)粗略地看一看Makefile的規(guī)則。

    target ... : prerequisites ...
            command
            ...
            ...

    target也就是一個(gè)目標(biāo)文件，可以是Object File，也可以是執(zhí)行文件。還可以是一個(gè)標(biāo)簽（Label），對(duì)于標(biāo)簽這種特性，在后續(xù)的“偽目標(biāo)”章節(jié)中會(huì)有敘述。

    prerequisites就是，要生成那個(gè)target所需要的文件或是目標(biāo)。

    command也就是make需要執(zhí)行的命令。（任意的Shell命令）

這是一個(gè)文件的依賴關(guān)系，也就是說(shuō)，target這一個(gè)或多個(gè)的目標(biāo)文件依賴于prerequisites中的文件，其生成規(guī)則定義在command中。說(shuō)白一點(diǎn)就是說(shuō)，prerequisites中如果有一個(gè)以上的文件比target文件要新的話，command所定義的命令就會(huì)被執(zhí)行。這就是Makefile的規(guī)則。也就是Makefile中最核心的內(nèi)容。

說(shuō)到底，Makefile的東西就是這樣一點(diǎn)，好像我的這篇文檔也該結(jié)束了。呵呵。還不盡然，這是Makefile的主線和核心，但要寫好一個(gè)Makefile還不夠，我會(huì)以后面一點(diǎn)一點(diǎn)地結(jié)合我的工作經(jīng)驗(yàn)給你慢慢到來(lái)。內(nèi)容還多著呢。：）


二、一個(gè)示例

正如前面所說(shuō)的，如果一個(gè)工程有3個(gè)頭文件，和8個(gè)C文件，我們?yōu)榱送瓿汕懊嫠龅哪侨齻€(gè)規(guī)則，我們的Makefile應(yīng)該是下面的這個(gè)樣子的。

    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的易讀。我們可以把這個(gè)內(nèi)容保存在文件為“Makefile”或“makefile”的文件中，然后在該目錄下直接輸入命令“make”就可以生成執(zhí)行文件edit。如果要?jiǎng)h除執(zhí)行文件和所有的中間目標(biāo)文件，那么，只要簡(jiǎn)單地執(zhí)行一下“make clean”就可以了。

在這個(gè)makefile中，目標(biāo)文件（target）包含：執(zhí)行文件edit和中間目標(biāo)文件（*.o），依賴文件（prerequisites）就是冒號(hào)后面的那些 .c 文件和 .h文件。每一個(gè) .o 文件都有一組依賴文件，而這些 .o 文件又是執(zhí)行文件 edit 的依賴文件。依賴關(guān)系的實(shí)質(zhì)上就是說(shuō)明了目標(biāo)文件是由哪些文件生成的，換言之，目標(biāo)文件是哪些文件更新的。

在定義好依賴關(guān)系后，后續(xù)的那一行定義了如何生成目標(biāo)文件的操作系統(tǒng)命令，一定要以一個(gè)Tab鍵作為開(kāi)頭。記住，make并不管命令是怎么工作的，他只管執(zhí)行所定義的命令。make會(huì)比較targets文件和prerequisites文件的修改日期，如果prerequisites文件的日期要比targets文件的日期要新，或者target不存在的話，那么，make就會(huì)執(zhí)行后續(xù)定義的命令。

這里要說(shuō)明一點(diǎn)的是，clean不是一個(gè)文件，它只不過(guò)是一個(gè)動(dòng)作名字，有點(diǎn)像C語(yǔ)言中的lable一樣，其冒號(hào)后什么也沒(méi)有，那么，make就不會(huì)自動(dòng)去找文件的依賴性，也就不會(huì)自動(dòng)執(zhí)行其后所定義的命令。要執(zhí)行其后的命令，就要在make命令后明顯得指出這個(gè)lable的名字。這樣的方法非常有用，我們可以在一個(gè)makefile中定義不用的編譯或是和編譯無(wú)關(guān)的命令，比如程序的打包，程序的備份，等等。

三、make是如何工作的

在默認(rèn)的方式下，也就是我們只輸入make命令。那么，

    1、make會(huì)在當(dāng)前目錄下找名字叫“Makefile”或“makefile”的文件。
    2、如果找到，它會(huì)找文件中的第一個(gè)目標(biāo)文件（target），在上面的例子中，他會(huì)找到“edit”這個(gè)文件，并把這個(gè)文件作為最終的目標(biāo)文件。
    3、如果edit文件不存在，或是edit所依賴的后面的 .o 文件的文件修改時(shí)間要比edit這個(gè)文件新，那么，他就會(huì)執(zhí)行后面所定義的命令來(lái)生成edit這個(gè)文件。
    4、如果edit所依賴的.o文件也存在，那么make會(huì)在當(dāng)前文件中找目標(biāo)為.o文件的依賴性，如果找到則再根據(jù)那一個(gè)規(guī)則生成.o文件。（這有點(diǎn)像一個(gè)堆棧的過(guò)程）
    5、當(dāng)然，你的C文件和H文件是存在的啦，于是make會(huì)生成 .o 文件，然后再用 .o 文件生命make的終極任務(wù)，也就是執(zhí)行文件edit了。

這就是整個(gè)make的依賴性，make會(huì)一層又一層地去找文件的依賴關(guān)系，直到最終編譯出第一個(gè)目標(biāo)文件。在找尋的過(guò)程中，如果出現(xiàn)錯(cuò)誤，比如最后被依賴的文件找不到，那么make就會(huì)直接退出，并報(bào)錯(cuò)，而對(duì)于所定義的命令的錯(cuò)誤，或是編譯不成功，make根本不理。make只管文件的依賴性，即，如果在我找了依賴關(guān)系之后，冒號(hào)后面的文件還是不在，那么對(duì)不起，我就不工作啦。

通過(guò)上述分析，我們知道，像clean這種，沒(méi)有被第一個(gè)目標(biāo)文件直接或間接關(guān)聯(lián)，那么它后面所定義的命令將不會(huì)被自動(dòng)執(zhí)行，不過(guò)，我們可以顯示要make執(zhí)行。即命令——“make clean”，以此來(lái)清除所有的目標(biāo)文件，以便重編譯。

于是在我們編程中，如果這個(gè)工程已被編譯過(guò)了，當(dāng)我們修改了其中一個(gè)源文件，比如file.c，那么根據(jù)我們的依賴性，我們的目標(biāo)file.o會(huì)被重編譯（也就是在這個(gè)依性關(guān)系后面所定義的命令），于是file.o的文件也是最新的啦，于是file.o的文件修改時(shí)間要比edit要新，所以edit也會(huì)被重新鏈接了（詳見(jiàn)edit目標(biāo)文件后定義的命令）。

而如果我們改變了“command.h”，那么，kdb.o、command.o和files.o都會(huì)被重編譯，并且，edit會(huì)被重鏈接。


四、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ù)了兩次，如果我們的工程需要加入一個(gè)新的[.o]文件，那么我們需要在兩個(gè)地方加（應(yīng)該是三個(gè)地方，還有一個(gè)地方在clean中）。當(dāng)然，我們的makefile并不復(fù)雜，所以在兩個(gè)地方加也不累，但如果makefile變得復(fù)雜，那么我們就有可能會(huì)忘掉一個(gè)需要加入的地方，而導(dǎo)致編譯失敗。所以，為了makefile的易維護(hù)，在makefile中我們可以使用變量。makefile的變量也就是一個(gè)字符串，理解成C語(yǔ)言中的宏可能會(huì)更好。

比如，我們聲明一個(gè)變量，叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ，反正不管什么啦，只要能夠表示obj文件就行了。我們?cè)趍akefile一開(kāi)始就這樣定義：

     objects = main.o kbd.o command.o display.o \
              insert.o search.o files.o utils.o

于是，我們就可以很方便地在我們的makefile中以“$(objects)”的方式來(lái)使用這個(gè)變量了，于是我們的改良版makefile就變成下面這個(gè)樣子：

    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 文件加入，我們只需簡(jiǎn)單地修改一下 objects 變量就可以了。

關(guān)于變量更多的話題，我會(huì)在后續(xù)給你一一道來(lái)。


五、讓make自動(dòng)推導(dǎo)

GNU的make很強(qiáng)大，它可以自動(dòng)推導(dǎo)文件以及文件依賴關(guān)系后面的命令，于是我們就沒(méi)必要去在每一個(gè)[.o]文件后都寫上類似的命令，因?yàn)椋覀兊膍ake會(huì)自動(dòng)識(shí)別，并自己推導(dǎo)命令。

只要make看到一個(gè)[.o]文件，它就會(huì)自動(dòng)的把[.c]文件加在依賴關(guān)系中，如果make找到一個(gè)whatever.o，那么whatever.c，就會(huì)是whatever.o的依賴文件。并且 cc -c whatever.c 也會(huì)被推導(dǎo)出來(lái)，于是，我們的makefile再也不用寫得這么復(fù)雜。我們的是新的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的“隱晦規(guī)則”。上面文件內(nèi)容中，“.PHONY”表示，clean是個(gè)偽目標(biāo)文件。

關(guān)于更為詳細(xì)的“隱晦規(guī)則”和“偽目標(biāo)文件”，我會(huì)在后續(xù)給你一一道來(lái)。


六、另類風(fēng)格的makefile

即然我們的make可以自動(dòng)推導(dǎo)命令，那么我看到那堆[.o]和[.h]的依賴就有點(diǎn)不爽，那么多的重復(fù)的[.h]，能不能把其收攏起來(lái)，好吧，沒(méi)有問(wèn)題，這個(gè)對(duì)于make來(lái)說(shuō)很容易，誰(shuí)叫它提供了自動(dòng)推導(dǎo)命令和文件的功能呢？來(lái)看看最新風(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變得很簡(jiǎn)單，但我們的文件依賴關(guān)系就顯得有點(diǎn)凌亂了。魚(yú)和熊掌不可兼得。還看你的喜好了。我是不喜歡這種風(fēng)格的，一是文件的依賴關(guān)系看不清楚，二是如果文件一多，要加入幾個(gè)新的.o文件，那就理不清楚了。


七、清空目標(biāo)文件的規(guī)則

每個(gè)Makefile中都應(yīng)該寫一個(gè)清空目標(biāo)文件（.o和執(zhí)行文件）的規(guī)則，這不僅便于重編譯，也很利于保持文件的清潔。這是一個(gè)“修養(yǎng)”（呵呵，還記得我的《編程修養(yǎng)》嗎）。一般的風(fēng)格都是：

        clean:
            rm edit $(objects)

更為穩(wěn)健的做法是：

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

前面說(shuō)過(guò)，.PHONY意思表示clean是一個(gè)“偽目標(biāo)”，。而在rm命令前面加了一個(gè)小減號(hào)的意思就是，也許某些文件出現(xiàn)問(wèn)題，但不要管，繼續(xù)做后面的事。當(dāng)然，clean的規(guī)則不要放在文件的開(kāi)頭，不然，這就會(huì)變成make的默認(rèn)目標(biāo)，相信誰(shuí)也不愿意這樣。不成文的規(guī)矩是——“clean從來(lái)都是放在文件的最后”。


上面就是一個(gè)makefile的概貌，也是makefile的基礎(chǔ)，下面還有很多makefile的相關(guān)細(xì)節(jié)，準(zhǔn)備好了嗎？準(zhǔn)備好了就來(lái)。