GNU Make (Makefile)是经常被用于程序源代码项目中,帮助用户编译源代码的建置工具。在 Makefile 中,可以分别替不同的源代码文件定义其编译的方式(编译所使用的指令),GNU Make 在编译源代码项目时,就会依照源代码是否有在产生目的文件后又被修改(依赖文档的修改日期比目的文件的修改日期来得晚),来自动判断是否真的需要再重新编译源代码,以省下重复编译的时间。
GNU Make 通常会搭配 C/C++ 语言的程序项目来使用,不过就算不是 C/C++ 语言的程序项目也还是可以使用 GNU Make。这篇文章将会介绍 Makefile 的基本用法。
安装 GNU Make
Linux 发行版通常会内置 GNU Make。如果没有的话,Debian 或是其衍生的 Linux 发行版可以用以下指令来安装:
红帽系的 Linux 发行版可以用以下指令来安装:
Makefile
Makefile 是 GNU Make 工具的脚本文件,里面描述了程序源代码项目中的源代码文件应该要如何被编译。在终端机运行 make 指令时,GNU Make 就会依照以下顺序来在目前的工作目录中寻找可用的 Makefile 文件来运行:
GNUmakefilemakefileMakefile
例如 GNU Make 找到了 GNUmakefile 文件,那么即便 makefile 和 Makefile 文件也有存在,GNU Make 也不会再去管那两个文件究竟写了什么。若没有特殊需求的话,会比较常用 Makefile 这个名称。
标准的 Makefile 结构如下:
all:
# Command 1
# Command 2
# ...
clean:
# Command 1
# Command 2
# ...
install:
# Command 1
# Command 2
# ...
# uninstall:
# Command 1
# Command 2
# ...
一行中井字号 # 后的字会被视为注解。以上,all、clean、install、uninstall 是具有特殊意义的目标(target),意义如下:
all:意思为「全部编译」,通常会是 Makefile 的第一个规则所用的目标。clean:用来清除编译时产生的所有文件。install:用来安装全部已经被编译好的程序。uninstall:这个目标相对少见一点,用来移除已经被安装好的程序。
一个目标所形成的结构称为一个规则(rule),规则的格式如下:
目标文档: [依赖文档]
指令1
指令2
...
目标文档 要填写文件名称或路径,也就是编译程序之后会产生的文件,如果有多个的话,要以空白字符 隔开。依赖文档 要填写文件名称或路径,也就是要编译出目标文档所需要的源代码文件,可不填写,如果有多个的话,要以空白字符 隔开。如果文件名称或路径中有空白字符的话,要以反斜线 \ 来跳脱。如果 依赖文档 所填写的名称或路径正好是其它规则的 目标文档 的话,GNU make 就会先去运行其它的规则。
同一规则中,指令和指令运行的顺序是从上到下,如果前一个指令运行不成功(回传的 Exit Status 不为 0 的话),就不会再继续运行之后的指令。这边还有个特别要注意的地方是,Makefile 规则中的指令缩进是必要的,而且只能够使用 TAB 字符 作为行首。
举个例子,使用 javac 指令来编译 Hello.java 这个文件,编译成功后会产生 Hello.class。所以 Makefile 的规则应该要这样写:
Hello.class: Hello.java
javac Hello.java
与刚才提到的「具有特殊意义的目标」搭配使用的话,完整的 Makefile 就变成:
all: Hello.class
Hello.class: Hello.java
javac Hello.java
clean:
rm -f *.class
install:
# Command 1
# Command 2
# ...
# uninstall:
# Command 1
# Command 2
# ...
也可以扩展一下,加入测试、安装和卸载的脚本:
all: Hello.jar
Hello.jar: Hello.class manifest.mf
jar cfm Hello.jar manifest.mf Hello.class
Hello.class: Hello.java
javac Hello.java
manifest.mf:
echo "Main-Class: Hello" > manifest.mf
clean:
rm -f *.class *.jar manifest.mf
test:
java -jar Hello.jar
install: test
cp Hello.jar ~/Hello.jar
uninstall:
rm -f ~/Hello.jar
make 指令
指定目标
make 指令可以用来运行 Makefile,在什么参数都不加的时候,make 只会去运行 Makefile 中的第一个规则。如果要指定要运行哪个规则的话,可在 make 指令的第一个参数加上已经定义在 Makefile 中的目标文档名称,例如 make all、make install 或是 make Hello.class。这也是为什么 all 这个目标通常会被放在第一个规则的原因,因为这样运行 make 就等于是运行 make all。
下图是用 make 指令运行上面 Makefile 范例的演示:
平行编译
由于 Makefile 把源代码的相依性和编译方式都分别定义好了,因此还可以简单实现出「平行编译」,运用更多的硬件资源来加快编译速度。若要激活 GNU make 的平行编译功能,可以在运行 make 指令时加上 -j 参数,-j 后可以接一个数值,表示要同时进行的最大工作数量(不接数值的话就不限制工作数量)。至于 -j 的值究竟要多大才会是最快的并没有一定,通常会把这个值的范围控制在处理器(逻辑处理内核)数量的一倍到三倍之间。可以搭配 nproc 指令取得的处理器(逻辑处理内核)数量来串接出 make 指令。
例如:
稍微高级一点的 Makefile 写法
隐藏指令
预设写在 Makefile 的指令在使用 make 指令来运行的时候都会被显示出来,如果要隐藏的话,可以在该指令前加上小老鼠 @。
例如:
Hello.class: Hello.java
@javac Hello.java
略过运行失败的指令
先前有提到,在相同规则下,只要有某个指令运行失败,其接下来的指令就不会被运行。如果这个指令本身是允许失败的话,想要在其失败后继续运行之后的指令,可以在该指令前加上减号 -。
例如:
Hello.class: Hello.java
-rm Hello.class
javac Hello.java
相依文档太多,难以一一枚举
撰写 Makefile 时常会遇到相依文件太多,不太能够一一枚举在规则内的情况,此时我们可以借助 find 和 sed 这两个外部指令的力量,来作为 依赖文档 的值。
例如:
all: class manifest.mf $(shell find . -maxdepth 1 -type f -iname '*.class' | sed 's/ /\\ /g')
jar cfm Hello.jar manifest.mf *.class
class: $(shell find . -maxdepth 1 -type f -iname '*.java' | sed 's/ /\\ /g')
javac *.java
以上 -maxdepth 1 参数可以限制 find 指令不去搜索子目录。如果要同时判断很多文件名,可以使用 -o 参数来连接多个 -iname 或是 -name 参数,前者不会判断英文大小写,后者才会判断。
通配符 %
在目标和依赖文档的路径中,可以使用 % 来表示任意的字符串(至少要有一个字符)。例如以下的「静态型样规则」(static pattern rule):
install: target/a.txt target/b.txt
target/a.txt target/b.txt: target/%: data/%
cp $< $@
静态型样规则在 目标文档 之后还有两个以冒号 : 隔开的字段,格式如下:
目标文档: 目标型样: 依赖型样
指令1
指令2
...
目标型样 中的 % 所匹配到的字符串,会被代入 依赖型样 的 %。所以以上的 target/a.txt 会依赖 data/a.txt,target/b.txt 会依赖 data/b.txt,运行 make install 时就会把这两个文件从 data 目录拷贝到 target 目录。要注意的是,目标文档 中的每个文件都必须符合 目标型样,否则 GNU make 会显示「doesn't match the target pattern」的消息,规则也无法如预期运作。
变量与环境变量
在 Makefile 中的变量声明及指派方式有三种。
= (recursively expanded variable)
此为基本的变量指派方式,例如值为 $(CC) -std=c90,其中的 $(CC) 会在该变量名称被使用到时,才会被取代为当下 CC 变量所保存的值。如果被用到很多次,就要重复进行解开变量的动作。
:= (simply expanded variable)
如果值里面有用到其它变量的话,例如值为 $(CC) -std=c90,其中的 $(CC) 会先被取代为实际 CC 变量所保存的值后,再给指定的变量名称来保存。对比 = 这种指派方式,:= 是比较直觉且安全的作法,性能也会好一点点。
?= (conditional variable)
如果该变量名称尚未被定义,新值才会被指派。
在读取 Makefile 所定义的变量或是外部的环境变量时,都可以使用以下的语法:
Makefile 中的 目标文档 和 依赖文档 字段,或是指令中都可以直接使用以上的语法来读取变量。
但如果想要在指令中使用环境变量,却不想要透过 GNU make 来事先读取的话,可以使用以下的语法:
其实两个钱字号 $$ 在 Makefile 中所代表的意义就是跳脱成一个钱字号 $ 啦!
规则内的特殊变量
以下面这个规则来举例:
a.o: library.cpp main.cpp
...
$@:等同于a.o。$<:等同于library.cpp。$^:等同于library.cpp main.cpp。
特殊意义的目标名称与文档撞名的处理方式──.PHONY
由于 Makefile 的规则主要是以判断文档的修改日期来决定是否要运行指令的关系,当我们将 目标文档 字段直接填写具有特殊意义的目标名称(如 clean、install)时,就并不是期望这个规则的指令在运行之后可以产生出与该目标名称相同的文件。
因此,原则上我们会需要确保与该目标名称相同的文件不存在,才能让这些特殊的规则可以顺利地被 GNU make 来运行。否则,如果我们在使用 make clean 时,却因为有「clean」这个文件的存在而导致 make clean 只会提示 make: 'clean' is up to date.,而没有任何的清除功能,那岂不是很可笑?
然而,若是撞名的情况真的无法避免,还是有个解决方案,那就是利用 .PHONY 这个 目标文档,将要忽略检查文件是否修改的 目标文档 枚举出来。实际上,.PHONY 本身并不是一个文件,它也是一个特殊意义的目标名称,其规则写法如下:
.PHONY: 要忽略检查的目标文档
例如:
.PHONY: clean install
有了以上设置,即便「.PHONY」、「clean」和「install」文件存在于工作目录中,make clean 和 make install 指令也还是可以正常使用。

