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