Deprecate leading underscore for _zend_hash_find_known_hash

When should we actually remove it? PHP 9.0?

Author: morrisonlevi

Zend/zend_hash.c

@@ -2270,7 +2270,13 @@ ZEND_API zval* ZEND_FASTCALL zend_hash_find(const HashTable *ht, zend_string *ke
 	return p ? &p->val : NULL;
 }
 
-ZEND_API zval* ZEND_FASTCALL _zend_hash_find_known_hash(const HashTable *ht, zend_string *key)
+ZEND_API ZEND_ATTRIBUTE_DEPRECATED
+zval* ZEND_FASTCALL _zend_hash_find_known_hash(const HashTable *ht, zend_string *key)
+{
+	return zend_hash_find_known_hash(ht, key);
+}
+
+ZEND_API zval* ZEND_FASTCALL zend_hash_find_known_hash(const HashTable *ht, zend_string *key)
 {
 	Bucket *p;
 

Zend/zend_hash.h

@@ -177,13 +177,19 @@ ZEND_API zval* ZEND_FASTCALL zend_hash_str_find(const HashTable *ht, const char
 ZEND_API zval* ZEND_FASTCALL zend_hash_index_find(const HashTable *ht, zend_ulong h);
 ZEND_API zval* ZEND_FASTCALL _zend_hash_index_find(const HashTable *ht, zend_ulong h);
 
-/* The same as zend_hash_find(), but hash value of the key must be already calculated */
-ZEND_API zval* ZEND_FASTCALL _zend_hash_find_known_hash(const HashTable *ht, zend_string *key);
+/**
+ * The same as zend_hash_find(), but hash value of the key must be already calculated.
+ * Use zend_hash_find_known_hash() when targeting PHP 8.1+; old name kept for bc only.
+ */
+ZEND_API ZEND_ATTRIBUTE_DEPRECATED
+zval* ZEND_FASTCALL _zend_hash_find_known_hash(const HashTable *ht, zend_string *key);
+
+ZEND_API zval* ZEND_FASTCALL zend_hash_find_known_hash(const HashTable *ht, zend_string *key);
 
 static zend_always_inline zval *zend_hash_find_ex(const HashTable *ht, zend_string *key, bool known_hash)
 {
 	if (known_hash) {
-		return _zend_hash_find_known_hash(ht, key);
+		return zend_hash_find_known_hash(ht, key);
 	} else {
 		return zend_hash_find(ht, key);
 	}

ext/opcache/jit/zend_jit_arm64.dasc

@@ -5144,7 +5144,7 @@ static int zend_jit_fetch_dimension_address_inner(dasm_State **Dst, const zend_o
 					|	EXT_CALL zend_hash_find, REG0
 					|1:
 				} else {
-					|	EXT_CALL _zend_hash_find_known_hash, REG0
+					|	EXT_CALL zend_hash_find_known_hash, REG0
 				}
 				|	mov REG0, RETVALx
 				if (not_found_exit_addr) {
@@ -5168,7 +5168,7 @@ static int zend_jit_fetch_dimension_address_inner(dasm_State **Dst, const zend_o
 					|	EXT_CALL zend_hash_find, REG0
 					|1:
 				} else {
-					|	EXT_CALL _zend_hash_find_known_hash, REG0
+					|	EXT_CALL zend_hash_find_known_hash, REG0
 				}
 				|	mov REG0, RETVALx
 				if (JIT_G(trigger) == ZEND_JIT_ON_HOT_TRACE && type == BP_VAR_R) {
@@ -13901,7 +13901,7 @@ static int zend_jit_in_array(dasm_State **Dst, const zend_op *opline, uint32_t o
 	} else {
 		zend_string *str = Z_STR_P(RT_CONSTANT(opline, opline->op1));
 		|	LOAD_ADDR FCARG2x, str
-		|	EXT_CALL _zend_hash_find_known_hash, REG0
+		|	EXT_CALL zend_hash_find_known_hash, REG0
 	}
 	if (exit_addr) {
 		if (smart_branch_opcode == ZEND_JMPZ) {

ext/opcache/jit/zend_jit_x86.dasc

@@ -5617,7 +5617,7 @@ static int zend_jit_fetch_dimension_address_inner(dasm_State **Dst, const zend_o
 					|	EXT_CALL zend_hash_find, r0
 					|1:
 				} else {
-					|	EXT_CALL _zend_hash_find_known_hash, r0
+					|	EXT_CALL zend_hash_find_known_hash, r0
 				}
 				|	test r0, r0
 				if (not_found_exit_addr) {
@@ -5640,7 +5640,7 @@ static int zend_jit_fetch_dimension_address_inner(dasm_State **Dst, const zend_o
 					|	EXT_CALL zend_hash_find, r0
 					|1:
 				} else {
-					|	EXT_CALL _zend_hash_find_known_hash, r0
+					|	EXT_CALL zend_hash_find_known_hash, r0
 				}
 				|	test r0, r0
 				if (JIT_G(trigger) == ZEND_JIT_ON_HOT_TRACE && type == BP_VAR_R) {
@@ -14753,7 +14753,7 @@ static int zend_jit_in_array(dasm_State **Dst, const zend_op *opline, uint32_t o
 	} else {
 		zend_string *str = Z_STR_P(RT_CONSTANT(opline, opline->op1));
 		|	LOAD_ADDR FCARG2a, str
-		|	EXT_CALL _zend_hash_find_known_hash, r0
+		|	EXT_CALL zend_hash_find_known_hash, r0
 	}
 	|	test r0, r0
 	if (exit_addr) {