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 * $Id: db_command.c,v 1.2 1993/10/16 16:47:10 rgrimes Exp $ 27 */ 28 29 /* 30 * Author: David B. Golub, Carnegie Mellon University 31 * Date: 7/90 32 */ 33 34 /* 35 * Command dispatcher. 36 */ 37 #include "param.h" 38 #include "systm.h" 39 #include "proc.h" 40 #include "ddb/ddb.h" 41 42 #include <ddb/db_lex.h> 43 #include <ddb/db_output.h> 44 45 #include <setjmp.h> 46 47 /* 48 * Exported global variables 49 */ 50 boolean_t db_cmd_loop_done; 51 jmp_buf db_jmpbuf; 52 db_addr_t db_dot; 53 db_addr_t db_last_addr; 54 db_addr_t db_prev; 55 db_addr_t db_next; 56 57 /* 58 * if 'ed' style: 'dot' is set at start of last item printed, 59 * and '+' points to next line. 60 * Otherwise: 'dot' points to next item, '..' points to last. 61 */ 62 boolean_t db_ed_style = TRUE; 63 64 65 /* 66 * Utility routine - discard tokens through end-of-line. 67 */ 68 void 69 db_skip_to_eol() 70 { 71 int t; 72 do { 73 t = db_read_token(); 74 } while (t != tEOL); 75 } 76 77 /* 78 * Command table 79 */ 80 struct command { 81 char * name; /* command name */ 82 void (*fcn)(); /* function to call */ 83 int flag; /* extra info: */ 84 #define CS_OWN 0x1 /* non-standard syntax */ 85 #define CS_MORE 0x2 /* standard syntax, but may have other 86 words at end */ 87 #define CS_SET_DOT 0x100 /* set dot after command */ 88 struct command *more; /* another level of command */ 89 }; 90 91 /* 92 * Results of command search. 93 */ 94 #define CMD_UNIQUE 0 95 #define CMD_FOUND 1 96 #define CMD_NONE 2 97 #define CMD_AMBIGUOUS 3 98 #define CMD_HELP 4 99 100 /* 101 * Search for command prefix. 102 */ 103 int 104 db_cmd_search(name, table, cmdp) 105 char * name; 106 struct command *table; 107 struct command **cmdp; /* out */ 108 { 109 struct command *cmd; 110 int result = CMD_NONE; 111 112 for (cmd = table; cmd->name != 0; cmd++) { 113 register char *lp; 114 register char *rp; 115 register int c; 116 117 lp = name; 118 rp = cmd->name; 119 while ((c = *lp) == *rp) { 120 if (c == 0) { 121 /* complete match */ 122 *cmdp = cmd; 123 return (CMD_UNIQUE); 124 } 125 lp++; 126 rp++; 127 } 128 if (c == 0) { 129 /* end of name, not end of command - 130 partial match */ 131 if (result == CMD_FOUND) { 132 result = CMD_AMBIGUOUS; 133 /* but keep looking for a full match - 134 this lets us match single letters */ 135 } 136 else { 137 *cmdp = cmd; 138 result = CMD_FOUND; 139 } 140 } 141 } 142 if (result == CMD_NONE) { 143 /* check for 'help' */ 144 if (name[0] == 'h' && name[1] == 'e' 145 && name[2] == 'l' && name[3] == 'p') 146 result = CMD_HELP; 147 } 148 return (result); 149 } 150 151 void 152 db_cmd_list(table) 153 struct command *table; 154 { 155 register struct command *cmd; 156 157 for (cmd = table; cmd->name != 0; cmd++) { 158 db_printf("%-12s", cmd->name); 159 db_end_line(); 160 } 161 } 162 163 void 164 db_command(last_cmdp, cmd_table) 165 struct command **last_cmdp; /* IN_OUT */ 166 struct command *cmd_table; 167 { 168 struct command *cmd; 169 int t; 170 char modif[TOK_STRING_SIZE]; 171 db_expr_t addr, count; 172 boolean_t have_addr = FALSE; 173 int result; 174 175 t = db_read_token(); 176 if (t == tEOL) { 177 /* empty line repeats last command, at 'next' */ 178 cmd = *last_cmdp; 179 addr = (db_expr_t)db_next; 180 have_addr = FALSE; 181 count = 1; 182 modif[0] = '\0'; 183 } 184 else if (t == tEXCL) { 185 void db_fncall(); 186 db_fncall(); 187 return; 188 } 189 else if (t != tIDENT) { 190 db_printf("?\n"); 191 db_flush_lex(); 192 return; 193 } 194 else { 195 /* 196 * Search for command 197 */ 198 while (cmd_table) { 199 result = db_cmd_search(db_tok_string, 200 cmd_table, 201 &cmd); 202 switch (result) { 203 case CMD_NONE: 204 db_printf("No such command\n"); 205 db_flush_lex(); 206 return; 207 case CMD_AMBIGUOUS: 208 db_printf("Ambiguous\n"); 209 db_flush_lex(); 210 return; 211 case CMD_HELP: 212 db_cmd_list(cmd_table); 213 db_flush_lex(); 214 return; 215 default: 216 break; 217 } 218 if ((cmd_table = cmd->more) != 0) { 219 t = db_read_token(); 220 if (t != tIDENT) { 221 db_cmd_list(cmd_table); 222 db_flush_lex(); 223 return; 224 } 225 } 226 } 227 228 if ((cmd->flag & CS_OWN) == 0) { 229 /* 230 * Standard syntax: 231 * command [/modifier] [addr] [,count] 232 */ 233 t = db_read_token(); 234 if (t == tSLASH) { 235 t = db_read_token(); 236 if (t != tIDENT) { 237 db_printf("Bad modifier\n"); 238 db_flush_lex(); 239 return; 240 } 241 db_strcpy(modif, db_tok_string); 242 } 243 else { 244 db_unread_token(t); 245 modif[0] = '\0'; 246 } 247 248 if (db_expression(&addr)) { 249 db_dot = (db_addr_t) addr; 250 db_last_addr = db_dot; 251 have_addr = TRUE; 252 } 253 else { 254 addr = (db_expr_t) db_dot; 255 have_addr = FALSE; 256 } 257 t = db_read_token(); 258 if (t == tCOMMA) { 259 if (!db_expression(&count)) { 260 db_printf("Count missing\n"); 261 db_flush_lex(); 262 return; 263 } 264 } 265 else { 266 db_unread_token(t); 267 count = -1; 268 } 269 if ((cmd->flag & CS_MORE) == 0) { 270 db_skip_to_eol(); 271 } 272 } 273 } 274 *last_cmdp = cmd; 275 if (cmd != 0) { 276 /* 277 * Execute the command. 278 */ 279 (*cmd->fcn)(addr, have_addr, count, modif); 280 281 if (cmd->flag & CS_SET_DOT) { 282 /* 283 * If command changes dot, set dot to 284 * previous address displayed (if 'ed' style). 285 */ 286 if (db_ed_style) { 287 db_dot = db_prev; 288 } 289 else { 290 db_dot = db_next; 291 } 292 } 293 else { 294 /* 295 * If command does not change dot, 296 * set 'next' location to be the same. 297 */ 298 db_next = db_dot; 299 } 300 } 301 } 302 303 /* 304 * 'show' commands 305 */ 306 extern void db_listbreak_cmd(); 307 extern void db_listwatch_cmd(); 308 extern void db_show_regs(), db_show_one_thread(), db_show_all_threads(); 309 extern void vm_map_print(), vm_object_print(), vm_page_print(); 310 extern void ipc_port_print(); 311 void db_show_help(); 312 313 struct command db_show_all_cmds[] = { 314 #if 0 315 { "threads", db_show_all_threads,0, 0 }, 316 #endif 317 { (char *)0 } 318 }; 319 320 struct command db_show_cmds[] = { 321 { "all", 0, 0, db_show_all_cmds }, 322 { "registers", db_show_regs, 0, 0 }, 323 { "breaks", db_listbreak_cmd, 0, 0 }, 324 { "watches", db_listwatch_cmd, 0, 0 }, 325 #if 0 326 { "thread", db_show_one_thread, 0, 0 }, 327 #endif 328 { "map", vm_map_print, 0, 0 }, 329 { "object", vm_object_print, 0, 0 }, 330 #if 0 331 { "page", vm_page_print, 0, 0 }, 332 #endif 333 #if 0 334 { "port", ipc_port_print, 0, 0 }, 335 #endif 336 { (char *)0, } 337 }; 338 339 extern void db_print_cmd(), db_examine_cmd(), db_set_cmd(); 340 extern void db_search_cmd(); 341 extern void db_write_cmd(); 342 extern void db_delete_cmd(), db_breakpoint_cmd(); 343 extern void db_deletewatch_cmd(), db_watchpoint_cmd(); 344 extern void db_single_step_cmd(), db_trace_until_call_cmd(), 345 db_trace_until_matching_cmd(), db_continue_cmd(); 346 extern void db_stack_trace_cmd(); 347 void db_help_cmd(); 348 void db_fncall(); 349 350 struct command db_command_table[] = { 351 { "print", db_print_cmd, 0, 0 }, 352 { "examine", db_examine_cmd, CS_SET_DOT, 0 }, 353 { "x", db_examine_cmd, CS_SET_DOT, 0 }, 354 { "search", db_search_cmd, CS_OWN|CS_SET_DOT, 0 }, 355 { "set", db_set_cmd, CS_OWN, 0 }, 356 { "write", db_write_cmd, CS_MORE|CS_SET_DOT, 0 }, 357 { "w", db_write_cmd, CS_MORE|CS_SET_DOT, 0 }, 358 { "delete", db_delete_cmd, 0, 0 }, 359 { "d", db_delete_cmd, 0, 0 }, 360 { "break", db_breakpoint_cmd, 0, 0 }, 361 { "dwatch", db_deletewatch_cmd, 0, 0 }, 362 { "watch", db_watchpoint_cmd, CS_MORE,0 }, 363 { "step", db_single_step_cmd, 0, 0 }, 364 { "s", db_single_step_cmd, 0, 0 }, 365 { "continue", db_continue_cmd, 0, 0 }, 366 { "c", db_continue_cmd, 0, 0 }, 367 { "until", db_trace_until_call_cmd,0, 0 }, 368 { "next", db_trace_until_matching_cmd,0, 0 }, 369 { "match", db_trace_until_matching_cmd,0, 0 }, 370 { "trace", db_stack_trace_cmd, 0, 0 }, 371 { "call", db_fncall, CS_OWN, 0 }, 372 { "show", 0, 0, db_show_cmds }, 373 { (char *)0, } 374 }; 375 376 struct command *db_last_command = 0; 377 378 void 379 db_help_cmd() 380 { 381 struct command *cmd = db_command_table; 382 383 while (cmd->name != 0) { 384 db_printf("%-12s", cmd->name); 385 db_end_line(); 386 cmd++; 387 } 388 } 389 390 void 391 db_command_loop() 392 { 393 /* 394 * Initialize 'prev' and 'next' to dot. 395 */ 396 db_prev = db_dot; 397 db_next = db_dot; 398 399 db_cmd_loop_done = 0; 400 while (!db_cmd_loop_done) { 401 402 (void) setjmp(db_jmpbuf); 403 if (db_print_position() != 0) 404 db_printf("\n"); 405 406 db_printf("db> "); 407 (void) db_read_line(); 408 409 db_command(&db_last_command, db_command_table); 410 } 411 } 412 413 void 414 db_error(s) 415 char *s; 416 { 417 if (s) 418 db_printf(s); 419 db_flush_lex(); 420 longjmp(db_jmpbuf, 1); 421 } 422 423 424 /* 425 * Call random function: 426 * !expr(arg,arg,arg) 427 */ 428 void 429 db_fncall() 430 { 431 db_expr_t fn_addr; 432 #define MAXARGS 11 433 db_expr_t args[MAXARGS]; 434 int nargs = 0; 435 db_expr_t retval; 436 db_expr_t (*func)(); 437 int t; 438 439 if (!db_expression(&fn_addr)) { 440 db_printf("Bad function\n"); 441 db_flush_lex(); 442 return; 443 } 444 func = (db_expr_t (*) ()) fn_addr; 445 446 t = db_read_token(); 447 if (t == tLPAREN) { 448 if (db_expression(&args[0])) { 449 nargs++; 450 while ((t = db_read_token()) == tCOMMA) { 451 if (nargs == MAXARGS) { 452 db_printf("Too many arguments\n"); 453 db_flush_lex(); 454 return; 455 } 456 if (!db_expression(&args[nargs])) { 457 db_printf("Argument missing\n"); 458 db_flush_lex(); 459 return; 460 } 461 nargs++; 462 } 463 db_unread_token(t); 464 } 465 if (db_read_token() != tRPAREN) { 466 db_printf("?\n"); 467 db_flush_lex(); 468 return; 469 } 470 } 471 db_skip_to_eol(); 472 473 while (nargs < MAXARGS) { 474 args[nargs++] = 0; 475 } 476 477 retval = (*func)(args[0], args[1], args[2], args[3], args[4], 478 args[5], args[6], args[7], args[8], args[9] ); 479 db_printf("%#n\n", retval); 480 } 481