例解 autoconf 和 automake 生成 Makefile 文件

￡神魔★判官ぃ 2022-02-14 19:45 211阅读 0赞

[杨 小华][Link 1], Linux 内核开发工程师, 自由撰稿人

**简介：** 本文介绍了在 linux 系统中，通过 Gnu autoconf 和 automake 生成 Makefile 的方法。主要探讨了生成 Makefile 的来龙去脉及其机理，接着详细介绍了配置 Configure.in 的方法及其规则。

**发布日期：** 2006 年 9 月 21 日  
**级别：** 初级  
**访问情况 ：** 65065 次浏览  
**评论：** 0 ([查看][Link 2] | [添加评论][Link 3] \- 登录)

![平均分 4 星 共 117 个评分][4 _ _ 117] 平均分 (117个评分)  
[为本文评分][Link 4]

**引子**

无论是在Linux还是在Unix环境中，make都是一个非常重要的编译命令。不管是自己进行项目开发还是安装应用软件，我们都经常要用到make或 make install。利用make工具，我们可以将大型的开发项目分解成为多个更易于管理的模块，对于一个包括几百个源文件的应用程序，使用make和 makefile工具就可以轻而易举的理顺各个源文件之间纷繁复杂的相互关系。

但是如果通过查阅make的帮助文档来手工编写Makefile,对任何程序员都是一场挑战。幸而有GNU 提供的Autoconf及Automake这两套工具使得编写makefile不再是一个难题。

本文将介绍如何利用 GNU Autoconf 及 Automake 这两套工具来协助我们自动产生 Makefile文件，并且让开发出来的软件可以像大多数源码包那样，只需"./configure", "make","make install" 就可以把程序安装到系统中。

[回页首][Link 5]

**模拟需求**

假设源文件按如下目录存放，如图1所示，运用autoconf和automake生成makefile文件。

图 1文件目录结构  
![图 1文件目录结构][1]

假设src是我们源文件目录，include目录存放其他库的头文件，lib目录存放用到的库文件，然后开始按模块存放，每个模块都有一个对应的目录，模块下再分子模块，如apple、orange。每个子目录下又分core，include，shell三个目录，其中core和shell目录存放.c文件，include的存放.h文件，其他类似。

样例程序功能：基于多线程的数据读写保护（联系作者获取整个autoconf和automake生成的Makefile工程和源码，E-mail：[normalnotebook@126.com][normalnotebook_126.com]）。

[回页首][Link 5]

**工具简介**

所必须的软件：autoconf/automake/m4/perl/libtool（其中libtool非必须）。

autoconf是一个用于生成可以自动地配置软件源码包，用以适应多种UNIX类系统的shell脚本工具，其中autoconf需要用到 m4，便于生成脚本。automake是一个从Makefile.am文件自动生成Makefile.in的工具。为了生成Makefile.in，automake还需用到perl，由于automake创建的发布完全遵循GNU标准，所以在创建中不需要perl。libtool是一款方便生成各种程序库的工具。

目前automake支持三种目录层次：flat、shallow和deep。

1) flat指的是所有文件都位于同一个目录中。

就是所有源文件、头文件以及其他库文件都位于当前目录中，且没有子目录。Termutils就是这一类。

2) shallow指的是主要的源代码都储存在顶层目录，其他各个部分则储存在子目录中。

就是主要源文件在当前目录中，而其它一些实现各部分功能的源文件位于各自不同的目录。automake本身就是这一类。

3) deep指的是所有源代码都被储存在子目录中；顶层目录主要包含配置信息。

就是所有源文件及自己写的头文件位于当前目录的一个子目录中，而当前目录里没有任何源文件。 GNU cpio和GNU tar就是这一类。

flat类型是最简单的，deep类型是最复杂的。不难看出，我们的模拟需求正是基于第三类deep型，也就是说我们要做挑战性的事情：)。注：我们的测试程序是基于多线程的简单程序。

[回页首][Link 5]

**生成 Makefile 的来龙去脉**

首先进入 project 目录，在该目录下运行一系列命令，创建和修改几个文件，就可以生成符合该平台的Makefile文件，操作过程如下：

1) 运行autoscan命令

2) 将configure.scan 文件重命名为configure.in，并修改configure.in文件

3) 在project目录下新建Makefile.am文件，并在core和shell目录下也新建makefile.am文件

4) 在project目录下新建NEWS、 README、 ChangeLog 、AUTHORS文件

5) 将/usr/share/automake-1.X/目录下的depcomp和complie文件拷贝到本目录下

6) 运行aclocal命令

7) 运行autoconf命令

8) 运行automake -a命令

9) 运行./confiugre脚本

可以通过图2看出产生Makefile的流程，如图所示：

图 2生成Makefile流程图  
![图 2生成Makefile流程图][2_Makefile]

[回页首][Link 5]

**Configure.in的八股文**

当我们利用autoscan工具生成confiugre.scan文件时，我们需要将confiugre.scan重命名为confiugre.in文件。confiugre.in调用一系列autoconf宏来测试程序需要的或用到的特性是否存在，以及这些特性的功能。

下面我们就来目睹一下confiugre.scan的庐山真面目：

<table style="font-size:0.8em"> 
 <tbody> 
  <tr> 
   <td style="font-family:arial,nsimsun,sans-serif; border:1px solid rgb(204,204,204); padding:2px 2px 5px; background-color:rgb(247,247,247)!important"> <pre style="width:694px; margin-top:0px; margin-bottom:0px; font-family:'Andale Mono','Lucida Console',Monaco,Liberation,fixed,monospace; font-size:11px; overflow:auto; background-color:rgb(247,247,247)!important"># Process this file with autoconf to produce a configure script.
AC_PREREQ(2.59)
AC_INIT(FULL-PACKAGE-NAME, VERSION, BUG-REPORT-ADDRESS)
AC_CONFIG_SRCDIR([config.h.in])
AC_CONFIG_HEADER([config.h])
# Checks for programs.
AC_PROG_CC
# Checks for libraries.
# FIXME: Replace `main' with a function in `-lpthread':
AC_CHECK_LIB([pthread], [main])
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_OUTPUT
</pre> </td> 
  </tr> 
 </tbody> 
</table>

每个configure.scan文件都是以AC\_INIT开头，以AC\_OUTPUT结束。我们不难从文件中看出confiugre.in文件的一般布局：

上面的调用次序只是建议性质的，但我们还是强烈建议不要随意改变对宏调用的次序。

现在就开始修改该文件：

修改后的结果如下：

AC_PREREQ(2.59)
AC_INIT(test, 1.0, normalnotebook@126.com)
AC_CONFIG_SRCDIR([src/ModuleA/apple/core/test.c])
AM_CONFIG_HEADER(config.h)
AM_INIT_AUTOMAKE(test,1.0)

# Checks for programs.
AC_PROG_CC
# Checks for libraries.
# FIXME: Replace `main' with a function in `-lpthread':
AC_CHECK_LIB([pthread], [pthread_rwlock_init])
AC_PROG_RANLIB
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_OUTPUT([Makefile
		src/lib/Makefile
		src/ModuleA/apple/core/Makefile
		src/ModuleA/apple/shell/Makefile
		])
		</pre> </td> 
  </tr> 
 </tbody> 
</table>

其中要将AC\_CONFIG\_HEADER(\[config.h\])修改为：AM\_CONFIG\_HEADER(config.h), 并加入AM\_INIT\_AUTOMAKE(test,1.0)。由于我们的测试程序是基于多线程的程序，所以要加入AC\_PROG\_RANLIB，不然运行automake命令时会出错。在AC\_OUTPUT输入要创建的Makefile文件名。

由于我们在程序中使用了读写锁，所以需要对库文件进行检查，即AC\_CHECK\_LIB(\[pthread\], \[main\])，该宏的含义如下：

![table1.gif][]

其中，LIBS是link的一个选项，详细请参看后续的Makefile文件。由于我们在程序中使用了读写锁，所以我们测试pthread库中是否存在pthread\_rwlock\_init函数。

由于我们是基于deep类型来创建makefile文件，所以我们需要在四处创建Makefile文件。即：project目录下，lib目录下，core和shell目录下。

Autoconf提供了很多内置宏来做相关的检测，限于篇幅关系，我们在这里对其他宏不做详细的解释，具体请参看参考文献1和参考文献2，也可参看autoconf信息页。

[回页首][Link 5]

**实战Makefile.am**

Makefile.am是一种比Makefile更高层次的规则。只需指定要生成什么目标，它由什么源文件生成，要安装到什么目录等构成。

表一列出了可执行文件、静态库、头文件和数据文件，四种书写Makefile.am文件个一般格式。

表 1Makefile.am一般格式  
![表 1Makefile.am一般格式][1Makefile.am]

对于可执行文件和静态库类型，如果只想编译，不想安装到系统中，可以用noinst\_PROGRAMS代替bin\_PROGRAMS，noinst\_LIBRARIES代替lib\_LIBRARIES。

Makefile.am还提供了一些全局变量供所有的目标体使用：

表 2 Makefile.am中可用的全局变量  
![表 2 Makefile.am中可用的全局变量][2 Makefile.am]

在Makefile.am中尽量使用相对路径，系统预定义了两个基本路径：

表 3Makefile.am中可用的路径变量  
![表 3Makefile.am中可用的路径变量][3Makefile.am]

在上文中我们提到过安装路径，automake设置了默认的安装路径：

1) 标准安装路径

默认安装路径为：$(prefix) = /usr/local，可以通过./configure --prefix=<new\_path>的方法来覆盖。

其它的预定义目录还包括：bindir = $(prefix)/bin, libdir = $(prefix)/lib, datadir = $(prefix)/share, sysconfdir = $(prefix)/etc等等。

2) 定义一个新的安装路径

比如test, 可定义testdir = $(prefix)/test, 然后test\_DATA =test1 test2，则test1，test2会作为数据文件安装到$(prefix)/ /test目录下。

我们首先需要在工程顶层目录下（即project/）创建一个Makefile.am来指明包含的子目录：

由于每个源文件都会用到相同的头文件，所以我们在最顶层的Makefile.am中包含了编译源文件时所用到的头文件，并导出，见蓝色部分代码。

我们将lib目录下的swap.c文件编译成libswap.a文件，被apple/shell/apple.c文件调用，那么lib目录下的Makefile.am如下所示：

细心的读者可能就会问：怎么表1中给出的是bin\_LIBRARIES，而这里是noinst\_LIBRARIES？这是因为如果只想编译，而不想安装到系统中，就用noinst\_LIBRARIES代替bin\_LIBRARIES，对于可执行文件就用noinst\_PROGRAMS代替bin\_PROGRAMS。对于安装的情况，库将会安装到$(prefix)/lib目录下，可执行文件将会安装到$\{prefix\}/bin。如果想安装该库，则Makefile.am示例如下：

最后两行的意思是将swap.h安装到$\{prefix\}/include /swap目录下。

接下来，对于可执行文件类型的情况，我们将讨论如何写Makefile.am？对于编译apple/core目录下的文件，我们写成的Makefile.am如下所示：

由于我们的test.c文件在链接时，需要apple.o和libswap.a文件，所以我们需要在test\_LDADD中包含这两个文件。对于Linux下的信号量/读写锁文件进行编译，需要在编译选项中指明-D\_GNU\_SOURCE。所以在test\_LDFLAGS中指明。而test\_LDFLAGS只是链接时的选项，编译时同样需要指明该选项，所以需要DEFS来指明编译选项，由于DEFS已经有初始值，所以这里用+=的形式指明。从这里可以看出，Makefile.am中的语法与Makefile的语法一致，也可以采用条件表达式。如果你的程序还包含其他的库，除了用AC\_CHECK\_LIB宏来指明外，还可以用LIBS来指明。

如果你只想编译某一个文件，那么Makefile.am如何写呢？这个文件也很简单，写法跟可执行文件的差不多，如下例所示：

我们这里只是欺骗automake，假装要生成apple文件，让它为我们生成依赖关系和执行命令。所以当你运行完automake命令后，然后修改apple/shell/下的Makefile.in文件，直接将LINK语句删除，即：

<table style="font-size:0.8em"> 
 <tbody> 
  <tr> 
   <td style="font-family:arial,nsimsun,sans-serif; border:1px solid rgb(204,204,204); padding:2px 2px 5px; background-color:rgb(247,247,247)!important"> <pre style="width:694px; margin-top:0px; margin-bottom:0px; font-family:'Andale Mono','Lucida Console',Monaco,Liberation,fixed,monospace; font-size:11px; overflow:auto; background-color:rgb(247,247,247)!important">…….
clean-noinstPROGRAMS:
	-test -z "$(noinst_PROGRAMS)" || rm -f $(noinst_PROGRAMS)
apple$(EXEEXT): $(apple_OBJECTS) $(apple_DEPENDENCIES) 
	@rm -f apple$(EXEEXT)
#$(LINK) $(apple_LDFLAGS) $(apple_OBJECTS) $(apple_LDADD) $(LIBS)
…….
</pre> </td> 
  </tr> 
 </tbody> 
</table>

通过上述处理，就可以达到我们的目的。从图1中不难看出为什么要修改Makefile.in的原因，而不是修改其他的文件。

[回页首][Link 5]

**下载**

<table style="font-size:0.8em; border-width:0px 1px 1px; border-right-style:solid; border-bottom-style:solid; border-left-style:solid; border-right-color:rgb(204,204,204); border-bottom-color:rgb(204,204,204); border-left-color:rgb(204,204,204); width:708px"> 
 <tbody> 
  <tr> 
   <th style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top; background-color:rgb(247,248,252)"> 名字</th> 
   <th style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top; background-color:rgb(247,248,252)"> 大小</th> 
   <th style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top; background-color:rgb(247,248,252)"> 下载方法</th> 
  </tr> 
  <tr> 
   <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top"> project.rar</td> 
   <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top"> &nbsp;</td> 
   <td style="font-family:arial,nsimsun,sans-serif; border-top-color:rgb(204,204,204); border-top-style:solid; border-top-width:1px; padding:8px 5px; vertical-align:top"> <a href="http://www.ibm.com/developerworks/apps/download/index.jsp?contentid=161255&amp;filename=project.rar&amp;method=http&amp;locale=zh_CN" style="color:rgb(153,102,153)" rel="nofollow">HTTP</a></td> 
  </tr> 
 </tbody> 
</table>

[关于下载方法的信息][Link 6]

**参考资料**

1.  Kurt Wall，张辉译 《GNU/Linux编程指南》 清华大学出版社
2.  Robert Mecklenburg，《GNU Make项目管理（第三版）》 东南大学出版社 2006
3.  [http://www.cngnu.org/technology/index.html][http_www.cngnu.org_technology_index.html]

**关于作者**

杨小华，目前从事 Linux 内核方面的研究，喜欢捣鼓 Linux 系统，对 Linux 中断系统比较了解。可以通过 normalnotebook@126.com 与他取得联系。

[Link 1]: http://www.ibm.com/developerworks/cn/linux/l-makefile/#author1
[Link 2]: http://www.ibm.com/developerworks/cn/linux/l-makefile/#icomments
[Link 3]: http://www.ibm.com/developerworks/cn/linux/l-makefile/#
[4 _ _ 117]: http://dw1.s81c.com/developerworks/i/stars120x20-4b.jpg
[Link 4]: http://www.ibm.com/developerworks/cn/linux/l-makefile/#iratings
[Link 5]: http://www.ibm.com/developerworks/cn/linux/l-makefile/#ibm-pcon
[1]: /images/20220214/37885e241ecc405eadaecc5df640fdda.png
[normalnotebook_126.com]: mailto:normalnotebook@126.com
[2_Makefile]: /images/20220214/c24d99d2273b4cf2be211e6a459e1917.png
[table1.gif]: /images/20220214/55ca21ab7b4343e2abe005dbc8104010.png
[1Makefile.am]: /images/20220214/69cfb549c1454c2f8bab97f59472ddfb.png
[2 Makefile.am]: /images/20220214/c6be26dcea9646a493ff864448197f63.png
[3Makefile.am]: /images/20220214/52e43b5db743460880e1a761faefd44a.png
[Link 6]: http://www.ibm.com/developerworks/cn/whichmethod.html
[http_www.cngnu.org_technology_index.html]: http://www.cngnu.org/technology/index.html