Autotools 入门

2024 年 7 月 14 日

概述 #

构建基于 Autotools 的软件包通常有以下步骤：

$ ./configure --prefix=/usr
$ make
$ make install

Configure 作用 #

./configure 会检查构建所需的编译器、系统架构、库文件和头文件等依赖，然后生成 config.h 、Makefile 等文件

用户可以通过配置 configure.ac 文件来控制 configure 的依赖检查 / 功能启用 / 跨平台等特性

Configure 流程 #

./configure 先生成 config.status，再运行 config.status 将模版文件输出为对应的文件

*.in            : 模板文件，可以手动编写，也可以由 autoheader、automake 工具生成
config.log      : 记录了 ./configure 和 config.status 执行过程中的日志及各种变量，用于调试
config.cache    : 由 ./configure -C 参数生成的缓存文件，提升重复 ./configure 的速度

模板文件 #

以 Makefile.in 为例，其形式大致如下：

CC = @CC@
CFLAGS = @CFLAGS@
prefix = @prefix@

all: hello

hello: main.c
	$(CC) $(CFLAGS) -o hello main.c

install:
	cp hello @bindir@

@variable@ 是替换变量（占位符），它在 ./configure 脚本执行时会被替换为实际值，详见 Substitutions in Makefiles

@variable@ 的值来自 configure.ac 中的宏定义和 ./configure 时自动检测或用户定义的值

@variable@ 是 Autotools 模板系统的核心机制，它使得 Makefile 能够根据系统环境和用户配置自动适配，是实现跨平台兼容性的关键

手动维护 Makefile.in 较繁琐，通常是编写 Makefile.am，让 automake 生成 Makefile.in

Makefile 目标 #

详见 Standard Targets for Users

all             : 默认目标，构建程序、库、文档等
install         : 安装需要安装的内容
uninstall       : 删除安装的内容
clean           : 清理编译过程中生成的目标文件和对象文件
distclean       : 与 clean 相同，但也会删除 AutoTools 生成的 Makefile，config.h，config.cache 等文件
check           : 运行测试套件（如果有）
installcheck    : 检查已安装的程序或库（如果支持）
dist            : 创建 PACKAGE-VERSION.tar.gz 压缩包

目录变量 #

目录变量指定了各类文件的安装位置，详见 Variables for Installation Directories

# 目录变量      # 默认值
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

prefix 参数 #

该参数指定文件的安装路径，默认是 /usr/local，手动指定如下：

$ ./configure --prefix=/usr

执行 ./configure 后会生成 config.log，prefix 的值可以在 config.log 文件中确认：

$ grep "^prefix" config.log
prefix='/usr'

其它目录变量也可以参照上面设置，执行 ./configure --help 查看更多可配置的参数

DESTDIR 参数 #

该参数用于安装文件到一个临时目录，比如打包构建好的程序或库，而不是在本地运行：

$ make install DESTDIR=/tmp/app

把 DESTDIR 看作根目录，当 prefix=/usr ，则安装目录就是 /tmp/app/usr，即 $(DESTDIR)/$(prefix)

prefix 与 DESTDIR 的区别 #

--prefix 会影响程序 运行时 的行为，一些程序构建时会把路径硬编码到二进制文件、库文件或其它文件中

$ ./configure --prefix=/usr/local
$ make install DESTDIR=/tmp/app

上面程序的安装路径为 /tmp/app/usr/local

当程序运行时会在 /usr/local/lib 查找库文件，而不是 /tmp/app/usr/local/lib

缓存变量 #

此类变量及其值的列表在 config.log 中可见：

## ---------------- ##
## Cache variables. ##
## ---------------- ##
ac_cv_build=x86_64-unknown-linux-gnu
ac_cv_c_compiler_gnu=yes
...
ac_cv_path_SED=/bin/sed

如果自动检测的值由于某种原因不正确，可以通过环境变量来覆盖：

$ ac_cv_path_SED=/path/to/sed ./configure

Autoconf #

configure.ac 是一个包含宏的 shell 脚本
autoconf 的工作就是将 configure.ac 中的宏展开，转换为完整的 shell 脚本，即 configure
autoconf 的宏以 AC_ 开头，详见 Autoconf Macro Index

文件最小化配置的 configure.ac

# 初始化 autoconf，指定软件包名称、版本号和错误报告地址
AC_INIT([hello], [1.0], [bug-report@address])
# 输出文件
AC_OUTPUT

$ ls
configure.ac
$ autoconf && ls
autom4te.cache  configure  configure.ac

autom4te.cache 文件夹由 autom4te 创建，用于提高执行效率， autoconf、autoheader、automake 等工具都会调用 autom4te 处理宏，详见 What is autom4te.cache

Aclocal #

aclocal 是为 autoconf 准备 “宏库” 的预处理工具

当 configure.ac 包含 autoconf 以外的第三方宏，如 automake 自带的宏和用户自定义的宏，aclocal 作用是将所有第三方宏整合到一个单一的文件 aclocal.m4 中，以供 autoconf 使用

文件configure.ac

AC_INIT([hello], [1.0], [bug-report@address])
# automake 自带的宏，用于初始化 automake
AM_INIT_AUTOMAKE
AC_OUTPUT

直接执行 autoconf 就会报错如下：

$ autoconf
configure.ac:2: error: possibly undefined macro: AM_INIT_AUTOMAKE
      If this token and others are legitimate, please use m4_pattern_allow.
      See the Autoconf documentation.

应该先执行 aclocal：

$ aclocal && ls
aclocal.m4  autom4te.cache  configure.ac
$ autoconf && ls
aclocal.m4  autom4te.cache  configure  configure.ac

Autoheader #

使用 AC_DEFINE 创建 C 语言宏定义

文件configure.ac

AC_INIT([hello], [1.0], [bug-report@address])
# 创建 C 宏定义，参数：[宏名]，[值]，[注释]
AC_DEFINE([FOOBAR], [42], [This is the foobar value])
# 声明 config.h 为输出头文件
AC_CONFIG_HEADERS([config.h])
# 输出所有已声明的文件
AC_OUTPUT

$ ls
configure.ac
$ autoheader && ls
autom4te.cache  config.h.in  configure.ac
$ autoconf && ls
autom4te.cache  config.h.in  configure  configure.ac
$ ./configure
configure: creating ./config.status
config.status: creating config.h
$ ls
autom4te.cache  config.h.in  config.status  configure.ac
config.h        config.log   configure

最终生成的头文件：

文件config.h

/* This is the foobar value */
#define FOOBAR 42
/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "bug-report@address"
/* Define to the full name of this package. */
#define PACKAGE_NAME "hello"
/* Define to the full name and version of this package. */
#define PACKAGE_STRING "hello 1.0"
/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "hello"
/* Define to the home page for this package. */
#define PACKAGE_URL ""
/* Define to the version of this package. */
#define PACKAGE_VERSION "1.0"

config.h 包含了软件包的名称、版本等大量的宏定义，用户程序可以直接使用这些宏，实现条件编译、对不同平台的移植适配等

Automake #

创建下列文件：

./
├── configure.ac
├── Makefile.am
└── src/
    ├── main.c
    └── Makefile.am

文件src/main.c

#include "../config.h"
#include <stdio.h>

int main(void){
    #ifdef ENABLE_CHINESE
        printf("你好，世界！\n");
    #else
        printf("Hello World!\n");
    #endif
    return 0;
}

文件configure.ac

AC_INIT([hello], [1.0], [bug-report@address])
# 通过一个独一无二的文件来标识源码目录，让 configure 脚本能够确定它正在正确的源代码目录中运行
AC_CONFIG_SRCDIR([src/main.c])
# 初始化 automake，foreign 告诉 automake 不需要所有 GNU 编码风格文件，-Wall -Werror 打开所有警告并报告为错误
AM_INIT_AUTOMAKE([foreign -Wall -Werror])
# 检查 C 编译器
AC_PROG_CC
# 添加 ./configure 命令行参数 --enable-chinese
AC_ARG_ENABLE(chinese, AS_HELP_STRING([--enable-chinese], [print in chinese]), opt_chinese=$enableval)

if test $opt_chinese = yes; then
    # 定义宏 ENABLE_CHINESE
    AC_DEFINE([ENABLE_CHINESE], [], [print in chinese])
fi

# 声明 config.h 为输出头文件
AC_CONFIG_HEADERS([config.h])
# 声明 Makefile 和 src/Makefile 为输出文件
AC_CONFIG_FILES([Makefile src/Makefile])
# 输出所有已声明的文件
AC_OUTPUT

文件Makefile.am

# SUBDIRS 表示需递归构建的子目录
SUBDIRS = src

文件src/Makefile.am

# 构建 hello 这个可执行文件
bin_PROGRAMS = hello
# 构建 hello 这个目标所需的源文件
hello_SOURCES = main.c


`AM_INIT_AUTOMAKE`	List of Automake options
`AC_ARG_ENABLE`	Choosing Package Options
`AC_SUBST`	Setting Output Variables
`SUBDIRS`	Recursing subdirectories

bin_PROGRAMS 命名规则如下，详见 The Uniform Naming Scheme ：

bin_PROGRAMS  ==>  prefix_PRIMARY  ==>  由 prefix 和 PRIMARY 两部分组成

prefix   :  匹配 *dir 的目录变量，例如 bindir，libdir，datadir 等
            这里我们构建的是 hello 这个可执行文件，安装在 bin 目录下，所以是 bindir

PRIMARY  :  PROGRAMS    ->  可执行文件
            LIBRARIES   ->  库文件
            HEADERS     ->  公共头文件
            DATA        ->  任意数据文件
            MANS        ->  文档
            SCRIPTS     ->  脚本

接下来开始构建：

$ aclocal                           # 生成 aclocal.m4
$ autoconf                          # 生成 configure
$ autoheader                        # 生成 config.h.in
$ automake --add-missing --copy     # 生成 Makefile.in src/Makefile.in
configure.ac:6: installing './compile'
configure.ac:4: installing './install-sh'
configure.ac:4: installing './missing'
src/Makefile.am: installing './depcomp'

$ ./configure --prefix=/tmp/app1    # 生成 config.h Makefile src/Makefile
$ make && make install              # 编译并安装
$ /tmp/app1/bin/hello               # 运行安装的程序
Hello World!

$ ./configure --prefix=/tmp/app2 --enable-chinese   # 使能中文打印，这会在 config.h 中定义 ENABLE_CHINESE 宏
$ make && make install              # 编译并安装
$ /tmp/app2/bin/hello               # 运行安装的程序
你好，世界！

automake 的 --add-missing --copy 参数用来复制缺失的辅助文件（Autotools 自带的 compile，install-sh 等），configure、Makefile 等可能会需要这些脚本

Autoreconf #

上面的例子中，手动执行 aclocal → autoconf → autoheader → automake 十分繁琐

可以使用 autoreconf 自动完成这一过程，通常搭配 -i 或 --install 参数（复制缺失的标准辅助文件）

$ make distclean
$ autoreconf -i
$ ./configure --prefix=/tmp/app3 --enable-chinese
$ make && make install
$ /tmp/app3/bin/hello
你好，世界！

Autoscan #

configure.ac 文件可以手动创建，也可以使用 autoscan 命令生成 configure.scan 文件，修改后再重命名为 configure.ac 即可

打包源码 #

使用 make dist 命令：

$ make dist
$ ls *.tar.*
hello-1.0.tar.gz

指定 tar 包压缩格式，修改 configure.ac 中 AM_INIT_AUTOMAKE 的参数即可，如 dist-xz：

AM_INIT_AUTOMAKE([foreign -Wall -Werror dist-xz])

AM_INIT_AUTOMAKE 参数详见 List of Automake options

发布软件 #

当软件作为 tar 包发布时，configure 和 Makefile.in 应该包含在内，用户解压后只需执行 ./configure、make、make install

当通过版本控制系统发布时，应该只包含 configure.ac 和 Makefile.am，不应包含 Autotools 生成的辅助文件

备忘 #

Autotools 涉及的的东西太多，以后再研究：

交叉编译
动态库
libtool
自定义宏

参考文章 #

官方文档 #

更多索引在官方文档总目录最下方

automake

Autoconf
- Autoconf Macro Index
- Concept Index

GNU Coding Standards