AutoTools学习笔记

开发一个C程序时，为了在不同环境下运行，可能需要考虑这些问题：

1. 某些函数在某些环境下不存在，例如strtod()
2. 同样功能的函数，名字不同，例如strchr() 与 index()
3. 函数名称冲突，例如int setpgrp(void)、setpgrp(int, int)
4. 函数在不同环境下行为不同，例如malloc(0)
5. 函数可能定义在不同的头文件中，例如string.h 、 strings.h 、memory.h

为了解决这些问题，可以：

1. 创建替换宏（substitution macros）
2. 创建替换函数（substitution functions）

手工处理这类问题非常繁琐，1991年人们开始编写Shell脚本，来猜测GNU环境的设置，最终形成了configure这个工具：

1. 探测系统中所需的函数、库、工具是否存在，根据结果生成config.h这个头文件，里面包含很多#define
2. 生成构建软件包的Makefile文件

现在configure文件一般由AutoConf生成，默认情况下遵循如下的目录约定，这些目录决定如何安装程序的可执行文件、库、文档等内容：

变量	默认值
prefix	/usr/local
exec-prefix	$(prefix)
bindir	$(exec-prefix)/bin
libdir	$(exec-prefix)/lib
includedir	$(prefix)/include
datarootdir	$(prefix)/share
datadir	$(datarootdir)
mandir	$(datarootdir)/man
infodir	$(datarootdir)/info

注：上述变量均可以作为configure的命令行参数使用，例如 ./configure --bindir=$HOME/bin 

执行 ./configure --help 可以看到configure的完整帮助，下面给出一些示例：

假设在src目录下有如下一简单C程序：

相关文件将按如下依赖关系生成：

输入文件列表：

生成configure、Makefile已经构建、打包的命令示意： 

工具	说明
autoconf	一个宏处理器（底层是GNU M4，但是带有很多预定义宏），从configure.ac（一个带有宏指令的Shell脚本）生成configure（一个完整的Shell脚本）
autoheader	从configure.ac生成config.h.in
autoreconf	按正确顺序运行所有工具
autoscan	扫描源代码以发现常见的可移植性问题、以及缺失的configure.ac中的宏定义
autoupdate	更新configure.ac中废弃的宏定义
ifnames	从#if/#ifdef/...指令中收集标识符
autom4te	Autoconf的核心，驱动M4、实现上面工具需要的特性

Autoconf提供多种宏来进行常见的配置检查，仅包含宏定义、没有任何Shell语句的congure.ac也是常见的。

Autoconf与M4
Autoconf底层的宏处理器是M4，下面是其一个简单的例子：

由于引号'的特殊用途，因此，在Autoconf中，使用[]来代替''，Shell中不能使用[进行条件判断，而需要使用if test语句。

configure.ac的组成与预定义宏

组成	说明以及重要的宏
准备（Prelude）	Shell 1 2 3 4 5 6 7 8 #强制Autoconf的初始化 AC_INIT(PACKAGE, VERSION, BUG-REPORT-ADDRESS) #启用Automake，并进行初始化，检查依赖的工具是否存在 AM_INIT_AUTOMAKE([OPTIONS...]) #要求Autoconf的最低版本 AC_PREREQ(VERSION) #例如install-sh、depcomp之类构建辅助脚本的存放目录 AC_CONFIG_AUX_DIR(DIRECTORY)
检查程序	Shell 1 2 3 4 5 6 7 8 9 10 11 #编译器检查，如果需要的话处理交叉编译器的搜索 AC_PROG_CC, AC_PROG_CXX, AC_PROG_F77 #寻找适合的实现，并设置$SED $YACC $LEX AC_PROG_SED, AC_PROG_YACC, AC_PROG_LE #设置VAR为第一个寻找到的PROGS，如果找不到，则设置为VAL-IF-NOT-FOUND AC_CHECK_PROGS(VAR, PROGS, [VAL-IF-NOT-FOUND]) #举例： AC_CHECK_PROGS([TAR], [tar gtar], [:]) if test "$TAR" = :; then     AC_MSG_ERROR([This package needs tar.]) fi
检查库	Shell 1 2 3 4 5 #检查__LIBRARY是否存在，是否包含FUNCT，并根据检查结果分别执行ACT-IF-FOUND、ACT-IF-NOT #如果ACT-IF-FOUND没有设置，则默认行为是： #1、LIBS="-l__LIBRARY $LIBS" （Automake使用$LIBS进行链接） #2、定义#define HAVE_LIB__LIBRARY AC_CHECK_LIB(__LIBRARY, FUNCT, [ACT-IF-FOUND], [ACT-IF-NOT])
检查头文件	Shell 1 2 3 4 5 6 7 8 9 10 11 12 13 #检查每一个头文件，并定义C宏：#define HAVE_HEADER_H AC_CHECK_HEADERS(HEADERS...)   AC_CHECK_HEADERS([sys/param.h unistd.h]) AC_CHECK_HEADERS([wchar.h])   #可能添加如下的宏定义:HAVE_SYS_PARAM_H, HAVE_UNISTD_H, HAVE_WCHAR_H #if HAVE_UNISTD_H #include <unistd.h> #endif   #检查一个头文件 AC_CHECK_HEADER(HEADER, [ACT-IF-FOUND], [ACT-IF-NOT])
输出文件	Shell 1 2 3 4 5 6 #从HEADER.h.in文件导出HEADER.h AC_CONFIG_HEADERS(HEADERS...) #从FILE.in文件导出FILE #注意*.in是模板文件，其中的@XYZ@为占位符 #自动使用AC_SUBST定义的变量替换 AC_CONFIG_FILES(FILES...)
动作	Shell 1 2 3 4 5 6 7 8 9 10 11 12 #打印ERROR-DESCRIPTION并退出 AC_MSG_ERROR(ERROR-DESCRIPTION, [EXIT-STATUS]) #打印警告信息 AC_MSG_WARN(ERROR-DESCRIPTION) #输出C宏定义到config.h AC_DEFINE(VARIABLE, VALUE, DESCRIPTION)   /* DESCRIPTION */ #define VARIABLE VALUE   #在Makefile中定义VARIABLE为VALUE AC_SUBST(VARIABLE, [VALUE])

工具	说明
automake	从Makefile.am、configure.ac推导出Makefile.in
aclocal	扫描configure.ac中使用的第三方宏定义、收集aclocal.m4中的定义

Automake辅助生成可移植的、GNU标准兼容的Makefile，它从简单的Makefile.am文件生成复杂的Makefile.in文件。

Makefile.am具有和Makefile类似的语法形式，但是通常只包含变量定义，Automake根据这些定义创建构建规则。在Makefile.am中包含额外的Makefile规则是允许的，Automake会将其保留，并输出到最终的Makefile。

在configure.ac中声明使用Automake

使用宏AM_INIT_AUTOMAKE([OPTIONS...])，可以在configure.ac中声明Automake，OPTIONS包括：

选项	说明
-Wall	开启所有警告
-Werror	将警告报告为错误
foreign	放松某些GNU标准的要求
1.11.1	要求最低1.11.1版本的Automake
dist-bzip2	在执行make dist、make distcheck时自动创建tar.bz2文件
tar-ustar	使用ustar格式创建tar归档文件

使用宏AC_CONFIG_FILES(FILES...)声明输出文件

Automake会为每一个存在FILE.am的FILE创建对应的FILE.in（模板）文件

Makefile.am中的where_PRIMARY惯例 

按目标设置标记

声明源代码文件

Automake举例：静态库

Makefile.am的目录布局

注意每个目录下均需要一个Makefile文件，因此也就对应了Makefile.am文件。并且这些Makefile必须在configure.ac中一一声明，例如：

make命令是在根目录运行的，Makefile.am可以声明构建子目录的顺序：

 Parallel Build Trees (即VPATH Builds)

VPATH用于指定一组make需要搜索的目录的列表。

obj文件、程序、库在configure运行的$CWD下构建，但是源代码不一定需要在$CWD下——所谓构建树（build tree）、源码树（source tree）：

1. Makefile、obj文件等处于构建树
2. Makefile.in、Makefile.am、源代码等位于源码树

如果./configure在$CWD中运行，则两棵树一致，每个Makefile的config.status会定义$(srcdir)，用来指定对应的源码目录

辅助库（Convenience Libraries）

所谓辅助库，是指仅仅在构建过程中使用的临时库：

检查依赖库

哪些文件被分发（Distributed）

 

1. 所有使用***_SOURCES声明的源代码
2. 所有使用***_HEADERS声明的头文件
3. 所有使用dist_***_ SCRIPTS声明的脚本文件
4. 所有使用dist_***_ DATA声明的数据文件
5. 诸如ChangeLog, NEWS之类的常规文件
6. EXTRA_DIST中列出的额外目录或者文件

条件构建（Conditional builds）

扩展Automake规则

1. Makefile.am中的内容几乎是逐字的复制到Makefile.in
2. automake添加新的规则、变量到Makefile.in，以实现必须定义的变量的语义
3. 某些较小的Makefile.in重写是通过条件构建来实现的
4. 在Makefile.am中添加自己的规则是可以的，例如这些规则：
   1. 对维护有意义的目标的规则：例如make style-check
   2. 用于构建特殊目标的规则：例如为某些文件生成FAQ
5. 可以定义对Automake无意义的变量，例如在自定义规则中使用

make命令失败时该怎么办