PHP系列之钩子

PHP 提供的钩子

PHP 和 Zend Engine 为扩展提供了许多不一样的钩子，这些扩展容许扩展开发人员以 PHP userland 没法提供的方式控制 PHP 运行时。

本章将展现各类钩子和从扩展钩子到它们的常见用例。

钩子到 PHP 功能的通常模式是 PHP 核心提供的扩展覆盖函数指针。而后扩展函数一般执行本身的工做并调用原始 PHP 核心函数。使用此模式，不一样的扩展能够覆盖同一个钩子而不会致使冲突。

挂钩到函数的执行

userland和内部函数的执行由Zend引擎中的两个函数处理，您能够用本身的实现替换这两个函数。覆盖此钩子的扩展的主要用例是通用函数级评测、调试和面向方面的编程。

钩子在 Zend/zend_execute.h 中定义:

ZEND_API extern void (*zend_execute_ex)(zend_execute_data *execute_data);ZEND_API extern void (*zend_execute_internal)(zend_execute_data *execute_data, zval *return_value);

若是要覆盖这些函数指针，则必须在 Minit 中执行此操做，由于 Zend Engine 中的其余决策是根据指针是否被覆盖这一事实提早作出的。

覆盖的一般模式是这样的：

static void (*original_zend_execute_ex) (zend_execute_data *execute_data);static void (*original_zend_execute_internal) (zend_execute_data *execute_data, zval *return_value);void my_execute_internal(zend_execute_data *execute_data, zval *return_value);void my_execute_ex (zend_execute_data *execute_data);PHP_MINIT_FUNCTION(my_extension){

    REGISTER_INI_ENTRIES();

 

    original_zend_execute_internal = zend_execute_internal;

    zend_execute_internal = my_execute_internal;

 

    original_zend_execute_ex = zend_execute_ex;

    zend_execute_ex = my_execute_ex;

 

    return SUCCESS;}PHP_MSHUTDOWN_FUNCTION(my_extension){

    zend_execute_internal = original_zend_execute_internal;

    zend_execute_ex = original_zend_execute_ex;

 

    return SUCCESS;}

覆盖 zend_execute_ex 的一个缺点是它将 Zend Virtual Machine 运行时的行为更改成使用递归，而不是在不离开解释器循环的状况下处理调用。此外，没有覆盖zend_execute_ex的 PHP 引擎也能够生成更优化的函数调用操做码。

这些挂钩对性能很是敏感，具体取决于原始函数封装代码的复杂性。

覆盖内部功能

在覆盖执行钩子时，扩展能够记录每一个函数调用，你还能够覆盖用户域，核心和扩展函数（和方法）的各个函数指针。若是扩展仅须要访问特定的内部函数调用，则具备更好的性能特征。

#if PHP_VERSION_ID < 70200typedef void (*zif_handler)(INTERNAL_FUNCTION_PARAMETERS);#endif

zif_handler original_handler_var_dump;ZEND_NAMED_FUNCTION(my_overwrite_var_dump){

    // 若是咱们想调用原始函数

    original_handler_var_dump(INTERNAL_FUNCTION_PARAM_PASSTHRU);}PHP_MINIT_FUNCTION(my_extension){

    zend_function *original;

 

    original = zend_hash_str_find_ptr(EG(function_table), "var_dump", sizeof("var_dump")-1);

 

    if (original != NULL) {

        original_handler_var_dump = original->internal_function.handler;

        original->internal_function.handler = my_overwrite_var_dump;

    }}

 

覆盖类方法时，能够在 zend_class_entry上找到函数表：

zend_class_entry *ce = zend_hash_str_find_ptr(CG(class_table), "PDO", sizeof("PDO")-1);if (ce != NULL) {

    original = zend_hash_str_find_ptr(&ce->function_table, "exec", sizeof("exec")-1);

 

    if (original != NULL) {

        original_handler_pdo_exec = original->internal_function.handler;

        original->internal_function.handler = my_overwrite_pdo_exec;

    }}

 

修改抽象语法树（AST）

当 PHP 7编译 PHP 代码时，它会先将其转换为抽象语法树（AST），而后最终生成持久存储在 Opcache 中的操做码。zend_ast_process钩子会被每一个已编译的脚本调用，并容许你在解析和建立 AST 以后修改 AST。

这是要使用的最复杂的钩子之一，由于它须要彻底了解 AST。在此处建立无效的 AST 可能会致使异常行为或崩溃。

最好看看使用此钩子的示例扩展：

• Google Stackdriver PHP调试器扩展
• 基于 Stackdriver 的带有 AST 的概念验证器

熟悉脚本/文件编译

每当用户脚本调用include/require或其对应的include_once/require_once时，PHP内核都会在指针zend_compile_file处调用该函数处理此请求。参数是文件句柄，结果是zend_op_array。

zend_op_array * my_extension_compile_file(zend_file_handle * file_handle，int类型);

PHP核心中有两个扩展实现了此挂钩：dtrace和opcache。

• 若是您使用环境变量USE_ZEND_DTRACE启动PHP脚本并使用dtrace支持编译了PHP，则dtrace_compile_file用于Zend / zend_dtrace.c。
• Opcache将操做数组存储在共享内存中以得到更好的性能，所以，每当脚本被编译时，其最终的操做数组都会从缓存中获得服务，而不是从新编译。您能够在ext / opcache / ZendAccelerator.c中找到此实现。
• 名为compile_file的默认实现是Zend / zend_language_scanner.l中扫描程序代码的一部分。

实施此挂钩的用例是Opcode Accelerating，PHP代码加密/解密，调试或概要分析。

您能够随时在执行PHP进程时替换该挂钩，而且替换后编译的全部PHP脚本都将由该挂钩的实现处理。

始终调用原始函数指针很是重要，不然PHP将没法再编译脚本，而且Opcache将再也不起做用。

此处的扩展覆盖顺序也很重要，由于您须要知道是要在Opcache以前仍是以后注册钩子，由于Opcache若是在其共享内存缓存中找到操做码数组条目，则不会调用原始函数指针。 Opcache将其钩子注册为启动后钩子，该钩子在扩展的minit阶段以后运行，所以默认状况下，缓存脚本时将再也不调用该钩子。

调用错误处理程序时的通知

与PHP用户区set_error_handler()函数相似，扩展能够经过实现zend_error_cb钩子将自身注册为错误处理程序：

ZEND_API void(* zend_error_cb)(int类型，const char * error_filename，const uint32_t error_lineno，const char * format，va_list args);

type变量对应于E _ *错误常量，该常量在PHP用户区中也可用。

PHP核心和用户态错误处理程序之间的关系很复杂：

1. 若是未注册任何用户级错误处理程序，则始终调用zend_error_cb。
2. 若是注册了userland错误处理程序，则对于E_ERROR，E_PARSE，E_CORE_ERROR，E_CORE_WARNING，E_COMPILE_ERROR的全部错误和E_COMPILE_WARNING始终调用zend_error_cb挂钩。
3. 对于全部其余错误，仅在用户态处理程序失败或返回false时调用zend_error_cb。

另外，因为Xdebug自身复杂的实现，它以不调用之前注册的内部处理程序的方式覆盖错误处理程序。

所以，覆盖此挂钩不是很可靠。

再次覆盖应该以尊重原始处理程序的方式进行，除非您想彻底替换它：

void(* original_zend_error_cb)(int类型，const char * error_filename，const uint error_lineno，const char * format，va_list args);void my_error_cb(int类型，const char * error_filename，const uint error_lineno，const char * format，va_list args){

    //个人特殊错误处理

 

    original_zend_error_cb(type，error_filename，error_lineno，format，args);}PHP_MINIT_FUNCTION(my_extension){

    original_zend_error_cb = zend_error_cb;

    zend_error_cb = my_error_cb;

 

    return SUCCESS;}PHP_MSHUTDOWN(my_extension){

    zend_error_cb = original_zend_error_cb;}

 

该挂钩主要用于为异常跟踪或应用程序性能管理软件实施集中式异常跟踪。

引起异常时的通知

每当PHP Core或Userland代码引起异常时，都会调用zend_throw_exception_hook并将异常做为参数。

这个钩子的签名很是简单：

void my_throw_exception_hook(zval * exception){

    if(original_zend_throw_exception_hook！= NULL){

        original_zend_throw_exception_hook(exception);

    }}

该挂钩没有默认实现，若是未被扩展覆盖，则指向NULL。

static void(* original_zend_throw_exception_hook)(zval * ex);void my_throw_exception_hook(zval * exception);PHP_MINIT_FUNCTION(my_extension){

    original_zend_throw_exception_hook = zend_throw_exception_hook;

    zend_throw_exception_hook = my_throw_exception_hook;

 

    return SUCCESS;}

 

若是实现此挂钩，请注意不管是否捕获到异常，都会调用此挂钩。将异常临时存储在此处，而后将其与错误处理程序挂钩的实现结合起来以检查异常是否未被捕获并致使脚本中止，仍然有用。

实现此挂钩的用例包括调试，日志记录和异常跟踪。

挂接到eval()

PHPeval不是内部函数，而是一种特殊的语言构造。所以，您没法经过zend_execute_internal或经过覆盖其函数指针来链接它。

挂钩到eval的用例并很少，您能够将其用于概要分析或出于安全目的。若是更改其行为，请注意可能须要评估其余扩展名。一个示例是Xdebug，它使用它执行断点条件。

extern ZEND_API zend_op_array *(* zend_compile_string)(zval * source_string，char * filename);

挂入垃圾收集器

当可收集对象的数量达到必定阈值时，引擎自己会调用gc_collect_cycles()或隐式地触发PHP垃圾收集器。

为了使您了解垃圾收集器的工做方式或分析其性能，能够覆盖执行垃圾收集操做的函数指针挂钩。从理论上讲，您能够在此处实现本身的垃圾收集算法，可是若是有必要对引擎进行其余更改，则这可能实际上并不可行。

int(* original_gc_collect_cycles)(无效);int my_gc_collect_cycles(无效){

    original_gc_collect_cycles();}PHP_MINIT_FUNCTION(my_extension){

    original_gc_collect_cycles = gc_collect_cycles;

    gc_collect_cycles = my_gc_collect_cycles;

 

    return SUCCESS;}

 

覆盖中断处理程序

当执行器全局EG(vm_interrupt)设置为1时，将调用一次中断处理程序。在执行用户域代码期间，将在常规检查点对它进行检查。引擎使用此挂钩经过信号处理程序实现PHP执行超时，该信号处理程序在达到超时持续时间后将中断设置为1。

当更安全地清理或实现本身的超时处理时，这有助于将信号处理推迟到运行时执行的后期。经过设置此挂钩，您不会意外禁用PHP的超时检查，由于它具备自定义处理的优先级，该优先级高于对zend_interrupt_function的任何覆盖。

ZEND_API void(* original_interrupt_function)(zend_execute_data * execute_data);void my_interrupt_function(zend_execute_data * execute_data){

    if(original_interrupt_function！= NULL){

        original_interrupt_function(execute_data);

    }}PHP_MINIT_FUNCTION(my_extension){

    original_interrupt_function = zend_interrupt_function;

    zend_interrupt_function = my_interrupt_function;

 

    return SUCCESS;}