poll: use PollBackend enum for backends

Author: bukka

ext/standard/poll.c

@@ -15,12 +15,14 @@
 */
 
 #include "php.h"
+#include "zend_enum.h"
+#include "zend_exceptions.h"
 #include "php_network.h"
 #include "php_poll.h"
 #include "poll_arginfo.h"
-#include "zend_exceptions.h"
 
 /* Class entries */
+static zend_class_entry *php_poll_backend_class_entry;
 static zend_class_entry *php_poll_context_class_entry;
 static zend_class_entry *php_poll_watcher_class_entry;
 static zend_class_entry *php_poll_handle_class_entry;
@@ -453,19 +455,19 @@ PHP_METHOD(PollWatcher, remove)
 
 PHP_METHOD(PollContext, __construct)
 {
-	zend_long backend_long = PHP_POLL_BACKEND_AUTO;
-	zend_string *backend_str = NULL;
+	zval *backend_obj;
 
 	ZEND_PARSE_PARAMETERS_START(0, 1)
 		Z_PARAM_OPTIONAL
-		Z_PARAM_STR_OR_LONG(backend_str, backend_long)
+		Z_PARAM_OBJECT_OF_CLASS(backend_obj, php_poll_backend_class_entry)
 	ZEND_PARSE_PARAMETERS_END();
 
 	php_poll_context_object *intern = PHP_POLL_CONTEXT_OBJ_FROM_ZV(getThis());
 
-	if (backend_str == NULL) {
-		intern->ctx = php_poll_create((php_poll_backend_type) backend_long, 0);
+	if (backend_obj == NULL) {
+		intern->ctx = php_poll_create(PHP_POLL_BACKEND_AUTO, 0);
 	} else {
+		const zend_string *backend_str = Z_STR_P(zend_enum_fetch_case_value(Z_OBJ_P(backend_obj)));
 		intern->ctx = php_poll_create_by_name(ZSTR_VAL(backend_str), 0);
 	}
 
@@ -599,13 +601,29 @@ PHP_METHOD(PollContext, wait)
 	efree(events);
 }
 
-PHP_METHOD(PollContext, getBackendName)
+PHP_METHOD(PollContext, getBackend)
 {
 	ZEND_PARSE_PARAMETERS_NONE();
 
 	php_poll_context_object *intern = PHP_POLL_CONTEXT_OBJ_FROM_ZV(getThis());
 	const char *backend_name = php_poll_backend_name(intern->ctx);
-	RETURN_STRING(backend_name);
+	const char *entryname = NULL;
+
+	if (!strcmp(backend_name, "epoll")) {
+		entryname = "Epoll";
+	} else if (!strcmp(backend_name, "kqueu")) {
+		entryname = "Kqueue";
+	} else if (!strcmp(backend_name, "wsapoll")) {
+		entryname = "WSAPoll";
+	} else if (!strcmp(backend_name, "eventport")) {
+		entryname = "EventPorts";
+	} else if (!strcmp(backend_name, "poll")) {
+		entryname = "Poll";
+	} else {
+		entryname = "Auto"; /* This should never happen */
+	}
+
+	RETURN_OBJ_COPY(zend_enum_get_case_cstr(php_poll_backend_class_entry, entryname));
 }
 
 /* Initialize the stream poll classes - add to PHP_MINIT_FUNCTION */
@@ -614,6 +632,9 @@ PHP_MINIT_FUNCTION(poll)
 	/* Register symbols */
 	register_poll_symbols(module_number);
 
+	/* Register backend */
+	php_poll_backend_class_entry = register_class_PollBackend();
+
 	/* Register base PollHandle class */
 	php_poll_handle_class_entry = register_class_PollHandle();
 	php_poll_handle_class_entry->create_object = php_poll_handle_create_object;

ext/standard/poll.stub.php

@@ -38,37 +38,15 @@
  */
 const POLL_EVENT_ET = UNKNOWN;
 
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_AUTO
- */
-const POLL_BACKEND_AUTO = UNKNOWN;
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_POLL
- */
-const POLL_BACKEND_POLL = UNKNOWN;
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_EPOLL
- */
-const POLL_BACKEND_EPOLL = UNKNOWN;
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_KQUEUE
- */
-const POLL_BACKEND_KQUEUE = UNKNOWN;
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_EVENTPORT
- */
-const POLL_BACKEND_EVENTPORT = UNKNOWN;
-/**
- * @var int
- * @cvalue PHP_POLL_BACKEND_WSAPOLL
- */
-const POLL_BACKEND_WSAPOLL = UNKNOWN;
-
+enum PollBackend : string
+{
+    case Auto = "auto";
+    case Poll = "poll";
+    case Epoll = "epoll";
+    case Kqueue = "kqueue";
+    case EventPorts = "eventport";
+    case WSAPoll = "wsapoll";
+}
 
 abstract class PollHandle
 {
@@ -113,13 +91,13 @@ public function remove(): void {}
 
 final class PollContext
 {
-    public function __construct(int|string $backend = POLL_BACKEND_AUTO) {}
+    public function __construct(PollBackend $backend = PollBackend::Auto) {}
 
     public function add(PollHandle $handle, int $events, mixed $data = null): PollWatcher {}
 
     public function wait(int $timeout = -1, int $maxEvents = -1): array {}
 
-    public function getBackendName(): string {}
+    public function getBackend(): PollBackend {}
 }
 
 class PollException extends Exception

ext/standard/poll_arginfo.h

@@ -3,7 +3,7 @@
 
 function pt_new_stream_poll(): PollContext {
     $backend = getenv('POLL_TEST_BACKEND');
-    return new PollContext($backend === false ? POLL_BACKEND_AUTO : $backend);
+    return new PollContext($backend === false ? PollBackend::Auto : PollBackend::from($backend));
 }
 
 function pt_stream_poll_add($poll_ctx, $stream, $events, $data = null): PollWatcher {
@@ -12,9 +12,9 @@ function pt_stream_poll_add($poll_ctx, $stream, $events, $data = null): PollWatc
 
 function pt_skip_for_backend($backend, $msg): void {
     $backends_to_skip = is_array($backend) ? $backend : array($backend);
-    $current_backend = pt_new_stream_poll()->getBackendName();
-    if (in_array($current_backend, $backends_to_skip)) {
-        die("skip backend $current_backend $msg\n");
+    $current_backend = pt_new_stream_poll()->getBackend();
+    if (in_array($current_backend->value, $backends_to_skip)) {
+        die("skip backend $current_backend->value $msg\n");
     }
 }
 
@@ -119,12 +119,12 @@ function pt_expect_events($watchers, $expected, ?PollContext $poll_ctx = null):
     $event_count = count($watchers);
     $expected_count = count($expected);
 
-    // Get current backend name for backend-specific expectations
-    $backend_name = $poll_ctx ? $poll_ctx->getBackendName() : 'unknown';
+    // Get the current backend for backend-specific expectations
+    $backend = $poll_ctx ? $poll_ctx->getBackend() : 'unknown';
 
     if ($event_count !== $expected_count) {
         echo "Event count mismatch: got $event_count, expected $expected_count\n";
-        pt_print_mismatched_events($watchers, $expected, [], $backend_name);
+        pt_print_mismatched_events($watchers, $expected, [], $backend->value);
         return;
     }
 
@@ -149,7 +149,7 @@ function pt_expect_events($watchers, $expected, ?PollContext $poll_ctx = null):
         $resolved_event = $exp_event;
 
         if (isset($exp_event['events']) && is_array($exp_event['events'])) {
-            $resolved_event['events'] = pt_resolve_backend_specific_value($exp_event['events'], $backend_name);
+            $resolved_event['events'] = pt_resolve_backend_specific_value($exp_event['events'], $backend->value);
         }
 
         $resolved_expected[] = $resolved_event;
@@ -195,7 +195,7 @@ function pt_expect_events($watchers, $expected, ?PollContext $poll_ctx = null):
         echo "Events matched - count: $event_count\n";
     } else {
         echo "Events did not match:\n";
-        pt_print_mismatched_events($watchers, $expected, $matched, $backend_name);
+        pt_print_mismatched_events($watchers, $expected, $matched, $backend->value);
     }
 }
 

ext/standard/tests/poll/poll.inc

@@ -11,16 +11,15 @@ if (substr(PHP_OS, 0, 3) == 'WIN') {
 require_once __DIR__ . '/poll.inc';
 // this just prints default poll ctx
 $poll_ctx = new PollContext();
-var_dump($poll_ctx->getBackendName());
-// poll is always available on Unix systems
-$poll_ctx = new PollContext(POLL_BACKEND_POLL);
-var_dump($poll_ctx->getBackendName());
-// test with string
-$poll_ctx = new PollContext('poll');
-var_dump($poll_ctx->getBackendName());
+var_dump($poll_ctx->getBackend());
+// test with poll that is always available on Unix systems
+$poll_ctx = new PollContext(PollBackend::Poll);
+$backend = $poll_ctx->getBackend();
+var_dump($backend->name);
+var_dump($backend->value);
 
 ?>
 --EXPECTF--
-string(%d) %s
-string(4) "poll"
+enum(PollBackend::%s)
+string(4) "Poll"
 string(4) "poll"

ext/standard/tests/poll/poll_stream_backend_name_unix.phpt

@@ -9,14 +9,16 @@ if (substr(PHP_OS, 0, 3) != 'WIN') {
 --FILE--
 <?php
 require_once __DIR__ . '/poll.inc';
-// wsapoll is always available on Windows
-$poll_ctx = new PollContext(POLL_BACKEND_WSAPOLL);
-var_dump($poll_ctx->getBackendName());
-// test with string
-$poll_ctx = new PollContext('wsapoll');
-var_dump($poll_ctx->getBackendName());
-
+// this just prints default poll ctx
+$poll_ctx = new PollContext();
+var_dump($poll_ctx->getBackend());
+// test with WSAPoll
+$poll_ctx = new PollContext(PollBackend::WSAPoll);
+$backend = $poll_ctx->getBackend();
+var_dump($backend->name);
+var_dump($backend->value);
 ?>
---EXPECT--
-string(7) "wsapoll"
+--EXPECTF--
+enum(PollBackend::%s)
+string(7) "WSAPoll"
 string(7) "wsapoll"

ext/standard/tests/poll/poll_stream_backend_name_windows.phpt

@@ -134,6 +134,10 @@ PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, ui
 /* Create new poll context */
 PHPAPI php_poll_ctx *php_poll_create_by_name(const char *preferred_backend, uint32_t flags)
 {
+	if (!strcmp(preferred_backend, "auto")) {
+		return php_poll_create(PHP_POLL_BACKEND_AUTO, flags);
+	}
+
 	php_poll_ctx *ctx = php_poll_create_context(flags);
 	if (ctx == NULL) {
 		return NULL;