php源码-如何查看opcode源码

opcode是什么大家都不陌生， php代码经过编译后就会形成opcode数组，zend引擎执行的就是opcode，我们看下opcode的结构体定义

//zend_compile.h文件中
struct _zend_op {
    const void *handler;  //opcode的处理函数
    znode_op op1;
    znode_op op2;
    znode_op result;
    uint32_t extended_value;
    uint32_t lineno;
    zend_uchar opcode; //opcode的名字id
    zend_uchar op1_type;
    zend_uchar op2_type;
    zend_uchar result_type;
};

每个opcode对应一个 handler函数， zend执行的就是这个handler函数，那么如何能找到opcode对应的handler函数呢？

第一步，通过vld扩展输出php代码编译之后的opcode都有什么

vld扩展地址： git clone https://github.com/derickr/vld.git vld
安装很简单， 也可以参考这篇文章安装vld扩展使用
phpize
./configure --with-php-config=/path/to/toy/php/bin/php-config
make
make install

使用
php -dvld.active=1 test.php

vld扩展能得到这么一个结果

opcode.png

这里得到的opcode对应的是zend_vm_opcodes.c中的 opcode定义， 比如ASSIGN 对应的是ZEND_ASSIGN, 但是仅仅通过这个我们还不能找到执行的handler函数具体是哪一个

第二步，opcode handler获取原理

通过opcode获取对应的handler关键函数就是 zend_vm_execute.h中的zend_vm_get_opcode_handler()和 zend_vm_get_opcode_handler_ex() , zend_vm_get_opcode_handler就是对zend_vm_get_opcode_handler_ex做一个封装。

zend_vm_get_opcode_handler_ex() 这个函数通过一定的计算最终返回的是 zend_opcode_handlers 数组中的某一个值，这个返回的值就是 opcode 要执行的handler函数， 也就是返回了一个函数指针。
zend_opcode_handlers存的就是所有opcode的handler函数指针， 这个值是在zend_init_opcodes_handlers() 中初始化的

void zend_init_opcodes_handlers(void)
{
    static const void *labels[] = {
        ZEND_NOP_SPEC_HANDLER,
        ZEND_ADD_SPEC_CONST_CONST_HANDLER,
        ...
        ZEND_SEND_VAR_EX_SIMPLE_SPEC_CV_QUICK_HANDLER,
        ZEND_NULL_HANDLER
  };
  ...
    zend_opcode_handlers = labels;
    zend_handlers_count = sizeof(labels) / sizeof(void*);
    zend_spec_handlers = specs;

labels数组定义了所有的opcode函数指针

第三步，修改zend_vm_execute.h源码，重新编译php，输出handler

修改zend_vm_get_opcode_handler_ex() 增加下面的代码输出handler

static const void *zend_vm_get_opcode_handler_ex(uint32_t spec, const zend_op* op) {
    ... 
    //把上面的labels定义拷贝过来，用文本转成字符串数组
    char* cclehui_op_handlers[] = {
        "ZEND_NOP_SPEC_HANDLER",
        "ZEND_ADD_SPEC_CONST_CONST_HANDLER",
        ...
        "ZEND_SEND_VAR_EX_SIMPLE_SPEC_CV_QUICK_HANDLER",
        "ZEND_NULL_HANDLER"
    };
    zend_uchar opcode = op->opcode;
    int index = (spec & SPEC_START_MASK) + offset;
    FILE *stream = fopen("/tmp/opcode.log", "a+");//输出opcode
    if(stream != NULL){
        fprintf(stream,"opcode: %d %s , index:%d %s\n", opcode,zend_get_opcode_name(opcode), index,cclehui_op_handlers[index]);
    }


    return zend_opcode_handlers[(spec & SPEC_START_MASK) + offset];


}

重新编译php， 运行demo: php -dvld.active=1 test.php , 在/tmp/opcode.log中应该会得到如下的输出

opcode2.png

最后一列的ZEND_EXIT_SPEC_UNUSED_HANDLER， ZEND_ECHO_SPEC_CONST_HANDLER等就是opcode对应的执行handler， 大部分都定义在 zend_vm_execute.h中