應(yīng)用程序設(shè)計(jì)：在動(dòng)態(tài)庫(kù)中如何調(diào)用外部函數(shù)？
大家好，我是一個(gè)動(dòng)態(tài)鏈接庫(kù)!
這個(gè)名字，相信你一定早就如雷貫耳了。
在計(jì)算機(jī)早期時(shí)代，由于內(nèi)存資源緊張，我可是發(fā)揮了重大的作用!
不論是在 Windows 系統(tǒng)中，還是在 Unix 系列平臺(tái)上，到處都能見(jiàn)到我的身影，因?yàn)槲夷転榇蠹夜?jié)省很多資源啊，資源就是人民幣!
愉快的玩耍
比如：我的主人編寫(xiě)了這么一段簡(jiǎn)單的代碼：
- # 文件：lib.c
- #include <stdio.h>
- int func_in_lib(int k)
- {
- printf("func_in_lib is called \n");
- return k + 1;
- }
只要用如下命令來(lái)編譯，我就誕生出來(lái)了 lib.so，也就是一個(gè)動(dòng)態(tài)鏈接庫(kù)：
- $ gcc -m32 -fPIC --shared -o lib.so lib.c
這個(gè)時(shí)候，主人隨便把我丟給誰(shuí)，我都可以為他服務(wù)，只要他調(diào)用我肚子里的這個(gè)函數(shù) func_in_lib 就可以了。
雖然目前你看到我提供的這個(gè)函數(shù)很簡(jiǎn)單，但是道理都是一樣的，后面如果有機(jī)會(huì)，我就在這個(gè)函數(shù)里來(lái)計(jì)算機(jī)器人的運(yùn)動(dòng)軌跡，給你瞧一瞧!
例如：張三今天寫(xiě)了一段代碼，需要調(diào)用我的這個(gè)函數(shù)。
張三這個(gè)人比較喜歡騷操作，明明他在編譯可執(zhí)行程序的時(shí)候，把我動(dòng)態(tài)鏈接一下就可以了，就像下面這樣：
- $ gcc -m32 -o main main.c ./lib.so
但是張三偏偏不這么做，為了炫技，他選擇使用 dlopen 動(dòng)態(tài)加載的方式，來(lái)把我從硬盤(pán)上加載到進(jìn)程中。
咱們來(lái)一起圍觀一下張三寫(xiě)的可執(zhí)行程序代碼:
- # 文件：main.c
- #include <unistd.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <dlfcn.h>
- typedef int (*pfunc)(int);
- int main(int argc, char *agv[])
- {
- int a = 1;
- int b;
- // 打開(kāi)動(dòng)態(tài)庫(kù)
- void *handle = dlopen("./lib.so", RTLD_NOW);
- if (handle)
- {
- // 查找動(dòng)態(tài)庫(kù)中的函數(shù)
- pfunc func = (pfunc) dlsym(handle, "func_in_lib");
- if (func)
- {
- b = func(a);
- printf("b = %d \n", b);
- }
- else
- {
- printf("dlsym failed! \n");
- }
- dlclose(handle);
- }
- else
- {
- printf("dlopen failed! \n");
- }
- return 0;
- }
從代碼中可以看到，張三預(yù)先知道我肚子里的這個(gè)函數(shù)名稱(chēng)是 func_in_lib，所以他使用了系統(tǒng)函數(shù) dlsym(handle, "func_in_lib"); 來(lái)找到這個(gè)函數(shù)在內(nèi)存中的加載地址，然后就可以直接調(diào)用這個(gè)函數(shù)了。
張三編譯得到可執(zhí)行文件 main 之后，執(zhí)行結(jié)果完全正確，很開(kāi)心!
悲從中來(lái)
可是有一天，我遇到一件煩人的事情，我的主人說(shuō)：你這個(gè)服務(wù)函數(shù)的計(jì)算過(guò)程太單調(diào)了，給你找點(diǎn)樂(lè)子，你在執(zhí)行的時(shí)候啊，到其他一個(gè)外部模塊里調(diào)用一個(gè)函數(shù)。
話剛說(shuō)完，就丟給我一個(gè)函數(shù)名：void func_in_main(void);。
也就是說(shuō)，我需要在我的服務(wù)函數(shù)中，去調(diào)用其他模塊里的函數(shù)，就像下面這樣：
- #include <stdio.h>
- // 外部函數(shù)聲明
- void func_in_main(void);
- int func_in_lib(int k)
- {
- printf("func_in_lib is called \n");
- // 調(diào)用外部函數(shù)
- func_in_main();
- return k + 1;
- }
那么這個(gè)函數(shù)在哪里呢?天哪，我怎么知道這個(gè)函數(shù)是什么鬼?怎么才能找到它藏在內(nèi)存的那個(gè)角落(地址)里?
不管怎么樣，主人修改了代碼之后，還是很順利的把我編譯了出來(lái):
- $ gcc -m32 -fPIC --shared -o lib.so lib.c
編譯指令完全沒(méi)有變化。
因?yàn)槲覂H僅是一個(gè)動(dòng)態(tài)鏈接庫(kù)，這個(gè)時(shí)候即使我不知道 func_in_main 函數(shù)的地址，也是可以編譯成功的。
只不過(guò)我要把這個(gè)家伙標(biāo)記一下：誰(shuí)要是想使用我，就必須告訴我這個(gè)家伙的地址在哪里!，否則就別怪我耍賴(lài)。
無(wú)辜的張三
我的主人對(duì)張三說(shuō)：兄弟，我的這個(gè)動(dòng)態(tài)鏈接庫(kù)升級(jí)了，功能更強(qiáng)大哦，想不想試一下?
張三心想：我是使用 dlopen 的方式來(lái)動(dòng)態(tài)加載動(dòng)態(tài)庫(kù)文件的，不需要對(duì)可執(zhí)行程序重新編譯或者鏈接，直接運(yùn)行就完事了!
于是他二話不說(shuō)，直接就把我拿過(guò)去，丟在他的可執(zhí)行程序目錄下，然后執(zhí)行 main 程序。
可是這一次，他看到的結(jié)果卻是：
- dlopen failed!
為什么會(huì)加載失敗呢?上次明明是正常執(zhí)行的!張三一臉懵!
其實(shí)，這壓根就不能怪我!以為我剛才就說(shuō)了：誰(shuí)要是想使用我，就必須告訴我 func_in_main 這個(gè)函數(shù)的地址在哪里!
可是在張三的這個(gè)進(jìn)程里，我到處都找不到這個(gè)函數(shù)的地址。既然你沒(méi)法滿(mǎn)足我，那我就沒(méi)法滿(mǎn)足你!
錦囊1: 導(dǎo)出符號(hào)表
張三這下也沒(méi)轍了，只要找我的主人算賬：我的應(yīng)用程序代碼一絲一毫都沒(méi)有動(dòng)，怎么換了你給的新動(dòng)態(tài)鏈接庫(kù)就不行了呢?
主人慢條斯理的回答：疏忽了，疏忽了，忘記跟你說(shuō)一件事情了：這個(gè)動(dòng)態(tài)庫(kù)啊，它需要你多做一件事情：在你的程序中提供一個(gè)名為 func_in_main 的函數(shù)，這樣就可以了。
張三一想：這個(gè)好辦，加一個(gè)函數(shù)就是了。
因?yàn)檫@個(gè)可執(zhí)行程序只有一個(gè) main.c 文件，于是他在其中新加了一個(gè)函數(shù)：
- void func_in_main(void)
- {
- printf("func_in_main \n");
- }
然后就開(kāi)始編譯、執(zhí)行，一頓操作猛如虎：
- # gcc -m32 -o main main.c -ldl
- # ./main
- dlopen failed!
咦?怎么還是失敗?!已經(jīng)按照要求加了 func_in_main 這個(gè)函數(shù)了啊?!
這個(gè)傻X張三，對(duì)，你確實(shí)是在 main.c 中加了這個(gè)函數(shù)，但是你僅僅是加在你的可執(zhí)行程序中的，但是我卻壓根就看不到這個(gè)函數(shù)啊!
不信的話，你檢查一下編譯出來(lái)的可執(zhí)行程序中，是否把 func_in_main 這個(gè)符號(hào)導(dǎo)出來(lái)了?如果不導(dǎo)出來(lái)，我怎么能看到?
- # 查看導(dǎo)出的符號(hào)表
- $ objdump -e main -T | grep func_in_main
- # 這里輸出為空
既然輸出為空，就說(shuō)明沒(méi)有導(dǎo)出來(lái)!這個(gè)就不用我教你了吧?
茴香豆的“茴”字，一共有四種寫(xiě)法。。。
哦，不，導(dǎo)出符號(hào)，一共有兩種方式：
方式1：導(dǎo)出所有的符號(hào)
- $ gcc -m32 -rdynamic -o main main.c -ldl
當(dāng)然，下面這個(gè)指令也可以：
- gcc -m32 -Wl,--export-dynamic -o main main.c -ldl
方式2：導(dǎo)出指定的符號(hào)
先定義一個(gè)文件，把需要導(dǎo)出的符號(hào)全部羅列出來(lái)：
文件：exported.txt
- {
- extern "C"
- {
- func_in_main;
- };
- };
然后，在編譯選項(xiàng)中指定這個(gè)導(dǎo)出文件：
- gcc -m32 -Wl,-dynamic-list=./exported.txt -o main main.c -ldl
使用以上兩種方式的任意一種即可，編譯之后，再使用 objdump 指令看一下導(dǎo)出符號(hào)：
- $ objdump -e main -T | grep func_in_main
- 080485bb g DF .text 00000019 Base func_in_main
嗯，很好很好!張三趕緊按照這樣的方式操作了一下，果真成功執(zhí)行了函數(shù)!
- $ ./main
- func_in_lib is called
- func_in_main
- b = 2
也就是說(shuō)，在我的動(dòng)態(tài)庫(kù)文件中，正確的找到了外部其他模塊中的函數(shù)地址，并且愉快的執(zhí)行成功了!
錦囊2: 動(dòng)態(tài)注冊(cè)
雖然執(zhí)行成功了，張三的心里隱隱約約的仍然有一絲不爽的感覺(jué)，每次編譯都要導(dǎo)出符號(hào)，真麻煩，能不能優(yōu)化一下?
于是他找到我的主人，表達(dá)了自己的不滿(mǎn)。
主人一瞧，有個(gè)性!既然你不想提供，那我就滿(mǎn)足你：
- 首先，在動(dòng)態(tài)庫(kù)中提供一個(gè)默認(rèn)的函數(shù)實(shí)現(xiàn)(func_in_main_def);
- 然后，再提供一個(gè)專(zhuān)門(mén)的注冊(cè)函數(shù)(register_func)，如果外部模塊想提供 func_in_main 這個(gè)函數(shù)，就調(diào)用注冊(cè)函數(shù)注冊(cè)進(jìn)來(lái);
此時(shí)，lib.c 最新的代碼就變成這個(gè)樣子了：
- #include <stdio.h>
- // 默認(rèn)試下
- void func_in_main_def(void)
- {
- printf("the main is lazy, do NOT register me! \n");
- }
- // 定義外部函數(shù)指針
- void (*func_in_main)() = func_in_main_def;
- void register_func(void (*pf)())
- {
- func_in_main = pf;
- }
- int func_in_lib(int k)
- {
- printf("func_in_lib is called \n");
- if (func_in_main)
- func_in_main();
- return k + 1;
- }
然后編譯，全新的我再一次誕生了 lib.so：
- gcc -m32 -fPIC --shared -o lib.so lib.c
主人把我丟給張三的時(shí)候說(shuō)：好了，滿(mǎn)足你的需求，這一次你不用提供 func_in_main 這個(gè)函數(shù)了，當(dāng)然也就不用再導(dǎo)出符號(hào)了。
不過(guò)，如果如果有一天，你改變了注意，又想提供這個(gè)函數(shù)了，那么你就要通過(guò)動(dòng)態(tài)庫(kù)中的 register_func 函數(shù)，把你的函數(shù)注冊(cè)進(jìn)來(lái)。
Have you got it?趕緊再去試一下!
這個(gè)時(shí)候，張三再次使用我的時(shí)候，就不需要導(dǎo)出他的 main.c 里的那個(gè)函數(shù) func_in_main了，實(shí)際上他可以把這個(gè)函數(shù)從代碼中刪掉!
編譯、執(zhí)行，張三再一次猛如虎的操作：
- $ gcc -m32 -o main main.c -ldl
- $ ./main
- func_in_lib is called
- the main is lazy, do NOT register me!
- b = 2
嗯，結(jié)果看起來(lái)是正確的。
咦?怎么多了一行字：the main is lazy, do NOT register me!
難道是在質(zhì)疑我的技術(shù)能力嗎?好吧，既然如此，我也滿(mǎn)足你，不就是注冊(cè)一個(gè)函數(shù)嘛，簡(jiǎn)單：
- // 文件: main.c
- #include <unistd.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <dlfcn.h>
- typedef int (*pfunc)(int);
- typedef int (*pregister)(void (*)());
- // 控制注冊(cè)函數(shù)的宏定義
- #define REG_FUNC
- #ifdef REG_FUNC
- void func_in_main(void)
- {
- printf("func_in_main \n");
- }
- #endif
- int main(int argc, char *agv[])
- {
- int a = 1;
- int b;
- // 打開(kāi)動(dòng)態(tài)庫(kù)
- void *handle = dlopen("./lib.so", RTLD_NOW);
- if (handle)
- {
- #ifdef REG_FUNC
- // 查找動(dòng)態(tài)庫(kù)中的注冊(cè)函數(shù)
- pregister register_func = (pregister) dlsym(handle, "register_func");
- if (register_func)
- {
- register_func(func_in_main);
- }
- #endif
- // 查找動(dòng)態(tài)庫(kù)中的函數(shù)
- pfunc func = (pfunc) dlsym(handle, "func_in_lib");
- if (func)
- {
- b = func(a);
- printf("b = %d \n", b);
- }
- else
- {
- printf("dlsym failed! \n");
- }
- dlclose(handle);
- }
- else
- {
- printf("dlopen failed! \n");
- }
- return 0;
- }
然后編譯、執(zhí)行：
- $ gcc -m32 -o main main.c -ldl
- $ ./main
- func_in_lib is called
- func_in_main
- b = 2
完美收官!
PS：很多平臺(tái)級(jí)的代碼，例如一些工控領(lǐng)域的運(yùn)行時(shí)(Runtime)軟件，大部分都是通過(guò)注冊(cè)的方式，來(lái)把平臺(tái)代碼、用戶(hù)代碼進(jìn)行連接、綁定的。
