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.8 2005/06/14 13:25:40 joerg 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.
116 db_cmd_search(name, table, aux_tablep, aux_tablep_end, cmdp)
118 struct command *table;
119 struct command **aux_tablep;
120 struct command **aux_tablep_end;
121 struct command **cmdp; /* out */
124 struct command **aux_cmdp;
125 int result = CMD_NONE;
127 for (cmd = table; cmd->name != 0; cmd++) {
134 while ((c = *lp) == *rp) {
144 /* end of name, not end of command -
146 if (result == CMD_FOUND) {
147 result = CMD_AMBIGUOUS;
148 /* but keep looking for a full match -
149 this lets us match single letters */
157 if (result == CMD_NONE && aux_tablep != 0)
158 /* XXX repeat too much code. */
159 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
165 rp = (*aux_cmdp)->name;
166 while ((c = *lp) == *rp) {
176 /* end of name, not end of command -
178 if (result == CMD_FOUND) {
179 result = CMD_AMBIGUOUS;
180 /* but keep looking for a full match -
181 this lets us match single letters */
189 if (result == CMD_NONE) {
190 /* check for 'help' */
191 if (name[0] == 'h' && name[1] == 'e'
192 && name[2] == 'l' && name[3] == 'p')
199 db_cmd_list(table, aux_tablep, aux_tablep_end)
200 struct command *table;
201 struct command **aux_tablep;
202 struct command **aux_tablep_end;
205 struct command **aux_cmdp;
207 for (cmd = table; cmd->name != 0; cmd++) {
208 db_printf("%-12s", cmd->name);
213 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
214 db_printf("%-12s", (*aux_cmdp)->name);
220 db_command(last_cmdp, cmd_table, aux_cmd_tablep, aux_cmd_tablep_end)
221 struct command **last_cmdp; /* IN_OUT */
222 struct command *cmd_table;
223 struct command **aux_cmd_tablep;
224 struct command **aux_cmd_tablep_end;
228 char modif[TOK_STRING_SIZE];
229 db_expr_t addr, count;
230 boolean_t have_addr = FALSE;
235 /* empty line repeats last command, at 'next' */
237 addr = (db_expr_t)db_next;
242 else if (t == tEXCL) {
243 db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, (char *)0);
246 else if (t != tIDENT) {
256 result = db_cmd_search(db_tok_string,
263 db_printf("No such command\n");
267 db_printf("Ambiguous\n");
271 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
277 if ((cmd_table = cmd->more) != 0) {
278 /* XXX usually no more aux's. */
280 if (cmd_table == db_show_cmds) {
281 aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
282 aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
287 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
294 if ((cmd->flag & CS_OWN) == 0) {
297 * command [/modifier] [addr] [,count]
302 if (t != tIDENT && t != tNUMBER) {
303 db_printf("Bad modifier\n");
307 db_strcpy(modif, db_tok_string);
314 if (db_expression(&addr)) {
315 db_dot = (db_addr_t) addr;
316 db_last_addr = db_dot;
320 addr = (db_expr_t) db_dot;
325 if (!db_expression(&count)) {
326 db_printf("Count missing\n");
335 if ((cmd->flag & CS_MORE) == 0) {
343 * Execute the command.
345 (*cmd->fcn)(addr, have_addr, count, modif);
347 if (cmd->flag & CS_SET_DOT) {
349 * If command changes dot, set dot to
350 * previous address displayed (if 'ed' style).
361 * If command does not change dot,
362 * set 'next' location to be the same.
373 static struct command db_show_all_cmds[] = {
375 { "threads", db_show_all_threads, 0, 0 },
377 { "procs", db_ps, 0, 0 },
381 static struct command db_show_cmds[] = {
382 { "all", 0, 0, db_show_all_cmds },
383 { "registers", db_show_regs, 0, 0 },
384 { "breaks", db_listbreak_cmd, 0, 0 },
386 { "thread", db_show_one_thread, 0, 0 },
389 { "port", ipc_port_print, 0, 0 },
394 static struct command db_command_table[] = {
395 { "print", db_print_cmd, 0, 0 },
396 { "p", db_print_cmd, 0, 0 },
397 { "examine", db_examine_cmd, CS_SET_DOT, 0 },
398 { "x", db_examine_cmd, CS_SET_DOT, 0 },
399 { "search", db_search_cmd, CS_OWN|CS_SET_DOT, 0 },
400 { "set", db_set_cmd, CS_OWN, 0 },
401 { "write", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
402 { "w", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
403 { "delete", db_delete_cmd, 0, 0 },
404 { "d", db_delete_cmd, 0, 0 },
405 { "break", db_breakpoint_cmd, 0, 0 },
406 { "dwatch", db_deletewatch_cmd, 0, 0 },
407 { "watch", db_watchpoint_cmd, CS_MORE,0 },
408 { "dhwatch", db_deletehwatch_cmd, 0, 0 },
409 { "hwatch", db_hwatchpoint_cmd, 0, 0 },
410 { "step", db_single_step_cmd, 0, 0 },
411 { "s", db_single_step_cmd, 0, 0 },
412 { "continue", db_continue_cmd, 0, 0 },
413 { "c", db_continue_cmd, 0, 0 },
414 { "until", db_trace_until_call_cmd,0, 0 },
415 { "next", db_trace_until_matching_cmd,0, 0 },
416 { "match", db_trace_until_matching_cmd,0, 0 },
417 { "trace", db_stack_trace_cmd, 0, 0 },
418 { "where", db_stack_trace_cmd, 0, 0 },
419 { "call", db_fncall, CS_OWN, 0 },
420 { "show", 0, 0, db_show_cmds },
421 { "ps", db_ps, 0, 0 },
422 { "gdb", db_gdb, 0, 0 },
423 { "reset", db_reset, 0, 0 },
427 static struct command *db_last_command = 0;
433 struct command *cmd = db_command_table;
435 while (cmd->name != 0) {
436 db_printf("%-12s", cmd->name);
444 * At least one non-optional command must be implemented using
445 * DB_COMMAND() so that db_cmd_set gets created. Here is one.
447 DB_COMMAND(panic, db_panic)
449 panic("from debugger");
456 * Initialize 'prev' and 'next' to dot.
461 db_cmd_loop_done = 0;
462 while (!db_cmd_loop_done) {
464 (void) setjmp(db_jmpbuf);
465 if (db_print_position() != 0)
469 (void) db_read_line();
471 db_command(&db_last_command, db_command_table,
472 SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
483 longjmp(db_jmpbuf, 1);
488 * Call random function:
492 db_fncall(dummy1, dummy2, dummy3, dummy4)
499 #define MAXARGS 11 /* XXX only 10 are passed */
500 db_expr_t args[MAXARGS];
503 typedef db_expr_t fcn_10args_t (db_expr_t, db_expr_t, db_expr_t,
504 db_expr_t, db_expr_t, db_expr_t,
505 db_expr_t, db_expr_t, db_expr_t,
510 if (!db_expression(&fn_addr)) {
511 db_printf("Bad function\n");
515 func = (fcn_10args_t *)fn_addr; /* XXX */
519 if (db_expression(&args[0])) {
521 while ((t = db_read_token()) == tCOMMA) {
522 if (nargs == MAXARGS) {
523 db_printf("Too many arguments\n");
527 if (!db_expression(&args[nargs])) {
528 db_printf("Argument missing\n");
536 if (db_read_token() != tRPAREN) {
544 while (nargs < MAXARGS) {
548 retval = (*func)(args[0], args[1], args[2], args[3], args[4],
549 args[5], args[6], args[7], args[8], args[9] );
550 db_printf("%#lr\n", (long)retval);
553 /* Enter GDB remote protocol debugger on the next trap. */
555 dev_t gdbdev = NODEV;
560 db_gdb (dummy1, dummy2, dummy3, dummy4)
567 if (gdbdev == NODEV) {
568 db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
569 db_printf("in your configuration file (currently sio only).\n");
574 db_printf("Next trap will enter %s\n",
575 boothowto & RB_GDB ? "GDB remote protocol mode"