The GDB/MI Interface
********************

Function and Purpose
====================

GDB/MI is a line based machine oriented text interface to GDBN.  It is specifically intended to support the development of systems which use the debugger as just one small component of a larger system.

This chapter is a specification of the GDB/MI interface.  It is written in the form of a reference manual.

Note that GDB/MI is still under construction, so some of the features described below are incomplete and subject to change.

Notation and Terminology
========================

This chapter uses the following notation:

  * | separates two alternatives.

  * [ SOMETHING ] indicates that SOMETHING is optional: it may or may not be given.

  * ( GROUP )* means that GROUP inside the parentheses may repeat zero or more times.

  * ( GROUP )+ means that GROUP inside the parentheses may repeat one or more times.

  * "STRING" means a literal STRING.

Acknowledgments
===============

In alphabetic order: Andrew Cagney, Fernando Nasser, Stan Shebs and Elena Zannoni.

GDB/MI Command Syntax
=====================

GDB/MI Input Syntax
-------------------

COMMAND ==>
     CLI-COMMAND | MI-COMMAND

CLI-COMMAND ==>
     [ TOKEN ] CLI-COMMAND NL, where CLI-COMMAND is any existing GDBN CLI command.

MI-COMMAND ==>
     [ TOKEN ] "-" OPERATION ( " " OPTION )* [ " --" ] ( " " PARAMETER )* NL

TOKEN ==>
     "any sequence of digits"

OPTION ==>
     "-" PARAMETER [ " " PARAMETER ]

PARAMETER ==>
     NON-BLANK-SEQUENCE | C-STRING

OPERATION ==>
     any of the operations described in this chapter

NON-BLANK-SEQUENCE ==>
     anything, provided it doesn't contain special characters such as "-", NL, """ and of course " "

C-STRING ==>
     """ SEVEN-BIT-ISO-C-STRING-CONTENT """

NL ==>
     CR | CR-LF

Notes:

  * The CLI commands are still handled by the MI interpreter; their output is described below.

  * The TOKEN, when present, is passed back when the command finishes.

  * Some MI commands accept optional arguments as part of the parameter list.  Each option is identified by a leading - (dash) and may be followed by an optional argument parameter.  Options occur first in the parameter list and can be delimited from normal parameters using -- (this is useful when some parameters begin with a dash).

Pragmatics:

  * We want easy access to the existing CLI syntax (for debugging).

  * We want it to be easy to spot a MI operation.

GDB/MI Output Syntax
--------------------

The output from GDB/MI consists of zero or more out-of-band records followed, optionally, by a single result record.  This result record is for the most recent command.  The sequence of output records is terminated by (GDBP).

If an input command was prefixed with a TOKEN then the corresponding output for that command will also be prefixed by that same TOKEN.

OUTPUT ==>
     ( OUT-OF-BAND-RECORD )* [ RESULT-RECORD ] "(gdb)" NL

RESULT-RECORD ==>
      [ TOKEN ] "^" RESULT-CLASS ( "," RESULT )* NL

OUT-OF-BAND-RECORD ==>
     ASYNC-RECORD | STREAM-RECORD

ASYNC-RECORD ==>
     EXEC-ASYNC-OUTPUT | STATUS-ASYNC-OUTPUT | NOTIFY-ASYNC-OUTPUT

EXEC-ASYNC-OUTPUT ==>
     [ TOKEN ] "*" ASYNC-OUTPUT

STATUS-ASYNC-OUTPUT ==>
     [ TOKEN ] "+" ASYNC-OUTPUT

NOTIFY-ASYNC-OUTPUT ==>
     [ TOKEN ] "=" ASYNC-OUTPUT

ASYNC-OUTPUT ==>
     ASYNC-CLASS ( "," RESULT )* NL

RESULT-CLASS ==>
     "done" | "running" | "connected" | "error" | "exit"

ASYNC-CLASS ==>
     "stopped" | OTHERS (where OTHERS will be added depending on the needs---this is still in development).

RESULT ==>
     [ STRING "=" ] VALUE

VALUE ==>
     CONST | "{" RESULT ( "," RESULT )* "}"

CONST ==>
     C-STRING

STREAM-RECORD ==>
     CONSOLE-STREAM-OUTPUT | TARGET-STREAM-OUTPUT | LOG-STREAM-OUTPUT

CONSOLE-STREAM-OUTPUT ==>
     "~" C-STRING

TARGET-STREAM-OUTPUT ==>
     "@" C-STRING

LOG-STREAM-OUTPUT ==>
     "&" C-STRING

NL ==>
     CR | CR-LF

TOKEN ==>
     any sequence of digits.

In addition, the following are still being developed:

QUERY
     This action is currently undefined.

Notes:

  * All output sequences end in a single line containing a period.

  * The TOKEN is from the corresponding request.  If an execution command is interrupted by the -exec-interrupt command, the TOKEN associated with the *stopped message is the one of the original execution command, not the one of the interrupt command.

  * STATUS-ASYNC-OUTPUT contains on-going status information about the progress of a slow operation.  It can be discarded.  All status output is prefixed by +.

  * EXEC-ASYNC-OUTPUT contains asynchronous state change on the target (stopped, started, disappeared).  All async output is prefixed by *.

  * NOTIFY-ASYNC-OUTPUT contains supplementary information that the client should handle (e.g., a new breakpoint information).  All notify output is prefixed by =.

  * CONSOLE-STREAM-OUTPUT is output that should be displayed as is in the console.  It is the textual response to a CLI command.  All the console output is prefixed by ~.

  * TARGET-STREAM-OUTPUT is the output produced by the target program. All the target output is prefixed by @.

  * LOG-STREAM-OUTPUT is output text coming from GDBN's internals, for instance messages that should be displayed as part of an error log.  All the log output is prefixed by &.

See GDB/MI Stream Records, for more details about the various output records.

See GDB/MI Draft Changes to Output Syntax, for proposed revisions to the current output syntax.

Simple Examples of GDB/MI Interaction
-------------------------------------

This subsection presents several simple examples of interaction using the GDB/MI interface.  In these examples, -> means that the following line is passed to GDB/MI as input, while <- means the output received from GDB/MI.

Target Stop
...........

Here's an example of stopping the inferior process:

     -> -stop
     <- (GDBP)

and later:

     <- *stop,reason="stop",address="0x123",source="a.c:123"
     <- (GDBP)

Simple CLI Command
..................

Here's an example of a simple CLI command being passed through GDB/MI and on to the CLI.

     -> print 1+2
     <- ~3\n
     <- (GDBP)

Command With Side Effects
.........................

     -> -symbol-file xyz.exe
     <- *breakpoint,nr="3",address="0x123",source="a.c:123"
     <- (GDBP)

A Bad Command
.............

Here's what happens if you pass a non-existent command:

     -> -rubbish
     <- error,"Rubbish not found"
     <- (GDBP)

GDB/MI Compatibility with CLI
=============================

To help users familiar with GDBN's existing CLI interface, GDB/MI accepts existing CLI commands.  As specified by the syntax, such commands can be directly entered into the GDB/MI interface and GDBN will respond.

This mechanism is provided as an aid to developers of GDB/MI clients and not as a reliable interface into the CLI.  Since the command is being interpreteted in an environment that assumes GDB/MI behaviour, the exact output of such commands is likely to end up being an un-supported hybrid of GDB/MI and CLI output.

GDB/MI Output Records
=====================

GDB/MI Result Records
---------------------

In addition to a number of out-of-band notifications, the response to a GDB/MI command includes one of the following result indications:

"^done" [ "," RESULTS ]
     The synchronous operation was successful, RESULTS are the return values.

"^running"
     The asynchronous operation was successfully started.  The target is running.

"^error" "," C-STRING
     The operation failed.  The C-STRING contains the corresponding error message.

GDB/MI Stream Records
---------------------

GDBN internally maintains a number of output streams: the console, the target, and the log.  The output intended for each of these streams is funneled through the GDB/MI interface using stream records.

Each stream record begins with a unique prefix character which identifies its stream (see GDB/MI Output Syntax).  In addition to the prefix, each stream record contains a STRING-OUTPUT.  This is either raw text (with an implicit new line) or a quoted C string (which does not contain an implicit newline).

"~" STRING-OUTPUT
     The console output stream contains text that should be displayed in the CLI console window.  It contains the textual responses to CLI commands.

"@" STRING-OUTPUT
     The target output stream contains any textual output from the running target.

"&" STRING-OUTPUT
     The log stream contains debugging messages being produced by GDBN's internals.

GDB/MI Out-of-band Records
--------------------------

Out-of-band records are used to notify the GDB/MI client of additional changes that have occurred.  Those changes can either be a consequence of GDB/MI (e.g., a breakpoint modified) or a result of target activity (e.g., target stopped).

The following is a preliminary list of possible out-of-band records.

"*" "stop"

GDB/MI Command Description Format
=================================

The remaining sections describe blocks of commands.  Each block of commands is laid out in a fashion similar to this section.

Note the the line breaks shown in the examples are here only for readability.  They don't appear in the real output. Also note that the commands with a non-available example (N.A.) are not yet implemented.

Motivation
----------

The motivation for this collection of commands.

Introduction
------------

A brief introduction to this collection of commands as a whole.

Commands
--------

For each command in the block, the following is described:

Synopsis
........

      -command ARGS...

GDBN Command
............

The corresponding GDBN CLI command.

Result
......

Out-of-band
...........

Notes
.....

Example
.......

GDB/MI Breakpoint table commands
================================

This section documents GDB/MI commands for manipulating breakpoints.

The -break-after Command
------------------------

Synopsis
........

      -break-after NUMBER COUNT

The breakpoint number NUMBER is not in effect until it has been hit COUNT times.  To see how this is reflected in the output of the -break-list command, see the description of the -break-list command below.

GDBN Command
............

The corresponding GDBN command is ignore.

Example
.......

     (GDBP)
     -break-insert main
     ^done,bkpt={number="1",addr="0x000100d0",file="hello.c",line="5"}
     (GDBP)
     -break-after 1 3
     ~
     ^done
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x000100d0",func="main",file="hello.c",line="5",times="0",
     ignore="3"}}
     (GDBP)

The -break-condition Command
----------------------------

Synopsis
........

      -break-condition NUMBER EXPR

Breakpoint NUMBER will stop the program only if the condition in EXPR is true.  The condition becomes part of the -break-list output (see the description of the -break-list command below).

GDBN Command
............

The corresponding GDBN command is condition.

Example
.......

     (GDBP)
     -break-condition 1 1
     ^done
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x000100d0",func="main",file="hello.c",line="5",cond="1",
     times="0",ignore="3"}}
     (GDBP)

The -break-delete Command
-------------------------

Synopsis
........

      -break-delete ( BREAKPOINT )+

Delete the breakpoint(s) whose number(s) are specified in the argument list.  This is obviously reflected in the breakpoint list.

GDBN command
............

The corresponding GDBN command is delete.

Example
.......

     (GDBP)
     -break-delete 1
     ^done
     (GDBP)
     -break-list
     ^done,BreakpointTable={}
     (GDBP)

The -break-disable Command
--------------------------

Synopsis
........

      -break-disable ( BREAKPOINT )+

Disable the named BREAKPOINT(s).  The field enabled in the break list is now set to n for the named BREAKPOINT(s).

GDBN Command
............

The corresponding GDBN command is disable.

Example
.......

     (GDBP)
     -break-disable 2
     ^done
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="2",type="breakpoint",disp="keep",enabled="n",
     addr="0x000100d0",func="main",file="hello.c",line="5",times="0"}}
     (GDBP)

The -break-enable Command
-------------------------

Synopsis
........

      -break-enable ( BREAKPOINT )+

Enable (previously disabled) BREAKPOINT(s).

GDBN Command
............

The corresponding GDBN command is enable.

Example
.......

     (GDBP)
     -break-enable 2
     ^done
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="2",type="breakpoint",disp="keep",enabled="y",
     addr="0x000100d0",func="main",file="hello.c",line="5",times="0"}}
     (GDBP)

The -break-info Command
-----------------------

Synopsis
........

      -break-info BREAKPOINT

Get information about a single breakpoint.

GDBN command
............

The corresponding GDBN command is info break BREAKPOINT.

Example
.......

N.A.

The -break-insert Command
-------------------------

Synopsis
........

      -break-insert [ -t ] [ -h ] [ -r ]
         [ -c CONDITION ] [ -i IGNORE-COUNT ]
         [ -p THREAD ] [ LINE | ADDR ]

If specified, LINE, can be one of:

  * function

  * filename:linenum

  * filename:function

  * *address

The possible optional parameters of this command are:

-t
     Insert a tempoary breakpoint.

-h
     Insert a hardware breakpoint.

-c CONDITION
     Make the breakpoint conditional on CONDITION.

-i IGNORE-COUNT
     Initialize the IGNORE-COUNT.

-r
     Insert a regular breakpoint in all the functions whose names match the given regular expression.  Other flags are not applicable to regular expresson.

Result
......

The result is in the form:

      ^done,bkptno="NUMBER",func="FUNCNAME",
       file="FILENAME",line="LINENO"

where NUMBER is the GDBN number for this breakpoint, FUNCNAME is the name of the function where the breakpoint was inserted, FILENAME is the name of the source file which contains this function, and LINENO is the source line number within that file.

Note: this format is open to change.

GDBN Command
............

The corresponding GDBN commands are break, tbreak, hbreak, thbreak, and rbreak.

Example
.......

     (GDBP)
     -break-insert main
     ^done,bkpt={number="1",addr="0x0001072c",file="recursive2.c",line="4"}
     (GDBP)
     -break-insert -t foo
     ^done,bkpt={number="2",addr="0x00010774",file="recursive2.c",line="11"}
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x0001072c", func="main",file="recursive2.c",line="4",times="0"},
     bkpt={number="2",type="breakpoint",disp="del",enabled="y",
     addr="0x00010774",func="foo",file="recursive2.c",line="11",times="0"}}
     (GDBP)
     -break-insert -r foo.*
     ~int foo(int, int);
     ^done,bkpt={number="3",addr="0x00010774",file="recursive2.c",line="11"}
     (GDBP)

The -break-list Command
-----------------------

Synopsis
........

      -break-list

Displays the list of inserted breakpoints, showing the following fields:

Number
     number of the breakpoint

Type
     type of the breakpoint: breakpoint or watchpoint

Disposition
     should the breakpoint be deleted or disabled when it is hit: keep or nokeep

Enabled
     is the breakpoint enabled or no: y or n

Address
     memory location at which the breakpoint is set

What
     logical location of the breakpoint, expressed by function name, file name, line number

Times
     number of times the breakpoint has been hit

If there are no breakpoints or watchpoints, the BreakpointTable field is an empty list.

GDBN Command
............

The corresponding GDBN command is info break.

Example
.......

     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x000100d0",func="main",file="hello.c",line="5",times="0"},
     bkpt={number="2",type="breakpoint",disp="keep",enabled="y",
     addr="0x00010114",func="foo",file="hello.c",line="13",times="0"}}
     (GDBP)

Here's an example of the result when there are no breakpoints:

     (GDBP)
     -break-list
     ^done,BreakpointTable={}
     (GDBP)

The -break-watch Command
------------------------

Synopsis
........

      -break-watch [ -a | -r ]

Create a watchpoint.  With the -a option it will create an access watchpoint, i.e. a watchpoint that triggers either on a read from or on a write to the memory location.  With the -r option, the watchpoint created is a read watchpoint, i.e. it will trigger only when the memory location is accessed for reading.  Without either of the options, the watchpoint created is a regular watchpoint, i.e. it will trigger when the memory location is accessed for writing. See Setting watchpoints.

Note that -break-list will report a single list of watchpoints and breakpoints inserted.

GDBN Command
............

The corresponding GDBN commands are watch, awatch, and rwatch.

Example
.......

Setting a watchpoint on a variable in the main function:

     (GDBP)
     -break-watch x
     ^done,wpt={number="2",exp="x"}
     (GDBP)
     -exec-continue
     ^running
     ^done,reason="watchpoint-trigger",wpt={number="2",exp="x"},
     value={old="-268439212",new="55"},
     frame={func="main",args={},file="recursive2.c",line="5"}
     (GDBP)

Setting a watchpoint on a variable local to a function.  GDBN will stop the program execution twice: first for the variable changing value, then for the watchpoint going out of scope.

     (GDBP)
     -break-watch C
     ^done,wpt={number="5",exp="C"}
     (GDBP)
     -exec-continue
     ^running
     ^done,reason="watchpoint-trigger",
     wpt={number="5",exp="C"},value={old="-276895068",new="3"},
     frame={func="callee4",args={},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="13"}
     (GDBP)
     -exec-continue
     ^running
     ^done,reason="watchpoint-scope",wpnum="5",
     frame={func="callee3",args={{name="strarg",
     value="0x11940 \"A string argument.\""}},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="18"}
     (GDBP)

Listing breakpoints and watchpoints, at different points in the program execution.  Note that once the watchpoint goes out of scope, it is deleted.

     (GDBP)
     -break-watch C
     ^done,wpt={number="2",exp="C"}
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x00010734",func="callee4",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"},
     bkpt={number="2",type="watchpoint",disp="keep",
     enabled="y",addr="",what="C",times="0"}}
     (GDBP)
     -exec-continue
     ^running
     ^done,reason="watchpoint-trigger",wpt={number="2",exp="C"},
     value={old="-276895068",new="3"},
     frame={func="callee4",args={},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="13"}
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x00010734",func="callee4",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"},
     bkpt={number="2",type="watchpoint",disp="keep",
     enabled="y",addr="",what="C",times="-5"}}
     (GDBP)
     -exec-continue
     ^running
     ^done,reason="watchpoint-scope",wpnum="2",
     frame={func="callee3",args={{name="strarg",
     value="0x11940 \"A string argument.\""}},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="18"}
     (GDBP)
     -break-list
     ^done,BreakpointTable={hdr={"Num","Type","Disp","Enb","Address","What"},
     bkpt={number="1",type="breakpoint",disp="keep",enabled="y",
     addr="0x00010734",func="callee4",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"}}
     (GDBP)

GDB/MI Data Manipulation
========================

This section describes the GDB/MI commands that manipulate data: examine memory and registers, evaluate expressions, etc.

The -data-disassemble Command
-----------------------------

Synopsis
........

      -data-disassemble
         [ -s START-ADDR -e END-ADDR ]
       | [ -f FILENAME -l LINENUM [ -n LINES ] ]
       -- MODE

Where:

START-ADDR
     is the beginning address (or $pc)

END-ADDR
     is the end address

FILENAME
     is the name of the file to disassemble

LINENUM
     is the line number to disassemble around

LINES
     is the the number of disassembly lines to be produced.  If it is -1, the whole function will be disassembled, in case no END-ADDR is specified.  If END-ADDR is specified as a non-zero value, and LINES is lower than the number of disassembly lines between START-ADDR and END-ADDR, only LINES lines are displayed; if LINES is higher than the number of lines between START-ADDR and END-ADDR, only the lines up to END-ADDR are displayed.

MODE
     is either 0 (meaning only disassembly) or 1 (meaning mixed source and disassembly).

Result
......

The output for each instruction is composed of four fields:

  * Address

  * Func-name

  * Offset

  * Instruction

Note that whatever included in the instruction field, is not manipulated directely by GDB/MI, i.e. it is not possible to adjust its format.

GDBN Command
............

There's no direct mapping from this command to the CLI.

Example
.......

Disassemble from the current value of $pc to $pc + 20:

     (GDBP)
     -data-disassemble -s $pc -e "$pc + 20" -- 0
     ^done,
     asm_insns={
     {address="0x000107c0",func-name="main",offset="4",
     inst="mov  2, %o0"},
     {address="0x000107c4",func-name="main",offset="8",
     inst="sethi  %hi(0x11800), %o2"},
     {address="0x000107c8",func-name="main",offset="12",
     inst="or  %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"},
     {address="0x000107cc",func-name="main",offset="16",
     inst="sethi  %hi(0x11800), %o2"},
     {address="0x000107d0",func-name="main",offset="20",
     inst="or  %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"}}
     (GDBP)

Disassemble the whole main function.  Line 32 is part of main.

     -data-disassemble -f basics.c -l 32 -- 0
     ^done,asm_insns={
     {address="0x000107bc",func-name="main",offset="0",
     inst="save  %sp, -112, %sp"},
     {address="0x000107c0",func-name="main",offset="4",
     inst="mov   2, %o0"},
     {address="0x000107c4",func-name="main",offset="8",
     inst="sethi %hi(0x11800), %o2"},
     [...]
     {address="0x0001081c",func-name="main",offset="96",inst="ret "},
     {address="0x00010820",func-name="main",offset="100",inst="restore "}}
     (GDBP)

Disassemble 3 instructions from the start of main:

     (GDBP)
     -data-disassemble -f basics.c -l 32 -n 3 -- 0
     ^done,asm_insns={
     {address="0x000107bc",func-name="main",offset="0",
     inst="save  %sp, -112, %sp"},
     {address="0x000107c0",func-name="main",offset="4",
     inst="mov  2, %o0"},
     {address="0x000107c4",func-name="main",offset="8",
     inst="sethi  %hi(0x11800), %o2"}}
     (GDBP)

Disassemble 3 instructions from the start of main in mixed mode:

     (GDBP)
     -data-disassemble -f basics.c -l 32 -n 3 -- 1
     ^done,asm_insns={
     src_and_asm_line={line="31",
     file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \
       testsuite/gdb.mi/basics.c",line_asm_insn={
     {address="0x000107bc",func-name="main",offset="0",
     inst="save  %sp, -112, %sp"}}},

     src_and_asm_line={line="32",
     file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \
       testsuite/gdb.mi/basics.c",line_asm_insn={
     {address="0x000107c0",func-name="main",offset="4",
     inst="mov  2, %o0"},
     {address="0x000107c4",func-name="main",offset="8",
     inst="sethi  %hi(0x11800), %o2"}}}}
     (GDBP)

The -data-evaluate-expression Command
-------------------------------------

Synopsis
........

      -data-evaluate-expression EXPR

Evaluate EXPR as an expression.  The expression could contain an inferior function call.  The function call will execute synchronously. If the expression contains spaces, it must be enclosed in double quotes.

GDBN Command
............

The corresponding GDBN commands are print, output, and call.  In gdbtk only, there's a corresponding gdb_eval command.

Example
.......

In the following example, the numbers that precede the commands are the tokens described in GDB/MI Command Syntax.  Notice how GDB/MI returns the same tokens in its output.

     211-data-evaluate-expression A
     211^done,value="1"
     (GDBP)
     311-data-evaluate-expression &A
     311^done,value="0xefffeb7c"
     (GDBP)
     411-data-evaluate-expression A+3
     411^done,value="4"
     (GDBP)
     511-data-evaluate-expression "A + 3"
     511^done,value="4"
     (GDBP)

The -data-list-changed-registers Command
----------------------------------------

Synopsis
........

      -data-list-changed-registers

Display a list of the registers that have changed.

GDBN Command
............

GDBN doesn't have a direct analog for this command; gdbtk has the corresponding command gdb_changed_register_list.

Example
.......

On a PPC MBX board:

     (GDBP)
     -exec-continue
     ^running

     (GDBP)
     *stopped,reason="breakpoint-hit",bkptno="1",frame={func="main",
     args={},file="try.c",line="5"}
     (GDBP)
     -data-list-changed-registers
     ^done,changed-registers={"0","1","2","4","5","6","7","8","9",
     "10","11","13","14","15","16","17","18","19","20","21","22","23",
     "24","25","26","27","28","30","31","64","65","66","67","69"}
     (GDBP)

The -data-list-register-names Command
-------------------------------------

Synopsis
........

      -data-list-register-names [ ( REGNO )+ ]

Show a list of register names for the current target.  If no arguments are given, it shows a list of the names of all the registers.  If integer numbers are given as arguments, it will print a list of the names of the registers corresponding to the arguments.

GDBN Command
............

GDBN does not have a command which corresponds to -data-list-register-names.  In gdbtk there is a corresponding command gdb_regnames.

Example
.......

For the PPC MBX board:

     (GDBP)
     -data-list-register-names
     ^done,register-names={"r0","r1","r2","r3","r4","r5","r6","r7",
     "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
     "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
     "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
     "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
     "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
     "pc","ps","cr","lr","ctr","xer"}
     (GDBP)
     -data-list-register-names 1 2 3
     ^done,register-names={"r1","r2","r3"}
     (GDBP)

The -data-list-register-values Command
--------------------------------------

Synopsis
........

      -data-list-register-values FMT [ ( REGNO )*]

Display the registers' contents.  FMT is the format according to which the registers' contents are to be returned, followed by an optional list of numbers specifying the registers to display.  A missing list of numbers indicates that the contents of all the registers must be returned.

Allowed formats for FMT are:

x
     Hexadecimal

o
     Octal

t
     Binary

d
     Decimal

r
     Raw

N
     Natural

GDBN Command
............

The corresponding GDBN commands are info reg, info
all-reg, and (in gdbtk) gdb_fetch_registers.

Example
.......

For a PPC MBX board (note: line breaks are for readability only, they don't appear in the actual output):

     (GDBP)
     -data-list-register-values r 64 65
     ^done,register-values={{number="64",value="0xfe00a300"},
     {number="65",value="0x00029002"}}
     (GDBP)
     -data-list-register-values x
     ^done,register-values={{number="0",value="0xfe0043c8"},
     {number="1",value="0x3fff88"},{number="2",value="0xfffffffe"},
     {number="3",value="0x0"},{number="4",value="0xa"},
     {number="5",value="0x3fff68"},{number="6",value="0x3fff58"},
     {number="7",value="0xfe011e98"},{number="8",value="0x2"},
     {number="9",value="0xfa202820"},{number="10",value="0xfa202808"},
     {number="11",value="0x1"},{number="12",value="0x0"},
     {number="13",value="0x4544"},{number="14",value="0xffdfffff"},
     {number="15",value="0xffffffff"},{number="16",value="0xfffffeff"},
     {number="17",value="0xefffffed"},{number="18",value="0xfffffffe"},
     {number="19",value="0xffffffff"},{number="20",value="0xffffffff"},
     {number="21",value="0xffffffff"},{number="22",value="0xfffffff7"},
     {number="23",value="0xffffffff"},{number="24",value="0xffffffff"},
     {number="25",value="0xffffffff"},{number="26",value="0xfffffffb"},
     {number="27",value="0xffffffff"},{number="28",value="0xf7bfffff"},
     {number="29",value="0x0"},{number="30",value="0xfe010000"},
     {number="31",value="0x0"},{number="32",value="0x0"},
     {number="33",value="0x0"},{number="34",value="0x0"},
     {number="35",value="0x0"},{number="36",value="0x0"},
     {number="37",value="0x0"},{number="38",value="0x0"},
     {number="39",value="0x0"},{number="40",value="0x0"},
     {number="41",value="0x0"},{number="42",value="0x0"},
     {number="43",value="0x0"},{number="44",value="0x0"},
     {number="45",value="0x0"},{number="46",value="0x0"},
     {number="47",value="0x0"},{number="48",value="0x0"},
     {number="49",value="0x0"},{number="50",value="0x0"},
     {number="51",value="0x0"},{number="52",value="0x0"},
     {number="53",value="0x0"},{number="54",value="0x0"},
     {number="55",value="0x0"},{number="56",value="0x0"},
     {number="57",value="0x0"},{number="58",value="0x0"},
     {number="59",value="0x0"},{number="60",value="0x0"},
     {number="61",value="0x0"},{number="62",value="0x0"},
     {number="63",value="0x0"},{number="64",value="0xfe00a300"},
     {number="65",value="0x29002"},{number="66",value="0x202f04b5"},
     {number="67",value="0xfe0043b0"},{number="68",value="0xfe00b3e4"},
     {number="69",value="0x20002b03"}}
     (GDBP)

The -data-read-memory Command
-----------------------------

Synopsis
........

      -data-read-memory [ -o BYTE-OFFSET ]
        ADDRESS WORD-FORMAT WORD-SIZE
        NR-ROWS NR-COLS [ ASCHAR ]

where:

ADDRESS
     An expression specifying the address of the first memory word to be read.  Complex expressions containing embedded white space should be quoted using the C convention.

WORD-FORMAT
     The format to be used to print the memory words.  The notation is the same as for GDBN's print command (see Output formats).

WORD-SIZE
     The size of each memory word in bytes.

NR-ROWS
     The number of rows in the output table.

NR-COLS
     The number of columns in the output table.

ASCHAR
     If present, indicates that each row should include an ASCII dump.  The value of ASCHAR is used as a padding character when a byte is not a member of the printable ASCII character set (printable ASCII characters are those whose code is between 32 and 126, inclusively).

BYTE-OFFSET
     An offset to add to the ADDRESS before fetching memory.

This command displays memory contents as a table of NR-ROWS by NR-COLS words, each word being WORD-SIZE bytes.  In total, NR-ROWS * NR-COLS * WORD-SIZE bytes are read (returned as total-bytes).  Should less then the requested number of bytes be returned by the target, the missing words are identified using N/A.  The number of bytes read from the target is returned in nr-bytes and the starting address used to read memory in addr.

The address of the next/previous row or page is available in next-row and prev-row, next-page and prev-page.

GDBN Command
............

The corresponding GDBN command is x.  gdbtk has gdb_get_mem memory read command.

Example
.......

Read six bytes of memory starting at bytes+6 but then offset by -6 bytes.  Format as three rows of two columns.  One byte per word.  Display each word in hex.

     (GDBP)
     9-data-read-memory -o -6 -- bytes+6 x 1 3 2
     9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
     next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
     prev-page="0x0000138a",memory={
     {addr="0x00001390",data={"0x00","0x01"}},
     {addr="0x00001392",data={"0x02","0x03"}},
     {addr="0x00001394",data={"0x04","0x05"}}}
     (GDBP)

Read two bytes of memory starting at address shorts + 64 and display as a single word formatted in decimal.

     (GDBP)
     5-data-read-memory shorts+64 d 2 1 1
     5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
     next-row="0x00001512",prev-row="0x0000150e",
     next-page="0x00001512",prev-page="0x0000150e",memory={
     {addr="0x00001510",data={"128"}}}
     (GDBP)

Read thirty two bytes of memory starting at bytes+16 and format as eight rows of four columns.  Include a string encoding with x used as the non-printable character.

     (GDBP)
     4-data-read-memory bytes+16 x 1 8 4 x
     4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
     next-row="0x000013c0",prev-row="0x0000139c",
     next-page="0x000013c0",prev-page="0x00001380",memory={
     {addr="0x000013a0",data={"0x10","0x11","0x12","0x13"},ascii="xxxx"},
     {addr="0x000013a4",data={"0x14","0x15","0x16","0x17"},ascii="xxxx"},
     {addr="0x000013a8",data={"0x18","0x19","0x1a","0x1b"},ascii="xxxx"},
     {addr="0x000013ac",data={"0x1c","0x1d","0x1e","0x1f"},ascii="xxxx"},
     {addr="0x000013b0",data={"0x20","0x21","0x22","0x23"},ascii=" !\"#"},
     {addr="0x000013b4",data={"0x24","0x25","0x26","0x27"},ascii="$%&'"},
     {addr="0x000013b8",data={"0x28","0x29","0x2a","0x2b"},ascii="()*+"},
     {addr="0x000013bc",data={"0x2c","0x2d","0x2e","0x2f"},ascii=",-./"}}
     (GDBP)

The -display-delete Command
---------------------------

Synopsis
........

      -display-delete NUMBER

Delete the display NUMBER.

GDBN Command
............

The corresponding GDBN command is delete display.

Example
.......

N.A.

The -display-disable Command
----------------------------

Synopsis
........

      -display-disable NUMBER

Disable display NUMBER.

GDBN Command
............

The corresponding GDBN command is disable display.

Example
.......

N.A.

The -display-enable Command
---------------------------

Synopsis
........

      -display-enable NUMBER

Enable display NUMBER.

GDBN Command
............

The corresponding GDBN command is enable display.

Example
.......

N.A.

The -display-insert Command
---------------------------

Synopsis
........

      -display-insert EXPRESSION

Display EXPRESSION every time the program stops.

GDBN Command
............

The corresponding GDBN command is display.

Example
.......

N.A.

The -display-list Command
-------------------------

Synopsis
........

      -display-list

List the displays.  Do not show the current values.

GDBN Command
............

The corresponding GDBN command is info display.

Example
.......

N.A.

The -environment-cd Command
---------------------------

Synopsis
........

      -environment-cd PATHDIR

Set GDBN's working directory.

GDBN Command
............

The corresponding GDBN command is cd.

Example
.......

     (GDBP)
     -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
     ^done
     (GDBP)

The -environment-directory Command
----------------------------------

Synopsis
........

      -environment-directory PATHDIR

Add directory PATHDIR to beginning of search path for source files.

GDBN Command
............

The corresponding GDBN command is dir.

Example
.......

     (GDBP)
     -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
     ^done
     (GDBP)

The -environment-path Command
-----------------------------

Synopsis
........

      -environment-path ( PATHDIR )+

Add directories PATHDIR to beginning of search path for object files.

GDBN Command
............

The corresponding GDBN command is path.

Example
.......

     (GDBP)
     -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb
     ^done
     (GDBP)

The -environment-pwd Command
----------------------------

Synopsis
........

      -environment-pwd

Show the current working directory.

GDBN command
............

The corresponding GDBN command is pwd.

Example
.......

     (GDBP)
     -environment-pwd
     ~Working directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb.
     ^done
     (GDBP)

GDB/MI Program control
======================

Program termination
...................

As a result of execution, the inferior program can run to completion, if it doesn't encounter any breakpoints.  In this case the output will include an exit code, if the program has exited exceptionally.

Examples
........

Program exited normally:

     (GDBP)
     -exec-run
     ^running
     (GDBP)
     x = 55
     *stopped,reason="exited-normally"
     (GDBP)

Program exited exceptionally:

     (GDBP)
     -exec-run
     ^running
     (GDBP)
     x = 55
     *stopped,reason="exited",exit-code="01"
     (GDBP)

Another way the program can terminate is if it receives a signal such as SIGINT.  In this case, GDB/MI displays this:

     (GDBP)
     *stopped,reason="exited-signalled",signal-name="SIGINT",
     signal-meaning="Interrupt"

The -exec-abort Command
-----------------------

Synopsis
........

      -exec-abort

Kill the inferior running program.

GDBN Command
............

The corresponding GDBN command is kill.

Example
.......

N.A.

The -exec-arguments Command
---------------------------

Synopsis
........

      -exec-arguments ARGS

Set the inferior program arguments, to be used in the next -exec-run.

GDBN Command
............

The corresponding GDBN command is set args.

Example
.......

Don't have one around.

The -exec-continue Command
--------------------------

Synopsis
........

      -exec-continue

Asynchronous command.  Resumes the execution of the inferior program until a breakpoint is encountered, or until the inferior exits.

GDBN Command
............

The corresponding GDBN corresponding is continue.

Example
.......

     -exec-continue
     ^running
     (GDBP)
     @Hello world
     *stopped,reason="breakpoint-hit",bkptno="2",frame={func="foo",args={},
     file="hello.c",line="13"}
     (GDBP)

The -exec-finish Command
------------------------

Synopsis
........

      -exec-finish

Asynchronous command.  Resumes the execution of the inferior program until the current function is exited.  Displays the results returned by the function.

GDBN Command
............

The corresponding GDBN command is finish.

Example
.......

Function returning void.

     -exec-finish
     ^running
     (GDBP)
     @hello from foo
     *stopped,reason="function-finished",frame={func="main",args={},
     file="hello.c",line="7"}
     (GDBP)

Function returning other than void.  The name of the internal GDBN variable storing the result is printed, together with the value itself.

     -exec-finish
     ^running
     (GDBP)
     *stopped,reason="function-finished",frame={addr="0x000107b0",func="foo",
     args={{name="a",value="1"},{name="b",value="9"}},
     file="recursive2.c",line="14"},
     gdb-result-var="$1",return-value="0"
     (GDBP)

The -exec-interrupt Command
---------------------------

Synopsis
........

      -exec-interrupt

Asynchronous command.  Interrupts the background execution of the target. Note how the token associated with the stop message is the one for the execution command that has been interrupted.  The token for the interrupt itself only appears in the ^done output.  If the user is trying to interrupt a non-running program, an error message will be printed.

GDBN Command
............

The corresponding GDBN command is interrupt.

Example
.......

     (GDBP)
     111-exec-continue
     111^running

     (GDBP)
     222-exec-interrupt
     222^done
     (GDBP)
     111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
     frame={addr="0x00010140",func="foo",args={},file="try.c",line="13"}
     (GDBP)

     (GDBP)
     -exec-interrupt
     ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
     (GDBP)

The -exec-next Command
----------------------

Synopsis
........

      -exec-next

Asynchronous command.  Resumes execution of the inferior program, stopping when the beginning of the next source line is reached.

GDBN Command
............

The corresponding GDBN command is next.

Example
.......

     -exec-next
     ^running
     (GDBP)
     *stopped,reason="end-stepping-range",line="8",file="hello.c"
     (GDBP)

The -exec-next-instruction Command
----------------------------------

Synopsis
........

      -exec-next-instruction

Asynchronous command.  Executes one machine instruction.  If the instruction is a function call continues until the function returns.  If the program stops at an instruction in the middle of a source line, the address will be printed as well.

GDBN Command
............

The corresponding GDBN command is nexti.

Example
.......

     (GDBP)
     -exec-next-instruction
     ^running

     (GDBP)
     *stopped,reason="end-stepping-range",
     addr="0x000100d4",line="5",file="hello.c"
     (GDBP)

The -exec-return Command
------------------------

Synopsis
........

      -exec-return

Makes current function return immediately.  Doesn't execute the inferior. Displays the new current frame.

GDBN Command
............

The corresponding GDBN command is return.

Example
.......

     (GDBP)
     200-break-insert callee4
     200^done,bkpt={number="1",addr="0x00010734",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"}
     (GDBP)
     000-exec-run
     000^running
     (GDBP)
     000*stopped,reason="breakpoint-hit",bkptno="1",
     frame={func="callee4",args={},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"}
     (GDBP)
     205-break-delete
     205^done
     (GDBP)
     111-exec-return
     111^done,frame={level="0 ",func="callee3",
     args={{name="strarg",
     value="0x11940 \"A string argument.\""}},
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="18"}
     (GDBP)

The -exec-run Command
---------------------

Synopsis
........

      -exec-run

Asynchronous command.  Starts execution of the inferior from the beginning.  The inferior executes until either a breakpoint is encountered or the program exits.

GDBN Command
............

The corresponding GDBN command is run.

Example
.......

     (GDBP)
     -break-insert main
     ^done,bkpt={number="1",addr="0x0001072c",file="recursive2.c",line="4"}
     (GDBP)
     -exec-run
     ^running
     (GDBP)
     *stopped,reason="breakpoint-hit",bkptno="1",
     frame={func="main",args={},file="recursive2.c",line="4"}
     (GDBP)

The -exec-show-arguments Command
--------------------------------

Synopsis
........

      -exec-show-arguments

Print the arguments of the program.

GDBN Command
............

The corresponding GDBN command is show args.

Example
.......

N.A.

The -exec-step Command
----------------------

Synopsis
........

      -exec-step

Asynchronous command.  Resumes execution of the inferior program, stopping when the beginning of the next source line is reached, if the next source line is not a function call.  If it is, stop at the first instruction of the called function.

GDBN Command
............

The corresponding GDBN command is step.

Example
.......

Stepping into a function:

     -exec-step
     ^running
     (GDBP)
     *stopped,reason="end-stepping-range",
     frame={func="foo",args={{name="a",value="10"},
     {name="b",value="0"}},file="recursive2.c",line="11"}
     (GDBP)

Regular stepping:

     -exec-step
     ^running
     (GDBP)
     *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
     (GDBP)

The -exec-step-instruction Command
----------------------------------

Synopsis
........

      -exec-step-instruction

Asynchronous command.  Resumes the inferior which executes one machine instruction.  The output, once GDBN has stopped, will vary depending on whether we have stopped in the middle of a source line or not.  In the former case, the address at which the program stopped will be printed as well.

GDBN Command
............

The corresponding GDBN command is stepi.

Example
.......

     (GDBP)
     -exec-step-instruction
     ^running

     (GDBP)
     *stopped,reason="end-stepping-range",
     frame={func="foo",args={},file="try.c",line="10"}
     (GDBP)
     -exec-step-instruction
     ^running

     (GDBP)
     *stopped,reason="end-stepping-range",
     frame={addr="0x000100f4",func="foo",args={},file="try.c",line="10"}
     (GDBP)

The -exec-until Command
-----------------------

Synopsis
........

      -exec-until [ LOCATION ]

Asynchronous command.  Executes the inferior until the LOCATION specified in the argument is reached.  If there is no argument, the inferior executes until a source line greater than the current one is reached. The reason for stopping in this case will be location-reached.

GDBN Command
............

The corresponding GDBN command is until.

Example
.......

     (GDBP)
     -exec-until recursive2.c:6
     ^running
     (GDBP)
     x = 55
     *stopped,reason="location-reached",frame={func="main",args={},
     file="recursive2.c",line="6"}
     (GDBP)

The -file-exec-and-symbols Command
----------------------------------

Synopsis
........

      -file-exec-and-symbols FILE

Specify the executable file to be debugged.  This file is the one from which the symbol table is also read.  If no file is specified, the command clears the executable and symbol information.  If breakpoints are set when using this command with no arguments, GDBN will produce error messages.  Otherwise, no output is produced, except a completion notification.

GDBN Command
............

The corresponding GDBN command is file.

Example
.......

     (GDBP)
     -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
     ^done
     (GDBP)

The -file-exec-file Command
---------------------------

Synopsis
........

      -file-exec-file FILE

Specify the executable file to be debugged.  Unlike -file-exec-and-symbols, the symbol table is not read from this file.  If used without argument, GDBN clears the information about the executable file.  No output is produced, except a completion notification.

GDBN Command
............

The corresponding GDBN command is exec-file.

Example
.......

     (GDBP)
     -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
     ^done
     (GDBP)

The -file-list-exec-sections Command
------------------------------------

Synopsis
........

      -file-list-exec-sections

List the sections of the current executable file.

GDBN Command
............

The GDBN command info file shows, among the rest, the same information as this command.  gdbtk has a corresponding command gdb_load_info.

Example
.......

N.A.

The -file-list-exec-source-files Command
----------------------------------------

Synopsis
........

      -file-list-exec-source-files

List the source files for the current executable.

GDBN Command
............

There's no GDBN command which directly corresponds to this one. gdbtk has an analogous command gdb_listfiles.

Example
.......

N.A.

The -file-list-shared-libraries Command
---------------------------------------

Synopsis
........

      -file-list-shared-libraries

List the shared libraries in the program.

GDBN Command
............

The corresponding GDBN command is info shared.

Example
.......

N.A.

The -file-list-symbol-files Command
-----------------------------------

Synopsis
........

      -file-list-symbol-files

List symbol files.

GDBN Command
............

The corresponding GDBN command is info file (part of it).

Example
.......

N.A.

The -file-symbol-file Command
-----------------------------

Synopsis
........

      -file-symbol-file FILE

Read symbol table info from the specified FILE argument.  When used without arguments, clears GDBN's symbol table info.  No output is produced, except for a completion notification.

GDBN Command
............

The corresponding GDBN command is symbol-file.

Example
.......

     (GDBP)
     -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
     ^done
     (GDBP)

Miscellaneous GDBN commands in GDB/MI
=====================================

The -gdb-exit Command
---------------------

Synopsis
........

      -gdb-exit

Exit GDBN immediately.

GDBN Command
............

Approximately corresponds to quit.

Example
.......

     (GDBP)
     -gdb-exit

The -gdb-set Command
--------------------

Synopsis
........

      -gdb-set

Set an internal GDBN variable.

GDBN Command
............

The corresponding GDBN command is set.

Example
.......

     (GDBP)
     -gdb-set $foo=3
     ^done
     (GDBP)

The -gdb-show Command
---------------------

Synopsis
........

      -gdb-show

Show the current value of a GDBN variable.

GDBN command
............

The corresponding GDBN command is show.

Example
.......

     (GDBP)
     -gdb-show annotate
     ^done,value="0"
     (GDBP)

The -gdb-version Command
------------------------

Synopsis
........

      -gdb-version

Show version information for GDBN.  Used mostly in testing.

GDBN Command
............

There's no equivalent GDBN command.  GDBN by default shows this information when you start an interactive session.

Example
.......

     (GDBP)
     -gdb-version
     ~GNU gdb 5.2.1
     ~Copyright 2000 Free Software Foundation, Inc.
     ~GDB is free software, covered by the GNU General Public License, and
     ~you are welcome to change it and/or distribute copies of it under
     ~ certain conditions.
     ~Type "show copying" to see the conditions.
     ~There is absolutely no warranty for GDB.  Type "show warranty" for
     ~ details.
     ~This GDB was configured as
      "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
     ^done
     (GDBP)

Stack manipulation commands in GDB/MI
=====================================

The -stack-info-frame Command
-----------------------------

Synopsis
........

      -stack-info-frame

Get info on the current frame.

GDBN Command
............

The corresponding GDBN command is info frame or frame (without arguments).

Example
.......

N.A.

The -stack-info-depth Command
-----------------------------

Synopsis
........

      -stack-info-depth [ MAX-DEPTH ]

Return the depth of the stack.  If the integer argument MAX-DEPTH is specified, do not count beyond MAX-DEPTH frames.

GDBN Command
............

There's no equivalent GDBN command.

Example
.......

For a stack with frame levels 0 through 11:

     (GDBP)
     -stack-info-depth
     ^done,depth="12"
     (GDBP)
     -stack-info-depth 4
     ^done,depth="4"
     (GDBP)
     -stack-info-depth 12
     ^done,depth="12"
     (GDBP)
     -stack-info-depth 11
     ^done,depth="11"
     (GDBP)
     -stack-info-depth 13
     ^done,depth="12"
     (GDBP)

The -stack-list-arguments Command
---------------------------------

Synopsis
........

      -stack-list-arguments SHOW-VALUES
         [ LOW-FRAME HIGH-FRAME ]

Display a list of the arguments for the frames between LOW-FRAME and HIGH-FRAME (inclusive).  If LOW-FRAME and HIGH-FRAME are not provided, list the arguments for the whole call stack.

The SHOW-VALUES argument must have a value of 0 or 1.  A value of 0 means that only the names of the arguments are listed, a value of 1 means that both names and values of the arguments are printed.

GDBN Command
............

GDBN does not have an equivalent command.  gdbtk has a gdb_get_args command which partially overlaps with the functionality of -stack-list-arguments.

Example
.......

     (GDBP)
     -stack-list-frames
     ^done,
     stack={
     frame={level="0 ",addr="0x00010734",func="callee4",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"},
     frame={level="1 ",addr="0x0001076c",func="callee3",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="17"},
     frame={level="2 ",addr="0x0001078c",func="callee2",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="22"},
     frame={level="3 ",addr="0x000107b4",func="callee1",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="27"},
     frame={level="4 ",addr="0x000107e0",func="main",
     file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="32"}}
     (GDBP)
     -stack-list-arguments 0
     ^done,
     stack-args={
     frame={level="0",args={}},
     frame={level="1",args={name="strarg"}},
     frame={level="2",args={name="intarg",name="strarg"}},
     frame={level="3",args={name="intarg",name="strarg",name="fltarg"}},
     frame={level="4",args={}}}
     (GDBP)
     -stack-list-arguments 1
     ^done,
     stack-args={
     frame={level="0",args={}},
     frame={level="1",
      args={{name="strarg",value="0x11940 \"A string argument.\""}}},
     frame={level="2",args={
     {name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""}}},
     {frame={level="3",args={
     {name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""},
     {name="fltarg",value="3.5"}}},
     frame={level="4",args={}}}
     (GDBP)
     -stack-list-arguments 0 2 2
     ^done,stack-args={frame={level="2",args={name="intarg",name="strarg"}}}
     (GDBP)
     -stack-list-arguments 1 2 2
     ^done,stack-args={frame={level="2",
     args={{name="intarg",value="2"},
     {name="strarg",value="0x11940 \"A string argument.\""}}}}
     (GDBP)

The -stack-list-frames Command
------------------------------

Synopsis
........

      -stack-list-frames [ LOW-FRAME HIGH-FRAME ]

List the frames currently on the stack.  For each frame it displays the following info:

LEVEL
     The frame number, 0 being the topmost frame, i.e. the innermost function.

ADDR
     The $pc value for that frame.

FUNC
     Function name.

FILE
     File name of the source file where the function lives.

LINE
     Line number corresponding to the $pc.

If invoked without arguments, this command prints a backtrace for the whole stack.  If given two integer arguments, it shows the frames whose levels are between the two arguments (inclusive).  If the two arguments are equal, it shows the single frame at the corresponding level.

GDBN Command
............

The corresponding GDBN commands are backtrace and where.

Example
.......

Full stack backtrace:

     (GDBP)
     -stack-list-frames
     ^done,stack=
     {frame={level="0 ",addr="0x0001076c",func="foo",
       file="recursive2.c",line="11"},
     frame={level="1 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="2 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="4 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="5 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="6 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="7 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="8 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="9 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="10",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="11",addr="0x00010738",func="main",
       file="recursive2.c",line="4"}}
     (GDBP)

Show frames between LOW_FRAME and HIGH_FRAME:

     (GDBP)
     -stack-list-frames 3 5
     ^done,stack=
     {frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="4 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"},
     frame={level="5 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"}}
     (GDBP)

Show a single frame:

     (GDBP)
     -stack-list-frames 3 3
     ^done,stack=
     {frame={level="3 ",addr="0x000107a4",func="foo",
       file="recursive2.c",line="14"}}
     (GDBP)

The -stack-list-locals Command
------------------------------

Synopsis
........

      -stack-list-locals PRINT-VALUES

Display the local variable names for the current frame.  With an argument of 0 prints only the names of the variables, with argument of 1 prints also their values.

GDBN Command
............

info locals in GDBN, gdb_get_locals in gdbtk.

Example
.......

     (GDBP)
     -stack-list-locals 0
     ^done,locals={name="A",name="B",name="C"}
     (GDBP)
     -stack-list-locals 1
     ^done,locals={{name="A",value="1"},{name="B",value="2"},
       {name="C",value="3"}}
     (GDBP)

The -stack-select-frame Command
-------------------------------

Synopsis
........

      -stack-select-frame FRAMENUM

Change the current frame.  Select a different frame FRAMENUM on the stack.

GDBN Command
............

The corresponding GDBN commands are frame, up, down, select-frame, up-silent, and down-silent.

Example
.......

     (GDBP)
     -stack-select-frame 2
     ^done
     (GDBP)

GDB/MI Symbol Query Commands
============================

The -symbol-info-address Command
--------------------------------

Synopsis
........

      -symbol-info-address SYMBOL

Describe where SYMBOL is stored.

GDBN Command
............

The corresponding GDBN command is info address.

Example
.......

N.A.

The -symbol-info-file Command
-----------------------------

Synopsis
........

      -symbol-info-file

Show the file for the symbol.

GDBN Command
............

There's no equivalent GDBN command.  gdbtk has gdb_find_file.

Example
.......

N.A.

The -symbol-info-function Command
---------------------------------

Synopsis
........

      -symbol-info-function

Show which function the symbol lives in.

GDBN Command
............

gdb_get_function in gdbtk.

Example
.......

N.A.

The -symbol-info-line Command
-----------------------------

Synopsis
........

      -symbol-info-line

Show the core addresses of the code for a source line.

GDBN Command
............

The corresponding GDBN comamnd is info line. gdbtk has the gdb_get_line and gdb_get_file commands.

Example
.......

N.A.

The -symbol-info-symbol Command
-------------------------------

Synopsis
........

      -symbol-info-symbol ADDR

Describe what symbol is at location ADDR.

GDBN Command
............

The corresponding GDBN command is info symbol.

Example
.......

N.A.

The -symbol-list-functions Command
----------------------------------

Synopsis
........

      -symbol-list-functions

List the functions in the executable.

GDBN Command
............

info functions in GDBN, gdb_listfunc and gdb_search in gdbtk.

Example
.......

N.A.

The -symbol-list-types Command
------------------------------

Synopsis
........

      -symbol-list-types

List all the type names.

GDBN Command
............

The corresponding commands are info types in GDBN, gdb_search in gdbtk.

Example
.......

N.A.

The -symbol-list-variables Command
----------------------------------

Synopsis
........

      -symbol-list-variables

List all the global and static variable names.

GDBN Command
............

info variables in GDBN, gdb_search in gdbtk.

Example
.......

N.A.

The -symbol-locate Command
--------------------------

Synopsis
........

      -symbol-locate

GDBN Command
............

gdb_loc in gdbtk.

Example
.......

N.A.

The -symbol-type Command
------------------------

Synopsis
........

      -symbol-type VARIABLE

Show type of VARIABLE.

GDBN Command
............

The corresponding GDBN command is ptype, gdbtk has gdb_obj_variable.

Example
.......

N.A.

GDB/MI Target Manipulation Commands
===================================

The -target-attach Command
--------------------------

Synopsis
........

      -target-attach PID | FILE

Attach to a process PID or a file FILE outside of GDBN.

GDBN command
............

The corresponding GDBN command is attach.

Example
.......

N.A.

The -target-compare-sections Command
------------------------------------

Synopsis
........

      -target-compare-sections [ SECTION ]

Compare data of section SECTION on target to the exec file. Without the argument, all sections are compared.

GDBN Command
............

The GDBN equivalent is compare-sections.

Example
.......

N.A.

The -target-detach Command
--------------------------

Synopsis
........

      -target-detach

Disconnect from the remote target.  There's no output.

GDBN command
............

The corresponding GDBN command is detach.

Example
.......

     (GDBP)
     -target-detach
     ^done
     (GDBP)

The -target-download Command
----------------------------

Synopsis
........

      -target-download

Loads the executable onto the remote target. It prints out an update message every half second, which includes the fields:

section
     The name of the section.

section-sent
     The size of what has been sent so far for that section.

section-size
     The size of the section.

total-sent
     The total size of what was sent so far (the current and the previous sections).

total-size
     The size of the overall executable to download.

Each message is sent as status record (see GDB/MI Output Syntax).

In addition, it prints the name and size of the sections, as they are downloaded.  These messages include the following fields:

section
     The name of the section.

section-size
     The size of the section.

total-size
     The size of the overall executable to download.

At the end, a summary is printed.

GDBN Command
............

The corresponding GDBN command is load.

Example
.......

Note: each status message appears on a single line.  Here the messages have been broken down so that they can fit onto a page.

     (GDBP)
     -target-download
     +download,{section=".text",section-size="6668",total-size="9880"}
     +download,{section=".text",section-sent="512",section-size="6668",
     total-sent="512",total-size="9880"}
     +download,{section=".text",section-sent="1024",section-size="6668",
     total-sent="1024",total-size="9880"}
     +download,{section=".text",section-sent="1536",section-size="6668",
     total-sent="1536",total-size="9880"}
     +download,{section=".text",section-sent="2048",section-size="6668",
     total-sent="2048",total-size="9880"}
     +download,{section=".text",section-sent="2560",section-size="6668",
     total-sent="2560",total-size="9880"}
     +download,{section=".text",section-sent="3072",section-size="6668",
     total-sent="3072",total-size="9880"}
     +download,{section=".text",section-sent="3584",section-size="6668",
     total-sent="3584",total-size="9880"}
     +download,{section=".text",section-sent="4096",section-size="6668",
     total-sent="4096",total-size="9880"}
     +download,{section=".text",section-sent="4608",section-size="6668",
     total-sent="4608",total-size="9880"}
     +download,{section=".text",section-sent="5120",section-size="6668",
     total-sent="5120",total-size="9880"}
     +download,{section=".text",section-sent="5632",section-size="6668",
     total-sent="5632",total-size="9880"}
     +download,{section=".text",section-sent="6144",section-size="6668",
     total-sent="6144",total-size="9880"}
     +download,{section=".text",section-sent="6656",section-size="6668",
     total-sent="6656",total-size="9880"}
     +download,{section=".init",section-size="28",total-size="9880"}
     +download,{section=".fini",section-size="28",total-size="9880"}
     +download,{section=".data",section-size="3156",total-size="9880"}
     +download,{section=".data",section-sent="512",section-size="3156",
     total-sent="7236",total-size="9880"}
     +download,{section=".data",section-sent="1024",section-size="3156",
     total-sent="7748",total-size="9880"}
     +download,{section=".data",section-sent="1536",section-size="3156",
     total-sent="8260",total-size="9880"}
     +download,{section=".data",section-sent="2048",section-size="3156",
     total-sent="8772",total-size="9880"}
     +download,{section=".data",section-sent="2560",section-size="3156",
     total-sent="9284",total-size="9880"}
     +download,{section=".data",section-sent="3072",section-size="3156",
     total-sent="9796",total-size="9880"}
     ^done,address="0x10004",load-size="9880",transfer-rate="6586",
     write-rate="429"
     (GDBP)

The -target-exec-status Command
-------------------------------

Synopsis
........

      -target-exec-status

Provide information on the state of the target (whether it is running or not, for instance).

GDBN Command
............

There's no equivalent GDBN command.

Example
.......

N.A.

The -target-list-available-targets Command
------------------------------------------

Synopsis
........

      -target-list-available-targets

List the possible targets to connect to.

GDBN Command
............

The corresponding GDBN command is help target.

Example
.......

N.A.

The -target-list-current-targets Command
----------------------------------------

Synopsis
........

      -target-list-current-targets

Describe the current target.

GDBN Command
............

The corresponding information is printed by info file (among other things).

Example
.......

N.A.

The -target-list-parameters Command
-----------------------------------

Synopsis
........

      -target-list-parameters

GDBN Command
............

No equivalent.

Example
.......

N.A.

The -target-select Command
--------------------------

Synopsis
........

      -target-select TYPE PARAMETERS ...

Connect GDBN to the remote target.  This command takes two args:

TYPE
     The type of target, for instance async, remote, etc.

PARAMETERS
     Device names, host names and the like.  See Commands for managing targets, for more details.

The output is a connection notification, followed by the address at which the target program is, in the following form:

     ^connected,addr="ADDRESS",func="FUNCTION NAME",
       args={ARG LIST}

GDBN Command
............

The corresponding GDBN command is target.

Example
.......

     (GDBP)
     -target-select async /dev/ttya
     ^connected,addr="0xfe00a300",func="??",args={}
     (GDBP)

GDB/MI Thread Commands
======================

The -thread-info Command
------------------------

Synopsis
........

      -thread-info

GDBN command
............

No equivalent.

Example
.......

N.A.

The -thread-list-all-threads Command
------------------------------------

Synopsis
........

      -thread-list-all-threads

GDBN Command
............

The equivalent GDBN command is info threads.

Example
.......

N.A.

The -thread-list-ids Command
----------------------------

Synopsis
........

      -thread-list-ids

Produces a list of the currently known GDBN thread ids.  At the end of the list it also prints the total number of such threads.

GDBN Command
............

Part of info threads supplies the same information.

Example
.......

No threads present, besides the main process:

     (GDBP)
     -thread-list-ids
     ^done,thread-ids={},number-of-threads="0"
     (GDBP)

Several threads:

     (GDBP)
     -thread-list-ids
     ^done,thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     number-of-threads="3"
     (GDBP)

The -thread-select Command
--------------------------

Synopsis
........

      -thread-select THREADNUM

Make THREADNUM the current thread.  It prints the number of the new current thread, and the topmost frame for that thread.

GDBN Command
............

The corresponding GDBN command is thread.

Example
.......

     (GDBP)
     -exec-next
     ^running
     (GDBP)
     *stopped,reason="end-stepping-range",thread-id="2",line="187",
     file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
     (GDBP)
     -thread-list-ids
     ^done,
     thread-ids={thread-id="3",thread-id="2",thread-id="1"},
     number-of-threads="3"
     (GDBP)
     -thread-select 3
     ^done,new-thread-id="3",
     frame={level="0 ",func="vprintf",
     args={{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""},
     {name="arg",value="0x2"}},file="vprintf.c",line="31"}
     (GDBP)

GDB/MI Tracepoint Commands
==========================

The tracepoint commands are not yet implemented.

GDB/MI Variable Objects
=======================

Motivation for Variable Objects in GDB/MI
-----------------------------------------

For the implementation of a variable debugger window (locals, watched expressions, etc.), we are proposing the adaptation of the existing code used by Insight.

The two main reasons for that are:

 1. It has been proven in practice (it is already on its second generation).

 2. It will shorten development time (needless to say how important it is now).

The original interface was designed to be used by Tcl code, so it was slightly changed so it could be used through GDB/MI.  This section describes the GDB/MI operations that will be available and gives some hints about their use.

Note: In addition to the set of operations described here, we expect the GUI implementation of a variable window to require, at least, the following operations:

  * -gdb-show output-radix

  * -stack-list-arguments

  * -stack-list-locals

  * -stack-select-frame

Introduction to Variable Objects in GDB/MI
------------------------------------------

The basic idea behind variable objects is the creation of a named object to represent a variable, an expression, a memory location or even a CPU register.  For each object created, a set of operations is available for examining or changing its properties.

Furthermore, complex data types, such as C structures, are represented in a tree format.  For instance, the struct type variable is the root and the children will represent the struct members.  If a child is itself of a complex type, it will also have children of its own. Appropriate language differences are handled for C, C++ and Java.

When returning the actual values of the objects, this facility allows for the individual selection of the display format used in the result creation.  It can be chosen among: binary, decimal, hexadecimal, octal and natural.  Natural refers to a default format automatically chosen based on the variable type (like decimal for an int, hex for pointers, etc.).

The following is the complete set of GDB/MI operations defined to access this functionality:

Operation
Description

-var-create
create a variable object
-var-delete
delete the variable object and its children
-var-set-format
set the display format of this variable
-var-show-format
show the display format of this variable
-var-info-num-children
tells how many children this object has
-var-list-children
return a list of the object's children
-var-info-type
show the type of this variable object
-var-info-expression
print what this variable object represents
-var-show-attributes
is this variable editable? does it exist here?
-var-evaluate-expression
get the value of this variable
-var-assign
set the value of this variable
-var-update
update the variable and its children

In the next subsection we describe each operation in detail and suggest how it can be used.

Description And Use of Operations on Variable Objects
-----------------------------------------------------

The -var-create Command
-----------------------

Synopsis
........

      -var-create {NAME | "-"}
         {FRAME-ADDR | "*"} EXPRESSION

This operation creates a variable object, which allows the monitoring of a variable, the result of an expression, a memory cell or a CPU register.

The NAME parameter is the string by which the object can be referenced.  It must be unique.  If - is specified, the varobj system will generate a string ``varNNNNNN'' automatically.  It will be unique provided that one does not specify NAME on that format. The command fails if a duplicate name is found.

The frame under which the expression should be evaluated can be specified by FRAME-ADDR.  A * indicates that the current frame should be used.

EXPRESSION is any expression valid on the current language set (must not begin with a *), or one of the following:

  * *ADDR, where ADDR is the address of a memory cell

  * *ADDR-ADDR --- a memory address range (TBD)

  * $REGNAME --- a CPU register name

Result
......

This operation returns the name, number of children and the type of the object created.  Type is returned as a string as the ones generated by the GDBN CLI:

      name="NAME",numchild="N",type="TYPE"

The -var-delete Command
-----------------------

Synopsis
........

      -var-delete NAME

Deletes a previously created variable object and all of its children.

Returns an error if the object NAME is not found.

The -var-set-format Command
---------------------------

Synopsis
........

      -var-set-format NAME FORMAT-SPEC

Sets the output format for the value of the object NAME to be FORMAT-SPEC.

The syntax for the FORMAT-SPEC is as follows:

      FORMAT-SPEC ==>
      {binary | decimal | hexadecimal | octal | natural}

The -var-show-format Command
----------------------------

Synopsis
........

      -var-show-format NAME

Returns the format used to display the value of the object NAME.

      FORMAT ==>
      FORMAT-SPEC

The -var-info-num-children Command
----------------------------------

Synopsis
........

      -var-info-num-children NAME

Returns the number of children of a variable object NAME:

      numchild=N

The -var-list-children Command
------------------------------

Synopsis
........

      -var-list-children NAME

Returns a list of the children of the specified variable object:

      numchild=N,children={{name=NAME,
      numchild=N,type=TYPE},(repeats N times)}

The -var-info-type Command
--------------------------

Synopsis
........

      -var-info-type NAME

Returns the type of the specified variable NAME.  The type is returned as a string in the same format as it is output by the GDBN CLI:

      type=TYPENAME

The -var-info-expression Command
--------------------------------

Synopsis
........

      -var-info-expression NAME

Returns what is represented by the variable object NAME:

      lang=LANG-SPEC,exp=EXPRESSION

where LANG-SPEC is {"C" | "C++" | "Java"}.

The -var-show-attributes Command
--------------------------------

Synopsis
........

      -var-show-attributes NAME

List attributes of the specified variable object NAME:

      status=ATTR [ ( ,ATTR )* ]

where ATTR is { { editable | noneditable } | TBD }.

The -var-evaluate-expression Command
------------------------------------

Synopsis
........

      -var-evaluate-expression NAME

Evaluates the expression that is represented by the specified variable object and returns its value as a string in the current format specified for the object:

      value=VALUE

The -var-assign Command
-----------------------

Synopsis
........

      -var-assign NAME EXPRESSION

Assigns the value of EXPRESSION to the variable object specified by NAME.  The object must be editable.

The -var-update Command
-----------------------

Synopsis
........

      -var-update {NAME | "*"}

Update the value of the variable object NAME by evaluating its expression after fetching all the new values from memory or registers. A * causes all existing variable objects to be updated.

GDB/MI Draft Changes to Output Syntax
=====================================

One problem identified in the existing GDB/MI output syntax was the difficulty in differentiating between a tuple such as:

     {number="1",type="breakpoint",disp="keep",enabled="y"}

where each value has a unique label, and a list such as:

     {"1","2","4"}
     {bp="1",bp="2",bp="4"}

where values are un-labeled or the label is duplicated.

What follows is a draft revision to the output specification that addresses this problem.

The output from GDB/MI consists of zero or more out-of-band records optionally followed by a single result record, the result record being for the most recent command input.  The sequence is terminated by (GDBP).

Asynchronous GDB/MI output is similar.

Each output record directly associated with an input command is prefixed by the input command's TOKEN.

OUTPUT ==>
     { OUT-OF-BAND-RECORD } [ RESULT-RECORD ] "(GDBP)" NL

RESULT-RECORD ==>
     [ TOKEN ] "^" RESULT-CLASS { "," RESULT } NL

OUT-OF-BAND-RECORD ==>
     ASYNC-RECORD | STREAM-RECORD

ASYNC-RECORD ==>
     EXEC-ASYNC-OUTPUT | STATUS-ASYNC-OUTPUT | NOTIFY-ASYNC-OUTPUT

EXEC-ASYNC-OUTPUT ==>
     [ TOKEN ] "*" ASYNC-OUTPUT

STATUS-ASYNC-OUTPUT ==>
     [ TOKEN ] "+" ASYNC-OUTPUT

NOTIFY-ASYNC-OUTPUT ==>
     [ TOKEN ] "=" ASYNC-OUTPUT

ASYNC-OUTPUT ==>
     ASYNC-CLASS { "," RESULT } NL

RESULT-CLASS ==>
     "done" | "running" | "connected" | "error" | "exit"

ASYNC-CLASS ==>
     "stopped" | others depending on need as still in development

RESULT ==>
     STRING "=" VALUE

VALUE ==>
     C-STRING | TUPPLE | LIST

TUPPLE ==>
     "{}" | "{" RESULT { "," RESULT } "}"

LIST ==>
     "[]" | "[" VALUE { "," VALUE } "]"

STRING ==>
     [-A-Za-z\.0-9_]*

C-STRING ==>
     See the input specification

STREAM-RECORD ==>
     CONSOLE-STREAM-OUTPUT | TARGET-STREAM-OUTPUT | LOG-STREAM-OUTPUT

CONSOLE-STREAM-OUTPUT ==>
     "~" C-STRING

TARGET-STREAM-OUTPUT ==>
     "@" C-STRING

LOG-STREAM-OUTPUT ==>
     "&" C-STRING

NL ==>
     CR | CR-LF

TOKEN ==>
     "any sequence of digits"

In addition, the following are still being developed.

QUERY
     This action is currently undefined.

Notes:

  * All output sequences end in a single line containing a period.

  * The TOKEN is from the corresponding request.  If an execution command is interrupted by the -exec-interrupt command, the token associated with the `*stopped' message is the one of the original execution command, not the one of the interrupt command.

  * STATUS-ASYNC-OUTPUT contains on-going status information about the progress of a slow operation.  It can be discarded.  All status output is prefixed by the prefix +.

  * EXEC-ASYNC-OUTPUT contains asynchronous state change on the target (stopped, started, disappeared).  All async output is prefixed by the prefix *.

  * NOTIFY-ASYNC-OUTPUT contains supplementary information that the client should handle (new breakpoint information).  All notify output is prefixed by the prefix =.

  * CONSOLE-STREAM-OUTPUT is output that should be displayed as is, in the console.  It is the textual response to a CLI command.  All the console output is prefixed by the prefix ~.

  * TARGET-STREAM-OUTPUT is the output produced by the target program. All the target output is prefixed by the prefix @.

  * LOG-STREAM-OUTPUT is output text coming from GDBN's internals, for instance messages that should be displayed as part of an error log.  All the log output is prefixed by the prefix &.