PHP之鉤子

#                        

PHP 提供的鉤子

PHP 和Zend Engine 為擴充功能提供了許多不同的鉤子，這些鉤子允許擴展開發人員以PHP userland 無法提供的方式控制PHP 運行時。

本章將展示各種鉤子和從擴充鉤子到它們的常見用例。

鉤子到 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;}

##替换操作码处理程序

TODO

以上是PHP之鉤子的詳細內容。更多資訊請關注PHP中文網其他相關文章！