2 .\" Mach Operating System
3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
4 .\" All Rights Reserved.
6 .\" Permission to use, copy, modify and distribute this software and its
7 .\" documentation is hereby granted, provided that both the copyright
8 .\" notice and this permission notice appear in all copies of the
9 .\" software, derivative works or modified versions, and any portions
10 .\" thereof, and that both notices appear in supporting documentation.
12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
16 .\" Carnegie Mellon requests users of this software to return to
18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 .\" School of Computer Science
20 .\" Carnegie Mellon University
21 .\" Pittsburgh PA 15213-3890
23 .\" any improvements or extensions that they make and grant Carnegie Mellon
24 .\" the rights to redistribute these changes.
26 .\" changed a \# to #, since groff choked on it.
30 .\" Revision 1.1 1993/07/15 18:41:02 brezak
33 .\" Revision 2.6 92/04/08 08:52:57 rpd
35 .\" [92/01/17 14:19:22 jsb]
36 .\" Changes for OSF debugger modifications.
39 .\" Revision 2.5 91/06/25 13:50:22 rpd
40 .\" Added some watchpoint explanation.
43 .\" Revision 2.4 91/06/17 15:47:31 jsb
44 .\" Added documentation for continue/c, match, search, and watchpoints.
45 .\" I've not actually explained what a watchpoint is; maybe Rich can
46 .\" do that (hint, hint).
47 .\" [91/06/17 10:58:08 jsb]
49 .\" Revision 2.3 91/05/14 17:04:23 mrt
50 .\" Correcting copyright
52 .\" Revision 2.2 91/02/14 14:10:06 mrt
53 .\" Changed to new Mach copyright
54 .\" [91/02/12 18:10:12 mrt]
56 .\" Revision 2.2 90/08/30 14:23:15 dbg
60 .\" $FreeBSD: src/share/man/man4/ddb.4,v 1.7.2.6 2001/08/17 13:08:37 ru Exp $
67 .Nd interactive kernel debugger
72 .Cd options DDB_UNATTENDED
76 kernel debugger has most of the features of the old kdb,
77 but with a more rational syntax
80 If linked into the running kernel,
81 it can be invoked locally with the
84 action (the default is Control-Alt-Esc).
85 The debugger is also invoked on kernel
88 .Va debug.debugger_on_panic
90 MIB variable is set non-zero,
96 .Va debug.trace_on_panic
98 MIB variable will cause
100 to print a stack trace on
102 It is zero by default unless the
106 The current location is called `dot'. The `dot' is displayed with
107 a hexadecimal format at a prompt.
108 Examine and write commands update `dot' to the address of the last line
109 examined or the last location modified, and set `next' to the address of
110 the next location to be examined or changed.
111 Other commands don't change `dot', and set `next' to be the same as `dot'.
113 The general command syntax is:
114 .Cm command Ns Op Li \&/ Ns Ar modifier
115 .Ar address Ns Op Li , Ns Ar count
117 A blank line repeats the previous command from the address `next' with
118 count 1 and no modifiers. Specifying
123 uses `dot'. A missing
126 to be 1 for printing commands or infinity for stack traces.
130 debugger has a feature like the
133 for the output. If an output line exceeds the number set in the
135 variable, it displays
137 and waits for a response.
138 The valid responses for it are:
140 .Bl -tag -compact -width SPC
146 abort the current command, and return to the command input mode
151 provides a small (currently 10 items) command history, and offers
152 simple emacs-style command line editing capabilities. In addition to
153 the emacs control keys, the usual ANSI arrow keys might be used to
154 browse through the history buffer, and move the cursor within the
160 Display the addressed locations according to the formats in the modifier.
161 Multiple modifier formats display multiple locations.
162 If no format is specified, the last formats specified for this command
165 The format characters are:
166 .Bl -tag -compact -width indent
168 look at by bytes (8 bits)
170 look at by half words (16 bits)
172 look at by long words (32 bits)
174 print the location being displayed
176 print the location with a line number if possible
178 display in unsigned hex
180 display in signed hex
182 display in unsigned octal
184 display in signed decimal
186 display in unsigned decimal
188 display in current radix, signed
190 display low 8 bits as a character.
191 Non-printing characters are displayed as an octal escape code (e.g., `\e000').
193 display the null-terminated string at the location.
194 Non-printing characters are displayed as octal escapes.
196 display in unsigned hex with character dump at the end of each line.
197 The location is also displayed in hex at the beginning of each line.
199 display as an instruction
206 Execute an examine command with the last specified parameters to it
207 except that the next address displayed by it is used as the start address.
210 Execute an examine command with the last specified parameters to it
211 except that the last start address subtracted by the size displayed by it
212 is used as the start address.
213 .It Cm print Ns Op Cm /acdoruxz
216 according to the modifier character (as described above for
228 If no modifier is specified, the last one specified to it is used.
230 can be a string, in which case it is printed as it is. For example:
231 .Bd -literal -offset indent
232 print/x \&"eax = \&" $eax \&"\enecx = \&" $ecx \&"\en\&"
236 .Bd -literal -offset indent
241 .Cm write Ns Op Cm /bhl
242 .Ar addr Ar expr1 Op Ar "expr2 ..."
244 Write the expressions specified after
246 on the command line at succeeding locations starting with
248 The write unit size can be specified in the modifier with a letter
254 (long word) respectively. If omitted,
255 long word is assumed.
258 since there is no delimiter between expressions, strange
260 It's best to enclose each expression in parentheses.
263 .Li \&$ Ns Ar variable
267 Set the named variable or register with the value of
269 Valid variable names are described below.
270 .It Cm break Ns Op Cm /u
275 is supplied, continues
277 - 1 times before stopping at the
278 break point. If the break point is set, a break point number is
281 This number can be used in deleting the break point
282 or adding conditions to it.
286 modifier is specified, this command sets a break point in user space
289 option, the address is considered in the kernel
290 space, and wrong space address is rejected with an error message.
291 This modifier can be used only if it is supported by machine dependent
295 If a user text is shadowed by a normal user space debugger,
296 user space break points may not work correctly. Setting a break
297 point at the low-level code paths may also cause strange behavior.
298 .It Cm delete Ar addr
299 .It Cm delete Li \&# Ns Ar number
300 Delete the break point. The target break point can be specified by a
301 break point number with
305 specified in the original
308 .It Cm step Ns Op Cm /p
311 times (the comma is a mandatory part of the syntax).
314 modifier is specified, print each instruction at each step.
315 Otherwise, only print the last instruction.
318 depending on machine type, it may not be possible to
319 single-step through some low-level code paths or user space code.
320 On machines with software-emulated single-stepping (e.g., pmax),
321 stepping through code executed by interrupt handlers will probably
323 .It Cm continue Ns Op Cm /c
324 Continue execution until a breakpoint or watchpoint.
327 modifier is specified, count instructions while executing.
328 Some machines (e.g., pmax) also count loads and stores.
331 when counting, the debugger is really silently single-stepping.
332 This means that single-stepping on low-level code may cause strange
334 .It Cm until Ns Op Cm /p
335 Stop at the next call or return instruction.
338 modifier is specified, print the call nesting depth and the
339 cumulative instruction count at each call or return. Otherwise,
340 only print when the matching return is hit.
341 .It Cm next Ns Op Cm /p
342 .It Cm match Ns Op Cm /p
343 Stop at the matching return instruction.
346 modifier is specified, print the call nesting depth and the
347 cumulative instruction count at each call or return. Otherwise,
348 only print when the matching return is hit.
349 .It Cm call Ar function
352 Could be used for kernel dump with
359 Useful when testing MMU/PMAP.
363 .Cm trace Ns Op Cm /u
369 option traces user space; if omitted,
374 is the number of frames to be traced.
377 is omitted, all frames are printed.
380 User space stack trace is valid
381 only if the machine dependent code supports it.
383 .Cm search Ns Op Cm /bhl
391 This command might fail in interesting
392 ways if it doesn't find the searched-for value. This is because
393 ddb doesn't always recover from touching bad memory. The optional
395 argument limits the search.
396 .It Cm show all procs Ns Op Cm /m
397 .It Cm ps Ns Op Cm /m
398 Display all process information.
399 The process information may not be shown if it is not
400 supported in the machine, or the bottom of the stack of the
401 target process is not in the main memory at that time.
404 modifier will alter the display to show VM map
405 addresses for the process and not show other info.
406 .It Cm show registers Ns Op Cm /u
407 Display the register set.
410 option is specified, it displays user registers instead of
411 kernel or currently saved one.
416 modifier depends on the machine. If
417 not supported, incorrect information will be displayed.
419 .Cm show map Ns Op Cm /f
426 modifier is specified the
427 complete map is printed.
429 .Cm show object Ns Op Cm /f
432 Prints the VM object at
436 option is specified the
437 complete object is printed.
438 .It Cm show ktr Ns Op Cm /v
439 Prints the contents of
444 modifier is specified, timestamp, filename and line number are displayed
447 For every global token, it prints its address, exclusive owner address,
448 number of collisions and description.
449 .It Cm "show watches"
450 Displays all watchpoints.
453 .Ar addr Ns Li \&, Ns Ar size
455 Set a watchpoint for a region. Execution stops
456 when an attempt to modify the region occurs.
459 argument defaults to 4.
460 If you specify a wrong space address, the request is rejected
461 with an error message.
464 Attempts to watch wired kernel memory
465 may cause unrecoverable error in some systems.
466 Watchpoints on user addresses work best.
468 If the kernel was compiled with
470 call the ACPICA debugger.
471 For more information, see the
472 .Dq ACPI Component Architecture User Guide and Programmer Reference .
474 Toggles between remote GDB and DDB mode. In remote GDB mode, another
475 machine is required that runs
477 using the remote debug feature, with a connection to the serial
478 console port on the target machine. Currently only available on the
482 Print a short summary of the available commands and command
486 The debugger accesses registers and variables as
488 Register names are as in the
489 .Dq Cm show registers
491 Some variables are suffixed with numbers, and may have some modifier
492 following a colon immediately after the variable name.
493 For example, register variables can have a
495 modifier to indicate user register (e.g.,
498 Built-in variables currently supported are:
499 .Bl -tag -width tabstops -compact
501 Input and output radix
503 Addresses are printed as 'symbol'+offset unless offset is greater than maxoff.
505 The width of the displayed line.
507 The number of lines. It is used by "more" feature.
516 Almost all expression operators in C are supported except
524 .Bl -tag -width Identifiers
526 The name of a symbol is translated to the value of the symbol, which
527 is the address of the corresponding object.
531 can be used in the identifier.
532 If supported by an object format dependent routine,
534 .Oo Em filename : Oc Em func : lineno ,
536 .Oo Em filename : Oc Ns Em variable ,
538 .Oo Em filename : Oc Ns Em lineno
539 can be accepted as a symbol.
541 Radix is determined by the first two letters:
547 decimal; otherwise, follow current radix.
553 address of the start of the last line examined.
554 Unlike `dot' or `next', this is only changed by
560 last address explicitly specified.
561 .It Li \&$ Ns Em variable
562 Translated to the value of the specified variable.
563 It may be followed by a
565 and modifiers as described above.
566 .It Em a Ns Li \&# Ns Em b
567 a binary operator which rounds up the left hand side to the next
568 multiple of right hand side.
569 .It Li \&* Ns Em expr
570 indirection. It may be followed by a
572 and modifiers as described above.
580 debugger was developed for Mach, and ported to
582 This manual page translated from
584 macros by Garrett Wollman.