FreeBSD/Linux Kernel Cross Reference
sys/ddb/db_command.c
1 /*
2 * Mach Operating System
3 * Copyright (c) 1991,1990 Carnegie Mellon University
4 * All Rights Reserved.
5 *
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.
11 *
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.
15 *
16 * Carnegie Mellon requests users of this software to return to
17 *
18 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 * School of Computer Science
20 * Carnegie Mellon University
21 * Pittsburgh PA 15213-3890
22 *
23 * any improvements or extensions that they make and grant Carnegie the
24 * rights to redistribute these changes.
25 *
26 * $FreeBSD: releng/5.1/sys/ddb/db_command.c 111017 2003-02-16 19:22:21Z phk $
27 */
28
29 /*
30 * Author: David B. Golub, Carnegie Mellon University
31 * Date: 7/90
32 */
33
34 /*
35 * Command dispatcher.
36 */
37 #include <sys/param.h>
38 #include <sys/linker_set.h>
39 #include <sys/lock.h>
40 #include <sys/mutex.h>
41 #include <sys/proc.h>
42 #include <sys/reboot.h>
43 #include <sys/signalvar.h>
44 #include <sys/systm.h>
45 #include <sys/cons.h>
46
47 #include <ddb/ddb.h>
48 #include <ddb/db_command.h>
49 #include <ddb/db_lex.h>
50 #include <ddb/db_output.h>
51
52 #include <machine/md_var.h>
53 #include <machine/setjmp.h>
54
55 /*
56 * Exported global variables
57 */
58 boolean_t db_cmd_loop_done;
59 db_addr_t db_dot;
60 jmp_buf db_jmpbuf;
61 db_addr_t db_last_addr;
62 db_addr_t db_prev;
63 db_addr_t db_next;
64
65 SET_DECLARE(db_cmd_set, struct command);
66 SET_DECLARE(db_show_cmd_set, struct command);
67
68 static db_cmdfcn_t db_fncall;
69 static db_cmdfcn_t db_gdb;
70 static db_cmdfcn_t db_kill;
71 static db_cmdfcn_t db_reset;
72
73 /* XXX this is actually forward-static. */
74 extern struct command db_show_cmds[];
75
76 /*
77 * if 'ed' style: 'dot' is set at start of last item printed,
78 * and '+' points to next line.
79 * Otherwise: 'dot' points to next item, '..' points to last.
80 */
81 static boolean_t db_ed_style = TRUE;
82
83 /*
84 * Utility routine - discard tokens through end-of-line.
85 */
86 void
87 db_skip_to_eol()
88 {
89 int t;
90 do {
91 t = db_read_token();
92 } while (t != tEOL);
93 }
94
95 /*
96 * Results of command search.
97 */
98 #define CMD_UNIQUE 0
99 #define CMD_FOUND 1
100 #define CMD_NONE 2
101 #define CMD_AMBIGUOUS 3
102 #define CMD_HELP 4
103
104 static void db_cmd_list(struct command *table, struct command **aux_tablep,
105 struct command **aux_tablep_end);
106 static int db_cmd_search(char *name, struct command *table,
107 struct command **aux_tablep,
108 struct command **aux_tablep_end, struct command **cmdp);
109 static void db_command(struct command **last_cmdp,
110 struct command *cmd_table, struct command **aux_cmd_tablep,
111 struct command **aux_cmd_tablep_end);
112
113 /*
114 * Search for command prefix.
115 */
116 static int
117 db_cmd_search(name, table, aux_tablep, aux_tablep_end, cmdp)
118 char * name;
119 struct command *table;
120 struct command **aux_tablep;
121 struct command **aux_tablep_end;
122 struct command **cmdp; /* out */
123 {
124 struct command *cmd;
125 struct command **aux_cmdp;
126 int result = CMD_NONE;
127
128 for (cmd = table; cmd->name != 0; cmd++) {
129 register char *lp;
130 register char *rp;
131 register int c;
132
133 lp = name;
134 rp = cmd->name;
135 while ((c = *lp) == *rp) {
136 if (c == 0) {
137 /* complete match */
138 *cmdp = cmd;
139 return (CMD_UNIQUE);
140 }
141 lp++;
142 rp++;
143 }
144 if (c == 0) {
145 /* end of name, not end of command -
146 partial match */
147 if (result == CMD_FOUND) {
148 result = CMD_AMBIGUOUS;
149 /* but keep looking for a full match -
150 this lets us match single letters */
151 }
152 else {
153 *cmdp = cmd;
154 result = CMD_FOUND;
155 }
156 }
157 }
158 if (result == CMD_NONE && aux_tablep != 0)
159 /* XXX repeat too much code. */
160 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
161 register char *lp;
162 register char *rp;
163 register int c;
164
165 lp = name;
166 rp = (*aux_cmdp)->name;
167 while ((c = *lp) == *rp) {
168 if (c == 0) {
169 /* complete match */
170 *cmdp = *aux_cmdp;
171 return (CMD_UNIQUE);
172 }
173 lp++;
174 rp++;
175 }
176 if (c == 0) {
177 /* end of name, not end of command -
178 partial match */
179 if (result == CMD_FOUND) {
180 result = CMD_AMBIGUOUS;
181 /* but keep looking for a full match -
182 this lets us match single letters */
183 }
184 else {
185 *cmdp = *aux_cmdp;
186 result = CMD_FOUND;
187 }
188 }
189 }
190 if (result == CMD_NONE) {
191 /* check for 'help' */
192 if (name[0] == 'h' && name[1] == 'e'
193 && name[2] == 'l' && name[3] == 'p')
194 result = CMD_HELP;
195 }
196 return (result);
197 }
198
199 static void
200 db_cmd_list(table, aux_tablep, aux_tablep_end)
201 struct command *table;
202 struct command **aux_tablep;
203 struct command **aux_tablep_end;
204 {
205 register struct command *cmd;
206 register struct command **aux_cmdp;
207
208 for (cmd = table; cmd->name != 0; cmd++) {
209 db_printf("%-12s", cmd->name);
210 db_end_line();
211 }
212 if (aux_tablep == 0)
213 return;
214 for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
215 db_printf("%-12s", (*aux_cmdp)->name);
216 db_end_line();
217 }
218 }
219
220 static void
221 db_command(last_cmdp, cmd_table, aux_cmd_tablep, aux_cmd_tablep_end)
222 struct command **last_cmdp; /* IN_OUT */
223 struct command *cmd_table;
224 struct command **aux_cmd_tablep;
225 struct command **aux_cmd_tablep_end;
226 {
227 struct command *cmd;
228 int t;
229 char modif[TOK_STRING_SIZE];
230 db_expr_t addr, count;
231 boolean_t have_addr = FALSE;
232 int result;
233
234 t = db_read_token();
235 if (t == tEOL) {
236 /* empty line repeats last command, at 'next' */
237 cmd = *last_cmdp;
238 addr = (db_expr_t)db_next;
239 have_addr = FALSE;
240 count = 1;
241 modif[0] = '\0';
242 }
243 else if (t == tEXCL) {
244 db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, (char *)0);
245 return;
246 }
247 else if (t != tIDENT) {
248 db_printf("?\n");
249 db_flush_lex();
250 return;
251 }
252 else {
253 /*
254 * Search for command
255 */
256 while (cmd_table) {
257 result = db_cmd_search(db_tok_string,
258 cmd_table,
259 aux_cmd_tablep,
260 aux_cmd_tablep_end,
261 &cmd);
262 switch (result) {
263 case CMD_NONE:
264 db_printf("No such command\n");
265 db_flush_lex();
266 return;
267 case CMD_AMBIGUOUS:
268 db_printf("Ambiguous\n");
269 db_flush_lex();
270 return;
271 case CMD_HELP:
272 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
273 db_flush_lex();
274 return;
275 default:
276 break;
277 }
278 if ((cmd_table = cmd->more) != 0) {
279 /* XXX usually no more aux's. */
280 aux_cmd_tablep = 0;
281 if (cmd_table == db_show_cmds) {
282 aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
283 aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
284 }
285
286 t = db_read_token();
287 if (t != tIDENT) {
288 db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
289 db_flush_lex();
290 return;
291 }
292 }
293 }
294
295 if ((cmd->flag & CS_OWN) == 0) {
296 /*
297 * Standard syntax:
298 * command [/modifier] [addr] [,count]
299 */
300 t = db_read_token();
301 if (t == tSLASH) {
302 t = db_read_token();
303 if (t != tIDENT) {
304 db_printf("Bad modifier\n");
305 db_flush_lex();
306 return;
307 }
308 db_strcpy(modif, db_tok_string);
309 }
310 else {
311 db_unread_token(t);
312 modif[0] = '\0';
313 }
314
315 if (db_expression(&addr)) {
316 db_dot = (db_addr_t) addr;
317 db_last_addr = db_dot;
318 have_addr = TRUE;
319 }
320 else {
321 addr = (db_expr_t) db_dot;
322 have_addr = FALSE;
323 }
324 t = db_read_token();
325 if (t == tCOMMA) {
326 if (!db_expression(&count)) {
327 db_printf("Count missing\n");
328 db_flush_lex();
329 return;
330 }
331 }
332 else {
333 db_unread_token(t);
334 count = -1;
335 }
336 if ((cmd->flag & CS_MORE) == 0) {
337 db_skip_to_eol();
338 }
339 }
340 }
341 *last_cmdp = cmd;
342 if (cmd != 0) {
343 /*
344 * Execute the command.
345 */
346 (*cmd->fcn)(addr, have_addr, count, modif);
347
348 if (cmd->flag & CS_SET_DOT) {
349 /*
350 * If command changes dot, set dot to
351 * previous address displayed (if 'ed' style).
352 */
353 if (db_ed_style) {
354 db_dot = db_prev;
355 }
356 else {
357 db_dot = db_next;
358 }
359 }
360 else {
361 /*
362 * If command does not change dot,
363 * set 'next' location to be the same.
364 */
365 db_next = db_dot;
366 }
367 }
368 }
369
370 /*
371 * 'show' commands
372 */
373
374 static struct command db_show_all_cmds[] = {
375 #if 0
376 { "threads", db_show_all_threads, 0, 0 },
377 #endif
378 { "procs", db_ps, 0, 0 },
379 { (char *)0 }
380 };
381
382 static struct command db_show_cmds[] = {
383 { "all", 0, 0, db_show_all_cmds },
384 { "registers", db_show_regs, 0, 0 },
385 { "breaks", db_listbreak_cmd, 0, 0 },
386 { "thread", db_show_one_thread, 0, 0 },
387 #if 0
388 { "port", ipc_port_print, 0, 0 },
389 #endif
390 { (char *)0, }
391 };
392
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 { "call", db_fncall, CS_OWN, 0 },
418 { "show", 0, 0, db_show_cmds },
419 { "ps", db_ps, 0, 0 },
420 { "gdb", db_gdb, 0, 0 },
421 { "reset", db_reset, 0, 0 },
422 { "kill", db_kill, CS_OWN, 0 },
423 { (char *)0, }
424 };
425
426 static struct command *db_last_command = 0;
427
428 #if 0
429 void
430 db_help_cmd()
431 {
432 struct command *cmd = db_command_table;
433
434 while (cmd->name != 0) {
435 db_printf("%-12s", cmd->name);
436 db_end_line();
437 cmd++;
438 }
439 }
440 #endif
441
442 /*
443 * At least one non-optional command must be implemented using
444 * DB_COMMAND() so that db_cmd_set gets created. Here is one.
445 */
446 DB_COMMAND(panic, db_panic)
447 {
448 panic("from debugger");
449 }
450
451 void
452 db_command_loop()
453 {
454 /*
455 * Initialize 'prev' and 'next' to dot.
456 */
457 db_prev = db_dot;
458 db_next = db_dot;
459
460 db_cmd_loop_done = 0;
461 while (!db_cmd_loop_done) {
462
463 (void) setjmp(db_jmpbuf);
464 if (db_print_position() != 0)
465 db_printf("\n");
466
467 db_printf("db> ");
468 (void) db_read_line();
469
470 db_command(&db_last_command, db_command_table,
471 SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
472 }
473 }
474
475 void
476 db_error(s)
477 const char *s;
478 {
479 if (s)
480 db_printf("%s", s);
481 db_flush_lex();
482 longjmp(db_jmpbuf, 1);
483 }
484
485
486 /*
487 * Call random function:
488 * !expr(arg,arg,arg)
489 */
490 static void
491 db_fncall(dummy1, dummy2, dummy3, dummy4)
492 db_expr_t dummy1;
493 boolean_t dummy2;
494 db_expr_t dummy3;
495 char * dummy4;
496 {
497 db_expr_t fn_addr;
498 #define MAXARGS 11 /* XXX only 10 are passed */
499 db_expr_t args[MAXARGS];
500 int nargs = 0;
501 db_expr_t retval;
502 typedef db_expr_t fcn_10args_t(db_expr_t, db_expr_t, db_expr_t,
503 db_expr_t, db_expr_t, db_expr_t, db_expr_t,
504 db_expr_t, db_expr_t, db_expr_t);
505 fcn_10args_t *func;
506 int t;
507
508 if (!db_expression(&fn_addr)) {
509 db_printf("Bad function\n");
510 db_flush_lex();
511 return;
512 }
513 func = (fcn_10args_t *)fn_addr; /* XXX */
514
515 t = db_read_token();
516 if (t == tLPAREN) {
517 if (db_expression(&args[0])) {
518 nargs++;
519 while ((t = db_read_token()) == tCOMMA) {
520 if (nargs == MAXARGS) {
521 db_printf("Too many arguments\n");
522 db_flush_lex();
523 return;
524 }
525 if (!db_expression(&args[nargs])) {
526 db_printf("Argument missing\n");
527 db_flush_lex();
528 return;
529 }
530 nargs++;
531 }
532 db_unread_token(t);
533 }
534 if (db_read_token() != tRPAREN) {
535 db_printf("?\n");
536 db_flush_lex();
537 return;
538 }
539 }
540 db_skip_to_eol();
541
542 while (nargs < MAXARGS) {
543 args[nargs++] = 0;
544 }
545
546 retval = (*func)(args[0], args[1], args[2], args[3], args[4],
547 args[5], args[6], args[7], args[8], args[9] );
548 db_printf("%#lr\n", (long)retval);
549 }
550
551 /* Enter GDB remote protocol debugger on the next trap. */
552
553 void *gdb_arg = NULL;
554 cn_getc_t *gdb_getc;
555 cn_putc_t *gdb_putc;
556
557 static void
558 db_gdb (dummy1, dummy2, dummy3, dummy4)
559 db_expr_t dummy1;
560 boolean_t dummy2;
561 db_expr_t dummy3;
562 char * dummy4;
563 {
564
565 if (gdb_arg == NULL) {
566 db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
567 db_printf("in your configuration file (currently sio only).\n");
568 return;
569 }
570 boothowto ^= RB_GDB;
571
572 db_printf("Next trap will enter %s\n",
573 boothowto & RB_GDB ? "GDB remote protocol mode"
574 : "DDB debugger");
575 }
576
577 static void
578 db_kill(dummy1, dummy2, dummy3, dummy4)
579 db_expr_t dummy1;
580 boolean_t dummy2;
581 db_expr_t dummy3;
582 char * dummy4;
583 {
584 db_expr_t old_radix, pid, sig;
585 struct proc *p;
586
587 #define DB_ERROR(f) do { db_printf f; db_flush_lex(); goto out; } while (0)
588
589 /*
590 * PIDs and signal numbers are typically represented in base
591 * 10, so make that the default here. It can, of course, be
592 * overridden by specifying a prefix.
593 */
594 old_radix = db_radix;
595 db_radix = 10;
596 /* Retrieve arguments. */
597 if (!db_expression(&sig))
598 DB_ERROR(("Missing signal number\n"));
599 if (!db_expression(&pid))
600 DB_ERROR(("Missing process ID\n"));
601 db_skip_to_eol();
602 if (sig < 0 || sig > _SIG_MAXSIG)
603 DB_ERROR(("Signal number out of range\n"));
604
605 /*
606 * Find the process in question. allproc_lock is not needed
607 * since we're in DDB.
608 */
609 /* sx_slock(&allproc_lock); */
610 LIST_FOREACH(p, &allproc, p_list)
611 if (p->p_pid == pid)
612 break;
613 /* sx_sunlock(&allproc_lock); */
614 if (p == NULL)
615 DB_ERROR(("Can't find process with pid %ld\n", (long) pid));
616
617 /* If it's already locked, bail; otherwise, do the deed. */
618 if (PROC_TRYLOCK(p) == 0)
619 DB_ERROR(("Can't lock process with pid %ld\n", (long) pid));
620 else {
621 psignal(p, sig);
622 PROC_UNLOCK(p);
623 }
624
625 out:
626 db_radix = old_radix;
627 #undef DB_ERROR
628 }
629
630 static void
631 db_reset(dummy1, dummy2, dummy3, dummy4)
632 db_expr_t dummy1;
633 boolean_t dummy2;
634 db_expr_t dummy3;
635 char * dummy4;
636 {
637
638 cpu_reset();
639 }
Cache object: bebb4cdc9878440633e4b93afd592f5c
|