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
zend_test_fiber_switch_to(zend_fiber_context * context,zval * value,bool exception)26 static zend_fiber_transfer zend_test_fiber_switch_to(zend_fiber_context *context, zval *value, bool exception)
27 {
28 zend_fiber_transfer transfer = {
29 .context = context,
30 .flags = exception ? ZEND_FIBER_TRANSFER_FLAG_ERROR : 0,
31 };
32
33 if (value) {
34 ZVAL_COPY(&transfer.value, value);
35 } else {
36 ZVAL_NULL(&transfer.value);
37 }
38
39 zend_fiber_switch_context(&transfer);
40
41 /* Forward bailout into current fiber. */
42 if (UNEXPECTED(transfer.flags & ZEND_FIBER_TRANSFER_FLAG_BAILOUT)) {
43 zend_bailout();
44 }
45
46 return transfer;
47 }
48
zend_test_fiber_resume(zend_test_fiber * fiber,zval * value,bool exception)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
zend_test_fiber_suspend(zend_test_fiber * fiber,zval * value)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
zend_test_fiber_execute(zend_fiber_transfer * transfer)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 zval retval;
78
79 zend_execute_data *execute_data;
80
81 EG(vm_stack) = NULL;
82 transfer->flags = 0;
83
84 zend_first_try {
85 zend_vm_stack stack = zend_vm_stack_new_page(ZEND_FIBER_VM_STACK_SIZE, NULL);
86 EG(vm_stack) = stack;
87 EG(vm_stack_top) = stack->top + ZEND_CALL_FRAME_SLOT;
88 EG(vm_stack_end) = stack->end;
89 EG(vm_stack_page_size) = ZEND_FIBER_VM_STACK_SIZE;
90
91 execute_data = (zend_execute_data *) stack->top;
92
93 memset(execute_data, 0, sizeof(zend_execute_data));
94
95 EG(current_execute_data) = execute_data;
96 EG(jit_trace_num) = 0;
97
98 #ifdef ZEND_CHECK_STACK_LIMIT
99 EG(stack_base) = zend_fiber_stack_base(fiber->context.stack);
100 EG(stack_limit) = zend_fiber_stack_limit(fiber->context.stack);
101 #endif
102 fiber->fci.retval = &retval;
103
104 zend_call_function(&fiber->fci, &fiber->fci_cache);
105
106 zval_ptr_dtor(&fiber->result); // Destroy param from symmetric coroutine.
107 zval_ptr_dtor(&fiber->fci.function_name);
108
109 if (EG(exception)) {
110 if (!(fiber->flags & ZEND_FIBER_FLAG_DESTROYED)
111 || !(zend_is_graceful_exit(EG(exception)) || zend_is_unwind_exit(EG(exception)))
112 ) {
113 fiber->flags |= ZEND_FIBER_FLAG_THREW;
114 transfer->flags = ZEND_FIBER_TRANSFER_FLAG_ERROR;
115
116 ZVAL_OBJ_COPY(&transfer->value, EG(exception));
117 }
118
119 zend_clear_exception();
120 } else {
121 ZVAL_COPY_VALUE(&fiber->result, &retval);
122 ZVAL_COPY(&transfer->value, &fiber->result);
123 }
124 } zend_catch {
125 fiber->flags |= ZEND_FIBER_FLAG_BAILOUT;
126 transfer->flags = ZEND_FIBER_TRANSFER_FLAG_BAILOUT;
127 } zend_end_try();
128
129 zend_vm_stack_destroy();
130
131 if (fiber->target) {
132 zend_fiber_context *target = &fiber->target->context;
133 zend_fiber_init_context(target, zend_test_fiber_class, zend_test_fiber_execute, EG(fiber_stack_size));
134 transfer->context = target;
135
136 ZVAL_COPY(&fiber->target->result, &fiber->result);
137 fiber->target->fci.params = &fiber->target->result;
138 fiber->target->fci.param_count = 1;
139
140 fiber->target->caller = fiber->caller;
141 ZT_G(active_fiber) = fiber->target;
142 } else {
143 transfer->context = fiber->caller;
144 }
145
146 fiber->caller = NULL;
147 }
148
zend_test_fiber_object_create(zend_class_entry * ce)149 static zend_object *zend_test_fiber_object_create(zend_class_entry *ce)
150 {
151 zend_test_fiber *fiber;
152
153 fiber = emalloc(sizeof(zend_test_fiber));
154 memset(fiber, 0, sizeof(zend_test_fiber));
155
156 zend_object_std_init(&fiber->std, ce);
157
158 return &fiber->std;
159 }
160
zend_test_fiber_object_destroy(zend_object * object)161 static void zend_test_fiber_object_destroy(zend_object *object)
162 {
163 zend_test_fiber *fiber = (zend_test_fiber *) object;
164
165 if (fiber->context.status != ZEND_FIBER_STATUS_SUSPENDED) {
166 return;
167 }
168
169 zend_object *exception = EG(exception);
170 EG(exception) = NULL;
171
172 fiber->flags |= ZEND_FIBER_FLAG_DESTROYED;
173
174 zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, NULL, false);
175
176 if (transfer.flags & ZEND_FIBER_TRANSFER_FLAG_ERROR) {
177 EG(exception) = Z_OBJ(transfer.value);
178
179 if (!exception && EG(current_execute_data) && EG(current_execute_data)->func
180 && ZEND_USER_CODE(EG(current_execute_data)->func->common.type)) {
181 zend_rethrow_exception(EG(current_execute_data));
182 }
183
184 zend_exception_set_previous(EG(exception), exception);
185
186 if (!EG(current_execute_data)) {
187 zend_exception_error(EG(exception), E_ERROR);
188 }
189 } else {
190 zval_ptr_dtor(&transfer.value);
191 EG(exception) = exception;
192 }
193 }
194
zend_test_fiber_object_free(zend_object * object)195 static void zend_test_fiber_object_free(zend_object *object)
196 {
197 zend_test_fiber *fiber = (zend_test_fiber *) object;
198
199 if (fiber->context.status == ZEND_FIBER_STATUS_INIT) {
200 // Fiber was never started, so we need to release the reference to the callback.
201 zval_ptr_dtor(&fiber->fci.function_name);
202 }
203
204 if (fiber->target) {
205 OBJ_RELEASE(&fiber->target->std);
206 }
207
208 zval_ptr_dtor(&fiber->result);
209
210 zend_object_std_dtor(&fiber->std);
211 }
212
delegate_transfer_result(zend_test_fiber * fiber,zend_fiber_transfer * transfer,INTERNAL_FUNCTION_PARAMETERS)213 static zend_always_inline void delegate_transfer_result(
214 zend_test_fiber *fiber, zend_fiber_transfer *transfer, INTERNAL_FUNCTION_PARAMETERS
215 ) {
216 if (transfer->flags & ZEND_FIBER_TRANSFER_FLAG_ERROR) {
217 zend_throw_exception_internal(Z_OBJ(transfer->value));
218 RETURN_THROWS();
219 }
220
221 if (fiber->context.status == ZEND_FIBER_STATUS_DEAD) {
222 zval_ptr_dtor(&transfer->value);
223 RETURN_NULL();
224 }
225
226 RETURN_COPY_VALUE(&transfer->value);
227 }
228
ZEND_METHOD(_ZendTestFiber,__construct)229 static ZEND_METHOD(_ZendTestFiber, __construct)
230 {
231 zend_test_fiber *fiber = (zend_test_fiber *) Z_OBJ_P(ZEND_THIS);
232
233 ZEND_PARSE_PARAMETERS_START(1, 1)
234 Z_PARAM_FUNC(fiber->fci, fiber->fci_cache)
235 ZEND_PARSE_PARAMETERS_END();
236
237 // Keep a reference to closures or callable objects while the fiber is running.
238 Z_TRY_ADDREF(fiber->fci.function_name);
239 }
240
ZEND_METHOD(_ZendTestFiber,start)241 static ZEND_METHOD(_ZendTestFiber, start)
242 {
243 zend_test_fiber *fiber = (zend_test_fiber *) Z_OBJ_P(ZEND_THIS);
244 zval *params;
245 uint32_t param_count;
246 zend_array *named_params;
247
248 ZEND_PARSE_PARAMETERS_START(0, -1)
249 Z_PARAM_VARIADIC_WITH_NAMED(params, param_count, named_params);
250 ZEND_PARSE_PARAMETERS_END();
251
252 ZEND_ASSERT(fiber->context.status == ZEND_FIBER_STATUS_INIT);
253
254 if (fiber->previous != NULL) {
255 zend_throw_error(NULL, "Cannot start a fiber that is the target of another fiber");
256 RETURN_THROWS();
257 }
258
259 fiber->fci.params = params;
260 fiber->fci.param_count = param_count;
261 fiber->fci.named_params = named_params;
262
263 zend_fiber_init_context(&fiber->context, zend_test_fiber_class, zend_test_fiber_execute, EG(fiber_stack_size));
264
265 fiber->previous = &fiber->context;
266
267 zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, NULL, false);
268
269 delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
270 }
271
ZEND_METHOD(_ZendTestFiber,suspend)272 static ZEND_METHOD(_ZendTestFiber, suspend)
273 {
274 zval *value = NULL;
275
276 ZEND_PARSE_PARAMETERS_START(0, 1)
277 Z_PARAM_OPTIONAL
278 Z_PARAM_ZVAL(value);
279 ZEND_PARSE_PARAMETERS_END();
280
281 zend_test_fiber *fiber = ZT_G(active_fiber);
282
283 ZEND_ASSERT(fiber);
284
285 zend_fiber_transfer transfer = zend_test_fiber_suspend(fiber, value);
286
287 if (fiber->flags & ZEND_FIBER_FLAG_DESTROYED) {
288 // This occurs when the test fiber is GC'ed while suspended.
289 zval_ptr_dtor(&transfer.value);
290 zend_throw_graceful_exit();
291 RETURN_THROWS();
292 }
293
294 delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
295 }
296
ZEND_METHOD(_ZendTestFiber,resume)297 static ZEND_METHOD(_ZendTestFiber, resume)
298 {
299 zend_test_fiber *fiber;
300 zval *value = NULL;
301
302 ZEND_PARSE_PARAMETERS_START(0, 1)
303 Z_PARAM_OPTIONAL
304 Z_PARAM_ZVAL(value);
305 ZEND_PARSE_PARAMETERS_END();
306
307 fiber = (zend_test_fiber *) Z_OBJ_P(ZEND_THIS);
308
309 if (UNEXPECTED(fiber->context.status != ZEND_FIBER_STATUS_SUSPENDED || fiber->caller != NULL)) {
310 zend_throw_error(NULL, "Cannot resume a fiber that is not suspended");
311 RETURN_THROWS();
312 }
313
314 zend_fiber_transfer transfer = zend_test_fiber_resume(fiber, value, false);
315
316 delegate_transfer_result(fiber, &transfer, INTERNAL_FUNCTION_PARAM_PASSTHRU);
317 }
318
ZEND_METHOD(_ZendTestFiber,pipeTo)319 static ZEND_METHOD(_ZendTestFiber, pipeTo)
320 {
321 zend_fcall_info fci;
322 zend_fcall_info_cache fci_cache;
323
324 ZEND_PARSE_PARAMETERS_START(1, 1)
325 Z_PARAM_FUNC(fci, fci_cache)
326 ZEND_PARSE_PARAMETERS_END();
327
328 zend_test_fiber *fiber = (zend_test_fiber *) Z_OBJ_P(ZEND_THIS);
329 zend_test_fiber *target = (zend_test_fiber *) zend_test_fiber_class->create_object(zend_test_fiber_class);
330
331 target->fci = fci;
332 target->fci_cache = fci_cache;
333 Z_TRY_ADDREF(target->fci.function_name);
334
335 target->previous = &fiber->context;
336
337 if (fiber->target) {
338 OBJ_RELEASE(&fiber->target->std);
339 }
340
341 fiber->target = target;
342
343 RETURN_OBJ_COPY(&target->std);
344 }
345
zend_test_fiber_init(void)346 void zend_test_fiber_init(void)
347 {
348 zend_test_fiber_class = register_class__ZendTestFiber();
349 zend_test_fiber_class->create_object = zend_test_fiber_object_create;
350 zend_test_fiber_class->default_object_handlers = &zend_test_fiber_handlers;
351
352 zend_test_fiber_handlers = std_object_handlers;
353 zend_test_fiber_handlers.dtor_obj = zend_test_fiber_object_destroy;
354 zend_test_fiber_handlers.free_obj = zend_test_fiber_object_free;
355 }
356
