Property hooks

.gitattributes

@@ -22,7 +22,7 @@
 # Collapse generated files within a pull request.
 **/*_arginfo.h linguist-generated
 /Zend/zend_vm_execute.h linguist-generated
-/Zend/zend_vm_opcodes.{h,c} linguist-generated
+/Zend/zend_vm_opcodes.[ch] linguist-generated
 
 # The OSS fuzz files are bunary
 /ext/date/tests/ossfuzz*.txt binary

NEWS

@@ -44,6 +44,9 @@ PHP                                                                        NEWS
 - Date:
   . Implement More Appropriate Date/Time Exceptions RFC. (Derick)
 
+- DOM:
+  . Fix bug GH-11308 (getElementsByTagName() is O(N^2)). (nielsdos)
+
 - Exif:
   . Removed unneeded codepaths in exif_process_TIFF_in_JPEG(). (nielsdos)
 

UPGRADING.INTERNALS

@@ -116,6 +116,29 @@ PHP 8.3 INTERNALS UPGRADE NOTES
    - The PHPAPI spl_iterator_apply() function now returns zend_result instead of int.
      There are no functional changes.
 
+ f. ext/dom
+   - A new function dom_get_doc_props_read_only() is added to gather the document
+     properties in a read-only way. This function avoids allocation when there are
+     no document properties changed yet.
+   - The node list returned by DOMNode::getElementsByTagName() and
+	 DOMNode::getElementsByTagNameNS() now caches the length and the last requested item.
+	 This means that the length and the last requested item are not recalculated
+	 when the node list is iterated over multiple times.
+	 If you do not use the internal PHP dom APIs to modify the document, you need to
+	 manually invalidate the cache using php_libxml_invalidate_node_list_cache_from_doc().
+	 Furthermore, the following internal APIs were added to handle the cache:
+	   . php_dom_is_cache_tag_stale_from_doc_ptr()
+	   . php_dom_is_cache_tag_stale_from_node()
+	   . php_dom_mark_cache_tag_up_to_date_from_node()
+   - The function dom_get_elements_by_tag_name_ns_raw() has an additional parameter to indicate
+     the base node of the node list. This function also no longer accepts -1 as the index argument.
+   - The function dom_namednode_iter() has additional arguments to avoid recomputing the length of
+     the strings.
+
+ g. ext/libxml
+   - Two new functions: php_libxml_invalidate_node_list_cache_from_doc() and
+     php_libxml_invalidate_node_list_cache() were added to invalidate the cache of a node list.
+
 ========================
 4. OpCode changes
 ========================

Zend/Optimizer/compact_literals.c

@@ -197,6 +197,9 @@ void zend_optimizer_compact_literals(zend_op_array *op_array, zend_optimizer_ctx
 						LITERAL_INFO(opline->op2.constant, 2);
 					}
 					break;
+				case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
+					LITERAL_INFO(opline->op1.constant, 1);
+					break;
 				case ZEND_CATCH:
 					LITERAL_INFO(opline->op1.constant, 2);
 					break;

Zend/Optimizer/optimize_func_calls.c

@@ -47,6 +47,7 @@ static void zend_delete_call_instructions(zend_op_array *op_array, zend_op *opli
 			case ZEND_INIT_STATIC_METHOD_CALL:
 			case ZEND_INIT_METHOD_CALL:
 			case ZEND_INIT_FCALL:
+			case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
 				if (call == 0) {
 					MAKE_NOP(opline);
 					return;
@@ -95,6 +96,11 @@ static void zend_try_inline_call(zend_op_array *op_array, zend_op *fcall, zend_o
 				return;
 			}
 
+			if (fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL) {
+				/* Don't inline property hook method */
+				return;
+			}
+
 			for (i = 0; i < num_args; i++) {
 				/* Don't inline functions with by-reference arguments. This would require
 				 * correct handling of INDIRECT arguments. */
@@ -168,6 +174,7 @@ void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
 			case ZEND_INIT_METHOD_CALL:
 			case ZEND_INIT_FCALL:
 			case ZEND_NEW:
+			case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
 				/* The argument passing optimizations are valid for prototypes as well,
 				 * as inheritance cannot change between ref <-> non-ref arguments. */
 				call_stack[call].func = zend_optimizer_get_called_func(
@@ -211,6 +218,7 @@ void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
 						}
 					} else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
 							|| fcall->opcode == ZEND_INIT_METHOD_CALL
+							|| fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
 							|| fcall->opcode == ZEND_NEW) {
 						/* We don't have specialized opcodes for this, do nothing */
 					} else {

Zend/Optimizer/zend_call_graph.c

@@ -61,6 +61,7 @@ ZEND_API void zend_analyze_calls(zend_arena **arena, zend_script *script, uint32
 			case ZEND_INIT_FCALL:
 			case ZEND_INIT_METHOD_CALL:
 			case ZEND_INIT_STATIC_METHOD_CALL:
+			case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
 				call_stack[call] = call_info;
 				func = zend_optimizer_get_called_func(
 					script, op_array, opline, &is_prototype);

Zend/Optimizer/zend_dump.c

@@ -23,6 +23,7 @@
 #include "zend_func_info.h"
 #include "zend_call_graph.h"
 #include "zend_dump.h"
+#include "ext/standard/php_string.h"
 
 void zend_dump_ht(HashTable *ht)
 {
@@ -65,8 +66,12 @@ void zend_dump_const(const zval *zv)
 		case IS_DOUBLE:
 			fprintf(stderr, " float(%g)", Z_DVAL_P(zv));
 			break;
-		case IS_STRING:
-			fprintf(stderr, " string(\"%s\")", Z_STRVAL_P(zv));
+		case IS_STRING:;
+			zend_string *escaped_string = php_addcslashes(Z_STR_P(zv), "\"\\", 2);
+
+			fprintf(stderr, " string(\"%s\")", ZSTR_VAL(escaped_string));
+
+			zend_string_release(escaped_string);
 			break;
 		case IS_ARRAY:
 			fprintf(stderr, " array(...)");

Zend/Optimizer/zend_optimizer.c

@@ -910,6 +910,27 @@ zend_function *zend_optimizer_get_called_func(
 				}
 			}
 			break;
+		case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:;
+			zend_class_entry *scope = op_array->scope;
+			ZEND_ASSERT(scope != NULL);
+			if (scope && (scope->ce_flags & ZEND_ACC_LINKED) && scope->parent) {
+				zend_class_entry *parent_scope = scope->parent;
+				zend_string *prop_name = Z_STR_P(CRT_CONSTANT(opline->op1));
+				zend_property_hook_kind hook_kind = opline->op2.num;
+				zend_property_info *prop_info = zend_get_property_info(parent_scope, prop_name, /* silent */ true);
+
+				if (prop_info
+					&& prop_info != ZEND_WRONG_PROPERTY_INFO
+					&& !(prop_info->flags & ZEND_ACC_PRIVATE)
+					&& prop_info->hooks) {
+					zend_function *fbc = prop_info->hooks[hook_kind];
+					if (fbc) {
+						*is_prototype = true;
+						return fbc;
+					}
+				}
+			}
+			break;
 		case ZEND_NEW:
 		{
 			zend_class_entry *ce = zend_optimizer_get_class_entry_from_op1(
@@ -1425,6 +1446,7 @@ void zend_foreach_op_array(zend_script *script, zend_op_array_func_t func, void
 {
 	zval *zv;
 	zend_op_array *op_array;
+	zend_property_info *property;
 
 	zend_foreach_op_array_helper(&script->main_op_array, func, context);
 
@@ -1445,6 +1467,17 @@ void zend_foreach_op_array(zend_script *script, zend_op_array_func_t func, void
 				zend_foreach_op_array_helper(op_array, func, context);
 			}
 		} ZEND_HASH_FOREACH_END();
+		ZEND_HASH_MAP_FOREACH_PTR(&ce->properties_info, property) {
+			zend_function **hooks = property->hooks;
+			if (hooks) {
+				for (uint32_t i = 0; i < ZEND_PROPERTY_HOOK_COUNT; i++) {
+					zend_function *hook = hooks[i];
+					if (hook && hook->common.scope == ce) {
+						zend_foreach_op_array_helper(&hooks[i]->op_array, func, context);
+					}
+				}
+			}
+		} ZEND_HASH_FOREACH_END();
 	} ZEND_HASH_FOREACH_END();
 }
 

Zend/tests/accessors/final.phpt

@@ -0,0 +1,20 @@
+--TEST--
+Final accessors
+--FILE--
+<?php
+
+class A {
+    public $prop {
+        final get { return 42; }
+    }
+}
+
+class B extends A {
+    public $prop {
+        get { return 24; }
+    }
+}
+
+?>
+--EXPECTF--
+Fatal error: Cannot override final accessor A::$prop::get() in %s on line %d

Zend/tests/alternative_offset_syntax_compile_error_in_const_expr.phpt

@@ -6,4 +6,4 @@ const FOO_COMPILE_ERROR = "BAR"{0};
 var_dump(FOO_COMPILE_ERROR);
 ?>
 --EXPECTF--
-Fatal error: Array and string offset access syntax with curly braces is no longer supported in %s on line 2
+Parse error: syntax error, unexpected token "{", expecting "," or ";" in %s on line %d

Zend/tests/alternative_offset_syntax_compile_error_outside_const_expr.phpt

@@ -6,4 +6,4 @@ $foo = 'BAR';
 var_dump($foo{0});
 ?>
 --EXPECTF--
-Fatal error: Array and string offset access syntax with curly braces is no longer supported in %s on line 3
+Parse error: syntax error, unexpected token "{", expecting ")" in %s on line %d

Zend/tests/alternative_offset_syntax_in_encaps_string.phpt

@@ -3,4 +3,4 @@ Alternative offset syntax should emit only E_COMPILE_ERROR in string interpolati
 --FILE--
 <?php "{$g{'h'}}"; ?>
 --EXPECTF--
-Fatal error: Array and string offset access syntax with curly braces is no longer supported in %s on line 1
+Parse error: syntax error, unexpected token "{", expecting "->" or "?->" or "[" in %s on line %d

Zend/tests/errmsg_037.phpt

@@ -10,4 +10,4 @@ class test {
 echo "Done\n";
 ?>
 --EXPECTF--
-Fatal error: Cannot use the abstract modifier on a property in %s on line %d
+Fatal error: Only hooked properties may be declared abstract in %s on line %d

Zend/tests/gh11320_1.phpt

@@ -0,0 +1,28 @@
+--TEST--
+GH-11320: Array literals can contain list() assignments
+--FILE--
+<?php
+$index = 1;
+function getList() { return [2, 3]; }
+var_dump([$index => list($x, $y) = getList()]);
+var_dump([$index => [$x, $y] = getList()]);
+?>
+--EXPECT--
+array(1) {
+  [1]=>
+  array(2) {
+    [0]=>
+    int(2)
+    [1]=>
+    int(3)
+  }
+}
+array(1) {
+  [1]=>
+  array(2) {
+    [0]=>
+    int(2)
+    [1]=>
+    int(3)
+  }
+}

Zend/tests/gh11320_2.phpt

@@ -0,0 +1,12 @@
+--TEST--
+GH-11320: list() expressions can contain magic constants
+--FILE--
+<?php
+[list(__FILE__ => $foo) = [__FILE__ => 'foo']];
+var_dump($foo);
+[[__FILE__ => $foo] = [__FILE__ => 'foo']];
+var_dump($foo);
+?>
+--EXPECT--
+string(3) "foo"
+string(3) "foo"

Zend/tests/gh11320_3.phpt

@@ -0,0 +1,8 @@
+--TEST--
+GH-11320: list() must not appear as a standalone array element
+--FILE--
+<?php
+[list($a)];
+?>
+--EXPECTF--
+Fatal error: Cannot use list() as standalone expression in %s on line %d

Zend/tests/property_hooks/abstract_hook.phpt

@@ -0,0 +1,22 @@
+--TEST--
+Abstract hooks compile successfully
+--FILE--
+<?php
+
+abstract class A {
+    public $prop {
+        abstract get;
+        set {}
+    }
+}
+
+class B extends A {
+    public $prop {
+        get {}
+    }
+}
+
+?>
+===DONE===
+--EXPECT--
+===DONE===

Zend/tests/property_hooks/abstract_hook_in_non_abstract_class.phpt

@@ -0,0 +1,15 @@
+--TEST--
+Abstract hooks in non-abstract class gives an error
+--FILE--
+<?php
+
+class Test {
+    public $prop {
+        abstract get;
+        set {}
+    }
+}
+
+?>
+--EXPECTF--
+Fatal error: Class Test contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Test::$prop::get) in %s on line %d

Zend/tests/property_hooks/abstract_hook_not_implemented.phpt

@@ -0,0 +1,17 @@
+--TEST--
+Abstract hooks that are not implemented throw an error
+--FILE--
+<?php
+
+abstract class A {
+    public $prop {
+        abstract get;
+        set {}
+    }
+}
+
+class B extends A {}
+
+?>
+--EXPECTF--
+Fatal error: Class B contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (A::$prop::get) in %s on line %d

Zend/tests/property_hooks/abstract_prop_abstract_hook.phpt

@@ -0,0 +1,12 @@
+--TEST--
+Abstract property with abstract hook is redundant so invalid
+--FILE--
+<?php
+
+class C {
+    abstract public $prop { abstract get; }
+}
+
+?>
+--EXPECTF--
+Fatal error: Property hook on abstract property cannot be explicitly abstract in %s on line %d

Zend/tests/property_hooks/abstract_prop_hooks.phpt

@@ -0,0 +1,17 @@
+--TEST--
+Explicit hooked property satisfies abstract property
+--FILE--
+<?php
+
+abstract class A {
+    abstract public $prop { get; set; }
+}
+
+class B extends A {
+    public $prop { get {} set {} }
+}
+
+?>
+===DONE===
+--EXPECT--
+===DONE===

Zend/tests/property_hooks/abstract_prop_not_implemented.phpt

@@ -0,0 +1,14 @@
+--TEST--
+Abstract property not implemented throws an error
+--FILE--
+<?php
+
+class A {
+    abstract public $prop { get; set; }
+}
+
+class B extends A {}
+
+?>
+--EXPECTF--
+Fatal error: Class A contains 2 abstract methods and must therefore be declared abstract or implement the remaining methods (A::$prop::get, A::$prop::set) in %s on line %d