Coverage Report

Created: 2026-02-14 06:52

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