自己动手用 C 扩展 PHP

自己动手用 C 扩展 PHP

关键词： PHP扩展
环境要求: Linux, GCC

首先，我们应该选择如何去构建我们的扩展模块， 有三种方式:
1. External Modules
外部模块，也就是编译成共享库，用dl()函数动态加载。
好处： (1)不需要重新编译 PHP (2)PHP体积小，因为不需要编译进PHP
缺点: (1)每次*.php脚本执行都需要用 dl()去加载，效率较低
(2)每次都要调用dl()
2. Built-in Modules
编译进PHP
好处: (1)不需要动态加载，模块在php脚本里面可以直接使用.
(2)不需要将模块编译成.so共享库，因为直接编译进PHP。
缺点： (1)对模块的改变都需要重新编译PHP
(2)因为编译进PHP，所以PHP二进制文件较大，而且多占点内存
3. The Zend Engine
Zend 核心里实现 （略 ... 有兴趣的话可以看 Zend API）

Note: 本人推荐用 第 2 种方式，直接编译进PHP， 但是在下面示例里，我们编译成外部模块
，因为，外部模块不需要重新编译 PHP，所以在测试阶段先编译成共享库，然后用dl()
加载(不过记得在php.ini里将安全模式设为 Off)，测试完后再用第2种方式重新编译进 PHP.

1. 首先下载 PHP 源代码， 解压。 然后我们开始构建代码结构，可以利用 PHP 源代码包ext目录里提供的 ext_skel 程序去生成我们需要的结构.

[ext]#./ext_skel --extname=haosoft_php_module

这样会在ext下生成一个 haosoft_php_module 目录。
目录里有 config.m4, haosoft_php_module.h, haosoft_php_module.c 等几个文件。

2. haosoft_php_module.h 为模块的头文件（熟悉C语言的应该了解）, 用 VI 打开，删除其中的一行：
PHP_FUNCTION(confirm_MyExt_compiled); /* For testing, remove later. */
改为：
PHP_FUNCTION(haosoft_test); /* For testing, remove later. */
说明：
PHP_FUNCTION() 是一个 Zend Macro，作用是声名一个 C 函数，使他在 PHP 脚本里可用, 参数 是函数的名字,我们这里的示例函数为 haosoft_test.

3. haosoft_php_module.c 为主文件，里面包含了实现， VI 打开，我们删除掉
PHP_FUNCTION(confirm_MyExt_compiled)
{
char *arg = NULL;
int arg_len, len;
char string[256];

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {
return;
}
len = sprintf(string, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "haosoft_php_module", arg);
RETURN_STRINGL(string, len, 1);
}
增加:
PHP_FUNCTION(haosoft_test) {
zend_printf("This is my php module !");
}

4. 现在，我们开始编译我们的模块，因为要编译成 so，我们选择手工编译。
进入 ext 目录:

开始编译，编译成*.o对象文件，注意这个"-DCOMPILE_DL_HAOSOFT_PHP_MODULE"，

在 haosoft_php_module.c 里你可以找到下面的语句

#ifdef COMPILE_DL_HAOSOFT_PHP_MODULE
ZEND_GET_MODULE(haosoft_php_module)
#endif

HAOSOFT_PHP_MODULE 是大写模块名，你可以换成其他名，但是必须保证这个预处理常量与
上面的语句里一致，至于上面语句的 ZEND_GET_MODULE(haosoft_php_module) 我们将在下一篇文
章讲解它的意思.

[ext]# cc -fpic -DCOMPILE_DL_HAOSOFT_PHP_MODULE=1 -I/usr/local/include -I. -I../main -I.. -I../TSRM -I../Zend -c -o haosoft_php_module/haosoft_php_module.o haosoft_php_module/haosoft_php_module.c

执行完之后会在 目录下生成一个haosoft_php_module.o文件，接下来 连接：
[ext]# cc -shared -L/usr/local/lib -rdynamic -o haosoft_php_module/haosoft_php_module.so haosoft_php_module/haosoft_php_module.o

这样会在目录下生成了我们需要的 haosoft_php_module.so 文件。
然后我们要建立一个目录
[ext]# mkdir -p /usr/local/php/lib/php/extensions/no-debug-non-zts-20041030
上面的 20041030 的号码是Zend内部模块API号码，如果你不知道的话，你先建立一个php文
件:
test.php

dl("abc.so");
?>

在浏览器里运行该文件会出现错误信息， 可以在错误信息里得到这个号码，请根据自己情况根据这个号码与你的PHP安装目录更改路径。

建立完目录后接下来，我们把haosoft_php_module.so移动到刚刚的目录里去
[ext]# mv haosoft_php_module/haosoft_php_module.so /usr/local/php/lib/php/extensions/no-debug-non-zts-20041030

OK！ 我们可以测试刚建立的模块了，目前模块里只有一个 haosoft_test() 的无参数方法。

建立 php 文件：

test.php

// 加载刚建立的模块
dl("haosoft_php_module.so");
// 调用函数
haosoft_test();
?>

执行。 看到显示 "This is my module !" 了吗？

5. 好了，模块编译，并测试无误后，我们可以将他编译进 PHP 了，回到 PHP源代码包根目录
执行:
[php-5.0.6]#./buildconf --force
[php-5.0.6]#./configure --enable-haosoft_php_module ... 也许你还有其他选项
[php-5.0.6]#make
[php-5.0.6]#make install
[php-5.0.6]#sh /etc/init.d/httpd restart ... 这里是重启 apache

---------------------------------------------------------------
本示例在我 PHP5.0.6 上编译通过, 下一章我们再详细分析 haosoft_php_module.h, haosoft_php_module.c 这两个文件里的内容，以及有参数，有返回值函数的定义及使用.
4 点了，偶该睡觉了！ 有时间再写下一章。 希望以上内容对大家会有所帮助！

在 上一章 自己动手用 C 扩展 PHP（一）里我们介绍了
如何编写自己的函数，接下来，我们开始编写一个有参数
有返回值的扩展函数。

因为 Zend 没有正式的函数调用语法检查支持，所以我们在编写扩展函数的时候必须得“小心”， 也就是我们必须得严格地进行调用合法性检查，首先，我们写一个函数：

#include "string.h"

PHP_FUNCTION(haosoft_strcat) {
char* pc_arg_one = NULL;
char* pc_arg_tow = NULL;
long arg_one_len;
long arg_tow_len;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &pc_arg_one, &arg_one_len, &pc_arg_tow, &arg_tow_len) == FAILURE) {
return;
}
RETURN_STRINGL(strcat(pc_arg_one, pc_arg_tow), (arg_one_len + arg_tow_len), 1);
}

我们来分析这个函数:
1.
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &pc_arg_one, &arg_one_len, &pc_arg_tow, &arg_tow_len) == FAILURE) {
return;
}
这句就是进行参数检查与取得参数的语句，zend_parse_parameters() 是 Zend 提供的 API 函数，第一个参数是参数的数量，可以通过 Zend 提供的 ZEND_NUM_ARGS() 来取得，TSRMLS_CC 是必须的， 第三个参数 "ss" 指明参数的类型（s - 字符串），这个函数有2个字符串参数，所以为 "ss", 之后的参数就是你要取得的参数值了，注意 如果参数类型为 "s" 的话， 参数值后面还要传一个 long 来取得字符串的长度. zend_parse_parameters 函数成功的话会返回
SUCCESS, 失败则返回 FAILURE ，并且输出错误信息.

2.
RETURN_STRINGL(strcat(pc_arg_one, pc_arg_tow), (arg_one_len + arg_tow_len), 1);
这句的作用是返回一个值，RETURN_STRINGL() 为返回字符串，详细信息可以参阅 Zend API 参考手册。这句作用是连接两个字符串参数并返回.

----------------------------------------------------------
编译好扩展模块后，现在我们可以在 php 里调用这个函数
<?php
$s_result = haosoft_strcat("a", "b");
echo $s_result;
?>
输出 : ab
---------------------------------------------------

说明:

函数参数类型指定字符表，和一些返回函数返回值的函数可以参阅 Zend 文档，这里就不列出了

因为Zend API 说明文档不完全，许多 Macro 及大多数 Zend API 函数都没有详细说明， 呵呵，所以如有错误地方，欢迎指正.

今天查阅了些Zend的资料， 用 C++ 写了一下PHP的扩展，觉得真的非常麻烦，一个
只有一个 MyClass::GetString()方法 的类，要实现在php里
<?php
$obj = new MyClass();
$string = $obj->GetString();
?>
写了好几百行代码，对于习惯面向对象形式编程的人简直是噩梦，希望Zend能在这方面改善一下了，等有时间我会再写写如何用C++编写PHP的扩展。

待续 ...

在上两章里讲述了扩展模块的基本用法，相信读者已经能够构建自己的扩展模块了，接下来，我们来看看几个重要的函数：

1. PHP_MINIT_FUNCTION(MyModule);
当模块被Zend Engine(ZE)加载后，例如Apache启动，加载了PHP模块，ZE会对每一个扩展模块调用此函数（如果有的话），可以在该函数里进行一些初始化操作.

2. PHP_RINIT_FUNCTION(MyModule);
对于每一个"使用"该模块的PHP脚本请求前，都执行该函数（如果有的话），最好的例子: Session 扩展模块，如果在一个PHP脚本里执行session.start(), Session模块的PHP_RINIT_FUNCTION（）将被调用. 详情可以看看 session模块 的源代码

3. PHP_RSHUTDOWN_FUNCTION(MyModule);
与PHP_RINIT_FUNCTION()相反，该函数是在一个 PHP 脚本执行完毕后执行.

4. PHP_MSHUTDOWN_FUNCTION(MyModule);
当ZE收到shutdown信号后，例如apache卸载PHP模块，ZE 对每一个模块调用此函数，最后关闭自己的核心子系统.

-------------------------------------------------------
如何使用以上的函数？

首先，在头文件("mymodule.h")里声明：

PHP_MINIT_FUNCTION(MyModule);
PHP_MSHUTDOWN_FUNCTION(MyModule);
PHP_RINIT_FUNCTION(MyModule);
PHP_RSHUTDOWN_FUNCTION(MyModule);

然后在你的 "mymodule.c" 里实现zend_module_entry结构：

zend_module_entry MyModule_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
STANDARD_MODULE_HEADER,
#endif
"MyModule",
MyModule_functions,
PHP_MINIT(MyModule),
PHP_MSHUTDOWN(MyModule),
PHP_RINIT(MyModule),
PHP_RSHUTDOWN(MyModule),
NULL,
#if ZEND_MODULE_API_NO >= 20010901
"0.1",
#endif
STANDARD_MODULE_PROPERTIES
};

// 实现 PHP_MINIT_FUNCTION() 等等 ...
PHP_MINIT_FUNCTION(MyModule)
{
// 你的实现代码 ...
return SUCCESS;
}

其实 ext 目录下的 ext_skel 程序建立扩展模块代码框架的时候都自动化帮你实现了这些结构，依照说明填充需要的代码即可.