經(jīng)常使用Linux的開(kāi)發(fā)人員或者運(yùn)維人員，可能對(duì)configure->make->make install相當(dāng)熟悉。事實(shí)上，這叫GNU構(gòu)建系統(tǒng)，利用腳本和make程序在特定平臺(tái)上構(gòu)建軟件。這種方式成為一種習(xí)慣，被廣泛使用。本文從用戶視角和開(kāi)發(fā)者視角詳細(xì)說(shuō)明，這種構(gòu)建方式的細(xì)節(jié)，以及開(kāi)發(fā)者如何利用autoconf和automake等工具(autotools)創(chuàng)建兼容GNU構(gòu)建系統(tǒng)的項(xiàng)目。

為了簡(jiǎn)化可移植構(gòu)建的難度，在早期有一套autotools工具幫助程序員構(gòu)建軟件。我們熟知的configure->make->make install三部曲，大多都是基于autotools來(lái)構(gòu)建的。autotools是GNU程序的標(biāo)準(zhǔn)構(gòu)建系統(tǒng)，所以其實(shí)我們經(jīng)常在使用三部曲。有些程序雖然也是這三部曲，但卻不是用autotools實(shí)現(xiàn)的，比如nginx的源碼就是作者自己編寫(xiě)的構(gòu)建程序。

用戶視角

用戶通過(guò)configure->make->make install基于源碼安裝軟件。然而大部分用戶可能并不知道這個(gè)過(guò)程究竟做了些什么。

configure腳本是由軟件開(kāi)發(fā)者維護(hù)并發(fā)布給用戶使用的shell腳本。這個(gè)腳本的作用是檢測(cè)系統(tǒng)環(huán)境，最終目的是生成Makefile和config.h。

make通過(guò)讀取Makefile文件，開(kāi)始構(gòu)建軟件。而make install可以將軟件安裝到需要安裝的位置。

 如上圖，開(kāi)發(fā)者在分發(fā)源碼包時(shí)，除了源代碼(.c .h...)，還有許多用以支撐軟件構(gòu)建的文件和工具，其中最重要的文件就是Makefile.in和config.h.in。configure腳本執(zhí)行成功后，將為每一個(gè)*.in文件處理成對(duì)應(yīng)的非*.in文件。

大部分情況只生成Makefile和config.h，因?yàn)镸akefile用于make程序識(shí)別并構(gòu)建軟件，而config.h中定義的宏，有助于軟件通過(guò)預(yù)編譯來(lái)改變自身的代碼，以適應(yīng)目標(biāo)平臺(tái)某些特殊性。有些軟件在configure階段，還可以生成其他文件，這完全取決于如軟件本身。

configure

當(dāng)運(yùn)行configure時(shí)，將看到類似如下的系統(tǒng)檢查，這些檢查的多少取決于軟件本身的需要，也就是由軟件開(kāi)發(fā)者來(lái)定義和編寫(xiě)的。

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... gawk 
checking whether make sets $(MAKE)... yes 
checking for gcc... gcc 
checking for C compiler default output file name... a.out 
...  

一般來(lái)說(shuō)，configure主要檢查當(dāng)前目標(biāo)平臺(tái)的程序、庫(kù)、頭文件、函數(shù)等的兼容性。這些檢查結(jié)果將作用于config.h和Makefile文件的生成。從而影響最終的編譯。

用戶也可以通過(guò)給configure配置參數(shù)來(lái)定制軟件需要包含或不需要包含的組件、安裝路徑等行為。這些參數(shù)分為5組，可以通過(guò)執(zhí)行./configure --help來(lái)查看，軟件提供哪些配置參數(shù)：

• *安裝路徑相關(guān)配置。最常見(jiàn)的是--prefix。
• *程序名配置。例如--program-suffix可用于為生成的程序添加后綴。
• *跨平臺(tái)編譯。不太常用。
• *動(dòng)態(tài)庫(kù)靜態(tài)庫(kù)選項(xiàng)。用于控制是否生成某種類型的庫(kù)文件。
• 程序組件選項(xiàng)。用于配置程序是否將某種功能編譯到程序中，一般形如--with-xxx。這可能是最常用的配置，而且由軟件開(kāi)發(fā)者來(lái)定義。

(*表示這是幾乎所有軟件都支持的配置，因?yàn)檫@些配置是autotool生成的configure腳本默認(rèn)支持的。)

configure在執(zhí)行過(guò)程中，除了生成Makefile外，還會(huì)生成的文件包括但不限于：

• config.log 日志文件
• config.cache 緩存，以提高下一次configure的速度，需通過(guò)-C來(lái)指定才會(huì)生成
• config.status 實(shí)際調(diào)用編譯工具構(gòu)建軟件的shell腳本

 如果軟件通過(guò)libtool構(gòu)建，還會(huì)生成libtool腳本。關(guān)于libtool腳本如何生成，請(qǐng)看開(kāi)發(fā)者視角。

configure經(jīng)常會(huì)中途出錯(cuò)，這一般是由于當(dāng)前平臺(tái)不具有構(gòu)建該軟件所必需的依賴(庫(kù)、函數(shù)、頭文件、程序...)。此時(shí)，不要慌張，仔細(xì)查看輸出，解決這些依賴。

開(kāi)發(fā)者視角

開(kāi)發(fā)者除了編寫(xiě)軟件本身的代碼外，還需要負(fù)責(zé)生成構(gòu)建軟件所需要文件和工具。當(dāng)我接觸到autotools后，我發(fā)現(xiàn)，雖然有工具的幫助，但這件事情依舊十分復(fù)雜。

對(duì)于C或C++程序員，在早期，構(gòu)建跨平臺(tái)的應(yīng)用程序是相當(dāng)繁瑣的一件事情，而且對(duì)于經(jīng)驗(yàn)不足的程序員而言，甚至難度巨大。因?yàn)闃?gòu)建可移植的程序的必要前提是對(duì)各個(gè)平臺(tái)足夠了解，這往往要花上相當(dāng)長(zhǎng)的時(shí)間去積累。

Unix系統(tǒng)的分支復(fù)雜度很高，不同的商用版或開(kāi)源版或多或少都有差異。這些差異主要體現(xiàn)在：系統(tǒng)組件、系統(tǒng)調(diào)用。我們主要將Unix分為如下幾個(gè)大類：IBM-AIX HP-UX Apple-DARWIN Solaris Linux FreeBSD。Unix分支大全

因此，對(duì)于開(kāi)發(fā)者而言，要么自己編寫(xiě)構(gòu)建用的腳本，這往往需要極其扎實(shí)的shell能力和平臺(tái)熟悉度。另一個(gè)選擇就是部分依賴工具。autoconf和automake就是這樣的工具。

autoreconf

為了生成configure腳本和Makefile.in等文件，開(kāi)發(fā)者需要?jiǎng)?chuàng)建并維護(hù)一個(gè)configure.ac文件(在早期，通常叫configure.in文件，雖然沒(méi)有區(qū)別，但強(qiáng)烈建議使用.ac，因?yàn)?in文件往往意味著被configure腳本識(shí)別為模板文件并生成直接參與最終構(gòu)建的文件，configure.in在命名上有歧義),以及一系列的Makefile.am。autoreconf程序能夠自動(dòng)按照合理的順序調(diào)用autoconfautomake aclocal等程序。

 configure.ac

configure.ac用于生成configure腳本。autoconf工具用來(lái)完成這一步。下面是一個(gè)configure.ac的例子：

AC_PREREQ([2.63]) 
AC_INIT([st], [1.0], [zhoupingtkbjb@163.com]) 
AC_CONFIG_SRCDIR([src/main.c]) 
AC_CONFIG_HEADERS([src/config.h]) 
 
AM_INIT_AUTOMAKE([foreign]) 
 
 
# Checks for programs. 
AC_PROG_CC 
AC_PROG_LIBTOOL 
 
# Checks for libraries. 
 
# Checks for header files. 
 
# Checks for typedefs, structures, and compiler characteristics. 
 
# Checks for library functions. 
 
AC_CONFIG_FILES([Makefile 
                 src/Makefile 
                 src/a/Makefile 
                 src/b/Makefile]) 
AC_OUTPUT  

其中以AC_開(kāi)頭的類似函數(shù)調(diào)用一樣的代碼，實(shí)際是一些被稱為“宏”的調(diào)用。這里的宏與C中的宏概念類似，會(huì)被替換展開(kāi)。m4是一個(gè)經(jīng)典的宏工具，autoconf正是構(gòu)建在m4之上，可以理解為autoconf預(yù)先實(shí)現(xiàn)了大量的，用于檢測(cè)系統(tǒng)可移植性的宏，這些宏在展開(kāi)后就是大量的shell腳本。所以編寫(xiě)configure.ac需要對(duì)這些宏熟練掌握，并且合理調(diào)用。有時(shí)，甚至可以自己實(shí)現(xiàn)自己的宏。

autoscan和configure.scan

可以通過(guò)調(diào)用autoscan命令得到一個(gè)初始化的configure.scan文件，然后重命名為configure.ac后，在此基礎(chǔ)上編輯configure.ac。autoscan會(huì)掃描源碼，并生成一些通用的宏調(diào)用、輸入的聲明以及輸出的聲明。盡管autoscan十分方便，但是沒(méi)人能夠在構(gòu)建之前，就把代碼完全寫(xiě)好，因此autoscan通常用于初始化configure.ac。

autoheader和config.h

autoheader命令掃描configure.ac中的內(nèi)容，并確定需要如何生成config.h.in。每當(dāng)configure.ac有所變化，都可以通過(guò)再次執(zhí)行autoheader更新config.h.in。在configure.ac通過(guò)AC_CONFIG_HEADERS([config.h])告訴autoheader應(yīng)當(dāng)生成config.h.in的路徑。在實(shí)際的編譯階段，生成的編譯命令會(huì)加上-DHAVE_CONFIG_H定義宏，于是在代碼中，我們可以通過(guò)下面代碼安全的引用config.h。 

/bin/sh ../../libtool --tag=CC --mode=compile gcc -DHAVE_CONFIG_H ...  

#ifdef HAVE_CONFIG_H 
#include <config.h> 
#endif  

config.h包含了大量的宏定義，其中包括軟件包的名字等信息，程序可以直接使用這些宏;更重要的是，程序可以根據(jù)其中的對(duì)目標(biāo)平臺(tái)的可移植性相關(guān)的宏，通過(guò)條件編譯，動(dòng)態(tài)的調(diào)整編譯行為。

automake和Makfile.am

手工編寫(xiě)Makefile是一件相當(dāng)煩瑣的事情，而且，如果項(xiàng)目復(fù)雜的話，編寫(xiě)難度將越來(lái)越大。因而，automake工具應(yīng)運(yùn)而生。我們可以編寫(xiě)像下面這樣的Makefile.am文件，并依靠automake來(lái)生成Makefile.in： 

SUBDIRS = a b 
bin_PROGRAMS    = st 
st_SOURCES        = main.c 
st_LDADD        = $(top_builddir)/src/a/liba.la $(top_builddir)/src/b/libb.la   

這里通過(guò)SUBDIRS聲明了兩個(gè)子目錄，子目錄的中的構(gòu)建需要靠a/Makefile.am和b/Makefile.am來(lái)進(jìn)行，這樣多目錄組織起來(lái)就方便多了。

bin_PROGRAMS聲明一個(gè)可執(zhí)行文件目標(biāo)，st_SOURCES指定這個(gè)目標(biāo)所依賴的源代碼文件。另外，st_LDADD聲明了可執(zhí)行文件在連接時(shí)，需要依賴的Libtool庫(kù)文件。

通過(guò)這個(gè)Makefile.am文件生成的Makefile.in文件相當(dāng)大，不便貼出，但是可以想象，Makefile.in要比我們手工編寫(xiě)的Makefile文件復(fù)雜的多。

automake的出現(xiàn)晚于autoconf，所以automake是作為autoconf的擴(kuò)展來(lái)實(shí)現(xiàn)的。通過(guò)在configure.ac中聲明AM_INIT_AUTOMAKE告訴autoconf需要配置和調(diào)用automake。

aclocal

上面提到，configure.ac實(shí)際是依靠宏展開(kāi)來(lái)得到configure的。因此，能否成功生成取決于，宏定義能否找到。autoconf會(huì)從自身安裝路徑下來(lái)尋找事先定義好了宏。然而對(duì)于像automake、libtool和gettext等第三方擴(kuò)展宏，甚至是開(kāi)發(fā)者自行編寫(xiě)的宏就一無(wú)所知了。于是，存在這個(gè)工具aclocal，將在configure.ac同一目錄下生成aclocal.m4，在掃描configure.ac的過(guò)程中，將第三方擴(kuò)展和開(kāi)發(fā)者自己編寫(xiě)的宏定義復(fù)制進(jìn)去。這樣，autoconf在遇到不認(rèn)識(shí)的宏時(shí)，就會(huì)從aclocal.m4中查找。

下面這張圖更為詳細(xì)的展現(xiàn)了整個(gè)工具鏈?zhǔn)侨绾位ハ嗯浜系摹?/p>

 libtool

libtool試圖解決不同平臺(tái)下，庫(kù)文件的差異。libtool實(shí)際是一個(gè)shell腳本，實(shí)際工作過(guò)程中，調(diào)用了目標(biāo)平臺(tái)的cc編譯器和鏈接器，以及給予合適的命令行參數(shù)。libtool可以單獨(dú)使用，這里只介紹與autotools集成使用相關(guān)的內(nèi)容。

automake支持libtool構(gòu)建聲明。在Makefile.am中，普通的庫(kù)文件目標(biāo)寫(xiě)作xxx_LIBRARIES： 

noinst_LIBRARIES = liba.a 
liba_SOURCES = ao1.c ao2.c ao3.c 

 而對(duì)于一個(gè)libtool目標(biāo)，寫(xiě)作xxx_LTLIBRARIES，并以.la作為后綴聲明庫(kù)文件。 

noinst_LTLIBRARIES = liba.la 
liba_la_SOURCES = ao1.c ao2.c ao3.c  

在configure.ac中需要聲明LT_INIT： 

... 
AM_INIT_AUTOMAKE([foreign]) 
LT_INIT 
... 

 有時(shí)，如果需要用到libtool中的某些宏，則推薦將這些宏copy到項(xiàng)目中。首先，通過(guò)AC_CONFIG_MACRO_DIR([m4])指定使用m4目錄存放第三方宏;然后在最外層的Makefile.am中加入ACLOCAL_AMFLAGS = -I m4。

all-in-one

上面討論了很多關(guān)于autoreconf的細(xì)節(jié)。實(shí)際上，如今我們可以直接調(diào)用autoreconf --install來(lái)自動(dòng)調(diào)用上面提到的所有子命令。這里--install參數(shù)試圖將輔助的腳本和宏copy到當(dāng)前項(xiàng)目目錄中，下面是執(zhí)行時(shí)的輸出： 

autoreconf: Entering directory `.' 
autoreconf: configure.ac: not using Gettext 
autoreconf: running: aclocal  
autoreconf: configure.ac: tracing 
autoreconf: running: libtoolize --copy 
libtoolize: putting auxiliary files in `.'. 
libtoolize: copying file `./ltmain.sh' 
libtoolize: Consider adding `AC_CONFIG_MACRO_DIR([m4])' to configure.ac and 
libtoolize: rerunning libtoolize, to keep the correct libtool macros in-tree. 
libtoolize: Consider adding `-I m4' to ACLOCAL_AMFLAGS in Makefile.am. 
autoreconf: running: /usr/bin/autoconf 
autoreconf: running: /usr/bin/autoheader 
autoreconf: running: automake --add-missing --copy --no-force 
configure.ac:10: installing `./config.guess' 
configure.ac:10: installing `./config.sub' 
configure.ac:9: installing `./install-sh' 
configure.ac:9: installing `./missing' 
src/Makefile.am: installing `./depcomp' 
autoreconf: Leaving directory `.'  

當(dāng)我們以--install參數(shù)運(yùn)行時(shí)，libtoolize --copy被調(diào)用，這將使得ltmain.sh被copy進(jìn)來(lái);接下來(lái)分別執(zhí)行autoconf和autoheader;automake的參數(shù)為--add-missing --copy --no-force，這將使得幾個(gè)輔助腳本和文件被安裝到目錄下。

這些輔助文件默認(rèn)安裝在configure.ac同一個(gè)目錄下，如果你希望用另一個(gè)目錄來(lái)存放他們，可以配置AC_CONFIG_AUX_DIR，例如AC_CONFIG_AUX_DIR([build-aux])將使用build-aux目錄來(lái)存放輔助文件。

如果不使用--install參數(shù)，輔助文件要么不copy，要么以軟鏈的形式創(chuàng)建。推薦使用--install，因?yàn)檫@樣，其他軟件維護(hù)可以避免由于構(gòu)建工具版本不一致造成問(wèn)題。

輔助文件

一個(gè)依靠GNU構(gòu)建系統(tǒng)開(kāi)發(fā)的軟件除了源碼之外，還有很多輔助的文件，有些是腳本，有些是文本文件。下面將逐一解釋這些文件：

• aclocal.m4：上面提到了，這個(gè)宏定義文件里面包含了第三方的宏定義，用于autoconf展開(kāi)configure.ac
• NEWS README AUTHORS ChangeLog：這些文件是GNU軟件的標(biāo)配，不過(guò)在項(xiàng)目中不一定需要加入。如果項(xiàng)目中沒(méi)有這些文件，每次autoreconf會(huì)提示缺少文件，不過(guò)這并不影響。如果不想看到這些錯(cuò)誤提示，可以用AM_INIT_AUTOMAKE([foreign])來(lái)配置automake。foreign參數(shù)就是告訴automake不要這么較真:)
• config.guess config.sub：由automake產(chǎn)生，兩個(gè)用于目標(biāo)平臺(tái)檢測(cè)的腳本
• depcomp install-sh：由automake產(chǎn)生，用于完成編譯和安裝的腳本
• missing：由automake產(chǎn)生
• ltmain.sh：有l(wèi)ibtoolize產(chǎn)生，該腳本用于在configure階段配置生成可運(yùn)行于目標(biāo)平臺(tái)的libtool腳本
• ylwrap：由automake產(chǎn)生，如果檢測(cè)構(gòu)建需要使用lex和yacc，那么會(huì)產(chǎn)生這個(gè)包裝腳本
• autogen.sh：在早期，autoreconf并不存在，軟件開(kāi)發(fā)者往往需要自己編寫(xiě)腳本，按照順序調(diào)用autoconf autoheaderautomake等工具程序。這個(gè)文件就是這樣的腳本。起這么個(gè)名字可能是習(xí)慣性的

總結(jié)

本文總概念上闡述了autotool系列工具是如何工作的。相比如今現(xiàn)成的IDE，GNU構(gòu)建系統(tǒng)其實(shí)是非常難用的，學(xué)習(xí)成本比較高。筆者認(rèn)為最為效率的途徑是學(xué)習(xí)開(kāi)源的程序，從中慢慢體會(huì)，慢慢吸收。另外，推薦幾個(gè)資料：

• 《GNU Autoconf Automake and Libtool》
•  Autotools Tutorial
• GNU網(wǎng)站上關(guān)于autoconf automake 和 libtool的手冊(cè) 

筆者還有一些相關(guān)的筆記，后面再另外寫(xiě)一篇文章總結(jié)一下。