使用Automake和Autoconf生成Makefile

automake 所產生的 Makefile 除了可以做到程序的自動編譯和鏈接外，還可以用來生成各種文檔（如manual page、info文件），可以將源代碼文件包裝起來以供發布。所以程序源代碼所存放的目錄結構最好符合GNU的標準慣例。下面以hello.c程序生成Makefile文件作為例子。

1,在當前目錄下創建一個名為hello的子目錄。hello這個目錄用于存放 hello.c這個程序及相關文件。新建一個源程序文件hello.c

#include <stdio.h>

int main(int argc, char** argv)

{

? ? ? ? ? printf("Welcome to use autoconf and automake\n");

? ? ? ? ? return 0;

}

2,創建一個名為Makefile.am的文件，并輸入以下內容：

AUTOMAKE_OPTIONS= foreign
bin_PROGRAMS= testp ? #輸出的最終可執行文件名稱
testp_SOURCES= hello.c? ＃如果有多個文件參與編譯，需要都列出

3,執行autoscan命令生成一個名為configure.scan文件：

autoscan

4,將configure.scan改名為configure.in：

mv configure.scan configure.in

5,打開configure.in，將該文件修改為以下內容：

AC_PREREQ(2.61)

AC_INIT(testp,1.0) ＃此行內容經過修改，test與Makefile.am中bin_PROGRAMS保持一致

AC_CONFIG_SRCDIR([testp.h])

AC_CONFIG_HEADER([config.h])

AM_INIT_AUTOMAKE(testp,1.0) ＃此行內容是新增加，test與Makefile.am中bin_PROGRAMS保持一致

# 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

6.執行命令 autoheader，生成config.h和config.h.in

7,然后執行以下兩個命令，分別生成aclocal.m4和configure文件：

aclocal

autoconf

8,新建四個空白文件，分別命名為NEWS,README,AUTHORS,ChangeLog。

touch NEWS
touch README
touch AUTHORS
touch ChangeLog

9,執行命令“automake --add-missing”，automake 會根據Makefile.am 文件產生一些文件，其中包含最重要的Makefile.in

automake --add-missing

10,最后執行“./configure”命令生成Makefile文件

./configure

11,生成Makefile文件后，就可以執行“make”命令來編譯hello.c程序，從而生成可執行程序testp。生成可執行程序testp后，執行。

make

./testp

Welcome to use autoconf and automake

歸納一下這個例子的流程。

（1）在存放源代碼的目錄下執行autoscan命令生成configure.scan文件。

（2）將configure.scan文件改名為configure.in，并對其默認配置進行修改。

（3）執行aclocal、autoconf兩個命令，分別生成aclocal.m4、configure文件。

（4）創建一個名為Makefile.am的文件，并輸入相應的內容。

（5）執行automake --add-missing，它根據Makefile.am文件，生成Makefile.in。

（6）執行./configure腳本文件，它根據Makefile.in文件，生成最終的Makefile文件。

通過以上步驟，在源代碼所在目錄下自動生成了Makefile文件。

?configure.in文件

autoconf是用來產生“configure”文件的工具。“configure”是一個Shell腳本，它可以自動設定一些編譯參數使程序能夠在不同平臺上進行編譯。autoconf讀取configure.in 文件然后產生''configure''這個Shell腳本。

configure.in 文件的內容是一系列GNU m4 的宏，這些宏經autoconf處理后會變成檢查系統特性的Shell腳本。configure.in文件中宏的順序并沒有特別的規定，但是每一個configure.in 文件必須以宏AC_INIT開頭，以宏AC_OUTPUT結束。一般可先用autoscan這個工具掃描原始文件以產生一個configure.scan 文件，再對configure.scan 作些修改，從而生成 configure.in 文件

configure.in 文件中一些宏的含義如下。

l? ? #或dnl：#或dnl后面的內容作為注釋不會被處理，它們是注釋的起始標志。

l? ? AC_INIT(FILE)：該宏用來說明源代碼所在路徑，如上例中的AC_INIT(hello.c)，表明源代碼在當前目錄下，名為hello.c。

l? ? AM_INIT_AUTOMAKE(PACKAGE,VERSION)：這個是后面運行automake命令所必需的宏，PACKAGE指明要產生軟件的名稱，VERSION 是其版本號。

l? ? AC_PROG_CC：檢查系統可用的C編譯器，若源代碼是用C語言編寫的就需要這個宏。

l ? ? AC_OUTPUT(FILE)：設置configure命令所要產生的文件。我們最終期望產生Makefile

這個文件，因此一般將其設置為AC_OUTPUT(Makefile)。

在運行automake命令時，還需要一些其他的宏，這些額外的宏由aclocal產生。執行aclocal會產生aclocal.m4文件，如果沒有特別的要求，無需修改它。用 aclocal產生的宏將會提示automake如何動作。

另一個重要的文件是Makefile.am。automake根據configure.in中的宏并在perl的幫助下把Makefile.am轉成Makefile.in文件。Makefile.am 文件定義所要產生的目標。

?Makefile.am文件

Makefile.am文件中幾個預定的選項的含義如下所示。

l? ? AUTOMAKE_OPTIONS：它用于設置automake的選項。automake 主要是幫助開發 GNU 軟件的人員來維護軟件，所以在執行automake 時，會檢查目錄下是否存在標準GNU軟件中應具備的文件，例如“NEWS”、“AUTHOR”、“ChangeLog”等文件。設置為foreign 時，automake 會改用一般軟件的標準來進行檢查。

l? ? bin_PROGRAMS：定義要產生的可執行程序的文件名。如果要產生多個可執行文件，每個文件名用空白符隔開。

l? ? testp_SOURCES：定義“testp”這個可執行程序所需要的原始文件。如果“testp”這個程序是由多個原始文件產生的，必須把它所用到的所有原始文件都列出來，并以空白符隔開。假設“testp”還需要“hello.c”、“main.c”、“hello.h”3個文件，則定義testp_SOURCES= hello.c main.c hello.h。如果定義多個可執行文件，則對每個可執行程序都要定義相應的filename_SOURCES，其中filename為要生成的可執行程序的文件名。

編輯好Makefile.am文件后，就可以使用命令automake --add-missing生成Makefile.in。加上--add-missing這個選項是用來提示automake加入包裝一個軟件所必需的文件，如果不使用該選項，automake可能會報告缺少了某些文件。automake產生出來的 Makefile.in文件是完全符合GNU Makefile規定的，只要執行 configure這個Shell腳本便可以產生合適的Makefile文件了。

?如何使用產生的Makefile文件

執行configure腳本文件所產生的Makefile文件有幾個預定的選項可供使用。

l? ? make all：產生設定的目標，即生成所有的可執行文件。使用make也可以達到此目的。

l? ? make clean：刪除之前編譯時生成的可執行文件及目標文件（形如*.o的中間文件）。

l? ? make distclean：除了刪除可執行文件和目標文件以外，把configure所產生的 Makefile文件也清除掉。通常在發布軟件前執行該命令。

l? ? make install：將使用make all或make命令產生的可執行文件以軟件的形式安裝到系統中。若使用bin_PROGRAMS宏，程序將會被安裝到 /usr/local/bin下，否則安裝到預定義的目錄下。

l? ? make dist：將程序和相關的文檔包裝為一個壓縮文檔以供發布。執行完該命令，在當前目錄下會產生一個名為PACKAGE-VERSION.tar.gz的文件。PACKAGE 和 VERSION 這兩個參數是來自configure.in文件中的AM_INIT_AUTOMAKE(PACKAGE,
VERSION)。如在上個例子中執行make dist命令，會產生名為“testp-1.0.tar.gz”的文件。

l? ? make distcheck：與make dist類似，但是加入了檢查包裝以后的壓縮文件是否正常。

例解 autoconf 和 automake 生成 Makefile 文件

本文介紹了在 linux 系統中，通過 Gnu autoconf 和 automake 生成 Makefile 的方法。主要探討了生成 Makefile 的來龍去脈及其機理，接著詳細介紹了配置 Configure.in 的方法及其規則。

引子

無論是在Linux還是在Unix環境中，make都是一個非常重要的編譯命令。不管是自己進行項目開發還是安裝應用軟件，我們都經常要用到make或 make install。利用make工具，我們可以將大型的開發項目分解成為多個更易于管理的模塊，對于一個包括幾百個源文件的應用程序，使用make和 makefile工具就可以輕而易舉的理順各個源文件之間紛繁復雜的相互關系。

但是如果通過查閱make的幫助文檔來手工編寫Makefile,對任何程序員都是一場挑戰。幸而有GNU 提供的Autoconf及Automake這兩套工具使得編寫makefile不再是一個難題。

本文將介紹如何利用 GNU Autoconf 及 Automake 這兩套工具來協助我們自動產生 Makefile文件，并且讓開發出來的軟件可以像大多數源碼包那樣，只需"./configure", "make","make install" 就可以把程序安裝到系統中。

回頁首

模擬需求

假設源文件按如下目錄存放，如圖1所示，運用autoconf和automake生成makefile文件。

圖 1文件目錄結構

假設src是我們源文件目錄，include目錄存放其他庫的頭文件，lib目錄存放用到的庫文件，然后開始按模塊存放，每個模塊都有一個對應的目錄，模塊下再分子模塊，如apple、orange。每個子目錄下又分core，include，shell三個目錄，其中core和shell目錄存放.c文件，include的存放.h文件，其他類似。

樣例程序功能：基于多線程的數據讀寫保護（聯系作者獲取整個autoconf和automake生成的Makefile工程和源碼，E-mail：normalnotebook@126.com）。

回頁首

工具簡介

所必須的軟件：autoconf/automake/m4/perl/libtool（其中libtool非必須）。

autoconf是一個用于生成可以自動地配置軟件源碼包，用以適應多種UNIX類系統的shell腳本工具，其中autoconf需要用到 m4，便于生成腳本。automake是一個從Makefile.am文件自動生成Makefile.in的工具。為了生成Makefile.in，automake還需用到perl，由于automake創建的發布完全遵循GNU標準，所以在創建中不需要perl。libtool是一款方便生成各種程序庫的工具。

目前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, normalnotebook@126.com)

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來指明。