git subrepo pull --force deps/lightrec
[pcsx_rearmed.git] / deps / lightrec / regcache.c
1 // SPDX-License-Identifier: LGPL-2.1-or-later
2 /*
3  * Copyright (C) 2014-2021 Paul Cercueil <paul@crapouillou.net>
4  */
5
6 #include "debug.h"
7 #include "memmanager.h"
8 #include "lightning-wrapper.h"
9 #include "regcache.h"
10
11 #include <stdbool.h>
12 #include <stddef.h>
13
14 #define REG_PC (offsetof(struct lightrec_state, next_pc) / sizeof(u32))
15
16 enum reg_priority {
17         REG_IS_TEMP,
18         REG_IS_TEMP_VALUE,
19         REG_IS_ZERO,
20         REG_IS_LOADED,
21         REG_IS_DIRTY,
22
23         REG_NB_PRIORITIES,
24 };
25
26 struct native_register {
27         bool used, output, extend, extended,
28              zero_extend, zero_extended, locked;
29         s16 emulated_register;
30         intptr_t value;
31         enum reg_priority prio;
32 };
33
34 struct regcache {
35         struct lightrec_state *state;
36         struct native_register lightrec_regs[NUM_REGS + NUM_TEMPS];
37 };
38
39 static const char * mips_regs[] = {
40         "zero",
41         "at",
42         "v0", "v1",
43         "a0", "a1", "a2", "a3",
44         "t0", "t1", "t2", "t3", "t4", "t5", "t6", "t7",
45         "s0", "s1", "s2", "s3", "s4", "s5", "s6", "s7",
46         "t8", "t9",
47         "k0", "k1",
48         "gp", "sp", "fp", "ra",
49         "lo", "hi",
50 };
51
52 /* Forward declaration(s) */
53 static void clean_reg(jit_state_t *_jit,
54                       struct native_register *nreg, u8 jit_reg, bool clean);
55
56 const char * lightrec_reg_name(u8 reg)
57 {
58         return mips_regs[reg];
59 }
60
61 static inline bool lightrec_reg_is_zero(u8 jit_reg)
62 {
63 #if defined(__mips__) || defined(__alpha__) || defined(__riscv)
64         if (jit_reg == _ZERO)
65                 return true;
66 #endif
67         return false;
68 }
69
70 static inline s8 lightrec_get_hardwired_reg(u16 reg)
71 {
72 #if defined(__mips__) || defined(__alpha__) || defined(__riscv)
73         if (reg == 0)
74                 return _ZERO;
75 #endif
76         return -1;
77 }
78
79 static inline u8 lightrec_reg_number(const struct regcache *cache,
80                 const struct native_register *nreg)
81 {
82         return (u8) (((uintptr_t) nreg - (uintptr_t) cache->lightrec_regs)
83                         / sizeof(*nreg));
84 }
85
86 static inline u8 lightrec_reg_to_lightning(const struct regcache *cache,
87                 const struct native_register *nreg)
88 {
89         u8 offset = lightrec_reg_number(cache, nreg);
90
91         if (offset < NUM_REGS)
92                 return JIT_V(FIRST_REG + offset);
93         else
94                 return JIT_R(FIRST_TEMP + offset - NUM_REGS);
95 }
96
97 static inline struct native_register * lightning_reg_to_lightrec(
98                 struct regcache *cache, u8 reg)
99 {
100         if ((JIT_V0 > JIT_R0 && reg >= JIT_V0) ||
101                         (JIT_V0 < JIT_R0 && reg < JIT_R0)) {
102                 if (JIT_V1 > JIT_V0)
103                         return &cache->lightrec_regs[reg - JIT_V(FIRST_REG)];
104                 else
105                         return &cache->lightrec_regs[JIT_V(FIRST_REG) - reg];
106         } else {
107                 if (JIT_R1 > JIT_R0)
108                         return &cache->lightrec_regs[NUM_REGS + reg - JIT_R(FIRST_TEMP)];
109                 else
110                         return &cache->lightrec_regs[NUM_REGS + JIT_R(FIRST_TEMP) - reg];
111         }
112 }
113
114 u8 lightrec_get_reg_in_flags(struct regcache *cache, u8 jit_reg)
115 {
116         struct native_register *reg;
117         u8 flags = 0;
118
119         if (lightrec_reg_is_zero(jit_reg))
120                 return REG_EXT | REG_ZEXT;
121
122         reg = lightning_reg_to_lightrec(cache, jit_reg);
123         if (reg->extended)
124                 flags |= REG_EXT;
125         if (reg->zero_extended)
126                 flags |= REG_ZEXT;
127
128         return flags;
129 }
130
131 void lightrec_set_reg_out_flags(struct regcache *cache, u8 jit_reg, u8 flags)
132 {
133         struct native_register *reg;
134
135         if (!lightrec_reg_is_zero(jit_reg)) {
136                 reg = lightning_reg_to_lightrec(cache, jit_reg);
137                 reg->extend = flags & REG_EXT;
138                 reg->zero_extend = flags & REG_ZEXT;
139         }
140 }
141
142 static struct native_register * alloc_temp(struct regcache *cache)
143 {
144         struct native_register *elm, *nreg = NULL;
145         enum reg_priority best = REG_NB_PRIORITIES;
146         unsigned int i;
147
148         /* We search the register list in reverse order. As temporaries are
149          * meant to be used only in the emitter functions, they can be mapped to
150          * caller-saved registers, as they won't have to be saved back to
151          * memory. */
152         for (i = ARRAY_SIZE(cache->lightrec_regs); i; i--) {
153                 elm = &cache->lightrec_regs[i - 1];
154
155                 if (!elm->used && !elm->locked && elm->prio < best) {
156                         nreg = elm;
157                         best = elm->prio;
158
159                         if (best == REG_IS_TEMP)
160                                 break;
161                 }
162         }
163
164         return nreg;
165 }
166
167 static struct native_register * find_mapped_reg(struct regcache *cache,
168                                                 u16 reg, bool out)
169 {
170         unsigned int i;
171
172         for (i = 0; i < ARRAY_SIZE(cache->lightrec_regs); i++) {
173                 struct native_register *nreg = &cache->lightrec_regs[i];
174                 if ((nreg->prio >= REG_IS_ZERO) &&
175                     nreg->emulated_register == reg &&
176                     (!out || !nreg->locked))
177                         return nreg;
178         }
179
180         return NULL;
181 }
182
183 static struct native_register * alloc_in_out(struct regcache *cache,
184                                              u16 reg, bool out)
185 {
186         struct native_register *elm, *nreg = NULL;
187         enum reg_priority best = REG_NB_PRIORITIES;
188         unsigned int i;
189
190         /* Try to find if the register is already mapped somewhere */
191         nreg = find_mapped_reg(cache, reg, out);
192         if (nreg)
193                 return nreg;
194
195         nreg = NULL;
196
197         for (i = 0; i < ARRAY_SIZE(cache->lightrec_regs); i++) {
198                 elm = &cache->lightrec_regs[i];
199
200                 if (!elm->used && !elm->locked && elm->prio < best) {
201                         nreg = elm;
202                         best = elm->prio;
203
204                         if (best == REG_IS_TEMP)
205                                 break;
206                 }
207         }
208
209         return nreg;
210 }
211
212 static void lightrec_discard_nreg(struct native_register *nreg)
213 {
214         nreg->extended = false;
215         nreg->zero_extended = false;
216         nreg->output = false;
217         nreg->used = false;
218         nreg->locked = false;
219         nreg->emulated_register = -1;
220         nreg->prio = 0;
221 }
222
223 static void lightrec_unload_nreg(struct regcache *cache, jit_state_t *_jit,
224                 struct native_register *nreg, u8 jit_reg)
225 {
226         clean_reg(_jit, nreg, jit_reg, false);
227         lightrec_discard_nreg(nreg);
228 }
229
230 void lightrec_unload_reg(struct regcache *cache, jit_state_t *_jit, u8 jit_reg)
231 {
232         if (lightrec_reg_is_zero(jit_reg))
233                 return;
234
235         lightrec_unload_nreg(cache, _jit,
236                         lightning_reg_to_lightrec(cache, jit_reg), jit_reg);
237 }
238
239 u8 lightrec_alloc_reg(struct regcache *cache, jit_state_t *_jit, u8 jit_reg)
240 {
241         struct native_register *reg;
242
243         if (lightrec_reg_is_zero(jit_reg))
244                 return jit_reg;
245
246         reg = lightning_reg_to_lightrec(cache, jit_reg);
247         lightrec_unload_nreg(cache, _jit, reg, jit_reg);
248
249         reg->used = true;
250         reg->prio = REG_IS_LOADED;
251         return jit_reg;
252 }
253
254 u8 lightrec_alloc_reg_temp(struct regcache *cache, jit_state_t *_jit)
255 {
256         u8 jit_reg;
257         struct native_register *nreg = alloc_temp(cache);
258         if (!nreg) {
259                 /* No free register, no dirty register to free. */
260                 pr_err("No more registers! Abandon ship!\n");
261                 return 0;
262         }
263
264         jit_reg = lightrec_reg_to_lightning(cache, nreg);
265         lightrec_unload_nreg(cache, _jit, nreg, jit_reg);
266
267         nreg->prio = REG_IS_TEMP;
268         nreg->used = true;
269         return jit_reg;
270 }
271
272 s8 lightrec_get_reg_with_value(struct regcache *cache, intptr_t value)
273 {
274         struct native_register *nreg;
275         unsigned int i;
276
277         for (i = 0; i < ARRAY_SIZE(cache->lightrec_regs); i++) {
278                 nreg = &cache->lightrec_regs[i];
279
280                 if (nreg->prio == REG_IS_TEMP_VALUE && nreg->value == value) {
281                         nreg->used = true;
282                         return lightrec_reg_to_lightning(cache, nreg);
283                 }
284         }
285
286         return -1;
287 }
288
289 void lightrec_temp_set_value(struct regcache *cache, u8 jit_reg, intptr_t value)
290 {
291         struct native_register *nreg;
292
293         nreg = lightning_reg_to_lightrec(cache, jit_reg);
294
295         nreg->prio = REG_IS_TEMP_VALUE;
296         nreg->value = value;
297 }
298
299 u8 lightrec_alloc_reg_out(struct regcache *cache, jit_state_t *_jit,
300                           u16 reg, u8 flags)
301 {
302         struct native_register *nreg;
303         u8 jit_reg;
304         s8 hw_reg;
305
306         hw_reg = lightrec_get_hardwired_reg(reg);
307         if (hw_reg >= 0)
308                 return (u8) hw_reg;
309
310         nreg = alloc_in_out(cache, reg, true);
311         if (!nreg) {
312                 /* No free register, no dirty register to free. */
313                 pr_err("No more registers! Abandon ship!\n");
314                 return 0;
315         }
316
317         jit_reg = lightrec_reg_to_lightning(cache, nreg);
318
319         /* If we get a dirty register that doesn't correspond to the one
320          * we're requesting, store back the old value */
321         if (nreg->emulated_register != reg)
322                 lightrec_unload_nreg(cache, _jit, nreg, jit_reg);
323
324         nreg->used = true;
325         nreg->output = true;
326         nreg->emulated_register = reg;
327         nreg->extend = flags & REG_EXT;
328         nreg->zero_extend = flags & REG_ZEXT;
329         nreg->prio = reg ? REG_IS_LOADED : REG_IS_ZERO;
330         return jit_reg;
331 }
332
333 u8 lightrec_alloc_reg_in(struct regcache *cache, jit_state_t *_jit,
334                          u16 reg, u8 flags)
335 {
336         struct native_register *nreg;
337         u8 jit_reg;
338         bool reg_changed;
339         s8 hw_reg;
340
341         hw_reg = lightrec_get_hardwired_reg(reg);
342         if (hw_reg >= 0)
343                 return (u8) hw_reg;
344
345         nreg = alloc_in_out(cache, reg, false);
346         if (!nreg) {
347                 /* No free register, no dirty register to free. */
348                 pr_err("No more registers! Abandon ship!\n");
349                 return 0;
350         }
351
352         jit_reg = lightrec_reg_to_lightning(cache, nreg);
353
354         /* If we get a dirty register that doesn't correspond to the one
355          * we're requesting, store back the old value */
356         reg_changed = nreg->emulated_register != reg;
357         if (reg_changed)
358                 lightrec_unload_nreg(cache, _jit, nreg, jit_reg);
359
360         if (nreg->prio < REG_IS_LOADED && reg != 0) {
361                 s16 offset = offsetof(struct lightrec_state, regs.gpr)
362                         + (reg << 2);
363
364                 nreg->zero_extended = flags & REG_ZEXT;
365                 nreg->extended = !nreg->zero_extended;
366
367                 /* Load previous value from register cache */
368                 if (nreg->zero_extended)
369                         jit_ldxi_ui(jit_reg, LIGHTREC_REG_STATE, offset);
370                 else
371                         jit_ldxi_i(jit_reg, LIGHTREC_REG_STATE, offset);
372
373                 nreg->prio = REG_IS_LOADED;
374         }
375
376         /* Clear register r0 before use */
377         if (reg == 0 && nreg->prio != REG_IS_ZERO) {
378                 jit_movi(jit_reg, 0);
379                 nreg->extended = true;
380                 nreg->zero_extended = true;
381                 nreg->prio = REG_IS_ZERO;
382         }
383
384         nreg->used = true;
385         nreg->output = false;
386         nreg->emulated_register = reg;
387
388         if ((flags & REG_EXT) && !nreg->extended &&
389             (!nreg->zero_extended || !(flags & REG_ZEXT))) {
390                 nreg->extended = true;
391                 nreg->zero_extended = false;
392                 jit_extr_i(jit_reg, jit_reg);
393         } else if (!(flags & REG_EXT) && (flags & REG_ZEXT) &&
394                    !nreg->zero_extended) {
395                 nreg->zero_extended = true;
396                 nreg->extended = false;
397                 jit_extr_ui(jit_reg, jit_reg);
398         }
399
400         return jit_reg;
401 }
402
403 static bool reg_pc_is_mapped(struct regcache *cache)
404 {
405         struct native_register *nreg = lightning_reg_to_lightrec(cache, JIT_V0);
406
407         return nreg->prio == REG_IS_LOADED && nreg->emulated_register == REG_PC;
408 }
409
410 void lightrec_load_imm(struct regcache *cache,
411                        jit_state_t *_jit, u8 jit_reg, u32 pc, u32 imm)
412 {
413         s32 delta = imm - pc;
414
415         if (!reg_pc_is_mapped(cache) || !can_sign_extend(delta, 16))
416                 jit_movi(jit_reg, imm);
417         else if (jit_reg != JIT_V0 || delta)
418                 jit_addi(jit_reg, JIT_V0, delta);
419 }
420
421 void lightrec_load_next_pc_imm(struct regcache *cache,
422                                jit_state_t *_jit, u32 pc, u32 imm)
423 {
424         struct native_register *nreg = lightning_reg_to_lightrec(cache, JIT_V0);
425
426         if (reg_pc_is_mapped(cache)) {
427                 /* JIT_V0 contains next PC - so we can overwrite it */
428                 lightrec_load_imm(cache, _jit, JIT_V0, pc, imm);
429         } else {
430                 /* JIT_V0 contains something else - invalidate it */
431                 lightrec_unload_reg(cache, _jit, JIT_V0);
432
433                 jit_movi(JIT_V0, imm);
434         }
435
436         nreg->prio = REG_IS_LOADED;
437         nreg->emulated_register = -1;
438         nreg->locked = true;
439 }
440
441 void lightrec_load_next_pc(struct regcache *cache, jit_state_t *_jit, u8 reg)
442 {
443         struct native_register *nreg_v0, *nreg;
444         u16 offset;
445         u8 jit_reg;
446
447         /* Invalidate JIT_V0 if it is not mapped to 'reg' */
448         nreg_v0 = lightning_reg_to_lightrec(cache, JIT_V0);
449         if (nreg_v0->prio >= REG_IS_LOADED && nreg_v0->emulated_register != reg)
450                 lightrec_unload_nreg(cache, _jit, nreg_v0, JIT_V0);
451
452         nreg = find_mapped_reg(cache, reg, false);
453         if (!nreg) {
454                 /* Not mapped - load the value from the register cache */
455
456                 offset = offsetof(struct lightrec_state, regs.gpr) + (reg << 2);
457                 jit_ldxi_ui(JIT_V0, LIGHTREC_REG_STATE, offset);
458
459                 nreg_v0->prio = REG_IS_LOADED;
460                 nreg_v0->emulated_register = reg;
461
462         } else if (nreg == nreg_v0) {
463                 /* The target register 'reg' is mapped to JIT_V0 */
464
465                 if (!nreg->zero_extended)
466                         jit_extr_ui(JIT_V0, JIT_V0);
467
468         } else {
469                 /* The target register 'reg' is mapped elsewhere. In that case,
470                  * move the register's value to JIT_V0 and re-map it in the
471                  * register cache. We can then safely discard the original
472                  * mapped register (even if it was dirty). */
473
474                 jit_reg = lightrec_reg_to_lightning(cache, nreg);
475                 if (nreg->zero_extended)
476                         jit_movr(JIT_V0, jit_reg);
477                 else
478                         jit_extr_ui(JIT_V0, jit_reg);
479
480                 *nreg_v0 = *nreg;
481                 lightrec_discard_nreg(nreg);
482         }
483
484         lightrec_clean_reg(cache, _jit, JIT_V0);
485
486         nreg_v0->zero_extended = true;
487         nreg_v0->locked = true;
488 }
489
490 static void free_reg(struct native_register *nreg)
491 {
492         /* Set output registers as dirty */
493         if (nreg->used && nreg->output && nreg->emulated_register > 0)
494                 nreg->prio = REG_IS_DIRTY;
495         if (nreg->output) {
496                 nreg->extended = nreg->extend;
497                 nreg->zero_extended = nreg->zero_extend;
498         }
499         nreg->used = false;
500 }
501
502 void lightrec_free_reg(struct regcache *cache, u8 jit_reg)
503 {
504         if (!lightrec_reg_is_zero(jit_reg))
505                 free_reg(lightning_reg_to_lightrec(cache, jit_reg));
506 }
507
508 void lightrec_free_regs(struct regcache *cache)
509 {
510         unsigned int i;
511
512         for (i = 0; i < ARRAY_SIZE(cache->lightrec_regs); i++)
513                 free_reg(&cache->lightrec_regs[i]);
514 }
515
516 static void clean_reg(jit_state_t *_jit,
517                 struct native_register *nreg, u8 jit_reg, bool clean)
518 {
519         /* If we get a dirty register, store back the old value */
520         if (nreg->prio == REG_IS_DIRTY) {
521                 s16 offset = offsetof(struct lightrec_state, regs.gpr)
522                         + (nreg->emulated_register << 2);
523
524                 jit_stxi_i(offset, LIGHTREC_REG_STATE, jit_reg);
525
526                 if (clean) {
527                         if (nreg->emulated_register == 0)
528                                 nreg->prio = REG_IS_ZERO;
529                         else
530                                 nreg->prio = REG_IS_LOADED;
531                 }
532         }
533 }
534
535 static void clean_regs(struct regcache *cache, jit_state_t *_jit, bool clean)
536 {
537         unsigned int i;
538
539         for (i = 0; i < NUM_REGS; i++) {
540                 clean_reg(_jit, &cache->lightrec_regs[i],
541                           JIT_V(FIRST_REG + i), clean);
542         }
543         for (i = 0; i < NUM_TEMPS; i++) {
544                 clean_reg(_jit, &cache->lightrec_regs[i + NUM_REGS],
545                                 JIT_R(FIRST_TEMP + i), clean);
546         }
547 }
548
549 void lightrec_storeback_regs(struct regcache *cache, jit_state_t *_jit)
550 {
551         clean_regs(cache, _jit, false);
552 }
553
554 void lightrec_clean_regs(struct regcache *cache, jit_state_t *_jit)
555 {
556         clean_regs(cache, _jit, true);
557 }
558
559 bool lightrec_has_dirty_regs(struct regcache *cache)
560 {
561         unsigned int i;
562
563         for (i = 0; i < NUM_REGS + NUM_TEMPS; i++)
564                 if (cache->lightrec_regs[i].prio == REG_IS_DIRTY)
565                         return true;
566
567         return false;
568 }
569
570 void lightrec_clean_reg(struct regcache *cache, jit_state_t *_jit, u8 jit_reg)
571 {
572         struct native_register *reg;
573
574         if (!lightrec_reg_is_zero(jit_reg)) {
575                 reg = lightning_reg_to_lightrec(cache, jit_reg);
576                 clean_reg(_jit, reg, jit_reg, true);
577         }
578 }
579
580 bool lightrec_reg_is_loaded(struct regcache *cache, u16 reg)
581 {
582         return !!find_mapped_reg(cache, reg, false);
583 }
584
585 void lightrec_clean_reg_if_loaded(struct regcache *cache, jit_state_t *_jit,
586                                   u16 reg, bool unload)
587 {
588         struct native_register *nreg;
589         u8 jit_reg;
590
591         nreg = find_mapped_reg(cache, reg, false);
592         if (nreg) {
593                 jit_reg = lightrec_reg_to_lightning(cache, nreg);
594
595                 if (unload)
596                         lightrec_unload_nreg(cache, _jit, nreg, jit_reg);
597                 else
598                         clean_reg(_jit, nreg, jit_reg, true);
599         }
600 }
601
602 void lightrec_discard_reg_if_loaded(struct regcache *cache, u16 reg)
603 {
604         struct native_register *nreg;
605
606         nreg = find_mapped_reg(cache, reg, false);
607         if (nreg)
608                 lightrec_discard_nreg(nreg);
609 }
610
611 struct native_register * lightrec_regcache_enter_branch(struct regcache *cache)
612 {
613         struct native_register *backup;
614
615         backup = lightrec_malloc(cache->state, MEM_FOR_LIGHTREC,
616                                  sizeof(cache->lightrec_regs));
617         memcpy(backup, &cache->lightrec_regs, sizeof(cache->lightrec_regs));
618
619         return backup;
620 }
621
622 void lightrec_regcache_leave_branch(struct regcache *cache,
623                         struct native_register *regs)
624 {
625         memcpy(&cache->lightrec_regs, regs, sizeof(cache->lightrec_regs));
626         lightrec_free(cache->state, MEM_FOR_LIGHTREC,
627                       sizeof(cache->lightrec_regs), regs);
628 }
629
630 void lightrec_regcache_reset(struct regcache *cache)
631 {
632         memset(&cache->lightrec_regs, 0, sizeof(cache->lightrec_regs));
633 }
634
635 void lightrec_preload_pc(struct regcache *cache)
636 {
637         struct native_register *nreg;
638
639         /* The block's PC is loaded in JIT_V0 at the start of the block */
640         nreg = lightning_reg_to_lightrec(cache, JIT_V0);
641         nreg->emulated_register = REG_PC;
642         nreg->prio = REG_IS_LOADED;
643         nreg->zero_extended = true;
644 }
645
646 struct regcache * lightrec_regcache_init(struct lightrec_state *state)
647 {
648         struct regcache *cache;
649
650         cache = lightrec_calloc(state, MEM_FOR_LIGHTREC, sizeof(*cache));
651         if (!cache)
652                 return NULL;
653
654         cache->state = state;
655
656         return cache;
657 }
658
659 void lightrec_free_regcache(struct regcache *cache)
660 {
661         return lightrec_free(cache->state, MEM_FOR_LIGHTREC,
662                              sizeof(*cache), cache);
663 }
664
665 void lightrec_regcache_mark_live(struct regcache *cache, jit_state_t *_jit)
666 {
667         struct native_register *nreg;
668         unsigned int i;
669
670 #ifdef _WIN32
671         /* FIXME: GNU Lightning on Windows seems to use our mapped registers as
672          * temporaries. Until the actual bug is found and fixed, unconditionally
673          * mark our registers as live here. */
674         for (i = 0; i < NUM_REGS; i++) {
675                 nreg = &cache->lightrec_regs[i];
676
677                 if (nreg->used || nreg->prio > REG_IS_TEMP)
678                         jit_live(JIT_V(FIRST_REG + i));
679         }
680 #endif
681
682         for (i = 0; i < NUM_TEMPS; i++) {
683                 nreg = &cache->lightrec_regs[NUM_REGS + i];
684
685                 if (nreg->used || nreg->prio > REG_IS_TEMP)
686                         jit_live(JIT_R(FIRST_TEMP + i));
687         }
688
689         jit_live(LIGHTREC_REG_STATE);
690         jit_live(LIGHTREC_REG_CYCLE);
691 }