程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> 關於PHP編程 >> 在PHP程序中使用Rust擴展的方法,php程序rust擴展

在PHP程序中使用Rust擴展的方法,php程序rust擴展

編輯:關於PHP編程

在PHP程序中使用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。然後在我們編譯的時候鏈接到它。

下面是頭文件:
 

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

這是一個相當基礎的頭文件,僅僅為了一個簡單的函數提供簽名/定義。接著我們需要寫一個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 目錄並且運行:

 $ 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的定義方法。
 

#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, 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 的代碼:
 復制代碼 代碼如下:
#![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 頭文件:
 

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

還要變更 C 擴展文件:
 

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;
 }
 
 char *str;
 str = hello_from_rust("Jared (from PHP!!)!");
 printf("%s\n", str);
 
 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);
}

無用的微基准

那麼為什麼你還要這樣做?我還真的沒有在現實世界裡使用過這個。但是我真的認為斐波那契序列算法就是一個好的例子來說明一個PHP拓展如何很基本。通常是直截了當(在Ruby中):
 

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

而且可以通過不使用遞歸來改善這不好的性能:
 

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版:
 

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

這是它的運行結果:
 

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

現在我們來做Rust版。下面是庫資源:
 復制代碼 代碼如下:
#![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_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);
}
?>

這就是它的運行結果:

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

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

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved