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