1 /*
2 +----------------------------------------------------------------------+
3 | Zend JIT |
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 | Hao Sun <hao.sun@arm.com> |
18 +----------------------------------------------------------------------+
19 */
20
21 #ifndef ZEND_JIT_INTERNAL_H
22 #define ZEND_JIT_INTERNAL_H
23
24 #include "zend_bitset.h"
25
26 /* Register Set */
27 #define ZEND_REGSET_EMPTY 0
28
29 #define ZEND_REGSET_IS_EMPTY(regset) \
30 (regset == ZEND_REGSET_EMPTY)
31
32 #define ZEND_REGSET_IS_SINGLETON(regset) \
33 (regset && !(regset & (regset - 1)))
34
35 #if (!ZEND_REGSET_64BIT)
36 #define ZEND_REGSET(reg) \
37 (1u << (reg))
38 #else
39 #define ZEND_REGSET(reg) \
40 (1ull << (reg))
41 #endif
42
43 #if (!ZEND_REGSET_64BIT)
44 #define ZEND_REGSET_INTERVAL(reg1, reg2) \
45 (((1u << ((reg2) - (reg1) + 1)) - 1) << (reg1))
46 #else
47 #define ZEND_REGSET_INTERVAL(reg1, reg2) \
48 (((1ull << ((reg2) - (reg1) + 1)) - 1) << (reg1))
49 #endif
50
51 #define ZEND_REGSET_IN(regset, reg) \
52 (((regset) & ZEND_REGSET(reg)) != 0)
53
54 #define ZEND_REGSET_INCL(regset, reg) \
55 (regset) |= ZEND_REGSET(reg)
56
57 #define ZEND_REGSET_EXCL(regset, reg) \
58 (regset) &= ~ZEND_REGSET(reg)
59
60 #define ZEND_REGSET_UNION(set1, set2) \
61 ((set1) | (set2))
62
63 #define ZEND_REGSET_INTERSECTION(set1, set2) \
64 ((set1) & (set2))
65
66 #define ZEND_REGSET_DIFFERENCE(set1, set2) \
67 ((set1) & ~(set2))
68
69 #if !defined(_WIN32)
70 # if (!ZEND_REGSET_64BIT)
71 # define ZEND_REGSET_FIRST(set) ((zend_reg)__builtin_ctz(set))
72 # define ZEND_REGSET_LAST(set) ((zend_reg)(__builtin_clz(set)^31))
73 # else
74 # define ZEND_REGSET_FIRST(set) ((zend_reg)__builtin_ctzll(set))
75 # define ZEND_REGSET_LAST(set) ((zend_reg)(__builtin_clzll(set)^63))
76 # endif
77 #else
78 # include <intrin.h>
__zend_jit_ctz(uint32_t value)79 uint32_t __inline __zend_jit_ctz(uint32_t value) {
80 DWORD trailing_zero = 0;
81 if (_BitScanForward(&trailing_zero, value)) {
82 return trailing_zero;
83 }
84 return 32;
85 }
__zend_jit_clz(uint32_t value)86 uint32_t __inline __zend_jit_clz(uint32_t value) {
87 DWORD leading_zero = 0;
88 if (_BitScanReverse(&leading_zero, value)) {
89 return 31 - leading_zero;
90 }
91 return 32;
92 }
93 # define ZEND_REGSET_FIRST(set) ((zend_reg)__zend_jit_ctz(set))
94 # define ZEND_REGSET_LAST(set) ((zend_reg)(__zend_jit_clz(set)^31))
95 #endif
96
97 #define ZEND_REGSET_FOREACH(set, reg) \
98 do { \
99 zend_regset _tmp = (set); \
100 while (!ZEND_REGSET_IS_EMPTY(_tmp)) { \
101 zend_reg _reg = ZEND_REGSET_FIRST(_tmp); \
102 ZEND_REGSET_EXCL(_tmp, _reg); \
103 reg = _reg; \
104
105 #define ZEND_REGSET_FOREACH_END() \
106 } \
107 } while (0)
108
109 /* Register Names */
110 extern const char *zend_reg_name[];
111
112 /* Address Encoding */
113 typedef uintptr_t zend_jit_addr;
114
115 #define IS_CONST_ZVAL 0
116 #define IS_MEM_ZVAL 1
117 #define IS_REG 2
118
119 #define _ZEND_ADDR_MODE_MASK 0x3
120 #define _ZEND_ADDR_REG_SHIFT 2
121 #define _ZEND_ADDR_REG_MASK 0x3f /* no more than 64 registers */
122 #define _ZEND_ADDR_OFFSET_SHIFT 8
123 #define _ZEND_ADDR_REG_STORE_BIT 8
124 #define _ZEND_ADDR_REG_LOAD_BIT 9
125 #define _ZEND_ADDR_REG_LAST_USE_BIT 10
126
127 #define ZEND_ADDR_CONST_ZVAL(zv) \
128 (((zend_jit_addr)(uintptr_t)(zv)) | IS_CONST_ZVAL)
129 #define ZEND_ADDR_MEM_ZVAL(reg, offset) \
130 ((((zend_jit_addr)(uintptr_t)(offset)) << _ZEND_ADDR_OFFSET_SHIFT) | \
131 (((zend_jit_addr)(uintptr_t)(reg)) << _ZEND_ADDR_REG_SHIFT) | \
132 IS_MEM_ZVAL)
133 #define ZEND_ADDR_REG(reg) \
134 ((((zend_jit_addr)(uintptr_t)(reg)) << _ZEND_ADDR_REG_SHIFT) | \
135 IS_REG)
136
137 #define Z_MODE(addr) (((addr) & _ZEND_ADDR_MODE_MASK))
138 #define Z_ZV(addr) ((zval*)(addr))
139 #define Z_OFFSET(addr) ((uint32_t)((addr)>>_ZEND_ADDR_OFFSET_SHIFT))
140 #define Z_REG(addr) ((zend_reg)(((addr)>>_ZEND_ADDR_REG_SHIFT) & _ZEND_ADDR_REG_MASK))
141 #define Z_STORE(addr) ((zend_reg)(((addr)>>_ZEND_ADDR_REG_STORE_BIT) & 1))
142 #define Z_LOAD(addr) ((zend_reg)(((addr)>>_ZEND_ADDR_REG_LOAD_BIT) & 1))
143 #define Z_LAST_USE(addr) ((zend_reg)(((addr)>>_ZEND_ADDR_REG_LAST_USE_BIT) & 1))
144
145 #define OP_REG_EX(reg, store, load, last_use) \
146 ((reg) | \
147 ((store) ? (1 << (_ZEND_ADDR_REG_STORE_BIT-_ZEND_ADDR_REG_SHIFT)) : 0) | \
148 ((load) ? (1 << (_ZEND_ADDR_REG_LOAD_BIT-_ZEND_ADDR_REG_SHIFT)) : 0) | \
149 ((last_use) ? (1 << (_ZEND_ADDR_REG_LAST_USE_BIT-_ZEND_ADDR_REG_SHIFT)) : 0) \
150 )
151
152 #define OP_REG(ssa_op, op) \
153 (ra && ssa_op->op >= 0 && ra[ssa_op->op] ? \
154 OP_REG_EX(ra[ssa_op->op]->reg, \
155 (ra[ssa_op->op]->flags & ZREG_STORE), \
156 (ra[ssa_op->op]->flags & ZREG_LOAD), \
157 zend_ival_is_last_use(ra[ssa_op->op], ssa_op - ssa->ops) \
158 ) : ZREG_NONE)
159
_zend_jit_decode_op(zend_uchar op_type,znode_op op,const zend_op * opline,zend_reg reg)160 static zend_always_inline zend_jit_addr _zend_jit_decode_op(zend_uchar op_type, znode_op op, const zend_op *opline, zend_reg reg)
161 {
162 if (op_type == IS_CONST) {
163 #if ZEND_USE_ABS_CONST_ADDR
164 return ZEND_ADDR_CONST_ZVAL(op.zv);
165 #else
166 return ZEND_ADDR_CONST_ZVAL(RT_CONSTANT(opline, op));
167 #endif
168 } else {
169 ZEND_ASSERT(op_type & (IS_CV|IS_TMP_VAR|IS_VAR));
170 if (reg != ZREG_NONE) {
171 return ZEND_ADDR_REG(reg);
172 } else {
173 return ZEND_ADDR_MEM_ZVAL(ZREG_FP, op.var);
174 }
175 }
176 }
177
178 #define OP_ADDR(opline, type, op) \
179 _zend_jit_decode_op((opline)->type, (opline)->op, opline, ZREG_NONE)
180
181 #define OP1_ADDR() \
182 OP_ADDR(opline, op1_type, op1)
183 #define OP2_ADDR() \
184 OP_ADDR(opline, op2_type, op2)
185 #define RES_ADDR() \
186 OP_ADDR(opline, result_type, result)
187 #define OP1_DATA_ADDR() \
188 OP_ADDR(opline + 1, op1_type, op1)
189
190 #define OP_REG_ADDR(opline, type, _op, _ssa_op) \
191 _zend_jit_decode_op((opline)->type, (opline)->_op, opline, \
192 OP_REG(ssa_op, _ssa_op))
193
194 #define OP1_REG_ADDR() \
195 OP_REG_ADDR(opline, op1_type, op1, op1_use)
196 #define OP2_REG_ADDR() \
197 OP_REG_ADDR(opline, op2_type, op2, op2_use)
198 #define RES_REG_ADDR() \
199 OP_REG_ADDR(opline, result_type, result, result_def)
200 #define OP1_DATA_REG_ADDR() \
201 OP_REG_ADDR(opline + 1, op1_type, op1, op1_use)
202
203 #define OP1_DEF_REG_ADDR() \
204 OP_REG_ADDR(opline, op1_type, op1, op1_def)
205 #define OP2_DEF_REG_ADDR() \
206 OP_REG_ADDR(opline, op2_type, op2, op2_def)
207 #define RES_USE_REG_ADDR() \
208 OP_REG_ADDR(opline, result_type, result, result_use)
209 #define OP1_DATA_DEF_REG_ADDR() \
210 OP_REG_ADDR(opline + 1, op1_type, op1, op1_def)
211
zend_jit_same_addr(zend_jit_addr addr1,zend_jit_addr addr2)212 static zend_always_inline bool zend_jit_same_addr(zend_jit_addr addr1, zend_jit_addr addr2)
213 {
214 if (addr1 == addr2) {
215 return 1;
216 } else if (Z_MODE(addr1) == IS_REG && Z_MODE(addr2) == IS_REG) {
217 return Z_REG(addr1) == Z_REG(addr2);
218 }
219 return 0;
220 }
221
222 typedef struct _zend_jit_op_array_extension {
223 zend_func_info func_info;
224 const void *orig_handler;
225 } zend_jit_op_array_extension;
226
227 /* Profiler */
228 extern zend_ulong zend_jit_profile_counter;
229 extern int zend_jit_profile_counter_rid;
230
231 #define ZEND_COUNTER_INFO(op_array) \
232 ZEND_OP_ARRAY_EXTENSION(op_array, zend_jit_profile_counter_rid)
233
234 /* Hot Counters */
235
236 #define ZEND_HOT_COUNTERS_COUNT 128
237
238 extern int16_t zend_jit_hot_counters[ZEND_HOT_COUNTERS_COUNT];
239
zend_jit_hash(const void * ptr)240 static zend_always_inline zend_long zend_jit_hash(const void *ptr)
241 {
242 uintptr_t x;
243
244 x = (uintptr_t)ptr >> 3;
245 #if SIZEOF_SIZE_T == 4
246 x = ((x >> 16) ^ x) * 0x45d9f3b;
247 x = ((x >> 16) ^ x) * 0x45d9f3b;
248 x = (x >> 16) ^ x;
249 #elif SIZEOF_SIZE_T == 8
250 x = (x ^ (x >> 30)) * 0xbf58476d1ce4e5b9;
251 x = (x ^ (x >> 27)) * 0x94d049bb133111eb;
252 x = x ^ (x >> 31);
253 #endif
254 return x;
255 }
256
257 void ZEND_FASTCALL zend_jit_hot_func(zend_execute_data *execute_data, const zend_op *opline);
258
259 typedef struct _zend_jit_op_array_hot_extension {
260 zend_func_info func_info;
261 int16_t *counter;
262 const void *orig_handlers[1];
263 } zend_jit_op_array_hot_extension;
264
265 #define zend_jit_op_array_hash(op_array) \
266 zend_jit_hash((op_array)->opcodes)
267
268 extern const zend_op *zend_jit_halt_op;
269
270 #ifdef HAVE_GCC_GLOBAL_REGS
271 # define EXECUTE_DATA_D void
272 # define EXECUTE_DATA_C
273 # define EXECUTE_DATA_DC
274 # define EXECUTE_DATA_CC
275 # define OPLINE_D void
276 # define OPLINE_C
277 # define OPLINE_DC
278 # define OPLINE_CC
279 # define ZEND_OPCODE_HANDLER_RET void
280 # define ZEND_OPCODE_HANDLER_ARGS EXECUTE_DATA_D
281 # define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU
282 # define ZEND_OPCODE_HANDLER_ARGS_DC
283 # define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU_CC
284 # define ZEND_OPCODE_RETURN() return
285 # define ZEND_OPCODE_TAIL_CALL(handler) do { \
286 handler(ZEND_OPCODE_HANDLER_ARGS_PASSTHRU); \
287 return; \
288 } while(0)
289 # define ZEND_OPCODE_TAIL_CALL_EX(handler, arg) do { \
290 handler(arg ZEND_OPCODE_HANDLER_ARGS_PASSTHRU_CC); \
291 return; \
292 } while(0)
293 #else
294 # define EXECUTE_DATA_D zend_execute_data* execute_data
295 # define EXECUTE_DATA_C execute_data
296 # define EXECUTE_DATA_DC , EXECUTE_DATA_D
297 # define EXECUTE_DATA_CC , EXECUTE_DATA_C
298 # define OPLINE_D const zend_op* opline
299 # define OPLINE_C opline
300 # define OPLINE_DC , OPLINE_D
301 # define OPLINE_CC , OPLINE_C
302 # define ZEND_OPCODE_HANDLER_RET int
303 # define ZEND_OPCODE_HANDLER_ARGS EXECUTE_DATA_D
304 # define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU EXECUTE_DATA_C
305 # define ZEND_OPCODE_HANDLER_ARGS_DC EXECUTE_DATA_DC
306 # define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU_CC EXECUTE_DATA_CC
307 # define ZEND_OPCODE_RETURN() return 0
308 # define ZEND_OPCODE_TAIL_CALL(handler) do { \
309 return handler(ZEND_OPCODE_HANDLER_ARGS_PASSTHRU); \
310 } while(0)
311 # define ZEND_OPCODE_TAIL_CALL_EX(handler, arg) do { \
312 return handler(arg ZEND_OPCODE_HANDLER_ARGS_PASSTHRU_CC); \
313 } while(0)
314 #endif
315
316 /* VM handlers */
317 typedef ZEND_OPCODE_HANDLER_RET (ZEND_FASTCALL *zend_vm_opcode_handler_t)(ZEND_OPCODE_HANDLER_ARGS);
318
319 /* VM helpers */
320 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_leave_nested_func_helper(uint32_t call_info EXECUTE_DATA_DC);
321 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_leave_top_func_helper(uint32_t call_info EXECUTE_DATA_DC);
322 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_leave_func_helper(EXECUTE_DATA_D);
323
324 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_profile_helper(ZEND_OPCODE_HANDLER_ARGS);
325
326 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_func_counter_helper(ZEND_OPCODE_HANDLER_ARGS);
327 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_loop_counter_helper(ZEND_OPCODE_HANDLER_ARGS);
328
329 void ZEND_FASTCALL zend_jit_copy_extra_args_helper(EXECUTE_DATA_D);
330 bool ZEND_FASTCALL zend_jit_deprecated_helper(OPLINE_D);
331
332 zend_constant* ZEND_FASTCALL zend_jit_get_constant(const zval *key, uint32_t flags);
333 zend_constant* ZEND_FASTCALL zend_jit_check_constant(const zval *key);
334
335 /* Tracer */
336 #define zend_jit_opline_hash(opline) \
337 zend_jit_hash(opline)
338
339 #define ZEND_JIT_TRACE_STOP(_) \
340 _(LOOP, "loop") \
341 _(RECURSIVE_CALL, "recursive call") \
342 _(RECURSIVE_RET, "recursive return") \
343 _(RETURN, "return") \
344 _(INTERPRETER, "exit to VM interpreter") \
345 _(LINK, "link to another trace") \
346 /* compilation and linking successful */ \
347 _(COMPILED, "compiled") \
348 _(ALREADY_DONE, "already prcessed") \
349 /* failures */ \
350 _(ERROR, "error") /* not used */ \
351 _(NOT_SUPPORTED, "not supported instructions") \
352 _(EXCEPTION, "exception") \
353 _(TOO_LONG, "trace too long") \
354 _(TOO_DEEP, "trace too deep") \
355 _(TOO_DEEP_RET, "trace too deep return") \
356 _(DEEP_RECURSION, "deep recursion") \
357 _(LOOP_UNROLL, "loop unroll limit reached") \
358 _(LOOP_EXIT, "exit from loop") \
359 _(RECURSION_EXIT, "return from recursive function") \
360 _(BLACK_LIST, "trace blacklisted") \
361 _(INNER_LOOP, "inner loop") /* trace it */ \
362 _(COMPILED_LOOP, "compiled loop") \
363 _(TRAMPOLINE, "trampoline call") \
364 _(BAD_FUNC, "bad function call") \
365 _(COMPILER_ERROR, "JIT compilation error") \
366 /* no recoverable error (blacklist immediately) */ \
367 _(NO_SHM, "insufficient shared memory") \
368 _(TOO_MANY_TRACES, "too many traces") \
369 _(TOO_MANY_CHILDREN, "too many side traces") \
370 _(TOO_MANY_EXITS, "too many side exits") \
371
372 #define ZEND_JIT_TRACE_STOP_NAME(name, description) \
373 ZEND_JIT_TRACE_STOP_ ## name,
374
375 typedef enum _zend_jit_trace_stop {
376 ZEND_JIT_TRACE_STOP(ZEND_JIT_TRACE_STOP_NAME)
377 ZEND_JIT_TRACE_HALT = 0x40
378 } zend_jit_trace_stop;
379
380 #define ZEND_JIT_TRACE_STOP_OK(ret) \
381 (ret < ZEND_JIT_TRACE_STOP_COMPILED)
382
383 #define ZEND_JIT_TRACE_STOP_DONE(ret) \
384 (ret < ZEND_JIT_TRACE_STOP_ERROR)
385
386 #define ZEND_JIT_TRACE_STOP_REPEAT(ret) \
387 (ret == ZEND_JIT_TRACE_STOP_INNER_LOOP)
388
389 #define ZEND_JIT_TRACE_STOP_MAY_RECOVER(ret) \
390 (ret <= ZEND_JIT_TRACE_STOP_COMPILER_ERROR)
391
392 #define ZEND_JIT_TRACE_START_MASK 0xf
393
394 #define ZEND_JIT_TRACE_START_LOOP (1<<0)
395 #define ZEND_JIT_TRACE_START_ENTER (1<<1)
396 #define ZEND_JIT_TRACE_START_RETURN (1<<2)
397 #define ZEND_JIT_TRACE_START_SIDE (1<<3) /* used for side traces */
398
399 #define ZEND_JIT_TRACE_JITED (1<<4)
400 #define ZEND_JIT_TRACE_BLACKLISTED (1<<5)
401 #define ZEND_JIT_TRACE_UNSUPPORTED (1<<6)
402
403 #define ZEND_JIT_TRACE_SUPPORTED 0
404
405 #define ZEND_JIT_EXIT_JITED (1<<0)
406 #define ZEND_JIT_EXIT_BLACKLISTED (1<<1)
407 #define ZEND_JIT_EXIT_TO_VM (1<<2) /* exit to VM without attempt to create a side trace */
408 #define ZEND_JIT_EXIT_RESTORE_CALL (1<<3) /* deoptimizer should restore EX(call) chain */
409 #define ZEND_JIT_EXIT_POLYMORPHISM (1<<4) /* exit because of polymorphic call */
410 #define ZEND_JIT_EXIT_FREE_OP1 (1<<5)
411 #define ZEND_JIT_EXIT_FREE_OP2 (1<<6)
412 #define ZEND_JIT_EXIT_PACKED_GUARD (1<<7)
413 #define ZEND_JIT_EXIT_CLOSURE_CALL (1<<8) /* exit because of polymorphic INIT_DYNAMIC_CALL call */
414 #define ZEND_JIT_EXIT_METHOD_CALL (1<<9) /* exit because of polymorphic INIT_METHOD_CALL call */
415 #define ZEND_JIT_EXIT_INVALIDATE (1<<10) /* invalidate current trace */
416
417 typedef union _zend_op_trace_info {
418 zend_op dummy; /* the size of this structure must be the same as zend_op */
419 struct {
420 const void *orig_handler;
421 const void *call_handler;
422 int16_t *counter;
423 uint8_t trace_flags;
424 };
425 } zend_op_trace_info;
426
427 typedef struct _zend_jit_op_array_trace_extension {
428 zend_func_info func_info;
429 const zend_op_array *op_array;
430 size_t offset; /* offset from "zend_op" to corresponding "op_info" */
431 zend_op_trace_info trace_info[1];
432 } zend_jit_op_array_trace_extension;
433
434 #define ZEND_OP_TRACE_INFO(opline, offset) \
435 ((zend_op_trace_info*)(((char*)opline) + offset))
436
437 /* Recorder */
438 typedef enum _zend_jit_trace_op {
439 ZEND_JIT_TRACE_VM,
440 ZEND_JIT_TRACE_OP1_TYPE,
441 ZEND_JIT_TRACE_OP2_TYPE,
442 ZEND_JIT_TRACE_VAL_INFO,
443 ZEND_JIT_TRACE_INIT_CALL,
444 ZEND_JIT_TRACE_DO_ICALL,
445 ZEND_JIT_TRACE_ENTER,
446 ZEND_JIT_TRACE_BACK,
447 ZEND_JIT_TRACE_END,
448 ZEND_JIT_TRACE_START,
449 } zend_jit_trace_op;
450
451 #define IS_UNKNOWN 255 /* may be used for zend_jit_trace_rec.op?_type */
452 #define IS_TRACE_PACKED (1<<4)
453 #define IS_TRACE_REFERENCE (1<<5)
454 #define IS_TRACE_INDIRECT (1<<6)
455
456 #define IS_TRACE_TYPE_MASK 0xf
457
458 #define ZEND_JIT_TRACE_FAKE_INIT_CALL 0x00000100
459 #define ZEND_JIT_TRACE_RETURN_VALUE_USED 0x00000100
460
461 #define ZEND_JIT_TRACE_MAX_SSA_VAR 0x7ffffe
462 #define ZEND_JIT_TRACE_SSA_VAR_SHIFT 9
463
464 #define ZEND_JIT_TRACE_FAKE_LEVEL_MASK 0xffff0000
465 #define ZEND_JIT_TRACE_FAKE_LEVEL_SHIFT 16
466
467 #define ZEND_JIT_TRACE_FAKE_LEVEL(info) \
468 (((info) & ZEND_JIT_TRACE_FAKE_LEVEL_MASK) >> ZEND_JIT_TRACE_FAKE_LEVEL_SHIFT)
469
470 #define ZEND_JIT_TRACE_FAKE_INFO(level) \
471 (((level) << ZEND_JIT_TRACE_FAKE_LEVEL_SHIFT) | ZEND_JIT_TRACE_FAKE_INIT_CALL)
472
473 #define ZEND_JIT_TRACE_SET_FIRST_SSA_VAR(_info, var) do { \
474 _info |= (var << ZEND_JIT_TRACE_SSA_VAR_SHIFT); \
475 } while (0)
476 #define ZEND_JIT_TRACE_GET_FIRST_SSA_VAR(_info) \
477 (_info >> ZEND_JIT_TRACE_SSA_VAR_SHIFT)
478
479 struct _zend_jit_trace_rec {
480 union {
481 struct { ZEND_ENDIAN_LOHI(
482 uint8_t op, /* zend_jit_trace_op */
483 union {
484 struct {
485 uint8_t op1_type;/* recorded zval op1_type for ZEND_JIT_TRACE_VM */
486 uint8_t op2_type;/* recorded zval op2_type for ZEND_JIT_TRACE_VM */
487 uint8_t op3_type;/* recorded zval for op_data.op1_type for ZEND_JIT_TRACE_VM */
488 };
489 struct {
490 uint8_t start; /* ZEND_JIT_TRACE_START_MASK for ZEND_JIT_TRACE_START/END */
491 uint8_t stop; /* zend_jit_trace_stop for ZEND_JIT_TRACE_START/END */
492 uint8_t level; /* recursive return level for ZEND_JIT_TRACE_START */
493 };
494 })
495 };
496 uint32_t last;
497 uint32_t info; /* "first_ssa_var" for ZEND_JIT_TRACE_ENTER and ZEND_JIT_TRACE_BACK,
498 * "return_value_used" for ZEND_JIT_TRACE_ENTER,
499 * "fake" for ZEND_JIT_TRACE_INIT_CALL */
500 };
501 union {
502 const void *ptr;
503 const zend_function *func;
504 const zend_op_array *op_array;
505 const zend_op *opline;
506 const zend_class_entry *ce;
507 };
508 };
509
510 #define ZEND_JIT_TRACE_START_REC_SIZE 2
511
512 typedef struct _zend_jit_trace_exit_info {
513 const zend_op *opline; /* opline where VM should continue execution */
514 const zend_op_array *op_array;
515 uint32_t flags; /* set of ZEND_JIT_EXIT_... */
516 uint32_t stack_size;
517 uint32_t stack_offset;
518 } zend_jit_trace_exit_info;
519
520 typedef union _zend_jit_trace_stack {
521 int32_t ssa_var;
522 uint32_t info;
523 struct {
524 uint8_t type; /* variable type (for type inference) */
525 uint8_t mem_type; /* stack slot type (for eliminate dead type store) */
526 int8_t reg;
527 uint8_t flags;
528 };
529 } zend_jit_trace_stack;
530
531 #define STACK_VAR(_stack, _slot) \
532 (_stack)[_slot].ssa_var
533 #define STACK_INFO(_stack, _slot) \
534 (_stack)[_slot].info
535 #define STACK_TYPE(_stack, _slot) \
536 (_stack)[_slot].type
537 #define STACK_MEM_TYPE(_stack, _slot) \
538 (_stack)[_slot].mem_type
539 #define STACK_REG(_stack, _slot) \
540 (_stack)[_slot].reg
541 #define STACK_FLAGS(_stack, _slot) \
542 (_stack)[_slot].flags
543 #define SET_STACK_VAR(_stack, _slot, _ssa_var) do { \
544 (_stack)[_slot].ssa_var = _ssa_var; \
545 } while (0)
546 #define SET_STACK_INFO(_stack, _slot, _info) do { \
547 (_stack)[_slot].info = _info; \
548 } while (0)
549 #define SET_STACK_TYPE(_stack, _slot, _type, _set_mem_type) do { \
550 uint8_t __type = (_type); \
551 (_stack)[_slot].type = __type; \
552 if (_set_mem_type) { \
553 (_stack)[_slot].mem_type = __type; \
554 } \
555 (_stack)[_slot].reg = ZREG_NONE; \
556 (_stack)[_slot].flags = 0; \
557 } while (0)
558 #define SET_STACK_REG(_stack, _slot, _reg) do { \
559 (_stack)[_slot].reg = _reg; \
560 (_stack)[_slot].flags = 0; \
561 } while (0)
562 #define SET_STACK_REG_EX(_stack, _slot, _reg, _flags) do { \
563 (_stack)[_slot].reg = _reg; \
564 (_stack)[_slot].flags = _flags; \
565 } while (0)
566 #define RESET_STACK_MEM_TYPE(_stack, _slot) do { \
567 (_stack)[_slot].mem_type = IS_UNKNOWN; \
568 } while (0)
569
570 /* trace info flags */
571 #define ZEND_JIT_TRACE_CHECK_INTERRUPT (1<<0)
572 #define ZEND_JIT_TRACE_LOOP (1<<1)
573 #define ZEND_JIT_TRACE_USES_INITIAL_IP (1<<2)
574
575 typedef struct _zend_jit_trace_info {
576 uint32_t id; /* trace id */
577 uint32_t root; /* root trace id or self id for root traces */
578 uint32_t parent; /* parent trace id or 0 for root traces */
579 uint32_t link; /* link trace id or self id for loop) */
580 uint32_t exit_count; /* number of side exits */
581 uint32_t child_count; /* number of side traces for root traces */
582 uint32_t code_size; /* size of native code */
583 uint32_t exit_counters; /* offset in exit counters array */
584 uint32_t stack_map_size;
585 uint32_t flags; /* See ZEND_JIT_TRACE_... defines above */
586 uint32_t polymorphism; /* Counter of polymorphic calls */
587 uint32_t jmp_table_size;/* number of jmp_table slots */
588 const zend_op_array *op_array; /* function */
589 const zend_op *opline; /* first opline */
590 const void *code_start; /* address of native code */
591 zend_jit_trace_exit_info *exit_info; /* info about side exits */
592 zend_jit_trace_stack *stack_map;
593 //uint32_t loop_offset;
594 } zend_jit_trace_info;
595
596 struct _zend_jit_trace_stack_frame {
597 zend_jit_trace_stack_frame *call;
598 zend_jit_trace_stack_frame *prev;
599 const zend_function *func;
600 const zend_op *call_opline;
601 zend_class_entry *ce; /* $this */
602 uint32_t call_level;
603 uint32_t _info;
604 int used_stack;
605 int old_checked_stack;
606 int old_peek_checked_stack;
607 zend_jit_trace_stack stack[1];
608 };
609
610 #define TRACE_FRAME_SHIFT_NUM_ARGS 16
611 #define TRACE_FRAME_MAX_NUM_ARGS 32767
612
613 #define TRACE_FRAME_MASK_NUM_ARGS 0xffff0000
614 #define TRACE_FRAME_MASK_NESTED 0x00000001
615 #define TRACE_FRAME_MASK_LAST_SEND_BY_REF 0x00000002
616 #define TRACE_FRAME_MASK_LAST_SEND_BY_VAL 0x00000004
617 #define TRACE_FRAME_MASK_RETURN_VALUE_USED 0x00000008
618 #define TRACE_FRAME_MASK_RETURN_VALUE_UNUSED 0x00000010
619 #define TRACE_FRAME_MASK_THIS_CHECKED 0x00000020
620 #define TRACE_FRAME_MASK_UNKNOWN_RETURN 0x00000040
621 #define TRACE_FRAME_MASK_NO_NEED_RELEASE_THIS 0x00000080
622 #define TRACE_FRAME_MASK_THIS_CLASS_CHECKED 0x00000100
623
624
625 #define TRACE_FRAME_INIT(frame, _func, _flags, num_args) do { \
626 zend_jit_trace_stack_frame *_frame = (frame); \
627 _frame->call = NULL; \
628 _frame->prev = NULL; \
629 _frame->func = (const zend_function*)_func; \
630 _frame->call_opline = NULL; \
631 _frame->call_level = 0; \
632 _frame->_info = (((uint32_t)(num_args)) << TRACE_FRAME_SHIFT_NUM_ARGS) & TRACE_FRAME_MASK_NUM_ARGS; \
633 _frame->_info |= _flags; \
634 } while (0)
635
636 #define TRACE_FRAME_RETURN_SSA_VAR(frame) \
637 ((int)(frame)->_info)
638 #define TRACE_FRAME_NUM_ARGS(frame) \
639 ((int)((frame)->_info) >> TRACE_FRAME_SHIFT_NUM_ARGS)
640 #define TRACE_FRAME_IS_NESTED(frame) \
641 ((frame)->_info & TRACE_FRAME_MASK_NESTED)
642 #define TRACE_FRAME_IS_LAST_SEND_BY_REF(frame) \
643 ((frame)->_info & TRACE_FRAME_MASK_LAST_SEND_BY_REF)
644 #define TRACE_FRAME_IS_LAST_SEND_BY_VAL(frame) \
645 ((frame)->_info & TRACE_FRAME_MASK_LAST_SEND_BY_VAL)
646 #define TRACE_FRAME_IS_RETURN_VALUE_USED(frame) \
647 ((frame)->_info & TRACE_FRAME_MASK_RETURN_VALUE_USED)
648 #define TRACE_FRAME_IS_RETURN_VALUE_UNUSED(frame) \
649 ((frame)->_info & TRACE_FRAME_MASK_RETURN_VALUE_UNUSED)
650 #define TRACE_FRAME_IS_THIS_CHECKED(frame) \
651 ((frame)->_info & TRACE_FRAME_MASK_THIS_CHECKED)
652 #define TRACE_FRAME_IS_UNKNOWN_RETURN(frame) \
653 ((frame)->_info & TRACE_FRAME_MASK_UNKNOWN_RETURN)
654 #define TRACE_FRAME_NO_NEED_RELEASE_THIS(frame) \
655 ((frame)->_info & TRACE_FRAME_MASK_NO_NEED_RELEASE_THIS)
656 #define TRACE_FRAME_IS_THIS_CLASS_CHECKED(frame) \
657 ((frame)->_info & TRACE_FRAME_MASK_THIS_CLASS_CHECKED)
658
659 #define TRACE_FRAME_SET_UNKNOWN_NUM_ARGS(frame) do { \
660 (frame)->_info |= (0xffffu << TRACE_FRAME_SHIFT_NUM_ARGS); \
661 } while (0)
662 #define TRACE_FRAME_SET_RETURN_SSA_VAR(frame, var) do { \
663 (frame)->_info = var; \
664 } while (0)
665 #define TRACE_FRAME_SET_LAST_SEND_BY_REF(frame) do { \
666 (frame)->_info |= TRACE_FRAME_MASK_LAST_SEND_BY_REF; \
667 (frame)->_info &= ~TRACE_FRAME_MASK_LAST_SEND_BY_VAL; \
668 } while (0)
669 #define TRACE_FRAME_SET_LAST_SEND_BY_VAL(frame) do { \
670 (frame)->_info |= TRACE_FRAME_MASK_LAST_SEND_BY_VAL; \
671 (frame)->_info &= ~TRACE_FRAME_MASK_LAST_SEND_BY_REF; \
672 } while (0)
673 #define TRACE_FRAME_SET_LAST_SEND_UNKNOWN(frame) do { \
674 (frame)->_info &= ~TRACE_FRAME_MASK_LAST_SEND_BY_VAL; \
675 (frame)->_info &= ~TRACE_FRAME_MASK_LAST_SEND_BY_REF; \
676 } while (0)
677 #define TRACE_FRAME_SET_RETURN_VALUE_USED(frame) do { \
678 (frame)->_info |= TRACE_FRAME_MASK_RETURN_VALUE_USED; \
679 (frame)->_info &= ~TRACE_FRAME_MASK_RETURN_VALUE_UNUSED; \
680 } while (0)
681 #define TRACE_FRAME_SET_RETURN_VALUE_UNUSED(frame) do { \
682 (frame)->_info |= TRACE_FRAME_MASK_RETURN_VALUE_UNUSED; \
683 (frame)->_info &= ~TRACE_FRAME_MASK_RETURN_VALUE_USED; \
684 } while (0)
685 #define TRACE_FRAME_SET_THIS_CHECKED(frame) do { \
686 (frame)->_info |= TRACE_FRAME_MASK_THIS_CHECKED; \
687 } while (0)
688 #define TRACE_FRAME_SET_NO_NEED_RELEASE_THIS(frame) do { \
689 (frame)->_info |= TRACE_FRAME_MASK_NO_NEED_RELEASE_THIS; \
690 } while (0)
691 #define TRACE_FRAME_SET_THIS_CLASS_CHECKED(frame) do { \
692 (frame)->_info |= TRACE_FRAME_MASK_THIS_CLASS_CHECKED; \
693 } while (0)
694
695 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_func_trace_helper(ZEND_OPCODE_HANDLER_ARGS);
696 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_ret_trace_helper(ZEND_OPCODE_HANDLER_ARGS);
697 ZEND_OPCODE_HANDLER_RET ZEND_FASTCALL zend_jit_loop_trace_helper(ZEND_OPCODE_HANDLER_ARGS);
698
699 int ZEND_FASTCALL zend_jit_trace_hot_root(zend_execute_data *execute_data, const zend_op *opline);
700 int ZEND_FASTCALL zend_jit_trace_exit(uint32_t exit_num, zend_jit_registers_buf *regs);
701 zend_jit_trace_stop ZEND_FASTCALL zend_jit_trace_execute(zend_execute_data *execute_data, const zend_op *opline, zend_jit_trace_rec *trace_buffer, uint8_t start, uint32_t is_megamorphc);
702
zend_jit_trace_get_exit_opline(zend_jit_trace_rec * trace,const zend_op * opline,bool * exit_if_true)703 static zend_always_inline const zend_op* zend_jit_trace_get_exit_opline(zend_jit_trace_rec *trace, const zend_op *opline, bool *exit_if_true)
704 {
705 if (trace->op == ZEND_JIT_TRACE_VM || trace->op == ZEND_JIT_TRACE_END) {
706 if (trace->opline == opline + 1) {
707 /* not taken branch */
708 *exit_if_true = opline->opcode == ZEND_JMPNZ;
709 return OP_JMP_ADDR(opline, opline->op2);
710 } else if (trace->opline == OP_JMP_ADDR(opline, opline->op2)) {
711 /* taken branch */
712 *exit_if_true = opline->opcode == ZEND_JMPZ;
713 return opline + 1;
714 } else {
715 ZEND_UNREACHABLE();
716 }
717 } else {
718 ZEND_UNREACHABLE();
719 }
720 *exit_if_true = 0;
721 return NULL;
722 }
723
zend_jit_may_be_modified(const zend_function * func,const zend_op_array * called_from)724 static inline bool zend_jit_may_be_modified(const zend_function *func, const zend_op_array *called_from)
725 {
726 if (func->type == ZEND_INTERNAL_FUNCTION) {
727 #ifdef _WIN32
728 /* ASLR */
729 return 1;
730 #else
731 return 0;
732 #endif
733 } else if (func->type == ZEND_USER_FUNCTION) {
734 if (func->common.fn_flags & ZEND_ACC_PRELOADED) {
735 return 0;
736 }
737 if (func->op_array.filename == called_from->filename && !func->op_array.scope) {
738 return 0;
739 }
740 }
741 return 1;
742 }
743
zend_jit_may_be_polymorphic_call(const zend_op * opline)744 static zend_always_inline bool zend_jit_may_be_polymorphic_call(const zend_op *opline)
745 {
746 if (opline->opcode == ZEND_INIT_FCALL
747 || opline->opcode == ZEND_INIT_FCALL_BY_NAME
748 || opline->opcode == ZEND_INIT_NS_FCALL_BY_NAME) {
749 return 0;
750 } else if (opline->opcode == ZEND_INIT_METHOD_CALL
751 || opline->opcode == ZEND_INIT_DYNAMIC_CALL) {
752 return 1;
753 } else if (opline->opcode == ZEND_INIT_STATIC_METHOD_CALL) {
754 return (opline->op1_type != IS_CONST || opline->op2_type != IS_CONST);
755 } else if (opline->opcode == ZEND_INIT_USER_CALL) {
756 return (opline->op2_type != IS_CONST);
757 } else if (opline->opcode == ZEND_NEW) {
758 return (opline->op1_type != IS_CONST);
759 } else {
760 ZEND_UNREACHABLE();
761 return 0;
762 }
763 }
764
765 /* Instruction cache flush */
766 #ifndef JIT_CACHE_FLUSH
767 # if ZEND_JIT_TARGET_ARM64
768 # if ((defined(__GNUC__) && ZEND_GCC_VERSION >= 4003) || __has_builtin(__builtin___clear_cache))
769 # define JIT_CACHE_FLUSH(from, to) __builtin___clear_cache((char*)(from), (char*)(to))
770 # else
771 # error "Missing builtin to flush instruction cache for AArch64"
772 # endif
773 # else /* Not required to implement on archs with unified caches */
774 # define JIT_CACHE_FLUSH(from, to)
775 # endif
776 #endif /* !JIT_CACHE_FLUSH */
777
778 /* bit helpers */
779
zend_long_is_power_of_two(zend_long x)780 static zend_always_inline bool zend_long_is_power_of_two(zend_long x)
781 {
782 return (x > 0) && !(x & (x - 1));
783 }
784
zend_long_floor_log2(zend_long x)785 static zend_always_inline uint32_t zend_long_floor_log2(zend_long x)
786 {
787 ZEND_ASSERT(zend_long_is_power_of_two(x));
788 return zend_ulong_ntz(x);
789 }
790
791 /* from http://aggregate.org/MAGIC/ */
ones32(uint32_t x)792 static zend_always_inline uint32_t ones32(uint32_t x)
793 {
794 x -= ((x >> 1) & 0x55555555);
795 x = (((x >> 2) & 0x33333333) + (x & 0x33333333));
796 x = (((x >> 4) + x) & 0x0f0f0f0f);
797 x += (x >> 8);
798 x += (x >> 16);
799 return x & 0x0000003f;
800 }
801
floor_log2(uint32_t x)802 static zend_always_inline uint32_t floor_log2(uint32_t x)
803 {
804 ZEND_ASSERT(x != 0);
805 x |= (x >> 1);
806 x |= (x >> 2);
807 x |= (x >> 4);
808 x |= (x >> 8);
809 x |= (x >> 16);
810 return ones32(x) - 1;
811 }
812
is_power_of_two(uint32_t x)813 static zend_always_inline bool is_power_of_two(uint32_t x)
814 {
815 return !(x & (x - 1)) && x != 0;
816 }
817
has_concrete_type(uint32_t value_type)818 static zend_always_inline bool has_concrete_type(uint32_t value_type)
819 {
820 return is_power_of_two (value_type & (MAY_BE_ANY|MAY_BE_UNDEF));
821 }
822
concrete_type(uint32_t value_type)823 static zend_always_inline uint32_t concrete_type(uint32_t value_type)
824 {
825 return floor_log2(value_type & (MAY_BE_ANY|MAY_BE_UNDEF));
826 }
827
is_signed(double d)828 static zend_always_inline bool is_signed(double d)
829 {
830 return (((unsigned char*)&d)[sizeof(double)-1] & 0x80) != 0;
831 }
832
833 #endif /* ZEND_JIT_INTERNAL_H */
834