4.4 中断及跳转

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

4.4.1 break与continue

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

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

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

在每层循环编译时都会创建一个zend_brk_cont_element的结构：

  1. typedef struct _zend_brk_cont_element {
  2.     int start;
  3.     int cont;
  4.     int brk;
  5.     int parent;
  6. } zend_brk_cont_element;

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

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

  1. zend_brk_cont_element *get_next_brk_cont_element(zend_op_array *op_array)
  2. {
  3.     op_array->last_brk_cont++;
  4.     op_array->brk_cont_array = erealloc(op_array->brk_cont_array, sizeof(zend_brk_cont_element)*op_array->last_brk_cont);
  5.     return &op_array->brk_cont_array[op_array->last_brk_cont-1];
  6. }

示例：

  1. $i = 0;
  2. while(1){
  3.     while(1){
  4.         if($i > 10){
  5.             break 2;
  6.         }
  7.         ++$i
  8.     }
  9. }

循环编译完以后对应的内存结构：

4.4 中断及跳转 - 图1

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

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

  • op1: 记录着当前循环zend_brk_cont_element结构的存储位置(在循环编译过程中CG(context).current_brk_cont记录着当前循环zend_brk_cont_element的位置)
  • op2: 记录着要跳出循环的层级，如果break/continue没有加数字，则默认为1
  1. void zend_compile_break_continue(zend_ast *ast)
  2. {
  3.     zend_ast *depth_ast = ast->child[0];
  5.     zend_op *opline;
  6.     int depth;
  8.     if (depth_ast) {
  9.         zval *depth_zv;
  10.         ...
  11.         depth = Z_LVAL_P(depth_zv);
  12.     } else {
  13.         depth = 1;
  14.     }
  15.     ...
  17.     //生成opcode
  18.     opline = zend_emit_op(NULL, ast->kind == ZEND_AST_BREAK ? ZEND_BRK : ZEND_CONT, NULL, NULL);
  19.     opline->op1.num = CG(context).current_brk_cont; //break、continue所在循环层
  20.     opline->op2.num = depth;  //要跳出的层数
  21. }

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

  1. ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type)
  2. {
  3.     //语法解析
  4.     zendparse();
  6.     //AST->opcodes
  7.     zend_compile_top_stmt(CG(ast));
  9.     pass_two(op_array);
  10.     ...
  11. }
  1. ZEND_API int pass_two(zend_op_array *op_array)
  2. {
  3.     ...
  5.     opline = op_array->opcodes;
  6.     end = opline + op_array->last;
  7.     while (opline < end) {
  8.         switch (opline->opcode) {
  9.             ...
  10.             case ZEND_BRK:
  11.             case ZEND_CONT:
  12.             {
  13.                 //计算跳转位置
  14.                 uint32_t jmp_target = zend_get_brk_cont_target(op_array, opline);
  15.                 ...
  16.                 //将opcode修改为ZEND_JMP
  17.                 opline->opcode = ZEND_JMP;
  18.                 opline->op1.opline_num = jmp_target;
  19.                 opline->op2.num = 0;
  21.                 //将绝对跳转opcode位置修改为相对当前opcode的位置
  22.                 ZEND_PASS_TWO_UPDATE_JMP_TARGET(op_array, opline, opline->op1);
  23.             }
  24.             break;
  25.             ...
  26.         }
  27.     }
  29.     op_array->fn_flags |= ZEND_ACC_DONE_PASS_TWO;
  30.     return 0;
  31. }

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

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

上面那个例子最终执行前的opcode如下图：

4.4 中断及跳转 - 图2

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

Note:

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

4.4.2 goto

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

goto语法：

  1. goto LABEL;
  3. LABEL:
  4.     statement;

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

  1. statement:
  2.     ...
  4.     |   T_STRING ':' { $$ = zend_ast_create(ZEND_AST_LABEL, $1); }
  5. ;

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

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

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

  1. void zend_compile_label(zend_ast *ast)
  2. {           
  3.     zend_string *label = zend_ast_get_str(ast->child[0]);
  4.     zend_label dest;
  6.     //编译时会将label插入CG(context).labels哈希表
  7.     if (!CG(context).labels) {
  8.         ALLOC_HASHTABLE(CG(context).labels);
  9.         zend_hash_init(CG(context).labels, 8, NULL, label_ptr_dtor, 0);
  10.     }       
  12.     //设置label信息：当前所在循环、下一条opcode编号
  13.     dest.brk_cont = CG(context).current_brk_cont;
  14.     dest.opline_num = get_next_op_number(CG(active_op_array));
  16.     if (!zend_hash_add_mem(CG(context).labels, label, &dest, sizeof(zend_label))) {
  17.         zend_error_noreturn(E_COMPILE_ERROR, "Label '%s' already defined", ZSTR_VAL(label));
  18.     }   
  19. }

goto的编译过程：

  1. void zend_compile_goto(zend_ast *ast)
  2. {
  3.     zend_ast *label_ast = ast->child[0];
  4.     znode label_node;
  5.     zend_op *opline;
  6.     uint32_t opnum_start = get_next_op_number(CG(active_op_array));
  8.     zend_compile_expr(&label_node, label_ast);
  10.     //如果当前在一个循环内则有的情况下是不能简单跳出循环的
  11.     zend_handle_loops_and_finally();
  12.     //编译一条临时opcode：ZEND_GOTO
  13.     opline = zend_emit_op(NULL, ZEND_GOTO, NULL, &label_node);
  14.     opline->op1.num = get_next_op_number(CG(active_op_array)) - opnum_start - 1;
  15.     opline->extended_value = CG(context).current_brk_cont;
  16. }

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

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