share/man/man4/ddb.4

   1 .\"
   2 .\" Mach Operating System
   3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
   4 .\" Copyright (c) 2007 Robert N. M. Watson
   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@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 Mellon
  25 .\" the rights to redistribute these changes.
  26 .\"
  27 .\" changed a \# to #, since groff choked on it.
  28 .\"
  29 .\" HISTORY
  30 .\" ddb.4,v
  31 .\" Revision 1.1  1993/07/15  18:41:02  brezak
  32 .\" Man page for DDB
  33 .\"
  34 .\" Revision 2.6  92/04/08  08:52:57  rpd
  35 .\"     Changes from OSF.
  36 .\"     [92/01/17  14:19:22  jsb]
  37 .\"     Changes for OSF debugger modifications.
  38 .\"     [91/12/12            tak]
  39 .\"
  40 .\" Revision 2.5  91/06/25  13:50:22  rpd
  41 .\"     Added some watchpoint explanation.
  42 .\"     [91/06/25            rpd]
  43 .\"
  44 .\" Revision 2.4  91/06/17  15:47:31  jsb
  45 .\"     Added documentation for continue/c, match, search, and watchpoints.
  46 .\"     I've not actually explained what a watchpoint is; maybe Rich can
  47 .\"     do that (hint, hint).
  48 .\"     [91/06/17  10:58:08  jsb]
  49 .\"
  50 .\" Revision 2.3  91/05/14  17:04:23  mrt
  51 .\"     Correcting copyright
  52 .\"
  53 .\" Revision 2.2  91/02/14  14:10:06  mrt
  54 .\"     Changed to new Mach copyright
  55 .\"     [91/02/12  18:10:12  mrt]
  56 .\"
  57 .\" Revision 2.2  90/08/30  14:23:15  dbg
  58 .\"     Created.
  59 .\"     [90/08/30            dbg]
  60 .\"
  61 .\" $FreeBSD$
  62 .\"
  63 .Dd July 15, 2014
  64 .Dt DDB 4
  65 .Os
  66 .Sh NAME
  67 .Nm ddb
  68 .Nd interactive kernel debugger
  69 .Sh SYNOPSIS
  70 In order to enable kernel debugging facilities include:
  71 .Bd -ragged -offset indent
  72 .Cd options KDB
  73 .Cd options DDB
  74 .Ed
  75 .Pp
  76 To prevent activation of the debugger on kernel
  77 .Xr panic 9 :
  78 .Bd -ragged -offset indent
  79 .Cd options KDB_UNATTENDED
  80 .Ed
  81 .Pp
  82 In order to print a stack trace of the current thread on the console
  83 for a panic:
  84 .Bd -ragged -offset indent
  85 .Cd options KDB_TRACE
  86 .Ed
  87 .Pp
  88 To print the numerical value of symbols in addition to the symbolic
  89 representation, define:
  90 .Bd -ragged -offset indent
  91 .Cd options DDB_NUMSYM
  92 .Ed
  93 .Pp
  94 To enable the
  95 .Xr gdb 1
  96 backend, so that remote debugging with
  97 .Xr kgdb 1
  98 is possible, include:
  99 .Bd -ragged -offset indent
 100 .Cd options GDB
 101 .Ed
 102 .Sh DESCRIPTION
 103 The
 104 .Nm
 105 kernel debugger is an interactive debugger with a syntax inspired by
 106 .Xr gdb 1 .
 107 If linked into the running kernel,
 108 it can be invoked locally with the
 109 .Ql debug
 110 .Xr keymap 5
 111 action.
 112 The debugger is also invoked on kernel
 113 .Xr panic 9
 114 if the
 115 .Va debug.debugger_on_panic
 116 .Xr sysctl 8
 117 MIB variable is set non-zero,
 118 which is the default
 119 unless the
 120 .Dv KDB_UNATTENDED
 121 option is specified.
 122 .Pp
 123 The current location is called
 124 .Va dot .
 125 The
 126 .Va dot
 127 is displayed with
 128 a hexadecimal format at a prompt.
 129 The commands
 130 .Ic examine
 131 and
 132 .Ic write
 133 update
 134 .Va dot
 135 to the address of the last line
 136 examined or the last location modified, and set
 137 .Va next
 138 to the address of
 139 the next location to be examined or changed.
 140 Other commands do not change
 141 .Va dot ,
 142 and set
 143 .Va next
 144 to be the same as
 145 .Va dot .
 146 .Pp
 147 The general command syntax is:
 148 .Ar command Ns Op Li / Ns Ar modifier
 149 .Ar address Ns Op Li , Ns Ar count
 150 .Pp
 151 A blank line repeats the previous command from the address
 152 .Va next
 153 with
 154 count 1 and no modifiers.
 155 Specifying
 156 .Ar address
 157 sets
 158 .Va dot
 159 to the address.
 160 Omitting
 161 .Ar address
 162 uses
 163 .Va dot .
 164 A missing
 165 .Ar count
 166 is taken
 167 to be 1 for printing commands or infinity for stack traces.
 168 .Pp
 169 The
 170 .Nm
 171 debugger has a pager feature (like the
 172 .Xr more 1
 173 command)
 174 for the output.
 175 If an output line exceeds the number set in the
 176 .Va lines
 177 variable, it displays
 178 .Dq Li --More--
 179 and waits for a response.
 180 The valid responses for it are:
 181 .Pp
 182 .Bl -tag -compact -width ".Li SPC"
 183 .It Li SPC
 184 one more page
 185 .It Li RET
 186 one more line
 187 .It Li q
 188 abort the current command, and return to the command input mode
 189 .El
 190 .Pp
 191 Finally,
 192 .Nm
 193 provides a small (currently 10 items) command history, and offers
 194 simple
 195 .Nm emacs Ns -style
 196 command line editing capabilities.
 197 In addition to
 198 the
 199 .Nm emacs
 200 control keys, the usual
 201 .Tn ANSI
 202 arrow keys may be used to
 203 browse through the history buffer, and move the cursor within the
 204 current line.
 205 .Sh COMMANDS
 206 .Bl -tag -width indent -compact
 207 .It Ic examine
 208 .It Ic x
 209 Display the addressed locations according to the formats in the modifier.
 210 Multiple modifier formats display multiple locations.
 211 If no format is specified, the last format specified for this command
 212 is used.
 213 .Pp
 214 The format characters are:
 215 .Bl -tag -compact -width indent
 216 .It Cm b
 217 look at by bytes (8 bits)
 218 .It Cm h
 219 look at by half words (16 bits)
 220 .It Cm l
 221 look at by long words (32 bits)
 222 .It Cm g
 223 look at by quad words (64 bits)
 224 .It Cm a
 225 print the location being displayed
 226 .It Cm A
 227 print the location with a line number if possible
 228 .It Cm x
 229 display in unsigned hex
 230 .It Cm z
 231 display in signed hex
 232 .It Cm o
 233 display in unsigned octal
 234 .It Cm d
 235 display in signed decimal
 236 .It Cm u
 237 display in unsigned decimal
 238 .It Cm r
 239 display in current radix, signed
 240 .It Cm c
 241 display low 8 bits as a character.
 242 Non-printing characters are displayed as an octal escape code (e.g.,
 243 .Ql \e000 ) .
 244 .It Cm s
 245 display the null-terminated string at the location.
 246 Non-printing characters are displayed as octal escapes.
 247 .It Cm m
 248 display in unsigned hex with character dump at the end of each line.
 249 The location is also displayed in hex at the beginning of each line.
 250 .It Cm i
 251 display as an instruction
 252 .It Cm I
 253 display as an instruction with possible alternate formats depending on the
 254 machine:
 255 .Bl -tag -width ".Tn powerpc" -compact
 256 .It Tn amd64
 257 No alternate format.
 258 .It Tn i386
 259 No alternate format.
 260 .It Tn ia64
 261 No alternate format.
 262 .It Tn powerpc
 263 No alternate format.
 264 .It Tn sparc64
 265 No alternate format.
 266 .El
 267 .It Cm S
 268 display a symbol name for the pointer stored at the address
 269 .El
 270 .Pp
 271 .It Ic xf
 272 Examine forward:
 273 execute an
 274 .Ic examine
 275 command with the last specified parameters to it
 276 except that the next address displayed by it is used as the start address.
 277 .Pp
 278 .It Ic xb
 279 Examine backward:
 280 execute an
 281 .Ic examine
 282 command with the last specified parameters to it
 283 except that the last start address subtracted by the size displayed by it
 284 is used as the start address.
 285 .Pp
 286 .It Ic print Ns Op Li / Ns Cm acdoruxz
 287 .It Ic p Ns Op Li / Ns Cm acdoruxz
 288 Print
 289 .Ar addr Ns s
 290 according to the modifier character (as described above for
 291 .Cm examine ) .
 292 Valid formats are:
 293 .Cm a , x , z , o , d , u , r ,
 294 and
 295 .Cm c .
 296 If no modifier is specified, the last one specified to it is used.
 297 The argument
 298 .Ar addr
 299 can be a string, in which case it is printed as it is.
 300 For example:
 301 .Bd -literal -offset indent
 302 print/x "eax = " $eax "\enecx = " $ecx "\en"
 303 .Ed
 304 .Pp
 305 will print like:
 306 .Bd -literal -offset indent
 307 eax = xxxxxx
 308 ecx = yyyyyy
 309 .Ed
 310 .Pp
 311 .It Xo
 312 .Ic write Ns Op Li / Ns Cm bhl
 313 .Ar addr expr1 Op Ar expr2 ...
 314 .Xc
 315 .It Xo
 316 .Ic w Ns Op Li / Ns Cm bhl
 317 .Ar addr expr1 Op Ar expr2 ...
 318 .Xc
 319 Write the expressions specified after
 320 .Ar addr
 321 on the command line at succeeding locations starting with
 322 .Ar addr .
 323 The write unit size can be specified in the modifier with a letter
 324 .Cm b
 325 (byte),
 326 .Cm h
 327 (half word) or
 328 .Cm l
 329 (long word) respectively.
 330 If omitted,
 331 long word is assumed.
 332 .Pp
 333 .Sy Warning :
 334 since there is no delimiter between expressions, strange
 335 things may happen.
 336 It is best to enclose each expression in parentheses.
 337 .Pp
 338 .It Ic set Li $ Ns Ar variable Oo Li = Oc Ar expr
 339 Set the named variable or register with the value of
 340 .Ar expr .
 341 Valid variable names are described below.
 342 .Pp
 343 .It Ic break Ns Op Li / Ns Cm u
 344 .It Ic b Ns Op Li / Ns Cm u
 345 Set a break point at
 346 .Ar addr .
 347 If
 348 .Ar count
 349 is supplied, continues
 350 .Ar count
 351 \- 1 times before stopping at the
 352 break point.
 353 If the break point is set, a break point number is
 354 printed with
 355 .Ql # .
 356 This number can be used in deleting the break point
 357 or adding conditions to it.
 358 .Pp
 359 If the
 360 .Cm u
 361 modifier is specified, this command sets a break point in user
 362 address space.
 363 Without the
 364 .Cm u
 365 option, the address is considered to be in the kernel
 366 space, and a wrong space address is rejected with an error message.
 367 This modifier can be used only if it is supported by machine dependent
 368 routines.
 369 .Pp
 370 .Sy Warning :
 371 If a user text is shadowed by a normal user space debugger,
 372 user space break points may not work correctly.
 373 Setting a break
 374 point at the low-level code paths may also cause strange behavior.
 375 .Pp
 376 .It Ic delete Ar addr
 377 .It Ic d Ar addr
 378 .It Ic delete Li # Ns Ar number
 379 .It Ic d Li # Ns Ar number
 380 Delete the break point.
 381 The target break point can be specified by a
 382 break point number with
 383 .Ql # ,
 384 or by using the same
 385 .Ar addr
 386 specified in the original
 387 .Ic break
 388 command.
 389 .Pp
 390 .It Ic watch Ar addr Ns Li , Ns Ar size
 391 Set a watchpoint for a region.
 392 Execution stops when an attempt to modify the region occurs.
 393 The
 394 .Ar size
 395 argument defaults to 4.
 396 If you specify a wrong space address, the request is rejected
 397 with an error message.
 398 .Pp
 399 .Sy Warning :
 400 Attempts to watch wired kernel memory
 401 may cause unrecoverable error in some systems such as i386.
 402 Watchpoints on user addresses work best.
 403 .Pp
 404 .It Ic hwatch Ar addr Ns Li , Ns Ar size
 405 Set a hardware watchpoint for a region if supported by the
 406 architecture.
 407 Execution stops when an attempt to modify the region occurs.
 408 The
 409 .Ar size
 410 argument defaults to 4.
 411 .Pp
 412 .Sy Warning :
 413 The hardware debug facilities do not have a concept of separate
 414 address spaces like the watch command does.
 415 Use
 416 .Ic hwatch
 417 for setting watchpoints on kernel address locations only, and avoid
 418 its use on user mode address spaces.
 419 .Pp
 420 .It Ic dhwatch Ar addr Ns Li , Ns Ar size
 421 Delete specified hardware watchpoint.
 422 .Pp
 423 .It Ic step Ns Op Li / Ns Cm p
 424 .It Ic s Ns Op Li / Ns Cm p
 425 Single step
 426 .Ar count
 427 times (the comma is a mandatory part of the syntax).
 428 If the
 429 .Cm p
 430 modifier is specified, print each instruction at each step.
 431 Otherwise, only print the last instruction.
 432 .Pp
 433 .Sy Warning :
 434 depending on machine type, it may not be possible to
 435 single-step through some low-level code paths or user space code.
 436 On machines with software-emulated single-stepping (e.g., pmax),
 437 stepping through code executed by interrupt handlers will probably
 438 do the wrong thing.
 439 .Pp
 440 .It Ic continue Ns Op Li / Ns Cm c
 441 .It Ic c Ns Op Li / Ns Cm c
 442 Continue execution until a breakpoint or watchpoint.
 443 If the
 444 .Cm c
 445 modifier is specified, count instructions while executing.
 446 Some machines (e.g., pmax) also count loads and stores.
 447 .Pp
 448 .Sy Warning :
 449 when counting, the debugger is really silently single-stepping.
 450 This means that single-stepping on low-level code may cause strange
 451 behavior.
 452 .Pp
 453 .It Ic until Ns Op Li / Ns Cm p
 454 Stop at the next call or return instruction.
 455 If the
 456 .Cm p
 457 modifier is specified, print the call nesting depth and the
 458 cumulative instruction count at each call or return.
 459 Otherwise,
 460 only print when the matching return is hit.
 461 .Pp
 462 .It Ic next Ns Op Li / Ns Cm p
 463 .It Ic match Ns Op Li / Ns Cm p
 464 Stop at the matching return instruction.
 465 If the
 466 .Cm p
 467 modifier is specified, print the call nesting depth and the
 468 cumulative instruction count at each call or return.
 469 Otherwise, only print when the matching return is hit.
 470 .Pp
 471 .It Xo
 472 .Ic trace Ns Op Li / Ns Cm u
 473 .Op Ar pid | tid
 474 .Op Li , Ns Ar count
 475 .Xc
 476 .It Xo
 477 .Ic t Ns Op Li / Ns Cm u
 478 .Op Ar pid | tid
 479 .Op Li , Ns Ar count
 480 .Xc
 481 .It Xo
 482 .Ic where Ns Op Li / Ns Cm u
 483 .Op Ar pid | tid
 484 .Op Li , Ns Ar count
 485 .Xc
 486 .It Xo
 487 .Ic bt Ns Op Li / Ns Cm u
 488 .Op Ar pid | tid
 489 .Op Li , Ns Ar count
 490 .Xc
 491 Stack trace.
 492 The
 493 .Cm u
 494 option traces user space; if omitted,
 495 .Ic trace
 496 only traces
 497 kernel space.
 498 The optional argument
 499 .Ar count
 500 is the number of frames to be traced.
 501 If
 502 .Ar count
 503 is omitted, all frames are printed.
 504 .Pp
 505 .Sy Warning :
 506 User space stack trace is valid
 507 only if the machine dependent code supports it.
 508 .Pp
 509 .It Xo
 510 .Ic search Ns Op Li / Ns Cm bhl
 511 .Ar addr
 512 .Ar value
 513 .Op Ar mask
 514 .Op Li , Ns Ar count
 515 .Xc
 516 Search memory for
 517 .Ar value .
 518 This command might fail in interesting
 519 ways if it does not find the searched-for value.
 520 This is because
 521 .Nm
 522 does not always recover from touching bad memory.
 523 The optional
 524 .Ar count
 525 argument limits the search.
 526 .\"
 527 .Pp
 528 .It Xo
 529 .Ic findstack
 530 .Ar addr
 531 .Xc
 532 Prints the thread address for a thread kernel-mode stack of which contains the
 533 specified address.
 534 If the thread is not found, search the thread stack cache and prints the
 535 cached stack address.
 536 Otherwise, prints nothing.
 537 .Pp
 538 .It Ic show Cm all procs Ns Op Li / Ns Cm m
 539 .It Ic ps Ns Op Li / Ns Cm m
 540 Display all process information.
 541 The process information may not be shown if it is not
 542 supported in the machine, or the bottom of the stack of the
 543 target process is not in the main memory at that time.
 544 The
 545 .Cm m
 546 modifier will alter the display to show VM map
 547 addresses for the process and not show other information.
 548 .\"
 549 .Pp
 550 .It Ic show Cm all ttys
 551 Show all TTY's within the system.
 552 Output is similar to
 553 .Xr pstat 8 ,
 554 but also includes the address of the TTY structure.
 555 .\"
 556 .Pp
 557 .It Ic show Cm allchains
 558 Show the same information like "show lockchain" does, but
 559 for every thread in the system.
 560 .\"
 561 .Pp
 562 .It Ic show Cm alllocks
 563 Show all locks that are currently held.
 564 This command is only available if
 565 .Xr witness 4
 566 is included in the kernel.
 567 .\"
 568 .Pp
 569 .It Ic show Cm allpcpu
 570 The same as "show pcpu", but for every CPU present in the system.
 571 .\"
 572 .Pp
 573 .It Ic show Cm allrman
 574 Show information related with resource management, including
 575 interrupt request lines, DMA request lines, I/O ports and I/O memory
 576 addresses.
 577 .\"
 578 .Pp
 579 .It Ic show Cm apic
 580 Dump data about APIC IDT vector mappings.
 581 .\"
 582 .Pp
 583 .It Ic show Cm breaks
 584 Show breakpoints set with the "break" command.
 585 .\"
 586 .Pp
 587 .It Ic show Cm bio Ar addr
 588 Show information about the bio structure
 589 .Vt struct bio
 590 present at
 591 .Ar addr .
 592 See the
 593 .Pa sys/bio.h
 594 header file and
 595 .Xr g_bio 9
 596 for more details on the exact meaning of the structure fields.
 597 .\"
 598 .Pp
 599 .It Ic show Cm buffer Ar addr
 600 Show information about the buf structure
 601 .Vt struct buf
 602 present at
 603 .Ar addr .
 604 See the
 605 .Pa sys/buf.h
 606 header file for more details on the exact meaning of the structure fields.
 607 .\"
 608 .Pp
 609 .It Ic show Cm cbstat
 610 Show brief information about the TTY subsystem.
 611 .\"
 612 .Pp
 613 .It Ic show Cm cdev
 614 Without argument, show the list of all created cdev's, consisting of devfs
 615 node name and struct cdev address.
 616 When address of cdev is supplied, show some internal devfs state of the cdev.
 617 .\"
 618 .Pp
 619 .It Ic show Cm conifhk
 620 Lists hooks currently waiting for completion in
 621 run_interrupt_driven_config_hooks().
 622 .\"
 623 .Pp
 624 .It Ic show Cm cpusets
 625 Print numbered root and assigned CPU affinity sets.
 626 See
 627 .Xr cpuset 2
 628 for more details.
 629 .\"
 630 .Pp
 631 .It Ic show Cm cyrixreg
 632 Show registers specific to the Cyrix processor.
 633 .\"
 634 .Pp
 635 .It Ic show Cm domain Ar addr
 636 Print protocol domain structure
 637 .Vt struct domain
 638 at address
 639 .Ar addr .
 640 See the
 641 .Pa sys/domain.h
 642 header file for more details on the exact meaning of the structure fields.
 643 .\"
 644 .Pp
 645 .It Ic show Cm ffs Op Ar addr
 646 Show brief information about ffs mount at the address
 647 .Ar addr ,
 648 if argument is given.
 649 Otherwise, provides the summary about each ffs mount.
 650 .\"
 651 .Pp
 652 .It Ic show Cm file Ar addr
 653 Show information about the file structure
 654 .Vt struct file
 655 present at address
 656 .Ar addr .
 657 .\"
 658 .Pp
 659 .It Ic show Cm files
 660 Show information about every file structure in the system.
 661 .\"
 662 .Pp
 663 .It Ic show Cm freepages
 664 Show the number of physical pages in each of the free lists.
 665 .\"
 666 .Pp
 667 .It Ic show Cm geom Op Ar addr
 668 If the
 669 .Ar addr
 670 argument is not given, displays the entire GEOM topology.
 671 If
 672 .Ar addr
 673 is given, displays details about the given GEOM object (class, geom,
 674 provider or consumer).
 675 .\"
 676 .Pp
 677 .It Ic show Cm idt
 678 Show IDT layout.
 679 The first column specifies the IDT vector.
 680 The second one is the name of the interrupt/trap handler.
 681 Those functions are machine dependent.
 682 .\"
 683 .Pp
 684 .It Ic show Cm inodedeps Op Ar addr
 685 Show brief information about each inodedep structure.
 686 If
 687 .Ar addr
 688 is given, only inodedeps belonging to the fs located at the
 689 supplied address are shown.
 690 .\"
 691 .Pp
 692 .It Ic show Cm inpcb Ar addr
 693 Show information on IP Control Block
 694 .Vt struct in_pcb
 695 present at
 696 .Ar addr .
 697 .\"
 698 .Pp
 699 .It Ic show Cm intr
 700 Dump information about interrupt handlers.
 701 .\"
 702 .Pp
 703 .It Ic show Cm intrcnt
 704 Dump the interrupt statistics.
 705 .\"
 706 .Pp
 707 .It Ic show Cm irqs
 708 Show interrupt lines and their respective kernel threads.
 709 .\"
 710 .Pp
 711 .It Ic show Cm jails
 712 Show the list of
 713 .Xr jail 8
 714 instances.
 715 In addition to what
 716 .Xr jls 8
 717 shows, also list kernel internal details.
 718 .\"
 719 .Pp
 720 .It Ic show Cm lapic
 721 Show information from the local APIC registers for this CPU.
 722 .\"
 723 .Pp
 724 .It Ic show Cm lock Ar addr
 725 Show lock structure.
 726 The output format is as follows:
 727 .Bl -tag -width "flags"
 728 .It Ic class:
 729 Class of the lock.
 730 Possible types include
 731 .Xr mutex 9 ,
 732 .Xr rmlock 9 ,
 733 .Xr rwlock 9 ,
 734 .Xr sx 9 .
 735 .It Ic name:
 736 Name of the lock.
 737 .It Ic flags:
 738 Flags passed to the lock initialization function.
 739 For exact possibilities see manual pages of possible lock types.
 740 .It Ic state:
 741 Current state of a lock.
 742 As well as
 743 .Ic flags
 744 it's lock-specific.
 745 .It Ic owner:
 746 Lock owner.
 747 .El
 748 .\"
 749 .Pp
 750 .It Ic show Cm lockchain Ar addr
 751 Show all threads a particular thread at address
 752 .Ar addr
 753 is waiting on based on non-sleepable and non-spin locks.
 754 .\"
 755 .Pp
 756 .It Ic show Cm lockedbufs
 757 Show the same information as "show buf", but for every locked
 758 .Vt struct buf
 759 object.
 760 .\"
 761 .Pp
 762 .It Ic show Cm lockedvnods
 763 List all locked vnodes in the system.
 764 .\"
 765 .Pp
 766 .It Ic show Cm locks
 767 Prints all locks that are currently acquired.
 768 This command is only available if
 769 .Xr witness 4
 770 is included in the kernel.
 771 .\"
 772 .Pp
 773 .It Ic show Cm locktree
 774 .\"
 775 .Pp
 776 .It Ic show Cm malloc
 777 Prints
 778 .Xr malloc 9
 779 memory allocator statistics.
 780 The output format is as follows:
 781 .Pp
 782 .Bl -tag -compact -offset indent -width "Requests"
 783 .It Ic Type
 784 Specifies a type of memory.
 785 It is the same as a description string used while defining the
 786 given memory type with
 787 .Xr MALLOC_DECLARE 9 .
 788 .It Ic InUse
 789 Number of memory allocations of the given type, for which
 790 .Xr free 9
 791 has not been called yet.
 792 .It Ic MemUse
 793 Total memory consumed by the given allocation type.
 794 .It Ic Requests
 795 Number of memory allocation requests for the given
 796 memory type.
 797 .El
 798 .Pp
 799 The same information can be gathered in userspace with
 800 .Dq Nm vmstat Fl m .
 801 .\"
 802 .Pp
 803 .It Ic show Cm map Ns Oo Li / Ns Cm f Oc Ar addr
 804 Prints the VM map at
 805 .Ar addr .
 806 If the
 807 .Cm f
 808 modifier is specified the
 809 complete map is printed.
 810 .\"
 811 .Pp
 812 .It Ic show Cm msgbuf
 813 Print the system's message buffer.
 814 It is the same output as in the
 815 .Dq Nm dmesg
 816 case.
 817 It is useful if you got a kernel panic, attached a serial cable
 818 to the machine and want to get the boot messages from before the
 819 system hang.
 820 .\"
 821 .It Ic show Cm mount
 822 Displays short info about all currently mounted file systems.
 823 .Pp
 824 .It Ic show Cm mount Ar addr
 825 Displays details about the given mount point.
 826 .\"
 827 .Pp
 828 .It Ic show Cm object Ns Oo Li / Ns Cm f Oc Ar addr
 829 Prints the VM object at
 830 .Ar addr .
 831 If the
 832 .Cm f
 833 option is specified the
 834 complete object is printed.
 835 .\"
 836 .Pp
 837 .It Ic show Cm page
 838 Show statistics on VM pages.
 839 .\"
 840 .Pp
 841 .It Ic show Cm pageq
 842 Show statistics on VM page queues.
 843 .\"
 844 .Pp
 845 .It Ic show Cm pciregs
 846 Print PCI bus registers.
 847 The same information can be gathered in userspace by running
 848 .Dq Nm pciconf Fl lv .
 849 .\"
 850 .Pp
 851 .It Ic show Cm pcpu
 852 Print current processor state.
 853 The output format is as follows:
 854 .Pp
 855 .Bl -tag -compact -offset indent -width "spin locks held:"
 856 .It Ic cpuid
 857 Processor identifier.
 858 .It Ic curthread
 859 Thread pointer, process identifier and the name of the process.
 860 .It Ic curpcb
 861 Control block pointer.
 862 .It Ic fpcurthread
 863 FPU thread pointer.
 864 .It Ic idlethread
 865 Idle thread pointer.
 866 .It Ic APIC ID
 867 CPU identifier coming from APIC.
 868 .It Ic currentldt
 869 LDT pointer.
 870 .It Ic spin locks held
 871 Names of spin locks held.
 872 .El
 873 .\"
 874 .Pp
 875 .It Ic show Cm pgrpdump
 876 Dump process groups present within the system.
 877 .\"
 878 .Pp
 879 .It Ic show Cm proc Op Ar addr
 880 If no
 881 .Op Ar addr
 882 is specified, print information about the current process.
 883 Otherwise, show information about the process at address
 884 .Ar addr .
 885 .\"
 886 .Pp
 887 .It Ic show Cm procvm
 888 Show process virtual memory layout.
 889 .\"
 890 .Pp
 891 .It Ic show Cm protosw Ar addr
 892 Print protocol switch structure
 893 .Vt struct protosw
 894 at address
 895 .Ar addr .
 896 .\"
 897 .Pp
 898 .It Ic show Cm registers Ns Op Li / Ns Cm u
 899 Display the register set.
 900 If the
 901 .Cm u
 902 modifier is specified, it displays user registers instead of
 903 kernel registers or the currently saved one.
 904 .Pp
 905 .Sy Warning :
 906 The support of the
 907 .Cm u
 908 modifier depends on the machine.
 909 If not supported, incorrect information will be displayed.
 910 .\"
 911 .Pp
 912 .It Ic show Cm rman Ar addr
 913 Show resource manager object
 914 .Vt struct rman
 915 at address
 916 .Ar addr .
 917 Addresses of particular pointers can be gathered with "show allrman"
 918 command.
 919 .\"
 920 .Pp
 921 .It Ic show Cm rtc
 922 Show real time clock value.
 923 Useful for long debugging sessions.
 924 .\"
 925 .Pp
 926 .It Ic show Cm sleepchain
 927 Show all the threads a particular thread is waiting on based on
 928 sleepable locks.
 929 .\"
 930 .Pp
 931 .It Ic show Cm sleepq
 932 .It Ic show Cm sleepqueue
 933 Both commands provide the same functionality.
 934 They show sleepqueue
 935 .Vt struct sleepqueue
 936 structure.
 937 Sleepqueues are used within the
 938 .Fx
 939 kernel to implement sleepable
 940 synchronization primitives (thread holding a lock might sleep or
 941 be context switched), which at the time of writing are:
 942 .Xr condvar 9 ,
 943 .Xr sx 9
 944 and standard
 945 .Xr msleep 9
 946 interface.
 947 .\"
 948 .Pp
 949 .It Ic show Cm sockbuf Ar addr
 950 .It Ic show Cm socket Ar addr
 951 Those commands print
 952 .Vt struct sockbuf
 953 and
 954 .Vt struct socket
 955 objects placed at
 956 .Ar addr .
 957 Output consists of all values present in structures mentioned.
 958 For exact interpretation and more details, visit
 959 .Pa sys/socket.h
 960 header file.
 961 .\"
 962 .Pp
 963 .It Ic show Cm sysregs
 964 Show system registers (e.g.,
 965 .Li cr0-4
 966 on i386.)
 967 Not present on some platforms.
 968 .\"
 969 .Pp
 970 .It Ic show Cm tcpcb Ar addr
 971 Print TCP control block
 972 .Vt struct tcpcb
 973 lying at address
 974 .Ar addr .
 975 For exact interpretation of output, visit
 976 .Pa netinet/tcp.h
 977 header file.
 978 .\"
 979 .Pp
 980 .It Ic show Cm thread Op Ar addr
 981 If no
 982 .Ar addr
 983 is specified, show detailed information about current thread.
 984 Otherwise, information about thread at
 985 .Ar addr
 986 is printed.
 987 .\"
 988 .Pp
 989 .It Ic show Cm threads
 990 Show all threads within the system.
 991 Output format is as follows:
 992 .Pp
 993 .Bl -tag -compact -offset indent -width "Second column"
 994 .It Ic First column
 995 Thread identifier (TID)
 996 .It Ic Second column
 997 Thread structure address
 998 .It Ic Third column
 999 Backtrace.
1000 .El
1001 .\"
1002 .Pp
1003 .It Ic show Cm tty Ar addr
1004 Display the contents of a TTY structure in a readable form.
1005 .\"
1006 .Pp
1007 .It Ic show Cm turnstile Ar addr
1008 Show turnstile
1009 .Vt struct turnstile
1010 structure at address
1011 .Ar addr .
1012 Turnstiles are structures used within the
1013 .Fx
1014 kernel to implement
1015 synchronization primitives which, while holding a specific type of lock, cannot
1016 sleep or context switch to another thread.
1017 Currently, those are:
1018 .Xr mutex 9 ,
1019 .Xr rwlock 9 ,
1020 .Xr rmlock 9 .
1021 .\"
1022 .Pp
1023 .It Ic show Cm uma
1024 Show UMA allocator statistics.
1025 Output consists five columns:
1026 .Pp
1027 .Bl -tag -compact -offset indent -width "Requests"
1028 .It Cm "Zone"
1029 Name of the UMA zone.
1030 The same string that was passed to
1031 .Xr uma_zcreate 9
1032 as a first argument.
1033 .It Cm "Size"
1034 Size of a given memory object (slab).
1035 .It Cm "Used"
1036 Number of slabs being currently used.
1037 .It Cm "Free"
1038 Number of free slabs within the UMA zone.
1039 .It Cm "Requests"
1040 Number of allocations requests to the given zone.
1041 .El
1042 .Pp
1043 The very same information might be gathered in the userspace
1044 with the help of
1045 .Dq Nm vmstat Fl z .
1046 .\"
1047 .Pp
1048 .It Ic show Cm unpcb Ar addr
1049 Shows UNIX domain socket private control block
1050 .Vt struct unpcb
1051 present at the address
1052 .Ar addr .
1053 .\"
1054 .Pp
1055 .It Ic show Cm vmochk
1056 Prints, whether the internal VM objects are in a map somewhere
1057 and none have zero ref counts.
1058 .\"
1059 .Pp
1060 .It Ic show Cm vmopag
1061 This is supposed to show physical addresses consumed by a
1062 VM object.
1063 Currently, it is not possible to use this command when
1064 .Xr witness 4
1065 is compiled in the kernel.
1066 .\"
1067 .Pp
1068 .It Ic show Cm vnode Op Ar addr
1069 Prints vnode
1070 .Vt struct vnode
1071 structure lying at
1072 .Op Ar addr .
1073 For the exact interpretation of the output, look at the
1074 .Pa sys/vnode.h
1075 header file.
1076 .\"
1077 .Pp
1078 .It Ic show Cm vnodebufs Ar addr
1079 Shows clean/dirty buffer lists of the vnode located at
1080 .Ar addr .
1081 .\"
1082 .Pp
1083 .It Ic show Cm watches
1084 Displays all watchpoints.
1085 Shows watchpoints set with "watch" command.
1086 .\"
1087 .Pp
1088 .It Ic show Cm witness
1089 Shows information about lock acquisition coming from the
1090 .Xr witness 4
1091 subsystem.
1092 .\"
1093 .Pp
1094 .It Ic gdb
1095 Toggles between remote GDB and DDB mode.
1096 In remote GDB mode, another machine is required that runs
1097 .Xr gdb 1
1098 using the remote debug feature, with a connection to the serial
1099 console port on the target machine.
1100 Currently only available on the
1101 i386
1102 architecture.
1103 .Pp
1104 .It Ic halt
1105 Halt the system.
1106 .Pp
1107 .It Ic kill Ar sig pid
1108 Send signal
1109 .Ar sig
1110 to process
1111 .Ar pid .
1112 The signal is acted on upon returning from the debugger.
1113 This command can be used to kill a process causing resource contention
1114 in the case of a hung system.
1115 See
1116 .Xr signal 3
1117 for a list of signals.
1118 Note that the arguments are reversed relative to
1119 .Xr kill 2 .
1120 .Pp
1121 .It Ic reboot Op Ar seconds
1122 .It Ic reset Op Ar seconds
1123 Hard reset the system.
1124 If the optional argument
1125 .Ar seconds
1126 is given, the debugger will wait for this long, at most a week,
1127 before rebooting.
1128 .Pp
1129 .It Ic help
1130 Print a short summary of the available commands and command
1131 abbreviations.
1132 .Pp
1133 .It Ic capture on
1134 .It Ic capture off
1135 .It Ic capture reset
1136 .It Ic capture status
1137 .Nm
1138 supports a basic output capture facility, which can be used to retrieve the
1139 results of debugging commands from userpsace using
1140 .Xr sysctl 2 .
1141 .Ic capture on
1142 enables output capture;
1143 .Ic capture off
1144 disables capture.
1145 .Ic capture reset
1146 will clear the capture buffer and disable capture.
1147 .Ic capture status
1148 will report current buffer use, buffer size, and disposition of output
1149 capture.
1150 .Pp
1151 Userspace processes may inspect and manage
1152 .Nm
1153 capture state using
1154 .Xr sysctl 8 :
1155 .Pp
1156 .Dv debug.ddb.capture.bufsize
1157 may be used to query or set the current capture buffer size.
1158 .Pp
1159 .Dv debug.ddb.capture.maxbufsize
1160 may be used to query the compile-time limit on the capture buffer size.
1161 .Pp
1162 .Dv debug.ddb.capture.bytes
1163 may be used to query the number of bytes of output currently in the capture
1164 buffer.
1165 .Pp
1166 .Dv debug.ddb.capture.data
1167 returns the contents of the buffer as a string to an appropriately privileged
1168 process.
1169 .Pp
1170 This facility is particularly useful in concert with the scripting and
1171 .Xr textdump 4
1172 facilities, allowing scripted debugging output to be captured and
1173 committed to disk as part of a textdump for later analysis.
1174 The contents of the capture buffer may also be inspected in a kernel core dump
1175 using
1176 .Xr kgdb 1 .
1177 .Pp
1178 .It Ic run
1179 .It Ic script
1180 .It Ic scripts
1181 .It Ic unscript
1182 Run, define, list, and delete scripts.
1183 See the
1184 .Sx SCRIPTING
1185 section for more information on the scripting facility.
1186 .Pp
1187 .It Ic textdump dump
1188 .It Ic textdump set
1189 .It Ic textdump status
1190 .It Ic textdump unset
1191 Use the
1192 .Ic textdump dump
1193 command to immediately perform a textdump.
1194 More information may be found in
1195 .Xr textdump 4 .
1196 The
1197 .Ic textdump set
1198 command may be used to force the next kernel core dump to be a textdump
1199 rather than a traditional memory dump or minidump.
1200 .Ic textdump status
1201 reports whether a textdump has been scheduled.
1202 .Ic textdump unset
1203 cancels a request to perform a textdump as the next kernel core dump.
1204 .El
1205 .Sh VARIABLES
1206 The debugger accesses registers and variables as
1207 .Li $ Ns Ar name .
1208 Register names are as in the
1209 .Dq Ic show Cm registers
1210 command.
1211 Some variables are suffixed with numbers, and may have some modifier
1212 following a colon immediately after the variable name.
1213 For example, register variables can have a
1214 .Cm u
1215 modifier to indicate user register (e.g.,
1216 .Dq Li $eax:u ) .
1217 .Pp
1218 Built-in variables currently supported are:
1219 .Pp
1220 .Bl -tag -width ".Va tabstops" -compact
1221 .It Va radix
1222 Input and output radix.
1223 .It Va maxoff
1224 Addresses are printed as
1225 .Dq Ar symbol Ns Li + Ns Ar offset
1226 unless
1227 .Ar offset
1228 is greater than
1229 .Va maxoff .
1230 .It Va maxwidth
1231 The width of the displayed line.
1232 .It Va lines
1233 The number of lines.
1234 It is used by the built-in pager.
1235 .It Va tabstops
1236 Tab stop width.
1237 .It Va work Ns Ar xx
1238 Work variable;
1239 .Ar xx
1240 can take values from 0 to 31.
1241 .El
1242 .Sh EXPRESSIONS
1243 Most expression operators in C are supported except
1244 .Ql ~ ,
1245 .Ql ^ ,
1246 and unary
1247 .Ql & .
1248 Special rules in
1249 .Nm
1250 are:
1251 .Bl -tag -width ".No Identifiers"
1252 .It Identifiers
1253 The name of a symbol is translated to the value of the symbol, which
1254 is the address of the corresponding object.
1255 .Ql \&.
1256 and
1257 .Ql \&:
1258 can be used in the identifier.
1259 If supported by an object format dependent routine,
1260 .Sm off
1261 .Oo Ar filename : Oc Ar func : lineno ,
1262 .Sm on
1263 .Oo Ar filename : Oc Ns Ar variable ,
1264 and
1265 .Oo Ar filename : Oc Ns Ar lineno
1266 can be accepted as a symbol.
1267 .It Numbers
1268 Radix is determined by the first two letters:
1269 .Ql 0x :
1270 hex,
1271 .Ql 0o :
1272 octal,
1273 .Ql 0t :
1274 decimal; otherwise, follow current radix.
1275 .It Li \&.
1276 .Va dot
1277 .It Li +
1278 .Va next
1279 .It Li ..
1280 address of the start of the last line examined.
1281 Unlike
1282 .Va dot
1283 or
1284 .Va next ,
1285 this is only changed by
1286 .Ic examine
1287 or
1288 .Ic write
1289 command.
1290 .It Li '
1291 last address explicitly specified.
1292 .It Li $ Ns Ar variable
1293 Translated to the value of the specified variable.
1294 It may be followed by a
1295 .Ql \&:
1296 and modifiers as described above.
1297 .It Ar a Ns Li # Ns Ar b
1298 A binary operator which rounds up the left hand side to the next
1299 multiple of right hand side.
1300 .It Li * Ns Ar expr
1301 Indirection.
1302 It may be followed by a
1303 .Ql \&:
1304 and modifiers as described above.
1305 .El
1306 .Sh SCRIPTING
1307 .Nm
1308 supports a basic scripting facility to allow automating tasks or responses to
1309 specific events.
1310 Each script consists of a list of DDB commands to be executed sequentially,
1311 and is assigned a unique name.
1312 Certain script names have special meaning, and will be automatically run on
1313 various
1314 .Nm
1315 events if scripts by those names have been defined.
1316 .Pp
1317 The
1318 .Ic script
1319 command may be used to define a script by name.
1320 Scripts consist of a series of
1321 .Nm
1322 commands separated with the
1323 .Ql \&;
1324 character.
1325 For example:
1326 .Bd -literal -offset indent
1327 script kdb.enter.panic=bt; show pcpu
1328 script lockinfo=show alllocks; show lockedvnods
1329 .Ed
1330 .Pp
1331 The
1332 .Ic scripts
1333 command lists currently defined scripts.
1334 .Pp
1335 The
1336 .Ic run
1337 command execute a script by name.
1338 For example:
1339 .Bd -literal -offset indent
1340 run lockinfo
1341 .Ed
1342 .Pp
1343 The
1344 .Ic unscript
1345 command may be used to delete a script by name.
1346 For example:
1347 .Bd -literal -offset indent
1348 unscript kdb.enter.panic
1349 .Ed
1350 .Pp
1351 These functions may also be performed from userspace using the
1352 .Xr ddb 8
1353 command.
1354 .Pp
1355 Certain scripts are run automatically, if defined, for specific
1356 .Nm
1357 events.
1358 The follow scripts are run when various events occur:
1359 .Bl -tag -width kdb.enter.powerfail
1360 .It Dv kdb.enter.acpi
1361 The kernel debugger was entered as a result of an
1362 .Xr acpi 4
1363 event.
1364 .It Dv kdb.enter.bootflags
1365 The kernel debugger was entered at boot as a result of the debugger boot
1366 flag being set.
1367 .It Dv kdb.enter.break
1368 The kernel debugger was entered as a result of a serial or console break.
1369 .It Dv kdb.enter.cam
1370 The kernel debugger was entered as a result of a
1371 .Xr CAM 4
1372 event.
1373 .It Dv kdb.enter.mac
1374 The kernel debugger was entered as a result of an assertion failure in the
1375 .Xr mac_test 4
1376 module of the
1377 TrustedBSD MAC Framework.
1378 .It Dv kdb.enter.ndis
1379 The kernel debugger was entered as a result of an
1380 .Xr ndis 4
1381 breakpoint event.
1382 .It Dv kdb.enter.netgraph
1383 The kernel debugger was entered as a result of a
1384 .Xr netgraph 4
1385 event.
1386 .It Dv kdb.enter.panic
1387 .Xr panic 9
1388 was called.
1389 .It Dv kdb.enter.powerfail
1390 The kernel debugger was entered as a result of a powerfail NMI on the sparc64
1391 platform.
1392 .It Dv kdb.enter.powerpc
1393 The kernel debugger was entered as a result of an unimplemented interrupt
1394 type on the powerpc platform.
1395 .It Dv kdb.enter.sysctl
1396 The kernel debugger was entered as a result of the
1397 .Dv debug.kdb.enter
1398 sysctl being set.
1399 .It Dv kdb.enter.trapsig
1400 The kernel debugger was entered as a result of a trapsig event on the sparc64
1401 platform.
1402 .It Dv kdb.enter.unionfs
1403 The kernel debugger was entered as a result of an assertion failure in the
1404 union file system.
1405 .It Dv kdb.enter.unknown
1406 The kernel debugger was entered, but no reason has been set.
1407 .It Dv kdb.enter.vfslock
1408 The kernel debugger was entered as a result of a VFS lock violation.
1409 .It Dv kdb.enter.watchdog
1410 The kernel debugger was entered as a result of a watchdog firing.
1411 .It Dv kdb.enter.witness
1412 The kernel debugger was entered as a result of a
1413 .Xr witness 4
1414 violation.
1415 .El
1416 .Pp
1417 In the event that none of these scripts is found,
1418 .Nm
1419 will attempt to execute a default script:
1420 .Bl -tag -width kdb.enter.powerfail
1421 .It Dv kdb.enter.default
1422 The kernel debugger was entered, but a script exactly matching the reason for
1423 entering was not defined.
1424 This can be used as a catch-all to handle cases not specifically of interest;
1425 for example,
1426 .Dv kdb.enter.witness
1427 might be defined to have special handling, and
1428 .Dv kdb.enter.default
1429 might be defined to simply panic and reboot.
1430 .El
1431 .Sh HINTS
1432 On machines with an ISA expansion bus, a simple NMI generation card can be
1433 constructed by connecting a push button between the A01 and B01 (CHCHK# and
1434 GND) card fingers.
1435 Momentarily shorting these two fingers together may cause the bridge chipset to
1436 generate an NMI, which causes the kernel to pass control to
1437 .Nm .
1438 Some bridge chipsets do not generate a NMI on CHCHK#, so your mileage may vary.
1439 The NMI allows one to break into the debugger on a wedged machine to
1440 diagnose problems.
1441 Other bus' bridge chipsets may be able to generate NMI using bus specific
1442 methods.
1443 .Sh FILES
1444 Header files mention in this manual page can be found below
1445 .Pa /usr/include
1446 directory.
1447 .Pp
1448 .Bl -dash -compact
1449 .It
1450 .Pa sys/buf.h
1451 .It
1452 .Pa sys/domain.h
1453 .It
1454 .Pa netinet/in_pcb.h
1455 .It
1456 .Pa sys/socket.h
1457 .It
1458 .Pa sys/vnode.h
1459 .El
1460 .Sh SEE ALSO
1461 .Xr gdb 1 ,
1462 .Xr kgdb 1 ,
1463 .Xr acpi 4 ,
1464 .Xr CAM 4 ,
1465 .Xr mac_test 4 ,
1466 .Xr ndis 4 ,
1467 .Xr netgraph 4 ,
1468 .Xr textdump 4 ,
1469 .Xr witness 4 ,
1470 .Xr ddb 8 ,
1471 .Xr sysctl 8 ,
1472 .Xr panic 9
1473 .Sh HISTORY
1474 The
1475 .Nm
1476 debugger was developed for Mach, and ported to
1477 .Bx 386 0.1 .
1478 This manual page translated from
1479 .Xr man 7
1480 macros by
1481 .An Garrett Wollman .
1482 .Pp
1483 .An Robert N. M. Watson
1484 added support for
1485 .Nm
1486 output capture,
1487 .Xr textdump 4
1488 and scripting in
1489 .Fx 7.1 .