第一部分 Makefile介绍

前言

  什么是 Makefile？或许许多 Windows 程序员都不知道这个东西，因为那些 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 进行讲述，我的环境是 Ubuntu1604（Linux众多发行版本中的一种，2016年发布），make 的版本是 GNU Make 4.1。毕竟，这个 make 是应用最为广泛的，例如 Ubuntu1804 的默认make版本也是 GNU Make 4.1。而且还是遵循于 IEEE 1003.2-1992 标准的（POSIX.2）。
  在这篇文档中，将以 C/C++ 的源码作为我们的基础，所以必然涉及一些关于 C/C++ 的编译知识，相关于这方面的内容，还请各位查看相关的编译器的文档。这里默认的编译器是 gcc v5.4.0。

关于程序的编译和链接
  在此，我想多说两句关于程序编译的一些规范和方法。一般来说，无论是 C、C++ 还是 Pascal，首先要源文件编译成中间代码文件，在 Windows 下也就是 .obj 文件，Unix 下是 .o 文件，即 Object File，这个动作叫做编译（compile）。然后再把大量的 Object File 合成可执行文件，这个动作叫做链接（link）。编译时，编译器要做的是检查语法的正确性、函数与变量的声明的正确性。对于后者，通常你需要告诉编译器头文件的位置（头文件中应该只是声明，而定义应该放在 C/C++ 文件中），只要所有语法正确，编译器就可以编译出中间目标文件。一般来说，每个源文件都应该对应于一个中间目标文件（ .o 文件或是 .obj 文件）。链接时，主要是链接函数和全局变量，所以，我们可以使用这些中间目标文件（ .o 文件或是 .obj 文件）来链接出我们的应用程序。链接器并不管函数所在的源文件，只管函数的中间目标文件（Object File），大多数时候，由于源文件太多，编译生成的中间目标文件太多，而在链接时需要明显地指出中间目标文件名，这对于编译很不方便，所以，我们要给中间目标文件打个包，在 Windows 下这种包叫“库文件”（Library File），也就是 .lib 文件，在 Unix 下是静态库Archive，也就是 .a 文件（相对的概念为.so，Shared Object动态库）。
  总结一下，源文件首先会生成中间目标文件，再由中间目标文件生成可执行文件。在编译时，编译器只检测程序语法，和函数、变量是否被声明。如果函数未被声明，编译器会给出一个警告，但可以生成 Object File。而在链接程序时，链接器会在所有的 Object File 中找寻函数的实现，如果找不到，那就会报链接错误码（Linker Error），在 VC 下，这种错误一般是：Link 2001 错误，意思是说，链接器未能找到函数的实现。你需要指定函数的 Object File。
  好，言归正传，GUN 的 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 的基本结构。简单来说，Makefile 由一项项用来编译应用程序的的规则组成。make所看到的第一项规则，会被作为默认规则（default）使用。一项规则可以分成三个部分：

• 工作目标 （target），可以是 Object File，也可以是可执行文件，还可以是一个标签（Label），对于标签这种特性，在后续的“伪目标”章节中会有叙述。
• 生成工作目标的必要条件 （prerequisite），要生成那个target所需要的文件或是目标。
• 生成工作目标所要执行的命令 （command），真正起作用的命令。

target : prerequisites1 prerequisites2
	command1
	command2
	command3

  一项规则其实就是指文件间的依赖关系，例如，target 这一个或多个的目标文件依赖于 prerequisites 中的文件，而如何使用 prerequisites （以生成 target） 的具体方式则定义于 command 中。那么 command 中的命令何时执行呢？答：prerequisites 中如果存在文件比 target 中的文件新，command 所定义的命令就会被执行，这便是 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
	gcc -o edit main.o kbd.o command.o display.o \
	      insert.o search.o files.o utils.o
main.o : main.c defs.h
	gcc -c main.c
kbd.o : kbd.c defs.h command.h
	gcc -c kbd.c
command.o : command.c defs.h command.h
	gcc -c command.c
display.o : display.c defs.h buffer.h
	gcc -c display.c
insert.o : insert.c defs.h buffer.h
	gcc -c insert.c
search.o : search.c defs.h buffer.h
	gcc -c search.c
files.o : files.c defs.h buffer.h command.h
	gcc -c files.c
utils.o : utils.c defs.h
	gcc -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 会比较 工作目标和必要条件的修改日期，如果必要条件的日期比工作目标的日期新，或者工作目标不存在的话，那么 make 就会执行后续定义的命令。
  这里要说明的一点是，clean 不是一个文件，它只不过是一个动作的名字，有点像 c 语言中的 label 一样，其冒号后什么也没有，那么 make 就不会自动去找文件的依赖性，也就不会自动执行其后所定义的命令。要执行其后的命令，就要在 make 命令后显式地指出这个 label 的名字。这样的方法非常有用，我们可以在一个 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 也会被重新链接了。
  而如果我们改变了“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
	gcc -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语言中的宏可能会更好。
  比如，我们声明一个变量，叫 object，OBJECT，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)
	gcc -o edit $(objects)
main.o : main.c defs.h
	gcc -c main.c
kbd.o : kbd.c defs.h command.h
	gcc -c kbd.c
command.o : command.c defs.h command.h
	gcc -c command.c
display.o : display.c defs.h buffer.h
	gcc -c display.c
insert.o : insert.c defs.h buffer.h
	gcc -c insert.c
search.o : search.c defs.h buffer.h
	gcc -c search.c
files.o : files.c defs.h buffer.h command.h
	gcc -c files.c
utils.o : utils.c defs.h
	gcc -c utils.c

clean :
	rm edit $(objects)      

于是如果有新的 .o 文件加入，我们只需要简单地修改一下 objects 变量就可以了。关于变量更多的话题，我会在后续给你一一道来。

五、让 make 自动推导

  GNU make 很强大，它可以自动推导文件以及文件依赖关系后面的命令，于是我们就没必要在每一个 [.o] 文件后面都写上类似的命令，因为我们的 make 会自动识别，并自己推导命令。
  只要 make 看到一个 [.o] 文件，它就会自动地把 [.c] 文件加在依赖关系中，如果 make 找到一个 whatever.o, 那么 whatever.c 就会是 whatever.o 的依赖文件。并且命令gcc -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 main.o $(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 main.o $(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 的相关细节，准备好了吗？准备好了就来。