Solution to build most splits using SN alternative assembler

Now most of the project splits can be built using the actual assembler used by the game by passing `-sn_as/--sn_assembler` on `configure.py` when building the game as matching, also capped Spimdisasm version as last version broke matching building for some reason

As always big shout out to the big @Mc-muffin for helping with this solution

Author: IWILLCRAFT-M0d

configs/sym.txt

@@ -6,6 +6,41 @@ D_0045345C = 0x0045345c; // type:s32
 D_004534C8 = 0x004534c8; // type:s32
 D_004534CC = 0x004534cc; // type:s32 size:8
 D_004537F0 = 0x004537f0; // type:s32
+D_00453282 = 0x00453282;
+D_00453284 = 0x00453284;
+D_00453286 = 0x00453286;
+D_00453288 = 0x00453288;
+D_0045328A = 0x0045328A;
+D_0045328C = 0x0045328C;
+D_0045328E = 0x0045328E;
+
+
+func_001F9CD0 = 0x001F9CD0; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00234A28 = 0x00234A28; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00147650 = 0x00147650; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00110A08 = 0x00110A08; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_001134A0 = 0x001134A0; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00113B10 = 0x00113B10; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00116250 = 0x00116250; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_0017A110 = 0x0017A110; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00131970 = 0x00131970; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00169B38 = 0x00169B38; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_001E86F8 = 0x001E86F8; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_00104DA0 = 0x00104DA0; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_0017EBF8 = 0x0017EBF8; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002EAD28 = 0x002EAD28; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002EA480 = 0x002EA480; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002EBFC8 = 0x002EBFC8; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002EB508 = 0x002EB508; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002EB958 = 0x002EB958; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002E3E60 = 0x002E3E60; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002E1680 = 0x002E1680; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+func_002886B0 = 0x002886B0; // note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
+
+
+
+
+
 
 // Functions
 entry = 0x00100008; // type:func
@@ -1377,7 +1412,7 @@ _$_14LegIKAnimation = 0x002E15B8; // type:func
 _$_21IKSingleStepAnimation = 0x002E27E8; // type:func
 _$_17IKAmblerAnimation = 0x002E3C78; // type:func
 _$_17TurnFlexAnimation = 0x002E5550; // type:func
-func_002E55A8__17TurnFlexAnimation = 0x002E55A8; // type:func
+func_002E55A8__17TurnFlexAnimation = 0x002E55A8; // type:func note - function noted in `PROBLEMATIC_FUNCS` list at `configure.py`
 __tf19WalkingBobAnimation = 0x002e5e70;
 __tf22WalkingParamsAnimation = 0x002E5F20;
 _$_23AnimVarWalkingAnimation = 0x002E5F70; // type:func

configure.py

@@ -70,6 +70,13 @@
     "src/text_00310BE8.cpp"
 ]
 
+UNCOMPATIBLE_SN_AS_SPLITS = [
+    "src/text_002421F8.cpp",
+    "src/text_0031FC50.cpp",
+    "src/text_00330930.cpp",
+    "src/text_00334BD0.cpp"
+]
+
 COMPLETED_SPLITS = [
 ]
 
@@ -96,7 +103,7 @@ def clean():
     shutil.rmtree("target", ignore_errors=True)
     shutil.rmtree(BUILD_DIR, ignore_errors=True)
 
-def ninja_build(linker_entries: List[LinkerEntry], objdiff_mode: bool, skip_checksum: bool):
+def ninja_build(linker_entries: List[LinkerEntry], objdiff_mode: bool, skip_checksum: bool, use_sn_as: bool = False):
 
     if objdiff_mode:
         ninja_file             = ninja_syntax.Writer(open("matching.ninja", "w", encoding="utf-8"), width=9999)
@@ -168,10 +175,17 @@ def ninja_build(linker_entries: List[LinkerEntry], objdiff_mode: bool, skip_chec
 
         split_state = ""
 
-        for split in COMPLETED_SPLITS:
-            if split == str(entry.src_paths[0]):
-                split_state = "-snas"
-                break
+        if use_sn_as:
+            split_state = "-snas"
+            for split in UNCOMPATIBLE_SN_AS_SPLITS:
+                if split == str(entry.src_paths[0]):
+                    split_state = ""
+                    break
+        else:
+            for split in COMPLETED_SPLITS:
+                if split == str(entry.src_paths[0]):
+                    split_state = "-snas"
+                    break
 
         # Matching file
         match seg.type:
@@ -279,6 +293,58 @@ def ninja_build(linker_entries: List[LinkerEntry], objdiff_mode: bool, skip_chec
     else:
         print("Skipping checksum step")
 
+COMMENT_PART = r"\/\* (.+) ([0-9A-Z]{2})([0-9A-Z]{2})([0-9A-Z]{2})([0-9A-Z]{2}) \*\/"
+INSTRUCTION_PART = r"(\b(vadda\.xyz)\b.*)"
+OPCODE_PATTERN = re.compile(f"{COMMENT_PART}  {INSTRUCTION_PART}")
+
+PROBLEMATIC_FUNCS = {
+    "func_001F9CD0",
+    "func_00234A28",
+    "func_00147650",
+    "func_00110A08",
+    "func_001134A0",
+    "func_00113B10",
+    "func_00116250",
+    "func_0017A110",
+    "func_00131970",
+    "func_00169B38",
+    "func_001E86F8",
+    "func_00104DA0",
+    "func_0017EBF8",
+    "func_002EAD28",
+    "func_002EA480",
+    "func_002EBFC8",
+    "func_002EB508",
+    "func_002EB958",
+    "func_002E55A8__17TurnFlexAnimation",
+    "func_002E3E60",
+    "func_002E1680",
+    "func_002886B0"
+}
+
+def replace_instructions_with_opcodes(asm_folder: Path) -> None:
+    nm_folder = ROOT / asm_folder / "nonmatchings"
+    for p in nm_folder.rglob("*.s"):
+        
+        if p.stem not in PROBLEMATIC_FUNCS:
+            continue
+        
+        with p.open("r") as file:
+            content = file.read()
+
+        if re.search(OPCODE_PATTERN, content):
+            # Reference found
+            # Embed the opcode, we have to swap byte order for correct endianness
+            content = re.sub(
+                OPCODE_PATTERN,
+                r"/* \1 \2\3\4\5 */  .word      0x\5\4\3\2 /* \6 */",
+                content,
+            )
+
+            # Write the updated content back to the file
+            with p.open("w") as file:
+                file.write(content)
+
 def main():
     parser = argparse.ArgumentParser(description="Configure the project")
     parser.add_argument(
@@ -299,6 +365,12 @@ def main():
         help="Skip the checksum step",
         action="store_true",
     )
+    parser.add_argument(
+        "-sn_as",
+        "--sn_assembler",
+        help="Build the entire game and engine using the alternative SN Assembler",
+        action="store_true",
+    )
     parser.add_argument(
         "-diff",
         "--objdiff",
@@ -310,6 +382,7 @@ def main():
     do_clean         = (args.clean or args.clean_only) or False
     do_skip_checksum = args.skip_checksum or False
     do_objects       = args.objdiff or False
+    use_sn_as        = args.sn_assembler or False
 
     if do_clean:
         clean()
@@ -319,11 +392,13 @@ def main():
 
     split.main([YAML_FILE], modes="all", verbose=False, disassemble_all=True, make_full_disasm_for_code=do_objects)
 
-    ninja_build(split.linker_writer.entries, do_objects, do_skip_checksum)
+    ninja_build(split.linker_writer.entries, do_objects, do_skip_checksum, use_sn_as)
 
     if do_objects:
         subprocess.call(["ninja", "-f", "objdiff.ninja"])
 
+    if use_sn_as:
+        replace_instructions_with_opcodes(split.config["options"]["asm_path"])
 
 if __name__ == "__main__":
     main()

include/labels.inc

@@ -1,6 +1,10 @@
 # This file is used by the original compiler/assembler.
 # Defines the expected assembly macros.
 
+.macro c1 label
+    cop1 \label
+.endm
+
 # A function symbol.
 .macro glabel label, visibility=global
     .\visibility \label
@@ -11,7 +15,7 @@
 
 # The end of a function symbol.
 .macro endlabel label
-    .size \label, . - \label
+    #.size \label, . - \label
     .end \label
 .endm
 
@@ -51,8 +55,8 @@
 
 # Label to signal the symbol haven't been matched yet.
 .macro nonmatching label, size=1
-    .global \label\().NON_MATCHING
-    .type \label\().NON_MATCHING, @object
-    .size \label\().NON_MATCHING, \size
-    \label\().NON_MATCHING:
+    #.global \label\().NON_MATCHING
+    #.type \label\().NON_MATCHING, @object
+    #.size \label\().NON_MATCHING, \size
+    #\label\().NON_MATCHING:
 .endm

requirements.txt

@@ -1,3 +1,4 @@
+spimdisasm<1.40.1
 splat64[mips]>=0.37.1,<1.0.0
 ninja
 ninja_syntax