跟我一起寫 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>;
filename可以是當前操作系統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 b.mk c.mk e.mk f.mk

     make命令開始時，會把找尋include所指出的其它Makefile，並把其內容安置在當前的位置。就好像C/C++的#include指令一樣。如果文件都沒有指定絕對路徑或是相對路徑的話，make會在當前目錄下首先尋找，如果當前目錄下沒有找到，那麼，make還會在下面的幾個目錄下找：

    1、如果make執行時，有“-I”或“--include-dir”參數，那麼make就會在這個參數所指定的目錄下去尋找。

    2、如果目錄<prefix>;/include（一般是：/usr/local/bin或/usr/include）存在的話，make也會去找。
     如果有文件沒有找到的話，make會生成一條警告信息，但不會馬上出現致命錯誤。它會繼續載入其它的文件，一旦完成makefile的讀取，make會再重試這些沒有找到，或是不能讀取的文件，如果還是不行，make纔會出現一條致命信息。如果你想讓make不理那些無法讀取的文件，而繼續執行，你可以在include前加一個減號“-”。如：

-include <filename>;

      其表示，無論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所完成的也就是這個目標。
好了，還是讓我們來看一看如何書寫規則。

1）規則舉例

看到這個例子，各位應該不是很

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文件）

2）規則的語法

      targets : prerequisites
        command
        ...

      或是這樣： 

      targets : prerequisites ; command
            command
            ...

targets是文件名，以空格分開，可以使用通配符。一般來說，我們的目標基本上是一個文件，但也有可能是多個文件。
command是命令行，如果其不與“target:prerequisites”在一行，那麼，必須以[Tab鍵]開頭，如果和prerequisites在一行，那麼可以用分號做爲分隔。（見上）
prerequisites也就是目標所依賴的文件（或依賴目標）。如果其中的某個文件要比目標文件要新，那麼，目標就被認爲是“過時的”，被認爲是需要重生成的。這個在前面已經講過了。
如果命令太長，你可以使用反斜框（‘\’）作爲換行符。make對一行上有多少個字符沒有限制。規則告訴make兩件事，文件的依賴關係和如何成成目標文件。

一般來說，make會以UNIX的標準Shell，也就是/bin/sh來執行命令。

3）在規則中使用通配符

如果我們想定義一系列比較類似的文件，我們很自然地就想起使用通配符。make支持三各通配符：“*”，“?”和“[...]”。這是和Unix的B-Shell是相同的。
波浪號（“~”）字符在文件名中也有比較特殊的用途。如果是“~/test”，這就表示當前用戶的$HOME目錄下的test目錄。而“~hchen/test”則表示用戶hchen的宿主目錄下的test目錄。（這些都是Unix下的小知識了，make也支持）而在Windows或是MS-DOS下，用戶沒有宿主目錄，那麼波浪號所指的目錄則根據環境變量“HOME”而定。
通配符代替了你一系列的文件，如“*.c”表示所以後綴爲c的文件。一個需要我們注意的是，如果我們的文件名中有通配符，如：“*”，那麼可以用轉義字符“\”，如“\*”來表示真實的“*”字符，而不是任意長度的字符串。
好吧，還是先來看幾個例子吧：

clean:
         rm -f *.o</span></span>

    上面這個例子我不不多說了，這是操作系統Shell所支持的通配符。這是在命令中的通配符。

print: *.c
         lpr -p $?
         touch print

    上面這個例子說明了通配符也可以在我們的規則中，目標print依賴於所有的[.c]文件。其中的“$?”是一個自動化變量，我會在後面給你講述。

objects = *.o

    上面這個例子，表示了，通符同樣可以用在變量中。並不是說[*.o]會展開，不！objects的值就是“*.o”。Makefile中的變量其實就是C/C++中的宏。如果你要讓通配符在變量中展開，也就是讓objects的值是所有[.o]的文件名的集合，那麼，你可以這樣：

objects := $(wildcard *.o)

這種用法由關鍵字“wildcard”指出，關於Makefile的關鍵字，我們將在後面討論。

4）文件搜尋

在一些大的工程中，有大量的源文件，我們通常的做法是把這許多的源文件分類，並存放在不同的目錄中。所以，當make需要去找尋文件的依賴關係時，你可以在文件前加上路徑，但最好的方法是把一個路徑告訴make，讓make在自動去找。
Makefile文件中的特殊變量“VPATH”就是完成這個功能的，如果沒有指明這個變量，make只會在當前的目錄中去找尋依賴文件和目標文件。如果定義了這個變量，那麼，make就會在噹噹前目錄找不到的情況下，到所指定的目錄中去找尋文件了。

VPATH = src:../headers

上面的的定義指定兩個目錄，“src”和“../headers”，make會按照這個順序進行搜索。目錄由“冒號”分隔。（當然，當前目錄永遠是最高優先搜索的地方）
另一個設置文件搜索路徑的方法是使用make的“vpath”關鍵字（注意，它是全小寫的），這不是變量，這是一個make的關鍵字，這和上面提到的那個VPATH變量很類似，但是它更爲靈活。它可以指定不同的文件在不同的搜索目錄中。這是一個很靈活的功能。它的使用方法有三種：

    1、vpath <pattern>; <directories>;
          爲符合模式<pattern>;的文件指定搜索目錄<directories>;。
    2、vpath <pattern>;
    清除符合模式<pattern>;的文件的搜索目錄。
    3、vpath
    清除所有已被設置好了的文件搜索目錄。

vapth使用方法中的<pattern>;需要包含“%”字符。“%”的意思是匹配零或若干字符，例如，“%.h”表示所有以“.h”結尾的文件。<pattern>;指定了要搜索的文件集，而<directories>;則指定了<pattern>;的文件集的搜索的目錄。例如：

vpath %.h ../headers

該語句表示，要求make在“../headers”目錄下搜索所有以“.h”結尾的文件。（如果某文件在當前目錄沒有找到的話）
我們可以連續地使用vpath語句，以指定不同搜索策略。如果連續的vpath語句中出現了相同的<pattern>;，或是被重複了的<pattern>;，那麼，make會按照vpath語句的先後順序來執行搜索。如：

    vpath %.c foo
    vpath %   blish
    vpath %.c bar

其表示“.c”結尾的文件，先在“foo”目錄，然後是“blish”，最後是“bar”目錄。

    vpath %.c foo:bar
    vpath %    blish

而上面的語句則表示“.c”結尾的文件，先在“foo”目錄，然後是“bar”目錄，最後纔是“blish”目錄。

5）僞目標

最早先的一個例子中，我們提到過一個“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”命令來達到清除不同種類文件的目的。

6）多目標

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，後面的爲參數。關於函數，將在後面講述。這裏的這個函數是截取字符串的意思，“$@”表示目標的集合，就像一個數組，“$@”依次取出目標，並執於命令。

7）靜態模式

靜態模式可以更加容易地定義多目標的規則，可以讓我們的規則變得更加的有彈性和靈活。我們還是先來看一下語法：

<targets ...>;: <target-pattern>;: <prereq-patterns ...>;
            <commands>;
            ...
<span style="font-size:14px;">    targets定義了一系列的目標文件，可以有通配符。是目標的一個集合。
    target-parrtern是指明瞭targets的模式，也就是的目標集模式。
    prereq-parrterns是目標的依賴模式，它對target-parrtern形成的模式再進行一次依賴目標的定義。</span>

這樣描述這三個東西，可能還是沒有說清楚，還是舉個例子來說明一下吧。如果我們的<target-parrtern>;定義成“%.o”，意思是我們的<target>;集合中都是以“.o”結尾的，而如果我們的<prereq-parrterns>;定義成“%.c”，意思是對<target-parrtern>;所形成的目標集進行二次定義，其計算方法是，取<target-parrtern>;模式中的“%”（也就是去掉了[.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中更大的彈性。

8）自動生成依賴性

在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]文件的依賴關係，並讓make自動更新或自成[.d]文件，並把其包含在我們的主Makefile中，這樣，我們就可以自動化地生成每個文件的依賴關係了。
這裏，我們給出了一個模式規則來產生[.d]文件：

             %.d: %.c
            @set -e; rm -f $@; \
             $(CC) -M $(CPPFLAGS) $< >; $@.$$$$; \
             sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ >; $@; \
             rm -f $@.$$$$

這個規則的意思是：所有的[.d]文件依賴於[.c]文件，“rm -f $@”的意思是刪除所有的目標，也就是[.d]文件，第二行的意思是，爲每個依賴文件“$<”，也就是[.c]文件生成依賴文件，“$@”表示模式“%.d”文件，如果有一個C文件是name.c，那麼“%”就是“name”，“$$$$”意爲一個隨機編號，第二行生成的文件有可能是“name.d.12345”，第三行使用sed命令做了一個替換，關於sed命令的用法請參看相關的使用文檔。第四行就是刪除臨時文件。
總而言之，這個模式要做的事就是在編譯器生成的依賴關係中加入[.d]文件的依賴，即把依賴關係：

main.o : main.c defs.h

轉成：

main.o main.d : main.c defs.h

於是，我們的[.d]文件也會自動更新了，並會自動生成了，當然，你還可以在這個[.d]文件中加入的不只是依賴關係，包括生成的命令也可一併加入，讓每個[.d]文件都包含一個完賴的規則。一旦我們完成這個工作，接下來，我們就要把這些自動生成的規則放進我們的主Makefile中。我們可以使用Makefile的“include”命令，來引入別的Makefile文件（前面講過），例如：

sources = foo.c bar.c

 include $(sources:.c=.d)

上述語句中的“$(sources:.c=.d)”中的“.c=.d”的意思是做一個替換，把變量$(sources)所有[.c]的字串都替換成[.d]，關於這個“替換”的內容，在後面我會有更爲詳細的講述。當然，你得注意次序，因爲include是按次來載入文件，最先載入的[.d]文件中的目標會成爲默認目標。