[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 "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 (*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 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);

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