Make PHP usleep() and time_nanosleep() alertable on Windows

Author: nicolas-grekas

NEWS

@@ -91,6 +91,8 @@ PHP                                                                        NEWS
     file fails after it was already truncated. (Ilia Alshanetsky)
 
 - Standard:
+  . Fixed bug GH-24399 (usleep() and time_nanosleep() ignore queued APCs on
+    Windows). (Nicolas Grekas)
   . Fixed chown() and lchown() failing to resolve user names in ZTS builds
     when getpwnam_r() needs a larger buffer. (Ilia Alshanetsky)
   . Fixed password_get_info() and password_needs_rehash() accepting malformed

ext/standard/tests/general_functions/sleep_alertable_win32.phpt

@@ -0,0 +1,68 @@
+--TEST--
+Sleep functions process queued APCs on Windows
+--EXTENSIONS--
+ffi
+--SKIPIF--
+<?php
+if (PHP_OS_FAMILY !== 'Windows') die('skip Windows only');
+?>
+--INI--
+ffi.enable=1
+--FILE--
+<?php
+$ffi = FFI::cdef(<<<'C'
+    typedef void (__stdcall *PAPCFUNC)(uintptr_t);
+    void * __stdcall GetCurrentThread(void);
+    unsigned long __stdcall QueueUserAPC(PAPCFUNC callback, void *thread, uintptr_t data);
+    unsigned long __stdcall SleepEx(unsigned long milliseconds, int alertable);
+C, 'kernel32.dll');
+
+$called = 0;
+$callback = static function (int $data) use (&$called): void {
+    $called = $data;
+};
+
+echo "usleep()\n";
+var_dump($ffi->QueueUserAPC($callback, $ffi->GetCurrentThread(), 1) !== 0);
+var_dump(usleep(1000000));
+var_dump($called === 1);
+
+echo "time_nanosleep()\n";
+var_dump($ffi->QueueUserAPC($callback, $ffi->GetCurrentThread(), 2) !== 0);
+$remaining = time_nanosleep(2, 0);
+var_dump($called === 2);
+var_dump(is_array($remaining));
+if (is_array($remaining)) {
+    var_dump($remaining['seconds'] >= 0 && $remaining['seconds'] <= 2);
+    var_dump($remaining['nanoseconds'] >= 0 && $remaining['nanoseconds'] < 1000000000);
+    var_dump($remaining['seconds'] > 0 || $remaining['nanoseconds'] > 0);
+    var_dump($remaining['seconds'] < 2 || $remaining['nanoseconds'] === 0);
+}
+
+echo "time_sleep_until()\n";
+var_dump($ffi->QueueUserAPC($callback, $ffi->GetCurrentThread(), 3) !== 0);
+$deadline = microtime(true) + 0.1;
+var_dump(time_sleep_until($deadline));
+var_dump($called === 3);
+var_dump(microtime(true) + 0.002 >= $deadline);
+
+$ffi->SleepEx(0, 1);
+?>
+--EXPECT--
+usleep()
+bool(true)
+NULL
+bool(true)
+time_nanosleep()
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+bool(true)
+time_sleep_until()
+bool(true)
+bool(true)
+bool(true)
+bool(true)

win32/time.c

@@ -22,6 +22,7 @@
 #include <mmsystem.h>
 #include <errno.h>
 #include "php_win32_globals.h"
+#include "zend_hrtime.h"
 
 static zend_always_inline void getfilesystemtime(struct timeval *tv)
 {/*{{{*/
@@ -67,13 +68,18 @@ PHPAPI int usleep(unsigned int useconds)
 {/*{{{*/
 	HANDLE timer;
 	LARGE_INTEGER due;
+	DWORD result;
 
 	due.QuadPart = -(10 * (__int64)useconds);
 
 	timer = CreateWaitableTimer(NULL, TRUE, NULL);
 	SetWaitableTimer(timer, &due, 0, NULL, NULL, 0);
-	WaitForSingleObject(timer, INFINITE);
+	result = WaitForSingleObjectEx(timer, INFINITE, TRUE);
 	CloseHandle(timer);
+	if (result == WAIT_IO_COMPLETION) {
+		errno = EINTR;
+		return -1;
+	}
 	return 0;
 }/*}}}*/
 
@@ -84,5 +90,22 @@ PHPAPI int nanosleep( const struct timespec * rqtp, struct timespec * rmtp )
 		errno = EINVAL;
 		return -1;
 	}
-	return usleep( rqtp->tv_sec * 1000000 + rqtp->tv_nsec / 1000  );
+	zend_hrtime_t start = zend_hrtime();
+	int result = usleep(rqtp->tv_sec * 1000000 + rqtp->tv_nsec / 1000);
+	if (result == -1 && errno == EINTR && rmtp != NULL) {
+		zend_hrtime_t elapsed = zend_hrtime() - start;
+		time_t seconds = rqtp->tv_sec - (time_t) (elapsed / ZEND_NANO_IN_SEC);
+		long nanoseconds = rqtp->tv_nsec - (long) (elapsed % ZEND_NANO_IN_SEC);
+		if (nanoseconds < 0) {
+			seconds--;
+			nanoseconds += (long) ZEND_NANO_IN_SEC;
+		}
+		if (seconds < 0) {
+			seconds = 0;
+			nanoseconds = 0;
+		}
+		rmtp->tv_sec = seconds;
+		rmtp->tv_nsec = nanoseconds;
+	}
+	return result;
 }/*}}}*/