PHP源码系列之扩展的原理与开发

最新推荐文章于 2024-08-28 09:15:55 发布
最新推荐文章于 2024-08-28 09:15:55 发布
阅读量795 收藏
点赞数 1
分类专栏： PHP源码系列 文章标签： php
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/acsdner/article/details/120396256
版权

目录

一、前言

1、本文使用源码版本为PHP-7.1.19
2、本文安装的PHP版本为7.1.19
3、使用电脑为Mac，操作系统信息如下

Darwin Kernel Version 18.0.0: root:xnu-4903.201.2~1/RELEASE_X86_64 x86_64

4、本文提到的扩展开发是PHP扩展，而不是Zend扩展，二者的区别见这里
5、文章原文来自于博客，关注获取最新文章

二、PHP扩展与Zend扩展

1、什么是PHP扩展

在/php-src/Zend/zend_modules.h头文件中定义了_zend_module_entry结构体，这个结构体就是PHP扩展的结构体，称为module，除了一些基本信息外，主要提供了以下个钩子函数

  • MINT ：模块初始化时被调用
  • MSHUTDOWN ：模块结束化时被调用
  • RINT ：每一次请求时被调用
  • RSHUTDOWN ：每一次请求结束后被调用
struct _zend_module_entry {
    // 基本信息一般通过STANDARD_MODULE_HEADER常量填充即可
    unsigned short size;
    unsigned int zend_api;
    const struct _zend_ini_entry *ini_entry;
    int module_started;
    int module_number;
    
    // 扩展的名称
    const char *name;
    
    // 扩展的函数指针, 用于获取扩展的函数列表
    const struct _zend_function_entry *functions;
    
    // MINT钩子函数
    int (*module_startup_func)(INIT_FUNC_ARGS);
    
    // MSHUTDOWN钩子函数
    int (*module_shutdown_func)(SHUTDOWN_FUNC_ARGS);
    
    // RINT钩子函数
    int (*request_startup_func)(INIT_FUNC_ARGS);
    
    // RSHUTDOWN钩子函数
    int (*request_shutdown_func)(SHUTDOWN_FUNC_ARGS);
	
    // 调用phpinfo()时打印扩展信息
    void (*info_func)(ZEND_MODULE_INFO_FUNC_ARGS);
};

2、什么是Zend扩展

在/php-src/Zend/zend_extensions.h头文件中定义了_zend_extension结构体，这个结构体就是Zend扩展的结构体，称为extension。相比PHP扩展，主要提供了更底层的钩子函数，如下所示

struct _zend_extension {
    // 一些基本信息
    char *name;
    char *version;
    char *author;
    char *URL;
    char *copyright;

    /*Zend生命周期内的一些钩子函数*/
    startup_func_t startup;
    shutdown_func_t shutdown;
    activate_func_t activate;
    deactivate_func_t deactivate;

    message_handler_func_t message_handler;

    op_array_handler_func_t op_array_handler;

    statement_handler_func_t statement_handler;
    fcall_begin_handler_func_t fcall_begin_handler;
    fcall_end_handler_func_t fcall_end_handler;

    op_array_ctor_func_t op_array_ctor;
    op_array_dtor_func_t op_array_dtor;
    /*Zend生命周期内的一些钩子函数*/
};

3、举例

(1) Json扩展

Json扩展定义结构体为zend_module_entry，可知它是PHP扩展
image.png

(2) Opcache扩展

Opcache扩展定义结构体为zend_extension，可知它是Zend扩展
image.png

(3) Xdebug扩展

Xdebug扩展必须在Zend生命周期内Hook才能实现对代码的调试，所以Xdebug是Zend扩展

4、总结

扩展是区分php扩展和zend扩展的，在PHP源码中也严格区分module和extension这两个定义

  • module表示php extension，即PHP的扩展，通过extension=*加载
  • extension表示zend extension，即Zend的扩展，通过zend_extension=*加载

三、扩展的组成结构

1、目录结构

在源码中的php-src/ext目录就是扩展目录，如json、mysqli、pdo等常用的扩展，其中每个扩展都主要由以下文件组成

  • tests ：单元测试目录
  • config.m4 ：扩展的编译配置文件（Unix系统）
  • config.w32 ：扩展的编译配置文件（Windows系统）
  • php_{$module}.h ：扩展的头文件
  • {$module}.c ：扩展源文件
  • {$module}.php ：扩展的测试文件

2、代码结构

(1) 单元测试

在编译扩展成功后，会在扩展目录下生成一个run-test.php脚本文件，这个脚本会自动执行tests目录下的所有单元测试。
​
此外在扩展目录下还会自动生成一个{$module}.php扩展的测试文件，可以方便的测试扩展是否可以正常加载和使用

(2) 编译配置文件

扩展下载后只有源码，需要进行编译生成.so扩展文件后才可以被PHP使用，config.m4和config.w32这两个文件就是在后续执行phpize阶段会使用到的编译配置文件。
​
m4是一种宏处理文件，主要由PHP_ARG_WITH和PHP_ARG_ENABLE两部分构成，一般使用第二部分即可，用于开启指定的扩展。这样在编译阶段，就会判断$PHP_PHP_HELLO变量不是no，从而执行此扩展的编译。
​
其中dnl宏会删除本行多余的字符，可以简单的理解为注释，如下所示，如果需要编译php_hello这个扩展，把PHP_ARG_ENABLE部分最前面的dnl宏都去掉即可

dnl If your extension references something external, use with:

dnl PHP_ARG_WITH(php_hello, for php_hello support,
dnl Make sure that the comment is aligned:
dnl [  --with-php_hello             Include php_hello support])

dnl Otherwise use enable:

dnl PHP_ARG_ENABLE(php_hello, whether to enable php_hello support,
dnl Make sure that the comment is aligned:
dnl [  --enable-php_hello           Enable php_hello support])

if test "$PHP_PHP_HELLO" != "no"; then
  PHP_NEW_EXTENSION(php_hello, php_hello.c, $ext_shared,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
fi

(3) 扩展头文件

一般名为php_{$module}.h的是扩展头文件，一般用于定义需要的常量和函数等

(4) 扩展源文件

一般名称为{$module}.c的是扩展源文件，主要由以下部分组成

  • zend_module_entry ：定义扩展的结构体
  • PHP_FUNCTION ：定义扩展的函数
  • Hook_FUNCTION ：如 PHP_MINIT_FUNCTION 等

四、扩展的加载过程

(1) 源码注释

在php-src/main/main.c文件中，php_module_startup()函数会执行扩展的加载与初始化。

int php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_modules, uint num_additional_modules)
{
    
    // Zend引擎初始化
    zend_startup(&zuf, NULL);
    
    // 注册常量
    php_output_register_constants();
    php_rfc1867_register_constants();
    
    // 注册ini配置
    if (php_init_config() == FAILURE) {
        return FAILURE;
    }
    REGISTER_INI_ENTRIES();
    zend_register_standard_ini_entries();

    // 注册$_GET/$_POST/$_SERVER/$_REQUEST等全局变量
    php_startup_auto_globals()

    // 加载静态编译的扩展这些扩展包含在main/internal_functions.c中
    if (php_register_internal_extensions_func(TSRMLS_C) == FAILURE) {
        php_printf("Unable to start builtin modules\n");
        return FAILURE;
    }

    // 注册SAPI的扩展模块，即additional_modules中的扩展
    php_register_extensions_bc(additional_modules, num_additional_modules TSRMLS_CC);

    // 根据ini配置，先加载Zend扩展, 再加载PHP扩展
    php_ini_register_extensions(TSRMLS_C);
    
    // 扩展初始化, 触发MINT()钩子
    zend_startup_modules(TSRMLS_C);
    zend_startup_extensions();
}

(2) php_ini_register_extensions函数

在此函数中，extension_lists是一个保存着解析ini配置后获得的所有扩展（包括PHP扩展和Zend扩展）的链表，通过使用&extension_lists.engine和&extension_lists.functions获取PHP扩展列表和Zend扩展链表，然后通过php_load_zend_extension_cb()或php_load_php_extension_cb()分别完成不同类型扩展的加载

void php_ini_register_extensions(void)
{
	//注册zend扩展
    zend_llist_apply(&extension_lists.engine, php_load_zend_extension_cb);
	//注册php扩展
    zend_llist_apply(&extension_lists.functions, php_load_php_extension_cb);

    zend_llist_destroy(&extension_lists.engine);
    zend_llist_destroy(&extension_lists.functions);
}

(3) 扩展的生命周期

如在PHP扩展与Zend扩展一节中看到的，这两种扩展分别提供了不同的钩子函数，这些函数在PHP生命周期内的调用顺序如下图所示

五、扩展的开发教程

1、获取PHP源码

获取PHP源码后，切换至7.1.19版本，按如下命令操作

git clone https://github.com/php/php-src
git checkout remotes/origin/PHP-7.1.19

2、生成扩展的基础文件

切换到ext扩展目录下，在此目录下，有一个ext_skel脚本，可以用来自动生成扩展的基础文件。比如创建一个print_hello的扩展，按如下命令操作

cd php-src/ext/
./ext_skel --extname=print_hello

执行成功后，会得到如下提示
img.png
回到在ext目录下，发现已经成功生成print_hello目录，主要包含如下文件

  • tests ：单元测试目录
  • config.m4 ：扩展的编译配置文件（Unix系统）
  • config.w32 ：扩展的编译配置文件（Windows系统）
  • php_print_hello.h ：扩展的头文件
  • print_hello.c ：扩展源文件
  • print_hello.php ：扩展的测试文件

image.png

3、修改编译配置文件

打开config.m4配置文件，如下所示

image.png
找到PHP_ARG_ENABLE这段代码，删掉前面的dnl宏，如下所示

# 修改前
dnl PHP_ARG_ENABLE(print_hello, whether to enable print_hello support,
dnl Make sure that the comment is aligned:
dnl [  --enable-print_hello           Enable print_hello support])

# 修改后
PHP_ARG_ENABLE(print_hello, whether to enable print_hello support,
Make sure that the comment is aligned:
[  --enable-print_hello           Enable print_hello support])

4、修改print_hello.c文件

找到PHP_FUNCTION（表示定义的扩展函数），在如下confirm_print_hello_compiled函数中添加一句输出hello world的代码

PHP_FUNCTION(confirm_print_hello_compiled)
{
	char *arg = NULL;
	size_t arg_len, len;
	zend_string *strg;

	if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &arg, &arg_len) == FAILURE) {
		return;
	}

	strg = strpprintf(0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "print_hello", arg);

  // 新增下面输出hello world的代码
  php_printf("hello world!\n");

  RETURN_STR(strg);
}

5、编译扩展

通过执行以下命令执行对扩展的编译处理

cd print_hello
phpize
./configure --with-php-config=/usr/bin/php-config
make
sudo make

执行make命令成功后如下所示
img.png
执行sudo make install命令成功后如下所示
image.png

6、执行扩展测试脚本

测试脚本会先动态加载print_hello扩展，并输出扩展中所有提供的函数，最后执行在print_hello.c源文件中定义的confirm_print_hello_compiled函数，如果正常执行则说明扩展加载且执行成功

$br = (php_sapi_name() == "cli")? "":"<br>";

// 判断扩展是否已加载
if(!extension_loaded('print_hello')) {
    // 在运行时动态加载扩展库
    // 如果加载失败，需要修改php.ini配置文件，直接开启动态加载扩展的选项enable_dl = On即可，在命令行下执行不需要重启PHP
    dl('print_hello.' . PHP_SHLIB_SUFFIX);
}
$module = 'print_hello';

// 依次输出扩展提供的所有函数
$functions = get_extension_funcs($module);
echo "Functions available in the test extension:$br\n";
foreach($functions as $func) {
    echo $func."$br\n";
}
echo "$br\n";

// 如果扩展加载成功, 则执行 confirm_print_hello_compiled 函数
$function = 'confirm_' . $module . '_compiled';
if (extension_loaded($module)) {
	$str = $function($module);
} else {
	$str = "Module $module is not compiled into PHP";
}

echo "$str\n";

脚本执行成功后如下所示
image.png

7、结束

到目前为止，简单的print_hello扩展就已经开发完成，当然还可以在print_hello.c源文件中定义更多的扩展函数，做更多有趣的事情！不过篇幅有限就不再讲解，关于扩展的高阶使用请关注博客，获取最新文章！

Wgrape
关注
专栏目录
php扩展开发
afterlife_union的博客
03-24 576
php 扩展开发相关知识
PHP扩展安装与使用系列课程php测试源码.zip
06-23
静态编译是在编译PHP时将扩展集成到PHP源码中，而动态加载则是在运行时通过php.ini配置文件来启用扩展。对于初学者，更常见的方法是动态加载，因为这样更便于管理和更新扩展。 "src"目录通常包含了课程中的源代码...
PHP Extension的开发基础
weixin_33786077的博客
12-09 377
摘要&amp;引言 PHP是当前应用非常广泛的一门语言，从国外的Facebook、Twitter到国内的淘宝、腾讯、百度再到互联网上林林总总的各种大中小型网站都能见到它的身影。PHP的成功，应该说很大程度上依赖于其开放的扩展API机制和丰富的扩展组件（PHP Extension），正是这些扩展组件使得PHP从各种数据库操作到XML、JSON、加密、文件处理、图形处理、Socket等领域无所不能。...
构建下一代PHP扩展的神器：ext-php-rs
最新发布
gitblog_00883的博客
08-28 416
构建下一代PHP扩展的神器：ext-php-rs ext-php-rsBindings for the Zend API to build PHP extensions natively in Rust.项目地址:https://gitcode.com/gh_mirrors/ex/ext-php-rs 在现代Web开发领域，PHP依然占据着重要的地位。为了满足开发者对于高效、安全且易于维护的扩展...
php拓展原理,扩展的实现原理
weixin_35380427的博客
03-28 203
扩展的实现原理扩展的实现原理## 7.2 扩展的实现原理PHP中扩展通过`zend_module_entry`这个结构来表示，此结构定义了扩展的全部信息：扩展名、扩展版本、扩展提供的函数列表以及PHP四个执行阶段的hook函数等，每一个扩展都需要定义一个此结构的变量，而且这个变量的名称格式必须是：`{mudule_name}_module_entry`，内核正是通过这个结构获取到扩展提供的功能的。...
PHP 扩展开发
xchenhao 的博客
02-21 545
PHP 扩展开始
PHP扩展开发
wzx19840423的专栏
09-29 398
首先让我们在你PHP源码树的ext/目录下创建一个名叫hello的目录，并进入(chdir)到这个目录中。这个目录实际上可以放在任何地方，PHP源码树内或者PHP源码树外，但是我希望你把它放在源码树内为了接下来的文章使用。在这你需要创建三个文件：一个包含你hello_world函数的源文件，一个头文件，其中包含PHP加载你扩展时候所需的引用，一个配置文件，它会被phpize用来准备扩展的编译环境。
PHP扩展开发中文教程_PHP扩展开发中文教程_源码
10-04
这通常包括安装PHP源码、配置编译选项，以及设置相关的开发工具，如GCC编译器和调试器。安装完毕后，开发者可以开始编写扩展的C代码，这涉及到头文件的包含、宏的使用以及函数声明等。 在编写扩展时，我们需要定义...
PHP实例开发源码-web表单设计器 ueditor扩展.zip
11-21
通过学习和研究这个源码，开发者可以深入理解PHP与前端编辑器的协同工作原理，提升在Web表单开发领域的技能。同时，这也是一个很好的实践项目，帮助开发者将理论知识转化为实际应用，锻炼解决问题的能力。
PHP实例开发源码—HTTPCWS PHP中文分词扩展.zip
11-22
这个压缩包包含了一个PHP的分词工具及其源码，可以帮助开发者更深入地理解其工作原理并进行定制化开发。 首先，我们来了解一下什么是分词。分词，即词语切分，是指将连续的汉字序列按照语义和语法划分成一个个单独...
PHP网站实例开发源码——QeePHP 开发框架.zip
10-25
11. **命令行工具**：提供了一系列的命令行工具，用于生成模型、控制器、迁移等，加快开发进程。 12. **自动加载**：通过自动加载机制，可以避免手动引入类文件，减少代码冗余。 通过研究QeePHP的源码，开发者可以...
深入理解PHP内置mysql扩展：原理与Linux配置
本文将深入探讨PHP源码中的ext/mysql扩展，这一扩展是PHP内建的一种类型，它允许PHP与MySQL数据库进行交互。PHP扩展通常分为三种：外部模块、内置扩展和Zend扩展，而mysql扩展由于其被集成到PHP核心，因此属于内置...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值