Node:Top, Next:Summary

# Debugging with GDB

This file describes GDB, the GNU symbolic debugger.

This is the Eighth Edition, March 2000, for GDB Version 5.0.

Copyright (C) 1988-2000 Free Software Foundation, Inc.

- Summary: Summary of GDB
- Sample Session: A sample GDB session

- Invocation: Getting in and out of GDB
- Commands: GDB commands
- Running: Running programs under GDB
- Stopping: Stopping and continuing
- Stack: Examining the stack
- Source: Examining source files
- Data: Examining data

- Languages: Using GDB with different languages

- Symbols: Examining the symbol table
- Altering: Altering execution
- GDB Files: GDB files
- Targets: Specifying a debugging target
- Configurations: Configuration-specific information
- Controlling GDB: Controlling GDB
- Sequences: Canned sequences of commands
- Emacs: Using GDB under GNU Emacs
- Annotations: GDB's annotation interface.

- GDB Bugs: Reporting bugs in GDB
- Formatting Documentation: How to format and print GDB documentation

- Command Line Editing: Command Line Editing
- Using History Interactively: Using History Interactively
- Installing GDB: Installing GDB
- Index: Index

Node:Summary, Next:Sample Session, Previous:Top, Up:Top

# Summary of GDB

The purpose of a debugger such as GDB is to allow you to see what is going on "inside" another program while it executes--or what another program was doing at the moment it crashed. GDB can do four main kinds of things (plus other things in support of these) to help you catch bugs in the act:

- Start your program, specifying anything that might affect its behavior.
- Make your program stop on specified conditions.
- Examine what has happened, when your program has stopped.
- Change things in your program, so you can experiment with correcting the effects of one bug and go on to learn about another.

You can use GDB to debug programs written in C and C++. For more information, see Supported languages. For more information, see C and C++.

Support for Modula-2 and Chill is partial. For information on Modula-2, see Modula-2. For information on Chill, see Chill.

Debugging Pascal programs which use sets, subranges, file variables, or nested functions does not currently work. GDB does not support entering expressions, printing values, or similar features using Pascal syntax. GDB can be used to debug programs written in Fortran, although it may be necessary to refer to some variables with a trailing underscore.

- Free Software: Freely redistributable software
- Contributors: Contributors to GDB

Node:Free Software, Next:Contributors, Up:Summary

## Free software

GDB is free software, protected by the GNU General Public License (GPL). The GPL gives you the freedom to copy or adapt a licensed program--but every person getting a copy also gets with it the freedom to modify that copy (which means that they must get access to the source code), and the freedom to distribute further copies. Typical software companies use copyrights to limit your freedoms; the Free Software Foundation uses the GPL to preserve these freedoms.

Fundamentally, the General Public License is a license which says that you have these freedoms and that you cannot take these freedoms away from anyone else.

Node:Contributors, Previous:Free Software, Up:Summary

## Contributors to GDB

Richard Stallman was the original author of GDB, and of many other GNU programs. Many others have contributed to its development. This section attempts to credit major contributors. One of the virtues of free software is that everyone is free to contribute to it; with regret, we cannot actually acknowledge everyone here. The file `ChangeLog` in the GDB distribution approximates a blow-by-blow account.

Changes much prior to version 2.0 are lost in the mists of time.

> Plea: Additions to this section are particularly welcome. If you or your friends (or enemies, to be evenhanded) have been unfairly omitted from this list, we would like to add your names!

So that they may not regard their many labors as thankless, we particularly thank those who shepherded GDB through major releases: Andrew Cagney (release 5.0); Jim Blandy (release 4.18); Jason Molenda (release 4.17); Stan Shebs (release 4.14); Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9); Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4); John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9); Jim Kingdon (releases 3.5, 3.4, and 3.3); and Randy Smith (releases 3.2, 3.1, and 3.0).

Richard Stallman, assisted at various times by Peter TerMaat, Chris Hanson, and Richard Mlynarik, handled releases through 2.8.

Michael Tiemann is the author of most of the GNU C++ support in GDB, with significant additional contributions from Per Bothner. James Clark wrote the GNU C++ demangler. Early work on C++ was by Peter TerMaat (who also did much general update work leading to release 3.0). GDB 4 uses the BFD subroutine library to examine multiple object-file formats; BFD was a joint project of David V. Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore.

David Johnson wrote the original COFF support; Pace Willison did the original support for encapsulated COFF.

Brent Benson of Harris Computer Systems contributed DWARF 2 support.

Adam de Boor and Bradley Davis contributed the ISI Optimum V support. Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS support. Jean-Daniel Fekete contributed Sun 386i support. Chris Hanson improved the HP9000 support. Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support. David Johnson contributed Encore Umax support. Jyrki Kuoppala contributed Altos 3068 support. Jeff Law contributed HP PA and SOM support. Keith Packard contributed NS32K support. Doug Rabson contributed Acorn Risc Machine support. Bob Rusk contributed Harris Nighthawk CX-UX support. Chris Smith contributed Convex support (and Fortran debugging). Jonathan Stone contributed Pyramid support. Michael Tiemann contributed SPARC support. Tim Tucker contributed support for the Gould NP1 and Gould Powernode. Pace Willison contributed Intel 386 support. Jay Vosburgh contributed Symmetry support.

Andreas Schwab contributed M68K Linux support.

Rich Schaefer and Peter Schauer helped with support of SunOS shared libraries.

Jay Fenlason and Roland McGrath ensured that GDB and GAS agree about several machine instruction sets.

Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop remote debugging. Intel Corporation, Wind River Systems, AMD, and ARM contributed remote debugging modules for the i960, VxWorks, A29K UDI, and RDI targets, respectively.

Brian Fox is the author of the readline libraries providing command-line editing and command history.

Andrew Beers of SUNY Buffalo wrote the language-switching code, the Modula-2 support, and contributed the Languages chapter of this manual.

Fred Fish wrote most of the support for Unix System Vr4. He also enhanced the command-completion support to cover C++ overloaded symbols.

Hitachi America, Ltd. sponsored the support for H8/300, H8/500, and Super-H processors.

NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors.

Mitsubishi sponsored the support for D10V, D30V, and M32R/D processors.

Toshiba sponsored the support for the TX39 Mips processor.

Matsushita sponsored the support for the MN10200 and MN10300 processors.

Fujitsu sponsored the support for SPARClite and FR30 processors.

Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware watchpoints.

Michael Snyder added support for tracepoints.

Stu Grossman wrote gdbserver.

Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made nearly innumerable bug fixes and cleanups throughout GDB.

The following people at the Hewlett-Packard Company contributed support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0 (narrow mode), HP's implementation of kernel threads, HP's aC++ compiler, and the terminal user interface: Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann, Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni. Kim Haase provided HP-specific information in this manual.

Cygnus Solutions has sponsored GDB maintenance and much of its development since 1991. Cygnus engineers who have worked on GDB fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler, Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni. In addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton, JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner, Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David Zuhn have made contributions both large and small.

Node:Sample Session, Next:Invocation, Previous:Summary, Up:Top

# A Sample GDB Session

You can use this manual at your leisure to read all about GDB. However, a handful of commands are enough to get started using the debugger. This chapter illustrates those commands.

One of the preliminary versions of GNU `m4` (a generic macro processor) exhibits the following bug: sometimes, when we change its quote strings from the default, the commands used to capture one macro definition within another stop working. In the following short `m4` session, we define a macro `foo` which expands to `0000`; we then use the `m4` built-in `defn` to define `bar` as the same thing. However, when we change the open quote string to `<QUOTE>` and the close quote string to `<UNQUOTE>`, the same procedure fails to define a new synonym `baz`:

    $ cd gnu/m4
    $ ./m4
    define(foo,0000)

    foo
    0000
    define(bar,defn(`foo'))

    bar
    0000
    changequote(<QUOTE>,<UNQUOTE>)

    define(baz,defn(<QUOTE>foo<UNQUOTE>))
    baz
    C-d
    m4: End of input: 0: fatal error: EOF in string

Let us use GDB to try to see what is going on.

    $ gdb m4
    GDB is free software and you are welcome to 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.

    GDB 5.0, Copyright 1999 Free Software Foundation, Inc...
    (gdb)

GDB reads only enough symbol data to know where to find the rest when needed; as a result, the first prompt comes up very quickly. We now tell GDB to use a narrower display width than usual, so that examples fit in this manual.

    (gdb) set width 70

We need to see how the `m4` built-in `changequote` works. Having looked at the source, we know the relevant subroutine is `m4_changequote`, so we set a breakpoint there with the GDB `break` command.

    (gdb) break m4_changequote
    Breakpoint 1 at 0x62f4: file builtin.c, line 879.

Using the `run` command, we start `m4` running under GDB control; as long as control does not reach the `m4_changequote` subroutine, the program runs as usual:

    (gdb) run
    Starting program: /work/Editorial/gdb/gnu/m4/m4
    define(foo,0000)

    foo
    0000

To trigger the breakpoint, we call `changequote`. GDB suspends execution of `m4`, displaying information about the context where it stops.

    changequote(<QUOTE>,<UNQUOTE>)

    Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
        at builtin.c:879
    879         if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))

Now we use the command `n` (`next`) to advance execution to the next line of the current function.

    (gdb) n
    882         set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
     : nil,

`set_quotes` looks like a promising subroutine. We can go into it by using the command `s` (`step`) instead of `next`. `step` goes to the next line to be executed in any subroutine, so it steps into `set_quotes`.

    (gdb) s
    set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
        at input.c:530
    530         if (lquote != def_lquote)

The display that shows the subroutine where `m4` is now suspended (and its arguments) is called a stack frame display. It shows a summary of the stack. We can use the `backtrace` command (which can also be spelled `bt`), to see where we are in the stack as a whole: the `backtrace` command displays a stack frame for each active subroutine.

    (gdb) bt
    #0  set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
        at input.c:530
    #1  0x6344 in m4_changequote (argc=3, argv=0x33c70)
        at builtin.c:882
    #2  0x8174 in expand_macro (sym=0x33320) at macro.c:242
    #3  0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
        at macro.c:71
    #4  0x79dc in expand_input () at macro.c:40
    #5  0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195

We step through a few more lines to see what happens. The first two times, we can use `s`; the next two times we use `n` to avoid falling into the `xstrdup` subroutine.

    (gdb) s
    0x3b5c  532         if (rquote != def_rquote)
    (gdb) s
    0x3b80  535         lquote = (lq == nil || *lq == '\0') ?  \
    def_lquote : xstrdup(lq);
    (gdb) n
    536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
     : xstrdup(rq);
    (gdb) n
    538         len_lquote = strlen(rquote);

The last line displayed looks a little odd; we can examine the variables `lquote` and `rquote` to see if they are in fact the new left and right quotes we specified. We use the command `p` (`print`) to see their values.

    (gdb) p lquote
    $1 = 0x35d40 "<QUOTE>"
    (gdb) p rquote
    $2 = 0x35d50 "<UNQUOTE>"

`lquote` and `rquote` are indeed the new left and right quotes. To look at some context, we can display ten lines of source surrounding the current line with the `l` (`list`) command.

    (gdb) l
    533             xfree(rquote);
    534
    535         lquote = (lq == nil || *lq == '\0') ? def_lquote\
     : xstrdup (lq);
    536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
     : xstrdup (rq);
    537
    538         len_lquote = strlen(rquote);
    539         len_rquote = strlen(lquote);
    540     }
    541
    542     void

Let us step past the two lines that set `len_lquote` and `len_rquote`, and then examine the values of those variables.

    (gdb) n
    539         len_rquote = strlen(lquote);
    (gdb) n
    540     }
    (gdb) p len_lquote
    $3 = 9
    (gdb) p len_rquote
    $4 = 7

That certainly looks wrong, assuming `len_lquote` and `len_rquote` are meant to be the lengths of `lquote` and `rquote` respectively. We can set them to better values using the `p` command, since it can print the value of any expression--and that expression can include subroutine calls and assignments.

    (gdb) p len_lquote=strlen(lquote)
    $5 = 7
    (gdb) p len_rquote=strlen(rquote)
    $6 = 9

Is that enough to fix the problem of using the new quotes with the `m4` built-in `defn`? We can allow `m4` to continue executing with the `c` (`continue`) command, and then try the example that caused trouble initially:

    (gdb) c
    Continuing.

    define(baz,defn(<QUOTE>foo<UNQUOTE>))

    baz
    0000

Success! The new quotes now work just as well as the default ones. The problem seems to have been just the two typos defining the wrong lengths. We allow `m4` exit by giving it an EOF as input:

    C-d
    Program exited normally.

The message `Program exited normally.` is from GDB; it indicates `m4` has finished executing. We can end our GDB session with the GDB `quit` command.

    (gdb) quit

Node:Invocation, Next:Commands, Previous:Sample Session, Up:Top

# Getting In and Out of GDB

This chapter discusses how to start GDB, and how to get out of it. The essentials are:

- type `gdb` to start GDB.
- type `quit` or `C-d` to exit.

- Invoking GDB: How to start GDB
- Quitting GDB: How to quit GDB
- Shell Commands: How to use shell commands inside GDB

Node:Invoking GDB, Next:Quitting GDB, Up:Invocation

## Invoking GDB

Invoke GDB by running the program `gdb`. Once started, GDB reads commands from the terminal until you tell it to exit.

You can also run `gdb` with a variety of arguments and options, to specify more of your debugging environment at the outset.

The command-line options described here are designed to cover a variety of situations; in some environments, some of these options may effectively be unavailable.

The most usual way to start GDB is with one argument, specifying an executable program:

    gdb program

You can also start with both an executable program and a core file specified:

    gdb program core

You can, instead, specify a process ID as a second argument, if you want to debug a running process:

    gdb program 1234

would attach GDB to process `1234` (unless you also have a file named `1234`; GDB does check for a core file first).

Taking advantage of the second command-line argument requires a fairly complete operating system; when you use GDB as a remote debugger attached to a bare board, there may not be any notion of "process", and there is often no way to get a core dump. GDB will warn you if it is unable to attach or to read core dumps.

You can run `gdb` without printing the front material, which describes GDB's non-warranty, by specifying `-silent`:

    gdb -silent

You can further control how GDB starts up by using command-line options. GDB itself can remind you of the options available.

Type

    gdb -help

to display all available options and briefly describe their use (`gdb -h` is a shorter equivalent).

All options and command line arguments you give are processed in sequential order. The order makes a difference when the `-x` option is used.

- File Options: Choosing files
- Mode Options: Choosing modes

Node:File Options, Next:Mode Options, Up:Invoking GDB

### Choosing files

When GDB starts, it reads any arguments other than options as specifying an executable file and core file (or process ID). This is the same as if the arguments were specified by the `-se` and `-c` options respectively. (GDB reads the first argument that does not have an associated option flag as equivalent to the `-se` option followed by that argument; and the second argument that does not have an associated option flag, if any, as equivalent to the `-c` option followed by that argument.)

If GDB has not been configured to included core file support, such as for most embedded targets, then it will complain about a second argument and ignore it.

Many options have both long and short forms; both are shown in the following list. GDB also recognizes the long forms if you truncate them, so long as enough of the option is present to be unambiguous. (If you prefer, you can flag option arguments with `--` rather than `-`, though we illustrate the more usual convention.)

`-symbols file`
`-s file`
  Read symbol table from file file.
`-exec file`
`-e file`
  Use file file as the executable file to execute when appropriate, and for examining pure data in conjunction with a core dump.
`-se file`
  Read symbol table from file file and use it as the executable file.
`-core file`
`-c file`
  Use file file as a core dump to examine.
`-c number`
  Connect to process ID number, as with the `attach` command (unless there is a file in core-dump format named number, in which case `-c` specifies that file as a core dump to read).
`-command file`
`-x file`
  Execute GDB commands from file file. See Command files.
`-directory directory`
`-d directory`
  Add directory to the path to search for source files.
`-m`
`-mapped`
  Warning: this option depends on operating system facilities that are not supported on all systems.
  If memory-mapped files are available on your system through the `mmap` system call, you can use this option to have GDB write the symbols from your program into a reusable file in the current directory. If the program you are debugging is called `/tmp/fred`, the mapped symbol file is `/tmp/fred.syms`. Future GDB debugging sessions notice the presence of this file, and can quickly map in symbol information from it, rather than reading the symbol table from the executable program.

  The `.syms` file is specific to the host machine where GDB is run. It holds an exact image of the internal GDB symbol table. It cannot be shared across multiple host platforms.

`-r`
`-readnow`
  Read each symbol file's entire symbol table immediately, rather than the default, which is to read it incrementally as it is needed. This makes startup slower, but makes future operations faster.

You typically combine the `-mapped` and `-readnow` options in order to build a `.syms` file that contains complete symbol information. (See Commands to specify files, for information on `.syms` files.) A simple GDB invocation to do nothing but build a `.syms` file for future use is:

    gdb -batch -nx -mapped -readnow programname

Node:Mode Options, Previous:File Options, Up:Invoking GDB

### Choosing modes

You can run GDB in various alternative modes--for example, in batch mode or quiet mode.

`-nx`
`-n`
  Do not execute commands found in any initialization files (normally called `.gdbinit`, or `gdb.ini` on PCs). Normally, GDB executes the commands in these files after all the command options and arguments have been processed. See Command files.
`-quiet`
`-silent`
`-q`
  "Quiet". Do not print the introductory and copyright messages. These messages are also suppressed in batch mode.
`-batch`
  Run in batch mode. Exit with status `0` after processing all the command files specified with `-x` (and all commands from initialization files, if not inhibited with `-n`). Exit with nonzero status if an error occurs in executing the GDB commands in the command files.

  Batch mode may be useful for running GDB as a filter, for example to download and run a program on another computer; in order to make this more useful, the message

      Program exited normally.

  (which is ordinarily issued whenever a program running under GDB control terminates) is not issued when running in batch mode.

`-nowindows`
`-nw`
  "No windows". If GDB comes with a graphical user interface (GUI) built in, then this option tells GDB to only use the command-line interface. If no GUI is available, this option has no effect.
`-windows`
`-w`
  If GDB includes a GUI, then this option requires it to be used if possible.
`-cd directory`
  Run GDB using directory as its working directory, instead of the current directory.
`-fullname`
`-f`
  GNU Emacs sets this option when it runs GDB as a subprocess. It tells GDB to output the full file name and line number in a standard, recognizable fashion each time a stack frame is displayed (which includes each time your program stops). This recognizable format looks like two `\032` characters, followed by the file name, line number and character position separated by colons, and a newline. The Emacs-to-GDB interface program uses the two `\032` characters as a signal to display the source code for the frame.
`-epoch`
  The Epoch Emacs-GDB interface sets this option when it runs GDB as a subprocess. It tells GDB to modify its print routines so as to allow Epoch to display values of expressions in a separate window.
`-annotate level`
  This option sets the annotation level inside GDB. Its effect is identical to using `set annotate level` (see Annotations). Annotation level controls how much information does GDB print together with its prompt, values of expressions, source lines, and other types of output. Level 0 is the normal, level 1 is for use when GDB is run as a subprocess of GNU Emacs, level 2 is the maximum annotation suitable for programs that control GDB.
`-async`
  Use the asynchronous event loop for the command-line interface. GDB processes all events, such as user keyboard input, via a special event loop. This allows GDB to accept and process user commands in parallel with the debugged process being run1, so you don't need to wait for control to return to GDB before you type the next command. (Note: as of version 5.0, the target side of the asynchronous operation is not yet in place, so `-async` does not work fully yet.)

  When the standard input is connected to a terminal device, GDB uses the asynchronous event loop by default, unless disabled by the `-noasync` option.

`-noasync`
  Disable the asynchronous event loop for the command-line interface.
`-baud bps`
`-b bps`
  Set the line speed (baud rate or bits per second) of any serial interface used by GDB for remote debugging.
`-tty device`
`-t device`
  Run using device for your program's standard input and output.
`-interpreter interp`
  Use the interpreter interp for interface with the controlling program or device. This option is meant to be set by programs which communicate with GDB using it as a back end. For example, `--interpreter=mi` causes GDB to use the gdbmi interface (see The GDB/MI Interface).
`-write`
  Open the executable and core files for both reading and writing. This is equivalent to the `set write on` command inside GDB (see Patching).
`-statistics`
  This option causes GDB to print statistics about time and memory usage after it completes each command and returns to the prompt.
`-version`
  This option causes GDB to print its version number and no-warranty blurb, and exit.

Node:Quitting GDB, Next:Shell Commands, Previous:Invoking GDB, Up:Invocation

## Quitting GDB

`quit [expression]`
`q`
  To exit GDB, use the `quit` command (abbreviated `q`), or type an end-of-file character (usually `C-d`). If you do not supply expression, GDB will terminate normally; otherwise it will terminate using the result of expression as the error code.

An interrupt (often `C-c`) does not exit from GDB, but rather terminates the action of any GDB command that is in progress and returns to GDB command level. It is safe to type the interrupt character at any time because GDB does not allow it to take effect until a time when it is safe.

If you have been using GDB to control an attached process or device, you can release it with the `detach` command (see Debugging an already-running process).

Node:Shell Commands, Previous:Quitting GDB, Up:Invocation

## Shell commands

If you need to execute occasional shell commands during your debugging session, there is no need to leave or suspend GDB; you can just use the `shell` command.

`shell command string`
  Invoke a standard shell to execute command string. If it exists, the environment variable `SHELL` determines which shell to run. Otherwise GDB uses the default shell (`/bin/sh` on Unix systems, `COMMAND.COM` on MS-DOS, etc.).

The utility `make` is often needed in development environments. You do not have to use the `shell` command for this purpose in GDB:

`make make-args`
  Execute the `make` program with the specified arguments. This is equivalent to `shell make make-args`.

Node:Commands, Next:Running, Previous:Invocation, Up:Top

# GDB Commands

You can abbreviate a GDB command to the first few letters of the command name, if that abbreviation is unambiguous; and you can repeat certain GDB commands by typing just <RET>. You can also use the <TAB> key to get GDB to fill out the rest of a word in a command (or to show you the alternatives available, if there is more than one possibility).

- Command Syntax: How to give commands to GDB
- Completion: Command completion
- Help: How to ask GDB for help

Node:Command Syntax, Next:Completion, Up:Commands

## Command syntax

A GDB command is a single line of input. There is no limit on how long it can be. It starts with a command name, which is followed by arguments whose meaning depends on the command name. For example, the command `step` accepts an argument which is the number of times to step, as in `step 5`. You can also use the `step` command with no arguments. Some commands do not allow any arguments. GDB command names may always be truncated if that abbreviation is unambiguous. Other possible command abbreviations are listed in the documentation for individual commands. In some cases, even ambiguous abbreviations are allowed; for example, `s` is specially defined as equivalent to `step` even though there are other commands whose names start with `s`. You can test abbreviations by using them as arguments to the `help` command.

A blank line as input to GDB (typing just <RET>) means to repeat the previous command. Certain commands (for example, `run`) will not repeat this way; these are commands whose unintentional repetition might cause trouble and which you are unlikely to want to repeat.

The `list` and `x` commands, when you repeat them with <RET>, construct new arguments rather than repeating exactly as typed. This permits easy scanning of source or memory. GDB can also use <RET> in another way: to partition lengthy output, in a way similar to the common utility `more` (see Screen size). Since it is easy to press one <RET> too many in this situation, GDB disables command repetition after any command that generates this sort of display.

Any text from a `#` to the end of the line is a comment; it does nothing. This is useful mainly in command files (see Command files).

Node:Completion, Next:Help, Previous:Command Syntax, Up:Commands

## Command completion

GDB can fill in the rest of a word in a command for you, if there is only one possibility; it can also show you what the valid possibilities are for the next word in a command, at any time. This works for GDB commands, GDB subcommands, and the names of symbols in your program.

Press the <TAB> key whenever you want GDB to fill out the rest of a word. If there is only one possibility, GDB fills in the word, and waits for you to finish the command (or press <RET> to enter it). For example, if you type

    (gdb) info bre <TAB>

GDB fills in the rest of the word `breakpoints`, since that is the only `info` subcommand beginning with `bre`:

    (gdb) info breakpoints

You can either press <RET> at this point, to run the `info breakpoints` command, or backspace and enter something else, if `breakpoints` does not look like the command you expected. (If you were sure you wanted `info breakpoints` in the first place, you might as well just type <RET> immediately after `info bre`, to exploit command abbreviations rather than command completion).

If there is more than one possibility for the next word when you press <TAB>, GDB sounds a bell. You can either supply more characters and try again, or just press <TAB> a second time; GDB displays all the possible completions for that word. For example, you might want to set a breakpoint on a subroutine whose name begins with `make_`, but when you type `b make_<TAB>` GDB just sounds the bell. Typing <TAB> again displays all the function names in your program that begin with those characters, for example:

    (gdb) b make_ <TAB>

    GDB sounds bell; press <TAB> again, to see:

    make_a_section_from_file     make_environ
    make_abs_section             make_function_type
    make_blockvector             make_pointer_type
    make_cleanup                 make_reference_type
    make_command                 make_symbol_completion_list
    (gdb) b make_

After displaying the available possibilities, GDB copies your partial input (`b make_` in the example) so you can finish the command.

If you just want to see the list of alternatives in the first place, you can press `M-?` rather than pressing <TAB> twice. `M-?` means `<META> ?`. You can type this either by holding down a key designated as the <META> shift on your keyboard (if there is one) while typing `?`, or as <ESC> followed by `?`.

Sometimes the string you need, while logically a "word", may contain parentheses or other characters that GDB normally excludes from its notion of a word. To permit word completion to work in this situation, you may enclose words in `'` (single quote marks) in GDB commands.

The most likely situation where you might need this is in typing the name of a C++ function. This is because C++ allows function overloading (multiple definitions of the same function, distinguished by argument type). For example, when you want to set a breakpoint you may need to distinguish whether you mean the version of `name` that takes an `int` parameter, `name(int)`, or the version that takes a `float` parameter, `name(float)`. To use the word-completion facilities in this situation, type a single quote `'` at the beginning of the function name. This alerts GDB that it may need to consider more information than usual when you press <TAB> or `M-?` to request word completion:

    (gdb) b 'bubble( M-?
    bubble(double,double)    bubble(int,int)
    (gdb) b 'bubble(

In some cases, GDB can tell that completing a name requires using quotes. When this happens, GDB inserts the quote for you (while completing as much as it can) if you do not type the quote in the first place:

    (gdb) b bub <TAB>

    GDB alters your input line to the following, and rings a bell:

    (gdb) b 'bubble(

In general, GDB can tell that a quote is needed (and inserts it) if you have not yet started typing the argument list when you ask for completion on an overloaded symbol.

For more information about overloaded functions, see C++ expressions. You can use the command `set overload-resolution off` to disable overload resolution; see GDB features for C++.

Node:Help, Previous:Completion, Up:Commands

## Getting help

You can always ask GDB itself for information on its commands, using the command `help`.

`help`
`h`
  You can use `help` (abbreviated `h`) with no arguments to display a short list of named classes of commands:

      (gdb) help
      List of classes of commands:

      aliases -- Aliases of other commands
      breakpoints -- Making program stop at certain points
      data -- Examining data
      files -- Specifying and examining files
      internals -- Maintenance commands
      obscure -- Obscure features
      running -- Running the program
      stack -- Examining the stack
      status -- Status inquiries
      support -- Support facilities
      tracepoints -- Tracing of program execution without

                     stopping the program
      user-defined -- User-defined commands

      Type "help" followed by a class name for a list of
      commands in that class.
      Type "help" followed by command name for full
      documentation.
      Command name abbreviations are allowed if unambiguous.
      (gdb)

`help class`
  Using one of the general help classes as an argument, you can get a list of the individual commands in that class. For example, here is the help display for the class `status`:

      (gdb) help status
      Status inquiries.

      List of commands:

      info -- Generic command for showing things
       about the program being debugged
      show -- Generic command for showing things
       about the debugger

      Type "help" followed by command name for full
      documentation.
      Command name abbreviations are allowed if unambiguous.
      (gdb)

`help command`
  With a command name as `help` argument, GDB displays a short paragraph on how to use that command.
`apropos args`
  The `apropos args` command searches through all of the GDB commands, and their documentation, for the regular expression specified in args. It prints out all matches found. For example:

      apropos reload

  results in:

      set symbol-reloading -- Set dynamic symbol table reloading
                                       multiple times in one run
      show symbol-reloading -- Show dynamic symbol table reloading
                                       multiple times in one run

`complete args`
  The `complete args` command lists all the possible completions for the beginning of a command. Use args to specify the beginning of the command you want completed. For example:

      complete i

  results in:

      if
      ignore
      info
      inspect

  This is intended for use by GNU Emacs.

In addition to `help`, you can use the GDB commands `info` and `show` to inquire about the state of your program, or the state of GDB itself. Each command supports many topics of inquiry; this manual introduces each of them in the appropriate context. The listings under `info` and under `show` in the Index point to all the sub-commands. See Index.

`info`
  This command (abbreviated `i`) is for describing the state of your program. For example, you can list the arguments given to your program with `info args`, list the registers currently in use with `info registers`, or list the breakpoints you have set with `info breakpoints`. You can get a complete list of the `info` sub-commands with `help info`.
`set`
  You can assign the result of an expression to an environment variable with `set`. For example, you can set the GDB prompt to a $-sign with `set prompt $`.
`show`
  In contrast to `info`, `show` is for describing the state of GDB itself. You can change most of the things you can `show`, by using the related command `set`; for example, you can control what number system is used for displays with `set radix`, or simply inquire which is currently in use with `show radix`.

  To display all the settable parameters and their current values, you can use `show` with no arguments; you may also use `info set`. Both commands produce the same display.

Here are three miscellaneous `show` subcommands, all of which are exceptional in lacking corresponding `set` commands:

`show version`
  Show what version of GDB is running. You should include this information in GDB bug-reports. If multiple versions of GDB are in use at your site, you may need to determine which version of GDB you are running; as GDB evolves, new commands are introduced, and old ones may wither away. Also, many system vendors ship variant versions of GDB, and there are variant versions of GDB in GNU/Linux distributions as well. The version number is the same as the one announced when you start GDB.
`show copying`
  Display information about permission for copying GDB.
`show warranty`
  Display the GNU "NO WARRANTY" statement, or a warranty, if your version of GDB comes with one.

Node:Running, Next:Stopping, Previous:Commands, Up:Top

# Running Programs Under GDB

When you run a program under GDB, you must first generate debugging information when you compile it.

You may start GDB with its arguments, if any, in an environment of your choice. If you are doing native debugging, you may redirect your program's input and output, debug an already running process, or kill a child process.

- Compilation: Compiling for debugging
- Starting: Starting your program
- Arguments: Your program's arguments
- Environment: Your program's environment

- Working Directory: Your program's working directory
- Input/Output: Your program's input and output
- Attach: Debugging an already-running process
- Kill Process: Killing the child process

- Threads: Debugging programs with multiple threads
- Processes: Debugging programs with multiple processes

Node:Compilation, Next:Starting, Up:Running

## Compiling for debugging

In order to debug a program effectively, you need to generate debugging information when you compile it. This debugging information is stored in the object file; it describes the data type of each variable or function and the correspondence between source line numbers and addresses in the executable code.

To request debugging information, specify the `-g` option when you run the compiler.

Many C compilers are unable to handle the `-g` and `-O` options together. Using those compilers, you cannot generate optimized executables containing debugging information. GCC, the GNU C compiler, supports `-g` with or without `-O`, making it possible to debug optimized code. We recommend that you always use `-g` whenever you compile a program. You may think your program is correct, but there is no sense in pushing your luck.

When you debug a program compiled with `-g -O`, remember that the optimizer is rearranging your code; the debugger shows you what is really there. Do not be too surprised when the execution path does not exactly match your source file! An extreme example: if you define a variable, but never use it, GDB never sees that variable--because the compiler optimizes it out of existence.

Some things do not work as well with `-g -O` as with just `-g`, particularly on machines with instruction scheduling. If in doubt, recompile with `-g` alone, and if this fixes the problem, please report it to us as a bug (including a test case!).

Older versions of the GNU C compiler permitted a variant option `-gg` for debugging information. GDB no longer supports this format; if your GNU C compiler has this option, do not use it.

Node:Starting, Next:Arguments, Previous:Compilation, Up:Running

## Starting your program

`run`
`r`
  Use the `run` command to start your program under GDB. You must first specify the program name (except on VxWorks) with an argument to GDB (see Getting In and Out of GDB), or by using the `file` or `exec-file` command (see Commands to specify files).

If you are running your program in an execution environment that supports processes, `run` creates an inferior process and makes that process run your program. (In environments without processes, `run` jumps to the start of your program.)

The execution of a program is affected by certain information it receives from its superior. GDB provides ways to specify this information, which you must do before starting your program. (You can change it after starting your program, but such changes only affect your program the next time you start it.) This information may be divided into four categories:

The arguments.
  Specify the arguments to give your program as the arguments of the `run` command. If a shell is available on your target, the shell is used to pass the arguments, so that you may use normal conventions (such as wildcard expansion or variable substitution) in describing the arguments. In Unix systems, you can control which shell is used with the `SHELL` environment variable. See Your program's arguments.
The environment.
  Your program normally inherits its environment from GDB, but you can use the GDB commands `set environment` and `unset environment` to change parts of the environment that affect your program. See Your program's environment.
The working directory.
  Your program inherits its working directory from GDB. You can set the GDB working directory with the `cd` command in GDB. See Your program's working directory.
The standard input and output.
  Your program normally uses the same device for standard input and standard output as GDB is using. You can redirect input and output in the `run` command line, or you can use the `tty` command to set a different device for your program. See Your program's input and output.

  Warning: While input and output redirection work, you cannot use pipes to pass the output of the program you are debugging to another program; if you attempt this, GDB is likely to wind up debugging the wrong program.

When you issue the `run` command, your program begins to execute immediately. See Stopping and continuing, for discussion of how to arrange for your program to stop. Once your program has stopped, you may call functions in your program, using the `print` or `call` commands. See Examining Data.

If the modification time of your symbol file has changed since the last time GDB read its symbols, GDB discards its symbol table, and reads it again. When it does this, GDB tries to retain your current breakpoints.

Node:Arguments, Next:Environment, Previous:Starting, Up:Running

## Your program's arguments

The arguments to your program can be specified by the arguments of the `run` command. They are passed to a shell, which expands wildcard characters and performs redirection of I/O, and thence to your program. Your `SHELL` environment variable (if it exists) specifies what shell GDB uses. If you do not define `SHELL`, GDB uses the default shell (`/bin/sh` on Unix).

On non-Unix systems, the program is usually invoked directly by GDB, which emulates I/O redirection via the appropriate system calls, and the wildcard characters are expanded by the startup code of the program, not by the shell.

`run` with no arguments uses the same arguments used by the previous `run`, or those set by the `set args` command.

`set args`
  Specify the arguments to be used the next time your program is run. If `set args` has no arguments, `run` executes your program with no arguments. Once you have run your program with arguments, using `set args` before the next `run` is the only way to run it again without arguments.
`show args`
  Show the arguments to give your program when it is started.

Node:Environment, Next:Working Directory, Previous:Arguments, Up:Running

## Your program's environment

The environment consists of a set of environment variables and their values. Environment variables conventionally record such things as your user name, your home directory, your terminal type, and your search path for programs to run. Usually you set up environment variables with the shell and they are inherited by all the other programs you run. When debugging, it can be useful to try running your program with a modified environment without having to start GDB over again.

`path directory`
  Add directory to the front of the `PATH` environment variable (the search path for executables), for both GDB and your program. You may specify several directory names, separated by whitespace or by a system-dependent separator character (`:` on Unix, `;` on MS-DOS and MS-Windows). If directory is already in the path, it is moved to the front, so it is searched sooner.

  You can use the string `$cwd` to refer to whatever is the current working directory at the time GDB searches the path. If you use `.` instead, it refers to the directory where you executed the `path` command. GDB replaces `.` in the directory argument (with the current path) before adding directory to the search path.

`show paths`
  Display the list of search paths for executables (the `PATH` environment variable).
`show environment [varname]`
  Print the value of environment variable varname to be given to your program when it starts. If you do not supply varname, print the names and values of all environment variables to be given to your program. You can abbreviate `environment` as `env`.
`set environment varname [=value]`
  Set environment variable varname to value. The value changes for your program only, not for GDB itself. value may be any string; the values of environment variables are just strings, and any interpretation is supplied by your program itself. The value parameter is optional; if it is eliminated, the variable is set to a null value.

  For example, this command:

      set env USER = foo

  tells the debugged program, when subsequently run, that its user is named `foo`. (The spaces around `=` are used for clarity here; they are not actually required.)

`unset environment varname`
  Remove variable varname from the environment to be passed to your program. This is different from `set env varname =`; `unset environment` removes the variable from the environment, rather than assigning it an empty value.

Warning: On Unix systems, GDB runs your program using the shell indicated by your `SHELL` environment variable if it exists (or `/bin/sh` if not). If your `SHELL` variable names a shell that runs an initialization file--such as `.cshrc` for C-shell, or `.bashrc` for BASH--any variables you set in that file affect your program. You may wish to move setting of environment variables to files that are only run when you sign on, such as `.login` or `.profile`.

Node:Working Directory, Next:Input/Output, Previous:Environment, Up:Running

## Your program's working directory

Each time you start your program with `run`, it inherits its working directory from the current working directory of GDB. The GDB working directory is initially whatever it inherited from its parent process (typically the shell), but you can specify a new working directory in GDB with the `cd` command.

The GDB working directory also serves as a default for the commands that specify files for GDB to operate on. See Commands to specify files.

`cd directory`
  Set the GDB working directory to directory.
`pwd`
  Print the GDB working directory.

Node:Input/Output, Next:Attach, Previous:Working Directory, Up:Running

## Your program's input and output

By default, the program you run under GDB does input and output to the same terminal that GDB uses. GDB switches the terminal to its own terminal modes to interact with you, but it records the terminal modes your program was using and switches back to them when you continue running your program.

`info terminal`
  Displays information recorded by GDB about the terminal modes your program is using.

You can redirect your program's input and/or output using shell redirection with the `run` command. For example,

    run > outfile

starts your program, diverting its output to the file `outfile`.

Another way to specify where your program should do input and output is with the `tty` command. This command accepts a file name as argument, and causes this file to be the default for future `run` commands. It also resets the controlling terminal for the child process, for future `run` commands. For example,

    tty /dev/ttyb

directs that processes started with subsequent `run` commands default to do input and output on the terminal `/dev/ttyb` and have that as their controlling terminal.

An explicit redirection in `run` overrides the `tty` command's effect on the input/output device, but not its effect on the controlling terminal.

When you use the `tty` command or redirect input in the `run` command, only the input for your program is affected. The input for GDB still comes from your terminal.

Node:Attach, Next:Kill Process, Previous:Input/Output, Up:Running

## Debugging an already-running process

`attach process-id`
  This command attaches to a running process--one that was started outside GDB. (`info files` shows your active targets.) The command takes as argument a process ID. The usual way to find out the process-id of a Unix process is with the `ps` utility, or with the `jobs -l` shell command.

  `attach` does not repeat if you press <RET> a second time after executing the command.

To use `attach`, your program must be running in an environment which supports processes; for example, `attach` does not work for programs on bare-board targets that lack an operating system. You must also have permission to send the process a signal.

When you use `attach`, the debugger finds the program running in the process first by looking in the current working directory, then (if the program is not found) by using the source file search path (see Specifying source directories). You can also use the `file` command to load the program. See Commands to Specify Files.

The first thing GDB does after arranging to debug the specified process is to stop it. You can examine and modify an attached process with all the GDB commands that are ordinarily available when you start processes with `run`. You can insert breakpoints; you can step and continue; you can modify storage. If you would rather the process continue running, you may use the `continue` command after attaching GDB to the process.

`detach`
  When you have finished debugging the attached process, you can use the `detach` command to release it from GDB control. Detaching the process continues its execution. After the `detach` command, that process and GDB become completely independent once more, and you are ready to `attach` another process or start one with `run`. `detach` does not repeat if you press <RET> again after executing the command.

If you exit GDB or use the `run` command while you have an attached process, you kill that process. By default, GDB asks for confirmation if you try to do either of these things; you can control whether or not you need to confirm by using the `set confirm` command (see Optional warnings and messages).

Node:Kill Process, Next:Threads, Previous:Attach, Up:Running

## Killing the child process

`kill`
  Kill the child process in which your program is running under GDB.

This command is useful if you wish to debug a core dump instead of a running process. GDB ignores any core dump file while your program is running.

On some operating systems, a program cannot be executed outside GDB while you have breakpoints set on it inside GDB. You can use the `kill` command in this situation to permit running your program outside the debugger.

The `kill` command is also useful if you wish to recompile and relink your program, since on many systems it is impossible to modify an executable file while it is running in a process. In this case, when you next type `run`, GDB notices that the file has changed, and reads the symbol table again (while trying to preserve your current breakpoint settings).

Node:Threads, Next:Processes, Previous:Kill Process, Up:Running

## Debugging programs with multiple threads

In some operating systems, such as HP-UX and Solaris, a single program may have more than one thread of execution. The precise semantics of threads differ from one operating system to another, but in general the threads of a single program are akin to multiple processes--except that they share one address space (that is, they can all examine and modify the same variables). On the other hand, each thread has its own registers and execution stack, and perhaps private memory. GDB provides these facilities for debugging multi-thread programs:

- automatic notification of new threads
- `thread threadno`, a command to switch among threads
- `info threads`, a command to inquire about existing threads
- `thread apply [threadno] [all] args`, a command to apply a command to a list of threads
- thread-specific breakpoints

> Warning: These facilities are not yet available on every GDB configuration where the operating system supports threads. If your GDB does not support threads, these commands have no effect. For example, a system without thread support shows no output from `info threads`, and always rejects the `thread` command, like this:

>     (gdb) info threads
>     (gdb) thread 1
>     Thread ID 1 not known.  Use the "info threads" command to
>     see the IDs of currently known threads.

The GDB thread debugging facility allows you to observe all threads while your program runs--but whenever GDB takes control, one thread in particular is always the focus of debugging. This thread is called the current thread. Debugging commands show program information from the perspective of the current thread.

Whenever GDB detects a new thread in your program, it displays the target system's identification for the thread with a message in the form `[New systag]`. systag is a thread identifier whose form varies depending on the particular system. For example, on LynxOS, you might see

    [New process 35 thread 27]

when GDB notices a new thread. In contrast, on an SGI system, the systag is simply something like `process 368`, with no further qualifier.

For debugging purposes, GDB associates its own thread number--always a single integer--with each thread in your program.

`info threads`
  Display a summary of all threads currently in your program. GDB displays for each thread (in this order):
  1. the thread number assigned by GDB
  2. the target system's thread identifier (systag)
  3. the current stack frame summary for that thread

  An asterisk `*` to the left of the GDB thread number indicates the current thread.

  For example,

    (gdb) info threads
      3 process 35 thread 27  0x34e5 in sigpause ()
      2 process 35 thread 23  0x34e5 in sigpause ()
    * 1 process 35 thread 13  main (argc=1, argv=0x7ffffff8)
        at threadtest.c:68

On HP-UX systems:

For debugging purposes, GDB associates its own thread number--a small integer assigned in thread-creation order--with each thread in your program.

Whenever GDB detects a new thread in your program, it displays both GDB's thread number and the target system's identification for the thread with a message in the form `[New systag]`. systag is a thread identifier whose form varies depending on the particular system. For example, on HP-UX, you see

    [New thread 2 (system thread 26594)]

when GDB notices a new thread.

`info threads`
  Display a summary of all threads currently in your program. GDB displays for each thread (in this order):
  1. the thread number assigned by GDB
  2. the target system's thread identifier (systag)
  3. the current stack frame summary for that thread

  An asterisk `*` to the left of the GDB thread number indicates the current thread.

  For example,

    (gdb) info threads
        * 3 system thread 26607  worker (wptr=0x7b09c318 "@") \

                                   at quicksort.c:137
          2 system thread 26606  0x7b0030d8 in __ksleep () \

                                   from /usr/lib/libc.2
          1 system thread 27905  0x7b003498 in _brk () \

                                   from /usr/lib/libc.2

`thread threadno`
  Make thread number threadno the current thread. The command argument threadno is the internal GDB thread number, as shown in the first field of the `info threads` display. GDB responds by displaying the system identifier of the thread you selected, and its current stack frame summary:

      (gdb) thread 2
      [Switching to process 35 thread 23]
      0x34e5 in sigpause ()

  As with the `[New ...]` message, the form of the text after `Switching to` depends on your system's conventions for identifying threads.

`thread apply [threadno] [all] args`
  The `thread apply` command allows you to apply a command to one or more threads. Specify the numbers of the threads that you want affected with the command argument threadno. threadno is the internal GDB thread number, as shown in the first field of the `info threads` display. To apply a command to all threads, use `thread apply all` args.

Whenever GDB stops your program, due to a breakpoint or a signal, it automatically selects the thread where that breakpoint or signal happened. GDB alerts you to the context switch with a message of the form `[Switching to systag]` to identify the thread.

See Stopping and starting multi-thread programs, for more information about how GDB behaves when you stop and start programs with multiple threads.

See Setting watchpoints, for information about watchpoints in programs with multiple threads.

Node:Processes, Previous:Threads, Up:Running

## Debugging programs with multiple processes

On most systems, GDB has no special support for debugging programs which create additional processes using the `fork` function. When a program forks, GDB will continue to debug the parent process and the child process will run unimpeded. If you have set a breakpoint in any code which the child then executes, the child will get a `SIGTRAP` signal which (unless it catches the signal) will cause it to terminate.

However, if you want to debug the child process there is a workaround which isn't too painful. Put a call to `sleep` in the code which the child process executes after the fork. It may be useful to sleep only if a certain environment variable is set, or a certain file exists, so that the delay need not occur when you don't want to run GDB on the child. While the child is sleeping, use the `ps` program to get its process ID. Then tell GDB (a new invocation of GDB if you are also debugging the parent process) to attach to the child process (see Attach). From that point on you can debug the child process just like any other process which you attached to.

On HP-UX (11.x and later only?), GDB provides support for debugging programs that create additional processes using the `fork` or `vfork` function.

By default, when a program forks, GDB will continue to debug the parent process and the child process will run unimpeded.

If you want to follow the child process instead of the parent process, use the command `set follow-fork-mode`.

`set follow-fork-mode mode`
  Set the debugger response to a program call of `fork` or `vfork`. A call to `fork` or `vfork` creates a new process. The mode can be:
  `parent`
    The original process is debugged after a fork. The child process runs unimpeded. This is the default.
  `child`
    The new process is debugged after a fork. The parent process runs unimpeded.
  `ask`
    The debugger will ask for one of the above choices.
`show follow-fork-mode`
  Display the current debugger response to a `fork` or `vfork` call.

If you ask to debug a child process and a `vfork` is followed by an `exec`, GDB executes the new target up to the first breakpoint in the new target. If you have a breakpoint set on `main` in your original program, the breakpoint will also be set on the child process's `main`.

When a child process is spawned by `vfork`, you cannot debug the child or parent until an `exec` call completes.

If you issue a `run` command to GDB after an `exec` call executes, the new target restarts. To restart the parent process, use the `file` command with the parent executable name as its argument.

You can use the `catch` command to make GDB stop whenever a `fork`, `vfork`, or `exec` call is made. See Setting catchpoints.

Node:Stopping, Next:Stack, Previous:Running, Up:Top

# Stopping and Continuing

The principal purposes of using a debugger are so that you can stop your program before it terminates; or so that, if your program runs into trouble, you can investigate and find out why.

Inside GDB, your program may stop for any of several reasons, such as a signal, a breakpoint, or reaching a new line after a GDB command such as `step`. You may then examine and change variables, set new breakpoints or remove old ones, and then continue execution. Usually, the messages shown by GDB provide ample explanation of the status of your program--but you can also explicitly request this information at any time.

`info program`
  Display information about the status of your program: whether it is running or not, what process it is, and why it stopped.

- Breakpoints: Breakpoints, watchpoints, and catchpoints
- Continuing and Stepping: Resuming execution
- Signals: Signals
- Thread Stops: Stopping and starting multi-thread programs

Node:Breakpoints, Next:Continuing and Stepping, Up:Stopping

## Breakpoints, watchpoints, and catchpoints

A breakpoint makes your program stop whenever a certain point in the program is reached. For each breakpoint, you can add conditions to control in finer detail whether your program stops. You can set breakpoints with the `break` command and its variants (see Setting breakpoints), to specify the place where your program should stop by line number, function name or exact address in the program.

In HP-UX, SunOS 4.x, SVR4, and Alpha OSF/1 configurations, you can set breakpoints in shared libraries before the executable is run. There is a minor limitation on HP-UX systems: you must wait until the executable is run in order to set breakpoints in shared library routines that are not called directly by the program (for example, routines that are arguments in a `pthread_create` call).

A watchpoint is a special breakpoint that stops your program when the value of an expression changes. You must use a different command to set watchpoints (see Setting watchpoints), but aside from that, you can manage a watchpoint like any other breakpoint: you enable, disable, and delete both breakpoints and watchpoints using the same commands.

You can arrange to have values from your program displayed automatically whenever GDB stops at a breakpoint. See Automatic display.

A catchpoint is another special breakpoint that stops your program when a certain kind of event occurs, such as the throwing of a C++ exception or the loading of a library. As with watchpoints, you use a different command to set a catchpoint (see Setting catchpoints), but aside from that, you can manage a catchpoint like any other breakpoint. (To stop when your program receives a signal, use the `handle` command; see Signals.) GDB assigns a number to each breakpoint, watchpoint, or catchpoint when you create it; these numbers are successive integers starting with one. In many of the commands for controlling various features of breakpoints you use the breakpoint number to say which breakpoint you want to change. Each breakpoint may be enabled or disabled; if disabled, it has no effect on your program until you enable it again.

Some GDB commands accept a range of breakpoints on which to operate. A breakpoint range is either a single breakpoint number, like `5`, or two such numbers, in increasing order, separated by a hyphen, like `5-7`. When a breakpoint range is given to a command, all breakpoint in that range are operated on.

- Set Breaks: Setting breakpoints
- Set Watchpoints: Setting watchpoints
- Set Catchpoints: Setting catchpoints
- Delete Breaks: Deleting breakpoints
- Disabling: Disabling breakpoints
- Conditions: Break conditions
- Break Commands: Breakpoint command lists
- Breakpoint Menus: Breakpoint menus
- Error in Breakpoints: ``Cannot insert breakpoints''

Node:Set Breaks, Next:Set Watchpoints, Up:Breakpoints

### Setting breakpoints

Breakpoints are set with the `break` command (abbreviated `b`). The debugger convenience variable `$bpnum` records the number of the breakpoints you've set most recently; see Convenience variables, for a discussion of what you can do with convenience variables.

You have several ways to say where the breakpoint should go.

`break function`
  Set a breakpoint at entry to function function. When using source languages that permit overloading of symbols, such as C++, function may refer to more than one possible place to break. See Breakpoint menus, for a discussion of that situation.
`break +offset`
`break -offset`
  Set a breakpoint some number of lines forward or back from the position at which execution stopped in the currently selected stack frame. (See Frames, for a description of stack frames.)
`break linenum`
  Set a breakpoint at line linenum in the current source file. The current source file is the last file whose source text was printed. The breakpoint will stop your program just before it executes any of the code on that line.
`break filename:linenum`
  Set a breakpoint at line linenum in source file filename.
`break filename:function`
  Set a breakpoint at entry to function function found in file filename. Specifying a file name as well as a function name is superfluous except when multiple files contain similarly named functions.
`break *address`
  Set a breakpoint at address address. You can use this to set breakpoints in parts of your program which do not have debugging information or source files.
`break`
  When called without any arguments, `break` sets a breakpoint at the next instruction to be executed in the selected stack frame (see Examining the Stack). In any selected frame but the innermost, this makes your program stop as soon as control returns to that frame. This is similar to the effect of a `finish` command in the frame inside the selected frame--except that `finish` does not leave an active breakpoint. If you use `break` without an argument in the innermost frame, GDB stops the next time it reaches the current location; this may be useful inside loops. GDB normally ignores breakpoints when it resumes execution, until at least one instruction has been executed. If it did not do this, you would be unable to proceed past a breakpoint without first disabling the breakpoint. This rule applies whether or not the breakpoint already existed when your program stopped.
`break ... if cond`
  Set a breakpoint with condition cond; evaluate the expression cond each time the breakpoint is reached, and stop only if the value is nonzero--that is, if cond evaluates as true. `...` stands for one of the possible arguments described above (or no argument) specifying where to break. See Break conditions, for more information on breakpoint conditions.
`tbreak args`
  Set a breakpoint enabled only for one stop. args are the same as for the `break` command, and the breakpoint is set in the same way, but the breakpoint is automatically deleted after the first time your program stops there. See Disabling breakpoints.
`hbreak args`
  Set a hardware-assisted breakpoint. args are the same as for the `break` command and the breakpoint is set in the same way, but the breakpoint requires hardware support and some target hardware may not have this support. The main purpose of this is EPROM/ROM code debugging, so you can set a breakpoint at an instruction without changing the instruction. This can be used with the new trap-generation provided by SPARClite DSU and some x86-based targets. These targets will generate traps when a program accesses some data or instruction address that is assigned to the debug registers. However the hardware breakpoint registers can take a limited number of breakpoints. For example, on the DSU, only two data breakpoints can be set at a time, and GDB will reject this command if more than two are used. Delete or disable unused hardware breakpoints before setting new ones (see Disabling). See Break conditions.
`thbreak args`
  Set a hardware-assisted breakpoint enabled only for one stop. args are the same as for the `hbreak` command and the breakpoint is set in the same way. However, like the `tbreak` command, the breakpoint is automatically deleted after the first time your program stops there. Also, like the `hbreak` command, the breakpoint requires hardware support and some target hardware may not have this support. See Disabling breakpoints. See also Break conditions.
`rbreak regex`
  Set breakpoints on all functions matching the regular expression regex. This command sets an unconditional breakpoint on all matches, printing a list of all breakpoints it set. Once these breakpoints are set, they are treated just like the breakpoints set with the `break` command. You can delete them, disable them, or make them conditional the same way as any other breakpoint.

  The syntax of the regular expression is the standard one used with tools like `grep`. Note that this is different from the syntax used by shells, so for instance `foo*` matches all functions that include an `fo` followed by zero or more `o`s. There is an implicit `.*` leading and trailing the regular expression you supply, so to match only functions that begin with `foo`, use `^foo`.

  When debugging C++ programs, `rbreak` is useful for setting breakpoints on overloaded functions that are not members of any special classes.

`info breakpoints [n]`
`info break [n]`
`info watchpoints [n]`
  Print a table of all breakpoints, watchpoints, and catchpoints set and not deleted, with the following columns for each breakpoint:
  Breakpoint Numbers
  Type
    Breakpoint, watchpoint, or catchpoint.
  Disposition
    Whether the breakpoint is marked to be disabled or deleted when hit.
  Enabled or Disabled
    Enabled breakpoints are marked with `y`. `n` marks breakpoints that are not enabled.
  Address
    Where the breakpoint is in your program, as a memory address.
  What
    Where the breakpoint is in the source for your program, as a file and line number.

  If a breakpoint is conditional, `info break` shows the condition on the line following the affected breakpoint; breakpoint commands, if any, are listed after that.

  `info break` with a breakpoint number n as argument lists only that breakpoint. The convenience variable `$_` and the default examining-address for the `x` command are set to the address of the last breakpoint listed (see Examining memory).

  `info break` displays a count of the number of times the breakpoint has been hit. This is especially useful in conjunction with the `ignore` command. You can ignore a large number of breakpoint hits, look at the breakpoint info to see how many times the breakpoint was hit, and then run again, ignoring one less than that number. This will get you quickly to the last hit of that breakpoint.

GDB allows you to set any number of breakpoints at the same place in your program. There is nothing silly or meaningless about this. When the breakpoints are conditional, this is even useful (see Break conditions). GDB itself sometimes sets breakpoints in your program for special purposes, such as proper handling of `longjmp` (in C programs). These internal breakpoints are assigned negative numbers, starting with `-1`; `info breakpoints` does not display them.

You can see these breakpoints with the GDB maintenance command `maint info breakpoints`.

`maint info breakpoints`
  Using the same format as `info breakpoints`, display both the breakpoints you've set explicitly, and those GDB is using for internal purposes. Internal breakpoints are shown with negative breakpoint numbers. The type column identifies what kind of breakpoint is shown:
  `breakpoint`
    Normal, explicitly set breakpoint.
  `watchpoint`
    Normal, explicitly set watchpoint.
  `longjmp`
    Internal breakpoint, used to handle correctly stepping through `longjmp` calls.
  `longjmp resume`
    Internal breakpoint at the target of a `longjmp`.
  `until`
    Temporary internal breakpoint used by the GDB `until` command.
  `finish`
    Temporary internal breakpoint used by the GDB `finish` command.
  `shlib events`
    Shared library events.

Node:Set Watchpoints, Next:Set Catchpoints, Previous:Set Breaks, Up:Breakpoints

### Setting watchpoints

You can use a watchpoint to stop execution whenever the value of an expression changes, without having to predict a particular place where this may happen.

Depending on your system, watchpoints may be implemented in software or hardware. GDB does software watchpointing by single-stepping your program and testing the variable's value each time, which is hundreds of times slower than normal execution. (But this may still be worth it, to catch errors where you have no clue what part of your program is the culprit.)

On some systems, such as HP-UX, Linux and some other x86-based targets, GDB includes support for hardware watchpoints, which do not slow down the running of your program.

`watch expr`
  Set a watchpoint for an expression. GDB will break when expr is written into by the program and its value changes.
`rwatch expr`
  Set a watchpoint that will break when watch expr is read by the program.
`awatch expr`
  Set a watchpoint that will break when expr is either read or written into by the program.
`info watchpoints`
  This command prints a list of watchpoints, breakpoints, and catchpoints; it is the same as `info break`.

GDB sets a hardware watchpoint if possible. Hardware watchpoints execute very quickly, and the debugger reports a change in value at the exact instruction where the change occurs. If GDB cannot set a hardware watchpoint, it sets a software watchpoint, which executes more slowly and reports the change in value at the next statement, not the instruction, after the change occurs.

When you issue the `watch` command, GDB reports

    Hardware watchpoint num: expr

if it was able to set a hardware watchpoint.

Currently, the `awatch` and `rwatch` commands can only set hardware watchpoints, because accesses to data that don't change the value of the watched expression cannot be detected without examining every instruction as it is being executed, and GDB does not do that currently. If GDB finds that it is unable to set a hardware breakpoint with the `awatch` or `rwatch` command, it will print a message like this:

    Expression cannot be implemented with read/access watchpoint.

Sometimes, GDB cannot set a hardware watchpoint because the data type of the watched expression is wider than what a hardware watchpoint on the target machine can handle. For example, some systems can only watch regions that are up to 4 bytes wide; on such systems you cannot set hardware watchpoints for an expression that yields a double-precision floating-point number (which is typically 8 bytes wide). As a work-around, it might be possible to break the large region into a series of smaller ones and watch them with separate watchpoints.

If you set too many hardware watchpoints, GDB might be unable to insert all of them when you resume the execution of your program. Since the precise number of active watchpoints is unknown until such time as the program is about to be resumed, GDB might not be able to warn you about this when you set the watchpoints, and the warning will be printed only when the program is resumed:

    Hardware watchpoint num: Could not insert watchpoint

If this happens, delete or disable some of the watchpoints.

The SPARClite DSU will generate traps when a program accesses some data or instruction address that is assigned to the debug registers. For the data addresses, DSU facilitates the `watch` command. However the hardware breakpoint registers can only take two data watchpoints, and both watchpoints must be the same kind. For example, you can set two watchpoints with `watch` commands, two with `rwatch` commands, or two with `awatch` commands, but you cannot set one watchpoint with one command and the other with a different command. GDB will reject the command if you try to mix watchpoints. Delete or disable unused watchpoint commands before setting new ones.

If you call a function interactively using `print` or `call`, any watchpoints you have set will be inactive until GDB reaches another kind of breakpoint or the call completes. GDB automatically deletes watchpoints that watch local (automatic) variables, or expressions that involve such variables, when they go out of scope, that is, when the execution leaves the block in which these variables were defined. In particular, when the program being debugged terminates, all local variables go out of scope, and so only watchpoints that watch global variables remain set. If you rerun the program, you will need to set all such watchpoints again. One way of doing that would be to set a code breakpoint at the entry to the `main` function and when it breaks, set all the watchpoints.

> Warning: In multi-thread programs, watchpoints have only limited usefulness. With the current watchpoint implementation, GDB can only watch the value of an expression in a single thread. If you are confident that the expression can only change due to the current thread's activity (and if you are also confident that no other thread can become current), then you can use watchpoints as usual. However, GDB may not notice when a non-current thread's activity changes the expression.

> HP-UX Warning: In multi-thread programs, software watchpoints have only limited usefulness. If GDB creates a software watchpoint, it can only watch the value of an expression in a single thread. If you are confident that the expression can only change due to the current thread's activity (and if you are also confident that no other thread can become current), then you can use software watchpoints as usual. However, GDB may not notice when a non-current thread's activity changes the expression. (Hardware watchpoints, in contrast, watch an expression in all threads.)

Node:Set Catchpoints, Next:Delete Breaks, Previous:Set Watchpoints, Up:Breakpoints

### Setting catchpoints

You can use catchpoints to cause the debugger to stop for certain kinds of program events, such as C++ exceptions or the loading of a shared library. Use the `catch` command to set a catchpoint.

`catch event`
  Stop when event occurs. event can be any of the following:
  `throw`
    The throwing of a C++ exception.
  `catch`
    The catching of a C++ exception.
  `exec`
    A call to `exec`. This is currently only available for HP-UX.
  `fork`
    A call to `fork`. This is currently only available for HP-UX.
  `vfork`
    A call to `vfork`. This is currently only available for HP-UX.
  `load`
  `load libname`
    The dynamic loading of any shared library, or the loading of the library libname. This is currently only available for HP-UX.
  `unload`
  `unload libname`
    The unloading of any dynamically loaded shared library, or the unloading of the library libname. This is currently only available for HP-UX.
`tcatch event`
  Set a catchpoint that is enabled only for one stop. The catchpoint is automatically deleted after the first time the event is caught.

Use the `info break` command to list the current catchpoints.

There are currently some limitations to C++ exception handling (`catch throw` and `catch catch`) in GDB:

- If you call a function interactively, GDB normally returns control to you when the function has finished executing. If the call raises an exception, however, the call may bypass the mechanism that returns control to you and cause your program either to abort or to simply continue running until it hits a breakpoint, catches a signal that GDB is listening for, or exits. This is the case even if you set a catchpoint for the exception; catchpoints on exceptions are disabled within interactive calls.
- You cannot raise an exception interactively.
- You cannot install an exception handler interactively.

Sometimes `catch` is not the best way to debug exception handling: if you need to know exactly where an exception is raised, it is better to stop before the exception handler is called, since that way you can see the stack before any unwinding takes place. If you set a breakpoint in an exception handler instead, it may not be easy to find out where the exception was raised.

To stop just before an exception handler is called, you need some knowledge of the implementation. In the case of GNU C++, exceptions are raised by calling a library function named `__raise_exception` which has the following ANSI C interface:

        /* addr is where the exception identifier is stored.
           id is the exception identifier.  */
        void __raise_exception (void **addr, void *id);

To make the debugger catch all exceptions before any stack unwinding takes place, set a breakpoint on `__raise_exception` (see Breakpoints; watchpoints; and exceptions).

With a conditional breakpoint (see Break conditions) that depends on the value of id, you can stop your program when a specific exception is raised. You can use multiple conditional breakpoints to stop your program when any of a number of exceptions are raised.

Node:Delete Breaks, Next:Disabling, Previous:Set Catchpoints, Up:Breakpoints

### Deleting breakpoints

It is often necessary to eliminate a breakpoint, watchpoint, or catchpoint once it has done its job and you no longer want your program to stop there. This is called deleting the breakpoint. A breakpoint that has been deleted no longer exists; it is forgotten.

With the `clear` command you can delete breakpoints according to where they are in your program. With the `delete` command you can delete individual breakpoints, watchpoints, or catchpoints by specifying their breakpoint numbers.

It is not necessary to delete a breakpoint to proceed past it. GDB automatically ignores breakpoints on the first instruction to be executed when you continue execution without changing the execution address.

`clear`
  Delete any breakpoints at the next instruction to be executed in the selected stack frame (see Selecting a frame). When the innermost frame is selected, this is a good way to delete a breakpoint where your program just stopped.
`clear function`
`clear filename:function`
  Delete any breakpoints set at entry to the function function.
`clear linenum`
`clear filename:linenum`
  Delete any breakpoints set at or within the code of the specified line.
`delete [breakpoints] [range...]`
  Delete the breakpoints, watchpoints, or catchpoints of the breakpoint ranges specified as arguments. If no argument is specified, delete all breakpoints (GDB asks confirmation, unless you have `set confirm off`). You can abbreviate this command as `d`.

Node:Disabling, Next:Conditions, Previous:Delete Breaks, Up:Breakpoints

### Disabling breakpoints

Rather than deleting a breakpoint, watchpoint, or catchpoint, you might prefer to disable it. This makes the breakpoint inoperative as if it had been deleted, but remembers the information on the breakpoint so that you can enable it again later.

You disable and enable breakpoints, watchpoints, and catchpoints with the `enable` and `disable` commands, optionally specifying one or more breakpoint numbers as arguments. Use `info break` or `info watch` to print a list of breakpoints, watchpoints, and catchpoints if you do not know which numbers to use.

A breakpoint, watchpoint, or catchpoint can have any of four different states of enablement:

- Enabled. The breakpoint stops your program. A breakpoint set with the `break` command starts out in this state.
- Disabled. The breakpoint has no effect on your program.
- Enabled once. The breakpoint stops your program, but then becomes disabled.
- Enabled for deletion. The breakpoint stops your program, but immediately after it does so it is deleted permanently. A breakpoint set with the `tbreak` command starts out in this state.

You can use the following commands to enable or disable breakpoints, watchpoints, and catchpoints:

`disable [breakpoints] [range...]`
  Disable the specified breakpoints--or all breakpoints, if none are listed. A disabled breakpoint has no effect but is not forgotten. All options such as ignore-counts, conditions and commands are remembered in case the breakpoint is enabled again later. You may abbreviate `disable` as `dis`.
`enable [breakpoints] [range...]`
  Enable the specified breakpoints (or all defined breakpoints). They become effective once again in stopping your program.
`enable [breakpoints] once range...`
  Enable the specified breakpoints temporarily. GDB disables any of these breakpoints immediately after stopping your program.
`enable [breakpoints] delete range...`
  Enable the specified breakpoints to work once, then die. GDB deletes any of these breakpoints as soon as your program stops there.

Except for a breakpoint set with `tbreak` (see Setting breakpoints), breakpoints that you set are initially enabled; subsequently, they become disabled or enabled only when you use one of the commands above. (The command `until` can set and delete a breakpoint of its own, but it does not change the state of your other breakpoints; see Continuing and stepping.)

Node:Conditions, Next:Break Commands, Previous:Disabling, Up:Breakpoints

### Break conditions

The simplest sort of breakpoint breaks every time your program reaches a specified place. You can also specify a condition for a breakpoint. A condition is just a Boolean expression in your programming language (see Expressions). A breakpoint with a condition evaluates the expression each time your program reaches it, and your program stops only if the condition is true.

This is the converse of using assertions for program validation; in that situation, you want to stop when the assertion is violated--that is, when the condition is false. In C, if you want to test an assertion expressed by the condition assert, you should set the condition `! assert` on the appropriate breakpoint.

Conditions are also accepted for watchpoints; you may not need them, since a watchpoint is inspecting the value of an expression anyhow--but it might be simpler, say, to just set a watchpoint on a variable name, and specify a condition that tests whether the new value is an interesting one.

Break conditions can have side effects, and may even call functions in your program. This can be useful, for example, to activate functions that log program progress, or to use your own print functions to format special data structures. The effects are completely predictable unless there is another enabled breakpoint at the same address. (In that case, GDB might see the other breakpoint first and stop your program without checking the condition of this one.) Note that breakpoint commands are usually more convenient and flexible than break conditions for the purpose of performing side effects when a breakpoint is reached (see Breakpoint command lists).

Break conditions can be specified when a breakpoint is set, by using `if` in the arguments to the `break` command. See Setting breakpoints. They can also be changed at any time with the `condition` command.

You can also use the `if` keyword with the `watch` command. The `catch` command does not recognize the `if` keyword; `condition` is the only way to impose a further condition on a catchpoint.

`condition bnum expression`
  Specify expression as the break condition for breakpoint, watchpoint, or catchpoint number bnum. After you set a condition, breakpoint bnum stops your program only if the value of expression is true (nonzero, in C). When you use `condition`, GDB checks expression immediately for syntactic correctness, and to determine whether symbols in it have referents in the context of your breakpoint. If expression uses symbols not referenced in the context of the breakpoint, GDB prints an error message:

      No symbol "foo" in current context.

  GDB does not actually evaluate expression at the time the `condition` command (or a command that sets a breakpoint with a condition, like `break if ...`) is given, however. See Expressions.
`condition bnum`
  Remove the condition from breakpoint number bnum. It becomes an ordinary unconditional breakpoint.

A special case of a breakpoint condition is to stop only when the breakpoint has been reached a certain number of times. This is so useful that there is a special way to do it, using the ignore count of the breakpoint. Every breakpoint has an ignore count, which is an integer. Most of the time, the ignore count is zero, and therefore has no effect. But if your program reaches a breakpoint whose ignore count is positive, then instead of stopping, it just decrements the ignore count by one and continues. As a result, if the ignore count value is n, the breakpoint does not stop the next n times your program reaches it.

`ignore bnum count`
  Set the ignore count of breakpoint number bnum to count. The next count times the breakpoint is reached, your program's execution does not stop; other than to decrement the ignore count, GDB takes no action.

  To make the breakpoint stop the next time it is reached, specify a count of zero.

  When you use `continue` to resume execution of your program from a breakpoint, you can specify an ignore count directly as an argument to `continue`, rather than using `ignore`. See Continuing and stepping.

  If a breakpoint has a positive ignore count and a condition, the condition is not checked. Once the ignore count reaches zero, GDB resumes checking the condition.

  You could achieve the effect of the ignore count with a condition such as `$foo-- <= 0` using a debugger convenience variable that is decremented each time. See Convenience variables.

Ignore counts apply to breakpoints, watchpoints, and catchpoints.

Node:Break Commands, Next:Breakpoint Menus, Previous:Conditions, Up:Breakpoints

### Breakpoint command lists

You can give any breakpoint (or watchpoint or catchpoint) a series of commands to execute when your program stops due to that breakpoint. For example, you might want to print the values of certain expressions, or enable other breakpoints.

`commands [bnum]`
`... command-list ...`
`end`
  Specify a list of commands for breakpoint number bnum. The commands themselves appear on the following lines. Type a line containing just `end` to terminate the commands.

  To remove all commands from a breakpoint, type `commands` and follow it immediately with `end`; that is, give no commands.

  With no bnum argument, `commands` refers to the last breakpoint, watchpoint, or catchpoint set (not to the breakpoint most recently encountered).

Pressing <RET> as a means of repeating the last GDB command is disabled within a command-list.

You can use breakpoint commands to start your program up again. Simply use the `continue` command, or `step`, or any other command that resumes execution.

Any other commands in the command list, after a command that resumes execution, are ignored. This is because any time you resume execution (even with a simple `next` or `step`), you may encounter another breakpoint--which could have its own command list, leading to ambiguities about which list to execute.

If the first command you specify in a command list is `silent`, the usual message about stopping at a breakpoint is not printed. This may be desirable for breakpoints that are to print a specific message and then continue. If none of the remaining commands print anything, you see no sign that the breakpoint was reached. `silent` is meaningful only at the beginning of a breakpoint command list.

The commands `echo`, `output`, and `printf` allow you to print precisely controlled output, and are often useful in silent breakpoints. See Commands for controlled output.

For example, here is how you could use breakpoint commands to print the value of `x` at entry to `foo` whenever `x` is positive.

    break foo if x>0
    commands
    silent
    printf "x is %d\n",x
    cont
    end

One application for breakpoint commands is to compensate for one bug so you can test for another. Put a breakpoint just after the erroneous line of code, give it a condition to detect the case in which something erroneous has been done, and give it commands to assign correct values to any variables that need them. End with the `continue` command so that your program does not stop, and start with the `silent` command so that no output is produced. Here is an example:

    break 403
    commands
    silent
    set x = y + 4
    cont
    end

Node:Breakpoint Menus, Next:Error in Breakpoints, Previous:Break Commands, Up:Breakpoints

### Breakpoint menus

Some programming languages (notably C++) permit a single function name to be defined several times, for application in different contexts. This is called overloading. When a function name is overloaded, `break function` is not enough to tell GDB where you want a breakpoint. If you realize this is a problem, you can use something like `break function(types)` to specify which particular version of the function you want. Otherwise, GDB offers you a menu of numbered choices for different possible breakpoints, and waits for your selection with the prompt `>`. The first two options are always `[0] cancel` and `[1] all`. Typing `1` sets a breakpoint at each definition of function, and typing `0` aborts the `break` command without setting any new breakpoints.

For example, the following session excerpt shows an attempt to set a breakpoint at the overloaded symbol `String::after`. We choose three particular definitions of that function name:

    (gdb) b String::after
    [0] cancel
    [1] all
    [2] file:String.cc; line number:867
    [3] file:String.cc; line number:860
    [4] file:String.cc; line number:875
    [5] file:String.cc; line number:853
    [6] file:String.cc; line number:846
    [7] file:String.cc; line number:735
    > 2 4 6
    Breakpoint 1 at 0xb26c: file String.cc, line 867.
    Breakpoint 2 at 0xb344: file String.cc, line 875.
    Breakpoint 3 at 0xafcc: file String.cc, line 846.
    Multiple breakpoints were set.
    Use the "delete" command to delete unwanted
     breakpoints.
    (gdb)

Node:Error in Breakpoints, Previous:Breakpoint Menus, Up:Breakpoints

### "Cannot insert breakpoints"

Under some operating systems, breakpoints cannot be used in a program if any other process is running that program. In this situation, attempting to run or continue a program with a breakpoint causes GDB to print an error message:

    Cannot insert breakpoints.
    The same program may be running in another process.

When this happens, you have three ways to proceed:

1. Remove or disable the breakpoints, then continue.
2. Suspend GDB, and copy the file containing your program to a new name. Resume GDB and use the `exec-file` command to specify that GDB should run your program under that name. Then start your program again.
3. Relink your program so that the text segment is nonsharable, using the linker option `-N`. The operating system limitation may not apply to nonsharable executables.

A similar message can be printed if you request too many active hardware-assisted breakpoints and watchpoints:

    Stopped; cannot insert breakpoints.
    You may have requested too many hardware breakpoints and watchpoints.

This message is printed when you attempt to resume the program, since only then GDB knows exactly how many hardware breakpoints and watchpoints it needs to insert.

When this message is printed, you need to disable or remove some of the hardware-assisted breakpoints and watchpoints, and then continue.

Node:Continuing and Stepping, Next:Signals, Previous:Breakpoints, Up:Stopping

## Continuing and stepping

Continuing means resuming program execution until your program completes normally. In contrast, stepping means executing just one more "step" of your program, where "step" may mean either one line of source code, or one machine instruction (depending on what particular command you use). Either when continuing or when stepping, your program may stop even sooner, due to a breakpoint or a signal. (If it stops due to a signal, you may want to use `handle`, or use `signal 0` to resume execution. See Signals.)

`continue [ignore-count]`
`c [ignore-count]`
`fg [ignore-count]`
  Resume program execution, at the address where your program last stopped; any breakpoints set at that address are bypassed. The optional argument ignore-count allows you to specify a further number of times to ignore a breakpoint at this location; its effect is like that of `ignore` (see Break conditions).

  The argument ignore-count is meaningful only when your program stopped due to a breakpoint. At other times, the argument to `continue` is ignored.

  The synonyms `c` and `fg` (for foreground, as the debugged program is deemed to be the foreground program) are provided purely for convenience, and have exactly the same behavior as `continue`.

To resume execution at a different place, you can use `return` (see Returning from a function) to go back to the calling function; or `jump` (see Continuing at a different address) to go to an arbitrary location in your program.

A typical technique for using stepping is to set a breakpoint (see Breakpoints; watchpoints; and catchpoints) at the beginning of the function or the section of your program where a problem is believed to lie, run your program until it stops at that breakpoint, and then step through the suspect area, examining the variables that are interesting, until you see the problem happen.

`step`
  Continue running your program until control reaches a different source line, then stop it and return control to GDB. This command is abbreviated `s`.

  > Warning: If you use the `step` command while control is within a function that was compiled without debugging information, execution proceeds until control reaches a function that does have debugging information. Likewise, it will not step into a function which is compiled without debugging information. To step through functions without debugging information, use the `stepi` command, described below.

  The `step` command only stops at the first instruction of a source line. This prevents the multiple stops that could otherwise occur in switch statements, for loops, etc. `step` continues to stop if a function that has debugging information is called within the line. In other words, `step` steps inside any functions called within the line.

  Also, the `step` command only enters a function if there is line number information for the function. Otherwise it acts like the `next` command. This avoids problems when using `cc -gl` on MIPS machines. Previously, `step` entered subroutines if there was any debugging information about the routine.

`step count`
  Continue running as in `step`, but do so count times. If a breakpoint is reached, or a signal not related to stepping occurs before count steps, stepping stops right away.
`next [count]`
  Continue to the next source line in the current (innermost) stack frame. This is similar to `step`, but function calls that appear within the line of code are executed without stopping. Execution stops when control reaches a different line of code at the original stack level that was executing when you gave the `next` command. This command is abbreviated `n`.

  An argument count is a repeat count, as for `step`.

  The `next` command only stops at the first instruction of a source line. This prevents multiple stops that could otherwise occur in switch statements, for loops, etc.

`finish`
  Continue running until just after function in the selected stack frame returns. Print the returned value (if any).

  Contrast this with the `return` command (see Returning from a function).

`until`
`u`
  Continue running until a source line past the current line, in the current stack frame, is reached. This command is used to avoid single stepping through a loop more than once. It is like the `next` command, except that when `until` encounters a jump, it automatically continues execution until the program counter is greater than the address of the jump.

  This means that when you reach the end of a loop after single stepping though it, `until` makes your program continue execution until it exits the loop. In contrast, a `next` command at the end of a loop simply steps back to the beginning of the loop, which forces you to step through the next iteration.

  `until` always stops your program if it attempts to exit the current stack frame.

  `until` may produce somewhat counterintuitive results if the order of machine code does not match the order of the source lines. For example, in the following excerpt from a debugging session, the `f` (`frame`) command shows that execution is stopped at line `206`; yet when we use `until`, we get to line `195`:

      (gdb) f
      #0  main (argc=4, argv=0xf7fffae8) at m4.c:206
      206                 expand_input();
      (gdb) until
      195             for ( ; argc > 0; NEXTARG) {

  This happened because, for execution efficiency, the compiler had generated code for the loop closure test at the end, rather than the start, of the loop--even though the test in a C `for`-loop is written before the body of the loop. The `until` command appeared to step back to the beginning of the loop when it advanced to this expression; however, it has not really gone to an earlier statement--not in terms of the actual machine code.

  `until` with no argument works by means of single instruction stepping, and hence is slower than `until` with an argument.

`until location`
`u location`
  Continue running your program until either the specified location is reached, or the current stack frame returns. location is any of the forms of argument acceptable to `break` (see Setting breakpoints). This form of the command uses breakpoints, and hence is quicker than `until` without an argument.
`stepi`
`stepi arg`
`si`
  Execute one machine instruction, then stop and return to the debugger.

  It is often useful to do `display/i $pc` when stepping by machine instructions. This makes GDB automatically display the next instruction to be executed, each time your program stops. See Automatic display.

  An argument is a repeat count, as in `step`.

`nexti`
`nexti arg`
`ni`
  Execute one machine instruction, but if it is a function call, proceed until the function returns.

  An argument is a repeat count, as in `next`.

Node:Signals, Next:Thread Stops, Previous:Continuing and Stepping, Up:Stopping

## Signals

A signal is an asynchronous event that can happen in a program. The operating system defines the possible kinds of signals, and gives each kind a name and a number. For example, in Unix `SIGINT` is the signal a program gets when you type an interrupt character (often `C-c`); `SIGSEGV` is the signal a program gets from referencing a place in memory far away from all the areas in use; `SIGALRM` occurs when the alarm clock timer goes off (which happens only if your program has requested an alarm).

Some signals, including `SIGALRM`, are a normal part of the functioning of your program. Others, such as `SIGSEGV`, indicate errors; these signals are fatal (they kill your program immediately) if the program has not specified in advance some other way to handle the signal. `SIGINT` does not indicate an error in your program, but it is normally fatal so it can carry out the purpose of the interrupt: to kill the program. GDB has the ability to detect any occurrence of a signal in your program. You can tell GDB in advance what to do for each kind of signal.

Normally, GDB is set up to ignore non-erroneous signals like `SIGALRM` (so as not to interfere with their role in the functioning of your program) but to stop your program immediately whenever an error signal happens. You can change these settings with the `handle` command.

`info signals`
`info handle`
  Print a table of all the kinds of signals and how GDB has been told to handle each one. You can use this to see the signal numbers of all the defined types of signals.

  `info handle` is an alias for `info signals`.

`handle signal keywords...`
  Change the way GDB handles signal signal. signal can be the number of a signal or its name (with or without the `SIG` at the beginning). The keywords say what change to make.

The keywords allowed by the `handle` command can be abbreviated. Their full names are:

`nostop`
  GDB should not stop your program when this signal happens. It may still print a message telling you that the signal has come in.
`stop`
  GDB should stop your program when this signal happens. This implies the `print` keyword as well.
`print`
  GDB should print a message when this signal happens.
`noprint`
  GDB should not mention the occurrence of the signal at all. This implies the `nostop` keyword as well.
`pass`
  GDB should allow your program to see this signal; your program can handle the signal, or else it may terminate if the signal is fatal and not handled.
`nopass`
  GDB should not allow your program to see this signal.

When a signal stops your program, the signal is not visible to the program until you continue. Your program sees the signal then, if `pass` is in effect for the signal in question at that time. In other words, after GDB reports a signal, you can use the `handle` command with `pass` or `nopass` to control whether your program sees that signal when you continue.

You can also use the `signal` command to prevent your program from seeing a signal, or cause it to see a signal it normally would not see, or to give it any signal at any time. For example, if your program stopped due to some sort of memory reference error, you might store correct values into the erroneous variables and continue, hoping to see more execution; but your program would probably terminate immediately as a result of the fatal signal once it saw the signal. To prevent this, you can continue with `signal 0`. See Giving your program a signal.

Node:Thread Stops, Previous:Signals, Up:Stopping

## Stopping and starting multi-thread programs

When your program has multiple threads (see Debugging programs with multiple threads), you can choose whether to set breakpoints on all threads, or on a particular thread.

`break linespec thread threadno`
`break linespec thread threadno if ...`
  linespec specifies source lines; there are several ways of writing them, but the effect is always to specify some source line.

  Use the qualifier `thread threadno` with a breakpoint command to specify that you only want GDB to stop the program when a particular thread reaches this breakpoint. threadno is one of the numeric thread identifiers assigned by GDB, shown in the first column of the `info threads` display.

  If you do not specify `thread threadno` when you set a breakpoint, the breakpoint applies to all threads of your program.

  You can use the `thread` qualifier on conditional breakpoints as well; in this case, place `thread threadno` before the breakpoint condition, like this:

      (gdb) break frik.c:13 thread 28 if bartab > lim

Whenever your program stops under GDB for any reason, all threads of execution stop, not just the current thread. This allows you to examine the overall state of the program, including switching between threads, without worrying that things may change underfoot.

Conversely, whenever you restart the program, all threads start executing. This is true even when single-stepping with commands like `step` or `next`.

In particular, GDB cannot single-step all threads in lockstep. Since thread scheduling is up to your debugging target's operating system (not controlled by GDB), other threads may execute more than one statement while the current thread completes a single step. Moreover, in general other threads stop in the middle of a statement, rather than at a clean statement boundary, when the program stops.

You might even find your program stopped in another thread after continuing or even single-stepping. This happens whenever some other thread runs into a breakpoint, a signal, or an exception before the first thread completes whatever you requested.

On some OSes, you can lock the OS scheduler and thus allow only a single thread to run.

`set scheduler-locking mode`
  Set the scheduler locking mode. If it is `off`, then there is no locking and any thread may run at any time. If `on`, then only the current thread may run when the inferior is resumed. The `step` mode optimizes for single-stepping. It stops other threads from "seizing the prompt" by preempting the current thread while you are stepping. Other threads will only rarely (or never) get a chance to run when you step. They are more likely to run when you `next` over a function call, and they are completely free to run when you use commands like `continue`, `until`, or `finish`. However, unless another thread hits a breakpoint during its timeslice, they will never steal the GDB prompt away from the thread that you are debugging.
`show scheduler-locking`
  Display the current scheduler locking mode.

Node:Stack, Next:Source, Previous:Stopping, Up:Top

# Examining the Stack

When your program has stopped, the first thing you need to know is where it stopped and how it got there.

Each time your program performs a function call, information about the call is generated. That information includes the location of the call in your program, the arguments of the call, and the local variables of the function being called. The information is saved in a block of data called a stack frame. The stack frames are allocated in a region of memory called the call stack.

When your program stops, the GDB commands for examining the stack allow you to see all of this information.

One of the stack frames is selected by GDB and many GDB commands refer implicitly to the selected frame. In particular, whenever you ask GDB for the value of a variable in your program, the value is found in the selected frame. There are special GDB commands to select whichever frame you are interested in. See Selecting a frame.

When your program stops, GDB automatically selects the currently executing frame and describes it briefly, similar to the `frame` command (see Information about a frame).

- Frames: Stack frames
- Backtrace: Backtraces
- Selection: Selecting a frame
- Frame Info: Information on a frame

Node:Frames, Next:Backtrace, Up:Stack

## Stack frames

The call stack is divided up into contiguous pieces called stack frames, or frames for short; each frame is the data associated with one call to one function. The frame contains the arguments given to the function, the function's local variables, and the address at which the function is executing.

When your program is started, the stack has only one frame, that of the function `main`. This is called the initial frame or the outermost frame. Each time a function is called, a new frame is made. Each time a function returns, the frame for that function invocation is eliminated. If a function is recursive, there can be many frames for the same function. The frame for the function in which execution is actually occurring is called the innermost frame. This is the most recently created of all the stack frames that still exist.

Inside your program, stack frames are identified by their addresses. A stack frame consists of many bytes, each of which has its own address; each kind of computer has a convention for choosing one byte whose address serves as the address of the frame. Usually this address is kept in a register called the frame pointer register while execution is going on in that frame. GDB assigns numbers to all existing stack frames, starting with zero for the innermost frame, one for the frame that called it, and so on upward. These numbers do not really exist in your program; they are assigned by GDB to give you a way of designating stack frames in GDB commands.

Some compilers provide a way to compile functions so that they operate without stack frames. (For example, the gcc option

    -fomit-frame-pointer

generates functions without a frame.) This is occasionally done with heavily used library functions to save the frame setup time. GDB has limited facilities for dealing with these function invocations. If the innermost function invocation has no stack frame, GDB nevertheless regards it as though it had a separate frame, which is numbered zero as usual, allowing correct tracing of the function call chain. However, GDB has no provision for frameless functions elsewhere in the stack.

`frame args`
  The `frame` command allows you to move from one stack frame to another, and to print the stack frame you select. args may be either the address of the frame or the stack frame number. Without an argument, `frame` prints the current stack frame.
`select-frame`
  The `select-frame` command allows you to move from one stack frame to another without printing the frame. This is the silent version of `frame`.

Node:Backtrace, Next:Selection, Previous:Frames, Up:Stack

## Backtraces

A backtrace is a summary of how your program got where it is. It shows one line per frame, for many frames, starting with the currently executing frame (frame zero), followed by its caller (frame one), and on up the stack.

`backtrace`
`bt`
  Print a backtrace of the entire stack: one line per frame for all frames in the stack.

  You can stop the backtrace at any time by typing the system interrupt character, normally `C-c`.

`backtrace n`
`bt n`
  Similar, but print only the innermost n frames.
`backtrace -n`
`bt -n`
  Similar, but print only the outermost n frames.

The names `where` and `info stack` (abbreviated `info s`) are additional aliases for `backtrace`.

Each line in the backtrace shows the frame number and the function name. The program counter value is also shown--unless you use `set print address off`. The backtrace also shows the source file name and line number, as well as the arguments to the function. The program counter value is omitted if it is at the beginning of the code for that line number.

Here is an example of a backtrace. It was made with the command `bt 3`, so it shows the innermost three frames.

    #0  m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
        at builtin.c:993
    #1  0x6e38 in expand_macro (sym=0x2b600) at macro.c:242
    #2  0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
        at macro.c:71
    (More stack frames follow...)

The display for frame zero does not begin with a program counter value, indicating that your program has stopped at the beginning of the code for line `993` of `builtin.c`.

Node:Selection, Next:Frame Info, Previous:Backtrace, Up:Stack

## Selecting a frame

Most commands for examining the stack and other data in your program work on whichever stack frame is selected at the moment. Here are the commands for selecting a stack frame; all of them finish by printing a brief description of the stack frame just selected.

`frame n`
`f n`
  Select frame number n. Recall that frame zero is the innermost (currently executing) frame, frame one is the frame that called the innermost one, and so on. The highest-numbered frame is the one for `main`.
`frame addr`
`f addr`
  Select the frame at address addr. This is useful mainly if the chaining of stack frames has been damaged by a bug, making it impossible for GDB to assign numbers properly to all frames. In addition, this can be useful when your program has multiple stacks and switches between them.

  On the SPARC architecture, `frame` needs two addresses to select an arbitrary frame: a frame pointer and a stack pointer.

  On the MIPS and Alpha architecture, it needs two addresses: a stack pointer and a program counter.

  On the 29k architecture, it needs three addresses: a register stack pointer, a program counter, and a memory stack pointer.

`up n`
  Move n frames up the stack. For positive numbers n, this advances toward the outermost frame, to higher frame numbers, to frames that have existed longer. n defaults to one.
`down n`
  Move n frames down the stack. For positive numbers n, this advances toward the innermost frame, to lower frame numbers, to frames that were created more recently. n defaults to one. You may abbreviate `down` as `do`.

All of these commands end by printing two lines of output describing the frame. The first line shows the frame number, the function name, the arguments, and the source file and line number of execution in that frame. The second line shows the text of that source line.

For example:

    (gdb) up
    #1  0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
        at env.c:10
    10              read_input_file (argv[i]);

After such a printout, the `list` command with no arguments prints ten lines centered on the point of execution in the frame. See Printing source lines.

`up-silently n`
`down-silently n`
  These two commands are variants of `up` and `down`, respectively; they differ in that they do their work silently, without causing display of the new frame. They are intended primarily for use in GDB command scripts, where the output might be unnecessary and distracting.

Node:Frame Info, Previous:Selection, Up:Stack

## Information about a frame

There are several other commands to print information about the selected stack frame.

`frame`
`f`
  When used without any argument, this command does not change which frame is selected, but prints a brief description of the currently selected stack frame. It can be abbreviated `f`. With an argument, this command is used to select a stack frame. See Selecting a frame.
`info frame`
`info f`
  This command prints a verbose description of the selected stack frame, including:
  - the address of the frame
  - the address of the next frame down (called by this frame)
  - the address of the next frame up (caller of this frame)
  - the language in which the source code corresponding to this frame is written
  - the address of the frame's arguments
  - the address of the frame's local variables
  - the program counter saved in it (the address of execution in the caller frame)
  - which registers were saved in the frame

  The verbose description is useful when something has gone wrong that has made the stack format fail to fit the usual conventions.

`info frame addr`
`info f addr`
  Print a verbose description of the frame at address addr, without selecting that frame. The selected frame remains unchanged by this command. This requires the same kind of address (more than one for some architectures) that you specify in the `frame` command. See Selecting a frame.
`info args`
  Print the arguments of the selected frame, each on a separate line.
`info locals`
  Print the local variables of the selected frame, each on a separate line. These are all variables (declared either static or automatic) accessible at the point of execution of the selected frame.
`info catch`
  Print a list of all the exception handlers that are active in the current stack frame at the current point of execution. To see other exception handlers, visit the associated frame (using the `up`, `down`, or `frame` commands); then type `info catch`. See Setting catchpoints.

Node:Source, Next:Data, Previous:Stack, Up:Top

# Examining Source Files

GDB can print parts of your program's source, since the debugging information recorded in the program tells GDB what source files were used to build it. When your program stops, GDB spontaneously prints the line where it stopped. Likewise, when you select a stack frame (see Selecting a frame), GDB prints the line where execution in that frame has stopped. You can print other portions of source files by explicit command.

If you use GDB through its GNU Emacs interface, you may prefer to use Emacs facilities to view source; see Using GDB under GNU Emacs.

- List: Printing source lines
- Search: Searching source files
- Source Path: Specifying source directories
- Machine Code: Source and machine code

Node:List, Next:Search, Up:Source

## Printing source lines

To print lines from a source file, use the `list` command (abbreviated `l`). By default, ten lines are printed. There are several ways to specify what part of the file you want to print.

Here are the forms of the `list` command most commonly used:

`list linenum`
  Print lines centered around line number linenum in the current source file.
`list function`
  Print lines centered around the beginning of function function.
`list`
  Print more lines. If the last lines printed were printed with a `list` command, this prints lines following the last lines printed; however, if the last line printed was a solitary line printed as part of displaying a stack frame (see Examining the Stack), this prints lines centered around that line.
`list -`
  Print lines just before the lines last printed.

By default, GDB prints ten source lines with any of these forms of the `list` command. You can change this using `set listsize`:

`set listsize count`
  Make the `list` command display count source lines (unless the `list` argument explicitly specifies some other number).
`show listsize`
  Display the number of lines that `list` prints.

Repeating a `list` command with <RET> discards the argument, so it is equivalent to typing just `list`. This is more useful than listing the same lines again. An exception is made for an argument of `-`; that argument is preserved in repetition so that each repetition moves up in the source file.

In general, the `list` command expects you to supply zero, one or two linespecs. Linespecs specify source lines; there are several ways of writing them, but the effect is always to specify some source line. Here is a complete description of the possible arguments for `list`:

`list linespec`
  Print lines centered around the line specified by linespec.
`list first,last`
  Print lines from first to last. Both arguments are linespecs.
`list ,last`
  Print lines ending with last.
`list first,`
  Print lines starting with first.
`list +`
  Print lines just after the lines last printed.
`list -`
  Print lines just before the lines last printed.
`list`
  As described in the preceding table.

Here are the ways of specifying a single source line--all the kinds of linespec.

`number`
  Specifies line number of the current source file. When a `list` command has two linespecs, this refers to the same source file as the first linespec.
`+offset`
  Specifies the line offset lines after the last line printed. When used as the second linespec in a `list` command that has two, this specifies the line offset lines down from the first linespec.
`-offset`
  Specifies the line offset lines before the last line printed.
`filename:number`
  Specifies line number in the source file filename.
`function`
  Specifies the line that begins the body of the function function. For example: in C, this is the line with the open brace.
`filename:function`
  Specifies the line of the open-brace that begins the body of the function function in the file filename. You only need the file name with a function name to avoid ambiguity when there are identically named functions in different source files.
`*address`
  Specifies the line containing the program address address. address may be any expression.

Node:Search, Next:Source Path, Previous:List, Up:Source

## Searching source files

There are two commands for searching through the current source file for a regular expression.

`forward-search regexp`
`search regexp`
  The command `forward-search regexp` checks each line, starting with the one following the last line listed, for a match for regexp. It lists the line that is found. You can use the synonym `search regexp` or abbreviate the command name as `fo`.
`reverse-search regexp`
  The command `reverse-search regexp` checks each line, starting with the one before the last line listed and going backward, for a match for regexp. It lists the line that is found. You can abbreviate this command as `rev`.

Node:Source Path, Next:Machine Code, Previous:Search, Up:Source

## Specifying source directories

Executable programs sometimes do not record the directories of the source files from which they were compiled, just the names. Even when they do, the directories could be moved between the compilation and your debugging session. GDB has a list of directories to search for source files; this is called the source path. Each time GDB wants a source file, it tries all the directories in the list, in the order they are present in the list, until it finds a file with the desired name. Note that the executable search path is not used for this purpose. Neither is the current working directory, unless it happens to be in the source path.

If GDB cannot find a source file in the source path, and the object program records a directory, GDB tries that directory too. If the source path is empty, and there is no record of the compilation directory, GDB looks in the current directory as a last resort.

Whenever you reset or rearrange the source path, GDB clears out any information it has cached about where source files are found and where each line is in the file.

When you start GDB, its source path includes only `cdir` and `cwd`, in that order. To add other directories, use the `directory` command.

`directory dirname ...`
`dir dirname ...`
  Add directory dirname to the front of the source path. Several directory names may be given to this command, separated by `:` (`;` on MS-DOS and MS-Windows, where `:` usually appears as part of absolute file names) or whitespace. You may specify a directory that is already in the source path; this moves it forward, so GDB searches it sooner.

  You can use the string `$cdir` to refer to the compilation directory (if one is recorded), and `$cwd` to refer to the current working directory. `$cwd` is not the same as `.`--the former tracks the current working directory as it changes during your GDB session, while the latter is immediately expanded to the current directory at the time you add an entry to the source path.

`directory`
  Reset the source path to empty again. This requires confirmation.
`show directories`
  Print the source path: show which directories it contains.

If your source path is cluttered with directories that are no longer of interest, GDB may sometimes cause confusion by finding the wrong versions of source. You can correct the situation as follows:

1. Use `directory` with no argument to reset the source path to empty.
2. Use `directory` with suitable arguments to reinstall the directories you want in the source path. You can add all the directories in one command.

Node:Machine Code, Previous:Source Path, Up:Source

## Source and machine code

You can use the command `info line` to map source lines to program addresses (and vice versa), and the command `disassemble` to display a range of addresses as machine instructions. When run under GNU Emacs mode, the `info line` command causes the arrow to point to the line specified. Also, `info line` prints addresses in symbolic form as well as hex.

`info line linespec`
  Print the starting and ending addresses of the compiled code for source line linespec. You can specify source lines in any of the ways understood by the `list` command (see Printing source lines).

For example, we can use `info line` to discover the location of the object code for the first line of function `m4_changequote`:

    (gdb) info line m4_changequote
    Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.

We can also inquire (using `*addr` as the form for linespec) what source line covers a particular address:

    (gdb) info line *0x63ff
    Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.

After `info line`, the default address for the `x` command is changed to the starting address of the line, so that `x/i` is sufficient to begin examining the machine code (see Examining memory). Also, this address is saved as the value of the convenience variable `$_` (see Convenience variables).

`disassemble`
  This specialized command dumps a range of memory as machine instructions. The default memory range is the function surrounding the program counter of the selected frame. A single argument to this command is a program counter value; GDB dumps the function surrounding this value. Two arguments specify a range of addresses (first inclusive, second exclusive) to dump.

The following example shows the disassembly of a range of addresses of HP PA-RISC 2.0 code:

    (gdb) disas 0x32c4 0x32e4
    Dump of assembler code from 0x32c4 to 0x32e4:
    0x32c4 <main+204>:      addil 0,dp
    0x32c8 <main+208>:      ldw 0x22c(sr0,r1),r26
    0x32cc <main+212>:      ldil 0x3000,r31
    0x32d0 <main+216>:      ble 0x3f8(sr4,r31)
    0x32d4 <main+220>:      ldo 0(r31),rp
    0x32d8 <main+224>:      addil -0x800,dp
    0x32dc <main+228>:      ldo 0x588(r1),r26
    0x32e0 <main+232>:      ldil 0x3000,r31
    End of assembler dump.

Some architectures have more than one commonly-used set of instruction mnemonics or other syntax.

`set disassembly-flavor instruction-set`
  Select the instruction set to use when disassembling the program via the `disassemble` or `x/i` commands.

  Currently this command is only defined for the Intel x86 family. You can set instruction-set to either `intel` or `att`. The default is `att`, the AT&T flavor used by default by Unix assemblers for x86-based targets.

Node:Data, Next:Languages, Previous:Source, Up:Top

# Examining Data

The usual way to examine data in your program is with the `print` command (abbreviated `p`), or its synonym `inspect`. It evaluates and prints the value of an expression of the language your program is written in (see Using GDB with Different Languages).

`print expr`
`print /f expr`
  expr is an expression (in the source language). By default the value of expr is printed in a format appropriate to its data type; you can choose a different format by specifying `/f`, where f is a letter specifying the format; see Output formats.
`print`
`print /f`
  If you omit expr, GDB displays the last value again (from the value history; see Value history). This allows you to conveniently inspect the same value in an alternative format.

A more low-level way of examining data is with the `x` command. It examines data in memory at a specified address and prints it in a specified format. See Examining memory.

If you are interested in information about types, or about how the fields of a struct or a class are declared, use the `ptype exp` command rather than `print`. See Examining the Symbol Table.

- Expressions: Expressions
- Variables: Program variables
- Arrays: Artificial arrays
- Output Formats: Output formats
- Memory: Examining memory
- Auto Display: Automatic display
- Print Settings: Print settings
- Value History: Value history
- Convenience Vars: Convenience variables
- Registers: Registers
- Floating Point Hardware: Floating point hardware

Node:Expressions, Next:Variables, Up:Data

## Expressions

`print` and many other GDB commands accept an expression and compute its value. Any kind of constant, variable or operator defined by the programming language you are using is valid in an expression in GDB. This includes conditional expressions, function calls, casts and string constants. It unfortunately does not include symbols defined by preprocessor `#define` commands. GDB supports array constants in expressions input by the user. The syntax is {element, element...}. For example, you can use the command `print {1, 2, 3}` to build up an array in memory that is `malloc`ed in the target program.

Because C is so widespread, most of the expressions shown in examples in this manual are in C. See Using GDB with Different Languages, for information on how to use expressions in other languages.

In this section, we discuss operators that you can use in GDB expressions regardless of your programming language.

Casts are supported in all languages, not just in C, because it is so useful to cast a number into a pointer in order to examine a structure at that address in memory. GDB supports these operators, in addition to those common to programming languages:

`@`
  `@` is a binary operator for treating parts of memory as arrays. See Artificial arrays, for more information.
`::`
  `::` allows you to specify a variable in terms of the file or function where it is defined. See Program variables.
`{type} addr`
  Refers to an object of type type stored at address addr in memory. addr may be any expression whose value is an integer or pointer (but parentheses are required around binary operators, just as in a cast). This construct is allowed regardless of what kind of data is normally supposed to reside at addr.

Node:Variables, Next:Arrays, Previous:Expressions, Up:Data

## Program variables

The most common kind of expression to use is the name of a variable in your program.

Variables in expressions are understood in the selected stack frame (see Selecting a frame); they must be either:

- global (or file-static)

or

- visible according to the scope rules of the programming language from the point of execution in that frame

This means that in the function

    foo (a)
         int a;
    {
      bar (a);
      {
        int b = test ();
        bar (b);
      }
    }

you can examine and use the variable `a` whenever your program is executing within the function `foo`, but you can only use or examine the variable `b` while your program is executing inside the block where `b` is declared.

There is an exception: you can refer to a variable or function whose scope is a single source file even if the current execution point is not in this file. But it is possible to have more than one such variable or function with the same name (in different source files). If that happens, referring to that name has unpredictable effects. If you wish, you can specify a static variable in a particular function or file, using the colon-colon notation:

    file::variable
    function::variable

Here file or function is the name of the context for the static variable. In the case of file names, you can use quotes to make sure GDB parses the file name as a single word--for example, to print a global value of `x` defined in `f2.c`:

    (gdb) p 'f2.c'::x

This use of `::` is very rarely in conflict with the very similar use of the same notation in C++. GDB also supports use of the C++ scope resolution operator in GDB expressions.

> Warning: Occasionally, a local variable may appear to have the wrong value at certain points in a function--just after entry to a new scope, and just before exit.

You may see this problem when you are stepping by machine instructions. This is because, on most machines, it takes more than one instruction to set up a stack frame (including local variable definitions); if you are stepping by machine instructions, variables may appear to have the wrong values until the stack frame is completely built. On exit, it usually also takes more than one machine instruction to destroy a stack frame; after you begin stepping through that group of instructions, local variable definitions may be gone.

This may also happen when the compiler does significant optimizations. To be sure of always seeing accurate values, turn off all optimization when compiling.

Another possible effect of compiler optimizations is to optimize unused variables out of existence, or assign variables to registers (as opposed to memory addresses). Depending on the support for such cases offered by the debug info format used by the compiler, GDB might not be able to display values for such local variables. If that happens, GDB will print a message like this:

    No symbol "foo" in current context.

To solve such problems, either recompile without optimizations, or use a different debug info format, if the compiler supports several such formats. For example, GCC, the GNU C/C++ compiler usually supports the `-gstabs` option. `-gstabs` produces debug info in a format that is superior to formats such as COFF. You may be able to use DWARF-2 (`-gdwarf-2`), which is also an effective form for debug info. See Debugging Options, for more information.

Node:Arrays, Next:Output Formats, Previous:Variables, Up:Data

## Artificial arrays

It is often useful to print out several successive objects of the same type in memory; a section of an array, or an array of dynamically determined size for which only a pointer exists in the program.

You can do this by referring to a contiguous span of memory as an artificial array, using the binary operator `@`. The left operand of `@` should be the first element of the desired array and be an individual object. The right operand should be the desired length of the array. The result is an array value whose elements are all of the type of the left argument. The first element is actually the left argument; the second element comes from bytes of memory immediately following those that hold the first element, and so on. Here is an example. If a program says

    int *array = (int *) malloc (len * sizeof (int));

you can print the contents of `array` with

    p *array@len

The left operand of `@` must reside in memory. Array values made with `@` in this way behave just like other arrays in terms of subscripting, and are coerced to pointers when used in expressions. Artificial arrays most often appear in expressions via the value history (see Value history), after printing one out.

Another way to create an artificial array is to use a cast. This re-interprets a value as if it were an array. The value need not be in memory:

    (gdb) p/x (short[2])0x12345678
    $1 = {0x1234, 0x5678}

As a convenience, if you leave the array length out (as in `(type[])value`) GDB calculates the size to fill the value (as `sizeof(value)/sizeof(type)`:

    (gdb) p/x (short[])0x12345678
    $2 = {0x1234, 0x5678}

Sometimes the artificial array mechanism is not quite enough; in moderately complex data structures, the elements of interest may not actually be adjacent--for example, if you are interested in the values of pointers in an array. One useful work-around in this situation is to use a convenience variable (see Convenience variables) as a counter in an expression that prints the first interesting value, and then repeat that expression via <RET>. For instance, suppose you have an array `dtab` of pointers to structures, and you are interested in the values of a field `fv` in each structure. Here is an example of what you might type:

    set $i = 0
    p dtab[$i++]->fv
    <RET>
    <RET>
    ...

Node:Output Formats, Next:Memory, Previous:Arrays, Up:Data

## Output formats

By default, GDB prints a value according to its data type. Sometimes this is not what you want. For example, you might want to print a number in hex, or a pointer in decimal. Or you might want to view data in memory at a certain address as a character string or as an instruction. To do these things, specify an output format when you print a value.

The simplest use of output formats is to say how to print a value already computed. This is done by starting the arguments of the `print` command with a slash and a format letter. The format letters supported are:

`x`
  Regard the bits of the value as an integer, and print the integer in hexadecimal.
`d`
  Print as integer in signed decimal.
`u`
  Print as integer in unsigned decimal.
`o`
  Print as integer in octal.
`t`
  Print as integer in binary. The letter `t` stands for "two". 2
`a`
  Print as an address, both absolute in hexadecimal and as an offset from the nearest preceding symbol. You can use this format used to discover where (in what function) an unknown address is located:

      (gdb) p/a 0x54320
      $3 = 0x54320 <_initialize_vx+396>

`c`
  Regard as an integer and print it as a character constant.
`f`
  Regard the bits of the value as a floating point number and print using typical floating point syntax.

For example, to print the program counter in hex (see Registers), type

    p/x $pc

Note that no space is required before the slash; this is because command names in GDB cannot contain a slash.

To reprint the last value in the value history with a different format, you can use the `print` command with just a format and no expression. For example, `p/x` reprints the last value in hex.

Node:Memory, Next:Auto Display, Previous:Output Formats, Up:Data

## Examining memory

You can use the command `x` (for "examine") to examine memory in any of several formats, independently of your program's data types.

`x/nfu addr`
`x addr`
`x`
  Use the `x` command to examine memory.

n, f, and u are all optional parameters that specify how much memory to display and how to format it; addr is an expression giving the address where you want to start displaying memory. If you use defaults for nfu, you need not type the slash `/`. Several commands set convenient defaults for addr.

n, the repeat count
  The repeat count is a decimal integer; the default is 1. It specifies how much memory (counting by units u) to display.
f, the display format
  The display format is one of the formats used by `print`, `s` (null-terminated string), or `i` (machine instruction). The default is `x` (hexadecimal) initially. The default changes each time you use either `x` or `print`.
u, the unit size
  The unit size is any of
  `b`
    Bytes.
  `h`
    Halfwords (two bytes).
  `w`
    Words (four bytes). This is the initial default.
  `g`
    Giant words (eight bytes).

  Each time you specify a unit size with `x`, that size becomes the default unit the next time you use `x`. (For the `s` and `i` formats, the unit size is ignored and is normally not written.)

addr, starting display address
  addr is the address where you want GDB to begin displaying memory. The expression need not have a pointer value (though it may); it is always interpreted as an integer address of a byte of memory. See Expressions, for more information on expressions. The default for addr is usually just after the last address examined--but several other commands also set the default address: `info breakpoints` (to the address of the last breakpoint listed), `info line` (to the starting address of a line), and `print` (if you use it to display a value from memory).

For example, `x/3uh 0x54320` is a request to display three halfwords (`h`) of memory, formatted as unsigned decimal integers (`u`), starting at address `0x54320`. `x/4xw $sp` prints the four words (`w`) of memory above the stack pointer (here, `$sp`; see Registers) in hexadecimal (`x`).

Since the letters indicating unit sizes are all distinct from the letters specifying output formats, you do not have to remember whether unit size or format comes first; either order works. The output specifications `4xw` and `4wx` mean exactly the same thing. (However, the count n must come first; `wx4` does not work.)

Even though the unit size u is ignored for the formats `s` and `i`, you might still want to use a count n; for example, `3i` specifies that you want to see three machine instructions, including any operands. The command `disassemble` gives an alternative way of inspecting machine instructions; see Source and machine code.

All the defaults for the arguments to `x` are designed to make it easy to continue scanning memory with minimal specifications each time you use `x`. For example, after you have inspected three machine instructions with `x/3i addr`, you can inspect the next seven with just `x/7`. If you use <RET> to repeat the `x` command, the repeat count n is used again; the other arguments default as for successive uses of `x`.

The addresses and contents printed by the `x` command are not saved in the value history because there is often too much of them and they would get in the way. Instead, GDB makes these values available for subsequent use in expressions as values of the convenience variables `$_` and `$__`. After an `x` command, the last address examined is available for use in expressions in the convenience variable `$_`. The contents of that address, as examined, are available in the convenience variable `$__`.

If the `x` command has a repeat count, the address and contents saved are from the last memory unit printed; this is not the same as the last address printed if several units were printed on the last line of output.

Node:Auto Display, Next:Print Settings, Previous:Memory, Up:Data

## Automatic display

If you find that you want to print the value of an expression frequently (to see how it changes), you might want to add it to the automatic display list so that GDB prints its value each time your program stops. Each expression added to the list is given a number to identify it; to remove an expression from the list, you specify that number. The automatic display looks like this:

    2: foo = 38
    3: bar[5] = (struct hack *) 0x3804

This display shows item numbers, expressions and their current values. As with displays you request manually using `x` or `print`, you can specify the output format you prefer; in fact, `display` decides whether to use `print` or `x` depending on how elaborate your format specification is--it uses `x` if you specify a unit size, or one of the two formats (`i` and `s`) that are only supported by `x`; otherwise it uses `print`.

`display expr`
  Add the expression expr to the list of expressions to display each time your program stops. See Expressions.

  `display` does not repeat if you press <RET> again after using it.

`display/fmt expr`
  For fmt specifying only a display format and not a size or count, add the expression expr to the auto-display list but arrange to display it each time in the specified format fmt. See Output formats.
`display/fmt addr`
  For fmt `i` or `s`, or including a unit-size or a number of units, add the expression addr as a memory address to be examined each time your program stops. Examining means in effect doing `x/fmt addr`. See Examining memory.

For example, `display/i $pc` can be helpful, to see the machine instruction about to be executed each time execution stops (`$pc` is a common name for the program counter; see Registers).

`undisplay dnums...`
`delete display dnums...`
  Remove item numbers dnums from the list of expressions to display.

  `undisplay` does not repeat if you press <RET> after using it. (Otherwise you would just get the error `No display number ...`.)

`disable display dnums...`
  Disable the display of item numbers dnums. A disabled display item is not printed automatically, but is not forgotten. It may be enabled again later.
`enable display dnums...`
  Enable display of item numbers dnums. It becomes effective once again in auto display of its expression, until you specify otherwise.
`display`
  Display the current values of the expressions on the list, just as is done when your program stops.
`info display`
  Print the list of expressions previously set up to display automatically, each one with its item number, but without showing the values. This includes disabled expressions, which are marked as such. It also includes expressions which would not be displayed right now because they refer to automatic variables not currently available.

If a display expression refers to local variables, then it does not make sense outside the lexical context for which it was set up. Such an expression is disabled when execution enters a context where one of its variables is not defined. For example, if you give the command `display last_char` while inside a function with an argument `last_char`, GDB displays this argument while your program continues to stop inside that function. When it stops elsewhere--where there is no variable `last_char`--the display is disabled automatically. The next time your program stops where `last_char` is meaningful, you can enable the display expression once again.

Node:Print Settings, Next:Value History, Previous:Auto Display, Up:Data

## Print settings

GDB provides the following ways to control how arrays, structures, and symbols are printed.

These settings are useful for debugging programs in any language:

`set print address`
`set print address on`
  GDB prints memory addresses showing the location of stack traces, structure values, pointer values, breakpoints, and so forth, even when it also displays the contents of those addresses. The default is `on`. For example, this is what a stack frame display looks like with `set print address on`:

      (gdb) f
      #0  set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
          at input.c:530
      530         if (lquote != def_lquote)

`set print address off`
  Do not print addresses when displaying their contents. For example, this is the same stack frame displayed with `set print address off`:

      (gdb) set print addr off
      (gdb) f
      #0  set_quotes (lq="<<", rq=">>") at input.c:530
      530         if (lquote != def_lquote)

  You can use `set print address off` to eliminate all machine dependent displays from the GDB interface. For example, with `print address off`, you should get the same text for backtraces on all machines--whether or not they involve pointer arguments.

`show print address`
  Show whether or not addresses are to be printed.

When GDB prints a symbolic address, it normally prints the closest earlier symbol plus an offset. If that symbol does not uniquely identify the address (for example, it is a name whose scope is a single source file), you may need to clarify. One way to do this is with `info line`, for example `info line *0x4537`. Alternately, you can set GDB to print the source file and line number when it prints a symbolic address:

`set print symbol-filename on`
  Tell GDB to print the source file name and line number of a symbol in the symbolic form of an address.
`set print symbol-filename off`
  Do not print source file name and line number of a symbol. This is the default.
`show print symbol-filename`
  Show whether or not GDB will print the source file name and line number of a symbol in the symbolic form of an address.

Another situation where it is helpful to show symbol filenames and line numbers is when disassembling code; GDB shows you the line number and source file that corresponds to each instruction.

Also, you may wish to see the symbolic form only if the address being printed is reasonably close to the closest earlier symbol:

`set print max-symbolic-offset max-offset`
  Tell GDB to only display the symbolic form of an address if the offset between the closest earlier symbol and the address is less than max-offset. The default is 0, which tells GDB to always print the symbolic form of an address if any symbol precedes it.
`show print max-symbolic-offset`
  Ask how large the maximum offset is that GDB prints in a symbolic address.

If you have a pointer and you are not sure where it points, try `set print symbol-filename on`. Then you can determine the name and source file location of the variable where it points, using `p/a pointer`. This interprets the address in symbolic form. For example, here GDB shows that a variable `ptt` points at another variable `t`, defined in `hi2.c`:

    (gdb) set print symbol-filename on
    (gdb) p/a ptt
    $4 = 0xe008 <t in hi2.c>

> Warning: For pointers that point to a local variable, `p/a` does not show the symbol name and filename of the referent, even with the appropriate `set print` options turned on.

Other settings control how different kinds of objects are printed:

`set print array`
`set print array on`
  Pretty print arrays. This format is more convenient to read, but uses more space. The default is off.
`set print array off`
  Return to compressed format for arrays.
`show print array`
  Show whether compressed or pretty format is selected for displaying arrays.
`set print elements number-of-elements`
  Set a limit on how many elements of an array GDB will print. If GDB is printing a large array, it stops printing after it has printed the number of elements set by the `set print elements` command. This limit also applies to the display of strings. When GDB starts, this limit is set to 200. Setting number-of-elements to zero means that the printing is unlimited.
`show print elements`
  Display the number of elements of a large array that GDB will print. If the number is 0, then the printing is unlimited.
`set print null-stop`
  Cause GDB to stop printing the characters of an array when the first NULL is encountered. This is useful when large arrays actually contain only short strings. The default is off.
`set print pretty on`
  Cause GDB to print structures in an indented format with one member per line, like this:

      $1 = {
        next = 0x0,
        flags = {
          sweet = 1,
          sour = 1
        },
        meat = 0x54 "Pork"
      }

`set print pretty off`
  Cause GDB to print structures in a compact format, like this:

      $1 = {next = 0x0, flags = {sweet = 1, sour = 1}, \
      meat = 0x54 "Pork"}

  This is the default format.

`show print pretty`
  Show which format GDB is using to print structures.
`set print sevenbit-strings on`
  Print using only seven-bit characters; if this option is set, GDB displays any eight-bit characters (in strings or character values) using the notation `\`nnn. This setting is best if you are working in English (ASCII) and you use the high-order bit of characters as a marker or "meta" bit.
`set print sevenbit-strings off`
  Print full eight-bit characters. This allows the use of more international character sets, and is the default.
`show print sevenbit-strings`
  Show whether or not GDB is printing only seven-bit characters.
`set print union on`
  Tell GDB to print unions which are contained in structures. This is the default setting.
`set print union off`
  Tell GDB not to print unions which are contained in structures.
`show print union`
  Ask GDB whether or not it will print unions which are contained in structures.

  For example, given the declarations

      typedef enum {Tree, Bug} Species;
      typedef enum {Big_tree, Acorn, Seedling} Tree_forms;
      typedef enum {Caterpillar, Cocoon, Butterfly}
                    Bug_forms;

      struct thing {
        Species it;
        union {
          Tree_forms tree;
          Bug_forms bug;
        } form;
      };

      struct thing foo = {Tree, {Acorn}};

  with `set print union on` in effect `p foo` would print

      $1 = {it = Tree, form = {tree = Acorn, bug = Cocoon}}

  and with `set print union off` in effect it would print

      $1 = {it = Tree, form = {...}}

These settings are of interest when debugging C++ programs:

`set print demangle`
`set print demangle on`
  Print C++ names in their source form rather than in the encoded ("mangled") form passed to the assembler and linker for type-safe linkage. The default is on.
`show print demangle`
  Show whether C++ names are printed in mangled or demangled form.
`set print asm-demangle`
`set print asm-demangle on`
  Print C++ names in their source form rather than their mangled form, even in assembler code printouts such as instruction disassemblies. The default is off.
`show print asm-demangle`
  Show whether C++ names in assembly listings are printed in mangled or demangled form.
`set demangle-style style`
  Choose among several encoding schemes used by different compilers to represent C++ names. The choices for style are currently:
  `auto`
    Allow GDB to choose a decoding style by inspecting your program.
  `gnu`
    Decode based on the GNU C++ compiler (`g++`) encoding algorithm. This is the default.
  `hp`
    Decode based on the HP ANSI C++ (`aCC`) encoding algorithm.
  `lucid`
    Decode based on the Lucid C++ compiler (`lcc`) encoding algorithm.
  `arm`
    Decode using the algorithm in the C++ Annotated Reference Manual. Warning: this setting alone is not sufficient to allow debugging `cfront`-generated executables. GDB would require further enhancement to permit that.
  If you omit style, you will see a list of possible formats.
`show demangle-style`
  Display the encoding style currently in use for decoding C++ symbols.
`set print object`
`set print object on`
  When displaying a pointer to an object, identify the actual (derived) type of the object rather than the declared type, using the virtual function table.
`set print object off`
  Display only the declared type of objects, without reference to the virtual function table. This is the default setting.
`show print object`
  Show whether actual, or declared, object types are displayed.
`set print static-members`
`set print static-members on`
  Print static members when displaying a C++ object. The default is on.
`set print static-members off`
  Do not print static members when displaying a C++ object.
`show print static-members`
  Show whether C++ static members are printed, or not.
`set print vtbl`
`set print vtbl on`
  Pretty print C++ virtual function tables. The default is off. (The `vtbl` commands do not work on programs compiled with the HP ANSI C++ compiler (`aCC`).)
`set print vtbl off`
  Do not pretty print C++ virtual function tables.
`show print vtbl`
  Show whether C++ virtual function tables are pretty printed, or not.

Node:Value History, Next:Convenience Vars, Previous:Print Settings, Up:Data

## Value history

Values printed by the `print` command are saved in the GDB value history. This allows you to refer to them in other expressions. Values are kept until the symbol table is re-read or discarded (for example with the `file` or `symbol-file` commands). When the symbol table changes, the value history is discarded, since the values may contain pointers back to the types defined in the symbol table.

The values printed are given history numbers by which you can refer to them. These are successive integers starting with one. `print` shows you the history number assigned to a value by printing `$num =` before the value; here num is the history number.

To refer to any previous value, use `$` followed by the value's history number. The way `print` labels its output is designed to remind you of this. Just `$` refers to the most recent value in the history, and `$$` refers to the value before that. `$$n` refers to the nth value from the end; `$$2` is the value just prior to `$$`, `$$1` is equivalent to `$$`, and `$$0` is equivalent to `$`.

For example, suppose you have just printed a pointer to a structure and want to see the contents of the structure. It suffices to type

    p *$

If you have a chain of structures where the component `next` points to the next one, you can print the contents of the next one with this:

    p *$.next

You can print successive links in the chain by repeating this command--which you can do by just typing <RET>.

Note that the history records values, not expressions. If the value of `x` is 4 and you type these commands:

    print x
    set x=5

then the value recorded in the value history by the `print` command remains 4 even though the value of `x` has changed.

`show values`
  Print the last ten values in the value history, with their item numbers. This is like `p $$9` repeated ten times, except that `show values` does not change the history.
`show values n`
  Print ten history values centered on history item number n.
`show values +`
  Print ten history values just after the values last printed. If no more values are available, `show values +` produces no display.

Pressing <RET> to repeat `show values n` has exactly the same effect as `show values +`.

Node:Convenience Vars, Next:Registers, Previous:Value History, Up:Data

## Convenience variables

GDB provides convenience variables that you can use within GDB to hold on to a value and refer to it later. These variables exist entirely within GDB; they are not part of your program, and setting a convenience variable has no direct effect on further execution of your program. That is why you can use them freely.

Convenience variables are prefixed with `$`. Any name preceded by `$` can be used for a convenience variable, unless it is one of the predefined machine-specific register names (see Registers). (Value history references, in contrast, are numbers preceded by `$`. See Value history.)

You can save a value in a convenience variable with an assignment expression, just as you would set a variable in your program. For example:

    set $foo = *object_ptr

would save in `$foo` the value contained in the object pointed to by `object_ptr`.

Using a convenience variable for the first time creates it, but its value is `void` until you assign a new value. You can alter the value with another assignment at any time.

Convenience variables have no fixed types. You can assign a convenience variable any type of value, including structures and arrays, even if that variable already has a value of a different type. The convenience variable, when used as an expression, has the type of its current value.

`show convenience`
  Print a list of convenience variables used so far, and their values. Abbreviated `show conv`.

One of the ways to use a convenience variable is as a counter to be incremented or a pointer to be advanced. For example, to print a field from successive elements of an array of structures:

    set $i = 0
    print bar[$i++]->contents

Repeat that command by typing <RET>.

Some convenience variables are created automatically by GDB and given values likely to be useful.

`$_`
  The variable `$_` is automatically set by the `x` command to the last address examined (see Examining memory). Other commands which provide a default address for `x` to examine also set `$_` to that address; these commands include `info line` and `info breakpoint`. The type of `$_` is `void *` except when set by the `x` command, in which case it is a pointer to the type of `$__`.
`$__`
  The variable `$__` is automatically set by the `x` command to the value found in the last address examined. Its type is chosen to match the format in which the data was printed.
`$_exitcode`
  The variable `$_exitcode` is automatically set to the exit code when the program being debugged terminates.

On HP-UX systems, if you refer to a function or variable name that begins with a dollar sign, GDB searches for a user or system name first, before it searches for a convenience variable.

Node:Registers, Next:Floating Point Hardware, Previous:Convenience Vars, Up:Data

## Registers

You can refer to machine register contents, in expressions, as variables with names starting with `$`. The names of registers are different for each machine; use `info registers` to see the names used on your machine.

`info registers`
  Print the names and values of all registers except floating-point registers (in the selected stack frame).
`info all-registers`
  Print the names and values of all registers, including floating-point registers.
`info registers regname ...`
  Print the relativized value of each specified register regname. As discussed in detail below, register values are normally relative to the selected stack frame. regname may be any register name valid on the machine you are using, with or without the initial `$`.

GDB has four "standard" register names that are available (in expressions) on most machines--whenever they do not conflict with an architecture's canonical mnemonics for registers. The register names `$pc` and `$sp` are used for the program counter register and the stack pointer. `$fp` is used for a register that contains a pointer to the current stack frame, and `$ps` is used for a register that contains the processor status. For example, you could print the program counter in hex with

    p/x $pc

or print the instruction to be executed next with

    x/i $pc

or add four to the stack pointer3 with

    set $sp += 4

Whenever possible, these four standard register names are available on your machine even though the machine has different canonical mnemonics, so long as there is no conflict. The `info registers` command shows the canonical names. For example, on the SPARC, `info registers` displays the processor status register as `$psr` but you can also refer to it as `$ps`; and on x86-based machines `$ps` is an alias for the EFLAGS register. GDB always considers the contents of an ordinary register as an integer when the register is examined in this way. Some machines have special registers which can hold nothing but floating point; these registers are considered to have floating point values. There is no way to refer to the contents of an ordinary register as floating point value (although you can print it as a floating point value with `print/f $regname`).

Some registers have distinct "raw" and "virtual" data formats. This means that the data format in which the register contents are saved by the operating system is not the same one that your program normally sees. For example, the registers of the 68881 floating point coprocessor are always saved in "extended" (raw) format, but all C programs expect to work with "double" (virtual) format. In such cases, GDB normally works with the virtual format only (the format that makes sense for your program), but the `info registers` command prints the data in both formats.

Normally, register values are relative to the selected stack frame (see Selecting a frame). This means that you get the value that the register would contain if all stack frames farther in were exited and their saved registers restored. In order to see the true contents of hardware registers, you must select the innermost frame (with `frame 0`).

However, GDB must deduce where registers are saved, from the machine code generated by your compiler. If some registers are not saved, or if GDB is unable to locate the saved registers, the selected stack frame makes no difference.

Node:Floating Point Hardware, Previous:Registers, Up:Data

## Floating point hardware

Depending on the configuration, GDB may be able to give you more information about the status of the floating point hardware.

`info float`
  Display hardware-dependent information about the floating point unit. The exact contents and layout vary depending on the floating point chip. Currently, `info float` is supported on the ARM and x86 machines.

Node:Languages, Next:Symbols, Previous:Data, Up:Top

# Using GDB with Different Languages

Although programming languages generally have common aspects, they are rarely expressed in the same manner. For instance, in ANSI C, dereferencing a pointer `p` is accomplished by `*p`, but in Modula-2, it is accomplished by `p^`. Values can also be represented (and displayed) differently. Hex numbers in C appear as `0x1ae`, while in Modula-2 they appear as `1AEH`.

Language-specific information is built into GDB for some languages, allowing you to express operations like the above in your program's native language, and allowing GDB to output values in a manner consistent with the syntax of your program's native language. The language you use to build expressions is called the working language.

- Setting: Switching between source languages
- Show: Displaying the language
- Checks: Type and range checks
- Support: Supported languages

Node:Setting, Next:Show, Up:Languages

## Switching between source languages

There are two ways to control the working language--either have GDB set it automatically, or select it manually yourself. You can use the `set language` command for either purpose. On startup, GDB defaults to setting the language automatically. The working language is used to determine how expressions you type are interpreted, how values are printed, etc.

In addition to the working language, every source file that GDB knows about has its own working language. For some object file formats, the compiler might indicate which language a particular source file is in. However, most of the time GDB infers the language from the name of the file. The language of a source file controls whether C++ names are demangled--this way `backtrace` can show each frame appropriately for its own language. There is no way to set the language of a source file from within GDB, but you can set the language associated with a filename extension. See Displaying the language.

This is most commonly a problem when you use a program, such as `cfront` or `f2c`, that generates C but is written in another language. In that case, make the program use `#line` directives in its C output; that way GDB will know the correct language of the source code of the original program, and will display that source code, not the generated C code.

- Filenames: Filename extensions and languages.
- Manually: Setting the working language manually
- Automatically: Having GDB infer the source language

Node:Filenames, Next:Manually, Up:Setting

### List of filename extensions and languages

If a source file name ends in one of the following extensions, then GDB infers that its language is the one indicated.

`.c`
  C source file
`.C`
`.cc`
`.cp`
`.cpp`
`.cxx`
`.c++`
  C++ source file
`.f`
`.F`
  Fortran source file
`.ch`
`.c186`
`.c286`
  CHILL source file
`.mod`
  Modula-2 source file
`.s`
`.S`
  Assembler source file. This actually behaves almost like C, but GDB does not skip over function prologues when stepping.

In addition, you may set the language associated with a filename extension. See Displaying the language.

Node:Manually, Next:Automatically, Previous:Filenames, Up:Setting

### Setting the working language

If you allow GDB to set the language automatically, expressions are interpreted the same way in your debugging session and your program.

If you wish, you may set the language manually. To do this, issue the command `set language lang`, where lang is the name of a language, such as `c` or `modula-2`. For a list of the supported languages, type `set language`.

Setting the language manually prevents GDB from updating the working language automatically. This can lead to confusion if you try to debug a program when the working language is not the same as the source language, when an expression is acceptable to both languages--but means different things. For instance, if the current source file were written in C, and GDB was parsing Modula-2, a command such as:

    print a = b + c

might not have the effect you intended. In C, this means to add `b` and `c` and place the result in `a`. The result printed would be the value of `a`. In Modula-2, this means to compare `a` to the result of `b+c`, yielding a `BOOLEAN` value.

Node:Automatically, Previous:Manually, Up:Setting

### Having GDB infer the source language

To have GDB set the working language automatically, use `set language local` or `set language auto`. GDB then infers the working language. That is, when your program stops in a frame (usually by encountering a breakpoint), GDB sets the working language to the language recorded for the function in that frame. If the language for a frame is unknown (that is, if the function or block corresponding to the frame was defined in a source file that does not have a recognized extension), the current working language is not changed, and GDB issues a warning.

This may not seem necessary for most programs, which are written entirely in one source language. However, program modules and libraries written in one source language can be used by a main program written in a different source language. Using `set language auto` in this case frees you from having to set the working language manually.

Node:Show, Next:Checks, Previous:Setting, Up:Languages

## Displaying the language

The following commands help you find out which language is the working language, and also what language source files were written in.

`show language`
  Display the current working language. This is the language you can use with commands such as `print` to build and compute expressions that may involve variables in your program.
`info frame`
  Display the source language for this frame. This language becomes the working language if you use an identifier from this frame. See Information about a frame, to identify the other information listed here.
`info source`
  Display the source language of this source file. See Examining the Symbol Table, to identify the other information listed here.

In unusual circumstances, you may have source files with extensions not in the standard list. You can then set the extension associated with a language explicitly:

`set extension-language .ext language`
  Set source files with extension .ext to be assumed to be in the source language language.
`info extensions`
  List all the filename extensions and the associated languages.

Node:Checks, Next:Support, Previous:Show, Up:Languages

## Type and range checking

> Warning: In this release, the GDB commands for type and range checking are included, but they do not yet have any effect. This section documents the intended facilities.

Some languages are designed to guard you against making seemingly common errors through a series of compile- and run-time checks. These include checking the type of arguments to functions and operators, and making sure mathematical overflows are caught at run time. Checks such as these help to ensure a program's correctness once it has been compiled by eliminating type mismatches, and providing active checks for range errors when your program is running. GDB can check for conditions like the above if you wish. Although GDB does not check the statements in your program, it can check expressions entered directly into GDB for evaluation via the `print` command, for example. As with the working language, GDB can also decide whether or not to check automatically based on your program's source language. See Supported languages, for the default settings of supported languages.

- Type Checking: An overview of type checking
- Range Checking: An overview of range checking

Node:Type Checking, Next:Range Checking, Up:Checks

### An overview of type checking

Some languages, such as Modula-2, are strongly typed, meaning that the arguments to operators and functions have to be of the correct type, otherwise an error occurs. These checks prevent type mismatch errors from ever causing any run-time problems. For example,

    1 + 2 => 3

    but

    error--> 1 + 2.3

The second example fails because the `CARDINAL` 1 is not type-compatible with the `REAL` 2.3.

For the expressions you use in GDB commands, you can tell the GDB type checker to skip checking; to treat any mismatches as errors and abandon the expression; or to only issue warnings when type mismatches occur, but evaluate the expression anyway. When you choose the last of these, GDB evaluates expressions like the second example above, but also issues a warning.

Even if you turn type checking off, there may be other reasons related to type that prevent GDB from evaluating an expression. For instance, GDB does not know how to add an `int` and a `struct foo`. These particular type errors have nothing to do with the language in use, and usually arise from expressions, such as the one described above, which make little sense to evaluate anyway.

Each language defines to what degree it is strict about type. For instance, both Modula-2 and C require the arguments to arithmetical operators to be numbers. In C, enumerated types and pointers can be represented as numbers, so that they are valid arguments to mathematical operators. See Supported languages, for further details on specific languages. GDB provides some additional commands for controlling the type checker:

`set check type auto`
  Set type checking on or off based on the current working language. See Supported languages, for the default settings for each language.
`set check type on`
`set check type off`
  Set type checking on or off, overriding the default setting for the current working language. Issue a warning if the setting does not match the language default. If any type mismatches occur in evaluating an expression while type checking is on, GDB prints a message and aborts evaluation of the expression.
`set check type warn`
  Cause the type checker to issue warnings, but to always attempt to evaluate the expression. Evaluating the expression may still be impossible for other reasons. For example, GDB cannot add numbers and structures.
`show type`
  Show the current setting of the type checker, and whether or not GDB is setting it automatically.

Node:Range Checking, Previous:Type Checking, Up:Checks

### An overview of range checking

In some languages (such as Modula-2), it is an error to exceed the bounds of a type; this is enforced with run-time checks. Such range checking is meant to ensure program correctness by making sure computations do not overflow, or indices on an array element access do not exceed the bounds of the array.

For expressions you use in GDB commands, you can tell GDB to treat range errors in one of three ways: ignore them, always treat them as errors and abandon the expression, or issue warnings but evaluate the expression anyway.

A range error can result from numerical overflow, from exceeding an array index bound, or when you type a constant that is not a member of any type. Some languages, however, do not treat overflows as an error. In many implementations of C, mathematical overflow causes the result to "wrap around" to lower values--for example, if m is the largest integer value, and s is the smallest, then

    m + 1 => s

This, too, is specific to individual languages, and in some cases specific to individual compilers or machines. See Supported languages, for further details on specific languages. GDB provides some additional commands for controlling the range checker:

`set check range auto`
  Set range checking on or off based on the current working language. See Supported languages, for the default settings for each language.
`set check range on`
`set check range off`
  Set range checking on or off, overriding the default setting for the current working language. A warning is issued if the setting does not match the language default. If a range error occurs and range checking is on, then a message is printed and evaluation of the expression is aborted.
`set check range warn`
  Output messages when the GDB range checker detects a range error, but attempt to evaluate the expression anyway. Evaluating the expression may still be impossible for other reasons, such as accessing memory that the process does not own (a typical example from many Unix systems).
`show range`
  Show the current setting of the range checker, and whether or not it is being set automatically by GDB.

Node:Support, Previous:Checks, Up:Languages

## Supported languages

GDB supports C, C++, Fortran, Java, Chill, assembly, and Modula-2. Some GDB features may be used in expressions regardless of the language you use: the GDB `@` and `::` operators, and the `{type}addr` construct (see Expressions) can be used with the constructs of any supported language.

The following sections detail to what degree each source language is supported by GDB. These sections are not meant to be language tutorials or references, but serve only as a reference guide to what the GDB expression parser accepts, and what input and output formats should look like for different languages. There are many good books written on each of these languages; please look to these for a language reference or tutorial.

- C: C and C++
- Modula-2: Modula-2
- Chill: Chill

Node:C, Next:Modula-2, Up:Support

### C and C++

Since C and C++ are so closely related, many features of GDB apply to both languages. Whenever this is the case, we discuss those languages together.

The C++ debugging facilities are jointly implemented by the C++ compiler and GDB. Therefore, to debug your C++ code effectively, you must compile your C++ programs with a supported C++ compiler, such as GNU `g++`, or the HP ANSI C++ compiler (`aCC`).

For best results when using GNU C++, use the stabs debugging format. You can select that format explicitly with the `g++` command-line options `-gstabs` or `-gstabs+`. See Debugging Options, for more information.

- C Operators: C and C++ operators
- C Constants: C and C++ constants
- C plus plus expressions: C++ expressions
- C Defaults: Default settings for C and C++
- C Checks: C and C++ type and range checks
- Debugging C: GDB and C
- Debugging C plus plus: GDB features for C++

Node:C Operators, Next:C Constants, Up:C

#### C and C++ operators

Operators must be defined on values of specific types. For instance, `+` is defined on numbers, but not on structures. Operators are often defined on groups of types.

For the purposes of C and C++, the following definitions hold:

- Integral types include `int` with any of its storage-class specifiers; `char`; `enum`; and, for C++, `bool`.
- Floating-point types include `float`, `double`, and `long double` (if supported by the target platform).
- Pointer types include all types defined as `(type *)`.
- Scalar types include all of the above.

The following operators are supported. They are listed here in order of increasing precedence:

`,`
  The comma or sequencing operator. Expressions in a comma-separated list are evaluated from left to right, with the result of the entire expression being the last expression evaluated.
`=`
  Assignment. The value of an assignment expression is the value assigned. Defined on scalar types.
`op=`
  Used in an expression of the form `a op= b`, and translated to `a = a op b`. `op=` and `=` have the same precedence. op is any one of the operators `|`, `^`, `&`, `<<`, `>>`, `+`, `-`, `*`, `/`, `%`.
`?:`
  The ternary operator. `a ? b : c` can be thought of as: if a then b else c. a should be of an integral type.
`||`
  Logical OR. Defined on integral types.
`&&`
  Logical AND. Defined on integral types.
`|`
  Bitwise OR. Defined on integral types.
`^`
  Bitwise exclusive-OR. Defined on integral types.
`&`
  Bitwise AND. Defined on integral types.
`==, !=`
  Equality and inequality. Defined on scalar types. The value of these expressions is 0 for false and non-zero for true.
`<, >, <=, >=`
  Less than, greater than, less than or equal, greater than or equal. Defined on scalar types. The value of these expressions is 0 for false and non-zero for true.
`<<, >>`
  left shift, and right shift. Defined on integral types.
`@`
  The GDB "artificial array" operator (see Expressions).
`+, -`
  Addition and subtraction. Defined on integral types, floating-point types and pointer types.
`*, /, %`
  Multiplication, division, and modulus. Multiplication and division are defined on integral and floating-point types. Modulus is defined on integral types.
`++, --`
  Increment and decrement. When appearing before a variable, the operation is performed before the variable is used in an expression; when appearing after it, the variable's value is used before the operation takes place.
`*`
  Pointer dereferencing. Defined on pointer types. Same precedence as `++`.
`&`
  Address operator. Defined on variables. Same precedence as `++`.

  For debugging C++, GDB implements a use of `&` beyond what is allowed in the C++ language itself: you can use `&(&ref)` (or, if you prefer, simply `&&ref`) to examine the address where a C++ reference variable (declared with `&ref`) is stored.

`-`
  Negative. Defined on integral and floating-point types. Same precedence as `++`.
`!`
  Logical negation. Defined on integral types. Same precedence as `++`.
`~`
  Bitwise complement operator. Defined on integral types. Same precedence as `++`.
`., ->`
  Structure member, and pointer-to-structure member. For convenience, GDB regards the two as equivalent, choosing whether to dereference a pointer based on the stored type information. Defined on `struct` and `union` data.
`.*, ->*`
  Dereferences of pointers to members.
`[]`
  Array indexing. `a[i]` is defined as `*(a+i)`. Same precedence as `->`.
`()`
  Function parameter list. Same precedence as `->`.
`::`
  C++ scope resolution operator. Defined on `struct`, `union`, and `class` types.
`::`
  Doubled colons also represent the GDB scope operator (see Expressions). Same precedence as `::`, above.

If an operator is redefined in the user code, GDB usually attempts to invoke the redefined version instead of using the operator's predefined meaning.

- C Constants:

Node:C Constants, Next:C plus plus expressions, Previous:C Operators, Up:C

#### C and C++ constants

GDB allows you to express the constants of C and C++ in the following ways:

- Integer constants are a sequence of digits. Octal constants are specified by a leading `0` (i.e. zero), and hexadecimal constants by a leading `0x` or `0X`. Constants may also end with a letter `l`, specifying that the constant should be treated as a `long` value.
- Floating point constants are a sequence of digits, followed by a decimal point, followed by a sequence of digits, and optionally followed by an exponent. An exponent is of the form: `e[[+]|-]nnn`, where nnn is another sequence of digits. The `+` is optional for positive exponents. A floating-point constant may also end with a letter `f` or `F`, specifying that the constant should be treated as being of the `float` (as opposed to the default `double`) type; or with a letter `l` or `L`, which specifies a `long double` constant.
- Enumerated constants consist of enumerated identifiers, or their integral equivalents.
- Character constants are a single character surrounded by single quotes (`'`), or a number--the ordinal value of the corresponding character (usually its ASCII value). Within quotes, the single character may be represented by a letter or by escape sequences, which are of the form `\nnn`, where nnn is the octal representation of the character's ordinal value; or of the form `\x`, where `x` is a predefined special character--for example, `\n` for newline.
- String constants are a sequence of character constants surrounded by double quotes (`"`). Any valid character constant (as described above) may appear. Double quotes within the string must be preceded by a backslash, so for instance `"a\"b'c"` is a string of five characters.
- Pointer constants are an integral value. You can also write pointers to constants using the C operator `&`.
- Array constants are comma-separated lists surrounded by braces `{` and `}`; for example, `{1,2,3}` is a three-element array of integers, `{{1,2}, {3,4}, {5,6}}` is a three-by-two array, and `{&"hi", &"there", &"fred"}` is a three-element array of pointers.

- C plus plus expressions:
- C Defaults:
- C Checks:

- Debugging C:

Node:C plus plus expressions, Next:C Defaults, Previous:C Constants, Up:C

#### C++ expressions

GDB expression handling can interpret most C++ expressions.

> Warning: GDB can only debug C++ code if you use the proper compiler. Typically, C++ debugging depends on the use of additional debugging information in the symbol table, and thus requires special support. In particular, if your compiler generates a.out, MIPS ECOFF, RS/6000 XCOFF, or ELF with stabs extensions to the symbol table, these facilities are all available. (With GNU CC, you can use the `-gstabs` option to request stabs debugging extensions explicitly.) Where the object code format is standard COFF or DWARF in ELF, on the other hand, most of the C++ support in GDB does not work.

1. Member function calls are allowed; you can use expressions like

       count = aml->GetOriginal(x, y)

2. While a member function is active (in the selected stack frame), your expressions have the same namespace available as the member function; that is, GDB allows implicit references to the class instance pointer `this` following the same rules as C++.
3. You can call overloaded functions; GDB resolves the function call to the right definition, with some restrictions. GDB does not perform overload resolution involving user-defined type conversions, calls to constructors, or instantiations of templates that do not exist in the program. It also cannot handle ellipsis argument lists or default arguments.

   It does perform integral conversions and promotions, floating-point promotions, arithmetic conversions, pointer conversions, conversions of class objects to base classes, and standard conversions such as those of functions or arrays to pointers; it requires an exact match on the number of function arguments.

   Overload resolution is always performed, unless you have specified `set overload-resolution off`. See GDB features for C++.

   You must specify `set overload-resolution off` in order to use an explicit function signature to call an overloaded function, as in

       p 'foo(char,int)'('x', 13)

   The GDB command-completion facility can simplify this; see Command completion.

4. GDB understands variables declared as C++ references; you can use them in expressions just as you do in C++ source--they are automatically dereferenced.

   In the parameter list shown when GDB displays a frame, the values of reference variables are not displayed (unlike other variables); this avoids clutter, since references are often used for large structures. The address of a reference variable is always shown, unless you have specified `set print address off`.

5. GDB supports the C++ name resolution operator `::`--your expressions can use it just as expressions in your program do. Since one scope may be defined in another, you can use `::` repeatedly if necessary, for example in an expression like `scope1::scope2::name`. GDB also allows resolving name scope by reference to source files, in both C and C++ debugging (see Program variables).

In addition, when used with HP's C++ compiler, GDB supports calling virtual functions correctly, printing out virtual bases of objects, calling functions in a base subobject, casting objects, and invoking user-defined operators.

Node:C Defaults, Next:C Checks, Previous:C plus plus expressions, Up:C

#### C and C++ defaults

If you allow GDB to set type and range checking automatically, they both default to `off` whenever the working language changes to C or C++. This happens regardless of whether you or GDB selects the working language.

If you allow GDB to set the language automatically, it recognizes source files whose names end with `.c`, `.C`, or `.cc`, etc, and when GDB enters code compiled from one of these files, it sets the working language to C or C++. See Having GDB infer the source language, for further details.

Node:C Checks, Next:Debugging C, Previous:C Defaults, Up:C

#### C and C++ type and range checks

By default, when GDB parses C or C++ expressions, type checking is not used. However, if you turn type checking on, GDB considers two variables type equivalent if:

- The two variables are structured and have the same structure, union, or enumerated tag.
- The two variables have the same type name, or types that have been declared equivalent through `typedef`.

Range checking, if turned on, is done on mathematical operations. Array indices are not checked, since they are often used to index a pointer that is not itself an array.

Node:Debugging C, Next:Debugging C plus plus, Previous:C Checks, Up:C

#### GDB and C

The `set print union` and `show print union` commands apply to the `union` type. When set to `on`, any `union` that is inside a `struct` or `class` is also printed. Otherwise, it appears as `{...}`.

The `@` operator aids in the debugging of dynamic arrays, formed with pointers and a memory allocation function. See Expressions.

- Debugging C plus plus:

Node:Debugging C plus plus, Previous:Debugging C, Up:C

#### GDB features for C++

Some GDB commands are particularly useful with C++, and some are designed specifically for use with C++. Here is a summary:

`breakpoint menus`
  When you want a breakpoint in a function whose name is overloaded, GDB breakpoint menus help you specify which function definition you want. See Breakpoint menus.
`rbreak regex`
  Setting breakpoints using regular expressions is helpful for setting breakpoints on overloaded functions that are not members of any special classes. See Setting breakpoints.
`catch throw`
`catch catch`
  Debug C++ exception handling using these commands. See Setting catchpoints.
`ptype typename`
  Print inheritance relationships as well as other information for type typename. See Examining the Symbol Table.
`set print demangle`
`show print demangle`
`set print asm-demangle`
`show print asm-demangle`
  Control whether C++ symbols display in their source form, both when displaying code as C++ source and when displaying disassemblies. See Print settings.
`set print object`
`show print object`
  Choose whether to print derived (actual) or declared types of objects. See Print settings.
`set print vtbl`
`show print vtbl`
  Control the format for printing virtual function tables. See Print settings. (The `vtbl` commands do not work on programs compiled with the HP ANSI C++ compiler (`aCC`).)
`set overload-resolution on`
  Enable overload resolution for C++ expression evaluation. The default is on. For overloaded functions, GDB evaluates the arguments and searches for a function whose signature matches the argument types, using the standard C++ conversion rules (see C++ expressions, for details). If it cannot find a match, it emits a message.
`set overload-resolution off`
  Disable overload resolution for C++ expression evaluation. For overloaded functions that are not class member functions, GDB chooses the first function of the specified name that it finds in the symbol table, whether or not its arguments are of the correct type. For overloaded functions that are class member functions, GDB searches for a function whose signature exactly matches the argument types.
`Overloaded symbol names`
  You can specify a particular definition of an overloaded symbol, using the same notation that is used to declare such symbols in C++: type `symbol(types)` rather than just symbol. You can also use the GDB command-line word completion facilities to list the available choices, or to finish the type list for you. See Command completion, for details on how to do this.

Node:Modula-2, Next:Chill, Previous:C, Up:Support

### Modula-2

The extensions made to GDB to support Modula-2 only support output from the GNU Modula-2 compiler (which is currently being developed). Other Modula-2 compilers are not currently supported, and attempting to debug executables produced by them is most likely to give an error as GDB reads in the executable's symbol table.

- M2 Operators: Built-in operators
- Built-In Func/Proc: Built-in functions and procedures
- M2 Constants: Modula-2 constants
- M2 Defaults: Default settings for Modula-2
- Deviations: Deviations from standard Modula-2
- M2 Checks: Modula-2 type and range checks
- M2 Scope: The scope operators `::` and `.`
- GDB/M2: GDB and Modula-2

Node:M2 Operators, Next:Built-In Func/Proc, Up:Modula-2

#### Operators

Operators must be defined on values of specific types. For instance, `+` is defined on numbers, but not on structures. Operators are often defined on groups of types. For the purposes of Modula-2, the following definitions hold:

- Integral types consist of `INTEGER`, `CARDINAL`, and their subranges.
- Character types consist of `CHAR` and its subranges.
- Floating-point types consist of `REAL`.
- Pointer types consist of anything declared as `POINTER TO type`.
- Scalar types consist of all of the above.
- Set types consist of `SET` and `BITSET` types.
- Boolean types consist of `BOOLEAN`.

The following operators are supported, and appear in order of increasing precedence:

`,`
  Function argument or array index separator.
`:=`
  Assignment. The value of var `:=` value is value.
`<, >`
  Less than, greater than on integral, floating-point, or enumerated types.
`<=, >=`
  Less than or equal to, greater than or equal to on integral, floating-point and enumerated types, or set inclusion on set types. Same precedence as `<`.
`=, <>, #`
  Equality and two ways of expressing inequality, valid on scalar types. Same precedence as `<`. In GDB scripts, only `<>` is available for inequality, since `#` conflicts with the script comment character.
`IN`
  Set membership. Defined on set types and the types of their members. Same precedence as `<`.
`OR`
  Boolean disjunction. Defined on boolean types.
`AND, &`
  Boolean conjunction. Defined on boolean types.
`@`
  The GDB "artificial array" operator (see Expressions).
`+, -`
  Addition and subtraction on integral and floating-point types, or union and difference on set types.
`*`
  Multiplication on integral and floating-point types, or set intersection on set types.
`/`
  Division on floating-point types, or symmetric set difference on set types. Same precedence as `*`.
`DIV, MOD`
  Integer division and remainder. Defined on integral types. Same precedence as `*`.
`-`
  Negative. Defined on `INTEGER` and `REAL` data.
`^`
  Pointer dereferencing. Defined on pointer types.
`NOT`
  Boolean negation. Defined on boolean types. Same precedence as `^`.
`.`
  `RECORD` field selector. Defined on `RECORD` data. Same precedence as `^`.
`[]`
  Array indexing. Defined on `ARRAY` data. Same precedence as `^`.
`()`
  Procedure argument list. Defined on `PROCEDURE` objects. Same precedence as `^`.
`::, .`
  GDB and Modula-2 scope operators.

> Warning: Sets and their operations are not yet supported, so GDB treats the use of the operator `IN`, or the use of operators `+`, `-`, `*`, `/`, `=`, , `<>`, `#`, `<=`, and `>=` on sets as an error.

Node:Built-In Func/Proc, Next:M2 Constants, Previous:M2 Operators, Up:Modula-2

#### Built-in functions and procedures

Modula-2 also makes available several built-in procedures and functions. In describing these, the following metavariables are used:

a
  represents an `ARRAY` variable.
c
  represents a `CHAR` constant or variable.
i
  represents a variable or constant of integral type.
m
  represents an identifier that belongs to a set. Generally used in the same function with the metavariable s. The type of s should be `SET OF mtype` (where mtype is the type of m).
n
  represents a variable or constant of integral or floating-point type.
r
  represents a variable or constant of floating-point type.
t
  represents a type.
v
  represents a variable.
x
  represents a variable or constant of one of many types. See the explanation of the function for details.

All Modula-2 built-in procedures also return a result, described below.

`ABS(n)`
  Returns the absolute value of n.
`CAP(c)`
  If c is a lower case letter, it returns its upper case equivalent, otherwise it returns its argument.
`CHR(i)`
  Returns the character whose ordinal value is i.
`DEC(v)`
  Decrements the value in the variable v by one. Returns the new value.
`DEC(v,i)`
  Decrements the value in the variable v by i. Returns the new value.
`EXCL(m,s)`
  Removes the element m from the set s. Returns the new set.
`FLOAT(i)`
  Returns the floating point equivalent of the integer i.
`HIGH(a)`
  Returns the index of the last member of a.
`INC(v)`
  Increments the value in the variable v by one. Returns the new value.
`INC(v,i)`
  Increments the value in the variable v by i. Returns the new value.
`INCL(m,s)`
  Adds the element m to the set s if it is not already there. Returns the new set.
`MAX(t)`
  Returns the maximum value of the type t.
`MIN(t)`
  Returns the minimum value of the type t.
`ODD(i)`
  Returns boolean TRUE if i is an odd number.
`ORD(x)`
  Returns the ordinal value of its argument. For example, the ordinal value of a character is its ASCII value (on machines supporting the ASCII character set). x must be of an ordered type, which include integral, character and enumerated types.
`SIZE(x)`
  Returns the size of its argument. x can be a variable or a type.
`TRUNC(r)`
  Returns the integral part of r.
`VAL(t,i)`
  Returns the member of the type t whose ordinal value is i.

> Warning: Sets and their operations are not yet supported, so GDB treats the use of procedures `INCL` and `EXCL` as an error.

Node:M2 Constants, Next:M2 Defaults, Previous:Built-In Func/Proc, Up:Modula-2

#### Constants

GDB allows you to express the constants of Modula-2 in the following ways:

- Integer constants are simply a sequence of digits. When used in an expression, a constant is interpreted to be type-compatible with the rest of the expression. Hexadecimal integers are specified by a trailing `H`, and octal integers by a trailing `B`.
- Floating point constants appear as a sequence of digits, followed by a decimal point and another sequence of digits. An optional exponent can then be specified, in the form `E[+|-]nnn`, where `[+|-]nnn` is the desired exponent. All of the digits of the floating point constant must be valid decimal (base 10) digits.
- Character constants consist of a single character enclosed by a pair of like quotes, either single (`'`) or double (`"`). They may also be expressed by their ordinal value (their ASCII value, usually) followed by a `C`.
- String constants consist of a sequence of characters enclosed by a pair of like quotes, either single (`'`) or double (`"`). Escape sequences in the style of C are also allowed. See C and C++ constants, for a brief explanation of escape sequences.
- Enumerated constants consist of an enumerated identifier.
- Boolean constants consist of the identifiers `TRUE` and `FALSE`.
- Pointer constants consist of integral values only.
- Set constants are not yet supported.

Node:M2 Defaults, Next:Deviations, Previous:M2 Constants, Up:Modula-2

#### Modula-2 defaults

If type and range checking are set automatically by GDB, they both default to `on` whenever the working language changes to Modula-2. This happens regardless of whether you or GDB selected the working language.

If you allow GDB to set the language automatically, then entering code compiled from a file whose name ends with `.mod` sets the working language to Modula-2. See Having GDB set the language automatically, for further details.

Node:Deviations, Next:M2 Checks, Previous:M2 Defaults, Up:Modula-2

#### Deviations from standard Modula-2

A few changes have been made to make Modula-2 programs easier to debug. This is done primarily via loosening its type strictness:

- Unlike in standard Modula-2, pointer constants can be formed by integers. This allows you to modify pointer variables during debugging. (In standard Modula-2, the actual address contained in a pointer variable is hidden from you; it can only be modified through direct assignment to another pointer variable or expression that returned a pointer.)
- C escape sequences can be used in strings and characters to represent non-printable characters. GDB prints out strings with these escape sequences embedded. Single non-printable characters are printed using the `CHR(nnn)` format.
- The assignment operator (`:=`) returns the value of its right-hand argument.
- All built-in procedures both modify and return their argument.

Node:M2 Checks, Next:M2 Scope, Previous:Deviations, Up:Modula-2

#### Modula-2 type and range checks

> Warning: in this release, GDB does not yet perform type or range checking.

GDB considers two Modula-2 variables type equivalent if:

- They are of types that have been declared equivalent via a `TYPE t1 = t2` statement
- They have been declared on the same line. (Note: This is true of the GNU Modula-2 compiler, but it may not be true of other compilers.)

As long as type checking is enabled, any attempt to combine variables whose types are not equivalent is an error.

Range checking is done on all mathematical operations, assignment, array index bounds, and all built-in functions and procedures.

Node:M2 Scope, Next:GDB/M2, Previous:M2 Checks, Up:Modula-2

#### The scope operators `::` and `.`

There are a few subtle differences between the Modula-2 scope operator (`.`) and the GDB scope operator (`::`). The two have similar syntax:

    module . id
    scope :: id

where scope is the name of a module or a procedure, module the name of a module, and id is any declared identifier within your program, except another module.

Using the `::` operator makes GDB search the scope specified by scope for the identifier id. If it is not found in the specified scope, then GDB searches all scopes enclosing the one specified by scope.

Using the `.` operator makes GDB search the current scope for the identifier specified by id that was imported from the definition module specified by module. With this operator, it is an error if the identifier id was not imported from definition module module, or if id is not an identifier in module.

Node:GDB/M2, Previous:M2 Scope, Up:Modula-2

#### GDB and Modula-2

Some GDB commands have little use when debugging Modula-2 programs. Five subcommands of `set print` and `show print` apply specifically to C and C++: `vtbl`, `demangle`, `asm-demangle`, `object`, and `union`. The first four apply to C++, and the last to the C `union` type, which has no direct analogue in Modula-2.

The `@` operator (see Expressions), while available with any language, is not useful with Modula-2. Its intent is to aid the debugging of dynamic arrays, which cannot be created in Modula-2 as they can in C or C++. However, because an address can be specified by an integral constant, the construct `{type}adrexp` is still useful.

In GDB scripts, the Modula-2 inequality operator `#` is interpreted as the beginning of a comment. Use `<>` instead.

Node:Chill, Previous:Modula-2, Up:Support

### Chill

The extensions made to GDB to support Chill only support output from the GNU Chill compiler. Other Chill compilers are not currently supported, and attempting to debug executables produced by them is most likely to give an error as GDB reads in the executable's symbol table.

This section covers the Chill related topics and the features of GDB which support these topics.

- How modes are displayed: How modes are displayed
- Locations: Locations and their accesses
- Values and their Operations: Values and their Operations
- Chill type and range checks:
- Chill defaults:

Node:How modes are displayed, Next:Locations, Up:Chill

#### How modes are displayed

The Chill Datatype- (Mode) support of GDB is directly related with the functionality of the GNU Chill compiler, and therefore deviates slightly from the standard specification of the Chill language. The provided modes are:

`Discrete modes:`
  - Integer Modes which are predefined by `BYTE, UBYTE, INT, UINT, LONG, ULONG`,
  - Boolean Mode which is predefined by `BOOL`,
  - Character Mode which is predefined by `CHAR`,
  - Set Mode which is displayed by the keyword `SET`.

        (gdb) ptype x
        type = SET (karli = 10, susi = 20, fritzi = 100)

    If the type is an unnumbered set the set element values are omitted.
  - Range Mode which is displayed by

        type = <basemode>(<lower bound> : <upper bound>)

    where `<lower bound>, <upper bound>` can be of any discrete literal expression (e.g. set element names).
`Powerset Mode:`
  A Powerset Mode is displayed by the keyword `POWERSET` followed by the member mode of the powerset. The member mode can be any discrete mode.

      (gdb) ptype x
      type = POWERSET SET (egon, hugo, otto)

`Reference Modes:`
  - Bound Reference Mode which is displayed by the keyword `REF` followed by the mode name to which the reference is bound.
  - Free Reference Mode which is displayed by the keyword `PTR`.
`Procedure mode`
  The procedure mode is displayed by `type = PROC(<parameter list>) <return mode> EXCEPTIONS (<exception list>)`. The `<parameter list>` is a list of the parameter modes. `<return mode>` indicates the mode of the result of the procedure if any. The exceptionlist lists all possible exceptions which can be raised by the procedure.
`Synchronization Modes:`
  - Event Mode which is displayed by

        EVENT (<event length>)

    where `(<event length>)` is optional.
  - Buffer Mode which is displayed by

        BUFFER (<buffer length>)<buffer element mode>

    where `(<buffer length>)` is optional.
`Timing Modes:`
  - Duration Mode which is predefined by `DURATION`
  - Absolute Time Mode which is predefined by `TIME`
`Real Modes:`
  Real Modes are predefined with `REAL` and `LONG_REAL`.
`String Modes:`
  - Character String Mode which is displayed by

        CHARS(<string length>)

    followed by the keyword `VARYING` if the String Mode is a varying mode
  - Bit String Mode which is displayed by

        BOOLS(<string
        length>)

`Array Mode:`
  The Array Mode is displayed by the keyword `ARRAY(<range>)` followed by the element mode (which may in turn be an array mode).

      (gdb) ptype x
      type = ARRAY (1:42)
                ARRAY (1:20)
                   SET (karli = 10, susi = 20, fritzi = 100)

`Structure Mode`
  The Structure mode is displayed by the keyword `STRUCT(<field list>)`. The `<field list>` consists of names and modes of fields of the structure. Variant structures have the keyword `CASE <field> OF <variant fields> ESAC` in their field list. Since the current version of the GNU Chill compiler doesn't implement tag processing (no runtime checks of variant fields, and therefore no debugging info), the output always displays all variant fields.

      (gdb) ptype str
      type = STRUCT (
          as x,
          bs x,
          CASE bs OF
          (karli):
              cs a
          (ott):
              ds x
          ESAC
      )

Node:Locations, Next:Values and their Operations, Previous:How modes are displayed, Up:Chill

#### Locations and their accesses

A location in Chill is an object which can contain values.

A value of a location is generally accessed by the (declared) name of the location. The output conforms to the specification of values in Chill programs. How values are specified is the topic of the next section, Values and their Operations.

The pseudo-location `RESULT` (or `result`) can be used to display or change the result of a currently-active procedure:

    set result := EXPR

This does the same as the Chill action `RESULT EXPR` (which is not available in GDB).

Values of reference mode locations are printed by `PTR(<hex value>)` in case of a free reference mode, and by `(REF <reference mode>) (<hex-value>)` in case of a bound reference. `<hex value>` represents the address where the reference points to. To access the value of the location referenced by the pointer, use the dereference operator `->`.

Values of procedure mode locations are displayed by

    { PROC
    (<argument modes> ) <return mode> } <address> <name of procedure
    location>

`<argument modes>` is a list of modes according to the parameter specification of the procedure and `<address>` shows the address of the entry point.

Substructures of string mode-, array mode- or structure mode-values (e.g. array slices, fields of structure locations) are accessed using certain operations which are described in the next section, Values and their Operations.

A location value may be interpreted as having a different mode using the location conversion. This mode conversion is written as `<mode name>(<location>)`. The user has to consider that the sizes of the modes have to be equal otherwise an error occurs. Furthermore, no range checking of the location against the destination mode is performed, and therefore the result can be quite confusing.

    (gdb) print int (s(3 up 4)) XXX TO be filled in !! XXX

Node:Values and their Operations, Next:Chill type and range checks, Previous:Locations, Up:Chill

#### Values and their Operations

Values are used to alter locations, to investigate complex structures in more detail or to filter relevant information out of a large amount of data. There are several (mode dependent) operations defined which enable such investigations. These operations are not only applicable to constant values but also to locations, which can become quite useful when debugging complex structures. During parsing the command line (e.g. evaluating an expression) GDB treats location names as the values behind these locations.

This section describes how values have to be specified and which operations are legal to be used with such values.

`Literal Values`
  Literal values are specified in the same manner as in GNU Chill programs. For detailed specification refer to the GNU Chill implementation Manual chapter 1.5.
`Tuple Values`
  A tuple is specified by `<mode name>[<tuple>]`, where `<mode name>` can be omitted if the mode of the tuple is unambiguous. This unambiguity is derived from the context of a evaluated expression. `<tuple>` can be one of the following:
  - Powerset Tuple
  - Array Tuple
  - Structure Tuple Powerset tuples, array tuples and structure tuples are specified in the same manner as in Chill programs refer to z200/88 chpt 5.2.5.
`String Element Value`
  A string element value is specified by

      <string value>(<index>)

  where `<index>` is a integer expression. It delivers a character value which is equivalent to the character indexed by `<index>` in the string.
`String Slice Value`
  A string slice value is specified by `<string value>(<slice spec>)`, where `<slice spec>` can be either a range of integer expressions or specified by `<start expr> up <size>`. `<size>` denotes the number of elements which the slice contains. The delivered value is a string value, which is part of the specified string.
`Array Element Values`
  An array element value is specified by `<array value>(<expr>)` and delivers a array element value of the mode of the specified array.
`Array Slice Values`
  An array slice is specified by `<array value>(<slice spec>)`, where `<slice spec>` can be either a range specified by expressions or by `<start expr> up <size>`. `<size>` denotes the number of arrayelements the slice contains. The delivered value is an array value which is part of the specified array.
`Structure Field Values`
  A structure field value is derived by `<structure value>.<field name>`, where `<field name>` indicates the name of a field specified in the mode definition of the structure. The mode of the delivered value corresponds to this mode definition in the structure definition.
`Procedure Call Value`
  The procedure call value is derived from the return value of the procedure4.

  Values of duration mode locations are represented by `ULONG` literals.

  Values of time mode locations appear as

      TIME(<secs>:<nsecs>)

`Zero-adic Operator Value`
  The zero-adic operator value is derived from the instance value for the current active process.
`Expression Values`
  The value delivered by an expression is the result of the evaluation of the specified expression. If there are error conditions (mode incompatibility, etc.) the evaluation of expressions is aborted with a corresponding error message. Expressions may be parenthesised which causes the evaluation of this expression before any other expression which uses the result of the parenthesised expression. The following operators are supported by GDB:
  ``OR, ORIF, XOR``
  ``AND, ANDIF``
  ``NOT``
    Logical operators defined over operands of boolean mode.
  ``=, /=``
    Equality and inequality operators defined over all modes.
  ``>, >=``
  ``<, <=``
    Relational operators defined over predefined modes.
  ``+, -``
  ``*, /, MOD, REM``
    Arithmetic operators defined over predefined modes.
  ``-``
    Change sign operator.
  ``//``
    String concatenation operator.
  ``()``
    String repetition operator.
  ``->``
    Referenced location operator which can be used either to take the address of a location (`->loc`), or to dereference a reference location (`loc->`).
  ``OR, XOR``
  ``AND``
  ``NOT``
    Powerset and bitstring operators.
  ``>, >=``
  ``<, <=``
    Powerset inclusion operators.
  ``IN``
    Membership operator.

Node:Chill type and range checks, Next:Chill defaults, Previous:Values and their Operations, Up:Chill

#### Chill type and range checks

GDB considers two Chill variables mode equivalent if the sizes of the two modes are equal. This rule applies recursively to more complex datatypes which means that complex modes are treated equivalent if all element modes (which also can be complex modes like structures, arrays, etc.) have the same size.

Range checking is done on all mathematical operations, assignment, array index bounds and all built in procedures.

Strong type checks are forced using the GDB command `set check strong`. This enforces strong type and range checks on all operations where Chill constructs are used (expressions, built in functions, etc.) in respect to the semantics as defined in the z.200 language specification.

All checks can be disabled by the GDB command `set check off`.

Node:Chill defaults, Previous:Chill type and range checks, Up:Chill

#### Chill defaults

If type and range checking are set automatically by GDB, they both default to `on` whenever the working language changes to Chill. This happens regardless of whether you or GDB selected the working language.

If you allow GDB to set the language automatically, then entering code compiled from a file whose name ends with `.ch` sets the working language to Chill. See Having GDB set the language automatically, for further details.

Node:Symbols, Next:Altering, Previous:Languages, Up:Top

# Examining the Symbol Table

The commands described in this chapter allow you to inquire about the symbols (names of variables, functions and types) defined in your program. This information is inherent in the text of your program and does not change as your program executes. GDB finds it in your program's symbol table, in the file indicated when you started GDB (see Choosing files), or by one of the file-management commands (see Commands to specify files).

Occasionally, you may need to refer to symbols that contain unusual characters, which GDB ordinarily treats as word delimiters. The most frequent case is in referring to static variables in other source files (see Program variables). File names are recorded in object files as debugging symbols, but GDB would ordinarily parse a typical file name, like `foo.c`, as the three words `foo` `.` `c`. To allow GDB to recognize `foo.c` as a single symbol, enclose it in single quotes; for example,

    p 'foo.c'::x

looks up the value of `x` in the scope of the file `foo.c`.

`info address symbol`
  Describe where the data for symbol is stored. For a register variable, this says which register it is kept in. For a non-register local variable, this prints the stack-frame offset at which the variable is always stored.

  Note the contrast with `print &symbol`, which does not work at all for a register variable, and for a stack local variable prints the exact address of the current instantiation of the variable.

`whatis expr`
  Print the data type of expression expr. expr is not actually evaluated, and any side-effecting operations (such as assignments or function calls) inside it do not take place. See Expressions.
`whatis`
  Print the data type of `$`, the last value in the value history.
`ptype typename`
  Print a description of data type typename. typename may be the name of a type, or for C code it may have the form `class class-name`, `struct struct-tag`, `union union-tag` or `enum enum-tag`.
`ptype expr`
`ptype`
  Print a description of the type of expression expr. `ptype` differs from `whatis` by printing a detailed description, instead of just the name of the type.

  For example, for this variable declaration:

      struct complex {double real; double imag;} v;

  the two commands give this output:

      (gdb) whatis v
      type = struct complex
      (gdb) ptype v
      type = struct complex {
          double real;
          double imag;
      }

  As with `whatis`, using `ptype` without an argument refers to the type of `$`, the last value in the value history.

`info types regexp`
`info types`
  Print a brief description of all types whose names match regexp (or all types in your program, if you supply no argument). Each complete typename is matched as though it were a complete line; thus, `i type value` gives information on all types in your program whose names include the string `value`, but `i type ^value$` gives information only on types whose complete name is `value`.

  This command differs from `ptype` in two ways: first, like `whatis`, it does not print a detailed description; second, it lists all source files where a type is defined.

`info source`
  Show the name of the current source file--that is, the source file for the function containing the current point of execution--and the language it was written in.
`info sources`
  Print the names of all source files in your program for which there is debugging information, organized into two lists: files whose symbols have already been read, and files whose symbols will be read when needed.
`info functions`
  Print the names and data types of all defined functions.
`info functions regexp`
  Print the names and data types of all defined functions whose names contain a match for regular expression regexp. Thus, `info fun step` finds all functions whose names include `step`; `info fun ^step` finds those whose names start with `step`.
`info variables`
  Print the names and data types of all variables that are declared outside of functions (i.e., excluding local variables).
`info variables regexp`
  Print the names and data types of all variables (except for local variables) whose names contain a match for regular expression regexp.

  Some systems allow individual object files that make up your program to be replaced without stopping and restarting your program. For example, in VxWorks you can simply recompile a defective object file and keep on running. If you are running on one of these systems, you can allow GDB to reload the symbols for automatically relinked modules:

  `set symbol-reloading on`
    Replace symbol definitions for the corresponding source file when an object file with a particular name is seen again.
  `set symbol-reloading off`
    Do not replace symbol definitions when encountering object files of the same name more than once. This is the default state; if you are not running on a system that permits automatic relinking of modules, you should leave `symbol-reloading` off, since otherwise GDB may discard symbols when linking large programs, that may contain several modules (from different directories or libraries) with the same name.
  `show symbol-reloading`
    Show the current `on` or `off` setting.
`set opaque-type-resolution on`
  Tell GDB to resolve opaque types. An opaque type is a type declared as a pointer to a `struct`, `class`, or `union`--for example, `struct MyType *`--that is used in one source file although the full declaration of `struct MyType` is in another source file. The default is on.

  A change in the setting of this subcommand will not take effect until the next time symbols for a file are loaded.

`set opaque-type-resolution off`
  Tell GDB not to resolve opaque types. In this case, the type is printed as follows:

      {<no data fields>}

`show opaque-type-resolution`
  Show whether opaque types are resolved or not.
`maint print symbols filename`
`maint print psymbols filename`
`maint print msymbols filename`
  Write a dump of debugging symbol data into the file filename. These commands are used to debug the GDB symbol-reading code. Only symbols with debugging data are included. If you use `maint print symbols`, GDB includes all the symbols for which it has already collected full details: that is, filename reflects symbols for only those files whose symbols GDB has read. You can use the command `info sources` to find out which files these are. If you use `maint print psymbols` instead, the dump shows information about symbols that GDB only knows partially--that is, symbols defined in files that GDB has skimmed, but not yet read completely. Finally, `maint print msymbols` dumps just the minimal symbol information required for each object file from which GDB has read some symbols. See Commands to specify files, for a discussion of how GDB reads symbols (in the description of `symbol-file`).

Node:Altering, Next:GDB Files, Previous:Symbols, Up:Top

# Altering Execution

Once you think you have found an error in your program, you might want to find out for certain whether correcting the apparent error would lead to correct results in the rest of the run. You can find the answer by experiment, using the GDB features for altering execution of the program.

For example, you can store new values into variables or memory locations, give your program a signal, restart it at a different address, or even return prematurely from a function.

- Assignment: Assignment to variables
- Jumping: Continuing at a different address
- Signaling: Giving your program a signal
- Returning: Returning from a function
- Calling: Calling your program's functions
- Patching: Patching your program

Node:Assignment, Next:Jumping, Up:Altering

## Assignment to variables

To alter the value of a variable, evaluate an assignment expression. See Expressions. For example,

    print x=4

stores the value 4 into the variable `x`, and then prints the value of the assignment expression (which is 4). See Using GDB with Different Languages, for more information on operators in supported languages.

If you are not interested in seeing the value of the assignment, use the `set` command instead of the `print` command. `set` is really the same as `print` except that the expression's value is not printed and is not put in the value history (see Value history). The expression is evaluated only for its effects.

If the beginning of the argument string of the `set` command appears identical to a `set` subcommand, use the `set variable` command instead of just `set`. This command is identical to `set` except for its lack of subcommands. For example, if your program has a variable `width`, you get an error if you try to set a new value with just `set width=13`, because GDB has the command `set width`:

    (gdb) whatis width
    type = double
    (gdb) p width
    $4 = 13
    (gdb) set width=47
    Invalid syntax in expression.

The invalid expression, of course, is `=47`. In order to actually set the program's variable `width`, use

    (gdb) set var width=47

Because the `set` command has many subcommands that can conflict with the names of program variables, it is a good idea to use the `set variable` command instead of just `set`. For example, if your program has a variable `g`, you run into problems if you try to set a new value with just `set g=4`, because GDB has the command `set gnutarget`, abbreviated `set g`:

    (gdb) whatis g
    type = double
    (gdb) p g
    $1 = 1
    (gdb) set g=4
    (gdb) p g
    $2 = 1
    (gdb) r
    The program being debugged has been started already.
    Start it from the beginning? (y or n) y
    Starting program: /home/smith/cc_progs/a.out
    "/home/smith/cc_progs/a.out": can't open to read symbols:
                                     Invalid bfd target.
    (gdb) show g
    The current BFD target is "=4".

The program variable `g` did not change, and you silently set the `gnutarget` to an invalid value. In order to set the variable `g`, use

    (gdb) set var g=4

GDB allows more implicit conversions in assignments than C; you can freely store an integer value into a pointer variable or vice versa, and you can convert any structure to any other structure that is the same length or shorter.

To store values into arbitrary places in memory, use the `{...}` construct to generate a value of specified type at a specified address (see Expressions). For example, `{int}0x83040` refers to memory location `0x83040` as an integer (which implies a certain size and representation in memory), and

    set {int}0x83040 = 4

stores the value 4 into that memory location.

Node:Jumping, Next:Signaling, Previous:Assignment, Up:Altering

## Continuing at a different address

Ordinarily, when you continue your program, you do so at the place where it stopped, with the `continue` command. You can instead continue at an address of your own choosing, with the following commands:

`jump linespec`
  Resume execution at line linespec. Execution stops again immediately if there is a breakpoint there. See Printing source lines, for a description of the different forms of linespec. It is common practice to use the `tbreak` command in conjunction with `jump`. See Setting breakpoints.

  The `jump` command does not change the current stack frame, or the stack pointer, or the contents of any memory location or any register other than the program counter. If line linespec is in a different function from the one currently executing, the results may be bizarre if the two functions expect different patterns of arguments or of local variables. For this reason, the `jump` command requests confirmation if the specified line is not in the function currently executing. However, even bizarre results are predictable if you are well acquainted with the machine-language code of your program.

`jump *address`
  Resume execution at the instruction at address address.

On many systems, you can get much the same effect as the `jump` command by storing a new value into the register `$pc`. The difference is that this does not start your program running; it only changes the address of where it will run when you continue. For example,

    set $pc = 0x485

makes the next `continue` command or stepping command execute at address `0x485`, rather than at the address where your program stopped. See Continuing and stepping.

The most common occasion to use the `jump` command is to back up--perhaps with more breakpoints set--over a portion of a program that has already executed, in order to examine its execution in more detail.

Node:Signaling, Next:Returning, Previous:Jumping, Up:Altering

## Giving your program a signal

`signal signal`
  Resume execution where your program stopped, but immediately give it the signal signal. signal can be the name or the number of a signal. For example, on many systems `signal 2` and `signal SIGINT` are both ways of sending an interrupt signal.

  Alternatively, if signal is zero, continue execution without giving a signal. This is useful when your program stopped on account of a signal and would ordinary see the signal when resumed with the `continue` command; `signal 0` causes it to resume without a signal.

  `signal` does not repeat when you press <RET> a second time after executing the command.

Invoking the `signal` command is not the same as invoking the `kill` utility from the shell. Sending a signal with `kill` causes GDB to decide what to do with the signal depending on the signal handling tables (see Signals). The `signal` command passes the signal directly to your program.

Node:Returning, Next:Calling, Previous:Signaling, Up:Altering

## Returning from a function

`return`
`return expression`
  You can cancel execution of a function call with the `return` command. If you give an expression argument, its value is used as the function's return value.

When you use `return`, GDB discards the selected stack frame (and all frames within it). You can think of this as making the discarded frame return prematurely. If you wish to specify a value to be returned, give that value as the argument to `return`.

This pops the selected stack frame (see Selecting a frame), and any other frames inside of it, leaving its caller as the innermost remaining frame. That frame becomes selected. The specified value is stored in the registers used for returning values of functions.

The `return` command does not resume execution; it leaves the program stopped in the state that would exist if the function had just returned. In contrast, the `finish` command (see Continuing and stepping) resumes execution until the selected stack frame returns naturally.

Node:Calling, Next:Patching, Previous:Returning, Up:Altering

## Calling program functions

`call expr`
  Evaluate the expression expr without displaying `void` returned values.

You can use this variant of the `print` command if you want to execute a function from your program, but without cluttering the output with `void` returned values. If the result is not void, it is printed and saved in the value history.

For the A29K, a user-controlled variable `call_scratch_address`, specifies the location of a scratch area to be used when GDB calls a function in the target. This is necessary because the usual method of putting the scratch area on the stack does not work in systems that have separate instruction and data spaces.

Node:Patching, Previous:Calling, Up:Altering

## Patching programs

By default, GDB opens the file containing your program's executable code (or the corefile) read-only. This prevents accidental alterations to machine code; but it also prevents you from intentionally patching your program's binary.

If you'd like to be able to patch the binary, you can specify that explicitly with the `set write` command. For example, you might want to turn on internal debugging flags, or even to make emergency repairs.

`set write on`
`set write off`
  If you specify `set write on`, GDB opens executable and core files for both reading and writing; if you specify `set write off` (the default), GDB opens them read-only.

  If you have already loaded a file, you must load it again (using the `exec-file` or `core-file` command) after changing `set write`, for your new setting to take effect.

`show write`
  Display whether executable files and core files are opened for writing as well as reading.

Node:GDB Files, Next:Targets, Previous:Altering, Up:Top

# GDB Files

GDB needs to know the file name of the program to be debugged, both in order to read its symbol table and in order to start your program. To debug a core dump of a previous run, you must also tell GDB the name of the core dump file.

- Files: Commands to specify files
- Symbol Errors: Errors reading symbol files

Node:Files, Next:Symbol Errors, Up:GDB Files

## Commands to specify files

You may want to specify executable and core dump file names. The usual way to do this is at start-up time, using the arguments to GDB's start-up commands (see Getting In and Out of GDB).

Occasionally it is necessary to change to a different file during a GDB session. Or you may run GDB and forget to specify a file you want to use. In these situations the GDB commands to specify new files are useful.

`file filename`
  Use filename as the program to be debugged. It is read for its symbols and for the contents of pure memory. It is also the program executed when you use the `run` command. If you do not specify a directory and the file is not found in the GDB working directory, GDB uses the environment variable `PATH` as a list of directories to search, just as the shell does when looking for a program to run. You can change the value of this variable, for both GDB and your program, using the `path` command.

  On systems with memory-mapped files, an auxiliary file named `filename.syms` may hold symbol table information for filename. If so, GDB maps in the symbol table from `filename.syms`, starting up more quickly. See the descriptions of the file options `-mapped` and `-readnow` (available on the command line, and with the commands `file`, `symbol-file`, or `add-symbol-file`, described below), for more information.

`file`
  `file` with no argument makes GDB discard any information it has on both executable file and the symbol table.
`exec-file [ filename ]`
  Specify that the program to be run (but not the symbol table) is found in filename. GDB searches the environment variable `PATH` if necessary to locate your program. Omitting filename means to discard information on the executable file.
`symbol-file [ filename ]`
  Read symbol table information from file filename. `PATH` is searched when necessary. Use the `file` command to get both symbol table and program to run from the same file.

  `symbol-file` with no argument clears out GDB information on your program's symbol table.

  The `symbol-file` command causes GDB to forget the contents of its convenience variables, the value history, and all breakpoints and auto-display expressions. This is because they may contain pointers to the internal data recording symbols and data types, which are part of the old symbol table data being discarded inside GDB.

  `symbol-file` does not repeat if you press <RET> again after executing it once.

  When GDB is configured for a particular environment, it understands debugging information in whatever format is the standard generated for that environment; you may use either a GNU compiler, or other compilers that adhere to the local conventions. Best results are usually obtained from GNU compilers; for example, using `gcc` you can generate debugging information for optimized code.

  For most kinds of object files, with the exception of old SVR3 systems using COFF, the `symbol-file` command does not normally read the symbol table in full right away. Instead, it scans the symbol table quickly to find which source files and which symbols are present. The details are read later, one source file at a time, as they are needed.

  The purpose of this two-stage reading strategy is to make GDB start up faster. For the most part, it is invisible except for occasional pauses while the symbol table details for a particular source file are being read. (The `set verbose` command can turn these pauses into messages if desired. See Optional warnings and messages.)

  We have not implemented the two-stage strategy for COFF yet. When the symbol table is stored in COFF format, `symbol-file` reads the symbol table data in full right away. Note that "stabs-in-COFF" still does the two-stage strategy, since the debug info is actually in stabs format.

`symbol-file filename [ -readnow ] [ -mapped ]`
`file filename [ -readnow ] [ -mapped ]`
  You can override the GDB two-stage strategy for reading symbol tables by using the `-readnow` option with any of the commands that load symbol table information, if you want to be sure GDB has the entire symbol table available.

  If memory-mapped files are available on your system through the `mmap` system call, you can use another option, `-mapped`, to cause GDB to write the symbols for your program into a reusable file. Future GDB debugging sessions map in symbol information from this auxiliary symbol file (if the program has not changed), rather than spending time reading the symbol table from the executable program. Using the `-mapped` option has the same effect as starting GDB with the `-mapped` command-line option.

  You can use both options together, to make sure the auxiliary symbol file has all the symbol information for your program.

  The auxiliary symbol file for a program called myprog is called `myprog.syms`. Once this file exists (so long as it is newer than the corresponding executable), GDB always attempts to use it when you debug myprog; no special options or commands are needed.

  The `.syms` file is specific to the host machine where you run GDB. It holds an exact image of the internal GDB symbol table. It cannot be shared across multiple host platforms.

`core-file [ filename ]`
  Specify the whereabouts of a core dump file to be used as the "contents of memory". Traditionally, core files contain only some parts of the address space of the process that generated them; GDB can access the executable file itself for other parts.

  `core-file` with no argument specifies that no core file is to be used.

  Note that the core file is ignored when your program is actually running under GDB. So, if you have been running your program and you wish to debug a core file instead, you must kill the subprocess in which the program is running. To do this, use the `kill` command (see Killing the child process).

`add-symbol-file filename address`
`add-symbol-file filename address [ -readnow ] [ -mapped ]`
`add-symbol-file filename address data_address bss_address`
`add-symbol-file filename -Tsection address`
  The `add-symbol-file` command reads additional symbol table information from the file filename. You would use this command when filename has been dynamically loaded (by some other means) into the program that is running. address should be the memory address at which the file has been loaded; GDB cannot figure this out for itself. You can specify up to three addresses, in which case they are taken to be the addresses of the text, data, and bss segments respectively. For complicated cases, you can specify an arbitrary number of `-Tsection address` pairs, to give an explicit section name and base address for that section. You can specify any address as an expression.

  The symbol table of the file filename is added to the symbol table originally read with the `symbol-file` command. You can use the `add-symbol-file` command any number of times; the new symbol data thus read keeps adding to the old. To discard all old symbol data instead, use the `symbol-file` command without any arguments.

  `add-symbol-file` does not repeat if you press <RET> after using it.

  You can use the `-mapped` and `-readnow` options just as with the `symbol-file` command, to change how GDB manages the symbol table information for filename.

`add-shared-symbol-file`
  The `add-shared-symbol-file` command can be used only under Harris' CXUX operating system for the Motorola 88k. GDB automatically looks for shared libraries, however if GDB does not find yours, you can run `add-shared-symbol-file`. It takes no arguments.
`section`
  The `section` command changes the base address of section SECTION of the exec file to ADDR. This can be used if the exec file does not contain section addresses, (such as in the a.out format), or when the addresses specified in the file itself are wrong. Each section must be changed separately. The `info files` command, described below, lists all the sections and their addresses.
`info files`
`info target`
  `info files` and `info target` are synonymous; both print the current target (see Specifying a Debugging Target), including the names of the executable and core dump files currently in use by GDB, and the files from which symbols were loaded. The command `help target` lists all possible targets rather than current ones.

All file-specifying commands allow both absolute and relative file names as arguments. GDB always converts the file name to an absolute file name and remembers it that way. GDB supports HP-UX, SunOS, SVr4, Irix 5, and IBM RS/6000 shared libraries. GDB automatically loads symbol definitions from shared libraries when you use the `run` command, or when you examine a core file. (Before you issue the `run` command, GDB does not understand references to a function in a shared library, however--unless you are debugging a core file).

On HP-UX, if the program loads a library explicitly, GDB automatically loads the symbols at the time of the `shl_load` call.

`info share`
`info sharedlibrary`
  Print the names of the shared libraries which are currently loaded.
`sharedlibrary regex`
`share regex`
  Load shared object library symbols for files matching a Unix regular expression. As with files loaded automatically, it only loads shared libraries required by your program for a core file or after typing `run`. If regex is omitted all shared libraries required by your program are loaded.

On HP-UX systems, GDB detects the loading of a shared library and automatically reads in symbols from the newly loaded library, up to a threshold that is initially set but that you can modify if you wish.

Beyond that threshold, symbols from shared libraries must be explicitly loaded. To load these symbols, use the command `sharedlibrary filename`. The base address of the shared library is determined automatically by GDB and need not be specified.

To display or set the threshold, use the commands:

`set auto-solib-add threshold`
  Set the autoloading size threshold, in megabytes. If threshold is nonzero, symbols from all shared object libraries will be loaded automatically when the inferior begins execution or when the dynamic linker informs GDB that a new library has been loaded, until the symbol table of the program and libraries exceeds this threshold. Otherwise, symbols must be loaded manually, using the `sharedlibrary` command. The default threshold is 100 megabytes.
`show auto-solib-add`
  Display the current autoloading size threshold, in megabytes.

Node:Symbol Errors, Previous:Files, Up:GDB Files

## Errors reading symbol files

While reading a symbol file, GDB occasionally encounters problems, such as symbol types it does not recognize, or known bugs in compiler output. By default, GDB does not notify you of such problems, since they are relatively common and primarily of interest to people debugging compilers. If you are interested in seeing information about ill-constructed symbol tables, you can either ask GDB to print only one message about each such type of problem, no matter how many times the problem occurs; or you can ask GDB to print more messages, to see how many times the problems occur, with the `set complaints` command (see Optional warnings and messages).

The messages currently printed, and their meanings, include:

`inner block not inside outer block in symbol`
  The symbol information shows where symbol scopes begin and end (such as at the start of a function or a block of statements). This error indicates that an inner scope block is not fully contained in its outer scope blocks. GDB circumvents the problem by treating the inner block as if it had the same scope as the outer block. In the error message, symbol may be shown as "`(don't know)`" if the outer block is not a function.
`block at address out of order`
  The symbol information for symbol scope blocks should occur in order of increasing addresses. This error indicates that it does not do so. GDB does not circumvent this problem, and has trouble locating symbols in the source file whose symbols it is reading. (You can often determine what source file is affected by specifying `set verbose on`. See Optional warnings and messages.)
`bad block start address patched`
  The symbol information for a symbol scope block has a start address smaller than the address of the preceding source line. This is known to occur in the SunOS 4.1.1 (and earlier) C compiler. GDB circumvents the problem by treating the symbol scope block as starting on the previous source line.
`bad string table offset in symbol n`
  Symbol number n contains a pointer into the string table which is larger than the size of the string table. GDB circumvents the problem by considering the symbol to have the name `foo`, which may cause other problems if many symbols end up with this name.
`unknown symbol type `0xnn``
  The symbol information contains new data types that GDB does not yet know how to read. `0xnn` is the symbol type of the uncomprehended information, in hexadecimal. GDB circumvents the error by ignoring this symbol information. This usually allows you to debug your program, though certain symbols are not accessible. If you encounter such a problem and feel like debugging it, you can debug `gdb` with itself, breakpoint on `complain`, then go up to the function `read_dbx_symtab` and examine `*bufp` to see the symbol.
`stub type has NULL name`
  GDB could not find the full definition for a struct or class.
`const/volatile indicator missing (ok if using g++ v1.x), got...`
  The symbol information for a C++ member function is missing some information that recent versions of the compiler should have output for it.
`info mismatch between compiler and debugger`
  GDB could not parse a type specification output by the compiler.

Node:Targets, Next:Configurations, Previous:GDB Files, Up:Top

# Specifying a Debugging Target

A target is the execution environment occupied by your program.

Often, GDB runs in the same host environment as your program; in that case, the debugging target is specified as a side effect when you use the `file` or `core` commands. When you need more flexibility--for example, running GDB on a physically separate host, or controlling a standalone system over a serial port or a realtime system over a TCP/IP connection--you can use the `target` command to specify one of the target types configured for GDB (see Commands for managing targets).

- Active Targets: Active targets
- Target Commands: Commands for managing targets
- Byte Order: Choosing target byte order
- Remote: Remote debugging
- KOD: Kernel Object Display

Node:Active Targets, Next:Target Commands, Up:Targets

## Active targets

There are three classes of targets: processes, core files, and executable files. GDB can work concurrently on up to three active targets, one in each class. This allows you to (for example) start a process and inspect its activity without abandoning your work on a core file.

For example, if you execute `gdb a.out`, then the executable file `a.out` is the only active target. If you designate a core file as well--presumably from a prior run that crashed and coredumped--then GDB has two active targets and uses them in tandem, looking first in the corefile target, then in the executable file, to satisfy requests for memory addresses. (Typically, these two classes of target are complementary, since core files contain only a program's read-write memory--variables and so on--plus machine status, while executable files contain only the program text and initialized data.)

When you type `run`, your executable file becomes an active process target as well. When a process target is active, all GDB commands requesting memory addresses refer to that target; addresses in an active core file or executable file target are obscured while the process target is active.

Use the `core-file` and `exec-file` commands to select a new core file or executable target (see Commands to specify files). To specify as a target a process that is already running, use the `attach` command (see Debugging an already-running process).

Node:Target Commands, Next:Byte Order, Previous:Active Targets, Up:Targets

## Commands for managing targets

`target type parameters`
  Connects the GDB host environment to a target machine or process. A target is typically a protocol for talking to debugging facilities. You use the argument type to specify the type or protocol of the target machine.

  Further parameters are interpreted by the target protocol, but typically include things like device names or host names to connect with, process numbers, and baud rates.

  The `target` command does not repeat if you press <RET> again after executing the command.

`help target`
  Displays the names of all targets available. To display targets currently selected, use either `info target` or `info files` (see Commands to specify files).
`help target name`
  Describe a particular target, including any parameters necessary to select it.
`set gnutarget args`
  GDB uses its own library BFD to read your files. GDB knows whether it is reading an executable, a core, or a .o file; however, you can specify the file format with the `set gnutarget` command. Unlike most `target` commands, with `gnutarget` the `target` refers to a program, not a machine.

  > Warning: To specify a file format with `set gnutarget`, you must know the actual BFD name.

  See Commands to specify files.

`show gnutarget`
  Use the `show gnutarget` command to display what file format `gnutarget` is set to read. If you have not set `gnutarget`, GDB will determine the file format for each file automatically, and `show gnutarget` displays `The current BDF target is "auto"`.

Here are some common targets (available, or not, depending on the GDB configuration):

`target exec program`
  An executable file. `target exec program` is the same as `exec-file program`.
`target core filename`
  A core dump file. `target core filename` is the same as `core-file filename`.
`target remote dev`
  Remote serial target in GDB-specific protocol. The argument dev specifies what serial device to use for the connection (e.g. `/dev/ttya`). See Remote debugging. `target remote` supports the `load` command. This is only useful if you have some other way of getting the stub to the target system, and you can put it somewhere in memory where it won't get clobbered by the download.
`target sim`
  Builtin CPU simulator. GDB includes simulators for most architectures. In general,

              target sim
              load
              run

  works; however, you cannot assume that a specific memory map, device drivers, or even basic I/O is available, although some simulators do provide these. For info about any processor-specific simulator details, see the appropriate section in Embedded Processors.

Some configurations may include these targets as well:

`target nrom dev`
  NetROM ROM emulator. This target only supports downloading.

Different targets are available on different configurations of GDB; your configuration may have more or fewer targets.

Many remote targets require you to download the executable's code once you've successfully established a connection.

`load filename`
  Depending on what remote debugging facilities are configured into GDB, the `load` command may be available. Where it exists, it is meant to make filename (an executable) available for debugging on the remote system--by downloading, or dynamic linking, for example. `load` also records the filename symbol table in GDB, like the `add-symbol-file` command.

  If your GDB does not have a `load` command, attempting to execute it gets the error message "`You can't do that when your target is ...`"

  The file is loaded at whatever address is specified in the executable. For some object file formats, you can specify the load address when you link the program; for other formats, like a.out, the object file format specifies a fixed address.

  `load` does not repeat if you press <RET> again after using it.

Node:Byte Order, Next:Remote, Previous:Target Commands, Up:Targets

## Choosing target byte order

Some types of processors, such as the MIPS, PowerPC, and Hitachi SH, offer the ability to run either big-endian or little-endian byte orders. Usually the executable or symbol will include a bit to designate the endian-ness, and you will not need to worry about which to use. However, you may still find it useful to adjust GDB's idea of processor endian-ness manually.

`set endian big`
  Instruct GDB to assume the target is big-endian.
`set endian little`
  Instruct GDB to assume the target is little-endian.
`set endian auto`
  Instruct GDB to use the byte order associated with the executable.
`show endian`
  Display GDB's current idea of the target byte order.

Note that these commands merely adjust interpretation of symbolic data on the host, and that they have absolutely no effect on the target system.

Node:Remote, Next:KOD, Previous:Byte Order, Up:Targets

## Remote debugging

If you are trying to debug a program running on a machine that cannot run GDB in the usual way, it is often useful to use remote debugging. For example, you might use remote debugging on an operating system kernel, or on a small system which does not have a general purpose operating system powerful enough to run a full-featured debugger.

Some configurations of GDB have special serial or TCP/IP interfaces to make this work with particular debugging targets. In addition, GDB comes with a generic serial protocol (specific to GDB, but not specific to any particular target system) which you can use if you write the remote stubs--the code that runs on the remote system to communicate with GDB.

Other remote targets may be available in your configuration of GDB; use `help target` to list them.

- Remote Serial: GDB remote serial protocol

Node:Remote Serial, Up:Remote

### The GDB remote serial protocol

To debug a program running on another machine (the debugging target machine), you must first arrange for all the usual prerequisites for the program to run by itself. For example, for a C program, you need:

1. A startup routine to set up the C runtime environment; these usually have a name like `crt0`. The startup routine may be supplied by your hardware supplier, or you may have to write your own.
2. A C subroutine library to support your program's subroutine calls, notably managing input and output.
3. A way of getting your program to the other machine--for example, a download program. These are often supplied by the hardware manufacturer, but you may have to write your own from hardware documentation.

The next step is to arrange for your program to use a serial port to communicate with the machine where GDB is running (the host machine). In general terms, the scheme looks like this:

On the host,
  GDB already understands how to use this protocol; when everything else is set up, you can simply use the `target remote` command (see Specifying a Debugging Target).
On the target,
  you must link with your program a few special-purpose subroutines that implement the GDB remote serial protocol. The file containing these subroutines is called a debugging stub.

  On certain remote targets, you can use an auxiliary program `gdbserver` instead of linking a stub into your program. See Using the `gdbserver` program, for details.

The debugging stub is specific to the architecture of the remote machine; for example, use `sparc-stub.c` to debug programs on SPARC boards.

These working remote stubs are distributed with GDB:

`i386-stub.c`
  For Intel 386 and compatible architectures.
`m68k-stub.c`
  For Motorola 680x0 architectures.
`sh-stub.c`
  For Hitachi SH architectures.
`sparc-stub.c`
  For SPARC architectures.
`sparcl-stub.c`
  For Fujitsu SPARCLITE architectures.

The `README` file in the GDB distribution may list other recently added stubs.

- Stub Contents: What the stub can do for you
- Bootstrapping: What you must do for the stub
- Debug Session: Putting it all together
- Protocol: Definition of the communication protocol
- Server: Using the `gdbserver' program
- NetWare: Using the `gdbserve.nlm' program

Node:Stub Contents, Next:Bootstrapping, Up:Remote Serial

#### What the stub can do for you

The debugging stub for your architecture supplies these three subroutines:

`set_debug_traps`
  This routine arranges for `handle_exception` to run when your program stops. You must call this subroutine explicitly near the beginning of your program.
`handle_exception`
  This is the central workhorse, but your program never calls it explicitly--the setup code arranges for `handle_exception` to run when a trap is triggered.

  `handle_exception` takes control when your program stops during execution (for example, on a breakpoint), and mediates communications with GDB on the host machine. This is where the communications protocol is implemented; `handle_exception` acts as the GDB representative on the target machine. It begins by sending summary information on the state of your program, then continues to execute, retrieving and transmitting any information GDB needs, until you execute a GDB command that makes your program resume; at that point, `handle_exception` returns control to your own code on the target machine.

`breakpoint`
  Use this auxiliary subroutine to make your program contain a breakpoint. Depending on the particular situation, this may be the only way for GDB to get control. For instance, if your target machine has some sort of interrupt button, you won't need to call this; pressing the interrupt button transfers control to `handle_exception`--in effect, to GDB. On some machines, simply receiving characters on the serial port may also trigger a trap; again, in that situation, you don't need to call `breakpoint` from your own program--simply running `target remote` from the host GDB session gets control.

  Call `breakpoint` if none of these is true, or if you simply want to make certain your program stops at a predetermined point for the start of your debugging session.

Node:Bootstrapping, Next:Debug Session, Previous:Stub Contents, Up:Remote Serial

#### What you must do for the stub

The debugging stubs that come with GDB are set up for a particular chip architecture, but they have no information about the rest of your debugging target machine.

First of all you need to tell the stub how to communicate with the serial port.

`int getDebugChar()`
  Write this subroutine to read a single character from the serial port. It may be identical to `getchar` for your target system; a different name is used to allow you to distinguish the two if you wish.
`void putDebugChar(int)`
  Write this subroutine to write a single character to the serial port. It may be identical to `putchar` for your target system; a different name is used to allow you to distinguish the two if you wish.

If you want GDB to be able to stop your program while it is running, you need to use an interrupt-driven serial driver, and arrange for it to stop when it receives a `^C` (`\003`, the control-C character). That is the character which GDB uses to tell the remote system to stop.

Getting the debugging target to return the proper status to GDB probably requires changes to the standard stub; one quick and dirty way is to just execute a breakpoint instruction (the "dirty" part is that GDB reports a `SIGTRAP` instead of a `SIGINT`).

Other routines you need to supply are:

`void exceptionHandler (int exception_number, void *exception_address)`
  Write this function to install exception_address in the exception handling tables. You need to do this because the stub does not have any way of knowing what the exception handling tables on your target system are like (for example, the processor's table might be in ROM, containing entries which point to a table in RAM). exception_number is the exception number which should be changed; its meaning is architecture-dependent (for example, different numbers might represent divide by zero, misaligned access, etc). When this exception occurs, control should be transferred directly to exception_address, and the processor state (stack, registers, and so on) should be just as it is when a processor exception occurs. So if you want to use a jump instruction to reach exception_address, it should be a simple jump, not a jump to subroutine.

  For the 386, exception_address should be installed as an interrupt gate so that interrupts are masked while the handler runs. The gate should be at privilege level 0 (the most privileged level). The SPARC and 68k stubs are able to mask interrupts themselves without help from `exceptionHandler`.

`void flush_i_cache()`
  On SPARC and SPARCLITE only, write this subroutine to flush the instruction cache, if any, on your target machine. If there is no instruction cache, this subroutine may be a no-op.

  On target machines that have instruction caches, GDB requires this function to make certain that the state of your program is stable.

You must also make sure this library routine is available:

`void *memset(void *, int, int)`
  This is the standard library function `memset` that sets an area of memory to a known value. If you have one of the free versions of `libc.a`, `memset` can be found there; otherwise, you must either obtain it from your hardware manufacturer, or write your own.

If you do not use the GNU C compiler, you may need other standard library subroutines as well; this varies from one stub to another, but in general the stubs are likely to use any of the common library subroutines which `gcc` generates as inline code.

Node:Debug Session, Next:Protocol, Previous:Bootstrapping, Up:Remote Serial

#### Putting it all together

In summary, when your program is ready to debug, you must follow these steps.

1. Make sure you have defined the supporting low-level routines (see What you must do for the stub):

       getDebugChar, putDebugChar,
       flush_i_cache, memset, exceptionHandler.

2. Insert these lines near the top of your program:

       set_debug_traps();
       breakpoint();

3. For the 680x0 stub only, you need to provide a variable called `exceptionHook`. Normally you just use:

       void (*exceptionHook)() = 0;

   but if before calling `set_debug_traps`, you set it to point to a function in your program, that function is called when `GDB` continues after stopping on a trap (for example, bus error). The function indicated by `exceptionHook` is called with one parameter: an `int` which is the exception number.

4. Compile and link together: your program, the GDB debugging stub for your target architecture, and the supporting subroutines.
5. Make sure you have a serial connection between your target machine and the GDB host, and identify the serial port on the host.
6. Download your program to your target machine (or get it there by whatever means the manufacturer provides), and start it.
7. To start remote debugging, run GDB on the host machine, and specify as an executable file the program that is running in the remote machine. This tells GDB how to find your program's symbols and the contents of its pure text.
8. Establish communication using the `target remote` command. Its argument specifies how to communicate with the target machine--either via a devicename attached to a direct serial line, or a TCP port (usually to a terminal server which in turn has a serial line to the target). For example, to use a serial line connected to the device named `/dev/ttyb`:

       target remote /dev/ttyb

   To use a TCP connection, use an argument of the form `host:port`. For example, to connect to port 2828 on a terminal server named `manyfarms`:

       target remote manyfarms:2828

Now you can use all the usual commands to examine and change data and to step and continue the remote program.

To resume the remote program and stop debugging it, use the `detach` command.

Whenever GDB is waiting for the remote program, if you type the interrupt character (often <C-C>), GDB attempts to stop the program. This may or may not succeed, depending in part on the hardware and the serial drivers the remote system uses. If you type the interrupt character once again, GDB displays this prompt:

    Interrupted while waiting for the program.
    Give up (and stop debugging it)?  (y or n)

If you type `y`, GDB abandons the remote debugging session. (If you decide you want to try again later, you can use `target remote` again to connect once more.) If you type `n`, GDB goes back to waiting.

Node:Protocol, Next:Server, Previous:Debug Session, Up:Remote Serial

#### Communication protocol

The stub files provided with GDB implement the target side of the communication protocol, and the GDB side is implemented in the GDB source file `remote.c`. Normally, you can simply allow these subroutines to communicate, and ignore the details. (If you're implementing your own stub file, you can still ignore the details: start with one of the existing stub files. `sparc-stub.c` is the best organized, and therefore the easiest to read.)

However, there may be occasions when you need to know something about the protocol--for example, if there is only one serial port to your target machine, you might want your program to do something special if it recognizes a packet meant for GDB.

In the examples below, `<-` and `->` are used to indicate transmitted and received data respectfully.

All GDB commands and responses (other than acknowledgments) are sent as a packet. A packet is introduced with the character `$`, the actual packet-data, and the terminating character `#` followed by a two-digit checksum:

    $packet-data#checksum

The two-digit checksum is computed as the modulo 256 sum of all characters between the leading `$` and the trailing `#` (an eight bit unsigned checksum).

Implementors should note that prior to GDB 5.0 the protocol specification also included an optional two-digit sequence-id:

    $sequence-id:packet-data#checksum

That sequence-id was appended to the acknowledgment. GDB has never output sequence-ids. Stubs that handle packets added since GDB 5.0 must not accept sequence-id.

When either the host or the target machine receives a packet, the first response expected is an acknowledgment: either `+` (to indicate the package was received correctly) or `-` (to request retransmission):

    <- $packet-data#checksum
    -> +

The host (GDB) sends commands, and the target (the debugging stub incorporated in your program) sends a response. In the case of step and continue commands, the response is only sent when the operation has completed (the target has again stopped).

packet-data consists of a sequence of characters with the exception of `#` and `$` (see `X` packet for additional exceptions).

Fields within the packet should be separated using `,` `;` or `:`. Except where otherwise noted all numbers are represented in HEX with leading zeros suppressed.

Implementors should note that prior to GDB 5.0, the character `:` could not appear as the third character in a packet (as it would potentially conflict with the sequence-id).

Response data can be run-length encoded to save space. A `*` means that the next character is an ASCII encoding giving a repeat count which stands for that many repetitions of the character preceding the `*`. The encoding is `n+29`, yielding a printable character where `n >=3` (which is where rle starts to win). The printable characters `$`, `#`, `+` and `-` or with a numeric value greater than 126 should not be used.

Some remote systems have used a different run-length encoding mechanism loosely refered to as the cisco encoding. Following the `*` character are two hex digits that indicate the size of the packet.

So:

    "0* "

means the same as "0000".

The error response returned for some packets includes a two character error number. That number is not well defined.

For any command not supported by the stub, an empty response (`$#00`) should be returned. That way it is possible to extend the protocol. A newer GDB can tell if a packet is supported based on that response.

A stub is required to support the `g`, `G`, `m`, `M`, `c`, and `s` commands. All other commands are optional.

Below is a complete list of all currently defined commands and their corresponding response data:

Packet | Request | Description
extended ops | `!` | Use the extended remote protocol. Sticky--only needs to be set once. The extended remote protocol supports the `R` packet.
| reply `` | Stubs that support the extended remote protocol return `` which, unfortunately, is identical to the response returned by stubs that do not support protocol extensions.
last signal | `?` | Indicate the reason the target halted. The reply is the same as for step and continue.
| reply | see below
reserved | `a` | Reserved for future use
set program arguments (reserved) | `A` arglen`,`argnum`,`arg`,...` |
|  | Initialized `argv[]` array passed into program. arglen specifies the number of bytes in the hex encoded byte stream arg. See `gdbserver` for more details.
| reply `OK`
| reply `E` NN
set baud (deprecated) | `b` baud | Change the serial line speed to baud. JTC: When does the transport layer state change? When it's received, or after the ACK is transmitted. In either case, there are problems if the command or the acknowledgment packet is dropped. Stan: If people really wanted to add something like this, and get it working for the first time, they ought to modify ser-unix.c to send some kind of out-of-band message to a specially-setup stub and have the switch happen "in between" packets, so that from remote protocol's point of view, nothing actually happened.
set breakpoint (deprecated) | `B` addr,mode | Set (mode is `S`) or clear (mode is `C`) a breakpoint at addr. This has been replaced by the `Z` and `z` packets.
continue | `c` addr | addr is address to resume. If addr is omitted, resume at current address.
| reply | see below
continue with signal | `C` sig`;`addr | Continue with signal sig (hex signal number). If `;`addr is omitted, resume at same address.
| reply | see below
toggle debug (deprecated) | `d` | toggle debug flag.
detach | `D` | Detach GDB from the remote system. Sent to the remote target before GDB disconnects.
| reply no response | GDB does not check for any response after sending this packet.
reserved | `e` | Reserved for future use
reserved | `E` | Reserved for future use
reserved | `f` | Reserved for future use
reserved | `F` | Reserved for future use
read registers | `g` | Read general registers.
| reply XX... | Each byte of register data is described by two hex digits. The bytes with the register are transmitted in target byte order. The size of each register and their position within the `g` packet are determined by the GDB internal macros REGISTER_RAW_SIZE and REGISTER_NAME macros. The specification of several standard `g` packets is specified below.
| `E` NN | for an error.
write regs | `G` XX... | See `g` for a description of the XX... data.
| reply `OK` | for success
| reply `E` NN | for an error
reserved | `h` | Reserved for future use
set thread | `H` c t... | Set thread for subsequent operations (`m`, `M`, `g`, `G`, et.al.). c = `c` for thread used in step and continue; t... can be -1 for all threads. c = `g` for thread used in other operations. If zero, pick a thread, any thread.
| reply `OK` | for success
| reply `E` NN | for an error
cycle step (draft) | `i` addr`,`nnn | Step the remote target by a single clock cycle. If `,`nnn is present, cycle step nnn cycles. If addr is present, cycle step starting at that address.
signal then cycle step (reserved) | `I` | See `i` and `S` for likely syntax and semantics.
reserved | `j` | Reserved for future use
reserved | `J` | Reserved for future use
kill request | `k` | FIXME: There is no description of how operate when a specific thread context has been selected (ie. does 'k' kill only that thread?).
reserved | `l` | Reserved for future use
reserved | `L` | Reserved for future use
read memory | `m` addr`,`length | Read length bytes of memory starting at address addr. Neither GDB nor the stub assume that sized memory transfers are assumed using word alligned accesses. FIXME: A word aligned memory transfer mechanism is needed.
| reply XX... | XX... is mem contents. Can be fewer bytes than requested if able to read only part of the data. Neither GDB nor the stub assume that sized memory transfers are assumed using word alligned accesses. FIXME: A word aligned memory transfer mechanism is needed.
| reply `E` NN | NN is errno
write mem | `M` addr,length`:`XX... | Write length bytes of memory starting at address addr. XX... is the data.
| reply `OK` | for success
| reply `E` NN | for an error (this includes the case where only part of the data was written).
reserved | `n` | Reserved for future use
reserved | `N` | Reserved for future use
reserved | `o` | Reserved for future use
reserved | `O` | Reserved for future use
read reg (reserved) | `p` n... | See write register.
| return r.... | The hex encoded value of the register in target byte order.
write reg | `P` n...`=`r... | Write register n... with value r..., which contains two hex digits for each byte in the register (target byte order).
| reply `OK` | for success
| reply `E` NN | for an error
general query | `q` query | Request info about query. In general GDB queries have a leading upper case letter. Custom vendor queries should use a company prefix (in lower case) ex: `qfsf.var`. query may optionally be followed by a `,` or `;` separated list. Stubs must ensure that they match the full query name.
| reply `XX...` | Hex encoded data from query. The reply can not be empty.
| reply `E` NN | error reply
| reply `` | Indicating an unrecognized query.
general set | `Q` var`=`val | Set value of var to val. See `q` for a discussing of naming conventions.
reset (deprecated) | `r` | Reset the entire system.
remote restart | `R` XX | Restart the remote server. XX while needed has no clear definition. FIXME: An example interaction explaining how this packet is used in extended-remote mode is needed.
step | `s` addr | addr is address to resume. If addr is omitted, resume at same address.
| reply | see below
step with signal | `S` sig`;`addr | Like `C` but step not continue.
| reply | see below
search | `t` addr`:`PP`,`MM | Search backwards starting at address addr for a match with pattern PP and mask MM. PP and MM are 4 bytes. addr must be at least 3 digits.
thread alive | `T` XX | Find out if the thread XX is alive.
| reply `OK` | thread is still alive
| reply `E` NN | thread is dead
reserved | `u` | Reserved for future use
reserved | `U` | Reserved for future use
reserved | `v` | Reserved for future use
reserved | `V` | Reserved for future use
reserved | `w` | Reserved for future use
reserved | `W` | Reserved for future use
reserved | `x` | Reserved for future use
write mem (binary) | `X` addr`,`length:XX... | addr is address, length is number of bytes, XX... is binary data. The characters `$`, `#`, and `0x7d` are escaped using `0x7d`.
| reply `OK` | for success
| reply `E` NN | for an error
reserved | `y` | Reserved for future use
reserved | `Y` | Reserved for future use
remove break or watchpoint (draft) | `z` t`,`addr`,`length | See `Z`.
insert break or watchpoint (draft) | `Z` t`,`addr`,`length | t is type: `0` - software breakpoint, `1` - hardware breakpoint, `2` - write watchpoint, `3` - read watchpoint, `4` - access watchpoint; addr is address; length is in bytes. For a software breakpoint, length specifies the size of the instruction to be patched. For hardware breakpoints and watchpoints length specifies the memory region to be monitored. To avoid potential problems with duplicate packets, the operations should be implemented in an idempotent way.
| reply `E` NN | for an error
| reply `OK` | for success
| `` | If not supported.
reserved | <other> | Reserved for future use

The `C`, `c`, `S`, `s` and `?` packets can receive any of the below as a reply. In the case of the `C`, `c`, `S` and `s` packets, that reply is only returned when the target halts. In the below the exact meaning of `signal number` is poorly defined. In general one of the UNIX signal numbering conventions is used.

`S` AA | AA is the signal number
`T` AA n...`:`r...`;`n...`:`r...`;`n...`:`r...`;` | AA = two hex digit signal number; n... = register number (hex), r... = target byte ordered register contents, size defined by `REGISTER_RAW_SIZE`; n... = `thread`, r... = thread process ID, this is a hex integer; n... = other string not starting with valid hex digit. GDB should ignore this n..., r... pair and go on to the next. This way we can extend the protocol.
`W` AA | The process exited, and AA is the exit status. This is only applicable for certains sorts of targets.
`X` AA | The process terminated with signal AA.
`N` AA`;`t...`;`d...`;`b... (obsolete) | AA = signal number; t... = address of symbol "_start"; d... = base of data section; b... = base of bss section. Note: only used by Cisco Systems targets. The difference between this reply and the "qOffsets" query is that the 'N' packet may arrive spontaneously whereas the 'qOffsets' is a query initiated by the host debugger.
`O` XX... | XX... is hex encoding of ASCII data. This can happen at any time while the program is running and the debugger should continue to wait for 'W', 'T', etc.

The following set and query packets have already been defined.

current thread | `q` `C` | Return the current thread id.
| reply `QC` pid | Where pid is a HEX encoded 16 bit process id.
| reply * | Any other reply implies the old pid.
all thread ids | `q` `fThreadInfo`
| `q` `sThreadInfo` | Obtain a list of active thread ids from the target (OS). Since there may be too many active threads to fit into one reply packet, this query works iteratively: it may require more than one query/reply sequence to obtain the entire list of threads. The first query of the sequence will be the `qf` `ThreadInfo` query; subsequent queries in the sequence will be the `qs` `ThreadInfo` query.
|  | NOTE: replaces the `qL` query (see below).
| reply `m`<id> | A single thread id
| reply `m`<id>,<id>... | a comma-separated list of thread ids
| reply `l` | (lower case 'el') denotes end of list.
|  | In response to each query, the target will reply with a list of one or more thread ids, in big-endian hex, separated by commas. GDB will respond to each reply with a request for more thread ids (using the `qs` form of the query), until the target responds with `l` (lower-case el, for `'last'`).
extra thread info | `q` `ThreadExtraInfo``,`id |
|  | Where <id> is a thread-id in big-endian hex. Obtain a printable string description of a thread's attributes from the target OS. This string may contain anything that the target OS thinks is interesting for GDB to tell the user about the thread. The string is displayed in GDB's `info threads` display. Some examples of possible thread extra info strings are "Runnable", or "Blocked on Mutex".
| reply XX... | Where XX... is a hex encoding of ASCII data, comprising the printable string containing the extra information about the thread's attributes.
query LIST or threadLIST (deprecated) | `q` `L` startflag threadcount nextthread |
|  | Obtain thread information from RTOS. Where: startflag (one hex digit) is one to indicate the first query and zero to indicate a subsequent query; threadcount (two hex digits) is the maximum number of threads the response packet can contain; and nextthread (eight hex digits), for subsequent queries (startflag is zero), is returned in the response as argthread.
|  | NOTE: this query is replaced by the `q` `fThreadInfo` query (see above).
| reply `q` `M` count done argthread thread... |
|  | Where: count (two hex digits) is the number of threads being returned; done (one hex digit) is zero to indicate more threads and one indicates no further threads; argthreadid (eight hex digits) is nextthread from the request packet; thread... is a sequence of thread IDs from the target. threadid (eight hex digits). See `remote.c:parse_threadlist_response()`.
compute CRC of memory block | `q` `CRC:`addr`,`length |
| reply `E` NN | An error (such as memory fault)
| reply `C` CRC32 | A 32 bit cyclic redundancy check of the specified memory region.
query sect offs | `q` `Offsets` | Get section offsets that the target used when re-locating the downloaded image. Note: while a `Bss` offset is included in the response, GDB ignores this and instead applies the `Data` offset to the `Bss` section.
| reply `Text=`xxx`;Data=`yyy`;Bss=`zzz
thread info request | `q` `P` mode threadid |
|  | Returns information on threadid. Where: mode is a hex encoded 32 bit mode; threadid is a hex encoded 64 bit thread ID.
| reply * | See `remote.c:remote_unpack_thread_info_response()`.
remote command | `q` `Rcmd,`COMMAND |
|  | COMMAND (hex encoded) is passed to the local interpreter for execution. Invalid commands should be reported using the output string. Before the final result packet, the target may also respond with a number of intermediate `O` OUTPUT console output packets. Implementors should note that providing access to a stubs's interpreter may have security implications.
| reply `OK` | A command response with no output.
| reply OUTPUT | A command response with the hex encoded output string OUTPUT.
| reply `E` NN | Indicate a badly formed request.
| reply `` | When `q` `Rcmd` is not recognized.

The following `g`/`G` packets have previously been defined. In the below, some thirty-two bit registers are transferred as sixty-four bits. Those registers should be zero/sign extended (which?) to fill the space allocated. Register bytes are transfered in target byte order. The two nibbles within a register byte are transfered most-significant - least-significant.

MIPS32 | All registers are transfered as thirty-two bit quantities in the order: 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point registers; fsr; fir; fp.
MIPS64 | All registers are transfered as sixty-four bit quantities (including thirty-two bit registers such as `sr`). The ordering is the same as `MIPS32`.

Example sequence of a target being re-started. Notice how the restart does not get any direct output:

    <- R00
    -> +
    target restarts
    <- ?
    -> +
    -> T001:1234123412341234
    <- +

Example sequence of a target being stepped by a single instruction:

    <- G1445...
    -> +
    <- s
    -> +
    time passes
    -> T001:1234123412341234
    <- +
    <- g
    -> +
    -> 1455...
    <- +

Node:Server, Next:NetWare, Previous:Protocol, Up:Remote Serial

#### Using the `gdbserver` program

`gdbserver` is a control program for Unix-like systems, which allows you to connect your program with a remote GDB via `target remote`--but without linking in the usual debugging stub.

`gdbserver` is not a complete replacement for the debugging stubs, because it requires essentially the same operating-system facilities that GDB itself does. In fact, a system that can run `gdbserver` to connect to a remote GDB could also run GDB locally! `gdbserver` is sometimes useful nevertheless, because it is a much smaller program than GDB itself. It is also easier to port than all of GDB, so you may be able to get started more quickly on a new system by using `gdbserver`. Finally, if you develop code for real-time systems, you may find that the tradeoffs involved in real-time operation make it more convenient to do as much development work as possible on another system, for example by cross-compiling. You can use `gdbserver` to make a similar choice for debugging. GDB and `gdbserver` communicate via either a serial line or a TCP connection, using the standard GDB remote serial protocol.

On the target machine,
  you need to have a copy of the program you want to debug. `gdbserver` does not need your program's symbol table, so you can strip the program if necessary to save space. GDB on the host system does all the symbol handling.

  To use the server, you must tell it how to communicate with GDB; the name of your program; and the arguments for your program. The syntax is:

      target> gdbserver comm program [ args ... ]

  comm is either a device name (to use a serial line) or a TCP hostname and portnumber. For example, to debug Emacs with the argument `foo.txt` and communicate with GDB over the serial port `/dev/com1`:

      target> gdbserver /dev/com1 emacs foo.txt

  `gdbserver` waits passively for the host GDB to communicate with it.

  To use a TCP connection instead of a serial line:

      target> gdbserver host:2345 emacs foo.txt

  The only difference from the previous example is the first argument, specifying that you are communicating with the host GDB via TCP. The `host:2345` argument means that `gdbserver` is to expect a TCP connection from machine `host` to local TCP port 2345. (Currently, the `host` part is ignored.) You can choose any number you want for the port number as long as it does not conflict with any TCP ports already in use on the target system (for example, `23` is reserved for `telnet`).5 You must use the same port number with the host GDB `target remote` command.

On the GDB host machine,
  you need an unstripped copy of your program, since GDB needs symbols and debugging information. Start up GDB as usual, using the name of the local copy of your program as the first argument. (You may also need the `--baud` option if the serial line is running at anything other than 9600bps.) After that, use `target remote` to establish communications with `gdbserver`. Its argument is either a device name (usually a serial device, like `/dev/ttyb`), or a TCP port descriptor in the form `host:PORT`. For example:

      (gdb) target remote /dev/ttyb

  communicates with the server via serial line `/dev/ttyb`, and

      (gdb) target remote the-target:2345

  communicates via a TCP connection to port 2345 on host `the-target`. For TCP connections, you must start up `gdbserver` prior to using the `target remote` command. Otherwise you may get an error whose text depends on the host system, but which usually looks something like `Connection refused`.

Node:NetWare, Previous:Server, Up:Remote Serial

#### Using the `gdbserve.nlm` program

`gdbserve.nlm` is a control program for NetWare systems, which allows you to connect your program with a remote GDB via `target remote`. GDB and `gdbserve.nlm` communicate via a serial line, using the standard GDB remote serial protocol.

On the target machine,
  you need to have a copy of the program you want to debug. `gdbserve.nlm` does not need your program's symbol table, so you can strip the program if necessary to save space. GDB on the host system does all the symbol handling.

  To use the server, you must tell it how to communicate with GDB; the name of your program; and the arguments for your program. The syntax is:

      load gdbserve [ BOARD=board ] [ PORT=port ]
                    [ BAUD=baud ] program [ args ... ]

  board and port specify the serial line; baud specifies the baud rate used by the connection. port and node default to 0, baud defaults to 9600bps.

  For example, to debug Emacs with the argument `foo.txt`and communicate with GDB over serial port number 2 or board 1 using a 19200bps connection:

      load gdbserve BOARD=1 PORT=2 BAUD=19200 emacs foo.txt

On the GDB host machine,
  you need an unstripped copy of your program, since GDB needs symbols and debugging information. Start up GDB as usual, using the name of the local copy of your program as the first argument. (You may also need the `--baud` option if the serial line is running at anything other than 9600bps. After that, use `target remote` to establish communications with `gdbserve.nlm`. Its argument is a device name (usually a serial device, like `/dev/ttyb`). For example:

      (gdb) target remote /dev/ttyb

  communications with the server via serial line `/dev/ttyb`.

Node:KOD, Previous:Remote, Up:Targets

## Kernel Object Display

Some targets support kernel object display. Using this facility, GDB communicates specially with the underlying operating system and can display information about operating system-level objects such as mutexes and other synchronization objects. Exactly which objects can be displayed is determined on a per-OS basis.

Use the `set os` command to set the operating system. This tells GDB which kernel object display module to initialize:

    (gdb) set os cisco

If `set os` succeeds, GDB will display some information about the operating system, and will create a new `info` command which can be used to query the target. The `info` command is named after the operating system:

    (gdb) info cisco
    List of Cisco Kernel Objects
    Object     Description
    any        Any and all objects

Further subcommands can be used to query about particular objects known by the kernel.

There is currently no way to determine whether a given operating system is supported other than to try it.

Node:Configurations, Next:Controlling GDB, Previous:Targets, Up:Top

# Configuration-Specific Information

While nearly all GDB commands are available for all native and cross versions of the debugger, there are some exceptions. This chapter describes things that are only available in certain configurations.

There are three major categories of configurations: native configurations, where the host and target are the same, embedded operating system configurations, which are usually the same for several different processor architectures, and bare embedded processors, which are quite different from each other.

- Native:
- Embedded OS:
- Embedded Processors:
- Architectures:

Node:Native, Next:Embedded OS, Up:Configurations

## Native

This section describes details specific to particular native configurations.

- HP-UX: HP-UX
- SVR4 Process Information: SVR4 process information

Node:HP-UX, Next:SVR4 Process Information, Up:Native

### HP-UX

On HP-UX systems, if you refer to a function or variable name that begins with a dollar sign, GDB searches for a user or system name first, before it searches for a convenience variable.

Node:SVR4 Process Information, Previous:HP-UX, Up:Native

### SVR4 process information

Many versions of SVR4 provide a facility called `/proc` that can be used to examine the image of a running process using file-system subroutines. If GDB is configured for an operating system with this facility, the command `info proc` is available to report on several kinds of information about the process running your program. `info proc` works only on SVR4 systems that include the `procfs` code. This includes OSF/1 (Digital Unix), Solaris, Irix, and Unixware, but not HP-UX or Linux, for example.

`info proc`
  Summarize available information about the process.
`info proc mappings`
  Report on the address ranges accessible in the program, with information on whether your program may read, write, or execute each range.
`info proc times`
  Starting time, user CPU time, and system CPU time for your program and its children.
`info proc id`
  Report on the process IDs related to your program: its own process ID, the ID of its parent, the process group ID, and the session ID.
`info proc status`
  General information on the state of the process. If the process is stopped, this report includes the reason for stopping, and any signal received.
`info proc all`
  Show all the above information about the process.

Node:Embedded OS, Next:Embedded Processors, Previous:Native, Up:Configurations

## Embedded Operating Systems

This section describes configurations involving the debugging of embedded operating systems that are available for several different architectures.

- VxWorks: Using GDB with VxWorks

GDB includes the ability to debug programs running on various real-time operating systems.

Node:VxWorks, Up:Embedded OS

### Using GDB with VxWorks

`target vxworks machinename`
  A VxWorks system, attached via TCP/IP. The argument machinename is the target system's machine name or IP address.

On VxWorks, `load` links filename dynamically on the current target system as well as adding its symbols in GDB. GDB enables developers to spawn and debug tasks running on networked VxWorks targets from a Unix host. Already-running tasks spawned from the VxWorks shell can also be debugged. GDB uses code that runs on both the Unix host and on the VxWorks target. The program `gdb` is installed and executed on the Unix host. (It may be installed with the name `vxgdb`, to distinguish it from a GDB for debugging programs on the host itself.)

`VxWorks-timeout args`
  All VxWorks-based targets now support the option `vxworks-timeout`. This option is set by the user, and args represents the number of seconds GDB waits for responses to rpc's. You might use this if your VxWorks target is a slow software simulator or is on the far side of a thin network line.

The following information on connecting to VxWorks was current when this manual was produced; newer releases of VxWorks may use revised procedures.

To use GDB with VxWorks, you must rebuild your VxWorks kernel to include the remote debugging interface routines in the VxWorks library `rdb.a`. To do this, define `INCLUDE_RDB` in the VxWorks configuration file `configAll.h` and rebuild your VxWorks kernel. The resulting kernel contains `rdb.a`, and spawns the source debugging task `tRdbTask` when VxWorks is booted. For more information on configuring and remaking VxWorks, see the manufacturer's manual.

Once you have included `rdb.a` in your VxWorks system image and set your Unix execution search path to find GDB, you are ready to run GDB. From your Unix host, run `gdb` (or `vxgdb`, depending on your installation). GDB comes up showing the prompt:

    (vxgdb)

- VxWorks Connection: Connecting to VxWorks
- VxWorks Download: VxWorks download
- VxWorks Attach: Running tasks

Node:VxWorks Connection, Next:VxWorks Download, Up:VxWorks

#### Connecting to VxWorks

The GDB command `target` lets you connect to a VxWorks target on the network. To connect to a target whose host name is "`tt`", type:

    (vxgdb) target vxworks tt

GDB displays messages like these:

    Attaching remote machine across net...
    Connected to tt.

GDB then attempts to read the symbol tables of any object modules loaded into the VxWorks target since it was last booted. GDB locates these files by searching the directories listed in the command search path (see Your program's environment); if it fails to find an object file, it displays a message such as:

    prog.o: No such file or directory.

When this happens, add the appropriate directory to the search path with the GDB command `path`, and execute the `target` command again.

Node:VxWorks Download, Next:VxWorks Attach, Previous:VxWorks Connection, Up:VxWorks

#### VxWorks download

If you have connected to the VxWorks target and you want to debug an object that has not yet been loaded, you can use the GDB `load` command to download a file from Unix to VxWorks incrementally. The object file given as an argument to the `load` command is actually opened twice: first by the VxWorks target in order to download the code, then by GDB in order to read the symbol table. This can lead to problems if the current working directories on the two systems differ. If both systems have NFS mounted the same filesystems, you can avoid these problems by using absolute paths. Otherwise, it is simplest to set the working directory on both systems to the directory in which the object file resides, and then to reference the file by its name, without any path. For instance, a program `prog.o` may reside in `vxpath/vw/demo/rdb` in VxWorks and in `hostpath/vw/demo/rdb` on the host. To load this program, type this on VxWorks:

    -> cd "vxpath/vw/demo/rdb"

Then, in GDB, type:

    (vxgdb) cd hostpath/vw/demo/rdb
    (vxgdb) load prog.o

GDB displays a response similar to this:

    Reading symbol data from wherever/vw/demo/rdb/prog.o... done.

You can also use the `load` command to reload an object module after editing and recompiling the corresponding source file. Note that this makes GDB delete all currently-defined breakpoints, auto-displays, and convenience variables, and to clear the value history. (This is necessary in order to preserve the integrity of debugger's data structures that reference the target system's symbol table.)

Node:VxWorks Attach, Previous:VxWorks Download, Up:VxWorks

#### Running tasks

You can also attach to an existing task using the `attach` command as follows:

    (vxgdb) attach task

where task is the VxWorks hexadecimal task ID. The task can be running or suspended when you attach to it. Running tasks are suspended at the time of attachment.

Node:Embedded Processors, Next:Architectures, Previous:Embedded OS, Up:Configurations

## Embedded Processors

This section goes into details specific to particular embedded configurations.

- A29K Embedded: AMD A29K Embedded
- ARM: ARM
- H8/300: Hitachi H8/300
- H8/500: Hitachi H8/500
- i960: Intel i960
- M32R/D: Mitsubishi M32R/D
- M68K: Motorola M68K
- M88K: Motorola M88K
- MIPS Embedded: MIPS Embedded
- PA: HP PA Embedded
- PowerPC:
- SH: Hitachi SH
- Sparclet: Tsqware Sparclet
- Sparclite: Fujitsu Sparclite
- ST2000: Tandem ST2000
- Z8000: Zilog Z8000

Node:A29K Embedded, Next:ARM, Up:Embedded Processors

### AMD A29K Embedded

- A29K UDI:
- A29K EB29K:
- Comms (EB29K): Communications setup
- gdb-EB29K: EB29K cross-debugging
- Remote Log: Remote log

`target adapt dev`
  Adapt monitor for A29K.
`target amd-eb dev speed PROG`
  Remote PC-resident AMD EB29K board, attached over serial lines. dev is the serial device, as for `target remote`; speed allows you to specify the linespeed; and PROG is the name of the program to be debugged, as it appears to DOS on the PC. See EBMON protocol for AMD29K.

Node:A29K UDI, Next:A29K EB29K, Up:A29K Embedded

#### A29K UDI

GDB supports AMD's UDI ("Universal Debugger Interface") protocol for debugging the a29k processor family. To use this configuration with AMD targets running the MiniMON monitor, you need the program `MONTIP`, available from AMD at no charge. You can also use GDB with the UDI-conformant a29k simulator program `ISSTIP`, also available from AMD.

`target udi keyword`
  Select the UDI interface to a remote a29k board or simulator, where keyword is an entry in the AMD configuration file `udi_soc`. This file contains keyword entries which specify parameters used to connect to a29k targets. If the `udi_soc` file is not in your working directory, you must set the environment variable `UDICONF` to its pathname.

Node:A29K EB29K, Next:Comms (EB29K), Previous:A29K UDI, Up:A29K Embedded

#### EBMON protocol for AMD29K

AMD distributes a 29K development board meant to fit in a PC, together with a DOS-hosted monitor program called `EBMON`. As a shorthand term, this development system is called the "EB29K". To use GDB from a Unix system to run programs on the EB29K board, you must first connect a serial cable between the PC (which hosts the EB29K board) and a serial port on the Unix system. In the following, we assume you've hooked the cable between the PC's `COM1` port and `/dev/ttya` on the Unix system.

Node:Comms (EB29K), Next:gdb-EB29K, Previous:A29K EB29K, Up:A29K Embedded

#### Communications setup

The next step is to set up the PC's port, by doing something like this in DOS on the PC:

    C:\> MODE com1:9600,n,8,1,none

This example--run on an MS DOS 4.0 system--sets the PC port to 9600 bps, no parity, eight data bits, one stop bit, and no "retry" action; you must match the communications parameters when establishing the Unix end of the connection as well.

To give control of the PC to the Unix side of the serial line, type the following at the DOS console:

    C:\> CTTY com1

(Later, if you wish to return control to the DOS console, you can use the command `CTTY con`--but you must send it over the device that had control, in our example over the `COM1` serial line.)

From the Unix host, use a communications program such as `tip` or `cu` to communicate with the PC; for example,

    cu -s 9600 -l /dev/ttya

The `cu` options shown specify, respectively, the linespeed and the serial port to use. If you use `tip` instead, your command line may look something like the following:

    tip -9600 /dev/ttya

Your system may require a different name where we show `/dev/ttya` as the argument to `tip`. The communications parameters, including which port to use, are associated with the `tip` argument in the "remote" descriptions file--normally the system table `/etc/remote`.

Using the `tip` or `cu` connection, change the DOS working directory to the directory containing a copy of your 29K program, then start the PC program `EBMON` (an EB29K control program supplied with your board by AMD). You should see an initial display from `EBMON` similar to the one that follows, ending with the `EBMON` prompt `#`--

    C:\> G:

    G:\> CD \usr\joe\work29k

    G:\USR\JOE\WORK29K> EBMON
    Am29000 PC Coprocessor Board Monitor, version 3.0-18
    Copyright 1990 Advanced Micro Devices, Inc.
    Written by Gibbons and Associates, Inc.

    Enter '?' or 'H' for help

    PC Coprocessor Type   = EB29K
    I/O Base              = 0x208
    Memory Base           = 0xd0000

    Data Memory Size      = 2048KB
    Available I-RAM Range = 0x8000 to 0x1fffff
    Available D-RAM Range = 0x80002000 to 0x801fffff

    PageSize              = 0x400
    Register Stack Size   = 0x800
    Memory Stack Size     = 0x1800

    CPU PRL               = 0x3
    Am29027 Available     = No
    Byte Write Available  = Yes

    # ~.

Then exit the `cu` or `tip` program (done in the example by typing `~.` at the `EBMON` prompt). `EBMON` keeps running, ready for GDB to take over.

For this example, we've assumed what is probably the most convenient way to make sure the same 29K program is on both the PC and the Unix system: a PC/NFS connection that establishes "drive `G:`" on the PC as a file system on the Unix host. If you do not have PC/NFS or something similar connecting the two systems, you must arrange some other way--perhaps floppy-disk transfer--of getting the 29K program from the Unix system to the PC; GDB does not download it over the serial line.

Node:gdb-EB29K, Next:Remote Log, Previous:Comms (EB29K), Up:A29K Embedded

#### EB29K cross-debugging

Finally, `cd` to the directory containing an image of your 29K program on the Unix system, and start GDB--specifying as argument the name of your 29K program:

    cd /usr/joe/work29k
    gdb myfoo

Now you can use the `target` command:

    target amd-eb /dev/ttya 9600 MYFOO

In this example, we've assumed your program is in a file called `myfoo`. Note that the filename given as the last argument to `target amd-eb` should be the name of the program as it appears to DOS. In our example this is simply `MYFOO`, but in general it can include a DOS path, and depending on your transfer mechanism may not resemble the name on the Unix side.

At this point, you can set any breakpoints you wish; when you are ready to see your program run on the 29K board, use the GDB command `run`.

To stop debugging the remote program, use the GDB `detach` command.

To return control of the PC to its console, use `tip` or `cu` once again, after your GDB session has concluded, to attach to `EBMON`. You can then type the command `q` to shut down `EBMON`, returning control to the DOS command-line interpreter. Type `CTTY con` to return command input to the main DOS console, and type `~.` to leave `tip` or `cu`.

Node:Remote Log, Previous:gdb-EB29K, Up:A29K Embedded

#### Remote log

The `target amd-eb` command creates a file `eb.log` in the current working directory, to help debug problems with the connection. `eb.log` records all the output from `EBMON`, including echoes of the commands sent to it. Running `tail -f` on this file in another window often helps to understand trouble with `EBMON`, or unexpected events on the PC side of the connection.

Node:ARM, Next:H8/300, Previous:A29K Embedded, Up:Embedded Processors

### ARM

`target rdi dev`
  ARM Angel monitor, via RDI library interface to ADP protocol. You may use this target to communicate with both boards running the Angel monitor, or with the EmbeddedICE JTAG debug device.
`target rdp dev`
  ARM Demon monitor.

Node:H8/300, Next:H8/500, Previous:ARM, Up:Embedded Processors

### Hitachi H8/300

`target hms dev`
  A Hitachi SH, H8/300, or H8/500 board, attached via serial line to your host. Use special commands `device` and `speed` to control the serial line and the communications speed used.
`target e7000 dev`
  E7000 emulator for Hitachi H8 and SH.
`target sh3 dev`
`target sh3e dev`
  Hitachi SH-3 and SH-3E target systems.

When you select remote debugging to a Hitachi SH, H8/300, or H8/500 board, the `load` command downloads your program to the Hitachi board and also opens it as the current executable target for GDB on your host (like the `file` command). GDB needs to know these things to talk to your Hitachi SH, H8/300, or H8/500:

1. that you want to use `target hms`, the remote debugging interface for Hitachi microprocessors, or `target e7000`, the in-circuit emulator for the Hitachi SH and the Hitachi 300H. (`target hms` is the default when GDB is configured specifically for the Hitachi SH, H8/300, or H8/500.)
2. what serial device connects your host to your Hitachi board (the first serial device available on your host is the default).
3. what speed to use over the serial device.

- Hitachi Boards: Connecting to Hitachi boards.
- Hitachi ICE: Using the E7000 In-Circuit Emulator.
- Hitachi Special: Special GDB commands for Hitachi micros.

Node:Hitachi Boards, Next:Hitachi ICE, Up:H8/300

#### Connecting to Hitachi boards

Use the special `GDB` command `device port` if you need to explicitly set the serial device. The default port is the first available port on your host. This is only necessary on Unix hosts, where it is typically something like `/dev/ttya`.

`GDB` has another special command to set the communications speed: `speed bps`. This command also is only used from Unix hosts; on DOS hosts, set the line speed as usual from outside GDB with the DOS `mode` command (for instance, `mode com2:9600,n,8,1,p` for a 9600bps connection).

The `device` and `speed` commands are available only when you use a Unix host to debug your Hitachi microprocessor programs. If you use a DOS host, GDB depends on an auxiliary terminate-and-stay-resident program called `asynctsr` to communicate with the development board through a PC serial port. You must also use the DOS `mode` command to set up the serial port on the DOS side.

The following sample session illustrates the steps needed to start a program under GDB control on an H8/300. The example uses a sample H8/300 program called `t.x`. The procedure is the same for the Hitachi SH and the H8/500.

First hook up your development board. In this example, we use a board attached to serial port `COM2`; if you use a different serial port, substitute its name in the argument of the `mode` command. When you call `asynctsr`, the auxiliary comms program used by the debugger, you give it just the numeric part of the serial port's name; for example, `asyncstr 2` below runs `asyncstr` on `COM2`.

    C:\H8300\TEST> asynctsr 2
    C:\H8300\TEST> mode com2:9600,n,8,1,p

    Resident portion of MODE loaded

    COM2: 9600, n, 8, 1, p

> Warning: We have noticed a bug in PC-NFS that conflicts with `asynctsr`. If you also run PC-NFS on your DOS host, you may need to disable it, or even boot without it, to use `asynctsr` to control your development board.

Now that serial communications are set up, and the development board is connected, you can start up GDB. Call `gdb` with the name of your program as the argument. `GDB` prompts you, as usual, with the prompt `(gdb)`. Use two special commands to begin your debugging session: `target hms` to specify cross-debugging to the Hitachi board, and the `load` command to download your program to the board. `load` displays the names of the program's sections, and a `*` for each 2K of data downloaded. (If you want to refresh GDB data on symbols or on the executable file without downloading, use the GDB commands `file` or `symbol-file`. These commands, and `load` itself, are described in Commands to specify files.)

    (eg-C:\H8300\TEST) gdb t.x
    GDB is free software and you are welcome to 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.
    GDB 5.0, Copyright 1992 Free Software Foundation, Inc...
    (gdb) target hms
    Connected to remote H8/300 HMS system.
    (gdb) load t.x
    .text   : 0x8000 .. 0xabde ***********
    .data   : 0xabde .. 0xad30 *
    .stack  : 0xf000 .. 0xf014 *

At this point, you're ready to run or debug your program. From here on, you can use all the usual GDB commands. The `break` command sets breakpoints; the `run` command starts your program; `print` or `x` display data; the `continue` command resumes execution after stopping at a breakpoint. You can use the `help` command at any time to find out more about GDB commands.

Remember, however, that operating system facilities aren't available on your development board; for example, if your program hangs, you can't send an interrupt--but you can press the RESET switch!

Use the RESET button on the development board

- to interrupt your program (don't use `ctl-C` on the DOS host--it has no way to pass an interrupt signal to the development board); and
- to return to the GDB command prompt after your program finishes normally. The communications protocol provides no other way for GDB to detect program completion.

In either case, GDB sees the effect of a RESET on the development board as a "normal exit" of your program.

Node:Hitachi ICE, Next:Hitachi Special, Previous:Hitachi Boards, Up:H8/300

#### Using the E7000 in-circuit emulator

You can use the E7000 in-circuit emulator to develop code for either the Hitachi SH or the H8/300H. Use one of these forms of the `target e7000` command to connect GDB to your E7000:

`target e7000 port speed`
  Use this form if your E7000 is connected to a serial port. The port argument identifies what serial port to use (for example, `com2`). The third argument is the line speed in bits per second (for example, `9600`).
`target e7000 hostname`
  If your E7000 is installed as a host on a TCP/IP network, you can just specify its hostname; GDB uses `telnet` to connect.

Node:Hitachi Special, Previous:Hitachi ICE, Up:H8/300

#### Special GDB commands for Hitachi micros

Some GDB commands are available only for the H8/300:

`set machine h8300`
`set machine h8300h`
  Condition GDB for one of the two variants of the H8/300 architecture with `set machine`. You can use `show machine` to check which variant is currently in effect.

Node:H8/500, Next:i960, Previous:H8/300, Up:Embedded Processors

### H8/500

`set memory mod`
`show memory`
  Specify which H8/500 memory model (mod) you are using with `set memory`; check which memory model is in effect with `show memory`. The accepted values for mod are `small`, `big`, `medium`, and `compact`.

Node:i960, Next:M32R/D, Previous:H8/500, Up:Embedded Processors

### Intel i960

`target mon960 dev`
  MON960 monitor for Intel i960.
`target nindy devicename`
  An Intel 960 board controlled by a Nindy Monitor. devicename is the name of the serial device to use for the connection, e.g. `/dev/ttya`.

Nindy is a ROM Monitor program for Intel 960 target systems. When GDB is configured to control a remote Intel 960 using Nindy, you can tell GDB how to connect to the 960 in several ways:

- Through command line options specifying serial port, version of the Nindy protocol, and communications speed;
- By responding to a prompt on startup;
- By using the `target` command at any point during your GDB session. See Commands for managing targets.

With the Nindy interface to an Intel 960 board, `load` downloads filename to the 960 as well as adding its symbols in GDB.

- Nindy Startup: Startup with Nindy
- Nindy Options: Options for Nindy
- Nindy Reset: Nindy reset command

Node:Nindy Startup, Next:Nindy Options, Up:i960

#### Startup with Nindy

If you simply start `gdb` without using any command-line options, you are prompted for what serial port to use, before you reach the ordinary GDB prompt:

    Attach /dev/ttyNN -- specify NN, or "quit" to quit:

Respond to the prompt with whatever suffix (after `/dev/tty`) identifies the serial port you want to use. You can, if you choose, simply start up with no Nindy connection by responding to the prompt with an empty line. If you do this and later wish to attach to Nindy, use `target` (see Commands for managing targets).

Node:Nindy Options, Next:Nindy Reset, Previous:Nindy Startup, Up:i960

#### Options for Nindy

These are the startup options for beginning your GDB session with a Nindy-960 board attached:

`-r port`
  Specify the serial port name of a serial interface to be used to connect to the target system. This option is only available when GDB is configured for the Intel 960 target architecture. You may specify port as any of: a full pathname (e.g. `-r /dev/ttya`), a device name in `/dev` (e.g. `-r ttya`), or simply the unique suffix for a specific `tty` (e.g. `-r a`).
`-O`
  (An uppercase letter "O", not a zero.) Specify that GDB should use the "old" Nindy monitor protocol to connect to the target system. This option is only available when GDB is configured for the Intel 960 target architecture.

  > Warning: if you specify `-O`, but are actually trying to connect to a target system that expects the newer protocol, the connection fails, appearing to be a speed mismatch. GDB repeatedly attempts to reconnect at several different line speeds. You can abort this process with an interrupt.

`-brk`
  Specify that GDB should first send a `BREAK` signal to the target system, in an attempt to reset it, before connecting to a Nindy target.

  > Warning: Many target systems do not have the hardware that this requires; it only works with a few boards.

The standard `-b` option controls the line speed used on the serial port.

Node:Nindy Reset, Previous:Nindy Options, Up:i960

#### Nindy reset command

`reset`
  For a Nindy target, this command sends a "break" to the remote target system; this is only useful if the target has been equipped with a circuit to perform a hard reset (or some other interesting action) when a break is detected.

Node:M32R/D, Next:M68K, Previous:i960, Up:Embedded Processors

### Mitsubishi M32R/D

`target m32r dev`
  Mitsubishi M32R/D ROM monitor.

Node:M68K, Next:M88K, Previous:M32R/D, Up:Embedded Processors

### M68k

The Motorola m68k configuration includes ColdFire support, and target command for the following ROM monitors.

`target abug dev`
  ABug ROM monitor for M68K.
`target cpu32bug dev`
  CPU32BUG monitor, running on a CPU32 (M68K) board.
`target dbug dev`
  dBUG ROM monitor for Motorola ColdFire.
`target est dev`
  EST-300 ICE monitor, running on a CPU32 (M68K) board.
`target rom68k dev`
  ROM 68K monitor, running on an M68K IDP board.

If GDB is configured with `m68*-ericsson-*`, it will instead have only a single special target command:

`target es1800 dev`
  ES-1800 emulator for M68K.

[context?]

`target rombug dev`
  ROMBUG ROM monitor for OS/9000.

Node:M88K, Next:MIPS Embedded, Previous:M68K, Up:Embedded Processors

### M88K

`target bug dev`
  BUG monitor, running on a MVME187 (m88k) board.

Node:MIPS Embedded, Next:PA, Previous:M88K, Up:Embedded Processors

### MIPS Embedded

GDB can use the MIPS remote debugging protocol to talk to a MIPS board attached to a serial line. This is available when you configure GDB with `--target=mips-idt-ecoff`.

Use these GDB commands to specify the connection to your target board:

`target mips port`
  To run a program on the board, start up `gdb` with the name of your program as the argument. To connect to the board, use the command `target mips port`, where port is the name of the serial port connected to the board. If the program has not already been downloaded to the board, you may use the `load` command to download it. You can then use all the usual GDB commands.

  For example, this sequence connects to the target board through a serial port, and loads and runs a program called prog through the debugger:

      host$ gdb prog
      GDB is free software and ...
      (gdb) target mips /dev/ttyb
      (gdb) load prog
      (gdb) run

`target mips hostname:portnumber`
  On some GDB host configurations, you can specify a TCP connection (for instance, to a serial line managed by a terminal concentrator) instead of a serial port, using the syntax `hostname:portnumber`.
`target pmon port`
  PMON ROM monitor.
`target ddb port`
  NEC's DDB variant of PMON for Vr4300.
`target lsi port`
  LSI variant of PMON.
`target r3900 dev`
  Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips.
`target array dev`
  Array Tech LSI33K RAID controller board.

GDB also supports these special commands for MIPS targets:

`set processor args`
`show processor`
  Use the `set processor` command to set the type of MIPS processor when you want to access processor-type-specific registers. For example, `set processor r3041` tells GDB to use the CPO registers appropriate for the 3041 chip. Use the `show processor` command to see what MIPS processor GDB is using. Use the `info reg` command to see what registers GDB is using.
`set mipsfpu double`
`set mipsfpu single`
`set mipsfpu none`
`show mipsfpu`
  If your target board does not support the MIPS floating point coprocessor, you should use the command `set mipsfpu none` (if you need this, you may wish to put the command in your GDB init file). This tells GDB how to find the return value of functions which return floating point values. It also allows GDB to avoid saving the floating point registers when calling functions on the board. If you are using a floating point coprocessor with only single precision floating point support, as on the R4650 processor, use the command `set mipsfpu single`. The default double precision floating point coprocessor may be selected using `set mipsfpu double`.

  In previous versions the only choices were double precision or no floating point, so `set mipsfpu on` will select double precision and `set mipsfpu off` will select no floating point.

  As usual, you can inquire about the `mipsfpu` variable with `show mipsfpu`.

`set remotedebug n`
`show remotedebug`
  You can see some debugging information about communications with the board by setting the `remotedebug` variable. If you set it to `1` using `set remotedebug 1`, every packet is displayed. If you set it to `2`, every character is displayed. You can check the current value at any time with the command `show remotedebug`.
`set timeout seconds`
`set retransmit-timeout seconds`
`show timeout`
`show retransmit-timeout`
  You can control the timeout used while waiting for a packet, in the MIPS remote protocol, with the `set timeout seconds` command. The default is 5 seconds. Similarly, you can control the timeout used while waiting for an acknowledgement of a packet with the `set retransmit-timeout seconds` command. The default is 3 seconds. You can inspect both values with `show timeout` and `show retransmit-timeout`. (These commands are only available when GDB is configured for `--target=mips-idt-ecoff`.)

  The timeout set by `set timeout` does not apply when GDB is waiting for your program to stop. In that case, GDB waits forever because it has no way of knowing how long the program is going to run before stopping.

Node:PowerPC, Next:SH, Previous:PA, Up:Embedded Processors

### PowerPC

`target dink32 dev`
  DINK32 ROM monitor.
`target ppcbug dev`
`target ppcbug1 dev`
  PPCBUG ROM monitor for PowerPC.
`target sds dev`
  SDS monitor, running on a PowerPC board (such as Motorola's ADS).

Node:PA, Next:PowerPC, Previous:MIPS Embedded, Up:Embedded Processors

### HP PA Embedded

`target op50n dev`
  OP50N monitor, running on an OKI HPPA board.
`target w89k dev`
  W89K monitor, running on a Winbond HPPA board.

Node:SH, Next:Sparclet, Previous:PowerPC, Up:Embedded Processors

### Hitachi SH

`target hms dev`
  A Hitachi SH board attached via serial line to your host. Use special commands `device` and `speed` to control the serial line and the communications speed used.
`target e7000 dev`
  E7000 emulator for Hitachi SH.
`target sh3 dev`
`target sh3e dev`
  Hitachi SH-3 and SH-3E target systems.

Node:Sparclet, Next:Sparclite, Previous:SH, Up:Embedded Processors

### Tsqware Sparclet

GDB enables developers to debug tasks running on Sparclet targets from a Unix host. GDB uses code that runs on both the Unix host and on the Sparclet target. The program `gdb` is installed and executed on the Unix host.

`remotetimeout args`
  GDB supports the option `remotetimeout`. This option is set by the user, and args represents the number of seconds GDB waits for responses.

When compiling for debugging, include the options `-g` to get debug information and `-Ttext` to relocate the program to where you wish to load it on the target. You may also want to add the options `-n` or `-N` in order to reduce the size of the sections. Example:

    sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N

You can use `objdump` to verify that the addresses are what you intended:

    sparclet-aout-objdump --headers --syms prog

Once you have set your Unix execution search path to find GDB, you are ready to run GDB. From your Unix host, run `gdb` (or `sparclet-aout-gdb`, depending on your installation). GDB comes up showing the prompt:

    (gdbslet)

- Sparclet File: Setting the file to debug
- Sparclet Connection: Connecting to Sparclet
- Sparclet Download: Sparclet download
- Sparclet Execution: Running and debugging

Node:Sparclet File, Next:Sparclet Connection, Up:Sparclet

#### Setting file to debug

The GDB command `file` lets you choose with program to debug.

    (gdbslet) file prog

GDB then attempts to read the symbol table of `prog`. GDB locates the file by searching the directories listed in the command search path. If the file was compiled with debug information (option "-g"), source files will be searched as well. GDB locates the source files by searching the directories listed in the directory search path (see Your program's environment). If it fails to find a file, it displays a message such as:

    prog: No such file or directory.

When this happens, add the appropriate directories to the search paths with the GDB commands `path` and `dir`, and execute the `target` command again.

Node:Sparclet Connection, Next:Sparclet Download, Previous:Sparclet File, Up:Sparclet

#### Connecting to Sparclet

The GDB command `target` lets you connect to a Sparclet target. To connect to a target on serial port "`ttya`", type:

    (gdbslet) target sparclet /dev/ttya
    Remote target sparclet connected to /dev/ttya
    main () at ../prog.c:3

GDB displays messages like these:

    Connected to ttya.

Node:Sparclet Download, Next:Sparclet Execution, Previous:Sparclet Connection, Up:Sparclet

#### Sparclet download

Once connected to the Sparclet target, you can use the GDB `load` command to download the file from the host to the target. The file name and load offset should be given as arguments to the `load` command. Since the file format is aout, the program must be loaded to the starting address. You can use `objdump` to find out what this value is. The load offset is an offset which is added to the VMA (virtual memory address) of each of the file's sections. For instance, if the program `prog` was linked to text address 0x1201000, with data at 0x12010160 and bss at 0x12010170, in GDB, type:

    (gdbslet) load prog 0x12010000
    Loading section .text, size 0xdb0 vma 0x12010000

If the code is loaded at a different address then what the program was linked to, you may need to use the `section` and `add-symbol-file` commands to tell GDB where to map the symbol table.

Node:Sparclet Execution, Previous:Sparclet Download, Up:Sparclet

#### Running and debugging

You can now begin debugging the task using GDB's execution control commands, `b`, `step`, `run`, etc. See the GDB manual for the list of commands.

    (gdbslet) b main
    Breakpoint 1 at 0x12010000: file prog.c, line 3.
    (gdbslet) run
    Starting program: prog
    Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3
    3        char *symarg = 0;
    (gdbslet) step
    4        char *execarg = "hello!";
    (gdbslet)

Node:Sparclite, Next:ST2000, Previous:Sparclet, Up:Embedded Processors

### Fujitsu Sparclite

`target sparclite dev`
  Fujitsu sparclite boards, used only for the purpose of loading. You must use an additional command to debug the program. For example: target remote dev using GDB standard remote protocol.

Node:ST2000, Next:Z8000, Previous:Sparclite, Up:Embedded Processors

### Tandem ST2000

GDB may be used with a Tandem ST2000 phone switch, running Tandem's STDBUG protocol.

To connect your ST2000 to the host system, see the manufacturer's manual. Once the ST2000 is physically attached, you can run:

    target st2000 dev speed

to establish it as your debugging environment. dev is normally the name of a serial device, such as `/dev/ttya`, connected to the ST2000 via a serial line. You can instead specify dev as a TCP connection (for example, to a serial line attached via a terminal concentrator) using the syntax `hostname:portnumber`.

The `load` and `attach` commands are not defined for this target; you must load your program into the ST2000 as you normally would for standalone operation. GDB reads debugging information (such as symbols) from a separate, debugging version of the program available on your host computer.

These auxiliary GDB commands are available to help you with the ST2000 environment:

`st2000 command`
  Send a command to the STDBUG monitor. See the manufacturer's manual for available commands.
`connect`
  Connect the controlling terminal to the STDBUG command monitor. When you are done interacting with STDBUG, typing either of two character sequences gets you back to the GDB command prompt: `<RET>~.` (Return, followed by tilde and period) or `<RET>~<C-d>` (Return, followed by tilde and control-D).

Node:Z8000, Previous:ST2000, Up:Embedded Processors

### Zilog Z8000

When configured for debugging Zilog Z8000 targets, GDB includes a Z8000 simulator.

For the Z8000 family, `target sim` simulates either the Z8002 (the unsegmented variant of the Z8000 architecture) or the Z8001 (the segmented variant). The simulator recognizes which architecture is appropriate by inspecting the object code.

`target sim args`
  Debug programs on a simulated CPU. If the simulator supports setup options, specify them via args.

After specifying this target, you can debug programs for the simulated CPU in the same style as programs for your host computer; use the `file` command to load a new program image, the `run` command to run your program, and so on.

As well as making available all the usual machine registers (see Registers), the Z8000 simulator provides three additional items of information as specially named registers:

`cycles`
  Counts clock-ticks in the simulator.
`insts`
  Counts instructions run in the simulator.
`time`
  Execution time in 60ths of a second.

You can refer to these values in GDB expressions with the usual conventions; for example, `b fputc if $cycles>5000` sets a conditional breakpoint that suspends only after at least 5000 simulated clock ticks.

Node:Architectures, Previous:Embedded Processors, Up:Configurations

## Architectures

This section describes characteristics of architectures that affect all uses of GDB with the architecture, both native and cross.

- A29K:
- Alpha:
- MIPS:

Node:A29K, Next:Alpha, Up:Architectures

### A29K

`set rstack_high_address address`
  On AMD 29000 family processors, registers are saved in a separate register stack. There is no way for GDB to determine the extent of this stack. Normally, GDB just assumes that the stack is "large enough". This may result in GDB referencing memory locations that do not exist. If necessary, you can get around this problem by specifying the ending address of the register stack with the `set rstack_high_address` command. The argument should be an address, which you probably want to precede with `0x` to specify in hexadecimal.
`show rstack_high_address`
  Display the current limit of the register stack, on AMD 29000 family processors.

Node:Alpha, Next:MIPS, Previous:A29K, Up:Architectures

### Alpha

See the following section.

Node:MIPS, Previous:Alpha, Up:Architectures

### MIPS

Alpha- and MIPS-based computers use an unusual stack frame, which sometimes requires GDB to search backward in the object code to find the beginning of a function.

To improve response time (especially for embedded applications, where GDB may be restricted to a slow serial line for this search) you may want to limit the size of this search, using one of these commands:

`set heuristic-fence-post limit`
  Restrict GDB to examining at most limit bytes in its search for the beginning of a function. A value of 0 (the default) means there is no limit. However, except for 0, the larger the limit the more bytes `heuristic-fence-post` must search and therefore the longer it takes to run.
`show heuristic-fence-post`
  Display the current limit.

These commands are available only when GDB is configured for debugging programs on Alpha or MIPS processors.

Node:Controlling GDB, Next:Sequences, Previous:Configurations, Up:Top

# Controlling GDB

You can alter the way GDB interacts with you by using the `set` command. For commands controlling how GDB displays data, see Print settings. Other settings are described here.

- Prompt: Prompt
- Editing: Command editing
- History: Command history
- Screen Size: Screen size
- Numbers: Numbers
- Messages/Warnings: Optional warnings and messages
- Debugging Output: Optional messages about internal happenings

Node:Prompt, Next:Editing, Up:Controlling GDB

## Prompt

GDB indicates its readiness to read a command by printing a string called the prompt. This string is normally `(gdb)`. You can change the prompt string with the `set prompt` command. For instance, when debugging GDB with GDB, it is useful to change the prompt in one of the GDB sessions so that you can always tell which one you are talking to.

Note: `set prompt` does not add a space for you after the prompt you set. This allows you to set a prompt which ends in a space or a prompt that does not.

`set prompt newprompt`
  Directs GDB to use newprompt as its prompt string henceforth.
`show prompt`
  Prints a line of the form: `Gdb's prompt is: your-prompt`

Node:Editing, Next:History, Previous:Prompt, Up:Controlling GDB

## Command editing

GDB reads its input commands via the readline interface. This GNU library provides consistent behavior for programs which provide a command line interface to the user. Advantages are GNU Emacs-style or vi-style inline editing of commands, `csh`-like history substitution, and a storage and recall of command history across debugging sessions.

You may control the behavior of command line editing in GDB with the command `set`.

`set editing`
`set editing on`
  Enable command line editing (enabled by default).
`set editing off`
  Disable command line editing.
`show editing`
  Show whether command line editing is enabled.

Node:History, Next:Screen Size, Previous:Editing, Up:Controlling GDB

## Command history

GDB can keep track of the commands you type during your debugging sessions, so that you can be certain of precisely what happened. Use these commands to manage the GDB command history facility.

`set history filename fname`
  Set the name of the GDB command history file to fname. This is the file where GDB reads an initial command history list, and where it writes the command history from this session when it exits. You can access this list through history expansion or through the history command editing characters listed below. This file defaults to the value of the environment variable `GDBHISTFILE`, or to `./.gdb_history` (`./_gdb_history` on MS-DOS) if this variable is not set.
`set history save`
`set history save on`
  Record command history in a file, whose name may be specified with the `set history filename` command. By default, this option is disabled.
`set history save off`
  Stop recording command history in a file.
`set history size size`
  Set the number of commands which GDB keeps in its history list. This defaults to the value of the environment variable `HISTSIZE`, or to 256 if this variable is not set.

History expansion assigns special meaning to the character `!`.

Since `!` is also the logical not operator in C, history expansion is off by default. If you decide to enable history expansion with the `set history expansion on` command, you may sometimes need to follow `!` (when it is used as logical not, in an expression) with a space or a tab to prevent it from being expanded. The readline history facilities do not attempt substitution on the strings `!=` and `!(`, even when history expansion is enabled.

The commands to control history expansion are:

`set history expansion on`
`set history expansion`
  Enable history expansion. History expansion is off by default.
`set history expansion off`
  Disable history expansion.

  The readline code comes with more complete documentation of editing and history expansion features. Users unfamiliar with GNU Emacs or `vi` may wish to read it.

`show history`
`show history filename`
`show history save`
`show history size`
`show history expansion`
  These commands display the state of the GDB history parameters. `show history` by itself displays all four states.

`show commands`
  Display the last ten commands in the command history.
`show commands n`
  Print ten commands centered on command number n.
`show commands +`
  Print ten commands just after the commands last printed.

Node:Screen Size, Next:Numbers, Previous:History, Up:Controlling GDB

## Screen size

Certain commands to GDB may produce large amounts of information output to the screen. To help you read all of it, GDB pauses and asks you for input at the end of each page of output. Type <RET> when you want to continue the output, or `q` to discard the remaining output. Also, the screen width setting determines when to wrap lines of output. Depending on what is being printed, GDB tries to break the line at a readable place, rather than simply letting it overflow onto the following line.

Normally GDB knows the size of the screen from the terminal driver software. For example, on Unix GDB uses the termcap data base together with the value of the `TERM` environment variable and the `stty rows` and `stty cols` settings. If this is not correct, you can override it with the `set height` and `set width` commands:

`set height lpp`
`show height`
`set width cpl`
`show width`
  These `set` commands specify a screen height of lpp lines and a screen width of cpl characters. The associated `show` commands display the current settings.

  If you specify a height of zero lines, GDB does not pause during output no matter how long the output is. This is useful if output is to a file or to an editor buffer.

  Likewise, you can specify `set width 0` to prevent GDB from wrapping its output.

Node:Numbers, Next:Messages/Warnings, Previous:Screen Size, Up:Controlling GDB

## Numbers

You can always enter numbers in octal, decimal, or hexadecimal in GDB by the usual conventions: octal numbers begin with `0`, decimal numbers end with `.`, and hexadecimal numbers begin with `0x`. Numbers that begin with none of these are, by default, entered in base 10; likewise, the default display for numbers--when no particular format is specified--is base 10. You can change the default base for both input and output with the `set radix` command.

`set input-radix base`
  Set the default base for numeric input. Supported choices for base are decimal 8, 10, or 16. base must itself be specified either unambiguously or using the current default radix; for example, any of

      set radix 012
      set radix 10.
      set radix 0xa

  sets the base to decimal. On the other hand, `set radix 10` leaves the radix unchanged no matter what it was.

`set output-radix base`
  Set the default base for numeric display. Supported choices for base are decimal 8, 10, or 16. base must itself be specified either unambiguously or using the current default radix.
`show input-radix`
  Display the current default base for numeric input.
`show output-radix`
  Display the current default base for numeric display.

Node:Messages/Warnings, Next:Debugging Output, Previous:Numbers, Up:Controlling GDB

## Optional warnings and messages

By default, GDB is silent about its inner workings. If you are running on a slow machine, you may want to use the `set verbose` command. This makes GDB tell you when it does a lengthy internal operation, so you will not think it has crashed.

Currently, the messages controlled by `set verbose` are those which announce that the symbol table for a source file is being read; see `symbol-file` in Commands to specify files.

`set verbose on`
  Enables GDB output of certain informational messages.
`set verbose off`
  Disables GDB output of certain informational messages.
`show verbose`
  Displays whether `set verbose` is on or off.

By default, if GDB encounters bugs in the symbol table of an object file, it is silent; but if you are debugging a compiler, you may find this information useful (see Errors reading symbol files).

`set complaints limit`
  Permits GDB to output limit complaints about each type of unusual symbols before becoming silent about the problem. Set limit to zero to suppress all complaints; set it to a large number to prevent complaints from being suppressed.
`show complaints`
  Displays how many symbol complaints GDB is permitted to produce.

By default, GDB is cautious, and asks what sometimes seems to be a lot of stupid questions to confirm certain commands. For example, if you try to run a program which is already running:

    (gdb) run
    The program being debugged has been started already.
    Start it from the beginning? (y or n)

If you are willing to unflinchingly face the consequences of your own commands, you can disable this "feature":

`set confirm off`
  Disables confirmation requests.
`set confirm on`
  Enables confirmation requests (the default).
`show confirm`
  Displays state of confirmation requests.

Node:Debugging Output, Previous:Messages/Warnings, Up:Controlling GDB

## Optional messages about internal happenings

`set debug arch`
  Turns on or off display of gdbarch debugging info. The default is off
`show debug arch`
  Displays the current state of displaying gdbarch debugging info.
`set debug event`
  Turns on or off display of GDB event debugging info. The default is off.
`show debug event`
  Displays the current state of displaying GDB event debugging info.
`set debug expression`
  Turns on or off display of GDB expression debugging info. The default is off.
`show debug expression`
  Displays the current state of displaying GDB expression debugging info.
`set debug overload`
  Turns on or off display of GDB C++ overload debugging info. This includes info such as ranking of functions, etc. The default is off.
`show debug overload`
  Displays the current state of displaying GDB C++ overload debugging info.
`set debug remote`
  Turns on or off display of reports on all packets sent back and forth across the serial line to the remote machine. The info is printed on the GDB standard output stream. The default is off.
`show debug remote`
  Displays the state of display of remote packets.
`set debug serial`
  Turns on or off display of GDB serial debugging info. The default is off.
`show debug serial`
  Displays the current state of displaying GDB serial debugging info.
`set debug target`
  Turns on or off display of GDB target debugging info. This info includes what is going on at the target level of GDB, as it happens. The default is off.
`show debug target`
  Displays the current state of displaying GDB target debugging info.
`set debug varobj`
  Turns on or off display of GDB variable object debugging info. The default is off.
`show debug varobj`
  Displays the current state of displaying GDB variable object debugging info.

Node:Sequences, Next:Emacs, Previous:Controlling GDB, Up:Top

# Canned Sequences of Commands

Aside from breakpoint commands (see Breakpoint command lists), GDB provides two ways to store sequences of commands for execution as a unit: user-defined commands and command files.

- Define: User-defined commands
- Hooks: User-defined command hooks
- Command Files: Command files
- Output: Commands for controlled output

Node:Define, Next:Hooks, Up:Sequences

## User-defined commands

A user-defined command is a sequence of GDB commands to which you assign a new name as a command. This is done with the `define` command. User commands may accept up to 10 arguments separated by whitespace. Arguments are accessed within the user command via $arg0...$arg9. A trivial example:

    define adder
      print $arg0 + $arg1 + $arg2

To execute the command use:

    adder 1 2 3

This defines the command `adder`, which prints the sum of its three arguments. Note the arguments are text substitutions, so they may reference variables, use complex expressions, or even perform inferior functions calls.

`define commandname`
  Define a command named commandname. If there is already a command by that name, you are asked to confirm that you want to redefine it.

  The definition of the command is made up of other GDB command lines, which are given following the `define` command. The end of these commands is marked by a line containing `end`.

`if`
  Takes a single argument, which is an expression to evaluate. It is followed by a series of commands that are executed only if the expression is true (nonzero). There can then optionally be a line `else`, followed by a series of commands that are only executed if the expression was false. The end of the list is marked by a line containing `end`.
`while`
  The syntax is similar to `if`: the command takes a single argument, which is an expression to evaluate, and must be followed by the commands to execute, one per line, terminated by an `end`. The commands are executed repeatedly as long as the expression evaluates to true.
`document commandname`
  Document the user-defined command commandname, so that it can be accessed by `help`. The command commandname must already be defined. This command reads lines of documentation just as `define` reads the lines of the command definition, ending with `end`. After the `document` command is finished, `help` on command commandname displays the documentation you have written.

  You may use the `document` command again to change the documentation of a command. Redefining the command with `define` does not change the documentation.

`help user-defined`
  List all user-defined commands, with the first line of the documentation (if any) for each.
`show user`
`show user commandname`
  Display the GDB commands used to define commandname (but not its documentation). If no commandname is given, display the definitions for all user-defined commands.

When user-defined commands are executed, the commands of the definition are not printed. An error in any command stops execution of the user-defined command.

If used interactively, commands that would ask for confirmation proceed without asking when used inside a user-defined command. Many GDB commands that normally print messages to say what they are doing omit the messages when used in a user-defined command.

Node:Hooks, Next:Command Files, Previous:Define, Up:Sequences

## User-defined command hooks

You may define hooks, which are a special kind of user-defined command. Whenever you run the command `foo`, if the user-defined command `hook-foo` exists, it is executed (with no arguments) before that command.

In addition, a pseudo-command, `stop` exists. Defining (`hook-stop`) makes the associated commands execute every time execution stops in your program: before breakpoint commands are run, displays are printed, or the stack frame is printed.

For example, to ignore `SIGALRM` signals while single-stepping, but treat them normally during normal execution, you could define:

    define hook-stop
    handle SIGALRM nopass
    end

    define hook-run
    handle SIGALRM pass
    end

    define hook-continue
    handle SIGLARM pass
    end

You can define a hook for any single-word command in GDB, but not for command aliases; you should define a hook for the basic command name, e.g. `backtrace` rather than `bt`. If an error occurs during the execution of your hook, execution of GDB commands stops and GDB issues a prompt (before the command that you actually typed had a chance to run).

If you try to define a hook which does not match any known command, you get a warning from the `define` command.

Node:Command Files, Next:Output, Previous:Hooks, Up:Sequences

## Command files

A command file for GDB is a file of lines that are GDB commands. Comments (lines starting with `#`) may also be included. An empty line in a command file does nothing; it does not mean to repeat the last command, as it would from the terminal.

When you start GDB, it automatically executes commands from its init files. These are files named `.gdbinit` on Unix, or `gdb.ini` on DOS/Windows. GDB reads the init file (if any) in your home directory6, then processes command line options and operands, and then reads the init file (if any) in the current working directory. This is so the init file in your home directory can set options (such as `set complaints`) which affect the processing of the command line options and operands. The init files are not executed if you use the `-nx` option; see Choosing modes.

On some configurations of GDB, the init file is known by a different name (these are typically environments where a specialized form of GDB may need to coexist with other forms, hence a different name for the specialized version's init file). These are the environments with special init file names:

- VxWorks (Wind River Systems real-time OS): `.vxgdbinit`
- OS68K (Enea Data Systems real-time OS): `.os68gdbinit`
- ES-1800 (Ericsson Telecom AB M68000 emulator): `.esgdbinit`

You can also request the execution of a command file with the `source` command:

`source filename`
  Execute the command file filename.

The lines in a command file are executed sequentially. They are not printed as they are executed. An error in any command terminates execution of the command file.

Commands that would ask for confirmation if used interactively proceed without asking when used in a command file. Many GDB commands that normally print messages to say what they are doing omit the messages when called from command files.

Node:Output, Previous:Command Files, Up:Sequences

## Commands for controlled output

During the execution of a command file or a user-defined command, normal GDB output is suppressed; the only output that appears is what is explicitly printed by the commands in the definition. This section describes three commands useful for generating exactly the output you want.

`echo text`
  Print text. Nonprinting characters can be included in text using C escape sequences, such as `\n` to print a newline. No newline is printed unless you specify one. In addition to the standard C escape sequences, a backslash followed by a space stands for a space. This is useful for displaying a string with spaces at the beginning or the end, since leading and trailing spaces are otherwise trimmed from all arguments. To print `and foo =` , use the command `echo \ and foo = \` .

  A backslash at the end of text can be used, as in C, to continue the command onto subsequent lines. For example,

      echo This is some text\n\
      which is continued\n\
      onto several lines.\n

  produces the same output as

      echo This is some text\n
      echo which is continued\n
      echo onto several lines.\n

`output expression`
  Print the value of expression and nothing but that value: no newlines, no `$nn =` . The value is not entered in the value history either. See Expressions, for more information on expressions.
`output/fmt expression`
  Print the value of expression in format fmt. You can use the same formats as for `print`. See Output formats, for more information.
`printf string, expressions...`
  Print the values of the expressions under the control of string. The expressions are separated by commas and may be either numbers or pointers. Their values are printed as specified by string, exactly as if your program were to execute the C subroutine

      printf (string, expressions...);

  For example, you can print two values in hex like this:

      printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo

  The only backslash-escape sequences that you can use in the format string are the simple ones that consist of backslash followed by a letter.

Node:Emacs, Next:Annotations, Previous:Sequences, Up:Top

# Using GDB under GNU Emacs

A special interface allows you to use GNU Emacs to view (and edit) the source files for the program you are debugging with GDB.

To use this interface, use the command `M-x gdb` in Emacs. Give the executable file you want to debug as an argument. This command starts GDB as a subprocess of Emacs, with input and output through a newly created Emacs buffer.

Using GDB under Emacs is just like using GDB normally except for two things:

- All "terminal" input and output goes through the Emacs buffer.

This applies both to GDB commands and their output, and to the input and output done by the program you are debugging.

This is useful because it means that you can copy the text of previous commands and input them again; you can even use parts of the output in this way.

All the facilities of Emacs' Shell mode are available for interacting with your program. In particular, you can send signals the usual way--for example, `C-c C-c` for an interrupt, `C-c C-z` for a stop.

- GDB displays source code through Emacs.

Each time GDB displays a stack frame, Emacs automatically finds the source file for that frame and puts an arrow (`=>`) at the left margin of the current line. Emacs uses a separate buffer for source display, and splits the screen to show both your GDB session and the source.

Explicit GDB `list` or search commands still produce output as usual, but you probably have no reason to use them from Emacs.

> Warning: If the directory where your program resides is not your current directory, it can be easy to confuse Emacs about the location of the source files, in which case the auxiliary display buffer does not appear to show your source. GDB can find programs by searching your environment's `PATH` variable, so the GDB input and output session proceeds normally; but Emacs does not get enough information back from GDB to locate the source files in this situation. To avoid this problem, either start GDB mode from the directory where your program resides, or specify an absolute file name when prompted for the `M-x gdb` argument.

> A similar confusion can result if you use the GDB `file` command to switch to debugging a program in some other location, from an existing GDB buffer in Emacs.

By default, `M-x gdb` calls the program called `gdb`. If you need to call GDB by a different name (for example, if you keep several configurations around, with different names) you can set the Emacs variable `gdb-command-name`; for example,

    (setq gdb-command-name "mygdb")

(preceded by `M-:` or `ESC :`, or typed in the `*scratch*` buffer, or in your `.emacs` file) makes Emacs call the program named "`mygdb`" instead.

In the GDB I/O buffer, you can use these special Emacs commands in addition to the standard Shell mode commands:

`C-h m`
  Describe the features of Emacs' GDB Mode.
`M-s`
  Execute to another source line, like the GDB `step` command; also update the display window to show the current file and location.
`M-n`
  Execute to next source line in this function, skipping all function calls, like the GDB `next` command. Then update the display window to show the current file and location.
`M-i`
  Execute one instruction, like the GDB `stepi` command; update display window accordingly.
`M-x gdb-nexti`
  Execute to next instruction, using the GDB `nexti` command; update display window accordingly.
`C-c C-f`
  Execute until exit from the selected stack frame, like the GDB `finish` command.
`M-c`
  Continue execution of your program, like the GDB `continue` command.

  Warning: In Emacs v19, this command is `C-c C-p`.

`M-u`
  Go up the number of frames indicated by the numeric argument (see Arguments), like the GDB `up` command.

  Warning: In Emacs v19, this command is `C-c C-u`.

`M-d`
  Go down the number of frames indicated by the numeric argument, like the GDB `down` command.

  Warning: In Emacs v19, this command is `C-c C-d`.

`C-x &`
  Read the number where the cursor is positioned, and insert it at the end of the GDB I/O buffer. For example, if you wish to disassemble code around an address that was displayed earlier, type `disassemble`; then move the cursor to the address display, and pick up the argument for `disassemble` by typing `C-x &`.

  You can customize this further by defining elements of the list `gdb-print-command`; once it is defined, you can format or otherwise process numbers picked up by `C-x &` before they are inserted. A numeric argument to `C-x &` indicates that you wish special formatting, and also acts as an index to pick an element of the list. If the list element is a string, the number to be inserted is formatted using the Emacs function `format`; otherwise the number is passed as an argument to the corresponding list element.

In any source file, the Emacs command `C-x SPC` (`gdb-break`) tells GDB to set a breakpoint on the source line point is on.

If you accidentally delete the source-display buffer, an easy way to get it back is to type the command `f` in the GDB buffer, to request a frame display; when you run under Emacs, this recreates the source buffer if necessary to show you the context of the current frame.

The source files displayed in Emacs are in ordinary Emacs buffers which are visiting the source files in the usual way. You can edit the files with these buffers if you wish; but keep in mind that GDB communicates with Emacs in terms of line numbers. If you add or delete lines from the text, the line numbers that GDB knows cease to correspond properly with the code.

Node:Annotations, Next:GDB Bugs, Previous:Emacs, Up:Top

# GDB Annotations

This chapter describes annotations in GDB. Annotations are designed to interface GDB to graphical user interfaces or other similar programs which want to interact with GDB at a relatively high level.

- Annotations Overview: What annotations are; the general syntax.
- Server Prefix: Issuing a command without affecting user state.
- Value Annotations: Values are marked as such.
- Frame Annotations: Stack frames are annotated.
- Displays: GDB can be told to display something periodically.
- Prompting: Annotations marking GDB's need for input.
- Errors: Annotations for error messages.
- Breakpoint Info: Information on breakpoints.
- Invalidation: Some annotations describe things now invalid.
- Annotations for Running: Whether the program is running, how it stopped, etc.
- Source Annotations: Annotations describing source code.
- TODO: Annotations which might be added in the future.

Node:Annotations Overview, Next:Server Prefix, Up:Annotations

## What is an Annotation?

To produce annotations, start GDB with the `--annotate=2` option.

Annotations start with a newline character, two `control-z` characters, and the name of the annotation. If there is no additional information associated with this annotation, the name of the annotation is followed immediately by a newline. If there is additional information, the name of the annotation is followed by a space, the additional information, and a newline. The additional information cannot contain newline characters.

Any output not beginning with a newline and two `control-z` characters denotes literal output from GDB. Currently there is no need for GDB to output a newline followed by two `control-z` characters, but if there was such a need, the annotations could be extended with an `escape` annotation which means those three characters as output.

A simple example of starting up GDB with annotations is:

    $ gdb --annotate=2
    GNU GDB 5.0
    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 "sparc-sun-sunos4.1.3"

    ^Z^Zpre-prompt
    (gdb)
    ^Z^Zprompt
    quit

    ^Z^Zpost-prompt
    $

Here `quit` is input to GDB; the rest is output from GDB. The three lines beginning `^Z^Z` (where `^Z` denotes a `control-z` character) are annotations; the rest is output from GDB.

Node:Server Prefix, Next:Value Annotations, Previous:Annotations Overview, Up:Annotations

## The Server Prefix

To issue a command to GDB without affecting certain aspects of the state which is seen by users, prefix it with `server` . This means that this command will not affect the command history, nor will it affect GDB's notion of which command to repeat if <RET> is pressed on a line by itself.

The server prefix does not affect the recording of values into the value history; to print a value without recording it into the value history, use the `output` command instead of the `print` command.

Node:Value Annotations, Next:Frame Annotations, Previous:Server Prefix, Up:Annotations

## Values

When a value is printed in various contexts, GDB uses annotations to delimit the value from the surrounding text.

If a value is printed using `print` and added to the value history, the annotation looks like

    ^Z^Zvalue-history-begin history-number value-flags
    history-string
    ^Z^Zvalue-history-value
    the-value
    ^Z^Zvalue-history-end

where history-number is the number it is getting in the value history, history-string is a string, such as `$5 =` , which introduces the value to the user, the-value is the output corresponding to the value itself, and value-flags is `*` for a value which can be dereferenced and `-` for a value which cannot.

If the value is not added to the value history (it is an invalid float or it is printed with the `output` command), the annotation is similar:

    ^Z^Zvalue-begin value-flags
    the-value
    ^Z^Zvalue-end

When GDB prints an argument to a function (for example, in the output from the `backtrace` command), it annotates it as follows:

    ^Z^Zarg-begin
    argument-name
    ^Z^Zarg-name-end
    separator-string
    ^Z^Zarg-value value-flags
    the-value
    ^Z^Zarg-end

where argument-name is the name of the argument, separator-string is text which separates the name from the value for the user's benefit (such as `=`), and value-flags and the-value have the same meanings as in a `value-history-begin` annotation.

When printing a structure, GDB annotates it as follows:

    ^Z^Zfield-begin value-flags
    field-name
    ^Z^Zfield-name-end
    separator-string
    ^Z^Zfield-value
    the-value
    ^Z^Zfield-end

where field-name is the name of the field, separator-string is text which separates the name from the value for the user's benefit (such as `=`), and value-flags and the-value have the same meanings as in a `value-history-begin` annotation.

When printing an array, GDB annotates it as follows:

    ^Z^Zarray-section-begin array-index value-flags

where array-index is the index of the first element being annotated and value-flags has the same meaning as in a `value-history-begin` annotation. This is followed by any number of elements, where is element can be either a single element:

    , whitespace         ; omitted for the first element
    the-value
    ^Z^Zelt

or a repeated element

    , whitespace         ; omitted for the first element
    the-value
    ^Z^Zelt-rep number-of-repititions
    repetition-string
    ^Z^Zelt-rep-end

In both cases, the-value is the output for the value of the element and whitespace can contain spaces, tabs, and newlines. In the repeated case, number-of-repititons is the number of consecutive array elements which contain that value, and repetition-string is a string which is designed to convey to the user that repitition is being depicted.

Once all the array elements have been output, the array annotation is ended with

    ^Z^Zarray-section-end

Node:Frame Annotations, Next:Displays, Previous:Value Annotations, Up:Annotations

## Frames

Whenever GDB prints a frame, it annotates it. For example, this applies to frames printed when GDB stops, output from commands such as `backtrace` or `up`, etc.

The frame annotation begins with

    ^Z^Zframe-begin level address
    level-string

where level is the number of the frame (0 is the innermost frame, and other frames have positive numbers), address is the address of the code executing in that frame, and level-string is a string designed to convey the level to the user. address is in the form `0x` followed by one or more lowercase hex digits (note that this does not depend on the language). The frame ends with

    ^Z^Zframe-end

Between these annotations is the main body of the frame, which can consist of

-     ^Z^Zfunction-call
      function-call-string

  where function-call-string is text designed to convey to the user that this frame is associated with a function call made by GDB to a function in the program being debugged.

-     ^Z^Zsignal-handler-caller
      signal-handler-caller-string

  where signal-handler-caller-string is text designed to convey to the user that this frame is associated with whatever mechanism is used by this operating system to call a signal handler (it is the frame which calls the signal handler, not the frame for the signal handler itself).

- A normal frame.

  This can optionally (depending on whether this is thought of as interesting information for the user to see) begin with

      ^Z^Zframe-address
      address
      ^Z^Zframe-address-end
      separator-string

  where address is the address executing in the frame (the same address as in the `frame-begin` annotation, but printed in a form which is intended for user consumption--in particular, the syntax varies depending on the language), and separator-string is a string intended to separate this address from what follows for the user's benefit.

  Then comes

      ^Z^Zframe-function-name
      function-name
      ^Z^Zframe-args
      arguments

  where function-name is the name of the function executing in the frame, or `??` if not known, and arguments are the arguments to the frame, with parentheses around them (each argument is annotated individually as well, see Value Annotations).

  If source information is available, a reference to it is then printed:

      ^Z^Zframe-source-begin
      source-intro-string
      ^Z^Zframe-source-file
      filename
      ^Z^Zframe-source-file-end
      :
      ^Z^Zframe-source-line
      line-number
      ^Z^Zframe-source-end

  where source-intro-string separates for the user's benefit the reference from the text which precedes it, filename is the name of the source file, and line-number is the line number within that file (the first line is line 1).

  If GDB prints some information about where the frame is from (which library, which load segment, etc.; currently only done on the RS/6000), it is annotated with

      ^Z^Zframe-where
      information

  Then, if source is to actually be displayed for this frame (for example, this is not true for output from the `backtrace` command), then a `source` annotation (see Source Annotations) is displayed. Unlike most annotations, this is output instead of the normal text which would be output, not in addition.

Node:Displays, Next:Prompting, Previous:Frame Annotations, Up:Annotations

## Displays

When GDB is told to display something using the `display` command, the results of the display are annotated:

    ^Z^Zdisplay-begin
    number
    ^Z^Zdisplay-number-end
    number-separator
    ^Z^Zdisplay-format
    format
    ^Z^Zdisplay-expression
    expression
    ^Z^Zdisplay-expression-end
    expression-separator
    ^Z^Zdisplay-value
    value
    ^Z^Zdisplay-end

where number is the number of the display, number-separator is intended to separate the number from what follows for the user, format includes information such as the size, format, or other information about how the value is being displayed, expression is the expression being displayed, expression-separator is intended to separate the expression from the text that follows for the user, and value is the actual value being displayed.

Node:Prompting, Next:Errors, Previous:Displays, Up:Annotations

## Annotation for GDB Input

When GDB prompts for input, it annotates this fact so it is possible to know when to send output, when the output from a given command is over, etc.

Different kinds of input each have a different input type. Each input type has three annotations: a `pre-` annotation, which denotes the beginning of any prompt which is being output, a plain annotation, which denotes the end of the prompt, and then a `post-` annotation which denotes the end of any echo which may (or may not) be associated with the input. For example, the `prompt` input type features the following annotations:

    ^Z^Zpre-prompt
    ^Z^Zprompt
    ^Z^Zpost-prompt

The input types are

`prompt`
  When GDB is prompting for a command (the main GDB prompt).
`commands`
  When GDB prompts for a set of commands, like in the `commands` command. The annotations are repeated for each command which is input.
`overload-choice`
  When GDB wants the user to select between various overloaded functions.
`query`
  When GDB wants the user to confirm a potentially dangerous operation.
`prompt-for-continue`
  When GDB is asking the user to press return to continue. Note: Don't expect this to work well; instead use `set height 0` to disable prompting. This is because the counting of lines is buggy in the presence of annotations.

Node:Errors, Next:Breakpoint Info, Previous:Prompting, Up:Annotations

## Errors

    ^Z^Zquit

This annotation occurs right before GDB responds to an interrupt.

    ^Z^Zerror

This annotation occurs right before GDB responds to an error.

Quit and error annotations indicate that any annotations which GDB was in the middle of may end abruptly. For example, if a `value-history-begin` annotation is followed by a `error`, one cannot expect to receive the matching `value-history-end`. One cannot expect not to receive it either, however; an error annotation does not necessarily mean that GDB is immediately returning all the way to the top level.

A quit or error annotation may be preceded by

    ^Z^Zerror-begin

Any output between that and the quit or error annotation is the error message.

Warning messages are not yet annotated.

Node:Breakpoint Info, Next:Invalidation, Previous:Errors, Up:Annotations

## Information on Breakpoints

The output from the `info breakpoints` command is annotated as follows:

    ^Z^Zbreakpoints-headers
    header-entry
    ^Z^Zbreakpoints-table

where header-entry has the same syntax as an entry (see below) but instead of containing data, it contains strings which are intended to convey the meaning of each field to the user. This is followed by any number of entries. If a field does not apply for this entry, it is omitted. Fields may contain trailing whitespace. Each entry consists of:

    ^Z^Zrecord
    ^Z^Zfield 0
    number
    ^Z^Zfield 1
    type
    ^Z^Zfield 2
    disposition
    ^Z^Zfield 3
    enable
    ^Z^Zfield 4
    address
    ^Z^Zfield 5
    what
    ^Z^Zfield 6
    frame
    ^Z^Zfield 7
    condition
    ^Z^Zfield 8
    ignore-count
    ^Z^Zfield 9
    commands

Note that address is intended for user consumption--the syntax varies depending on the language.

The output ends with

    ^Z^Zbreakpoints-table-end

Node:Invalidation, Next:Annotations for Running, Previous:Breakpoint Info, Up:Annotations

## Invalidation Notices

The following annotations say that certain pieces of state may have changed.

`^Z^Zframes-invalid`
  The frames (for example, output from the `backtrace` command) may have changed.
`^Z^Zbreakpoints-invalid`
  The breakpoints may have changed. For example, the user just added or deleted a breakpoint.

Node:Annotations for Running, Next:Source Annotations, Previous:Invalidation, Up:Annotations

## Running the Program

When the program starts executing due to a GDB command such as `step` or `continue`,

    ^Z^Zstarting

is output. When the program stops,

    ^Z^Zstopped

is output. Before the `stopped` annotation, a variety of annotations describe how the program stopped.

`^Z^Zexited exit-status`
  The program exited, and exit-status is the exit status (zero for successful exit, otherwise nonzero).
`^Z^Zsignalled`
  The program exited with a signal. After the `^Z^Zsignalled`, the annotation continues:

      intro-text
      ^Z^Zsignal-name
      name
      ^Z^Zsignal-name-end
      middle-text
      ^Z^Zsignal-string
      string
      ^Z^Zsignal-string-end
      end-text

  where name is the name of the signal, such as `SIGILL` or `SIGSEGV`, and string is the explanation of the signal, such as `Illegal Instruction` or `Segmentation fault`. intro-text, middle-text, and end-text are for the user's benefit and have no particular format.

`^Z^Zsignal`
  The syntax of this annotation is just like `signalled`, but GDB is just saying that the program received the signal, not that it was terminated with it.
`^Z^Zbreakpoint number`
  The program hit breakpoint number number.
`^Z^Zwatchpoint number`
  The program hit watchpoint number number.

Node:Source Annotations, Next:TODO, Previous:Annotations for Running, Up:Annotations

## Displaying Source

The following annotation is used instead of displaying source code:

    ^Z^Zsource filename:line:character:middle:addr

where filename is an absolute file name indicating which source file, line is the line number within that file (where 1 is the first line in the file), character is the character position within the file (where 0 is the first character in the file) (for most debug formats this will necessarily point to the beginning of a line), middle is `middle` if addr is in the middle of the line, or `beg` if addr is at the beginning of the line, and addr is the address in the target program associated with the source which is being displayed. addr is in the form `0x` followed by one or more lowercase hex digits (note that this does not depend on the language).

Node:TODO, Previous:Source Annotations, Up:Annotations

## Annotations We Might Want in the Future

        - target-invalid
          the target might have changed (registers, heap contents, or
          execution status).  For performance, we might eventually want
          to hit `registers-invalid' and `all-registers-invalid' with
          greater precision

        - systematic annotation for set/show parameters (including
          invalidation notices).

        - similarly, `info' returns a list of candidates for invalidation
          notices.

Node:GDB/MI

# The GDB/MI Interface

## Function and Purpose

GDB/MI is a line based machine oriented text interface to GDB. 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 Compatibility with CLI:
- GDB/MI Output Records:
- GDB/MI Command Description Format:
- GDB/MI Breakpoint Table Commands:
- GDB/MI Data Manipulation:
- GDB/MI Program Control:
- GDB/MI Miscellaneous Commands:
- GDB/MI Stack Manipulation:
- GDB/MI Symbol Query:
- GDB/MI Target Manipulation:
- GDB/MI Thread Commands:
- GDB/MI Tracepoint Commands:
- GDB/MI Variable Objects:
- GDB/MI Draft Changes to Output Syntax:

Node:GDB/MI Command Syntax, Next:GDB/MI Compatibility with CLI, Up:GDB/MI

## GDB/MI Command Syntax

- GDB/MI Input Syntax:
- GDB/MI Output Syntax:
- GDB/MI Simple Examples:

Node:GDB/MI Input Syntax, Next:GDB/MI Output Syntax, Up: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 GDB 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 document
`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.

Node:GDB/MI Output Syntax, Next:GDB/MI Simple Examples, Previous:GDB/MI Input Syntax, Up:GDB/MI Command Syntax

### 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 `(gdb)`.

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 GDB'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.

Node:GDB/MI Simple Examples, Previous:GDB/MI Output Syntax, Up:GDB/MI Command 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
    <- (gdb)

and later:

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

#### 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
    <- (gdb)

#### Command With Side Effects

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

#### A Bad Command

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

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

Node:GDB/MI Compatibility with CLI, Next:GDB/MI Output Records, Previous:GDB/MI Command Syntax, Up:GDB/MI

## GDB/MI Compatibility with CLI

To help users familiar with GDB'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 GDB 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.

Node:GDB/MI Output Records, Next:GDB/MI Command Description Format, Previous:GDB/MI Compatibility with CLI, Up:GDB/MI

## GDB/MI Output Records

- GDB/MI Result Records:
- GDB/MI Stream Records:
- GDB/MI Out-of-band Records:

Node:GDB/MI Result Records, Next:GDB/MI Stream Records, Up: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` is the return value.
`"^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.

Node:GDB/MI Stream Records, Next:GDB/MI Out-of-band Records, Previous:GDB/MI Result Records, Up:GDB/MI Output Records

### GDB/MI Stream Records

GDB 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 GDB's internals.

Node:GDB/MI Out-of-band Records, Previous:GDB/MI Stream Records, Up:GDB/MI Output Records

### 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"`

Node:GDB/MI Command Description Format, Next:GDB/MI Breakpoint Table Commands, Previous:GDB/MI Output Records, Up:GDB/MI

## 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 chapter.

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...

#### GDB Command

The corresponding GDB CLI command.

#### Result

#### Out-of-band

#### Notes

#### Example

Node:GDB/MI Breakpoint Table Commands, Next:GDB/MI Data Manipulation, Previous:GDB/MI Command Description Format, Up:GDB/MI

## 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.

#### GDB Command

The corresponding GDB command is `ignore`.

#### Example

    (gdb)
    -break-insert main
    ^done,bkpt={number="1",addr="0x000100d0",file="hello.c",line="5"}
    (gdb)
    -break-after 1 3
    ~
    ^done
    (gdb)
    -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"}}
    (gdb)

### -break-condition

#### 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).

#### GDB Command

The corresponding GDB command is `condition`.

#### Example

    (gdb)
    -break-condition 1 1
    ^done
    (gdb)
    -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"}}
    (gdb)

### 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.

#### GDB command

The corresponding GDB command is `delete`.

#### Example

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

### 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).

#### GDB Command

The corresponding GDB command is `disable`.

#### Example

    (gdb)
    -break-disable 2
    ^done
    (gdb)
    -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"}}
    (gdb)

### The `-break-enable` Command

#### Synopsis

     -break-enable ( breakpoint )+

Enable (previously disabled) breakpoint(s).

#### GDB Command

The corresponding GDB command is `enable`.

#### Example

    (gdb)
    -break-enable 2
    ^done
    (gdb)
    -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"}}
    (gdb)

### The `-break-info` Command

#### Synopsis

     -break-info breakpoint

Get information about a single breakpoint.

#### GDB command

The corresponding GDB 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 GDB 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.

#### GDB Command

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

#### Example

    (gdb)
    -break-insert main
    ^done,bkpt={number="1",addr="0x0001072c",file="recursive2.c",line="4"}
    (gdb)
    -break-insert -t foo
    ^done,bkpt={number="2",addr="0x00010774",file="recursive2.c",line="11"}
    (gdb)
    -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"}}
    (gdb)
    -break-insert -r foo.*
    ~int foo(int, int);
    ^done,bkpt={number="3",addr="0x00010774",file="recursive2.c",line="11"}
    (gdb)

### 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.

#### GDB Command

The corresponding GDB command is `info break`.

#### Example

    (gdb)
    -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"}}
    (gdb)

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

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

### 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.

#### GDB Command

The corresponding GDB commands are `watch`, `awatch`, and `rwatch`.

#### Example

Setting a watchpoint on a variable in the `main` function:

    (gdb)
    -break-watch x
    ^done,wpt={number="2",exp="x"}
    (gdb)
    -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"}
    (gdb)

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

    (gdb)
    -break-watch C
    ^done,wpt={number="5",exp="C"}
    (gdb)
    -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"}
    (gdb)
    -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"}
    (gdb)

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

    (gdb)
    -break-watch C
    ^done,wpt={number="2",exp="C"}
    (gdb)
    -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"}}
    (gdb)
    -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"}
    (gdb)
    -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"}}
    (gdb)
    -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"}
    (gdb)
    -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"}}
    (gdb)

Node:GDB/MI Data Manipulation, Next:GDB/MI Program Control, Previous:GDB/MI Breakpoint Table Commands, Up:GDB/MI

## 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 two fields:

- Address
- Func-name
- Offset
- Instruction

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

#### GDB Command

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

#### Example

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

    (gdb)
    -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>"}}
    (gdb)

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 "}}
    (gdb)

Disassemble 3 instructions from the start of `main`:

    (gdb)
    -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"}}
    (gdb)

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

    (gdb)
    -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"}}}}
    (gdb)

### 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.

#### GDB Command

The corresponding GDB 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"
    (gdb)
    311-data-evaluate-expression &A
    311^done,value="0xefffeb7c"
    (gdb)
    411-data-evaluate-expression A+3
    411^done,value="4"
    (gdb)
    511-data-evaluate-expression "A + 3"
    511^done,value="4"
    (gdb)

### The `-data-list-changed-registers` Command

#### Synopsis

     -data-list-changed-registers

Display a list of the registers that have changed.

#### GDB Command

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

#### Example

On a PPC MBX board:

    (gdb)
    -exec-continue
    ^running

    (gdb)
    *stopped,reason="breakpoint-hit",bkptno="1",frame={func="main",
    args={},file="try.c",line="5"}
    (gdb)
    -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"}
    (gdb)

### 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.

#### GDB Command

GDB 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:

    (gdb)
    -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"}
    (gdb)
    -data-list-register-names 1 2 3
    ^done,register-names={"r1","r2","r3"}
    (gdb)

### 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

#### GDB Command

The corresponding GDB 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):

    (gdb)
    -data-list-register-values r 64 65
    ^done,register-values={{number="64",value="0xfe00a300"},
    {number="65",value="0x00029002"}}
    (gdb)
    -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"}}
    (gdb)

### 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 GDB'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 page or row is available in `next-row` and `prev-row`, `next-page` and `prev-page`.

#### GDB Command

The corresponding GDB command is `x`. `gdbtk` has `gdb_get_mem` memory read.

#### 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.

    (gdb)
    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"}}}
    (gdb)

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

    (gdb)
    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"}}}
    (gdb)

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.

    (gdb)
    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=",-./"}}
    (gdb)

### The `-display-delete` Command

#### Synopsis

     -display-delete number

Delete the display number.

#### GDB Command

The corresponding GDB command is `delete display`.

#### Example

N.A.

### The `-display-disable` Command

#### Synopsis

     -display-disable number

Disable display number.

#### GDB Command

The corresponding GDB command is `disable display`.

#### Example

N.A.

### The `-display-enable` Command

#### Synopsis

     -display-enable number

Enable display number.

#### GDB Command

The corresponding GDB command is `enable display`.

#### Example

N.A.

### The `-display-insert` Command

#### Synopsis

     -display-insert expression

Display expression every time the program stops.

#### GDB Command

The corresponding GDB command is `display`.

#### Example

N.A.

### The `-display-list` Command

#### Synopsis

     -display-list

List the displays. Do not show the current values.

#### GDB Command

The corresponding GDB command is `info display`.

#### Example

N.A.

### The `-environment-cd` Command

#### Synopsis

     -environment-cd pathdir

Set GDB's working directory.

#### GDB Command

The corresponding GDB command is `cd`.

#### Example

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

### The `-environment-directory` Command

#### Synopsis

     -environment-directory pathdir

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

#### GDB Command

The corresponding GDB command is `dir`.

#### Example

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

### The `-environment-path` Command

#### Synopsis

     -environment-path ( pathdir )+

Add directories to beginning of search path for object files.

#### GDB Command

The corresponding GDB command is `path`.

#### Example

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

### The `-environment-pwd` Command

#### Synopsis

     -environment-pwd

Show the current working directory.

#### GDB command

The corresponding GDB command is `pwd`.

#### Example

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

Node:GDB/MI Program Control, Next:GDB/MI Miscellaneous Commands, Previous:GDB/MI Data Manipulation, Up:GDB/MI

## GDB/MI Program control

#### Program termination

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

#### Examples:

Program exited normally:

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

Program exited exceptionally:

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

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

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

### The `-exec-abort` Command

#### Synopsis

     -exec-abort

Kill the inferior running program.

#### GDB Command

The corresponding GDB 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`.

#### GDB Command

The corresponding GDB 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.

#### GDB Command

The corresponding GDB corresponding is `continue`.

#### Example

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

### 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.

#### GDB Command

The corresponding GDB command is `finish`.

#### Example

Function returning `void`.

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

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

    -exec-finish
    ^running
    (gdb)
    *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"
    (gdb)

### 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.

#### GDB Command

The corresponding GDB command is `interrupt`.

#### Example

    (gdb)
    111-exec-continue
    111^running

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

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

### 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.

#### GDB Command

The corresponding GDB command is `next`.

#### Example

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

### 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.

#### GDB Command

The corresponding GDB command is `nexti`.

#### Example

    (gdb)
    -exec-next-instruction
    ^running

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

### The `-exec-return` Command

#### Synopsis

     -exec-return

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

#### GDB Command

The corresponding GDB command is `return`.

#### Example

    (gdb)
    200-break-insert callee4
    200^done,bkpt={number="1",addr="0x00010734",
    file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"}
    (gdb)
    000-exec-run
    000^running
    (gdb)
    000*stopped,reason="breakpoint-hit",bkptno="1",
    frame={func="callee4",args={},
    file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"}
    (gdb)
    205-break-delete
    205^done
    (gdb)
    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"}
    (gdb)

### 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.

#### GDB Command

The corresponding GDB command is `run`.

#### Example

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

### The `-exec-show-arguments` Command

#### Synopsis

     -exec-show-arguments

Print the arguments of the program.

#### GDB Command

The corresponding GDB 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.

#### GDB Command

The corresponding GDB command is `step`.

#### Example

Stepping into a function:

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

Regular stepping:

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

### The `-exec-step-instruction` Command

#### Synopsis

     -exec-step-instruction

Asynchronous command. Resumes the inferior which executes one machine instruction. The output, once GDB 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.

#### GDB Command

The corresponding GDB command is `stepi`.

#### Example

    (gdb)
    -exec-step-instruction
    ^running

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

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

### 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".

#### GDB Command

The corresponding GDB command is `until`.

#### Example

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

### 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, gdb will produce error messages. Otherwise, no output is produced, except a completion notification.

#### GDB Command

The corresponding GDB command is `file`.

#### Example

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

### 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, GDB clears the information about the executable file. No output is produced, except a completion notification.

#### GDB Command

The corresponding GDB command is `exec-file`.

#### Example

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

### The `-file-list-exec-sections` Command

#### Synopsis

     -file-list-exec-sections

List the sections of the current executable file.

#### GDB Command

The GDB 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.

#### GDB Command

There's no GDB 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.

#### GDB Command

The corresponding GDB command is `info shared`.

#### Example

N.A.

### The `-file-list-symbol-files` Command

#### Synopsis

     -file-list-symbol-files

List symbol files.

#### GDB Command

The corresponding GDB 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 GDB's symbol table info. No output is produced, except for a completion notification.

#### GDB Command

The corresponding GDB command is `symbol-file`.

#### Example

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

Node:GDB/MI Miscellaneous Commands, Next:GDB/MI Stack Manipulation, Previous:GDB/MI Program Control, Up:GDB/MI

## Miscellaneous GDB commands in GDB/MI

### The `-gdb-exit` Command

#### Synopsis

     -gdb-exit

Exit GDB immediately.

#### GDB Command

Approximately corresponds to `quit`.

#### Example

    (gdb)
    -gdb-exit

### The `-gdb-set` Command

#### Synopsis

     -gdb-set

Set an internal GDB variable.

#### GDB Command

The corresponding GDB command is `set`.

#### Example

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

### The `-gdb-show` Command

#### Synopsis

     -gdb-show

Show the current value of a GDB variable.

#### GDB command

The corresponding GDB command is `show`.

#### Example

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

### The `-gdb-version` Command

#### Synopsis

     -gdb-version

Show version information for GDB. Used mostly in testing.

#### GDB Command

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

#### Example

    (gdb)
    -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
    (gdb)

Node:GDB/MI Stack Manipulation, Next:GDB/MI Symbol Query, Previous:GDB/MI Miscellaneous Commands, Up:GDB/MI

## Stack manipulation commands in GDB/MI

### The `-stack-info-frame` Command

#### Synopsis

     -stack-info-frame

Get info on the current frame.

#### GDB Command

The corresponding GDB 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.

#### GDB Command

There's no equivalent GDB command.

#### Example

For a stack with frame levels 0 through 11:

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

### 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.

#### GDB Command

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

#### Example

    (gdb)
    -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"}}
    (gdb)
    -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={}}}
    (gdb)
    -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={}}}
    (gdb)
    -stack-list-arguments 0 2 2
    ^done,stack-args={frame={level="2",args={name="intarg",name="strarg"}}}
    (gdb)
    -stack-list-arguments 1 2 2
    ^done,stack-args={frame={level="2",
    args={{name="intarg",value="2"},
    {name="strarg",value="0x11940 \"A string argument.\""}}}}
    (gdb)

### 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.

#### GDB Command

The corresponding GDB commands are `backtrace` and `where`.

#### Example

Full stack backtrace:

    (gdb)
    -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"}}
    (gdb)

Show frames between low_frame and high_frame:

    (gdb)
    -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"}}
    (gdb)

Show a single frame:

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

### 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.

#### GDB Command

`info locals` in GDB, `gdb_get_locals` in `gdbtk`.

#### Example

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

### The `-stack-select-frame` Command

#### Synopsis

     -stack-select-frame framenum

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

#### GDB Command

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

#### Example

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

Node:GDB/MI Symbol Query, Next:GDB/MI Target Manipulation, Previous:GDB/MI Stack Manipulation, Up:GDB/MI

## GDB/MI Symbol Query Commands

### The `-symbol-info-address` Command

#### Synopsis

     -symbol-info-address symbol

Describe where symbol is stored.

#### GDB Command

The corresponding GDB command is `info address`.

#### Example

N.A.

### The `-symbol-info-file` Command

#### Synopsis

     -symbol-info-file

Show the file for the symbol.

#### GDB Command

There's no equivalent GDB command. `gdbtk` has `gdb_filnd_file`.

#### Example

N.A.

### The `-symbol-info-function` Command

#### Synopsis

     -symbol-info-function

Show which function the symbol lives in.

#### GDB 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.

#### GDB Command

The corresponding GDB comamnd is `info line`. `gdbtk` has the `gdb_get_line` `gdb_get_file` commands.

#### Example

N.A.

### The `-symbol-info-symbol` Command

#### Synopsis

     -symbol-info-symbol addr

Describe what symbol is at location addr.

#### GDB Command

The corresponding GDB command is `info symbol`.

#### Example

N.A.

### The `-symbol-list-functions` Command

#### Synopsis

     -symbol-list-functions

List the functions in the executable.

#### GDB Command

`info functions` in GDB, `gdb_listfunc` `gdb_search` in `gdbtk`.

#### Example

N.A.

### The `-symbol-list-types` Command

#### Synopsis

     -symbol-list-types

List all the type names.

#### GDB Command

The corresponding commands are `info types` in GDB, `gdb_search` in `gdbtk`.

#### Example

N.A.

### The `-symbol-list-variables` Command

#### Synopsis

     -symbol-list-variables

List all the global and static variable names.

#### GDB Command

`info variables` in GDB, `gdb_search` in `gdbtk`.

#### Example

N.A.

### The `-symbol-locate` Command

#### Synopsis

     -symbol-locate

#### GDB Command

`gdb_loc` in `gdbtk`.

#### Example

N.A.

### The `-symbol-type` Command

#### Synopsis

     -symbol-type variable

Show type of variable.

#### GDB Command

The corresponding GDB command is `ptype`, `gdbtk` has `gdb_obj_variable`.

#### Example

N.A.

Node:GDB/MI Target Manipulation, Next:GDB/MI Thread Commands, Previous:GDB/MI Symbol Query, Up:GDB/MI

## 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 GDB.

#### GDB command

The corresponding GDB 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.

#### GDB Command

The GDB equivalent is `compare-sections`.

#### Example

N.A.

### The `-target-detach` Command

#### Synopsis

     -target-detach

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

#### GDB command

The corresponding GDB command is `detach`.

#### Example

    (gdb)
    -target-detach
    ^done
    (gdb)

### 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.

#### GDB Command

The corresponding GDB 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.

    (gdb)
    -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"
    (gdb)

### 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).

#### GDB Command

There's no equivalent GDB command.

#### Example

N.A.

### The `-target-list-available-targets` Command

#### Synopsis

     -target-list-available-targets

List the possible targets to connect to.

#### GDB Command

The corresponding GDB command is `help target`.

#### Example

N.A.

### The `-target-list-current-targets` Command

#### Synopsis

     -target-list-current-targets

Describe the current target.

#### GDB Command

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

#### Example

N.A.

### The `-target-list-parameters` Command

#### Synopsis

     -target-list-parameters

#### GDB Command

No equivalent.

#### Example

N.A.

### The `-target-select` Command

#### Synopsis

     -target-select type parameters ...

Connect GDB 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}

#### GDB Command

The corresponding GDB command is `target`.

#### Example

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

Node:GDB/MI Thread Commands, Next:GDB/MI Tracepoint Commands, Previous:GDB/MI Target Manipulation, Up:GDB/MI

## GDB/MI Thread Commands

### The `-thread-info` Command

#### Synopsis

     -thread-info

#### GDB command

No equivalent.

#### Example

N.A.

### The `-thread-list-all-threads` Command

#### Synopsis

     -thread-list-all-threads

#### GDB Command

The equivalent GDB command is `info threads`.

#### Example

N.A.

### The `-thread-list-ids` Command

#### Synopsis

     -thread-list-ids

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

#### GDB Command

Part of `info threads` supplies the same information.

#### Example

No threads present, besides the main process.

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

Several threads.

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

### 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.

#### GDB Command

The corresponding GDB command is `thread`.

#### Example

    (gdb)
    -exec-next
    ^running
    (gdb)
    *stopped,reason="end-stepping-range",thread-id="2",line="187",
    file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
    (gdb)
    -thread-list-ids
    ^done,
    thread-ids={thread-id="3",thread-id="2",thread-id="1"},
    number-of-threads="3"
    (gdb)
    -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"}
    (gdb)

Node:GDB/MI Tracepoint Commands, Next:GDB/MI Variable Objects, Previous:GDB/MI Thread Commands, Up:GDB/MI

## GDB/MI Tracepoint Commands

The tracepoint commands are not yet implemented.

Node:GDB/MI Variable Objects, Next:GDB/MI Draft Changes to Output Syntax, Previous:GDB/MI Tracepoint Commands, Up:GDB/MI

## 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 flathead. This document describes the flathead 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 flathead 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 GDB 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 GDB 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.

Node:GDB/MI Draft Changes to Output Syntax, Previous:GDB/MI Variable Objects, Up:GDB/MI

## 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 "(gdb)".

Asynchronous GDB/MI output is similar.

Each output record directly associated with an input command is prefixed by the input commands `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 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 GDB's internals, for instance messages that should be displayed as part of an error log. All the log output is prefixed by the prefix "&".

Node:GDB Bugs, Next:Formatting Documentation, Previous:Annotations, Up:Top

# Reporting Bugs in GDB

Your bug reports play an essential role in making GDB reliable.

Reporting a bug may help you by bringing a solution to your problem, or it may not. But in any case the principal function of a bug report is to help the entire community by making the next version of GDB work better. Bug reports are your contribution to the maintenance of GDB.

In order for a bug report to serve its purpose, you must include the information that enables us to fix the bug.

- Bug Criteria: Have you found a bug?
- Bug Reporting: How to report bugs

Node:Bug Criteria, Next:Bug Reporting, Up:GDB Bugs

## Have you found a bug?

If you are not sure whether you have found a bug, here are some guidelines:

- If the debugger gets a fatal signal, for any input whatever, that is a GDB bug. Reliable debuggers never crash.
- If GDB produces an error message for valid input, that is a bug. (Note that if you're cross debugging, the problem may also be somewhere in the connection to the target.)
- If GDB does not produce an error message for invalid input, that is a bug. However, you should note that your idea of "invalid input" might be our idea of "an extension" or "support for traditional practice".
- If you are an experienced user of debugging tools, your suggestions for improvement of GDB are welcome in any case.

Node:Bug Reporting, Previous:Bug Criteria, Up:GDB Bugs

## How to report bugs

A number of companies and individuals offer support for GNU products. If you obtained GDB from a support organization, we recommend you contact that organization first.

You can find contact information for many support companies and individuals in the file `etc/SERVICE` in the GNU Emacs distribution.

In any event, we also recommend that you send bug reports for GDB to this addresses:

    bug-gdb@gnu.org

Do not send bug reports to `info-gdb`, or to `help-gdb`, or to any newsgroups. Most users of GDB do not want to receive bug reports. Those that do have arranged to receive `bug-gdb`.

The mailing list `bug-gdb` has a newsgroup `gnu.gdb.bug` which serves as a repeater. The mailing list and the newsgroup carry exactly the same messages. Often people think of posting bug reports to the newsgroup instead of mailing them. This appears to work, but it has one problem which can be crucial: a newsgroup posting often lacks a mail path back to the sender. Thus, if we need to ask for more information, we may be unable to reach you. For this reason, it is better to send bug reports to the mailing list.

As a last resort, send bug reports on paper to:

    GNU Debugger Bugs
    Free Software Foundation Inc.
    59 Temple Place - Suite 330
    Boston, MA 02111-1307
    USA

The fundamental principle of reporting bugs usefully is this: report all the facts. If you are not sure whether to state a fact or leave it out, state it!

Often people omit facts because they think they know what causes the problem and assume that some details do not matter. Thus, you might assume that the name of the variable you use in an example does not matter. Well, probably it does not, but one cannot be sure. Perhaps the bug is a stray memory reference which happens to fetch from the location where that name is stored in memory; perhaps, if the name were different, the contents of that location would fool the debugger into doing the right thing despite the bug. Play it safe and give a specific, complete example. That is the easiest thing for you to do, and the most helpful.

Keep in mind that the purpose of a bug report is to enable us to fix the bug. It may be that the bug has been reported previously, but neither you nor we can know that unless your bug report is complete and self-contained.

Sometimes people give a few sketchy facts and ask, "Does this ring a bell?" Those bug reports are useless, and we urge everyone to refuse to respond to them except to chide the sender to report bugs properly.

To enable us to fix the bug, you should include all these things:

- The version of GDB. GDB announces it if you start with no arguments; you can also print it at any time using `show version`.

  Without this, we will not know whether there is any point in looking for the bug in the current version of GDB.

- The type of machine you are using, and the operating system name and version number.
- What compiler (and its version) was used to compile GDB--e.g. "gcc-2.8.1".
- What compiler (and its version) was used to compile the program you are debugging--e.g. "gcc-2.8.1", or "HP92453-01 A.10.32.03 HP C Compiler". For GCC, you can say `gcc --version` to get this information; for other compilers, see the documentation for those compilers.
- The command arguments you gave the compiler to compile your example and observe the bug. For example, did you use `-O`? To guarantee you will not omit something important, list them all. A copy of the Makefile (or the output from make) is sufficient.

  If we were to try to guess the arguments, we would probably guess wrong and then we might not encounter the bug.

- A complete input script, and all necessary source files, that will reproduce the bug.
- A description of what behavior you observe that you believe is incorrect. For example, "It gets a fatal signal."

  Of course, if the bug is that GDB gets a fatal signal, then we will certainly notice it. But if the bug is incorrect output, we might not notice unless it is glaringly wrong. You might as well not give us a chance to make a mistake.

  Even if the problem you experience is a fatal signal, you should still say so explicitly. Suppose something strange is going on, such as, your copy of GDB is out of synch, or you have encountered a bug in the C library on your system. (This has happened!) Your copy might crash and ours would not. If you told us to expect a crash, then when ours fails to crash, we would know that the bug was not happening for us. If you had not told us to expect a crash, then we would not be able to draw any conclusion from our observations.

- If you wish to suggest changes to the GDB source, send us context diffs. If you even discuss something in the GDB source, refer to it by context, not by line number.

  The line numbers in our development sources will not match those in your sources. Your line numbers would convey no useful information to us.

Here are some things that are not necessary:

- A description of the envelope of the bug.

  Often people who encounter a bug spend a lot of time investigating which changes to the input file will make the bug go away and which changes will not affect it.

  This is often time consuming and not very useful, because the way we will find the bug is by running a single example under the debugger with breakpoints, not by pure deduction from a series of examples. We recommend that you save your time for something else.

  Of course, if you can find a simpler example to report instead of the original one, that is a convenience for us. Errors in the output will be easier to spot, running under the debugger will take less time, and so on.

  However, simplification is not vital; if you do not want to do this, report the bug anyway and send us the entire test case you used.

- A patch for the bug.

  A patch for the bug does help us if it is a good one. But do not omit the necessary information, such as the test case, on the assumption that a patch is all we need. We might see problems with your patch and decide to fix the problem another way, or we might not understand it at all.

  Sometimes with a program as complicated as GDB it is very hard to construct an example that will make the program follow a certain path through the code. If you do not send us the example, we will not be able to construct one, so we will not be able to verify that the bug is fixed.

  And if we cannot understand what bug you are trying to fix, or why your patch should be an improvement, we will not install it. A test case will help us to understand.

- A guess about what the bug is or what it depends on.

  Such guesses are usually wrong. Even we cannot guess right about such things without first using the debugger to find the facts.

Node:Command Line Editing, Next:Using History Interactively, Previous:Formatting Documentation, Up:Top

# Command Line Editing

This chapter describes the basic features of the GNU command line editing interface.

- Introduction and Notation: Notation used in this text.
- Readline Interaction: The minimum set of commands for editing a line.
- Readline Init File: Customizing Readline from a user's view.
- Bindable Readline Commands: A description of most of the Readline commands available for binding
- Readline vi Mode: A short description of how to make Readline behave like the vi editor.

Node:Introduction and Notation, Next:Readline Interaction, Up:Command Line Editing

## Introduction to Line Editing

The following paragraphs describe the notation used to represent keystrokes.

The text <C-k> is read as `Control-K' and describes the character produced when the <k> key is pressed while the Control key is depressed.

The text <M-k> is read as `Meta-K' and describes the character produced when the meta key (if you have one) is depressed, and the <k> key is pressed. If you do not have a meta key, the identical keystroke can be generated by typing <ESC> first, and then typing <k>. Either process is known as metafying the <k> key.

The text <M-C-k> is read as `Meta-Control-k' and describes the character produced by metafying <C-k>.

In addition, several keys have their own names. Specifically, <DEL>, <ESC>, <LFD>, <SPC>, <RET>, and <TAB> all stand for themselves when seen in this text, or in an init file (see Readline Init File).

Node:Readline Interaction, Next:Readline Init File, Previous:Introduction and Notation, Up:Command Line Editing

## Readline Interaction

Often during an interactive session you type in a long line of text, only to notice that the first word on the line is misspelled. The Readline library gives you a set of commands for manipulating the text as you type it in, allowing you to just fix your typo, and not forcing you to retype the majority of the line. Using these editing commands, you move the cursor to the place that needs correction, and delete or insert the text of the corrections. Then, when you are satisfied with the line, you simply press <RETURN>. You do not have to be at the end of the line to press <RETURN>; the entire line is accepted regardless of the location of the cursor within the line.

- Readline Bare Essentials: The least you need to know about Readline.
- Readline Movement Commands: Moving about the input line.
- Readline Killing Commands: How to delete text, and how to get it back!
- Readline Arguments: Giving numeric arguments to commands.
- Searching: Searching through previous lines.

Node:Readline Bare Essentials, Next:Readline Movement Commands, Up:Readline Interaction

### Readline Bare Essentials

In order to enter characters into the line, simply type them. The typed character appears where the cursor was, and then the cursor moves one space to the right. If you mistype a character, you can use your erase character to back up and delete the mistyped character.

Sometimes you may miss typing a character that you wanted to type, and not notice your error until you have typed several other characters. In that case, you can type <C-b> to move the cursor to the left, and then correct your mistake. Afterwards, you can move the cursor to the right with <C-f>.

When you add text in the middle of a line, you will notice that characters to the right of the cursor are `pushed over' to make room for the text that you have inserted. Likewise, when you delete text behind the cursor, characters to the right of the cursor are `pulled back' to fill in the blank space created by the removal of the text. A list of the basic bare essentials for editing the text of an input line follows.

<C-b>
  Move back one character.
<C-f>
  Move forward one character.
<DEL>
  Delete the character to the left of the cursor.
<C-d>
  Delete the character underneath the cursor.
Printing characters
  Insert the character into the line at the cursor.
<C-_>
  Undo the last editing command. You can undo all the way back to an empty line.

Node:Readline Movement Commands, Next:Readline Killing Commands, Previous:Readline Bare Essentials, Up:Readline Interaction

### Readline Movement Commands

The above table describes the most basic possible keystrokes that you need in order to do editing of the input line. For your convenience, many other commands have been added in addition to <C-b>, <C-f>, <C-d>, and <DEL>. Here are some commands for moving more rapidly about the line.

<C-a>
  Move to the start of the line.
<C-e>
  Move to the end of the line.
<M-f>
  Move forward a word, where a word is composed of letters and digits.
<M-b>
  Move backward a word.
<C-l>
  Clear the screen, reprinting the current line at the top.

Notice how <C-f> moves forward a character, while <M-f> moves forward a word. It is a loose convention that control keystrokes operate on characters while meta keystrokes operate on words.

Node:Readline Killing Commands, Next:Readline Arguments, Previous:Readline Movement Commands, Up:Readline Interaction

### Readline Killing Commands

Killing text means to delete the text from the line, but to save it away for later use, usually by yanking (re-inserting) it back into the line. If the description for a command says that it `kills' text, then you can be sure that you can get the text back in a different (or the same) place later.

When you use a kill command, the text is saved in a kill-ring. Any number of consecutive kills save all of the killed text together, so that when you yank it back, you get it all. The kill ring is not line specific; the text that you killed on a previously typed line is available to be yanked back later, when you are typing another line.

Here is the list of commands for killing text.

<C-k>
  Kill the text from the current cursor position to the end of the line.
<M-d>
  Kill from the cursor to the end of the current word, or if between words, to the end of the next word.
<M-DEL>
  Kill from the cursor the start of the previous word, or if between words, to the start of the previous word.
<C-w>
  Kill from the cursor to the previous whitespace. This is different than <M-DEL> because the word boundaries differ.

Here is how to yank the text back into the line. Yanking means to copy the most-recently-killed text from the kill buffer.

<C-y>
  Yank the most recently killed text back into the buffer at the cursor.
<M-y>
  Rotate the kill-ring, and yank the new top. You can only do this if the prior command is <C-y> or <M-y>.

Node:Readline Arguments, Next:Searching, Previous:Readline Killing Commands, Up:Readline Interaction

### Readline Arguments

You can pass numeric arguments to Readline commands. Sometimes the argument acts as a repeat count, other times it is the sign of the argument that is significant. If you pass a negative argument to a command which normally acts in a forward direction, that command will act in a backward direction. For example, to kill text back to the start of the line, you might type `M-- C-k`.

The general way to pass numeric arguments to a command is to type meta digits before the command. If the first `digit' typed is a minus sign (<->), then the sign of the argument will be negative. Once you have typed one meta digit to get the argument started, you can type the remainder of the digits, and then the command. For example, to give the <C-d> command an argument of 10, you could type `M-1 0 C-d`.

Node:Searching, Previous:Readline Arguments, Up:Readline Interaction

### Searching for Commands in the History

Readline provides commands for searching through the command history for lines containing a specified string. There are two search modes: incremental and non-incremental.

Incremental searches begin before the user has finished typing the search string. As each character of the search string is typed, Readline displays the next entry from the history matching the string typed so far. An incremental search requires only as many characters as needed to find the desired history entry. The characters present in the value of the isearch-terminators variable are used to terminate an incremental search. If that variable has not been assigned a value, the <ESC> and <C-J> characters will terminate an incremental search. <C-g> will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line. To find other matching entries in the history list, type <C-s> or <C-r> as appropriate. This will search backward or forward in the history for the next entry matching the search string typed so far. Any other key sequence bound to a Readline command will terminate the search and execute that command. For instance, a <RET> will terminate the search and accept the line, thereby executing the command from the history list.

Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be typed by the user or be part of the contents of the current line.

Node:Readline Init File, Next:Bindable Readline Commands, Previous:Readline Interaction, Up:Command Line Editing

## Readline Init File

Although the Readline library comes with a set of `emacs`-like keybindings installed by default, it is possible to use a different set of keybindings. Any user can customize programs that use Readline by putting commands in an inputrc file in his home directory. The name of this file is taken from the value of the environment variable `INPUTRC`. If that variable is unset, the default is `~/.inputrc`.

When a program which uses the Readline library starts up, the init file is read, and the key bindings are set.

In addition, the `C-x C-r` command re-reads this init file, thus incorporating any changes that you might have made to it.

- Readline Init File Syntax: Syntax for the commands in the inputrc file.

- Conditional Init Constructs: Conditional key bindings in the inputrc file.

- Sample Init File: An example inputrc file.

Node:Readline Init File Syntax, Next:Conditional Init Constructs, Up:Readline Init File

### Readline Init File Syntax

There are only a few basic constructs allowed in the Readline init file. Blank lines are ignored. Lines beginning with a `#` are comments. Lines beginning with a `$` indicate conditional constructs (see Conditional Init Constructs). Other lines denote variable settings and key bindings.

Variable Settings
  You can modify the run-time behavior of Readline by altering the values of variables in Readline using the `set` command within the init file. Here is how to change from the default Emacs-like key binding to use `vi` line editing commands:

      set editing-mode vi

  A great deal of run-time behavior is changeable with the following variables.

  `bell-style`
    Controls what happens when Readline wants to ring the terminal bell. If set to `none`, Readline never rings the bell. If set to `visible`, Readline uses a visible bell if one is available. If set to `audible` (the default), Readline attempts to ring the terminal's bell.
  `comment-begin`
    The string to insert at the beginning of the line when the `insert-comment` command is executed. The default value is `"#"`.
  `completion-ignore-case`
    If set to `on`, Readline performs filename matching and completion in a case-insensitive fashion. The default value is `off`.
  `completion-query-items`
    The number of possible completions that determines when the user is asked whether he wants to see the list of possibilities. If the number of possible completions is greater than this value, Readline will ask the user whether or not he wishes to view them; otherwise, they are simply listed. The default limit is `100`.
  `convert-meta`
    If set to `on`, Readline will convert characters with the eighth bit set to an ASCII key sequence by stripping the eighth bit and prepending an <ESC> character, converting them to a meta-prefixed key sequence. The default value is `on`.
  `disable-completion`
    If set to `On`, Readline will inhibit word completion. Completion characters will be inserted into the line as if they had been mapped to `self-insert`. The default is `off`.
  `editing-mode`
    The `editing-mode` variable controls which default set of key bindings is used. By default, Readline starts up in Emacs editing mode, where the keystrokes are most similar to Emacs. This variable can be set to either `emacs` or `vi`.
  `enable-keypad`
    When set to `on`, Readline will try to enable the application keypad when it is called. Some systems need this to enable the arrow keys. The default is `off`.
  `expand-tilde`
    If set to `on`, tilde expansion is performed when Readline attempts word completion. The default is `off`.
  `horizontal-scroll-mode`
    This variable can be set to either `on` or `off`. Setting it to `on` means that the text of the lines being edited will scroll horizontally on a single screen line when they are longer than the width of the screen, instead of wrapping onto a new screen line. By default, this variable is set to `off`.
  `input-meta`
    If set to `on`, Readline will enable eight-bit input (it will not strip the eighth bit from the characters it reads), regardless of what the terminal claims it can support. The default value is `off`. The name `meta-flag` is a synonym for this variable.
  `isearch-terminators`
    The string of characters that should terminate an incremental search without subsequently executing the character as a command (see Searching). If this variable has not been given a value, the characters <ESC> and <C-J> will terminate an incremental search.
  `keymap`
    Sets Readline's idea of the current keymap for key binding commands. Acceptable `keymap` names are `emacs`, `emacs-standard`, `emacs-meta`, `emacs-ctlx`, `vi`, `vi-command`, and `vi-insert`. `vi` is equivalent to `vi-command`; `emacs` is equivalent to `emacs-standard`. The default value is `emacs`. The value of the `editing-mode` variable also affects the default keymap.
  `mark-directories`
    If set to `on`, completed directory names have a slash appended. The default is `on`.
  `mark-modified-lines`
    This variable, when set to `on`, causes Readline to display an asterisk (`*`) at the start of history lines which have been modified. This variable is `off` by default.
  `output-meta`
    If set to `on`, Readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. The default is `off`.
  `print-completions-horizontally`
    If set to `on`, Readline will display completions with matches sorted horizontally in alphabetical order, rather than down the screen. The default is `off`.
  `show-all-if-ambiguous`
    This alters the default behavior of the completion functions. If set to `on`, words which have more than one possible completion cause the matches to be listed immediately instead of ringing the bell. The default value is `off`.
  `visible-stats`
    If set to `on`, a character denoting a file's type is appended to the filename when listing possible completions. The default is `off`.
Key Bindings
  The syntax for controlling key bindings in the init file is simple. First you have to know the name of the command that you want to change. The following sections contain tables of the command name, the default keybinding, if any, and a short description of what the command does.

  Once you know the name of the command, simply place the name of the key you wish to bind the command to, a colon, and then the name of the command on a line in the init file. The name of the key can be expressed in different ways, depending on which is most comfortable for you.

  keyname: function-name or macro
    keyname is the name of a key spelled out in English. For example:

        Control-u: universal-argument
        Meta-Rubout: backward-kill-word
        Control-o: "> output"

    In the above example, <C-u> is bound to the function `universal-argument`, and <C-o> is bound to run the macro expressed on the right hand side (that is, to insert the text `> output` into the line).

  "keyseq": function-name or macro
    keyseq differs from keyname above in that strings denoting an entire key sequence can be specified, by placing the key sequence in double quotes. Some GNU Emacs style key escapes can be used, as in the following example, but the special character names are not recognized.

        "\C-u": universal-argument
        "\C-x\C-r": re-read-init-file
        "\e[11~": "Function Key 1"

    In the above example, <C-u> is bound to the function `universal-argument` (just as it was in the first example), `<C-x> <C-r>` is bound to the function `re-read-init-file`, and `<ESC> <[> <1> <1> <~>` is bound to insert the text `Function Key 1`.

  The following GNU Emacs style escape sequences are available when specifying key sequences:

  ``\C-``
    control prefix
  ``\M-``
    meta prefix
  ``\e``
    an escape character
  ``\\``
    backslash
  ``\"``
    <">
  ``\'``
    <'>

  In addition to the GNU Emacs style escape sequences, a second set of backslash escapes is available:

  `\a`
    alert (bell)
  `\b`
    backspace
  `\d`
    delete
  `\f`
    form feed
  `\n`
    newline
  `\r`
    carriage return
  `\t`
    horizontal tab
  `\v`
    vertical tab
  `\nnn`
    the character whose ASCII code is the octal value nnn (one to three digits)
  `\xnnn`
    the character whose ASCII code is the hexadecimal value nnn (one to three digits)

  When entering the text of a macro, single or double quotes must be used to indicate a macro definition. Unquoted text is assumed to be a function name. In the macro body, the backslash escapes described above are expanded. Backslash will quote any other character in the macro text, including `"` and `'`. For example, the following binding will make `C-x \` insert a single `\` into the line:

      "\C-x\\": "\\"

Node:Conditional Init Constructs, Next:Sample Init File, Previous:Readline Init File Syntax, Up:Readline Init File

### Conditional Init Constructs

Readline implements a facility similar in spirit to the conditional compilation features of the C preprocessor which allows key bindings and variable settings to be performed as the result of tests. There are four parser directives used.

`$if`
  The `$if` construct allows bindings to be made based on the editing mode, the terminal being used, or the application using Readline. The text of the test extends to the end of the line; no characters are required to isolate it.
  `mode`
    The `mode=` form of the `$if` directive is used to test whether Readline is in `emacs` or `vi` mode. This may be used in conjunction with the `set keymap` command, for instance, to set bindings in the `emacs-standard` and `emacs-ctlx` keymaps only if Readline is starting out in `emacs` mode.
  `term`
    The `term=` form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal's function keys. The word on the right side of the `=` is tested against both the full name of the terminal and the portion of the terminal name before the first `-`. This allows `sun` to match both `sun` and `sun-cmd`, for instance.
  `application`
    The application construct is used to include application-specific settings. Each program using the Readline library sets the application name, and you can test for it. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in Bash:

        $if Bash
        # Quote the current or previous word
        "\C-xq": "\eb\"\ef\""
        $endif

`$endif`
  This command, as seen in the previous example, terminates an `$if` command.
`$else`
  Commands in this branch of the `$if` directive are executed if the test fails.
`$include`
  This directive takes a single filename as an argument and reads commands and bindings from that file.

      $include /etc/inputrc

Node:Sample Init File, Previous:Conditional Init Constructs, Up:Readline Init File

### Sample Init File

Here is an example of an inputrc file. This illustrates key binding, variable assignment, and conditional syntax.

    # This file controls the behaviour of line input editing for
    # programs that use the Gnu Readline library.  Existing programs
    # include FTP, Bash, and Gdb.
    #
    # You can re-read the inputrc file with C-x C-r.
    # Lines beginning with '#' are comments.
    #
    # First, include any systemwide bindings and variable assignments from
    # /etc/Inputrc
    $include /etc/Inputrc

    #
    # Set various bindings for emacs mode.

    set editing-mode emacs

    $if mode=emacs

    Meta-Control-h:	backward-kill-word	Text after the function name is ignored

    #
    # Arrow keys in keypad mode
    #
    #"\M-OD":        backward-char
    #"\M-OC":        forward-char
    #"\M-OA":        previous-history
    #"\M-OB":        next-history
    #
    # Arrow keys in ANSI mode
    #
    "\M-[D":        backward-char
    "\M-[C":        forward-char
    "\M-[A":        previous-history
    "\M-[B":        next-history
    #
    # Arrow keys in 8 bit keypad mode
    #
    #"\M-\C-OD":       backward-char
    #"\M-\C-OC":       forward-char
    #"\M-\C-OA":       previous-history
    #"\M-\C-OB":       next-history
    #
    # Arrow keys in 8 bit ANSI mode
    #
    #"\M-\C-[D":       backward-char
    #"\M-\C-[C":       forward-char
    #"\M-\C-[A":       previous-history
    #"\M-\C-[B":       next-history

    C-q: quoted-insert

    $endif

    # An old-style binding.  This happens to be the default.
    TAB: complete

    # Macros that are convenient for shell interaction
    $if Bash
    # edit the path
    "\C-xp": "PATH=${PATH}\e\C-e\C-a\ef\C-f"
    # prepare to type a quoted word -- insert open and close double quotes
    # and move to just after the open quote
    "\C-x\"": "\"\"\C-b"
    # insert a backslash (testing backslash escapes in sequences and macros)
    "\C-x\\": "\\"
    # Quote the current or previous word
    "\C-xq": "\eb\"\ef\""
    # Add a binding to refresh the line, which is unbound
    "\C-xr": redraw-current-line
    # Edit variable on current line.
    "\M-\C-v": "\C-a\C-k$\C-y\M-\C-e\C-a\C-y="
    $endif

    # use a visible bell if one is available
    set bell-style visible

    # don't strip characters to 7 bits when reading
    set input-meta on

    # allow iso-latin1 characters to be inserted rather than converted to
    # prefix-meta sequences
    set convert-meta off

    # display characters with the eighth bit set directly rather than
    # as meta-prefixed characters
    set output-meta on

    # if there are more than 150 possible completions for a word, ask the
    # user if he wants to see all of them
    set completion-query-items 150

    # For FTP
    $if Ftp
    "\C-xg": "get \M-?"
    "\C-xt": "put \M-?"
    "\M-.": yank-last-arg
    $endif

Node:Bindable Readline Commands, Next:Readline vi Mode, Previous:Readline Init File, Up:Command Line Editing

## Bindable Readline Commands

- Commands For Moving: Moving about the line.
- Commands For History: Getting at previous lines.
- Commands For Text: Commands for changing text.
- Commands For Killing: Commands for killing and yanking.
- Numeric Arguments: Specifying numeric arguments, repeat counts.
- Commands For Completion: Getting Readline to do the typing for you.
- Keyboard Macros: Saving and re-executing typed characters
- Miscellaneous Commands: Other miscellaneous commands.

This section describes Readline commands that may be bound to key sequences.

Node:Commands For Moving, Next:Commands For History, Up:Bindable Readline Commands

### Commands For Moving

`beginning-of-line (C-a)`
  Move to the start of the current line.
`end-of-line (C-e)`
  Move to the end of the line.
`forward-char (C-f)`
  Move forward a character.
`backward-char (C-b)`
  Move back a character.
`forward-word (M-f)`
  Move forward to the end of the next word. Words are composed of letters and digits.
`backward-word (M-b)`
  Move back to the start of this, or the previous, word. Words are composed of letters and digits.
`clear-screen (C-l)`
  Clear the screen and redraw the current line, leaving the current line at the top of the screen.
`redraw-current-line ()`
  Refresh the current line. By default, this is unbound.

Node:Commands For History, Next:Commands For Text, Previous:Commands For Moving, Up:Bindable Readline Commands

### Commands For Manipulating The History

`accept-line (Newline, Return)`
  Accept the line regardless of where the cursor is. If this line is non-empty, add it to the history list. If this line was a history line, then restore the history line to its original state.
`previous-history (C-p)`
  Move `up' through the history list.
`next-history (C-n)`
  Move `down' through the history list.
`beginning-of-history (M-<)`
  Move to the first line in the history.
`end-of-history (M->)`
  Move to the end of the input history, i.e., the line currently being entered.
`reverse-search-history (C-r)`
  Search backward starting at the current line and moving `up' through the history as necessary. This is an incremental search.
`forward-search-history (C-s)`
  Search forward starting at the current line and moving `down' through the the history as necessary. This is an incremental search.
`non-incremental-reverse-search-history (M-p)`
  Search backward starting at the current line and moving `up' through the history as necessary using a non-incremental search for a string supplied by the user.
`non-incremental-forward-search-history (M-n)`
  Search forward starting at the current line and moving `down' through the the history as necessary using a non-incremental search for a string supplied by the user.
`history-search-forward ()`
  Search forward through the history for the string of characters between the start of the current line and the current cursor position (the point). This is a non-incremental search. By default, this command is unbound.
`history-search-backward ()`
  Search backward through the history for the string of characters between the start of the current line and the point. This is a non-incremental search. By default, this command is unbound.
`yank-nth-arg (M-C-y)`
  Insert the first argument to the previous command (usually the second word on the previous line). With an argument n, insert the nth word from the previous command (the words in the previous command begin with word 0). A negative argument inserts the nth word from the end of the previous command.
`yank-last-arg (M-., M-_)`
  Insert last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like `yank-nth-arg`. Successive calls to `yank-last-arg` move back through the history list, inserting the last argument of each line in turn.

Node:Commands For Text, Next:Commands For Killing, Previous:Commands For History, Up:Bindable Readline Commands

### Commands For Changing Text

`delete-char (C-d)`
  Delete the character under the cursor. If the cursor is at the beginning of the line, there are no characters in the line, and the last character typed was not bound to `delete-char`, then return `EOF`.
`backward-delete-char (Rubout)`
  Delete the character behind the cursor. A numeric argument means to kill the characters instead of deleting them.
`forward-backward-delete-char ()`
  Delete the character under the cursor, unless the cursor is at the end of the line, in which case the character behind the cursor is deleted. By default, this is not bound to a key.
`quoted-insert (C-q, C-v)`
  Add the next character typed to the line verbatim. This is how to insert key sequences like <C-q>, for example.
`tab-insert (M-TAB)`
  Insert a tab character.
`self-insert (a, b, A, 1, !, ...)`
  Insert yourself.
`transpose-chars (C-t)`
  Drag the character before the cursor forward over the character at the cursor, moving the cursor forward as well. If the insertion point is at the end of the line, then this transposes the last two characters of the line. Negative arguments don't work.
`transpose-words (M-t)`
  Drag the word behind the cursor past the word in front of the cursor moving the cursor over that word as well.
`upcase-word (M-u)`
  Uppercase the current (or following) word. With a negative argument, uppercase the previous word, but do not move the cursor.
`downcase-word (M-l)`
  Lowercase the current (or following) word. With a negative argument, lowercase the previous word, but do not move the cursor.
`capitalize-word (M-c)`
  Capitalize the current (or following) word. With a negative argument, capitalize the previous word, but do not move the cursor.

Node:Commands For Killing, Next:Numeric Arguments, Previous:Commands For Text, Up:Bindable Readline Commands

### Killing And Yanking

`kill-line (C-k)`
  Kill the text from the current cursor position to the end of the line.
`backward-kill-line (C-x Rubout)`
  Kill backward to the beginning of the line.
`unix-line-discard (C-u)`
  Kill backward from the cursor to the beginning of the current line. The killed text is saved on the kill-ring.
`kill-whole-line ()`
  Kill all characters on the current line, no matter where the cursor is. By default, this is unbound.
`kill-word (M-d)`
  Kill from the cursor to the end of the current word, or if between words, to the end of the next word. Word boundaries are the same as `forward-word`.
`backward-kill-word (M-DEL)`
  Kill the word behind the cursor. Word boundaries are the same as `backward-word`.
`unix-word-rubout (C-w)`
  Kill the word behind the cursor, using white space as a word boundary. The killed text is saved on the kill-ring.
`delete-horizontal-space ()`
  Delete all spaces and tabs around point. By default, this is unbound.
`kill-region ()`
  Kill the text between the point and the mark (saved cursor position). This text is referred to as the region. By default, this command is unbound.
`copy-region-as-kill ()`
  Copy the text in the region to the kill buffer, so it can be yanked right away. By default, this command is unbound.
`copy-backward-word ()`
  Copy the word before point to the kill buffer. The word boundaries are the same as `backward-word`. By default, this command is unbound.
`copy-forward-word ()`
  Copy the word following point to the kill buffer. The word boundaries are the same as `forward-word`. By default, this command is unbound.
`yank (C-y)`
  Yank the top of the kill ring into the buffer at the current cursor position.
`yank-pop (M-y)`
  Rotate the kill-ring, and yank the new top. You can only do this if the prior command is yank or yank-pop.

Node:Numeric Arguments, Next:Commands For Completion, Previous:Commands For Killing, Up:Bindable Readline Commands

### Specifying Numeric Arguments

`digit-argument (M-0, M-1, ... M--)`
  Add this digit to the argument already accumulating, or start a new argument. <M-> starts a negative argument.
`universal-argument ()`
  This is another way to specify an argument. If this command is followed by one or more digits, optionally with a leading minus sign, those digits define the argument. If the command is followed by digits, executing `universal-argument` again ends the numeric argument, but is otherwise ignored. As a special case, if this command is immediately followed by a character that is neither a digit or minus sign, the argument count for the next command is multiplied by four. The argument count is initially one, so executing this function the first time makes the argument count four, a second time makes the argument count sixteen, and so on. By default, this is not bound to a key.

Node:Commands For Completion, Next:Keyboard Macros, Previous:Numeric Arguments, Up:Bindable Readline Commands

### Letting Readline Type For You

`complete (TAB)`
  Attempt to do completion on the text before the cursor. This is application-specific. Generally, if you are typing a filename argument, you can do filename completion; if you are typing a command, you can do command completion; if you are typing in a symbol to GDB, you can do symbol name completion; if you are typing in a variable to Bash, you can do variable name completion, and so on.
`possible-completions (M-?)`
  List the possible completions of the text before the cursor.
`insert-completions (M-*)`
  Insert all completions of the text before point that would have been generated by `possible-completions`.
`menu-complete ()`
  Similar to `complete`, but replaces the word to be completed with a single match from the list of possible completions. Repeated execution of `menu-complete` steps through the list of possible completions, inserting each match in turn. At the end of the list of completions, the bell is rung and the original text is restored. An argument of n moves n positions forward in the list of matches; a negative argument may be used to move backward through the list. This command is intended to be bound to `TAB`, but is unbound by default.
`delete-char-or-list ()`
  Deletes the character under the cursor if not at the beginning or end of the line (like `delete-char`). If at the end of the line, behaves identically to `possible-completions`. This command is unbound by default.

Node:Keyboard Macros, Next:Miscellaneous Commands, Previous:Commands For Completion, Up:Bindable Readline Commands

### Keyboard Macros

`start-kbd-macro (C-x ()`
  Begin saving the characters typed into the current keyboard macro.
`end-kbd-macro (C-x ))`
  Stop saving the characters typed into the current keyboard macro and save the definition.
`call-last-kbd-macro (C-x e)`
  Re-execute the last keyboard macro defined, by making the characters in the macro appear as if typed at the keyboard.

Node:Miscellaneous Commands, Previous:Keyboard Macros, Up:Bindable Readline Commands

### Some Miscellaneous Commands

`re-read-init-file (C-x C-r)`
  Read in the contents of the inputrc file, and incorporate any bindings or variable assignments found there.
`abort (C-g)`
  Abort the current editing command and ring the terminal's bell (subject to the setting of `bell-style`).
`do-uppercase-version (M-a, M-b, M-x, ...)`
  If the metafied character x is lowercase, run the command that is bound to the corresponding uppercase character.
`prefix-meta (ESC)`
  Make the next character typed be metafied. This is for keyboards without a meta key. Typing `ESC f` is equivalent to typing `M-f`.
`undo (C-_, C-x C-u)`
  Incremental undo, separately remembered for each line.
`revert-line (M-r)`
  Undo all changes made to this line. This is like executing the `undo` command enough times to get back to the beginning.
`tilde-expand (M-~)`
  Perform tilde expansion on the current word.
`set-mark (C-@)`
  Set the mark to the current point. If a numeric argument is supplied, the mark is set to that position.
`exchange-point-and-mark (C-x C-x)`
  Swap the point with the mark. The current cursor position is set to the saved position, and the old cursor position is saved as the mark.
`character-search (C-])`
  A character is read and point is moved to the next occurrence of that character. A negative count searches for previous occurrences.
`character-search-backward (M-C-])`
  A character is read and point is moved to the previous occurrence of that character. A negative count searches for subsequent occurrences.
`insert-comment (M-#)`
  The value of the `comment-begin` variable is inserted at the beginning of the current line, and the line is accepted as if a newline had been typed.
`dump-functions ()`
  Print all of the functions and their key bindings to the Readline output stream. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an inputrc file. This command is unbound by default.
`dump-variables ()`
  Print all of the settable variables and their values to the Readline output stream. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an inputrc file. This command is unbound by default.
`dump-macros ()`
  Print all of the Readline key sequences bound to macros and the strings they ouput. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an inputrc file. This command is unbound by default.

Node:Readline vi Mode, Previous:Bindable Readline Commands, Up:Command Line Editing

## Readline vi Mode

While the Readline library does not have a full set of `vi` editing functions, it does contain enough to allow simple editing of the line. The Readline `vi` mode behaves as specified in the POSIX 1003.2 standard.

In order to switch interactively between `emacs` and `vi` editing modes, use the command M-C-j (toggle-editing-mode). The Readline default is `emacs` mode.

When you enter a line in `vi` mode, you are already placed in `insertion' mode, as if you had typed an `i`. Pressing <ESC> switches you into `command' mode, where you can edit the text of the line with the standard `vi` movement keys, move to previous history lines with `k` and subsequent lines with `j`, and so forth.

Node:Using History Interactively, Next:Installing GDB, Previous:Command Line Editing, Up:Top

# Using History Interactively

This chapter describes how to use the GNU History Library interactively, from a user's standpoint. It should be considered a user's guide.

- History Interaction: What it feels like using History as a user.

Node:History Interaction, Up:Using History Interactively

## History Expansion

The History library provides a history expansion feature that is similar to the history expansion provided by `csh`. This section describes the syntax used to manipulate the history information.

History expansions introduce words from the history list into the input stream, making it easy to repeat commands, insert the arguments to a previous command into the current input line, or fix errors in previous commands quickly.

History expansion takes place in two parts. The first is to determine which line from the history list should be used during substitution. The second is to select portions of that line for inclusion into the current one. The line selected from the history is called the event, and the portions of that line that are acted upon are called words. Various modifiers are available to manipulate the selected words. The line is broken into words in the same fashion that Bash does, so that several words surrounded by quotes are considered one word. History expansions are introduced by the appearance of the history expansion character, which is `!` by default.

- Event Designators: How to specify which history line to use.
- Word Designators: Specifying which words are of interest.
- Modifiers: Modifying the results of substitution.

Node:Event Designators, Next:Word Designators, Up:History Interaction

### Event Designators

An event designator is a reference to a command line entry in the history list.

`!`
  Start a history substitution, except when followed by a space, tab, the end of the line, `=` or `(`.
`!n`
  Refer to command line n.
`!-n`
  Refer to the command n lines back.
`!!`
  Refer to the previous command. This is a synonym for `!-1`.
`!string`
  Refer to the most recent command starting with string.
`!?string[?]`
  Refer to the most recent command containing string. The trailing `?` may be omitted if the string is followed immediately by a newline.
`^string1^string2^`
  Quick Substitution. Repeat the last command, replacing string1 with string2. Equivalent to `!!:s/string1/string2/`.
`!#`
  The entire command line typed so far.

Node:Word Designators, Next:Modifiers, Previous:Event Designators, Up:History Interaction

### Word Designators

Word designators are used to select desired words from the event. A `:` separates the event specification from the word designator. It may be omitted if the word designator begins with a `^`, `$`, `*`, `-`, or `%`. Words are numbered from the beginning of the line, with the first word being denoted by 0 (zero). Words are inserted into the current line separated by single spaces.

`0 (zero)`
  The `0`th word. For many applications, this is the command word.
`n`
  The nth word.
`^`
  The first argument; that is, word 1.
`$`
  The last argument.
`%`
  The word matched by the most recent `?string?` search.
`x-y`
  A range of words; `-y` abbreviates `0-y`.
`*`
  All of the words, except the `0`th. This is a synonym for `1-$`. It is not an error to use `*` if there is just one word in the event; the empty string is returned in that case.
`x*`
  Abbreviates `x-$`
`x-`
  Abbreviates `x-$` like `x*`, but omits the last word.

If a word designator is supplied without an event specification, the previous command is used as the event.

Node:Modifiers, Previous:Word Designators, Up:History Interaction

### Modifiers

After the optional word designator, you can add a sequence of one or more of the following modifiers, each preceded by a `:`.

`h`
  Remove a trailing pathname component, leaving only the head.
`t`
  Remove all leading pathname components, leaving the tail.
`r`
  Remove a trailing suffix of the form `.suffix`, leaving the basename.
`e`
  Remove all but the trailing suffix.
`p`
  Print the new command but do not execute it.
`s/old/new/`
  Substitute new for the first occurrence of old in the event line. Any delimiter may be used in place of `/`. The delimiter may be quoted in old and new with a single backslash. If `&` appears in new, it is replaced by old. A single backslash will quote the `&`. The final delimiter is optional if it is the last character on the input line.
`&`
  Repeat the previous substitution.
`g`
  Cause changes to be applied over the entire event line. Used in conjunction with `s`, as in `gs/old/new/`, or with `&`.

Node:Formatting Documentation, Next:Command Line Editing, Previous:GDB Bugs, Up:Top

# Formatting Documentation

The GDB 4 release includes an already-formatted reference card, ready for printing with PostScript or Ghostscript, in the `gdb` subdirectory of the main source directory7. If you can use PostScript or Ghostscript with your printer, you can print the reference card immediately with `refcard.ps`.

The release also includes the source for the reference card. You can format it, using TeX, by typing:

    make refcard.dvi

The GDB reference card is designed to print in landscape mode on US "letter" size paper; that is, on a sheet 11 inches wide by 8.5 inches high. You will need to specify this form of printing as an option to your DVI output program.

All the documentation for GDB comes as part of the machine-readable distribution. The documentation is written in Texinfo format, which is a documentation system that uses a single source file to produce both on-line information and a printed manual. You can use one of the Info formatting commands to create the on-line version of the documentation and TeX (or `texi2roff`) to typeset the printed version. GDB includes an already formatted copy of the on-line Info version of this manual in the `gdb` subdirectory. The main Info file is `gdb-5.0/gdb/gdb.info`, and it refers to subordinate files matching `gdb.info*` in the same directory. If necessary, you can print out these files, or read them with any editor; but they are easier to read using the `info` subsystem in GNU Emacs or the standalone `info` program, available as part of the GNU Texinfo distribution.

If you want to format these Info files yourself, you need one of the Info formatting programs, such as `texinfo-format-buffer` or `makeinfo`.

If you have `makeinfo` installed, and are in the top level GDB source directory (`gdb-5.0`, in the case of version 5.0), you can make the Info file by typing:

    cd gdb
    make gdb.info

If you want to typeset and print copies of this manual, you need TeX, a program to print its DVI output files, and `texinfo.tex`, the Texinfo definitions file.

TeX is a typesetting program; it does not print files directly, but produces output files called DVI files. To print a typeset document, you need a program to print DVI files. If your system has TeX installed, chances are it has such a program. The precise command to use depends on your system; `lpr -d` is common; another (for PostScript devices) is `dvips`. The DVI print command may require a file name without any extension or a `.dvi` extension.

TeX also requires a macro definitions file called `texinfo.tex`. This file tells TeX how to typeset a document written in Texinfo format. On its own, TeX cannot either read or typeset a Texinfo file. `texinfo.tex` is distributed with GDB and is located in the `gdb-version-number/texinfo` directory.

If you have TeX and a DVI printer program installed, you can typeset and print this manual. First switch to the the `gdb` subdirectory of the main source directory (for example, to `gdb-5.0/gdb`) and type:

    make gdb.dvi

Then give `gdb.dvi` to your DVI printing program.

Node:Installing GDB, Next:Index, Previous:Using History Interactively, Up:Top

# Installing GDB

GDB comes with a `configure` script that automates the process of preparing GDB for installation; you can then use `make` to build the `gdb` program.

The GDB distribution includes all the source code you need for GDB in a single directory, whose name is usually composed by appending the version number to `gdb`.

For example, the GDB version 5.0 distribution is in the `gdb-5.0` directory. That directory contains:

`gdb-5.0/configure (and supporting files)`
  script for configuring GDB and all its supporting libraries
`gdb-5.0/gdb`
  the source specific to GDB itself
`gdb-5.0/bfd`
  source for the Binary File Descriptor library
`gdb-5.0/include`
  GNU include files
`gdb-5.0/libiberty`
  source for the `-liberty` free software library
`gdb-5.0/opcodes`
  source for the library of opcode tables and disassemblers
`gdb-5.0/readline`
  source for the GNU command-line interface
`gdb-5.0/glob`
  source for the GNU filename pattern-matching subroutine
`gdb-5.0/mmalloc`
  source for the GNU memory-mapped malloc package

The simplest way to configure and build GDB is to run `configure` from the `gdb-version-number` source directory, which in this example is the `gdb-5.0` directory.

First switch to the `gdb-version-number` source directory if you are not already in it; then run `configure`. Pass the identifier for the platform on which GDB will run as an argument.

For example:

    cd gdb-5.0
    ./configure host
    make

where host is an identifier such as `sun4` or `decstation`, that identifies the platform where GDB will run. (You can often leave off host; `configure` tries to guess the correct value by examining your system.)

Running `configure host` and then running `make` builds the `bfd`, `readline`, `mmalloc`, and `libiberty` libraries, then `gdb` itself. The configured source files, and the binaries, are left in the corresponding source directories.

`configure` is a Bourne-shell (`/bin/sh`) script; if your system does not recognize this automatically when you run a different shell, you may need to run `sh` on it explicitly:

    sh configure host

If you run `configure` from a directory that contains source directories for multiple libraries or programs, such as the `gdb-5.0` source directory for version 5.0, `configure` creates configuration files for every directory level underneath (unless you tell it not to, with the `--norecursion` option).

You can run the `configure` script from any of the subordinate directories in the GDB distribution if you only want to configure that subdirectory, but be sure to specify a path to it.

For example, with version 5.0, type the following to configure only the `bfd` subdirectory:

    cd gdb-5.0/bfd
    ../configure host

You can install `gdb` anywhere; it has no hardwired paths. However, you should make sure that the shell on your path (named by the `SHELL` environment variable) is publicly readable. Remember that GDB uses the shell to start your program--some systems refuse to let GDB debug child processes whose programs are not readable.

- Separate Objdir: Compiling GDB in another directory
- Config Names: Specifying names for hosts and targets
- Configure Options: Summary of options for configure

Node:Separate Objdir, Next:Config Names, Up:Installing GDB

## Compiling GDB in another directory

If you want to run GDB versions for several host or target machines, you need a different `gdb` compiled for each combination of host and target. `configure` is designed to make this easy by allowing you to generate each configuration in a separate subdirectory, rather than in the source directory. If your `make` program handles the `VPATH` feature (GNU `make` does), running `make` in each of these directories builds the `gdb` program specified there.

To build `gdb` in a separate directory, run `configure` with the `--srcdir` option to specify where to find the source. (You also need to specify a path to find `configure` itself from your working directory. If the path to `configure` would be the same as the argument to `--srcdir`, you can leave out the `--srcdir` option; it is assumed.)

For example, with version 5.0, you can build GDB in a separate directory for a Sun 4 like this:

    cd gdb-5.0
    mkdir ../gdb-sun4
    cd ../gdb-sun4
    ../gdb-5.0/configure sun4
    make

When `configure` builds a configuration using a remote source directory, it creates a tree for the binaries with the same structure (and using the same names) as the tree under the source directory. In the example, you'd find the Sun 4 library `libiberty.a` in the directory `gdb-sun4/libiberty`, and GDB itself in `gdb-sun4/gdb`.

One popular reason to build several GDB configurations in separate directories is to configure GDB for cross-compiling (where GDB runs on one machine--the host--while debugging programs that run on another machine--the target). You specify a cross-debugging target by giving the `--target=target` option to `configure`.

When you run `make` to build a program or library, you must run it in a configured directory--whatever directory you were in when you called `configure` (or one of its subdirectories).

The `Makefile` that `configure` generates in each source directory also runs recursively. If you type `make` in a source directory such as `gdb-5.0` (or in a separate configured directory configured with `--srcdir=dirname/gdb-5.0`), you will build all the required libraries, and then build GDB.

When you have multiple hosts or targets configured in separate directories, you can run `make` on them in parallel (for example, if they are NFS-mounted on each of the hosts); they will not interfere with each other.

Node:Config Names, Next:Configure Options, Previous:Separate Objdir, Up:Installing GDB

## Specifying names for hosts and targets

The specifications used for hosts and targets in the `configure` script are based on a three-part naming scheme, but some short predefined aliases are also supported. The full naming scheme encodes three pieces of information in the following pattern:

    architecture-vendor-os

For example, you can use the alias `sun4` as a host argument, or as the value for target in a `--target=target` option. The equivalent full name is `sparc-sun-sunos4`.

The `configure` script accompanying GDB does not provide any query facility to list all supported host and target names or aliases. `configure` calls the Bourne shell script `config.sub` to map abbreviations to full names; you can read the script, if you wish, or you can use it to test your guesses on abbreviations--for example:

    % sh config.sub i386-linux
    i386-pc-linux-gnu
    % sh config.sub alpha-linux
    alpha-unknown-linux-gnu
    % sh config.sub hp9k700
    hppa1.1-hp-hpux
    % sh config.sub sun4
    sparc-sun-sunos4.1.1
    % sh config.sub sun3
    m68k-sun-sunos4.1.1
    % sh config.sub i986v
    Invalid configuration `i986v': machine `i986v' not recognized

`config.sub` is also distributed in the GDB source directory (`gdb-5.0`, for version 5.0).

Node:Configure Options, Previous:Config Names, Up:Installing GDB

## `configure` options

Here is a summary of the `configure` options and arguments that are most often useful for building GDB. `configure` also has several other options not listed here. see , for a full explanation of `configure`.

    configure [--help]
              [--prefix=dir]
              [--exec-prefix=dir]
              [--srcdir=dirname]
              [--norecursion] [--rm]
              [--target=target]
              host

You may introduce options with a single `-` rather than `--` if you prefer; but you may abbreviate option names if you use `--`.

`--help`
  Display a quick summary of how to invoke `configure`.
`--prefix=dir`
  Configure the source to install programs and files under directory `dir`.
`--exec-prefix=dir`
  Configure the source to install programs under directory `dir`.
`--srcdir=dirname`
  Warning: using this option requires GNU `make`, or another `make` that implements the `VPATH` feature.
  Use this option to make configurations in directories separate from the GDB source directories. Among other things, you can use this to build (or maintain) several configurations simultaneously, in separate directories. `configure` writes configuration specific files in the current directory, but arranges for them to use the source in the directory dirname. `configure` creates directories under the working directory in parallel to the source directories below dirname.
`--norecursion`
  Configure only the directory level where `configure` is executed; do not propagate configuration to subdirectories.
`--target=target`
  Configure GDB for cross-debugging programs running on the specified target. Without this option, GDB is configured to debug programs that run on the same machine (host) as GDB itself.

  There is no convenient way to generate a list of all available targets.

`host ...`
  Configure GDB to run on the specified host.

  There is no convenient way to generate a list of all available hosts.

There are many other options available as well, but they are generally needed for special purposes only.

Node:Index, Previous:Installing GDB, Up:Top

# Index

- "No symbol "foo" in current context": Variables
- `#` (a comment)``: Command Syntax
- `#` in Modula-2: GDB/M2
- `$`: Value History
- `$$`: Value History
- `$_` and `info breakpoints`: Set Breaks
- `$_` and `info line`: Machine Code
- `$_`, `$__`, and value history: Memory
- `$_`, convenience variable``: Convenience Vars
- `$__`, convenience variable``: Convenience Vars
- `$_exitcode`, convenience variable``: Convenience Vars
- `$bpnum`, convenience variable``: Set Breaks
- `$cdir`, convenience variable``: Source Path
- `$cwdr`, convenience variable``: Source Path
- `--annotate`: Mode Options
- `--async`: Mode Options
- `--batch`: Mode Options
- `--baud`: Mode Options
- `--cd`: Mode Options
- `--command`: File Options
- `--core`: File Options
- `--directory`: File Options
- `--epoch`: Mode Options
- `--exec`: File Options
- `--fullname`: Mode Options
- `--interpreter`: Mode Options
- `--mapped`: File Options
- `--noasync`: Mode Options
- `--nowindows`: Mode Options
- `--nx`: Mode Options
- `--quiet`: Mode Options
- `--readnow`: File Options
- `--se`: File Options
- `--silent`: Mode Options
- `--statistics`: Mode Options
- `--symbols`: File Options
- `--tty`: Mode Options
- `--version`: Mode Options
- `--windows`: Mode Options
- `--write`: Mode Options
- `-b`: Mode Options
- `-break-after`: GDB/MI Breakpoint Table Commands
- `-break-condition`: GDB/MI Breakpoint Table Commands
- `-break-delete`: GDB/MI Breakpoint Table Commands
- `-break-disable`: GDB/MI Breakpoint Table Commands
- `-break-enable`: GDB/MI Breakpoint Table Commands
- `-break-info`: GDB/MI Breakpoint Table Commands
- `-break-insert`: GDB/MI Breakpoint Table Commands
- `-break-list`: GDB/MI Breakpoint Table Commands
- `-break-watch`: GDB/MI Breakpoint Table Commands
- `-c`: File Options
- `-d`: File Options
- `-data-disassemble`: GDB/MI Data Manipulation
- `-data-evaluate-expression`: GDB/MI Data Manipulation
- `-data-list-changed-registers`: GDB/MI Data Manipulation
- `-data-list-register-names`: GDB/MI Data Manipulation
- `-data-list-register-values`: GDB/MI Data Manipulation
- `-data-read-memory`: GDB/MI Data Manipulation
- `-display-delete`: GDB/MI Data Manipulation
- `-display-disable`: GDB/MI Data Manipulation
- `-display-enable`: GDB/MI Data Manipulation
- `-display-insert`: GDB/MI Data Manipulation
- `-display-list`: GDB/MI Data Manipulation
- `-e`: File Options
- `-environment-cd`: GDB/MI Data Manipulation
- `-environment-directory`: GDB/MI Data Manipulation
- `-environment-path`: GDB/MI Data Manipulation
- `-environment-pwd`: GDB/MI Data Manipulation
- `-exec-abort`: GDB/MI Program Control
- `-exec-arguments`: GDB/MI Program Control
- `-exec-continue`: GDB/MI Program Control
- `-exec-finish`: GDB/MI Program Control
- `-exec-interrupt`: GDB/MI Program Control
- `-exec-next`: GDB/MI Program Control
- `-exec-next-instruction`: GDB/MI Program Control
- `-exec-return`: GDB/MI Program Control
- `-exec-run`: GDB/MI Program Control
- `-exec-show-arguments`: GDB/MI Program Control
- `-exec-step`: GDB/MI Program Control
- `-exec-step-instruction`: GDB/MI Program Control
- `-exec-until`: GDB/MI Program Control
- `-f`: Mode Options
- `-file-exec-and-symbols`: GDB/MI Program Control
- `-file-exec-file`: GDB/MI Program Control
- `-file-list-exec-sections`: GDB/MI Program Control
- `-file-list-exec-source-files`: GDB/MI Program Control
- `-file-list-shared-libraries`: GDB/MI Program Control
- `-file-list-symbol-files`: GDB/MI Program Control
- `-file-symbol-file`: GDB/MI Program Control
- `-gdb-exit`: GDB/MI Miscellaneous Commands
- `-gdb-set`: GDB/MI Miscellaneous Commands
- `-gdb-show`: GDB/MI Miscellaneous Commands
- `-gdb-version`: GDB/MI Miscellaneous Commands
- `-m`: File Options
- `-n`: Mode Options
- `-nw`: Mode Options
- `-q`: Mode Options
- `-r`: File Options
- `-s`: File Options
- `-stack-info-depth`: GDB/MI Stack Manipulation
- `-stack-info-frame`: GDB/MI Stack Manipulation
- `-stack-list-arguments`: GDB/MI Stack Manipulation
- `-stack-list-frames`: GDB/MI Stack Manipulation
- `-stack-list-locals`: GDB/MI Stack Manipulation
- `-stack-select-frame`: GDB/MI Stack Manipulation
- `-symbol-info-address`: GDB/MI Symbol Query
- `-symbol-info-file`: GDB/MI Symbol Query
- `-symbol-info-function`: GDB/MI Symbol Query
- `-symbol-info-line`: GDB/MI Symbol Query
- `-symbol-info-symbol`: GDB/MI Symbol Query
- `-symbol-list-functions`: GDB/MI Symbol Query
- `-symbol-list-types`: GDB/MI Symbol Query
- `-symbol-list-variables`: GDB/MI Symbol Query
- `-symbol-locate`: GDB/MI Symbol Query
- `-symbol-type`: GDB/MI Symbol Query
- `-t`: Mode Options
- `-target-attach`: GDB/MI Target Manipulation
- `-target-compare-sections`: GDB/MI Target Manipulation
- `-target-detach`: GDB/MI Target Manipulation
- `-target-download`: GDB/MI Target Manipulation
- `-target-exec-status`: GDB/MI Target Manipulation
- `-target-list-available-targets`: GDB/MI Target Manipulation
- `-target-list-current-targets`: GDB/MI Target Manipulation
- `-target-list-parameters`: GDB/MI Target Manipulation
- `-target-select`: GDB/MI Target Manipulation
- `-thread-info`: GDB/MI Thread Commands
- `-thread-list-all-threads`: GDB/MI Thread Commands
- `-thread-list-ids`: GDB/MI Thread Commands
- `-thread-select`: GDB/MI Thread Commands
- `-var-assign`: GDB/MI Variable Objects
- `-var-create`: GDB/MI Variable Objects
- `-var-delete`: GDB/MI Variable Objects
- `-var-evaluate-expression`: GDB/MI Variable Objects
- `-var-info-expression`: GDB/MI Variable Objects
- `-var-info-num-children`: GDB/MI Variable Objects
- `-var-info-type`: GDB/MI Variable Objects
- `-var-list-children`: GDB/MI Variable Objects
- `-var-set-format`: GDB/MI Variable Objects
- `-var-show-attributes`: GDB/MI Variable Objects
- `-var-show-format`: GDB/MI Variable Objects
- `-var-update`: GDB/MI Variable Objects
- `-w`: Mode Options
- `-x`: File Options
- `.`, Modula-2 scope operator: M2 Scope
- `.esgdbinit`: Command Files
- `.gdbinit`: Command Files
- `.os68gdbinit`: Command Files
- `.vxgdbinit`: Command Files
- `/proc`: SVR4 Process Information
- `@`, referencing memory as an array``: Arrays
- `^done`: GDB/MI Result Records
- ^error: GDB/MI Result Records
- `^running`: GDB/MI Result Records
- a.out and C++: C plus plus expressions
- abbreviation: Command Syntax
- `abort (C-g)`: Miscellaneous Commands
- `accept-line (Newline, Return)`: Commands For History
- acknowledgment, for GDB remote: Protocol
- active targets: Active Targets
- `add-shared-symbol-file`: Files
- `add-symbol-file`: Files
- Alpha stack: MIPS
- AMD 29K register stack: A29K
- AMD EB29K: A29K Embedded
- AMD29K via UDI: A29K UDI
- annotations: Annotations Overview
- annotations for breakpoints: Breakpoint Info
- annotations for display: Displays
- annotations for errors, warnings and interrupts: Errors
- annotations for frames: Frame Annotations
- annotations for invalidation messages: Invalidation
- annotations for prompts: Prompting
- annotations for running programs: Annotations for Running
- annotations for source display: Source Annotations
- annotations for values: Value Annotations
- `apropos`: Help
- `arg-begin`: Value Annotations
- `arg-end`: Value Annotations
- `arg-name-end`: Value Annotations
- `arg-value`: Value Annotations
- arguments (to your program): Arguments
- `array-section-end`: Value Annotations
- artificial array: Arrays
- assembly instructions: Machine Code
- assignment: Assignment
- async output in GDB/MI: GDB/MI Output Syntax
- AT&T disassembly flavor: Machine Code
- `attach`: Attach
- automatic display: Auto Display
- automatic thread selection: Threads
- `awatch`: Set Watchpoints
- `b` (`break`)``: Set Breaks
- `backtrace`: Backtrace
- backtraces: Backtrace
- `backward-char (C-b)`: Commands For Moving
- `backward-delete-char (Rubout)`: Commands For Text
- `backward-kill-line (C-x Rubout)`: Commands For Killing
- `backward-kill-word (M-DEL)`: Commands For Killing
- `backward-word (M-b)`: Commands For Moving
- `beginning-of-history (M-<)`: Commands For History
- `beginning-of-line (C-a)`: Commands For Moving
- `bell-style`: Readline Init File Syntax
- `break`: Set Breaks
- `break ... thread threadno`: Thread Stops
- break in overloaded functions: Debugging C plus plus
- `breakpoint`: Annotations for Running
- breakpoint commands: Break Commands
- breakpoint commands for GDB/MI: GDB/MI Breakpoint Table Commands
- breakpoint conditions: Conditions
- breakpoint numbers: Breakpoints
- breakpoint on events: Breakpoints
- breakpoint on memory address: Breakpoints
- breakpoint on variable modification: Breakpoints
- breakpoint ranges: Breakpoints
- `breakpoint` subroutine, remote: Stub Contents
- breakpoints: Breakpoints
- breakpoints and threads: Thread Stops
- `breakpoints-headers`: Breakpoint Info
- `breakpoints-invalid`: Invalidation
- `breakpoints-table`: Breakpoint Info
- `breakpoints-table-end`: Breakpoint Info
- `bt` (`backtrace`)``: Backtrace
- bug criteria: Bug Criteria
- bug reports: Bug Reporting
- bugs in GDB: GDB Bugs
- `c` (`continue`)``: Continuing and Stepping
- C and C++: C
- C and C++ checks: C Checks
- C and C++ constants: C Constants
- C and C++ defaults: C Defaults
- C and C++ operators: C Operators
- C`++`: C
- C++ and object formats: C plus plus expressions
- C++ exception handling: Debugging C plus plus
- C++ scope resolution: Variables
- C++ support, not in COFF: C plus plus expressions
- C++ symbol decoding style: Print Settings
- C++ symbol display: Debugging C plus plus
- `call`: Calling
- call overloaded functions: C plus plus expressions
- call stack: Stack
- `call-last-kbd-macro (C-x e)`: Keyboard Macros
- calling functions: Calling
- calling make: Shell Commands
- `capitalize-word (M-c)`: Commands For Text
- casts, to view memory: Expressions
- `catch`: Set Catchpoints
- `catch catch`: Set Catchpoints
- catch exceptions, list active handlers: Frame Info
- `catch exec`: Set Catchpoints
- `catch fork`: Set Catchpoints
- `catch load`: Set Catchpoints
- `catch throw`: Set Catchpoints
- `catch unload`: Set Catchpoints
- `catch vfork`: Set Catchpoints
- catchpoints: Breakpoints
- catchpoints, setting: Set Catchpoints
- `cd`: Working Directory
- `cdir`: Source Path
- `character-search (C-])`: Miscellaneous Commands
- `character-search-backward (M-C-])`: Miscellaneous Commands
- checks, range: Type Checking
- checks, type: Checks
- checksum, for GDB remote: Protocol
- Chill: Summary
- choosing target byte order: Byte Order
- `clear`: Delete Breaks
- `clear-screen (C-l)`: Commands For Moving
- clearing breakpoints, watchpoints, catchpoints: Delete Breaks
- COFF versus C++: C plus plus expressions
- colon, doubled as scope operator: M2 Scope
- colon-colon, context for variables/functions: Variables
- command editing: Readline Bare Essentials
- command files: Command Files
- command hooks: Hooks
- command line editing: Editing
- `commands`: Break Commands, Prompting
- commands for C++: Debugging C plus plus
- commands to STDBUG (ST2000): ST2000
- comment: Command Syntax
- `comment-begin`: Readline Init File Syntax
- compatibility, GDB/MI and CLI: GDB/MI Compatibility with CLI
- compilation directory: Source Path
- compiling, on Sparclet: Sparclet
- `complete`: Help
- `complete (TAB)`: Commands For Completion
- completion: Completion
- completion of quoted strings: Completion
- `completion-query-items`: Readline Init File Syntax
- `condition`: Conditions
- conditional breakpoints: Conditions
- configuring GDB: Installing GDB
- confirmation: Messages/Warnings
- connect (to STDBUG): ST2000
- console output in GDB/MI: GDB/MI Output Syntax
- `continue`: Continuing and Stepping
- continuing: Continuing and Stepping
- continuing threads: Thread Stops
- control C, and remote debugging: Bootstrapping
- controlling terminal: Input/Output
- convenience variables: Convenience Vars
- `convert-meta`: Readline Init File Syntax
- `copy-backward-word ()`: Commands For Killing
- `copy-forward-word ()`: Commands For Killing
- `copy-region-as-kill ()`: Commands For Killing
- `core`: Files
- core dump file: Files
- `core-file`: Files
- crash of debugger: Bug Criteria
- current directory: Source Path
- current stack frame: Frames
- current thread: Threads
- `cwd`: Source Path
- `d` (`delete`)``: Delete Breaks
- data manipulation, in GDB/MI: GDB/MI Data Manipulation
- debugger crash: Bug Criteria
- debugging optimized code: Compilation
- debugging stub, example: Protocol
- debugging target: Targets
- `define`: Define
- `delete`: Delete Breaks
- delete breakpoints: Delete Breaks
- `delete display`: Auto Display
- `delete-char (C-d)`: Commands For Text
- `delete-char-or-list ()`: Commands For Completion
- `delete-horizontal-space ()`: Commands For Killing
- deleting breakpoints, watchpoints, catchpoints: Delete Breaks
- demangling: Print Settings
- `detach`: Attach
- `device`: Hitachi Boards
- `digit-argument (M-0, M-1, ... M--)`: Numeric Arguments
- `dir`: Source Path
- directories for source files: Source Path
- `directory`: Source Path
- directory, compilation: Source Path
- directory, current: Source Path
- `dis` (`disable`)``: Disabling
- `disable`: Disabling
- `disable breakpoints`: Disabling
- `disable display`: Auto Display
- `disable-completion`: Readline Init File Syntax
- `disassemble`: Machine Code
- `display`: Auto Display
- display of expressions: Auto Display
- `display-begin`: Displays
- `display-end`: Displays
- `display-expression`: Displays
- `display-expression-end`: Displays
- `display-format`: Displays
- `display-number-end`: Displays
- `display-value`: Displays
- `do` (`down`)``: Selection
- `do-uppercase-version (M-a, M-b, M-x, ...)`: Miscellaneous Commands
- `document`: Define
- documentation: Formatting Documentation
- `down`: Selection
- `down-silently`: Selection
- `downcase-word (M-l)`: Commands For Text
- download to H8/300 or H8/500: H8/300
- download to Hitachi SH: H8/300
- download to Nindy-960: i960
- download to Sparclet: Sparclet Download
- download to VxWorks: VxWorks Download
- draft changes to output syntax of GDB/MI: GDB/MI Draft Changes to Output Syntax
- `dump-functions ()`: Miscellaneous Commands
- `dump-macros ()`: Miscellaneous Commands
- `dump-variables ()`: Miscellaneous Commands
- dynamic linking: Files
- `eb.log`, a log file for EB29K: Remote Log
- EB29K board: A29K EB29K
- `EBMON`: Comms (EB29K)
- `echo`: Output
- ECOFF and C++: C plus plus expressions
- editing: Editing
- editing command lines: Readline Bare Essentials
- `editing-mode`: Readline Init File Syntax
- ELF/DWARF and C++: C plus plus expressions
- ELF/stabs and C++: C plus plus expressions
- `else`: Define
- `elt`: Value Annotations
- `elt-rep`: Value Annotations
- `elt-rep-end`: Value Annotations
- Emacs: Emacs
- `enable`: Disabling
- `enable breakpoints`: Disabling
- `enable display`: Auto Display
- `enable-keypad`: Readline Init File Syntax
- `end`: Break Commands
- `end-kbd-macro (C-x ))`: Keyboard Macros
- `end-of-history (M->)`: Commands For History
- `end-of-line (C-e)`: Commands For Moving
- entering numbers: Numbers
- environment (of your program): Environment
- `error`: Errors
- error on valid input: Bug Criteria
- `error-begin`: Errors
- event designators: Event Designators
- event handling: Set Catchpoints
- examining data: Data
- examining memory: Memory
- exception handlers: Set Catchpoints
- exception handlers, how to list: Frame Info
- `exceptionHandler`: Bootstrapping
- `exchange-point-and-mark (C-x C-x)`: Miscellaneous Commands
- `exec-file`: Files
- executable file: Files
- `exited`: Annotations for Running
- exiting GDB: Quitting GDB
- `expand-tilde`: Readline Init File Syntax
- expressions: Expressions
- expressions in C or C++: C
- expressions in C++: C plus plus expressions
- expressions in Modula-2: Modula-2
- `f` (`frame`)``: Selection
- fatal signal: Bug Criteria
- fatal signals: Signals
- `fg` (resume foreground execution)``: Continuing and Stepping
- `field`: Breakpoint Info
- `field-begin`: Value Annotations
- `field-end`: Value Annotations
- `field-name-end`: Value Annotations
- `field-value`: Value Annotations
- `file`: Files
- `finish`: Continuing and Stepping
- flinching: Messages/Warnings
- floating point: Floating Point Hardware
- floating point registers: Registers
- floating point, MIPS remote: MIPS Embedded
- `flush_i_cache`: Bootstrapping
- focus of debugging: Threads
- foo: Symbol Errors
- fork, debugging programs which call: Processes
- format options: Print Settings
- formatted output: Output Formats
- Fortran: Summary
- `forward-backward-delete-char ()`: Commands For Text
- `forward-char (C-f)`: Commands For Moving
- `forward-search`: Search
- `forward-search-history (C-s)`: Commands For History
- `forward-word (M-f)`: Commands For Moving
- frame number: Frames
- frame pointer: Frames
- `frame`, command``: Frames
- frame, definition: Frames
- `frame`, selecting``: Selection
- `frame-address`: Frame Annotations
- `frame-address-end`: Frame Annotations
- `frame-args`: Frame Annotations
- `frame-begin`: Frame Annotations
- `frame-end`: Frame Annotations
- `frame-function-name`: Frame Annotations
- `frame-source-begin`: Frame Annotations
- `frame-source-end`: Frame Annotations
- `frame-source-file`: Frame Annotations
- `frame-source-file-end`: Frame Annotations
- `frame-source-line`: Frame Annotations
- `frame-where`: Frame Annotations
- frameless execution: Frames
- `frames-invalid`: Invalidation
- Fujitsu: Remote Serial
- `function-call`: Frame Annotations
- `g++`, GNU C`++` compiler: C
- GDB bugs, reporting: Bug Reporting
- GDB reference card: Formatting Documentation
- `gdb.ini`: Command Files
- GDB/MI, breakpoint commands: GDB/MI Breakpoint Table Commands
- GDB/MI, compatibility with CLI: GDB/MI Compatibility with CLI
- GDB/MI, data manipulation: GDB/MI Data Manipulation
- GDB/MI, draft changes to output syntax: GDB/MI Draft Changes to Output Syntax
- GDB/MI, input syntax: GDB/MI Input Syntax
- GDB/MI, its purpose: GDB/MI
- GDB/MI, out-of-band records: GDB/MI Out-of-band Records
- GDB/MI, output syntax: GDB/MI Output Syntax
- GDB/MI, result records: GDB/MI Result Records
- GDB/MI, simple examples: GDB/MI Simple Examples
- GDB/MI, stream records: GDB/MI Stream Records
- `GDBHISTFILE`: History
- `gdbserve.nlm`: NetWare
- `gdbserver`: Server
- `getDebugChar`: Bootstrapping
- GNU C++: C
- GNU Emacs: Emacs
- `h` (`help`)``: Help
- H8/300 or H8/500 download: H8/300
- `handle`: Signals
- `handle_exception`: Stub Contents
- handling signals: Signals
- hardware watchpoints: Set Watchpoints
- `hbreak`: Set Breaks
- `help`: Help
- `help target`: Target Commands
- `help user-defined`: Define
- `heuristic-fence-post` (Alpha, MIPS): MIPS
- history events: Event Designators
- history expansion: History, History Interaction
- history file: History
- history number: Value History
- history save: History
- history size: History
- history substitution: History
- `history-search-backward ()`: Commands For History
- `history-search-forward ()`: Commands For History
- Hitachi: Remote Serial
- Hitachi SH download: H8/300
- hooks, for commands: Hooks
- `horizontal-scroll-mode`: Readline Init File Syntax
- `i` (`info`)``: Help
- i/o: Input/Output
- i386: Remote Serial
- `i386-stub.c`: Remote Serial
- i960: i960
- `if`: Define
- `ignore`: Conditions
- ignore count (of breakpoint): Conditions
- `INCLUDE_RDB`: VxWorks
- `info`: Help
- `info address`: Symbols
- `info all-registers`: Registers
- `info args`: Frame Info
- `info breakpoints`: Set Breaks
- `info catch`: Frame Info
- `info display`: Auto Display
- `info extensions`: Show
- `info f` (`info frame`)``: Frame Info
- `info files`: Files
- `info float`: Floating Point Hardware
- `info frame`: Frame Info
- `info frame`, show the source language``: Show
- `info functions`: Symbols
- `info line`: Machine Code
- `info locals`: Frame Info
- `info proc`: SVR4 Process Information
- `info proc id`: SVR4 Process Information
- `info proc mappings`: SVR4 Process Information
- `info proc status`: SVR4 Process Information
- `info proc times`: SVR4 Process Information
- `info program`: Stopping
- `info registers`: Registers
- `info s` (`info stack`)``: Backtrace
- `info set`: Help
- `info share`: Files
- `info sharedlibrary`: Files
- `info signals`: Signals
- `info source`: Symbols
- `info source`, show the source language``: Show
- `info sources`: Symbols
- `info stack`: Backtrace
- `info target`: Files
- `info terminal`: Input/Output
- `info threads`: Threads
- `info types`: Symbols
- `info variables`: Symbols
- `info watchpoints`: Set Watchpoints
- inheritance: Debugging C plus plus
- init file: Command Files
- init file name: Command Files
- initial frame: Frames
- initialization file, readline: Readline Init File
- innermost frame: Frames
- input syntax for GDB/MI: GDB/MI Input Syntax
- `input-meta`: Readline Init File Syntax
- `insert-comment (M-#)`: Miscellaneous Commands
- `insert-completions (M-*)`: Commands For Completion
- `inspect`: Data
- installation: Installing GDB
- instructions, assembly: Machine Code
- Intel: Remote Serial
- Intel disassembly flavor: Machine Code
- interaction, readline: Readline Interaction
- internal GDB breakpoints: Set Breaks
- interrupt: Quitting GDB
- interrupting remote programs: Debug Session
- interrupting remote targets: Bootstrapping
- invalid input: Bug Criteria
- `isearch-terminators`: Readline Init File Syntax
- `jump`: Jumping
- kernel object: KOD
- kernel object display: KOD
- `keymap`: Readline Init File Syntax
- `kill`: Kill Process
- kill ring: Readline Killing Commands
- `kill-line (C-k)`: Commands For Killing
- `kill-region ()`: Commands For Killing
- `kill-whole-line ()`: Commands For Killing
- `kill-word (M-d)`: Commands For Killing
- killing text: Readline Killing Commands
- KOD: KOD
- `l` (`list`)``: List
- languages: Languages
- latest breakpoint: Set Breaks
- leaving GDB: Quitting GDB
- linespec: List
- `list`: List
- listing machine instructions: Machine Code
- `load filename`: Target Commands
- log file for EB29K: Remote Log
- log output in GDB/MI: GDB/MI Output Syntax
- m680x0: Remote Serial
- `m68k-stub.c`: Remote Serial
- machine instructions: Machine Code
- `maint info breakpoints`: Set Breaks
- `maint print psymbols`: Symbols
- `maint print symbols`: Symbols
- `make`: Shell Commands
- `mapped`: Files
- `mark-modified-lines`: Readline Init File Syntax
- member functions: C plus plus expressions
- memory models, H8/500: H8/500
- memory tracing: Breakpoints
- memory, viewing as typed object: Expressions
- memory-mapped symbol file: Files
- `memset`: Bootstrapping
- `menu-complete ()`: Commands For Completion
- `meta-flag`: Readline Init File Syntax
- MIPS boards: MIPS Embedded
- MIPS remote floating point: MIPS Embedded
- MIPS `remotedebug` protocol: MIPS Embedded
- MIPS stack: MIPS
- Modula-2: Summary
- Modula-2 built-ins: M2 Operators
- Modula-2 checks: M2 Checks
- Modula-2 constants: Built-In Func/Proc
- Modula-2 defaults: M2 Defaults
- Modula-2 operators: M2 Operators
- Modula-2, deviations from: Deviations
- Modula-2, GDB support: Modula-2
- Motorola 680x0: Remote Serial
- multiple processes: Processes
- multiple targets: Active Targets
- multiple threads: Threads
- `n` (`next`)``: Continuing and Stepping
- names of symbols: Symbols
- namespace in C++: C plus plus expressions
- negative breakpoint numbers: Set Breaks
- `New` systag message: Threads
- `New` systag message, on HP-UX: Threads
- `next`: Continuing and Stepping
- `next-history (C-n)`: Commands For History
- `nexti`: Continuing and Stepping
- `ni` (`nexti`)``: Continuing and Stepping
- Nindy: i960
- `non-incremental-forward-search-history (M-n)`: Commands For History
- `non-incremental-reverse-search-history (M-p)`: Commands For History
- notation, readline: Readline Bare Essentials
- notational conventions, for GDB/MI: GDB/MI
- notify output in GDB/MI: GDB/MI Output Syntax
- number representation: Numbers
- numbers for breakpoints: Breakpoints
- object formats and C++: C plus plus expressions
- online documentation: Help
- optimized code, debugging: Compilation
- out-of-band records in GDB/MI: GDB/MI Out-of-band Records
- outermost frame: Frames
- `output`: Output
- output formats: Output Formats
- output syntax of GDB/MI: GDB/MI Output Syntax
- `output-meta`: Readline Init File Syntax
- `overload-choice`: Prompting
- overloaded functions, calling: C plus plus expressions
- overloaded functions, overload resolution: Debugging C plus plus
- overloading: Breakpoint Menus
- overloading in C++: Debugging C plus plus
- packets, reporting on stdout: Debugging Output
- partial symbol dump: Symbols
- Pascal: Summary
- patching binaries: Patching
- `path`: Environment
- pauses in output: Screen Size
- pipes: Starting
- pointer, finding referent: Print Settings
- `possible-completions (M-?)`: Commands For Completion
- `post-commands`: Prompting
- `post-overload-choice`: Prompting
- `post-prompt`: Prompting
- `post-prompt-for-continue`: Prompting
- `post-query`: Prompting
- `pre-commands`: Prompting
- `pre-overload-choice`: Prompting
- `pre-prompt`: Prompting
- `pre-prompt-for-continue`: Prompting
- `pre-query`: Prompting
- `prefix-meta (ESC)`: Miscellaneous Commands
- `previous-history (C-p)`: Commands For History
- `print`: Data
- print settings: Print Settings
- `printf`: Output
- printing data: Data
- process image: SVR4 Process Information
- processes, multiple: Processes
- `prompt`: Prompting, Prompt
- `prompt-for-continue`: Prompting
- protocol, GDB remote serial: Protocol
- `ptype`: Symbols
- `putDebugChar`: Bootstrapping
- `pwd`: Working Directory
- `q` (`quit`)``: Quitting GDB
- `query`: Prompting
- `quit`: Errors
- `quit` [`expression`]``: Quitting GDB
- `quoted-insert (C-q, C-v)`: Commands For Text
- quotes in commands: Completion
- quoting names: Symbols
- `r` (`run`)``: Starting
- raise exceptions: Set Catchpoints
- range checking: Type Checking
- ranges of breakpoints: Breakpoints
- `rbreak`: Set Breaks
- `re-read-init-file (C-x C-r)`: Miscellaneous Commands
- reading symbols immediately: Files
- readline: Editing
- `readnow`: Files
- `record`: Breakpoint Info
- redirection: Input/Output
- `redraw-current-line ()`: Commands For Moving
- reference card: Formatting Documentation
- reference declarations: C plus plus expressions
- register stack, AMD29K: A29K
- registers: Registers
- regular expression: Set Breaks
- reloading symbols: Symbols
- remote connection without stubs: Server
- remote debugging: Remote
- remote programs, interrupting: Debug Session
- remote serial debugging summary: Debug Session
- remote serial debugging, overview: Remote Serial
- remote serial protocol: Protocol
- remote serial stub: Stub Contents
- remote serial stub list: Remote Serial
- remote serial stub, initialization: Stub Contents
- remote serial stub, main routine: Stub Contents
- remote stub, example: Protocol
- remote stub, support routines: Bootstrapping
- `remotedebug`, MIPS protocol: MIPS Embedded
- `remotetimeout`: Sparclet
- repeating commands: Command Syntax
- reporting bugs in GDB: GDB Bugs
- `reset`: Nindy Reset
- response time, MIPS debugging: MIPS
- result records in GDB/MI: GDB/MI Result Records
- resuming execution: Continuing and Stepping
- `RET` (repeat last command)``: Command Syntax
- `retransmit-timeout`, MIPS protocol: MIPS Embedded
- `return`: Returning
- returning from a function: Returning
- `reverse-search`: Search
- `reverse-search-history (C-r)`: Commands For History
- `revert-line (M-r)`: Miscellaneous Commands
- `run`: Starting
- running: Starting
- running 29K programs: A29K EB29K
- running and debugging Sparclet programs: Sparclet Execution
- running VxWorks tasks: VxWorks Attach
- running, on Sparclet: Sparclet
- `rwatch`: Set Watchpoints
- `s` (`step`)``: Continuing and Stepping
- saving symbol table: Files
- scope: M2 Scope
- `search`: Search
- searching: Search
- `section`: Files
- `select-frame`: Frames
- selected frame: Stack
- selecting frame silently: Frames
- `self-insert (a, b, A, 1, !, ...)`: Commands For Text
- sequence-id, for GDB remote: Protocol
- serial connections, debugging: Debugging Output
- serial device, Hitachi micros: Hitachi Boards
- serial line speed, Hitachi micros: Hitachi Boards
- serial line, `target remote`: Debug Session
- serial protocol, GDB remote: Protocol
- server prefix for annotations: Server Prefix
- `set`: Help
- `set args`: Arguments
- `set auto-solib-add`: Files
- `set check range`: Range Checking
- `set check type`: Type Checking
- `set check`, range``: Range Checking
- `set check`, type``: Type Checking
- `set complaints`: Messages/Warnings
- `set confirm`: Messages/Warnings
- `set debug arch`: Debugging Output
- `set debug event`: Debugging Output
- `set debug expression`: Debugging Output
- `set debug overload`: Debugging Output
- `set debug remote`: Debugging Output
- `set debug serial`: Debugging Output
- `set debug target`: Debugging Output
- `set debug varobj`: Debugging Output
- `set demangle-style`: Print Settings
- `set disassembly-flavor`: Machine Code
- `set editing`: Editing
- `set endian auto`: Byte Order
- `set endian big`: Byte Order
- `set endian little`: Byte Order
- `set environment`: Environment
- `set extension-language`: Show
- `set follow-fork-mode`: Processes
- `set gnutarget`: Target Commands
- `set height`: Screen Size
- `set history expansion`: History
- `set history filename`: History
- `set history save`: History
- `set history size`: History
- `set input-radix`: Numbers
- `set language`: Manually
- `set listsize`: List
- `set machine`: Hitachi Special
- `set memory mod`: H8/500
- `set mipsfpu`: MIPS Embedded
- `set opaque-type-resolution`: Symbols
- `set output-radix`: Numbers
- `set overload-resolution`: Debugging C plus plus
- `set print address`: Print Settings
- `set print array`: Print Settings
- `set print asm-demangle`: Print Settings
- `set print demangle`: Print Settings
- `set print elements`: Print Settings
- `set print max-symbolic-offset`: Print Settings
- `set print null-stop`: Print Settings
- `set print object`: Print Settings
- `set print pretty`: Print Settings
- `set print sevenbit-strings`: Print Settings
- `set print static-members`: Print Settings
- `set print symbol-filename`: Print Settings
- `set print union`: Print Settings
- `set print vtbl`: Print Settings
- `set processor args`: MIPS Embedded
- `set prompt`: Prompt
- `set remotedebug`, MIPS protocol``: MIPS Embedded
- `set retransmit-timeout`: MIPS Embedded
- `set rstack_high_address`: A29K
- `set symbol-reloading`: Symbols
- `set timeout`: MIPS Embedded
- `set variable`: Assignment
- `set verbose`: Messages/Warnings
- `set width`: Screen Size
- `set write`: Patching
- `set-mark (C-@)`: Miscellaneous Commands
- `set_debug_traps`: Stub Contents
- setting variables: Assignment
- setting watchpoints: Set Watchpoints
- SH: Remote Serial
- `sh-stub.c`: Remote Serial
- `share`: Files
- shared libraries: Files
- `sharedlibrary`: Files
- `shell`: Shell Commands
- shell escape: Shell Commands
- `show`: Help
- `show args`: Arguments
- `show auto-solib-add`: Files
- `show check range`: Range Checking
- `show check type`: Type Checking
- `show complaints`: Messages/Warnings
- `show confirm`: Messages/Warnings
- `show convenience`: Convenience Vars
- `show copying`: Help
- `show debug arch`: Debugging Output
- `show debug event`: Debugging Output
- `show debug expression`: Debugging Output
- `show debug overload`: Debugging Output
- `show debug remote`: Debugging Output
- `show debug serial`: Debugging Output
- `show debug target`: Debugging Output
- `show debug varobj`: Debugging Output
- `show demangle-style`: Print Settings
- `show directories`: Source Path
- `show editing`: Editing
- `show environment`: Environment
- `show gnutarget`: Target Commands
- `show height`: Screen Size
- `show history`: History
- `show input-radix`: Numbers
- `show language`: Show
- `show listsize`: List
- `show machine`: Hitachi Special
- `show mipsfpu`: MIPS Embedded
- `show opaque-type-resolution`: Symbols
- `show output-radix`: Numbers
- `show paths`: Environment
- `show print address`: Print Settings
- `show print array`: Print Settings
- `show print asm-demangle`: Print Settings
- `show print demangle`: Print Settings
- `show print elements`: Print Settings
- `show print max-symbolic-offset`: Print Settings
- `show print object`: Print Settings
- `show print pretty`: Print Settings
- `show print sevenbit-strings`: Print Settings
- `show print static-members`: Print Settings
- `show print symbol-filename`: Print Settings
- `show print union`: Print Settings
- `show print vtbl`: Print Settings
- `show processor`: MIPS Embedded
- `show prompt`: Prompt
- `show remotedebug`, MIPS protocol``: MIPS Embedded
- `show retransmit-timeout`: MIPS Embedded
- `show rstack_high_address`: A29K
- `show symbol-reloading`: Symbols
- `show timeout`: MIPS Embedded
- `show user`: Define
- `show values`: Value History
- `show verbose`: Messages/Warnings
- `show version`: Help
- `show warranty`: Help
- `show width`: Screen Size
- `show write`: Patching
- `show-all-if-ambiguous`: Readline Init File Syntax
- `shows`: History
- `si` (`stepi`)``: Continuing and Stepping
- `signal`: Annotations for Running, Signaling
- `signal-handler-caller`: Frame Annotations
- `signal-name`: Annotations for Running
- `signal-name-end`: Annotations for Running
- `signal-string`: Annotations for Running
- `signal-string-end`: Annotations for Running
- `signalled`: Annotations for Running
- signals: Signals
- `silent`: Break Commands
- `sim`: Z8000
- simulator, Z8000: Z8000
- size of screen: Screen Size
- software watchpoints: Set Watchpoints
- `source`: Command Files, Source Annotations
- source path: Source Path
- Sparc: Remote Serial
- `sparc-stub.c`: Remote Serial
- `sparcl-stub.c`: Remote Serial
- Sparclet: Sparclet
- SparcLite: Remote Serial
- `speed`: Hitachi Boards
- ST2000 auxiliary commands: ST2000
- `st2000 cmd`: ST2000
- stack frame: Frames
- stack on Alpha: MIPS
- stack on MIPS: MIPS
- stack traces: Backtrace
- stacking targets: Active Targets
- `start-kbd-macro (C-x ()`: Keyboard Macros
- `starting`: Annotations for Running, Starting
- status output in GDB/MI: GDB/MI Output Syntax
- STDBUG commands (ST2000): ST2000
- `step`: Continuing and Stepping
- `stepi`: Continuing and Stepping
- stepping: Continuing and Stepping
- `stop`, a pseudo-command``: Hooks
- stopped threads: Thread Stops
- `stopping`: Annotations for Running
- stream records in GDB/MI: GDB/MI Stream Records
- stub example, remote debugging: Protocol
- stupid questions: Messages/Warnings
- switching threads: Threads
- switching threads automatically: Threads
- symbol decoding style, C++: Print Settings
- symbol dump: Symbols
- symbol names: Symbols
- symbol overloading: Breakpoint Menus
- symbol table: Files
- `symbol-file`: Files
- symbols, reading immediately: Files
- `target`: Targets
- `target abug`: M68K
- `target adapt`: A29K Embedded
- `target amd-eb`: A29K Embedded
- `target array`: MIPS Embedded
- `target bug`: M88K
- target byte order: Byte Order
- `target core`: Target Commands
- `target cpu32bug`: M68K
- `target dbug`: M68K
- `target ddb port`: MIPS Embedded
- `target dink32`: PowerPC
- `target e7000`, with H8/300``: H8/300
- `target e7000`, with Hitachi ICE``: Hitachi ICE
- `target e7000`, with Hitachi SH``: SH
- `target es1800`: M68K
- `target est`: M68K
- `target exec`: Target Commands
- `target hms`, and serial protocol``: Hitachi Boards
- `target hms`, with H8/300``: H8/300
- `target hms`, with Hitachi SH``: SH
- `target lsi port`: MIPS Embedded
- `target m32r`: M32R/D
- `target mips port`: MIPS Embedded
- `target mon960`: i960
- `target nindy`: i960
- `target nrom`: Target Commands
- `target op50n`: PA
- target output in GDB/MI: GDB/MI Output Syntax
- `target pmon port`: MIPS Embedded
- `target ppcbug`: PowerPC
- `target ppcbug1`: PowerPC
- `target r3900`: MIPS Embedded
- `target rdi`: ARM
- `target rdp`: ARM
- `target remote`: Target Commands
- `target rom68k`: M68K
- `target rombug`: M68K
- `target sds`: PowerPC
- `target sh3`, with H8/300``: H8/300
- `target sh3`, with SH``: SH
- `target sh3e`, with H8/300``: H8/300
- `target sh3e`, with SH``: SH
- `target sim`: Target Commands
- `target sim`, with Z8000``: Z8000
- `target sparclite`: Sparclite
- `target vxworks`: VxWorks
- `target w89k`: PA
- `tbreak`: Set Breaks
- TCP port, `target remote`: Debug Session
- terminal: Input/Output
- `thbreak`: Set Breaks
- `this`, inside C`++` member functions``: C plus plus expressions
- `thread apply`: Threads
- thread breakpoints: Thread Stops
- thread identifier (GDB): Threads
- thread identifier (system): Threads
- thread identifier (system), on HP-UX: Threads
- thread number: Threads
- `thread threadno`: Threads
- threads and watchpoints: Set Watchpoints
- threads of execution: Threads
- threads, automatic switching: Threads
- threads, continuing: Thread Stops
- threads, stopped: Thread Stops
- `timeout`, MIPS protocol: MIPS Embedded
- tracebacks: Backtrace
- `transpose-chars (C-t)`: Commands For Text
- `transpose-words (M-t)`: Commands For Text
- `tty`: Input/Output
- type casting memory: Expressions
- type checking: Checks
- type conversions in C++: C plus plus expressions
- `u` (`until`)``: Continuing and Stepping
- UDI: A29K UDI
- `udi`: A29K UDI
- `undisplay`: Auto Display
- `undo (C-_, C-x C-u)`: Miscellaneous Commands
- `universal-argument ()`: Numeric Arguments
- `unix-line-discard (C-u)`: Commands For Killing
- `unix-word-rubout (C-w)`: Commands For Killing
- unknown address, locating: Output Formats
- `unset environment`: Environment
- `until`: Continuing and Stepping
- `up`: Selection
- `up-silently`: Selection
- `upcase-word (M-u)`: Commands For Text
- user-defined command: Define
- value history: Value History
- `value-begin`: Value Annotations
- `value-end`: Value Annotations
- `value-history-begin`: Value Annotations
- `value-history-end`: Value Annotations
- `value-history-value`: Value Annotations
- variable name conflict: Variables
- variable objects in GDB/MI: GDB/MI Variable Objects
- variable values, wrong: Variables
- variables, setting: Assignment
- version number: Help
- `visible-stats`: Readline Init File Syntax
- VxWorks: VxWorks
- `vxworks-timeout`: VxWorks
- `watch`: Set Watchpoints
- `watchpoint`: Annotations for Running
- watchpoints: Breakpoints
- watchpoints and threads: Set Watchpoints
- `whatis`: Symbols
- `where`: Backtrace
- `while`: Define
- wild pointer, interpreting: Print Settings
- word completion: Completion
- working directory: Source Path
- working directory (of your program): Working Directory
- working language: Languages
- writing into corefiles: Patching
- writing into executables: Patching
- wrong values: Variables
- `x` (examine memory)``: Memory
- `x`(examine), and`info line`: Machine Code
- XCOFF and C++: C plus plus expressions
- `yank (C-y)`: Commands For Killing
- `yank-last-arg (M-., M-_)`: Commands For History
- `yank-nth-arg (M-C-y)`: Commands For History
- `yank-pop (M-y)`: Commands For Killing
- yanking text: Readline Killing Commands
- Z8000: Z8000
- Zilog Z8000 simulator: Z8000
- {type}: Expressions

# Table of Contents

- Debugging with GDB
- Summary of GDB
  - Free software
  - Contributors to GDB
- A Sample GDB Session
- Getting In and Out of GDB
  - Invoking GDB
    - Choosing files
    - Choosing modes
  - Quitting GDB
  - Shell commands
- GDB Commands
  - Command syntax
  - Command completion
  - Getting help
- Running Programs Under GDB
  - Compiling for debugging
  - Starting your program
  - Your program's arguments
  - Your program's environment
  - Your program's working directory
  - Your program's input and output
  - Debugging an already-running process
  - Killing the child process
  - Debugging programs with multiple threads
  - Debugging programs with multiple processes
- Stopping and Continuing
  - Breakpoints, watchpoints, and catchpoints
    - Setting breakpoints
    - Setting watchpoints
    - Setting catchpoints
    - Deleting breakpoints
    - Disabling breakpoints
    - Break conditions
    - Breakpoint command lists
    - Breakpoint menus
    - "Cannot insert breakpoints"
  - Continuing and stepping
  - Signals
  - Stopping and starting multi-thread programs
- Examining the Stack
  - Stack frames
  - Backtraces
  - Selecting a frame
  - Information about a frame
- Examining Source Files
  - Printing source lines
  - Searching source files
  - Specifying source directories
  - Source and machine code
- Examining Data
  - Expressions
  - Program variables
  - Artificial arrays
  - Output formats
  - Examining memory
  - Automatic display
  - Print settings
  - Value history
  - Convenience variables
  - Registers
  - Floating point hardware
- Using GDB with Different Languages
  - Switching between source languages
    - List of filename extensions and languages
    - Setting the working language
    - Having GDB infer the source language
  - Displaying the language
  - Type and range checking
    - An overview of type checking
    - An overview of range checking
  - Supported languages
    - C and C++
      - C and C++ operators
      - C and C++ constants
      - C++ expressions
      - C and C++ defaults
      - C and C++ type and range checks
      - GDB and C
      - GDB features for C++
    - Modula-2
      - Operators
      - Built-in functions and procedures
      - Constants
      - Modula-2 defaults
      - Deviations from standard Modula-2
      - Modula-2 type and range checks
      - The scope operators `::` and `.`
      - GDB and Modula-2
    - Chill
      - How modes are displayed
      - Locations and their accesses
      - Values and their Operations
      - Chill type and range checks
      - Chill defaults
- Examining the Symbol Table
- Altering Execution
  - Assignment to variables
  - Continuing at a different address
  - Giving your program a signal
  - Returning from a function
  - Calling program functions
  - Patching programs
- GDB Files
  - Commands to specify files
  - Errors reading symbol files
- Specifying a Debugging Target
  - Active targets
  - Commands for managing targets
  - Choosing target byte order
  - Remote debugging
    - The GDB remote serial protocol
      - What the stub can do for you
      - What you must do for the stub
      - Putting it all together
      - Communication protocol
      - Using the `gdbserver` program
      - Using the `gdbserve.nlm` program
  - Kernel Object Display
- Configuration-Specific Information
  - Native
    - HP-UX
    - SVR4 process information
  - Embedded Operating Systems
    - Using GDB with VxWorks
      - Connecting to VxWorks
      - VxWorks download
      - Running tasks
  - Embedded Processors
    - AMD A29K Embedded
      - A29K UDI
      - EBMON protocol for AMD29K
      - Communications setup
      - EB29K cross-debugging
      - Remote log
    - ARM
    - Hitachi H8/300
      - Connecting to Hitachi boards
      - Using the E7000 in-circuit emulator
      - Special GDB commands for Hitachi micros
    - H8/500
    - Intel i960
      - Startup with Nindy
      - Options for Nindy
      - Nindy reset command
    - Mitsubishi M32R/D
    - M68k
    - M88K
    - MIPS Embedded
    - PowerPC
    - HP PA Embedded
    - Hitachi SH
    - Tsqware Sparclet
      - Setting file to debug
      - Connecting to Sparclet
      - Sparclet download
      - Running and debugging
    - Fujitsu Sparclite
    - Tandem ST2000
    - Zilog Z8000
  - Architectures
    - A29K
    - Alpha
    - MIPS
- Controlling GDB
  - Prompt
  - Command editing
  - Command history
  - Screen size
  - Numbers
  - Optional warnings and messages
  - Optional messages about internal happenings
- Canned Sequences of Commands
  - User-defined commands
  - User-defined command hooks
  - Command files
  - Commands for controlled output
- Using GDB under GNU Emacs
- GDB Annotations
  - What is an Annotation?
  - The Server Prefix
  - Values
  - Frames
  - Displays
  - Annotation for GDB Input
  - Errors
  - Information on Breakpoints
  - Invalidation Notices
  - Running the Program
  - Displaying Source
  - Annotations We Might Want in the Future
- The GDB/MI Interface
  - Function and Purpose
  - Notation and Terminology
  - GDB/MI Command Syntax
    - GDB/MI Input Syntax
    - GDB/MI Output Syntax
    - Simple Examples of GDB/MI Interaction
  - GDB/MI Compatibility with CLI
  - GDB/MI Output Records
    - GDB/MI Result Records
    - GDB/MI Stream Records
    - GDB/MI Out-of-band Records
  - GDB/MI Command Description Format
  - GDB/MI Breakpoint table commands
  - GDB/MI Data Manipulation
  - GDB/MI Program control
  - Miscellaneous GDB commands in GDB/MI
  - Stack manipulation commands in GDB/MI
  - GDB/MI Symbol Query Commands
  - GDB/MI Target Manipulation Commands
  - GDB/MI Thread Commands
  - GDB/MI Tracepoint Commands
  - GDB/MI Variable Objects
  - GDB/MI Draft Changes to Output Syntax
- Reporting Bugs in GDB
  - Have you found a bug?
  - How to report bugs
- Command Line Editing
  - Introduction to Line Editing
  - Readline Interaction
    - Readline Bare Essentials
    - Readline Movement Commands
    - Readline Killing Commands
    - Readline Arguments
    - Searching for Commands in the History
  - Readline Init File
    - Readline Init File Syntax
    - Conditional Init Constructs
    - Sample Init File
  - Bindable Readline Commands
    - Commands For Moving
    - Commands For Manipulating The History
    - Commands For Changing Text
    - Killing And Yanking
    - Specifying Numeric Arguments
    - Letting Readline Type For You
    - Keyboard Macros
    - Some Miscellaneous Commands
  - Readline vi Mode
- Using History Interactively
  - History Expansion
    - Event Designators
    - Word Designators
    - Modifiers
- Formatting Documentation
- Installing GDB
  - Compiling GDB in another directory
  - Specifying names for hosts and targets
  - `configure` options
- Index

#### Footnotes

1. GDB built with DJGPP tools for MS-DOS/MS-Windows supports this mode of operation, but the event loop is suspended when the debuggee runs.

2. `b` cannot be used because these format letters are also used with the `x` command, where `b` stands for "byte"; see Examining memory.

3. This is a way of removing one word from the stack, on machines where stacks grow downward in memory (most machines, nowadays). This assumes that the innermost stack frame is selected; setting `$sp` is not allowed when other stack frames are selected. To pop entire frames off the stack, regardless of machine architecture, use `return`; see Returning from a function.

4. If a procedure call is used for instance in an expression, then this procedure is called with all its side effects. This can lead to confusing results if used carelessly.

5. If you choose a port number that conflicts with another service, `gdbserver` prints an error message and exits.

6. On DOS/Windows systems, the home directory is the one pointed to by the `HOME` environment variable.

7. In `gdb-5.0/gdb/refcard.ps` of the version 5.0 release.