/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 | 256 | { |
40 | 256 | int call = 0; |
41 | | |
42 | 530 | while (1) { |
43 | 530 | switch (opline->opcode) { |
44 | 0 | case ZEND_INIT_FCALL_BY_NAME: |
45 | 0 | case ZEND_INIT_NS_FCALL_BY_NAME: |
46 | 20 | case ZEND_INIT_STATIC_METHOD_CALL: |
47 | 20 | case ZEND_INIT_METHOD_CALL: |
48 | 276 | case ZEND_INIT_FCALL: |
49 | 276 | case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL: |
50 | 276 | if (call == 0) { |
51 | 256 | MAKE_NOP(opline); |
52 | 256 | return; |
53 | 256 | } |
54 | 20 | ZEND_FALLTHROUGH; |
55 | 22 | case ZEND_NEW: |
56 | 22 | case ZEND_INIT_DYNAMIC_CALL: |
57 | 22 | case ZEND_INIT_USER_CALL: |
58 | 22 | call--; |
59 | 22 | break; |
60 | 14 | case ZEND_DO_FCALL: |
61 | 14 | case ZEND_DO_ICALL: |
62 | 22 | case ZEND_DO_UCALL: |
63 | 22 | case ZEND_DO_FCALL_BY_NAME: |
64 | 22 | call++; |
65 | 22 | break; |
66 | 58 | case ZEND_SEND_VAL: |
67 | 84 | case ZEND_SEND_VAR: |
68 | 84 | if (call == 0) { |
69 | 84 | zend_optimizer_convert_to_free_op1(op_array, opline); |
70 | 84 | } |
71 | 84 | break; |
72 | 530 | } |
73 | 274 | opline--; |
74 | 274 | } |
75 | 256 | } |
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 | 52.8k | { |
79 | 52.8k | const uint32_t no_discard = RETURN_VALUE_USED(opline) ? 0 : ZEND_ACC_NODISCARD; |
80 | | |
81 | 52.8k | if (func->type == ZEND_USER_FUNCTION |
82 | 10.9k | && !(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 | 8.67k | && !(func->op_array.fn_flags & (ZEND_ACC_TRAIT_CLONE)) |
85 | 8.67k | && fcall->extended_value >= func->op_array.required_num_args |
86 | 8.65k | && func->op_array.opcodes[func->op_array.num_args].opcode == ZEND_RETURN) { |
87 | | |
88 | 518 | zend_op *ret_opline = func->op_array.opcodes + func->op_array.num_args; |
89 | | |
90 | 518 | if (ret_opline->op1_type == IS_CONST) { |
91 | 302 | uint32_t i, num_args = func->op_array.num_args; |
92 | 302 | num_args += (func->op_array.fn_flags & ZEND_ACC_VARIADIC) != 0; |
93 | | |
94 | 302 | if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL |
95 | 18 | && !(func->op_array.fn_flags & ZEND_ACC_STATIC)) { |
96 | | /* Don't inline static call to instance method. */ |
97 | 0 | return; |
98 | 0 | } |
99 | | |
100 | 390 | 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 | 102 | if (ZEND_ARG_SEND_MODE(&func->op_array.arg_info[i])) { |
104 | 14 | return; |
105 | 14 | } |
106 | 102 | } |
107 | | |
108 | 288 | if (fcall->extended_value < func->op_array.num_args) { |
109 | | /* don't inline functions with named constants in default arguments */ |
110 | 34 | i = fcall->extended_value; |
111 | | |
112 | 38 | do { |
113 | 38 | 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 | 32 | return; |
115 | 32 | } |
116 | 6 | i++; |
117 | 6 | } while (i < func->op_array.num_args); |
118 | 34 | } |
119 | | |
120 | 256 | if (RETURN_VALUE_USED(opline)) { |
121 | 204 | zval zv; |
122 | | |
123 | 204 | ZVAL_COPY(&zv, CRT_CONSTANT_EX(&func->op_array, ret_opline, ret_opline->op1)); |
124 | 204 | opline->opcode = ZEND_QM_ASSIGN; |
125 | 204 | opline->op1_type = IS_CONST; |
126 | 204 | opline->op1.constant = zend_optimizer_add_literal(op_array, &zv); |
127 | 204 | SET_UNUSED(opline->op2); |
128 | 204 | } else { |
129 | 52 | MAKE_NOP(opline); |
130 | 52 | } |
131 | | |
132 | 256 | zend_delete_call_instructions(op_array, opline-1); |
133 | 256 | } |
134 | 518 | } |
135 | 52.8k | } |
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 | 14.0k | { |
140 | 14.0k | if (!info->func) { |
141 | 12.9k | return false; |
142 | 12.9k | } |
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 | 1.12k | return !info->is_prototype |
147 | 222 | || arg_num <= info->func->common.num_args |
148 | 4 | || (info->func->common.fn_flags & ZEND_ACC_VARIADIC); |
149 | 14.0k | } |
150 | | |
151 | | void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx) |
152 | 47.7k | { |
153 | 47.7k | zend_op *opline = op_array->opcodes; |
154 | 47.7k | const zend_op *end = opline + op_array->last; |
155 | 47.7k | int call = 0; |
156 | 47.7k | void *checkpoint; |
157 | 47.7k | optimizer_call_info *call_stack; |
158 | | |
159 | 47.7k | if (op_array->last < 2) { |
160 | 1.39k | return; |
161 | 1.39k | } |
162 | | |
163 | 46.3k | checkpoint = zend_arena_checkpoint(ctx->arena); |
164 | 46.3k | call_stack = zend_arena_calloc(&ctx->arena, op_array->last / 2, sizeof(optimizer_call_info)); |
165 | 1.18M | while (opline < end) { |
166 | 1.13M | switch (opline->opcode) { |
167 | 3.11k | case ZEND_INIT_FCALL_BY_NAME: |
168 | 4.57k | case ZEND_INIT_NS_FCALL_BY_NAME: |
169 | 7.42k | case ZEND_INIT_STATIC_METHOD_CALL: |
170 | 25.7k | case ZEND_INIT_METHOD_CALL: |
171 | 76.9k | case ZEND_INIT_FCALL: |
172 | 100k | case ZEND_NEW: |
173 | 100k | 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 | 100k | call_stack[call].func = zend_optimizer_get_called_func( |
177 | 100k | ctx->script, op_array, opline, &call_stack[call].is_prototype); |
178 | 100k | call_stack[call].try_inline = |
179 | 100k | !call_stack[call].is_prototype |
180 | 100k | && opline->opcode != ZEND_NEW |
181 | 76.9k | && opline->opcode != ZEND_INIT_PARENT_PROPERTY_HOOK_CALL; |
182 | 100k | ZEND_FALLTHROUGH; |
183 | 103k | case ZEND_INIT_DYNAMIC_CALL: |
184 | 103k | case ZEND_INIT_USER_CALL: |
185 | 103k | call_stack[call].opline = opline; |
186 | 103k | call_stack[call].func_arg_num = (uint32_t)-1; |
187 | 103k | call++; |
188 | 103k | break; |
189 | 98.4k | case ZEND_DO_FCALL: |
190 | 98.4k | case ZEND_DO_ICALL: |
191 | 103k | case ZEND_DO_UCALL: |
192 | 103k | case ZEND_DO_FCALL_BY_NAME: |
193 | 103k | case ZEND_CALLABLE_CONVERT: |
194 | 103k | call--; |
195 | 103k | if (call_stack[call].func && call_stack[call].opline) { |
196 | 55.4k | zend_op *fcall = call_stack[call].opline; |
197 | | |
198 | 55.4k | if (fcall->opcode == ZEND_INIT_FCALL) { |
199 | | /* nothing to do */ |
200 | 51.2k | } else if (fcall->opcode == ZEND_INIT_FCALL_BY_NAME) { |
201 | 605 | fcall->opcode = ZEND_INIT_FCALL; |
202 | 605 | fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func); |
203 | 605 | literal_dtor(&ZEND_OP2_LITERAL(fcall)); |
204 | 605 | fcall->op2.constant = fcall->op2.constant + 1; |
205 | 3.59k | } else if (fcall->opcode == ZEND_INIT_NS_FCALL_BY_NAME) { |
206 | 177 | fcall->opcode = ZEND_INIT_FCALL; |
207 | 177 | fcall->op1.num = zend_vm_calc_used_stack(fcall->extended_value, call_stack[call].func); |
208 | 177 | literal_dtor(&op_array->literals[fcall->op2.constant]); |
209 | 177 | literal_dtor(&op_array->literals[fcall->op2.constant + 2]); |
210 | 177 | fcall->op2.constant = fcall->op2.constant + 1; |
211 | 3.41k | } else if (fcall->opcode == ZEND_INIT_STATIC_METHOD_CALL |
212 | 1.71k | || fcall->opcode == ZEND_INIT_METHOD_CALL |
213 | 1.48k | || fcall->opcode == ZEND_INIT_PARENT_PROPERTY_HOOK_CALL |
214 | 3.41k | || fcall->opcode == ZEND_NEW) { |
215 | | /* We don't have specialized opcodes for this, do nothing */ |
216 | 3.41k | } 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 | 55.4k | if (opline->opcode != ZEND_CALLABLE_CONVERT) { |
227 | 55.2k | opline->opcode = zend_get_call_op(fcall, call_stack[call].func, !RESULT_UNUSED(opline)); |
228 | 55.2k | } |
229 | | |
230 | 55.4k | if ((ZEND_OPTIMIZER_PASS_16 & ctx->optimization_level) |
231 | 55.4k | && call_stack[call].try_inline |
232 | 52.9k | && opline->opcode != ZEND_CALLABLE_CONVERT) { |
233 | 52.8k | zend_try_inline_call(op_array, fcall, opline, call_stack[call].func); |
234 | 52.8k | } |
235 | 55.4k | } |
236 | 103k | call_stack[call].func = NULL; |
237 | 103k | call_stack[call].opline = NULL; |
238 | 103k | call_stack[call].try_inline = false; |
239 | 103k | call_stack[call].func_arg_num = (uint32_t)-1; |
240 | 103k | break; |
241 | 10 | case ZEND_FETCH_FUNC_ARG: |
242 | 176 | case ZEND_FETCH_STATIC_PROP_FUNC_ARG: |
243 | 374 | case ZEND_FETCH_OBJ_FUNC_ARG: |
244 | 717 | case ZEND_FETCH_DIM_FUNC_ARG: |
245 | 717 | if (call_stack[call - 1].func_arg_num != (uint32_t)-1 |
246 | 70 | && has_known_send_mode(&call_stack[call - 1], call_stack[call - 1].func_arg_num)) { |
247 | 70 | 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 | 20 | if ((opline->opcode == ZEND_FETCH_OBJ_FUNC_ARG || opline->opcode == ZEND_FETCH_DIM_FUNC_ARG) |
251 | 20 | && (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 | 4 | call_stack[call - 1].last_check_func_arg_opline = NULL; |
254 | 4 | break; |
255 | 4 | } |
256 | 16 | if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) { |
257 | 16 | opline->opcode -= 9; |
258 | 16 | } else { |
259 | 0 | opline->opcode = ZEND_FETCH_STATIC_PROP_W; |
260 | 0 | } |
261 | 50 | } else { |
262 | 50 | if (opline->opcode == ZEND_FETCH_DIM_FUNC_ARG |
263 | 20 | && 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 | 6 | call_stack[call - 1].try_inline = false; |
267 | 6 | break; |
268 | 6 | } |
269 | | |
270 | 44 | if (opline->opcode != ZEND_FETCH_STATIC_PROP_FUNC_ARG) { |
271 | 44 | opline->opcode -= 12; |
272 | 44 | } else { |
273 | 0 | opline->opcode = ZEND_FETCH_STATIC_PROP_R; |
274 | 0 | } |
275 | 44 | } |
276 | 70 | } |
277 | 707 | break; |
278 | 7.47k | case ZEND_SEND_VAL_EX: |
279 | 7.47k | if (opline->op2_type == IS_CONST) { |
280 | 326 | call_stack[call - 1].try_inline = false; |
281 | 326 | break; |
282 | 326 | } |
283 | | |
284 | 7.14k | if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) { |
285 | 377 | if (!ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) { |
286 | 337 | opline->opcode = ZEND_SEND_VAL; |
287 | 337 | } |
288 | 377 | } |
289 | 7.14k | break; |
290 | 631 | case ZEND_CHECK_FUNC_ARG: |
291 | 631 | if (opline->op2_type == IS_CONST) { |
292 | 70 | call_stack[call - 1].try_inline = false; |
293 | 70 | call_stack[call - 1].func_arg_num = (uint32_t)-1; |
294 | 70 | break; |
295 | 70 | } |
296 | | |
297 | 561 | if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) { |
298 | 72 | call_stack[call - 1].func_arg_num = opline->op2.num; |
299 | 72 | call_stack[call - 1].last_check_func_arg_opline = opline; |
300 | 72 | } |
301 | 561 | break; |
302 | 631 | case ZEND_SEND_FUNC_ARG: |
303 | | /* Don't transform SEND_FUNC_ARG if any FETCH opcodes weren't transformed. */ |
304 | 631 | if (call_stack[call - 1].last_check_func_arg_opline == NULL) { |
305 | 563 | if (opline->op2_type == IS_CONST) { |
306 | 70 | call_stack[call - 1].try_inline = false; |
307 | 70 | } |
308 | 563 | break; |
309 | 563 | } |
310 | 68 | MAKE_NOP(call_stack[call - 1].last_check_func_arg_opline); |
311 | 68 | call_stack[call - 1].last_check_func_arg_opline = NULL; |
312 | 68 | ZEND_FALLTHROUGH; |
313 | 5.80k | case ZEND_SEND_VAR_EX: |
314 | 5.80k | if (opline->op2_type == IS_CONST) { |
315 | 248 | call_stack[call - 1].try_inline = false; |
316 | 248 | break; |
317 | 248 | } |
318 | | |
319 | 5.55k | if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) { |
320 | 514 | call_stack[call - 1].func_arg_num = (uint32_t)-1; |
321 | 514 | if (ARG_SHOULD_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) { |
322 | 24 | opline->opcode = ZEND_SEND_REF; |
323 | 490 | } else { |
324 | 490 | opline->opcode = ZEND_SEND_VAR; |
325 | 490 | } |
326 | 514 | } |
327 | 5.55k | break; |
328 | 838 | case ZEND_SEND_VAR_NO_REF_EX: |
329 | 838 | if (opline->op2_type == IS_CONST) { |
330 | 100 | call_stack[call - 1].try_inline = false; |
331 | 100 | break; |
332 | 100 | } |
333 | | |
334 | 738 | if (has_known_send_mode(&call_stack[call - 1], opline->op2.num)) { |
335 | 91 | if (ARG_MUST_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) { |
336 | 64 | opline->opcode = ZEND_SEND_VAR_NO_REF; |
337 | 64 | } else if (ARG_MAY_BE_SENT_BY_REF(call_stack[call - 1].func, opline->op2.num)) { |
338 | 0 | opline->opcode = ZEND_SEND_VAL; |
339 | 27 | } else { |
340 | 27 | opline->opcode = ZEND_SEND_VAR; |
341 | 27 | } |
342 | 91 | } |
343 | 738 | break; |
344 | 51.9k | case ZEND_SEND_VAL: |
345 | 79.6k | case ZEND_SEND_VAR: |
346 | 80.7k | case ZEND_SEND_REF: |
347 | 80.7k | if (opline->op2_type == IS_CONST) { |
348 | 356 | call_stack[call - 1].try_inline = false; |
349 | 356 | break; |
350 | 356 | } |
351 | 80.3k | break; |
352 | 80.3k | case ZEND_SEND_UNPACK: |
353 | 1.66k | case ZEND_SEND_USER: |
354 | 1.92k | case ZEND_SEND_ARRAY: |
355 | 1.92k | call_stack[call - 1].try_inline = false; |
356 | 1.92k | break; |
357 | 831k | default: |
358 | 831k | break; |
359 | 1.13M | } |
360 | 1.13M | opline++; |
361 | 1.13M | } |
362 | | |
363 | 46.3k | zend_arena_release(&ctx->arena, checkpoint); |
364 | 46.3k | } |