WIP: Recording soft fails for individual opcodes

derickr · derickr · commit 90c664c3e305 · 2025-02-03T11:51:41.000Z
diff --git a/src/coverage/branch_info.c b/src/coverage/branch_info.c
@@ -55,7 +55,7 @@ void xdebug_branch_info_free(xdebug_branch_info *branch_info)
 	free(branch_info);
 }
 
-void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos)
+void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos, bool soft_fail)
 {
 	xdebug_set_add(branch_info->ends, pos);
 	if (outidx < XDEBUG_BRANCH_MAX_OUTS) {
@@ -65,6 +65,7 @@ void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos
 		}
 	}
 	branch_info->branches[pos].start_lineno = lineno;
+	branch_info->branches[pos].soft_fail = soft_fail;
 }
 
 static void only_leave_first_catch(zend_op_array *opa, xdebug_branch_info *branch_info, int position)
diff --git a/src/coverage/branch_info.h b/src/coverage/branch_info.h
@@ -41,6 +41,7 @@ typedef struct _xdebug_branch {
 	unsigned int  end_op;
 	unsigned int  outs_count;
 	int           outs[XDEBUG_BRANCH_MAX_OUTS];
+	bool          soft_fails[XDEBUG_BRANCH_MAX_OUTS];
 } xdebug_branch;
 
 typedef struct _xdebug_path {
diff --git a/src/coverage/code_coverage.c b/src/coverage/code_coverage.c
@@ -321,7 +321,7 @@ static zend_always_inline bool xdebug_string_equals_cstr(const zend_string *s1,
 # define xdebug_string_equals_literal  zend_string_equals_literal
 #endif
 
-static int xdebug_find_jumps(zend_op_array *opa, unsigned int position, size_t *jump_count, int *jumps)
+static int xdebug_find_jumps(zend_op_array *opa, unsigned int position, size_t *jump_count, int *jumps, bool *soft_fail_jumps)
 {
 #if ZEND_USE_ABS_JMP_ADDR
 	zend_op *base_address = &(opa->opcodes[0]);
@@ -361,6 +361,7 @@ static int xdebug_find_jumps(zend_op_array *opa, unsigned int position, size_t *
 	} else if (opcode.opcode == ZEND_FE_RESET_R || opcode.opcode == ZEND_FE_RESET_RW) {
 		jumps[0] = position + 1;
 		jumps[1] = XDEBUG_ZNODE_JMP_LINE(opcode.op2, position, base_address);
+		soft_fail_jumps[1] = true;
 		*jump_count = 2;
 		return 1;
 
@@ -512,10 +513,14 @@ static void xdebug_analysis_branch(zend_op_array *opa, unsigned int position, xd
 	while (position < opa->last) {
 		size_t jump_count = 0;
 		int    jumps[XDEBUG_BRANCH_MAX_OUTS];
+		bool   soft_fail_jumps[XDEBUG_BRANCH_MAX_OUTS];
 		size_t i;
 
+		/* Clean out soft_fail_jumps */
+		memset(soft_fail_jumps, 0, sizeof(soft_fail_jumps));
+
 		/* See if we have a jump instruction */
-		if (xdebug_find_jumps(opa, position, &jump_count, jumps)) {
+		if (xdebug_find_jumps(opa, position, &jump_count, jumps, soft_fail_jumps)) {
 			/* Record the highest jump if we have branch information*/
 			if (branch_info && jump_count > branch_info->highest_out) {
 				branch_info->highest_out = jump_count;
@@ -524,7 +529,7 @@ static void xdebug_analysis_branch(zend_op_array *opa, unsigned int position, xd
 			for (i = 0; i < jump_count; i++) {
 				if (jumps[i] == XDEBUG_JMP_EXIT || jumps[i] != XDEBUG_JMP_NOT_SET) {
 					if (branch_info) {
-						xdebug_branch_info_update(branch_info, position, opa->opcodes[position].lineno, i, jumps[i]);
+						xdebug_branch_info_update(branch_info, position, opa->opcodes[position].lineno, i, jumps[i], soft_fail_jumps[i]);
 					}
 					if (jumps[i] != XDEBUG_JMP_EXIT) {
 						xdebug_analysis_branch(opa, jumps[i], set, branch_info);
diff --git a/src/coverage/code_coverage_private.h b/src/coverage/code_coverage_private.h
@@ -64,7 +64,7 @@ typedef struct xdebug_coverage_file {
 
 xdebug_branch_info *xdebug_branch_info_create(unsigned int size);
 
-void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos);
+void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos, bool soft_fail);
 void xdebug_branch_post_process(zend_op_array *opa, xdebug_branch_info *branch_info);
 void xdebug_branch_find_paths(xdebug_branch_info *branch_info);
 
diff --git a/tests/coverage/foreach.phpt b/tests/coverage/foreach.phpt
@@ -54,7 +54,6 @@ showLanguages
 - paths
   - 0 3 4 3 9: HIT
   - 0 3 9: HIT
-  - 0 9:  X
 
 showLanguages
 - branches

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ void xdebug_branch_info_free(xdebug_branch_info *branch_info)`
`55`	`55`	`free(branch_info);`
`56`	`56`	`}`
`57`	`57`
`58`		`-void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos)`
	`58`	`+void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos, unsigned int lineno, unsigned int outidx, unsigned int jump_pos, bool soft_fail)`
`59`	`59`	`{`
`60`	`60`	`xdebug_set_add(branch_info->ends, pos);`
`61`	`61`	`if (outidx < XDEBUG_BRANCH_MAX_OUTS) {`
`@@ -65,6 +65,7 @@ void xdebug_branch_info_update(xdebug_branch_info *branch_info, unsigned int pos`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`	`branch_info->branches[pos].start_lineno = lineno;`
	`68`	`+ branch_info->branches[pos].soft_fail = soft_fail;`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`static void only_leave_first_catch(zend_op_array opa, xdebug_branch_info branch_info, int position)`