1. autotools是什么?
在GNU归档中找不到autotools软件包,实际上它是指三个GNU包: autoconf、automake和libtools。将三者配合使用,可以产生可移植的软件。
1.1 autoconf
autoconf 是一个可扩展的M4宏集合。用于产生shell脚本,为工程的源代码自动产生配置脚本。这些脚本能自动适配多种类的Unix操作系统。
autoconf 包括的程序有:
- autoscan
一般在一个新工程中用autoscan扫描源代码,生成文件configure.scan。autoscan寻找可移植性问题,比如检查编译器、库、头文件等。
开发者可以在configure.scan的基础上修改,得到自己的configure.ac(或者configure.in)。
- autoheader
当configure.ac文件中引用了宏AC_CONFIG_HEADER()时,autoheader会根据configure.ac中的宏定义,产生C/C++兼容的头文件模板config.h.in。
当使用者执行脚本configure时,会根据config.h.in生成头文件config.h。所以软件源代码可以包含config.h,使用其中定义的变量等。
- autom4te (发音automate)
autom4te是M4的智能缓存包装器。其他autotools工具(如autoconf和automake),可以用它减少访问configure.ac的时间。
在运行autoconf或autoreconf之后,autom4te在工程的顶层目录中,生成autom4te.cache目录。
- autoconf
autoconf是个简单的shell脚本,它将configure.ac中的宏展开,生成configure脚本。这个过程用到aclocal.m4中定义的宏。
autoconf首先确保当前shell包含必要的功能,来执行M4宏处理器,然后解析命令行参数,并执行autom4te。
下图展示了autoconf 和 autoheader如何使用输入文件,产生相应的输出文件。
- autoreconf
autoreconf 基于configure.ac的内容,以正确的顺序依次执行autoconf、automake、和libtool软件包中的其他配置工具,生成configure脚本。
autoreconf足够聪明执行你需要的工具,以你需要它们的顺序,用你想要的选项。事实上,autoreconf是执行Autotools工具链的推荐方法。
- autoupdate
autoupdate升级configure.ac,以匹配当前版本的autotools所支持的语法。
- ifnames
1.2 automake
automake扩展了autoconf,它将定义在Makefile.am中的项目构建规则,转换成Makefile。它创建的Makefile符合GNU编码标准定义的准则。
automake 包括的程序有:(以Perl脚本的形式提供)
- aclocal
aclocal的定义是:“aclocal - create aclocal.m4 by scanning configure.ac”。它根据configure.ac的需要,将系统已经安装的automake宏,和用户定义的宏(在文件acinclude.m4中,或在子目录m4中的.m4文件中),集中到文件 aclocal.m4中。
下图展示了aclocal的数据流。
- automake
根据高层次的生成规范文件Makefile.am,生成标准makefile模板Makefile.in。以后脚本configure会将Makefile.in转换成Makefile。
如果configure.ac定义了一些特殊的宏,比如AC_PROG_LIBTOOL,它会调用libtoolize,否则它自己产生config.guess和config.sub;
1.3 libtool
libtool是解决共享库可移植性的工具。
类Unix平台之间有很多功能是相同的,但也有一些显著的不同。
比如共享库的构建,有些平台把共享库命名为libname.so,有些则使用libname.a,或libname.sl,还有些甚至不提供本地共享库。这样,在不同的Unix平台上构建共享库时,可能需要向你的编译系统和源代码中,添加很多平台相关的条件代码。
使用libtool,可以避免加入这些平台相关的代码。
比如针对共享库的命名问题,libtool提供了automake宏集,可以在makefile中隐藏库命名差异。
libtool提供的组件有:
- libtoolize
libtoolize shell脚本为项目使用Libtool做准备。它向工程目录添加一个通用libtool脚本的自定义版本。automake生成的Makefile,在合适的时间在用户系统上执行这个自定义脚本。
- libtool
libtool shell脚本是libtoolize添加的通用libtool脚本的自定义版本。
- ltdl库及头文件ltdl.h
ltdl库可能会被静态地或动态地链接进你的程序,给予它们平台之间一致性运行时的共享库访问接口。
下图展示了automake、libtool如何使用输入文件,产生输出文件。
2. autotools依赖的软件包
2.1 m4
M4是一个UNIX宏处理器, 可以将输入值代入到模板中,展开模板成为输出。M4支持使用简单的运算和字符串操作, 主要用于编译前的预处理。autoconf是M4的一个主要使用者。
2.2 Perl
Perl是一种脚本语言。 它借取了C、sed、awk、shell scripting 以及很多其他程式語言的特性。
3. autotools的目标
autotools的目的,是使你的用户(软件的使用者)生活变得简单,而不是你(软件的维护者)生活变得简单。但从长远来看,作为一个工程管理者,使用autotools也会让你的工作变得简单。因为autotools使你的工程难以置信地可移植---甚至是在你从没测试、安装、或构建过你的代码的系统上。
对于autotools,区分软件维护者的平台和软件使用者的平台是重要的。
autotools的设计目的指明,一个autotools产生的编译系统,应该依赖现成的、预先安装在使用者机器上的工具。例如,维护者使用的机器,创建一个分支需要perl解释器,但是使用者的机器,从发行分支构建产品,则并不需要Perl。
所以使用者的机器不需要安装autotools。它只需要一个符合POSIX标准的make和Bourne shell,以执行autotools产生的配置脚本。
4. 软件维护者要做什么?
4.1 流程图
如下是使用autotools生成Makefile的流程图。其中的configure.ac(或configure.in)和Makefile.am,是需要软件维护者编辑的。
4.2 操作过程
在工程目录下运行一系列命令,创建和修改几个文件,就可以生成符合该平台的Makefile文件。操作过程如下:
- 运行autoscan命令
- 将configure.scan 文件重命名为configure.in,并修改configure.in文件
- 在工程的根目录下新建Makefile.am文件,并在子目录下也新建makefile.am文件
- 在project目录下新建NEWS、 README、 ChangeLog 、AUTHORS文件
- 将/usr/share/automake-1.X/目录下的depcomp和compile文件拷贝到工程的根目录下
- 运行aclocal命令
- 运行autoconf命令
- 运行automake -a命令
- 运行confiugre脚本
参考文档
《Autotools - GNU Autoconf, Automake与Libtool实践者指南》第一章
《Autotools - GNU Autoconf, Automake与Libtool实践者指南》第三章
Autoconf官方文档
例解 autoconf 和 automake 生成 Makefile 文件