add a thp-based huge page alloc fallback
[pcsx_rearmed.git] / deps / lightrec / lightrec.h
... / ...
CommitLineData
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2016-2021 Paul Cercueil <paul@crapouillou.net>
4 */
5
6#ifndef __LIGHTREC_H__
7#define __LIGHTREC_H__
8
9#ifdef __cplusplus
10#define _Bool bool
11extern "C" {
12#endif
13
14#include <stddef.h>
15#include <stdint.h>
16
17#ifdef _WIN32
18# ifdef lightrec_EXPORTS
19# define __api __declspec(dllexport)
20# elif !defined(LIGHTREC_STATIC)
21# define __api __declspec(dllimport)
22# else
23# define __api
24# endif
25#elif __GNUC__ >= 4
26# define __api __attribute__((visibility ("default")))
27#else
28# define __api
29#endif
30
31#ifndef __cnst
32# ifdef __GNUC__
33# define __cnst __attribute__((const))
34# else
35# define __cnst
36# endif
37#endif
38#ifndef __pure
39# ifdef __GNUC__
40# define __pure __attribute__((pure))
41# else
42# define __pure
43# endif
44#endif
45
46typedef uint64_t u64;
47typedef uint32_t u32;
48typedef uint16_t u16;
49typedef uint8_t u8;
50
51typedef int64_t s64;
52typedef int32_t s32;
53typedef int16_t s16;
54typedef int8_t s8;
55
56struct lightrec_state;
57struct lightrec_mem_map;
58
59/* Exit flags */
60#define LIGHTREC_EXIT_NORMAL (0)
61#define LIGHTREC_EXIT_CHECK_INTERRUPT (1 << 0)
62#define LIGHTREC_EXIT_BREAK (1 << 1)
63#define LIGHTREC_EXIT_SYSCALL (1 << 2)
64#define LIGHTREC_EXIT_SEGFAULT (1 << 3)
65#define LIGHTREC_EXIT_NOMEM (1 << 4)
66#define LIGHTREC_EXIT_UNKNOWN_OP (1 << 5)
67
68/* Unsafe optimizations flags */
69#define LIGHTREC_OPT_INV_DMA_ONLY (1 << 0)
70#define LIGHTREC_OPT_SP_GP_HIT_RAM (1 << 1)
71
72enum psx_map {
73 PSX_MAP_KERNEL_USER_RAM,
74 PSX_MAP_BIOS,
75 PSX_MAP_SCRATCH_PAD,
76 PSX_MAP_PARALLEL_PORT,
77 PSX_MAP_HW_REGISTERS,
78 PSX_MAP_CACHE_CONTROL,
79 PSX_MAP_MIRROR1,
80 PSX_MAP_MIRROR2,
81 PSX_MAP_MIRROR3,
82 PSX_MAP_CODE_BUFFER,
83 PSX_MAP_PPORT_MIRROR,
84
85 PSX_MAP_UNKNOWN,
86};
87
88struct lightrec_mem_map_ops {
89 void (*sb)(struct lightrec_state *, u32 opcode,
90 void *host, u32 addr, u8 data);
91 void (*sh)(struct lightrec_state *, u32 opcode,
92 void *host, u32 addr, u16 data);
93 void (*sw)(struct lightrec_state *, u32 opcode,
94 void *host, u32 addr, u32 data);
95 u8 (*lb)(struct lightrec_state *, u32 opcode, void *host, u32 addr);
96 u16 (*lh)(struct lightrec_state *, u32 opcode, void *host, u32 addr);
97 u32 (*lw)(struct lightrec_state *, u32 opcode, void *host, u32 addr);
98};
99
100struct lightrec_mem_map {
101 u32 pc;
102 u32 length;
103 void *address;
104 const struct lightrec_mem_map_ops *ops;
105 const struct lightrec_mem_map *mirror_of;
106};
107
108struct lightrec_ops {
109 void (*cop2_notify)(struct lightrec_state *state, u32 op, u32 data);
110 void (*cop2_op)(struct lightrec_state *state, u32 op);
111 void (*enable_ram)(struct lightrec_state *state, _Bool enable);
112 _Bool (*hw_direct)(u32 kaddr, _Bool is_write, u8 size);
113 void (*code_inv)(void *addr, u32 len);
114};
115
116struct lightrec_registers {
117 u32 gpr[34];
118 u32 cp0[32];
119 u32 cp2d[32];
120 u32 cp2c[32];
121};
122
123__api struct lightrec_state *lightrec_init(char *argv0,
124 const struct lightrec_mem_map *map,
125 size_t nb,
126 const struct lightrec_ops *ops);
127
128__api void lightrec_destroy(struct lightrec_state *state);
129
130__api u32 lightrec_execute(struct lightrec_state *state,
131 u32 pc, u32 target_cycle);
132__api u32 lightrec_run_interpreter(struct lightrec_state *state,
133 u32 pc, u32 target_cycle);
134
135__api void lightrec_invalidate(struct lightrec_state *state, u32 addr, u32 len);
136__api void lightrec_invalidate_all(struct lightrec_state *state);
137
138__api void lightrec_set_exit_flags(struct lightrec_state *state, u32 flags);
139__api u32 lightrec_exit_flags(struct lightrec_state *state);
140
141__api void lightrec_set_unsafe_opt_flags(struct lightrec_state *state, u32 flags);
142
143__api __cnst struct lightrec_registers *
144lightrec_get_registers(struct lightrec_state *state);
145
146__api u32 lightrec_current_cycle_count(const struct lightrec_state *state);
147__api void lightrec_reset_cycle_count(struct lightrec_state *state, u32 cycles);
148__api void lightrec_set_target_cycle_count(struct lightrec_state *state,
149 u32 cycles);
150__api void lightrec_set_cycles_per_opcode(struct lightrec_state *state, u32 cycles);
151
152#ifdef __cplusplus
153};
154#endif
155
156#endif /* __LIGHTREC_H__ */