Prayer

陳皓

概述
——

什么是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的相關細節，準備好了嗎？準備好了就來。