freebsd-nq/share/man/man4/ddb.4

934 lines
22 KiB
Groff
Raw Normal View History

.\"
.\" Mach Operating System
.\" Copyright (c) 1991,1990 Carnegie Mellon University
.\" Copyright (c) 2007 Robert N. M. Watson
.\" All Rights Reserved.
.\"
.\" Permission to use, copy, modify and distribute this software and its
.\" documentation is hereby granted, provided that both the copyright
.\" notice and this permission notice appear in all copies of the
.\" software, derivative works or modified versions, and any portions
.\" thereof, and that both notices appear in supporting documentation.
.\"
.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
.\"
.\" Carnegie Mellon requests users of this software to return to
.\"
.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
.\" School of Computer Science
.\" Carnegie Mellon University
.\" Pittsburgh PA 15213-3890
.\"
.\" any improvements or extensions that they make and grant Carnegie Mellon
.\" the rights to redistribute these changes.
.\"
.\" changed a \# to #, since groff choked on it.
.\"
.\" HISTORY
.\" ddb.4,v
.\" Revision 1.1 1993/07/15 18:41:02 brezak
.\" Man page for DDB
.\"
.\" Revision 2.6 92/04/08 08:52:57 rpd
.\" Changes from OSF.
.\" [92/01/17 14:19:22 jsb]
.\" Changes for OSF debugger modifications.
.\" [91/12/12 tak]
.\"
.\" Revision 2.5 91/06/25 13:50:22 rpd
.\" Added some watchpoint explanation.
.\" [91/06/25 rpd]
.\"
.\" Revision 2.4 91/06/17 15:47:31 jsb
.\" Added documentation for continue/c, match, search, and watchpoints.
.\" I've not actually explained what a watchpoint is; maybe Rich can
.\" do that (hint, hint).
.\" [91/06/17 10:58:08 jsb]
.\"
.\" Revision 2.3 91/05/14 17:04:23 mrt
.\" Correcting copyright
.\"
.\" Revision 2.2 91/02/14 14:10:06 mrt
.\" Changed to new Mach copyright
.\" [91/02/12 18:10:12 mrt]
.\"
.\" Revision 2.2 90/08/30 14:23:15 dbg
.\" Created.
.\" [90/08/30 dbg]
.\"
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
2006-10-09 15:21:50 +00:00
.\"
.Dd December 26, 2007
1996-01-17 21:07:02 +00:00
.Dt DDB 4
.Os
1996-01-17 21:07:02 +00:00
.Sh NAME
.Nm ddb
.Nd interactive kernel debugger
.Sh SYNOPSIS
.Cd options KDB
1996-01-17 21:07:02 +00:00
.Cd options DDB
.Pp
To prevent activation of the debugger on kernel
.Xr panic 9 :
.Cd options KDB_UNATTENDED
1996-01-17 21:07:02 +00:00
.Sh DESCRIPTION
The
.Nm
2006-10-09 15:21:50 +00:00
kernel debugger has most of the features of the old
.Nm kdb ,
1996-01-17 21:07:02 +00:00
but with a more rational syntax
inspired by
.Xr gdb 1 .
If linked into the running kernel,
it can be invoked locally with the
.Ql debug
.Xr keymap 5
action.
The debugger is also invoked on kernel
.Xr panic 9
if the
.Va debug.debugger_on_panic
.Xr sysctl 8
MIB variable is set non-zero,
which is the default
unless the
.Dv KDB_UNATTENDED
option is specified.
1996-01-17 21:07:02 +00:00
.Pp
2006-10-09 15:21:50 +00:00
The current location is called
.Va dot .
The
.Va dot
is displayed with
a hexadecimal format at a prompt.
2006-10-09 15:21:50 +00:00
The commands
.Ic examine
and
.Ic write
update
.Va dot
to the address of the last line
examined or the last location modified, and set
.Va next
to the address of
the next location to be examined or changed.
2006-10-09 15:21:50 +00:00
Other commands do not change
.Va dot ,
and set
.Va next
to be the same as
.Va dot .
1996-01-17 21:07:02 +00:00
.Pp
The general command syntax is:
2006-10-09 15:21:50 +00:00
.Ar command Ns Op Li / Ns Ar modifier
1996-01-17 21:07:02 +00:00
.Ar address Ns Op Li , Ns Ar count
.Pp
2006-10-09 15:21:50 +00:00
A blank line repeats the previous command from the address
.Va next
with
count 1 and no modifiers.
Specifying
1996-01-17 21:07:02 +00:00
.Ar address
2006-10-09 15:21:50 +00:00
sets
.Va dot
to the address.
Omitting
1996-01-17 21:07:02 +00:00
.Ar address
2006-10-09 15:21:50 +00:00
uses
.Va dot .
A missing
1996-01-17 21:07:02 +00:00
.Ar count
is taken
to be 1 for printing commands or infinity for stack traces.
.Pp
The
.Nm
2006-10-09 15:21:50 +00:00
debugger has a pager feature (like the
1996-01-17 21:07:02 +00:00
.Xr more 1
2006-10-09 15:21:50 +00:00
command)
for the output.
If an output line exceeds the number set in the
2006-10-09 15:21:50 +00:00
.Va lines
1996-01-17 21:07:02 +00:00
variable, it displays
2006-10-11 07:07:31 +00:00
.Dq Li --More--
and waits for a response.
The valid responses for it are:
1996-01-17 21:07:02 +00:00
.Pp
.Bl -tag -compact -width ".Li SPC"
1996-01-17 21:07:02 +00:00
.It Li SPC
one more page
1996-01-17 21:07:02 +00:00
.It Li RET
one more line
1996-01-17 21:07:02 +00:00
.It Li q
abort the current command, and return to the command input mode
.El
.Pp
Finally,
.Nm
provides a small (currently 10 items) command history, and offers
2006-10-09 15:21:50 +00:00
simple
.Nm emacs Ns -style
command line editing capabilities.
In addition to
2006-10-09 15:21:50 +00:00
the
.Nm emacs
control keys, the usual
.Tn ANSI
arrow keys might be used to
browse through the history buffer, and move the cursor within the
current line.
1996-01-17 21:07:02 +00:00
.Sh COMMANDS
.Bl -tag -width indent -compact
2006-10-09 15:21:50 +00:00
.It Ic examine
.It Ic x
Display the addressed locations according to the formats in the modifier.
Multiple modifier formats display multiple locations.
2006-10-09 15:21:50 +00:00
If no format is specified, the last format specified for this command
is used.
1996-01-17 21:07:02 +00:00
.Pp
The format characters are:
.Bl -tag -compact -width indent
2006-10-09 15:21:50 +00:00
.It Cm b
1996-01-17 21:07:02 +00:00
look at by bytes (8 bits)
2006-10-09 15:21:50 +00:00
.It Cm h
1996-01-17 21:07:02 +00:00
look at by half words (16 bits)
2006-10-09 15:21:50 +00:00
.It Cm l
1996-01-17 21:07:02 +00:00
look at by long words (32 bits)
2006-10-09 15:21:50 +00:00
.It Cm a
print the location being displayed
2006-10-09 15:21:50 +00:00
.It Cm A
print the location with a line number if possible
2006-10-09 15:21:50 +00:00
.It Cm x
display in unsigned hex
2006-10-09 15:21:50 +00:00
.It Cm z
display in signed hex
2006-10-09 15:21:50 +00:00
.It Cm o
display in unsigned octal
2006-10-09 15:21:50 +00:00
.It Cm d
display in signed decimal
2006-10-09 15:21:50 +00:00
.It Cm u
display in unsigned decimal
2006-10-09 15:21:50 +00:00
.It Cm r
display in current radix, signed
2006-10-09 15:21:50 +00:00
.It Cm c
display low 8 bits as a character.
2006-10-09 15:21:50 +00:00
Non-printing characters are displayed as an octal escape code (e.g.,
.Ql \e000 ) .
.It Cm s
display the null-terminated string at the location.
Non-printing characters are displayed as octal escapes.
2006-10-09 15:21:50 +00:00
.It Cm m
display in unsigned hex with character dump at the end of each line.
The location is also displayed in hex at the beginning of each line.
2006-10-09 15:21:50 +00:00
.It Cm i
display as an instruction
2006-10-09 15:21:50 +00:00
.It Cm I
display as an instruction with possible alternate formats depending on the
machine:
.Bl -tag -width ".Tn powerpc" -compact
.It Tn alpha
Show the registers of the instruction.
.It Tn amd64
No alternate format.
1996-01-17 21:07:02 +00:00
.It Tn i386
No alternate format.
.It Tn ia64
No alternate format.
.It Tn powerpc
No alternate format.
.It Tn sparc64
No alternate format.
1996-01-17 21:07:02 +00:00
.El
.El
.Pp
2006-10-09 15:21:50 +00:00
.It Ic xf
1996-01-17 21:07:02 +00:00
Examine forward:
2006-10-09 15:21:50 +00:00
execute an
.Ic examine
command with the last specified parameters to it
except that the next address displayed by it is used as the start address.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic xb
1996-01-17 21:07:02 +00:00
Examine backward:
2006-10-09 15:21:50 +00:00
execute an
.Ic examine
command with the last specified parameters to it
except that the last start address subtracted by the size displayed by it
is used as the start address.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic print Ns Op Li / Ns Cm acdoruxz
.It Ic p Ns Op Li / Ns Cm acdoruxz
Print
.Ar addr Ns s
1996-01-17 21:07:02 +00:00
according to the modifier character (as described above for
2006-10-09 15:21:50 +00:00
.Cm examine ) .
1996-01-17 21:07:02 +00:00
Valid formats are:
2006-10-09 15:21:50 +00:00
.Cm a , x , z , o , d , u , r ,
1996-01-17 21:07:02 +00:00
and
2006-10-09 15:21:50 +00:00
.Cm c .
1996-01-17 21:07:02 +00:00
If no modifier is specified, the last one specified to it is used.
2006-10-09 15:21:50 +00:00
The argument
1996-01-17 21:07:02 +00:00
.Ar addr
can be a string, in which case it is printed as it is.
For example:
1996-01-17 21:07:02 +00:00
.Bd -literal -offset indent
2006-10-09 15:21:50 +00:00
print/x "eax = " $eax "\enecx = " $ecx "\en"
1996-01-17 21:07:02 +00:00
.Ed
.Pp
will print like:
.Bd -literal -offset indent
eax = xxxxxx
ecx = yyyyyy
1996-01-17 21:07:02 +00:00
.Ed
.Pp
1996-01-17 21:07:02 +00:00
.It Xo
2006-10-09 15:21:50 +00:00
.Ic write Ns Op Li / Ns Cm bhl
.Ar addr expr1 Op Ar expr2 ...
1996-01-17 21:07:02 +00:00
.Xc
.It Xo
2006-10-09 15:21:50 +00:00
.Ic w Ns Op Li / Ns Cm bhl
.Ar addr expr1 Op Ar expr2 ...
.Xc
1996-01-17 21:07:02 +00:00
Write the expressions specified after
.Ar addr
on the command line at succeeding locations starting with
2006-10-09 15:21:50 +00:00
.Ar addr .
The write unit size can be specified in the modifier with a letter
2006-10-09 15:21:50 +00:00
.Cm b
(byte),
2006-10-09 15:21:50 +00:00
.Cm h
1996-01-17 21:07:02 +00:00
(half word) or
2006-10-09 15:21:50 +00:00
.Cm l
(long word) respectively.
If omitted,
long word is assumed.
1996-01-17 21:07:02 +00:00
.Pp
.Sy Warning :
since there is no delimiter between expressions, strange
things may happen.
2005-02-13 23:45:54 +00:00
It is best to enclose each expression in parentheses.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic set Li $ Ns Ar variable Oo Li = Oc Ar expr
Set the named variable or register with the value of
1996-01-17 21:07:02 +00:00
.Ar expr .
Valid variable names are described below.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic break Ns Op Li / Ns Cm u
.It Ic b Ns Op Li / Ns Cm u
1996-01-17 21:07:02 +00:00
Set a break point at
.Ar addr .
If
.Ar count
is supplied, continues
.Ar count
2006-10-09 15:21:50 +00:00
\- 1 times before stopping at the
break point.
If the break point is set, a break point number is
1996-01-17 21:07:02 +00:00
printed with
2006-10-09 15:21:50 +00:00
.Ql # .
1996-01-17 21:07:02 +00:00
This number can be used in deleting the break point
or adding conditions to it.
1996-01-17 21:07:02 +00:00
.Pp
If the
2006-10-09 15:21:50 +00:00
.Cm u
1996-01-17 21:07:02 +00:00
modifier is specified, this command sets a break point in user space
address.
Without the
2006-10-09 15:21:50 +00:00
.Cm u
1996-01-17 21:07:02 +00:00
option, the address is considered in the kernel
space, and wrong space address is rejected with an error message.
This modifier can be used only if it is supported by machine dependent
routines.
1996-01-17 21:07:02 +00:00
.Pp
.Sy Warning :
If a user text is shadowed by a normal user space debugger,
user space break points may not work correctly.
Setting a break
point at the low-level code paths may also cause strange behavior.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic delete Ar addr
.It Ic d Ar addr
.It Ic delete Li # Ns Ar number
.It Ic d Li # Ns Ar number
Delete the break point.
The target break point can be specified by a
break point number with
2006-10-09 15:21:50 +00:00
.Ql # ,
1996-01-17 21:07:02 +00:00
or by using the same
.Ar addr
specified in the original
2006-10-09 15:21:50 +00:00
.Ic break
command.
.Pp
.It Ic watch Ar addr Ns Li , Ns Ar size
Set a watchpoint for a region.
Execution stops when an attempt to modify the region occurs.
The
.Ar size
argument defaults to 4.
If you specify a wrong space address, the request is rejected
with an error message.
.Pp
.Sy Warning :
Attempts to watch wired kernel memory
may cause unrecoverable error in some systems such as i386.
Watchpoints on user addresses work best.
.Pp
.It Ic hwatch Ar addr Ns Li , Ns Ar size
Set a hardware watchpoint for a region if supported by the
architecture.
Execution stops when an attempt to modify the region occurs.
The
.Ar size
argument defaults to 4.
.Pp
.Sy Warning :
The hardware debug facilities do not have a concept of separate
address spaces like the watch command does.
Use
.Ic hwatch
for setting watchpoints on kernel address locations only, and avoid
its use on user mode address spaces.
.Pp
.It Ic dhwatch Ar addr Ns Li , Ns Ar size
Delete specified hardware watchpoint.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic step Ns Op Li / Ns Cm p
.It Ic s Ns Op Li / Ns Cm p
Single step
1996-01-17 21:07:02 +00:00
.Ar count
times (the comma is a mandatory part of the syntax).
If the
2006-10-09 15:21:50 +00:00
.Cm p
1996-01-17 21:07:02 +00:00
modifier is specified, print each instruction at each step.
Otherwise, only print the last instruction.
1996-01-17 21:07:02 +00:00
.Pp
.Sy Warning :
depending on machine type, it may not be possible to
single-step through some low-level code paths or user space code.
On machines with software-emulated single-stepping (e.g., pmax),
stepping through code executed by interrupt handlers will probably
do the wrong thing.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic continue Ns Op Li / Ns Cm c
.It Ic c Ns Op Li / Ns Cm c
Continue execution until a breakpoint or watchpoint.
1996-01-17 21:07:02 +00:00
If the
2006-10-09 15:21:50 +00:00
.Cm c
1996-01-17 21:07:02 +00:00
modifier is specified, count instructions while executing.
Some machines (e.g., pmax) also count loads and stores.
1996-01-17 21:07:02 +00:00
.Pp
.Sy Warning :
when counting, the debugger is really silently single-stepping.
This means that single-stepping on low-level code may cause strange
behavior.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic until Ns Op Li / Ns Cm p
Stop at the next call or return instruction.
1996-01-17 21:07:02 +00:00
If the
2006-10-09 15:21:50 +00:00
.Cm p
1996-01-17 21:07:02 +00:00
modifier is specified, print the call nesting depth and the
cumulative instruction count at each call or return.
Otherwise,
only print when the matching return is hit.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic next Ns Op Li / Ns Cm p
.It Ic match Ns Op Li / Ns Cm p
Stop at the matching return instruction.
1996-01-17 21:07:02 +00:00
If the
2006-10-09 15:21:50 +00:00
.Cm p
1996-01-17 21:07:02 +00:00
modifier is specified, print the call nesting depth and the
cumulative instruction count at each call or return.
Otherwise, only print when the matching return is hit.
.Pp
1996-01-17 21:07:02 +00:00
.It Xo
2006-10-09 15:21:50 +00:00
.Ic trace Ns Op Li / Ns Cm u
.Op Ar pid | tid
2006-10-09 15:21:50 +00:00
.Op Li , Ns Ar count
1996-01-17 21:07:02 +00:00
.Xc
.It Xo
2006-10-09 15:21:50 +00:00
.Ic t Ns Op Li / Ns Cm u
.Op Ar pid | tid
2006-10-09 15:21:50 +00:00
.Op Li , Ns Ar count
.Xc
.It Xo
2006-10-09 15:21:50 +00:00
.Ic where Ns Op Li / Ns Cm u
.Op Ar pid | tid
2006-10-09 15:21:50 +00:00
.Op Li , Ns Ar count
.Xc
.It Xo
2006-10-09 15:21:50 +00:00
.Ic bt Ns Op Li / Ns Cm u
.Op Ar pid | tid
2006-10-09 15:21:50 +00:00
.Op Li , Ns Ar count
.Xc
Stack trace.
The
2006-10-09 15:21:50 +00:00
.Cm u
option traces user space; if omitted,
2006-10-09 15:21:50 +00:00
.Ic trace
1996-01-17 21:07:02 +00:00
only traces
kernel space.
2006-10-09 15:21:50 +00:00
The optional argument
1996-01-17 21:07:02 +00:00
.Ar count
is the number of frames to be traced.
If
1996-01-17 21:07:02 +00:00
.Ar count
is omitted, all frames are printed.
.Pp
.Sy Warning :
User space stack trace is valid
only if the machine dependent code supports it.
.Pp
1996-01-17 21:07:02 +00:00
.It Xo
2006-10-09 15:21:50 +00:00
.Ic search Ns Op Li / Ns Cm bhl
1996-01-17 21:07:02 +00:00
.Ar addr
.Ar value
.Op Ar mask
2006-10-09 15:21:50 +00:00
.Op Li , Ns Ar count
1996-01-17 21:07:02 +00:00
.Xc
Search memory for
.Ar value .
This command might fail in interesting
2005-02-13 22:25:33 +00:00
ways if it does not find the searched-for value.
2006-10-09 15:21:50 +00:00
This is because
.Nm
does not always recover from touching bad memory.
The optional
1996-01-17 21:07:02 +00:00
.Ar count
argument limits the search.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm all procs Ns Op Li / Ns Cm m
.It Ic ps Ns Op Li / Ns Cm m
Display all process information.
The process information may not be shown if it is not
supported in the machine, or the bottom of the stack of the
target process is not in the main memory at that time.
The
2006-10-09 15:21:50 +00:00
.Cm m
1996-01-17 21:07:02 +00:00
modifier will alter the display to show VM map
addresses for the process and not show other info.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm registers Ns Op Li / Ns Cm u
Display the register set.
1996-01-17 21:07:02 +00:00
If the
2006-10-09 15:21:50 +00:00
.Cm u
modifier is specified, it displays user registers instead of
kernel or currently saved one.
1996-01-17 21:07:02 +00:00
.Pp
.Sy Warning :
The support of the
2006-10-09 15:21:50 +00:00
.Cm u
modifier depends on the machine.
If not supported, incorrect information will be displayed.
.Pp
.It Ic show Cm sysregs
Show system registers (e.g.,
.Li cr0-4
on i386.)
Not present on some platforms.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm geom Op Ar addr
If the
.Ar addr
argument is not given, displays the entire GEOM topology.
If the
.Ar addr
2006-09-18 15:24:20 +00:00
is given, displays details about the given GEOM object (class, geom, provider
or consumer).
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm map Ns Oo Li / Ns Cm f Oc Ar addr
Prints the VM map at
1996-01-17 21:07:02 +00:00
.Ar addr .
If the
2006-10-09 15:21:50 +00:00
.Cm f
1996-01-17 21:07:02 +00:00
modifier is specified the
complete map is printed.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm object Ns Oo Li / Ns Cm f Oc Ar addr
1996-01-17 21:07:02 +00:00
Prints the VM object at
.Ar addr .
If the
2006-10-09 15:21:50 +00:00
.Cm f
1996-01-17 21:07:02 +00:00
option is specified the
complete object is printed.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm vnode Ar addr
2006-09-05 12:17:53 +00:00
Displays details about the given vnode.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic show Cm watches
Displays all watchpoints.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic gdb
Toggles between remote GDB and DDB mode.
In remote GDB mode, another machine is required that runs
.Xr gdb 1
using the remote debug feature, with a connection to the serial
console port on the target machine.
Currently only available on the
2006-10-09 15:21:50 +00:00
i386
architecture.
.Pp
.It Ic halt
Halt the system.
.Pp
.It Ic kill Ar sig pid
Send signal
.Ar sig
to process
.Ar pid .
The signal is acted on upon returning from the debugger.
This command can be used to kill a process causing resource contention
in the case of a hung system.
See
.Xr signal 3
for a list of signals.
Note that the arguments are reversed relative to
.Xr kill 2 .
.Pp
.It Ic reboot
.It Ic reset
Hard reset the system.
.Pp
2006-10-09 15:21:50 +00:00
.It Ic help
Print a short summary of the available commands and command
abbreviations.
.Pp
.It Ic capture on
.It Ic capture off
.It Ic capture reset
.It Ic capture status
.Nm
supports a basic output capture facility, which can be used to retrieve the
results of debugging commands from userpsace using
.Xr sysctl 2 .
.Ic capture on
enables output capture;
.Ic capture off
disables capture.
.Ic capture reset
will clear the capture buffer and disable capture.
.Ic capture status
will report current buffer use, buffer size, and disposition of output
capture.
.Pp
Userspace processes may inspect and manage
.Nm
capture state using
.Xr sysctl 8 :
.Pp
.Dv debug.ddb.capture.bufsize
may be used to query or set the current capture buffer size.
.Pp
.Dv debug.ddb.capture.maxbufsize
may be used to query the compile-time limit on the capture buffer size.
.Pp
.Dv debug.ddb.capture.bytes
may be used to query the number of bytes of output currently in the capture
buffer.
.Pp
.Dv debug.ddb.capture.data
returns the contents of the buffer as a string to an appropriately privileged
process.
.Pp
This facility is particularly useful in concert with the scripting and
.Xr textdump 4
facilities, allowing scripted debugging output to be captured and
committed to disk as part of a textdump for later analysis.
The contents of the capture buffer may also be inspected in a kernel core dump
using
.Xr kgdb 1 .
.Pp
.It Ic run
.It Ic script
.It Ic scripts
.It Ic unscript
Run, define, list, and delete scripts.
See the
.Sx SCRIPTING
section for more information on the scripting facility.
.Pp
.It Ic textdump set
.It Ic textdump status
.It Ic textdump unset
The
.Ic textdump set
command may be used to force the next kernel core dump to be a textdump
rather than a traditional memory dump or minidump.
.Ic textdump status
reports whether a textdump has been scheduled.
.Ic textdump unset
cancels a request to perform a textdump as the next kernel core dump.
More information may be found in
.Xr textdump 4 .
1996-01-17 21:07:02 +00:00
.El
.Sh VARIABLES
The debugger accesses registers and variables as
2006-10-09 15:21:50 +00:00
.Li $ Ns Ar name .
1996-01-17 21:07:02 +00:00
Register names are as in the
2006-10-09 15:21:50 +00:00
.Dq Ic show Cm registers
command.
Some variables are suffixed with numbers, and may have some modifier
following a colon immediately after the variable name.
1996-01-17 21:07:02 +00:00
For example, register variables can have a
2006-10-09 15:21:50 +00:00
.Cm u
1996-01-17 21:07:02 +00:00
modifier to indicate user register (e.g.,
2006-10-09 15:21:50 +00:00
.Dq Li $eax:u ) .
1996-01-17 21:07:02 +00:00
.Pp
Built-in variables currently supported are:
2006-10-09 15:21:50 +00:00
.Pp
.Bl -tag -width ".Va tabstops" -compact
.It Va radix
Input and output radix.
.It Va maxoff
Addresses are printed as
.Dq Ar symbol Ns Li + Ns Ar offset
unless
.Ar offset
is greater than
.Va maxoff .
.It Va maxwidth
The width of the displayed line.
2006-10-09 15:21:50 +00:00
.It Va lines
The number of lines.
2006-10-09 15:21:50 +00:00
It is used by the built-in pager.
.It Va tabstops
Tab stop width.
2006-10-09 15:21:50 +00:00
.It Va work Ns Ar xx
Work variable;
1996-01-17 21:07:02 +00:00
.Ar xx
2006-10-09 15:21:50 +00:00
can take values from 0 to 31.
1996-01-17 21:07:02 +00:00
.El
.Sh EXPRESSIONS
2006-10-09 15:21:50 +00:00
Most expression operators in C are supported except
.Ql ~ ,
.Ql ^ ,
1996-01-17 21:07:02 +00:00
and unary
2006-10-09 15:21:50 +00:00
.Ql & .
1996-01-17 21:07:02 +00:00
Special rules in
.Nm
are:
2006-10-09 15:21:50 +00:00
.Bl -tag -width ".No Identifiers"
.It Identifiers
1996-01-17 21:07:02 +00:00
The name of a symbol is translated to the value of the symbol, which
is the address of the corresponding object.
2006-10-09 15:21:50 +00:00
.Ql \&.
1996-01-17 21:07:02 +00:00
and
2006-10-09 15:21:50 +00:00
.Ql \&:
1996-01-17 21:07:02 +00:00
can be used in the identifier.
If supported by an object format dependent routine,
2001-01-15 17:22:16 +00:00
.Sm off
2006-10-09 15:21:50 +00:00
.Oo Ar filename : Oc Ar func : lineno ,
2001-01-15 17:22:16 +00:00
.Sm on
2006-10-09 15:21:50 +00:00
.Oo Ar filename : Oc Ns Ar variable ,
1996-01-17 21:07:02 +00:00
and
2006-10-09 15:21:50 +00:00
.Oo Ar filename : Oc Ns Ar lineno
can be accepted as a symbol.
2006-10-09 15:21:50 +00:00
.It Numbers
1996-01-17 21:07:02 +00:00
Radix is determined by the first two letters:
2006-10-09 15:21:50 +00:00
.Ql 0x :
1996-01-17 21:07:02 +00:00
hex,
2006-10-09 15:21:50 +00:00
.Ql 0o :
1996-01-17 21:07:02 +00:00
octal,
2006-10-09 15:21:50 +00:00
.Ql 0t :
1996-01-17 21:07:02 +00:00
decimal; otherwise, follow current radix.
.It Li \&.
2006-10-09 15:21:50 +00:00
.Va dot
.It Li +
.Va next
.It Li ..
address of the start of the last line examined.
2006-10-09 15:21:50 +00:00
Unlike
.Va dot
or
.Va next ,
this is only changed by
.Ic examine
1996-01-17 21:07:02 +00:00
or
2006-10-09 15:21:50 +00:00
.Ic write
1996-01-17 21:07:02 +00:00
command.
2006-10-09 15:21:50 +00:00
.It Li '
last address explicitly specified.
2006-10-09 15:21:50 +00:00
.It Li $ Ns Ar variable
1996-01-17 21:07:02 +00:00
Translated to the value of the specified variable.
It may be followed by a
2006-10-09 15:21:50 +00:00
.Ql \&:
1996-01-17 21:07:02 +00:00
and modifiers as described above.
2006-10-09 15:21:50 +00:00
.It Ar a Ns Li # Ns Ar b
A binary operator which rounds up the left hand side to the next
multiple of right hand side.
2006-10-09 15:21:50 +00:00
.It Li * Ns Ar expr
Indirection.
It may be followed by a
2006-10-09 15:21:50 +00:00
.Ql \&:
1996-01-17 21:07:02 +00:00
and modifiers as described above.
.El
.Sh SCRIPTING
.Nm
supports a basic scripting facility to allow automating tasks or responses to
specific events.
Each script consists of a list of DDB commands to be executed sequentially,
and is assigned a unique name.
Certain script names have special meaning, and will be automatically run on
various
.Nm
events if scripts by those names have been defined.
.Pp
The
.Ic script
command may be used to define a script by name.
Scripts consist of a series of
.Nm
commands separated with the
.Ic ;
character.
For example:
.Bd -literal -offset indent
script kdb.enter.panic=bt;show pcpu
script lockinfo=show alllocks;show lockedvnods
.Ed
.Pp
The
.Ic scripts
command lists currently defined scripts.
.Pp
The
.Ic run
command execute a script by name.
For example:
.Bd -literal -offset indent
run lockinfo
.Ed
.Pp
The
.Ic unscript
command may be used to delete a script by name.
For example:
.Bd -literal -offset indent
unscript kdb.enter.panic
.Ed
.Pp
These functions may also be performed from userspace using the
.Xr ddb 8
command.
.Pp
Certain scripts are run automatically, if defined, for specific
.Nm
events.
The follow scripts are run when various events occur:
.Bl -tag -width kdb.enter.powerfail
.It Dv kdb.enter.acpi
The kernel debugger was entered as a result of an
.Xr acpi 4
event.
.It Dv kdb.enter.bootflags
The kernel debugger was entered at boot as a result of the debugger boot
flag being set.
.It Dv kdb.enter.break
The kernel debugger was entered as a result of a serial or console break.
.It Dv kdb.enter.cam
The kernel debugger was entered as a result of a
.Xr CAM 4
event.
.It Dv kdb.enter.mac
The kernel debugger was entered as a result of an assertion failure in the
.Xr mac_test 4
module of the
TrustedBSD MAC Framework.
.It Dv kdb.enter.ndis
The kernel debugger was entered as a result of an
.Xr ndis 4
breakpoint event.
.It Dv kdb.enter.netgraph
The kernel debugger was entered as a result of a
.Xr netgraph 4
event.
.It Dv kdb.enter.panic
.Xr panic 9
was called.
.It Dv kdb.enter.powerfail
The kernel debugger was entered as a result of a powerfail NMI on the sparc64
platform.
.It Dv kdb.enter.powerpc
The kernel debugger was entered as a result of an unimplemented interrupt
type on the powerpc platform.
.It Dv kdb.enter.sysctl
The kernel debugger was entered as a result of the
.Dv debug.kdb.enter
sysctl being set.
.It Dv kdb.enter.trapsig
The kernel debugger was entered as a result of a trapsig event on the sparc64
or sun4v platform.
.It Dv kdb.enter.unionfs
The kernel debugger was entered as a result of an assertion failure in the
union file system.
.It Dv kdb.enter.unknown
The kernel debugger was entered, but no reason has been set.
.It Dv kdb.enter.vfslock
The kernel debugger was entered as a result of a VFS lock violation.
.It Dv kdb.enter.watchdog
The kernel debugger was entered as a result of a watchdog firing.
.It Dv kdb.enter.witness
The kernel debugger was entered as a result of a
.Xr witness 4
violation.
.El
.Pp
In the event that none of these scripts is found,
.Nm
will attempt to execute a default script:
.Bl -tag -width kdb.enter.powerfail
.It Dv kdb.enter.default
The kernel debugger was entered, but a script exactly matching the reason for
entering was not defined.
This can be used as a catch-all to handle cases not specifically of interest;
for example,
.Dv kdb.enter.witness
might be defined to have special handling, and
.Dv kdb.enter.default
might be defined to simply panic and reboot.
.El
.Sh HINTS
On machines with an ISA expansion bus, a simple NMI generation card can be
constructed by connecting a push button between the A01 and B01 (CHCHK# and
GND) card fingers.
Momentarily shorting these two fingers together may cause the bridge chipset to
generate an NMI, which causes the kernel to pass control to
.Nm .
Some bridge chipsets do not generate a NMI on CHCHK#, so your mileage may vary.
The NMI allows one to break into the debugger on a wedged machine to
diagnose problems.
Other bus' bridge chipsets may be able to generate NMI using bus specific
methods.
.Sh SEE ALSO
.Xr gdb 1 ,
.Xr kgdb 1 ,
.Xr acpi 4 ,
.Xr CAM 4 ,
.Xr mac_text 4 ,
.Xr ndis 4 ,
.Xr netgraph 4 ,
.Xr textdump 4 ,
.Xr witness 4 ,
.Xr ddb 8 ,
.Xr sysctl 8 ,
.Xr panic 9
1996-01-17 21:07:02 +00:00
.Sh HISTORY
The
.Nm
debugger was developed for Mach, and ported to
.Bx 386 0.1 .
1996-01-17 21:07:02 +00:00
This manual page translated from
2006-10-09 15:21:50 +00:00
.Xr man 7
macros by
.An Garrett Wollman .
.Pp
.An Robert N. M. Watson
added support for
.Nm
output capture,
.Xr textdump 4
and scripting in
.Fx 8.0 .