当前位置:Gxlcms > PHP教程 > 使用Rust创建PHP扩展_PHP教程

使用Rust创建PHP扩展_PHP教程

时间:2021-07-01 10:21:17 帮助过:18人阅读

使用 Rust 创建 PHP 扩展


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

使用 Rust 创建 PHP 扩展

从那时起我便萌生了用Rust写一个的想法,过去的几天一直在尝试。今天上午我终于让它运行了。
C或PHP中的Rust

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

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

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

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

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

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

这就是Rust编译器在我们不使用这个依赖的时候所告诉我们需要链接什么。
从C中调用Rust

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

下面是头文件:

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

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

  1. // hello.c
  2. #include
  3. #include
  4. #include "hello_from_rust.h"
  5. int main(int argc, char *argv[]) {
  6. hello_from_rust("Jared!");
  7. }

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

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编译器可以提供出来。

经运行下面的代码我们可以得到一个二进制的文件:

  1. $ ./hello_c
  2. Hello from Rust, Jared!

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

从 php 中调用 c

该部分花了我一些时间来弄明白,在这个世界上,该文档在 php 扩展中并不是最好的。最好的部分是来自绑定一个脚本 ext_skel 的 php 源大多数代表“扩展骨架”)即生成大多数你需要的样板代码。为了让代码运行,我十分努力地学习 php 文档,“扩展骨骼”。

你可以通过下载来开始,和未配额的 php 源,把代码写进 php 目录并且运行:

  1. $ cd ext/
  2. $ ./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 来开始吧。

不解释,下面就是我的成果:

  1. PHP_ARG_WITH(hello_from_rust, for hello_from_rust support,
  2. [ --with-hello_from_rust Include hello_from_rust support])
  3. if test "$PHP_HELLO_FROM_RUST" != "no"; then
  4. PHP_SUBST(HELLO_FROM_RUST_SHARED_LIBADD)
  5. PHP_ADD_LIBRARY_WITH_PATH(hello_from_rust, ., HELLO_FROM_RUST_SHARED_LIBADD)
  6. PHP_NEW_EXTENSION(hello_from_rust, hello_from_rust.c, $ext_shared)
  7. 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的定义方法。

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

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

现在,我们可以试着建立我们的扩展:

  1. $ phpize
  2. $ ./configure
  3. $ sudo make install

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

现在,我们可以运行它啦!

  1. $ php hello_from_rust.php
  2. Functions available in the test extension:
  3. confirm_hello_from_rust_compiled
  4. Hello from Rust, Jared (from PHP!!)!
  5. Congratulations! You have successfully modified ext/hello_from_rust/config.m4. Module hello_from_rust is now compiled into PHP.
  6. Segmentation fault: 11

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

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

这里是 Rust 的代码:

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

并变更 C 头文件:

  1. #ifndef __HELLO
  2. #define __HELLO
  3. const char * hello_from_rust(const char *name);
  4. #endif

还要变更 C 扩展文件:

  1. PHP_FUNCTION(confirm_hello_from_rust_compiled)
  2. {
  3. char *arg = NULL;
  4. int arg_len, len;
  5. char *strg;
  6. if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {
  7. return;
  8. }
  9. char *str;
  10. str = hello_from_rust("Jared (from PHP!!)!");
  11. printf("%s/n", str);
  12. len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "hello_from_rust", arg);
  13. RETURN_STRINGL(strg, len, 0);
  14. }

无用的微基准

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

  1. def fib(at) do
  2. if (at == 1 || at == 0)
  3. return at
  4. else
  5. return fib(at - 1) + fib(at - 2)
  6. end
  7. end

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

  1. def fib(at) do
  2. if (at == 1 || at == 0)
  3. return at
  4. elsif (val = @cache[at]).present?
  5. return val
  6. end
  7. total = 1
  8. parent = 1
  9. gp = 1
  10. (1..at).each do |i|
  11. total = parent + gp
  12. gp = parent
  13. parent = total
  14. end
  15. return total
  16. end

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

  1. def fib(at) do
  2. if (at == 1 || at == 0)
  3. return at
  4. elsif (val = @cache[at]).present?
  5. return val
  6. end
  7. total = 1
  8. parent = 1
  9. gp = 1
  10. (1..at).each do |i|
  11. total = parent + gp
  12. gp = parent
  13. parent = total
  14. end
  15. return total
  16. end
  17. 这是它的运行结果:
  18. $ time php php_fib.php
  19. real 0m2.046s
  20. user 0m1.823s
  21. sys 0m0.207s
  22. 现在我们来做Rust版。下面是库资源:
  23. #![crate_type = "staticlib"]
  24. fn fib(at: usize) -> usize {
  25. if at == 0 {
  26. return 0;
  27. } else if at == 1 {
  28. return 1;
  29. }
  30. let mut total = 1;
  31. let mut parent = 1;
  32. let mut gp = 0;
  33. for _ in 1 .. at {
  34. total = parent + gp;
  35. gp = parent;
  36. parent = total;
  37. }
  38. return total;
  39. }
  40. #[no_mangle]
  41. pub extern "C" fn rust_fib(at: usize) -> usize {
  42. fib(at)
  43. }
  44. 注意,我编译的库rustc – O rust_lib.rs使编译器优化因为我们是这里的标准)。这里是C扩展源相关摘录):
  45. PHP_FUNCTION(confirm_rust_fib_compiled)
  46. {
  47. long number;
  48. if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &number) == FAILURE) {
  49. return;
  50. }
  51. RETURN_LONG(rust_fib(number));
  52. }

运行PHP脚本:

  1. $br = (php_sapi_name() == "cli")? "":"
    "
    ;
  2. if(!extension_loaded('rust_fib')) {
  3. dl('rust_fib.' . PHP_SHLIB_SUFFIX);
  4. }
  5. for ($i = 0; $i < 100000; $i ++) {
  6. confirm_rust_fib_compiled(92);
  7. }
  8. ?>
  9. 这就是它的运行结果:
  10. $ time php rust_fib.php
  11. real 0m0.586s
  12. user 0m0.342s
  13. sys 0m0.221s

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

总结

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

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



www.bkjia.comtruehttp://www.bkjia.com/PHPjc/986377.htmlTechArticle使用 Rust 创建 PHP 扩展 去年十月,我和 Etsy 的同事有过一个关于如何为像PHP样的解释性语言写拓展的讨论,Ruby或Python目前的状况应该会比...

人气教程排行