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

发布时间：2020-12-13 02:43:46 所属栏目：PHP教程来源：网络整理

导读：《PHP实例：在PHP程序中使用Rust扩展的方法》要点：本文介绍了PHP实例：在PHP程序中使用Rust扩展的方法，希望对您有用。如果有疑问，可以联系我们。 ?C或PHP中的Rust PHP教程我的基本出发点便是写一些可以编译的Rust代码到一个库里面,并写为它一些C的头文

《PHP实例：在PHP程序中使用Rust扩展的方法》要点：
本文介绍了PHP实例：在PHP程序中使用Rust扩展的方法，希望对您有用。如果有疑问，可以联系我们。

?C或PHP中的RustPHP教程

我的基本出发点便是写一些可以编译的Rust代码到一个库里面,并写为它一些C的头文件,在C中为被调用的PHP做一个拓展.虽然并不是很简单,但是很有趣.
Rust FFI(foreign function interface)PHP教程

我所做的第一件事情就是摆弄Rust与C连接的Rust的外部函数接口.我曾用简单的办法(hello_from_rust)写过一个灵活的库,伴有单一的声明(a pointer to a C char,otherwise known as a string),如下是输入后输出的“Hello from Rust”.
?
PHP教程

// 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库拆分它.这有一个接下来会怎样的很好的解释.PHP教程

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

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编译器在我们不使用这个依赖的时候所告诉我们必要链接什么.PHP教程

从C中挪用RustPHP教程

既然我们有了一个库,不得不做两件事来保证它从C中可调用.首先,我们必要为它创建一个C的头文件,hello_from_rust.h.然后在我们编译的时候链接到它.PHP教程

下面是头文件：
?
PHP教程

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

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

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

我们通过运行一下代码来编译它：
?
PHP教程

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编译器可以提供出来.PHP教程

经运行下面的代码我们可以获得一个二进制的文件：
?
PHP教程

$ ./hello_c
Hello from Rust,Jared!

漂亮!我们刚才从C中调用了Rust库.现在我们必要理解Rust库是如何进入一个PHP扩展的.PHP教程

从 php 中挪用 cPHP教程

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

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

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

??? .rust 源
??? .rust库
??? .c header

进入同一个目次.因此,现在你应该看看像这样的一个目次：PHP教程

 .
├── 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教程

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

不解释,下面便是我的成果：
?
PHP教程

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教程

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

#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,"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!!)!");.PHP教程

现在,我们可以试着树立我们的扩展：PHP教程

$ phpize
$ ./configure
$ sudo make install

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

现在,我们可以运行它啦!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 库,开始打印我们的字符串.那很有趣!但是......那段错误的结局发生了什么?PHP教程

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

这里是 Rust 的代码：
?PHP教程

代码如下:

 
#![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 头文件：
?
PHP教程

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

还要变革 C 扩展文件：
?
PHP教程

PHP_FUNCTION(confirm_hello_from_rust_compiled)
{
 char *arg = NULL;
 int arg_len,&arg_len) == FAILURE) {
  return;
 }
 
 char *str;
 str = hello_from_rust("Jared (from PHP!!)!");
 printf("%sn",str);
 
 len = spprintf(&strg,0);
}

无用的微基准PHP教程

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

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

并且可以通过不使用递归来改善这不好的性能：
?
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

那么我们环抱它来写两个例子,一个在PHP中,一个在Rust中.看看哪个更快.下面是PHP版：
?
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

这是它的运行成果：
?
PHP教程

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

现在我们来做Rust版.下面是库资源：
?PHP教程

代码如下:

#![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教程

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教程

<?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);
}
?>

这便是它的运行结果：
PHP教程

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

你可以瞥见它比前者快了三倍!完美的Rust微基准!
PHP教程

欢迎参与《PHP实例：在PHP程序中使用Rust扩展的方法》讨论，分享您的想法，编程之家 52php.cn为您提供专业教程。

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!