Coverage Report

Created: 2026-09-14 06:25

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/php-src/Zend/Optimizer/optimize_func_calls.c
Line
Count
Source
1
/*
2
   +----------------------------------------------------------------------+
3
   | Zend OPcache                                                         |
4
   +----------------------------------------------------------------------+
5
   | Copyright © The PHP Group and Contributors.                          |
6
   +----------------------------------------------------------------------+
7
   | This source file is subject to the Modified BSD License that is      |
8
   | bundled with this package in the file LICENSE, and is available      |
9
   | through the World Wide Web at <https://www.php.net/license/>.        |
10
   |                                                                      |
11
   | SPDX-License-Identifier: BSD-3-Clause                                |
12
   +----------------------------------------------------------------------+
13
   | Authors: Dmitry Stogov <dmitry@php.net>                              |
14
   |          Xinchen Hui <laruence@php.net>                              |
15
   +----------------------------------------------------------------------+
16
*/
17
18
/* pass 4
19
 * - optimize INIT_FCALL_BY_NAME to DO_FCALL
20
 */
21
22
#include "Optimizer/zend_optimizer.h"
23
#include "Optimizer/zend_optimizer_internal.h"
24
#include "zend_API.h"
25
#include "zend_constants.h"
26
#include "zend_execute.h"
27
#include "zend_vm.h"
28
29
typedef struct _optimizer_call_info {
30
  zend_function *func;
31
  zend_op       *opline;
32
  zend_op       *last_check_func_arg_opline;
33
  bool      is_prototype;
34
  bool      try_inline;
35
  uint32_t       func_arg_num;
36
} optimizer_call_info;
37
38
static void zend_delete_call_instructions(const zend_op_array *op_array, zend_op *opline)
39
647
{
40
647
  int call = 0;
41
42
1.38k
  while (1) {
43
1.38k
    switch (opline->opcode) {
44
14
      case ZEND_INIT_FCALL_BY_NAME:
45
14
      case ZEND_INIT_NS_FCALL_BY_NAME:
46
66
      case ZEND_INIT_STATIC_METHOD_CALL:
47
68
      case ZEND_INIT_METHOD_CALL:
48
701
      case ZEND_INIT_FCALL:
49
701
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
50
701
        if (call == 0) {
51
647
          MAKE_NOP(opline);
52
647
          return;
53
647
        }
54
54
        ZEND_FALLTHROUGH;
55
62
      case ZEND_NEW:
56
62
      case ZEND_INIT_DYNAMIC_CALL:
57
62
      case ZEND_INIT_USER_CALL:
58
62
        call--;
59
62
        break;
60
46
      case ZEND_DO_FCALL:
61
46
      case ZEND_DO_ICALL:
62
62
      case ZEND_DO_UCALL:
63
62
      case ZEND_DO_FCALL_BY_NAME:
64
62
        call++;
65
62
        break;
66
117
      case ZEND_SEND_VAL:
67
342
      case ZEND_SEND_VAR:
68
342
        if (call == 0) {
69
342
          zend_optimizer_convert_to_free_op1(op_array, opline);
70
342
        }
71
342
        break;
72
1.38k
    }
73
736
    opline--;
74
736
  }
75
647
}
76
77
static void zend_try_inline_call(zend_op_array *op_array, const zend_op *fcall, zend_op *opline, const zend_function *func)
78
138k
{
79
138k
  const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD;
80
81
138k
  if (func->type == ZEND_USER_FUNCTION
82
29.6k
   && !(func->op_array.fn_flags & (ZEND_ACC_ABSTRACT|ZEND_ACC_HAS_TYPE_HINTS|ZEND_ACC_DEPRECATED|no_discard))
83
    /* TODO: function copied from trait may be inconsistent ??? */
84
23.1k
   && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
85
23.1k
   && fcall->extended_value >= func->op_array.required_num_args
86
22.9k
   && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) {
87
88
1.31k
    zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args;
89
90
1.31k
    if (ret_opline->op1_type == IS_CONST) {
91
762
      uint32_t i, num_args = func->op_array.num_args;
92
762
      num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0;
93
94
762
      if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
95
48
          && !(func->op_array.fn_flags & ZEND_ACC_STATIC)) {
96
        /* Don't inline static call to instance method. */
97
0
        return;
98
0
      }
99
100
1.13k
      for (i = 0; i < num_args; i++) {
101
        /* Don't inline functions with by-reference arguments. This would require
102
         * correct handling of INDIRECT arguments. */
103
397
        if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) {
104
29
          return;
105
29
        }
106
397
      }
107
108
733
      if (fcall->extended_value < func->op_array.num_args) {
109
        /* don't inline functions with named constants in default arguments */
110
86
        i = fcall->extended_value;
111
112
86
        do {
113
86
          if (Z_TYPE_P(CRT_CONSTANT_EX(&func->op_array, &func->op_array.opcodes[i], func->op_array.opcodes[i].op2)) == IS_CONSTANT_AST) {
114
86
            return;
115
86
          }
116
0
          i++;
117
0
        } while (i < func->op_array.num_args);
118
86
      }
119
120
647
      if (RETURN_VALUE_USED(opline)) {
121
450
        zval zv;
122
123
450
        ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1));
124
450
        opline->opcode = ZEND_QM_ASSIGN;
125
450
        opline->op1_type = IS_CONST;
126
450
        opline->op1.constant = zend_optimizer_add_literal(op_array, &zv);
127
450
        SET_UNUSED(opline->op2);
128
450
      } else {
129
197
        MAKE_NOP(opline);
130
197
      }
131
132
647
      zend_delete_call_instructions(op_array, opline-1);
133
647
    }
134
1.31k
  }
135
138k
}
136
137
/* arg_num is 1-based here, to match SEND encoding. */
138
static bool has_known_send_mode(const optimizer_call_info *info, uint32_t arg_num)
139
39.2k
{
140
39.2k
  if (!info->func) {
141
36.1k
    return false;
142
36.1k
  }
143
144
  /* For prototype functions we should not make assumptions about arguments that are not part of
145
   * the signature: And inheriting method can add an optional by-ref argument. */
146
3.10k
  return !info->is_prototype
147
784
    || arg_num <= info->func->common.num_args
148
10
    || (info->func->common.fn_flags & ZEND_ACC_VARIADIC);
149
39.2k
}
150
151
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
152
115k
{
153
115k
  zend_op *opline = op_array->opcodes;
154
115k
  const zend_op *end = opline + op_array->last;
155
115k
  int call = 0;
156
115k
  void *checkpoint;
157
115k
  optimizer_call_info *call_stack;
158
159
115k
  if (op_array->last < 2) {
160
2.95k
    return;
161
2.95k
  }
162
163
112k
  checkpoint = zend_arena_checkpoint(ctx->arena);
164
112k
  call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info));
165
2.93M
  while (opline < end) {
166
2.82M
    switch (opline->opcode) {
167
9.45k
      case ZEND_INIT_FCALL_BY_NAME:
168
12.5k
      case ZEND_INIT_NS_FCALL_BY_NAME:
169
20.1k
      case ZEND_INIT_STATIC_METHOD_CALL:
170
65.1k
      case ZEND_INIT_METHOD_CALL:
171
201k
      case ZEND_INIT_FCALL:
172
260k
      case ZEND_NEW:
173
260k
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
174
        /* The argument passing optimizations are valid for prototypes as well,
175
         * as inheritance cannot change between ref <-> non-ref arguments. */
176
260k
        call_stack[call].func = zend_optimizer_get_called_func(
177
260k
          ctx->script, op_array, opline, &call_stack[call].is_prototype);
178
260k
        call_stack[call].try_inline =
179
260k
          !call_stack[call].is_prototype
180
260k
          && opline->opcode != ZEND_NEW
181
201k
          && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL;
182
260k
        ZEND_FALLTHROUGH;
183
268k
      case ZEND_INIT_DYNAMIC_CALL:
184
269k
      case ZEND_INIT_USER_CALL:
185
269k
        call_stack[call].opline = opline;
186
269k
        call_stack[call].func_arg_num = (uint32_t)-1;
187
269k
        call++;
188
269k
        break;
189
253k
      case ZEND_DO_FCALL:
190
253k
      case ZEND_DO_ICALL:
191
266k
      case ZEND_DO_UCALL:
192
267k
      case ZEND_DO_FCALL_BY_NAME:
193
268k
      case ZEND_CALLABLE_CONVERT:
194
269k
      case ZEND_CALLABLE_CONVERT_PARTIAL:
195
269k
        call--;
196
269k
        if (call_stack[call].func && call_stack[call].opline) {
197
146k
          zend_op *fcall = call_stack[call].opline;
198
199
146k
          if (fcall->opcode == ZEND_INIT_FCALL) {
200
            /* nothing to do */
201
136k
          } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) {
202
1.53k
            fcall->opcode = ZEND_INIT_FCALL;
203
1.53k
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
204
1.53k
            literal_dtor(&ZEND_OP2_LITERAL(fcall));
205
1.53k
            fcall->op2.constant = fcall->op2.constant + 1;
206
8.96k
          } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
207
402
            fcall->opcode = ZEND_INIT_FCALL;
208
402
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
209
402
            literal_dtor(&op_array->literals[fcall->op2.constant]);
210
402
            literal_dtor(&op_array->literals[fcall->op2.constant + 2]);
211
402
            fcall->op2.constant = fcall->op2.constant + 1;
212
8.56k
          } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
213
4.36k
              || fcall->opcode == ZEND_INIT_METHOD_CALL
214
3.70k
              || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
215
8.56k
              || fcall->opcode == ZEND_NEW) {
216
            /* We don't have specialized opcodes for this, do nothing */
217
8.56k
          } else {
218
0
            ZEND_UNREACHABLE();
219
0
          }
220
221
          /* If the INIT opcode changed the DO opcode can also change to
222
           * a more optimized one.
223
           *
224
           * At this point we also know whether or not the result of
225
           * the DO opcode is used, allowing to optimize calls to
226
           * ZEND_ACC_NODISCARD functions. */
227
146k
          if (opline->opcode != ZEND_CALLABLE_CONVERT && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
228
145k
            opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline));
229
145k
          }
230
231
146k
          if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level)
232
146k
              && call_stack[call].try_inline
233
139k
              && opline->opcode != ZEND_CALLABLE_CONVERT
234
139k
              && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
235
138k
            zend_try_inline_call(op_array, fcall, opline, call_stack[call].func);
236
138k
          }
237
146k
        }
238
269k
        call_stack[call].func = NULL;
239
269k
        call_stack[call].opline = NULL;
240
269k
        call_stack[call].try_inline = false;
241
269k
        call_stack[call].func_arg_num = (uint32_t)-1;
242
269k
        break;
243
105
      case ZEND_FETCH_FUNC_ARG:
244
414
      case ZEND_FETCH_STATIC_PROP_FUNC_ARG:
245
944
      case ZEND_FETCH_OBJ_FUNC_ARG:
246
1.75k
      case ZEND_FETCH_DIM_FUNC_ARG:
247
1.75k
        if (call_stack[call - 1].func_arg_num != (uint32_t)-1
248
170
            && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) {
249
170
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, call_stack[call - 1].func_arg_num)) {
250
            /* There's no TMP specialization for FETCH_OBJ_W/FETCH_DIM_W. Avoid
251
             * converting it and error at runtime in the FUNC_ARG variant. */
252
48
            if ((opline->opcode == ZEND_FETCH_OBJ_FUNC_ARG || opline->opcode == ZEND_FETCH_DIM_FUNC_ARG)
253
48
             && (opline->op1_type == IS_TMP_VAR || call_stack[call - 1].last_check_func_arg_opline == NULL)) {
254
              /* Don't remove the associated CHECK_FUNC_ARG opcode. */
255
8
              call_stack[call - 1].last_check_func_arg_opline = NULL;
256
8
              break;
257
8
            }
258
40
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
259
40
              opline->opcode -= 9;
260
40
            } else {
261
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_W;
262
0
            }
263
122
          } else {
264
122
            if (opline->opcode == ZEND_FETCH_DIM_FUNC_ARG
265
44
                && opline->op2_type == IS_UNUSED) {
266
              /* FETCH_DIM_FUNC_ARG supports UNUSED op2, while FETCH_DIM_R does not.
267
               * Performing the replacement would create an invalid opcode. */
268
14
              call_stack[call - 1].try_inline = false;
269
14
              break;
270
14
            }
271
272
108
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
273
108
              opline->opcode -= 12;
274
108
            } else {
275
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_R;
276
0
            }
277
108
          }
278
170
        }
279
1.73k
        break;
280
22.4k
      case ZEND_SEND_VAL_EX:
281
22.4k
        if (opline->op2_type == IS_CONST) {
282
1.30k
          call_stack[call - 1].try_inline = false;
283
1.30k
          break;
284
1.30k
        }
285
286
21.1k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
287
1.02k
          if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
288
967
            opline->opcode = ZEND_SEND_VAL;
289
967
          }
290
1.02k
        }
291
21.1k
        break;
292
1.60k
      case ZEND_CHECK_FUNC_ARG:
293
1.60k
        if (opline->op2_type == IS_CONST) {
294
216
          call_stack[call - 1].try_inline = false;
295
216
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
296
216
          break;
297
216
        }
298
299
1.39k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
300
168
          call_stack[call - 1].func_arg_num = opline->op2.num;
301
168
          call_stack[call - 1].last_check_func_arg_opline = opline;
302
168
        }
303
1.39k
        break;
304
1.60k
      case ZEND_SEND_FUNC_ARG:
305
        /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */
306
1.60k
        if (call_stack[call - 1].last_check_func_arg_opline == NULL) {
307
1.44k
          if (opline->op2_type == IS_CONST) {
308
216
            call_stack[call - 1].try_inline = false;
309
216
          }
310
1.44k
          break;
311
1.44k
        }
312
160
        MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline);
313
160
        call_stack[call - 1].last_check_func_arg_opline = NULL;
314
160
        ZEND_FALLTHROUGH;
315
15.0k
      case ZEND_SEND_VAR_EX:
316
15.0k
        if (opline->op2_type == IS_CONST) {
317
681
          call_stack[call - 1].try_inline = false;
318
681
          break;
319
681
        }
320
321
14.3k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
322
1.49k
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
323
1.49k
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
324
61
            opline->opcode = ZEND_SEND_REF;
325
1.43k
          } else {
326
1.43k
            opline->opcode = ZEND_SEND_VAR;
327
1.43k
          }
328
1.49k
        }
329
14.3k
        break;
330
2.35k
      case ZEND_SEND_VAR_NO_REF_EX:
331
2.35k
        if (opline->op2_type == IS_CONST) {
332
220
          call_stack[call - 1].try_inline = false;
333
220
          break;
334
220
        }
335
336
2.13k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
337
232
          if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
338
156
            opline->opcode = ZEND_SEND_VAR_NO_REF;
339
156
          } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
340
0
            opline->opcode = ZEND_SEND_VAL;
341
76
          } else {
342
76
            opline->opcode = ZEND_SEND_VAR;
343
76
          }
344
232
        }
345
2.13k
        break;
346
137k
      case ZEND_SEND_VAL:
347
207k
      case ZEND_SEND_VAR:
348
210k
      case ZEND_SEND_REF:
349
210k
        if (opline->op2_type == IS_CONST) {
350
1.44k
          call_stack[call - 1].try_inline = false;
351
1.44k
          break;
352
1.44k
        }
353
208k
        break;
354
208k
      case ZEND_SEND_UNPACK:
355
4.82k
      case ZEND_SEND_USER:
356
5.59k
      case ZEND_SEND_ARRAY:
357
5.59k
        call_stack[call - 1].try_inline = false;
358
5.59k
        break;
359
2.02M
      default:
360
2.02M
        break;
361
2.82M
    }
362
2.82M
    opline++;
363
2.82M
  }
364
365
112k
  zend_arena_release(&ctx->arena, checkpoint);
366
112k
}