例解 autoconf 和 automake 生成 Makefile 檔案
引子
無論是在Linux還是在Unix環境中，make都是一個非常重要的編譯命令。不管是自己進行專案開發還是安裝應用軟體，我們都經常要用到make或 make install。利用make工具，我們可以將大型的開發專案分解成為多個更易於管理的模組，對於一個包括幾百個原始檔的應用程式，使用make和 makefile工具就可以輕而易舉的理順各個原始檔之間紛繁複雜的相互關係。
但是如果通過查閱make的幫助文件來手工編寫Makefile,對任何程式設計師都是一場挑戰。幸而有GNU 提供的Autoconf及Automake這兩套工具使得編寫makefile不再是一個難題。
本文將介紹如何利用 GNU Autoconf
模擬需求
假設原始檔按如下目錄存放，如圖1所示，運用autoconf和automake生成makefile檔案。
圖 1檔案目錄結構
假設src是我們原始檔目錄，include目錄存放其他庫的標頭檔案，lib目錄存放用到的庫檔案，然後開始按模組存放，每個模組都有一個對應的目錄，模組下再分子模組，如apple、orange。每個子目錄下又分core，include，shell三個目錄，其中core和shell目錄存放.c檔案，include的存放.h檔案，其他類似。
樣例程式功能：基於多執行緒的資料讀防寫（聯絡作者獲取整個autoconf和automake生成的Makefile工程和原始碼，E-mail：[email protected]）。
工具簡介
所必須的軟體：autoconf/automake/m4/perl/libtool（其中libtool非必須）。autoconf是一個用於生成可以自動地配置軟體原始碼包，用以適應多種UNIX類系統的shell指令碼工具，其中autoconf需要用到 m4，便於生成指令碼。automake是一個從Makefile.am檔案自動生成Makefile.in的工具。為了生成Makefile.in，automake還需用到perl
目前automake支援三種目錄層次：flat、shallow和deep。
1) flat指的是所有檔案都位於同一個目錄中。
就是所有原始檔、標頭檔案以及其他庫檔案都位於當前目錄中，且沒有子目錄。Termutils就是這一類。
2) shallow指的是主要的原始碼都儲存在頂層目錄，其他各個部分則儲存在子目錄中。
就是主要原始檔在當前目錄中，而其它一些實現各部分功能的原始檔位於各自不同的目錄。automake本身就是這一類。
3) deep指的是所有原始碼都被儲存在子目錄中；頂層目錄主要包含配置資訊。
就是所有原始檔及自己寫的標頭檔案位於當前目錄的一個子目錄中，而當前目錄裡沒有任何原始檔。 GNU cpio和GNU tar就是這一類。
flat型別是最簡單的，deep型別是最複雜的。不難看出，我們的模擬需求正是基於第三類deep型，也就是說我們要做挑戰性的事情：)。注：我們的測試程式是基於多執行緒的簡單程式。
生成 Makefile 的來龍去脈
首先進入 project 目錄，在該目錄下執行一系列命令，建立和修改幾個檔案，就可以生成符合該平臺的Makefile檔案，操作過程如下：
1) 執行autoscan命令
2) 將configure.scan 檔案重新命名為configure.in，並修改configure.in檔案
3) 在project目錄下新建Makefile.am檔案，並在core和shell目錄下也新建makefile.am檔案
4) 在project目錄下新建NEWS、 README、 ChangeLog 、AUTHORS檔案
5) 將/usr/share/automake-1.X/目錄下的depcomp和complie檔案拷貝到本目錄下
6) 執行aclocal命令
7) 執行autoconf命令
8) 執行automake -a命令
9) 執行./confiugre指令碼
可以通過圖2看出產生Makefile的流程，如圖所示：
圖 2生成Makefile流程圖
Configure.in的八股文
當我們利用autoscan工具生成confiugre.scan檔案時，我們需要將confiugre.scan重新命名為confiugre.in檔案。confiugre.in呼叫一系列autoconf巨集來測試程式需要的或用到的特性是否存在，以及這些特性的功能。
下面我們就來目睹一下confiugre.scan的廬山真面目：
# Process this file with autoconf to produce a configure script.
AC_PREREQ(2.59)
AC_INIT(FULL-PACKAGE-NAME, VERSION, BUG-REPORT-ADDRESS)
AC_CONFIG_SRCDIR([config.h.in])
AC_CONFIG_HEADER([config.h])
# Checks for programs.
AC_PROG_CC
# Checks for libraries.
# FIXME: Replace `main' with a function in `-lpthread':
AC_CHECK_LIB([pthread], [main])
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_OUTPUT每個configure.scan檔案都是以AC_INIT開頭，以AC_OUTPUT結束。我們不難從檔案中看出confiugre.in檔案的一般佈局：
AC_INIT
測試程式
測試函式庫
測試標頭檔案
測試型別定義
測試結構
測試編譯器特性
測試庫函式
測試系統呼叫
AC_OUTPUT上面的呼叫次序只是建議性質的，但我們還是強烈建議不要隨意改變對巨集呼叫的次序。
現在就開始修改該檔案：
$mv configure.scan configure.in
$vim configure.in修改後的結果如下：
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ(2.59)
AC_INIT(test, 1.0, [email protected])
AC_CONFIG_SRCDIR([src/ModuleA/apple/core/test.c])
AM_CONFIG_HEADER(config.h)
AM_INIT_AUTOMAKE(test,1.0)
# Checks for programs.
AC_PROG_CC
# Checks for libraries.
# FIXME: Replace `main' with a function in `-lpthread':
AC_CHECK_LIB([pthread], [pthread_rwlock_init])
AC_PROG_RANLIB
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_OUTPUT([Makefile
src/lib/Makefile
src/ModuleA/apple/core/Makefile
src/ModuleA/apple/shell/Makefile
])其中要將AC_CONFIG_HEADER([config.h])修改為：AM_CONFIG_HEADER(config.h), 並加入AM_INIT_AUTOMAKE(test,1.0)。由於我們的測試程式是基於多執行緒的程式，所以要加入AC_PROG_RANLIB，不然執行automake命令時會出錯。在AC_OUTPUT輸入要建立的Makefile檔名。
由於我們在程式中使用了讀寫鎖，所以需要對庫檔案進行檢查，即AC_CHECK_LIB([pthread], [main])，該巨集的含義如下：
其中，LIBS是link的一個選項，詳細請參看後續的Makefile檔案。由於我們在程式中使用了讀寫鎖，所以我們測試pthread庫中是否存在pthread_rwlock_init函式。
由於我們是基於deep型別來建立makefile檔案，所以我們需要在四處建立Makefile檔案。即：project目錄下，lib目錄下，core和shell目錄下。
Autoconf提供了很多內建巨集來做相關的檢測，限於篇幅關係，我們在這裡對其他巨集不做詳細的解釋，具體請參看參考文獻1和參考文獻2，也可參看autoconf資訊頁。
實戰Makefile.am
Makefile.am是一種比Makefile更高層次的規則。只需指定要生成什麼目標，它由什麼原始檔生成，要安裝到什麼目錄等構成。
表一列出了可執行檔案、靜態庫、標頭檔案和資料檔案，四種書寫Makefile.am檔案個一般格式。
表 1Makefile.am一般格式
對於可執行檔案和靜態庫型別，如果只想編譯，不想安裝到系統中，可以用noinst_PROGRAMS代替bin_PROGRAMS，noinst_LIBRARIES代替lib_LIBRARIES。
Makefile.am還提供了一些全域性變數供所有的目標體使用：
表 2 Makefile.am中可用的全域性變數
在Makefile.am中儘量使用相對路徑，系統預定義了兩個基本路徑：
表 3Makefile.am中可用的路徑變數
在上文中我們提到過安裝路徑，automake設定了預設的安裝路徑：
1) 標準安裝路徑
預設安裝路徑為：$(prefix) = /usr/local，可以通過./configure --prefix=<new_path>的方法來覆蓋。
其它的預定義目錄還包括：bindir = $(prefix)/bin, libdir = $(prefix)/lib, datadir = $(prefix)/share, sysconfdir = $(prefix)/etc等等。
2) 定義一個新的安裝路徑
比如test, 可定義testdir = $(prefix)/test, 然後test_DATA =test1 test2，則test1，test2會作為資料檔案安裝到$(prefix)/ /test目錄下。
我們首先需要在工程頂層目錄下（即project/）建立一個Makefile.am來指明包含的子目錄：
SUBDIRS=src/lib src/ModuleA/apple/shell src/ModuleA/apple/core
CURRENTPATH=$(shell /bin/pwd)
INCLUDES=-I$(CURRENTPATH)/src/include -I$(CURRENTPATH)/src/ModuleA/apple/include
export INCLUDES由於每個原始檔都會用到相同的標頭檔案，所以我們在最頂層的Makefile.am中包含了編譯原始檔時所用到的標頭檔案，並匯出，見藍色部分程式碼。
我們將lib目錄下的swap.c檔案編譯成libswap.a檔案，被apple/shell/apple.c檔案呼叫，那麼lib目錄下的Makefile.am如下所示：
noinst_LIBRARIES=libswap.a
libswap_a_SOURCES=swap.c
INCLUDES=-I$(top_srcdir)/src/includ細心的讀者可能就會問：怎麼表1中給出的是bin_LIBRARIES，而這裡是noinst_LIBRARIES？這是因為如果只想編譯，而不想安裝到系統中，就用noinst_LIBRARIES代替bin_LIBRARIES，對於可執行檔案就用noinst_PROGRAMS代替bin_PROGRAMS。對於安裝的情況，庫將會安裝到$(prefix)/lib目錄下，可執行檔案將會安裝到${prefix}/bin。如果想安裝該庫，則Makefile.am示例如下：
bin_LIBRARIES=libswap.a
libswap_a_SOURCES=swap.c
INCLUDES=-I$(top_srcdir)/src/include
swapincludedir=$(includedir)/swap
swapinclude_HEADERS=$(top_srcdir)/src/include/swap.h最後兩行的意思是將swap.h安裝到${prefix}/include /swap目錄下。
接下來，對於可執行檔案型別的情況，我們將討論如何寫Makefile.am？對於編譯apple/core目錄下的檔案，我們寫成的Makefile.am如下所示：
noinst_PROGRAMS=test
test_SOURCES=test.c
test_LDADD=$(top_srcdir)/src/ModuleA/apple/shell/apple.o $(top_srcdir)/src/lib/libswap.a
test_LDFLAGS=-D_GNU_SOURCE
DEFS+=-D_GNU_SOURCE
#LIBS=-lpthread由於我們的test.c檔案在連結時，需要apple.o和libswap.a檔案，所以我們需要在test_LDADD中包含這兩個檔案。對於Linux下的訊號量/讀寫鎖檔案進行編譯，需要在編譯選項中指明-D_GNU_SOURCE。所以在test_LDFLAGS中指明。而test_LDFLAGS只是連結時的選項，編譯時同樣需要指明該選項，所以需要DEFS來指明編譯選項，由於DEFS已經有初始值，所以這裡用+=的形式指明。從這裡可以看出，Makefile.am中的語法與Makefile的語法一致，也可以採用條件表示式。如果你的程式還包含其他的庫，除了用AC_CHECK_LIB巨集來指明外，還可以用LIBS來指明。
如果你只想編譯某一個檔案，那麼Makefile.am如何寫呢？這個檔案也很簡單，寫法跟可執行檔案的差不多，如下例所示：
noinst_PROGRAMS=apple
apple_SOURCES=apple.c
DEFS+=-D_GNU_SOURCE我們這裡只是欺騙automake，假裝要生成apple檔案，讓它為我們生成依賴關係和執行命令。所以當你執行完automake命令後，然後修改apple/shell/下的Makefile.in檔案，直接將LINK語句刪除，即：
…….
clean-noinstPROGRAMS:
-test -z "$(noinst_PROGRAMS)" || rm -f $(noinst_PROGRAMS)
apple$(EXEEXT): $(apple_OBJECTS) $(apple_DEPENDENCIES)
@rm -f apple$(EXEEXT)
#$(LINK) $(apple_LDFLAGS) $(apple_OBJECTS) $(apple_LDADD) $(LIBS)
…….通過上述處理，就可以達到我們的目的。從圖1中不難看出為什麼要修改Makefile.in的原因，而不是修改其他的檔案。