在PHP程序中使用Rust扩展的方法

2024-03-29 20:42:04 35

C或PHP中的Rust

我的基本出发点就是写一些可以编译的Rust代码到一个库里面，并写为它一些C的头文件，在C中为被调用的PHP做一个拓展。虽然并不是很简单，但是很有趣。
RustFFI（foreignfunctioninterface）

我所做的第一件事情就是摆弄Rust与C连接的Rust的外部函数接口。我曾用简单的方法（hello_from_rust）写过一个灵活的库，伴有单一的声明（apointertoaCchar,otherwiseknownasastring），如下是输入后输出的“HellofromRust”。

//hello_from_rust.rs
#![crate_type="staticlib"]

#![feature(libc)]
externcratelibc;
usestd::ffi::CStr;

#[no_mangle]
pubextern"C"fnhello_from_rust(name:*constlibc::c_char){
letbuf_name=unsafe{CStr::from_ptr(name).to_bytes()};
letstr_name=String::from_utf8(buf_name.to_vec()).unwrap();
letc_name=format!("HellofromRust,{}",str_name);
println!("{}",c_name);
}

我从C（或其它！）中调用的Rust库拆分它。这有一个接下来会怎样的很好的解释。

编译它会得到.a的一个文件，libhello_from_rust.a。这是一个静态的库，包含它自己所有的依赖关系，而且我们在编译一个C程序的时候链接它，这让我们能做后续的事情。注意：在我们编译后会得到如下输出：

note:linkagainstthefollowingnativeartifactswhenlinkingagainstthisstaticlibrary
note:theorderandanyduplicationcanbesignificantonsomeplatforms,andsomayneedtobepreserved
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

voidhello_from_rust(constchar*name);

#endif

这是一个相当基础的头文件，仅仅为了一个简单的函数提供签名/定义。接着我们需要写一个C程序并使用它。

//hello.c
#include<stdio.h>
#include<stdlib.h>
#include"hello_from_rust.h"

intmain(intargc,char*argv[]){
hello_from_rust("Jared!");
}

我们通过运行一下代码来编译它：

gcc-Wall-ohello_chello.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
HellofromRust,Jared!

漂亮！我们刚才从C中调用了Rust库。现在我们需要理解Rust库是如何进入一个PHP扩展的。

从php中调用c

该部分花了我一些时间来弄明白，在这个世界上，该文档在php扩展中并不是最好的。最好的部分是来自绑定一个脚本ext_skel的php源（大多数代表“扩展骨架”）即生成大多数你需要的样板代码。你可以通过下载来开始，和未配额的php源，把代码写进php目录并且运行：

$cdext/
$./ext_skel--extname=hello_from_rust

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

.rust源
.rust库
.cheader

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

.
├──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个文件

你可以在phpdocs在上面看到关于这些文件很好的描述。建立一个扩展的文件。我们将通过编辑config.m4来开始吧。

不解释，下面就是我的成果：

PHP_ARG_WITH(hello_from_rust,forhello_from_rustsupport,
[--with-hello_from_rustIncludehello_from_rustsupport])

iftest"$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"

//abunchofcommentsandcoderemoved...

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

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

hello_from_rust("Jared(fromPHP!!)!");

len=spprintf(&strg,0,"Congratulations!Youhavesuccessfullymodifiedext/%.78s/config.m4.Module%.78sisnowcompiledintoPHP.","hello_from_rust",arg);
RETURN_STRINGL(strg,len,0);
}

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

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

$phpize
$./configure
$sudomakeinstall

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

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

$phphello_from_rust.php
Functionsavailableinthetestextension:
confirm_hello_from_rust_compiled

HellofromRust,Jared(fromPHP!!)!
Congratulations!Youhavesuccessfullymodifiedext/hello_from_rust/config.m4.Modulehello_from_rustisnowcompiledintoPHP.
Segmentationfault:11

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

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

这里是Rust的代码：


#![crate_type="staticlib"]

 

#![feature(libc)]

externcratelibc;

usestd::ffi::{CStr,CString};

 

#[no_mangle]

pubextern"C"fnhello_from_rust(name:*constlibc::c_char)->*constlibc::c_char{

   letbuf_name=unsafe{CStr::from_ptr(name).to_bytes()};

   letstr_name=String::from_utf8(buf_name.to_vec()).unwrap();

   letc_name  =format!("HellofromRust,{}",str_name);

 

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

}

并变更C头文件：

#ifndef__HELLO
#define__HELLO

constchar*hello_from_rust(constchar*name);

#endif

还要变更C扩展文件：

PHP_FUNCTION(confirm_hello_from_rust_compiled)
{
char*arg=NULL;
intarg_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(fromPHP!!)!");
printf("%s\n",str);

len=spprintf(&strg,0,"Congratulations!Youhavesuccessfullymodifiedext/%.78s/config.m4.Module%.78sisnowcompiledintoPHP.","hello_from_rust",arg);
RETURN_STRINGL(strg,len,0);
}

无用的微基准

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

deffib(at)do
if(at==1||at==0)
returnat
else
returnfib(at-1)+fib(at-2)
end
end

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

deffib(at)do
if(at==1||at==0)
returnat
elsif(val=@cache[at]).present?
returnval
end

total=1
parent=1
gp=1

(1..at).eachdo|i|
total=parent+gp
gp=parent
parent=total
end

returntotal
end

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

deffib(at)do
if(at==1||at==0)
returnat
elsif(val=@cache[at]).present?
returnval
end

total=1
parent=1
gp=1

(1..at).eachdo|i|
total=parent+gp
gp=parent
parent=total
end

returntotal
end

这是它的运行结果：

$timephpphp_fib.php

real0m2.046s
user0m1.823s
sys0m0.207s

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


#![crate_type="staticlib"]

 

fnfib(at:usize)->usize{

   ifat==0{

       return0;

   }elseifat==1{

       return1;

   }

 

   letmuttotal =1;

   letmutparent=1;

   letmutgp    =0;

   for_in1..at{

       total =parent+gp;

       gp    =parent;

       parent=total;

   }

 

   returntotal;

}

 

#[no_mangle]

pubextern"C"fnrust_fib(at:usize)->usize{

   fib(at)

}

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

PHP_FUNCTION(confirm_rust_fib_compiled)
{
longnumber;

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('rust_fib')){
dl('rust_fib.'.PHP_SHLIB_SUFFIX);
}

for($i=0;$i<100000;$i++){
confirm_rust_fib_compiled(92);
}
?>

这就是它的运行结果：

$timephprust_fib.php

real0m0.586s
user0m0.342s
sys0m0.221s

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

在PHP程序中使用Rust扩展的方法

热门推荐

随机推荐