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