自動(dòng)生成 Makefile 的全過程詳解

automake/autoconf 入門

作為Linux 下的程序開發(fā)人員，大家一定都遇到過Makefile ，用make 命令來編譯自己寫的程序確實(shí)是很方便。一般情況下，大家都是手工寫一個(gè)簡單Makefile ，如果要想寫出一個(gè)符合自由軟件慣例的Makefile 就不那么容易了。

在本文中，將給大家介紹如何使用autoconf 和automake 兩個(gè)工具來幫助我們自動(dòng)地生成符合自由軟件慣例的Makefile ，這樣就可以象常 見的GNU 程序一樣，只要使用“./configure” ，“make” ，“make instal” 就可以把程序安裝到Linux 系統(tǒng)中去了。這將特別適合想做開放源代碼軟件的程序開發(fā)人員，又或如果你只是自己寫些小的Toy 程序，那么這 個(gè)文章對(duì)你也會(huì)有很大的幫助。

一、Makefile 介紹

Makefile 是用于自動(dòng)編譯和鏈接的，一個(gè)工程有很多文件組成，每一個(gè)文件的改變都會(huì)導(dǎo)致工程的重新鏈接，但是不是所有的文件都需要重新編譯，Makefile 中紀(jì)錄有文件的信息，在make 時(shí)會(huì)決定在鏈接的時(shí)候需要重新編譯哪些文件。

Makefile 的宗旨就是：讓編譯器知道要編譯一個(gè)文件需要依賴其他的哪些文件。當(dāng)那些依賴文件有了改變，編譯器會(huì)自動(dòng)的發(fā)現(xiàn)最終的生成文件已經(jīng)過時(shí)，而重新編譯相應(yīng)的模塊。

Makefile 的基本結(jié)構(gòu)不是很復(fù)雜，但當(dāng)一個(gè)程序開發(fā)人員開始寫Makefile 時(shí)，經(jīng)常會(huì)懷疑自己寫的是否符合慣例，而且自己寫的 Makefile 經(jīng)常和自己的開發(fā)環(huán)境相關(guān)聯(lián)，當(dāng)系統(tǒng)環(huán)境變量或路徑發(fā)生了變化后，Makefile 可能還要跟著修改。這樣就造成了手工書寫 Makefile 的諸多問題，automake 恰好能很好地幫助我們解決這些問題。

使用automake ，程序開發(fā)人員只需要寫一些 簡單的含有預(yù)定義宏的文件，由autoconf 根據(jù)一個(gè)宏文件生成configure ，由automake 根據(jù)另一個(gè)宏文件生成Makefile.in ， 再使用configure 依據(jù)Makefile.in 來生成一個(gè)符合慣例的Makefile 。下面我們將詳細(xì)介紹Makefile 的automake 生成 方法。

二、使用的環(huán)境

本文所提到的程序是基于Linux 發(fā)行版本：Fedora Core release 1 ，它包含了我們要用到的autoconf ，automake。

三、從helloworld 入手

我們從大家最常使用的例子程序helloworld 開始。

下面的過程如果簡單地說來就是：

新建三個(gè)文件：

helloworld.c

configure.in

Makefile.am

然后執(zhí)行：

aclocal; autoconf; automake --add-missing; ./configure; make; ./helloworld

就可以看到Makefile 被產(chǎn)生出來，而且可以將helloworld.c 編譯通過。

很簡單吧，幾條命令就可以做出一個(gè)符合慣例的Makefile ，感覺如何呀。

現(xiàn)在開始介紹詳細(xì)的過程：

1 、建目錄

在你的工作目錄下建一個(gè)helloworld 目錄，我們用它來存放helloworld 程序及相關(guān)文件，如在/home/my/build下：

$ mkdir helloword

$ cd helloworld

2 、 helloworld.c

然后用你自己最喜歡的編輯器寫一個(gè)hellowrold.c 文件，如命令：vi helloworld.c 。使用下面的代碼作為helloworld.c 的內(nèi)容。

int main(int argc, char** argv)

{

printf("Hello, Linux World!\n");

return 0;

}

完成后保存退出。

現(xiàn)在在helloworld 目錄下就應(yīng)該有一個(gè)你自己寫的helloworld.c 了。

3 、生成configure

我們使用autoscan 命令來幫助我們根據(jù)目錄下的源代碼生成一個(gè)configure.in 的模板文件。

命令：

$ autoscan

$ ls

configure.scan helloworld.c

執(zhí)行后在hellowrold 目錄下會(huì)生成一個(gè)文件：configure.scan ，我們可以拿它作為configure.in 的藍(lán)本。

現(xiàn)在將configure.scan 改名為configure.in ，并且編輯它，按下面的內(nèi)容修改，去掉無關(guān)的語句：

============================configure.in 內(nèi)容開始=========================================

# -*- Autoconf -*-

# Process this file with autoconf to produce a configure script.

AC_INIT(helloworld.c)

AM_INIT_AUTOMAKE(helloworld, 1.0)

# 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_OUTPUT(Makefile)

============================configure.in 內(nèi)容結(jié)束=========================================

然后執(zhí)行命令aclocal 和autoconf ，分別會(huì)產(chǎn)生aclocal.m4 及configure 兩個(gè)文件：

$ aclocal

$ls

aclocal.m4 configure.in helloworld.c

$ autoconf

$ ls

aclocal.m4 autom4te.cache configure configure.in helloworld.c

大家可以看到configure.in 內(nèi)容是一些宏定義，這些宏經(jīng)autoconf 處理后會(huì)變成檢查系統(tǒng)特性、環(huán)境變量、軟件必須的參數(shù)的shell 腳本。

autoconf 是用來生成自動(dòng)配置軟件源代碼腳本(configure )的工具。configure 腳本能獨(dú)立于autoconf 運(yùn)行，且在運(yùn)行的過程中，不需要用戶的干預(yù)。

要生成configure 文件，你必須告訴autoconf 如何找到你所用的宏。方式是使用aclocal 程序來生成你的aclocal.m4。

aclocal 根據(jù)configure.in 文件的內(nèi)容，自動(dòng)生成aclocal.m4 文件。aclocal 是一個(gè)perl 腳本程序，它的定義是：“aclocal - create aclocal.m4 by scanning configure.ac” 。

autoconf 從configure.in 這個(gè)列舉編譯軟件時(shí)所需要各種參數(shù)的模板文件中創(chuàng)建configure 。

autoconf 需要GNU m4 宏處理器來處理aclocal.m4 ，生成configure 腳本。

m4 是一個(gè)宏處理器。將輸入拷貝到輸出，同時(shí)將宏展開。宏可以是內(nèi)嵌的，也可以是用戶定義的。除了可以展開宏，m4 還有一些內(nèi)建的函數(shù)，用來引用文件，執(zhí)行命令，整數(shù)運(yùn)算，文本操作，循環(huán)等。m4 既可以作為編譯器的前端，也可以單獨(dú)作為一個(gè)宏處理器。[!--empirenews.page--]

4 、新建Makefile.am

新建Makefile.am 文件，命令：

$ vi Makefile.am

內(nèi)容如下:

AUTOMAKE_OPTIONS=foreign

bin_PROGRAMS=helloworld

helloworld_SOURCES=helloworld.c

automake 會(huì)根據(jù)你寫的Makefile.am 來自動(dòng)生成Makefile.in 。

Makefile.am 中定義的宏和目標(biāo), 會(huì)指導(dǎo)automake 生成指定的代碼。例如，宏bin_PROGRAMS 將導(dǎo)致編譯和連接的目標(biāo)被生成。

5 、運(yùn)行automake

命令：

$ automake --add-missing

configure.in: installing `./install-sh'

configure.in: installing `./mkinstalldirs'

configure.in: installing `./missing'

Makefile.am: installing `./depcomp'

automake 會(huì)根據(jù)Makefile.am 文件產(chǎn)生一些文件，包含最重要的Makefile.in 。

6 、執(zhí)行configure 生成Makefile

$ ./configure

checking for a BSD-compatible install... /usr/bin/install -c

checking whether build environment is sane... yes

checking for gawk... gawk

checking whether make sets $(MAKE)... yes

checking for gcc... gcc

checking for C compiler default output... a.out

checking whether the C compiler works... yes

checking whether we are cross compiling... no

checking for suffix of executables...

checking for suffix of object files... o

checking whether we are using the GNU C compiler... yes

checking whether gcc accepts -g... yes

checking for gcc option to accept ANSI C... none needed

checking for style of include used by make... GNU

checking dependency style of gcc... gcc3

configure: creating ./config.status

config.status: creating Makefile

config.status: executing depfiles commands

$ ls -l Makefile

-rw-rw-r-- 1 yutao yutao 15035 Oct 15 10:40 Makefile

你可以看到，此時(shí)Makefile 已經(jīng)產(chǎn)生出來了。

7 、使用Makefile 編譯代碼

$ make

if gcc -DPACKAGE_NAME="" -DPACKAGE_TARNAME="" -DPACKAGE_VERSION="" -

DPACKAGE_STRING="" -DPACKAGE_BUGREPORT="" -DPACKAGE="helloworld" -DVERSION="1.0"

-I. -I. -g -O2 -MT helloworld.o -MD -MP -MF ".deps/helloworld.Tpo" \

-c -o helloworld.o `test -f 'helloworld.c' || echo './'`helloworld.c; \

then mv -f ".deps/helloworld.Tpo" ".deps/helloworld.Po"; \

else rm -f ".deps/helloworld.Tpo"; exit 1; \

fi

gcc -g -O2 -o helloworld helloworld.o

運(yùn)行helloworld

$ ./helloworld

Hello, Linux World!

這樣helloworld 就編譯出來了，你如果按上面的步驟來做的話，應(yīng)該也會(huì)很容易地編譯出正確的helloworld 文件。你還可以試著使用一些其 他的make 命令，如make clean ，make install ，make dist ，看看它們會(huì)給你什么樣的效果。感覺如何?自己也能寫出這么專業(yè)的Makefile ，老板一定會(huì)對(duì)你刮目相看。

四、深入淺出

針對(duì)上面提到的各個(gè)命令，我們?cè)僮鲂┰敿?xì)的介紹。

1 、 autoscan

autoscan 是用來掃描源代碼目錄生成configure.scan 文件的。autoscan 可以用目錄名做為參數(shù)，但如果你不使用參數(shù)的話，那么 autoscan 將認(rèn)為使用的是當(dāng)前目錄。autoscan 將掃描你所指定目錄中的源文件，并創(chuàng)建configure.scan 文件。

2 、 configure.scan

configure.scan 包含了系統(tǒng)配置的基本選項(xiàng)，里面都是一些宏定義。我們需要將它改名為configure.in

3 、 aclocal

aclocal 是一個(gè)perl 腳本程序。aclocal 根據(jù)configure.in 文件的內(nèi)容，自動(dòng)生成aclocal.m4 文件。aclocal 的定義是：“aclocal - create aclocal.m4 by scanning configure.ac” 。

4 、 autoconf

autoconf 是用來產(chǎn)生configure 文件的。configure 是一個(gè)腳本，它能設(shè)置源程序來適應(yīng)各種不同的操作系統(tǒng)平臺(tái)，并且根據(jù)不同的系統(tǒng)來產(chǎn)生合適的Makefile ，從而可以使你的源代碼能在不同的操作系統(tǒng)平臺(tái)上被編譯出來。

configure.in 文件的內(nèi)容是一些宏，這些宏經(jīng)過autoconf 處理后會(huì)變成檢查系統(tǒng)特性、環(huán)境變量、軟件必須的參數(shù)的shell 腳本。configure.in 文件中的宏的順序并沒有規(guī)定，但是你必須在所有宏的最前 面和最后面分別加上AC_INIT 宏和AC_OUTPUT 宏。

在configure.ini 中：

# 號(hào)表示注釋，這個(gè)宏后面的內(nèi)容將被忽略。

AC_INIT(FILE)

這個(gè)宏用來檢查源代碼所在的路徑。

AM_INIT_AUTOMAKE(PACKAGE, VERSION)

這個(gè)宏是必須的，它描述了我們將要生成的軟件包的名字及其版本號(hào)：PACKAGE 是軟件包的名字，VERSION 是版本號(hào)。當(dāng)你使用make dist 命令時(shí)，它會(huì)給你生成一個(gè)類似helloworld-1.0.tar.gz 的軟件發(fā)行包，其中就有對(duì)應(yīng)的軟件包的名字和版本號(hào)。

AC_PROG_CC

這個(gè)宏將檢查系統(tǒng)所用的C 編譯器。

AC_OUTPUT(FILE)

這個(gè)宏是我們要輸出的Makefile 的名字。

我們?cè)谑褂胊utomake 時(shí)，實(shí)際上還需要用到其他的一些宏，但我們可以用aclocal 來幫我們自動(dòng)產(chǎn)生。執(zhí)行aclocal后我們會(huì)得到aclocal.m4 文件。

產(chǎn)生了configure.in 和aclocal.m4 兩個(gè)宏文件后，我們就可以使用autoconf 來產(chǎn)生configure 文件了。

5 、 Makefile.am

Makefile.am 是用來生成Makefile.in 的，需要你手工書寫。Makefile.am 中定義了一些內(nèi)容：

AUTOMAKE_OPTIONS

這個(gè)是automake 的選項(xiàng)。在執(zhí)行automake 時(shí)，它會(huì)檢查目錄下是否存在標(biāo)準(zhǔn)GNU 軟件包中應(yīng)具備的各種文件，例如AUTHORS 、ChangeLog 、NEWS 等文件。我們將其設(shè)置成foreign 時(shí)，automake 會(huì)改用一般軟件包的標(biāo)準(zhǔn)來檢查。[!--empirenews.page--]

bin_PROGRAMS

這個(gè)是指定我們所要產(chǎn)生的可執(zhí)行文件的文件名。如果你要產(chǎn)生多個(gè)可執(zhí)行文件，那么在各個(gè)名字間用空格隔開。

helloworld_SOURCES

這個(gè)是指定產(chǎn)生“helloworld” 時(shí)所需要的源代碼。如果它用到了多個(gè)源文件，那么請(qǐng)使用空格符號(hào)將它們隔開。比如需要 helloworld.h ，helloworld.c 那么請(qǐng)寫成helloworld_SOURCES= helloworld.h helloworld.c 。

如果你在bin_PROGRAMS 定義了多個(gè)可執(zhí)行文件，則對(duì)應(yīng)每個(gè)可執(zhí)行文件都要定義相對(duì)的filename_SOURCES 。

6 、 automake

我們使用automake --add-missing 來產(chǎn)生Makefile.in 。

選項(xiàng)--add-missing 的定義是“add missing standard files to package” ，它會(huì)讓automake 加入一個(gè)標(biāo)準(zhǔn)的軟件包所必須的一些文件。

我們用automake 產(chǎn)生出來的Makefile.in 文件是符合GNU Makefile 慣例的，接下來我們只要執(zhí)行configure 這個(gè)shell腳本就可以產(chǎn)生合適的 Makefile 文件了。

7 、 Makefile

在符合GNU Makefiel 慣例的Makefile 中，包含了一些基本的預(yù)先定義的操作：

make

根據(jù)Makefile 編譯源代碼，連接，生成目標(biāo)文件，可執(zhí)行文件。

make clean

清除上次的make 命令所產(chǎn)生的object 文件(后綴為“.o” 的文件)及可執(zhí)行文件。

make install

將編譯成功的可執(zhí)行文件安裝到系統(tǒng)目錄中，一般為/usr/local/bin 目錄。

make dist

產(chǎn)生發(fā)布軟件包文件(即distribution package )。這個(gè)命令將會(huì)將可執(zhí)行文件及相關(guān)文件打包成一個(gè)tar.gz 壓縮的文件用來作為發(fā)布軟件的軟件包。

它會(huì)在當(dāng)前目錄下生成一個(gè)名字類似“PACKAGE-VERSION.tar.gz” 的文件。PACKAGE 和VERSION ，是我們?cè)赾onfigure.in 中定義的AM_INIT_AUTOMAKE(PACKAGE, VERSION) 。

make distcheck

生成發(fā)布軟件包并對(duì)其進(jìn)行測試檢查，以確定發(fā)布包的正確性。這個(gè)操作將自動(dòng)把壓縮包文件解開，然后執(zhí)行configure 命令，并且執(zhí)行make ，來確認(rèn)編譯不出現(xiàn)錯(cuò)誤，最后提示你軟件包已經(jīng)準(zhǔn)備好，可以發(fā)布了。

===============================================

helloworld-1.0.tar.gz is ready for distribution

===============================================

make distclean

類似make clean ，但同時(shí)也將configure 生成的文件全部刪除掉，包括Makefile 。

五、結(jié)束語

通過上面的介紹，你應(yīng)該可以很容易地生成一個(gè)你自己的符合GNU 慣例的Makefile 文件及對(duì)應(yīng)的項(xiàng)目文件。

如果你想寫出更復(fù)雜的且符合慣例的Makefile ，你可以參考一些開放代碼的項(xiàng)目中的configure.in 和Makefile.am 文件，比如：嵌入式數(shù)據(jù)庫sqlite ，單元測試cppunit 。