Disable rodata start suggestion

CHANGELOG.md

@@ -2,9 +2,11 @@
 
 ### 0.28.2
 
+* New global option and per-segment option: `suggestion_rodata_section_start`
+  * Allows to toggle the rodata section start suggestion that is emitted by inspecting the data section
 * Avoid running spimdisasm on auto segments.
   * Should improve runtime performance and avoid giving redundant filesplit suggestions.
-* A zero-sized bin segment is considered a hard error.
+* A zero-sized bin segment is now considered a hard error.
 
 ### 0.28.1
 

docs/Configuration.md

@@ -674,6 +674,18 @@ Does the same as `use_gp_rel_macro_nonmatching`, except it is only applied to `a
 
 Defaults to `True`
 
+### suggestion_rodata_section_start
+
+splat is able to suggest where the rodata section may start by inspecting a corresponding data section (as long as the rodata section follows rodata and not the other way around).
+Don't trust this suggestion blindly since it may be incorrect, either because the rodata section may start a lot before than what splat suggests or splat even may be completely wrong and suggest something that
+actually is data as if it were rodata.
+
+This option allows turning off the suggestion in case you have checked it is not correct.
+
+This can be turned off [per segment](Segments.md#suggestion_rodata_section_start), which is recommended if you are still on the exploration stage of the decompilation project.
+
+Defaults to `True`.
+
 ## N64-specific options
 
 ### header_encoding

docs/Segments.md

@@ -537,3 +537,25 @@ Only works on top-level segments
 ```
 
 Defaults to the global `subalign` option.
+
+### `suggestion_rodata_section_start`
+
+splat is able to suggest where the rodata section may start by inspecting a corresponding data section (as long as the rodata section follows rodata and not the other way around).
+Don't trust this suggestion blindly since it may be incorrect, either because the rodata section may start a lot before than what splat suggests or splat even may be completely wrong and suggest something that
+actually is data as if it were rodata.
+
+This option allows turning off the suggestion for this segment in case you have checked the suggestion is not correct. This option is inherited from the parent segment if a subsegment does not specify it.
+
+This can be turned off [globally](Configuration.md#suggestion_rodata_section_start), but it is not recommended to globally turn it off unless you are confident you have mapped every data/rodata section of every segment.
+
+Defaults to the global option.
+
+**Example:**
+
+```yaml
+  - name: boot
+    type: code
+    start: 0x001060
+    vram: 0x80000460
+    suggestion_rodata_section_start: False
+```

src/splat/segtypes/common/data.py

@@ -146,7 +146,11 @@ def disassemble_data(self, rom_bytes):
             )
 
             # Hint to the user that we are now in the .rodata section and no longer in the .data section (assuming rodata follows data)
-            if not rodata_encountered and self.get_most_parent().rodata_follows_data:
+            if (
+                self.suggestion_rodata_section_start
+                and not rodata_encountered
+                and self.get_most_parent().rodata_follows_data
+            ):
                 if symbol.contextSym.isJumpTable():
                     rodata_encountered = True
                     print(

src/splat/segtypes/segment.py

@@ -220,6 +220,19 @@ def parse_ld_align_segment_start(yaml: Union[dict, list]) -> Optional[int]:
             return yaml["ld_align_segment_start"]
         return options.opts.ld_align_segment_start
 
+    @staticmethod
+    def parse_suggestion_rodata_section_start(
+        yaml: Union[dict, list]
+    ) -> Optional[bool]:
+        if isinstance(yaml, dict):
+            suggestion_rodata_section_start = yaml.get(
+                "suggestion_rodata_section_start"
+            )
+            if suggestion_rodata_section_start is not None:
+                assert isinstance(suggestion_rodata_section_start, bool)
+                return suggestion_rodata_section_start
+        return None
+
     def __init__(
         self,
         rom_start: Optional[int],
@@ -301,6 +314,10 @@ def __init__(
         # True if this segment was generated based on auto_link_sections
         self.is_generated: bool = False
 
+        self.given_suggestion_rodata_section_start: Optional[bool] = (
+            self.parse_suggestion_rodata_section_start(yaml)
+        )
+
         # Is an automatic segment, generated automatically or declared on the yaml by the user
         self.is_auto_segment: bool = False
 
@@ -512,6 +529,14 @@ def rodata_follows_data(self) -> bool:
             self.section_order.index(".rodata") - self.section_order.index(".data") == 1
         )
 
+    @property
+    def suggestion_rodata_section_start(self) -> bool:
+        if self.given_suggestion_rodata_section_start is not None:
+            return self.given_suggestion_rodata_section_start
+        if self.parent is not None:
+            return self.parent.suggestion_rodata_section_start
+        return options.opts.suggestion_rodata_section_start
+
     def get_cname(self) -> str:
         name = self.name
         if self.parent:

src/splat/util/options.py

@@ -232,6 +232,8 @@ class SplatOpts:
     use_gp_rel_macro_nonmatching: bool
     # Does the same as `use_gp_rel_macro_nonmatching`, except it is only applied to `asm` and `hasm` segments.
     use_gp_rel_macro: bool
+    # Allows emitting suggestions for where the rodata may start by examining the data section.
+    suggestion_rodata_section_start: bool
 
     ################################################################################
     # N64-specific options
@@ -558,6 +560,9 @@ def parse_endianness() -> Literal["big", "little"]:
             "use_gp_rel_macro_nonmatching", bool, True
         ),
         use_gp_rel_macro=p.parse_opt("use_gp_rel_macro", bool, True),
+        suggestion_rodata_section_start=p.parse_opt(
+            "suggestion_rodata_section_start", bool, True
+        ),
     )
     p.check_no_unread_opts()
     return ret