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;
153 #elif defined(__loongarch__)
155 # define JIT_FA0 _FA0
158 # define JIT_FRET _FA0
159 typedef jit_uint64_t jit_regset_t;
162 #define jit_data(u,v,w) _jit_data(_jit,u,v,w)
163 extern jit_node_t *_jit_data(jit_state_t*, const void*,
164 jit_word_t, jit_int32_t);
166 #define jit_size(vector) (sizeof(vector) / sizeof((vector)[0]))
168 #define jit_reg_free_p(regno) \
169 (!jit_regset_tstbit(&_jitc->reglive, regno) && \
170 !jit_regset_tstbit(&_jitc->regarg, regno) && \
171 !jit_regset_tstbit(&_jitc->regsav, regno))
173 #define jit_reg_free_if_spill_p(regno) \
174 (!jit_regset_tstbit(&_jitc->regarg, regno) && \
175 !jit_regset_tstbit(&_jitc->regsav, regno))
177 #define jit_inc_synth(code) \
179 (void)jit_new_node(jit_code_##code); \
182 #define jit_inc_synth_w(code, u) \
184 (void)jit_new_node_w(jit_code_##code, u); \
187 #define jit_inc_synth_f(code, u) \
189 (void)jit_new_node_f(jit_code_##code, u); \
192 #define jit_inc_synth_d(code, u) \
194 (void)jit_new_node_d(jit_code_##code, u); \
197 #define jit_inc_synth_ww(code, u, v) \
199 (void)jit_new_node_ww(jit_code_##code, u, v); \
202 #define jit_inc_synth_wp(code, u, v) \
204 (void)jit_new_node_wp(jit_code_##code, u, v); \
207 #define jit_inc_synth_fp(code, u, v) \
209 (void)jit_new_node_fp(jit_code_##code, u, v); \
212 #define jit_inc_synth_dp(code, u, v) \
214 (void)jit_new_node_dp(jit_code_##code, u, v); \
217 #define jit_dec_synth() jit_synth_dec()
219 #define jit_link_prolog() \
221 _jitc->tail->link = _jitc->function->prolog->link; \
222 _jitc->function->prolog->link = _jitc->tail; \
224 #define jit_link_prepare() \
226 _jitc->tail->link = _jitc->prepare->link; \
227 _jitc->prepare->link = _jitc->tail; \
229 #define jit_link_reverse(where) \
231 jit_node_t *tmp, *tail = 0; \
233 tmp = (where)->link; \
234 (where)->link = tail; \
242 * Private jit_class bitmasks
244 #define jit_class_named 0x00400000 /* hit must be the named reg */
245 #define jit_class_nospill 0x00800000 /* hint to fail if need spill */
246 #define jit_class_sft 0x01000000 /* not a hardware register */
247 #define jit_class_rg8 0x04000000 /* x86 8 bits */
248 #define jit_class_xpr 0x80000000 /* float / vector */
249 /* Used on sparc64 where %f0-%f31 can be encode for single float
250 * but %f32 to %f62 only as double precision */
251 #define jit_class_sng 0x10000000 /* Single precision float */
252 #define jit_class_dbl 0x20000000 /* Only double precision float */
253 #define jit_regno_patch 0x00008000 /* this is a register
254 * returned by a "user" call
255 * to jit_get_reg() */
257 #define jit_call_default 0
258 #define jit_call_varargs 1
260 #define jit_kind_register 1
261 #define jit_kind_code 2
262 #define jit_kind_word 3
263 #define jit_kind_float32 4
264 #define jit_kind_float64 5
266 #define jit_cc_a0_reg 0x00000001 /* arg0 is a register */
267 #define jit_cc_a0_chg 0x00000002 /* arg0 is modified */
268 #define jit_cc_a0_jmp 0x00000004 /* arg0 is a jump target */
269 #define jit_cc_a0_rlh 0x00000008 /* arg0 is a register pair */
270 #define jit_cc_a0_int 0x00000010 /* arg0 is immediate word */
271 #define jit_cc_a0_flt 0x00000020 /* arg0 is immediate float */
272 #define jit_cc_a0_dbl 0x00000040 /* arg0 is immediate double */
273 #define jit_cc_a0_arg 0x00000080 /* arg1 is an argument int id */
274 #define jit_cc_a0_cnd 0x00000100 /* arg1 is a conditinally set register */
275 #define jit_cc_a1_reg 0x00000200 /* arg1 is a register */
276 #define jit_cc_a1_chg 0x00000400 /* arg1 is modified */
277 #define jit_cc_a1_int 0x00001000 /* arg1 is immediate word */
278 #define jit_cc_a1_flt 0x00002000 /* arg1 is immediate float */
279 #define jit_cc_a1_dbl 0x00004000 /* arg1 is immediate double */
280 #define jit_cc_a1_arg 0x00008000 /* arg1 is an argument node */
281 #define jit_cc_a2_reg 0x00010000 /* arg2 is a register */
282 #define jit_cc_a2_chg 0x00020000 /* arg2 is modified */
283 #define jit_cc_a2_int 0x00100000 /* arg2 is immediate word */
284 #define jit_cc_a2_flt 0x00200000 /* arg2 is immediate float */
285 #define jit_cc_a2_dbl 0x00400000 /* arg2 is immediate double */
286 #define jit_cc_a2_rlh 0x00800000 /* arg2 is a register pair */
288 #if __ia64__ || (__sparc__ && __WORDSIZE == 64)
290 jit_regset_com(jit_regset_t*, jit_regset_t*);
293 jit_regset_and(jit_regset_t*, jit_regset_t*, jit_regset_t*);
296 jit_regset_ior(jit_regset_t*, jit_regset_t*, jit_regset_t*);
299 jit_regset_xor(jit_regset_t*, jit_regset_t*, jit_regset_t*);
302 jit_regset_set(jit_regset_t*, jit_regset_t*);
305 jit_regset_set_mask(jit_regset_t*, jit_int32_t);
308 jit_regset_cmp_ui(jit_regset_t*, jit_word_t);
311 jit_regset_set_ui(jit_regset_t*, jit_word_t);
314 jit_regset_set_p(jit_regset_t*);
317 jit_regset_clrbit(jit_regset_t*, jit_int32_t);
320 jit_regset_setbit(jit_regset_t*, jit_int32_t);
323 jit_regset_tstbit(jit_regset_t*, jit_int32_t);
324 # if __sparc__ && __WORDSIZE == 64
325 # define jit_regset_new(set) \
326 do { (set)->rl = (set)->rh = 0; } while (0)
327 # define jit_regset_del(set) \
328 do { (set)->rl = (set)->rh = 0; } while (0)
330 # define jit_regset_new(set) \
331 do { (set)->rl = (set)->rh = (set)->fl = (set)->fh = 0; } while (0)
332 # define jit_regset_del(set) \
333 do { (set)->rl = (set)->rh = (set)->fl = (set)->fh = 0; } while (0)
336 # define jit_regset_com(u, v) (*(u) = ~*(v))
337 # define jit_regset_and(u, v, w) (*(u) = *(v) & *(w))
338 # define jit_regset_ior(u, v, w) (*(u) = *(v) | *(w))
339 # define jit_regset_xor(u, v, w) (*(u) = *(v) ^ *(w))
340 # define jit_regset_set(u, v) (*(u) = *(v))
341 # define jit_regset_set_mask(u, v) (*(u) = (1LL << (v)) - 1)
342 # define jit_regset_cmp_ui(u, v) (*(u) != (v))
343 # define jit_regset_set_ui(u, v) (*(u) = (v))
344 # define jit_regset_set_p(set) (*set)
345 # define jit_regset_clrbit(set, bit) (*(set) &= ~(1LL << (bit)))
346 # define jit_regset_setbit(set, bit) (*(set) |= 1LL << (bit))
347 # define jit_regset_tstbit(set, bit) (*(set) & (1LL << (bit)))
348 # define jit_regset_new(set) (*(set) = 0)
349 # define jit_regset_del(set) (*(set) = 0)
352 jit_regset_scan1(jit_regset_t*, jit_int32_t);
354 #define jit_reglive_setup() \
356 jit_regset_set_ui(&_jitc->reglive, 0); \
357 jit_regset_set_ui(&_jitc->regmask, 0); \
363 typedef union jit_data jit_data_t;
364 typedef struct jit_note jit_note_t;
365 typedef struct jit_line jit_line_t;
366 typedef struct jit_block jit_block_t;
367 typedef struct jit_value jit_value_t;
368 typedef struct jit_compiler jit_compiler_t;
369 typedef struct jit_function jit_function_t;
370 typedef struct jit_register jit_register_t;
373 typedef struct jit_data_info jit_data_info_t;
376 typedef struct jit_const jit_const_t;
381 #if __BYTE_ORDER == __LITTLE_ENDIAN
401 jit_word_t size; /* of code */
406 jit_int32_t *linenos;
407 jit_int32_t *offsets;
415 jit_uint16_t offset; /* Used if DEVEL_DISASSEMBLER */
424 jit_regset_t reglive;
425 jit_regset_t regmask;
426 jit_bool_t again; /* Flag need to rebuild regset masks
427 * due to changes in live and unknown
446 #if __arm__ && DISASSEMBLER
447 struct jit_data_info {
448 jit_uword_t code; /* pointer in code buffer */
449 jit_word_t length; /* length of constant vector */
451 #elif __riscv && __WORDSIZE == 64
459 struct jit_function {
467 jit_int32_t argn; /* for debug output */
481 /* Helper for common jit generation pattern, used in GNU Smalltalk
482 * and possibly others, where a static frame layout is required or
485 jit_uint32_t define_frame : 1;
486 jit_uint32_t assume_frame : 1;
488 /* alloca offset offset */
490 /* uses allocar flag */
491 jit_uint32_t allocar : 1;
493 /* varargs state offsets */
494 jit_int32_t vaoff; /* offset of jit_va_list */
495 jit_int32_t vagp; /* first gp va argument */
496 jit_int32_t vafp; /* first fp va argument */
499 /* data used only during jit generation */
500 struct jit_compiler {
506 jit_regset_t regs; /* changed regs since last stop */
507 jit_int32_t pred; /* changed preds last stop */
508 jit_int32_t ioff; /* offset in inst vector */
509 jit_int32_t rout; /* first output register */
510 jit_int32_t breg; /* base register for prolog/epilog */
512 #if __mips__ || __ia64__ || __alpha__ || \
513 (__sparc__ && __WORDSIZE == 64) || __riscv || __loongarch__
515 #define jit_carry _jitc->carry
519 jit_node_t *prepare; /* inside prepare/finish* block */
520 jit_uint32_t realize : 1; /* jit_realize() called? */
521 jit_uint32_t dataset : 1; /* jit_dataset() called? */
522 jit_uint32_t done : 1; /* emit state finished */
523 jit_uint32_t emit : 1; /* emit state entered */
524 jit_uint32_t again : 1; /* start over emiting function */
525 jit_uint32_t synth : 8; /* emiting synthesized instructions */
527 jit_uint32_t getreg : 1;
529 jit_uint32_t no_data : 1;
530 jit_uint32_t no_note : 1;
531 jit_int32_t reglen; /* number of registers */
532 jit_regset_t regarg; /* cannot allocate */
533 jit_regset_t regsav; /* automatic spill only once */
534 jit_regset_t reglive; /* known live registers at some point */
535 jit_regset_t regmask; /* register mask to update reglive */
541 jit_node_t **table; /* very simple hash table */
542 jit_word_t size; /* number of vectors in table */
543 jit_word_t count; /* number of hash table entries */
544 jit_word_t offset; /* offset in bytes in ptr */
547 jit_int32_t *gen; /* ssa like "register version" */
548 jit_value_t *values; /* temporary jit_value_t vector */
553 } blocks; /* basic blocks */
558 } patches; /* forward patch information */
559 jit_function_t *function; /* current function */
564 } functions; /* prolog/epilogue offsets in code */
572 jit_node_t *head; /* first note node */
573 jit_node_t *tail; /* linked list insertion */
574 /* fields to store temporary state information */
581 /* prevent using thumb instructions that set flags? */
582 jit_uint32_t no_set_flags : 1;
585 jit_data_info_t *ptr;
588 } data_info; /* constant pools information */
590 /* Note that this field is somewhat hackish, but required by most
591 * ways to implement jit, unless implementing a pure one function
592 * per jit, as most times it needs to start the jit buffer with a
593 * jump where the "main" prolog starts, and because the initial
594 * code is in "arm mode", need to make an "arm mode" patch on that
595 * jump. A good example is the test suite assembler, where most
596 * test cases start with a "jmpi main" call. */
599 jit_uint8_t *data; /* pointer to code */
600 jit_word_t size; /* size data */
601 jit_word_t offset; /* pending patches */
602 jit_word_t length; /* number of pending constants */
603 jit_int32_t values[1024]; /* pending constants */
604 jit_word_t patches[2048];
606 #elif (__powerpc__ && _CALL_AIXDESC) || __ia64__
607 /* Keep track of prolog addresses, just for the sake of making
608 * jit that starts with a jump to a "main" label work like other
616 #elif __riscv && __WORDSIZE == 64
618 /* Hash table for constants to be resolved and patched */
620 jit_const_t **table; /* very simple hash table */
621 jit_word_t size; /* number of vectors in table */
622 jit_word_t count; /* number of distinct entries */
625 jit_const_t **ptr; /* keep a single pointer */
626 jit_const_t *list; /* free list */
627 jit_word_t length; /* length of pool */
629 /* Linear list for constants that cannot be encoded easily */
631 jit_word_t *instrs; /* list of direct movi instructions */
632 jit_word_t *values; /* list of direct movi constants */
633 jit_word_t offset; /* offset in instrs/values vector */
634 jit_word_t length; /* length of instrs/values vector */
639 /* Temporary storage to calculate instructions length */
641 /* Global flag for code buffer heuristic size computation */
643 /* Pointer to code to prevent miscalculation if reallocating buffer */
648 #define _jitc _jit->comp
669 jit_compiler_t *comp;
670 /* Flags to know if user did set the code and data buffers */
671 jit_uint32_t user_code : 1;
672 jit_uint32_t user_data : 1;
675 struct jit_register {
683 extern void jit_get_cpu(void);
685 #define jit_init() _jit_init(_jit)
686 extern void _jit_init(jit_state_t*);
688 #define jit_synth_inc() _jit_synth_inc(_jit)
689 extern void _jit_synth_inc(jit_state_t*);
691 #define jit_new_node_no_link(u) _jit_new_node_no_link(_jit, u)
692 extern jit_node_t *_jit_new_node_no_link(jit_state_t*, jit_code_t);
694 #define jit_link_node(u) _jit_link_node(_jit, u)
695 extern void _jit_link_node(jit_state_t*, jit_node_t*);
697 #define jit_link_label(l) _jit_link_label(_jit,l)
699 _jit_link_label(jit_state_t*,jit_node_t*);
701 #define jit_synth_dec() _jit_synth_dec(_jit)
702 extern void _jit_synth_dec(jit_state_t*);
704 #define jit_reglive(node) _jit_reglive(_jit, node)
706 _jit_reglive(jit_state_t*, jit_node_t*);
708 #define jit_regarg_set(n,v) _jit_regarg_set(_jit,n,v)
710 _jit_regarg_set(jit_state_t*, jit_node_t*, jit_int32_t);
712 #define jit_regarg_clr(n,v) _jit_regarg_clr(_jit,n,v)
714 _jit_regarg_clr(jit_state_t*, jit_node_t*, jit_int32_t);
716 #define jit_save(reg) _jit_save(_jit, reg)
718 _jit_save(jit_state_t*, jit_int32_t);
720 #define jit_load(reg) _jit_load(_jit, reg)
722 _jit_load(jit_state_t*, jit_int32_t);
724 #define jit_trampoline(u,v) _jit_trampoline(_jit, u, v)
725 extern void _jit_trampoline(jit_state_t*, jit_int32_t, jit_bool_t);
727 #define jit_optimize() _jit_optimize(_jit)
729 _jit_optimize(jit_state_t*);
731 #define jit_classify(code) _jit_classify(_jit, code)
733 _jit_classify(jit_state_t*, jit_code_t);
735 #define jit_regarg_p(n, r) _jit_regarg_p(_jit, n, r)
737 _jit_regarg_p(jit_state_t*, jit_node_t*, jit_int32_t);
739 #define emit_code() _emit_code(_jit)
741 _emit_code(jit_state_t*);
744 jit_flush(void *fptr, void *tptr);
746 #define emit_ldxi(r0, r1, i0) _emit_ldxi(_jit, r0, r1, i0)
748 _emit_ldxi(jit_state_t*, jit_int32_t, jit_int32_t, jit_word_t);
750 #define emit_stxi(i0, r0, r1) _emit_stxi(_jit, i0, r0, r1)
752 _emit_stxi(jit_state_t*, jit_word_t, jit_int32_t, jit_int32_t);
754 #define emit_ldxi_d(r0, r1, i0) _emit_ldxi_d(_jit, r0, r1, i0)
756 _emit_ldxi_d(jit_state_t*, jit_int32_t, jit_int32_t, jit_word_t);
758 #define emit_stxi_d(i0, r0, r1) _emit_stxi_d(_jit, i0, r0, r1)
760 _emit_stxi_d(jit_state_t*, jit_word_t, jit_int32_t, jit_int32_t);
762 extern void jit_init_print(void);
763 extern void jit_init_debug(const char*);
764 extern void jit_finish_debug(void);
766 extern void jit_init_note(void);
767 extern void jit_finish_note(void);
768 #define jit_set_note(n,u,v,w) _jit_set_note(_jit, n, u, v, w)
769 extern void _jit_set_note(jit_state_t*, jit_note_t*, char*, int, jit_int32_t);
770 #define jit_annotate() _jit_annotate(_jit)
771 extern void _jit_annotate(jit_state_t*);
773 #define jit_print_node(u) _jit_print_node(_jit,u)
774 extern void _jit_print_node(jit_state_t*,jit_node_t*);
776 extern jit_pointer_t jit_memcpy(jit_pointer_t,const void*,jit_word_t);
777 extern jit_pointer_t jit_memmove(jit_pointer_t,const void*,jit_word_t);
778 extern void jit_alloc(jit_pointer_t*, jit_word_t);
779 extern void jit_realloc(jit_pointer_t*, jit_word_t, jit_word_t);
780 void jit_free(jit_pointer_t*);
782 extern void jit_init_size(void);
783 extern void jit_finish_size(void);
786 # define jit_size_prepare() _jit_size_prepare(_jit)
788 _jit_size_prepare(jit_state_t*);
790 # define jit_size_collect(node) _jit_size_collect(_jit, node)
792 _jit_size_collect(jit_state_t*, jit_node_t*);
794 # define jit_get_size() _jit_get_size(_jit)
796 _jit_get_size(jit_state_t*);
800 jit_get_max_instr(void);
805 extern jit_register_t _rvs[];
807 #endif /* _jit_private_h */