Coverage Report

Created: 2025-12-14 06:06

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 (c) The PHP Group                                          |
6
   +----------------------------------------------------------------------+
7
   | This source file is subject to version 3.01 of the PHP 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
   | https://www.php.net/license/3_01.txt                                 |
11
   | If you did not receive a copy of the PHP license and are unable to   |
12
   | obtain it through the world-wide-web, please send a note to          |
13
   | license@php.net so we can mail you a copy immediately.               |
14
   +----------------------------------------------------------------------+
15
   | Authors: Dmitry Stogov <dmitry@php.net>                              |
16
   |          Xinchen Hui <laruence@php.net>                              |
17
   +----------------------------------------------------------------------+
18
*/
19
20
/* pass 4
21
 * - optimize INIT_FCALL_BY_NAME to DO_FCALL
22
 */
23
24
#include "Optimizer/zend_optimizer.h"
25
#include "Optimizer/zend_optimizer_internal.h"
26
#include "zend_API.h"
27
#include "zend_constants.h"
28
#include "zend_execute.h"
29
#include "zend_vm.h"
30
31
typedef struct _optimizer_call_info {
32
  zend_function *func;
33
  zend_op       *opline;
34
  zend_op       *last_check_func_arg_opline;
35
  bool      is_prototype;
36
  bool      try_inline;
37
  uint32_t       func_arg_num;
38
} optimizer_call_info;
39
40
static void zend_delete_call_instructions(const zend_op_array *op_array, zend_op *opline)
41
0
{
42
0
  int call = 0;
43
44
0
  while (1) {
45
0
    switch (opline->opcode) {
46
0
      case ZEND_INIT_FCALL_BY_NAME:
47
0
      case ZEND_INIT_NS_FCALL_BY_NAME:
48
0
      case ZEND_INIT_STATIC_METHOD_CALL:
49
0
      case ZEND_INIT_METHOD_CALL:
50
0
      case ZEND_INIT_FCALL:
51
0
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
52
0
        if (call == 0) {
53
0
          MAKE_NOP(opline);
54
0
          return;
55
0
        }
56
0
        ZEND_FALLTHROUGH;
57
0
      case ZEND_NEW:
58
0
      case ZEND_INIT_DYNAMIC_CALL:
59
0
      case ZEND_INIT_USER_CALL:
60
0
        call--;
61
0
        break;
62
0
      case ZEND_DO_FCALL:
63
0
      case ZEND_DO_ICALL:
64
0
      case ZEND_DO_UCALL:
65
0
      case ZEND_DO_FCALL_BY_NAME:
66
0
        call++;
67
0
        break;
68
0
      case ZEND_SEND_VAL:
69
0
      case ZEND_SEND_VAR:
70
0
        if (call == 0) {
71
0
          zend_optimizer_convert_to_free_op1(op_array, opline);
72
0
        }
73
0
        break;
74
0
    }
75
0
    opline--;
76
0
  }
77
0
}
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
0
{
81
0
  const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD;
82
83
0
  if (func->type == ZEND_USER_FUNCTION
84
0
   && !(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
0
   && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
87
0
   && fcall->extended_value >= func->op_array.required_num_args
88
0
   && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) {
89
90
0
    zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args;
91
92
0
    if (ret_opline->op1_type == IS_CONST) {
93
0
      uint32_t i, num_args = func->op_array.num_args;
94
0
      num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0;
95
96
0
      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
0
      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
0
        if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) {
106
0
          return;
107
0
        }
108
0
      }
109
110
0
      if (fcall->extended_value < func->op_array.num_args) {
111
        /* don't inline functions with named constants in default arguments */
112
0
        i = fcall->extended_value;
113
114
0
        do {
115
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) {
116
0
            return;
117
0
          }
118
0
          i++;
119
0
        } while (i < func->op_array.num_args);
120
0
      }
121
122
0
      if (RETURN_VALUE_USED(opline)) {
123
0
        zval zv;
124
125
0
        ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1));
126
0
        opline->opcode = ZEND_QM_ASSIGN;
127
0
        opline->op1_type = IS_CONST;
128
0
        opline->op1.constant = zend_optimizer_add_literal(op_array, &zv);
129
0
        SET_UNUSED(opline->op2);
130
0
      } else {
131
0
        MAKE_NOP(opline);
132
0
      }
133
134
0
      zend_delete_call_instructions(op_array, opline-1);
135
0
    }
136
0
  }
137
0
}
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
0
{
142
0
  if (!info->func) {
143
0
    return false;
144
0
  }
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
0
  return !info->is_prototype
149
0
    || arg_num <= info->func->common.num_args
150
0
    || (info->func->common.fn_flags & ZEND_ACC_VARIADIC);
151
0
}
152
153
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
154
0
{
155
0
  zend_op *opline = op_array->opcodes;
156
0
  const zend_op *end = opline + op_array->last;
157
0
  int call = 0;
158
0
  void *checkpoint;
159
0
  optimizer_call_info *call_stack;
160
161
0
  if (op_array->last < 2) {
162
0
    return;
163
0
  }
164
165
0
  checkpoint = zend_arena_checkpoint(ctx->arena);
166
0
  call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info));
167
0
  while (opline < end) {
168
0
    switch (opline->opcode) {
169
0
      case ZEND_INIT_FCALL_BY_NAME:
170
0
      case ZEND_INIT_NS_FCALL_BY_NAME:
171
0
      case ZEND_INIT_STATIC_METHOD_CALL:
172
0
      case ZEND_INIT_METHOD_CALL:
173
0
      case ZEND_INIT_FCALL:
174
0
      case ZEND_NEW:
175
0
      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
0
        call_stack[call].func = zend_optimizer_get_called_func(
179
0
          ctx->script, op_array, opline, &call_stack[call].is_prototype);
180
0
        call_stack[call].try_inline =
181
0
          !call_stack[call].is_prototype
182
0
          && opline->opcode != ZEND_NEW
183
0
          && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL;
184
0
        ZEND_FALLTHROUGH;
185
0
      case ZEND_INIT_DYNAMIC_CALL:
186
0
      case ZEND_INIT_USER_CALL:
187
0
        call_stack[call].opline = opline;
188
0
        call_stack[call].func_arg_num = (uint32_t)-1;
189
0
        call++;
190
0
        break;
191
0
      case ZEND_DO_FCALL:
192
0
      case ZEND_DO_ICALL:
193
0
      case ZEND_DO_UCALL:
194
0
      case ZEND_DO_FCALL_BY_NAME:
195
0
      case ZEND_CALLABLE_CONVERT:
196
0
        call--;
197
0
        if (call_stack[call].func && call_stack[call].opline) {
198
0
          zend_op *fcall = call_stack[call].opline;
199
200
0
          if (fcall->opcode == ZEND_INIT_FCALL) {
201
            /* nothing to do */
202
0
          } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) {
203
0
            fcall->opcode = ZEND_INIT_FCALL;
204
0
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
205
0
            literal_dtor(&ZEND_OP2_LITERAL(fcall));
206
0
            fcall->op2.constant = fcall->op2.constant + 1;
207
0
          } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
208
0
            fcall->opcode = ZEND_INIT_FCALL;
209
0
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
210
0
            literal_dtor(&op_array->literals[fcall->op2.constant]);
211
0
            literal_dtor(&op_array->literals[fcall->op2.constant + 2]);
212
0
            fcall->op2.constant = fcall->op2.constant + 1;
213
0
          } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
214
0
              || fcall->opcode == ZEND_INIT_METHOD_CALL
215
0
              || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
216
0
              || fcall->opcode == ZEND_NEW) {
217
            /* We don't have specialized opcodes for this, do nothing */
218
0
          } else {
219
0
            ZEND_UNREACHABLE();
220
0
          }
221
222
          /* If the INIT opcode changed the DO opcode can also change to
223
           * a more optimized one.
224
           *
225
           * At this point we also know whether or not the result of
226
           * the DO opcode is used, allowing to optimize calls to
227
           * ZEND_ACC_NODISCARD functions. */
228
0
          if (opline->opcode != ZEND_CALLABLE_CONVERT) {
229
0
            opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline));
230
0
          }
231
232
0
          if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level)
233
0
              && call_stack[call].try_inline
234
0
              && opline->opcode != ZEND_CALLABLE_CONVERT) {
235
0
            zend_try_inline_call(op_array, fcall, opline, call_stack[call].func);
236
0
          }
237
0
        }
238
0
        call_stack[call].func = NULL;
239
0
        call_stack[call].opline = NULL;
240
0
        call_stack[call].try_inline = false;
241
0
        call_stack[call].func_arg_num = (uint32_t)-1;
242
0
        break;
243
0
      case ZEND_FETCH_FUNC_ARG:
244
0
      case ZEND_FETCH_STATIC_PROP_FUNC_ARG:
245
0
      case ZEND_FETCH_OBJ_FUNC_ARG:
246
0
      case ZEND_FETCH_DIM_FUNC_ARG:
247
0
        if (call_stack[call - 1].func_arg_num != (uint32_t)-1
248
0
            && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) {
249
0
          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
0
            if ((opline->opcode == ZEND_FETCH_OBJ_FUNC_ARG || opline->opcode == ZEND_FETCH_DIM_FUNC_ARG)
253
0
             && (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
0
              call_stack[call - 1].last_check_func_arg_opline = NULL;
256
0
              break;
257
0
            }
258
0
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
259
0
              opline->opcode -= 9;
260
0
            } else {
261
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_W;
262
0
            }
263
0
          } else {
264
0
            if (opline->opcode == ZEND_FETCH_DIM_FUNC_ARG
265
0
                && 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
0
              call_stack[call - 1].try_inline = false;
269
0
              break;
270
0
            }
271
272
0
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
273
0
              opline->opcode -= 12;
274
0
            } else {
275
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_R;
276
0
            }
277
0
          }
278
0
        }
279
0
        break;
280
0
      case ZEND_SEND_VAL_EX:
281
0
        if (opline->op2_type == IS_CONST) {
282
0
          call_stack[call - 1].try_inline = false;
283
0
          break;
284
0
        }
285
286
0
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
287
0
          if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
288
0
            opline->opcode = ZEND_SEND_VAL;
289
0
          }
290
0
        }
291
0
        break;
292
0
      case ZEND_CHECK_FUNC_ARG:
293
0
        if (opline->op2_type == IS_CONST) {
294
0
          call_stack[call - 1].try_inline = false;
295
0
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
296
0
          break;
297
0
        }
298
299
0
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
300
0
          call_stack[call - 1].func_arg_num = opline->op2.num;
301
0
          call_stack[call - 1].last_check_func_arg_opline = opline;
302
0
        }
303
0
        break;
304
0
      case ZEND_SEND_FUNC_ARG:
305
        /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */
306
0
        if (call_stack[call - 1].last_check_func_arg_opline == NULL) {
307
0
          if (opline->op2_type == IS_CONST) {
308
0
            call_stack[call - 1].try_inline = false;
309
0
          }
310
0
          break;
311
0
        }
312
0
        MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline);
313
0
        call_stack[call - 1].last_check_func_arg_opline = NULL;
314
0
        ZEND_FALLTHROUGH;
315
0
      case ZEND_SEND_VAR_EX:
316
0
        if (opline->op2_type == IS_CONST) {
317
0
          call_stack[call - 1].try_inline = false;
318
0
          break;
319
0
        }
320
321
0
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
322
0
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
323
0
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
324
0
            opline->opcode = ZEND_SEND_REF;
325
0
          } else {
326
0
            opline->opcode = ZEND_SEND_VAR;
327
0
          }
328
0
        }
329
0
        break;
330
0
      case ZEND_SEND_VAR_NO_REF_EX:
331
0
        if (opline->op2_type == IS_CONST) {
332
0
          call_stack[call - 1].try_inline = false;
333
0
          break;
334
0
        }
335
336
0
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
337
0
          if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
338
0
            opline->opcode = ZEND_SEND_VAR_NO_REF;
339
0
          } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
340
0
            opline->opcode = ZEND_SEND_VAL;
341
0
          } else {
342
0
            opline->opcode = ZEND_SEND_VAR;
343
0
          }
344
0
        }
345
0
        break;
346
0
      case ZEND_SEND_VAL:
347
0
      case ZEND_SEND_VAR:
348
0
      case ZEND_SEND_REF:
349
0
        if (opline->op2_type == IS_CONST) {
350
0
          call_stack[call - 1].try_inline = false;
351
0
          break;
352
0
        }
353
0
        break;
354
0
      case ZEND_SEND_UNPACK:
355
0
      case ZEND_SEND_USER:
356
0
      case ZEND_SEND_ARRAY:
357
0
        call_stack[call - 1].try_inline = false;
358
0
        break;
359
0
      default:
360
0
        break;
361
0
    }
362
0
    opline++;
363
0
  }
364
365
0
  zend_arena_release(&ctx->arena, checkpoint);
366
0
}