澳门新浦京娱乐游戏编写自己的php扩展函数

更新: 初稿刚发布还没几个小时我意识到我的 PHP
基准测试是错的。为公平起见我已经更新了 PHP 和 Rust 的版本。你可以在
GitHub 仓库里看到変更(链接在底部)。

编写自己的php扩展函数php程序写的时间长了,自然对他所提供的功能了如指掌,他所提供的一大堆功能,真是觉得很好用,但有时候会发现php也缺少一些功能,自己总是会产生为php添加一些自定义的功能的想法。久而久之,终于今天憋不住了,开始动手研究如何添加。下载一个php的源代码包,这里使用的是php
4.0.5版,解压后会看到php的根目录下会有README.EXT_SKEL这样一个文件,打开详细阅读了一下,发现了一个非常好用的工具,这个工具可以帮你构建一个空的php扩展,然后你向里面添加相应的代码就可以完成你自己的功能扩展了。下面我们就来介绍如何使用这个工具。首先转移你的目录到php的目录下的ext目录,如果你只需要一个基本的扩展框架的话,执行下面的命令:./ext_skel
–extname=module_namemodule_name是你自己可以选择的扩展模块的名字,例如我选择的my_module。执行工具后会自动在ext目录下建立你选择的module_name名字的目录,里面已经生成了相关的代码,这些代码中只需要调整config.m4文件中的三行注释就可以正常的编译带这个自定义扩展模块的php了。在php的根目录执行下列操作就可以得到。./buildconf./configure
–enable-module_namemake下面我来演示建立my_module扩展框架的全过程,为了更有效果,我们来完成一个php的扩展功能,在php中调用这个功能可以在web页面中显示hello
world这个经典单词。在php目录下的ext目录中,执行下面的命令./ext_skel
–extname=my_module得到反馈结果:Creating directory my_moduleCreating
basic files: config.m4 Makefile.in .cvsignore my_module.c
php_my_module.h tests/001.phpt my_module.php [done].To use your new
extension, you will have to execute the following steps:1.$ cd ..2.$ vi
ext/my_module/config.m43.$ ./buildconf4.$ ./configure
–[with|enable]-my_module5.$ make6.$ ./php -f
ext/my_module/my_module.php7.$ vi ext/my_module/my_module.c8.$
makeRepeat steps 3-6 until you are satisfied with
ext/my_module/config.m4 andstep 6 confirms that your module is compiled
into PHP. Then, start writingcode and repeat the last two steps as often
as
necessary.如果你能看懂上面的东西,那就照着去做。如果不是太明白的话,按照我下面的提示来做也可以。Cd
my_module首先进入my_module目录vi
config.m4使用文本编辑器打开config.m4文件,文件内容大致如下:dnl $Id$dnl
config.m4 for extension my_modulednl don’t forget to call
PHP_EXTENSION(my_module)dnl Comments in this file start with the
string ‘dnl’.dnl Remove where necessary. This file will not workdnl
without editing.dnl If your extension references something external, use
with:dnl PHP_ARG_WITH(my_module, for my_module support,dnl Make sure
that the comment is aligned:dnl [–with-my_module Include my_module
support])dnl Otherwise use enable:dnl PHP_ARG_ENABLE(my_module,
whether to enable my_module support,dnl Make sure that the comment is
aligned:dnl [–enable-my_module Enable my_module support])if test
“$PHP_MY_MODULE” != “no”; thendnl If you will not be testing anything
external, like existence ofdnl headers, libraries or functions in them,
just uncomment thednl following line and you are ready to go.dnl Write
more examples of tests here…PHP_EXTENSION(my_module,
$ext_shared)Fi根据你自己的选择将dnl PHP_ARG_WITH(my_module, for
my_module support,dnl Make sure that the comment is aligned:dnl
[–with-my_module Include my_module
support])修改成PHP_ARG_WITH(my_澳门新浦京娱乐游戏 ,module, for my_module support,Make
sure that the comment is aligned:[–with-my_module Include my_module
support])或者将dnl PHP_ARG_ENABLE(my_module, whether to enable
my_module support,dnl Make sure that the comment is aligned:dnl
[–enable-my_module Enable my_module
support])修改成PHP_ARG_ENABLE(my_module, whether to enable
my_module support,Make sure that the comment is
aligned:[–enable-my_module Enable my_module
support])一般我会选择后者,然后保存退出。如果你对vi文本编辑器的操作有困难的话,请参考相应的说明文章,这里就不再详细描述了。Vi
my_module.c将文件其中的下列代码进行修改/* Every user visible function
must have an entry in my_module_functions[].*/function_entry
my_module_functions[] = { PHP_FE(say_hello, NULL)/*
添加着一行代码 */ PHP_FE(confirm_my_module_compiled, NULL) /* For
testing, remove later. */ {NULL, NULL, NULL} /* Must be the last line
in my_module_functions[]
*/};在文件的最后添加下列代码PHP_FUNCTION(say_hello){
zend_printf(“hello world/n”);}保存文件退出vi
php_my_module.h在文件中PHP_FUNCTION(confirm_my_module_compiled);一行前面添加下面的代码PHP_FUNCTION(say_hello);保存文件退出退回到php的根目录下,执行下面的命令./buildconf./configure
–enable-my_modulemake如果一切顺利的话,我们现在已经将扩展模块my_module编译到php里面了。我们编写下面的代码进行测试?
Say_hello();?保存文件为say_hello.php在php的根目录下运行./php q
say_hello.php正常情况下会显示hello
world表示我们的第一个扩展正常的运行了!解释一下上面做的操作,ext_skel生成一些框下文件,我们需要修改以下文件my_module.c扩展模块的主程序php_my_module.h
扩展模块的头文件config.m4配置文件主程序中描述了php扩展模块的声明,模块中含有多少个函数,各个函数的作用,在phpinfo函数中显示什么内容,模块初始化做些什么,结束做些什么都会在这个文件里进行描述。我们在上面只是添加了一个函数say_hello,并且描述了say_hello函数的具体内容,调用zend_printf系统函数在php中打印字符串。在对应的头文件中声明了say_hello这个函数,从而完成了我们预期的功能。下面我们会编写一个更复杂的扩展,创造一个带参数的php扩展函数,根据给入的参数,显示hello
world, xxxx。Xxxx代表输入的字符串内容,例如我的名字yorgo。Vi
my_module.c修改最后的say_hello函数内容如下:PHP_FUNCTION(say_hello){
zval **yourname; if (ZEND_NUM_ARGS() != 1
zend_get_parameters_ex(1, &yourname) == FAILURE) {
WRONG_PARAM_COUNT; } zend_printf(“hello world, %s/n”,
Z_STRVAL_PP(yourname));}存盘退出。退回php的根目录,运行make修改say_hello.php为?
Say_hello(“yorgo”);?保存退出后运行./php q say_hello.php得出结果hello
world,
yorgo表示我们这次的修改也成功了,可以改变say_hello中的参数,看看动态的效果。这里主要解释上面修改的函数内容,由于say_hello函数需要有参数引入,所以在my_module.c中的say_hello函数主要在进行参数的处理,将php中引用say_hello时所填写的参数内容正确的传递到my_module.c中的say_hello处理函数中。为此,程序中添加了这么几行。zval
**yourname;if (ZEND_NUM_ARGS() != 1 zend_get_parameters_ex(1,
&yourname) == FAILURE){WRONG_PARAM_COUNT;}zend_printf(“hello world,
%s/n”, Z_STRVAL_PP(yourname));代码解释如下:zval
**yourname;初始化一个参数的指针ZEND_NUM_ARGS()得到传递过来得参数数量,并且判断如果不为1的时候表示有问题,报错。zend_get_parameters_ex(1,
&yourname)将刚刚初始化的指针指向传递过来的参数,如果不成功则报错。Z_STRVAL_PP(yourname)处理指针指向的参数并获得实际存储的值。(待续)

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

从那时起我便萌生了用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 源,把代码写进 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微基准!

总结

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

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

发表评论

电子邮件地址不会被公开。 必填项已用*标注