linux庫檔案編寫入門【摘自 chinaunix】

 

轉貼自: http://hi.baidu.com/harrybobo/blog/item/ae3347b51711afc637d3ca69.html

 

一、為什麼要使用庫檔案
我們在實際編程工作中肯定會遇到這種情況：有幾個項目裡有一些函數模組的功能相同，
實現代碼也相同，也是我們所說的重複代碼。比如，很多項目裡都有一個使用者驗證的功能。
程式碼片段如下：
//UserLogin.h檔案，提供函式宣告
int IsValidUser(char* username, int namelen);
    //UserLogin.c檔案，實現對使用者資訊的驗證
int IsValidUser(char* username, int namelen)
{
   int IsValid = 0;
   /*下面是具體的處理代碼，略去*/
   return IsValid
}
如果每個項目都儲存著這兩個UserLogin.h和UserLogin.c檔案，會有以下幾個弊端:
1、每個項目裡都有重複的模組，造成代碼重複。  
2、代碼的重用性不好，一旦IsValidUser的代碼發生了變化，為了保持設計的一致性，我們還要手工修改其他項目裡的UserLogin.c檔案，既費時又費力，還容易出錯。  
庫檔案就是對公用代碼的一種組織形式。
為瞭解決上面兩個弊端，就提出了用庫檔案存放公用代碼的解決方案，其要點就是把公用的（也就是可以被多次複用的）目標代碼從項目中分離出來，統一存放到庫檔案中，項目要用到這些代碼的時候，在編譯或者啟動並執行時候從庫檔案中取得目標代碼即可。庫檔案又分兩種：靜態庫和動態庫。

二、靜態庫與動態庫
    如果程式是在編譯時間載入庫檔案的，就是使用了靜態庫。如果是在運行時載入目標代碼，就成為動態庫。換句話說，如果是使用靜態庫，則靜態庫代碼在編譯時間就拷貝到了程式的程式碼片段，程式的體積會膨脹。如果使用動態庫，則程式中只保留庫檔案的名字和函數名，在運行時去尋找庫檔案和函數體，程式的體積基本變化不大。
靜態庫的原則是“以空間換時間”，增加程式體積，減少已耗用時間;
動態庫則是“以時間換空間”，增加了已耗用時間，但減少了程式本身的體積。
下面我們就以實際例子來看看如何使用這兩種庫.

三、靜態庫的編寫和使用
1、概述
靜態庫檔案的副檔名一般為.a,其編寫步驟很簡單。
⑴編寫函數代碼
⑵編譯產生各目標檔案
⑶用ar檔案對目標檔案歸檔，產生靜態庫檔案。
注意歸檔檔案名稱必須以lib打頭。
使用要點：
⑴在gcc 的-I參數後加上靜態庫標頭檔的路徑。
⑵在gcc 的-L參數後加上庫檔案所在目錄
⑶在gcc 的-l參數後加上庫檔案名稱，但是要去掉lib和.a副檔名。
    比如庫檔案名稱是libtest.a 那麼參數就是 -l test
2、編寫最簡單的靜態庫檔案
編寫如下兩個檔案，注意放在同一目錄中
myalib.h //靜態庫標頭檔
myalib.c //靜態庫實現檔案
//myalib.h 檔案的內容
void test();
//myalib.c 檔案的內容
#inlcude
void test()
{
printf("test/n");
}
3、製作庫檔案
⑴產生目標檔案
gcc -c myalib.c
執行完後會產生一個myalib.o檔案
⑵用ar命令歸檔,格式為ar -rc  
再次提醒，歸檔檔案名稱一定要以lib打頭, .a結尾。
ar -rc libtest.a myalib.o
執行完後會產生一個libtest.a檔案
4、使用庫檔案
⑴編寫一個測試程式main.c,內容為
//main.c 測試靜態庫調用的程式
#include "myalib.h" //要把函數的標頭檔包含進來，否則編譯時間會報錯
int main(int argc,char* argv[])
{
test();
return 0;  
}
⑵編譯目標檔案，注意要把靜態庫標頭檔的路徑加到-I參數裡面
gcc -I /root/exercise -o main.o -c main.c
現在產生了一個main.o檔案
⑶產生可執行檔，注意要把靜態庫檔案的路徑加到-L參數裡面，
把庫檔案名稱(去掉打頭的lib和結尾的.a)加到-l參數後面。如下面所示
gcc -o main -L/root/exercise main.o -ltest
此時就會產生一個名為main的可執行檔
另外，注意- l參數好象應該加到輸入檔案名稱的後面，否則會報錯。
比如gcc -o main -L/root/exercise -ltest main.o就會提示
main.o(.text+0x11): In function `main':
: undefined reference to `test'
collect2: ld returned 1 exit status
原因我還不清楚:-)
⑷執行可執行檔查看效果
執行./main， 輸出
test
說明執行成功。

四、動態庫的編寫
1、概述
動態庫一般以.so結尾，就是shared object的意思.
其基本產生步驟為
⑴編寫函數代碼
⑵編譯產生動態庫檔案,要加上 -shared 和 -fpic 選項 ，
    庫檔案名稱以lib開頭， 以.so 結尾。

使用方式分為兩種:[b] [/b][b]隱式調用和顯示調用 [/b]
隱式調用類似於靜態庫的使用，但需修改動態連結程式庫的設定檔/etc/ld.so.conf;
顯示調用則是在主程式裡使用dlopen、dlsym、dlerror、dlclose等系統函數。
具體的調用方式會在 "五、動態庫的調用" 中詳細說明.
2、編寫最簡單的動態庫檔案
為了便於對照， 我們仍然採用靜態庫中的檔案做例子.
編寫如下兩個檔案，注意放在同一目錄中
myalib.h //靜態庫標頭檔
myalib.c //靜態庫實現檔案

//myalib.h 檔案的內容
void test();
//myalib.c 檔案的內容
#inlcude
void test()
{
printf("test/n");
}
3、編譯產生動態庫 ,庫檔案名稱以lib開頭， 以.so 結尾。
gcc -fpic -shared -o libtest.so myalib.c
此時就產生一個libtest.so檔案

五、動態庫的隱式調用
隱式調用的含義是代碼裡不出現庫檔案名稱，就是說這個代碼和
調用靜態庫的代碼是類似的。
1、編寫測試檔案
//main.c 測試動態庫隱式調用的程式
#include "myalib.h" //要把函數的標頭檔包含進來，否則編譯時間會報錯
int main(int argc,char* argv[])
{
test();
return 0;  
}
2、 編譯測試程式,與靜態庫類似,要把標頭檔的路徑加到-I參數裡面
gcc -I /root/exercise -o main.o -c main.c
現在產生了一個main.o檔案
3、串連產生測試程式
gcc -o main -L/root/exercise main.o -ltest
現在產生了一個main檔案
4、執行測試程式
./main
此時出現提示
./main: error while loading shared libraries: libtest.so: cannot open shared object file: No such file or directory。
這個原因就是程式運行時並不知道動態庫所在的路徑，因此自然找不到。
解決這個問題的辦法有三種。見下節

六、使動態庫被系統共用的三種辦法
    (再次說明: 本節參考了電腦世界網雨亦奇的文章"LINUX動態連結程式庫進階應用程式"
    地址
[url=http://www.ccw.com.cn/htm/center/prog/02_3_13_3_2.asp][color=#0000ff]http://www.ccw.com.cn/htm/center/prog/02_3_13_3_2.asp[/color][/url]
)
(1)拷貝動態連結程式庫到系統共用目錄下,或在系統共用目錄下為該動態連結程式庫
建立串連(硬串連或符號串連均可,常用符號串連).這裡說的系統共用目錄,
指的是LINUX動態連結程式庫存放的目錄,包括
/lib,/usr/lib以及/etc/ld.so.conf檔案內所列的一系列目錄.
執行個體：執行
# cp libtest.so /lib
# ldconfig
或:
# ln -s `pwd`/libtest.so /lib
# ldconfig
注意pwd前後有兩個反引號`，其目的是取得pwd命令的輸出，即目前的目錄.
此時再執行main，即可成功.
(2)將動態連結程式庫所在目錄名追加到動態連結程式庫設定檔/etc/ld.so.conf中.
# pwd >> /etc/ld.so.conf
# ldconfig
此時再執行main，即可成功.
(3)利用動態連結程式庫管理命令ldconfig,強制其搜尋指定目錄,並更新快取檔案,便於動態裝入.
# ldconfig `pwd`
此時再執行main，即可成功.
    要注意,第三種方法雖然有效,但效果是暫時的,供程式測試還可以,一旦再度運行ldconfig,則快取檔案內容可能改變,所需的動態連結程式庫可能不被系統共用了.而且無論哪種辦法，其實質都是用ldconfig命令把動態庫檔案所在路徑加入到系統庫列表中，(前兩種永久，第三種臨時)
ldconfig是一個動態連結程式庫管理命令
為了讓動態連結程式庫為系統所共用,還需運行動態連結程式庫的管理命令--ldconfig
ldconfig   命令的用途,主要是在預設搜尋目錄(/lib和/usr/lib)以及動態庫設定檔/etc/ld.so.conf內所列的目錄下,搜尋出可共用的動態連結程式庫(格式如前介紹,lib*.so*),進而建立出動態裝入程式(ld.so)所需的串連和快取檔案.快取檔案預設為   /etc/ld.so.cache,此檔案儲存已排好序的動態連結程式庫名字列表.
ldconfig通常在系統啟動時運行,而當使用者安裝了一個新的動態連結程式庫時,就需要手工運行這個命令.
ldconfig命令列用法如下:
ldconfig [-v|--verbose] [-n] [-N] [-X] [-f CONF] [-C CACHE] [-r ROOT] [-l] [-p|--print-cache] [-c FORMAT] [--format=FORMAT] [-V] [-?|--help|--usage] path...
ldconfig可用的選項說明如下:
(1) -v或--verbose : 用此選項時,ldconfig將顯示正在掃描的目錄及搜尋到的動態連結程式庫,還有它所建立的串連的名字.
(2) -n : 用此選項時,ldconfig僅掃描命令列指定的目錄,不掃描預設目錄(/lib,/usr/lib),也不掃描設定檔/etc/ld.so.conf所列的目錄.
(3) -N : 此選項指示ldconfig不重建快取檔案(/etc/ld.so.cache).若未用-X選項,ldconfig照常更新檔案的串連.
(4) -X : 此選項指示ldconfig不更新檔案的串連.若未用-N選項,則快取檔案正常更新.
(5) -f CONF : 此選項指定動態連結程式庫的設定檔為CONF,系統預設為/etc/ld.so.conf.
(6) -C CACHE : 此選項指定產生的快取檔案為CACHE,系統預設的是/etc/ld.so.cache,此檔案存放已排好序的可共用的動態連結程式庫的列表.
(7)   -r ROOT : 此選項改變應用程式的根目錄為ROOT(是調用chroot函數實現的).選擇此項時,系統預設的設定檔 /etc/ld.so.conf,實際對應的為 ROOT/etc/ld.so.conf.如用-r /usr/zzz時,開啟設定檔 /etc/ld.so.conf時,實際開啟的是/usr/zzz/etc/ld.so.conf檔案.用此選項,可以大大增加動態連結程式庫管理的靈活性.
(8) -l : 通常情況下,ldconfig搜尋動態連結程式庫時將自動建立動態連結程式庫的串連.選擇此項時,將進入專家模式,需要手工設定串連.一般使用者不用此項.
(9) -p或--print-cache : 此選項指示ldconfig列印出當前快取檔案所儲存的所有共用庫的名字.
(10) -c FORMAT 或 --format=FORMAT : 此選項用於指定快取檔案所使用的格式,共有三種: ld(老格式),new(新格式)和compat(相容格式,此為預設格式).
(11) -V : 此選項列印出ldconfig的版本資訊,而後退出.
(12) -? 或 --help 或 --usage : 這三個選項作用相同,都是讓ldconfig列印出其協助資訊,而後退出.

七、動態庫的顯式調用
顯式調用的含義是代碼出現庫檔案名稱，使用者需要自己去
開啟和管理庫檔案。其要點為:
⑴把[b]dlfcn.h[/b]系統標頭檔包含進來
⑵用dlopen函數開啟庫檔案，並指定開啟檔案
dllope的的第一個參數為共用庫的名稱，將會在下面位置尋找指定的共用庫。
①環境變數LD_LIBRARY_PATH列出的用分號間隔的所有目錄。
②檔案/etc/ld.so.cache中找到的庫的列表，由ldconfig命令重新整理。
③目錄usr/lib。
④目錄/lib。
⑤目前的目錄。
第二個參數為開啟共用庫的方式。有兩個取值
①RTLD_NOW：將共用庫中的所有函數載入到記憶體
②RTLD_LAZY：會推後共用庫中的函數的載入操作，直到調用dlsym()時方載入某函數
⑶用dlerror()函數測試是否開啟成功，並進行錯誤處理;
⑷用dlsym獲得函數地址,存放在一個函數指標中
⑸用獲得的函數指標進行函數調用。
⑹程式結束時用dlclose關閉開啟的動態庫，防止資源流失。
⑺用ldconfig工具把動態庫的路徑加到系統庫列表中
1、編寫測試檔案
//main.c 測試動態庫顯式調用的程式
#include    //用於動態庫管理的系統標頭檔  
#include "myalib.h" //要把函數的標頭檔包含進來，否則編譯時間會報錯
int main(int argc,char* argv[])
{
//聲明對應的函數的函數指標
void (*pTest)();
  
      //載入動態庫
void *pdlHandle = dlopen("libtest.so", RTLD_LAZY);
  
//錯誤處理
       if(pdlHandle == NULL ) {
       printf("Failed load library/n");
       return -1;
}
char* pszErr = dlerror();
if(pszErr != NULL)
{
       printf("%s/n", pszErr);
       return -1;
}

//擷取函數的地址
pTest = dlsym(pdlHandle, "test");
pszErr = dlerror();
if(pszErr != NULL)
{
       printf("%s/n", pszErr);
       dlclose(pdlHandle);
       return -1;
}

//實現函數調用
(*pTest)();
//程式結束時關閉動態庫
dlclose(pdlHandle);
return 0;  
}
2、編譯測試檔案 使用-ldl選項指明產生的對象模組需要使用共用庫
gcc -o main -ldl main.c
執行完後就產生了一個main檔案
3、執行測試程式
執行 ./main
輸出
test
說明成功。

八、使用動態庫時應注意的其他問題
1、無論是動態庫的顯式調用還是隱式調用，都需要用
ldconfig工具將動態庫的路徑加到系統庫列表中，否則運行時會出錯。  
2、可以用ldd命令檢查程式都使用到哪些共用庫
ldd命令列用法如下:
ldd [--version] [-v|--verbose] [-d|--data-relocs] [-r|--function-relocs] [--help] FILE...
各選項說明如下:
(1) --version : 此選項用於列印出ldd的版本號碼.
(2) -v 或 --verbose : 此選項指示ldd輸出關於所依賴的動態連結程式庫的儘可能詳細的資訊.
(3) -d 或 --data-relocs : 此選項執行重定位,並且顯示不存在的函數.
(4) -r 或 --function-relocs : 此選項執行資料對象與函數的重定位,同時報告不存在的對象.
(5) --help : 此選項用於列印出ldd的協助資訊.
我們一般用-v選項.
現在看幾個執行個體
⑴用靜態庫串連時的結果
#ldd main
libc.so.6 => /lib/tls/libc.so.6 (0xb74ad000)
/lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0xb75eb000)
可見使用靜態庫時，由於庫已經被編譯成程式的一部分，因此ldd的輸出中就只有用到的
系統庫。
⑵用動態庫隱式串連時的結果
libtest.so => /root/exercise/libtest.so (0xb75e2000)
    libc.so.6 => /lib/tls/libc.so.6 (0xb74ab000)
    /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0xb75eb000)
    可見隱式使用動態庫時，所有用到的動態庫(包括系統和使用者的)都會被顯示出來。
⑶動態庫顯式串連時的結果
ldd main
libdl.so.2 => /lib/libdl.so.2 (0xb75e1000)
libc.so.6 => /lib/tls/libc.so.6 (0xb74aa000)
/lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0xb75eb000)
可見顯式使用動態庫時，程式中不再儲存運行時開啟動態庫的資訊，只保留用到的系統庫的資訊.  
這個與使用靜態庫時的輸出是類似的.