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