include_asm_macro_style setting (#476)

* maspsx_include_asm_hack

* lineendings

* change setting to include_asm_macro_style

* Fix test

* Update src/splat/scripts/create_config.py

Author: AngheloAlf

CHANGELOG.md

@@ -1,5 +1,11 @@
 # splat Release Notes
 
+### 0.36.0
+
+* New yaml option: `include_asm_macro_style`:
+  * Allows configuring the style used by the generated `INCLUDE_ASM` macro. It currently allows two possible values:
+  * `default`: Uses the default definition for the macro. This is the default.
+  * `maspsx_hack`: Changes the definition of the generated `INCLUDE_ASM` to be compatible with the one expected by `maspsx` when using the [reordering workaround hack](https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack). This value is only relevant for psx projects.
 * `spimdisasm` 1.36.1 or above is now required.
 
 ### 0.35.2

README.md

@@ -21,7 +21,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.35.2,<1.0.0
+splat64[mips]>=0.36.0,<1.0.0
 ```
 
 ### Optional dependencies

docs/Configuration.md

@@ -138,6 +138,15 @@ Some files may not be generated depending on the selected platform and compiler,
 
 Defaults to `True`.
 
+### include_asm_macro_style
+
+Allows configuring the style used by the generated `INCLUDE_ASM` macro. It currently allows two possible values:
+
+- `default`: Uses the default definition for the macro. This is the default.
+- `maspsx_hack`: Changes the definition of the generated `INCLUDE_ASM` to be compatible with the one expected by `maspsx` when using the [reordering workaround hack](https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack).
+
+Defaults to `default`.
+
 ### o_as_suffix
 
 Used to determine the file extension of the built files that will be listed on the linker script.

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.35.2"
+version = "0.36.0"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}

src/splat/__init__.py

@@ -1,7 +1,7 @@
 __package_name__ = __name__
 
 # Should be synced with pyproject.toml
-__version__ = "0.35.2"
+__version__ = "0.36.0"
 __author__ = "ethteck"
 
 from . import util as util

src/splat/scripts/create_config.py

@@ -309,6 +309,10 @@ def create_psx_config(exe_path: Path, exe_bytes: bytes):
   data_string_encoding: ASCII
   rodata_string_guesser_level: 2
   data_string_guesser_level: 2
+
+  # Uncomment this line if you need to use the maspsx reorder workaround hack
+  # https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack
+  # include_asm_macro_style: maspsx_hack
 """
 
     segments = f"""\

src/splat/segtypes/n64/i1.py

@@ -1,9 +1,9 @@
-import n64img.image
-
-from .img import N64SegImg
-
-
-class N64SegI1(N64SegImg):
-    def __init__(self, *args, **kwargs):
-        kwargs["img_cls"] = n64img.image.I1
-        super().__init__(*args, **kwargs)
+import n64img.image
+
+from .img import N64SegImg
+
+
+class N64SegI1(N64SegImg):
+    def __init__(self, *args, **kwargs):
+        kwargs["img_cls"] = n64img.image.I1
+        super().__init__(*args, **kwargs)

src/splat/util/file_presets.py

@@ -33,13 +33,23 @@ def write_include_asm_h():
         # These compilers do not use the `INCLUDE_ASM` macro.
         return
 
-    file_data = """\
-#ifndef INCLUDE_ASM_H
-#define INCLUDE_ASM_H
-
-#if !defined(M2CTX) && !defined(PERMUTER)
-
-#ifndef INCLUDE_ASM
+    if options.opts.include_asm_macro_style == "maspsx_hack":
+        include_asm_macro = """\
+#define INCLUDE_ASM(FOLDER, NAME) \\
+    void __maspsx_include_asm_hack_##NAME() { \\
+        __asm__( \\
+            ".text # maspsx-keep \\n" \\
+            "    .align 2 # maspsx-keep\\n" \\
+            "    .set noat # maspsx-keep\\n" \\
+            "    .set noreorder # maspsx-keep\\n" \\
+            "    .include \\"" FOLDER "/" #NAME ".s\\" # maspsx-keep\\n" \\
+            "    .set reorder # maspsx-keep\\n" \\
+            "    .set at # maspsx-keep\\n" \\
+        ); \\
+    }
+"""
+    else:  # default
+        include_asm_macro = """\
 #define INCLUDE_ASM(FOLDER, NAME) \\
     __asm__( \\
         ".section .text\\n" \\
@@ -49,14 +59,28 @@ def write_include_asm_h():
         "    .set reorder\\n" \\
         "    .set at\\n" \\
     )
-#endif
-#ifndef INCLUDE_RODATA
+"""
+
+    include_rodata_macro = """\
 #define INCLUDE_RODATA(FOLDER, NAME) \\
     __asm__( \\
         ".section .rodata\\n" \\
         "    .include \\"" FOLDER "/" #NAME ".s\\"\\n" \\
         ".section .text" \\
     )
+"""
+
+    file_data = f"""\
+#ifndef INCLUDE_ASM_H
+#define INCLUDE_ASM_H
+
+#if !defined(M2CTX) && !defined(PERMUTER)
+
+#ifndef INCLUDE_ASM
+{include_asm_macro}\
+#endif
+#ifndef INCLUDE_RODATA
+{include_rodata_macro}\
 #endif
 __asm__(".include \\"include/labels.inc\\"\\n");
 

src/splat/util/options.py

@@ -37,7 +37,12 @@ class SplatOpts:
     generated_s_preamble: str
     # Determines any extra content to be added in the generated macro.inc file
     generated_macro_inc_content: Optional[str]
+    # Determines if files related to assembly macros should be regenerated by splat
     generate_asm_macros_files: bool
+    # Changes the definition of the generated `INCLUDE_ASM`.
+    # default: The default one.
+    # maspsx_hack: Use the maspsx hack workaround definition https://github.com/mkst/maspsx?tab=readme-ov-file#include_asm-reordering-workaround-hack
+    include_asm_macro_style: Literal["default", "maspsx_hack"]
     # Determines whether to use .o as the suffix for all binary files?... TODO document
     use_o_as_suffix: bool
     # the value of the $gp register to correctly calculate offset to %gp_rel relocs
@@ -400,6 +405,21 @@ def parse_endianness() -> Literal["big", "little"]:
         else:
             raise ValueError(f"Invalid endianness: {endianness}")
 
+    def parse_include_asm_macro_style() -> Literal["default", "maspsx_hack"]:
+        include_asm_macro_style = p.parse_opt_within(
+            "include_asm_macro_style",
+            str,
+            ["default", "maspsx_hack"],
+            "default",
+        )
+
+        if include_asm_macro_style == "default":
+            return "default"
+        elif include_asm_macro_style == "maspsx_hack":
+            return "maspsx_hack"
+        else:
+            raise ValueError(f"Invalid endianness: {include_asm_macro_style}")
+
     default_ld_bss_is_noload = True
     if platform == "psx":
         default_ld_bss_is_noload = False
@@ -431,6 +451,7 @@ def parse_endianness() -> Literal["big", "little"]:
             "generated_macro_inc_content", str
         ),
         generate_asm_macros_files=p.parse_opt("generate_asm_macros_files", bool, True),
+        include_asm_macro_style=parse_include_asm_macro_style(),
         use_o_as_suffix=p.parse_opt("o_as_suffix", bool, False),
         gp=p.parse_optional_opt("gp_value", int),
         check_consecutive_segment_types=p.parse_opt(