Linux C工程管理 之autoconf与automake

一、autoconf
     autoconf是一个用于生成可以自动的配置软件源代码包以适应多种UNIX系统的shell脚本的工具。由autoconf生成的配置脚本在运行时与autoconf是无关的，也就是说，配置脚本的用户并不需要拥有autoconf。由autoconf生成的这些脚本通常被命名为configure，它们检查当前系统是否满足软件正常运行所需要的特征，并根据检查得到的信息生成Makefile。对于每个使用了autoconf的软件包，autoconf从一个列举了该软件包需要的或者可以使用的系统特种的列表的模板文件中生成配置脚本。在shell代码识别并响应了一个被列出的系统特征之后，autoconf允许许多个可能使用该特征的软件包共享特征。如果后来因为某些原因需要调整shell代码，只在一个地方进行修改，所有的配置脚本都将被自动重新生成，以使用更新了的代码。为了生成配置脚本，autoconf需要宏处理工具GNU m4。

      

     由autoconf生成的配置脚本通常被称为configure。运行时，configure会创建一些文件。在这些文件中，配置参数被适当的值所替换。由configure创建的文件有：

    1、一个或多个Makefile文件，在包的每个子目录中都有一个。
    2、有时创建一个C语言头文件，它的名字可以被配置，该头文件包含一些宏定义语句。
    3、名为config.status的shell脚本，在运行时，它将重新创建上述文件。
    4、名为config.cache的shell脚本，它保存了许多测试的运行结果。
    5、名为config.log的文件，它包含了由编译程序输出的许多信息，以便在configure出现错误时进行调试。

    为了得到由autoconf创建的configure脚本，首先需要编写一个configure.in（该文件包含了对软件包需要或可以使用的系统特征进行测试的autoconf宏的调用）作为autoconf的输入文件。如果autoconf所提供的预定义测试不能满足要求，则需要自行编写特征测试，这时可能还需要编写一个名为aclocal.m4的文件和一个名为acsite.m4de文件。如果在软件包中使用了包含宏定义语句的C语言头文件，可能还需要编写acconfig.h，此时， autoconf会生成一个文件 config.h.in，在软件包发布时需要包含这个文件。第一次看到这里我吓了一大跳，为了得到configure脚本，需要手动编写这么多文件，这不是坑爹么！在大多数情况下，不需要在configure.in文件中手工输入复杂的宏定义，用脚本程序autoscan可以简化为软件包创建 configure.in文件的工作（看到这里，菜鸟笑了。。。呵呵）。autoscan又是啥玩意儿呢？autoscan是autoconf软件包提供的Perl脚本程序，它从源程序中抽取与函数调用和头文件有关的信息，并将其输出到configure.scan文件中。这个configure.scan可以作为软件包的configure.in文件的初始版本（不光需要改名，而且文件内容需要进行适当地修改哦！至于怎么改，这里暂时就不说了）。

  

     经过上面的一番折腾，我们有了configure.in文件，下面可以开始生成自动配置脚本configure了。要生configure，只需要不带参数地运行autoconf，autoconf将使用m4宏处理器处理configure.in文件。如果提供了文件参数， autoconf将读入指定的文件而不是默认的configure.in文件，并且把配置脚本输出到文件或设备而不是configure中。

二、automake

      我们知道，要使用make，必须先编写一个Makefile文件。它描述了软件包中各个文件之间的关系，提供了更新每个文件的命令。对于一个工程来说，编写Makefile文件也是一个蛮繁琐的工作，如果是一个庞大的工程，手动编写
Makefile就有点坑爹了！还好有automake，automake是一个从文件Makefile.am中自动生成Makefile.in文件的工具。 每个Makefile.am文件是一系列make的宏定义又是也会包含make规则。利用automake生成的Makefile.in服从GNU Makefile标准。看到这里，可能菜鸟又要问了，这个Makefile.am文件怎么生成呢，有没有类似的命令自动生成呢。呵呵，这个还真没有，这里的Makefile.am是需我们手动编写滴，至于怎么编写Makefile.am，这里暂时不说。虽然我们需要手动编写Makefile.am,这个automake还是挺好的，大大减轻了我们的工作。这个automake这么厉害，那它是怎么做到的呢？我们一起来看看它的工作流程。automake首先读入Makefile.am文件，然后生成Makefile.in。automake根据Makefile.am中定义的宏和目标产生更多特定代码，例如一个bin_PROGRAMS宏定义将生成一个需要被编译、链接的目标。automake把Makefile.am中的宏定义和目标复制到生成的文件中。开发者可以根据需要把任何代码添加到生成的Makefile.in文件中。需要注意的是，automake不能识别GNU对make的扩展。在Makefile.am中使用这些扩展特性将导致错误或不确定行为。

       呵呵，通过上面的介绍，我们对automake和autoconf有了一定的了解。下面我们通过一个C语言例子来走下整个流程。这里的例子很菜鸟，一共有三个文件，test.h、test.c和main.c。其中test.h里面声明了一个test函数，这个test函数的实现是在test.c中，然后在main.c中的main函数里面调用这个test函数。首先我们大概分析下流程，不然菜鸟不好下手啊。我们要手动使用make来编译这个C程序，但是使用make需要有Makefile文件；如果要得到Makefile文件，我们需要有自己编写一个Makefile.am，然后执行automake来生成Makefile.in；有了Makefile.in，我们只要执行configure脚本就能生成Makefile文件；根据我们前面介绍的，要想生成configure脚本，我们需要先执行autoscan生成configure.scan，然后对这个文件进行修改得到configure.in文件，接下来我们可以执行autoconf由这个configure.in文件。呵呵，这下子思路清晰多了，下面开始动手操作。

1、我把上面的三个c程序文件放到test目录下，目前目录中就只有这三个文件。

2、执行autoscan，我们会发现test目录中多了autoscan.log和configure.scan文件。

3、把生成的configure.scan修改成configure.in。首先我们先把名字改过来，然后用Ubuntu自带的gedit编辑器打开这个文件，在修改之前文件内容是这样的

下面我们修改后的文件是这样的

这里第一行是autoscan自动生成的，这个不用管它；第二行代表软件名称和版本号，这个是自己随便写的；第三行是我们加上去的，后面的automake命令需要用到它；第四行是程序源文件的目录，我们这里是当前目录；第五行这个宏
将检查系统的C编译器；第六行代表automake的输出文件名为Makefile。

4、执行aclocal和autoconf，我们发现已经生成了configure脚本。

5、编写Makefile.am

第一行是automake的选项，在执行automake时，它会检查目录下是否存在标准GNU软件包中应具备的各种文件，我们将其设置成foreign时，automake会改用一般软件包的标准来检查；第二行宏bin_PROGRAMS将导致编译和链接的目标被生成，其中test代表链接后生成的可执行文件名；第三行指定源文件，有多个源文件，需要用空格隔开。

6、有了Makefile.am后，我们就可以执行automake来生成Makefile.in文件了

执行automake时可能会报出上面的这个问题，说是找不到一些文件。仔细看我们会发现，这里报出问题的同时也提示了解决方法，根据提示我们再次执行这个命令。执行成功后我们查看目录，会发现Makefile.in文件已经生成了

7、有了Makefile.in和configure脚本就好办了，我们直接执行configure脚本，就可以由Makefile.in生成Makefile文件

这里是执行过程，完了以后我们查看目录会发现我们期待已久的Makefile终于生成了

8、至此就可以编译我们的程序了。

呵呵，执行比较顺利，没有报错。查看目录，已经生成了可执行程序test为了验证结果，我们执行下这个testOK，我们看到了程序的输出信息！！！

    好啦，以上就是关于autoconf和automake的全部内容。呵呵，是不是很简单呢？我这里只是粗略地介绍了下autoconf和automake，如果想深入了解，可以去查阅相关的资料。

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

作为Linux下的程序开发人员，一定都遇到过Makefile，用make命令来编译自己写的程序确实是很方便。一般情况下，大家都是手工写一个简单Makefile，如果要想写出一个符合自由软件惯例的Makefile就不那么容易了. 在本文中，将介绍如何使用autoconf和automake两个工具来帮助我们自动地生成符合自由软件惯例的Makefile，这样就可以象常见的GNU程序一样，只要使用“./configure”，“make”，“make instal”就可以把程序安装到Linux系统中去了。这将特别适合想做开放源代码软件的程序开发人员，又或如果你只是自己写些小的Toy程序，那么这个文章对你也会有很大的帮助。

一、Makefile介绍

Makefile是用于自动编译和链接的，一个工程有很多文件组成，每一个文件的改变都会导致工程的重新链接，但是不是所有的文件都需要重新编译，Makefile中纪录有文件的信息，在make时会决定在链接的时候需要重新编译哪些文件。

Makefile的宗旨就是：让编译器知道要编译一个文件需要依赖其他的哪些文件。当那些依赖文件有了改变，编译器会自动的发现最终的生成文件已经过时，而重新编译相应的模块。

Makefile的基本结构不是很复杂，但当一个程序开发人员开始写Makefile时，经常会怀疑自己写的是否符合惯例，而且自己写的Makefile经常和自己的开发环境相关联，当系统环境变量或路径发生了变化后，Makefile可能还要跟着修改。这样就造成了手工书写Makefile的诸多问题，automake恰好能很好地帮助我们解决这些问题。

使用automake，程序开发人员只需要写一些简单的含有预定义宏的文件，由autoconf根据一个宏文件生成configure，由automake根据另一个宏文件生成Makefile.in，再使用configure依据Makefile.in来生成一个符合惯例的Makefile。下面我们将详细介绍Makefile的automake生成方法。

二、使用的环境

本文所提到的程序是基于Linux发行版本：Fedora Core release 1，它包含了我们要用到的autoconf，automake。

三、从helloworld入手

我们从大家最常使用的例子程序helloworld开始。

下面的过程如果简单地说来就是：

新建三个文件：　　helloworld.c　　configure.in　　Makefile.am

然后执行：autoscan; aclocal; autoconf; automake --add-missing; ./configure; make; ./helloworld;

就可以看到Makefile被产生出来，而且可以将helloworld.c编译通过。很简单吧，几条命令就可以做出一个符合惯例的Makefile，感觉如何呀。现在开始介绍详细的过程：

1、建目录

在你的工作目录下建一个helloworld目录，我们用它来存放helloworld程序及相关文件，如在/home/my/build下：

$ mkdir helloword

$ cd helloworld

2、 helloworld.c

然后用你自己最喜欢的编辑器写一个hellowrold.c文件，如命令：vi helloworld.c。使用下面的代码作为helloworld.c的内容。

int main(int argc, char** argv)
        {
                printf("Hello, Linux World! ");
                return 0;
        }

完成后保存退出。现在在helloworld目录下就应该有一个你自己写的helloworld.c了。

3、生成configure

我们使用autoscan命令来帮助我们根据目录下的源代码生成一个configure.in的模板文件。

命令：

$ autoscan
        $ ls
        configure.scan helloworld.c

执行后在hellowrold目录下会生成一个文件：configure.scan，我们可以拿它作为configure.in的蓝本。

4，生成configure.in

现在将configure.scan改名为configure.in，并且编辑它，按下面的内容修改，去掉无关的语句：

Code
        ============================configure.in内容开始=========================================

        # -*- Autoconf -*-

        # Process thisfile with autoconf to produce a configure script.

        AC_INIT(helloworld.c)

        AM_INIT_AUTOMAKE(helloworld, 1.0)

        # Checks forprograms.

        AC_PROG_CC

        # Checks forlibraries.

        # Checks forheader files.

        # Checks fortypedefs, structures, and compiler characteristics.

        # Checks forlibrary functions.

        AC_OUTPUT(Makefile)============================configure.in内容结束=========================================

5 执行aclocal和autoconf

然后执行命令aclocal和autoconf，分别会产生aclocal.m4及configure两个文件：

Code
        $ aclocal

        $ls

        aclocal.m4 configure.inhelloworld.c

        $ autoconf

        $ ls

        aclocal.m4 autom4te.cache configure configure.in helloworld.c

大家可以看到configure.in内容是一些宏定义，这些宏经autoconf处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。

autoconf 是用来生成自动配置软件源代码脚本（configure）的工具。configure脚本能独立于autoconf运行，且在运行的过程中，不需要用户的干预。

要生成configure文件，你必须告诉autoconf如何找到你所用的宏。方式是使用aclocal程序来生成你的aclocal.m4。

aclocal根据configure.in文件的内容，自动生成aclocal.m4文件。aclocal是一个perl 脚本程序，它的定义是：“aclocal - create aclocal.m4 by scanning configure.ac”。

autoconf从configure.in这个列举编译软件时所需要各种参数的模板文件中创建configure。

autoconf需要GNU m4宏处理器来处理aclocal.m4，生成configure脚本。

m4是一个宏处理器。将输入拷贝到输出，同时将宏展开。宏可以是内嵌的，也可以是用户定义的。除了可以展开宏，m4还有一些内建的函数，用来引用文件，执行命令，整数运算，文本操作，循环等。m4既可以作为编译器的前端，也可以单独作为一个宏处理器.

6、新建Makefile.am

新建Makefile.am文件，命令：$ vi Makefile.am

内容如下:

Code
        AUTOMAKE_OPTIONS=foreign

        bin_PROGRAMS=helloworld

        helloworld_SOURCES=helloworld.c

automake会根据你写的Makefile.am来自动生成Makefile.in。Makefile.am中定义的宏和目标,会指导automake生成指定的代码。例如，宏bin_PROGRAMS将导致编译和连接的目标被生成。

7、运行automake

命令：

Code
        $ automake --add-missing

        configure.in: installing `./install-sh'
        configure.in: installing `./mkinstalldirs'
        configure.in: installing `./missing'
        Makefile.am: installing `./depcomp'

automake会根据Makefile.am文件产生一些文件，包含最重要的Makefile.in。

8、执行configure生成Makefile

Code
        $ ./configure

        checking for a BSD-compatible install.../usr/bin/install -c

        checking whether build environment is sane... yes

        checking for gawk...gawk

        checking whether make sets $(MAKE)... yes

        checking for gcc... gcc

        checking for C compiler default output...a.out

        checking whether the C compiler works... yes

        checking whether we are cross compiling... no

        checking for suffix of executables...

        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 ANSI C... none needed

        checking for style of include used by make... GNU

        checking dependency style of gcc... gcc3

        configure: creating ./config.status

        config.status: creating Makefile

        config.status: executing depfiles commands

        $ ls -l Makefile-rw-rw-r-- 1 yutao yutao 15035 Oct 15 10:40 Makefile

你可以看到，此时Makefile已经产生出来了。

9、使用Makefile编译代码

Code
        $ makeif gcc -DPACKAGE_NAME="" -DPACKAGE_TARNAME="" -DPACKAGE_VERSION="" -

        DPACKAGE_STRING="" -DPACKAGE_BUGREPORT="" -DPACKAGE="helloworld" -DVERSION="1.0"
        -I. -I. -g -O2 -MT helloworld.o -MD -MP -MF ".deps/helloworld.Tpo"-c -o helloworld.o `test -f 'helloworld.c' || echo './'`helloworld.c;

        then mv -f ".deps/helloworld.Tpo" ".deps/helloworld.Po";else rm -f ".deps/helloworld.Tpo"; exit 1;

        fi

        gcc -g -O2 -o helloworld helloworld.o

10， 运行helloworld

Code
        $ ./helloworld

        Hello, Linux World!

这样helloworld就编译出来了，你如果按上面的步骤来做的话，应该也会很容易地编译出正确的helloworld文件。你还可以试着使用一些其他的make命令，如make clean，make install，make dist，看看它们会给你什么样的效果。感觉如何？自己也能写出这么专业的Makefile，老板一定会对你刮目相看。