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"
15 #if ENABLE_THREADED_COMPILER
16 #include <stdatomic.h>
20 #include <immintrin.h>
23 #define ARRAY_SIZE(x) (sizeof(x) ? sizeof(x) / sizeof((x)[0]) : 0)
25 #define GENMASK(h, l) \
26 (((uintptr_t)-1 << (l)) & ((uintptr_t)-1 >> (__WORDSIZE - 1 - (h))))
29 # define likely(x) __builtin_expect(!!(x),1)
30 # define unlikely(x) __builtin_expect(!!(x),0)
32 # define likely(x) (x)
33 # define unlikely(x) (x)
36 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
37 # define LE32TOH(x) __builtin_bswap32(x)
38 # define HTOLE32(x) __builtin_bswap32(x)
39 # define LE16TOH(x) __builtin_bswap16(x)
40 # define HTOLE16(x) __builtin_bswap16(x)
42 # define LE32TOH(x) (x)
43 # define HTOLE32(x) (x)
44 # define LE16TOH(x) (x)
45 # define HTOLE16(x) (x)
49 #define SET_DEFAULT_ELM(table, value) [0 ... ARRAY_SIZE(table) - 1] = value
51 #define SET_DEFAULT_ELM(table, value) [0] = NULL
54 #define fallthrough do {} while (0) /* fall-through */
56 #define container_of(ptr, type, member) \
57 ((type *)((void *)(ptr) - offsetof(type, member)))
60 # define popcount32(x) __popcnt(x)
61 # define clz32(x) _lzcnt_u32(x)
62 # define ctz32(x) _tzcnt_u32(x)
64 # define popcount32(x) __builtin_popcount(x)
65 # define clz32(x) __builtin_clz(x)
66 # define ctz32(x) __builtin_ctz(x)
69 /* Flags for (struct block *)->flags */
70 #define BLOCK_NEVER_COMPILE BIT(0)
71 #define BLOCK_SHOULD_RECOMPILE BIT(1)
72 #define BLOCK_FULLY_TAGGED BIT(2)
73 #define BLOCK_IS_DEAD BIT(3)
74 #define BLOCK_IS_MEMSET BIT(4)
75 #define BLOCK_NO_OPCODE_LIST BIT(5)
77 #define RAM_SIZE 0x200000
78 #define BIOS_SIZE 0x80000
80 #define CODE_LUT_SIZE ((RAM_SIZE + BIOS_SIZE) >> 2)
84 #define REG_CP2_TEMP (offsetof(struct lightrec_state, cp2_temp_reg) / sizeof(u32))
86 /* Definition of jit_state_t (avoids inclusion of <lightning.h>) */
89 typedef struct jit_state jit_state_t;
98 #if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
107 struct opcode *opcode_list;
108 void (*function)(void);
114 unsigned int code_size;
116 #if ENABLE_THREADED_COMPILER
123 struct lightrec_branch {
124 struct jit_node *branch;
128 struct lightrec_branch_target {
129 struct jit_node *label;
135 C_WRAPPER_RW_GENERIC,
142 struct lightrec_cstate {
143 struct lightrec_state *state;
145 struct lightrec_branch local_branches[512];
146 struct lightrec_branch_target targets[512];
147 unsigned int nb_local_branches;
148 unsigned int nb_targets;
151 struct regcache *reg_cache;
154 struct lightrec_state {
155 struct lightrec_registers regs;
158 uintptr_t wrapper_regs[NUM_TEMPS];
162 u32 old_cycle_counter;
163 struct block *dispatcher, *c_wrapper_block;
164 void *c_wrappers[C_WRAPPERS_COUNT];
165 void *wrappers_eps[C_WRAPPERS_COUNT];
166 struct blockcache *block_cache;
167 struct recompiler *rec;
168 struct lightrec_cstate *cstate;
169 struct reaper *reaper;
171 void (*eob_wrapper_func)(void);
172 void (*memset_func)(void);
173 void (*get_next_block)(void);
174 struct lightrec_ops ops;
175 unsigned int nb_precompile;
176 unsigned int nb_maps;
177 const struct lightrec_mem_map *maps;
178 uintptr_t offset_ram, offset_bios, offset_scratch, offset_io;
179 _Bool with_32bit_lut;
180 _Bool mirrors_mapped;
181 _Bool invalidate_from_dma_only;
185 u32 lightrec_rw(struct lightrec_state *state, union code op,
186 u32 addr, u32 data, u32 *flags,
187 struct block *block);
189 void lightrec_free_block(struct lightrec_state *state, struct block *block);
191 void remove_from_code_lut(struct blockcache *cache, struct block *block);
193 const struct lightrec_mem_map *
194 lightrec_get_map(struct lightrec_state *state, void **host, u32 kaddr);
196 static inline u32 kunseg(u32 addr)
198 if (unlikely(addr >= 0xa0000000))
199 return addr - 0xa0000000;
201 return addr &~ 0x80000000;
204 static inline u32 lut_offset(u32 pc)
207 return ((pc & (BIOS_SIZE - 1)) + RAM_SIZE) >> 2; // BIOS
209 return (pc & (RAM_SIZE - 1)) >> 2; // RAM
212 static inline _Bool is_big_endian(void)
214 return __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__;
217 static inline _Bool lut_is_32bit(const struct lightrec_state *state)
219 return __WORDSIZE == 32 ||
220 (ENABLE_CODE_BUFFER && state->with_32bit_lut);
223 static inline size_t lut_elm_size(const struct lightrec_state *state)
225 return lut_is_32bit(state) ? 4 : sizeof(void *);
228 static inline void ** lut_address(struct lightrec_state *state, u32 offset)
230 if (lut_is_32bit(state))
231 return (void **) ((uintptr_t) state->code_lut + offset * 4);
233 return &state->code_lut[offset];
236 static inline void * lut_read(struct lightrec_state *state, u32 offset)
238 void **lut_entry = lut_address(state, offset);
240 if (lut_is_32bit(state))
241 return (void *)(uintptr_t) *(u32 *) lut_entry;
246 static inline void lut_write(struct lightrec_state *state, u32 offset, void *ptr)
248 void **lut_entry = lut_address(state, offset);
250 if (lut_is_32bit(state))
251 *(u32 *) lut_entry = (u32)(uintptr_t) ptr;
256 static inline u32 get_ds_pc(const struct block *block, u16 offset, s16 imm)
258 u16 flags = block->opcode_list[offset].flags;
260 offset += op_flag_no_ds(flags);
262 return block->pc + (offset + imm << 2);
265 static inline u32 get_branch_pc(const struct block *block, u16 offset, s16 imm)
267 u16 flags = block->opcode_list[offset].flags;
269 offset -= op_flag_no_ds(flags);
271 return block->pc + (offset + imm << 2);
274 void lightrec_mtc(struct lightrec_state *state, union code op, u8 reg, u32 data);
275 u32 lightrec_mfc(struct lightrec_state *state, union code op);
276 void lightrec_rfe(struct lightrec_state *state);
277 void lightrec_cp(struct lightrec_state *state, union code op);
279 struct lightrec_cstate * lightrec_create_cstate(struct lightrec_state *state);
280 void lightrec_free_cstate(struct lightrec_cstate *cstate);
282 union code lightrec_read_opcode(struct lightrec_state *state, u32 pc);
284 int lightrec_compile_block(struct lightrec_cstate *cstate, struct block *block);
285 void lightrec_free_opcode_list(struct lightrec_state *state,
286 struct opcode *list);
288 unsigned int lightrec_cycles_of_opcode(union code code);
290 static inline u8 get_mult_div_lo(union code c)
292 return (OPT_FLAG_MULT_DIV && c.r.rd) ? c.r.rd : REG_LO;
295 static inline u8 get_mult_div_hi(union code c)
297 return (OPT_FLAG_MULT_DIV && c.r.imm) ? c.r.imm : REG_HI;
300 static inline s16 s16_max(s16 a, s16 b)
302 return a > b ? a : b;
305 static inline _Bool block_has_flag(struct block *block, u8 flag)
307 #if ENABLE_THREADED_COMPILER
308 return atomic_load_explicit(&block->flags, memory_order_relaxed) & flag;
310 return block->flags & flag;
314 static inline u8 block_set_flags(struct block *block, u8 mask)
316 #if ENABLE_THREADED_COMPILER
317 return atomic_fetch_or_explicit(&block->flags, mask,
318 memory_order_relaxed);
320 u8 flags = block->flags;
322 block->flags |= mask;
328 static inline u8 block_clear_flags(struct block *block, u8 mask)
330 #if ENABLE_THREADED_COMPILER
331 return atomic_fetch_and_explicit(&block->flags, ~mask,
332 memory_order_relaxed);
334 u8 flags = block->flags;
336 block->flags &= ~mask;
342 static inline _Bool can_sign_extend(s32 value, u8 order)
344 return (u32)(value >> order - 1) + 1 < 2;
347 static inline _Bool can_zero_extend(u32 value, u8 order)
349 return (value >> order) == 0;
352 #endif /* __LIGHTREC_PRIVATE_H__ */