Coverage Report

Created: 2025-09-27 06:26

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