db_command.c revision 1.108
1 /* $NetBSD: db_command.c,v 1.108 2007/10/14 00:37:56 uwe Exp $ */ 2 /* 3 * Mach Operating System 4 * Copyright (c) 1991,1990 Carnegie Mellon University 5 * All Rights Reserved. 6 * 7 * Permission to use, copy, modify and distribute this software and its 8 * documentation is hereby granted, provided that both the copyright 9 * notice and this permission notice appear in all copies of the 10 * software, derivative works or modified versions, and any portions 11 * thereof, and that both notices appear in supporting documentation. 12 * 13 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 14 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 15 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 16 * 17 * Carnegie Mellon requests users of this software to return to 18 * 19 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU 20 * School of Computer Science 21 * Carnegie Mellon University 22 * Pittsburgh PA 15213-3890 23 * 24 * any improvements or extensions that they make and grant Carnegie the 25 * rights to redistribute these changes. 26 */ 27 /* 28 * Copyright (c) 1996, 1997, 1998, 1999, 2002 The NetBSD Foundation, Inc. 29 * All rights reserved. 30 * 31 * This code is derived from software contributed to The NetBSD Foundation 32 * by Adam Hamsik. 33 * 34 * Redistribution and use in source and binary forms, with or without 35 * modification, are permitted provided that the following conditions 36 * are met: 37 * 1. Redistributions of source code must retain the above copyright 38 * notice, this list of conditions and the following disclaimer. 39 * 2. Redistributions in binary form must reproduce the above copyright 40 * notice, this list of conditions and the following disclaimer in the 41 * documentation and/or other materials provided with the distribution. 42 * 3. All advertising materials mentioning features or use of this software 43 * must display the following acknowledgement: 44 * This product includes software developed by the NetBSD 45 * Foundation, Inc. and its contributors. 46 * 4. Neither the name of The NetBSD Foundation nor the names of its 47 * contributors may be used to endorse or promote products derived 48 * from this software without specific prior written permission. 49 * 50 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 51 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 52 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 53 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 54 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 55 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 56 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 57 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 58 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 59 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 60 * POSSIBILITY OF SUCH DAMAGE. 61 */ 62 63 /* 64 * Command dispatcher. 65 */ 66 67 #include <sys/cdefs.h> 68 __KERNEL_RCSID(0, "$NetBSD: db_command.c,v 1.108 2007/10/14 00:37:56 uwe Exp $"); 69 70 #include "opt_ddb.h" 71 #include "opt_kgdb.h" 72 #include "opt_inet.h" 73 #include "opt_ddbparam.h" 74 75 #include <sys/param.h> 76 #include <sys/systm.h> 77 #include <sys/reboot.h> 78 #include <sys/device.h> 79 #include <sys/malloc.h> 80 #include <sys/mbuf.h> 81 #include <sys/namei.h> 82 #include <sys/pool.h> 83 #include <sys/proc.h> 84 #include <sys/vnode.h> 85 #include <sys/lockdebug.h> 86 #include <sys/sleepq.h> 87 88 /*include queue macros*/ 89 #include <sys/queue.h> 90 91 #include <machine/db_machdep.h> /* type definitions */ 92 93 #if defined(_KERNEL_OPT) 94 #include "opt_multiprocessor.h" 95 #endif 96 #ifdef MULTIPROCESSOR 97 #include <machine/cpu.h> 98 #endif 99 100 #include <ddb/db_lex.h> 101 #include <ddb/db_output.h> 102 #include <ddb/db_command.h> 103 #include <ddb/db_break.h> 104 #include <ddb/db_watch.h> 105 #include <ddb/db_run.h> 106 #include <ddb/db_variables.h> 107 #include <ddb/db_interface.h> 108 #include <ddb/db_sym.h> 109 #include <ddb/db_extern.h> 110 111 #include <uvm/uvm_extern.h> 112 #include <uvm/uvm_ddb.h> 113 114 #include "arp.h" 115 116 /* 117 * Results of command search. 118 */ 119 #define CMD_UNIQUE 0 120 #define CMD_FOUND 1 121 #define CMD_NONE 2 122 #define CMD_AMBIGUOUS 3 123 124 /* 125 * Exported global variables 126 */ 127 bool db_cmd_loop_done; 128 label_t *db_recover; 129 db_addr_t db_dot; 130 db_addr_t db_last_addr; 131 db_addr_t db_prev; 132 db_addr_t db_next; 133 134 135 /* 136 New DDB api for adding and removing commands uses three lists, because 137 we use two types of commands 138 a) standard commands without subcommands -> reboot 139 b) show commands which are subcommands of show command -> show aio_jobs 140 c) if defined machine specific commands 141 142 ddb_add_cmd, ddb_rem_cmd use type (DDB_SHOW_CMD||DDB_BASE_CMD)argument to 143 add them to representativ lists. 144 */ 145 146 static const struct db_command db_command_table[]; 147 static const struct db_command db_show_cmds[]; 148 #ifdef DB_MACHINE_COMMANDS 149 static const struct db_command db_machine_command_table[]; 150 #endif 151 152 /* the global queue of all command tables */ 153 TAILQ_HEAD(db_cmd_tbl_en_head, db_cmd_tbl_en); 154 155 /* TAILQ entry used to register command tables */ 156 struct db_cmd_tbl_en { 157 const struct db_command *db_cmd; /* cmd table */ 158 TAILQ_ENTRY(db_cmd_tbl_en) db_cmd_next; 159 }; 160 161 /* head of base commands list */ 162 static struct db_cmd_tbl_en_head db_base_cmd_list = 163 TAILQ_HEAD_INITIALIZER(db_base_cmd_list); 164 static struct db_cmd_tbl_en db_base_cmd_builtins = 165 { .db_cmd = db_command_table }; 166 167 /* head of show commands list */ 168 static struct db_cmd_tbl_en_head db_show_cmd_list = 169 TAILQ_HEAD_INITIALIZER(db_show_cmd_list); 170 static struct db_cmd_tbl_en db_show_cmd_builtins = 171 { .db_cmd = db_show_cmds }; 172 173 /* head of machine commands list */ 174 static struct db_cmd_tbl_en_head db_mach_cmd_list = 175 TAILQ_HEAD_INITIALIZER(db_mach_cmd_list); 176 #ifdef DB_MACHINE_COMMANDS 177 static struct db_cmd_tbl_en db_mach_cmd_builtins = 178 { .db_cmd = db_machine_command_table }; 179 #endif 180 181 /* 182 * if 'ed' style: 'dot' is set at start of last item printed, 183 * and '+' points to next line. 184 * Otherwise: 'dot' points to next item, '..' points to last. 185 */ 186 static bool db_ed_style = true; 187 188 static void db_init_commands(void); 189 static int db_register_tbl_entry(uint8_t type, 190 struct db_cmd_tbl_en *list_ent); 191 static void db_cmd_list(const struct db_cmd_tbl_en_head *); 192 static int db_cmd_search(const char *, const struct db_command *, 193 const struct db_command **); 194 static void db_command(const struct db_command **); 195 static void db_buf_print_cmd(db_expr_t, bool, db_expr_t, const char *); 196 static void db_event_print_cmd(db_expr_t, bool, db_expr_t, const char *); 197 static void db_fncall(db_expr_t, bool, db_expr_t, const char *); 198 static int db_get_list_type(const char *); 199 static void db_help_print_cmd(db_expr_t, bool, db_expr_t, const char *); 200 static void db_lock_print_cmd(db_expr_t, bool, db_expr_t, const char *); 201 static void db_mount_print_cmd(db_expr_t, bool, db_expr_t, const char *); 202 static void db_mbuf_print_cmd(db_expr_t, bool, db_expr_t, const char *); 203 static void db_malloc_print_cmd(db_expr_t, bool, db_expr_t, const char *); 204 static void db_map_print_cmd(db_expr_t, bool, db_expr_t, const char *); 205 static void db_namecache_print_cmd(db_expr_t, bool, db_expr_t, 206 const char *); 207 static void db_object_print_cmd(db_expr_t, bool, db_expr_t, const char *); 208 static void db_page_print_cmd(db_expr_t, bool, db_expr_t, const char *); 209 static void db_show_all_pages(db_expr_t, bool, db_expr_t, const char *); 210 static void db_pool_print_cmd(db_expr_t, bool, db_expr_t, const char *); 211 static void db_reboot_cmd(db_expr_t, bool, db_expr_t, const char *); 212 static void db_sifting_cmd(db_expr_t, bool, db_expr_t, const char *); 213 static void db_stack_trace_cmd(db_expr_t, bool, db_expr_t, const char *); 214 static void db_sync_cmd(db_expr_t, bool, db_expr_t, const char *); 215 static void db_uvmexp_print_cmd(db_expr_t, bool, db_expr_t, const char *); 216 static void db_vnode_print_cmd(db_expr_t, bool, db_expr_t, const char *); 217 218 static const struct db_command db_show_cmds[] = { 219 /*added from all sub cmds*/ 220 { DDB_ADD_CMD("callout", db_show_callout, 221 0 ,"List all used callout functions.",NULL,NULL) }, 222 { DDB_ADD_CMD("pages", db_show_all_pages, 223 0 ,"List all used memory pages.",NULL,NULL) }, 224 { DDB_ADD_CMD("procs", db_show_all_procs, 225 0 ,"List all processes.",NULL,NULL) }, 226 { DDB_ADD_CMD("pools", db_show_all_pools, 227 0 ,"Show all poolS",NULL,NULL) }, 228 /*added from all sub cmds*/ 229 { DDB_ADD_CMD("aio_jobs", db_show_aio_jobs, 0, 230 "Show aio jobs",NULL,NULL) }, 231 { DDB_ADD_CMD("all", NULL, 232 CS_COMPAT, NULL,NULL,NULL) }, 233 #if defined(INET) && (NARP > 0) 234 { DDB_ADD_CMD("arptab", db_show_arptab, 0,NULL,NULL,NULL) }, 235 #endif 236 { DDB_ADD_CMD("breaks", db_listbreak_cmd, 0, 237 "Display all breaks.",NULL,NULL) }, 238 { DDB_ADD_CMD("buf", db_buf_print_cmd, 0, 239 "Print the struct buf at address.", "[/f] address",NULL) }, 240 { DDB_ADD_CMD("event", db_event_print_cmd, 0, 241 "Print all the non-zero evcnt(9) event counters.", "[/f]",NULL) }, 242 { DDB_ADD_CMD("lock", db_lock_print_cmd, 0,NULL,NULL,NULL) }, 243 { DDB_ADD_CMD("malloc", db_malloc_print_cmd,0,NULL,NULL,NULL) }, 244 { DDB_ADD_CMD("map", db_map_print_cmd, 0, 245 "Print the vm_map at address.", "[/f] address",NULL) }, 246 { DDB_ADD_CMD("mount", db_mount_print_cmd, 0, 247 "Print the mount structure at address.", "[/f] address",NULL) }, 248 { DDB_ADD_CMD("mbuf", db_mbuf_print_cmd, 0,NULL,NULL, 249 "-c prints all mbuf chains") }, 250 { DDB_ADD_CMD("ncache", db_namecache_print_cmd, 0, 251 "Dump the namecache list.", "address",NULL) }, 252 { DDB_ADD_CMD("object", db_object_print_cmd, 0, 253 "Print the vm_object at address.", "[/f] address",NULL) }, 254 { DDB_ADD_CMD("page", db_page_print_cmd, 0, 255 "Print the vm_page at address.", "[/f] address",NULL) }, 256 { DDB_ADD_CMD("pool", db_pool_print_cmd, 0, 257 "Print the pool at address.", "[/clp] address",NULL) }, 258 { DDB_ADD_CMD("registers", db_show_regs, 0, 259 "Display the register set.", "[/u]",NULL) }, 260 { DDB_ADD_CMD("sched_qs", db_show_sched_qs, 0, 261 "Print the state of the scheduler's run queues.", 262 NULL,NULL) }, 263 { DDB_ADD_CMD("uvmexp", db_uvmexp_print_cmd, 0, 264 "Print a selection of UVM counters and statistics.", 265 NULL,NULL) }, 266 { DDB_ADD_CMD("vnode", db_vnode_print_cmd, 0, 267 "Print the vnode at address.", "[/f] address",NULL) }, 268 { DDB_ADD_CMD("watches", db_listwatch_cmd, 0, 269 "Display all watchpoints.", NULL,NULL) }, 270 { DDB_ADD_CMD(NULL, NULL, 0,NULL,NULL,NULL) } 271 }; 272 273 /* arch/<arch>/<arch>/db_interface.c */ 274 #ifdef DB_MACHINE_COMMANDS 275 extern const struct db_command db_machine_command_table[]; 276 #endif 277 278 static const struct db_command db_command_table[] = { 279 { DDB_ADD_CMD("b", db_breakpoint_cmd, 0, 280 "Set a breakpoint at address", "[/u] address[,count].",NULL) }, 281 { DDB_ADD_CMD("break", db_breakpoint_cmd, 0, 282 "Set a breakpoint at address", "[/u] address[,count].",NULL) }, 283 { DDB_ADD_CMD("bt", db_stack_trace_cmd, 0, 284 "Show backtrace.", "See help trace.",NULL) }, 285 { DDB_ADD_CMD("c", db_continue_cmd, 0, 286 "Continue execution.", "[/c]",NULL) }, 287 { DDB_ADD_CMD("call", db_fncall, CS_OWN, 288 "Call the function", "address[(expression[,...])]",NULL) }, 289 { DDB_ADD_CMD("callout", db_show_callout, 0, NULL, 290 NULL,NULL ) }, 291 { DDB_ADD_CMD("continue", db_continue_cmd, 0, 292 "Continue execution.", "[/c]",NULL) }, 293 { DDB_ADD_CMD("d", db_delete_cmd, 0, 294 "Delete a breakpoint.", "address | #number",NULL) }, 295 { DDB_ADD_CMD("delete", db_delete_cmd, 0, 296 "Delete a breakpoint.", "address | #number",NULL) }, 297 { DDB_ADD_CMD("dmesg", db_dmesg, 0, 298 "Show kernel message buffer.", "[count]",NULL) }, 299 { DDB_ADD_CMD("dwatch", db_deletewatch_cmd, 0, 300 "Delete the watchpoint.", "address",NULL) }, 301 { DDB_ADD_CMD("examine", db_examine_cmd, CS_SET_DOT, 302 "Display the address locations.", 303 "[/modifier] address[,count]",NULL) }, 304 { DDB_ADD_CMD("help", db_help_print_cmd, CS_OWN|CS_NOREPEAT, 305 "Display help about commands", 306 "Use other commands as arguments.",NULL) }, 307 { DDB_ADD_CMD("kill", db_kill_proc, CS_OWN, 308 "Send a signal to the process","pid[,signal_number]", 309 " pid:\t\t\tthe process id (may need 0t prefix for decimal)\n" 310 " signal_number:\tthe signal to send") }, 311 #ifdef KGDB 312 { DDB_ADD_CMD("kgdb", db_kgdb_cmd, 0, NULL,NULL,NULL) }, 313 #endif 314 { DDB_ADD_CMD("machine",NULL,CS_MACH, 315 "Architecture specific functions.",NULL,NULL) }, 316 { DDB_ADD_CMD("match", db_trace_until_matching_cmd,0, 317 "Stop at the matching return instruction.","See help next",NULL) }, 318 { DDB_ADD_CMD("next", db_trace_until_matching_cmd,0, 319 "Stop at the matching return instruction.","[/p]",NULL) }, 320 { DDB_ADD_CMD("p", db_print_cmd, 0, 321 "Print address according to the format.", 322 "[/axzodurc] address [address ...]",NULL) }, 323 { DDB_ADD_CMD("print", db_print_cmd, 0, 324 "Print address according to the format.", 325 "[/axzodurc] address [address ...]",NULL) }, 326 { DDB_ADD_CMD("ps", db_show_all_procs, 0, 327 "Print all processes.","See show all procs",NULL) }, 328 { DDB_ADD_CMD("reboot", db_reboot_cmd, CS_OWN, 329 "Reboot","0x1 RB_ASKNAME, 0x2 RB_SINGLE, 0x4 RB_NOSYNC, 0x8 RB_HALT," 330 "0x40 RB_KDB, 0x100 RB_DUMP, 0x808 RB_POWERDOWN",NULL) }, 331 { DDB_ADD_CMD("s", db_single_step_cmd, 0, 332 "Single-step count times.","[/p] [,count]",NULL) }, 333 { DDB_ADD_CMD("search", db_search_cmd, CS_OWN|CS_SET_DOT, 334 "Search memory from address for value.", 335 "[/bhl] address value [mask] [,count]",NULL) }, 336 { DDB_ADD_CMD("set", db_set_cmd, CS_OWN, 337 "Set the named variable","$variable [=] expression",NULL) }, 338 { DDB_ADD_CMD("show", NULL, CS_SHOW, 339 "Show kernel stats.", NULL,NULL) }, 340 { DDB_ADD_CMD("sifting", db_sifting_cmd, CS_OWN, 341 "Search the symbol tables ","[/F] string",NULL) }, 342 { DDB_ADD_CMD("step", db_single_step_cmd, 0, 343 "Single-step count times.","[/p] [,count]",NULL) }, 344 { DDB_ADD_CMD("sync", db_sync_cmd, CS_OWN, 345 "Force a crash dump, and then reboot.",NULL,NULL) }, 346 { DDB_ADD_CMD("trace", db_stack_trace_cmd, 0, 347 "Stack trace from frame-address.", 348 "[/u[l]] [frame-address][,count]",NULL) }, 349 { DDB_ADD_CMD("until", db_trace_until_call_cmd,0, 350 "Stop at the next call or return instruction.","[/p]",NULL) }, 351 { DDB_ADD_CMD("w", db_write_cmd, CS_MORE|CS_SET_DOT, 352 "Set a watchpoint for a region. ","address[,size]",NULL) }, 353 { DDB_ADD_CMD("watch", db_watchpoint_cmd, CS_MORE, 354 "Set a watchpoint for a region. ","address[,size]",NULL) }, 355 { DDB_ADD_CMD("write", db_write_cmd, CS_MORE|CS_SET_DOT, 356 "Write the expressions at succeeding locations.", 357 "[/bhl] address expression [expression ...]",NULL) }, 358 { DDB_ADD_CMD("x", db_examine_cmd, CS_SET_DOT, 359 "Display the address locations.", 360 "[/modifier] address[,count]",NULL) }, 361 { DDB_ADD_CMD(NULL, NULL, 0, NULL, NULL, NULL) } 362 }; 363 364 static const struct db_command *db_last_command = NULL; 365 #if defined(DDB_COMMANDONENTER) 366 char db_cmd_on_enter[DB_LINE_MAXLEN + 1] = ___STRING(DDB_COMMANDONENTER); 367 #else /* defined(DDB_COMMANDONENTER) */ 368 char db_cmd_on_enter[DB_LINE_MAXLEN + 1] = ""; 369 #endif /* defined(DDB_COMMANDONENTER) */ 370 #define DB_LINE_SEP ';' 371 372 /* 373 * Utility routine - discard tokens through end-of-line. 374 */ 375 void 376 db_skip_to_eol(void) 377 { 378 int t; 379 380 do { 381 t = db_read_token(); 382 } while (t != tEOL); 383 } 384 385 void 386 db_error(const char *s) 387 { 388 389 if (s) 390 db_printf("%s", s); 391 db_flush_lex(); 392 longjmp(db_recover); 393 } 394 395 /*Execute commandlist after ddb start 396 *This function goes through the command list created from commands and ';' 397 */ 398 399 static void 400 db_execute_commandlist(const char *cmdlist) 401 { 402 const char *cmd = cmdlist; 403 const struct db_command *dummy = NULL; 404 405 while (*cmd != '\0') { 406 const char *ep = cmd; 407 408 while (*ep != '\0' && *ep != DB_LINE_SEP) { 409 ep++; 410 } 411 db_set_line(cmd, ep); 412 db_command(&dummy); 413 cmd = ep; 414 if (*cmd == DB_LINE_SEP) { 415 cmd++; 416 } 417 } 418 } 419 420 /*Initialize ddb command tables*/ 421 void 422 db_init_commands(void) 423 { 424 static bool done = false; 425 426 if (done) return; 427 done = true; 428 429 /* register command tables */ 430 (void)db_register_tbl_entry(DDB_BASE_CMD, &db_base_cmd_builtins); 431 #ifdef DB_MACHINE_COMMANDS 432 (void)db_register_tbl_entry(DDB_MACH_CMD, &db_mach_cmd_builtins); 433 #endif 434 (void)db_register_tbl_entry(DDB_SHOW_CMD, &db_show_cmd_builtins); 435 } 436 437 438 /* 439 * Add command table to the specified list 440 * Arg: 441 * int type specifies type of command table DDB_SHOW_CMD|DDB_BASE_CMD|DDB_MAC_CMD 442 * *cmd_tbl poiter to static allocated db_command table 443 * 444 *Command table must be NULL terminated array of struct db_command 445 */ 446 int 447 db_register_tbl(uint8_t type, const struct db_command *cmd_tbl) 448 { 449 struct db_cmd_tbl_en *list_ent; 450 451 if (cmd_tbl->name == 0) 452 /* empty list - ignore */ 453 return 0; 454 455 /* force builtin commands to be registered first */ 456 db_init_commands(); 457 458 /* now create a list entry for this table */ 459 list_ent = malloc(sizeof(struct db_cmd_tbl_en), M_TEMP, M_ZERO); 460 if (list_ent == NULL) 461 return ENOMEM; 462 list_ent->db_cmd=cmd_tbl; 463 464 /* and register it */ 465 return db_register_tbl_entry(type, list_ent); 466 } 467 468 static int 469 db_register_tbl_entry(uint8_t type, struct db_cmd_tbl_en *list_ent) 470 { 471 struct db_cmd_tbl_en_head *list; 472 473 switch(type) { 474 case DDB_BASE_CMD: 475 list = &db_base_cmd_list; 476 break; 477 case DDB_SHOW_CMD: 478 list = &db_show_cmd_list; 479 break; 480 case DDB_MACH_CMD: 481 list = &db_mach_cmd_list; 482 break; 483 default: 484 return ENOENT; 485 } 486 487 TAILQ_INSERT_TAIL(list, list_ent, db_cmd_next); 488 489 return 0; 490 } 491 492 /* 493 * Remove command table specified with db_cmd address == cmd_tbl 494 */ 495 int 496 db_unregister_tbl(uint8_t type,const struct db_command *cmd_tbl) 497 { 498 struct db_cmd_tbl_en *list_ent; 499 struct db_cmd_tbl_en_head *list; 500 501 /* find list on which the entry should live */ 502 switch (type) { 503 case DDB_BASE_CMD: 504 list=&db_base_cmd_list; 505 break; 506 case DDB_SHOW_CMD: 507 list=&db_show_cmd_list; 508 break; 509 case DDB_MACH_CMD: 510 list=&db_mach_cmd_list; 511 break; 512 default: 513 return EINVAL; 514 } 515 516 TAILQ_FOREACH (list_ent,list,db_cmd_next) { 517 if (list_ent->db_cmd == cmd_tbl){ 518 TAILQ_REMOVE(list, 519 list_ent,db_cmd_next); 520 free(list_ent,M_TEMP); 521 return 0; 522 } 523 } 524 return ENOENT; 525 } 526 527 /*This function is called from machine trap code.*/ 528 void 529 db_command_loop(void) 530 { 531 532 label_t db_jmpbuf; 533 label_t *savejmp; 534 535 /* 536 * Initialize 'prev' and 'next' to dot. 537 */ 538 db_prev = db_dot; 539 db_next = db_dot; 540 541 db_cmd_loop_done = false; 542 543 /*Init default command tables add machine, base, 544 show command tables to the list*/ 545 db_init_commands(); 546 547 /*save context for return from ddb*/ 548 savejmp = db_recover; 549 db_recover = &db_jmpbuf; 550 (void) setjmp(&db_jmpbuf); 551 552 /*Execute default ddb start commands*/ 553 db_execute_commandlist(db_cmd_on_enter); 554 555 (void) setjmp(&db_jmpbuf); 556 while (!db_cmd_loop_done) { 557 if (db_print_position() != 0) 558 db_printf("\n"); 559 db_output_line = 0; 560 561 562 #ifdef MULTIPROCESSOR 563 db_printf("db{%ld}> ", (long)cpu_number()); 564 #else 565 db_printf("db> "); 566 #endif 567 (void) db_read_line(); 568 569 db_command(&db_last_command); 570 } 571 572 db_recover = savejmp; 573 } 574 575 /* 576 * Search for command table for command prefix 577 * ret: CMD_UNIQUE -> completely matches command 578 * CMD_FOUND -> matches prefix of single command 579 * CMD_AMBIGIOUS -> matches prefix of more than one command 580 * CMD_NONE -> command not found 581 */ 582 static int 583 db_cmd_search(const char *name,const struct db_command *table, 584 const struct db_command **cmdp) 585 { 586 587 const struct db_command *cmd; 588 int result; 589 590 result = CMD_NONE; 591 for (cmd = table; cmd->name != 0; cmd++) { 592 const char *lp; 593 const char *rp; 594 595 lp = name; 596 rp = cmd->name; 597 while (*lp != '\0' && *lp == *rp) { 598 rp++; 599 lp++; 600 } 601 602 if (*lp != '\0') /* mismatch or extra chars in name */ 603 continue; 604 605 if (*rp == '\0') { /* complete match */ 606 *cmdp = cmd; 607 return (CMD_UNIQUE); 608 } 609 610 /* prefix match: end of name, not end of command */ 611 if (result == CMD_NONE) { 612 result = CMD_FOUND; 613 *cmdp = cmd; 614 } 615 else if (result == CMD_FOUND) { 616 result = CMD_AMBIGUOUS; 617 *cmdp = NULL; 618 } 619 } 620 621 return (result); 622 } 623 624 /* 625 *List commands to the console. 626 */ 627 static void 628 db_cmd_list(const struct db_cmd_tbl_en_head *list) 629 { 630 631 struct db_cmd_tbl_en *list_ent; 632 const struct db_command *table; 633 size_t i, j, w, columns, lines, numcmds, width=0; 634 const char *p; 635 636 TAILQ_FOREACH(list_ent,list,db_cmd_next) { 637 table = list_ent->db_cmd; 638 for (i = 0; table[i].name != NULL; i++) { 639 w = strlen(table[i].name); 640 if (w > width) 641 width = w; 642 } 643 } 644 645 width = DB_NEXT_TAB(width); 646 647 columns = db_max_width / width; 648 if (columns == 0) 649 columns = 1; 650 651 TAILQ_FOREACH(list_ent,list,db_cmd_next) { 652 table = list_ent->db_cmd; 653 654 for (numcmds = 0; table[numcmds].name != NULL; numcmds++) 655 ; 656 lines = (numcmds + columns - 1) / columns; 657 658 for (i = 0; i < lines; i++) { 659 for (j = 0; j < columns; j++) { 660 p = table[j * lines + i].name; 661 if (p) 662 db_printf("%s", p); 663 if (j * lines + i + lines >= numcmds) { 664 db_putchar('\n'); 665 break; 666 } 667 if (p) { 668 w = strlen(p); 669 while (w < width) { 670 w = DB_NEXT_TAB(w); 671 db_putchar('\t'); 672 } 673 } 674 } 675 } 676 } 677 return; 678 } 679 680 /* 681 *Returns type of list for command with name *name. 682 */ 683 static int 684 db_get_list_type(const char *name) 685 { 686 687 const struct db_command *cmd; 688 struct db_cmd_tbl_en *list_ent; 689 int error,ret=-1; 690 691 /* search for the command name */ 692 TAILQ_FOREACH(list_ent,&db_base_cmd_list,db_cmd_next) { 693 /* 694 * cmd_search returns CMD_UNIQUE, CMD_FOUND ... 695 * CMD_UNIQUE when name was completly matched to cmd->name 696 * CMD_FOUND when name was only partially matched to cmd->name 697 * CMD_NONE command not found in a list 698 * CMD_AMBIGIOUS ->more partialy matches 699 */ 700 701 error = db_cmd_search(name, list_ent->db_cmd, &cmd); 702 703 if (error == CMD_UNIQUE) { 704 /* exact match found */ 705 if (cmd->flag == CS_SHOW) { 706 ret = DDB_SHOW_CMD; 707 break; 708 } 709 if (cmd->flag == CS_MACH) { 710 ret = DDB_MACH_CMD; 711 break; 712 } else { 713 ret = DDB_BASE_CMD; 714 break; 715 } 716 717 } else if (error == CMD_FOUND){ 718 /* 719 * partial match, search will continue, but 720 * note current result in case we won't 721 * find anything better. 722 */ 723 if (cmd->flag == CS_SHOW) 724 ret = DDB_SHOW_CMD; 725 if (cmd->flag == CS_MACH) 726 ret = DDB_MACH_CMD; 727 else 728 ret = DDB_BASE_CMD; 729 } 730 } 731 732 return ret; 733 } 734 735 /* 736 *Parse command line and execute apropriate function. 737 */ 738 static void 739 db_command(const struct db_command **last_cmdp) 740 { 741 const struct db_command *command; 742 struct db_cmd_tbl_en *list_ent; 743 struct db_cmd_tbl_en_head *list; 744 745 int t; 746 int result; 747 748 char modif[TOK_STRING_SIZE]; 749 db_expr_t addr, count; 750 bool have_addr = false; 751 752 static db_expr_t last_count = 0; 753 754 command = NULL; /* XXX gcc */ 755 756 t = db_read_token(); 757 if ((t == tEOL) || (t == tCOMMA)) { 758 /* 759 * An empty line repeats last command, at 'next'. 760 * Only a count repeats the last command with the new count. 761 */ 762 command = *last_cmdp; 763 764 if (!command) 765 return; 766 767 addr = (db_expr_t)db_next; 768 if (t == tCOMMA) { 769 if (!db_expression(&count)) { 770 db_printf("Count missing\n"); 771 db_flush_lex(); 772 return; 773 } 774 } else 775 count = last_count; 776 have_addr = false; 777 modif[0] = '\0'; 778 db_skip_to_eol(); 779 780 } else if (t == tEXCL) { 781 db_fncall(0, 0, 0, NULL); 782 return; 783 784 } else if (t != tIDENT) { 785 db_printf("?\n"); 786 db_flush_lex(); 787 return; 788 789 } else { 790 791 switch(db_get_list_type(db_tok_string)) { 792 793 case DDB_BASE_CMD: 794 list = &db_base_cmd_list; 795 break; 796 797 case DDB_SHOW_CMD: 798 list = &db_show_cmd_list; 799 /* need to read show subcommand if show command list 800 is used. */ 801 t = db_read_token(); 802 803 if (t != tIDENT) { 804 /* if only show command is executed, print 805 all subcommands */ 806 db_cmd_list(list); 807 db_flush_lex(); 808 return; 809 } 810 break; 811 case DDB_MACH_CMD: 812 list = &db_mach_cmd_list; 813 /* need to read machine subcommand if 814 machine level 2 command list is used. */ 815 t = db_read_token(); 816 817 if (t != tIDENT) { 818 /* if only show command is executed, print 819 all subcommands */ 820 db_cmd_list(list); 821 db_flush_lex(); 822 return; 823 } 824 break; 825 default: 826 db_printf("No such command\n"); 827 db_flush_lex(); 828 return; 829 } 830 831 COMPAT_RET: 832 TAILQ_FOREACH(list_ent, list, db_cmd_next) { 833 result = db_cmd_search(db_tok_string, list_ent->db_cmd, 834 &command); 835 836 /* after CMD_UNIQUE in cmd_list only a single command 837 name is possible */ 838 if (result == CMD_UNIQUE) 839 break; 840 841 } 842 843 /* check compatibility flag */ 844 if (command && command->flag & CS_COMPAT){ 845 t = db_read_token(); 846 if (t != tIDENT) { 847 db_cmd_list(list); 848 db_flush_lex(); 849 return; 850 } 851 852 /* support only level 2 commands here */ 853 goto COMPAT_RET; 854 } 855 856 if (!command) { 857 db_printf("No such command\n"); 858 db_flush_lex(); 859 return; 860 } 861 862 if ((command->flag & CS_OWN) == 0) { 863 864 /* 865 * Standard syntax: 866 * command [/modifier] [addr] [,count] 867 */ 868 t = db_read_token(); /* get modifier */ 869 if (t == tSLASH) { 870 t = db_read_token(); 871 if (t != tIDENT) { 872 db_printf("Bad modifier\n"); 873 db_flush_lex(); 874 return; 875 } 876 /* save modifier */ 877 strlcpy(modif, db_tok_string, sizeof(modif)); 878 879 } else { 880 db_unread_token(t); 881 modif[0] = '\0'; 882 } 883 884 if (db_expression(&addr)) { /*get address*/ 885 db_dot = (db_addr_t) addr; 886 db_last_addr = db_dot; 887 have_addr = true; 888 } else { 889 addr = (db_expr_t) db_dot; 890 have_addr = false; 891 } 892 893 t = db_read_token(); 894 if (t == tCOMMA) { /*Get count*/ 895 if (!db_expression(&count)) { 896 db_printf("Count missing\n"); 897 db_flush_lex(); 898 return; 899 } 900 } else { 901 db_unread_token(t); 902 count = -1; 903 } 904 if ((command->flag & CS_MORE) == 0) { 905 db_skip_to_eol(); 906 } 907 } 908 } 909 910 if (command->flag & CS_NOREPEAT) { 911 *last_cmdp = NULL; 912 last_count = 0; 913 } else { 914 *last_cmdp = command; 915 last_count = count; 916 } 917 918 if (command != NULL) { 919 /* 920 * Execute the command. 921 */ 922 if (command->fcn != NULL) 923 (*command->fcn)(addr, have_addr, count, modif); 924 925 if (command->flag & CS_SET_DOT) { 926 /* 927 * If command changes dot, set dot to 928 * previous address displayed (if 'ed' style). 929 */ 930 if (db_ed_style) 931 db_dot = db_prev; 932 else 933 db_dot = db_next; 934 } else { 935 /* 936 * If command does not change dot, 937 * set 'next' location to be the same. 938 */ 939 db_next = db_dot; 940 } 941 } 942 } 943 944 /* 945 * Print help for commands 946 */ 947 static void 948 db_help_print_cmd(db_expr_t addr, bool have_addr, db_expr_t count, 949 const char *modif) 950 { 951 952 const struct db_cmd_tbl_en_head *list; 953 const struct db_cmd_tbl_en *list_ent; 954 const struct db_command *help; 955 int t, result; 956 957 t = db_read_token(); 958 /* is there another command after the "help"? */ 959 if (t == tIDENT){ 960 961 switch(db_get_list_type(db_tok_string)){ 962 963 case DDB_BASE_CMD: 964 list=&db_base_cmd_list; 965 break; 966 case DDB_SHOW_CMD: 967 list=&db_show_cmd_list; 968 /* read the show subcommand */ 969 t = db_read_token(); 970 971 if (t != tIDENT) { 972 /* no subcommand, print the list */ 973 db_cmd_list(list); 974 db_flush_lex(); 975 return; 976 } 977 978 break; 979 case DDB_MACH_CMD: 980 list=&db_mach_cmd_list; 981 /* read machine subcommand */ 982 t = db_read_token(); 983 984 if (t != tIDENT) { 985 /* no subcommand - just print the list */ 986 db_cmd_list(list); 987 db_flush_lex(); 988 return; 989 } 990 break; 991 992 default: 993 db_printf("No such command\n"); 994 db_flush_lex(); 995 return; 996 } 997 COMPAT_RET: 998 TAILQ_FOREACH(list_ent,list,db_cmd_next){ 999 result = db_cmd_search(db_tok_string, list_ent->db_cmd, 1000 &help); 1001 /* after CMD_UNIQUE only a single command 1002 name is possible */ 1003 if (result == CMD_UNIQUE) 1004 break; 1005 } 1006 #ifdef DDB_VERBOSE_HELP 1007 /*print help*/ 1008 1009 db_printf("Command: %s\n",help->name); 1010 1011 if (help->cmd_descr != NULL) 1012 db_printf(" Description: %s\n",help->cmd_descr); 1013 1014 if (help->cmd_arg != NULL) 1015 db_printf(" Arguments: %s\n",help->cmd_arg); 1016 1017 if (help->cmd_arg_help != NULL) 1018 db_printf(" Arguments description:\n%s\n", 1019 help->cmd_arg_help); 1020 1021 if ((help->cmd_arg == NULL) && (help->cmd_descr == NULL)) 1022 db_printf("%s Doesn't have any help message included.\n", 1023 help->name); 1024 #endif 1025 /* check compatibility flag */ 1026 /* 1027 * The "show all" command table has been merged with the 1028 * "show" command table - but we want to keep the old UI 1029 * available. So if we find a CS_COMPAT entry, we read 1030 * the next token and try again. 1031 */ 1032 if (help->flag == CS_COMPAT){ 1033 t = db_read_token(); 1034 1035 if (t != tIDENT){ 1036 db_cmd_list(list); 1037 db_flush_lex(); 1038 return; 1039 } 1040 1041 goto COMPAT_RET; 1042 /* support only level 2 commands here */ 1043 } else { 1044 db_skip_to_eol(); 1045 } 1046 1047 } else /* t != tIDENT */ 1048 /* print base commands */ 1049 db_cmd_list(&db_base_cmd_list); 1050 1051 return; 1052 } 1053 /*ARGSUSED*/ 1054 static void 1055 db_map_print_cmd(db_expr_t addr, bool have_addr, db_expr_t count, 1056 const char *modif) 1057 { 1058 bool full = false; 1059 1060 if (modif[0] == 'f') 1061 full = true; 1062 1063 if (have_addr == false) 1064 addr = (db_expr_t)(intptr_t) kernel_map; 1065 1066 uvm_map_printit((struct vm_map *)(intptr_t) addr, full, db_printf); 1067 } 1068 1069 /*ARGSUSED*/ 1070 static void 1071 db_malloc_print_cmd(db_expr_t addr, bool have_addr, 1072 db_expr_t count, const char *modif) 1073 { 1074 1075 #ifdef MALLOC_DEBUG 1076 if (!have_addr) 1077 addr = 0; 1078 1079 debug_malloc_printit(db_printf, (vaddr_t) addr); 1080 #else 1081 db_printf("The kernel is not built with the MALLOC_DEBUG option.\n"); 1082 #endif /* MALLOC_DEBUG */ 1083 } 1084 1085 /*ARGSUSED*/ 1086 static void 1087 db_object_print_cmd(db_expr_t addr, bool have_addr, 1088 db_expr_t count, const char *modif) 1089 { 1090 bool full = false; 1091 1092 if (modif[0] == 'f') 1093 full = true; 1094 1095 uvm_object_printit((struct uvm_object *)(intptr_t) addr, full, 1096 db_printf); 1097 } 1098 1099 /*ARGSUSED*/ 1100 static void 1101 db_page_print_cmd(db_expr_t addr, bool have_addr, 1102 db_expr_t count, const char *modif) 1103 { 1104 bool full = false; 1105 1106 if (modif[0] == 'f') 1107 full = true; 1108 1109 uvm_page_printit((struct vm_page *)(intptr_t) addr, full, db_printf); 1110 } 1111 1112 /*ARGSUSED*/ 1113 static void 1114 db_show_all_pages(db_expr_t addr, bool have_addr, 1115 db_expr_t count, const char *modif) 1116 { 1117 1118 uvm_page_printall(db_printf); 1119 } 1120 1121 /*ARGSUSED*/ 1122 static void 1123 db_buf_print_cmd(db_expr_t addr, bool have_addr, 1124 db_expr_t count, const char *modif) 1125 { 1126 bool full = false; 1127 1128 if (modif[0] == 'f') 1129 full = true; 1130 1131 vfs_buf_print((struct buf *)(intptr_t) addr, full, db_printf); 1132 } 1133 1134 /*ARGSUSED*/ 1135 static void 1136 db_event_print_cmd(db_expr_t addr, bool have_addr, 1137 db_expr_t count, const char *modif) 1138 { 1139 bool full = false; 1140 1141 if (modif[0] == 'f') 1142 full = true; 1143 1144 event_print(full, db_printf); 1145 } 1146 1147 /*ARGSUSED*/ 1148 static void 1149 db_vnode_print_cmd(db_expr_t addr, bool have_addr, 1150 db_expr_t count, const char *modif) 1151 { 1152 bool full = false; 1153 1154 if (modif[0] == 'f') 1155 full = true; 1156 1157 vfs_vnode_print((struct vnode *)(intptr_t) addr, full, db_printf); 1158 } 1159 1160 static void 1161 db_mount_print_cmd(db_expr_t addr, bool have_addr, 1162 db_expr_t count, const char *modif) 1163 { 1164 bool full = false; 1165 1166 if (modif[0] == 'f') 1167 full = true; 1168 1169 vfs_mount_print((struct mount *)(intptr_t) addr, full, db_printf); 1170 } 1171 1172 /*ARGSUSED*/ 1173 static void 1174 db_mbuf_print_cmd(db_expr_t addr, bool have_addr, 1175 db_expr_t count, const char *modif) 1176 { 1177 1178 m_print((const struct mbuf *)(intptr_t) addr, modif, db_printf); 1179 } 1180 1181 /*ARGSUSED*/ 1182 static void 1183 db_pool_print_cmd(db_expr_t addr, bool have_addr, 1184 db_expr_t count, const char *modif) 1185 { 1186 1187 pool_printit((struct pool *)(intptr_t) addr, modif, db_printf); 1188 } 1189 1190 /*ARGSUSED*/ 1191 static void 1192 db_namecache_print_cmd(db_expr_t addr, bool have_addr, 1193 db_expr_t count, const char *modif) 1194 { 1195 1196 namecache_print((struct vnode *)(intptr_t) addr, db_printf); 1197 } 1198 1199 /*ARGSUSED*/ 1200 static void 1201 db_uvmexp_print_cmd(db_expr_t addr, bool have_addr, 1202 db_expr_t count, const char *modif) 1203 { 1204 1205 uvmexp_print(db_printf); 1206 } 1207 1208 /*ARGSUSED*/ 1209 static void 1210 db_lock_print_cmd(db_expr_t addr, bool have_addr, 1211 db_expr_t count, const char *modif) 1212 { 1213 1214 lockdebug_lock_print((void *)addr, db_printf); 1215 } 1216 1217 /* 1218 * Call random function: 1219 * !expr(arg,arg,arg) 1220 */ 1221 /*ARGSUSED*/ 1222 static void 1223 db_fncall(db_expr_t addr, bool have_addr, 1224 db_expr_t count, const char *modif) 1225 { 1226 db_expr_t fn_addr; 1227 #define MAXARGS 11 1228 db_expr_t args[MAXARGS]; 1229 int nargs = 0; 1230 db_expr_t retval; 1231 db_expr_t (*func)(db_expr_t, ...); 1232 int t; 1233 1234 if (!db_expression(&fn_addr)) { 1235 db_printf("Bad function\n"); 1236 db_flush_lex(); 1237 return; 1238 } 1239 func = (db_expr_t (*)(db_expr_t, ...))(intptr_t) fn_addr; 1240 1241 t = db_read_token(); 1242 if (t == tLPAREN) { 1243 if (db_expression(&args[0])) { 1244 nargs++; 1245 while ((t = db_read_token()) == tCOMMA) { 1246 if (nargs == MAXARGS) { 1247 db_printf("Too many arguments\n"); 1248 db_flush_lex(); 1249 return; 1250 } 1251 if (!db_expression(&args[nargs])) { 1252 db_printf("Argument missing\n"); 1253 db_flush_lex(); 1254 return; 1255 } 1256 nargs++; 1257 } 1258 db_unread_token(t); 1259 } 1260 if (db_read_token() != tRPAREN) { 1261 db_printf("?\n"); 1262 db_flush_lex(); 1263 return; 1264 } 1265 } 1266 db_skip_to_eol(); 1267 1268 while (nargs < MAXARGS) { 1269 args[nargs++] = 0; 1270 } 1271 1272 retval = (*func)(args[0], args[1], args[2], args[3], args[4], 1273 args[5], args[6], args[7], args[8], args[9]); 1274 db_printf("%s\n", db_num_to_str(retval)); 1275 } 1276 1277 static void 1278 db_reboot_cmd(db_expr_t addr, bool have_addr, 1279 db_expr_t count, const char *modif) 1280 { 1281 db_expr_t bootflags; 1282 1283 /* Flags, default to RB_AUTOBOOT */ 1284 if (!db_expression(&bootflags)) 1285 bootflags = (db_expr_t)RB_AUTOBOOT; 1286 if (db_read_token() != tEOL) { 1287 db_error("?\n"); 1288 /*NOTREACHED*/ 1289 } 1290 /* 1291 * We are leaving DDB, never to return upward. 1292 * Clear db_recover so that we can debug faults in functions 1293 * called from cpu_reboot. 1294 */ 1295 db_recover = 0; 1296 cpu_reboot((int)bootflags, NULL); 1297 } 1298 1299 static void 1300 db_sifting_cmd(db_expr_t addr, bool have_addr, 1301 db_expr_t count, const char *modif) 1302 { 1303 int mode, t; 1304 1305 t = db_read_token(); 1306 if (t == tSLASH) { 1307 t = db_read_token(); 1308 if (t != tIDENT) { 1309 bad_modifier: 1310 db_printf("Bad modifier\n"); 1311 db_flush_lex(); 1312 return; 1313 } 1314 if (!strcmp(db_tok_string, "F")) 1315 mode = 'F'; 1316 else 1317 goto bad_modifier; 1318 t = db_read_token(); 1319 } else 1320 mode = 0; 1321 1322 if (t == tIDENT) 1323 db_sifting(db_tok_string, mode); 1324 else { 1325 db_printf("Bad argument (non-string)\n"); 1326 db_flush_lex(); 1327 } 1328 } 1329 1330 static void 1331 db_stack_trace_cmd(db_expr_t addr, bool have_addr, db_expr_t count, const char *modif) 1332 { 1333 register const char *cp = modif; 1334 register char c; 1335 void (*pr)(const char *, ...); 1336 1337 pr = db_printf; 1338 while ((c = *cp++) != 0) 1339 if (c == 'l') 1340 pr = printf; 1341 1342 if (count == -1) 1343 count = 65535; 1344 1345 db_stack_trace_print(addr, have_addr, count, modif, pr); 1346 } 1347 1348 static void 1349 db_sync_cmd(db_expr_t addr, bool have_addr, 1350 db_expr_t count, const char *modif) 1351 { 1352 1353 /* 1354 * We are leaving DDB, never to return upward. 1355 * Clear db_recover so that we can debug faults in functions 1356 * called from cpu_reboot. 1357 */ 1358 db_recover = 0; 1359 cpu_reboot(RB_DUMP, NULL); 1360 } 1361
Indexes created Wed Sep 24 15:09:51 GMT 2025