xref: /PHP-8.0/ext/opcache/jit/zend_jit.h (revision d5a82e2c)
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    | http://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    +----------------------------------------------------------------------+
17 */
18 
19 #ifndef HAVE_JIT_H
20 #define HAVE_JIT_H
21 
22 #define ZEND_JIT_LEVEL_NONE        0     /* no JIT */
23 #define ZEND_JIT_LEVEL_MINIMAL     1     /* minimal JIT (subroutine threading) */
24 #define ZEND_JIT_LEVEL_INLINE      2     /* selective inline threading */
25 #define ZEND_JIT_LEVEL_OPT_FUNC    3     /* optimized JIT based on Type-Inference */
26 #define ZEND_JIT_LEVEL_OPT_FUNCS   4     /* optimized JIT based on Type-Inference and call-tree */
27 #define ZEND_JIT_LEVEL_OPT_SCRIPT  5     /* optimized JIT based on Type-Inference and inner-procedure analysis */
28 
29 #define ZEND_JIT_ON_SCRIPT_LOAD    0
30 #define ZEND_JIT_ON_FIRST_EXEC     1
31 #define ZEND_JIT_ON_PROF_REQUEST   2     /* compile the most frequently caled on first request functions */
32 #define ZEND_JIT_ON_HOT_COUNTERS   3     /* compile functions after N calls or loop iterations */
33 #define ZEND_JIT_ON_DOC_COMMENT    4     /* compile functions with "@jit" tag in doc-comments */
34 #define ZEND_JIT_ON_HOT_TRACE      5     /* trace functions after N calls or loop iterations */
35 
36 #define ZEND_JIT_REG_ALLOC_LOCAL  (1<<0) /* local linear scan register allocation */
37 #define ZEND_JIT_REG_ALLOC_GLOBAL (1<<1) /* global linear scan register allocation */
38 #define ZEND_JIT_CPU_AVX          (1<<2) /* use AVX instructions, if available */
39 
40 #define ZEND_JIT_DEFAULT_BUFFER_SIZE  "0"
41 
42 #define ZEND_JIT_COUNTER_INIT         32531
43 
44 #define ZEND_JIT_DEBUG_ASM       (1<<0)
45 #define ZEND_JIT_DEBUG_SSA       (1<<1)
46 #define ZEND_JIT_DEBUG_REG_ALLOC (1<<2)
47 #define ZEND_JIT_DEBUG_ASM_STUBS (1<<3)
48 
49 #define ZEND_JIT_DEBUG_PERF      (1<<4)
50 #define ZEND_JIT_DEBUG_PERF_DUMP (1<<5)
51 #define ZEND_JIT_DEBUG_OPROFILE  (1<<6)
52 #define ZEND_JIT_DEBUG_VTUNE     (1<<7)
53 
54 #define ZEND_JIT_DEBUG_GDB       (1<<8)
55 #define ZEND_JIT_DEBUG_SIZE      (1<<9)
56 
57 #define ZEND_JIT_DEBUG_TRACE_START     (1<<12)
58 #define ZEND_JIT_DEBUG_TRACE_STOP      (1<<13)
59 #define ZEND_JIT_DEBUG_TRACE_COMPILED  (1<<14)
60 #define ZEND_JIT_DEBUG_TRACE_EXIT      (1<<15)
61 #define ZEND_JIT_DEBUG_TRACE_ABORT     (1<<16)
62 #define ZEND_JIT_DEBUG_TRACE_BLACKLIST (1<<17)
63 #define ZEND_JIT_DEBUG_TRACE_BYTECODE  (1<<18)
64 #define ZEND_JIT_DEBUG_TRACE_TSSA      (1<<19)
65 #define ZEND_JIT_DEBUG_TRACE_EXIT_INFO (1<<20)
66 
67 #define ZEND_JIT_DEBUG_PERSISTENT      0x1f0 /* profile and debbuger flags can't be changed at run-time */
68 
69 #define ZEND_JIT_TRACE_MAX_LENGTH        1024 /* max length of single trace */
70 #define ZEND_JIT_TRACE_MAX_EXITS          512 /* max number of side exits per trace */
71 
72 #define ZEND_JIT_TRACE_MAX_FUNCS           30 /* max number of different functions in a single trace */
73 #define ZEND_JIT_TRACE_MAX_CALL_DEPTH      10 /* max depth of inlined calls */
74 #define ZEND_JIT_TRACE_MAX_RET_DEPTH        4 /* max depth of inlined returns */
75 #define ZEND_JIT_TRACE_MAX_LOOPS_UNROLL    10 /* max number of unrolled loops */
76 
77 #define ZEND_JIT_TRACE_BAD_ROOT_SLOTS      64 /* number of slots in bad root trace cache */
78 
79 typedef struct _zend_jit_trace_rec zend_jit_trace_rec;
80 typedef struct _zend_jit_trace_stack_frame zend_jit_trace_stack_frame;
81 typedef struct _sym_node zend_sym_node;
82 
83 typedef struct _zend_jit_globals {
84 	zend_bool enabled;
85 	zend_bool on;
86 	uint8_t   trigger;
87 	uint8_t   opt_level;
88 	uint32_t  opt_flags;
89 
90 	const char *options;
91 	zend_long   buffer_size;
92 	zend_long   debug;
93 	zend_long   bisect_limit;
94 	double      prof_threshold;
95 	zend_long   max_root_traces;       /* max number of root traces */
96 	zend_long   max_side_traces;       /* max number of side traces (per root trace) */
97 	zend_long   max_exit_counters;     /* max total number of side exits for all traces */
98 	zend_long   hot_loop;
99 	zend_long   hot_func;
100 	zend_long   hot_return;
101 	zend_long   hot_side_exit;         /* number of exits before taking side trace */
102 	zend_long   blacklist_root_trace;  /* number of attempts to JIT a root trace before blacklist it */
103 	zend_long   blacklist_side_trace;  /* number of attempts to JIT a side trace before blacklist it */
104 	zend_long   max_loop_unrolls;      /* max number of unrolled loops */
105 	zend_long   max_recursive_calls;   /* max number of recursive inlined call unrolls */
106 	zend_long   max_recursive_returns; /* max number of recursive inlined return unrolls */
107 	zend_long   max_polymorphic_calls; /* max number of inlined polymorphic calls */
108 
109 	zend_sym_node *symbols;            /* symbols for disassembler */
110 
111 	zend_bool tracing;
112 
113 	zend_jit_trace_rec *current_trace;
114 	zend_jit_trace_stack_frame *current_frame;
115 
116 	const zend_op *bad_root_cache_opline[ZEND_JIT_TRACE_BAD_ROOT_SLOTS];
117 	uint8_t bad_root_cache_count[ZEND_JIT_TRACE_BAD_ROOT_SLOTS];
118 	uint8_t bad_root_cache_stop[ZEND_JIT_TRACE_BAD_ROOT_SLOTS];
119 	uint32_t bad_root_slot;
120 
121 	uint8_t  *exit_counters;
122 } zend_jit_globals;
123 
124 #ifdef ZTS
125 # define JIT_G(v) ZEND_TSRMG(jit_globals_id, zend_jit_globals *, v)
126 extern int jit_globals_id;
127 #else
128 # define JIT_G(v) (jit_globals.v)
129 extern zend_jit_globals jit_globals;
130 #endif
131 
132 ZEND_EXT_API int  zend_jit_op_array(zend_op_array *op_array, zend_script *script);
133 ZEND_EXT_API int  zend_jit_script(zend_script *script);
134 ZEND_EXT_API void zend_jit_unprotect(void);
135 ZEND_EXT_API void zend_jit_protect(void);
136 ZEND_EXT_API void zend_jit_init(void);
137 ZEND_EXT_API int  zend_jit_config(zend_string *jit_options, int stage);
138 ZEND_EXT_API int  zend_jit_debug_config(zend_long old_val, zend_long new_val, int stage);
139 ZEND_EXT_API int  zend_jit_check_support(void);
140 ZEND_EXT_API int  zend_jit_startup(void *jit_buffer, size_t size, zend_bool reattached);
141 ZEND_EXT_API void zend_jit_shutdown(void);
142 ZEND_EXT_API void zend_jit_activate(void);
143 ZEND_EXT_API void zend_jit_deactivate(void);
144 ZEND_EXT_API void zend_jit_status(zval *ret);
145 ZEND_EXT_API void zend_jit_restart(void);
146 
147 typedef struct _zend_lifetime_interval zend_lifetime_interval;
148 typedef struct _zend_life_range zend_life_range;
149 
150 struct _zend_life_range {
151 	uint32_t         start;
152 	uint32_t         end;
153 	zend_life_range *next;
154 };
155 
156 #define ZREG_FLAGS_SHIFT    8
157 
158 #define ZREG_STORE          (1<<0)
159 #define ZREG_LOAD           (1<<1)
160 #define ZREG_LAST_USE       (1<<2)
161 #define ZREG_SPLIT          (1<<3)
162 
163 struct _zend_lifetime_interval {
164 	int                     ssa_var;
165 	union {
166 		struct {
167 		ZEND_ENDIAN_LOHI_3(
168 			int8_t          reg,
169 			uint8_t         flags,
170 			uint16_t        reserved
171 		)};
172 		uint32_t            reg_flags;
173 	};
174 	zend_life_range         range;
175 	zend_lifetime_interval *hint;
176 	zend_lifetime_interval *used_as_hint;
177 	zend_lifetime_interval *list_next;
178 };
179 
180 #endif /* HAVE_JIT_H */
181