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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
from getch import getche
from .emu import Machine
from dataclasses import dataclass
@dataclass
class DbgAddrInfo:
src_info: str
text: str
original_text: str
labels: list[str]
def try_parse_num(s: str) -> int | None:
if s.startswith("0x"):
return int(s[2:], 16)
elif s.startswith("0b"):
return int(s[2:], 2)
elif s.isdigit():
return int(s)
else:
return None
class Debugger:
def __init__(self):
self.rom_image = None
self.breakpoints: set[int] = set()
self.machine = Machine()
self.machine.reset()
self.machine.run()
self.dbg_addr_info: dict[int, DbgAddrInfo] = {}
def load_rom_image(self, rom_image_path: str) -> None:
self.rom_image_path = rom_image_path
with open(rom_image_path, "rb") as f:
self.rom_image = bytearray(f.read())
self.machine.load_rom_image(self.rom_image)
print(f"Loaded ROM image from \"{rom_image_path}\".")
dbg_symbols_path = rom_image_path + ".dbg"
try:
with open(dbg_symbols_path, "r") as f:
dbg_file_lines = f.readlines()
except FileNotFoundError:
print(f"Note: debug symbols file \"{dbg_symbols_path}\" not found.")
return
self.dbg_addr_info = {}
self.dbg_text_col_width = 0
self.dbg_original_text_col_width = 0
for line in dbg_file_lines:
addr, src_info, text, original_text, *labels_ = line.split(";")
addr = int(addr, 16)
if len(text) > self.dbg_text_col_width:
self.dbg_text_col_width = len(text)
if len(original_text) > self.dbg_original_text_col_width:
self.dbg_original_text_col_width = len(original_text)
labels = []
for label in labels_:
label = label.strip()
if label != "":
labels.append(label)
self.dbg_addr_info[addr] = DbgAddrInfo(
src_info=src_info,
text=text,
original_text=original_text,
labels=labels,
)
print(f"Loaded debug info for from \"{dbg_symbols_path}\".")
def query_breakpoint(self) -> int | None:
input_ = input("Breakpoint address: ")
as_number = try_parse_num(input_)
if input_ == "":
return None
# address breakpoint
if as_number is not None:
return as_number
# line breakpoint
if ":" in input_:
file_name, line_num = input_.strip().split(":")
for addr, dbg_info in self.dbg_addr_info.items():
if dbg_info.src_info == f"{file_name}:{line_num}":
return addr
return None
# label breakpoint
for addr, dbg_info in self.dbg_addr_info.items():
if input_ in dbg_info.labels:
return addr
def print_breakpoints(self):
for addr in self.breakpoints:
if addr in self.dbg_addr_info and len(self.dbg_addr_info[addr].labels) > 0:
label_suffix = f" [{' '.join(self.dbg_addr_info[addr].labels)}] ({self.dbg_addr_info[addr].src_info})"
else:
label_suffix = ""
print(f" 0x{addr:>04x}{label_suffix}")
if len(self.breakpoints) == 0:
print("<no breakpoints>")
print()
def print_pc_context(self):
print("=== Program context")
for i in range(-4, 5):
addr = self.machine.pc.value + i
if addr < 0 or addr >= 64 * 2 ** 16:
continue
if i == 0:
print(f"> 0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}", end="")
else:
print(f" 0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}", end="")
if addr in self.dbg_addr_info:
dbg_info = self.dbg_addr_info[addr]
labels: str = f"[{' '.join(dbg_info.labels)}] " if len(dbg_info.labels) > 0 else ""
print(f" {dbg_info.text:<{self.dbg_text_col_width}} {dbg_info.original_text:<{self.dbg_original_text_col_width}} {labels}({dbg_info.src_info})")
else:
print()
print()
def activate(self):
print("=== ATK16 debugger ===")
print("Press ? to show command help. Press q to quit.")
print()
while True:
self.print_pc_context()
print("dbg> ", end="", flush=True)
cmd = getche()
print()
if cmd == "q":
break
elif cmd == "?":
self.print_help()
elif cmd == "l":
load_path = input(f"Path to ROM image [default: {self.rom_image_path}]: ")
if load_path.strip() == "":
load_path = self.rom_image_path
self.load_rom_image(load_path)
self.machine.reset()
self.machine.run()
print("Machine reset.")
elif cmd == "r":
while self.machine.running:
self.machine.step()
if self.machine.pc.value in self.breakpoints:
for addr in self.breakpoints:
if addr in self.dbg_addr_info and len(self.dbg_addr_info[addr].labels) > 0:
label_suffix = f" [{' '.join(self.dbg_addr_info[addr].labels)}] ({self.dbg_addr_info[addr].src_info})"
else:
label_suffix = ""
print(f"Breakpoint hit at 0x{self.machine.pc.value:>04x}{label_suffix}")
break
if not self.machine.running:
print("Machine halted.")
elif cmd == "b":
print("Set breakpoints:")
self.print_breakpoints()
addr = self.query_breakpoint()
if addr is None:
print("Cancelled")
continue
if type(addr) != int or addr < 0 or addr >= 64 * 2 ** 16:
print("Invalid address")
if addr in self.breakpoints:
self.breakpoints.remove(addr)
print(f"Removed breakpoint at 0x{addr:>04x}")
else:
self.breakpoints.add(addr)
elif cmd == "n":
if not self.machine.running:
print("Machine halted.")
continue
self.machine.step()
if not self.machine.running:
print("Machine halted.")
elif cmd == "s":
self.machine.print_state_summary()
elif cmd == "0":
self.machine.reset()
self.machine.run()
print("Machine reset.")
else:
print(f"Unknown command: {cmd}")
def print_help(self):
print("Debugger commands:")
print(" r run until next breakpoint or until halted")
print(" n step forward")
print(" b step backward")
print(" b set or remove breakpoint")
print(" s show state summary")
print(" 0 reset machine state")
print(" l load ROM image and reset machine state")
print(" q quit")
print(" ? show this help")
print()
|
