Makefile构建系统概览

Unix下最常用的构建脚本语言要数makefile，但手写makefile往往有过于繁琐，故常用automake来自动生成支持所有标准目标的makefile，再用autoconf处理配置软件包的工作。

GNU makefile

make是一个构建工具，与写shell脚本相比，make的强项在于可实现自动的部分重新编译，但也可用于众多与依赖有关的任务。只用在makefile文件中写出各文件间的依赖关系，make就会根据这些规则和各文件的最后修改时间自动决定重新生成哪些文件。虽然make是通用的，不过还是多用于unix世界的C/C++/perl等项目，Java项目多用ant或maven，ruby项目多用rake。

make的通常用法为：

make [终极目标...]

其中规则放在当前目录的文件GNUmakefile、makefile或Makefile中。如果不指定终极目标，默认为makefile中首个规则的首个目标（除非规则是模式规则或以点开首）。make的选项在这不多说，只提一下-j选项会导致并发执行，-l可限制负载。

make的执行过程

1. 依次读取变量环境变量MAKEFILES定义的 makefile 文件列表（以空格分隔，通常仅用于make的递归调用过程中的通信）
2. 读取工作目录下的 makefile 文件(依次查找GNUmakefile、makefile、Makefile”,首先找到那个就读取那个)
3. 依次读取工作目录 makefile 文件中使用指示符“include”包含的文件
4. 查找重建所有已读取的 makefile 文件的规则(如果存在一个目标是当前读取的某一个 makefile 文件，则执行此规则重建此 makefile 文件，完成以后从第一步开始重新执行)
5. 初始化变量值并展开那些需要立即展开的变量和函数并根据预设条件确定执行分支
6. 根据终极目标以及其他目标的依赖关系建立依赖关系链表
7. 执行除终极目标以外的所有的目标的规则(规则中如果目标文件不存在或依赖文件中任一个文件的时间戳比目标文件新，则使用规则所定义的命令重建目标文件)
8. 执行“终极目标”所在的规则

makefile概览

makefile中的规则形如：

目标:前提
	命令
	...

其中规则的首行中，目标是待实现的事项（通常是生成的文件名，不是的话叫伪目标）列表，前提是生成目标所需要的文件名列表（可以空）。接下来以制表符开始的若干行每行为一条shell命令，指定实现目标所需的动作，每行在不同子shell独立运行。

makefile中也可以在换行前加反斜杠来续行，分解长的行有助提高可读性。makefile中由##开始行末注释，也同样可续行。作为例子，以下是一个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很不理想，首先它有很多重复，不但编写和修改麻烦，而且会成为错误的温床。有见及此，makefile支持变量，用变量指代字符串。于是上述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 : 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 $(OBJECTS)

然后我们看到生成.o文件的规则太像了，由于它们太常用，其实makefile的隐含规则链（通常基于目标文件名的后缀）已经能处理，于是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
clean :
	rm edit $(OBJECTS)

其实还可以更简短：

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
$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h
clean :
	rm edit $(OBJECTS)

makefile中可以用include 文件名...或-include 文件名...导入其它makefile文件，区别在于前者在文件不存在时报错中止。常见的做法是每个目录一个makefile。

其它细节

规则的变形

模式规则

若目标中有一个%，则它可匹配任何非空字符串，在依赖中也可用%引用捕获部分。

有明确规则可用时不用模式规则。当多个模式都匹配时，首个规则被应用。有模式规则可用时不用隐含规则。

由于兼容原因，makefile支持后缀规则，如.o.c和.c分别相当于%.o:%.c和%:%.c，其中假设涉及后缀.c和.o都在特殊目标.SUFFIXES的依赖中。

另外，静态模式可用于一类前提略有不同的目标：

目标...:目标模式:相应前提...
	命令
	...

双冒号规则

双冒号规则就是使用::代替普通规则的:得到的规则。一个目标可以出现在多个规则中时，这些规则必须是同一类型的规则，要么都是普通规则，要么都是双冒号规则。双冒号规则和普通规则的处理的不同点表现在以下几个方面:

1. 双冒号规则中，当依赖文件比目标更新时。规则将会被执行。对于一个没有依赖而只有命令行的双冒号规则，当引用此目标时，规则的命令将会被无条件执行。而对普通规则，当规则的目标文件存在时，此规则的命令永远不会被执行。

2. 当同一个文件作为多个双冒号规则的目标时。这些不同的规则会被独立的处理，而不是像普通规则那样合并所有的依赖到一个目标文件。这就意味着对这些规则的处理就像多个不同的普通规则一样。就是说多个双冒号规则中的每一个的依赖文件被改变之后，make 只执行此规则定义的命令,而其它的以这个文件作为目标的双冒号规则将不会被执行。

GNU make 的双冒号规则给我们提供一种根据依赖的更新情况而执行不同的命令来重建同一目标的机制。一般这种需要的情况很少，所以双冒号规则的使用比较罕见。

伪目标

规则变量

命令前缀

条件执行

和C语言的文本包含一样，make的条件执行也基于文本。其语法为：

条件
条件为真时保留的文本
endif

或

条件
条件为真时保留的文本
else
条件为假时保留的文本
endif

其中条件形如以下之一：

ifeq (ARG1, ARG2)
ifeq 'ARG1' 'ARG2'
ifeq "ARG1" "ARG2"
ifeq "ARG1" 'ARG2'
ifeq 'ARG1' "ARG2"
ifneq (ARG1, ARG2)
ifneq 'ARG1' 'ARG2'
ifneq "ARG1" "ARG2"
ifneq "ARG1" 'ARG2'
ifneq 'ARG1' "ARG2"
ifdef VARIABLE-NAME
ifndef VARIABLE-NAME

变量

makefile的变量类似C语言的宏，在读取期就展开，展开后内容可被继续展开至不再有变量引用。变量名是不包括:、##、=、前置空白和尾空白的任何字符串，大小写敏感的。变量的值可用$(变量名)或者${变量名}引用，单字符变量名可省略括号。make可以引用环境变量。引用一个没有定义的变量时，make 默认它的值为空。

用=定义的变量是延迟求值变量，变量的值就是等号后的值。用:=定义的变量是立即求值变量，变量的值是对等号后的值展开的结果。这意味着如果变量A定义用到其它变量B，则在前一情况下$A展开为与当前$B值有关的值，在后一情况下$A展开为与定义A时$B值有关的值。立即求值变量因为结果符合记法作用域，不易死循环，容易理解，但较不灵活。延迟求值变量的另外一种定义方法为：

define 变量名
变量值
endef

另外，可用?=给出变量的条件赋值，只有变量不存在时才会进行赋值（延迟求值）。还可用+=把值追加到时变量的值后面，变量性质不变（原来不存在则视为延迟求值变量）。

可以定义目标特定变量，这种变量的作用域是个别目标的上下文，包括和这些目标引发的所有执行过程。目标特定变量和同名的全局变量属于两个不同的变量，它们性质可以不同。定义语法如：

目标 ... : 变量赋值

类似地有模式特定变量。

如果在命令行指定了变量值，则在变量赋值前需要加上override 方能修改变量的值。

变量默认只在当前make有效，如果要传给子make，要用指示export 变量名 ...，而unexport 变量名 ...则可取消其作用。

内置变量

函数

函数调用形如$(函数名 以逗号分隔的参数列表)或者${函数名 以逗号分隔的参数列表}，其中参数会被依次展开。

以下的函数更像是宏：

文件名

makefile中文件名（但在变量定义中不会有特殊处理）接受通配符（*、?和[]，与shell类似）。

至于文件的搜索路径可以如下指定：

make的使用

按惯例，makefile的一些伪目标用于特定用途：

GNU autotools

Makefile工具还不能算是完整的构建系统，因为不同包的makefile间有很多重复性的代码，手工写是烦人的，而且写出的代码往往是考虑不详的，在不同机器上会出现各种繁琐的问题。gcc的-M或-MM选项（后者忽略标准库的头文件）可生成头文件依赖关系的makefile，但这仍然不够：

• automake的目的是自动生成支持所有标准目标的makefile，支持依赖跟踪和递归构建
• autoconf的目的是消除包用户配置软件包的工作，以便让包可以在不同机器以相同方式使用

例子

这里用最简单的例子开始：

src/main.c是源代码：

#include <config.h>
#include <stdio.h>
int main (void)
{
  puts ("Hello World!");
  puts ("This is " PACKAGE_STRING ".");
  return 0;
}

README是对包的给用户看的第一个文档：

This is a demonstration package for GNU Automake.
Type 'info Automake' to read the Automake manual.

Makefile.am和src/Makefile.am包含两个目录的automake指令，语法与makefile相同，但遇到特定的变量作特别处理而不是直接复制到对就的.in文件：

bin_PROGRAMS = hello    #结束于_PROGRAMS、_SCRIPTS、_DATA、_LIBRARIES的变量指定makefile应构建的文件
hello_SOURCES = main.c  #结束于_SOURCES的变量指定相应的一个或多个源文件

SUBDIRS = src           #SUBDIRS指定构建当前目录前应构建的目录
dist_doc_DATA = README  #dist_前缀指出打包时相应文件应复制到归档包

configure.ac包含autoconf指令（其实AC_开首的是m4宏）：

AC_INIT([amhello], [1.0], [bug-automake@gnu.org])  #初始化autoconf，指定包名、版本和报错的联系方式
AM_INIT_AUTOMAKE([-Wall -Werror foreign])          #初始化automake，指定打开所有automake的错误检查，且包不遵守GNU标准
AC_PROG_CC                                         #寻找C编译器以决定CC变量的值
AC_CONFIG_HEADERS([config.h])                      #生成包含此文件指定宏定义（如PACKAGE_STRING）的头文件
AC_CONFIG_FILES([                                  #指定需生成.in文件模板的.am文件
 Makefile
 src/Makefile
])
AC_OUTPUT                                          #实际生成脚本

现在，先为这个包初始化构建系统生成configure脚本和用这脚本生成makefile（以后不用重复这两步，因为make时会自动检测am或ac文件的变化）：

$ autoreconf --install
$ ./configure

现在就可以用make并验证它正常工作了：

$ make
$ src/hello 
Hello World!
This is amhello 1.0.

目录结构

为使用automake，在包目录放置：

• 一个autoconf文件configure.ac或configure.in
• 一个automake文件Makefile.am 然后对automake文件运行automake将生成模板Makefile.in。

为使用autoconf，在包目录放置：

• 一个autoconf文件configure.ac或configure.in
• 一个makefile模板Makefile.in
• 可选择提供m4宏文件aclocal.m4和acsite.m4，其中定义包特定的宏 然后对autoconf文件运行autoconf将生成跨平台的脚本configure。

利用autoreconf通过反复运行autoconf、autoheader、aclocal、automake、libtoolize和autopoint，一步到位地生成或更新包的构建系统。

configure脚本通常生成如下文件：

• 一个或多个makefile，通常是每个子目录一个
• 一个可选的头文件
• 一个config.statusshell脚本，运行它会重新生成上述文件
• 一个日志文件config.log

GNU autoconf

configure.ac文件的典型布局如下：

AC_PREREQ([2.69])                                                 #Autoconf requirements
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
# Information on the package
# Checks for programs.
# Checks for libraries.
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
# Checks for system services
AC_CONFIG_FILES([Makefile,src/Makefile])
AC_OUTPUT

为编写configure.ac，可以运行autoscan自动检查目录树找出常见移植性问题并生成一个模板configure.scan，把它修改成所需后再改名。

autoconf的一个重要用途是为定义C/C++宏，ifnames程序用于列出一个C/C++文件中#if、#elif、#ifdef'、#ifndef等等用到的标识符，这对编写configure.ac`是有用的。

宏

Makefile中的替换

Makefile.in中的@变量名@会被autoconf替换为变量的值。

automake

宏

变量

automake主要用变量的值决定做什么，虽然变量繁多，但有一些规则：

• 一个变量有AM_前缀版本，这时AM_前缀的由开发者设置，没有的由用户设置
• 一些前缀有特殊意义：
  • no_base表示不压平目录结构
  • dist表示指定要发布的文件
  • no_dist表示指定不要发布的文件
  • no_inst表示指定要发布但不安装的文件（通常因为只在安装时用到）
  • 其它前缀表示对应子目录
• 后缀PROGRAMS、LIBRARIES、LTLIBRARIES、LISP、PYTHON、JAVA、SCRIPTS、DATA、HEADERS、MANS、TEXINFOS分别表示各类文件