應用程序設計:在動態庫中如何調用外部函數?

大家好,我是一個動態鏈接庫!

這個名字,相信你一定早就如雷貫耳了。

在計算機早期時代,由於內存資源緊張,我可是發揮了重大的作用!

不論是在 Windows 系統中,還是在 Unix 系列平臺上,到處都能見到我的身影,因爲我能爲大家節省很多資源啊,資源就是人民幣!

愉快的玩耍

比如:我的主人編寫了這麼一段簡單的代碼:

# 文件:lib.c

#include <stdio.h>

int func_in_lib(int k)
{
    printf("func_in_lib is called \n");
    return k + 1;
}

只要用如下命令來編譯,我就誕生出來了 lib.so,也就是一個動態鏈接庫:

$ gcc -m32 -fPIC --shared -o lib.so lib.c

這個時候,主人隨便把我丟給誰,我都可以爲他服務,只要他調用我肚子裏的這個函數 func_in_lib 就可以了。

雖然目前你看到我提供的這個函數很簡單,但是道理都是一樣的,後面如果有機會,我就在這個函數里來計算機器人的運動軌跡,給你瞧一瞧!

例如:張三今天寫了一段代碼,需要調用我的這個函數。

張三這個人比較喜歡騷操作,明明他在編譯可執行程序的時候,把我動態鏈接一下就可以了,就像下面這樣:

$ gcc -m32 -o main main.c ./lib.so

但是張三偏偏不這麼做,爲了炫技,他選擇使用 dlopen 動態加載的方式,來把我從硬盤上加載到進程中。

咱們來一起圍觀一下張三寫的可執行程序代碼:

# 文件: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;

    // 打開動態庫
    void *handle = dlopen("./lib.so", RTLD_NOW);
    if (handle)
    {
        // 查找動態庫中的函數
        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;
}

從代碼中可以看到,張三預先知道我肚子裏的這個函數名稱是 func_in_lib,所以他使用了系統函數 dlsym(handle, "func_in_lib"); 來找到這個函數在內存中的加載地址,然後就可以直接調用這個函數了。

張三編譯得到可執行文件 main 之後,執行結果完全正確,很開心!

悲從中來

可是有一天,我遇到一件煩人的事情,我的主人說:你這個服務函數的計算過程太單調了,給你找點樂子,你在執行的時候啊,到其他一個外部模塊裏調用一個函數。

話剛說完,就丟給我一個函數名:void func_in_main(void);

也就是說,我需要在我的服務函數中,去調用其他模塊裏的函數,就像下面這樣:

#include <stdio.h>

// 外部函數聲明
void func_in_main(void);

int func_in_lib(int k)
{
    printf("func_in_lib is called \n");

    // 調用外部函數
    func_in_main();
    
    return k + 1;
}

那麼這個函數在哪裏呢?天哪,我怎麼知道這個函數是什麼鬼?怎麼才能找到它藏在內存的那個角落 (地址) 裏?

不管怎麼樣,主人修改了代碼之後,還是很順利的把我編譯了出來:

$ gcc -m32 -fPIC --shared -o lib.so lib.c

編譯指令完全沒有變化。

因爲我僅僅是一個動態鏈接庫,這個時候即使我不知道 func_in_main 函數的地址,也是可以編譯成功的。

只不過我要把這個傢伙標記一下:誰要是想使用我,就必須告訴我這個傢伙的地址在哪裏!,否則就別怪我耍賴。

無辜的張三

我的主人對張三說:兄弟,我的這個動態鏈接庫升級了,功能更強大哦,想不想試一下?

張三心想:我是使用 dlopen 的方式來動態加載動態庫文件的,不需要對可執行程序重新編譯或者鏈接,直接運行就完事了!

於是他二話不說,直接就把我拿過去,丟在他的可執行程序目錄下,然後執行 main 程序。

可是這一次,他看到的結果卻是:

dlopen failed!

爲什麼會加載失敗呢?上次明明是正常執行的!張三一臉懵逼!

其實,這壓根就不能怪我!以爲我剛纔就說了:誰要是想使用我,就必須告訴我 func_in_main 這個函數的地址在哪裏!

可是在張三的這個進程裏,我到處都找不到這個函數的地址。既然你沒法滿足我,那我就沒法滿足你!

錦囊 1: 導出符號表

張三這下也沒轍了,只要找我的主人算賬:我的應用程序代碼一絲一毫都沒有動,怎麼換了你給的新動態鏈接庫就不行了呢?

主人慢條斯理的回答:疏忽了,疏忽了,忘記跟你說一件事情了:這個動態庫啊,它需要你多做一件事情:在你的程序中提供一個名爲 func_in_main 的函數,這樣就可以了。

張三一想:這個好辦,加一個函數就是了。

因爲這個可執行程序只有一個 main.c 文件,於是他在其中新加了一個函數:

void func_in_main(void)
{
    printf("func_in_main \n");
}

然後就開始編譯、執行,一頓操作猛如虎:

# gcc -m32 -o main main.c -ldl
# ./main
dlopen failed!

咦?怎麼還是失敗?!已經按照要求加了 func_in_main 這個函數了啊?!

這個傻 X 張三,對,你確實是在 main.c 中加了這個函數,但是你僅僅是加在你的可執行程序中的,但是我卻壓根就看不到這個函數啊!

不信的話,你檢查一下編譯出來的可執行程序中,是否把 func_in_main 這個符號導出來了?如果不導出來,我怎麼能看到?

# 查看導出的符號表
$ objdump -e main -T | grep func_in_main
# 這裏輸出爲空

既然輸出爲空,就說明沒有導出來!這個就不用我教你了吧?

茴香豆的 “茴” 字,一共有四種寫法。。。

哦,不,導出符號,一共有兩種方式:

方式 1:導出所有的符號

$ gcc -m32 -rdynamic -o main main.c -ldl

當然,下面這個指令也可以:

gcc -m32 -Wl,--export-dynamic -o main main.c -ldl

方式 2:導出指定的符號

先定義一個文件,把需要導出的符號全部羅列出來:

文件:exported.txt

{
    extern "C"
    {
        func_in_main;
    };
};

然後,在編譯選項中指定這個導出文件:

gcc -m32 -Wl,-dynamic-list=./exported.txt -o main main.c -ldl

使用以上兩種方式的任意一種即可,編譯之後,再使用 objdump 指令看一下導出符號:

$ objdump -e main -T | grep func_in_main
080485bb g    DF .text	00000019  Base        func_in_main

嗯,很好很好!張三趕緊按照這樣的方式操作了一下,果真成功執行了函數!

$ ./main 
func_in_lib is called 
func_in_main 
b = 2

也就是說,在我的動態庫文件中,正確的找到了外部其他模塊中的函數地址,並且愉快的執行成功了!

錦囊 2: 動態註冊

雖然執行成功了,張三的心裏隱隱約約的仍然有一絲不爽的感覺,每次編譯都要導出符號,真麻煩,能不能優化一下?

於是他找到我的主人,表達了自己的不滿。

主人一瞧,有個性!既然你不想提供,那我就滿足你:

  1. 首先,在動態庫中提供一個默認的函數實現 (func_in_main_def);

  2. 然後,再提供一個專門的註冊函數 (register_func),如果外部模塊想提供 func_in_main 這個函數,就調用註冊函數註冊進來;

此時,lib.c 最新的代碼就變成這個樣子了:

#include <stdio.h>

// 默認實現
void func_in_main_def(void)
{
    printf("the main is lazy, do NOT register me! \n");
}

// 定義外部函數指針
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

主人把我丟給張三的時候說:好了,滿足你的需求,這一次你不用提供 func_in_main 這個函數了,當然也就不用再導出符號了。

不過,如果如果有一天,你改變了注意,又想提供這個函數了,那麼你就要通過動態庫中的 register_func 函數,把你的函數註冊進來。

Have you got it?趕緊再去試一下!

這個時候,張三再次使用我的時候,就不需要導出他的 main.c 裏的那個函數 func_in_main 了,實際上他可以把這個函數從代碼中刪掉!

編譯、執行,張三再一次猛如虎的操作:

$ gcc -m32 -o main main.c -ldl
$ ./main
func_in_lib is called 
the main is lazy, do NOT register me! 
b = 2

嗯,結果看起來是正確的。

咦?怎麼多了一行字:the main is lazy, do NOT register me!

難道是在質疑我的技術能力嗎?好吧,既然如此,我也滿足你,不就是註冊一個函數嘛,簡單:

// 文件: main.c

#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <dlfcn.h>

typedef int (*pfunc)(int);
typedef int (*pregister)(void (*)());

// 控制註冊函數的宏定義
#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;

    // 打開動態庫
    void *handle = dlopen("./lib.so", RTLD_NOW);
    if (handle)
    {
#ifdef REG_FUNC
        // 查找動態庫中的註冊函數
        pregister register_func = (pregister) dlsym(handle, "register_func");
        if (register_func)
        {

            register_func(func_in_main);
        }
#endif

        // 查找動態庫中的函數
        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;
}

然後編譯、執行:

$ gcc -m32 -o main main.c -ldl
$ ./main 
func_in_lib is called 
func_in_main 
b = 2

完美收官!

PS:很多平臺級的代碼,例如一些工控領域的運行時 (Runtime) 軟件,大部分都是通過註冊的方式,來把平臺代碼、用戶代碼進行連接、綁定的。

本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s/HSLySL557Df-h5SfU_INmg