使用 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”。


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

我从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 <stdio.h> 
  3. #include <stdlib.h> 
  4. #include "hello_from_rust.h" 
  5.  
  6. int main(int argc, char *argv[]) { 
  7. 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编译器可以提供出来。

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


 
 
  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.  
  4. if test "$PHP_HELLO_FROM_RUST" != "no"; then 
  5. PHP_SUBST(HELLO_FROM_RUST_SHARED_LIBADD) 
  6.  
  7. PHP_ADD_LIBRARY_WITH_PATH(hello_from_rust, ., HELLO_FROM_RUST_SHARED_LIBADD) 
  8.  
  9. PHP_NEW_EXTENSION(hello_from_rust, hello_from_rust.c, $ext_shared
  10. 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.  
  3. // a bunch of comments and code removed... 
  4.  
  5. PHP_FUNCTION(confirm_hello_from_rust_compiled) 
  6. char *arg = NULL; 
  7. int arg_len, len; 
  8. char *strg; 
  9.  
  10. if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) { 
  11. return
  12.  
  13. hello_from_rust("Jared (from PHP!!)!"); 
  14.  
  15. len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.""hello_from_rust", arg); 
  16. RETURN_STRINGL(strg, len, 0); 

注意:我添加了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.  
  5. Hello from Rust, Jared (from PHP!!)! 
  6. Congratulations! You have successfully modified ext/hello_from_rust/config.m4. Module hello_from_rust is now compiled into PHP. 
  7. Segmentation fault: 11 

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

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

这里是 Rust 的代码:


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

并变更 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. char *arg = NULL; 
  3. int arg_len, len; 
  4. char *strg; 
  5.  
  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.  
  13. len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.""hello_from_rust", arg); 
  14. RETURN_STRINGL(strg, len, 0); 

无用的微基准

那么为什么你还要这样做?我还真的没有在现实世界里使用过这个。但是我真的认为斐波那契序列算法就是一个好的例子来说明一个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.  
  8. total = 1 
  9. parent = 1 
  10. gp = 1 
  11.  
  12. (1..at).each do |i| 
  13. total = parent + gp 
  14. gp = parent 
  15. parent = total 
  16. end 
  17.  
  18. return total 
  19. 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.  
  8. total = 1 
  9. parent = 1 
  10. gp = 1 
  11.  
  12. (1..at).each do |i| 
  13. total = parent + gp 
  14. gp = parent 
  15. parent = total 
  16. end 
  17.  
  18. return total 
  19. end 
  20.  
  21. 这是它的运行结果: 
  22.  
  23. $ time php php_fib.php 
  24.  
  25. real 0m2.046s 
  26. user 0m1.823s 
  27. sys 0m0.207s 
  28.  
  29. 现在我们来做Rust版。下面是库资源: 
  30.  
  31. #![crate_type = "staticlib"
  32.  
  33. fn fib(at: usize) -> usize { 
  34. if at == 0 { 
  35. return 0; 
  36. else if at == 1 { 
  37. return 1; 
  38.  
  39. let mut total = 1; 
  40. let mut parent = 1; 
  41. let mut gp = 0; 
  42. for _ in 1 .. at { 
  43. total = parent + gp; 
  44. gp = parent; 
  45. parent = total; 
  46.  
  47. return total; 
  48.  
  49. #[no_mangle] 
  50. pub extern "C" fn rust_fib(at: usize) -> usize { 
  51. fib(at) 
  52.  
  53. 注意,我编译的库rustc – O rust_lib.rs使编译器优化(因为我们是这里的标准)。这里是C扩展源(相关摘录): 
  54.  
  55. PHP_FUNCTION(confirm_rust_fib_compiled) 
  56. long number; 
  57.  
  58. if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &number) == FAILURE) { 
  59. return
  60.  
  61. RETURN_LONG(rust_fib(number)); 

运行PHP脚本:


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

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

总结

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

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


来源:51CTO

相关文章
|
7月前
|
运维 Unix Linux
Linux系统 PHP安装expect扩展详解
Linux系统 PHP安装expect扩展详解
92 5
|
3月前
|
设计模式 算法 数据库连接
PHP中的设计模式:提高代码的可维护性与扩展性本文旨在探讨PHP中常见的设计模式及其应用,帮助开发者编写出更加灵活、可维护和易于扩展的代码。通过深入浅出的解释和实例演示,我们将了解如何使用设计模式解决实际开发中的问题,并提升代码质量。
在软件开发过程中,设计模式是一套经过验证的解决方案模板,用于处理常见的软件设计问题。PHP作为流行的服务器端脚本语言,也有其特定的设计模式应用。本文将重点介绍几种PHP中常用的设计模式,包括单例模式、工厂模式和策略模式,并通过实际代码示例展示它们的具体用法。同时,我们还将讨论如何在实际项目中合理选择和应用这些设计模式,以提升代码的可维护性和扩展性。
62 4
|
2月前
|
NoSQL 安全 Linux
MongoDB PHP 扩展
10月更文挑战第19天
13 0
MongoDB PHP 扩展
|
3月前
|
设计模式 存储 算法
PHP中的设计模式:策略模式的深入解析与应用在软件开发的浩瀚海洋中,PHP以其独特的魅力和强大的功能吸引了无数开发者。作为一门历史悠久且广泛应用的编程语言,PHP不仅拥有丰富的内置函数和扩展库,还支持面向对象编程(OOP),为开发者提供了灵活而强大的工具集。在PHP的众多特性中,设计模式的应用尤为引人注目,它们如同精雕细琢的宝石,镶嵌在代码的肌理之中,让程序更加优雅、高效且易于维护。今天,我们就来深入探讨PHP中使用频率颇高的一种设计模式——策略模式。
本文旨在深入探讨PHP中的策略模式,从定义到实现,再到应用场景,全面剖析其在PHP编程中的应用价值。策略模式作为一种行为型设计模式,允许在运行时根据不同情况选择不同的算法或行为,极大地提高了代码的灵活性和可维护性。通过实例分析,本文将展示如何在PHP项目中有效利用策略模式来解决实际问题,并提升代码质量。
|
4月前
|
安全 前端开发 PHP
PHP与现代Web开发:构建高效和可扩展的应用程序
【8月更文挑战第29天】在这篇文章中,我们将深入探讨PHP如何适应现代Web开发的需求。我们将通过实际案例分析,揭示PHP的核心优势,并展示如何利用这些优势来构建高性能、可扩展的Web应用。文章不仅提供理论知识,还包括具体的代码示例,旨在帮助开发者更好地理解和运用PHP解决实际问题。
|
4月前
|
SQL 关系型数据库 MySQL
PHP与数据库交互的艺术:深入探讨PDO扩展
【8月更文挑战第28天】在数字信息时代的海洋里,PHP作为一艘灵活的帆船,承载着无数网站和应用的梦想。而PDO扩展,则是这艘帆船上不可或缺的导航仪,指引着数据安全与效率的航向。本文将带你领略PHP与数据库交互的艺术,深入浅出地探索PDO的世界,从连接数据库到执行复杂的查询,每一步都清晰可见。我们将一起航行在这段奇妙的旅程上,解锁数据的奥秘,体验编程的乐趣。
62 1
|
4月前
|
存储 安全 Linux
【Azure 应用服务】App Service For Linux 怎么安装Composer,怎么安装PHP扩展,怎么来修改站点根路径启动程序?
【Azure 应用服务】App Service For Linux 怎么安装Composer,怎么安装PHP扩展,怎么来修改站点根路径启动程序?
|
5月前
|
运维 Serverless API
函数计算产品使用问题之如何使用PHP Runtime非内置扩展
阿里云Serverless 应用引擎(SAE)提供了完整的微服务应用生命周期管理能力,包括应用部署、服务治理、开发运维、资源管理等功能,并通过扩展功能支持多环境管理、API Gateway、事件驱动等高级应用场景,帮助企业快速构建、部署、运维和扩展微服务架构,实现Serverless化的应用部署与运维模式。以下是对SAE产品使用合集的概述,包括应用管理、服务治理、开发运维、资源管理等方面。
|
6月前
|
Ubuntu 中间件 Linux
linux php添加扩展zip libzip ZipArchive功能
linux php添加扩展zip libzip ZipArchive功能
199 1