splat64 0.37.0__py3-none-any.whl → 0.37.2__py3-none-any.whl

splat/__init__.py

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

splat/scripts/split.py

@@ -6,6 +6,8 @@ import importlib
 from typing import Any, Dict, List, Optional, Set, Tuple, Union
 from pathlib import Path
 
+from collections import defaultdict, deque
+
 from .. import __package_name__, __version__
 from ..disassembler import disassembler_instance
 from ..util import cache_handler, progress_bar, vram_classes, statistics, file_presets
@@ -222,6 +224,47 @@ def calc_segment_dependences(
     return vram_class_to_follows_segments
 
 
+def sort_segments_by_vram_class_dependency(
+    all_segments: List[Segment],
+) -> List[Segment]:
+    # map all "_VRAM_END" strings to segments
+    end_sym_to_seg: Dict[str, Segment] = {}
+    for seg in all_segments:
+        end_sym_to_seg[get_segment_vram_end_symbol_name(seg)] = seg
+
+    # build dependency graph: A -> B means "A must come before B"
+    graph: Dict[Segment, List[Segment]] = defaultdict(list)
+    indeg: Dict[Segment, int] = {seg: 0 for seg in all_segments}
+
+    for seg in all_segments:
+        sym = seg.vram_symbol
+        if sym is None:
+            continue
+        dep = end_sym_to_seg.get(sym)
+        if dep is None or dep is seg:
+            continue
+        graph[dep].append(seg)
+        indeg[seg] += 1
+
+    # stable topo sort with queue seeded in original order
+    q = deque([seg for seg in all_segments if indeg[seg] == 0])
+    out: List[Segment] = []
+
+    while q:
+        n = q.popleft()
+        out.append(n)
+        for m in graph.get(n, []):
+            indeg[m] -= 1
+            if indeg[m] == 0:
+                q.append(m)
+
+    assert len(out) == len(all_segments), (
+        "Encountered cyclic dependency when reordering segments by vram class."
+    )
+
+    return out
+
+
 def read_target_binary() -> bytes:
     rom_bytes = options.opts.target_path.read_bytes()
 
@@ -317,6 +360,9 @@ def do_split(
 
 
 def write_linker_script(all_segments: List[Segment]) -> LinkerWriter:
+    if options.opts.ld_sort_segments_by_vram_class_dependency:
+        all_segments = sort_segments_by_vram_class_dependency(all_segments)
+
     vram_class_dependencies = calc_segment_dependences(all_segments)
     vram_classes_to_search = set(vram_class_dependencies.keys())
 

splat/segtypes/common/c.py

@@ -51,7 +51,7 @@ class CommonSegC(CommonSegCodeSubsegment):
 
     @staticmethod
     def get_funcs_defined_in_c(c_file: Path) -> Set[str]:
-        with open(c_file, "r") as f:
+        with open(c_file, "r", encoding="utf-8") as f:
             text = CommonSegC.strip_c_comments(f.read())
 
         return set(m.group(1) for m in C_FUNC_RE.finditer(text))
@@ -105,7 +105,7 @@ class CommonSegC(CommonSegCodeSubsegment):
 
     @staticmethod
     def get_global_asm_funcs(c_file: Path) -> Set[str]:
-        with c_file.open() as f:
+        with c_file.open(encoding="utf-8") as f:
             text = CommonSegC.strip_c_comments(f.read())
         if options.opts.compiler == IDO:
             return set(m.group(2) for m in C_GLOBAL_ASM_IDO_RE.finditer(text))
@@ -114,7 +114,7 @@ class CommonSegC(CommonSegCodeSubsegment):
 
     @staticmethod
     def get_global_asm_rodata_syms(c_file: Path) -> Set[str]:
-        with c_file.open() as f:
+        with c_file.open(encoding="utf-8") as f:
             text = CommonSegC.strip_c_comments(f.read())
         if options.opts.compiler == IDO:
             return set(m.group(2) for m in C_GLOBAL_ASM_IDO_RE.finditer(text))
@@ -152,6 +152,8 @@ class CommonSegC(CommonSegCodeSubsegment):
 
     def split(self, rom_bytes: bytes):
         if self.is_auto_segment:
+            if options.opts.make_full_disasm_for_code:
+                self.split_as_asmtu_file(self.asm_out_path())
             return
 
         if self.rom_start != self.rom_end:

splat/segtypes/common/codesubsegment.py

@@ -252,22 +252,21 @@ class CommonSegCodeSubsegment(Segment):
             f.write(self.spim_section.disassemble())
 
     # Same as above but write all sections from siblings
-    def split_as_asmtu_file(self, out_path: Optional[Path]):
-        if self.spim_section is None:
-            return
-
-        if not out_path:
-            return
-
+    def split_as_asmtu_file(self, out_path: Path):
         out_path.parent.mkdir(parents=True, exist_ok=True)
 
         self.print_file_boundaries()
 
         with open(out_path, "w", newline="\n") as f:
-            # Write `.text` contents
-            for line in self.get_asm_file_header():
-                f.write(line + "\n")
-            f.write(self.spim_section.disassemble())
+            # self.spim_section would be None if the current section was
+            # declared `auto` in the yaml.
+            # This can be useful when there are TUs with only data/rodata/bss/etc
+            # sections but not text section.
+            if self.spim_section is not None:
+                # Write `.text` contents
+                for line in self.get_asm_file_header():
+                    f.write(line + "\n")
+                f.write(self.spim_section.disassemble())
 
             # Disassemble the siblings to this file by respecting the `section_order`
             for sect in self.section_order:
@@ -281,25 +280,31 @@ class CommonSegCodeSubsegment(Segment):
                 if (
                     isinstance(sibling, CommonSegCodeSubsegment)
                     and sibling.spim_section is not None
-                    and not sibling.should_self_split()
+                    and (
+                        not sibling.should_self_split()
+                        or options.opts.make_full_disasm_for_code
+                    )
                 ):
                     f.write("\n")
                     f.write(f"{sibling.get_section_asm_line()}\n\n")
                     f.write(sibling.spim_section.disassemble())
 
-            # Another loop to check anything that somehow may not be present on the `section_order`
+            # Another loop to check anything that somehow may not be present in the `section_order`
             for sect, sibling in self.siblings.items():
                 if sect == self.get_linker_section_linksection():
                     continue
 
                 if sect in self.section_order:
-                    # Already handled on the above loop
+                    # Already handled in the above loop
                     continue
 
                 if (
                     isinstance(sibling, CommonSegCodeSubsegment)
                     and sibling.spim_section is not None
-                    and not sibling.should_self_split()
+                    and (
+                        not sibling.should_self_split()
+                        or options.opts.make_full_disasm_for_code
+                    )
                 ):
                     f.write("\n")
                     f.write(f"{sibling.get_section_asm_line()}\n\n")

splat/util/file_presets.py

@@ -42,9 +42,6 @@ def write_include_asm_h():
         return
 
     directory = options.opts.generated_asm_macros_directory.as_posix()
-    print()
-    print(directory)
-    print()
 
     if options.opts.include_asm_macro_style == "maspsx_hack":
         include_asm_macro = """\

splat/util/n64/rominfo.py

@@ -162,8 +162,7 @@ class N64EntrypointInfo:
                         register_values[insn.rs.value] + insn.getProcessedImmediate()
                     )
                     completed_pair[insn.rt.value] = True
-                    if not insn.isUnsigned():
-                        lo_assignments[insn.rt.value] = current_rom
+                    lo_assignments[insn.rt.value] = current_rom
                 elif insn.doesStore():
                     if insn.rt == rabbitizer.RegGprO32.zero:
                         # Try to detect the zero-ing bss algorithm

splat/util/options.py

@@ -127,6 +127,8 @@ class SplatOpts:
     # `vram_symbol` / `follows_classes` (vram_class options) to calculate vram addresses in the linker script.
     # If disabled, this uses the plain integer values for vram addresses defined in the yaml.
     ld_use_symbolic_vram_addresses: bool
+    # Ensures segments of vram classes with dependencies (`vram_symbol` / `follows_classes`) are written to the linker script AFTER the segments they depend on.
+    ld_sort_segments_by_vram_class_dependency: bool
     # Change linker script generation to allow partially linking segments. Requires both `ld_partial_scripts_path` and `ld_partial_build_segments_path` to be set.
     ld_partial_linking: bool
     # Folder were each intermediary linker script will be written to.
@@ -512,6 +514,9 @@ def _parse_yaml(
         ld_sections_allowlist=p.parse_opt("ld_sections_allowlist", list, []),
         ld_sections_denylist=p.parse_opt("ld_sections_denylist", list, []),
         ld_wildcard_sections=p.parse_opt("ld_wildcard_sections", bool, False),
+        ld_sort_segments_by_vram_class_dependency=p.parse_opt(
+            "ld_sort_segments_by_vram_class_dependency", bool, False
+        ),
         ld_use_symbolic_vram_addresses=p.parse_opt(
             "ld_use_symbolic_vram_addresses", bool, True
         ),

{splat64-0.37.0.dist-info → splat64-0.37.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splat64
-Version: 0.37.0
+Version: 0.37.2
 Summary: A binary splitting tool to assist with decompilation and modding projects
 Project-URL: Repository, https://github.com/ethteck/splat
 Project-URL: Issues, https://github.com/ethteck/splat/issues
@@ -76,7 +76,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.37.0,<1.0.0
+splat64[mips]>=0.37.2,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.37.0.dist-info → splat64-0.37.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-splat/__init__.py,sha256=rvIlPAMo8x-ro2Ehl1n7-IVrTyHavDimSnE80nIzgno,291
+splat/__init__.py,sha256=-m9-FH6WSFV9bHUlbGLqooheqgbSGqaA_-Y0hfB1p9Y,291
 splat/__main__.py,sha256=T333dHDgr-2HYYhtARnYMEjdECnYiNIKfcXDD99o22A,732
 splat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 splat/disassembler/__init__.py,sha256=LXuCElHxOvbb9xuSSeswT8W_v78chwtqjKq_9nxFVzQ,167
@@ -15,7 +15,7 @@ splat/platforms/psx.py,sha256=YxQERdOBr4p3ab9Wk80FNhVYi-uvmh7p_jeykSFp23M,40
 splat/scripts/__init__.py,sha256=OY0nHg6a7JB437Sb96qLbZ_7ByVsal1gStj35wJAI_Y,101
 splat/scripts/capy.py,sha256=svbOfLO34-QN3xLiBy9vk2RGs_To8TWMWEKBw6yx2xQ,3674
 splat/scripts/create_config.py,sha256=Xt0BgS9ql5GfLrNKWQRMuKWea0sXUygRV1_wCYGrrPE,17949
-splat/scripts/split.py,sha256=rstKTy1osrD4Cqp07NGNVpLeBVQSNbeeTYC-AORrSJs,21937
+splat/scripts/split.py,sha256=mOqaaXWX47EQpZiAmfMFLFpEBN5-KsZ_Uk2sl1SNh7k,23334
 splat/segtypes/__init__.py,sha256=-upUw_4JGQtvyp6IfTMzOq_CK3xvVaT_0K0_EipHyOo,208
 splat/segtypes/linker_entry.py,sha256=WHFdVFC_NW6_ub-LJbfwze-FZGCTRtjEZHz_bhIkX-M,25160
 splat/segtypes/segment.py,sha256=IcmF7FxDrJ1ZP5AKFO-skNrGfYhGIYwawyepKzeTF3A,30619
@@ -24,9 +24,9 @@ splat/segtypes/common/asm.py,sha256=gpR4uZ57l4Q9G0XTOeO1JIk9P5d8xXBxRfkrPIN-M1A,
 splat/segtypes/common/asmtu.py,sha256=C52kKh-8YeDHu0EucEfQ-tQMtDgfKfwAJ6wwiW6nOBU,354
 splat/segtypes/common/bin.py,sha256=qZeuvHNSrRuxdk-8V0xW0tcFhtzPk6doyf43E_t7D9Q,1250
 splat/segtypes/common/bss.py,sha256=cX0RO7LRcBRO6t463AUSSV8sGdlxZTcd5_McZjjqfFo,3107
-splat/segtypes/common/c.py,sha256=RkevmqKXK9RKQ_yPClFFur1Uq4jGGdVtL1BnScbHhok,21327
+splat/segtypes/common/c.py,sha256=uKc8V4VSz2bRkt2g7CVbKibRdp2R1Ro9UAxBVLyB8M8,21494
 splat/segtypes/common/code.py,sha256=FfBuy6x8fQXoJYX2Ul80uOs-CzlVslUaveD-hBmvKXM,10693
-splat/segtypes/common/codesubsegment.py,sha256=XpPzNwGSNL4HE7Qgi7-tSVXlYtfdXug9PrzQIJu3yDI,10720
+splat/segtypes/common/codesubsegment.py,sha256=a9AGNfWrQRfMVKP84_a_2BBfQSwOVviAltp8ZjOivT0,11140
 splat/segtypes/common/cpp.py,sha256=p-duowCt4czrmaWgj1LuFw5LGfdyB_uaeLTKVmH80Cg,180
 splat/segtypes/common/data.py,sha256=l3CCa95vHH8XwiksamaxuZuSF_rOGqcozGlZj0bt9Yw,5712
 splat/segtypes/common/databin.py,sha256=nDI1ciAv0QLt2xDYjEtGJHSoONZzJZKyST-BuSKML2Q,1169
@@ -80,9 +80,9 @@ splat/util/cache_handler.py,sha256=BrTWo8U4bj8TBcZfIRwiAYmogc3YUlBz9P-34Y0aIrg,1
 splat/util/color.py,sha256=FSmy0dAQJ9FzRBc99Yt4kBEyB62MC_YiVkqoWgPMsRU,371
 splat/util/compiler.py,sha256=n5hlxazUy8rq-t7DADBbC0n6ZGuLDzp3ma3883oHQ3E,1848
 splat/util/conf.py,sha256=0Qcv5d5XAvdVzqF4i4L_lJuC5hI0PEufeob58YaN-xs,3230
-splat/util/file_presets.py,sha256=BJh56jCpJCFUqEYTA6xiAnJlyFInVzqtRGUY6eGqz-w,19030
+splat/util/file_presets.py,sha256=4UsDMqQy5ZACSafjCba1pwwTQKK_2leOycwTFkNG4Ac,18985
 splat/util/log.py,sha256=aJA1rg8IirJu1wGzjNuATHvepYvD3k5CtEyMasyJWxI,1193
-splat/util/options.py,sha256=Lq1noBa-2f_j7lSvFfOyq4b2rFhBuCvB-M_s1Czu1Pg,31931
+splat/util/options.py,sha256=wPW2T1jZ3m6fAgVnVfsnvAH0ZK4pF_-mlVP967RdtNU,32287
 splat/util/palettes.py,sha256=d3KoZnwt-zunI9eNwb3txysXg4DY3xnF0O5aQRxM4so,2920
 splat/util/progress_bar.py,sha256=41VehpIFK1cphENaXV_Aq6_3mFx25eQ8V7Z51SKFPeM,166
 splat/util/relocs.py,sha256=j8fzM9u0ZQwZa1b1Dd26ho9GwIooBXt8mE0jAN7wqV0,4153
@@ -92,13 +92,13 @@ splat/util/utils.py,sha256=kAC0DAjaGa0Kq2k86RfQtFkheV87XuyeOgZIVIk3CHE,208
 splat/util/vram_classes.py,sha256=UH4rkugEwoec_-alJ4smNOcnU51G-V5OG7Pfsj47eaM,3491
 splat/util/n64/__init__.py,sha256=hsBkPh6NUz-bW7HVspcNZ0mCxBhdfcPC07_7gbga95o,84
 splat/util/n64/find_code_length.py,sha256=uUoPoUORAjsAvH8oGqwnGvw6j8I_NnSrZtA-x9h9h7E,1414
-splat/util/n64/rominfo.py,sha256=Ms9P-MuuOSyEF4QNB3wBuC-U9OdrfByqR0VPAHqTBQI,16976
+splat/util/n64/rominfo.py,sha256=o3c3m8GG8iCu8ruohfrYRmlTjXo1W8gZJHEVHcH_QGc,16926
 splat/util/ps2/__init__.py,sha256=hAU12HtQLOc_sxc8_rzxOERBT5wjg3DhQ8XRN9hBXfA,39
 splat/util/ps2/ps2elfinfo.py,sha256=v6nTPabzXpG1N-MhhkbVeLoGjgsjBEpHL1DoPv26-Hs,7982
 splat/util/psx/__init__.py,sha256=kCCaR-KB1mNlIcXB4OuuSQ2zVLbWg_SnIZIUeyjeBBI,39
 splat/util/psx/psxexeinfo.py,sha256=Oxd5Lt8HTNHuUzw3cVujdyJRqEG-yo0XT78wEISUXms,5705
-splat64-0.37.0.dist-info/METADATA,sha256=Q-9gJotMBsqiMMtThLZaPEgL5g8uzaw9zm_QJd033po,3879
-splat64-0.37.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-splat64-0.37.0.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
-splat64-0.37.0.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
-splat64-0.37.0.dist-info/RECORD,,
+splat64-0.37.2.dist-info/METADATA,sha256=BEiQ_5Eq0N_JpZfq2YdJ8cv7XjYfhxzqfOb4n9SCjIY,3879
+splat64-0.37.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+splat64-0.37.2.dist-info/entry_points.txt,sha256=O7Xy-qNOHcI87-OQrWJ-OhRDws74SuwVb_4rtnp0eLo,52
+splat64-0.37.2.dist-info/licenses/LICENSE,sha256=97VMVzjG8yQvsf8NG2M9IFSbh7R8cifJnc6QK1cZqj8,1070
+splat64-0.37.2.dist-info/RECORD,,