Autoconf介绍李俊良2009/06/18内容大纲目的Autoconf简单介绍Autoconf框架图Autoconf流程(过程)Autoconf小结以及和rpm结合FAQ目的如何方便在linux系统上写c/c++的工程的一种技巧,从而提高工程化的能力;方便的阅读开源代码;容易理解整个工程源码的架构;写出优秀而漂亮的代码框架。AutoConf简单介绍今天我们一起来了解一下关于自动化编译的神秘面纱。无论是在Linux还是在Unix环境中,make都是一个非常重要的编译命令。可以通过查阅make的帮助文档来手工编写Makefile,当然我们更愿意自动生成Makefile。要想了解更多的自动化编译的知识,不仅仅要熟悉Makefile的语法,还要熟悉m4规则。实践还证明:光靠这些规则理论是不够的,我们要学会在实践中创造规则、完善理论。AutoConf框架图autoscaneditaclocalautoconfautoheaderautomake./configureAutoconf流程—autoscan在开始antoconf之前,了解一下Autoconf依赖于:Bash,Coreutils,Diffutils,Grep,M4,Make,Perl,Sed.autoscan程序可以用来为软件包创建configure.in文件。autoscan在以命令行参数中指定的目录为根(如果未给定参数,则以当前目录为根)的目录树中检查源文件。它为通常的轻便问题搜索源文件,并且为那个包创建一个configure.scan文件,这个文件就是configure.in的前身。autoscan程序是perl语言写的。AutoConf框架图autoscaneditaclocalautoconfautoheaderautomake./configureAutoconf流程—edit(一)configure.in由configure.scan文件更名而来,文件内容都是以AC_INIT开头,以AC_OUTPUT结束。confiugre.in文件的一般布局–AC_INIT–测试程序–测试函数库–测试头文件–测试类型定义–测试结构–测试编译器特性–测试库函数–测试系统调用–AC_OUTPUT宏含义AC_CHECK_LIB(library,function,[action-if-found],[action-if-not-found],[other-libraries])该宏用来检查lib库中是否存在指定的函数。当测试成功时,执行shell命令action_if_found或者action_if_found当为空时,在输出变量LIBS中添加-llib。action_if_not_found把-lother_libs选项传给link命令Autoconf流程—edit(二)宏定义含义AC_INIT(FILE)用来检查源代码所在的路径。AM_INIT_AUTOMAKE(PACKAGE,VERSION)这个宏是必须的,它描述了我们将要生成的软件包的名字及其版本号:PACKAGE是软件包的名字,VERSION是版本号。当你使用makedist命令时,它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包,其中就有对应的软件包的名字和版本号。AC_PROG_CC检查系统所用的C编译器。AC_OUTPUT(FILE)要输出的Makefile的名字。AutoConf框架图autoscaneditaclocalautoconfautoheaderautomake./configureAutoconf流程—aclocalaclocal也是一个perl脚本程序,aclocal根据configure.in文件的内容,自动生成aclocal.m4文件。m4是传统Unix的宏处理的安装启动的应用,其对应的是.m4文件记录了很多无法理解的宏。相关的介绍见官方网站:框架图autoscaneditaclocal幻灯片9autoconfautoheaderautomake./configureAutoconf流程—autoheader负责生成config.h.in文件。该工具通常会从“acconfig.h”文件中复制用户附加的符号定义,因此此处没有附加符号定义,所以不需要创建“acconfig.h”文件。AutoConf框架图autoscaneditaclocalautoconfautoheaderautomake./configureAutoconf流程—automakebin_PROGRAMS=foofoo_SOURCES=foo_LDADD=foo_LDFLAGS=foo_DEPENDENCIES=可执行文件lib_LIBRARIES=libfoo.afoo_a_SOURCES=foo_a_LDADD=foo_a_LIBADD=foo_a_LDFLAGS=静态库automake要用的脚本配置文件是Makefile.am,用户需要自己创建相应的文件。之后,automake工具转换成Makefile.in。automake有相对应的一些参数可以配置,比如-a等等Autoconf流程—automake目前automake支持三种目录层次:flat、shallow和deep。–Flat指的是所有文件都位于同一个目录中•就是所有源文件、头文件以及其他库文件都位于当前目录中,且没有子目录。Termutils就是这一类。–shallow指的是主要的源代码都储存在顶层目录,其他各个部分则储存在子目录中。•就是主要源文件在当前目录中,而其它一些实现各部分功能的源文件位于各自不同的目录。Automake本身就是这一类。–deep指的是所有源代码都被储存在子目录中;顶层目录主要包含配置信息。•就是所有源文件及自己写的头文件位于当前目录的一个子目录中,而当前目录里没有任何源文件。GNUcpio和GNUtar就是这一类。Yahoo的ydm、dcp等工程也属于这一类。flat类型是最简单的,deep类型是最复杂的。但是实际工程中我们经常用到的是deep类型的。Autoconf流程—automakeinclude_HEADERS–头文件data_DATA–数据文件AUTOMAKE_OPTIONS–由于GNU对自己发布的软件有严格的规范,比如必须附带许可证声明文件COPYING等,否则automake执行时会报错。automake提供了三种软件等级:foreign、gnu和gnits,让用户选择采用,默认等级为gnu。在本例使用foreign等级,它只检测必须的文件。bin_PROGRAMS或lib_LINRARIES–定义要产生的执行文件名。如果要产生多个执行文件,每个文件名用空格隔开。–对于可执行文件和静态库类型,如果只想编译,不想安装到系统中,可以用noinst_PROGRAMS代替bin_PROGRAMS,noinst_LIBRARIES代替lib_LIBRARIES。Autoconf流程—automakeMakefile.am还提供了一些全局变量供所有的目标体使用:INCLUDES–链接时所需要的头文件LDADD–链接时所需要的库文件LDFLAGS–链接时所需要的库文件选项标志EXTRA_DIST–源程序和一些默认的文件将自动打入.tar.gz包,其它文件若要进入.tar.gz包可以用这种办法,比如配置文件,数据文件等等。SUBDIRS–在处理本目录之前要递归处理哪些子目录makefile.am中尽量使用相对路径,系统预定义了两个基本路径:1,$(top_srcdir)工程最顶层目录,用于引用源程序2,$(top_builddir)定义了生成目标文件上最上层目录,用于引用.o等编译出来的目标文件。AutoConf框架图autoscaneditaclocalautoconfautoheaderautomake./configureAutoconf流程—autoconfautoconf是一个用于生成可以自动地配置软件源码包,用以适应多种UNIX类系统的shell脚本工具,其中autoconf需要用到m4,便于生成脚本。通过configure.in和aclocal.m4文件,使用autoconf生成configure文件,很复杂的configure文件吧!运行configure文件,生成了我们要的Makefile文件Autoconf小结—补充Libtool工具添加需要注意libtoolize步骤针对CFLAGS和CXXFLAGS对默认GNU的编译选项的更改针对一个lib可以拆分成两个libdata_DATA需要指定datadir变量的位置AC_HEADER_STDC等宏的合理添加makedist等各种包的打法autoreconf的使用Autoconf小结—rpm方案我们知道生成rpm,需要用到一个spec文件,来注明rpm包的信息。在工程项目中一般通常解决方法是在文件的根目录放一个*.spec.in(用来生成spec文件)或spec文件,这里我结合了.rpmmacros采用了生成spec文件的方式:–#definerpmbuildroot–RPMBUILDTOPDIR=$(shellunsetRPMBUILDTOPDIR;if[-f${HOME}/.rpmmacros];thenexportRPMBUILDTOPDIR=`grep_topdir${HOME}/.rpmmacros|awk'{print$$2}'`;elseexportRPMBUILDTOPDIR=/usr/src/redhat;fi;echo$${RPMBUILDTOPDIR};)–或–RPMBUILDTOPDIR=$(shellecho$(rpm--showrc|grep'_topdir'|awk'{print$3}’))Autoconf小结—rpm方案下面的这些有点像Makefile吧,但是这个是在Makefile.am文件中:–.PHONY:rpm–rpm:dist@PACKAGE@.spec–$(RM)${RPMBUILDTOPDIR}/SOURCES/$(distdir).tar.gz–$(RM)${RPMBUILDTOPDIR}/SPECS/@PACKAGE@.spec–$(LN_S)`pwd`/$(distdir).tar.gz${RPMBUILDTOPDIR}/SOURCES–$(LN_S)`pwd`/@PACKAGE@.spec${RPMBUILDTOPDIR}/SPECS–rpmbuild-ba${RPMBUILDTOPDIR}/SPECS/@PACKAGE@.spec这样,我就可以通过makerpm命令来生成rpm了,值得注意的是如果没有在.rpmmacros文件内指定_topdir,则需要sudo权限来根据系统变量来生成rpm。AutoconfFAQ依赖的其他项目是从代码编译的,同时他们的makefile是自己写的一套–其他项目从代码进行编译的话,可以一次性把编译好的lib和头文件放到你工程下的lib和include目录下,而不是你每次修改自己工程的源文件都需要make一下其他的项目。–我们的目的并不是让别人遵从我们的想法,而是宣扬我们的想法是多么的好,甚至你有更好的想法,我们会一起改进autoconf。make的时候发生的错误有时候奇奇怪怪的,比如链接起来了其他代码片段–一般在make出现错误了,可以从错误代码原因进行分析,只要你遵守“游戏规则”,是不会产生链接到其它的代码片段的。这个autoconf如何和java源码一起编译–我们可以写Makefile.am,方法如同写Makefile一样,把java里面的编译器,比如ant包含进来,完成我们的make过程即可。Autoconf流程—rpm方案