Linux之autoconf(1)基礎介紹

Author：Onceday Date：2023年2023年12月10日

漫漫長路，才剛剛開始…

本文主要內容翻譯自Autoconf官方文檔，僅供學習交流之用。

全系列文章請查看專欄: buildroot編譯框架_Once_day的博客-CSDN博客。

參考文檔：

• Autoconf 教程 Part-1 翻譯 - 紅色的紅 - 知乎 (zhihu.com)
• autoconf / automake工具使用介紹 - Primitive - 博客園 (cnblogs.com)
• 感覺autoconf真不太好用，有何替代方案？ - 知乎 (zhihu.com)
• Autoconf - GNU Project - Free Software Foundation
• GNU Autoconf - Creating Automatic Configuration Scripts - GNU Project - Free Software Foundation
• GNU M4 - GNU Project - Free Software Foundation
• GNU M4 - GNU macro processor - GNU Project - Free Software Foundation
• Automake - GNU Project - Free Software Foundation
• Libtool - GNU Project - Free Software Foundation
• GNU Libtool - Portable Dynamic Shared Object Management - GNU Project - Free Software Foundation
• Gnulib - GNU Portability Library - GNU Project - Free Software Foundation
• GNU Autoconf, Automake and Libtool (sourceware.org)
• Autotools Tutorial (epita.fr)

1. 概述

1.1 介紹

Autoconf 是一個為了生成可以自動配置的源代碼包而設計的工具。它的主要目的是創建一個腳本，通常叫做 configure 腳本，它可以在軟件安裝前檢測目標系統的特性并自動調整軟件以適應這些系統。Autoconf 是自由軟件基金會的 GNU 項目的一部分，廣泛應用于 Unix-like 系統上的開源軟件中。

Autoconf 使用 M4 宏處理語言生成 configure 腳本。軟件開發者編寫一個名為 configure.ac 或 configure.in 的模板文件，其中包含了檢測特定功能，庫文件，編譯器選項等的宏調用。Autoconf 處理這個模板文件，并創建一個可移植的 shell 腳本 configure。

主要功能包括：

• 檢測系統特性：檢查編譯器選項、庫函數、系統服務等是否存在。
• 跨平臺支持：通過生成的腳本可以適應多種不同的操作系統和環境。
• 生成 Makefile：通常與 Automake 結合使用，根據 Makefile.am 模板文件生成 Makefile.in，然后 configure 腳本會進一步生成最終的 Makefile。
• 用戶友好：生成的配置腳本通常支持像 --prefix 等標準配置選項，以及檢測過程中的有用提示和錯誤信息。

使用 Autoconf 的基本步驟如下：

1. 編寫 configure.ac：定義宏和測試，指定生成的文件等。
2. 運行 autoconf：生成 configure 腳本。
3. 分發源代碼：將源代碼包含 configure 腳本一起分發。
4. 構建軟件：用戶下載源代碼包后，運行 configure 腳本并接著使用 make 構建軟件。

Autoconf 通常與其他工具一起使用，如 Automake（生成規范的 Makefile 文件）和 Libtool（處理共享庫的生成）。這些工具的結合使用構成了一個強大的自動化構建系統，它可以處理許多編譯和安裝軟件時可能出現的復雜性。

Autoconf解決了一個重要的問題，可靠地發現特定于系統的構建和運行時信息，但這只是可移植軟件開發難題的一部分。為此，GNU項目開發了一套集成的實用程序來完成Autoconf啟動的工作: GNU構建系統，其最重要的組件是Autoconf、Automake和Libtool。

GNU構建系統，有時也被稱為 Autotools，是一套由 GNU 項目開發的編程工具，它們的目的是協助創建跨平臺的軟件包。這套工具包括 Autoconf, Automake, Libtool 和一些其他輔助工具，它們各自承擔不同的職責，協同工作以簡化構建過程。

整體性學習Autotools使用和流程，可以參考下面兩本書(都可以免費查看):

• GNU Autoconf, Automake and Libtool (sourceware.org)
• Autotools Tutorial (epita.fr)

1.2 Autotools之Automake介紹

make的普遍性意味著makefile幾乎是分發軟件自動構建規則的唯一可行方法，但很快就會遇到它的眾多限制。它缺乏對自動依賴跟蹤、子目錄中的遞歸構建、可靠的時間戳(例如，對于網絡文件系統)等等的支持，這意味著開發人員必須為每個項目痛苦地(通常是不正確的)重新發明輪子。

由于make在許多系統上的特性，可移植性是非常重要的。最重要的是，實現用戶期望的許多標準目標(make install、make distclean、make uninstall等)所需的手工勞動。當然，由于使用的是Autoconf，因此還必須在Makefile.in中插入重復的代碼。以識別CC、CFLAGS和configure提供的其他替換，從這里開始，Automake便步入了這個混亂的世界。

Automake允許在Makefile.am中指定構建需求，使用比普通makefile更簡單和更強大的語法生成一個可移植的makefile.in，并在Autoconf中使用。例如，使用Makefile.am構建和安裝一個簡單的“Hello world”程序，如下所示:

bin_PROGRAMS = hello
hello_SOURCES = hello.c

生成的Makefile.in(大概400行代碼)自動支持所有標準目標、Autoconf提供的替換、自動依賴項跟蹤、VPATH構建等功能。Make構建hello程序，make install將其安裝在/usr/local/bin中(如果不是/usr/local，也可以是配置的前綴路徑)。

對于較大的包(特別是帶有子目錄的包)，Automake的好處會增加，但即使對于小程序，增加的便利性和可移植性也是非常重要的。

1.3 Autotools之Gnulib介紹

GNU軟件可以在許多不同類型的系統上運行。雖然主要目標是為GNU系統編寫軟件，但許多用戶和開發人員是通過他們已經在使用的系統被介紹給我們的。

Gnulib是公共GNU代碼的中心位置，旨在在自由軟件包之間共享。它的組件通常在源代碼級別共享，而不是作為構建、安裝和鏈接的庫。其思想是將文件從Gnulib復制到您自己的源代碼樹中。沒有分發包，開發者只需要從存儲庫中獲取源模塊。源文件可在網上，在各種許可證，主要是 GNU GPL 或 GNU LGPL。

Gnulib模塊通常包含C源代碼以及用于配置源代碼的Autoconf宏。例如，Gnulib的stdalign模塊實現了一個幾乎符合C11的stdalin.h標準頭文件，即使在缺乏stdalin .h的老式主機上也是如此。該模塊包含替換頭文件的源文件，以及一個Autoconf宏，該宏安排在老式系統上使用替換頭文件。

1.4 Autotools之Libtool介紹

通常，人們不僅希望構建程序，還希望構建庫，以便其他程序可以從您的勞動成果中受益。理想情況下，人們希望生成共享的(動態鏈接的)庫，它可以被多個程序使用，而不會在磁盤或內存中復制，并且可以獨立于鏈接的程序進行更新。然而，可移植地生成共享庫是一場噩夢：每個系統都有自己不兼容的工具、編譯器標志和魔法咒語。幸運的是，GNU提供了一個解決方案: Libtool。

Libtool可以處理構建共享庫的所有需求，并且目前似乎是實現可移植性的唯一方法。它還處理許多其他令人頭痛的問題，例如:Make規則與共享庫的變量后綴的交互，在超級用戶安裝共享庫之前與它們可靠地鏈接，以及提供一致的版本控制系統(以便可以在不破壞二進制兼容性的情況下安裝或升級庫的不同版本)。雖然Libtool，像Autoconf一樣，可以在沒有Automake的情況下使用。但它與Automake結合使用非常簡單：Libtool在需要共享庫時自動使用，而不需要知道它的語法。

2. Autotools使用流程

本處流程示例參考知乎問答: 感覺autoconf真不太好用，有何替代方案？ - 知乎 (zhihu.com)，其中宅學部落-王利濤(嵌入式C語言自我修養)的回復，欲了解詳情，請訪問以上鏈接，特別是原作者王利濤的文章。

2.1 Autotools工具、項目、庫文件關系圖

雖然上面的圖看起來非常復雜，但是Autotools的發展并非是一蹴而就，其中有則漫長的歲月和時間積累，是在軟件開發過程中不斷解決問題的積累。圖中不同顏色代表了不同的工具作用，下面按照發展歷程總結它們的出現原因。

• Makefile時代，這是最早期的情況，Makefile都是手寫。現在的程序員，更多只是要求能讀懂Makefile，畢竟如cmake和meson等現代化構建工具，比起Makefile，好用多了。

  手寫Makefile時，只需要Makefile、源代碼，便可以編譯出目標執行程序，中間所有Autotools步驟都不需要，但是隨著Unix類系統越來越復雜，Makefile也變得異常復雜，且難以閱讀和調試(真的很難調試)。另外一方面，沒有足夠的經驗(對于絕大部分人都是如此)，Makefile很難符合標準，因此難以移植，往往換個項目和平臺，又要改一堆內容。

  因此，后來出現了configure腳本，先用腳本生成配置變量，再調用Makefile，腳本比起Makefile，更好調試。

• 隨著linux操作系統的出現，Unix系統類別更多，不同系統之間差異越來越大，為了減少程序員在configure腳本上的無用功(多半是重復操作)，因此出現了Autoconf工具，用于自動生成configure腳本。

  對于自動生成configure腳本，其代碼量依舊不少，但是屬于固定模板代碼，不容易出錯(相對于人工編寫而言)。用戶仍然可以定義項目特定的宏變量參數，放在configure.ac文件里，甚至于configure.ac文件都可以通過autoscan自動掃描項目文件來生成。

• 隨著項目的龐大，Makefile手工編寫也越來越復雜，因此除了使用autoconf自動生成配置變量之外，也開發出了automake來自動生成標準的Makefile文件。

  用戶只需手工編寫一個makefile.am文件，定義生成目標和需要編譯的源文件，然后automake便可以自動生成Makefile.in文件，其中包含程序編譯、鏈接的基本規則。再通過configure腳本配置一下，便可以在當前特定平臺上執行。

  Makefile.in是面向于通用平臺的Makefile文件，在autoconf生成特定平臺的配置腳本configure之后，通過該配置腳本，便可以生成特定平臺的Makefile文件(實現一些標準變量定義，以符合特定平臺的需求)。

• Automake和autoconf都會自行定義一些宏變量，這些宏變量需要進行互通，因此便采用M4宏語言實現，即aclocal.m4文件，其中還包含用戶項目自定義的宏參數。

  aclocal工具可以自行收集automake和autoconf以及用戶自定義宏放在aclocal.m4文件里面，這樣就無須手動復制這些宏到M4文件中。

  最終還有一個autoheader工具，該工具可以把configure.ac中的宏配置轉換為C語言的#define宏，這樣在代碼里的宏能根據實際平臺的值進行對應操作。configure腳本最終會生成一個config.h文件，很多配置框架都有類似的文件，比如kconfig這種。

• 隨著動態庫/靜態庫越來越多，之間差異也逐漸增大，包括符號版本控制等。為此，出現了libtool工具，對動態庫進行抽象，統一生成.la的形式，這樣就可以跨平臺支持(告訴Makefile如何操作)。

附錄

附錄: Autotools介紹

(1) M4 宏處理器，M4 是一種通用的宏處理器，是一種用來在文本文件中定義和擴展宏（即預設的文本片段）的工具。它是 Autoconf 的核心組件，因為 Autoconf 的模板文件(configure.ac 或 configure.in)是用 M4 宏語言編寫的。M4 特別適用于生成代碼和自動化文本替換，也可以用來生成 HTML 或 XML 文件。M4 能處理復雜的文本替換和序列，支持條件語句、循環和遞歸宏調用等。

(2) Automake， Automake 是一個生成 Makefile 文件的工具，它使得管理 Makefile 文件更加簡單。它與 Autoconf 緊密集成，使用者僅需編寫一個相對簡單的 Makefile.am 文件，其中包括了程序需要的源文件和編譯指令。然后 Automake 會生成適用于不同平臺的 Makefile.in，這個文件隨后會被 Autoconf 生成的 configure 腳本處理，最終生成用于實際編譯軟件的 Makefile。

(3) Libtool，Libtool 是一個用于統一庫文件編譯的腳本。在 Unix-like 系統中，共享庫和靜態庫的處理方式往往因操作系統的不同而有很大差異。Libtool 抽象了這些差異，允許開發者以統一的方式創建可移植的共享庫。它與 Autoconf 和 Automake 結合使用，使得開發者可以忽略庫文件編譯時的復雜性。

這三個工具經常一起使用，創建了一個強大的構建系統：

1. Autoconf (configure.ac): 生成配置腳本（configure），用于檢測系統特性并配置軟件包以適合當前系統。
2. Automake (Makefile.am): 生成 Makefile.in 模板，定義了如何編譯和安裝程序。
3. Libtool: 處理庫文件的創建和使用。

當開發者準備好了 configure.ac 和 Makefile.am 文件后，他們會按照下面的步驟使用這些工具：

• 使用 autoconf 生成 configure 腳本。
• 使用 automake 生成 Makefile.in。
• 在構建時，運行 configure 腳本，它會檢測系統特性并使用來自 Makefile.in 的指令生成 Makefile。
• 最后，使用 make 命令來構建和安裝軟件。

這個過程隱藏了許多平臺差異，使得開發者可以專注于代碼本身，而不必為各種系統上的構建問題操心。

附錄: Gnulib介紹

Gnulib, 通常稱為 “GNU Portability Library”, 是一個由宏、腳本和代碼組成的庫，用于提高各種 GNU 和其他系統上的軟件包的可移植性。Gnulib 包含了一系列的模塊，每個模塊都提供一種功能，比如提供標準 C 庫中不存在的函數，或者提供一些平臺特有的功能的可移植替代實現。

• 可移植性: Gnulib 的主要目標是解決各種操作系統之間的兼容性問題，特別是 Unix-like 系統和類似于 GNU 系統的環境。
• 模塊化: 它包含了許多獨立的模塊，每個模塊都可以單獨使用。這些模塊通常包括函數、宏、類型定義和其他可以在多個項目之間共享的代碼。
• 自動化工具: Gnulib 配有一個腳本，可以自動將所選擇的模塊集成到你的項目中。
• 廣泛的功能: 它包括了大量的功能，從基本的字符串處理和文件操作到更高級的系統服務和抽象。
• 與 Autotools 的集成: Gnulib 設計為與 GNU 構建系統（Autotools）緊密集成，方便在使用 Autoconf 和 Automake 的項目中利用 Gnulib。

使用 Gnulib 通常涉及以下步驟：

1. 選擇模塊: 項目維護者首先確定他們的軟件需要哪些 Gnulib 模塊來解決可移植性問題或補充缺失功能。
2. 集成模塊: 使用 Gnulib 提供的 gnulib-tool 腳本，將這些模塊的源代碼和其他必要文件復制或鏈接到主項目中。
3. 配置構建系統: 更新項目的 configure.ac 和 Makefile.am 文件（如果使用 Autotools），以便在構建過程中包含和編譯 Gnulib 模塊。

與其他標準庫（如 glibc）不同，Gnulib 更側重于跨平臺的可移植性而不是系統特定的性能優化。此外，Gnulib 不是作為一個共享庫來安裝的，而是作為源代碼直接集成到你的項目中，這意味著它不會引入運行時依賴。

Gnulib 是許多 GNU 軟件和其他開源項目的基礎設施組件，因為它解決了許多在廣泛的環境中編寫可移植代碼時遇到的常見問題。

附錄: Gettext介紹

gettext 是一個國際化（i18n）和本地化（l10n）的工具集，它是 GNU 項目的一部分，用于使軟件能夠根據不同的語言和文化背景來適配其文本輸出。國際化通常指的是將軟件設計得能夠適應多種語言的過程，而本地化是指實際適配軟件到特定語言的過程。

• 提取文本: gettext 工具可以從源代碼中提取出需要翻譯的字符串。
• 編寫和管理翻譯: 它允許翻譯人員在不改變源代碼的情況下編寫翻譯（通常是以 .po 文件格式）。
• 編譯翻譯: 翻譯完成后，gettext 可以將 .po 文件編譯成二進制的 .mo 文件，以便軟件在運行時使用。
• 運行時支持: gettext 運行時庫支持軟件在運行時查找和使用正確的翻譯字符串。

在源代碼中，需要翻譯的字符串會被特殊的宏包圍，如 gettext("Message") 或簡寫的 _() 宏，例如 _ ("Message")。這些宏是標記這些字符串在運行時需要被翻譯的方式。

開發者使用 gettext 相關的工具來處理這些標記過的字符串：

• xgettext: 從源代碼文件中提取帶有 gettext 標記的字符串，并創建 .pot（Portable Object Template）文件，這是一個包含所有待翻譯文本的模板。
• msginit: 初始化一個新的 .po（Portable Object）文件，基于 .pot 文件，為特定語言準備翻譯。
• msgmerge: 更新已有的 .po 文件，合并新的字符串變化。
• msgfmt: 將 .po 文件編譯成 .mo（Machine Object）文件，讓軟件可以使用翻譯后的字符串。

本地化使用流程:

1. 提取: 在開發過程中，通過 xgettext 從源代碼中提取所有需要翻譯的字符串。
2. 初始化: 對于每種目標語言，使用 msginit 來初始化一個 .po 文件。
3. 翻譯: 翻譯人員翻譯 .po 文件中的每個字符串。
4. 編譯: 使用 msgfmt 將翻譯好的 .po 文件編譯成 .mo 文件。
5. 安裝和使用: 將 .mo 文件安裝到系統的適當位置，軟件在運行時會自動使用這些文件中的翻譯字符串。