Makefile基础

Makefile基础

---

先上一个有多个源文件和头文件的C语言的代码程序：

/* main.c */
#include <stdio.h>
#include "main.h"
#include "stack.h"
#include "maze.h"

struct point predecessor[MAX_ROW][MAX_COL] = {
	{{-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}},
	{{-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}},
	{{-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}},
	{{-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}},
	{{-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}, {-1,-1}},
};

void visit(int row, int col, struct point pre)
{
	struct point visit_point = { row, col };
	maze[row][col] = 2;
	predecessor[row][col] = pre;
	push(visit_point);
}

int main(void)
{
	struct point p = { 0, 0 };

	maze[p.row][p.col] = 2;
	push(p);	
	
	while (!is_empty()) 
	{
		p = pop();
		if (p.row == MAX_ROW - 1  /* goal */
		    && p.col == MAX_COL - 1)
			break;
		if (p.col+1 < MAX_COL     /* right */
		    && maze[p.row][p.col+1] == 0)
			visit(p.row, p.col+1, p);
		if (p.row+1 < MAX_ROW     /* down */
		    && maze[p.row+1][p.col] == 0)
			visit(p.row+1, p.col, p);
		if (p.col-1 >= 0          /* left */
		    && maze[p.row][p.col-1] == 0)
			visit(p.row, p.col-1, p);
		if (p.row-1 >= 0          /* up */
		    && maze[p.row-1][p.col] == 0)
			visit(p.row-1, p.col, p);
		print_maze();
	}
	if (p.row == MAX_ROW - 1 && p.col == MAX_COL - 1) 
	{
		printf("(%d, %d)
", p.row, p.col);
		while (predecessor[p.row][p.col].row != -1) 
		{
			p = predecessor[p.row][p.col];
			printf("(%d, %d)
", p.row, p.col);
		}
	} else
		printf("No path!
");

	return 0;
}

堆栈和迷宫的代码分别转移到模块stack.c和maze.c中，main.c包含它们提供的头文件stack.h和maze.h

/* main.h */
#ifndef MAIN_H
#define MAIN_H

typedef struct point { int row, col; } item_t;

#define MAX_ROW 5
#define MAX_COL 5

#endif

在main.h中定义了一个类型和两个常量，main.c、stack.c和maze.c都要用到这些定义，都要包含这个头文件。下面是栈功能模块：

/* stack.c */
#include "stack.h"
 
static item_t stack[512];
static int top = 0;
 
void push(item_t p)
{
    stack[top++] = p;
}
 
item_t pop(void)
{
    return stack[--top];
}
 
int is_empty(void)
{
    return top == 0;
}
 
/* stack.h */
#ifndef STACK_H
#define STACK_H
 
#include "main.h" /* provides definition for item_t */
 
extern void push(item_t);
extern item_t pop(void);
extern int is_empty(void);
 
#endif

下面是迷宫功能模块：

/* maze.c */
#include <stdio.h>
#include "maze.h"

int maze[MAX_ROW][MAX_COL] = {
	0, 1, 0, 0, 0,
	0, 1, 0, 1, 0,
	0, 0, 0, 0, 0,
	0, 1, 1, 1, 0,
	0, 0, 0, 1, 0,
};

void print_maze(void)
{
	int i, j;
	for (i = 0; i < MAX_ROW; i++) {
		for (j = 0; j < MAX_COL; j++)
			printf("%d ", maze[i][j]);
		putchar('
');
	}
	printf("*********
");
}

/* maze.h */
#ifndef MAZE_H
#define MAZE_H

#include "main.h" /* provides defintion for MAX_ROW and MAX_COL */

extern int maze[MAX_ROW][MAX_COL];
void print_maze(void);

#endif

这些源文件可以这样编译：

$ gcc -Wall -o main main.c stack.c maze.c 

但这不是个好办法，如果编译之后又对maze.c做了修改，又要把所有源文件编译一遍，即使main.c、stack.c和那些头文件都没有修改也要跟着重新编译。一个大型的软件项目往往由上千个源文件组成，全部编译一遍需要几个小时，只改一个源文件就要求全部重新编译肯定是不合理的。

这样编译也许更好一些：

$ gcc -c main.c
$ gcc -c stack.c
$ gcc -c maze.c
$ gcc -o main main.o stack.o maze.o

如果编译之后又对maze.c做了修改，要重新编译只需要做两步：

$ gcc -c maze.c
$ gcc -o main main.o stack.o maze.o

但是这样，很容易出错，比如我修改了三个源文件，可能有一个忘了重新编译，结果编译完后运行代码，则忘记编译的那个源文件的修改没生效，运行时出了Bug还满世界找原因呢。更复杂的问题是，假如我改了main.h怎么办？所有包含main.h的源文件都需要重新编译，我得挨个找哪些源文件包含了main.h，有的还很不明显，例如stack.c包含了stack.h，而后者包含了main.h。可见手动处理这些问题非常容易出错，那有没有自动的解决办法呢？有，就是写一个Makefile文件和源代码放在同一个目录下：

main: main.o stack.o maze.o
	gcc main.o stack.o maze.o -o main

main.o: main.c main.h stack.h maze.h
	gcc -c main.c

stack.o: stack.c stack.h main.h
	gcc -c stack.c

maze.o: maze.c maze.h main.h
	gcc -c maze.c

然后在这个目录下运行make编译：

$ make
gcc -c main.c
gcc -c stack.c
gcc -c maze.c
gcc main.o stack.o maze.o -o main

make命令会自动读取当前目录下的Makefile文件，完成相应的编译步骤。Makefile由一组规则（Rule）组成，每条规则的格式是：

target ... : prerequisites ... 
	command1
	command2
	...

例如：

main: main.o stack.o maze.o
	gcc main.o stack.o maze.o -o main

main是这条规则的目标（Target），main.o、stack.o和maze.o是这条规则的条件（Prerequisite）。目标和条件之间的关系是：欲更新目标，必须首先更新它的所有条件；所有条件中只要有一个条件被更新了，目标也必须随之被更新。所谓“更新”就是执行一遍规则中的命令列表。命令列表中的每条命令必须以一个Tab开头，注意不能是空格，Makefile的格式不像C语言的缩进那么随意，对于Makefile中的每个以Tab开头的命令，make会创建一个Shell进程去执行命令列表。

对于上面这个例子，make执行如下步骤：

1. 尝试更新Makefile中第一条规则的目标main，第一条规则的目标称为缺省目标，只要缺省目标更新了就算完成任务了，其它工作都是为这个目的而做的。由于我们是第一次编译，main文件还没生成，显然需要更新，但规则说必须先更新了main.o、stack.o和maze.o这三个条件，然后才能更新main。

2. 所以make会进一步查找以这三个条件为目标的规则，这些目标文件也没有生成，也需要更新，所以执行相应的命令（gcc -c main.c、gcc -c stack.c和gcc -c maze.c）更新它们。

3. 最后执行gcc main.o stack.o maze.o -o main更新main。

如果没有做任何改动，再次运行make：

$ make
make: `main' is up to date.

make会提示缺省目标已经是最新的了，不需要执行任何命令更新它。

---

再做个实验，如果修改了maze.h（比如加个无关痛痒的空格）再运行make：

$ make
gcc -c main.c
gcc -c maze.c
gcc main.o stack.o maze.o -o main

make会自动选择那些受影响的源文件重新编译，不受影响的源文件则不重新编译，这是怎么做到的呢？

1. make仍然尝试更新缺省目标，首先检查目标main是否需要更新，这就要检查三个条件main.o、stack.o和maze.o是否需要更新。

2. make会进一步查找以这三个条件为目标的规则，然后发现main.o和maze.o需要更新，因为它们都有一个条件是maze.h，而这个文件的修改时间比main.o和maze.o晚，所以执行相应的命令更新main.o和maze.o。

3. 既然main的三个条件中有两个被更新过了，那么main也需要更新，所以执行命令gcc main.o stack.o maze.o -o main更新main。

注意：这种更新的检查都要递归到源码文件或者头文件。

---

通常Makefile都会有一个clean规则，用于清除编译过程中产生的二进制文件，保留源文件：

clean:
	@echo "cleanning project"
	-rm main *.o
	@echo "clean completed"

把这条规则添加到我们的Makefile末尾，然后执行这条规则：

$ make clean 
cleanning project
rm main *.o
clean completed

如果在make的命令行中指定一个目标（例如clean），则更新这个目标，如果不指定目标则更新Makefile中第一条规则的目标（缺省目标）。

和前面介绍的规则不同，clean目标不依赖于任何条件，并且执行它的命令列表不会生成clean这个文件，刚才说过，只要执行了命令列表就算更新了目标，即使目标并没有生成也算。

在这个例子还演示了命令前面加@和-字符的效果：

如果make执行的命令前面加了@字符，则不显示命令本身而只显示它的结果；

通常make执行的命令如果出错（该命令的退出状态非0）就立刻终止，不再执行后续命令，但如果命令前面加了-号，即使这条命令出错，make也会继续执行后续命令。通常rm命令和mkdir命令前面要加-号，因为rm要删除的文件可能不存在，mkdir要创建的目录可能已存在，这两个命令都有可能出错，但这种错误是应该忽略的。例如上面已经执行过一遍make clean，再执行一遍就没有文件可删了，这时rm会报错，但make忽略这一错误，继续执行后面的echo命令：

$ make clean 
cleanning project
rm main *.o
rm: cannot remove `main': No such file or directory
rm: cannot remove `*.o': No such file or directory
make: [clean] Error 1 (ignored)
clean completed

读者可以把命令前面的@和-去掉再试试，对比一下结果有何不同。

---

这里还有一个问题，如果当前目录下存在一个文件叫clean会怎么样呢：

$ touch clean
$ make clean
make: `clean' is up to date.

如果存在clean这个文件，clean目标又不依赖于任何条件，make就认为它不需要更新了。而我们希望把clean当作一个特殊的名字使用，不管它存在不存在都要更新，可以添一条特殊规则，把clean声明为一个伪目标：

.PHONY: clean

这条规则没有命令列表。类似.PHONY这种make内建的特殊目标还有很多，各有不同的用途。在C语言中要求变量和函数先声明后使用，而Makefile不太一样，这条规则写在clean:规则的后面也行，也能起到声明clean是伪目标的作用：

clean:
	@echo "cleanning project"
	-rm main *.o
	@echo "clean completed"

.PHONY: clean

make处理Makefile的过程，gcc处理一个C程序分为预处理和编译两个阶段，类似地，make处理Makefile的过程也分为两个阶段：

(1) 首先从前到后读取所有规则，建立起一个完整的依赖关系图，例如：

 

(2) 然后从缺省目标或者命令行指定的目标开始，根据依赖关系图选择适当的规则执行，执行Makefile中的规则和执行C代码不一样，并不是从前到后按顺序执行，也不是所有规则都要执行一遍，例如make缺省目标时不会更新clean目标，因为从上图可以看出，它跟缺省目标没有任何依赖关系。

clean目标是一个约定俗成的名字，在所有软件项目的Makefile中都表示清除编译生成的文件，类似这样的约定俗成的目标名字有：

all，执行主要的编译工作，通常用作缺省目标。

install，执行编译后的安装工作，把可执行文件、配置文件、文档等分别拷到不同的安装目录。

clean，删除编译生成的二进制文件。

distclean，不仅删除编译生成的二进制文件，也删除其它生成的文件，例如配置文件和格式转换后的文档，执行make distclean之后应该清除所有这些文件，只留下源文件。

关于文件命名的一个规定：

只要符合本章所描述的语法的文件我们都叫它Makefile，而它的文件名则不一定是Makefile。事实上，执行make命令时，是按照GNUmakefile、makefile、Makefile的顺序找到第一个存在的文件并执行它，不过还是建议使用Makefile做文件名。除了GNU make，有些UNIX系统的make命令不是GNU make，不会查找GNUmakefile这个文件名，如果你写的Makefile包含GNUmake的特殊语法，可以起名为GNUmakefile，否则不建议用这个文件名。

隐含规则

---

上一节的Makefile写得中规中矩，比较繁琐，是为了讲清楚基本概念，其实Makefile有很多灵活的写法，可以写得更简洁，同时减少出错的可能。本节我们来看看这样一个例子还有哪些改进的余地。

一个目标依赖的所有条件不一定非得写在一条规则中，也可以拆开写。

main.o: main.h stack.h maze.h

main.o: main.c
	gcc -c main.c

相当于：

main.o: main.c main.h stack.h maze.h
	gcc -c main.c

如果一个目标拆开写多条规则，其中只有一条规则允许有命令列表，其它规则应该没有命令列表，否则make会报警告并且采用最后一条规则的命令列表。

这样我们的例子可以改写成：

main: main.o stack.o maze.o
	gcc main.o stack.o maze.o -o main

main.o: main.h stack.h maze.h
stack.o: stack.h main.h
maze.o: maze.h main.h

main.o: main.c
	gcc -c main.c

stack.o: stack.c
	gcc -c stack.c

maze.o: maze.c
	gcc -c maze.c

clean:
	-rm main *.o

.PHONY: clean

这不是比原来更繁琐了吗？现在可以把提出来的三条规则删去，写成：

main: main.o stack.o maze.o
	gcc main.o stack.o maze.o -o main

main.o: main.h stack.h maze.h
stack.o: stack.h main.h
maze.o: maze.h main.h

clean:
	-rm main *.o

.PHONY: clean

这就比原来简单多了。可是现在main.o、stack.o和maze.o这三个目标连编译命令都没有了，怎么编译的呢？试试看：

$ make
cc    -c -o main.o main.c
cc    -c -o stack.o stack.c
cc    -c -o maze.o maze.c
gcc main.o stack.o maze.o -o main

make命令的模式规则

---

现在解释一下前三条编译命令是怎么来。如果一个目标在Makefile中的所有规则都没有命令列表，make会尝试在内建的隐含规则（Implicit Rule）数据库中查找适用的规则。make的隐含规则数据库可以用make -p命令打印，打印出来的格式也是Makefile的格式，包括很多变量和规则，其中和我们这个例子有关的隐含规则有：

# default
OUTPUT_OPTION = -o $@

# default
CC = cc

# default
COMPILE.c = $(CC) $(CFLAGS) $(CPPFLAGS) $(TARGET_ARCH) -c

%.o: %.c
#  commands to execute (built-in):
        $(COMPILE.c) $(OUTPUT_OPTION) $<

对上面的default设置做一个解释：

(1) CC是一个Makefile变量，用CC = cc定义和赋值，用$(CC)取它的值，其值应该是cc。Makefile变量像C的宏定义一样，代表一串字符，在取值的地方展开。cc是一个符号链接，通常指向gcc，在有些UNIX系统上可能指向另外一种C编译器。

$ which cc
/usr/bin/cc
$ ls -l /usr/bin/cc
lrwxrwxrwx 1 root root 20 2008-07-04 05:59 /usr/bin/cc -> /etc/alternatives/cc
$ ls -l /etc/alternatives/cc
lrwxrwxrwx 1 root root 12 2008-11-01 09:10 /etc/alternatives/cc -> /usr/bin/gcc

(2) 前面的三个都是make的变量，类似C语言的宏定义，CFLAGS这个变量没有定义，$(CFLAGS)展开是空，CPPFLAGS和TARGET_ARCH也是如此。这样$(COMPILE.c)展开应该是cc 空 空 空 -c，去掉所有的“空”得到cc␣␣␣␣-c，注意中间留下4个空格。%.o: %.c是一种特殊的规则，称为模式规则（Pattern Rule），用于匹配没有命令列表的规则。所以%.o: %.c规则的命令列表$(COMPILE.c)␣$(OUTPUT_OPTION)␣$<展开之后是cc␣␣␣␣-c␣-o␣$@␣$<，和上面的编译命令已经很接近了。$@和$<是两个特殊的变量，$@的取值为规则中的目标，$<的取值为规则中的第一个条件。

现在回顾一下整个过程，在我们的Makefile中以main.o为目标的规则都没有命令列表，所以make会查找隐含规则，发现隐含规则中有这样一条模式规则适用，main.o符合%.o的模式，现在%就代表main（称为main.o这个名字的Stem），再替换到%.c中就是main.c。所以这条模式规则匹配完之后，相当于：

main.o: main.c
	cc    -c -o main.o main.c