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