1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
3 * Copyright (C) 2016-2021 Paul Cercueil <paul@crapouillou.net>
6 #ifndef __LIGHTREC_PRIVATE_H__
7 #define __LIGHTREC_PRIVATE_H__
9 #include "lightning-wrapper.h"
10 #include "lightrec-config.h"
11 #include "disassembler.h"
14 #if ENABLE_THREADED_COMPILER
15 #include <stdatomic.h>
18 #define ARRAY_SIZE(x) (sizeof(x) ? sizeof(x) / sizeof((x)[0]) : 0)
21 # define likely(x) __builtin_expect(!!(x),1)
22 # define unlikely(x) __builtin_expect(!!(x),0)
24 # define likely(x) (x)
25 # define unlikely(x) (x)
28 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
29 # define LE32TOH(x) __builtin_bswap32(x)
30 # define HTOLE32(x) __builtin_bswap32(x)
31 # define LE16TOH(x) __builtin_bswap16(x)
32 # define HTOLE16(x) __builtin_bswap16(x)
34 # define LE32TOH(x) (x)
35 # define HTOLE32(x) (x)
36 # define LE16TOH(x) (x)
37 # define HTOLE16(x) (x)
41 #define SET_DEFAULT_ELM(table, value) [0 ... ARRAY_SIZE(table) - 1] = value
43 #define SET_DEFAULT_ELM(table, value) [0] = NULL
46 #define fallthrough do {} while (0) /* fall-through */
48 /* Flags for (struct block *)->flags */
49 #define BLOCK_NEVER_COMPILE BIT(0)
50 #define BLOCK_SHOULD_RECOMPILE BIT(1)
51 #define BLOCK_FULLY_TAGGED BIT(2)
52 #define BLOCK_IS_DEAD BIT(3)
53 #define BLOCK_IS_MEMSET BIT(4)
55 #define RAM_SIZE 0x200000
56 #define BIOS_SIZE 0x80000
58 #define CODE_LUT_SIZE ((RAM_SIZE + BIOS_SIZE) >> 2)
63 /* Definition of jit_state_t (avoids inclusion of <lightning.h>) */
66 typedef struct jit_state jit_state_t;
75 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
84 struct opcode *opcode_list;
85 void (*function)(void);
91 unsigned int code_size;
94 #if ENABLE_THREADED_COMPILER
95 atomic_flag op_list_freed;
99 struct lightrec_branch {
100 struct jit_node *branch;
104 struct lightrec_branch_target {
105 struct jit_node *label;
111 C_WRAPPER_RW_GENERIC,
119 struct lightrec_cstate {
120 struct lightrec_state *state;
122 struct jit_node *branches[512];
123 struct lightrec_branch local_branches[512];
124 struct lightrec_branch_target targets[512];
125 unsigned int nb_branches;
126 unsigned int nb_local_branches;
127 unsigned int nb_targets;
130 struct regcache *reg_cache;
133 struct lightrec_state {
134 struct lightrec_registers regs;
139 u32 old_cycle_counter;
141 struct block *dispatcher, *c_wrapper_block;
142 void *c_wrappers[C_WRAPPERS_COUNT];
143 void *wrappers_eps[C_WRAPPERS_COUNT];
144 struct blockcache *block_cache;
145 struct recompiler *rec;
146 struct lightrec_cstate *cstate;
147 struct reaper *reaper;
149 void (*eob_wrapper_func)(void);
150 void (*memset_func)(void);
151 void (*get_next_block)(void);
152 struct lightrec_ops ops;
153 unsigned int nb_precompile;
154 unsigned int nb_maps;
155 const struct lightrec_mem_map *maps;
156 uintptr_t offset_ram, offset_bios, offset_scratch;
157 _Bool with_32bit_lut;
158 _Bool mirrors_mapped;
159 _Bool invalidate_from_dma_only;
163 u32 lightrec_rw(struct lightrec_state *state, union code op,
164 u32 addr, u32 data, u16 *flags,
165 struct block *block);
167 void lightrec_free_block(struct lightrec_state *state, struct block *block);
169 void remove_from_code_lut(struct blockcache *cache, struct block *block);
172 lightrec_get_map_idx(struct lightrec_state *state, u32 kaddr);
174 const struct lightrec_mem_map *
175 lightrec_get_map(struct lightrec_state *state, void **host, u32 kaddr);
177 static inline u32 kunseg(u32 addr)
179 if (unlikely(addr >= 0xa0000000))
180 return addr - 0xa0000000;
182 return addr &~ 0x80000000;
185 static inline u32 lut_offset(u32 pc)
188 return ((pc & (BIOS_SIZE - 1)) + RAM_SIZE) >> 2; // BIOS
190 return (pc & (RAM_SIZE - 1)) >> 2; // RAM
193 static inline _Bool is_big_endian(void)
195 return __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__;
198 static inline _Bool lut_is_32bit(const struct lightrec_state *state)
200 return __WORDSIZE == 32 ||
201 (ENABLE_CODE_BUFFER && state->with_32bit_lut);
204 static inline size_t lut_elm_size(const struct lightrec_state *state)
206 return lut_is_32bit(state) ? 4 : sizeof(void *);
209 static inline void ** lut_address(struct lightrec_state *state, u32 offset)
211 if (lut_is_32bit(state))
212 return (void **) ((uintptr_t) state->code_lut + offset * 4);
214 return &state->code_lut[offset];
217 static inline void * lut_read(struct lightrec_state *state, u32 offset)
219 void **lut_entry = lut_address(state, offset);
221 if (lut_is_32bit(state))
222 return (void *)(uintptr_t) *(u32 *) lut_entry;
227 static inline void lut_write(struct lightrec_state *state, u32 offset, void *ptr)
229 void **lut_entry = lut_address(state, offset);
231 if (lut_is_32bit(state))
232 *(u32 *) lut_entry = (u32)(uintptr_t) ptr;
237 static inline u32 get_ds_pc(const struct block *block, u16 offset, s16 imm)
239 u16 flags = block->opcode_list[offset].flags;
241 offset += !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));
243 return block->pc + (offset + imm << 2);
246 static inline u32 get_branch_pc(const struct block *block, u16 offset, s16 imm)
248 u16 flags = block->opcode_list[offset].flags;
250 offset -= !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));
252 return block->pc + (offset + imm << 2);
255 void lightrec_mtc(struct lightrec_state *state, union code op, u32 data);
256 u32 lightrec_mfc(struct lightrec_state *state, union code op);
257 void lightrec_rfe(struct lightrec_state *state);
258 void lightrec_cp(struct lightrec_state *state, union code op);
260 struct lightrec_cstate * lightrec_create_cstate(struct lightrec_state *state);
261 void lightrec_free_cstate(struct lightrec_cstate *cstate);
263 union code lightrec_read_opcode(struct lightrec_state *state, u32 pc);
265 struct block * lightrec_get_block(struct lightrec_state *state, u32 pc);
266 int lightrec_compile_block(struct lightrec_cstate *cstate, struct block *block);
267 void lightrec_free_opcode_list(struct lightrec_state *state, struct block *block);
269 unsigned int lightrec_cycles_of_opcode(union code code);
271 static inline u8 get_mult_div_lo(union code c)
273 return (OPT_FLAG_MULT_DIV && c.r.rd) ? c.r.rd : REG_LO;
276 static inline u8 get_mult_div_hi(union code c)
278 return (OPT_FLAG_MULT_DIV && c.r.imm) ? c.r.imm : REG_HI;
281 #endif /* __LIGHTREC_PRIVATE_H__ */