Skip to content

Commit d0c43e1

Browse files
trowskitrowski
authored
Reorganize zend_test and add custom fiber implementation tests (php#7137)
1 parent b5a14e6 commit d0c43e1

16 files changed

+953
-289
lines changed

‎ext/zend_test/config.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ PHP_ARG_ENABLE([zend-test],
44
[Enable zend_test extension])])
55

66
if test "$PHP_ZEND_TEST" != "no"; then
7-
PHP_NEW_EXTENSION(zend_test, test.c, $ext_shared,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
7+
PHP_NEW_EXTENSION(zend_test, test.c observer.c fiber.c, $ext_shared,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
88
fi

‎ext/zend_test/config.w32

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
ARG_ENABLE("zend-test", "enable zend_test extension", "no");
44

55
if (PHP_ZEND_TEST != "no") {
6-
EXTENSION("zend_test", "test.c", PHP_ZEND_TEST_SHARED, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
6+
EXTENSION("zend_test", "test.c observer.c fiber.c", PHP_ZEND_TEST_SHARED, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
77
ADD_FLAG("CFLAGS_ZEND_TEST", "/D PHP_ZEND_TEST_EXPORTS ");
88
}

‎ext/zend_test/fiber.c

+298
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,298 @@
1+
/*
2+
+----------------------------------------------------------------------+
3+
| Copyright (c) The PHP Group |
4+
+----------------------------------------------------------------------+
5+
| This source file is subject to version 3.01 of the PHP license, |
6+
| that is bundled with this package in the file LICENSE, and is |
7+
| available through the world-wide-web at the following url: |
8+
| https://www.php.net/license/3_01.txt |
9+
| If you did not receive a copy of the PHP license and are unable to |
10+
| obtain it through the world-wide-web, please send a note to |
11+
| license@php.net so we can mail you a copy immediately. |
12+
+----------------------------------------------------------------------+
13+
| Authors: Aaron Piotrowski <aaron@trowski.com> |
14+
+----------------------------------------------------------------------+
15+
*/
16+
17+
#include "php_test.h"
18+
#include "fiber.h"
19+
#include "fiber_arginfo.h"
20+
#include "zend_fibers.h"
21+
#include "zend_exceptions.h"
22+
23+
static zend_class_entry *zend_test_fiber_class;
24+
static zend_object_handlers zend_test_fiber_handlers;
25+
26+
static zend_always_inline zend_fiber_context *zend_test_fiber_get_context(zend_test_fiber *fiber)
27+
{
28+
return (zend_fiber_context *) &fiber->handle;
29+
}
30+
31+
static zend_fiber_transfer zend_test_fiber_switch_to(zend_fiber_context *context, zval *value, bool exception)
32+
{
33+
zend_fiber_transfer transfer = {
34+
.context = context,
35+
.flags = exception ? ZEND_FIBER_TRANSFER_FLAG_ERROR : 0,
36+
};
37+
38+
if (value) {
39+
ZVAL_COPY(&transfer.value, value);
40+
} else {
41+
ZVAL_NULL(&transfer.value);
42+
}
43+
44+
zend_fiber_switch_context(&transfer);
45+
46+
return transfer;
47+
}
48+
49+
static zend_fiber_transfer zend_test_fiber_resume(zend_test_fiber *fiber, zval *value, bool exception)
50+
{
51+
zend_test_fiber *previous = ZT_G(active_fiber);
52+
53+
fiber->caller = EG(current_fiber_context);
54+
ZT_G(active_fiber) = fiber;
55+
56+
zend_fiber_transfer transfer = zend_test_fiber_switch_to(fiber->previous, value, exception);
57+
58+
ZT_G(active_fiber) = previous;
59+
60+
return transfer;
61+
}
62+
63+
static zend_fiber_transfer zend_test_fiber_suspend(zend_test_fiber *fiber, zval *value)
64+
{
65+
ZEND_ASSERT(fiber->caller != NULL);
66+
67+
zend_fiber_context *caller = fiber->caller;
68+
fiber->previous = EG(current_fiber_context);
69+
fiber->caller = NULL;
70+
71+
return zend_test_fiber_switch_to(caller, value, false);
72+
}
73+
74+
static ZEND_STACK_ALIGNED void zend_test_fiber_execute(zend_fiber_transfer *transfer)
75+
{
76+
zend_test_fiber *fiber = ZT_G(active_fiber);
77+
78+
zend_execute_data *execute_data;
79+
80+
EG(vm_stack) = NULL;
81+
82+
zend_first_try {
83+
zend_vm_stack stack = zend_vm_stack_new_page(ZEND_FIBER_VM_STACK_SIZE, NULL);
84+
EG(vm_stack) = stack;
85+
EG(vm_stack_top) = stack->top + ZEND_CALL_FRAME_SLOT;
86+
EG(vm_stack_end) = stack->end;
87+
EG(vm_stack_page_size) = ZEND_FIBER_VM_STACK_SIZE;
88+
89+
execute_data = (zend_execute_data *) stack->top;
90+
91+
memset(execute_data, 0, sizeof(zend_execute_data));
92+
93+
EG(current_execute_data) = execute_data;
94+
EG(jit_trace_num) = 0;
95+
96+
fiber->fci.retval = &fiber->result;
97+
98+
zend_call_function(&fiber->fci, &fiber->fci_cache);
99+
100+
zval_ptr_dtor(&fiber->fci.function_name);
101+
102+
if (EG(exception)) {
103+
if (!(fiber->flags & ZEND_FIBER_FLAG_DESTROYED)
104+
|| !(zend_is_graceful_exit(EG(exception)) || zend_is_unwind_exit(EG(exception)))
105+
) {
106+
fiber->flags |= ZEND_FIBER_FLAG_THREW;
107+
transfer->flags = ZEND_FIBER_TRANSFER_FLAG_ERROR;
108+
109+
ZVAL_OBJ_COPY(&transfer->value, EG(exception));
110+
}
111+
112+
zend_clear_exception();
113+
} else {
114+
ZVAL_COPY(&transfer->value, &fiber->result);
115+
}
116+
} zend_catch {
117+
fiber->flags |= ZEND_FIBER_FLAG_BAILOUT;
118+
} zend_end_try();
119+
120+
transfer->context = fiber->caller;
121+
122+
zend_vm_stack_destroy();
123+
fiber->caller = NULL;
124+
}
125+
126+
static zend_object *zend_test_fiber_object_create(zend_class_entry *ce)
127+
{
128+
zend_test_fiber *fiber;
129+
130+
fiber = emalloc(sizeof(zend_test_fiber));
131+
memset(fiber, 0, sizeof(zend_test_fiber));
132+
133+
zend_object_std_init(&fiber->std, ce);
134+
fiber->std.handlers = &zend_test_fiber_handlers;
135+
136+
return &fiber->std;
137+
}
138+
139+
static void zend_test_fiber_object_destroy(zend_object *object)
140+
{
141+
zend_test_fiber *fiber = (zend_test_fiber *) object;
142+
143+
if (fiber->status != ZEND_FIBER_STATUS_SUSPENDED) {
144+
return;
145+
}
146+
147+
zend_object *exception = EG(exception);
148+
EG(exception) = NULL;
149+
150+
fiber->flags |= ZEND_FIBER_FLAG_DESTROYED;
151+
152+
zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, NULL, false);
153+
154+
if (transfer.flags & ZEND_FIBER_TRANSFER_FLAG_ERROR) {
155+
EG(exception) = Z_OBJ(transfer.value);
156+
157+
if (!exception && EG(current_execute_data) && EG(current_execute_data)->func
158+
&& ZEND_USER_CODE(EG(current_execute_data)->func->common.type)) {
159+
zend_rethrow_exception(EG(current_execute_data));
160+
}
161+
162+
zend_exception_set_previous(EG(exception), exception);
163+
164+
if (!EG(current_execute_data)) {
165+
zend_exception_error(EG(exception), E_ERROR);
166+
}
167+
} else {
168+
zval_ptr_dtor(&transfer.value);
169+
EG(exception) = exception;
170+
}
171+
}
172+
173+
static void zend_test_fiber_object_free(zend_object *object)
174+
{
175+
zend_test_fiber *fiber = (zend_test_fiber *) object;
176+
177+
if (fiber->status == ZEND_FIBER_STATUS_INIT) {
178+
// Fiber was never started, so we need to release the reference to the callback.
179+
zval_ptr_dtor(&fiber->fci.function_name);
180+
}
181+
182+
zval_ptr_dtor(&fiber->result);
183+
184+
zend_object_std_dtor(&fiber->std);
185+
}
186+
187+
static zend_always_inline void delegate_transfer_result(
188+
zend_test_fiber *fiber, zend_fiber_transfer *transfer, INTERNAL_FUNCTION_PARAMETERS
189+
) {
190+
if (transfer->flags & ZEND_FIBER_TRANSFER_FLAG_ERROR) {
191+
zend_throw_exception_internal(Z_OBJ(transfer->value));
192+
RETURN_THROWS();
193+
}
194+
195+
if (fiber->status == ZEND_FIBER_STATUS_DEAD) {
196+
zval_ptr_dtor(&transfer->value);
197+
RETURN_NULL();
198+
}
199+
200+
RETURN_COPY_VALUE(&transfer->value);
201+
}
202+
203+
static ZEND_METHOD(_ZendTestFiber, __construct)
204+
{
205+
zend_test_fiber *fiber = (zend_test_fiber *) Z_OBJ_P(getThis());
206+
207+
ZEND_PARSE_PARAMETERS_START(1, 1)
208+
Z_PARAM_FUNC(fiber->fci, fiber->fci_cache)
209+
ZEND_PARSE_PARAMETERS_END();
210+
211+
// Keep a reference to closures or callable objects while the fiber is running.
212+
Z_TRY_ADDREF(fiber->fci.function_name);
213+
}
214+
215+
static ZEND_METHOD(_ZendTestFiber, start)
216+
{
217+
zend_test_fiber *fiber = (zend_test_fiber *) Z_OBJ_P(getThis());
218+
zval *params;
219+
uint32_t param_count;
220+
zend_array *named_params;
221+
222+
ZEND_PARSE_PARAMETERS_START(0, -1)
223+
Z_PARAM_VARIADIC_WITH_NAMED(params, param_count, named_params);
224+
ZEND_PARSE_PARAMETERS_END();
225+
226+
ZEND_ASSERT(fiber->status == ZEND_FIBER_STATUS_INIT);
227+
228+
fiber->fci.params = params;
229+
fiber->fci.param_count = param_count;
230+
fiber->fci.named_params = named_params;
231+
232+
zend_fiber_context *context = zend_test_fiber_get_context(fiber);
233+
234+
zend_fiber_init_context(context, zend_test_fiber_class, zend_test_fiber_execute, EG(fiber_stack_size));
235+
236+
fiber->previous = context;
237+
238+
zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, NULL, false);
239+
240+
delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
241+
}
242+
243+
static ZEND_METHOD(_ZendTestFiber, suspend)
244+
{
245+
zval *value = NULL;
246+
247+
ZEND_PARSE_PARAMETERS_START(0, 1)
248+
Z_PARAM_OPTIONAL
249+
Z_PARAM_ZVAL(value);
250+
ZEND_PARSE_PARAMETERS_END();
251+
252+
zend_test_fiber *fiber = ZT_G(active_fiber);
253+
254+
ZEND_ASSERT(fiber);
255+
256+
zend_fiber_transfer transfer = zend_test_fiber_suspend(fiber, value);
257+
258+
if (fiber->flags & ZEND_FIBER_FLAG_DESTROYED) {
259+
// This occurs when the test fiber is GC'ed while suspended.
260+
zval_ptr_dtor(&transfer.value);
261+
zend_throw_graceful_exit();
262+
RETURN_THROWS();
263+
}
264+
265+
delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
266+
}
267+
268+
static ZEND_METHOD(_ZendTestFiber, resume)
269+
{
270+
zend_test_fiber *fiber;
271+
zval *value = NULL;
272+
273+
ZEND_PARSE_PARAMETERS_START(0, 1)
274+
Z_PARAM_OPTIONAL
275+
Z_PARAM_ZVAL(value);
276+
ZEND_PARSE_PARAMETERS_END();
277+
278+
fiber = (zend_test_fiber *) Z_OBJ_P(getThis());
279+
280+
if (UNEXPECTED(fiber->status != ZEND_FIBER_STATUS_SUSPENDED || fiber->caller != NULL)) {
281+
zend_throw_error(NULL, "Cannot resume a fiber that is not suspended");
282+
RETURN_THROWS();
283+
}
284+
285+
zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, value, false);
286+
287+
delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
288+
}
289+
290+
void zend_test_fiber_init(void)
291+
{
292+
zend_test_fiber_class = register_class__ZendTestFiber();
293+
zend_test_fiber_class->create_object = zend_test_fiber_object_create;
294+
295+
zend_test_fiber_handlers = std_object_handlers;
296+
zend_test_fiber_handlers.dtor_obj = zend_test_fiber_object_destroy;
297+
zend_test_fiber_handlers.free_obj = zend_test_fiber_object_free;
298+
}

‎ext/zend_test/fiber.h

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
+----------------------------------------------------------------------+
3+
| Copyright (c) The PHP Group |
4+
+----------------------------------------------------------------------+
5+
| This source file is subject to version 3.01 of the PHP license, |
6+
| that is bundled with this package in the file LICENSE, and is |
7+
| available through the world-wide-web at the following url: |
8+
| https://www.php.net/license/3_01.txt |
9+
| If you did not receive a copy of the PHP license and are unable to |
10+
| obtain it through the world-wide-web, please send a note to |
11+
| license@php.net so we can mail you a copy immediately. |
12+
+----------------------------------------------------------------------+
13+
| Authors: Aaron Piotrowski <aaron@trowski.com> |
14+
+----------------------------------------------------------------------+
15+
*/
16+
17+
#ifndef ZEND_TEST_FIBER_H
18+
#define ZEND_TEST_FIBER_H
19+
20+
#include "zend_fibers.h"
21+
22+
typedef struct _zend_test_fiber {
23+
zend_object std;
24+
ZEND_FIBER_CONTEXT_FIELDS;
25+
zend_fiber_context *caller;
26+
zend_fiber_context *previous;
27+
zend_fcall_info fci;
28+
zend_fcall_info_cache fci_cache;
29+
zval result;
30+
} zend_test_fiber;
31+
32+
void zend_test_fiber_init(void);
33+
34+
#endif

‎ext/zend_test/fiber.stub.php

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
/** @generate-class-entries static */
4+
5+
final class _ZendTestFiber
6+
{
7+
public function __construct(callable $callback) {}
8+
9+
public function start(mixed ...$args): mixed {}
10+
11+
public function resume(mixed $value = null): mixed {}
12+
13+
public static function suspend(mixed $value = null): mixed {}
14+
}

0 commit comments

Comments
 (0)