Merge pull request #20 from true-async/19-test-true-async-using-valgrind

19 test true async using valgrind

Author: EdmondDantes

.github/workflows/build.yml

@@ -61,7 +61,26 @@ jobs:
             libxml2-dev libxslt1-dev libpq-dev libreadline-dev libldap2-dev libsodium-dev \
             libargon2-dev \
             firebird-dev \
-            libuv1-dev
+            valgrind cmake
+
+      - name: Install LibUV >= 1.44.0
+        run: |
+          # Check if system libuv meets requirements
+          if pkg-config --exists libuv && pkg-config --atleast-version=1.44.0 libuv; then
+            echo "System libuv version: $(pkg-config --modversion libuv)"
+            sudo apt-get install -y libuv1-dev
+          else
+            echo "Installing LibUV 1.44.0 from source"
+            wget https://github.com/libuv/libuv/archive/v1.44.0.tar.gz
+            tar -xzf v1.44.0.tar.gz
+            cd libuv-1.44.0
+            mkdir build && cd build
+            cmake .. -DCMAKE_BUILD_TYPE=Release
+            make -j$(nproc)
+            sudo make install
+            sudo ldconfig
+            cd ../..
+          fi
 
       - name: Configure PHP
         working-directory: php-src
@@ -140,11 +159,11 @@ jobs:
             -d opcache.jit=tracing \
             -d zend_test.observer.enabled=1 \
             -d zend_test.observer.show_output=0 \
-            -P -q -x -j2 \
+            -P -q -x -j4 \
             -g FAIL,BORK,LEAK,XLEAK \
             --no-progress \
             --offline \
             --show-diff \
-            --show-slow 1000 \
+            --show-slow 2000 \
             --set-timeout 120 \
-            --repeat 2
+            --repeat 2

CHANGELOG.md

@@ -22,7 +22,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Memory management improvements for long-running async applications
 - Proper cleanup of coroutine and scope objects during garbage collection cycles
 
-## [0.2.0] - TBD
+### Changed
+- **LibUV requirement increased to ≥ 1.44.0** - Requires libuv version 1.44.0 or later to ensure proper UV_RUN_ONCE behavior and prevent busy loop issues that could cause high CPU usage
+
+
+## [0.2.0] - 2025-07-01
 
 ### Added
 - **Async-aware destructor handling (PHP Core)**: Implemented `async_shutdown_destructors()` function to properly 

README.md

@@ -31,6 +31,21 @@ tightly integrated at the core level.
 PHP TRUE ASYNC is supported for PHP 8.5.0 and later.
 `LibUV` is the primary reactor implementation for this extension.
 
+### Requirements
+
+- **PHP 8.5.0+**
+- **LibUV ≥ 1.44.0** (required) - Fixes critical `UV_RUN_ONCE` busy loop issue that could cause high CPU usage
+
+### Why LibUV 1.44.0+ is Required
+
+Prior to libuv 1.44, there was a critical issue in `uv__io_poll()`/`uv__run_pending` logic that could cause the event loop to "stick" after the first callback when running in `UV_RUN_ONCE` mode, especially when new ready events appeared within callbacks. This resulted in:
+
+- **High CPU usage** due to busy loops
+- **Performance degradation** in async applications
+- **Inconsistent event loop behavior** affecting TrueAsync API reliability
+
+The fix in libuv 1.44 ensures that `UV_RUN_ONCE` properly returns after processing all ready callbacks in the current iteration, meeting the "forward progress" specification requirements. This is essential for TrueAsync's performance and reliability.
+
 ---
 
 ### Unix / macOS
@@ -67,7 +82,31 @@ PHP TRUE ASYNC is supported for PHP 8.5.0 and later.
 
 4. **Install LibUV:**:
    
-Please see the [LibUV installation guide](https://github.com/libuv/libuv)
+**IMPORTANT:** LibUV version 1.44.0 or later is required.
+
+For Debian/Ubuntu:
+```bash
+# Check if system libuv meets requirements (≥1.44.0)
+pkg-config --modversion libuv
+
+# If version is too old, install from source:
+wget https://github.com/libuv/libuv/archive/v1.44.0.tar.gz
+tar -xzf v1.44.0.tar.gz
+cd libuv-1.44.0
+mkdir build && cd build
+cmake .. -DCMAKE_BUILD_TYPE=Release
+make -j$(nproc)
+sudo make install
+sudo ldconfig
+```
+
+For macOS:
+```bash
+# Homebrew usually has recent versions
+brew install libuv
+```
+
+Please see the [LibUV installation guide](https://github.com/libuv/libuv) for more details.
 
 5. **Configure and build:**
 

async_API.c

@@ -299,11 +299,10 @@ void async_waiting_callback_dispose(zend_async_event_callback_t *callback, zend_
 
 	await_callback->await_context = NULL;
 
-	if (await_context == NULL) {
-		return;
+	if (await_context != NULL) {
+		await_context->dtor(await_context);
 	}
 
-	await_context->dtor(await_context);
 	await_callback->prev_dispose(callback, event);
 }
 
@@ -322,7 +321,9 @@ void async_waiting_callback(
 	// remove the callback from the event
 	// We remove the callback because we treat all events
 	// as FUTURE-type objects, where the trigger can be activated only once.
+	ZEND_ASYNC_EVENT_CALLBACK_ADD_REF(callback);
 	event->del_callback(event, callback);
+	ZEND_ASYNC_EVENT_CALLBACK_DEC_REF(callback);
 
 	if (exception != NULL) {
 		ZEND_ASYNC_EVENT_SET_EXCEPTION_HANDLED(event);
@@ -356,6 +357,7 @@ void async_waiting_callback(
 			false
 		);
 
+		callback->dispose(callback, NULL);
 		return;
 	}
 
@@ -366,6 +368,7 @@ void async_waiting_callback(
 			ZEND_ASYNC_RESUME(await_callback->callback.coroutine);
 		}
 
+		callback->dispose(callback, NULL);
 		return;
 	}
 
@@ -393,6 +396,8 @@ void async_waiting_callback(
 	if (UNEXPECTED(ITERATOR_IS_FINISHED(await_context))) {
 		ZEND_ASYNC_RESUME(await_callback->callback.coroutine);
 	}
+
+	callback->dispose(callback, NULL);
 }
 
 /**
@@ -415,7 +420,9 @@ void async_waiting_cancellation_callback(
 	async_await_context_t * await_context = await_callback->await_context;
 
 	await_context->resolved_count++;
+	ZEND_ASYNC_EVENT_CALLBACK_ADD_REF(callback);
 	event->del_callback(event, callback);
+	ZEND_ASYNC_EVENT_CALLBACK_DEC_REF(callback);
 
 	if (exception != NULL) {
 		ZEND_ASYNC_EVENT_SET_EXCEPTION_HANDLED(event);
@@ -445,6 +452,8 @@ void async_waiting_cancellation_callback(
 	if (await_context->total != 0 && await_context->resolved_count >= await_context->total) {
 		ZEND_ASYNC_RESUME(await_callback->callback.coroutine);
 	}
+
+	callback->dispose(callback, NULL);
 }
 
 zend_result await_iterator_handler(async_iterator_t *iterator, zval *current, zval *key)

config.m4

@@ -26,14 +26,15 @@ if test "$PHP_ASYNC" = "yes"; then
     AC_MSG_CHECKING(for libuv)
 
     if test -x "$PKG_CONFIG" && $PKG_CONFIG --exists libuv; then
-      if $PKG_CONFIG libuv --atleast-version 1.40.0; then
+      dnl Require libuv >= 1.44.0 for UV_RUN_ONCE busy loop fix
+      if $PKG_CONFIG libuv --atleast-version 1.44.0; then
         LIBUV_INCLINE=`$PKG_CONFIG libuv --cflags`
         LIBUV_LIBLINE=`$PKG_CONFIG libuv --libs`
         LIBUV_VERSION=`$PKG_CONFIG libuv --modversion`
         AC_MSG_RESULT(from pkgconfig: found version $LIBUV_VERSION)
         AC_DEFINE(PHP_ASYNC_LIBUV,1,[ ])
       else
-        AC_MSG_ERROR(system libuv must be upgraded to version >= 1.40.0)
+        AC_MSG_ERROR(system libuv must be upgraded to version >= 1.44.0 (fixes UV_RUN_ONCE busy loop issue))
       fi
       PHP_EVAL_LIBLINE($LIBUV_LIBLINE, UV_SHARED_LIBADD)
       PHP_EVAL_INCLINE($LIBUV_INCLINE)

config.w32

@@ -30,6 +30,9 @@ if (PHP_ASYNC == "yes") {
     if (CHECK_HEADER_ADD_INCLUDE("libuv/uv.h", "CFLAGS_UV", PHP_PHP_BUILD + "\\include")
         && CHECK_LIB("libuv.lib", "libuv")) {
 
+        // Note: libuv >= 1.44.0 is required for UV_RUN_ONCE busy loop fix
+        // For Windows builds, manually verify libuv version meets requirements
+        
         PHP_INSTALL_HEADERS("ext/async", "libuv_reactor.h");
 
         ADD_SOURCES("ext/async", "libuv_reactor.c");
@@ -39,6 +42,7 @@ if (PHP_ASYNC == "yes") {
         ERROR("Libuv components are not found. The search was performed in the directory: '" + PHP_PHP_BUILD +
               "'.\nTo compile PHP TRUE ASYNC with LibUV:\n" +
               "1. Copy files from 'libuv\\include' to '" + PHP_PHP_BUILD + "\\include\\libuv\\'\n" +
-              "2. Build libuv.lib and copy it to '" + PHP_PHP_BUILD + "\\lib\\'");
+              "2. Build libuv.lib and copy it to '" + PHP_PHP_BUILD + "\\lib\\'\n" +
+              "3. IMPORTANT: Use libuv >= 1.44.0 (fixes UV_RUN_ONCE busy loop issue)");
     }
 }

run-tests.sh

@@ -3,11 +3,12 @@
 BASE_PATH="$(cd "$(dirname "$0")/tests" && pwd)"
 RUN_TESTS_PATH="$(cd "$(dirname "$0")/../../" && pwd)/run-tests.php"
 PHP_EXECUTABLE="$(cd "$(dirname "$0")/../../" && pwd)/sapi/cli/php"
+export VALGRIND_OPTS="--leak-check=full --track-origins=yes"
 
 if [ -z "$1" ]; then
     TEST_PATH="$BASE_PATH"
 else
     TEST_PATH="$BASE_PATH/$1"
 fi
 
-"$PHP_EXECUTABLE" "$RUN_TESTS_PATH" --show-diff -p "$PHP_EXECUTABLE" "$TEST_PATH"
+"$PHP_EXECUTABLE" "$RUN_TESTS_PATH" --show-diff -m -p "$PHP_EXECUTABLE" "$TEST_PATH"

tests/await/006-awaitAny_empty.phpt

@@ -8,11 +8,13 @@ use function Async\awaitAny;
 echo "start\n";
 
 $result = awaitAny([]);
-var_dump($result);
+
+$resultCheck = $result === null ? "OK" : "FALSE: " . var_export($result, true);
+echo "Result is null: $resultCheck\n";
 
 echo "end\n";
 ?>
 --EXPECT--
 start
-NULL
+Result is null: OK
 end

tests/await/007-awaitAny_exception.phpt

@@ -6,6 +6,7 @@ awaitAny() - coroutine throws exception
 use function Async\spawn;
 use function Async\awaitAny;
 use function Async\delay;
+use function Async\suspend;
 
 echo "start\n";
 
@@ -15,7 +16,7 @@ $coroutines = [
         return "first";
     }),
     spawn(function() {
-        delay(20);
+        suspend();
         throw new RuntimeException("test exception");
     }),
 ];

tests/await/008-awaitFirstSuccess_basic.phpt

@@ -25,36 +25,10 @@ $coroutines = [
 ];
 
 $result = awaitFirstSuccess($coroutines);
-var_dump($result);
-
+echo "Result: {$result[0]}\n";
 echo "end\n";
 ?>
 --EXPECTF--
 start
-array(2) {
-  [0]=>
-  string(7) "success"
-  [1]=>
-  array(1) {
-    [0]=>
-    object(RuntimeException)#%d (7) {
-      ["message":protected]=>
-      string(11) "first error"
-      ["string":"Exception":private]=>
-      string(0) ""
-      ["code":protected]=>
-      int(0)
-      ["file":protected]=>
-      string(%d) "%s"
-      ["line":protected]=>
-      int(%d)
-      ["trace":"Exception":private]=>
-      array(%d) {
-        %a
-      }
-      ["previous":"Exception":private]=>
-      NULL
-    }
-  }
-}
+Result: success
 end