Implement SPECIAL3 instructions

Decompollaborate · Apr 11, 2024 · c3cce0e · c3cce0e
1 parent 8b81f55
commit c3cce0e
Show file tree

Hide file tree

Showing 21 changed files with 175 additions and 2 deletions.
diff --git a/cplusplus/include/generated/OperandType_enum_class.hpp b/cplusplus/include/generated/OperandType_enum_class.hpp
diff --git a/cplusplus/include/generated/UniqueId_enum_class.hpp b/cplusplus/include/generated/UniqueId_enum_class.hpp
diff --git a/cplusplus/include/instructions/InstructionR4000Allegrex.hpp b/cplusplus/include/instructions/InstructionR4000Allegrex.hpp
@@ -13,6 +13,10 @@ namespace rabbitizer {
     public:
         InstructionR4000Allegrex(uint32_t word, uint32_t vram);
         virtual ~InstructionR4000Allegrex();
+
+        uint8_t GetR4000Allegrex_pos() const;
+        uint8_t GetR4000Allegrex_size() const;
+        uint8_t GetR4000Allegrex_size_plus_pos() const;
     };
 };
 

diff --git a/cplusplus/src/instructions/InstructionR4000Allegrex.cpp b/cplusplus/src/instructions/InstructionR4000Allegrex.cpp
@@ -17,3 +17,13 @@ InstructionR4000Allegrex::InstructionR4000Allegrex(uint32_t word, uint32_t vram)
 InstructionR4000Allegrex::~InstructionR4000Allegrex() {
     RabbitizerInstructionR4000Allegrex_destroy(&this->instr);
 }
+
+uint8_t InstructionR4000Allegrex::GetR4000Allegrex_pos() const {
+    return RAB_INSTR_R4000ALLEGREX_GET_pos(&this->instr);
+}
+uint8_t InstructionR4000Allegrex::GetR4000Allegrex_size() const {
+    return RAB_INSTR_R4000ALLEGREX_GET_size(&this->instr);
+}
+uint8_t InstructionR4000Allegrex::GetR4000Allegrex_size_plus_pos() const {
+    return RAB_INSTR_R4000ALLEGREX_GET_size_plus_pos(&this->instr);
+}
diff --git a/include/generated/InstrDescriptor_Descriptors_array.h b/include/generated/InstrDescriptor_Descriptors_array.h
diff --git a/include/generated/InstrId_Names_array.h b/include/generated/InstrId_Names_array.h
diff --git a/include/generated/InstrId_enum.h b/include/generated/InstrId_enum.h
diff --git a/include/generated/OperandType_enum.h b/include/generated/OperandType_enum.h
diff --git a/include/generated/OperandType_function_declarations.h b/include/generated/OperandType_function_declarations.h
diff --git a/include/generated/instrOpercandCallbacks_array.h b/include/generated/instrOpercandCallbacks_array.h
diff --git a/include/instructions/RabbitizerInstructionR4000Allegrex.h b/include/instructions/RabbitizerInstructionR4000Allegrex.h
@@ -12,6 +12,16 @@ extern "C" {
 #endif
 
 
+#define RAB_INSTR_R4000ALLEGREX_GET_pos(self)                       (SHIFTR((self)->word,  6,  5))
+#define RAB_INSTR_R4000ALLEGREX_GET_size(self)                      (SHIFTR((self)->word, 11,  5))
+#define RAB_INSTR_R4000ALLEGREX_GET_size_plus_pos(self)             (SHIFTR((self)->word, 11,  5))
+
+
+#define RAB_INSTR_R4000ALLEGREX_PACK_pos(word, value)               (BITREPACK((word), (value),  6,  5))
+#define RAB_INSTR_R4000ALLEGREX_PACK_size(word, value)              (BITREPACK((word), (value), 11,  5))
+#define RAB_INSTR_R4000ALLEGREX_PACK_size_plus_pos(word, value)     (BITREPACK((word), (value), 11,  5))
+
+
 NON_NULL(1)
 void RabbitizerInstructionR4000Allegrex_init(RabbitizerInstruction *self, uint32_t word, uint32_t vram);
 NON_NULL(1)

diff --git a/rabbitizer/InstrId.pyi b/rabbitizer/InstrId.pyi
diff --git a/rabbitizer/OperandType.pyi b/rabbitizer/OperandType.pyi
diff --git a/rust/src/instr_id_enum.rs b/rust/src/instr_id_enum.rs
diff --git a/rust/src/operand_type_enum.rs b/rust/src/operand_type_enum.rs
diff --git a/src/instructions/RabbitizerInstrDescriptor.c b/src/instructions/RabbitizerInstrDescriptor.c
@@ -264,6 +264,13 @@ bool RabbitizerInstrDescriptor_hasOperandAlias(const RabbitizerInstrDescriptor *
             break;
             /* r3000gte */
 
+            /* r4000allegrex */
+        case RAB_OPERAND_r4000allegrex_pos:
+        case RAB_OPERAND_r4000allegrex_size:
+        case RAB_OPERAND_r4000allegrex_size_plus_pos:
+            break;
+            /* r4000allegrex */
+
             /* r5900 */
         case RAB_OPERAND_r5900_I:
         case RAB_OPERAND_r5900_Q:

diff --git a/src/instructions/RabbitizerInstruction/RabbitizerInstruction.c b/src/instructions/RabbitizerInstruction/RabbitizerInstruction.c
@@ -9,6 +9,7 @@
 #include "instructions/RabbitizerRegister.h"
 #include "instructions/RabbitizerInstructionRsp.h"
 #include "instructions/RabbitizerInstructionR3000GTE.h"
+#include "instructions/RabbitizerInstructionR4000Allegrex.h"
 #include "instructions/RabbitizerInstructionR5900.h"
 
 void RabbitizerInstruction_init(RabbitizerInstruction *self, uint32_t word, uint32_t vram) {
@@ -355,6 +356,20 @@ void RabbitizerInstruction_blankOut(RabbitizerInstruction *self) {
                 break;
             /* r3000gte */
 
+            /* r4000allegrex */
+            case RAB_OPERAND_r4000allegrex_pos:
+                self->word = RAB_INSTR_R4000ALLEGREX_PACK_pos(self->word, 0);
+                break;
+
+            case RAB_OPERAND_r4000allegrex_size:
+                self->word = RAB_INSTR_R4000ALLEGREX_PACK_size(self->word, 0);
+                break;
+
+            case RAB_OPERAND_r4000allegrex_size_plus_pos:
+                self->word = RAB_INSTR_R4000ALLEGREX_PACK_size_plus_pos(self->word, 0);
+                break;
+            /* r4000allegrex */
+
             /* r5900 */
             case RAB_OPERAND_r5900_I:
             case RAB_OPERAND_r5900_Q:

diff --git a/src/instructions/RabbitizerInstruction/RabbitizerInstruction_Examination.c b/src/instructions/RabbitizerInstruction/RabbitizerInstruction_Examination.c
@@ -8,6 +8,7 @@
 #include "common/RabbitizerConfig.h"
 #include "instructions/RabbitizerInstructionRsp.h"
 #include "instructions/RabbitizerInstructionR3000GTE.h"
+#include "instructions/RabbitizerInstructionR4000Allegrex.h"
 #include "instructions/RabbitizerInstructionR5900.h"
 #include "instructions/RabbitizerRegister.h"
 
@@ -401,6 +402,20 @@ uint32_t RabbitizerInstruction_getValidBits(const RabbitizerInstruction *self) {
                 break;
             /* r3000gte */
 
+            /* r4000allegrex */
+            case RAB_OPERAND_r4000allegrex_pos:
+                validbits = RAB_INSTR_R4000ALLEGREX_PACK_pos(validbits, ~0);
+                break;
+
+            case RAB_OPERAND_r4000allegrex_size:
+                validbits = RAB_INSTR_R4000ALLEGREX_PACK_size(validbits, ~0);
+                break;
+
+            case RAB_OPERAND_r4000allegrex_size_plus_pos:
+                validbits = RAB_INSTR_R4000ALLEGREX_PACK_size_plus_pos(validbits, ~0);
+                break;
+            /* r4000allegrex */
+
             /* r5900 */
             case RAB_OPERAND_r5900_I:
             case RAB_OPERAND_r5900_Q:

diff --git a/...tions/RabbitizerInstructionR4000Allegrex/RabbitizerInstructionR4000Allegrex_OperandType.c b/...tions/RabbitizerInstructionR4000Allegrex/RabbitizerInstructionR4000Allegrex_OperandType.c
@@ -2,3 +2,65 @@
 /* SPDX-License-Identifier: MIT */
 
 #include "instructions/RabbitizerInstructionR4000Allegrex.h"
+
+#include <assert.h>
+#include <string.h>
+#include <stdio.h>
+
+#include "common/Utils.h"
+#include "common/RabbitizerConfig.h"
+#include "instructions/RabbitizerRegister.h"
+
+size_t RabbitizerOperandType_process_r4000allegrex_pos(const RabbitizerInstruction *self, char *dst,
+                                                       UNUSED const char *immOverride,
+                                                       UNUSED size_t immOverrideLength) {
+    size_t totalSize = 0;
+    uint32_t temp = RAB_INSTR_R4000ALLEGREX_GET_pos(self);
+
+// TODO: consider making this a proper configuration
+#if 0
+    if (temp < 10) {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    } else {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "0x%x", temp);
+    }
+#endif
+    RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    return totalSize;
+}
+
+size_t RabbitizerOperandType_process_r4000allegrex_size(const RabbitizerInstruction *self, char *dst,
+                                                        UNUSED const char *immOverride,
+                                                        UNUSED size_t immOverrideLength) {
+    size_t totalSize = 0;
+    uint32_t temp = RAB_INSTR_R4000ALLEGREX_GET_size(self) + 1;
+
+// TODO: consider making this a proper configuration
+#if 0
+    if (temp < 10) {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    } else {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "0x%x", temp);
+    }
+#endif
+    RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    return totalSize;
+}
+
+size_t RabbitizerOperandType_process_r4000allegrex_size_plus_pos(const RabbitizerInstruction *self, char *dst,
+                                                                 UNUSED const char *immOverride,
+                                                                 UNUSED size_t immOverrideLength) {
+    size_t totalSize = 0;
+    uint32_t temp = RAB_INSTR_R4000ALLEGREX_GET_size_plus_pos(self) + 1 - RAB_INSTR_R4000ALLEGREX_GET_pos(self);
+
+// TODO: consider making this a proper configuration
+#if 0
+    if (temp < 10) {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    } else {
+        RABUTILS_BUFFER_SPRINTF(dst, totalSize, "0x%x", temp);
+    }
+#endif
+    RABUTILS_BUFFER_SPRINTF(dst, totalSize, "%i", temp);
+    return totalSize;
+}
diff --git a/tables/tables/instr_id/r4000allegrex/r4000allegrex_special3.inc b/tables/tables/instr_id/r4000allegrex/r4000allegrex_special3.inc
@@ -6,7 +6,7 @@
     | = SPECIAL |                                         | function|
     ------6----------------------------------------------------6-----
     |--000--|--001--|--010--|--011--|--100--|--101--|--110--|--111--| lo
-000 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
+000 | EXT   | ---   | ---   | ---   | INS   | ---   | ---   | ---   |
 001 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
 010 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
 011 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
@@ -15,5 +15,21 @@
 110 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
 111 | ---   | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
  hi |-------|-------|-------|-------|-------|-------|-------|-------|
-     *1 = SPECIAL3 BSHFL, see SPECIAL BSHFL list
+     *1 = SPECIAL3 BSHFL
 */
+
+    RABBITIZER_DEF_INSTR_ID(
+        r4000allegrex, 0x00, ext,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_cpu_rs, RAB_OPERAND_r4000allegrex_pos, RAB_OPERAND_r4000allegrex_size},
+        .instrType=RABBITIZER_INSTR_TYPE_R,
+        .modifiesRt=true,
+        .readsRs=true
+    ) // EXTract bit field
+
+    RABBITIZER_DEF_INSTR_ID(
+        r4000allegrex, 0x04, ins,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_cpu_rs, RAB_OPERAND_r4000allegrex_pos, RAB_OPERAND_r4000allegrex_size_plus_pos},
+        .instrType=RABBITIZER_INSTR_TYPE_R,
+        .modifiesRt=true,
+        .readsRs=true
+    ) // INSert bit field
diff --git a/tables/tables/operands/RabbitizerOperandType_r4000allegrex.inc b/tables/tables/operands/RabbitizerOperandType_r4000allegrex.inc
@@ -1,2 +1,6 @@
 /* SPDX-FileCopyrightText: © 2024 Decompollaborate */
 /* SPDX-License-Identifier: MIT */
+
+    RAB_DEF_OPERAND(r4000allegrex, pos)
+    RAB_DEF_OPERAND(r4000allegrex, size)
+    RAB_DEF_OPERAND(r4000allegrex, size_plus_pos)