【原】讓PHP能夠調(diào)用C的函數(shù)-FFI擴展

硬核項目經(jīng)理 2021-05-31

展開全文

讓PHP能夠調(diào)用C的函數(shù)-FFI擴展

在大型公司中，一般會有很多編程語言的配合。比如說讓 Java 來做微服務層，用 C++ 來進行底層運算，用 PHP 來做中間層，最后使用 JS 展現(xiàn)效果。這些語言間的配合大部分都是通過 RPC 來完成，或者直接將數(shù)據(jù)入庫再使用不同的語言來取用。那么，我們 PHP 的代碼能否直接調(diào)用這些語言呢？其實，PHP 還真為我們準備了一個可以直接調(diào)用 C 語言的擴展庫，并且這個擴展庫還是已經(jīng)默認內(nèi)置在 PHP 中了，它就是 FFI 擴展。

什么是 FFI

FFI ， Foreign Function Interface，外部函數(shù)接口。這個擴展允許我們加載一些公共庫（.dll、.so），其實也就是可以調(diào)用一些 C 的數(shù)據(jù)結(jié)構(gòu)及函數(shù)。它已經(jīng)是隨 PHP 源碼發(fā)布的一個擴展了，在編譯的時候可以加上 --with-ffi 來直接編譯到 PHP 程序中。

我們這里已經(jīng)是編譯好的 PHP ，所以我們直接找到這個擴展，進行簡單的擴展安裝步驟就可以安裝完成。

cd php-7.4.4/ext/ffi/
phpize
./configure
make && make install

安裝完成后記得在 php.ini 文件中打開擴展。關(guān)于這個擴展需要注意的一點是，它有一個配置項為 ffi.enable ，默認情況下這個配置項的值是 "preload" ，僅在 CLI SAPI 環(huán)境下啟用 FFI 的能力。當然，我們也可以修改為 "true" 或 "false" 來開啟和關(guān)閉它。設定為 "true" 將使得這個擴展在任何環(huán)境下都啟用。

使用 FFI 調(diào)用 C 的函數(shù)

接下來，簡單地看一下它是如何調(diào)用 C 的函數(shù)的。

// 創(chuàng)建一個 FFI 對象，加載 libc 并且導入 printf 函數(shù)
$ffi_printf = FFI::cdef(
    "int printf(const char *format, ...);", // C 的定義規(guī)則
    "libc.so.6"); // 指定 libc 庫
// 調(diào)用 C 的 printf 函數(shù)
$ffi_printf->printf("Hello %s!\n", "world"); // Hello World

// 加載 math 并且導入 pow 函數(shù)
$ffi_pow = FFI::cdef(
    "double pow(double x, double y);", 
    "libboost_math_c99.so.1.66.0");
// 這里調(diào)用的是 C 的 pow 函數(shù)，不是 PHP 自己的
echo $ffi_pow->pow(2,3), PHP_EOL; // 8

我們創(chuàng)建了兩個對象，分別調(diào)用了 C 的 printf() 和 pow() 函數(shù)。FFI::cdef() 是用于創(chuàng)建一個 FFI 對象，它接收兩個參數(shù)，一個是包含常規(guī)C語言（類型、結(jié)構(gòu)、函數(shù)、變量等）聲明序列的字符串。實際上，這個字符串可以從C頭文件復制粘貼。而另一個參數(shù)則是要加載并定義鏈接的共享庫文件的名稱。也就是我們需要的 .dll 或 .so 文件，它與我們聲明字符串是對應的，比如在 libc.so.6 中并沒有 pow() 這類的計算函數(shù)，所以我們就要找到 math 相關(guān)的 C 語言計算函數(shù)庫。

定義變量和數(shù)組

當然，F(xiàn)FI 也是可以定義變量和數(shù)組的。

// 創(chuàng)建一個 int 變量
$x = FFI::new("int");
var_dump($x->cdata); // int(0)

// 為變量賦值
$x->cdata = 5;
var_dump($x->cdata); // int(5)

// 計算變量
$x->cdata += 2;
var_dump($x->cdata); // int(7)


// 結(jié)合上面的兩個 FFI 對象操作

echo "pow value:", $ffi_pow->pow($x->cdata, 3), PHP_EOL;
// pow value:343
$ffi_printf->printf("Int Pow value is : %f\n", $ffi_pow->pow($x->cdata, 3));
// Int Pow value is : 343.000000


// 創(chuàng)建一個數(shù)組
$a = FFI::new("long[1024]");
// 為數(shù)組賦值
for ($i = 0; $i < count($a); $i++) {
    $a[$i] = $i;
}
var_dump($a[25]); // int(25)

$sum = 0;
foreach ($a as $n) {
    $sum += $n;
}
var_dump($sum); // int(523776)

var_dump(count($a)); // int(1024) 數(shù)組長度
var_dump(FFI::sizeof($a)); // int(8192)，內(nèi)存大小

使用 FFI::new() 函數(shù)來創(chuàng)建一個 C 的數(shù)據(jù)結(jié)構(gòu)，也就是變量聲明，這些變量的內(nèi)容將保存在 cdata 屬性中。而數(shù)組則直接就可以操作這個函數(shù)的返回值。當然，當我們要結(jié)束使用的時候，還是需要使用 FFI::free() 來釋放變量的，就和 C 語言的開發(fā)一樣。

總結(jié)

是不是感覺很高大上？但是請注意哦，F(xiàn)FI 調(diào)用的 C 函數(shù)并沒有 PHP 本身去調(diào)用的效率高。比如這種 pow() 函數(shù)，使用 PHP 自身的效率更好。而且，F(xiàn)FI 擴展雖說已經(jīng)是跟隨 PHP 同步發(fā)布的擴展，但它還是處于實驗性質(zhì)的。也就是說，這個擴展是為未來可能用到的其它功能準備的，而且還有很多不確定性。所以在生產(chǎn)環(huán)境中如果需要合適類似的功能的話，那么還是要做更多的深入調(diào)研哦。

測試代碼：https://github.com/zhangyue0503/dev-blog/blob/master/php/202004/source/%E8%AE%A9PHP%E8%83%BD%E5%A4%9F%E8%B0%83%E7%94%A8C%E7%9A%84%E5%87%BD%E6%95%B0-FFI%E6%89%A9%E5%B1%95.php

參考文檔：https://www./manual/zh/intro.ffi.phphttps://www./manual/zh/ffi.examples-basic.php