关注公众号不定期领红包:

加入知识星球社群:

关注微博获取实时动态:

Makefile基础

Last updated: ... / Reads: 90489 Edit

在Linux环境下,当我们输入make命令时,它就在当前目录查找一个名为Makefile的文件,然后,根据这个文件定义的规则,自动化地执行任意命令,包括编译命令。

Makefile这个单词,顾名思义,就是指如何生成文件。

我们举个例子:在当前目录下,有3个文本文件:a.txtb.txtc.txt

现在,我们要合并a.txtb.txt,生成中间文件m.txt,再用中间文件m.txtc.txt合并,生成最终的目标文件x.txt,整个逻辑如下图所示:

┌─────┐ ┌─────┐ ┌─────┐
│a.txt│ │b.txt│ │c.txt│
└─────┘ └─────┘ └─────┘
   │       │       │
   └───┬───┘       │
       │           │
       ▼           │
    ┌─────┐        │
    │m.txt│        │
    └─────┘        │
       │           │
       └─────┬─────┘
             │
             ▼
          ┌─────┐
          │x.txt│
          └─────┘

根据上述逻辑,我们来编写Makefile

规则

Makefile由若干条规则(Rule)构成,每一条规则指出一个目标文件(Target),若干依赖文件(prerequisites),以及生成目标文件的命令。

例如,要生成m.txt,依赖a.txtb.txt,规则如下:

# 目标文件: 依赖文件1 依赖文件2
m.txt: a.txt b.txt
	cat a.txt b.txt > m.txt

一条规则的格式为目标文件: 依赖文件1 依赖文件2 ...,紧接着,以Tab开头的是命令,用来生成目标文件。上述规则使用cat命令合并了a.txtb.txt,并写入到m.txt。用什么方式生成目标文件make并不关心,因为命令完全是我们自己写的,可以是编译命令,也可以是cpmv等任何命令。

#开头的是注释,会被make命令忽略。

注意:Makefile的规则中,命令必须以Tab开头,不能是空格。

类似的,我们写出生成x.txt的规则如下:

x.txt: m.txt c.txt
	cat m.txt c.txt > x.txt

由于make执行时,默认执行第一条规则,所以,我们把规则x.txt放到前面。完整的Makefile如下:

x.txt: m.txt c.txt
	cat m.txt c.txt > x.txt

m.txt: a.txt b.txt
	cat a.txt b.txt > m.txt

在当前目录创建a.txtb.txtc.txt,输入一些内容,执行make

$ make
cat a.txt b.txt > m.txt
cat m.txt c.txt > x.txt

make默认执行第一条规则,也就是创建x.txt,但是由于x.txt依赖的文件m.txt不存在(另一个依赖c.txt已存在),故需要先执行规则m.txt创建出m.txt文件,再执行规则x.txt。执行完成后,当前目录下生成了两个文件m.txtx.txt

可见,Makefile定义了一系列规则,每个规则在满足依赖文件的前提下执行命令,就能创建出一个目标文件,这就是英文Make file的意思。

把默认执行的规则放第一条,其他规则的顺序是无关紧要的,因为make执行时自动判断依赖。

此外,make会打印出执行的每一条命令,便于我们观察执行顺序以便调试。

如果我们再次运行make,输出如下:

$ make
make: `x.txt' is up to date.

make检测到x.txt已经是最新版本,无需再次执行,因为x.txt的创建时间晚于它依赖的m.txtc.txt的最后修改时间。

make使用文件的创建和修改时间来判断是否应该更新一个目标文件。

修改c.txt后,运行make,会触发x.txt的更新:

$ make
cat m.txt c.txt > x.txt

但并不会触发m.txt的更新,原因是m.txt的依赖a.txtb.txt并未更新,所以,make只会根据Makefile去执行那些必要的规则,并不会把所有规则都无脑执行一遍。

在编译大型程序时,全量编译往往需要几十分钟甚至几个小时。全量编译完成后,如果仅修改了几个文件,再全部重新编译完全没有必要,用Makefile实现增量编译就十分节省时间。

当然,是否能正确地实现增量更新,取决于我们的规则写得对不对,make本身并不会检查规则逻辑是否正确。

伪目标

因为m.txtx.txt都是自动生成的文件,所以,可以安全地删除。

删除时,我们也不希望手动删除,而是编写一个clean规则来删除它们:

clean:
	rm -f m.txt
	rm -f x.txt

clean规则与我们前面编写的规则有所不同,它没有依赖文件,因此,要执行clean,必须用命令make clean

$ make clean
rm -f m.txt
rm -f x.txt

然而,在执行clean时,我们并没有创建一个名为clean的文件,所以,因为目标文件clean不存在,每次运行make clean,都会执行这个规则的命令。

如果我们手动创建一个clean的文件,这个clean规则就不会执行了!

如果我们希望makeclean不要视为文件,可以添加一个标识:

.PHONY: clean
clean:
	rm -f m.txt
	rm -f x.txt

此时,clean就不被视为一个文件,而是伪目标(Phony Target)。

大型项目通常会提供cleaninstall这些约定俗成的伪目标名称,方便用户快速执行特定任务。

一般来说,并不需要用.PHONY标识clean等约定俗成的伪目标名称,除非有人故意搞破坏,手动创建名字叫clean的文件。

执行多条命令

一个规则可以有多条命令,例如:

cd:
	pwd
	cd ..
	pwd

执行cd规则:

$ make cd
pwd
/home/ubuntu/makefile-tutorial/v1
cd ..
pwd
/home/ubuntu/makefile-tutorial/v1

观察输出,发现cd ..命令执行后,并未改变当前目录,两次输出的pwd是一样的,这是因为make针对每条命令,都会创建一个独立的Shell环境,类似cd ..这样的命令,并不会影响当前目录。

解决办法是把多条命令以;分隔,写到一行:

cd_ok:
	pwd; cd ..; pwd;

再执行cd_ok目标就得到了预期结果:

$ make cd_ok
pwd; cd ..; pwd
/home/ubuntu/makefile-tutorial/v1
/home/ubuntu/makefile-tutorial

可以使用\把一行语句拆成多行,便于浏览:

cd_ok:
	pwd; \
	cd ..; \
	pwd

另一种执行多条命令的语法是用&&,它的好处是当某条命令失败时,后续命令不会继续执行:

cd_ok:
	cd .. && pwd

控制打印

默认情况下,make会打印出它执行的每一条命令。如果我们不想打印某一条命令,可以在命令前加上@,表示不打印命令(但是仍然会执行):

no_output:
	@echo 'not display'
	echo 'will display'

执行结果如下:

$ make no_output
not display
echo 'will display'
will display

注意命令echo 'not display'本身没有打印,但命令仍然会执行,并且执行的结果仍然正常打印。

控制错误

make在执行命令时,会检查每一条命令的返回值,如果返回错误(非0值),就会中断执行。

例如,不使用-f删除一个不存在的文件会报错:

has_error:
	rm zzz.txt
	echo 'ok'

执行上述目标,输出如下:

$ make has_error
rm zzz.txt
rm: zzz.txt: No such file or directory
make: *** [has_error] Error 1

由于命令rm zzz.txt报错,导致后面的命令echo 'ok'并不会执行,make打印出错误,然后退出。

有些时候,我们想忽略错误,继续执行后续命令,可以在需要忽略错误的命令前加上-

ignore_error:
	-rm zzz.txt
	echo 'ok'

执行上述目标,输出如下:

$ make ignore_error
rm zzz.txt
rm: zzz.txt: No such file or directory
make: [ignore_error] Error 1 (ignored)
echo 'ok'
ok

make检测到rm zzz.txt报错,并打印错误,但显示(ignored),然后继续执行后续命令。

对于执行可能出错,但不影响逻辑的命令,可以用-忽略。

参考源码

可以从GitHub下载源码。

GitHub

小结

编写Makefile就是编写一系列规则,用来告诉make如何执行这些规则,最终生成我们期望的目标文件。

查看官方手册:


Comments

Make a comment