GNU make学习

一　GNU Make介绍

1. Makefile

Ｍakefile文件是描述make命令工作内容的文件

就是说Makefile会告诉make需要做什么怎么做，文件与文件之间的依赖关系，可以说Makefile是make命令在编译对应模块时的配置文件

一个简单的 Makefile 描述规则组成:

TARGET...:PREREQUISITES...

COMMOND

...

...

target:规则的目标,通常是最后需要生成的文件名或者为了实现这个目的而必需的中间过程文件名。

可以是.o文件、也可以是最后的可执行程序的文件名等。另外,目标也可以是一个make执行的动作的名称,如目标“clean”,我们称这样的目标是“伪目标”.

prerequisites:规则的依赖。生成规则目标所需要的文件名列表。通常一个目标依赖于一个或者多个文件。

command:规则的命令行。是规则所要执行的动作(任意的 shell 命令或者是可在shell 下执行的程序)。它限定了 make 执行这条规则时所需要的动作。

一个规则可以有多个命令行,每一条命令占一行。

注意:每一个命令行必须以[Tab]字符开始,[Tab]字符告诉 make 此行是一个命令行。

make 按照命令完成相应的动作。这也是书写 Makefile 中容易产生,而且比较隐蔽的错误。

命令就是在任何一个目标的依赖文件发生变化后重建目标的动作描述。

一个目标可

以没有依赖而只有动作(指定的命令)。

比如 Makefile 中的目标“clean”,此目标没有依赖,只有命令。它所定义的命令用来删除 make 过程产生的中间文件(进行清理工作)。

在 Makefile 中“规则”就是描述在什么情况下、如何重建规则的目标文件,通常规则中包括了目标的依赖关系(目标的依赖文件)和重建目标的命令。

make 执行重建目标的命令,来创建或者重建规则的目标(此目标文件也可以是触发这个规则的上一个规则中的依赖文件) 规则包含了文件之间的依赖关系和更新此规则目标所需要的命令。

下面是一个简单的例子：

#sample Makefile
edit : main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o
	cc -o edit main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o


main.o : main.c defs.h
	cc -c main.c
kbd.o : kbd.c defs.h command.h
	cc -c kbd.c
command.o : command.c defs.h command.h
	cc -c command.c
display.o : display.c defs.h buffer.h
	cc -c display.c
insert.o : insert.c defs.h buffer.h
	cc -c insert.c
search.o : search.c defs.h buffer.h
	cc -c search.c
files.o : files.c defs.h buffer.h command.h
	cc -c files.c
utils.o : utils.c defs.h
	cc -c utils.c


clean :
	rm edit main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o

首先书写时,可以将一个较长行使用反斜线(\)来分解为多行,这样可以使我们的Makefile书写清晰、容易阅读理解。

但需要注意:反斜线之后不能有空格(这也是大家最容易犯的错误,错误比较隐蔽)。

在描述依赖关系行之下通常就是规则的命令行(存在一些些规则没有命令行),命令行定义了规则的动作(如何根据依赖文件来更新目标文件)。

命令行必需以[Tab]键开始,以和Makefile其他行区别。就是说所有的命令行必需以[Tab] 字符开始,但并不是所有的以[Tab]键出现行都是命令行。但make程序会把出现在第一条规则之后的所有以[Tab]字符开始的行都作为命令行来处理。

(记住:make程序本身并不关心命令是如何工作的,对目标文件的更新需要你在规则描述中提供正确的命令。“make”程序所做的就是当目标程序需要更新时执行规则所定义的命令)。

Makefile中把那些没有任何依赖只有执行动作的目标称为“伪目标”(phony targets) 

2. make 如何工作

默认的情况下,make执行的是Makefile中的第一个规则,此规则的第一个目标称之为“最终目的”或者“终极目标”

上例中，目标edit是第一个目标，所以它是make的终极目标，当修改了任何c文件或头文件时，执行make会重建edit目标

当在 shell 提示符下输入“make”命令以后。make 读取当前目录下的 Makefile 文件,并将 Makefile 文件中的第一个目标作为其执行的“终极目标”,开始处理第一个规则(终极目标所在的规则)

在上例中，第一个规则就是目标“edit”所在的规则。规则描述了“edit”的依赖关系,并定义了链接.o 文件生成目标“edit”的命令; 

make在执行这个规则所定义的命令之前,首先处理目标“edit”的所有的依赖文件(例子中的那些.o 文件)的更新规则(以这些.o 文件为目标的规则)。

对这些.o 文件为目标的规则处理有下列三种情况:

1. 目标.o 文件不存在,使用其描述规则创建它;

2. 目标.o 文件存在,目标.o 文件所依赖的.c 源文件、 文件中的任何一个比目标.o.h文件“更新”(在上一次 make 之后被修改)。则根据规则重新编译生成它;

3. 目标.o 文件存在,目标.o 文件比它的任何一个依赖文件(的.c 源文件、.h 文件)“更新”(它的依赖文件在上一次 make 之后没有被修改),则什么也不做。

3. 指定变量

同样是上边的例子,我们来看一下终极目标“edit”所在的规则:

edit : main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o
	cc -o edit main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o

在这个规则中.o 文件列表出现了两次;第一次:作为目标“edit”的依赖文件列表出现,第二次:规则命令行中作为“cc”的参数列表。

这样做所带来的问题是:如果我们需要为目标“edit”增加一个的依赖文件,我们就需要在两个地方添加

添加时可能在“edit”的依赖列表中加入了、但却忘记了给命令行中添加,或者相反。这就给后期的维护和修改带来了很多不方便,添加或修改时出现遗漏。

为了避免这个问题,在实际工作中大家都比较认同的方法是,使用一个变量“objects”“OBJECTS”“objs”“OBJS”“obj”或者“OBJ”来作为所有的.o 文件的列表的替代。在使用到这些文件列表的地方,使用此变量来代替。在上例的 Makefile中我们可以添加这样一行:

objects = main.o kbd.o command.o display.o \
	insert.o search.o files.o utils.o

变量，引用方式$(变量名),当变量名是一个字符时，不用加()，多个字符必须加

4. 自动推导规则

在使用make编译.c源文件时,编译.c源文件规则的命令可以不用明确给出

这是因为make本身存在一个默认的规则,能够自动完成对.c文件的编译并生成对应的.o文件。

在Makefile中我们只需要给出需要重建的目标文件名(一个.o文件),make会自动为这个.o文件寻找合适的依赖文件(对应的.c文件。对应是指:文件名除后缀外,其余都相同的两个文件),而且使用正确的命令来重建这个目标文件。

对于上边的例子,此默认规则就使用命令“cc -c main.c -o main.o”来创建文件“main.o”。对一个目标文件是“N.o”,倚赖文件是“N.c”的规则,完全可以省略其规则的命令行,而由make自身决定使用默认命令。此默认规则称为make的隐含规则

这样,在书写 Makefile 时,我们就可以省略掉描述.c 文件和.o 依赖关系的规则,而只需要给出那些特定的规则描述(.o 目标所需要的.h 文件)

因此上边的例子就可以以更加简单的方式书写,我们同样使用变量“objects”。Makefile 内容如下:

# sample Makefile
objects = main.o kbd.o command.o display.o \
		insert.o search.o files.o utils.o
edit : $(objects)
	cc -o edit $(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)

这种格式的Makefile更接近于我们实际应用。

对于上面的Ｍakefile我们还可心用另一种风格进行书写：

#sample Makefile
objects = main.o kbd.o command.o display.o \
	insert.o search.o files.o utils.o
edit : $(objects)
	cc -o edit $(objects)


$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h

这样根据依赖对目标进行分组，这里只做一下介绍，并不推荐用这种风格，因为会对后期维护造成很大的不便

书写规则建议的方式是:单目标,多依赖。就是说尽量要做到一个规则中只存在一个目标文件,可有多个依赖文件。尽量避免使用多目标,单依赖的方式。

这样书写的好处是后期维护会非常方便,而且这样做会使 Makefile 会更清晰、明了。

5. 清除工作目录过程文件

规则除了完成源代码编译之外,也可以完成其它任务。例如:前边提到的为了实现
清除当前目录中编译过程中产生的临时文件(edit 和哪些.o 文件)的规则:

clean :
	rm edit $(objects)

在实际应用时,我们把这个规则写成如下稍微复杂一些的样子。以防止出现始料未及的情况。

.PHONY : clean
clean :
	-rm edit $(objects)

这两个实现有两点不同: 

1. 通过“.PHONY”特殊目标将“clean”目标声明为伪目标。避免当磁盘上存在一个名为“clean”文件时,目标“clean”所在规则的命令无法执行

2. 在命令行之前使用“-”,意思是忽略命令“rm”的执行错误

这样的一个目标在 Makefile 中,不能将其作为终极目标(Makefile 的第一个目标)。因为我们的初衷并不是当你在命令行上输入 make 以后执行删除动作。
而是要创建或者更新程序。在我们上边的例子中。就是在输入 make 以后要需要对目标“edit”进行创建或者重建。

上例中因为目标“clean”没有出现在终极目标“edit”依赖关系中(终极目标的直接依赖或者间接依赖),所以我们执行“make”时,目标“clean”所在的规则将不会被处理。当需要执行此规则,要在make的命令行选项中明确指定这个目标(执行“make clean”。

二、Makefile总述

1. Makefile的内容

在一个完整的 Makefile 中,包含了 5 个东西:显式规则、隐含规则、变量定义、指示符和注释。

• 显式规则:它描述了在何种情况下如何更新一个或者多个被称为目标的文件(Makefile 的目标文件)。书写 Makefile 时需要明确地给出目标文件、目标的依赖文件列表以及更新目标文件所需要的命令(有些规则没有命令,这样的规则只是纯粹的描述了文件之间的依赖关系)
  
• 隐含规则:它是make根据一类目标文件(典型的是根据文件名的后缀)而自动推导出来的规则。make根据目标文件的名,自动产生目标的依赖文件并使用默认的命令来对目标进行更新(建立一个规则)
  
• 变量定义:使用一个字符或字符串代表一段文本串,当定义了一个变量以后,Makefile后续在需要使用此文本串的地方,通过引用这个变量来实现对文本串的使用。第一章的例子中,我们就定义了一个变量“objects”来表示一个.o文件列表。
  
• Makefile 指示符:指示符指明在 make 程序读取 makefile 文件过程中所要执行的一个动作。其中包括:
  
  • 读取一个文件,读取给定文件名的文件,将其内容作为makefile文件的一部分。
    
  • 决定(通常是根据一个变量的得值)处理或者忽略Makefile中的某一特定部分。
    
  • 定义一个多行变量。
    
• 注释:Makefile 中“#”字符后的内容被作为是注释内容(和 shell 脚本一样)处理。如果此行的第一个非空字符为“#”,那么此行为注释行。注释行的结尾如果存在反斜线(\),那么下一行也被作为注释行。一般在书写 Makefile时推荐将注释作为一个独立的行,而不要和 Makefile 的有效行放在一行中书写。当在 Makefile 中需要使用字符“#”时,可以使用反斜线加“#”(\#)来实现(对特殊字符“#”的转义),其表示将“#”作为一字符而不是注释的开始标志。

需要注意的地方:

Makefile 中第一个规则之后的所有以[Tab]字符开始的的行,make 程序都会将其交给系统 shell 程序去解释执行。

因此,以[Tab]字符开始的注释行也会被交给 shell 来处理,此命令行是否需要被执行(shell 执行或者忽略)是由系统 shell 程序来判决的。

另外,在使用指示符“define”定义一个多行的变量或者命令包时,其定义体(“define”和“endef”之间的内容)会被完整的展开到 Makefile 中引用此变量的地方

(包含定义体中的注释行);

make 在引用此变量的地方对所有的定义体进行处理,决定是注释还是有效内容。Makefile 中变量的引用和 C 语言中的宏类似(但是其实质并不相同,后续将会详细讨论)。

对一个变量引用的地方 make 所做的就是将这个变量根据定义进行基于文本的展开,展开变量的过程不涉及到任何变量的具体含义和功能分析。

２. makefile文件的命名

默认的情况下,make 会在工作目录(执行 make 的目录)下按照文件名顺序寻找makefile 文件读取并执行,查找的文件名顺序为:“GNUmakefile” “makefile”、“Makefile”。

通常应该使用“makefile”或者“Makefile”作为一个 makefile 的文件名

(我们推荐使用“Makefile”,首字母大写而比较显著,一般在一个目录中和当前目录的一些重要 文 件 ( README,Chagelist 等 ) 靠 近 , 在 寻 找 时 会 比 较 容 易 的 发 现 它 )

而“GNUmakefile”是我们不推荐使用的文件名,因为以此命名的文件只有“GNU make”才可以识别,而其他版本的 make 程序只会在工作目录下“makefile”和“Makefile”这两个文件。

如果make程序在工作目录下无法找到以上三个文件中的任何一个,它将不读取任何其他文件作为解析对象。

但是根据make隐含规则的特性,我们可以通过命令行指定一个目标,如果当前目录下存在符合此目标的依赖文件,那么这个命令行所指定的目标将会被创建或者更新.

当 makefile 文件的命名不是这三个任何一个时,需要通过 make 的“-f” “--file”或者选项来指定 make 读取的 makefile 文件。给 make 指定 makefile 文件的格式为:“-f NAME” “—file=NAME” 它指定文件或者,“NAME”作为执行 make 时读取的 makefile文件。

也可以通过多个“-f”或者“--file”选项来指定多个需要读取的 makefile 文件,多个 makefile 文件将会被按照指定的顺序进行链接并被 make 解析执行。当通过“-f”或者“--file”指定 make 读取 makefile 的文件时,make 就不再自动查找这三个标准命名的 makefile 文件

注释:通过命令指定目标使用make的隐含规则:
当前目录下不存在以“GNUmakefile”“makefile”“Makefile”命名的任何文件,
1. 当前目录下存在一个源文件foo.c的,我们可以使用“make foo.o”来使用make的隐含规则自动生成foo.o。当执行“make foo.o”时。我们可以看到其执行的命令为:cc –c –o foo.o foo.c之后,foo.o将会被创建或者更新。
2. 如果当前目录下没有foo.c文件时,就是make对.o文件目标的隐含规则中依赖文件不存在。如果使用命令“make foo.o”时,将回到到如下提示:make: *** No rule to make target ‘foo.o’. Stop.
3. 如果直接使用命令“make”时,得到的提示信息如下:make: *** No targets specified and no makefile found. Stop.

3. 包含其它makefile文件

Makefile 中包含其它文件所需要使用的关键字是“include”,和 c 语言对头文件的包含方式一致.

include”指示符告诉 make 暂停读取当前的 Makefile,而转去读取“include”指定的一个或者多个文件,完成以后再继续当前 Makefile 的读取。

Makefile 中指示符“include”书写在独立的一行,其形式如下:

include FILENAMES...

FILENAMES 是 shell 所支持的文件名(可以使用通配符)。

指示符“include”所在的行可以一个或者多个空格(make程序在处理时将忽略这些空格)开始,切忌不能以[Tab]字符开始(如果一行以[Tab]字符开始make程序将此行作为一个命令行来处理)。指示符“include”和文件名之间、多个文件之间使用空格或者[Tab]键隔开。行尾的空白字符在处理时被忽略。使用指示符包含进来的Makefile中,如果存在变量或者函数的引用。

通常指示符“include”用在以下场合:

1. 有多个不同的程序,由不同目录下的几个独立的Makefile来描述其重建规则。它们需要使用一组通用的变量定义或者模式规则。

通用的做法是将这些共同使用的变量或者模式规则定义在一个文件中(没有具体的文件命名限制),在需要使用的Makefile中使用指示符“include”来包含此文件。

2. 当根据源文件自动产生依赖文件时;我们可以将自动产生的依赖关系保存在另外一个文件中,主Makefile使用指示符“include”包含这些文件。

这样的做法比直接在主Makefile中追加依赖文件的方法要明智的多。其它版本的make已经使用这种方式来处理。

如 果 指 示 符 “ include ” 指 定 的 文 件 不 是 以 斜 线 开 始 ( 绝 对 路 径 , 如/usr/src/Makefile...) 而且当前目录下也不存在此文件;

make将根据文件名试图在以下几个目录下查找:

首先,查找使用命令行选项“-I”或者“--include-dir”指定的目录,如果找到指定的文件,则使用这个文件;

否则继续依此搜索以下几个目录(如果其存在) “/usr/gnu/include” “/usr/local/include”和“/usr/include”。

当在这些目录下都没有找到“include”指定的文件时,make将会提示一个包含文件未找到的告警提示,但是不会立刻退出。而是继续处理Makefile的后续内容。

当完成读取整个Makefile后,make将试图使用规则来创建通过指示符“include”指定的但未找到的文件,当不能创建它时(没有创建这个文件的规则),make将提示致命错误并退出。

会输出类似如下错误提示:

Makefile:错误的行数:未找到文件名:提示信息 No such file or directory)

Make: *** No rule to make target ‘<filename>’. Stop

通常我们在 Makefile 中可使用“-include”来代替“include”,来忽略由于包含文件不存在或者无法创建时的错误提示(“-”的意思是告诉 make,忽略此操作的错误。make 继续执行)。像下边那样:

-include FILENAMES...

使用这种方式时,当所要包含的文件不存在时不会有错误提示、make 也不会退出;除此之外,和第一种方式效果相同。

以下是这两种方式的比较:

使用“include FILENAMES...”,make 程序处理时,如果“FILENAMES”列表中的任何一个文件不能正常读取而且不存在一个创建此文件的规则时 make 程序将会提示错误并退出。

使用“-include FILENAMES...”的情况是,当所包含的文件不存在或者不存在一个规则去创建它,make 程序会继续执行,只有真正由于不能正确完成终极目标的重建时(某些必需的目标无法在当前已读取的 makefile 文件内容中找到正确的重建规则),才会提示致命错误并退出。

为了和其它的 make 程序进行兼容。也可以使用“sinclude”来代替“-include” (GNU 所支持的方式)。

4. 变量 MAKEFILES

如果在当前环境定义了一个“MAKEFILES”环境变量,make执行时首先将此变量的值作为需要读入的Makefile文件,多个文件之间使用空格分开。类似使用指示符“include”包含其它Makefile文件一样,如果文件名非绝对路径而且当前目录也不存在此文件,make会在一些默认的目录去寻找。

它和使用“include”的区别:

1. 环境变量指定的 makefile 文件中的“目标”不会被作为 make 执行的“终极目标”。就是说,这些文件中所定义规则的目标,make 不会将其作为“终极目标”来看待。

如果在 make 的工作目录下没有一个名为“Makefile”“makefile”或者“GNUmakefile”的文件,make 同样会提示“make: *** No targets specifiedand no makefile found. Stop.”;

而在 make 的工作目录下存在这样一个文件(“Makefile”“makefile”或者“GNUmakefile”,那么 make 执行时的“终极目标”就是当前目录下这个文件中所定义的“终极目标”。

2. 环境变量所定义的文件列表,在执行 make 时,如果不能找到其中某一个文件(不存在或者无法创建)。make 不会提示错误,也不退出。就是说环境变量“MAKEFILES”定义的包含文件是否存在不会导致 make 错误(这是比较隐蔽的地方)。

3. make 在执行时,首先读取的是环境变量“MAKEFILES”所指定的文件列表,之后才是工作目录下的 makefile 文件,“include”所指定的文件是在 make 发现此关键字的时、暂停正在读取的文件而转去读取“include”所指定的文件。

变量“MAKEFILES”主要用在“make”的递归调用过程中的的通信。实际应用中很少设置此变量。因为一旦设置了此变量,在多级make调用时;由于每一级make都会读取“MAKEFILES”变量所指定的文件,将导致执行出现混乱(这可能不是你想看到的执行结果)。

不过,我们可以使用此环境变量来指定一个定义了通用“隐含规则”和变量的文件,比如设置默认搜索路径;通过这种方式设置的“隐含规则”和定义的变量可以被任何make进程使用。

也有人想让 login 程序自动的在自己的工作环境中设置此环境变量,编写的Makefile 建立在此环境变量的基础上。此想法可以肯定地说不是一个好主意。规劝大家千万不要这么干,否则你所编写的 Makefile 在其他人的工作环境中肯定不能正常工作。因为别人的工作环境中可能没有设置相同的环境变量“MAKEFILES”。

推荐的做法是:在需要包含其它 makefile 文件时使用指示符“include”来实现。