poll: add raw events support to allow lower overhead on kqueue

Author: bukka

ext/standard/basic_functions.stub.php

@@ -3362,7 +3362,7 @@ function soundex(string $string): string {}
 
 /* streamsfuncs.c */
 
-function stream_poll_create(int|string $backend = STREAM_POLL_BACKEND_AUTO): StreamPollContext {}
+function stream_poll_create(int|string $backend = STREAM_POLL_BACKEND_AUTO, bool $raw_events = false): StreamPollContext {}
 
 /** @param resource $stream */
 function stream_poll_add(StreamPollContext $poll_ctx, $stream, int $events, mixed $data = null): void {}

ext/standard/basic_functions_arginfo.h

@@ -99,17 +99,20 @@ PHP_FUNCTION(stream_poll_create)
 {
 	zend_long backend_long = PHP_POLL_BACKEND_AUTO;
 	zend_string *backend_str = NULL;
+	bool raw_events = false;
 	php_poll_ctx *poll_ctx;
 
 	ZEND_PARSE_PARAMETERS_START(0, 1)
 	Z_PARAM_OPTIONAL
 	Z_PARAM_STR_OR_LONG(backend_str, backend_long)
+	Z_PARAM_BOOL(raw_events)
 	ZEND_PARSE_PARAMETERS_END();
 
+	uint32_t flags = raw_events ? PHP_POLL_FLAG_RAW_EVENTS : 0;
 	if (backend_str == NULL) {
-		poll_ctx = php_poll_create((php_poll_backend_type) backend_long, false);
+		poll_ctx = php_poll_create((php_poll_backend_type) backend_long, flags);
 	} else {
-		poll_ctx = php_poll_create_by_name(ZSTR_VAL(backend_str), false);
+		poll_ctx = php_poll_create_by_name(ZSTR_VAL(backend_str), flags);
 	}
 	if (!poll_ctx) {
 		zend_throw_exception(

ext/standard/stream_poll.c

@@ -28,6 +28,10 @@
 #define PHP_POLL_ONESHOT 0x20
 #define PHP_POLL_ET      0x40 /* Edge-triggered */
 
+/* Poll flags */
+#define PHP_POLL_FLAG_PERSISTENT 0x01
+#define PHP_POLL_FLAG_RAW_EVENTS 0x02
+
 /* Poll backend types */
 typedef enum {
 	PHP_POLL_BACKEND_AUTO = -1,
@@ -70,8 +74,8 @@ typedef struct php_poll_backend_ops php_poll_backend_ops;
 typedef struct php_poll_event php_poll_event;
 
 /* Public API */
-PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, bool persistent);
-PHPAPI php_poll_ctx *php_poll_create_by_name(const char *preferred_backend, bool persistent);
+PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, uint32_t flags);
+PHPAPI php_poll_ctx *php_poll_create_by_name(const char *preferred_backend, uint32_t flags);
 
 PHPAPI zend_result php_poll_set_max_events_hint(php_poll_ctx *ctx, int max_events);
 PHPAPI zend_result php_poll_init(php_poll_ctx *ctx);

main/php_poll.h

@@ -62,15 +62,15 @@ typedef struct php_poll_backend_ops {
 struct php_poll_ctx {
 	const php_poll_backend_ops *backend_ops;
 	php_poll_backend_type backend_type;
-
-	bool initialized;
-	bool persistent;
+	php_poll_error last_error;
 
 	/* Optional capacity hint for backends */
 	int max_events_hint;
 
-	/* Last error */
-	php_poll_error last_error;
+	/* Flags */
+	uint32_t initialized : 1;
+	uint32_t persistent : 1;
+	uint32_t raw_events : 1;
 
 	/* Backend-specific data */
 	void *backend_data;

main/poll/php_poll_internal.h

@@ -99,19 +99,31 @@ static const php_poll_backend_ops *php_poll_get_backend_ops_by_name(const char *
 	return NULL;
 }
 
-/* Create new poll context */
-PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, bool persistent)
+static php_poll_ctx *php_poll_create_context(uint32_t flags)
 {
+	bool persistent = flags & PHP_POLL_FLAG_PERSISTENT;
 	php_poll_ctx *ctx = php_poll_calloc(1, sizeof(php_poll_ctx), persistent);
 	if (!ctx) {
 		return NULL;
 	}
 	ctx->persistent = persistent;
+	ctx->raw_events = flags & PHP_POLL_FLAG_RAW_EVENTS;
+
+	return ctx;
+}
+
+/* Create new poll context */
+PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, uint32_t flags)
+{
+	php_poll_ctx *ctx = php_poll_create_context(flags);
+	if (ctx == NULL) {
+		return NULL;
+	}
 
 	/* Get backend operations */
 	ctx->backend_ops = php_poll_get_backend_ops(preferred_backend);
 	if (!ctx->backend_ops) {
-		pefree(ctx, persistent);
+		pefree(ctx, ctx->persistent);
 		return NULL;
 	}
 	ctx->backend_type = preferred_backend;
@@ -120,18 +132,17 @@ PHPAPI php_poll_ctx *php_poll_create(php_poll_backend_type preferred_backend, bo
 }
 
 /* Create new poll context */
-PHPAPI php_poll_ctx *php_poll_create_by_name(const char *preferred_backend, bool persistent)
+PHPAPI php_poll_ctx *php_poll_create_by_name(const char *preferred_backend, uint32_t flags)
 {
-	php_poll_ctx *ctx = php_poll_calloc(1, sizeof(php_poll_ctx), persistent);
-	if (!ctx) {
+	php_poll_ctx *ctx = php_poll_create_context(flags);
+	if (ctx == NULL) {
 		return NULL;
 	}
-	ctx->persistent = persistent;
 
 	/* Get backend operations */
 	ctx->backend_ops = php_poll_get_backend_ops_by_name(preferred_backend);
 	if (!ctx->backend_ops) {
-		pefree(ctx, persistent);
+		pefree(ctx, ctx->persistent);
 		return NULL;
 	}
 	ctx->backend_type = ctx->backend_ops->type;