天天看点

使用 Rust 创建 PHP 扩展

去年十月,我和 etsy 的同事有过一个关于如何为像php样的解释性语言写拓展的讨论,ruby或python目前的状况应该会比php容易。我们谈到了写一个成功创建扩展的障碍是它们通常需要用c来写,但是如果你不擅长c这门语言的话很难有那个信心。

使用 Rust 创建 PHP 扩展

从那时起我便萌生了用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。然后在我们编译的时候链接到它。

下面是头文件:

这是一个相当基础的头文件,仅仅为了一个简单的函数提供签名/定义。接着我们需要写一个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 

这将生成需要创建 php 扩展的基本骨架。现在,移动你处处想局部地保持你的扩展的文件夹。并且移动你的

.rust 源

.rust库

.c header

进入同一个目录。因此,现在你应该看看像这样的一个目录:

.

├── credits

├── experimental

├── config.m4

├── config.w32

├── hello_from_rust.c

├── hello_from_rust.h

├── hello_from_rust.php

├── hello_from_rust.rs

├── libhello_from_rust.a

├── php_hello_from_rust.h

└── tests

└── 001.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的定义方法。

// 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 的代码:

use std::ffi::{cstr, cstring}; 

pub extern "c" fn hello_from_rust(name: *const libc::c_char) -> *const libc::c_char { 

cstring::new(c_name).unwrap().as_ptr() 

并变更 c 头文件:

#ifndef __hello 

#define __hello 

const char * hello_from_rust(const char *name); 

#endif 

还要变更 c 扩展文件:

char *str; 

str = hello_from_rust("jared (from php!!)!"); 

printf("%s/n", str); 

无用的微基准

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

def fib(at) do 

if (at == 1 || at == 0) 

return at 

else 

return fib(at - 1) + fib(at - 2) 

end 

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

elsif (val = @cache[at]).present? 

return val 

total = 1 

parent = 1 

gp = 1 

(1..at).each do |i| 

total = parent + gp 

gp = parent 

parent = total 

return total 

那么我们围绕它来写两个例子,一个在php中,一个在rust中。看看哪个更快。下面是php版:

这是它的运行结果: 

$ time php php_fib.php 

real 0m2.046s 

user 0m1.823s 

sys 0m0.207s 

现在我们来做rust版。下面是库资源: 

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; 

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_long(rust_fib(number)); 

运行PHP脚本:

<?php 

$br = (php_sapi_name() == "cli")? "":"<br>"; 

if(!extension_loaded('rust_fib')) { 

dl('rust_fib.' . 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,这是一个很好的方式。

如果你希望查看所有代码或者查看更改记录,可以访问github repo。

来源:51cto