教你如何使用automake生成Makefile文件

• 作者：邹祁峰
• 邮箱：[email protected]
• 博客：http://blog.csdn.net/qifengzou
• 日期：2014.02.21
• 转载请注明来自"祁峰"的CSDN博客

1 引言

  众所周知，Makefile主要用来组织源码的编译，其语法在此不做阐述。经分析可发现，源码的组织结构通常有以下3种形式：

    1) flat：所有文件都处在同一目录

        所有源文件、头文件以及相关的库文件都处在当前的目录中，不存在任何子目录。

    2) shallow：主要源代码处在顶层目录，其他各部分处在子目录

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

    3) deep：所有源代码处在子目录，顶层目录存放配置信息

        所有源文件及自己写的头文件位于当前目录的一个子目录中，而当前目录里没有任何源文件。

    使用automake对以上3种源码组织结构的编译过程在某些细节上存在一些差异，但是大概流程是一致的，如下图所示：

图1 生成Makefile的过程

2 创建过程

2.1 FLAT

  根据引言中对flat源码结构的描述“所有源文件、头文件以及相关的库文件都处在当前的目录中，不存在任何子目录”可知其目录结构如下图所示：

图2 flat源码结构
(注：将algo.c改为algo.h)

目录说明：

    add.c：实现加法运算 int my_add(int a, int b) { return (a + b); }

    sub.c：实现减法运算 int my_sub(int a, int b) { return (a - b); }

    mul.c：实现乘法运算 intmy_mul(int a, int b) { return(a * b); }

    div.c: 实现除法运算 intmy_div(int a, int b) { return(a / b); }

    algo.h：头文件声明源码中实现的函数

    test.c：在主函数中调用以上源文件实现的函数，并展示运算结果

编译步骤：

1) 执行autoscan

    在目录中执行autoscan命令，会生成文件configure.scan，再将其重命名为configure.in，最后还需要做如下修改。

    #autoscan

    #mv configure.scan configure.in

    #vim configure.in

修改过程：

    ①、将AC_CONFIG_SRCDIR([sub.c])改为AC_CONFIG_SRCDIR([test.c]) - 注：使用有主函数main()的源文件test.c取代sub.c

    ②、将AC_CONFIG_HEADER([config.h])改为AM_CONFIG_HEADER([config.h])

    ③、新增AM_INIT_AUTOMAKE(math, 1.0)：其中math是希望生成的可执行程序的名字，1.0表示版本号

    ④、将AC_OUTPUT改为AC_OUTPUT(Makefile)：表示要创建的Makefile名

图3 修改前后对比

2) 配置Makefile.am

    在当前目录中新建Makefile.am文件，生成可执行文件math，因此其配置内容为：

图4 Makefile.am

3) 新建文件

    在当前目录下新建文件NEWS、README、ChangeLog、AUTHORS文件，内容为空；

    #touch NEWS

    #touch README

    #touch ChangeLog

    #touch AUTHORS

4) 生成configure

    #aclocal   —— 该命令将以configure.in为输入文件，生成aclocal.m4

    #autoconf  —— 该命令将以configure.in和aclocal.m4为输入文件，生成文件configure

    #autoheader

5) 生成Makefile.in

    #automake -a （该命令将以configure.in和Makefile.am为输入文件，生成文件Makefile.in）

6) 执行./configure

    配置安装程序，并生成Makefile

7) 编译源码

    经过以上步骤，已经生成了Makefile，此时只需执行make，便可以编译源码，并生成可执行程序了；

8) 运行结果

    完成以上所有操作之后，在当前目录下就生成了可执行程序math，其最终的运行结果如下图所示：

图5 flat结果

2.2 SHALLOW

    根据引言中对shallow源码结构的描述“主要源文件在当前目录中，而其它一些实现各部分功能的源文件位于各自不同的目录”可知其目录结构如下图所示：

图6 shallow源码结构

目录说明：

    add/add.c：实现加法运算 int my_add(int a, int b) { return (a + b); }

    sub/sub.c：实现减法运算 int my_sub(int a, int b) { return (a - b); }

    mul/mul.c：实现乘法运算 int my_mul(int a, int b) { return (a * b); }

    div/div.c: 实现除法运算 int my_div(int a, int b) { return (a / b); }

    incl/algo.h：头文件声明源码中实现的函数

    test.c：在主函数中调用以上源文件实现的函数，并展示运算结果

编译步骤：

1) 执行autoscan

    在目录中执行autoscan命令，会生成文件configure.scan，再将其重命名为configure.in，最后还需要做如下修改。

    #autoscan

    #mv configure.scan configure.in

    #vim configure.in

  修改过程:

    ①、将AC_CONFIG_HEADER([config.h])改为AM_CONFIG_HEADER([config.h])

    ②、新增AM_INIT_AUTOMAKE(math, 2.0)：其中math是希望生成的可执行程序的名字，2.0表示版本号

    ③、将AC_OUTPUT改为AC_OUTPUT([Makefile

                                ./add/Makeifle

                                ./sub/Makefile

                                ./mul/Makefile

                                ./div/Makefile])：表示要创建的Makefile名

图7 修改前后对比

2) 配置Makefile.am

    现在存在的目录有顶层目录math、add、sub、mul、div和incl，因此需要分别在对应新建Makefile.am文件，一共6个。

    1) 顶层目录的Makefile.am

图8 顶层目录Makefile.am

    配置说明：

        ①、SUBDIRS：用来指明源文件、库文件所在目录

        ②、CURRENTPATH：获取当前代码所在目录

        ③、INCLUDES：指明头文件所在目录

        ④、bin_PROGRAMS：指明生成的可执行文件的名称exec

        ⑤、exec_SOURCES: 指明可执行程序依赖的源文件

        ⑥、exec_LDADD：指明链接时依赖的文件

        ⑦、exec_LDFLAGS：指明链接时需要的选项

        ⑧、DEFS：指明编译选项

        ⑨、LIBS：指明程序还需要包含的库

    2) 源文件目录Makefile.am

图9 子目录add中的Makefile.am

    这里使用了欺骗手段，欺骗automake需要生成可执行程序add，让它生成依赖文件add.o和执行命令。所以当运行完automake命令后，需要修改对应目录下的Makefile.in，删除其中的LINK语句。

    配置说明：

        ①、noinst_PROGRAMS：指明需要生成的可执行程序的名称，在此因为不要安装，所以使用关键字noinst_PROGRAMS；如果需要安装，则使用bin_PROGRAMS。

        ②、exec_SOURCES：指明可执行程序依赖的文件名

        ③、DEFS：指明编译选项

    因sub、mul以及div目录的作用与add相似，因此，他们的Makefile.am配置是极其相似，只需将其中的add改为sub、mul或div即可，在此不再迭述。

    3) 头文件Makefile.am

    将被源码使用的头文件加入到对应的变量include_HEADERS中即可：

图10 头文件Makefile.am

3) 新建文件

    在当前目录下新建文件NEWS、README、ChangeLog、AUTHORS文件，内容为空；

    #touch NEWS

    #touch README

    #touch ChangeLog

    #touch AUTHORS

4) 生成configure

    #aclocal    —— 该命令将以configure.in为输入文件，生成aclocal.m4

    #autoconf   —— 该命令将以configure.in和aclocal.m4为输入文件，生成文件configure

    #autoheader

5) 生成Makefile.in

    #automake -a  —— 该命令将以configure.in和Makefile.am为输入文件，生成文件Makefile.in

    因生成add.o、sub.o、mul.o和div.o使用了欺骗的手段，所以当运行完automake命令后，需要修改对应目录下的Makefile.in，删除其中的LINK语句。

图11 修改前后对比

    因add、sub、mul与div的功能相似，所以其修改过程也是极其一致的，在此不再迭述。

6) 执行./configure

    配置安装程序，并生成Makefile

7) 编译源码

    #make

    #make install

    便可完成源码的编译和程序的安装；

8) 运行结果

    完成以上所有操作之后，在当前目录下就生成了可执行程序math，其最终的运行结果如下图所示：

图12 shallow编译结果

2.3 DEEP

    根据引言中对deep源码结构的描述“所有源文件都放在子目录中，顶层目录只放配置信息”可知其目录结构如下图所示：

图13 deep源码结构

目录说明：

    add/add.c：实现加法运算 int my_add(int a, int b) { return (a + b); }

    sub/sub.c：实现减法运算 int my_sub(int a, int b) { return (a - b); }

    mul/mul.c：实现乘法运算 int my_mul(int a, int b) { return (a * b); }

    div/div.c: 实现除法运算 int my_div(int a, int b) { return (a / b); }

    incl/algo.h：头文件声明源码中实现的函数

    main/test.c：在主函数中调用以上源文件实现的函数，并展示运算结果

编译步骤：

1) 执行autoscan

    在目录中执行autoscan命令，会生成文件configure.scan，再将其重命名为configure.in，最后还需要做如下修改。

    #autoscan

    #mv configure.scan configure.in

    #vim configure.in

修改过程:

    ①、将AC_CONFIG_SRCDIR([mul/mul.c])改为AC_CONFIG_SRCDIR([main/test.c])

    ②、将AC_CONFIG_HEADER([config.h])改为 AM _CONFIG_HEADER([config.h])

    ③、新增AM_INIT_AUTOMAKE(math, 3.0)：其中math是希望生成的可执行程序的名字，2.0表示版本号

    ④、在AC_CONFIG_FILES([add/Makefile ...])中再添加一行main/Makefile

    ⑤、将AC_OUTPUT改为AC_OUTPUT([Makefile ])

图14 修改前后对比

2) 配置Makefile.am

    现在存在的目录有顶层目录math、add、sub、mul、div、main和incl，因此需要分别在对应新建Makefile.am文件，一共7个。

    1) 顶层目录的Makefile.am

图15 顶层目录Makefile.am

    配置说明：

        ①、SUBDIRS：用来指明源文件、库文件所在目录

        ②、CURRENTPATH：获取当前代码所在目录

        ③、INCLUDES：指明头文件所在目录

    2) 源文件目录Makefile.am

图16 子目录add中的Makefile.am

    这里使用了欺骗手段，欺骗automake需要生成可执行程序add，让它生成依赖文件add.o和执行命令。所以当运行完automake命令后，需要修改对应目录下的Makefile.in，删除其中的LINK语句。

    配置说明：

        ①、noinst_PROGRAMS：指明需要生成的可执行程序的名称，在此因为不要安装，所以使用关键字noinst_PROGRAMS；如果需要安装，则使用bin_PROGRAMS。

        ②、exec_SOURCES：指明可执行程序依赖的文件名

        ③、DEFS：指明编译选项

    因sub、mul、div目录的作用与add相似，因此，他们的Makefile.am配置是极其相似，只需将其中的add改为sub、mul或div即可，在此不再迭述。

    3) 主函数中的Makefile.am

图17 子目录main中的Makefile.am

    配置说明：

        ①、bin_PROGRAMS：指明生成的可执行文件的名称exec

        ②、exec_SOURCES: 指明可执行程序依赖的源文件

        ③、exec_LDADD：指明链接时依赖的文件

        ④、exec_LDFLAGS：指明链接时需要的选项

        ⑤、DEFS：指明编译选项

        ⑥、LIBS：指明程序还需要包含的库

    4) 头文件Makefile.am

    将被源码使用的头文件加入到对应的变量include_HEADERS中即可：

图18 头文件Makefile.am

3) 新建文件

    在当前目录下新建文件NEWS、README、ChangeLog、AUTHORS文件，内容为空；

    #touch NEWS

    #touch README

    #touch ChangeLog

    #touch AUTHORS

4) 生成configure

    #aclocal    —— 该命令将以configure.in为输入文件，生成aclocal.m4

    #autoconf   —— 该命令将以configure.in和aclocal.m4为输入文件，生成文件configure

    #autoheader

5) 生成Makefile.in

    #automake -a  —— 该命令将以configure.in和Makefile.am为输入文件，生成文件Makefile.in

    因生成add.o、sub.o、mul.o和div.o使用了欺骗的手段，所以当运行完automake命令后，需要修改对应目录下的Makefile.in，删除其中的LINK语句。

图19 修改前后对比

    因add、sub、mul与div的功能相似，所以其修改过程也是极其一致的，在此不再迭述。[注：main下的不用修改]

6) 执行./configure

    完成安装路径的配置和Makefile的生成；

7) 编译源码

    #make

    #make install

    便可完成源码的编译和程序的安装；

8) 运行结果

    完成以上所有操作之后，在当前目录下就生成了可执行程序math，其最终的运行结果如下图所示：

图20 deep编译结果

  在此文中还有很多变量含义和设置为明确说明，有兴趣的可参考：http://www.ibm.com/developerworks/cn/linux/l-makefile/