深切了解PHP内核(六)函数的概念、传参及返回值

一样、函数的定义

  用户函数的定义从function 关键字开始,如下

function foo($var) {
    echo $var;
}

  1、词法分析

  在Zend/zend_language_scanner.l中我们找到如下所展示之代码:

<ST_IN_SCRIPTING>"function" {
    return T_FUNCTION;
}

  它所表示的意思是function将会晤生成T_FUNCTION标记。在取得这符号后,我们初步语法分析。

  2、语法分析

  在Zend/zend_language_parser.y文件被找到函数的扬言过程标记如下:

function:
    T_FUNCTION { $$.u.opline_num = CG(zend_lineno); }
;

is_reference:
        /* empty */ { $$.op_type = ZEND_RETURN_VAL; }
    |   '&'         { $$.op_type = ZEND_RETURN_REF; }
;

unticked_function_declaration_statement:
        function is_reference T_STRING {
zend_do_begin_function_declaration(&$1, &$3, 0, $2.op_type, NULL TSRMLS_CC); }
            '(' parameter_list ')' '{' inner_statement_list '}' {
                zend_do_end_function_declaration(&$1 TSRMLS_CC); }
;

    关注点在function is_reference
T_STRING,表示function关键字,是否引用,函数曰

  T_FUNCTION标记只是用来恒定函数的扬言,表示即是一个函数,而再多的行事是同这函数相关的事物,包括参数,返回值。

  3、生成中间代码

  语法解析后,我们见到所实行编译函数为zend_do_begin_function_declaration。在Zend/zend_complie.c文件找到该促成如下:

void zend_do_begin_function_declaration(znode *function_token, znode 
*function_name,
 int is_method, int return_reference, znode *fn_flags_znode TSRMLS_DC) /* {{{ 
*/
{
    ...//省略
    function_token->u.op_array = CG(active_op_array);
    lcname = zend_str_tolower_dup(name, name_len);

    orig_interactive = CG(interactive);
    CG(interactive) = 0;
    init_op_array(&op_array, ZEND_USER_FUNCTION, INITIAL_OP_ARRAY_SIZE 
TSRMLS_CC);
    CG(interactive) = orig_interactive;

     ...//省略

    if (is_method) {
        ...//省略,类方法 在后面的章节介绍
„!ǶGH
    } else {
        zend_op *opline = get_next_op(CG(active_op_array) TSRMLS_CC);


        opline->opcode = ZEND_DECLARE_FUNCTION;
        opline->op1.op_type = IS_CONST;
        build_runtime_defined_function_key(&opline->op1.u.constant, lcname,
            name_len TSRMLS_CC);
        opline->op2.op_type = IS_CONST;
        opline->op2.u.constant.type = IS_STRING;
        opline->op2.u.constant.value.str.val = lcname;
        opline->op2.u.constant.value.str.len = name_len;
        Z_SET_REFCOUNT(opline->op2.u.constant, 1);
        opline->extended_value = ZEND_DECLARE_FUNCTION;
        zend_hash_update(CG(function_table), opline-
>op1.u.constant.value.str.val,
            opline->op1.u.constant.value.str.len, &op_array, 
sizeof(zend_op_array),
             (void **) &CG(active_op_array));
    }

}
/* }}} */

  生成的代码为ZEND_DECLARE_FUNCTION,根据此当中的代码和操作数对应之op_type。我们可以找到中间代码的实行函数为ZEND_DECLARE_FUNCTION_SPEC_HANDLER。

    在转变中间代码的早晚,可以观看就合并了函数誉为全副吧稍写,表示函数的号不是区  分大小写的。

  也证实这个实现,我们看无异截代码

function T() {
    echo 1;
}

function t() {
    echo 2;
}

  执行代码会报错Fatal error: Cannot redeclare t() (previously declared
in …)

  代表对此PHP来说T和t是同一个函数曰,校验函数曰是否更,这个进程是于哪进行的也?

  4、执行中间代码

  在Zend/zend_vm_execute.h文件中找到ZEND_DECLARE_FUNCTION中间代码对应的实践函数:ZEND_DECLARE_FUNCTION_SPEC_HANDLER。此函数只调用了函数do_bind_function。其调用代码为:

do_bind_function(EX(opline), EG(function_table), 0);

  以这个函数中将EX(opline)所针对的函数添加至EG(function_table)中,并认清是否都存在同样名字的函数,如果在则报错,EG(function_table)用来存放在执行进程被任何之函数信息,相当给函数的注册表。它的构造是一个HashTable,所以在do_bind_function函数中上加新的函数使用的凡HashTable的操作函数zend_hash_add

 

亚、函数的参数

  函数的定义只是一个将函数叫注册到函数列表的进程。

  1、用户从定义函数的参数

  我们掌握对函数的参数检查是由此zend_do_receive_arg函数来兑现之,在这函数中对参数的重中之重代码如下:

CG(active_op_array)->arg_info = erealloc(CG(active_op_array)->arg_info,
        sizeof(zend_arg_info)*(CG(active_op_array)->num_args));
cur_arg_info = &CG(active_op_array)->arg_info[CG(active_op_array)->num_args-1];
cur_arg_info->name = estrndup(varname->u.constant.value.str.val,
        varname->u.constant.value.str.len);
cur_arg_info->name_len = varname->u.constant.value.str.len;
cur_arg_info->array_type_hint = 0;
cur_arg_info->allow_null = 1;
cur_arg_info->pass_by_reference = pass_by_reference;
cur_arg_info->class_name = NULL;
cur_arg_info->class_name_len = 0;

  整个参数的传递是由此让中间代码的arg_info字段执行赋值操作就。关键点是当arg_info字段,arg_info字段的布局如下:

typedef struct _zend_arg_info {
    const char *name;   /*参数的名称*/
    zend_uint name_len;     /*参数名称的长度*/
    const char *class_name; /* 类名*/
     zend_uint class_name_len;   /*类名长度*/
    zend_bool array_type_hint;  /*数组类型提示*/
    zend_bool allow_null;   /*是否允许为NULLͺ*/
    zend_bool pass_by_reference;    /*是否引用传递*/
    zend_bool return_reference; 
    int required_num_args;  
} zend_arg_info;

  参数的价值传递和参数传递的区分是由此pass_by_reference参数在转变中间代码时落实的。

  对于参数的个数,中间代码中带有的arg_nums字段在历次执行**zend_do_receive_argxx时还见面加1.之类代码:

CG(active_op_array)->num_args++;

  并且当前参数的目为ŒCG(active_op_array)->num_args-1.如下代码:

cur_arg_info = &CG(active_op_array)->arg_info[CG(active_op_array)->num_args-1];

  以上的剖析是指向函数定义时之参数设置,这些参数是固定的。而于实际编写程序时或者咱们会为此到但是转换参数。此时我们会就此到函数func_num_args和func_get_args。它们是盖其中函数存在。于是以Zend\zend_builtin_functions.c文件被找到这片个函数的落实。我们先是来看func_num_args函数的实现,其代码如下:

/* {{{ proto int func_num_args(void)
   Get the number of arguments that were passed to the function */
ZEND_FUNCTION(func_num_args)
{
    zend_execute_data *ex = EG(current_execute_data)->prev_execute_data;

    if (ex && ex->function_state.arguments) {
        RETURN_LONG((long)(zend_uintptr_t)*(ex->function_state.arguments));
    } else {
        zend_error(E_WARNING,
"func_num_args():  Called from the global scope - no function context");
        RETURN_LONG(-1);
    }
}
/* }}} */

  在存在ex->function_state.arguments的情下,及函数调用时,返回ex->function_state.arguments转化后的价值,否则显示错误并赶回-1。这里最重点的一些是EG(current_execute_data)。这个变量存放的凡时实践顺序还是函数的数据,此时咱们得取前一个实行顺序的数量,为什么呢?因为这函数的调用是当上函数后实施的。函数的系数据等都在前头实施过程被,于是调用的是:

zend_execute_data *ex = EG(current_execute_data)->prev_execute_data;

 

  2、内部函数的参数

  因广阔的count函数为条例,其参数处理部分的代码如下:

/* {{{ proto int count(mixed var [, int mode])
   Count the number of elements in a variable (usually an array) */
PHP_FUNCTION(count)
{
    zval *array;
    long mode = COUNT_NORMAL;

    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|l",
         &array, &mode) == FAILURE) {
        return;
    }
    ... //省略
}

  这里包括了有限个操作:一个凡得到参数的个数,一个是分析参数列表。

  (1)取参数的个数

  取参数的个数是通过ZEND_NUM_ARGS()宏来实现的,其定义如下:

#define ZEND_NUM_ARGS()     (ht)

  ht是于Zend/zend.h文件被定义的宏INTERNAL_FUNCTION_PARAMETERS中的ht,如下

#define INTERNAL_FUNCTION_PARAMETERS int ht, zval *return_value,
zval **return_value_ptr, zval *this_ptr, int return_value_used TSRMLS_DC

  (2)解析参数列表

  PHP内部函数在条分缕析参数时利用的是zend_parse_parameters。它好大大简化参数的收取处理工作,虽然它在拍卖可转换参数时还闹接触死亡。

  其宣称如下:

ZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, 
...)
  • 先是个参数num_args表明表示怀念如果接到的参数个数,我们常常利用ZEND_NUM_ARGS()来代表对传播的参数“有略要稍微”
  • 其次单参数应该是宏TSRMLS_CC。
  • 其三独参数type_spec是一个字符串,用来指定我们所愿意接收的一一参数的类型,有硌类似于printf中指定输出格式的那个格式化字符串。
  • 剩余的参数就是咱所以来接收PHP参数值的变量的指针。

  zend_parse_parameters()在条分缕析参数的还要户尽可能的易参数类型,这样便足以确保我们连能够赢得所期待之档次的变量

 

  3、函数的返回值

  PHP中函数都来返回值,没return返回null

  (1)return语句

  从Zend/zend_language_parser.y文件中得以肯定该生成中间代码调用的凡zend_do_return函数。

void zend_do_return(znode *expr, int do_end_vparse TSRMLS_DC) /* {{{ */
{
    zend_op *opline;
    int start_op_number, end_op_number;
 if (do_end_vparse) {
        if (CG(active_op_array)->return_reference
                && !zend_is_function_or_method_call(expr)) {
            zend_do_end_variable_parse(expr, BP_VAR_W, 0 TSRMLS_CC);/* 处理返回引用 */
        } else {
            zend_do_end_variable_parse(expr, BP_VAR_R, 0 TSRMLS_CC);/* 处理常规变量返回 */
        }
    }

   ...// 省略,取其他中间代码操作

    opline->opcode = ZEND_RETURN;

    if (expr) {
        opline->op1 = *expr;

        if (do_end_vparse && zend_is_function_or_method_call(expr)) {
            opline->extended_value = ZEND_RETURNS_FUNCTION;
        }
    } else {
        opline->op1.op_type = IS_CONST;
        INIT_ZVAL(opline->op1.u.constant);
    }

    SET_UNUSED(opline->op2);
}
/* }}} */

  生成中间代码为ZEND_RETURN。第一独操作数的花色在返回值为可用之表达式时,其色为表达式的操作类型,否则路也IS_CONST。这在继承计算执行中间代码函数时有用到。根据操作数的差,ZEND_RETURN中间代码会执行ZEND_RETURN_SPEC_CONST_HANDLER,ZEND_RETURN_SPEC_TMP_HANDLER或ZEND_RETURN_SPEC_TMP_HANDLER。这三独函数的执行流程基本类似,包括针对有的左的拍卖。这里我们因为ZEND_RETURN_SPEC_CONST_HANDLER也条例说明函数返回值的实践过程:

static int ZEND_FASTCALL  
ZEND_RETURN_SPEC_CONST_HANDLER(ZEND_OPCODE_HANDLER_ARGS)
{
    zend_op *opline = EX(opline);
    zval *retval_ptr;
    zval **retval_ptr_ptr;


    if (EG(active_op_array)->return_reference == ZEND_RETURN_REF) {

        //  ǓǔŷsÁ\ɁƶMļ@ɗÁĻļ
        if (IS_CONST == IS_CONST || IS_CONST == IS_TMP_VAR) {   
            /* Not supposed to happen, but we'll allow it */
            zend_error(E_NOTICE, "Only variable references \
                should be returned by reference");
            goto return_by_value;
        }

        retval_ptr_ptr = NULL;  //  ǓǔŔ

        if (IS_CONST == IS_VAR && !retval_ptr_ptr) {
            zend_error_noreturn(E_ERROR, "Cannot return string offsets by 
reference");
        }
 if (IS_CONST == IS_VAR && !Z_ISREF_PP(retval_ptr_ptr)) {
            if (opline->extended_value == ZEND_RETURNS_FUNCTION &&
                EX_T(opline->op1.u.var).var.fcall_returned_reference) {
            } else if (EX_T(opline->op1.u.var).var.ptr_ptr ==
                    &EX_T(opline->op1.u.var).var.ptr) {
                if (IS_CONST == IS_VAR && !0) {
                      /* undo the effect of get_zval_ptr_ptr() */
                    PZVAL_LOCK(*retval_ptr_ptr);
                }
                zend_error(E_NOTICE, "Only variable references \
                 should be returned by reference");
                goto return_by_value;
            }
        }

        if (EG(return_value_ptr_ptr)) { //  Ǔǔŷs
            SEPARATE_ZVAL_TO_MAKE_IS_REF(retval_ptr_ptr);   //  is_ref__gcőęŒ
1
            Z_ADDREF_PP(retval_ptr_ptr);    //  refcount__gcŒď×1

            (*EG(return_value_ptr_ptr)) = (*retval_ptr_ptr);
        }
    } else {
return_by_value:

        retval_ptr = &opline->op1.u.constant;

        if (!EG(return_value_ptr_ptr)) {
            if (IS_CONST == IS_TMP_VAR) {

            }
        } else if (!0) { /* Not a temp var */
            if (IS_CONST == IS_CONST ||
                EG(active_op_array)->return_reference == ZEND_RETURN_REF ||
                (PZVAL_IS_REF(retval_ptr) && Z_REFCOUNT_P(retval_ptr) > 0)) {
                zval *ret;

                ALLOC_ZVAL(ret);
                INIT_PZVAL_COPY(ret, retval_ptr);   //  Ł™ͿʍǓǔŔ 
                zval_copy_ctor(ret);
                *EG(return_value_ptr_ptr) = ret;
            } else {
                *EG(return_value_ptr_ptr) = retval_ptr; //  ħ6ɶŔ
                Z_ADDREF_P(retval_ptr);
            }
        } else {
            zval *ret;

            ALLOC_ZVAL(ret);
            INIT_PZVAL_COPY(ret, retval_ptr);    //  Ł™ͿʍǓǔŔ 
            *EG(return_value_ptr_ptr) = ret;    
        }
    }

    return zend_leave_helper_SPEC(ZEND_OPCODE_HANDLER_ARGS_PASSTHRU);   //  Ǔ
ǔĉˆșʒ
}

  函数的归值当程序执行时存储在*EG(return_value_ptr_ptr)。ZEND内核对值返回跟援返回作了分别,并且以此基础及针对常量,临时变量和外类别的变量在回时作了不同之处理。在return执行了事后,ZEND内核通过调用zend_leave_helper_SPEC函数,清除函数内部用的变量等。这吗是ZEND内核自动为函数加上NULL返回的原故有。

相关文章