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$
  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/reboot.h>
  40 #include <sys/systm.h>
  41 #include <sys/cons.h>
  42
  43 #include <ddb/ddb.h>
  44 #include <ddb/db_command.h>
  45 #include <ddb/db_lex.h>
  46 #include <ddb/db_output.h>
  47
  48 #include <machine/setjmp.h>
  49
  50 /*
  51  * Exported global variables
  52  */
  53 boolean_t       db_cmd_loop_done;
  54 db_addr_t       db_dot;
  55 jmp_buf         db_jmpbuf;
  56 db_addr_t       db_last_addr;
  57 db_addr_t       db_prev;
  58 db_addr_t       db_next;
  59
  60 SET_DECLARE(db_cmd_set, struct command);
  61 SET_DECLARE(db_show_cmd_set, struct command);
  62
  63 static db_cmdfcn_t      db_fncall;
  64 static db_cmdfcn_t      db_gdb;
  65
  66 /* XXX this is actually forward-static. */
  67 extern struct command   db_show_cmds[];
  68
  69 /*
  70  * if 'ed' style: 'dot' is set at start of last item printed,
  71  * and '+' points to next line.
  72  * Otherwise: 'dot' points to next item, '..' points to last.
  73  */
  74 static boolean_t        db_ed_style = TRUE;
  75
  76 /*
  77  * Utility routine - discard tokens through end-of-line.
  78  */
  79 void
  80 db_skip_to_eol()
  81 {
  82         int     t;
  83         do {
  84             t = db_read_token();
  85         } while (t != tEOL);
  86 }
  87
  88 /*
  89  * Results of command search.
  90  */
  91 #define CMD_UNIQUE      0
  92 #define CMD_FOUND       1
  93 #define CMD_NONE        2
  94 #define CMD_AMBIGUOUS   3
  95 #define CMD_HELP        4
  96
  97 static void     db_cmd_list __P((struct command *table,
  98                                  struct command **aux_tablep,
  99                                  struct command **aux_tablep_end));
 100 static int      db_cmd_search __P((char *name, struct command *table,
 101                                    struct command **aux_tablep,
 102                                    struct command **aux_tablep_end,
 103                                    struct command **cmdp));
 104 static void     db_command __P((struct command **last_cmdp,
 105                                 struct command *cmd_table,
 106                                 struct command **aux_cmd_tablep,
 107                                 struct command **aux_cmd_tablep_end));
 108
 109 /*
 110  * Search for command prefix.
 111  */
 112 static int
 113 db_cmd_search(name, table, aux_tablep, aux_tablep_end, cmdp)
 114         char *          name;
 115         struct command  *table;
 116         struct command  **aux_tablep;
 117         struct command  **aux_tablep_end;
 118         struct command  **cmdp; /* out */
 119 {
 120         struct command  *cmd;
 121         struct command  **aux_cmdp;
 122         int             result = CMD_NONE;
 123
 124         for (cmd = table; cmd->name != 0; cmd++) {
 125             register char *lp;
 126             register char *rp;
 127             register int  c;
 128
 129             lp = name;
 130             rp = cmd->name;
 131             while ((c = *lp) == *rp) {
 132                 if (c == 0) {
 133                     /* complete match */
 134                     *cmdp = cmd;
 135                     return (CMD_UNIQUE);
 136                 }
 137                 lp++;
 138                 rp++;
 139             }
 140             if (c == 0) {
 141                 /* end of name, not end of command -
 142                    partial match */
 143                 if (result == CMD_FOUND) {
 144                     result = CMD_AMBIGUOUS;
 145                     /* but keep looking for a full match -
 146                        this lets us match single letters */
 147                 }
 148                 else {
 149                     *cmdp = cmd;
 150                     result = CMD_FOUND;
 151                 }
 152             }
 153         }
 154         if (result == CMD_NONE && aux_tablep != 0)
 155             /* XXX repeat too much code. */
 156             for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
 157                 register char *lp;
 158                 register char *rp;
 159                 register int  c;
 160
 161                 lp = name;
 162                 rp = (*aux_cmdp)->name;
 163                 while ((c = *lp) == *rp) {
 164                     if (c == 0) {
 165                         /* complete match */
 166                         *cmdp = *aux_cmdp;
 167                         return (CMD_UNIQUE);
 168                     }
 169                     lp++;
 170                     rp++;
 171                 }
 172                 if (c == 0) {
 173                     /* end of name, not end of command -
 174                        partial match */
 175                     if (result == CMD_FOUND) {
 176                         result = CMD_AMBIGUOUS;
 177                         /* but keep looking for a full match -
 178                            this lets us match single letters */
 179                     }
 180                     else {
 181                         *cmdp = *aux_cmdp;
 182                         result = CMD_FOUND;
 183                     }
 184                 }
 185             }
 186         if (result == CMD_NONE) {
 187             /* check for 'help' */
 188                 if (name[0] == 'h' && name[1] == 'e'
 189                     && name[2] == 'l' && name[3] == 'p')
 190                         result = CMD_HELP;
 191         }
 192         return (result);
 193 }
 194
 195 static void
 196 db_cmd_list(table, aux_tablep, aux_tablep_end)
 197         struct command *table;
 198         struct command **aux_tablep;
 199         struct command **aux_tablep_end;
 200 {
 201         register struct command *cmd;
 202         register struct command **aux_cmdp;
 203
 204         for (cmd = table; cmd->name != 0; cmd++) {
 205             db_printf("%-12s", cmd->name);
 206             db_end_line();
 207         }
 208         if (aux_tablep == 0)
 209             return;
 210         for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
 211             db_printf("%-12s", (*aux_cmdp)->name);
 212             db_end_line();
 213         }
 214 }
 215
 216 static void
 217 db_command(last_cmdp, cmd_table, aux_cmd_tablep, aux_cmd_tablep_end)
 218         struct command  **last_cmdp;    /* IN_OUT */
 219         struct command  *cmd_table;
 220         struct command  **aux_cmd_tablep;
 221         struct command  **aux_cmd_tablep_end;
 222 {
 223         struct command  *cmd;
 224         int             t;
 225         char            modif[TOK_STRING_SIZE];
 226         db_expr_t       addr, count;
 227         boolean_t       have_addr = FALSE;
 228         int             result;
 229
 230         t = db_read_token();
 231         if (t == tEOL) {
 232             /* empty line repeats last command, at 'next' */
 233             cmd = *last_cmdp;
 234             addr = (db_expr_t)db_next;
 235             have_addr = FALSE;
 236             count = 1;
 237             modif[0] = '\0';
 238         }
 239         else if (t == tEXCL) {
 240             db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, (char *)0);
 241             return;
 242         }
 243         else if (t != tIDENT) {
 244             db_printf("?\n");
 245             db_flush_lex();
 246             return;
 247         }
 248         else {
 249             /*
 250              * Search for command
 251              */
 252             while (cmd_table) {
 253                 result = db_cmd_search(db_tok_string,
 254                                        cmd_table,
 255                                        aux_cmd_tablep,
 256                                        aux_cmd_tablep_end,
 257                                        &cmd);
 258                 switch (result) {
 259                     case CMD_NONE:
 260                         db_printf("No such command\n");
 261                         db_flush_lex();
 262                         return;
 263                     case CMD_AMBIGUOUS:
 264                         db_printf("Ambiguous\n");
 265                         db_flush_lex();
 266                         return;
 267                     case CMD_HELP:
 268                         db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
 269                         db_flush_lex();
 270                         return;
 271                     default:
 272                         break;
 273                 }
 274                 if ((cmd_table = cmd->more) != 0) {
 275                     /* XXX usually no more aux's. */
 276                     aux_cmd_tablep = 0;
 277                     if (cmd_table == db_show_cmds)
 278                         aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
 279                         aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
 280
 281                     t = db_read_token();
 282                     if (t != tIDENT) {
 283                         db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
 284                         db_flush_lex();
 285                         return;
 286                     }
 287                 }
 288             }
 289
 290             if ((cmd->flag & CS_OWN) == 0) {
 291                 /*
 292                  * Standard syntax:
 293                  * command [/modifier] [addr] [,count]
 294                  */
 295                 t = db_read_token();
 296                 if (t == tSLASH) {
 297                     t = db_read_token();
 298                     if (t != tIDENT) {
 299                         db_printf("Bad modifier\n");
 300                         db_flush_lex();
 301                         return;
 302                     }
 303                     db_strcpy(modif, db_tok_string);
 304                 }
 305                 else {
 306                     db_unread_token(t);
 307                     modif[0] = '\0';
 308                 }
 309
 310                 if (db_expression(&addr)) {
 311                     db_dot = (db_addr_t) addr;
 312                     db_last_addr = db_dot;
 313                     have_addr = TRUE;
 314                 }
 315                 else {
 316                     addr = (db_expr_t) db_dot;
 317                     have_addr = FALSE;
 318                 }
 319                 t = db_read_token();
 320                 if (t == tCOMMA) {
 321                     if (!db_expression(&count)) {
 322                         db_printf("Count missing\n");
 323                         db_flush_lex();
 324                         return;
 325                     }
 326                 }
 327                 else {
 328                     db_unread_token(t);
 329                     count = -1;
 330                 }
 331                 if ((cmd->flag & CS_MORE) == 0) {
 332                     db_skip_to_eol();
 333                 }
 334             }
 335         }
 336         *last_cmdp = cmd;
 337         if (cmd != 0) {
 338             /*
 339              * Execute the command.
 340              */
 341             (*cmd->fcn)(addr, have_addr, count, modif);
 342
 343             if (cmd->flag & CS_SET_DOT) {
 344                 /*
 345                  * If command changes dot, set dot to
 346                  * previous address displayed (if 'ed' style).
 347                  */
 348                 if (db_ed_style) {
 349                     db_dot = db_prev;
 350                 }
 351                 else {
 352                     db_dot = db_next;
 353                 }
 354             }
 355             else {
 356                 /*
 357                  * If command does not change dot,
 358                  * set 'next' location to be the same.
 359                  */
 360                 db_next = db_dot;
 361             }
 362         }
 363 }
 364
 365 /*
 366  * 'show' commands
 367  */
 368
 369 static struct command db_show_all_cmds[] = {
 370 #if 0
 371         { "threads",    db_show_all_threads,    0,      0 },
 372 #endif
 373         { "procs",      db_ps,                  0,      0 },
 374         { (char *)0 }
 375 };
 376
 377 static struct command db_show_cmds[] = {
 378         { "all",        0,                      0,      db_show_all_cmds },
 379         { "registers",  db_show_regs,           0,      0 },
 380         { "breaks",     db_listbreak_cmd,       0,      0 },
 381 #if 0
 382         { "thread",     db_show_one_thread,     0,      0 },
 383 #endif
 384 #if 0
 385         { "port",       ipc_port_print,         0,      0 },
 386 #endif
 387         { (char *)0, }
 388 };
 389
 390 static struct command db_command_table[] = {
 391         { "print",      db_print_cmd,           0,      0 },
 392         { "p",          db_print_cmd,           0,      0 },
 393         { "examine",    db_examine_cmd,         CS_SET_DOT, 0 },
 394         { "x",          db_examine_cmd,         CS_SET_DOT, 0 },
 395         { "search",     db_search_cmd,          CS_OWN|CS_SET_DOT, 0 },
 396         { "set",        db_set_cmd,             CS_OWN, 0 },
 397         { "write",      db_write_cmd,           CS_MORE|CS_SET_DOT, 0 },
 398         { "w",          db_write_cmd,           CS_MORE|CS_SET_DOT, 0 },
 399         { "delete",     db_delete_cmd,          0,      0 },
 400         { "d",          db_delete_cmd,          0,      0 },
 401         { "break",      db_breakpoint_cmd,      0,      0 },
 402         { "dwatch",     db_deletewatch_cmd,     0,      0 },
 403         { "watch",      db_watchpoint_cmd,      CS_MORE,0 },
 404         { "dhwatch",    db_deletehwatch_cmd,    0,      0 },
 405         { "hwatch",     db_hwatchpoint_cmd,     0,      0 },
 406         { "step",       db_single_step_cmd,     0,      0 },
 407         { "s",          db_single_step_cmd,     0,      0 },
 408         { "continue",   db_continue_cmd,        0,      0 },
 409         { "c",          db_continue_cmd,        0,      0 },
 410         { "until",      db_trace_until_call_cmd,0,      0 },
 411         { "next",       db_trace_until_matching_cmd,0,  0 },
 412         { "match",      db_trace_until_matching_cmd,0,  0 },
 413         { "trace",      db_stack_trace_cmd,     0,      0 },
 414         { "call",       db_fncall,              CS_OWN, 0 },
 415         { "show",       0,                      0,      db_show_cmds },
 416         { "ps",         db_ps,                  0,      0 },
 417         { "gdb",        db_gdb,                 0,      0 },
 418         { (char *)0, }
 419 };
 420
 421 static struct command   *db_last_command = 0;
 422
 423 #if 0
 424 void
 425 db_help_cmd()
 426 {
 427         struct command *cmd = db_command_table;
 428
 429         while (cmd->name != 0) {
 430             db_printf("%-12s", cmd->name);
 431             db_end_line();
 432             cmd++;
 433         }
 434 }
 435 #endif
 436
 437 /*
 438  * At least one non-optional command must be implemented using
 439  * DB_COMMAND() so that db_cmd_set gets created.  Here is one.
 440  */
 441 DB_COMMAND(panic, db_panic)
 442 {
 443         panic("from debugger");
 444 }
 445
 446 void
 447 db_command_loop()
 448 {
 449         /*
 450          * Initialize 'prev' and 'next' to dot.
 451          */
 452         db_prev = db_dot;
 453         db_next = db_dot;
 454
 455         db_cmd_loop_done = 0;
 456         while (!db_cmd_loop_done) {
 457
 458             (void) setjmp(db_jmpbuf);
 459             if (db_print_position() != 0)
 460                 db_printf("\n");
 461
 462             db_printf("db> ");
 463             (void) db_read_line();
 464
 465             db_command(&db_last_command, db_command_table,
 466                        SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
 467         }
 468 }
 469
 470 void
 471 db_error(s)
 472         char *s;
 473 {
 474         if (s)
 475             db_printf("%s", s);
 476         db_flush_lex();
 477         longjmp(db_jmpbuf, 1);
 478 }
 479
 480
 481 /*
 482  * Call random function:
 483  * !expr(arg,arg,arg)
 484  */
 485 static void
 486 db_fncall(dummy1, dummy2, dummy3, dummy4)
 487         db_expr_t       dummy1;
 488         boolean_t       dummy2;
 489         db_expr_t       dummy3;
 490         char *          dummy4;
 491 {
 492         db_expr_t       fn_addr;
 493 #define MAXARGS         11      /* XXX only 10 are passed */
 494         db_expr_t       args[MAXARGS];
 495         int             nargs = 0;
 496         db_expr_t       retval;
 497         typedef db_expr_t fcn_10args_t __P((db_expr_t, db_expr_t, db_expr_t,
 498                                             db_expr_t, db_expr_t, db_expr_t,
 499                                             db_expr_t, db_expr_t, db_expr_t,
 500                                             db_expr_t));
 501         fcn_10args_t    *func;
 502         int             t;
 503
 504         if (!db_expression(&fn_addr)) {
 505             db_printf("Bad function\n");
 506             db_flush_lex();
 507             return;
 508         }
 509         func = (fcn_10args_t *)fn_addr; /* XXX */
 510
 511         t = db_read_token();
 512         if (t == tLPAREN) {
 513             if (db_expression(&args[0])) {
 514                 nargs++;
 515                 while ((t = db_read_token()) == tCOMMA) {
 516                     if (nargs == MAXARGS) {
 517                         db_printf("Too many arguments\n");
 518                         db_flush_lex();
 519                         return;
 520                     }
 521                     if (!db_expression(&args[nargs])) {
 522                         db_printf("Argument missing\n");
 523                         db_flush_lex();
 524                         return;
 525                     }
 526                     nargs++;
 527                 }
 528                 db_unread_token(t);
 529             }
 530             if (db_read_token() != tRPAREN) {
 531                 db_printf("?\n");
 532                 db_flush_lex();
 533                 return;
 534             }
 535         }
 536         db_skip_to_eol();
 537
 538         while (nargs < MAXARGS) {
 539             args[nargs++] = 0;
 540         }
 541
 542         retval = (*func)(args[0], args[1], args[2], args[3], args[4],
 543                          args[5], args[6], args[7], args[8], args[9] );
 544         db_printf("%#lr\n", (long)retval);
 545 }
 546
 547 /* Enter GDB remote protocol debugger on the next trap. */
 548
 549 dev_t      gdbdev = NODEV;
 550 cn_getc_t *gdb_getc;
 551 cn_putc_t *gdb_putc;
 552
 553 static void
 554 db_gdb (dummy1, dummy2, dummy3, dummy4)
 555         db_expr_t       dummy1;
 556         boolean_t       dummy2;
 557         db_expr_t       dummy3;
 558         char *          dummy4;
 559 {
 560
 561         if (gdbdev == NODEV) {
 562                 db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
 563                 db_printf("in your configuration file (currently sio only).\n");
 564                 return;
 565         }
 566         boothowto ^= RB_GDB;
 567
 568         db_printf("Next trap will enter %s\n",
 569                    boothowto & RB_GDB ? "GDB remote protocol mode"
 570                                       : "DDB debugger");
 571 }