Coverage Report

Created: 2025-12-14 06:09

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/php-src/Zend/zend_closures.c
Line
Count
Source
1
/*
2
   +----------------------------------------------------------------------+
3
   | Zend Engine                                                          |
4
   +----------------------------------------------------------------------+
5
   | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
6
   +----------------------------------------------------------------------+
7
   | This source file is subject to version 2.00 of the Zend license,     |
8
   | that is bundled with this package in the file LICENSE, and is        |
9
   | available through the world-wide-web at the following url:           |
10
   | http://www.zend.com/license/2_00.txt.                                |
11
   | If you did not receive a copy of the Zend license and are unable to  |
12
   | obtain it through the world-wide-web, please send a note to          |
13
   | license@zend.com so we can mail you a copy immediately.              |
14
   +----------------------------------------------------------------------+
15
   | Authors: Christian Seiler <chris_se@gmx.net>                         |
16
   |          Dmitry Stogov <dmitry@php.net>                              |
17
   |          Marcus Boerger <helly@php.net>                              |
18
   +----------------------------------------------------------------------+
19
*/
20
21
#include "zend.h"
22
#include "zend_API.h"
23
#include "zend_closures.h"
24
#include "zend_exceptions.h"
25
#include "zend_interfaces.h"
26
#include "zend_objects.h"
27
#include "zend_objects_API.h"
28
#include "zend_globals.h"
29
#include "zend_closures_arginfo.h"
30
31
typedef struct _zend_closure {
32
  zend_object       std;
33
  zend_function     func;
34
  zval              this_ptr;
35
  zend_class_entry *called_scope;
36
  zif_handler       orig_internal_handler;
37
} zend_closure;
38
39
/* non-static since it needs to be referenced */
40
ZEND_API zend_class_entry *zend_ce_closure;
41
static zend_object_handlers closure_handlers;
42
43
static zend_result zend_closure_get_closure(zend_object *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr, bool check_only);
44
45
ZEND_METHOD(Closure, __invoke) /* {{{ */
46
102
{
47
102
  zend_function *func = EX(func);
48
102
  zval *args;
49
102
  uint32_t num_args;
50
102
  HashTable *named_args;
51
52
306
  ZEND_PARSE_PARAMETERS_START(0, -1)
53
306
    Z_PARAM_VARIADIC_WITH_NAMED(args, num_args, named_args)
54
306
  ZEND_PARSE_PARAMETERS_END();
55
56
102
  zend_fcall_info_cache fcc = {
57
102
    .closure = Z_OBJ_P(ZEND_THIS),
58
102
  };
59
102
  zend_closure_get_closure(Z_OBJ_P(ZEND_THIS), &fcc.calling_scope, &fcc.function_handler, &fcc.object, false);
60
102
  fcc.called_scope = fcc.calling_scope;
61
102
  zend_call_known_fcc(&fcc, return_value, num_args, args, named_args);
62
63
  /* destruct the function also, then - we have allocated it in get_method */
64
102
  zend_string_release_ex(func->internal_function.function_name, 0);
65
102
  efree(func);
66
67
  /* Set the func pointer to NULL. Prior to PHP 8.3, this was only done for debug builds,
68
   * because debug builds check certain properties after the call and needed to know this
69
   * had been freed.
70
   * However, extensions can proxy zend_execute_internal, and it's a bit surprising to have
71
   * an invalid func pointer sitting on there, so this was changed in PHP 8.3.
72
   */
73
102
  execute_data->func = NULL;
74
102
}
75
/* }}} */
76
77
static bool zend_valid_closure_binding(
78
    zend_closure *closure, zval *newthis, zend_class_entry *scope) /* {{{ */
79
1.28k
{
80
1.28k
  zend_function *func = &closure->func;
81
1.28k
  bool is_fake_closure = (func->common.fn_flags & ZEND_ACC_FAKE_CLOSURE) != 0;
82
1.28k
  if (newthis) {
83
1.14k
    if (func->common.fn_flags & ZEND_ACC_STATIC) {
84
33
      zend_error(E_WARNING, "Cannot bind an instance to a static closure, this will be an error in PHP 9");
85
33
      return false;
86
33
    }
87
88
1.11k
    if (is_fake_closure && func->common.scope &&
89
36
        !instanceof_function(Z_OBJCE_P(newthis), func->common.scope)) {
90
      /* Binding incompatible $this to an internal method is not supported. */
91
6
      zend_error(E_WARNING, "Cannot bind method %s::%s() to object of class %s, this will be an error in PHP 9",
92
6
          ZSTR_VAL(func->common.scope->name),
93
6
          ZSTR_VAL(func->common.function_name),
94
6
          ZSTR_VAL(Z_OBJCE_P(newthis)->name));
95
6
      return false;
96
6
    }
97
1.11k
  } else if (is_fake_closure && func->common.scope
98
3
      && !(func->common.fn_flags & ZEND_ACC_STATIC)) {
99
3
    zend_error(E_WARNING, "Cannot unbind $this of method, this will be an error in PHP 9");
100
3
    return false;
101
132
  } else if (!is_fake_closure && !Z_ISUNDEF(closure->this_ptr)
102
21
      && (func->common.fn_flags & ZEND_ACC_USES_THIS)) {
103
18
    zend_error(E_WARNING, "Cannot unbind $this of closure using $this, this will be an error in PHP 9");
104
18
    return false;
105
18
  }
106
107
1.22k
  if (scope && scope != func->common.scope && scope->type == ZEND_INTERNAL_CLASS) {
108
    /* rebinding to internal class is not allowed */
109
294
    zend_error(E_WARNING, "Cannot bind closure to scope of internal class %s, this will be an error in PHP 9",
110
294
        ZSTR_VAL(scope->name));
111
294
    return false;
112
294
  }
113
114
930
  if (is_fake_closure && scope != func->common.scope) {
115
6
    if (func->common.scope == NULL) {
116
3
      zend_error(E_WARNING, "Cannot rebind scope of closure created from function, this will be an error in PHP 9");
117
3
    } else {
118
3
      zend_error(E_WARNING, "Cannot rebind scope of closure created from method, this will be an error in PHP 9");
119
3
    }
120
6
    return false;
121
6
  }
122
123
924
  return true;
124
930
}
125
/* }}} */
126
127
/* {{{ Call closure, binding to a given object with its class as the scope */
128
ZEND_METHOD(Closure, call)
129
972
{
130
972
  zval *newthis, closure_result;
131
972
  zend_closure *closure;
132
972
  zend_fcall_info fci;
133
972
  zend_fcall_info_cache fci_cache;
134
972
  zend_object *newobj;
135
972
  zend_class_entry *newclass;
136
137
972
  fci.param_count = 0;
138
972
  fci.params = NULL;
139
140
2.91k
  ZEND_PARSE_PARAMETERS_START(1, -1)
141
3.88k
    Z_PARAM_OBJECT(newthis)
142
969
    Z_PARAM_VARIADIC_WITH_NAMED(fci.params, fci.param_count, fci.named_params)
143
972
  ZEND_PARSE_PARAMETERS_END();
144
145
969
  closure = (zend_closure *) Z_OBJ_P(ZEND_THIS);
146
147
969
  newobj = Z_OBJ_P(newthis);
148
969
  newclass = newobj->ce;
149
150
969
  if (!zend_valid_closure_binding(closure, newthis, newclass)) {
151
300
    return;
152
300
  }
153
154
669
  fci_cache.called_scope = newclass;
155
669
  fci_cache.object = fci.object = newobj;
156
157
669
  fci.size = sizeof(fci);
158
669
  ZVAL_OBJ(&fci.function_name, &closure->std);
159
669
  ZVAL_UNDEF(&closure_result);
160
669
  fci.retval = &closure_result;
161
162
669
  if (closure->func.common.fn_flags & ZEND_ACC_GENERATOR) {
163
3
    zval new_closure;
164
3
    zend_create_closure(&new_closure, &closure->func, newclass, closure->called_scope, newthis);
165
3
    closure = (zend_closure *) Z_OBJ(new_closure);
166
3
    fci_cache.function_handler = &closure->func;
167
168
3
    zend_call_function(&fci, &fci_cache);
169
170
    /* copied upon generator creation */
171
3
    GC_DELREF(&closure->std);
172
666
  } else {
173
666
    zend_closure *fake_closure;
174
666
    zend_function *my_function;
175
176
666
    fake_closure = emalloc(sizeof(zend_closure));
177
666
    memset(&fake_closure->std, 0, sizeof(fake_closure->std));
178
666
    fake_closure->std.gc.refcount = 1;
179
666
    fake_closure->std.gc.u.type_info = GC_NULL;
180
666
    ZVAL_UNDEF(&fake_closure->this_ptr);
181
666
    fake_closure->called_scope = NULL;
182
666
    my_function = &fake_closure->func;
183
666
    if (ZEND_USER_CODE(closure->func.type)) {
184
660
      memcpy(my_function, &closure->func, sizeof(zend_op_array));
185
660
    } else {
186
6
      memcpy(my_function, &closure->func, sizeof(zend_internal_function));
187
6
    }
188
    /* use scope of passed object */
189
666
    my_function->common.scope = newclass;
190
666
    if (closure->func.type == ZEND_INTERNAL_FUNCTION) {
191
6
      my_function->internal_function.handler = closure->orig_internal_handler;
192
6
    }
193
666
    fci_cache.function_handler = my_function;
194
195
    /* Runtime cache relies on bound scope to be immutable, hence we need a separate rt cache in case scope changed */
196
666
    if (ZEND_USER_CODE(my_function->type)
197
660
     && (closure->func.common.scope != newclass
198
660
      || (closure->func.common.fn_flags & ZEND_ACC_HEAP_RT_CACHE))) {
199
660
      void *ptr;
200
201
660
      my_function->op_array.fn_flags |= ZEND_ACC_HEAP_RT_CACHE;
202
660
      ptr = emalloc(my_function->op_array.cache_size);
203
660
      ZEND_MAP_PTR_INIT(my_function->op_array.run_time_cache, ptr);
204
660
      memset(ptr, 0, my_function->op_array.cache_size);
205
660
    }
206
207
666
    zend_call_function(&fci, &fci_cache);
208
209
666
    if (ZEND_USER_CODE(my_function->type)) {
210
660
      if (fci_cache.function_handler->common.fn_flags & ZEND_ACC_HEAP_RT_CACHE) {
211
660
        efree(ZEND_MAP_PTR(my_function->op_array.run_time_cache));
212
660
      }
213
660
    }
214
666
    efree_size(fake_closure, sizeof(zend_closure));
215
666
  }
216
217
669
  if (Z_TYPE(closure_result) != IS_UNDEF) {
218
669
    if (Z_ISREF(closure_result)) {
219
3
      zend_unwrap_reference(&closure_result);
220
3
    }
221
669
    ZVAL_COPY_VALUE(return_value, &closure_result);
222
669
  }
223
669
}
224
/* }}} */
225
226
static void do_closure_bind(zval *return_value, zval *zclosure, zval *newthis, zend_object *scope_obj, zend_string *scope_str)
227
318
{
228
318
  zend_class_entry *ce, *called_scope;
229
318
  zend_closure *closure = (zend_closure *) Z_OBJ_P(zclosure);
230
231
318
  if (scope_obj) {
232
15
    ce = scope_obj->ce;
233
303
  } else if (scope_str) {
234
255
    if (zend_string_equals(scope_str, ZSTR_KNOWN(ZEND_STR_STATIC))) {
235
144
      ce = closure->func.common.scope;
236
144
    } else if ((ce = zend_lookup_class(scope_str)) == NULL) {
237
3
      zend_error(E_WARNING, "Class \"%s\" not found", ZSTR_VAL(scope_str));
238
3
      RETURN_NULL();
239
3
    }
240
255
  } else {
241
48
    ce = NULL;
242
48
  }
243
244
315
  if (!zend_valid_closure_binding(closure, newthis, ce)) {
245
60
    return;
246
60
  }
247
248
255
  if (newthis) {
249
141
    called_scope = Z_OBJCE_P(newthis);
250
141
  } else {
251
114
    called_scope = ce;
252
114
  }
253
254
255
  zend_create_closure(return_value, &closure->func, ce, called_scope, newthis);
255
255
}
256
257
/* {{{ Create a closure from another one and bind to another object and scope */
258
ZEND_METHOD(Closure, bind)
259
27
{
260
27
  zval *zclosure, *newthis;
261
27
  zend_object *scope_obj = NULL;
262
27
  zend_string *scope_str = ZSTR_KNOWN(ZEND_STR_STATIC);
263
264
81
  ZEND_PARSE_PARAMETERS_START(2, 3)
265
108
    Z_PARAM_OBJECT_OF_CLASS(zclosure, zend_ce_closure)
266
135
    Z_PARAM_OBJECT_OR_NULL(newthis)
267
27
    Z_PARAM_OPTIONAL
268
126
    Z_PARAM_OBJ_OR_STR_OR_NULL(scope_obj, scope_str)
269
126
  ZEND_PARSE_PARAMETERS_END();
270
271
27
  do_closure_bind(return_value, zclosure, newthis, scope_obj, scope_str);
272
27
}
273
274
/* {{{ Create a closure from another one and bind to another object and scope */
275
ZEND_METHOD(Closure, bindTo)
276
294
{
277
294
  zval *newthis;
278
294
  zend_object *scope_obj = NULL;
279
294
  zend_string *scope_str = ZSTR_KNOWN(ZEND_STR_STATIC);
280
281
882
  ZEND_PARSE_PARAMETERS_START(1, 2)
282
1.17k
    Z_PARAM_OBJECT_OR_NULL(newthis)
283
294
    Z_PARAM_OPTIONAL
284
1.08k
    Z_PARAM_OBJ_OR_STR_OR_NULL(scope_obj, scope_str)
285
1.08k
  ZEND_PARSE_PARAMETERS_END();
286
287
291
  do_closure_bind(return_value, ZEND_THIS, newthis, scope_obj, scope_str);
288
291
}
289
290
static void zend_copy_parameters_array(const uint32_t param_count, HashTable *argument_array) /* {{{ */
291
69
{
292
69
  zval *param_ptr = ZEND_CALL_ARG(EG(current_execute_data), 1);
293
294
69
  ZEND_ASSERT(param_count <= ZEND_CALL_NUM_ARGS(EG(current_execute_data)));
295
296
213
  for (uint32_t i = 0; i < param_count; i++) {
297
144
    Z_TRY_ADDREF_P(param_ptr);
298
144
    zend_hash_next_index_insert_new(argument_array, param_ptr);
299
144
    param_ptr++;
300
144
  }
301
69
}
302
303
102
static ZEND_NAMED_FUNCTION(zend_closure_call_magic) /* {{{ */ {
304
102
  zend_fcall_info fci;
305
102
  zend_fcall_info_cache fcc;
306
102
  zval params[2];
307
308
102
  memset(&fci, 0, sizeof(zend_fcall_info));
309
102
  memset(&fcc, 0, sizeof(zend_fcall_info_cache));
310
311
102
  fci.size = sizeof(zend_fcall_info);
312
102
  fci.retval = return_value;
313
314
102
  fcc.function_handler = (EX(func)->internal_function.fn_flags & ZEND_ACC_STATIC) ?
315
78
    EX(func)->internal_function.scope->__callstatic : EX(func)->internal_function.scope->__call;
316
102
  fci.named_params = NULL;
317
102
  fci.params = params;
318
102
  fci.param_count = 2;
319
102
  ZVAL_STR(&fci.params[0], EX(func)->common.function_name);
320
102
  if (EX_CALL_INFO() & ZEND_CALL_HAS_EXTRA_NAMED_PARAMS) {
321
21
    zend_string *name;
322
21
    zval *named_param_zval;
323
21
    array_init_size(&fci.params[1], ZEND_NUM_ARGS() + zend_hash_num_elements(EX(extra_named_params)));
324
    /* Avoid conversion from packed to mixed later. */
325
21
    zend_hash_real_init_mixed(Z_ARRVAL(fci.params[1]));
326
21
    zend_copy_parameters_array(ZEND_NUM_ARGS(), Z_ARRVAL(fci.params[1]));
327
126
    ZEND_HASH_MAP_FOREACH_STR_KEY_VAL(EX(extra_named_params), name, named_param_zval) {
328
126
      Z_TRY_ADDREF_P(named_param_zval);
329
126
      zend_hash_add_new(Z_ARRVAL(fci.params[1]), name, named_param_zval);
330
126
    } ZEND_HASH_FOREACH_END();
331
81
  } else if (ZEND_NUM_ARGS()) {
332
48
    array_init_size(&fci.params[1], ZEND_NUM_ARGS());
333
48
    zend_copy_parameters_array(ZEND_NUM_ARGS(), Z_ARRVAL(fci.params[1]));
334
48
  } else {
335
33
    ZVAL_EMPTY_ARRAY(&fci.params[1]);
336
33
  }
337
338
102
  fcc.object = fci.object = Z_OBJ_P(ZEND_THIS);
339
102
  fcc.called_scope = zend_get_called_scope(EG(current_execute_data));
340
341
102
  zend_call_function(&fci, &fcc);
342
343
102
  zval_ptr_dtor(&fci.params[1]);
344
102
}
345
/* }}} */
346
347
348
static zend_result zend_create_closure_from_callable(zval *return_value, zval *callable, char **error) /* {{{ */ {
348
348
  zend_fcall_info_cache fcc;
349
348
  zend_function *mptr;
350
348
  zval instance;
351
348
  zend_internal_function call;
352
353
348
  if (!zend_is_callable_ex(callable, NULL, 0, NULL, &fcc, error)) {
354
72
    return FAILURE;
355
72
  }
356
357
276
  mptr = fcc.function_handler;
358
276
  if (mptr->common.fn_flags & ZEND_ACC_CALL_VIA_TRAMPOLINE) {
359
    /* For Closure::fromCallable([$closure, "__invoke"]) return $closure. */
360
72
    if (fcc.object && fcc.object->ce == zend_ce_closure
361
33
        && zend_string_equals(mptr->common.function_name, ZSTR_KNOWN(ZEND_STR_MAGIC_INVOKE))) {
362
33
      RETVAL_OBJ_COPY(fcc.object);
363
33
      zend_free_trampoline(mptr);
364
33
      return SUCCESS;
365
33
    }
366
367
39
    if (!mptr->common.scope) {
368
0
      return FAILURE;
369
0
    }
370
39
    if (mptr->common.fn_flags & ZEND_ACC_STATIC) {
371
3
      if (!mptr->common.scope->__callstatic) {
372
0
        return FAILURE;
373
0
      }
374
36
    } else {
375
36
      if (!mptr->common.scope->__call) {
376
0
        return FAILURE;
377
0
      }
378
36
    }
379
380
39
    memset(&call, 0, sizeof(zend_internal_function));
381
39
    call.type = ZEND_INTERNAL_FUNCTION;
382
39
    call.fn_flags = mptr->common.fn_flags & (ZEND_ACC_STATIC | ZEND_ACC_DEPRECATED);
383
39
    call.handler = zend_closure_call_magic;
384
39
    call.function_name = mptr->common.function_name;
385
39
    call.scope = mptr->common.scope;
386
39
    call.doc_comment = NULL;
387
39
    call.attributes = mptr->common.attributes;
388
389
39
    zend_free_trampoline(mptr);
390
39
    mptr = (zend_function *) &call;
391
39
  }
392
393
243
  if (fcc.object) {
394
123
    ZVAL_OBJ(&instance, fcc.object);
395
123
    zend_create_fake_closure(return_value, mptr, mptr->common.scope, fcc.called_scope, &instance);
396
123
  } else {
397
120
    zend_create_fake_closure(return_value, mptr, mptr->common.scope, fcc.called_scope, NULL);
398
120
  }
399
400
243
  if (&mptr->internal_function == &call) {
401
39
    zend_string_release(mptr->common.function_name);
402
39
  }
403
404
243
  return SUCCESS;
405
276
}
406
/* }}} */
407
408
/* {{{ Create a closure from a callable using the current scope. */
409
ZEND_METHOD(Closure, fromCallable)
410
351
{
411
351
  zval *callable;
412
351
  char *error = NULL;
413
414
1.05k
  ZEND_PARSE_PARAMETERS_START(1, 1)
415
1.40k
    Z_PARAM_ZVAL(callable)
416
1.40k
  ZEND_PARSE_PARAMETERS_END();
417
418
351
  if (Z_TYPE_P(callable) == IS_OBJECT && instanceof_function(Z_OBJCE_P(callable), zend_ce_closure)) {
419
    /* It's already a closure */
420
3
    RETURN_COPY(callable);
421
3
  }
422
423
348
  if (zend_create_closure_from_callable(return_value, callable, &error) == FAILURE) {
424
72
    if (error) {
425
72
      zend_type_error("Failed to create closure from callable: %s", error);
426
72
      efree(error);
427
72
    } else {
428
0
      zend_type_error("Failed to create closure from callable");
429
0
    }
430
72
  }
431
348
}
432
/* }}} */
433
434
ZEND_METHOD(Closure, getCurrent)
435
36
{
436
36
  ZEND_PARSE_PARAMETERS_NONE();
437
438
36
  zend_execute_data *prev_ex = EX(prev_execute_data);
439
440
36
  if (!prev_ex
441
36
   || !prev_ex->func
442
36
   || (prev_ex->func->common.fn_flags & (ZEND_ACC_CLOSURE|ZEND_ACC_FAKE_CLOSURE)) != ZEND_ACC_CLOSURE) {
443
6
      zend_throw_error(NULL, "Current function is not a closure");
444
6
      RETURN_THROWS();
445
6
  }
446
447
30
  zend_object *obj = ZEND_CLOSURE_OBJECT(prev_ex->func);
448
30
  RETURN_OBJ_COPY(obj);
449
30
}
450
451
static ZEND_COLD zend_function *zend_closure_get_constructor(zend_object *object) /* {{{ */
452
4
{
453
4
  zend_throw_error(NULL, "Instantiation of class Closure is not allowed");
454
4
  return NULL;
455
4
}
456
/* }}} */
457
458
/* int return due to Object Handler API */
459
static int zend_closure_compare(zval *o1, zval *o2) /* {{{ */
460
102
{
461
102
  ZEND_COMPARE_OBJECTS_FALLBACK(o1, o2);
462
463
102
  zend_closure *lhs = (zend_closure*) Z_OBJ_P(o1);
464
102
  zend_closure *rhs = (zend_closure*) Z_OBJ_P(o2);
465
466
102
  if (!((lhs->func.common.fn_flags & ZEND_ACC_FAKE_CLOSURE) && (rhs->func.common.fn_flags & ZEND_ACC_FAKE_CLOSURE))) {
467
0
    return ZEND_UNCOMPARABLE;
468
0
  }
469
470
102
  if (Z_TYPE(lhs->this_ptr) != Z_TYPE(rhs->this_ptr)) {
471
3
    return ZEND_UNCOMPARABLE;
472
3
  }
473
474
99
  if (Z_TYPE(lhs->this_ptr) == IS_OBJECT && Z_OBJ(lhs->this_ptr) != Z_OBJ(rhs->this_ptr)) {
475
21
    return ZEND_UNCOMPARABLE;
476
21
  }
477
478
78
  if (lhs->called_scope != rhs->called_scope) {
479
9
    return ZEND_UNCOMPARABLE;
480
9
  }
481
482
69
  if (lhs->func.type != rhs->func.type) {
483
0
    return ZEND_UNCOMPARABLE;
484
0
  }
485
486
69
  if (lhs->func.common.scope != rhs->func.common.scope) {
487
0
    return ZEND_UNCOMPARABLE;
488
0
  }
489
490
69
  if (!zend_string_equals(lhs->func.common.function_name, rhs->func.common.function_name)) {
491
27
    return ZEND_UNCOMPARABLE;
492
27
  }
493
494
42
  return 0;
495
69
}
496
/* }}} */
497
498
ZEND_API zend_function *zend_get_closure_invoke_method(zend_object *object) /* {{{ */
499
225
{
500
225
  zend_closure *closure = (zend_closure *)object;
501
225
  zend_function *invoke = (zend_function*)emalloc(sizeof(zend_function));
502
225
  const uint32_t keep_flags =
503
225
    ZEND_ACC_RETURN_REFERENCE | ZEND_ACC_VARIADIC | ZEND_ACC_HAS_RETURN_TYPE | ZEND_ACC_DEPRECATED;
504
505
225
  invoke->common = closure->func.common;
506
  /* We return ZEND_INTERNAL_FUNCTION, but arg_info representation is the
507
   * same as for ZEND_USER_FUNCTION (uses zend_string* instead of char*).
508
   * This is not a problem, because ZEND_ACC_HAS_TYPE_HINTS is never set,
509
   * and we won't check arguments on internal function. We also set
510
   * ZEND_ACC_USER_ARG_INFO flag to prevent invalid usage by Reflection */
511
225
  invoke->type = ZEND_INTERNAL_FUNCTION;
512
225
  invoke->internal_function.fn_flags =
513
225
    ZEND_ACC_PUBLIC | ZEND_ACC_CALL_VIA_HANDLER | (closure->func.common.fn_flags & keep_flags);
514
225
  if (closure->func.type != ZEND_INTERNAL_FUNCTION || (closure->func.common.fn_flags & ZEND_ACC_USER_ARG_INFO)) {
515
180
    invoke->internal_function.fn_flags |=
516
180
      ZEND_ACC_USER_ARG_INFO;
517
180
  }
518
225
  invoke->internal_function.handler = ZEND_MN(Closure___invoke);
519
225
  invoke->internal_function.doc_comment = NULL;
520
225
  invoke->internal_function.module = 0;
521
225
  invoke->internal_function.scope = zend_ce_closure;
522
225
  invoke->internal_function.function_name = ZSTR_KNOWN(ZEND_STR_MAGIC_INVOKE);
523
225
  return invoke;
524
225
}
525
/* }}} */
526
527
ZEND_API const zend_function *zend_get_closure_method_def(zend_object *obj) /* {{{ */
528
309
{
529
309
  zend_closure *closure = (zend_closure *) obj;
530
309
  return &closure->func;
531
309
}
532
/* }}} */
533
534
ZEND_API zval* zend_get_closure_this_ptr(zval *obj) /* {{{ */
535
6
{
536
6
  zend_closure *closure = (zend_closure *)Z_OBJ_P(obj);
537
6
  return &closure->this_ptr;
538
6
}
539
/* }}} */
540
541
static zend_function *zend_closure_get_method(zend_object **object, zend_string *method, const zval *key) /* {{{ */
542
1.25k
{
543
1.25k
  if (zend_string_equals_literal_ci(method, ZEND_INVOKE_FUNC_NAME)) {
544
213
    return zend_get_closure_invoke_method(*object);
545
213
  }
546
547
1.04k
  return zend_std_get_method(object, method, key);
548
1.25k
}
549
/* }}} */
550
551
static void zend_closure_free_storage(zend_object *object) /* {{{ */
552
7.14k
{
553
7.14k
  zend_closure *closure = (zend_closure *)object;
554
555
7.14k
  zend_object_std_dtor(&closure->std);
556
557
7.14k
  if (closure->func.type == ZEND_USER_FUNCTION) {
558
    /* We don't own the static variables of fake closures. */
559
6.81k
    if (!(closure->func.op_array.fn_flags & ZEND_ACC_FAKE_CLOSURE)) {
560
6.46k
      zend_destroy_static_vars(&closure->func.op_array);
561
6.46k
    }
562
6.81k
    destroy_op_array(&closure->func.op_array);
563
6.81k
  } else if (closure->func.type == ZEND_INTERNAL_FUNCTION) {
564
324
    zend_string_release(closure->func.common.function_name);
565
324
  }
566
567
7.14k
  if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
568
1.63k
    zval_ptr_dtor(&closure->this_ptr);
569
1.63k
  }
570
7.14k
}
571
/* }}} */
572
573
static zend_object *zend_closure_new(zend_class_entry *class_type) /* {{{ */
574
7.14k
{
575
7.14k
  zend_closure *closure;
576
577
7.14k
  closure = emalloc(sizeof(zend_closure));
578
7.14k
  memset(closure, 0, sizeof(zend_closure));
579
580
7.14k
  zend_object_std_init(&closure->std, class_type);
581
582
7.14k
  return (zend_object*)closure;
583
7.14k
}
584
/* }}} */
585
586
static zend_object *zend_closure_clone(zend_object *zobject) /* {{{ */
587
12
{
588
12
  zend_closure *closure = (zend_closure *)zobject;
589
12
  zval result;
590
591
12
  zend_create_closure(&result, &closure->func,
592
12
    closure->func.common.scope, closure->called_scope, &closure->this_ptr);
593
12
  return Z_OBJ(result);
594
12
}
595
/* }}} */
596
597
static zend_result zend_closure_get_closure(zend_object *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr, bool check_only) /* {{{ */
598
8.02k
{
599
8.02k
  zend_closure *closure = (zend_closure*)obj;
600
601
8.02k
  *fptr_ptr = &closure->func;
602
8.02k
  *ce_ptr = closure->called_scope;
603
604
8.02k
  if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
605
804
    *obj_ptr = Z_OBJ(closure->this_ptr);
606
7.22k
  } else {
607
7.22k
    *obj_ptr = NULL;
608
7.22k
  }
609
610
8.02k
  return SUCCESS;
611
8.02k
}
612
/* }}} */
613
614
/* *is_temp is int due to Object Handler API */
615
static HashTable *zend_closure_get_debug_info(zend_object *object, int *is_temp) /* {{{ */
616
903
{
617
903
  zend_closure *closure = (zend_closure *)object;
618
903
  zval val;
619
903
  struct _zend_arg_info *arg_info = closure->func.common.arg_info;
620
903
  HashTable *debug_info;
621
903
  bool zstr_args = (closure->func.type == ZEND_USER_FUNCTION) || (closure->func.common.fn_flags & ZEND_ACC_USER_ARG_INFO);
622
623
903
  *is_temp = 1;
624
625
903
  debug_info = zend_new_array(8);
626
627
903
  if (closure->func.op_array.fn_flags & ZEND_ACC_FAKE_CLOSURE) {
628
129
    if (closure->func.common.scope) {
629
33
      zend_string *class_name = closure->func.common.scope->name;
630
33
      zend_string *func_name = closure->func.common.function_name;
631
33
      zend_string *combined = zend_string_concat3(
632
33
        ZSTR_VAL(class_name), ZSTR_LEN(class_name),
633
33
        "::", strlen("::"),
634
33
        ZSTR_VAL(func_name), ZSTR_LEN(func_name)
635
33
      );
636
33
      ZVAL_STR(&val, combined);
637
96
    } else {
638
96
      ZVAL_STR_COPY(&val, closure->func.common.function_name);
639
96
    }
640
129
    zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_FUNCTION), &val);
641
774
  } else {
642
774
    ZVAL_STR_COPY(&val, closure->func.common.function_name);
643
774
    zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_NAME), &val);
644
645
774
    ZVAL_STR_COPY(&val, closure->func.op_array.filename);
646
774
    zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_FILE), &val);
647
648
774
    ZVAL_LONG(&val, closure->func.op_array.line_start);
649
774
    zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_LINE), &val);
650
774
  }
651
652
903
  if (closure->func.type == ZEND_USER_FUNCTION && closure->func.op_array.static_variables) {
653
78
    zval *var;
654
78
    zend_string *key;
655
78
    HashTable *static_variables = ZEND_MAP_PTR_GET(closure->func.op_array.static_variables_ptr);
656
657
78
    array_init(&val);
658
659
330
    ZEND_HASH_MAP_FOREACH_STR_KEY_VAL(static_variables, key, var) {
660
330
      zval copy;
661
662
330
      if (Z_ISREF_P(var) && Z_REFCOUNT_P(var) == 1) {
663
21
        var = Z_REFVAL_P(var);
664
21
      }
665
330
      ZVAL_COPY(&copy, var);
666
667
330
      zend_hash_add_new(Z_ARRVAL(val), key, &copy);
668
330
    } ZEND_HASH_FOREACH_END();
669
670
78
    if (zend_hash_num_elements(Z_ARRVAL(val))) {
671
63
      zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_STATIC), &val);
672
63
    } else {
673
15
      zval_ptr_dtor(&val);
674
15
    }
675
78
  }
676
677
903
  if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
678
633
    Z_ADDREF(closure->this_ptr);
679
633
    zend_hash_update(debug_info, ZSTR_KNOWN(ZEND_STR_THIS), &closure->this_ptr);
680
633
  }
681
682
903
  if (arg_info &&
683
117
    (closure->func.common.num_args ||
684
114
     (closure->func.common.fn_flags & ZEND_ACC_VARIADIC))) {
685
114
    uint32_t i, num_args, required = closure->func.common.required_num_args;
686
687
114
    array_init(&val);
688
689
114
    num_args = closure->func.common.num_args;
690
114
    if (closure->func.common.fn_flags & ZEND_ACC_VARIADIC) {
691
15
      num_args++;
692
15
    }
693
243
    for (i = 0; i < num_args; i++) {
694
129
      zend_string *name;
695
129
      zval info;
696
129
      ZEND_ASSERT(arg_info->name && "Argument should have name");
697
129
      if (zstr_args) {
698
36
        name = zend_strpprintf(0, "%s$%s",
699
36
            ZEND_ARG_SEND_MODE(arg_info) ? "&" : "",
700
36
            ZSTR_VAL(arg_info->name));
701
93
      } else {
702
93
        name = zend_strpprintf(0, "%s$%s",
703
93
            ZEND_ARG_SEND_MODE(arg_info) ? "&" : "",
704
93
            ((zend_internal_arg_info*)arg_info)->name);
705
93
      }
706
129
      ZVAL_NEW_STR(&info, zend_strpprintf(0, "%s", i >= required ? "<optional>" : "<required>"));
707
129
      zend_hash_update(Z_ARRVAL(val), name, &info);
708
129
      zend_string_release_ex(name, 0);
709
129
      arg_info++;
710
129
    }
711
114
    zend_hash_str_update(debug_info, "parameter", sizeof("parameter")-1, &val);
712
114
  }
713
714
903
  return debug_info;
715
903
}
716
/* }}} */
717
718
static HashTable *zend_closure_get_gc(zend_object *obj, zval **table, int *n) /* {{{ */
719
6.62k
{
720
6.62k
  zend_closure *closure = (zend_closure *)obj;
721
722
6.62k
  *table = Z_TYPE(closure->this_ptr) != IS_NULL ? &closure->this_ptr : NULL;
723
6.62k
  *n = Z_TYPE(closure->this_ptr) != IS_NULL ? 1 : 0;
724
  /* Fake closures don't own the static variables they reference. */
725
6.62k
  return (closure->func.type == ZEND_USER_FUNCTION
726
6.50k
      && !(closure->func.op_array.fn_flags & ZEND_ACC_FAKE_CLOSURE)) ?
727
6.62k
    ZEND_MAP_PTR_GET(closure->func.op_array.static_variables_ptr) : NULL;
728
6.62k
}
729
/* }}} */
730
731
/* {{{ Private constructor preventing instantiation */
732
ZEND_COLD ZEND_METHOD(Closure, __construct)
733
0
{
734
0
  zend_throw_error(NULL, "Instantiation of class Closure is not allowed");
735
0
}
736
/* }}} */
737
738
void zend_register_closure_ce(void) /* {{{ */
739
2
{
740
2
  zend_ce_closure = register_class_Closure();
741
2
  zend_ce_closure->create_object = zend_closure_new;
742
2
  zend_ce_closure->default_object_handlers = &closure_handlers;
743
744
2
  memcpy(&closure_handlers, &std_object_handlers, sizeof(zend_object_handlers));
745
2
  closure_handlers.free_obj = zend_closure_free_storage;
746
2
  closure_handlers.get_constructor = zend_closure_get_constructor;
747
2
  closure_handlers.get_method = zend_closure_get_method;
748
2
  closure_handlers.compare = zend_closure_compare;
749
2
  closure_handlers.clone_obj = zend_closure_clone;
750
2
  closure_handlers.get_debug_info = zend_closure_get_debug_info;
751
2
  closure_handlers.get_closure = zend_closure_get_closure;
752
2
  closure_handlers.get_gc = zend_closure_get_gc;
753
2
}
754
/* }}} */
755
756
static ZEND_NAMED_FUNCTION(zend_closure_internal_handler) /* {{{ */
757
219
{
758
219
  zend_closure *closure = (zend_closure*)ZEND_CLOSURE_OBJECT(EX(func));
759
219
  closure->orig_internal_handler(INTERNAL_FUNCTION_PARAM_PASSTHRU);
760
  // Assign to EX(this) so that it is released after observer checks etc.
761
219
  ZEND_ADD_CALL_FLAG(execute_data, ZEND_CALL_RELEASE_THIS);
762
219
  Z_OBJ(EX(This)) = &closure->std;
763
219
}
764
/* }}} */
765
766
static void zend_create_closure_ex(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zval *this_ptr, bool is_fake) /* {{{ */
767
7.14k
{
768
7.14k
  zend_closure *closure;
769
7.14k
  void *ptr;
770
771
7.14k
  object_init_ex(res, zend_ce_closure);
772
773
7.14k
  closure = (zend_closure *)Z_OBJ_P(res);
774
775
7.14k
  if ((scope == NULL) && this_ptr && (Z_TYPE_P(this_ptr) != IS_UNDEF)) {
776
    /* use dummy scope if we're binding an object without specifying a scope */
777
    /* maybe it would be better to create one for this purpose */
778
42
    scope = zend_ce_closure;
779
42
  }
780
781
7.14k
  if (func->type == ZEND_USER_FUNCTION) {
782
6.81k
    memcpy(&closure->func, func, sizeof(zend_op_array));
783
6.81k
    closure->func.common.fn_flags |= ZEND_ACC_CLOSURE;
784
6.81k
    closure->func.common.fn_flags &= ~ZEND_ACC_IMMUTABLE;
785
786
6.81k
    zend_string_addref(closure->func.op_array.function_name);
787
6.81k
    if (closure->func.op_array.refcount) {
788
21
      (*closure->func.op_array.refcount)++;
789
21
    }
790
791
    /* For fake closures, we want to reuse the static variables of the original function. */
792
6.81k
    HashTable *ht = ZEND_MAP_PTR_GET(func->op_array.static_variables_ptr);
793
6.81k
    if (!is_fake) {
794
6.46k
      if (!ht) {
795
6.44k
        ht = closure->func.op_array.static_variables;
796
6.44k
      }
797
6.46k
      ZEND_MAP_PTR_INIT(closure->func.op_array.static_variables_ptr,
798
6.46k
        ht ? zend_array_dup(ht) : NULL);
799
6.46k
    } else if (func->op_array.static_variables) {
800
48
      if (!ht) {
801
21
        ht = zend_array_dup(func->op_array.static_variables);
802
21
        ZEND_MAP_PTR_SET(func->op_array.static_variables_ptr, ht);
803
21
      }
804
48
      ZEND_MAP_PTR_INIT(closure->func.op_array.static_variables_ptr, ht);
805
48
    }
806
807
    /* Runtime cache is scope-dependent, so we cannot reuse it if the scope changed */
808
6.81k
    ptr = ZEND_MAP_PTR_GET(func->op_array.run_time_cache);
809
6.81k
    if (!ptr
810
1.20k
      || func->common.scope != scope
811
1.05k
      || (func->common.fn_flags & ZEND_ACC_HEAP_RT_CACHE)
812
6.81k
    ) {
813
5.83k
      if (!ptr
814
5.61k
       && (func->common.fn_flags & ZEND_ACC_CLOSURE)
815
5.46k
       && (func->common.scope == scope ||
816
4.05k
           !(func->common.fn_flags & ZEND_ACC_IMMUTABLE))) {
817
        /* If a real closure is used for the first time, we create a shared runtime cache
818
         * and remember which scope it is for. */
819
4.05k
        if (func->common.scope != scope) {
820
0
          func->common.scope = scope;
821
0
        }
822
4.05k
        ptr = zend_arena_alloc(&CG(arena), func->op_array.cache_size);
823
4.05k
        ZEND_MAP_PTR_SET(func->op_array.run_time_cache, ptr);
824
4.05k
        closure->func.op_array.fn_flags &= ~ZEND_ACC_HEAP_RT_CACHE;
825
4.05k
      } else {
826
        /* Otherwise, we use a non-shared runtime cache */
827
1.77k
        ptr = emalloc(func->op_array.cache_size);
828
1.77k
        closure->func.op_array.fn_flags |= ZEND_ACC_HEAP_RT_CACHE;
829
1.77k
      }
830
5.83k
      memset(ptr, 0, func->op_array.cache_size);
831
5.83k
    }
832
6.81k
    ZEND_MAP_PTR_INIT(closure->func.op_array.run_time_cache, ptr);
833
6.81k
  } else {
834
324
    memcpy(&closure->func, func, sizeof(zend_internal_function));
835
324
    closure->func.common.fn_flags |= ZEND_ACC_CLOSURE;
836
    /* wrap internal function handler to avoid memory leak */
837
324
    if (UNEXPECTED(closure->func.internal_function.handler == zend_closure_internal_handler)) {
838
      /* avoid infinity recursion, by taking handler from nested closure */
839
15
      zend_closure *nested = (zend_closure*)((char*)func - XtOffsetOf(zend_closure, func));
840
15
      ZEND_ASSERT(nested->std.ce == zend_ce_closure);
841
15
      closure->orig_internal_handler = nested->orig_internal_handler;
842
309
    } else {
843
309
      closure->orig_internal_handler = closure->func.internal_function.handler;
844
309
    }
845
324
    closure->func.internal_function.handler = zend_closure_internal_handler;
846
324
    zend_string_addref(closure->func.op_array.function_name);
847
324
    if (!func->common.scope) {
848
      /* if it's a free function, we won't set scope & this since they're meaningless */
849
183
      this_ptr = NULL;
850
183
      scope = NULL;
851
183
    }
852
324
  }
853
854
7.14k
  ZVAL_UNDEF(&closure->this_ptr);
855
  /* Invariant:
856
   * If the closure is unscoped or static, it has no bound object. */
857
7.14k
  closure->func.common.scope = scope;
858
7.14k
  closure->called_scope = called_scope;
859
7.14k
  if (scope) {
860
1.98k
    closure->func.common.fn_flags |= ZEND_ACC_PUBLIC;
861
1.98k
    if (this_ptr && Z_TYPE_P(this_ptr) == IS_OBJECT && (closure->func.common.fn_flags & ZEND_ACC_STATIC) == 0) {
862
1.63k
      ZVAL_OBJ_COPY(&closure->this_ptr, Z_OBJ_P(this_ptr));
863
1.63k
    }
864
1.98k
  }
865
7.14k
}
866
/* }}} */
867
868
ZEND_API void zend_create_closure(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zval *this_ptr)
869
6.49k
{
870
6.49k
  zend_create_closure_ex(res, func, scope, called_scope, this_ptr,
871
6.49k
    /* is_fake */ (func->common.fn_flags & ZEND_ACC_FAKE_CLOSURE) != 0);
872
6.49k
}
873
874
ZEND_API void zend_create_fake_closure(zval *res, zend_function *func, zend_class_entry *scope, zend_class_entry *called_scope, zval *this_ptr) /* {{{ */
875
651
{
876
651
  zend_closure *closure;
877
878
651
  zend_create_closure_ex(res, func, scope, called_scope, this_ptr, /* is_fake */ true);
879
880
651
  closure = (zend_closure *)Z_OBJ_P(res);
881
651
  closure->func.common.fn_flags |= ZEND_ACC_FAKE_CLOSURE;
882
651
  if (Z_TYPE(closure->this_ptr) != IS_OBJECT) {
883
438
    GC_ADD_FLAGS(&closure->std, GC_NOT_COLLECTABLE);
884
438
  }
885
651
}
886
/* }}} */
887
888
/* __call and __callStatic name the arguments "$arguments" in the docs. */
889
static zend_internal_arg_info trampoline_arg_info[] = {ZEND_ARG_VARIADIC_TYPE_INFO(false, arguments, IS_MIXED, false)};
890
891
276
void zend_closure_from_frame(zval *return_value, const zend_execute_data *call) { /* {{{ */
892
276
  zval instance;
893
276
  zend_internal_function trampoline;
894
276
  zend_function *mptr = call->func;
895
896
276
  if (ZEND_CALL_INFO(call) & ZEND_CALL_CLOSURE) {
897
3
    RETURN_OBJ(ZEND_CLOSURE_OBJECT(mptr));
898
3
  }
899
900
273
  if (mptr->common.fn_flags & ZEND_ACC_CALL_VIA_TRAMPOLINE) {
901
78
    if ((ZEND_CALL_INFO(call) & ZEND_CALL_HAS_THIS) &&
902
54
      (Z_OBJCE(call->This) == zend_ce_closure)
903
6
      && zend_string_equals(mptr->common.function_name, ZSTR_KNOWN(ZEND_STR_MAGIC_INVOKE))) {
904
6
          zend_free_trampoline(mptr);
905
6
          RETURN_OBJ_COPY(Z_OBJ(call->This));
906
6
      }
907
908
72
    memset(&trampoline, 0, sizeof(zend_internal_function));
909
72
    trampoline.type = ZEND_INTERNAL_FUNCTION;
910
72
    trampoline.fn_flags = mptr->common.fn_flags & (ZEND_ACC_STATIC | ZEND_ACC_VARIADIC | ZEND_ACC_RETURN_REFERENCE | ZEND_ACC_DEPRECATED);
911
72
    trampoline.handler = zend_closure_call_magic;
912
72
    trampoline.function_name = mptr->common.function_name;
913
72
    trampoline.scope = mptr->common.scope;
914
72
    trampoline.doc_comment = NULL;
915
72
    if (trampoline.fn_flags & ZEND_ACC_VARIADIC) {
916
72
      trampoline.arg_info = trampoline_arg_info;
917
72
    }
918
72
    trampoline.attributes = mptr->common.attributes;
919
920
72
    zend_free_trampoline(mptr);
921
72
    mptr = (zend_function *) &trampoline;
922
72
  }
923
924
267
  if (ZEND_CALL_INFO(call) & ZEND_CALL_HAS_THIS) {
925
81
    ZVAL_OBJ(&instance, Z_OBJ(call->This));
926
927
81
    zend_create_fake_closure(return_value, mptr, mptr->common.scope, Z_OBJCE(instance), &instance);
928
186
  } else {
929
186
    zend_create_fake_closure(return_value, mptr, mptr->common.scope, Z_CE(call->This), NULL);
930
186
  }
931
932
267
  if (&mptr->internal_function == &trampoline) {
933
72
    zend_string_release(mptr->common.function_name);
934
72
  }
935
267
} /* }}} */
936
937
void zend_closure_bind_var(zval *closure_zv, zend_string *var_name, zval *var) /* {{{ */
938
0
{
939
0
  zend_closure *closure = (zend_closure *) Z_OBJ_P(closure_zv);
940
0
  HashTable *static_variables = ZEND_MAP_PTR_GET(closure->func.op_array.static_variables_ptr);
941
0
  zend_hash_update(static_variables, var_name, var);
942
0
}
943
/* }}} */
944
945
void zend_closure_bind_var_ex(zval *closure_zv, uint32_t offset, zval *val) /* {{{ */
946
2.85k
{
947
2.85k
  zend_closure *closure = (zend_closure *) Z_OBJ_P(closure_zv);
948
2.85k
  HashTable *static_variables = ZEND_MAP_PTR_GET(closure->func.op_array.static_variables_ptr);
949
2.85k
  zval *var = (zval*)((char*)static_variables->arData + offset);
950
2.85k
  zval_ptr_dtor(var);
951
2.85k
  ZVAL_COPY_VALUE(var, val);
952
2.85k
}
953
/* }}} */