2 * Mach Operating System
3 * Copyright (c) 1991,1990 Carnegie Mellon University
6 * Permission to use, copy, modify and distribute this software and its
7 * documentation is hereby granted, provided that both the copyright
8 * notice and this permission notice appear in all copies of the
9 * software, derivative works or modified versions, and any portions
10 * thereof, and that both notices appear in supporting documentation.
12 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
13 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
16 * Carnegie Mellon requests users of this software to return to
18 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 * School of Computer Science
20 * Carnegie Mellon University
21 * Pittsburgh PA 15213-3890
23 * any improvements or extensions that they make and grant Carnegie the
24 * rights to redistribute these changes.
26 * $FreeBSD: src/sys/ddb/db_command.c,v 1.34.2.2 2001/07/29 22:48:36 kris Exp $
27 * $DragonFly: src/sys/ddb/db_command.c,v 1.12 2007/05/07 05:21:38 dillon Exp $
31 * Author: David B. Golub, Carnegie Mellon University
38 #include <sys/param.h>
39 #include <sys/linker_set.h>
40 #include <sys/reboot.h>
41 #include <sys/systm.h>
45 #include <ddb/db_command.h>
46 #include <ddb/db_lex.h>
47 #include <ddb/db_output.h>
49 #include <machine/md_var.h> /* needed for db_reset() */
54 * Exported global variables
56 boolean_t db_cmd_loop_done;
59 db_addr_t db_last_addr;
63 SET_DECLARE(db_cmd_set, struct command);
64 SET_DECLARE(db_show_cmd_set, struct command);
66 static db_cmdfcn_t db_fncall;
67 static db_cmdfcn_t db_gdb;
68 static db_cmdfcn_t db_reset;
70 static struct command db_show_cmds[];
73 * if 'ed' style: 'dot' is set at start of last item printed,
74 * and '+' points to next line.
75 * Otherwise: 'dot' points to next item, '..' points to last.
77 static boolean_t db_ed_style = TRUE;
80 * Utility routine - discard tokens through end-of-line.
92 * Results of command search.
97 #define CMD_AMBIGUOUS 3
100 static void db_cmd_list (struct command *table,
101 struct command **aux_tablep,
102 struct command **aux_tablep_end);
103 static int db_cmd_search (char *name, struct command *table,
104 struct command **aux_tablep,
105 struct command **aux_tablep_end,
106 struct command **cmdp);
107 static void db_command (struct command **last_cmdp,
108 struct command *cmd_table,
109 struct command **aux_cmd_tablep,
110 struct command **aux_cmd_tablep_end);
113 * Search for command prefix.
119 db_cmd_search(char *name, struct command *table, struct command **aux_tablep,
120 struct command **aux_tablep_end, struct command **cmdp)
123 struct command **aux_cmdp;
124 int result = CMD_NONE;
126 for (cmd = table; cmd->name != 0; cmd++) {
133 while ((c = *lp) == *rp) {
143 /* end of name, not end of command -
145 if (result == CMD_FOUND) {
146 result = CMD_AMBIGUOUS;
147 /* but keep looking for a full match -
148 this lets us match single letters */
156 if (result == CMD_NONE && aux_tablep != 0)
157 /* XXX repeat too much code. */
158 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
164 rp = (*aux_cmdp)->name;
165 while ((c = *lp) == *rp) {
175 /* end of name, not end of command -
177 if (result == CMD_FOUND) {
178 result = CMD_AMBIGUOUS;
179 /* but keep looking for a full match -
180 this lets us match single letters */
188 if (result == CMD_NONE) {
189 /* check for 'help' */
190 if (name[0] == 'h' && name[1] == 'e'
191 && name[2] == 'l' && name[3] == 'p')
198 db_cmd_list(struct command *table, struct command **aux_tablep,
199 struct command **aux_tablep_end)
202 struct command **aux_cmdp;
204 for (cmd = table; cmd->name != 0; cmd++) {
205 db_printf("%-12s", cmd->name);
210 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
211 db_printf("%-12s", (*aux_cmdp)->name);
221 db_command(struct command **last_cmdp, struct command *cmd_table,
222 struct command **aux_cmd_tablep, struct command **aux_cmd_tablep_end)
226 char modif[TOK_STRING_SIZE];
227 db_expr_t addr, count;
228 boolean_t have_addr = FALSE;
234 /* empty line repeats last command, at 'next' */
236 addr = (db_expr_t)db_next;
241 else if (t == tEXCL) {
242 db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, NULL);
245 else if (t != tIDENT) {
255 result = db_cmd_search(db_tok_string,
262 db_printf("No such command\n");
266 db_printf("Ambiguous\n");
270 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
276 if ((cmd_table = cmd->more) != 0) {
277 /* XXX usually no more aux's. */
279 if (cmd_table == db_show_cmds) {
280 aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
281 aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
286 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
293 if ((cmd->flag & CS_OWN) == 0) {
296 * command [/modifier] [addr] [,count]
301 if (t != tIDENT && t != tNUMBER) {
302 db_printf("Bad modifier\n");
306 db_strcpy(modif, db_tok_string);
313 if (db_expression(&addr)) {
314 db_dot = (db_addr_t) addr;
315 db_last_addr = db_dot;
319 addr = (db_expr_t) db_dot;
324 if (!db_expression(&count)) {
325 db_printf("Count missing\n");
334 if ((cmd->flag & CS_MORE) == 0) {
342 * Execute the command.
344 (*cmd->fcn)(addr, have_addr, count, modif);
346 if (cmd->flag & CS_SET_DOT) {
348 * If command changes dot, set dot to
349 * previous address displayed (if 'ed' style).
360 * If command does not change dot,
361 * set 'next' location to be the same.
372 static struct command db_show_all_cmds[] = {
374 { "threads", db_show_all_threads, 0, 0 },
376 { "procs", db_ps, 0, 0 },
380 static struct command db_show_cmds[] = {
381 { "all", 0, 0, db_show_all_cmds },
382 { "registers", db_show_regs, 0, 0 },
383 { "breaks", db_listbreak_cmd, 0, 0 },
385 { "thread", db_show_one_thread, 0, 0 },
388 { "port", ipc_port_print, 0, 0 },
393 static struct command db_command_table[] = {
394 { "print", db_print_cmd, 0, 0 },
395 { "p", db_print_cmd, 0, 0 },
396 { "examine", db_examine_cmd, CS_SET_DOT, 0 },
397 { "x", db_examine_cmd, CS_SET_DOT, 0 },
398 { "search", db_search_cmd, CS_OWN|CS_SET_DOT, 0 },
399 { "set", db_set_cmd, CS_OWN, 0 },
400 { "write", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
401 { "w", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
402 { "delete", db_delete_cmd, 0, 0 },
403 { "d", db_delete_cmd, 0, 0 },
404 { "break", db_breakpoint_cmd, 0, 0 },
405 { "dwatch", db_deletewatch_cmd, 0, 0 },
406 { "watch", db_watchpoint_cmd, CS_MORE,0 },
407 { "dhwatch", db_deletehwatch_cmd, 0, 0 },
408 { "hwatch", db_hwatchpoint_cmd, 0, 0 },
409 { "step", db_single_step_cmd, 0, 0 },
410 { "s", db_single_step_cmd, 0, 0 },
411 { "continue", db_continue_cmd, 0, 0 },
412 { "c", db_continue_cmd, 0, 0 },
413 { "until", db_trace_until_call_cmd,0, 0 },
414 { "next", db_trace_until_matching_cmd,0, 0 },
415 { "match", db_trace_until_matching_cmd,0, 0 },
416 { "trace", db_stack_trace_cmd, 0, 0 },
417 { "where", db_stack_trace_cmd, 0, 0 },
418 { "call", db_fncall, CS_OWN, 0 },
419 { "show", 0, 0, db_show_cmds },
420 { "ps", db_ps, 0, 0 },
421 { "gdb", db_gdb, 0, 0 },
422 { "reset", db_reset, 0, 0 },
426 static struct command *db_last_command = 0;
432 struct command *cmd = db_command_table;
434 while (cmd->name != 0) {
435 db_printf("%-12s", cmd->name);
443 * At least one non-optional command must be implemented using
444 * DB_COMMAND() so that db_cmd_set gets created. Here is one.
446 DB_COMMAND(panic, db_panic)
448 panic("from debugger");
452 db_command_loop(void)
455 * Initialize 'prev' and 'next' to dot.
460 db_cmd_loop_done = 0;
461 while (!db_cmd_loop_done) {
464 if (db_print_position() != 0)
470 db_command(&db_last_command, db_command_table,
471 SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
481 longjmp(db_jmpbuf, 1);
486 * Call random function:
490 db_fncall(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
493 #define MAXARGS 11 /* XXX only 10 are passed */
494 db_expr_t args[MAXARGS];
497 typedef db_expr_t fcn_10args_t (db_expr_t, db_expr_t, db_expr_t,
498 db_expr_t, db_expr_t, db_expr_t,
499 db_expr_t, db_expr_t, db_expr_t,
504 if (!db_expression(&fn_addr)) {
505 db_printf("Bad function\n");
509 func = (fcn_10args_t *)fn_addr; /* XXX */
513 if (db_expression(&args[0])) {
515 while ((t = db_read_token()) == tCOMMA) {
516 if (nargs == MAXARGS) {
517 db_printf("Too many arguments\n");
521 if (!db_expression(&args[nargs])) {
522 db_printf("Argument missing\n");
530 if (db_read_token() != tRPAREN) {
538 while (nargs < MAXARGS) {
542 retval = (*func)(args[0], args[1], args[2], args[3], args[4],
543 args[5], args[6], args[7], args[8], args[9] );
544 db_printf("%#lr\n", (long)retval);
547 /* Enter GDB remote protocol debugger on the next trap. */
550 db_gdb(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
552 if (gdb_tab == NULL) {
553 db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
554 db_printf("in your configuration file (currently sio only).\n");
559 db_printf("Next trap will enter %s\n",
560 boothowto & RB_GDB ? "GDB remote protocol mode"
565 db_reset(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char * dummy4)