forked from n64decomp/sm64
-
Notifications
You must be signed in to change notification settings - Fork 2
/
first-diff.py
executable file
·196 lines (177 loc) · 6.32 KB
/
first-diff.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
#!/usr/bin/env python3
import sys
import os.path
lang = None
# TODO: -S argument for shifted ROMs
args = []
for arg in sys.argv[1:]:
if arg == '-j':
lang = 'jp'
elif arg == '-u':
lang = 'us'
elif arg == '-e':
lang = 'eu'
else:
args.append(arg)
if lang is None:
lang = 'us'
best = 0
for path in ['build/us/sm64.us.z64', 'build/jp/sm64.jp.z64', 'build/eu/sm64.eu.z64']:
try:
mtime = os.path.getmtime(path)
if mtime > best:
best = mtime
lang = path.split('/')[1]
except Exception:
pass
print("Assuming language " + lang)
baseimg = 'baserom.' + lang + '.z64'
basemap = 'sm64.' + lang + '.map'
myimg = 'build/' + lang + '/sm64.' + lang + '.z64'
mymap = 'build/' + lang + '/sm64.' + lang + '.map'
if os.path.isfile('expected/' + mymap):
basemap = 'expected/' + mymap
required_files = [baseimg, myimg, mymap]
if any(not os.path.isfile(path) for path in required_files):
print(', '.join(required_files[:-1]) + " and " + required_files[-1] + " must exist.")
exit(1)
mybin = open(myimg, 'rb').read()
basebin = open(baseimg, 'rb').read()
if len(mybin) != len(basebin):
print("Modified ROM has different size...")
exit(1)
def search_map(rom_addr):
ram_offset = None
last_ram = 0
last_rom = 0
last_fn = '<start of rom>'
last_file = '<no file>'
prev_line = ''
with open(mymap) as f:
for line in f:
if 'load address' in line:
# Example: ".boot 0x0000000004000000 0x1000 load address 0x0000000000000000"
if 'noload' in line or 'noload' in prev_line:
ram_offset = None
continue
ram = int(line[16:16+18], 0)
rom = int(line[59:59+18], 0)
ram_offset = ram - rom
continue
prev_line = line
if ram_offset is None or '=' in line or '*fill*' in line or ' 0x' not in line:
continue
ram = int(line[16:16+18], 0)
rom = ram - ram_offset
fn = line.split()[-1]
if '0x' in fn:
ram_offset = None
continue
if rom > rom_addr or (rom_addr & 0x80000000 and ram > rom_addr):
return 'in {} (ram 0x{:08x}, rom 0x{:x}, {})'.format(last_fn, last_ram, last_rom, last_file)
last_ram = ram
last_rom = rom
last_fn = fn
if '/' in fn:
last_file = fn
return 'at end of rom?'
def parse_map(fname):
ram_offset = None
cur_file = '<no file>'
syms = {}
prev_sym = None
prev_line = ''
with open(fname) as f:
for line in f:
if 'load address' in line:
if 'noload' in line or 'noload' in prev_line:
ram_offset = None
continue
ram = int(line[16:16+18], 0)
rom = int(line[59:59+18], 0)
ram_offset = ram - rom
continue
prev_line = line
if ram_offset is None or '=' in line or '*fill*' in line or ' 0x' not in line:
continue
ram = int(line[16:16+18], 0)
rom = ram - ram_offset
fn = line.split()[-1]
if '0x' in fn:
ram_offset = None
elif '/' in fn:
cur_file = fn
else:
syms[fn] = (rom, cur_file, prev_sym, ram)
prev_sym = fn
return syms
def map_diff():
map1 = parse_map(mymap)
map2 = parse_map(basemap)
min_ram = None
found = None
for sym, addr in map1.items():
if sym not in map2:
continue
if addr[0] != map2[sym][0]:
if min_ram is None or addr[0] < min_ram:
min_ram = addr[0]
found = (sym, addr[1], addr[2])
if min_ram is None:
return False
else:
print()
print("Map appears to have shifted just before {} ({}) -- in {}?".format(found[0], found[1], found[2]))
if found[2] is not None and found[2] not in map2:
print()
print("(Base map file {} out of date due to renamed symbols, so result may be imprecise.)".format(basemap))
return True
def hexbytes(bs):
return ":".join("{:02x}".format(c) for c in bs)
# For convenience, allow `./first-diff.py <ROM addr | RAM addr | function name>`
# to do a symbol <-> address lookup. This should really be split out into a
# separate script...
if args:
try:
addr = int(args[0], 0)
print(args[0], "is", search_map(addr))
except ValueError:
m = parse_map(mymap)
try:
print(args[0], "is at position", hex(m[args[0]][0]), "in ROM,", hex(m[args[0]][3]), "in RAM")
except KeyError:
print("function", args[0], "not found")
exit()
found_instr_diff = None
diffs = 0
shift_cap = 1000
for i in range(24, len(mybin), 4):
# (mybin[i:i+4] != basebin[i:i+4], but that's slightly slower in CPython...)
if diffs <= shift_cap and (mybin[i] != basebin[i] or mybin[i+1] != basebin[i+1] or mybin[i+2] != basebin[i+2] or mybin[i+3] != basebin[i+3]):
if diffs == 0:
print("First difference at ROM addr " + hex(i) + ", " + search_map(i))
print("Bytes:", hexbytes(mybin[i:i+4]), 'vs', hexbytes(basebin[i:i+4]))
diffs += 1
if found_instr_diff is None and mybin[i] >> 2 != basebin[i] >> 2:
found_instr_diff = i
if diffs == 0:
print("No differences!")
exit()
definite_shift = (diffs > shift_cap)
if not definite_shift:
print(str(diffs) + " differing word(s).")
if diffs > 100:
if found_instr_diff is not None:
i = found_instr_diff
print("First instruction difference at ROM addr " + hex(i) + ", " + search_map(i))
print("Bytes:", hexbytes(mybin[i:i+4]), 'vs', hexbytes(basebin[i:i+4]))
if lang == 'eu':
print("Shifted ROM, as expected.")
else:
if not os.path.isfile(basemap):
if definite_shift:
print("Tons of differences, must be a shifted ROM.")
print("To find ROM shifts, copy a clean .map file to " + basemap + " and rerun this script.")
exit()
if not map_diff():
print("No ROM shift{}.".format(" (!?)" if definite_shift else ""))