Coverage Report

Created: 2026-06-13 07:01

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