db_show_all_command(9) [freebsd man page]

DB_COMMAND(9)						   BSD Kernel Developer's Manual					     DB_COMMAND(9)

NAME

     DB_COMMAND, DB_SHOW_COMMAND, DB_SHOW_ALL_COMMAND -- Extends the ddb command set

SYNOPSIS

     #include <ddb/ddb.h>

     DB_COMMAND(command_name, command_function);

     DB_SHOW_COMMAND(command_name, command_function);

     DB_SHOW_ALL_COMMAND(command_name, command_function);

DESCRIPTION

     The DB_COMMAND() macro adds command_name to the list of top-level commands.  Invoking command_name from ddb will call command_function.

     The DB_SHOW_COMMAND() and DB_SHOW_ALL_COMMAND() are roughly equivalent to DB_COMMAND() but in these cases, command_name is a sub-command of
     the ddb show command and show all command, respectively.

     The general command syntax: command[/modifier] address[,count], translates into the following parameters for command_function:

	   addr 	 The address passed to the command as an argument.

	   have_addr	 A boolean value that is true if the addr field is valid.

	   count	 The number of quad words starting at offset addr that the command must process.

	   modif	 A pointer to the string of modifiers. That is, a series of symbols used to pass some options to the command. For example,
			 the examine command will display words in decimal form if it is passed the modifier "d".

EXAMPLE

     In your module, the command is declared as:

     DB_COMMAND(mycmd, my_cmd_func)
     {
	     if (have_addr)
		     db_printf("Calling my command with address %p
", addr);
     }

     Then, when in ddb:

     db> mycmd 0x1000
     Calling my command with address 0x1000
     db>

SEE ALSO

     ddb(4)

AUTHORS

     This manual page was written by Guillaume Ballet <gballet@gmail.com>.

BSD
								  August 27, 2008							       BSD

DDB(8)							    BSD System Manager's Manual 						    DDB(8)

NAME

     ddb -- configure DDB kernel debugger properties

SYNOPSIS

     ddb capture [-M -core] [-N -system] print
     ddb capture [-M -core] [-N -system] status
     ddb script scriptname
     ddb script scriptname=script
     ddb scripts
     ddb unscript scriptname
     ddb pathname

DESCRIPTION

     The ddb utility configures certain aspects of the ddb(4) kernel debugger from user space that are not configured at compile-time or easily
     via sysctl(8) MIB entries.

     To ease configuration, commands can be put in a file which is processed using ddb as shown in the last synopsis line.  An absolute pathname
     must be used.  The file will be read line by line and applied as arguments to the ddb utility.  Whitespace at the beginning of lines will be
     ignored as will lines where the first non-whitespace character is '#'.

OUTPUT CAPTURE

     The ddb utility can be used to extract the contents of the ddb(4) output capture buffer of the current live kernel, or from the crash dump of
     a kernel on disk.	The following debugger commands are available from the command line:

     capture [-M core] [-N system] print
	     Print the current contents of the ddb(4) output capture buffer.

     capture [-M core] [-N system] status
	     Print the current status of the ddb(4) output capture buffer.

SCRIPTING

     The ddb utility can be used to configure aspects of ddb(4) scripting from user space; scripting support is described in more detail in
     ddb(4).  Each of the debugger commands is available from the command line:

     script scriptname
	     Print the script named scriptname.

     script scriptname=script
	     Define a script named scriptname.	As many scripts contain characters interpreted in special ways by the shell, it is advisable to
	     enclose script in quotes.

     scripts
	     List currently defined scripts.

     unscript scriptname
	     Delete the script named scriptname.

EXIT STATUS

     The ddb utility exits 0 on success, and >0 if an error occurs.

EXAMPLES

     The following example defines a script that will execute when the kernel debugger is entered as a result of a break signal:

	   ddb script kdb.enter.break="show pcpu; bt"

     The following example will delete the script:

	   ddb unscript kdb.enter.break

     For further examples, see the ddb(4) and textdump(4) manual pages.

SEE ALSO

     ddb(4), textdump(4), sysctl(8)

HISTORY

     The ddb utility first appeared in FreeBSD 7.1.

AUTHORS

     Robert N M Watson

BUGS

     Ideally, ddb would not exist, as all pertinent aspects of ddb(4) could be configured directly via sysctl(8).

BSD
								 December 24, 2008							       BSD