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 November 29, 2008
  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 Ic show Cm all procs Ns Op Li / Ns Cm m
 527 .It Ic ps Ns Op Li / Ns Cm m
 528 Display all process information.
 529 The process information may not be shown if it is not
 530 supported in the machine, or the bottom of the stack of the
 531 target process is not in the main memory at that time.
 532 The
 533 .Cm m
 534 modifier will alter the display to show VM map
 535 addresses for the process and not show other information.
 536 .\"
 537 .Pp
 538 .It Ic show Cm all ttys
 539 Show all TTY's within the system.
 540 Output is similar to
 541 .Xr pstat 8 ,
 542 but also includes the address of the TTY structure.
 543 .\"
 544 .Pp
 545 .It Ic show Cm allchains
 546 Show the same information like "show lockchain" does, but
 547 for every thread in the system.
 548 .\"
 549 .Pp
 550 .It Ic show Cm alllocks
 551 Show all locks that are currently held.
 552 This command is only available if
 553 .Xr witness 4
 554 is included in the kernel.
 555 .\"
 556 .Pp
 557 .It Ic show Cm allpcpu
 558 The same as "show pcpu", but for every CPU present in the system.
 559 .\"
 560 .Pp
 561 .It Ic show Cm allrman
 562 Show information related with resource management, including
 563 interrupt request lines, DMA request lines, I/O ports and I/O memory
 564 addresses.
 565 .\"
 566 .Pp
 567 .It Ic show Cm apic
 568 Dump data about APIC IDT vector mappings.
 569 .\"
 570 .Pp
 571 .It Ic show Cm breaks
 572 Show breakpoints set with the "break" command.
 573 .\"
 574 .Pp
 575 .It Ic show Cm buffer
 576 Show buffer structure of
 577 .Vt struct buf
 578 type.
 579 Such a structure is used within the
 580 .Fx
 581 kernel for the I/O subsystem
 582 implementation.
 583 For an exact interpretation of the output, please see the
 584 .Pa sys/buf.h
 585 header file.
 586 .\"
 587 .Pp
 588 .It Ic show Cm cbstat
 589 Show brief information about the TTY subsystem.
 590 .\"
 591 .Pp
 592 .It Ic show Cm conifhk
 593 Lists hooks currently waiting for completion in
 594 run_interrupt_driven_config_hooks().
 595 .\"
 596 .Pp
 597 .It Ic show Cm cpusets
 598 Print numbered root and assigned CPU affinity sets.
 599 See
 600 .Xr cpuset 2
 601 for more details.
 602 .\"
 603 .Pp
 604 .It Ic show Cm cyrixreg
 605 Show registers specific to the Cyrix processor.
 606 .\"
 607 .Pp
 608 .It Ic show Cm domain Ar addr
 609 Print protocol domain structure
 610 .Vt struct domain
 611 at address
 612 .Ar addr .
 613 See the
 614 .Pa sys/domain.h
 615 header file for more details on the exact meaning of the structure fields.
 616 .\"
 617 .Pp
 618 .It Ic show Cm ffs Op Ar addr
 619 Show brief information about ffs mount at the address
 620 .Ar addr ,
 621 if argument is given.
 622 Otherwise, provides the summary about each ffs mount.
 623 .\"
 624 .Pp
 625 .It Ic show Cm file Ar addr
 626 Show information about the file structure
 627 .Vt struct file
 628 present at address
 629 .Ar addr .
 630 .\"
 631 .Pp
 632 .It Ic show Cm files
 633 Show information about every file structure in the system.
 634 .\"
 635 .Pp
 636 .It Ic show Cm freepages
 637 Show the number of physical pages in each of the free lists.
 638 .\"
 639 .Pp
 640 .It Ic show Cm geom Op Ar addr
 641 If the
 642 .Ar addr
 643 argument is not given, displays the entire GEOM topology.
 644 If
 645 .Ar addr
 646 is given, displays details about the given GEOM object (class, geom,
 647 provider or consumer).
 648 .\"
 649 .Pp
 650 .It Ic show Cm idt
 651 Show IDT layout.
 652 The first column specifies the IDT vector.
 653 The second one is the name of the interrupt/trap handler.
 654 Those functions are machine dependent.
 655 .\"
 656 .Pp
 657 .It Ic show Cm inodedeps Op Ar addr
 658 Show brief information about each inodedep structure.
 659 If
 660 .Ar addr
 661 is given, only inodedeps belonging to the fs located at the
 662 supplied address are shown.
 663 .\"
 664 .Pp
 665 .It Ic show Cm inpcb Ar addr
 666 Show information on IP Control Block
 667 .Vt struct in_pcb
 668 present at
 669 .Ar addr .
 670 .\"
 671 .Pp
 672 .It Ic show Cm intr
 673 Dump information about interrupt handlers.
 674 .\"
 675 .Pp
 676 .It Ic show Cm intrcnt
 677 Dump the interrupt statistics.
 678 .\"
 679 .Pp
 680 .It Ic show Cm irqs
 681 Show interrupt lines and their respective kernel threads.
 682 .\"
 683 .Pp
 684 .It Ic show Cm jails
 685 Show the list of
 686 .Xr jail 8
 687 instances.
 688 In addition to what
 689 .Xr jls 8
 690 shows, also list kernel internal details.
 691 .\"
 692 .Pp
 693 .It Ic show Cm lapic
 694 Show information from the local APIC registers for this CPU.
 695 .\"
 696 .Pp
 697 .It Ic show Cm lock Ar addr
 698 Show lock structure.
 699 The output format is as follows:
 700 .Bl -tag -offset 0 -width "flags"
 701 .It Ic class:
 702 Class of the lock.
 703 Possible types include
 704 .Xr mutex 9 ,
 705 .Xr rmlock 9 ,
 706 .Xr rwlock 9 ,
 707 .Xr sx 9 .
 708 .It Ic name:
 709 Name of the lock.
 710 .It Ic flags:
 711 Flags passed to the lock initialization function.
 712 For exact possibilities see manual pages of possible lock types.
 713 .It Ic state:
 714 Current state of a lock.
 715 As well as
 716 .Ic flags
 717 it's lock-specific.
 718 .It Ic owner:
 719 Lock owner.
 720 .El
 721 .\"
 722 .Pp
 723 .It Ic show Cm lockchain Ar addr
 724 Show all threads a particular thread at address
 725 .Ar addr
 726 is waiting on based on non-sleepable and non-spin locks.
 727 .\"
 728 .Pp
 729 .It Ic show Cm lockedbufs
 730 Show the same information as "show buf", but for every locked
 731 .Vt struct buf
 732 object.
 733 .\"
 734 .Pp
 735 .It Ic show Cm lockedvnods
 736 List all locked vnodes in the system.
 737 .\"
 738 .Pp
 739 .It Ic show Cm locks
 740 Prints all locks that are currently acquired.
 741 This command is only available if
 742 .Xr witness 4
 743 is included in the kernel.
 744 .\"
 745 .Pp
 746 .It Ic show Cm locktree
 747 .\"
 748 .Pp
 749 .It Ic show Cm malloc
 750 Prints
 751 .Xr malloc 9
 752 memory allocator statistics.
 753 The output format is as follows:
 754 .Pp
 755 .Bl -tag -compact -offset indent -width "Requests"
 756 .It Ic Type
 757 Specifies a type of memory.
 758 It is the same as a description string used while defining the
 759 given memory type with
 760 .Xr MALLOC_DECLARE 9 .
 761 .It Ic InUse
 762 Number of memory allocations of the given type, for which
 763 .Xr free 9
 764 has not been called yet.
 765 .It Ic MemUse
 766 Total memory consumed by the given allocation type.
 767 .It Ic Requests
 768 Number of memory allocation requests for the given
 769 memory type.
 770 .El
 771 .Pp
 772 The same information can be gathered in userspace with
 773 .Dq Nm vmstat Fl m .
 774 .\"
 775 .Pp
 776 .It Ic show Cm map Ns Oo Li / Ns Cm f Oc Ar addr
 777 Prints the VM map at
 778 .Ar addr .
 779 If the
 780 .Cm f
 781 modifier is specified the
 782 complete map is printed.
 783 .\"
 784 .Pp
 785 .It Ic show Cm msgbuf
 786 Print the system's message buffer.
 787 It is the same output as in the
 788 .Dq Nm dmesg
 789 case.
 790 It is useful if you got a kernel panic, attached a serial cable
 791 to the machine and want to get the boot messages from before the
 792 system hang.
 793 .\"
 794 .It Ic show Cm mount
 795 Displays short info about all currently mounted file systems.
 796 .Pp
 797 .It Ic show Cm mount Ar addr
 798 Displays details about the given mount point.
 799 .Pp
 800 .\"
 801 .Pp
 802 .It Ic show Cm object Ns Oo Li / Ns Cm f Oc Ar addr
 803 Prints the VM object at
 804 .Ar addr .
 805 If the
 806 .Cm f
 807 option is specified the
 808 complete object is printed.
 809 .\"
 810 .Pp
 811 .It Ic show Cm page
 812 Show statistics on VM pages.
 813 .\"
 814 .Pp
 815 .It Ic show Cm pageq
 816 Show statistics on VM page queues.
 817 .\"
 818 .Pp
 819 .It Ic show Cm pciregs
 820 Print PCI bus registers.
 821 The same information can be gathered in userspace by running
 822 .Dq Nm pciconf Fl lv .
 823 .\"
 824 .Pp
 825 .It Ic show Cm pcpu
 826 Print current processor state.
 827 The output format is as follows:
 828 .Pp
 829 .Bl -tag -compact -offset indent -width "spin locks held:"
 830 .It Ic cpuid
 831 Processor identifier.
 832 .It Ic curthread
 833 Thread pointer, process identifier and the name of the process.
 834 .It Ic curpcb
 835 Control block pointer.
 836 .It Ic fpcurthread
 837 FPU thread pointer.
 838 .It Ic idlethread
 839 Idle thread pointer.
 840 .It Ic APIC ID
 841 CPU identifier coming from APIC.
 842 .It Ic currentldt
 843 LDT pointer.
 844 .It Ic spin locks held
 845 Names of spin locks held.
 846 .El
 847 .\"
 848 .Pp
 849 .It Ic show Cm pgrpdump
 850 Dump process groups present within the system.
 851 .\"
 852 .Pp
 853 .It Ic show Cm proc Op Ar addr
 854 If no
 855 .Op Ar addr
 856 is specified, print information about the current process.
 857 Otherwise, show information about the process at address
 858 .Ar addr .
 859 .\"
 860 .Pp
 861 .It Ic show Cm procvm
 862 Show process virtual memory layout.
 863 .\"
 864 .Pp
 865 .It Ic show Cm protosw Ar addr
 866 Print protocol switch structure
 867 .Vt struct protosw
 868 at address
 869 .Ar addr .
 870 .\"
 871 .Pp
 872 .It Ic show Cm registers Ns Op Li / Ns Cm u
 873 Display the register set.
 874 If the
 875 .Cm u
 876 modifier is specified, it displays user registers instead of
 877 kernel registers or the currently saved one.
 878 .Pp
 879 .Sy Warning :
 880 The support of the
 881 .Cm u
 882 modifier depends on the machine.
 883 If not supported, incorrect information will be displayed.
 884 .\"
 885 .Pp
 886 .It Ic show Cm rman Ar addr
 887 Show resource manager object
 888 .Vt struct rman
 889 at address
 890 .Ar addr .
 891 Addresses of particular pointers can be gathered with "show allrman"
 892 command.
 893 .\"
 894 .Pp
 895 .It Ic show Cm rtc
 896 Show real time clock value.
 897 Useful for long debugging sessions.
 898 .\"
 899 .Pp
 900 .It Ic show Cm sleepchain
 901 Show all the threads a particular thread is waiting on based on
 902 sleepable locks.
 903 .\"
 904 .Pp
 905 .It Ic show Cm sleepq
 906 .It Ic show Cm sleepqueue
 907 Both commands provide the same functionality.
 908 They show sleepqueue
 909 .Vt struct sleepqueue
 910 structure.
 911 Sleepqueues are used within the
 912 .Fx
 913 kernel to implement sleepable
 914 synchronization primitives (thread holding a lock might sleep or
 915 be context switched), which at the time of writing are:
 916 .Xr condvar 9 ,
 917 .Xr sx 9
 918 and standard
 919 .Xr msleep 9
 920 interface.
 921 .\"
 922 .Pp
 923 .It Ic show Cm sockbuf Ar addr
 924 .It Ic show Cm socket Ar addr
 925 Those commands print
 926 .Vt struct sockbuf
 927 and
 928 .Vt struct socket
 929 objects placed at
 930 .Ar addr .
 931 Output consists of all values present in structures mentioned.
 932 For exact interpretation and more details, visit
 933 .Pa sys/socket.h
 934 header file.
 935 .\"
 936 .Pp
 937 .It Ic show Cm sysregs
 938 Show system registers (e.g.,
 939 .Li cr0-4
 940 on i386.)
 941 Not present on some platforms.
 942 .\"
 943 .Pp
 944 .It Ic show Cm tcpcb Ar addr
 945 Print TCP control block
 946 .Vt struct tcpcb
 947 lying at address
 948 .Ar addr .
 949 For exact interpretation of output, visit
 950 .Pa netinet/tcp.h
 951 header file.
 952 .\"
 953 .Pp
 954 .It Ic show Cm thread Op Ar addr
 955 If no
 956 .Ar addr
 957 is specified, show detailed information about current thread.
 958 Otherwise, information about thread at
 959 .Ar addr
 960 is printed.
 961 .\"
 962 .Pp
 963 .It Ic show Cm threads
 964 Show all threads within the system.
 965 Output format is as follows:
 966 .Pp
 967 .Bl -tag -width "PPID" -compact -offset indent -width "Second column"
 968 .It Ic First column
 969 Thread identifier (TID)
 970 .It Ic Second column
 971 Thread structure address
 972 .It Ic Third column
 973 Backtrace.
 974 .El
 975 .\"
 976 .Pp
 977 .It Ic show Cm tty Ar addr
 978 Display the contents of a TTY structure in a readable form.
 979 .\"
 980 .Pp
 981 .It Ic show Cm turnstile Ar addr
 982 Show turnstile
 983 .Vt struct turnstile
 984 structure at address
 985 .Ar addr .
 986 Turnstiles are structures used within the
 987 .Fx
 988 kernel to implement
 989 synchronization primitives which, while holding a specific type of lock, cannot
 990 sleep or context switch to another thread.
 991 Currently, those are:
 992 .Xr mutex 9 ,
 993 .Xr rwlock 9 ,
 994 .Xr rmlock 9 .
 995 .\"
 996 .Pp
 997 .It Ic show Cm uma
 998 Show UMA allocator statistics.
 999 Output consists five columns:
1000 .Pp
1001 .Bl -tag -compact -offset indent -width "Requests"
1002 .It Cm "Zone"
1003 Name of the UMA zone.
1004 The same string that was passed to
1005 .Xr uma_zcreate 9
1006 as a first argument.
1007 .It Cm "Size"
1008 Size of a given memory object (slab).
1009 .It Cm "Used"
1010 Number of slabs being currently used.
1011 .It Cm "Free"
1012 Number of free slabs within the UMA zone.
1013 .It Cm "Requests"
1014 Number of allocations requests to the given zone.
1015 .El
1016 .Pp
1017 The very same information might be gathered in the userspace
1018 with the help of
1019 .Dq Nm vmstat Fl z
1020 .\"
1021 .Pp
1022 .It Ic show Cm unpcb Ar addr
1023 Shows UNIX domain socket private control block
1024 .Vt struct unpcb
1025 present at the address
1026 .Ar addr
1027 .\"
1028 .Pp
1029 .It Ic show Cm vmochk
1030 Prints, whether the internal VM objects are in a map somewhere
1031 and none have zero ref counts.
1032 .\"
1033 .Pp
1034 .It Ic show Cm vmopag
1035 This is supposed to show physical addresses consumed by a
1036 VM object.
1037 Currently, it is not possible to use this command when
1038 .Xr witness 4
1039 is compiled in the kernel.
1040 .\"
1041 .Pp
1042 .It Ic show Cm vnode Op Ar addr
1043 Prints vnode
1044 .Vt struct vnode
1045 structure lying at
1046 .Op Ar addr .
1047 For the exact interpretation of the output, look at the
1048 .Pa sys/vnode.h
1049 header file.
1050 .\"
1051 .Pp
1052 .It Ic show Cm vnodebufs Ar addr
1053 Shows clean/dirty buffer lists of the vnode located at
1054 .Ar addr .
1055 .\"
1056 .Pp
1057 .It Ic show Cm watches
1058 Displays all watchpoints.
1059 Shows watchpoints set with "watch" command.
1060 .\"
1061 .Pp
1062 .It Ic show Cm witness
1063 Shows information about lock acquisition coming from the
1064 .Xr witness 4
1065 subsystem.
1066 .\"
1067 .Pp
1068 .It Ic gdb
1069 Toggles between remote GDB and DDB mode.
1070 In remote GDB mode, another machine is required that runs
1071 .Xr gdb 1
1072 using the remote debug feature, with a connection to the serial
1073 console port on the target machine.
1074 Currently only available on the
1075 i386
1076 architecture.
1077 .Pp
1078 .It Ic halt
1079 Halt the system.
1080 .Pp
1081 .It Ic kill Ar sig pid
1082 Send signal
1083 .Ar sig
1084 to process
1085 .Ar pid .
1086 The signal is acted on upon returning from the debugger.
1087 This command can be used to kill a process causing resource contention
1088 in the case of a hung system.
1089 See
1090 .Xr signal 3
1091 for a list of signals.
1092 Note that the arguments are reversed relative to
1093 .Xr kill 2 .
1094 .Pp
1095 .It Ic reboot
1096 .It Ic reset
1097 Hard reset the system.
1098 .Pp
1099 .It Ic help
1100 Print a short summary of the available commands and command
1101 abbreviations.
1102 .Pp
1103 .It Ic capture on
1104 .It Ic capture off
1105 .It Ic capture reset
1106 .It Ic capture status
1107 .Nm
1108 supports a basic output capture facility, which can be used to retrieve the
1109 results of debugging commands from userpsace using
1110 .Xr sysctl 2 .
1111 .Ic capture on
1112 enables output capture;
1113 .Ic capture off
1114 disables capture.
1115 .Ic capture reset
1116 will clear the capture buffer and disable capture.
1117 .Ic capture status
1118 will report current buffer use, buffer size, and disposition of output
1119 capture.
1120 .Pp
1121 Userspace processes may inspect and manage
1122 .Nm
1123 capture state using
1124 .Xr sysctl 8 :
1125 .Pp
1126 .Dv debug.ddb.capture.bufsize
1127 may be used to query or set the current capture buffer size.
1128 .Pp
1129 .Dv debug.ddb.capture.maxbufsize
1130 may be used to query the compile-time limit on the capture buffer size.
1131 .Pp
1132 .Dv debug.ddb.capture.bytes
1133 may be used to query the number of bytes of output currently in the capture
1134 buffer.
1135 .Pp
1136 .Dv debug.ddb.capture.data
1137 returns the contents of the buffer as a string to an appropriately privileged
1138 process.
1139 .Pp
1140 This facility is particularly useful in concert with the scripting and
1141 .Xr textdump 4
1142 facilities, allowing scripted debugging output to be captured and
1143 committed to disk as part of a textdump for later analysis.
1144 The contents of the capture buffer may also be inspected in a kernel core dump
1145 using
1146 .Xr kgdb 1 .
1147 .Pp
1148 .It Ic run
1149 .It Ic script
1150 .It Ic scripts
1151 .It Ic unscript
1152 Run, define, list, and delete scripts.
1153 See the
1154 .Sx SCRIPTING
1155 section for more information on the scripting facility.
1156 .Pp
1157 .It Ic textdump set
1158 .It Ic textdump status
1159 .It Ic textdump unset
1160 The
1161 .Ic textdump set
1162 command may be used to force the next kernel core dump to be a textdump
1163 rather than a traditional memory dump or minidump.
1164 .Ic textdump status
1165 reports whether a textdump has been scheduled.
1166 .Ic textdump unset
1167 cancels a request to perform a textdump as the next kernel core dump.
1168 More information may be found in
1169 .Xr textdump 4 .
1170 .El
1171 .Sh VARIABLES
1172 The debugger accesses registers and variables as
1173 .Li $ Ns Ar name .
1174 Register names are as in the
1175 .Dq Ic show Cm registers
1176 command.
1177 Some variables are suffixed with numbers, and may have some modifier
1178 following a colon immediately after the variable name.
1179 For example, register variables can have a
1180 .Cm u
1181 modifier to indicate user register (e.g.,
1182 .Dq Li $eax:u ) .
1183 .Pp
1184 Built-in variables currently supported are:
1185 .Pp
1186 .Bl -tag -width ".Va tabstops" -compact
1187 .It Va radix
1188 Input and output radix.
1189 .It Va maxoff
1190 Addresses are printed as
1191 .Dq Ar symbol Ns Li + Ns Ar offset
1192 unless
1193 .Ar offset
1194 is greater than
1195 .Va maxoff .
1196 .It Va maxwidth
1197 The width of the displayed line.
1198 .It Va lines
1199 The number of lines.
1200 It is used by the built-in pager.
1201 .It Va tabstops
1202 Tab stop width.
1203 .It Va work Ns Ar xx
1204 Work variable;
1205 .Ar xx
1206 can take values from 0 to 31.
1207 .El
1208 .Sh EXPRESSIONS
1209 Most expression operators in C are supported except
1210 .Ql ~ ,
1211 .Ql ^ ,
1212 and unary
1213 .Ql & .
1214 Special rules in
1215 .Nm
1216 are:
1217 .Bl -tag -width ".No Identifiers"
1218 .It Identifiers
1219 The name of a symbol is translated to the value of the symbol, which
1220 is the address of the corresponding object.
1221 .Ql \&.
1222 and
1223 .Ql \&:
1224 can be used in the identifier.
1225 If supported by an object format dependent routine,
1226 .Sm off
1227 .Oo Ar filename : Oc Ar func : lineno ,
1228 .Sm on
1229 .Oo Ar filename : Oc Ns Ar variable ,
1230 and
1231 .Oo Ar filename : Oc Ns Ar lineno
1232 can be accepted as a symbol.
1233 .It Numbers
1234 Radix is determined by the first two letters:
1235 .Ql 0x :
1236 hex,
1237 .Ql 0o :
1238 octal,
1239 .Ql 0t :
1240 decimal; otherwise, follow current radix.
1241 .It Li \&.
1242 .Va dot
1243 .It Li +
1244 .Va next
1245 .It Li ..
1246 address of the start of the last line examined.
1247 Unlike
1248 .Va dot
1249 or
1250 .Va next ,
1251 this is only changed by
1252 .Ic examine
1253 or
1254 .Ic write
1255 command.
1256 .It Li '
1257 last address explicitly specified.
1258 .It Li $ Ns Ar variable
1259 Translated to the value of the specified variable.
1260 It may be followed by a
1261 .Ql \&:
1262 and modifiers as described above.
1263 .It Ar a Ns Li # Ns Ar b
1264 A binary operator which rounds up the left hand side to the next
1265 multiple of right hand side.
1266 .It Li * Ns Ar expr
1267 Indirection.
1268 It may be followed by a
1269 .Ql \&:
1270 and modifiers as described above.
1271 .El
1272 .Sh SCRIPTING
1273 .Nm
1274 supports a basic scripting facility to allow automating tasks or responses to
1275 specific events.
1276 Each script consists of a list of DDB commands to be executed sequentially,
1277 and is assigned a unique name.
1278 Certain script names have special meaning, and will be automatically run on
1279 various
1280 .Nm
1281 events if scripts by those names have been defined.
1282 .Pp
1283 The
1284 .Ic script
1285 command may be used to define a script by name.
1286 Scripts consist of a series of
1287 .Nm
1288 commands separated with the
1289 .Ic ;
1290 character.
1291 For example:
1292 .Bd -literal -offset indent
1293 script kdb.enter.panic=bt; show pcpu
1294 script lockinfo=show alllocks; show lockedvnods
1295 .Ed
1296 .Pp
1297 The
1298 .Ic scripts
1299 command lists currently defined scripts.
1300 .Pp
1301 The
1302 .Ic run
1303 command execute a script by name.
1304 For example:
1305 .Bd -literal -offset indent
1306 run lockinfo
1307 .Ed
1308 .Pp
1309 The
1310 .Ic unscript
1311 command may be used to delete a script by name.
1312 For example:
1313 .Bd -literal -offset indent
1314 unscript kdb.enter.panic
1315 .Ed
1316 .Pp
1317 These functions may also be performed from userspace using the
1318 .Xr ddb 8
1319 command.
1320 .Pp
1321 Certain scripts are run automatically, if defined, for specific
1322 .Nm
1323 events.
1324 The follow scripts are run when various events occur:
1325 .Bl -tag -width kdb.enter.powerfail
1326 .It Dv kdb.enter.acpi
1327 The kernel debugger was entered as a result of an
1328 .Xr acpi 4
1329 event.
1330 .It Dv kdb.enter.bootflags
1331 The kernel debugger was entered at boot as a result of the debugger boot
1332 flag being set.
1333 .It Dv kdb.enter.break
1334 The kernel debugger was entered as a result of a serial or console break.
1335 .It Dv kdb.enter.cam
1336 The kernel debugger was entered as a result of a
1337 .Xr CAM 4
1338 event.
1339 .It Dv kdb.enter.mac
1340 The kernel debugger was entered as a result of an assertion failure in the
1341 .Xr mac_test 4
1342 module of the
1343 TrustedBSD MAC Framework.
1344 .It Dv kdb.enter.ndis
1345 The kernel debugger was entered as a result of an
1346 .Xr ndis 4
1347 breakpoint event.
1348 .It Dv kdb.enter.netgraph
1349 The kernel debugger was entered as a result of a
1350 .Xr netgraph 4
1351 event.
1352 .It Dv kdb.enter.panic
1353 .Xr panic 9
1354 was called.
1355 .It Dv kdb.enter.powerfail
1356 The kernel debugger was entered as a result of a powerfail NMI on the sparc64
1357 platform.
1358 .It Dv kdb.enter.powerpc
1359 The kernel debugger was entered as a result of an unimplemented interrupt
1360 type on the powerpc platform.
1361 .It Dv kdb.enter.sysctl
1362 The kernel debugger was entered as a result of the
1363 .Dv debug.kdb.enter
1364 sysctl being set.
1365 .It Dv kdb.enter.trapsig
1366 The kernel debugger was entered as a result of a trapsig event on the sparc64
1367 or sun4v platform.
1368 .It Dv kdb.enter.unionfs
1369 The kernel debugger was entered as a result of an assertion failure in the
1370 union file system.
1371 .It Dv kdb.enter.unknown
1372 The kernel debugger was entered, but no reason has been set.
1373 .It Dv kdb.enter.vfslock
1374 The kernel debugger was entered as a result of a VFS lock violation.
1375 .It Dv kdb.enter.watchdog
1376 The kernel debugger was entered as a result of a watchdog firing.
1377 .It Dv kdb.enter.witness
1378 The kernel debugger was entered as a result of a
1379 .Xr witness 4
1380 violation.
1381 .El
1382 .Pp
1383 In the event that none of these scripts is found,
1384 .Nm
1385 will attempt to execute a default script:
1386 .Bl -tag -width kdb.enter.powerfail
1387 .It Dv kdb.enter.default
1388 The kernel debugger was entered, but a script exactly matching the reason for
1389 entering was not defined.
1390 This can be used as a catch-all to handle cases not specifically of interest;
1391 for example,
1392 .Dv kdb.enter.witness
1393 might be defined to have special handling, and
1394 .Dv kdb.enter.default
1395 might be defined to simply panic and reboot.
1396 .El
1397 .Sh HINTS
1398 On machines with an ISA expansion bus, a simple NMI generation card can be
1399 constructed by connecting a push button between the A01 and B01 (CHCHK# and
1400 GND) card fingers.
1401 Momentarily shorting these two fingers together may cause the bridge chipset to
1402 generate an NMI, which causes the kernel to pass control to
1403 .Nm .
1404 Some bridge chipsets do not generate a NMI on CHCHK#, so your mileage may vary.
1405 The NMI allows one to break into the debugger on a wedged machine to
1406 diagnose problems.
1407 Other bus' bridge chipsets may be able to generate NMI using bus specific
1408 methods.
1409 .Sh FILES
1410 Header files mention in this manual page can be found below
1411 .Pa /usr/include
1412 directory.
1413 .Pp
1414 .Bl -dash -compact
1415 .It
1416 .Pa sys/buf.h
1417 .It
1418 .Pa sys/domain.h
1419 .It
1420 .Pa netinet/in_pcb.h
1421 .It
1422 .Pa sys/socket.h
1423 .It
1424 .Pa sys/vnode.h
1425 .El
1426 .Sh SEE ALSO
1427 .Xr gdb 1 ,
1428 .Xr kgdb 1 ,
1429 .Xr acpi 4 ,
1430 .Xr CAM 4 ,
1431 .Xr mac_test 4 ,
1432 .Xr ndis 4 ,
1433 .Xr netgraph 4 ,
1434 .Xr textdump 4 ,
1435 .Xr witness 4 ,
1436 .Xr ddb 8 ,
1437 .Xr sysctl 8 ,
1438 .Xr panic 9
1439 .Sh HISTORY
1440 The
1441 .Nm
1442 debugger was developed for Mach, and ported to
1443 .Bx 386 0.1 .
1444 This manual page translated from
1445 .Xr man 7
1446 macros by
1447 .An Garrett Wollman .
1448 .Pp
1449 .An Robert N. M. Watson
1450 added support for
1451 .Nm
1452 output capture,
1453 .Xr textdump 4
1454 and scripting in
1455 .Fx 7.1 .