Merge pull request #78 from Decompollaborate/develop

1.13.0

Author: AngheloAlf

CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.13.0] - 2025-04-04
+
+### Added
+
+- Add support for a few missing R5900 instructions.
+  - `cfc2.i`, `ctc2.i`, `qmfc2.i` and `qmtc2.i`.
+
+### Changed
+
+- Change some R5900 opcodes to use their suffix.
+  - Specifically `cfc2`, `ctc2`, `qmfc2` and `qmtc2` are changed to `cfc2.ni`,
+    `ctc2.ni`, `qmfc2.ni` and `qmtc2.ni`.
+
+### Fixed
+
+- Allow building Python bindings with Clang versions that do not support some
+  some warning flags.
+  - Specifically `-Wno-nonnull-compare`.
+
 ## [1.12.6] - 2025-02-06
 
 ### Fixed
@@ -709,6 +728,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - First version
 
 [unreleased]: https://github.com/Decompollaborate/rabbitizer/compare/master...develop
+[1.13.0]: https://github.com/Decompollaborate/rabbitizer/compare/1.12.6...1.13.0
 [1.12.6]: https://github.com/Decompollaborate/rabbitizer/compare/1.12.5...1.12.6
 [1.12.5]: https://github.com/Decompollaborate/rabbitizer/compare/1.12.4...1.12.5
 [1.12.4]: https://github.com/Decompollaborate/rabbitizer/compare/1.12.3...1.12.4

Cargo.lock

@@ -4,7 +4,7 @@
 [package]
 name = "rabbitizer"
 # Version should be synced with include/common/RabbitizerVersion.h
-version = "1.12.6"
+version = "1.13.0"
 edition = "2021"
 authors = ["Anghelo Carvajal <angheloalf95@gmail.com>"]
 description = "MIPS instruction decoder"

Cargo.toml

@@ -69,7 +69,7 @@ If you use a `requirements.txt` file in your repository, then you can add this
 library with the following line:
 
 ```txt
-rabbitizer>=1.12.5,<2.0.0
+rabbitizer>=1.13.0,<2.0.0
 ```
 
 ### Development version
@@ -109,7 +109,7 @@ cargo add rabbitizer
 Or you can add it manually to your `Cargo.toml`:
 
 ```toml
-rabbitizer = "1.12.6"
+rabbitizer = "1.13.0"
 ```
 
 See this crate at <https://crates.io/crates/rabbitizer>.

README.md

@@ -13,8 +13,8 @@ extern "C" {
 
 // Header version
 #define RAB_VERSION_MAJOR 1
-#define RAB_VERSION_MINOR 12
-#define RAB_VERSION_PATCH 6
+#define RAB_VERSION_MINOR 13
+#define RAB_VERSION_PATCH 0
 
 #define RAB_VERSION_STR RAB_STRINGIFY(RAB_VERSION_MAJOR) "." RAB_STRINGIFY(RAB_VERSION_MINOR) "." RAB_STRINGIFY(RAB_VERSION_PATCH)
 

cplusplus/include/generated/UniqueId_enum_class.hpp

@@ -12,7 +12,7 @@ extern "C" {
 #endif
 
 
-#define RAB_INSTR_R5900_GET_cop2_highbit(self)          (SHIFTR((self)->word, 25,  1))
+#define RAB_INSTR_R5900_GET_cop2_highlowbit(self)       ((SHIFTR((self)->word, 25,  1) << 1) | SHIFTR((self)->word, 0,  1))
 #define RAB_INSTR_R5900_GET_cop2_nohighbit_fmt(self)    (SHIFTR((self)->word, 21,  4))
 
 #define RAB_INSTR_R5900_GET_mmi_function(self)          (SHIFTR((self)->word,  6,  5))
@@ -39,7 +39,7 @@ extern "C" {
 #define RAB_INSTR_R5900_GET_imm15(self)                 (SHIFTR((self)->word,  6, 15))
 
 
-#define RAB_INSTR_R5900_PACK_cop2_highbit(word, value)  (BITREPACK((word), (value), 25,  1))
+#define RAB_INSTR_R5900_PACK_cop2_highlowbit(word, value)  (BITREPACK(BITREPACK((word), (value) >> 1, 25,  1), (value),  0,  1))
 #define RAB_INSTR_R5900_PACK_cop2_nohighbit_fmt(word, value)    (BITREPACK((word), (value), 21,  4))
 
 #define RAB_INSTR_R5900_PACK_mmi_function(word, value)  (BITREPACK((word), (value),  6,  5))

include/common/RabbitizerVersion.h

@@ -4,7 +4,7 @@
 [project]
 name = "rabbitizer"
 # Version should be synced with include/common/RabbitizerVersion.h
-version = "1.12.6"
+version = "1.13.0"
 description = "MIPS instruction decoder"
 # license = "MIT"
 readme = "README.md"

include/generated/InstrDescriptor_Descriptors_array.h

@@ -13,6 +13,7 @@
 
 extraCompileArgs = ["-std=c11", "-Wall", "-g",]
 if platform.system() == "Linux":
+    extraCompileArgs += ["-Wno-unknown-warning-option",]
     extraCompileArgs += ["-Os", "-Wextra",]
     extraCompileArgs += ["-Werror=vla", "-Werror=switch", "-Werror=implicit-fallthrough", "-Werror=unused-function", "-Werror=unused-parameter", "-Werror=shadow", "-Werror=switch"]
     extraCompileArgs += ["-Werror=implicit-function-declaration", "-Werror=incompatible-pointer-types"]

include/generated/InstrId_Names_array.h

@@ -222,14 +222,29 @@ void RabbitizerInstructionR5900_processUniqueId_Coprocessor2_Special1(Rabbitizer
     }
 }
 
-void RabbitizerInstructionR5900_processUniqueId_Coprocessor2_nohighbit(RabbitizerInstruction *self) {
+void RabbitizerInstructionR5900_processUniqueId_Coprocessor2_ni(RabbitizerInstruction *self) {
     uint8_t fmt = RAB_INSTR_R5900_GET_cop2_nohighbit_fmt(self);
 
     self->_mandatorybits = RAB_INSTR_R5900_PACK_cop2_nohighbit_fmt(self->_mandatorybits, fmt);
     self->instrIdType = RAB_INSTR_ID_TYPE_R5900_COP2_NOHIGHBIT;
 
     switch (fmt) {
-#include "tables/instr_id/r5900/r5900_cop2.inc"
+#include "tables/instr_id/r5900/r5900_cop2_ni.inc"
+
+        case 0x08:
+            RabbitizerInstruction_processUniqueId_Coprocessor2_BC2(self);
+            break;
+    }
+}
+
+void RabbitizerInstructionR5900_processUniqueId_Coprocessor2_i(RabbitizerInstruction *self) {
+    uint8_t fmt = RAB_INSTR_R5900_GET_cop2_nohighbit_fmt(self);
+
+    self->_mandatorybits = RAB_INSTR_R5900_PACK_cop2_nohighbit_fmt(self->_mandatorybits, fmt);
+    self->instrIdType = RAB_INSTR_ID_TYPE_R5900_COP2_NOHIGHBIT;
+
+    switch (fmt) {
+#include "tables/instr_id/r5900/r5900_cop2_i.inc"
 
         case 0x08:
             RabbitizerInstruction_processUniqueId_Coprocessor2_BC2(self);
@@ -238,17 +253,22 @@ void RabbitizerInstructionR5900_processUniqueId_Coprocessor2_nohighbit(Rabbitize
 }
 
 void RabbitizerInstructionR5900_processUniqueId_Coprocessor2(RabbitizerInstruction *self) {
-    uint8_t fmt = RAB_INSTR_R5900_GET_cop2_highbit(self);
+    uint8_t fmt = RAB_INSTR_R5900_GET_cop2_highlowbit(self);
 
-    self->_mandatorybits = RAB_INSTR_R5900_PACK_cop2_highbit(self->_mandatorybits, fmt);
+    self->_mandatorybits = RAB_INSTR_R5900_PACK_cop2_highlowbit(self->_mandatorybits, fmt);
     self->instrIdType = RAB_INSTR_ID_TYPE_R5900_COP2;
 
     switch (fmt) {
         case 0x00:
-            RabbitizerInstructionR5900_processUniqueId_Coprocessor2_nohighbit(self);
+            RabbitizerInstructionR5900_processUniqueId_Coprocessor2_ni(self);
             break;
 
         case 0x01:
+            RabbitizerInstructionR5900_processUniqueId_Coprocessor2_i(self);
+            break;
+
+        case 0x02:
+        case 0x03:
             RabbitizerInstructionR5900_processUniqueId_Coprocessor2_Special1(self);
             break;
     }

include/generated/InstrId_enum.h

@@ -23,7 +23,8 @@
 
     #include "r5900/r5900_cop1_fpu_s.inc"
 
-    #include "r5900/r5900_cop2.inc"
+    #include "r5900/r5900_cop2_ni.inc"
+    #include "r5900/r5900_cop2_i.inc"
     #include "r5900/r5900_cop2_bc2.inc"
     #include "r5900/r5900_cop2_special1.inc"
     #include "r5900/r5900_cop2_special2.inc"

include/instructions/RabbitizerInstructionR5900.h

@@ -1,12 +1,12 @@
-/* SPDX-FileCopyrightText: © 2022-2024 Decompollaborate */
+/* SPDX-FileCopyrightText: © 2025 Decompollaborate */
 /* SPDX-License-Identifier: MIT */
 
 /*
-    31--------26-25------21 ----------------------------------------0
-    |  = COP2   |   fmt   |                                         |
-    ------6----------5-----------------------------------------------
+    31--------26-25------21 --------------------------------------1-0
+    |  = COP2   |   fmt   |                                       |1|
+    ------6----------5---------------------------------------------1-
     |--000--|--001--|--010--|--011--|--100--|--101--|--110--|--111--| lo
- 00 | ---   | QMFC2 | CFC2  | ---   | ---   | QMTC2 | CTC2  | ---   |
+ 00 | ---   |QMFC2.I| CFC2.I| ---   | ---   |QMTC2.I| CTC2.I| ---   |
  01 | *1    | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
  10 | *2    | *2    | *2    | *2    | *2    | *2    | *2    | *2    |
  11 | *2    | *2    | *2    | *2    | *2    | *2    | *2    | *2    |
@@ -15,23 +15,23 @@
 */
 
     // TODO: properties
-    RABBITIZER_DEF_INSTR_ID(
-        r5900, 0x01, qmfc2,
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x01, qmfc2_i, qmfc2.i,
         .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vfs},
         .modifiesRt=true
     )
-    RABBITIZER_DEF_INSTR_ID(
-        r5900, 0x02, cfc2,
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x02, cfc2_i, cfc2.i,
         .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vis},
         .modifiesRt=true
     )
-    RABBITIZER_DEF_INSTR_ID(
-        r5900, 0x05, qmtc2,
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x05, qmtc2_i, qmtc2.i,
         .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vfs},
         .readsRt=true
     )
-    RABBITIZER_DEF_INSTR_ID(
-        r5900, 0x06, ctc2,
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x06, ctc2_i, ctc2.i,
         .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vis},
         .readsRt=true
     )

pyproject.toml

@@ -0,0 +1,37 @@
+/* SPDX-FileCopyrightText: © 2025 Decompollaborate */
+/* SPDX-License-Identifier: MIT */
+
+/*
+    31--------26-25------21 --------------------------------------1-0
+    |  = COP2   |   fmt   |                                       |0|
+    ------6----------5---------------------------------------------1-
+    |--000--|--001--|--010--|--011--|--100--|--101--|--110--|--111--| lo
+ 00 | ---   |QMFC2.NI|CFC2.NI| ---  | ---   |QMTC2.NI|CTC2.NI| ---  |
+ 01 | *1    | ---   | ---   | ---   | ---   | ---   | ---   | ---   |
+ 10 | *2    | *2    | *2    | *2    | *2    | *2    | *2    | *2    |
+ 11 | *2    | *2    | *2    | *2    | *2    | *2    | *2    | *2    |
+ hi |-------|-------|-------|-------|-------|-------|-------|-------|
+     *1 = BC instructions, see BC2 list   *2 =see special1 table
+*/
+
+    // TODO: properties
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x01, qmfc2_ni, qmfc2.ni,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vfs},
+        .modifiesRt=true
+    )
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x02, cfc2_ni, cfc2.ni,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vis},
+        .modifiesRt=true
+    )
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x05, qmtc2_ni, qmtc2.ni,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vfs},
+        .readsRt=true
+    )
+    RABBITIZER_DEF_INSTR_ID_ALTNAME(
+        r5900, 0x06, ctc2_ni, ctc2.ni,
+        .operands={RAB_OPERAND_cpu_rt, RAB_OPERAND_r5900_vis},
+        .readsRt=true
+    )

rabbitizer/InstrId.pyi

@@ -42,6 +42,9 @@ const TestEntry test_entries[] = {
     TEST_ENTRY_C(0x4A220BFF, NULL, "viswr.w     $vi2, ($vi1)"),
 
     TEST_ENTRY_C(0x4A0307B2, NULL, "viaddi      $vi3, $vi0, -0x2"),
+
+    TEST_ENTRY_C(0x48500800, NULL, "cfc2.ni     $s0, $vi1"),
+    TEST_ENTRY_C(0x48500801, NULL, "cfc2.i      $s0, $vi1"),
 };
 
 size_t test_entries_len = ARRAY_COUNT(test_entries);