1 \input texinfo @c -*-texinfo-*-
2 @c Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
3 @c 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
4 @c Free Software Foundation, Inc.
7 @c makeinfo ignores cmds prev to setfilename, so its arg cannot make use
8 @c of @set vars. However, you can override filename with makeinfo -o.
13 @settitle Debugging with @value{GDBN}
14 @setchapternewpage odd
25 @c readline appendices use @vindex, @findex and @ftable,
26 @c annotate.texi and gdbmi use @findex.
30 @c !!set GDB manual's edition---not the same as GDB version!
31 @c This is updated by GNU Press.
34 @c !!set GDB edit command default editor
37 @c THIS MANUAL REQUIRES TEXINFO 4.0 OR LATER.
39 @c This is a dir.info fragment to support semi-automated addition of
40 @c manuals to an info tree.
41 @dircategory Software development
43 * Gdb: (gdb). The GNU debugger.
47 This file documents the @sc{gnu} debugger @value{GDBN}.
50 This is the @value{EDITION} Edition, of @cite{Debugging with
51 @value{GDBN}: the @sc{gnu} Source-Level Debugger} for @value{GDBN}
52 Version @value{GDBVN}.
54 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,@*
55 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006@*
56 Free Software Foundation, Inc.
58 Permission is granted to copy, distribute and/or modify this document
59 under the terms of the GNU Free Documentation License, Version 1.1 or
60 any later version published by the Free Software Foundation; with the
61 Invariant Sections being ``Free Software'' and ``Free Software Needs
62 Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
63 and with the Back-Cover Texts as in (a) below.
65 (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
66 this GNU Manual. Buying copies from GNU Press supports the FSF in
67 developing GNU and promoting software freedom.''
71 @title Debugging with @value{GDBN}
72 @subtitle The @sc{gnu} Source-Level Debugger
74 @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN}
75 @author Richard Stallman, Roland Pesch, Stan Shebs, et al.
79 \hfill (Send bugs and comments on @value{GDBN} to bug-gdb\@gnu.org.)\par
80 \hfill {\it Debugging with @value{GDBN}}\par
81 \hfill \TeX{}info \texinfoversion\par
85 @vskip 0pt plus 1filll
86 Copyright @copyright{} 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
87 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2006
88 Free Software Foundation, Inc.
90 Published by the Free Software Foundation @*
91 51 Franklin Street, Fifth Floor,
92 Boston, MA 02110-1301, USA@*
95 Permission is granted to copy, distribute and/or modify this document
96 under the terms of the GNU Free Documentation License, Version 1.1 or
97 any later version published by the Free Software Foundation; with the
98 Invariant Sections being ``Free Software'' and ``Free Software Needs
99 Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
100 and with the Back-Cover Texts as in (a) below.
102 (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
103 this GNU Manual. Buying copies from GNU Press supports the FSF in
104 developing GNU and promoting software freedom.''
106 This edition of the GDB manual is dedicated to the memory of Fred
107 Fish. Fred was a long-standing contributor to GDB and to Free
108 software in general. We will miss him.
113 @node Top, Summary, (dir), (dir)
115 @top Debugging with @value{GDBN}
117 This file describes @value{GDBN}, the @sc{gnu} symbolic debugger.
119 This is the @value{EDITION} Edition, for @value{GDBN} Version
122 Copyright (C) 1988-2006 Free Software Foundation, Inc.
124 This edition of the GDB manual is dedicated to the memory of Fred
125 Fish. Fred was a long-standing contributor to GDB and to Free
126 software in general. We will miss him.
129 * Summary:: Summary of @value{GDBN}
130 * Sample Session:: A sample @value{GDBN} session
132 * Invocation:: Getting in and out of @value{GDBN}
133 * Commands:: @value{GDBN} commands
134 * Running:: Running programs under @value{GDBN}
135 * Stopping:: Stopping and continuing
136 * Stack:: Examining the stack
137 * Source:: Examining source files
138 * Data:: Examining data
139 * Macros:: Preprocessor Macros
140 * Tracepoints:: Debugging remote targets non-intrusively
141 * Overlays:: Debugging programs that use overlays
143 * Languages:: Using @value{GDBN} with different languages
145 * Symbols:: Examining the symbol table
146 * Altering:: Altering execution
147 * GDB Files:: @value{GDBN} files
148 * Targets:: Specifying a debugging target
149 * Remote Debugging:: Debugging remote programs
150 * Configurations:: Configuration-specific information
151 * Controlling GDB:: Controlling @value{GDBN}
152 * Sequences:: Canned sequences of commands
153 * Interpreters:: Command Interpreters
154 * TUI:: @value{GDBN} Text User Interface
155 * Emacs:: Using @value{GDBN} under @sc{gnu} Emacs
156 * GDB/MI:: @value{GDBN}'s Machine Interface.
157 * Annotations:: @value{GDBN}'s annotation interface.
159 * GDB Bugs:: Reporting bugs in @value{GDBN}
161 * Command Line Editing:: Command Line Editing
162 * Using History Interactively:: Using History Interactively
163 * Formatting Documentation:: How to format and print @value{GDBN} documentation
164 * Installing GDB:: Installing GDB
165 * Maintenance Commands:: Maintenance Commands
166 * Remote Protocol:: GDB Remote Serial Protocol
167 * Agent Expressions:: The GDB Agent Expression Mechanism
168 * Target Descriptions:: How targets can describe themselves to
170 * Copying:: GNU General Public License says
171 how you can copy and share GDB
172 * GNU Free Documentation License:: The license for this documentation
181 @unnumbered Summary of @value{GDBN}
183 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
184 going on ``inside'' another program while it executes---or what another
185 program was doing at the moment it crashed.
187 @value{GDBN} can do four main kinds of things (plus other things in support of
188 these) to help you catch bugs in the act:
192 Start your program, specifying anything that might affect its behavior.
195 Make your program stop on specified conditions.
198 Examine what has happened, when your program has stopped.
201 Change things in your program, so you can experiment with correcting the
202 effects of one bug and go on to learn about another.
205 You can use @value{GDBN} to debug programs written in C and C@t{++}.
206 For more information, see @ref{Supported Languages,,Supported Languages}.
207 For more information, see @ref{C,,C and C++}.
210 Support for Modula-2 is partial. For information on Modula-2, see
211 @ref{Modula-2,,Modula-2}.
214 Debugging Pascal programs which use sets, subranges, file variables, or
215 nested functions does not currently work. @value{GDBN} does not support
216 entering expressions, printing values, or similar features using Pascal
220 @value{GDBN} can be used to debug programs written in Fortran, although
221 it may be necessary to refer to some variables with a trailing
224 @value{GDBN} can be used to debug programs written in Objective-C,
225 using either the Apple/NeXT or the GNU Objective-C runtime.
228 * Free Software:: Freely redistributable software
229 * Contributors:: Contributors to GDB
233 @unnumberedsec Free Software
235 @value{GDBN} is @dfn{free software}, protected by the @sc{gnu}
236 General Public License
237 (GPL). The GPL gives you the freedom to copy or adapt a licensed
238 program---but every person getting a copy also gets with it the
239 freedom to modify that copy (which means that they must get access to
240 the source code), and the freedom to distribute further copies.
241 Typical software companies use copyrights to limit your freedoms; the
242 Free Software Foundation uses the GPL to preserve these freedoms.
244 Fundamentally, the General Public License is a license which says that
245 you have these freedoms and that you cannot take these freedoms away
248 @unnumberedsec Free Software Needs Free Documentation
250 The biggest deficiency in the free software community today is not in
251 the software---it is the lack of good free documentation that we can
252 include with the free software. Many of our most important
253 programs do not come with free reference manuals and free introductory
254 texts. Documentation is an essential part of any software package;
255 when an important free software package does not come with a free
256 manual and a free tutorial, that is a major gap. We have many such
259 Consider Perl, for instance. The tutorial manuals that people
260 normally use are non-free. How did this come about? Because the
261 authors of those manuals published them with restrictive terms---no
262 copying, no modification, source files not available---which exclude
263 them from the free software world.
265 That wasn't the first time this sort of thing happened, and it was far
266 from the last. Many times we have heard a GNU user eagerly describe a
267 manual that he is writing, his intended contribution to the community,
268 only to learn that he had ruined everything by signing a publication
269 contract to make it non-free.
271 Free documentation, like free software, is a matter of freedom, not
272 price. The problem with the non-free manual is not that publishers
273 charge a price for printed copies---that in itself is fine. (The Free
274 Software Foundation sells printed copies of manuals, too.) The
275 problem is the restrictions on the use of the manual. Free manuals
276 are available in source code form, and give you permission to copy and
277 modify. Non-free manuals do not allow this.
279 The criteria of freedom for a free manual are roughly the same as for
280 free software. Redistribution (including the normal kinds of
281 commercial redistribution) must be permitted, so that the manual can
282 accompany every copy of the program, both on-line and on paper.
284 Permission for modification of the technical content is crucial too.
285 When people modify the software, adding or changing features, if they
286 are conscientious they will change the manual too---so they can
287 provide accurate and clear documentation for the modified program. A
288 manual that leaves you no choice but to write a new manual to document
289 a changed version of the program is not really available to our
292 Some kinds of limits on the way modification is handled are
293 acceptable. For example, requirements to preserve the original
294 author's copyright notice, the distribution terms, or the list of
295 authors, are ok. It is also no problem to require modified versions
296 to include notice that they were modified. Even entire sections that
297 may not be deleted or changed are acceptable, as long as they deal
298 with nontechnical topics (like this one). These kinds of restrictions
299 are acceptable because they don't obstruct the community's normal use
302 However, it must be possible to modify all the @emph{technical}
303 content of the manual, and then distribute the result in all the usual
304 media, through all the usual channels. Otherwise, the restrictions
305 obstruct the use of the manual, it is not free, and we need another
306 manual to replace it.
308 Please spread the word about this issue. Our community continues to
309 lose manuals to proprietary publishing. If we spread the word that
310 free software needs free reference manuals and free tutorials, perhaps
311 the next person who wants to contribute by writing documentation will
312 realize, before it is too late, that only free manuals contribute to
313 the free software community.
315 If you are writing documentation, please insist on publishing it under
316 the GNU Free Documentation License or another free documentation
317 license. Remember that this decision requires your approval---you
318 don't have to let the publisher decide. Some commercial publishers
319 will use a free license if you insist, but they will not propose the
320 option; it is up to you to raise the issue and say firmly that this is
321 what you want. If the publisher you are dealing with refuses, please
322 try other publishers. If you're not sure whether a proposed license
323 is free, write to @email{licensing@@gnu.org}.
325 You can encourage commercial publishers to sell more free, copylefted
326 manuals and tutorials by buying them, and particularly by buying
327 copies from the publishers that paid for their writing or for major
328 improvements. Meanwhile, try to avoid buying non-free documentation
329 at all. Check the distribution terms of a manual before you buy it,
330 and insist that whoever seeks your business must respect your freedom.
331 Check the history of the book, and try to reward the publishers that
332 have paid or pay the authors to work on it.
334 The Free Software Foundation maintains a list of free documentation
335 published by other publishers, at
336 @url{http://www.fsf.org/doc/other-free-books.html}.
339 @unnumberedsec Contributors to @value{GDBN}
341 Richard Stallman was the original author of @value{GDBN}, and of many
342 other @sc{gnu} programs. Many others have contributed to its
343 development. This section attempts to credit major contributors. One
344 of the virtues of free software is that everyone is free to contribute
345 to it; with regret, we cannot actually acknowledge everyone here. The
346 file @file{ChangeLog} in the @value{GDBN} distribution approximates a
347 blow-by-blow account.
349 Changes much prior to version 2.0 are lost in the mists of time.
352 @emph{Plea:} Additions to this section are particularly welcome. If you
353 or your friends (or enemies, to be evenhanded) have been unfairly
354 omitted from this list, we would like to add your names!
357 So that they may not regard their many labors as thankless, we
358 particularly thank those who shepherded @value{GDBN} through major
360 Andrew Cagney (releases 6.3, 6.2, 6.1, 6.0, 5.3, 5.2, 5.1 and 5.0);
361 Jim Blandy (release 4.18);
362 Jason Molenda (release 4.17);
363 Stan Shebs (release 4.14);
364 Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9);
365 Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4);
366 John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9);
367 Jim Kingdon (releases 3.5, 3.4, and 3.3);
368 and Randy Smith (releases 3.2, 3.1, and 3.0).
370 Richard Stallman, assisted at various times by Peter TerMaat, Chris
371 Hanson, and Richard Mlynarik, handled releases through 2.8.
373 Michael Tiemann is the author of most of the @sc{gnu} C@t{++} support
374 in @value{GDBN}, with significant additional contributions from Per
375 Bothner and Daniel Berlin. James Clark wrote the @sc{gnu} C@t{++}
376 demangler. Early work on C@t{++} was by Peter TerMaat (who also did
377 much general update work leading to release 3.0).
379 @value{GDBN} uses the BFD subroutine library to examine multiple
380 object-file formats; BFD was a joint project of David V.
381 Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore.
383 David Johnson wrote the original COFF support; Pace Willison did
384 the original support for encapsulated COFF.
386 Brent Benson of Harris Computer Systems contributed DWARF 2 support.
388 Adam de Boor and Bradley Davis contributed the ISI Optimum V support.
389 Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS
391 Jean-Daniel Fekete contributed Sun 386i support.
392 Chris Hanson improved the HP9000 support.
393 Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support.
394 David Johnson contributed Encore Umax support.
395 Jyrki Kuoppala contributed Altos 3068 support.
396 Jeff Law contributed HP PA and SOM support.
397 Keith Packard contributed NS32K support.
398 Doug Rabson contributed Acorn Risc Machine support.
399 Bob Rusk contributed Harris Nighthawk CX-UX support.
400 Chris Smith contributed Convex support (and Fortran debugging).
401 Jonathan Stone contributed Pyramid support.
402 Michael Tiemann contributed SPARC support.
403 Tim Tucker contributed support for the Gould NP1 and Gould Powernode.
404 Pace Willison contributed Intel 386 support.
405 Jay Vosburgh contributed Symmetry support.
406 Marko Mlinar contributed OpenRISC 1000 support.
408 Andreas Schwab contributed M68K @sc{gnu}/Linux support.
410 Rich Schaefer and Peter Schauer helped with support of SunOS shared
413 Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree
414 about several machine instruction sets.
416 Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop
417 remote debugging. Intel Corporation, Wind River Systems, AMD, and ARM
418 contributed remote debugging modules for the i960, VxWorks, A29K UDI,
419 and RDI targets, respectively.
421 Brian Fox is the author of the readline libraries providing
422 command-line editing and command history.
424 Andrew Beers of SUNY Buffalo wrote the language-switching code, the
425 Modula-2 support, and contributed the Languages chapter of this manual.
427 Fred Fish wrote most of the support for Unix System Vr4.
428 He also enhanced the command-completion support to cover C@t{++} overloaded
431 Hitachi America (now Renesas America), Ltd. sponsored the support for
432 H8/300, H8/500, and Super-H processors.
434 NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors.
436 Mitsubishi (now Renesas) sponsored the support for D10V, D30V, and M32R/D
439 Toshiba sponsored the support for the TX39 Mips processor.
441 Matsushita sponsored the support for the MN10200 and MN10300 processors.
443 Fujitsu sponsored the support for SPARClite and FR30 processors.
445 Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware
448 Michael Snyder added support for tracepoints.
450 Stu Grossman wrote gdbserver.
452 Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made
453 nearly innumerable bug fixes and cleanups throughout @value{GDBN}.
455 The following people at the Hewlett-Packard Company contributed
456 support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0
457 (narrow mode), HP's implementation of kernel threads, HP's aC@t{++}
458 compiler, and the Text User Interface (nee Terminal User Interface):
459 Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann,
460 Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni. Kim Haase
461 provided HP-specific information in this manual.
463 DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project.
464 Robert Hoehne made significant contributions to the DJGPP port.
466 Cygnus Solutions has sponsored @value{GDBN} maintenance and much of its
467 development since 1991. Cygnus engineers who have worked on @value{GDBN}
468 fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin
469 Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim
470 Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler,
471 Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek
472 Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni. In
473 addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton,
474 JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug
475 Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff
476 Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner,
477 Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin
478 Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela
479 Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David
480 Zuhn have made contributions both large and small.
482 Andrew Cagney, Fernando Nasser, and Elena Zannoni, while working for
483 Cygnus Solutions, implemented the original @sc{gdb/mi} interface.
485 Jim Blandy added support for preprocessor macros, while working for Red
488 Andrew Cagney designed @value{GDBN}'s architecture vector. Many
489 people including Andrew Cagney, Stephane Carrez, Randolph Chung, Nick
490 Duffek, Richard Henderson, Mark Kettenis, Grace Sainsbury, Kei
491 Sakamoto, Yoshinori Sato, Michael Snyder, Andreas Schwab, Jason
492 Thorpe, Corinna Vinschen, Ulrich Weigand, and Elena Zannoni, helped
493 with the migration of old architectures to this new framework.
495 Andrew Cagney completely re-designed and re-implemented @value{GDBN}'s
496 unwinder framework, this consisting of a fresh new design featuring
497 frame IDs, independent frame sniffers, and the sentinel frame. Mark
498 Kettenis implemented the @sc{dwarf 2} unwinder, Jeff Johnston the
499 libunwind unwinder, and Andrew Cagney the dummy, sentinel, tramp, and
500 trad unwinders. The architecture-specific changes, each involving a
501 complete rewrite of the architecture's frame code, were carried out by
502 Jim Blandy, Joel Brobecker, Kevin Buettner, Andrew Cagney, Stephane
503 Carrez, Randolph Chung, Orjan Friberg, Richard Henderson, Daniel
504 Jacobowitz, Jeff Johnston, Mark Kettenis, Theodore A. Roth, Kei
505 Sakamoto, Yoshinori Sato, Michael Snyder, Corinna Vinschen, and Ulrich
508 Christian Zankel, Ross Morley, Bob Wilson, and Maxim Grigoriev from
509 Tensilica, Inc.@: contributed support for Xtensa processors. Others
510 who have worked on the Xtensa port of @value{GDBN} in the past include
511 Steve Tjiang, John Newlin, and Scott Foehner.
514 @chapter A Sample @value{GDBN} Session
516 You can use this manual at your leisure to read all about @value{GDBN}.
517 However, a handful of commands are enough to get started using the
518 debugger. This chapter illustrates those commands.
521 In this sample session, we emphasize user input like this: @b{input},
522 to make it easier to pick out from the surrounding output.
525 @c FIXME: this example may not be appropriate for some configs, where
526 @c FIXME...primary interest is in remote use.
528 One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro
529 processor) exhibits the following bug: sometimes, when we change its
530 quote strings from the default, the commands used to capture one macro
531 definition within another stop working. In the following short @code{m4}
532 session, we define a macro @code{foo} which expands to @code{0000}; we
533 then use the @code{m4} built-in @code{defn} to define @code{bar} as the
534 same thing. However, when we change the open quote string to
535 @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same
536 procedure fails to define a new synonym @code{baz}:
545 @b{define(bar,defn(`foo'))}
549 @b{changequote(<QUOTE>,<UNQUOTE>)}
551 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
554 m4: End of input: 0: fatal error: EOF in string
558 Let us use @value{GDBN} to try to see what is going on.
561 $ @b{@value{GDBP} m4}
562 @c FIXME: this falsifies the exact text played out, to permit smallbook
563 @c FIXME... format to come out better.
564 @value{GDBN} is free software and you are welcome to distribute copies
565 of it under certain conditions; type "show copying" to see
567 There is absolutely no warranty for @value{GDBN}; type "show warranty"
570 @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc...
575 @value{GDBN} reads only enough symbol data to know where to find the
576 rest when needed; as a result, the first prompt comes up very quickly.
577 We now tell @value{GDBN} to use a narrower display width than usual, so
578 that examples fit in this manual.
581 (@value{GDBP}) @b{set width 70}
585 We need to see how the @code{m4} built-in @code{changequote} works.
586 Having looked at the source, we know the relevant subroutine is
587 @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
588 @code{break} command.
591 (@value{GDBP}) @b{break m4_changequote}
592 Breakpoint 1 at 0x62f4: file builtin.c, line 879.
596 Using the @code{run} command, we start @code{m4} running under @value{GDBN}
597 control; as long as control does not reach the @code{m4_changequote}
598 subroutine, the program runs as usual:
601 (@value{GDBP}) @b{run}
602 Starting program: /work/Editorial/gdb/gnu/m4/m4
610 To trigger the breakpoint, we call @code{changequote}. @value{GDBN}
611 suspends execution of @code{m4}, displaying information about the
612 context where it stops.
615 @b{changequote(<QUOTE>,<UNQUOTE>)}
617 Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
619 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))
623 Now we use the command @code{n} (@code{next}) to advance execution to
624 the next line of the current function.
628 882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
633 @code{set_quotes} looks like a promising subroutine. We can go into it
634 by using the command @code{s} (@code{step}) instead of @code{next}.
635 @code{step} goes to the next line to be executed in @emph{any}
636 subroutine, so it steps into @code{set_quotes}.
640 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
642 530 if (lquote != def_lquote)
646 The display that shows the subroutine where @code{m4} is now
647 suspended (and its arguments) is called a stack frame display. It
648 shows a summary of the stack. We can use the @code{backtrace}
649 command (which can also be spelled @code{bt}), to see where we are
650 in the stack as a whole: the @code{backtrace} command displays a
651 stack frame for each active subroutine.
654 (@value{GDBP}) @b{bt}
655 #0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
657 #1 0x6344 in m4_changequote (argc=3, argv=0x33c70)
659 #2 0x8174 in expand_macro (sym=0x33320) at macro.c:242
660 #3 0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
662 #4 0x79dc in expand_input () at macro.c:40
663 #5 0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195
667 We step through a few more lines to see what happens. The first two
668 times, we can use @samp{s}; the next two times we use @code{n} to avoid
669 falling into the @code{xstrdup} subroutine.
673 0x3b5c 532 if (rquote != def_rquote)
675 0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \
676 def_lquote : xstrdup(lq);
678 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
681 538 len_lquote = strlen(rquote);
685 The last line displayed looks a little odd; we can examine the variables
686 @code{lquote} and @code{rquote} to see if they are in fact the new left
687 and right quotes we specified. We use the command @code{p}
688 (@code{print}) to see their values.
691 (@value{GDBP}) @b{p lquote}
692 $1 = 0x35d40 "<QUOTE>"
693 (@value{GDBP}) @b{p rquote}
694 $2 = 0x35d50 "<UNQUOTE>"
698 @code{lquote} and @code{rquote} are indeed the new left and right quotes.
699 To look at some context, we can display ten lines of source
700 surrounding the current line with the @code{l} (@code{list}) command.
706 535 lquote = (lq == nil || *lq == '\0') ? def_lquote\
708 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
711 538 len_lquote = strlen(rquote);
712 539 len_rquote = strlen(lquote);
719 Let us step past the two lines that set @code{len_lquote} and
720 @code{len_rquote}, and then examine the values of those variables.
724 539 len_rquote = strlen(lquote);
727 (@value{GDBP}) @b{p len_lquote}
729 (@value{GDBP}) @b{p len_rquote}
734 That certainly looks wrong, assuming @code{len_lquote} and
735 @code{len_rquote} are meant to be the lengths of @code{lquote} and
736 @code{rquote} respectively. We can set them to better values using
737 the @code{p} command, since it can print the value of
738 any expression---and that expression can include subroutine calls and
742 (@value{GDBP}) @b{p len_lquote=strlen(lquote)}
744 (@value{GDBP}) @b{p len_rquote=strlen(rquote)}
749 Is that enough to fix the problem of using the new quotes with the
750 @code{m4} built-in @code{defn}? We can allow @code{m4} to continue
751 executing with the @code{c} (@code{continue}) command, and then try the
752 example that caused trouble initially:
758 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
765 Success! The new quotes now work just as well as the default ones. The
766 problem seems to have been just the two typos defining the wrong
767 lengths. We allow @code{m4} exit by giving it an EOF as input:
771 Program exited normally.
775 The message @samp{Program exited normally.} is from @value{GDBN}; it
776 indicates @code{m4} has finished executing. We can end our @value{GDBN}
777 session with the @value{GDBN} @code{quit} command.
780 (@value{GDBP}) @b{quit}
784 @chapter Getting In and Out of @value{GDBN}
786 This chapter discusses how to start @value{GDBN}, and how to get out of it.
790 type @samp{@value{GDBP}} to start @value{GDBN}.
792 type @kbd{quit} or @kbd{Ctrl-d} to exit.
796 * Invoking GDB:: How to start @value{GDBN}
797 * Quitting GDB:: How to quit @value{GDBN}
798 * Shell Commands:: How to use shell commands inside @value{GDBN}
799 * Logging Output:: How to log @value{GDBN}'s output to a file
803 @section Invoking @value{GDBN}
805 Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started,
806 @value{GDBN} reads commands from the terminal until you tell it to exit.
808 You can also run @code{@value{GDBP}} with a variety of arguments and options,
809 to specify more of your debugging environment at the outset.
811 The command-line options described here are designed
812 to cover a variety of situations; in some environments, some of these
813 options may effectively be unavailable.
815 The most usual way to start @value{GDBN} is with one argument,
816 specifying an executable program:
819 @value{GDBP} @var{program}
823 You can also start with both an executable program and a core file
827 @value{GDBP} @var{program} @var{core}
830 You can, instead, specify a process ID as a second argument, if you want
831 to debug a running process:
834 @value{GDBP} @var{program} 1234
838 would attach @value{GDBN} to process @code{1234} (unless you also have a file
839 named @file{1234}; @value{GDBN} does check for a core file first).
841 Taking advantage of the second command-line argument requires a fairly
842 complete operating system; when you use @value{GDBN} as a remote
843 debugger attached to a bare board, there may not be any notion of
844 ``process'', and there is often no way to get a core dump. @value{GDBN}
845 will warn you if it is unable to attach or to read core dumps.
847 You can optionally have @code{@value{GDBP}} pass any arguments after the
848 executable file to the inferior using @code{--args}. This option stops
851 @value{GDBP} --args gcc -O2 -c foo.c
853 This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
854 @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}.
856 You can run @code{@value{GDBP}} without printing the front material, which describes
857 @value{GDBN}'s non-warranty, by specifying @code{-silent}:
864 You can further control how @value{GDBN} starts up by using command-line
865 options. @value{GDBN} itself can remind you of the options available.
875 to display all available options and briefly describe their use
876 (@samp{@value{GDBP} -h} is a shorter equivalent).
878 All options and command line arguments you give are processed
879 in sequential order. The order makes a difference when the
880 @samp{-x} option is used.
884 * File Options:: Choosing files
885 * Mode Options:: Choosing modes
886 * Startup:: What @value{GDBN} does during startup
890 @subsection Choosing Files
892 When @value{GDBN} starts, it reads any arguments other than options as
893 specifying an executable file and core file (or process ID). This is
894 the same as if the arguments were specified by the @samp{-se} and
895 @samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the
896 first argument that does not have an associated option flag as
897 equivalent to the @samp{-se} option followed by that argument; and the
898 second argument that does not have an associated option flag, if any, as
899 equivalent to the @samp{-c}/@samp{-p} option followed by that argument.)
900 If the second argument begins with a decimal digit, @value{GDBN} will
901 first attempt to attach to it as a process, and if that fails, attempt
902 to open it as a corefile. If you have a corefile whose name begins with
903 a digit, you can prevent @value{GDBN} from treating it as a pid by
904 prefixing it with @file{./}, e.g.@: @file{./12345}.
906 If @value{GDBN} has not been configured to included core file support,
907 such as for most embedded targets, then it will complain about a second
908 argument and ignore it.
910 Many options have both long and short forms; both are shown in the
911 following list. @value{GDBN} also recognizes the long forms if you truncate
912 them, so long as enough of the option is present to be unambiguous.
913 (If you prefer, you can flag option arguments with @samp{--} rather
914 than @samp{-}, though we illustrate the more usual convention.)
916 @c NOTE: the @cindex entries here use double dashes ON PURPOSE. This
917 @c way, both those who look for -foo and --foo in the index, will find
921 @item -symbols @var{file}
923 @cindex @code{--symbols}
925 Read symbol table from file @var{file}.
927 @item -exec @var{file}
929 @cindex @code{--exec}
931 Use file @var{file} as the executable file to execute when appropriate,
932 and for examining pure data in conjunction with a core dump.
936 Read symbol table from file @var{file} and use it as the executable
939 @item -core @var{file}
941 @cindex @code{--core}
943 Use file @var{file} as a core dump to examine.
945 @item -c @var{number}
946 @item -pid @var{number}
947 @itemx -p @var{number}
950 Connect to process ID @var{number}, as with the @code{attach} command.
951 If there is no such process, @value{GDBN} will attempt to open a core
952 file named @var{number}.
954 @item -command @var{file}
956 @cindex @code{--command}
958 Execute @value{GDBN} commands from file @var{file}. @xref{Command
959 Files,, Command files}.
961 @item -eval-command @var{command}
962 @itemx -ex @var{command}
963 @cindex @code{--eval-command}
965 Execute a single @value{GDBN} command.
967 This option may be used multiple times to call multiple commands. It may
968 also be interleaved with @samp{-command} as required.
971 @value{GDBP} -ex 'target sim' -ex 'load' \
972 -x setbreakpoints -ex 'run' a.out
975 @item -directory @var{directory}
976 @itemx -d @var{directory}
977 @cindex @code{--directory}
979 Add @var{directory} to the path to search for source and script files.
983 @cindex @code{--readnow}
985 Read each symbol file's entire symbol table immediately, rather than
986 the default, which is to read it incrementally as it is needed.
987 This makes startup slower, but makes future operations faster.
992 @subsection Choosing Modes
994 You can run @value{GDBN} in various alternative modes---for example, in
995 batch mode or quiet mode.
1002 Do not execute commands found in any initialization files. Normally,
1003 @value{GDBN} executes the commands in these files after all the command
1004 options and arguments have been processed. @xref{Command Files,,Command
1010 @cindex @code{--quiet}
1011 @cindex @code{--silent}
1013 ``Quiet''. Do not print the introductory and copyright messages. These
1014 messages are also suppressed in batch mode.
1017 @cindex @code{--batch}
1018 Run in batch mode. Exit with status @code{0} after processing all the
1019 command files specified with @samp{-x} (and all commands from
1020 initialization files, if not inhibited with @samp{-n}). Exit with
1021 nonzero status if an error occurs in executing the @value{GDBN} commands
1022 in the command files.
1024 Batch mode may be useful for running @value{GDBN} as a filter, for
1025 example to download and run a program on another computer; in order to
1026 make this more useful, the message
1029 Program exited normally.
1033 (which is ordinarily issued whenever a program running under
1034 @value{GDBN} control terminates) is not issued when running in batch
1038 @cindex @code{--batch-silent}
1039 Run in batch mode exactly like @samp{-batch}, but totally silently. All
1040 @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is
1041 unaffected). This is much quieter than @samp{-silent} and would be useless
1042 for an interactive session.
1044 This is particularly useful when using targets that give @samp{Loading section}
1045 messages, for example.
1047 Note that targets that give their output via @value{GDBN}, as opposed to
1048 writing directly to @code{stdout}, will also be made silent.
1050 @item -return-child-result
1051 @cindex @code{--return-child-result}
1052 The return code from @value{GDBN} will be the return code from the child
1053 process (the process being debugged), with the following exceptions:
1057 @value{GDBN} exits abnormally. E.g., due to an incorrect argument or an
1058 internal error. In this case the exit code is the same as it would have been
1059 without @samp{-return-child-result}.
1061 The user quits with an explicit value. E.g., @samp{quit 1}.
1063 The child process never runs, or is not allowed to terminate, in which case
1064 the exit code will be -1.
1067 This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent},
1068 when @value{GDBN} is being used as a remote program loader or simulator
1073 @cindex @code{--nowindows}
1075 ``No windows''. If @value{GDBN} comes with a graphical user interface
1076 (GUI) built in, then this option tells @value{GDBN} to only use the command-line
1077 interface. If no GUI is available, this option has no effect.
1081 @cindex @code{--windows}
1083 If @value{GDBN} includes a GUI, then this option requires it to be
1086 @item -cd @var{directory}
1088 Run @value{GDBN} using @var{directory} as its working directory,
1089 instead of the current directory.
1093 @cindex @code{--fullname}
1095 @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
1096 subprocess. It tells @value{GDBN} to output the full file name and line
1097 number in a standard, recognizable fashion each time a stack frame is
1098 displayed (which includes each time your program stops). This
1099 recognizable format looks like two @samp{\032} characters, followed by
1100 the file name, line number and character position separated by colons,
1101 and a newline. The Emacs-to-@value{GDBN} interface program uses the two
1102 @samp{\032} characters as a signal to display the source code for the
1106 @cindex @code{--epoch}
1107 The Epoch Emacs-@value{GDBN} interface sets this option when it runs
1108 @value{GDBN} as a subprocess. It tells @value{GDBN} to modify its print
1109 routines so as to allow Epoch to display values of expressions in a
1112 @item -annotate @var{level}
1113 @cindex @code{--annotate}
1114 This option sets the @dfn{annotation level} inside @value{GDBN}. Its
1115 effect is identical to using @samp{set annotate @var{level}}
1116 (@pxref{Annotations}). The annotation @var{level} controls how much
1117 information @value{GDBN} prints together with its prompt, values of
1118 expressions, source lines, and other types of output. Level 0 is the
1119 normal, level 1 is for use when @value{GDBN} is run as a subprocess of
1120 @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs
1121 that control @value{GDBN}, and level 2 has been deprecated.
1123 The annotation mechanism has largely been superseded by @sc{gdb/mi}
1127 @cindex @code{--args}
1128 Change interpretation of command line so that arguments following the
1129 executable file are passed as command line arguments to the inferior.
1130 This option stops option processing.
1132 @item -baud @var{bps}
1134 @cindex @code{--baud}
1136 Set the line speed (baud rate or bits per second) of any serial
1137 interface used by @value{GDBN} for remote debugging.
1139 @item -l @var{timeout}
1141 Set the timeout (in seconds) of any communication used by @value{GDBN}
1142 for remote debugging.
1144 @item -tty @var{device}
1145 @itemx -t @var{device}
1146 @cindex @code{--tty}
1148 Run using @var{device} for your program's standard input and output.
1149 @c FIXME: kingdon thinks there is more to -tty. Investigate.
1151 @c resolve the situation of these eventually
1153 @cindex @code{--tui}
1154 Activate the @dfn{Text User Interface} when starting. The Text User
1155 Interface manages several text windows on the terminal, showing
1156 source, assembly, registers and @value{GDBN} command outputs
1157 (@pxref{TUI, ,@value{GDBN} Text User Interface}). Alternatively, the
1158 Text User Interface can be enabled by invoking the program
1159 @samp{@value{GDBTUI}}. Do not use this option if you run @value{GDBN} from
1160 Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}).
1163 @c @cindex @code{--xdb}
1164 @c Run in XDB compatibility mode, allowing the use of certain XDB commands.
1165 @c For information, see the file @file{xdb_trans.html}, which is usually
1166 @c installed in the directory @code{/opt/langtools/wdb/doc} on HP-UX
1169 @item -interpreter @var{interp}
1170 @cindex @code{--interpreter}
1171 Use the interpreter @var{interp} for interface with the controlling
1172 program or device. This option is meant to be set by programs which
1173 communicate with @value{GDBN} using it as a back end.
1174 @xref{Interpreters, , Command Interpreters}.
1176 @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes
1177 @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, ,
1178 The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0. The
1179 previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and
1180 selected with @samp{--interpreter=mi1}, is deprecated. Earlier
1181 @sc{gdb/mi} interfaces are no longer supported.
1184 @cindex @code{--write}
1185 Open the executable and core files for both reading and writing. This
1186 is equivalent to the @samp{set write on} command inside @value{GDBN}
1190 @cindex @code{--statistics}
1191 This option causes @value{GDBN} to print statistics about time and
1192 memory usage after it completes each command and returns to the prompt.
1195 @cindex @code{--version}
1196 This option causes @value{GDBN} to print its version number and
1197 no-warranty blurb, and exit.
1202 @subsection What @value{GDBN} Does During Startup
1203 @cindex @value{GDBN} startup
1205 Here's the description of what @value{GDBN} does during session startup:
1209 Sets up the command interpreter as specified by the command line
1210 (@pxref{Mode Options, interpreter}).
1214 Reads the @dfn{init file} (if any) in your home directory@footnote{On
1215 DOS/Windows systems, the home directory is the one pointed to by the
1216 @code{HOME} environment variable.} and executes all the commands in
1220 Processes command line options and operands.
1223 Reads and executes the commands from init file (if any) in the current
1224 working directory. This is only done if the current directory is
1225 different from your home directory. Thus, you can have more than one
1226 init file, one generic in your home directory, and another, specific
1227 to the program you are debugging, in the directory where you invoke
1231 Reads command files specified by the @samp{-x} option. @xref{Command
1232 Files}, for more details about @value{GDBN} command files.
1235 Reads the command history recorded in the @dfn{history file}.
1236 @xref{Command History}, for more details about the command history and the
1237 files where @value{GDBN} records it.
1240 Init files use the same syntax as @dfn{command files} (@pxref{Command
1241 Files}) and are processed by @value{GDBN} in the same way. The init
1242 file in your home directory can set options (such as @samp{set
1243 complaints}) that affect subsequent processing of command line options
1244 and operands. Init files are not executed if you use the @samp{-nx}
1245 option (@pxref{Mode Options, ,Choosing Modes}).
1247 @cindex init file name
1248 @cindex @file{.gdbinit}
1249 @cindex @file{gdb.ini}
1250 The @value{GDBN} init files are normally called @file{.gdbinit}.
1251 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
1252 the limitations of file names imposed by DOS filesystems. The Windows
1253 ports of @value{GDBN} use the standard name, but if they find a
1254 @file{gdb.ini} file, they warn you about that and suggest to rename
1255 the file to the standard name.
1259 @section Quitting @value{GDBN}
1260 @cindex exiting @value{GDBN}
1261 @cindex leaving @value{GDBN}
1264 @kindex quit @r{[}@var{expression}@r{]}
1265 @kindex q @r{(@code{quit})}
1266 @item quit @r{[}@var{expression}@r{]}
1268 To exit @value{GDBN}, use the @code{quit} command (abbreviated
1269 @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you
1270 do not supply @var{expression}, @value{GDBN} will terminate normally;
1271 otherwise it will terminate using the result of @var{expression} as the
1276 An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather
1277 terminates the action of any @value{GDBN} command that is in progress and
1278 returns to @value{GDBN} command level. It is safe to type the interrupt
1279 character at any time because @value{GDBN} does not allow it to take effect
1280 until a time when it is safe.
1282 If you have been using @value{GDBN} to control an attached process or
1283 device, you can release it with the @code{detach} command
1284 (@pxref{Attach, ,Debugging an Already-running Process}).
1286 @node Shell Commands
1287 @section Shell Commands
1289 If you need to execute occasional shell commands during your
1290 debugging session, there is no need to leave or suspend @value{GDBN}; you can
1291 just use the @code{shell} command.
1295 @cindex shell escape
1296 @item shell @var{command string}
1297 Invoke a standard shell to execute @var{command string}.
1298 If it exists, the environment variable @code{SHELL} determines which
1299 shell to run. Otherwise @value{GDBN} uses the default shell
1300 (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.).
1303 The utility @code{make} is often needed in development environments.
1304 You do not have to use the @code{shell} command for this purpose in
1309 @cindex calling make
1310 @item make @var{make-args}
1311 Execute the @code{make} program with the specified
1312 arguments. This is equivalent to @samp{shell make @var{make-args}}.
1315 @node Logging Output
1316 @section Logging Output
1317 @cindex logging @value{GDBN} output
1318 @cindex save @value{GDBN} output to a file
1320 You may want to save the output of @value{GDBN} commands to a file.
1321 There are several commands to control @value{GDBN}'s logging.
1325 @item set logging on
1327 @item set logging off
1329 @cindex logging file name
1330 @item set logging file @var{file}
1331 Change the name of the current logfile. The default logfile is @file{gdb.txt}.
1332 @item set logging overwrite [on|off]
1333 By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if
1334 you want @code{set logging on} to overwrite the logfile instead.
1335 @item set logging redirect [on|off]
1336 By default, @value{GDBN} output will go to both the terminal and the logfile.
1337 Set @code{redirect} if you want output to go only to the log file.
1338 @kindex show logging
1340 Show the current values of the logging settings.
1344 @chapter @value{GDBN} Commands
1346 You can abbreviate a @value{GDBN} command to the first few letters of the command
1347 name, if that abbreviation is unambiguous; and you can repeat certain
1348 @value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB}
1349 key to get @value{GDBN} to fill out the rest of a word in a command (or to
1350 show you the alternatives available, if there is more than one possibility).
1353 * Command Syntax:: How to give commands to @value{GDBN}
1354 * Completion:: Command completion
1355 * Help:: How to ask @value{GDBN} for help
1358 @node Command Syntax
1359 @section Command Syntax
1361 A @value{GDBN} command is a single line of input. There is no limit on
1362 how long it can be. It starts with a command name, which is followed by
1363 arguments whose meaning depends on the command name. For example, the
1364 command @code{step} accepts an argument which is the number of times to
1365 step, as in @samp{step 5}. You can also use the @code{step} command
1366 with no arguments. Some commands do not allow any arguments.
1368 @cindex abbreviation
1369 @value{GDBN} command names may always be truncated if that abbreviation is
1370 unambiguous. Other possible command abbreviations are listed in the
1371 documentation for individual commands. In some cases, even ambiguous
1372 abbreviations are allowed; for example, @code{s} is specially defined as
1373 equivalent to @code{step} even though there are other commands whose
1374 names start with @code{s}. You can test abbreviations by using them as
1375 arguments to the @code{help} command.
1377 @cindex repeating commands
1378 @kindex RET @r{(repeat last command)}
1379 A blank line as input to @value{GDBN} (typing just @key{RET}) means to
1380 repeat the previous command. Certain commands (for example, @code{run})
1381 will not repeat this way; these are commands whose unintentional
1382 repetition might cause trouble and which you are unlikely to want to
1383 repeat. User-defined commands can disable this feature; see
1384 @ref{Define, dont-repeat}.
1386 The @code{list} and @code{x} commands, when you repeat them with
1387 @key{RET}, construct new arguments rather than repeating
1388 exactly as typed. This permits easy scanning of source or memory.
1390 @value{GDBN} can also use @key{RET} in another way: to partition lengthy
1391 output, in a way similar to the common utility @code{more}
1392 (@pxref{Screen Size,,Screen Size}). Since it is easy to press one
1393 @key{RET} too many in this situation, @value{GDBN} disables command
1394 repetition after any command that generates this sort of display.
1396 @kindex # @r{(a comment)}
1398 Any text from a @kbd{#} to the end of the line is a comment; it does
1399 nothing. This is useful mainly in command files (@pxref{Command
1400 Files,,Command Files}).
1402 @cindex repeating command sequences
1403 @kindex Ctrl-o @r{(operate-and-get-next)}
1404 The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of
1405 commands. This command accepts the current line, like @key{RET}, and
1406 then fetches the next line relative to the current line from the history
1410 @section Command Completion
1413 @cindex word completion
1414 @value{GDBN} can fill in the rest of a word in a command for you, if there is
1415 only one possibility; it can also show you what the valid possibilities
1416 are for the next word in a command, at any time. This works for @value{GDBN}
1417 commands, @value{GDBN} subcommands, and the names of symbols in your program.
1419 Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
1420 of a word. If there is only one possibility, @value{GDBN} fills in the
1421 word, and waits for you to finish the command (or press @key{RET} to
1422 enter it). For example, if you type
1424 @c FIXME "@key" does not distinguish its argument sufficiently to permit
1425 @c complete accuracy in these examples; space introduced for clarity.
1426 @c If texinfo enhancements make it unnecessary, it would be nice to
1427 @c replace " @key" by "@key" in the following...
1429 (@value{GDBP}) info bre @key{TAB}
1433 @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
1434 the only @code{info} subcommand beginning with @samp{bre}:
1437 (@value{GDBP}) info breakpoints
1441 You can either press @key{RET} at this point, to run the @code{info
1442 breakpoints} command, or backspace and enter something else, if
1443 @samp{breakpoints} does not look like the command you expected. (If you
1444 were sure you wanted @code{info breakpoints} in the first place, you
1445 might as well just type @key{RET} immediately after @samp{info bre},
1446 to exploit command abbreviations rather than command completion).
1448 If there is more than one possibility for the next word when you press
1449 @key{TAB}, @value{GDBN} sounds a bell. You can either supply more
1450 characters and try again, or just press @key{TAB} a second time;
1451 @value{GDBN} displays all the possible completions for that word. For
1452 example, you might want to set a breakpoint on a subroutine whose name
1453 begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
1454 just sounds the bell. Typing @key{TAB} again displays all the
1455 function names in your program that begin with those characters, for
1459 (@value{GDBP}) b make_ @key{TAB}
1460 @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
1461 make_a_section_from_file make_environ
1462 make_abs_section make_function_type
1463 make_blockvector make_pointer_type
1464 make_cleanup make_reference_type
1465 make_command make_symbol_completion_list
1466 (@value{GDBP}) b make_
1470 After displaying the available possibilities, @value{GDBN} copies your
1471 partial input (@samp{b make_} in the example) so you can finish the
1474 If you just want to see the list of alternatives in the first place, you
1475 can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?}
1476 means @kbd{@key{META} ?}. You can type this either by holding down a
1477 key designated as the @key{META} shift on your keyboard (if there is
1478 one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}.
1480 @cindex quotes in commands
1481 @cindex completion of quoted strings
1482 Sometimes the string you need, while logically a ``word'', may contain
1483 parentheses or other characters that @value{GDBN} normally excludes from
1484 its notion of a word. To permit word completion to work in this
1485 situation, you may enclose words in @code{'} (single quote marks) in
1486 @value{GDBN} commands.
1488 The most likely situation where you might need this is in typing the
1489 name of a C@t{++} function. This is because C@t{++} allows function
1490 overloading (multiple definitions of the same function, distinguished
1491 by argument type). For example, when you want to set a breakpoint you
1492 may need to distinguish whether you mean the version of @code{name}
1493 that takes an @code{int} parameter, @code{name(int)}, or the version
1494 that takes a @code{float} parameter, @code{name(float)}. To use the
1495 word-completion facilities in this situation, type a single quote
1496 @code{'} at the beginning of the function name. This alerts
1497 @value{GDBN} that it may need to consider more information than usual
1498 when you press @key{TAB} or @kbd{M-?} to request word completion:
1501 (@value{GDBP}) b 'bubble( @kbd{M-?}
1502 bubble(double,double) bubble(int,int)
1503 (@value{GDBP}) b 'bubble(
1506 In some cases, @value{GDBN} can tell that completing a name requires using
1507 quotes. When this happens, @value{GDBN} inserts the quote for you (while
1508 completing as much as it can) if you do not type the quote in the first
1512 (@value{GDBP}) b bub @key{TAB}
1513 @exdent @value{GDBN} alters your input line to the following, and rings a bell:
1514 (@value{GDBP}) b 'bubble(
1518 In general, @value{GDBN} can tell that a quote is needed (and inserts it) if
1519 you have not yet started typing the argument list when you ask for
1520 completion on an overloaded symbol.
1522 For more information about overloaded functions, see @ref{C Plus Plus
1523 Expressions, ,C@t{++} Expressions}. You can use the command @code{set
1524 overload-resolution off} to disable overload resolution;
1525 see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}.
1529 @section Getting Help
1530 @cindex online documentation
1533 You can always ask @value{GDBN} itself for information on its commands,
1534 using the command @code{help}.
1537 @kindex h @r{(@code{help})}
1540 You can use @code{help} (abbreviated @code{h}) with no arguments to
1541 display a short list of named classes of commands:
1545 List of classes of commands:
1547 aliases -- Aliases of other commands
1548 breakpoints -- Making program stop at certain points
1549 data -- Examining data
1550 files -- Specifying and examining files
1551 internals -- Maintenance commands
1552 obscure -- Obscure features
1553 running -- Running the program
1554 stack -- Examining the stack
1555 status -- Status inquiries
1556 support -- Support facilities
1557 tracepoints -- Tracing of program execution without
1558 stopping the program
1559 user-defined -- User-defined commands
1561 Type "help" followed by a class name for a list of
1562 commands in that class.
1563 Type "help" followed by command name for full
1565 Command name abbreviations are allowed if unambiguous.
1568 @c the above line break eliminates huge line overfull...
1570 @item help @var{class}
1571 Using one of the general help classes as an argument, you can get a
1572 list of the individual commands in that class. For example, here is the
1573 help display for the class @code{status}:
1576 (@value{GDBP}) help status
1581 @c Line break in "show" line falsifies real output, but needed
1582 @c to fit in smallbook page size.
1583 info -- Generic command for showing things
1584 about the program being debugged
1585 show -- Generic command for showing things
1588 Type "help" followed by command name for full
1590 Command name abbreviations are allowed if unambiguous.
1594 @item help @var{command}
1595 With a command name as @code{help} argument, @value{GDBN} displays a
1596 short paragraph on how to use that command.
1599 @item apropos @var{args}
1600 The @code{apropos} command searches through all of the @value{GDBN}
1601 commands, and their documentation, for the regular expression specified in
1602 @var{args}. It prints out all matches found. For example:
1613 set symbol-reloading -- Set dynamic symbol table reloading
1614 multiple times in one run
1615 show symbol-reloading -- Show dynamic symbol table reloading
1616 multiple times in one run
1621 @item complete @var{args}
1622 The @code{complete @var{args}} command lists all the possible completions
1623 for the beginning of a command. Use @var{args} to specify the beginning of the
1624 command you want completed. For example:
1630 @noindent results in:
1641 @noindent This is intended for use by @sc{gnu} Emacs.
1644 In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
1645 and @code{show} to inquire about the state of your program, or the state
1646 of @value{GDBN} itself. Each command supports many topics of inquiry; this
1647 manual introduces each of them in the appropriate context. The listings
1648 under @code{info} and under @code{show} in the Index point to
1649 all the sub-commands. @xref{Index}.
1654 @kindex i @r{(@code{info})}
1656 This command (abbreviated @code{i}) is for describing the state of your
1657 program. For example, you can list the arguments given to your program
1658 with @code{info args}, list the registers currently in use with @code{info
1659 registers}, or list the breakpoints you have set with @code{info breakpoints}.
1660 You can get a complete list of the @code{info} sub-commands with
1661 @w{@code{help info}}.
1665 You can assign the result of an expression to an environment variable with
1666 @code{set}. For example, you can set the @value{GDBN} prompt to a $-sign with
1667 @code{set prompt $}.
1671 In contrast to @code{info}, @code{show} is for describing the state of
1672 @value{GDBN} itself.
1673 You can change most of the things you can @code{show}, by using the
1674 related command @code{set}; for example, you can control what number
1675 system is used for displays with @code{set radix}, or simply inquire
1676 which is currently in use with @code{show radix}.
1679 To display all the settable parameters and their current
1680 values, you can use @code{show} with no arguments; you may also use
1681 @code{info set}. Both commands produce the same display.
1682 @c FIXME: "info set" violates the rule that "info" is for state of
1683 @c FIXME...program. Ck w/ GNU: "info set" to be called something else,
1684 @c FIXME...or change desc of rule---eg "state of prog and debugging session"?
1688 Here are three miscellaneous @code{show} subcommands, all of which are
1689 exceptional in lacking corresponding @code{set} commands:
1692 @kindex show version
1693 @cindex @value{GDBN} version number
1695 Show what version of @value{GDBN} is running. You should include this
1696 information in @value{GDBN} bug-reports. If multiple versions of
1697 @value{GDBN} are in use at your site, you may need to determine which
1698 version of @value{GDBN} you are running; as @value{GDBN} evolves, new
1699 commands are introduced, and old ones may wither away. Also, many
1700 system vendors ship variant versions of @value{GDBN}, and there are
1701 variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well.
1702 The version number is the same as the one announced when you start
1705 @kindex show copying
1706 @kindex info copying
1707 @cindex display @value{GDBN} copyright
1710 Display information about permission for copying @value{GDBN}.
1712 @kindex show warranty
1713 @kindex info warranty
1715 @itemx info warranty
1716 Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty,
1717 if your version of @value{GDBN} comes with one.
1722 @chapter Running Programs Under @value{GDBN}
1724 When you run a program under @value{GDBN}, you must first generate
1725 debugging information when you compile it.
1727 You may start @value{GDBN} with its arguments, if any, in an environment
1728 of your choice. If you are doing native debugging, you may redirect
1729 your program's input and output, debug an already running process, or
1730 kill a child process.
1733 * Compilation:: Compiling for debugging
1734 * Starting:: Starting your program
1735 * Arguments:: Your program's arguments
1736 * Environment:: Your program's environment
1738 * Working Directory:: Your program's working directory
1739 * Input/Output:: Your program's input and output
1740 * Attach:: Debugging an already-running process
1741 * Kill Process:: Killing the child process
1743 * Threads:: Debugging programs with multiple threads
1744 * Processes:: Debugging programs with multiple processes
1745 * Checkpoint/Restart:: Setting a @emph{bookmark} to return to later
1749 @section Compiling for Debugging
1751 In order to debug a program effectively, you need to generate
1752 debugging information when you compile it. This debugging information
1753 is stored in the object file; it describes the data type of each
1754 variable or function and the correspondence between source line numbers
1755 and addresses in the executable code.
1757 To request debugging information, specify the @samp{-g} option when you run
1760 Programs that are to be shipped to your customers are compiled with
1761 optimizations, using the @samp{-O} compiler option. However, many
1762 compilers are unable to handle the @samp{-g} and @samp{-O} options
1763 together. Using those compilers, you cannot generate optimized
1764 executables containing debugging information.
1766 @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or
1767 without @samp{-O}, making it possible to debug optimized code. We
1768 recommend that you @emph{always} use @samp{-g} whenever you compile a
1769 program. You may think your program is correct, but there is no sense
1770 in pushing your luck.
1772 @cindex optimized code, debugging
1773 @cindex debugging optimized code
1774 When you debug a program compiled with @samp{-g -O}, remember that the
1775 optimizer is rearranging your code; the debugger shows you what is
1776 really there. Do not be too surprised when the execution path does not
1777 exactly match your source file! An extreme example: if you define a
1778 variable, but never use it, @value{GDBN} never sees that
1779 variable---because the compiler optimizes it out of existence.
1781 Some things do not work as well with @samp{-g -O} as with just
1782 @samp{-g}, particularly on machines with instruction scheduling. If in
1783 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
1784 please report it to us as a bug (including a test case!).
1785 @xref{Variables}, for more information about debugging optimized code.
1787 Older versions of the @sc{gnu} C compiler permitted a variant option
1788 @w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this
1789 format; if your @sc{gnu} C compiler has this option, do not use it.
1791 @value{GDBN} knows about preprocessor macros and can show you their
1792 expansion (@pxref{Macros}). Most compilers do not include information
1793 about preprocessor macros in the debugging information if you specify
1794 the @option{-g} flag alone, because this information is rather large.
1795 Version 3.1 and later of @value{NGCC}, the @sc{gnu} C compiler,
1796 provides macro information if you specify the options
1797 @option{-gdwarf-2} and @option{-g3}; the former option requests
1798 debugging information in the Dwarf 2 format, and the latter requests
1799 ``extra information''. In the future, we hope to find more compact
1800 ways to represent macro information, so that it can be included with
1805 @section Starting your Program
1811 @kindex r @r{(@code{run})}
1814 Use the @code{run} command to start your program under @value{GDBN}.
1815 You must first specify the program name (except on VxWorks) with an
1816 argument to @value{GDBN} (@pxref{Invocation, ,Getting In and Out of
1817 @value{GDBN}}), or by using the @code{file} or @code{exec-file} command
1818 (@pxref{Files, ,Commands to Specify Files}).
1822 If you are running your program in an execution environment that
1823 supports processes, @code{run} creates an inferior process and makes
1824 that process run your program. (In environments without processes,
1825 @code{run} jumps to the start of your program.)
1827 The execution of a program is affected by certain information it
1828 receives from its superior. @value{GDBN} provides ways to specify this
1829 information, which you must do @emph{before} starting your program. (You
1830 can change it after starting your program, but such changes only affect
1831 your program the next time you start it.) This information may be
1832 divided into four categories:
1835 @item The @emph{arguments.}
1836 Specify the arguments to give your program as the arguments of the
1837 @code{run} command. If a shell is available on your target, the shell
1838 is used to pass the arguments, so that you may use normal conventions
1839 (such as wildcard expansion or variable substitution) in describing
1841 In Unix systems, you can control which shell is used with the
1842 @code{SHELL} environment variable.
1843 @xref{Arguments, ,Your Program's Arguments}.
1845 @item The @emph{environment.}
1846 Your program normally inherits its environment from @value{GDBN}, but you can
1847 use the @value{GDBN} commands @code{set environment} and @code{unset
1848 environment} to change parts of the environment that affect
1849 your program. @xref{Environment, ,Your Program's Environment}.
1851 @item The @emph{working directory.}
1852 Your program inherits its working directory from @value{GDBN}. You can set
1853 the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}.
1854 @xref{Working Directory, ,Your Program's Working Directory}.
1856 @item The @emph{standard input and output.}
1857 Your program normally uses the same device for standard input and
1858 standard output as @value{GDBN} is using. You can redirect input and output
1859 in the @code{run} command line, or you can use the @code{tty} command to
1860 set a different device for your program.
1861 @xref{Input/Output, ,Your Program's Input and Output}.
1864 @emph{Warning:} While input and output redirection work, you cannot use
1865 pipes to pass the output of the program you are debugging to another
1866 program; if you attempt this, @value{GDBN} is likely to wind up debugging the
1870 When you issue the @code{run} command, your program begins to execute
1871 immediately. @xref{Stopping, ,Stopping and Continuing}, for discussion
1872 of how to arrange for your program to stop. Once your program has
1873 stopped, you may call functions in your program, using the @code{print}
1874 or @code{call} commands. @xref{Data, ,Examining Data}.
1876 If the modification time of your symbol file has changed since the last
1877 time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
1878 table, and reads it again. When it does this, @value{GDBN} tries to retain
1879 your current breakpoints.
1884 @cindex run to main procedure
1885 The name of the main procedure can vary from language to language.
1886 With C or C@t{++}, the main procedure name is always @code{main}, but
1887 other languages such as Ada do not require a specific name for their
1888 main procedure. The debugger provides a convenient way to start the
1889 execution of the program and to stop at the beginning of the main
1890 procedure, depending on the language used.
1892 The @samp{start} command does the equivalent of setting a temporary
1893 breakpoint at the beginning of the main procedure and then invoking
1894 the @samp{run} command.
1896 @cindex elaboration phase
1897 Some programs contain an @dfn{elaboration} phase where some startup code is
1898 executed before the main procedure is called. This depends on the
1899 languages used to write your program. In C@t{++}, for instance,
1900 constructors for static and global objects are executed before
1901 @code{main} is called. It is therefore possible that the debugger stops
1902 before reaching the main procedure. However, the temporary breakpoint
1903 will remain to halt execution.
1905 Specify the arguments to give to your program as arguments to the
1906 @samp{start} command. These arguments will be given verbatim to the
1907 underlying @samp{run} command. Note that the same arguments will be
1908 reused if no argument is provided during subsequent calls to
1909 @samp{start} or @samp{run}.
1911 It is sometimes necessary to debug the program during elaboration. In
1912 these cases, using the @code{start} command would stop the execution of
1913 your program too late, as the program would have already completed the
1914 elaboration phase. Under these circumstances, insert breakpoints in your
1915 elaboration code before running your program.
1919 @section Your Program's Arguments
1921 @cindex arguments (to your program)
1922 The arguments to your program can be specified by the arguments of the
1924 They are passed to a shell, which expands wildcard characters and
1925 performs redirection of I/O, and thence to your program. Your
1926 @code{SHELL} environment variable (if it exists) specifies what shell
1927 @value{GDBN} uses. If you do not define @code{SHELL}, @value{GDBN} uses
1928 the default shell (@file{/bin/sh} on Unix).
1930 On non-Unix systems, the program is usually invoked directly by
1931 @value{GDBN}, which emulates I/O redirection via the appropriate system
1932 calls, and the wildcard characters are expanded by the startup code of
1933 the program, not by the shell.
1935 @code{run} with no arguments uses the same arguments used by the previous
1936 @code{run}, or those set by the @code{set args} command.
1941 Specify the arguments to be used the next time your program is run. If
1942 @code{set args} has no arguments, @code{run} executes your program
1943 with no arguments. Once you have run your program with arguments,
1944 using @code{set args} before the next @code{run} is the only way to run
1945 it again without arguments.
1949 Show the arguments to give your program when it is started.
1953 @section Your Program's Environment
1955 @cindex environment (of your program)
1956 The @dfn{environment} consists of a set of environment variables and
1957 their values. Environment variables conventionally record such things as
1958 your user name, your home directory, your terminal type, and your search
1959 path for programs to run. Usually you set up environment variables with
1960 the shell and they are inherited by all the other programs you run. When
1961 debugging, it can be useful to try running your program with a modified
1962 environment without having to start @value{GDBN} over again.
1966 @item path @var{directory}
1967 Add @var{directory} to the front of the @code{PATH} environment variable
1968 (the search path for executables) that will be passed to your program.
1969 The value of @code{PATH} used by @value{GDBN} does not change.
1970 You may specify several directory names, separated by whitespace or by a
1971 system-dependent separator character (@samp{:} on Unix, @samp{;} on
1972 MS-DOS and MS-Windows). If @var{directory} is already in the path, it
1973 is moved to the front, so it is searched sooner.
1975 You can use the string @samp{$cwd} to refer to whatever is the current
1976 working directory at the time @value{GDBN} searches the path. If you
1977 use @samp{.} instead, it refers to the directory where you executed the
1978 @code{path} command. @value{GDBN} replaces @samp{.} in the
1979 @var{directory} argument (with the current path) before adding
1980 @var{directory} to the search path.
1981 @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
1982 @c document that, since repeating it would be a no-op.
1986 Display the list of search paths for executables (the @code{PATH}
1987 environment variable).
1989 @kindex show environment
1990 @item show environment @r{[}@var{varname}@r{]}
1991 Print the value of environment variable @var{varname} to be given to
1992 your program when it starts. If you do not supply @var{varname},
1993 print the names and values of all environment variables to be given to
1994 your program. You can abbreviate @code{environment} as @code{env}.
1996 @kindex set environment
1997 @item set environment @var{varname} @r{[}=@var{value}@r{]}
1998 Set environment variable @var{varname} to @var{value}. The value
1999 changes for your program only, not for @value{GDBN} itself. @var{value} may
2000 be any string; the values of environment variables are just strings, and
2001 any interpretation is supplied by your program itself. The @var{value}
2002 parameter is optional; if it is eliminated, the variable is set to a
2004 @c "any string" here does not include leading, trailing
2005 @c blanks. Gnu asks: does anyone care?
2007 For example, this command:
2014 tells the debugged program, when subsequently run, that its user is named
2015 @samp{foo}. (The spaces around @samp{=} are used for clarity here; they
2016 are not actually required.)
2018 @kindex unset environment
2019 @item unset environment @var{varname}
2020 Remove variable @var{varname} from the environment to be passed to your
2021 program. This is different from @samp{set env @var{varname} =};
2022 @code{unset environment} removes the variable from the environment,
2023 rather than assigning it an empty value.
2026 @emph{Warning:} On Unix systems, @value{GDBN} runs your program using
2028 by your @code{SHELL} environment variable if it exists (or
2029 @code{/bin/sh} if not). If your @code{SHELL} variable names a shell
2030 that runs an initialization file---such as @file{.cshrc} for C-shell, or
2031 @file{.bashrc} for BASH---any variables you set in that file affect
2032 your program. You may wish to move setting of environment variables to
2033 files that are only run when you sign on, such as @file{.login} or
2036 @node Working Directory
2037 @section Your Program's Working Directory
2039 @cindex working directory (of your program)
2040 Each time you start your program with @code{run}, it inherits its
2041 working directory from the current working directory of @value{GDBN}.
2042 The @value{GDBN} working directory is initially whatever it inherited
2043 from its parent process (typically the shell), but you can specify a new
2044 working directory in @value{GDBN} with the @code{cd} command.
2046 The @value{GDBN} working directory also serves as a default for the commands
2047 that specify files for @value{GDBN} to operate on. @xref{Files, ,Commands to
2052 @cindex change working directory
2053 @item cd @var{directory}
2054 Set the @value{GDBN} working directory to @var{directory}.
2058 Print the @value{GDBN} working directory.
2061 It is generally impossible to find the current working directory of
2062 the process being debugged (since a program can change its directory
2063 during its run). If you work on a system where @value{GDBN} is
2064 configured with the @file{/proc} support, you can use the @code{info
2065 proc} command (@pxref{SVR4 Process Information}) to find out the
2066 current working directory of the debuggee.
2069 @section Your Program's Input and Output
2074 By default, the program you run under @value{GDBN} does input and output to
2075 the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal
2076 to its own terminal modes to interact with you, but it records the terminal
2077 modes your program was using and switches back to them when you continue
2078 running your program.
2081 @kindex info terminal
2083 Displays information recorded by @value{GDBN} about the terminal modes your
2087 You can redirect your program's input and/or output using shell
2088 redirection with the @code{run} command. For example,
2095 starts your program, diverting its output to the file @file{outfile}.
2098 @cindex controlling terminal
2099 Another way to specify where your program should do input and output is
2100 with the @code{tty} command. This command accepts a file name as
2101 argument, and causes this file to be the default for future @code{run}
2102 commands. It also resets the controlling terminal for the child
2103 process, for future @code{run} commands. For example,
2110 directs that processes started with subsequent @code{run} commands
2111 default to do input and output on the terminal @file{/dev/ttyb} and have
2112 that as their controlling terminal.
2114 An explicit redirection in @code{run} overrides the @code{tty} command's
2115 effect on the input/output device, but not its effect on the controlling
2118 When you use the @code{tty} command or redirect input in the @code{run}
2119 command, only the input @emph{for your program} is affected. The input
2120 for @value{GDBN} still comes from your terminal. @code{tty} is an alias
2121 for @code{set inferior-tty}.
2123 @cindex inferior tty
2124 @cindex set inferior controlling terminal
2125 You can use the @code{show inferior-tty} command to tell @value{GDBN} to
2126 display the name of the terminal that will be used for future runs of your
2130 @item set inferior-tty /dev/ttyb
2131 @kindex set inferior-tty
2132 Set the tty for the program being debugged to /dev/ttyb.
2134 @item show inferior-tty
2135 @kindex show inferior-tty
2136 Show the current tty for the program being debugged.
2140 @section Debugging an Already-running Process
2145 @item attach @var{process-id}
2146 This command attaches to a running process---one that was started
2147 outside @value{GDBN}. (@code{info files} shows your active
2148 targets.) The command takes as argument a process ID. The usual way to
2149 find out the @var{process-id} of a Unix process is with the @code{ps} utility,
2150 or with the @samp{jobs -l} shell command.
2152 @code{attach} does not repeat if you press @key{RET} a second time after
2153 executing the command.
2156 To use @code{attach}, your program must be running in an environment
2157 which supports processes; for example, @code{attach} does not work for
2158 programs on bare-board targets that lack an operating system. You must
2159 also have permission to send the process a signal.
2161 When you use @code{attach}, the debugger finds the program running in
2162 the process first by looking in the current working directory, then (if
2163 the program is not found) by using the source file search path
2164 (@pxref{Source Path, ,Specifying Source Directories}). You can also use
2165 the @code{file} command to load the program. @xref{Files, ,Commands to
2168 The first thing @value{GDBN} does after arranging to debug the specified
2169 process is to stop it. You can examine and modify an attached process
2170 with all the @value{GDBN} commands that are ordinarily available when
2171 you start processes with @code{run}. You can insert breakpoints; you
2172 can step and continue; you can modify storage. If you would rather the
2173 process continue running, you may use the @code{continue} command after
2174 attaching @value{GDBN} to the process.
2179 When you have finished debugging the attached process, you can use the
2180 @code{detach} command to release it from @value{GDBN} control. Detaching
2181 the process continues its execution. After the @code{detach} command,
2182 that process and @value{GDBN} become completely independent once more, and you
2183 are ready to @code{attach} another process or start one with @code{run}.
2184 @code{detach} does not repeat if you press @key{RET} again after
2185 executing the command.
2188 If you exit @value{GDBN} while you have an attached process, you detach
2189 that process. If you use the @code{run} command, you kill that process.
2190 By default, @value{GDBN} asks for confirmation if you try to do either of these
2191 things; you can control whether or not you need to confirm by using the
2192 @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and
2196 @section Killing the Child Process
2201 Kill the child process in which your program is running under @value{GDBN}.
2204 This command is useful if you wish to debug a core dump instead of a
2205 running process. @value{GDBN} ignores any core dump file while your program
2208 On some operating systems, a program cannot be executed outside @value{GDBN}
2209 while you have breakpoints set on it inside @value{GDBN}. You can use the
2210 @code{kill} command in this situation to permit running your program
2211 outside the debugger.
2213 The @code{kill} command is also useful if you wish to recompile and
2214 relink your program, since on many systems it is impossible to modify an
2215 executable file while it is running in a process. In this case, when you
2216 next type @code{run}, @value{GDBN} notices that the file has changed, and
2217 reads the symbol table again (while trying to preserve your current
2218 breakpoint settings).
2221 @section Debugging Programs with Multiple Threads
2223 @cindex threads of execution
2224 @cindex multiple threads
2225 @cindex switching threads
2226 In some operating systems, such as HP-UX and Solaris, a single program
2227 may have more than one @dfn{thread} of execution. The precise semantics
2228 of threads differ from one operating system to another, but in general
2229 the threads of a single program are akin to multiple processes---except
2230 that they share one address space (that is, they can all examine and
2231 modify the same variables). On the other hand, each thread has its own
2232 registers and execution stack, and perhaps private memory.
2234 @value{GDBN} provides these facilities for debugging multi-thread
2238 @item automatic notification of new threads
2239 @item @samp{thread @var{threadno}}, a command to switch among threads
2240 @item @samp{info threads}, a command to inquire about existing threads
2241 @item @samp{thread apply [@var{threadno}] [@var{all}] @var{args}},
2242 a command to apply a command to a list of threads
2243 @item thread-specific breakpoints
2247 @emph{Warning:} These facilities are not yet available on every
2248 @value{GDBN} configuration where the operating system supports threads.
2249 If your @value{GDBN} does not support threads, these commands have no
2250 effect. For example, a system without thread support shows no output
2251 from @samp{info threads}, and always rejects the @code{thread} command,
2255 (@value{GDBP}) info threads
2256 (@value{GDBP}) thread 1
2257 Thread ID 1 not known. Use the "info threads" command to
2258 see the IDs of currently known threads.
2260 @c FIXME to implementors: how hard would it be to say "sorry, this GDB
2261 @c doesn't support threads"?
2264 @cindex focus of debugging
2265 @cindex current thread
2266 The @value{GDBN} thread debugging facility allows you to observe all
2267 threads while your program runs---but whenever @value{GDBN} takes
2268 control, one thread in particular is always the focus of debugging.
2269 This thread is called the @dfn{current thread}. Debugging commands show
2270 program information from the perspective of the current thread.
2272 @cindex @code{New} @var{systag} message
2273 @cindex thread identifier (system)
2274 @c FIXME-implementors!! It would be more helpful if the [New...] message
2275 @c included GDB's numeric thread handle, so you could just go to that
2276 @c thread without first checking `info threads'.
2277 Whenever @value{GDBN} detects a new thread in your program, it displays
2278 the target system's identification for the thread with a message in the
2279 form @samp{[New @var{systag}]}. @var{systag} is a thread identifier
2280 whose form varies depending on the particular system. For example, on
2281 @sc{gnu}/Linux, you might see
2284 [New Thread 46912507313328 (LWP 25582)]
2288 when @value{GDBN} notices a new thread. In contrast, on an SGI system,
2289 the @var{systag} is simply something like @samp{process 368}, with no
2292 @c FIXME!! (1) Does the [New...] message appear even for the very first
2293 @c thread of a program, or does it only appear for the
2294 @c second---i.e.@: when it becomes obvious we have a multithread
2296 @c (2) *Is* there necessarily a first thread always? Or do some
2297 @c multithread systems permit starting a program with multiple
2298 @c threads ab initio?
2300 @cindex thread number
2301 @cindex thread identifier (GDB)
2302 For debugging purposes, @value{GDBN} associates its own thread
2303 number---always a single integer---with each thread in your program.
2306 @kindex info threads
2308 Display a summary of all threads currently in your
2309 program. @value{GDBN} displays for each thread (in this order):
2313 the thread number assigned by @value{GDBN}
2316 the target system's thread identifier (@var{systag})
2319 the current stack frame summary for that thread
2323 An asterisk @samp{*} to the left of the @value{GDBN} thread number
2324 indicates the current thread.
2328 @c end table here to get a little more width for example
2331 (@value{GDBP}) info threads
2332 3 process 35 thread 27 0x34e5 in sigpause ()
2333 2 process 35 thread 23 0x34e5 in sigpause ()
2334 * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
2340 @cindex debugging multithreaded programs (on HP-UX)
2341 @cindex thread identifier (GDB), on HP-UX
2342 For debugging purposes, @value{GDBN} associates its own thread
2343 number---a small integer assigned in thread-creation order---with each
2344 thread in your program.
2346 @cindex @code{New} @var{systag} message, on HP-UX
2347 @cindex thread identifier (system), on HP-UX
2348 @c FIXME-implementors!! It would be more helpful if the [New...] message
2349 @c included GDB's numeric thread handle, so you could just go to that
2350 @c thread without first checking `info threads'.
2351 Whenever @value{GDBN} detects a new thread in your program, it displays
2352 both @value{GDBN}'s thread number and the target system's identification for the thread with a message in the
2353 form @samp{[New @var{systag}]}. @var{systag} is a thread identifier
2354 whose form varies depending on the particular system. For example, on
2358 [New thread 2 (system thread 26594)]
2362 when @value{GDBN} notices a new thread.
2365 @kindex info threads (HP-UX)
2367 Display a summary of all threads currently in your
2368 program. @value{GDBN} displays for each thread (in this order):
2371 @item the thread number assigned by @value{GDBN}
2373 @item the target system's thread identifier (@var{systag})
2375 @item the current stack frame summary for that thread
2379 An asterisk @samp{*} to the left of the @value{GDBN} thread number
2380 indicates the current thread.
2384 @c end table here to get a little more width for example
2387 (@value{GDBP}) info threads
2388 * 3 system thread 26607 worker (wptr=0x7b09c318 "@@") \@*
2390 2 system thread 26606 0x7b0030d8 in __ksleep () \@*
2391 from /usr/lib/libc.2
2392 1 system thread 27905 0x7b003498 in _brk () \@*
2393 from /usr/lib/libc.2
2396 On Solaris, you can display more information about user threads with a
2397 Solaris-specific command:
2400 @item maint info sol-threads
2401 @kindex maint info sol-threads
2402 @cindex thread info (Solaris)
2403 Display info on Solaris user threads.
2407 @kindex thread @var{threadno}
2408 @item thread @var{threadno}
2409 Make thread number @var{threadno} the current thread. The command
2410 argument @var{threadno} is the internal @value{GDBN} thread number, as
2411 shown in the first field of the @samp{info threads} display.
2412 @value{GDBN} responds by displaying the system identifier of the thread
2413 you selected, and its current stack frame summary:
2416 @c FIXME!! This example made up; find a @value{GDBN} w/threads and get real one
2417 (@value{GDBP}) thread 2
2418 [Switching to process 35 thread 23]
2419 0x34e5 in sigpause ()
2423 As with the @samp{[New @dots{}]} message, the form of the text after
2424 @samp{Switching to} depends on your system's conventions for identifying
2427 @kindex thread apply
2428 @cindex apply command to several threads
2429 @item thread apply [@var{threadno}] [@var{all}] @var{command}
2430 The @code{thread apply} command allows you to apply the named
2431 @var{command} to one or more threads. Specify the numbers of the
2432 threads that you want affected with the command argument
2433 @var{threadno}. It can be a single thread number, one of the numbers
2434 shown in the first field of the @samp{info threads} display; or it
2435 could be a range of thread numbers, as in @code{2-4}. To apply a
2436 command to all threads, type @kbd{thread apply all @var{command}}.
2439 @cindex automatic thread selection
2440 @cindex switching threads automatically
2441 @cindex threads, automatic switching
2442 Whenever @value{GDBN} stops your program, due to a breakpoint or a
2443 signal, it automatically selects the thread where that breakpoint or
2444 signal happened. @value{GDBN} alerts you to the context switch with a
2445 message of the form @samp{[Switching to @var{systag}]} to identify the
2448 @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for
2449 more information about how @value{GDBN} behaves when you stop and start
2450 programs with multiple threads.
2452 @xref{Set Watchpoints,,Setting Watchpoints}, for information about
2453 watchpoints in programs with multiple threads.
2456 @section Debugging Programs with Multiple Processes
2458 @cindex fork, debugging programs which call
2459 @cindex multiple processes
2460 @cindex processes, multiple
2461 On most systems, @value{GDBN} has no special support for debugging
2462 programs which create additional processes using the @code{fork}
2463 function. When a program forks, @value{GDBN} will continue to debug the
2464 parent process and the child process will run unimpeded. If you have
2465 set a breakpoint in any code which the child then executes, the child
2466 will get a @code{SIGTRAP} signal which (unless it catches the signal)
2467 will cause it to terminate.
2469 However, if you want to debug the child process there is a workaround
2470 which isn't too painful. Put a call to @code{sleep} in the code which
2471 the child process executes after the fork. It may be useful to sleep
2472 only if a certain environment variable is set, or a certain file exists,
2473 so that the delay need not occur when you don't want to run @value{GDBN}
2474 on the child. While the child is sleeping, use the @code{ps} program to
2475 get its process ID. Then tell @value{GDBN} (a new invocation of
2476 @value{GDBN} if you are also debugging the parent process) to attach to
2477 the child process (@pxref{Attach}). From that point on you can debug
2478 the child process just like any other process which you attached to.
2480 On some systems, @value{GDBN} provides support for debugging programs that
2481 create additional processes using the @code{fork} or @code{vfork} functions.
2482 Currently, the only platforms with this feature are HP-UX (11.x and later
2483 only?) and GNU/Linux (kernel version 2.5.60 and later).
2485 By default, when a program forks, @value{GDBN} will continue to debug
2486 the parent process and the child process will run unimpeded.
2488 If you want to follow the child process instead of the parent process,
2489 use the command @w{@code{set follow-fork-mode}}.
2492 @kindex set follow-fork-mode
2493 @item set follow-fork-mode @var{mode}
2494 Set the debugger response to a program call of @code{fork} or
2495 @code{vfork}. A call to @code{fork} or @code{vfork} creates a new
2496 process. The @var{mode} argument can be:
2500 The original process is debugged after a fork. The child process runs
2501 unimpeded. This is the default.
2504 The new process is debugged after a fork. The parent process runs
2509 @kindex show follow-fork-mode
2510 @item show follow-fork-mode
2511 Display the current debugger response to a @code{fork} or @code{vfork} call.
2514 @cindex debugging multiple processes
2515 On Linux, if you want to debug both the parent and child processes, use the
2516 command @w{@code{set detach-on-fork}}.
2519 @kindex set detach-on-fork
2520 @item set detach-on-fork @var{mode}
2521 Tells gdb whether to detach one of the processes after a fork, or
2522 retain debugger control over them both.
2526 The child process (or parent process, depending on the value of
2527 @code{follow-fork-mode}) will be detached and allowed to run
2528 independently. This is the default.
2531 Both processes will be held under the control of @value{GDBN}.
2532 One process (child or parent, depending on the value of
2533 @code{follow-fork-mode}) is debugged as usual, while the other
2538 @kindex show detach-on-follow
2539 @item show detach-on-follow
2540 Show whether detach-on-follow mode is on/off.
2543 If you choose to set @var{detach-on-follow} mode off, then
2544 @value{GDBN} will retain control of all forked processes (including
2545 nested forks). You can list the forked processes under the control of
2546 @value{GDBN} by using the @w{@code{info forks}} command, and switch
2547 from one fork to another by using the @w{@code{fork}} command.
2552 Print a list of all forked processes under the control of @value{GDBN}.
2553 The listing will include a fork id, a process id, and the current
2554 position (program counter) of the process.
2557 @kindex fork @var{fork-id}
2558 @item fork @var{fork-id}
2559 Make fork number @var{fork-id} the current process. The argument
2560 @var{fork-id} is the internal fork number assigned by @value{GDBN},
2561 as shown in the first field of the @samp{info forks} display.
2565 To quit debugging one of the forked processes, you can either detach
2566 from it by using the @w{@code{detach fork}} command (allowing it to
2567 run independently), or delete (and kill) it using the
2568 @w{@code{delete fork}} command.
2571 @kindex detach fork @var{fork-id}
2572 @item detach fork @var{fork-id}
2573 Detach from the process identified by @value{GDBN} fork number
2574 @var{fork-id}, and remove it from the fork list. The process will be
2575 allowed to run independently.
2577 @kindex delete fork @var{fork-id}
2578 @item delete fork @var{fork-id}
2579 Kill the process identified by @value{GDBN} fork number @var{fork-id},
2580 and remove it from the fork list.
2584 If you ask to debug a child process and a @code{vfork} is followed by an
2585 @code{exec}, @value{GDBN} executes the new target up to the first
2586 breakpoint in the new target. If you have a breakpoint set on
2587 @code{main} in your original program, the breakpoint will also be set on
2588 the child process's @code{main}.
2590 When a child process is spawned by @code{vfork}, you cannot debug the
2591 child or parent until an @code{exec} call completes.
2593 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
2594 call executes, the new target restarts. To restart the parent process,
2595 use the @code{file} command with the parent executable name as its
2598 You can use the @code{catch} command to make @value{GDBN} stop whenever
2599 a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set
2600 Catchpoints, ,Setting Catchpoints}.
2602 @node Checkpoint/Restart
2603 @section Setting a @emph{Bookmark} to Return to Later
2608 @cindex snapshot of a process
2609 @cindex rewind program state
2611 On certain operating systems@footnote{Currently, only
2612 @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a
2613 program's state, called a @dfn{checkpoint}, and come back to it
2616 Returning to a checkpoint effectively undoes everything that has
2617 happened in the program since the @code{checkpoint} was saved. This
2618 includes changes in memory, registers, and even (within some limits)
2619 system state. Effectively, it is like going back in time to the
2620 moment when the checkpoint was saved.
2622 Thus, if you're stepping thru a program and you think you're
2623 getting close to the point where things go wrong, you can save
2624 a checkpoint. Then, if you accidentally go too far and miss
2625 the critical statement, instead of having to restart your program
2626 from the beginning, you can just go back to the checkpoint and
2627 start again from there.
2629 This can be especially useful if it takes a lot of time or
2630 steps to reach the point where you think the bug occurs.
2632 To use the @code{checkpoint}/@code{restart} method of debugging:
2637 Save a snapshot of the debugged program's current execution state.
2638 The @code{checkpoint} command takes no arguments, but each checkpoint
2639 is assigned a small integer id, similar to a breakpoint id.
2641 @kindex info checkpoints
2642 @item info checkpoints
2643 List the checkpoints that have been saved in the current debugging
2644 session. For each checkpoint, the following information will be
2651 @item Source line, or label
2654 @kindex restart @var{checkpoint-id}
2655 @item restart @var{checkpoint-id}
2656 Restore the program state that was saved as checkpoint number
2657 @var{checkpoint-id}. All program variables, registers, stack frames
2658 etc.@: will be returned to the values that they had when the checkpoint
2659 was saved. In essence, gdb will ``wind back the clock'' to the point
2660 in time when the checkpoint was saved.
2662 Note that breakpoints, @value{GDBN} variables, command history etc.
2663 are not affected by restoring a checkpoint. In general, a checkpoint
2664 only restores things that reside in the program being debugged, not in
2667 @kindex delete checkpoint @var{checkpoint-id}
2668 @item delete checkpoint @var{checkpoint-id}
2669 Delete the previously-saved checkpoint identified by @var{checkpoint-id}.
2673 Returning to a previously saved checkpoint will restore the user state
2674 of the program being debugged, plus a significant subset of the system
2675 (OS) state, including file pointers. It won't ``un-write'' data from
2676 a file, but it will rewind the file pointer to the previous location,
2677 so that the previously written data can be overwritten. For files
2678 opened in read mode, the pointer will also be restored so that the
2679 previously read data can be read again.
2681 Of course, characters that have been sent to a printer (or other
2682 external device) cannot be ``snatched back'', and characters received
2683 from eg.@: a serial device can be removed from internal program buffers,
2684 but they cannot be ``pushed back'' into the serial pipeline, ready to
2685 be received again. Similarly, the actual contents of files that have
2686 been changed cannot be restored (at this time).
2688 However, within those constraints, you actually can ``rewind'' your
2689 program to a previously saved point in time, and begin debugging it
2690 again --- and you can change the course of events so as to debug a
2691 different execution path this time.
2693 @cindex checkpoints and process id
2694 Finally, there is one bit of internal program state that will be
2695 different when you return to a checkpoint --- the program's process
2696 id. Each checkpoint will have a unique process id (or @var{pid}),
2697 and each will be different from the program's original @var{pid}.
2698 If your program has saved a local copy of its process id, this could
2699 potentially pose a problem.
2701 @subsection A Non-obvious Benefit of Using Checkpoints
2703 On some systems such as @sc{gnu}/Linux, address space randomization
2704 is performed on new processes for security reasons. This makes it
2705 difficult or impossible to set a breakpoint, or watchpoint, on an
2706 absolute address if you have to restart the program, since the
2707 absolute location of a symbol will change from one execution to the
2710 A checkpoint, however, is an @emph{identical} copy of a process.
2711 Therefore if you create a checkpoint at (eg.@:) the start of main,
2712 and simply return to that checkpoint instead of restarting the
2713 process, you can avoid the effects of address randomization and
2714 your symbols will all stay in the same place.
2717 @chapter Stopping and Continuing
2719 The principal purposes of using a debugger are so that you can stop your
2720 program before it terminates; or so that, if your program runs into
2721 trouble, you can investigate and find out why.
2723 Inside @value{GDBN}, your program may stop for any of several reasons,
2724 such as a signal, a breakpoint, or reaching a new line after a
2725 @value{GDBN} command such as @code{step}. You may then examine and
2726 change variables, set new breakpoints or remove old ones, and then
2727 continue execution. Usually, the messages shown by @value{GDBN} provide
2728 ample explanation of the status of your program---but you can also
2729 explicitly request this information at any time.
2732 @kindex info program
2734 Display information about the status of your program: whether it is
2735 running or not, what process it is, and why it stopped.
2739 * Breakpoints:: Breakpoints, watchpoints, and catchpoints
2740 * Continuing and Stepping:: Resuming execution
2742 * Thread Stops:: Stopping and starting multi-thread programs
2746 @section Breakpoints, Watchpoints, and Catchpoints
2749 A @dfn{breakpoint} makes your program stop whenever a certain point in
2750 the program is reached. For each breakpoint, you can add conditions to
2751 control in finer detail whether your program stops. You can set
2752 breakpoints with the @code{break} command and its variants (@pxref{Set
2753 Breaks, ,Setting Breakpoints}), to specify the place where your program
2754 should stop by line number, function name or exact address in the
2757 On some systems, you can set breakpoints in shared libraries before
2758 the executable is run. There is a minor limitation on HP-UX systems:
2759 you must wait until the executable is run in order to set breakpoints
2760 in shared library routines that are not called directly by the program
2761 (for example, routines that are arguments in a @code{pthread_create}
2765 @cindex data breakpoints
2766 @cindex memory tracing
2767 @cindex breakpoint on memory address
2768 @cindex breakpoint on variable modification
2769 A @dfn{watchpoint} is a special breakpoint that stops your program
2770 when the value of an expression changes. The expression may be a value
2771 of a variable, or it could involve values of one or more variables
2772 combined by operators, such as @samp{a + b}. This is sometimes called
2773 @dfn{data breakpoints}. You must use a different command to set
2774 watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside
2775 from that, you can manage a watchpoint like any other breakpoint: you
2776 enable, disable, and delete both breakpoints and watchpoints using the
2779 You can arrange to have values from your program displayed automatically
2780 whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,,
2784 @cindex breakpoint on events
2785 A @dfn{catchpoint} is another special breakpoint that stops your program
2786 when a certain kind of event occurs, such as the throwing of a C@t{++}
2787 exception or the loading of a library. As with watchpoints, you use a
2788 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
2789 Catchpoints}), but aside from that, you can manage a catchpoint like any
2790 other breakpoint. (To stop when your program receives a signal, use the
2791 @code{handle} command; see @ref{Signals, ,Signals}.)
2793 @cindex breakpoint numbers
2794 @cindex numbers for breakpoints
2795 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
2796 catchpoint when you create it; these numbers are successive integers
2797 starting with one. In many of the commands for controlling various
2798 features of breakpoints you use the breakpoint number to say which
2799 breakpoint you want to change. Each breakpoint may be @dfn{enabled} or
2800 @dfn{disabled}; if disabled, it has no effect on your program until you
2803 @cindex breakpoint ranges
2804 @cindex ranges of breakpoints
2805 Some @value{GDBN} commands accept a range of breakpoints on which to
2806 operate. A breakpoint range is either a single breakpoint number, like
2807 @samp{5}, or two such numbers, in increasing order, separated by a
2808 hyphen, like @samp{5-7}. When a breakpoint range is given to a command,
2809 all breakpoints in that range are operated on.
2812 * Set Breaks:: Setting breakpoints
2813 * Set Watchpoints:: Setting watchpoints
2814 * Set Catchpoints:: Setting catchpoints
2815 * Delete Breaks:: Deleting breakpoints
2816 * Disabling:: Disabling breakpoints
2817 * Conditions:: Break conditions
2818 * Break Commands:: Breakpoint command lists
2819 * Breakpoint Menus:: Breakpoint menus
2820 * Error in Breakpoints:: ``Cannot insert breakpoints''
2821 * Breakpoint-related Warnings:: ``Breakpoint address adjusted...''
2825 @subsection Setting Breakpoints
2827 @c FIXME LMB what does GDB do if no code on line of breakpt?
2828 @c consider in particular declaration with/without initialization.
2830 @c FIXME 2 is there stuff on this already? break at fun start, already init?
2833 @kindex b @r{(@code{break})}
2834 @vindex $bpnum@r{, convenience variable}
2835 @cindex latest breakpoint
2836 Breakpoints are set with the @code{break} command (abbreviated
2837 @code{b}). The debugger convenience variable @samp{$bpnum} records the
2838 number of the breakpoint you've set most recently; see @ref{Convenience
2839 Vars,, Convenience Variables}, for a discussion of what you can do with
2840 convenience variables.
2842 You have several ways to say where the breakpoint should go.
2845 @item break @var{function}
2846 Set a breakpoint at entry to function @var{function}.
2847 When using source languages that permit overloading of symbols, such as
2848 C@t{++}, @var{function} may refer to more than one possible place to break.
2849 @xref{Breakpoint Menus,,Breakpoint Menus}, for a discussion of that situation.
2851 @item break +@var{offset}
2852 @itemx break -@var{offset}
2853 Set a breakpoint some number of lines forward or back from the position
2854 at which execution stopped in the currently selected @dfn{stack frame}.
2855 (@xref{Frames, ,Frames}, for a description of stack frames.)
2857 @item break @var{linenum}
2858 Set a breakpoint at line @var{linenum} in the current source file.
2859 The current source file is the last file whose source text was printed.
2860 The breakpoint will stop your program just before it executes any of the
2863 @item break @var{filename}:@var{linenum}
2864 Set a breakpoint at line @var{linenum} in source file @var{filename}.
2866 @item break @var{filename}:@var{function}
2867 Set a breakpoint at entry to function @var{function} found in file
2868 @var{filename}. Specifying a file name as well as a function name is
2869 superfluous except when multiple files contain similarly named
2872 @item break *@var{address}
2873 Set a breakpoint at address @var{address}. You can use this to set
2874 breakpoints in parts of your program which do not have debugging
2875 information or source files.
2878 When called without any arguments, @code{break} sets a breakpoint at
2879 the next instruction to be executed in the selected stack frame
2880 (@pxref{Stack, ,Examining the Stack}). In any selected frame but the
2881 innermost, this makes your program stop as soon as control
2882 returns to that frame. This is similar to the effect of a
2883 @code{finish} command in the frame inside the selected frame---except
2884 that @code{finish} does not leave an active breakpoint. If you use
2885 @code{break} without an argument in the innermost frame, @value{GDBN} stops
2886 the next time it reaches the current location; this may be useful
2889 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
2890 least one instruction has been executed. If it did not do this, you
2891 would be unable to proceed past a breakpoint without first disabling the
2892 breakpoint. This rule applies whether or not the breakpoint already
2893 existed when your program stopped.
2895 @item break @dots{} if @var{cond}
2896 Set a breakpoint with condition @var{cond}; evaluate the expression
2897 @var{cond} each time the breakpoint is reached, and stop only if the
2898 value is nonzero---that is, if @var{cond} evaluates as true.
2899 @samp{@dots{}} stands for one of the possible arguments described
2900 above (or no argument) specifying where to break. @xref{Conditions,
2901 ,Break Conditions}, for more information on breakpoint conditions.
2904 @item tbreak @var{args}
2905 Set a breakpoint enabled only for one stop. @var{args} are the
2906 same as for the @code{break} command, and the breakpoint is set in the same
2907 way, but the breakpoint is automatically deleted after the first time your
2908 program stops there. @xref{Disabling, ,Disabling Breakpoints}.
2911 @cindex hardware breakpoints
2912 @item hbreak @var{args}
2913 Set a hardware-assisted breakpoint. @var{args} are the same as for the
2914 @code{break} command and the breakpoint is set in the same way, but the
2915 breakpoint requires hardware support and some target hardware may not
2916 have this support. The main purpose of this is EPROM/ROM code
2917 debugging, so you can set a breakpoint at an instruction without
2918 changing the instruction. This can be used with the new trap-generation
2919 provided by SPARClite DSU and most x86-based targets. These targets
2920 will generate traps when a program accesses some data or instruction
2921 address that is assigned to the debug registers. However the hardware
2922 breakpoint registers can take a limited number of breakpoints. For
2923 example, on the DSU, only two data breakpoints can be set at a time, and
2924 @value{GDBN} will reject this command if more than two are used. Delete
2925 or disable unused hardware breakpoints before setting new ones
2926 (@pxref{Disabling, ,Disabling Breakpoints}).
2927 @xref{Conditions, ,Break Conditions}.
2928 For remote targets, you can restrict the number of hardware
2929 breakpoints @value{GDBN} will use, see @ref{set remote
2930 hardware-breakpoint-limit}.
2934 @item thbreak @var{args}
2935 Set a hardware-assisted breakpoint enabled only for one stop. @var{args}
2936 are the same as for the @code{hbreak} command and the breakpoint is set in
2937 the same way. However, like the @code{tbreak} command,
2938 the breakpoint is automatically deleted after the
2939 first time your program stops there. Also, like the @code{hbreak}
2940 command, the breakpoint requires hardware support and some target hardware
2941 may not have this support. @xref{Disabling, ,Disabling Breakpoints}.
2942 See also @ref{Conditions, ,Break Conditions}.
2945 @cindex regular expression
2946 @cindex breakpoints in functions matching a regexp
2947 @cindex set breakpoints in many functions
2948 @item rbreak @var{regex}
2949 Set breakpoints on all functions matching the regular expression
2950 @var{regex}. This command sets an unconditional breakpoint on all
2951 matches, printing a list of all breakpoints it set. Once these
2952 breakpoints are set, they are treated just like the breakpoints set with
2953 the @code{break} command. You can delete them, disable them, or make
2954 them conditional the same way as any other breakpoint.
2956 The syntax of the regular expression is the standard one used with tools
2957 like @file{grep}. Note that this is different from the syntax used by
2958 shells, so for instance @code{foo*} matches all functions that include
2959 an @code{fo} followed by zero or more @code{o}s. There is an implicit
2960 @code{.*} leading and trailing the regular expression you supply, so to
2961 match only functions that begin with @code{foo}, use @code{^foo}.
2963 @cindex non-member C@t{++} functions, set breakpoint in
2964 When debugging C@t{++} programs, @code{rbreak} is useful for setting
2965 breakpoints on overloaded functions that are not members of any special
2968 @cindex set breakpoints on all functions
2969 The @code{rbreak} command can be used to set breakpoints in
2970 @strong{all} the functions in a program, like this:
2973 (@value{GDBP}) rbreak .
2976 @kindex info breakpoints
2977 @cindex @code{$_} and @code{info breakpoints}
2978 @item info breakpoints @r{[}@var{n}@r{]}
2979 @itemx info break @r{[}@var{n}@r{]}
2980 @itemx info watchpoints @r{[}@var{n}@r{]}
2981 Print a table of all breakpoints, watchpoints, and catchpoints set and
2982 not deleted. Optional argument @var{n} means print information only
2983 about the specified breakpoint (or watchpoint or catchpoint). For
2984 each breakpoint, following columns are printed:
2987 @item Breakpoint Numbers
2989 Breakpoint, watchpoint, or catchpoint.
2991 Whether the breakpoint is marked to be disabled or deleted when hit.
2992 @item Enabled or Disabled
2993 Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints
2994 that are not enabled. An optional @samp{(p)} suffix marks pending
2995 breakpoints --- breakpoints for which address is either not yet
2996 resolved, pending load of a shared library, or for which address was
2997 in a shared library that was since unloaded. Such breakpoint won't
2998 fire until a shared library that has the symbol or line referred by
2999 breakpoint is loaded. See below for details.
3001 Where the breakpoint is in your program, as a memory address. For a
3002 pending breakpoint whose address is not yet known, this field will
3003 contain @samp{<PENDING>}. A breakpoint with several locations will
3004 have @samp{<MULTIPLE>} in this field --- see below for details.
3006 Where the breakpoint is in the source for your program, as a file and
3007 line number. For a pending breakpoint, the original string passed to
3008 the breakpoint command will be listed as it cannot be resolved until
3009 the appropriate shared library is loaded in the future.
3013 If a breakpoint is conditional, @code{info break} shows the condition on
3014 the line following the affected breakpoint; breakpoint commands, if any,
3015 are listed after that. A pending breakpoint is allowed to have a condition
3016 specified for it. The condition is not parsed for validity until a shared
3017 library is loaded that allows the pending breakpoint to resolve to a
3021 @code{info break} with a breakpoint
3022 number @var{n} as argument lists only that breakpoint. The
3023 convenience variable @code{$_} and the default examining-address for
3024 the @code{x} command are set to the address of the last breakpoint
3025 listed (@pxref{Memory, ,Examining Memory}).
3028 @code{info break} displays a count of the number of times the breakpoint
3029 has been hit. This is especially useful in conjunction with the
3030 @code{ignore} command. You can ignore a large number of breakpoint
3031 hits, look at the breakpoint info to see how many times the breakpoint
3032 was hit, and then run again, ignoring one less than that number. This
3033 will get you quickly to the last hit of that breakpoint.
3036 @value{GDBN} allows you to set any number of breakpoints at the same place in
3037 your program. There is nothing silly or meaningless about this. When
3038 the breakpoints are conditional, this is even useful
3039 (@pxref{Conditions, ,Break Conditions}).
3041 It is possible that a breakpoint corresponds to several locations
3042 in your program. Examples of this situation are:
3047 For a C@t{++} constructor, the @value{NGCC} compiler generates several
3048 instances of the function body, used in different cases.
3051 For a C@t{++} template function, a given line in the function can
3052 correspond to any number of instantiations.
3055 For an inlined function, a given source line can correspond to
3056 several places where that function is inlined.
3060 In all those cases, @value{GDBN} will insert a breakpoint at all
3061 the relevant locations.
3063 A breakpoint with multiple locations is displayed in the
3064 breakpoint table using several rows --- one header row, followed
3065 by one row for each breakpoint location. The header row
3066 has @samp{<MULTIPLE>} in the address column. The rows for
3067 individual locations contain the actual addresses for locations,
3068 and say what functions those locations are in. The number
3069 column for a location has number in the format
3070 @var{breakpoint-number}.@var{location-number}.
3074 Num Type Disp Enb Address What
3075 1 breakpoint keep y <MULTIPLE>
3077 breakpoint already hit 1 time
3078 1.1 y 0x080486a2 in void foo<int>() at t.cc:8
3079 1.2 y 0x080486ca in void foo<double>() at t.cc:8
3082 Each location can be individually enabled or disabled by passing
3083 @var{breakpoint-number}.@var{location-number} as argument to the
3084 @code{enable} and @code{disable} commands.
3086 @cindex pending breakpoints
3087 It's quite common to have a breakpoint inside a shared library.
3088 The shared library may be loaded and unloaded explicitly,
3089 and possibly repeatedly, as the program is executed. To support
3090 this use case, @value{GDBN} updates breakpoint locations whenever
3091 any shared library is loaded or unloaded. Typically, you would
3092 set a breakpoint in a shared library at the beginning of your
3093 debugging session, when the library is not loaded, and when the
3094 symbols from the library are not available. When you try to set
3095 breakpoint, @value{GDBN} will ask you if you want to set
3096 a so called @dfn{pending breakpoint} --- breakpoint whose address
3097 is not yet resolved.
3099 After the program is run, whenever a new shared library is loaded,
3100 @value{GDBN} reevaluates all the breakpoints. When a newly loaded
3101 shared library contains the symbol or line referred to by some
3102 pending breakpoint, that breakpoint is resolved and becomes an
3103 ordinary breakpoint. When a library is unloaded, all breakpoints
3104 that refer to its symbols or source lines become pending again.
3106 This logic works for breakpoints with multiple locations, too. For
3107 example, if you have a breakpoint in a C@t{++} template function, and
3108 a newly loaded shared library has an instantiation of that template,
3109 a new location is added to the list of locations for the breakpoint.
3111 Except for having unresolved address, pending breakpoints do not
3112 differ from regular breakpoints. You can set conditions or commands,
3113 enable and disable them and perform other breakpoint operations.
3115 @value{GDBN} provides some additional commands for controlling what
3116 happens when the @samp{break} command cannot resolve breakpoint
3117 address specification to an address:
3119 @kindex set breakpoint pending
3120 @kindex show breakpoint pending
3122 @item set breakpoint pending auto
3123 This is the default behavior. When @value{GDBN} cannot find the breakpoint
3124 location, it queries you whether a pending breakpoint should be created.
3126 @item set breakpoint pending on
3127 This indicates that an unrecognized breakpoint location should automatically
3128 result in a pending breakpoint being created.
3130 @item set breakpoint pending off
3131 This indicates that pending breakpoints are not to be created. Any
3132 unrecognized breakpoint location results in an error. This setting does
3133 not affect any pending breakpoints previously created.
3135 @item show breakpoint pending
3136 Show the current behavior setting for creating pending breakpoints.
3139 The settings above only affect the @code{break} command and its
3140 variants. Once breakpoint is set, it will be automatically updated
3141 as shared libraries are loaded and unloaded.
3143 @cindex automatic hardware breakpoints
3144 For some targets, @value{GDBN} can automatically decide if hardware or
3145 software breakpoints should be used, depending on whether the
3146 breakpoint address is read-only or read-write. This applies to
3147 breakpoints set with the @code{break} command as well as to internal
3148 breakpoints set by commands like @code{next} and @code{finish}. For
3149 breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware
3152 You can control this automatic behaviour with the following commands::
3154 @kindex set breakpoint auto-hw
3155 @kindex show breakpoint auto-hw
3157 @item set breakpoint auto-hw on
3158 This is the default behavior. When @value{GDBN} sets a breakpoint, it
3159 will try to use the target memory map to decide if software or hardware
3160 breakpoint must be used.
3162 @item set breakpoint auto-hw off
3163 This indicates @value{GDBN} should not automatically select breakpoint
3164 type. If the target provides a memory map, @value{GDBN} will warn when
3165 trying to set software breakpoint at a read-only address.
3169 @cindex negative breakpoint numbers
3170 @cindex internal @value{GDBN} breakpoints
3171 @value{GDBN} itself sometimes sets breakpoints in your program for
3172 special purposes, such as proper handling of @code{longjmp} (in C
3173 programs). These internal breakpoints are assigned negative numbers,
3174 starting with @code{-1}; @samp{info breakpoints} does not display them.
3175 You can see these breakpoints with the @value{GDBN} maintenance command
3176 @samp{maint info breakpoints} (@pxref{maint info breakpoints}).
3179 @node Set Watchpoints
3180 @subsection Setting Watchpoints
3182 @cindex setting watchpoints
3183 You can use a watchpoint to stop execution whenever the value of an
3184 expression changes, without having to predict a particular place where
3185 this may happen. (This is sometimes called a @dfn{data breakpoint}.)
3186 The expression may be as simple as the value of a single variable, or
3187 as complex as many variables combined by operators. Examples include:
3191 A reference to the value of a single variable.
3194 An address cast to an appropriate data type. For example,
3195 @samp{*(int *)0x12345678} will watch a 4-byte region at the specified
3196 address (assuming an @code{int} occupies 4 bytes).
3199 An arbitrarily complex expression, such as @samp{a*b + c/d}. The
3200 expression can use any operators valid in the program's native
3201 language (@pxref{Languages}).
3204 @cindex software watchpoints
3205 @cindex hardware watchpoints
3206 Depending on your system, watchpoints may be implemented in software or
3207 hardware. @value{GDBN} does software watchpointing by single-stepping your
3208 program and testing the variable's value each time, which is hundreds of
3209 times slower than normal execution. (But this may still be worth it, to
3210 catch errors where you have no clue what part of your program is the
3213 On some systems, such as HP-UX, @sc{gnu}/Linux and most other
3214 x86-based targets, @value{GDBN} includes support for hardware
3215 watchpoints, which do not slow down the running of your program.
3219 @item watch @var{expr}
3220 Set a watchpoint for an expression. @value{GDBN} will break when the
3221 expression @var{expr} is written into by the program and its value
3222 changes. The simplest (and the most popular) use of this command is
3223 to watch the value of a single variable:
3226 (@value{GDBP}) watch foo
3230 @item rwatch @var{expr}
3231 Set a watchpoint that will break when the value of @var{expr} is read
3235 @item awatch @var{expr}
3236 Set a watchpoint that will break when @var{expr} is either read from
3237 or written into by the program.
3239 @kindex info watchpoints @r{[}@var{n}@r{]}
3240 @item info watchpoints
3241 This command prints a list of watchpoints, breakpoints, and catchpoints;
3242 it is the same as @code{info break} (@pxref{Set Breaks}).
3245 @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware
3246 watchpoints execute very quickly, and the debugger reports a change in
3247 value at the exact instruction where the change occurs. If @value{GDBN}
3248 cannot set a hardware watchpoint, it sets a software watchpoint, which
3249 executes more slowly and reports the change in value at the next
3250 @emph{statement}, not the instruction, after the change occurs.
3252 @cindex use only software watchpoints
3253 You can force @value{GDBN} to use only software watchpoints with the
3254 @kbd{set can-use-hw-watchpoints 0} command. With this variable set to
3255 zero, @value{GDBN} will never try to use hardware watchpoints, even if
3256 the underlying system supports them. (Note that hardware-assisted
3257 watchpoints that were set @emph{before} setting
3258 @code{can-use-hw-watchpoints} to zero will still use the hardware
3259 mechanism of watching expression values.)
3262 @item set can-use-hw-watchpoints
3263 @kindex set can-use-hw-watchpoints
3264 Set whether or not to use hardware watchpoints.
3266 @item show can-use-hw-watchpoints
3267 @kindex show can-use-hw-watchpoints
3268 Show the current mode of using hardware watchpoints.
3271 For remote targets, you can restrict the number of hardware
3272 watchpoints @value{GDBN} will use, see @ref{set remote
3273 hardware-breakpoint-limit}.
3275 When you issue the @code{watch} command, @value{GDBN} reports
3278 Hardware watchpoint @var{num}: @var{expr}
3282 if it was able to set a hardware watchpoint.
3284 Currently, the @code{awatch} and @code{rwatch} commands can only set
3285 hardware watchpoints, because accesses to data that don't change the
3286 value of the watched expression cannot be detected without examining
3287 every instruction as it is being executed, and @value{GDBN} does not do
3288 that currently. If @value{GDBN} finds that it is unable to set a
3289 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
3290 will print a message like this:
3293 Expression cannot be implemented with read/access watchpoint.
3296 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
3297 data type of the watched expression is wider than what a hardware
3298 watchpoint on the target machine can handle. For example, some systems
3299 can only watch regions that are up to 4 bytes wide; on such systems you
3300 cannot set hardware watchpoints for an expression that yields a
3301 double-precision floating-point number (which is typically 8 bytes
3302 wide). As a work-around, it might be possible to break the large region
3303 into a series of smaller ones and watch them with separate watchpoints.
3305 If you set too many hardware watchpoints, @value{GDBN} might be unable
3306 to insert all of them when you resume the execution of your program.
3307 Since the precise number of active watchpoints is unknown until such
3308 time as the program is about to be resumed, @value{GDBN} might not be
3309 able to warn you about this when you set the watchpoints, and the
3310 warning will be printed only when the program is resumed:
3313 Hardware watchpoint @var{num}: Could not insert watchpoint
3317 If this happens, delete or disable some of the watchpoints.
3319 Watching complex expressions that reference many variables can also
3320 exhaust the resources available for hardware-assisted watchpoints.
3321 That's because @value{GDBN} needs to watch every variable in the
3322 expression with separately allocated resources.
3324 The SPARClite DSU will generate traps when a program accesses some data
3325 or instruction address that is assigned to the debug registers. For the
3326 data addresses, DSU facilitates the @code{watch} command. However the
3327 hardware breakpoint registers can only take two data watchpoints, and
3328 both watchpoints must be the same kind. For example, you can set two
3329 watchpoints with @code{watch} commands, two with @code{rwatch} commands,
3330 @strong{or} two with @code{awatch} commands, but you cannot set one
3331 watchpoint with one command and the other with a different command.
3332 @value{GDBN} will reject the command if you try to mix watchpoints.
3333 Delete or disable unused watchpoint commands before setting new ones.
3335 If you call a function interactively using @code{print} or @code{call},
3336 any watchpoints you have set will be inactive until @value{GDBN} reaches another
3337 kind of breakpoint or the call completes.
3339 @value{GDBN} automatically deletes watchpoints that watch local
3340 (automatic) variables, or expressions that involve such variables, when
3341 they go out of scope, that is, when the execution leaves the block in
3342 which these variables were defined. In particular, when the program
3343 being debugged terminates, @emph{all} local variables go out of scope,
3344 and so only watchpoints that watch global variables remain set. If you
3345 rerun the program, you will need to set all such watchpoints again. One
3346 way of doing that would be to set a code breakpoint at the entry to the
3347 @code{main} function and when it breaks, set all the watchpoints.
3349 @cindex watchpoints and threads
3350 @cindex threads and watchpoints
3351 In multi-threaded programs, watchpoints will detect changes to the
3352 watched expression from every thread.
3355 @emph{Warning:} In multi-threaded programs, software watchpoints
3356 have only limited usefulness. If @value{GDBN} creates a software
3357 watchpoint, it can only watch the value of an expression @emph{in a
3358 single thread}. If you are confident that the expression can only
3359 change due to the current thread's activity (and if you are also
3360 confident that no other thread can become current), then you can use
3361 software watchpoints as usual. However, @value{GDBN} may not notice
3362 when a non-current thread's activity changes the expression. (Hardware
3363 watchpoints, in contrast, watch an expression in all threads.)
3366 @xref{set remote hardware-watchpoint-limit}.
3368 @node Set Catchpoints
3369 @subsection Setting Catchpoints
3370 @cindex catchpoints, setting
3371 @cindex exception handlers
3372 @cindex event handling
3374 You can use @dfn{catchpoints} to cause the debugger to stop for certain
3375 kinds of program events, such as C@t{++} exceptions or the loading of a
3376 shared library. Use the @code{catch} command to set a catchpoint.
3380 @item catch @var{event}
3381 Stop when @var{event} occurs. @var{event} can be any of the following:
3384 @cindex stop on C@t{++} exceptions
3385 The throwing of a C@t{++} exception.
3388 The catching of a C@t{++} exception.
3391 @cindex Ada exception catching
3392 @cindex catch Ada exceptions
3393 An Ada exception being raised. If an exception name is specified
3394 at the end of the command (eg @code{catch exception Program_Error}),
3395 the debugger will stop only when this specific exception is raised.
3396 Otherwise, the debugger stops execution when any Ada exception is raised.
3398 @item exception unhandled
3399 An exception that was raised but is not handled by the program.
3402 A failed Ada assertion.
3405 @cindex break on fork/exec
3406 A call to @code{exec}. This is currently only available for HP-UX.
3409 A call to @code{fork}. This is currently only available for HP-UX.
3412 A call to @code{vfork}. This is currently only available for HP-UX.
3415 @itemx load @var{libname}
3416 @cindex break on load/unload of shared library
3417 The dynamic loading of any shared library, or the loading of the library
3418 @var{libname}. This is currently only available for HP-UX.
3421 @itemx unload @var{libname}
3422 The unloading of any dynamically loaded shared library, or the unloading
3423 of the library @var{libname}. This is currently only available for HP-UX.
3426 @item tcatch @var{event}
3427 Set a catchpoint that is enabled only for one stop. The catchpoint is
3428 automatically deleted after the first time the event is caught.
3432 Use the @code{info break} command to list the current catchpoints.
3434 There are currently some limitations to C@t{++} exception handling
3435 (@code{catch throw} and @code{catch catch}) in @value{GDBN}:
3439 If you call a function interactively, @value{GDBN} normally returns
3440 control to you when the function has finished executing. If the call
3441 raises an exception, however, the call may bypass the mechanism that
3442 returns control to you and cause your program either to abort or to
3443 simply continue running until it hits a breakpoint, catches a signal
3444 that @value{GDBN} is listening for, or exits. This is the case even if
3445 you set a catchpoint for the exception; catchpoints on exceptions are
3446 disabled within interactive calls.
3449 You cannot raise an exception interactively.
3452 You cannot install an exception handler interactively.
3455 @cindex raise exceptions
3456 Sometimes @code{catch} is not the best way to debug exception handling:
3457 if you need to know exactly where an exception is raised, it is better to
3458 stop @emph{before} the exception handler is called, since that way you
3459 can see the stack before any unwinding takes place. If you set a
3460 breakpoint in an exception handler instead, it may not be easy to find
3461 out where the exception was raised.
3463 To stop just before an exception handler is called, you need some
3464 knowledge of the implementation. In the case of @sc{gnu} C@t{++}, exceptions are
3465 raised by calling a library function named @code{__raise_exception}
3466 which has the following ANSI C interface:
3469 /* @var{addr} is where the exception identifier is stored.
3470 @var{id} is the exception identifier. */
3471 void __raise_exception (void **addr, void *id);
3475 To make the debugger catch all exceptions before any stack
3476 unwinding takes place, set a breakpoint on @code{__raise_exception}
3477 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Exceptions}).
3479 With a conditional breakpoint (@pxref{Conditions, ,Break Conditions})
3480 that depends on the value of @var{id}, you can stop your program when
3481 a specific exception is raised. You can use multiple conditional
3482 breakpoints to stop your program when any of a number of exceptions are
3487 @subsection Deleting Breakpoints
3489 @cindex clearing breakpoints, watchpoints, catchpoints
3490 @cindex deleting breakpoints, watchpoints, catchpoints
3491 It is often necessary to eliminate a breakpoint, watchpoint, or
3492 catchpoint once it has done its job and you no longer want your program
3493 to stop there. This is called @dfn{deleting} the breakpoint. A
3494 breakpoint that has been deleted no longer exists; it is forgotten.
3496 With the @code{clear} command you can delete breakpoints according to
3497 where they are in your program. With the @code{delete} command you can
3498 delete individual breakpoints, watchpoints, or catchpoints by specifying
3499 their breakpoint numbers.
3501 It is not necessary to delete a breakpoint to proceed past it. @value{GDBN}
3502 automatically ignores breakpoints on the first instruction to be executed
3503 when you continue execution without changing the execution address.
3508 Delete any breakpoints at the next instruction to be executed in the
3509 selected stack frame (@pxref{Selection, ,Selecting a Frame}). When
3510 the innermost frame is selected, this is a good way to delete a
3511 breakpoint where your program just stopped.
3513 @item clear @var{function}
3514 @itemx clear @var{filename}:@var{function}
3515 Delete any breakpoints set at entry to the named @var{function}.
3517 @item clear @var{linenum}
3518 @itemx clear @var{filename}:@var{linenum}
3519 Delete any breakpoints set at or within the code of the specified
3520 @var{linenum} of the specified @var{filename}.
3522 @cindex delete breakpoints
3524 @kindex d @r{(@code{delete})}
3525 @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
3526 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
3527 ranges specified as arguments. If no argument is specified, delete all
3528 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
3529 confirm off}). You can abbreviate this command as @code{d}.
3533 @subsection Disabling Breakpoints
3535 @cindex enable/disable a breakpoint
3536 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
3537 prefer to @dfn{disable} it. This makes the breakpoint inoperative as if
3538 it had been deleted, but remembers the information on the breakpoint so
3539 that you can @dfn{enable} it again later.
3541 You disable and enable breakpoints, watchpoints, and catchpoints with
3542 the @code{enable} and @code{disable} commands, optionally specifying one
3543 or more breakpoint numbers as arguments. Use @code{info break} or
3544 @code{info watch} to print a list of breakpoints, watchpoints, and
3545 catchpoints if you do not know which numbers to use.
3547 A breakpoint, watchpoint, or catchpoint can have any of four different
3548 states of enablement:
3552 Enabled. The breakpoint stops your program. A breakpoint set
3553 with the @code{break} command starts out in this state.
3555 Disabled. The breakpoint has no effect on your program.
3557 Enabled once. The breakpoint stops your program, but then becomes
3560 Enabled for deletion. The breakpoint stops your program, but
3561 immediately after it does so it is deleted permanently. A breakpoint
3562 set with the @code{tbreak} command starts out in this state.
3565 You can use the following commands to enable or disable breakpoints,
3566 watchpoints, and catchpoints:
3570 @kindex dis @r{(@code{disable})}
3571 @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
3572 Disable the specified breakpoints---or all breakpoints, if none are
3573 listed. A disabled breakpoint has no effect but is not forgotten. All
3574 options such as ignore-counts, conditions and commands are remembered in
3575 case the breakpoint is enabled again later. You may abbreviate
3576 @code{disable} as @code{dis}.
3579 @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
3580 Enable the specified breakpoints (or all defined breakpoints). They
3581 become effective once again in stopping your program.
3583 @item enable @r{[}breakpoints@r{]} once @var{range}@dots{}
3584 Enable the specified breakpoints temporarily. @value{GDBN} disables any
3585 of these breakpoints immediately after stopping your program.
3587 @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{}
3588 Enable the specified breakpoints to work once, then die. @value{GDBN}
3589 deletes any of these breakpoints as soon as your program stops there.
3590 Breakpoints set by the @code{tbreak} command start out in this state.
3593 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
3594 @c confusing: tbreak is also initially enabled.
3595 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
3596 ,Setting Breakpoints}), breakpoints that you set are initially enabled;
3597 subsequently, they become disabled or enabled only when you use one of
3598 the commands above. (The command @code{until} can set and delete a
3599 breakpoint of its own, but it does not change the state of your other
3600 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
3604 @subsection Break Conditions
3605 @cindex conditional breakpoints
3606 @cindex breakpoint conditions
3608 @c FIXME what is scope of break condition expr? Context where wanted?
3609 @c in particular for a watchpoint?
3610 The simplest sort of breakpoint breaks every time your program reaches a
3611 specified place. You can also specify a @dfn{condition} for a
3612 breakpoint. A condition is just a Boolean expression in your
3613 programming language (@pxref{Expressions, ,Expressions}). A breakpoint with
3614 a condition evaluates the expression each time your program reaches it,
3615 and your program stops only if the condition is @emph{true}.
3617 This is the converse of using assertions for program validation; in that
3618 situation, you want to stop when the assertion is violated---that is,
3619 when the condition is false. In C, if you want to test an assertion expressed
3620 by the condition @var{assert}, you should set the condition
3621 @samp{! @var{assert}} on the appropriate breakpoint.
3623 Conditions are also accepted for watchpoints; you may not need them,
3624 since a watchpoint is inspecting the value of an expression anyhow---but
3625 it might be simpler, say, to just set a watchpoint on a variable name,
3626 and specify a condition that tests whether the new value is an interesting
3629 Break conditions can have side effects, and may even call functions in
3630 your program. This can be useful, for example, to activate functions
3631 that log program progress, or to use your own print functions to
3632 format special data structures. The effects are completely predictable
3633 unless there is another enabled breakpoint at the same address. (In
3634 that case, @value{GDBN} might see the other breakpoint first and stop your
3635 program without checking the condition of this one.) Note that
3636 breakpoint commands are usually more convenient and flexible than break
3638 purpose of performing side effects when a breakpoint is reached
3639 (@pxref{Break Commands, ,Breakpoint Command Lists}).
3641 Break conditions can be specified when a breakpoint is set, by using
3642 @samp{if} in the arguments to the @code{break} command. @xref{Set
3643 Breaks, ,Setting Breakpoints}. They can also be changed at any time
3644 with the @code{condition} command.
3646 You can also use the @code{if} keyword with the @code{watch} command.
3647 The @code{catch} command does not recognize the @code{if} keyword;
3648 @code{condition} is the only way to impose a further condition on a
3653 @item condition @var{bnum} @var{expression}
3654 Specify @var{expression} as the break condition for breakpoint,
3655 watchpoint, or catchpoint number @var{bnum}. After you set a condition,
3656 breakpoint @var{bnum} stops your program only if the value of
3657 @var{expression} is true (nonzero, in C). When you use
3658 @code{condition}, @value{GDBN} checks @var{expression} immediately for
3659 syntactic correctness, and to determine whether symbols in it have
3660 referents in the context of your breakpoint. If @var{expression} uses
3661 symbols not referenced in the context of the breakpoint, @value{GDBN}
3662 prints an error message:
3665 No symbol "foo" in current context.
3670 not actually evaluate @var{expression} at the time the @code{condition}
3671 command (or a command that sets a breakpoint with a condition, like
3672 @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}.
3674 @item condition @var{bnum}
3675 Remove the condition from breakpoint number @var{bnum}. It becomes
3676 an ordinary unconditional breakpoint.
3679 @cindex ignore count (of breakpoint)
3680 A special case of a breakpoint condition is to stop only when the
3681 breakpoint has been reached a certain number of times. This is so
3682 useful that there is a special way to do it, using the @dfn{ignore
3683 count} of the breakpoint. Every breakpoint has an ignore count, which
3684 is an integer. Most of the time, the ignore count is zero, and
3685 therefore has no effect. But if your program reaches a breakpoint whose
3686 ignore count is positive, then instead of stopping, it just decrements
3687 the ignore count by one and continues. As a result, if the ignore count
3688 value is @var{n}, the breakpoint does not stop the next @var{n} times
3689 your program reaches it.
3693 @item ignore @var{bnum} @var{count}
3694 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
3695 The next @var{count} times the breakpoint is reached, your program's
3696 execution does not stop; other than to decrement the ignore count, @value{GDBN}
3699 To make the breakpoint stop the next time it is reached, specify
3702 When you use @code{continue} to resume execution of your program from a
3703 breakpoint, you can specify an ignore count directly as an argument to
3704 @code{continue}, rather than using @code{ignore}. @xref{Continuing and
3705 Stepping,,Continuing and Stepping}.
3707 If a breakpoint has a positive ignore count and a condition, the
3708 condition is not checked. Once the ignore count reaches zero,
3709 @value{GDBN} resumes checking the condition.
3711 You could achieve the effect of the ignore count with a condition such
3712 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
3713 is decremented each time. @xref{Convenience Vars, ,Convenience
3717 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
3720 @node Break Commands
3721 @subsection Breakpoint Command Lists
3723 @cindex breakpoint commands
3724 You can give any breakpoint (or watchpoint or catchpoint) a series of
3725 commands to execute when your program stops due to that breakpoint. For
3726 example, you might want to print the values of certain expressions, or
3727 enable other breakpoints.
3731 @kindex end@r{ (breakpoint commands)}
3732 @item commands @r{[}@var{bnum}@r{]}
3733 @itemx @dots{} @var{command-list} @dots{}
3735 Specify a list of commands for breakpoint number @var{bnum}. The commands
3736 themselves appear on the following lines. Type a line containing just
3737 @code{end} to terminate the commands.
3739 To remove all commands from a breakpoint, type @code{commands} and
3740 follow it immediately with @code{end}; that is, give no commands.
3742 With no @var{bnum} argument, @code{commands} refers to the last
3743 breakpoint, watchpoint, or catchpoint set (not to the breakpoint most
3744 recently encountered).
3747 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
3748 disabled within a @var{command-list}.
3750 You can use breakpoint commands to start your program up again. Simply
3751 use the @code{continue} command, or @code{step}, or any other command
3752 that resumes execution.
3754 Any other commands in the command list, after a command that resumes
3755 execution, are ignored. This is because any time you resume execution
3756 (even with a simple @code{next} or @code{step}), you may encounter
3757 another breakpoint---which could have its own command list, leading to
3758 ambiguities about which list to execute.
3761 If the first command you specify in a command list is @code{silent}, the
3762 usual message about stopping at a breakpoint is not printed. This may
3763 be desirable for breakpoints that are to print a specific message and
3764 then continue. If none of the remaining commands print anything, you
3765 see no sign that the breakpoint was reached. @code{silent} is
3766 meaningful only at the beginning of a breakpoint command list.
3768 The commands @code{echo}, @code{output}, and @code{printf} allow you to
3769 print precisely controlled output, and are often useful in silent
3770 breakpoints. @xref{Output, ,Commands for Controlled Output}.
3772 For example, here is how you could use breakpoint commands to print the
3773 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
3779 printf "x is %d\n",x
3784 One application for breakpoint commands is to compensate for one bug so
3785 you can test for another. Put a breakpoint just after the erroneous line
3786 of code, give it a condition to detect the case in which something
3787 erroneous has been done, and give it commands to assign correct values
3788 to any variables that need them. End with the @code{continue} command
3789 so that your program does not stop, and start with the @code{silent}
3790 command so that no output is produced. Here is an example:
3801 @node Breakpoint Menus
3802 @subsection Breakpoint Menus
3804 @cindex symbol overloading
3806 Some programming languages (notably C@t{++} and Objective-C) permit a
3807 single function name
3808 to be defined several times, for application in different contexts.
3809 This is called @dfn{overloading}. When a function name is overloaded,
3810 @samp{break @var{function}} is not enough to tell @value{GDBN} where you want
3811 a breakpoint. If you realize this is a problem, you can use
3812 something like @samp{break @var{function}(@var{types})} to specify which
3813 particular version of the function you want. Otherwise, @value{GDBN} offers
3814 you a menu of numbered choices for different possible breakpoints, and
3815 waits for your selection with the prompt @samp{>}. The first two
3816 options are always @samp{[0] cancel} and @samp{[1] all}. Typing @kbd{1}
3817 sets a breakpoint at each definition of @var{function}, and typing
3818 @kbd{0} aborts the @code{break} command without setting any new
3821 For example, the following session excerpt shows an attempt to set a
3822 breakpoint at the overloaded symbol @code{String::after}.
3823 We choose three particular definitions of that function name:
3825 @c FIXME! This is likely to change to show arg type lists, at least
3828 (@value{GDBP}) b String::after
3831 [2] file:String.cc; line number:867
3832 [3] file:String.cc; line number:860
3833 [4] file:String.cc; line number:875
3834 [5] file:String.cc; line number:853
3835 [6] file:String.cc; line number:846
3836 [7] file:String.cc; line number:735
3838 Breakpoint 1 at 0xb26c: file String.cc, line 867.
3839 Breakpoint 2 at 0xb344: file String.cc, line 875.
3840 Breakpoint 3 at 0xafcc: file String.cc, line 846.
3841 Multiple breakpoints were set.
3842 Use the "delete" command to delete unwanted
3848 @c @ifclear BARETARGET
3849 @node Error in Breakpoints
3850 @subsection ``Cannot insert breakpoints''
3852 @c FIXME!! 14/6/95 Is there a real example of this? Let's use it.
3854 Under some operating systems, breakpoints cannot be used in a program if
3855 any other process is running that program. In this situation,
3856 attempting to run or continue a program with a breakpoint causes
3857 @value{GDBN} to print an error message:
3860 Cannot insert breakpoints.
3861 The same program may be running in another process.
3864 When this happens, you have three ways to proceed:
3868 Remove or disable the breakpoints, then continue.
3871 Suspend @value{GDBN}, and copy the file containing your program to a new
3872 name. Resume @value{GDBN} and use the @code{exec-file} command to specify
3873 that @value{GDBN} should run your program under that name.
3874 Then start your program again.
3877 Relink your program so that the text segment is nonsharable, using the
3878 linker option @samp{-N}. The operating system limitation may not apply
3879 to nonsharable executables.
3883 A similar message can be printed if you request too many active
3884 hardware-assisted breakpoints and watchpoints:
3886 @c FIXME: the precise wording of this message may change; the relevant
3887 @c source change is not committed yet (Sep 3, 1999).
3889 Stopped; cannot insert breakpoints.
3890 You may have requested too many hardware breakpoints and watchpoints.
3894 This message is printed when you attempt to resume the program, since
3895 only then @value{GDBN} knows exactly how many hardware breakpoints and
3896 watchpoints it needs to insert.
3898 When this message is printed, you need to disable or remove some of the
3899 hardware-assisted breakpoints and watchpoints, and then continue.
3901 @node Breakpoint-related Warnings
3902 @subsection ``Breakpoint address adjusted...''
3903 @cindex breakpoint address adjusted
3905 Some processor architectures place constraints on the addresses at
3906 which breakpoints may be placed. For architectures thus constrained,
3907 @value{GDBN} will attempt to adjust the breakpoint's address to comply
3908 with the constraints dictated by the architecture.
3910 One example of such an architecture is the Fujitsu FR-V. The FR-V is
3911 a VLIW architecture in which a number of RISC-like instructions may be
3912 bundled together for parallel execution. The FR-V architecture
3913 constrains the location of a breakpoint instruction within such a
3914 bundle to the instruction with the lowest address. @value{GDBN}
3915 honors this constraint by adjusting a breakpoint's address to the
3916 first in the bundle.
3918 It is not uncommon for optimized code to have bundles which contain
3919 instructions from different source statements, thus it may happen that
3920 a breakpoint's address will be adjusted from one source statement to
3921 another. Since this adjustment may significantly alter @value{GDBN}'s
3922 breakpoint related behavior from what the user expects, a warning is
3923 printed when the breakpoint is first set and also when the breakpoint
3926 A warning like the one below is printed when setting a breakpoint
3927 that's been subject to address adjustment:
3930 warning: Breakpoint address adjusted from 0x00010414 to 0x00010410.
3933 Such warnings are printed both for user settable and @value{GDBN}'s
3934 internal breakpoints. If you see one of these warnings, you should
3935 verify that a breakpoint set at the adjusted address will have the
3936 desired affect. If not, the breakpoint in question may be removed and
3937 other breakpoints may be set which will have the desired behavior.
3938 E.g., it may be sufficient to place the breakpoint at a later
3939 instruction. A conditional breakpoint may also be useful in some
3940 cases to prevent the breakpoint from triggering too often.
3942 @value{GDBN} will also issue a warning when stopping at one of these
3943 adjusted breakpoints:
3946 warning: Breakpoint 1 address previously adjusted from 0x00010414
3950 When this warning is encountered, it may be too late to take remedial
3951 action except in cases where the breakpoint is hit earlier or more
3952 frequently than expected.
3954 @node Continuing and Stepping
3955 @section Continuing and Stepping
3959 @cindex resuming execution
3960 @dfn{Continuing} means resuming program execution until your program
3961 completes normally. In contrast, @dfn{stepping} means executing just
3962 one more ``step'' of your program, where ``step'' may mean either one
3963 line of source code, or one machine instruction (depending on what
3964 particular command you use). Either when continuing or when stepping,
3965 your program may stop even sooner, due to a breakpoint or a signal. (If
3966 it stops due to a signal, you may want to use @code{handle}, or use
3967 @samp{signal 0} to resume execution. @xref{Signals, ,Signals}.)
3971 @kindex c @r{(@code{continue})}
3972 @kindex fg @r{(resume foreground execution)}
3973 @item continue @r{[}@var{ignore-count}@r{]}
3974 @itemx c @r{[}@var{ignore-count}@r{]}
3975 @itemx fg @r{[}@var{ignore-count}@r{]}
3976 Resume program execution, at the address where your program last stopped;
3977 any breakpoints set at that address are bypassed. The optional argument
3978 @var{ignore-count} allows you to specify a further number of times to
3979 ignore a breakpoint at this location; its effect is like that of
3980 @code{ignore} (@pxref{Conditions, ,Break Conditions}).
3982 The argument @var{ignore-count} is meaningful only when your program
3983 stopped due to a breakpoint. At other times, the argument to
3984 @code{continue} is ignored.
3986 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
3987 debugged program is deemed to be the foreground program) are provided
3988 purely for convenience, and have exactly the same behavior as
3992 To resume execution at a different place, you can use @code{return}
3993 (@pxref{Returning, ,Returning from a Function}) to go back to the
3994 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
3995 Different Address}) to go to an arbitrary location in your program.
3997 A typical technique for using stepping is to set a breakpoint
3998 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the
3999 beginning of the function or the section of your program where a problem
4000 is believed to lie, run your program until it stops at that breakpoint,
4001 and then step through the suspect area, examining the variables that are
4002 interesting, until you see the problem happen.
4006 @kindex s @r{(@code{step})}
4008 Continue running your program until control reaches a different source
4009 line, then stop it and return control to @value{GDBN}. This command is
4010 abbreviated @code{s}.
4013 @c "without debugging information" is imprecise; actually "without line
4014 @c numbers in the debugging information". (gcc -g1 has debugging info but
4015 @c not line numbers). But it seems complex to try to make that
4016 @c distinction here.
4017 @emph{Warning:} If you use the @code{step} command while control is
4018 within a function that was compiled without debugging information,
4019 execution proceeds until control reaches a function that does have
4020 debugging information. Likewise, it will not step into a function which
4021 is compiled without debugging information. To step through functions
4022 without debugging information, use the @code{stepi} command, described
4026 The @code{step} command only stops at the first instruction of a source
4027 line. This prevents the multiple stops that could otherwise occur in
4028 @code{switch} statements, @code{for} loops, etc. @code{step} continues
4029 to stop if a function that has debugging information is called within
4030 the line. In other words, @code{step} @emph{steps inside} any functions
4031 called within the line.
4033 Also, the @code{step} command only enters a function if there is line
4034 number information for the function. Otherwise it acts like the
4035 @code{next} command. This avoids problems when using @code{cc -gl}
4036 on MIPS machines. Previously, @code{step} entered subroutines if there
4037 was any debugging information about the routine.
4039 @item step @var{count}
4040 Continue running as in @code{step}, but do so @var{count} times. If a
4041 breakpoint is reached, or a signal not related to stepping occurs before
4042 @var{count} steps, stepping stops right away.
4045 @kindex n @r{(@code{next})}
4046 @item next @r{[}@var{count}@r{]}
4047 Continue to the next source line in the current (innermost) stack frame.
4048 This is similar to @code{step}, but function calls that appear within
4049 the line of code are executed without stopping. Execution stops when
4050 control reaches a different line of code at the original stack level
4051 that was executing when you gave the @code{next} command. This command
4052 is abbreviated @code{n}.
4054 An argument @var{count} is a repeat count, as for @code{step}.
4057 @c FIX ME!! Do we delete this, or is there a way it fits in with
4058 @c the following paragraph? --- Vctoria
4060 @c @code{next} within a function that lacks debugging information acts like
4061 @c @code{step}, but any function calls appearing within the code of the
4062 @c function are executed without stopping.
4064 The @code{next} command only stops at the first instruction of a
4065 source line. This prevents multiple stops that could otherwise occur in
4066 @code{switch} statements, @code{for} loops, etc.
4068 @kindex set step-mode
4070 @cindex functions without line info, and stepping
4071 @cindex stepping into functions with no line info
4072 @itemx set step-mode on
4073 The @code{set step-mode on} command causes the @code{step} command to
4074 stop at the first instruction of a function which contains no debug line
4075 information rather than stepping over it.
4077 This is useful in cases where you may be interested in inspecting the
4078 machine instructions of a function which has no symbolic info and do not
4079 want @value{GDBN} to automatically skip over this function.
4081 @item set step-mode off
4082 Causes the @code{step} command to step over any functions which contains no
4083 debug information. This is the default.
4085 @item show step-mode
4086 Show whether @value{GDBN} will stop in or step over functions without
4087 source line debug information.
4091 Continue running until just after function in the selected stack frame
4092 returns. Print the returned value (if any).
4094 Contrast this with the @code{return} command (@pxref{Returning,
4095 ,Returning from a Function}).
4098 @kindex u @r{(@code{until})}
4099 @cindex run until specified location
4102 Continue running until a source line past the current line, in the
4103 current stack frame, is reached. This command is used to avoid single
4104 stepping through a loop more than once. It is like the @code{next}
4105 command, except that when @code{until} encounters a jump, it
4106 automatically continues execution until the program counter is greater
4107 than the address of the jump.
4109 This means that when you reach the end of a loop after single stepping
4110 though it, @code{until} makes your program continue execution until it
4111 exits the loop. In contrast, a @code{next} command at the end of a loop
4112 simply steps back to the beginning of the loop, which forces you to step
4113 through the next iteration.
4115 @code{until} always stops your program if it attempts to exit the current
4118 @code{until} may produce somewhat counterintuitive results if the order
4119 of machine code does not match the order of the source lines. For
4120 example, in the following excerpt from a debugging session, the @code{f}
4121 (@code{frame}) command shows that execution is stopped at line
4122 @code{206}; yet when we use @code{until}, we get to line @code{195}:
4126 #0 main (argc=4, argv=0xf7fffae8) at m4.c:206
4128 (@value{GDBP}) until
4129 195 for ( ; argc > 0; NEXTARG) @{
4132 This happened because, for execution efficiency, the compiler had
4133 generated code for the loop closure test at the end, rather than the
4134 start, of the loop---even though the test in a C @code{for}-loop is
4135 written before the body of the loop. The @code{until} command appeared
4136 to step back to the beginning of the loop when it advanced to this
4137 expression; however, it has not really gone to an earlier
4138 statement---not in terms of the actual machine code.
4140 @code{until} with no argument works by means of single
4141 instruction stepping, and hence is slower than @code{until} with an
4144 @item until @var{location}
4145 @itemx u @var{location}
4146 Continue running your program until either the specified location is
4147 reached, or the current stack frame returns. @var{location} is any of
4148 the forms of argument acceptable to @code{break} (@pxref{Set Breaks,
4149 ,Setting Breakpoints}). This form of the command uses breakpoints, and
4150 hence is quicker than @code{until} without an argument. The specified
4151 location is actually reached only if it is in the current frame. This
4152 implies that @code{until} can be used to skip over recursive function
4153 invocations. For instance in the code below, if the current location is
4154 line @code{96}, issuing @code{until 99} will execute the program up to
4155 line @code{99} in the same invocation of factorial, i.e., after the inner
4156 invocations have returned.
4159 94 int factorial (int value)
4161 96 if (value > 1) @{
4162 97 value *= factorial (value - 1);
4169 @kindex advance @var{location}
4170 @itemx advance @var{location}
4171 Continue running the program up to the given @var{location}. An argument is
4172 required, which should be of the same form as arguments for the @code{break}
4173 command. Execution will also stop upon exit from the current stack
4174 frame. This command is similar to @code{until}, but @code{advance} will
4175 not skip over recursive function calls, and the target location doesn't
4176 have to be in the same frame as the current one.
4180 @kindex si @r{(@code{stepi})}
4182 @itemx stepi @var{arg}
4184 Execute one machine instruction, then stop and return to the debugger.
4186 It is often useful to do @samp{display/i $pc} when stepping by machine
4187 instructions. This makes @value{GDBN} automatically display the next
4188 instruction to be executed, each time your program stops. @xref{Auto
4189 Display,, Automatic Display}.
4191 An argument is a repeat count, as in @code{step}.
4195 @kindex ni @r{(@code{nexti})}
4197 @itemx nexti @var{arg}
4199 Execute one machine instruction, but if it is a function call,
4200 proceed until the function returns.
4202 An argument is a repeat count, as in @code{next}.
4209 A signal is an asynchronous event that can happen in a program. The
4210 operating system defines the possible kinds of signals, and gives each
4211 kind a name and a number. For example, in Unix @code{SIGINT} is the
4212 signal a program gets when you type an interrupt character (often @kbd{Ctrl-c});
4213 @code{SIGSEGV} is the signal a program gets from referencing a place in
4214 memory far away from all the areas in use; @code{SIGALRM} occurs when
4215 the alarm clock timer goes off (which happens only if your program has
4216 requested an alarm).
4218 @cindex fatal signals
4219 Some signals, including @code{SIGALRM}, are a normal part of the
4220 functioning of your program. Others, such as @code{SIGSEGV}, indicate
4221 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
4222 program has not specified in advance some other way to handle the signal.
4223 @code{SIGINT} does not indicate an error in your program, but it is normally
4224 fatal so it can carry out the purpose of the interrupt: to kill the program.
4226 @value{GDBN} has the ability to detect any occurrence of a signal in your
4227 program. You can tell @value{GDBN} in advance what to do for each kind of
4230 @cindex handling signals
4231 Normally, @value{GDBN} is set up to let the non-erroneous signals like
4232 @code{SIGALRM} be silently passed to your program
4233 (so as not to interfere with their role in the program's functioning)
4234 but to stop your program immediately whenever an error signal happens.
4235 You can change these settings with the @code{handle} command.
4238 @kindex info signals
4242 Print a table of all the kinds of signals and how @value{GDBN} has been told to
4243 handle each one. You can use this to see the signal numbers of all
4244 the defined types of signals.
4246 @item info signals @var{sig}
4247 Similar, but print information only about the specified signal number.
4249 @code{info handle} is an alias for @code{info signals}.
4252 @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
4253 Change the way @value{GDBN} handles signal @var{signal}. @var{signal}
4254 can be the number of a signal or its name (with or without the
4255 @samp{SIG} at the beginning); a list of signal numbers of the form
4256 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
4257 known signals. Optional arguments @var{keywords}, described below,
4258 say what change to make.
4262 The keywords allowed by the @code{handle} command can be abbreviated.
4263 Their full names are:
4267 @value{GDBN} should not stop your program when this signal happens. It may
4268 still print a message telling you that the signal has come in.
4271 @value{GDBN} should stop your program when this signal happens. This implies
4272 the @code{print} keyword as well.
4275 @value{GDBN} should print a message when this signal happens.
4278 @value{GDBN} should not mention the occurrence of the signal at all. This
4279 implies the @code{nostop} keyword as well.
4283 @value{GDBN} should allow your program to see this signal; your program
4284 can handle the signal, or else it may terminate if the signal is fatal
4285 and not handled. @code{pass} and @code{noignore} are synonyms.
4289 @value{GDBN} should not allow your program to see this signal.
4290 @code{nopass} and @code{ignore} are synonyms.
4294 When a signal stops your program, the signal is not visible to the
4296 continue. Your program sees the signal then, if @code{pass} is in
4297 effect for the signal in question @emph{at that time}. In other words,
4298 after @value{GDBN} reports a signal, you can use the @code{handle}
4299 command with @code{pass} or @code{nopass} to control whether your
4300 program sees that signal when you continue.
4302 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
4303 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
4304 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
4307 You can also use the @code{signal} command to prevent your program from
4308 seeing a signal, or cause it to see a signal it normally would not see,
4309 or to give it any signal at any time. For example, if your program stopped
4310 due to some sort of memory reference error, you might store correct
4311 values into the erroneous variables and continue, hoping to see more
4312 execution; but your program would probably terminate immediately as
4313 a result of the fatal signal once it saw the signal. To prevent this,
4314 you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your
4318 @section Stopping and Starting Multi-thread Programs
4320 When your program has multiple threads (@pxref{Threads,, Debugging
4321 Programs with Multiple Threads}), you can choose whether to set
4322 breakpoints on all threads, or on a particular thread.
4325 @cindex breakpoints and threads
4326 @cindex thread breakpoints
4327 @kindex break @dots{} thread @var{threadno}
4328 @item break @var{linespec} thread @var{threadno}
4329 @itemx break @var{linespec} thread @var{threadno} if @dots{}
4330 @var{linespec} specifies source lines; there are several ways of
4331 writing them, but the effect is always to specify some source line.
4333 Use the qualifier @samp{thread @var{threadno}} with a breakpoint command
4334 to specify that you only want @value{GDBN} to stop the program when a
4335 particular thread reaches this breakpoint. @var{threadno} is one of the
4336 numeric thread identifiers assigned by @value{GDBN}, shown in the first
4337 column of the @samp{info threads} display.
4339 If you do not specify @samp{thread @var{threadno}} when you set a
4340 breakpoint, the breakpoint applies to @emph{all} threads of your
4343 You can use the @code{thread} qualifier on conditional breakpoints as
4344 well; in this case, place @samp{thread @var{threadno}} before the
4345 breakpoint condition, like this:
4348 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
4353 @cindex stopped threads
4354 @cindex threads, stopped
4355 Whenever your program stops under @value{GDBN} for any reason,
4356 @emph{all} threads of execution stop, not just the current thread. This
4357 allows you to examine the overall state of the program, including
4358 switching between threads, without worrying that things may change
4361 @cindex thread breakpoints and system calls
4362 @cindex system calls and thread breakpoints
4363 @cindex premature return from system calls
4364 There is an unfortunate side effect. If one thread stops for a
4365 breakpoint, or for some other reason, and another thread is blocked in a
4366 system call, then the system call may return prematurely. This is a
4367 consequence of the interaction between multiple threads and the signals
4368 that @value{GDBN} uses to implement breakpoints and other events that
4371 To handle this problem, your program should check the return value of
4372 each system call and react appropriately. This is good programming
4375 For example, do not write code like this:
4381 The call to @code{sleep} will return early if a different thread stops
4382 at a breakpoint or for some other reason.
4384 Instead, write this:
4389 unslept = sleep (unslept);
4392 A system call is allowed to return early, so the system is still
4393 conforming to its specification. But @value{GDBN} does cause your
4394 multi-threaded program to behave differently than it would without
4397 Also, @value{GDBN} uses internal breakpoints in the thread library to
4398 monitor certain events such as thread creation and thread destruction.
4399 When such an event happens, a system call in another thread may return
4400 prematurely, even though your program does not appear to stop.
4402 @cindex continuing threads
4403 @cindex threads, continuing
4404 Conversely, whenever you restart the program, @emph{all} threads start
4405 executing. @emph{This is true even when single-stepping} with commands
4406 like @code{step} or @code{next}.
4408 In particular, @value{GDBN} cannot single-step all threads in lockstep.
4409 Since thread scheduling is up to your debugging target's operating
4410 system (not controlled by @value{GDBN}), other threads may
4411 execute more than one statement while the current thread completes a
4412 single step. Moreover, in general other threads stop in the middle of a
4413 statement, rather than at a clean statement boundary, when the program
4416 You might even find your program stopped in another thread after
4417 continuing or even single-stepping. This happens whenever some other
4418 thread runs into a breakpoint, a signal, or an exception before the
4419 first thread completes whatever you requested.
4421 On some OSes, you can lock the OS scheduler and thus allow only a single
4425 @item set scheduler-locking @var{mode}
4426 @cindex scheduler locking mode
4427 @cindex lock scheduler
4428 Set the scheduler locking mode. If it is @code{off}, then there is no
4429 locking and any thread may run at any time. If @code{on}, then only the
4430 current thread may run when the inferior is resumed. The @code{step}
4431 mode optimizes for single-stepping. It stops other threads from
4432 ``seizing the prompt'' by preempting the current thread while you are
4433 stepping. Other threads will only rarely (or never) get a chance to run
4434 when you step. They are more likely to run when you @samp{next} over a
4435 function call, and they are completely free to run when you use commands
4436 like @samp{continue}, @samp{until}, or @samp{finish}. However, unless another
4437 thread hits a breakpoint during its timeslice, they will never steal the
4438 @value{GDBN} prompt away from the thread that you are debugging.
4440 @item show scheduler-locking
4441 Display the current scheduler locking mode.
4446 @chapter Examining the Stack
4448 When your program has stopped, the first thing you need to know is where it
4449 stopped and how it got there.
4452 Each time your program performs a function call, information about the call
4454 That information includes the location of the call in your program,
4455 the arguments of the call,
4456 and the local variables of the function being called.
4457 The information is saved in a block of data called a @dfn{stack frame}.
4458 The stack frames are allocated in a region of memory called the @dfn{call
4461 When your program stops, the @value{GDBN} commands for examining the
4462 stack allow you to see all of this information.
4464 @cindex selected frame
4465 One of the stack frames is @dfn{selected} by @value{GDBN} and many
4466 @value{GDBN} commands refer implicitly to the selected frame. In
4467 particular, whenever you ask @value{GDBN} for the value of a variable in
4468 your program, the value is found in the selected frame. There are
4469 special @value{GDBN} commands to select whichever frame you are
4470 interested in. @xref{Selection, ,Selecting a Frame}.
4472 When your program stops, @value{GDBN} automatically selects the
4473 currently executing frame and describes it briefly, similar to the
4474 @code{frame} command (@pxref{Frame Info, ,Information about a Frame}).
4477 * Frames:: Stack frames
4478 * Backtrace:: Backtraces
4479 * Selection:: Selecting a frame
4480 * Frame Info:: Information on a frame
4485 @section Stack Frames
4487 @cindex frame, definition
4489 The call stack is divided up into contiguous pieces called @dfn{stack
4490 frames}, or @dfn{frames} for short; each frame is the data associated
4491 with one call to one function. The frame contains the arguments given
4492 to the function, the function's local variables, and the address at
4493 which the function is executing.
4495 @cindex initial frame
4496 @cindex outermost frame
4497 @cindex innermost frame
4498 When your program is started, the stack has only one frame, that of the
4499 function @code{main}. This is called the @dfn{initial} frame or the
4500 @dfn{outermost} frame. Each time a function is called, a new frame is
4501 made. Each time a function returns, the frame for that function invocation
4502 is eliminated. If a function is recursive, there can be many frames for
4503 the same function. The frame for the function in which execution is
4504 actually occurring is called the @dfn{innermost} frame. This is the most
4505 recently created of all the stack frames that still exist.
4507 @cindex frame pointer
4508 Inside your program, stack frames are identified by their addresses. A
4509 stack frame consists of many bytes, each of which has its own address; each
4510 kind of computer has a convention for choosing one byte whose
4511 address serves as the address of the frame. Usually this address is kept
4512 in a register called the @dfn{frame pointer register}
4513 (@pxref{Registers, $fp}) while execution is going on in that frame.
4515 @cindex frame number
4516 @value{GDBN} assigns numbers to all existing stack frames, starting with
4517 zero for the innermost frame, one for the frame that called it,
4518 and so on upward. These numbers do not really exist in your program;
4519 they are assigned by @value{GDBN} to give you a way of designating stack
4520 frames in @value{GDBN} commands.
4522 @c The -fomit-frame-pointer below perennially causes hbox overflow
4523 @c underflow problems.
4524 @cindex frameless execution
4525 Some compilers provide a way to compile functions so that they operate
4526 without stack frames. (For example, the @value{NGCC} option
4528 @samp{-fomit-frame-pointer}
4530 generates functions without a frame.)
4531 This is occasionally done with heavily used library functions to save
4532 the frame setup time. @value{GDBN} has limited facilities for dealing
4533 with these function invocations. If the innermost function invocation
4534 has no stack frame, @value{GDBN} nevertheless regards it as though
4535 it had a separate frame, which is numbered zero as usual, allowing
4536 correct tracing of the function call chain. However, @value{GDBN} has
4537 no provision for frameless functions elsewhere in the stack.
4540 @kindex frame@r{, command}
4541 @cindex current stack frame
4542 @item frame @var{args}
4543 The @code{frame} command allows you to move from one stack frame to another,
4544 and to print the stack frame you select. @var{args} may be either the
4545 address of the frame or the stack frame number. Without an argument,
4546 @code{frame} prints the current stack frame.
4548 @kindex select-frame
4549 @cindex selecting frame silently
4551 The @code{select-frame} command allows you to move from one stack frame
4552 to another without printing the frame. This is the silent version of
4560 @cindex call stack traces
4561 A backtrace is a summary of how your program got where it is. It shows one
4562 line per frame, for many frames, starting with the currently executing
4563 frame (frame zero), followed by its caller (frame one), and on up the
4568 @kindex bt @r{(@code{backtrace})}
4571 Print a backtrace of the entire stack: one line per frame for all
4572 frames in the stack.
4574 You can stop the backtrace at any time by typing the system interrupt
4575 character, normally @kbd{Ctrl-c}.
4577 @item backtrace @var{n}
4579 Similar, but print only the innermost @var{n} frames.
4581 @item backtrace -@var{n}
4583 Similar, but print only the outermost @var{n} frames.
4585 @item backtrace full
4587 @itemx bt full @var{n}
4588 @itemx bt full -@var{n}
4589 Print the values of the local variables also. @var{n} specifies the
4590 number of frames to print, as described above.
4595 The names @code{where} and @code{info stack} (abbreviated @code{info s})
4596 are additional aliases for @code{backtrace}.
4598 @cindex multiple threads, backtrace
4599 In a multi-threaded program, @value{GDBN} by default shows the
4600 backtrace only for the current thread. To display the backtrace for
4601 several or all of the threads, use the command @code{thread apply}
4602 (@pxref{Threads, thread apply}). For example, if you type @kbd{thread
4603 apply all backtrace}, @value{GDBN} will display the backtrace for all
4604 the threads; this is handy when you debug a core dump of a
4605 multi-threaded program.
4607 Each line in the backtrace shows the frame number and the function name.
4608 The program counter value is also shown---unless you use @code{set
4609 print address off}. The backtrace also shows the source file name and
4610 line number, as well as the arguments to the function. The program
4611 counter value is omitted if it is at the beginning of the code for that
4614 Here is an example of a backtrace. It was made with the command
4615 @samp{bt 3}, so it shows the innermost three frames.
4619 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
4621 #1 0x6e38 in expand_macro (sym=0x2b600) at macro.c:242
4622 #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
4624 (More stack frames follow...)
4629 The display for frame zero does not begin with a program counter
4630 value, indicating that your program has stopped at the beginning of the
4631 code for line @code{993} of @code{builtin.c}.
4633 @cindex value optimized out, in backtrace
4634 @cindex function call arguments, optimized out
4635 If your program was compiled with optimizations, some compilers will
4636 optimize away arguments passed to functions if those arguments are
4637 never used after the call. Such optimizations generate code that
4638 passes arguments through registers, but doesn't store those arguments
4639 in the stack frame. @value{GDBN} has no way of displaying such
4640 arguments in stack frames other than the innermost one. Here's what
4641 such a backtrace might look like:
4645 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
4647 #1 0x6e38 in expand_macro (sym=<value optimized out>) at macro.c:242
4648 #2 0x6840 in expand_token (obs=0x0, t=<value optimized out>, td=0xf7fffb08)
4650 (More stack frames follow...)
4655 The values of arguments that were not saved in their stack frames are
4656 shown as @samp{<value optimized out>}.
4658 If you need to display the values of such optimized-out arguments,
4659 either deduce that from other variables whose values depend on the one
4660 you are interested in, or recompile without optimizations.
4662 @cindex backtrace beyond @code{main} function
4663 @cindex program entry point
4664 @cindex startup code, and backtrace
4665 Most programs have a standard user entry point---a place where system
4666 libraries and startup code transition into user code. For C this is
4667 @code{main}@footnote{
4668 Note that embedded programs (the so-called ``free-standing''
4669 environment) are not required to have a @code{main} function as the
4670 entry point. They could even have multiple entry points.}.
4671 When @value{GDBN} finds the entry function in a backtrace
4672 it will terminate the backtrace, to avoid tracing into highly
4673 system-specific (and generally uninteresting) code.
4675 If you need to examine the startup code, or limit the number of levels
4676 in a backtrace, you can change this behavior:
4679 @item set backtrace past-main
4680 @itemx set backtrace past-main on
4681 @kindex set backtrace
4682 Backtraces will continue past the user entry point.
4684 @item set backtrace past-main off
4685 Backtraces will stop when they encounter the user entry point. This is the
4688 @item show backtrace past-main
4689 @kindex show backtrace
4690 Display the current user entry point backtrace policy.
4692 @item set backtrace past-entry
4693 @itemx set backtrace past-entry on
4694 Backtraces will continue past the internal entry point of an application.
4695 This entry point is encoded by the linker when the application is built,
4696 and is likely before the user entry point @code{main} (or equivalent) is called.
4698 @item set backtrace past-entry off
4699 Backtraces will stop when they encounter the internal entry point of an
4700 application. This is the default.
4702 @item show backtrace past-entry
4703 Display the current internal entry point backtrace policy.
4705 @item set backtrace limit @var{n}
4706 @itemx set backtrace limit 0
4707 @cindex backtrace limit
4708 Limit the backtrace to @var{n} levels. A value of zero means
4711 @item show backtrace limit
4712 Display the current limit on backtrace levels.
4716 @section Selecting a Frame
4718 Most commands for examining the stack and other data in your program work on
4719 whichever stack frame is selected at the moment. Here are the commands for
4720 selecting a stack frame; all of them finish by printing a brief description
4721 of the stack frame just selected.
4724 @kindex frame@r{, selecting}
4725 @kindex f @r{(@code{frame})}
4728 Select frame number @var{n}. Recall that frame zero is the innermost
4729 (currently executing) frame, frame one is the frame that called the
4730 innermost one, and so on. The highest-numbered frame is the one for
4733 @item frame @var{addr}
4735 Select the frame at address @var{addr}. This is useful mainly if the
4736 chaining of stack frames has been damaged by a bug, making it
4737 impossible for @value{GDBN} to assign numbers properly to all frames. In
4738 addition, this can be useful when your program has multiple stacks and
4739 switches between them.
4741 On the SPARC architecture, @code{frame} needs two addresses to
4742 select an arbitrary frame: a frame pointer and a stack pointer.
4744 On the MIPS and Alpha architecture, it needs two addresses: a stack
4745 pointer and a program counter.
4747 On the 29k architecture, it needs three addresses: a register stack
4748 pointer, a program counter, and a memory stack pointer.
4752 Move @var{n} frames up the stack. For positive numbers @var{n}, this
4753 advances toward the outermost frame, to higher frame numbers, to frames
4754 that have existed longer. @var{n} defaults to one.
4757 @kindex do @r{(@code{down})}
4759 Move @var{n} frames down the stack. For positive numbers @var{n}, this
4760 advances toward the innermost frame, to lower frame numbers, to frames
4761 that were created more recently. @var{n} defaults to one. You may
4762 abbreviate @code{down} as @code{do}.
4765 All of these commands end by printing two lines of output describing the
4766 frame. The first line shows the frame number, the function name, the
4767 arguments, and the source file and line number of execution in that
4768 frame. The second line shows the text of that source line.
4776 #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
4778 10 read_input_file (argv[i]);
4782 After such a printout, the @code{list} command with no arguments
4783 prints ten lines centered on the point of execution in the frame.
4784 You can also edit the program at the point of execution with your favorite
4785 editing program by typing @code{edit}.
4786 @xref{List, ,Printing Source Lines},
4790 @kindex down-silently
4792 @item up-silently @var{n}
4793 @itemx down-silently @var{n}
4794 These two commands are variants of @code{up} and @code{down},
4795 respectively; they differ in that they do their work silently, without
4796 causing display of the new frame. They are intended primarily for use
4797 in @value{GDBN} command scripts, where the output might be unnecessary and
4802 @section Information About a Frame
4804 There are several other commands to print information about the selected
4810 When used without any argument, this command does not change which
4811 frame is selected, but prints a brief description of the currently
4812 selected stack frame. It can be abbreviated @code{f}. With an
4813 argument, this command is used to select a stack frame.
4814 @xref{Selection, ,Selecting a Frame}.
4817 @kindex info f @r{(@code{info frame})}
4820 This command prints a verbose description of the selected stack frame,
4825 the address of the frame
4827 the address of the next frame down (called by this frame)
4829 the address of the next frame up (caller of this frame)
4831 the language in which the source code corresponding to this frame is written
4833 the address of the frame's arguments
4835 the address of the frame's local variables
4837 the program counter saved in it (the address of execution in the caller frame)
4839 which registers were saved in the frame
4842 @noindent The verbose description is useful when
4843 something has gone wrong that has made the stack format fail to fit
4844 the usual conventions.
4846 @item info frame @var{addr}
4847 @itemx info f @var{addr}
4848 Print a verbose description of the frame at address @var{addr}, without
4849 selecting that frame. The selected frame remains unchanged by this
4850 command. This requires the same kind of address (more than one for some
4851 architectures) that you specify in the @code{frame} command.
4852 @xref{Selection, ,Selecting a Frame}.
4856 Print the arguments of the selected frame, each on a separate line.
4860 Print the local variables of the selected frame, each on a separate
4861 line. These are all variables (declared either static or automatic)
4862 accessible at the point of execution of the selected frame.
4865 @cindex catch exceptions, list active handlers
4866 @cindex exception handlers, how to list
4868 Print a list of all the exception handlers that are active in the
4869 current stack frame at the current point of execution. To see other
4870 exception handlers, visit the associated frame (using the @code{up},
4871 @code{down}, or @code{frame} commands); then type @code{info catch}.
4872 @xref{Set Catchpoints, , Setting Catchpoints}.
4878 @chapter Examining Source Files
4880 @value{GDBN} can print parts of your program's source, since the debugging
4881 information recorded in the program tells @value{GDBN} what source files were
4882 used to build it. When your program stops, @value{GDBN} spontaneously prints
4883 the line where it stopped. Likewise, when you select a stack frame
4884 (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where
4885 execution in that frame has stopped. You can print other portions of
4886 source files by explicit command.
4888 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
4889 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
4890 @value{GDBN} under @sc{gnu} Emacs}.
4893 * List:: Printing source lines
4894 * Edit:: Editing source files
4895 * Search:: Searching source files
4896 * Source Path:: Specifying source directories
4897 * Machine Code:: Source and machine code
4901 @section Printing Source Lines
4904 @kindex l @r{(@code{list})}
4905 To print lines from a source file, use the @code{list} command
4906 (abbreviated @code{l}). By default, ten lines are printed.
4907 There are several ways to specify what part of the file you want to print.
4909 Here are the forms of the @code{list} command most commonly used:
4912 @item list @var{linenum}
4913 Print lines centered around line number @var{linenum} in the
4914 current source file.
4916 @item list @var{function}
4917 Print lines centered around the beginning of function
4921 Print more lines. If the last lines printed were printed with a
4922 @code{list} command, this prints lines following the last lines
4923 printed; however, if the last line printed was a solitary line printed
4924 as part of displaying a stack frame (@pxref{Stack, ,Examining the
4925 Stack}), this prints lines centered around that line.
4928 Print lines just before the lines last printed.
4931 @cindex @code{list}, how many lines to display
4932 By default, @value{GDBN} prints ten source lines with any of these forms of
4933 the @code{list} command. You can change this using @code{set listsize}:
4936 @kindex set listsize
4937 @item set listsize @var{count}
4938 Make the @code{list} command display @var{count} source lines (unless
4939 the @code{list} argument explicitly specifies some other number).
4941 @kindex show listsize
4943 Display the number of lines that @code{list} prints.
4946 Repeating a @code{list} command with @key{RET} discards the argument,
4947 so it is equivalent to typing just @code{list}. This is more useful
4948 than listing the same lines again. An exception is made for an
4949 argument of @samp{-}; that argument is preserved in repetition so that
4950 each repetition moves up in the source file.
4953 In general, the @code{list} command expects you to supply zero, one or two
4954 @dfn{linespecs}. Linespecs specify source lines; there are several ways
4955 of writing them, but the effect is always to specify some source line.
4956 Here is a complete description of the possible arguments for @code{list}:
4959 @item list @var{linespec}
4960 Print lines centered around the line specified by @var{linespec}.
4962 @item list @var{first},@var{last}
4963 Print lines from @var{first} to @var{last}. Both arguments are
4966 @item list ,@var{last}
4967 Print lines ending with @var{last}.
4969 @item list @var{first},
4970 Print lines starting with @var{first}.
4973 Print lines just after the lines last printed.
4976 Print lines just before the lines last printed.
4979 As described in the preceding table.
4982 Here are the ways of specifying a single source line---all the
4987 Specifies line @var{number} of the current source file.
4988 When a @code{list} command has two linespecs, this refers to
4989 the same source file as the first linespec.
4992 Specifies the line @var{offset} lines after the last line printed.
4993 When used as the second linespec in a @code{list} command that has
4994 two, this specifies the line @var{offset} lines down from the
4998 Specifies the line @var{offset} lines before the last line printed.
5000 @item @var{filename}:@var{number}
5001 Specifies line @var{number} in the source file @var{filename}.
5003 @item @var{function}
5004 Specifies the line that begins the body of the function @var{function}.
5005 For example: in C, this is the line with the open brace.
5007 @item @var{filename}:@var{function}
5008 Specifies the line of the open-brace that begins the body of the
5009 function @var{function} in the file @var{filename}. You only need the
5010 file name with a function name to avoid ambiguity when there are
5011 identically named functions in different source files.
5013 @item *@var{address}
5014 Specifies the line containing the program address @var{address}.
5015 @var{address} may be any expression.
5019 @section Editing Source Files
5020 @cindex editing source files
5023 @kindex e @r{(@code{edit})}
5024 To edit the lines in a source file, use the @code{edit} command.
5025 The editing program of your choice
5026 is invoked with the current line set to
5027 the active line in the program.
5028 Alternatively, there are several ways to specify what part of the file you
5029 want to print if you want to see other parts of the program.
5031 Here are the forms of the @code{edit} command most commonly used:
5035 Edit the current source file at the active line number in the program.
5037 @item edit @var{number}
5038 Edit the current source file with @var{number} as the active line number.
5040 @item edit @var{function}
5041 Edit the file containing @var{function} at the beginning of its definition.
5043 @item edit @var{filename}:@var{number}
5044 Specifies line @var{number} in the source file @var{filename}.
5046 @item edit @var{filename}:@var{function}
5047 Specifies the line that begins the body of the
5048 function @var{function} in the file @var{filename}. You only need the
5049 file name with a function name to avoid ambiguity when there are
5050 identically named functions in different source files.
5052 @item edit *@var{address}
5053 Specifies the line containing the program address @var{address}.
5054 @var{address} may be any expression.
5057 @subsection Choosing your Editor
5058 You can customize @value{GDBN} to use any editor you want
5060 The only restriction is that your editor (say @code{ex}), recognizes the
5061 following command-line syntax:
5063 ex +@var{number} file
5065 The optional numeric value +@var{number} specifies the number of the line in
5066 the file where to start editing.}.
5067 By default, it is @file{@value{EDITOR}}, but you can change this
5068 by setting the environment variable @code{EDITOR} before using
5069 @value{GDBN}. For example, to configure @value{GDBN} to use the
5070 @code{vi} editor, you could use these commands with the @code{sh} shell:
5076 or in the @code{csh} shell,
5078 setenv EDITOR /usr/bin/vi
5083 @section Searching Source Files
5084 @cindex searching source files
5086 There are two commands for searching through the current source file for a
5091 @kindex forward-search
5092 @item forward-search @var{regexp}
5093 @itemx search @var{regexp}
5094 The command @samp{forward-search @var{regexp}} checks each line,
5095 starting with the one following the last line listed, for a match for
5096 @var{regexp}. It lists the line that is found. You can use the
5097 synonym @samp{search @var{regexp}} or abbreviate the command name as
5100 @kindex reverse-search
5101 @item reverse-search @var{regexp}
5102 The command @samp{reverse-search @var{regexp}} checks each line, starting
5103 with the one before the last line listed and going backward, for a match
5104 for @var{regexp}. It lists the line that is found. You can abbreviate
5105 this command as @code{rev}.
5109 @section Specifying Source Directories
5112 @cindex directories for source files
5113 Executable programs sometimes do not record the directories of the source
5114 files from which they were compiled, just the names. Even when they do,
5115 the directories could be moved between the compilation and your debugging
5116 session. @value{GDBN} has a list of directories to search for source files;
5117 this is called the @dfn{source path}. Each time @value{GDBN} wants a source file,
5118 it tries all the directories in the list, in the order they are present
5119 in the list, until it finds a file with the desired name.
5121 For example, suppose an executable references the file
5122 @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is
5123 @file{/mnt/cross}. The file is first looked up literally; if this
5124 fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this
5125 fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error
5126 message is printed. @value{GDBN} does not look up the parts of the
5127 source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}.
5128 Likewise, the subdirectories of the source path are not searched: if
5129 the source path is @file{/mnt/cross}, and the binary refers to
5130 @file{foo.c}, @value{GDBN} would not find it under
5131 @file{/mnt/cross/usr/src/foo-1.0/lib}.
5133 Plain file names, relative file names with leading directories, file
5134 names containing dots, etc.@: are all treated as described above; for
5135 instance, if the source path is @file{/mnt/cross}, and the source file
5136 is recorded as @file{../lib/foo.c}, @value{GDBN} would first try
5137 @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after
5138 that---@file{/mnt/cross/foo.c}.
5140 Note that the executable search path is @emph{not} used to locate the
5143 Whenever you reset or rearrange the source path, @value{GDBN} clears out
5144 any information it has cached about where source files are found and where
5145 each line is in the file.
5149 When you start @value{GDBN}, its source path includes only @samp{cdir}
5150 and @samp{cwd}, in that order.
5151 To add other directories, use the @code{directory} command.
5153 The search path is used to find both program source files and @value{GDBN}
5154 script files (read using the @samp{-command} option and @samp{source} command).
5156 In addition to the source path, @value{GDBN} provides a set of commands
5157 that manage a list of source path substitution rules. A @dfn{substitution
5158 rule} specifies how to rewrite source directories stored in the program's
5159 debug information in case the sources were moved to a different
5160 directory between compilation and debugging. A rule is made of
5161 two strings, the first specifying what needs to be rewritten in
5162 the path, and the second specifying how it should be rewritten.
5163 In @ref{set substitute-path}, we name these two parts @var{from} and
5164 @var{to} respectively. @value{GDBN} does a simple string replacement
5165 of @var{from} with @var{to} at the start of the directory part of the
5166 source file name, and uses that result instead of the original file
5167 name to look up the sources.
5169 Using the previous example, suppose the @file{foo-1.0} tree has been
5170 moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell
5171 @value{GDBN} to replace @file{/usr/src} in all source path names with
5172 @file{/mnt/cross}. The first lookup will then be
5173 @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location
5174 of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path
5175 substitution rule, use the @code{set substitute-path} command
5176 (@pxref{set substitute-path}).
5178 To avoid unexpected substitution results, a rule is applied only if the
5179 @var{from} part of the directory name ends at a directory separator.
5180 For instance, a rule substituting @file{/usr/source} into
5181 @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but
5182 not to @file{/usr/sourceware/foo-2.0}. And because the substitution
5183 is applied only at the beginning of the directory name, this rule will
5184 not be applied to @file{/root/usr/source/baz.c} either.
5186 In many cases, you can achieve the same result using the @code{directory}
5187 command. However, @code{set substitute-path} can be more efficient in
5188 the case where the sources are organized in a complex tree with multiple
5189 subdirectories. With the @code{directory} command, you need to add each
5190 subdirectory of your project. If you moved the entire tree while
5191 preserving its internal organization, then @code{set substitute-path}
5192 allows you to direct the debugger to all the sources with one single
5195 @code{set substitute-path} is also more than just a shortcut command.
5196 The source path is only used if the file at the original location no
5197 longer exists. On the other hand, @code{set substitute-path} modifies
5198 the debugger behavior to look at the rewritten location instead. So, if
5199 for any reason a source file that is not relevant to your executable is
5200 located at the original location, a substitution rule is the only
5201 method available to point @value{GDBN} at the new location.
5204 @item directory @var{dirname} @dots{}
5205 @item dir @var{dirname} @dots{}
5206 Add directory @var{dirname} to the front of the source path. Several
5207 directory names may be given to this command, separated by @samp{:}
5208 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
5209 part of absolute file names) or
5210 whitespace. You may specify a directory that is already in the source
5211 path; this moves it forward, so @value{GDBN} searches it sooner.
5215 @vindex $cdir@r{, convenience variable}
5216 @vindex $cwd@r{, convenience variable}
5217 @cindex compilation directory
5218 @cindex current directory
5219 @cindex working directory
5220 @cindex directory, current
5221 @cindex directory, compilation
5222 You can use the string @samp{$cdir} to refer to the compilation
5223 directory (if one is recorded), and @samp{$cwd} to refer to the current
5224 working directory. @samp{$cwd} is not the same as @samp{.}---the former
5225 tracks the current working directory as it changes during your @value{GDBN}
5226 session, while the latter is immediately expanded to the current
5227 directory at the time you add an entry to the source path.
5230 Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation.
5232 @c RET-repeat for @code{directory} is explicitly disabled, but since
5233 @c repeating it would be a no-op we do not say that. (thanks to RMS)
5235 @item show directories
5236 @kindex show directories
5237 Print the source path: show which directories it contains.
5239 @anchor{set substitute-path}
5240 @item set substitute-path @var{from} @var{to}
5241 @kindex set substitute-path
5242 Define a source path substitution rule, and add it at the end of the
5243 current list of existing substitution rules. If a rule with the same
5244 @var{from} was already defined, then the old rule is also deleted.
5246 For example, if the file @file{/foo/bar/baz.c} was moved to
5247 @file{/mnt/cross/baz.c}, then the command
5250 (@value{GDBP}) set substitute-path /usr/src /mnt/cross
5254 will tell @value{GDBN} to replace @samp{/usr/src} with
5255 @samp{/mnt/cross}, which will allow @value{GDBN} to find the file
5256 @file{baz.c} even though it was moved.
5258 In the case when more than one substitution rule have been defined,
5259 the rules are evaluated one by one in the order where they have been
5260 defined. The first one matching, if any, is selected to perform
5263 For instance, if we had entered the following commands:
5266 (@value{GDBP}) set substitute-path /usr/src/include /mnt/include
5267 (@value{GDBP}) set substitute-path /usr/src /mnt/src
5271 @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into
5272 @file{/mnt/include/defs.h} by using the first rule. However, it would
5273 use the second rule to rewrite @file{/usr/src/lib/foo.c} into
5274 @file{/mnt/src/lib/foo.c}.
5277 @item unset substitute-path [path]
5278 @kindex unset substitute-path
5279 If a path is specified, search the current list of substitution rules
5280 for a rule that would rewrite that path. Delete that rule if found.
5281 A warning is emitted by the debugger if no rule could be found.
5283 If no path is specified, then all substitution rules are deleted.
5285 @item show substitute-path [path]
5286 @kindex show substitute-path
5287 If a path is specified, then print the source path substitution rule
5288 which would rewrite that path, if any.
5290 If no path is specified, then print all existing source path substitution
5295 If your source path is cluttered with directories that are no longer of
5296 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
5297 versions of source. You can correct the situation as follows:
5301 Use @code{directory} with no argument to reset the source path to its default value.
5304 Use @code{directory} with suitable arguments to reinstall the
5305 directories you want in the source path. You can add all the
5306 directories in one command.
5310 @section Source and Machine Code
5311 @cindex source line and its code address
5313 You can use the command @code{info line} to map source lines to program
5314 addresses (and vice versa), and the command @code{disassemble} to display
5315 a range of addresses as machine instructions. When run under @sc{gnu} Emacs
5316 mode, the @code{info line} command causes the arrow to point to the
5317 line specified. Also, @code{info line} prints addresses in symbolic form as
5322 @item info line @var{linespec}
5323 Print the starting and ending addresses of the compiled code for
5324 source line @var{linespec}. You can specify source lines in any of
5325 the ways understood by the @code{list} command (@pxref{List, ,Printing
5329 For example, we can use @code{info line} to discover the location of
5330 the object code for the first line of function
5331 @code{m4_changequote}:
5333 @c FIXME: I think this example should also show the addresses in
5334 @c symbolic form, as they usually would be displayed.
5336 (@value{GDBP}) info line m4_changequote
5337 Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
5341 @cindex code address and its source line
5342 We can also inquire (using @code{*@var{addr}} as the form for
5343 @var{linespec}) what source line covers a particular address:
5345 (@value{GDBP}) info line *0x63ff
5346 Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
5349 @cindex @code{$_} and @code{info line}
5350 @cindex @code{x} command, default address
5351 @kindex x@r{(examine), and} info line
5352 After @code{info line}, the default address for the @code{x} command
5353 is changed to the starting address of the line, so that @samp{x/i} is
5354 sufficient to begin examining the machine code (@pxref{Memory,
5355 ,Examining Memory}). Also, this address is saved as the value of the
5356 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
5361 @cindex assembly instructions
5362 @cindex instructions, assembly
5363 @cindex machine instructions
5364 @cindex listing machine instructions
5366 This specialized command dumps a range of memory as machine
5367 instructions. The default memory range is the function surrounding the
5368 program counter of the selected frame. A single argument to this
5369 command is a program counter value; @value{GDBN} dumps the function
5370 surrounding this value. Two arguments specify a range of addresses
5371 (first inclusive, second exclusive) to dump.
5374 The following example shows the disassembly of a range of addresses of
5375 HP PA-RISC 2.0 code:
5378 (@value{GDBP}) disas 0x32c4 0x32e4
5379 Dump of assembler code from 0x32c4 to 0x32e4:
5380 0x32c4 <main+204>: addil 0,dp
5381 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26
5382 0x32cc <main+212>: ldil 0x3000,r31
5383 0x32d0 <main+216>: ble 0x3f8(sr4,r31)
5384 0x32d4 <main+220>: ldo 0(r31),rp
5385 0x32d8 <main+224>: addil -0x800,dp
5386 0x32dc <main+228>: ldo 0x588(r1),r26
5387 0x32e0 <main+232>: ldil 0x3000,r31
5388 End of assembler dump.
5391 Some architectures have more than one commonly-used set of instruction
5392 mnemonics or other syntax.
5394 For programs that were dynamically linked and use shared libraries,
5395 instructions that call functions or branch to locations in the shared
5396 libraries might show a seemingly bogus location---it's actually a
5397 location of the relocation table. On some architectures, @value{GDBN}
5398 might be able to resolve these to actual function names.
5401 @kindex set disassembly-flavor
5402 @cindex Intel disassembly flavor
5403 @cindex AT&T disassembly flavor
5404 @item set disassembly-flavor @var{instruction-set}
5405 Select the instruction set to use when disassembling the
5406 program via the @code{disassemble} or @code{x/i} commands.
5408 Currently this command is only defined for the Intel x86 family. You
5409 can set @var{instruction-set} to either @code{intel} or @code{att}.
5410 The default is @code{att}, the AT&T flavor used by default by Unix
5411 assemblers for x86-based targets.
5413 @kindex show disassembly-flavor
5414 @item show disassembly-flavor
5415 Show the current setting of the disassembly flavor.
5420 @chapter Examining Data
5422 @cindex printing data
5423 @cindex examining data
5426 @c "inspect" is not quite a synonym if you are using Epoch, which we do not
5427 @c document because it is nonstandard... Under Epoch it displays in a
5428 @c different window or something like that.
5429 The usual way to examine data in your program is with the @code{print}
5430 command (abbreviated @code{p}), or its synonym @code{inspect}. It
5431 evaluates and prints the value of an expression of the language your
5432 program is written in (@pxref{Languages, ,Using @value{GDBN} with
5433 Different Languages}).
5436 @item print @var{expr}
5437 @itemx print /@var{f} @var{expr}
5438 @var{expr} is an expression (in the source language). By default the
5439 value of @var{expr} is printed in a format appropriate to its data type;
5440 you can choose a different format by specifying @samp{/@var{f}}, where
5441 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
5445 @itemx print /@var{f}
5446 @cindex reprint the last value
5447 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
5448 @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to
5449 conveniently inspect the same value in an alternative format.
5452 A more low-level way of examining data is with the @code{x} command.
5453 It examines data in memory at a specified address and prints it in a
5454 specified format. @xref{Memory, ,Examining Memory}.
5456 If you are interested in information about types, or about how the
5457 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
5458 command rather than @code{print}. @xref{Symbols, ,Examining the Symbol
5462 * Expressions:: Expressions
5463 * Variables:: Program variables
5464 * Arrays:: Artificial arrays
5465 * Output Formats:: Output formats
5466 * Memory:: Examining memory
5467 * Auto Display:: Automatic display
5468 * Print Settings:: Print settings
5469 * Value History:: Value history
5470 * Convenience Vars:: Convenience variables
5471 * Registers:: Registers
5472 * Floating Point Hardware:: Floating point hardware
5473 * Vector Unit:: Vector Unit
5474 * OS Information:: Auxiliary data provided by operating system
5475 * Memory Region Attributes:: Memory region attributes
5476 * Dump/Restore Files:: Copy between memory and a file
5477 * Core File Generation:: Cause a program dump its core
5478 * Character Sets:: Debugging programs that use a different
5479 character set than GDB does
5480 * Caching Remote Data:: Data caching for remote targets
5484 @section Expressions
5487 @code{print} and many other @value{GDBN} commands accept an expression and
5488 compute its value. Any kind of constant, variable or operator defined
5489 by the programming language you are using is valid in an expression in
5490 @value{GDBN}. This includes conditional expressions, function calls,
5491 casts, and string constants. It also includes preprocessor macros, if
5492 you compiled your program to include this information; see
5495 @cindex arrays in expressions
5496 @value{GDBN} supports array constants in expressions input by
5497 the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example,
5498 you can use the command @code{print @{1, 2, 3@}} to build up an array in
5499 memory that is @code{malloc}ed in the target program.
5501 Because C is so widespread, most of the expressions shown in examples in
5502 this manual are in C. @xref{Languages, , Using @value{GDBN} with Different
5503 Languages}, for information on how to use expressions in other
5506 In this section, we discuss operators that you can use in @value{GDBN}
5507 expressions regardless of your programming language.
5509 @cindex casts, in expressions
5510 Casts are supported in all languages, not just in C, because it is so
5511 useful to cast a number into a pointer in order to examine a structure
5512 at that address in memory.
5513 @c FIXME: casts supported---Mod2 true?
5515 @value{GDBN} supports these operators, in addition to those common
5516 to programming languages:
5520 @samp{@@} is a binary operator for treating parts of memory as arrays.
5521 @xref{Arrays, ,Artificial Arrays}, for more information.
5524 @samp{::} allows you to specify a variable in terms of the file or
5525 function where it is defined. @xref{Variables, ,Program Variables}.
5527 @cindex @{@var{type}@}
5528 @cindex type casting memory
5529 @cindex memory, viewing as typed object
5530 @cindex casts, to view memory
5531 @item @{@var{type}@} @var{addr}
5532 Refers to an object of type @var{type} stored at address @var{addr} in
5533 memory. @var{addr} may be any expression whose value is an integer or
5534 pointer (but parentheses are required around binary operators, just as in
5535 a cast). This construct is allowed regardless of what kind of data is
5536 normally supposed to reside at @var{addr}.
5540 @section Program Variables
5542 The most common kind of expression to use is the name of a variable
5545 Variables in expressions are understood in the selected stack frame
5546 (@pxref{Selection, ,Selecting a Frame}); they must be either:
5550 global (or file-static)
5557 visible according to the scope rules of the
5558 programming language from the point of execution in that frame
5561 @noindent This means that in the function
5576 you can examine and use the variable @code{a} whenever your program is
5577 executing within the function @code{foo}, but you can only use or
5578 examine the variable @code{b} while your program is executing inside
5579 the block where @code{b} is declared.
5581 @cindex variable name conflict
5582 There is an exception: you can refer to a variable or function whose
5583 scope is a single source file even if the current execution point is not
5584 in this file. But it is possible to have more than one such variable or
5585 function with the same name (in different source files). If that
5586 happens, referring to that name has unpredictable effects. If you wish,
5587 you can specify a static variable in a particular function or file,
5588 using the colon-colon (@code{::}) notation:
5590 @cindex colon-colon, context for variables/functions
5592 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
5593 @cindex @code{::}, context for variables/functions
5596 @var{file}::@var{variable}
5597 @var{function}::@var{variable}
5601 Here @var{file} or @var{function} is the name of the context for the
5602 static @var{variable}. In the case of file names, you can use quotes to
5603 make sure @value{GDBN} parses the file name as a single word---for example,
5604 to print a global value of @code{x} defined in @file{f2.c}:
5607 (@value{GDBP}) p 'f2.c'::x
5610 @cindex C@t{++} scope resolution
5611 This use of @samp{::} is very rarely in conflict with the very similar
5612 use of the same notation in C@t{++}. @value{GDBN} also supports use of the C@t{++}
5613 scope resolution operator in @value{GDBN} expressions.
5614 @c FIXME: Um, so what happens in one of those rare cases where it's in
5617 @cindex wrong values
5618 @cindex variable values, wrong
5619 @cindex function entry/exit, wrong values of variables
5620 @cindex optimized code, wrong values of variables
5622 @emph{Warning:} Occasionally, a local variable may appear to have the
5623 wrong value at certain points in a function---just after entry to a new
5624 scope, and just before exit.
5626 You may see this problem when you are stepping by machine instructions.
5627 This is because, on most machines, it takes more than one instruction to
5628 set up a stack frame (including local variable definitions); if you are
5629 stepping by machine instructions, variables may appear to have the wrong
5630 values until the stack frame is completely built. On exit, it usually
5631 also takes more than one machine instruction to destroy a stack frame;
5632 after you begin stepping through that group of instructions, local
5633 variable definitions may be gone.
5635 This may also happen when the compiler does significant optimizations.
5636 To be sure of always seeing accurate values, turn off all optimization
5639 @cindex ``No symbol "foo" in current context''
5640 Another possible effect of compiler optimizations is to optimize
5641 unused variables out of existence, or assign variables to registers (as
5642 opposed to memory addresses). Depending on the support for such cases
5643 offered by the debug info format used by the compiler, @value{GDBN}
5644 might not be able to display values for such local variables. If that
5645 happens, @value{GDBN} will print a message like this:
5648 No symbol "foo" in current context.
5651 To solve such problems, either recompile without optimizations, or use a
5652 different debug info format, if the compiler supports several such
5653 formats. For example, @value{NGCC}, the @sc{gnu} C/C@t{++} compiler,
5654 usually supports the @option{-gstabs+} option. @option{-gstabs+}
5655 produces debug info in a format that is superior to formats such as
5656 COFF. You may be able to use DWARF 2 (@option{-gdwarf-2}), which is also
5657 an effective form for debug info. @xref{Debugging Options,,Options
5658 for Debugging Your Program or GCC, gcc.info, Using the @sc{gnu}
5659 Compiler Collection (GCC)}.
5660 @xref{C, ,C and C@t{++}}, for more information about debug info formats
5661 that are best suited to C@t{++} programs.
5663 If you ask to print an object whose contents are unknown to
5664 @value{GDBN}, e.g., because its data type is not completely specified
5665 by the debug information, @value{GDBN} will say @samp{<incomplete
5666 type>}. @xref{Symbols, incomplete type}, for more about this.
5668 Strings are identified as arrays of @code{char} values without specified
5669 signedness. Arrays of either @code{signed char} or @code{unsigned char} get
5670 printed as arrays of 1 byte sized integers. @code{-fsigned-char} or
5671 @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
5672 defines literal string type @code{"char"} as @code{char} without a sign.
5677 signed char var1[] = "A";
5680 You get during debugging
5685 $2 = @{65 'A', 0 '\0'@}
5689 @section Artificial Arrays
5691 @cindex artificial array
5693 @kindex @@@r{, referencing memory as an array}
5694 It is often useful to print out several successive objects of the
5695 same type in memory; a section of an array, or an array of
5696 dynamically determined size for which only a pointer exists in the
5699 You can do this by referring to a contiguous span of memory as an
5700 @dfn{artificial array}, using the binary operator @samp{@@}. The left
5701 operand of @samp{@@} should be the first element of the desired array
5702 and be an individual object. The right operand should be the desired length
5703 of the array. The result is an array value whose elements are all of
5704 the type of the left argument. The first element is actually the left
5705 argument; the second element comes from bytes of memory immediately
5706 following those that hold the first element, and so on. Here is an
5707 example. If a program says
5710 int *array = (int *) malloc (len * sizeof (int));
5714 you can print the contents of @code{array} with
5720 The left operand of @samp{@@} must reside in memory. Array values made
5721 with @samp{@@} in this way behave just like other arrays in terms of
5722 subscripting, and are coerced to pointers when used in expressions.
5723 Artificial arrays most often appear in expressions via the value history
5724 (@pxref{Value History, ,Value History}), after printing one out.
5726 Another way to create an artificial array is to use a cast.
5727 This re-interprets a value as if it were an array.
5728 The value need not be in memory:
5730 (@value{GDBP}) p/x (short[2])0x12345678
5731 $1 = @{0x1234, 0x5678@}
5734 As a convenience, if you leave the array length out (as in
5735 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
5736 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
5738 (@value{GDBP}) p/x (short[])0x12345678
5739 $2 = @{0x1234, 0x5678@}
5742 Sometimes the artificial array mechanism is not quite enough; in
5743 moderately complex data structures, the elements of interest may not
5744 actually be adjacent---for example, if you are interested in the values
5745 of pointers in an array. One useful work-around in this situation is
5746 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
5747 Variables}) as a counter in an expression that prints the first
5748 interesting value, and then repeat that expression via @key{RET}. For
5749 instance, suppose you have an array @code{dtab} of pointers to
5750 structures, and you are interested in the values of a field @code{fv}
5751 in each structure. Here is an example of what you might type:
5761 @node Output Formats
5762 @section Output Formats
5764 @cindex formatted output
5765 @cindex output formats
5766 By default, @value{GDBN} prints a value according to its data type. Sometimes
5767 this is not what you want. For example, you might want to print a number
5768 in hex, or a pointer in decimal. Or you might want to view data in memory
5769 at a certain address as a character string or as an instruction. To do
5770 these things, specify an @dfn{output format} when you print a value.
5772 The simplest use of output formats is to say how to print a value
5773 already computed. This is done by starting the arguments of the
5774 @code{print} command with a slash and a format letter. The format
5775 letters supported are:
5779 Regard the bits of the value as an integer, and print the integer in
5783 Print as integer in signed decimal.
5786 Print as integer in unsigned decimal.
5789 Print as integer in octal.
5792 Print as integer in binary. The letter @samp{t} stands for ``two''.
5793 @footnote{@samp{b} cannot be used because these format letters are also
5794 used with the @code{x} command, where @samp{b} stands for ``byte'';
5795 see @ref{Memory,,Examining Memory}.}
5798 @cindex unknown address, locating
5799 @cindex locate address
5800 Print as an address, both absolute in hexadecimal and as an offset from
5801 the nearest preceding symbol. You can use this format used to discover
5802 where (in what function) an unknown address is located:
5805 (@value{GDBP}) p/a 0x54320
5806 $3 = 0x54320 <_initialize_vx+396>
5810 The command @code{info symbol 0x54320} yields similar results.
5811 @xref{Symbols, info symbol}.
5814 Regard as an integer and print it as a character constant. This
5815 prints both the numerical value and its character representation. The
5816 character representation is replaced with the octal escape @samp{\nnn}
5817 for characters outside the 7-bit @sc{ascii} range.
5819 Without this format, @value{GDBN} displays @code{char},
5820 @w{@code{unsigned char}}, and @w{@code{signed char}} data as character
5821 constants. Single-byte members of vectors are displayed as integer
5825 Regard the bits of the value as a floating point number and print
5826 using typical floating point syntax.
5829 @cindex printing strings
5830 @cindex printing byte arrays
5831 Regard as a string, if possible. With this format, pointers to single-byte
5832 data are displayed as null-terminated strings and arrays of single-byte data
5833 are displayed as fixed-length strings. Other values are displayed in their
5836 Without this format, @value{GDBN} displays pointers to and arrays of
5837 @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as
5838 strings. Single-byte members of a vector are displayed as an integer
5842 For example, to print the program counter in hex (@pxref{Registers}), type
5849 Note that no space is required before the slash; this is because command
5850 names in @value{GDBN} cannot contain a slash.
5852 To reprint the last value in the value history with a different format,
5853 you can use the @code{print} command with just a format and no
5854 expression. For example, @samp{p/x} reprints the last value in hex.
5857 @section Examining Memory
5859 You can use the command @code{x} (for ``examine'') to examine memory in
5860 any of several formats, independently of your program's data types.
5862 @cindex examining memory
5864 @kindex x @r{(examine memory)}
5865 @item x/@var{nfu} @var{addr}
5868 Use the @code{x} command to examine memory.
5871 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
5872 much memory to display and how to format it; @var{addr} is an
5873 expression giving the address where you want to start displaying memory.
5874 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
5875 Several commands set convenient defaults for @var{addr}.
5878 @item @var{n}, the repeat count
5879 The repeat count is a decimal integer; the default is 1. It specifies
5880 how much memory (counting by units @var{u}) to display.
5881 @c This really is **decimal**; unaffected by 'set radix' as of GDB
5884 @item @var{f}, the display format
5885 The display format is one of the formats used by @code{print}
5886 (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c},
5887 @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions).
5888 The default is @samp{x} (hexadecimal) initially. The default changes
5889 each time you use either @code{x} or @code{print}.
5891 @item @var{u}, the unit size
5892 The unit size is any of
5898 Halfwords (two bytes).
5900 Words (four bytes). This is the initial default.
5902 Giant words (eight bytes).
5905 Each time you specify a unit size with @code{x}, that size becomes the
5906 default unit the next time you use @code{x}. (For the @samp{s} and
5907 @samp{i} formats, the unit size is ignored and is normally not written.)
5909 @item @var{addr}, starting display address
5910 @var{addr} is the address where you want @value{GDBN} to begin displaying
5911 memory. The expression need not have a pointer value (though it may);
5912 it is always interpreted as an integer address of a byte of memory.
5913 @xref{Expressions, ,Expressions}, for more information on expressions. The default for
5914 @var{addr} is usually just after the last address examined---but several
5915 other commands also set the default address: @code{info breakpoints} (to
5916 the address of the last breakpoint listed), @code{info line} (to the
5917 starting address of a line), and @code{print} (if you use it to display
5918 a value from memory).
5921 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
5922 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
5923 starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four
5924 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
5925 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
5927 Since the letters indicating unit sizes are all distinct from the
5928 letters specifying output formats, you do not have to remember whether
5929 unit size or format comes first; either order works. The output
5930 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
5931 (However, the count @var{n} must come first; @samp{wx4} does not work.)
5933 Even though the unit size @var{u} is ignored for the formats @samp{s}
5934 and @samp{i}, you might still want to use a count @var{n}; for example,
5935 @samp{3i} specifies that you want to see three machine instructions,
5936 including any operands. For convenience, especially when used with
5937 the @code{display} command, the @samp{i} format also prints branch delay
5938 slot instructions, if any, beyond the count specified, which immediately
5939 follow the last instruction that is within the count. The command
5940 @code{disassemble} gives an alternative way of inspecting machine
5941 instructions; see @ref{Machine Code,,Source and Machine Code}.
5943 All the defaults for the arguments to @code{x} are designed to make it
5944 easy to continue scanning memory with minimal specifications each time
5945 you use @code{x}. For example, after you have inspected three machine
5946 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
5947 with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command,
5948 the repeat count @var{n} is used again; the other arguments default as
5949 for successive uses of @code{x}.
5951 @cindex @code{$_}, @code{$__}, and value history
5952 The addresses and contents printed by the @code{x} command are not saved
5953 in the value history because there is often too much of them and they
5954 would get in the way. Instead, @value{GDBN} makes these values available for
5955 subsequent use in expressions as values of the convenience variables
5956 @code{$_} and @code{$__}. After an @code{x} command, the last address
5957 examined is available for use in expressions in the convenience variable
5958 @code{$_}. The contents of that address, as examined, are available in
5959 the convenience variable @code{$__}.
5961 If the @code{x} command has a repeat count, the address and contents saved
5962 are from the last memory unit printed; this is not the same as the last
5963 address printed if several units were printed on the last line of output.
5965 @cindex remote memory comparison
5966 @cindex verify remote memory image
5967 When you are debugging a program running on a remote target machine
5968 (@pxref{Remote Debugging}), you may wish to verify the program's image in the
5969 remote machine's memory against the executable file you downloaded to
5970 the target. The @code{compare-sections} command is provided for such
5974 @kindex compare-sections
5975 @item compare-sections @r{[}@var{section-name}@r{]}
5976 Compare the data of a loadable section @var{section-name} in the
5977 executable file of the program being debugged with the same section in
5978 the remote machine's memory, and report any mismatches. With no
5979 arguments, compares all loadable sections. This command's
5980 availability depends on the target's support for the @code{"qCRC"}
5985 @section Automatic Display
5986 @cindex automatic display
5987 @cindex display of expressions
5989 If you find that you want to print the value of an expression frequently
5990 (to see how it changes), you might want to add it to the @dfn{automatic
5991 display list} so that @value{GDBN} prints its value each time your program stops.
5992 Each expression added to the list is given a number to identify it;
5993 to remove an expression from the list, you specify that number.
5994 The automatic display looks like this:
5998 3: bar[5] = (struct hack *) 0x3804
6002 This display shows item numbers, expressions and their current values. As with
6003 displays you request manually using @code{x} or @code{print}, you can
6004 specify the output format you prefer; in fact, @code{display} decides
6005 whether to use @code{print} or @code{x} depending your format
6006 specification---it uses @code{x} if you specify either the @samp{i}
6007 or @samp{s} format, or a unit size; otherwise it uses @code{print}.
6011 @item display @var{expr}
6012 Add the expression @var{expr} to the list of expressions to display
6013 each time your program stops. @xref{Expressions, ,Expressions}.
6015 @code{display} does not repeat if you press @key{RET} again after using it.
6017 @item display/@var{fmt} @var{expr}
6018 For @var{fmt} specifying only a display format and not a size or
6019 count, add the expression @var{expr} to the auto-display list but
6020 arrange to display it each time in the specified format @var{fmt}.
6021 @xref{Output Formats,,Output Formats}.
6023 @item display/@var{fmt} @var{addr}
6024 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
6025 number of units, add the expression @var{addr} as a memory address to
6026 be examined each time your program stops. Examining means in effect
6027 doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}.
6030 For example, @samp{display/i $pc} can be helpful, to see the machine
6031 instruction about to be executed each time execution stops (@samp{$pc}
6032 is a common name for the program counter; @pxref{Registers, ,Registers}).
6035 @kindex delete display
6037 @item undisplay @var{dnums}@dots{}
6038 @itemx delete display @var{dnums}@dots{}
6039 Remove item numbers @var{dnums} from the list of expressions to display.
6041 @code{undisplay} does not repeat if you press @key{RET} after using it.
6042 (Otherwise you would just get the error @samp{No display number @dots{}}.)
6044 @kindex disable display
6045 @item disable display @var{dnums}@dots{}
6046 Disable the display of item numbers @var{dnums}. A disabled display
6047 item is not printed automatically, but is not forgotten. It may be
6048 enabled again later.
6050 @kindex enable display
6051 @item enable display @var{dnums}@dots{}
6052 Enable display of item numbers @var{dnums}. It becomes effective once
6053 again in auto display of its expression, until you specify otherwise.
6056 Display the current values of the expressions on the list, just as is
6057 done when your program stops.
6059 @kindex info display
6061 Print the list of expressions previously set up to display
6062 automatically, each one with its item number, but without showing the
6063 values. This includes disabled expressions, which are marked as such.
6064 It also includes expressions which would not be displayed right now
6065 because they refer to automatic variables not currently available.
6068 @cindex display disabled out of scope
6069 If a display expression refers to local variables, then it does not make
6070 sense outside the lexical context for which it was set up. Such an
6071 expression is disabled when execution enters a context where one of its
6072 variables is not defined. For example, if you give the command
6073 @code{display last_char} while inside a function with an argument
6074 @code{last_char}, @value{GDBN} displays this argument while your program
6075 continues to stop inside that function. When it stops elsewhere---where
6076 there is no variable @code{last_char}---the display is disabled
6077 automatically. The next time your program stops where @code{last_char}
6078 is meaningful, you can enable the display expression once again.
6080 @node Print Settings
6081 @section Print Settings
6083 @cindex format options
6084 @cindex print settings
6085 @value{GDBN} provides the following ways to control how arrays, structures,
6086 and symbols are printed.
6089 These settings are useful for debugging programs in any language:
6093 @item set print address
6094 @itemx set print address on
6095 @cindex print/don't print memory addresses
6096 @value{GDBN} prints memory addresses showing the location of stack
6097 traces, structure values, pointer values, breakpoints, and so forth,
6098 even when it also displays the contents of those addresses. The default
6099 is @code{on}. For example, this is what a stack frame display looks like with
6100 @code{set print address on}:
6105 #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
6107 530 if (lquote != def_lquote)
6111 @item set print address off
6112 Do not print addresses when displaying their contents. For example,
6113 this is the same stack frame displayed with @code{set print address off}:
6117 (@value{GDBP}) set print addr off
6119 #0 set_quotes (lq="<<", rq=">>") at input.c:530
6120 530 if (lquote != def_lquote)
6124 You can use @samp{set print address off} to eliminate all machine
6125 dependent displays from the @value{GDBN} interface. For example, with
6126 @code{print address off}, you should get the same text for backtraces on
6127 all machines---whether or not they involve pointer arguments.
6130 @item show print address
6131 Show whether or not addresses are to be printed.
6134 When @value{GDBN} prints a symbolic address, it normally prints the
6135 closest earlier symbol plus an offset. If that symbol does not uniquely
6136 identify the address (for example, it is a name whose scope is a single
6137 source file), you may need to clarify. One way to do this is with
6138 @code{info line}, for example @samp{info line *0x4537}. Alternately,
6139 you can set @value{GDBN} to print the source file and line number when
6140 it prints a symbolic address:
6143 @item set print symbol-filename on
6144 @cindex source file and line of a symbol
6145 @cindex symbol, source file and line
6146 Tell @value{GDBN} to print the source file name and line number of a
6147 symbol in the symbolic form of an address.
6149 @item set print symbol-filename off
6150 Do not print source file name and line number of a symbol. This is the
6153 @item show print symbol-filename
6154 Show whether or not @value{GDBN} will print the source file name and
6155 line number of a symbol in the symbolic form of an address.
6158 Another situation where it is helpful to show symbol filenames and line
6159 numbers is when disassembling code; @value{GDBN} shows you the line
6160 number and source file that corresponds to each instruction.
6162 Also, you may wish to see the symbolic form only if the address being
6163 printed is reasonably close to the closest earlier symbol:
6166 @item set print max-symbolic-offset @var{max-offset}
6167 @cindex maximum value for offset of closest symbol
6168 Tell @value{GDBN} to only display the symbolic form of an address if the
6169 offset between the closest earlier symbol and the address is less than
6170 @var{max-offset}. The default is 0, which tells @value{GDBN}
6171 to always print the symbolic form of an address if any symbol precedes it.
6173 @item show print max-symbolic-offset
6174 Ask how large the maximum offset is that @value{GDBN} prints in a
6178 @cindex wild pointer, interpreting
6179 @cindex pointer, finding referent
6180 If you have a pointer and you are not sure where it points, try
6181 @samp{set print symbol-filename on}. Then you can determine the name
6182 and source file location of the variable where it points, using
6183 @samp{p/a @var{pointer}}. This interprets the address in symbolic form.
6184 For example, here @value{GDBN} shows that a variable @code{ptt} points
6185 at another variable @code{t}, defined in @file{hi2.c}:
6188 (@value{GDBP}) set print symbol-filename on
6189 (@value{GDBP}) p/a ptt
6190 $4 = 0xe008 <t in hi2.c>
6194 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
6195 does not show the symbol name and filename of the referent, even with
6196 the appropriate @code{set print} options turned on.
6199 Other settings control how different kinds of objects are printed:
6202 @item set print array
6203 @itemx set print array on
6204 @cindex pretty print arrays
6205 Pretty print arrays. This format is more convenient to read,
6206 but uses more space. The default is off.
6208 @item set print array off
6209 Return to compressed format for arrays.
6211 @item show print array
6212 Show whether compressed or pretty format is selected for displaying
6215 @cindex print array indexes
6216 @item set print array-indexes
6217 @itemx set print array-indexes on
6218 Print the index of each element when displaying arrays. May be more
6219 convenient to locate a given element in the array or quickly find the
6220 index of a given element in that printed array. The default is off.
6222 @item set print array-indexes off
6223 Stop printing element indexes when displaying arrays.
6225 @item show print array-indexes
6226 Show whether the index of each element is printed when displaying
6229 @item set print elements @var{number-of-elements}
6230 @cindex number of array elements to print
6231 @cindex limit on number of printed array elements
6232 Set a limit on how many elements of an array @value{GDBN} will print.
6233 If @value{GDBN} is printing a large array, it stops printing after it has
6234 printed the number of elements set by the @code{set print elements} command.
6235 This limit also applies to the display of strings.
6236 When @value{GDBN} starts, this limit is set to 200.
6237 Setting @var{number-of-elements} to zero means that the printing is unlimited.
6239 @item show print elements
6240 Display the number of elements of a large array that @value{GDBN} will print.
6241 If the number is 0, then the printing is unlimited.
6243 @item set print frame-arguments @var{value}
6244 @cindex printing frame argument values
6245 @cindex print all frame argument values
6246 @cindex print frame argument values for scalars only
6247 @cindex do not print frame argument values
6248 This command allows to control how the values of arguments are printed
6249 when the debugger prints a frame (@pxref{Frames}). The possible
6254 The values of all arguments are printed. This is the default.
6257 Print the value of an argument only if it is a scalar. The value of more
6258 complex arguments such as arrays, structures, unions, etc, is replaced
6259 by @code{@dots{}}. Here is an example where only scalar arguments are shown:
6262 #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green)
6267 None of the argument values are printed. Instead, the value of each argument
6268 is replaced by @code{@dots{}}. In this case, the example above now becomes:
6271 #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{})
6276 By default, all argument values are always printed. But this command
6277 can be useful in several cases. For instance, it can be used to reduce
6278 the amount of information printed in each frame, making the backtrace
6279 more readable. Also, this command can be used to improve performance
6280 when displaying Ada frames, because the computation of large arguments
6281 can sometimes be CPU-intensive, especiallly in large applications.
6282 Setting @code{print frame-arguments} to @code{scalars} or @code{none}
6283 avoids this computation, thus speeding up the display of each Ada frame.
6285 @item show print frame-arguments
6286 Show how the value of arguments should be displayed when printing a frame.
6288 @item set print repeats
6289 @cindex repeated array elements
6290 Set the threshold for suppressing display of repeated array
6291 elements. When the number of consecutive identical elements of an
6292 array exceeds the threshold, @value{GDBN} prints the string
6293 @code{"<repeats @var{n} times>"}, where @var{n} is the number of
6294 identical repetitions, instead of displaying the identical elements
6295 themselves. Setting the threshold to zero will cause all elements to
6296 be individually printed. The default threshold is 10.
6298 @item show print repeats
6299 Display the current threshold for printing repeated identical
6302 @item set print null-stop
6303 @cindex @sc{null} elements in arrays
6304 Cause @value{GDBN} to stop printing the characters of an array when the first
6305 @sc{null} is encountered. This is useful when large arrays actually
6306 contain only short strings.
6309 @item show print null-stop
6310 Show whether @value{GDBN} stops printing an array on the first
6311 @sc{null} character.
6313 @item set print pretty on
6314 @cindex print structures in indented form
6315 @cindex indentation in structure display
6316 Cause @value{GDBN} to print structures in an indented format with one member
6317 per line, like this:
6332 @item set print pretty off
6333 Cause @value{GDBN} to print structures in a compact format, like this:
6337 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
6338 meat = 0x54 "Pork"@}
6343 This is the default format.
6345 @item show print pretty
6346 Show which format @value{GDBN} is using to print structures.
6348 @item set print sevenbit-strings on
6349 @cindex eight-bit characters in strings
6350 @cindex octal escapes in strings
6351 Print using only seven-bit characters; if this option is set,
6352 @value{GDBN} displays any eight-bit characters (in strings or
6353 character values) using the notation @code{\}@var{nnn}. This setting is
6354 best if you are working in English (@sc{ascii}) and you use the
6355 high-order bit of characters as a marker or ``meta'' bit.
6357 @item set print sevenbit-strings off
6358 Print full eight-bit characters. This allows the use of more
6359 international character sets, and is the default.
6361 @item show print sevenbit-strings
6362 Show whether or not @value{GDBN} is printing only seven-bit characters.
6364 @item set print union on
6365 @cindex unions in structures, printing
6366 Tell @value{GDBN} to print unions which are contained in structures
6367 and other unions. This is the default setting.
6369 @item set print union off
6370 Tell @value{GDBN} not to print unions which are contained in
6371 structures and other unions. @value{GDBN} will print @code{"@{...@}"}
6374 @item show print union
6375 Ask @value{GDBN} whether or not it will print unions which are contained in
6376 structures and other unions.
6378 For example, given the declarations
6381 typedef enum @{Tree, Bug@} Species;
6382 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
6383 typedef enum @{Caterpillar, Cocoon, Butterfly@}
6394 struct thing foo = @{Tree, @{Acorn@}@};
6398 with @code{set print union on} in effect @samp{p foo} would print
6401 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
6405 and with @code{set print union off} in effect it would print
6408 $1 = @{it = Tree, form = @{...@}@}
6412 @code{set print union} affects programs written in C-like languages
6418 These settings are of interest when debugging C@t{++} programs:
6421 @cindex demangling C@t{++} names
6422 @item set print demangle
6423 @itemx set print demangle on
6424 Print C@t{++} names in their source form rather than in the encoded
6425 (``mangled'') form passed to the assembler and linker for type-safe
6426 linkage. The default is on.
6428 @item show print demangle
6429 Show whether C@t{++} names are printed in mangled or demangled form.
6431 @item set print asm-demangle
6432 @itemx set print asm-demangle on
6433 Print C@t{++} names in their source form rather than their mangled form, even
6434 in assembler code printouts such as instruction disassemblies.
6437 @item show print asm-demangle
6438 Show whether C@t{++} names in assembly listings are printed in mangled
6441 @cindex C@t{++} symbol decoding style
6442 @cindex symbol decoding style, C@t{++}
6443 @kindex set demangle-style
6444 @item set demangle-style @var{style}
6445 Choose among several encoding schemes used by different compilers to
6446 represent C@t{++} names. The choices for @var{style} are currently:
6450 Allow @value{GDBN} to choose a decoding style by inspecting your program.
6453 Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm.
6454 This is the default.
6457 Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm.
6460 Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm.
6463 Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}.
6464 @strong{Warning:} this setting alone is not sufficient to allow
6465 debugging @code{cfront}-generated executables. @value{GDBN} would
6466 require further enhancement to permit that.
6469 If you omit @var{style}, you will see a list of possible formats.
6471 @item show demangle-style
6472 Display the encoding style currently in use for decoding C@t{++} symbols.
6474 @item set print object
6475 @itemx set print object on
6476 @cindex derived type of an object, printing
6477 @cindex display derived types
6478 When displaying a pointer to an object, identify the @emph{actual}
6479 (derived) type of the object rather than the @emph{declared} type, using
6480 the virtual function table.
6482 @item set print object off
6483 Display only the declared type of objects, without reference to the
6484 virtual function table. This is the default setting.
6486 @item show print object
6487 Show whether actual, or declared, object types are displayed.
6489 @item set print static-members
6490 @itemx set print static-members on
6491 @cindex static members of C@t{++} objects
6492 Print static members when displaying a C@t{++} object. The default is on.
6494 @item set print static-members off
6495 Do not print static members when displaying a C@t{++} object.
6497 @item show print static-members
6498 Show whether C@t{++} static members are printed or not.
6500 @item set print pascal_static-members
6501 @itemx set print pascal_static-members on
6502 @cindex static members of Pascal objects
6503 @cindex Pascal objects, static members display
6504 Print static members when displaying a Pascal object. The default is on.
6506 @item set print pascal_static-members off
6507 Do not print static members when displaying a Pascal object.
6509 @item show print pascal_static-members
6510 Show whether Pascal static members are printed or not.
6512 @c These don't work with HP ANSI C++ yet.
6513 @item set print vtbl
6514 @itemx set print vtbl on
6515 @cindex pretty print C@t{++} virtual function tables
6516 @cindex virtual functions (C@t{++}) display
6517 @cindex VTBL display
6518 Pretty print C@t{++} virtual function tables. The default is off.
6519 (The @code{vtbl} commands do not work on programs compiled with the HP
6520 ANSI C@t{++} compiler (@code{aCC}).)
6522 @item set print vtbl off
6523 Do not pretty print C@t{++} virtual function tables.
6525 @item show print vtbl
6526 Show whether C@t{++} virtual function tables are pretty printed, or not.
6530 @section Value History
6532 @cindex value history
6533 @cindex history of values printed by @value{GDBN}
6534 Values printed by the @code{print} command are saved in the @value{GDBN}
6535 @dfn{value history}. This allows you to refer to them in other expressions.
6536 Values are kept until the symbol table is re-read or discarded
6537 (for example with the @code{file} or @code{symbol-file} commands).
6538 When the symbol table changes, the value history is discarded,
6539 since the values may contain pointers back to the types defined in the
6544 @cindex history number
6545 The values printed are given @dfn{history numbers} by which you can
6546 refer to them. These are successive integers starting with one.
6547 @code{print} shows you the history number assigned to a value by
6548 printing @samp{$@var{num} = } before the value; here @var{num} is the
6551 To refer to any previous value, use @samp{$} followed by the value's
6552 history number. The way @code{print} labels its output is designed to
6553 remind you of this. Just @code{$} refers to the most recent value in
6554 the history, and @code{$$} refers to the value before that.
6555 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
6556 is the value just prior to @code{$$}, @code{$$1} is equivalent to
6557 @code{$$}, and @code{$$0} is equivalent to @code{$}.
6559 For example, suppose you have just printed a pointer to a structure and
6560 want to see the contents of the structure. It suffices to type
6566 If you have a chain of structures where the component @code{next} points
6567 to the next one, you can print the contents of the next one with this:
6574 You can print successive links in the chain by repeating this
6575 command---which you can do by just typing @key{RET}.
6577 Note that the history records values, not expressions. If the value of
6578 @code{x} is 4 and you type these commands:
6586 then the value recorded in the value history by the @code{print} command
6587 remains 4 even though the value of @code{x} has changed.
6592 Print the last ten values in the value history, with their item numbers.
6593 This is like @samp{p@ $$9} repeated ten times, except that @code{show
6594 values} does not change the history.
6596 @item show values @var{n}
6597 Print ten history values centered on history item number @var{n}.
6600 Print ten history values just after the values last printed. If no more
6601 values are available, @code{show values +} produces no display.
6604 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
6605 same effect as @samp{show values +}.
6607 @node Convenience Vars
6608 @section Convenience Variables
6610 @cindex convenience variables
6611 @cindex user-defined variables
6612 @value{GDBN} provides @dfn{convenience variables} that you can use within
6613 @value{GDBN} to hold on to a value and refer to it later. These variables
6614 exist entirely within @value{GDBN}; they are not part of your program, and
6615 setting a convenience variable has no direct effect on further execution
6616 of your program. That is why you can use them freely.
6618 Convenience variables are prefixed with @samp{$}. Any name preceded by
6619 @samp{$} can be used for a convenience variable, unless it is one of
6620 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
6621 (Value history references, in contrast, are @emph{numbers} preceded
6622 by @samp{$}. @xref{Value History, ,Value History}.)
6624 You can save a value in a convenience variable with an assignment
6625 expression, just as you would set a variable in your program.
6629 set $foo = *object_ptr
6633 would save in @code{$foo} the value contained in the object pointed to by
6636 Using a convenience variable for the first time creates it, but its
6637 value is @code{void} until you assign a new value. You can alter the
6638 value with another assignment at any time.
6640 Convenience variables have no fixed types. You can assign a convenience
6641 variable any type of value, including structures and arrays, even if
6642 that variable already has a value of a different type. The convenience
6643 variable, when used as an expression, has the type of its current value.
6646 @kindex show convenience
6647 @cindex show all user variables
6648 @item show convenience
6649 Print a list of convenience variables used so far, and their values.
6650 Abbreviated @code{show conv}.
6652 @kindex init-if-undefined
6653 @cindex convenience variables, initializing
6654 @item init-if-undefined $@var{variable} = @var{expression}
6655 Set a convenience variable if it has not already been set. This is useful
6656 for user-defined commands that keep some state. It is similar, in concept,
6657 to using local static variables with initializers in C (except that
6658 convenience variables are global). It can also be used to allow users to
6659 override default values used in a command script.
6661 If the variable is already defined then the expression is not evaluated so
6662 any side-effects do not occur.
6665 One of the ways to use a convenience variable is as a counter to be
6666 incremented or a pointer to be advanced. For example, to print
6667 a field from successive elements of an array of structures:
6671 print bar[$i++]->contents
6675 Repeat that command by typing @key{RET}.
6677 Some convenience variables are created automatically by @value{GDBN} and given
6678 values likely to be useful.
6681 @vindex $_@r{, convenience variable}
6683 The variable @code{$_} is automatically set by the @code{x} command to
6684 the last address examined (@pxref{Memory, ,Examining Memory}). Other
6685 commands which provide a default address for @code{x} to examine also
6686 set @code{$_} to that address; these commands include @code{info line}
6687 and @code{info breakpoint}. The type of @code{$_} is @code{void *}
6688 except when set by the @code{x} command, in which case it is a pointer
6689 to the type of @code{$__}.
6691 @vindex $__@r{, convenience variable}
6693 The variable @code{$__} is automatically set by the @code{x} command
6694 to the value found in the last address examined. Its type is chosen
6695 to match the format in which the data was printed.
6698 @vindex $_exitcode@r{, convenience variable}
6699 The variable @code{$_exitcode} is automatically set to the exit code when
6700 the program being debugged terminates.
6703 On HP-UX systems, if you refer to a function or variable name that
6704 begins with a dollar sign, @value{GDBN} searches for a user or system
6705 name first, before it searches for a convenience variable.
6711 You can refer to machine register contents, in expressions, as variables
6712 with names starting with @samp{$}. The names of registers are different
6713 for each machine; use @code{info registers} to see the names used on
6717 @kindex info registers
6718 @item info registers
6719 Print the names and values of all registers except floating-point
6720 and vector registers (in the selected stack frame).
6722 @kindex info all-registers
6723 @cindex floating point registers
6724 @item info all-registers
6725 Print the names and values of all registers, including floating-point
6726 and vector registers (in the selected stack frame).
6728 @item info registers @var{regname} @dots{}
6729 Print the @dfn{relativized} value of each specified register @var{regname}.
6730 As discussed in detail below, register values are normally relative to
6731 the selected stack frame. @var{regname} may be any register name valid on
6732 the machine you are using, with or without the initial @samp{$}.
6735 @cindex stack pointer register
6736 @cindex program counter register
6737 @cindex process status register
6738 @cindex frame pointer register
6739 @cindex standard registers
6740 @value{GDBN} has four ``standard'' register names that are available (in
6741 expressions) on most machines---whenever they do not conflict with an
6742 architecture's canonical mnemonics for registers. The register names
6743 @code{$pc} and @code{$sp} are used for the program counter register and
6744 the stack pointer. @code{$fp} is used for a register that contains a
6745 pointer to the current stack frame, and @code{$ps} is used for a
6746 register that contains the processor status. For example,
6747 you could print the program counter in hex with
6754 or print the instruction to be executed next with
6761 or add four to the stack pointer@footnote{This is a way of removing
6762 one word from the stack, on machines where stacks grow downward in
6763 memory (most machines, nowadays). This assumes that the innermost
6764 stack frame is selected; setting @code{$sp} is not allowed when other
6765 stack frames are selected. To pop entire frames off the stack,
6766 regardless of machine architecture, use @code{return};
6767 see @ref{Returning, ,Returning from a Function}.} with
6773 Whenever possible, these four standard register names are available on
6774 your machine even though the machine has different canonical mnemonics,
6775 so long as there is no conflict. The @code{info registers} command
6776 shows the canonical names. For example, on the SPARC, @code{info
6777 registers} displays the processor status register as @code{$psr} but you
6778 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
6779 is an alias for the @sc{eflags} register.
6781 @value{GDBN} always considers the contents of an ordinary register as an
6782 integer when the register is examined in this way. Some machines have
6783 special registers which can hold nothing but floating point; these
6784 registers are considered to have floating point values. There is no way
6785 to refer to the contents of an ordinary register as floating point value
6786 (although you can @emph{print} it as a floating point value with
6787 @samp{print/f $@var{regname}}).
6789 Some registers have distinct ``raw'' and ``virtual'' data formats. This
6790 means that the data format in which the register contents are saved by
6791 the operating system is not the same one that your program normally
6792 sees. For example, the registers of the 68881 floating point
6793 coprocessor are always saved in ``extended'' (raw) format, but all C
6794 programs expect to work with ``double'' (virtual) format. In such
6795 cases, @value{GDBN} normally works with the virtual format only (the format
6796 that makes sense for your program), but the @code{info registers} command
6797 prints the data in both formats.
6799 @cindex SSE registers (x86)
6800 @cindex MMX registers (x86)
6801 Some machines have special registers whose contents can be interpreted
6802 in several different ways. For example, modern x86-based machines
6803 have SSE and MMX registers that can hold several values packed
6804 together in several different formats. @value{GDBN} refers to such
6805 registers in @code{struct} notation:
6808 (@value{GDBP}) print $xmm1
6810 v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@},
6811 v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@},
6812 v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000",
6813 v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@},
6814 v4_int32 = @{0, 20657912, 11, 13@},
6815 v2_int64 = @{88725056443645952, 55834574859@},
6816 uint128 = 0x0000000d0000000b013b36f800000000
6821 To set values of such registers, you need to tell @value{GDBN} which
6822 view of the register you wish to change, as if you were assigning
6823 value to a @code{struct} member:
6826 (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF
6829 Normally, register values are relative to the selected stack frame
6830 (@pxref{Selection, ,Selecting a Frame}). This means that you get the
6831 value that the register would contain if all stack frames farther in
6832 were exited and their saved registers restored. In order to see the
6833 true contents of hardware registers, you must select the innermost
6834 frame (with @samp{frame 0}).
6836 However, @value{GDBN} must deduce where registers are saved, from the machine
6837 code generated by your compiler. If some registers are not saved, or if
6838 @value{GDBN} is unable to locate the saved registers, the selected stack
6839 frame makes no difference.
6841 @node Floating Point Hardware
6842 @section Floating Point Hardware
6843 @cindex floating point
6845 Depending on the configuration, @value{GDBN} may be able to give
6846 you more information about the status of the floating point hardware.
6851 Display hardware-dependent information about the floating
6852 point unit. The exact contents and layout vary depending on the
6853 floating point chip. Currently, @samp{info float} is supported on
6854 the ARM and x86 machines.
6858 @section Vector Unit
6861 Depending on the configuration, @value{GDBN} may be able to give you
6862 more information about the status of the vector unit.
6867 Display information about the vector unit. The exact contents and
6868 layout vary depending on the hardware.
6871 @node OS Information
6872 @section Operating System Auxiliary Information
6873 @cindex OS information
6875 @value{GDBN} provides interfaces to useful OS facilities that can help
6876 you debug your program.
6878 @cindex @code{ptrace} system call
6879 @cindex @code{struct user} contents
6880 When @value{GDBN} runs on a @dfn{Posix system} (such as GNU or Unix
6881 machines), it interfaces with the inferior via the @code{ptrace}
6882 system call. The operating system creates a special sata structure,
6883 called @code{struct user}, for this interface. You can use the
6884 command @code{info udot} to display the contents of this data
6890 Display the contents of the @code{struct user} maintained by the OS
6891 kernel for the program being debugged. @value{GDBN} displays the
6892 contents of @code{struct user} as a list of hex numbers, similar to
6893 the @code{examine} command.
6896 @cindex auxiliary vector
6897 @cindex vector, auxiliary
6898 Some operating systems supply an @dfn{auxiliary vector} to programs at
6899 startup. This is akin to the arguments and environment that you
6900 specify for a program, but contains a system-dependent variety of
6901 binary values that tell system libraries important details about the
6902 hardware, operating system, and process. Each value's purpose is
6903 identified by an integer tag; the meanings are well-known but system-specific.
6904 Depending on the configuration and operating system facilities,
6905 @value{GDBN} may be able to show you this information. For remote
6906 targets, this functionality may further depend on the remote stub's
6907 support of the @samp{qXfer:auxv:read} packet, see
6908 @ref{qXfer auxiliary vector read}.
6913 Display the auxiliary vector of the inferior, which can be either a
6914 live process or a core dump file. @value{GDBN} prints each tag value
6915 numerically, and also shows names and text descriptions for recognized
6916 tags. Some values in the vector are numbers, some bit masks, and some
6917 pointers to strings or other data. @value{GDBN} displays each value in the
6918 most appropriate form for a recognized tag, and in hexadecimal for
6919 an unrecognized tag.
6923 @node Memory Region Attributes
6924 @section Memory Region Attributes
6925 @cindex memory region attributes
6927 @dfn{Memory region attributes} allow you to describe special handling
6928 required by regions of your target's memory. @value{GDBN} uses
6929 attributes to determine whether to allow certain types of memory
6930 accesses; whether to use specific width accesses; and whether to cache
6931 target memory. By default the description of memory regions is
6932 fetched from the target (if the current target supports this), but the
6933 user can override the fetched regions.
6935 Defined memory regions can be individually enabled and disabled. When a
6936 memory region is disabled, @value{GDBN} uses the default attributes when
6937 accessing memory in that region. Similarly, if no memory regions have
6938 been defined, @value{GDBN} uses the default attributes when accessing
6941 When a memory region is defined, it is given a number to identify it;
6942 to enable, disable, or remove a memory region, you specify that number.
6946 @item mem @var{lower} @var{upper} @var{attributes}@dots{}
6947 Define a memory region bounded by @var{lower} and @var{upper} with
6948 attributes @var{attributes}@dots{}, and add it to the list of regions
6949 monitored by @value{GDBN}. Note that @var{upper} == 0 is a special
6950 case: it is treated as the target's maximum memory address.
6951 (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.)
6954 Discard any user changes to the memory regions and use target-supplied
6955 regions, if available, or no regions if the target does not support.
6958 @item delete mem @var{nums}@dots{}
6959 Remove memory regions @var{nums}@dots{} from the list of regions
6960 monitored by @value{GDBN}.
6963 @item disable mem @var{nums}@dots{}
6964 Disable monitoring of memory regions @var{nums}@dots{}.
6965 A disabled memory region is not forgotten.
6966 It may be enabled again later.
6969 @item enable mem @var{nums}@dots{}
6970 Enable monitoring of memory regions @var{nums}@dots{}.
6974 Print a table of all defined memory regions, with the following columns
6978 @item Memory Region Number
6979 @item Enabled or Disabled.
6980 Enabled memory regions are marked with @samp{y}.
6981 Disabled memory regions are marked with @samp{n}.
6984 The address defining the inclusive lower bound of the memory region.
6987 The address defining the exclusive upper bound of the memory region.
6990 The list of attributes set for this memory region.
6995 @subsection Attributes
6997 @subsubsection Memory Access Mode
6998 The access mode attributes set whether @value{GDBN} may make read or
6999 write accesses to a memory region.
7001 While these attributes prevent @value{GDBN} from performing invalid
7002 memory accesses, they do nothing to prevent the target system, I/O DMA,
7003 etc.@: from accessing memory.
7007 Memory is read only.
7009 Memory is write only.
7011 Memory is read/write. This is the default.
7014 @subsubsection Memory Access Size
7015 The access size attribute tells @value{GDBN} to use specific sized
7016 accesses in the memory region. Often memory mapped device registers
7017 require specific sized accesses. If no access size attribute is
7018 specified, @value{GDBN} may use accesses of any size.
7022 Use 8 bit memory accesses.
7024 Use 16 bit memory accesses.
7026 Use 32 bit memory accesses.
7028 Use 64 bit memory accesses.
7031 @c @subsubsection Hardware/Software Breakpoints
7032 @c The hardware/software breakpoint attributes set whether @value{GDBN}
7033 @c will use hardware or software breakpoints for the internal breakpoints
7034 @c used by the step, next, finish, until, etc. commands.
7038 @c Always use hardware breakpoints
7039 @c @item swbreak (default)
7042 @subsubsection Data Cache
7043 The data cache attributes set whether @value{GDBN} will cache target
7044 memory. While this generally improves performance by reducing debug
7045 protocol overhead, it can lead to incorrect results because @value{GDBN}
7046 does not know about volatile variables or memory mapped device
7051 Enable @value{GDBN} to cache target memory.
7053 Disable @value{GDBN} from caching target memory. This is the default.
7056 @subsection Memory Access Checking
7057 @value{GDBN} can be instructed to refuse accesses to memory that is
7058 not explicitly described. This can be useful if accessing such
7059 regions has undesired effects for a specific target, or to provide
7060 better error checking. The following commands control this behaviour.
7063 @kindex set mem inaccessible-by-default
7064 @item set mem inaccessible-by-default [on|off]
7065 If @code{on} is specified, make @value{GDBN} treat memory not
7066 explicitly described by the memory ranges as non-existent and refuse accesses
7067 to such memory. The checks are only performed if there's at least one
7068 memory range defined. If @code{off} is specified, make @value{GDBN}
7069 treat the memory not explicitly described by the memory ranges as RAM.
7070 The default value is @code{on}.
7071 @kindex show mem inaccessible-by-default
7072 @item show mem inaccessible-by-default
7073 Show the current handling of accesses to unknown memory.
7077 @c @subsubsection Memory Write Verification
7078 @c The memory write verification attributes set whether @value{GDBN}
7079 @c will re-reads data after each write to verify the write was successful.
7083 @c @item noverify (default)
7086 @node Dump/Restore Files
7087 @section Copy Between Memory and a File
7088 @cindex dump/restore files
7089 @cindex append data to a file
7090 @cindex dump data to a file
7091 @cindex restore data from a file
7093 You can use the commands @code{dump}, @code{append}, and
7094 @code{restore} to copy data between target memory and a file. The
7095 @code{dump} and @code{append} commands write data to a file, and the
7096 @code{restore} command reads data from a file back into the inferior's
7097 memory. Files may be in binary, Motorola S-record, Intel hex, or
7098 Tektronix Hex format; however, @value{GDBN} can only append to binary
7104 @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
7105 @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr}
7106 Dump the contents of memory from @var{start_addr} to @var{end_addr},
7107 or the value of @var{expr}, to @var{filename} in the given format.
7109 The @var{format} parameter may be any one of:
7116 Motorola S-record format.
7118 Tektronix Hex format.
7121 @value{GDBN} uses the same definitions of these formats as the
7122 @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If
7123 @var{format} is omitted, @value{GDBN} dumps the data in raw binary
7127 @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
7128 @itemx append @r{[}binary@r{]} value @var{filename} @var{expr}
7129 Append the contents of memory from @var{start_addr} to @var{end_addr},
7130 or the value of @var{expr}, to the file @var{filename}, in raw binary form.
7131 (@value{GDBN} can only append data to files in raw binary form.)
7134 @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end}
7135 Restore the contents of file @var{filename} into memory. The
7136 @code{restore} command can automatically recognize any known @sc{bfd}
7137 file format, except for raw binary. To restore a raw binary file you
7138 must specify the optional keyword @code{binary} after the filename.
7140 If @var{bias} is non-zero, its value will be added to the addresses
7141 contained in the file. Binary files always start at address zero, so
7142 they will be restored at address @var{bias}. Other bfd files have
7143 a built-in location; they will be restored at offset @var{bias}
7146 If @var{start} and/or @var{end} are non-zero, then only data between
7147 file offset @var{start} and file offset @var{end} will be restored.
7148 These offsets are relative to the addresses in the file, before
7149 the @var{bias} argument is applied.
7153 @node Core File Generation
7154 @section How to Produce a Core File from Your Program
7155 @cindex dump core from inferior
7157 A @dfn{core file} or @dfn{core dump} is a file that records the memory
7158 image of a running process and its process status (register values
7159 etc.). Its primary use is post-mortem debugging of a program that
7160 crashed while it ran outside a debugger. A program that crashes
7161 automatically produces a core file, unless this feature is disabled by
7162 the user. @xref{Files}, for information on invoking @value{GDBN} in
7163 the post-mortem debugging mode.
7165 Occasionally, you may wish to produce a core file of the program you
7166 are debugging in order to preserve a snapshot of its state.
7167 @value{GDBN} has a special command for that.
7171 @kindex generate-core-file
7172 @item generate-core-file [@var{file}]
7173 @itemx gcore [@var{file}]
7174 Produce a core dump of the inferior process. The optional argument
7175 @var{file} specifies the file name where to put the core dump. If not
7176 specified, the file name defaults to @file{core.@var{pid}}, where
7177 @var{pid} is the inferior process ID.
7179 Note that this command is implemented only for some systems (as of
7180 this writing, @sc{gnu}/Linux, FreeBSD, Solaris, Unixware, and S390).
7183 @node Character Sets
7184 @section Character Sets
7185 @cindex character sets
7187 @cindex translating between character sets
7188 @cindex host character set
7189 @cindex target character set
7191 If the program you are debugging uses a different character set to
7192 represent characters and strings than the one @value{GDBN} uses itself,
7193 @value{GDBN} can automatically translate between the character sets for
7194 you. The character set @value{GDBN} uses we call the @dfn{host
7195 character set}; the one the inferior program uses we call the
7196 @dfn{target character set}.
7198 For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which
7199 uses the ISO Latin 1 character set, but you are using @value{GDBN}'s
7200 remote protocol (@pxref{Remote Debugging}) to debug a program
7201 running on an IBM mainframe, which uses the @sc{ebcdic} character set,
7202 then the host character set is Latin-1, and the target character set is
7203 @sc{ebcdic}. If you give @value{GDBN} the command @code{set
7204 target-charset EBCDIC-US}, then @value{GDBN} translates between
7205 @sc{ebcdic} and Latin 1 as you print character or string values, or use
7206 character and string literals in expressions.
7208 @value{GDBN} has no way to automatically recognize which character set
7209 the inferior program uses; you must tell it, using the @code{set
7210 target-charset} command, described below.
7212 Here are the commands for controlling @value{GDBN}'s character set
7216 @item set target-charset @var{charset}
7217 @kindex set target-charset
7218 Set the current target character set to @var{charset}. We list the
7219 character set names @value{GDBN} recognizes below, but if you type
7220 @code{set target-charset} followed by @key{TAB}@key{TAB}, @value{GDBN} will
7221 list the target character sets it supports.
7225 @item set host-charset @var{charset}
7226 @kindex set host-charset
7227 Set the current host character set to @var{charset}.
7229 By default, @value{GDBN} uses a host character set appropriate to the
7230 system it is running on; you can override that default using the
7231 @code{set host-charset} command.
7233 @value{GDBN} can only use certain character sets as its host character
7234 set. We list the character set names @value{GDBN} recognizes below, and
7235 indicate which can be host character sets, but if you type
7236 @code{set target-charset} followed by @key{TAB}@key{TAB}, @value{GDBN} will
7237 list the host character sets it supports.
7239 @item set charset @var{charset}
7241 Set the current host and target character sets to @var{charset}. As
7242 above, if you type @code{set charset} followed by @key{TAB}@key{TAB},
7243 @value{GDBN} will list the name of the character sets that can be used
7244 for both host and target.
7248 @kindex show charset
7249 Show the names of the current host and target charsets.
7251 @itemx show host-charset
7252 @kindex show host-charset
7253 Show the name of the current host charset.
7255 @itemx show target-charset
7256 @kindex show target-charset
7257 Show the name of the current target charset.
7261 @value{GDBN} currently includes support for the following character
7267 @cindex ASCII character set
7268 Seven-bit U.S. @sc{ascii}. @value{GDBN} can use this as its host
7272 @cindex ISO 8859-1 character set
7273 @cindex ISO Latin 1 character set
7274 The ISO Latin 1 character set. This extends @sc{ascii} with accented
7275 characters needed for French, German, and Spanish. @value{GDBN} can use
7276 this as its host character set.
7280 @cindex EBCDIC character set
7281 @cindex IBM1047 character set
7282 Variants of the @sc{ebcdic} character set, used on some of IBM's
7283 mainframe operating systems. (@sc{gnu}/Linux on the S/390 uses U.S. @sc{ascii}.)
7284 @value{GDBN} cannot use these as its host character set.
7288 Note that these are all single-byte character sets. More work inside
7289 @value{GDBN} is needed to support multi-byte or variable-width character
7290 encodings, like the UTF-8 and UCS-2 encodings of Unicode.
7292 Here is an example of @value{GDBN}'s character set support in action.
7293 Assume that the following source code has been placed in the file
7294 @file{charset-test.c}:
7300 = @{72, 101, 108, 108, 111, 44, 32, 119,
7301 111, 114, 108, 100, 33, 10, 0@};
7302 char ibm1047_hello[]
7303 = @{200, 133, 147, 147, 150, 107, 64, 166,
7304 150, 153, 147, 132, 90, 37, 0@};
7308 printf ("Hello, world!\n");
7312 In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays
7313 containing the string @samp{Hello, world!} followed by a newline,
7314 encoded in the @sc{ascii} and @sc{ibm1047} character sets.
7316 We compile the program, and invoke the debugger on it:
7319 $ gcc -g charset-test.c -o charset-test
7320 $ gdb -nw charset-test
7321 GNU gdb 2001-12-19-cvs
7322 Copyright 2001 Free Software Foundation, Inc.
7327 We can use the @code{show charset} command to see what character sets
7328 @value{GDBN} is currently using to interpret and display characters and
7332 (@value{GDBP}) show charset
7333 The current host and target character set is `ISO-8859-1'.
7337 For the sake of printing this manual, let's use @sc{ascii} as our
7338 initial character set:
7340 (@value{GDBP}) set charset ASCII
7341 (@value{GDBP}) show charset
7342 The current host and target character set is `ASCII'.
7346 Let's assume that @sc{ascii} is indeed the correct character set for our
7347 host system --- in other words, let's assume that if @value{GDBN} prints
7348 characters using the @sc{ascii} character set, our terminal will display
7349 them properly. Since our current target character set is also
7350 @sc{ascii}, the contents of @code{ascii_hello} print legibly:
7353 (@value{GDBP}) print ascii_hello
7354 $1 = 0x401698 "Hello, world!\n"
7355 (@value{GDBP}) print ascii_hello[0]
7360 @value{GDBN} uses the target character set for character and string
7361 literals you use in expressions:
7364 (@value{GDBP}) print '+'
7369 The @sc{ascii} character set uses the number 43 to encode the @samp{+}
7372 @value{GDBN} relies on the user to tell it which character set the
7373 target program uses. If we print @code{ibm1047_hello} while our target
7374 character set is still @sc{ascii}, we get jibberish:
7377 (@value{GDBP}) print ibm1047_hello
7378 $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%"
7379 (@value{GDBP}) print ibm1047_hello[0]
7384 If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB},
7385 @value{GDBN} tells us the character sets it supports:
7388 (@value{GDBP}) set target-charset
7389 ASCII EBCDIC-US IBM1047 ISO-8859-1
7390 (@value{GDBP}) set target-charset
7393 We can select @sc{ibm1047} as our target character set, and examine the
7394 program's strings again. Now the @sc{ascii} string is wrong, but
7395 @value{GDBN} translates the contents of @code{ibm1047_hello} from the
7396 target character set, @sc{ibm1047}, to the host character set,
7397 @sc{ascii}, and they display correctly:
7400 (@value{GDBP}) set target-charset IBM1047
7401 (@value{GDBP}) show charset
7402 The current host character set is `ASCII'.
7403 The current target character set is `IBM1047'.
7404 (@value{GDBP}) print ascii_hello
7405 $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012"
7406 (@value{GDBP}) print ascii_hello[0]
7408 (@value{GDBP}) print ibm1047_hello
7409 $8 = 0x4016a8 "Hello, world!\n"
7410 (@value{GDBP}) print ibm1047_hello[0]
7415 As above, @value{GDBN} uses the target character set for character and
7416 string literals you use in expressions:
7419 (@value{GDBP}) print '+'
7424 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
7427 @node Caching Remote Data
7428 @section Caching Data of Remote Targets
7429 @cindex caching data of remote targets
7431 @value{GDBN} can cache data exchanged between the debugger and a
7432 remote target (@pxref{Remote Debugging}). Such caching generally improves
7433 performance, because it reduces the overhead of the remote protocol by
7434 bundling memory reads and writes into large chunks. Unfortunately,
7435 @value{GDBN} does not currently know anything about volatile
7436 registers, and thus data caching will produce incorrect results when
7437 volatile registers are in use.
7440 @kindex set remotecache
7441 @item set remotecache on
7442 @itemx set remotecache off
7443 Set caching state for remote targets. When @code{ON}, use data
7444 caching. By default, this option is @code{OFF}.
7446 @kindex show remotecache
7447 @item show remotecache
7448 Show the current state of data caching for remote targets.
7452 Print the information about the data cache performance. The
7453 information displayed includes: the dcache width and depth; and for
7454 each cache line, how many times it was referenced, and its data and
7455 state (dirty, bad, ok, etc.). This command is useful for debugging
7456 the data cache operation.
7461 @chapter C Preprocessor Macros
7463 Some languages, such as C and C@t{++}, provide a way to define and invoke
7464 ``preprocessor macros'' which expand into strings of tokens.
7465 @value{GDBN} can evaluate expressions containing macro invocations, show
7466 the result of macro expansion, and show a macro's definition, including
7467 where it was defined.
7469 You may need to compile your program specially to provide @value{GDBN}
7470 with information about preprocessor macros. Most compilers do not
7471 include macros in their debugging information, even when you compile
7472 with the @option{-g} flag. @xref{Compilation}.
7474 A program may define a macro at one point, remove that definition later,
7475 and then provide a different definition after that. Thus, at different
7476 points in the program, a macro may have different definitions, or have
7477 no definition at all. If there is a current stack frame, @value{GDBN}
7478 uses the macros in scope at that frame's source code line. Otherwise,
7479 @value{GDBN} uses the macros in scope at the current listing location;
7482 At the moment, @value{GDBN} does not support the @code{##}
7483 token-splicing operator, the @code{#} stringification operator, or
7484 variable-arity macros.
7486 Whenever @value{GDBN} evaluates an expression, it always expands any
7487 macro invocations present in the expression. @value{GDBN} also provides
7488 the following commands for working with macros explicitly.
7492 @kindex macro expand
7493 @cindex macro expansion, showing the results of preprocessor
7494 @cindex preprocessor macro expansion, showing the results of
7495 @cindex expanding preprocessor macros
7496 @item macro expand @var{expression}
7497 @itemx macro exp @var{expression}
7498 Show the results of expanding all preprocessor macro invocations in
7499 @var{expression}. Since @value{GDBN} simply expands macros, but does
7500 not parse the result, @var{expression} need not be a valid expression;
7501 it can be any string of tokens.
7504 @item macro expand-once @var{expression}
7505 @itemx macro exp1 @var{expression}
7506 @cindex expand macro once
7507 @i{(This command is not yet implemented.)} Show the results of
7508 expanding those preprocessor macro invocations that appear explicitly in
7509 @var{expression}. Macro invocations appearing in that expansion are
7510 left unchanged. This command allows you to see the effect of a
7511 particular macro more clearly, without being confused by further
7512 expansions. Since @value{GDBN} simply expands macros, but does not
7513 parse the result, @var{expression} need not be a valid expression; it
7514 can be any string of tokens.
7517 @cindex macro definition, showing
7518 @cindex definition, showing a macro's
7519 @item info macro @var{macro}
7520 Show the definition of the macro named @var{macro}, and describe the
7521 source location where that definition was established.
7523 @kindex macro define
7524 @cindex user-defined macros
7525 @cindex defining macros interactively
7526 @cindex macros, user-defined
7527 @item macro define @var{macro} @var{replacement-list}
7528 @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list}
7529 @i{(This command is not yet implemented.)} Introduce a definition for a
7530 preprocessor macro named @var{macro}, invocations of which are replaced
7531 by the tokens given in @var{replacement-list}. The first form of this
7532 command defines an ``object-like'' macro, which takes no arguments; the
7533 second form defines a ``function-like'' macro, which takes the arguments
7534 given in @var{arglist}.
7536 A definition introduced by this command is in scope in every expression
7537 evaluated in @value{GDBN}, until it is removed with the @command{macro
7538 undef} command, described below. The definition overrides all
7539 definitions for @var{macro} present in the program being debugged, as
7540 well as any previous user-supplied definition.
7543 @item macro undef @var{macro}
7544 @i{(This command is not yet implemented.)} Remove any user-supplied
7545 definition for the macro named @var{macro}. This command only affects
7546 definitions provided with the @command{macro define} command, described
7547 above; it cannot remove definitions present in the program being
7552 @i{(This command is not yet implemented.)} List all the macros
7553 defined using the @code{macro define} command.
7556 @cindex macros, example of debugging with
7557 Here is a transcript showing the above commands in action. First, we
7558 show our source files:
7566 #define ADD(x) (M + x)
7571 printf ("Hello, world!\n");
7573 printf ("We're so creative.\n");
7575 printf ("Goodbye, world!\n");
7582 Now, we compile the program using the @sc{gnu} C compiler, @value{NGCC}.
7583 We pass the @option{-gdwarf-2} and @option{-g3} flags to ensure the
7584 compiler includes information about preprocessor macros in the debugging
7588 $ gcc -gdwarf-2 -g3 sample.c -o sample
7592 Now, we start @value{GDBN} on our sample program:
7596 GNU gdb 2002-05-06-cvs
7597 Copyright 2002 Free Software Foundation, Inc.
7598 GDB is free software, @dots{}
7602 We can expand macros and examine their definitions, even when the
7603 program is not running. @value{GDBN} uses the current listing position
7604 to decide which macro definitions are in scope:
7607 (@value{GDBP}) list main
7610 5 #define ADD(x) (M + x)
7615 10 printf ("Hello, world!\n");
7617 12 printf ("We're so creative.\n");
7618 (@value{GDBP}) info macro ADD
7619 Defined at /home/jimb/gdb/macros/play/sample.c:5
7620 #define ADD(x) (M + x)
7621 (@value{GDBP}) info macro Q
7622 Defined at /home/jimb/gdb/macros/play/sample.h:1
7623 included at /home/jimb/gdb/macros/play/sample.c:2
7625 (@value{GDBP}) macro expand ADD(1)
7626 expands to: (42 + 1)
7627 (@value{GDBP}) macro expand-once ADD(1)
7628 expands to: once (M + 1)
7632 In the example above, note that @command{macro expand-once} expands only
7633 the macro invocation explicit in the original text --- the invocation of
7634 @code{ADD} --- but does not expand the invocation of the macro @code{M},
7635 which was introduced by @code{ADD}.
7637 Once the program is running, @value{GDBN} uses the macro definitions in
7638 force at the source line of the current stack frame:
7641 (@value{GDBP}) break main
7642 Breakpoint 1 at 0x8048370: file sample.c, line 10.
7644 Starting program: /home/jimb/gdb/macros/play/sample
7646 Breakpoint 1, main () at sample.c:10
7647 10 printf ("Hello, world!\n");
7651 At line 10, the definition of the macro @code{N} at line 9 is in force:
7654 (@value{GDBP}) info macro N
7655 Defined at /home/jimb/gdb/macros/play/sample.c:9
7657 (@value{GDBP}) macro expand N Q M
7659 (@value{GDBP}) print N Q M
7664 As we step over directives that remove @code{N}'s definition, and then
7665 give it a new definition, @value{GDBN} finds the definition (or lack
7666 thereof) in force at each point:
7671 12 printf ("We're so creative.\n");
7672 (@value{GDBP}) info macro N
7673 The symbol `N' has no definition as a C/C++ preprocessor macro
7674 at /home/jimb/gdb/macros/play/sample.c:12
7677 14 printf ("Goodbye, world!\n");
7678 (@value{GDBP}) info macro N
7679 Defined at /home/jimb/gdb/macros/play/sample.c:13
7681 (@value{GDBP}) macro expand N Q M
7682 expands to: 1729 < 42
7683 (@value{GDBP}) print N Q M
7690 @chapter Tracepoints
7691 @c This chapter is based on the documentation written by Michael
7692 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
7695 In some applications, it is not feasible for the debugger to interrupt
7696 the program's execution long enough for the developer to learn
7697 anything helpful about its behavior. If the program's correctness
7698 depends on its real-time behavior, delays introduced by a debugger
7699 might cause the program to change its behavior drastically, or perhaps
7700 fail, even when the code itself is correct. It is useful to be able
7701 to observe the program's behavior without interrupting it.
7703 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
7704 specify locations in the program, called @dfn{tracepoints}, and
7705 arbitrary expressions to evaluate when those tracepoints are reached.
7706 Later, using the @code{tfind} command, you can examine the values
7707 those expressions had when the program hit the tracepoints. The
7708 expressions may also denote objects in memory---structures or arrays,
7709 for example---whose values @value{GDBN} should record; while visiting
7710 a particular tracepoint, you may inspect those objects as if they were
7711 in memory at that moment. However, because @value{GDBN} records these
7712 values without interacting with you, it can do so quickly and
7713 unobtrusively, hopefully not disturbing the program's behavior.
7715 The tracepoint facility is currently available only for remote
7716 targets. @xref{Targets}. In addition, your remote target must know
7717 how to collect trace data. This functionality is implemented in the
7718 remote stub; however, none of the stubs distributed with @value{GDBN}
7719 support tracepoints as of this writing. The format of the remote
7720 packets used to implement tracepoints are described in @ref{Tracepoint
7723 This chapter describes the tracepoint commands and features.
7727 * Analyze Collected Data::
7728 * Tracepoint Variables::
7731 @node Set Tracepoints
7732 @section Commands to Set Tracepoints
7734 Before running such a @dfn{trace experiment}, an arbitrary number of
7735 tracepoints can be set. Like a breakpoint (@pxref{Set Breaks}), a
7736 tracepoint has a number assigned to it by @value{GDBN}. Like with
7737 breakpoints, tracepoint numbers are successive integers starting from
7738 one. Many of the commands associated with tracepoints take the
7739 tracepoint number as their argument, to identify which tracepoint to
7742 For each tracepoint, you can specify, in advance, some arbitrary set
7743 of data that you want the target to collect in the trace buffer when
7744 it hits that tracepoint. The collected data can include registers,
7745 local variables, or global data. Later, you can use @value{GDBN}
7746 commands to examine the values these data had at the time the
7749 This section describes commands to set tracepoints and associated
7750 conditions and actions.
7753 * Create and Delete Tracepoints::
7754 * Enable and Disable Tracepoints::
7755 * Tracepoint Passcounts::
7756 * Tracepoint Actions::
7757 * Listing Tracepoints::
7758 * Starting and Stopping Trace Experiments::
7761 @node Create and Delete Tracepoints
7762 @subsection Create and Delete Tracepoints
7765 @cindex set tracepoint
7768 The @code{trace} command is very similar to the @code{break} command.
7769 Its argument can be a source line, a function name, or an address in
7770 the target program. @xref{Set Breaks}. The @code{trace} command
7771 defines a tracepoint, which is a point in the target program where the
7772 debugger will briefly stop, collect some data, and then allow the
7773 program to continue. Setting a tracepoint or changing its commands
7774 doesn't take effect until the next @code{tstart} command; thus, you
7775 cannot change the tracepoint attributes once a trace experiment is
7778 Here are some examples of using the @code{trace} command:
7781 (@value{GDBP}) @b{trace foo.c:121} // a source file and line number
7783 (@value{GDBP}) @b{trace +2} // 2 lines forward
7785 (@value{GDBP}) @b{trace my_function} // first source line of function
7787 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
7789 (@value{GDBP}) @b{trace *0x2117c4} // an address
7793 You can abbreviate @code{trace} as @code{tr}.
7796 @cindex last tracepoint number
7797 @cindex recent tracepoint number
7798 @cindex tracepoint number
7799 The convenience variable @code{$tpnum} records the tracepoint number
7800 of the most recently set tracepoint.
7802 @kindex delete tracepoint
7803 @cindex tracepoint deletion
7804 @item delete tracepoint @r{[}@var{num}@r{]}
7805 Permanently delete one or more tracepoints. With no argument, the
7806 default is to delete all tracepoints.
7811 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
7813 (@value{GDBP}) @b{delete trace} // remove all tracepoints
7817 You can abbreviate this command as @code{del tr}.
7820 @node Enable and Disable Tracepoints
7821 @subsection Enable and Disable Tracepoints
7824 @kindex disable tracepoint
7825 @item disable tracepoint @r{[}@var{num}@r{]}
7826 Disable tracepoint @var{num}, or all tracepoints if no argument
7827 @var{num} is given. A disabled tracepoint will have no effect during
7828 the next trace experiment, but it is not forgotten. You can re-enable
7829 a disabled tracepoint using the @code{enable tracepoint} command.
7831 @kindex enable tracepoint
7832 @item enable tracepoint @r{[}@var{num}@r{]}
7833 Enable tracepoint @var{num}, or all tracepoints. The enabled
7834 tracepoints will become effective the next time a trace experiment is
7838 @node Tracepoint Passcounts
7839 @subsection Tracepoint Passcounts
7843 @cindex tracepoint pass count
7844 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
7845 Set the @dfn{passcount} of a tracepoint. The passcount is a way to
7846 automatically stop a trace experiment. If a tracepoint's passcount is
7847 @var{n}, then the trace experiment will be automatically stopped on
7848 the @var{n}'th time that tracepoint is hit. If the tracepoint number
7849 @var{num} is not specified, the @code{passcount} command sets the
7850 passcount of the most recently defined tracepoint. If no passcount is
7851 given, the trace experiment will run until stopped explicitly by the
7857 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of
7858 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2}
7860 (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the
7861 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.}
7862 (@value{GDBP}) @b{trace foo}
7863 (@value{GDBP}) @b{pass 3}
7864 (@value{GDBP}) @b{trace bar}
7865 (@value{GDBP}) @b{pass 2}
7866 (@value{GDBP}) @b{trace baz}
7867 (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been
7868 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has}
7869 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times}
7870 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.}
7874 @node Tracepoint Actions
7875 @subsection Tracepoint Action Lists
7879 @cindex tracepoint actions
7880 @item actions @r{[}@var{num}@r{]}
7881 This command will prompt for a list of actions to be taken when the
7882 tracepoint is hit. If the tracepoint number @var{num} is not
7883 specified, this command sets the actions for the one that was most
7884 recently defined (so that you can define a tracepoint and then say
7885 @code{actions} without bothering about its number). You specify the
7886 actions themselves on the following lines, one action at a time, and
7887 terminate the actions list with a line containing just @code{end}. So
7888 far, the only defined actions are @code{collect} and
7889 @code{while-stepping}.
7891 @cindex remove actions from a tracepoint
7892 To remove all actions from a tracepoint, type @samp{actions @var{num}}
7893 and follow it immediately with @samp{end}.
7896 (@value{GDBP}) @b{collect @var{data}} // collect some data
7898 (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data
7900 (@value{GDBP}) @b{end} // signals the end of actions.
7903 In the following example, the action list begins with @code{collect}
7904 commands indicating the things to be collected when the tracepoint is
7905 hit. Then, in order to single-step and collect additional data
7906 following the tracepoint, a @code{while-stepping} command is used,
7907 followed by the list of things to be collected while stepping. The
7908 @code{while-stepping} command is terminated by its own separate
7909 @code{end} command. Lastly, the action list is terminated by an
7913 (@value{GDBP}) @b{trace foo}
7914 (@value{GDBP}) @b{actions}
7915 Enter actions for tracepoint 1, one per line:
7924 @kindex collect @r{(tracepoints)}
7925 @item collect @var{expr1}, @var{expr2}, @dots{}
7926 Collect values of the given expressions when the tracepoint is hit.
7927 This command accepts a comma-separated list of any valid expressions.
7928 In addition to global, static, or local variables, the following
7929 special arguments are supported:
7933 collect all registers
7936 collect all function arguments
7939 collect all local variables.
7942 You can give several consecutive @code{collect} commands, each one
7943 with a single argument, or one @code{collect} command with several
7944 arguments separated by commas: the effect is the same.
7946 The command @code{info scope} (@pxref{Symbols, info scope}) is
7947 particularly useful for figuring out what data to collect.
7949 @kindex while-stepping @r{(tracepoints)}
7950 @item while-stepping @var{n}
7951 Perform @var{n} single-step traces after the tracepoint, collecting
7952 new data at each step. The @code{while-stepping} command is
7953 followed by the list of what to collect while stepping (followed by
7954 its own @code{end} command):
7958 > collect $regs, myglobal
7964 You may abbreviate @code{while-stepping} as @code{ws} or
7968 @node Listing Tracepoints
7969 @subsection Listing Tracepoints
7972 @kindex info tracepoints
7974 @cindex information about tracepoints
7975 @item info tracepoints @r{[}@var{num}@r{]}
7976 Display information about the tracepoint @var{num}. If you don't specify
7977 a tracepoint number, displays information about all the tracepoints
7978 defined so far. For each tracepoint, the following information is
7985 whether it is enabled or disabled
7989 its passcount as given by the @code{passcount @var{n}} command
7991 its step count as given by the @code{while-stepping @var{n}} command
7993 where in the source files is the tracepoint set
7995 its action list as given by the @code{actions} command
7999 (@value{GDBP}) @b{info trace}
8000 Num Enb Address PassC StepC What
8001 1 y 0x002117c4 0 0 <gdb_asm>
8002 2 y 0x0020dc64 0 0 in g_test at g_test.c:1375
8003 3 y 0x0020b1f4 0 0 in get_data at ../foo.c:41
8008 This command can be abbreviated @code{info tp}.
8011 @node Starting and Stopping Trace Experiments
8012 @subsection Starting and Stopping Trace Experiments
8016 @cindex start a new trace experiment
8017 @cindex collected data discarded
8019 This command takes no arguments. It starts the trace experiment, and
8020 begins collecting data. This has the side effect of discarding all
8021 the data collected in the trace buffer during the previous trace
8025 @cindex stop a running trace experiment
8027 This command takes no arguments. It ends the trace experiment, and
8028 stops collecting data.
8030 @strong{Note}: a trace experiment and data collection may stop
8031 automatically if any tracepoint's passcount is reached
8032 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
8035 @cindex status of trace data collection
8036 @cindex trace experiment, status of
8038 This command displays the status of the current trace data
8042 Here is an example of the commands we described so far:
8045 (@value{GDBP}) @b{trace gdb_c_test}
8046 (@value{GDBP}) @b{actions}
8047 Enter actions for tracepoint #1, one per line.
8048 > collect $regs,$locals,$args
8053 (@value{GDBP}) @b{tstart}
8054 [time passes @dots{}]
8055 (@value{GDBP}) @b{tstop}
8059 @node Analyze Collected Data
8060 @section Using the Collected Data
8062 After the tracepoint experiment ends, you use @value{GDBN} commands
8063 for examining the trace data. The basic idea is that each tracepoint
8064 collects a trace @dfn{snapshot} every time it is hit and another
8065 snapshot every time it single-steps. All these snapshots are
8066 consecutively numbered from zero and go into a buffer, and you can
8067 examine them later. The way you examine them is to @dfn{focus} on a
8068 specific trace snapshot. When the remote stub is focused on a trace
8069 snapshot, it will respond to all @value{GDBN} requests for memory and
8070 registers by reading from the buffer which belongs to that snapshot,
8071 rather than from @emph{real} memory or registers of the program being
8072 debugged. This means that @strong{all} @value{GDBN} commands
8073 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
8074 behave as if we were currently debugging the program state as it was
8075 when the tracepoint occurred. Any requests for data that are not in
8076 the buffer will fail.
8079 * tfind:: How to select a trace snapshot
8080 * tdump:: How to display all data for a snapshot
8081 * save-tracepoints:: How to save tracepoints for a future run
8085 @subsection @code{tfind @var{n}}
8088 @cindex select trace snapshot
8089 @cindex find trace snapshot
8090 The basic command for selecting a trace snapshot from the buffer is
8091 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
8092 counting from zero. If no argument @var{n} is given, the next
8093 snapshot is selected.
8095 Here are the various forms of using the @code{tfind} command.
8099 Find the first snapshot in the buffer. This is a synonym for
8100 @code{tfind 0} (since 0 is the number of the first snapshot).
8103 Stop debugging trace snapshots, resume @emph{live} debugging.
8106 Same as @samp{tfind none}.
8109 No argument means find the next trace snapshot.
8112 Find the previous trace snapshot before the current one. This permits
8113 retracing earlier steps.
8115 @item tfind tracepoint @var{num}
8116 Find the next snapshot associated with tracepoint @var{num}. Search
8117 proceeds forward from the last examined trace snapshot. If no
8118 argument @var{num} is given, it means find the next snapshot collected
8119 for the same tracepoint as the current snapshot.
8121 @item tfind pc @var{addr}
8122 Find the next snapshot associated with the value @var{addr} of the
8123 program counter. Search proceeds forward from the last examined trace
8124 snapshot. If no argument @var{addr} is given, it means find the next
8125 snapshot with the same value of PC as the current snapshot.
8127 @item tfind outside @var{addr1}, @var{addr2}
8128 Find the next snapshot whose PC is outside the given range of
8131 @item tfind range @var{addr1}, @var{addr2}
8132 Find the next snapshot whose PC is between @var{addr1} and
8133 @var{addr2}. @c FIXME: Is the range inclusive or exclusive?
8135 @item tfind line @r{[}@var{file}:@r{]}@var{n}
8136 Find the next snapshot associated with the source line @var{n}. If
8137 the optional argument @var{file} is given, refer to line @var{n} in
8138 that source file. Search proceeds forward from the last examined
8139 trace snapshot. If no argument @var{n} is given, it means find the
8140 next line other than the one currently being examined; thus saying
8141 @code{tfind line} repeatedly can appear to have the same effect as
8142 stepping from line to line in a @emph{live} debugging session.
8145 The default arguments for the @code{tfind} commands are specifically
8146 designed to make it easy to scan through the trace buffer. For
8147 instance, @code{tfind} with no argument selects the next trace
8148 snapshot, and @code{tfind -} with no argument selects the previous
8149 trace snapshot. So, by giving one @code{tfind} command, and then
8150 simply hitting @key{RET} repeatedly you can examine all the trace
8151 snapshots in order. Or, by saying @code{tfind -} and then hitting
8152 @key{RET} repeatedly you can examine the snapshots in reverse order.
8153 The @code{tfind line} command with no argument selects the snapshot
8154 for the next source line executed. The @code{tfind pc} command with
8155 no argument selects the next snapshot with the same program counter
8156 (PC) as the current frame. The @code{tfind tracepoint} command with
8157 no argument selects the next trace snapshot collected by the same
8158 tracepoint as the current one.
8160 In addition to letting you scan through the trace buffer manually,
8161 these commands make it easy to construct @value{GDBN} scripts that
8162 scan through the trace buffer and print out whatever collected data
8163 you are interested in. Thus, if we want to examine the PC, FP, and SP
8164 registers from each trace frame in the buffer, we can say this:
8167 (@value{GDBP}) @b{tfind start}
8168 (@value{GDBP}) @b{while ($trace_frame != -1)}
8169 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
8170 $trace_frame, $pc, $sp, $fp
8174 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
8175 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
8176 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
8177 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
8178 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
8179 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
8180 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
8181 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
8182 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
8183 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
8184 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
8187 Or, if we want to examine the variable @code{X} at each source line in
8191 (@value{GDBP}) @b{tfind start}
8192 (@value{GDBP}) @b{while ($trace_frame != -1)}
8193 > printf "Frame %d, X == %d\n", $trace_frame, X
8203 @subsection @code{tdump}
8205 @cindex dump all data collected at tracepoint
8206 @cindex tracepoint data, display
8208 This command takes no arguments. It prints all the data collected at
8209 the current trace snapshot.
8212 (@value{GDBP}) @b{trace 444}
8213 (@value{GDBP}) @b{actions}
8214 Enter actions for tracepoint #2, one per line:
8215 > collect $regs, $locals, $args, gdb_long_test
8218 (@value{GDBP}) @b{tstart}
8220 (@value{GDBP}) @b{tfind line 444}
8221 #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
8223 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
8225 (@value{GDBP}) @b{tdump}
8226 Data collected at tracepoint 2, trace frame 1:
8227 d0 0xc4aa0085 -995491707
8231 d4 0x71aea3d 119204413
8236 a1 0x3000668 50333288
8239 a4 0x3000698 50333336
8241 fp 0x30bf3c 0x30bf3c
8242 sp 0x30bf34 0x30bf34
8244 pc 0x20b2c8 0x20b2c8
8248 p = 0x20e5b4 "gdb-test"
8255 gdb_long_test = 17 '\021'
8260 @node save-tracepoints
8261 @subsection @code{save-tracepoints @var{filename}}
8262 @kindex save-tracepoints
8263 @cindex save tracepoints for future sessions
8265 This command saves all current tracepoint definitions together with
8266 their actions and passcounts, into a file @file{@var{filename}}
8267 suitable for use in a later debugging session. To read the saved
8268 tracepoint definitions, use the @code{source} command (@pxref{Command
8271 @node Tracepoint Variables
8272 @section Convenience Variables for Tracepoints
8273 @cindex tracepoint variables
8274 @cindex convenience variables for tracepoints
8277 @vindex $trace_frame
8278 @item (int) $trace_frame
8279 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
8280 snapshot is selected.
8283 @item (int) $tracepoint
8284 The tracepoint for the current trace snapshot.
8287 @item (int) $trace_line
8288 The line number for the current trace snapshot.
8291 @item (char []) $trace_file
8292 The source file for the current trace snapshot.
8295 @item (char []) $trace_func
8296 The name of the function containing @code{$tracepoint}.
8299 Note: @code{$trace_file} is not suitable for use in @code{printf},
8300 use @code{output} instead.
8302 Here's a simple example of using these convenience variables for
8303 stepping through all the trace snapshots and printing some of their
8307 (@value{GDBP}) @b{tfind start}
8309 (@value{GDBP}) @b{while $trace_frame != -1}
8310 > output $trace_file
8311 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
8317 @chapter Debugging Programs That Use Overlays
8320 If your program is too large to fit completely in your target system's
8321 memory, you can sometimes use @dfn{overlays} to work around this
8322 problem. @value{GDBN} provides some support for debugging programs that
8326 * How Overlays Work:: A general explanation of overlays.
8327 * Overlay Commands:: Managing overlays in @value{GDBN}.
8328 * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are
8329 mapped by asking the inferior.
8330 * Overlay Sample Program:: A sample program using overlays.
8333 @node How Overlays Work
8334 @section How Overlays Work
8335 @cindex mapped overlays
8336 @cindex unmapped overlays
8337 @cindex load address, overlay's
8338 @cindex mapped address
8339 @cindex overlay area
8341 Suppose you have a computer whose instruction address space is only 64
8342 kilobytes long, but which has much more memory which can be accessed by
8343 other means: special instructions, segment registers, or memory
8344 management hardware, for example. Suppose further that you want to
8345 adapt a program which is larger than 64 kilobytes to run on this system.
8347 One solution is to identify modules of your program which are relatively
8348 independent, and need not call each other directly; call these modules
8349 @dfn{overlays}. Separate the overlays from the main program, and place
8350 their machine code in the larger memory. Place your main program in
8351 instruction memory, but leave at least enough space there to hold the
8352 largest overlay as well.
8354 Now, to call a function located in an overlay, you must first copy that
8355 overlay's machine code from the large memory into the space set aside
8356 for it in the instruction memory, and then jump to its entry point
8359 @c NB: In the below the mapped area's size is greater or equal to the
8360 @c size of all overlays. This is intentional to remind the developer
8361 @c that overlays don't necessarily need to be the same size.
8365 Data Instruction Larger
8366 Address Space Address Space Address Space
8367 +-----------+ +-----------+ +-----------+
8369 +-----------+ +-----------+ +-----------+<-- overlay 1
8370 | program | | main | .----| overlay 1 | load address
8371 | variables | | program | | +-----------+
8372 | and heap | | | | | |
8373 +-----------+ | | | +-----------+<-- overlay 2
8374 | | +-----------+ | | | load address
8375 +-----------+ | | | .-| overlay 2 |
8377 mapped --->+-----------+ | | +-----------+
8379 | overlay | <-' | | |
8380 | area | <---' +-----------+<-- overlay 3
8381 | | <---. | | load address
8382 +-----------+ `--| overlay 3 |
8389 @anchor{A code overlay}A code overlay
8393 The diagram (@pxref{A code overlay}) shows a system with separate data
8394 and instruction address spaces. To map an overlay, the program copies
8395 its code from the larger address space to the instruction address space.
8396 Since the overlays shown here all use the same mapped address, only one
8397 may be mapped at a time. For a system with a single address space for
8398 data and instructions, the diagram would be similar, except that the
8399 program variables and heap would share an address space with the main
8400 program and the overlay area.
8402 An overlay loaded into instruction memory and ready for use is called a
8403 @dfn{mapped} overlay; its @dfn{mapped address} is its address in the
8404 instruction memory. An overlay not present (or only partially present)
8405 in instruction memory is called @dfn{unmapped}; its @dfn{load address}
8406 is its address in the larger memory. The mapped address is also called
8407 the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also
8408 called the @dfn{load memory address}, or @dfn{LMA}.
8410 Unfortunately, overlays are not a completely transparent way to adapt a
8411 program to limited instruction memory. They introduce a new set of
8412 global constraints you must keep in mind as you design your program:
8417 Before calling or returning to a function in an overlay, your program
8418 must make sure that overlay is actually mapped. Otherwise, the call or
8419 return will transfer control to the right address, but in the wrong
8420 overlay, and your program will probably crash.
8423 If the process of mapping an overlay is expensive on your system, you
8424 will need to choose your overlays carefully to minimize their effect on
8425 your program's performance.
8428 The executable file you load onto your system must contain each
8429 overlay's instructions, appearing at the overlay's load address, not its
8430 mapped address. However, each overlay's instructions must be relocated
8431 and its symbols defined as if the overlay were at its mapped address.
8432 You can use GNU linker scripts to specify different load and relocation
8433 addresses for pieces of your program; see @ref{Overlay Description,,,
8434 ld.info, Using ld: the GNU linker}.
8437 The procedure for loading executable files onto your system must be able
8438 to load their contents into the larger address space as well as the
8439 instruction and data spaces.
8443 The overlay system described above is rather simple, and could be
8444 improved in many ways:
8449 If your system has suitable bank switch registers or memory management
8450 hardware, you could use those facilities to make an overlay's load area
8451 contents simply appear at their mapped address in instruction space.
8452 This would probably be faster than copying the overlay to its mapped
8453 area in the usual way.
8456 If your overlays are small enough, you could set aside more than one
8457 overlay area, and have more than one overlay mapped at a time.
8460 You can use overlays to manage data, as well as instructions. In
8461 general, data overlays are even less transparent to your design than
8462 code overlays: whereas code overlays only require care when you call or
8463 return to functions, data overlays require care every time you access
8464 the data. Also, if you change the contents of a data overlay, you
8465 must copy its contents back out to its load address before you can copy a
8466 different data overlay into the same mapped area.
8471 @node Overlay Commands
8472 @section Overlay Commands
8474 To use @value{GDBN}'s overlay support, each overlay in your program must
8475 correspond to a separate section of the executable file. The section's
8476 virtual memory address and load memory address must be the overlay's
8477 mapped and load addresses. Identifying overlays with sections allows
8478 @value{GDBN} to determine the appropriate address of a function or
8479 variable, depending on whether the overlay is mapped or not.
8481 @value{GDBN}'s overlay commands all start with the word @code{overlay};
8482 you can abbreviate this as @code{ov} or @code{ovly}. The commands are:
8487 Disable @value{GDBN}'s overlay support. When overlay support is
8488 disabled, @value{GDBN} assumes that all functions and variables are
8489 always present at their mapped addresses. By default, @value{GDBN}'s
8490 overlay support is disabled.
8492 @item overlay manual
8493 @cindex manual overlay debugging
8494 Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN}
8495 relies on you to tell it which overlays are mapped, and which are not,
8496 using the @code{overlay map-overlay} and @code{overlay unmap-overlay}
8497 commands described below.
8499 @item overlay map-overlay @var{overlay}
8500 @itemx overlay map @var{overlay}
8501 @cindex map an overlay
8502 Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must
8503 be the name of the object file section containing the overlay. When an
8504 overlay is mapped, @value{GDBN} assumes it can find the overlay's
8505 functions and variables at their mapped addresses. @value{GDBN} assumes
8506 that any other overlays whose mapped ranges overlap that of
8507 @var{overlay} are now unmapped.
8509 @item overlay unmap-overlay @var{overlay}
8510 @itemx overlay unmap @var{overlay}
8511 @cindex unmap an overlay
8512 Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay}
8513 must be the name of the object file section containing the overlay.
8514 When an overlay is unmapped, @value{GDBN} assumes it can find the
8515 overlay's functions and variables at their load addresses.
8518 Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN}
8519 consults a data structure the overlay manager maintains in the inferior
8520 to see which overlays are mapped. For details, see @ref{Automatic
8523 @item overlay load-target
8525 @cindex reloading the overlay table
8526 Re-read the overlay table from the inferior. Normally, @value{GDBN}
8527 re-reads the table @value{GDBN} automatically each time the inferior
8528 stops, so this command should only be necessary if you have changed the
8529 overlay mapping yourself using @value{GDBN}. This command is only
8530 useful when using automatic overlay debugging.
8532 @item overlay list-overlays
8534 @cindex listing mapped overlays
8535 Display a list of the overlays currently mapped, along with their mapped
8536 addresses, load addresses, and sizes.
8540 Normally, when @value{GDBN} prints a code address, it includes the name
8541 of the function the address falls in:
8544 (@value{GDBP}) print main
8545 $3 = @{int ()@} 0x11a0 <main>
8548 When overlay debugging is enabled, @value{GDBN} recognizes code in
8549 unmapped overlays, and prints the names of unmapped functions with
8550 asterisks around them. For example, if @code{foo} is a function in an
8551 unmapped overlay, @value{GDBN} prints it this way:
8554 (@value{GDBP}) overlay list
8555 No sections are mapped.
8556 (@value{GDBP}) print foo
8557 $5 = @{int (int)@} 0x100000 <*foo*>
8560 When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's
8564 (@value{GDBP}) overlay list
8565 Section .ov.foo.text, loaded at 0x100000 - 0x100034,
8566 mapped at 0x1016 - 0x104a
8567 (@value{GDBP}) print foo
8568 $6 = @{int (int)@} 0x1016 <foo>
8571 When overlay debugging is enabled, @value{GDBN} can find the correct
8572 address for functions and variables in an overlay, whether or not the
8573 overlay is mapped. This allows most @value{GDBN} commands, like
8574 @code{break} and @code{disassemble}, to work normally, even on unmapped
8575 code. However, @value{GDBN}'s breakpoint support has some limitations:
8579 @cindex breakpoints in overlays
8580 @cindex overlays, setting breakpoints in
8581 You can set breakpoints in functions in unmapped overlays, as long as
8582 @value{GDBN} can write to the overlay at its load address.
8584 @value{GDBN} can not set hardware or simulator-based breakpoints in
8585 unmapped overlays. However, if you set a breakpoint at the end of your
8586 overlay manager (and tell @value{GDBN} which overlays are now mapped, if
8587 you are using manual overlay management), @value{GDBN} will re-set its
8588 breakpoints properly.
8592 @node Automatic Overlay Debugging
8593 @section Automatic Overlay Debugging
8594 @cindex automatic overlay debugging
8596 @value{GDBN} can automatically track which overlays are mapped and which
8597 are not, given some simple co-operation from the overlay manager in the
8598 inferior. If you enable automatic overlay debugging with the
8599 @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN}
8600 looks in the inferior's memory for certain variables describing the
8601 current state of the overlays.
8603 Here are the variables your overlay manager must define to support
8604 @value{GDBN}'s automatic overlay debugging:
8608 @item @code{_ovly_table}:
8609 This variable must be an array of the following structures:
8614 /* The overlay's mapped address. */
8617 /* The size of the overlay, in bytes. */
8620 /* The overlay's load address. */
8623 /* Non-zero if the overlay is currently mapped;
8625 unsigned long mapped;
8629 @item @code{_novlys}:
8630 This variable must be a four-byte signed integer, holding the total
8631 number of elements in @code{_ovly_table}.
8635 To decide whether a particular overlay is mapped or not, @value{GDBN}
8636 looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and
8637 @code{lma} members equal the VMA and LMA of the overlay's section in the
8638 executable file. When @value{GDBN} finds a matching entry, it consults
8639 the entry's @code{mapped} member to determine whether the overlay is
8642 In addition, your overlay manager may define a function called
8643 @code{_ovly_debug_event}. If this function is defined, @value{GDBN}
8644 will silently set a breakpoint there. If the overlay manager then
8645 calls this function whenever it has changed the overlay table, this
8646 will enable @value{GDBN} to accurately keep track of which overlays
8647 are in program memory, and update any breakpoints that may be set
8648 in overlays. This will allow breakpoints to work even if the
8649 overlays are kept in ROM or other non-writable memory while they
8650 are not being executed.
8652 @node Overlay Sample Program
8653 @section Overlay Sample Program
8654 @cindex overlay example program
8656 When linking a program which uses overlays, you must place the overlays
8657 at their load addresses, while relocating them to run at their mapped
8658 addresses. To do this, you must write a linker script (@pxref{Overlay
8659 Description,,, ld.info, Using ld: the GNU linker}). Unfortunately,
8660 since linker scripts are specific to a particular host system, target
8661 architecture, and target memory layout, this manual cannot provide
8662 portable sample code demonstrating @value{GDBN}'s overlay support.
8664 However, the @value{GDBN} source distribution does contain an overlaid
8665 program, with linker scripts for a few systems, as part of its test
8666 suite. The program consists of the following files from
8667 @file{gdb/testsuite/gdb.base}:
8671 The main program file.
8673 A simple overlay manager, used by @file{overlays.c}.
8678 Overlay modules, loaded and used by @file{overlays.c}.
8681 Linker scripts for linking the test program on the @code{d10v-elf}
8682 and @code{m32r-elf} targets.
8685 You can build the test program using the @code{d10v-elf} GCC
8686 cross-compiler like this:
8689 $ d10v-elf-gcc -g -c overlays.c
8690 $ d10v-elf-gcc -g -c ovlymgr.c
8691 $ d10v-elf-gcc -g -c foo.c
8692 $ d10v-elf-gcc -g -c bar.c
8693 $ d10v-elf-gcc -g -c baz.c
8694 $ d10v-elf-gcc -g -c grbx.c
8695 $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \
8696 baz.o grbx.o -Wl,-Td10v.ld -o overlays
8699 The build process is identical for any other architecture, except that
8700 you must substitute the appropriate compiler and linker script for the
8701 target system for @code{d10v-elf-gcc} and @code{d10v.ld}.
8705 @chapter Using @value{GDBN} with Different Languages
8708 Although programming languages generally have common aspects, they are
8709 rarely expressed in the same manner. For instance, in ANSI C,
8710 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
8711 Modula-2, it is accomplished by @code{p^}. Values can also be
8712 represented (and displayed) differently. Hex numbers in C appear as
8713 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
8715 @cindex working language
8716 Language-specific information is built into @value{GDBN} for some languages,
8717 allowing you to express operations like the above in your program's
8718 native language, and allowing @value{GDBN} to output values in a manner
8719 consistent with the syntax of your program's native language. The
8720 language you use to build expressions is called the @dfn{working
8724 * Setting:: Switching between source languages
8725 * Show:: Displaying the language
8726 * Checks:: Type and range checks
8727 * Supported Languages:: Supported languages
8728 * Unsupported Languages:: Unsupported languages
8732 @section Switching Between Source Languages
8734 There are two ways to control the working language---either have @value{GDBN}
8735 set it automatically, or select it manually yourself. You can use the
8736 @code{set language} command for either purpose. On startup, @value{GDBN}
8737 defaults to setting the language automatically. The working language is
8738 used to determine how expressions you type are interpreted, how values
8741 In addition to the working language, every source file that
8742 @value{GDBN} knows about has its own working language. For some object
8743 file formats, the compiler might indicate which language a particular
8744 source file is in. However, most of the time @value{GDBN} infers the
8745 language from the name of the file. The language of a source file
8746 controls whether C@t{++} names are demangled---this way @code{backtrace} can
8747 show each frame appropriately for its own language. There is no way to
8748 set the language of a source file from within @value{GDBN}, but you can
8749 set the language associated with a filename extension. @xref{Show, ,
8750 Displaying the Language}.
8752 This is most commonly a problem when you use a program, such
8753 as @code{cfront} or @code{f2c}, that generates C but is written in
8754 another language. In that case, make the
8755 program use @code{#line} directives in its C output; that way
8756 @value{GDBN} will know the correct language of the source code of the original
8757 program, and will display that source code, not the generated C code.
8760 * Filenames:: Filename extensions and languages.
8761 * Manually:: Setting the working language manually
8762 * Automatically:: Having @value{GDBN} infer the source language
8766 @subsection List of Filename Extensions and Languages
8768 If a source file name ends in one of the following extensions, then
8769 @value{GDBN} infers that its language is the one indicated.
8790 Objective-C source file
8797 Modula-2 source file
8801 Assembler source file. This actually behaves almost like C, but
8802 @value{GDBN} does not skip over function prologues when stepping.
8805 In addition, you may set the language associated with a filename
8806 extension. @xref{Show, , Displaying the Language}.
8809 @subsection Setting the Working Language
8811 If you allow @value{GDBN} to set the language automatically,
8812 expressions are interpreted the same way in your debugging session and
8815 @kindex set language
8816 If you wish, you may set the language manually. To do this, issue the
8817 command @samp{set language @var{lang}}, where @var{lang} is the name of
8819 @code{c} or @code{modula-2}.
8820 For a list of the supported languages, type @samp{set language}.
8822 Setting the language manually prevents @value{GDBN} from updating the working
8823 language automatically. This can lead to confusion if you try
8824 to debug a program when the working language is not the same as the
8825 source language, when an expression is acceptable to both
8826 languages---but means different things. For instance, if the current
8827 source file were written in C, and @value{GDBN} was parsing Modula-2, a
8835 might not have the effect you intended. In C, this means to add
8836 @code{b} and @code{c} and place the result in @code{a}. The result
8837 printed would be the value of @code{a}. In Modula-2, this means to compare
8838 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
8841 @subsection Having @value{GDBN} Infer the Source Language
8843 To have @value{GDBN} set the working language automatically, use
8844 @samp{set language local} or @samp{set language auto}. @value{GDBN}
8845 then infers the working language. That is, when your program stops in a
8846 frame (usually by encountering a breakpoint), @value{GDBN} sets the
8847 working language to the language recorded for the function in that
8848 frame. If the language for a frame is unknown (that is, if the function
8849 or block corresponding to the frame was defined in a source file that
8850 does not have a recognized extension), the current working language is
8851 not changed, and @value{GDBN} issues a warning.
8853 This may not seem necessary for most programs, which are written
8854 entirely in one source language. However, program modules and libraries
8855 written in one source language can be used by a main program written in
8856 a different source language. Using @samp{set language auto} in this
8857 case frees you from having to set the working language manually.
8860 @section Displaying the Language
8862 The following commands help you find out which language is the
8863 working language, and also what language source files were written in.
8867 @kindex show language
8868 Display the current working language. This is the
8869 language you can use with commands such as @code{print} to
8870 build and compute expressions that may involve variables in your program.
8873 @kindex info frame@r{, show the source language}
8874 Display the source language for this frame. This language becomes the
8875 working language if you use an identifier from this frame.
8876 @xref{Frame Info, ,Information about a Frame}, to identify the other
8877 information listed here.
8880 @kindex info source@r{, show the source language}
8881 Display the source language of this source file.
8882 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
8883 information listed here.
8886 In unusual circumstances, you may have source files with extensions
8887 not in the standard list. You can then set the extension associated
8888 with a language explicitly:
8891 @item set extension-language @var{ext} @var{language}
8892 @kindex set extension-language
8893 Tell @value{GDBN} that source files with extension @var{ext} are to be
8894 assumed as written in the source language @var{language}.
8896 @item info extensions
8897 @kindex info extensions
8898 List all the filename extensions and the associated languages.
8902 @section Type and Range Checking
8905 @emph{Warning:} In this release, the @value{GDBN} commands for type and range
8906 checking are included, but they do not yet have any effect. This
8907 section documents the intended facilities.
8909 @c FIXME remove warning when type/range code added
8911 Some languages are designed to guard you against making seemingly common
8912 errors through a series of compile- and run-time checks. These include
8913 checking the type of arguments to functions and operators, and making
8914 sure mathematical overflows are caught at run time. Checks such as
8915 these help to ensure a program's correctness once it has been compiled
8916 by eliminating type mismatches, and providing active checks for range
8917 errors when your program is running.
8919 @value{GDBN} can check for conditions like the above if you wish.
8920 Although @value{GDBN} does not check the statements in your program,
8921 it can check expressions entered directly into @value{GDBN} for
8922 evaluation via the @code{print} command, for example. As with the
8923 working language, @value{GDBN} can also decide whether or not to check
8924 automatically based on your program's source language.
8925 @xref{Supported Languages, ,Supported Languages}, for the default
8926 settings of supported languages.
8929 * Type Checking:: An overview of type checking
8930 * Range Checking:: An overview of range checking
8933 @cindex type checking
8934 @cindex checks, type
8936 @subsection An Overview of Type Checking
8938 Some languages, such as Modula-2, are strongly typed, meaning that the
8939 arguments to operators and functions have to be of the correct type,
8940 otherwise an error occurs. These checks prevent type mismatch
8941 errors from ever causing any run-time problems. For example,
8949 The second example fails because the @code{CARDINAL} 1 is not
8950 type-compatible with the @code{REAL} 2.3.
8952 For the expressions you use in @value{GDBN} commands, you can tell the
8953 @value{GDBN} type checker to skip checking;
8954 to treat any mismatches as errors and abandon the expression;
8955 or to only issue warnings when type mismatches occur,
8956 but evaluate the expression anyway. When you choose the last of
8957 these, @value{GDBN} evaluates expressions like the second example above, but
8958 also issues a warning.
8960 Even if you turn type checking off, there may be other reasons
8961 related to type that prevent @value{GDBN} from evaluating an expression.
8962 For instance, @value{GDBN} does not know how to add an @code{int} and
8963 a @code{struct foo}. These particular type errors have nothing to do
8964 with the language in use, and usually arise from expressions, such as
8965 the one described above, which make little sense to evaluate anyway.
8967 Each language defines to what degree it is strict about type. For
8968 instance, both Modula-2 and C require the arguments to arithmetical
8969 operators to be numbers. In C, enumerated types and pointers can be
8970 represented as numbers, so that they are valid arguments to mathematical
8971 operators. @xref{Supported Languages, ,Supported Languages}, for further
8972 details on specific languages.
8974 @value{GDBN} provides some additional commands for controlling the type checker:
8976 @kindex set check type
8977 @kindex show check type
8979 @item set check type auto
8980 Set type checking on or off based on the current working language.
8981 @xref{Supported Languages, ,Supported Languages}, for the default settings for
8984 @item set check type on
8985 @itemx set check type off
8986 Set type checking on or off, overriding the default setting for the
8987 current working language. Issue a warning if the setting does not
8988 match the language default. If any type mismatches occur in
8989 evaluating an expression while type checking is on, @value{GDBN} prints a
8990 message and aborts evaluation of the expression.
8992 @item set check type warn
8993 Cause the type checker to issue warnings, but to always attempt to
8994 evaluate the expression. Evaluating the expression may still
8995 be impossible for other reasons. For example, @value{GDBN} cannot add
8996 numbers and structures.
8999 Show the current setting of the type checker, and whether or not @value{GDBN}
9000 is setting it automatically.
9003 @cindex range checking
9004 @cindex checks, range
9005 @node Range Checking
9006 @subsection An Overview of Range Checking
9008 In some languages (such as Modula-2), it is an error to exceed the
9009 bounds of a type; this is enforced with run-time checks. Such range
9010 checking is meant to ensure program correctness by making sure
9011 computations do not overflow, or indices on an array element access do
9012 not exceed the bounds of the array.
9014 For expressions you use in @value{GDBN} commands, you can tell
9015 @value{GDBN} to treat range errors in one of three ways: ignore them,
9016 always treat them as errors and abandon the expression, or issue
9017 warnings but evaluate the expression anyway.
9019 A range error can result from numerical overflow, from exceeding an
9020 array index bound, or when you type a constant that is not a member
9021 of any type. Some languages, however, do not treat overflows as an
9022 error. In many implementations of C, mathematical overflow causes the
9023 result to ``wrap around'' to lower values---for example, if @var{m} is
9024 the largest integer value, and @var{s} is the smallest, then
9027 @var{m} + 1 @result{} @var{s}
9030 This, too, is specific to individual languages, and in some cases
9031 specific to individual compilers or machines. @xref{Supported Languages, ,
9032 Supported Languages}, for further details on specific languages.
9034 @value{GDBN} provides some additional commands for controlling the range checker:
9036 @kindex set check range
9037 @kindex show check range
9039 @item set check range auto
9040 Set range checking on or off based on the current working language.
9041 @xref{Supported Languages, ,Supported Languages}, for the default settings for
9044 @item set check range on
9045 @itemx set check range off
9046 Set range checking on or off, overriding the default setting for the
9047 current working language. A warning is issued if the setting does not
9048 match the language default. If a range error occurs and range checking is on,
9049 then a message is printed and evaluation of the expression is aborted.
9051 @item set check range warn
9052 Output messages when the @value{GDBN} range checker detects a range error,
9053 but attempt to evaluate the expression anyway. Evaluating the
9054 expression may still be impossible for other reasons, such as accessing
9055 memory that the process does not own (a typical example from many Unix
9059 Show the current setting of the range checker, and whether or not it is
9060 being set automatically by @value{GDBN}.
9063 @node Supported Languages
9064 @section Supported Languages
9066 @value{GDBN} supports C, C@t{++}, Objective-C, Fortran, Java, Pascal,
9067 assembly, Modula-2, and Ada.
9068 @c This is false ...
9069 Some @value{GDBN} features may be used in expressions regardless of the
9070 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
9071 and the @samp{@{type@}addr} construct (@pxref{Expressions,
9072 ,Expressions}) can be used with the constructs of any supported
9075 The following sections detail to what degree each source language is
9076 supported by @value{GDBN}. These sections are not meant to be language
9077 tutorials or references, but serve only as a reference guide to what the
9078 @value{GDBN} expression parser accepts, and what input and output
9079 formats should look like for different languages. There are many good
9080 books written on each of these languages; please look to these for a
9081 language reference or tutorial.
9085 * Objective-C:: Objective-C
9088 * Modula-2:: Modula-2
9093 @subsection C and C@t{++}
9095 @cindex C and C@t{++}
9096 @cindex expressions in C or C@t{++}
9098 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
9099 to both languages. Whenever this is the case, we discuss those languages
9103 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
9104 @cindex @sc{gnu} C@t{++}
9105 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
9106 compiler and @value{GDBN}. Therefore, to debug your C@t{++} code
9107 effectively, you must compile your C@t{++} programs with a supported
9108 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
9109 compiler (@code{aCC}).
9111 For best results when using @sc{gnu} C@t{++}, use the DWARF 2 debugging
9112 format; if it doesn't work on your system, try the stabs+ debugging
9113 format. You can select those formats explicitly with the @code{g++}
9114 command-line options @option{-gdwarf-2} and @option{-gstabs+}.
9115 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
9116 gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}.
9119 * C Operators:: C and C@t{++} operators
9120 * C Constants:: C and C@t{++} constants
9121 * C Plus Plus Expressions:: C@t{++} expressions
9122 * C Defaults:: Default settings for C and C@t{++}
9123 * C Checks:: C and C@t{++} type and range checks
9124 * Debugging C:: @value{GDBN} and C
9125 * Debugging C Plus Plus:: @value{GDBN} features for C@t{++}
9129 @subsubsection C and C@t{++} Operators
9131 @cindex C and C@t{++} operators
9133 Operators must be defined on values of specific types. For instance,
9134 @code{+} is defined on numbers, but not on structures. Operators are
9135 often defined on groups of types.
9137 For the purposes of C and C@t{++}, the following definitions hold:
9142 @emph{Integral types} include @code{int} with any of its storage-class
9143 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
9146 @emph{Floating-point types} include @code{float}, @code{double}, and
9147 @code{long double} (if supported by the target platform).
9150 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
9153 @emph{Scalar types} include all of the above.
9158 The following operators are supported. They are listed here
9159 in order of increasing precedence:
9163 The comma or sequencing operator. Expressions in a comma-separated list
9164 are evaluated from left to right, with the result of the entire
9165 expression being the last expression evaluated.
9168 Assignment. The value of an assignment expression is the value
9169 assigned. Defined on scalar types.
9172 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
9173 and translated to @w{@code{@var{a} = @var{a op b}}}.
9174 @w{@code{@var{op}=}} and @code{=} have the same precedence.
9175 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
9176 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
9179 The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought
9180 of as: if @var{a} then @var{b} else @var{c}. @var{a} should be of an
9184 Logical @sc{or}. Defined on integral types.
9187 Logical @sc{and}. Defined on integral types.
9190 Bitwise @sc{or}. Defined on integral types.
9193 Bitwise exclusive-@sc{or}. Defined on integral types.
9196 Bitwise @sc{and}. Defined on integral types.
9199 Equality and inequality. Defined on scalar types. The value of these
9200 expressions is 0 for false and non-zero for true.
9202 @item <@r{, }>@r{, }<=@r{, }>=
9203 Less than, greater than, less than or equal, greater than or equal.
9204 Defined on scalar types. The value of these expressions is 0 for false
9205 and non-zero for true.
9208 left shift, and right shift. Defined on integral types.
9211 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
9214 Addition and subtraction. Defined on integral types, floating-point types and
9217 @item *@r{, }/@r{, }%
9218 Multiplication, division, and modulus. Multiplication and division are
9219 defined on integral and floating-point types. Modulus is defined on
9223 Increment and decrement. When appearing before a variable, the
9224 operation is performed before the variable is used in an expression;
9225 when appearing after it, the variable's value is used before the
9226 operation takes place.
9229 Pointer dereferencing. Defined on pointer types. Same precedence as
9233 Address operator. Defined on variables. Same precedence as @code{++}.
9235 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
9236 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
9237 (or, if you prefer, simply @samp{&&@var{ref}}) to examine the address
9238 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
9242 Negative. Defined on integral and floating-point types. Same
9243 precedence as @code{++}.
9246 Logical negation. Defined on integral types. Same precedence as
9250 Bitwise complement operator. Defined on integral types. Same precedence as
9255 Structure member, and pointer-to-structure member. For convenience,
9256 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
9257 pointer based on the stored type information.
9258 Defined on @code{struct} and @code{union} data.
9261 Dereferences of pointers to members.
9264 Array indexing. @code{@var{a}[@var{i}]} is defined as
9265 @code{*(@var{a}+@var{i})}. Same precedence as @code{->}.
9268 Function parameter list. Same precedence as @code{->}.
9271 C@t{++} scope resolution operator. Defined on @code{struct}, @code{union},
9272 and @code{class} types.
9275 Doubled colons also represent the @value{GDBN} scope operator
9276 (@pxref{Expressions, ,Expressions}). Same precedence as @code{::},
9280 If an operator is redefined in the user code, @value{GDBN} usually
9281 attempts to invoke the redefined version instead of using the operator's
9285 @subsubsection C and C@t{++} Constants
9287 @cindex C and C@t{++} constants
9289 @value{GDBN} allows you to express the constants of C and C@t{++} in the
9294 Integer constants are a sequence of digits. Octal constants are
9295 specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants
9296 by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter
9297 @samp{l}, specifying that the constant should be treated as a
9301 Floating point constants are a sequence of digits, followed by a decimal
9302 point, followed by a sequence of digits, and optionally followed by an
9303 exponent. An exponent is of the form:
9304 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
9305 sequence of digits. The @samp{+} is optional for positive exponents.
9306 A floating-point constant may also end with a letter @samp{f} or
9307 @samp{F}, specifying that the constant should be treated as being of
9308 the @code{float} (as opposed to the default @code{double}) type; or with
9309 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
9313 Enumerated constants consist of enumerated identifiers, or their
9314 integral equivalents.
9317 Character constants are a single character surrounded by single quotes
9318 (@code{'}), or a number---the ordinal value of the corresponding character
9319 (usually its @sc{ascii} value). Within quotes, the single character may
9320 be represented by a letter or by @dfn{escape sequences}, which are of
9321 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
9322 of the character's ordinal value; or of the form @samp{\@var{x}}, where
9323 @samp{@var{x}} is a predefined special character---for example,
9324 @samp{\n} for newline.
9327 String constants are a sequence of character constants surrounded by
9328 double quotes (@code{"}). Any valid character constant (as described
9329 above) may appear. Double quotes within the string must be preceded by
9330 a backslash, so for instance @samp{"a\"b'c"} is a string of five
9334 Pointer constants are an integral value. You can also write pointers
9335 to constants using the C operator @samp{&}.
9338 Array constants are comma-separated lists surrounded by braces @samp{@{}
9339 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
9340 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
9341 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
9344 @node C Plus Plus Expressions
9345 @subsubsection C@t{++} Expressions
9347 @cindex expressions in C@t{++}
9348 @value{GDBN} expression handling can interpret most C@t{++} expressions.
9350 @cindex debugging C@t{++} programs
9351 @cindex C@t{++} compilers
9352 @cindex debug formats and C@t{++}
9353 @cindex @value{NGCC} and C@t{++}
9355 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use the
9356 proper compiler and the proper debug format. Currently, @value{GDBN}
9357 works best when debugging C@t{++} code that is compiled with
9358 @value{NGCC} 2.95.3 or with @value{NGCC} 3.1 or newer, using the options
9359 @option{-gdwarf-2} or @option{-gstabs+}. DWARF 2 is preferred over
9360 stabs+. Most configurations of @value{NGCC} emit either DWARF 2 or
9361 stabs+ as their default debug format, so you usually don't need to
9362 specify a debug format explicitly. Other compilers and/or debug formats
9363 are likely to work badly or not at all when using @value{GDBN} to debug
9369 @cindex member functions
9371 Member function calls are allowed; you can use expressions like
9374 count = aml->GetOriginal(x, y)
9377 @vindex this@r{, inside C@t{++} member functions}
9378 @cindex namespace in C@t{++}
9380 While a member function is active (in the selected stack frame), your
9381 expressions have the same namespace available as the member function;
9382 that is, @value{GDBN} allows implicit references to the class instance
9383 pointer @code{this} following the same rules as C@t{++}.
9385 @cindex call overloaded functions
9386 @cindex overloaded functions, calling
9387 @cindex type conversions in C@t{++}
9389 You can call overloaded functions; @value{GDBN} resolves the function
9390 call to the right definition, with some restrictions. @value{GDBN} does not
9391 perform overload resolution involving user-defined type conversions,
9392 calls to constructors, or instantiations of templates that do not exist
9393 in the program. It also cannot handle ellipsis argument lists or
9396 It does perform integral conversions and promotions, floating-point
9397 promotions, arithmetic conversions, pointer conversions, conversions of
9398 class objects to base classes, and standard conversions such as those of
9399 functions or arrays to pointers; it requires an exact match on the
9400 number of function arguments.
9402 Overload resolution is always performed, unless you have specified
9403 @code{set overload-resolution off}. @xref{Debugging C Plus Plus,
9404 ,@value{GDBN} Features for C@t{++}}.
9406 You must specify @code{set overload-resolution off} in order to use an
9407 explicit function signature to call an overloaded function, as in
9409 p 'foo(char,int)'('x', 13)
9412 The @value{GDBN} command-completion facility can simplify this;
9413 see @ref{Completion, ,Command Completion}.
9415 @cindex reference declarations
9417 @value{GDBN} understands variables declared as C@t{++} references; you can use
9418 them in expressions just as you do in C@t{++} source---they are automatically
9421 In the parameter list shown when @value{GDBN} displays a frame, the values of
9422 reference variables are not displayed (unlike other variables); this
9423 avoids clutter, since references are often used for large structures.
9424 The @emph{address} of a reference variable is always shown, unless
9425 you have specified @samp{set print address off}.
9428 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
9429 expressions can use it just as expressions in your program do. Since
9430 one scope may be defined in another, you can use @code{::} repeatedly if
9431 necessary, for example in an expression like
9432 @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows
9433 resolving name scope by reference to source files, in both C and C@t{++}
9434 debugging (@pxref{Variables, ,Program Variables}).
9437 In addition, when used with HP's C@t{++} compiler, @value{GDBN} supports
9438 calling virtual functions correctly, printing out virtual bases of
9439 objects, calling functions in a base subobject, casting objects, and
9440 invoking user-defined operators.
9443 @subsubsection C and C@t{++} Defaults
9445 @cindex C and C@t{++} defaults
9447 If you allow @value{GDBN} to set type and range checking automatically, they
9448 both default to @code{off} whenever the working language changes to
9449 C or C@t{++}. This happens regardless of whether you or @value{GDBN}
9450 selects the working language.
9452 If you allow @value{GDBN} to set the language automatically, it
9453 recognizes source files whose names end with @file{.c}, @file{.C}, or
9454 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
9455 these files, it sets the working language to C or C@t{++}.
9456 @xref{Automatically, ,Having @value{GDBN} Infer the Source Language},
9457 for further details.
9459 @c Type checking is (a) primarily motivated by Modula-2, and (b)
9460 @c unimplemented. If (b) changes, it might make sense to let this node
9461 @c appear even if Mod-2 does not, but meanwhile ignore it. roland 16jul93.
9464 @subsubsection C and C@t{++} Type and Range Checks
9466 @cindex C and C@t{++} checks
9468 By default, when @value{GDBN} parses C or C@t{++} expressions, type checking
9469 is not used. However, if you turn type checking on, @value{GDBN}
9470 considers two variables type equivalent if:
9474 The two variables are structured and have the same structure, union, or
9478 The two variables have the same type name, or types that have been
9479 declared equivalent through @code{typedef}.
9482 @c leaving this out because neither J Gilmore nor R Pesch understand it.
9485 The two @code{struct}, @code{union}, or @code{enum} variables are
9486 declared in the same declaration. (Note: this may not be true for all C
9491 Range checking, if turned on, is done on mathematical operations. Array
9492 indices are not checked, since they are often used to index a pointer
9493 that is not itself an array.
9496 @subsubsection @value{GDBN} and C
9498 The @code{set print union} and @code{show print union} commands apply to
9499 the @code{union} type. When set to @samp{on}, any @code{union} that is
9500 inside a @code{struct} or @code{class} is also printed. Otherwise, it
9501 appears as @samp{@{...@}}.
9503 The @code{@@} operator aids in the debugging of dynamic arrays, formed
9504 with pointers and a memory allocation function. @xref{Expressions,
9507 @node Debugging C Plus Plus
9508 @subsubsection @value{GDBN} Features for C@t{++}
9510 @cindex commands for C@t{++}
9512 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
9513 designed specifically for use with C@t{++}. Here is a summary:
9516 @cindex break in overloaded functions
9517 @item @r{breakpoint menus}
9518 When you want a breakpoint in a function whose name is overloaded,
9519 @value{GDBN} breakpoint menus help you specify which function definition
9520 you want. @xref{Breakpoint Menus,,Breakpoint Menus}.
9522 @cindex overloading in C@t{++}
9523 @item rbreak @var{regex}
9524 Setting breakpoints using regular expressions is helpful for setting
9525 breakpoints on overloaded functions that are not members of any special
9527 @xref{Set Breaks, ,Setting Breakpoints}.
9529 @cindex C@t{++} exception handling
9532 Debug C@t{++} exception handling using these commands. @xref{Set
9533 Catchpoints, , Setting Catchpoints}.
9536 @item ptype @var{typename}
9537 Print inheritance relationships as well as other information for type
9539 @xref{Symbols, ,Examining the Symbol Table}.
9541 @cindex C@t{++} symbol display
9542 @item set print demangle
9543 @itemx show print demangle
9544 @itemx set print asm-demangle
9545 @itemx show print asm-demangle
9546 Control whether C@t{++} symbols display in their source form, both when
9547 displaying code as C@t{++} source and when displaying disassemblies.
9548 @xref{Print Settings, ,Print Settings}.
9550 @item set print object
9551 @itemx show print object
9552 Choose whether to print derived (actual) or declared types of objects.
9553 @xref{Print Settings, ,Print Settings}.
9555 @item set print vtbl
9556 @itemx show print vtbl
9557 Control the format for printing virtual function tables.
9558 @xref{Print Settings, ,Print Settings}.
9559 (The @code{vtbl} commands do not work on programs compiled with the HP
9560 ANSI C@t{++} compiler (@code{aCC}).)
9562 @kindex set overload-resolution
9563 @cindex overloaded functions, overload resolution
9564 @item set overload-resolution on
9565 Enable overload resolution for C@t{++} expression evaluation. The default
9566 is on. For overloaded functions, @value{GDBN} evaluates the arguments
9567 and searches for a function whose signature matches the argument types,
9568 using the standard C@t{++} conversion rules (see @ref{C Plus Plus
9569 Expressions, ,C@t{++} Expressions}, for details).
9570 If it cannot find a match, it emits a message.
9572 @item set overload-resolution off
9573 Disable overload resolution for C@t{++} expression evaluation. For
9574 overloaded functions that are not class member functions, @value{GDBN}
9575 chooses the first function of the specified name that it finds in the
9576 symbol table, whether or not its arguments are of the correct type. For
9577 overloaded functions that are class member functions, @value{GDBN}
9578 searches for a function whose signature @emph{exactly} matches the
9581 @kindex show overload-resolution
9582 @item show overload-resolution
9583 Show the current setting of overload resolution.
9585 @item @r{Overloaded symbol names}
9586 You can specify a particular definition of an overloaded symbol, using
9587 the same notation that is used to declare such symbols in C@t{++}: type
9588 @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can
9589 also use the @value{GDBN} command-line word completion facilities to list the
9590 available choices, or to finish the type list for you.
9591 @xref{Completion,, Command Completion}, for details on how to do this.
9595 @subsection Objective-C
9598 This section provides information about some commands and command
9599 options that are useful for debugging Objective-C code. See also
9600 @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a
9601 few more commands specific to Objective-C support.
9604 * Method Names in Commands::
9605 * The Print Command with Objective-C::
9608 @node Method Names in Commands
9609 @subsubsection Method Names in Commands
9611 The following commands have been extended to accept Objective-C method
9612 names as line specifications:
9614 @kindex clear@r{, and Objective-C}
9615 @kindex break@r{, and Objective-C}
9616 @kindex info line@r{, and Objective-C}
9617 @kindex jump@r{, and Objective-C}
9618 @kindex list@r{, and Objective-C}
9622 @item @code{info line}
9627 A fully qualified Objective-C method name is specified as
9630 -[@var{Class} @var{methodName}]
9633 where the minus sign is used to indicate an instance method and a
9634 plus sign (not shown) is used to indicate a class method. The class
9635 name @var{Class} and method name @var{methodName} are enclosed in
9636 brackets, similar to the way messages are specified in Objective-C
9637 source code. For example, to set a breakpoint at the @code{create}
9638 instance method of class @code{Fruit} in the program currently being
9642 break -[Fruit create]
9645 To list ten program lines around the @code{initialize} class method,
9649 list +[NSText initialize]
9652 In the current version of @value{GDBN}, the plus or minus sign is
9653 required. In future versions of @value{GDBN}, the plus or minus
9654 sign will be optional, but you can use it to narrow the search. It
9655 is also possible to specify just a method name:
9661 You must specify the complete method name, including any colons. If
9662 your program's source files contain more than one @code{create} method,
9663 you'll be presented with a numbered list of classes that implement that
9664 method. Indicate your choice by number, or type @samp{0} to exit if
9667 As another example, to clear a breakpoint established at the
9668 @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter:
9671 clear -[NSWindow makeKeyAndOrderFront:]
9674 @node The Print Command with Objective-C
9675 @subsubsection The Print Command With Objective-C
9676 @cindex Objective-C, print objects
9677 @kindex print-object
9678 @kindex po @r{(@code{print-object})}
9680 The print command has also been extended to accept methods. For example:
9683 print -[@var{object} hash]
9686 @cindex print an Objective-C object description
9687 @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects
9689 will tell @value{GDBN} to send the @code{hash} message to @var{object}
9690 and print the result. Also, an additional command has been added,
9691 @code{print-object} or @code{po} for short, which is meant to print
9692 the description of an object. However, this command may only work
9693 with certain Objective-C libraries that have a particular hook
9694 function, @code{_NSPrintForDebugger}, defined.
9698 @cindex Fortran-specific support in @value{GDBN}
9700 @value{GDBN} can be used to debug programs written in Fortran, but it
9701 currently supports only the features of Fortran 77 language.
9703 @cindex trailing underscore, in Fortran symbols
9704 Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers
9705 among them) append an underscore to the names of variables and
9706 functions. When you debug programs compiled by those compilers, you
9707 will need to refer to variables and functions with a trailing
9711 * Fortran Operators:: Fortran operators and expressions
9712 * Fortran Defaults:: Default settings for Fortran
9713 * Special Fortran Commands:: Special @value{GDBN} commands for Fortran
9716 @node Fortran Operators
9717 @subsubsection Fortran Operators and Expressions
9719 @cindex Fortran operators and expressions
9721 Operators must be defined on values of specific types. For instance,
9722 @code{+} is defined on numbers, but not on characters or other non-
9723 arithmetic types. Operators are often defined on groups of types.
9727 The exponentiation operator. It raises the first operand to the power
9731 The range operator. Normally used in the form of array(low:high) to
9732 represent a section of array.
9735 @node Fortran Defaults
9736 @subsubsection Fortran Defaults
9738 @cindex Fortran Defaults
9740 Fortran symbols are usually case-insensitive, so @value{GDBN} by
9741 default uses case-insensitive matches for Fortran symbols. You can
9742 change that with the @samp{set case-insensitive} command, see
9743 @ref{Symbols}, for the details.
9745 @node Special Fortran Commands
9746 @subsubsection Special Fortran Commands
9748 @cindex Special Fortran commands
9750 @value{GDBN} has some commands to support Fortran-specific features,
9751 such as displaying common blocks.
9754 @cindex @code{COMMON} blocks, Fortran
9756 @item info common @r{[}@var{common-name}@r{]}
9757 This command prints the values contained in the Fortran @code{COMMON}
9758 block whose name is @var{common-name}. With no argument, the names of
9759 all @code{COMMON} blocks visible at the current program location are
9766 @cindex Pascal support in @value{GDBN}, limitations
9767 Debugging Pascal programs which use sets, subranges, file variables, or
9768 nested functions does not currently work. @value{GDBN} does not support
9769 entering expressions, printing values, or similar features using Pascal
9772 The Pascal-specific command @code{set print pascal_static-members}
9773 controls whether static members of Pascal objects are displayed.
9774 @xref{Print Settings, pascal_static-members}.
9777 @subsection Modula-2
9779 @cindex Modula-2, @value{GDBN} support
9781 The extensions made to @value{GDBN} to support Modula-2 only support
9782 output from the @sc{gnu} Modula-2 compiler (which is currently being
9783 developed). Other Modula-2 compilers are not currently supported, and
9784 attempting to debug executables produced by them is most likely
9785 to give an error as @value{GDBN} reads in the executable's symbol
9788 @cindex expressions in Modula-2
9790 * M2 Operators:: Built-in operators
9791 * Built-In Func/Proc:: Built-in functions and procedures
9792 * M2 Constants:: Modula-2 constants
9793 * M2 Types:: Modula-2 types
9794 * M2 Defaults:: Default settings for Modula-2
9795 * Deviations:: Deviations from standard Modula-2
9796 * M2 Checks:: Modula-2 type and range checks
9797 * M2 Scope:: The scope operators @code{::} and @code{.}
9798 * GDB/M2:: @value{GDBN} and Modula-2
9802 @subsubsection Operators
9803 @cindex Modula-2 operators
9805 Operators must be defined on values of specific types. For instance,
9806 @code{+} is defined on numbers, but not on structures. Operators are
9807 often defined on groups of types. For the purposes of Modula-2, the
9808 following definitions hold:
9813 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
9817 @emph{Character types} consist of @code{CHAR} and its subranges.
9820 @emph{Floating-point types} consist of @code{REAL}.
9823 @emph{Pointer types} consist of anything declared as @code{POINTER TO
9827 @emph{Scalar types} consist of all of the above.
9830 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
9833 @emph{Boolean types} consist of @code{BOOLEAN}.
9837 The following operators are supported, and appear in order of
9838 increasing precedence:
9842 Function argument or array index separator.
9845 Assignment. The value of @var{var} @code{:=} @var{value} is
9849 Less than, greater than on integral, floating-point, or enumerated
9853 Less than or equal to, greater than or equal to
9854 on integral, floating-point and enumerated types, or set inclusion on
9855 set types. Same precedence as @code{<}.
9857 @item =@r{, }<>@r{, }#
9858 Equality and two ways of expressing inequality, valid on scalar types.
9859 Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is
9860 available for inequality, since @code{#} conflicts with the script
9864 Set membership. Defined on set types and the types of their members.
9865 Same precedence as @code{<}.
9868 Boolean disjunction. Defined on boolean types.
9871 Boolean conjunction. Defined on boolean types.
9874 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
9877 Addition and subtraction on integral and floating-point types, or union
9878 and difference on set types.
9881 Multiplication on integral and floating-point types, or set intersection
9885 Division on floating-point types, or symmetric set difference on set
9886 types. Same precedence as @code{*}.
9889 Integer division and remainder. Defined on integral types. Same
9890 precedence as @code{*}.
9893 Negative. Defined on @code{INTEGER} and @code{REAL} data.
9896 Pointer dereferencing. Defined on pointer types.
9899 Boolean negation. Defined on boolean types. Same precedence as
9903 @code{RECORD} field selector. Defined on @code{RECORD} data. Same
9904 precedence as @code{^}.
9907 Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}.
9910 Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence
9914 @value{GDBN} and Modula-2 scope operators.
9918 @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN}
9919 treats the use of the operator @code{IN}, or the use of operators
9920 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
9921 @code{<=}, and @code{>=} on sets as an error.
9925 @node Built-In Func/Proc
9926 @subsubsection Built-in Functions and Procedures
9927 @cindex Modula-2 built-ins
9929 Modula-2 also makes available several built-in procedures and functions.
9930 In describing these, the following metavariables are used:
9935 represents an @code{ARRAY} variable.
9938 represents a @code{CHAR} constant or variable.
9941 represents a variable or constant of integral type.
9944 represents an identifier that belongs to a set. Generally used in the
9945 same function with the metavariable @var{s}. The type of @var{s} should
9946 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
9949 represents a variable or constant of integral or floating-point type.
9952 represents a variable or constant of floating-point type.
9958 represents a variable.
9961 represents a variable or constant of one of many types. See the
9962 explanation of the function for details.
9965 All Modula-2 built-in procedures also return a result, described below.
9969 Returns the absolute value of @var{n}.
9972 If @var{c} is a lower case letter, it returns its upper case
9973 equivalent, otherwise it returns its argument.
9976 Returns the character whose ordinal value is @var{i}.
9979 Decrements the value in the variable @var{v} by one. Returns the new value.
9981 @item DEC(@var{v},@var{i})
9982 Decrements the value in the variable @var{v} by @var{i}. Returns the
9985 @item EXCL(@var{m},@var{s})
9986 Removes the element @var{m} from the set @var{s}. Returns the new
9989 @item FLOAT(@var{i})
9990 Returns the floating point equivalent of the integer @var{i}.
9993 Returns the index of the last member of @var{a}.
9996 Increments the value in the variable @var{v} by one. Returns the new value.
9998 @item INC(@var{v},@var{i})
9999 Increments the value in the variable @var{v} by @var{i}. Returns the
10002 @item INCL(@var{m},@var{s})
10003 Adds the element @var{m} to the set @var{s} if it is not already
10004 there. Returns the new set.
10007 Returns the maximum value of the type @var{t}.
10010 Returns the minimum value of the type @var{t}.
10013 Returns boolean TRUE if @var{i} is an odd number.
10016 Returns the ordinal value of its argument. For example, the ordinal
10017 value of a character is its @sc{ascii} value (on machines supporting the
10018 @sc{ascii} character set). @var{x} must be of an ordered type, which include
10019 integral, character and enumerated types.
10021 @item SIZE(@var{x})
10022 Returns the size of its argument. @var{x} can be a variable or a type.
10024 @item TRUNC(@var{r})
10025 Returns the integral part of @var{r}.
10027 @item TSIZE(@var{x})
10028 Returns the size of its argument. @var{x} can be a variable or a type.
10030 @item VAL(@var{t},@var{i})
10031 Returns the member of the type @var{t} whose ordinal value is @var{i}.
10035 @emph{Warning:} Sets and their operations are not yet supported, so
10036 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
10040 @cindex Modula-2 constants
10042 @subsubsection Constants
10044 @value{GDBN} allows you to express the constants of Modula-2 in the following
10050 Integer constants are simply a sequence of digits. When used in an
10051 expression, a constant is interpreted to be type-compatible with the
10052 rest of the expression. Hexadecimal integers are specified by a
10053 trailing @samp{H}, and octal integers by a trailing @samp{B}.
10056 Floating point constants appear as a sequence of digits, followed by a
10057 decimal point and another sequence of digits. An optional exponent can
10058 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
10059 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the
10060 digits of the floating point constant must be valid decimal (base 10)
10064 Character constants consist of a single character enclosed by a pair of
10065 like quotes, either single (@code{'}) or double (@code{"}). They may
10066 also be expressed by their ordinal value (their @sc{ascii} value, usually)
10067 followed by a @samp{C}.
10070 String constants consist of a sequence of characters enclosed by a
10071 pair of like quotes, either single (@code{'}) or double (@code{"}).
10072 Escape sequences in the style of C are also allowed. @xref{C
10073 Constants, ,C and C@t{++} Constants}, for a brief explanation of escape
10077 Enumerated constants consist of an enumerated identifier.
10080 Boolean constants consist of the identifiers @code{TRUE} and
10084 Pointer constants consist of integral values only.
10087 Set constants are not yet supported.
10091 @subsubsection Modula-2 Types
10092 @cindex Modula-2 types
10094 Currently @value{GDBN} can print the following data types in Modula-2
10095 syntax: array types, record types, set types, pointer types, procedure
10096 types, enumerated types, subrange types and base types. You can also
10097 print the contents of variables declared using these type.
10098 This section gives a number of simple source code examples together with
10099 sample @value{GDBN} sessions.
10101 The first example contains the following section of code:
10110 and you can request @value{GDBN} to interrogate the type and value of
10111 @code{r} and @code{s}.
10114 (@value{GDBP}) print s
10116 (@value{GDBP}) ptype s
10118 (@value{GDBP}) print r
10120 (@value{GDBP}) ptype r
10125 Likewise if your source code declares @code{s} as:
10129 s: SET ['A'..'Z'] ;
10133 then you may query the type of @code{s} by:
10136 (@value{GDBP}) ptype s
10137 type = SET ['A'..'Z']
10141 Note that at present you cannot interactively manipulate set
10142 expressions using the debugger.
10144 The following example shows how you might declare an array in Modula-2
10145 and how you can interact with @value{GDBN} to print its type and contents:
10149 s: ARRAY [-10..10] OF CHAR ;
10153 (@value{GDBP}) ptype s
10154 ARRAY [-10..10] OF CHAR
10157 Note that the array handling is not yet complete and although the type
10158 is printed correctly, expression handling still assumes that all
10159 arrays have a lower bound of zero and not @code{-10} as in the example
10162 Here are some more type related Modula-2 examples:
10166 colour = (blue, red, yellow, green) ;
10167 t = [blue..yellow] ;
10175 The @value{GDBN} interaction shows how you can query the data type
10176 and value of a variable.
10179 (@value{GDBP}) print s
10181 (@value{GDBP}) ptype t
10182 type = [blue..yellow]
10186 In this example a Modula-2 array is declared and its contents
10187 displayed. Observe that the contents are written in the same way as
10188 their @code{C} counterparts.
10192 s: ARRAY [1..5] OF CARDINAL ;
10198 (@value{GDBP}) print s
10199 $1 = @{1, 0, 0, 0, 0@}
10200 (@value{GDBP}) ptype s
10201 type = ARRAY [1..5] OF CARDINAL
10204 The Modula-2 language interface to @value{GDBN} also understands
10205 pointer types as shown in this example:
10209 s: POINTER TO ARRAY [1..5] OF CARDINAL ;
10216 and you can request that @value{GDBN} describes the type of @code{s}.
10219 (@value{GDBP}) ptype s
10220 type = POINTER TO ARRAY [1..5] OF CARDINAL
10223 @value{GDBN} handles compound types as we can see in this example.
10224 Here we combine array types, record types, pointer types and subrange
10235 myarray = ARRAY myrange OF CARDINAL ;
10236 myrange = [-2..2] ;
10238 s: POINTER TO ARRAY myrange OF foo ;
10242 and you can ask @value{GDBN} to describe the type of @code{s} as shown
10246 (@value{GDBP}) ptype s
10247 type = POINTER TO ARRAY [-2..2] OF foo = RECORD
10250 f3 : ARRAY [-2..2] OF CARDINAL;
10255 @subsubsection Modula-2 Defaults
10256 @cindex Modula-2 defaults
10258 If type and range checking are set automatically by @value{GDBN}, they
10259 both default to @code{on} whenever the working language changes to
10260 Modula-2. This happens regardless of whether you or @value{GDBN}
10261 selected the working language.
10263 If you allow @value{GDBN} to set the language automatically, then entering
10264 code compiled from a file whose name ends with @file{.mod} sets the
10265 working language to Modula-2. @xref{Automatically, ,Having @value{GDBN}
10266 Infer the Source Language}, for further details.
10269 @subsubsection Deviations from Standard Modula-2
10270 @cindex Modula-2, deviations from
10272 A few changes have been made to make Modula-2 programs easier to debug.
10273 This is done primarily via loosening its type strictness:
10277 Unlike in standard Modula-2, pointer constants can be formed by
10278 integers. This allows you to modify pointer variables during
10279 debugging. (In standard Modula-2, the actual address contained in a
10280 pointer variable is hidden from you; it can only be modified
10281 through direct assignment to another pointer variable or expression that
10282 returned a pointer.)
10285 C escape sequences can be used in strings and characters to represent
10286 non-printable characters. @value{GDBN} prints out strings with these
10287 escape sequences embedded. Single non-printable characters are
10288 printed using the @samp{CHR(@var{nnn})} format.
10291 The assignment operator (@code{:=}) returns the value of its right-hand
10295 All built-in procedures both modify @emph{and} return their argument.
10299 @subsubsection Modula-2 Type and Range Checks
10300 @cindex Modula-2 checks
10303 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
10306 @c FIXME remove warning when type/range checks added
10308 @value{GDBN} considers two Modula-2 variables type equivalent if:
10312 They are of types that have been declared equivalent via a @code{TYPE
10313 @var{t1} = @var{t2}} statement
10316 They have been declared on the same line. (Note: This is true of the
10317 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
10320 As long as type checking is enabled, any attempt to combine variables
10321 whose types are not equivalent is an error.
10323 Range checking is done on all mathematical operations, assignment, array
10324 index bounds, and all built-in functions and procedures.
10327 @subsubsection The Scope Operators @code{::} and @code{.}
10329 @cindex @code{.}, Modula-2 scope operator
10330 @cindex colon, doubled as scope operator
10332 @vindex colon-colon@r{, in Modula-2}
10333 @c Info cannot handle :: but TeX can.
10336 @vindex ::@r{, in Modula-2}
10339 There are a few subtle differences between the Modula-2 scope operator
10340 (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have
10345 @var{module} . @var{id}
10346 @var{scope} :: @var{id}
10350 where @var{scope} is the name of a module or a procedure,
10351 @var{module} the name of a module, and @var{id} is any declared
10352 identifier within your program, except another module.
10354 Using the @code{::} operator makes @value{GDBN} search the scope
10355 specified by @var{scope} for the identifier @var{id}. If it is not
10356 found in the specified scope, then @value{GDBN} searches all scopes
10357 enclosing the one specified by @var{scope}.
10359 Using the @code{.} operator makes @value{GDBN} search the current scope for
10360 the identifier specified by @var{id} that was imported from the
10361 definition module specified by @var{module}. With this operator, it is
10362 an error if the identifier @var{id} was not imported from definition
10363 module @var{module}, or if @var{id} is not an identifier in
10367 @subsubsection @value{GDBN} and Modula-2
10369 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
10370 Five subcommands of @code{set print} and @code{show print} apply
10371 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
10372 @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four
10373 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
10374 analogue in Modula-2.
10376 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
10377 with any language, is not useful with Modula-2. Its
10378 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
10379 created in Modula-2 as they can in C or C@t{++}. However, because an
10380 address can be specified by an integral constant, the construct
10381 @samp{@{@var{type}@}@var{adrexp}} is still useful.
10383 @cindex @code{#} in Modula-2
10384 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
10385 interpreted as the beginning of a comment. Use @code{<>} instead.
10391 The extensions made to @value{GDBN} for Ada only support
10392 output from the @sc{gnu} Ada (GNAT) compiler.
10393 Other Ada compilers are not currently supported, and
10394 attempting to debug executables produced by them is most likely
10398 @cindex expressions in Ada
10400 * Ada Mode Intro:: General remarks on the Ada syntax
10401 and semantics supported by Ada mode
10403 * Omissions from Ada:: Restrictions on the Ada expression syntax.
10404 * Additions to Ada:: Extensions of the Ada expression syntax.
10405 * Stopping Before Main Program:: Debugging the program during elaboration.
10406 * Ada Glitches:: Known peculiarities of Ada mode.
10409 @node Ada Mode Intro
10410 @subsubsection Introduction
10411 @cindex Ada mode, general
10413 The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression
10414 syntax, with some extensions.
10415 The philosophy behind the design of this subset is
10419 That @value{GDBN} should provide basic literals and access to operations for
10420 arithmetic, dereferencing, field selection, indexing, and subprogram calls,
10421 leaving more sophisticated computations to subprograms written into the
10422 program (which therefore may be called from @value{GDBN}).
10425 That type safety and strict adherence to Ada language restrictions
10426 are not particularly important to the @value{GDBN} user.
10429 That brevity is important to the @value{GDBN} user.
10432 Thus, for brevity, the debugger acts as if there were
10433 implicit @code{with} and @code{use} clauses in effect for all user-written
10434 packages, making it unnecessary to fully qualify most names with
10435 their packages, regardless of context. Where this causes ambiguity,
10436 @value{GDBN} asks the user's intent.
10438 The debugger will start in Ada mode if it detects an Ada main program.
10439 As for other languages, it will enter Ada mode when stopped in a program that
10440 was translated from an Ada source file.
10442 While in Ada mode, you may use `@t{--}' for comments. This is useful
10443 mostly for documenting command files. The standard @value{GDBN} comment
10444 (@samp{#}) still works at the beginning of a line in Ada mode, but not in the
10445 middle (to allow based literals).
10447 The debugger supports limited overloading. Given a subprogram call in which
10448 the function symbol has multiple definitions, it will use the number of
10449 actual parameters and some information about their types to attempt to narrow
10450 the set of definitions. It also makes very limited use of context, preferring
10451 procedures to functions in the context of the @code{call} command, and
10452 functions to procedures elsewhere.
10454 @node Omissions from Ada
10455 @subsubsection Omissions from Ada
10456 @cindex Ada, omissions from
10458 Here are the notable omissions from the subset:
10462 Only a subset of the attributes are supported:
10466 @t{'First}, @t{'Last}, and @t{'Length}
10467 on array objects (not on types and subtypes).
10470 @t{'Min} and @t{'Max}.
10473 @t{'Pos} and @t{'Val}.
10479 @t{'Range} on array objects (not subtypes), but only as the right
10480 operand of the membership (@code{in}) operator.
10483 @t{'Access}, @t{'Unchecked_Access}, and
10484 @t{'Unrestricted_Access} (a GNAT extension).
10492 @code{Characters.Latin_1} are not available and
10493 concatenation is not implemented. Thus, escape characters in strings are
10494 not currently available.
10497 Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise
10498 equality of representations. They will generally work correctly
10499 for strings and arrays whose elements have integer or enumeration types.
10500 They may not work correctly for arrays whose element
10501 types have user-defined equality, for arrays of real values
10502 (in particular, IEEE-conformant floating point, because of negative
10503 zeroes and NaNs), and for arrays whose elements contain unused bits with
10504 indeterminate values.
10507 The other component-by-component array operations (@code{and}, @code{or},
10508 @code{xor}, @code{not}, and relational tests other than equality)
10509 are not implemented.
10512 @cindex array aggregates (Ada)
10513 @cindex record aggregates (Ada)
10514 @cindex aggregates (Ada)
10515 There is limited support for array and record aggregates. They are
10516 permitted only on the right sides of assignments, as in these examples:
10519 set An_Array := (1, 2, 3, 4, 5, 6)
10520 set An_Array := (1, others => 0)
10521 set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6)
10522 set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9))
10523 set A_Record := (1, "Peter", True);
10524 set A_Record := (Name => "Peter", Id => 1, Alive => True)
10528 discriminant's value by assigning an aggregate has an
10529 undefined effect if that discriminant is used within the record.
10530 However, you can first modify discriminants by directly assigning to
10531 them (which normally would not be allowed in Ada), and then performing an
10532 aggregate assignment. For example, given a variable @code{A_Rec}
10533 declared to have a type such as:
10536 type Rec (Len : Small_Integer := 0) is record
10538 Vals : IntArray (1 .. Len);
10542 you can assign a value with a different size of @code{Vals} with two
10547 set A_Rec := (Id => 42, Vals => (1, 2, 3, 4))
10550 As this example also illustrates, @value{GDBN} is very loose about the usual
10551 rules concerning aggregates. You may leave out some of the
10552 components of an array or record aggregate (such as the @code{Len}
10553 component in the assignment to @code{A_Rec} above); they will retain their
10554 original values upon assignment. You may freely use dynamic values as
10555 indices in component associations. You may even use overlapping or
10556 redundant component associations, although which component values are
10557 assigned in such cases is not defined.
10560 Calls to dispatching subprograms are not implemented.
10563 The overloading algorithm is much more limited (i.e., less selective)
10564 than that of real Ada. It makes only limited use of the context in
10565 which a subexpression appears to resolve its meaning, and it is much
10566 looser in its rules for allowing type matches. As a result, some
10567 function calls will be ambiguous, and the user will be asked to choose
10568 the proper resolution.
10571 The @code{new} operator is not implemented.
10574 Entry calls are not implemented.
10577 Aside from printing, arithmetic operations on the native VAX floating-point
10578 formats are not supported.
10581 It is not possible to slice a packed array.
10584 @node Additions to Ada
10585 @subsubsection Additions to Ada
10586 @cindex Ada, deviations from
10588 As it does for other languages, @value{GDBN} makes certain generic
10589 extensions to Ada (@pxref{Expressions}):
10593 If the expression @var{E} is a variable residing in memory (typically
10594 a local variable or array element) and @var{N} is a positive integer,
10595 then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
10596 @var{N}-1 adjacent variables following it in memory as an array. In
10597 Ada, this operator is generally not necessary, since its prime use is
10598 in displaying parts of an array, and slicing will usually do this in
10599 Ada. However, there are occasional uses when debugging programs in
10600 which certain debugging information has been optimized away.
10603 @code{@var{B}::@var{var}} means ``the variable named @var{var} that
10604 appears in function or file @var{B}.'' When @var{B} is a file name,
10605 you must typically surround it in single quotes.
10608 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
10609 @var{type} that appears at address @var{addr}.''
10612 A name starting with @samp{$} is a convenience variable
10613 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
10616 In addition, @value{GDBN} provides a few other shortcuts and outright
10617 additions specific to Ada:
10621 The assignment statement is allowed as an expression, returning
10622 its right-hand operand as its value. Thus, you may enter
10626 print A(tmp := y + 1)
10630 The semicolon is allowed as an ``operator,'' returning as its value
10631 the value of its right-hand operand.
10632 This allows, for example,
10633 complex conditional breaks:
10637 condition 1 (report(i); k += 1; A(k) > 100)
10641 Rather than use catenation and symbolic character names to introduce special
10642 characters into strings, one may instead use a special bracket notation,
10643 which is also used to print strings. A sequence of characters of the form
10644 @samp{["@var{XX}"]} within a string or character literal denotes the
10645 (single) character whose numeric encoding is @var{XX} in hexadecimal. The
10646 sequence of characters @samp{["""]} also denotes a single quotation mark
10647 in strings. For example,
10649 "One line.["0a"]Next line.["0a"]"
10652 contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
10656 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
10657 @t{'Max} is optional (and is ignored in any case). For example, it is valid
10665 When printing arrays, @value{GDBN} uses positional notation when the
10666 array has a lower bound of 1, and uses a modified named notation otherwise.
10667 For example, a one-dimensional array of three integers with a lower bound
10668 of 3 might print as
10675 That is, in contrast to valid Ada, only the first component has a @code{=>}
10679 You may abbreviate attributes in expressions with any unique,
10680 multi-character subsequence of
10681 their names (an exact match gets preference).
10682 For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh}
10683 in place of @t{a'length}.
10686 @cindex quoting Ada internal identifiers
10687 Since Ada is case-insensitive, the debugger normally maps identifiers you type
10688 to lower case. The GNAT compiler uses upper-case characters for
10689 some of its internal identifiers, which are normally of no interest to users.
10690 For the rare occasions when you actually have to look at them,
10691 enclose them in angle brackets to avoid the lower-case mapping.
10694 @value{GDBP} print <JMPBUF_SAVE>[0]
10698 Printing an object of class-wide type or dereferencing an
10699 access-to-class-wide value will display all the components of the object's
10700 specific type (as indicated by its run-time tag). Likewise, component
10701 selection on such a value will operate on the specific type of the
10706 @node Stopping Before Main Program
10707 @subsubsection Stopping at the Very Beginning
10709 @cindex breakpointing Ada elaboration code
10710 It is sometimes necessary to debug the program during elaboration, and
10711 before reaching the main procedure.
10712 As defined in the Ada Reference
10713 Manual, the elaboration code is invoked from a procedure called
10714 @code{adainit}. To run your program up to the beginning of
10715 elaboration, simply use the following two commands:
10716 @code{tbreak adainit} and @code{run}.
10719 @subsubsection Known Peculiarities of Ada Mode
10720 @cindex Ada, problems
10722 Besides the omissions listed previously (@pxref{Omissions from Ada}),
10723 we know of several problems with and limitations of Ada mode in
10725 some of which will be fixed with planned future releases of the debugger
10726 and the GNU Ada compiler.
10730 Currently, the debugger
10731 has insufficient information to determine whether certain pointers represent
10732 pointers to objects or the objects themselves.
10733 Thus, the user may have to tack an extra @code{.all} after an expression
10734 to get it printed properly.
10737 Static constants that the compiler chooses not to materialize as objects in
10738 storage are invisible to the debugger.
10741 Named parameter associations in function argument lists are ignored (the
10742 argument lists are treated as positional).
10745 Many useful library packages are currently invisible to the debugger.
10748 Fixed-point arithmetic, conversions, input, and output is carried out using
10749 floating-point arithmetic, and may give results that only approximate those on
10753 The type of the @t{'Address} attribute may not be @code{System.Address}.
10756 The GNAT compiler never generates the prefix @code{Standard} for any of
10757 the standard symbols defined by the Ada language. @value{GDBN} knows about
10758 this: it will strip the prefix from names when you use it, and will never
10759 look for a name you have so qualified among local symbols, nor match against
10760 symbols in other packages or subprograms. If you have
10761 defined entities anywhere in your program other than parameters and
10762 local variables whose simple names match names in @code{Standard},
10763 GNAT's lack of qualification here can cause confusion. When this happens,
10764 you can usually resolve the confusion
10765 by qualifying the problematic names with package
10766 @code{Standard} explicitly.
10769 @node Unsupported Languages
10770 @section Unsupported Languages
10772 @cindex unsupported languages
10773 @cindex minimal language
10774 In addition to the other fully-supported programming languages,
10775 @value{GDBN} also provides a pseudo-language, called @code{minimal}.
10776 It does not represent a real programming language, but provides a set
10777 of capabilities close to what the C or assembly languages provide.
10778 This should allow most simple operations to be performed while debugging
10779 an application that uses a language currently not supported by @value{GDBN}.
10781 If the language is set to @code{auto}, @value{GDBN} will automatically
10782 select this language if the current frame corresponds to an unsupported
10786 @chapter Examining the Symbol Table
10788 The commands described in this chapter allow you to inquire about the
10789 symbols (names of variables, functions and types) defined in your
10790 program. This information is inherent in the text of your program and
10791 does not change as your program executes. @value{GDBN} finds it in your
10792 program's symbol table, in the file indicated when you started @value{GDBN}
10793 (@pxref{File Options, ,Choosing Files}), or by one of the
10794 file-management commands (@pxref{Files, ,Commands to Specify Files}).
10796 @cindex symbol names
10797 @cindex names of symbols
10798 @cindex quoting names
10799 Occasionally, you may need to refer to symbols that contain unusual
10800 characters, which @value{GDBN} ordinarily treats as word delimiters. The
10801 most frequent case is in referring to static variables in other
10802 source files (@pxref{Variables,,Program Variables}). File names
10803 are recorded in object files as debugging symbols, but @value{GDBN} would
10804 ordinarily parse a typical file name, like @file{foo.c}, as the three words
10805 @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize
10806 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
10813 looks up the value of @code{x} in the scope of the file @file{foo.c}.
10816 @cindex case-insensitive symbol names
10817 @cindex case sensitivity in symbol names
10818 @kindex set case-sensitive
10819 @item set case-sensitive on
10820 @itemx set case-sensitive off
10821 @itemx set case-sensitive auto
10822 Normally, when @value{GDBN} looks up symbols, it matches their names
10823 with case sensitivity determined by the current source language.
10824 Occasionally, you may wish to control that. The command @code{set
10825 case-sensitive} lets you do that by specifying @code{on} for
10826 case-sensitive matches or @code{off} for case-insensitive ones. If
10827 you specify @code{auto}, case sensitivity is reset to the default
10828 suitable for the source language. The default is case-sensitive
10829 matches for all languages except for Fortran, for which the default is
10830 case-insensitive matches.
10832 @kindex show case-sensitive
10833 @item show case-sensitive
10834 This command shows the current setting of case sensitivity for symbols
10837 @kindex info address
10838 @cindex address of a symbol
10839 @item info address @var{symbol}
10840 Describe where the data for @var{symbol} is stored. For a register
10841 variable, this says which register it is kept in. For a non-register
10842 local variable, this prints the stack-frame offset at which the variable
10845 Note the contrast with @samp{print &@var{symbol}}, which does not work
10846 at all for a register variable, and for a stack local variable prints
10847 the exact address of the current instantiation of the variable.
10849 @kindex info symbol
10850 @cindex symbol from address
10851 @cindex closest symbol and offset for an address
10852 @item info symbol @var{addr}
10853 Print the name of a symbol which is stored at the address @var{addr}.
10854 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
10855 nearest symbol and an offset from it:
10858 (@value{GDBP}) info symbol 0x54320
10859 _initialize_vx + 396 in section .text
10863 This is the opposite of the @code{info address} command. You can use
10864 it to find out the name of a variable or a function given its address.
10867 @item whatis [@var{arg}]
10868 Print the data type of @var{arg}, which can be either an expression or
10869 a data type. With no argument, print the data type of @code{$}, the
10870 last value in the value history. If @var{arg} is an expression, it is
10871 not actually evaluated, and any side-effecting operations (such as
10872 assignments or function calls) inside it do not take place. If
10873 @var{arg} is a type name, it may be the name of a type or typedef, or
10874 for C code it may have the form @samp{class @var{class-name}},
10875 @samp{struct @var{struct-tag}}, @samp{union @var{union-tag}} or
10876 @samp{enum @var{enum-tag}}.
10877 @xref{Expressions, ,Expressions}.
10880 @item ptype [@var{arg}]
10881 @code{ptype} accepts the same arguments as @code{whatis}, but prints a
10882 detailed description of the type, instead of just the name of the type.
10883 @xref{Expressions, ,Expressions}.
10885 For example, for this variable declaration:
10888 struct complex @{double real; double imag;@} v;
10892 the two commands give this output:
10896 (@value{GDBP}) whatis v
10897 type = struct complex
10898 (@value{GDBP}) ptype v
10899 type = struct complex @{
10907 As with @code{whatis}, using @code{ptype} without an argument refers to
10908 the type of @code{$}, the last value in the value history.
10910 @cindex incomplete type
10911 Sometimes, programs use opaque data types or incomplete specifications
10912 of complex data structure. If the debug information included in the
10913 program does not allow @value{GDBN} to display a full declaration of
10914 the data type, it will say @samp{<incomplete type>}. For example,
10915 given these declarations:
10919 struct foo *fooptr;
10923 but no definition for @code{struct foo} itself, @value{GDBN} will say:
10926 (@value{GDBP}) ptype foo
10927 $1 = <incomplete type>
10931 ``Incomplete type'' is C terminology for data types that are not
10932 completely specified.
10935 @item info types @var{regexp}
10937 Print a brief description of all types whose names match the regular
10938 expression @var{regexp} (or all types in your program, if you supply
10939 no argument). Each complete typename is matched as though it were a
10940 complete line; thus, @samp{i type value} gives information on all
10941 types in your program whose names include the string @code{value}, but
10942 @samp{i type ^value$} gives information only on types whose complete
10943 name is @code{value}.
10945 This command differs from @code{ptype} in two ways: first, like
10946 @code{whatis}, it does not print a detailed description; second, it
10947 lists all source files where a type is defined.
10950 @cindex local variables
10951 @item info scope @var{location}
10952 List all the variables local to a particular scope. This command
10953 accepts a @var{location} argument---a function name, a source line, or
10954 an address preceded by a @samp{*}, and prints all the variables local
10955 to the scope defined by that location. For example:
10958 (@value{GDBP}) @b{info scope command_line_handler}
10959 Scope for command_line_handler:
10960 Symbol rl is an argument at stack/frame offset 8, length 4.
10961 Symbol linebuffer is in static storage at address 0x150a18, length 4.
10962 Symbol linelength is in static storage at address 0x150a1c, length 4.
10963 Symbol p is a local variable in register $esi, length 4.
10964 Symbol p1 is a local variable in register $ebx, length 4.
10965 Symbol nline is a local variable in register $edx, length 4.
10966 Symbol repeat is a local variable at frame offset -8, length 4.
10970 This command is especially useful for determining what data to collect
10971 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
10974 @kindex info source
10976 Show information about the current source file---that is, the source file for
10977 the function containing the current point of execution:
10980 the name of the source file, and the directory containing it,
10982 the directory it was compiled in,
10984 its length, in lines,
10986 which programming language it is written in,
10988 whether the executable includes debugging information for that file, and
10989 if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and
10991 whether the debugging information includes information about
10992 preprocessor macros.
10996 @kindex info sources
10998 Print the names of all source files in your program for which there is
10999 debugging information, organized into two lists: files whose symbols
11000 have already been read, and files whose symbols will be read when needed.
11002 @kindex info functions
11003 @item info functions
11004 Print the names and data types of all defined functions.
11006 @item info functions @var{regexp}
11007 Print the names and data types of all defined functions
11008 whose names contain a match for regular expression @var{regexp}.
11009 Thus, @samp{info fun step} finds all functions whose names
11010 include @code{step}; @samp{info fun ^step} finds those whose names
11011 start with @code{step}. If a function name contains characters
11012 that conflict with the regular expression language (e.g.@:
11013 @samp{operator*()}), they may be quoted with a backslash.
11015 @kindex info variables
11016 @item info variables
11017 Print the names and data types of all variables that are declared
11018 outside of functions (i.e.@: excluding local variables).
11020 @item info variables @var{regexp}
11021 Print the names and data types of all variables (except for local
11022 variables) whose names contain a match for regular expression
11025 @kindex info classes
11026 @cindex Objective-C, classes and selectors
11028 @itemx info classes @var{regexp}
11029 Display all Objective-C classes in your program, or
11030 (with the @var{regexp} argument) all those matching a particular regular
11033 @kindex info selectors
11034 @item info selectors
11035 @itemx info selectors @var{regexp}
11036 Display all Objective-C selectors in your program, or
11037 (with the @var{regexp} argument) all those matching a particular regular
11041 This was never implemented.
11042 @kindex info methods
11044 @itemx info methods @var{regexp}
11045 The @code{info methods} command permits the user to examine all defined
11046 methods within C@t{++} program, or (with the @var{regexp} argument) a
11047 specific set of methods found in the various C@t{++} classes. Many
11048 C@t{++} classes provide a large number of methods. Thus, the output
11049 from the @code{ptype} command can be overwhelming and hard to use. The
11050 @code{info-methods} command filters the methods, printing only those
11051 which match the regular-expression @var{regexp}.
11054 @cindex reloading symbols
11055 Some systems allow individual object files that make up your program to
11056 be replaced without stopping and restarting your program. For example,
11057 in VxWorks you can simply recompile a defective object file and keep on
11058 running. If you are running on one of these systems, you can allow
11059 @value{GDBN} to reload the symbols for automatically relinked modules:
11062 @kindex set symbol-reloading
11063 @item set symbol-reloading on
11064 Replace symbol definitions for the corresponding source file when an
11065 object file with a particular name is seen again.
11067 @item set symbol-reloading off
11068 Do not replace symbol definitions when encountering object files of the
11069 same name more than once. This is the default state; if you are not
11070 running on a system that permits automatic relinking of modules, you
11071 should leave @code{symbol-reloading} off, since otherwise @value{GDBN}
11072 may discard symbols when linking large programs, that may contain
11073 several modules (from different directories or libraries) with the same
11076 @kindex show symbol-reloading
11077 @item show symbol-reloading
11078 Show the current @code{on} or @code{off} setting.
11081 @cindex opaque data types
11082 @kindex set opaque-type-resolution
11083 @item set opaque-type-resolution on
11084 Tell @value{GDBN} to resolve opaque types. An opaque type is a type
11085 declared as a pointer to a @code{struct}, @code{class}, or
11086 @code{union}---for example, @code{struct MyType *}---that is used in one
11087 source file although the full declaration of @code{struct MyType} is in
11088 another source file. The default is on.
11090 A change in the setting of this subcommand will not take effect until
11091 the next time symbols for a file are loaded.
11093 @item set opaque-type-resolution off
11094 Tell @value{GDBN} not to resolve opaque types. In this case, the type
11095 is printed as follows:
11097 @{<no data fields>@}
11100 @kindex show opaque-type-resolution
11101 @item show opaque-type-resolution
11102 Show whether opaque types are resolved or not.
11104 @kindex maint print symbols
11105 @cindex symbol dump
11106 @kindex maint print psymbols
11107 @cindex partial symbol dump
11108 @item maint print symbols @var{filename}
11109 @itemx maint print psymbols @var{filename}
11110 @itemx maint print msymbols @var{filename}
11111 Write a dump of debugging symbol data into the file @var{filename}.
11112 These commands are used to debug the @value{GDBN} symbol-reading code. Only
11113 symbols with debugging data are included. If you use @samp{maint print
11114 symbols}, @value{GDBN} includes all the symbols for which it has already
11115 collected full details: that is, @var{filename} reflects symbols for
11116 only those files whose symbols @value{GDBN} has read. You can use the
11117 command @code{info sources} to find out which files these are. If you
11118 use @samp{maint print psymbols} instead, the dump shows information about
11119 symbols that @value{GDBN} only knows partially---that is, symbols defined in
11120 files that @value{GDBN} has skimmed, but not yet read completely. Finally,
11121 @samp{maint print msymbols} dumps just the minimal symbol information
11122 required for each object file from which @value{GDBN} has read some symbols.
11123 @xref{Files, ,Commands to Specify Files}, for a discussion of how
11124 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
11126 @kindex maint info symtabs
11127 @kindex maint info psymtabs
11128 @cindex listing @value{GDBN}'s internal symbol tables
11129 @cindex symbol tables, listing @value{GDBN}'s internal
11130 @cindex full symbol tables, listing @value{GDBN}'s internal
11131 @cindex partial symbol tables, listing @value{GDBN}'s internal
11132 @item maint info symtabs @r{[} @var{regexp} @r{]}
11133 @itemx maint info psymtabs @r{[} @var{regexp} @r{]}
11135 List the @code{struct symtab} or @code{struct partial_symtab}
11136 structures whose names match @var{regexp}. If @var{regexp} is not
11137 given, list them all. The output includes expressions which you can
11138 copy into a @value{GDBN} debugging this one to examine a particular
11139 structure in more detail. For example:
11142 (@value{GDBP}) maint info psymtabs dwarf2read
11143 @{ objfile /home/gnu/build/gdb/gdb
11144 ((struct objfile *) 0x82e69d0)
11145 @{ psymtab /home/gnu/src/gdb/dwarf2read.c
11146 ((struct partial_symtab *) 0x8474b10)
11149 text addresses 0x814d3c8 -- 0x8158074
11150 globals (* (struct partial_symbol **) 0x8507a08 @@ 9)
11151 statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882)
11152 dependencies (none)
11155 (@value{GDBP}) maint info symtabs
11159 We see that there is one partial symbol table whose filename contains
11160 the string @samp{dwarf2read}, belonging to the @samp{gdb} executable;
11161 and we see that @value{GDBN} has not read in any symtabs yet at all.
11162 If we set a breakpoint on a function, that will cause @value{GDBN} to
11163 read the symtab for the compilation unit containing that function:
11166 (@value{GDBP}) break dwarf2_psymtab_to_symtab
11167 Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c,
11169 (@value{GDBP}) maint info symtabs
11170 @{ objfile /home/gnu/build/gdb/gdb
11171 ((struct objfile *) 0x82e69d0)
11172 @{ symtab /home/gnu/src/gdb/dwarf2read.c
11173 ((struct symtab *) 0x86c1f38)
11176 blockvector ((struct blockvector *) 0x86c1bd0) (primary)
11177 debugformat DWARF 2
11186 @chapter Altering Execution
11188 Once you think you have found an error in your program, you might want to
11189 find out for certain whether correcting the apparent error would lead to
11190 correct results in the rest of the run. You can find the answer by
11191 experiment, using the @value{GDBN} features for altering execution of the
11194 For example, you can store new values into variables or memory
11195 locations, give your program a signal, restart it at a different
11196 address, or even return prematurely from a function.
11199 * Assignment:: Assignment to variables
11200 * Jumping:: Continuing at a different address
11201 * Signaling:: Giving your program a signal
11202 * Returning:: Returning from a function
11203 * Calling:: Calling your program's functions
11204 * Patching:: Patching your program
11208 @section Assignment to Variables
11211 @cindex setting variables
11212 To alter the value of a variable, evaluate an assignment expression.
11213 @xref{Expressions, ,Expressions}. For example,
11220 stores the value 4 into the variable @code{x}, and then prints the
11221 value of the assignment expression (which is 4).
11222 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
11223 information on operators in supported languages.
11225 @kindex set variable
11226 @cindex variables, setting
11227 If you are not interested in seeing the value of the assignment, use the
11228 @code{set} command instead of the @code{print} command. @code{set} is
11229 really the same as @code{print} except that the expression's value is
11230 not printed and is not put in the value history (@pxref{Value History,
11231 ,Value History}). The expression is evaluated only for its effects.
11233 If the beginning of the argument string of the @code{set} command
11234 appears identical to a @code{set} subcommand, use the @code{set
11235 variable} command instead of just @code{set}. This command is identical
11236 to @code{set} except for its lack of subcommands. For example, if your
11237 program has a variable @code{width}, you get an error if you try to set
11238 a new value with just @samp{set width=13}, because @value{GDBN} has the
11239 command @code{set width}:
11242 (@value{GDBP}) whatis width
11244 (@value{GDBP}) p width
11246 (@value{GDBP}) set width=47
11247 Invalid syntax in expression.
11251 The invalid expression, of course, is @samp{=47}. In
11252 order to actually set the program's variable @code{width}, use
11255 (@value{GDBP}) set var width=47
11258 Because the @code{set} command has many subcommands that can conflict
11259 with the names of program variables, it is a good idea to use the
11260 @code{set variable} command instead of just @code{set}. For example, if
11261 your program has a variable @code{g}, you run into problems if you try
11262 to set a new value with just @samp{set g=4}, because @value{GDBN} has
11263 the command @code{set gnutarget}, abbreviated @code{set g}:
11267 (@value{GDBP}) whatis g
11271 (@value{GDBP}) set g=4
11275 The program being debugged has been started already.
11276 Start it from the beginning? (y or n) y
11277 Starting program: /home/smith/cc_progs/a.out
11278 "/home/smith/cc_progs/a.out": can't open to read symbols:
11279 Invalid bfd target.
11280 (@value{GDBP}) show g
11281 The current BFD target is "=4".
11286 The program variable @code{g} did not change, and you silently set the
11287 @code{gnutarget} to an invalid value. In order to set the variable
11291 (@value{GDBP}) set var g=4
11294 @value{GDBN} allows more implicit conversions in assignments than C; you can
11295 freely store an integer value into a pointer variable or vice versa,
11296 and you can convert any structure to any other structure that is the
11297 same length or shorter.
11298 @comment FIXME: how do structs align/pad in these conversions?
11299 @comment /doc@cygnus.com 18dec1990
11301 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
11302 construct to generate a value of specified type at a specified address
11303 (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers
11304 to memory location @code{0x83040} as an integer (which implies a certain size
11305 and representation in memory), and
11308 set @{int@}0x83040 = 4
11312 stores the value 4 into that memory location.
11315 @section Continuing at a Different Address
11317 Ordinarily, when you continue your program, you do so at the place where
11318 it stopped, with the @code{continue} command. You can instead continue at
11319 an address of your own choosing, with the following commands:
11323 @item jump @var{linespec}
11324 Resume execution at line @var{linespec}. Execution stops again
11325 immediately if there is a breakpoint there. @xref{List, ,Printing
11326 Source Lines}, for a description of the different forms of
11327 @var{linespec}. It is common practice to use the @code{tbreak} command
11328 in conjunction with @code{jump}. @xref{Set Breaks, ,Setting
11331 The @code{jump} command does not change the current stack frame, or
11332 the stack pointer, or the contents of any memory location or any
11333 register other than the program counter. If line @var{linespec} is in
11334 a different function from the one currently executing, the results may
11335 be bizarre if the two functions expect different patterns of arguments or
11336 of local variables. For this reason, the @code{jump} command requests
11337 confirmation if the specified line is not in the function currently
11338 executing. However, even bizarre results are predictable if you are
11339 well acquainted with the machine-language code of your program.
11341 @item jump *@var{address}
11342 Resume execution at the instruction at address @var{address}.
11345 @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt.
11346 On many systems, you can get much the same effect as the @code{jump}
11347 command by storing a new value into the register @code{$pc}. The
11348 difference is that this does not start your program running; it only
11349 changes the address of where it @emph{will} run when you continue. For
11357 makes the next @code{continue} command or stepping command execute at
11358 address @code{0x485}, rather than at the address where your program stopped.
11359 @xref{Continuing and Stepping, ,Continuing and Stepping}.
11361 The most common occasion to use the @code{jump} command is to back
11362 up---perhaps with more breakpoints set---over a portion of a program
11363 that has already executed, in order to examine its execution in more
11368 @section Giving your Program a Signal
11369 @cindex deliver a signal to a program
11373 @item signal @var{signal}
11374 Resume execution where your program stopped, but immediately give it the
11375 signal @var{signal}. @var{signal} can be the name or the number of a
11376 signal. For example, on many systems @code{signal 2} and @code{signal
11377 SIGINT} are both ways of sending an interrupt signal.
11379 Alternatively, if @var{signal} is zero, continue execution without
11380 giving a signal. This is useful when your program stopped on account of
11381 a signal and would ordinary see the signal when resumed with the
11382 @code{continue} command; @samp{signal 0} causes it to resume without a
11385 @code{signal} does not repeat when you press @key{RET} a second time
11386 after executing the command.
11390 Invoking the @code{signal} command is not the same as invoking the
11391 @code{kill} utility from the shell. Sending a signal with @code{kill}
11392 causes @value{GDBN} to decide what to do with the signal depending on
11393 the signal handling tables (@pxref{Signals}). The @code{signal} command
11394 passes the signal directly to your program.
11398 @section Returning from a Function
11401 @cindex returning from a function
11404 @itemx return @var{expression}
11405 You can cancel execution of a function call with the @code{return}
11406 command. If you give an
11407 @var{expression} argument, its value is used as the function's return
11411 When you use @code{return}, @value{GDBN} discards the selected stack frame
11412 (and all frames within it). You can think of this as making the
11413 discarded frame return prematurely. If you wish to specify a value to
11414 be returned, give that value as the argument to @code{return}.
11416 This pops the selected stack frame (@pxref{Selection, ,Selecting a
11417 Frame}), and any other frames inside of it, leaving its caller as the
11418 innermost remaining frame. That frame becomes selected. The
11419 specified value is stored in the registers used for returning values
11422 The @code{return} command does not resume execution; it leaves the
11423 program stopped in the state that would exist if the function had just
11424 returned. In contrast, the @code{finish} command (@pxref{Continuing
11425 and Stepping, ,Continuing and Stepping}) resumes execution until the
11426 selected stack frame returns naturally.
11429 @section Calling Program Functions
11432 @cindex calling functions
11433 @cindex inferior functions, calling
11434 @item print @var{expr}
11435 Evaluate the expression @var{expr} and display the resulting value.
11436 @var{expr} may include calls to functions in the program being
11440 @item call @var{expr}
11441 Evaluate the expression @var{expr} without displaying @code{void}
11444 You can use this variant of the @code{print} command if you want to
11445 execute a function from your program that does not return anything
11446 (a.k.a.@: @dfn{a void function}), but without cluttering the output
11447 with @code{void} returned values that @value{GDBN} will otherwise
11448 print. If the result is not void, it is printed and saved in the
11452 It is possible for the function you call via the @code{print} or
11453 @code{call} command to generate a signal (e.g., if there's a bug in
11454 the function, or if you passed it incorrect arguments). What happens
11455 in that case is controlled by the @code{set unwindonsignal} command.
11458 @item set unwindonsignal
11459 @kindex set unwindonsignal
11460 @cindex unwind stack in called functions
11461 @cindex call dummy stack unwinding
11462 Set unwinding of the stack if a signal is received while in a function
11463 that @value{GDBN} called in the program being debugged. If set to on,
11464 @value{GDBN} unwinds the stack it created for the call and restores
11465 the context to what it was before the call. If set to off (the
11466 default), @value{GDBN} stops in the frame where the signal was
11469 @item show unwindonsignal
11470 @kindex show unwindonsignal
11471 Show the current setting of stack unwinding in the functions called by
11475 @cindex weak alias functions
11476 Sometimes, a function you wish to call is actually a @dfn{weak alias}
11477 for another function. In such case, @value{GDBN} might not pick up
11478 the type information, including the types of the function arguments,
11479 which causes @value{GDBN} to call the inferior function incorrectly.
11480 As a result, the called function will function erroneously and may
11481 even crash. A solution to that is to use the name of the aliased
11485 @section Patching Programs
11487 @cindex patching binaries
11488 @cindex writing into executables
11489 @cindex writing into corefiles
11491 By default, @value{GDBN} opens the file containing your program's
11492 executable code (or the corefile) read-only. This prevents accidental
11493 alterations to machine code; but it also prevents you from intentionally
11494 patching your program's binary.
11496 If you'd like to be able to patch the binary, you can specify that
11497 explicitly with the @code{set write} command. For example, you might
11498 want to turn on internal debugging flags, or even to make emergency
11504 @itemx set write off
11505 If you specify @samp{set write on}, @value{GDBN} opens executable and
11506 core files for both reading and writing; if you specify @samp{set write
11507 off} (the default), @value{GDBN} opens them read-only.
11509 If you have already loaded a file, you must load it again (using the
11510 @code{exec-file} or @code{core-file} command) after changing @code{set
11511 write}, for your new setting to take effect.
11515 Display whether executable files and core files are opened for writing
11516 as well as reading.
11520 @chapter @value{GDBN} Files
11522 @value{GDBN} needs to know the file name of the program to be debugged,
11523 both in order to read its symbol table and in order to start your
11524 program. To debug a core dump of a previous run, you must also tell
11525 @value{GDBN} the name of the core dump file.
11528 * Files:: Commands to specify files
11529 * Separate Debug Files:: Debugging information in separate files
11530 * Symbol Errors:: Errors reading symbol files
11534 @section Commands to Specify Files
11536 @cindex symbol table
11537 @cindex core dump file
11539 You may want to specify executable and core dump file names. The usual
11540 way to do this is at start-up time, using the arguments to
11541 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
11542 Out of @value{GDBN}}).
11544 Occasionally it is necessary to change to a different file during a
11545 @value{GDBN} session. Or you may run @value{GDBN} and forget to
11546 specify a file you want to use. Or you are debugging a remote target
11547 via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver}
11548 Program}). In these situations the @value{GDBN} commands to specify
11549 new files are useful.
11552 @cindex executable file
11554 @item file @var{filename}
11555 Use @var{filename} as the program to be debugged. It is read for its
11556 symbols and for the contents of pure memory. It is also the program
11557 executed when you use the @code{run} command. If you do not specify a
11558 directory and the file is not found in the @value{GDBN} working directory,
11559 @value{GDBN} uses the environment variable @code{PATH} as a list of
11560 directories to search, just as the shell does when looking for a program
11561 to run. You can change the value of this variable, for both @value{GDBN}
11562 and your program, using the @code{path} command.
11564 @cindex unlinked object files
11565 @cindex patching object files
11566 You can load unlinked object @file{.o} files into @value{GDBN} using
11567 the @code{file} command. You will not be able to ``run'' an object
11568 file, but you can disassemble functions and inspect variables. Also,
11569 if the underlying BFD functionality supports it, you could use
11570 @kbd{gdb -write} to patch object files using this technique. Note
11571 that @value{GDBN} can neither interpret nor modify relocations in this
11572 case, so branches and some initialized variables will appear to go to
11573 the wrong place. But this feature is still handy from time to time.
11576 @code{file} with no argument makes @value{GDBN} discard any information it
11577 has on both executable file and the symbol table.
11580 @item exec-file @r{[} @var{filename} @r{]}
11581 Specify that the program to be run (but not the symbol table) is found
11582 in @var{filename}. @value{GDBN} searches the environment variable @code{PATH}
11583 if necessary to locate your program. Omitting @var{filename} means to
11584 discard information on the executable file.
11586 @kindex symbol-file
11587 @item symbol-file @r{[} @var{filename} @r{]}
11588 Read symbol table information from file @var{filename}. @code{PATH} is
11589 searched when necessary. Use the @code{file} command to get both symbol
11590 table and program to run from the same file.
11592 @code{symbol-file} with no argument clears out @value{GDBN} information on your
11593 program's symbol table.
11595 The @code{symbol-file} command causes @value{GDBN} to forget the contents of
11596 some breakpoints and auto-display expressions. This is because they may
11597 contain pointers to the internal data recording symbols and data types,
11598 which are part of the old symbol table data being discarded inside
11601 @code{symbol-file} does not repeat if you press @key{RET} again after
11604 When @value{GDBN} is configured for a particular environment, it
11605 understands debugging information in whatever format is the standard
11606 generated for that environment; you may use either a @sc{gnu} compiler, or
11607 other compilers that adhere to the local conventions.
11608 Best results are usually obtained from @sc{gnu} compilers; for example,
11609 using @code{@value{NGCC}} you can generate debugging information for
11612 For most kinds of object files, with the exception of old SVR3 systems
11613 using COFF, the @code{symbol-file} command does not normally read the
11614 symbol table in full right away. Instead, it scans the symbol table
11615 quickly to find which source files and which symbols are present. The
11616 details are read later, one source file at a time, as they are needed.
11618 The purpose of this two-stage reading strategy is to make @value{GDBN}
11619 start up faster. For the most part, it is invisible except for
11620 occasional pauses while the symbol table details for a particular source
11621 file are being read. (The @code{set verbose} command can turn these
11622 pauses into messages if desired. @xref{Messages/Warnings, ,Optional
11623 Warnings and Messages}.)
11625 We have not implemented the two-stage strategy for COFF yet. When the
11626 symbol table is stored in COFF format, @code{symbol-file} reads the
11627 symbol table data in full right away. Note that ``stabs-in-COFF''
11628 still does the two-stage strategy, since the debug info is actually
11632 @cindex reading symbols immediately
11633 @cindex symbols, reading immediately
11634 @item symbol-file @var{filename} @r{[} -readnow @r{]}
11635 @itemx file @var{filename} @r{[} -readnow @r{]}
11636 You can override the @value{GDBN} two-stage strategy for reading symbol
11637 tables by using the @samp{-readnow} option with any of the commands that
11638 load symbol table information, if you want to be sure @value{GDBN} has the
11639 entire symbol table available.
11641 @c FIXME: for now no mention of directories, since this seems to be in
11642 @c flux. 13mar1992 status is that in theory GDB would look either in
11643 @c current dir or in same dir as myprog; but issues like competing
11644 @c GDB's, or clutter in system dirs, mean that in practice right now
11645 @c only current dir is used. FFish says maybe a special GDB hierarchy
11646 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
11650 @item core-file @r{[}@var{filename}@r{]}
11652 Specify the whereabouts of a core dump file to be used as the ``contents
11653 of memory''. Traditionally, core files contain only some parts of the
11654 address space of the process that generated them; @value{GDBN} can access the
11655 executable file itself for other parts.
11657 @code{core-file} with no argument specifies that no core file is
11660 Note that the core file is ignored when your program is actually running
11661 under @value{GDBN}. So, if you have been running your program and you
11662 wish to debug a core file instead, you must kill the subprocess in which
11663 the program is running. To do this, use the @code{kill} command
11664 (@pxref{Kill Process, ,Killing the Child Process}).
11666 @kindex add-symbol-file
11667 @cindex dynamic linking
11668 @item add-symbol-file @var{filename} @var{address}
11669 @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]}
11670 @itemx add-symbol-file @var{filename} @r{-s}@var{section} @var{address} @dots{}
11671 The @code{add-symbol-file} command reads additional symbol table
11672 information from the file @var{filename}. You would use this command
11673 when @var{filename} has been dynamically loaded (by some other means)
11674 into the program that is running. @var{address} should be the memory
11675 address at which the file has been loaded; @value{GDBN} cannot figure
11676 this out for itself. You can additionally specify an arbitrary number
11677 of @samp{@r{-s}@var{section} @var{address}} pairs, to give an explicit
11678 section name and base address for that section. You can specify any
11679 @var{address} as an expression.
11681 The symbol table of the file @var{filename} is added to the symbol table
11682 originally read with the @code{symbol-file} command. You can use the
11683 @code{add-symbol-file} command any number of times; the new symbol data
11684 thus read keeps adding to the old. To discard all old symbol data
11685 instead, use the @code{symbol-file} command without any arguments.
11687 @cindex relocatable object files, reading symbols from
11688 @cindex object files, relocatable, reading symbols from
11689 @cindex reading symbols from relocatable object files
11690 @cindex symbols, reading from relocatable object files
11691 @cindex @file{.o} files, reading symbols from
11692 Although @var{filename} is typically a shared library file, an
11693 executable file, or some other object file which has been fully
11694 relocated for loading into a process, you can also load symbolic
11695 information from relocatable @file{.o} files, as long as:
11699 the file's symbolic information refers only to linker symbols defined in
11700 that file, not to symbols defined by other object files,
11702 every section the file's symbolic information refers to has actually
11703 been loaded into the inferior, as it appears in the file, and
11705 you can determine the address at which every section was loaded, and
11706 provide these to the @code{add-symbol-file} command.
11710 Some embedded operating systems, like Sun Chorus and VxWorks, can load
11711 relocatable files into an already running program; such systems
11712 typically make the requirements above easy to meet. However, it's
11713 important to recognize that many native systems use complex link
11714 procedures (@code{.linkonce} section factoring and C@t{++} constructor table
11715 assembly, for example) that make the requirements difficult to meet. In
11716 general, one cannot assume that using @code{add-symbol-file} to read a
11717 relocatable object file's symbolic information will have the same effect
11718 as linking the relocatable object file into the program in the normal
11721 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
11723 @kindex add-symbol-file-from-memory
11724 @cindex @code{syscall DSO}
11725 @cindex load symbols from memory
11726 @item add-symbol-file-from-memory @var{address}
11727 Load symbols from the given @var{address} in a dynamically loaded
11728 object file whose image is mapped directly into the inferior's memory.
11729 For example, the Linux kernel maps a @code{syscall DSO} into each
11730 process's address space; this DSO provides kernel-specific code for
11731 some system calls. The argument can be any expression whose
11732 evaluation yields the address of the file's shared object file header.
11733 For this command to work, you must have used @code{symbol-file} or
11734 @code{exec-file} commands in advance.
11736 @kindex add-shared-symbol-files
11738 @item add-shared-symbol-files @var{library-file}
11739 @itemx assf @var{library-file}
11740 The @code{add-shared-symbol-files} command can currently be used only
11741 in the Cygwin build of @value{GDBN} on MS-Windows OS, where it is an
11742 alias for the @code{dll-symbols} command (@pxref{Cygwin Native}).
11743 @value{GDBN} automatically looks for shared libraries, however if
11744 @value{GDBN} does not find yours, you can invoke
11745 @code{add-shared-symbol-files}. It takes one argument: the shared
11746 library's file name. @code{assf} is a shorthand alias for
11747 @code{add-shared-symbol-files}.
11750 @item section @var{section} @var{addr}
11751 The @code{section} command changes the base address of the named
11752 @var{section} of the exec file to @var{addr}. This can be used if the
11753 exec file does not contain section addresses, (such as in the
11754 @code{a.out} format), or when the addresses specified in the file
11755 itself are wrong. Each section must be changed separately. The
11756 @code{info files} command, described below, lists all the sections and
11760 @kindex info target
11763 @code{info files} and @code{info target} are synonymous; both print the
11764 current target (@pxref{Targets, ,Specifying a Debugging Target}),
11765 including the names of the executable and core dump files currently in
11766 use by @value{GDBN}, and the files from which symbols were loaded. The
11767 command @code{help target} lists all possible targets rather than
11770 @kindex maint info sections
11771 @item maint info sections
11772 Another command that can give you extra information about program sections
11773 is @code{maint info sections}. In addition to the section information
11774 displayed by @code{info files}, this command displays the flags and file
11775 offset of each section in the executable and core dump files. In addition,
11776 @code{maint info sections} provides the following command options (which
11777 may be arbitrarily combined):
11781 Display sections for all loaded object files, including shared libraries.
11782 @item @var{sections}
11783 Display info only for named @var{sections}.
11784 @item @var{section-flags}
11785 Display info only for sections for which @var{section-flags} are true.
11786 The section flags that @value{GDBN} currently knows about are:
11789 Section will have space allocated in the process when loaded.
11790 Set for all sections except those containing debug information.
11792 Section will be loaded from the file into the child process memory.
11793 Set for pre-initialized code and data, clear for @code{.bss} sections.
11795 Section needs to be relocated before loading.
11797 Section cannot be modified by the child process.
11799 Section contains executable code only.
11801 Section contains data only (no executable code).
11803 Section will reside in ROM.
11805 Section contains data for constructor/destructor lists.
11807 Section is not empty.
11809 An instruction to the linker to not output the section.
11810 @item COFF_SHARED_LIBRARY
11811 A notification to the linker that the section contains
11812 COFF shared library information.
11814 Section contains common symbols.
11817 @kindex set trust-readonly-sections
11818 @cindex read-only sections
11819 @item set trust-readonly-sections on
11820 Tell @value{GDBN} that readonly sections in your object file
11821 really are read-only (i.e.@: that their contents will not change).
11822 In that case, @value{GDBN} can fetch values from these sections
11823 out of the object file, rather than from the target program.
11824 For some targets (notably embedded ones), this can be a significant
11825 enhancement to debugging performance.
11827 The default is off.
11829 @item set trust-readonly-sections off
11830 Tell @value{GDBN} not to trust readonly sections. This means that
11831 the contents of the section might change while the program is running,
11832 and must therefore be fetched from the target when needed.
11834 @item show trust-readonly-sections
11835 Show the current setting of trusting readonly sections.
11838 All file-specifying commands allow both absolute and relative file names
11839 as arguments. @value{GDBN} always converts the file name to an absolute file
11840 name and remembers it that way.
11842 @cindex shared libraries
11843 @anchor{Shared Libraries}
11844 @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, HP-UX, SunOS, SVr4, Irix,
11845 and IBM RS/6000 AIX shared libraries.
11847 On MS-Windows @value{GDBN} must be linked with the Expat library to support
11848 shared libraries. @xref{Expat}.
11850 @value{GDBN} automatically loads symbol definitions from shared libraries
11851 when you use the @code{run} command, or when you examine a core file.
11852 (Before you issue the @code{run} command, @value{GDBN} does not understand
11853 references to a function in a shared library, however---unless you are
11854 debugging a core file).
11856 On HP-UX, if the program loads a library explicitly, @value{GDBN}
11857 automatically loads the symbols at the time of the @code{shl_load} call.
11859 @c FIXME: some @value{GDBN} release may permit some refs to undef
11860 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
11861 @c FIXME...lib; check this from time to time when updating manual
11863 There are times, however, when you may wish to not automatically load
11864 symbol definitions from shared libraries, such as when they are
11865 particularly large or there are many of them.
11867 To control the automatic loading of shared library symbols, use the
11871 @kindex set auto-solib-add
11872 @item set auto-solib-add @var{mode}
11873 If @var{mode} is @code{on}, symbols from all shared object libraries
11874 will be loaded automatically when the inferior begins execution, you
11875 attach to an independently started inferior, or when the dynamic linker
11876 informs @value{GDBN} that a new library has been loaded. If @var{mode}
11877 is @code{off}, symbols must be loaded manually, using the
11878 @code{sharedlibrary} command. The default value is @code{on}.
11880 @cindex memory used for symbol tables
11881 If your program uses lots of shared libraries with debug info that
11882 takes large amounts of memory, you can decrease the @value{GDBN}
11883 memory footprint by preventing it from automatically loading the
11884 symbols from shared libraries. To that end, type @kbd{set
11885 auto-solib-add off} before running the inferior, then load each
11886 library whose debug symbols you do need with @kbd{sharedlibrary
11887 @var{regexp}}, where @var{regexp} is a regular expression that matches
11888 the libraries whose symbols you want to be loaded.
11890 @kindex show auto-solib-add
11891 @item show auto-solib-add
11892 Display the current autoloading mode.
11895 @cindex load shared library
11896 To explicitly load shared library symbols, use the @code{sharedlibrary}
11900 @kindex info sharedlibrary
11903 @itemx info sharedlibrary
11904 Print the names of the shared libraries which are currently loaded.
11906 @kindex sharedlibrary
11908 @item sharedlibrary @var{regex}
11909 @itemx share @var{regex}
11910 Load shared object library symbols for files matching a
11911 Unix regular expression.
11912 As with files loaded automatically, it only loads shared libraries
11913 required by your program for a core file or after typing @code{run}. If
11914 @var{regex} is omitted all shared libraries required by your program are
11917 @item nosharedlibrary
11918 @kindex nosharedlibrary
11919 @cindex unload symbols from shared libraries
11920 Unload all shared object library symbols. This discards all symbols
11921 that have been loaded from all shared libraries. Symbols from shared
11922 libraries that were loaded by explicit user requests are not
11926 Sometimes you may wish that @value{GDBN} stops and gives you control
11927 when any of shared library events happen. Use the @code{set
11928 stop-on-solib-events} command for this:
11931 @item set stop-on-solib-events
11932 @kindex set stop-on-solib-events
11933 This command controls whether @value{GDBN} should give you control
11934 when the dynamic linker notifies it about some shared library event.
11935 The most common event of interest is loading or unloading of a new
11938 @item show stop-on-solib-events
11939 @kindex show stop-on-solib-events
11940 Show whether @value{GDBN} stops and gives you control when shared
11941 library events happen.
11944 Shared libraries are also supported in many cross or remote debugging
11945 configurations. A copy of the target's libraries need to be present on the
11946 host system; they need to be the same as the target libraries, although the
11947 copies on the target can be stripped as long as the copies on the host are
11950 @cindex where to look for shared libraries
11951 For remote debugging, you need to tell @value{GDBN} where the target
11952 libraries are, so that it can load the correct copies---otherwise, it
11953 may try to load the host's libraries. @value{GDBN} has two variables
11954 to specify the search directories for target libraries.
11957 @cindex prefix for shared library file names
11958 @cindex system root, alternate
11959 @kindex set solib-absolute-prefix
11960 @kindex set sysroot
11961 @item set sysroot @var{path}
11962 Use @var{path} as the system root for the program being debugged. Any
11963 absolute shared library paths will be prefixed with @var{path}; many
11964 runtime loaders store the absolute paths to the shared library in the
11965 target program's memory. If you use @code{set sysroot} to find shared
11966 libraries, they need to be laid out in the same way that they are on
11967 the target, with e.g.@: a @file{/lib} and @file{/usr/lib} hierarchy
11970 The @code{set solib-absolute-prefix} command is an alias for @code{set
11973 @cindex default system root
11974 @cindex @samp{--with-sysroot}
11975 You can set the default system root by using the configure-time
11976 @samp{--with-sysroot} option. If the system root is inside
11977 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
11978 @samp{--exec-prefix}), then the default system root will be updated
11979 automatically if the installed @value{GDBN} is moved to a new
11982 @kindex show sysroot
11984 Display the current shared library prefix.
11986 @kindex set solib-search-path
11987 @item set solib-search-path @var{path}
11988 If this variable is set, @var{path} is a colon-separated list of
11989 directories to search for shared libraries. @samp{solib-search-path}
11990 is used after @samp{sysroot} fails to locate the library, or if the
11991 path to the library is relative instead of absolute. If you want to
11992 use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set
11993 @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from
11994 finding your host's libraries. @samp{sysroot} is preferred; setting
11995 it to a nonexistent directory may interfere with automatic loading
11996 of shared library symbols.
11998 @kindex show solib-search-path
11999 @item show solib-search-path
12000 Display the current shared library search path.
12004 @node Separate Debug Files
12005 @section Debugging Information in Separate Files
12006 @cindex separate debugging information files
12007 @cindex debugging information in separate files
12008 @cindex @file{.debug} subdirectories
12009 @cindex debugging information directory, global
12010 @cindex global debugging information directory
12011 @cindex build ID, and separate debugging files
12012 @cindex @file{.build-id} directory
12014 @value{GDBN} allows you to put a program's debugging information in a
12015 file separate from the executable itself, in a way that allows
12016 @value{GDBN} to find and load the debugging information automatically.
12017 Since debugging information can be very large---sometimes larger
12018 than the executable code itself---some systems distribute debugging
12019 information for their executables in separate files, which users can
12020 install only when they need to debug a problem.
12022 @value{GDBN} supports two ways of specifying the separate debug info
12027 The executable contains a @dfn{debug link} that specifies the name of
12028 the separate debug info file. The separate debug file's name is
12029 usually @file{@var{executable}.debug}, where @var{executable} is the
12030 name of the corresponding executable file without leading directories
12031 (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the
12032 debug link specifies a CRC32 checksum for the debug file, which
12033 @value{GDBN} uses to validate that the executable and the debug file
12034 came from the same build.
12037 The executable contains a @dfn{build ID}, a unique bit string that is
12038 also present in the corresponding debug info file. (This is supported
12039 only on some operating systems, notably those which use the ELF format
12040 for binary files and the @sc{gnu} Binutils.) For more details about
12041 this feature, see the description of the @option{--build-id}
12042 command-line option in @ref{Options, , Command Line Options, ld.info,
12043 The GNU Linker}. The debug info file's name is not specified
12044 explicitly by the build ID, but can be computed from the build ID, see
12048 Depending on the way the debug info file is specified, @value{GDBN}
12049 uses two different methods of looking for the debug file:
12053 For the ``debug link'' method, @value{GDBN} looks up the named file in
12054 the directory of the executable file, then in a subdirectory of that
12055 directory named @file{.debug}, and finally under the global debug
12056 directory, in a subdirectory whose name is identical to the leading
12057 directories of the executable's absolute file name.
12060 For the ``build ID'' method, @value{GDBN} looks in the
12061 @file{.build-id} subdirectory of the global debug directory for a file
12062 named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
12063 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
12064 are the rest of the bit string. (Real build ID strings are 32 or more
12065 hex characters, not 10.)
12068 So, for example, suppose you ask @value{GDBN} to debug
12069 @file{/usr/bin/ls}, which has a debug link that specifies the
12070 file @file{ls.debug}, and a build ID whose value in hex is
12071 @code{abcdef1234}. If the global debug directory is
12072 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
12073 debug information files, in the indicated order:
12077 @file{/usr/lib/debug/.build-id/ab/cdef1234.debug}
12079 @file{/usr/bin/ls.debug}
12081 @file{/usr/bin/.debug/ls.debug}
12083 @file{/usr/lib/debug/usr/bin/ls.debug}.
12086 You can set the global debugging info directory's name, and view the
12087 name @value{GDBN} is currently using.
12091 @kindex set debug-file-directory
12092 @item set debug-file-directory @var{directory}
12093 Set the directory which @value{GDBN} searches for separate debugging
12094 information files to @var{directory}.
12096 @kindex show debug-file-directory
12097 @item show debug-file-directory
12098 Show the directory @value{GDBN} searches for separate debugging
12103 @cindex @code{.gnu_debuglink} sections
12104 @cindex debug link sections
12105 A debug link is a special section of the executable file named
12106 @code{.gnu_debuglink}. The section must contain:
12110 A filename, with any leading directory components removed, followed by
12113 zero to three bytes of padding, as needed to reach the next four-byte
12114 boundary within the section, and
12116 a four-byte CRC checksum, stored in the same endianness used for the
12117 executable file itself. The checksum is computed on the debugging
12118 information file's full contents by the function given below, passing
12119 zero as the @var{crc} argument.
12122 Any executable file format can carry a debug link, as long as it can
12123 contain a section named @code{.gnu_debuglink} with the contents
12126 @cindex @code{.note.gnu.build-id} sections
12127 @cindex build ID sections
12128 The build ID is a special section in the executable file (and in other
12129 ELF binary files that @value{GDBN} may consider). This section is
12130 often named @code{.note.gnu.build-id}, but that name is not mandatory.
12131 It contains unique identification for the built files---the ID remains
12132 the same across multiple builds of the same build tree. The default
12133 algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the
12134 content for the build ID string. The same section with an identical
12135 value is present in the original built binary with symbols, in its
12136 stripped variant, and in the separate debugging information file.
12138 The debugging information file itself should be an ordinary
12139 executable, containing a full set of linker symbols, sections, and
12140 debugging information. The sections of the debugging information file
12141 should have the same names, addresses, and sizes as the original file,
12142 but they need not contain any data---much like a @code{.bss} section
12143 in an ordinary executable.
12145 The @sc{gnu} binary utilities (Binutils) package includes the
12146 @samp{objcopy} utility that can produce
12147 the separated executable / debugging information file pairs using the
12148 following commands:
12151 @kbd{objcopy --only-keep-debug foo foo.debug}
12156 These commands remove the debugging
12157 information from the executable file @file{foo} and place it in the file
12158 @file{foo.debug}. You can use the first, second or both methods to link the
12163 The debug link method needs the following additional command to also leave
12164 behind a debug link in @file{foo}:
12167 @kbd{objcopy --add-gnu-debuglink=foo.debug foo}
12170 Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains
12171 a version of the @code{strip} command such that the command @kbd{strip foo -f
12172 foo.debug} has the same functionality as the two @code{objcopy} commands and
12173 the @code{ln -s} command above, together.
12176 Build ID gets embedded into the main executable using @code{ld --build-id} or
12177 the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus
12178 compatibility fixes for debug files separation are present in @sc{gnu} binary
12179 utilities (Binutils) package since version 2.18.
12184 Since there are many different ways to compute CRC's for the debug
12185 link (different polynomials, reversals, byte ordering, etc.), the
12186 simplest way to describe the CRC used in @code{.gnu_debuglink}
12187 sections is to give the complete code for a function that computes it:
12189 @kindex gnu_debuglink_crc32
12192 gnu_debuglink_crc32 (unsigned long crc,
12193 unsigned char *buf, size_t len)
12195 static const unsigned long crc32_table[256] =
12197 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
12198 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
12199 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
12200 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
12201 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
12202 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
12203 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
12204 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
12205 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
12206 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
12207 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
12208 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
12209 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
12210 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
12211 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
12212 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
12213 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
12214 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
12215 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
12216 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
12217 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
12218 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
12219 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
12220 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
12221 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
12222 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
12223 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
12224 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
12225 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
12226 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
12227 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
12228 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
12229 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
12230 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
12231 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
12232 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
12233 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
12234 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
12235 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
12236 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
12237 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
12238 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
12239 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
12240 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
12241 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
12242 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
12243 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
12244 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
12245 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
12246 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
12247 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
12250 unsigned char *end;
12252 crc = ~crc & 0xffffffff;
12253 for (end = buf + len; buf < end; ++buf)
12254 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
12255 return ~crc & 0xffffffff;
12260 This computation does not apply to the ``build ID'' method.
12263 @node Symbol Errors
12264 @section Errors Reading Symbol Files
12266 While reading a symbol file, @value{GDBN} occasionally encounters problems,
12267 such as symbol types it does not recognize, or known bugs in compiler
12268 output. By default, @value{GDBN} does not notify you of such problems, since
12269 they are relatively common and primarily of interest to people
12270 debugging compilers. If you are interested in seeing information
12271 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
12272 only one message about each such type of problem, no matter how many
12273 times the problem occurs; or you can ask @value{GDBN} to print more messages,
12274 to see how many times the problems occur, with the @code{set
12275 complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
12278 The messages currently printed, and their meanings, include:
12281 @item inner block not inside outer block in @var{symbol}
12283 The symbol information shows where symbol scopes begin and end
12284 (such as at the start of a function or a block of statements). This
12285 error indicates that an inner scope block is not fully contained
12286 in its outer scope blocks.
12288 @value{GDBN} circumvents the problem by treating the inner block as if it had
12289 the same scope as the outer block. In the error message, @var{symbol}
12290 may be shown as ``@code{(don't know)}'' if the outer block is not a
12293 @item block at @var{address} out of order
12295 The symbol information for symbol scope blocks should occur in
12296 order of increasing addresses. This error indicates that it does not
12299 @value{GDBN} does not circumvent this problem, and has trouble
12300 locating symbols in the source file whose symbols it is reading. (You
12301 can often determine what source file is affected by specifying
12302 @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and
12305 @item bad block start address patched
12307 The symbol information for a symbol scope block has a start address
12308 smaller than the address of the preceding source line. This is known
12309 to occur in the SunOS 4.1.1 (and earlier) C compiler.
12311 @value{GDBN} circumvents the problem by treating the symbol scope block as
12312 starting on the previous source line.
12314 @item bad string table offset in symbol @var{n}
12317 Symbol number @var{n} contains a pointer into the string table which is
12318 larger than the size of the string table.
12320 @value{GDBN} circumvents the problem by considering the symbol to have the
12321 name @code{foo}, which may cause other problems if many symbols end up
12324 @item unknown symbol type @code{0x@var{nn}}
12326 The symbol information contains new data types that @value{GDBN} does
12327 not yet know how to read. @code{0x@var{nn}} is the symbol type of the
12328 uncomprehended information, in hexadecimal.
12330 @value{GDBN} circumvents the error by ignoring this symbol information.
12331 This usually allows you to debug your program, though certain symbols
12332 are not accessible. If you encounter such a problem and feel like
12333 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
12334 on @code{complain}, then go up to the function @code{read_dbx_symtab}
12335 and examine @code{*bufp} to see the symbol.
12337 @item stub type has NULL name
12339 @value{GDBN} could not find the full definition for a struct or class.
12341 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
12342 The symbol information for a C@t{++} member function is missing some
12343 information that recent versions of the compiler should have output for
12346 @item info mismatch between compiler and debugger
12348 @value{GDBN} could not parse a type specification output by the compiler.
12353 @chapter Specifying a Debugging Target
12355 @cindex debugging target
12356 A @dfn{target} is the execution environment occupied by your program.
12358 Often, @value{GDBN} runs in the same host environment as your program;
12359 in that case, the debugging target is specified as a side effect when
12360 you use the @code{file} or @code{core} commands. When you need more
12361 flexibility---for example, running @value{GDBN} on a physically separate
12362 host, or controlling a standalone system over a serial port or a
12363 realtime system over a TCP/IP connection---you can use the @code{target}
12364 command to specify one of the target types configured for @value{GDBN}
12365 (@pxref{Target Commands, ,Commands for Managing Targets}).
12367 @cindex target architecture
12368 It is possible to build @value{GDBN} for several different @dfn{target
12369 architectures}. When @value{GDBN} is built like that, you can choose
12370 one of the available architectures with the @kbd{set architecture}
12374 @kindex set architecture
12375 @kindex show architecture
12376 @item set architecture @var{arch}
12377 This command sets the current target architecture to @var{arch}. The
12378 value of @var{arch} can be @code{"auto"}, in addition to one of the
12379 supported architectures.
12381 @item show architecture
12382 Show the current target architecture.
12384 @item set processor
12386 @kindex set processor
12387 @kindex show processor
12388 These are alias commands for, respectively, @code{set architecture}
12389 and @code{show architecture}.
12393 * Active Targets:: Active targets
12394 * Target Commands:: Commands for managing targets
12395 * Byte Order:: Choosing target byte order
12398 @node Active Targets
12399 @section Active Targets
12401 @cindex stacking targets
12402 @cindex active targets
12403 @cindex multiple targets
12405 There are three classes of targets: processes, core files, and
12406 executable files. @value{GDBN} can work concurrently on up to three
12407 active targets, one in each class. This allows you to (for example)
12408 start a process and inspect its activity without abandoning your work on
12411 For example, if you execute @samp{gdb a.out}, then the executable file
12412 @code{a.out} is the only active target. If you designate a core file as
12413 well---presumably from a prior run that crashed and coredumped---then
12414 @value{GDBN} has two active targets and uses them in tandem, looking
12415 first in the corefile target, then in the executable file, to satisfy
12416 requests for memory addresses. (Typically, these two classes of target
12417 are complementary, since core files contain only a program's
12418 read-write memory---variables and so on---plus machine status, while
12419 executable files contain only the program text and initialized data.)
12421 When you type @code{run}, your executable file becomes an active process
12422 target as well. When a process target is active, all @value{GDBN}
12423 commands requesting memory addresses refer to that target; addresses in
12424 an active core file or executable file target are obscured while the
12425 process target is active.
12427 Use the @code{core-file} and @code{exec-file} commands to select a new
12428 core file or executable target (@pxref{Files, ,Commands to Specify
12429 Files}). To specify as a target a process that is already running, use
12430 the @code{attach} command (@pxref{Attach, ,Debugging an Already-running
12433 @node Target Commands
12434 @section Commands for Managing Targets
12437 @item target @var{type} @var{parameters}
12438 Connects the @value{GDBN} host environment to a target machine or
12439 process. A target is typically a protocol for talking to debugging
12440 facilities. You use the argument @var{type} to specify the type or
12441 protocol of the target machine.
12443 Further @var{parameters} are interpreted by the target protocol, but
12444 typically include things like device names or host names to connect
12445 with, process numbers, and baud rates.
12447 The @code{target} command does not repeat if you press @key{RET} again
12448 after executing the command.
12450 @kindex help target
12452 Displays the names of all targets available. To display targets
12453 currently selected, use either @code{info target} or @code{info files}
12454 (@pxref{Files, ,Commands to Specify Files}).
12456 @item help target @var{name}
12457 Describe a particular target, including any parameters necessary to
12460 @kindex set gnutarget
12461 @item set gnutarget @var{args}
12462 @value{GDBN} uses its own library BFD to read your files. @value{GDBN}
12463 knows whether it is reading an @dfn{executable},
12464 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
12465 with the @code{set gnutarget} command. Unlike most @code{target} commands,
12466 with @code{gnutarget} the @code{target} refers to a program, not a machine.
12469 @emph{Warning:} To specify a file format with @code{set gnutarget},
12470 you must know the actual BFD name.
12474 @xref{Files, , Commands to Specify Files}.
12476 @kindex show gnutarget
12477 @item show gnutarget
12478 Use the @code{show gnutarget} command to display what file format
12479 @code{gnutarget} is set to read. If you have not set @code{gnutarget},
12480 @value{GDBN} will determine the file format for each file automatically,
12481 and @code{show gnutarget} displays @samp{The current BDF target is "auto"}.
12484 @cindex common targets
12485 Here are some common targets (available, or not, depending on the GDB
12490 @item target exec @var{program}
12491 @cindex executable file target
12492 An executable file. @samp{target exec @var{program}} is the same as
12493 @samp{exec-file @var{program}}.
12495 @item target core @var{filename}
12496 @cindex core dump file target
12497 A core dump file. @samp{target core @var{filename}} is the same as
12498 @samp{core-file @var{filename}}.
12500 @item target remote @var{medium}
12501 @cindex remote target
12502 A remote system connected to @value{GDBN} via a serial line or network
12503 connection. This command tells @value{GDBN} to use its own remote
12504 protocol over @var{medium} for debugging. @xref{Remote Debugging}.
12506 For example, if you have a board connected to @file{/dev/ttya} on the
12507 machine running @value{GDBN}, you could say:
12510 target remote /dev/ttya
12513 @code{target remote} supports the @code{load} command. This is only
12514 useful if you have some other way of getting the stub to the target
12515 system, and you can put it somewhere in memory where it won't get
12516 clobbered by the download.
12519 @cindex built-in simulator target
12520 Builtin CPU simulator. @value{GDBN} includes simulators for most architectures.
12528 works; however, you cannot assume that a specific memory map, device
12529 drivers, or even basic I/O is available, although some simulators do
12530 provide these. For info about any processor-specific simulator details,
12531 see the appropriate section in @ref{Embedded Processors, ,Embedded
12536 Some configurations may include these targets as well:
12540 @item target nrom @var{dev}
12541 @cindex NetROM ROM emulator target
12542 NetROM ROM emulator. This target only supports downloading.
12546 Different targets are available on different configurations of @value{GDBN};
12547 your configuration may have more or fewer targets.
12549 Many remote targets require you to download the executable's code once
12550 you've successfully established a connection. You may wish to control
12551 various aspects of this process.
12556 @kindex set hash@r{, for remote monitors}
12557 @cindex hash mark while downloading
12558 This command controls whether a hash mark @samp{#} is displayed while
12559 downloading a file to the remote monitor. If on, a hash mark is
12560 displayed after each S-record is successfully downloaded to the
12564 @kindex show hash@r{, for remote monitors}
12565 Show the current status of displaying the hash mark.
12567 @item set debug monitor
12568 @kindex set debug monitor
12569 @cindex display remote monitor communications
12570 Enable or disable display of communications messages between
12571 @value{GDBN} and the remote monitor.
12573 @item show debug monitor
12574 @kindex show debug monitor
12575 Show the current status of displaying communications between
12576 @value{GDBN} and the remote monitor.
12581 @kindex load @var{filename}
12582 @item load @var{filename}
12583 Depending on what remote debugging facilities are configured into
12584 @value{GDBN}, the @code{load} command may be available. Where it exists, it
12585 is meant to make @var{filename} (an executable) available for debugging
12586 on the remote system---by downloading, or dynamic linking, for example.
12587 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
12588 the @code{add-symbol-file} command.
12590 If your @value{GDBN} does not have a @code{load} command, attempting to
12591 execute it gets the error message ``@code{You can't do that when your
12592 target is @dots{}}''
12594 The file is loaded at whatever address is specified in the executable.
12595 For some object file formats, you can specify the load address when you
12596 link the program; for other formats, like a.out, the object file format
12597 specifies a fixed address.
12598 @c FIXME! This would be a good place for an xref to the GNU linker doc.
12600 Depending on the remote side capabilities, @value{GDBN} may be able to
12601 load programs into flash memory.
12603 @code{load} does not repeat if you press @key{RET} again after using it.
12607 @section Choosing Target Byte Order
12609 @cindex choosing target byte order
12610 @cindex target byte order
12612 Some types of processors, such as the MIPS, PowerPC, and Renesas SH,
12613 offer the ability to run either big-endian or little-endian byte
12614 orders. Usually the executable or symbol will include a bit to
12615 designate the endian-ness, and you will not need to worry about
12616 which to use. However, you may still find it useful to adjust
12617 @value{GDBN}'s idea of processor endian-ness manually.
12621 @item set endian big
12622 Instruct @value{GDBN} to assume the target is big-endian.
12624 @item set endian little
12625 Instruct @value{GDBN} to assume the target is little-endian.
12627 @item set endian auto
12628 Instruct @value{GDBN} to use the byte order associated with the
12632 Display @value{GDBN}'s current idea of the target byte order.
12636 Note that these commands merely adjust interpretation of symbolic
12637 data on the host, and that they have absolutely no effect on the
12641 @node Remote Debugging
12642 @chapter Debugging Remote Programs
12643 @cindex remote debugging
12645 If you are trying to debug a program running on a machine that cannot run
12646 @value{GDBN} in the usual way, it is often useful to use remote debugging.
12647 For example, you might use remote debugging on an operating system kernel,
12648 or on a small system which does not have a general purpose operating system
12649 powerful enough to run a full-featured debugger.
12651 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
12652 to make this work with particular debugging targets. In addition,
12653 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
12654 but not specific to any particular target system) which you can use if you
12655 write the remote stubs---the code that runs on the remote system to
12656 communicate with @value{GDBN}.
12658 Other remote targets may be available in your
12659 configuration of @value{GDBN}; use @code{help target} to list them.
12662 * Connecting:: Connecting to a remote target
12663 * Server:: Using the gdbserver program
12664 * Remote Configuration:: Remote configuration
12665 * Remote Stub:: Implementing a remote stub
12669 @section Connecting to a Remote Target
12671 On the @value{GDBN} host machine, you will need an unstripped copy of
12672 your program, since @value{GDBN} needs symbol and debugging information.
12673 Start up @value{GDBN} as usual, using the name of the local copy of your
12674 program as the first argument.
12676 @cindex @code{target remote}
12677 @value{GDBN} can communicate with the target over a serial line, or
12678 over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In
12679 each case, @value{GDBN} uses the same protocol for debugging your
12680 program; only the medium carrying the debugging packets varies. The
12681 @code{target remote} command establishes a connection to the target.
12682 Its arguments indicate which medium to use:
12686 @item target remote @var{serial-device}
12687 @cindex serial line, @code{target remote}
12688 Use @var{serial-device} to communicate with the target. For example,
12689 to use a serial line connected to the device named @file{/dev/ttyb}:
12692 target remote /dev/ttyb
12695 If you're using a serial line, you may want to give @value{GDBN} the
12696 @w{@samp{--baud}} option, or use the @code{set remotebaud} command
12697 (@pxref{Remote Configuration, set remotebaud}) before the
12698 @code{target} command.
12700 @item target remote @code{@var{host}:@var{port}}
12701 @itemx target remote @code{tcp:@var{host}:@var{port}}
12702 @cindex @acronym{TCP} port, @code{target remote}
12703 Debug using a @acronym{TCP} connection to @var{port} on @var{host}.
12704 The @var{host} may be either a host name or a numeric @acronym{IP}
12705 address; @var{port} must be a decimal number. The @var{host} could be
12706 the target machine itself, if it is directly connected to the net, or
12707 it might be a terminal server which in turn has a serial line to the
12710 For example, to connect to port 2828 on a terminal server named
12714 target remote manyfarms:2828
12717 If your remote target is actually running on the same machine as your
12718 debugger session (e.g.@: a simulator for your target running on the
12719 same host), you can omit the hostname. For example, to connect to
12720 port 1234 on your local machine:
12723 target remote :1234
12727 Note that the colon is still required here.
12729 @item target remote @code{udp:@var{host}:@var{port}}
12730 @cindex @acronym{UDP} port, @code{target remote}
12731 Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to
12732 connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}:
12735 target remote udp:manyfarms:2828
12738 When using a @acronym{UDP} connection for remote debugging, you should
12739 keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP}
12740 can silently drop packets on busy or unreliable networks, which will
12741 cause havoc with your debugging session.
12743 @item target remote | @var{command}
12744 @cindex pipe, @code{target remote} to
12745 Run @var{command} in the background and communicate with it using a
12746 pipe. The @var{command} is a shell command, to be parsed and expanded
12747 by the system's command shell, @code{/bin/sh}; it should expect remote
12748 protocol packets on its standard input, and send replies on its
12749 standard output. You could use this to run a stand-alone simulator
12750 that speaks the remote debugging protocol, to make net connections
12751 using programs like @code{ssh}, or for other similar tricks.
12753 If @var{command} closes its standard output (perhaps by exiting),
12754 @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the
12755 program has already exited, this will have no effect.)
12759 Once the connection has been established, you can use all the usual
12760 commands to examine and change data and to step and continue the
12763 @cindex interrupting remote programs
12764 @cindex remote programs, interrupting
12765 Whenever @value{GDBN} is waiting for the remote program, if you type the
12766 interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the
12767 program. This may or may not succeed, depending in part on the hardware
12768 and the serial drivers the remote system uses. If you type the
12769 interrupt character once again, @value{GDBN} displays this prompt:
12772 Interrupted while waiting for the program.
12773 Give up (and stop debugging it)? (y or n)
12776 If you type @kbd{y}, @value{GDBN} abandons the remote debugging session.
12777 (If you decide you want to try again later, you can use @samp{target
12778 remote} again to connect once more.) If you type @kbd{n}, @value{GDBN}
12779 goes back to waiting.
12782 @kindex detach (remote)
12784 When you have finished debugging the remote program, you can use the
12785 @code{detach} command to release it from @value{GDBN} control.
12786 Detaching from the target normally resumes its execution, but the results
12787 will depend on your particular remote stub. After the @code{detach}
12788 command, @value{GDBN} is free to connect to another target.
12792 The @code{disconnect} command behaves like @code{detach}, except that
12793 the target is generally not resumed. It will wait for @value{GDBN}
12794 (this instance or another one) to connect and continue debugging. After
12795 the @code{disconnect} command, @value{GDBN} is again free to connect to
12798 @cindex send command to remote monitor
12799 @cindex extend @value{GDBN} for remote targets
12800 @cindex add new commands for external monitor
12802 @item monitor @var{cmd}
12803 This command allows you to send arbitrary commands directly to the
12804 remote monitor. Since @value{GDBN} doesn't care about the commands it
12805 sends like this, this command is the way to extend @value{GDBN}---you
12806 can add new commands that only the external monitor will understand
12811 @section Using the @code{gdbserver} Program
12814 @cindex remote connection without stubs
12815 @code{gdbserver} is a control program for Unix-like systems, which
12816 allows you to connect your program with a remote @value{GDBN} via
12817 @code{target remote}---but without linking in the usual debugging stub.
12819 @code{gdbserver} is not a complete replacement for the debugging stubs,
12820 because it requires essentially the same operating-system facilities
12821 that @value{GDBN} itself does. In fact, a system that can run
12822 @code{gdbserver} to connect to a remote @value{GDBN} could also run
12823 @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless,
12824 because it is a much smaller program than @value{GDBN} itself. It is
12825 also easier to port than all of @value{GDBN}, so you may be able to get
12826 started more quickly on a new system by using @code{gdbserver}.
12827 Finally, if you develop code for real-time systems, you may find that
12828 the tradeoffs involved in real-time operation make it more convenient to
12829 do as much development work as possible on another system, for example
12830 by cross-compiling. You can use @code{gdbserver} to make a similar
12831 choice for debugging.
12833 @value{GDBN} and @code{gdbserver} communicate via either a serial line
12834 or a TCP connection, using the standard @value{GDBN} remote serial
12838 @item On the target machine,
12839 you need to have a copy of the program you want to debug.
12840 @code{gdbserver} does not need your program's symbol table, so you can
12841 strip the program if necessary to save space. @value{GDBN} on the host
12842 system does all the symbol handling.
12844 To use the server, you must tell it how to communicate with @value{GDBN};
12845 the name of your program; and the arguments for your program. The usual
12849 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
12852 @var{comm} is either a device name (to use a serial line) or a TCP
12853 hostname and portnumber. For example, to debug Emacs with the argument
12854 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
12858 target> gdbserver /dev/com1 emacs foo.txt
12861 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
12864 To use a TCP connection instead of a serial line:
12867 target> gdbserver host:2345 emacs foo.txt
12870 The only difference from the previous example is the first argument,
12871 specifying that you are communicating with the host @value{GDBN} via
12872 TCP. The @samp{host:2345} argument means that @code{gdbserver} is to
12873 expect a TCP connection from machine @samp{host} to local TCP port 2345.
12874 (Currently, the @samp{host} part is ignored.) You can choose any number
12875 you want for the port number as long as it does not conflict with any
12876 TCP ports already in use on the target system (for example, @code{23} is
12877 reserved for @code{telnet}).@footnote{If you choose a port number that
12878 conflicts with another service, @code{gdbserver} prints an error message
12879 and exits.} You must use the same port number with the host @value{GDBN}
12880 @code{target remote} command.
12882 On some targets, @code{gdbserver} can also attach to running programs.
12883 This is accomplished via the @code{--attach} argument. The syntax is:
12886 target> gdbserver @var{comm} --attach @var{pid}
12889 @var{pid} is the process ID of a currently running process. It isn't necessary
12890 to point @code{gdbserver} at a binary for the running process.
12893 @cindex attach to a program by name
12894 You can debug processes by name instead of process ID if your target has the
12895 @code{pidof} utility:
12898 target> gdbserver @var{comm} --attach `pidof @var{program}`
12901 In case more than one copy of @var{program} is running, or @var{program}
12902 has multiple threads, most versions of @code{pidof} support the
12903 @code{-s} option to only return the first process ID.
12905 @item On the host machine,
12906 first make sure you have the necessary symbol files. Load symbols for
12907 your application using the @code{file} command before you connect. Use
12908 @code{set sysroot} to locate target libraries (unless your @value{GDBN}
12909 was compiled with the correct sysroot using @code{--with-system-root}).
12911 The symbol file and target libraries must exactly match the executable
12912 and libraries on the target, with one exception: the files on the host
12913 system should not be stripped, even if the files on the target system
12914 are. Mismatched or missing files will lead to confusing results
12915 during debugging. On @sc{gnu}/Linux targets, mismatched or missing
12916 files may also prevent @code{gdbserver} from debugging multi-threaded
12919 Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
12920 For TCP connections, you must start up @code{gdbserver} prior to using
12921 the @code{target remote} command. Otherwise you may get an error whose
12922 text depends on the host system, but which usually looks something like
12923 @samp{Connection refused}. You don't need to use the @code{load}
12924 command in @value{GDBN} when using @code{gdbserver}, since the program is
12925 already on the target.
12929 @subsection Monitor Commands for @code{gdbserver}
12930 @cindex monitor commands, for @code{gdbserver}
12932 During a @value{GDBN} session using @code{gdbserver}, you can use the
12933 @code{monitor} command to send special requests to @code{gdbserver}.
12934 Here are the available commands; they are only of interest when
12935 debugging @value{GDBN} or @code{gdbserver}.
12939 List the available monitor commands.
12941 @item monitor set debug 0
12942 @itemx monitor set debug 1
12943 Disable or enable general debugging messages.
12945 @item monitor set remote-debug 0
12946 @itemx monitor set remote-debug 1
12947 Disable or enable specific debugging messages associated with the remote
12948 protocol (@pxref{Remote Protocol}).
12952 @node Remote Configuration
12953 @section Remote Configuration
12956 @kindex show remote
12957 This section documents the configuration options available when
12958 debugging remote programs. For the options related to the File I/O
12959 extensions of the remote protocol, see @ref{system,
12960 system-call-allowed}.
12963 @item set remoteaddresssize @var{bits}
12964 @cindex address size for remote targets
12965 @cindex bits in remote address
12966 Set the maximum size of address in a memory packet to the specified
12967 number of bits. @value{GDBN} will mask off the address bits above
12968 that number, when it passes addresses to the remote target. The
12969 default value is the number of bits in the target's address.
12971 @item show remoteaddresssize
12972 Show the current value of remote address size in bits.
12974 @item set remotebaud @var{n}
12975 @cindex baud rate for remote targets
12976 Set the baud rate for the remote serial I/O to @var{n} baud. The
12977 value is used to set the speed of the serial port used for debugging
12980 @item show remotebaud
12981 Show the current speed of the remote connection.
12983 @item set remotebreak
12984 @cindex interrupt remote programs
12985 @cindex BREAK signal instead of Ctrl-C
12986 @anchor{set remotebreak}
12987 If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote
12988 when you type @kbd{Ctrl-c} to interrupt the program running
12989 on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C}
12990 character instead. The default is off, since most remote systems
12991 expect to see @samp{Ctrl-C} as the interrupt signal.
12993 @item show remotebreak
12994 Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to
12995 interrupt the remote program.
12997 @item set remoteflow on
12998 @itemx set remoteflow off
12999 @kindex set remoteflow
13000 Enable or disable hardware flow control (@code{RTS}/@code{CTS})
13001 on the serial port used to communicate to the remote target.
13003 @item show remoteflow
13004 @kindex show remoteflow
13005 Show the current setting of hardware flow control.
13007 @item set remotelogbase @var{base}
13008 Set the base (a.k.a.@: radix) of logging serial protocol
13009 communications to @var{base}. Supported values of @var{base} are:
13010 @code{ascii}, @code{octal}, and @code{hex}. The default is
13013 @item show remotelogbase
13014 Show the current setting of the radix for logging remote serial
13017 @item set remotelogfile @var{file}
13018 @cindex record serial communications on file
13019 Record remote serial communications on the named @var{file}. The
13020 default is not to record at all.
13022 @item show remotelogfile.
13023 Show the current setting of the file name on which to record the
13024 serial communications.
13026 @item set remotetimeout @var{num}
13027 @cindex timeout for serial communications
13028 @cindex remote timeout
13029 Set the timeout limit to wait for the remote target to respond to
13030 @var{num} seconds. The default is 2 seconds.
13032 @item show remotetimeout
13033 Show the current number of seconds to wait for the remote target
13036 @cindex limit hardware breakpoints and watchpoints
13037 @cindex remote target, limit break- and watchpoints
13038 @anchor{set remote hardware-watchpoint-limit}
13039 @anchor{set remote hardware-breakpoint-limit}
13040 @item set remote hardware-watchpoint-limit @var{limit}
13041 @itemx set remote hardware-breakpoint-limit @var{limit}
13042 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
13043 watchpoints. A limit of -1, the default, is treated as unlimited.
13046 @cindex remote packets, enabling and disabling
13047 The @value{GDBN} remote protocol autodetects the packets supported by
13048 your debugging stub. If you need to override the autodetection, you
13049 can use these commands to enable or disable individual packets. Each
13050 packet can be set to @samp{on} (the remote target supports this
13051 packet), @samp{off} (the remote target does not support this packet),
13052 or @samp{auto} (detect remote target support for this packet). They
13053 all default to @samp{auto}. For more information about each packet,
13054 see @ref{Remote Protocol}.
13056 During normal use, you should not have to use any of these commands.
13057 If you do, that may be a bug in your remote debugging stub, or a bug
13058 in @value{GDBN}. You may want to report the problem to the
13059 @value{GDBN} developers.
13061 For each packet @var{name}, the command to enable or disable the
13062 packet is @code{set remote @var{name}-packet}. The available settings
13065 @multitable @columnfractions 0.28 0.32 0.25
13068 @tab Related Features
13070 @item @code{fetch-register}
13072 @tab @code{info registers}
13074 @item @code{set-register}
13078 @item @code{binary-download}
13080 @tab @code{load}, @code{set}
13082 @item @code{read-aux-vector}
13083 @tab @code{qXfer:auxv:read}
13084 @tab @code{info auxv}
13086 @item @code{symbol-lookup}
13087 @tab @code{qSymbol}
13088 @tab Detecting multiple threads
13090 @item @code{verbose-resume}
13092 @tab Stepping or resuming multiple threads
13094 @item @code{software-breakpoint}
13098 @item @code{hardware-breakpoint}
13102 @item @code{write-watchpoint}
13106 @item @code{read-watchpoint}
13110 @item @code{access-watchpoint}
13114 @item @code{target-features}
13115 @tab @code{qXfer:features:read}
13116 @tab @code{set architecture}
13118 @item @code{library-info}
13119 @tab @code{qXfer:libraries:read}
13120 @tab @code{info sharedlibrary}
13122 @item @code{memory-map}
13123 @tab @code{qXfer:memory-map:read}
13124 @tab @code{info mem}
13126 @item @code{read-spu-object}
13127 @tab @code{qXfer:spu:read}
13128 @tab @code{info spu}
13130 @item @code{write-spu-object}
13131 @tab @code{qXfer:spu:write}
13132 @tab @code{info spu}
13134 @item @code{get-thread-local-@*storage-address}
13135 @tab @code{qGetTLSAddr}
13136 @tab Displaying @code{__thread} variables
13138 @item @code{supported-packets}
13139 @tab @code{qSupported}
13140 @tab Remote communications parameters
13142 @item @code{pass-signals}
13143 @tab @code{QPassSignals}
13144 @tab @code{handle @var{signal}}
13149 @section Implementing a Remote Stub
13151 @cindex debugging stub, example
13152 @cindex remote stub, example
13153 @cindex stub example, remote debugging
13154 The stub files provided with @value{GDBN} implement the target side of the
13155 communication protocol, and the @value{GDBN} side is implemented in the
13156 @value{GDBN} source file @file{remote.c}. Normally, you can simply allow
13157 these subroutines to communicate, and ignore the details. (If you're
13158 implementing your own stub file, you can still ignore the details: start
13159 with one of the existing stub files. @file{sparc-stub.c} is the best
13160 organized, and therefore the easiest to read.)
13162 @cindex remote serial debugging, overview
13163 To debug a program running on another machine (the debugging
13164 @dfn{target} machine), you must first arrange for all the usual
13165 prerequisites for the program to run by itself. For example, for a C
13170 A startup routine to set up the C runtime environment; these usually
13171 have a name like @file{crt0}. The startup routine may be supplied by
13172 your hardware supplier, or you may have to write your own.
13175 A C subroutine library to support your program's
13176 subroutine calls, notably managing input and output.
13179 A way of getting your program to the other machine---for example, a
13180 download program. These are often supplied by the hardware
13181 manufacturer, but you may have to write your own from hardware
13185 The next step is to arrange for your program to use a serial port to
13186 communicate with the machine where @value{GDBN} is running (the @dfn{host}
13187 machine). In general terms, the scheme looks like this:
13191 @value{GDBN} already understands how to use this protocol; when everything
13192 else is set up, you can simply use the @samp{target remote} command
13193 (@pxref{Targets,,Specifying a Debugging Target}).
13195 @item On the target,
13196 you must link with your program a few special-purpose subroutines that
13197 implement the @value{GDBN} remote serial protocol. The file containing these
13198 subroutines is called a @dfn{debugging stub}.
13200 On certain remote targets, you can use an auxiliary program
13201 @code{gdbserver} instead of linking a stub into your program.
13202 @xref{Server,,Using the @code{gdbserver} Program}, for details.
13205 The debugging stub is specific to the architecture of the remote
13206 machine; for example, use @file{sparc-stub.c} to debug programs on
13209 @cindex remote serial stub list
13210 These working remote stubs are distributed with @value{GDBN}:
13215 @cindex @file{i386-stub.c}
13218 For Intel 386 and compatible architectures.
13221 @cindex @file{m68k-stub.c}
13222 @cindex Motorola 680x0
13224 For Motorola 680x0 architectures.
13227 @cindex @file{sh-stub.c}
13230 For Renesas SH architectures.
13233 @cindex @file{sparc-stub.c}
13235 For @sc{sparc} architectures.
13237 @item sparcl-stub.c
13238 @cindex @file{sparcl-stub.c}
13241 For Fujitsu @sc{sparclite} architectures.
13245 The @file{README} file in the @value{GDBN} distribution may list other
13246 recently added stubs.
13249 * Stub Contents:: What the stub can do for you
13250 * Bootstrapping:: What you must do for the stub
13251 * Debug Session:: Putting it all together
13254 @node Stub Contents
13255 @subsection What the Stub Can Do for You
13257 @cindex remote serial stub
13258 The debugging stub for your architecture supplies these three
13262 @item set_debug_traps
13263 @findex set_debug_traps
13264 @cindex remote serial stub, initialization
13265 This routine arranges for @code{handle_exception} to run when your
13266 program stops. You must call this subroutine explicitly near the
13267 beginning of your program.
13269 @item handle_exception
13270 @findex handle_exception
13271 @cindex remote serial stub, main routine
13272 This is the central workhorse, but your program never calls it
13273 explicitly---the setup code arranges for @code{handle_exception} to
13274 run when a trap is triggered.
13276 @code{handle_exception} takes control when your program stops during
13277 execution (for example, on a breakpoint), and mediates communications
13278 with @value{GDBN} on the host machine. This is where the communications
13279 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
13280 representative on the target machine. It begins by sending summary
13281 information on the state of your program, then continues to execute,
13282 retrieving and transmitting any information @value{GDBN} needs, until you
13283 execute a @value{GDBN} command that makes your program resume; at that point,
13284 @code{handle_exception} returns control to your own code on the target
13288 @cindex @code{breakpoint} subroutine, remote
13289 Use this auxiliary subroutine to make your program contain a
13290 breakpoint. Depending on the particular situation, this may be the only
13291 way for @value{GDBN} to get control. For instance, if your target
13292 machine has some sort of interrupt button, you won't need to call this;
13293 pressing the interrupt button transfers control to
13294 @code{handle_exception}---in effect, to @value{GDBN}. On some machines,
13295 simply receiving characters on the serial port may also trigger a trap;
13296 again, in that situation, you don't need to call @code{breakpoint} from
13297 your own program---simply running @samp{target remote} from the host
13298 @value{GDBN} session gets control.
13300 Call @code{breakpoint} if none of these is true, or if you simply want
13301 to make certain your program stops at a predetermined point for the
13302 start of your debugging session.
13305 @node Bootstrapping
13306 @subsection What You Must Do for the Stub
13308 @cindex remote stub, support routines
13309 The debugging stubs that come with @value{GDBN} are set up for a particular
13310 chip architecture, but they have no information about the rest of your
13311 debugging target machine.
13313 First of all you need to tell the stub how to communicate with the
13317 @item int getDebugChar()
13318 @findex getDebugChar
13319 Write this subroutine to read a single character from the serial port.
13320 It may be identical to @code{getchar} for your target system; a
13321 different name is used to allow you to distinguish the two if you wish.
13323 @item void putDebugChar(int)
13324 @findex putDebugChar
13325 Write this subroutine to write a single character to the serial port.
13326 It may be identical to @code{putchar} for your target system; a
13327 different name is used to allow you to distinguish the two if you wish.
13330 @cindex control C, and remote debugging
13331 @cindex interrupting remote targets
13332 If you want @value{GDBN} to be able to stop your program while it is
13333 running, you need to use an interrupt-driven serial driver, and arrange
13334 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
13335 character). That is the character which @value{GDBN} uses to tell the
13336 remote system to stop.
13338 Getting the debugging target to return the proper status to @value{GDBN}
13339 probably requires changes to the standard stub; one quick and dirty way
13340 is to just execute a breakpoint instruction (the ``dirty'' part is that
13341 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
13343 Other routines you need to supply are:
13346 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
13347 @findex exceptionHandler
13348 Write this function to install @var{exception_address} in the exception
13349 handling tables. You need to do this because the stub does not have any
13350 way of knowing what the exception handling tables on your target system
13351 are like (for example, the processor's table might be in @sc{rom},
13352 containing entries which point to a table in @sc{ram}).
13353 @var{exception_number} is the exception number which should be changed;
13354 its meaning is architecture-dependent (for example, different numbers
13355 might represent divide by zero, misaligned access, etc). When this
13356 exception occurs, control should be transferred directly to
13357 @var{exception_address}, and the processor state (stack, registers,
13358 and so on) should be just as it is when a processor exception occurs. So if
13359 you want to use a jump instruction to reach @var{exception_address}, it
13360 should be a simple jump, not a jump to subroutine.
13362 For the 386, @var{exception_address} should be installed as an interrupt
13363 gate so that interrupts are masked while the handler runs. The gate
13364 should be at privilege level 0 (the most privileged level). The
13365 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
13366 help from @code{exceptionHandler}.
13368 @item void flush_i_cache()
13369 @findex flush_i_cache
13370 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
13371 instruction cache, if any, on your target machine. If there is no
13372 instruction cache, this subroutine may be a no-op.
13374 On target machines that have instruction caches, @value{GDBN} requires this
13375 function to make certain that the state of your program is stable.
13379 You must also make sure this library routine is available:
13382 @item void *memset(void *, int, int)
13384 This is the standard library function @code{memset} that sets an area of
13385 memory to a known value. If you have one of the free versions of
13386 @code{libc.a}, @code{memset} can be found there; otherwise, you must
13387 either obtain it from your hardware manufacturer, or write your own.
13390 If you do not use the GNU C compiler, you may need other standard
13391 library subroutines as well; this varies from one stub to another,
13392 but in general the stubs are likely to use any of the common library
13393 subroutines which @code{@value{NGCC}} generates as inline code.
13396 @node Debug Session
13397 @subsection Putting it All Together
13399 @cindex remote serial debugging summary
13400 In summary, when your program is ready to debug, you must follow these
13405 Make sure you have defined the supporting low-level routines
13406 (@pxref{Bootstrapping,,What You Must Do for the Stub}):
13408 @code{getDebugChar}, @code{putDebugChar},
13409 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
13413 Insert these lines near the top of your program:
13421 For the 680x0 stub only, you need to provide a variable called
13422 @code{exceptionHook}. Normally you just use:
13425 void (*exceptionHook)() = 0;
13429 but if before calling @code{set_debug_traps}, you set it to point to a
13430 function in your program, that function is called when
13431 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
13432 error). The function indicated by @code{exceptionHook} is called with
13433 one parameter: an @code{int} which is the exception number.
13436 Compile and link together: your program, the @value{GDBN} debugging stub for
13437 your target architecture, and the supporting subroutines.
13440 Make sure you have a serial connection between your target machine and
13441 the @value{GDBN} host, and identify the serial port on the host.
13444 @c The "remote" target now provides a `load' command, so we should
13445 @c document that. FIXME.
13446 Download your program to your target machine (or get it there by
13447 whatever means the manufacturer provides), and start it.
13450 Start @value{GDBN} on the host, and connect to the target
13451 (@pxref{Connecting,,Connecting to a Remote Target}).
13455 @node Configurations
13456 @chapter Configuration-Specific Information
13458 While nearly all @value{GDBN} commands are available for all native and
13459 cross versions of the debugger, there are some exceptions. This chapter
13460 describes things that are only available in certain configurations.
13462 There are three major categories of configurations: native
13463 configurations, where the host and target are the same, embedded
13464 operating system configurations, which are usually the same for several
13465 different processor architectures, and bare embedded processors, which
13466 are quite different from each other.
13471 * Embedded Processors::
13478 This section describes details specific to particular native
13483 * BSD libkvm Interface:: Debugging BSD kernel memory images
13484 * SVR4 Process Information:: SVR4 process information
13485 * DJGPP Native:: Features specific to the DJGPP port
13486 * Cygwin Native:: Features specific to the Cygwin port
13487 * Hurd Native:: Features specific to @sc{gnu} Hurd
13488 * Neutrino:: Features specific to QNX Neutrino
13494 On HP-UX systems, if you refer to a function or variable name that
13495 begins with a dollar sign, @value{GDBN} searches for a user or system
13496 name first, before it searches for a convenience variable.
13499 @node BSD libkvm Interface
13500 @subsection BSD libkvm Interface
13503 @cindex kernel memory image
13504 @cindex kernel crash dump
13506 BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
13507 interface that provides a uniform interface for accessing kernel virtual
13508 memory images, including live systems and crash dumps. @value{GDBN}
13509 uses this interface to allow you to debug live kernels and kernel crash
13510 dumps on many native BSD configurations. This is implemented as a
13511 special @code{kvm} debugging target. For debugging a live system, load
13512 the currently running kernel into @value{GDBN} and connect to the
13516 (@value{GDBP}) @b{target kvm}
13519 For debugging crash dumps, provide the file name of the crash dump as an
13523 (@value{GDBP}) @b{target kvm /var/crash/bsd.0}
13526 Once connected to the @code{kvm} target, the following commands are
13532 Set current context from the @dfn{Process Control Block} (PCB) address.
13535 Set current context from proc address. This command isn't available on
13536 modern FreeBSD systems.
13539 @node SVR4 Process Information
13540 @subsection SVR4 Process Information
13542 @cindex examine process image
13543 @cindex process info via @file{/proc}
13545 Many versions of SVR4 and compatible systems provide a facility called
13546 @samp{/proc} that can be used to examine the image of a running
13547 process using file-system subroutines. If @value{GDBN} is configured
13548 for an operating system with this facility, the command @code{info
13549 proc} is available to report information about the process running
13550 your program, or about any process running on your system. @code{info
13551 proc} works only on SVR4 systems that include the @code{procfs} code.
13552 This includes, as of this writing, @sc{gnu}/Linux, OSF/1 (Digital
13553 Unix), Solaris, Irix, and Unixware, but not HP-UX, for example.
13559 @itemx info proc @var{process-id}
13560 Summarize available information about any running process. If a
13561 process ID is specified by @var{process-id}, display information about
13562 that process; otherwise display information about the program being
13563 debugged. The summary includes the debugged process ID, the command
13564 line used to invoke it, its current working directory, and its
13565 executable file's absolute file name.
13567 On some systems, @var{process-id} can be of the form
13568 @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID
13569 within a process. If the optional @var{pid} part is missing, it means
13570 a thread from the process being debugged (the leading @samp{/} still
13571 needs to be present, or else @value{GDBN} will interpret the number as
13572 a process ID rather than a thread ID).
13574 @item info proc mappings
13575 @cindex memory address space mappings
13576 Report the memory address space ranges accessible in the program, with
13577 information on whether the process has read, write, or execute access
13578 rights to each range. On @sc{gnu}/Linux systems, each memory range
13579 includes the object file which is mapped to that range, instead of the
13580 memory access rights to that range.
13582 @item info proc stat
13583 @itemx info proc status
13584 @cindex process detailed status information
13585 These subcommands are specific to @sc{gnu}/Linux systems. They show
13586 the process-related information, including the user ID and group ID;
13587 how many threads are there in the process; its virtual memory usage;
13588 the signals that are pending, blocked, and ignored; its TTY; its
13589 consumption of system and user time; its stack size; its @samp{nice}
13590 value; etc. For more information, see the @samp{proc} man page
13591 (type @kbd{man 5 proc} from your shell prompt).
13593 @item info proc all
13594 Show all the information about the process described under all of the
13595 above @code{info proc} subcommands.
13598 @comment These sub-options of 'info proc' were not included when
13599 @comment procfs.c was re-written. Keep their descriptions around
13600 @comment against the day when someone finds the time to put them back in.
13601 @kindex info proc times
13602 @item info proc times
13603 Starting time, user CPU time, and system CPU time for your program and
13606 @kindex info proc id
13608 Report on the process IDs related to your program: its own process ID,
13609 the ID of its parent, the process group ID, and the session ID.
13612 @item set procfs-trace
13613 @kindex set procfs-trace
13614 @cindex @code{procfs} API calls
13615 This command enables and disables tracing of @code{procfs} API calls.
13617 @item show procfs-trace
13618 @kindex show procfs-trace
13619 Show the current state of @code{procfs} API call tracing.
13621 @item set procfs-file @var{file}
13622 @kindex set procfs-file
13623 Tell @value{GDBN} to write @code{procfs} API trace to the named
13624 @var{file}. @value{GDBN} appends the trace info to the previous
13625 contents of the file. The default is to display the trace on the
13628 @item show procfs-file
13629 @kindex show procfs-file
13630 Show the file to which @code{procfs} API trace is written.
13632 @item proc-trace-entry
13633 @itemx proc-trace-exit
13634 @itemx proc-untrace-entry
13635 @itemx proc-untrace-exit
13636 @kindex proc-trace-entry
13637 @kindex proc-trace-exit
13638 @kindex proc-untrace-entry
13639 @kindex proc-untrace-exit
13640 These commands enable and disable tracing of entries into and exits
13641 from the @code{syscall} interface.
13644 @kindex info pidlist
13645 @cindex process list, QNX Neutrino
13646 For QNX Neutrino only, this command displays the list of all the
13647 processes and all the threads within each process.
13650 @kindex info meminfo
13651 @cindex mapinfo list, QNX Neutrino
13652 For QNX Neutrino only, this command displays the list of all mapinfos.
13656 @subsection Features for Debugging @sc{djgpp} Programs
13657 @cindex @sc{djgpp} debugging
13658 @cindex native @sc{djgpp} debugging
13659 @cindex MS-DOS-specific commands
13662 @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and
13663 MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs
13664 that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on
13665 top of real-mode DOS systems and their emulations.
13667 @value{GDBN} supports native debugging of @sc{djgpp} programs, and
13668 defines a few commands specific to the @sc{djgpp} port. This
13669 subsection describes those commands.
13674 This is a prefix of @sc{djgpp}-specific commands which print
13675 information about the target system and important OS structures.
13678 @cindex MS-DOS system info
13679 @cindex free memory information (MS-DOS)
13680 @item info dos sysinfo
13681 This command displays assorted information about the underlying
13682 platform: the CPU type and features, the OS version and flavor, the
13683 DPMI version, and the available conventional and DPMI memory.
13688 @cindex segment descriptor tables
13689 @cindex descriptor tables display
13691 @itemx info dos ldt
13692 @itemx info dos idt
13693 These 3 commands display entries from, respectively, Global, Local,
13694 and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor
13695 tables are data structures which store a descriptor for each segment
13696 that is currently in use. The segment's selector is an index into a
13697 descriptor table; the table entry for that index holds the
13698 descriptor's base address and limit, and its attributes and access
13701 A typical @sc{djgpp} program uses 3 segments: a code segment, a data
13702 segment (used for both data and the stack), and a DOS segment (which
13703 allows access to DOS/BIOS data structures and absolute addresses in
13704 conventional memory). However, the DPMI host will usually define
13705 additional segments in order to support the DPMI environment.
13707 @cindex garbled pointers
13708 These commands allow to display entries from the descriptor tables.
13709 Without an argument, all entries from the specified table are
13710 displayed. An argument, which should be an integer expression, means
13711 display a single entry whose index is given by the argument. For
13712 example, here's a convenient way to display information about the
13713 debugged program's data segment:
13716 @exdent @code{(@value{GDBP}) info dos ldt $ds}
13717 @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)}
13721 This comes in handy when you want to see whether a pointer is outside
13722 the data segment's limit (i.e.@: @dfn{garbled}).
13724 @cindex page tables display (MS-DOS)
13726 @itemx info dos pte
13727 These two commands display entries from, respectively, the Page
13728 Directory and the Page Tables. Page Directories and Page Tables are
13729 data structures which control how virtual memory addresses are mapped
13730 into physical addresses. A Page Table includes an entry for every
13731 page of memory that is mapped into the program's address space; there
13732 may be several Page Tables, each one holding up to 4096 entries. A
13733 Page Directory has up to 4096 entries, one each for every Page Table
13734 that is currently in use.
13736 Without an argument, @kbd{info dos pde} displays the entire Page
13737 Directory, and @kbd{info dos pte} displays all the entries in all of
13738 the Page Tables. An argument, an integer expression, given to the
13739 @kbd{info dos pde} command means display only that entry from the Page
13740 Directory table. An argument given to the @kbd{info dos pte} command
13741 means display entries from a single Page Table, the one pointed to by
13742 the specified entry in the Page Directory.
13744 @cindex direct memory access (DMA) on MS-DOS
13745 These commands are useful when your program uses @dfn{DMA} (Direct
13746 Memory Access), which needs physical addresses to program the DMA
13749 These commands are supported only with some DPMI servers.
13751 @cindex physical address from linear address
13752 @item info dos address-pte @var{addr}
13753 This command displays the Page Table entry for a specified linear
13754 address. The argument @var{addr} is a linear address which should
13755 already have the appropriate segment's base address added to it,
13756 because this command accepts addresses which may belong to @emph{any}
13757 segment. For example, here's how to display the Page Table entry for
13758 the page where a variable @code{i} is stored:
13761 @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i}
13762 @exdent @code{Page Table entry for address 0x11a00d30:}
13763 @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30}
13767 This says that @code{i} is stored at offset @code{0xd30} from the page
13768 whose physical base address is @code{0x02698000}, and shows all the
13769 attributes of that page.
13771 Note that you must cast the addresses of variables to a @code{char *},
13772 since otherwise the value of @code{__djgpp_base_address}, the base
13773 address of all variables and functions in a @sc{djgpp} program, will
13774 be added using the rules of C pointer arithmetics: if @code{i} is
13775 declared an @code{int}, @value{GDBN} will add 4 times the value of
13776 @code{__djgpp_base_address} to the address of @code{i}.
13778 Here's another example, it displays the Page Table entry for the
13782 @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)}
13783 @exdent @code{Page Table entry for address 0x29110:}
13784 @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110}
13788 (The @code{+ 3} offset is because the transfer buffer's address is the
13789 3rd member of the @code{_go32_info_block} structure.) The output
13790 clearly shows that this DPMI server maps the addresses in conventional
13791 memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and
13792 linear (@code{0x29110}) addresses are identical.
13794 This command is supported only with some DPMI servers.
13797 @cindex DOS serial data link, remote debugging
13798 In addition to native debugging, the DJGPP port supports remote
13799 debugging via a serial data link. The following commands are specific
13800 to remote serial debugging in the DJGPP port of @value{GDBN}.
13803 @kindex set com1base
13804 @kindex set com1irq
13805 @kindex set com2base
13806 @kindex set com2irq
13807 @kindex set com3base
13808 @kindex set com3irq
13809 @kindex set com4base
13810 @kindex set com4irq
13811 @item set com1base @var{addr}
13812 This command sets the base I/O port address of the @file{COM1} serial
13815 @item set com1irq @var{irq}
13816 This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use
13817 for the @file{COM1} serial port.
13819 There are similar commands @samp{set com2base}, @samp{set com3irq},
13820 etc.@: for setting the port address and the @code{IRQ} lines for the
13823 @kindex show com1base
13824 @kindex show com1irq
13825 @kindex show com2base
13826 @kindex show com2irq
13827 @kindex show com3base
13828 @kindex show com3irq
13829 @kindex show com4base
13830 @kindex show com4irq
13831 The related commands @samp{show com1base}, @samp{show com1irq} etc.@:
13832 display the current settings of the base address and the @code{IRQ}
13833 lines used by the COM ports.
13836 @kindex info serial
13837 @cindex DOS serial port status
13838 This command prints the status of the 4 DOS serial ports. For each
13839 port, it prints whether it's active or not, its I/O base address and
13840 IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the
13841 counts of various errors encountered so far.
13845 @node Cygwin Native
13846 @subsection Features for Debugging MS Windows PE Executables
13847 @cindex MS Windows debugging
13848 @cindex native Cygwin debugging
13849 @cindex Cygwin-specific commands
13851 @value{GDBN} supports native debugging of MS Windows programs, including
13852 DLLs with and without symbolic debugging information. There are various
13853 additional Cygwin-specific commands, described in this section.
13854 Working with DLLs that have no debugging symbols is described in
13855 @ref{Non-debug DLL Symbols}.
13860 This is a prefix of MS Windows-specific commands which print
13861 information about the target system and important OS structures.
13863 @item info w32 selector
13864 This command displays information returned by
13865 the Win32 API @code{GetThreadSelectorEntry} function.
13866 It takes an optional argument that is evaluated to
13867 a long value to give the information about this given selector.
13868 Without argument, this command displays information
13869 about the six segment registers.
13873 This is a Cygwin-specific alias of @code{info shared}.
13875 @kindex dll-symbols
13877 This command loads symbols from a dll similarly to
13878 add-sym command but without the need to specify a base address.
13880 @kindex set cygwin-exceptions
13881 @cindex debugging the Cygwin DLL
13882 @cindex Cygwin DLL, debugging
13883 @item set cygwin-exceptions @var{mode}
13884 If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that
13885 happen inside the Cygwin DLL. If @var{mode} is @code{off},
13886 @value{GDBN} will delay recognition of exceptions, and may ignore some
13887 exceptions which seem to be caused by internal Cygwin DLL
13888 ``bookkeeping''. This option is meant primarily for debugging the
13889 Cygwin DLL itself; the default value is @code{off} to avoid annoying
13890 @value{GDBN} users with false @code{SIGSEGV} signals.
13892 @kindex show cygwin-exceptions
13893 @item show cygwin-exceptions
13894 Displays whether @value{GDBN} will break on exceptions that happen
13895 inside the Cygwin DLL itself.
13897 @kindex set new-console
13898 @item set new-console @var{mode}
13899 If @var{mode} is @code{on} the debuggee will
13900 be started in a new console on next start.
13901 If @var{mode} is @code{off}i, the debuggee will
13902 be started in the same console as the debugger.
13904 @kindex show new-console
13905 @item show new-console
13906 Displays whether a new console is used
13907 when the debuggee is started.
13909 @kindex set new-group
13910 @item set new-group @var{mode}
13911 This boolean value controls whether the debuggee should
13912 start a new group or stay in the same group as the debugger.
13913 This affects the way the Windows OS handles
13916 @kindex show new-group
13917 @item show new-group
13918 Displays current value of new-group boolean.
13920 @kindex set debugevents
13921 @item set debugevents
13922 This boolean value adds debug output concerning kernel events related
13923 to the debuggee seen by the debugger. This includes events that
13924 signal thread and process creation and exit, DLL loading and
13925 unloading, console interrupts, and debugging messages produced by the
13926 Windows @code{OutputDebugString} API call.
13928 @kindex set debugexec
13929 @item set debugexec
13930 This boolean value adds debug output concerning execute events
13931 (such as resume thread) seen by the debugger.
13933 @kindex set debugexceptions
13934 @item set debugexceptions
13935 This boolean value adds debug output concerning exceptions in the
13936 debuggee seen by the debugger.
13938 @kindex set debugmemory
13939 @item set debugmemory
13940 This boolean value adds debug output concerning debuggee memory reads
13941 and writes by the debugger.
13945 This boolean values specifies whether the debuggee is called
13946 via a shell or directly (default value is on).
13950 Displays if the debuggee will be started with a shell.
13955 * Non-debug DLL Symbols:: Support for DLLs without debugging symbols
13958 @node Non-debug DLL Symbols
13959 @subsubsection Support for DLLs without Debugging Symbols
13960 @cindex DLLs with no debugging symbols
13961 @cindex Minimal symbols and DLLs
13963 Very often on windows, some of the DLLs that your program relies on do
13964 not include symbolic debugging information (for example,
13965 @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging
13966 symbols in a DLL, it relies on the minimal amount of symbolic
13967 information contained in the DLL's export table. This section
13968 describes working with such symbols, known internally to @value{GDBN} as
13969 ``minimal symbols''.
13971 Note that before the debugged program has started execution, no DLLs
13972 will have been loaded. The easiest way around this problem is simply to
13973 start the program --- either by setting a breakpoint or letting the
13974 program run once to completion. It is also possible to force
13975 @value{GDBN} to load a particular DLL before starting the executable ---
13976 see the shared library information in @ref{Files}, or the
13977 @code{dll-symbols} command in @ref{Cygwin Native}. Currently,
13978 explicitly loading symbols from a DLL with no debugging information will
13979 cause the symbol names to be duplicated in @value{GDBN}'s lookup table,
13980 which may adversely affect symbol lookup performance.
13982 @subsubsection DLL Name Prefixes
13984 In keeping with the naming conventions used by the Microsoft debugging
13985 tools, DLL export symbols are made available with a prefix based on the
13986 DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is
13987 also entered into the symbol table, so @code{CreateFileA} is often
13988 sufficient. In some cases there will be name clashes within a program
13989 (particularly if the executable itself includes full debugging symbols)
13990 necessitating the use of the fully qualified name when referring to the
13991 contents of the DLL. Use single-quotes around the name to avoid the
13992 exclamation mark (``!'') being interpreted as a language operator.
13994 Note that the internal name of the DLL may be all upper-case, even
13995 though the file name of the DLL is lower-case, or vice-versa. Since
13996 symbols within @value{GDBN} are @emph{case-sensitive} this may cause
13997 some confusion. If in doubt, try the @code{info functions} and
13998 @code{info variables} commands or even @code{maint print msymbols}
13999 (@pxref{Symbols}). Here's an example:
14002 (@value{GDBP}) info function CreateFileA
14003 All functions matching regular expression "CreateFileA":
14005 Non-debugging symbols:
14006 0x77e885f4 CreateFileA
14007 0x77e885f4 KERNEL32!CreateFileA
14011 (@value{GDBP}) info function !
14012 All functions matching regular expression "!":
14014 Non-debugging symbols:
14015 0x6100114c cygwin1!__assert
14016 0x61004034 cygwin1!_dll_crt0@@0
14017 0x61004240 cygwin1!dll_crt0(per_process *)
14021 @subsubsection Working with Minimal Symbols
14023 Symbols extracted from a DLL's export table do not contain very much
14024 type information. All that @value{GDBN} can do is guess whether a symbol
14025 refers to a function or variable depending on the linker section that
14026 contains the symbol. Also note that the actual contents of the memory
14027 contained in a DLL are not available unless the program is running. This
14028 means that you cannot examine the contents of a variable or disassemble
14029 a function within a DLL without a running program.
14031 Variables are generally treated as pointers and dereferenced
14032 automatically. For this reason, it is often necessary to prefix a
14033 variable name with the address-of operator (``&'') and provide explicit
14034 type information in the command. Here's an example of the type of
14038 (@value{GDBP}) print 'cygwin1!__argv'
14043 (@value{GDBP}) x 'cygwin1!__argv'
14044 0x10021610: "\230y\""
14047 And two possible solutions:
14050 (@value{GDBP}) print ((char **)'cygwin1!__argv')[0]
14051 $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram"
14055 (@value{GDBP}) x/2x &'cygwin1!__argv'
14056 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000
14057 (@value{GDBP}) x/x 0x10021608
14058 0x10021608: 0x0022fd98
14059 (@value{GDBP}) x/s 0x0022fd98
14060 0x22fd98: "/cygdrive/c/mydirectory/myprogram"
14063 Setting a break point within a DLL is possible even before the program
14064 starts execution. However, under these circumstances, @value{GDBN} can't
14065 examine the initial instructions of the function in order to skip the
14066 function's frame set-up code. You can work around this by using ``*&''
14067 to set the breakpoint at a raw memory address:
14070 (@value{GDBP}) break *&'python22!PyOS_Readline'
14071 Breakpoint 1 at 0x1e04eff0
14074 The author of these extensions is not entirely convinced that setting a
14075 break point within a shared DLL like @file{kernel32.dll} is completely
14079 @subsection Commands Specific to @sc{gnu} Hurd Systems
14080 @cindex @sc{gnu} Hurd debugging
14082 This subsection describes @value{GDBN} commands specific to the
14083 @sc{gnu} Hurd native debugging.
14088 @kindex set signals@r{, Hurd command}
14089 @kindex set sigs@r{, Hurd command}
14090 This command toggles the state of inferior signal interception by
14091 @value{GDBN}. Mach exceptions, such as breakpoint traps, are not
14092 affected by this command. @code{sigs} is a shorthand alias for
14097 @kindex show signals@r{, Hurd command}
14098 @kindex show sigs@r{, Hurd command}
14099 Show the current state of intercepting inferior's signals.
14101 @item set signal-thread
14102 @itemx set sigthread
14103 @kindex set signal-thread
14104 @kindex set sigthread
14105 This command tells @value{GDBN} which thread is the @code{libc} signal
14106 thread. That thread is run when a signal is delivered to a running
14107 process. @code{set sigthread} is the shorthand alias of @code{set
14110 @item show signal-thread
14111 @itemx show sigthread
14112 @kindex show signal-thread
14113 @kindex show sigthread
14114 These two commands show which thread will run when the inferior is
14115 delivered a signal.
14118 @kindex set stopped@r{, Hurd command}
14119 This commands tells @value{GDBN} that the inferior process is stopped,
14120 as with the @code{SIGSTOP} signal. The stopped process can be
14121 continued by delivering a signal to it.
14124 @kindex show stopped@r{, Hurd command}
14125 This command shows whether @value{GDBN} thinks the debuggee is
14128 @item set exceptions
14129 @kindex set exceptions@r{, Hurd command}
14130 Use this command to turn off trapping of exceptions in the inferior.
14131 When exception trapping is off, neither breakpoints nor
14132 single-stepping will work. To restore the default, set exception
14135 @item show exceptions
14136 @kindex show exceptions@r{, Hurd command}
14137 Show the current state of trapping exceptions in the inferior.
14139 @item set task pause
14140 @kindex set task@r{, Hurd commands}
14141 @cindex task attributes (@sc{gnu} Hurd)
14142 @cindex pause current task (@sc{gnu} Hurd)
14143 This command toggles task suspension when @value{GDBN} has control.
14144 Setting it to on takes effect immediately, and the task is suspended
14145 whenever @value{GDBN} gets control. Setting it to off will take
14146 effect the next time the inferior is continued. If this option is set
14147 to off, you can use @code{set thread default pause on} or @code{set
14148 thread pause on} (see below) to pause individual threads.
14150 @item show task pause
14151 @kindex show task@r{, Hurd commands}
14152 Show the current state of task suspension.
14154 @item set task detach-suspend-count
14155 @cindex task suspend count
14156 @cindex detach from task, @sc{gnu} Hurd
14157 This command sets the suspend count the task will be left with when
14158 @value{GDBN} detaches from it.
14160 @item show task detach-suspend-count
14161 Show the suspend count the task will be left with when detaching.
14163 @item set task exception-port
14164 @itemx set task excp
14165 @cindex task exception port, @sc{gnu} Hurd
14166 This command sets the task exception port to which @value{GDBN} will
14167 forward exceptions. The argument should be the value of the @dfn{send
14168 rights} of the task. @code{set task excp} is a shorthand alias.
14170 @item set noninvasive
14171 @cindex noninvasive task options
14172 This command switches @value{GDBN} to a mode that is the least
14173 invasive as far as interfering with the inferior is concerned. This
14174 is the same as using @code{set task pause}, @code{set exceptions}, and
14175 @code{set signals} to values opposite to the defaults.
14177 @item info send-rights
14178 @itemx info receive-rights
14179 @itemx info port-rights
14180 @itemx info port-sets
14181 @itemx info dead-names
14184 @cindex send rights, @sc{gnu} Hurd
14185 @cindex receive rights, @sc{gnu} Hurd
14186 @cindex port rights, @sc{gnu} Hurd
14187 @cindex port sets, @sc{gnu} Hurd
14188 @cindex dead names, @sc{gnu} Hurd
14189 These commands display information about, respectively, send rights,
14190 receive rights, port rights, port sets, and dead names of a task.
14191 There are also shorthand aliases: @code{info ports} for @code{info
14192 port-rights} and @code{info psets} for @code{info port-sets}.
14194 @item set thread pause
14195 @kindex set thread@r{, Hurd command}
14196 @cindex thread properties, @sc{gnu} Hurd
14197 @cindex pause current thread (@sc{gnu} Hurd)
14198 This command toggles current thread suspension when @value{GDBN} has
14199 control. Setting it to on takes effect immediately, and the current
14200 thread is suspended whenever @value{GDBN} gets control. Setting it to
14201 off will take effect the next time the inferior is continued.
14202 Normally, this command has no effect, since when @value{GDBN} has
14203 control, the whole task is suspended. However, if you used @code{set
14204 task pause off} (see above), this command comes in handy to suspend
14205 only the current thread.
14207 @item show thread pause
14208 @kindex show thread@r{, Hurd command}
14209 This command shows the state of current thread suspension.
14211 @item set thread run
14212 This command sets whether the current thread is allowed to run.
14214 @item show thread run
14215 Show whether the current thread is allowed to run.
14217 @item set thread detach-suspend-count
14218 @cindex thread suspend count, @sc{gnu} Hurd
14219 @cindex detach from thread, @sc{gnu} Hurd
14220 This command sets the suspend count @value{GDBN} will leave on a
14221 thread when detaching. This number is relative to the suspend count
14222 found by @value{GDBN} when it notices the thread; use @code{set thread
14223 takeover-suspend-count} to force it to an absolute value.
14225 @item show thread detach-suspend-count
14226 Show the suspend count @value{GDBN} will leave on the thread when
14229 @item set thread exception-port
14230 @itemx set thread excp
14231 Set the thread exception port to which to forward exceptions. This
14232 overrides the port set by @code{set task exception-port} (see above).
14233 @code{set thread excp} is the shorthand alias.
14235 @item set thread takeover-suspend-count
14236 Normally, @value{GDBN}'s thread suspend counts are relative to the
14237 value @value{GDBN} finds when it notices each thread. This command
14238 changes the suspend counts to be absolute instead.
14240 @item set thread default
14241 @itemx show thread default
14242 @cindex thread default settings, @sc{gnu} Hurd
14243 Each of the above @code{set thread} commands has a @code{set thread
14244 default} counterpart (e.g., @code{set thread default pause}, @code{set
14245 thread default exception-port}, etc.). The @code{thread default}
14246 variety of commands sets the default thread properties for all
14247 threads; you can then change the properties of individual threads with
14248 the non-default commands.
14253 @subsection QNX Neutrino
14254 @cindex QNX Neutrino
14256 @value{GDBN} provides the following commands specific to the QNX
14260 @item set debug nto-debug
14261 @kindex set debug nto-debug
14262 When set to on, enables debugging messages specific to the QNX
14265 @item show debug nto-debug
14266 @kindex show debug nto-debug
14267 Show the current state of QNX Neutrino messages.
14272 @section Embedded Operating Systems
14274 This section describes configurations involving the debugging of
14275 embedded operating systems that are available for several different
14279 * VxWorks:: Using @value{GDBN} with VxWorks
14282 @value{GDBN} includes the ability to debug programs running on
14283 various real-time operating systems.
14286 @subsection Using @value{GDBN} with VxWorks
14292 @kindex target vxworks
14293 @item target vxworks @var{machinename}
14294 A VxWorks system, attached via TCP/IP. The argument @var{machinename}
14295 is the target system's machine name or IP address.
14299 On VxWorks, @code{load} links @var{filename} dynamically on the
14300 current target system as well as adding its symbols in @value{GDBN}.
14302 @value{GDBN} enables developers to spawn and debug tasks running on networked
14303 VxWorks targets from a Unix host. Already-running tasks spawned from
14304 the VxWorks shell can also be debugged. @value{GDBN} uses code that runs on
14305 both the Unix host and on the VxWorks target. The program
14306 @code{@value{GDBP}} is installed and executed on the Unix host. (It may be
14307 installed with the name @code{vxgdb}, to distinguish it from a
14308 @value{GDBN} for debugging programs on the host itself.)
14311 @item VxWorks-timeout @var{args}
14312 @kindex vxworks-timeout
14313 All VxWorks-based targets now support the option @code{vxworks-timeout}.
14314 This option is set by the user, and @var{args} represents the number of
14315 seconds @value{GDBN} waits for responses to rpc's. You might use this if
14316 your VxWorks target is a slow software simulator or is on the far side
14317 of a thin network line.
14320 The following information on connecting to VxWorks was current when
14321 this manual was produced; newer releases of VxWorks may use revised
14324 @findex INCLUDE_RDB
14325 To use @value{GDBN} with VxWorks, you must rebuild your VxWorks kernel
14326 to include the remote debugging interface routines in the VxWorks
14327 library @file{rdb.a}. To do this, define @code{INCLUDE_RDB} in the
14328 VxWorks configuration file @file{configAll.h} and rebuild your VxWorks
14329 kernel. The resulting kernel contains @file{rdb.a}, and spawns the
14330 source debugging task @code{tRdbTask} when VxWorks is booted. For more
14331 information on configuring and remaking VxWorks, see the manufacturer's
14333 @c VxWorks, see the @cite{VxWorks Programmer's Guide}.
14335 Once you have included @file{rdb.a} in your VxWorks system image and set
14336 your Unix execution search path to find @value{GDBN}, you are ready to
14337 run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} (or
14338 @code{vxgdb}, depending on your installation).
14340 @value{GDBN} comes up showing the prompt:
14347 * VxWorks Connection:: Connecting to VxWorks
14348 * VxWorks Download:: VxWorks download
14349 * VxWorks Attach:: Running tasks
14352 @node VxWorks Connection
14353 @subsubsection Connecting to VxWorks
14355 The @value{GDBN} command @code{target} lets you connect to a VxWorks target on the
14356 network. To connect to a target whose host name is ``@code{tt}'', type:
14359 (vxgdb) target vxworks tt
14363 @value{GDBN} displays messages like these:
14366 Attaching remote machine across net...
14371 @value{GDBN} then attempts to read the symbol tables of any object modules
14372 loaded into the VxWorks target since it was last booted. @value{GDBN} locates
14373 these files by searching the directories listed in the command search
14374 path (@pxref{Environment, ,Your Program's Environment}); if it fails
14375 to find an object file, it displays a message such as:
14378 prog.o: No such file or directory.
14381 When this happens, add the appropriate directory to the search path with
14382 the @value{GDBN} command @code{path}, and execute the @code{target}
14385 @node VxWorks Download
14386 @subsubsection VxWorks Download
14388 @cindex download to VxWorks
14389 If you have connected to the VxWorks target and you want to debug an
14390 object that has not yet been loaded, you can use the @value{GDBN}
14391 @code{load} command to download a file from Unix to VxWorks
14392 incrementally. The object file given as an argument to the @code{load}
14393 command is actually opened twice: first by the VxWorks target in order
14394 to download the code, then by @value{GDBN} in order to read the symbol
14395 table. This can lead to problems if the current working directories on
14396 the two systems differ. If both systems have NFS mounted the same
14397 filesystems, you can avoid these problems by using absolute paths.
14398 Otherwise, it is simplest to set the working directory on both systems
14399 to the directory in which the object file resides, and then to reference
14400 the file by its name, without any path. For instance, a program
14401 @file{prog.o} may reside in @file{@var{vxpath}/vw/demo/rdb} in VxWorks
14402 and in @file{@var{hostpath}/vw/demo/rdb} on the host. To load this
14403 program, type this on VxWorks:
14406 -> cd "@var{vxpath}/vw/demo/rdb"
14410 Then, in @value{GDBN}, type:
14413 (vxgdb) cd @var{hostpath}/vw/demo/rdb
14414 (vxgdb) load prog.o
14417 @value{GDBN} displays a response similar to this:
14420 Reading symbol data from wherever/vw/demo/rdb/prog.o... done.
14423 You can also use the @code{load} command to reload an object module
14424 after editing and recompiling the corresponding source file. Note that
14425 this makes @value{GDBN} delete all currently-defined breakpoints,
14426 auto-displays, and convenience variables, and to clear the value
14427 history. (This is necessary in order to preserve the integrity of
14428 debugger's data structures that reference the target system's symbol
14431 @node VxWorks Attach
14432 @subsubsection Running Tasks
14434 @cindex running VxWorks tasks
14435 You can also attach to an existing task using the @code{attach} command as
14439 (vxgdb) attach @var{task}
14443 where @var{task} is the VxWorks hexadecimal task ID. The task can be running
14444 or suspended when you attach to it. Running tasks are suspended at
14445 the time of attachment.
14447 @node Embedded Processors
14448 @section Embedded Processors
14450 This section goes into details specific to particular embedded
14453 @cindex send command to simulator
14454 Whenever a specific embedded processor has a simulator, @value{GDBN}
14455 allows to send an arbitrary command to the simulator.
14458 @item sim @var{command}
14459 @kindex sim@r{, a command}
14460 Send an arbitrary @var{command} string to the simulator. Consult the
14461 documentation for the specific simulator in use for information about
14462 acceptable commands.
14468 * M32R/D:: Renesas M32R/D
14469 * M68K:: Motorola M68K
14470 * MIPS Embedded:: MIPS Embedded
14471 * OpenRISC 1000:: OpenRisc 1000
14472 * PA:: HP PA Embedded
14473 * PowerPC:: PowerPC
14474 * Sparclet:: Tsqware Sparclet
14475 * Sparclite:: Fujitsu Sparclite
14476 * Z8000:: Zilog Z8000
14479 * Super-H:: Renesas Super-H
14488 @item target rdi @var{dev}
14489 ARM Angel monitor, via RDI library interface to ADP protocol. You may
14490 use this target to communicate with both boards running the Angel
14491 monitor, or with the EmbeddedICE JTAG debug device.
14494 @item target rdp @var{dev}
14499 @value{GDBN} provides the following ARM-specific commands:
14502 @item set arm disassembler
14504 This commands selects from a list of disassembly styles. The
14505 @code{"std"} style is the standard style.
14507 @item show arm disassembler
14509 Show the current disassembly style.
14511 @item set arm apcs32
14512 @cindex ARM 32-bit mode
14513 This command toggles ARM operation mode between 32-bit and 26-bit.
14515 @item show arm apcs32
14516 Display the current usage of the ARM 32-bit mode.
14518 @item set arm fpu @var{fputype}
14519 This command sets the ARM floating-point unit (FPU) type. The
14520 argument @var{fputype} can be one of these:
14524 Determine the FPU type by querying the OS ABI.
14526 Software FPU, with mixed-endian doubles on little-endian ARM
14529 GCC-compiled FPA co-processor.
14531 Software FPU with pure-endian doubles.
14537 Show the current type of the FPU.
14540 This command forces @value{GDBN} to use the specified ABI.
14543 Show the currently used ABI.
14545 @item set debug arm
14546 Toggle whether to display ARM-specific debugging messages from the ARM
14547 target support subsystem.
14549 @item show debug arm
14550 Show whether ARM-specific debugging messages are enabled.
14553 The following commands are available when an ARM target is debugged
14554 using the RDI interface:
14557 @item rdilogfile @r{[}@var{file}@r{]}
14559 @cindex ADP (Angel Debugger Protocol) logging
14560 Set the filename for the ADP (Angel Debugger Protocol) packet log.
14561 With an argument, sets the log file to the specified @var{file}. With
14562 no argument, show the current log file name. The default log file is
14565 @item rdilogenable @r{[}@var{arg}@r{]}
14566 @kindex rdilogenable
14567 Control logging of ADP packets. With an argument of 1 or @code{"yes"}
14568 enables logging, with an argument 0 or @code{"no"} disables it. With
14569 no arguments displays the current setting. When logging is enabled,
14570 ADP packets exchanged between @value{GDBN} and the RDI target device
14571 are logged to a file.
14573 @item set rdiromatzero
14574 @kindex set rdiromatzero
14575 @cindex ROM at zero address, RDI
14576 Tell @value{GDBN} whether the target has ROM at address 0. If on,
14577 vector catching is disabled, so that zero address can be used. If off
14578 (the default), vector catching is enabled. For this command to take
14579 effect, it needs to be invoked prior to the @code{target rdi} command.
14581 @item show rdiromatzero
14582 @kindex show rdiromatzero
14583 Show the current setting of ROM at zero address.
14585 @item set rdiheartbeat
14586 @kindex set rdiheartbeat
14587 @cindex RDI heartbeat
14588 Enable or disable RDI heartbeat packets. It is not recommended to
14589 turn on this option, since it confuses ARM and EPI JTAG interface, as
14590 well as the Angel monitor.
14592 @item show rdiheartbeat
14593 @kindex show rdiheartbeat
14594 Show the setting of RDI heartbeat packets.
14599 @subsection Renesas M32R/D and M32R/SDI
14602 @kindex target m32r
14603 @item target m32r @var{dev}
14604 Renesas M32R/D ROM monitor.
14606 @kindex target m32rsdi
14607 @item target m32rsdi @var{dev}
14608 Renesas M32R SDI server, connected via parallel port to the board.
14611 The following @value{GDBN} commands are specific to the M32R monitor:
14614 @item set download-path @var{path}
14615 @kindex set download-path
14616 @cindex find downloadable @sc{srec} files (M32R)
14617 Set the default path for finding downloadable @sc{srec} files.
14619 @item show download-path
14620 @kindex show download-path
14621 Show the default path for downloadable @sc{srec} files.
14623 @item set board-address @var{addr}
14624 @kindex set board-address
14625 @cindex M32-EVA target board address
14626 Set the IP address for the M32R-EVA target board.
14628 @item show board-address
14629 @kindex show board-address
14630 Show the current IP address of the target board.
14632 @item set server-address @var{addr}
14633 @kindex set server-address
14634 @cindex download server address (M32R)
14635 Set the IP address for the download server, which is the @value{GDBN}'s
14638 @item show server-address
14639 @kindex show server-address
14640 Display the IP address of the download server.
14642 @item upload @r{[}@var{file}@r{]}
14643 @kindex upload@r{, M32R}
14644 Upload the specified @sc{srec} @var{file} via the monitor's Ethernet
14645 upload capability. If no @var{file} argument is given, the current
14646 executable file is uploaded.
14648 @item tload @r{[}@var{file}@r{]}
14649 @kindex tload@r{, M32R}
14650 Test the @code{upload} command.
14653 The following commands are available for M32R/SDI:
14658 @cindex reset SDI connection, M32R
14659 This command resets the SDI connection.
14663 This command shows the SDI connection status.
14666 @kindex debug_chaos
14667 @cindex M32R/Chaos debugging
14668 Instructs the remote that M32R/Chaos debugging is to be used.
14670 @item use_debug_dma
14671 @kindex use_debug_dma
14672 Instructs the remote to use the DEBUG_DMA method of accessing memory.
14675 @kindex use_mon_code
14676 Instructs the remote to use the MON_CODE method of accessing memory.
14679 @kindex use_ib_break
14680 Instructs the remote to set breakpoints by IB break.
14682 @item use_dbt_break
14683 @kindex use_dbt_break
14684 Instructs the remote to set breakpoints by DBT.
14690 The Motorola m68k configuration includes ColdFire support, and a
14691 target command for the following ROM monitor.
14695 @kindex target dbug
14696 @item target dbug @var{dev}
14697 dBUG ROM monitor for Motorola ColdFire.
14701 @node MIPS Embedded
14702 @subsection MIPS Embedded
14704 @cindex MIPS boards
14705 @value{GDBN} can use the MIPS remote debugging protocol to talk to a
14706 MIPS board attached to a serial line. This is available when
14707 you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}.
14710 Use these @value{GDBN} commands to specify the connection to your target board:
14713 @item target mips @var{port}
14714 @kindex target mips @var{port}
14715 To run a program on the board, start up @code{@value{GDBP}} with the
14716 name of your program as the argument. To connect to the board, use the
14717 command @samp{target mips @var{port}}, where @var{port} is the name of
14718 the serial port connected to the board. If the program has not already
14719 been downloaded to the board, you may use the @code{load} command to
14720 download it. You can then use all the usual @value{GDBN} commands.
14722 For example, this sequence connects to the target board through a serial
14723 port, and loads and runs a program called @var{prog} through the
14727 host$ @value{GDBP} @var{prog}
14728 @value{GDBN} is free software and @dots{}
14729 (@value{GDBP}) target mips /dev/ttyb
14730 (@value{GDBP}) load @var{prog}
14734 @item target mips @var{hostname}:@var{portnumber}
14735 On some @value{GDBN} host configurations, you can specify a TCP
14736 connection (for instance, to a serial line managed by a terminal
14737 concentrator) instead of a serial port, using the syntax
14738 @samp{@var{hostname}:@var{portnumber}}.
14740 @item target pmon @var{port}
14741 @kindex target pmon @var{port}
14744 @item target ddb @var{port}
14745 @kindex target ddb @var{port}
14746 NEC's DDB variant of PMON for Vr4300.
14748 @item target lsi @var{port}
14749 @kindex target lsi @var{port}
14750 LSI variant of PMON.
14752 @kindex target r3900
14753 @item target r3900 @var{dev}
14754 Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips.
14756 @kindex target array
14757 @item target array @var{dev}
14758 Array Tech LSI33K RAID controller board.
14764 @value{GDBN} also supports these special commands for MIPS targets:
14767 @item set mipsfpu double
14768 @itemx set mipsfpu single
14769 @itemx set mipsfpu none
14770 @itemx set mipsfpu auto
14771 @itemx show mipsfpu
14772 @kindex set mipsfpu
14773 @kindex show mipsfpu
14774 @cindex MIPS remote floating point
14775 @cindex floating point, MIPS remote
14776 If your target board does not support the MIPS floating point
14777 coprocessor, you should use the command @samp{set mipsfpu none} (if you
14778 need this, you may wish to put the command in your @value{GDBN} init
14779 file). This tells @value{GDBN} how to find the return value of
14780 functions which return floating point values. It also allows
14781 @value{GDBN} to avoid saving the floating point registers when calling
14782 functions on the board. If you are using a floating point coprocessor
14783 with only single precision floating point support, as on the @sc{r4650}
14784 processor, use the command @samp{set mipsfpu single}. The default
14785 double precision floating point coprocessor may be selected using
14786 @samp{set mipsfpu double}.
14788 In previous versions the only choices were double precision or no
14789 floating point, so @samp{set mipsfpu on} will select double precision
14790 and @samp{set mipsfpu off} will select no floating point.
14792 As usual, you can inquire about the @code{mipsfpu} variable with
14793 @samp{show mipsfpu}.
14795 @item set timeout @var{seconds}
14796 @itemx set retransmit-timeout @var{seconds}
14797 @itemx show timeout
14798 @itemx show retransmit-timeout
14799 @cindex @code{timeout}, MIPS protocol
14800 @cindex @code{retransmit-timeout}, MIPS protocol
14801 @kindex set timeout
14802 @kindex show timeout
14803 @kindex set retransmit-timeout
14804 @kindex show retransmit-timeout
14805 You can control the timeout used while waiting for a packet, in the MIPS
14806 remote protocol, with the @code{set timeout @var{seconds}} command. The
14807 default is 5 seconds. Similarly, you can control the timeout used while
14808 waiting for an acknowledgement of a packet with the @code{set
14809 retransmit-timeout @var{seconds}} command. The default is 3 seconds.
14810 You can inspect both values with @code{show timeout} and @code{show
14811 retransmit-timeout}. (These commands are @emph{only} available when
14812 @value{GDBN} is configured for @samp{--target=mips-idt-ecoff}.)
14814 The timeout set by @code{set timeout} does not apply when @value{GDBN}
14815 is waiting for your program to stop. In that case, @value{GDBN} waits
14816 forever because it has no way of knowing how long the program is going
14817 to run before stopping.
14819 @item set syn-garbage-limit @var{num}
14820 @kindex set syn-garbage-limit@r{, MIPS remote}
14821 @cindex synchronize with remote MIPS target
14822 Limit the maximum number of characters @value{GDBN} should ignore when
14823 it tries to synchronize with the remote target. The default is 10
14824 characters. Setting the limit to -1 means there's no limit.
14826 @item show syn-garbage-limit
14827 @kindex show syn-garbage-limit@r{, MIPS remote}
14828 Show the current limit on the number of characters to ignore when
14829 trying to synchronize with the remote system.
14831 @item set monitor-prompt @var{prompt}
14832 @kindex set monitor-prompt@r{, MIPS remote}
14833 @cindex remote monitor prompt
14834 Tell @value{GDBN} to expect the specified @var{prompt} string from the
14835 remote monitor. The default depends on the target:
14845 @item show monitor-prompt
14846 @kindex show monitor-prompt@r{, MIPS remote}
14847 Show the current strings @value{GDBN} expects as the prompt from the
14850 @item set monitor-warnings
14851 @kindex set monitor-warnings@r{, MIPS remote}
14852 Enable or disable monitor warnings about hardware breakpoints. This
14853 has effect only for the @code{lsi} target. When on, @value{GDBN} will
14854 display warning messages whose codes are returned by the @code{lsi}
14855 PMON monitor for breakpoint commands.
14857 @item show monitor-warnings
14858 @kindex show monitor-warnings@r{, MIPS remote}
14859 Show the current setting of printing monitor warnings.
14861 @item pmon @var{command}
14862 @kindex pmon@r{, MIPS remote}
14863 @cindex send PMON command
14864 This command allows sending an arbitrary @var{command} string to the
14865 monitor. The monitor must be in debug mode for this to work.
14868 @node OpenRISC 1000
14869 @subsection OpenRISC 1000
14870 @cindex OpenRISC 1000
14872 @cindex or1k boards
14873 See OR1k Architecture document (@uref{www.opencores.org}) for more information
14874 about platform and commands.
14878 @kindex target jtag
14879 @item target jtag jtag://@var{host}:@var{port}
14881 Connects to remote JTAG server.
14882 JTAG remote server can be either an or1ksim or JTAG server,
14883 connected via parallel port to the board.
14885 Example: @code{target jtag jtag://localhost:9999}
14888 @item or1ksim @var{command}
14889 If connected to @code{or1ksim} OpenRISC 1000 Architectural
14890 Simulator, proprietary commands can be executed.
14892 @kindex info or1k spr
14893 @item info or1k spr
14894 Displays spr groups.
14896 @item info or1k spr @var{group}
14897 @itemx info or1k spr @var{groupno}
14898 Displays register names in selected group.
14900 @item info or1k spr @var{group} @var{register}
14901 @itemx info or1k spr @var{register}
14902 @itemx info or1k spr @var{groupno} @var{registerno}
14903 @itemx info or1k spr @var{registerno}
14904 Shows information about specified spr register.
14907 @item spr @var{group} @var{register} @var{value}
14908 @itemx spr @var{register @var{value}}
14909 @itemx spr @var{groupno} @var{registerno @var{value}}
14910 @itemx spr @var{registerno @var{value}}
14911 Writes @var{value} to specified spr register.
14914 Some implementations of OpenRISC 1000 Architecture also have hardware trace.
14915 It is very similar to @value{GDBN} trace, except it does not interfere with normal
14916 program execution and is thus much faster. Hardware breakpoints/watchpoint
14917 triggers can be set using:
14920 Load effective address/data
14922 Store effective address/data
14924 Access effective address ($SEA or $LEA) or data ($SDATA/$LDATA)
14929 When triggered, it can capture low level data, like: @code{PC}, @code{LSEA},
14930 @code{LDATA}, @code{SDATA}, @code{READSPR}, @code{WRITESPR}, @code{INSTR}.
14932 @code{htrace} commands:
14933 @cindex OpenRISC 1000 htrace
14936 @item hwatch @var{conditional}
14937 Set hardware watchpoint on combination of Load/Store Effective Address(es)
14938 or Data. For example:
14940 @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)}
14942 @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)}
14946 Display information about current HW trace configuration.
14948 @item htrace trigger @var{conditional}
14949 Set starting criteria for HW trace.
14951 @item htrace qualifier @var{conditional}
14952 Set acquisition qualifier for HW trace.
14954 @item htrace stop @var{conditional}
14955 Set HW trace stopping criteria.
14957 @item htrace record [@var{data}]*
14958 Selects the data to be recorded, when qualifier is met and HW trace was
14961 @item htrace enable
14962 @itemx htrace disable
14963 Enables/disables the HW trace.
14965 @item htrace rewind [@var{filename}]
14966 Clears currently recorded trace data.
14968 If filename is specified, new trace file is made and any newly collected data
14969 will be written there.
14971 @item htrace print [@var{start} [@var{len}]]
14972 Prints trace buffer, using current record configuration.
14974 @item htrace mode continuous
14975 Set continuous trace mode.
14977 @item htrace mode suspend
14978 Set suspend trace mode.
14983 @subsection PowerPC
14985 @value{GDBN} provides the following PowerPC-specific commands:
14988 @kindex set powerpc
14989 @item set powerpc soft-float
14990 @itemx show powerpc soft-float
14991 Force @value{GDBN} to use (or not use) a software floating point calling
14992 convention. By default, @value{GDBN} selects the calling convention based
14993 on the selected architecture and the provided executable file.
14995 @item set powerpc vector-abi
14996 @itemx show powerpc vector-abi
14997 Force @value{GDBN} to use the specified calling convention for vector
14998 arguments and return values. The valid options are @samp{auto};
14999 @samp{generic}, to avoid vector registers even if they are present;
15000 @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE
15001 registers. By default, @value{GDBN} selects the calling convention
15002 based on the selected architecture and the provided executable file.
15004 @kindex target dink32
15005 @item target dink32 @var{dev}
15006 DINK32 ROM monitor.
15008 @kindex target ppcbug
15009 @item target ppcbug @var{dev}
15010 @kindex target ppcbug1
15011 @item target ppcbug1 @var{dev}
15012 PPCBUG ROM monitor for PowerPC.
15015 @item target sds @var{dev}
15016 SDS monitor, running on a PowerPC board (such as Motorola's ADS).
15019 @cindex SDS protocol
15020 The following commands specific to the SDS protocol are supported
15024 @item set sdstimeout @var{nsec}
15025 @kindex set sdstimeout
15026 Set the timeout for SDS protocol reads to be @var{nsec} seconds. The
15027 default is 2 seconds.
15029 @item show sdstimeout
15030 @kindex show sdstimeout
15031 Show the current value of the SDS timeout.
15033 @item sds @var{command}
15034 @kindex sds@r{, a command}
15035 Send the specified @var{command} string to the SDS monitor.
15040 @subsection HP PA Embedded
15044 @kindex target op50n
15045 @item target op50n @var{dev}
15046 OP50N monitor, running on an OKI HPPA board.
15048 @kindex target w89k
15049 @item target w89k @var{dev}
15050 W89K monitor, running on a Winbond HPPA board.
15055 @subsection Tsqware Sparclet
15059 @value{GDBN} enables developers to debug tasks running on
15060 Sparclet targets from a Unix host.
15061 @value{GDBN} uses code that runs on
15062 both the Unix host and on the Sparclet target. The program
15063 @code{@value{GDBP}} is installed and executed on the Unix host.
15066 @item remotetimeout @var{args}
15067 @kindex remotetimeout
15068 @value{GDBN} supports the option @code{remotetimeout}.
15069 This option is set by the user, and @var{args} represents the number of
15070 seconds @value{GDBN} waits for responses.
15073 @cindex compiling, on Sparclet
15074 When compiling for debugging, include the options @samp{-g} to get debug
15075 information and @samp{-Ttext} to relocate the program to where you wish to
15076 load it on the target. You may also want to add the options @samp{-n} or
15077 @samp{-N} in order to reduce the size of the sections. Example:
15080 sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N
15083 You can use @code{objdump} to verify that the addresses are what you intended:
15086 sparclet-aout-objdump --headers --syms prog
15089 @cindex running, on Sparclet
15091 your Unix execution search path to find @value{GDBN}, you are ready to
15092 run @value{GDBN}. From your Unix host, run @code{@value{GDBP}}
15093 (or @code{sparclet-aout-gdb}, depending on your installation).
15095 @value{GDBN} comes up showing the prompt:
15102 * Sparclet File:: Setting the file to debug
15103 * Sparclet Connection:: Connecting to Sparclet
15104 * Sparclet Download:: Sparclet download
15105 * Sparclet Execution:: Running and debugging
15108 @node Sparclet File
15109 @subsubsection Setting File to Debug
15111 The @value{GDBN} command @code{file} lets you choose with program to debug.
15114 (gdbslet) file prog
15118 @value{GDBN} then attempts to read the symbol table of @file{prog}.
15119 @value{GDBN} locates
15120 the file by searching the directories listed in the command search
15122 If the file was compiled with debug information (option @samp{-g}), source
15123 files will be searched as well.
15124 @value{GDBN} locates
15125 the source files by searching the directories listed in the directory search
15126 path (@pxref{Environment, ,Your Program's Environment}).
15128 to find a file, it displays a message such as:
15131 prog: No such file or directory.
15134 When this happens, add the appropriate directories to the search paths with
15135 the @value{GDBN} commands @code{path} and @code{dir}, and execute the
15136 @code{target} command again.
15138 @node Sparclet Connection
15139 @subsubsection Connecting to Sparclet
15141 The @value{GDBN} command @code{target} lets you connect to a Sparclet target.
15142 To connect to a target on serial port ``@code{ttya}'', type:
15145 (gdbslet) target sparclet /dev/ttya
15146 Remote target sparclet connected to /dev/ttya
15147 main () at ../prog.c:3
15151 @value{GDBN} displays messages like these:
15157 @node Sparclet Download
15158 @subsubsection Sparclet Download
15160 @cindex download to Sparclet
15161 Once connected to the Sparclet target,
15162 you can use the @value{GDBN}
15163 @code{load} command to download the file from the host to the target.
15164 The file name and load offset should be given as arguments to the @code{load}
15166 Since the file format is aout, the program must be loaded to the starting
15167 address. You can use @code{objdump} to find out what this value is. The load
15168 offset is an offset which is added to the VMA (virtual memory address)
15169 of each of the file's sections.
15170 For instance, if the program
15171 @file{prog} was linked to text address 0x1201000, with data at 0x12010160
15172 and bss at 0x12010170, in @value{GDBN}, type:
15175 (gdbslet) load prog 0x12010000
15176 Loading section .text, size 0xdb0 vma 0x12010000
15179 If the code is loaded at a different address then what the program was linked
15180 to, you may need to use the @code{section} and @code{add-symbol-file} commands
15181 to tell @value{GDBN} where to map the symbol table.
15183 @node Sparclet Execution
15184 @subsubsection Running and Debugging
15186 @cindex running and debugging Sparclet programs
15187 You can now begin debugging the task using @value{GDBN}'s execution control
15188 commands, @code{b}, @code{step}, @code{run}, etc. See the @value{GDBN}
15189 manual for the list of commands.
15193 Breakpoint 1 at 0x12010000: file prog.c, line 3.
15195 Starting program: prog
15196 Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3
15197 3 char *symarg = 0;
15199 4 char *execarg = "hello!";
15204 @subsection Fujitsu Sparclite
15208 @kindex target sparclite
15209 @item target sparclite @var{dev}
15210 Fujitsu sparclite boards, used only for the purpose of loading.
15211 You must use an additional command to debug the program.
15212 For example: target remote @var{dev} using @value{GDBN} standard
15218 @subsection Zilog Z8000
15221 @cindex simulator, Z8000
15222 @cindex Zilog Z8000 simulator
15224 When configured for debugging Zilog Z8000 targets, @value{GDBN} includes
15227 For the Z8000 family, @samp{target sim} simulates either the Z8002 (the
15228 unsegmented variant of the Z8000 architecture) or the Z8001 (the
15229 segmented variant). The simulator recognizes which architecture is
15230 appropriate by inspecting the object code.
15233 @item target sim @var{args}
15235 @kindex target sim@r{, with Z8000}
15236 Debug programs on a simulated CPU. If the simulator supports setup
15237 options, specify them via @var{args}.
15241 After specifying this target, you can debug programs for the simulated
15242 CPU in the same style as programs for your host computer; use the
15243 @code{file} command to load a new program image, the @code{run} command
15244 to run your program, and so on.
15246 As well as making available all the usual machine registers
15247 (@pxref{Registers, ,Registers}), the Z8000 simulator provides three
15248 additional items of information as specially named registers:
15253 Counts clock-ticks in the simulator.
15256 Counts instructions run in the simulator.
15259 Execution time in 60ths of a second.
15263 You can refer to these values in @value{GDBN} expressions with the usual
15264 conventions; for example, @w{@samp{b fputc if $cycles>5000}} sets a
15265 conditional breakpoint that suspends only after at least 5000
15266 simulated clock ticks.
15269 @subsection Atmel AVR
15272 When configured for debugging the Atmel AVR, @value{GDBN} supports the
15273 following AVR-specific commands:
15276 @item info io_registers
15277 @kindex info io_registers@r{, AVR}
15278 @cindex I/O registers (Atmel AVR)
15279 This command displays information about the AVR I/O registers. For
15280 each register, @value{GDBN} prints its number and value.
15287 When configured for debugging CRIS, @value{GDBN} provides the
15288 following CRIS-specific commands:
15291 @item set cris-version @var{ver}
15292 @cindex CRIS version
15293 Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
15294 The CRIS version affects register names and sizes. This command is useful in
15295 case autodetection of the CRIS version fails.
15297 @item show cris-version
15298 Show the current CRIS version.
15300 @item set cris-dwarf2-cfi
15301 @cindex DWARF-2 CFI and CRIS
15302 Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}.
15303 Change to @samp{off} when using @code{gcc-cris} whose version is below
15306 @item show cris-dwarf2-cfi
15307 Show the current state of using DWARF-2 CFI.
15309 @item set cris-mode @var{mode}
15311 Set the current CRIS mode to @var{mode}. It should only be changed when
15312 debugging in guru mode, in which case it should be set to
15313 @samp{guru} (the default is @samp{normal}).
15315 @item show cris-mode
15316 Show the current CRIS mode.
15320 @subsection Renesas Super-H
15323 For the Renesas Super-H processor, @value{GDBN} provides these
15328 @kindex regs@r{, Super-H}
15329 Show the values of all Super-H registers.
15333 @node Architectures
15334 @section Architectures
15336 This section describes characteristics of architectures that affect
15337 all uses of @value{GDBN} with the architecture, both native and cross.
15344 * HPPA:: HP PA architecture
15345 * SPU:: Cell Broadband Engine SPU architecture
15349 @subsection x86 Architecture-specific Issues
15352 @item set struct-convention @var{mode}
15353 @kindex set struct-convention
15354 @cindex struct return convention
15355 @cindex struct/union returned in registers
15356 Set the convention used by the inferior to return @code{struct}s and
15357 @code{union}s from functions to @var{mode}. Possible values of
15358 @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the
15359 default). @code{"default"} or @code{"pcc"} means that @code{struct}s
15360 are returned on the stack, while @code{"reg"} means that a
15361 @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will
15362 be returned in a register.
15364 @item show struct-convention
15365 @kindex show struct-convention
15366 Show the current setting of the convention to return @code{struct}s
15375 @kindex set rstack_high_address
15376 @cindex AMD 29K register stack
15377 @cindex register stack, AMD29K
15378 @item set rstack_high_address @var{address}
15379 On AMD 29000 family processors, registers are saved in a separate
15380 @dfn{register stack}. There is no way for @value{GDBN} to determine the
15381 extent of this stack. Normally, @value{GDBN} just assumes that the
15382 stack is ``large enough''. This may result in @value{GDBN} referencing
15383 memory locations that do not exist. If necessary, you can get around
15384 this problem by specifying the ending address of the register stack with
15385 the @code{set rstack_high_address} command. The argument should be an
15386 address, which you probably want to precede with @samp{0x} to specify in
15389 @kindex show rstack_high_address
15390 @item show rstack_high_address
15391 Display the current limit of the register stack, on AMD 29000 family
15399 See the following section.
15404 @cindex stack on Alpha
15405 @cindex stack on MIPS
15406 @cindex Alpha stack
15408 Alpha- and MIPS-based computers use an unusual stack frame, which
15409 sometimes requires @value{GDBN} to search backward in the object code to
15410 find the beginning of a function.
15412 @cindex response time, MIPS debugging
15413 To improve response time (especially for embedded applications, where
15414 @value{GDBN} may be restricted to a slow serial line for this search)
15415 you may want to limit the size of this search, using one of these
15419 @cindex @code{heuristic-fence-post} (Alpha, MIPS)
15420 @item set heuristic-fence-post @var{limit}
15421 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
15422 search for the beginning of a function. A value of @var{0} (the
15423 default) means there is no limit. However, except for @var{0}, the
15424 larger the limit the more bytes @code{heuristic-fence-post} must search
15425 and therefore the longer it takes to run. You should only need to use
15426 this command when debugging a stripped executable.
15428 @item show heuristic-fence-post
15429 Display the current limit.
15433 These commands are available @emph{only} when @value{GDBN} is configured
15434 for debugging programs on Alpha or MIPS processors.
15436 Several MIPS-specific commands are available when debugging MIPS
15440 @item set mips abi @var{arg}
15441 @kindex set mips abi
15442 @cindex set ABI for MIPS
15443 Tell @value{GDBN} which MIPS ABI is used by the inferior. Possible
15444 values of @var{arg} are:
15448 The default ABI associated with the current binary (this is the
15459 @item show mips abi
15460 @kindex show mips abi
15461 Show the MIPS ABI used by @value{GDBN} to debug the inferior.
15464 @itemx show mipsfpu
15465 @xref{MIPS Embedded, set mipsfpu}.
15467 @item set mips mask-address @var{arg}
15468 @kindex set mips mask-address
15469 @cindex MIPS addresses, masking
15470 This command determines whether the most-significant 32 bits of 64-bit
15471 MIPS addresses are masked off. The argument @var{arg} can be
15472 @samp{on}, @samp{off}, or @samp{auto}. The latter is the default
15473 setting, which lets @value{GDBN} determine the correct value.
15475 @item show mips mask-address
15476 @kindex show mips mask-address
15477 Show whether the upper 32 bits of MIPS addresses are masked off or
15480 @item set remote-mips64-transfers-32bit-regs
15481 @kindex set remote-mips64-transfers-32bit-regs
15482 This command controls compatibility with 64-bit MIPS targets that
15483 transfer data in 32-bit quantities. If you have an old MIPS 64 target
15484 that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr},
15485 and 64 bits for other registers, set this option to @samp{on}.
15487 @item show remote-mips64-transfers-32bit-regs
15488 @kindex show remote-mips64-transfers-32bit-regs
15489 Show the current setting of compatibility with older MIPS 64 targets.
15491 @item set debug mips
15492 @kindex set debug mips
15493 This command turns on and off debugging messages for the MIPS-specific
15494 target code in @value{GDBN}.
15496 @item show debug mips
15497 @kindex show debug mips
15498 Show the current setting of MIPS debugging messages.
15504 @cindex HPPA support
15506 When @value{GDBN} is debugging the HP PA architecture, it provides the
15507 following special commands:
15510 @item set debug hppa
15511 @kindex set debug hppa
15512 This command determines whether HPPA architecture-specific debugging
15513 messages are to be displayed.
15515 @item show debug hppa
15516 Show whether HPPA debugging messages are displayed.
15518 @item maint print unwind @var{address}
15519 @kindex maint print unwind@r{, HPPA}
15520 This command displays the contents of the unwind table entry at the
15521 given @var{address}.
15527 @subsection Cell Broadband Engine SPU architecture
15528 @cindex Cell Broadband Engine
15531 When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture,
15532 it provides the following special commands:
15535 @item info spu event
15537 Display SPU event facility status. Shows current event mask
15538 and pending event status.
15540 @item info spu signal
15541 Display SPU signal notification facility status. Shows pending
15542 signal-control word and signal notification mode of both signal
15543 notification channels.
15545 @item info spu mailbox
15546 Display SPU mailbox facility status. Shows all pending entries,
15547 in order of processing, in each of the SPU Write Outbound,
15548 SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes.
15551 Display MFC DMA status. Shows all pending commands in the MFC
15552 DMA queue. For each entry, opcode, tag, class IDs, effective
15553 and local store addresses and transfer size are shown.
15555 @item info spu proxydma
15556 Display MFC Proxy-DMA status. Shows all pending commands in the MFC
15557 Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective
15558 and local store addresses and transfer size are shown.
15563 @node Controlling GDB
15564 @chapter Controlling @value{GDBN}
15566 You can alter the way @value{GDBN} interacts with you by using the
15567 @code{set} command. For commands controlling how @value{GDBN} displays
15568 data, see @ref{Print Settings, ,Print Settings}. Other settings are
15573 * Editing:: Command editing
15574 * Command History:: Command history
15575 * Screen Size:: Screen size
15576 * Numbers:: Numbers
15577 * ABI:: Configuring the current ABI
15578 * Messages/Warnings:: Optional warnings and messages
15579 * Debugging Output:: Optional messages about internal happenings
15587 @value{GDBN} indicates its readiness to read a command by printing a string
15588 called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You
15589 can change the prompt string with the @code{set prompt} command. For
15590 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
15591 the prompt in one of the @value{GDBN} sessions so that you can always tell
15592 which one you are talking to.
15594 @emph{Note:} @code{set prompt} does not add a space for you after the
15595 prompt you set. This allows you to set a prompt which ends in a space
15596 or a prompt that does not.
15600 @item set prompt @var{newprompt}
15601 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
15603 @kindex show prompt
15605 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
15609 @section Command Editing
15611 @cindex command line editing
15613 @value{GDBN} reads its input commands via the @dfn{Readline} interface. This
15614 @sc{gnu} library provides consistent behavior for programs which provide a
15615 command line interface to the user. Advantages are @sc{gnu} Emacs-style
15616 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
15617 substitution, and a storage and recall of command history across
15618 debugging sessions.
15620 You may control the behavior of command line editing in @value{GDBN} with the
15621 command @code{set}.
15624 @kindex set editing
15627 @itemx set editing on
15628 Enable command line editing (enabled by default).
15630 @item set editing off
15631 Disable command line editing.
15633 @kindex show editing
15635 Show whether command line editing is enabled.
15638 @xref{Command Line Editing}, for more details about the Readline
15639 interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are
15640 encouraged to read that chapter.
15642 @node Command History
15643 @section Command History
15644 @cindex command history
15646 @value{GDBN} can keep track of the commands you type during your
15647 debugging sessions, so that you can be certain of precisely what
15648 happened. Use these commands to manage the @value{GDBN} command
15651 @value{GDBN} uses the @sc{gnu} History library, a part of the Readline
15652 package, to provide the history facility. @xref{Using History
15653 Interactively}, for the detailed description of the History library.
15655 To issue a command to @value{GDBN} without affecting certain aspects of
15656 the state which is seen by users, prefix it with @samp{server }
15657 (@pxref{Server Prefix}). This
15658 means that this command will not affect the command history, nor will it
15659 affect @value{GDBN}'s notion of which command to repeat if @key{RET} is
15660 pressed on a line by itself.
15662 @cindex @code{server}, command prefix
15663 The server prefix does not affect the recording of values into the value
15664 history; to print a value without recording it into the value history,
15665 use the @code{output} command instead of the @code{print} command.
15667 Here is the description of @value{GDBN} commands related to command
15671 @cindex history substitution
15672 @cindex history file
15673 @kindex set history filename
15674 @cindex @env{GDBHISTFILE}, environment variable
15675 @item set history filename @var{fname}
15676 Set the name of the @value{GDBN} command history file to @var{fname}.
15677 This is the file where @value{GDBN} reads an initial command history
15678 list, and where it writes the command history from this session when it
15679 exits. You can access this list through history expansion or through
15680 the history command editing characters listed below. This file defaults
15681 to the value of the environment variable @code{GDBHISTFILE}, or to
15682 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
15685 @cindex save command history
15686 @kindex set history save
15687 @item set history save
15688 @itemx set history save on
15689 Record command history in a file, whose name may be specified with the
15690 @code{set history filename} command. By default, this option is disabled.
15692 @item set history save off
15693 Stop recording command history in a file.
15695 @cindex history size
15696 @kindex set history size
15697 @cindex @env{HISTSIZE}, environment variable
15698 @item set history size @var{size}
15699 Set the number of commands which @value{GDBN} keeps in its history list.
15700 This defaults to the value of the environment variable
15701 @code{HISTSIZE}, or to 256 if this variable is not set.
15704 History expansion assigns special meaning to the character @kbd{!}.
15705 @xref{Event Designators}, for more details.
15707 @cindex history expansion, turn on/off
15708 Since @kbd{!} is also the logical not operator in C, history expansion
15709 is off by default. If you decide to enable history expansion with the
15710 @code{set history expansion on} command, you may sometimes need to
15711 follow @kbd{!} (when it is used as logical not, in an expression) with
15712 a space or a tab to prevent it from being expanded. The readline
15713 history facilities do not attempt substitution on the strings
15714 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
15716 The commands to control history expansion are:
15719 @item set history expansion on
15720 @itemx set history expansion
15721 @kindex set history expansion
15722 Enable history expansion. History expansion is off by default.
15724 @item set history expansion off
15725 Disable history expansion.
15728 @kindex show history
15730 @itemx show history filename
15731 @itemx show history save
15732 @itemx show history size
15733 @itemx show history expansion
15734 These commands display the state of the @value{GDBN} history parameters.
15735 @code{show history} by itself displays all four states.
15740 @kindex show commands
15741 @cindex show last commands
15742 @cindex display command history
15743 @item show commands
15744 Display the last ten commands in the command history.
15746 @item show commands @var{n}
15747 Print ten commands centered on command number @var{n}.
15749 @item show commands +
15750 Print ten commands just after the commands last printed.
15754 @section Screen Size
15755 @cindex size of screen
15756 @cindex pauses in output
15758 Certain commands to @value{GDBN} may produce large amounts of
15759 information output to the screen. To help you read all of it,
15760 @value{GDBN} pauses and asks you for input at the end of each page of
15761 output. Type @key{RET} when you want to continue the output, or @kbd{q}
15762 to discard the remaining output. Also, the screen width setting
15763 determines when to wrap lines of output. Depending on what is being
15764 printed, @value{GDBN} tries to break the line at a readable place,
15765 rather than simply letting it overflow onto the following line.
15767 Normally @value{GDBN} knows the size of the screen from the terminal
15768 driver software. For example, on Unix @value{GDBN} uses the termcap data base
15769 together with the value of the @code{TERM} environment variable and the
15770 @code{stty rows} and @code{stty cols} settings. If this is not correct,
15771 you can override it with the @code{set height} and @code{set
15778 @kindex show height
15779 @item set height @var{lpp}
15781 @itemx set width @var{cpl}
15783 These @code{set} commands specify a screen height of @var{lpp} lines and
15784 a screen width of @var{cpl} characters. The associated @code{show}
15785 commands display the current settings.
15787 If you specify a height of zero lines, @value{GDBN} does not pause during
15788 output no matter how long the output is. This is useful if output is to a
15789 file or to an editor buffer.
15791 Likewise, you can specify @samp{set width 0} to prevent @value{GDBN}
15792 from wrapping its output.
15794 @item set pagination on
15795 @itemx set pagination off
15796 @kindex set pagination
15797 Turn the output pagination on or off; the default is on. Turning
15798 pagination off is the alternative to @code{set height 0}.
15800 @item show pagination
15801 @kindex show pagination
15802 Show the current pagination mode.
15807 @cindex number representation
15808 @cindex entering numbers
15810 You can always enter numbers in octal, decimal, or hexadecimal in
15811 @value{GDBN} by the usual conventions: octal numbers begin with
15812 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
15813 begin with @samp{0x}. Numbers that neither begin with @samp{0} or
15814 @samp{0x}, nor end with a @samp{.} are, by default, entered in base
15815 10; likewise, the default display for numbers---when no particular
15816 format is specified---is base 10. You can change the default base for
15817 both input and output with the commands described below.
15820 @kindex set input-radix
15821 @item set input-radix @var{base}
15822 Set the default base for numeric input. Supported choices
15823 for @var{base} are decimal 8, 10, or 16. @var{base} must itself be
15824 specified either unambiguously or using the current input radix; for
15828 set input-radix 012
15829 set input-radix 10.
15830 set input-radix 0xa
15834 sets the input base to decimal. On the other hand, @samp{set input-radix 10}
15835 leaves the input radix unchanged, no matter what it was, since
15836 @samp{10}, being without any leading or trailing signs of its base, is
15837 interpreted in the current radix. Thus, if the current radix is 16,
15838 @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't
15841 @kindex set output-radix
15842 @item set output-radix @var{base}
15843 Set the default base for numeric display. Supported choices
15844 for @var{base} are decimal 8, 10, or 16. @var{base} must itself be
15845 specified either unambiguously or using the current input radix.
15847 @kindex show input-radix
15848 @item show input-radix
15849 Display the current default base for numeric input.
15851 @kindex show output-radix
15852 @item show output-radix
15853 Display the current default base for numeric display.
15855 @item set radix @r{[}@var{base}@r{]}
15859 These commands set and show the default base for both input and output
15860 of numbers. @code{set radix} sets the radix of input and output to
15861 the same base; without an argument, it resets the radix back to its
15862 default value of 10.
15867 @section Configuring the Current ABI
15869 @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your
15870 application automatically. However, sometimes you need to override its
15871 conclusions. Use these commands to manage @value{GDBN}'s view of the
15878 One @value{GDBN} configuration can debug binaries for multiple operating
15879 system targets, either via remote debugging or native emulation.
15880 @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use,
15881 but you can override its conclusion using the @code{set osabi} command.
15882 One example where this is useful is in debugging of binaries which use
15883 an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does
15884 not have the same identifying marks that the standard C library for your
15889 Show the OS ABI currently in use.
15892 With no argument, show the list of registered available OS ABI's.
15894 @item set osabi @var{abi}
15895 Set the current OS ABI to @var{abi}.
15898 @cindex float promotion
15900 Generally, the way that an argument of type @code{float} is passed to a
15901 function depends on whether the function is prototyped. For a prototyped
15902 (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged,
15903 according to the architecture's convention for @code{float}. For unprototyped
15904 (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type
15905 @code{double} and then passed.
15907 Unfortunately, some forms of debug information do not reliably indicate whether
15908 a function is prototyped. If @value{GDBN} calls a function that is not marked
15909 as prototyped, it consults @kbd{set coerce-float-to-double}.
15912 @kindex set coerce-float-to-double
15913 @item set coerce-float-to-double
15914 @itemx set coerce-float-to-double on
15915 Arguments of type @code{float} will be promoted to @code{double} when passed
15916 to an unprototyped function. This is the default setting.
15918 @item set coerce-float-to-double off
15919 Arguments of type @code{float} will be passed directly to unprototyped
15922 @kindex show coerce-float-to-double
15923 @item show coerce-float-to-double
15924 Show the current setting of promoting @code{float} to @code{double}.
15928 @kindex show cp-abi
15929 @value{GDBN} needs to know the ABI used for your program's C@t{++}
15930 objects. The correct C@t{++} ABI depends on which C@t{++} compiler was
15931 used to build your application. @value{GDBN} only fully supports
15932 programs with a single C@t{++} ABI; if your program contains code using
15933 multiple C@t{++} ABI's or if @value{GDBN} can not identify your
15934 program's ABI correctly, you can tell @value{GDBN} which ABI to use.
15935 Currently supported ABI's include ``gnu-v2'', for @code{g++} versions
15936 before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and
15937 ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may
15938 use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is
15943 Show the C@t{++} ABI currently in use.
15946 With no argument, show the list of supported C@t{++} ABI's.
15948 @item set cp-abi @var{abi}
15949 @itemx set cp-abi auto
15950 Set the current C@t{++} ABI to @var{abi}, or return to automatic detection.
15953 @node Messages/Warnings
15954 @section Optional Warnings and Messages
15956 @cindex verbose operation
15957 @cindex optional warnings
15958 By default, @value{GDBN} is silent about its inner workings. If you are
15959 running on a slow machine, you may want to use the @code{set verbose}
15960 command. This makes @value{GDBN} tell you when it does a lengthy
15961 internal operation, so you will not think it has crashed.
15963 Currently, the messages controlled by @code{set verbose} are those
15964 which announce that the symbol table for a source file is being read;
15965 see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
15968 @kindex set verbose
15969 @item set verbose on
15970 Enables @value{GDBN} output of certain informational messages.
15972 @item set verbose off
15973 Disables @value{GDBN} output of certain informational messages.
15975 @kindex show verbose
15977 Displays whether @code{set verbose} is on or off.
15980 By default, if @value{GDBN} encounters bugs in the symbol table of an
15981 object file, it is silent; but if you are debugging a compiler, you may
15982 find this information useful (@pxref{Symbol Errors, ,Errors Reading
15987 @kindex set complaints
15988 @item set complaints @var{limit}
15989 Permits @value{GDBN} to output @var{limit} complaints about each type of
15990 unusual symbols before becoming silent about the problem. Set
15991 @var{limit} to zero to suppress all complaints; set it to a large number
15992 to prevent complaints from being suppressed.
15994 @kindex show complaints
15995 @item show complaints
15996 Displays how many symbol complaints @value{GDBN} is permitted to produce.
16000 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
16001 lot of stupid questions to confirm certain commands. For example, if
16002 you try to run a program which is already running:
16006 The program being debugged has been started already.
16007 Start it from the beginning? (y or n)
16010 If you are willing to unflinchingly face the consequences of your own
16011 commands, you can disable this ``feature'':
16015 @kindex set confirm
16017 @cindex confirmation
16018 @cindex stupid questions
16019 @item set confirm off
16020 Disables confirmation requests.
16022 @item set confirm on
16023 Enables confirmation requests (the default).
16025 @kindex show confirm
16027 Displays state of confirmation requests.
16031 @cindex command tracing
16032 If you need to debug user-defined commands or sourced files you may find it
16033 useful to enable @dfn{command tracing}. In this mode each command will be
16034 printed as it is executed, prefixed with one or more @samp{+} symbols, the
16035 quantity denoting the call depth of each command.
16038 @kindex set trace-commands
16039 @cindex command scripts, debugging
16040 @item set trace-commands on
16041 Enable command tracing.
16042 @item set trace-commands off
16043 Disable command tracing.
16044 @item show trace-commands
16045 Display the current state of command tracing.
16048 @node Debugging Output
16049 @section Optional Messages about Internal Happenings
16050 @cindex optional debugging messages
16052 @value{GDBN} has commands that enable optional debugging messages from
16053 various @value{GDBN} subsystems; normally these commands are of
16054 interest to @value{GDBN} maintainers, or when reporting a bug. This
16055 section documents those commands.
16058 @kindex set exec-done-display
16059 @item set exec-done-display
16060 Turns on or off the notification of asynchronous commands'
16061 completion. When on, @value{GDBN} will print a message when an
16062 asynchronous command finishes its execution. The default is off.
16063 @kindex show exec-done-display
16064 @item show exec-done-display
16065 Displays the current setting of asynchronous command completion
16068 @cindex gdbarch debugging info
16069 @cindex architecture debugging info
16070 @item set debug arch
16071 Turns on or off display of gdbarch debugging info. The default is off
16073 @item show debug arch
16074 Displays the current state of displaying gdbarch debugging info.
16075 @item set debug aix-thread
16076 @cindex AIX threads
16077 Display debugging messages about inner workings of the AIX thread
16079 @item show debug aix-thread
16080 Show the current state of AIX thread debugging info display.
16081 @item set debug event
16082 @cindex event debugging info
16083 Turns on or off display of @value{GDBN} event debugging info. The
16085 @item show debug event
16086 Displays the current state of displaying @value{GDBN} event debugging
16088 @item set debug expression
16089 @cindex expression debugging info
16090 Turns on or off display of debugging info about @value{GDBN}
16091 expression parsing. The default is off.
16092 @item show debug expression
16093 Displays the current state of displaying debugging info about
16094 @value{GDBN} expression parsing.
16095 @item set debug frame
16096 @cindex frame debugging info
16097 Turns on or off display of @value{GDBN} frame debugging info. The
16099 @item show debug frame
16100 Displays the current state of displaying @value{GDBN} frame debugging
16102 @item set debug infrun
16103 @cindex inferior debugging info
16104 Turns on or off display of @value{GDBN} debugging info for running the inferior.
16105 The default is off. @file{infrun.c} contains GDB's runtime state machine used
16106 for implementing operations such as single-stepping the inferior.
16107 @item show debug infrun
16108 Displays the current state of @value{GDBN} inferior debugging.
16109 @item set debug lin-lwp
16110 @cindex @sc{gnu}/Linux LWP debug messages
16111 @cindex Linux lightweight processes
16112 Turns on or off debugging messages from the Linux LWP debug support.
16113 @item show debug lin-lwp
16114 Show the current state of Linux LWP debugging messages.
16115 @item set debug observer
16116 @cindex observer debugging info
16117 Turns on or off display of @value{GDBN} observer debugging. This
16118 includes info such as the notification of observable events.
16119 @item show debug observer
16120 Displays the current state of observer debugging.
16121 @item set debug overload
16122 @cindex C@t{++} overload debugging info
16123 Turns on or off display of @value{GDBN} C@t{++} overload debugging
16124 info. This includes info such as ranking of functions, etc. The default
16126 @item show debug overload
16127 Displays the current state of displaying @value{GDBN} C@t{++} overload
16129 @cindex packets, reporting on stdout
16130 @cindex serial connections, debugging
16131 @cindex debug remote protocol
16132 @cindex remote protocol debugging
16133 @cindex display remote packets
16134 @item set debug remote
16135 Turns on or off display of reports on all packets sent back and forth across
16136 the serial line to the remote machine. The info is printed on the
16137 @value{GDBN} standard output stream. The default is off.
16138 @item show debug remote
16139 Displays the state of display of remote packets.
16140 @item set debug serial
16141 Turns on or off display of @value{GDBN} serial debugging info. The
16143 @item show debug serial
16144 Displays the current state of displaying @value{GDBN} serial debugging
16146 @item set debug solib-frv
16147 @cindex FR-V shared-library debugging
16148 Turns on or off debugging messages for FR-V shared-library code.
16149 @item show debug solib-frv
16150 Display the current state of FR-V shared-library code debugging
16152 @item set debug target
16153 @cindex target debugging info
16154 Turns on or off display of @value{GDBN} target debugging info. This info
16155 includes what is going on at the target level of GDB, as it happens. The
16156 default is 0. Set it to 1 to track events, and to 2 to also track the
16157 value of large memory transfers. Changes to this flag do not take effect
16158 until the next time you connect to a target or use the @code{run} command.
16159 @item show debug target
16160 Displays the current state of displaying @value{GDBN} target debugging
16162 @item set debugvarobj
16163 @cindex variable object debugging info
16164 Turns on or off display of @value{GDBN} variable object debugging
16165 info. The default is off.
16166 @item show debugvarobj
16167 Displays the current state of displaying @value{GDBN} variable object
16169 @item set debug xml
16170 @cindex XML parser debugging
16171 Turns on or off debugging messages for built-in XML parsers.
16172 @item show debug xml
16173 Displays the current state of XML debugging messages.
16177 @chapter Canned Sequences of Commands
16179 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
16180 Command Lists}), @value{GDBN} provides two ways to store sequences of
16181 commands for execution as a unit: user-defined commands and command
16185 * Define:: How to define your own commands
16186 * Hooks:: Hooks for user-defined commands
16187 * Command Files:: How to write scripts of commands to be stored in a file
16188 * Output:: Commands for controlled output
16192 @section User-defined Commands
16194 @cindex user-defined command
16195 @cindex arguments, to user-defined commands
16196 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
16197 which you assign a new name as a command. This is done with the
16198 @code{define} command. User commands may accept up to 10 arguments
16199 separated by whitespace. Arguments are accessed within the user command
16200 via @code{$arg0@dots{}$arg9}. A trivial example:
16204 print $arg0 + $arg1 + $arg2
16209 To execute the command use:
16216 This defines the command @code{adder}, which prints the sum of
16217 its three arguments. Note the arguments are text substitutions, so they may
16218 reference variables, use complex expressions, or even perform inferior
16221 @cindex argument count in user-defined commands
16222 @cindex how many arguments (user-defined commands)
16223 In addition, @code{$argc} may be used to find out how many arguments have
16224 been passed. This expands to a number in the range 0@dots{}10.
16229 print $arg0 + $arg1
16232 print $arg0 + $arg1 + $arg2
16240 @item define @var{commandname}
16241 Define a command named @var{commandname}. If there is already a command
16242 by that name, you are asked to confirm that you want to redefine it.
16244 The definition of the command is made up of other @value{GDBN} command lines,
16245 which are given following the @code{define} command. The end of these
16246 commands is marked by a line containing @code{end}.
16249 @kindex end@r{ (user-defined commands)}
16250 @item document @var{commandname}
16251 Document the user-defined command @var{commandname}, so that it can be
16252 accessed by @code{help}. The command @var{commandname} must already be
16253 defined. This command reads lines of documentation just as @code{define}
16254 reads the lines of the command definition, ending with @code{end}.
16255 After the @code{document} command is finished, @code{help} on command
16256 @var{commandname} displays the documentation you have written.
16258 You may use the @code{document} command again to change the
16259 documentation of a command. Redefining the command with @code{define}
16260 does not change the documentation.
16262 @kindex dont-repeat
16263 @cindex don't repeat command
16265 Used inside a user-defined command, this tells @value{GDBN} that this
16266 command should not be repeated when the user hits @key{RET}
16267 (@pxref{Command Syntax, repeat last command}).
16269 @kindex help user-defined
16270 @item help user-defined
16271 List all user-defined commands, with the first line of the documentation
16276 @itemx show user @var{commandname}
16277 Display the @value{GDBN} commands used to define @var{commandname} (but
16278 not its documentation). If no @var{commandname} is given, display the
16279 definitions for all user-defined commands.
16281 @cindex infinite recursion in user-defined commands
16282 @kindex show max-user-call-depth
16283 @kindex set max-user-call-depth
16284 @item show max-user-call-depth
16285 @itemx set max-user-call-depth
16286 The value of @code{max-user-call-depth} controls how many recursion
16287 levels are allowed in user-defined commands before @value{GDBN} suspects an
16288 infinite recursion and aborts the command.
16291 In addition to the above commands, user-defined commands frequently
16292 use control flow commands, described in @ref{Command Files}.
16294 When user-defined commands are executed, the
16295 commands of the definition are not printed. An error in any command
16296 stops execution of the user-defined command.
16298 If used interactively, commands that would ask for confirmation proceed
16299 without asking when used inside a user-defined command. Many @value{GDBN}
16300 commands that normally print messages to say what they are doing omit the
16301 messages when used in a user-defined command.
16304 @section User-defined Command Hooks
16305 @cindex command hooks
16306 @cindex hooks, for commands
16307 @cindex hooks, pre-command
16310 You may define @dfn{hooks}, which are a special kind of user-defined
16311 command. Whenever you run the command @samp{foo}, if the user-defined
16312 command @samp{hook-foo} exists, it is executed (with no arguments)
16313 before that command.
16315 @cindex hooks, post-command
16317 A hook may also be defined which is run after the command you executed.
16318 Whenever you run the command @samp{foo}, if the user-defined command
16319 @samp{hookpost-foo} exists, it is executed (with no arguments) after
16320 that command. Post-execution hooks may exist simultaneously with
16321 pre-execution hooks, for the same command.
16323 It is valid for a hook to call the command which it hooks. If this
16324 occurs, the hook is not re-executed, thereby avoiding infinite recursion.
16326 @c It would be nice if hookpost could be passed a parameter indicating
16327 @c if the command it hooks executed properly or not. FIXME!
16329 @kindex stop@r{, a pseudo-command}
16330 In addition, a pseudo-command, @samp{stop} exists. Defining
16331 (@samp{hook-stop}) makes the associated commands execute every time
16332 execution stops in your program: before breakpoint commands are run,
16333 displays are printed, or the stack frame is printed.
16335 For example, to ignore @code{SIGALRM} signals while
16336 single-stepping, but treat them normally during normal execution,
16341 handle SIGALRM nopass
16345 handle SIGALRM pass
16348 define hook-continue
16349 handle SIGALRM pass
16353 As a further example, to hook at the beginning and end of the @code{echo}
16354 command, and to add extra text to the beginning and end of the message,
16362 define hookpost-echo
16366 (@value{GDBP}) echo Hello World
16367 <<<---Hello World--->>>
16372 You can define a hook for any single-word command in @value{GDBN}, but
16373 not for command aliases; you should define a hook for the basic command
16374 name, e.g.@: @code{backtrace} rather than @code{bt}.
16375 @c FIXME! So how does Joe User discover whether a command is an alias
16377 If an error occurs during the execution of your hook, execution of
16378 @value{GDBN} commands stops and @value{GDBN} issues a prompt
16379 (before the command that you actually typed had a chance to run).
16381 If you try to define a hook which does not match any known command, you
16382 get a warning from the @code{define} command.
16384 @node Command Files
16385 @section Command Files
16387 @cindex command files
16388 @cindex scripting commands
16389 A command file for @value{GDBN} is a text file made of lines that are
16390 @value{GDBN} commands. Comments (lines starting with @kbd{#}) may
16391 also be included. An empty line in a command file does nothing; it
16392 does not mean to repeat the last command, as it would from the
16395 You can request the execution of a command file with the @code{source}
16400 @cindex execute commands from a file
16401 @item source [@code{-v}] @var{filename}
16402 Execute the command file @var{filename}.
16405 The lines in a command file are generally executed sequentially,
16406 unless the order of execution is changed by one of the
16407 @emph{flow-control commands} described below. The commands are not
16408 printed as they are executed. An error in any command terminates
16409 execution of the command file and control is returned to the console.
16411 @value{GDBN} searches for @var{filename} in the current directory and then
16412 on the search path (specified with the @samp{directory} command).
16414 If @code{-v}, for verbose mode, is given then @value{GDBN} displays
16415 each command as it is executed. The option must be given before
16416 @var{filename}, and is interpreted as part of the filename anywhere else.
16418 Commands that would ask for confirmation if used interactively proceed
16419 without asking when used in a command file. Many @value{GDBN} commands that
16420 normally print messages to say what they are doing omit the messages
16421 when called from command files.
16423 @value{GDBN} also accepts command input from standard input. In this
16424 mode, normal output goes to standard output and error output goes to
16425 standard error. Errors in a command file supplied on standard input do
16426 not terminate execution of the command file---execution continues with
16430 gdb < cmds > log 2>&1
16433 (The syntax above will vary depending on the shell used.) This example
16434 will execute commands from the file @file{cmds}. All output and errors
16435 would be directed to @file{log}.
16437 Since commands stored on command files tend to be more general than
16438 commands typed interactively, they frequently need to deal with
16439 complicated situations, such as different or unexpected values of
16440 variables and symbols, changes in how the program being debugged is
16441 built, etc. @value{GDBN} provides a set of flow-control commands to
16442 deal with these complexities. Using these commands, you can write
16443 complex scripts that loop over data structures, execute commands
16444 conditionally, etc.
16451 This command allows to include in your script conditionally executed
16452 commands. The @code{if} command takes a single argument, which is an
16453 expression to evaluate. It is followed by a series of commands that
16454 are executed only if the expression is true (its value is nonzero).
16455 There can then optionally be an @code{else} line, followed by a series
16456 of commands that are only executed if the expression was false. The
16457 end of the list is marked by a line containing @code{end}.
16461 This command allows to write loops. Its syntax is similar to
16462 @code{if}: the command takes a single argument, which is an expression
16463 to evaluate, and must be followed by the commands to execute, one per
16464 line, terminated by an @code{end}. These commands are called the
16465 @dfn{body} of the loop. The commands in the body of @code{while} are
16466 executed repeatedly as long as the expression evaluates to true.
16470 This command exits the @code{while} loop in whose body it is included.
16471 Execution of the script continues after that @code{while}s @code{end}
16474 @kindex loop_continue
16475 @item loop_continue
16476 This command skips the execution of the rest of the body of commands
16477 in the @code{while} loop in whose body it is included. Execution
16478 branches to the beginning of the @code{while} loop, where it evaluates
16479 the controlling expression.
16481 @kindex end@r{ (if/else/while commands)}
16483 Terminate the block of commands that are the body of @code{if},
16484 @code{else}, or @code{while} flow-control commands.
16489 @section Commands for Controlled Output
16491 During the execution of a command file or a user-defined command, normal
16492 @value{GDBN} output is suppressed; the only output that appears is what is
16493 explicitly printed by the commands in the definition. This section
16494 describes three commands useful for generating exactly the output you
16499 @item echo @var{text}
16500 @c I do not consider backslash-space a standard C escape sequence
16501 @c because it is not in ANSI.
16502 Print @var{text}. Nonprinting characters can be included in
16503 @var{text} using C escape sequences, such as @samp{\n} to print a
16504 newline. @strong{No newline is printed unless you specify one.}
16505 In addition to the standard C escape sequences, a backslash followed
16506 by a space stands for a space. This is useful for displaying a
16507 string with spaces at the beginning or the end, since leading and
16508 trailing spaces are otherwise trimmed from all arguments.
16509 To print @samp{@w{ }and foo =@w{ }}, use the command
16510 @samp{echo \@w{ }and foo = \@w{ }}.
16512 A backslash at the end of @var{text} can be used, as in C, to continue
16513 the command onto subsequent lines. For example,
16516 echo This is some text\n\
16517 which is continued\n\
16518 onto several lines.\n
16521 produces the same output as
16524 echo This is some text\n
16525 echo which is continued\n
16526 echo onto several lines.\n
16530 @item output @var{expression}
16531 Print the value of @var{expression} and nothing but that value: no
16532 newlines, no @samp{$@var{nn} = }. The value is not entered in the
16533 value history either. @xref{Expressions, ,Expressions}, for more information
16536 @item output/@var{fmt} @var{expression}
16537 Print the value of @var{expression} in format @var{fmt}. You can use
16538 the same formats as for @code{print}. @xref{Output Formats,,Output
16539 Formats}, for more information.
16542 @item printf @var{template}, @var{expressions}@dots{}
16543 Print the values of one or more @var{expressions} under the control of
16544 the string @var{template}. To print several values, make
16545 @var{expressions} be a comma-separated list of individual expressions,
16546 which may be either numbers or pointers. Their values are printed as
16547 specified by @var{template}, exactly as a C program would do by
16548 executing the code below:
16551 printf (@var{template}, @var{expressions}@dots{});
16554 As in @code{C} @code{printf}, ordinary characters in @var{template}
16555 are printed verbatim, while @dfn{conversion specification} introduced
16556 by the @samp{%} character cause subsequent @var{expressions} to be
16557 evaluated, their values converted and formatted according to type and
16558 style information encoded in the conversion specifications, and then
16561 For example, you can print two values in hex like this:
16564 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
16567 @code{printf} supports all the standard @code{C} conversion
16568 specifications, including the flags and modifiers between the @samp{%}
16569 character and the conversion letter, with the following exceptions:
16573 The argument-ordering modifiers, such as @samp{2$}, are not supported.
16576 The modifier @samp{*} is not supported for specifying precision or
16580 The @samp{'} flag (for separation of digits into groups according to
16581 @code{LC_NUMERIC'}) is not supported.
16584 The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not
16588 The conversion letter @samp{n} (as in @samp{%n}) is not supported.
16591 The conversion letters @samp{a} and @samp{A} are not supported.
16595 Note that the @samp{ll} type modifier is supported only if the
16596 underlying @code{C} implementation used to build @value{GDBN} supports
16597 the @code{long long int} type, and the @samp{L} type modifier is
16598 supported only if @code{long double} type is available.
16600 As in @code{C}, @code{printf} supports simple backslash-escape
16601 sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"},
16602 @samp{\a}, and @samp{\f}, that consist of backslash followed by a
16603 single character. Octal and hexadecimal escape sequences are not
16606 Additionally, @code{printf} supports conversion specifications for DFP
16607 (@dfn{Decimal Floating Point}) types using the following conversion
16612 @samp{H} for printing @code{Decimal32} types.
16615 @samp{D} for printing @code{Decimal64} types.
16618 @samp{DD} for printing @code{Decimal128} types.
16621 If the underlying @code{C} implementation used to build @value{GDBN} has
16622 support for the three conversion letters for DFP types, other modifiers
16623 such as width and precision will also be available for @value{GDB} to use.
16625 In case there is no such @code{C} support, no additional modifiers will be
16626 available and the value will be printed in the standard way.
16628 Here's an example of printing DFP types using the above conversion letters:
16630 printf "D32: %H - D64: %D - D128: %DD\n",1.2345df,1.2E10dd,1.2E1dl
16636 @chapter Command Interpreters
16637 @cindex command interpreters
16639 @value{GDBN} supports multiple command interpreters, and some command
16640 infrastructure to allow users or user interface writers to switch
16641 between interpreters or run commands in other interpreters.
16643 @value{GDBN} currently supports two command interpreters, the console
16644 interpreter (sometimes called the command-line interpreter or @sc{cli})
16645 and the machine interface interpreter (or @sc{gdb/mi}). This manual
16646 describes both of these interfaces in great detail.
16648 By default, @value{GDBN} will start with the console interpreter.
16649 However, the user may choose to start @value{GDBN} with another
16650 interpreter by specifying the @option{-i} or @option{--interpreter}
16651 startup options. Defined interpreters include:
16655 @cindex console interpreter
16656 The traditional console or command-line interpreter. This is the most often
16657 used interpreter with @value{GDBN}. With no interpreter specified at runtime,
16658 @value{GDBN} will use this interpreter.
16661 @cindex mi interpreter
16662 The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily
16663 by programs wishing to use @value{GDBN} as a backend for a debugger GUI
16664 or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi}
16668 @cindex mi2 interpreter
16669 The current @sc{gdb/mi} interface.
16672 @cindex mi1 interpreter
16673 The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
16677 @cindex invoke another interpreter
16678 The interpreter being used by @value{GDBN} may not be dynamically
16679 switched at runtime. Although possible, this could lead to a very
16680 precarious situation. Consider an IDE using @sc{gdb/mi}. If a user
16681 enters the command "interpreter-set console" in a console view,
16682 @value{GDBN} would switch to using the console interpreter, rendering
16683 the IDE inoperable!
16685 @kindex interpreter-exec
16686 Although you may only choose a single interpreter at startup, you may execute
16687 commands in any interpreter from the current interpreter using the appropriate
16688 command. If you are running the console interpreter, simply use the
16689 @code{interpreter-exec} command:
16692 interpreter-exec mi "-data-list-register-names"
16695 @sc{gdb/mi} has a similar command, although it is only available in versions of
16696 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
16699 @chapter @value{GDBN} Text User Interface
16701 @cindex Text User Interface
16704 * TUI Overview:: TUI overview
16705 * TUI Keys:: TUI key bindings
16706 * TUI Single Key Mode:: TUI single key mode
16707 * TUI Commands:: TUI-specific commands
16708 * TUI Configuration:: TUI configuration variables
16711 The @value{GDBN} Text User Interface (TUI) is a terminal
16712 interface which uses the @code{curses} library to show the source
16713 file, the assembly output, the program registers and @value{GDBN}
16714 commands in separate text windows. The TUI mode is supported only
16715 on platforms where a suitable version of the @code{curses} library
16718 @pindex @value{GDBTUI}
16719 The TUI mode is enabled by default when you invoke @value{GDBN} as
16720 either @samp{@value{GDBTUI}} or @samp{@value{GDBP} -tui}.
16721 You can also switch in and out of TUI mode while @value{GDBN} runs by
16722 using various TUI commands and key bindings, such as @kbd{C-x C-a}.
16723 @xref{TUI Keys, ,TUI Key Bindings}.
16726 @section TUI Overview
16728 In TUI mode, @value{GDBN} can display several text windows:
16732 This window is the @value{GDBN} command window with the @value{GDBN}
16733 prompt and the @value{GDBN} output. The @value{GDBN} input is still
16734 managed using readline.
16737 The source window shows the source file of the program. The current
16738 line and active breakpoints are displayed in this window.
16741 The assembly window shows the disassembly output of the program.
16744 This window shows the processor registers. Registers are highlighted
16745 when their values change.
16748 The source and assembly windows show the current program position
16749 by highlighting the current line and marking it with a @samp{>} marker.
16750 Breakpoints are indicated with two markers. The first marker
16751 indicates the breakpoint type:
16755 Breakpoint which was hit at least once.
16758 Breakpoint which was never hit.
16761 Hardware breakpoint which was hit at least once.
16764 Hardware breakpoint which was never hit.
16767 The second marker indicates whether the breakpoint is enabled or not:
16771 Breakpoint is enabled.
16774 Breakpoint is disabled.
16777 The source, assembly and register windows are updated when the current
16778 thread changes, when the frame changes, or when the program counter
16781 These windows are not all visible at the same time. The command
16782 window is always visible. The others can be arranged in several
16793 source and assembly,
16796 source and registers, or
16799 assembly and registers.
16802 A status line above the command window shows the following information:
16806 Indicates the current @value{GDBN} target.
16807 (@pxref{Targets, ,Specifying a Debugging Target}).
16810 Gives the current process or thread number.
16811 When no process is being debugged, this field is set to @code{No process}.
16814 Gives the current function name for the selected frame.
16815 The name is demangled if demangling is turned on (@pxref{Print Settings}).
16816 When there is no symbol corresponding to the current program counter,
16817 the string @code{??} is displayed.
16820 Indicates the current line number for the selected frame.
16821 When the current line number is not known, the string @code{??} is displayed.
16824 Indicates the current program counter address.
16828 @section TUI Key Bindings
16829 @cindex TUI key bindings
16831 The TUI installs several key bindings in the readline keymaps
16832 (@pxref{Command Line Editing}). The following key bindings
16833 are installed for both TUI mode and the @value{GDBN} standard mode.
16842 Enter or leave the TUI mode. When leaving the TUI mode,
16843 the curses window management stops and @value{GDBN} operates using
16844 its standard mode, writing on the terminal directly. When reentering
16845 the TUI mode, control is given back to the curses windows.
16846 The screen is then refreshed.
16850 Use a TUI layout with only one window. The layout will
16851 either be @samp{source} or @samp{assembly}. When the TUI mode
16852 is not active, it will switch to the TUI mode.
16854 Think of this key binding as the Emacs @kbd{C-x 1} binding.
16858 Use a TUI layout with at least two windows. When the current
16859 layout already has two windows, the next layout with two windows is used.
16860 When a new layout is chosen, one window will always be common to the
16861 previous layout and the new one.
16863 Think of it as the Emacs @kbd{C-x 2} binding.
16867 Change the active window. The TUI associates several key bindings
16868 (like scrolling and arrow keys) with the active window. This command
16869 gives the focus to the next TUI window.
16871 Think of it as the Emacs @kbd{C-x o} binding.
16875 Switch in and out of the TUI SingleKey mode that binds single
16876 keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}).
16879 The following key bindings only work in the TUI mode:
16884 Scroll the active window one page up.
16888 Scroll the active window one page down.
16892 Scroll the active window one line up.
16896 Scroll the active window one line down.
16900 Scroll the active window one column left.
16904 Scroll the active window one column right.
16908 Refresh the screen.
16911 Because the arrow keys scroll the active window in the TUI mode, they
16912 are not available for their normal use by readline unless the command
16913 window has the focus. When another window is active, you must use
16914 other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b}
16915 and @kbd{C-f} to control the command window.
16917 @node TUI Single Key Mode
16918 @section TUI Single Key Mode
16919 @cindex TUI single key mode
16921 The TUI also provides a @dfn{SingleKey} mode, which binds several
16922 frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to
16923 switch into this mode, where the following key bindings are used:
16926 @kindex c @r{(SingleKey TUI key)}
16930 @kindex d @r{(SingleKey TUI key)}
16934 @kindex f @r{(SingleKey TUI key)}
16938 @kindex n @r{(SingleKey TUI key)}
16942 @kindex q @r{(SingleKey TUI key)}
16944 exit the SingleKey mode.
16946 @kindex r @r{(SingleKey TUI key)}
16950 @kindex s @r{(SingleKey TUI key)}
16954 @kindex u @r{(SingleKey TUI key)}
16958 @kindex v @r{(SingleKey TUI key)}
16962 @kindex w @r{(SingleKey TUI key)}
16967 Other keys temporarily switch to the @value{GDBN} command prompt.
16968 The key that was pressed is inserted in the editing buffer so that
16969 it is possible to type most @value{GDBN} commands without interaction
16970 with the TUI SingleKey mode. Once the command is entered the TUI
16971 SingleKey mode is restored. The only way to permanently leave
16972 this mode is by typing @kbd{q} or @kbd{C-x s}.
16976 @section TUI-specific Commands
16977 @cindex TUI commands
16979 The TUI has specific commands to control the text windows.
16980 These commands are always available, even when @value{GDBN} is not in
16981 the TUI mode. When @value{GDBN} is in the standard mode, most
16982 of these commands will automatically switch to the TUI mode.
16987 List and give the size of all displayed windows.
16991 Display the next layout.
16994 Display the previous layout.
16997 Display the source window only.
17000 Display the assembly window only.
17003 Display the source and assembly window.
17006 Display the register window together with the source or assembly window.
17010 Make the next window active for scrolling.
17013 Make the previous window active for scrolling.
17016 Make the source window active for scrolling.
17019 Make the assembly window active for scrolling.
17022 Make the register window active for scrolling.
17025 Make the command window active for scrolling.
17029 Refresh the screen. This is similar to typing @kbd{C-L}.
17031 @item tui reg float
17033 Show the floating point registers in the register window.
17035 @item tui reg general
17036 Show the general registers in the register window.
17039 Show the next register group. The list of register groups as well as
17040 their order is target specific. The predefined register groups are the
17041 following: @code{general}, @code{float}, @code{system}, @code{vector},
17042 @code{all}, @code{save}, @code{restore}.
17044 @item tui reg system
17045 Show the system registers in the register window.
17049 Update the source window and the current execution point.
17051 @item winheight @var{name} +@var{count}
17052 @itemx winheight @var{name} -@var{count}
17054 Change the height of the window @var{name} by @var{count}
17055 lines. Positive counts increase the height, while negative counts
17058 @item tabset @var{nchars}
17060 Set the width of tab stops to be @var{nchars} characters.
17063 @node TUI Configuration
17064 @section TUI Configuration Variables
17065 @cindex TUI configuration variables
17067 Several configuration variables control the appearance of TUI windows.
17070 @item set tui border-kind @var{kind}
17071 @kindex set tui border-kind
17072 Select the border appearance for the source, assembly and register windows.
17073 The possible values are the following:
17076 Use a space character to draw the border.
17079 Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border.
17082 Use the Alternate Character Set to draw the border. The border is
17083 drawn using character line graphics if the terminal supports them.
17086 @item set tui border-mode @var{mode}
17087 @kindex set tui border-mode
17088 @itemx set tui active-border-mode @var{mode}
17089 @kindex set tui active-border-mode
17090 Select the display attributes for the borders of the inactive windows
17091 or the active window. The @var{mode} can be one of the following:
17094 Use normal attributes to display the border.
17100 Use reverse video mode.
17103 Use half bright mode.
17105 @item half-standout
17106 Use half bright and standout mode.
17109 Use extra bright or bold mode.
17111 @item bold-standout
17112 Use extra bright or bold and standout mode.
17117 @chapter Using @value{GDBN} under @sc{gnu} Emacs
17120 @cindex @sc{gnu} Emacs
17121 A special interface allows you to use @sc{gnu} Emacs to view (and
17122 edit) the source files for the program you are debugging with
17125 To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the
17126 executable file you want to debug as an argument. This command starts
17127 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
17128 created Emacs buffer.
17129 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
17131 Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two
17136 All ``terminal'' input and output goes through an Emacs buffer, called
17139 This applies both to @value{GDBN} commands and their output, and to the input
17140 and output done by the program you are debugging.
17142 This is useful because it means that you can copy the text of previous
17143 commands and input them again; you can even use parts of the output
17146 All the facilities of Emacs' Shell mode are available for interacting
17147 with your program. In particular, you can send signals the usual
17148 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
17152 @value{GDBN} displays source code through Emacs.
17154 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
17155 source file for that frame and puts an arrow (@samp{=>}) at the
17156 left margin of the current line. Emacs uses a separate buffer for
17157 source display, and splits the screen to show both your @value{GDBN} session
17160 Explicit @value{GDBN} @code{list} or search commands still produce output as
17161 usual, but you probably have no reason to use them from Emacs.
17164 We call this @dfn{text command mode}. Emacs 22.1, and later, also uses
17165 a graphical mode, enabled by default, which provides further buffers
17166 that can control the execution and describe the state of your program.
17167 @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}.
17169 If you specify an absolute file name when prompted for the @kbd{M-x
17170 gdb} argument, then Emacs sets your current working directory to where
17171 your program resides. If you only specify the file name, then Emacs
17172 sets your current working directory to to the directory associated
17173 with the previous buffer. In this case, @value{GDBN} may find your
17174 program by searching your environment's @code{PATH} variable, but on
17175 some operating systems it might not find the source. So, although the
17176 @value{GDBN} input and output session proceeds normally, the auxiliary
17177 buffer does not display the current source and line of execution.
17179 The initial working directory of @value{GDBN} is printed on the top
17180 line of the GUD buffer and this serves as a default for the commands
17181 that specify files for @value{GDBN} to operate on. @xref{Files,
17182 ,Commands to Specify Files}.
17184 By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you
17185 need to call @value{GDBN} by a different name (for example, if you
17186 keep several configurations around, with different names) you can
17187 customize the Emacs variable @code{gud-gdb-command-name} to run the
17190 In the GUD buffer, you can use these special Emacs commands in
17191 addition to the standard Shell mode commands:
17195 Describe the features of Emacs' GUD Mode.
17198 Execute to another source line, like the @value{GDBN} @code{step} command; also
17199 update the display window to show the current file and location.
17202 Execute to next source line in this function, skipping all function
17203 calls, like the @value{GDBN} @code{next} command. Then update the display window
17204 to show the current file and location.
17207 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
17208 display window accordingly.
17211 Execute until exit from the selected stack frame, like the @value{GDBN}
17212 @code{finish} command.
17215 Continue execution of your program, like the @value{GDBN} @code{continue}
17219 Go up the number of frames indicated by the numeric argument
17220 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
17221 like the @value{GDBN} @code{up} command.
17224 Go down the number of frames indicated by the numeric argument, like the
17225 @value{GDBN} @code{down} command.
17228 In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break})
17229 tells @value{GDBN} to set a breakpoint on the source line point is on.
17231 In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a
17232 separate frame which shows a backtrace when the GUD buffer is current.
17233 Move point to any frame in the stack and type @key{RET} to make it
17234 become the current frame and display the associated source in the
17235 source buffer. Alternatively, click @kbd{Mouse-2} to make the
17236 selected frame become the current one. In graphical mode, the
17237 speedbar displays watch expressions.
17239 If you accidentally delete the source-display buffer, an easy way to get
17240 it back is to type the command @code{f} in the @value{GDBN} buffer, to
17241 request a frame display; when you run under Emacs, this recreates
17242 the source buffer if necessary to show you the context of the current
17245 The source files displayed in Emacs are in ordinary Emacs buffers
17246 which are visiting the source files in the usual way. You can edit
17247 the files with these buffers if you wish; but keep in mind that @value{GDBN}
17248 communicates with Emacs in terms of line numbers. If you add or
17249 delete lines from the text, the line numbers that @value{GDBN} knows cease
17250 to correspond properly with the code.
17252 A more detailed description of Emacs' interaction with @value{GDBN} is
17253 given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu}
17256 @c The following dropped because Epoch is nonstandard. Reactivate
17257 @c if/when v19 does something similar. ---doc@cygnus.com 19dec1990
17259 @kindex Emacs Epoch environment
17263 Version 18 of @sc{gnu} Emacs has a built-in window system
17264 called the @code{epoch}
17265 environment. Users of this environment can use a new command,
17266 @code{inspect} which performs identically to @code{print} except that
17267 each value is printed in its own window.
17272 @chapter The @sc{gdb/mi} Interface
17274 @unnumberedsec Function and Purpose
17276 @cindex @sc{gdb/mi}, its purpose
17277 @sc{gdb/mi} is a line based machine oriented text interface to
17278 @value{GDBN} and is activated by specifying using the
17279 @option{--interpreter} command line option (@pxref{Mode Options}). It
17280 is specifically intended to support the development of systems which
17281 use the debugger as just one small component of a larger system.
17283 This chapter is a specification of the @sc{gdb/mi} interface. It is written
17284 in the form of a reference manual.
17286 Note that @sc{gdb/mi} is still under construction, so some of the
17287 features described below are incomplete and subject to change
17288 (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}).
17290 @unnumberedsec Notation and Terminology
17292 @cindex notational conventions, for @sc{gdb/mi}
17293 This chapter uses the following notation:
17297 @code{|} separates two alternatives.
17300 @code{[ @var{something} ]} indicates that @var{something} is optional:
17301 it may or may not be given.
17304 @code{( @var{group} )*} means that @var{group} inside the parentheses
17305 may repeat zero or more times.
17308 @code{( @var{group} )+} means that @var{group} inside the parentheses
17309 may repeat one or more times.
17312 @code{"@var{string}"} means a literal @var{string}.
17316 @heading Dependencies
17320 * GDB/MI Command Syntax::
17321 * GDB/MI Compatibility with CLI::
17322 * GDB/MI Development and Front Ends::
17323 * GDB/MI Output Records::
17324 * GDB/MI Simple Examples::
17325 * GDB/MI Command Description Format::
17326 * GDB/MI Breakpoint Commands::
17327 * GDB/MI Program Context::
17328 * GDB/MI Thread Commands::
17329 * GDB/MI Program Execution::
17330 * GDB/MI Stack Manipulation::
17331 * GDB/MI Variable Objects::
17332 * GDB/MI Data Manipulation::
17333 * GDB/MI Tracepoint Commands::
17334 * GDB/MI Symbol Query::
17335 * GDB/MI File Commands::
17337 * GDB/MI Kod Commands::
17338 * GDB/MI Memory Overlay Commands::
17339 * GDB/MI Signal Handling Commands::
17341 * GDB/MI Target Manipulation::
17342 * GDB/MI Miscellaneous Commands::
17345 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17346 @node GDB/MI Command Syntax
17347 @section @sc{gdb/mi} Command Syntax
17350 * GDB/MI Input Syntax::
17351 * GDB/MI Output Syntax::
17354 @node GDB/MI Input Syntax
17355 @subsection @sc{gdb/mi} Input Syntax
17357 @cindex input syntax for @sc{gdb/mi}
17358 @cindex @sc{gdb/mi}, input syntax
17360 @item @var{command} @expansion{}
17361 @code{@var{cli-command} | @var{mi-command}}
17363 @item @var{cli-command} @expansion{}
17364 @code{[ @var{token} ] @var{cli-command} @var{nl}}, where
17365 @var{cli-command} is any existing @value{GDBN} CLI command.
17367 @item @var{mi-command} @expansion{}
17368 @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*
17369 @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
17371 @item @var{token} @expansion{}
17372 "any sequence of digits"
17374 @item @var{option} @expansion{}
17375 @code{"-" @var{parameter} [ " " @var{parameter} ]}
17377 @item @var{parameter} @expansion{}
17378 @code{@var{non-blank-sequence} | @var{c-string}}
17380 @item @var{operation} @expansion{}
17381 @emph{any of the operations described in this chapter}
17383 @item @var{non-blank-sequence} @expansion{}
17384 @emph{anything, provided it doesn't contain special characters such as
17385 "-", @var{nl}, """ and of course " "}
17387 @item @var{c-string} @expansion{}
17388 @code{""" @var{seven-bit-iso-c-string-content} """}
17390 @item @var{nl} @expansion{}
17399 The CLI commands are still handled by the @sc{mi} interpreter; their
17400 output is described below.
17403 The @code{@var{token}}, when present, is passed back when the command
17407 Some @sc{mi} commands accept optional arguments as part of the parameter
17408 list. Each option is identified by a leading @samp{-} (dash) and may be
17409 followed by an optional argument parameter. Options occur first in the
17410 parameter list and can be delimited from normal parameters using
17411 @samp{--} (this is useful when some parameters begin with a dash).
17418 We want easy access to the existing CLI syntax (for debugging).
17421 We want it to be easy to spot a @sc{mi} operation.
17424 @node GDB/MI Output Syntax
17425 @subsection @sc{gdb/mi} Output Syntax
17427 @cindex output syntax of @sc{gdb/mi}
17428 @cindex @sc{gdb/mi}, output syntax
17429 The output from @sc{gdb/mi} consists of zero or more out-of-band records
17430 followed, optionally, by a single result record. This result record
17431 is for the most recent command. The sequence of output records is
17432 terminated by @samp{(gdb)}.
17434 If an input command was prefixed with a @code{@var{token}} then the
17435 corresponding output for that command will also be prefixed by that same
17439 @item @var{output} @expansion{}
17440 @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}
17442 @item @var{result-record} @expansion{}
17443 @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}
17445 @item @var{out-of-band-record} @expansion{}
17446 @code{@var{async-record} | @var{stream-record}}
17448 @item @var{async-record} @expansion{}
17449 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
17451 @item @var{exec-async-output} @expansion{}
17452 @code{[ @var{token} ] "*" @var{async-output}}
17454 @item @var{status-async-output} @expansion{}
17455 @code{[ @var{token} ] "+" @var{async-output}}
17457 @item @var{notify-async-output} @expansion{}
17458 @code{[ @var{token} ] "=" @var{async-output}}
17460 @item @var{async-output} @expansion{}
17461 @code{@var{async-class} ( "," @var{result} )* @var{nl}}
17463 @item @var{result-class} @expansion{}
17464 @code{"done" | "running" | "connected" | "error" | "exit"}
17466 @item @var{async-class} @expansion{}
17467 @code{"stopped" | @var{others}} (where @var{others} will be added
17468 depending on the needs---this is still in development).
17470 @item @var{result} @expansion{}
17471 @code{ @var{variable} "=" @var{value}}
17473 @item @var{variable} @expansion{}
17474 @code{ @var{string} }
17476 @item @var{value} @expansion{}
17477 @code{ @var{const} | @var{tuple} | @var{list} }
17479 @item @var{const} @expansion{}
17480 @code{@var{c-string}}
17482 @item @var{tuple} @expansion{}
17483 @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" }
17485 @item @var{list} @expansion{}
17486 @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "["
17487 @var{result} ( "," @var{result} )* "]" }
17489 @item @var{stream-record} @expansion{}
17490 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
17492 @item @var{console-stream-output} @expansion{}
17493 @code{"~" @var{c-string}}
17495 @item @var{target-stream-output} @expansion{}
17496 @code{"@@" @var{c-string}}
17498 @item @var{log-stream-output} @expansion{}
17499 @code{"&" @var{c-string}}
17501 @item @var{nl} @expansion{}
17504 @item @var{token} @expansion{}
17505 @emph{any sequence of digits}.
17513 All output sequences end in a single line containing a period.
17516 The @code{@var{token}} is from the corresponding request. If an execution
17517 command is interrupted by the @samp{-exec-interrupt} command, the
17518 @var{token} associated with the @samp{*stopped} message is the one of the
17519 original execution command, not the one of the interrupt command.
17522 @cindex status output in @sc{gdb/mi}
17523 @var{status-async-output} contains on-going status information about the
17524 progress of a slow operation. It can be discarded. All status output is
17525 prefixed by @samp{+}.
17528 @cindex async output in @sc{gdb/mi}
17529 @var{exec-async-output} contains asynchronous state change on the target
17530 (stopped, started, disappeared). All async output is prefixed by
17534 @cindex notify output in @sc{gdb/mi}
17535 @var{notify-async-output} contains supplementary information that the
17536 client should handle (e.g., a new breakpoint information). All notify
17537 output is prefixed by @samp{=}.
17540 @cindex console output in @sc{gdb/mi}
17541 @var{console-stream-output} is output that should be displayed as is in the
17542 console. It is the textual response to a CLI command. All the console
17543 output is prefixed by @samp{~}.
17546 @cindex target output in @sc{gdb/mi}
17547 @var{target-stream-output} is the output produced by the target program.
17548 All the target output is prefixed by @samp{@@}.
17551 @cindex log output in @sc{gdb/mi}
17552 @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for
17553 instance messages that should be displayed as part of an error log. All
17554 the log output is prefixed by @samp{&}.
17557 @cindex list output in @sc{gdb/mi}
17558 New @sc{gdb/mi} commands should only output @var{lists} containing
17564 @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more
17565 details about the various output records.
17567 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17568 @node GDB/MI Compatibility with CLI
17569 @section @sc{gdb/mi} Compatibility with CLI
17571 @cindex compatibility, @sc{gdb/mi} and CLI
17572 @cindex @sc{gdb/mi}, compatibility with CLI
17574 For the developers convenience CLI commands can be entered directly,
17575 but there may be some unexpected behaviour. For example, commands
17576 that query the user will behave as if the user replied yes, breakpoint
17577 command lists are not executed and some CLI commands, such as
17578 @code{if}, @code{when} and @code{define}, prompt for further input with
17579 @samp{>}, which is not valid MI output.
17581 This feature may be removed at some stage in the future and it is
17582 recommended that front ends use the @code{-interpreter-exec} command
17583 (@pxref{-interpreter-exec}).
17585 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17586 @node GDB/MI Development and Front Ends
17587 @section @sc{gdb/mi} Development and Front Ends
17588 @cindex @sc{gdb/mi} development
17590 The application which takes the MI output and presents the state of the
17591 program being debugged to the user is called a @dfn{front end}.
17593 Although @sc{gdb/mi} is still incomplete, it is currently being used
17594 by a variety of front ends to @value{GDBN}. This makes it difficult
17595 to introduce new functionality without breaking existing usage. This
17596 section tries to minimize the problems by describing how the protocol
17599 Some changes in MI need not break a carefully designed front end, and
17600 for these the MI version will remain unchanged. The following is a
17601 list of changes that may occur within one level, so front ends should
17602 parse MI output in a way that can handle them:
17606 New MI commands may be added.
17609 New fields may be added to the output of any MI command.
17612 The range of values for fields with specified values, e.g.,
17613 @code{in_scope} (@pxref{-var-update}) may be extended.
17615 @c The format of field's content e.g type prefix, may change so parse it
17616 @c at your own risk. Yes, in general?
17618 @c The order of fields may change? Shouldn't really matter but it might
17619 @c resolve inconsistencies.
17622 If the changes are likely to break front ends, the MI version level
17623 will be increased by one. This will allow the front end to parse the
17624 output according to the MI version. Apart from mi0, new versions of
17625 @value{GDBN} will not support old versions of MI and it will be the
17626 responsibility of the front end to work with the new one.
17628 @c Starting with mi3, add a new command -mi-version that prints the MI
17631 The best way to avoid unexpected changes in MI that might break your front
17632 end is to make your project known to @value{GDBN} developers and
17633 follow development on @email{gdb@@sourceware.org} and
17634 @email{gdb-patches@@sourceware.org}. There is also the mailing list
17635 @email{dmi-discuss@@lists.freestandards.org}, hosted by the Free Standards
17636 Group, which has the aim of creating a more general MI protocol
17637 called Debugger Machine Interface (DMI) that will become a standard
17638 for all debuggers, not just @value{GDBN}.
17639 @cindex mailing lists
17641 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17642 @node GDB/MI Output Records
17643 @section @sc{gdb/mi} Output Records
17646 * GDB/MI Result Records::
17647 * GDB/MI Stream Records::
17648 * GDB/MI Out-of-band Records::
17651 @node GDB/MI Result Records
17652 @subsection @sc{gdb/mi} Result Records
17654 @cindex result records in @sc{gdb/mi}
17655 @cindex @sc{gdb/mi}, result records
17656 In addition to a number of out-of-band notifications, the response to a
17657 @sc{gdb/mi} command includes one of the following result indications:
17661 @item "^done" [ "," @var{results} ]
17662 The synchronous operation was successful, @code{@var{results}} are the return
17667 @c Is this one correct? Should it be an out-of-band notification?
17668 The asynchronous operation was successfully started. The target is
17673 @value{GDBN} has connected to a remote target.
17675 @item "^error" "," @var{c-string}
17677 The operation failed. The @code{@var{c-string}} contains the corresponding
17682 @value{GDBN} has terminated.
17686 @node GDB/MI Stream Records
17687 @subsection @sc{gdb/mi} Stream Records
17689 @cindex @sc{gdb/mi}, stream records
17690 @cindex stream records in @sc{gdb/mi}
17691 @value{GDBN} internally maintains a number of output streams: the console, the
17692 target, and the log. The output intended for each of these streams is
17693 funneled through the @sc{gdb/mi} interface using @dfn{stream records}.
17695 Each stream record begins with a unique @dfn{prefix character} which
17696 identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output
17697 Syntax}). In addition to the prefix, each stream record contains a
17698 @code{@var{string-output}}. This is either raw text (with an implicit new
17699 line) or a quoted C string (which does not contain an implicit newline).
17702 @item "~" @var{string-output}
17703 The console output stream contains text that should be displayed in the
17704 CLI console window. It contains the textual responses to CLI commands.
17706 @item "@@" @var{string-output}
17707 The target output stream contains any textual output from the running
17708 target. This is only present when GDB's event loop is truly
17709 asynchronous, which is currently only the case for remote targets.
17711 @item "&" @var{string-output}
17712 The log stream contains debugging messages being produced by @value{GDBN}'s
17716 @node GDB/MI Out-of-band Records
17717 @subsection @sc{gdb/mi} Out-of-band Records
17719 @cindex out-of-band records in @sc{gdb/mi}
17720 @cindex @sc{gdb/mi}, out-of-band records
17721 @dfn{Out-of-band} records are used to notify the @sc{gdb/mi} client of
17722 additional changes that have occurred. Those changes can either be a
17723 consequence of @sc{gdb/mi} (e.g., a breakpoint modified) or a result of
17724 target activity (e.g., target stopped).
17726 The following is a preliminary list of possible out-of-band records.
17727 In particular, the @var{exec-async-output} records.
17730 @item *stopped,reason="@var{reason}"
17733 @var{reason} can be one of the following:
17736 @item breakpoint-hit
17737 A breakpoint was reached.
17738 @item watchpoint-trigger
17739 A watchpoint was triggered.
17740 @item read-watchpoint-trigger
17741 A read watchpoint was triggered.
17742 @item access-watchpoint-trigger
17743 An access watchpoint was triggered.
17744 @item function-finished
17745 An -exec-finish or similar CLI command was accomplished.
17746 @item location-reached
17747 An -exec-until or similar CLI command was accomplished.
17748 @item watchpoint-scope
17749 A watchpoint has gone out of scope.
17750 @item end-stepping-range
17751 An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or
17752 similar CLI command was accomplished.
17753 @item exited-signalled
17754 The inferior exited because of a signal.
17756 The inferior exited.
17757 @item exited-normally
17758 The inferior exited normally.
17759 @item signal-received
17760 A signal was received by the inferior.
17764 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17765 @node GDB/MI Simple Examples
17766 @section Simple Examples of @sc{gdb/mi} Interaction
17767 @cindex @sc{gdb/mi}, simple examples
17769 This subsection presents several simple examples of interaction using
17770 the @sc{gdb/mi} interface. In these examples, @samp{->} means that the
17771 following line is passed to @sc{gdb/mi} as input, while @samp{<-} means
17772 the output received from @sc{gdb/mi}.
17774 Note the line breaks shown in the examples are here only for
17775 readability, they don't appear in the real output.
17777 @subheading Setting a Breakpoint
17779 Setting a breakpoint generates synchronous output which contains detailed
17780 information of the breakpoint.
17783 -> -break-insert main
17784 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
17785 enabled="y",addr="0x08048564",func="main",file="myprog.c",
17786 fullname="/home/nickrob/myprog.c",line="68",times="0"@}
17790 @subheading Program Execution
17792 Program execution generates asynchronous records and MI gives the
17793 reason that execution stopped.
17799 <- *stopped,reason="breakpoint-hit",bkptno="1",thread-id="0",
17800 frame=@{addr="0x08048564",func="main",
17801 args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}],
17802 file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@}
17807 <- *stopped,reason="exited-normally"
17811 @subheading Quitting @value{GDBN}
17813 Quitting @value{GDBN} just prints the result class @samp{^exit}.
17821 @subheading A Bad Command
17823 Here's what happens if you pass a non-existent command:
17827 <- ^error,msg="Undefined MI command: rubbish"
17832 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17833 @node GDB/MI Command Description Format
17834 @section @sc{gdb/mi} Command Description Format
17836 The remaining sections describe blocks of commands. Each block of
17837 commands is laid out in a fashion similar to this section.
17839 @subheading Motivation
17841 The motivation for this collection of commands.
17843 @subheading Introduction
17845 A brief introduction to this collection of commands as a whole.
17847 @subheading Commands
17849 For each command in the block, the following is described:
17851 @subsubheading Synopsis
17854 -command @var{args}@dots{}
17857 @subsubheading Result
17859 @subsubheading @value{GDBN} Command
17861 The corresponding @value{GDBN} CLI command(s), if any.
17863 @subsubheading Example
17865 Example(s) formatted for readability. Some of the described commands have
17866 not been implemented yet and these are labeled N.A.@: (not available).
17869 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
17870 @node GDB/MI Breakpoint Commands
17871 @section @sc{gdb/mi} Breakpoint Commands
17873 @cindex breakpoint commands for @sc{gdb/mi}
17874 @cindex @sc{gdb/mi}, breakpoint commands
17875 This section documents @sc{gdb/mi} commands for manipulating
17878 @subheading The @code{-break-after} Command
17879 @findex -break-after
17881 @subsubheading Synopsis
17884 -break-after @var{number} @var{count}
17887 The breakpoint number @var{number} is not in effect until it has been
17888 hit @var{count} times. To see how this is reflected in the output of
17889 the @samp{-break-list} command, see the description of the
17890 @samp{-break-list} command below.
17892 @subsubheading @value{GDBN} Command
17894 The corresponding @value{GDBN} command is @samp{ignore}.
17896 @subsubheading Example
17901 ^done,bkpt=@{number="1",addr="0x000100d0",file="hello.c",
17902 fullname="/home/foo/hello.c",line="5",times="0"@}
17909 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
17910 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
17911 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
17912 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
17913 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
17914 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
17915 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
17916 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
17917 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
17918 line="5",times="0",ignore="3"@}]@}
17923 @subheading The @code{-break-catch} Command
17924 @findex -break-catch
17926 @subheading The @code{-break-commands} Command
17927 @findex -break-commands
17931 @subheading The @code{-break-condition} Command
17932 @findex -break-condition
17934 @subsubheading Synopsis
17937 -break-condition @var{number} @var{expr}
17940 Breakpoint @var{number} will stop the program only if the condition in
17941 @var{expr} is true. The condition becomes part of the
17942 @samp{-break-list} output (see the description of the @samp{-break-list}
17945 @subsubheading @value{GDBN} Command
17947 The corresponding @value{GDBN} command is @samp{condition}.
17949 @subsubheading Example
17953 -break-condition 1 1
17957 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
17958 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
17959 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
17960 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
17961 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
17962 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
17963 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
17964 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
17965 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
17966 line="5",cond="1",times="0",ignore="3"@}]@}
17970 @subheading The @code{-break-delete} Command
17971 @findex -break-delete
17973 @subsubheading Synopsis
17976 -break-delete ( @var{breakpoint} )+
17979 Delete the breakpoint(s) whose number(s) are specified in the argument
17980 list. This is obviously reflected in the breakpoint list.
17982 @subsubheading @value{GDBN} Command
17984 The corresponding @value{GDBN} command is @samp{delete}.
17986 @subsubheading Example
17994 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
17995 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
17996 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
17997 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
17998 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
17999 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18000 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18005 @subheading The @code{-break-disable} Command
18006 @findex -break-disable
18008 @subsubheading Synopsis
18011 -break-disable ( @var{breakpoint} )+
18014 Disable the named @var{breakpoint}(s). The field @samp{enabled} in the
18015 break list is now set to @samp{n} for the named @var{breakpoint}(s).
18017 @subsubheading @value{GDBN} Command
18019 The corresponding @value{GDBN} command is @samp{disable}.
18021 @subsubheading Example
18029 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
18030 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18031 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18032 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18033 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18034 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18035 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18036 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
18037 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
18038 line="5",times="0"@}]@}
18042 @subheading The @code{-break-enable} Command
18043 @findex -break-enable
18045 @subsubheading Synopsis
18048 -break-enable ( @var{breakpoint} )+
18051 Enable (previously disabled) @var{breakpoint}(s).
18053 @subsubheading @value{GDBN} Command
18055 The corresponding @value{GDBN} command is @samp{enable}.
18057 @subsubheading Example
18065 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
18066 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18067 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18068 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18069 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18070 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18071 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18072 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
18073 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
18074 line="5",times="0"@}]@}
18078 @subheading The @code{-break-info} Command
18079 @findex -break-info
18081 @subsubheading Synopsis
18084 -break-info @var{breakpoint}
18088 Get information about a single breakpoint.
18090 @subsubheading @value{GDBN} Command
18092 The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}.
18094 @subsubheading Example
18097 @subheading The @code{-break-insert} Command
18098 @findex -break-insert
18100 @subsubheading Synopsis
18103 -break-insert [ -t ] [ -h ] [ -r ]
18104 [ -c @var{condition} ] [ -i @var{ignore-count} ]
18105 [ -p @var{thread} ] [ @var{line} | @var{addr} ]
18109 If specified, @var{line}, can be one of:
18116 @item filename:linenum
18117 @item filename:function
18121 The possible optional parameters of this command are:
18125 Insert a temporary breakpoint.
18127 Insert a hardware breakpoint.
18128 @item -c @var{condition}
18129 Make the breakpoint conditional on @var{condition}.
18130 @item -i @var{ignore-count}
18131 Initialize the @var{ignore-count}.
18133 Insert a regular breakpoint in all the functions whose names match the
18134 given regular expression. Other flags are not applicable to regular
18138 @subsubheading Result
18140 The result is in the form:
18143 ^done,bkpt=@{number="@var{number}",type="@var{type}",disp="del"|"keep",
18144 enabled="y"|"n",addr="@var{hex}",func="@var{funcname}",file="@var{filename}",
18145 fullname="@var{full_filename}",line="@var{lineno}",[thread="@var{threadno},]
18146 times="@var{times}"@}
18150 where @var{number} is the @value{GDBN} number for this breakpoint,
18151 @var{funcname} is the name of the function where the breakpoint was
18152 inserted, @var{filename} is the name of the source file which contains
18153 this function, @var{lineno} is the source line number within that file
18154 and @var{times} the number of times that the breakpoint has been hit
18155 (always 0 for -break-insert but may be greater for -break-info or -break-list
18156 which use the same output).
18158 Note: this format is open to change.
18159 @c An out-of-band breakpoint instead of part of the result?
18161 @subsubheading @value{GDBN} Command
18163 The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak},
18164 @samp{hbreak}, @samp{thbreak}, and @samp{rbreak}.
18166 @subsubheading Example
18171 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
18172 fullname="/home/foo/recursive2.c,line="4",times="0"@}
18174 -break-insert -t foo
18175 ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
18176 fullname="/home/foo/recursive2.c,line="11",times="0"@}
18179 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
18180 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18181 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18182 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18183 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18184 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18185 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18186 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
18187 addr="0x0001072c", func="main",file="recursive2.c",
18188 fullname="/home/foo/recursive2.c,"line="4",times="0"@},
18189 bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",
18190 addr="0x00010774",func="foo",file="recursive2.c",
18191 fullname="/home/foo/recursive2.c",line="11",times="0"@}]@}
18193 -break-insert -r foo.*
18194 ~int foo(int, int);
18195 ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c,
18196 "fullname="/home/foo/recursive2.c",line="11",times="0"@}
18200 @subheading The @code{-break-list} Command
18201 @findex -break-list
18203 @subsubheading Synopsis
18209 Displays the list of inserted breakpoints, showing the following fields:
18213 number of the breakpoint
18215 type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}
18217 should the breakpoint be deleted or disabled when it is hit: @samp{keep}
18220 is the breakpoint enabled or no: @samp{y} or @samp{n}
18222 memory location at which the breakpoint is set
18224 logical location of the breakpoint, expressed by function name, file
18227 number of times the breakpoint has been hit
18230 If there are no breakpoints or watchpoints, the @code{BreakpointTable}
18231 @code{body} field is an empty list.
18233 @subsubheading @value{GDBN} Command
18235 The corresponding @value{GDBN} command is @samp{info break}.
18237 @subsubheading Example
18242 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
18243 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18244 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18245 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18246 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18247 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18248 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18249 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
18250 addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@},
18251 bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
18252 addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
18253 line="13",times="0"@}]@}
18257 Here's an example of the result when there are no breakpoints:
18262 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
18263 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18264 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18265 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18266 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18267 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18268 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18273 @subheading The @code{-break-watch} Command
18274 @findex -break-watch
18276 @subsubheading Synopsis
18279 -break-watch [ -a | -r ]
18282 Create a watchpoint. With the @samp{-a} option it will create an
18283 @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a
18284 read from or on a write to the memory location. With the @samp{-r}
18285 option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will
18286 trigger only when the memory location is accessed for reading. Without
18287 either of the options, the watchpoint created is a regular watchpoint,
18288 i.e., it will trigger when the memory location is accessed for writing.
18289 @xref{Set Watchpoints, , Setting Watchpoints}.
18291 Note that @samp{-break-list} will report a single list of watchpoints and
18292 breakpoints inserted.
18294 @subsubheading @value{GDBN} Command
18296 The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and
18299 @subsubheading Example
18301 Setting a watchpoint on a variable in the @code{main} function:
18306 ^done,wpt=@{number="2",exp="x"@}
18311 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
18312 value=@{old="-268439212",new="55"@},
18313 frame=@{func="main",args=[],file="recursive2.c",
18314 fullname="/home/foo/bar/recursive2.c",line="5"@}
18318 Setting a watchpoint on a variable local to a function. @value{GDBN} will stop
18319 the program execution twice: first for the variable changing value, then
18320 for the watchpoint going out of scope.
18325 ^done,wpt=@{number="5",exp="C"@}
18330 *stopped,reason="watchpoint-trigger",
18331 wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
18332 frame=@{func="callee4",args=[],
18333 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18334 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
18339 *stopped,reason="watchpoint-scope",wpnum="5",
18340 frame=@{func="callee3",args=[@{name="strarg",
18341 value="0x11940 \"A string argument.\""@}],
18342 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18343 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
18347 Listing breakpoints and watchpoints, at different points in the program
18348 execution. Note that once the watchpoint goes out of scope, it is
18354 ^done,wpt=@{number="2",exp="C"@}
18357 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
18358 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18359 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18360 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18361 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18362 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18363 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18364 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
18365 addr="0x00010734",func="callee4",
18366 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18367 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",times="1"@},
18368 bkpt=@{number="2",type="watchpoint",disp="keep",
18369 enabled="y",addr="",what="C",times="0"@}]@}
18374 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
18375 value=@{old="-276895068",new="3"@},
18376 frame=@{func="callee4",args=[],
18377 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18378 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
18381 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
18382 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18383 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18384 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18385 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18386 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18387 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18388 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
18389 addr="0x00010734",func="callee4",
18390 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18391 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"@},
18392 bkpt=@{number="2",type="watchpoint",disp="keep",
18393 enabled="y",addr="",what="C",times="-5"@}]@}
18397 ^done,reason="watchpoint-scope",wpnum="2",
18398 frame=@{func="callee3",args=[@{name="strarg",
18399 value="0x11940 \"A string argument.\""@}],
18400 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18401 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
18404 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
18405 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
18406 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
18407 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
18408 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
18409 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
18410 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
18411 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
18412 addr="0x00010734",func="callee4",
18413 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18414 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
18419 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
18420 @node GDB/MI Program Context
18421 @section @sc{gdb/mi} Program Context
18423 @subheading The @code{-exec-arguments} Command
18424 @findex -exec-arguments
18427 @subsubheading Synopsis
18430 -exec-arguments @var{args}
18433 Set the inferior program arguments, to be used in the next
18436 @subsubheading @value{GDBN} Command
18438 The corresponding @value{GDBN} command is @samp{set args}.
18440 @subsubheading Example
18443 Don't have one around.
18446 @subheading The @code{-exec-show-arguments} Command
18447 @findex -exec-show-arguments
18449 @subsubheading Synopsis
18452 -exec-show-arguments
18455 Print the arguments of the program.
18457 @subsubheading @value{GDBN} Command
18459 The corresponding @value{GDBN} command is @samp{show args}.
18461 @subsubheading Example
18465 @subheading The @code{-environment-cd} Command
18466 @findex -environment-cd
18468 @subsubheading Synopsis
18471 -environment-cd @var{pathdir}
18474 Set @value{GDBN}'s working directory.
18476 @subsubheading @value{GDBN} Command
18478 The corresponding @value{GDBN} command is @samp{cd}.
18480 @subsubheading Example
18484 -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
18490 @subheading The @code{-environment-directory} Command
18491 @findex -environment-directory
18493 @subsubheading Synopsis
18496 -environment-directory [ -r ] [ @var{pathdir} ]+
18499 Add directories @var{pathdir} to beginning of search path for source files.
18500 If the @samp{-r} option is used, the search path is reset to the default
18501 search path. If directories @var{pathdir} are supplied in addition to the
18502 @samp{-r} option, the search path is first reset and then addition
18504 Multiple directories may be specified, separated by blanks. Specifying
18505 multiple directories in a single command
18506 results in the directories added to the beginning of the
18507 search path in the same order they were presented in the command.
18508 If blanks are needed as
18509 part of a directory name, double-quotes should be used around
18510 the name. In the command output, the path will show up separated
18511 by the system directory-separator character. The directory-separator
18512 character must not be used
18513 in any directory name.
18514 If no directories are specified, the current search path is displayed.
18516 @subsubheading @value{GDBN} Command
18518 The corresponding @value{GDBN} command is @samp{dir}.
18520 @subsubheading Example
18524 -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
18525 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
18527 -environment-directory ""
18528 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
18530 -environment-directory -r /home/jjohnstn/src/gdb /usr/src
18531 ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
18533 -environment-directory -r
18534 ^done,source-path="$cdir:$cwd"
18539 @subheading The @code{-environment-path} Command
18540 @findex -environment-path
18542 @subsubheading Synopsis
18545 -environment-path [ -r ] [ @var{pathdir} ]+
18548 Add directories @var{pathdir} to beginning of search path for object files.
18549 If the @samp{-r} option is used, the search path is reset to the original
18550 search path that existed at gdb start-up. If directories @var{pathdir} are
18551 supplied in addition to the
18552 @samp{-r} option, the search path is first reset and then addition
18554 Multiple directories may be specified, separated by blanks. Specifying
18555 multiple directories in a single command
18556 results in the directories added to the beginning of the
18557 search path in the same order they were presented in the command.
18558 If blanks are needed as
18559 part of a directory name, double-quotes should be used around
18560 the name. In the command output, the path will show up separated
18561 by the system directory-separator character. The directory-separator
18562 character must not be used
18563 in any directory name.
18564 If no directories are specified, the current path is displayed.
18567 @subsubheading @value{GDBN} Command
18569 The corresponding @value{GDBN} command is @samp{path}.
18571 @subsubheading Example
18576 ^done,path="/usr/bin"
18578 -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
18579 ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
18581 -environment-path -r /usr/local/bin
18582 ^done,path="/usr/local/bin:/usr/bin"
18587 @subheading The @code{-environment-pwd} Command
18588 @findex -environment-pwd
18590 @subsubheading Synopsis
18596 Show the current working directory.
18598 @subsubheading @value{GDBN} Command
18600 The corresponding @value{GDBN} command is @samp{pwd}.
18602 @subsubheading Example
18607 ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
18611 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
18612 @node GDB/MI Thread Commands
18613 @section @sc{gdb/mi} Thread Commands
18616 @subheading The @code{-thread-info} Command
18617 @findex -thread-info
18619 @subsubheading Synopsis
18625 @subsubheading @value{GDBN} Command
18629 @subsubheading Example
18633 @subheading The @code{-thread-list-all-threads} Command
18634 @findex -thread-list-all-threads
18636 @subsubheading Synopsis
18639 -thread-list-all-threads
18642 @subsubheading @value{GDBN} Command
18644 The equivalent @value{GDBN} command is @samp{info threads}.
18646 @subsubheading Example
18650 @subheading The @code{-thread-list-ids} Command
18651 @findex -thread-list-ids
18653 @subsubheading Synopsis
18659 Produces a list of the currently known @value{GDBN} thread ids. At the
18660 end of the list it also prints the total number of such threads.
18662 @subsubheading @value{GDBN} Command
18664 Part of @samp{info threads} supplies the same information.
18666 @subsubheading Example
18668 No threads present, besides the main process:
18673 ^done,thread-ids=@{@},number-of-threads="0"
18683 ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
18684 number-of-threads="3"
18689 @subheading The @code{-thread-select} Command
18690 @findex -thread-select
18692 @subsubheading Synopsis
18695 -thread-select @var{threadnum}
18698 Make @var{threadnum} the current thread. It prints the number of the new
18699 current thread, and the topmost frame for that thread.
18701 @subsubheading @value{GDBN} Command
18703 The corresponding @value{GDBN} command is @samp{thread}.
18705 @subsubheading Example
18712 *stopped,reason="end-stepping-range",thread-id="2",line="187",
18713 file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
18717 thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
18718 number-of-threads="3"
18721 ^done,new-thread-id="3",
18722 frame=@{level="0",func="vprintf",
18723 args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
18724 @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@}
18728 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
18729 @node GDB/MI Program Execution
18730 @section @sc{gdb/mi} Program Execution
18732 These are the asynchronous commands which generate the out-of-band
18733 record @samp{*stopped}. Currently @value{GDBN} only really executes
18734 asynchronously with remote targets and this interaction is mimicked in
18737 @subheading The @code{-exec-continue} Command
18738 @findex -exec-continue
18740 @subsubheading Synopsis
18746 Resumes the execution of the inferior program until a breakpoint is
18747 encountered, or until the inferior exits.
18749 @subsubheading @value{GDBN} Command
18751 The corresponding @value{GDBN} corresponding is @samp{continue}.
18753 @subsubheading Example
18760 *stopped,reason="breakpoint-hit",bkptno="2",frame=@{func="foo",args=[],
18761 file="hello.c",fullname="/home/foo/bar/hello.c",line="13"@}
18766 @subheading The @code{-exec-finish} Command
18767 @findex -exec-finish
18769 @subsubheading Synopsis
18775 Resumes the execution of the inferior program until the current
18776 function is exited. Displays the results returned by the function.
18778 @subsubheading @value{GDBN} Command
18780 The corresponding @value{GDBN} command is @samp{finish}.
18782 @subsubheading Example
18784 Function returning @code{void}.
18791 *stopped,reason="function-finished",frame=@{func="main",args=[],
18792 file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@}
18796 Function returning other than @code{void}. The name of the internal
18797 @value{GDBN} variable storing the result is printed, together with the
18804 *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
18805 args=[@{name="a",value="1"],@{name="b",value="9"@}@},
18806 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
18807 gdb-result-var="$1",return-value="0"
18812 @subheading The @code{-exec-interrupt} Command
18813 @findex -exec-interrupt
18815 @subsubheading Synopsis
18821 Interrupts the background execution of the target. Note how the token
18822 associated with the stop message is the one for the execution command
18823 that has been interrupted. The token for the interrupt itself only
18824 appears in the @samp{^done} output. If the user is trying to
18825 interrupt a non-running program, an error message will be printed.
18827 @subsubheading @value{GDBN} Command
18829 The corresponding @value{GDBN} command is @samp{interrupt}.
18831 @subsubheading Example
18842 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
18843 frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
18844 fullname="/home/foo/bar/try.c",line="13"@}
18849 ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
18854 @subheading The @code{-exec-next} Command
18857 @subsubheading Synopsis
18863 Resumes execution of the inferior program, stopping when the beginning
18864 of the next source line is reached.
18866 @subsubheading @value{GDBN} Command
18868 The corresponding @value{GDBN} command is @samp{next}.
18870 @subsubheading Example
18876 *stopped,reason="end-stepping-range",line="8",file="hello.c"
18881 @subheading The @code{-exec-next-instruction} Command
18882 @findex -exec-next-instruction
18884 @subsubheading Synopsis
18887 -exec-next-instruction
18890 Executes one machine instruction. If the instruction is a function
18891 call, continues until the function returns. If the program stops at an
18892 instruction in the middle of a source line, the address will be
18895 @subsubheading @value{GDBN} Command
18897 The corresponding @value{GDBN} command is @samp{nexti}.
18899 @subsubheading Example
18903 -exec-next-instruction
18907 *stopped,reason="end-stepping-range",
18908 addr="0x000100d4",line="5",file="hello.c"
18913 @subheading The @code{-exec-return} Command
18914 @findex -exec-return
18916 @subsubheading Synopsis
18922 Makes current function return immediately. Doesn't execute the inferior.
18923 Displays the new current frame.
18925 @subsubheading @value{GDBN} Command
18927 The corresponding @value{GDBN} command is @samp{return}.
18929 @subsubheading Example
18933 200-break-insert callee4
18934 200^done,bkpt=@{number="1",addr="0x00010734",
18935 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
18940 000*stopped,reason="breakpoint-hit",bkptno="1",
18941 frame=@{func="callee4",args=[],
18942 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18943 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
18949 111^done,frame=@{level="0",func="callee3",
18950 args=[@{name="strarg",
18951 value="0x11940 \"A string argument.\""@}],
18952 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
18953 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
18958 @subheading The @code{-exec-run} Command
18961 @subsubheading Synopsis
18967 Starts execution of the inferior from the beginning. The inferior
18968 executes until either a breakpoint is encountered or the program
18969 exits. In the latter case the output will include an exit code, if
18970 the program has exited exceptionally.
18972 @subsubheading @value{GDBN} Command
18974 The corresponding @value{GDBN} command is @samp{run}.
18976 @subsubheading Examples
18981 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
18986 *stopped,reason="breakpoint-hit",bkptno="1",
18987 frame=@{func="main",args=[],file="recursive2.c",
18988 fullname="/home/foo/bar/recursive2.c",line="4"@}
18993 Program exited normally:
19001 *stopped,reason="exited-normally"
19006 Program exited exceptionally:
19014 *stopped,reason="exited",exit-code="01"
19018 Another way the program can terminate is if it receives a signal such as
19019 @code{SIGINT}. In this case, @sc{gdb/mi} displays this:
19023 *stopped,reason="exited-signalled",signal-name="SIGINT",
19024 signal-meaning="Interrupt"
19028 @c @subheading -exec-signal
19031 @subheading The @code{-exec-step} Command
19034 @subsubheading Synopsis
19040 Resumes execution of the inferior program, stopping when the beginning
19041 of the next source line is reached, if the next source line is not a
19042 function call. If it is, stop at the first instruction of the called
19045 @subsubheading @value{GDBN} Command
19047 The corresponding @value{GDBN} command is @samp{step}.
19049 @subsubheading Example
19051 Stepping into a function:
19057 *stopped,reason="end-stepping-range",
19058 frame=@{func="foo",args=[@{name="a",value="10"@},
19059 @{name="b",value="0"@}],file="recursive2.c",
19060 fullname="/home/foo/bar/recursive2.c",line="11"@}
19070 *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
19075 @subheading The @code{-exec-step-instruction} Command
19076 @findex -exec-step-instruction
19078 @subsubheading Synopsis
19081 -exec-step-instruction
19084 Resumes the inferior which executes one machine instruction. The
19085 output, once @value{GDBN} has stopped, will vary depending on whether
19086 we have stopped in the middle of a source line or not. In the former
19087 case, the address at which the program stopped will be printed as
19090 @subsubheading @value{GDBN} Command
19092 The corresponding @value{GDBN} command is @samp{stepi}.
19094 @subsubheading Example
19098 -exec-step-instruction
19102 *stopped,reason="end-stepping-range",
19103 frame=@{func="foo",args=[],file="try.c",
19104 fullname="/home/foo/bar/try.c",line="10"@}
19106 -exec-step-instruction
19110 *stopped,reason="end-stepping-range",
19111 frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
19112 fullname="/home/foo/bar/try.c",line="10"@}
19117 @subheading The @code{-exec-until} Command
19118 @findex -exec-until
19120 @subsubheading Synopsis
19123 -exec-until [ @var{location} ]
19126 Executes the inferior until the @var{location} specified in the
19127 argument is reached. If there is no argument, the inferior executes
19128 until a source line greater than the current one is reached. The
19129 reason for stopping in this case will be @samp{location-reached}.
19131 @subsubheading @value{GDBN} Command
19133 The corresponding @value{GDBN} command is @samp{until}.
19135 @subsubheading Example
19139 -exec-until recursive2.c:6
19143 *stopped,reason="location-reached",frame=@{func="main",args=[],
19144 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@}
19149 @subheading -file-clear
19150 Is this going away????
19153 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
19154 @node GDB/MI Stack Manipulation
19155 @section @sc{gdb/mi} Stack Manipulation Commands
19158 @subheading The @code{-stack-info-frame} Command
19159 @findex -stack-info-frame
19161 @subsubheading Synopsis
19167 Get info on the selected frame.
19169 @subsubheading @value{GDBN} Command
19171 The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame}
19172 (without arguments).
19174 @subsubheading Example
19179 ^done,frame=@{level="1",addr="0x0001076c",func="callee3",
19180 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19181 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}
19185 @subheading The @code{-stack-info-depth} Command
19186 @findex -stack-info-depth
19188 @subsubheading Synopsis
19191 -stack-info-depth [ @var{max-depth} ]
19194 Return the depth of the stack. If the integer argument @var{max-depth}
19195 is specified, do not count beyond @var{max-depth} frames.
19197 @subsubheading @value{GDBN} Command
19199 There's no equivalent @value{GDBN} command.
19201 @subsubheading Example
19203 For a stack with frame levels 0 through 11:
19210 -stack-info-depth 4
19213 -stack-info-depth 12
19216 -stack-info-depth 11
19219 -stack-info-depth 13
19224 @subheading The @code{-stack-list-arguments} Command
19225 @findex -stack-list-arguments
19227 @subsubheading Synopsis
19230 -stack-list-arguments @var{show-values}
19231 [ @var{low-frame} @var{high-frame} ]
19234 Display a list of the arguments for the frames between @var{low-frame}
19235 and @var{high-frame} (inclusive). If @var{low-frame} and
19236 @var{high-frame} are not provided, list the arguments for the whole
19237 call stack. If the two arguments are equal, show the single frame
19238 at the corresponding level. It is an error if @var{low-frame} is
19239 larger than the actual number of frames. On the other hand,
19240 @var{high-frame} may be larger than the actual number of frames, in
19241 which case only existing frames will be returned.
19243 The @var{show-values} argument must have a value of 0 or 1. A value of
19244 0 means that only the names of the arguments are listed, a value of 1
19245 means that both names and values of the arguments are printed.
19247 @subsubheading @value{GDBN} Command
19249 @value{GDBN} does not have an equivalent command. @code{gdbtk} has a
19250 @samp{gdb_get_args} command which partially overlaps with the
19251 functionality of @samp{-stack-list-arguments}.
19253 @subsubheading Example
19260 frame=@{level="0",addr="0x00010734",func="callee4",
19261 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19262 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@},
19263 frame=@{level="1",addr="0x0001076c",func="callee3",
19264 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19265 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@},
19266 frame=@{level="2",addr="0x0001078c",func="callee2",
19267 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19268 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@},
19269 frame=@{level="3",addr="0x000107b4",func="callee1",
19270 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19271 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@},
19272 frame=@{level="4",addr="0x000107e0",func="main",
19273 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
19274 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}]
19276 -stack-list-arguments 0
19279 frame=@{level="0",args=[]@},
19280 frame=@{level="1",args=[name="strarg"]@},
19281 frame=@{level="2",args=[name="intarg",name="strarg"]@},
19282 frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
19283 frame=@{level="4",args=[]@}]
19285 -stack-list-arguments 1
19288 frame=@{level="0",args=[]@},
19290 args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@},
19291 frame=@{level="2",args=[
19292 @{name="intarg",value="2"@},
19293 @{name="strarg",value="0x11940 \"A string argument.\""@}]@},
19294 @{frame=@{level="3",args=[
19295 @{name="intarg",value="2"@},
19296 @{name="strarg",value="0x11940 \"A string argument.\""@},
19297 @{name="fltarg",value="3.5"@}]@},
19298 frame=@{level="4",args=[]@}]
19300 -stack-list-arguments 0 2 2
19301 ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
19303 -stack-list-arguments 1 2 2
19304 ^done,stack-args=[frame=@{level="2",
19305 args=[@{name="intarg",value="2"@},
19306 @{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
19310 @c @subheading -stack-list-exception-handlers
19313 @subheading The @code{-stack-list-frames} Command
19314 @findex -stack-list-frames
19316 @subsubheading Synopsis
19319 -stack-list-frames [ @var{low-frame} @var{high-frame} ]
19322 List the frames currently on the stack. For each frame it displays the
19327 The frame number, 0 being the topmost frame, i.e., the innermost function.
19329 The @code{$pc} value for that frame.
19333 File name of the source file where the function lives.
19335 Line number corresponding to the @code{$pc}.
19338 If invoked without arguments, this command prints a backtrace for the
19339 whole stack. If given two integer arguments, it shows the frames whose
19340 levels are between the two arguments (inclusive). If the two arguments
19341 are equal, it shows the single frame at the corresponding level. It is
19342 an error if @var{low-frame} is larger than the actual number of
19343 frames. On the other hand, @var{high-frame} may be larger than the
19344 actual number of frames, in which case only existing frames will be returned.
19346 @subsubheading @value{GDBN} Command
19348 The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}.
19350 @subsubheading Example
19352 Full stack backtrace:
19358 [frame=@{level="0",addr="0x0001076c",func="foo",
19359 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@},
19360 frame=@{level="1",addr="0x000107a4",func="foo",
19361 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19362 frame=@{level="2",addr="0x000107a4",func="foo",
19363 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19364 frame=@{level="3",addr="0x000107a4",func="foo",
19365 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19366 frame=@{level="4",addr="0x000107a4",func="foo",
19367 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19368 frame=@{level="5",addr="0x000107a4",func="foo",
19369 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19370 frame=@{level="6",addr="0x000107a4",func="foo",
19371 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19372 frame=@{level="7",addr="0x000107a4",func="foo",
19373 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19374 frame=@{level="8",addr="0x000107a4",func="foo",
19375 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19376 frame=@{level="9",addr="0x000107a4",func="foo",
19377 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19378 frame=@{level="10",addr="0x000107a4",func="foo",
19379 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19380 frame=@{level="11",addr="0x00010738",func="main",
19381 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}]
19385 Show frames between @var{low_frame} and @var{high_frame}:
19389 -stack-list-frames 3 5
19391 [frame=@{level="3",addr="0x000107a4",func="foo",
19392 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19393 frame=@{level="4",addr="0x000107a4",func="foo",
19394 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
19395 frame=@{level="5",addr="0x000107a4",func="foo",
19396 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
19400 Show a single frame:
19404 -stack-list-frames 3 3
19406 [frame=@{level="3",addr="0x000107a4",func="foo",
19407 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
19412 @subheading The @code{-stack-list-locals} Command
19413 @findex -stack-list-locals
19415 @subsubheading Synopsis
19418 -stack-list-locals @var{print-values}
19421 Display the local variable names for the selected frame. If
19422 @var{print-values} is 0 or @code{--no-values}, print only the names of
19423 the variables; if it is 1 or @code{--all-values}, print also their
19424 values; and if it is 2 or @code{--simple-values}, print the name,
19425 type and value for simple data types and the name and type for arrays,
19426 structures and unions. In this last case, a frontend can immediately
19427 display the value of simple data types and create variable objects for
19428 other data types when the user wishes to explore their values in
19431 @subsubheading @value{GDBN} Command
19433 @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}.
19435 @subsubheading Example
19439 -stack-list-locals 0
19440 ^done,locals=[name="A",name="B",name="C"]
19442 -stack-list-locals --all-values
19443 ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
19444 @{name="C",value="@{1, 2, 3@}"@}]
19445 -stack-list-locals --simple-values
19446 ^done,locals=[@{name="A",type="int",value="1"@},
19447 @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
19452 @subheading The @code{-stack-select-frame} Command
19453 @findex -stack-select-frame
19455 @subsubheading Synopsis
19458 -stack-select-frame @var{framenum}
19461 Change the selected frame. Select a different frame @var{framenum} on
19464 @subsubheading @value{GDBN} Command
19466 The corresponding @value{GDBN} commands are @samp{frame}, @samp{up},
19467 @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}.
19469 @subsubheading Example
19473 -stack-select-frame 2
19478 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
19479 @node GDB/MI Variable Objects
19480 @section @sc{gdb/mi} Variable Objects
19484 @subheading Motivation for Variable Objects in @sc{gdb/mi}
19486 For the implementation of a variable debugger window (locals, watched
19487 expressions, etc.), we are proposing the adaptation of the existing code
19488 used by @code{Insight}.
19490 The two main reasons for that are:
19494 It has been proven in practice (it is already on its second generation).
19497 It will shorten development time (needless to say how important it is
19501 The original interface was designed to be used by Tcl code, so it was
19502 slightly changed so it could be used through @sc{gdb/mi}. This section
19503 describes the @sc{gdb/mi} operations that will be available and gives some
19504 hints about their use.
19506 @emph{Note}: In addition to the set of operations described here, we
19507 expect the @sc{gui} implementation of a variable window to require, at
19508 least, the following operations:
19511 @item @code{-gdb-show} @code{output-radix}
19512 @item @code{-stack-list-arguments}
19513 @item @code{-stack-list-locals}
19514 @item @code{-stack-select-frame}
19519 @subheading Introduction to Variable Objects
19521 @cindex variable objects in @sc{gdb/mi}
19523 Variable objects are "object-oriented" MI interface for examining and
19524 changing values of expressions. Unlike some other MI interfaces that
19525 work with expressions, variable objects are specifically designed for
19526 simple and efficient presentation in the frontend. A variable object
19527 is identified by string name. When a variable object is created, the
19528 frontend specifies the expression for that variable object. The
19529 expression can be a simple variable, or it can be an arbitrary complex
19530 expression, and can even involve CPU registers. After creating a
19531 variable object, the frontend can invoke other variable object
19532 operations---for example to obtain or change the value of a variable
19533 object, or to change display format.
19535 Variable objects have hierarchical tree structure. Any variable object
19536 that corresponds to a composite type, such as structure in C, has
19537 a number of child variable objects, for example corresponding to each
19538 element of a structure. A child variable object can itself have
19539 children, recursively. Recursion ends when we reach
19540 leaf variable objects, which always have built-in types. Child variable
19541 objects are created only by explicit request, so if a frontend
19542 is not interested in the children of a particular variable object, no
19543 child will be created.
19545 For a leaf variable object it is possible to obtain its value as a
19546 string, or set the value from a string. String value can be also
19547 obtained for a non-leaf variable object, but it's generally a string
19548 that only indicates the type of the object, and does not list its
19549 contents. Assignment to a non-leaf variable object is not allowed.
19551 A frontend does not need to read the values of all variable objects each time
19552 the program stops. Instead, MI provides an update command that lists all
19553 variable objects whose values has changed since the last update
19554 operation. This considerably reduces the amount of data that must
19555 be transferred to the frontend. As noted above, children variable
19556 objects are created on demand, and only leaf variable objects have a
19557 real value. As result, gdb will read target memory only for leaf
19558 variables that frontend has created.
19560 The automatic update is not always desirable. For example, a frontend
19561 might want to keep a value of some expression for future reference,
19562 and never update it. For another example, fetching memory is
19563 relatively slow for embedded targets, so a frontend might want
19564 to disable automatic update for the variables that are either not
19565 visible on the screen, or ``closed''. This is possible using so
19566 called ``frozen variable objects''. Such variable objects are never
19567 implicitly updated.
19569 The following is the complete set of @sc{gdb/mi} operations defined to
19570 access this functionality:
19572 @multitable @columnfractions .4 .6
19573 @item @strong{Operation}
19574 @tab @strong{Description}
19576 @item @code{-var-create}
19577 @tab create a variable object
19578 @item @code{-var-delete}
19579 @tab delete the variable object and/or its children
19580 @item @code{-var-set-format}
19581 @tab set the display format of this variable
19582 @item @code{-var-show-format}
19583 @tab show the display format of this variable
19584 @item @code{-var-info-num-children}
19585 @tab tells how many children this object has
19586 @item @code{-var-list-children}
19587 @tab return a list of the object's children
19588 @item @code{-var-info-type}
19589 @tab show the type of this variable object
19590 @item @code{-var-info-expression}
19591 @tab print parent-relative expression that this variable object represents
19592 @item @code{-var-info-path-expression}
19593 @tab print full expression that this variable object represents
19594 @item @code{-var-show-attributes}
19595 @tab is this variable editable? does it exist here?
19596 @item @code{-var-evaluate-expression}
19597 @tab get the value of this variable
19598 @item @code{-var-assign}
19599 @tab set the value of this variable
19600 @item @code{-var-update}
19601 @tab update the variable and its children
19602 @item @code{-var-set-frozen}
19603 @tab set frozeness attribute
19606 In the next subsection we describe each operation in detail and suggest
19607 how it can be used.
19609 @subheading Description And Use of Operations on Variable Objects
19611 @subheading The @code{-var-create} Command
19612 @findex -var-create
19614 @subsubheading Synopsis
19617 -var-create @{@var{name} | "-"@}
19618 @{@var{frame-addr} | "*"@} @var{expression}
19621 This operation creates a variable object, which allows the monitoring of
19622 a variable, the result of an expression, a memory cell or a CPU
19625 The @var{name} parameter is the string by which the object can be
19626 referenced. It must be unique. If @samp{-} is specified, the varobj
19627 system will generate a string ``varNNNNNN'' automatically. It will be
19628 unique provided that one does not specify @var{name} on that format.
19629 The command fails if a duplicate name is found.
19631 The frame under which the expression should be evaluated can be
19632 specified by @var{frame-addr}. A @samp{*} indicates that the current
19633 frame should be used.
19635 @var{expression} is any expression valid on the current language set (must not
19636 begin with a @samp{*}), or one of the following:
19640 @samp{*@var{addr}}, where @var{addr} is the address of a memory cell
19643 @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
19646 @samp{$@var{regname}} --- a CPU register name
19649 @subsubheading Result
19651 This operation returns the name, number of children and the type of the
19652 object created. Type is returned as a string as the ones generated by
19653 the @value{GDBN} CLI:
19656 name="@var{name}",numchild="N",type="@var{type}"
19660 @subheading The @code{-var-delete} Command
19661 @findex -var-delete
19663 @subsubheading Synopsis
19666 -var-delete [ -c ] @var{name}
19669 Deletes a previously created variable object and all of its children.
19670 With the @samp{-c} option, just deletes the children.
19672 Returns an error if the object @var{name} is not found.
19675 @subheading The @code{-var-set-format} Command
19676 @findex -var-set-format
19678 @subsubheading Synopsis
19681 -var-set-format @var{name} @var{format-spec}
19684 Sets the output format for the value of the object @var{name} to be
19687 The syntax for the @var{format-spec} is as follows:
19690 @var{format-spec} @expansion{}
19691 @{binary | decimal | hexadecimal | octal | natural@}
19694 The natural format is the default format choosen automatically
19695 based on the variable type (like decimal for an @code{int}, hex
19696 for pointers, etc.).
19698 For a variable with children, the format is set only on the
19699 variable itself, and the children are not affected.
19701 @subheading The @code{-var-show-format} Command
19702 @findex -var-show-format
19704 @subsubheading Synopsis
19707 -var-show-format @var{name}
19710 Returns the format used to display the value of the object @var{name}.
19713 @var{format} @expansion{}
19718 @subheading The @code{-var-info-num-children} Command
19719 @findex -var-info-num-children
19721 @subsubheading Synopsis
19724 -var-info-num-children @var{name}
19727 Returns the number of children of a variable object @var{name}:
19734 @subheading The @code{-var-list-children} Command
19735 @findex -var-list-children
19737 @subsubheading Synopsis
19740 -var-list-children [@var{print-values}] @var{name}
19742 @anchor{-var-list-children}
19744 Return a list of the children of the specified variable object and
19745 create variable objects for them, if they do not already exist. With
19746 a single argument or if @var{print-values} has a value for of 0 or
19747 @code{--no-values}, print only the names of the variables; if
19748 @var{print-values} is 1 or @code{--all-values}, also print their
19749 values; and if it is 2 or @code{--simple-values} print the name and
19750 value for simple data types and just the name for arrays, structures
19753 @subsubheading Example
19757 -var-list-children n
19758 ^done,numchild=@var{n},children=[@{name=@var{name},
19759 numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
19761 -var-list-children --all-values n
19762 ^done,numchild=@var{n},children=[@{name=@var{name},
19763 numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
19767 @subheading The @code{-var-info-type} Command
19768 @findex -var-info-type
19770 @subsubheading Synopsis
19773 -var-info-type @var{name}
19776 Returns the type of the specified variable @var{name}. The type is
19777 returned as a string in the same format as it is output by the
19781 type=@var{typename}
19785 @subheading The @code{-var-info-expression} Command
19786 @findex -var-info-expression
19788 @subsubheading Synopsis
19791 -var-info-expression @var{name}
19794 Returns a string that is suitable for presenting this
19795 variable object in user interface. The string is generally
19796 not valid expression in the current language, and cannot be evaluated.
19798 For example, if @code{a} is an array, and variable object
19799 @code{A} was created for @code{a}, then we'll get this output:
19802 (gdb) -var-info-expression A.1
19803 ^done,lang="C",exp="1"
19807 Here, the values of @code{lang} can be @code{@{"C" | "C++" | "Java"@}}.
19809 Note that the output of the @code{-var-list-children} command also
19810 includes those expressions, so the @code{-var-info-expression} command
19813 @subheading The @code{-var-info-path-expression} Command
19814 @findex -var-info-path-expression
19816 @subsubheading Synopsis
19819 -var-info-path-expression @var{name}
19822 Returns an expression that can be evaluated in the current
19823 context and will yield the same value that a variable object has.
19824 Compare this with the @code{-var-info-expression} command, which
19825 result can be used only for UI presentation. Typical use of
19826 the @code{-var-info-path-expression} command is creating a
19827 watchpoint from a variable object.
19829 For example, suppose @code{C} is a C@t{++} class, derived from class
19830 @code{Base}, and that the @code{Base} class has a member called
19831 @code{m_size}. Assume a variable @code{c} is has the type of
19832 @code{C} and a variable object @code{C} was created for variable
19833 @code{c}. Then, we'll get this output:
19835 (gdb) -var-info-path-expression C.Base.public.m_size
19836 ^done,path_expr=((Base)c).m_size)
19839 @subheading The @code{-var-show-attributes} Command
19840 @findex -var-show-attributes
19842 @subsubheading Synopsis
19845 -var-show-attributes @var{name}
19848 List attributes of the specified variable object @var{name}:
19851 status=@var{attr} [ ( ,@var{attr} )* ]
19855 where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}.
19857 @subheading The @code{-var-evaluate-expression} Command
19858 @findex -var-evaluate-expression
19860 @subsubheading Synopsis
19863 -var-evaluate-expression @var{name}
19866 Evaluates the expression that is represented by the specified variable
19867 object and returns its value as a string. The format of the
19868 string can be changed using the @code{-var-set-format} command.
19874 Note that one must invoke @code{-var-list-children} for a variable
19875 before the value of a child variable can be evaluated.
19877 @subheading The @code{-var-assign} Command
19878 @findex -var-assign
19880 @subsubheading Synopsis
19883 -var-assign @var{name} @var{expression}
19886 Assigns the value of @var{expression} to the variable object specified
19887 by @var{name}. The object must be @samp{editable}. If the variable's
19888 value is altered by the assign, the variable will show up in any
19889 subsequent @code{-var-update} list.
19891 @subsubheading Example
19899 ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
19903 @subheading The @code{-var-update} Command
19904 @findex -var-update
19906 @subsubheading Synopsis
19909 -var-update [@var{print-values}] @{@var{name} | "*"@}
19912 Reevaluate the expressions corresponding to the variable object
19913 @var{name} and all its direct and indirect children, and return the
19914 list of variable objects whose values have changed; @var{name} must
19915 be a root variable object. Here, ``changed'' means that the result of
19916 @code{-var-evaluate-expression} before and after the
19917 @code{-var-update} is different. If @samp{*} is used as the variable
19918 object names, all existing variable objects are updated, except
19919 for frozen ones (@pxref{-var-set-frozen}). The option
19920 @var{print-values} determines whether both names and values, or just
19921 names are printed. The possible values of this options are the same
19922 as for @code{-var-list-children} (@pxref{-var-list-children}). It is
19923 recommended to use the @samp{--all-values} option, to reduce the
19924 number of MI commands needed on each program stop.
19927 @subsubheading Example
19934 -var-update --all-values var1
19935 ^done,changelist=[@{name="var1",value="3",in_scope="true",
19936 type_changed="false"@}]
19940 @anchor{-var-update}
19941 The field in_scope may take three values:
19945 The variable object's current value is valid.
19948 The variable object does not currently hold a valid value but it may
19949 hold one in the future if its associated expression comes back into
19953 The variable object no longer holds a valid value.
19954 This can occur when the executable file being debugged has changed,
19955 either through recompilation or by using the @value{GDBN} @code{file}
19956 command. The front end should normally choose to delete these variable
19960 In the future new values may be added to this list so the front should
19961 be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}.
19963 @subheading The @code{-var-set-frozen} Command
19964 @findex -var-set-frozen
19965 @anchor{-var-set-frozen}
19967 @subsubheading Synopsis
19970 -var-set-frozen @var{name} @var{flag}
19973 Set the frozenness flag on the variable object @var{name}. The
19974 @var{flag} parameter should be either @samp{1} to make the variable
19975 frozen or @samp{0} to make it unfrozen. If a variable object is
19976 frozen, then neither itself, nor any of its children, are
19977 implicitly updated by @code{-var-update} of
19978 a parent variable or by @code{-var-update *}. Only
19979 @code{-var-update} of the variable itself will update its value and
19980 values of its children. After a variable object is unfrozen, it is
19981 implicitly updated by all subsequent @code{-var-update} operations.
19982 Unfreezing a variable does not update it, only subsequent
19983 @code{-var-update} does.
19985 @subsubheading Example
19989 -var-set-frozen V 1
19995 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
19996 @node GDB/MI Data Manipulation
19997 @section @sc{gdb/mi} Data Manipulation
19999 @cindex data manipulation, in @sc{gdb/mi}
20000 @cindex @sc{gdb/mi}, data manipulation
20001 This section describes the @sc{gdb/mi} commands that manipulate data:
20002 examine memory and registers, evaluate expressions, etc.
20004 @c REMOVED FROM THE INTERFACE.
20005 @c @subheading -data-assign
20006 @c Change the value of a program variable. Plenty of side effects.
20007 @c @subsubheading GDB Command
20009 @c @subsubheading Example
20012 @subheading The @code{-data-disassemble} Command
20013 @findex -data-disassemble
20015 @subsubheading Synopsis
20019 [ -s @var{start-addr} -e @var{end-addr} ]
20020 | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
20028 @item @var{start-addr}
20029 is the beginning address (or @code{$pc})
20030 @item @var{end-addr}
20032 @item @var{filename}
20033 is the name of the file to disassemble
20034 @item @var{linenum}
20035 is the line number to disassemble around
20037 is the number of disassembly lines to be produced. If it is -1,
20038 the whole function will be disassembled, in case no @var{end-addr} is
20039 specified. If @var{end-addr} is specified as a non-zero value, and
20040 @var{lines} is lower than the number of disassembly lines between
20041 @var{start-addr} and @var{end-addr}, only @var{lines} lines are
20042 displayed; if @var{lines} is higher than the number of lines between
20043 @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
20046 is either 0 (meaning only disassembly) or 1 (meaning mixed source and
20050 @subsubheading Result
20052 The output for each instruction is composed of four fields:
20061 Note that whatever included in the instruction field, is not manipulated
20062 directly by @sc{gdb/mi}, i.e., it is not possible to adjust its format.
20064 @subsubheading @value{GDBN} Command
20066 There's no direct mapping from this command to the CLI.
20068 @subsubheading Example
20070 Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
20074 -data-disassemble -s $pc -e "$pc + 20" -- 0
20077 @{address="0x000107c0",func-name="main",offset="4",
20078 inst="mov 2, %o0"@},
20079 @{address="0x000107c4",func-name="main",offset="8",
20080 inst="sethi %hi(0x11800), %o2"@},
20081 @{address="0x000107c8",func-name="main",offset="12",
20082 inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@},
20083 @{address="0x000107cc",func-name="main",offset="16",
20084 inst="sethi %hi(0x11800), %o2"@},
20085 @{address="0x000107d0",func-name="main",offset="20",
20086 inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
20090 Disassemble the whole @code{main} function. Line 32 is part of
20094 -data-disassemble -f basics.c -l 32 -- 0
20096 @{address="0x000107bc",func-name="main",offset="0",
20097 inst="save %sp, -112, %sp"@},
20098 @{address="0x000107c0",func-name="main",offset="4",
20099 inst="mov 2, %o0"@},
20100 @{address="0x000107c4",func-name="main",offset="8",
20101 inst="sethi %hi(0x11800), %o2"@},
20103 @{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
20104 @{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
20108 Disassemble 3 instructions from the start of @code{main}:
20112 -data-disassemble -f basics.c -l 32 -n 3 -- 0
20114 @{address="0x000107bc",func-name="main",offset="0",
20115 inst="save %sp, -112, %sp"@},
20116 @{address="0x000107c0",func-name="main",offset="4",
20117 inst="mov 2, %o0"@},
20118 @{address="0x000107c4",func-name="main",offset="8",
20119 inst="sethi %hi(0x11800), %o2"@}]
20123 Disassemble 3 instructions from the start of @code{main} in mixed mode:
20127 -data-disassemble -f basics.c -l 32 -n 3 -- 1
20129 src_and_asm_line=@{line="31",
20130 file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \
20131 testsuite/gdb.mi/basics.c",line_asm_insn=[
20132 @{address="0x000107bc",func-name="main",offset="0",
20133 inst="save %sp, -112, %sp"@}]@},
20134 src_and_asm_line=@{line="32",
20135 file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \
20136 testsuite/gdb.mi/basics.c",line_asm_insn=[
20137 @{address="0x000107c0",func-name="main",offset="4",
20138 inst="mov 2, %o0"@},
20139 @{address="0x000107c4",func-name="main",offset="8",
20140 inst="sethi %hi(0x11800), %o2"@}]@}]
20145 @subheading The @code{-data-evaluate-expression} Command
20146 @findex -data-evaluate-expression
20148 @subsubheading Synopsis
20151 -data-evaluate-expression @var{expr}
20154 Evaluate @var{expr} as an expression. The expression could contain an
20155 inferior function call. The function call will execute synchronously.
20156 If the expression contains spaces, it must be enclosed in double quotes.
20158 @subsubheading @value{GDBN} Command
20160 The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and
20161 @samp{call}. In @code{gdbtk} only, there's a corresponding
20162 @samp{gdb_eval} command.
20164 @subsubheading Example
20166 In the following example, the numbers that precede the commands are the
20167 @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi}
20168 Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its
20172 211-data-evaluate-expression A
20175 311-data-evaluate-expression &A
20176 311^done,value="0xefffeb7c"
20178 411-data-evaluate-expression A+3
20181 511-data-evaluate-expression "A + 3"
20187 @subheading The @code{-data-list-changed-registers} Command
20188 @findex -data-list-changed-registers
20190 @subsubheading Synopsis
20193 -data-list-changed-registers
20196 Display a list of the registers that have changed.
20198 @subsubheading @value{GDBN} Command
20200 @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk}
20201 has the corresponding command @samp{gdb_changed_register_list}.
20203 @subsubheading Example
20205 On a PPC MBX board:
20213 *stopped,reason="breakpoint-hit",bkptno="1",frame=@{func="main",
20214 args=[],file="try.c",fullname="/home/foo/bar/try.c",line="5"@}
20216 -data-list-changed-registers
20217 ^done,changed-registers=["0","1","2","4","5","6","7","8","9",
20218 "10","11","13","14","15","16","17","18","19","20","21","22","23",
20219 "24","25","26","27","28","30","31","64","65","66","67","69"]
20224 @subheading The @code{-data-list-register-names} Command
20225 @findex -data-list-register-names
20227 @subsubheading Synopsis
20230 -data-list-register-names [ ( @var{regno} )+ ]
20233 Show a list of register names for the current target. If no arguments
20234 are given, it shows a list of the names of all the registers. If
20235 integer numbers are given as arguments, it will print a list of the
20236 names of the registers corresponding to the arguments. To ensure
20237 consistency between a register name and its number, the output list may
20238 include empty register names.
20240 @subsubheading @value{GDBN} Command
20242 @value{GDBN} does not have a command which corresponds to
20243 @samp{-data-list-register-names}. In @code{gdbtk} there is a
20244 corresponding command @samp{gdb_regnames}.
20246 @subsubheading Example
20248 For the PPC MBX board:
20251 -data-list-register-names
20252 ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
20253 "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
20254 "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
20255 "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
20256 "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
20257 "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
20258 "", "pc","ps","cr","lr","ctr","xer"]
20260 -data-list-register-names 1 2 3
20261 ^done,register-names=["r1","r2","r3"]
20265 @subheading The @code{-data-list-register-values} Command
20266 @findex -data-list-register-values
20268 @subsubheading Synopsis
20271 -data-list-register-values @var{fmt} [ ( @var{regno} )*]
20274 Display the registers' contents. @var{fmt} is the format according to
20275 which the registers' contents are to be returned, followed by an optional
20276 list of numbers specifying the registers to display. A missing list of
20277 numbers indicates that the contents of all the registers must be returned.
20279 Allowed formats for @var{fmt} are:
20296 @subsubheading @value{GDBN} Command
20298 The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info
20299 all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}.
20301 @subsubheading Example
20303 For a PPC MBX board (note: line breaks are for readability only, they
20304 don't appear in the actual output):
20308 -data-list-register-values r 64 65
20309 ^done,register-values=[@{number="64",value="0xfe00a300"@},
20310 @{number="65",value="0x00029002"@}]
20312 -data-list-register-values x
20313 ^done,register-values=[@{number="0",value="0xfe0043c8"@},
20314 @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
20315 @{number="3",value="0x0"@},@{number="4",value="0xa"@},
20316 @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@},
20317 @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@},
20318 @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@},
20319 @{number="11",value="0x1"@},@{number="12",value="0x0"@},
20320 @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@},
20321 @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@},
20322 @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@},
20323 @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@},
20324 @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@},
20325 @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@},
20326 @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@},
20327 @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@},
20328 @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@},
20329 @{number="31",value="0x0"@},@{number="32",value="0x0"@},
20330 @{number="33",value="0x0"@},@{number="34",value="0x0"@},
20331 @{number="35",value="0x0"@},@{number="36",value="0x0"@},
20332 @{number="37",value="0x0"@},@{number="38",value="0x0"@},
20333 @{number="39",value="0x0"@},@{number="40",value="0x0"@},
20334 @{number="41",value="0x0"@},@{number="42",value="0x0"@},
20335 @{number="43",value="0x0"@},@{number="44",value="0x0"@},
20336 @{number="45",value="0x0"@},@{number="46",value="0x0"@},
20337 @{number="47",value="0x0"@},@{number="48",value="0x0"@},
20338 @{number="49",value="0x0"@},@{number="50",value="0x0"@},
20339 @{number="51",value="0x0"@},@{number="52",value="0x0"@},
20340 @{number="53",value="0x0"@},@{number="54",value="0x0"@},
20341 @{number="55",value="0x0"@},@{number="56",value="0x0"@},
20342 @{number="57",value="0x0"@},@{number="58",value="0x0"@},
20343 @{number="59",value="0x0"@},@{number="60",value="0x0"@},
20344 @{number="61",value="0x0"@},@{number="62",value="0x0"@},
20345 @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@},
20346 @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
20347 @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
20348 @{number="69",value="0x20002b03"@}]
20353 @subheading The @code{-data-read-memory} Command
20354 @findex -data-read-memory
20356 @subsubheading Synopsis
20359 -data-read-memory [ -o @var{byte-offset} ]
20360 @var{address} @var{word-format} @var{word-size}
20361 @var{nr-rows} @var{nr-cols} [ @var{aschar} ]
20368 @item @var{address}
20369 An expression specifying the address of the first memory word to be
20370 read. Complex expressions containing embedded white space should be
20371 quoted using the C convention.
20373 @item @var{word-format}
20374 The format to be used to print the memory words. The notation is the
20375 same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats,
20378 @item @var{word-size}
20379 The size of each memory word in bytes.
20381 @item @var{nr-rows}
20382 The number of rows in the output table.
20384 @item @var{nr-cols}
20385 The number of columns in the output table.
20388 If present, indicates that each row should include an @sc{ascii} dump. The
20389 value of @var{aschar} is used as a padding character when a byte is not a
20390 member of the printable @sc{ascii} character set (printable @sc{ascii}
20391 characters are those whose code is between 32 and 126, inclusively).
20393 @item @var{byte-offset}
20394 An offset to add to the @var{address} before fetching memory.
20397 This command displays memory contents as a table of @var{nr-rows} by
20398 @var{nr-cols} words, each word being @var{word-size} bytes. In total,
20399 @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
20400 (returned as @samp{total-bytes}). Should less than the requested number
20401 of bytes be returned by the target, the missing words are identified
20402 using @samp{N/A}. The number of bytes read from the target is returned
20403 in @samp{nr-bytes} and the starting address used to read memory in
20406 The address of the next/previous row or page is available in
20407 @samp{next-row} and @samp{prev-row}, @samp{next-page} and
20410 @subsubheading @value{GDBN} Command
20412 The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has
20413 @samp{gdb_get_mem} memory read command.
20415 @subsubheading Example
20417 Read six bytes of memory starting at @code{bytes+6} but then offset by
20418 @code{-6} bytes. Format as three rows of two columns. One byte per
20419 word. Display each word in hex.
20423 9-data-read-memory -o -6 -- bytes+6 x 1 3 2
20424 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
20425 next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
20426 prev-page="0x0000138a",memory=[
20427 @{addr="0x00001390",data=["0x00","0x01"]@},
20428 @{addr="0x00001392",data=["0x02","0x03"]@},
20429 @{addr="0x00001394",data=["0x04","0x05"]@}]
20433 Read two bytes of memory starting at address @code{shorts + 64} and
20434 display as a single word formatted in decimal.
20438 5-data-read-memory shorts+64 d 2 1 1
20439 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
20440 next-row="0x00001512",prev-row="0x0000150e",
20441 next-page="0x00001512",prev-page="0x0000150e",memory=[
20442 @{addr="0x00001510",data=["128"]@}]
20446 Read thirty two bytes of memory starting at @code{bytes+16} and format
20447 as eight rows of four columns. Include a string encoding with @samp{x}
20448 used as the non-printable character.
20452 4-data-read-memory bytes+16 x 1 8 4 x
20453 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
20454 next-row="0x000013c0",prev-row="0x0000139c",
20455 next-page="0x000013c0",prev-page="0x00001380",memory=[
20456 @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@},
20457 @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@},
20458 @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@},
20459 @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@},
20460 @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@},
20461 @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
20462 @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
20463 @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
20467 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20468 @node GDB/MI Tracepoint Commands
20469 @section @sc{gdb/mi} Tracepoint Commands
20471 The tracepoint commands are not yet implemented.
20473 @c @subheading -trace-actions
20475 @c @subheading -trace-delete
20477 @c @subheading -trace-disable
20479 @c @subheading -trace-dump
20481 @c @subheading -trace-enable
20483 @c @subheading -trace-exists
20485 @c @subheading -trace-find
20487 @c @subheading -trace-frame-number
20489 @c @subheading -trace-info
20491 @c @subheading -trace-insert
20493 @c @subheading -trace-list
20495 @c @subheading -trace-pass-count
20497 @c @subheading -trace-save
20499 @c @subheading -trace-start
20501 @c @subheading -trace-stop
20504 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20505 @node GDB/MI Symbol Query
20506 @section @sc{gdb/mi} Symbol Query Commands
20509 @subheading The @code{-symbol-info-address} Command
20510 @findex -symbol-info-address
20512 @subsubheading Synopsis
20515 -symbol-info-address @var{symbol}
20518 Describe where @var{symbol} is stored.
20520 @subsubheading @value{GDBN} Command
20522 The corresponding @value{GDBN} command is @samp{info address}.
20524 @subsubheading Example
20528 @subheading The @code{-symbol-info-file} Command
20529 @findex -symbol-info-file
20531 @subsubheading Synopsis
20537 Show the file for the symbol.
20539 @subsubheading @value{GDBN} Command
20541 There's no equivalent @value{GDBN} command. @code{gdbtk} has
20542 @samp{gdb_find_file}.
20544 @subsubheading Example
20548 @subheading The @code{-symbol-info-function} Command
20549 @findex -symbol-info-function
20551 @subsubheading Synopsis
20554 -symbol-info-function
20557 Show which function the symbol lives in.
20559 @subsubheading @value{GDBN} Command
20561 @samp{gdb_get_function} in @code{gdbtk}.
20563 @subsubheading Example
20567 @subheading The @code{-symbol-info-line} Command
20568 @findex -symbol-info-line
20570 @subsubheading Synopsis
20576 Show the core addresses of the code for a source line.
20578 @subsubheading @value{GDBN} Command
20580 The corresponding @value{GDBN} command is @samp{info line}.
20581 @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands.
20583 @subsubheading Example
20587 @subheading The @code{-symbol-info-symbol} Command
20588 @findex -symbol-info-symbol
20590 @subsubheading Synopsis
20593 -symbol-info-symbol @var{addr}
20596 Describe what symbol is at location @var{addr}.
20598 @subsubheading @value{GDBN} Command
20600 The corresponding @value{GDBN} command is @samp{info symbol}.
20602 @subsubheading Example
20606 @subheading The @code{-symbol-list-functions} Command
20607 @findex -symbol-list-functions
20609 @subsubheading Synopsis
20612 -symbol-list-functions
20615 List the functions in the executable.
20617 @subsubheading @value{GDBN} Command
20619 @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and
20620 @samp{gdb_search} in @code{gdbtk}.
20622 @subsubheading Example
20626 @subheading The @code{-symbol-list-lines} Command
20627 @findex -symbol-list-lines
20629 @subsubheading Synopsis
20632 -symbol-list-lines @var{filename}
20635 Print the list of lines that contain code and their associated program
20636 addresses for the given source filename. The entries are sorted in
20637 ascending PC order.
20639 @subsubheading @value{GDBN} Command
20641 There is no corresponding @value{GDBN} command.
20643 @subsubheading Example
20646 -symbol-list-lines basics.c
20647 ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
20652 @subheading The @code{-symbol-list-types} Command
20653 @findex -symbol-list-types
20655 @subsubheading Synopsis
20661 List all the type names.
20663 @subsubheading @value{GDBN} Command
20665 The corresponding commands are @samp{info types} in @value{GDBN},
20666 @samp{gdb_search} in @code{gdbtk}.
20668 @subsubheading Example
20672 @subheading The @code{-symbol-list-variables} Command
20673 @findex -symbol-list-variables
20675 @subsubheading Synopsis
20678 -symbol-list-variables
20681 List all the global and static variable names.
20683 @subsubheading @value{GDBN} Command
20685 @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}.
20687 @subsubheading Example
20691 @subheading The @code{-symbol-locate} Command
20692 @findex -symbol-locate
20694 @subsubheading Synopsis
20700 @subsubheading @value{GDBN} Command
20702 @samp{gdb_loc} in @code{gdbtk}.
20704 @subsubheading Example
20708 @subheading The @code{-symbol-type} Command
20709 @findex -symbol-type
20711 @subsubheading Synopsis
20714 -symbol-type @var{variable}
20717 Show type of @var{variable}.
20719 @subsubheading @value{GDBN} Command
20721 The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has
20722 @samp{gdb_obj_variable}.
20724 @subsubheading Example
20728 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20729 @node GDB/MI File Commands
20730 @section @sc{gdb/mi} File Commands
20732 This section describes the GDB/MI commands to specify executable file names
20733 and to read in and obtain symbol table information.
20735 @subheading The @code{-file-exec-and-symbols} Command
20736 @findex -file-exec-and-symbols
20738 @subsubheading Synopsis
20741 -file-exec-and-symbols @var{file}
20744 Specify the executable file to be debugged. This file is the one from
20745 which the symbol table is also read. If no file is specified, the
20746 command clears the executable and symbol information. If breakpoints
20747 are set when using this command with no arguments, @value{GDBN} will produce
20748 error messages. Otherwise, no output is produced, except a completion
20751 @subsubheading @value{GDBN} Command
20753 The corresponding @value{GDBN} command is @samp{file}.
20755 @subsubheading Example
20759 -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
20765 @subheading The @code{-file-exec-file} Command
20766 @findex -file-exec-file
20768 @subsubheading Synopsis
20771 -file-exec-file @var{file}
20774 Specify the executable file to be debugged. Unlike
20775 @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read
20776 from this file. If used without argument, @value{GDBN} clears the information
20777 about the executable file. No output is produced, except a completion
20780 @subsubheading @value{GDBN} Command
20782 The corresponding @value{GDBN} command is @samp{exec-file}.
20784 @subsubheading Example
20788 -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
20794 @subheading The @code{-file-list-exec-sections} Command
20795 @findex -file-list-exec-sections
20797 @subsubheading Synopsis
20800 -file-list-exec-sections
20803 List the sections of the current executable file.
20805 @subsubheading @value{GDBN} Command
20807 The @value{GDBN} command @samp{info file} shows, among the rest, the same
20808 information as this command. @code{gdbtk} has a corresponding command
20809 @samp{gdb_load_info}.
20811 @subsubheading Example
20815 @subheading The @code{-file-list-exec-source-file} Command
20816 @findex -file-list-exec-source-file
20818 @subsubheading Synopsis
20821 -file-list-exec-source-file
20824 List the line number, the current source file, and the absolute path
20825 to the current source file for the current executable.
20827 @subsubheading @value{GDBN} Command
20829 The @value{GDBN} equivalent is @samp{info source}
20831 @subsubheading Example
20835 123-file-list-exec-source-file
20836 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c"
20841 @subheading The @code{-file-list-exec-source-files} Command
20842 @findex -file-list-exec-source-files
20844 @subsubheading Synopsis
20847 -file-list-exec-source-files
20850 List the source files for the current executable.
20852 It will always output the filename, but only when @value{GDBN} can find
20853 the absolute file name of a source file, will it output the fullname.
20855 @subsubheading @value{GDBN} Command
20857 The @value{GDBN} equivalent is @samp{info sources}.
20858 @code{gdbtk} has an analogous command @samp{gdb_listfiles}.
20860 @subsubheading Example
20863 -file-list-exec-source-files
20865 @{file=foo.c,fullname=/home/foo.c@},
20866 @{file=/home/bar.c,fullname=/home/bar.c@},
20867 @{file=gdb_could_not_find_fullpath.c@}]
20871 @subheading The @code{-file-list-shared-libraries} Command
20872 @findex -file-list-shared-libraries
20874 @subsubheading Synopsis
20877 -file-list-shared-libraries
20880 List the shared libraries in the program.
20882 @subsubheading @value{GDBN} Command
20884 The corresponding @value{GDBN} command is @samp{info shared}.
20886 @subsubheading Example
20890 @subheading The @code{-file-list-symbol-files} Command
20891 @findex -file-list-symbol-files
20893 @subsubheading Synopsis
20896 -file-list-symbol-files
20901 @subsubheading @value{GDBN} Command
20903 The corresponding @value{GDBN} command is @samp{info file} (part of it).
20905 @subsubheading Example
20909 @subheading The @code{-file-symbol-file} Command
20910 @findex -file-symbol-file
20912 @subsubheading Synopsis
20915 -file-symbol-file @var{file}
20918 Read symbol table info from the specified @var{file} argument. When
20919 used without arguments, clears @value{GDBN}'s symbol table info. No output is
20920 produced, except for a completion notification.
20922 @subsubheading @value{GDBN} Command
20924 The corresponding @value{GDBN} command is @samp{symbol-file}.
20926 @subsubheading Example
20930 -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
20936 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20937 @node GDB/MI Memory Overlay Commands
20938 @section @sc{gdb/mi} Memory Overlay Commands
20940 The memory overlay commands are not implemented.
20942 @c @subheading -overlay-auto
20944 @c @subheading -overlay-list-mapping-state
20946 @c @subheading -overlay-list-overlays
20948 @c @subheading -overlay-map
20950 @c @subheading -overlay-off
20952 @c @subheading -overlay-on
20954 @c @subheading -overlay-unmap
20956 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20957 @node GDB/MI Signal Handling Commands
20958 @section @sc{gdb/mi} Signal Handling Commands
20960 Signal handling commands are not implemented.
20962 @c @subheading -signal-handle
20964 @c @subheading -signal-list-handle-actions
20966 @c @subheading -signal-list-signal-types
20970 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
20971 @node GDB/MI Target Manipulation
20972 @section @sc{gdb/mi} Target Manipulation Commands
20975 @subheading The @code{-target-attach} Command
20976 @findex -target-attach
20978 @subsubheading Synopsis
20981 -target-attach @var{pid} | @var{file}
20984 Attach to a process @var{pid} or a file @var{file} outside of @value{GDBN}.
20986 @subsubheading @value{GDBN} Command
20988 The corresponding @value{GDBN} command is @samp{attach}.
20990 @subsubheading Example
20994 @subheading The @code{-target-compare-sections} Command
20995 @findex -target-compare-sections
20997 @subsubheading Synopsis
21000 -target-compare-sections [ @var{section} ]
21003 Compare data of section @var{section} on target to the exec file.
21004 Without the argument, all sections are compared.
21006 @subsubheading @value{GDBN} Command
21008 The @value{GDBN} equivalent is @samp{compare-sections}.
21010 @subsubheading Example
21014 @subheading The @code{-target-detach} Command
21015 @findex -target-detach
21017 @subsubheading Synopsis
21023 Detach from the remote target which normally resumes its execution.
21026 @subsubheading @value{GDBN} Command
21028 The corresponding @value{GDBN} command is @samp{detach}.
21030 @subsubheading Example
21040 @subheading The @code{-target-disconnect} Command
21041 @findex -target-disconnect
21043 @subsubheading Synopsis
21049 Disconnect from the remote target. There's no output and the target is
21050 generally not resumed.
21052 @subsubheading @value{GDBN} Command
21054 The corresponding @value{GDBN} command is @samp{disconnect}.
21056 @subsubheading Example
21066 @subheading The @code{-target-download} Command
21067 @findex -target-download
21069 @subsubheading Synopsis
21075 Loads the executable onto the remote target.
21076 It prints out an update message every half second, which includes the fields:
21080 The name of the section.
21082 The size of what has been sent so far for that section.
21084 The size of the section.
21086 The total size of what was sent so far (the current and the previous sections).
21088 The size of the overall executable to download.
21092 Each message is sent as status record (@pxref{GDB/MI Output Syntax, ,
21093 @sc{gdb/mi} Output Syntax}).
21095 In addition, it prints the name and size of the sections, as they are
21096 downloaded. These messages include the following fields:
21100 The name of the section.
21102 The size of the section.
21104 The size of the overall executable to download.
21108 At the end, a summary is printed.
21110 @subsubheading @value{GDBN} Command
21112 The corresponding @value{GDBN} command is @samp{load}.
21114 @subsubheading Example
21116 Note: each status message appears on a single line. Here the messages
21117 have been broken down so that they can fit onto a page.
21122 +download,@{section=".text",section-size="6668",total-size="9880"@}
21123 +download,@{section=".text",section-sent="512",section-size="6668",
21124 total-sent="512",total-size="9880"@}
21125 +download,@{section=".text",section-sent="1024",section-size="6668",
21126 total-sent="1024",total-size="9880"@}
21127 +download,@{section=".text",section-sent="1536",section-size="6668",
21128 total-sent="1536",total-size="9880"@}
21129 +download,@{section=".text",section-sent="2048",section-size="6668",
21130 total-sent="2048",total-size="9880"@}
21131 +download,@{section=".text",section-sent="2560",section-size="6668",
21132 total-sent="2560",total-size="9880"@}
21133 +download,@{section=".text",section-sent="3072",section-size="6668",
21134 total-sent="3072",total-size="9880"@}
21135 +download,@{section=".text",section-sent="3584",section-size="6668",
21136 total-sent="3584",total-size="9880"@}
21137 +download,@{section=".text",section-sent="4096",section-size="6668",
21138 total-sent="4096",total-size="9880"@}
21139 +download,@{section=".text",section-sent="4608",section-size="6668",
21140 total-sent="4608",total-size="9880"@}
21141 +download,@{section=".text",section-sent="5120",section-size="6668",
21142 total-sent="5120",total-size="9880"@}
21143 +download,@{section=".text",section-sent="5632",section-size="6668",
21144 total-sent="5632",total-size="9880"@}
21145 +download,@{section=".text",section-sent="6144",section-size="6668",
21146 total-sent="6144",total-size="9880"@}
21147 +download,@{section=".text",section-sent="6656",section-size="6668",
21148 total-sent="6656",total-size="9880"@}
21149 +download,@{section=".init",section-size="28",total-size="9880"@}
21150 +download,@{section=".fini",section-size="28",total-size="9880"@}
21151 +download,@{section=".data",section-size="3156",total-size="9880"@}
21152 +download,@{section=".data",section-sent="512",section-size="3156",
21153 total-sent="7236",total-size="9880"@}
21154 +download,@{section=".data",section-sent="1024",section-size="3156",
21155 total-sent="7748",total-size="9880"@}
21156 +download,@{section=".data",section-sent="1536",section-size="3156",
21157 total-sent="8260",total-size="9880"@}
21158 +download,@{section=".data",section-sent="2048",section-size="3156",
21159 total-sent="8772",total-size="9880"@}
21160 +download,@{section=".data",section-sent="2560",section-size="3156",
21161 total-sent="9284",total-size="9880"@}
21162 +download,@{section=".data",section-sent="3072",section-size="3156",
21163 total-sent="9796",total-size="9880"@}
21164 ^done,address="0x10004",load-size="9880",transfer-rate="6586",
21170 @subheading The @code{-target-exec-status} Command
21171 @findex -target-exec-status
21173 @subsubheading Synopsis
21176 -target-exec-status
21179 Provide information on the state of the target (whether it is running or
21180 not, for instance).
21182 @subsubheading @value{GDBN} Command
21184 There's no equivalent @value{GDBN} command.
21186 @subsubheading Example
21190 @subheading The @code{-target-list-available-targets} Command
21191 @findex -target-list-available-targets
21193 @subsubheading Synopsis
21196 -target-list-available-targets
21199 List the possible targets to connect to.
21201 @subsubheading @value{GDBN} Command
21203 The corresponding @value{GDBN} command is @samp{help target}.
21205 @subsubheading Example
21209 @subheading The @code{-target-list-current-targets} Command
21210 @findex -target-list-current-targets
21212 @subsubheading Synopsis
21215 -target-list-current-targets
21218 Describe the current target.
21220 @subsubheading @value{GDBN} Command
21222 The corresponding information is printed by @samp{info file} (among
21225 @subsubheading Example
21229 @subheading The @code{-target-list-parameters} Command
21230 @findex -target-list-parameters
21232 @subsubheading Synopsis
21235 -target-list-parameters
21240 @subsubheading @value{GDBN} Command
21244 @subsubheading Example
21248 @subheading The @code{-target-select} Command
21249 @findex -target-select
21251 @subsubheading Synopsis
21254 -target-select @var{type} @var{parameters @dots{}}
21257 Connect @value{GDBN} to the remote target. This command takes two args:
21261 The type of target, for instance @samp{async}, @samp{remote}, etc.
21262 @item @var{parameters}
21263 Device names, host names and the like. @xref{Target Commands, ,
21264 Commands for Managing Targets}, for more details.
21267 The output is a connection notification, followed by the address at
21268 which the target program is, in the following form:
21271 ^connected,addr="@var{address}",func="@var{function name}",
21272 args=[@var{arg list}]
21275 @subsubheading @value{GDBN} Command
21277 The corresponding @value{GDBN} command is @samp{target}.
21279 @subsubheading Example
21283 -target-select async /dev/ttya
21284 ^connected,addr="0xfe00a300",func="??",args=[]
21288 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
21289 @node GDB/MI Miscellaneous Commands
21290 @section Miscellaneous @sc{gdb/mi} Commands
21292 @c @subheading -gdb-complete
21294 @subheading The @code{-gdb-exit} Command
21297 @subsubheading Synopsis
21303 Exit @value{GDBN} immediately.
21305 @subsubheading @value{GDBN} Command
21307 Approximately corresponds to @samp{quit}.
21309 @subsubheading Example
21318 @subheading The @code{-exec-abort} Command
21319 @findex -exec-abort
21321 @subsubheading Synopsis
21327 Kill the inferior running program.
21329 @subsubheading @value{GDBN} Command
21331 The corresponding @value{GDBN} command is @samp{kill}.
21333 @subsubheading Example
21337 @subheading The @code{-gdb-set} Command
21340 @subsubheading Synopsis
21346 Set an internal @value{GDBN} variable.
21347 @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ?????
21349 @subsubheading @value{GDBN} Command
21351 The corresponding @value{GDBN} command is @samp{set}.
21353 @subsubheading Example
21363 @subheading The @code{-gdb-show} Command
21366 @subsubheading Synopsis
21372 Show the current value of a @value{GDBN} variable.
21374 @subsubheading @value{GDBN} Command
21376 The corresponding @value{GDBN} command is @samp{show}.
21378 @subsubheading Example
21387 @c @subheading -gdb-source
21390 @subheading The @code{-gdb-version} Command
21391 @findex -gdb-version
21393 @subsubheading Synopsis
21399 Show version information for @value{GDBN}. Used mostly in testing.
21401 @subsubheading @value{GDBN} Command
21403 The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by
21404 default shows this information when you start an interactive session.
21406 @subsubheading Example
21408 @c This example modifies the actual output from GDB to avoid overfull
21414 ~Copyright 2000 Free Software Foundation, Inc.
21415 ~GDB is free software, covered by the GNU General Public License, and
21416 ~you are welcome to change it and/or distribute copies of it under
21417 ~ certain conditions.
21418 ~Type "show copying" to see the conditions.
21419 ~There is absolutely no warranty for GDB. Type "show warranty" for
21421 ~This GDB was configured as
21422 "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
21427 @subheading The @code{-list-features} Command
21428 @findex -list-features
21430 Returns a list of particular features of the MI protocol that
21431 this version of gdb implements. A feature can be a command,
21432 or a new field in an output of some command, or even an
21433 important bugfix. While a frontend can sometimes detect presence
21434 of a feature at runtime, it is easier to perform detection at debugger
21437 The command returns a list of strings, with each string naming an
21438 available feature. Each returned string is just a name, it does not
21439 have any internal structure. The list of possible feature names
21445 (gdb) -list-features
21446 ^done,result=["feature1","feature2"]
21449 The current list of features is:
21453 @samp{frozen-varobjs}---indicates presence of the
21454 @code{-var-set-frozen} command, as well as possible presense of the
21455 @code{frozen} field in the output of @code{-varobj-create}.
21458 @subheading The @code{-interpreter-exec} Command
21459 @findex -interpreter-exec
21461 @subheading Synopsis
21464 -interpreter-exec @var{interpreter} @var{command}
21466 @anchor{-interpreter-exec}
21468 Execute the specified @var{command} in the given @var{interpreter}.
21470 @subheading @value{GDBN} Command
21472 The corresponding @value{GDBN} command is @samp{interpreter-exec}.
21474 @subheading Example
21478 -interpreter-exec console "break main"
21479 &"During symbol reading, couldn't parse type; debugger out of date?.\n"
21480 &"During symbol reading, bad structure-type format.\n"
21481 ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
21486 @subheading The @code{-inferior-tty-set} Command
21487 @findex -inferior-tty-set
21489 @subheading Synopsis
21492 -inferior-tty-set /dev/pts/1
21495 Set terminal for future runs of the program being debugged.
21497 @subheading @value{GDBN} Command
21499 The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1.
21501 @subheading Example
21505 -inferior-tty-set /dev/pts/1
21510 @subheading The @code{-inferior-tty-show} Command
21511 @findex -inferior-tty-show
21513 @subheading Synopsis
21519 Show terminal for future runs of program being debugged.
21521 @subheading @value{GDBN} Command
21523 The corresponding @value{GDBN} command is @samp{show inferior-tty}.
21525 @subheading Example
21529 -inferior-tty-set /dev/pts/1
21533 ^done,inferior_tty_terminal="/dev/pts/1"
21537 @subheading The @code{-enable-timings} Command
21538 @findex -enable-timings
21540 @subheading Synopsis
21543 -enable-timings [yes | no]
21546 Toggle the printing of the wallclock, user and system times for an MI
21547 command as a field in its output. This command is to help frontend
21548 developers optimize the performance of their code. No argument is
21549 equivalent to @samp{yes}.
21551 @subheading @value{GDBN} Command
21555 @subheading Example
21563 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
21564 addr="0x080484ed",func="main",file="myprog.c",
21565 fullname="/home/nickrob/myprog.c",line="73",times="0"@},
21566 time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
21574 *stopped,reason="breakpoint-hit",bkptno="1",thread-id="0",
21575 frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
21576 @{name="argv",value="0xbfb60364"@}],file="myprog.c",
21577 fullname="/home/nickrob/myprog.c",line="73"@}
21582 @chapter @value{GDBN} Annotations
21584 This chapter describes annotations in @value{GDBN}. Annotations were
21585 designed to interface @value{GDBN} to graphical user interfaces or other
21586 similar programs which want to interact with @value{GDBN} at a
21587 relatively high level.
21589 The annotation mechanism has largely been superseded by @sc{gdb/mi}
21593 This is Edition @value{EDITION}, @value{DATE}.
21597 * Annotations Overview:: What annotations are; the general syntax.
21598 * Server Prefix:: Issuing a command without affecting user state.
21599 * Prompting:: Annotations marking @value{GDBN}'s need for input.
21600 * Errors:: Annotations for error messages.
21601 * Invalidation:: Some annotations describe things now invalid.
21602 * Annotations for Running::
21603 Whether the program is running, how it stopped, etc.
21604 * Source Annotations:: Annotations describing source code.
21607 @node Annotations Overview
21608 @section What is an Annotation?
21609 @cindex annotations
21611 Annotations start with a newline character, two @samp{control-z}
21612 characters, and the name of the annotation. If there is no additional
21613 information associated with this annotation, the name of the annotation
21614 is followed immediately by a newline. If there is additional
21615 information, the name of the annotation is followed by a space, the
21616 additional information, and a newline. The additional information
21617 cannot contain newline characters.
21619 Any output not beginning with a newline and two @samp{control-z}
21620 characters denotes literal output from @value{GDBN}. Currently there is
21621 no need for @value{GDBN} to output a newline followed by two
21622 @samp{control-z} characters, but if there was such a need, the
21623 annotations could be extended with an @samp{escape} annotation which
21624 means those three characters as output.
21626 The annotation @var{level}, which is specified using the
21627 @option{--annotate} command line option (@pxref{Mode Options}), controls
21628 how much information @value{GDBN} prints together with its prompt,
21629 values of expressions, source lines, and other types of output. Level 0
21630 is for no annotations, level 1 is for use when @value{GDBN} is run as a
21631 subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable
21632 for programs that control @value{GDBN}, and level 2 annotations have
21633 been made obsolete (@pxref{Limitations, , Limitations of the Annotation
21634 Interface, annotate, GDB's Obsolete Annotations}).
21637 @kindex set annotate
21638 @item set annotate @var{level}
21639 The @value{GDBN} command @code{set annotate} sets the level of
21640 annotations to the specified @var{level}.
21642 @item show annotate
21643 @kindex show annotate
21644 Show the current annotation level.
21647 This chapter describes level 3 annotations.
21649 A simple example of starting up @value{GDBN} with annotations is:
21652 $ @kbd{gdb --annotate=3}
21654 Copyright 2003 Free Software Foundation, Inc.
21655 GDB is free software, covered by the GNU General Public License,
21656 and you are welcome to change it and/or distribute copies of it
21657 under certain conditions.
21658 Type "show copying" to see the conditions.
21659 There is absolutely no warranty for GDB. Type "show warranty"
21661 This GDB was configured as "i386-pc-linux-gnu"
21672 Here @samp{quit} is input to @value{GDBN}; the rest is output from
21673 @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z}
21674 denotes a @samp{control-z} character) are annotations; the rest is
21675 output from @value{GDBN}.
21677 @node Server Prefix
21678 @section The Server Prefix
21679 @cindex server prefix
21681 If you prefix a command with @samp{server } then it will not affect
21682 the command history, nor will it affect @value{GDBN}'s notion of which
21683 command to repeat if @key{RET} is pressed on a line by itself. This
21684 means that commands can be run behind a user's back by a front-end in
21685 a transparent manner.
21687 The server prefix does not affect the recording of values into the value
21688 history; to print a value without recording it into the value history,
21689 use the @code{output} command instead of the @code{print} command.
21692 @section Annotation for @value{GDBN} Input
21694 @cindex annotations for prompts
21695 When @value{GDBN} prompts for input, it annotates this fact so it is possible
21696 to know when to send output, when the output from a given command is
21699 Different kinds of input each have a different @dfn{input type}. Each
21700 input type has three annotations: a @code{pre-} annotation, which
21701 denotes the beginning of any prompt which is being output, a plain
21702 annotation, which denotes the end of the prompt, and then a @code{post-}
21703 annotation which denotes the end of any echo which may (or may not) be
21704 associated with the input. For example, the @code{prompt} input type
21705 features the following annotations:
21713 The input types are
21716 @findex pre-prompt annotation
21717 @findex prompt annotation
21718 @findex post-prompt annotation
21720 When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
21722 @findex pre-commands annotation
21723 @findex commands annotation
21724 @findex post-commands annotation
21726 When @value{GDBN} prompts for a set of commands, like in the @code{commands}
21727 command. The annotations are repeated for each command which is input.
21729 @findex pre-overload-choice annotation
21730 @findex overload-choice annotation
21731 @findex post-overload-choice annotation
21732 @item overload-choice
21733 When @value{GDBN} wants the user to select between various overloaded functions.
21735 @findex pre-query annotation
21736 @findex query annotation
21737 @findex post-query annotation
21739 When @value{GDBN} wants the user to confirm a potentially dangerous operation.
21741 @findex pre-prompt-for-continue annotation
21742 @findex prompt-for-continue annotation
21743 @findex post-prompt-for-continue annotation
21744 @item prompt-for-continue
21745 When @value{GDBN} is asking the user to press return to continue. Note: Don't
21746 expect this to work well; instead use @code{set height 0} to disable
21747 prompting. This is because the counting of lines is buggy in the
21748 presence of annotations.
21753 @cindex annotations for errors, warnings and interrupts
21755 @findex quit annotation
21760 This annotation occurs right before @value{GDBN} responds to an interrupt.
21762 @findex error annotation
21767 This annotation occurs right before @value{GDBN} responds to an error.
21769 Quit and error annotations indicate that any annotations which @value{GDBN} was
21770 in the middle of may end abruptly. For example, if a
21771 @code{value-history-begin} annotation is followed by a @code{error}, one
21772 cannot expect to receive the matching @code{value-history-end}. One
21773 cannot expect not to receive it either, however; an error annotation
21774 does not necessarily mean that @value{GDBN} is immediately returning all the way
21777 @findex error-begin annotation
21778 A quit or error annotation may be preceded by
21784 Any output between that and the quit or error annotation is the error
21787 Warning messages are not yet annotated.
21788 @c If we want to change that, need to fix warning(), type_error(),
21789 @c range_error(), and possibly other places.
21792 @section Invalidation Notices
21794 @cindex annotations for invalidation messages
21795 The following annotations say that certain pieces of state may have
21799 @findex frames-invalid annotation
21800 @item ^Z^Zframes-invalid
21802 The frames (for example, output from the @code{backtrace} command) may
21805 @findex breakpoints-invalid annotation
21806 @item ^Z^Zbreakpoints-invalid
21808 The breakpoints may have changed. For example, the user just added or
21809 deleted a breakpoint.
21812 @node Annotations for Running
21813 @section Running the Program
21814 @cindex annotations for running programs
21816 @findex starting annotation
21817 @findex stopping annotation
21818 When the program starts executing due to a @value{GDBN} command such as
21819 @code{step} or @code{continue},
21825 is output. When the program stops,
21831 is output. Before the @code{stopped} annotation, a variety of
21832 annotations describe how the program stopped.
21835 @findex exited annotation
21836 @item ^Z^Zexited @var{exit-status}
21837 The program exited, and @var{exit-status} is the exit status (zero for
21838 successful exit, otherwise nonzero).
21840 @findex signalled annotation
21841 @findex signal-name annotation
21842 @findex signal-name-end annotation
21843 @findex signal-string annotation
21844 @findex signal-string-end annotation
21845 @item ^Z^Zsignalled
21846 The program exited with a signal. After the @code{^Z^Zsignalled}, the
21847 annotation continues:
21853 ^Z^Zsignal-name-end
21857 ^Z^Zsignal-string-end
21862 where @var{name} is the name of the signal, such as @code{SIGILL} or
21863 @code{SIGSEGV}, and @var{string} is the explanation of the signal, such
21864 as @code{Illegal Instruction} or @code{Segmentation fault}.
21865 @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
21866 user's benefit and have no particular format.
21868 @findex signal annotation
21870 The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
21871 just saying that the program received the signal, not that it was
21872 terminated with it.
21874 @findex breakpoint annotation
21875 @item ^Z^Zbreakpoint @var{number}
21876 The program hit breakpoint number @var{number}.
21878 @findex watchpoint annotation
21879 @item ^Z^Zwatchpoint @var{number}
21880 The program hit watchpoint number @var{number}.
21883 @node Source Annotations
21884 @section Displaying Source
21885 @cindex annotations for source display
21887 @findex source annotation
21888 The following annotation is used instead of displaying source code:
21891 ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr}
21894 where @var{filename} is an absolute file name indicating which source
21895 file, @var{line} is the line number within that file (where 1 is the
21896 first line in the file), @var{character} is the character position
21897 within the file (where 0 is the first character in the file) (for most
21898 debug formats this will necessarily point to the beginning of a line),
21899 @var{middle} is @samp{middle} if @var{addr} is in the middle of the
21900 line, or @samp{beg} if @var{addr} is at the beginning of the line, and
21901 @var{addr} is the address in the target program associated with the
21902 source which is being displayed. @var{addr} is in the form @samp{0x}
21903 followed by one or more lowercase hex digits (note that this does not
21904 depend on the language).
21907 @chapter Reporting Bugs in @value{GDBN}
21908 @cindex bugs in @value{GDBN}
21909 @cindex reporting bugs in @value{GDBN}
21911 Your bug reports play an essential role in making @value{GDBN} reliable.
21913 Reporting a bug may help you by bringing a solution to your problem, or it
21914 may not. But in any case the principal function of a bug report is to help
21915 the entire community by making the next version of @value{GDBN} work better. Bug
21916 reports are your contribution to the maintenance of @value{GDBN}.
21918 In order for a bug report to serve its purpose, you must include the
21919 information that enables us to fix the bug.
21922 * Bug Criteria:: Have you found a bug?
21923 * Bug Reporting:: How to report bugs
21927 @section Have You Found a Bug?
21928 @cindex bug criteria
21930 If you are not sure whether you have found a bug, here are some guidelines:
21933 @cindex fatal signal
21934 @cindex debugger crash
21935 @cindex crash of debugger
21937 If the debugger gets a fatal signal, for any input whatever, that is a
21938 @value{GDBN} bug. Reliable debuggers never crash.
21940 @cindex error on valid input
21942 If @value{GDBN} produces an error message for valid input, that is a
21943 bug. (Note that if you're cross debugging, the problem may also be
21944 somewhere in the connection to the target.)
21946 @cindex invalid input
21948 If @value{GDBN} does not produce an error message for invalid input,
21949 that is a bug. However, you should note that your idea of
21950 ``invalid input'' might be our idea of ``an extension'' or ``support
21951 for traditional practice''.
21954 If you are an experienced user of debugging tools, your suggestions
21955 for improvement of @value{GDBN} are welcome in any case.
21958 @node Bug Reporting
21959 @section How to Report Bugs
21960 @cindex bug reports
21961 @cindex @value{GDBN} bugs, reporting
21963 A number of companies and individuals offer support for @sc{gnu} products.
21964 If you obtained @value{GDBN} from a support organization, we recommend you
21965 contact that organization first.
21967 You can find contact information for many support companies and
21968 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
21970 @c should add a web page ref...
21972 In any event, we also recommend that you submit bug reports for
21973 @value{GDBN}. The preferred method is to submit them directly using
21974 @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web
21975 page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can
21978 @strong{Do not send bug reports to @samp{info-gdb}, or to
21979 @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do
21980 not want to receive bug reports. Those that do have arranged to receive
21983 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
21984 serves as a repeater. The mailing list and the newsgroup carry exactly
21985 the same messages. Often people think of posting bug reports to the
21986 newsgroup instead of mailing them. This appears to work, but it has one
21987 problem which can be crucial: a newsgroup posting often lacks a mail
21988 path back to the sender. Thus, if we need to ask for more information,
21989 we may be unable to reach you. For this reason, it is better to send
21990 bug reports to the mailing list.
21992 The fundamental principle of reporting bugs usefully is this:
21993 @strong{report all the facts}. If you are not sure whether to state a
21994 fact or leave it out, state it!
21996 Often people omit facts because they think they know what causes the
21997 problem and assume that some details do not matter. Thus, you might
21998 assume that the name of the variable you use in an example does not matter.
21999 Well, probably it does not, but one cannot be sure. Perhaps the bug is a
22000 stray memory reference which happens to fetch from the location where that
22001 name is stored in memory; perhaps, if the name were different, the contents
22002 of that location would fool the debugger into doing the right thing despite
22003 the bug. Play it safe and give a specific, complete example. That is the
22004 easiest thing for you to do, and the most helpful.
22006 Keep in mind that the purpose of a bug report is to enable us to fix the
22007 bug. It may be that the bug has been reported previously, but neither
22008 you nor we can know that unless your bug report is complete and
22011 Sometimes people give a few sketchy facts and ask, ``Does this ring a
22012 bell?'' Those bug reports are useless, and we urge everyone to
22013 @emph{refuse to respond to them} except to chide the sender to report
22016 To enable us to fix the bug, you should include all these things:
22020 The version of @value{GDBN}. @value{GDBN} announces it if you start
22021 with no arguments; you can also print it at any time using @code{show
22024 Without this, we will not know whether there is any point in looking for
22025 the bug in the current version of @value{GDBN}.
22028 The type of machine you are using, and the operating system name and
22032 What compiler (and its version) was used to compile @value{GDBN}---e.g.@:
22033 ``@value{GCC}--2.8.1''.
22036 What compiler (and its version) was used to compile the program you are
22037 debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
22038 C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version}
22039 to get this information; for other compilers, see the documentation for
22043 The command arguments you gave the compiler to compile your example and
22044 observe the bug. For example, did you use @samp{-O}? To guarantee
22045 you will not omit something important, list them all. A copy of the
22046 Makefile (or the output from make) is sufficient.
22048 If we were to try to guess the arguments, we would probably guess wrong
22049 and then we might not encounter the bug.
22052 A complete input script, and all necessary source files, that will
22056 A description of what behavior you observe that you believe is
22057 incorrect. For example, ``It gets a fatal signal.''
22059 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
22060 will certainly notice it. But if the bug is incorrect output, we might
22061 not notice unless it is glaringly wrong. You might as well not give us
22062 a chance to make a mistake.
22064 Even if the problem you experience is a fatal signal, you should still
22065 say so explicitly. Suppose something strange is going on, such as, your
22066 copy of @value{GDBN} is out of synch, or you have encountered a bug in
22067 the C library on your system. (This has happened!) Your copy might
22068 crash and ours would not. If you told us to expect a crash, then when
22069 ours fails to crash, we would know that the bug was not happening for
22070 us. If you had not told us to expect a crash, then we would not be able
22071 to draw any conclusion from our observations.
22074 @cindex recording a session script
22075 To collect all this information, you can use a session recording program
22076 such as @command{script}, which is available on many Unix systems.
22077 Just run your @value{GDBN} session inside @command{script} and then
22078 include the @file{typescript} file with your bug report.
22080 Another way to record a @value{GDBN} session is to run @value{GDBN}
22081 inside Emacs and then save the entire buffer to a file.
22084 If you wish to suggest changes to the @value{GDBN} source, send us context
22085 diffs. If you even discuss something in the @value{GDBN} source, refer to
22086 it by context, not by line number.
22088 The line numbers in our development sources will not match those in your
22089 sources. Your line numbers would convey no useful information to us.
22093 Here are some things that are not necessary:
22097 A description of the envelope of the bug.
22099 Often people who encounter a bug spend a lot of time investigating
22100 which changes to the input file will make the bug go away and which
22101 changes will not affect it.
22103 This is often time consuming and not very useful, because the way we
22104 will find the bug is by running a single example under the debugger
22105 with breakpoints, not by pure deduction from a series of examples.
22106 We recommend that you save your time for something else.
22108 Of course, if you can find a simpler example to report @emph{instead}
22109 of the original one, that is a convenience for us. Errors in the
22110 output will be easier to spot, running under the debugger will take
22111 less time, and so on.
22113 However, simplification is not vital; if you do not want to do this,
22114 report the bug anyway and send us the entire test case you used.
22117 A patch for the bug.
22119 A patch for the bug does help us if it is a good one. But do not omit
22120 the necessary information, such as the test case, on the assumption that
22121 a patch is all we need. We might see problems with your patch and decide
22122 to fix the problem another way, or we might not understand it at all.
22124 Sometimes with a program as complicated as @value{GDBN} it is very hard to
22125 construct an example that will make the program follow a certain path
22126 through the code. If you do not send us the example, we will not be able
22127 to construct one, so we will not be able to verify that the bug is fixed.
22129 And if we cannot understand what bug you are trying to fix, or why your
22130 patch should be an improvement, we will not install it. A test case will
22131 help us to understand.
22134 A guess about what the bug is or what it depends on.
22136 Such guesses are usually wrong. Even we cannot guess right about such
22137 things without first using the debugger to find the facts.
22140 @c The readline documentation is distributed with the readline code
22141 @c and consists of the two following files:
22143 @c inc-hist.texinfo
22144 @c Use -I with makeinfo to point to the appropriate directory,
22145 @c environment var TEXINPUTS with TeX.
22146 @include rluser.texi
22147 @include inc-hist.texinfo
22150 @node Formatting Documentation
22151 @appendix Formatting Documentation
22153 @cindex @value{GDBN} reference card
22154 @cindex reference card
22155 The @value{GDBN} 4 release includes an already-formatted reference card, ready
22156 for printing with PostScript or Ghostscript, in the @file{gdb}
22157 subdirectory of the main source directory@footnote{In
22158 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
22159 release.}. If you can use PostScript or Ghostscript with your printer,
22160 you can print the reference card immediately with @file{refcard.ps}.
22162 The release also includes the source for the reference card. You
22163 can format it, using @TeX{}, by typing:
22169 The @value{GDBN} reference card is designed to print in @dfn{landscape}
22170 mode on US ``letter'' size paper;
22171 that is, on a sheet 11 inches wide by 8.5 inches
22172 high. You will need to specify this form of printing as an option to
22173 your @sc{dvi} output program.
22175 @cindex documentation
22177 All the documentation for @value{GDBN} comes as part of the machine-readable
22178 distribution. The documentation is written in Texinfo format, which is
22179 a documentation system that uses a single source file to produce both
22180 on-line information and a printed manual. You can use one of the Info
22181 formatting commands to create the on-line version of the documentation
22182 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
22184 @value{GDBN} includes an already formatted copy of the on-line Info
22185 version of this manual in the @file{gdb} subdirectory. The main Info
22186 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
22187 subordinate files matching @samp{gdb.info*} in the same directory. If
22188 necessary, you can print out these files, or read them with any editor;
22189 but they are easier to read using the @code{info} subsystem in @sc{gnu}
22190 Emacs or the standalone @code{info} program, available as part of the
22191 @sc{gnu} Texinfo distribution.
22193 If you want to format these Info files yourself, you need one of the
22194 Info formatting programs, such as @code{texinfo-format-buffer} or
22197 If you have @code{makeinfo} installed, and are in the top level
22198 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
22199 version @value{GDBVN}), you can make the Info file by typing:
22206 If you want to typeset and print copies of this manual, you need @TeX{},
22207 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
22208 Texinfo definitions file.
22210 @TeX{} is a typesetting program; it does not print files directly, but
22211 produces output files called @sc{dvi} files. To print a typeset
22212 document, you need a program to print @sc{dvi} files. If your system
22213 has @TeX{} installed, chances are it has such a program. The precise
22214 command to use depends on your system; @kbd{lpr -d} is common; another
22215 (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may
22216 require a file name without any extension or a @samp{.dvi} extension.
22218 @TeX{} also requires a macro definitions file called
22219 @file{texinfo.tex}. This file tells @TeX{} how to typeset a document
22220 written in Texinfo format. On its own, @TeX{} cannot either read or
22221 typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB
22222 and is located in the @file{gdb-@var{version-number}/texinfo}
22225 If you have @TeX{} and a @sc{dvi} printer program installed, you can
22226 typeset and print this manual. First switch to the @file{gdb}
22227 subdirectory of the main source directory (for example, to
22228 @file{gdb-@value{GDBVN}/gdb}) and type:
22234 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
22236 @node Installing GDB
22237 @appendix Installing @value{GDBN}
22238 @cindex installation
22241 * Requirements:: Requirements for building @value{GDBN}
22242 * Running Configure:: Invoking the @value{GDBN} @file{configure} script
22243 * Separate Objdir:: Compiling @value{GDBN} in another directory
22244 * Config Names:: Specifying names for hosts and targets
22245 * Configure Options:: Summary of options for configure
22249 @section Requirements for Building @value{GDBN}
22250 @cindex building @value{GDBN}, requirements for
22252 Building @value{GDBN} requires various tools and packages to be available.
22253 Other packages will be used only if they are found.
22255 @heading Tools/Packages Necessary for Building @value{GDBN}
22257 @item ISO C90 compiler
22258 @value{GDBN} is written in ISO C90. It should be buildable with any
22259 working C90 compiler, e.g.@: GCC.
22263 @heading Tools/Packages Optional for Building @value{GDBN}
22267 @value{GDBN} can use the Expat XML parsing library. This library may be
22268 included with your operating system distribution; if it is not, you
22269 can get the latest version from @url{http://expat.sourceforge.net}.
22270 The @file{configure} script will search for this library in several
22271 standard locations; if it is installed in an unusual path, you can
22272 use the @option{--with-libexpat-prefix} option to specify its location.
22278 Remote protocol memory maps (@pxref{Memory Map Format})
22280 Target descriptions (@pxref{Target Descriptions})
22282 Remote shared library lists (@pxref{Library List Format})
22284 MS-Windows shared libraries (@pxref{Shared Libraries})
22289 @node Running Configure
22290 @section Invoking the @value{GDBN} @file{configure} Script
22291 @cindex configuring @value{GDBN}
22292 @value{GDBN} comes with a @file{configure} script that automates the process
22293 of preparing @value{GDBN} for installation; you can then use @code{make} to
22294 build the @code{gdb} program.
22296 @c irrelevant in info file; it's as current as the code it lives with.
22297 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
22298 look at the @file{README} file in the sources; we may have improved the
22299 installation procedures since publishing this manual.}
22302 The @value{GDBN} distribution includes all the source code you need for
22303 @value{GDBN} in a single directory, whose name is usually composed by
22304 appending the version number to @samp{gdb}.
22306 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
22307 @file{gdb-@value{GDBVN}} directory. That directory contains:
22310 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
22311 script for configuring @value{GDBN} and all its supporting libraries
22313 @item gdb-@value{GDBVN}/gdb
22314 the source specific to @value{GDBN} itself
22316 @item gdb-@value{GDBVN}/bfd
22317 source for the Binary File Descriptor library
22319 @item gdb-@value{GDBVN}/include
22320 @sc{gnu} include files
22322 @item gdb-@value{GDBVN}/libiberty
22323 source for the @samp{-liberty} free software library
22325 @item gdb-@value{GDBVN}/opcodes
22326 source for the library of opcode tables and disassemblers
22328 @item gdb-@value{GDBVN}/readline
22329 source for the @sc{gnu} command-line interface
22331 @item gdb-@value{GDBVN}/glob
22332 source for the @sc{gnu} filename pattern-matching subroutine
22334 @item gdb-@value{GDBVN}/mmalloc
22335 source for the @sc{gnu} memory-mapped malloc package
22338 The simplest way to configure and build @value{GDBN} is to run @file{configure}
22339 from the @file{gdb-@var{version-number}} source directory, which in
22340 this example is the @file{gdb-@value{GDBVN}} directory.
22342 First switch to the @file{gdb-@var{version-number}} source directory
22343 if you are not already in it; then run @file{configure}. Pass the
22344 identifier for the platform on which @value{GDBN} will run as an
22350 cd gdb-@value{GDBVN}
22351 ./configure @var{host}
22356 where @var{host} is an identifier such as @samp{sun4} or
22357 @samp{decstation}, that identifies the platform where @value{GDBN} will run.
22358 (You can often leave off @var{host}; @file{configure} tries to guess the
22359 correct value by examining your system.)
22361 Running @samp{configure @var{host}} and then running @code{make} builds the
22362 @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
22363 libraries, then @code{gdb} itself. The configured source files, and the
22364 binaries, are left in the corresponding source directories.
22367 @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
22368 system does not recognize this automatically when you run a different
22369 shell, you may need to run @code{sh} on it explicitly:
22372 sh configure @var{host}
22375 If you run @file{configure} from a directory that contains source
22376 directories for multiple libraries or programs, such as the
22377 @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN},
22379 creates configuration files for every directory level underneath (unless
22380 you tell it not to, with the @samp{--norecursion} option).
22382 You should run the @file{configure} script from the top directory in the
22383 source tree, the @file{gdb-@var{version-number}} directory. If you run
22384 @file{configure} from one of the subdirectories, you will configure only
22385 that subdirectory. That is usually not what you want. In particular,
22386 if you run the first @file{configure} from the @file{gdb} subdirectory
22387 of the @file{gdb-@var{version-number}} directory, you will omit the
22388 configuration of @file{bfd}, @file{readline}, and other sibling
22389 directories of the @file{gdb} subdirectory. This leads to build errors
22390 about missing include files such as @file{bfd/bfd.h}.
22392 You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
22393 However, you should make sure that the shell on your path (named by
22394 the @samp{SHELL} environment variable) is publicly readable. Remember
22395 that @value{GDBN} uses the shell to start your program---some systems refuse to
22396 let @value{GDBN} debug child processes whose programs are not readable.
22398 @node Separate Objdir
22399 @section Compiling @value{GDBN} in Another Directory
22401 If you want to run @value{GDBN} versions for several host or target machines,
22402 you need a different @code{gdb} compiled for each combination of
22403 host and target. @file{configure} is designed to make this easy by
22404 allowing you to generate each configuration in a separate subdirectory,
22405 rather than in the source directory. If your @code{make} program
22406 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
22407 @code{make} in each of these directories builds the @code{gdb}
22408 program specified there.
22410 To build @code{gdb} in a separate directory, run @file{configure}
22411 with the @samp{--srcdir} option to specify where to find the source.
22412 (You also need to specify a path to find @file{configure}
22413 itself from your working directory. If the path to @file{configure}
22414 would be the same as the argument to @samp{--srcdir}, you can leave out
22415 the @samp{--srcdir} option; it is assumed.)
22417 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
22418 separate directory for a Sun 4 like this:
22422 cd gdb-@value{GDBVN}
22425 ../gdb-@value{GDBVN}/configure sun4
22430 When @file{configure} builds a configuration using a remote source
22431 directory, it creates a tree for the binaries with the same structure
22432 (and using the same names) as the tree under the source directory. In
22433 the example, you'd find the Sun 4 library @file{libiberty.a} in the
22434 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
22435 @file{gdb-sun4/gdb}.
22437 Make sure that your path to the @file{configure} script has just one
22438 instance of @file{gdb} in it. If your path to @file{configure} looks
22439 like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
22440 one subdirectory of @value{GDBN}, not the whole package. This leads to
22441 build errors about missing include files such as @file{bfd/bfd.h}.
22443 One popular reason to build several @value{GDBN} configurations in separate
22444 directories is to configure @value{GDBN} for cross-compiling (where
22445 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
22446 programs that run on another machine---the @dfn{target}).
22447 You specify a cross-debugging target by
22448 giving the @samp{--target=@var{target}} option to @file{configure}.
22450 When you run @code{make} to build a program or library, you must run
22451 it in a configured directory---whatever directory you were in when you
22452 called @file{configure} (or one of its subdirectories).
22454 The @code{Makefile} that @file{configure} generates in each source
22455 directory also runs recursively. If you type @code{make} in a source
22456 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
22457 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
22458 will build all the required libraries, and then build GDB.
22460 When you have multiple hosts or targets configured in separate
22461 directories, you can run @code{make} on them in parallel (for example,
22462 if they are NFS-mounted on each of the hosts); they will not interfere
22466 @section Specifying Names for Hosts and Targets
22468 The specifications used for hosts and targets in the @file{configure}
22469 script are based on a three-part naming scheme, but some short predefined
22470 aliases are also supported. The full naming scheme encodes three pieces
22471 of information in the following pattern:
22474 @var{architecture}-@var{vendor}-@var{os}
22477 For example, you can use the alias @code{sun4} as a @var{host} argument,
22478 or as the value for @var{target} in a @code{--target=@var{target}}
22479 option. The equivalent full name is @samp{sparc-sun-sunos4}.
22481 The @file{configure} script accompanying @value{GDBN} does not provide
22482 any query facility to list all supported host and target names or
22483 aliases. @file{configure} calls the Bourne shell script
22484 @code{config.sub} to map abbreviations to full names; you can read the
22485 script, if you wish, or you can use it to test your guesses on
22486 abbreviations---for example:
22489 % sh config.sub i386-linux
22491 % sh config.sub alpha-linux
22492 alpha-unknown-linux-gnu
22493 % sh config.sub hp9k700
22495 % sh config.sub sun4
22496 sparc-sun-sunos4.1.1
22497 % sh config.sub sun3
22498 m68k-sun-sunos4.1.1
22499 % sh config.sub i986v
22500 Invalid configuration `i986v': machine `i986v' not recognized
22504 @code{config.sub} is also distributed in the @value{GDBN} source
22505 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
22507 @node Configure Options
22508 @section @file{configure} Options
22510 Here is a summary of the @file{configure} options and arguments that
22511 are most often useful for building @value{GDBN}. @file{configure} also has
22512 several other options not listed here. @inforef{What Configure
22513 Does,,configure.info}, for a full explanation of @file{configure}.
22516 configure @r{[}--help@r{]}
22517 @r{[}--prefix=@var{dir}@r{]}
22518 @r{[}--exec-prefix=@var{dir}@r{]}
22519 @r{[}--srcdir=@var{dirname}@r{]}
22520 @r{[}--norecursion@r{]} @r{[}--rm@r{]}
22521 @r{[}--target=@var{target}@r{]}
22526 You may introduce options with a single @samp{-} rather than
22527 @samp{--} if you prefer; but you may abbreviate option names if you use
22532 Display a quick summary of how to invoke @file{configure}.
22534 @item --prefix=@var{dir}
22535 Configure the source to install programs and files under directory
22538 @item --exec-prefix=@var{dir}
22539 Configure the source to install programs under directory
22542 @c avoid splitting the warning from the explanation:
22544 @item --srcdir=@var{dirname}
22545 @strong{Warning: using this option requires @sc{gnu} @code{make}, or another
22546 @code{make} that implements the @code{VPATH} feature.}@*
22547 Use this option to make configurations in directories separate from the
22548 @value{GDBN} source directories. Among other things, you can use this to
22549 build (or maintain) several configurations simultaneously, in separate
22550 directories. @file{configure} writes configuration-specific files in
22551 the current directory, but arranges for them to use the source in the
22552 directory @var{dirname}. @file{configure} creates directories under
22553 the working directory in parallel to the source directories below
22556 @item --norecursion
22557 Configure only the directory level where @file{configure} is executed; do not
22558 propagate configuration to subdirectories.
22560 @item --target=@var{target}
22561 Configure @value{GDBN} for cross-debugging programs running on the specified
22562 @var{target}. Without this option, @value{GDBN} is configured to debug
22563 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
22565 There is no convenient way to generate a list of all available targets.
22567 @item @var{host} @dots{}
22568 Configure @value{GDBN} to run on the specified @var{host}.
22570 There is no convenient way to generate a list of all available hosts.
22573 There are many other options available as well, but they are generally
22574 needed for special purposes only.
22576 @node Maintenance Commands
22577 @appendix Maintenance Commands
22578 @cindex maintenance commands
22579 @cindex internal commands
22581 In addition to commands intended for @value{GDBN} users, @value{GDBN}
22582 includes a number of commands intended for @value{GDBN} developers,
22583 that are not documented elsewhere in this manual. These commands are
22584 provided here for reference. (For commands that turn on debugging
22585 messages, see @ref{Debugging Output}.)
22588 @kindex maint agent
22589 @item maint agent @var{expression}
22590 Translate the given @var{expression} into remote agent bytecodes.
22591 This command is useful for debugging the Agent Expression mechanism
22592 (@pxref{Agent Expressions}).
22594 @kindex maint info breakpoints
22595 @item @anchor{maint info breakpoints}maint info breakpoints
22596 Using the same format as @samp{info breakpoints}, display both the
22597 breakpoints you've set explicitly, and those @value{GDBN} is using for
22598 internal purposes. Internal breakpoints are shown with negative
22599 breakpoint numbers. The type column identifies what kind of breakpoint
22604 Normal, explicitly set breakpoint.
22607 Normal, explicitly set watchpoint.
22610 Internal breakpoint, used to handle correctly stepping through
22611 @code{longjmp} calls.
22613 @item longjmp resume
22614 Internal breakpoint at the target of a @code{longjmp}.
22617 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
22620 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
22623 Shared library events.
22627 @kindex maint check-symtabs
22628 @item maint check-symtabs
22629 Check the consistency of psymtabs and symtabs.
22631 @kindex maint cplus first_component
22632 @item maint cplus first_component @var{name}
22633 Print the first C@t{++} class/namespace component of @var{name}.
22635 @kindex maint cplus namespace
22636 @item maint cplus namespace
22637 Print the list of possible C@t{++} namespaces.
22639 @kindex maint demangle
22640 @item maint demangle @var{name}
22641 Demangle a C@t{++} or Objective-C mangled @var{name}.
22643 @kindex maint deprecate
22644 @kindex maint undeprecate
22645 @cindex deprecated commands
22646 @item maint deprecate @var{command} @r{[}@var{replacement}@r{]}
22647 @itemx maint undeprecate @var{command}
22648 Deprecate or undeprecate the named @var{command}. Deprecated commands
22649 cause @value{GDBN} to issue a warning when you use them. The optional
22650 argument @var{replacement} says which newer command should be used in
22651 favor of the deprecated one; if it is given, @value{GDBN} will mention
22652 the replacement as part of the warning.
22654 @kindex maint dump-me
22655 @item maint dump-me
22656 @cindex @code{SIGQUIT} signal, dump core of @value{GDBN}
22657 Cause a fatal signal in the debugger and force it to dump its core.
22658 This is supported only on systems which support aborting a program
22659 with the @code{SIGQUIT} signal.
22661 @kindex maint internal-error
22662 @kindex maint internal-warning
22663 @item maint internal-error @r{[}@var{message-text}@r{]}
22664 @itemx maint internal-warning @r{[}@var{message-text}@r{]}
22665 Cause @value{GDBN} to call the internal function @code{internal_error}
22666 or @code{internal_warning} and hence behave as though an internal error
22667 or internal warning has been detected. In addition to reporting the
22668 internal problem, these functions give the user the opportunity to
22669 either quit @value{GDBN} or create a core file of the current
22670 @value{GDBN} session.
22672 These commands take an optional parameter @var{message-text} that is
22673 used as the text of the error or warning message.
22675 Here's an example of using @code{internal-error}:
22678 (@value{GDBP}) @kbd{maint internal-error testing, 1, 2}
22679 @dots{}/maint.c:121: internal-error: testing, 1, 2
22680 A problem internal to GDB has been detected. Further
22681 debugging may prove unreliable.
22682 Quit this debugging session? (y or n) @kbd{n}
22683 Create a core file? (y or n) @kbd{n}
22687 @kindex maint packet
22688 @item maint packet @var{text}
22689 If @value{GDBN} is talking to an inferior via the serial protocol,
22690 then this command sends the string @var{text} to the inferior, and
22691 displays the response packet. @value{GDBN} supplies the initial
22692 @samp{$} character, the terminating @samp{#} character, and the
22695 @kindex maint print architecture
22696 @item maint print architecture @r{[}@var{file}@r{]}
22697 Print the entire architecture configuration. The optional argument
22698 @var{file} names the file where the output goes.
22700 @kindex maint print c-tdesc
22701 @item maint print c-tdesc
22702 Print the current target description (@pxref{Target Descriptions}) as
22703 a C source file. The created source file can be used in @value{GDBN}
22704 when an XML parser is not available to parse the description.
22706 @kindex maint print dummy-frames
22707 @item maint print dummy-frames
22708 Prints the contents of @value{GDBN}'s internal dummy-frame stack.
22711 (@value{GDBP}) @kbd{b add}
22713 (@value{GDBP}) @kbd{print add(2,3)}
22714 Breakpoint 2, add (a=2, b=3) at @dots{}
22716 The program being debugged stopped while in a function called from GDB.
22718 (@value{GDBP}) @kbd{maint print dummy-frames}
22719 0x1a57c80: pc=0x01014068 fp=0x0200bddc sp=0x0200bdd6
22720 top=0x0200bdd4 id=@{stack=0x200bddc,code=0x101405c@}
22721 call_lo=0x01014000 call_hi=0x01014001
22725 Takes an optional file parameter.
22727 @kindex maint print registers
22728 @kindex maint print raw-registers
22729 @kindex maint print cooked-registers
22730 @kindex maint print register-groups
22731 @item maint print registers @r{[}@var{file}@r{]}
22732 @itemx maint print raw-registers @r{[}@var{file}@r{]}
22733 @itemx maint print cooked-registers @r{[}@var{file}@r{]}
22734 @itemx maint print register-groups @r{[}@var{file}@r{]}
22735 Print @value{GDBN}'s internal register data structures.
22737 The command @code{maint print raw-registers} includes the contents of
22738 the raw register cache; the command @code{maint print cooked-registers}
22739 includes the (cooked) value of all registers; and the command
22740 @code{maint print register-groups} includes the groups that each
22741 register is a member of. @xref{Registers,, Registers, gdbint,
22742 @value{GDBN} Internals}.
22744 These commands take an optional parameter, a file name to which to
22745 write the information.
22747 @kindex maint print reggroups
22748 @item maint print reggroups @r{[}@var{file}@r{]}
22749 Print @value{GDBN}'s internal register group data structures. The
22750 optional argument @var{file} tells to what file to write the
22753 The register groups info looks like this:
22756 (@value{GDBP}) @kbd{maint print reggroups}
22769 This command forces @value{GDBN} to flush its internal register cache.
22771 @kindex maint print objfiles
22772 @cindex info for known object files
22773 @item maint print objfiles
22774 Print a dump of all known object files. For each object file, this
22775 command prints its name, address in memory, and all of its psymtabs
22778 @kindex maint print statistics
22779 @cindex bcache statistics
22780 @item maint print statistics
22781 This command prints, for each object file in the program, various data
22782 about that object file followed by the byte cache (@dfn{bcache})
22783 statistics for the object file. The objfile data includes the number
22784 of minimal, partial, full, and stabs symbols, the number of types
22785 defined by the objfile, the number of as yet unexpanded psym tables,
22786 the number of line tables and string tables, and the amount of memory
22787 used by the various tables. The bcache statistics include the counts,
22788 sizes, and counts of duplicates of all and unique objects, max,
22789 average, and median entry size, total memory used and its overhead and
22790 savings, and various measures of the hash table size and chain
22793 @kindex maint print target-stack
22794 @cindex target stack description
22795 @item maint print target-stack
22796 A @dfn{target} is an interface between the debugger and a particular
22797 kind of file or process. Targets can be stacked in @dfn{strata},
22798 so that more than one target can potentially respond to a request.
22799 In particular, memory accesses will walk down the stack of targets
22800 until they find a target that is interested in handling that particular
22803 This command prints a short description of each layer that was pushed on
22804 the @dfn{target stack}, starting from the top layer down to the bottom one.
22806 @kindex maint print type
22807 @cindex type chain of a data type
22808 @item maint print type @var{expr}
22809 Print the type chain for a type specified by @var{expr}. The argument
22810 can be either a type name or a symbol. If it is a symbol, the type of
22811 that symbol is described. The type chain produced by this command is
22812 a recursive definition of the data type as stored in @value{GDBN}'s
22813 data structures, including its flags and contained types.
22815 @kindex maint set dwarf2 max-cache-age
22816 @kindex maint show dwarf2 max-cache-age
22817 @item maint set dwarf2 max-cache-age
22818 @itemx maint show dwarf2 max-cache-age
22819 Control the DWARF 2 compilation unit cache.
22821 @cindex DWARF 2 compilation units cache
22822 In object files with inter-compilation-unit references, such as those
22823 produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF 2
22824 reader needs to frequently refer to previously read compilation units.
22825 This setting controls how long a compilation unit will remain in the
22826 cache if it is not referenced. A higher limit means that cached
22827 compilation units will be stored in memory longer, and more total
22828 memory will be used. Setting it to zero disables caching, which will
22829 slow down @value{GDBN} startup, but reduce memory consumption.
22831 @kindex maint set profile
22832 @kindex maint show profile
22833 @cindex profiling GDB
22834 @item maint set profile
22835 @itemx maint show profile
22836 Control profiling of @value{GDBN}.
22838 Profiling will be disabled until you use the @samp{maint set profile}
22839 command to enable it. When you enable profiling, the system will begin
22840 collecting timing and execution count data; when you disable profiling or
22841 exit @value{GDBN}, the results will be written to a log file. Remember that
22842 if you use profiling, @value{GDBN} will overwrite the profiling log file
22843 (often called @file{gmon.out}). If you have a record of important profiling
22844 data in a @file{gmon.out} file, be sure to move it to a safe location.
22846 Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
22847 compiled with the @samp{-pg} compiler option.
22849 @kindex maint show-debug-regs
22850 @cindex x86 hardware debug registers
22851 @item maint show-debug-regs
22852 Control whether to show variables that mirror the x86 hardware debug
22853 registers. Use @code{ON} to enable, @code{OFF} to disable. If
22854 enabled, the debug registers values are shown when @value{GDBN} inserts or
22855 removes a hardware breakpoint or watchpoint, and when the inferior
22856 triggers a hardware-assisted breakpoint or watchpoint.
22858 @kindex maint space
22859 @cindex memory used by commands
22861 Control whether to display memory usage for each command. If set to a
22862 nonzero value, @value{GDBN} will display how much memory each command
22863 took, following the command's own output. This can also be requested
22864 by invoking @value{GDBN} with the @option{--statistics} command-line
22865 switch (@pxref{Mode Options}).
22868 @cindex time of command execution
22870 Control whether to display the execution time for each command. If
22871 set to a nonzero value, @value{GDBN} will display how much time it
22872 took to execute each command, following the command's own output.
22873 This can also be requested by invoking @value{GDBN} with the
22874 @option{--statistics} command-line switch (@pxref{Mode Options}).
22876 @kindex maint translate-address
22877 @item maint translate-address @r{[}@var{section}@r{]} @var{addr}
22878 Find the symbol stored at the location specified by the address
22879 @var{addr} and an optional section name @var{section}. If found,
22880 @value{GDBN} prints the name of the closest symbol and an offset from
22881 the symbol's location to the specified address. This is similar to
22882 the @code{info address} command (@pxref{Symbols}), except that this
22883 command also allows to find symbols in other sections.
22887 The following command is useful for non-interactive invocations of
22888 @value{GDBN}, such as in the test suite.
22891 @item set watchdog @var{nsec}
22892 @kindex set watchdog
22893 @cindex watchdog timer
22894 @cindex timeout for commands
22895 Set the maximum number of seconds @value{GDBN} will wait for the
22896 target operation to finish. If this time expires, @value{GDBN}
22897 reports and error and the command is aborted.
22899 @item show watchdog
22900 Show the current setting of the target wait timeout.
22903 @node Remote Protocol
22904 @appendix @value{GDBN} Remote Serial Protocol
22909 * Stop Reply Packets::
22910 * General Query Packets::
22911 * Register Packet Format::
22912 * Tracepoint Packets::
22915 * File-I/O Remote Protocol Extension::
22916 * Library List Format::
22917 * Memory Map Format::
22923 There may be occasions when you need to know something about the
22924 protocol---for example, if there is only one serial port to your target
22925 machine, you might want your program to do something special if it
22926 recognizes a packet meant for @value{GDBN}.
22928 In the examples below, @samp{->} and @samp{<-} are used to indicate
22929 transmitted and received data, respectively.
22931 @cindex protocol, @value{GDBN} remote serial
22932 @cindex serial protocol, @value{GDBN} remote
22933 @cindex remote serial protocol
22934 All @value{GDBN} commands and responses (other than acknowledgments) are
22935 sent as a @var{packet}. A @var{packet} is introduced with the character
22936 @samp{$}, the actual @var{packet-data}, and the terminating character
22937 @samp{#} followed by a two-digit @var{checksum}:
22940 @code{$}@var{packet-data}@code{#}@var{checksum}
22944 @cindex checksum, for @value{GDBN} remote
22946 The two-digit @var{checksum} is computed as the modulo 256 sum of all
22947 characters between the leading @samp{$} and the trailing @samp{#} (an
22948 eight bit unsigned checksum).
22950 Implementors should note that prior to @value{GDBN} 5.0 the protocol
22951 specification also included an optional two-digit @var{sequence-id}:
22954 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
22957 @cindex sequence-id, for @value{GDBN} remote
22959 That @var{sequence-id} was appended to the acknowledgment. @value{GDBN}
22960 has never output @var{sequence-id}s. Stubs that handle packets added
22961 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
22963 @cindex acknowledgment, for @value{GDBN} remote
22964 When either the host or the target machine receives a packet, the first
22965 response expected is an acknowledgment: either @samp{+} (to indicate
22966 the package was received correctly) or @samp{-} (to request
22970 -> @code{$}@var{packet-data}@code{#}@var{checksum}
22975 The host (@value{GDBN}) sends @var{command}s, and the target (the
22976 debugging stub incorporated in your program) sends a @var{response}. In
22977 the case of step and continue @var{command}s, the response is only sent
22978 when the operation has completed (the target has again stopped).
22980 @var{packet-data} consists of a sequence of characters with the
22981 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
22984 @cindex remote protocol, field separator
22985 Fields within the packet should be separated using @samp{,} @samp{;} or
22986 @samp{:}. Except where otherwise noted all numbers are represented in
22987 @sc{hex} with leading zeros suppressed.
22989 Implementors should note that prior to @value{GDBN} 5.0, the character
22990 @samp{:} could not appear as the third character in a packet (as it
22991 would potentially conflict with the @var{sequence-id}).
22993 @cindex remote protocol, binary data
22994 @anchor{Binary Data}
22995 Binary data in most packets is encoded either as two hexadecimal
22996 digits per byte of binary data. This allowed the traditional remote
22997 protocol to work over connections which were only seven-bit clean.
22998 Some packets designed more recently assume an eight-bit clean
22999 connection, and use a more efficient encoding to send and receive
23002 The binary data representation uses @code{7d} (@sc{ascii} @samp{@}})
23003 as an escape character. Any escaped byte is transmitted as the escape
23004 character followed by the original character XORed with @code{0x20}.
23005 For example, the byte @code{0x7d} would be transmitted as the two
23006 bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}),
23007 @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii}
23008 @samp{@}}) must always be escaped. Responses sent by the stub
23009 must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it
23010 is not interpreted as the start of a run-length encoded sequence
23013 Response @var{data} can be run-length encoded to save space. A @samp{*}
23014 means that the next character is an @sc{ascii} encoding giving a repeat count
23015 which stands for that many repetitions of the character preceding the
23016 @samp{*}. The encoding is @code{n+29}, yielding a printable character
23017 where @code{n >=3} (which is where rle starts to win). The printable
23018 characters @samp{$}, @samp{#}, @samp{+} and @samp{-} or with a numeric
23019 value greater than 126 should not be used.
23026 means the same as "0000".
23028 The error response returned for some packets includes a two character
23029 error number. That number is not well defined.
23031 @cindex empty response, for unsupported packets
23032 For any @var{command} not supported by the stub, an empty response
23033 (@samp{$#00}) should be returned. That way it is possible to extend the
23034 protocol. A newer @value{GDBN} can tell if a packet is supported based
23037 A stub is required to support the @samp{g}, @samp{G}, @samp{m}, @samp{M},
23038 @samp{c}, and @samp{s} @var{command}s. All other @var{command}s are
23044 The following table provides a complete list of all currently defined
23045 @var{command}s and their corresponding response @var{data}.
23046 @xref{File-I/O Remote Protocol Extension}, for details about the File
23047 I/O extension of the remote protocol.
23049 Each packet's description has a template showing the packet's overall
23050 syntax, followed by an explanation of the packet's meaning. We
23051 include spaces in some of the templates for clarity; these are not
23052 part of the packet's syntax. No @value{GDBN} packet uses spaces to
23053 separate its components. For example, a template like @samp{foo
23054 @var{bar} @var{baz}} describes a packet beginning with the three ASCII
23055 bytes @samp{foo}, followed by a @var{bar}, followed directly by a
23056 @var{baz}. @value{GDBN} does not transmit a space character between the
23057 @samp{foo} and the @var{bar}, or between the @var{bar} and the
23060 Note that all packet forms beginning with an upper- or lower-case
23061 letter, other than those described here, are reserved for future use.
23063 Here are the packet descriptions.
23068 @cindex @samp{!} packet
23069 Enable extended mode. In extended mode, the remote server is made
23070 persistent. The @samp{R} packet is used to restart the program being
23076 The remote target both supports and has enabled extended mode.
23080 @cindex @samp{?} packet
23081 Indicate the reason the target halted. The reply is the same as for
23085 @xref{Stop Reply Packets}, for the reply specifications.
23087 @item A @var{arglen},@var{argnum},@var{arg},@dots{}
23088 @cindex @samp{A} packet
23089 Initialized @code{argv[]} array passed into program. @var{arglen}
23090 specifies the number of bytes in the hex encoded byte stream
23091 @var{arg}. See @code{gdbserver} for more details.
23096 The arguments were set.
23102 @cindex @samp{b} packet
23103 (Don't use this packet; its behavior is not well-defined.)
23104 Change the serial line speed to @var{baud}.
23106 JTC: @emph{When does the transport layer state change? When it's
23107 received, or after the ACK is transmitted. In either case, there are
23108 problems if the command or the acknowledgment packet is dropped.}
23110 Stan: @emph{If people really wanted to add something like this, and get
23111 it working for the first time, they ought to modify ser-unix.c to send
23112 some kind of out-of-band message to a specially-setup stub and have the
23113 switch happen "in between" packets, so that from remote protocol's point
23114 of view, nothing actually happened.}
23116 @item B @var{addr},@var{mode}
23117 @cindex @samp{B} packet
23118 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
23119 breakpoint at @var{addr}.
23121 Don't use this packet. Use the @samp{Z} and @samp{z} packets instead
23122 (@pxref{insert breakpoint or watchpoint packet}).
23124 @item c @r{[}@var{addr}@r{]}
23125 @cindex @samp{c} packet
23126 Continue. @var{addr} is address to resume. If @var{addr} is omitted,
23127 resume at current address.
23130 @xref{Stop Reply Packets}, for the reply specifications.
23132 @item C @var{sig}@r{[};@var{addr}@r{]}
23133 @cindex @samp{C} packet
23134 Continue with signal @var{sig} (hex signal number). If
23135 @samp{;@var{addr}} is omitted, resume at same address.
23138 @xref{Stop Reply Packets}, for the reply specifications.
23141 @cindex @samp{d} packet
23144 Don't use this packet; instead, define a general set packet
23145 (@pxref{General Query Packets}).
23148 @cindex @samp{D} packet
23149 Detach @value{GDBN} from the remote system. Sent to the remote target
23150 before @value{GDBN} disconnects via the @code{detach} command.
23160 @item F @var{RC},@var{EE},@var{CF};@var{XX}
23161 @cindex @samp{F} packet
23162 A reply from @value{GDBN} to an @samp{F} packet sent by the target.
23163 This is part of the File-I/O protocol extension. @xref{File-I/O
23164 Remote Protocol Extension}, for the specification.
23167 @anchor{read registers packet}
23168 @cindex @samp{g} packet
23169 Read general registers.
23173 @item @var{XX@dots{}}
23174 Each byte of register data is described by two hex digits. The bytes
23175 with the register are transmitted in target byte order. The size of
23176 each register and their position within the @samp{g} packet are
23177 determined by the @value{GDBN} internal gdbarch functions
23178 @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The
23179 specification of several standard @samp{g} packets is specified below.
23184 @item G @var{XX@dots{}}
23185 @cindex @samp{G} packet
23186 Write general registers. @xref{read registers packet}, for a
23187 description of the @var{XX@dots{}} data.
23197 @item H @var{c} @var{t}
23198 @cindex @samp{H} packet
23199 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
23200 @samp{G}, et.al.). @var{c} depends on the operation to be performed: it
23201 should be @samp{c} for step and continue operations, @samp{g} for other
23202 operations. The thread designator @var{t} may be @samp{-1}, meaning all
23203 the threads, a thread number, or @samp{0} which means pick any thread.
23214 @c 'H': How restrictive (or permissive) is the thread model. If a
23215 @c thread is selected and stopped, are other threads allowed
23216 @c to continue to execute? As I mentioned above, I think the
23217 @c semantics of each command when a thread is selected must be
23218 @c described. For example:
23220 @c 'g': If the stub supports threads and a specific thread is
23221 @c selected, returns the register block from that thread;
23222 @c otherwise returns current registers.
23224 @c 'G' If the stub supports threads and a specific thread is
23225 @c selected, sets the registers of the register block of
23226 @c that thread; otherwise sets current registers.
23228 @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]}
23229 @anchor{cycle step packet}
23230 @cindex @samp{i} packet
23231 Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is
23232 present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle
23233 step starting at that address.
23236 @cindex @samp{I} packet
23237 Signal, then cycle step. @xref{step with signal packet}. @xref{cycle
23241 @cindex @samp{k} packet
23244 FIXME: @emph{There is no description of how to operate when a specific
23245 thread context has been selected (i.e.@: does 'k' kill only that
23248 @item m @var{addr},@var{length}
23249 @cindex @samp{m} packet
23250 Read @var{length} bytes of memory starting at address @var{addr}.
23251 Note that @var{addr} may not be aligned to any particular boundary.
23253 The stub need not use any particular size or alignment when gathering
23254 data from memory for the response; even if @var{addr} is word-aligned
23255 and @var{length} is a multiple of the word size, the stub is free to
23256 use byte accesses, or not. For this reason, this packet may not be
23257 suitable for accessing memory-mapped I/O devices.
23258 @cindex alignment of remote memory accesses
23259 @cindex size of remote memory accesses
23260 @cindex memory, alignment and size of remote accesses
23264 @item @var{XX@dots{}}
23265 Memory contents; each byte is transmitted as a two-digit hexadecimal
23266 number. The reply may contain fewer bytes than requested if the
23267 server was able to read only part of the region of memory.
23272 @item M @var{addr},@var{length}:@var{XX@dots{}}
23273 @cindex @samp{M} packet
23274 Write @var{length} bytes of memory starting at address @var{addr}.
23275 @var{XX@dots{}} is the data; each byte is transmitted as a two-digit
23276 hexadecimal number.
23283 for an error (this includes the case where only part of the data was
23288 @cindex @samp{p} packet
23289 Read the value of register @var{n}; @var{n} is in hex.
23290 @xref{read registers packet}, for a description of how the returned
23291 register value is encoded.
23295 @item @var{XX@dots{}}
23296 the register's value
23300 Indicating an unrecognized @var{query}.
23303 @item P @var{n@dots{}}=@var{r@dots{}}
23304 @anchor{write register packet}
23305 @cindex @samp{P} packet
23306 Write register @var{n@dots{}} with value @var{r@dots{}}. The register
23307 number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex
23308 digits for each byte in the register (target byte order).
23318 @item q @var{name} @var{params}@dots{}
23319 @itemx Q @var{name} @var{params}@dots{}
23320 @cindex @samp{q} packet
23321 @cindex @samp{Q} packet
23322 General query (@samp{q}) and set (@samp{Q}). These packets are
23323 described fully in @ref{General Query Packets}.
23326 @cindex @samp{r} packet
23327 Reset the entire system.
23329 Don't use this packet; use the @samp{R} packet instead.
23332 @cindex @samp{R} packet
23333 Restart the program being debugged. @var{XX}, while needed, is ignored.
23334 This packet is only available in extended mode.
23336 The @samp{R} packet has no reply.
23338 @item s @r{[}@var{addr}@r{]}
23339 @cindex @samp{s} packet
23340 Single step. @var{addr} is the address at which to resume. If
23341 @var{addr} is omitted, resume at same address.
23344 @xref{Stop Reply Packets}, for the reply specifications.
23346 @item S @var{sig}@r{[};@var{addr}@r{]}
23347 @anchor{step with signal packet}
23348 @cindex @samp{S} packet
23349 Step with signal. This is analogous to the @samp{C} packet, but
23350 requests a single-step, rather than a normal resumption of execution.
23353 @xref{Stop Reply Packets}, for the reply specifications.
23355 @item t @var{addr}:@var{PP},@var{MM}
23356 @cindex @samp{t} packet
23357 Search backwards starting at address @var{addr} for a match with pattern
23358 @var{PP} and mask @var{MM}. @var{PP} and @var{MM} are 4 bytes.
23359 @var{addr} must be at least 3 digits.
23362 @cindex @samp{T} packet
23363 Find out if the thread XX is alive.
23368 thread is still alive
23374 Packets starting with @samp{v} are identified by a multi-letter name,
23375 up to the first @samp{;} or @samp{?} (or the end of the packet).
23377 @item vCont@r{[};@var{action}@r{[}:@var{tid}@r{]]}@dots{}
23378 @cindex @samp{vCont} packet
23379 Resume the inferior, specifying different actions for each thread.
23380 If an action is specified with no @var{tid}, then it is applied to any
23381 threads that don't have a specific action specified; if no default action is
23382 specified then other threads should remain stopped. Specifying multiple
23383 default actions is an error; specifying no actions is also an error.
23384 Thread IDs are specified in hexadecimal. Currently supported actions are:
23390 Continue with signal @var{sig}. @var{sig} should be two hex digits.
23394 Step with signal @var{sig}. @var{sig} should be two hex digits.
23397 The optional @var{addr} argument normally associated with these packets is
23398 not supported in @samp{vCont}.
23401 @xref{Stop Reply Packets}, for the reply specifications.
23404 @cindex @samp{vCont?} packet
23405 Request a list of actions supported by the @samp{vCont} packet.
23409 @item vCont@r{[};@var{action}@dots{}@r{]}
23410 The @samp{vCont} packet is supported. Each @var{action} is a supported
23411 command in the @samp{vCont} packet.
23413 The @samp{vCont} packet is not supported.
23416 @item vFlashErase:@var{addr},@var{length}
23417 @cindex @samp{vFlashErase} packet
23418 Direct the stub to erase @var{length} bytes of flash starting at
23419 @var{addr}. The region may enclose any number of flash blocks, but
23420 its start and end must fall on block boundaries, as indicated by the
23421 flash block size appearing in the memory map (@pxref{Memory Map
23422 Format}). @value{GDBN} groups flash memory programming operations
23423 together, and sends a @samp{vFlashDone} request after each group; the
23424 stub is allowed to delay erase operation until the @samp{vFlashDone}
23425 packet is received.
23435 @item vFlashWrite:@var{addr}:@var{XX@dots{}}
23436 @cindex @samp{vFlashWrite} packet
23437 Direct the stub to write data to flash address @var{addr}. The data
23438 is passed in binary form using the same encoding as for the @samp{X}
23439 packet (@pxref{Binary Data}). The memory ranges specified by
23440 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
23441 not overlap, and must appear in order of increasing addresses
23442 (although @samp{vFlashErase} packets for higher addresses may already
23443 have been received; the ordering is guaranteed only between
23444 @samp{vFlashWrite} packets). If a packet writes to an address that was
23445 neither erased by a preceding @samp{vFlashErase} packet nor by some other
23446 target-specific method, the results are unpredictable.
23454 for vFlashWrite addressing non-flash memory
23460 @cindex @samp{vFlashDone} packet
23461 Indicate to the stub that flash programming operation is finished.
23462 The stub is permitted to delay or batch the effects of a group of
23463 @samp{vFlashErase} and @samp{vFlashWrite} packets until a
23464 @samp{vFlashDone} packet is received. The contents of the affected
23465 regions of flash memory are unpredictable until the @samp{vFlashDone}
23466 request is completed.
23468 @item X @var{addr},@var{length}:@var{XX@dots{}}
23470 @cindex @samp{X} packet
23471 Write data to memory, where the data is transmitted in binary.
23472 @var{addr} is address, @var{length} is number of bytes,
23473 @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}).
23483 @item z @var{type},@var{addr},@var{length}
23484 @itemx Z @var{type},@var{addr},@var{length}
23485 @anchor{insert breakpoint or watchpoint packet}
23486 @cindex @samp{z} packet
23487 @cindex @samp{Z} packets
23488 Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or
23489 watchpoint starting at address @var{address} and covering the next
23490 @var{length} bytes.
23492 Each breakpoint and watchpoint packet @var{type} is documented
23495 @emph{Implementation notes: A remote target shall return an empty string
23496 for an unrecognized breakpoint or watchpoint packet @var{type}. A
23497 remote target shall support either both or neither of a given
23498 @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To
23499 avoid potential problems with duplicate packets, the operations should
23500 be implemented in an idempotent way.}
23502 @item z0,@var{addr},@var{length}
23503 @itemx Z0,@var{addr},@var{length}
23504 @cindex @samp{z0} packet
23505 @cindex @samp{Z0} packet
23506 Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address
23507 @var{addr} of size @var{length}.
23509 A memory breakpoint is implemented by replacing the instruction at
23510 @var{addr} with a software breakpoint or trap instruction. The
23511 @var{length} is used by targets that indicates the size of the
23512 breakpoint (in bytes) that should be inserted (e.g., the @sc{arm} and
23513 @sc{mips} can insert either a 2 or 4 byte breakpoint).
23515 @emph{Implementation note: It is possible for a target to copy or move
23516 code that contains memory breakpoints (e.g., when implementing
23517 overlays). The behavior of this packet, in the presence of such a
23518 target, is not defined.}
23530 @item z1,@var{addr},@var{length}
23531 @itemx Z1,@var{addr},@var{length}
23532 @cindex @samp{z1} packet
23533 @cindex @samp{Z1} packet
23534 Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
23535 address @var{addr} of size @var{length}.
23537 A hardware breakpoint is implemented using a mechanism that is not
23538 dependant on being able to modify the target's memory.
23540 @emph{Implementation note: A hardware breakpoint is not affected by code
23553 @item z2,@var{addr},@var{length}
23554 @itemx Z2,@var{addr},@var{length}
23555 @cindex @samp{z2} packet
23556 @cindex @samp{Z2} packet
23557 Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint.
23569 @item z3,@var{addr},@var{length}
23570 @itemx Z3,@var{addr},@var{length}
23571 @cindex @samp{z3} packet
23572 @cindex @samp{Z3} packet
23573 Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint.
23585 @item z4,@var{addr},@var{length}
23586 @itemx Z4,@var{addr},@var{length}
23587 @cindex @samp{z4} packet
23588 @cindex @samp{Z4} packet
23589 Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint.
23603 @node Stop Reply Packets
23604 @section Stop Reply Packets
23605 @cindex stop reply packets
23607 The @samp{C}, @samp{c}, @samp{S}, @samp{s} and @samp{?} packets can
23608 receive any of the below as a reply. In the case of the @samp{C},
23609 @samp{c}, @samp{S} and @samp{s} packets, that reply is only returned
23610 when the target halts. In the below the exact meaning of @dfn{signal
23611 number} is defined by the header @file{include/gdb/signals.h} in the
23612 @value{GDBN} source code.
23614 As in the description of request packets, we include spaces in the
23615 reply templates for clarity; these are not part of the reply packet's
23616 syntax. No @value{GDBN} stop reply packet uses spaces to separate its
23622 The program received signal number @var{AA} (a two-digit hexadecimal
23623 number). This is equivalent to a @samp{T} response with no
23624 @var{n}:@var{r} pairs.
23626 @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{}
23627 @cindex @samp{T} packet reply
23628 The program received signal number @var{AA} (a two-digit hexadecimal
23629 number). This is equivalent to an @samp{S} response, except that the
23630 @samp{@var{n}:@var{r}} pairs can carry values of important registers
23631 and other information directly in the stop reply packet, reducing
23632 round-trip latency. Single-step and breakpoint traps are reported
23633 this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows:
23637 If @var{n} is a hexadecimal number, it is a register number, and the
23638 corresponding @var{r} gives that register's value. @var{r} is a
23639 series of bytes in target byte order, with each byte given by a
23640 two-digit hex number.
23643 If @var{n} is @samp{thread}, then @var{r} is the thread process ID, in
23647 If @var{n} is a recognized @dfn{stop reason}, it describes a more
23648 specific event that stopped the target. The currently defined stop
23649 reasons are listed below. @var{aa} should be @samp{05}, the trap
23650 signal. At most one stop reason should be present.
23653 Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair
23654 and go on to the next; this allows us to extend the protocol in the
23658 The currently defined stop reasons are:
23664 The packet indicates a watchpoint hit, and @var{r} is the data address, in
23667 @cindex shared library events, remote reply
23669 The packet indicates that the loaded libraries have changed.
23670 @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
23671 list of loaded libraries. @var{r} is ignored.
23675 The process exited, and @var{AA} is the exit status. This is only
23676 applicable to certain targets.
23679 The process terminated with signal @var{AA}.
23681 @item O @var{XX}@dots{}
23682 @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be
23683 written as the program's console output. This can happen at any time
23684 while the program is running and the debugger should continue to wait
23685 for @samp{W}, @samp{T}, etc.
23687 @item F @var{call-id},@var{parameter}@dots{}
23688 @var{call-id} is the identifier which says which host system call should
23689 be called. This is just the name of the function. Translation into the
23690 correct system call is only applicable as it's defined in @value{GDBN}.
23691 @xref{File-I/O Remote Protocol Extension}, for a list of implemented
23694 @samp{@var{parameter}@dots{}} is a list of parameters as defined for
23695 this very system call.
23697 The target replies with this packet when it expects @value{GDBN} to
23698 call a host system call on behalf of the target. @value{GDBN} replies
23699 with an appropriate @samp{F} packet and keeps up waiting for the next
23700 reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S}
23701 or @samp{s} action is expected to be continued. @xref{File-I/O Remote
23702 Protocol Extension}, for more details.
23706 @node General Query Packets
23707 @section General Query Packets
23708 @cindex remote query requests
23710 Packets starting with @samp{q} are @dfn{general query packets};
23711 packets starting with @samp{Q} are @dfn{general set packets}. General
23712 query and set packets are a semi-unified form for retrieving and
23713 sending information to and from the stub.
23715 The initial letter of a query or set packet is followed by a name
23716 indicating what sort of thing the packet applies to. For example,
23717 @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
23718 definitions with the stub. These packet names follow some
23723 The name must not contain commas, colons or semicolons.
23725 Most @value{GDBN} query and set packets have a leading upper case
23728 The names of custom vendor packets should use a company prefix, in
23729 lower case, followed by a period. For example, packets designed at
23730 the Acme Corporation might begin with @samp{qacme.foo} (for querying
23731 foos) or @samp{Qacme.bar} (for setting bars).
23734 The name of a query or set packet should be separated from any
23735 parameters by a @samp{:}; the parameters themselves should be
23736 separated by @samp{,} or @samp{;}. Stubs must be careful to match the
23737 full packet name, and check for a separator or the end of the packet,
23738 in case two packet names share a common prefix. New packets should not begin
23739 with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL}
23740 packets predate these conventions, and have arguments without any terminator
23741 for the packet name; we suspect they are in widespread use in places that
23742 are difficult to upgrade. The @samp{qC} packet has no arguments, but some
23743 existing stubs (e.g.@: RedBoot) are known to not check for the end of the
23746 Like the descriptions of the other packets, each description here
23747 has a template showing the packet's overall syntax, followed by an
23748 explanation of the packet's meaning. We include spaces in some of the
23749 templates for clarity; these are not part of the packet's syntax. No
23750 @value{GDBN} packet uses spaces to separate its components.
23752 Here are the currently defined query and set packets:
23757 @cindex current thread, remote request
23758 @cindex @samp{qC} packet
23759 Return the current thread id.
23764 Where @var{pid} is an unsigned hexadecimal process id.
23765 @item @r{(anything else)}
23766 Any other reply implies the old pid.
23769 @item qCRC:@var{addr},@var{length}
23770 @cindex CRC of memory block, remote request
23771 @cindex @samp{qCRC} packet
23772 Compute the CRC checksum of a block of memory.
23776 An error (such as memory fault)
23777 @item C @var{crc32}
23778 The specified memory region's checksum is @var{crc32}.
23782 @itemx qsThreadInfo
23783 @cindex list active threads, remote request
23784 @cindex @samp{qfThreadInfo} packet
23785 @cindex @samp{qsThreadInfo} packet
23786 Obtain a list of all active thread ids from the target (OS). Since there
23787 may be too many active threads to fit into one reply packet, this query
23788 works iteratively: it may require more than one query/reply sequence to
23789 obtain the entire list of threads. The first query of the sequence will
23790 be the @samp{qfThreadInfo} query; subsequent queries in the
23791 sequence will be the @samp{qsThreadInfo} query.
23793 NOTE: This packet replaces the @samp{qL} query (see below).
23799 @item m @var{id},@var{id}@dots{}
23800 a comma-separated list of thread ids
23802 (lower case letter @samp{L}) denotes end of list.
23805 In response to each query, the target will reply with a list of one or
23806 more thread ids, in big-endian unsigned hex, separated by commas.
23807 @value{GDBN} will respond to each reply with a request for more thread
23808 ids (using the @samp{qs} form of the query), until the target responds
23809 with @samp{l} (lower-case el, for @dfn{last}).
23811 @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm}
23812 @cindex get thread-local storage address, remote request
23813 @cindex @samp{qGetTLSAddr} packet
23814 Fetch the address associated with thread local storage specified
23815 by @var{thread-id}, @var{offset}, and @var{lm}.
23817 @var{thread-id} is the (big endian, hex encoded) thread id associated with the
23818 thread for which to fetch the TLS address.
23820 @var{offset} is the (big endian, hex encoded) offset associated with the
23821 thread local variable. (This offset is obtained from the debug
23822 information associated with the variable.)
23824 @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the
23825 the load module associated with the thread local storage. For example,
23826 a @sc{gnu}/Linux system will pass the link map address of the shared
23827 object associated with the thread local storage under consideration.
23828 Other operating environments may choose to represent the load module
23829 differently, so the precise meaning of this parameter will vary.
23833 @item @var{XX}@dots{}
23834 Hex encoded (big endian) bytes representing the address of the thread
23835 local storage requested.
23838 An error occurred. @var{nn} are hex digits.
23841 An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub.
23844 @item qL @var{startflag} @var{threadcount} @var{nextthread}
23845 Obtain thread information from RTOS. Where: @var{startflag} (one hex
23846 digit) is one to indicate the first query and zero to indicate a
23847 subsequent query; @var{threadcount} (two hex digits) is the maximum
23848 number of threads the response packet can contain; and @var{nextthread}
23849 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
23850 returned in the response as @var{argthread}.
23852 Don't use this packet; use the @samp{qfThreadInfo} query instead (see above).
23856 @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{}
23857 Where: @var{count} (two hex digits) is the number of threads being
23858 returned; @var{done} (one hex digit) is zero to indicate more threads
23859 and one indicates no further threads; @var{argthreadid} (eight hex
23860 digits) is @var{nextthread} from the request packet; @var{thread}@dots{}
23861 is a sequence of thread IDs from the target. @var{threadid} (eight hex
23862 digits). See @code{remote.c:parse_threadlist_response()}.
23866 @cindex section offsets, remote request
23867 @cindex @samp{qOffsets} packet
23868 Get section offsets that the target used when relocating the downloaded
23873 @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]}
23874 Relocate the @code{Text} section by @var{xxx} from its original address.
23875 Relocate the @code{Data} section by @var{yyy} from its original address.
23876 If the object file format provides segment information (e.g.@: @sc{elf}
23877 @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire
23878 segments by the supplied offsets.
23880 @emph{Note: while a @code{Bss} offset may be included in the response,
23881 @value{GDBN} ignores this and instead applies the @code{Data} offset
23882 to the @code{Bss} section.}
23884 @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]}
23885 Relocate the first segment of the object file, which conventionally
23886 contains program code, to a starting address of @var{xxx}. If
23887 @samp{DataSeg} is specified, relocate the second segment, which
23888 conventionally contains modifiable data, to a starting address of
23889 @var{yyy}. @value{GDBN} will report an error if the object file
23890 does not contain segment information, or does not contain at least
23891 as many segments as mentioned in the reply. Extra segments are
23892 kept at fixed offsets relative to the last relocated segment.
23895 @item qP @var{mode} @var{threadid}
23896 @cindex thread information, remote request
23897 @cindex @samp{qP} packet
23898 Returns information on @var{threadid}. Where: @var{mode} is a hex
23899 encoded 32 bit mode; @var{threadid} is a hex encoded 64 bit thread ID.
23901 Don't use this packet; use the @samp{qThreadExtraInfo} query instead
23904 Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
23906 @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
23907 @cindex pass signals to inferior, remote request
23908 @cindex @samp{QPassSignals} packet
23909 @anchor{QPassSignals}
23910 Each listed @var{signal} should be passed directly to the inferior process.
23911 Signals are numbered identically to continue packets and stop replies
23912 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
23913 strictly greater than the previous item. These signals do not need to stop
23914 the inferior, or be reported to @value{GDBN}. All other signals should be
23915 reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not
23916 combine; any earlier @samp{QPassSignals} list is completely replaced by the
23917 new list. This packet improves performance when using @samp{handle
23918 @var{signal} nostop noprint pass}.
23923 The request succeeded.
23926 An error occurred. @var{nn} are hex digits.
23929 An empty reply indicates that @samp{QPassSignals} is not supported by
23933 Use of this packet is controlled by the @code{set remote pass-signals}
23934 command (@pxref{Remote Configuration, set remote pass-signals}).
23935 This packet is not probed by default; the remote stub must request it,
23936 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
23938 @item qRcmd,@var{command}
23939 @cindex execute remote command, remote request
23940 @cindex @samp{qRcmd} packet
23941 @var{command} (hex encoded) is passed to the local interpreter for
23942 execution. Invalid commands should be reported using the output
23943 string. Before the final result packet, the target may also respond
23944 with a number of intermediate @samp{O@var{output}} console output
23945 packets. @emph{Implementors should note that providing access to a
23946 stubs's interpreter may have security implications}.
23951 A command response with no output.
23953 A command response with the hex encoded output string @var{OUTPUT}.
23955 Indicate a badly formed request.
23957 An empty reply indicates that @samp{qRcmd} is not recognized.
23960 (Note that the @code{qRcmd} packet's name is separated from the
23961 command by a @samp{,}, not a @samp{:}, contrary to the naming
23962 conventions above. Please don't use this packet as a model for new
23965 @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]}
23966 @cindex supported packets, remote query
23967 @cindex features of the remote protocol
23968 @cindex @samp{qSupported} packet
23969 @anchor{qSupported}
23970 Tell the remote stub about features supported by @value{GDBN}, and
23971 query the stub for features it supports. This packet allows
23972 @value{GDBN} and the remote stub to take advantage of each others'
23973 features. @samp{qSupported} also consolidates multiple feature probes
23974 at startup, to improve @value{GDBN} performance---a single larger
23975 packet performs better than multiple smaller probe packets on
23976 high-latency links. Some features may enable behavior which must not
23977 be on by default, e.g.@: because it would confuse older clients or
23978 stubs. Other features may describe packets which could be
23979 automatically probed for, but are not. These features must be
23980 reported before @value{GDBN} will use them. This ``default
23981 unsupported'' behavior is not appropriate for all packets, but it
23982 helps to keep the initial connection time under control with new
23983 versions of @value{GDBN} which support increasing numbers of packets.
23987 @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{}
23988 The stub supports or does not support each returned @var{stubfeature},
23989 depending on the form of each @var{stubfeature} (see below for the
23992 An empty reply indicates that @samp{qSupported} is not recognized,
23993 or that no features needed to be reported to @value{GDBN}.
23996 The allowed forms for each feature (either a @var{gdbfeature} in the
23997 @samp{qSupported} packet, or a @var{stubfeature} in the response)
24001 @item @var{name}=@var{value}
24002 The remote protocol feature @var{name} is supported, and associated
24003 with the specified @var{value}. The format of @var{value} depends
24004 on the feature, but it must not include a semicolon.
24006 The remote protocol feature @var{name} is supported, and does not
24007 need an associated value.
24009 The remote protocol feature @var{name} is not supported.
24011 The remote protocol feature @var{name} may be supported, and
24012 @value{GDBN} should auto-detect support in some other way when it is
24013 needed. This form will not be used for @var{gdbfeature} notifications,
24014 but may be used for @var{stubfeature} responses.
24017 Whenever the stub receives a @samp{qSupported} request, the
24018 supplied set of @value{GDBN} features should override any previous
24019 request. This allows @value{GDBN} to put the stub in a known
24020 state, even if the stub had previously been communicating with
24021 a different version of @value{GDBN}.
24023 No values of @var{gdbfeature} (for the packet sent by @value{GDBN})
24024 are defined yet. Stubs should ignore any unknown values for
24025 @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported}
24026 packet supports receiving packets of unlimited length (earlier
24027 versions of @value{GDBN} may reject overly long responses). Values
24028 for @var{gdbfeature} may be defined in the future to let the stub take
24029 advantage of new features in @value{GDBN}, e.g.@: incompatible
24030 improvements in the remote protocol---support for unlimited length
24031 responses would be a @var{gdbfeature} example, if it were not implied by
24032 the @samp{qSupported} query. The stub's reply should be independent
24033 of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN}
24034 describes all the features it supports, and then the stub replies with
24035 all the features it supports.
24037 Similarly, @value{GDBN} will silently ignore unrecognized stub feature
24038 responses, as long as each response uses one of the standard forms.
24040 Some features are flags. A stub which supports a flag feature
24041 should respond with a @samp{+} form response. Other features
24042 require values, and the stub should respond with an @samp{=}
24045 Each feature has a default value, which @value{GDBN} will use if
24046 @samp{qSupported} is not available or if the feature is not mentioned
24047 in the @samp{qSupported} response. The default values are fixed; a
24048 stub is free to omit any feature responses that match the defaults.
24050 Not all features can be probed, but for those which can, the probing
24051 mechanism is useful: in some cases, a stub's internal
24052 architecture may not allow the protocol layer to know some information
24053 about the underlying target in advance. This is especially common in
24054 stubs which may be configured for multiple targets.
24056 These are the currently defined stub features and their properties:
24058 @multitable @columnfractions 0.35 0.2 0.12 0.2
24059 @c NOTE: The first row should be @headitem, but we do not yet require
24060 @c a new enough version of Texinfo (4.7) to use @headitem.
24062 @tab Value Required
24066 @item @samp{PacketSize}
24071 @item @samp{qXfer:auxv:read}
24076 @item @samp{qXfer:features:read}
24081 @item @samp{qXfer:libraries:read}
24086 @item @samp{qXfer:memory-map:read}
24091 @item @samp{qXfer:spu:read}
24096 @item @samp{qXfer:spu:write}
24101 @item @samp{QPassSignals}
24108 These are the currently defined stub features, in more detail:
24111 @cindex packet size, remote protocol
24112 @item PacketSize=@var{bytes}
24113 The remote stub can accept packets up to at least @var{bytes} in
24114 length. @value{GDBN} will send packets up to this size for bulk
24115 transfers, and will never send larger packets. This is a limit on the
24116 data characters in the packet, including the frame and checksum.
24117 There is no trailing NUL byte in a remote protocol packet; if the stub
24118 stores packets in a NUL-terminated format, it should allow an extra
24119 byte in its buffer for the NUL. If this stub feature is not supported,
24120 @value{GDBN} guesses based on the size of the @samp{g} packet response.
24122 @item qXfer:auxv:read
24123 The remote stub understands the @samp{qXfer:auxv:read} packet
24124 (@pxref{qXfer auxiliary vector read}).
24126 @item qXfer:features:read
24127 The remote stub understands the @samp{qXfer:features:read} packet
24128 (@pxref{qXfer target description read}).
24130 @item qXfer:libraries:read
24131 The remote stub understands the @samp{qXfer:libraries:read} packet
24132 (@pxref{qXfer library list read}).
24134 @item qXfer:memory-map:read
24135 The remote stub understands the @samp{qXfer:memory-map:read} packet
24136 (@pxref{qXfer memory map read}).
24138 @item qXfer:spu:read
24139 The remote stub understands the @samp{qXfer:spu:read} packet
24140 (@pxref{qXfer spu read}).
24142 @item qXfer:spu:write
24143 The remote stub understands the @samp{qXfer:spu:write} packet
24144 (@pxref{qXfer spu write}).
24147 The remote stub understands the @samp{QPassSignals} packet
24148 (@pxref{QPassSignals}).
24153 @cindex symbol lookup, remote request
24154 @cindex @samp{qSymbol} packet
24155 Notify the target that @value{GDBN} is prepared to serve symbol lookup
24156 requests. Accept requests from the target for the values of symbols.
24161 The target does not need to look up any (more) symbols.
24162 @item qSymbol:@var{sym_name}
24163 The target requests the value of symbol @var{sym_name} (hex encoded).
24164 @value{GDBN} may provide the value by using the
24165 @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described
24169 @item qSymbol:@var{sym_value}:@var{sym_name}
24170 Set the value of @var{sym_name} to @var{sym_value}.
24172 @var{sym_name} (hex encoded) is the name of a symbol whose value the
24173 target has previously requested.
24175 @var{sym_value} (hex) is the value for symbol @var{sym_name}. If
24176 @value{GDBN} cannot supply a value for @var{sym_name}, then this field
24182 The target does not need to look up any (more) symbols.
24183 @item qSymbol:@var{sym_name}
24184 The target requests the value of a new symbol @var{sym_name} (hex
24185 encoded). @value{GDBN} will continue to supply the values of symbols
24186 (if available), until the target ceases to request them.
24191 @xref{Tracepoint Packets}.
24193 @item qThreadExtraInfo,@var{id}
24194 @cindex thread attributes info, remote request
24195 @cindex @samp{qThreadExtraInfo} packet
24196 Obtain a printable string description of a thread's attributes from
24197 the target OS. @var{id} is a thread-id in big-endian hex. This
24198 string may contain anything that the target OS thinks is interesting
24199 for @value{GDBN} to tell the user about the thread. The string is
24200 displayed in @value{GDBN}'s @code{info threads} display. Some
24201 examples of possible thread extra info strings are @samp{Runnable}, or
24202 @samp{Blocked on Mutex}.
24206 @item @var{XX}@dots{}
24207 Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data,
24208 comprising the printable string containing the extra information about
24209 the thread's attributes.
24212 (Note that the @code{qThreadExtraInfo} packet's name is separated from
24213 the command by a @samp{,}, not a @samp{:}, contrary to the naming
24214 conventions above. Please don't use this packet as a model for new
24222 @xref{Tracepoint Packets}.
24224 @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length}
24225 @cindex read special object, remote request
24226 @cindex @samp{qXfer} packet
24227 @anchor{qXfer read}
24228 Read uninterpreted bytes from the target's special data area
24229 identified by the keyword @var{object}. Request @var{length} bytes
24230 starting at @var{offset} bytes into the data. The content and
24231 encoding of @var{annex} is specific to @var{object}; it can supply
24232 additional details about what data to access.
24234 Here are the specific requests of this form defined so far. All
24235 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
24236 formats, listed below.
24239 @item qXfer:auxv:read::@var{offset},@var{length}
24240 @anchor{qXfer auxiliary vector read}
24241 Access the target's @dfn{auxiliary vector}. @xref{OS Information,
24242 auxiliary vector}. Note @var{annex} must be empty.
24244 This packet is not probed by default; the remote stub must request it,
24245 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24247 @item qXfer:features:read:@var{annex}:@var{offset},@var{length}
24248 @anchor{qXfer target description read}
24249 Access the @dfn{target description}. @xref{Target Descriptions}. The
24250 annex specifies which XML document to access. The main description is
24251 always loaded from the @samp{target.xml} annex.
24253 This packet is not probed by default; the remote stub must request it,
24254 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24256 @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length}
24257 @anchor{qXfer library list read}
24258 Access the target's list of loaded libraries. @xref{Library List Format}.
24259 The annex part of the generic @samp{qXfer} packet must be empty
24260 (@pxref{qXfer read}).
24262 Targets which maintain a list of libraries in the program's memory do
24263 not need to implement this packet; it is designed for platforms where
24264 the operating system manages the list of loaded libraries.
24266 This packet is not probed by default; the remote stub must request it,
24267 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24269 @item qXfer:memory-map:read::@var{offset},@var{length}
24270 @anchor{qXfer memory map read}
24271 Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The
24272 annex part of the generic @samp{qXfer} packet must be empty
24273 (@pxref{qXfer read}).
24275 This packet is not probed by default; the remote stub must request it,
24276 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24278 @item qXfer:spu:read:@var{annex}:@var{offset},@var{length}
24279 @anchor{qXfer spu read}
24280 Read contents of an @code{spufs} file on the target system. The
24281 annex specifies which file to read; it must be of the form
24282 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
24283 in the target process, and @var{name} identifes the @code{spufs} file
24284 in that context to be accessed.
24286 This packet is not probed by default; the remote stub must request it,
24287 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24293 Data @var{data} (@pxref{Binary Data}) has been read from the
24294 target. There may be more data at a higher address (although
24295 it is permitted to return @samp{m} even for the last valid
24296 block of data, as long as at least one byte of data was read).
24297 @var{data} may have fewer bytes than the @var{length} in the
24301 Data @var{data} (@pxref{Binary Data}) has been read from the target.
24302 There is no more data to be read. @var{data} may have fewer bytes
24303 than the @var{length} in the request.
24306 The @var{offset} in the request is at the end of the data.
24307 There is no more data to be read.
24310 The request was malformed, or @var{annex} was invalid.
24313 The offset was invalid, or there was an error encountered reading the data.
24314 @var{nn} is a hex-encoded @code{errno} value.
24317 An empty reply indicates the @var{object} string was not recognized by
24318 the stub, or that the object does not support reading.
24321 @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{}
24322 @cindex write data into object, remote request
24323 Write uninterpreted bytes into the target's special data area
24324 identified by the keyword @var{object}, starting at @var{offset} bytes
24325 into the data. @var{data}@dots{} is the binary-encoded data
24326 (@pxref{Binary Data}) to be written. The content and encoding of @var{annex}
24327 is specific to @var{object}; it can supply additional details about what data
24330 Here are the specific requests of this form defined so far. All
24331 @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply
24332 formats, listed below.
24335 @item qXfer:@var{spu}:write:@var{annex}:@var{offset}:@var{data}@dots{}
24336 @anchor{qXfer spu write}
24337 Write @var{data} to an @code{spufs} file on the target system. The
24338 annex specifies which file to write; it must be of the form
24339 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
24340 in the target process, and @var{name} identifes the @code{spufs} file
24341 in that context to be accessed.
24343 This packet is not probed by default; the remote stub must request it,
24344 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
24350 @var{nn} (hex encoded) is the number of bytes written.
24351 This may be fewer bytes than supplied in the request.
24354 The request was malformed, or @var{annex} was invalid.
24357 The offset was invalid, or there was an error encountered writing the data.
24358 @var{nn} is a hex-encoded @code{errno} value.
24361 An empty reply indicates the @var{object} string was not
24362 recognized by the stub, or that the object does not support writing.
24365 @item qXfer:@var{object}:@var{operation}:@dots{}
24366 Requests of this form may be added in the future. When a stub does
24367 not recognize the @var{object} keyword, or its support for
24368 @var{object} does not recognize the @var{operation} keyword, the stub
24369 must respond with an empty packet.
24373 @node Register Packet Format
24374 @section Register Packet Format
24376 The following @code{g}/@code{G} packets have previously been defined.
24377 In the below, some thirty-two bit registers are transferred as
24378 sixty-four bits. Those registers should be zero/sign extended (which?)
24379 to fill the space allocated. Register bytes are transferred in target
24380 byte order. The two nibbles within a register byte are transferred
24381 most-significant - least-significant.
24387 All registers are transferred as thirty-two bit quantities in the order:
24388 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
24389 registers; fsr; fir; fp.
24393 All registers are transferred as sixty-four bit quantities (including
24394 thirty-two bit registers such as @code{sr}). The ordering is the same
24399 @node Tracepoint Packets
24400 @section Tracepoint Packets
24401 @cindex tracepoint packets
24402 @cindex packets, tracepoint
24404 Here we describe the packets @value{GDBN} uses to implement
24405 tracepoints (@pxref{Tracepoints}).
24409 @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}@r{[}-@r{]}
24410 Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena}
24411 is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then
24412 the tracepoint is disabled. @var{step} is the tracepoint's step
24413 count, and @var{pass} is its pass count. If the trailing @samp{-} is
24414 present, further @samp{QTDP} packets will follow to specify this
24415 tracepoint's actions.
24420 The packet was understood and carried out.
24422 The packet was not recognized.
24425 @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]}
24426 Define actions to be taken when a tracepoint is hit. @var{n} and
24427 @var{addr} must be the same as in the initial @samp{QTDP} packet for
24428 this tracepoint. This packet may only be sent immediately after
24429 another @samp{QTDP} packet that ended with a @samp{-}. If the
24430 trailing @samp{-} is present, further @samp{QTDP} packets will follow,
24431 specifying more actions for this tracepoint.
24433 In the series of action packets for a given tracepoint, at most one
24434 can have an @samp{S} before its first @var{action}. If such a packet
24435 is sent, it and the following packets define ``while-stepping''
24436 actions. Any prior packets define ordinary actions --- that is, those
24437 taken when the tracepoint is first hit. If no action packet has an
24438 @samp{S}, then all the packets in the series specify ordinary
24439 tracepoint actions.
24441 The @samp{@var{action}@dots{}} portion of the packet is a series of
24442 actions, concatenated without separators. Each action has one of the
24448 Collect the registers whose bits are set in @var{mask}. @var{mask} is
24449 a hexadecimal number whose @var{i}'th bit is set if register number
24450 @var{i} should be collected. (The least significant bit is numbered
24451 zero.) Note that @var{mask} may be any number of digits long; it may
24452 not fit in a 32-bit word.
24454 @item M @var{basereg},@var{offset},@var{len}
24455 Collect @var{len} bytes of memory starting at the address in register
24456 number @var{basereg}, plus @var{offset}. If @var{basereg} is
24457 @samp{-1}, then the range has a fixed address: @var{offset} is the
24458 address of the lowest byte to collect. The @var{basereg},
24459 @var{offset}, and @var{len} parameters are all unsigned hexadecimal
24460 values (the @samp{-1} value for @var{basereg} is a special case).
24462 @item X @var{len},@var{expr}
24463 Evaluate @var{expr}, whose length is @var{len}, and collect memory as
24464 it directs. @var{expr} is an agent expression, as described in
24465 @ref{Agent Expressions}. Each byte of the expression is encoded as a
24466 two-digit hex number in the packet; @var{len} is the number of bytes
24467 in the expression (and thus one-half the number of hex digits in the
24472 Any number of actions may be packed together in a single @samp{QTDP}
24473 packet, as long as the packet does not exceed the maximum packet
24474 length (400 bytes, for many stubs). There may be only one @samp{R}
24475 action per tracepoint, and it must precede any @samp{M} or @samp{X}
24476 actions. Any registers referred to by @samp{M} and @samp{X} actions
24477 must be collected by a preceding @samp{R} action. (The
24478 ``while-stepping'' actions are treated as if they were attached to a
24479 separate tracepoint, as far as these restrictions are concerned.)
24484 The packet was understood and carried out.
24486 The packet was not recognized.
24489 @item QTFrame:@var{n}
24490 Select the @var{n}'th tracepoint frame from the buffer, and use the
24491 register and memory contents recorded there to answer subsequent
24492 request packets from @value{GDBN}.
24494 A successful reply from the stub indicates that the stub has found the
24495 requested frame. The response is a series of parts, concatenated
24496 without separators, describing the frame we selected. Each part has
24497 one of the following forms:
24501 The selected frame is number @var{n} in the trace frame buffer;
24502 @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there
24503 was no frame matching the criteria in the request packet.
24506 The selected trace frame records a hit of tracepoint number @var{t};
24507 @var{t} is a hexadecimal number.
24511 @item QTFrame:pc:@var{addr}
24512 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
24513 currently selected frame whose PC is @var{addr};
24514 @var{addr} is a hexadecimal number.
24516 @item QTFrame:tdp:@var{t}
24517 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
24518 currently selected frame that is a hit of tracepoint @var{t}; @var{t}
24519 is a hexadecimal number.
24521 @item QTFrame:range:@var{start}:@var{end}
24522 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
24523 currently selected frame whose PC is between @var{start} (inclusive)
24524 and @var{end} (exclusive); @var{start} and @var{end} are hexadecimal
24527 @item QTFrame:outside:@var{start}:@var{end}
24528 Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first
24529 frame @emph{outside} the given range of addresses.
24532 Begin the tracepoint experiment. Begin collecting data from tracepoint
24533 hits in the trace frame buffer.
24536 End the tracepoint experiment. Stop collecting trace frames.
24539 Clear the table of tracepoints, and empty the trace frame buffer.
24541 @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{}
24542 Establish the given ranges of memory as ``transparent''. The stub
24543 will answer requests for these ranges from memory's current contents,
24544 if they were not collected as part of the tracepoint hit.
24546 @value{GDBN} uses this to mark read-only regions of memory, like those
24547 containing program code. Since these areas never change, they should
24548 still have the same contents they did when the tracepoint was hit, so
24549 there's no reason for the stub to refuse to provide their contents.
24552 Ask the stub if there is a trace experiment running right now.
24557 There is no trace experiment running.
24559 There is a trace experiment running.
24566 @section Interrupts
24567 @cindex interrupts (remote protocol)
24569 When a program on the remote target is running, @value{GDBN} may
24570 attempt to interrupt it by sending a @samp{Ctrl-C} or a @code{BREAK},
24571 control of which is specified via @value{GDBN}'s @samp{remotebreak}
24572 setting (@pxref{set remotebreak}).
24574 The precise meaning of @code{BREAK} is defined by the transport
24575 mechanism and may, in fact, be undefined. @value{GDBN} does
24576 not currently define a @code{BREAK} mechanism for any of the network
24579 @samp{Ctrl-C}, on the other hand, is defined and implemented for all
24580 transport mechanisms. It is represented by sending the single byte
24581 @code{0x03} without any of the usual packet overhead described in
24582 the Overview section (@pxref{Overview}). When a @code{0x03} byte is
24583 transmitted as part of a packet, it is considered to be packet data
24584 and does @emph{not} represent an interrupt. E.g., an @samp{X} packet
24585 (@pxref{X packet}), used for binary downloads, may include an unescaped
24586 @code{0x03} as part of its packet.
24588 Stubs are not required to recognize these interrupt mechanisms and the
24589 precise meaning associated with receipt of the interrupt is
24590 implementation defined. If the stub is successful at interrupting the
24591 running program, it is expected that it will send one of the Stop
24592 Reply Packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result
24593 of successfully stopping the program. Interrupts received while the
24594 program is stopped will be discarded.
24599 Example sequence of a target being re-started. Notice how the restart
24600 does not get any direct output:
24605 @emph{target restarts}
24608 <- @code{T001:1234123412341234}
24612 Example sequence of a target being stepped by a single instruction:
24615 -> @code{G1445@dots{}}
24620 <- @code{T001:1234123412341234}
24624 <- @code{1455@dots{}}
24628 @node File-I/O Remote Protocol Extension
24629 @section File-I/O Remote Protocol Extension
24630 @cindex File-I/O remote protocol extension
24633 * File-I/O Overview::
24634 * Protocol Basics::
24635 * The F Request Packet::
24636 * The F Reply Packet::
24637 * The Ctrl-C Message::
24639 * List of Supported Calls::
24640 * Protocol-specific Representation of Datatypes::
24642 * File-I/O Examples::
24645 @node File-I/O Overview
24646 @subsection File-I/O Overview
24647 @cindex file-i/o overview
24649 The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the
24650 target to use the host's file system and console I/O to perform various
24651 system calls. System calls on the target system are translated into a
24652 remote protocol packet to the host system, which then performs the needed
24653 actions and returns a response packet to the target system.
24654 This simulates file system operations even on targets that lack file systems.
24656 The protocol is defined to be independent of both the host and target systems.
24657 It uses its own internal representation of datatypes and values. Both
24658 @value{GDBN} and the target's @value{GDBN} stub are responsible for
24659 translating the system-dependent value representations into the internal
24660 protocol representations when data is transmitted.
24662 The communication is synchronous. A system call is possible only when
24663 @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S}
24664 or @samp{s} packets. While @value{GDBN} handles the request for a system call,
24665 the target is stopped to allow deterministic access to the target's
24666 memory. Therefore File-I/O is not interruptible by target signals. On
24667 the other hand, it is possible to interrupt File-I/O by a user interrupt
24668 (@samp{Ctrl-C}) within @value{GDBN}.
24670 The target's request to perform a host system call does not finish
24671 the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means,
24672 after finishing the system call, the target returns to continuing the
24673 previous activity (continue, step). No additional continue or step
24674 request from @value{GDBN} is required.
24677 (@value{GDBP}) continue
24678 <- target requests 'system call X'
24679 target is stopped, @value{GDBN} executes system call
24680 -> @value{GDBN} returns result
24681 ... target continues, @value{GDBN} returns to wait for the target
24682 <- target hits breakpoint and sends a Txx packet
24685 The protocol only supports I/O on the console and to regular files on
24686 the host file system. Character or block special devices, pipes,
24687 named pipes, sockets or any other communication method on the host
24688 system are not supported by this protocol.
24690 @node Protocol Basics
24691 @subsection Protocol Basics
24692 @cindex protocol basics, file-i/o
24694 The File-I/O protocol uses the @code{F} packet as the request as well
24695 as reply packet. Since a File-I/O system call can only occur when
24696 @value{GDBN} is waiting for a response from the continuing or stepping target,
24697 the File-I/O request is a reply that @value{GDBN} has to expect as a result
24698 of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet.
24699 This @code{F} packet contains all information needed to allow @value{GDBN}
24700 to call the appropriate host system call:
24704 A unique identifier for the requested system call.
24707 All parameters to the system call. Pointers are given as addresses
24708 in the target memory address space. Pointers to strings are given as
24709 pointer/length pair. Numerical values are given as they are.
24710 Numerical control flags are given in a protocol-specific representation.
24714 At this point, @value{GDBN} has to perform the following actions.
24718 If the parameters include pointer values to data needed as input to a
24719 system call, @value{GDBN} requests this data from the target with a
24720 standard @code{m} packet request. This additional communication has to be
24721 expected by the target implementation and is handled as any other @code{m}
24725 @value{GDBN} translates all value from protocol representation to host
24726 representation as needed. Datatypes are coerced into the host types.
24729 @value{GDBN} calls the system call.
24732 It then coerces datatypes back to protocol representation.
24735 If the system call is expected to return data in buffer space specified
24736 by pointer parameters to the call, the data is transmitted to the
24737 target using a @code{M} or @code{X} packet. This packet has to be expected
24738 by the target implementation and is handled as any other @code{M} or @code{X}
24743 Eventually @value{GDBN} replies with another @code{F} packet which contains all
24744 necessary information for the target to continue. This at least contains
24751 @code{errno}, if has been changed by the system call.
24758 After having done the needed type and value coercion, the target continues
24759 the latest continue or step action.
24761 @node The F Request Packet
24762 @subsection The @code{F} Request Packet
24763 @cindex file-i/o request packet
24764 @cindex @code{F} request packet
24766 The @code{F} request packet has the following format:
24769 @item F@var{call-id},@var{parameter@dots{}}
24771 @var{call-id} is the identifier to indicate the host system call to be called.
24772 This is just the name of the function.
24774 @var{parameter@dots{}} are the parameters to the system call.
24775 Parameters are hexadecimal integer values, either the actual values in case
24776 of scalar datatypes, pointers to target buffer space in case of compound
24777 datatypes and unspecified memory areas, or pointer/length pairs in case
24778 of string parameters. These are appended to the @var{call-id} as a
24779 comma-delimited list. All values are transmitted in ASCII
24780 string representation, pointer/length pairs separated by a slash.
24786 @node The F Reply Packet
24787 @subsection The @code{F} Reply Packet
24788 @cindex file-i/o reply packet
24789 @cindex @code{F} reply packet
24791 The @code{F} reply packet has the following format:
24795 @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment}
24797 @var{retcode} is the return code of the system call as hexadecimal value.
24799 @var{errno} is the @code{errno} set by the call, in protocol-specific
24801 This parameter can be omitted if the call was successful.
24803 @var{Ctrl-C flag} is only sent if the user requested a break. In this
24804 case, @var{errno} must be sent as well, even if the call was successful.
24805 The @var{Ctrl-C flag} itself consists of the character @samp{C}:
24812 or, if the call was interrupted before the host call has been performed:
24819 assuming 4 is the protocol-specific representation of @code{EINTR}.
24824 @node The Ctrl-C Message
24825 @subsection The @samp{Ctrl-C} Message
24826 @cindex ctrl-c message, in file-i/o protocol
24828 If the @samp{Ctrl-C} flag is set in the @value{GDBN}
24829 reply packet (@pxref{The F Reply Packet}),
24830 the target should behave as if it had
24831 gotten a break message. The meaning for the target is ``system call
24832 interrupted by @code{SIGINT}''. Consequentially, the target should actually stop
24833 (as with a break message) and return to @value{GDBN} with a @code{T02}
24836 It's important for the target to know in which
24837 state the system call was interrupted. There are two possible cases:
24841 The system call hasn't been performed on the host yet.
24844 The system call on the host has been finished.
24848 These two states can be distinguished by the target by the value of the
24849 returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system
24850 call hasn't been performed. This is equivalent to the @code{EINTR} handling
24851 on POSIX systems. In any other case, the target may presume that the
24852 system call has been finished --- successfully or not --- and should behave
24853 as if the break message arrived right after the system call.
24855 @value{GDBN} must behave reliably. If the system call has not been called
24856 yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as
24857 @code{errno} in the packet. If the system call on the host has been finished
24858 before the user requests a break, the full action must be finished by
24859 @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary.
24860 The @code{F} packet may only be sent when either nothing has happened
24861 or the full action has been completed.
24864 @subsection Console I/O
24865 @cindex console i/o as part of file-i/o
24867 By default and if not explicitly closed by the target system, the file
24868 descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output
24869 on the @value{GDBN} console is handled as any other file output operation
24870 (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled
24871 by @value{GDBN} so that after the target read request from file descriptor
24872 0 all following typing is buffered until either one of the following
24877 The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the
24879 system call is treated as finished.
24882 The user presses @key{RET}. This is treated as end of input with a trailing
24886 The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing
24887 character (neither newline nor @samp{Ctrl-D}) is appended to the input.
24891 If the user has typed more characters than fit in the buffer given to
24892 the @code{read} call, the trailing characters are buffered in @value{GDBN} until
24893 either another @code{read(0, @dots{})} is requested by the target, or debugging
24894 is stopped at the user's request.
24897 @node List of Supported Calls
24898 @subsection List of Supported Calls
24899 @cindex list of supported file-i/o calls
24916 @unnumberedsubsubsec open
24917 @cindex open, file-i/o system call
24922 int open(const char *pathname, int flags);
24923 int open(const char *pathname, int flags, mode_t mode);
24927 @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}}
24930 @var{flags} is the bitwise @code{OR} of the following values:
24934 If the file does not exist it will be created. The host
24935 rules apply as far as file ownership and time stamps
24939 When used with @code{O_CREAT}, if the file already exists it is
24940 an error and open() fails.
24943 If the file already exists and the open mode allows
24944 writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be
24945 truncated to zero length.
24948 The file is opened in append mode.
24951 The file is opened for reading only.
24954 The file is opened for writing only.
24957 The file is opened for reading and writing.
24961 Other bits are silently ignored.
24965 @var{mode} is the bitwise @code{OR} of the following values:
24969 User has read permission.
24972 User has write permission.
24975 Group has read permission.
24978 Group has write permission.
24981 Others have read permission.
24984 Others have write permission.
24988 Other bits are silently ignored.
24991 @item Return value:
24992 @code{open} returns the new file descriptor or -1 if an error
24999 @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used.
25002 @var{pathname} refers to a directory.
25005 The requested access is not allowed.
25008 @var{pathname} was too long.
25011 A directory component in @var{pathname} does not exist.
25014 @var{pathname} refers to a device, pipe, named pipe or socket.
25017 @var{pathname} refers to a file on a read-only filesystem and
25018 write access was requested.
25021 @var{pathname} is an invalid pointer value.
25024 No space on device to create the file.
25027 The process already has the maximum number of files open.
25030 The limit on the total number of files open on the system
25034 The call was interrupted by the user.
25040 @unnumberedsubsubsec close
25041 @cindex close, file-i/o system call
25050 @samp{Fclose,@var{fd}}
25052 @item Return value:
25053 @code{close} returns zero on success, or -1 if an error occurred.
25059 @var{fd} isn't a valid open file descriptor.
25062 The call was interrupted by the user.
25068 @unnumberedsubsubsec read
25069 @cindex read, file-i/o system call
25074 int read(int fd, void *buf, unsigned int count);
25078 @samp{Fread,@var{fd},@var{bufptr},@var{count}}
25080 @item Return value:
25081 On success, the number of bytes read is returned.
25082 Zero indicates end of file. If count is zero, read
25083 returns zero as well. On error, -1 is returned.
25089 @var{fd} is not a valid file descriptor or is not open for
25093 @var{bufptr} is an invalid pointer value.
25096 The call was interrupted by the user.
25102 @unnumberedsubsubsec write
25103 @cindex write, file-i/o system call
25108 int write(int fd, const void *buf, unsigned int count);
25112 @samp{Fwrite,@var{fd},@var{bufptr},@var{count}}
25114 @item Return value:
25115 On success, the number of bytes written are returned.
25116 Zero indicates nothing was written. On error, -1
25123 @var{fd} is not a valid file descriptor or is not open for
25127 @var{bufptr} is an invalid pointer value.
25130 An attempt was made to write a file that exceeds the
25131 host-specific maximum file size allowed.
25134 No space on device to write the data.
25137 The call was interrupted by the user.
25143 @unnumberedsubsubsec lseek
25144 @cindex lseek, file-i/o system call
25149 long lseek (int fd, long offset, int flag);
25153 @samp{Flseek,@var{fd},@var{offset},@var{flag}}
25155 @var{flag} is one of:
25159 The offset is set to @var{offset} bytes.
25162 The offset is set to its current location plus @var{offset}
25166 The offset is set to the size of the file plus @var{offset}
25170 @item Return value:
25171 On success, the resulting unsigned offset in bytes from
25172 the beginning of the file is returned. Otherwise, a
25173 value of -1 is returned.
25179 @var{fd} is not a valid open file descriptor.
25182 @var{fd} is associated with the @value{GDBN} console.
25185 @var{flag} is not a proper value.
25188 The call was interrupted by the user.
25194 @unnumberedsubsubsec rename
25195 @cindex rename, file-i/o system call
25200 int rename(const char *oldpath, const char *newpath);
25204 @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}}
25206 @item Return value:
25207 On success, zero is returned. On error, -1 is returned.
25213 @var{newpath} is an existing directory, but @var{oldpath} is not a
25217 @var{newpath} is a non-empty directory.
25220 @var{oldpath} or @var{newpath} is a directory that is in use by some
25224 An attempt was made to make a directory a subdirectory
25228 A component used as a directory in @var{oldpath} or new
25229 path is not a directory. Or @var{oldpath} is a directory
25230 and @var{newpath} exists but is not a directory.
25233 @var{oldpathptr} or @var{newpathptr} are invalid pointer values.
25236 No access to the file or the path of the file.
25240 @var{oldpath} or @var{newpath} was too long.
25243 A directory component in @var{oldpath} or @var{newpath} does not exist.
25246 The file is on a read-only filesystem.
25249 The device containing the file has no room for the new
25253 The call was interrupted by the user.
25259 @unnumberedsubsubsec unlink
25260 @cindex unlink, file-i/o system call
25265 int unlink(const char *pathname);
25269 @samp{Funlink,@var{pathnameptr}/@var{len}}
25271 @item Return value:
25272 On success, zero is returned. On error, -1 is returned.
25278 No access to the file or the path of the file.
25281 The system does not allow unlinking of directories.
25284 The file @var{pathname} cannot be unlinked because it's
25285 being used by another process.
25288 @var{pathnameptr} is an invalid pointer value.
25291 @var{pathname} was too long.
25294 A directory component in @var{pathname} does not exist.
25297 A component of the path is not a directory.
25300 The file is on a read-only filesystem.
25303 The call was interrupted by the user.
25309 @unnumberedsubsubsec stat/fstat
25310 @cindex fstat, file-i/o system call
25311 @cindex stat, file-i/o system call
25316 int stat(const char *pathname, struct stat *buf);
25317 int fstat(int fd, struct stat *buf);
25321 @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@*
25322 @samp{Ffstat,@var{fd},@var{bufptr}}
25324 @item Return value:
25325 On success, zero is returned. On error, -1 is returned.
25331 @var{fd} is not a valid open file.
25334 A directory component in @var{pathname} does not exist or the
25335 path is an empty string.
25338 A component of the path is not a directory.
25341 @var{pathnameptr} is an invalid pointer value.
25344 No access to the file or the path of the file.
25347 @var{pathname} was too long.
25350 The call was interrupted by the user.
25356 @unnumberedsubsubsec gettimeofday
25357 @cindex gettimeofday, file-i/o system call
25362 int gettimeofday(struct timeval *tv, void *tz);
25366 @samp{Fgettimeofday,@var{tvptr},@var{tzptr}}
25368 @item Return value:
25369 On success, 0 is returned, -1 otherwise.
25375 @var{tz} is a non-NULL pointer.
25378 @var{tvptr} and/or @var{tzptr} is an invalid pointer value.
25384 @unnumberedsubsubsec isatty
25385 @cindex isatty, file-i/o system call
25390 int isatty(int fd);
25394 @samp{Fisatty,@var{fd}}
25396 @item Return value:
25397 Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise.
25403 The call was interrupted by the user.
25408 Note that the @code{isatty} call is treated as a special case: it returns
25409 1 to the target if the file descriptor is attached
25410 to the @value{GDBN} console, 0 otherwise. Implementing through system calls
25411 would require implementing @code{ioctl} and would be more complex than
25416 @unnumberedsubsubsec system
25417 @cindex system, file-i/o system call
25422 int system(const char *command);
25426 @samp{Fsystem,@var{commandptr}/@var{len}}
25428 @item Return value:
25429 If @var{len} is zero, the return value indicates whether a shell is
25430 available. A zero return value indicates a shell is not available.
25431 For non-zero @var{len}, the value returned is -1 on error and the
25432 return status of the command otherwise. Only the exit status of the
25433 command is returned, which is extracted from the host's @code{system}
25434 return value by calling @code{WEXITSTATUS(retval)}. In case
25435 @file{/bin/sh} could not be executed, 127 is returned.
25441 The call was interrupted by the user.
25446 @value{GDBN} takes over the full task of calling the necessary host calls
25447 to perform the @code{system} call. The return value of @code{system} on
25448 the host is simplified before it's returned
25449 to the target. Any termination signal information from the child process
25450 is discarded, and the return value consists
25451 entirely of the exit status of the called command.
25453 Due to security concerns, the @code{system} call is by default refused
25454 by @value{GDBN}. The user has to allow this call explicitly with the
25455 @code{set remote system-call-allowed 1} command.
25458 @item set remote system-call-allowed
25459 @kindex set remote system-call-allowed
25460 Control whether to allow the @code{system} calls in the File I/O
25461 protocol for the remote target. The default is zero (disabled).
25463 @item show remote system-call-allowed
25464 @kindex show remote system-call-allowed
25465 Show whether the @code{system} calls are allowed in the File I/O
25469 @node Protocol-specific Representation of Datatypes
25470 @subsection Protocol-specific Representation of Datatypes
25471 @cindex protocol-specific representation of datatypes, in file-i/o protocol
25474 * Integral Datatypes::
25476 * Memory Transfer::
25481 @node Integral Datatypes
25482 @unnumberedsubsubsec Integral Datatypes
25483 @cindex integral datatypes, in file-i/o protocol
25485 The integral datatypes used in the system calls are @code{int},
25486 @code{unsigned int}, @code{long}, @code{unsigned long},
25487 @code{mode_t}, and @code{time_t}.
25489 @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are
25490 implemented as 32 bit values in this protocol.
25492 @code{long} and @code{unsigned long} are implemented as 64 bit types.
25494 @xref{Limits}, for corresponding MIN and MAX values (similar to those
25495 in @file{limits.h}) to allow range checking on host and target.
25497 @code{time_t} datatypes are defined as seconds since the Epoch.
25499 All integral datatypes transferred as part of a memory read or write of a
25500 structured datatype e.g.@: a @code{struct stat} have to be given in big endian
25503 @node Pointer Values
25504 @unnumberedsubsubsec Pointer Values
25505 @cindex pointer values, in file-i/o protocol
25507 Pointers to target data are transmitted as they are. An exception
25508 is made for pointers to buffers for which the length isn't
25509 transmitted as part of the function call, namely strings. Strings
25510 are transmitted as a pointer/length pair, both as hex values, e.g.@:
25517 which is a pointer to data of length 18 bytes at position 0x1aaf.
25518 The length is defined as the full string length in bytes, including
25519 the trailing null byte. For example, the string @code{"hello world"}
25520 at address 0x123456 is transmitted as
25526 @node Memory Transfer
25527 @unnumberedsubsubsec Memory Transfer
25528 @cindex memory transfer, in file-i/o protocol
25530 Structured data which is transferred using a memory read or write (for
25531 example, a @code{struct stat}) is expected to be in a protocol-specific format
25532 with all scalar multibyte datatypes being big endian. Translation to
25533 this representation needs to be done both by the target before the @code{F}
25534 packet is sent, and by @value{GDBN} before
25535 it transfers memory to the target. Transferred pointers to structured
25536 data should point to the already-coerced data at any time.
25540 @unnumberedsubsubsec struct stat
25541 @cindex struct stat, in file-i/o protocol
25543 The buffer of type @code{struct stat} used by the target and @value{GDBN}
25544 is defined as follows:
25548 unsigned int st_dev; /* device */
25549 unsigned int st_ino; /* inode */
25550 mode_t st_mode; /* protection */
25551 unsigned int st_nlink; /* number of hard links */
25552 unsigned int st_uid; /* user ID of owner */
25553 unsigned int st_gid; /* group ID of owner */
25554 unsigned int st_rdev; /* device type (if inode device) */
25555 unsigned long st_size; /* total size, in bytes */
25556 unsigned long st_blksize; /* blocksize for filesystem I/O */
25557 unsigned long st_blocks; /* number of blocks allocated */
25558 time_t st_atime; /* time of last access */
25559 time_t st_mtime; /* time of last modification */
25560 time_t st_ctime; /* time of last change */
25564 The integral datatypes conform to the definitions given in the
25565 appropriate section (see @ref{Integral Datatypes}, for details) so this
25566 structure is of size 64 bytes.
25568 The values of several fields have a restricted meaning and/or
25574 A value of 0 represents a file, 1 the console.
25577 No valid meaning for the target. Transmitted unchanged.
25580 Valid mode bits are described in @ref{Constants}. Any other
25581 bits have currently no meaning for the target.
25586 No valid meaning for the target. Transmitted unchanged.
25591 These values have a host and file system dependent
25592 accuracy. Especially on Windows hosts, the file system may not
25593 support exact timing values.
25596 The target gets a @code{struct stat} of the above representation and is
25597 responsible for coercing it to the target representation before
25600 Note that due to size differences between the host, target, and protocol
25601 representations of @code{struct stat} members, these members could eventually
25602 get truncated on the target.
25604 @node struct timeval
25605 @unnumberedsubsubsec struct timeval
25606 @cindex struct timeval, in file-i/o protocol
25608 The buffer of type @code{struct timeval} used by the File-I/O protocol
25609 is defined as follows:
25613 time_t tv_sec; /* second */
25614 long tv_usec; /* microsecond */
25618 The integral datatypes conform to the definitions given in the
25619 appropriate section (see @ref{Integral Datatypes}, for details) so this
25620 structure is of size 8 bytes.
25623 @subsection Constants
25624 @cindex constants, in file-i/o protocol
25626 The following values are used for the constants inside of the
25627 protocol. @value{GDBN} and target are responsible for translating these
25628 values before and after the call as needed.
25639 @unnumberedsubsubsec Open Flags
25640 @cindex open flags, in file-i/o protocol
25642 All values are given in hexadecimal representation.
25654 @node mode_t Values
25655 @unnumberedsubsubsec mode_t Values
25656 @cindex mode_t values, in file-i/o protocol
25658 All values are given in octal representation.
25675 @unnumberedsubsubsec Errno Values
25676 @cindex errno values, in file-i/o protocol
25678 All values are given in decimal representation.
25703 @code{EUNKNOWN} is used as a fallback error value if a host system returns
25704 any error value not in the list of supported error numbers.
25707 @unnumberedsubsubsec Lseek Flags
25708 @cindex lseek flags, in file-i/o protocol
25717 @unnumberedsubsubsec Limits
25718 @cindex limits, in file-i/o protocol
25720 All values are given in decimal representation.
25723 INT_MIN -2147483648
25725 UINT_MAX 4294967295
25726 LONG_MIN -9223372036854775808
25727 LONG_MAX 9223372036854775807
25728 ULONG_MAX 18446744073709551615
25731 @node File-I/O Examples
25732 @subsection File-I/O Examples
25733 @cindex file-i/o examples
25735 Example sequence of a write call, file descriptor 3, buffer is at target
25736 address 0x1234, 6 bytes should be written:
25739 <- @code{Fwrite,3,1234,6}
25740 @emph{request memory read from target}
25743 @emph{return "6 bytes written"}
25747 Example sequence of a read call, file descriptor 3, buffer is at target
25748 address 0x1234, 6 bytes should be read:
25751 <- @code{Fread,3,1234,6}
25752 @emph{request memory write to target}
25753 -> @code{X1234,6:XXXXXX}
25754 @emph{return "6 bytes read"}
25758 Example sequence of a read call, call fails on the host due to invalid
25759 file descriptor (@code{EBADF}):
25762 <- @code{Fread,3,1234,6}
25766 Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on
25770 <- @code{Fread,3,1234,6}
25775 Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on
25779 <- @code{Fread,3,1234,6}
25780 -> @code{X1234,6:XXXXXX}
25784 @node Library List Format
25785 @section Library List Format
25786 @cindex library list format, remote protocol
25788 On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the
25789 same process as your application to manage libraries. In this case,
25790 @value{GDBN} can use the loader's symbol table and normal memory
25791 operations to maintain a list of shared libraries. On other
25792 platforms, the operating system manages loaded libraries.
25793 @value{GDBN} can not retrieve the list of currently loaded libraries
25794 through memory operations, so it uses the @samp{qXfer:libraries:read}
25795 packet (@pxref{qXfer library list read}) instead. The remote stub
25796 queries the target's operating system and reports which libraries
25799 The @samp{qXfer:libraries:read} packet returns an XML document which
25800 lists loaded libraries and their offsets. Each library has an
25801 associated name and one or more segment base addresses, which report
25802 where the library was loaded in memory. The segment bases are start
25803 addresses, not relocation offsets; they do not depend on the library's
25804 link-time base addresses.
25806 @value{GDBN} must be linked with the Expat library to support XML
25807 library lists. @xref{Expat}.
25809 A simple memory map, with one loaded library relocated by a single
25810 offset, looks like this:
25814 <library name="/lib/libc.so.6">
25815 <segment address="0x10000000"/>
25820 The format of a library list is described by this DTD:
25823 <!-- library-list: Root element with versioning -->
25824 <!ELEMENT library-list (library)*>
25825 <!ATTLIST library-list version CDATA #FIXED "1.0">
25826 <!ELEMENT library (segment)*>
25827 <!ATTLIST library name CDATA #REQUIRED>
25828 <!ELEMENT segment EMPTY>
25829 <!ATTLIST segment address CDATA #REQUIRED>
25832 @node Memory Map Format
25833 @section Memory Map Format
25834 @cindex memory map format
25836 To be able to write into flash memory, @value{GDBN} needs to obtain a
25837 memory map from the target. This section describes the format of the
25840 The memory map is obtained using the @samp{qXfer:memory-map:read}
25841 (@pxref{qXfer memory map read}) packet and is an XML document that
25842 lists memory regions.
25844 @value{GDBN} must be linked with the Expat library to support XML
25845 memory maps. @xref{Expat}.
25847 The top-level structure of the document is shown below:
25850 <?xml version="1.0"?>
25851 <!DOCTYPE memory-map
25852 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
25853 "http://sourceware.org/gdb/gdb-memory-map.dtd">
25859 Each region can be either:
25864 A region of RAM starting at @var{addr} and extending for @var{length}
25868 <memory type="ram" start="@var{addr}" length="@var{length}"/>
25873 A region of read-only memory:
25876 <memory type="rom" start="@var{addr}" length="@var{length}"/>
25881 A region of flash memory, with erasure blocks @var{blocksize}
25885 <memory type="flash" start="@var{addr}" length="@var{length}">
25886 <property name="blocksize">@var{blocksize}</property>
25892 Regions must not overlap. @value{GDBN} assumes that areas of memory not covered
25893 by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X}
25894 packets to write to addresses in such ranges.
25896 The formal DTD for memory map format is given below:
25899 <!-- ................................................... -->
25900 <!-- Memory Map XML DTD ................................ -->
25901 <!-- File: memory-map.dtd .............................. -->
25902 <!-- .................................... .............. -->
25903 <!-- memory-map.dtd -->
25904 <!-- memory-map: Root element with versioning -->
25905 <!ELEMENT memory-map (memory | property)>
25906 <!ATTLIST memory-map version CDATA #FIXED "1.0.0">
25907 <!ELEMENT memory (property)>
25908 <!-- memory: Specifies a memory region,
25909 and its type, or device. -->
25910 <!ATTLIST memory type CDATA #REQUIRED
25911 start CDATA #REQUIRED
25912 length CDATA #REQUIRED
25913 device CDATA #IMPLIED>
25914 <!-- property: Generic attribute tag -->
25915 <!ELEMENT property (#PCDATA | property)*>
25916 <!ATTLIST property name CDATA #REQUIRED>
25919 @include agentexpr.texi
25921 @node Target Descriptions
25922 @appendix Target Descriptions
25923 @cindex target descriptions
25925 @strong{Warning:} target descriptions are still under active development,
25926 and the contents and format may change between @value{GDBN} releases.
25927 The format is expected to stabilize in the future.
25929 One of the challenges of using @value{GDBN} to debug embedded systems
25930 is that there are so many minor variants of each processor
25931 architecture in use. It is common practice for vendors to start with
25932 a standard processor core --- ARM, PowerPC, or MIPS, for example ---
25933 and then make changes to adapt it to a particular market niche. Some
25934 architectures have hundreds of variants, available from dozens of
25935 vendors. This leads to a number of problems:
25939 With so many different customized processors, it is difficult for
25940 the @value{GDBN} maintainers to keep up with the changes.
25942 Since individual variants may have short lifetimes or limited
25943 audiences, it may not be worthwhile to carry information about every
25944 variant in the @value{GDBN} source tree.
25946 When @value{GDBN} does support the architecture of the embedded system
25947 at hand, the task of finding the correct architecture name to give the
25948 @command{set architecture} command can be error-prone.
25951 To address these problems, the @value{GDBN} remote protocol allows a
25952 target system to not only identify itself to @value{GDBN}, but to
25953 actually describe its own features. This lets @value{GDBN} support
25954 processor variants it has never seen before --- to the extent that the
25955 descriptions are accurate, and that @value{GDBN} understands them.
25957 @value{GDBN} must be linked with the Expat library to support XML
25958 target descriptions. @xref{Expat}.
25961 * Retrieving Descriptions:: How descriptions are fetched from a target.
25962 * Target Description Format:: The contents of a target description.
25963 * Predefined Target Types:: Standard types available for target
25965 * Standard Target Features:: Features @value{GDBN} knows about.
25968 @node Retrieving Descriptions
25969 @section Retrieving Descriptions
25971 Target descriptions can be read from the target automatically, or
25972 specified by the user manually. The default behavior is to read the
25973 description from the target. @value{GDBN} retrieves it via the remote
25974 protocol using @samp{qXfer} requests (@pxref{General Query Packets,
25975 qXfer}). The @var{annex} in the @samp{qXfer} packet will be
25976 @samp{target.xml}. The contents of the @samp{target.xml} annex are an
25977 XML document, of the form described in @ref{Target Description
25980 Alternatively, you can specify a file to read for the target description.
25981 If a file is set, the target will not be queried. The commands to
25982 specify a file are:
25985 @cindex set tdesc filename
25986 @item set tdesc filename @var{path}
25987 Read the target description from @var{path}.
25989 @cindex unset tdesc filename
25990 @item unset tdesc filename
25991 Do not read the XML target description from a file. @value{GDBN}
25992 will use the description supplied by the current target.
25994 @cindex show tdesc filename
25995 @item show tdesc filename
25996 Show the filename to read for a target description, if any.
26000 @node Target Description Format
26001 @section Target Description Format
26002 @cindex target descriptions, XML format
26004 A target description annex is an @uref{http://www.w3.org/XML/, XML}
26005 document which complies with the Document Type Definition provided in
26006 the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This
26007 means you can use generally available tools like @command{xmllint} to
26008 check that your feature descriptions are well-formed and valid.
26009 However, to help people unfamiliar with XML write descriptions for
26010 their targets, we also describe the grammar here.
26012 Target descriptions can identify the architecture of the remote target
26013 and (for some architectures) provide information about custom register
26014 sets. @value{GDBN} can use this information to autoconfigure for your
26015 target, or to warn you if you connect to an unsupported target.
26017 Here is a simple target description:
26020 <target version="1.0">
26021 <architecture>i386:x86-64</architecture>
26026 This minimal description only says that the target uses
26027 the x86-64 architecture.
26029 A target description has the following overall form, with [ ] marking
26030 optional elements and @dots{} marking repeatable elements. The elements
26031 are explained further below.
26034 <?xml version="1.0"?>
26035 <!DOCTYPE target SYSTEM "gdb-target.dtd">
26036 <target version="1.0">
26037 @r{[}@var{architecture}@r{]}
26038 @r{[}@var{feature}@dots{}@r{]}
26043 The description is generally insensitive to whitespace and line
26044 breaks, under the usual common-sense rules. The XML version
26045 declaration and document type declaration can generally be omitted
26046 (@value{GDBN} does not require them), but specifying them may be
26047 useful for XML validation tools. The @samp{version} attribute for
26048 @samp{<target>} may also be omitted, but we recommend
26049 including it; if future versions of @value{GDBN} use an incompatible
26050 revision of @file{gdb-target.dtd}, they will detect and report
26051 the version mismatch.
26053 @subsection Inclusion
26054 @cindex target descriptions, inclusion
26057 @cindex <xi:include>
26060 It can sometimes be valuable to split a target description up into
26061 several different annexes, either for organizational purposes, or to
26062 share files between different possible target descriptions. You can
26063 divide a description into multiple files by replacing any element of
26064 the target description with an inclusion directive of the form:
26067 <xi:include href="@var{document}"/>
26071 When @value{GDBN} encounters an element of this form, it will retrieve
26072 the named XML @var{document}, and replace the inclusion directive with
26073 the contents of that document. If the current description was read
26074 using @samp{qXfer}, then so will be the included document;
26075 @var{document} will be interpreted as the name of an annex. If the
26076 current description was read from a file, @value{GDBN} will look for
26077 @var{document} as a file in the same directory where it found the
26078 original description.
26080 @subsection Architecture
26081 @cindex <architecture>
26083 An @samp{<architecture>} element has this form:
26086 <architecture>@var{arch}</architecture>
26089 @var{arch} is an architecture name from the same selection
26090 accepted by @code{set architecture} (@pxref{Targets, ,Specifying a
26091 Debugging Target}).
26093 @subsection Features
26096 Each @samp{<feature>} describes some logical portion of the target
26097 system. Features are currently used to describe available CPU
26098 registers and the types of their contents. A @samp{<feature>} element
26102 <feature name="@var{name}">
26103 @r{[}@var{type}@dots{}@r{]}
26109 Each feature's name should be unique within the description. The name
26110 of a feature does not matter unless @value{GDBN} has some special
26111 knowledge of the contents of that feature; if it does, the feature
26112 should have its standard name. @xref{Standard Target Features}.
26116 Any register's value is a collection of bits which @value{GDBN} must
26117 interpret. The default interpretation is a two's complement integer,
26118 but other types can be requested by name in the register description.
26119 Some predefined types are provided by @value{GDBN} (@pxref{Predefined
26120 Target Types}), and the description can define additional composite types.
26122 Each type element must have an @samp{id} attribute, which gives
26123 a unique (within the containing @samp{<feature>}) name to the type.
26124 Types must be defined before they are used.
26127 Some targets offer vector registers, which can be treated as arrays
26128 of scalar elements. These types are written as @samp{<vector>} elements,
26129 specifying the array element type, @var{type}, and the number of elements,
26133 <vector id="@var{id}" type="@var{type}" count="@var{count}"/>
26137 If a register's value is usefully viewed in multiple ways, define it
26138 with a union type containing the useful representations. The
26139 @samp{<union>} element contains one or more @samp{<field>} elements,
26140 each of which has a @var{name} and a @var{type}:
26143 <union id="@var{id}">
26144 <field name="@var{name}" type="@var{type}"/>
26149 @subsection Registers
26152 Each register is represented as an element with this form:
26155 <reg name="@var{name}"
26156 bitsize="@var{size}"
26157 @r{[}regnum="@var{num}"@r{]}
26158 @r{[}save-restore="@var{save-restore}"@r{]}
26159 @r{[}type="@var{type}"@r{]}
26160 @r{[}group="@var{group}"@r{]}/>
26164 The components are as follows:
26169 The register's name; it must be unique within the target description.
26172 The register's size, in bits.
26175 The register's number. If omitted, a register's number is one greater
26176 than that of the previous register (either in the current feature or in
26177 a preceeding feature); the first register in the target description
26178 defaults to zero. This register number is used to read or write
26179 the register; e.g.@: it is used in the remote @code{p} and @code{P}
26180 packets, and registers appear in the @code{g} and @code{G} packets
26181 in order of increasing register number.
26184 Whether the register should be preserved across inferior function
26185 calls; this must be either @code{yes} or @code{no}. The default is
26186 @code{yes}, which is appropriate for most registers except for
26187 some system control registers; this is not related to the target's
26191 The type of the register. @var{type} may be a predefined type, a type
26192 defined in the current feature, or one of the special types @code{int}
26193 and @code{float}. @code{int} is an integer type of the correct size
26194 for @var{bitsize}, and @code{float} is a floating point type (in the
26195 architecture's normal floating point format) of the correct size for
26196 @var{bitsize}. The default is @code{int}.
26199 The register group to which this register belongs. @var{group} must
26200 be either @code{general}, @code{float}, or @code{vector}. If no
26201 @var{group} is specified, @value{GDBN} will not display the register
26202 in @code{info registers}.
26206 @node Predefined Target Types
26207 @section Predefined Target Types
26208 @cindex target descriptions, predefined types
26210 Type definitions in the self-description can build up composite types
26211 from basic building blocks, but can not define fundamental types. Instead,
26212 standard identifiers are provided by @value{GDBN} for the fundamental
26213 types. The currently supported types are:
26222 Signed integer types holding the specified number of bits.
26229 Unsigned integer types holding the specified number of bits.
26233 Pointers to unspecified code and data. The program counter and
26234 any dedicated return address register may be marked as code
26235 pointers; printing a code pointer converts it into a symbolic
26236 address. The stack pointer and any dedicated address registers
26237 may be marked as data pointers.
26240 Single precision IEEE floating point.
26243 Double precision IEEE floating point.
26246 The 12-byte extended precision format used by ARM FPA registers.
26250 @node Standard Target Features
26251 @section Standard Target Features
26252 @cindex target descriptions, standard features
26254 A target description must contain either no registers or all the
26255 target's registers. If the description contains no registers, then
26256 @value{GDBN} will assume a default register layout, selected based on
26257 the architecture. If the description contains any registers, the
26258 default layout will not be used; the standard registers must be
26259 described in the target description, in such a way that @value{GDBN}
26260 can recognize them.
26262 This is accomplished by giving specific names to feature elements
26263 which contain standard registers. @value{GDBN} will look for features
26264 with those names and verify that they contain the expected registers;
26265 if any known feature is missing required registers, or if any required
26266 feature is missing, @value{GDBN} will reject the target
26267 description. You can add additional registers to any of the
26268 standard features --- @value{GDBN} will display them just as if
26269 they were added to an unrecognized feature.
26271 This section lists the known features and their expected contents.
26272 Sample XML documents for these features are included in the
26273 @value{GDBN} source tree, in the directory @file{gdb/features}.
26275 Names recognized by @value{GDBN} should include the name of the
26276 company or organization which selected the name, and the overall
26277 architecture to which the feature applies; so e.g.@: the feature
26278 containing ARM core registers is named @samp{org.gnu.gdb.arm.core}.
26280 The names of registers are not case sensitive for the purpose
26281 of recognizing standard features, but @value{GDBN} will only display
26282 registers using the capitalization used in the description.
26291 @subsection ARM Features
26292 @cindex target descriptions, ARM features
26294 The @samp{org.gnu.gdb.arm.core} feature is required for ARM targets.
26295 It should contain registers @samp{r0} through @samp{r13}, @samp{sp},
26296 @samp{lr}, @samp{pc}, and @samp{cpsr}.
26298 The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it
26299 should contain registers @samp{f0} through @samp{f7} and @samp{fps}.
26301 The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present,
26302 it should contain at least registers @samp{wR0} through @samp{wR15} and
26303 @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon},
26304 @samp{wCSSF}, and @samp{wCASF} registers are optional.
26306 @subsection MIPS Features
26307 @cindex target descriptions, MIPS features
26309 The @samp{org.gnu.gdb.mips.cpu} feature is required for MIPS targets.
26310 It should contain registers @samp{r0} through @samp{r31}, @samp{lo},
26311 @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending
26314 The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should
26315 contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause}
26316 registers. They may be 32-bit or 64-bit depending on the target.
26318 The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though
26319 it may be optional in a future version of @value{GDBN}. It should
26320 contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and
26321 @samp{fir}. They may be 32-bit or 64-bit depending on the target.
26323 The @samp{org.gnu.gdb.mips.linux} feature is optional. It should
26324 contain a single register, @samp{restart}, which is used by the
26325 Linux kernel to control restartable syscalls.
26327 @node M68K Features
26328 @subsection M68K Features
26329 @cindex target descriptions, M68K features
26332 @item @samp{org.gnu.gdb.m68k.core}
26333 @itemx @samp{org.gnu.gdb.coldfire.core}
26334 @itemx @samp{org.gnu.gdb.fido.core}
26335 One of those features must be always present.
26336 The feature that is present determines which flavor of m86k is
26337 used. The feature that is present should contain registers
26338 @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
26339 @samp{sp}, @samp{ps} and @samp{pc}.
26341 @item @samp{org.gnu.gdb.coldfire.fp}
26342 This feature is optional. If present, it should contain registers
26343 @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
26347 @subsection PowerPC Features
26348 @cindex target descriptions, PowerPC features
26350 The @samp{org.gnu.gdb.power.core} feature is required for PowerPC
26351 targets. It should contain registers @samp{r0} through @samp{r31},
26352 @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and
26353 @samp{xer}. They may be 32-bit or 64-bit depending on the target.
26355 The @samp{org.gnu.gdb.power.fpu} feature is optional. It should
26356 contain registers @samp{f0} through @samp{f31} and @samp{fpscr}.
26358 The @samp{org.gnu.gdb.power.altivec} feature is optional. It should
26359 contain registers @samp{vr0} through @samp{vr31}, @samp{vscr},
26362 The @samp{org.gnu.gdb.power.spe} feature is optional. It should
26363 contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and
26364 @samp{spefscr}. SPE targets should provide 32-bit registers in
26365 @samp{org.gnu.gdb.power.core} and provide the upper halves in
26366 @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine
26367 these to present registers @samp{ev0} through @samp{ev31} to the
26382 % I think something like @colophon should be in texinfo. In the
26384 \long\def\colophon{\hbox to0pt{}\vfill
26385 \centerline{The body of this manual is set in}
26386 \centerline{\fontname\tenrm,}
26387 \centerline{with headings in {\bf\fontname\tenbf}}
26388 \centerline{and examples in {\tt\fontname\tentt}.}
26389 \centerline{{\it\fontname\tenit\/},}
26390 \centerline{{\bf\fontname\tenbf}, and}
26391 \centerline{{\sl\fontname\tensl\/}}
26392 \centerline{are used for emphasis.}\vfill}
26394 % Blame: doc@cygnus.com, 1991.