Merge pull request #186 from Decompollaborate/develop

1.33.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.33.0] - 2025-03-10
+
+### Added
+
+- `SectionText.setGpRelHack`: Allows updating the gpRelHack value after anlyzing
+  the section.
+
+### Changed
+
+- Change where `.size` directive and end label is emitted on functions with no
+  user-declared size.
+  - The directives are now emitted before the function's trailing padding.
+- Allow using reloc `MIPS_NONE` on `jal` and `j` instructions.
+
+### Fixed
+
+- `gpRelHack` fix:
+  - Avoid emitting multiple `gp_rel:` comments.
+
 ## [1.32.4] - 2025-03-03
 
 ### Fixed
@@ -1764,6 +1783,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Version 1.0.0
 
 [unreleased]: https://github.com/Decompollaborate/spimdisasm/compare/master...develop
+[1.33.0]: https://github.com/Decompollaborate/spimdisasm/compare/1.32.4...1.33.0
 [1.32.4]: https://github.com/Decompollaborate/spimdisasm/compare/1.32.3...1.32.4
 [1.32.3]: https://github.com/Decompollaborate/spimdisasm/compare/1.32.2...1.32.3
 [1.32.2]: https://github.com/Decompollaborate/spimdisasm/compare/1.32.1...1.32.2

README.md

@@ -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
-spimdisasm>=1.32.4,<2.0.0
+spimdisasm>=1.33.0,<2.0.0
 ```
 
 ### Development version

pyproject.toml

@@ -4,7 +4,7 @@
 [project]
 name = "spimdisasm"
 # Version should be synced with spimdisasm/__init__.py
-version = "1.32.4"
+version = "1.33.0"
 description = "MIPS disassembler"
 readme = "README.md"
 license = {file = "LICENSE"}

spimdisasm/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-__version_info__: tuple[int, int, int] = (1, 32, 4)
+__version_info__: tuple[int, int, int] = (1, 33, 0)
 __version__ = ".".join(map(str, __version_info__))# + "-dev0"
 __author__ = "Decompollaborate"
 

spimdisasm/mips/sections/MipsSectionText.py

@@ -419,3 +419,12 @@ def removeTrailingNops(self) -> bool:
             was_updated = True
 
         return was_updated
+
+    def getGpRelHack(self) -> bool:
+        return self.gpRelHack
+
+    def setGpRelHack(self, value: bool) -> None:
+        self.gpRelHack = value
+        for func in self.symbolList:
+            assert isinstance(func, symbols.SymbolFunction)
+            func.gpRelHack = value

spimdisasm/mips/symbols/MipsSymbolFunction.py

@@ -709,11 +709,15 @@ def _getImmOverrideForInstruction(self, instr: rabbitizer.Instruction, instrOffs
             return None, None
 
         relocInfo = self.getReloc(instrOffset, instr)
-        if relocInfo is not None and not relocInfo.isRelocNone():
-            ignoredRelocs = set()
-            if self.gpRelHack:
-                ignoredRelocs.add(common.RelocType.MIPS_GPREL16)
-            return relocInfo.getNameWithReloc(isSplittedSymbol=isSplittedSymbol, ignoredRelocs=ignoredRelocs), relocInfo
+        if relocInfo is not None:
+            if relocInfo.isRelocNone():
+                if instr.isJumpWithAddress():
+                    return f"0x{instr.getInstrIndexAsVram():08X}", relocInfo
+            else:
+                ignoredRelocs = set()
+                if self.gpRelHack:
+                    ignoredRelocs.add(common.RelocType.MIPS_GPREL16)
+                return relocInfo.getNameWithReloc(isSplittedSymbol=isSplittedSymbol, ignoredRelocs=ignoredRelocs), relocInfo
 
         if instr.isBranch() or instr.isUnconditionalBranch():
             if common.GlobalConfig.IGNORE_BRANCHES:
@@ -811,8 +815,9 @@ def _emitInstruction(self, instr: rabbitizer.Instruction, instructionOffset: int
                     line = line.replace("addiu ", "la    ").replace(", $gp, ", ", ").replace(", $28, ", ", ")
 
                 endComment = self.endOfLineComment.get(instructionOffset//4, "")
-                endComment += f" /* gp_rel: {immOverride} */"
-                self.endOfLineComment[instructionOffset//4] = endComment
+                if " /* gp_rel: " not in endComment:
+                    endComment += f" /* gp_rel: {immOverride} */"
+                    self.endOfLineComment[instructionOffset//4] = endComment
 
         return f"{comment}  {line}"
 
@@ -867,7 +872,13 @@ def disassemble(self, migrate: bool=False, useGlobalLabel: bool=True, isSplitted
         self._generateRelocsFromInstructionAnalyzer()
 
         symName = self.getName()
+
         symSize = self.contextSym.getSize()
+        if self.contextSym.userDeclaredSize is None:
+            # Fixup symbol size to avoid counting padding as part of the symbol
+            # on the emitted size and end directives.
+            symSize -= 4 * self.countExtraPadding()
+
         output += self.getSymbolAsmDeclaration(symName, useGlobalLabel)
 
         wasLastInstABranch = False