C語言 Make命令教程

make只是一個根據指定的Shell命令進行構建的工具

在linux和unix中，有一個強大的使用程序，叫make，可以用它來管理多模塊程序的編譯和鏈接，直至生成可執行文件

make使用程序讀取一個說明文件，稱為Makefile，Makefile文件中描述了整個軟件工程的 編譯規則和各個文件之間的依賴關系；

Makefile就像是一個Shell腳本一樣，其中可以執行操作系統的命令，它帶來的好處就是我們能夠實現“自動化編譯”，一旦寫好，只要一個make命令，整個軟件功能就完全自動編譯，極大的提高了軟件開發的效率；

make是一個命令工具，是一個解釋Makefile中指令的命令工具，一般來說大多數IDE都有這個命令

使用make可以是重新編譯的次數達到最小化；

格式

Makefile文件由一系列規則（rules）構成。每條規則的形式如下。

<target> : <prerequisites> 
[tab]  <commands>

target

一個目標（target）就構成一條規則。目標通常是文件名，指明Make命令所要構建的對象，

目標可以是一個文件名，也可以是多個文件名，之間用空格分隔。

偽目標

除了文件名，目標還可以是某個操作的名字，這稱為"偽目標"（phony target）

clean:
	rm *.o

clean不是文件名，而是操作的名字，屬於“偽目標”，作用是刪除對象文件

$ make clean

注：如果當前目錄中，正好有一個文件叫做clean，那么此命令不會執行。因為make發現clean文件已經存在，就沒有必要重新構建 了。就不會執行rm命令。

為了避免這種情況，可以聲明clean是“偽目標”。

.PHONY: clean
clean:
	rm *.o temp

聲明clean是偽目標之后，make就不會去檢車是否存在一個叫做clean的文件，而是每次運行都執行對應的命令。

如果Make命令運行時沒有指定目標，默認會執行Makefile文件的第一個目標。

$ make

上面代碼執行Makefile文件的第一個目標。

prerequistites

前置條件通常是一組文件名，之間用空格分隔。它指定了"目標"是否重新構建的判斷標准：只要有一個前置文件不存在，或者有過更新（前置文件的last-modification時間戳比目標的時間戳新），"目標"就需要重新構建。

result.txt: source.txt
    cp source.txt result.txt

上面代碼中，構建 result.txt 的前置條件是 source.txt 。如果當前目錄中，source.txt 已經存在，那么make result.txt可以正常運行，否則必須再寫一條規則，來生成 source.txt 。

注：若前置文件不存在，那么make會自動尋找生成前置文件的語句，會先生成前置文件再生成目標文件，如沒有生成前置文件的語句，那么則無法生成目標文件。

source.txt:
    echo "this is the source" > source.txt

上面代碼中，source.txt后面沒有前置條件，就意味着它跟其他文件都無關，只要這個文件還不存在，每次調用make source.txt，它都會生成。

注：多次執行生成同一文件，若前置條件不變，則不會重復生成。

$ make result.txt
$ make result.txt

上面命令連續執行兩次make result.txt。第一次執行會先新建 source.txt，然后再新建 result.txt。第二次執行，Make發現 source.txt 沒有變動（時間戳晚於 result.txt），就不會執行任何操作，result.txt 也不會重新生成。

多文件

如果需要生成多個文件，往往采用下面的寫法。

source: file1 file2 file3

上面代碼中，source 是一個偽目標，只有三個前置文件，沒有任何對應的命令。

$ make source

執行make source命令后，就會一次性生成 file1，file2，file3 三個文件。這比下面的寫法要方便很多。

$ make file1
$ make file2
$ make file3

commands

命令（commands）表示如何更新目標文件，由一行或多行的Shell命令組成。它是構建"目標"的具體指令，它的運行結果通常就是生成目標文件。

每行命令之前必須有一個tab鍵。如果想用其他鍵，可以用內置變量.RECIPEPREFIX聲明。

.RECIPEPREFIX = >
all:
> echo Hello, world

上面代碼用.RECIPEPREFIX指定，大於號（>）替代tab鍵。所以，每一行命令的起首變成了大於號，而不是tab鍵。

注

需要注意的是，每行命令在一個單獨的shell中執行。這些Shell之間沒有繼承關系。

var-lost:
    export foo=bar
    echo "foo=[$$foo]"

上面代碼執行后（make var-lost），取不到foo的值。因為兩行命令在兩個不同的進程執行。

1. 一個解決辦法是將兩行命令寫在一行，中間用分號分隔。

   var-kept:
       export foo=bar; echo "foo=[$$foo]"
   

2. 另一個解決辦法是在換行符前加反斜杠轉義。

   var-kept:
       export foo=bar; \
       echo "foo=[$$foo]"
   

3. 最后一個方法是加上.ONESHELL:命令。

   .ONESHELL:
   var-kept:
       export foo=bar; 
       echo "foo=[$$foo]"
   

語法

注釋

井號（#）在Makefile中表示注釋。

# 這是注釋
result.txt: source.txt
    # 這是注釋
    cp source.txt result.txt # 這也是注釋

echoing

正常情況下，make會打印每條命令，然后再執行，這就叫做回聲（echoing）。

test:
    # 這是測試

執行上面的規則，會得到下面的結果。

$ make test
# 這是測試

在命令的前面加上@，就可以關閉回聲。

test:
    @# 這是測試

注：由於在構建過程中，需要了解當前在執行哪條命令，所以通常只在注釋和純顯示的echo命令前面加上@。

test:
    @# 這是測試
    @echo TODO

通配符

通配符（wildcard）用來指定一組符合條件的文件名。Makefile 的通配符與 Bash 一致，主要有星號（*）、問號（？）和 [...] 。比如， *.o 表示所有后綴名為o的文件。

模式匹配

Make命令允許對文件名，進行類似正則運算的匹配，主要用到的匹配符是%。比如，假定當前目錄下有 f1.c 和 f2.c 兩個源碼文件，需要將它們編譯為對應的對象文件。

%.o: %.c

等同於下面的寫法。

f1.o: f1.c
f2.o: f2.c

使用匹配符%，可以將大量同類型的文件，只用一條規則就完成構建。

變量和賦值符

Makefile 允許使用等號自定義變量。

txt = Hello World
test:
    @echo $(txt)

上面代碼中，變量 txt 等於 Hello World。調用時，變量需要放在 $( ) 之中。

調用Shell變量，需要在美元符號前，再加一個美元符號，這是因為Make命令會對美元符號轉義。

test:
    @echo $$HOME

變量賦值

v1 = $(v2)

上面代碼中，變量 v1 的值是另一個變量 v2。這時會產生一個問題，v1 的值到底在定義時擴展（靜態擴展），還是在運行時擴展（動態擴展）？如果 v2 的值是動態的，這兩種擴展方式的結果可能會差異很大。

靜態擴展是指v1的值是v2的初始值，而動態擴展是v1的值會隨着v2進行改變

為了解決類似問題，Makefile一共提供了四個賦值運算符 （=、:=、？=、+=），它們的區別請看StackOverflow

VARIABLE = value
# 在執行時擴展，允許遞歸擴展。動態擴展

VARIABLE := value
# 在定義時擴展。靜態擴展

VARIABLE ?= value
# 只有在該變量為空時才設置值。

VARIABLE += value
# 將值追加到變量的尾端。

example

/* Filename: Makefile*/
x := foo
y := $(x) bar
x := later

a = foo
b = $(a) bar
a = later

test:
    @echo x - $(x)
    @echo y - $(y)
    @echo a - $(a)
    @echo b - $(b)

make test prints:

x - later
y - foo bar
a - later
b - later bar

y值中用的是x的初始值，而b值用的是a的最新值。

:= 靜態擴展

= 動態擴展

內置變量

Make命令提供一系列內置變量，比如，$(CC) 指向當前使用的編譯器，$(MAKE) 指向當前使用的Make工具。這主要是為了跨平台的兼容性，詳細的內置變量清單見手冊。

自動變量

1. $@

$@指代當前目標，就是Make命令當前構建的那個目標。比如，make foo的 $@ 就指代foo。

a.txt b.txt: 
    touch $@

等同於下面的寫法。

a.txt:
    touch a.txt
b.txt:
    touch b.txt

2. $<

$< 指代第一個前置條件。比如，規則為 t: p1 p2，那么$< 就指代p1。

a.txt: b.txt c.txt
    cp $< $@ 

等同於下面的寫法。

a.txt: b.txt c.txt
    cp b.txt a.txt 

3. $?

$? 指代比目標更新的所有前置條件，之間以空格分隔。比如，規則為 t: p1 p2，其中 p2 的時間戳比 t 新，$?就指代p2

4. $^

$^ 指代所有前置條件，之間以空格分隔。比如，規則為 t: p1 p2，那么 $^ 就指代 p1 p2 。

5. $*

$* 指代匹配符 % 匹配的部分， 比如% 匹配 f1.txt 中的f1 ，$* 就表示 f1。

6. $(@D) 和 $(@F)

$(@D) 和 $(@F) 分別指向 $@ 的目錄名和文件名。

比如，$@是 src/input.c，那么$(@D) 的值為 src ，$(@F) 的值為 input.c。

7. $(<D) 和 $(<F)

$(<D) 和 $(<F) 分別指向 $< 的目錄名和文件名。

example

dest/%.txt: src/%.txt
    @[ -d dest ] || mkdir dest
    cp $< $@

上面代碼將 src 目錄下的 txt 文件，拷貝到 dest 目錄下。首先判斷 dest 目錄是否存在，如果不存在就新建，然后，$< 指代前置文件（src/%.txt）， $@指代目標文件（dest/%.txt）。

判斷和循環

Makefile使用 Bash 語法，完成判斷和循環。

ifeq ($(CC),gcc)
  libs=$(libs_for_gcc)
else
  libs=$(normal_libs)
endif

上面代碼判斷當前編譯器是否 gcc ，然后指定不同的庫文件。

LIST = one two three
all:
    for i in $(LIST); do \
        echo $$i; \
    done

# 等同於

all:
    for i in one two three; do \
        echo $i; \
    done

上面代碼的運行結果。

one
two
three

函數

Makefile 還可以使用函數，格式如下。

$(function arguments)
# 或者
${function arguments}

Makefile提供了許多內置函數，可供調用。下面是幾個常用的內置函數。

1. shell 函數

shell 函數用來執行 shell 命令

srcfiles := $(shell echo src/{00..99}.txt)

2. wildcard 函數

wildcard 函數用來在 Makefile 中，替換 Bash 的通配符。

srcfiles := $(wildcard src/*.txt)

3. subst 函數

subst 函數用來文本替換，格式如下。

$(subst from,to,text)

下面的例子將字符串"feet on the street"替換成"fEEt on the strEEt"。

$(subst ee,EE,feet on the street)

comma:= ,
empty:=
# space變量用兩個空變量作為標識符，當中是一個空格
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))
# bar is now `a,b,c'.

4. patsubst函數

patsubst 函數用於模式匹配的替換，格式如下。

$(patsubst pattern,replacement,text)

下面的例子將文件名"x.c.c bar.c"，替換成"x.c.o bar.o"。

$(patsubst %.c,%.o,x.c.c bar.c)

5. 替換后綴名

替換后綴名函數的寫法是：變量名 + 冒號 + 后綴名替換規則。它實際上patsubst函數的一種簡寫形式。

min: $(OUTPUT:.js=.min.js)

上面代碼的意思是，將變量OUTPUT中的后綴名 .js 全部替換成 .min.js 。

注意

makefile書寫主要注意的是：

1. 編譯規則
2. 依賴關系
3. 倒推原理
4. 使用make命令去執行
5. 如果已經是最新的文件的時候，就不會再去編譯執行了
6. make去讀取makefile的時候，是按照依賴文件的順序去查找並且執行命令的
7. make在編譯的時候，如果發現被編譯的文件已經是最新的了，就不會再去編譯(減少了編譯次數)
8. make文件是根據被編譯文件的時間戳去判斷文件是否是當前最新的文件,如果是最新的，那么就會去重新編譯，如果不是最新的，就不會去進行編譯；
9. 千萬要注意makefile中編譯命令前面的分隔符

實例

#Sample
CC := gcc
scriptName := FMindex

$(scriptName): main.o FMindex.o getRank.o BWT.o
	$(CC) -o $@ $^
	@echo DONE!

BWT.o: BWT.c bwt.h
	$(CC) -c $<

getRank.o: getRank.c getRank.h
	$(CC) -c $<

FMindex.o: FMindex.c FMindex.h
	$(CC) -c $<

main.o: main.c
	$(CC) -c $<


.PHONY: clean
clean:
	rm *.o
	rm $(scriptName)

參考文章

1. https://www.ruanyifeng.com/blog/2015/02/make.html
2. https://blog.csdn.net/qq_29924041/article/details/55224446