使用 rust 建立 php 擴充

去年十月，我和 Etsy 的同事有過一個關於如何為像PHP樣的解釋性語言寫拓展的討論，Ruby或Python目前的狀況應該會比PHP容易。我們談到了寫一個成功創建擴充功能的障礙是它們通常需要用C來寫，但是如果你不擅長C這門語言的話很難有那個信心。

從那時起我便萌生了用Rust寫一個的想法，過去的幾天一直在嘗試。今天早上我終於讓它運行了。

C或PHP中的Rust

我的基本出發點就是寫一些可以編譯的Rust程式碼到一個函式庫裡面，並寫為它一些C的頭文件，在C中為被調用的PHP做一個拓展。雖然不是很簡單，但很有趣。

Rust FFI（foreign function interface）

我所做的第一件事就是擺弄Rust與C連接的Rust的外部函數介面。我曾經用簡單的方法（hello_from_rust）寫過一個靈活的函式庫，伴隨單一的聲明（a pointer to a C char, otherwise known as a string），如下是輸入後輸出的「Hello from Rust」。

// hello_from_rust.rs
#![crate_type = "staticlib"]
#![feature(libc)]
extern crate libc;
use std::ffi::CStr;
#[no_mangle]
pub extern "C" fn hello_from_rust(name: *const libc::c_char) {
    let buf_name = unsafe { CStr::from_ptr(name).to_bytes() };
    let str_name = String::from_utf8(buf_name.to_vec()).unwrap();
    let c_name   = format!("Hello from Rust, {}", str_name);
    println!("{}", c_name);
}

我從C（或其它！）中調用的Rust庫拆分它。這有一個接下來會怎樣的很好的解釋。

編譯它會得到.a的一個文件，libhello_from_rust.a。這是一個靜態的函式庫，包含它自己所有的依賴關係，而且我們在編譯一個C程式的時候連結它，這讓我們能做後續的事情。注意：在我們編譯後會得到如下輸出：

note: link against the following native artifacts when linking against this static library
note: the order and any duplication can be significant on some platforms, and so may need to be preserved
note: library: Systemnote: library: pthread
note: library: c
note: library: m

這就是Rust編譯器在我們不使用這個依賴的時候所告訴我們需要連結什麼。

從C中調用Rust

既然我們有了一個庫，不得不做兩件事來保證它從C中可調用。首先，我們需要為它建立一個C的頭文件，hello_from_rust.h。然後在我們編譯的時候連結到它。

下面是頭文件：

// hello_from_rust.h
#ifndef __HELLO
#define __HELLO
void hello_from_rust(const char *name);
#endif

這是一個相當基礎的頭文件，僅僅為了一個簡單的函數提供簽名/定義。接著我們需要寫一個C程式並使用它。

// hello.c
#include <stdio.h>
#include <stdlib.h>
#include "hello_from_rust.h"
int main(int argc, char *argv[]) {
    hello_from_rust("Jared!");
}

我們通過運行一下程式碼來編譯它：

gcc -Wall -o hello_c hello.c -L /Users/jmcfarland/code/rust/php-hello-rust -lhello_from_rust -lSystem -lpthread -lc -lm

注意在末尾的-lSystem -lpthread -lc -lm告訴gcc不要鏈接那些“本地的古董”，為了當編譯我們的Rust庫時Rust編譯器可以提供出來。

經運行下面的程式碼我們可以得到一個二進位的檔案：

$ ./hello_c
Hello from Rust, Jared!

漂亮！我們剛才從C中呼叫了Rust函式庫。現在我們要理解Rust函式庫是如何進入一個PHP擴充的。

從 php 中調用 c

該部分花了我一些時間來弄清楚，在這個世界上，該文檔在 php 擴展中並不是最好的。最好的部分是來自綁定一個腳本 ext_skel 的 php 來源（大多數代表「擴展骨架」）即產生大多數你需要的樣板程式碼。為了讓程式碼運行，我十分努力地學習 php 文檔，「擴展骨骼」。

你可以透過下載來開始，和未配額的php 來源，把程式碼寫進php 目錄並且運作：

$ cd ext/
$ ./ext_skel –extname=hello_from_rust

這將需要創建需要創建的擴充基本骨架。現在，移動你處處想局部地保持你的擴充的資料夾。並且移動你的

.rust 源

.rust庫

.c header

進入同一個目錄。因此，現在你應該看看像這樣的目錄：

.
├── CREDITS
├── EXPERIMENTAL
├── config.m4
├── config.w32
├⎜✔⠜_ config.w32
✔ ─ hello_from_rust.h
├── hello_from_rust.php
├── hello_from_rust.rs
├── libhello_from_rust.a
testtest phpt

一個目錄，11個文件

你可以在php docs 在上面看到關於這些文件很好的描述。建立一個擴充的檔案。我們將透過編輯 config.m4 來開始吧。

不解釋，以下是我的成果：

PHP_ARG_WITH(hello_from_rust, for hello_from_rust support,
[  --with-hello_from_rust             Include hello_from_rust support])
if test "$PHP_HELLO_FROM_RUST" != "no"; then
  PHP_SUBST(HELLO_FROM_RUST_SHARED_LIBADD)
  PHP_ADD_LIBRARY_WITH_PATH(hello_from_rust, ., HELLO_FROM_RUST_SHARED_LIBADD)
  PHP_NEW_EXTENSION(hello_from_rust, hello_from_rust.c, $ext_shared)
fi

正如我所理解的那样，这些是基本的宏命令。但是有关这些宏命令的文档是相当糟糕的（比如：google”PHP_ADD_LIBRARY_WITH_PATH”并没有出现PHP团队所写的结果）。我偶然这个PHP_ADD_LIBRARY_PATH宏命令在有些人所谈论的在一个PHP拓展里链接一个静态库的先前的线程里。在评论中其它的推荐使用的宏命令是在我运行ext_skel后产生的。

既然我们进行了配置设置，我们需要从PHP脚本中实际地调用库。为此我们得修改自动生成的文件，hello_from_rust.c。首先我们添加hello_from_rust.h头文件到包含命令中。然后我们要修改confirm_hello_from_rust_compiled的定义方法。

#include "hello_from_rust.h"
// a bunch of comments and code removed...
PHP_FUNCTION(confirm_hello_from_rust_compiled)
{
    char *arg = NULL;
    int arg_len, len;
    char *strg;
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {
        return;
    }
    hello_from_rust("Jared (from PHP!!)!");
    len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "hello_from_rust", arg);
    RETURN_STRINGL(strg, len, 0);
}

注意：我添加了hello_from_rust(“Jared (fromPHP!!)!”);。

现在，我们可以试着建立我们的扩展：

$ phpize
$ ./configure
$ sudo make install

就是它，生成我们的元配置，运行生成的配置命令，然后安装该扩展。安装时，我必须亲自使用sudo，因为我的用户并不拥有安装目录的 php 扩展。

现在，我们可以运行它啦！

$ php hello_from_rust.php
Functions available in the test extension:
confirm_hello_from_rust_compiled

Hello from Rust, Jared (from PHP!!)!
Congratulations! You have successfully modified ext/hello_from_rust/config.m4. Module hello_from_rust is now compiled into PHP.
Segmentation fault: 11

还不错，php 已进入我们的 c 扩展，看到我们的应用方法列表并且调用。接着，c 扩展已进入我们的 rust 库，开始打印我们的字符串。那很有趣！但是……那段错误的结局发生了什么？

 

正如我所提到的，这里是使用了 Rust 相关的 println! 宏，但是我没有对它做进一步的调试。如果我们从我们的 Rust 库中删除并返回一个 char* 替代，段错误就会消失。

这里是 Rust 的代码：

#![crate_type = "staticlib"]
#![feature(libc)]
extern crate libc;
use std::ffi::{CStr, CString};
#[no_mangle]
pub extern "C" fn hello_from_rust(name: *const libc::c_char) -> *const libc::c_char {
    let buf_name = unsafe { CStr::from_ptr(name).to_bytes() };
    let str_name = String::from_utf8(buf_name.to_vec()).unwrap();
    let c_name   = format!("Hello from Rust, {}", str_name);
    CString::new(c_name).unwrap().as_ptr()
}

并变更 C 头文件：

#ifndef __HELLO
#define __HELLO
const char * hello_from_rust(const char *name);
#endif

还要变更 C 扩展文件：

PHP_FUNCTION(confirm_hello_from_rust_compiled)
{
 char *arg = NULL;
    int arg_len, len;
    char *strg;

    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {
        return;
    }

    char *str;
    str = hello_from_rust("Jared (from PHP!!)!");
    printf("%s/n", str);

    len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "hello_from_rust", arg);
    RETURN_STRINGL(strg, len, 0);
}

无用的微基准

那么为什么你还要这样做？我还真的没有在现实世界里使用过这个。但是我真的认为斐波那契序列算法就是一个好的例子来说明一个PHP拓展如何很基本。通常是直截了当（在Ruby中）：

def fib(at) do
    if (at == 1 || at == 0)
        return at
    else
        return fib(at - 1) + fib(at - 2)
    end
end

而且可以通过不使用递归来改善这不好的性能：

def fib(at) do
    if (at == 1 || at == 0)
        return at
    elsif (val = @cache[at]).present?
        return val  
    end
    total  = 1
    parent = 1
    gp     = 1
    (1..at).each do |i|
        total  = parent + gp
        gp     = parent
        parent = total
    end
    return total
end

那么我们围绕它来写两个例子，一个在PHP中，一个在Rust中。看看哪个更快。下面是PHP版：

def fib(at) do
    if (at == 1 || at == 0)
        return at
    elsif (val = @cache[at]).present?
        return val  
    end
    total  = 1
    parent = 1
    gp     = 1
    (1..at).each do |i|
        total  = parent + gp
        gp     = parent
        parent = total
    end
    return total
end

这是它的运行结果：

$ time php php_fib.php
real    0m2.046s
user    0m1.823s
sys 0m0.207s

现在我们来做Rust版。下面是库资源：

#![crate_type = "staticlib"]
fn fib(at: usize) -> usize {
    if at == 0 {
        return 0;
    } else if at == 1 {
        return 1;
    }
    let mut total  = 1;
    let mut parent = 1;
    let mut gp     = 0;
    for _ in 1 .. at {
        total  = parent + gp;
        gp     = parent;
        parent = total;
    }
    return total;
}
#[no_mangle]
pub extern "C" fn rust_fib(at: usize) -> usize {
    fib(at)
}

注意，我编译的库rustc – O rust_lib.rs使编译器优化（因为我们是这里的标准）。这里是C扩展源（相关摘录）：

PHP_FUNCTION(confirm_rust_fib_compiled)
{
    long number;
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &number) == FAILURE) {
        return;
    }
    RETURN_LONG(rust_fib(number));
}

运行ＰＨＰ脚本：

<?php
$br = (php_sapi_name() == "cli")? "":"<br>";
if(!extension_loaded(&#39;rust_fib&#39;)) {
    dl(&#39;rust_fib.&#39; . PHP_SHLIB_SUFFIX);
}
for ($i = 0; $i < 100000; $i ++) {
    confirm_rust_fib_compiled(92);
}
?>

这就是它的运行结果：

$ time php rust_fib.php
real    0m0.586s
user    0m0.342s
sys 0m0.221s

你可以看见它比前者快了三倍！完美的Rust微基准！

总结

这里几乎没有得出什么结论。我不确定在Rust上写一个PHP的扩展是一个好的想法，但是花费一些时间去研究Rust，PHP和C，这是一个很好的方式。