Use unused type bit for flagging iterable

Author: Girgias

Zend/zend_compile.c

@@ -6174,8 +6174,8 @@ static zend_type zend_compile_single_typename(zend_ast *ast)
 				zend_type iterable = (zend_type) ZEND_TYPE_INIT_CLASS(ZSTR_KNOWN(ZEND_STR_TRAVERSABLE), 0, 0);
 				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_NAME_BIT;
 				ZEND_TYPE_FULL_MASK(iterable) |= MAY_BE_ARRAY;
-				/* Set MAY_BE_ITERABLE for BC compat during Reflection */
-				ZEND_TYPE_FULL_MASK(iterable) |= MAY_BE_ITERABLE;
+				/* Set iterable bit for BC compat during Reflection */
+				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_ITERABLE_BIT;
 				/* Inform that the type list is a union type */
 				ZEND_TYPE_FULL_MASK(iterable) |= _ZEND_TYPE_UNION_BIT;
 				return iterable;

Zend/zend_inheritance.c

@@ -539,8 +539,7 @@ static inheritance_status zend_perform_covariant_type_check(
 	/* Builtin types may be removed, but not added */
 	uint32_t fe_type_mask = ZEND_TYPE_PURE_MASK(fe_type);
 	uint32_t proto_type_mask = ZEND_TYPE_PURE_MASK(proto_type);
-	/* MAY_BE_ITERABLE is only used for BC with Reflection so remove it */
-	uint32_t added_types = fe_type_mask & ~proto_type_mask & ~MAY_BE_ITERABLE;
+	uint32_t added_types = fe_type_mask & ~proto_type_mask;
 	if (added_types) {
 		if ((added_types & MAY_BE_STATIC)
 				&& zend_type_permits_self(proto_type, proto_scope, fe_scope)) {

Zend/zend_type_info.h

@@ -38,8 +38,6 @@
 /* These are used in zend_type, but not for type inference.
  * They are allowed to overlap with types used during inference. */
 #define MAY_BE_CALLABLE             (1 << IS_CALLABLE)
-/* Kept as BC for reflection */
-#define MAY_BE_ITERABLE             (1 << IS_ITERABLE)
 #define MAY_BE_VOID                 (1 << IS_VOID)
 #define MAY_BE_NEVER                (1 << IS_NEVER)
 #define MAY_BE_STATIC               (1 << IS_STATIC)

Zend/zend_types.h

@@ -144,7 +144,7 @@ typedef struct {
 #define _ZEND_TYPE_NAME_BIT (1u << 24)
 #define _ZEND_TYPE_LIST_BIT (1u << 22)
 #define _ZEND_TYPE_KIND_MASK (_ZEND_TYPE_LIST_BIT|_ZEND_TYPE_NAME_BIT)
-/* TODO: bit 21 is not used */
+#define _ZEND_TYPE_ITERABLE_BIT (1u << 21)
 /* Whether the type list is arena allocated */
 #define _ZEND_TYPE_ARENA_BIT (1u << 20)
 /* Whether the type list is an intersection type */
@@ -170,6 +170,9 @@ typedef struct {
 #define ZEND_TYPE_HAS_LIST(t) \
 	((((t).type_mask) & _ZEND_TYPE_LIST_BIT) != 0)
 
+#define ZEND_TYPE_IS_ITERABLE_FALLBACK(t) \
+	((((t).type_mask) & _ZEND_TYPE_ITERABLE_BIT) != 0)
+
 #define ZEND_TYPE_IS_INTERSECTION(t) \
 	((((t).type_mask) & _ZEND_TYPE_INTERSECTION_BIT) != 0)
 

ext/reflection/php_reflection.c

@@ -1330,7 +1330,7 @@ static reflection_type_kind get_type_kind(zend_type type) {
 
 	if (ZEND_TYPE_IS_COMPLEX(type)) {
 		/* BC support for 'iterable' type */
-		if (type_mask_without_null == (MAY_BE_ARRAY|MAY_BE_ITERABLE)) {
+		if (UNEXPECTED(ZEND_TYPE_IS_ITERABLE_FALLBACK(type))) {
 			return NAMED_TYPE;
 		}
 		if (type_mask_without_null != 0) {
@@ -1361,10 +1361,6 @@ static void reflection_type_factory(zend_type type, zval *object, bool legacy_be
 			reflection_instantiate(reflection_intersection_type_ptr, object);
 			break;
 		case UNION_TYPE:
-			/* Clear fake iterable type */
-			if ((ZEND_TYPE_PURE_MASK(type) & MAY_BE_ITERABLE) != 0) {
-				ZEND_TYPE_FULL_MASK(type) &= ~MAY_BE_ITERABLE;
-			}
 			reflection_instantiate(reflection_union_type_ptr, object);
 			break;
 		case NAMED_TYPE:
@@ -2705,6 +2701,11 @@ ZEND_METHOD(ReflectionParameter, isArray)
 	}
 	GET_REFLECTION_OBJECT_PTR(param);
 
+	/* BC For iterable */
+	if (ZEND_TYPE_IS_ITERABLE_FALLBACK(param->arg_info->type)) {
+		RETURN_FALSE;
+	}
+
 	type_mask = ZEND_TYPE_PURE_MASK_WITHOUT_NULL(param->arg_info->type);
 	RETVAL_BOOL(type_mask == MAY_BE_ARRAY);
 }
@@ -2987,7 +2988,7 @@ ZEND_METHOD(ReflectionType, allowsNull)
 
 /* BC for iterable */
 static zend_string *zend_type_to_string_ex(zend_type type) {
-	if (UNEXPECTED((ZEND_TYPE_PURE_MASK(type) & MAY_BE_ITERABLE) != 0)) {
+	if (UNEXPECTED(ZEND_TYPE_IS_ITERABLE_FALLBACK(type))) {
 		return ZSTR_KNOWN(ZEND_STR_ITERABLE);
 	}
 	return zend_type_to_string(type);
@@ -3090,9 +3091,6 @@ ZEND_METHOD(ReflectionUnionType, getTypes)
 	if (type_mask & MAY_BE_CALLABLE) {
 		append_type_mask(return_value, MAY_BE_CALLABLE);
 	}
-	if (type_mask & MAY_BE_ITERABLE) {
-		append_type_mask(return_value, MAY_BE_ITERABLE);
-	}
 	if (type_mask & MAY_BE_OBJECT) {
 		append_type_mask(return_value, MAY_BE_OBJECT);
 	}

ext/reflection/tests/union_types.phpt

@@ -69,8 +69,8 @@ Allows null: false
   Name: X
   String: X
   Allows Null: false
-  Name: Traversable
-  String: Traversable
+  Name: iterable
+  String: iterable
   Allows Null: false
   Name: array
   String: array