Merge pull request #123 from Decompollaborate/develop

1.14.2

Author: AngheloAlf

pyproject.toml

@@ -4,7 +4,7 @@
 [project]
 name = "spimdisasm"
 # Version should be synced with spimdisasm/__init__.py
-version = "1.14.1"
+version = "1.14.2"
 description = "MIPS disassembler"
 # license = "MIT"
 readme = "README.md"
@@ -36,5 +36,8 @@ exclude = ["build*"]
 [tool.setuptools.dynamic]
 dependencies = {file = "requirements.txt"}
 
+[tool.setuptools.package-data]
+spimdisasm = ["py.typed"]
+
 [tool.cibuildwheel]
 skip = ["cp36-*"]

spimdisasm/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-__version_info__ = (1, 14, 1)
+__version_info__ = (1, 14, 2)
 __version__ = ".".join(map(str, __version_info__))
 __author__ = "Decompollaborate"
 

spimdisasm/common/Utils.py

@@ -42,14 +42,17 @@ def eprintVerbose(*args, **kwargs):
 def isStdoutRedirected() -> bool:
     return not sys.stdout.isatty()
 
-# Returns the md5 hash of a bytearray
-def getStrHash(byte_array: bytearray) -> str:
+# Returns the md5 hash of a bytes
+def getStrHash(byte_array: bytes) -> str:
     return str(hashlib.md5(byte_array).hexdigest())
 
-def writeBytearrayToFile(filepath: Path, array_of_bytes: bytearray):
+def writeBytesToFile(filepath: Path, array_of_bytes: bytes):
     with filepath.open(mode="wb") as f:
         f.write(array_of_bytes)
 
+#! deprecated
+writeBytearrayToFile = writeBytesToFile
+
 def readFileAsBytearray(filepath: Path) -> bytearray:
     if not filepath.exists():
         return bytearray(0)
@@ -67,7 +70,7 @@ def readJson(filepath: Path):
 def removeExtraWhitespace(line: str) -> str:
     return " ".join(line.split())
 
-def endianessBytesToWords(endian: InputEndian, array_of_bytes: bytearray, offset: int=0, offsetEnd: int|None=None) -> list[int]:
+def endianessBytesToWords(endian: InputEndian, array_of_bytes: bytes, offset: int=0, offsetEnd: int|None=None) -> list[int]:
     totalBytesCount = len(array_of_bytes)
     if totalBytesCount == 0:
         return list()
@@ -88,33 +91,34 @@ def endianessBytesToWords(endian: InputEndian, array_of_bytes: bytearray, offset
         little_byte_format = f"<{halfwords}H"
         big_byte_format = f">{halfwords}H"
         tmp = struct.unpack_from(little_byte_format, array_of_bytes, offset)
-        struct.pack_into(big_byte_format, array_of_bytes, offset, *tmp)
+        newBytes = bytearray(array_of_bytes)
+        struct.pack_into(big_byte_format, newBytes, offset, *tmp)
+        array_of_bytes = bytes(newBytes)
 
     words = bytesCount//4
     endian_format = f">{words}I"
     if endian == InputEndian.LITTLE:
         endian_format = f"<{words}I"
     return list(struct.unpack_from(endian_format, array_of_bytes, offset))
 
-def bytesToWords(array_of_bytes: bytearray, offset: int=0, offsetEnd: int|None=None) -> list[int]:
+def bytesToWords(array_of_bytes: bytes, offset: int=0, offsetEnd: int|None=None) -> list[int]:
     return endianessBytesToWords(GlobalConfig.ENDIAN, array_of_bytes, offset, offsetEnd)
 
 #! deprecated
 bytesToBEWords = bytesToWords
 
-def endianessWordsToBytes(endian: InputEndian, words_list: list[int], buffer: bytearray) -> bytearray:
+def endianessWordsToBytes(endian: InputEndian, words_list: list[int]) -> bytes:
     if endian == InputEndian.MIDDLE:
         raise BufferError("TODO: wordsToBytesEndianess: GlobalConfig.ENDIAN == InputEndian.MIDDLE")
 
     words = len(words_list)
     endian_format = f">{words}I"
     if endian == InputEndian.LITTLE:
         endian_format = f"<{words}I"
-    struct.pack_into(endian_format, buffer, 0, *words_list)
-    return buffer
+    return struct.pack(endian_format, *words_list)
 
-def wordsToBytes(words_list: list[int], buffer: bytearray) -> bytearray:
-    return endianessWordsToBytes(GlobalConfig.ENDIAN, words_list, buffer)
+def wordsToBytes(words_list: list[int]) -> bytes:
+    return endianessWordsToBytes(GlobalConfig.ENDIAN, words_list)
 
 #! deprecated
 beWordsToBytes = wordsToBytes
@@ -227,7 +231,7 @@ def getMaybeBooleyFromMaybeStr(booley: str|None) -> bool|None:
 
 escapeCharactersSpecialCases = {0x1B, 0x8C, 0x8D}
 
-def decodeString(buf: bytearray, offset: int, stringEncoding: str) -> tuple[list[str], int]:
+def decodeString(buf: bytes, offset: int, stringEncoding: str) -> tuple[list[str], int]:
     result = []
 
     dst = bytearray()

spimdisasm/elf32/Elf32Dyns.py

@@ -29,7 +29,7 @@ def ptr(self) -> int:
         return self.val
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32DynEntry:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32DynEntry:
         entryFormat = common.GlobalConfig.ENDIAN.toFormatString() + "II"
         unpacked = struct.unpack_from(entryFormat, array_of_bytes, offset)
 
@@ -41,7 +41,7 @@ def structSize() -> int:
 
 
 class Elf32Dyns:
-    def __init__(self, array_of_bytes: bytearray, offset: int, rawSize: int):
+    def __init__(self, array_of_bytes: bytes, offset: int, rawSize: int):
         self.dyns: list[Elf32DynEntry] = list()
         self.offset: int = offset
         self.rawSize: int = rawSize

spimdisasm/elf32/Elf32File.py

@@ -21,7 +21,7 @@
 
 
 class Elf32File:
-    def __init__(self, array_of_bytes: bytearray):
+    def __init__(self, array_of_bytes: bytes):
         self.header = Elf32Header.fromBytearray(array_of_bytes)
         # print(self.header)
 
@@ -140,10 +140,10 @@ def handleFlags(self) -> None:
             common.GlobalConfig.ARCHLEVEL = common.ArchLevel.MIPS64R2
 
 
-    def _processSection_NULL(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_NULL(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         pass
 
-    def _processSection_PROGBITS(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_PROGBITS(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         fileSecType = common.FileSectionType.fromStr(sectionEntryName)
         smallFileSecType = common.FileSectionType.fromSmallStr(sectionEntryName)
 
@@ -159,23 +159,23 @@ def _processSection_PROGBITS(self, array_of_bytes: bytearray, entry: Elf32Sectio
             self.got = Elf32GlobalOffsetTable(array_of_bytes, entry.offset, entry.size)
         elif sectionEntryName == ".interp":
             # strings with names of dynamic libraries
-            common.Utils.printVerbose(f"Unhandled SYMTAB found: '{sectionEntryName}'")
+            common.Utils.printVerbose(f"Unhandled PROGBITS found: '{sectionEntryName}'")
         elif sectionEntryName == ".MIPS.stubs":
             # ?
-            common.Utils.printVerbose(f"Unhandled SYMTAB found: '{sectionEntryName}'")
+            common.Utils.printVerbose(f"Unhandled PROGBITS found: '{sectionEntryName}'")
         elif sectionEntryName == ".init":
             # ?
-            common.Utils.printVerbose(f"Unhandled SYMTAB found: '{sectionEntryName}'")
+            common.Utils.printVerbose(f"Unhandled PROGBITS found: '{sectionEntryName}'")
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint(f"Unhandled PROGBITS found: '{sectionEntryName}'", entry, "\n")
 
-    def _processSection_SYMTAB(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_SYMTAB(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".symtab":
             self.symtab = Elf32Syms(array_of_bytes, entry.offset, entry.size)
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled SYMTAB found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_STRTAB(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_STRTAB(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".strtab":
             self.strtab = Elf32StringTable(array_of_bytes, entry.offset, entry.size)
         elif sectionEntryName == ".dynstr":
@@ -185,33 +185,33 @@ def _processSection_STRTAB(self, array_of_bytes: bytearray, entry: Elf32SectionH
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled STRTAB found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_RELA(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_RELA(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_HASH(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_HASH(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_DYNAMIC(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_DYNAMIC(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".dynamic":
             self.dynamic = Elf32Dyns(array_of_bytes, entry.offset, entry.size)
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled DYNAMIC found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_NOTE(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_NOTE(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_NOBITS(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_NOBITS(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".bss":
             self.nobits = entry
         if sectionEntryName == ".sbss":
             self.nobitsSmall = entry
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled NOBITS found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_REL(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_REL(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName.startswith(".rel."):
             fileSecType = common.FileSectionType.fromStr(sectionEntryName[4:])
             if fileSecType != common.FileSectionType.Invalid:
@@ -221,53 +221,53 @@ def _processSection_REL(self, array_of_bytes: bytearray, entry: Elf32SectionHead
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled REL found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_DYNSYM(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_DYNSYM(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".dynsym":
             self.dynsym = Elf32Syms(array_of_bytes, entry.offset, entry.size)
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled DYNSYM found: ", sectionEntryName, entry, "\n")
 
 
-    def _processSection_MIPS_LIBLIST(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_LIBLIST(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_MSYM(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_MSYM(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_CONFLICT(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_CONFLICT(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_GPTAB(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_GPTAB(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_DEBUG(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_DEBUG(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_REGINFO(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_REGINFO(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         if sectionEntryName == ".reginfo":
             self.reginfo = Elf32RegInfo.fromBytearray(array_of_bytes, entry.offset)
         elif common.GlobalConfig.VERBOSE:
             common.Utils.eprint("Unhandled MIPS_REGINFO found: ", sectionEntryName, entry, "\n")
 
-    def _processSection_MIPS_OPTIONS(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_OPTIONS(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_SYMBOL_LIB(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_SYMBOL_LIB(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
-    def _processSection_MIPS_ABIFLAGS(self, array_of_bytes: bytearray, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
+    def _processSection_MIPS_ABIFLAGS(self, array_of_bytes: bytes, entry: Elf32SectionHeaderEntry, sectionEntryName: str) -> None:
         # ?
         pass
 
 
-    _sectionProcessorCallbacks: dict[int, Callable[[Elf32File, bytearray, Elf32SectionHeaderEntry, str], None]] = {
+    _sectionProcessorCallbacks: dict[int, Callable[[Elf32File, bytes, Elf32SectionHeaderEntry, str], None]] = {
         Elf32SectionHeaderType.NULL.value: _processSection_NULL,
         Elf32SectionHeaderType.PROGBITS.value: _processSection_PROGBITS,
         Elf32SectionHeaderType.SYMTAB.value: _processSection_SYMTAB,

spimdisasm/elf32/Elf32GlobalOffsetTable.py

@@ -27,7 +27,7 @@ def getAddress(self) -> int:
 
 
 class Elf32GlobalOffsetTable:
-    def __init__(self, array_of_bytes: bytearray, offset: int, rawSize: int):
+    def __init__(self, array_of_bytes: bytes, offset: int, rawSize: int):
         self.entries: list[int] = list()
         self.offset: int = offset
         self.rawSize: int = rawSize

spimdisasm/elf32/Elf32Header.py

@@ -48,7 +48,7 @@ def getPad(self) -> int:
 
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32Identifier:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32Identifier:
         identFormat = "16B"
         ident = list(struct.unpack_from(identFormat, array_of_bytes, 0 + offset))
 
@@ -90,7 +90,7 @@ class Elf32Header:
                                             # 0x34
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32Header:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32Header:
         identifier = Elf32Identifier.fromBytearray(array_of_bytes, offset)
 
         dataEncoding = identifier.getDataEncoding()

spimdisasm/elf32/Elf32RegInfo.py

@@ -19,7 +19,7 @@ class Elf32RegInfo:
                                          # 0x18
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32RegInfo:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32RegInfo:
         gprFormat = common.GlobalConfig.ENDIAN.toFormatString() + "I"
         gpr = struct.unpack_from(gprFormat, array_of_bytes, 0 + offset)[0]
         # print(gpr)

spimdisasm/elf32/Elf32Rels.py

@@ -26,15 +26,15 @@ def rType(self):
         return self.info & 0xFF
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32RelEntry:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32RelEntry:
         entryFormat = common.GlobalConfig.ENDIAN.toFormatString() + "II"
         unpacked = struct.unpack_from(entryFormat, array_of_bytes, offset)
 
         return Elf32RelEntry(*unpacked)
 
 
 class Elf32Rels:
-    def __init__(self, sectionName: str, array_of_bytes: bytearray, offset: int, rawSize: int):
+    def __init__(self, sectionName: str, array_of_bytes: bytes, offset: int, rawSize: int):
         self.sectionName = sectionName
         self.relocations: list[Elf32RelEntry] = list()
         self.offset: int = offset

spimdisasm/elf32/Elf32SectionHeaders.py

@@ -29,15 +29,15 @@ class Elf32SectionHeaderEntry:
                                 # 0x28
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32SectionHeaderEntry:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32SectionHeaderEntry:
         headerFormat = common.GlobalConfig.ENDIAN.toFormatString() + "10I"
         unpacked = struct.unpack_from(headerFormat, array_of_bytes, offset)
 
         return Elf32SectionHeaderEntry(*unpacked)
 
 
 class Elf32SectionHeaders:
-    def __init__(self, array_of_bytes: bytearray, shoff: int, shnum: int):
+    def __init__(self, array_of_bytes: bytes, shoff: int, shnum: int):
         self.sections: list[Elf32SectionHeaderEntry] = list()
         self.shoff: int = shoff
         self.shnum: int = shnum

spimdisasm/elf32/Elf32StringTable.py

@@ -8,8 +8,8 @@
 
 # a.k.a. strtab (string table)
 class Elf32StringTable:
-    def __init__(self, array_of_bytes: bytearray, offset: int, rawsize: int):
-        self.strings: bytearray = array_of_bytes[offset:offset+rawsize]
+    def __init__(self, array_of_bytes: bytes, offset: int, rawsize: int):
+        self.strings: bytes = array_of_bytes[offset:offset+rawsize]
         self.offset: int = offset
         self.rawsize: int = rawsize
 

spimdisasm/elf32/Elf32Syms.py

@@ -31,7 +31,7 @@ def stType(self):
         return self.info & 0xF
 
     @staticmethod
-    def fromBytearray(array_of_bytes: bytearray, offset: int = 0) -> Elf32SymEntry:
+    def fromBytearray(array_of_bytes: bytes, offset: int = 0) -> Elf32SymEntry:
         entryFormat = common.GlobalConfig.ENDIAN.toFormatString() + "IIIBBH"
         unpacked = struct.unpack_from(entryFormat, array_of_bytes, offset)
 
@@ -43,7 +43,7 @@ def structSize() -> int:
 
 
 class Elf32Syms:
-    def __init__(self, array_of_bytes: bytearray, offset: int, rawSize: int):
+    def __init__(self, array_of_bytes: bytes, offset: int, rawSize: int):
         self.symbols: list[Elf32SymEntry] = list()
         self.offset: int = offset
         self.rawSize: int = rawSize

spimdisasm/elfObjDisasm/ElfObjDisasmInternals.py

@@ -123,7 +123,7 @@ def getOutputPath(inputPath: Path, textOutput: Path, dataOutput: Path, sectionTy
 
     return outputFilePath
 
-def getProcessedSections(context: common.Context, elfFile: elf32.Elf32File, array_of_bytes: bytearray, inputPath: Path, textOutput: Path, dataOutput: Path) -> tuple[dict[common.FileSectionType, list[mips.sections.SectionBase]], dict[common.FileSectionType, list[Path]]]:
+def getProcessedSections(context: common.Context, elfFile: elf32.Elf32File, array_of_bytes: bytes, inputPath: Path, textOutput: Path, dataOutput: Path) -> tuple[dict[common.FileSectionType, list[mips.sections.SectionBase]], dict[common.FileSectionType, list[Path]]]:
     processedSegments: dict[common.FileSectionType, list[mips.sections.SectionBase]] = dict()
     segmentPaths: dict[common.FileSectionType, list[Path]] = dict()