例解 autoconf 和 automake 生成 Makefile 文件

引子

不管是在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來指明。

若是你只想編譯某一個文件，那麼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的緣由，而不是修改其餘的文件。

回頁首

下載

名字	大小	下載方法
project.rar		HTTP

關於下載方法的信息

參考資料

1. Kurt Wall，張輝譯 《GNU/Linux編程指南》 清華大學出版社
2. Robert Mecklenburg，《GNU Make項目管理（第三版）》 東南大學出版社 2006
3. http://www.cngnu.org/technology/index.html

做者簡介

楊小華，目前從事 Linux 內核方面的研究，喜歡搗鼓 Linux 系統，對 Linux 中斷系統比較瞭解。能夠經過 normalnotebook@126.com與他取得聯繫。

蘇春豔：在讀研究生，主要在Linux系統下從事嵌入式開發。