Coverage Report

Created: 2026-06-02 06:36

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