DB_COMMAND(9) Extends the ddb command set

Other Alias



In ddb/ddb.h Fo DB_COMMAND Fa command_name Fa command_function Fc Fn DB_SHOW_COMMAND command_name command_function Fn DB_SHOW_ALL_COMMAND command_name command_function


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

The Fn DB_SHOW_COMMAND and Fn DB_SHOW_ALL_COMMAND are roughly equivalent to Fn DB_COMMAND but in these cases, Fa 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 Fa command_function :

Fa addr
The address passed to the command as an argument.
Fa have_addr
A boolean value that is true if the addr field is valid.
Fa count
The number of quad words starting at offset Fa addr that the command must process.
Fa 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".


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\n", addr);

Then, when in ddb:

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


This manual page was written by An Guillaume Ballet Aq [email protected] .