src/debugger/cli-debugger.c (view raw)
1/* Copyright (c) 2013-2014 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#include <mgba/internal/debugger/cli-debugger.h>
7
8#include <mgba/internal/debugger/symbols.h>
9
10#include <mgba/core/core.h>
11#include <mgba/core/version.h>
12#include <mgba/internal/debugger/parser.h>
13#include <mgba-util/string.h>
14
15#if ENABLE_SCRIPTING
16#include <mgba/core/scripting.h>
17#endif
18
19#if !defined(NDEBUG) && !defined(_WIN32)
20#include <signal.h>
21#endif
22
23#ifdef USE_PTHREADS
24#include <pthread.h>
25#endif
26
27const char* ERROR_MISSING_ARGS = "Arguments missing"; // TODO: share
28const char* ERROR_OVERFLOW = "Arguments overflow";
29const char* ERROR_INVALID_ARGS = "Invalid arguments";
30
31#if !defined(NDEBUG) && !defined(_WIN32)
32static void _breakInto(struct CLIDebugger*, struct CLIDebugVector*);
33#endif
34static void _continue(struct CLIDebugger*, struct CLIDebugVector*);
35static void _disassemble(struct CLIDebugger*, struct CLIDebugVector*);
36static void _next(struct CLIDebugger*, struct CLIDebugVector*);
37static void _print(struct CLIDebugger*, struct CLIDebugVector*);
38static void _printBin(struct CLIDebugger*, struct CLIDebugVector*);
39static void _printHex(struct CLIDebugger*, struct CLIDebugVector*);
40static void _printStatus(struct CLIDebugger*, struct CLIDebugVector*);
41static void _printHelp(struct CLIDebugger*, struct CLIDebugVector*);
42static void _quit(struct CLIDebugger*, struct CLIDebugVector*);
43static void _readByte(struct CLIDebugger*, struct CLIDebugVector*);
44static void _reset(struct CLIDebugger*, struct CLIDebugVector*);
45static void _readHalfword(struct CLIDebugger*, struct CLIDebugVector*);
46static void _readWord(struct CLIDebugger*, struct CLIDebugVector*);
47static void _setBreakpoint(struct CLIDebugger*, struct CLIDebugVector*);
48static void _clearBreakpoint(struct CLIDebugger*, struct CLIDebugVector*);
49static void _setWatchpoint(struct CLIDebugger*, struct CLIDebugVector*);
50static void _setReadWatchpoint(struct CLIDebugger*, struct CLIDebugVector*);
51static void _setWriteWatchpoint(struct CLIDebugger*, struct CLIDebugVector*);
52static void _trace(struct CLIDebugger*, struct CLIDebugVector*);
53static void _writeByte(struct CLIDebugger*, struct CLIDebugVector*);
54static void _writeHalfword(struct CLIDebugger*, struct CLIDebugVector*);
55static void _writeRegister(struct CLIDebugger*, struct CLIDebugVector*);
56static void _writeWord(struct CLIDebugger*, struct CLIDebugVector*);
57static void _dumpByte(struct CLIDebugger*, struct CLIDebugVector*);
58static void _dumpHalfword(struct CLIDebugger*, struct CLIDebugVector*);
59static void _dumpWord(struct CLIDebugger*, struct CLIDebugVector*);
60#ifdef ENABLE_SCRIPTING
61static void _source(struct CLIDebugger*, struct CLIDebugVector*);
62#endif
63
64static struct CLIDebuggerCommandSummary _debuggerCommands[] = {
65 { "b", _setBreakpoint, "Is", "Set a breakpoint" },
66 { "break", _setBreakpoint, "Is", "Set a breakpoint" },
67 { "c", _continue, "", "Continue execution" },
68 { "continue", _continue, "", "Continue execution" },
69 { "d", _clearBreakpoint, "I", "Delete a breakpoint or watchpoint" },
70 { "delete", _clearBreakpoint, "I", "Delete a breakpoint or watchpoint" },
71 { "dis", _disassemble, "Ii", "Disassemble instructions" },
72 { "disasm", _disassemble, "Ii", "Disassemble instructions" },
73 { "disassemble", _disassemble, "Ii", "Disassemble instructions" },
74 { "h", _printHelp, "S", "Print help" },
75 { "help", _printHelp, "S", "Print help" },
76 { "i", _printStatus, "", "Print the current status" },
77 { "info", _printStatus, "", "Print the current status" },
78 { "n", _next, "", "Execute next instruction" },
79 { "next", _next, "", "Execute next instruction" },
80 { "p", _print, "I", "Print a value" },
81 { "p/t", _printBin, "I", "Print a value as binary" },
82 { "p/x", _printHex, "I", "Print a value as hexadecimal" },
83 { "print", _print, "I", "Print a value" },
84 { "print/t", _printBin, "I", "Print a value as binary" },
85 { "print/x", _printHex, "I", "Print a value as hexadecimal" },
86 { "q", _quit, "", "Quit the emulator" },
87 { "quit", _quit, "", "Quit the emulator" },
88 { "reset", _reset, "", "Reset the emulation" },
89 { "r/1", _readByte, "I", "Read a byte from a specified offset" },
90 { "r/2", _readHalfword, "I", "Read a halfword from a specified offset" },
91 { "r/4", _readWord, "I", "Read a word from a specified offset" },
92 { "status", _printStatus, "", "Print the current status" },
93 { "trace", _trace, "I", "Trace a fixed number of instructions" },
94 { "w", _setWatchpoint, "Is", "Set a watchpoint" },
95 { "w/1", _writeByte, "II", "Write a byte at a specified offset" },
96 { "w/2", _writeHalfword, "II", "Write a halfword at a specified offset" },
97 { "w/r", _writeRegister, "SI", "Write a register" },
98 { "w/4", _writeWord, "II", "Write a word at a specified offset" },
99 { "watch", _setWatchpoint, "Is", "Set a watchpoint" },
100 { "watch/r", _setReadWatchpoint, "Is", "Set a read watchpoint" },
101 { "watch/w", _setWriteWatchpoint, "Is", "Set a write watchpoint" },
102 { "x/1", _dumpByte, "Ii", "Examine bytes at a specified offset" },
103 { "x/2", _dumpHalfword, "Ii", "Examine halfwords at a specified offset" },
104 { "x/4", _dumpWord, "Ii", "Examine words at a specified offset" },
105#ifdef ENABLE_SCRIPTING
106 { "source", _source, "S", "Load a script" },
107#endif
108#if !defined(NDEBUG) && !defined(_WIN32)
109 { "!", _breakInto, "", "Break into attached debugger (for developers)" },
110#endif
111 { 0, 0, 0, 0 }
112};
113
114#if !defined(NDEBUG) && !defined(_WIN32)
115static void _handleDeath(int sig) {
116 UNUSED(sig);
117 printf("No debugger attached!\n");
118}
119
120static void _breakInto(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
121 UNUSED(debugger);
122 UNUSED(dv);
123 struct sigaction sa, osa;
124 sa.sa_handler = _handleDeath;
125 sigemptyset(&sa.sa_mask);
126 sigaddset(&sa.sa_mask, SIGTRAP);
127 sa.sa_flags = SA_RESTART;
128 sigaction(SIGTRAP, &sa, &osa);
129#ifdef USE_PTHREADS
130 pthread_kill(pthread_self(), SIGTRAP);
131#else
132 kill(getpid(), SIGTRAP);
133#endif
134 sigaction(SIGTRAP, &osa, 0);
135}
136#endif
137
138static void _continue(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
139 UNUSED(dv);
140 debugger->d.state = DEBUGGER_RUNNING;
141}
142
143static void _next(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
144 UNUSED(dv);
145 debugger->d.core->step(debugger->d.core);
146 _printStatus(debugger, 0);
147}
148
149static void _disassemble(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
150 debugger->system->disassemble(debugger->system, dv);
151}
152
153static void _print(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
154 for (; dv; dv = dv->next) {
155 if (dv->segmentValue >= 0) {
156 debugger->backend->printf(debugger->backend, " $%02X:%04X", dv->segmentValue, dv->intValue);
157 continue;
158 }
159 debugger->backend->printf(debugger->backend, " %u", dv->intValue);
160 }
161 debugger->backend->printf(debugger->backend, "\n");
162}
163
164static void _printBin(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
165 for (; dv; dv = dv->next) {
166 debugger->backend->printf(debugger->backend, " 0b");
167 int i = 32;
168 while (i--) {
169 debugger->backend->printf(debugger->backend, "%u", (dv->intValue >> i) & 1);
170 }
171 }
172 debugger->backend->printf(debugger->backend, "\n");
173}
174
175static void _printHex(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
176 for (; dv; dv = dv->next) {
177 debugger->backend->printf(debugger->backend, " 0x%08X", dv->intValue);
178 }
179 debugger->backend->printf(debugger->backend, "\n");
180}
181
182static void _printHelp(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
183 UNUSED(dv);
184 if (!dv) {
185 debugger->backend->printf(debugger->backend, "Generic commands:\n");
186 int i;
187 for (i = 0; _debuggerCommands[i].name; ++i) {
188 debugger->backend->printf(debugger->backend, "%-10s %s\n", _debuggerCommands[i].name, _debuggerCommands[i].summary);
189 }
190 if (debugger->system) {
191 debugger->backend->printf(debugger->backend, "%s commands:\n", debugger->system->platformName);
192 for (i = 0; debugger->system->platformCommands[i].name; ++i) {
193 debugger->backend->printf(debugger->backend, "%-10s %s\n", debugger->system->platformCommands[i].name, debugger->system->platformCommands[i].summary);
194 }
195 debugger->backend->printf(debugger->backend, "%s commands:\n", debugger->system->name);
196 for (i = 0; debugger->system->commands[i].name; ++i) {
197 debugger->backend->printf(debugger->backend, "%-10s %s\n", debugger->system->commands[i].name, debugger->system->commands[i].summary);
198 }
199 }
200 } else {
201 int i;
202 for (i = 0; _debuggerCommands[i].name; ++i) {
203 if (strcmp(_debuggerCommands[i].name, dv->charValue) == 0) {
204 debugger->backend->printf(debugger->backend, " %s\n", _debuggerCommands[i].summary);
205 }
206 }
207 if (debugger->system) {
208 for (i = 0; debugger->system->platformCommands[i].name; ++i) {
209 if (strcmp(debugger->system->platformCommands[i].name, dv->charValue) == 0) {
210 debugger->backend->printf(debugger->backend, " %s\n", debugger->system->platformCommands[i].summary);
211 }
212 }
213 for (i = 0; debugger->system->commands[i].name; ++i) {
214 if (strcmp(debugger->system->commands[i].name, dv->charValue) == 0) {
215 debugger->backend->printf(debugger->backend, " %s\n", debugger->system->commands[i].summary);
216 }
217 }
218 }
219 }
220}
221
222static void _quit(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
223 UNUSED(dv);
224 debugger->d.state = DEBUGGER_SHUTDOWN;
225}
226
227static void _readByte(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
228 if (!dv || dv->type != CLIDV_INT_TYPE) {
229 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
230 return;
231 }
232 uint32_t address = dv->intValue;
233 uint8_t value;
234 if (dv->segmentValue >= 0) {
235 value = debugger->d.core->rawRead8(debugger->d.core, address, dv->segmentValue);
236 } else {
237 value = debugger->d.core->busRead8(debugger->d.core, address);
238 }
239 debugger->backend->printf(debugger->backend, " 0x%02X\n", value);
240}
241
242static void _reset(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
243 UNUSED(dv);
244 debugger->d.core->reset(debugger->d.core);
245 _printStatus(debugger, 0);
246}
247
248static void _readHalfword(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
249 if (!dv || dv->type != CLIDV_INT_TYPE) {
250 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
251 return;
252 }
253 uint32_t address = dv->intValue;
254 uint16_t value;
255 if (dv->segmentValue >= 0) {
256 value = debugger->d.core->rawRead16(debugger->d.core, address & -1, dv->segmentValue);
257 } else {
258 value = debugger->d.core->busRead16(debugger->d.core, address & ~1);
259 }
260 debugger->backend->printf(debugger->backend, " 0x%04X\n", value);
261}
262
263static void _readWord(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
264 if (!dv || dv->type != CLIDV_INT_TYPE) {
265 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
266 return;
267 }
268 uint32_t address = dv->intValue;
269 uint32_t value;
270 if (dv->segmentValue >= 0) {
271 value = debugger->d.core->rawRead32(debugger->d.core, address & -3, dv->segmentValue);
272 } else {
273 value = debugger->d.core->busRead32(debugger->d.core, address & ~3);
274 }
275 debugger->backend->printf(debugger->backend, " 0x%08X\n", value);
276}
277
278static void _writeByte(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
279 if (!dv || !dv->next) {
280 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
281 return;
282 }
283 if (dv->type != CLIDV_INT_TYPE || dv->next->type != CLIDV_INT_TYPE) {
284 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
285 return;
286 }
287 uint32_t address = dv->intValue;
288 uint32_t value = dv->next->intValue;
289 if (value > 0xFF) {
290 debugger->backend->printf(debugger->backend, "%s\n", ERROR_OVERFLOW);
291 return;
292 }
293 if (dv->segmentValue >= 0) {
294 debugger->d.core->rawWrite8(debugger->d.core, address, value, dv->segmentValue);
295 } else {
296 debugger->d.core->busWrite8(debugger->d.core, address, value);
297 }
298}
299
300static void _writeHalfword(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
301 if (!dv || !dv->next) {
302 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
303 return;
304 }
305 if (dv->type != CLIDV_INT_TYPE || dv->next->type != CLIDV_INT_TYPE) {
306 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
307 return;
308 }
309 uint32_t address = dv->intValue;
310 uint32_t value = dv->next->intValue;
311 if (value > 0xFFFF) {
312 debugger->backend->printf(debugger->backend, "%s\n", ERROR_OVERFLOW);
313 return;
314 }
315 if (dv->segmentValue >= 0) {
316 debugger->d.core->rawWrite16(debugger->d.core, address, value, dv->segmentValue);
317 } else {
318 debugger->d.core->busWrite16(debugger->d.core, address, value);
319 }
320}
321
322static void _writeRegister(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
323 if (!dv || !dv->next) {
324 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
325 return;
326 }
327 if (dv->type != CLIDV_CHAR_TYPE || dv->next->type != CLIDV_INT_TYPE) {
328 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
329 return;
330 }
331 if (!debugger->d.platform->setRegister(debugger->d.platform, dv->charValue, dv->next->intValue)) {
332 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
333 }
334}
335
336static void _writeWord(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
337 if (!dv || !dv->next) {
338 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
339 return;
340 }
341 if (dv->type != CLIDV_INT_TYPE || dv->next->type != CLIDV_INT_TYPE) {
342 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
343 return;
344 }
345 uint32_t address = dv->intValue;
346 uint32_t value = dv->next->intValue;
347 if (dv->segmentValue >= 0) {
348 debugger->d.core->rawWrite32(debugger->d.core, address, value, dv->segmentValue);
349 } else {
350 debugger->d.core->busWrite32(debugger->d.core, address, value);
351 }
352}
353
354static void _dumpByte(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
355 if (!dv || dv->type != CLIDV_INT_TYPE) {
356 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
357 return;
358 }
359 uint32_t address = dv->intValue;
360 uint32_t words = 16;
361 if (dv->next && dv->next->type == CLIDV_INT_TYPE) {
362 words = dv->next->intValue;
363 }
364 while (words) {
365 uint32_t line = 16;
366 if (line > words) {
367 line = words;
368 }
369 debugger->backend->printf(debugger->backend, "0x%08X:", address);
370 for (; line > 0; --line, ++address, --words) {
371 uint32_t value;
372 if (dv->segmentValue >= 0) {
373 value = debugger->d.core->rawRead8(debugger->d.core, address, dv->segmentValue);
374 } else {
375 value = debugger->d.core->busRead8(debugger->d.core, address);
376 }
377 debugger->backend->printf(debugger->backend, " %02X", value);
378 }
379 debugger->backend->printf(debugger->backend, "\n");
380 }
381}
382
383static void _dumpHalfword(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
384 if (!dv || dv->type != CLIDV_INT_TYPE) {
385 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
386 return;
387 }
388 uint32_t address = dv->intValue;
389 uint32_t words = 8;
390 if (dv->next && dv->next->type == CLIDV_INT_TYPE) {
391 words = dv->next->intValue;
392 }
393 while (words) {
394 uint32_t line = 8;
395 if (line > words) {
396 line = words;
397 }
398 debugger->backend->printf(debugger->backend, "0x%08X:", address);
399 for (; line > 0; --line, address += 2, --words) {
400 uint32_t value;
401 if (dv->segmentValue >= 0) {
402 value = debugger->d.core->rawRead16(debugger->d.core, address, dv->segmentValue);
403 } else {
404 value = debugger->d.core->busRead16(debugger->d.core, address);
405 }
406 debugger->backend->printf(debugger->backend, " %04X", value);
407 }
408 debugger->backend->printf(debugger->backend, "\n");
409 }
410}
411
412static void _dumpWord(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
413 if (!dv || dv->type != CLIDV_INT_TYPE) {
414 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
415 return;
416 }
417 uint32_t address = dv->intValue;
418 uint32_t words = 4;
419 if (dv->next && dv->next->type == CLIDV_INT_TYPE) {
420 words = dv->next->intValue;
421 }
422 while (words) {
423 uint32_t line = 4;
424 if (line > words) {
425 line = words;
426 }
427 debugger->backend->printf(debugger->backend, "0x%08X:", address);
428 for (; line > 0; --line, address += 4, --words) {
429 uint32_t value;
430 if (dv->segmentValue >= 0) {
431 value = debugger->d.core->rawRead32(debugger->d.core, address, dv->segmentValue);
432 } else {
433 value = debugger->d.core->busRead32(debugger->d.core, address);
434 }
435 debugger->backend->printf(debugger->backend, " %08X", value);
436 }
437 debugger->backend->printf(debugger->backend, "\n");
438 }
439}
440
441#ifdef ENABLE_SCRIPTING
442static void _source(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
443 if (!dv) {
444 debugger->backend->printf(debugger->backend, "Needs a filename\n");
445 return;
446 }
447 if (debugger->d.bridge && mScriptBridgeLoadScript(debugger->d.bridge, dv->charValue)) {
448 mScriptBridgeRun(debugger->d.bridge);
449 } else {
450 debugger->backend->printf(debugger->backend, "Failed to load script\n");
451 }
452}
453#endif
454
455static struct ParseTree* _parseTree(const char* string) {
456 struct LexVector lv;
457 bool error = false;
458 LexVectorInit(&lv, 0);
459 size_t length = strlen(string);
460 size_t adjusted = lexExpression(&lv, string, length, NULL);
461 struct ParseTree* tree = malloc(sizeof(*tree));
462 if (!adjusted) {
463 error = true;
464 } else {
465 parseLexedExpression(tree, &lv);
466
467 if (adjusted > length) {
468 error = true;
469 } else {
470 length -= adjusted;
471 string += adjusted;
472 }
473 }
474 lexFree(&lv);
475 LexVectorClear(&lv);
476 LexVectorDeinit(&lv);
477 if (error) {
478 parseFree(tree);
479 free(tree);
480 return NULL;
481 } else {
482 return tree;
483 }
484}
485
486static void _setBreakpoint(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
487 if (!dv || dv->type != CLIDV_INT_TYPE) {
488 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
489 return;
490 }
491 uint32_t address = dv->intValue;
492 if (dv->next && dv->next->type == CLIDV_CHAR_TYPE) {
493 struct ParseTree* tree = _parseTree(dv->next->charValue);
494 if (tree) {
495 debugger->d.platform->setConditionalBreakpoint(debugger->d.platform, address, dv->segmentValue, tree);
496 } else {
497 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
498 }
499 } else {
500 debugger->d.platform->setBreakpoint(debugger->d.platform, address, dv->segmentValue);
501 }
502}
503
504static void _setWatchpoint(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
505 if (!dv || dv->type != CLIDV_INT_TYPE) {
506 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
507 return;
508 }
509 if (!debugger->d.platform->setWatchpoint) {
510 debugger->backend->printf(debugger->backend, "Watchpoints are not supported by this platform.\n");
511 return;
512 }
513 uint32_t address = dv->intValue;
514 if (dv->next && dv->next->type == CLIDV_CHAR_TYPE) {
515 struct ParseTree* tree = _parseTree(dv->next->charValue);
516 if (tree) {
517 debugger->d.platform->setConditionalWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_RW, tree);
518 } else {
519 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
520 }
521 } else {
522 debugger->d.platform->setWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_RW);
523 }
524}
525
526static void _setReadWatchpoint(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
527 if (!dv || dv->type != CLIDV_INT_TYPE) {
528 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
529 return;
530 }
531 if (!debugger->d.platform->setWatchpoint) {
532 debugger->backend->printf(debugger->backend, "Watchpoints are not supported by this platform.\n");
533 return;
534 }
535 uint32_t address = dv->intValue;
536 if (dv->next && dv->next->type == CLIDV_CHAR_TYPE) {
537 struct ParseTree* tree = _parseTree(dv->next->charValue);
538 if (tree) {
539 debugger->d.platform->setConditionalWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_READ, tree);
540 } else {
541 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
542 }
543 } else {
544 debugger->d.platform->setWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_READ);
545 }
546}
547
548static void _setWriteWatchpoint(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
549 if (!dv || dv->type != CLIDV_INT_TYPE) {
550 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
551 return;
552 }
553 if (!debugger->d.platform->setWatchpoint) {
554 debugger->backend->printf(debugger->backend, "Watchpoints are not supported by this platform.\n");
555 return;
556 }
557 uint32_t address = dv->intValue;
558 if (dv->next && dv->next->type == CLIDV_CHAR_TYPE) {
559 struct ParseTree* tree = _parseTree(dv->next->charValue);
560 if (tree) {
561 debugger->d.platform->setConditionalWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_WRITE, tree);
562 } else {
563 debugger->backend->printf(debugger->backend, "%s\n", ERROR_INVALID_ARGS);
564 }
565 } else {
566 debugger->d.platform->setWatchpoint(debugger->d.platform, address, dv->segmentValue, WATCHPOINT_WRITE);
567 }}
568
569static void _clearBreakpoint(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
570 if (!dv || dv->type != CLIDV_INT_TYPE) {
571 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
572 return;
573 }
574 uint32_t address = dv->intValue;
575 debugger->d.platform->clearBreakpoint(debugger->d.platform, address, dv->segmentValue);
576 if (debugger->d.platform->clearWatchpoint) {
577 debugger->d.platform->clearWatchpoint(debugger->d.platform, address, dv->segmentValue);
578 }
579}
580
581static void _trace(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
582 if (!dv || dv->type != CLIDV_INT_TYPE) {
583 debugger->backend->printf(debugger->backend, "%s\n", ERROR_MISSING_ARGS);
584 return;
585 }
586
587 char trace[1024];
588 trace[sizeof(trace) - 1] = '\0';
589
590 int i;
591 for (i = 0; i < dv->intValue; ++i) {
592 debugger->d.core->step(debugger->d.core);
593 size_t traceSize = sizeof(trace) - 1;
594 debugger->d.platform->trace(debugger->d.platform, trace, &traceSize);
595 if (traceSize + 1 < sizeof(trace)) {
596 trace[traceSize + 1] = '\0';
597 }
598 debugger->backend->printf(debugger->backend, "%s\n", trace);
599 }
600}
601
602static void _printStatus(struct CLIDebugger* debugger, struct CLIDebugVector* dv) {
603 UNUSED(dv);
604 debugger->system->printStatus(debugger->system);
605}
606
607struct CLIDebugVector* CLIDVParse(struct CLIDebugger* debugger, const char* string, size_t length) {
608 if (!string || length < 1) {
609 return 0;
610 }
611
612 struct CLIDebugVector dvTemp = { .type = CLIDV_INT_TYPE, .segmentValue = -1 };
613
614 struct LexVector lv;
615 LexVectorInit(&lv, 0);
616 size_t adjusted = lexExpression(&lv, string, length, " ");
617 if (adjusted > length) {
618 dvTemp.type = CLIDV_ERROR_TYPE;
619 }
620
621 struct ParseTree tree;
622 parseLexedExpression(&tree, &lv);
623 if (tree.token.type == TOKEN_ERROR_TYPE) {
624 dvTemp.type = CLIDV_ERROR_TYPE;
625 } else {
626 if (!mDebuggerEvaluateParseTree(&debugger->d, &tree, &dvTemp.intValue, &dvTemp.segmentValue)) {
627 dvTemp.type = CLIDV_ERROR_TYPE;
628 }
629 }
630
631 parseFree(&tree);
632
633 lexFree(&lv);
634 LexVectorDeinit(&lv);
635
636 struct CLIDebugVector* dv = malloc(sizeof(struct CLIDebugVector));
637 if (dvTemp.type == CLIDV_ERROR_TYPE) {
638 dv->type = CLIDV_ERROR_TYPE;
639 dv->next = 0;
640 } else {
641 *dv = dvTemp;
642 }
643 return dv;
644}
645
646struct CLIDebugVector* CLIDVStringParse(struct CLIDebugger* debugger, const char* string, size_t length) {
647 UNUSED(debugger);
648 if (!string || length < 1) {
649 return 0;
650 }
651
652 struct CLIDebugVector dvTemp = { .type = CLIDV_CHAR_TYPE };
653
654 dvTemp.charValue = strndup(string, length);
655
656 struct CLIDebugVector* dv = malloc(sizeof(struct CLIDebugVector));
657 *dv = dvTemp;
658 return dv;
659}
660
661static void _DVFree(struct CLIDebugVector* dv) {
662 struct CLIDebugVector* next;
663 while (dv) {
664 next = dv->next;
665 if (dv->type == CLIDV_CHAR_TYPE) {
666 free(dv->charValue);
667 }
668 free(dv);
669 dv = next;
670 }
671}
672
673static struct CLIDebugVector* _parseArg(struct CLIDebugger* debugger, const char* args, size_t argsLen, char type) {
674 struct CLIDebugVector* dv = NULL;
675 switch (type) {
676 case 'I':
677 case 'i':
678 return CLIDVParse(debugger, args, argsLen);
679 case 'S':
680 case 's':
681 return CLIDVStringParse(debugger, args, argsLen);
682 case '*':
683 dv = _parseArg(debugger, args, argsLen, 'I');
684 if (!dv) {
685 dv = _parseArg(debugger, args, argsLen, 'S');
686 }
687 break;
688 }
689 return dv;
690}
691
692static int _tryCommands(struct CLIDebugger* debugger, struct CLIDebuggerCommandSummary* commands, const char* command, size_t commandLen, const char* args, size_t argsLen) {
693 struct CLIDebugVector* dv = NULL;
694 struct CLIDebugVector* dvLast = NULL;
695 int i;
696 const char* name;
697 for (i = 0; (name = commands[i].name); ++i) {
698 if (strlen(name) != commandLen) {
699 continue;
700 }
701 if (strncasecmp(name, command, commandLen) == 0) {
702 if (commands[i].format && args) {
703 char lastArg = '\0';
704 int arg;
705 for (arg = 0; commands[i].format[arg] && argsLen; ++arg) {
706 while (isspace(args[0]) && argsLen) {
707 ++args;
708 --argsLen;
709 }
710 if (!args[0] || !argsLen) {
711 debugger->backend->printf(debugger->backend, "Wrong number of arguments\n");
712 _DVFree(dv);
713 return 0;
714 }
715
716 size_t adjusted;
717 const char* next = strchr(args, ' ');
718 if (next) {
719 adjusted = next - args;
720 } else {
721 adjusted = argsLen;
722 }
723
724 struct CLIDebugVector* dvNext = NULL;
725 bool nextArgMandatory = false;
726
727 if (commands[i].format[arg] == '+') {
728 dvNext = _parseArg(debugger, args, adjusted, lastArg);
729 --args;
730 } else {
731 nextArgMandatory = isupper(commands[i].format[arg]) || (commands[i].format[arg] == '*');
732 dvNext = _parseArg(debugger, args, adjusted, commands[i].format[arg]);
733 }
734
735 args += adjusted;
736 argsLen -= adjusted;
737
738 if (!dvNext) {
739 if (!nextArgMandatory) {
740 args = NULL;
741 }
742 break;
743 }
744 if (dvNext->type == CLIDV_ERROR_TYPE) {
745 debugger->backend->printf(debugger->backend, "Parse error\n");
746 _DVFree(dv);
747 return 0;
748 }
749
750 if (dvLast) {
751 dvLast->next = dvNext;
752 dvLast = dvNext;
753 } else {
754 dv = dvNext;
755 dvLast = dv;
756 }
757 }
758 }
759
760 if (args) {
761 while (isspace(args[0]) && argsLen) {
762 ++args;
763 --argsLen;
764 }
765 }
766 if (args && argsLen) {
767 debugger->backend->printf(debugger->backend, "Wrong number of arguments\n");
768 _DVFree(dv);
769 return 0;
770 }
771 commands[i].command(debugger, dv);
772 _DVFree(dv);
773 return 1;
774 }
775 }
776 return -1;
777}
778
779static bool _parse(struct CLIDebugger* debugger, const char* line, size_t count) {
780 const char* firstSpace = strchr(line, ' ');
781 size_t cmdLength;
782 if (firstSpace) {
783 cmdLength = firstSpace - line;
784 } else {
785 cmdLength = count;
786 }
787
788 const char* args = 0;
789 if (firstSpace) {
790 args = firstSpace + 1;
791 }
792 int result = _tryCommands(debugger, _debuggerCommands, line, cmdLength, args, count - cmdLength - 1);
793 if (result < 0 && debugger->system) {
794 result = _tryCommands(debugger, debugger->system->commands, line, cmdLength, args, count - cmdLength - 1);
795 if (result < 0) {
796 result = _tryCommands(debugger, debugger->system->platformCommands, line, cmdLength, args, count - cmdLength - 1);
797 }
798 }
799 if (result < 0) {
800 debugger->backend->printf(debugger->backend, "Command not found\n");
801 }
802 return false;
803}
804
805static void _commandLine(struct mDebugger* debugger) {
806 struct CLIDebugger* cliDebugger = (struct CLIDebugger*) debugger;
807 const char* line;
808 size_t len;
809 _printStatus(cliDebugger, 0);
810 while (debugger->state == DEBUGGER_PAUSED) {
811 line = cliDebugger->backend->readline(cliDebugger->backend, &len);
812 if (!line || len == 0) {
813 debugger->state = DEBUGGER_SHUTDOWN;
814 return;
815 }
816 if (line[0] == '\n') {
817 line = cliDebugger->backend->historyLast(cliDebugger->backend, &len);
818 if (line && len) {
819 _parse(cliDebugger, line, len);
820 }
821 } else {
822 _parse(cliDebugger, line, len);
823 cliDebugger->backend->historyAppend(cliDebugger->backend, line);
824 }
825 }
826}
827
828static void _reportEntry(struct mDebugger* debugger, enum mDebuggerEntryReason reason, struct mDebuggerEntryInfo* info) {
829 struct CLIDebugger* cliDebugger = (struct CLIDebugger*) debugger;
830 switch (reason) {
831 case DEBUGGER_ENTER_MANUAL:
832 case DEBUGGER_ENTER_ATTACHED:
833 break;
834 case DEBUGGER_ENTER_BREAKPOINT:
835 if (info) {
836 cliDebugger->backend->printf(cliDebugger->backend, "Hit breakpoint at 0x%08X\n", info->address);
837 } else {
838 cliDebugger->backend->printf(cliDebugger->backend, "Hit breakpoint\n");
839 }
840 break;
841 case DEBUGGER_ENTER_WATCHPOINT:
842 if (info) {
843 if (info->type.wp.accessType & WATCHPOINT_WRITE) {
844 cliDebugger->backend->printf(cliDebugger->backend, "Hit watchpoint at 0x%08X: (new value = 0x%08X, old value = 0x%08X)\n", info->address, info->type.wp.newValue, info->type.wp.oldValue);
845 } else {
846 cliDebugger->backend->printf(cliDebugger->backend, "Hit watchpoint at 0x%08X: (value = 0x%08X)\n", info->address, info->type.wp.oldValue);
847 }
848 } else {
849 cliDebugger->backend->printf(cliDebugger->backend, "Hit watchpoint\n");
850 }
851 break;
852 case DEBUGGER_ENTER_ILLEGAL_OP:
853 if (info) {
854 cliDebugger->backend->printf(cliDebugger->backend, "Hit illegal opcode at 0x%08X: 0x%08X\n", info->address, info->type.bp.opcode);
855 } else {
856 cliDebugger->backend->printf(cliDebugger->backend, "Hit illegal opcode\n");
857 }
858 break;
859 }
860}
861
862static void _cliDebuggerInit(struct mDebugger* debugger) {
863 struct CLIDebugger* cliDebugger = (struct CLIDebugger*) debugger;
864 cliDebugger->backend->init(cliDebugger->backend);
865}
866
867static void _cliDebuggerDeinit(struct mDebugger* debugger) {
868 struct CLIDebugger* cliDebugger = (struct CLIDebugger*) debugger;
869 if (cliDebugger->system) {
870 if (cliDebugger->system->deinit) {
871 cliDebugger->system->deinit(cliDebugger->system);
872 }
873 free(cliDebugger->system);
874 cliDebugger->system = NULL;
875 }
876 if (cliDebugger->backend && cliDebugger->backend->deinit) {
877 cliDebugger->backend->deinit(cliDebugger->backend);
878 cliDebugger->backend = NULL;
879 }
880}
881
882static void _cliDebuggerCustom(struct mDebugger* debugger) {
883 struct CLIDebugger* cliDebugger = (struct CLIDebugger*) debugger;
884 bool retain = false;
885 if (cliDebugger->system) {
886 retain = cliDebugger->system->custom(cliDebugger->system);
887 }
888 if (!retain && debugger->state == DEBUGGER_CUSTOM) {
889 debugger->state = DEBUGGER_RUNNING;
890 }
891}
892
893void CLIDebuggerCreate(struct CLIDebugger* debugger) {
894 debugger->d.init = _cliDebuggerInit;
895 debugger->d.deinit = _cliDebuggerDeinit;
896 debugger->d.custom = _cliDebuggerCustom;
897 debugger->d.paused = _commandLine;
898 debugger->d.entered = _reportEntry;
899 debugger->d.type = DEBUGGER_CLI;
900
901 debugger->system = NULL;
902 debugger->backend = NULL;
903}
904
905void CLIDebuggerAttachSystem(struct CLIDebugger* debugger, struct CLIDebuggerSystem* system) {
906 if (debugger->system) {
907 if (debugger->system->deinit) {
908 debugger->system->deinit(debugger->system);
909 }
910 free(debugger->system);
911 }
912
913 debugger->system = system;
914 system->p = debugger;
915}
916
917void CLIDebuggerAttachBackend(struct CLIDebugger* debugger, struct CLIDebuggerBackend* backend) {
918 if (debugger->backend == backend) {
919 return;
920 }
921 if (debugger->backend && debugger->backend->deinit) {
922 debugger->backend->deinit(debugger->backend);
923 }
924
925 debugger->backend = backend;
926 backend->p = debugger;
927}
928
929bool CLIDebuggerTabComplete(struct CLIDebugger* debugger, const char* token, bool initial, size_t tokenLen) {
930 size_t cmd = 0;
931 size_t len;
932 const char* name = 0;
933 for (len = 1; len <= tokenLen; ++len) {
934 for (; (name = _debuggerCommands[cmd].name); ++cmd) {
935 int cmp = strncasecmp(name, token, len);
936 if (cmp > 0) {
937 return false;
938 }
939 if (cmp == 0) {
940 break;
941 }
942 }
943 }
944 if (!name) {
945 return false;
946 }
947 if (_debuggerCommands[cmd + 1].name && strlen(_debuggerCommands[cmd + 1].name) >= len && name[len - 1] == _debuggerCommands[cmd + 1].name[len - 1]) {
948 --len;
949 const char* next = 0;
950 int i;
951 for (i = cmd + 1; _debuggerCommands[i].name; ++i) {
952 if (strncasecmp(name, _debuggerCommands[i].name, len)) {
953 break;
954 }
955 next = _debuggerCommands[i].name;
956 }
957 if (!next) {
958 return false;
959 }
960
961 for (; name[len]; ++len) {
962 if (name[len] != next[len]) {
963 break;
964 }
965 char out[2] = { name[len], '\0' };
966 debugger->backend->lineAppend(debugger->backend, out);
967 }
968 return true;
969 }
970 name += len - 1;
971 debugger->backend->lineAppend(debugger->backend, name);
972 debugger->backend->lineAppend(debugger->backend, " ");
973 return true;
974}