【走进php内核】之中断及跳转(break,continue,goto)

中断及跳转

PHP中的中断及跳转语句主要有break、continue、goto&＃xff0c;这几种语句的实现基础都是跳转。

break与continue

break用于结束当前for、foreach、while、do-while 或者 switch 结构的执行&＃xff1b;continue用于跳过本次循环中剩余代码&＃xff0c;进行下一轮循环。break、continue是非常相像的&＃xff0c;它们都可以接受一个可选数字参数来决定跳过的循环层数&＃xff0c;两者的不同点在于break是跳到循环结束的位置&＃xff0c;而continue是跳到循环判断条件的位置&＃xff0c;本质在于跳转位置的不同。

break、continue的实现稍微有些复杂&＃xff0c;下面具体介绍下其编译过程。

上一节我们已经介绍过循环语句的编译&＃xff0c;其中在各种循环编译过程中有两个特殊操作&＃xff1a;zend_begin_loop()、zend_end_loop()&＃xff0c;分别在循环编译前以及编译后调用&＃xff0c;这两步操作就是为break、continue服务的。

在每层循环编译时都会创建一个zend_brk_cont_element的结构&＃xff1a;

typedef struct _zend_brk_cont_element {int start;int cont;int brk;int parent;
} zend_brk_cont_element;

cont记录的是当前循环判断条件opcode起始位置&＃xff0c;brk记录的是当前循环结束的位置&＃xff0c;parent记录的是父层循环zend_brk_cont_element结构的存储位置&＃xff0c;也就是说多层嵌套循环会生成一个zend_brk_cont_element的链表&＃xff0c;每层循环编译结束时更新自己的zend_brk_cont_element结构&＃xff0c;所以break、continue的处理过程实际就是根据跳出的层级索引到那一层的zend_brk_cont_element结构&＃xff0c;然后得到它的cont、brk进行相应的opcode跳转。

各循环的zend_brk_cont_element结构保存在zend_op_array->brk_cont_array数组中&＃xff0c;编译各循环时依次申请一个zend_brk_cont_element&＃xff0c;zend_op_array->last_brk_cont记录此数组第一个可用位置&＃xff0c;每申请一个元素last_brk_cont就相应的增加1&＃xff0c;然后将数组扩容&＃xff0c;parent记录的就是父层循环结构在该数组中的存储位置。

zend_brk_cont_element *get_next_brk_cont_element(zend_op_array *op_array)
{op_array->last_brk_cont&＃43;&＃43;;op_array->brk_cont_array &＃61; erealloc(op_array->brk_cont_array, sizeof(zend_brk_cont_element)*op_array->last_brk_cont);return &op_array->brk_cont_array[op_array->last_brk_cont-1];
}

示例&＃xff1a;

$i &＃61; 0;
while(1){while(1){if($i > 10){break 2;}&＃43;&＃43;$i}
}

循环编译完以后对应的内存结构&＃xff1a;

介绍完编译循环结构时为break、continue做的准备&＃xff0c;接下来我们具体分析下break、continue的编译。

有了前面的准备&＃xff0c;break、continue的编译过程就比较简单了&＃xff0c;主要就是各生成一条临时opcode&＃xff1a;ZEND_BRK、ZEND_CONT&＃xff0c;这条opcode记录着两个重要信息&＃xff1a;

• op1: 记录着当前循环zend_brk_cont_element结构的存储位置(在循环编译过程中CG(context).current_brk_cont记录着当前循环zend_brk_cont_element的位置)
• op2: 记录着要跳出循环的层级&＃xff0c;如果break/continue没有加数字&＃xff0c;则默认为1

void zend_compile_break_continue(zend_ast *ast)
{zend_ast *depth_ast &＃61; ast->child[0];zend_op *opline;int depth;if (depth_ast) {zval *depth_zv;...depth &＃61; Z_LVAL_P(depth_zv);} else {depth &＃61; 1;}...//生成opcodeopline &＃61; zend_emit_op(NULL, ast->kind &＃61;&＃61; ZEND_AST_BREAK ? ZEND_BRK : ZEND_CONT, NULL, NULL);opline->op1.num &＃61; CG(context).current_brk_cont; //break、continue所在循环层opline->op2.num &＃61; depth; //要跳出的层数
}

zend_compile_break_continue()到这一步完成整个break、continue的编译还没有完成&＃xff0c;因为CG(active_op_array)->brk_cont_array这个数组只是编译期间使用的一个临时结构&＃xff0c;break、continue编译生成的opcode&＃xff1a;ZEND_BRK、ZEND_CONT并不是运行时直接执行的&＃xff0c;这条opcode在整个脚本编译完成后、执行前被优化为 ZEND_JMP &＃xff0c;这个操作在pass_two()中完成&＃xff0c;关于这个过程在《AST->zend_op_array》一节曾经介绍过。

ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type)
{//语法解析zendparse();//AST->opcodeszend_compile_top_stmt(CG(ast));pass_two(op_array);...
}

ZEND_API int pass_two(zend_op_array *op_array)
{...opline &＃61; op_array->opcodes;end &＃61; opline &＃43; op_array->last;while (opline opcode) {...case ZEND_BRK:case ZEND_CONT:{//计算跳转位置uint32_t jmp_target &＃61; zend_get_brk_cont_target(op_array, opline);...//将opcode修改为ZEND_JMPopline->opcode &＃61; ZEND_JMP;opline->op1.opline_num &＃61; jmp_target;opline->op2.num &＃61; 0;//将绝对跳转opcode位置修改为相对当前opcode的位置ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, opline->op1);}break;...}}op_array->fn_flags |&＃61; ZEND_ACC_DONE_PASS_TWO;return 0;
}

从上面的过程可以看出&＃xff0c;如果opcode为&＃xff1a;ZEND_BRK或ZEND_CONT则统一设置opcode为ZEND_JMP&＃xff0c;新opcode的op1记录的是break、continue跳到opcode的位置&＃xff0c;这个值根据编译期间的zend_brk_cont_element计算得到&＃xff0c;首先从op1、op2取出break、continue所在循环的zend_brk_cont_element结构以及要跳过的层级&＃xff0c;然后根据zend_brk_cont_element.parent及层级数找到具体要跳出层的zend_brk_cont_element结构&＃xff0c;从这个结构中获得那层循环判断条件及循环结束的opcode的位置。

static uint32_t zend_get_brk_cont_target(const zend_op_array *op_array, const zend_op *opline) {int nest_levels &＃61; opline->op2.num; //跳出的层级&＃xff1a;break n;int array_offset &＃61; opline->op1.num;//break、continue所属循环zend_brk_cont_element的存储下标zend_brk_cont_element *jmp_to;do {//从break/continue所在循环层开始jmp_to &＃61; &op_array->brk_cont_array[array_offset];if (nest_levels > 1) {//如果还没到要跳出的层数则接着跳到上层array_offset &＃61; jmp_to->parent;}} while (--nest_levels > 0);return opline->opcode &＃61;&＃61; ZEND_BRK ? jmp_to->brk : jmp_to->cont;
}

上面那个例子最终执行前的opcode如下图&＃xff1a;

执行时直接跳到对应的opcode位置即可。

Note:

在多层循环中break、continue直接根据层级数字跳转很不方便&＃xff0c;这点PHP可以借鉴Golang的语法:break/continue &＃43; LABEL&＃xff0c;支持按标签break、continue&＃xff0c;根据上一节及本节介绍的内容这一个实现起来并不复杂&＃xff0c;有兴趣的可以思考下如何实现。

goto

goto 操作符可以用来跳转到程序中的另一位置。该目标位置可以用目标名称加上冒号来标记&＃xff0c;而跳转指令是 goto 之后接上目标位置的标记。PHP 中的 goto 有一定限制&＃xff0c;目标位置只能位于同一个文件和作用域&＃xff0c;也就是说无法跳出一个函数或类方法&＃xff0c;也无法跳入到另一个函数&＃xff0c;可以跳出循环但无法跳入循环(可以在同一层循环中跳转)&＃xff0c;多层循环中通常会用goto代替多层break。

goto语法&＃xff1a;

goto LABEL;LABEL:statement;

goto与label需要组合使用&＃xff0c;其实现与break、continue类似&＃xff0c;最终也是被优化为ZEND_JMP&＃xff0c;首先看下定义一个label时都有哪些操作&＃xff1a;

statement:...| T_STRING &＃39;:&＃39; { $$ &＃61; zend_ast_create(ZEND_AST_LABEL, $1); }
;

label的编译过程非常简单&＃xff0c;与循环结构的编译类似&＃xff0c;编译时会把label插入CG(context).labels哈希表中&＃xff0c;key就是label名称&＃xff0c;value是一个zend_label结构&＃xff1a;

typedef struct _zend_label {int brk_cont; //当前label所在循环uint32_t opline_num; //下一条opcode位置
} zend_label;

brk_cont用于记录当前label所在的循环&＃xff0c;这个值就是上面介绍的每个循环在zend_op_array->brk_cont_array数组中的位置&＃xff1b;opline_num比较容易理解&＃xff0c;就是label下面第一条opcode的位置。到这里你应该能猜得到goto的工作过程了&＃xff0c;首先根据label名称在CG(context).labels查找到跳转label的zend_label结构&＃xff0c;然后jmp到zend_label.opline_num的位置&＃xff0c;brk_cont的作用是用来判断是不是goto到了另一层循环中去。label具体的编译过程&＃xff1a;

void zend_compile_label(zend_ast *ast)
{ zend_string *label &＃61; zend_ast_get_str(ast->child[0]);zend_label dest;//编译时会将label插入CG(context).labels哈希表if (!CG(context).labels) {ALLOC_HASHTABLE(CG(context).labels);zend_hash_init(CG(context).labels, 8, NULL, label_ptr_dtor, 0);} //设置label信息&＃xff1a;当前所在循环、下一条opcode编号dest.brk_cont &＃61; CG(context).current_brk_cont;dest.opline_num &＃61; get_next_op_number(CG(active_op_array));if (!zend_hash_add_mem(CG(context).labels, label, &dest, sizeof(zend_label))) {zend_error_noreturn(E_COMPILE_ERROR, "Label &＃39;%s&＃39; already defined", ZSTR_VAL(label));}
}

goto的编译过程&＃xff1a;

void zend_compile_goto(zend_ast *ast)
{zend_ast *label_ast &＃61; ast->child[0];znode label_node;zend_op *opline;uint32_t opnum_start &＃61; get_next_op_number(CG(active_op_array));zend_compile_expr(&label_node, label_ast);//如果当前在一个循环内则有的情况下是不能简单跳出循环的zend_handle_loops_and_finally();//编译一条临时opcode&＃xff1a;ZEND_GOTOopline &＃61; zend_emit_op(NULL, ZEND_GOTO, NULL, &label_node);opline->op1.num &＃61; get_next_op_number(CG(active_op_array)) - opnum_start - 1;opline->extended_value &＃61; CG(context).current_brk_cont;
}

goto初步被编译为ZEND_GOTO&＃xff0c;其中label名称保存在op2&＃xff0c;extended_value记录的是goto所在循环&＃xff0c;如果没有在循环中这个值就等于-1&＃xff0c;op1比较特殊&＃xff0c;从上面编译的过程分析&＃xff0c;它的值等于goto之间的opcode数&＃xff0c;goto只编译了一条ZEND_GOTO哪来的其他opcode呢&＃xff1f;这种情况就是goto在一个循环中&＃xff0c;上一节介绍的循环结构中有一个比较特殊&＃xff1a;foreach&＃xff0c;它在遍历前会新生成一个zval用于遍历&＃xff0c;这个zval是在循环结束时才被释放&＃xff0c;假如foreach循环体中执行了goto&＃xff0c;直接像普通跳转一样跳到了别的位置&＃xff0c;那么这个zval就无法释放了&＃xff0c;所以这种情况下在goto跳转前需要先执行这些收尾的opcode&＃xff0c;这些opcode就是上面zend_handle_loops_and_finally()编译的&＃xff0c;具体的细节这里不再展开&＃xff0c;有兴趣的可以仔细研究下foreach编译时zend_begin_loop()的特殊处理。

后面的处理就与break、continue一样了&＃xff0c;在pass_two()中ZEND_GOTO被重置为ZEND_JMP&＃xff0c;具体的处理过程在zend_resolve_goto_label()&＃xff0c;比较简单&＃xff0c;不再赘述。