sf64/first_diff.py
Alejandro Asenjo Nitti 410a5b017b
fox_versus decompiled, introduce first_diff.py to the project, fixed fox_option NON_MATCHING build (#71)
* fox_versus functions

* more functions

* more input!

* functions so far

* fix bss reordering

* all functions matching

* fix caller addresses

* import data cleanup

* introduce first_diff to the project

* fix wrong type

* second version of bss reordering prevention header

* move versus symbols to variables.h

* BSS importing attempt (failed)
terrain is prepared for another contributor to try

* fix fox_option NON_MATCHING build

* format

* remove static keyword from fox_map data symbols

* IMPORT BSS

* rename fox_versus

* FIX ADDRESSES & SYMBOLS y fox map

* fix more addresses

* more address fixes for fox_map

* all fox_map addresses done

* fix bss build in fox_map, migration pending

* bss reorder failed attempt

* remove unused externs

* remove unnecessary config file

* remove unnecessary entries in settings.json

* comments

* move structs to fox_map header

* put static back in fox_option data

* PR review
2024-01-10 11:55:08 -06:00

59 lines
2.1 KiB
Python
Executable File

#!/usr/bin/env python3
import argparse
from pathlib import Path
try:
import rabbitizer
except ImportError:
print("Missing dependency rabbitizer, install it with `python3 -m pip install 'rabbitizer>=1.0.0,<2.0.0'`")
exit(1)
try:
import mapfile_parser
except ImportError:
print("Missing dependency mapfile_parser, install it with `python3 -m pip install 'mapfile-parser>=1.2.1,<2.0.0'`")
exit(1)
def decodeInstruction(bytesDiff: bytes, mapFile: mapfile_parser.MapFile) -> str:
word = (bytesDiff[0] << 24) | (bytesDiff[1] << 16) | (bytesDiff[2] << 8) | (bytesDiff[3] << 0)
instr = rabbitizer.Instruction(word)
immOverride = None
if instr.isJumpWithAddress():
# Instruction is a function call (jal)
# Get the embedded address of the function call
symAddress = instr.getInstrIndexAsVram()
# Search for the address in the mapfile
symInfo = mapFile.findSymbolByVramOrVrom(symAddress)
if symInfo is not None:
# Use the symbol from the mapfile instead of a raw value
immOverride = symInfo.symbol.name
return instr.disassemble(immOverride=immOverride, extraLJust=-20)
def firstDiffMain():
parser = argparse.ArgumentParser(description="Find the first difference(s) between the built ROM and the base ROM.")
parser.add_argument("-c", "--count", type=int, default=5, help="find up to this many instruction difference(s)")
parser.add_argument("-v", "--version", help="Which version should be processed", default="us.rev1")
parser.add_argument("-a", "--add-colons", action='store_true', help="Add colon between bytes" )
args = parser.parse_args()
buildFolder = Path("build")
BUILTROM = Path(buildFolder / f"starfox64.us.uncompressed.z64")
BUILTMAP = buildFolder / f"starfox64.us.map"
EXPECTEDROM = Path("baserom.us.uncompressed.z64")
EXPECTEDMAP = "expected" / BUILTMAP
mapfile_parser.frontends.first_diff.doFirstDiff(BUILTMAP, EXPECTEDMAP, BUILTROM, EXPECTEDROM, args.count, mismatchSize=True, addColons=args.add_colons, bytesConverterCallback=decodeInstruction)
if __name__ == "__main__":
firstDiffMain()