[pcsx_rearmed.git] / deps / lightrec / lightrec-private.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2016-2021 Paul Cercueil <paul@crapouillou.net>
 */

#ifndef __LIGHTREC_PRIVATE_H__
#define __LIGHTREC_PRIVATE_H__

#include "lightning-wrapper.h"
#include "lightrec-config.h"
#include "disassembler.h"
#include "lightrec.h"

#if ENABLE_THREADED_COMPILER
#include <stdatomic.h>
#endif

#define ARRAY_SIZE(x) (sizeof(x) ? sizeof(x) / sizeof((x)[0]) : 0)

#ifdef __GNUC__
#	define likely(x)       __builtin_expect(!!(x),1)
#	define unlikely(x)     __builtin_expect(!!(x),0)
#else
#	define likely(x)       (x)
#	define unlikely(x)     (x)
#endif

#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
#	define LE32TOH(x)	__builtin_bswap32(x)
#	define HTOLE32(x)	__builtin_bswap32(x)
#	define LE16TOH(x)	__builtin_bswap16(x)
#	define HTOLE16(x)	__builtin_bswap16(x)
#else
#	define LE32TOH(x)	(x)
#	define HTOLE32(x)	(x)
#	define LE16TOH(x)	(x)
#	define HTOLE16(x)	(x)
#endif

#if HAS_DEFAULT_ELM
#define SET_DEFAULT_ELM(table, value) [0 ... ARRAY_SIZE(table) - 1] = value
#else
#define SET_DEFAULT_ELM(table, value) [0] = NULL
#endif

/* Flags for (struct block *)->flags */
#define BLOCK_NEVER_COMPILE	BIT(0)
#define BLOCK_SHOULD_RECOMPILE	BIT(1)
#define BLOCK_FULLY_TAGGED	BIT(2)
#define BLOCK_IS_DEAD		BIT(3)
#define BLOCK_IS_MEMSET		BIT(4)

#define RAM_SIZE	0x200000
#define BIOS_SIZE	0x80000

#define CODE_LUT_SIZE	((RAM_SIZE + BIOS_SIZE) >> 2)

#define REG_LO 32
#define REG_HI 33

/* Definition of jit_state_t (avoids inclusion of <lightning.h>) */
struct jit_node;
struct jit_state;
typedef struct jit_state jit_state_t;

struct blockcache;
struct recompiler;
struct regcache;
struct opcode;
struct tinymm;
struct reaper;

struct block {
	jit_state_t *_jit;
	struct opcode *opcode_list;
	void (*function)(void);
	const u32 *code;
	struct block *next;
	u32 pc;
	u32 hash;
	unsigned int code_size;
	u16 nb_ops;
	u8 flags;
#if ENABLE_THREADED_COMPILER
	atomic_flag op_list_freed;
#endif
};

struct lightrec_branch {
	struct jit_node *branch;
	u32 target;
};

struct lightrec_branch_target {
	struct jit_node *label;
	u32 offset;
};

enum c_wrappers {
	C_WRAPPER_RW,
	C_WRAPPER_RW_GENERIC,
	C_WRAPPER_MTC,
	C_WRAPPER_CP,
	C_WRAPPER_SYSCALL,
	C_WRAPPER_BREAK,
	C_WRAPPERS_COUNT,
};

struct lightrec_cstate {
	struct lightrec_state *state;

	struct jit_node *branches[512];
	struct lightrec_branch local_branches[512];
	struct lightrec_branch_target targets[512];
	unsigned int nb_branches;
	unsigned int nb_local_branches;
	unsigned int nb_targets;
	unsigned int cycles;

	struct regcache *reg_cache;
};

struct lightrec_state {
	struct lightrec_registers regs;
	u32 next_pc;
	u32 current_cycle;
	u32 target_cycle;
	u32 exit_flags;
	u32 old_cycle_counter;
	u32 c_wrapper_arg;
	struct block *dispatcher, *c_wrapper_block;
	void *c_wrappers[C_WRAPPERS_COUNT];
	void *wrappers_eps[C_WRAPPERS_COUNT];
	struct tinymm *tinymm;
	struct blockcache *block_cache;
	struct recompiler *rec;
	struct lightrec_cstate *cstate;
	struct reaper *reaper;
	void *tlsf;
	void (*eob_wrapper_func)(void);
	void (*memset_func)(void);
	void (*get_next_block)(void);
	struct lightrec_ops ops;
	unsigned int nb_precompile;
	unsigned int nb_maps;
	const struct lightrec_mem_map *maps;
	uintptr_t offset_ram, offset_bios, offset_scratch;
	_Bool with_32bit_lut;
	_Bool mirrors_mapped;
	_Bool invalidate_from_dma_only;
	void *code_lut[];
};

u32 lightrec_rw(struct lightrec_state *state, union code op,
		u32 addr, u32 data, u16 *flags,
		struct block *block);

void lightrec_free_block(struct lightrec_state *state, struct block *block);

void remove_from_code_lut(struct blockcache *cache, struct block *block);

enum psx_map
lightrec_get_map_idx(struct lightrec_state *state, u32 kaddr);

const struct lightrec_mem_map *
lightrec_get_map(struct lightrec_state *state, void **host, u32 kaddr);

static inline u32 kunseg(u32 addr)
{
	if (unlikely(addr >= 0xa0000000))
		return addr - 0xa0000000;
	else
		return addr &~ 0x80000000;
}

static inline u32 lut_offset(u32 pc)
{
	if (pc & BIT(28))
		return ((pc & (BIOS_SIZE - 1)) + RAM_SIZE) >> 2; // BIOS
	else
		return (pc & (RAM_SIZE - 1)) >> 2; // RAM
}

static inline _Bool is_big_endian(void)
{
	return __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__;
}

static inline _Bool lut_is_32bit(const struct lightrec_state *state)
{
	return __WORDSIZE == 32 ||
		(ENABLE_CODE_BUFFER && state->with_32bit_lut);
}

static inline size_t lut_elm_size(const struct lightrec_state *state)
{
	return lut_is_32bit(state) ? 4 : sizeof(void *);
}

static inline void ** lut_address(struct lightrec_state *state, u32 offset)
{
	if (lut_is_32bit(state))
		return (void **) ((uintptr_t) state->code_lut + offset * 4);
	else
		return &state->code_lut[offset];
}

static inline void * lut_read(struct lightrec_state *state, u32 offset)
{
	void **lut_entry = lut_address(state, lut_offset(offset));

	if (lut_is_32bit(state))
		return (void *)(uintptr_t) *(u32 *) lut_entry;
	else
		return *lut_entry;
}

static inline void lut_write(struct lightrec_state *state, u32 offset, void *ptr)
{
	void **lut_entry = lut_address(state, offset);

	if (lut_is_32bit(state))
		*(u32 *) lut_entry = (u32)(uintptr_t) ptr;
	else
		*lut_entry = ptr;
}

static inline u32 get_ds_pc(const struct block *block, u16 offset, s16 imm)
{
	u16 flags = block->opcode_list[offset].flags;

	offset += !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));

	return block->pc + (offset + imm << 2);
}

static inline u32 get_branch_pc(const struct block *block, u16 offset, s16 imm)
{
	u16 flags = block->opcode_list[offset].flags;

	offset -= !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));

	return block->pc + (offset + imm << 2);
}

void lightrec_mtc(struct lightrec_state *state, union code op, u32 data);
u32 lightrec_mfc(struct lightrec_state *state, union code op);
void lightrec_rfe(struct lightrec_state *state);
void lightrec_cp(struct lightrec_state *state, union code op);

struct lightrec_cstate * lightrec_create_cstate(struct lightrec_state *state);
void lightrec_free_cstate(struct lightrec_cstate *cstate);

union code lightrec_read_opcode(struct lightrec_state *state, u32 pc);

struct block * lightrec_get_block(struct lightrec_state *state, u32 pc);
int lightrec_compile_block(struct lightrec_cstate *cstate, struct block *block);
void lightrec_free_opcode_list(struct lightrec_state *state, struct block *block);

unsigned int lightrec_cycles_of_opcode(union code code);

static inline u8 get_mult_div_lo(union code c)
{
	return (OPT_FLAG_MULT_DIV && c.r.rd) ? c.r.rd : REG_LO;
}

static inline u8 get_mult_div_hi(union code c)
{
	return (OPT_FLAG_MULT_DIV && c.r.imm) ? c.r.imm : REG_HI;
}

#endif /* __LIGHTREC_PRIVATE_H__ */
Commit	Line	Data
98fa08a5	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
d16005f8	2	/*
98fa08a5	3	* Copyright (C) 2016-2021 Paul Cercueil <paul@crapouillou.net>
d16005f8 PC	4	*/
	5
	6	#ifndef __LIGHTREC_PRIVATE_H__
	7	#define __LIGHTREC_PRIVATE_H__
	8
02487de7	9	#include "lightning-wrapper.h"
98fa08a5	10	#include "lightrec-config.h"
d16005f8 PC	11	#include "disassembler.h"
	12	#include "lightrec.h"
	13
	14	#if ENABLE_THREADED_COMPILER
	15	#include <stdatomic.h>
	16	#endif
	17
	18	#define ARRAY_SIZE(x) (sizeof(x) ? sizeof(x) / sizeof((x)[0]) : 0)
d16005f8 PC	19
	20	#ifdef __GNUC__
	21	# define likely(x) __builtin_expect(!!(x),1)
	22	# define unlikely(x) __builtin_expect(!!(x),0)
	23	#else
	24	# define likely(x) (x)
	25	# define unlikely(x) (x)
	26	#endif
	27
	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)
	33	#else
	34	# define LE32TOH(x) (x)
	35	# define HTOLE32(x) (x)
	36	# define LE16TOH(x) (x)
	37	# define HTOLE16(x) (x)
	38	#endif
	39
98fa08a5 PC	40	#if HAS_DEFAULT_ELM
	41	#define SET_DEFAULT_ELM(table, value) [0 ... ARRAY_SIZE(table) - 1] = value
	42	#else
	43	#define SET_DEFAULT_ELM(table, value) [0] = NULL
	44	#endif
	45
d16005f8 PC	46	/* Flags for (struct block )->flags /
	47	#define BLOCK_NEVER_COMPILE BIT(0)
	48	#define BLOCK_SHOULD_RECOMPILE BIT(1)
	49	#define BLOCK_FULLY_TAGGED BIT(2)
a59e5536	50	#define BLOCK_IS_DEAD BIT(3)
98fa08a5	51	#define BLOCK_IS_MEMSET BIT(4)
d16005f8 PC	52
	53	#define RAM_SIZE 0x200000
	54	#define BIOS_SIZE 0x80000
	55
	56	#define CODE_LUT_SIZE ((RAM_SIZE + BIOS_SIZE) >> 2)
	57
98fa08a5 PC	58	#define REG_LO 32
	59	#define REG_HI 33
	60
d16005f8 PC	61	/* Definition of jit_state_t (avoids inclusion of <lightning.h>) */
	62	struct jit_node;
	63	struct jit_state;
	64	typedef struct jit_state jit_state_t;
	65
	66	struct blockcache;
	67	struct recompiler;
	68	struct regcache;
	69	struct opcode;
	70	struct tinymm;
a59e5536	71	struct reaper;
d16005f8 PC	72
	73	struct block {
	74	jit_state_t *_jit;
d16005f8 PC	75	struct opcode *opcode_list;
d16005f8 PC	76	void (*function)(void);
98fa08a5 PC	77	const u32 *code;
98fa08a5 PC	78	struct block *next;
d16005f8 PC	79	u32 pc;
d16005f8 PC	80	u32 hash;
98fa08a5 PC	81	unsigned int code_size;
	82	u16 nb_ops;
	83	u8 flags;
d16005f8 PC	84	#if ENABLE_THREADED_COMPILER
	85	atomic_flag op_list_freed;
	86	#endif
d16005f8 PC	87	};
	88
	89	struct lightrec_branch {
	90	struct jit_node *branch;
	91	u32 target;
	92	};
	93
	94	struct lightrec_branch_target {
	95	struct jit_node *label;
	96	u32 offset;
	97	};
	98
98fa08a5 PC	99	enum c_wrappers {
	100	C_WRAPPER_RW,
	101	C_WRAPPER_RW_GENERIC,
98fa08a5 PC	102	C_WRAPPER_MTC,
	103	C_WRAPPER_CP,
	104	C_WRAPPER_SYSCALL,
	105	C_WRAPPER_BREAK,
	106	C_WRAPPERS_COUNT,
	107	};
	108
	109	struct lightrec_cstate {
	110	struct lightrec_state *state;
	111
d16005f8 PC	112	struct jit_node *branches[512];
	113	struct lightrec_branch local_branches[512];
	114	struct lightrec_branch_target targets[512];
	115	unsigned int nb_branches;
	116	unsigned int nb_local_branches;
	117	unsigned int nb_targets;
98fa08a5 PC	118	unsigned int cycles;
	119
	120	struct regcache *reg_cache;
	121	};
	122
	123	struct lightrec_state {
	124	struct lightrec_registers regs;
	125	u32 next_pc;
	126	u32 current_cycle;
	127	u32 target_cycle;
	128	u32 exit_flags;
	129	u32 old_cycle_counter;
22eee2ac	130	u32 c_wrapper_arg;
98fa08a5	131	struct block dispatcher, c_wrapper_block;
fd58fa32 PC	132	void *c_wrappers[C_WRAPPERS_COUNT];
fd58fa32 PC	133	void *wrappers_eps[C_WRAPPERS_COUNT];
d16005f8 PC	134	struct tinymm *tinymm;
d16005f8 PC	135	struct blockcache *block_cache;
d16005f8	136	struct recompiler *rec;
98fa08a5	137	struct lightrec_cstate *cstate;
a59e5536	138	struct reaper *reaper;
02487de7	139	void *tlsf;
d16005f8	140	void (*eob_wrapper_func)(void);
98fa08a5	141	void (*memset_func)(void);
d16005f8 PC	142	void (*get_next_block)(void);
d16005f8 PC	143	struct lightrec_ops ops;
a59e5536	144	unsigned int nb_precompile;
d16005f8 PC	145	unsigned int nb_maps;
	146	const struct lightrec_mem_map *maps;
	147	uintptr_t offset_ram, offset_bios, offset_scratch;
02487de7	148	_Bool with_32bit_lut;
d16005f8 PC	149	_Bool mirrors_mapped;
	150	_Bool invalidate_from_dma_only;
	151	void *code_lut[];
	152	};
	153
	154	u32 lightrec_rw(struct lightrec_state *state, union code op,
98fa08a5 PC	155	u32 addr, u32 data, u16 *flags,
98fa08a5 PC	156	struct block *block);
d16005f8	157
98fa08a5	158	void lightrec_free_block(struct lightrec_state state, struct block block);
d16005f8 PC	159
	160	void remove_from_code_lut(struct blockcache cache, struct block block);
	161
02487de7 PC	162	enum psx_map
	163	lightrec_get_map_idx(struct lightrec_state *state, u32 kaddr);
	164
98fa08a5 PC	165	const struct lightrec_mem_map *
	166	lightrec_get_map(struct lightrec_state state, void *host, u32 kaddr);
	167
d16005f8 PC	168	static inline u32 kunseg(u32 addr)
	169	{
	170	if (unlikely(addr >= 0xa0000000))
	171	return addr - 0xa0000000;
	172	else
	173	return addr &~ 0x80000000;
	174	}
	175
	176	static inline u32 lut_offset(u32 pc)
	177	{
	178	if (pc & BIT(28))
	179	return ((pc & (BIOS_SIZE - 1)) + RAM_SIZE) >> 2; // BIOS
	180	else
	181	return (pc & (RAM_SIZE - 1)) >> 2; // RAM
	182	}
	183
02487de7 PC	184	static inline _Bool is_big_endian(void)
	185	{
	186	return __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__;
	187	}
	188
	189	static inline _Bool lut_is_32bit(const struct lightrec_state *state)
	190	{
	191	return __WORDSIZE == 32 \|\|
	192	(ENABLE_CODE_BUFFER && state->with_32bit_lut);
	193	}
	194
	195	static inline size_t lut_elm_size(const struct lightrec_state *state)
	196	{
	197	return lut_is_32bit(state) ? 4 : sizeof(void *);
	198	}
	199
	200	static inline void ** lut_address(struct lightrec_state *state, u32 offset)
	201	{
	202	if (lut_is_32bit(state))
	203	return (void *) ((uintptr_t) state->code_lut + offset 4);
	204	else
	205	return &state->code_lut[offset];
	206	}
	207
	208	static inline void * lut_read(struct lightrec_state *state, u32 offset)
	209	{
	210	void **lut_entry = lut_address(state, lut_offset(offset));
	211
	212	if (lut_is_32bit(state))
	213	return (void )(uintptr_t) (u32 *) lut_entry;
	214	else
	215	return *lut_entry;
	216	}
	217
	218	static inline void lut_write(struct lightrec_state state, u32 offset, void ptr)
	219	{
	220	void **lut_entry = lut_address(state, offset);
	221
	222	if (lut_is_32bit(state))
	223	(u32 ) lut_entry = (u32)(uintptr_t) ptr;
	224	else
	225	*lut_entry = ptr;
	226	}
	227
98fa08a5 PC	228	static inline u32 get_ds_pc(const struct block *block, u16 offset, s16 imm)
	229	{
	230	u16 flags = block->opcode_list[offset].flags;
	231
	232	offset += !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));
	233
	234	return block->pc + (offset + imm << 2);
	235	}
	236
	237	static inline u32 get_branch_pc(const struct block *block, u16 offset, s16 imm)
	238	{
	239	u16 flags = block->opcode_list[offset].flags;
	240
	241	offset -= !!(OPT_SWITCH_DELAY_SLOTS && (flags & LIGHTREC_NO_DS));
	242
	243	return block->pc + (offset + imm << 2);
	244	}
	245
d16005f8 PC	246	void lightrec_mtc(struct lightrec_state *state, union code op, u32 data);
d16005f8 PC	247	u32 lightrec_mfc(struct lightrec_state *state, union code op);
98fa08a5 PC	248	void lightrec_rfe(struct lightrec_state *state);
	249	void lightrec_cp(struct lightrec_state *state, union code op);
	250
	251	struct lightrec_cstate * lightrec_create_cstate(struct lightrec_state *state);
	252	void lightrec_free_cstate(struct lightrec_cstate *cstate);
d16005f8 PC	253
	254	union code lightrec_read_opcode(struct lightrec_state *state, u32 pc);
	255
	256	struct block * lightrec_get_block(struct lightrec_state *state, u32 pc);
98fa08a5 PC	257	int lightrec_compile_block(struct lightrec_cstate cstate, struct block block);
	258	void lightrec_free_opcode_list(struct lightrec_state state, struct block block);
	259
	260	unsigned int lightrec_cycles_of_opcode(union code code);
	261
	262	static inline u8 get_mult_div_lo(union code c)
	263	{
	264	return (OPT_FLAG_MULT_DIV && c.r.rd) ? c.r.rd : REG_LO;
	265	}
	266
	267	static inline u8 get_mult_div_hi(union code c)
	268	{
	269	return (OPT_FLAG_MULT_DIV && c.r.imm) ? c.r.imm : REG_HI;
	270	}
d16005f8 PC	271
d16005f8 PC	272	#endif /* __LIGHTREC_PRIVATE_H__ */