前言

受到2022年“谷歌使用Rust重寫(xiě)Android系統(tǒng)且所有Rust代碼的內(nèi)存安全漏洞為零” [1] 的啟發(fā)，最近筆者懷著濃厚的興趣也順應(yīng)Rust 的潮流，嘗試著將一款C語(yǔ)言開(kāi)發(fā)的基礎(chǔ)軟件轉(zhuǎn)化為 Rust 語(yǔ)言。本文的主要目的是通過(guò)記錄此次轉(zhuǎn)化過(guò)程中遇到的比較常見(jiàn)且有意思的問(wèn)題以及解決此問(wèn)題的方法與大家一起做相關(guān)的技術(shù)交流和討論。

問(wèn)題描述

本文將記錄轉(zhuǎn)化過(guò)程中遇到的另外一個(gè)問(wèn)題。該問(wèn)題是由已經(jīng)轉(zhuǎn)化完成的 Rust 代碼使用到軟件中引入的第三方軟件包和鏈接庫(kù)所導(dǎo)致的。設(shè)想這樣一個(gè)場(chǎng)景：Rust 項(xiàng)目中完成某一個(gè)功能點(diǎn)需要用到一個(gè)或多個(gè)第三方軟件包和鏈接庫(kù)。這顯然是很常見(jiàn)的用戶場(chǎng)景，但是由于用戶環(huán)境不同，用戶安裝的第三方軟件包和鏈接庫(kù)的版本不同，使得轉(zhuǎn)化后的 Rust 代碼必須要做適當(dāng)?shù)募嫒萏幚怼?/p>

這里所說(shuō)的用戶的環(huán)境不同，可以理解為芯片指令集的平臺(tái)不同，如 Intel x86 以及國(guó)產(chǎn)的 ARM 麒麟服務(wù)器。當(dāng)然更常見(jiàn)的情形是芯片平臺(tái)相同，但是存在操作系統(tǒng)層面第三方軟件包和鏈接庫(kù)安裝的差異，如 x86 下的 Ubuntu 和 CentOS 中用戶安裝了不同版本的第三方軟件包和鏈接庫(kù)等。

事實(shí)上，即使排除所有平臺(tái)和系統(tǒng)層面的差異，由于用戶安裝了該基礎(chǔ)軟件所依賴的不同版本的第三方軟件包和鏈接庫(kù)，然而這些第三方軟件包或者鏈接庫(kù)由于自身的演進(jìn)導(dǎo)致不同版本之間存在較大差異（可能實(shí)現(xiàn)相同功能的函數(shù)和函數(shù)簽名都有千差萬(wàn)別），這給我重寫(xiě)該軟件的工作帶來(lái)了一些挑戰(zhàn)。基于上述說(shuō)明，在完成重寫(xiě)該基礎(chǔ)軟件的過(guò)程中如何使得轉(zhuǎn)化后的 Rust 代碼能兼容該基礎(chǔ)軟件所依賴的主流第三方軟件包和鏈接庫(kù)則是我遇到的最大挑戰(zhàn)。需要說(shuō)明的是這里的第三方軟件包和鏈接庫(kù)可能是基于 Rust 語(yǔ)言開(kāi)發(fā)的，也可能是基于 C 語(yǔ)言開(kāi)發(fā)的。

解決方案

對(duì)于此問(wèn)題的解決方案需要使用 Rust FFI(Foreign Function Interface) [1]，這基本上是沒(méi)有太大爭(zhēng)議的。因?yàn)樵诒敬诬浖貙?xiě)過(guò)程中我遇到的場(chǎng)景是：對(duì)于不同版本的鏈接庫(kù)使用哪個(gè)版本的函數(shù)取決于用戶的安裝運(yùn)行時(shí)環(huán)境，所以除了 Rust FFI，在代碼適配上我還考慮了使用 Rust features [2] 機(jī)制。

下面我簡(jiǎn)化了一下場(chǎng)景和解決方案，同時(shí)我把樣本代碼放到了我的 github [3] 里，歡迎大家一起交流。如樣本代碼所示，my-rust-bin 文件夾中的一段業(yè)務(wù)代碼需要調(diào)用到靜態(tài)鏈接庫(kù) my_rust_lib 中的函數(shù)，該鏈接庫(kù)有兩個(gè)版本 v1（在文件夾 my-rust-lib-v1 中） 和 v2（在文件夾 my-rust-lib-v2 中）， 且不同版本的庫(kù)其函數(shù)不一樣。

my-rust-lib-v1 對(duì)應(yīng)的業(yè)務(wù)函數(shù)為：pub fn my_rust_lib_v1(left: usize, right: usize) -> usize

my-rust-lib-v2 對(duì)應(yīng)的業(yè)務(wù)函數(shù)為：pub fn my_rust_lib_v2(left: usize, right: usize) -> usize

另外一個(gè) lib 文件夾的目的其實(shí)是為了模擬用戶本地安裝的鏈接庫(kù)?？梢苑謩e編譯不同版本的靜態(tài)鏈接庫(kù)，然后把生成的庫(kù)文件（在本例中是）libmy_rust_lib.a, 然后把不同版本的庫(kù)文件拷貝到此文件夾下，以此來(lái)模擬用戶環(huán)境中安裝的不同版本的鏈接庫(kù)。解決方案中的關(guān)鍵點(diǎn)在于 my-rust-bin 中，

首先在 my-rust-bin 的 Cargo.toml 中有定義對(duì)應(yīng)的 features，如下所示：

[features]
v1=[]
v2=[]

其次在 my-rust-bin 的 src/main.rs 下的代碼如下：

#[cfg(feature="v1")]
modbindingmylib{
extern"C"{
pubfnmy_rust_lib_v1(left:usize,right:usize)->usize;
}
}

#[cfg(feature="v2")]
modbindingmylib{
extern"C"{
pubfnmy_rust_lib_v2(left:usize,right:usize)->usize;
}
}

#[cfg(not(any(feature="v1",feature="v2")))]
compile_error!("Pleasespecifyeither'v1'or'v2'feature");

pubfnmy_rust_lib(left:usize,right:usize)->usize{
#[cfg(feature="v1")]
unsafe{
returnbindingmylib::my_rust_lib_v1(left,right);
}

#[cfg(feature="v2")]
unsafe{
returnbindingmylib::my_rust_lib_v2(left,right);
}
}

fnmain(){
letr_value:usize=my_rust_lib(3,5);
println!("Thereturnvalueofmy_rust_libis[{}]",r_value);
}

現(xiàn)在我來(lái)解讀一下這段代碼。代碼先分別定義一個(gè)相同的模塊 bindingmylib，然后根據(jù) features 分別引入的依賴，使用的不同的靜態(tài)鏈接庫(kù)函數(shù)（my_rust_lib_v1 和 my_rust_lib_v2）, 同時(shí)通過(guò) compile_error! 定義一個(gè)沒(méi)有設(shè)置 v1 和 v2 features 的編譯錯(cuò)誤（防止編譯時(shí)忘記設(shè)置 features選項(xiàng)，下面在編譯環(huán)節(jié)的時(shí)候有用）。最后將兩個(gè)有差異的函數(shù)統(tǒng)一為函數(shù) my_rust_lib，并在該函數(shù)中根據(jù) features 定義分別調(diào)用不同的函數(shù)并返回相應(yīng)的值。

最后是在 my-rust-bin 中編譯二進(jìn)制文件：

編譯并運(yùn)行 v1 的二進(jìn)制文件

#編譯v1版本的my-rust-bin
$cdmy-rust-bin
$cargobuild--features="v1"

#運(yùn)行v1版本的my-rust-bin
$target/debug/my-rust-bin
my_rust_lib_v1:8
Thereturnvalueofmy_rust_libis[8]

編譯并運(yùn)行 v2 的二進(jìn)制文件

#編譯v2版本的my-rust-bin
$cdmy-rust-bin
$cargobuild--features="v2"

#運(yùn)行v2版本的my-rust-bin
$target/debug/my-rust-bin
my_rust_lib_v2:8
Thereturnvalueofmy_rust_libis[8]

備注：如果編譯的時(shí)候沒(méi)有設(shè)置 --features 則會(huì)有如下輸出：

$cargobuild
error:Pleasespecifyeither'v1'or'v2'feature
-->src/main.rs1
|
16|compile_error!("Pleasespecifyeither'v1'or'v2'feature");
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

至此，用戶在編譯好該基礎(chǔ)軟件之后，就可以無(wú)感知的通過(guò)統(tǒng)一的函數(shù)入口調(diào)用不同版本的相同鏈接庫(kù)中的不同函數(shù)了。

總結(jié)

本文主要是在簡(jiǎn)化了問(wèn)題的實(shí)際場(chǎng)景以后，解決不同版本的同一軟件包或者鏈接庫(kù)中，函數(shù)及其函數(shù)簽名不同導(dǎo)致的調(diào)用問(wèn)題。之所以說(shuō)簡(jiǎn)化，主要是本文所描述的場(chǎng)景中，my-rust-bin 和其依賴的外部鏈接庫(kù)均是 Rust 編寫(xiě)。而在我的實(shí)際場(chǎng)景中則會(huì)更復(fù)雜一些，存在著 Rust 代碼依賴 C 編寫(xiě)的外部鏈接庫(kù)，同時(shí)存在混合的原來(lái) C 代碼部分依賴新改寫(xiě)的 Rust 外部鏈接庫(kù)的情況。但是無(wú)論哪種情況，萬(wàn)變不離其宗，我們都可以從這種最簡(jiǎn)單的場(chǎng)景出發(fā)去解決遇到的問(wèn)題。

關(guān)于作者

張懷龍?jiān)吐氂诎柨ㄌ乩视?，百度，IBM等企業(yè)從事云計(jì)算研發(fā)相關(guān)的工作。目前就職于 Intel 中國(guó)，擔(dān)任云原生開(kāi)發(fā)工程師并致力于云原生、服務(wù)網(wǎng)格等技術(shù)領(lǐng)域研究實(shí)踐，也是Istio 的maintainer的開(kāi)發(fā)者。曾多次在 KubeCon、ServiceMeshCon、IstioCon、GOTC 和 InfoQ/QCon 等大會(huì)上發(fā)表演講。

審核編輯：湯梓紅