2. 程式人生 > >AUTOTOOL

AUTOTOOL

阿新 • • 發佈：2019-02-16

說明：

autobook：https://sourceware.org/autobook/

autoconf手冊：http://www.gnu.org/software/autoconf/manual/autoconf.html

automaker手冊：http://www.gnu.org/software/automake/manual/automake.html

看看這三個手冊就知道這個autotool有多煩了，linux裡面可能一個Makefile就能搞定的東西，autotool要弄一堆檔案，看完下面的內容，仍然不能理解autotool有什麼好。

autotools的作用：
1. 使程式碼可移植
程式碼可移植不是自動的，程式碼自身必須保證其在任意平臺可以執行。autotools只是告訴，這個平臺什麼可以用，什麼不可以用。


2. 使安裝分發很容易
# ./configure
# make
# make install
這個最初是gnu的規範，後來變成了開源的規範。


3. 看起來很專業的樣子
專業，至少從看起來專業開始。但是切記，估計只有跑在虛擬機器上的程式碼（例如perl），和精通各個平臺的人，才能寫出真正可移植的程式碼。


我對可移植的理解：
作為公司內部專案，不必追求可移植，在linux平臺執行，（只要能）就應該榨乾linux提供的每一份特性。


無論對於一個初學者還是一個資深的Linux程式設計師，編寫Makefile檔案都是一件很麻煩的事；再者，開發人員應該把主要的精力放在程式程式碼的編寫上，而在Makefile檔案花費太多的精力顯然是不明智的；還有，對於不同的處理器架構，往往編譯器不同，環境不同,特別是一些嵌入式系統中的各種程式的編譯，於是移植問題也使Makefile檔案編寫趨於複雜，也顯得這個問題很重要。對於這些問題Linux的高手們早已想到了，所以他們開發了一些能夠自動生成Makefile檔案的工具。他們就是下面這些工具：
 
〉GNU Automake 
〉GNU Autoconf 
〉GNU m4 
〉perl 
〉GNU Libtool 
因此您的作業系統必須安裝以上軟體，否則就不能夠自動生成Makefile檔案或者在生成的過程中出現各種各樣的問題。用 autoconf/automake/autoheader工具來處理各種移植性的問題，用這些工具完成系統配置資訊的收集，製作Makefile檔案。然後在打算編譯原始碼時只需要通過 "./configure; make"這樣簡單的命令就可以得到乾淨利落的編譯。

1.autoscan (autoconf): 掃描原始碼以搜尋普通的可移植性問題，比如檢查編譯器，庫，標頭檔案等，生成檔案configure.scan,它是configure.ac的一個雛形。

    your source files --> [autoscan*] --> [configure.scan] --> configure.ac

2.aclocal (automake):根據已經安裝的巨集，使用者定義巨集和acinclude.m4檔案中的巨集將configure.ac檔案所需要的巨集集中定義到檔案 aclocal.m4中。aclocal是一個perl 指令碼程式，它的定義是：“aclocal - create aclocal.m4 by scanning configure.ac”
user input files   optional input     process          output files
================   ==============     =======          ============

                    acinclude.m4 - - - - -.
                                          V
                                      .-------,
configure.ac ------------------------>|aclocal|
                 {user macro files} ->|       |------> aclocal.m4
                                      `-------'
3.autoheader(autoconf): 根據configure.ac中的某些巨集，比如cpp巨集定義，執行m4，聲稱config.h.in

user input files    optional input     process          output files
================    ==============     =======          ============

                    aclocal.m4 - - - - - - - .
                                             |
                                             V
                                     .----------,
configure.ac ----------------------->|autoheader|----> autoconfig.h.in
                                     `----------'

4.automake: automake將Makefile.am中定義的結構建立Makefile.in，然後configure指令碼將生成的Makefile.in檔案轉換 為Makefile。如果在configure.ac中定義了一些特殊的巨集，比如AC_PROG_LIBTOOL，它會呼叫libtoolize，否則它 會自己產生config.guess和config.sub

user input files   optional input   processes          output files
================   ==============   =========          ============

                                     .--------,
                                     |        | - - -> COPYING
                                     |        | - - -> INSTALL
                                     |        |------> install-sh
                                     |        |------> missing
                                     |automake|------> mkinstalldirs
configure.ac ----------------------->|        |
Makefile.am  ----------------------->|        |------> Makefile.in
                                     |        |------> stamp-h.in
                                 .---+        | - - -> config.guess
                                 |   |        | - - -> config.sub
                                 |   `------+-'
                                 |          | - - - -> config.guess
                                 |libtoolize| - - - -> config.sub
                                 |          |--------> ltmain.sh
                                 |          |--------> ltconfig
                                 `----------'

5.autoconf:將configure.ac中的巨集展開，生成configure指令碼。這個過程可能要用到aclocal.m4中定義的巨集。

user input files   optional input   processes          output files
================   ==============   =========          ============

aclocal.m4 ,autoconfig.h.in - - - - - - -.
                                         V
                                     .--------,
configure.ac ----------------------->|autoconf|------> configure
6. ./configure的過程
                                            .-------------> [config.cache]
     configure* --------------------------+-------------> config.log
                                          |
              [config.h.in] -.            v            .--> [autoconfig.h]
                             +-------> config.status* -+                   
              Makefile.in ---'                         `-->   Makefile
7. make過程
[autoconfig.h] -.
                     +--> make* --->  程式
        Makefile   ---'
.---------,
                   config.site - - ->|         |
                  config.cache - - ->|<span style="padding-bottom:0px; margin:0px; padding-left:0px; padding-right:0px; padding-top:0px"><span style="padding-bottom:0px; margin:0px; padding-left:0px; padding-right:0px; padding-top:0px">configure</span></span>| - - -> config.cache
                                     |         +-,
                                     `-+-------' |
                                       |         |----> config.status
                   config.h.in ------->|config-  |----> config.h
                   Makefile.in ------->|  .status|----> Makefile
                                       |         |----> stamp-h
                                       |         +--,
                                     .-+         |  |
                                     | `------+--'  |
                   ltmain.sh ------->|ltconfig|-------> libtool
                                     |        |     |
                                     `-+------'     |
                                       |config.guess|
                                       | config.sub |
                                       `------------'<p style="padding-bottom:0px; line-height:1.5; margin-top:0px; margin-bottom:15pt; letter-spacing:1px; padding-top:0px"> </p>
<pre style="border-bottom:rgb(221,221,221) 1px solid; border-left:rgb(108,226,108) 5px solid; padding-bottom:5px; background-color:rgb(246,246,246); margin-top:10px; padding-left:5px; padding-right:5px; font-family:'Courier New',Arial; margin-bottom:10px; font-size:9pt; border-top:rgb(221,221,221) 1px solid; border-right:rgb(221,221,221) 1px solid; padding-top:5px">.--------,
                   Makefile ------>|        |
                   config.h ------>|  <span style="padding-bottom:0px; margin:0px; padding-left:0px; padding-right:0px; padding-top:0px"><span style="padding-bottom:0px; margin:0px; padding-left:0px; padding-right:0px; padding-top:0px">make</span></span>  |
{project sources} ---------------->|        |--------> {project targets}
                                 .-+        +--,
                                 | `--------'  |
                                 |   libtool   |
                                 |   missing   |
                                 |  install-sh |
                                 |mkinstalldirs|
                                 `-------------'

*****************************************************************

例項：


在/hello/目錄下建立一個hello.c檔案，並編譯執行它：

#cd /hello/

(1) 編寫原始檔hello.c：

#include<stdio.h> 
int main(int argc, char** argv)
{
printf("Hello, GNU!n");
return 0;
}

[[email protected] hello]$ ll
total 4
-rw-rw-r-- 1 litao litao 68 Aug 12 12:02 hello.c

一、autoscan

[[email protected] hello]$ autoscan
autom4te: configure.ac: no such file or directory
autoscan: /usr/bin/autom4te failed with exit status: 1
[[email protected] hello]$ ll
total 8
-rw-rw-r-- 1 litao litao   0 Aug 12 12:03 autoscan.log
-rw-rw-r-- 1 litao litao 457 Aug 12 12:03 configure.scan
-rw-rw-r-- 1 litao litao  68 Aug 12 12:02 hello.c

已經生成了configure.scan，autoscan.log檔案

將configure.scan 修改為 configure.in，最後修改的內容如下：

[[email protected] hello]$ mv configure.scan configure.in    
[[email protected] hello]$ vim configure.in 

#                                               -*- Autoconf -*-
# 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([hello.c])
#AC_CONFIG_HEADER([config.h])
AM_INIT_AUTOMAKE(hello, 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)

二、acloacl

[[email protected] hello]$ aclocal 

生成 aclocal.m4 和 autom4te.cache (生成aclocal.m4的過程中涉及到configure.in)

[[email protected] hello]$ ll
total 44
-rw-rw-r-- 1 litao litao 31120 Aug 12 12:08 aclocal.m4
drwxr-xr-x 2 litao litao  4096 Aug 12 12:08 autom4te.cache
-rw-rw-r-- 1 litao litao     0 Aug 12 12:03 autoscan.log
-rw-rw-r-- 1 litao litao   496 Aug 12 12:08 configure.in
-rw-rw-r-- 1 litao litao    68 Aug 12 12:02 hello.c

三、antoconf

[[email protected] hello]$ autoconf
生成 configure (根據 configure.in, 和 aclocal.m4)
[[email protected] hello]$ ll
total 168
-rw-rw-r-- 1 litao litao  31120 Aug 12 12:08 aclocal.m4
drwxr-xr-x 2 litao litao   4096 Aug 12 12:11 autom4te.cache
-rw-rw-r-- 1 litao litao      0 Aug 12 12:03 autoscan.log
-rwxrwxr-x 1 litao litao 122297 Aug 12 12:11 configure
-rw-rw-r-- 1 litao litao    496 Aug 12 12:08 configure.in
-rw-rw-r-- 1 litao litao     68 Aug 12 12:02 hello.c

四、編寫Makefile.am：

AUTOMAKE_OPTIONS= foreign
bin_PROGRAMS= hello
hello_SOURCES= hello.c

五、automake

生成 Makefile.in， depcomp， install-sh， 和 missing (根據 Makefile.am, 和 aclocal.m4)

[[email protected] hello]$ automake
configure.in: required file `./install-sh' not found
configure.in: required file `./missing' not found
Makefile.am: required file `./depcomp' not found
[[email protected] hello]$ automake --add-missing
configure.in: installing `./install-sh'
configure.in: installing `./missing'
Makefile.am: installing `./depcomp'

這裡還差了一步！

[[email protected] mybit]# automake --add-missing
configure.in:8: installing './install-sh'
configure.in:8: installing './missing'
configure.in:7: error: required file 'config.h.in' not found
Makefile.am: installing './depcomp'

這裡沒有找到config.h.in查了一下需要執行autoheader生成
[[email protected] mybit]# ls
aclocal.m4      autoscan.log  configure.in  install-sh   missing  test2.c
autom4te.cache  configure     depcomp       Makefile.am  test1.c
[[email protected] mybit]# man automake
[[email protected] mybit]# info automake
[[email protected] mybit]# autoheader
[[email protected] hello]$ ll
total 192
-rw-rw-r-- 1 litao litao  31120 Aug 12 12:08 aclocal.m4
drwxr-xr-x 2 litao litao   4096 Aug 12 12:14 autom4te.cache
-rw-rw-r-- 1 litao litao      0 Aug 12 12:03 autoscan.log
-rwxrwxr-x 1 litao litao 122297 Aug 12 12:11 configure
-rw-rw-r-- 1 litao litao    496 Aug 12 12:08 configure.in
lrwxrwxrwx 1 litao litao     31 Aug 12 12:16 depcomp -> /usr/share/automake-1.9/depcomp
-rw-rw-r-- 1 litao litao     68 Aug 12 12:02 hello.c
lrwxrwxrwx 1 litao litao     34 Aug 12 12:16 install-sh -> /usr/share/automake-1.9/install-sh
-rw-rw-r-- 1 litao litao     69 Aug 12 12:15 Makefile.am
-rw-rw-r-- 1 litao litao  16561 Aug 12 12:16 Makefile.in
lrwxrwxrwx 1 litao litao     31 Aug 12 12:16 missing -> /usr/share/automake-1.9/missing

六、configure
生成 Makefile， config.log， 和 config.status

生成makefile整個過程

configure.in ：
configure.in檔案內容是一系列GNU m4 的巨集，這些巨集經autoconf處理後會變成檢查系統特性的shell scripts。 configure.in 內巨集的順序並沒有特別的規定，但是每一個configure.in 檔案必須在所有巨集前加入 AC_INIT 巨集，然後在所有巨集的最後加上 AC_OUTPUT巨集。可先用 autoscan 掃描原始檔案以產生一個 configure.scan 檔案，再對 configure.scan 做些修改成 configure.in 檔案。在範例中所用到的巨集如下：

dnl 
這個巨集後面的字不會被處理，可以視為註釋 
AC_INIT(FILE) 
該巨集用來檢查原始碼所在路徑，autoscan 會自動產生，一般無須修改它。 
AM_INIT_AUTOMAKE(PACKAGE,VERSION) 
這個是使用 Automake 所必備的巨集，PACKAGE 是所要產生軟體套件的名稱，VERSION 是版本編號。 
AC_PROG_CC 
檢查系統可用的C編譯器，若原始碼是用C寫的就需要這個巨集。 
AC_OUTPUT(FILE) 
設定 configure 所要產生的檔案，若是Makefile ，configure 便會把它檢查出來的結果帶入  Makefile.in 檔案後產生合適的 Makefile。 
實際上，這裡使用 Automake 時，還需要一些其他的巨集，這些額外的巨集我們用 aclocal來幫助產生。執行 aclocal會產生aclocal.m4 檔案，如果無特別的用途，可以不需要修改它，用 aclocal 所產生的巨集會告訴 Automake如何動作。 

有了 configure.in 及 aclocal.m4兩個檔案以後，便可以執行 autoconf來產生 configure 檔案了。

Makefile.am         Automake 會根據 configure.in 中的巨集把Makefile.am 轉成 Makefile.in 檔案。 Makefile.am 檔案定義所要產生的目標： 

AUTOMAKE_OPTIONS 
設定 automake 的選項。
Automake 主要是幫助開發 GNU 軟體的人員來維護軟體，所以在執行 automake 時，會檢查目錄下是否存在標準 GNU 軟體中應具備的檔案，例如 'NEWS'、'AUTHOR'、'ChangeLog' 等檔案。設定 foreign 時，automake 會改用一般軟體的標準來檢查。 
bin_PROGRAMS 
定義要產生的執行檔名。如果要產生多個執行檔案，每個檔名用空白符隔開。 
hello_SOURCES 
定義 'hello' 這個執行程式所需要的原始檔案。如果 'hello'這個程式是由多個原始檔案所產生，必須把它所用到的所有原始檔案都列出來，以空白符隔開。假設 'hello' 還需要 'hello.c'、'main.c'、'hello.h' 三個檔案的話，則定義 
hello_SOURCES= hello.c main.c hello.h 
如果定義多個執行檔案，則對每個執行程式都要定義相對的filename_SOURCES。 

編輯好 Makefile.am 檔案，就可以用 automake --add-missing來產生 Makefile.in。加上 --add-missing 選項來告訴 automake順便假如包裝一個軟體所必須的檔案。Automake產生生出來的 Makefile.in 檔案是完全符合 GNU Makefile 的慣例，只要執行 configure這個shell script 便可以產生合適的 Makefile 檔案了。 

*************************************************************************

四、深入淺出針對上面提到的各個命令，我們再做些詳細的介紹。

1、 autoscan

autoscan是用來掃描原始碼目錄生成configure.scan檔案的。autoscan可以用目錄名做為引數，但如果你不使用引數的話，那麼 autoscan將認為使用的是當前目錄。autoscan將掃描你所指定目錄中的原始檔，並建立configure.scan檔案。

2、 configure.scan

configure.scan包含了系統配置的基本選項，裡面都是一些巨集定義。我們需要將它改名為configure.in

3、 aclocal

aclocal是一個perl 指令碼程式。aclocal根據configure.in檔案的內容，自動生成aclocal.m4檔案。aclocal的定義是：“aclocal - create aclocal.m4 by scanning configure.ac”。

4、 autoconf

autoconf是用來產生configure檔案的。configure是一個指令碼，它能設定源程式來適應各種不同的作業系統平臺，並且根據不同的系統來產生合適的Makefile，從而可以使你的原始碼能在不同的作業系統平臺上被編譯出來。

configure.in檔案的內容是一些巨集，這些巨集經過autoconf 處理後會變成檢查系統特性、環境變數、軟體必須的引數的shell指令碼。configure.in檔案中的巨集的順序並沒有規定，但是你必須在所有巨集的最前面和最後面分別加上AC_INIT巨集和AC_OUTPUT巨集。在configure.ini中：

#號表示註釋，這個巨集後面的內容將被忽略。

AC_INIT(FILE)

這個巨集用來檢查原始碼所在的路徑。

AM_INIT_AUTOMAKE(PACKAGE, VERSION)

這個巨集是必須的，它描述了我們將要生成的軟體包的名字及其版本號：PACKAGE是軟體包的名字，VERSION是版本號。當你使用make dist命令時，它會給你生成一個類似helloworld-1.0.tar.gz的軟體發行包，其中就有對應的軟體包的名字和版本號。

AC_PROG_CC

這個巨集將檢查系統所用的C編譯器。

AC_OUTPUT(FILE)

這個巨集是我們要輸出的Makefile的名字。我們在使用automake時，實際上還需要用到其他的一些巨集，但我們可以用aclocal 來幫我們自動產生。執行aclocal後我們會得到aclocal.m4檔案。產生了configure.in和aclocal.m4 兩個巨集檔案後，我們就可以使用autoconf來產生configure檔案了。

5、 Makefile.am

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

AUTOMAKE_OPTIONS

這個是automake的選項。在執行automake時，它會檢查目錄下是否存在標準GNU軟體包中應具備的各種檔案，例如AUTHORS、ChangeLog、NEWS等檔案。我們將其設定成foreign時，automake會改用一般軟體包的標準來檢查。

bin_PROGRAMS

這個是指定我們所要產生的可執行檔案的檔名。如果你要產生多個可執行檔案，那麼在各個名字間用空格隔開。

helloworld_SOURCES

這個是指定產生“helloworld”時所需要的原始碼。如果它用到了多個原始檔，那麼請使用空格符號將它們隔開。比如需要 helloworld.h，helloworld.c那麼請寫成helloworld_SOURCES= helloworld.h helloworld.c。如果你在bin_PROGRAMS定義了多個可執行檔案，則對應每個可執行檔案都要定義相對的filename_SOURCES。

6、 automake

我們使用automake --add-missing來產生Makefile.in。選項--add-missing的定義是“add missing standard files to package”，它會讓automake加入一個標準的軟體包所必須的一些檔案。我們用automake產生出來的Makefile.in檔案是符合GNU Makefile慣例的，接下來我們只要執行configure這個shell 指令碼就可以產生合適的 Makefile檔案了。

7、 Makefile

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

make

根據Makefile編譯原始碼，連線，生成目標檔案，可執行檔案。

make clean

清除上次的make命令所產生的object檔案（字尾為“.o”的檔案）及可執行檔案。

make install

將編譯成功的可執行檔案安裝到系統目錄中，一般為/usr/local/bin目錄。

make dist

產生髮布軟體包檔案（即distribution package）。這個命令將會將可執行檔案及相關檔案打包成一個tar.gz壓縮的檔案用來作為釋出軟體的軟體包。它會在當前目錄下生成一個名字類似“PACKAGE-VERSION.tar.gz”的檔案。PACKAGE和VERSION，是我們在configure.in中定義的AM_INIT_AUTOMAKE(PACKAGE, VERSION)。

make distcheck

生成釋出軟體包並對其進行測試檢查，以確定釋出包的正確性。這個操作將自動把壓縮包檔案解開，然後執行configure命令，並且執行make，來確認編譯不出現錯誤，最後提示你軟體包已經準備好，可以釋出了。

===============================================
helloworld-1.0.tar.gz is ready for distribution
===============================================
make distclean

類似make clean，但同時也將configure生成的檔案全部刪除掉，包括Makefile。


相關推薦

AutoTool使用

1.0  簡介 –Makefile而且常常會受到自己的開發環境的限制，只要環境引數不同或者路徑更改，可能 Makefile 就得跟著修改修改。雖然有 GNU Makefile Conventions (GNU Makefile慣例)訂出一些使用 GNU 程式設計時撰寫 Makefile

autotool總結

$(srcdir)/configure: configure.ac aclocal.m4 cd '$(srcdir)' && autoconf # autoheader might not change config.h.in, so tou

AUTOTOOL

說明：autobook：https://sourceware.org/autobook/autoconf手冊：http://www.gnu.org/software/autoconf/manual/autoconf.htmlautomaker手冊：http://www.gnu