Coverage Report

Created: 2026-04-01 06:49

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