rabbitizer/include/instructions/RabbitizerRegisterDescriptor.h
Anghelo Carvajal b51b62da45
ALLEGREX support (#60)
* setup ALLEGREX

* more setup

* clo

* fix

* Implement SPECIAL_RS and SPECIAL_SA instructions

* more table placeholders

* Implement bshfl instructions

* Rename to R4000Allegrex

* Implement SPECIAL instructions

* Add tests

* Remove some duplicated tests

* Implement SPECIAL3 instructions

* fix bug in test

* update

* Implement COPz

* Implement SPECIAL2 instructions

* Implement COP1

* Yeet cop3

* som tests

* bvf, bvfl, bvt, bvtl

* fix bshfl prefix

* need to implement the vfpu registers

* implement vt_7?

* R4000AllegrexVF -> R4000AllegrexVScalar

* Add test suite to compare with the sn toolchain decoding

* more vfpu test cases

* forgor this

* I can't decide how to name these registers

* Prepare tables for all register types

* Fix typo

* Implement vector scalar register operands

* Implement quad registers

* Fix tests?

* svl.q, svr.q

* Implement a bunch of vfpu0 instructions

* implement registers for `.t` and `.p` instructions

* Implement VFPU1 instructions

* bleh

* VFPU1, VFPU3 and `vcmp.`

* Fix wrong register type on some instructions

* start vfpu3

* Implement VFPU3 instructions

* start categorizing VFPU4

* Categorize VFPU5

* VFPU6 identification

* Identify VFPU7

* COP2 is weird

* organize COP2 a bit

* Add test cases for VFPU4 FMT

* VFPU4 FMT2 stuff

* VFPU4 FMT3 stuff

* VFPU5 stuff

* VFPU6 stuff

* VFPU7 stuff

* Implement COP2 instructions

* Implement vmov, vabs and vneg

* VPFU4 FMT0 FMT0 FMT0 implemented

* VFPU FMT0 FMT0 FMT2

* vnrcp, vnsin, vrexp2

* vrnds, vrndi, vrndf1, vrndf2

* Change tests a bit

* vf2h, vh2f, vsbz, vlgb

* vuc2ifs, vc2i, vus2i, vs2i, vi2uc, vi2c, vi2us, vi2s

* vsrt1, vsrt2, vbfy1, vbfy2, vocp, vsocp, vfad, vavg

* vsrt3, vsrt4, vsgn

* vmfvc and vmtvc placeholders

* vt4444, vt5551, vt5650

* vcst placeholder

* vf2in

* vf2iz

* vf2iu, vf2id, vi2f

* vcmovt, vcmovf

* vwbn.s, viim.s, vfim.s

* vpfxs, vpfxt, vpfxd, vnop, vsync, vflush

* vmmov, vmidt, vmzero, vmone

* vrot

* vmmul, vhtfm2, vtfm2, vhtfm3, vtfm3, vhtfm4, vtfm4, vmscl, vcrsp, vqmul

* Implement matrix operands

* fix matrix operands

* Fix `illegal` tests

* hack out a way to check the test cases are assemblable

* test-fixing: branches

* fix more test cases

* fix vmfvc and vmtvc

* more test fixing

* vdiv and fix operand R323

* more test fixing

* Fix matrix operands

* implement vcmp comparisons

* fix vsync2

* vsqrt and vrndf1 fixes

* Implement "constant" operand for `vcst`

* Add missing operand of vf2in, vf2iz, vf2iu, vf2id, vi2f

* Add missing vcmovt and vcmovf operands

* Add missing vwbn operand

* Tests cases for vmmul

* Fix vtfm2

* Implement "transpose matrix register"

* Add placeholders for the remaining missing operands

* Implement viim operand

* Implement vrot code operand

* placeholders for rp and wp operands

* test cases for vpfxs, vpfxt and vpfxd

* Properly implement rpx, rpy, rpz and rpw

* Properly implement wpx, wpy, wpz and wpw operands

* Implement vfim

* changelog

* readme

* some cleanup

* Restructure some tables

* more table restructure

* fix tests

* more table yeeting

* more cleanup

* more cleanup

* reanming

* moar

* fmt
2024-04-22 13:15:58 -04:00

107 lines
4.5 KiB
C

/* SPDX-FileCopyrightText: © 2022-2024 Decompollaborate */
/* SPDX-License-Identifier: MIT */
#ifndef RABBITIZER_REGISTERDESCRIPTOR_H
#define RABBITIZER_REGISTERDESCRIPTOR_H
#pragma once
#include <stdbool.h>
#include "common/Utils.h"
#ifdef __cplusplus
extern "C" {
#endif
// Please note the members of this struct may be renamed or removed without further notice.
// For consistent usage please use the functions instead
typedef struct RabbitizerRegisterDescriptor {
bool isClobberedByFuncCall; // A function call invalidates the value hold by the register
bool isReserved; // This register is not implemented and is reserved for future use
bool isKernel; // Kernel-only registers ($k0, $k1)
bool isZero; // $zero
bool isAt; // $at
bool isReturnReg; // $v0, $v1
bool isRa; // $ra
bool isStackPointer; // $sp
bool isGp; // $gp
bool isTemp; // $tX
bool isArg; // $aX
bool isSaved; // $sX
} RabbitizerRegisterDescriptor;
extern const RabbitizerRegisterDescriptor RabbitizerRegister_GprO32_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_GprN32_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop0_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop1O32_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop1N32_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop1N64_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop1Control_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_Cop2_Descriptors[];
/* RSP */
extern const RabbitizerRegisterDescriptor RabbitizerRegister_RspGpr_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_RspCop0_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_RspCop2_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_RspCop2Control_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_RspVector_Descriptors[];
/* RSP */
/* R4000ALLEGREX */
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexS_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexV2D_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexV3D_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexV4D_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexM2x2_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexM3x3_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexM4x4_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexVfpuControl_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R4000AllegrexVConstant_Descriptors[];
/* R4000ALLEGREX */
/* R5900 */
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R5900VF_Descriptors[];
extern const RabbitizerRegisterDescriptor RabbitizerRegister_R5900VI_Descriptors[];
/* R5900 */
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isClobberedByFuncCall(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isReserved(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isKernel(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isZero(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isAt(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isReturnReg(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isRa(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isStackPointer(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isGp(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isTemp(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isArg(const RabbitizerRegisterDescriptor *self);
NODISCARD NON_NULL(1) PURE
bool RabbitizerRegisterDescriptor_isSaved(const RabbitizerRegisterDescriptor *self);
#ifdef __cplusplus
}
#endif
#endif