ddb(4): vax: Clarify how to enter into DDB from console

See gencnrint() and kdbrint().

// At last, I can activate DDB on SIMH ;)

ddb: New `show all tstiles' command.

Shows who's waiting for which locks and what the owner is up to.

XXX pullup-10

branches: 1.202.2;
Add missing "show vmem[s]".

Fix date.

x/I no longer has special meaning on alpha, and behaves just like x/i.

Numeric modifiers conflict with the syntax interpretation of ddb, so use 'b', 'w', 'l', 'q' instead.
Also, change load/store('l','s') to 'r','w' like the other arch.

>db{0}> machine watch/1 hostname
>Bad modifier

>db{0}> machine watch/s1 hostname
>add watchpoint 0 as ffffc00001087848

Add missing 'q' modifier for the write command.

ddb: add two new modifiers to "show pool" and "show all pools"

- /s shows a short single-line per pool list (the normal output
is about 10 lines per.)
- /S skips pools with zero allocations.

Install ddb(9). Xref it from ddb(4).

Fix editor mistake in previous.

Document the MIPs "mips machine {cpu,nmi,watch,unwatch}" commands.
Add commented out stubs for the mfcr and mtcr commands.

Use upper-case "CPU" consistently in all text except DDB command names.

New sentence, new line.

Copy "mach reset" logic from arm32 recently added by jmcneill@. The
previous MIPS "mach reset" DDB command was hard-coded for Octeon Cavium
CPUs only.

Add ddb "mach reset" command for Arm ports.

Don't mention a.out support, which does not exist in ddb any more.

Teach ddb(4) about printing the full mount list.

- examin/m displays with splitting by spaces as specified size
- add support 'q' modifier on all arch
- consider endianness

Add support for 'p' qualifier for pointer values on examine.
this shows as a pointer with symbol if possible. (e.g. "x/p $sp,10")

Describe how to enter ddb for evbarm.
Bump date.

The 'c' modifier of mbuf command is to NOT follow the mbuf chain.
Usually, users want to floow the mbuf chain. This modifier is used when a
user don't want to follow a mbuf chain.

extend the ddb "show kernhist" command. the synopsis is now:

show kernhist[/i] [addr[,count]]

the i modifier means display info instead of entries, and the count
restricts to the last count entries.

the count option is only supported for specified histories. it
could be extended but requires more logic than the single history,
as multiple histories are merged during display.

Add machine commands for aarch64.

Improve wording.

Add "show socket" command written by Hiroki SUENAGA. It prints usage of
system's socket buffers.

Add /d(dump) and /v(verbose) modifiers to DDB's "show mbuf" command. Mainly
written by Hiroki SUENAGA. Currently, /v supports Ethernet, PPP, PPPoE, ARP,
IPv4, ICMP, IPv6, ICMPv6, TCP and UDP.

branches: 1.178.2;
ddb: rename "show lockstat" to "show lockstats" to avoid conflicting with lockstat(8)

Requested by mrg@

Improve wording. Fix a Cm argument.

Add a new command, show all locks, which shows information of active locks

The command shows information of all active (i.e., being held) locks that are
tracked through either of LWPs or CPUs by the LOCKDEBUG facility. The /t
modifier additionally shows a backtrace for each LWP additionally. This
feature is useful for debugging especially to analyze deadlocks.

The command is useful only if LOCKDEBUG is enabled.

Add a new command, show lockstat, which shows statistics of locks

Currently the command shows the number of allocated locks.

The command is useful only if LOCKDEBUG is enabled.

branches: 1.174.2;
Quote minus.

document dumpstack variable.
Sort built-in variables alphabetically.

Remove macros without effect.

Remove port-acorn26

OK core@

Fix word.

Remove Tn.

document ddb.panicstackframes

Remove workaround for ancient HTML generation code.

branches: 1.166.6;
Fix typo.

Try to document the new "show vnode_lock" command.

Bump date for previous.

Update the list of options that enable the "show kernhist" command, and
restructure a bit.

Add a BIOHIST option. As mentioned on tech-kern.

branches: 1.161.2;
ddb: rename show arptab to show routes

show arptab command of ddb is now inappropriate because it actually dumps
routes but arp entries aren't routes anymore. So rename it to show routes
and move the code from if_arp.c to route.c.

ok christos@

Slight markup fix.

Update for 'show kernhist' change. (go wiz!)

Bump date for previous, remove empty line.

Add sandpoint ddb-entry method.

PR/8899: Alexander Nasonov: ddb command 'show malloc' is no longer available

branches: 1.155.2;
Rename NetBSD/hp700 to NetBSD/hppa.

Unfortunately our VCS isn't very helpful here.

Change from deleted "show uvmhist" to "show kernhist".

XXX pullup-6

remove show dmesg

add show dmesg

document show panic

mention what sync does.

branches: 1.149.6;
Address kern/36526. Note, contrary to the PR, ; command separator works as
documented in ddb(4)
Document ddb.commandonenter sysctl. Note, commandonenter is not available
as a variable:
db{0}> print $onpanic
1
db{0}> print $commandonenter
Unknown variable
So document the sysctl elsewhere, not in the variables section.

Update hp700 key sequences section.

branches: 1.147.2;
ps/l shows LWP name, not command name.

Document "show proc". Be more verbose about commands that print
information about processes especially the '>' sign (e.g. LWP is
currently running).

Bump date. Straight from Hackathon@ESPCI.

Be more precise for Xen dom0: either Ctrl + Alt + Esc, or +++++ when on
serial console.

Thanks to Christoph and Manuel for pointing that out.

Be more precise for Xen: +++++ is only valid for Xen domUs. dom0 uses
the same key sequences as i386/amd64.

Quote minus so it does not become a dash.

Document additional settings for onpanic, from options(4).

Fix a typo. Bump date for previous.

document the acorn26, i386, ia64 and vax ddb commands in both the builtin
help and in ddb.4. fixes PR#38304, PR#38305, PR#38309 and PR#38313.

properly document alpha ddb "mach" commands. PR#38303.

note that sun2 has the same ddb mach commands as sun3/sun3x. part of PR#38310

branches: 1.137.2;
Document new hp700 'frame' command.

Uncomment crash(8) reference.

Comment out crash(8) reference, per PR 10708, until a MI one exists.

New modifiers for the "write" command: /BHL. They act like /bhl but do not
read the old value from memory before writing.

Bump date for more powerpc commands.

New machine commands for PPC OEA.
bat: prints the BAT registers and translations
mmu: prints MMU registers (sdr1, sr0..15)
Previous PPC commands were for IBM4xx only, so make two sections now:
POWERPC 4xx and POWERPC OEA.

Bump date for PowerPC descriptions. Make HTML-ready.

document powerpc ddb commands. PR#38307.

Bump date for sparc ddb command descriptions.

document sparc ddb commands. PR#38312.

Match wording in list to other entries.

extend 'show event' to take /i /t and /m modifiers, to select interrupt,
trap or misc event types. you can mix them with /f as well, to show all
including zero events for traps and misc, "show event/ftm"

Use .It "" instead of .br, they are different logical lines.
Don't use .Xo/.Xc to work around ancient macro argument limit.

Add crash(8), a utility to diagnose kernel crashes. This is basically
ddb running on crash dumps, but with two notable changes:

- Breakpoints, watches, etc are obviously never going to work so they
are not handled.

- You can pipe output to the shell, e.g. ps | grep foo

Items remaining to be done:

- Port it to architectures other than i386. This isn't difficult, just
a case of making db_disasm.c/db_trace.c or their equivalent compile
and work.

- Make more of the "show" commands work, e.g "show uvmexp".

branches: 1.123.2;
Fix typo in .Dd argument. New sentence, new line.

Default 'show all procs' to /l. People tend to type 'ps' without modifiers
when providing information about deadlocks. Without the thread info it's
not very useful.

It's "show uvmhist" not "uvmhist".

Bump date for zaurus key combination.

Update ddb.4 to include Zaurus key combinations.

branches: 1.118.2;
fix formatting error

typo

Note show uvmhist.

Bump date.

Add documentation for show files command

Add simple help messages for MD machine commands on ddb(4).
PR port-mips/38306

branches: 1.113.2;
Move TNF licenses to 2 clause form

branches: 1.112.2; 1.112.4;
Remove arm32 ddb machine commands that no longer exist.

Also change widest string to traptrace as intrchain no longer exists.

Fixes port-arm/38311

Bump the date.

Add magic keyboard sequence for NetBSD-amd64.

Remove support for NetBSD/pc532.

document whatis.

Fix typos.

Improve sparc64 "mach" descriptions.

Add a few missing "mach" commands for sparc64.

Document options DDB_VERBOSE_HELP.

branches: 1.103.4;
Document lines=0 and maxwidth=0

describe: show all callout, show arptab, show lock, show malloc

Fix typo in Dd.

s/pid/lwpaddr/ in the bt/a case.

Document trace/a.

update the "bt" description to include "/l" modifier

branches: 1.97.2; 1.97.4; 1.97.6;
Add /l to description of "ps" abbreviation for "show all procs".

Document 'show all procs /l'. (i.e. catch up with reality)

Bump date for previous.

How to enter ddb on a xen comU: +++++
By Jeff Ito (ijk at speakeasy dot net) on port-xen@

Fix some typos.

Bump date for previous.

Document "show all pages". Reminded by wiz.

add "show mbuf" command.

Drop trailing whitespace.

Bump date to welcome back # operator.

Widen "Value" column in the reboot desccription to accomodate RB_POWERDOWN.
Make the table aligned properly in PostScript output.

Reinstate description of # operator lost in an editing accident.
While here, fix spacing in the description of possible identifier syntax.

Remove superfluous quoting. Use Aq macro instead of \*[Lt]\*[Gt].

document "show all pools".

Sort SEE ALSO. Fix typo.

document DDB_COMMANDONENTER.

Expand the description of "reboot" slightly: add cross-references to
reboot(2) and reboot(8), and especially document RB_DUMP -- which is,
in fact, documented in reboot(2), if you'd only known to look there.

Bump date for tee_msgbuf; new sentence, new line.

Implement ddb setting that allows all ddb output to be teed into the
kernel message buffer/log. Its off by default and can be switched on in the
kernel configuration on build time, be set as a variable in ddb and be set
using sysctl.

This adds the sysctl value
ddb.tee_msgbuf = 0
by default.

The functionality is especially added and aimed for developers who are not
blessed with a serial console and wish to keep all their ddb output in the
log. Specifying /l as a modifier to some selected commands will also put
the output in the log but not all commands provide one nor has the same
meaning for all commands.

This feature could in the future also be implemented as an ddb command but
that could lead to more bloat allthough maybe easier for non developpers to
use when mailing their backtraces from kernel crashes.

Add hpcarm and sparc64 key sequences.
Remove sun3x key sequence (no longer a separate port).

Mention hw.cnmagic. From Christian Biere in PR 24405.
Also, Xr cnmagic(9) and bump date.

Mention how to enter DDB on vax. From Brian Chase in PR 23740.

NetBSD -> .Nx; use Dv for an option name; bump date for previous.

add "show mount" ddb command

document the (more useful) flags for `reboot'

Bump date for previous, and escape an exclamation mark so it
gets marked up.

Document "show sched_qs".

Bump date for last.

Document the new "count" argument to the dmesg command.

Fix Ns usage; quote exclamation mark.

Remove some superfluous macro calls.

New sentence, new line. Bump date for last. Add missing "the".

(1) Don't print the message buffer (via ddb's dmesg command) if the
message buffer has not yet been set up, mimicking code from the top of
the sysctl routine for retrieving the message buffer.

(2) Add a /l modifier to the trace command. This makes it print the
backtrace using printf() instead of db_printf(), which has the nice
side-effect of also putting it into the message buffer. A kernel with
ddb in it but disabled (ie, ddb.onpanic set to zero) will print a
backtrace (which ends up in the message buffer) before dumping (or
not, depending on the value of kern.dump_on_panic) and rebooting, but
if ddb is not disabled, the backtrace is not printed, and there's no
way to get it to display a backtrace such that you can retrieve it
after the dump. The backtrace printed by gdb is sometimes a little
different.

(3) Documentation for the above.

Hack around ".Nm" introducing newlines in the SYNOPSIS section.
Reported by Kouichiro Hiratsuka via uebayasi.

Uppercase prom and eeprom.

Mention how to enter ddb on macppc. Bump date and copyright.

Drop trailing space.

.Nm does not need a dummy argument ("") before punctuation or
for correct formatting of the SYNOPSIS any longer.

Add a synonym for trace - 'bt' and document it

document sh3 and hpcsh usage.

Document "show event".

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

fix typo: u-are -> u-area

Convenience variables (workXX) don't work, so don't document them.

Sort sections, sort SEE ALSO, and some formatting improvements.

Change xref for vmstat(8) to vmstat(1).
Whitespace, punctuation and spelling fixes while I'm here.

describe about $fromconsole

Copyright 1997-2001 (range).
Document some stuff:
show breaks
show buf
show ncache
show page
show pool
show uvmexp
show vnode
Sprinkle some commas.

document sparc64 usage.

branches: 1.48.2;
Fix long-standing inconsistency between manapage and code.
The "ditto" character is " (double-quote); not , (comma) as
indicated in the manpage; and not ' (single-quote) as indicated
in the man.old -style manpage from which the mdoc manpage was derived.

Some other versions of ddb use single-quote for this feature, and this
part of the code may change again in the near future, but the documentation
now affects reality now.
they

branches: 1.47.2;
Note "sifting" requires backslash escapes for leading digits.

Add a "sifting" command to ddb (named from the Sun OpenPROM command of
the same name); it searches the symbol table(s) for all symbols matching
a given substring, and prints.

Extremely useful for when you forget that critical symbol name.

Also, with /F support (cf. "ls -F") to print a char indicating the
symbol type.

BREAK gets ddb on the i386 serial console
fix ")." misconstruction (mandoc)

Sort commands alphabetically (wow, much easier to find things now).

Fix few commands using Cm instead of Ic [consisntency].

Make .Bl's -compact in most cases (where items are one-line entries);
dramatically improves readability

No more 'mach halt' on MIPS.

Comment out "xf" and "xb"; they aren't implemented and don't
ever appear to have been.

Document "!" as a synonym for "call"

GC spurious blank lines.

From kern/9569.
Preserve ddb's idea of "count" from one command to the next if
repeating a command via hitting newline.

Remove MIPS/trapdump.
Mention MIPS/kvtop.

Add a description about key sequences for hpcmips.

document "sync" command

branches: 1.35.2;
Document new `L' format modifier.

Revert previous.

Driving directions: serial console to ddb prompt

More and more of .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Many more to
come.

Fix minor formatting errors.

Add note about PID.

minor fix

Add dwatch, kill and call.

Add the method to activate DDB on the atari (Julian Coleman).

note x68k's NMI switch.

sync "x/I" section to reality

remove a note about eeprom on Suns - not true.

additional miscellaneous cleanup of "entering debugger" and "machine-specific commands" sections.

add sun3{,x} key sequence to "entering debugger"

The "entering debugger" section moved higher.
Key sequences for "pmax" added to "entering debugger".

fixed the mdoc display formatting for the machine specific commands

Herewith find documentation of the machine/port specific commands
to ddb(4) that I can glean from the source code as requested by PR#1562.

Portmasters, please check for accuracy.

Also, someone with a bit more facility with mdoc(7) should figure
out why I get the odd indentation when I thought I used the macros
in a reasonable fashion...

macroize BSD, NetBSD, FreeBSD and misc cleanup

Add DDB key sequences for alpha and mvme68k.

add amiga interrupt sequence

* major rewrite from scratch using -mandoc macros (it was a -man.old doc)
* cleaned up a few points, clarifying ambiguous sentences
* documented DDB_HISTORY_SIZE=xxx kernel option, and the appropriate
editing keys
* added notes on how to drop into ddb on the mac68k (from [kern/4501])

update doc on new "ps" options

branches: 1.13.2;
Fix many more formatting bugs, and add a section on activating the debugger.

Fix a few formatting bugs.

Document the reboot command.

Document trace/t

alternate -> alternative, per PR 2643

.TH argument should be uppercase.

add the missing SYNOPSIS section.

Document "onpanic" built-in variable.

Merged with 4.4lite.
Changed to conform to NetBSD's new RCS Id convention.

Add RCS identifiers, remove some completely useless RCS logs and patchkit
headers, and a few other insignificant changes.

kill change log

Set RCS comment leader to .\".

Man page for DDB