Linux下autoconf和automake使用 痛定思痛。 2022-09-23 09:00 189阅读 0赞 作为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发行版本Ubuntu 16.04,它包含了我们要用到的autoconf,automake,如果没有安装可以运行apt install进行安装。 三、从helloworld入手 我们从大家最常使用的例子程序helloworld开始。 1.新建目录hello作为我们的工程目录,并在该目录中新建两个文件:hello\_world.c hello\_world.h 文件内容如下: hello\_world.c \#include "helloworld.h" int main() \{ printf("hello world!\\n"); return 0; \} hello\_world.h \#include <stdio.h> 2.生成configure.scan 在当前目录下执行autoscan,在当前目录下会生成一个configure.ac的模板文件configure.scan。 3.修改config.scan文件,原来的内容为 \# -\*- Autoconf -\*- \# Process this file with autoconf to produce a configure script. AC\_PREREQ(\[2.69\]) AC\_INIT(\[FULL-PACKAGE-NAME\], \[VERSION\], \[BUG-REPORT-ADDRESS\]) AC\_CONFIG\_SRCDIR(\[helloworld.c\]) AC\_CONFIG\_HEADERS(\[config.h\]) \# Checks for programs. AC\_PROG\_CC \# Checks for libraries. \# Checks for header files. \# Checks for typedefs, structures, and compiler characteristics. \# Checks for library functions. AC\_OUTPUT 修改为: \# -\*- Autoconf -\*- \# Process this file with autoconf to produce a configure script. AC\_PREREQ(\[2.69\]) \#AC\_INIT(\[FULL-PACKAGE-NAME\], \[VERSION\], \[BUG-REPORT-ADDRESS\]) AC\_INIT(hello\_world, 1.0, 10972353xxx.qq.com) AM\_INIT\_AUTOMAKE(hello\_world, 1.0,10972353xxx.qq.com) AC\_CONFIG\_SRCDIR(\[helloworld.c\]) AC\_CONFIG\_HEADERS(\[config.h\]) \# Checks for programs. AC\_PROG\_CC \# Checks for libraries. \# Checks for header files. \# Checks for typedefs, structures, and compiler characteristics. \# Checks for library functions. AC\_CONFIG\_FILES(\[Makefile\]) AC\_OUTPUT 重命名configure.scan为configure.ac 说明: (1)以“\#”号开始的行均为注释行。 (2)AC\_PREREQ 宏声明本文要求的autoconf版本, 如本例中的版本 2.69。 (3)AC\_INIT 宏用来定义软件的名称、版本等信息、作者的E-mail等。 (4)AM\_INIT\_AUTOMAKE是通过手动添加的, 它是automake所必备的宏, FULL-PACKAGE-NAME是软件名称,VERSION是软件版本号。 (5)AC\_CONFIG\_SCRDIR 宏用来侦测所指定的源码文件是否存在, 来确定源码目录的有效性.。此处为当前目录下main.c。 (6)AC\_CONFIG\_HEADER 宏用于生成config.h文件,以便autoheader命令使用。 (7)AC\_PROG\_CC用来指定编译器,如果不指定,默认gcc。 (8)AC\_OUTPUT 用来设定 configure 所要产生的文件,如果是makefile,configure 会把它检查出来的结果带入makefile.in文件产生合适的makefile。使用 Automake时,还需要一些其他的参数,这些额外的宏用aclocal工具产生。 (9)AC\_CONFIG\_FILES宏用于生成相应的Makefile文件。 4.执行命令aclocal和autoconf,分别会产生aclocal.m4和configure两个文件。 m4是一个宏处理器.将输入拷贝到输出,同时将宏展开.宏可以是内嵌的 ,也可以是用户定义的 .除了可以展开宏,m4还有一些内建的函数,用来引用文件,执行命令,整数运算,文本操作,循环等.m4既可以作为编译器的前端,也可以单独作为一个宏处理器。 5.用autoheader生成config.h.in 执行autoheader后在当前目录下会生成config.h.in文件。 6.新建Makefile.am文件,填入以下内容: AUTOMAKE\_OPTIONS=foreign bin\_PROGRAMS=hello\_world hello\_world\_SOURCES=hello\_world.c hello\_world.h 7.运行automake --add-missing 使用选项 "--add-missing" 可以让Automake自动添加一些必需的脚本文件,如果出现如下错误: Makefile.am: error: required file './NEWS' not found Makefile.am: error: required file './README' not found Makefile.am: error: required file './AUTHORS' not found Makefile.am: error: required file './ChangeLog' not found 可以添加这些文件,touch NEWS README AUTHORS ChangeLog 这些文件都是说明性文件,提供给使用者阅读,可以根据自己的要去撰写。 8.测试刚才生成的configure,用来生成Makefile。 因为我想安装的目录是/opt,所以我需要使用prefix来指定,输入如下命令: ./configure --prefix=/opt 执行完毕后,在该目录下会有Makefile文件产生。 9.使用Makefile编译,直接执行make命令。 10.安装到configure指定的目录中,执行如下命令: sudo make install 11.到/opt目录下还有一个bin目录,在bin目录下查看到生成出来的目标文件hello\_world,执行./hello\_world将会看到执行结果。 12.卸载sudo make install 生成的目标文件 在hello目录下直接执行sudo make uninstall 进行反安装,执行结束后会发现/opt/bin目录下的hello\_world可执行文件不存在了。 还可以在hello目录下执行make clean清理make编译出来的.o文件,使用make dist产生发布软件包文件(即distribution package),这个命令将会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。 四、深入浅出 针对上面提到的各个命令,我们再做些详细的介绍。 1、autoscan autoscan是用来扫描源代码目录生成configure.scan文件的。autoscan可以用目录名做为参数,但如果你不使用参数的话,那么autoscan将认为使用的是当前目录。autoscan将扫描你所指定目录中的源文件,并创建configure.scan文件。 2、configure.scan configure.scan包含了系统配置的基本选项,里面都是一些宏定义。我们需要将它改名为configure.in 3、aclocal aclocal是一个perl脚本程序。aclocal根据configure.in文件的内容,自动生成aclocal.m4文件。aclocal的定义是:“aclocal - create aclocal.m4 by scanning configure.ac”。 4、autoconf 使用autoconf,根据configure.in和aclocal.m4来产生configure文件。configure是一个脚本,它能设置源程序来适应各种不同的操作系统平台,并且根据不同的系统来产生合适的Makefile,从而可以使你的源代码能在不同的操作系统平台上被编译出来。 configure.in文件的内容是一些宏,这些宏经过autoconf处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。configure.in文件中的宏的顺序并没有规定,但是你必须在所有宏的最前面和最后面分别加上AC\_INIT宏和AC\_OUTPUT宏。 在configure.ini中: \#号表示注释,这个宏后面的内容将被忽略。 AC\_INIT(FILE) 这个宏用来检查源代码所在的路径。 AM\_INIT\_AUTOMAKE(PACKAGE, VERSION) 这个宏是必须的,它描述了我们将要生成的软件包的名字及其版本号:PACKAGE是软件包的名字,VERSION是版本号。当你使用make dist命令时,它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包,其中就有对应的软件包的名字和版本号。 AC\_PROG\_CC 这个宏将检查系统所用的C编译器。 AC\_OUTPUT(FILE) 这个宏是我们要输出的Makefile的名字。 我们在使用automake时,实际上还需要用到其他的一些宏,但我们可以用aclocal来帮我们自动产生。执行aclocal后我们会得到aclocal.m4文件。 产生了configure.in和aclocal.m4两个宏文件后,我们就可以使用autoconf来产生configure文件了。 5、Makefile.am Makefile.am是用来生成Makefile.in的,需要你手工书写。Makefile.am中定义了一些内容: AUTOMAKE\_OPTIONS 这个是automake的选项。在执行automake时,它会检查目录下是否存在标准GNU软件包中应具备的各种文件,例如AUTHORS、ChangeLog、NEWS等文件。我们将其设置成foreign时,automake会改用一般软件包的标准来检查。 bin\_PROGRAMS 这个是指定我们所要产生的可执行文件的文件名。如果你要产生多个可执行文件,那么在各个名字间用空格隔开。 helloworld\_SOURCES 这个是指定产生“helloworld”时所需要的源代码。如果它用到了多个源文件,那么请使用空格符号将它们隔开。比如需要helloworld.h,helloworld.c那么请写成helloworld\_SOURCES= helloworld.h helloworld.c。 如果你在bin\_PROGRAMS定义了多个可执行文件,则对应每个可执行文件都要定义相对的filename\_SOURCES。 6、automake 我们使用automake,根据configure.in和Makefile.am来产生Makefile.in。 选项--add-missing的定义是“add missing standard files to package”,它会让automake加入一个标准的软件包所必须的一些文件。 我们用automake产生出来的Makefile.in文件是符合GNU Makefile惯例的,接下来我们只要执行configure这个shell脚本就可以产生合适的Makefile文件了。 7、Makefile 在符合GNU Makefiel惯例的Makefile中,包含了一些基本的预先定义的操作: make 根据Makefile编译源代码,连接,生成目标文件,可执行文件。 make clean 清除上次的make命令所产生的object文件(后缀为“.o”的文件)及可执行文件。 make install 将编译成功的可执行文件安装到系统目录中,一般为/usr/local/bin目录。 make dist 产生发布软件包文件(即distribution package)。这个命令将会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。它会在当前目录下生成一个名字类似“PACKAGE-VERSION.tar.gz”的文件。PACKAGE和VERSION,是我们在configure.in中定义的AM\_INIT\_AUTOMAKE(PACKAGE, VERSION)。 make distcheck 生成发布软件包并对其进行测试检查,以确定发布包的正确性。这个操作将自动把压缩包文件解开,然后执行configure命令,并且执行make,来确认编译不出现错误,最后提示你软件包已经准备好,可以发布了。 make distclean 类似make clean,但同时也将configure生成的文件全部删除掉,包括Makefile。 五、过程图示 ![2009052517385173.png][] 六、结束语 通过上面的介绍,你应该可以很容易地生成一个你自己的符合GNU惯例的Makefile文件及对应的项目文件。如果你想写出更复杂的且符合惯例的Makefile,你可以参考一些开放代码的项目中的configure.in和Makefile.am文件,比如:嵌入式数据库sqlite,单元测试cppunit。 [2009052517385173.png]: /images/20220720/db99dea9635e4dd59a7f669c28dc257f.png
还没有评论,来说两句吧...