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

2023-06-02 0 299

在写作上面的文本以后,他们假设你早已对 PHP 7 基本上的计算机程序都有大体的介绍了,这是上面文本写作的大前提。

他们分成三大块:

具体来说同时实现两个自订的文档关上、加载、载入、停用的文档操作方式扩充;

接着预测各操作另一面的同时实现基本上原理,当中这类部份的同时实现就要和PHP 5.3 采用天然资源包覆服务器端扩充源代码阐释 对照预测。

0 透过蓝本聚合扩充金属结构

具体来说步入到源代码产品目录的ext产品目录中,加进两个文档操作方式的蓝本文档

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

[root@localhost ext]# vim tipi_file.proto

撰稿蓝本为

resource file_open(string filename, string mode)

string file_read(resource filehandle, int size)

bool file_write(resource filehandle, string buffer)

bool file_close(resource filehandle)

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

这样两个简单的文档操作方式扩充的代码金属结构就聚合了。

完整代码 tipi_file.c(https://github.com/zhoumengkang/notes/blob/master/php-extension/php7.0/tipi_file/tipi_file.c),可以先有两个大体的介绍,这样后面写作时,思路可能会清晰很多。

 1 扩充的同时实现

1.1 注册天然资源类型

1.1.1 注册天然资源 API

ZEND_API intzend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld,constchar*type_name, intmodule_number)

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

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

1.1.2 加进天然资源释放回调函数

staticvoidtipi_file_dtor(zend_resource *rsrc TSRMLS_DC){

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

fclose(fp);

}

他们发现该函数的参数类型是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_ex在PHP_MINIT_FUNCTION来注册天然资源类型。

PHP_MINIT_FUNCTION(tipi_file)

{

/* If you have INI entries, uncomment these lines

REGISTER_INI_ENTRIES();

*/

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

returnSUCCESS;

}

当中TIPI_FILE_TYPE在前面早已定义了,是该扩充的别名(具体可以对照着代码 tipi_file.c 查看(https://github.com/zhoumengkang/notes/blob/master/php-extension/php7.0/tipi_file/tipi_file.c))

1.2 注册天然资源

1.2.1 注册天然资源 API

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

ZEND_API zend_resource* zend_register_resource(void*rsrc_pointer, intrsrc_type)

参数解释rsrc_pointer天然资源数据指针rsrc_type注册天然资源类型时获得的天然资源类型 id1.2.2 在 file_open函数中同时实现天然资源的注册

PHP_FUNCTION(file_open)

{

char*filename = NULL;

char*mode = NULL;

intargc = ZEND_NUM_ARGS();

size_tfilename_len;

size_tmode_len;

if(zend_parse_parameters(argc TSRMLS_CC,“ss”, &filename, &filename_len, &mode, &mode_len) == FAILURE) 

return;

// 采用 VCWD 宏取代标准 C 文档操作方式函数

FILE*fp = VCWD_FOPEN(filename, mode);

if(fp == NULL) {

RETURN_FALSE;

}

RETURN_RES(zend_register_resource(fp, le_tipi_file));

}

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

1.3 采用天然资源

1.3.1 采用天然资源 API

ZEND_API void*zend_fetch_resource(zend_resource *res,constchar*resource_type_name, intresource_type)

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

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

1.3.2 解析天然资源的同时实现

当他们要同时实现文档的加载时,最终还是需要采用原生的fread函数,所以这里需要透过zend_fetch_resource将zend_resource解析成为该天然资源包覆的原始的FILE *的指针。

PHP_FUNCTION(file_read)

{

intargc = ZEND_NUM_ARGS();

intfilehandle_id = -1;

zend_long size;

zval *filehandle = NULL;

FILE*fp = NULL;

char*result;

size_tbytes_read;

if(zend_parse_parameters(argc TSRMLS_CC,“rl”, &filehandle, &size) == FAILURE) 

return;

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

RETURN_FALSE;

}

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

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

result[bytes_read] = \0;

RETURN_STRING(result, 0);

}

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

与之类似的文档的载入操作方式,也很类似,这里就复制代码了,请查看完整的代码 tipi_file.c(https://github.com/zhoumengkang/notes/blob/master/php-extension/php7.0/tipi_file/tipi_file.c)

1.4 天然资源的删除

1.4.1 天然资源删除 API

ZEND_API intzend_list_close(zend_resource *res)

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

1.4.2 天然资源删除的同时实现

他们在函数file_close中需要调用天然资源删除 API

PHP_FUNCTION(file_close)

{

intargc = ZEND_NUM_ARGS();

intfilehandle_id = -1;

zval *filehandle = NULL;

if(zend_parse_parameters(argc TSRMLS_CC,“r”, &filehandle) == FAILURE) 

return;

zend_list_close(Z_RES_P(filehandle));

RETURN_TRUE;

}

1.5 编译安装以及测试

1.5.1 编译安装

透过上面的编码,两个简单的服务器端的扩充就同时实现了。查看完整版(https://github.com/zhoumengkang/notes/tree/master/php-extension/php7.0/tipi_file)

上面的一些命令配置请根据自己的环境而定(安装的过程可以参考最基础的扩充开发教程(https://mengkang.net/660.html))

[root@localhost tipi_file]# php7ize

Configuring for:

PHP Api Version:         20151012

Zend Module Api No:      20151012

Zend Extension Api No:   320151012

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

[root@localhost tipi_file]# make

[root@localhost tipi_file]# make install

1.5.2 测试

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

$fp = file_open(“./CREDITS”,“r+”);

var_dump($fp);

var_dump(file_read($fp,6));

var_dump(file_write($fp,“zhoumengakng”));

var_dump(file_close($fp));

接着透过命令行执行

php7 -d“extension=tipi_file.so”tipi_file.php

2 源代码预测

2.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)

{

zend_rsrc_list_dtors_entry *lde;

zval zv;

lde = malloc(sizeof(zend_rsrc_list_dtors_entry));

lde->list_dtor_ex = ld;

lde->plist_dtor_ex = pld;

lde->module_number = module_number;

lde->resource_id = list_destructors.nNextFreeElement;

lde->type_name = type_name;

ZVAL_PTR(&zv, lde);

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

returnFAILURE;

}

returnlist_destructors.nNextFreeElement-1;

}

当中

ZVAL_PTR(&zv, lde);

等价于

zv.value.ptr = (lde);

zv.u1.type_info = IS_PTR;

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

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

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

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

2.2 天然资源的注册

ZEND_API zend_resource* zend_register_resource(void*rsrc_pointer, intrsrc_type)

{

zval *zv;

zv = zend_list_insert(rsrc_pointer, rsrc_type);

returnZ_RES_P(zv);

}

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

重点预测zend_list_insert

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

{

int index;

zval zv;

index = zend_hash_next_free_element(&EG(regular_list));

if(index == 0) {

index = 1;

}

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

returnzend_hash_index_add_new(&EG(regular_list), index, &zv);

}

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

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

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

zend_resource *_res =                                 \

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

zval *__z;                                         \

GC_REFCOUNT(_res) = 1;                                    \

GC_TYPE_INFO(_res) = IS_RESOURCE;                     \

_res->handle = (h);                                        \

_res->type = (t);                                      \

_res->ptr = (p);                                       \

__z = (z);                                            \

Z_RES_P(__z) = _res;                                  \

Z_TYPE_INFO_P(__z) = IS_RESOURCE_EX;                  \

while(0)

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

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

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

关于HashTable的具体操作方式,这里暂不做细致的预测,后面单独再单独说。

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

2.3 解析天然资源源代码预测

ZEND_API void*zend_fetch_resource(zend_resource *res, constchar*resource_type_name, intresource_type)

{

if(resource_type == res->type) {

returnres->ptr;

}

if(resource_type_name) {

constchar*space;

constchar*class_name = get_active_class_name(&space);

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);

}

returnNULL;

}

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

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

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

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

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

2.4 删除天然资源源代码预测

ZEND_API intzend_list_close(zend_resource *res)

{

if(GC_REFCOUNT(res) <= 0) {

returnzend_list_free(res);

elseif(res->type >= 0) {

zend_resource_dtor(res);

}

returnSUCCESS;

}

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

staticvoidzend_resource_dtor(zend_resource *res)

{

zend_rsrc_list_dtors_entry *ld;

zend_resource r = *res;

res->type = -1;

res->ptr = NULL;

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

if(ld) {

if(ld->list_dtor_ex) {

ld->list_dtor_ex(&r);

}

else{

zend_error(E_WARNING, “Unknown list entry type (%d)”, r.type);

}

}

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

ZEND_API intzend_list_free(zend_resource *res)

{

if(GC_REFCOUNT(res) <= 0) {

returnzend_hash_index_del(&EG(regular_list), res->handle);

else{

returnSUCCESS;

}

}

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

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

先从zend_resource逆向透过其type在list_destructors中索引层层关联,找到该类天然资源的释放回调函数,接着对该天然资源执行释放回调函数。

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

本文为优才学院Web全栈学员周梦康原创文章,转载请联系原作者

博客地址:https://mengkang.net/684.html

推荐写作

PHP 开发利器 PhpStorm 7 发布

PHP7 性能翻倍关键大揭露

PHP同时实现四种基本上排序算法

PHP开发提高效率技巧

相关文章

发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务