Implement pcntl_waitid

ext/pcntl/config.m4

@@ -24,8 +24,12 @@ if test "$PHP_PCNTL" != "no"; then
     unshare
     wait3
     wait4
+    waitid
   ]))
 
+  AC_CHECK_HEADER([linux/wait.h],
+    [AC_DEFINE([HAVE_LINUX_WAIT_H], [1], [linux/wait.h found])])
+
   dnl if unsupported, -1 means automatically ENOSYS in this context
   AC_CACHE_CHECK([if sched_getcpu is supported], [php_cv_func_sched_getcpu],
   [AC_RUN_IFELSE([AC_LANG_SOURCE([

ext/pcntl/pcntl.c

@@ -125,6 +125,24 @@ static zend_class_entry *QosClass_ce;
 
 #define LONG_CONST(c) (zend_long) c
 
+#ifdef HAVE_WAITID
+#if defined(HAVE_LINUX_WAIT_H)
+#include <linux/wait.h>
+#endif
+#if defined (P_ALL)
+#define HAVE_POSIX_IDTYPES 1
+#endif
+#if defined (P_PIDFD)
+#define HAVE_LINUX_IDTYPES 1
+#endif
+#if defined (P_UID)
+#define HAVE_NETBSD_IDTYPES 1
+#endif
+#if defined (P_JAILID)
+#define HAVE_FREEBSD_IDTYPES 1
+#endif
+#endif
+
 #include "Zend/zend_enum.h"
 #include "Zend/zend_max_execution_timer.h"
 
@@ -385,6 +403,45 @@ PHP_FUNCTION(pcntl_waitpid)
 }
 /* }}} */
 
+#ifdef HAVE_WAITID
+PHP_FUNCTION(pcntl_waitid)
+{
+	zend_long idtype = P_PID;
+	zend_long id = 0;
+	bool id_is_null = 1;
+	zval *user_siginfo = NULL;
+	zend_long options = WEXITED;
+
+	ZEND_PARSE_PARAMETERS_START(2, 4)
+		Z_PARAM_LONG(idtype)
+		Z_PARAM_LONG_OR_NULL(id, id_is_null)
+		Z_PARAM_OPTIONAL
+		Z_PARAM_ZVAL(user_siginfo)
+		Z_PARAM_LONG(options)
+	ZEND_PARSE_PARAMETERS_END();
+
+	errno = 0;
+	siginfo_t siginfo;
+
+	int status = waitid((idtype_t) idtype, (id_t) id, &siginfo, (int) options);
+
+	if (status == -1) {
+		if (errno == EINVAL) {
+			zend_value_error("An invalid value was specified for options, or idtype and id specify an invalid set of processes");
+			RETURN_THROWS();
+		}
+		PCNTL_G(last_error) = errno;
+		php_error_docref(NULL, E_WARNING, "%s", strerror(errno));
+		RETURN_FALSE;
+	}
+
+	// TODO verify that passing SIGCHLD does what we need
+	pcntl_siginfo_to_zval(SIGCHLD, &siginfo, user_siginfo);
+
+	RETURN_TRUE;
+}
+#endif
+
 /* {{{ Waits on or returns the status of a forked child as defined by the waitpid() system call */
 PHP_FUNCTION(pcntl_wait)
 {
@@ -1685,7 +1742,7 @@ PHP_FUNCTION(pcntl_setcpuaffinity)
 			zend_argument_value_error(2, "cpu id must be between 0 and " ZEND_ULONG_FMT " (" ZEND_LONG_FMT ")", maxcpus, cpu);
 			RETURN_THROWS();
 		}
-		       
+
 		if (!PCNTL_CPU_ISSET(cpu, mask)) {
 			PCNTL_CPU_SET(cpu, mask);
 		}

ext/pcntl/pcntl.stub.php

@@ -25,6 +25,82 @@
  */
 const WCONTINUED = UNKNOWN;
 #endif
+#ifdef WEXITED
+/**
+ * @var int
+ * @cvalue LONG_CONST(WEXITED)
+ */
+const WEXITED = UNKNOWN;
+#endif
+#ifdef WSTOPPED
+/**
+ * @var int
+ * @cvalue LONG_CONST(WSTOPPED)
+ */
+const WSTOPPED = UNKNOWN;
+#endif
+#ifdef WNOWAIT
+/**
+ * @var int
+ * @cvalue LONG_CONST(WNOWAIT)
+ */
+const WNOWAIT = UNKNOWN;
+#endif
+
+#ifdef HAVE_WAITID
+/* First argument to waitid */
+#ifdef HAVE_POSIX_IDTYPES
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_ALL)
+ */
+const P_ALL = UNKNOWN;
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_PID)
+ */
+const P_PID = UNKNOWN;
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_PGID)
+ */
+const P_PGID = UNKNOWN;
+#endif
+/* Linux specific idtype */
+#ifdef HAVE_LINUX_IDTYPES
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_PIDFD)
+ */
+const P_PIDFD = UNKNOWN;
+#endif
+/* NetBSD specific idtypes */
+#ifdef HAVE_NETBSD_IDTYPES
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_UID)
+ */
+const P_UID = UNKNOWN;
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_GID)
+ */
+const P_GID = UNKNOWN;
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_SID)
+ */
+const P_SID = UNKNOWN;
+#endif
+/* FreeBSD specific idtype */
+#ifdef HAVE_FREEBSD_IDTYPES
+/**
+ * @var int
+ * @cvalue LONG_CONST(P_JAILID)
+ */
+const P_JAILID = UNKNOWN;
+#endif
+#endif
 
 /* Signal Constants */
 
@@ -927,6 +1003,9 @@ function pcntl_fork(): int {}
  */
 function pcntl_waitpid(int $process_id, &$status, int $flags = 0, &$resource_usage = []): int {}
 
+/** @param array $info */
+function pcntl_waitid(int $idtype, ?int $id = null, &$info = [], int $flags = 0): bool {}
+
 /**
  * @param int $status
  * @param array $resource_usage

ext/pcntl/tests/pcntl_waitid.phpt

@@ -0,0 +1,76 @@
+--TEST--
+pcntl_waitid()
+--EXTENSIONS--
+pcntl
+posix
+--SKIPIF--
+<?php
+    if (!function_exists('pcntl_waitid')) die('skip pcntl_waitid unavailable');
+?>
+--FILE--
+<?php
+$pid = pcntl_fork();
+if ($pid == -1) {
+    die("failed");
+} else if ($pid) {
+    // invalid idtype
+    try {
+        pcntl_waitid(-42, $pid, $siginfo, WSTOPPED);
+    } catch (\ValueError $e) {
+        echo $e->getMessage() . \PHP_EOL;
+    }
+    try {
+        pcntl_waitid(PHP_INT_MAX, $pid, $siginfo, WSTOPPED);
+    } catch (\ValueError $e) {
+        echo $e->getMessage() . \PHP_EOL;
+    }
+    // invalid flags
+    try {
+        pcntl_waitid(P_PID, $pid, $siginfo, -42);
+    } catch (\ValueError $e) {
+        echo $e->getMessage() . \PHP_EOL;
+    }
+    try {
+        pcntl_waitid(P_PID, $pid, $siginfo, PHP_INT_MAX);
+    } catch (\ValueError $e) {
+        echo $e->getMessage() . \PHP_EOL;
+    }
+    // need at least one of WEXITED, WSTOPPED, WCONTINUED flagd
+    try {
+        pcntl_waitid(P_PID, $pid, $siginfo, WNOHANG);
+    } catch (\ValueError $e) {
+        echo $e->getMessage() . \PHP_EOL;
+    }
+
+    // with WNOHANG, call succeeds but there is no PID state change
+    $result = pcntl_waitid(P_PID, $pid, $siginfo, WEXITED | WNOHANG);
+    var_dump($result);
+    var_dump($siginfo["pid"]);
+
+    $result = pcntl_waitid(P_PID, $pid, $siginfo, WSTOPPED);
+    var_dump($result);
+
+    posix_kill($pid, SIGCONT);
+    $result = pcntl_waitid(P_PID, $pid, $siginfo, WCONTINUED);
+    var_dump($result);
+
+    $result = pcntl_waitid(P_PID, $pid, $siginfo, WEXITED);
+    var_dump($result);
+    var_dump($siginfo["status"]);
+} else {
+    posix_kill(posix_getpid(), SIGSTOP);
+    exit(42);
+}
+?>
+--EXPECTF--
+An invalid value was specified for options, or idtype and id specify an invalid set of processes
+An invalid value was specified for options, or idtype and id specify an invalid set of processes
+An invalid value was specified for options, or idtype and id specify an invalid set of processes
+An invalid value was specified for options, or idtype and id specify an invalid set of processes
+An invalid value was specified for options, or idtype and id specify an invalid set of processes
+bool(true)
+int(0)
+bool(true)
+bool(true)
+bool(true)
+int(42)