使用過開源C/C++項目的同學們都知道，標準的編譯過程已經變成了簡單的三部曲：configure/make/make?install,?使用起來很方便，不像平時自己寫代碼，要手寫一堆復雜的Makefile，而且換個編譯環境，Makefile還需要修改（Eclipse也是這樣）。

?

這么好的東東當然要拿來用了，但GNU的Autotool系列博大精深，工具數量又多，涉及的語言也多，要是自己從頭看到尾，黃花菜都涼了，項目估計早就結束了；上網搜樣例倒是有一大堆，但都是“hello?world”的樣例，離真正完成大型項目的目標還差得遠。

?

沒有辦法，對照網上的樣例，再找幾個開源的源碼，然后參考各種Autotools的手冊，花了2天時間，終于完成了一個基本可用的Autotools。為了避免其他XDJM也浪費時間，因此將過程總結下來，就算是新年禮物，送給大家！！

?

提綱挈領：使用Autotools其實很簡單

大家不要看到那么多工具，其實使用起來很簡單，總結起來就是兩部分：

1）?按照順序調用各個工具；

2）?修改或者添加3個文件；

整個操作順序如下圖：

?

?

聽到我這么講，大家是否覺得有信心了？好的，下面我們來看具體如何操作：

1.?源碼根目錄調用autoscan腳本，生成configure.scan文件，然后將此文件重命名為configure.ac(或configure.in,早期使用.in后綴)

2.?修改【configure.ac】，利用autoconf提供的各種M4宏，配置項目需要的各種自動化探測項目

3.?編寫【自定義宏】，建議每個宏一個單獨的*.m4文件；

4.?調用aclocal收集configure.ac中用到的各種非Autoconf的宏，包括自定義宏；

5.?調用autoheader，掃描configure.ac(configure.in)、acconfig.h（如果存在），生成config.h.in宏定義文件，里面主要是根據configure.ac中某些特定宏(如AC_DEFINE)生成的#define和#undefine宏，configure在將根據實際的探測結果決定這些宏是否定義（具體見后面例子）。

6.?按照automake規定的規則和項目的目錄結構，編寫一個或多個【Makefile.am】(Makefile.am數目和存放位置和源碼目錄結構相關)，Makefile.am主要寫的就是編譯的目標及其源碼組成。

7.?調用automake，將每個Makefile.am轉化成Makefile.in，同時生成滿足GNU編碼規范的一系列文件（帶-a選項自動添加缺少的文件，但有幾個仍需要自己添加，在執行automake前需執行touch?NEWS?README?AUTHORS?ChangeLog）。如果configure.ac配置了使用libtool(定義了AC_PROG_LIBTOOL宏（老版本）或LT_INIT宏)，需要在此步驟前先在項目根目錄執行libtoolize?--automake?--copy?--force，以生成ltmain.sh，供automake和config.status調用。

8.?調用autoconf，利用M4解析configure.ac，生成shell腳本configure。以上幾步完成后，開發者的工作就算完成了，后面的定制就由開源軟件的用戶根據需要給configure輸入不同的參數來完成。

9.?用戶調用configure，生成Makefile，然后make?&&?make?install。

整個過程步驟有9步，但其中有6步你只需要簡單的敲一個命令即可，只有剩下的三步需要你動手寫一些東西，對應上面步驟中的藍色黑體字部分，而本文的重點就是如何在大型項目中完成這三歩。

?

步步為營：三步完成編譯配置

【第2步：修改configure.ac文件】

從上面的步驟可以看到，使用autoscan工具掃描后就會生成一個簡單的configure.ac文件，這已經是一個完整的configure.ac文件框架了，但還不足以達到我們的要求，因此我們要在框架里面添加一些東西：

1.1?添加AM_INIT_AUTOMAKE宏

在AC_INIT?宏下一行添加AM_INIT_AUTOMAKE([foreign?-Wall?-Werror])，中括號里面的選項可以根據需要來修改，具體請看automake手冊關于這個宏的說明。

1.2?如果需要，添加AC_CONFIG_HEADERS([config.h])宏

添加這個宏很簡單，但關鍵是“如果需要”，什么情況下需要這個宏呢？

這個宏的目的是輸出config.h，這是一個C的頭文件，里面主要是包含很多宏定義#define，說到這里其實就很明確了，輸出這個文件的目的就是提供各種相關的宏，而宏在代碼中的作用就是#ifdef，也就是說：如果你的代碼需要用到宏開關進行控制，那么就要輸出這個文件。具體的使用方法如下：

1）?首先確定代碼中需要使用什么宏來進行開關定制，確定宏的名稱，編寫和宏相關的代碼，且要包含config.h的頭文件；

2）?在configure.ac中的各種處理（例如AC_CHECK_***，AC_ARG_***）中使用AC_DEFINE宏定義C/C++的宏，名稱和上面的相同；如果是使用AC_CHECK_HEADERS，會自動添加宏定義；

3）?執行完第7歩后，Autoconf就會自動生成config?.h文件

1.3添加編譯鏈接需要的程序

編譯鏈接需要用到的程序需要添加在#?Checks?for?programs.注釋后面。對于C/C++來說，最常見的就是gcc,?g++,?靜態庫編譯、動態庫編譯，對應的選項如下：

AC_PROG_CXX

AC_PROG_CC

AC_PROG_RANLIB

如果使用libtool編譯，則選項如下，注意使用了libtool則需要將AC_PROG_RANLIB去掉

LT_INIT

1.4?在configure.ac代碼中各個部分添加自己的檢測處理

這一步是我們的主要工作，需要根據自己的項目具體情況來編寫，常見操作對應的宏和樣例請參考本文后面的“【常見操作對應的宏】”：。至于具體添加在哪個地方，configure.ac中的注釋已經清楚的告訴你了，例如：

#?Checks?for?libraries.

#?Checks?for?library?functions.

1.5?在AC_OUTPUT上一行添加AC_CONFIG_FILES宏

添加這個宏的目的是制定Autoconf輸出哪些文件，常見的文件就是Makefile文件，config.h在AC_CONFIG_HEADERS宏里面指定了，這里不需要再次指定。例如：

AC_CONFIG_FILES([Makefile?tools/Makefile?common/Makefile?worker/Makefile])

?

【第3步：編寫自定義的Autoconf宏】

Autoconf雖然提供了很多內置的宏，但在實際項目中，這些宏不可能滿足所有的要求，有的處理還是要自己完成。雖然在configure.ac文件中可以直接編寫各種處理代碼，但這樣做有幾個缺點：

1）?很不美觀：打開configure.ac文件，密密麻麻的一大段花花綠綠的Shell代碼，看著眼花繚亂；

2）?修改起來很麻煩：要找半天才能找到要修改的位置，一不小心就改錯了；

就像寫C/C++代碼要進行封裝一樣，Autoconf的處理也需要進行封裝，這個封裝就是自定宏，定義完成后在configure.ac中調用，看起來很清爽，修改也很簡單。

下面我們來看如何自定義宏：

2.1?新建一個單獨的目錄，用于存放自定義宏，一般定義為m4

2.2?新建自定義宏文件

建議每個宏一個文件，文件必須以.m4結尾，文件名就是宏名（當然如果你非要不這么做也可以，文件名隨便取）

2.3?編寫Autoconf宏

具體的編寫方式請參考Autoconf的手冊第10章節，最好邊看手冊邊對照一個開源軟件的樣例，這樣效果最好了。這里說明幾個需要注意的地方：

1）m4宏不是shell，請不要直接在文件中寫shell代碼，而要在宏的各個部分里面寫代碼；

最常見的就是if-else判斷，如果要在代碼中編寫if-else判斷，需要使用AS_IF宏，或者在其它宏里面寫，例如AC_ARG_WITH,?AC_CACHE_CHECK；

2）AC_DEFUN是定義autoconf的宏，AC_DEFINE是定義C/C++的config?.h里面的宏，不要混淆了；

2.4?運行aclocal工具，生成aclocal.m4

由于自定義宏是放在我們新建的目錄中的，configure.ac并沒有像C/C++那樣的include語句可用，因此也就找不到這些宏，這時就需要aclocal工具了：aclocal會將自定義宏編譯成configure.ac可用的宏，保存在和configure.ac同級目錄下的aclocal.m4文件中，這樣在configure.ac就能夠直接使用了。具體的編譯方法如下（m4就是你的目錄）:

aclocal?-I?m4

同時需要在根目錄下的Makefile.am中添加ACLOCAL_AMFLAGS?=?-I?m4。

?

還有一種方法是將所有的自定義宏都放入到一個acinclude.m4文件中，不過不推薦這種方法，原因是因為這種方法的缺點和直接將所有自定義宏放入configure.ac中沒有多大差別。

【第6步：編寫Makefile.am文件】

對于大型項目來說，代碼一般都是分目錄存放的，而不會像Hello?world樣例那樣簡單的就幾個文件，因此寫Makefile.am就麻煩一些，但其實主要是工作量增加了，原則都是一樣的：

原則1：每個目錄一個Makefile.am文件；同時在configure.ac的AC_CONFIG_FILES宏中指定輸出所有的Makefile文件，例如：

AC_CONFIG_FILES([Makefile?tools/Makefile?common/Makefile?worker/Makefile])

原則2：父目錄需要包含子目錄

在父目錄下的Makefile.am中添加:?SUBDIRS?=?所有子目錄，例如SUBDIRS=test?tools

原則3：Makefile.am中指明當前目錄如何編譯

前兩個原則很簡單，這里就不多說了，重點說一下如何編寫Makefile.am。

?

編寫Makefile.am主要是完成3件事情：編譯(make)、安裝(make?install)、打包(make?dist)，下面我們一一來進行講解。

3.1?編譯安裝

編譯和安裝的規則是綁定在一起的，通過同一條語句同時指定了編譯和安裝的處理方式，具體的格式為：安裝目錄_編譯類型=編譯目標

3.1.1【安裝目錄】

例如：bin_PROGRAMS?=?hello?subdir/goodbye，其中安裝目錄是bin，編譯類型是PROGRAMS，編譯目標是兩個程序hello,?goodbye.

常用缺省的安裝目錄如下

目錄	Makefile.am中的變量	使用方式
prefix	/usr/local	安裝目錄，通過--prefix指定
exec_prefix	${prefix}	同prefix
bindir	${exec_prefix}/bin	bin_編譯類型
libdir	${exec_prefix}/lib	lib_編譯類型
includedir	${prefix}/include	include_編譯類型
noinstdir	無	noinst_編譯類型，特殊的目錄，表示編譯目標不安裝。

?

除了常用的缺省目錄外，有時候我們還需要自定義目錄，例如我們希望安裝完成后安裝目錄下有一個配置文件目錄config，同時將指定的test.ini拷貝到config目錄，則config目錄需要通過自定義目錄方式定義，然后按照缺省目錄的使用方式使用。例如：?

在根目錄下的Makefile.am中添加如下內容：

configdir=${prefix}/config??=>?定義一個自定義的目錄名稱config,注意dir后綴是固定的

config_DATA=config/test.ini??=>?使用自定義的目錄config，必須要有這句，否則目錄不會創建,?=號后面如果有對應的文件，安裝時會將對應的文件拷貝到config目錄下。

?

3.1.2【編譯類型】

常見編譯類型如下，沒有自定義編譯類型

類型	說明	使用方式
PROGRAMS	可執行程序	bin_PROGRAMS
LIBRARIES	庫文件	lib_LIBRARIES
LTLIBRARIES?(Libtool?libraries)	libtool庫文件	lib_LTLIBRARIES
HEADERS	頭文件	include_HEADERS
SCRIPTS	腳本文件，有可執行權限	test_SCRIPTS（需要自定義test目錄）
DATA	數據文件，無可執行權限	conf_DATA(需要自定義conf目錄)

?

3.1.3【編譯目標】

編譯目標其實就是編譯類型對應的具體文件，其中需要make生成的文件主要有如下幾個：可執行程序_PROGRAMS，普通庫文件_LIBRARIES，libtool庫文件_LTLIBRARIES,其它類型對應的編譯目標不需要編譯，源文件就是目標文件。

??標準的編譯配置

如果你熟悉gcc的編譯命令寫法，那么Automake的Makefile.am編譯過程就很好寫了。因為Automake只是將寫在一行gcc命令里的各個不同部分的信息分開定義而已。我們來看具體是如何定義的：

_SOURCES：對應gcc命令中的源代碼文件

_LIBADD：編譯鏈接庫時需要鏈接的其它庫，對應gcc命令中的*.a等文件

_LDADD：編譯鏈接程序時需要鏈接的其他庫，對應gcc命令中的*.a等文件

_LDFLAGS：鏈接選項，對應gcc命令中的-L,?-l,?-shared,?-fpic等選項

_LIBTOOLFLAGS：libtool編譯時的選項

**FLAGS(例如_CFLAGS/_CXXFLAGS)：編譯選項，對應gcc命令中的-O2,?-g,?-I等選項

舉例如下：

#不同的編譯類型只是第一句不一樣，后面的編譯配置都是一樣的 bin_PROGRAMS=?myproject myproject_SOURCES?=?main.c myproject_LDADD???=?./utils/libutils.a?./module1/libmodule1.a?./core1/libcore.a myproject_LDFLAGS?=?-L/home/test/local?-lmemcached myproject_CFLAGS??=?-I./core1/?-I./module1/?-I./utils/?-O2?-g

?

??如何編譯可執行程序

對于大型項目來說，代碼基本上都是分目錄存放的，如果是直接寫makefile文件，一般都是將所有源文件首先編譯成*.o的文件，再鏈接成最終的二進制文件。但在Automake里面這樣是行不通的，因為你只要仔細看編譯類型表格就會發現，并沒有一種編譯類型能夠編譯*.o文件，無法像常規makefile那樣來編寫，所以就需要采取一些技巧。

其實這個技巧也很簡單：將非main函數所在目錄的文件編譯成靜態鏈接庫，然后采用鏈接靜態庫的方式編譯可執行程序。

樣例如下：

=================根目錄Makefile.am======================

#對應Makefile.am原則2 SUBDIRS?=?tools?common?worker

?

=================tool目錄Makefile.am======================

#只是為了編譯而生成的.a庫文件，沒有必要安裝,?所以是noinst noinst_LIBRARIES=libtools.a? libtools_a_SOURCES=./urlcode.h?\ ???????????????????./stringtools.cpp?\ ???????????????????./stringtools.h?\ ???????????????????./urlcode.c

?

===============common目錄Makefile.am======================

#只是為了編譯而生成的.a庫文件，沒有必要安裝,?所以是noinst noinst_LIBRARIES=libcommon.a libcommon_a_SOURCES=./iniparser.c?\ ????????????????????(省略很多文件,?實際使用時要一一填寫) ????????????????????./exception.h?\

?

==============worker目錄Makefile.am============================

bin_PROGRAMS=worker worker_SOURCES=./workeralgorithm.cpp?\ ????????????????./worker.cpp?\ ????????????????(省略很多文件,?實際使用時要一一填寫) ???????????????./worker.h #通過_LDADD告訴Automake需要鏈接哪些庫 worker_LDADD=../tools/libtools.a?../common/libcommon.a

?

??如何編譯靜態庫

Automake天然支持編譯靜態庫，只需要將編譯類型指定為_LIBRARIES即可。

?

??如何編譯動態庫

需要注意的是：_LIBRARIES只支持靜態庫(即*.a文件),而不支持編譯動態庫(*.so)文件，要編譯動態鏈接庫,需要使用_PROGRAMS。除此之外，還需要采用自定義目錄的方式避開Automake的兩個隱含的限制：

1)?如果使用bin_PROGRAMS,?則庫文件會安裝到bin目錄下，這個不符合我們對動態庫的要求；

2)?automake不允許用lib_?PROGRAMS

下面假設將utils編譯成so，采用自定義目錄的方式，修改Makefile.am如下：

mylibdir=$libdir?????????#$libdir其實就是lib目錄，請參考【安裝目錄】表格 mylib_PROGRAMS=?libutils.so libutils_so_SOURCES?=?utils.c?utils.h libutils_so_LDFLAGS?=?-shared?–fpic??#這個就是gcc編譯動態庫的選項

?

??如何編譯libtool庫

對于跨平臺可移植的庫來說，推薦使用libtool編譯，而且Automake內置了libtool的支持，只需要將編譯類型修改為_LTLIBRARIES即可。

需要注意的是：如果要使用libtool編譯，需要在configure.ac中添加LT_INIT宏，同時注釋掉AC_PROG_RANLIB，因為使用了LT_INIT后，AC_PROG_RANLIB就沒有作用了。

?

3.2?打包

Automake缺省情況下會自動打包，自動打包包含如下內容：

1)?所有源文件

2)?所有Makefile.am/Makefile.in文件

3)?configure讀取的文件

4)?Makefile.am’s?(using?include)?和configure.ac’?(using?m4_include)包含的文件

5)?缺省的文件，例如README,?ChangeLog,?NEWS,?AUTHORS

?

如果除了這些缺省的文件外，你還想將其它文件打包(一般包括靜態庫、頭文件、配置文件、幫助文件)，有如下兩種方法：

(1)?粗粒度方式：通過EXTRA_DIST來指定，指定文件就打包文件，指定目錄就打包目錄，例如：

EXTRA_DIST=conf/config.ini??test??tools/initialize.sh

如果test是目錄，那么會將test目錄下所有的文件和目錄都打包。

(2)?細粒度方式：在“安裝目錄_編譯類型=編譯目標”前添加dist(表示需要打包),?或者nodist(不需要打包)，例如：

#將data_DATA=?distribute-this打包 dist_data_DATA?=?distribute-this ? #foo_?SOURCES不打包 bin_PROGRAMS?=?foo nodist_foo_SOURCES?=?do-not-distribute.c

?

【后記】

GNU?Autotool工具博大精深，我也是結合項目的實際應用來使用的，并沒有完整的研究所有的工具，因此難免存在瑕疵和紕漏，如果大家發現有疑問或者問題的地方，歡迎大家指正。當然，GNU自己的手冊是最權威的，如果你有疑問的話，參考手冊，以手冊為準。

?

如果想了解autotools的工作原理和流程以及更高級的技巧，請參考胡華強寫的《autoconf?and?automake介紹與典型應用.doc》。

?

【常見操作對應的宏】

1）給./configure添加--with-package參數，例如：./configure??--with-libmemcached

AC_ARG_WITH，具體如何寫請參考autoconf手冊15.2章節，里面給了一個完整的樣例。

2）給./configure添加?–enable-feature參數，例如：./configure?–enable-multithread

AC_ARG_ENABLE，顧名思義，這個宏的意思就是打開開關，這個開關可以是編譯開關，也可以是代碼功能開關，如果是編譯開關，則要配合AM_CONDITIONAL宏來使用（樣例請看automake手冊20.1章節的AM_CONDITIONAL宏說明）；如果是代碼功能開關，則要配合AC_DEFINE宏來使用（請參考autoconf手冊15.2章節的AC_ARG_WITH宏的樣例）

3）在./configure的時候檢查頭文件

AC_CHECK_HEADER:?檢查一個頭文件

AC_CHECK_HEADERS：檢查一批頭文件

4）在./configure時檢查庫文件

AC_CHECK_LIB：樣例請參考autoconf手冊15.2章節的AC_ARG_WITH宏的樣例

5）修改make行為

如果你想修改默認的make行為，可以先使用AC_ARG_WITH或者AC_ARG_ENABLE添加./configure參數，再結合如下兩個宏來完成：

AM_CONDITIONAL：在./configure.ac中增加一個automake宏，在Makefile.am中使用if-else-endif來使用宏；

AC_SUBST：在./configure.ac中直接修改automake的變量，例如AM_CXXFLAGS，AM_CFLAGS等編譯鏈接。

?

【參考資料】

1. 入門材料：http://sources.redhat.com/autobook/autobook/autobook_toc.html?。

2. autoconf手冊：http://www.gnu.org/software/autoconf/manual/autoconf.html?。

3. automake手冊：http://sources.redhat.com/automake/automake.html?。

4. libtool手冊：http://www.gnu.org/software/libtool/manual/libtool.html?

5. tutorial：http://www.lrde.epita.fr/~adl/dl/autotools.pdf?。

分類:?C

總結

以上是生活随笔為你收集整理的大型项目使用Automake/Autoconf完成编译配置的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。