Merge branch 'true-async-api' into true-async-api-stable

Author: EdmondDantes

Zend/zend_async_API.c

@@ -197,11 +197,13 @@ void zend_async_globals_dtor(void)
 #endif
 }
 
-void zend_async_shutdown(void)
+void zend_async_api_shutdown(void)
 {
-	zend_async_globals_dtor();
 	zend_async_internal_context_api_shutdown();
 	zend_async_main_handlers_shutdown();
+#ifndef ZTS
+	zend_async_globals_dtor();
+#endif
 }
 
 ZEND_API int zend_async_get_api_version_number(void)

Zend/zend_async_API.h

@@ -363,6 +363,30 @@ struct _zend_async_event_callback_s {
 	zend_async_event_callback_dispose_fn dispose;
 };
 
+#define ZEND_ASYNC_EVENT_CALLBACK_ADD_REF(callback) \
+	if (callback != NULL) { \
+		callback->ref_count++; \
+	}
+
+//
+// For a callback,
+// it’s crucial that the reference count is always greater than zero,
+// because a value of zero is a special case triggered from a destructor.
+// If you need to “retain” ownership of the object,
+// you **MUST** use either this macro or ZEND_ASYNC_EVENT_CALLBACK_RELEASE.
+//
+#define ZEND_ASYNC_EVENT_CALLBACK_DEC_REF(callback) \
+	if(callback != NULL && callback->ref_count > 1) { \
+		callback->ref_count--; \
+	}
+
+#define ZEND_ASYNC_EVENT_CALLBACK_RELEASE(callback) \
+	if (callback != NULL && callback->ref_count > 1) { \
+		callback->ref_count--; \
+	} else { \
+		coroutine_event_callback_dispose(callback, NULL); \
+	}
+
 struct _zend_coroutine_event_callback_s {
 	zend_async_event_callback_t base;
 	zend_coroutine_t *coroutine;
@@ -1111,7 +1135,7 @@ ZEND_API bool zend_async_is_enabled(void);
 ZEND_API bool zend_scheduler_is_enabled(void);
 
 void zend_async_init(void);
-void zend_async_shutdown(void);
+void zend_async_api_shutdown(void);
 void zend_async_globals_ctor(void);
 void zend_async_globals_dtor(void);
 
@@ -1352,6 +1376,9 @@ END_EXTERN_C()
  * @param priority   Priority level for the exception-throwing coroutine
  */
 #define ZEND_ASYNC_SPAWN_AND_THROW(exception, scope, priority) zend_async_spawn_and_throw_fn(exception, scope, priority)
+/**
+ * The API method initiates graceful shutdown mode.
+ */
 #define ZEND_ASYNC_SHUTDOWN() zend_async_shutdown_fn()
 #define ZEND_ASYNC_ENGINE_SHUTDOWN() zend_async_engine_shutdown_fn()
 #define ZEND_ASYNC_GET_COROUTINES() zend_async_get_coroutines_fn()

Zend/zend_fibers.c

@@ -461,11 +461,14 @@ ZEND_API void zend_fiber_destroy_context(zend_fiber_context *context)
 {
 	zend_observer_fiber_destroy_notify(context);
 
+	// This code allows freeing the memory of the context independently of the stack memory.
+	zend_fiber_stack *stack = context->stack;
+
 	if (context->cleanup) {
 		context->cleanup(context);
 	}
 
-	zend_fiber_stack_free(context->stack);
+	zend_fiber_stack_free(stack);
 }
 
 ZEND_API void zend_fiber_switch_context(zend_fiber_transfer *transfer)

Zend/zend_gc.c

@@ -2034,8 +2034,10 @@ static void zend_gc_collect_cycles_coroutine(void)
 	}
 
 	if (GC_G(microtask) != NULL) {
-		GC_G(microtask)->is_cancelled = true;
-		ZEND_ASYNC_MICROTASK_RELEASE(GC_G(microtask));
+		zend_async_microtask_t *microtask = GC_G(microtask);
+		GC_G(microtask) = NULL;
+		microtask->is_cancelled = true;
+		ZEND_ASYNC_MICROTASK_RELEASE(microtask);
 	}
 }
 
@@ -2066,8 +2068,10 @@ static void coroutine_dispose(zend_coroutine_t *coroutine)
 		GC_G(dtor_scope) = NULL;
 
 		if (GC_G(microtask) != NULL) {
-			GC_G(microtask)->is_cancelled = true;
-			zend_gc_collect_cycles_microtask_dtor(GC_G(microtask));
+			zend_async_microtask_t *microtask = GC_G(microtask);
+			GC_G(microtask) = NULL;
+			microtask->is_cancelled = true;
+			ZEND_ASYNC_MICROTASK_RELEASE(microtask);
 		}
 
 		if (GC_G(gc_stack) != NULL) {
@@ -2150,6 +2154,8 @@ ZEND_API int zend_gc_collect_cycles(void)
 
 #endif
 
+	zend_hrtime_t dtor_start_time = 0;
+
 #ifdef PHP_ASYNC_API
 #define GC_COLLECT_TOTAL_COUNT (context->total_count)
 #define GC_COLLECT_COUNT (context->count)
@@ -2181,6 +2187,7 @@ ZEND_API int zend_gc_collect_cycles(void)
 		// so we continue the process from the next element.
 		GC_G(async_context).state = GC_ASYNC_STATE_RUNNING;
 		GC_G(dtor_idx)++;
+		dtor_start_time = zend_hrtime();
 		goto continue_calling_destructors;
 	} else {
 		context->state = GC_ASYNC_STATE_INIT;
@@ -2231,7 +2238,10 @@ ZEND_API int zend_gc_collect_cycles(void)
 		zend_refcounted *p;
 		uint32_t gc_flags = 0;
 		uint32_t idx, end;
-#ifndef PHP_ASYNC_API
+#ifdef PHP_ASYNC_API
+		stack->next = NULL;
+		stack->prev = NULL;
+#else
 		int count;
 		gc_stack stack;
 		stack.prev = NULL;
@@ -2314,7 +2324,7 @@ ZEND_API int zend_gc_collect_cycles(void)
 			}
 
 			/* Actually call destructors. */
-			zend_hrtime_t dtor_start_time = zend_hrtime();
+			dtor_start_time = zend_hrtime();
 			if (EXPECTED(!EG(active_fiber))) {
 #ifdef PHP_ASYNC_API
 continue_calling_destructors:
@@ -2344,7 +2354,7 @@ ZEND_API int zend_gc_collect_cycles(void)
 			}
 		}
 
-		GC_COLLECT_FREE_STACK;
+		gc_stack_free(GC_COLLECT_STACK);
 
 #ifdef PHP_ASYNC_API
 		end = GC_G(first_unused);

main/main.c

@@ -2515,12 +2515,13 @@ void php_module_shutdown(void)
 
 	module_initialized = false;
 
+#ifdef PHP_ASYNC_API
+	zend_async_api_shutdown();
+#endif
+
 #ifndef ZTS
 	core_globals_dtor(&core_globals);
 	gc_globals_dtor();
-	#ifdef PHP_ASYNC_API
-	zend_async_globals_dtor();
-	#endif
 #else
 	ts_free_id(core_globals_id);
 #endif