streams: Re-add support for arbitrary metadata for stream notifier functions

TimWolla · TimWolla · commit 8f91f185563d · 2025-07-17T15:28:51.000+02:00
Support for attaching arbitrary metadata for consumption by stream notifier functions got broken in #19024 when the previous `zval ptr` got changed to `zend_fcall_info_cache *fcc`, making the data specific to the `user_space_stream_notifier`. Fix this by changing the field to `void *ptr`, avoiding the indirection through a `zval`, but preserving the ability to store arbitrary data. If necessary to support different types than `IS_PTR`, extensions can heap-allocate a `zval` to store within `->ptr` as a minimal change to keep compatibility with PHP 8.4 or lower.
diff --git a/NEWS b/NEWS
@@ -6,6 +6,9 @@ PHP                                                                        NEWS
   . socket_set_option for multicast context throws a ValueError
     when the socket family is not of AF_INET/AF_INET6 family. (David Carlier)
 
+- Standard:
+  . Fix support for non-userland stream notifiers. (timwolla)
+
 - URI:
   . Empty host handling is fixed. (Máté Kocsis)
   . Error handling of Uri\WhatWg\Url::withHost() is fixed when the input
diff --git a/UPGRADING.INTERNALS b/UPGRADING.INTERNALS
@@ -129,6 +129,11 @@ PHP 8.5 INTERNALS UPGRADE NOTES
   . The php_std_date() function has been removed. Use php_format_date() with
     the "D, d M Y H:i:s \\G\\M\\T" format instead.
   . Added php_url_encode_to_smart_str() to encode a URL to a smart_str buffer.
+  . The ptr field of the php_stream_notifier struct is now a void* instead
+    of a zval. If the zval was used to store IS_PTR values only, the
+    extra layer of indirection can be removed. In other cases a zval can
+    be heap-allocated and stored in the pointer as a minimal change to keep
+    compatibility.
 
 ========================
 4. OpCode changes
diff --git a/ext/standard/streamsfuncs.c b/ext/standard/streamsfuncs.c
@@ -869,19 +869,17 @@ static void user_space_stream_notifier(php_stream_context *context, int notifyco
 	ZVAL_LONG(&zvs[4], bytes_sofar);
 	ZVAL_LONG(&zvs[5], bytes_max);
 
-	zend_call_known_fcc(context->notifier->fcc, NULL, 6, zvs, NULL);
+	zend_call_known_fcc(context->notifier->ptr, NULL, 6, zvs, NULL);
 	/* Free refcounted string parameter */
 	zval_ptr_dtor_str(&zvs[2]);
 }
 
 static void user_space_stream_notifier_dtor(php_stream_notifier *notifier)
 {
-	ZEND_ASSERT(notifier);
-	ZEND_ASSERT(notifier->fcc);
-	ZEND_ASSERT(notifier->fcc->function_handler);
-	zend_fcc_dtor(notifier->fcc);
-	efree(notifier->fcc);
-	notifier->fcc = NULL;
+	zend_fcall_info_cache *fcc = notifier->ptr;
+	zend_fcc_dtor(fcc);
+	efree(notifier->ptr);
+	notifier->ptr = NULL;
 }
 
 static zend_result parse_context_options(php_stream_context *context, HashTable *options)
@@ -931,7 +929,7 @@ static zend_result parse_context_params(php_stream_context *context, HashTable *
 
 		context->notifier = php_stream_notification_alloc();
 		context->notifier->func = user_space_stream_notifier;
-		context->notifier->fcc = fcc;
+		context->notifier->ptr = fcc;
 		context->notifier->dtor = user_space_stream_notifier_dtor;
 	}
 	if (NULL != (tmp = zend_hash_str_find(params, "options", sizeof("options")-1))) {
@@ -1128,10 +1126,10 @@ PHP_FUNCTION(stream_context_get_params)
 	}
 
 	array_init(return_value);
-	if (context->notifier && context->notifier->fcc) {
-		ZEND_ASSERT(context->notifier->func == user_space_stream_notifier);
+	if (context->notifier && context->notifier->func == user_space_stream_notifier) {
+		zend_fcall_info_cache *fcc = context->notifier->ptr;
 		zval fn;
-		zend_get_callable_zval_from_fcc(context->notifier->fcc, &fn);
+		zend_get_callable_zval_from_fcc(fcc, &fn);
 		add_assoc_zval_ex(return_value, ZEND_STRL("notification"), &fn);
 	}
 	Z_TRY_ADDREF(context->options);
diff --git a/main/streams/php_stream_context.h b/main/streams/php_stream_context.h
@@ -44,7 +44,7 @@ typedef struct _php_stream_notifier php_stream_notifier;
 struct _php_stream_notifier {
 	php_stream_notification_func func;
 	void (*dtor)(php_stream_notifier *notifier);
-	zend_fcall_info_cache *fcc;
+	void *ptr;
 	int mask;
 	size_t progress, progress_max; /* position for progress notification */
 };
