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 $
30 * Author: David B. Golub, Carnegie Mellon University
37 #include <sys/param.h>
38 #include <sys/linker_set.h>
39 #include <sys/reboot.h>
40 #include <sys/systm.h>
44 #include <ddb/db_command.h>
45 #include <ddb/db_lex.h>
46 #include <ddb/db_output.h>
48 #include <machine/md_var.h> /* needed for db_reset() */
49 #include <machine/setjmp.h>
52 * Exported global variables
54 boolean_t db_cmd_loop_done;
57 db_addr_t db_last_addr;
61 SET_DECLARE(db_cmd_set, struct command);
62 SET_DECLARE(db_show_cmd_set, struct command);
64 static db_cmdfcn_t db_fncall;
65 static db_cmdfcn_t db_gdb;
66 static db_cmdfcn_t db_reset;
72 static struct command db_show_all_cmds[] = {
74 { "threads", db_show_all_threads, 0, NULL },
76 { "procs", db_ps, 0, NULL },
80 static struct command db_show_cmds[] = {
81 { "all", 0, 0, db_show_all_cmds },
82 { "registers", db_show_regs, 0, NULL },
83 { "breaks", db_listbreak_cmd, 0, NULL },
85 { "thread", db_show_one_thread, 0, NULL },
88 { "port", ipc_port_print, 0, NULL },
93 static struct command db_command_table[] = {
94 { "print", db_print_cmd, 0, NULL },
95 { "p", db_print_cmd, 0, NULL },
96 { "examine", db_examine_cmd, CS_SET_DOT, NULL },
97 { "x", db_examine_cmd, CS_SET_DOT, NULL },
98 { "search", db_search_cmd, CS_OWN|CS_SET_DOT, NULL },
99 { "set", db_set_cmd, CS_OWN, NULL },
100 { "write", db_write_cmd, CS_MORE|CS_SET_DOT, NULL },
101 { "w", db_write_cmd, CS_MORE|CS_SET_DOT, NULL },
102 { "delete", db_delete_cmd, 0, NULL },
103 { "d", db_delete_cmd, 0, NULL },
104 { "break", db_breakpoint_cmd, 0, NULL },
105 { "dwatch", db_deletewatch_cmd, 0, NULL },
106 { "watch", db_watchpoint_cmd, CS_MORE,NULL },
107 { "dhwatch", db_deletehwatch_cmd, 0, NULL },
108 { "hwatch", db_hwatchpoint_cmd, 0, NULL },
109 { "step", db_single_step_cmd, 0, NULL },
110 { "s", db_single_step_cmd, 0, NULL },
111 { "continue", db_continue_cmd, 0, NULL },
112 { "c", db_continue_cmd, 0, NULL },
113 { "until", db_trace_until_call_cmd,0, NULL },
114 { "next", db_trace_until_matching_cmd,0, NULL },
115 { "match", db_trace_until_matching_cmd,0, NULL },
116 { "trace", db_stack_trace_cmd, 0, NULL },
117 { "where", db_stack_trace_cmd, 0, NULL },
118 { "call", db_fncall, CS_OWN, NULL },
119 { "show", 0, 0, db_show_cmds },
120 { "ps", db_ps, 0, NULL },
121 { "gdb", db_gdb, 0, NULL },
122 { "reset", db_reset, 0, NULL },
126 static struct command *db_last_command = NULL;
129 * if 'ed' style: 'dot' is set at start of last item printed,
130 * and '+' points to next line.
131 * Otherwise: 'dot' points to next item, '..' points to last.
133 static boolean_t db_ed_style = TRUE;
136 * Utility routine - discard tokens through end-of-line.
148 * Results of command search.
153 #define CMD_AMBIGUOUS 3
156 static void db_cmd_list (struct command *table,
157 struct command **aux_tablep,
158 struct command **aux_tablep_end);
159 static int db_cmd_search (char *name, struct command *table,
160 struct command **aux_tablep,
161 struct command **aux_tablep_end,
162 struct command **cmdp);
163 static void db_command (struct command **last_cmdp,
164 struct command *cmd_table,
165 struct command **aux_cmd_tablep,
166 struct command **aux_cmd_tablep_end);
169 * Search for command prefix.
175 db_cmd_search(char *name, struct command *table, struct command **aux_tablep,
176 struct command **aux_tablep_end, struct command **cmdp)
179 struct command **aux_cmdp;
180 int result = CMD_NONE;
182 for (cmd = table; cmd->name != 0; cmd++) {
189 while ((c = *lp) == *rp) {
199 /* end of name, not end of command -
201 if (result == CMD_FOUND) {
202 result = CMD_AMBIGUOUS;
203 /* but keep looking for a full match -
204 this lets us match single letters */
212 if (result == CMD_NONE && aux_tablep != NULL)
213 /* XXX repeat too much code. */
214 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
220 rp = (*aux_cmdp)->name;
221 while ((c = *lp) == *rp) {
231 /* end of name, not end of command -
233 if (result == CMD_FOUND) {
234 result = CMD_AMBIGUOUS;
235 /* but keep looking for a full match -
236 this lets us match single letters */
244 if (result == CMD_NONE) {
245 /* check for 'help' */
246 if (name[0] == 'h' && name[1] == 'e'
247 && name[2] == 'l' && name[3] == 'p')
254 db_cmd_list(struct command *table, struct command **aux_tablep,
255 struct command **aux_tablep_end)
258 struct command **aux_cmdp;
260 for (cmd = table; cmd->name != 0; cmd++) {
261 db_printf("%-12s", cmd->name);
264 if (aux_tablep == NULL)
266 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
267 db_printf("%-12s", (*aux_cmdp)->name);
277 db_command(struct command **last_cmdp, struct command *cmd_table,
278 struct command **aux_cmd_tablep, struct command **aux_cmd_tablep_end)
282 char modif[TOK_STRING_SIZE];
283 db_expr_t addr, count;
284 boolean_t have_addr = FALSE;
290 /* empty line repeats last command, at 'next' */
292 addr = (db_expr_t)db_next;
297 else if (t == tEXCL) {
298 db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, NULL);
301 else if (t != tIDENT) {
311 result = db_cmd_search(db_tok_string,
318 db_printf("No such command\n");
322 db_printf("Ambiguous\n");
326 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
332 if ((cmd_table = cmd->more) != NULL) {
333 /* XXX usually no more aux's. */
334 aux_cmd_tablep = NULL;
335 if (cmd_table == db_show_cmds) {
336 aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
337 aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
342 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
349 if ((cmd->flag & CS_OWN) == 0) {
352 * command [/modifier] [addr] [,count]
357 if (t != tIDENT && t != tNUMBER) {
358 db_printf("Bad modifier\n");
362 db_strcpy(modif, db_tok_string);
369 if (db_expression(&addr)) {
370 db_dot = (db_addr_t) addr;
371 db_last_addr = db_dot;
375 addr = (db_expr_t) db_dot;
380 if (!db_expression(&count)) {
381 db_printf("Count missing\n");
390 if ((cmd->flag & CS_MORE) == 0) {
398 * Execute the command.
400 (*cmd->fcn)(addr, have_addr, count, modif);
402 if (cmd->flag & CS_SET_DOT) {
404 * If command changes dot, set dot to
405 * previous address displayed (if 'ed' style).
416 * If command does not change dot,
417 * set 'next' location to be the same.
428 struct command *cmd = db_command_table;
430 while (cmd->name != 0) {
431 db_printf("%-12s", cmd->name);
439 * At least one non-optional command must be implemented using
440 * DB_COMMAND() so that db_cmd_set gets created. Here is one.
442 DB_COMMAND(panic, db_panic)
444 panic("from debugger");
448 db_command_loop(void)
451 * Initialize 'prev' and 'next' to dot.
457 db_cmd_loop_done = 0;
458 while (!db_cmd_loop_done) {
461 if (db_print_position() != 0)
467 db_command(&db_last_command, db_command_table,
468 SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
479 longjmp(db_jmpbuf, 1);
484 * Call random function:
488 db_fncall(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
491 #define MAXARGS 11 /* XXX only 10 are passed */
492 db_expr_t args[MAXARGS];
495 typedef db_expr_t fcn_10args_t (db_expr_t, db_expr_t, db_expr_t,
496 db_expr_t, db_expr_t, db_expr_t,
497 db_expr_t, db_expr_t, db_expr_t,
502 if (!db_expression(&fn_addr)) {
503 db_printf("Bad function\n");
507 func = (fcn_10args_t *)fn_addr; /* XXX */
511 if (db_expression(&args[0])) {
513 while ((t = db_read_token()) == tCOMMA) {
514 if (nargs == MAXARGS) {
515 db_printf("Too many arguments\n");
519 if (!db_expression(&args[nargs])) {
520 db_printf("Argument missing\n");
528 if (db_read_token() != tRPAREN) {
536 while (nargs < MAXARGS) {
540 retval = (*func)(args[0], args[1], args[2], args[3], args[4],
541 args[5], args[6], args[7], args[8], args[9] );
542 db_printf("%#lr\n", (long)retval);
545 /* Enter GDB remote protocol debugger on the next trap. */
548 db_gdb(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
550 if (gdb_tab == NULL) {
551 db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
552 db_printf("in your configuration file (currently sio only).\n");
557 db_printf("Next trap will enter %s\n",
558 boothowto & RB_GDB ? "GDB remote protocol mode"
563 db_reset(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char * dummy4)