Debugging With GDB
Debugging With GDB
Debugging With GDB
Copyright
c 1988, '89, '90, '91, '92, '93 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this manual provided the copyright
notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modied versions of this manual under the conditions
for verbatim copying, provided also that the entire resulting derived work is distributed under the
terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another language,
under the above conditions for modied versions.
Summary of GDB 1
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 aect its behavior.
Make your program stop on specied conditions.
Examine what has happened, when your program has stopped.
Change things in your program, so you can experiment with correcting the eects of one bug
and go on to learn about another.
You can use GDB to debug programs written in C or C++. For more information, see Sec-
tion 9.4.1 [C and C++], page 90.
Support for Modula-2 and Chill is partial. For information on Modula-2, see Section 9.4.2
[Modula-2], page 95. There is no further documentation on Chill yet.
Debugging Pascal programs which use sets, subranges, le 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 does not
yet support entering expressions, printing values, or similar features using Fortran syntax. It may
be necessary to refer to some variables with a trailing underscore.
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.
2 Debugging with GDB
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 le `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 long labor as thankless, we particularly thank those who
shepherded GDB through major releases: Fred Fish (releases 4.12, 4.11, 4.10, 4.9), Stu Grossman
and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, 4.4), John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9);
Jim Kingdon (releases 3.5, 3.4, 3.3); and Randy Smith (releases 3.2, 3.1, 3.0). As major maintainer
of GDB for some period, each contributed signicantly to the structure, stability, and capabilities
of the entire debugger.
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 signicant
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-le 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.
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
Summary of GDB 3
Hasei contributed Sony/News OS 3 support. David Johnson contributed Encore Umax support.
Jyrki Kuoppala contributed Altos 3068 support. Keith Packard contributed NS32K support. Doug
Rabson contributed Acorn Risc Machine 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.
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 debug-
ging. Intel Corporation and Wind River Systems contributed remote debugging modules for their
products.
Brian Fox is the author of the readline libraries providing command-line editing and command
history.
Andrew Beers of SUNY Bualo 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.
and info catch: GDB can break when an exception is raised, before the stack is peeled
back to the exception handler's context.
Modula-2 GDB now has preliminary support for the GNU Modula-2 compiler, currently under
development at the State University of New York at Bualo. Coordinated development
of both GDB and the GNU Modula-2 compiler will continue. Other Modula-2 compilers
are currently not supported, and attempting to debug programs compiled with them
will likely result in an error as the symbol table of the executable is read in.
Command Rationalization
Many GDB commands have been renamed to make them easier to remember and use.
In particular, the subcommands of info and show/set are grouped to make the former
refer to the state of your program, and the latter refer to the state of GDB itself.
See Appendix C [Renamed Commands], page 171, for details on what commands were
renamed.
Shared Libraries
GDB 4 can debug programs and core les that use SunOS, SVR4, or IBM RS/6000
shared libraries.
Threads On some systems, GDB 4 has facilities to debug multi-thread programs.
Reference Card
GDB 4 has a reference card. See Appendix D [Formatting the Documentation],
page 173, for instructions about how to print it.
Chapter 1: A Sample GDB Session 7
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.
In this sample session, we emphasize user input like this: input, to make it easier to pick out
from the surrounding output.
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 denition within another stop working. In the following short m4 session, we dene a
macro foo which expands to 0000; we then use the m4 built-in defn to dene 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 dene a new synonym baz:
$ cd gnu/m4
$ ./m4
dene(foo,0000)
foo
0000
dene(bar,defn(`foo'))
bar
0000
changequote(<QUOTE>,<UNQUOTE>)
dene(baz,defn(<QUOTE>foo<UNQUOTE>))
baz
C-d
m4: End of input: 0: fatal error: EOF in string
$ 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 4.12, Copyright 1993 Free Software Foundation, Inc...
(gdb)
8 Debugging with GDB
GDB reads only enough symbol data to know where to nd the rest when needed; as a result, the
rst prompt comes up very quickly. We now tell GDB to use a narrower display width than usual,
so that examples t in this manual.
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.
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
dene(foo,0000)
foo
0000
To trigger the breakpoint, we call changequote. GDB suspends execution of m4, displaying infor-
mation 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.
Chapter 1: A Sample GDB Session 9
(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 rst 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 specied. We use the command p (print) to
see their values.
(gdb) p lquote
$1 = 0x35d40 "<QUOTE>"
(gdb) p rquote
$2 = 0x35d50 "<UNQUOTE>"
10 Debugging with GDB
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.
Is that enough to x 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
Chapter 1: A Sample GDB Session 11
Continuing.
dene(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 dening 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 nished executing. We
can end our GDB session with the GDB quit command.
(gdb) quit
12 Debugging with GDB
Chapter 2: Getting In and Out of GDB 13
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 eectively 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 le specied:
You can, instead, specify a process ID as a second argument, if you want to debug a running
process:
would attach GDB to process 1234 (unless you also have a le named `1234'; GDB does check for
a core le rst).
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.
14 Debugging with GDB
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 brie y 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 dierence when the `-x' option is used.
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
ag option arguments with `--' rather than `-', though we
illustrate the more usual convention.)
-symbols le
-s le Read symbol table from le le.
-exec le
-e le Use le le as the executable le to execute when appropriate, and for examining pure
data in conjunction with a core dump.
-se le Read symbol table from le le and use it as the executable le.
-core le
-c le Use le le as a core dump to examine.
Chapter 2: Getting In and Out of GDB 15
-c number
Connect to process ID number, as with the attach command (unless there is a le in
core-dump format named number, in which case `-c' species that le as a core dump
to read).
-command le
-x le Execute GDB commands from le le. See Section 15.3 [Command les], page 149.
-directory directory
-d directory
Add directory to the path to search for source les.
-m
-mapped Warning: this option depends on operating system facilities that are not supported on
all systems.
If memory-mapped les 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
le in the current directory. If the program you are debugging is called `/tmp/fred',
the mapped symbol le is `./fred.syms'. Future GDB debugging sessions notice the
presence of this le, and can quickly map in symbol information from it, rather than
reading the symbol table from the executable program.
The `.syms' le is specic 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 le'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.
The -mapped and -readnow options are typically combined in order to build a `.syms' le that
contains complete symbol information. (See Section 12.1 [Commands to specify les], page 113, for
information on `.syms' les.) A simple GDB invocation to do nothing but build a `.syms' le for
future use is:
-nx
-n Do not execute commands from any initialization les (normally called `.gdbinit').
Normally, the commands in these les are executed after all the command options and
arguments have been processed. See Section 15.3 [Command les], page 149.
-quiet
-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 les specied
with `-x' (and all commands from initialization les, if not inhibited with `-n'). Exit
with nonzero status if an error occurs in executing the GDB commands in the command
les.
Batch mode may be useful for running GDB as a lter, 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.
-cd directory
Run GDB using directory as its working directory, instead of the current directory.
-fullname
-f Emacs sets this option when it runs GDB as a subprocess. It tells GDB to output the
full le 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 le 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.
-b bps Set the line speed (baud rate or bits per second) of any serial interface used by GDB
for remote debugging.
-tty device
Run using device for your program's standard input and output.
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 eect 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 Section 4.7 [Debugging an already-running process], page 30).
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 specied arguments. This is equivalent to `shell
make make-args'.
18 Debugging with GDB
Chapter 3: GDB Commands 19
3 GDB Commands
You can abbreviate a GDB command to the rst 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 ll out the rest of a word in a command (or to show you
the alternatives available, if there is more than one possibility).
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 dened 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 Section 14.4 [Screen size], page 143). 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 les (see Section 15.3 [Command les], page 149).
20 Debugging with GDB
Press the TAB key whenever you want GDB to ll out the rest of a word. If there is only one
possibility, GDB lls in the word, and waits for you to nish the command (or press RET to enter
it). For example, if you type
GDB lls in the rest of the word `breakpoints', since that is the only info subcommand beginning
with `bre':
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 rst 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:
After displaying the available possibilities, GDB copies your partial input (`b make_' in the example)
so you can nish the command.
Chapter 3: GDB Commands 21
If you just want to see the list of alternatives in the rst 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 denitions 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:
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 rst place:
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.
help
h You can use help (abbreviated h) with no arguments to display a short list of named
classes of commands:
22 Debugging with GDB
(gdb) help
List of classes of commands:
List of commands:
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], page 181.
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
Chapter 3: GDB Commands 23
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.
show In contrast, 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 corre-
sponding 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 occasion-
ally want to determine which version of GDB you are running; as GDB evolves, new
commands are introduced, and old ones may wither away. The version number is also
announced when you start GDB.
show copying
Display information about permission for copying GDB.
show warranty
Display the GNU \NO WARRANTY" statement.
24 Debugging with GDB
Chapter 4: Running Programs Under GDB 25
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 le! An extreme example: if you dene 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 xes the problem, please
report it as a bug (including a test case!).
Older versions of the GNU C compiler permitted a variant option `-gg' for debugging informa-
tion. GDB no longer supports this format; if your GNU C compiler has this option, do not use
it.
26 Debugging with GDB
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 aected 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 aect 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 Section 4.3 [Your program's arguments], page 27.
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 environ-
ment that aect your program. See Section 4.4 [Your program's environment], page 27.
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 Section 4.5 [Your program's working
directory], page 29.
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
Chapter 4: Running Programs Under GDB 27
can use the tty command to set a dierent device for your program. See Section 4.6
[Your program's input and output], page 29.
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 Chapter 5
[Stopping and continuing], page 35, 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 Chapter 8 [Examining Data], page 65.
If the modication time of your symbol le 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.
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.
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 modied environment without having to start GDB over again.
path directory
Add directory to the front of the PATH environment variable (the search path for exe-
cutables), for both GDB and your program. You may specify several directory names,
separated by `:' or whitespace. 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 a Unix 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 dierent from `set env varname ='; unset environment removes the variable from
the environment, rather than assigning it an empty value.
Warning: 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 le|
such as `.cshrc' for C-shell, or `.bashrc' for BASH|any variables you set in that le aect your
program. You may wish to move setting of environment variables to les that are only run when
you sign on, such as `.login' or `.profile'.
Chapter 4: Running Programs Under GDB 29
The GDB working directory also serves as a default for the commands that specify les for GDB
to operate on. See Section 12.1 [Commands to specify les], page 113.
cd directory
Set the GDB working directory to directory.
pwd Print the GDB working directory.
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 com-
mand. For example,
run > outfile
Another way to specify where your program should do input and output is with the tty com-
mand. This command accepts a le name as argument, and causes this le to be the default for
future run commands. It also resets the controlling terminal for the child process, for future run
commands. For example,
30 Debugging with GDB
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 eect on the input/output device,
but not its eect on the controlling terminal.
When you use the tty command or redirect input in the run command, only the input for your
program is aected. The input for GDB still comes from your terminal.
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 using attach, you should rst use the file command to specify the program running in
the process and load its symbol table. See Section 12.1 [Commands to Specify Files], page 113.
The rst thing GDB does after arranging to debug the specied 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 nished debugging the attached process, you can use the detach com-
mand to release it from GDB control. Detaching the process continues its execution.
After the detach command, that process and GDB become completely independent
Chapter 4: Running Programs Under GDB 31
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 conrmation if you try to do either of these things; you can
control whether or not you need to conrm by using the set confirm command (see Section 14.6
[Optional warnings and messages], page 144).
This command is useful if you wish to debug a core dump instead of a running process. GDB
ignores any core dump le while your program is running.
On some operating systems, a program cannot be executed outside GDB while you have break-
points 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 le while it is running in a process. In this
case, when you next type run, GDB notices that the le has changed, and reads the symbol table
again (while trying to preserve your current breakpoint settings).
Warning: These facilities are not yet available on every GDB conguration where
the operating system supports threads. If your GDB does not support threads, these
commands have no eect. For example, a system without thread support shows no
output from `info threads', and always rejects the thread command, like this:
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 identi-
cation for the thread with a message in the form `[New systag ]'. systag is a thread identier 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 qualier.
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 identier (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
thread threadno
Make thread number threadno the current thread. The command argument threadno
is the internal GDB thread number, as shown in the rst eld of the `info threads'
display. GDB responds by displaying the system identier of the thread you selected,
and its current stack frame summary:
(gdb) thread 2
[Switching to process 35 thread 23]
34 Debugging with GDB
0x34e5 in sigpause ()
As with the `[New ]' message, the form of the text after `Switching to' depends on
:::
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 Section 5.4 [Stopping and starting multi-thread programs], page 51, for more information
about how GDB behaves when you stop and start programs with multiple threads.
See Section 5.1.2 [Setting watchpoints], page 39, for information about watchpoints in programs
with multiple threads.
Chapter 5: Stopping and Continuing 35
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.
A watchpoint is a special breakpoint that stops your program when the value of an expression
changes. You must use a dierent command to set watchpoints (see Section 5.1.2 [Setting watch-
points], page 39), 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 Section 8.6 [Automatic display], page 71.
GDB assigns a number to each breakpoint or watchpoint 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
36 Debugging with GDB
breakpoint may be enabled or disabled; if disabled, it has no eect on your program until you
enable it again.
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 Section 5.1.8 [Breakpoint menus], page 45, for a discussion
of that situation.
break +oset
break -oset
Set a breakpoint some number of lines forward or back from the position at which
execution stopped in the currently selected frame.
break linenum
Set a breakpoint at line linenum in the current source le. That le is the last le whose
source text was printed. This breakpoint stops your program just before it executes
any of the code on that line.
break lename :linenum
Set a breakpoint at line linenum in source le lename.
break lename :function
Set a breakpoint at entry to function function found in le lename. Specifying a
le name as well as a function name is super
uous except when multiple les 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 les.
break When called without any arguments, break sets a breakpoint at the next instruction to
be executed in the selected stack frame (see Chapter 6 [Examining the Stack], page 53).
In any selected frame but the innermost, this makes your program stop as soon as
Chapter 5: Stopping and Continuing 37
control returns to that frame. This is similar to the eect 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 in-
struction has been executed. If it did not do this, you would be unable to proceed past
a breakpoint without rst 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 Section 5.1.6 [Break conditions], page 42, for more
information on breakpoint conditions.
tbreak args
Set a breakpoint enabled only for one stop. args are the same as for the break com-
mand, and the breakpoint is set in the same way, but the breakpoint is automatically
disabled after the rst time your program stops there. See Section 5.1.5 [Disabling
breakpoints], page 41.
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.
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 and watchpoints set and not deleted, with the following
columns for each breakpoint:
Breakpoint Numbers
Type Breakpoint or watchpoint.
Disposition
Whether the breakpoint is marked to be disabled or deleted when hit.
38 Debugging with GDB
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 le and line
number.
If a breakpoint is conditional, info break shows the condition on the line following the
aected 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 Section 8.5 [Examining memory], page 69).
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 Section 5.1.6 [Break conditions], page 42).
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'.
Watchpoints currently execute two orders of magnitude more slowly than other breakpoints,
but this can be well worth it to catch errors where you have no clue what part of your program is
the culprit.
watch expr
Set a watchpoint for an expression.
info watchpoints
This command prints a list of watchpoints and breakpoints; it is the same as info
break.
catch exceptions
You can set breakpoints at active exception handlers by using the catch command.
exceptions is a list of names of exceptions to catch.
You can use info catch to list active exception handlers. See Section 6.4 [Information about a
frame], page 56.
If you call a function interactively, GDB normally returns control to you when the function has
nished executing. If the call raises an exception, however, the call may bypass the mechanism
that returns control to you and cause your program to simply continue running until it hits a
breakpoint, catches a signal that GDB is listening for, or exits.
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 nd out where the exception was raised.
To stop just before an exception handler is called, you need some knowledge of the imple-
mentation. 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 Section 5.1 [Breakpoints; watchpoints; and exceptions], page 35).
With a conditional breakpoint (see Section 5.1.6 [Break conditions], page 42) that depends on
the value of id, you can stop your program when a specic exception is raised. You can use multiple
conditional breakpoints to stop your program when any of a number of exceptions are raised.
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 or watchpoints by
specifying their breakpoint numbers.
Chapter 5: Stopping and Continuing 41
It is not necessary to delete a breakpoint to proceed past it. GDB automatically ignores break-
points on the rst 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 Section 6.3 [Selecting a frame], page 55). When the innermost frame is
selected, this is a good way to delete a breakpoint where your program just stopped.
clear function
clear lename :function
Delete any breakpoints set at entry to the function function.
clear linenum
clear lename :linenum
Delete any breakpoints set at or within the code of the specied line.
delete [breakpoints] [bnums ] :::
You disable and enable breakpoints and watchpoints 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 or watchpoints if you do not know which numbers to use.
Enabled. The breakpoint stops your program. A breakpoint set with the break command
starts out in this state.
Disabled. The breakpoint has no eect on your program.
Enabled once. The breakpoint stops your program, but then becomes disabled. A breakpoint
set with the tbreak command starts out in this state.
Enabled for deletion. The breakpoint stops your program, but immediately after it does so it
is deleted permanently.
42 Debugging with GDB
You can use the following commands to enable or disable breakpoints and watchpoints:
Disable the specied breakpoints|or all breakpoints, if none are listed. A disabled
breakpoint has no eect but is not forgotten. All options such as ignore-counts, con-
ditions and commands are remembered in case the breakpoint is enabled again later.
You may abbreviate disable as dis.
enable [breakpoints] [bnums ]
:::
Enable the specied breakpoints (or all dened breakpoints). They become eective
once again in stopping your program.
enable [breakpoints] once bnums :::
Enable the specied breakpoints temporarily. GDB disables any of these breakpoints
immediately after stopping your program.
enable [breakpoints] delete bnums :::
Enable the specied breakpoints to work once, then die. GDB deletes any of these
breakpoints as soon as your program stops there.
Save for a breakpoint set with tbreak (see Section 5.1.1 [Setting breakpoints], page 36), break-
points 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 Section 5.2 [Continuing and
stepping], page 47.)
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.
Chapter 5: Stopping and Continuing 43
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 eects, 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 eects are completely predictable unless
there is another enabled breakpoint at the same address. (In that case, GDB might see the other
breakpoint rst and stop your program without checking the condition of this one.) Note that
breakpoint commands are usually more convenient and
exible for the purpose of performing side
eects when a breakpoint is reached (see Section 5.1.7 [Breakpoint command lists], page 44).
Break conditions can be specied when a breakpoint is set, by using `if' in the arguments to
the break command. See Section 5.1.1 [Setting breakpoints], page 36. They can also be changed at
any time with the condition command. The watch command does not recognize the if keyword;
condition is the only way to impose a further condition on a watchpoint.
condition bnum
Remove the condition from breakpoint number bnum. It becomes an ordinary uncon-
ditional 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 eect. 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.
44 Debugging with GDB
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 com-
mands.
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 or watchpoint 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
Chapter 5: Stopping and Continuing 45
encounter another breakpoint|which could have its own command list, leading to ambiguities
about which list to execute.
If the rst 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 specic
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 Section 15.4 [Commands for controlled output], page 150.
For example, here is how you could use breakpoint commands to print the value of x at entry
to foo whenever x is positive.
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
this is a problem, you can use something like `break function(types )' to specify which particular
version of the function you want. Otherwise, GDB oers you a menu of numbered choices for
dierent possible breakpoints, and waits for your selection with the prompt `>'. The rst two
options are always `[0] cancel' and `[1] all'. Typing 1 sets a breakpoint at each denition 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 denitions 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)
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 eect is like that of ignore (see Section 5.1.6 [Break conditions], page 42).
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 are provided purely for convenience, and have exactly the same
behavior as continue.
To resume execution at a dierent place, you can use return (see Section 11.4 [Returning from
a function], page 109) to go back to the calling function; or jump (see Section 11.2 [Continuing at
a dierent address], page 108) to go to an arbitrary location in your program.
A typical technique for using stepping is to set a breakpoint (see Section 5.1 [Breakpoints;
watchpoints; and exceptions], page 35) 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 dierent 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.
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.
48 Debugging with GDB
next [count]
Continue to the next source line in the current (innermost) stack frame. Similar to
step, but any function calls appearing within the line of code are executed without
stopping. Execution stops when control reaches a dierent line of code at the stack level
which was executing when the next command was given. This command is abbreviated
n.
An argument count is a repeat count, as for step.
next within a function that lacks debugging information acts like step, but any function
calls appearing within the code of the function are executed without stopping.
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 Section 11.4 [Returning from a function],
page 109).
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 eciency, 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.
Chapter 5: Stopping and Continuing 49
until location
u location Continue running your program until either the specied location is reached, or the
current stack frame returns. location is any of the forms of argument acceptable to
break (see Section 5.1.1 [Setting breakpoints], page 36). This form of the command
uses breakpoints, and hence is quicker than until without an argument.
stepi
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 Section 8.6 [Automatic display], page 71.
An argument is a repeat count, as in step.
nexti
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.
5.3 Signals
A signal is an asynchronous event that can happen in a program. The operating system denes
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 (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 o (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 (kill your program immediately) if the
program has not specied 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.
50 Debugging with GDB
info signals
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 dened types of 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 until you continue. Your program
sees the signal then, if pass is in eect 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 Section 11.3 [Giving your program a signal], page 109.
Chapter 5: Stopping and Continuing 51
Use the qualier `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 identiers assigned by GDB, shown in the rst
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 qualier 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 nd 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 rst thread completes whatever you requested.
52 Debugging with GDB
Chapter 6: Examining the Stack 53
Each time your program performs a function call, the information about where in your program
the call was made from is saved in a block of data called a stack frame. The frame also contains the
arguments of the call and the local variables of the function that was called. All 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.
When your program stops, GDB automatically selects the currently executing frame and de-
scribes it brie
y as the frame command does (see Section 6.4 [Information about a frame], page 56).
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 identied 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
54 Debugging with GDB
one of those bytes 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.
6.2 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
le 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.
Chapter 6: Examining the Stack 55
Here is an example of a backtrace. It was made with the command `bt 3', so it shows the
innermost three frames.
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.
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.
up n Move n frames up the stack. For positive numbers n, this advances toward the outer-
most 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.
56 Debugging with GDB
All of these commands end by printing two lines of output describing the frame. The rst line
shows the frame number, the function name, the arguments, and the source le 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 Section 7.1 [Printing source lines], page 59.
up-silently n
down-silently n
These two commands are variants of up and down, respectively; they dier 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.
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
Section 6.3 [Selecting a frame], page 55.
info frame
info f This command prints a verbose description of the selected stack frame, including the
address of the frame, the addresses of the next frame down (called by this frame) and the
next frame up (caller of this frame), the language that the source code corresponding to
this frame was written in, the address of the frame's arguments, the program counter
saved in it (the address of execution in the caller frame), and 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 t the usual conventions.
Chapter 6: Examining the Stack 57
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 Section 5.1.3
[Breakpoints and exceptions], page 39.
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:
These commands are available only when GDB is congured for debugging programs on MIPS
processors.
58 Debugging with GDB
Chapter 7: Examining Source Files 59
If you use GDB through its GNU Emacs interface, you may prefer to use Emacs facilities to
view source; see Chapter 16 [Using GDB under GNU Emacs], page 151.
Here are the forms of the list command most commonly used:
list linenum
Print lines centered around line number linenum in the current source le.
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 Chapter 6 [Examining the
Stack], page 53), 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:
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 le.
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 eect 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 specied by linespec.
list rst,last
Print lines from rst to last. Both arguments are linespecs.
list ,last Print lines ending with last.
list rst,
Print lines starting with rst.
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 Species line number of the current source le. When a list command has two
linespecs, this refers to the same source le as the rst linespec.
+oset Species the line oset lines after the last line printed. When used as the second
linespec in a list command that has two, this species the line oset lines down from
the rst linespec.
-oset Species the line oset lines before the last line printed.
lename :number
Species line number in the source le lename.
function Species the line of the open-brace that begins the body of the function function.
Chapter 7: Examining Source Files 61
lename :function
Species the line of the open-brace that begins the body of the function function in
the le lename. You only need the le name with a function name to avoid ambiguity
when there are identically named functions in dierent source les.
*address Species the line containing the program address address. address may be any expres-
sion.
forward-search regexp
search regexp
The command `forward-search regexp' checks each line, starting with the one follow-
ing the last line listed, for a match for regexp. It lists the line that is found. You can
use 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.
If GDB cannot nd a source le 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.
62 Debugging with GDB
Whenever you reset or rearrange the source path, GDB clears out any information it has cached
about where source les are found and where each line is in the le.
When you start GDB, its source path is empty. To add other directories, use the directory
command.
Add directory dirname to the front of the source path. Several directory names may
be given to this command, separated by `:' 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 conrmation.
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 some-
times cause confusion by nding the wrong versions of source. You can correct the situation as
follows:
For example, we can use info line to discover the location of the object code for the rst line
of function m4_changequote:
(gdb) info line m4_changecom
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 sucient to begin examining the machine code (see Section 8.5 [Examining
memory], page 69). Also, this address is saved as the value of the convenience variable $_ (see
Section 8.9 [Convenience variables], page 80).
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 (rst
inclusive, second exclusive) to dump.
We can use disassemble to inspect the object code range shown in the last info line example
(the example shows SPARC machine instructions):
(gdb) disas 0x63e4 0x6404
Dump of assembler code from 0x63e4 to 0x6404:
0x63e4 <builtin_init+5340>: ble 0x63f8 <builtin_init+5360>
0x63e8 <builtin_init+5344>: sethi %hi(0x4c00), %o0
0x63ec <builtin_init+5348>: ld [%i1+4], %o0
0x63f0 <builtin_init+5352>: b 0x63fc <builtin_init+5364>
0x63f4 <builtin_init+5356>: ld [%o0+4], %o0
0x63f8 <builtin_init+5360>: or %o0, 0x1a4, %o0
0x63fc <builtin_init+5364>: call 0x9288 <path_search>
0x6400 <builtin_init+5368>: nop
End of assembler dump.
64 Debugging with GDB
Chapter 8: Examining Data 65
8 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 Chapter 9 [Using GDB with Dierent Languages], page 85).
print exp
print /f exp
exp is an expression (in the source language). By default the value of exp is printed in
a format appropriate to its data type; you can choose a dierent format by specifying
`/f ', where f is a letter specifying the format; see Section 8.4 [Output formats], page 68.
print
print /f If you omit exp, GDB displays the last value again (from the value history; see Sec-
tion 8.8 [Value history], page 78). 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 specied address and prints it in a specied format. See Section 8.5 [Examining memory],
page 69.
If you are interested in information about types, or about how the elds of a struct or class are
declared, use the ptype exp command rather than print. See Chapter 10 [Examining the Symbol
Table], page 103.
8.1 Expressions
print and many other GDB commands accept an expression and compute its value. Any kind
of constant, variable or operator dened 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 dened by preprocessor #define commands.
Because C is so widespread, most of the expressions shown in examples in this manual are in
C. See Chapter 9 [Using GDB with Dierent Languages], page 85, 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.
66 Debugging with GDB
Casts are supported in all languages, not just in C, because it is so useful to cast a number into
a pointer so as to examine a structure at that address in memory.
@ `@' is a binary operator for treating parts of memory as arrays. See Section 8.3 [Articial
arrays], page 67, for more information.
:: `::' allows you to specify a variable in terms of the le or function where it is dened.
See Section 8.2 [Program variables], page 66.
{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.
Variables in expressions are understood in the selected stack frame (see Section 6.3 [Selecting a
frame], page 55); they must either be global (or static) or be 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.
Chapter 8: Examining Data 67
There is an exception: you can refer to a variable or function whose scope is a single source le
even if the current execution point is not in this le. But it is possible to have more than one such
variable or function with the same name (in dierent source les). If that happens, referring to
that name has unpredictable eects. If you wish, you can specify a static variable in a particular
function or le, using the colon-colon notation:
le ::variable
function::variable
Here le or function is the name of the context for the static variable. In the case of le names,
you can use quotes to make sure GDB parses the le name as a single word|for example, to print
a global value of x dened in `f2.c':
(gdb) p 'f2.c'::x
This use of `::' is very rarely in con
ict 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 denitions); 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 denitions may be gone.
You can do this by referring to a contiguous span of memory as an articial array, using the
binary operator `@'. The left operand of `@' should be the rst element of the desired array, as 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 rst element is actually
68 Debugging with GDB
the left argument; the second element comes from bytes of memory immediately following those
that hold the rst element, and so on. Here is an example. If a program says
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.
Articial arrays most often appear in expressions via the value history (see Section 8.8 [Value
history], page 78), after printing one out.
Sometimes the articial 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 Section 8.9 [Convenience variables], page 80) as a counter in an expression that prints
the rst 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 eld fv in each
structure. Here is an example of what you might type:
set $i = 0
p dtab[$i++]->fv
RET
RET
:::
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:
Chapter 8: Examining Data 69
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".1
a Print as an address, both absolute in hexadecimal and as an oset 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>
For example, to print the program counter in hex (see Section 8.10 [Registers], page 81), 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 dierent format, you can use the print
command with just a format and no expression. For example, `p/x' reprints the last value in hex.
x/nfu addr
x addr
x Use the x command to examine memory.
1
`b' cannot be used because these format letters are also used with the x command, where `b'
stands for \byte"; see Section 8.5 [Examining memory], page 69.
70 Debugging with GDB
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.
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 Section 8.10 [Registers], page 81) 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 rst; either order works. The
Chapter 8: Examining Data 71
output specications `4xw' and `4wx' mean exactly the same thing. (However, the count n must
come rst; `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' species that you want to see three machine instructions, including any
operands. The command disassemble gives an alternative way of inspecting machine instructions;
see Section 7.4 [Source and machine code], page 62.
All the defaults for the arguments to x are designed to make it easy to continue scanning
memory with minimal specications 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.
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 specication is|it uses x if you
72 Debugging with GDB
specify a unit size, or one of the two formats (`i' and `s') that are only supported by x; otherwise
it uses print.
display exp
Add the expression exp to the list of expressions to display each time your program
stops. See Section 8.1 [Expressions], page 65.
display does not repeat if you press RET again after using it.
display/fmt exp
For fmt specifying only a display format and not a size or count, add the expression
exp to the auto-display list but arrange to display it each time in the specied format
fmt. See Section 8.4 [Output formats], page 68.
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 eect doing `x/fmt addr'. See Section 8.5 [Examining memory], page 69.
For example, `display/i $pc' can be helpful, to see the machine instruction about to be exe-
cuted each time execution stops (`$pc' is a common name for the program counter; see Section 8.10
[Registers], page 81).
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 eective 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.
Chapter 8: Examining Data 73
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 dened. 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.
When GDB prints a symbolic address, it normally prints the closest earlier symbol plus an
oset. If that symbol does not uniquely identify the address (for example, it is a name whose scope
is a single source le), you may need to disambiguate. One way to do this is with info line,
for example `info line *0x4537'. Alternately, you can set GDB to print the source le and line
number when it prints a symbolic address:
Another situation where it is helpful to show symbol lenames and line numbers is when disas-
sembling code; GDB shows you the line number and source le 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:
Sometimes GDB can tell you more about an address if it does an extensive search of its symbol
information. The default is to provide a quick symbolic display that is usually correct, but which
may not give the most useful answer when working in some object le formats. If you are not
getting the information you need, try:
If you have a pointer and you are not sure where it points, try `set print symbol-filename
on' and `set print fast-symbolic-addr off'. Then you can determine the name and source le
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, dened in
`hi2.c':
(gdb) set print fast-symbolic-addr off
(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 lename of the referent, even with the appropriate set print options turned
on.
struct thing {
Species it;
union {
Tree_forms tree;
Bug_forms bug;
} form;
};
arm Decode using the algorithm in the C++ Annotated Reference Manual.
Warning: this setting alone is not sucient to allow debugging cfront-
generated executables. GDB would require further enhancement to permit
that.
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 vtbl
set print vtbl on
Pretty print C++ virtual function tables. The default is o.
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.
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
Chapter 8: Examining Data 79
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 suces 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,
produces no display.
Pressing RET to repeat show values n has exactly the same eect as `show values +'.
80 Debugging with GDB
Convenience variables are prexed with `$'. Any name preceded by `$' can be used for a conve-
nience variable, unless it is one of the predened machine-specic register names (see Section 8.10
[Registers], page 81). (Value history references, in contrast, are numbers preceded by `$'. See
Section 8.8 [Value history], page 78.)
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 rst 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 xed 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 dierent 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
con.
Some convenience variables are created automatically by GDB and given values likely to be
useful.
Chapter 8: Examining Data 81
$_ The variable $_ is automatically set by the x command to the last address examined
(see Section 8.5 [Examining memory], page 69). 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.
8.10 Registers
You can refer to machine register contents, in expressions, as variables with names starting with
`$'. The names of registers are dierent 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
oating-point registers (in the selected
stack frame).
info all-registers
Print the names and values of all registers, including
oating-point registers.
info registers regname :::
Print the relativized value of each specied register regname. 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 con
ict 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
x/i $pc
82 Debugging with GDB
Whenever possible, these four standard register names are available on your machine even though
the machine has dierent canonical mnemonics, so long as there is no con
ict. 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.
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
oating
point; these registers are considered to have
oating point values. There is no way to refer to the
contents of an ordinary register as
oating point value (although you can print it as a
oating 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
oating 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 Section 6.3 [Selecting a
frame], page 55). 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 dierence.
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.
info float
Display hardware-dependent information about the
oating point unit. The exact
contents and layout vary depending on the
oating point chip; on some platforms,
`info float' is not available at all.
84 Debugging with GDB
Chapter 9: Using GDB with Dierent Languages 85
Language-specic 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, called the working language, can be selected manually, or GDB can set it
automatically.
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 dierent
things. For instance, if the current source le were written in C, and GDB was parsing Modula-2,
a command such as:
print a = b + c
86 Debugging with GDB
might not have the eect 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.
This information is recorded for each function or procedure in a source le. 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 dened in a source le 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 lan-
guage. However, program modules and libraries written in one source language can be used by a
main program written in a dierent source language. Using `set language auto' in this case frees
you from having to set the working language manually.
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.
Chapter 9: Using GDB with Dierent Languages 87
info frame
Among the other information listed here (see Section 6.4 [Information about a frame],
page 56) is the source language for this frame. This language becomes the working
language if you use an identier from this frame.
info source
Among the other information listed here (see Chapter 10 [Examining the Symbol Table],
page 103) is the source language of this source le.
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 over
ows 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 Section 9.4 [Supported
languages], page 90, for the default settings of supported languages.
The second example fails because the CARDINAL 1 is not type-compatible with the REAL 2.3.
88 Debugging with GDB
For 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 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 though you may turn type checking o, other type-based reasons may 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 denes 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 Section 9.4 [Supported languages], page 90, for further details on specic languages.
GDB provides some additional commands for controlling the type checker:
making sure computations do not over
ow, 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 over
ow, 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
over
ows as an error. In many implementations of C, mathematical over
ow 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 specic to individual languages, and in some cases specic to individual compilers or
machines. See Section 9.4 [Supported languages], page 90, for further details on specic languages.
GDB provides some additional commands for controlling the range checker:
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
dierent languages. There are many good books written on each of these languages; please look to
these for a language reference or tutorial.
The C++ debugging facilities are jointly implemented by the GNU C++ compiler and GDB.
Therefore, to debug your C++ code eectively, you must compile your C++ programs with the GNU
C++ compiler, g++.
For best results when debugging C++ programs, use the stabs debugging format. You can select
that format explicitly with the g++ command-line options `-gstabs' or `-gstabs+'. See section
\Options for Debugging Your Program or GNU CC" in Using GNU CC, for more information.
Integral types include int with any of its storage-class speciers; char; and enum.
Floating-point types include float and double.
Pointer types include all types dened as (type *).
Scalar types include all of the above.
Chapter 9: Using GDB with Dierent Languages 91
The following operators are supported. They are listed here in order of increasing precedence:
Integer constants are a sequence of digits. Octal constants are specied by a leading `0' (ie.
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.
Enumerated constants consist of enumerated identiers, 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 predened special character|for example, `\n' for newline.
String constants are a sequence of character constants surrounded by double quotes (").
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.
Chapter 9: Using GDB with Dierent Languages 93
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 denition, with
one restriction|you must use arguments of the type required by the function that you want to
call. GDB does not perform conversions requiring constructors or user-dened type operators.
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 specied
`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 dened 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 les, in both C and C++ debugging (see
Section 8.2 [Program variables], page 66).
If you allow GDB to set the language automatically, it sets the working language to C or C++ on
entering code compiled from a source le whose name ends with `.c', `.C', or `.cc'. See Section 9.1.2
[Having GDB infer the source language], page 86, for further details.
The two variables are structured and have the same structure, union, or enumerated tag.
Two 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.
The @ operator aids in the debugging of dynamic arrays, formed with pointers and a memory
allocation function. See Section 8.1 [Expressions], page 65.
breakpoint menus
When you want a breakpoint in a function whose name is overloaded, GDB break-
point menus help you specify which function denition you want. See Section 5.1.8
[Breakpoint menus], page 45.
Chapter 9: Using GDB with Dierent Languages 95
rbreak regex
Setting breakpoints using regular expressions is helpful for setting breakpoints on over-
loaded functions that are not members of any special classes. See Section 5.1.1 [Setting
breakpoints], page 36.
catch exceptions
info catch
Debug C++ exception handling using these commands. See Section 5.1.3 [Breakpoints
and exceptions], page 39.
ptype typename
Print inheritance relationships as well as other information for type typename. See
Chapter 10 [Examining the Symbol Table], page 103.
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 Section 8.7 [Print settings],
page 73.
set print object
show print object
Choose whether to print derived (actual) or declared types of objects. See Section 8.7
[Print settings], page 73.
set print vtbl
show print vtbl
Control the format for printing virtual function tables. See Section 8.7 [Print settings],
page 73.
Overloaded symbol names
You can specify a particular denition 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 nish the type list for you. See Section 3.2 [Command
completion], page 20, for details on how to do this.
9.4.2 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
96 Debugging with GDB
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.
9.4.2.1 Operators
Operators must be dened on values of specic types. For instance, + is dened on numbers, but
not on structures. Operators are often dened on groups of types. For the purposes of Modula-2,
the following denitions hold:
The following operators are supported, and appear in order of increasing precedence:
+, - Addition and subtraction on integral and
oating-point types, or union and dierence
on set types.
* Multiplication on integral and
oating-point types, or set intersection on set types.
/ Division on
oating-point types, or symmetric set dierence on set types. Same prece-
dence as *.
DIV, MOD Integer division and remainder. Dened on integral types. Same precedence as *.
- Negative. Dened on INTEGER and REAL data.
^ Pointer dereferencing. Dened on pointer types.
NOT Boolean negation. Dened on boolean types. Same precedence as ^.
. RECORD eld selector. Dened on RECORD data. Same precedence as ^.
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.
v represents a variable.
x represents a variable or constant of one of many types. See the explanation of the
function for details.
Warning: Sets and their operations are not yet supported, so GDB treats the use of
procedures INCL and EXCL as an error.
Chapter 9: Using GDB with Dierent Languages 99
9.4.2.3 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
specied 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 specied, in the form `E[+|-]nnn', where
`[+|-]nnn' is the desired exponent. All of the digits of the
oating 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 Section 9.4.1.2
[C and C++ constants], page 92, for a brief explanation of escape sequences.
Enumerated constants consist of an enumerated identier.
Boolean constants consist of the identiers TRUE and FALSE.
Pointer constants consist of integral values only.
Set constants are not yet supported.
If you allow GDB to set the language automatically, then entering code compiled from a le
whose name ends with `.mod' sets the working language to Modula-2. See Section 9.1.2 [Having
GDB set the language automatically], page 86, for further details.
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 modied 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.
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.
module . id
scope :: id
Chapter 9: Using GDB with Dierent Languages 101
where scope is the name of a module or a procedure, module the name of a module, and id is any
declared identier within your program, except another module.
Using the :: operator makes GDB search the scope specied by scope for the identier id. If
it is not found in the specied scope, then GDB searches all scopes enclosing the one specied by
scope.
Using the . operator makes GDB search the current scope for the identier specied by id that
was imported from the denition module specied by module. With this operator, it is an error
if the identier id was not imported from denition module module, or if id is not an identier in
module.
The @ operator (see Section 8.1 [Expressions], page 65), while available while using 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 specied
by an integral constant, the construct `{type }adrexp' is still useful. (see Section 8.1 [Expressions],
page 65)
In GDB scripts, the Modula-2 inequality operator # is interpreted as the beginning of a comment.
Use <> instead.
102 Debugging with GDB
Chapter 10: Examining the Symbol Table 103
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 les (see Section 8.2 [Program variables], page 66). File names are recorded in object
les as debugging symbols, but GDB would ordinarily parse a typical le 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
11 Altering Execution
Once you think you have found an error in your program, you might want to nd out for certain
whether correcting the apparent error would lead to correct results in the rest of the run. You can
nd 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 dierent address, or even return prematurely from a function to its caller.
print x=4
stores the value 4 into the variable x, and then prints the value of the assignment expression (which
is 4). See Chapter 9 [Using GDB with Dierent Languages], page 85, 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 Section 8.8 [Value history], page 78). The expression
is evaluated only for its eects.
If the beginning of the argument string of the set command appears identical to a set sub-
command, 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:
The invalid expression, of course, is `=47'. In order to actually set the program's variable width,
use
(gdb) set var width=47
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 specied type at a specied address (see Section 8.1 [Expressions], page 65). 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
jump linespec
Resume execution at line linespec. Execution stops again immediately if there is a
breakpoint there. See Section 7.1 [Printing source lines], page 59, for a description of
the dierent forms of linespec.
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 dierent function from the one currently executing, the results
may be bizarre if the two functions expect dierent patterns of arguments or of local
variables. For this reason, the jump command requests conrmation if the specied 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.
Chapter 11: Altering Execution 109
You can get much the same eect as the jump command by storing a new value into the register
$pc. The dierence is that this does not start your program running; it only changes the address
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 Section 5.2 [Continuing and stepping], page 47.
The most common occasion to use the jump command is to back up, perhaps with more break-
points set, over a portion of a program that has already executed, in order to examine its execution
in more detail.
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 Section 5.3 [Signals], page 49). The signal command passes the signal
directly to your program.
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 Section 6.3 [Selecting a frame], page 55), and any other
frames inside of it, leaving its caller as the innermost remaining frame. That frame becomes selected.
The specied 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 Section 5.2
[Continuing and stepping], page 47) resumes execution until the selected stack frame returns nat-
urally.
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. The result is printed and
saved in the value history, if it is not void.
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
ags, or even to make
emergency repairs.
set write on
set write off
If you specify `set write on', GDB opens executable and core les for both reading
and writing; if you specify `set write off' (the default), GDB opens them read-only.
Chapter 11: Altering Execution 111
If you have already loaded a le, you must load it again (using the exec-file or
core-file command) after changing set write, for your new setting to take eect.
show write
Display whether executable les and core les are opened for writing as well as reading.
112 Debugging with GDB
Chapter 12: GDB Files 113
12 GDB Files
GDB needs to know the le 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 le.
Occasionally it is necessary to change to a dierent le during a GDB session. Or you may run
GDB and forget to specify a le you want to use. In these situations the GDB commands to specify
new les are useful.
file lename
Use lename 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 le 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 les, an auxiliary le `lename.syms' may hold
symbol table information for lename. If so, GDB maps in the symbol table from
`lename.syms', starting up more quickly. See the descriptions of the options `-mapped'
and `-readnow' (available on the command line, and with the commands file, symbol-
file, or add-symbol-file), for more information.
file file with no argument makes GDB discard any information it has on both executable
le and the symbol table.
exec-file [ lename ]
Specify that the program to be run (but not the symbol table) is found in lename.
GDB searches the environment variable PATH if necessary to locate your program.
Omitting lename means to discard information on the executable le.
symbol-file [ lename ]
Read symbol table information from le lename. PATH is searched when necessary.
Use the file command to get both symbol table and program to run from the same
le.
114 Debugging with GDB
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 congured for a particular environment, it understands debugging infor-
mation 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.
On some kinds of object les, the symbol-file command does not normally read the
symbol table in full right away. Instead, it scans the symbol table quickly to nd which
source les and which symbols are present. The details are read later, one source le
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 le are being read. (The set verbose command can turn these
pauses into messages if desired. See Section 14.6 [Optional warnings and messages],
page 144.)
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.
symbol-file lename [ -readnow ] [ -mapped ]
file lename [ -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 les 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 le. Future GDB debugging sessions map in symbol information from
this auxiliary symbol le (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 eect as starting GDB with the `-mapped' command-line option.
You can use both options together, to make sure the auxiliary symbol le has all the
symbol information for your program.
Chapter 12: GDB Files 115
The auxiliary symbol le for a program called myprog is called `myprog.syms'. Once
this le 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' le is specic 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 [ lename ]
Specify the whereabouts of a core dump le to be used as the \contents of memory".
Traditionally, core les contain only some parts of the address space of the process that
generated them; GDB can access the executable le itself for other parts.
core-file with no argument species that no core le is to be used.
Note that the core le 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 le instead,
you must kill the subprocess in which the program is running. To do this, use the kill
command (see Section 4.8 [Killing the child process], page 31).
load lename
Depending on what remote debugging facilities are congured into GDB, the load
command may be available. Where it exists, it is meant to make lename (an exe-
cutable) available for debugging on the remote system|by downloading, or dynamic
linking, for example. load also records the lename 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 le is loaded at whatever address is specied in the executable. For some object
le formats, you can specify the load address when you link the program; for other
formats, like a.out, the object le format species a xed address.
On VxWorks, load links lename dynamically on the current target system as well as
adding its symbols in GDB.
With the Nindy interface to an Intel 960 board, load downloads lename to the 960
as well as adding its symbols in GDB.
When you select remote debugging to a Hitachi SH, H8/300, or H8/500 board (see Sec-
tion 13.3.7 [GDB and Hitachi Microprocessors], page 138), the load command down-
loads your program to the Hitachi board and also opens it as the current executable
target for GDB on your host (like the file command).
load does not repeat if you press RET again after using it.
116 Debugging with GDB
All le-specifying commands allow both absolute and relative le names as arguments. GDB
always converts the le name to an absolute path name and remembers it that way.
GDB supports SunOS, SVr4, Irix 5, and IBM RS/6000 shared libraries. GDB automatically
loads symbol denitions from shared libraries when you use the run command, or when you examine
a core le. (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 le).
info share
info sharedlibrary
Print the names of the shared libraries which are currently loaded.
sharedlibrary regex
share regex
This is an obsolescent command; you can use it to explicitly load shared object library
symbols for les matching a Unix regular expression, but as with les loaded automat-
ically, it only loads shared libraries required by your program for a core le or after
typing run. If regex is omitted all shared libraries required by your program are loaded.
Chapter 12: GDB Files 117
For example, if you execute `gdb a.out', then the executable le a.out is the only active target.
If you designate a core le as well|presumably from a prior run that crashed and coredumped|
then GDB has two active targets and uses them in tandem, looking rst in the corele target, then
in the executable le, to satisfy requests for memory addresses. (Typically, these two classes of
target are complementary, since core les contain only a program's read-write memory|variables
and so on|plus machine status, while executable les contain only the program text and initialized
data.)
When you type run, your executable le 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 le or executable le target are obscured while the process target is
active.
Use the core-file and exec-file commands to select a new core le or executable target
(see Section 12.1 [Commands to specify les], page 113). To specify as a target a process that is
already running, use the attach command (see Section 4.7 [Debugging an already-running process],
page 30).
Here are some common targets (available, or not, depending on the GDB conguration):
target hms
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. See Section 13.3.7 [GDB and Hitachi Microprocessors], page 138.
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'. See Section 13.3.2 [GDB with
a remote i960 (Nindy)], page 130.
target st2000 dev speed
A Tandem ST2000 phone switch, running Tandem's STDBUG protocol. dev is the
name of the device attached to the ST2000 serial line; speed is the communication line
speed. The arguments are not used if GDB is congured to connect to the ST2000
using TCP or Telnet. See Section 13.3.5 [GDB with a Tandem ST2000], page 135.
target vxworks machinename
A VxWorks system, attached via TCP/IP. The argument machinename is the tar-
get system's machine name or IP address. See Section 13.3.6 [GDB and VxWorks],
page 135.
Dierent targets are available on dierent congurations of GDB; your conguration may have
more or fewer targets.
Some congurations 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 (specic to
GDB, but not specic 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 conguration of GDB; use help targets to list
them.
122 Debugging with GDB
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. You probably need 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 Chapter 13 [Specifying a Debugging
Target], page 119).
On the target,
you must link with your program a few special-purpose subroutines that implement the
GDB remote serial protocol. The le 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 Section 13.3.1.5 [Using the gdbserver program],
page 128, for details.
The debugging stub is specic to the architecture of the remote machine; for example, use
`sparc-stub.c' to debug programs on sparc boards.
sparc-stub.c
For sparc architectures.
Chapter 13: Specifying a Debugging Target 123
m68k-stub.c
For Motorola 680x0 architectures.
i386-stub.c
For Intel 386 and compatible architectures.
The `README' le in the GDB distribution may list other recently added stubs.
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 exam-
ple, 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 in-
formation 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
eect, 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.
124 Debugging with GDB
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 dierent 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 dierent 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).
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 themself without
help from exceptionHandler.
void flush_i_cache()
Write this subroutine to
ush 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.
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.
1. Make sure you have the supporting low-level routines (see Section 13.3.1.2 [What you must do
for the stub], page 124):
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).
126 Debugging with GDB
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 architec-
ture, 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 used for this on the host.
6. Download your program to your target machine (or get it there by whatever means the man-
ufacturer provides), and start it.
7. To start remote debugging, run GDB on the host machine, and specify as an executable le the
program that is running in the remote machine. This tells GDB how to nd your program's
symbols and the contents of its pure text.
Then establish communication using the target remote command. Its argument species 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:
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.
Chapter 13: Specifying a Debugging Target 127
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.
All GDB commands and responses (other than acknowledgements, which are single characters)
are sent as a packet which includes a checksum. A packet is introduced with the character `$', and
ends with the character `#' followed by a two-digit checksum:
$packet info #checksum
checksum is computed as the modulo 256 sum of the packet info characters.
When either the host or the target machine receives a packet, the rst response expected is an
acknowledgement: a single character, either `+' (to indicate the package was received correctly) or
`-' (to request retransmission).
The host (GDB) sends commands, and the target (the debugging stub incorporated in your
program) sends data in response. The target also sends data when your program stops.
Command packets are distinguished by their rst character, which identies the kind of com-
mand.
c
caddr Resume execution at the current address (or at addr if supplied).
s
saddr Step the target program for one instruction, from either the current program counter
or from addr if supplied.
k Kill the target program.
? Report the most recent signal. To allow you to take advantage of the GDB signal
handling commands, one of the functions of the debugging stub is to report CPU traps
as the corresponding POSIX signal values.
If you have trouble with the serial connection, you can use the command set remotedebug.
This makes GDB report on all packets sent back and forth across the serial line to the remote
machine. The packet-debugging information is printed on the GDB standard output stream. set
remotedebug off turns it o, and show remotedebug shows you its current state.
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 neverthe-
less, 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 nd that the tradeos involved in real-time oper-
ation 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.
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 dierence from the previous example is the rst 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 con
ict with any TCP ports already in use
on the target system (for example, 23 is reserved for telnet).1 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 rst argument. (You may also need the `--baud' option if the serial line is
running at anything other than 9600 bps.) 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 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'.
1
If you choose a port number that con
icts with another service, gdbserver prints an error
message and exits.
130 Debugging with GDB
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 Section 13.2
[Commands for managing targets], page 119.
Respond to the prompt with whatever sux (after `/dev/tty') identies 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
Section 13.2 [Commands for managing targets], page 119).
-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 congured 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 sux for a specic 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 congured for the Intel 960 target architecture.
Chapter 13: Specifying a Debugging Target 131
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
dierent line speeds. You can abort this process with an interrupt.
-brk Specify that GDB should rst 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.
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.
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:
(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:
Your system may require a dierent 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 le|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
Chapter 13: Specifying a Debugging Target 133
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.
PageSize = 0x400
Register Stack Size = 0x800
Memory Stack Size = 0x1800
# ~.
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 le system on the Unix host. If you do not have PC/NFS or some-
thing similar connecting the two systems, you must arrange some other way|perhaps
oppy-disk
transfer|of getting the 29K program from the Unix system to the PC; GDB does not download it
over the serial line.
134 Debugging with GDB
cd /usr/joe/work29k
gdb myfoo
In this example, we've assumed your program is in a le called `myfoo'. Note that the lename
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.
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 dened for this target; you must load your program
into the ST2000 as you normally would for standalone operation. GDB reads debugging informa-
tion (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).
The following information on connecting to VxWorks was current when this manual was pro-
duced; newer releases of VxWorks may use revised procedures.
136 Debugging with GDB
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, dene INCLUDE_RDB in
the VxWorks conguration le `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 conguring 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 nd GDB, you are ready to run GDB. From your Unix host, run gdb (or vxgdb,
depending on your installation).
(vxgdb)
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 les by searching the directories listed in the
command search path (see Section 4.4 [Your program's environment], page 27); if it fails to nd an
object le, it displays a message such as:
When this happens, add the appropriate directory to the search path with the GDB command
path,and execute the target command again.
Chapter 13: Specifying a Debugging Target 137
You can also use the load command to reload an object module after editing and recompiling
the corresponding source le. Note that this makes GDB delete all currently-dened breakpoints,
auto-displays, and convenience variables, and to clear the value history. (This is necessary in order
to preserve the integrity of debugger data structures that reference the target system's symbol
table.)
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.
138 Debugging with GDB
1. that you want to use `target hms', the remote debugging interface for Hitachi microprocessors
(this is the default when GDB is congured specically for the Hitachi SH, H8/300, or H8/500);
2. what serial device connects your host to your Hitachi board (the rst serial device available
on your host is the default);
Use the special gdb command `device port' if you need to explicitly set the serial device. The
default port is the rst 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 9600 bps 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.
Use these GDB commands to specify the connection to your target board:
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
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
Debug programs on a simulated CPU (which CPU depends on the GDB conguration)
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 info reg), this debugging target
provides three additional items of information as specially named registers:
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.
Chapter 14: Controlling GDB 141
14 Controlling GDB
You can alter the way GDB interacts with you by using the set command. For commands
controlling how GDB displays data, see Section 8.7 [Print settings], page 73; other settings are
described here.
14.1 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.
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.
142 Debugging with GDB
Since ! is also the logical not operator in C, history expansion is o 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 readline code comes with more complete documentation of editing and history
expansion features. Users unfamiliar with 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.
Normally GDB knows the size of the screen from 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:
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 le or to an editor buer.
Likewise, you can specify `set width 0' to prevent GDB from wrapping its output.
14.5 Numbers
You can always enter numbers in octal, decimal, or hexadecimal in GDB by the usual conven-
tions: 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 specied|is base 10. You can change
the default base for both input and output with the set radix command.
Currently, the messages controlled by set verbose are those which announce that the symbol
table for a source le is being read; see symbol-file in Section 12.1 [Commands to specify les],
page 113.
set verbose on
Enables GDB output of certain informational messages.
Chapter 14: Controlling GDB 145
By default, if GDB encounters bugs in the symbol table of an object le, it is silent; but if you
are debugging a compiler, you may nd this information useful (see Section 12.2 [Errors reading
symbol les], page 117).
By default, GDB is cautious, and asks what sometimes seems to be a lot of stupid questions to
conrm 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 un
inchingly face the consequences of your own commands, you can disable
this \feature":
Some systems allow individual object les 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 le 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:
146 Debugging with GDB
set symbol-reloading on
Replace symbol denitions for the corresponding source le when an object le with a
particular name is seen again.
set symbol-reloading off
Do not replace symbol denitions when re-encountering object les of the same name.
This is the default state; if you are not running on a system that permits automatically
relinking modules, you should leave symbol-reloading o, since otherwise GDB may
discard symbols when linking large programs, that may contain several modules (from
dierent directories or libraries) with the same name.
show symbol-reloading
Show the current on or off setting.
Chapter 15: Canned Sequences of Commands 147
define commandname
Dene a command named commandname. If there is already a command by that name,
you are asked to conrm that you want to redene it.
The denition 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.
document commandname
Give documentation to the user-dened command commandname. The command com-
mandname must already be dened. This command reads lines of documentation just
as define reads the lines of the command denition, ending with end. After the
document command is nished, help on command commandname displays the docu-
mentation you have specied.
You may use the document command again to change the documentation of a command.
Redening the command with define does not change the documentation.
help user-defined
List all user-dened commands, with the rst line of the documentation (if any) for
each.
show user
show user commandname
Display the GDB commands used to dene commandname (but not its documentation).
If no commandname is given, display the denitions for all user-dened commands.
User-dened commands do not take arguments. When they are executed, the commands of the
denition are not printed. An error in any command stops execution of the user-dened command.
148 Debugging with GDB
Commands that would ask for conrmation if used interactively proceed without asking when
used inside a user-dened command. Many GDB commands that normally print messages to say
what they are doing omit the messages when used in a user-dened command.
For example, to ignore SIGALRM signals while single-stepping, but treat them normally during
normal execution, you could dene:
define hook-stop
handle SIGALRM nopass
end
define hook-run
handle SIGALRM pass
end
define hook-continue
handle SIGLARM pass
end
You can dene a hook for any single-word command in GDB, but not for command aliases; you
should dene 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 dene a hook which does not match any known command, you get a warning from
the define command.
Chapter 15: Canned Sequences of Commands 149
When you start GDB, it automatically executes commands from its init les. These are les
named `.gdbinit'. GDB reads the init le (if any) in your home directory, then processes command
line options and operands, and then reads the init le (if any) in the current working directory.
This is so the init le in your home directory can set options (such as set complaints) which aect
the processing of the command line options and operands. The init les are not executed if you
use the `-nx' option; see Section 2.1.2 [Choosing modes], page 15.
On some congurations of GDB, the init le is known by a dierent name (these are typically
environments where a specialized form of GDB may need to coexist with other forms, hence a
dierent name for the specialized version's init le). These are the environments with special init
le names:
You can also request the execution of a command le with the source command:
source lename
Execute the command le lename.
The lines in a command le are executed sequentially. They are not printed as they are executed.
An error in any command terminates execution of the command le.
Commands that would ask for conrmation if used interactively proceed without asking when
used in a command le. Many GDB commands that normally print messages to say what they are
doing omit the messages when called from command les.
150 Debugging with GDB
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 Section 8.1 [Expressions], page 65,
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 Section 8.4 [Output formats], page 68, 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 specied 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.
Chapter 16: Using GDB under GNU Emacs 151
To use this interface, use the command M-x gdb in Emacs. Give the executable le 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 buer.
Using GDB under Emacs is just like using GDB normally except for two things:
All \terminal" input and output goes through the Emacs buer.
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.
Each time GDB displays a stack frame, Emacs automatically nds the source le for that frame
and puts an arrow (`=>') at the left margin of the current line. Emacs uses a separate buer 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 les, in which case the
auxiliary display buer does not appear to show your source. GDB can nd 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 les in this situation. To avoid this problem, either start GDB
152 Debugging with GDB
mode from the directory where your program resides, or specify a full path 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 buer in Emacs.
By default, M-x gdb calls the program called `gdb'. If you need to call GDB by a dierent
name (for example, if you keep several congurations around, with dierent names) you can set
the Emacs variable gdb-command-name; for example,
(setq gdb-command-name "mygdb")
(preceded by ESC ESC, or typed in the *scratch* buer, or in your `.emacs' le) makes Emacs call
the program named \mygdb" instead.
In the GDB I/O buer, you can use these special Emacs commands in addition to the standard
Shell mode commands:
M-i Execute one instruction, like the GDB stepi command; update display window ac-
cordingly.
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 section \Numeric
Arguments" in The GNU Emacs Manual), 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.
Chapter 16: Using GDB under GNU Emacs 153
In any source le, 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 buer, an easy way to get it back is to type the
command f in the GDB buer, to request a frame display; when you run under Emacs, this recreates
the source buer if necessary to show you the context of the current frame.
The source les displayed in Emacs are in ordinary Emacs buers which are visiting the source
les in the usual way. You can edit the les with these buers 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.
154 Debugging with GDB
Chapter 17: Reporting Bugs in GDB 155
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 x the bug.
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.
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.
You can nd contact information for many support companies and individuals in the le
`etc/SERVICE' in the GNU Emacs distribution.
In any event, we also recommend that you send bug reports for GDB to one of these addresses:
156 Debugging with GDB
[email protected]
{ucbvax|mit-eddie|uunet}!prep.ai.mit.edu!bug-gdb
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.
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 dierent, the contents of that location would fool the debugger
into doing the right thing despite the bug. Play it safe and give a specic, 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 x the bug if it is new to us.
It is not as important as what happens if the bug is already known. Therefore, always write your
bug reports on the assumption that the bug has not been reported previously.
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.
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.0".
What compiler (and its version) was used to compile the program you are debugging|e.g.
\gcc{2.0".
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 Makele (or the output from make) is sucient.
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 les, 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. We are human,
after all. 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. Sup-
pose 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 dis. 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.
Of course, if you can nd 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, simplication 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 x 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
xed.
And if we cannot understand what bug you are trying to x, 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 rst
using the debugger to nd the facts.
Appendix A: Command Line Editing 159
The text C-K is read as `Control-K' and describes the character produced when the Control key
is depressed and the K key is struck.
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 struck. If you do not have a meta key, the identical
keystroke can be generated by typing ESC rst, 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. Specically, DEL, ESC, LFD, SPC, RET, and TAB
all stand for themselves when seen in this text, or in an init le (see Section A.3 [Readline Init
File], page 162, for more info).
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. Aftwerwards, 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 get `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 get `pulled back' to ll 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-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.
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 to 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 dierent than M-DEL because
the word boundaries dier.
And, here is how to yank the text back into the line. Yanking is
C-Y Yank the most recently killed text back into the buer 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.
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 in one clean sweep.
The kill ring is not line specic; the text that you killed on a previously typed line is available to
be yanked back later, when you are typing another line.
162 Debugging with GDB
The general way to pass numeric arguments to a command is to type meta digits before the
command. If the rst `digit' you type 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.
When a program which uses the Readline library starts up, the `~/.inputrc' le is read, and
the keybindings are set.
In addition, the C-X C-R command re-reads this init le, thus incorporating any changes that
you might have made to it.
Variable Settings
You can change the state of a few variables in Readline. You do this by using the set
command within the init le. Here is how you would specify that you wish to use Vi
line editing commands:
set editing-mode vi
Right now, there are only a few variables which can be set; so few in fact, that we just
iterate them here:
Appendix A: Command Line Editing 163
editing-mode
The editing-mode variable controls which editing mode you are using.
By default, GNU Readline starts up in Emacs editing mode, where the
keystrokes are most similar to Emacs. This variable can either be set to
emacs or vi.
horizontal-scroll-mode
This variable can either be set to On or Off. Setting it to On means that
the text of the lines that you edit will scroll horizontally on a single screen
line when they are larger than the width of the screen, instead of wrapping
onto a new screen line. By default, this variable is set to Off.
mark-modified-lines
This variable when set to On, says to display an asterisk (`*') at the starts
of history lines which have been modied. This variable is o by default.
prefer-visible-bell
If this variable is set to On it means to use a visible bell if one is available,
rather than simply ringing the terminal bell. By default, the value is Off.
Key Bindings
The syntax for controlling keybindings in the `~/.inputrc' le is simple. First you
have to know the name of the command that you want to change. The following pages
contain tables of the command name, the default keybinding, 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
`~/.inputrc' le. The name of the key can be expressed in dierent 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 diers from keyname above in that strings denoting an entire key
sequence can be specied. Simply place the key sequence in double quotes.
GNU Emacs style key escapes can be used, as in the following example:
"\C-u": universal-argument
"\C-x\C-r": re-read-init-file
164 Debugging with GDB
beginning-of-history (M-<)
Move to the rst line in the history.
end-of-history (M->)
Move to the end of the input history, i.e., the line you are entering!
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.
upcase-word (M-U)
Uppercase all letters in the current (or following) word. With a negative argument, do
the previous word, but do not move point.
downcase-word (M-L)
Lowercase all letters in the current (or following) word. With a negative argument, do
the previous word, but do not move point.
capitalize-word (M-C)
Uppercase the rst letter in the current (or following) word. With a negative argument,
do the previous word, but do not move point.
revert-line (M-R)
Undo all changes made to this line. This is like typing the `undo' command enough
times to get back to the beginning.
In order to switch interactively between Emacs and Vi editing modes, use the command M-C-J
(toggle-editing-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 `edit' mode, where you can edit the text of the line
with the standard Vi movement keys, move to previous history lines with `k', and following lines
with `j', and so forth.
Appendix B: Using History Interactively 169
This chapter describes how to use the GNU History Library interactively, from a user's stand-
point.
History expansion takes place in two parts. The rst is to determine which line from the
previous history 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 previous history is called the event,
and the portions of that line that are acted upon are called words. The line is broken into words
in the same fashion that the Bash shell does, so that several English (or Unix) words surrounded
by quotes are considered as one word.
! Start a history subsititution, except when followed by a space, tab, or the end of the
line... = or (.
!! Refer to the previous command. This is a synonym for !-1.
!n Refer to command line n.
!-n Refer to the command line n lines back.
!string Refer to the most recent command starting with string.
!?string[?]
Refer to the most recent command containing string.
170 Debugging with GDB
0 (zero) The zero'th word. For many applications, this is the command word.
n The n'th word.
^ The rst 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, excepting the zero'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.
# The entire command line typed so far. This means the current command, not the
previous command, so it really isn't a word designator, and doesn't belong in this
section.
h Remove a trailing pathname component, leaving only the head.
r Remove a trailing sux of the form `.'sux, leaving the basename.
e Remove all but the sux.
t Remove all leading pathname components, leaving the tail.
p Print the new command but do not execute it.
Appendix C: Renamed Commands 171
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 docu-
mentation is written in Texinfo format, which is a documentation system that uses a single source
le to produce both on-line information and a printed manual. You can use one of the Info for-
matting 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 le is `gdb-version-number /gdb/gdb.info', and it refers to
subordinate les matching `gdb.info*' in the same directory. If necessary, you can print out these
les, 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 les 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-4.12', in
the case of version 4.12), you can make the Info le by typing:
cd gdb
make gdb.info
1
In `gdb-4.12/gdb/refcard.ps' of the version 4.12 release.
174 Debugging with GDB
If you want to typeset and print copies of this manual, you need TEX, a program to print its
dvi output les, and `texinfo.tex', the Texinfo denitions le.
TEX is a typesetting program; it does not print les directly, but produces output les called
dvi les. To print a typeset document, you need a program to print dvi les. 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 le name without any extension or a `.dvi' extension.
TEX also requires a macro denitions le called `texinfo.tex'. This le tells TEX how to typeset
a document written in Texinfo format. On its own, TEX cannot read, much less typeset a Texinfo
le. `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-4.12/gdb')
and then type:
make gdb.dvi
Appendix E: Installing GDB 175
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 4.12 distribution is in the `gdb-4.12' directory. That directory
contains:
The simplest way to congure and build GDB is to run configure from the `gdb-version-
number' source directory, which in this example is the `gdb-4.12' directory.
1
If you have a more recent version of GDB than 4.12, look at the `README' le in the sources; we
may have improved the installation procedures since publishing this manual.
176 Debugging with GDB
First switch to the `gdb-version-number' source directory if you are not already in it; then run
configure. Pass the identier for the platform on which GDB will run as an argument.
For example:
cd gdb-4.12
./configure host
make
where host is an identier such as `sun4' or `decstation', that identies the platform where GDB
will run. (You can often leave o 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 congured source les, 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 automati-
cally when you run a dierent 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-4.12' source directory for version 4.12, configure creates conguration
les 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 distribu-
tion if you only want to congure that subdirectory, but be sure to specify a path to it.
For example, with version 4.12, type the following to congure only the bfd subdirectory:
cd gdb-4.12/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.
Appendix E: Installing GDB 177
To build gdb in a separate directory, run configure with the `--srcdir' option to specify where
to nd the source. (You also need to specify a path to nd 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 4.12, you can build GDB in a separate directory for a Sun 4 like this:
cd gdb-4.12
mkdir ../gdb-sun4
cd ../gdb-sun4
../gdb-4.12/configure sun4
make
When configure builds a conguration 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 nd 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 congurations in separate directories is to congure
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 congured 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-4.12' (or in a separate congured directory congured
with `--srcdir=path/gdb-4.12'), you will build all the required libraries, and then build GDB.
178 Debugging with GDB
When you have multiple hosts or targets congured 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.
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 sup-
ported 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 sun4
sparc-sun-sunos4.1.1
% sh config.sub sun3
m68k-sun-sunos4.1.1
% sh config.sub decstation
mips-dec-ultrix4.2
% sh config.sub hp300bsd
m68k-hp-bsd
% sh config.sub i386v
i386-unknown-sysv
% sh config.sub i786v
Invalid configuration `i786v': machine `i786v' not recognized
config.sub is also distributed in the GDB source directory (`gdb-4.12', for version 4.12).
Appendix E: Installing GDB 179
Here is a summary of the configure options and arguments that are most often useful for build-
ing GDB. configure also has several other options not listed here. See Info le `configure.info',
node `What Configure Does', for a full explanation of configure.
configure [--help]
[--prefix=dir]
[--srcdir=path]
[--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 `--'.
configure accepts other options, for compatibility with conguring other GNU tools recursively;
but these are the only options that aect GDB or its supporting libraries.
Index 181
Index
# add-symbol-file : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 116
#:::::::::::::::::::::::::::::::::::::::::::::::::: 19 add-syms : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
# in Modula-2 :::::::::::::::::::::::::::::::::::: 101 AMD 29K register stack ::::::::::::::::::::::::::: 82
AMD EB29K 120
$
:::::::::::::::::::::::::::::::::::::
$cdir : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 62
$cwd : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 62 b:::::::::::::::::::::::::::::::::::::::::::::::::: 36
54
. backtrace : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
break : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 36
.::::::::::::::::::::::::::::::::::::::::::::::::: 100 break ::: threadno
thread ::::::::::::::::::::::::: 51
.esgdbinit : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 149 break in overloaded functions :::::::::::::::::::::: 94
`.gdbinit' :::::::::::::::::::::::::::::::::::::::: 149 breakpoint commands :::::::::::::::::::::::::::::: 44
.os68gdbinit :::::::::::::::::::::::::::::::::::: 149 breakpoint conditions :::::::::::::::::::::::::::::: 42
.vxgdbinit : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 149 breakpoint numbers :::::::::::::::::::::::::::::::: 35
breakpoint on memory address 35
/
:::::::::::::::::::::
{ C
{ type } ::::::::::::::::::::::::::::::::::::::::::::: 66 c:::::::::::::::::::::::::::::::::::::::::::::::::: 47
C and C++ 90
A
:::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::: 66 D
39
catch : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : d:::::::::::::::::::::::::::::::::::::::::::::::::: 41
catch exceptions ::::::::::::::::::::::::::::::::::: 57 debugger crash ::::::::::::::::::::::::::::::::::: 155
29
cd : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : debugging optimized code :::::::::::::::::::::::::: 25
62
cdir : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : debugging stub, example :::::::::::::::::::::::::: 127
checks, range :::::::::::::::::::::::::::::::::::::: 88 debugging target :::::::::::::::::::::::::::::::::: 119
checks, type ::::::::::::::::::::::::::::::::::::::: 87 define ::::::::::::::::::::::::::::::::::::::::::: 147
checksum, for GDB remote ::::::::::::::::::::::: 127 delete :::::::::::::::::::::::::::::::::::::::::::: 41
41
clear : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : delete breakpoints ::::::::::::::::::::::::::::::::: 41
clearing breakpoints, watchpoints :::::::::::::::::: 40 delete display : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 72
co versus C++ :::::::::::::::::::::::::::::::::::: 93 delete environment : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
colon, doubled as scope operator :::::::::::::::::: 100 deleting breakpoints, watchpoints :::::::::::::::::: 40
colon-colon :::::::::::::::::::::::::::::::::::::::: 67 detach :::::::::::::::::::::::::::::::::::::::::::: 30
command les ::::::::::::::::::::::::::::::: 148, 149 device ::::::::::::::::::::::::::::::::::::::::::: 138
command line editing ::::::::::::::::::::::::::::: 141 directories for source les :::::::::::::::::::::::::: 61
commands : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 44 directory : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 62
commands for C++ ::::::::::::::::::::::::::::::::: 94 directory, compilation :::::::::::::::::::::::::::::: 62
commands to STDBUG (ST2000) ::::::::::::::::: 135 directory, current :::::::::::::::::::::::::::::::::: 62
comment :::::::::::::::::::::::::::::::::::::::::: 19 dis : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 42
compilation directory :::::::::::::::::::::::::::::: 62 disable : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 42
completion ::::::::::::::::::::::::::::::::::::::::: 20 disable breakpoints : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 42
completion of quoted strings ::::::::::::::::::::::: 21 disable display :::::::::::::::::::::::::::::::::: 72
condition : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 43 disabled breakpoints ::::::::::::::::::::::::::::::: 41
conditional breakpoints :::::::::::::::::::::::::::: 42 disassemble : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 63
conguring GDB ::::::::::::::::::::::::::::::::: 175 display : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 72
conrmation :::::::::::::::::::::::::::::::::::::: 145 display of expressions :::::::::::::::::::::::::::::: 71
connect (to STDBUG) :::::::::::::::::::::::::::: 135 do : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 55
continue : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 47 document : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 147
continuing ::::::::::::::::::::::::::::::::::::::::: 47 documentation :::::::::::::::::::::::::::::::::::: 173
continuing threads ::::::::::::::::::::::::::::::::: 51 down : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 55
control C, and remote debugging :::::::::::::::::: 124 down-silently :::::::::::::::::::::::::::::::::::: 56
download to H8/300 or H8/500 ::::::::::::::::::: 115
Index 183
flush i cache : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
139
125
eb.log ::::::::::::::::::::::::::::::::::::::::::: 134
EB29K board ::::::::::::::::::::::::::::::::::::: 131 focus of debugging ::::::::::::::::::::::::::::::::: 32
EBMON :::::::::::::::::::::::::::::::::::::::::::: 132 foo ::::::::::::::::::::::::::::::::::::::::::::::: 117
echo : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 150 format options ::::::::::::::::::::::::::::::::::::: 73
eco and C++ :::::::::::::::::::::::::::::::::::::: 93 formatted output :::::::::::::::::::::::::::::::::: 68
editing ::::::::::::::::::::::::::::::::::::::::::: 141 Fortran ::::::::::::::::::::::::::::::::::::::::::::: 1
editing-mode :::::::::::::::::::::::::::::::::::: 163 forward-search : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 61
elf/dwarf and C++ ::::::::::::::::::::::::::::::::: 93 frame :::::::::::::::::::::::::::::::::::::::::::::: 53
elf/stabs and C++ :::::::::::::::::::::::::::::::::: 93 frame : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 55
emacs :::::::::::::::::::::::::::::::::::::::::::: 151 frame number ::::::::::::::::::::::::::::::::::::: 54
enable :::::::::::::::::::::::::::::::::::::::::::: 42 frame pointer :::::::::::::::::::::::::::::::::::::: 53
enable breakpoints : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 42 frameless execution :::::::::::::::::::::::::::::::: 54
72
G
enable display : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
enabled breakpoints :::::::::::::::::::::::::::::::: 41
end : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :44 g++ : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 90
entering numbers ::::::::::::::::::::::::::::::::: 144 GDB bugs, reporting ::::::::::::::::::::::::::::: 155
environment (of your program) ::::::::::::::::::::: 27 GDB reference card ::::::::::::::::::::::::::::::: 173
error on valid input ::::::::::::::::::::::::::::::: 155 GDBHISTFILE ::::::::::::::::::::::::::::::::::::: 142
event designators ::::::::::::::::::::::::::::::::: 169 gdbserver : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 128
examining data :::::::::::::::::::::::::::::::::::: 65 getDebugChar :::::::::::::::::::::::::::::::::::: 124
examining memory ::::::::::::::::::::::::::::::::: 69 GNU C++ ::::::::::::::::::::::::::::::::::::::::: 90
exception handlers ::::::::::::::::::::::::::::: 39, 57
exceptionHandler : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
exec-file : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
124
113
H
h:::::::::::::::::::::::::::::::::::::::::::::::::: 21
executable le :::::::::::::::::::::::::::::::::::: 113 H8/300 or H8/500 download :::::::::::::::::::::: 115
exiting GDB ::::::::::::::::::::::::::::::::::::::: 16 H8/300 or H8/500 simulator :::::::::::::::::::::: 140
expansion :::::::::::::::::::::::::::::::::::::::: 169 handle :::::::::::::::::::::::::::::::::::::::::::: 50
expressions :::::::::::::::::::::::::::::::::::::::: 65 handle exception : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 123
expressions in C or C++ :::::::::::::::::::::::::::: 90 handling signals ::::::::::::::::::::::::::::::::::: 49
expressions in C++ ::::::::::::::::::::::::::::::::: 93 help : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 21
expressions in Modula-2 :::::::::::::::::::::::::::: 96 help target : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 120
147
F
help user-defined : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
heuristic-fence-post (MIPS) :::::::::::::::::::: 57
f:::::::::::::::::::::::::::::::::::::::::::::::::: 55 history expansion ::::::::::::::::::::::::::::::::: 142
fatal signal ::::::::::::::::::::::::::::::::::::::: 155 history le :::::::::::::::::::::::::::::::::::::::: 142
fatal signals :::::::::::::::::::::::::::::::::::::::: 49 history number :::::::::::::::::::::::::::::::::::: 78
fg : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 47 history save :::::::::::::::::::::::::::::::::::::: 142
184 Debugging with GDB
::::::::::::::::::::::::::::::::::::::
31
32 K
info proc mappings ::::::::::::::::::::::::::::::: 31 kill : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 31
32
L
info proc status : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
info proc times : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 32
info program : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 35 l:::::::::::::::::::::::::::::::::::::::::::::::::: 59
info registers : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 81 languages :::::::::::::::::::::::::::::::::::::::::: 85
info s : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 54 latest breakpoint ::::::::::::::::::::::::::::::::::: 36
info set :::::::::::::::::::::::::::::::::::::::::: 23 leaving GDB ::::::::::::::::::::::::::::::::::::::: 16
Index 185
M O
m680x0 123
object formats and C++ 93
:::::::::::::::::::::::::::::::::::::::::::
online documentation 21
:::::::::::::::::::::::::::::::::::::
48
Q
n::::::::::::::::::::::::::::::::::::::::::::::::::
names of symbols ::::::::::::::::::::::::::::::::: 103
namespace in C++ ::::::::::::::::::::::::::::::::: 93 q:::::::::::::::::::::::::::::::::::::::::::::::::: 16
negative breakpoint numbers ::::::::::::::::::::::: 38 quit : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 16
New systag ::::::::::::::::::::::::::::::::::::::::: 33 quotes in commands ::::::::::::::::::::::::::::::: 21
next : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 48 quoting names :::::::::::::::::::::::::::::::::::: 103
186 Debugging with GDB
R S
raise exceptions :::::::::::::::::::::::::::::::::::: 40 s:::::::::::::::::::::::::::::::::::::::::::::::::: 47
range checking ::::::::::::::::::::::::::::::::::::: 88 saving symbol table ::::::::::::::::::::::::::::::: 114
rbreak :::::::::::::::::::::::::::::::::::::::::::: 37 scope ::::::::::::::::::::::::::::::::::::::::::::: 100
reading symbols immediately ::::::::::::::::::::: 114 search :::::::::::::::::::::::::::::::::::::::::::: 61
readline :::::::::::::::::::::::::::::::::::::::::: 141 searching :::::::::::::::::::::::::::::::::::::::::: 61
readnow : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 114 selected frame ::::::::::::::::::::::::::::::::::::: 53
redirection ::::::::::::::::::::::::::::::::::::::::: 29 serial connections, debugging ::::::::::::::::::::: 128
reference card :::::::::::::::::::::::::::::::::::: 173 serial device, Hitachi micros ::::::::::::::::::::::: 138
reference declarations :::::::::::::::::::::::::::::: 93 serial line speed, Hitachi micros ::::::::::::::::::: 138
register stack, AMD29K ::::::::::::::::::::::::::: 82 serial line, target remote ::::::::::::::::::::::::: 126
registers ::::::::::::::::::::::::::::::::::::::::::: 81 serial protocol, GDB remote :::::::::::::::::::::: 127
regular expression :::::::::::::::::::::::::::::::::: 37 set addressprint : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
reloading symbols ::::::::::::::::::::::::::::::::: 145 set args :::::::::::::::::::::::::::::::::::::::::: 27
remote connection without stubs :::::::::::::::::: 128 set array-max : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
remote debugging ::::::::::::::::::::::::::::::::: 121 set arrayprint :::::::::::::::::::::::::::::::::: 171
remote programs, interrupting :::::::::::::::::::: 126 set asm-demangle : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
remote serial debugging summary ::::::::::::::::: 125 set caution : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
remote serial debugging, overview ::::::::::::::::: 122 set check : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 88, 89
remote serial protocol ::::::::::::::::::::::::::::: 127 set check range : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 89
remote serial stub :::::::::::::::::::::::::::::::: 123 set check type : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 88
remote serial stub list ::::::::::::::::::::::::::::: 122 set complaints :::::::::::::::::::::::::::::::::: 145
remote serial stub, initialization ::::::::::::::::::: 123 set confirm : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 145
remote serial stub, main routine :::::::::::::::::: 123 set demangle : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 171
remote stub, example ::::::::::::::::::::::::::::: 127 set demangle-style : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 77
remote stub, support routines ::::::::::::::::::::: 124 set editing : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 141
remotedebug, MIPS protocol :::::::::::::::::::::: 139 set environment :::::::::::::::::::::::::::::::::: 28
repeating commands ::::::::::::::::::::::::::::::: 19 set height : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 143
reporting bugs in GDB ::::::::::::::::::::::::::: 155 set history expansion : : : : : : : : : : : : : : : : : : : : : : : : : : : 142
reset :::::::::::::::::::::::::::::::::::::::::::: 131 set history filename : : : : : : : : : : : : : : : : : : : : : : : : : : : : 142
response time, MIPS debugging :::::::::::::::::::: 57 set history save : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 142
resuming execution :::::::::::::::::::::::::::::::: 47 set history size : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 142
RET : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :19 set history write ::::::::::::::::::::::::::::::: 171
retransmit-timeout , MIPS protocol :::::::::::::: 139 set language : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 85
return ::::::::::::::::::::::::::::::::::::::::::: 109 set listsize : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 59
returning from a function ::::::::::::::::::::::::: 109 set mipsfpu off : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 139
reverse-search : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 61 set prettyprint ::::::::::::::::::::::::::::::::: 171
run : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :26 set print address : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 73
running :::::::::::::::::::::::::::::::::::::::::::: 26 set print array : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 75
running 29K programs :::::::::::::::::::::::::::: 131 set print asm-demangle : : : : : : : : : : : : : : : : : : : : : : : : : : : 77
running VxWorks tasks ::::::::::::::::::::::::::: 137 set print demangle ::::::::::::::::::::::::::::::: 77
set print elements ::::::::::::::::::::::::::::::: 75
set print fast-symbolic-addr : : : : : : : : : : : : : : : : : : : : 74
Index 187
:::::::::::::::::::::::: 77 U
symbol dump ::::::::::::::::::::::::::::::::::::: 105 u:::::::::::::::::::::::::::::::::::::::::::::::::: 48
symbol names :::::::::::::::::::::::::::::::::::: 103 udi : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 131
symbol overloading :::::::::::::::::::::::::::::::: 45 UDI :::::::::::::::::::::::::::::::::::::::::::::: 131
symbol table :::::::::::::::::::::::::::::::::::::: 113 undisplay : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 72
symbol-file ::::::::::::::::::::::::::::::::::::: 113 unknown address, locating ::::::::::::::::::::::::: 69
symbols, reading immediately ::::::::::::::::::::: 114 unset :::::::::::::::::::::::::::::::::::::::::::: 171
unset environment : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 28
48
T
until : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :
up : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 55
target ::::::::::::::::::::::::::::::::::::::::::: 119 up-silently : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 56
target amd-eb : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : 120 user-dened command :::::::::::::::::::::::::::: 147
Index 189
W X
watch : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : : :39 x:::::::::::::::::::::::::::::::::::::::::::::::::: 69
watchpoints ::::::::::::::::::::::::::::::::::::::: 35 xco and C++ :::::::::::::::::::::::::::::::::::::: 93
watchpoints and threads 39
Z
:::::::::::::::::::::::::::
Table of Contents
Summary of GDB :::::::::::::::::::::::::::::::::::::::: 1
Free software ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: 1
Contributors to GDB ::::::::::::::::::::::::::::::::::::::::::::::::::: 2
New Features since GDB Version 3.5 ::::::::::::::::::: 5
1 A Sample GDB Session :::::::::::::::::::::::::::::: 7
2 Getting In and Out of GDB :::::::::::::::::::::::: 13
2.1 Invoking GDB ::::::::::::::::::::::::::::::::::::::::::::::::::: 13
2.1.1 Choosing les ::::::::::::::::::::::::::::::::::::::::::: 14
2.1.2 Choosing modes :::::::::::::::::::::::::::::::::::::::: 15
2.2 Quitting GDB ::::::::::::::::::::::::::::::::::::::::::::::::::: 16
2.3 Shell commands :::::::::::::::::::::::::::::::::::::::::::::::::: 17
3 GDB Commands :::::::::::::::::::::::::::::::::::: 19
3.1 Command syntax :::::::::::::::::::::::::::::::::::::::::::::::: 19
3.2 Command completion :::::::::::::::::::::::::::::::::::::::::::: 20
3.3 Getting help ::::::::::::::::::::::::::::::::::::::::::::::::::::: 21
4 Running Programs Under GDB ::::::::::::::::::: 25
4.1 Compiling for debugging ::::::::::::::::::::::::::::::::::::::::: 25
4.2 Starting your program:::::::::::::::::::::::::::::::::::::::::::: 26
4.3 Your program's arguments ::::::::::::::::::::::::::::::::::::::: 27
4.4 Your program's environment ::::::::::::::::::::::::::::::::::::: 27
4.5 Your program's working directory :::::::::::::::::::::::::::::::: 29
4.6 Your program's input and output ::::::::::::::::::::::::::::::::: 29
4.7 Debugging an already-running process :::::::::::::::::::::::::::: 30
4.8 Killing the child process
:::::::::::::::::::::::::::::::::::::::::: 31
4.9 Additional process information::::::::::::::::::::::::::::::::::: 31
4.10 Debugging programs with multiple threads :::::::::::::::::::::: 32
5 Stopping and Continuing ::::::::::::::::::::::::::: 35
5.1 Breakpoints, watchpoints, and exceptions ::::::::::::::::::::::::: 35
5.1.1 Setting breakpoints ::::::::::::::::::::::::::::::::::::: 36
5.1.2 Setting watchpoints ::::::::::::::::::::::::::::::::::::: 39
ii Debugging with GDB
5.1.3 Breakpoints and exceptions ::::::::::::::::::::::::::::: 39
5.1.4 Deleting breakpoints :::::::::::::::::::::::::::::::::::: 40
5.1.5 Disabling breakpoints ::::::::::::::::::::::::::::::::::: 41
5.1.6 Break conditions :::::::::::::::::::::::::::::::::::::::: 42
5.1.7 Breakpoint command lists ::::::::::::::::::::::::::::::: 44
5.1.8 Breakpoint menus ::::::::::::::::::::::::::::::::::::::: 45
5.1.9 \Cannot insert breakpoints" ::::::::::::::::::::::::::::: 46
5.2 Continuing and stepping ::::::::::::::::::::::::::::::::::::::::: 47
5.3 Signals ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: 49
5.4 Stopping and starting multi-thread programs ::::::::::::::::::::: 51
6 Examining the Stack :::::::::::::::::::::::::::::::: 53
6.1 Stack frames ::::::::::::::::::::::::::::::::::::::::::::::::::::: 53
6.2 Backtraces ::::::::::::::::::::::::::::::::::::::::::::::::::::::: 54
6.3 Selecting a frame::::::::::::::::::::::::::::::::::::::::::::::::: 55
6.4 Information about a frame ::::::::::::::::::::::::::::::::::::::: 56
6.5 MIPS machines and the function stack ::::::::::::::::::::::::::: 57
7 Examining Source Files ::::::::::::::::::::::::::::: 59
7.1 Printing source lines:::::::::::::::::::::::::::::::::::::::::::::: 59
7.2 Searching source les ::::::::::::::::::::::::::::::::::::::::::::: 61
7.3 Specifying source directories :::::::::::::::::::::::::::::::::::::: 61
7.4 Source and machine code ::::::::::::::::::::::::::::::::::::::::: 62
8 Examining Data ::::::::::::::::::::::::::::::::::::: 65
8.1 Expressions :::::::::::::::::::::::::::::::::::::::::::::::::::::: 65
8.2 Program variables :::::::::::::::::::::::::::::::::::::::::::::::: 66
8.3 Articial arrays:::::::::::::::::::::::::::::::::::::::::::::::::: 67
8.4 Output formats :::::::::::::::::::::::::::::::::::::::::::::::::: 68
8.5 Examining memory :::::::::::::::::::::::::::::::::::::::::::::: 69
8.6 Automatic display :::::::::::::::::::::::::::::::::::::::::::::::: 71
8.7 Print settings:::::::::::::::::::::::::::::::::::::::::::::::::::: 73
8.8 Value history::::::::::::::::::::::::::::::::::::::::::::::::::::: 78
8.9 Convenience variables :::::::::::::::::::::::::::::::::::::::::::: 80
8.10 Registers:::::::::::::::::::::::::::::::::::::::::::::::::::::::: 81
8.11 Floating point hardware ::::::::::::::::::::::::::::::::::::::::: 83
9 Using GDB with Dierent Languages ::::::::::::: 85
9.1 Switching between source languages :::::::::::::::::::::::::::::: 85
9.1.1 Setting the working language :::::::::::::::::::::::::::: 85
9.1.2 Having GDB infer the source language :::::::::::::::::: 86
9.2 Displaying the language :::::::::::::::::::::::::::::::::::::::::: 86
iii
9.3 Type and range checking ::::::::::::::::::::::::::::::::::::::::: 87
9.3.1 An overview of type checking :::::::::::::::::::::::::::: 87
9.3.2 An overview of range checking ::::::::::::::::::::::::::: 88
9.4 Supported languages ::::::::::::::::::::::::::::::::::::::::::::: 90
9.4.1 C and C++ :::::::::::::::::::::::::::::::::::::::::::::: 90
9.4.1.1 C and C++ operators ::::::::::::::::::::::::::: 90
9.4.1.2 C and C++ constants ::::::::::::::::::::::::::: 92
9.4.1.3 C++ expressions :::::::::::::::::::::::::::::::: 93
9.4.1.4 C and C++ defaults :::::::::::::::::::::::::::: 93
9.4.1.5 C and C++ type and range checks :::::::::::::: 94
9.4.1.6 GDB and C :::::::::::::::::::::::::::::::::::: 94
9.4.1.7 GDB features for C++ :::::::::::::::::::::::::: 94
9.4.2 Modula-2 ::::::::::::::::::::::::::::::::::::::::::::::: 95
9.4.2.1 Operators :::::::::::::::::::::::::::::::::::::: 96
9.4.2.2 Built-in functions and procedures :::::::::::::: 97
9.4.2.3 Constants :::::::::::::::::::::::::::::::::::::: 99
9.4.2.4 Modula-2 defaults :::::::::::::::::::::::::::::: 99
9.4.2.5 Deviations from standard Modula-2 :::::::::::: 99
9.4.2.6 Modula-2 type and range checks :::::::::::::: 100
9.4.2.7 The scope operators :: and . ::::::::::::::::: 100
9.4.2.8 GDB and Modula-2 ::::::::::::::::::::::::::: 101
10 Examining the Symbol Table :::::::::::::::::::: 103
11 Altering Execution ::::::::::::::::::::::::::::::: 107
11.1 Assignment to variables:::::::::::::::::::::::::::::::::::::::: 107
11.2 Continuing at a dierent address ::::::::::::::::::::::::::::::: 108
11.3 Giving your program a signal :::::::::::::::::::::::::::::::::: 109
11.4 Returning from a function ::::::::::::::::::::::::::::::::::::: 109
11.5 Calling program functions:::::::::::::::::::::::::::::::::::::: 110
11.6 Patching programs ::::::::::::::::::::::::::::::::::::::::::::: 110
12 GDB Files ::::::::::::::::::::::::::::::::::::::::: 113
12.1 Commands to specify les :::::::::::::::::::::::::::::::::::::: 113
12.2 Errors reading symbol les ::::::::::::::::::::::::::::::::::::: 117
13 Specifying a Debugging Target :::::::::::::::::: 119
13.1 Active targets :::::::::::::::::::::::::::::::::::::::::::::::::: 119
13.2 Commands for managing targets ::::::::::::::::::::::::::::::: 119
13.3 Remote debugging ::::::::::::::::::::::::::::::::::::::::::::: 121
13.3.1 The GDB remote serial protocol :::::::::::::::::::::: 122
13.3.1.1 What the stub can do for you :::::::::::::::: 123
iv Debugging with GDB
13.3.1.2 What you must do for the stub :::::::::::::: 124
13.3.1.3 Putting it all together ::::::::::::::::::::::: 125
13.3.1.4 Communication protocol ::::::::::::::::::::: 127
13.3.1.5 Using the gdbserver program ::::::::::::::: 128
13.3.2 GDB with a remote i960 (Nindy) ::::::::::::::::::::: 130
13.3.2.1 Startup with Nindy :::::::::::::::::::::::::: 130
13.3.2.2 Options for Nindy ::::::::::::::::::::::::::: 130
13.3.2.3 Nindy reset command ::::::::::::::::::::::: 131
13.3.3 The UDI protocol for AMD29K ::::::::::::::::::::::: 131
13.3.4 The EBMON protocol for AMD29K ::::::::::::::::::: 131
13.3.4.1 Communications setup ::::::::::::::::::::::: 132
13.3.4.2 EB29K cross-debugging :::::::::::::::::::::: 134
13.3.4.3 Remote log :::::::::::::::::::::::::::::::::: 134
13.3.5 GDB with a Tandem ST2000 ::::::::::::::::::::::::: 135
13.3.6 GDB and VxWorks ::::::::::::::::::::::::::::::::::: 135
13.3.6.1 Connecting to VxWorks ::::::::::::::::::::: 136
13.3.6.2 VxWorks download :::::::::::::::::::::::::: 137
13.3.6.3 Running tasks ::::::::::::::::::::::::::::::: 137
13.3.7 GDB and Hitachi Microprocessors :::::::::::::::::::: 138
13.3.8 GDB and remote MIPS boards :::::::::::::::::::::::: 138
13.3.9 Simulated CPU target :::::::::::::::::::::::::::::::: 140
14 Controlling GDB ::::::::::::::::::::::::::::::::: 141
14.1 Prompt :::::::::::::::::::::::::::::::::::::::::::::::::::::::: 141
14.2 Command editing :::::::::::::::::::::::::::::::::::::::::::::: 141
14.3 Command history :::::::::::::::::::::::::::::::::::::::::::::: 142
14.4 Screen size ::::::::::::::::::::::::::::::::::::::::::::::::::::: 143
14.5 Numbers ::::::::::::::::::::::::::::::::::::::::::::::::::::::: 144
14.6 Optional warnings and messages ::::::::::::::::::::::::::::::: 144
15 Canned Sequences of Commands :::::::::::::::: 147
15.1 User-dened commands :::::::::::::::::::::::::::::::::::::::: 147
15.2 User-dened command hooks ::::::::::::::::::::::::::::::::::: 148
15.3 Command les ::::::::::::::::::::::::::::::::::::::::::::::::: 149
15.4 Commands for controlled output ::::::::::::::::::::::::::::::: 150
16 Using GDB under GNU Emacs ::::::::::::::::: 151
17 Reporting Bugs in GDB ::::::::::::::::::::::::: 155
17.1 Have you found a bug? ::::::::::::::::::::::::::::::::::::::::: 155
17.2 How to report bugs :::::::::::::::::::::::::::::::::::::::::::: 155
v
Appendix A Command Line Editing ::::::::::::::: 159
A.1 Introduction to Line Editing :::::::::::::::::::::::::::::::::::: 159
A.2 Readline Interaction :::::::::::::::::::::::::::::::::::::::::::: 159
A.2.1 Readline Bare Essentials ::::::::::::::::::::::::::::::: 160
A.2.2 Readline Movement Commands :::::::::::::::::::::::: 160
A.2.3 Readline Killing Commands ::::::::::::::::::::::::::: 161
A.2.4 Readline Arguments ::::::::::::::::::::::::::::::::::: 162
A.3 Readline Init File::::::::::::::::::::::::::::::::::::::::::::::: 162
A.3.1 Readline Init Syntax :::::::::::::::::::::::::::::::::: 162
A.3.1.1 Commands For Moving ::::::::::::::::::::::: 164
A.3.1.2 Commands For Manipulating The History :::: 164
A.3.1.3 Commands For Changing Text ::::::::::::::: 165
A.3.1.4 Killing And Yanking ::::::::::::::::::::::::: 166
A.3.1.5 Specifying Numeric Arguments ::::::::::::::: 167
A.3.1.6 Letting Readline Type For You ::::::::::::::: 167
A.3.1.7 Some Miscellaneous Commands :::::::::::::: 167
A.3.2 Readline Vi Mode ::::::::::::::::::::::::::::::::::::: 168
Appendix B Using History Interactively ::::::::::: 169
B.1 History Interaction ::::::::::::::::::::::::::::::::::::::::::::: 169
B.1.1 Event Designators ::::::::::::::::::::::::::::::::::::: 169
B.1.2 Word Designators ::::::::::::::::::::::::::::::::::::: 170
B.1.3 Modiers :::::::::::::::::::::::::::::::::::::::::::::: 170
Appendix C Renamed Commands :::::::::::::::::: 171
Appendix D Formatting Documentation ::::::::::: 173
Appendix E Installing GDB ::::::::::::::::::::::::: 175
E.1 Compiling GDB in another directory :::::::::::::::::::::::::::: 177
E.2 Specifying names for hosts and targets :::::::::::::::::::::::::: 178
E.3 configure options :::::::::::::::::::::::::::::::::::::::::::::: 179
Index ::::::::::::::::::::::::::::::::::::::::::::::::::: 181
vi Debugging with GDB