Subversion Repositories or1k

@c  \input texinfo   @c -*-texinfo-*-

@c  \input texinfo   @c -*-texinfo-*-

@c  @c %**start of header

@c  @c %**start of header

@c  @setfilename gdbmi.info

@c  @setfilename gdbmi.info

@c  @settitle GDB/MI Machine Interface

@c  @settitle GDB/MI Machine Interface

@c  @setchapternewpage off

@c  @setchapternewpage off

@c  @c %**end of header

@c  @c %**end of header

@c  @ifinfo

@c  @ifinfo

@c  This file documents GDB/MI, a Machine Interface to GDB.

@c  This file documents GDB/MI, a Machine Interface to GDB.

@c  Copyright (C) 2000, Free Software Foundation, Inc.

@c  Copyright (C) 2000, Free Software Foundation, Inc.

@c  Contributed by Cygnus Solutions.

@c  Contributed by Cygnus Solutions.

@c  Permission is granted to make and distribute verbatim copies of this

@c  Permission is granted to make and distribute verbatim copies of this

@c  manual provided the copyright notice and this permission notice are

@c  manual provided the copyright notice and this permission notice are

@c  preserved on all copies.

@c  preserved on all copies.

@c  @ignore

@c  @ignore

@c  Permission is granted to process this file through TeX and print the

@c  Permission is granted to process this file through TeX and print the

@c  results, provided the printed document carries copying permission notice

@c  results, provided the printed document carries copying permission notice

@c  identical to this one except for the removal of this paragraph (this

@c  identical to this one except for the removal of this paragraph (this

@c  paragraph not being relevant to the printed manual).

@c  paragraph not being relevant to the printed manual).

@c  @end ignore

@c  @end ignore

@c  Permission is granted to copy and distribute modified versions of this

@c  Permission is granted to copy and distribute modified versions of this

@c  manual under the conditions for verbatim copying, provided also that the

@c  manual under the conditions for verbatim copying, provided also that the

@c  entire resulting derived work is distributed under the terms of a

@c  entire resulting derived work is distributed under the terms of a

@c  permission notice identical to this one.

@c  permission notice identical to this one.

@c  Permission is granted to copy and distribute translations of this manual

@c  Permission is granted to copy and distribute translations of this manual

@c  into another language, under the above conditions for modified versions.

@c  into another language, under the above conditions for modified versions.

@c  @end ifinfo

@c  @end ifinfo

@c  @c  This title page illustrates only one of the

@c  @c  This title page illustrates only one of the

@c  @c  two methods of forming a title page.

@c  @c  two methods of forming a title page.

@c  @titlepage

@c  @titlepage

@c  @title GDB/MI

@c  @title GDB/MI

@c  @subtitle Version 0.2

@c  @subtitle Version 0.2

@c  @subtitle Feb 2000

@c  @subtitle Feb 2000

@c  @author Andrew Cagney, Fernando Nasser and Elena Zannoni

@c  @author Andrew Cagney, Fernando Nasser and Elena Zannoni

@c  @c  The following two commands

@c  @c  The following two commands

@c  @c  start the copyright page.

@c  @c  start the copyright page.

@c  @page

@c  @page

@c  @vskip 0pt plus 1filll

@c  @vskip 0pt plus 1filll

@c  Permission is granted to make and distribute verbatim copies of this

@c  Permission is granted to make and distribute verbatim copies of this

@c  manual provided the copyright notice and this permission notice are

@c  manual provided the copyright notice and this permission notice are

@c  preserved on all copies.

@c  preserved on all copies.

@c  Copyright @copyright{} 2000, Free Software Foundation, Inc.

@c  Copyright @copyright{} 2000, Free Software Foundation, Inc.

@c  @end titlepage

@c  @end titlepage

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% CHAPTER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% CHAPTER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI

@node GDB/MI

@chapter The @sc{gdb/mi} Interface

@chapter The @sc{gdb/mi} Interface

@unnumberedsec Function and Purpose

@unnumberedsec Function and Purpose

@cindex @sc{gdb/mi}, its purpose

@cindex @sc{gdb/mi}, its purpose

@sc{gdb/mi} is a line based machine oriented text interface to GDB.  It is

@sc{gdb/mi} is a line based machine oriented text interface to GDB.  It is

specifically intended to support the development of systems which use

specifically intended to support the development of systems which use

the debugger as just one small component of a larger system.

the debugger as just one small component of a larger system.

This chapter is a specification of the @sc{gdb/mi} interface.  It is written

This chapter is a specification of the @sc{gdb/mi} interface.  It is written

in the form of a reference manual.

in the form of a reference manual.

Note that @sc{gdb/mi} is still under construction, so some of the

Note that @sc{gdb/mi} is still under construction, so some of the

features described below are incomplete and subject to change.

features described below are incomplete and subject to change.

@unnumberedsec Notation and Terminology

@unnumberedsec Notation and Terminology

@cindex notational conventions, for @sc{gdb/mi}

@cindex notational conventions, for @sc{gdb/mi}

This chapter uses the following notation:

This chapter uses the following notation:

@itemize @bullet

@itemize @bullet

@item

@item

@code{|} separates two alternatives.

@code{|} separates two alternatives.

@item

@item

@code{[ @var{something} ]} indicates that @var{something} is optional:

@code{[ @var{something} ]} indicates that @var{something} is optional:

it may or may not be given.

it may or may not be given.

@item

@item

@code{( @var{group} )*} means that @var{group} inside the parentheses

@code{( @var{group} )*} means that @var{group} inside the parentheses

may repeat zero or more times.

may repeat zero or more times.

@item

@item

@code{( @var{group} )+} means that @var{group} inside the parentheses

@code{( @var{group} )+} means that @var{group} inside the parentheses

may repeat one or more times.

may repeat one or more times.

@item

@item

@code{"@var{string}"} means a literal @var{string}.

@code{"@var{string}"} means a literal @var{string}.

@end itemize

@end itemize

@ignore

@ignore

@heading Dependencies

@heading Dependencies

@end ignore

@end ignore

@heading Acknowledgments

@heading Acknowledgments

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

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

Elena Zannoni.

Elena Zannoni.

@menu

@menu

* GDB/MI Command Syntax::

* GDB/MI Command Syntax::

* GDB/MI Compatibility with CLI::

* GDB/MI Compatibility with CLI::

* GDB/MI Output Records::

* GDB/MI Output Records::

* GDB/MI Command Description Format::

* GDB/MI Command Description Format::

* GDB/MI Breakpoint Table Commands::

* GDB/MI Breakpoint Table Commands::

* GDB/MI Data Manipulation::

* GDB/MI Data Manipulation::

* GDB/MI Program Control::

* GDB/MI Program Control::

* GDB/MI Miscellaneous Commands::

* GDB/MI Miscellaneous Commands::

* GDB/MI Stack Manipulation::

* GDB/MI Stack Manipulation::

* GDB/MI Symbol Query::

* GDB/MI Symbol Query::

* GDB/MI Target Manipulation::

* GDB/MI Target Manipulation::

* GDB/MI Thread Commands::

* GDB/MI Thread Commands::

* GDB/MI Tracepoint Commands::

* GDB/MI Tracepoint Commands::

* GDB/MI Variable Objects::

* GDB/MI Variable Objects::

* GDB/MI Draft Changes to Output Syntax::

* GDB/MI Draft Changes to Output Syntax::

@end menu

@end menu

@c When these are implemented, they should be moved to be between Misc and

@c When these are implemented, they should be moved to be between Misc and

@c Stack Manipulation in the above menu.  They are now outside the menu

@c Stack Manipulation in the above menu.  They are now outside the menu

@c because makeinfo 3.12 barfs if it sees @ignore or @comments in the

@c because makeinfo 3.12 barfs if it sees @ignore or @comments in the

@c middle of a menu.

@c middle of a menu.

@ignore

@ignore

* GDB/MI Kod Commands::

* GDB/MI Kod Commands::

* GDB/MI Memory Overlay Commands::

* GDB/MI Memory Overlay Commands::

* GDB/MI Signal Handling Commands::

* GDB/MI Signal Handling Commands::

@end ignore

@end ignore

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI Command Syntax

@node GDB/MI Command Syntax

@section @sc{gdb/mi} Command Syntax

@section @sc{gdb/mi} Command Syntax

@menu

@menu

* GDB/MI Input Syntax::

* GDB/MI Input Syntax::

* GDB/MI Output Syntax::

* GDB/MI Output Syntax::

* GDB/MI Simple Examples::

* GDB/MI Simple Examples::

@end menu

@end menu

@node GDB/MI Input Syntax

@node GDB/MI Input Syntax

@subsection @sc{gdb/mi} Input Syntax

@subsection @sc{gdb/mi} Input Syntax

@cindex input syntax for @sc{gdb/mi}

@cindex input syntax for @sc{gdb/mi}

@cindex @sc{gdb/mi}, input syntax

@cindex @sc{gdb/mi}, input syntax

@table @code

@table @code

@item @var{command} @expansion{}

@item @var{command} @expansion{}

@code{@var{cli-command} | @var{mi-command}}

@code{@var{cli-command} | @var{mi-command}}

@item @var{cli-command} @expansion{}

@item @var{cli-command} @expansion{}

@code{[ @var{token} ] @var{cli-command} @var{nl}}, where

@code{[ @var{token} ] @var{cli-command} @var{nl}}, where

@var{cli-command} is any existing GDB CLI command.

@var{cli-command} is any existing GDB CLI command.

@item @var{mi-command} @expansion{}

@item @var{mi-command} @expansion{}

@code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*

@code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*

@code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}

@code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}

@item @var{token} @expansion{}

@item @var{token} @expansion{}

@code{"any sequence of digits"}

@code{"any sequence of digits"}

@item @var{option} @expansion{}

@item @var{option} @expansion{}

@code{"-" @var{parameter} [ " " @var{parameter} ]}

@code{"-" @var{parameter} [ " " @var{parameter} ]}

@item @var{parameter} @expansion{}

@item @var{parameter} @expansion{}

@code{@var{non-blank-sequence} | @var{c-string}}

@code{@var{non-blank-sequence} | @var{c-string}}

@item @var{operation} @expansion{}

@item @var{operation} @expansion{}

@emph{any of the operations described in this document}

@emph{any of the operations described in this document}

@item @var{non-blank-sequence} @expansion{}

@item @var{non-blank-sequence} @expansion{}

@emph{anything, provided it doesn't contain special characters such as

@emph{anything, provided it doesn't contain special characters such as

"-", @var{nl}, """ and of course " "}

"-", @var{nl}, """ and of course " "}

@item @var{c-string} @expansion{}

@item @var{c-string} @expansion{}

@code{""" @var{seven-bit-iso-c-string-content} """}

@code{""" @var{seven-bit-iso-c-string-content} """}

@item @var{nl} @expansion{}

@item @var{nl} @expansion{}

@code{CR | CR-LF}

@code{CR | CR-LF}

@end table

@end table

Notes:

Notes:

@itemize @bullet

@itemize @bullet

@item

@item

The CLI commands are still handled by the @sc{mi} interpreter; their

The CLI commands are still handled by the @sc{mi} interpreter; their

output is described below.

output is described below.

@item

@item

The @code{@var{token}}, when present, is passed back when the command

The @code{@var{token}}, when present, is passed back when the command

finishes.

finishes.

@item

@item

Some @sc{mi} commands accept optional arguments as part of the parameter

Some @sc{mi} commands accept optional arguments as part of the parameter

list. Each option is identified by a leading @samp{-} (dash) and may be

list. Each option is identified by a leading @samp{-} (dash) and may be

followed by an optional argument parameter.  Options occur first in the

followed by an optional argument parameter.  Options occur first in the

parameter list and can be delimited from normal parameters using

parameter list and can be delimited from normal parameters using

@samp{--} (this is useful when some parameters begin with a dash).

@samp{--} (this is useful when some parameters begin with a dash).

@end itemize

@end itemize

Pragmatics:

Pragmatics:

@itemize @bullet

@itemize @bullet

@item

@item

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

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

@item

@item

We want it to be easy to spot a @sc{mi} operation.

We want it to be easy to spot a @sc{mi} operation.

@end itemize

@end itemize

@node GDB/MI Output Syntax

@node GDB/MI Output Syntax

@subsection @sc{gdb/mi} Output Syntax

@subsection @sc{gdb/mi} Output Syntax

@cindex output syntax of @sc{gdb/mi}

@cindex output syntax of @sc{gdb/mi}

@cindex @sc{gdb/mi}, output syntax

@cindex @sc{gdb/mi}, output syntax

The output from @sc{gdb/mi} consists of zero or more out-of-band records

The output from @sc{gdb/mi} consists of zero or more out-of-band records

followed, optionally, by a single result record.  This result record

followed, optionally, by a single result record.  This result record

is for the most recent command.  The sequence of output records is

is for the most recent command.  The sequence of output records is

terminated by @samp{(gdb)}.

terminated by @samp{(gdb)}.

If an input command was prefixed with a @code{@var{token}} then the

If an input command was prefixed with a @code{@var{token}} then the

corresponding output for that command will also be prefixed by that same

corresponding output for that command will also be prefixed by that same

@var{token}.

@var{token}.

@table @code

@table @code

@item @var{output} @expansion{}

@item @var{output} @expansion{}

@code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}

@code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}

@item @var{result-record} @expansion{}

@item @var{result-record} @expansion{}

@code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}

@code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}

@item @var{out-of-band-record} @expansion{}

@item @var{out-of-band-record} @expansion{}

@code{@var{async-record} | @var{stream-record}}

@code{@var{async-record} | @var{stream-record}}

@item @var{async-record} @expansion{}

@item @var{async-record} @expansion{}

@code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}

@code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}

@item @var{exec-async-output} @expansion{}

@item @var{exec-async-output} @expansion{}

@code{[ @var{token} ] "*" @var{async-output}}

@code{[ @var{token} ] "*" @var{async-output}}

@item @var{status-async-output} @expansion{}

@item @var{status-async-output} @expansion{}

@code{[ @var{token} ] "+" @var{async-output}}

@code{[ @var{token} ] "+" @var{async-output}}

@item @var{notify-async-output} @expansion{}

@item @var{notify-async-output} @expansion{}

@code{[ @var{token} ] "=" @var{async-output}}

@code{[ @var{token} ] "=" @var{async-output}}

@item @var{async-output} @expansion{}

@item @var{async-output} @expansion{}

@code{@var{async-class} ( "," @var{result} )* @var{nl}}

@code{@var{async-class} ( "," @var{result} )* @var{nl}}

@item @var{result-class} @expansion{}

@item @var{result-class} @expansion{}

@code{"done" | "running" | "connected" | "error" | "exit"}

@code{"done" | "running" | "connected" | "error" | "exit"}

@item @var{async-class} @expansion{}

@item @var{async-class} @expansion{}

@code{"stopped" | @var{others}} (where @var{others} will be added

@code{"stopped" | @var{others}} (where @var{others} will be added

depending on the needs---this is still in development).

depending on the needs---this is still in development).

@item @var{result} @expansion{}

@item @var{result} @expansion{}

@code{[ @var{string} "=" ] @var{value}}

@code{[ @var{string} "=" ] @var{value}}

@item @var{value} @expansion{}

@item @var{value} @expansion{}

@code{@var{const} | "@{" @var{result} ( "," @var{result} )* "@}"}

@code{@var{const} | "@{" @var{result} ( "," @var{result} )* "@}"}

@item @var{const} @expansion{}

@item @var{const} @expansion{}

@code{@var{c-string}}

@code{@var{c-string}}

@item @var{stream-record} @expansion{}

@item @var{stream-record} @expansion{}

@code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}

@code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}

@item @var{console-stream-output} @expansion{}

@item @var{console-stream-output} @expansion{}

@code{"~" @var{c-string}}

@code{"~" @var{c-string}}

@item @var{target-stream-output} @expansion{}

@item @var{target-stream-output} @expansion{}

@code{"@@" @var{c-string}}

@code{"@@" @var{c-string}}

@item @var{log-stream-output} @expansion{}

@item @var{log-stream-output} @expansion{}

@code{"&" @var{c-string}}

@code{"&" @var{c-string}}

@item @var{nl} @expansion{}

@item @var{nl} @expansion{}

@code{CR | CR-LF}

@code{CR | CR-LF}

@item @var{token} @expansion{}

@item @var{token} @expansion{}

@emph{any sequence of digits}.

@emph{any sequence of digits}.

@end table

@end table

In addition, the following are still being developed:

In addition, the following are still being developed:

@table @code

@table @code

@item @var{query}

@item @var{query}

This action is currently undefined.

This action is currently undefined.

@end table

@end table

Notes:

Notes:

@itemize @bullet

@itemize @bullet

@item

@item

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

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

@item

@item

The @code{@var{token}} is from the corresponding request.  If an execution

The @code{@var{token}} is from the corresponding request.  If an execution

command is interrupted by the @samp{-exec-interrupt} command, the

command is interrupted by the @samp{-exec-interrupt} command, the

@var{token} associated with the `*stopped' message is the one of the

@var{token} associated with the `*stopped' message is the one of the

original execution command, not the one of the interrupt-command.

original execution command, not the one of the interrupt-command.

@item

@item

@cindex status output in @sc{gdb/mi}

@cindex status output in @sc{gdb/mi}

@var{status-async-output} contains on-going status information about the

@var{status-async-output} contains on-going status information about the

progress of a slow operation.  It can be discarded.  All status output is

progress of a slow operation.  It can be discarded.  All status output is

prefixed by @samp{+}.

prefixed by @samp{+}.

@item

@item

@cindex async output in @sc{gdb/mi}

@cindex async output in @sc{gdb/mi}

@var{exec-async-output} contains asynchronous state change on the target

@var{exec-async-output} contains asynchronous state change on the target

(stopped, started, disappeared).  All async output is prefixed by

(stopped, started, disappeared).  All async output is prefixed by

@samp{*}.

@samp{*}.

@item

@item

@cindex notify output in @sc{gdb/mi}

@cindex notify output in @sc{gdb/mi}

@var{notify-async-output} contains supplementary information that the

@var{notify-async-output} contains supplementary information that the

client should handle (e.g., a new breakpoint information).  All notify

client should handle (e.g., a new breakpoint information).  All notify

output is prefixed by @samp{=}.

output is prefixed by @samp{=}.

@item

@item

@cindex console output in @sc{gdb/mi}

@cindex console output in @sc{gdb/mi}

@var{console-stream-output} is output that should be displayed as is in the

@var{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

console.  It is the textual response to a CLI command.  All the console

output is prefixed by @samp{~}.

output is prefixed by @samp{~}.

@item

@item

@cindex target output in @sc{gdb/mi}

@cindex target output in @sc{gdb/mi}

@var{target-stream-output} is the output produced by the target program.

@var{target-stream-output} is the output produced by the target program.

All the target output is prefixed by @samp{@@}.

All the target output is prefixed by @samp{@@}.

@item

@item

@cindex log output in @sc{gdb/mi}

@cindex log output in @sc{gdb/mi}

@var{log-stream-output} is output text coming from GDB's internals, for

@var{log-stream-output} is output text coming from GDB's internals, for

instance messages that should be displayed as part of an error log.  All

instance messages that should be displayed as part of an error log.  All

the log output is prefixed by @samp{&}.

the log output is prefixed by @samp{&}.

@end itemize

@end itemize

@xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more

@xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more

details about the various output records.

details about the various output records.

@xref{GDB/MI Draft Changes to Output Syntax, , @sc{gdb/mi} Draft Changes

@xref{GDB/MI Draft Changes to Output Syntax, , @sc{gdb/mi} Draft Changes

to Output Syntax}, for proposed revisions to the current output syntax.

to Output Syntax}, for proposed revisions to the current output syntax.

@node GDB/MI Simple Examples

@node GDB/MI Simple Examples

@subsection Simple Examples of @sc{gdb/mi} Interaction

@subsection Simple Examples of @sc{gdb/mi} Interaction

@cindex @sc{gdb/mi}, simple examples

@cindex @sc{gdb/mi}, simple examples

This subsection presents several simple examples of interaction using

This subsection presents several simple examples of interaction using

the @sc{gdb/mi} interface.  In these examples, @samp{->} means that the

the @sc{gdb/mi} interface.  In these examples, @samp{->} means that the

following line is passed to @sc{gdb/mi} as input, while @samp{<-} means

following line is passed to @sc{gdb/mi} as input, while @samp{<-} means

the output received from @sc{gdb/mi}.

the output received from @sc{gdb/mi}.

@subsubheading Target Stop

@subsubheading Target Stop

Here's an example of stopping the inferior process:

Here's an example of stopping the inferior process:

@example

@example

-> -stop

-> -stop

<- (gdb)

<- (gdb)

@end example

@end example

@noindent

@noindent

and later:

and later:

@example

@example

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

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

<- (gdb)

<- (gdb)

@end example

@end example

@subsubheading Simple CLI Command

@subsubheading Simple CLI Command

Here's an example of a simple CLI command being passed through

Here's an example of a simple CLI command being passed through

@sc{gdb/mi} and on to the CLI.

@sc{gdb/mi} and on to the CLI.

@example

@example

-> print 1+2

-> print 1+2

<- ~3\n

<- ~3\n

<- (gdb)

<- (gdb)

@end example

@end example

@subsubheading Command With Side Effects

@subsubheading Command With Side Effects

@example

@example

-> -symbol-file xyz.exe

-> -symbol-file xyz.exe

<- *breakpoint,nr="3",address="0x123",source="a.c:123"

<- *breakpoint,nr="3",address="0x123",source="a.c:123"

<- (gdb)

<- (gdb)

@end example

@end example

@subsubheading A Bad Command

@subsubheading A Bad Command

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

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

@example

@example

-> -rubbish

-> -rubbish

<- error,"Rubbish not found"

<- error,"Rubbish not found"

<- (gdb)

<- (gdb)

@end example

@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI Compatibility with CLI

@node GDB/MI Compatibility with CLI

@section @sc{gdb/mi} Compatibility with CLI

@section @sc{gdb/mi} Compatibility with CLI

@cindex compatibility, @sc{gdb/mi} and CLI

@cindex compatibility, @sc{gdb/mi} and CLI

@cindex @sc{gdb/mi}, compatibility with CLI

@cindex @sc{gdb/mi}, compatibility with CLI

To help users familiar with GDB's existing CLI interface, @sc{gdb/mi}

To help users familiar with GDB's existing CLI interface, @sc{gdb/mi}

accepts existing CLI commands.  As specified by the syntax, such

accepts existing CLI commands.  As specified by the syntax, such

commands can be directly entered into the @sc{gdb/mi} interface and GDB will

commands can be directly entered into the @sc{gdb/mi} interface and GDB will

respond.

respond.

This mechanism is provided as an aid to developers of @sc{gdb/mi}

This mechanism is provided as an aid to developers of @sc{gdb/mi}

clients and not as a reliable interface into the CLI.  Since the command

clients and not as a reliable interface into the CLI.  Since the command

is being interpreteted in an environment that assumes @sc{gdb/mi}

is being interpreteted in an environment that assumes @sc{gdb/mi}

behaviour, the exact output of such commands is likely to end up being

behaviour, the exact output of such commands is likely to end up being

an un-supported hybrid of @sc{gdb/mi} and CLI output.

an un-supported hybrid of @sc{gdb/mi} and CLI output.

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI Output Records

@node GDB/MI Output Records

@section @sc{gdb/mi} Output Records

@section @sc{gdb/mi} Output Records

@menu

@menu

* GDB/MI Result Records::

* GDB/MI Result Records::

* GDB/MI Stream Records::

* GDB/MI Stream Records::

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

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

@end menu

@end menu

@node GDB/MI Result Records

@node GDB/MI Result Records

@subsection @sc{gdb/mi} Result Records

@subsection @sc{gdb/mi} Result Records

@cindex result records in @sc{gdb/mi}

@cindex result records in @sc{gdb/mi}

@cindex @sc{gdb/mi}, result records

@cindex @sc{gdb/mi}, result records

In addition to a number of out-of-band notifications, the response to a

In addition to a number of out-of-band notifications, the response to a

@sc{gdb/mi} command includes one of the following result indications:

@sc{gdb/mi} command includes one of the following result indications:

@table @code

@table @code

@findex ^done

@findex ^done

@item "^done" [ "," @var{results} ]

@item "^done" [ "," @var{results} ]

The synchronous operation was successful, @code{@var{results}} is the return

The synchronous operation was successful, @code{@var{results}} is the return

value.

value.

@item "^running"

@item "^running"

@findex ^running

@findex ^running

@c Is this one correct?  Should it be an out-of-band notification?

@c Is this one correct?  Should it be an out-of-band notification?

The asynchronous operation was successfully started.  The target is

The asynchronous operation was successfully started.  The target is

running.

running.

@item "^error" "," @var{c-string}

@item "^error" "," @var{c-string}

@cindex ^error

@cindex ^error

The operation failed.  The @code{@var{c-string}} contains the corresponding

The operation failed.  The @code{@var{c-string}} contains the corresponding

error message.

error message.

@end table

@end table

@node GDB/MI Stream Records

@node GDB/MI Stream Records

@subsection @sc{gdb/mi} Stream Records

@subsection @sc{gdb/mi} Stream Records

@cindex @sc{gdb/mi}, stream records

@cindex @sc{gdb/mi}, stream records

@cindex stream records in @sc{gdb/mi}

@cindex stream records in @sc{gdb/mi}

GDB internally maintains a number of output streams: the console, the

GDB internally maintains a number of output streams: the console, the

target, and the log.  The output intended for each of these streams is

target, and the log.  The output intended for each of these streams is

funneled through the @sc{gdb/mi} interface using @dfn{stream records}.

funneled through the @sc{gdb/mi} interface using @dfn{stream records}.

Each stream record begins with a unique @dfn{prefix character} which

Each stream record begins with a unique @dfn{prefix character} which

identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output

identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output

Syntax}). In addition to the prefix, each stream record contains a

Syntax}). In addition to the prefix, each stream record contains a

@code{@var{string-output}}.  This is either raw text (with an implicit new

@code{@var{string-output}}.  This is either raw text (with an implicit new

line) or a quoted C string (which does not contain an implicit newline).

line) or a quoted C string (which does not contain an implicit newline).

@table @code

@table @code

@item "~" @var{string-output}

@item "~" @var{string-output}

The console output stream contains text that should be displayed in the

The console output stream contains text that should be displayed in the

CLI console window.  It contains the textual responses to CLI commands.

CLI console window.  It contains the textual responses to CLI commands.

@item "@@" @var{string-output}

@item "@@" @var{string-output}

The target output stream contains any textual output from the running

The target output stream contains any textual output from the running

target.

target.

@item "&" @var{string-output}

@item "&" @var{string-output}

The LOG stream contains debugging messages being produced by GDB's

The LOG stream contains debugging messages being produced by GDB's

internals.

internals.

@end table

@end table

@node GDB/MI Out-of-band Records

@node GDB/MI Out-of-band Records

@subsection @sc{gdb/mi} Out-of-band Records

@subsection @sc{gdb/mi} Out-of-band Records

@cindex out-of-band records in @sc{gdb/mi}

@cindex out-of-band records in @sc{gdb/mi}

@cindex @sc{gdb/mi}, out-of-band records

@cindex @sc{gdb/mi}, out-of-band records

@dfn{Out-of-band} records are used to notify the @sc{gdb/mi} client of

@dfn{Out-of-band} records are used to notify the @sc{gdb/mi} client of

additional changes that have occurred.  Those changes can either be a

additional changes that have occurred.  Those changes can either be a

consequence of @sc{gdb/mi} (e.g., a breakpoint modified) or a result of

consequence of @sc{gdb/mi} (e.g., a breakpoint modified) or a result of

target activity (e.g., target stopped).

target activity (e.g., target stopped).

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

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

@table @code

@table @code

@item "*" "stop"

@item "*" "stop"

@end table

@end table

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI Command Description Format

@node GDB/MI Command Description Format

@section @sc{gdb/mi} Command Description Format

@section @sc{gdb/mi} Command Description Format

The remaining sections describe blocks of commands.  Each block of

The remaining sections describe blocks of commands.  Each block of

commands is laid out in a fashion similar to this chapter.

commands is laid out in a fashion similar to this chapter.

Note the the line breaks shown in the examples are here only for

Note the the line breaks shown in the examples are here only for

readability. They don't appear in the real output.

readability. They don't appear in the real output.

Also note that the commands with a non-available example (N.A.@:) are

Also note that the commands with a non-available example (N.A.@:) are

not yet implemented.

not yet implemented.

@subheading Motivation

@subheading Motivation

The motivation for this collection of commands

The motivation for this collection of commands

@subheading Introduction

@subheading Introduction

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

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

@subheading Commands

@subheading Commands

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

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

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -command @var{args}...

 -command @var{args}...

@end example

@end example

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB CLI command.

The corresponding GDB CLI command.

@subsubheading Result

@subsubheading Result

@subsubheading Out-of-band

@subsubheading Out-of-band

@subsubheading Notes

@subsubheading Notes

@subsubheading Example

@subsubheading Example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node GDB/MI Breakpoint Table Commands

@node GDB/MI Breakpoint Table Commands

@section @sc{gdb/mi} Breakpoint table commands

@section @sc{gdb/mi} Breakpoint table commands

@cindex breakpoint commands for @sc{gdb/mi}

@cindex breakpoint commands for @sc{gdb/mi}

@cindex @sc{gdb/mi}, breakpoint commands

@cindex @sc{gdb/mi}, breakpoint commands

This section documents @sc{gdb/mi} commands for manipulating

This section documents @sc{gdb/mi} commands for manipulating

breakpoints.

breakpoints.

@subheading The @code{-break-after} Command

@subheading The @code{-break-after} Command

@findex -break-after

@findex -break-after

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-after @var{number} @var{count}

 -break-after @var{number} @var{count}

@end example

@end example

The breakpoint number @var{number} is not in effect until it has been

The breakpoint number @var{number} is not in effect until it has been

hit @var{count} times.  To see how this is reflected in the output of

hit @var{count} times.  To see how this is reflected in the output of

the @samp{-break-list} command, see the description of the

the @samp{-break-list} command, see the description of the

@samp{-break-list} command below.

@samp{-break-list} command below.

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB command is @samp{ignore}.

The corresponding GDB command is @samp{ignore}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-insert main

-break-insert main

^done,bkpt=@{number="1",addr="0x000100d0",file="hello.c",line="5"@}

^done,bkpt=@{number="1",addr="0x000100d0",file="hello.c",line="5"@}

(gdb)

(gdb)

-break-after 1 3

-break-after 1 3

~

~

^done

^done

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

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

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

addr="0x000100d0",func="main",file="hello.c",line="5",times="0",

addr="0x000100d0",func="main",file="hello.c",line="5",times="0",

ignore="3"@}@}

ignore="3"@}@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@ignore

@ignore

@subheading The @code{-break-catch} Command

@subheading The @code{-break-catch} Command

@findex -break-catch

@findex -break-catch

@subheading The @code{-break-commands} Command

@subheading The @code{-break-commands} Command

@findex -break-commands

@findex -break-commands

@end ignore

@end ignore

@subheading -break-condition

@subheading -break-condition

@findex -break-condition

@findex -break-condition

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-condition @var{number} @var{expr}

 -break-condition @var{number} @var{expr}

@end example

@end example

Breakpoint @var{number} will stop the program only if the condition in

Breakpoint @var{number} will stop the program only if the condition in

@var{expr} is true.  The condition becomes part of the

@var{expr} is true.  The condition becomes part of the

@samp{-break-list} output (see the description of the @samp{-break-list}

@samp{-break-list} output (see the description of the @samp{-break-list}

command below).

command below).

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB command is @samp{condition}.

The corresponding GDB command is @samp{condition}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-condition 1 1

-break-condition 1 1

^done

^done

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

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

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

addr="0x000100d0",func="main",file="hello.c",line="5",cond="1",

addr="0x000100d0",func="main",file="hello.c",line="5",cond="1",

times="0",ignore="3"@}@}

times="0",ignore="3"@}@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@subheading The @code{-break-delete} Command

@subheading The @code{-break-delete} Command

@findex -break-delete

@findex -break-delete

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-delete ( @var{breakpoint} )+

 -break-delete ( @var{breakpoint} )+

@end example

@end example

Delete the breakpoint(s) whose number(s) are specified in the argument

Delete the breakpoint(s) whose number(s) are specified in the argument

list. This is obviously reflected in the breakpoint list.

list. This is obviously reflected in the breakpoint list.

@subsubheading GDB command

@subsubheading GDB command

The corresponding GDB command is @samp{delete}.

The corresponding GDB command is @samp{delete}.

@subsubheading Example

@subsubheading Example

@example

@example

(gdb)

(gdb)

-break-delete 1

-break-delete 1

^done

^done

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{@}

^done,BreakpointTable=@{@}

(gdb)

(gdb)

@end example

@end example

@subheading The @code{-break-disable} Command

@subheading The @code{-break-disable} Command

@findex -break-disable

@findex -break-disable

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-disable ( @var{breakpoint} )+

 -break-disable ( @var{breakpoint} )+

@end example

@end example

Disable the named @var{breakpoint}(s).  The field @samp{enabled} in the

Disable the named @var{breakpoint}(s).  The field @samp{enabled} in the

break list is now set to @samp{n} for the named @var{breakpoint}(s).

break list is now set to @samp{n} for the named @var{breakpoint}(s).

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB command is @samp{disable}.

The corresponding GDB command is @samp{disable}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-disable 2

-break-disable 2

^done

^done

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}@}

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@subheading The @code{-break-enable} Command

@subheading The @code{-break-enable} Command

@findex -break-enable

@findex -break-enable

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-enable ( @var{breakpoint} )+

 -break-enable ( @var{breakpoint} )+

@end example

@end example

Enable (previously disabled) @var{breakpoint}(s).

Enable (previously disabled) @var{breakpoint}(s).

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB command is @samp{enable}.

The corresponding GDB command is @samp{enable}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-enable 2

-break-enable 2

^done

^done

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}@}

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@subheading The @code{-break-info} Command

@subheading The @code{-break-info} Command

@findex -break-info

@findex -break-info

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-info @var{breakpoint}

 -break-info @var{breakpoint}

@end example

@end example

@c REDUNDANT???

@c REDUNDANT???

Get information about a single breakpoint.

Get information about a single breakpoint.

@subsubheading GDB command

@subsubheading GDB command

The corresponding GDB command is @samp{info break @var{breakpoint}}.

The corresponding GDB command is @samp{info break @var{breakpoint}}.

@subsubheading Example

@subsubheading Example

N.A.

N.A.

@subheading The @code{-break-insert} Command

@subheading The @code{-break-insert} Command

@findex -break-insert

@findex -break-insert

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-insert [ -t ] [ -h ] [ -r ]

 -break-insert [ -t ] [ -h ] [ -r ]

    [ -c @var{condition} ] [ -i @var{ignore-count} ]

    [ -c @var{condition} ] [ -i @var{ignore-count} ]

    [ -p @var{thread} ] [ @var{line} | @var{addr} ]

    [ -p @var{thread} ] [ @var{line} | @var{addr} ]

@end example

@end example

@noindent

@noindent

If specified, @var{line}, can be one of:

If specified, @var{line}, can be one of:

@itemize @bullet

@itemize @bullet

@item function

@item function

@c @item +offset

@c @item +offset

@c @item -offset

@c @item -offset

@c @item linenum

@c @item linenum

@item filename:linenum

@item filename:linenum

@item filename:function

@item filename:function

@item *address

@item *address

@end itemize

@end itemize

The possible optional parameters of this command are:

The possible optional parameters of this command are:

@table @samp

@table @samp

@item -t

@item -t

Insert a tempoary breakpoint.

Insert a tempoary breakpoint.

@item -h

@item -h

Insert a hardware breakpoint.

Insert a hardware breakpoint.

@item -c @var{condition}

@item -c @var{condition}

Make the breakpoint conditional on @var{condition}.

Make the breakpoint conditional on @var{condition}.

@item -i @var{ignore-count}

@item -i @var{ignore-count}

Initialize the @var{ignore-count}.

Initialize the @var{ignore-count}.

@item -r

@item -r

Insert a regular breakpoint in all the functions whose names match the

Insert a regular breakpoint in all the functions whose names match the

given regular expression.  Other flags are not applicable to regular

given regular expression.  Other flags are not applicable to regular

expresson.

expresson.

@end table

@end table

@subsubheading Result

@subsubheading Result

The result is in the form:

The result is in the form:

@example

@example

 ^done,bkptno="@var{number}",func="@var{funcname}",

 ^done,bkptno="@var{number}",func="@var{funcname}",

  file="@var{filename}",line="@var{lineno}"

  file="@var{filename}",line="@var{lineno}"

@end example

@end example

@noindent

@noindent

where @var{number} is the GDB number for this breakpoint, @var{funcname}

where @var{number} is the GDB number for this breakpoint, @var{funcname}

is the name of the function where the breakpoint was inserted,

is the name of the function where the breakpoint was inserted,

@var{filename} is the name of the source file which contains this

@var{filename} is the name of the source file which contains this

function, and @var{lineno} is the source line number within that file.

function, and @var{lineno} is the source line number within that file.

Note: this format is open to change.

Note: this format is open to change.

@c An out-of-band breakpoint instead of part of the result?

@c An out-of-band breakpoint instead of part of the result?

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB commands are @samp{break}, @samp{tbreak},

The corresponding GDB commands are @samp{break}, @samp{tbreak},

@samp{hbreak}, @samp{thbreak}, and @samp{rbreak}.

@samp{hbreak}, @samp{thbreak}, and @samp{rbreak}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-insert main

-break-insert main

^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}

^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}

(gdb)

(gdb)

-break-insert -t foo

-break-insert -t foo

^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",line="11"@}

^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",line="11"@}

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

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

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

addr="0x0001072c", func="main",file="recursive2.c",line="4",times="0"@},

addr="0x0001072c", func="main",file="recursive2.c",line="4",times="0"@},

bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",

bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",

addr="0x00010774",func="foo",file="recursive2.c",line="11",times="0"@}@}

addr="0x00010774",func="foo",file="recursive2.c",line="11",times="0"@}@}

(gdb)

(gdb)

-break-insert -r foo.*

-break-insert -r foo.*

~int foo(int, int);

~int foo(int, int);

^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c",line="11"@}

^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c",line="11"@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@subheading The @code{-break-list} Command

@subheading The @code{-break-list} Command

@findex -break-list

@findex -break-list

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-list

 -break-list

@end example

@end example

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

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

@table @samp

@table @samp

@item Number

@item Number

number of the breakpoint

number of the breakpoint

@item Type

@item Type

type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}

type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}

@item Disposition

@item Disposition

should the breakpoint be deleted or disabled when it is hit: @samp{keep}

should the breakpoint be deleted or disabled when it is hit: @samp{keep}

or @samp{nokeep}

or @samp{nokeep}

@item Enabled

@item Enabled

is the breakpoint enabled or no: @samp{y} or @samp{n}

is the breakpoint enabled or no: @samp{y} or @samp{n}

@item Address

@item Address

memory location at which the breakpoint is set

memory location at which the breakpoint is set

@item What

@item What

logical location of the breakpoint, expressed by function name, file

logical location of the breakpoint, expressed by function name, file

name, line number

name, line number

@item times

@item times

number of times the breakpoint has been hit

number of times the breakpoint has been hit

@end table

@end table

If there are no breakpoints or watchpoints, the BreakpointTable field is

If there are no breakpoints or watchpoints, the BreakpointTable field is

an empty list.

an empty list.

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB command is @samp{info break}.

The corresponding GDB command is @samp{info break}.

@subsubheading Example

@subsubheading Example

@smallexample

@smallexample

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

^done,BreakpointTable=@{hdr=@{"Num","Type","Disp","Enb","Address","What"@},

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

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

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@},

addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@},

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",

bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",

addr="0x00010114",func="foo",file="hello.c",line="13",times="0"@}@}

addr="0x00010114",func="foo",file="hello.c",line="13",times="0"@}@}

(gdb)

(gdb)

@end smallexample

@end smallexample

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

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

@smallexample

@smallexample

(gdb)

(gdb)

-break-list

-break-list

^done,BreakpointTable=@{@}

^done,BreakpointTable=@{@}

(gdb)

(gdb)

@end smallexample

@end smallexample

@subheading The @code{-break-watch} Command

@subheading The @code{-break-watch} Command

@findex -break-watch

@findex -break-watch

@subsubheading Synopsis

@subsubheading Synopsis

@example

@example

 -break-watch [ -a | -r ]

 -break-watch [ -a | -r ]

@end example

@end example

Create a watchpoint.  With the @samp{-a} option it will create an

Create a watchpoint.  With the @samp{-a} option it will create an

@dfn{access} watchpoint, i.e. a watchpoint that triggers either on a

@dfn{access} watchpoint, i.e. a watchpoint that triggers either on a

read from or on a write to the memory location.  With the @samp{-r}

read from or on a write to the memory location.  With the @samp{-r}

option, the watchpoint created is a @dfn{read} watchpoint, i.e. it will

option, the watchpoint created is a @dfn{read} watchpoint, i.e. it will

trigger only when the memory location is accessed for reading.  Without

trigger only when the memory location is accessed for reading.  Without

either of the options, the watchpoint created is a regular watchpoint,

either of the options, the watchpoint created is a regular watchpoint,

i.e. it will trigger when the memory location is accessed for writing.

i.e. it will trigger when the memory location is accessed for writing.

@xref{Set Watchpoints, , Setting watchpoints}.

@xref{Set Watchpoints, , Setting watchpoints}.

Note that @samp{-break-list} will report a single list of watchpoints and

Note that @samp{-break-list} will report a single list of watchpoints and

breakpoints inserted.

breakpoints inserted.

@subsubheading GDB Command

@subsubheading GDB Command

The corresponding GDB commands are @samp{watch}, @samp{awatch}, and

The corresponding GDB commands are @samp{watch}, @samp{awatch}, and

@samp{rwatch}.

@samp{rwatch}.

@subsubheading Example

@subsubheading Example

Setting a watchpoint on a variable in the @code{main} function:

Setting a watchpoint on a variable in the @code{main} function:

@smallexample

@smallexample

(gdb)

(gdb)

-break-watch x

-break-watch x

^done,wpt=@{number="2",exp="x"@}

^done,wpt=@{number="2",exp="x"@}

(gdb)

(gdb)

-exec-continue

-exec-continue

^running

^running

^done,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},

^done,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},

value=@{old="-268439212",new="55"@},

value=@{old="-268439212",new="55"@},

frame=@{func="main",args=@{@},file="recursive2.c",line="5"@}

frame=@{func="main",args=@{@},file="recursive2.c",line="5"@}

(gdb)

(gdb)

@end smallexample

@end smallexample

Setting a watchpoint on a variable local to a function.  GDB will stop

Setting a watchpoint on a variable local to a function.  GDB will stop

the program execution twice: first for the variable changing value, then

the program execution twice: first for the variable changing value, then

for the watchpoint going out of scope.

for the watchpoint going out of scope.

@smallexample

@smallexample

(gdb)

(gdb)

-break-watch C

-break-watch C

^done,wpt=@{number="5",exp="C"@}

^done,wpt=@{number="5",exp="C"@}

(gdb)

(gdb)

-exec-continue

-exec-continue

^running

^running

^done,reason="watchpoint-trigger",

^done,reason="watchpoint-trigger",

wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},

wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},

frame=@{func="callee4",args=@{@},

frame=@{func="callee4",args=@{@},