db_command.c revision 1.10 1 1.1 cgd /*
2 1.1 cgd * Mach Operating System
3 1.1 cgd * Copyright (c) 1991,1990 Carnegie Mellon University
4 1.1 cgd * All Rights Reserved.
5 1.1 cgd *
6 1.1 cgd * Permission to use, copy, modify and distribute this software and its
7 1.1 cgd * documentation is hereby granted, provided that both the copyright
8 1.1 cgd * notice and this permission notice appear in all copies of the
9 1.1 cgd * software, derivative works or modified versions, and any portions
10 1.1 cgd * thereof, and that both notices appear in supporting documentation.
11 1.1 cgd *
12 1.1 cgd * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
13 1.1 cgd * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 1.1 cgd * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 1.1 cgd *
16 1.1 cgd * Carnegie Mellon requests users of this software to return to
17 1.1 cgd *
18 1.1 cgd * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
19 1.1 cgd * School of Computer Science
20 1.1 cgd * Carnegie Mellon University
21 1.1 cgd * Pittsburgh PA 15213-3890
22 1.1 cgd *
23 1.1 cgd * any improvements or extensions that they make and grant Carnegie the
24 1.1 cgd * rights to redistribute these changes.
25 1.3 cgd *
26 1.10 pk * $Id: db_command.c,v 1.10 1994/03/23 20:00:56 pk Exp $
27 1.1 cgd */
28 1.5 mycroft
29 1.1 cgd /*
30 1.1 cgd * Command dispatcher.
31 1.1 cgd */
32 1.7 mycroft #include <sys/param.h>
33 1.7 mycroft #include <sys/proc.h>
34 1.7 mycroft
35 1.1 cgd #include <machine/db_machdep.h> /* type definitions */
36 1.1 cgd
37 1.1 cgd #include <ddb/db_lex.h>
38 1.1 cgd #include <ddb/db_output.h>
39 1.10 pk #include <ddb/db_command.h>
40 1.1 cgd
41 1.1 cgd #include <setjmp.h>
42 1.1 cgd
43 1.1 cgd /*
44 1.1 cgd * Exported global variables
45 1.1 cgd */
46 1.1 cgd boolean_t db_cmd_loop_done;
47 1.8 mycroft jmp_buf *db_recover;
48 1.1 cgd db_addr_t db_dot;
49 1.1 cgd db_addr_t db_last_addr;
50 1.1 cgd db_addr_t db_prev;
51 1.1 cgd db_addr_t db_next;
52 1.1 cgd
53 1.1 cgd /*
54 1.1 cgd * if 'ed' style: 'dot' is set at start of last item printed,
55 1.1 cgd * and '+' points to next line.
56 1.1 cgd * Otherwise: 'dot' points to next item, '..' points to last.
57 1.1 cgd */
58 1.1 cgd boolean_t db_ed_style = TRUE;
59 1.1 cgd
60 1.1 cgd /*
61 1.1 cgd * Utility routine - discard tokens through end-of-line.
62 1.1 cgd */
63 1.1 cgd void
64 1.1 cgd db_skip_to_eol()
65 1.1 cgd {
66 1.1 cgd int t;
67 1.1 cgd do {
68 1.1 cgd t = db_read_token();
69 1.1 cgd } while (t != tEOL);
70 1.1 cgd }
71 1.1 cgd
72 1.1 cgd /*
73 1.1 cgd * Results of command search.
74 1.1 cgd */
75 1.1 cgd #define CMD_UNIQUE 0
76 1.1 cgd #define CMD_FOUND 1
77 1.1 cgd #define CMD_NONE 2
78 1.1 cgd #define CMD_AMBIGUOUS 3
79 1.1 cgd #define CMD_HELP 4
80 1.1 cgd
81 1.1 cgd /*
82 1.1 cgd * Search for command prefix.
83 1.1 cgd */
84 1.1 cgd int
85 1.1 cgd db_cmd_search(name, table, cmdp)
86 1.10 pk char *name;
87 1.10 pk struct db_command *table;
88 1.10 pk struct db_command **cmdp; /* out */
89 1.1 cgd {
90 1.10 pk struct db_command *cmd;
91 1.10 pk int result = CMD_NONE;
92 1.1 cgd
93 1.1 cgd for (cmd = table; cmd->name != 0; cmd++) {
94 1.1 cgd register char *lp;
95 1.1 cgd register char *rp;
96 1.1 cgd register int c;
97 1.1 cgd
98 1.1 cgd lp = name;
99 1.1 cgd rp = cmd->name;
100 1.1 cgd while ((c = *lp) == *rp) {
101 1.1 cgd if (c == 0) {
102 1.1 cgd /* complete match */
103 1.1 cgd *cmdp = cmd;
104 1.1 cgd return (CMD_UNIQUE);
105 1.1 cgd }
106 1.1 cgd lp++;
107 1.1 cgd rp++;
108 1.1 cgd }
109 1.1 cgd if (c == 0) {
110 1.1 cgd /* end of name, not end of command -
111 1.1 cgd partial match */
112 1.1 cgd if (result == CMD_FOUND) {
113 1.1 cgd result = CMD_AMBIGUOUS;
114 1.1 cgd /* but keep looking for a full match -
115 1.1 cgd this lets us match single letters */
116 1.1 cgd }
117 1.1 cgd else {
118 1.1 cgd *cmdp = cmd;
119 1.1 cgd result = CMD_FOUND;
120 1.1 cgd }
121 1.1 cgd }
122 1.1 cgd }
123 1.1 cgd if (result == CMD_NONE) {
124 1.1 cgd /* check for 'help' */
125 1.1 cgd if (name[0] == 'h' && name[1] == 'e'
126 1.1 cgd && name[2] == 'l' && name[3] == 'p')
127 1.1 cgd result = CMD_HELP;
128 1.1 cgd }
129 1.1 cgd return (result);
130 1.1 cgd }
131 1.1 cgd
132 1.1 cgd void
133 1.1 cgd db_cmd_list(table)
134 1.10 pk struct db_command *table;
135 1.1 cgd {
136 1.10 pk register struct db_command *cmd;
137 1.1 cgd
138 1.1 cgd for (cmd = table; cmd->name != 0; cmd++) {
139 1.1 cgd db_printf("%-12s", cmd->name);
140 1.1 cgd db_end_line();
141 1.1 cgd }
142 1.1 cgd }
143 1.1 cgd
144 1.1 cgd void
145 1.1 cgd db_command(last_cmdp, cmd_table)
146 1.10 pk struct db_command **last_cmdp; /* IN_OUT */
147 1.10 pk struct db_command *cmd_table;
148 1.1 cgd {
149 1.10 pk struct db_command *cmd;
150 1.1 cgd int t;
151 1.1 cgd char modif[TOK_STRING_SIZE];
152 1.1 cgd db_expr_t addr, count;
153 1.1 cgd boolean_t have_addr;
154 1.1 cgd int result;
155 1.1 cgd
156 1.1 cgd t = db_read_token();
157 1.1 cgd if (t == tEOL) {
158 1.1 cgd /* empty line repeats last command, at 'next' */
159 1.1 cgd cmd = *last_cmdp;
160 1.1 cgd addr = (db_expr_t)db_next;
161 1.1 cgd have_addr = FALSE;
162 1.1 cgd count = 1;
163 1.1 cgd modif[0] = '\0';
164 1.1 cgd }
165 1.1 cgd else if (t == tEXCL) {
166 1.1 cgd void db_fncall();
167 1.1 cgd db_fncall();
168 1.1 cgd return;
169 1.1 cgd }
170 1.1 cgd else if (t != tIDENT) {
171 1.1 cgd db_printf("?\n");
172 1.1 cgd db_flush_lex();
173 1.1 cgd return;
174 1.1 cgd }
175 1.1 cgd else {
176 1.1 cgd /*
177 1.1 cgd * Search for command
178 1.1 cgd */
179 1.1 cgd while (cmd_table) {
180 1.1 cgd result = db_cmd_search(db_tok_string,
181 1.1 cgd cmd_table,
182 1.1 cgd &cmd);
183 1.1 cgd switch (result) {
184 1.1 cgd case CMD_NONE:
185 1.1 cgd db_printf("No such command\n");
186 1.1 cgd db_flush_lex();
187 1.1 cgd return;
188 1.1 cgd case CMD_AMBIGUOUS:
189 1.1 cgd db_printf("Ambiguous\n");
190 1.1 cgd db_flush_lex();
191 1.1 cgd return;
192 1.1 cgd case CMD_HELP:
193 1.1 cgd db_cmd_list(cmd_table);
194 1.1 cgd db_flush_lex();
195 1.1 cgd return;
196 1.1 cgd default:
197 1.1 cgd break;
198 1.1 cgd }
199 1.1 cgd if ((cmd_table = cmd->more) != 0) {
200 1.1 cgd t = db_read_token();
201 1.1 cgd if (t != tIDENT) {
202 1.1 cgd db_cmd_list(cmd_table);
203 1.1 cgd db_flush_lex();
204 1.1 cgd return;
205 1.1 cgd }
206 1.1 cgd }
207 1.1 cgd }
208 1.1 cgd
209 1.1 cgd if ((cmd->flag & CS_OWN) == 0) {
210 1.1 cgd /*
211 1.1 cgd * Standard syntax:
212 1.1 cgd * command [/modifier] [addr] [,count]
213 1.1 cgd */
214 1.1 cgd t = db_read_token();
215 1.1 cgd if (t == tSLASH) {
216 1.1 cgd t = db_read_token();
217 1.1 cgd if (t != tIDENT) {
218 1.1 cgd db_printf("Bad modifier\n");
219 1.1 cgd db_flush_lex();
220 1.1 cgd return;
221 1.1 cgd }
222 1.1 cgd db_strcpy(modif, db_tok_string);
223 1.1 cgd }
224 1.1 cgd else {
225 1.1 cgd db_unread_token(t);
226 1.1 cgd modif[0] = '\0';
227 1.1 cgd }
228 1.1 cgd
229 1.1 cgd if (db_expression(&addr)) {
230 1.1 cgd db_dot = (db_addr_t) addr;
231 1.1 cgd db_last_addr = db_dot;
232 1.1 cgd have_addr = TRUE;
233 1.1 cgd }
234 1.1 cgd else {
235 1.1 cgd addr = (db_expr_t) db_dot;
236 1.1 cgd have_addr = FALSE;
237 1.1 cgd }
238 1.1 cgd t = db_read_token();
239 1.1 cgd if (t == tCOMMA) {
240 1.1 cgd if (!db_expression(&count)) {
241 1.1 cgd db_printf("Count missing\n");
242 1.1 cgd db_flush_lex();
243 1.1 cgd return;
244 1.1 cgd }
245 1.1 cgd }
246 1.1 cgd else {
247 1.1 cgd db_unread_token(t);
248 1.1 cgd count = -1;
249 1.1 cgd }
250 1.1 cgd if ((cmd->flag & CS_MORE) == 0) {
251 1.1 cgd db_skip_to_eol();
252 1.1 cgd }
253 1.1 cgd }
254 1.1 cgd }
255 1.1 cgd *last_cmdp = cmd;
256 1.1 cgd if (cmd != 0) {
257 1.1 cgd /*
258 1.1 cgd * Execute the command.
259 1.1 cgd */
260 1.1 cgd (*cmd->fcn)(addr, have_addr, count, modif);
261 1.1 cgd
262 1.1 cgd if (cmd->flag & CS_SET_DOT) {
263 1.1 cgd /*
264 1.1 cgd * If command changes dot, set dot to
265 1.1 cgd * previous address displayed (if 'ed' style).
266 1.1 cgd */
267 1.1 cgd if (db_ed_style) {
268 1.1 cgd db_dot = db_prev;
269 1.1 cgd }
270 1.1 cgd else {
271 1.1 cgd db_dot = db_next;
272 1.1 cgd }
273 1.1 cgd }
274 1.1 cgd else {
275 1.1 cgd /*
276 1.1 cgd * If command does not change dot,
277 1.1 cgd * set 'next' location to be the same.
278 1.1 cgd */
279 1.1 cgd db_next = db_dot;
280 1.1 cgd }
281 1.1 cgd }
282 1.1 cgd }
283 1.1 cgd
284 1.4 brezak /*ARGSUSED*/
285 1.4 brezak void
286 1.4 brezak db_map_print_cmd(addr, have_addr, count, modif)
287 1.4 brezak db_expr_t addr;
288 1.4 brezak int have_addr;
289 1.4 brezak db_expr_t count;
290 1.4 brezak char * modif;
291 1.4 brezak {
292 1.6 brezak extern void _vm_map_print();
293 1.4 brezak boolean_t full = FALSE;
294 1.4 brezak
295 1.4 brezak if (modif[0] == 'f')
296 1.4 brezak full = TRUE;
297 1.4 brezak
298 1.6 brezak _vm_map_print(addr, full, db_printf);
299 1.4 brezak }
300 1.4 brezak
301 1.4 brezak /*ARGSUSED*/
302 1.4 brezak void
303 1.4 brezak db_object_print_cmd(addr, have_addr, count, modif)
304 1.4 brezak db_expr_t addr;
305 1.4 brezak int have_addr;
306 1.4 brezak db_expr_t count;
307 1.4 brezak char * modif;
308 1.4 brezak {
309 1.6 brezak extern void _vm_object_print();
310 1.4 brezak boolean_t full = FALSE;
311 1.4 brezak
312 1.4 brezak if (modif[0] == 'f')
313 1.4 brezak full = TRUE;
314 1.4 brezak
315 1.6 brezak _vm_object_print(addr, full, db_printf);
316 1.4 brezak }
317 1.4 brezak
318 1.1 cgd /*
319 1.1 cgd * 'show' commands
320 1.1 cgd */
321 1.4 brezak extern void db_show_all_procs();
322 1.1 cgd extern void db_listbreak_cmd();
323 1.1 cgd extern void db_listwatch_cmd();
324 1.4 brezak extern void db_show_regs();
325 1.1 cgd void db_show_help();
326 1.1 cgd
327 1.10 pk struct db_command db_show_all_cmds[] = {
328 1.4 brezak { "procs", db_show_all_procs,0, 0 },
329 1.1 cgd { (char *)0 }
330 1.1 cgd };
331 1.1 cgd
332 1.10 pk struct db_command db_show_cmds[] = {
333 1.1 cgd { "all", 0, 0, db_show_all_cmds },
334 1.1 cgd { "registers", db_show_regs, 0, 0 },
335 1.1 cgd { "breaks", db_listbreak_cmd, 0, 0 },
336 1.1 cgd { "watches", db_listwatch_cmd, 0, 0 },
337 1.4 brezak { "map", db_map_print_cmd, 0, 0 },
338 1.4 brezak { "object", db_object_print_cmd, 0, 0 },
339 1.1 cgd { (char *)0, }
340 1.1 cgd };
341 1.1 cgd
342 1.1 cgd extern void db_print_cmd(), db_examine_cmd(), db_set_cmd();
343 1.1 cgd extern void db_search_cmd();
344 1.1 cgd extern void db_write_cmd();
345 1.1 cgd extern void db_delete_cmd(), db_breakpoint_cmd();
346 1.1 cgd extern void db_deletewatch_cmd(), db_watchpoint_cmd();
347 1.1 cgd extern void db_single_step_cmd(), db_trace_until_call_cmd(),
348 1.1 cgd db_trace_until_matching_cmd(), db_continue_cmd();
349 1.1 cgd extern void db_stack_trace_cmd();
350 1.1 cgd void db_help_cmd();
351 1.1 cgd void db_fncall();
352 1.1 cgd
353 1.10 pk struct db_command db_command_table[] = {
354 1.6 brezak #ifdef DB_MACHINE_COMMANDS
355 1.6 brezak /* this must be the first entry, if it exists */
356 1.6 brezak { "machine", 0, 0, 0},
357 1.6 brezak #endif
358 1.6 brezak { "print", db_print_cmd, 0, 0 },
359 1.6 brezak { "examine", db_examine_cmd, CS_SET_DOT, 0 },
360 1.6 brezak { "x", db_examine_cmd, CS_SET_DOT, 0 },
361 1.1 cgd { "search", db_search_cmd, CS_OWN|CS_SET_DOT, 0 },
362 1.6 brezak { "set", db_set_cmd, CS_OWN, 0 },
363 1.1 cgd { "write", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
364 1.1 cgd { "w", db_write_cmd, CS_MORE|CS_SET_DOT, 0 },
365 1.6 brezak { "delete", db_delete_cmd, 0, 0 },
366 1.6 brezak { "d", db_delete_cmd, 0, 0 },
367 1.6 brezak { "break", db_breakpoint_cmd, 0, 0 },
368 1.6 brezak { "dwatch", db_deletewatch_cmd, 0, 0 },
369 1.6 brezak { "watch", db_watchpoint_cmd, CS_MORE, 0 },
370 1.6 brezak { "step", db_single_step_cmd, 0, 0 },
371 1.6 brezak { "s", db_single_step_cmd, 0, 0 },
372 1.6 brezak { "continue", db_continue_cmd, 0, 0 },
373 1.6 brezak { "c", db_continue_cmd, 0, 0 },
374 1.6 brezak { "until", db_trace_until_call_cmd,0, 0 },
375 1.6 brezak { "next", db_trace_until_matching_cmd,0, 0 },
376 1.6 brezak { "match", db_trace_until_matching_cmd,0, 0 },
377 1.6 brezak { "trace", db_stack_trace_cmd, 0, 0 },
378 1.6 brezak { "call", db_fncall, CS_OWN, 0 },
379 1.6 brezak { "ps", db_show_all_procs, 0, 0 },
380 1.6 brezak { "show", 0, 0, db_show_cmds },
381 1.1 cgd { (char *)0, }
382 1.1 cgd };
383 1.6 brezak
384 1.6 brezak #ifdef DB_MACHINE_COMMANDS
385 1.6 brezak
386 1.6 brezak /* this function should be called to install the machine dependent
387 1.6 brezak commands. It should be called before the debugger is enabled */
388 1.6 brezak void db_machine_commands_install(ptr)
389 1.6 brezak struct db_command *ptr;
390 1.6 brezak {
391 1.6 brezak db_command_table[0].more = ptr;
392 1.6 brezak return;
393 1.6 brezak }
394 1.6 brezak
395 1.6 brezak #endif
396 1.1 cgd
397 1.10 pk struct db_command *db_last_command = 0;
398 1.1 cgd
399 1.1 cgd void
400 1.1 cgd db_help_cmd()
401 1.1 cgd {
402 1.10 pk struct db_command *cmd = db_command_table;
403 1.1 cgd
404 1.1 cgd while (cmd->name != 0) {
405 1.1 cgd db_printf("%-12s", cmd->name);
406 1.1 cgd db_end_line();
407 1.1 cgd cmd++;
408 1.1 cgd }
409 1.1 cgd }
410 1.1 cgd
411 1.1 cgd void
412 1.1 cgd db_command_loop()
413 1.1 cgd {
414 1.8 mycroft jmp_buf db_jmpbuf;
415 1.8 mycroft jmp_buf *savejmp = db_recover;
416 1.8 mycroft extern int db_output_line;
417 1.4 brezak
418 1.1 cgd /*
419 1.1 cgd * Initialize 'prev' and 'next' to dot.
420 1.1 cgd */
421 1.1 cgd db_prev = db_dot;
422 1.1 cgd db_next = db_dot;
423 1.1 cgd
424 1.1 cgd db_cmd_loop_done = 0;
425 1.9 mycroft (void) setjmp(*(db_recover = &db_jmpbuf));
426 1.8 mycroft
427 1.1 cgd while (!db_cmd_loop_done) {
428 1.8 mycroft if (db_print_position() != 0)
429 1.8 mycroft db_printf("\n");
430 1.8 mycroft db_output_line = 0;
431 1.1 cgd
432 1.8 mycroft db_printf("db> ");
433 1.8 mycroft (void) db_read_line();
434 1.1 cgd
435 1.8 mycroft db_command(&db_last_command, db_command_table);
436 1.8 mycroft }
437 1.1 cgd
438 1.8 mycroft db_recover = savejmp;
439 1.1 cgd }
440 1.1 cgd
441 1.1 cgd void
442 1.1 cgd db_error(s)
443 1.1 cgd char *s;
444 1.1 cgd {
445 1.1 cgd if (s)
446 1.1 cgd db_printf(s);
447 1.1 cgd db_flush_lex();
448 1.9 mycroft longjmp(*db_recover, 1);
449 1.1 cgd }
450 1.1 cgd
451 1.1 cgd
452 1.1 cgd /*
453 1.1 cgd * Call random function:
454 1.1 cgd * !expr(arg,arg,arg)
455 1.1 cgd */
456 1.1 cgd void
457 1.1 cgd db_fncall()
458 1.1 cgd {
459 1.1 cgd db_expr_t fn_addr;
460 1.1 cgd #define MAXARGS 11
461 1.1 cgd db_expr_t args[MAXARGS];
462 1.1 cgd int nargs = 0;
463 1.1 cgd db_expr_t retval;
464 1.1 cgd db_expr_t (*func)();
465 1.1 cgd int t;
466 1.1 cgd
467 1.1 cgd if (!db_expression(&fn_addr)) {
468 1.1 cgd db_printf("Bad function\n");
469 1.1 cgd db_flush_lex();
470 1.1 cgd return;
471 1.1 cgd }
472 1.1 cgd func = (db_expr_t (*) ()) fn_addr;
473 1.1 cgd
474 1.1 cgd t = db_read_token();
475 1.1 cgd if (t == tLPAREN) {
476 1.1 cgd if (db_expression(&args[0])) {
477 1.1 cgd nargs++;
478 1.1 cgd while ((t = db_read_token()) == tCOMMA) {
479 1.1 cgd if (nargs == MAXARGS) {
480 1.1 cgd db_printf("Too many arguments\n");
481 1.1 cgd db_flush_lex();
482 1.1 cgd return;
483 1.1 cgd }
484 1.1 cgd if (!db_expression(&args[nargs])) {
485 1.1 cgd db_printf("Argument missing\n");
486 1.1 cgd db_flush_lex();
487 1.1 cgd return;
488 1.1 cgd }
489 1.1 cgd nargs++;
490 1.1 cgd }
491 1.1 cgd db_unread_token(t);
492 1.1 cgd }
493 1.1 cgd if (db_read_token() != tRPAREN) {
494 1.1 cgd db_printf("?\n");
495 1.1 cgd db_flush_lex();
496 1.1 cgd return;
497 1.1 cgd }
498 1.1 cgd }
499 1.1 cgd db_skip_to_eol();
500 1.1 cgd
501 1.1 cgd while (nargs < MAXARGS) {
502 1.1 cgd args[nargs++] = 0;
503 1.1 cgd }
504 1.1 cgd
505 1.1 cgd retval = (*func)(args[0], args[1], args[2], args[3], args[4],
506 1.1 cgd args[5], args[6], args[7], args[8], args[9] );
507 1.1 cgd db_printf("%#n\n", retval);
508 1.1 cgd }
509