Coverage Report

Created: 2026-07-25 06:39

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
565
{
40
565
  int call = 0;
41
42
1.18k
  while (1) {
43
1.18k
    switch (opline->opcode) {
44
12
      case ZEND_INIT_FCALL_BY_NAME:
45
12
      case ZEND_INIT_NS_FCALL_BY_NAME:
46
58
      case ZEND_INIT_STATIC_METHOD_CALL:
47
58
      case ZEND_INIT_METHOD_CALL:
48
615
      case ZEND_INIT_FCALL:
49
615
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
50
615
        if (call == 0) {
51
565
          MAKE_NOP(opline);
52
565
          return;
53
565
        }
54
50
        ZEND_FALLTHROUGH;
55
60
      case ZEND_NEW:
56
60
      case ZEND_INIT_DYNAMIC_CALL:
57
60
      case ZEND_INIT_USER_CALL:
58
60
        call--;
59
60
        break;
60
44
      case ZEND_DO_FCALL:
61
44
      case ZEND_DO_ICALL:
62
60
      case ZEND_DO_UCALL:
63
60
      case ZEND_DO_FCALL_BY_NAME:
64
60
        call++;
65
60
        break;
66
113
      case ZEND_SEND_VAL:
67
250
      case ZEND_SEND_VAR:
68
250
        if (call == 0) {
69
250
          zend_optimizer_convert_to_free_op1(op_array, opline);
70
250
        }
71
250
        break;
72
1.18k
    }
73
620
    opline--;
74
620
  }
75
565
}
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
137k
{
79
137k
  const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD;
80
81
137k
  if (func->type == ZEND_USER_FUNCTION
82
29.8k
   && !(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.5k
   && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
85
23.5k
   && fcall->extended_value >= func->op_array.required_num_args
86
23.3k
   && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) {
87
88
1.18k
    zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args;
89
90
1.18k
    if (ret_opline->op1_type == IS_CONST) {
91
648
      uint32_t i, num_args = func->op_array.num_args;
92
648
      num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0;
93
94
648
      if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
95
44
          && !(func->op_array.fn_flags & ZEND_ACC_STATIC)) {
96
        /* Don't inline static call to instance method. */
97
0
        return;
98
0
      }
99
100
882
      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
271
        if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) {
104
37
          return;
105
37
        }
106
271
      }
107
108
611
      if (fcall->extended_value < func->op_array.num_args) {
109
        /* don't inline functions with named constants in default arguments */
110
46
        i = fcall->extended_value;
111
112
46
        do {
113
46
          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
46
            return;
115
46
          }
116
0
          i++;
117
0
        } while (i < func->op_array.num_args);
118
46
      }
119
120
565
      if (RETURN_VALUE_USED(opline)) {
121
440
        zval zv;
122
123
440
        ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1));
124
440
        opline->opcode = ZEND_QM_ASSIGN;
125
440
        opline->op1_type = IS_CONST;
126
440
        opline->op1.constant = zend_optimizer_add_literal(op_array, &zv);
127
440
        SET_UNUSED(opline->op2);
128
440
      } else {
129
125
        MAKE_NOP(opline);
130
125
      }
131
132
565
      zend_delete_call_instructions(op_array, opline-1);
133
565
    }
134
1.18k
  }
135
137k
}
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
38.0k
{
140
38.0k
  if (!info->func) {
141
34.7k
    return false;
142
34.7k
  }
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.24k
  return !info->is_prototype
147
739
    || arg_num <= info->func->common.num_args
148
11
    || (info->func->common.fn_flags & ZEND_ACC_VARIADIC);
149
38.0k
}
150
151
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
152
116k
{
153
116k
  zend_op *opline = op_array->opcodes;
154
116k
  const zend_op *end = opline + op_array->last;
155
116k
  int call = 0;
156
116k
  void *checkpoint;
157
116k
  optimizer_call_info *call_stack;
158
159
116k
  if (op_array->last < 2) {
160
2.92k
    return;
161
2.92k
  }
162
163
113k
  checkpoint = zend_arena_checkpoint(ctx->arena);
164
113k
  call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info));
165
3.05M
  while (opline < end) {
166
2.93M
    switch (opline->opcode) {
167
9.38k
      case ZEND_INIT_FCALL_BY_NAME:
168
12.4k
      case ZEND_INIT_NS_FCALL_BY_NAME:
169
19.9k
      case ZEND_INIT_STATIC_METHOD_CALL:
170
63.7k
      case ZEND_INIT_METHOD_CALL:
171
198k
      case ZEND_INIT_FCALL:
172
258k
      case ZEND_NEW:
173
259k
      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
259k
        call_stack[call].func = zend_optimizer_get_called_func(
177
259k
          ctx->script, op_array, opline, &call_stack[call].is_prototype);
178
259k
        call_stack[call].try_inline =
179
259k
          !call_stack[call].is_prototype
180
258k
          && opline->opcode != ZEND_NEW
181
198k
          && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL;
182
259k
        ZEND_FALLTHROUGH;
183
266k
      case ZEND_INIT_DYNAMIC_CALL:
184
267k
      case ZEND_INIT_USER_CALL:
185
267k
        call_stack[call].opline = opline;
186
267k
        call_stack[call].func_arg_num = (uint32_t)-1;
187
267k
        call++;
188
267k
        break;
189
251k
      case ZEND_DO_FCALL:
190
251k
      case ZEND_DO_ICALL:
191
265k
      case ZEND_DO_UCALL:
192
265k
      case ZEND_DO_FCALL_BY_NAME:
193
266k
      case ZEND_CALLABLE_CONVERT:
194
267k
      case ZEND_CALLABLE_CONVERT_PARTIAL:
195
267k
        call--;
196
267k
        if (call_stack[call].func && call_stack[call].opline) {
197
145k
          zend_op *fcall = call_stack[call].opline;
198
199
145k
          if (fcall->opcode == ZEND_INIT_FCALL) {
200
            /* nothing to do */
201
134k
          } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) {
202
1.67k
            fcall->opcode = ZEND_INIT_FCALL;
203
1.67k
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
204
1.67k
            literal_dtor(&ZEND_OP2_LITERAL(fcall));
205
1.67k
            fcall->op2.constant = fcall->op2.constant + 1;
206
8.82k
          } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
207
438
            fcall->opcode = ZEND_INIT_FCALL;
208
438
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
209
438
            literal_dtor(&op_array->literals[fcall->op2.constant]);
210
438
            literal_dtor(&op_array->literals[fcall->op2.constant + 2]);
211
438
            fcall->op2.constant = fcall->op2.constant + 1;
212
8.39k
          } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
213
4.28k
              || fcall->opcode == ZEND_INIT_METHOD_CALL
214
3.61k
              || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
215
8.39k
              || fcall->opcode == ZEND_NEW) {
216
            /* We don't have specialized opcodes for this, do nothing */
217
8.39k
          } 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
145k
          if (opline->opcode != ZEND_CALLABLE_CONVERT && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
228
143k
            opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline));
229
143k
          }
230
231
145k
          if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level)
232
145k
              && call_stack[call].try_inline
233
138k
              && opline->opcode != ZEND_CALLABLE_CONVERT
234
137k
              && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
235
137k
            zend_try_inline_call(op_array, fcall, opline, call_stack[call].func);
236
137k
          }
237
145k
        }
238
267k
        call_stack[call].func = NULL;
239
267k
        call_stack[call].opline = NULL;
240
267k
        call_stack[call].try_inline = false;
241
267k
        call_stack[call].func_arg_num = (uint32_t)-1;
242
267k
        break;
243
101
      case ZEND_FETCH_FUNC_ARG:
244
394
      case ZEND_FETCH_STATIC_PROP_FUNC_ARG:
245
866
      case ZEND_FETCH_OBJ_FUNC_ARG:
246
1.71k
      case ZEND_FETCH_DIM_FUNC_ARG:
247
1.71k
        if (call_stack[call - 1].func_arg_num != (uint32_t)-1
248
150
            && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) {
249
150
          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
42
            if ((opline->opcode == ZEND_FETCH_OBJ_FUNC_ARG || opline->opcode == ZEND_FETCH_DIM_FUNC_ARG)
253
42
             && (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
10
              call_stack[call - 1].last_check_func_arg_opline = NULL;
256
10
              break;
257
10
            }
258
32
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
259
32
              opline->opcode -= 9;
260
32
            } else {
261
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_W;
262
0
            }
263
108
          } else {
264
108
            if (opline->opcode == ZEND_FETCH_DIM_FUNC_ARG
265
50
                && 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
16
              call_stack[call - 1].try_inline = false;
269
16
              break;
270
16
            }
271
272
92
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
273
92
              opline->opcode -= 12;
274
92
            } else {
275
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_R;
276
0
            }
277
92
          }
278
150
        }
279
1.68k
        break;
280
21.5k
      case ZEND_SEND_VAL_EX:
281
21.5k
        if (opline->op2_type == IS_CONST) {
282
1.38k
          call_stack[call - 1].try_inline = false;
283
1.38k
          break;
284
1.38k
        }
285
286
20.2k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
287
1.08k
          if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
288
1.01k
            opline->opcode = ZEND_SEND_VAL;
289
1.01k
          }
290
1.08k
        }
291
20.2k
        break;
292
1.56k
      case ZEND_CHECK_FUNC_ARG:
293
1.56k
        if (opline->op2_type == IS_CONST) {
294
208
          call_stack[call - 1].try_inline = false;
295
208
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
296
208
          break;
297
208
        }
298
299
1.35k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
300
148
          call_stack[call - 1].func_arg_num = opline->op2.num;
301
148
          call_stack[call - 1].last_check_func_arg_opline = opline;
302
148
        }
303
1.35k
        break;
304
1.56k
      case ZEND_SEND_FUNC_ARG:
305
        /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */
306
1.56k
        if (call_stack[call - 1].last_check_func_arg_opline == NULL) {
307
1.42k
          if (opline->op2_type == IS_CONST) {
308
208
            call_stack[call - 1].try_inline = false;
309
208
          }
310
1.42k
          break;
311
1.42k
        }
312
138
        MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline);
313
138
        call_stack[call - 1].last_check_func_arg_opline = NULL;
314
138
        ZEND_FALLTHROUGH;
315
14.8k
      case ZEND_SEND_VAR_EX:
316
14.8k
        if (opline->op2_type == IS_CONST) {
317
775
          call_stack[call - 1].try_inline = false;
318
775
          break;
319
775
        }
320
321
14.1k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
322
1.54k
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
323
1.54k
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
324
52
            opline->opcode = ZEND_SEND_REF;
325
1.49k
          } else {
326
1.49k
            opline->opcode = ZEND_SEND_VAR;
327
1.49k
          }
328
1.54k
        }
329
14.1k
        break;
330
2.52k
      case ZEND_SEND_VAR_NO_REF_EX:
331
2.52k
        if (opline->op2_type == IS_CONST) {
332
316
          call_stack[call - 1].try_inline = false;
333
316
          break;
334
316
        }
335
336
2.21k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
337
306
          if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
338
238
            opline->opcode = ZEND_SEND_VAR_NO_REF;
339
238
          } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
340
0
            opline->opcode = ZEND_SEND_VAL;
341
68
          } else {
342
68
            opline->opcode = ZEND_SEND_VAR;
343
68
          }
344
306
        }
345
2.21k
        break;
346
135k
      case ZEND_SEND_VAL:
347
208k
      case ZEND_SEND_VAR:
348
211k
      case ZEND_SEND_REF:
349
211k
        if (opline->op2_type == IS_CONST) {
350
1.32k
          call_stack[call - 1].try_inline = false;
351
1.32k
          break;
352
1.32k
        }
353
210k
        break;
354
210k
      case ZEND_SEND_UNPACK:
355
4.47k
      case ZEND_SEND_USER:
356
5.19k
      case ZEND_SEND_ARRAY:
357
5.19k
        call_stack[call - 1].try_inline = false;
358
5.19k
        break;
359
2.14M
      default:
360
2.14M
        break;
361
2.93M
    }
362
2.93M
    opline++;
363
2.93M
  }
364
365
113k
  zend_arena_release(&ctx->arena, checkpoint);
366
113k
}