2 * Copyright (C) 2012-2022 Free Software Foundation, Inc.
4 * This file is part of GNU lightning.
6 * GNU lightning is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation; either version 3, or (at your option)
11 * GNU lightning is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 * License for more details.
17 * Paulo Cesar Pereira de Andrade
20 #ifndef _jit_private_h
21 #define _jit_private_h
34 # if !defined(offsetof)
35 # define offsetof(type, field) ((char *)&((type *)0)->field - (char *)0)
40 # define maybe_unused __attribute__ ((unused))
41 # define unlikely(exprn) __builtin_expect(!!(exprn), 0)
42 # define likely(exprn) __builtin_expect(!!(exprn), 1)
44 # define PUBLIC __attribute__ ((visibility("default")))
45 # define HIDDEN __attribute__ ((visibility("hidden")))
51 # define maybe_unused /**/
52 # define unlikely(exprn) exprn
53 # define likely(exprn) exprn
58 #define rc(value) jit_class_##value
59 #define rn(reg) (jit_regno(_rvs[jit_regno(reg)].spec))
61 #if defined(__i386__) || defined(__x86_64__)
65 # define JIT_FRET _ST0
66 typedef jit_uint32_t jit_regset_t;
68 # if __CYGWIN__ || _WIN32
73 # define JIT_FA0 _XMM0
74 # define JIT_FRET _XMM0
75 typedef jit_uint64_t jit_regset_t;
77 #elif defined(__mips__)
83 typedef jit_uint64_t jit_regset_t;
84 #elif defined(__arm__)
89 # if defined(__ARM_PCS_VFP)
94 typedef jit_uint64_t jit_regset_t;
95 #elif defined(__powerpc__)
100 # define JIT_FRET _F1
101 typedef jit_uint64_t jit_regset_t;
102 #elif defined(__sparc__)
105 # define JIT_FRET _F0
106 # if __WORDSIZE == 32
107 typedef jit_uint64_t jit_regset_t;
114 #elif defined(__ia64__)
117 # define JIT_FRET _F8
124 #elif defined(__hppa__)
126 # define JIT_RET _R28
127 # define JIT_FRET _F4
128 typedef jit_uint64_t jit_regset_t;
129 #elif defined(__aarch64__)
134 # define JIT_FRET _V0
135 typedef jit_uint64_t jit_regset_t;
136 #elif defined(__s390__) || defined(__s390x__)
139 # define JIT_FRET _F0
140 typedef jit_uint32_t jit_regset_t;
141 #elif defined(__alpha__)
144 # define JIT_FRET _F0
145 typedef jit_uint64_t jit_regset_t;
146 #elif defined(__riscv)
148 # define JIT_FA0 _FA0
151 # define JIT_FRET _FA0
152 typedef jit_uint64_t jit_regset_t;
155 #define jit_data(u,v,w) _jit_data(_jit,u,v,w)
156 extern jit_node_t *_jit_data(jit_state_t*, const void*,
157 jit_word_t, jit_int32_t);
159 #define jit_size(vector) (sizeof(vector) / sizeof((vector)[0]))
161 #define jit_reg_free_p(regno) \
162 (!jit_regset_tstbit(&_jitc->reglive, regno) && \
163 !jit_regset_tstbit(&_jitc->regarg, regno) && \
164 !jit_regset_tstbit(&_jitc->regsav, regno))
166 #define jit_reg_free_if_spill_p(regno) \
167 (!jit_regset_tstbit(&_jitc->regarg, regno) && \
168 !jit_regset_tstbit(&_jitc->regsav, regno))
170 #define jit_inc_synth(code) \
172 (void)jit_new_node(jit_code_##code); \
175 #define jit_inc_synth_w(code, u) \
177 (void)jit_new_node_w(jit_code_##code, u); \
180 #define jit_inc_synth_f(code, u) \
182 (void)jit_new_node_f(jit_code_##code, u); \
185 #define jit_inc_synth_d(code, u) \
187 (void)jit_new_node_d(jit_code_##code, u); \
190 #define jit_inc_synth_ww(code, u, v) \
192 (void)jit_new_node_ww(jit_code_##code, u, v); \
195 #define jit_inc_synth_wp(code, u, v) \
197 (void)jit_new_node_wp(jit_code_##code, u, v); \
200 #define jit_inc_synth_fp(code, u, v) \
202 (void)jit_new_node_fp(jit_code_##code, u, v); \
205 #define jit_inc_synth_dp(code, u, v) \
207 (void)jit_new_node_dp(jit_code_##code, u, v); \
210 #define jit_dec_synth() jit_synth_dec()
212 #define jit_link_prolog() \
214 _jitc->tail->link = _jitc->function->prolog->link; \
215 _jitc->function->prolog->link = _jitc->tail; \
217 #define jit_link_prepare() \
219 _jitc->tail->link = _jitc->prepare->link; \
220 _jitc->prepare->link = _jitc->tail; \
222 #define jit_link_reverse(where) \
224 jit_node_t *tmp, *tail = 0; \
226 tmp = (where)->link; \
227 (where)->link = tail; \
235 * Private jit_class bitmasks
237 #define jit_class_named 0x00400000 /* hit must be the named reg */
238 #define jit_class_nospill 0x00800000 /* hint to fail if need spill */
239 #define jit_class_sft 0x01000000 /* not a hardware register */
240 #define jit_class_rg8 0x04000000 /* x86 8 bits */
241 #define jit_class_xpr 0x80000000 /* float / vector */
242 /* Used on sparc64 where %f0-%f31 can be encode for single float
243 * but %f32 to %f62 only as double precision */
244 #define jit_class_sng 0x10000000 /* Single precision float */
245 #define jit_class_dbl 0x20000000 /* Only double precision float */
246 #define jit_regno_patch 0x00008000 /* this is a register
247 * returned by a "user" call
248 * to jit_get_reg() */
250 #define jit_call_default 0
251 #define jit_call_varargs 1
253 #define jit_kind_register 1
254 #define jit_kind_code 2
255 #define jit_kind_word 3
256 #define jit_kind_float32 4
257 #define jit_kind_float64 5
259 #define jit_cc_a0_reg 0x00000001 /* arg0 is a register */
260 #define jit_cc_a0_chg 0x00000002 /* arg0 is modified */
261 #define jit_cc_a0_jmp 0x00000004 /* arg0 is a jump target */
262 #define jit_cc_a0_rlh 0x00000008 /* arg0 is a register pair */
263 #define jit_cc_a0_int 0x00000010 /* arg0 is immediate word */
264 #define jit_cc_a0_flt 0x00000020 /* arg0 is immediate float */
265 #define jit_cc_a0_dbl 0x00000040 /* arg0 is immediate double */
266 #define jit_cc_a0_arg 0x00000080 /* arg1 is an argument int id */
267 #define jit_cc_a0_cnd 0x00000100 /* arg1 is a conditinally set register */
268 #define jit_cc_a1_reg 0x00000200 /* arg1 is a register */
269 #define jit_cc_a1_chg 0x00000400 /* arg1 is modified */
270 #define jit_cc_a1_int 0x00001000 /* arg1 is immediate word */
271 #define jit_cc_a1_flt 0x00002000 /* arg1 is immediate float */
272 #define jit_cc_a1_dbl 0x00004000 /* arg1 is immediate double */
273 #define jit_cc_a1_arg 0x00008000 /* arg1 is an argument node */
274 #define jit_cc_a2_reg 0x00010000 /* arg2 is a register */
275 #define jit_cc_a2_chg 0x00020000 /* arg2 is modified */
276 #define jit_cc_a2_int 0x00100000 /* arg2 is immediate word */
277 #define jit_cc_a2_flt 0x00200000 /* arg2 is immediate float */
278 #define jit_cc_a2_dbl 0x00400000 /* arg2 is immediate double */
279 #define jit_cc_a2_rlh 0x00800000 /* arg2 is a register pair */
281 #if __ia64__ || (__sparc__ && __WORDSIZE == 64)
283 jit_regset_com(jit_regset_t*, jit_regset_t*);
286 jit_regset_and(jit_regset_t*, jit_regset_t*, jit_regset_t*);
289 jit_regset_ior(jit_regset_t*, jit_regset_t*, jit_regset_t*);
292 jit_regset_xor(jit_regset_t*, jit_regset_t*, jit_regset_t*);
295 jit_regset_set(jit_regset_t*, jit_regset_t*);
298 jit_regset_set_mask(jit_regset_t*, jit_int32_t);
301 jit_regset_cmp_ui(jit_regset_t*, jit_word_t);
304 jit_regset_set_ui(jit_regset_t*, jit_word_t);
307 jit_regset_set_p(jit_regset_t*);
310 jit_regset_clrbit(jit_regset_t*, jit_int32_t);
313 jit_regset_setbit(jit_regset_t*, jit_int32_t);
316 jit_regset_tstbit(jit_regset_t*, jit_int32_t);
317 # if __sparc__ && __WORDSIZE == 64
318 # define jit_regset_new(set) \
319 do { (set)->rl = (set)->rh = 0; } while (0)
320 # define jit_regset_del(set) \
321 do { (set)->rl = (set)->rh = 0; } while (0)
323 # define jit_regset_new(set) \
324 do { (set)->rl = (set)->rh = (set)->fl = (set)->fh = 0; } while (0)
325 # define jit_regset_del(set) \
326 do { (set)->rl = (set)->rh = (set)->fl = (set)->fh = 0; } while (0)
329 # define jit_regset_com(u, v) (*(u) = ~*(v))
330 # define jit_regset_and(u, v, w) (*(u) = *(v) & *(w))
331 # define jit_regset_ior(u, v, w) (*(u) = *(v) | *(w))
332 # define jit_regset_xor(u, v, w) (*(u) = *(v) ^ *(w))
333 # define jit_regset_set(u, v) (*(u) = *(v))
334 # define jit_regset_set_mask(u, v) (*(u) = (1LL << (v)) - 1)
335 # define jit_regset_cmp_ui(u, v) (*(u) != (v))
336 # define jit_regset_set_ui(u, v) (*(u) = (v))
337 # define jit_regset_set_p(set) (*set)
338 # define jit_regset_clrbit(set, bit) (*(set) &= ~(1LL << (bit)))
339 # define jit_regset_setbit(set, bit) (*(set) |= 1LL << (bit))
340 # define jit_regset_tstbit(set, bit) (*(set) & (1LL << (bit)))
341 # define jit_regset_new(set) (*(set) = 0)
342 # define jit_regset_del(set) (*(set) = 0)
345 jit_regset_scan1(jit_regset_t*, jit_int32_t);
347 #define jit_reglive_setup() \
349 jit_regset_set_ui(&_jitc->reglive, 0); \
350 jit_regset_set_ui(&_jitc->regmask, 0); \
356 typedef union jit_data jit_data_t;
357 typedef struct jit_note jit_note_t;
358 typedef struct jit_line jit_line_t;
359 typedef struct jit_block jit_block_t;
360 typedef struct jit_value jit_value_t;
361 typedef struct jit_compiler jit_compiler_t;
362 typedef struct jit_function jit_function_t;
363 typedef struct jit_register jit_register_t;
366 typedef struct jit_data_info jit_data_info_t;
369 typedef struct jit_const jit_const_t;
374 #if __BYTE_ORDER == __LITTLE_ENDIAN
394 jit_word_t size; /* of code */
399 jit_int32_t *linenos;
400 jit_int32_t *offsets;
408 jit_uint16_t offset; /* Used if DEVEL_DISASSEMBLER */
417 jit_regset_t reglive;
418 jit_regset_t regmask;
419 jit_bool_t again; /* Flag need to rebuild regset masks
420 * due to changes in live and unknown
439 #if __arm__ && DISASSEMBLER
440 struct jit_data_info {
441 jit_uword_t code; /* pointer in code buffer */
442 jit_word_t length; /* length of constant vector */
444 #elif __riscv && __WORDSIZE == 64
452 struct jit_function {
460 jit_int32_t argn; /* for debug output */
474 /* Helper for common jit generation pattern, used in GNU Smalltalk
475 * and possibly others, where a static frame layout is required or
478 jit_uint32_t define_frame : 1;
479 jit_uint32_t assume_frame : 1;
481 /* alloca offset offset */
483 /* uses allocar flag */
484 jit_uint32_t allocar : 1;
486 /* varargs state offsets */
487 jit_int32_t vaoff; /* offset of jit_va_list */
488 jit_int32_t vagp; /* first gp va argument */
489 jit_int32_t vafp; /* first fp va argument */
492 /* data used only during jit generation */
493 struct jit_compiler {
499 jit_regset_t regs; /* changed regs since last stop */
500 jit_int32_t pred; /* changed preds last stop */
501 jit_int32_t ioff; /* offset in inst vector */
502 jit_int32_t rout; /* first output register */
503 jit_int32_t breg; /* base register for prolog/epilog */
505 #if __mips__ || __ia64__ || __alpha__ || \
506 (__sparc__ && __WORDSIZE == 64) || __riscv
508 #define jit_carry _jitc->carry
512 jit_node_t *prepare; /* inside prepare/finish* block */
513 jit_uint32_t realize : 1; /* jit_realize() called? */
514 jit_uint32_t dataset : 1; /* jit_dataset() called? */
515 jit_uint32_t done : 1; /* emit state finished */
516 jit_uint32_t emit : 1; /* emit state entered */
517 jit_uint32_t again : 1; /* start over emiting function */
518 jit_uint32_t synth : 8; /* emiting synthesized instructions */
520 jit_uint32_t getreg : 1;
522 jit_uint32_t no_data : 1;
523 jit_uint32_t no_note : 1;
524 jit_int32_t reglen; /* number of registers */
525 jit_regset_t regarg; /* cannot allocate */
526 jit_regset_t regsav; /* automatic spill only once */
527 jit_regset_t reglive; /* known live registers at some point */
528 jit_regset_t regmask; /* register mask to update reglive */
534 jit_node_t **table; /* very simple hash table */
535 jit_word_t size; /* number of vectors in table */
536 jit_word_t count; /* number of hash table entries */
537 jit_word_t offset; /* offset in bytes in ptr */
540 jit_int32_t *gen; /* ssa like "register version" */
541 jit_value_t *values; /* temporary jit_value_t vector */
546 } blocks; /* basic blocks */
551 } patches; /* forward patch information */
552 jit_function_t *function; /* current function */
557 } functions; /* prolog/epilogue offsets in code */
565 jit_node_t *head; /* first note node */
566 jit_node_t *tail; /* linked list insertion */
567 /* fields to store temporary state information */
574 /* prevent using thumb instructions that set flags? */
575 jit_uint32_t no_set_flags : 1;
578 jit_data_info_t *ptr;
581 } data_info; /* constant pools information */
583 /* Note that this field is somewhat hackish, but required by most
584 * ways to implement jit, unless implementing a pure one function
585 * per jit, as most times it needs to start the jit buffer with a
586 * jump where the "main" prolog starts, and because the initial
587 * code is in "arm mode", need to make an "arm mode" patch on that
588 * jump. A good example is the test suite assembler, where most
589 * test cases start with a "jmpi main" call. */
592 jit_uint8_t *data; /* pointer to code */
593 jit_word_t size; /* size data */
594 jit_word_t offset; /* pending patches */
595 jit_word_t length; /* number of pending constants */
596 jit_int32_t values[1024]; /* pending constants */
597 jit_word_t patches[2048];
599 #elif (__powerpc__ && _CALL_AIXDESC) || __ia64__
600 /* Keep track of prolog addresses, just for the sake of making
601 * jit that starts with a jump to a "main" label work like other
609 #elif __riscv && __WORDSIZE == 64
611 /* Hash table for constants to be resolved and patched */
613 jit_const_t **table; /* very simple hash table */
614 jit_word_t size; /* number of vectors in table */
615 jit_word_t count; /* number of distinct entries */
618 jit_const_t **ptr; /* keep a single pointer */
619 jit_const_t *list; /* free list */
620 jit_word_t length; /* length of pool */
622 /* Linear list for constants that cannot be encoded easily */
624 jit_word_t *instrs; /* list of direct movi instructions */
625 jit_word_t *values; /* list of direct movi constants */
626 jit_word_t offset; /* offset in instrs/values vector */
627 jit_word_t length; /* length of instrs/values vector */
632 /* Temporary storage to calculate instructions length */
634 /* Global flag for code buffer heuristic size computation */
636 /* Pointer to code to prevent miscalculation if reallocating buffer */
641 #define _jitc _jit->comp
662 jit_compiler_t *comp;
663 /* Flags to know if user did set the code and data buffers */
664 jit_uint32_t user_code : 1;
665 jit_uint32_t user_data : 1;
668 struct jit_register {
676 extern void jit_get_cpu(void);
678 #define jit_init() _jit_init(_jit)
679 extern void _jit_init(jit_state_t*);
681 #define jit_synth_inc() _jit_synth_inc(_jit)
682 extern void _jit_synth_inc(jit_state_t*);
684 #define jit_new_node_no_link(u) _jit_new_node_no_link(_jit, u)
685 extern jit_node_t *_jit_new_node_no_link(jit_state_t*, jit_code_t);
687 #define jit_link_node(u) _jit_link_node(_jit, u)
688 extern void _jit_link_node(jit_state_t*, jit_node_t*);
690 #define jit_link_label(l) _jit_link_label(_jit,l)
692 _jit_link_label(jit_state_t*,jit_node_t*);
694 #define jit_synth_dec() _jit_synth_dec(_jit)
695 extern void _jit_synth_dec(jit_state_t*);
697 #define jit_reglive(node) _jit_reglive(_jit, node)
699 _jit_reglive(jit_state_t*, jit_node_t*);
701 #define jit_regarg_set(n,v) _jit_regarg_set(_jit,n,v)
703 _jit_regarg_set(jit_state_t*, jit_node_t*, jit_int32_t);
705 #define jit_regarg_clr(n,v) _jit_regarg_clr(_jit,n,v)
707 _jit_regarg_clr(jit_state_t*, jit_node_t*, jit_int32_t);
709 #define jit_save(reg) _jit_save(_jit, reg)
711 _jit_save(jit_state_t*, jit_int32_t);
713 #define jit_load(reg) _jit_load(_jit, reg)
715 _jit_load(jit_state_t*, jit_int32_t);
717 #define jit_trampoline(u,v) _jit_trampoline(_jit, u, v)
718 extern void _jit_trampoline(jit_state_t*, jit_int32_t, jit_bool_t);
720 #define jit_optimize() _jit_optimize(_jit)
722 _jit_optimize(jit_state_t*);
724 #define jit_classify(code) _jit_classify(_jit, code)
726 _jit_classify(jit_state_t*, jit_code_t);
728 #define jit_regarg_p(n, r) _jit_regarg_p(_jit, n, r)
730 _jit_regarg_p(jit_state_t*, jit_node_t*, jit_int32_t);
732 #define emit_code() _emit_code(_jit)
734 _emit_code(jit_state_t*);
737 jit_flush(void *fptr, void *tptr);
739 #define emit_ldxi(r0, r1, i0) _emit_ldxi(_jit, r0, r1, i0)
741 _emit_ldxi(jit_state_t*, jit_int32_t, jit_int32_t, jit_word_t);
743 #define emit_stxi(i0, r0, r1) _emit_stxi(_jit, i0, r0, r1)
745 _emit_stxi(jit_state_t*, jit_word_t, jit_int32_t, jit_int32_t);
747 #define emit_ldxi_d(r0, r1, i0) _emit_ldxi_d(_jit, r0, r1, i0)
749 _emit_ldxi_d(jit_state_t*, jit_int32_t, jit_int32_t, jit_word_t);
751 #define emit_stxi_d(i0, r0, r1) _emit_stxi_d(_jit, i0, r0, r1)
753 _emit_stxi_d(jit_state_t*, jit_word_t, jit_int32_t, jit_int32_t);
755 extern void jit_init_print(void);
756 extern void jit_init_debug(const char*);
757 extern void jit_finish_debug(void);
759 extern void jit_init_note(void);
760 extern void jit_finish_note(void);
761 #define jit_set_note(n,u,v,w) _jit_set_note(_jit, n, u, v, w)
762 extern void _jit_set_note(jit_state_t*, jit_note_t*, char*, int, jit_int32_t);
763 #define jit_annotate() _jit_annotate(_jit)
764 extern void _jit_annotate(jit_state_t*);
766 #define jit_print_node(u) _jit_print_node(_jit,u)
767 extern void _jit_print_node(jit_state_t*,jit_node_t*);
769 extern jit_pointer_t jit_memcpy(jit_pointer_t,const void*,jit_word_t);
770 extern jit_pointer_t jit_memmove(jit_pointer_t,const void*,jit_word_t);
771 extern void jit_alloc(jit_pointer_t*, jit_word_t);
772 extern void jit_realloc(jit_pointer_t*, jit_word_t, jit_word_t);
773 void jit_free(jit_pointer_t*);
775 extern void jit_init_size(void);
776 extern void jit_finish_size(void);
779 # define jit_size_prepare() _jit_size_prepare(_jit)
781 _jit_size_prepare(jit_state_t*);
783 # define jit_size_collect(node) _jit_size_collect(_jit, node)
785 _jit_size_collect(jit_state_t*, jit_node_t*);
787 # define jit_get_size() _jit_get_size(_jit)
789 _jit_get_size(jit_state_t*);
793 jit_get_max_instr(void);
798 extern jit_register_t _rvs[];
800 #endif /* _jit_private_h */