db_command.c revision 2320
1219820Sjeff/* 2219820Sjeff * Mach Operating System 3219820Sjeff * Copyright (c) 1991,1990 Carnegie Mellon University 4219820Sjeff * All Rights Reserved. 5219820Sjeff * 6219820Sjeff * Permission to use, copy, modify and distribute this software and its 7219820Sjeff * documentation is hereby granted, provided that both the copyright 8219820Sjeff * notice and this permission notice appear in all copies of the 9219820Sjeff * software, derivative works or modified versions, and any portions 10219820Sjeff * thereof, and that both notices appear in supporting documentation. 11219820Sjeff * 12219820Sjeff * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS 13219820Sjeff * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 14219820Sjeff * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 15219820Sjeff * 16219820Sjeff * Carnegie Mellon requests users of this software to return to 17219820Sjeff * 18219820Sjeff * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 19219820Sjeff * School of Computer Science 20219820Sjeff * Carnegie Mellon University 21219820Sjeff * Pittsburgh PA 15213-3890 22219820Sjeff * 23219820Sjeff * any improvements or extensions that they make and grant Carnegie the 24219820Sjeff * rights to redistribute these changes. 25219820Sjeff * 26219820Sjeff * $Id: db_command.c,v 1.7 1994/08/18 22:34:20 wollman Exp $ 27219820Sjeff */ 28219820Sjeff 29219820Sjeff/* 30219820Sjeff * Author: David B. Golub, Carnegie Mellon University 31219820Sjeff * Date: 7/90 32219820Sjeff */ 33219820Sjeff 34219820Sjeff/* 35219820Sjeff * Command dispatcher. 36219820Sjeff */ 37219820Sjeff#include <sys/param.h> 38219820Sjeff#include <sys/systm.h> 39219820Sjeff#include <sys/proc.h> 40219820Sjeff#include <ddb/ddb.h> 41219820Sjeff 42219820Sjeff#include <ddb/db_lex.h> 43219820Sjeff#include <ddb/db_output.h> 44219820Sjeff 45219820Sjeff#include <setjmp.h> 46219820Sjeff 47219820Sjeff/* 48219820Sjeff * Exported global variables 49219820Sjeff */ 50219820Sjeffboolean_t db_cmd_loop_done; 51219820Sjeffjmp_buf db_jmpbuf; 52219820Sjeffdb_addr_t db_dot; 53219820Sjeffdb_addr_t db_last_addr; 54219820Sjeffdb_addr_t db_prev; 55219820Sjeffdb_addr_t db_next; 56219820Sjeff 57219820Sjeff/* 58219820Sjeff * if 'ed' style: 'dot' is set at start of last item printed, 59219820Sjeff * and '+' points to next line. 60219820Sjeff * Otherwise: 'dot' points to next item, '..' points to last. 61219820Sjeff */ 62219820Sjeffboolean_t db_ed_style = TRUE; 63219820Sjeff 64219820Sjeff 65219820Sjeff/* 66219820Sjeff * Utility routine - discard tokens through end-of-line. 67219820Sjeff */ 68219820Sjeffvoid 69219820Sjeffdb_skip_to_eol() 70219820Sjeff{ 71219820Sjeff int t; 72219820Sjeff do { 73219820Sjeff t = db_read_token(); 74219820Sjeff } while (t != tEOL); 75219820Sjeff} 76219820Sjeff 77219820Sjeff/* 78219820Sjeff * Command table 79219820Sjeff */ 80219820Sjeffstruct command { 81219820Sjeff char * name; /* command name */ 82219820Sjeff void (*fcn)(); /* function to call */ 83219820Sjeff int flag; /* extra info: */ 84219820Sjeff#define CS_OWN 0x1 /* non-standard syntax */ 85219820Sjeff#define CS_MORE 0x2 /* standard syntax, but may have other 86219820Sjeff words at end */ 87219820Sjeff#define CS_SET_DOT 0x100 /* set dot after command */ 88219820Sjeff struct command *more; /* another level of command */ 89219820Sjeff}; 90219820Sjeff 91219820Sjeff/* 92219820Sjeff * Results of command search. 93219820Sjeff */ 94219820Sjeff#define CMD_UNIQUE 0 95219820Sjeff#define CMD_FOUND 1 96219820Sjeff#define CMD_NONE 2 97219820Sjeff#define CMD_AMBIGUOUS 3 98219820Sjeff#define CMD_HELP 4 99219820Sjeff 100219820Sjeff/* 101219820Sjeff * Search for command prefix. 102219820Sjeff */ 103219820Sjeffint 104219820Sjeffdb_cmd_search(name, table, cmdp) 105219820Sjeff char * name; 106219820Sjeff struct command *table; 107219820Sjeff 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 151void 152db_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 163void 164db_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 307extern void db_show_one_thread(), db_show_all_threads(); 308extern void vm_page_print(); 309extern void db_ps(); 310extern void ipc_port_print(); 311void db_show_help(); 312 313struct command db_show_all_cmds[] = { 314#if 0 315 { "threads", db_show_all_threads, 0, 0 }, 316#endif 317 { "procs", db_ps, 0, 0 }, 318 { (char *)0 } 319}; 320 321struct command db_show_cmds[] = { 322 { "all", 0, 0, db_show_all_cmds }, 323 { "registers", db_show_regs, 0, 0 }, 324 { "breaks", db_listbreak_cmd, 0, 0 }, 325 { "watches", db_listwatch_cmd, 0, 0 }, 326#if 0 327 { "thread", db_show_one_thread, 0, 0 }, 328#endif 329 { "map", vm_map_print, 0, 0 }, 330 { "object", vm_object_print, 0, 0 }, 331#if 0 332 { "page", vm_page_print, 0, 0 }, 333#endif 334#if 0 335 { "port", ipc_port_print, 0, 0 }, 336#endif 337 { (char *)0, } 338}; 339 340void db_help_cmd(); 341void db_fncall(); 342 343struct command db_command_table[] = { 344 { "print", db_print_cmd, 0, 0 }, 345 { "examine", db_examine_cmd, CS_SET_DOT, 0 }, 346 { "x", db_examine_cmd, CS_SET_DOT, 0 }, 347 { "search", db_search_cmd, CS_OWN|CS_SET_DOT, 0 }, 348 { "set", db_set_cmd, CS_OWN, 0 }, 349 { "write", db_write_cmd, CS_MORE|CS_SET_DOT, 0 }, 350 { "w", db_write_cmd, CS_MORE|CS_SET_DOT, 0 }, 351 { "delete", db_delete_cmd, 0, 0 }, 352 { "d", db_delete_cmd, 0, 0 }, 353 { "break", db_breakpoint_cmd, 0, 0 }, 354 { "dwatch", db_deletewatch_cmd, 0, 0 }, 355 { "watch", db_watchpoint_cmd, CS_MORE,0 }, 356 { "step", db_single_step_cmd, 0, 0 }, 357 { "s", db_single_step_cmd, 0, 0 }, 358 { "continue", db_continue_cmd, 0, 0 }, 359 { "c", db_continue_cmd, 0, 0 }, 360 { "until", db_trace_until_call_cmd,0, 0 }, 361 { "next", db_trace_until_matching_cmd,0, 0 }, 362 { "match", db_trace_until_matching_cmd,0, 0 }, 363 { "trace", db_stack_trace_cmd, 0, 0 }, 364 { "call", db_fncall, CS_OWN, 0 }, 365 { "show", 0, 0, db_show_cmds }, 366 { "ps", db_ps, 0, 0 }, 367 { (char *)0, } 368}; 369 370struct command *db_last_command = 0; 371 372void 373db_help_cmd() 374{ 375 struct command *cmd = db_command_table; 376 377 while (cmd->name != 0) { 378 db_printf("%-12s", cmd->name); 379 db_end_line(); 380 cmd++; 381 } 382} 383 384void 385db_command_loop() 386{ 387 /* 388 * Initialize 'prev' and 'next' to dot. 389 */ 390 db_prev = db_dot; 391 db_next = db_dot; 392 393 db_cmd_loop_done = 0; 394 while (!db_cmd_loop_done) { 395 396 (void) setjmp(db_jmpbuf); 397 if (db_print_position() != 0) 398 db_printf("\n"); 399 400 db_printf("db> "); 401 (void) db_read_line(); 402 403 db_command(&db_last_command, db_command_table); 404 } 405} 406 407void 408db_error(s) 409 char *s; 410{ 411 if (s) 412 db_printf(s); 413 db_flush_lex(); 414 longjmp(db_jmpbuf, 1); 415} 416 417 418/* 419 * Call random function: 420 * !expr(arg,arg,arg) 421 */ 422void 423db_fncall() 424{ 425 db_expr_t fn_addr; 426#define MAXARGS 11 427 db_expr_t args[MAXARGS]; 428 int nargs = 0; 429 db_expr_t retval; 430 db_expr_t (*func)(); 431 int t; 432 433 if (!db_expression(&fn_addr)) { 434 db_printf("Bad function\n"); 435 db_flush_lex(); 436 return; 437 } 438 func = (db_expr_t (*) ()) fn_addr; 439 440 t = db_read_token(); 441 if (t == tLPAREN) { 442 if (db_expression(&args[0])) { 443 nargs++; 444 while ((t = db_read_token()) == tCOMMA) { 445 if (nargs == MAXARGS) { 446 db_printf("Too many arguments\n"); 447 db_flush_lex(); 448 return; 449 } 450 if (!db_expression(&args[nargs])) { 451 db_printf("Argument missing\n"); 452 db_flush_lex(); 453 return; 454 } 455 nargs++; 456 } 457 db_unread_token(t); 458 } 459 if (db_read_token() != tRPAREN) { 460 db_printf("?\n"); 461 db_flush_lex(); 462 return; 463 } 464 } 465 db_skip_to_eol(); 466 467 while (nargs < MAXARGS) { 468 args[nargs++] = 0; 469 } 470 471 retval = (*func)(args[0], args[1], args[2], args[3], args[4], 472 args[5], args[6], args[7], args[8], args[9] ); 473 db_printf("%#n\n", retval); 474} 475