Zend: reengineer how __debugInfo() magic method is handed

Girgias · Girgias · commit 06473b1f25db · 2025-11-21T08:40:27.000Z
The primary motivation is to get rid of the bailout by using a type error, but also properly abort the output when an exception is thrown or the deprecation notice is promoted to an exception.

This is effectively an internal API change as extensions are no longer allowed to return NULL to fast path an empty array.
diff --git a/Zend/tests/debug_info/debug_info-error-0.0.phpt b/Zend/tests/debug_info/debug_info-error-0.0.phpt
@@ -17,4 +17,8 @@ $c = new C(0.0);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-0.phpt b/Zend/tests/debug_info/debug_info-error-0.phpt
@@ -17,4 +17,8 @@ $c = new C(0);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-1.0.phpt b/Zend/tests/debug_info/debug_info-error-1.0.phpt
@@ -17,4 +17,8 @@ $c = new C(1.0);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-1.phpt b/Zend/tests/debug_info/debug_info-error-1.phpt
@@ -17,4 +17,8 @@ $c = new C(1);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-debug_zval_dump-basic.phpt b/Zend/tests/debug_info/debug_info-error-debug_zval_dump-basic.phpt
@@ -18,4 +18,8 @@ debug_zval_dump($c);
 
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): debug_zval_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-debug_zval_dump-within-array.phpt b/Zend/tests/debug_info/debug_info-error-debug_zval_dump-within-array.phpt
@@ -21,9 +21,8 @@ $a = [
 debug_zval_dump($a);
 ?>
 --EXPECTF--
-array(3) packed refcount(2){
-  [0]=>
-  string(3) "foo" interned
-  [1]=>
-  
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): debug_zval_dump(Array)
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-debug_zval_dump-within-object.phpt b/Zend/tests/debug_info/debug_info-error-debug_zval_dump-within-object.phpt
@@ -20,9 +20,8 @@ $o->bar = 'bar';
 debug_zval_dump($o);
 ?>
 --EXPECTF--
-object(stdClass)#1 (3) refcount(2){
-  ["foo"]=>
-  string(3) "foo" interned
-  ["c"]=>
-  
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): debug_zval_dump(Object(stdClass))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-empty_str.phpt b/Zend/tests/debug_info/debug_info-error-empty_str.phpt
@@ -17,4 +17,8 @@ $c = new C("");
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-false.phpt b/Zend/tests/debug_info/debug_info-error-false.phpt
@@ -17,4 +17,8 @@ $c = new C(false);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-object.phpt b/Zend/tests/debug_info/debug_info-error-object.phpt
@@ -17,4 +17,8 @@ $c = new C(new stdClass);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-print_r-basic.phpt b/Zend/tests/debug_info/debug_info-error-print_r-basic.phpt
@@ -18,4 +18,8 @@ print_r($c);
 
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): print_r(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-print_r-within-array.phpt b/Zend/tests/debug_info/debug_info-error-print_r-within-array.phpt
@@ -21,4 +21,8 @@ $a = [
 print_r($a);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): print_r(Array)
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-print_r-within-object.phpt b/Zend/tests/debug_info/debug_info-error-print_r-within-object.phpt
@@ -20,4 +20,8 @@ $o->bar = 'bar';
 print_r($o);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): print_r(Object(stdClass))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-resource.phpt b/Zend/tests/debug_info/debug_info-error-resource.phpt
@@ -19,4 +19,8 @@ $c = new C(fopen("data:text/plain,Foo", 'r'));
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-str.phpt b/Zend/tests/debug_info/debug_info-error-str.phpt
@@ -17,4 +17,8 @@ $c = new C("foo");
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-true.phpt b/Zend/tests/debug_info/debug_info-error-true.phpt
@@ -17,4 +17,8 @@ $c = new C(true);
 var_dump($c);
 ?>
 --EXPECTF--
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(C))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-within-array.phpt b/Zend/tests/debug_info/debug_info-error-within-array.phpt
@@ -21,9 +21,8 @@ $a = [
 var_dump($a);
 ?>
 --EXPECTF--
-array(3) {
-  [0]=>
-  string(3) "foo"
-  [1]=>
-  
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Array)
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/tests/debug_info/debug_info-error-within-object.phpt b/Zend/tests/debug_info/debug_info-error-within-object.phpt
@@ -20,9 +20,8 @@ $o->bar = 'bar';
 var_dump($o);
 ?>
 --EXPECTF--
-object(stdClass)#1 (3) {
-  ["foo"]=>
-  string(3) "foo"
-  ["c"]=>
-  
-Fatal error: __debuginfo() must return an array in %s on line %d
+Fatal error: Uncaught TypeError: __debuginfo() must return an array in %s:%d
+Stack trace:
+#0 %s(%d): var_dump(Object(stdClass))
+#1 {main}
+  thrown in %s on line %d
diff --git a/Zend/zend.c b/Zend/zend.c
@@ -375,9 +375,9 @@ ZEND_API zend_string *zend_strpprintf_unchecked(size_t max_len, const char *form
 }
 /* }}} */
 
-static void zend_print_zval_r_to_buf(smart_str *buf, zval *expr, int indent);
+static bool zend_print_zval_r_to_buf(smart_str *buf, zval *expr, int indent);
 
-static void print_hash(smart_str *buf, HashTable *ht, int indent, bool is_object) /* {{{ */
+static bool print_hash(smart_str *buf, HashTable *ht, int indent, bool is_object) /* {{{ */
 {
 	zval *tmp;
 	zend_string *string_key;
@@ -398,7 +398,7 @@ static void print_hash(smart_str *buf, HashTable *ht, int indent, bool is_object
 			if (is_object) {
 				const char *prop_name, *class_name;
 				size_t prop_len;
-				int mangled = zend_unmangle_property_name_ex(string_key, &class_name, &prop_name, &prop_len);
+				zend_result mangled = zend_unmangle_property_name_ex(string_key, &class_name, &prop_name, &prop_len);
 
 				smart_str_appendl(buf, prop_name, prop_len);
 				if (class_name && mangled == SUCCESS) {
@@ -417,14 +417,17 @@ static void print_hash(smart_str *buf, HashTable *ht, int indent, bool is_object
 			smart_str_append_long(buf, num_key);
 		}
 		smart_str_appends(buf, "] => ");
-		zend_print_zval_r_to_buf(buf, tmp, indent+PRINT_ZVAL_INDENT);
+		if (UNEXPECTED(!zend_print_zval_r_to_buf(buf, tmp, indent+PRINT_ZVAL_INDENT))) {
+			return false;
+		}
 		smart_str_appends(buf, "\n");
 	} ZEND_HASH_FOREACH_END();
 	indent -= PRINT_ZVAL_INDENT;
 	for (i = 0; i < indent; i++) {
 		smart_str_appendc(buf, ' ');
 	}
 	smart_str_appends(buf, ")\n");
+	return true;
 }
 /* }}} */
 
@@ -541,29 +544,28 @@ ZEND_API void zend_print_flat_zval_r(zval *expr)
 	smart_str_free(&buf);
 }
 
-static void zend_print_zval_r_to_buf(smart_str *buf, zval *expr, int indent) /* {{{ */
+static bool zend_print_zval_r_to_buf(smart_str *buf, zval *expr, int indent) /* {{{ */
 {
 	switch (Z_TYPE_P(expr)) {
-		case IS_ARRAY:
+		case IS_ARRAY: {
 			smart_str_appends(buf, "Array\n");
 			if (!(GC_FLAGS(Z_ARRVAL_P(expr)) & GC_IMMUTABLE)) {
 				if (GC_IS_RECURSIVE(Z_ARRVAL_P(expr))) {
 					smart_str_appends(buf, " *RECURSION*");
-					return;
+					return true;
 				}
 				GC_PROTECT_RECURSION(Z_ARRVAL_P(expr));
 			}
-			print_hash(buf, Z_ARRVAL_P(expr), indent, false);
+			bool status = print_hash(buf, Z_ARRVAL_P(expr), indent, false);
 			GC_TRY_UNPROTECT_RECURSION(Z_ARRVAL_P(expr));
-			break;
+			return status;
+		}
 		case IS_OBJECT:
 			{
-				HashTable *properties;
-
 				zend_object *zobj = Z_OBJ_P(expr);
 				uint32_t *guard = zend_get_recursion_guard(zobj);
 				zend_string *class_name = Z_OBJ_HANDLER_P(expr, get_class_name)(zobj);
-				smart_str_appends(buf, ZSTR_VAL(class_name));
+				smart_str_append(buf, class_name);
 				zend_string_release_ex(class_name, 0);
 
 				if (!(zobj->ce->ce_flags & ZEND_ACC_ENUM)) {
@@ -579,45 +581,49 @@ static void zend_print_zval_r_to_buf(smart_str *buf, zval *expr, int indent) /*
 
 				if (ZEND_GUARD_OR_GC_IS_RECURSIVE(guard, DEBUG, zobj)) {
 					smart_str_appends(buf, " *RECURSION*");
-					return;
+					return true;
 				}
 
-				if ((properties = zend_get_properties_for(expr, ZEND_PROP_PURPOSE_DEBUG)) == NULL) {
-					print_hash(buf, (HashTable*) &zend_empty_array, indent, true);
-					break;
+				HashTable *properties = zend_get_properties_for(expr, ZEND_PROP_PURPOSE_DEBUG);
+				/* Either we must have properties as a HashTable (even if empty) or an exception if NULL is returned */
+				ZEND_ASSERT(properties || EG(exception));
+				if (UNEXPECTED(properties == NULL)) {
+					return false;
 				}
 
 				ZEND_GUARD_OR_GC_PROTECT_RECURSION(guard, DEBUG, zobj);
-				print_hash(buf, properties, indent, true);
+				bool status = print_hash(buf, properties, indent, true);
 				ZEND_GUARD_OR_GC_UNPROTECT_RECURSION(guard, DEBUG, zobj);
 
-				zend_release_properties(properties);
-				break;
+				zend_array_release(properties);
+				return status;
 			}
 		case IS_LONG:
 			smart_str_append_long(buf, Z_LVAL_P(expr));
-			break;
+			return true;
 		case IS_REFERENCE:
-			zend_print_zval_r_to_buf(buf, Z_REFVAL_P(expr), indent);
-			break;
+			return zend_print_zval_r_to_buf(buf, Z_REFVAL_P(expr), indent);
 		case IS_STRING:
 			smart_str_append(buf, Z_STR_P(expr));
-			break;
-		default:
-			{
-				zend_string *str = zval_get_string_func(expr);
-				smart_str_append(buf, str);
-				zend_string_release_ex(str, 0);
-			}
-			break;
+			return true;
+		default: {
+			zend_string *str = zval_get_string_func(expr);
+			smart_str_append(buf, str);
+			zend_string_release_ex(str, 0);
+			return true;
+		}
 	}
 }
 /* }}} */
 
 ZEND_API zend_string *zend_print_zval_r_to_str(zval *expr, int indent) /* {{{ */
 {
 	smart_str buf = {0};
-	zend_print_zval_r_to_buf(&buf, expr, indent);
+	bool status = zend_print_zval_r_to_buf(&buf, expr, indent);
+	if (UNEXPECTED(!status)) {
+		smart_str_free(&buf);
+		return NULL;
+	}
 	smart_str_0(&buf);
 	return buf.s;
 }
@@ -626,6 +632,10 @@ ZEND_API zend_string *zend_print_zval_r_to_str(zval *expr, int indent) /* {{{ */
 ZEND_API void zend_print_zval_r(zval *expr, int indent) /* {{{ */
 {
 	zend_string *str = zend_print_zval_r_to_str(expr, indent);
+	/* If an exception was triggered while printing the zval */
+	if (UNEXPECTED(str == NULL)) {
+		return;
+	}
 	zend_write(ZSTR_VAL(str), ZSTR_LEN(str));
 	zend_string_release_ex(str, 0);
 }
diff --git a/Zend/zend_object_handlers.c b/Zend/zend_object_handlers.c
@@ -229,9 +229,9 @@ ZEND_API HashTable *zend_std_get_debug_info(zend_object *object, int *is_temp) /
 		return ht;
 	}
 
-	zend_error_noreturn(E_ERROR, ZEND_DEBUGINFO_FUNC_NAME "() must return an array");
-
-	return NULL; /* Compilers are dumb and don't understand that noreturn means that the function does NOT need a return value... */
+	zval_ptr_dtor(&retval);
+	zend_type_error(ZEND_DEBUGINFO_FUNC_NAME "() must return an array");
+	return NULL;
 }
 /* }}} */
 
diff --git a/ext/ffi/ffi.c b/ext/ffi/ffi.c
diff --git a/ext/standard/basic_functions.c b/ext/standard/basic_functions.c
diff --git a/ext/standard/info.c b/ext/standard/info.c
diff --git a/ext/standard/var.c b/ext/standard/var.c
