【Linux技术】autotools制作makefile过程详解

Preface

   Makefile固然可以帮助make完成它的使命，但要承认的是，编写Makefile确实不是一件轻松的事，尤其对于一个较大的项目而言更是如此。那么，有没有一种轻松的手段生成Makefile而同时又能让我们享受make的优越性呢？autotools系列工具正是为此而设的，它只需用户输入简单的目标文件、依赖文件、文件目录等就可以轻松地生成Makefile了，这无疑是广大用户的所希望的。另外，这些工具还可以完成系统配置信息的收集，从而可以方便地处理各种移植性的问题。

   也正是基于此，现在Linux上的软件开发一般都用autotools来制作Makefile。

   但是这个工具对像我们这样的初学者来说还是比较陌生，网上找到的使用方法又比较分散，所以这里我把整个流程完整的记录下来，利人利己！

 

---

autotools使用流程

   正如前面所言，autotools是系列工具，读者首先要确认系统是否装了以下工具（可以用which命令进行查看）。

     ·aclocal

     ·autoscan

     ·autoconf

     ·autoheader

     ·automake

   使用autotools主要就是利用各个工具的脚本文件以生成最后的Makefile。其总体流程是这样的：

     ·使用aclocal生成一个“aclocal.m4”文件，该文件主要处理本地的宏定义；

     ·改写“configure.scan”文件，并将其重命名为“configure.in”，并使用autoconf文件生成configure文件。

   接下来，将通过一个简单的hello.c例子来熟悉autotools生成makefile的过程.

 

 

---

先看效果

 

---

 

 

 

---

1．autoscan

   首先运行autoscan命令，它会在给定目录及其子目录树中检查源文件，若没有给出目录，就在当前目录及其子目录树中进行检查。它会搜索源文件以寻找一般的移植性问题并创建一个文件件“configure.scan”，该文件就是接下来autoconf要用到的“configure.in”原型。

 

 

---

2．autoconf

 

 

   configure.in是autoconf的脚本配置文件，它的原型文件即“configure.scan”

 

   （注意）这里要将configure.scan改名为configure.ac，并手动修改其中的内容。该文件主要用于定义程序的

基本信息(名字、版本号等)、在进行编译之前需要进行的测试、需要在哪些目录生成Makefile文件等等

   改后的configure.ac如下所示

1 #                                               -*- Autoconf -*-             
 2 # Process this file with autoconf to produce a configure script.             
 3                                                                              
 4 AC_PREREQ([2.68])                                                            
 5 #AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])               
 6 AC_CONFIG_SRCDIR([hello.c])                                                  
 7 AC_CONFIG_HEADERS([config.h])                                                
 8                                                                              
 9 #add-me-------------                                                         
10 AC_INIT(hello,1.0,[email protected])                                    
11 AM_INIT_AUTOMAKE(hello,1.0)                                                  
12                                                                              
13 # Checks for programs.                                                       
14 AC_PROG_CC                                                                   
15                                                                              
16 # Checks for libraries.                                                      
17                                                                              
18 # Checks for header files.                                                   
19 AC_CHECK_HEADERS([stdlib.h])                                                 
20                                                                              
21 # Checks for typedefs, structures, and compiler characteristics.             
22                                                                              
23 # Checks for library functions.                                              
24                                                                              
25 AC_CONFIG_FILES([Makefile])                                                  
26 AC_OUTPUT

 

   其中add-me----后面两句是加进去的，AC_INIT宏用来定义软件的名称和版本等信息；  

   AM_INIT_AUTOMAKE是automake所必备的宏，参数分别是所要产生软件套件的名称和版本编号。

 

   下面解释下其它代码

   ·以“#”号开始的行为注释。

   ·AC_PREREQ宏声明本文件要求的autoconf版本，如本例使用的版本2.59。

   ·AC_INIT宏用来定义软件的名称和版本等信息l。

   ·AM_INIT_AUTOMAKE是笔者另加的，它是automake所必备的宏，也同前面一样，PACKAGE是所要产生软件套件的名称，VERSION是版本编号。

   ·AC_CONFIG_SRCDIR宏用来侦测所指定的源码文件是否存在，来确定源码目录的有

效性。在此处为当前目录下的hello.c。

   ·AC_CONFIG_HEADER宏用于生成config.h文件，以便autoheader使用。

   ·AC_CONFIG_FILES宏用于生成相应的Makefile文件。

   ·中间的注释间可以添加分别用户测试程序、测试函数库、测试头文件等宏定义。

 

 

   接下来首先运行aclocal，生成一个“aclocal.m4”文件，该文件主要处理本地的宏定义。

 

   再接着运行autoconf，生成“configure”可执行文件。

 

 

 

---

3．autoheader

   接着使用autoheader命令，它负责生成config.h.in文件。该工具通常会从“acconfig.h”文件中复制用户附加的符号定义，因此此处没有附加符号定义，所以不需要创建“acconfig.h”文件。如下所示：

 

 

 

---

4．automake

   这一步是创建Makefile很重要的一步，automake要用的脚本配置文件是Makefile.am，用户需要自己创建这个文件。之后，automake工具将其转换成Makefile.in。
   在该例中，创建的文件为Makefile.am如下所示：

AUTOMAKE_OPTIONS=foreign
bin_PROGRAMS= hello
hellohello_SOURCES= hello.c

 

 

   下面对该脚本文件的对应项进行解释。

   ·其中的AUTOMAKE_OPTIONS为设置automake的选项。由于GNU对自己发布的软件有严格的规范，比如必须附带许可证声明文件COPYING等，否则automake执行时会报错。automake提供了三种软件等级：foreign、gnu和gnits，让用户选择采用，默认等级为gnu。在本例使用foreign等级，它只检测必须的文件。

   ·bin_PROGRAMS定义要产生的执行文件名。如果要产生多个执行文件，每个文件名用空格隔开。

   ·hello_SOURCES定义“hello”这个执行程序所需要的原始文件。如果”hello”这个程序是由多个原始文件所产生的，则必须把它所用到的所有原始文件都列出来，并用空格隔开。例如：若目标体“hello”需要“hello.c”、“sunq.c”、“hello.h”三个依赖文件，则定义hello_SOURCES=hello.c sunq.c。
   接下来可以使用automake对其生成“configure.in”文件，在这里使用选项“—adding-missing”可以让automake自动添加有一些必需的脚本文件。

 

   在automake之后就可以生成configure.in文件。

 

 

 

---

5．运行configure

   在这一步中，通过运行自动配置设置文件configure，把Makefile.in变成了最终的Makefile。如下所示

mystery@mystery-dell:~/Desktop/autotools$ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... no
checking for mawk... mawk
checking whether make sets $(MAKE)... yes
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking for style of include used by make... GNU
checking dependency style of gcc... gcc3
checking how to run the C preprocessor... gcc -E
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for ANSI C header files... yes
checking for sys/types.h... yes
checking for sys/stat.h... yes
checking for stdlib.h... yes
checking for string.h... yes
checking for memory.h... yes
checking for strings.h... yes
checking for inttypes.h... yes
checking for stdint.h... yes
checking for unistd.h... yes
checking for stdlib.h... (cached) yes
configure: creating ./config.status
config.status: creating Makefile
config.status: executing depfiles commands

 

 

   可以看到，在运行configure时收集了系统的信息，用户可以在configure命令中对其进行方便地配置.

   在./configure的自定义参数有两种，一种是开关式（--enable-XXX或--disable-XXX），另一种是开放式，即后面要填入一串字符（--with-XXX=yyyy）参数。读者可以自行尝试其使用方法。另外，读者可以查看同一目录下的”config.log”文件，以方便调试之用。

   到此为止，makefile就可以自动生成了。回忆整个步骤，用户不再需要定制不同的规则，而只需要输入简单的文件及目录名即可，这样就大大方便了用户的使用。

 

 

---

autotools生成的Makefile除具有普通的编译功能外，还具有以下主要功能:

1．make

   键入make默认执行”make all”命令，即目标体为all，其执行情况如下所示：

mystery@mystery-dell:~/Desktop/autotools$ make
cd . && /bin/bash ./config.status config.h
config.status: creating config.h
make  all-am
make[1]: Entering directory `/home/mystery/Desktop/autotools'
gcc -DHAVE_CONFIG_H -I.     -g -O2 -MT hello.o -MD -MP -MF .deps/hello.Tpo -c -o hello.o hello.c
mv -f .deps/hello.Tpo .deps/hello.Po
gcc  -g -O2   -o hello hello.o
cd . && /bin/bash ./config.status config.h
config.status: creating config.h
config.status: config.h is unchanged
make[1]: Leaving directory `/home/mystery/Desktop/autotools'

 

 

   此时在本目录下就生成了可执行文件“hello”，运行“./hello”能出现正常结果，如下所示：

mystery@mystery-dell:~/Desktop/autotools$ ./hello
!!!Hello World!!!

 

 

---

2．make install

   此时，会把该程序安装到系统目录中去；

   若直接运行hello，也能出现正确结果。

 

 

---

3．make clean

   此时，make会清除之前所编译的可执行文件及目标文件（object file, *.o），如下所示：

mystery@mystery-dell:~/Desktop/autotools$ make clean
test -z "hello" || rm -f hello
rm -f *.o

 

 

---

4．make dist

   此时，make将程序和相关的文档打包为一个压缩文档以供发布，如下所示：

mystery@mystery-dell:~/Desktop/autotools$ make dist
mystery@mystery-dell:~/Desktop/autotools$ ls hello-1.0-tar.gz
hello-1.0-tar.gz

 

 

 

   可见该命令生成了一个hello-1.0-tar.gz的压缩文件。

   由上面的讲述不难看出，autotools确实是软件维护与发布的必备工具，也鉴于此，如今GUN的软件一般都是由automake来制作的。