1. 程式人生 > >理解 pkg-config 工具

理解 pkg-config 工具

你在 Unix 或 Linux 下開發過軟體嗎?寫完一個程式,編譯執行完全正常,在你本機上工作得好好的,你放到原始碼管理系統中。然後,告訴你的同事說,你可以取下來用了。這時,你長長的出了一口氣,幾天的工作沒有白費,多麼清新的空氣啊,你開始飄飄然了。

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

“不會吧,我這邊好好的!”表面上你說得很客氣,其實,你心裡已經罵開了,真笨,不知道腦子幹嘛用的。也許,你想的沒錯,上次,他犯了一個簡單的錯誤,不是你一去就解決了嗎。

他喊三次之後,你不得不放下你手上的工作,剛才那種美妙的感覺已經消失得無影無蹤了,要不是你把情緒控制得很好,一肚子氣就要撒在他身上了。你走到他的電腦前,鍵入 make,優雅的按下回車。怎麼可能出錯呢?你信心十足。然而,螢幕上的結果多少有點讓人臉紅,該死的,libxxx.so 怎麼會讓不到呢?

你在/usr目錄中查詢 libxxx.so,一切都逃不過你的眼睛。奇怪,libxxx.so 怎麼在 /usr/local/lib 下,不是應該在 /usr/lib 下的嗎?這你可不能怪別人,別人想安裝在哪裡都行,下次還可能安裝到 /lib 目錄下呢。

以上的場景並非虛構,我都經歷過好幾次,明明在本機上好好的,在別人的機器上連編譯都過不去。可能兩人的作業系統一模一樣,需要的庫都安裝上,只是由於個人 喜好不同,安裝在不同的目錄而已。遇到這種情況,每次都技巧性的繞過去了,用的補丁型的方法,心裡老惦記其它地方能不能工作。

今天我們要介紹的 pkg-config,為解決以上問題提供了一個優美方案。從此,你再也不為此擔憂了。pkg-config提供了下面幾個功能:

  1. 檢查庫的版本號。如果所需要的庫的版本不滿足要求,它會打印出錯誤資訊,避免連結錯誤版本的庫檔案。
  2. 獲得編譯預處理引數,如巨集定義,標頭檔案的位置。
  3. 獲得連結引數,如庫及依賴的其它庫的位置,檔名及其它一些連線引數。
  4. 自動加入所依賴的其它庫的設定。

這一切都自動的,庫檔案安裝在哪裡都沒關係!

在使用前,我們說說 pkg-config 的原理,pkg-config 並非精靈,可以憑空得到以上資訊。事實上,為了讓pkg-config可以得到這些資訊,要求庫的提供者,提供一個.pc檔案。比如gtk+-2.0的pc檔案內容如下:

prefix=/usr
exec_prefix=/usr
libdir=/usr/lib
includedir=/usr/include
target=x11

gtk_binary_version=2.4.0
gtk_host=i386-redhat-linux-gnu

Name: GTK+
Description: GIMP Tool Kit (${target} target)
Version: 2.6.7
Requires: gdk-${target}-2.0 atk
Libs: -L${libdir} -lgtk-${target}-2.0
Cflags: -I${includedir}/gtk-2.0

這個檔案一般放在 /usr/lib/pkgconfig/ 或者 /usr/local/lib/pkgconfig/ 裡,當然也可以放在其它任何地方,如像 X11 相關的pc檔案是放在 /usr/X11R6/lib/pkgconfig 下的。為了讓pkgconfig可以找到你的pc檔案,你要把pc檔案所在的路徑,設定在環境變數 PKG_CONFIG_PATH 裡。

使用 pkg-config 的 –cflags 引數可以給出在編譯時所需要的選項,而 –libs 引數可以給出連線時的選項。例如,假設一個 sample.c 的程式用到了 Glib 庫,就可以這樣編譯:

$ gcc -c `pkg-config –cflags glib-2.0` sample.c

然後這樣連線:

$ gcc sample.o -o sample `pkg-config –libs glib-2.0`

或者上面兩步也可以合併為以下一步:

$ gcc sample.c -o sample `pkg-config –cflags –libs glib-2.0`

可以看到:由於使用了 pkg-config 工具來獲得庫的選項,所以不論庫安裝在什麼目錄下,都可以使用相同的編譯和連線命令,帶來了編譯和連線介面的統一。

使用 pkg-config 工具提取庫的編譯和連線引數有兩個基本的前提:

  • 庫本身在安裝的時候必須提供一個相應的 .pc 檔案(不這樣做的庫說明不支援 pkg-config 工具的使用)。
  • pkg-config 必須知道要到哪裡去尋找此 .pc 檔案。

GTK+ 及其依賴庫支援使用 pkg-config 工具,所以剩下的問題就是如何告訴 pkg-config 到哪裡去尋找庫對應的 .pc 檔案,這也是通過設定搜尋路徑來解決的。

對於支援 pkg-config 工具的 GTK+ 及其依賴庫來說,庫的標頭檔案的搜尋路徑的設定變成了對 .pc 檔案搜尋路徑的設定。.pc 檔案的搜尋路徑是通過環境變數 PKG_CONFIG_PATH 來設定的,pkg-config 將按照設定路徑的先後順序進行搜尋,直到找到指定的 .pc 檔案為止。

安裝完 Glib 後,在 bash 中應該進行如下設定:

$ export PKG_CONFIG_PATH=/opt/gtk/lib/pkgconfig:$PKG_CONFIG_PATH

可以執行下面的命令檢查是否 /opt/gtk/lib/pkgconfig 路徑已經設定在 PKG_CONFIG_PATH 環境變數中:

$ echo $PKG_CONFIG_PATH

這樣設定之後,使用 glib 庫的其它程式或庫在編譯的時候 pkg-config 就知道首先要到 /opt/gtk/lib/pkgconfig 這個目錄中去尋找 glib-2.0.pc 了(GTK+ 和其它的依賴庫的 .pc 檔案也將拷貝到這裡,也會首先到這裡搜尋它們對應的 .pc 檔案)。之後,通過 pkg-config 就可以把其中庫的編譯和連線引數提取出來供程式在編譯和連線時使用。

另外還需要注意的是:環境變數的設定只對當前的終端視窗有效。如果到了沒有進行上述設定的終端視窗中,pkg-config 將找不到新安裝的 glib-2.0.pc 檔案、從而可能使後面進行的安裝(如 glib 之後的 Atk 的安裝)無法進行。

在我們採用的安裝方案中,由於是使用環境變數對 GTK+ 及其依賴庫進行的設定,所以當系統重新啟動、或者新開一個終端視窗之後,如果想使用新安裝的 GTK+ 庫,需要如上面那樣重新設定 PKG_CONFIG_PATH 和 LD_LIBRARY_PATH 環境變數。

這種使用 GTK+ 的方法,在使用之前多了一個對庫進行設定的過程。雖然顯得稍微繁瑣了一些,但卻是一種最安全的使用 GTK+ 庫的方式,不會對系統上已經存在的使用了 GTK+ 庫的程式(比如 GNOME 桌面)帶來任何衝擊。

為了使庫的設定變得簡單一些,可以把下面的這兩句設定儲存到一個檔案中(比如 set_gtk-2.10 檔案):

export PKG_CONFIG_PATH=/opt/gtk/lib/pkgconfig:$PKG_CONFIG_PATH
export LD_LIBRARY_PATH=/opt/gtk/lib:$LD_LIBRARY_PATH

之後,就可以用下面的方法進行庫的設定了(其中的 source 命令也可以用 . 代替):

$ source set_gtk-2.10

只有在用新版的 GTK+ 庫開發應用程式、或者執行使用了新版 GTK+ 庫的程式的時候,才有必要進行上述設定。

如果想避免使用 GTK+ 庫之前上述設定的麻煩,可以把上面兩個環境變數的設定在系統的配置檔案中(如 /etc/profile)或者自己的使用者配置檔案中(如 ~/.bash_profile) ;庫的搜尋路徑也可以設定在 /etc/ld.so.conf 檔案中,等等。這種設定在系統啟動時會生效,從而會導致使用 GTK+ 的程式使用新版的 GTK+ 執行庫,這有可能會帶來一些問題。當然,如果你發現用新版的 GTK+ 代替舊版沒有什麼問題的話,使用這種設定方式是比較方便的。

庫檔案在連線(靜態庫和共享庫)和執行(僅限於使用共享庫的程式)時被使用,其搜尋路徑是在系統中進行設定的。一般 Linux 系統把 /lib 和 /usr/lib 兩個目錄作為預設的庫搜尋路徑,所以使用這兩個目錄中的庫時不需要進行設定搜尋路徑即可直接使用。對於處於預設庫搜尋路徑之外的庫,需要將庫的位置新增到庫的搜尋路徑之中。設定庫檔案的搜尋路徑有下列兩種方式,可任選其一使用:

  1. 在環境變數 LD_LIBRARY_PATH 中指明庫的搜尋路徑。
  2. 在  /etc/ld.so.conf  檔案中新增庫的搜尋路徑。

將自己可能存放庫檔案的路徑都加入到 /etc/ld.so.conf 中是明智的選擇。( ^_^)

新增方法也極其簡單,將庫檔案的絕對路徑直接寫進去就OK了,一行一個。例如:

/usr/X11R6/lib
/usr/local/lib
/opt/lib

需要注意的是:第二種搜尋路徑的設定方式對於程式連線時的庫(包括共享庫和靜態庫)的定位已經足夠了,但是對於使用了共享庫的程式的執行還是不夠的。這是 因為為了加快程式執行時對共享庫的定位速度,避免使用搜索路徑查詢共享庫的低效率,所以是直接讀取庫列表檔案 /etc/ld.so.cache 從中進行搜尋的。/etc/ld.so.cache 是一個非文字的資料檔案,不能直接編輯,它是根據 /etc/ld.so.conf 中設定的搜尋路徑由 /sbin/ldconfig 命令將這些搜尋路徑下的共享庫檔案集中在一起而生成的(ldconfig 命令要以 root 許可權執行)。因此,為了保證程式執行時對庫的定位,在 /etc/ld.so.conf 中進行了庫搜尋路徑的設定之後,還必須要執行 /sbin/ldconfig 命令更新 /etc/ld.so.cache 檔案之後才可以。ldconfig ,簡單的說,它的作用就是將 /etc/ld.so.conf 列出的路徑下的庫檔案快取到/etc/ld.so.cache以供使用。因此當安裝完一些庫檔案(例如剛安裝好 glib 或者修改 ld.so.conf 增加新的庫路徑)後,需要執行一下 /sbin/ldconfig 使所有的庫檔案都被快取到 ld.so.cache 中,如果沒做,即使庫檔案明明就在 /usr/lib 下的,也是不會被使用的,結果編譯過程中抱錯,缺少xxx庫,去檢視發現明明就在那放著,搞的想大罵 computer 蠢豬一個。 (^_^)

在程式連線時,對於庫檔案(靜態庫和共享庫)的搜尋路徑,除了上面的設定方式之外,還可以通過 -L 引數顯式指定。因為用 -L 設定的路徑將被優先搜尋,所以在連線的時候通常都會以這種方式直接指定要連線的庫的路徑。

前面已經說明過了,庫搜尋路徑的設定有兩種方式:在環境變數 LD_LIBRARY_PATH 中設定以及在 /etc/ld.so.conf 檔案中設定。其中,第二種設定方式需要 root 許可權,以改變 /etc/ld.so.conf 檔案並執行 /sbin/ldconfig 命令。而且,當系統重新啟動後,所有的基於 GTK2 的程式在執行時都將使用新安裝的 GTK+ 庫。不幸的是,由於 GTK+ 版本的改變,這有時會給應用程式帶來相容性的問題,造成某些程式執行不正常。為了避免出現上面的這些情況,在 GTK+ 及其依賴庫的安裝過程中對於庫的搜尋路徑的設定將採用第一種方式進行。這種設定方式不需要 root 許可權,設定也簡單:

$ export LD_LIBRARY_PATH=/opt/gtk/lib:$LD_LIBRARY_PATH

可以用下面的命令檢視 LD_LIBRAY_PATH 的設定內容:

$ echo $LD_LIBRARY_PATH

最後,我來總結一下,PKG_CONFIG_PATH 主要指明.pc檔案的所在路徑,這樣 pkg-config 工具就可以根據.pc檔案的內容動態生成編譯和連線選項,比如 Cflags (編譯用)和 Libs (連線用),如果使用的是動態連結庫,那麼程式在連線和執行時,一般 Linux 系統把 /lib 和 /usr/lib 兩個目錄作為預設的庫搜尋路徑,對於處於預設庫搜尋路徑之外的庫,系統管理員可以設定 LD_LIBRARY_PATH 環境變數或在 /etc/ld.so.conf 檔案中新增庫的搜尋路徑。值得說明的是,使用 gcc 連線時的選項,如果不用 pkg-config 工具,需要顯示的宣告連線的動態連結庫名。使用 gcc 的同學可以檢視下面的注意事項。

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

gcc 命令幾個重要選項:

  • -shared 該選項指定生成動態連線庫(讓聯結器生成T型別的匯出符號表,有時候也生成弱連線W型別的匯出符號,不用該標誌外部程式無法連線。相當於一個可執行檔案)。
  • -fPIC:表示編譯為位置獨立的程式碼,不用此選項的話編譯後的程式碼是位置相關的所以動態載入時是通過程式碼拷貝的方式來滿足不同程序的需要,而不能達到真正程式碼段共享的目的。
  • -L.:表示要連線的庫在當前目錄中。
  • -lmy:編譯器查詢動態連線庫時有隱含的命名規則,即在給出的名字前面加上lib,後面加上.so來確定庫的名稱(libmy.so)。

當然如果有 root 許可權的話,可以修改 /etc/ld.so.conf 檔案,然後呼叫 /sbin/ldconfig 來達到同樣的目的,不過如果沒有 root 許可權,那麼只能採用輸出 LD_LIBRARY_PATH 的方法了。