Coverage Report

Created: 2025-12-31 07:28

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
16
{
42
16
  int call = 0;
43
44
16
  while (1) {
45
16
    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
16
      case ZEND_INIT_FCALL:
51
16
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
52
16
        if (call == 0) {
53
16
          MAKE_NOP(opline);
54
16
          return;
55
16
        }
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
16
    }
75
0
    opline--;
76
0
  }
77
16
}
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
20.2k
{
81
20.2k
  const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD;
82
83
20.2k
  if (func->type == ZEND_USER_FUNCTION
84
3.20k
   && !(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
2.71k
   && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE))
87
2.71k
   && fcall->extended_value >= func->op_array.required_num_args
88
2.70k
   && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) {
89
90
58
    zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args;
91
92
58
    if (ret_opline->op1_type == IS_CONST) {
93
24
      uint32_t i, num_args = func->op_array.num_args;
94
24
      num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0;
95
96
24
      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
32
      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
8
        if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) {
106
0
          return;
107
0
        }
108
8
      }
109
110
24
      if (fcall->extended_value < func->op_array.num_args) {
111
        /* don't inline functions with named constants in default arguments */
112
8
        i = fcall->extended_value;
113
114
8
        do {
115
8
          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
8
            return;
117
8
          }
118
0
          i++;
119
0
        } while (i < func->op_array.num_args);
120
8
      }
121
122
16
      if (RETURN_VALUE_USED(opline)) {
123
16
        zval zv;
124
125
16
        ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1));
126
16
        opline->opcode = ZEND_QM_ASSIGN;
127
16
        opline->op1_type = IS_CONST;
128
16
        opline->op1.constant = zend_optimizer_add_literal(op_array, &zv);
129
16
        SET_UNUSED(opline->op2);
130
16
      } else {
131
0
        MAKE_NOP(opline);
132
0
      }
133
134
16
      zend_delete_call_instructions(op_array, opline-1);
135
16
    }
136
58
  }
137
20.2k
}
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
8.20k
{
142
8.20k
  if (!info->func) {
143
7.73k
    return false;
144
7.73k
  }
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
470
  return !info->is_prototype
149
82
    || arg_num <= info->func->common.num_args
150
0
    || (info->func->common.fn_flags & ZEND_ACC_VARIADIC);
151
8.20k
}
152
153
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx)
154
17.0k
{
155
17.0k
  zend_op *opline = op_array->opcodes;
156
17.0k
  const zend_op *end = opline + op_array->last;
157
17.0k
  int call = 0;
158
17.0k
  void *checkpoint;
159
17.0k
  optimizer_call_info *call_stack;
160
161
17.0k
  if (op_array->last < 2) {
162
270
    return;
163
270
  }
164
165
16.7k
  checkpoint = zend_arena_checkpoint(ctx->arena);
166
16.7k
  call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info));
167
1.00M
  while (opline < end) {
168
987k
    switch (opline->opcode) {
169
1.65k
      case ZEND_INIT_FCALL_BY_NAME:
170
2.00k
      case ZEND_INIT_NS_FCALL_BY_NAME:
171
2.98k
      case ZEND_INIT_STATIC_METHOD_CALL:
172
16.8k
      case ZEND_INIT_METHOD_CALL:
173
36.5k
      case ZEND_INIT_FCALL:
174
54.7k
      case ZEND_NEW:
175
54.7k
      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
54.7k
        call_stack[call].func = zend_optimizer_get_called_func(
179
54.7k
          ctx->script, op_array, opline, &call_stack[call].is_prototype);
180
54.7k
        call_stack[call].try_inline =
181
54.7k
          !call_stack[call].is_prototype
182
54.6k
          && opline->opcode != ZEND_NEW
183
36.4k
          && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL;
184
54.7k
        ZEND_FALLTHROUGH;
185
55.3k
      case ZEND_INIT_DYNAMIC_CALL:
186
55.4k
      case ZEND_INIT_USER_CALL:
187
55.4k
        call_stack[call].opline = opline;
188
55.4k
        call_stack[call].func_arg_num = (uint32_t)-1;
189
55.4k
        call++;
190
55.4k
        break;
191
53.9k
      case ZEND_DO_FCALL:
192
53.9k
      case ZEND_DO_ICALL:
193
55.4k
      case ZEND_DO_UCALL:
194
55.4k
      case ZEND_DO_FCALL_BY_NAME:
195
55.4k
      case ZEND_CALLABLE_CONVERT:
196
55.4k
        call--;
197
55.4k
        if (call_stack[call].func && call_stack[call].opline) {
198
20.9k
          zend_op *fcall = call_stack[call].opline;
199
200
20.9k
          if (fcall->opcode == ZEND_INIT_FCALL) {
201
            /* nothing to do */
202
19.6k
          } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) {
203
235
            fcall->opcode = ZEND_INIT_FCALL;
204
235
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
205
235
            literal_dtor(&ZEND_OP2_LITERAL(fcall));
206
235
            fcall->op2.constant = fcall->op2.constant + 1;
207
1.02k
          } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
208
8
            fcall->opcode = ZEND_INIT_FCALL;
209
8
            fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func);
210
8
            literal_dtor(&op_array->literals[fcall->op2.constant]);
211
8
            literal_dtor(&op_array->literals[fcall->op2.constant + 2]);
212
8
            fcall->op2.constant = fcall->op2.constant + 1;
213
1.01k
          } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL
214
349
              || fcall->opcode == ZEND_INIT_METHOD_CALL
215
239
              || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL
216
1.01k
              || fcall->opcode == ZEND_NEW) {
217
            /* We don't have specialized opcodes for this, do nothing */
218
1.01k
          } 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
20.9k
          if (opline->opcode != ZEND_CALLABLE_CONVERT) {
229
20.9k
            opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline));
230
20.9k
          }
231
232
20.9k
          if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level)
233
20.9k
              && call_stack[call].try_inline
234
20.2k
              && opline->opcode != ZEND_CALLABLE_CONVERT) {
235
20.2k
            zend_try_inline_call(op_array, fcall, opline, call_stack[call].func);
236
20.2k
          }
237
20.9k
        }
238
55.4k
        call_stack[call].func = NULL;
239
55.4k
        call_stack[call].opline = NULL;
240
55.4k
        call_stack[call].try_inline = false;
241
55.4k
        call_stack[call].func_arg_num = (uint32_t)-1;
242
55.4k
        break;
243
0
      case ZEND_FETCH_FUNC_ARG:
244
280
      case ZEND_FETCH_STATIC_PROP_FUNC_ARG:
245
616
      case ZEND_FETCH_OBJ_FUNC_ARG:
246
931
      case ZEND_FETCH_DIM_FUNC_ARG:
247
931
        if (call_stack[call - 1].func_arg_num != (uint32_t)-1
248
10
            && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) {
249
10
          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
10
          } else {
264
10
            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
10
            if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) {
273
10
              opline->opcode -= 12;
274
10
            } else {
275
0
              opline->opcode = ZEND_FETCH_STATIC_PROP_R;
276
0
            }
277
10
          }
278
10
        }
279
931
        break;
280
3.28k
      case ZEND_SEND_VAL_EX:
281
3.28k
        if (opline->op2_type == IS_CONST) {
282
226
          call_stack[call - 1].try_inline = false;
283
226
          break;
284
226
        }
285
286
3.06k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
287
176
          if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
288
174
            opline->opcode = ZEND_SEND_VAL;
289
174
          }
290
176
        }
291
3.06k
        break;
292
741
      case ZEND_CHECK_FUNC_ARG:
293
741
        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
741
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
300
10
          call_stack[call - 1].func_arg_num = opline->op2.num;
301
10
          call_stack[call - 1].last_check_func_arg_opline = opline;
302
10
        }
303
741
        break;
304
741
      case ZEND_SEND_FUNC_ARG:
305
        /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */
306
741
        if (call_stack[call - 1].last_check_func_arg_opline == NULL) {
307
731
          if (opline->op2_type == IS_CONST) {
308
0
            call_stack[call - 1].try_inline = false;
309
0
          }
310
731
          break;
311
731
        }
312
10
        MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline);
313
10
        call_stack[call - 1].last_check_func_arg_opline = NULL;
314
10
        ZEND_FALLTHROUGH;
315
4.11k
      case ZEND_SEND_VAR_EX:
316
4.11k
        if (opline->op2_type == IS_CONST) {
317
182
          call_stack[call - 1].try_inline = false;
318
182
          break;
319
182
        }
320
321
3.92k
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
322
154
          call_stack[call - 1].func_arg_num = (uint32_t)-1;
323
154
          if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
324
0
            opline->opcode = ZEND_SEND_REF;
325
154
          } else {
326
154
            opline->opcode = ZEND_SEND_VAR;
327
154
          }
328
154
        }
329
3.92k
        break;
330
626
      case ZEND_SEND_VAR_NO_REF_EX:
331
626
        if (opline->op2_type == IS_CONST) {
332
160
          call_stack[call - 1].try_inline = false;
333
160
          break;
334
160
        }
335
336
466
        if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) {
337
120
          if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
338
114
            opline->opcode = ZEND_SEND_VAR_NO_REF;
339
114
          } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) {
340
0
            opline->opcode = ZEND_SEND_VAL;
341
6
          } else {
342
6
            opline->opcode = ZEND_SEND_VAR;
343
6
          }
344
120
        }
345
466
        break;
346
13.6k
      case ZEND_SEND_VAL:
347
48.0k
      case ZEND_SEND_VAR:
348
48.5k
      case ZEND_SEND_REF:
349
48.5k
        if (opline->op2_type == IS_CONST) {
350
280
          call_stack[call - 1].try_inline = false;
351
280
          break;
352
280
        }
353
48.2k
        break;
354
48.2k
      case ZEND_SEND_UNPACK:
355
24
      case ZEND_SEND_USER:
356
100
      case ZEND_SEND_ARRAY:
357
100
        call_stack[call - 1].try_inline = false;
358
100
        break;
359
817k
      default:
360
817k
        break;
361
987k
    }
362
987k
    opline++;
363
987k
  }
364
365
16.7k
  zend_arena_release(&ctx->arena, checkpoint);
366
16.7k
}