Coverage Report

Created: 2026-10-28 06:20

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
20
{
40
20
  int call = 0;
41
42
50
  while (1) {
43
50
    switch (opline->opcode) {
44
0
      case ZEND_INIT_FCALL_BY_NAME:
45
0
      case ZEND_INIT_NS_FCALL_BY_NAME:
46
0
      case ZEND_INIT_STATIC_METHOD_CALL:
47
0
      case ZEND_INIT_METHOD_CALL:
48
20
      case ZEND_INIT_FCALL:
49
20
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
50
20
        if (call == 0) {
51
20
          MAKE_NOP(opline);
52
20
          return;
53
20
        }
54
0
        ZEND_FALLTHROUGH;
55
0
      case ZEND_NEW:
56
4
      case ZEND_INIT_DYNAMIC_CALL:
57
4
      case ZEND_INIT_USER_CALL:
58
4
        call--;
59
4
        break;
60
0
      case ZEND_DO_FCALL:
61
0
      case ZEND_DO_ICALL:
62
0
      case ZEND_DO_UCALL:
63
0
      case ZEND_DO_FCALL_BY_NAME:
64
4
      case ZEND_CALLABLE_CONVERT:
65
4
      case ZEND_CALLABLE_CONVERT_PARTIAL:
66
4
        call++;
67
4
        break;
68
10
      case ZEND_SEND_VAL:
69
16
      case ZEND_SEND_VAR:
70
16
        if (call == 0) {
71
16
          zend_optimizer_convert_to_free_op1(op_array, opline);
72
16
        }
73
16
        break;
74
50
    }
75
30
    opline--;
76
30
  }
77
20
}
78
79
static void zend_try_inline_call(zend_op_array *op_array, const zend_op *fcall, zend_op *opline, const zend_function *func)
80
1.84k
{
81
1.84k
  const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD;
82
83
1.84k
  if (func->type == ZEND_USER_FUNCTION
84
152
   && !(func->op_array.fn_flags & (ZEND_ACC_ABSTRACT|ZEND_ACC_HAS_TYPE_HINTS|ZEND_ACC_DEPRECATED|no_discard))
85
    /* TODO: function copied from trait may be inconsistent ??? */
86
140
   && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
87
140
   && fcall->extended_value >= func->op_array.required_num_args
88
138
   && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) {
89
90
22
    zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args;
91
92
22
    if (ret_opline->op1_type == IS_CONST) {
93
22
      uint32_t i, num_args = func->op_array.num_args;
94
22
      num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0;
95
96
22
      if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
97
0
          && !(func->op_array.fn_flags & ZEND_ACC_STATIC)) {
98
        /* Don't inline static call to instance method. */
99
0
        return;
100
0
      }
101
102
38
      for (i = 0; i < num_args; i++) {
103
        /* Don't inline functions with by-reference arguments. This would require
104
         * correct handling of INDIRECT arguments. */
105
16
        if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) {
106
0
          return;
107
0
        }
108
16
      }
109
110
22
      if (fcall->extended_value < func->op_array.num_args) {
111
        /* don't inline functions with named constants in default arguments */
112
2
        i = fcall->extended_value;
113
114
2
        do {
115
2
          if (Z_TYPE_P(CRT_CONSTANT_EX(&func->op_array, &func->op_array.opcodes[i], func->op_array.opcodes[i].op2)) == IS_CONSTANT_AST) {
116
2
            return;
117
2
          }
118
0
          i++;
119
0
        } while (i < func->op_array.num_args);
120
2
      }
121
122
20
      if (RETURN_VALUE_USED(opline)) {
123
10
        zval zv;
124
125
10
        ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1));
126
10
        opline->opcode = ZEND_QM_ASSIGN;
127
10
        opline->op1_type = IS_CONST;
128
10
        opline->op1.constant = zend_optimizer_add_literal(op_array, &zv);
129
10
        SET_UNUSED(opline->op2);
130
10
      } else {
131
10
        MAKE_NOP(opline);
132
10
      }
133
134
20
      zend_delete_call_instructions(op_array, opline-1);
135
20
    }
136
22
  }
137
1.84k
}
138
139
/* arg_num is 1-based here, to match SEND encoding. */
140
static bool has_known_send_mode(const optimizer_call_info *info, uint32_t arg_num)
141
1.52k
{
142
1.52k
  if (!info->func) {
143
1.51k
    return false;
144
1.51k
  }
145
146
  /* For prototype functions we should not make assumptions about arguments that are not part of
147
   * the signature: And inheriting method can add an optional by-ref argument. */
148
16
  return !info->is_prototype
149
0
    || arg_num <= info->func->common.num_args
150
0
    || (info->func->common.fn_flags & ZEND_ACC_VARIADIC);
151
1.52k
}
152
153
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
154
25.9k
{
155
25.9k
  zend_op *opline = op_array->opcodes;
156
25.9k
  const zend_op *end = opline + op_array->last;
157
25.9k
  int call = 0;
158
25.9k
  void *checkpoint;
159
25.9k
  optimizer_call_info *call_stack;
160
161
25.9k
  if (op_array->last < 2) {
162
1.02k
    return;
163
1.02k
  }
164
165
24.9k
  checkpoint = zend_arena_checkpoint(ctx->arena);
166
24.9k
  call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info));
167
189k
  while (opline < end) {
168
164k
    switch (opline->opcode) {
169
1.37k
      case ZEND_INIT_FCALL_BY_NAME:
170
1.40k
      case ZEND_INIT_NS_FCALL_BY_NAME:
171
1.50k
      case ZEND_INIT_STATIC_METHOD_CALL:
172
1.56k
      case ZEND_INIT_METHOD_CALL:
173
3.47k
      case ZEND_INIT_FCALL:
174
8.88k
      case ZEND_NEW:
175
8.88k
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
176
        /* The argument passing optimizations are valid for prototypes as well,
177
         * as inheritance cannot change between ref <-> non-ref arguments. */
178
8.88k
        call_stack[call].func = zend_optimizer_get_called_func(
179
8.88k
          ctx->script, op_array, opline, &call_stack[call].is_prototype);
180
8.88k
        call_stack[call].try_inline =
181
8.88k
          !call_stack[call].is_prototype
182
8.88k
          && opline->opcode != ZEND_NEW
183
3.47k
          && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL;
184
8.88k
        ZEND_FALLTHROUGH;
185
9.07k
      case ZEND_INIT_DYNAMIC_CALL:
186
9.07k
      case ZEND_INIT_USER_CALL:
187
9.07k
        call_stack[call].opline = opline;
188
9.07k
        call_stack[call].func_arg_num = (uint32_t)-1;
189
9.07k
        call++;
190
9.07k
        break;
191
8.87k
      case ZEND_DO_FCALL:
192
8.87k
      case ZEND_DO_ICALL:
193
8.94k
      case ZEND_DO_UCALL:
194
8.94k
      case ZEND_DO_FCALL_BY_NAME:
195
9.01k
      case ZEND_CALLABLE_CONVERT:
196
9.07k
      case ZEND_CALLABLE_CONVERT_PARTIAL:
197
9.07k
        call--;
198
9.07k
        if (call_stack[call].func && call_stack[call].opline) {
199
1.93k
          zend_op *fcall = call_stack[call].opline;
200
201
1.93k
          if (fcall->opcode == ZEND_INIT_FCALL) {
202
            /* nothing to do */
203
1.91k
          } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) {
204
10
            fcall->opcode = ZEND_INIT_FCALL;
205
10
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
206
10
            literal_dtor(&ZEND_OP2_LITERAL(fcall));
207
10
            fcall->op2.constant = fcall->op2.constant + 1;
208
10
          } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
209
0
            fcall->opcode = ZEND_INIT_FCALL;
210
0
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
211
0
            literal_dtor(&op_array->literals[fcall->op2.constant]);
212
0
            literal_dtor(&op_array->literals[fcall->op2.constant + 2]);
213
0
            fcall->op2.constant = fcall->op2.constant + 1;
214
6
          } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
215
0
              || fcall->opcode == ZEND_INIT_METHOD_CALL
216
0
              || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
217
6
              || fcall->opcode == ZEND_NEW) {
218
            /* We don't have specialized opcodes for this, do nothing */
219
6
          } else {
220
0
            ZEND_UNREACHABLE();
221
0
          }
222
223
          /* If the INIT opcode changed the DO opcode can also change to
224
           * a more optimized one.
225
           *
226
           * At this point we also know whether or not the result of
227
           * the DO opcode is used, allowing to optimize calls to
228
           * ZEND_ACC_NODISCARD functions. */
229
1.93k
          if (opline->opcode != ZEND_CALLABLE_CONVERT && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
230
1.88k
            opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline));
231
1.88k
          }
232
233
1.93k
          if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level)
234
1.93k
              && call_stack[call].try_inline
235
1.89k
              && opline->opcode != ZEND_CALLABLE_CONVERT
236
1.87k
              && opline->opcode != ZEND_CALLABLE_CONVERT_PARTIAL) {
237
1.84k
            zend_try_inline_call(op_array, fcall, opline, call_stack[call].func);
238
1.84k
          }
239
1.93k
        }
240
9.07k
        call_stack[call].func = NULL;
241
9.07k
        call_stack[call].opline = NULL;
242
9.07k
        call_stack[call].try_inline = false;
243
9.07k
        call_stack[call].func_arg_num = (uint32_t)-1;
244
9.07k
        break;
245
34
      case ZEND_FETCH_FUNC_ARG:
246
46
      case ZEND_FETCH_STATIC_PROP_FUNC_ARG:
247
54
      case ZEND_FETCH_OBJ_FUNC_ARG:
248
116
      case ZEND_FETCH_DIM_FUNC_ARG:
249
116
        if (call_stack[call - 1].func_arg_num != (uint32_t)-1
250
0
            && call_stack[call - 1].last_check_func_arg_opline != NULL
251
0
            && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) {
252
0
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, call_stack[call - 1].func_arg_num)) {
253
            /* There's no TMP specialization for FETCH_OBJ_W/FETCH_DIM_W. Avoid
254
             * converting it and error at runtime in the FUNC_ARG variant. */
255
0
            if ((opline->opcode == ZEND_FETCH_OBJ_FUNC_ARG || opline->opcode == ZEND_FETCH_DIM_FUNC_ARG)
256
0
             && opline->op1_type == IS_TMP_VAR) {
257
              /* Don't remove the associated CHECK_FUNC_ARG opcode. */
258
0
              call_stack[call - 1].last_check_func_arg_opline = NULL;
259
0
              break;
260
0
            }
261
0
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
262
0
              opline->opcode -= 9;
263
0
            } else {
264
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_W;
265
0
            }
266
0
          } else {
267
0
            if (opline->opcode == ZEND_FETCH_DIM_FUNC_ARG
268
0
                && opline->op2_type == IS_UNUSED) {
269
              /* FETCH_DIM_FUNC_ARG supports UNUSED op2, while FETCH_DIM_R does not.
270
               * Performing the replacement would create an invalid opcode. */
271
0
              call_stack[call - 1].try_inline = false;
272
              /* Don't remove the associated CHECK_FUNC_ARG opcode. */
273
0
              call_stack[call - 1].last_check_func_arg_opline = NULL;
274
0
              break;
275
0
            }
276
277
0
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
278
0
              opline->opcode -= 12;
279
0
            } else {
280
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_R;
281
0
            }
282
0
          }
283
0
        }
284
116
        break;
285
1.27k
      case ZEND_SEND_VAL_EX:
286
1.27k
        if (opline->op2_type == IS_CONST) {
287
62
          call_stack[call - 1].try_inline = false;
288
62
          break;
289
62
        }
290
291
1.21k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
292
10
          if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
293
4
            opline->opcode = ZEND_SEND_VAL;
294
4
          }
295
10
        }
296
1.21k
        break;
297
110
      case ZEND_CHECK_FUNC_ARG:
298
110
        if (opline->op2_type == IS_CONST) {
299
12
          call_stack[call - 1].try_inline = false;
300
12
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
301
12
          break;
302
12
        }
303
304
98
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
305
0
          call_stack[call - 1].func_arg_num = opline->op2.num;
306
0
          call_stack[call - 1].last_check_func_arg_opline = opline;
307
0
        }
308
98
        break;
309
110
      case ZEND_SEND_FUNC_ARG:
310
        /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */
311
110
        if (call_stack[call - 1].last_check_func_arg_opline == NULL) {
312
110
          if (opline->op2_type == IS_CONST) {
313
12
            call_stack[call - 1].try_inline = false;
314
12
          }
315
110
          break;
316
110
        }
317
0
        MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline);
318
0
        call_stack[call - 1].last_check_func_arg_opline = NULL;
319
0
        ZEND_FALLTHROUGH;
320
120
      case ZEND_SEND_VAR_EX:
321
120
        if (opline->op2_type == IS_CONST) {
322
6
          call_stack[call - 1].try_inline = false;
323
6
          break;
324
6
        }
325
326
114
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
327
0
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
328
0
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
329
0
            opline->opcode = ZEND_SEND_REF;
330
0
          } else {
331
0
            opline->opcode = ZEND_SEND_VAR;
332
0
          }
333
0
        }
334
114
        break;
335
112
      case ZEND_SEND_VAR_NO_REF_EX:
336
112
        if (opline->op2_type == IS_CONST) {
337
6
          call_stack[call - 1].try_inline = false;
338
6
          break;
339
6
        }
340
341
106
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
342
6
          if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
343
0
            opline->opcode = ZEND_SEND_VAR_NO_REF;
344
6
          } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
345
0
            opline->opcode = ZEND_SEND_VAL;
346
6
          } else {
347
6
            opline->opcode = ZEND_SEND_VAR;
348
6
          }
349
6
        }
350
106
        break;
351
7.34k
      case ZEND_SEND_VAL:
352
7.45k
      case ZEND_SEND_VAR:
353
7.45k
      case ZEND_SEND_REF:
354
7.45k
        if (opline->op2_type == IS_CONST) {
355
20
          call_stack[call - 1].try_inline = false;
356
20
          break;
357
20
        }
358
7.43k
        break;
359
7.43k
      case ZEND_SEND_UNPACK:
360
14
      case ZEND_SEND_USER:
361
14
      case ZEND_SEND_ARRAY:
362
14
        call_stack[call - 1].try_inline = false;
363
14
        break;
364
137k
      default:
365
137k
        break;
366
164k
    }
367
164k
    opline++;
368
164k
  }
369
370
24.9k
  zend_arena_release(&ctx->arena, checkpoint);
371
24.9k
}