理解 pkg-config 工具(linux編譯輔助工具)

你在 Unix 或 Linux 下開發(fā)過軟件嗎？寫完一個程序，編譯運(yùn)行完全正常，在你本機(jī)上工作得好好的，你放到源代碼管理系統(tǒng)中。然后，告訴你的同事說，你可以取下來用了。這時，你長長的出了一口氣，幾天的工作沒有白費(fèi)，多么清新的空氣啊，你開始飄飄然了。

“Hi，怎么編譯不過去？”你還沉浸在那種美妙的感覺之中，雙臂充滿著力量，似乎沒有什么問題能難倒你的。正在此時，那個笨蛋已經(jīng)沖著你嚷開了。

“不會吧，我這邊好好的！”表面上你說得很客氣，其實(shí)，你心里已經(jīng)罵開了，真笨，不知道腦子干嘛用的。也許，你想的沒錯，上次，他犯了一個簡單的錯誤，不是你一去就解決了嗎。

他喊三次之后，你不得不放下你手上的工作，剛才那種美妙的感覺已經(jīng)消失得無影無蹤了，要不是你把情緒控制得很好，一肚子氣就要撒在他身上了。你走到他的電腦前，鍵入 make，優(yōu)雅的按下回車。怎么可能出錯呢？你信心十足。然而，屏幕上的結(jié)果多少有點(diǎn)讓人臉紅，該死的，libxxx.so 怎么會讓不到呢？

你在/usr目錄中查找 libxxx.so，一切都逃不過你的眼睛。奇怪，libxxx.so 怎么在 /usr/local/lib 下，不是應(yīng)該在 /usr/lib 下的嗎？這你可不能怪別人，別人想安裝在哪里都行，下次還可能安裝到 /lib 目錄下呢。

以上的場景并非虛構(gòu)，我都經(jīng)歷過好幾次，明明在本機(jī)上好好的，在別人的機(jī)器上連編譯都過不去。可能兩人的操作系統(tǒng)一模一樣，需要的庫都安裝上，只是由于個人 喜好不同，安裝在不同的目錄而已。遇到這種情況，每次都技巧性的繞過去了，用的補(bǔ)丁型的方法，心里老惦記其它地方能不能工作。

今天我們要介紹的 pkg-config，為解決以上問題提供了一個優(yōu)美方案。從此，你再也不為此擔(dān)憂了。pkg-config提供了下面幾個功能：

檢查庫的版本號。如果所需要的庫的版本不滿足要求，它會打印出錯誤信息，避免鏈接錯誤版本的庫文件。
獲得編譯預(yù)處理參數(shù)，如宏定義，頭文件的位置。
獲得鏈接參數(shù)，如庫及依賴的其它庫的位置，文件名及其它一些連接參數(shù)。
自動加入所依賴的其它庫的設(shè)置。
這一切都自動的，庫文件安裝在哪里都沒關(guān)系！

在使用前，我們說說 pkg-config 的原理，pkg-config 并非精靈，可以憑空得到以上信息。事實(shí)上，為了讓pkg-config可以得到這些信息，要求庫的提供者，提供一個.pc文件。比如gtk+-2.0的pc文件內(nèi)容如下：

這個文件一般放在 /usr/lib/pkgconfig/ 或者 /usr/local/lib/pkgconfig/ 里，當(dāng)然也可以放在其它任何地方，如像 X11 相關(guān)的pc文件是放在 /usr/X11R6/lib/pkgconfig 下的。為了讓pkgconfig可以找到你的pc文件，你要把pc文件所在的路徑，設(shè)置在環(huán)境變量 PKG_CONFIG_PATH 里。

使用 pkg-config 的 –cflags 參數(shù)可以給出在編譯時所需要的選項(xiàng)，而 –libs 參數(shù)可以給出連接時的選項(xiàng)。例如，假設(shè)一個 sample.c 的程序用到了 Glib 庫，就可以這樣編譯：

庫本身在安裝的時候必須提供一個相應(yīng)的 .pc 文件(不這樣做的庫說明不支持 pkg-config 工具的使用)。
pkg-config 必須知道要到哪里去尋找此 .pc 文件。
GTK+ 及其依賴庫支持使用 pkg-config 工具，所以剩下的問題就是如何告訴 pkg-config 到哪里去尋找?guī)鞂?yīng)的 .pc 文件，這也是通過設(shè)置搜索路徑來解決的。

對于支持 pkg-config 工具的 GTK+ 及其依賴庫來說，庫的頭文件的搜索路徑的設(shè)置變成了對 .pc 文件搜索路徑的設(shè)置。.pc 文件的搜索路徑是通過環(huán)境變量 PKG_CONFIG_PATH 來設(shè)置的，pkg-config 將按照設(shè)置路徑的先后順序進(jìn)行搜索，直到找到指定的 .pc 文件為止。

安裝完 Glib 后，在 bash 中應(yīng)該進(jìn)行如下設(shè)置：

這樣設(shè)置之后，使用 glib 庫的其它程序或庫在編譯的時候 pkg-config 就知道首先要到 /opt/gtk/lib/pkgconfig 這個目錄中去尋找 glib-2.0.pc 了（GTK+ 和其它的依賴庫的 .pc 文件也將拷貝到這里，也會首先到這里搜索它們對應(yīng)的 .pc 文件）。之后，通過 pkg-config 就可以把其中庫的編譯和連接參數(shù)提取出來供程序在編譯和連接時使用。

另外還需要注意的是：環(huán)境變量的設(shè)置只對當(dāng)前的終端窗口有效。如果到了沒有進(jìn)行上述設(shè)置的終端窗口中，pkg-config 將找不到新安裝的 glib-2.0.pc 文件、從而可能使后面進(jìn)行的安裝（如 glib 之后的 Atk 的安裝）無法進(jìn)行。

在我們采用的安裝方案中，由于是使用環(huán)境變量對 GTK+ 及其依賴庫進(jìn)行的設(shè)置，所以當(dāng)系統(tǒng)重新啟動、或者新開一個終端窗口之后，如果想使用新安裝的 GTK+ 庫，需要如上面那樣重新設(shè)置 PKG_CONFIG_PATH 和 LD_LIBRARY_PATH 環(huán)境變量。

這種使用 GTK+ 的方法，在使用之前多了一個對庫進(jìn)行設(shè)置的過程。雖然顯得稍微繁瑣了一些，但卻是一種最安全的使用 GTK+ 庫的方式，不會對系統(tǒng)上已經(jīng)存在的使用了 GTK+ 庫的程序（比如 GNOME 桌面）帶來任何沖擊。

為了使庫的設(shè)置變得簡單一些，可以把下面的這兩句設(shè)置保存到一個文件中（比如 set_gtk-2.10 文件）:

之后，就可以用下面的方法進(jìn)行庫的設(shè)置了（其中的 source 命令也可以用 . 代替）：

只有在用新版的 GTK+ 庫開發(fā)應(yīng)用程序、或者運(yùn)行使用了新版 GTK+ 庫的程序的時候，才有必要進(jìn)行上述設(shè)置。

如果想避免使用 GTK+ 庫之前上述設(shè)置的麻煩，可以把上面兩個環(huán)境變量的設(shè)置在系統(tǒng)的配置文件中（如 /etc/profile）或者自己的用戶配置文件中（如 ~/.bash_profile） ；庫的搜索路徑也可以設(shè)置在 /etc/ld.so.conf 文件中，等等。這種設(shè)置在系統(tǒng)啟動時會生效，從而會導(dǎo)致使用 GTK+ 的程序使用新版的 GTK+ 運(yùn)行庫，這有可能會帶來一些問題。當(dāng)然，如果你發(fā)現(xiàn)用新版的 GTK+ 代替舊版沒有什么問題的話，使用這種設(shè)置方式是比較方便的。

庫文件在連接（靜態(tài)庫和共享庫）和運(yùn)行（僅限于使用共享庫的程序）時被使用，其搜索路徑是在系統(tǒng)中進(jìn)行設(shè)置的。一般 Linux 系統(tǒng)把 /lib 和 /usr/lib 兩個目錄作為默認(rèn)的庫搜索路徑，所以使用這兩個目錄中的庫時不需要進(jìn)行設(shè)置搜索路徑即可直接使用。對于處于默認(rèn)庫搜索路徑之外的庫，需要將庫的位置添加到庫的搜索路徑之中。設(shè)置庫文件的搜索路徑有下列兩種方式，可任選其一使用：

在環(huán)境變量 LD_LIBRARY_PATH 中指明庫的搜索路徑。
在  /etc/ld.so.conf  文件中添加庫的搜索路徑。
將自己可能存放庫文件的路徑都加入到 /etc/ld.so.conf 中是明智的選擇。（ ^_^）

添加方法也極其簡單，將庫文件的絕對路徑直接寫進(jìn)去就OK了，一行一個。例如：

需要注意的是：第二種搜索路徑的設(shè)置方式對于程序連接時的庫（包括共享庫和靜態(tài)庫）的定位已經(jīng)足夠了，但是對于使用了共享庫的程序的執(zhí)行還是不夠的。這是 因?yàn)闉榱思涌斐绦驁?zhí)行時對共享庫的定位速度，避免使用搜索路徑查找共享庫的低效率，所以是直接讀取庫列表文件 /etc/ld.so.cache 從中進(jìn)行搜索的。/etc/ld.so.cache 是一個非文本的數(shù)據(jù)文件，不能直接編輯，它是根據(jù) /etc/ld.so.conf 中設(shè)置的搜索路徑由 /sbin/ldconfig 命令將這些搜索路徑下的共享庫文件集中在一起而生成的（ldconfig 命令要以 root 權(quán)限執(zhí)行）。因此，為了保證程序執(zhí)行時對庫的定位，在 /etc/ld.so.conf 中進(jìn)行了庫搜索路徑的設(shè)置之后，還必須要運(yùn)行 /sbin/ldconfig 命令更新 /etc/ld.so.cache 文件之后才可以。ldconfig ,簡單的說，它的作用就是將 /etc/ld.so.conf 列出的路徑下的庫文件緩存到/etc/ld.so.cache以供使用。因此當(dāng)安裝完一些庫文件（例如剛安裝好 glib 或者修改 ld.so.conf 增加新的庫路徑)后，需要運(yùn)行一下 /sbin/ldconfig 使所有的庫文件都被緩存到 ld.so.cache 中，如果沒做，即使庫文件明明就在 /usr/lib 下的，也是不會被使用的，結(jié)果編譯過程中抱錯，缺少xxx庫，去查看發(fā)現(xiàn)明明就在那放著，搞的想大罵 computer 蠢豬一個。 （^_^）

在程序連接時，對于庫文件（靜態(tài)庫和共享庫）的搜索路徑，除了上面的設(shè)置方式之外，還可以通過 -L 參數(shù)顯式指定。因?yàn)橛?-L 設(shè)置的路徑將被優(yōu)先搜索，所以在連接的時候通常都會以這種方式直接指定要連接的庫的路徑。

前面已經(jīng)說明過了，庫搜索路徑的設(shè)置有兩種方式：在環(huán)境變量 LD_LIBRARY_PATH 中設(shè)置以及在 /etc/ld.so.conf 文件中設(shè)置。其中，第二種設(shè)置方式需要 root 權(quán)限，以改變 /etc/ld.so.conf 文件并執(zhí)行 /sbin/ldconfig 命令。而且，當(dāng)系統(tǒng)重新啟動后，所有的基于 GTK2 的程序在運(yùn)行時都將使用新安裝的 GTK+ 庫。不幸的是，由于 GTK+ 版本的改變，這有時會給應(yīng)用程序帶來兼容性的問題，造成某些程序運(yùn)行不正常。為了避免出現(xiàn)上面的這些情況，在 GTK+ 及其依賴庫的安裝過程中對于庫的搜索路徑的設(shè)置將采用第一種方式進(jìn)行。這種設(shè)置方式不需要 root 權(quán)限，設(shè)置也簡單：

最后，我來總結(jié)一下，PKG_CONFIG_PATH 主要指明.pc文件的所在路徑，這樣 pkg-config 工具就可以根據(jù).pc文件的內(nèi)容動態(tài)生成編譯和連接選項(xiàng)，比如 Cflags （編譯用）和 Libs （連接用），如果使用的是動態(tài)鏈接庫，那么程序在連接和運(yùn)行時，一般 Linux 系統(tǒng)把 /lib 和 /usr/lib 兩個目錄作為默認(rèn)的庫搜索路徑，對于處于默認(rèn)庫搜索路徑之外的庫，系統(tǒng)管理員可以設(shè)置 LD_LIBRARY_PATH 環(huán)境變量或在 /etc/ld.so.conf 文件中添加庫的搜索路徑。值得說明的是，使用 gcc 連接時的選項(xiàng)，如果不用 pkg-config 工具，需要顯示的聲明連接的動態(tài)鏈接庫名。使用 gcc 的同學(xué)可以查看下面的注意事項(xiàng)。

Linux 系統(tǒng)中，為了讓動態(tài)鏈接庫能被系統(tǒng)中其它程序共享,其名字應(yīng)符合 lib*.so.* 這種格式。如果某個動態(tài)鏈接庫不符合此格式，則 Linux 的動態(tài)鏈接庫自動裝入程序（ld）將搜索不到此鏈接庫，其它程序也無法共享之。格式中，第一個*通常表示為簡寫的庫名,第二個*通常表示為該庫的版本號。如在我的系統(tǒng)中，基本C動態(tài)鏈接庫的名字為 libc.so.6，線程 pthread 動態(tài)鏈接庫的名字為 libpthread.so.0 等等。如果沒有指定版本號，比如 libmy.so ，這也是符合要求的格式。

gcc 命令幾個重要選項(xiàng):

-shared 該選項(xiàng)指定生成動態(tài)連接庫（讓連接器生成T類型的導(dǎo)出符號表，有時候也生成弱連接W類型的導(dǎo)出符號，不用該標(biāo)志外部程序無法連接。相當(dāng)于一個可執(zhí)行文件）。
-fPIC：表示編譯為位置獨(dú)立的代碼，不用此選項(xiàng)的話編譯后的代碼是位置相關(guān)的所以動態(tài)載入時是通過代碼拷貝的方式來滿足不同進(jìn)程的需要，而不能達(dá)到真正代碼段共享的目的。
-L.：表示要連接的庫在當(dāng)前目錄中。
-lmy：編譯器查找動態(tài)連接庫時有隱含的命名規(guī)則，即在給出的名字前面加上lib，后面加上.so來確定庫的名稱（libmy.so）。
當(dāng)然如果有 root 權(quán)限的話，可以修改 /etc/ld.so.conf 文件，然后調(diào)用 /sbin/ldconfig 來達(dá)到同樣的目的，不過如果沒有 root 權(quán)限，那么只能采用輸出 LD_LIBRARY_PATH 的方法了。