例解 autoconf 和 automake 生成 Makefile 文件

文檔選項 打印本頁 將此頁作為電子郵件發送 樣例代碼

級別： 初級

楊 小華 (normalnotebook@126.com), Linux 內核研究員
蘇 春艷, 在讀研究生

2006 年 9 月 21 日

本文介紹了在 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文件。

假設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的流程，如圖所示：

回頁首

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文件個一般格式。

對于可執行文件和靜態庫類型，如果只想編譯，不想安裝到系統中，可以用noinst_PROGRAMS代替bin_PROGRAMS，noinst_LIBRARIES代替lib_LIBRARIES。

Makefile.am還提供了一些全局變量供所有的目標體使用：

在Makefile.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的原因，而不是修改其他的文件。

回頁首

下載

	關于下載方法的信息

參考資料

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系統下從事嵌入式開發。