微信号:phpfamily

介绍:一群靠谱的人,愿为PHPer带来一些值得细细品味的精神食粮!

[PHP7系列] 使用资源包裹第三方扩展的实现及其源码解读

2016-03-04 19:12 周梦康

在阅读下面的内容之前,我们假定你已经对 PHP 7 基本的数据结构 都有大致的了解了,这是下面内容阅读的前提。

我们分为两大块:

首先实现一个自定义的文件打开、读取、写入、关闭的文件操作扩展;

然后分析各个操作背后的实现原理,其中某些部分的实现我会和 PHP 5.3 使用资源包裹第三方扩展源码解读 对比分析。

0 通过原型生成扩展骨架

首先进入到源码目录的ext目录中,添加一个文件操作的原型文件

  1. [root@localhost php-src-php-7.0.3]# cd ext/

  2. [root@localhost ext]# vim tipi_file.proto

编辑原型为

  1. resource file_open(string filename, string mode)

  2. string file_read(resource filehandle, int size)

  3. bool file_write(resource filehandle, string buffer)

  4. bool file_close(resource filehandle)

  1. [root@localhost ext]# ./ext_skel --extname=tipi_file --proto=./tipi_file.proto

这样一个简单的文件操作扩展的代码骨架就生成了。

完整代码 tipi_file.c,可以先有一个大致的了解,这样后面阅读时,思路可能会清晰很多。

 1 扩展的实现

1.1 注册资源类型

1.1.1 注册资源 API

  1. ZEND_API int zend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld, const char *type_name, int module_number)

参数 解释
ld 释放该资源时调用的函数。
pld 释放用于在不同请求中始终存在的永久资源的函数。
type_name 是一个具有描述性类型名称的字符串。
module_number 为引擎内部使用,当我们调用这个函数时,我们只需要传递一个已经定义好的module_number变量。

该 API 返回一个资源类型 id,该id应当被作为全局变量保存在扩展里,以便在必要的时候传递给其他资源API。

1.1.2 添加资源释放回调函数

  1. static void tipi_file_dtor(zend_resource *rsrc TSRMLS_DC){

  2.      FILE *fp = (FILE *) rsrc->ptr;

  3.      fclose(fp);

  4. }

我们发现该函数的参数类型是zend_resource。这是 PHP7 新增的数据结构,在 PHP 5 则是zend_rsrc_list_entry。细节的内容,我们留在后面分析。

1.1.3 在PHP_MINIT_FUNCTION中注册

我们知道在 PHP 生命周期中,当 PHP 被装载时,PHP_MINIT_FUNCTION(模块启动函数)即被引擎调用。这使得引擎做一些例如资源类型,注册INI变量等的一次初始化。

那么我们需要在这里通过zend_register_list_destructors_exPHP_MINIT_FUNCTION来注册资源类型。

  1. PHP_MINIT_FUNCTION(tipi_file)

  2. {

  3.     /* If you have INI entries, uncomment these lines

  4.     REGISTER_INI_ENTRIES();

  5.     */

  6.  

  7.     le_tipi_file = zend_register_list_destructors_ex(tipi_file_dtor, NULL, TIPI_FILE_TYPE, module_number);

  8.     return SUCCESS;

  9. }

其中TIPI_FILE_TYPE在前面已经定义了,是该扩展的别名(具体可以对比着代码 tipi_file.c 查看)

1.2 注册资源

1.2.1 注册资源 API

在 PHP 7 中删除了原来的ZEND_REGISTER_RESOURCE宏,直接使用zend_register_resource函数

  1. ZEND_API zend_resource* zend_register_resource(void *rsrc_pointer, int rsrc_type)

参数 解释
rsrc_pointer 资源数据指针
rsrc_type 注册资源类型时获得的资源类型 id

1.2.2 在 file_open函数中实现资源的注册

  1. PHP_FUNCTION(file_open)

  2. {

  3.     char *filename = NULL;

  4.     char *mode = NULL;

  5.     int argc = ZEND_NUM_ARGS();

  6.     size_t filename_len;

  7.     size_t mode_len;

  8.  

  9.     if (zend_parse_parameters(argc TSRMLS_CC, "ss", &filename, &filename_len, &mode, &mode_len) == FAILURE) 

  10.         return;

  11.  

  12.     // 使用 VCWD 宏取代标准 C 文件操作函数

  13.     FILE *fp = VCWD_FOPEN(filename, mode);

  14.  

  15.     if (fp == NULL) {

  16.         RETURN_FALSE;

  17.     }

  18.  

  19.     RETURN_RES(zend_register_resource(fp, le_tipi_file));

  20. }

其中RETURN_RES宏的作用是将返回的zend_resource添加到zval中,然后将最后的zval作为返回值。也就是说该函数的返回值为zval指针。RETURN_RES(zend_register_resource(fp, le_tipi_file))会将返回值的value.res设为fpu1.type_info设为IS_RESOURCE_EX。大家可以根据源码非常直观的了解到,这里不粘贴代码详细说明了。

1.3 使用资源

1.3.1 使用资源 API

  1. ZEND_API void *zend_fetch_resource(zend_resource *res, const char *resource_type_name, int resource_type)

在 PHP 7 中删除了原有的ZEND_FETCH_RESOURCE宏,直接使用函数zend_fetch_resource,而且解析方式也变得简单了很多,想比 PHP 5 要高效很多,后面我们再通过图片分析对比。

参数 含义
res 资源指针
resource_type_name 该类资源的字符串别名
resource_type 该类资源的类型 id

1.3.2 解析资源的实现

当我们要实现文件的读取时,最终还是需要使用原生的fread函数,所以这里需要通过zend_fetch_resourcezend_resource解析成为该资源包裹的原始的FILE *的指针。

  1. PHP_FUNCTION(file_read)

  2. {

  3.     int argc = ZEND_NUM_ARGS();

  4.     int filehandle_id = -1;

  5.     zend_long size;

  6.     zval *filehandle = NULL;

  7.     FILE *fp = NULL;

  8.     char *result;

  9.     size_t bytes_read;

  10.  

  11.     if (zend_parse_parameters(argc TSRMLS_CC, "rl", &filehandle, &size) == FAILURE) 

  12.         return;

  13.  

  14.     if ((fp = (FILE *)zend_fetch_resource(Z_RES_P(filehandle), TIPI_FILE_TYPE, le_tipi_file)) == NULL) {

  15.         RETURN_FALSE;

  16.     }

  17.  

  18.     result = (char *) emalloc(size+1);

  19.     bytes_read = fread(result, 1, size, fp);

  20.     result[bytes_read] = '\0';

  21.  

  22.     RETURN_STRING(result, 0);

  23.  

  24. }

这里需要说明,脚本自动生成的扩展代码中还是使用ZEND_FETCH_RESOURCE, 是个 BUG,因为自动生成的脚本(ext/skeleton/create_stubs)还没更新。

与之类似的文件的写入操作,也很类似,这里就复制代码了,请查看完整的代码 tipi_file.c

1.4 资源的删除

1.4.1 资源删除 API

  1. ZEND_API int zend_list_close(zend_resource *res)

传入需要被删除的资源即可。该 API 看似非常简单,实际做了很多工作,后面原理分析细说。

1.4.2 资源删除的实现

我们在函数file_close中需要调用资源删除 API

  1. PHP_FUNCTION(file_close)

  2. {

  3.     int argc = ZEND_NUM_ARGS();

  4.     int filehandle_id = -1;

  5.     zval *filehandle = NULL;

  6.  

  7.     if (zend_parse_parameters(argc TSRMLS_CC, "r", &filehandle) == FAILURE) 

  8.         return;

  9.  

  10.     zend_list_close(Z_RES_P(filehandle));

  11.     RETURN_TRUE;

  12. }

1.5 编译安装以及测试

1.5.1 编译安装

通过上面的编码,一个简单的第三方的扩展就实现了。查看完整版

下面的一些命令配置请根据自己的环境而定(安装的过程可以参考最基础的扩展开发教程)

  1. [root@localhost tipi_file]# php7ize

  2. Configuring for:

  3. PHP Api Version:         20151012

  4. Zend Module Api No:      20151012

  5. Zend Extension Api No:   320151012

  6. [root@localhost tipi_file]# ./configure --with-php-config=/usr/local/php7/bin/php-config

  7. ...

  8. [root@localhost tipi_file]# make

  9. ...

  10. [root@localhost tipi_file]# make install

  11. ...

1.5.2 测试

直接用 php 脚本测试,就不一个功能一个功能写测试样例了,修改tipi_file.php文件。

  1. $fp = file_open("./CREDITS","r+");

  2. var_dump($fp);

  3. var_dump(file_read($fp,6));

  4. var_dump(file_write($fp,"zhoumengakng"));

  5. var_dump(file_close($fp));

然后通过命令行执行

  1. php7 -d"extension=tipi_file.so" tipi_file.php

2 源码分析

2.1 注册资源类型源码

  1. ZEND_API int zend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld, const char *type_name, int module_number)

  2. {

  3.    zend_rsrc_list_dtors_entry *lde;

  4.    zval zv;

  5.  

  6.    lde = malloc(sizeof(zend_rsrc_list_dtors_entry));

  7.    lde->list_dtor_ex = ld;

  8.    lde->plist_dtor_ex = pld;

  9.    lde->module_number = module_number;

  10.    lde->resource_id = list_destructors.nNextFreeElement;

  11.    lde->type_name = type_name;

  12.    ZVAL_PTR(&zv, lde);

  13.  

  14.    if (zend_hash_next_index_insert(&list_destructors, &zv) == NULL) {

  15.       return FAILURE;

  16.    }

  17.    return list_destructors.nNextFreeElement-1;

  18. }

其中

  1. ZVAL_PTR(&zv, lde);

等价于

  1. zv.value.ptr = (lde);

  2. zv.u1.type_info = IS_PTR;

list_destructors是一个全局静态HashTable,资源类型注册时,将一个zval结构体变量zv存放入list_destructorsarData中,而zvvalue.ptr却指向了zend_rsrc_list_dtors_entry *ldelde中包含的该种资源释放函数指针、持久资源的释放函数指针,资源类型名称,该资源在 hashtable 中的索引依据 (resource_id)等。

而这里的resource_id则是该函数的返回值,所以后面我们在解析该类型变量时,都需要将resource_id带上。

整个的注册步骤可以总结为下图:

2.2 资源的注册

  1. ZEND_API zend_resource* zend_register_resource(void *rsrc_pointer, int rsrc_type)

  2. {

  3.    zval *zv;

  4.  

  5.    zv = zend_list_insert(rsrc_pointer, rsrc_type);

  6.  

  7.    return Z_RES_P(zv);

  8. }

该函数的功能则是将zend_list_insert返回的zval中的资源指针返回。Z_RES_P宏在Zend/zend_types.h中定义。

重点分析zend_list_insert

  1. ZEND_API zval *zend_list_insert(void *ptr, int type)

  2. {

  3.    int index;

  4.    zval zv;

  5.  

  6.    index = zend_hash_next_free_element(&EG(regular_list));

  7.    if (index == 0) {

  8.       index = 1;

  9.    }

  10.    ZVAL_NEW_RES(&zv, index, ptr, type);

  11.    return zend_hash_index_add_new(&EG(regular_list), index, &zv);

  12. }

其中zend_hash_next_free_element宏,返回&EG(regular_list)表的nNextFreeElement,后面用来作为索引查询的依据。

ZVAL_NEW_RES宏是 PHP 7 新增的一套东西,把一个资源装载到zval里去,因为PHP 7 中Bucket只能存zval了。

  1. #define ZVAL_NEW_RES(z, h, p, t) do {                         \

  2.         zend_resource *_res =                                 \

  3.         (zend_resource *) emalloc(sizeof(zend_resource));     \

  4.         zval *__z;                                         \

  5.         GC_REFCOUNT(_res) = 1;                                    \

  6.         GC_TYPE_INFO(_res) = IS_RESOURCE;                     \

  7.         _res->handle = (h);                                        \

  8.         _res->type = (t);                                      \

  9.         _res->ptr = (p);                                       \

  10.         __z = (z);                                            \

  11.         Z_RES_P(__z) = _res;                                  \

  12.         Z_TYPE_INFO_P(__z) = IS_RESOURCE_EX;                  \

  13.     while (0)

代码比较清晰,首先根据h,p,t新建了一个资源,然后一起存入了z这个zval的结构体。(最后两个宏前面刚刚讨论过了)

最后就是zend_hash_index_add_new宏了,追踪代码发现其最后等价于调用的是

  1. _zend_hash_index_add_or_update_i(&EG(regular_list), index, &zv, HASH_ADD | HASH_ADD_NEW ZEND_FILE_LINE_RELAY_CC)

关于HashTable的具体操作,这里暂不做细致的分析,后面单独再单独说。

2.3 解析资源源码分析

  1. ZEND_API void *zend_fetch_resource(zend_resource *res, const char *resource_type_name, int resource_type)

  2. {

  3.    if (resource_type == res->type) {

  4.       return res->ptr;

  5.    }

  6.  

  7.    if (resource_type_name) {

  8.       const char *space;

  9.       const char *class_name = get_active_class_name(&space);

  10.       zend_error(E_WARNING, "%s%s%s(): supplied resource is not a valid %s resource", class_name, space, get_active_function_name(), resource_type_name);

  11.    }

  12.  

  13.    return NULL;

  14. }

在上面的例子中我们是这样解析的

  1. (FILE *)zend_fetch_resource(Z_RES_P(filehandle), TIPI_FILE_TYPE, le_tipi_file)

首先通过Z_RES_P宏,获取filehandle这个zval变量中的zend_resource。然后zend_fetch_resource中只是对比了zend_resourcetype与我们预想的资源类型是否一致,然后返回了zend_resource*ptr,最后转换成FILE *指针。

PHP7 中资源的解析比 PHP5中解析简单快捷很多,得益于其 zval 结构的改变。

原来PHP5中则需要通过EG(regular_list)查找,如下图所示。

而现在 PHP7的解析则直接从zval里解析出zend_resource,如下图所示:

2.4 删除资源源码分析

  1. ZEND_API int zend_list_close(zend_resource *res)

  2. {

  3.    if (GC_REFCOUNT(res) <= 0) {

  4.       return zend_list_free(res);

  5.    else if (res->type >= 0) {

  6.       zend_resource_dtor(res);

  7.    }

  8.    return SUCCESS;

  9. }

与PHP5 不同的地方,这里不是每次都进来将其引用计数减一操作,而是直接调用zend_resource_dtor函数。

  1. static void zend_resource_dtor(zend_resource *res)

  2. {

  3.    zend_rsrc_list_dtors_entry *ld;

  4.    zend_resource r = *res;

  5.  

  6.    res->type = -1;

  7.    res->ptr = NULL;

  8.  

  9.    ld = zend_hash_index_find_ptr(&list_destructors, r.type);

  10.    if (ld) {

  11.       if (ld->list_dtor_ex) {

  12.          ld->list_dtor_ex(&r);

  13.       }

  14.    else {

  15.       zend_error(E_WARNING, "Unknown list entry type (%d)", r.type);

  16.    }

  17. }

如果引用计数已经等于0或者小于0了,那么才从EG(regular_list)中删除

  1. ZEND_API int zend_list_free(zend_resource *res)

  2. {

  3.    if (GC_REFCOUNT(res) <= 0) {

  4.       return zend_hash_index_del(&EG(regular_list), res->handle);

  5.    else {

  6.       return SUCCESS;

  7.    }

  8. }

原理图还是引用上面的注册资源类型、并注册资源的图:

先从zend_resource逆向通过其typelist_destructors中索引层层关联,找到该类资源的释放回调函数,然后对该资源执行释放回调函数。

而后面的从EG(regular_list)中删除,则是通过res->handler做为索引的依据。


---------------伟大的分割线----------------

PHP饭米粒(phpfamily) 由一群靠谱的人建立,愿为PHPer带来一些值得细细品味的精神食粮!

本文由 周梦康 向php饭米粒(phpfamily) 投稿,转载请注明本来源信息和以下的二维码(长按可识别二维码关注):


 
PHP饭米粒 更多文章 世界上最好的语言将于2015年11月12日发布PHP7正式版 我就是我,不一样的PHPer 安全从我做起--PHP安全编码 网站如何实现安全的“记住我” MD5足够吗----谈PHP中信息加密技术
猜您喜欢 Cocos重磅出席iWeb峰会 携手共推HTML5发展 需求、开发和测试的“三足鼎立” 【学习分享】Liblinear之信赖域牛顿法 高级正则表达式技术(Python版) 一份代码构建移动、桌面、Web全平台应用