1 \input texinfo @c -*-texinfo-*-
2 @c Copyright (C) 1988-2015 Free Software Foundation, Inc.
5 @c makeinfo ignores cmds prev to setfilename, so its arg cannot make use
6 @c of @set vars. However, you can override filename with makeinfo -o.
13 @settitle Debugging with @value{GDBN}
14 @setchapternewpage odd
23 @c To avoid file-name clashes between index.html and Index.html, when
24 @c the manual is produced on a Posix host and then moved to a
25 @c case-insensitive filesystem (e.g., MS-Windows), we separate the
26 @c indices into two: Concept Index and all the rest.
30 @c readline appendices use @vindex, @findex and @ftable,
31 @c annotate.texi and gdbmi use @findex.
34 @c !!set GDB manual's edition---not the same as GDB version!
35 @c This is updated by GNU Press.
38 @c !!set GDB edit command default editor
41 @c THIS MANUAL REQUIRES TEXINFO 4.0 OR LATER.
43 @c This is a dir.info fragment to support semi-automated addition of
44 @c manuals to an info tree.
45 @dircategory Software development
47 * Gdb: (gdb). The GNU debugger.
48 * gdbserver: (gdb) Server. The GNU debugging server.
52 @c man begin COPYRIGHT
53 Copyright @copyright{} 1988-2015 Free Software Foundation, Inc.
55 Permission is granted to copy, distribute and/or modify this document
56 under the terms of the GNU Free Documentation License, Version 1.3 or
57 any later version published by the Free Software Foundation; with the
58 Invariant Sections being ``Free Software'' and ``Free Software Needs
59 Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
60 and with the Back-Cover Texts as in (a) below.
62 (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
63 this GNU Manual. Buying copies from GNU Press supports the FSF in
64 developing GNU and promoting software freedom.''
69 This file documents the @sc{gnu} debugger @value{GDBN}.
71 This is the @value{EDITION} Edition, of @cite{Debugging with
72 @value{GDBN}: the @sc{gnu} Source-Level Debugger} for @value{GDBN}
73 @ifset VERSION_PACKAGE
74 @value{VERSION_PACKAGE}
76 Version @value{GDBVN}.
82 @title Debugging with @value{GDBN}
83 @subtitle The @sc{gnu} Source-Level Debugger
85 @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN}
86 @ifset VERSION_PACKAGE
88 @subtitle @value{VERSION_PACKAGE}
90 @author Richard Stallman, Roland Pesch, Stan Shebs, et al.
94 \hfill (Send bugs and comments on @value{GDBN} to @value{BUGURL}.)\par
95 \hfill {\it Debugging with @value{GDBN}}\par
96 \hfill \TeX{}info \texinfoversion\par
100 @vskip 0pt plus 1filll
101 Published by the Free Software Foundation @*
102 51 Franklin Street, Fifth Floor,
103 Boston, MA 02110-1301, USA@*
104 ISBN 978-0-9831592-3-0 @*
111 @node Top, Summary, (dir), (dir)
113 @top Debugging with @value{GDBN}
115 This file describes @value{GDBN}, the @sc{gnu} symbolic debugger.
117 This is the @value{EDITION} Edition, for @value{GDBN}
118 @ifset VERSION_PACKAGE
119 @value{VERSION_PACKAGE}
121 Version @value{GDBVN}.
123 Copyright (C) 1988-2015 Free Software Foundation, Inc.
125 This edition of the GDB manual is dedicated to the memory of Fred
126 Fish. Fred was a long-standing contributor to GDB and to Free
127 software in general. We will miss him.
130 * Summary:: Summary of @value{GDBN}
131 * Sample Session:: A sample @value{GDBN} session
133 * Invocation:: Getting in and out of @value{GDBN}
134 * Commands:: @value{GDBN} commands
135 * Running:: Running programs under @value{GDBN}
136 * Stopping:: Stopping and continuing
137 * Reverse Execution:: Running programs backward
138 * Process Record and Replay:: Recording inferior's execution and replaying it
139 * Stack:: Examining the stack
140 * Source:: Examining source files
141 * Data:: Examining data
142 * Optimized Code:: Debugging optimized code
143 * Macros:: Preprocessor Macros
144 * Tracepoints:: Debugging remote targets non-intrusively
145 * Overlays:: Debugging programs that use overlays
147 * Languages:: Using @value{GDBN} with different languages
149 * Symbols:: Examining the symbol table
150 * Altering:: Altering execution
151 * GDB Files:: @value{GDBN} files
152 * Targets:: Specifying a debugging target
153 * Remote Debugging:: Debugging remote programs
154 * Configurations:: Configuration-specific information
155 * Controlling GDB:: Controlling @value{GDBN}
156 * Extending GDB:: Extending @value{GDBN}
157 * Interpreters:: Command Interpreters
158 * TUI:: @value{GDBN} Text User Interface
159 * Emacs:: Using @value{GDBN} under @sc{gnu} Emacs
160 * GDB/MI:: @value{GDBN}'s Machine Interface.
161 * Annotations:: @value{GDBN}'s annotation interface.
162 * JIT Interface:: Using the JIT debugging interface.
163 * In-Process Agent:: In-Process Agent
165 * GDB Bugs:: Reporting bugs in @value{GDBN}
167 @ifset SYSTEM_READLINE
168 * Command Line Editing: (rluserman). Command Line Editing
169 * Using History Interactively: (history). Using History Interactively
171 @ifclear SYSTEM_READLINE
172 * Command Line Editing:: Command Line Editing
173 * Using History Interactively:: Using History Interactively
175 * In Memoriam:: In Memoriam
176 * Formatting Documentation:: How to format and print @value{GDBN} documentation
177 * Installing GDB:: Installing GDB
178 * Maintenance Commands:: Maintenance Commands
179 * Remote Protocol:: GDB Remote Serial Protocol
180 * Agent Expressions:: The GDB Agent Expression Mechanism
181 * Target Descriptions:: How targets can describe themselves to
183 * Operating System Information:: Getting additional information from
185 * Trace File Format:: GDB trace file format
186 * Index Section Format:: .gdb_index section format
187 * Man Pages:: Manual pages
188 * Copying:: GNU General Public License says
189 how you can copy and share GDB
190 * GNU Free Documentation License:: The license for this documentation
191 * Concept Index:: Index of @value{GDBN} concepts
192 * Command and Variable Index:: Index of @value{GDBN} commands, variables,
193 functions, and Python data types
201 @unnumbered Summary of @value{GDBN}
203 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
204 going on ``inside'' another program while it executes---or what another
205 program was doing at the moment it crashed.
207 @value{GDBN} can do four main kinds of things (plus other things in support of
208 these) to help you catch bugs in the act:
212 Start your program, specifying anything that might affect its behavior.
215 Make your program stop on specified conditions.
218 Examine what has happened, when your program has stopped.
221 Change things in your program, so you can experiment with correcting the
222 effects of one bug and go on to learn about another.
225 You can use @value{GDBN} to debug programs written in C and C@t{++}.
226 For more information, see @ref{Supported Languages,,Supported Languages}.
227 For more information, see @ref{C,,C and C++}.
229 Support for D is partial. For information on D, see
233 Support for Modula-2 is partial. For information on Modula-2, see
234 @ref{Modula-2,,Modula-2}.
236 Support for OpenCL C is partial. For information on OpenCL C, see
237 @ref{OpenCL C,,OpenCL C}.
240 Debugging Pascal programs which use sets, subranges, file variables, or
241 nested functions does not currently work. @value{GDBN} does not support
242 entering expressions, printing values, or similar features using Pascal
246 @value{GDBN} can be used to debug programs written in Fortran, although
247 it may be necessary to refer to some variables with a trailing
250 @value{GDBN} can be used to debug programs written in Objective-C,
251 using either the Apple/NeXT or the GNU Objective-C runtime.
254 * Free Software:: Freely redistributable software
255 * Free Documentation:: Free Software Needs Free Documentation
256 * Contributors:: Contributors to GDB
260 @unnumberedsec Free Software
262 @value{GDBN} is @dfn{free software}, protected by the @sc{gnu}
263 General Public License
264 (GPL). The GPL gives you the freedom to copy or adapt a licensed
265 program---but every person getting a copy also gets with it the
266 freedom to modify that copy (which means that they must get access to
267 the source code), and the freedom to distribute further copies.
268 Typical software companies use copyrights to limit your freedoms; the
269 Free Software Foundation uses the GPL to preserve these freedoms.
271 Fundamentally, the General Public License is a license which says that
272 you have these freedoms and that you cannot take these freedoms away
275 @node Free Documentation
276 @unnumberedsec Free Software Needs Free Documentation
278 The biggest deficiency in the free software community today is not in
279 the software---it is the lack of good free documentation that we can
280 include with the free software. Many of our most important
281 programs do not come with free reference manuals and free introductory
282 texts. Documentation is an essential part of any software package;
283 when an important free software package does not come with a free
284 manual and a free tutorial, that is a major gap. We have many such
287 Consider Perl, for instance. The tutorial manuals that people
288 normally use are non-free. How did this come about? Because the
289 authors of those manuals published them with restrictive terms---no
290 copying, no modification, source files not available---which exclude
291 them from the free software world.
293 That wasn't the first time this sort of thing happened, and it was far
294 from the last. Many times we have heard a GNU user eagerly describe a
295 manual that he is writing, his intended contribution to the community,
296 only to learn that he had ruined everything by signing a publication
297 contract to make it non-free.
299 Free documentation, like free software, is a matter of freedom, not
300 price. The problem with the non-free manual is not that publishers
301 charge a price for printed copies---that in itself is fine. (The Free
302 Software Foundation sells printed copies of manuals, too.) The
303 problem is the restrictions on the use of the manual. Free manuals
304 are available in source code form, and give you permission to copy and
305 modify. Non-free manuals do not allow this.
307 The criteria of freedom for a free manual are roughly the same as for
308 free software. Redistribution (including the normal kinds of
309 commercial redistribution) must be permitted, so that the manual can
310 accompany every copy of the program, both on-line and on paper.
312 Permission for modification of the technical content is crucial too.
313 When people modify the software, adding or changing features, if they
314 are conscientious they will change the manual too---so they can
315 provide accurate and clear documentation for the modified program. A
316 manual that leaves you no choice but to write a new manual to document
317 a changed version of the program is not really available to our
320 Some kinds of limits on the way modification is handled are
321 acceptable. For example, requirements to preserve the original
322 author's copyright notice, the distribution terms, or the list of
323 authors, are ok. It is also no problem to require modified versions
324 to include notice that they were modified. Even entire sections that
325 may not be deleted or changed are acceptable, as long as they deal
326 with nontechnical topics (like this one). These kinds of restrictions
327 are acceptable because they don't obstruct the community's normal use
330 However, it must be possible to modify all the @emph{technical}
331 content of the manual, and then distribute the result in all the usual
332 media, through all the usual channels. Otherwise, the restrictions
333 obstruct the use of the manual, it is not free, and we need another
334 manual to replace it.
336 Please spread the word about this issue. Our community continues to
337 lose manuals to proprietary publishing. If we spread the word that
338 free software needs free reference manuals and free tutorials, perhaps
339 the next person who wants to contribute by writing documentation will
340 realize, before it is too late, that only free manuals contribute to
341 the free software community.
343 If you are writing documentation, please insist on publishing it under
344 the GNU Free Documentation License or another free documentation
345 license. Remember that this decision requires your approval---you
346 don't have to let the publisher decide. Some commercial publishers
347 will use a free license if you insist, but they will not propose the
348 option; it is up to you to raise the issue and say firmly that this is
349 what you want. If the publisher you are dealing with refuses, please
350 try other publishers. If you're not sure whether a proposed license
351 is free, write to @email{licensing@@gnu.org}.
353 You can encourage commercial publishers to sell more free, copylefted
354 manuals and tutorials by buying them, and particularly by buying
355 copies from the publishers that paid for their writing or for major
356 improvements. Meanwhile, try to avoid buying non-free documentation
357 at all. Check the distribution terms of a manual before you buy it,
358 and insist that whoever seeks your business must respect your freedom.
359 Check the history of the book, and try to reward the publishers that
360 have paid or pay the authors to work on it.
362 The Free Software Foundation maintains a list of free documentation
363 published by other publishers, at
364 @url{http://www.fsf.org/doc/other-free-books.html}.
367 @unnumberedsec Contributors to @value{GDBN}
369 Richard Stallman was the original author of @value{GDBN}, and of many
370 other @sc{gnu} programs. Many others have contributed to its
371 development. This section attempts to credit major contributors. One
372 of the virtues of free software is that everyone is free to contribute
373 to it; with regret, we cannot actually acknowledge everyone here. The
374 file @file{ChangeLog} in the @value{GDBN} distribution approximates a
375 blow-by-blow account.
377 Changes much prior to version 2.0 are lost in the mists of time.
380 @emph{Plea:} Additions to this section are particularly welcome. If you
381 or your friends (or enemies, to be evenhanded) have been unfairly
382 omitted from this list, we would like to add your names!
385 So that they may not regard their many labors as thankless, we
386 particularly thank those who shepherded @value{GDBN} through major
388 Andrew Cagney (releases 6.3, 6.2, 6.1, 6.0, 5.3, 5.2, 5.1 and 5.0);
389 Jim Blandy (release 4.18);
390 Jason Molenda (release 4.17);
391 Stan Shebs (release 4.14);
392 Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9);
393 Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4);
394 John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9);
395 Jim Kingdon (releases 3.5, 3.4, and 3.3);
396 and Randy Smith (releases 3.2, 3.1, and 3.0).
398 Richard Stallman, assisted at various times by Peter TerMaat, Chris
399 Hanson, and Richard Mlynarik, handled releases through 2.8.
401 Michael Tiemann is the author of most of the @sc{gnu} C@t{++} support
402 in @value{GDBN}, with significant additional contributions from Per
403 Bothner and Daniel Berlin. James Clark wrote the @sc{gnu} C@t{++}
404 demangler. Early work on C@t{++} was by Peter TerMaat (who also did
405 much general update work leading to release 3.0).
407 @value{GDBN} uses the BFD subroutine library to examine multiple
408 object-file formats; BFD was a joint project of David V.
409 Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore.
411 David Johnson wrote the original COFF support; Pace Willison did
412 the original support for encapsulated COFF.
414 Brent Benson of Harris Computer Systems contributed DWARF 2 support.
416 Adam de Boor and Bradley Davis contributed the ISI Optimum V support.
417 Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS
419 Jean-Daniel Fekete contributed Sun 386i support.
420 Chris Hanson improved the HP9000 support.
421 Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support.
422 David Johnson contributed Encore Umax support.
423 Jyrki Kuoppala contributed Altos 3068 support.
424 Jeff Law contributed HP PA and SOM support.
425 Keith Packard contributed NS32K support.
426 Doug Rabson contributed Acorn Risc Machine support.
427 Bob Rusk contributed Harris Nighthawk CX-UX support.
428 Chris Smith contributed Convex support (and Fortran debugging).
429 Jonathan Stone contributed Pyramid support.
430 Michael Tiemann contributed SPARC support.
431 Tim Tucker contributed support for the Gould NP1 and Gould Powernode.
432 Pace Willison contributed Intel 386 support.
433 Jay Vosburgh contributed Symmetry support.
434 Marko Mlinar contributed OpenRISC 1000 support.
436 Andreas Schwab contributed M68K @sc{gnu}/Linux support.
438 Rich Schaefer and Peter Schauer helped with support of SunOS shared
441 Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree
442 about several machine instruction sets.
444 Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop
445 remote debugging. Intel Corporation, Wind River Systems, AMD, and ARM
446 contributed remote debugging modules for the i960, VxWorks, A29K UDI,
447 and RDI targets, respectively.
449 Brian Fox is the author of the readline libraries providing
450 command-line editing and command history.
452 Andrew Beers of SUNY Buffalo wrote the language-switching code, the
453 Modula-2 support, and contributed the Languages chapter of this manual.
455 Fred Fish wrote most of the support for Unix System Vr4.
456 He also enhanced the command-completion support to cover C@t{++} overloaded
459 Hitachi America (now Renesas America), Ltd. sponsored the support for
460 H8/300, H8/500, and Super-H processors.
462 NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors.
464 Mitsubishi (now Renesas) sponsored the support for D10V, D30V, and M32R/D
467 Toshiba sponsored the support for the TX39 Mips processor.
469 Matsushita sponsored the support for the MN10200 and MN10300 processors.
471 Fujitsu sponsored the support for SPARClite and FR30 processors.
473 Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware
476 Michael Snyder added support for tracepoints.
478 Stu Grossman wrote gdbserver.
480 Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made
481 nearly innumerable bug fixes and cleanups throughout @value{GDBN}.
483 The following people at the Hewlett-Packard Company contributed
484 support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0
485 (narrow mode), HP's implementation of kernel threads, HP's aC@t{++}
486 compiler, and the Text User Interface (nee Terminal User Interface):
487 Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann,
488 Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni. Kim Haase
489 provided HP-specific information in this manual.
491 DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project.
492 Robert Hoehne made significant contributions to the DJGPP port.
494 Cygnus Solutions has sponsored @value{GDBN} maintenance and much of its
495 development since 1991. Cygnus engineers who have worked on @value{GDBN}
496 fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin
497 Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim
498 Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler,
499 Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek
500 Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni. In
501 addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton,
502 JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug
503 Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff
504 Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner,
505 Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin
506 Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela
507 Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David
508 Zuhn have made contributions both large and small.
510 Andrew Cagney, Fernando Nasser, and Elena Zannoni, while working for
511 Cygnus Solutions, implemented the original @sc{gdb/mi} interface.
513 Jim Blandy added support for preprocessor macros, while working for Red
516 Andrew Cagney designed @value{GDBN}'s architecture vector. Many
517 people including Andrew Cagney, Stephane Carrez, Randolph Chung, Nick
518 Duffek, Richard Henderson, Mark Kettenis, Grace Sainsbury, Kei
519 Sakamoto, Yoshinori Sato, Michael Snyder, Andreas Schwab, Jason
520 Thorpe, Corinna Vinschen, Ulrich Weigand, and Elena Zannoni, helped
521 with the migration of old architectures to this new framework.
523 Andrew Cagney completely re-designed and re-implemented @value{GDBN}'s
524 unwinder framework, this consisting of a fresh new design featuring
525 frame IDs, independent frame sniffers, and the sentinel frame. Mark
526 Kettenis implemented the @sc{dwarf 2} unwinder, Jeff Johnston the
527 libunwind unwinder, and Andrew Cagney the dummy, sentinel, tramp, and
528 trad unwinders. The architecture-specific changes, each involving a
529 complete rewrite of the architecture's frame code, were carried out by
530 Jim Blandy, Joel Brobecker, Kevin Buettner, Andrew Cagney, Stephane
531 Carrez, Randolph Chung, Orjan Friberg, Richard Henderson, Daniel
532 Jacobowitz, Jeff Johnston, Mark Kettenis, Theodore A. Roth, Kei
533 Sakamoto, Yoshinori Sato, Michael Snyder, Corinna Vinschen, and Ulrich
536 Christian Zankel, Ross Morley, Bob Wilson, and Maxim Grigoriev from
537 Tensilica, Inc.@: contributed support for Xtensa processors. Others
538 who have worked on the Xtensa port of @value{GDBN} in the past include
539 Steve Tjiang, John Newlin, and Scott Foehner.
541 Michael Eager and staff of Xilinx, Inc., contributed support for the
542 Xilinx MicroBlaze architecture.
545 @chapter A Sample @value{GDBN} Session
547 You can use this manual at your leisure to read all about @value{GDBN}.
548 However, a handful of commands are enough to get started using the
549 debugger. This chapter illustrates those commands.
552 In this sample session, we emphasize user input like this: @b{input},
553 to make it easier to pick out from the surrounding output.
556 @c FIXME: this example may not be appropriate for some configs, where
557 @c FIXME...primary interest is in remote use.
559 One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro
560 processor) exhibits the following bug: sometimes, when we change its
561 quote strings from the default, the commands used to capture one macro
562 definition within another stop working. In the following short @code{m4}
563 session, we define a macro @code{foo} which expands to @code{0000}; we
564 then use the @code{m4} built-in @code{defn} to define @code{bar} as the
565 same thing. However, when we change the open quote string to
566 @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same
567 procedure fails to define a new synonym @code{baz}:
576 @b{define(bar,defn(`foo'))}
580 @b{changequote(<QUOTE>,<UNQUOTE>)}
582 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
585 m4: End of input: 0: fatal error: EOF in string
589 Let us use @value{GDBN} to try to see what is going on.
592 $ @b{@value{GDBP} m4}
593 @c FIXME: this falsifies the exact text played out, to permit smallbook
594 @c FIXME... format to come out better.
595 @value{GDBN} is free software and you are welcome to distribute copies
596 of it under certain conditions; type "show copying" to see
598 There is absolutely no warranty for @value{GDBN}; type "show warranty"
601 @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc...
606 @value{GDBN} reads only enough symbol data to know where to find the
607 rest when needed; as a result, the first prompt comes up very quickly.
608 We now tell @value{GDBN} to use a narrower display width than usual, so
609 that examples fit in this manual.
612 (@value{GDBP}) @b{set width 70}
616 We need to see how the @code{m4} built-in @code{changequote} works.
617 Having looked at the source, we know the relevant subroutine is
618 @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
619 @code{break} command.
622 (@value{GDBP}) @b{break m4_changequote}
623 Breakpoint 1 at 0x62f4: file builtin.c, line 879.
627 Using the @code{run} command, we start @code{m4} running under @value{GDBN}
628 control; as long as control does not reach the @code{m4_changequote}
629 subroutine, the program runs as usual:
632 (@value{GDBP}) @b{run}
633 Starting program: /work/Editorial/gdb/gnu/m4/m4
641 To trigger the breakpoint, we call @code{changequote}. @value{GDBN}
642 suspends execution of @code{m4}, displaying information about the
643 context where it stops.
646 @b{changequote(<QUOTE>,<UNQUOTE>)}
648 Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
650 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))
654 Now we use the command @code{n} (@code{next}) to advance execution to
655 the next line of the current function.
659 882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
664 @code{set_quotes} looks like a promising subroutine. We can go into it
665 by using the command @code{s} (@code{step}) instead of @code{next}.
666 @code{step} goes to the next line to be executed in @emph{any}
667 subroutine, so it steps into @code{set_quotes}.
671 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
673 530 if (lquote != def_lquote)
677 The display that shows the subroutine where @code{m4} is now
678 suspended (and its arguments) is called a stack frame display. It
679 shows a summary of the stack. We can use the @code{backtrace}
680 command (which can also be spelled @code{bt}), to see where we are
681 in the stack as a whole: the @code{backtrace} command displays a
682 stack frame for each active subroutine.
685 (@value{GDBP}) @b{bt}
686 #0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
688 #1 0x6344 in m4_changequote (argc=3, argv=0x33c70)
690 #2 0x8174 in expand_macro (sym=0x33320) at macro.c:242
691 #3 0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
693 #4 0x79dc in expand_input () at macro.c:40
694 #5 0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195
698 We step through a few more lines to see what happens. The first two
699 times, we can use @samp{s}; the next two times we use @code{n} to avoid
700 falling into the @code{xstrdup} subroutine.
704 0x3b5c 532 if (rquote != def_rquote)
706 0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \
707 def_lquote : xstrdup(lq);
709 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
712 538 len_lquote = strlen(rquote);
716 The last line displayed looks a little odd; we can examine the variables
717 @code{lquote} and @code{rquote} to see if they are in fact the new left
718 and right quotes we specified. We use the command @code{p}
719 (@code{print}) to see their values.
722 (@value{GDBP}) @b{p lquote}
723 $1 = 0x35d40 "<QUOTE>"
724 (@value{GDBP}) @b{p rquote}
725 $2 = 0x35d50 "<UNQUOTE>"
729 @code{lquote} and @code{rquote} are indeed the new left and right quotes.
730 To look at some context, we can display ten lines of source
731 surrounding the current line with the @code{l} (@code{list}) command.
737 535 lquote = (lq == nil || *lq == '\0') ? def_lquote\
739 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
742 538 len_lquote = strlen(rquote);
743 539 len_rquote = strlen(lquote);
750 Let us step past the two lines that set @code{len_lquote} and
751 @code{len_rquote}, and then examine the values of those variables.
755 539 len_rquote = strlen(lquote);
758 (@value{GDBP}) @b{p len_lquote}
760 (@value{GDBP}) @b{p len_rquote}
765 That certainly looks wrong, assuming @code{len_lquote} and
766 @code{len_rquote} are meant to be the lengths of @code{lquote} and
767 @code{rquote} respectively. We can set them to better values using
768 the @code{p} command, since it can print the value of
769 any expression---and that expression can include subroutine calls and
773 (@value{GDBP}) @b{p len_lquote=strlen(lquote)}
775 (@value{GDBP}) @b{p len_rquote=strlen(rquote)}
780 Is that enough to fix the problem of using the new quotes with the
781 @code{m4} built-in @code{defn}? We can allow @code{m4} to continue
782 executing with the @code{c} (@code{continue}) command, and then try the
783 example that caused trouble initially:
789 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
796 Success! The new quotes now work just as well as the default ones. The
797 problem seems to have been just the two typos defining the wrong
798 lengths. We allow @code{m4} exit by giving it an EOF as input:
802 Program exited normally.
806 The message @samp{Program exited normally.} is from @value{GDBN}; it
807 indicates @code{m4} has finished executing. We can end our @value{GDBN}
808 session with the @value{GDBN} @code{quit} command.
811 (@value{GDBP}) @b{quit}
815 @chapter Getting In and Out of @value{GDBN}
817 This chapter discusses how to start @value{GDBN}, and how to get out of it.
821 type @samp{@value{GDBP}} to start @value{GDBN}.
823 type @kbd{quit} or @kbd{Ctrl-d} to exit.
827 * Invoking GDB:: How to start @value{GDBN}
828 * Quitting GDB:: How to quit @value{GDBN}
829 * Shell Commands:: How to use shell commands inside @value{GDBN}
830 * Logging Output:: How to log @value{GDBN}'s output to a file
834 @section Invoking @value{GDBN}
836 Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started,
837 @value{GDBN} reads commands from the terminal until you tell it to exit.
839 You can also run @code{@value{GDBP}} with a variety of arguments and options,
840 to specify more of your debugging environment at the outset.
842 The command-line options described here are designed
843 to cover a variety of situations; in some environments, some of these
844 options may effectively be unavailable.
846 The most usual way to start @value{GDBN} is with one argument,
847 specifying an executable program:
850 @value{GDBP} @var{program}
854 You can also start with both an executable program and a core file
858 @value{GDBP} @var{program} @var{core}
861 You can, instead, specify a process ID as a second argument, if you want
862 to debug a running process:
865 @value{GDBP} @var{program} 1234
869 would attach @value{GDBN} to process @code{1234} (unless you also have a file
870 named @file{1234}; @value{GDBN} does check for a core file first).
872 Taking advantage of the second command-line argument requires a fairly
873 complete operating system; when you use @value{GDBN} as a remote
874 debugger attached to a bare board, there may not be any notion of
875 ``process'', and there is often no way to get a core dump. @value{GDBN}
876 will warn you if it is unable to attach or to read core dumps.
878 You can optionally have @code{@value{GDBP}} pass any arguments after the
879 executable file to the inferior using @code{--args}. This option stops
882 @value{GDBP} --args gcc -O2 -c foo.c
884 This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
885 @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}.
887 You can run @code{@value{GDBP}} without printing the front material, which describes
888 @value{GDBN}'s non-warranty, by specifying @code{--silent}
889 (or @code{-q}/@code{--quiet}):
892 @value{GDBP} --silent
896 You can further control how @value{GDBN} starts up by using command-line
897 options. @value{GDBN} itself can remind you of the options available.
907 to display all available options and briefly describe their use
908 (@samp{@value{GDBP} -h} is a shorter equivalent).
910 All options and command line arguments you give are processed
911 in sequential order. The order makes a difference when the
912 @samp{-x} option is used.
916 * File Options:: Choosing files
917 * Mode Options:: Choosing modes
918 * Startup:: What @value{GDBN} does during startup
922 @subsection Choosing Files
924 When @value{GDBN} starts, it reads any arguments other than options as
925 specifying an executable file and core file (or process ID). This is
926 the same as if the arguments were specified by the @samp{-se} and
927 @samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the
928 first argument that does not have an associated option flag as
929 equivalent to the @samp{-se} option followed by that argument; and the
930 second argument that does not have an associated option flag, if any, as
931 equivalent to the @samp{-c}/@samp{-p} option followed by that argument.)
932 If the second argument begins with a decimal digit, @value{GDBN} will
933 first attempt to attach to it as a process, and if that fails, attempt
934 to open it as a corefile. If you have a corefile whose name begins with
935 a digit, you can prevent @value{GDBN} from treating it as a pid by
936 prefixing it with @file{./}, e.g.@: @file{./12345}.
938 If @value{GDBN} has not been configured to included core file support,
939 such as for most embedded targets, then it will complain about a second
940 argument and ignore it.
942 Many options have both long and short forms; both are shown in the
943 following list. @value{GDBN} also recognizes the long forms if you truncate
944 them, so long as enough of the option is present to be unambiguous.
945 (If you prefer, you can flag option arguments with @samp{--} rather
946 than @samp{-}, though we illustrate the more usual convention.)
948 @c NOTE: the @cindex entries here use double dashes ON PURPOSE. This
949 @c way, both those who look for -foo and --foo in the index, will find
953 @item -symbols @var{file}
955 @cindex @code{--symbols}
957 Read symbol table from file @var{file}.
959 @item -exec @var{file}
961 @cindex @code{--exec}
963 Use file @var{file} as the executable file to execute when appropriate,
964 and for examining pure data in conjunction with a core dump.
968 Read symbol table from file @var{file} and use it as the executable
971 @item -core @var{file}
973 @cindex @code{--core}
975 Use file @var{file} as a core dump to examine.
977 @item -pid @var{number}
978 @itemx -p @var{number}
981 Connect to process ID @var{number}, as with the @code{attach} command.
983 @item -command @var{file}
985 @cindex @code{--command}
987 Execute commands from file @var{file}. The contents of this file is
988 evaluated exactly as the @code{source} command would.
989 @xref{Command Files,, Command files}.
991 @item -eval-command @var{command}
992 @itemx -ex @var{command}
993 @cindex @code{--eval-command}
995 Execute a single @value{GDBN} command.
997 This option may be used multiple times to call multiple commands. It may
998 also be interleaved with @samp{-command} as required.
1001 @value{GDBP} -ex 'target sim' -ex 'load' \
1002 -x setbreakpoints -ex 'run' a.out
1005 @item -init-command @var{file}
1006 @itemx -ix @var{file}
1007 @cindex @code{--init-command}
1009 Execute commands from file @var{file} before loading the inferior (but
1010 after loading gdbinit files).
1013 @item -init-eval-command @var{command}
1014 @itemx -iex @var{command}
1015 @cindex @code{--init-eval-command}
1017 Execute a single @value{GDBN} command before loading the inferior (but
1018 after loading gdbinit files).
1021 @item -directory @var{directory}
1022 @itemx -d @var{directory}
1023 @cindex @code{--directory}
1025 Add @var{directory} to the path to search for source and script files.
1029 @cindex @code{--readnow}
1031 Read each symbol file's entire symbol table immediately, rather than
1032 the default, which is to read it incrementally as it is needed.
1033 This makes startup slower, but makes future operations faster.
1038 @subsection Choosing Modes
1040 You can run @value{GDBN} in various alternative modes---for example, in
1041 batch mode or quiet mode.
1049 Do not execute commands found in any initialization file.
1050 There are three init files, loaded in the following order:
1053 @item @file{system.gdbinit}
1054 This is the system-wide init file.
1055 Its location is specified with the @code{--with-system-gdbinit}
1056 configure option (@pxref{System-wide configuration}).
1057 It is loaded first when @value{GDBN} starts, before command line options
1058 have been processed.
1059 @item @file{~/.gdbinit}
1060 This is the init file in your home directory.
1061 It is loaded next, after @file{system.gdbinit}, and before
1062 command options have been processed.
1063 @item @file{./.gdbinit}
1064 This is the init file in the current directory.
1065 It is loaded last, after command line options other than @code{-x} and
1066 @code{-ex} have been processed. Command line options @code{-x} and
1067 @code{-ex} are processed last, after @file{./.gdbinit} has been loaded.
1070 For further documentation on startup processing, @xref{Startup}.
1071 For documentation on how to write command files,
1072 @xref{Command Files,,Command Files}.
1077 Do not execute commands found in @file{~/.gdbinit}, the init file
1078 in your home directory.
1084 @cindex @code{--quiet}
1085 @cindex @code{--silent}
1087 ``Quiet''. Do not print the introductory and copyright messages. These
1088 messages are also suppressed in batch mode.
1091 @cindex @code{--batch}
1092 Run in batch mode. Exit with status @code{0} after processing all the
1093 command files specified with @samp{-x} (and all commands from
1094 initialization files, if not inhibited with @samp{-n}). Exit with
1095 nonzero status if an error occurs in executing the @value{GDBN} commands
1096 in the command files. Batch mode also disables pagination, sets unlimited
1097 terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm
1098 off} were in effect (@pxref{Messages/Warnings}).
1100 Batch mode may be useful for running @value{GDBN} as a filter, for
1101 example to download and run a program on another computer; in order to
1102 make this more useful, the message
1105 Program exited normally.
1109 (which is ordinarily issued whenever a program running under
1110 @value{GDBN} control terminates) is not issued when running in batch
1114 @cindex @code{--batch-silent}
1115 Run in batch mode exactly like @samp{-batch}, but totally silently. All
1116 @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is
1117 unaffected). This is much quieter than @samp{-silent} and would be useless
1118 for an interactive session.
1120 This is particularly useful when using targets that give @samp{Loading section}
1121 messages, for example.
1123 Note that targets that give their output via @value{GDBN}, as opposed to
1124 writing directly to @code{stdout}, will also be made silent.
1126 @item -return-child-result
1127 @cindex @code{--return-child-result}
1128 The return code from @value{GDBN} will be the return code from the child
1129 process (the process being debugged), with the following exceptions:
1133 @value{GDBN} exits abnormally. E.g., due to an incorrect argument or an
1134 internal error. In this case the exit code is the same as it would have been
1135 without @samp{-return-child-result}.
1137 The user quits with an explicit value. E.g., @samp{quit 1}.
1139 The child process never runs, or is not allowed to terminate, in which case
1140 the exit code will be -1.
1143 This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent},
1144 when @value{GDBN} is being used as a remote program loader or simulator
1149 @cindex @code{--nowindows}
1151 ``No windows''. If @value{GDBN} comes with a graphical user interface
1152 (GUI) built in, then this option tells @value{GDBN} to only use the command-line
1153 interface. If no GUI is available, this option has no effect.
1157 @cindex @code{--windows}
1159 If @value{GDBN} includes a GUI, then this option requires it to be
1162 @item -cd @var{directory}
1164 Run @value{GDBN} using @var{directory} as its working directory,
1165 instead of the current directory.
1167 @item -data-directory @var{directory}
1168 @itemx -D @var{directory}
1169 @cindex @code{--data-directory}
1171 Run @value{GDBN} using @var{directory} as its data directory.
1172 The data directory is where @value{GDBN} searches for its
1173 auxiliary files. @xref{Data Files}.
1177 @cindex @code{--fullname}
1179 @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
1180 subprocess. It tells @value{GDBN} to output the full file name and line
1181 number in a standard, recognizable fashion each time a stack frame is
1182 displayed (which includes each time your program stops). This
1183 recognizable format looks like two @samp{\032} characters, followed by
1184 the file name, line number and character position separated by colons,
1185 and a newline. The Emacs-to-@value{GDBN} interface program uses the two
1186 @samp{\032} characters as a signal to display the source code for the
1189 @item -annotate @var{level}
1190 @cindex @code{--annotate}
1191 This option sets the @dfn{annotation level} inside @value{GDBN}. Its
1192 effect is identical to using @samp{set annotate @var{level}}
1193 (@pxref{Annotations}). The annotation @var{level} controls how much
1194 information @value{GDBN} prints together with its prompt, values of
1195 expressions, source lines, and other types of output. Level 0 is the
1196 normal, level 1 is for use when @value{GDBN} is run as a subprocess of
1197 @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs
1198 that control @value{GDBN}, and level 2 has been deprecated.
1200 The annotation mechanism has largely been superseded by @sc{gdb/mi}
1204 @cindex @code{--args}
1205 Change interpretation of command line so that arguments following the
1206 executable file are passed as command line arguments to the inferior.
1207 This option stops option processing.
1209 @item -baud @var{bps}
1211 @cindex @code{--baud}
1213 Set the line speed (baud rate or bits per second) of any serial
1214 interface used by @value{GDBN} for remote debugging.
1216 @item -l @var{timeout}
1218 Set the timeout (in seconds) of any communication used by @value{GDBN}
1219 for remote debugging.
1221 @item -tty @var{device}
1222 @itemx -t @var{device}
1223 @cindex @code{--tty}
1225 Run using @var{device} for your program's standard input and output.
1226 @c FIXME: kingdon thinks there is more to -tty. Investigate.
1228 @c resolve the situation of these eventually
1230 @cindex @code{--tui}
1231 Activate the @dfn{Text User Interface} when starting. The Text User
1232 Interface manages several text windows on the terminal, showing
1233 source, assembly, registers and @value{GDBN} command outputs
1234 (@pxref{TUI, ,@value{GDBN} Text User Interface}). Do not use this
1235 option if you run @value{GDBN} from Emacs (@pxref{Emacs, ,
1236 Using @value{GDBN} under @sc{gnu} Emacs}).
1238 @item -interpreter @var{interp}
1239 @cindex @code{--interpreter}
1240 Use the interpreter @var{interp} for interface with the controlling
1241 program or device. This option is meant to be set by programs which
1242 communicate with @value{GDBN} using it as a back end.
1243 @xref{Interpreters, , Command Interpreters}.
1245 @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes
1246 @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, ,
1247 The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0. The
1248 previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and
1249 selected with @samp{--interpreter=mi1}, is deprecated. Earlier
1250 @sc{gdb/mi} interfaces are no longer supported.
1253 @cindex @code{--write}
1254 Open the executable and core files for both reading and writing. This
1255 is equivalent to the @samp{set write on} command inside @value{GDBN}
1259 @cindex @code{--statistics}
1260 This option causes @value{GDBN} to print statistics about time and
1261 memory usage after it completes each command and returns to the prompt.
1264 @cindex @code{--version}
1265 This option causes @value{GDBN} to print its version number and
1266 no-warranty blurb, and exit.
1268 @item -configuration
1269 @cindex @code{--configuration}
1270 This option causes @value{GDBN} to print details about its build-time
1271 configuration parameters, and then exit. These details can be
1272 important when reporting @value{GDBN} bugs (@pxref{GDB Bugs}).
1277 @subsection What @value{GDBN} Does During Startup
1278 @cindex @value{GDBN} startup
1280 Here's the description of what @value{GDBN} does during session startup:
1284 Sets up the command interpreter as specified by the command line
1285 (@pxref{Mode Options, interpreter}).
1289 Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was
1290 used when building @value{GDBN}; @pxref{System-wide configuration,
1291 ,System-wide configuration and settings}) and executes all the commands in
1294 @anchor{Home Directory Init File}
1296 Reads the init file (if any) in your home directory@footnote{On
1297 DOS/Windows systems, the home directory is the one pointed to by the
1298 @code{HOME} environment variable.} and executes all the commands in
1301 @anchor{Option -init-eval-command}
1303 Executes commands and command files specified by the @samp{-iex} and
1304 @samp{-ix} options in their specified order. Usually you should use the
1305 @samp{-ex} and @samp{-x} options instead, but this way you can apply
1306 settings before @value{GDBN} init files get executed and before inferior
1310 Processes command line options and operands.
1312 @anchor{Init File in the Current Directory during Startup}
1314 Reads and executes the commands from init file (if any) in the current
1315 working directory as long as @samp{set auto-load local-gdbinit} is set to
1316 @samp{on} (@pxref{Init File in the Current Directory}).
1317 This is only done if the current directory is
1318 different from your home directory. Thus, you can have more than one
1319 init file, one generic in your home directory, and another, specific
1320 to the program you are debugging, in the directory where you invoke
1324 If the command line specified a program to debug, or a process to
1325 attach to, or a core file, @value{GDBN} loads any auto-loaded
1326 scripts provided for the program or for its loaded shared libraries.
1327 @xref{Auto-loading}.
1329 If you wish to disable the auto-loading during startup,
1330 you must do something like the following:
1333 $ gdb -iex "set auto-load python-scripts off" myprogram
1336 Option @samp{-ex} does not work because the auto-loading is then turned
1340 Executes commands and command files specified by the @samp{-ex} and
1341 @samp{-x} options in their specified order. @xref{Command Files}, for
1342 more details about @value{GDBN} command files.
1345 Reads the command history recorded in the @dfn{history file}.
1346 @xref{Command History}, for more details about the command history and the
1347 files where @value{GDBN} records it.
1350 Init files use the same syntax as @dfn{command files} (@pxref{Command
1351 Files}) and are processed by @value{GDBN} in the same way. The init
1352 file in your home directory can set options (such as @samp{set
1353 complaints}) that affect subsequent processing of command line options
1354 and operands. Init files are not executed if you use the @samp{-nx}
1355 option (@pxref{Mode Options, ,Choosing Modes}).
1357 To display the list of init files loaded by gdb at startup, you
1358 can use @kbd{gdb --help}.
1360 @cindex init file name
1361 @cindex @file{.gdbinit}
1362 @cindex @file{gdb.ini}
1363 The @value{GDBN} init files are normally called @file{.gdbinit}.
1364 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
1365 the limitations of file names imposed by DOS filesystems. The Windows
1366 port of @value{GDBN} uses the standard name, but if it finds a
1367 @file{gdb.ini} file in your home directory, it warns you about that
1368 and suggests to rename the file to the standard name.
1372 @section Quitting @value{GDBN}
1373 @cindex exiting @value{GDBN}
1374 @cindex leaving @value{GDBN}
1377 @kindex quit @r{[}@var{expression}@r{]}
1378 @kindex q @r{(@code{quit})}
1379 @item quit @r{[}@var{expression}@r{]}
1381 To exit @value{GDBN}, use the @code{quit} command (abbreviated
1382 @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you
1383 do not supply @var{expression}, @value{GDBN} will terminate normally;
1384 otherwise it will terminate using the result of @var{expression} as the
1389 An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather
1390 terminates the action of any @value{GDBN} command that is in progress and
1391 returns to @value{GDBN} command level. It is safe to type the interrupt
1392 character at any time because @value{GDBN} does not allow it to take effect
1393 until a time when it is safe.
1395 If you have been using @value{GDBN} to control an attached process or
1396 device, you can release it with the @code{detach} command
1397 (@pxref{Attach, ,Debugging an Already-running Process}).
1399 @node Shell Commands
1400 @section Shell Commands
1402 If you need to execute occasional shell commands during your
1403 debugging session, there is no need to leave or suspend @value{GDBN}; you can
1404 just use the @code{shell} command.
1409 @cindex shell escape
1410 @item shell @var{command-string}
1411 @itemx !@var{command-string}
1412 Invoke a standard shell to execute @var{command-string}.
1413 Note that no space is needed between @code{!} and @var{command-string}.
1414 If it exists, the environment variable @code{SHELL} determines which
1415 shell to run. Otherwise @value{GDBN} uses the default shell
1416 (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.).
1419 The utility @code{make} is often needed in development environments.
1420 You do not have to use the @code{shell} command for this purpose in
1425 @cindex calling make
1426 @item make @var{make-args}
1427 Execute the @code{make} program with the specified
1428 arguments. This is equivalent to @samp{shell make @var{make-args}}.
1431 @node Logging Output
1432 @section Logging Output
1433 @cindex logging @value{GDBN} output
1434 @cindex save @value{GDBN} output to a file
1436 You may want to save the output of @value{GDBN} commands to a file.
1437 There are several commands to control @value{GDBN}'s logging.
1441 @item set logging on
1443 @item set logging off
1445 @cindex logging file name
1446 @item set logging file @var{file}
1447 Change the name of the current logfile. The default logfile is @file{gdb.txt}.
1448 @item set logging overwrite [on|off]
1449 By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if
1450 you want @code{set logging on} to overwrite the logfile instead.
1451 @item set logging redirect [on|off]
1452 By default, @value{GDBN} output will go to both the terminal and the logfile.
1453 Set @code{redirect} if you want output to go only to the log file.
1454 @kindex show logging
1456 Show the current values of the logging settings.
1460 @chapter @value{GDBN} Commands
1462 You can abbreviate a @value{GDBN} command to the first few letters of the command
1463 name, if that abbreviation is unambiguous; and you can repeat certain
1464 @value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB}
1465 key to get @value{GDBN} to fill out the rest of a word in a command (or to
1466 show you the alternatives available, if there is more than one possibility).
1469 * Command Syntax:: How to give commands to @value{GDBN}
1470 * Completion:: Command completion
1471 * Help:: How to ask @value{GDBN} for help
1474 @node Command Syntax
1475 @section Command Syntax
1477 A @value{GDBN} command is a single line of input. There is no limit on
1478 how long it can be. It starts with a command name, which is followed by
1479 arguments whose meaning depends on the command name. For example, the
1480 command @code{step} accepts an argument which is the number of times to
1481 step, as in @samp{step 5}. You can also use the @code{step} command
1482 with no arguments. Some commands do not allow any arguments.
1484 @cindex abbreviation
1485 @value{GDBN} command names may always be truncated if that abbreviation is
1486 unambiguous. Other possible command abbreviations are listed in the
1487 documentation for individual commands. In some cases, even ambiguous
1488 abbreviations are allowed; for example, @code{s} is specially defined as
1489 equivalent to @code{step} even though there are other commands whose
1490 names start with @code{s}. You can test abbreviations by using them as
1491 arguments to the @code{help} command.
1493 @cindex repeating commands
1494 @kindex RET @r{(repeat last command)}
1495 A blank line as input to @value{GDBN} (typing just @key{RET}) means to
1496 repeat the previous command. Certain commands (for example, @code{run})
1497 will not repeat this way; these are commands whose unintentional
1498 repetition might cause trouble and which you are unlikely to want to
1499 repeat. User-defined commands can disable this feature; see
1500 @ref{Define, dont-repeat}.
1502 The @code{list} and @code{x} commands, when you repeat them with
1503 @key{RET}, construct new arguments rather than repeating
1504 exactly as typed. This permits easy scanning of source or memory.
1506 @value{GDBN} can also use @key{RET} in another way: to partition lengthy
1507 output, in a way similar to the common utility @code{more}
1508 (@pxref{Screen Size,,Screen Size}). Since it is easy to press one
1509 @key{RET} too many in this situation, @value{GDBN} disables command
1510 repetition after any command that generates this sort of display.
1512 @kindex # @r{(a comment)}
1514 Any text from a @kbd{#} to the end of the line is a comment; it does
1515 nothing. This is useful mainly in command files (@pxref{Command
1516 Files,,Command Files}).
1518 @cindex repeating command sequences
1519 @kindex Ctrl-o @r{(operate-and-get-next)}
1520 The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of
1521 commands. This command accepts the current line, like @key{RET}, and
1522 then fetches the next line relative to the current line from the history
1526 @section Command Completion
1529 @cindex word completion
1530 @value{GDBN} can fill in the rest of a word in a command for you, if there is
1531 only one possibility; it can also show you what the valid possibilities
1532 are for the next word in a command, at any time. This works for @value{GDBN}
1533 commands, @value{GDBN} subcommands, and the names of symbols in your program.
1535 Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
1536 of a word. If there is only one possibility, @value{GDBN} fills in the
1537 word, and waits for you to finish the command (or press @key{RET} to
1538 enter it). For example, if you type
1540 @c FIXME "@key" does not distinguish its argument sufficiently to permit
1541 @c complete accuracy in these examples; space introduced for clarity.
1542 @c If texinfo enhancements make it unnecessary, it would be nice to
1543 @c replace " @key" by "@key" in the following...
1545 (@value{GDBP}) info bre @key{TAB}
1549 @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
1550 the only @code{info} subcommand beginning with @samp{bre}:
1553 (@value{GDBP}) info breakpoints
1557 You can either press @key{RET} at this point, to run the @code{info
1558 breakpoints} command, or backspace and enter something else, if
1559 @samp{breakpoints} does not look like the command you expected. (If you
1560 were sure you wanted @code{info breakpoints} in the first place, you
1561 might as well just type @key{RET} immediately after @samp{info bre},
1562 to exploit command abbreviations rather than command completion).
1564 If there is more than one possibility for the next word when you press
1565 @key{TAB}, @value{GDBN} sounds a bell. You can either supply more
1566 characters and try again, or just press @key{TAB} a second time;
1567 @value{GDBN} displays all the possible completions for that word. For
1568 example, you might want to set a breakpoint on a subroutine whose name
1569 begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
1570 just sounds the bell. Typing @key{TAB} again displays all the
1571 function names in your program that begin with those characters, for
1575 (@value{GDBP}) b make_ @key{TAB}
1576 @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
1577 make_a_section_from_file make_environ
1578 make_abs_section make_function_type
1579 make_blockvector make_pointer_type
1580 make_cleanup make_reference_type
1581 make_command make_symbol_completion_list
1582 (@value{GDBP}) b make_
1586 After displaying the available possibilities, @value{GDBN} copies your
1587 partial input (@samp{b make_} in the example) so you can finish the
1590 If you just want to see the list of alternatives in the first place, you
1591 can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?}
1592 means @kbd{@key{META} ?}. You can type this either by holding down a
1593 key designated as the @key{META} shift on your keyboard (if there is
1594 one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}.
1596 If the number of possible completions is large, @value{GDBN} will
1597 print as much of the list as it has collected, as well as a message
1598 indicating that the list may be truncated.
1601 (@value{GDBP}) b m@key{TAB}@key{TAB}
1603 <... the rest of the possible completions ...>
1604 *** List may be truncated, max-completions reached. ***
1609 This behavior can be controlled with the following commands:
1612 @kindex set max-completions
1613 @item set max-completions @var{limit}
1614 @itemx set max-completions unlimited
1615 Set the maximum number of completion candidates. @value{GDBN} will
1616 stop looking for more completions once it collects this many candidates.
1617 This is useful when completing on things like function names as collecting
1618 all the possible candidates can be time consuming.
1619 The default value is 200. A value of zero disables tab-completion.
1620 Note that setting either no limit or a very large limit can make
1622 @kindex show max-completions
1623 @item show max-completions
1624 Show the maximum number of candidates that @value{GDBN} will collect and show
1628 @cindex quotes in commands
1629 @cindex completion of quoted strings
1630 Sometimes the string you need, while logically a ``word'', may contain
1631 parentheses or other characters that @value{GDBN} normally excludes from
1632 its notion of a word. To permit word completion to work in this
1633 situation, you may enclose words in @code{'} (single quote marks) in
1634 @value{GDBN} commands.
1636 The most likely situation where you might need this is in typing the
1637 name of a C@t{++} function. This is because C@t{++} allows function
1638 overloading (multiple definitions of the same function, distinguished
1639 by argument type). For example, when you want to set a breakpoint you
1640 may need to distinguish whether you mean the version of @code{name}
1641 that takes an @code{int} parameter, @code{name(int)}, or the version
1642 that takes a @code{float} parameter, @code{name(float)}. To use the
1643 word-completion facilities in this situation, type a single quote
1644 @code{'} at the beginning of the function name. This alerts
1645 @value{GDBN} that it may need to consider more information than usual
1646 when you press @key{TAB} or @kbd{M-?} to request word completion:
1649 (@value{GDBP}) b 'bubble( @kbd{M-?}
1650 bubble(double,double) bubble(int,int)
1651 (@value{GDBP}) b 'bubble(
1654 In some cases, @value{GDBN} can tell that completing a name requires using
1655 quotes. When this happens, @value{GDBN} inserts the quote for you (while
1656 completing as much as it can) if you do not type the quote in the first
1660 (@value{GDBP}) b bub @key{TAB}
1661 @exdent @value{GDBN} alters your input line to the following, and rings a bell:
1662 (@value{GDBP}) b 'bubble(
1666 In general, @value{GDBN} can tell that a quote is needed (and inserts it) if
1667 you have not yet started typing the argument list when you ask for
1668 completion on an overloaded symbol.
1670 For more information about overloaded functions, see @ref{C Plus Plus
1671 Expressions, ,C@t{++} Expressions}. You can use the command @code{set
1672 overload-resolution off} to disable overload resolution;
1673 see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}.
1675 @cindex completion of structure field names
1676 @cindex structure field name completion
1677 @cindex completion of union field names
1678 @cindex union field name completion
1679 When completing in an expression which looks up a field in a
1680 structure, @value{GDBN} also tries@footnote{The completer can be
1681 confused by certain kinds of invalid expressions. Also, it only
1682 examines the static type of the expression, not the dynamic type.} to
1683 limit completions to the field names available in the type of the
1687 (@value{GDBP}) p gdb_stdout.@kbd{M-?}
1688 magic to_fputs to_rewind
1689 to_data to_isatty to_write
1690 to_delete to_put to_write_async_safe
1695 This is because the @code{gdb_stdout} is a variable of the type
1696 @code{struct ui_file} that is defined in @value{GDBN} sources as
1703 ui_file_flush_ftype *to_flush;
1704 ui_file_write_ftype *to_write;
1705 ui_file_write_async_safe_ftype *to_write_async_safe;
1706 ui_file_fputs_ftype *to_fputs;
1707 ui_file_read_ftype *to_read;
1708 ui_file_delete_ftype *to_delete;
1709 ui_file_isatty_ftype *to_isatty;
1710 ui_file_rewind_ftype *to_rewind;
1711 ui_file_put_ftype *to_put;
1718 @section Getting Help
1719 @cindex online documentation
1722 You can always ask @value{GDBN} itself for information on its commands,
1723 using the command @code{help}.
1726 @kindex h @r{(@code{help})}
1729 You can use @code{help} (abbreviated @code{h}) with no arguments to
1730 display a short list of named classes of commands:
1734 List of classes of commands:
1736 aliases -- Aliases of other commands
1737 breakpoints -- Making program stop at certain points
1738 data -- Examining data
1739 files -- Specifying and examining files
1740 internals -- Maintenance commands
1741 obscure -- Obscure features
1742 running -- Running the program
1743 stack -- Examining the stack
1744 status -- Status inquiries
1745 support -- Support facilities
1746 tracepoints -- Tracing of program execution without
1747 stopping the program
1748 user-defined -- User-defined commands
1750 Type "help" followed by a class name for a list of
1751 commands in that class.
1752 Type "help" followed by command name for full
1754 Command name abbreviations are allowed if unambiguous.
1757 @c the above line break eliminates huge line overfull...
1759 @item help @var{class}
1760 Using one of the general help classes as an argument, you can get a
1761 list of the individual commands in that class. For example, here is the
1762 help display for the class @code{status}:
1765 (@value{GDBP}) help status
1770 @c Line break in "show" line falsifies real output, but needed
1771 @c to fit in smallbook page size.
1772 info -- Generic command for showing things
1773 about the program being debugged
1774 show -- Generic command for showing things
1777 Type "help" followed by command name for full
1779 Command name abbreviations are allowed if unambiguous.
1783 @item help @var{command}
1784 With a command name as @code{help} argument, @value{GDBN} displays a
1785 short paragraph on how to use that command.
1788 @item apropos @var{args}
1789 The @code{apropos} command searches through all of the @value{GDBN}
1790 commands, and their documentation, for the regular expression specified in
1791 @var{args}. It prints out all matches found. For example:
1802 alias -- Define a new command that is an alias of an existing command
1803 aliases -- Aliases of other commands
1804 d -- Delete some breakpoints or auto-display expressions
1805 del -- Delete some breakpoints or auto-display expressions
1806 delete -- Delete some breakpoints or auto-display expressions
1811 @item complete @var{args}
1812 The @code{complete @var{args}} command lists all the possible completions
1813 for the beginning of a command. Use @var{args} to specify the beginning of the
1814 command you want completed. For example:
1820 @noindent results in:
1831 @noindent This is intended for use by @sc{gnu} Emacs.
1834 In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
1835 and @code{show} to inquire about the state of your program, or the state
1836 of @value{GDBN} itself. Each command supports many topics of inquiry; this
1837 manual introduces each of them in the appropriate context. The listings
1838 under @code{info} and under @code{show} in the Command, Variable, and
1839 Function Index point to all the sub-commands. @xref{Command and Variable
1845 @kindex i @r{(@code{info})}
1847 This command (abbreviated @code{i}) is for describing the state of your
1848 program. For example, you can show the arguments passed to a function
1849 with @code{info args}, list the registers currently in use with @code{info
1850 registers}, or list the breakpoints you have set with @code{info breakpoints}.
1851 You can get a complete list of the @code{info} sub-commands with
1852 @w{@code{help info}}.
1856 You can assign the result of an expression to an environment variable with
1857 @code{set}. For example, you can set the @value{GDBN} prompt to a $-sign with
1858 @code{set prompt $}.
1862 In contrast to @code{info}, @code{show} is for describing the state of
1863 @value{GDBN} itself.
1864 You can change most of the things you can @code{show}, by using the
1865 related command @code{set}; for example, you can control what number
1866 system is used for displays with @code{set radix}, or simply inquire
1867 which is currently in use with @code{show radix}.
1870 To display all the settable parameters and their current
1871 values, you can use @code{show} with no arguments; you may also use
1872 @code{info set}. Both commands produce the same display.
1873 @c FIXME: "info set" violates the rule that "info" is for state of
1874 @c FIXME...program. Ck w/ GNU: "info set" to be called something else,
1875 @c FIXME...or change desc of rule---eg "state of prog and debugging session"?
1879 Here are several miscellaneous @code{show} subcommands, all of which are
1880 exceptional in lacking corresponding @code{set} commands:
1883 @kindex show version
1884 @cindex @value{GDBN} version number
1886 Show what version of @value{GDBN} is running. You should include this
1887 information in @value{GDBN} bug-reports. If multiple versions of
1888 @value{GDBN} are in use at your site, you may need to determine which
1889 version of @value{GDBN} you are running; as @value{GDBN} evolves, new
1890 commands are introduced, and old ones may wither away. Also, many
1891 system vendors ship variant versions of @value{GDBN}, and there are
1892 variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well.
1893 The version number is the same as the one announced when you start
1896 @kindex show copying
1897 @kindex info copying
1898 @cindex display @value{GDBN} copyright
1901 Display information about permission for copying @value{GDBN}.
1903 @kindex show warranty
1904 @kindex info warranty
1906 @itemx info warranty
1907 Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty,
1908 if your version of @value{GDBN} comes with one.
1910 @kindex show configuration
1911 @item show configuration
1912 Display detailed information about the way @value{GDBN} was configured
1913 when it was built. This displays the optional arguments passed to the
1914 @file{configure} script and also configuration parameters detected
1915 automatically by @command{configure}. When reporting a @value{GDBN}
1916 bug (@pxref{GDB Bugs}), it is important to include this information in
1922 @chapter Running Programs Under @value{GDBN}
1924 When you run a program under @value{GDBN}, you must first generate
1925 debugging information when you compile it.
1927 You may start @value{GDBN} with its arguments, if any, in an environment
1928 of your choice. If you are doing native debugging, you may redirect
1929 your program's input and output, debug an already running process, or
1930 kill a child process.
1933 * Compilation:: Compiling for debugging
1934 * Starting:: Starting your program
1935 * Arguments:: Your program's arguments
1936 * Environment:: Your program's environment
1938 * Working Directory:: Your program's working directory
1939 * Input/Output:: Your program's input and output
1940 * Attach:: Debugging an already-running process
1941 * Kill Process:: Killing the child process
1943 * Inferiors and Programs:: Debugging multiple inferiors and programs
1944 * Threads:: Debugging programs with multiple threads
1945 * Forks:: Debugging forks
1946 * Checkpoint/Restart:: Setting a @emph{bookmark} to return to later
1950 @section Compiling for Debugging
1952 In order to debug a program effectively, you need to generate
1953 debugging information when you compile it. This debugging information
1954 is stored in the object file; it describes the data type of each
1955 variable or function and the correspondence between source line numbers
1956 and addresses in the executable code.
1958 To request debugging information, specify the @samp{-g} option when you run
1961 Programs that are to be shipped to your customers are compiled with
1962 optimizations, using the @samp{-O} compiler option. However, some
1963 compilers are unable to handle the @samp{-g} and @samp{-O} options
1964 together. Using those compilers, you cannot generate optimized
1965 executables containing debugging information.
1967 @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or
1968 without @samp{-O}, making it possible to debug optimized code. We
1969 recommend that you @emph{always} use @samp{-g} whenever you compile a
1970 program. You may think your program is correct, but there is no sense
1971 in pushing your luck. For more information, see @ref{Optimized Code}.
1973 Older versions of the @sc{gnu} C compiler permitted a variant option
1974 @w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this
1975 format; if your @sc{gnu} C compiler has this option, do not use it.
1977 @value{GDBN} knows about preprocessor macros and can show you their
1978 expansion (@pxref{Macros}). Most compilers do not include information
1979 about preprocessor macros in the debugging information if you specify
1980 the @option{-g} flag alone. Version 3.1 and later of @value{NGCC},
1981 the @sc{gnu} C compiler, provides macro information if you are using
1982 the DWARF debugging format, and specify the option @option{-g3}.
1984 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
1985 gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}, for more
1986 information on @value{NGCC} options affecting debug information.
1988 You will have the best debugging experience if you use the latest
1989 version of the DWARF debugging format that your compiler supports.
1990 DWARF is currently the most expressive and best supported debugging
1991 format in @value{GDBN}.
1995 @section Starting your Program
2001 @kindex r @r{(@code{run})}
2004 Use the @code{run} command to start your program under @value{GDBN}.
2005 You must first specify the program name with an argument to
2006 @value{GDBN} (@pxref{Invocation, ,Getting In and Out of
2007 @value{GDBN}}), or by using the @code{file} or @code{exec-file}
2008 command (@pxref{Files, ,Commands to Specify Files}).
2012 If you are running your program in an execution environment that
2013 supports processes, @code{run} creates an inferior process and makes
2014 that process run your program. In some environments without processes,
2015 @code{run} jumps to the start of your program. Other targets,
2016 like @samp{remote}, are always running. If you get an error
2017 message like this one:
2020 The "remote" target does not support "run".
2021 Try "help target" or "continue".
2025 then use @code{continue} to run your program. You may need @code{load}
2026 first (@pxref{load}).
2028 The execution of a program is affected by certain information it
2029 receives from its superior. @value{GDBN} provides ways to specify this
2030 information, which you must do @emph{before} starting your program. (You
2031 can change it after starting your program, but such changes only affect
2032 your program the next time you start it.) This information may be
2033 divided into four categories:
2036 @item The @emph{arguments.}
2037 Specify the arguments to give your program as the arguments of the
2038 @code{run} command. If a shell is available on your target, the shell
2039 is used to pass the arguments, so that you may use normal conventions
2040 (such as wildcard expansion or variable substitution) in describing
2042 In Unix systems, you can control which shell is used with the
2043 @code{SHELL} environment variable. If you do not define @code{SHELL},
2044 @value{GDBN} uses the default shell (@file{/bin/sh}). You can disable
2045 use of any shell with the @code{set startup-with-shell} command (see
2048 @item The @emph{environment.}
2049 Your program normally inherits its environment from @value{GDBN}, but you can
2050 use the @value{GDBN} commands @code{set environment} and @code{unset
2051 environment} to change parts of the environment that affect
2052 your program. @xref{Environment, ,Your Program's Environment}.
2054 @item The @emph{working directory.}
2055 Your program inherits its working directory from @value{GDBN}. You can set
2056 the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}.
2057 @xref{Working Directory, ,Your Program's Working Directory}.
2059 @item The @emph{standard input and output.}
2060 Your program normally uses the same device for standard input and
2061 standard output as @value{GDBN} is using. You can redirect input and output
2062 in the @code{run} command line, or you can use the @code{tty} command to
2063 set a different device for your program.
2064 @xref{Input/Output, ,Your Program's Input and Output}.
2067 @emph{Warning:} While input and output redirection work, you cannot use
2068 pipes to pass the output of the program you are debugging to another
2069 program; if you attempt this, @value{GDBN} is likely to wind up debugging the
2073 When you issue the @code{run} command, your program begins to execute
2074 immediately. @xref{Stopping, ,Stopping and Continuing}, for discussion
2075 of how to arrange for your program to stop. Once your program has
2076 stopped, you may call functions in your program, using the @code{print}
2077 or @code{call} commands. @xref{Data, ,Examining Data}.
2079 If the modification time of your symbol file has changed since the last
2080 time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
2081 table, and reads it again. When it does this, @value{GDBN} tries to retain
2082 your current breakpoints.
2087 @cindex run to main procedure
2088 The name of the main procedure can vary from language to language.
2089 With C or C@t{++}, the main procedure name is always @code{main}, but
2090 other languages such as Ada do not require a specific name for their
2091 main procedure. The debugger provides a convenient way to start the
2092 execution of the program and to stop at the beginning of the main
2093 procedure, depending on the language used.
2095 The @samp{start} command does the equivalent of setting a temporary
2096 breakpoint at the beginning of the main procedure and then invoking
2097 the @samp{run} command.
2099 @cindex elaboration phase
2100 Some programs contain an @dfn{elaboration} phase where some startup code is
2101 executed before the main procedure is called. This depends on the
2102 languages used to write your program. In C@t{++}, for instance,
2103 constructors for static and global objects are executed before
2104 @code{main} is called. It is therefore possible that the debugger stops
2105 before reaching the main procedure. However, the temporary breakpoint
2106 will remain to halt execution.
2108 Specify the arguments to give to your program as arguments to the
2109 @samp{start} command. These arguments will be given verbatim to the
2110 underlying @samp{run} command. Note that the same arguments will be
2111 reused if no argument is provided during subsequent calls to
2112 @samp{start} or @samp{run}.
2114 It is sometimes necessary to debug the program during elaboration. In
2115 these cases, using the @code{start} command would stop the execution of
2116 your program too late, as the program would have already completed the
2117 elaboration phase. Under these circumstances, insert breakpoints in your
2118 elaboration code before running your program.
2120 @anchor{set exec-wrapper}
2121 @kindex set exec-wrapper
2122 @item set exec-wrapper @var{wrapper}
2123 @itemx show exec-wrapper
2124 @itemx unset exec-wrapper
2125 When @samp{exec-wrapper} is set, the specified wrapper is used to
2126 launch programs for debugging. @value{GDBN} starts your program
2127 with a shell command of the form @kbd{exec @var{wrapper}
2128 @var{program}}. Quoting is added to @var{program} and its
2129 arguments, but not to @var{wrapper}, so you should add quotes if
2130 appropriate for your shell. The wrapper runs until it executes
2131 your program, and then @value{GDBN} takes control.
2133 You can use any program that eventually calls @code{execve} with
2134 its arguments as a wrapper. Several standard Unix utilities do
2135 this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending
2136 with @code{exec "$@@"} will also work.
2138 For example, you can use @code{env} to pass an environment variable to
2139 the debugged program, without setting the variable in your shell's
2143 (@value{GDBP}) set exec-wrapper env 'LD_PRELOAD=libtest.so'
2147 This command is available when debugging locally on most targets, excluding
2148 @sc{djgpp}, Cygwin, MS Windows, and QNX Neutrino.
2150 @kindex set startup-with-shell
2151 @item set startup-with-shell
2152 @itemx set startup-with-shell on
2153 @itemx set startup-with-shell off
2154 @itemx show set startup-with-shell
2155 On Unix systems, by default, if a shell is available on your target,
2156 @value{GDBN}) uses it to start your program. Arguments of the
2157 @code{run} command are passed to the shell, which does variable
2158 substitution, expands wildcard characters and performs redirection of
2159 I/O. In some circumstances, it may be useful to disable such use of a
2160 shell, for example, when debugging the shell itself or diagnosing
2161 startup failures such as:
2165 Starting program: ./a.out
2166 During startup program terminated with signal SIGSEGV, Segmentation fault.
2170 which indicates the shell or the wrapper specified with
2171 @samp{exec-wrapper} crashed, not your program. Most often, this is
2172 caused by something odd in your shell's non-interactive mode
2173 initialization file---such as @file{.cshrc} for C-shell,
2174 $@file{.zshenv} for the Z shell, or the file specified in the
2175 @samp{BASH_ENV} environment variable for BASH.
2177 @anchor{set auto-connect-native-target}
2178 @kindex set auto-connect-native-target
2179 @item set auto-connect-native-target
2180 @itemx set auto-connect-native-target on
2181 @itemx set auto-connect-native-target off
2182 @itemx show auto-connect-native-target
2184 By default, if not connected to any target yet (e.g., with
2185 @code{target remote}), the @code{run} command starts your program as a
2186 native process under @value{GDBN}, on your local machine. If you're
2187 sure you don't want to debug programs on your local machine, you can
2188 tell @value{GDBN} to not connect to the native target automatically
2189 with the @code{set auto-connect-native-target off} command.
2191 If @code{on}, which is the default, and if @value{GDBN} is not
2192 connected to a target already, the @code{run} command automaticaly
2193 connects to the native target, if one is available.
2195 If @code{off}, and if @value{GDBN} is not connected to a target
2196 already, the @code{run} command fails with an error:
2200 Don't know how to run. Try "help target".
2203 If @value{GDBN} is already connected to a target, @value{GDBN} always
2204 uses it with the @code{run} command.
2206 In any case, you can explicitly connect to the native target with the
2207 @code{target native} command. For example,
2210 (@value{GDBP}) set auto-connect-native-target off
2212 Don't know how to run. Try "help target".
2213 (@value{GDBP}) target native
2215 Starting program: ./a.out
2216 [Inferior 1 (process 10421) exited normally]
2219 In case you connected explicitly to the @code{native} target,
2220 @value{GDBN} remains connected even if all inferiors exit, ready for
2221 the next @code{run} command. Use the @code{disconnect} command to
2224 Examples of other commands that likewise respect the
2225 @code{auto-connect-native-target} setting: @code{attach}, @code{info
2226 proc}, @code{info os}.
2228 @kindex set disable-randomization
2229 @item set disable-randomization
2230 @itemx set disable-randomization on
2231 This option (enabled by default in @value{GDBN}) will turn off the native
2232 randomization of the virtual address space of the started program. This option
2233 is useful for multiple debugging sessions to make the execution better
2234 reproducible and memory addresses reusable across debugging sessions.
2236 This feature is implemented only on certain targets, including @sc{gnu}/Linux.
2237 On @sc{gnu}/Linux you can get the same behavior using
2240 (@value{GDBP}) set exec-wrapper setarch `uname -m` -R
2243 @item set disable-randomization off
2244 Leave the behavior of the started executable unchanged. Some bugs rear their
2245 ugly heads only when the program is loaded at certain addresses. If your bug
2246 disappears when you run the program under @value{GDBN}, that might be because
2247 @value{GDBN} by default disables the address randomization on platforms, such
2248 as @sc{gnu}/Linux, which do that for stand-alone programs. Use @kbd{set
2249 disable-randomization off} to try to reproduce such elusive bugs.
2251 On targets where it is available, virtual address space randomization
2252 protects the programs against certain kinds of security attacks. In these
2253 cases the attacker needs to know the exact location of a concrete executable
2254 code. Randomizing its location makes it impossible to inject jumps misusing
2255 a code at its expected addresses.
2257 Prelinking shared libraries provides a startup performance advantage but it
2258 makes addresses in these libraries predictable for privileged processes by
2259 having just unprivileged access at the target system. Reading the shared
2260 library binary gives enough information for assembling the malicious code
2261 misusing it. Still even a prelinked shared library can get loaded at a new
2262 random address just requiring the regular relocation process during the
2263 startup. Shared libraries not already prelinked are always loaded at
2264 a randomly chosen address.
2266 Position independent executables (PIE) contain position independent code
2267 similar to the shared libraries and therefore such executables get loaded at
2268 a randomly chosen address upon startup. PIE executables always load even
2269 already prelinked shared libraries at a random address. You can build such
2270 executable using @command{gcc -fPIE -pie}.
2272 Heap (malloc storage), stack and custom mmap areas are always placed randomly
2273 (as long as the randomization is enabled).
2275 @item show disable-randomization
2276 Show the current setting of the explicit disable of the native randomization of
2277 the virtual address space of the started program.
2282 @section Your Program's Arguments
2284 @cindex arguments (to your program)
2285 The arguments to your program can be specified by the arguments of the
2287 They are passed to a shell, which expands wildcard characters and
2288 performs redirection of I/O, and thence to your program. Your
2289 @code{SHELL} environment variable (if it exists) specifies what shell
2290 @value{GDBN} uses. If you do not define @code{SHELL}, @value{GDBN} uses
2291 the default shell (@file{/bin/sh} on Unix).
2293 On non-Unix systems, the program is usually invoked directly by
2294 @value{GDBN}, which emulates I/O redirection via the appropriate system
2295 calls, and the wildcard characters are expanded by the startup code of
2296 the program, not by the shell.
2298 @code{run} with no arguments uses the same arguments used by the previous
2299 @code{run}, or those set by the @code{set args} command.
2304 Specify the arguments to be used the next time your program is run. If
2305 @code{set args} has no arguments, @code{run} executes your program
2306 with no arguments. Once you have run your program with arguments,
2307 using @code{set args} before the next @code{run} is the only way to run
2308 it again without arguments.
2312 Show the arguments to give your program when it is started.
2316 @section Your Program's Environment
2318 @cindex environment (of your program)
2319 The @dfn{environment} consists of a set of environment variables and
2320 their values. Environment variables conventionally record such things as
2321 your user name, your home directory, your terminal type, and your search
2322 path for programs to run. Usually you set up environment variables with
2323 the shell and they are inherited by all the other programs you run. When
2324 debugging, it can be useful to try running your program with a modified
2325 environment without having to start @value{GDBN} over again.
2329 @item path @var{directory}
2330 Add @var{directory} to the front of the @code{PATH} environment variable
2331 (the search path for executables) that will be passed to your program.
2332 The value of @code{PATH} used by @value{GDBN} does not change.
2333 You may specify several directory names, separated by whitespace or by a
2334 system-dependent separator character (@samp{:} on Unix, @samp{;} on
2335 MS-DOS and MS-Windows). If @var{directory} is already in the path, it
2336 is moved to the front, so it is searched sooner.
2338 You can use the string @samp{$cwd} to refer to whatever is the current
2339 working directory at the time @value{GDBN} searches the path. If you
2340 use @samp{.} instead, it refers to the directory where you executed the
2341 @code{path} command. @value{GDBN} replaces @samp{.} in the
2342 @var{directory} argument (with the current path) before adding
2343 @var{directory} to the search path.
2344 @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
2345 @c document that, since repeating it would be a no-op.
2349 Display the list of search paths for executables (the @code{PATH}
2350 environment variable).
2352 @kindex show environment
2353 @item show environment @r{[}@var{varname}@r{]}
2354 Print the value of environment variable @var{varname} to be given to
2355 your program when it starts. If you do not supply @var{varname},
2356 print the names and values of all environment variables to be given to
2357 your program. You can abbreviate @code{environment} as @code{env}.
2359 @kindex set environment
2360 @item set environment @var{varname} @r{[}=@var{value}@r{]}
2361 Set environment variable @var{varname} to @var{value}. The value
2362 changes for your program (and the shell @value{GDBN} uses to launch
2363 it), not for @value{GDBN} itself. The @var{value} may be any string; the
2364 values of environment variables are just strings, and any
2365 interpretation is supplied by your program itself. The @var{value}
2366 parameter is optional; if it is eliminated, the variable is set to a
2368 @c "any string" here does not include leading, trailing
2369 @c blanks. Gnu asks: does anyone care?
2371 For example, this command:
2378 tells the debugged program, when subsequently run, that its user is named
2379 @samp{foo}. (The spaces around @samp{=} are used for clarity here; they
2380 are not actually required.)
2382 Note that on Unix systems, @value{GDBN} runs your program via a shell,
2383 which also inherits the environment set with @code{set environment}.
2384 If necessary, you can avoid that by using the @samp{env} program as a
2385 wrapper instead of using @code{set environment}. @xref{set
2386 exec-wrapper}, for an example doing just that.
2388 @kindex unset environment
2389 @item unset environment @var{varname}
2390 Remove variable @var{varname} from the environment to be passed to your
2391 program. This is different from @samp{set env @var{varname} =};
2392 @code{unset environment} removes the variable from the environment,
2393 rather than assigning it an empty value.
2396 @emph{Warning:} On Unix systems, @value{GDBN} runs your program using
2397 the shell indicated by your @code{SHELL} environment variable if it
2398 exists (or @code{/bin/sh} if not). If your @code{SHELL} variable
2399 names a shell that runs an initialization file when started
2400 non-interactively---such as @file{.cshrc} for C-shell, $@file{.zshenv}
2401 for the Z shell, or the file specified in the @samp{BASH_ENV}
2402 environment variable for BASH---any variables you set in that file
2403 affect your program. You may wish to move setting of environment
2404 variables to files that are only run when you sign on, such as
2405 @file{.login} or @file{.profile}.
2407 @node Working Directory
2408 @section Your Program's Working Directory
2410 @cindex working directory (of your program)
2411 Each time you start your program with @code{run}, it inherits its
2412 working directory from the current working directory of @value{GDBN}.
2413 The @value{GDBN} working directory is initially whatever it inherited
2414 from its parent process (typically the shell), but you can specify a new
2415 working directory in @value{GDBN} with the @code{cd} command.
2417 The @value{GDBN} working directory also serves as a default for the commands
2418 that specify files for @value{GDBN} to operate on. @xref{Files, ,Commands to
2423 @cindex change working directory
2424 @item cd @r{[}@var{directory}@r{]}
2425 Set the @value{GDBN} working directory to @var{directory}. If not
2426 given, @var{directory} uses @file{'~'}.
2430 Print the @value{GDBN} working directory.
2433 It is generally impossible to find the current working directory of
2434 the process being debugged (since a program can change its directory
2435 during its run). If you work on a system where @value{GDBN} is
2436 configured with the @file{/proc} support, you can use the @code{info
2437 proc} command (@pxref{SVR4 Process Information}) to find out the
2438 current working directory of the debuggee.
2441 @section Your Program's Input and Output
2446 By default, the program you run under @value{GDBN} does input and output to
2447 the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal
2448 to its own terminal modes to interact with you, but it records the terminal
2449 modes your program was using and switches back to them when you continue
2450 running your program.
2453 @kindex info terminal
2455 Displays information recorded by @value{GDBN} about the terminal modes your
2459 You can redirect your program's input and/or output using shell
2460 redirection with the @code{run} command. For example,
2467 starts your program, diverting its output to the file @file{outfile}.
2470 @cindex controlling terminal
2471 Another way to specify where your program should do input and output is
2472 with the @code{tty} command. This command accepts a file name as
2473 argument, and causes this file to be the default for future @code{run}
2474 commands. It also resets the controlling terminal for the child
2475 process, for future @code{run} commands. For example,
2482 directs that processes started with subsequent @code{run} commands
2483 default to do input and output on the terminal @file{/dev/ttyb} and have
2484 that as their controlling terminal.
2486 An explicit redirection in @code{run} overrides the @code{tty} command's
2487 effect on the input/output device, but not its effect on the controlling
2490 When you use the @code{tty} command or redirect input in the @code{run}
2491 command, only the input @emph{for your program} is affected. The input
2492 for @value{GDBN} still comes from your terminal. @code{tty} is an alias
2493 for @code{set inferior-tty}.
2495 @cindex inferior tty
2496 @cindex set inferior controlling terminal
2497 You can use the @code{show inferior-tty} command to tell @value{GDBN} to
2498 display the name of the terminal that will be used for future runs of your
2502 @item set inferior-tty /dev/ttyb
2503 @kindex set inferior-tty
2504 Set the tty for the program being debugged to /dev/ttyb.
2506 @item show inferior-tty
2507 @kindex show inferior-tty
2508 Show the current tty for the program being debugged.
2512 @section Debugging an Already-running Process
2517 @item attach @var{process-id}
2518 This command attaches to a running process---one that was started
2519 outside @value{GDBN}. (@code{info files} shows your active
2520 targets.) The command takes as argument a process ID. The usual way to
2521 find out the @var{process-id} of a Unix process is with the @code{ps} utility,
2522 or with the @samp{jobs -l} shell command.
2524 @code{attach} does not repeat if you press @key{RET} a second time after
2525 executing the command.
2528 To use @code{attach}, your program must be running in an environment
2529 which supports processes; for example, @code{attach} does not work for
2530 programs on bare-board targets that lack an operating system. You must
2531 also have permission to send the process a signal.
2533 When you use @code{attach}, the debugger finds the program running in
2534 the process first by looking in the current working directory, then (if
2535 the program is not found) by using the source file search path
2536 (@pxref{Source Path, ,Specifying Source Directories}). You can also use
2537 the @code{file} command to load the program. @xref{Files, ,Commands to
2540 The first thing @value{GDBN} does after arranging to debug the specified
2541 process is to stop it. You can examine and modify an attached process
2542 with all the @value{GDBN} commands that are ordinarily available when
2543 you start processes with @code{run}. You can insert breakpoints; you
2544 can step and continue; you can modify storage. If you would rather the
2545 process continue running, you may use the @code{continue} command after
2546 attaching @value{GDBN} to the process.
2551 When you have finished debugging the attached process, you can use the
2552 @code{detach} command to release it from @value{GDBN} control. Detaching
2553 the process continues its execution. After the @code{detach} command,
2554 that process and @value{GDBN} become completely independent once more, and you
2555 are ready to @code{attach} another process or start one with @code{run}.
2556 @code{detach} does not repeat if you press @key{RET} again after
2557 executing the command.
2560 If you exit @value{GDBN} while you have an attached process, you detach
2561 that process. If you use the @code{run} command, you kill that process.
2562 By default, @value{GDBN} asks for confirmation if you try to do either of these
2563 things; you can control whether or not you need to confirm by using the
2564 @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and
2568 @section Killing the Child Process
2573 Kill the child process in which your program is running under @value{GDBN}.
2576 This command is useful if you wish to debug a core dump instead of a
2577 running process. @value{GDBN} ignores any core dump file while your program
2580 On some operating systems, a program cannot be executed outside @value{GDBN}
2581 while you have breakpoints set on it inside @value{GDBN}. You can use the
2582 @code{kill} command in this situation to permit running your program
2583 outside the debugger.
2585 The @code{kill} command is also useful if you wish to recompile and
2586 relink your program, since on many systems it is impossible to modify an
2587 executable file while it is running in a process. In this case, when you
2588 next type @code{run}, @value{GDBN} notices that the file has changed, and
2589 reads the symbol table again (while trying to preserve your current
2590 breakpoint settings).
2592 @node Inferiors and Programs
2593 @section Debugging Multiple Inferiors and Programs
2595 @value{GDBN} lets you run and debug multiple programs in a single
2596 session. In addition, @value{GDBN} on some systems may let you run
2597 several programs simultaneously (otherwise you have to exit from one
2598 before starting another). In the most general case, you can have
2599 multiple threads of execution in each of multiple processes, launched
2600 from multiple executables.
2603 @value{GDBN} represents the state of each program execution with an
2604 object called an @dfn{inferior}. An inferior typically corresponds to
2605 a process, but is more general and applies also to targets that do not
2606 have processes. Inferiors may be created before a process runs, and
2607 may be retained after a process exits. Inferiors have unique
2608 identifiers that are different from process ids. Usually each
2609 inferior will also have its own distinct address space, although some
2610 embedded targets may have several inferiors running in different parts
2611 of a single address space. Each inferior may in turn have multiple
2612 threads running in it.
2614 To find out what inferiors exist at any moment, use @w{@code{info
2618 @kindex info inferiors
2619 @item info inferiors
2620 Print a list of all inferiors currently being managed by @value{GDBN}.
2622 @value{GDBN} displays for each inferior (in this order):
2626 the inferior number assigned by @value{GDBN}
2629 the target system's inferior identifier
2632 the name of the executable the inferior is running.
2637 An asterisk @samp{*} preceding the @value{GDBN} inferior number
2638 indicates the current inferior.
2642 @c end table here to get a little more width for example
2645 (@value{GDBP}) info inferiors
2646 Num Description Executable
2647 2 process 2307 hello
2648 * 1 process 3401 goodbye
2651 To switch focus between inferiors, use the @code{inferior} command:
2654 @kindex inferior @var{infno}
2655 @item inferior @var{infno}
2656 Make inferior number @var{infno} the current inferior. The argument
2657 @var{infno} is the inferior number assigned by @value{GDBN}, as shown
2658 in the first field of the @samp{info inferiors} display.
2662 You can get multiple executables into a debugging session via the
2663 @code{add-inferior} and @w{@code{clone-inferior}} commands. On some
2664 systems @value{GDBN} can add inferiors to the debug session
2665 automatically by following calls to @code{fork} and @code{exec}. To
2666 remove inferiors from the debugging session use the
2667 @w{@code{remove-inferiors}} command.
2670 @kindex add-inferior
2671 @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ]
2672 Adds @var{n} inferiors to be run using @var{executable} as the
2673 executable; @var{n} defaults to 1. If no executable is specified,
2674 the inferiors begins empty, with no program. You can still assign or
2675 change the program assigned to the inferior at any time by using the
2676 @code{file} command with the executable name as its argument.
2678 @kindex clone-inferior
2679 @item clone-inferior [ -copies @var{n} ] [ @var{infno} ]
2680 Adds @var{n} inferiors ready to execute the same program as inferior
2681 @var{infno}; @var{n} defaults to 1, and @var{infno} defaults to the
2682 number of the current inferior. This is a convenient command when you
2683 want to run another instance of the inferior you are debugging.
2686 (@value{GDBP}) info inferiors
2687 Num Description Executable
2688 * 1 process 29964 helloworld
2689 (@value{GDBP}) clone-inferior
2692 (@value{GDBP}) info inferiors
2693 Num Description Executable
2695 * 1 process 29964 helloworld
2698 You can now simply switch focus to inferior 2 and run it.
2700 @kindex remove-inferiors
2701 @item remove-inferiors @var{infno}@dots{}
2702 Removes the inferior or inferiors @var{infno}@dots{}. It is not
2703 possible to remove an inferior that is running with this command. For
2704 those, use the @code{kill} or @code{detach} command first.
2708 To quit debugging one of the running inferiors that is not the current
2709 inferior, you can either detach from it by using the @w{@code{detach
2710 inferior}} command (allowing it to run independently), or kill it
2711 using the @w{@code{kill inferiors}} command:
2714 @kindex detach inferiors @var{infno}@dots{}
2715 @item detach inferior @var{infno}@dots{}
2716 Detach from the inferior or inferiors identified by @value{GDBN}
2717 inferior number(s) @var{infno}@dots{}. Note that the inferior's entry
2718 still stays on the list of inferiors shown by @code{info inferiors},
2719 but its Description will show @samp{<null>}.
2721 @kindex kill inferiors @var{infno}@dots{}
2722 @item kill inferiors @var{infno}@dots{}
2723 Kill the inferior or inferiors identified by @value{GDBN} inferior
2724 number(s) @var{infno}@dots{}. Note that the inferior's entry still
2725 stays on the list of inferiors shown by @code{info inferiors}, but its
2726 Description will show @samp{<null>}.
2729 After the successful completion of a command such as @code{detach},
2730 @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after
2731 a normal process exit, the inferior is still valid and listed with
2732 @code{info inferiors}, ready to be restarted.
2735 To be notified when inferiors are started or exit under @value{GDBN}'s
2736 control use @w{@code{set print inferior-events}}:
2739 @kindex set print inferior-events
2740 @cindex print messages on inferior start and exit
2741 @item set print inferior-events
2742 @itemx set print inferior-events on
2743 @itemx set print inferior-events off
2744 The @code{set print inferior-events} command allows you to enable or
2745 disable printing of messages when @value{GDBN} notices that new
2746 inferiors have started or that inferiors have exited or have been
2747 detached. By default, these messages will not be printed.
2749 @kindex show print inferior-events
2750 @item show print inferior-events
2751 Show whether messages will be printed when @value{GDBN} detects that
2752 inferiors have started, exited or have been detached.
2755 Many commands will work the same with multiple programs as with a
2756 single program: e.g., @code{print myglobal} will simply display the
2757 value of @code{myglobal} in the current inferior.
2760 Occasionaly, when debugging @value{GDBN} itself, it may be useful to
2761 get more info about the relationship of inferiors, programs, address
2762 spaces in a debug session. You can do that with the @w{@code{maint
2763 info program-spaces}} command.
2766 @kindex maint info program-spaces
2767 @item maint info program-spaces
2768 Print a list of all program spaces currently being managed by
2771 @value{GDBN} displays for each program space (in this order):
2775 the program space number assigned by @value{GDBN}
2778 the name of the executable loaded into the program space, with e.g.,
2779 the @code{file} command.
2784 An asterisk @samp{*} preceding the @value{GDBN} program space number
2785 indicates the current program space.
2787 In addition, below each program space line, @value{GDBN} prints extra
2788 information that isn't suitable to display in tabular form. For
2789 example, the list of inferiors bound to the program space.
2792 (@value{GDBP}) maint info program-spaces
2795 Bound inferiors: ID 1 (process 21561)
2799 Here we can see that no inferior is running the program @code{hello},
2800 while @code{process 21561} is running the program @code{goodbye}. On
2801 some targets, it is possible that multiple inferiors are bound to the
2802 same program space. The most common example is that of debugging both
2803 the parent and child processes of a @code{vfork} call. For example,
2806 (@value{GDBP}) maint info program-spaces
2809 Bound inferiors: ID 2 (process 18050), ID 1 (process 18045)
2812 Here, both inferior 2 and inferior 1 are running in the same program
2813 space as a result of inferior 1 having executed a @code{vfork} call.
2817 @section Debugging Programs with Multiple Threads
2819 @cindex threads of execution
2820 @cindex multiple threads
2821 @cindex switching threads
2822 In some operating systems, such as HP-UX and Solaris, a single program
2823 may have more than one @dfn{thread} of execution. The precise semantics
2824 of threads differ from one operating system to another, but in general
2825 the threads of a single program are akin to multiple processes---except
2826 that they share one address space (that is, they can all examine and
2827 modify the same variables). On the other hand, each thread has its own
2828 registers and execution stack, and perhaps private memory.
2830 @value{GDBN} provides these facilities for debugging multi-thread
2834 @item automatic notification of new threads
2835 @item @samp{thread @var{threadno}}, a command to switch among threads
2836 @item @samp{info threads}, a command to inquire about existing threads
2837 @item @samp{thread apply [@var{threadno}] [@var{all}] @var{args}},
2838 a command to apply a command to a list of threads
2839 @item thread-specific breakpoints
2840 @item @samp{set print thread-events}, which controls printing of
2841 messages on thread start and exit.
2842 @item @samp{set libthread-db-search-path @var{path}}, which lets
2843 the user specify which @code{libthread_db} to use if the default choice
2844 isn't compatible with the program.
2848 @emph{Warning:} These facilities are not yet available on every
2849 @value{GDBN} configuration where the operating system supports threads.
2850 If your @value{GDBN} does not support threads, these commands have no
2851 effect. For example, a system without thread support shows no output
2852 from @samp{info threads}, and always rejects the @code{thread} command,
2856 (@value{GDBP}) info threads
2857 (@value{GDBP}) thread 1
2858 Thread ID 1 not known. Use the "info threads" command to
2859 see the IDs of currently known threads.
2861 @c FIXME to implementors: how hard would it be to say "sorry, this GDB
2862 @c doesn't support threads"?
2865 @cindex focus of debugging
2866 @cindex current thread
2867 The @value{GDBN} thread debugging facility allows you to observe all
2868 threads while your program runs---but whenever @value{GDBN} takes
2869 control, one thread in particular is always the focus of debugging.
2870 This thread is called the @dfn{current thread}. Debugging commands show
2871 program information from the perspective of the current thread.
2873 @cindex @code{New} @var{systag} message
2874 @cindex thread identifier (system)
2875 @c FIXME-implementors!! It would be more helpful if the [New...] message
2876 @c included GDB's numeric thread handle, so you could just go to that
2877 @c thread without first checking `info threads'.
2878 Whenever @value{GDBN} detects a new thread in your program, it displays
2879 the target system's identification for the thread with a message in the
2880 form @samp{[New @var{systag}]}, where @var{systag} is a thread identifier
2881 whose form varies depending on the particular system. For example, on
2882 @sc{gnu}/Linux, you might see
2885 [New Thread 0x41e02940 (LWP 25582)]
2889 when @value{GDBN} notices a new thread. In contrast, on an SGI system,
2890 the @var{systag} is simply something like @samp{process 368}, with no
2893 @c FIXME!! (1) Does the [New...] message appear even for the very first
2894 @c thread of a program, or does it only appear for the
2895 @c second---i.e.@: when it becomes obvious we have a multithread
2897 @c (2) *Is* there necessarily a first thread always? Or do some
2898 @c multithread systems permit starting a program with multiple
2899 @c threads ab initio?
2901 @cindex thread number
2902 @cindex thread identifier (GDB)
2903 For debugging purposes, @value{GDBN} associates its own thread
2904 number---always a single integer---with each thread in your program.
2907 @kindex info threads
2908 @item info threads @r{[}@var{id}@dots{}@r{]}
2909 Display a summary of all threads currently in your program. Optional
2910 argument @var{id}@dots{} is one or more thread ids separated by spaces, and
2911 means to print information only about the specified thread or threads.
2912 @value{GDBN} displays for each thread (in this order):
2916 the thread number assigned by @value{GDBN}
2919 the target system's thread identifier (@var{systag})
2922 the thread's name, if one is known. A thread can either be named by
2923 the user (see @code{thread name}, below), or, in some cases, by the
2927 the current stack frame summary for that thread
2931 An asterisk @samp{*} to the left of the @value{GDBN} thread number
2932 indicates the current thread.
2936 @c end table here to get a little more width for example
2939 (@value{GDBP}) info threads
2941 3 process 35 thread 27 0x34e5 in sigpause ()
2942 2 process 35 thread 23 0x34e5 in sigpause ()
2943 * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
2947 On Solaris, you can display more information about user threads with a
2948 Solaris-specific command:
2951 @item maint info sol-threads
2952 @kindex maint info sol-threads
2953 @cindex thread info (Solaris)
2954 Display info on Solaris user threads.
2958 @kindex thread @var{threadno}
2959 @item thread @var{threadno}
2960 Make thread number @var{threadno} the current thread. The command
2961 argument @var{threadno} is the internal @value{GDBN} thread number, as
2962 shown in the first field of the @samp{info threads} display.
2963 @value{GDBN} responds by displaying the system identifier of the thread
2964 you selected, and its current stack frame summary:
2967 (@value{GDBP}) thread 2
2968 [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))]
2969 #0 some_function (ignore=0x0) at example.c:8
2970 8 printf ("hello\n");
2974 As with the @samp{[New @dots{}]} message, the form of the text after
2975 @samp{Switching to} depends on your system's conventions for identifying
2978 @vindex $_thread@r{, convenience variable}
2979 The debugger convenience variable @samp{$_thread} contains the number
2980 of the current thread. You may find this useful in writing breakpoint
2981 conditional expressions, command scripts, and so forth. See
2982 @xref{Convenience Vars,, Convenience Variables}, for general
2983 information on convenience variables.
2985 @kindex thread apply
2986 @cindex apply command to several threads
2987 @item thread apply [@var{threadno} | all [-ascending]] @var{command}
2988 The @code{thread apply} command allows you to apply the named
2989 @var{command} to one or more threads. Specify the numbers of the
2990 threads that you want affected with the command argument
2991 @var{threadno}. It can be a single thread number, one of the numbers
2992 shown in the first field of the @samp{info threads} display; or it
2993 could be a range of thread numbers, as in @code{2-4}. To apply
2994 a command to all threads in descending order, type @kbd{thread apply all
2995 @var{command}}. To apply a command to all threads in ascending order,
2996 type @kbd{thread apply all -ascending @var{command}}.
3000 @cindex name a thread
3001 @item thread name [@var{name}]
3002 This command assigns a name to the current thread. If no argument is
3003 given, any existing user-specified name is removed. The thread name
3004 appears in the @samp{info threads} display.
3006 On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to
3007 determine the name of the thread as given by the OS. On these
3008 systems, a name specified with @samp{thread name} will override the
3009 system-give name, and removing the user-specified name will cause
3010 @value{GDBN} to once again display the system-specified name.
3013 @cindex search for a thread
3014 @item thread find [@var{regexp}]
3015 Search for and display thread ids whose name or @var{systag}
3016 matches the supplied regular expression.
3018 As well as being the complement to the @samp{thread name} command,
3019 this command also allows you to identify a thread by its target
3020 @var{systag}. For instance, on @sc{gnu}/Linux, the target @var{systag}
3024 (@value{GDBN}) thread find 26688
3025 Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)'
3026 (@value{GDBN}) info thread 4
3028 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select ()
3031 @kindex set print thread-events
3032 @cindex print messages on thread start and exit
3033 @item set print thread-events
3034 @itemx set print thread-events on
3035 @itemx set print thread-events off
3036 The @code{set print thread-events} command allows you to enable or
3037 disable printing of messages when @value{GDBN} notices that new threads have
3038 started or that threads have exited. By default, these messages will
3039 be printed if detection of these events is supported by the target.
3040 Note that these messages cannot be disabled on all targets.
3042 @kindex show print thread-events
3043 @item show print thread-events
3044 Show whether messages will be printed when @value{GDBN} detects that threads
3045 have started and exited.
3048 @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for
3049 more information about how @value{GDBN} behaves when you stop and start
3050 programs with multiple threads.
3052 @xref{Set Watchpoints,,Setting Watchpoints}, for information about
3053 watchpoints in programs with multiple threads.
3055 @anchor{set libthread-db-search-path}
3057 @kindex set libthread-db-search-path
3058 @cindex search path for @code{libthread_db}
3059 @item set libthread-db-search-path @r{[}@var{path}@r{]}
3060 If this variable is set, @var{path} is a colon-separated list of
3061 directories @value{GDBN} will use to search for @code{libthread_db}.
3062 If you omit @var{path}, @samp{libthread-db-search-path} will be reset to
3063 its default value (@code{$sdir:$pdir} on @sc{gnu}/Linux and Solaris systems).
3064 Internally, the default value comes from the @code{LIBTHREAD_DB_SEARCH_PATH}
3067 On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper''
3068 @code{libthread_db} library to obtain information about threads in the
3069 inferior process. @value{GDBN} will use @samp{libthread-db-search-path}
3070 to find @code{libthread_db}. @value{GDBN} also consults first if inferior
3071 specific thread debugging library loading is enabled
3072 by @samp{set auto-load libthread-db} (@pxref{libthread_db.so.1 file}).
3074 A special entry @samp{$sdir} for @samp{libthread-db-search-path}
3075 refers to the default system directories that are
3076 normally searched for loading shared libraries. The @samp{$sdir} entry
3077 is the only kind not needing to be enabled by @samp{set auto-load libthread-db}
3078 (@pxref{libthread_db.so.1 file}).
3080 A special entry @samp{$pdir} for @samp{libthread-db-search-path}
3081 refers to the directory from which @code{libpthread}
3082 was loaded in the inferior process.
3084 For any @code{libthread_db} library @value{GDBN} finds in above directories,
3085 @value{GDBN} attempts to initialize it with the current inferior process.
3086 If this initialization fails (which could happen because of a version
3087 mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN}
3088 will unload @code{libthread_db}, and continue with the next directory.
3089 If none of @code{libthread_db} libraries initialize successfully,
3090 @value{GDBN} will issue a warning and thread debugging will be disabled.
3092 Setting @code{libthread-db-search-path} is currently implemented
3093 only on some platforms.
3095 @kindex show libthread-db-search-path
3096 @item show libthread-db-search-path
3097 Display current libthread_db search path.
3099 @kindex set debug libthread-db
3100 @kindex show debug libthread-db
3101 @cindex debugging @code{libthread_db}
3102 @item set debug libthread-db
3103 @itemx show debug libthread-db
3104 Turns on or off display of @code{libthread_db}-related events.
3105 Use @code{1} to enable, @code{0} to disable.
3109 @section Debugging Forks
3111 @cindex fork, debugging programs which call
3112 @cindex multiple processes
3113 @cindex processes, multiple
3114 On most systems, @value{GDBN} has no special support for debugging
3115 programs which create additional processes using the @code{fork}
3116 function. When a program forks, @value{GDBN} will continue to debug the
3117 parent process and the child process will run unimpeded. If you have
3118 set a breakpoint in any code which the child then executes, the child
3119 will get a @code{SIGTRAP} signal which (unless it catches the signal)
3120 will cause it to terminate.
3122 However, if you want to debug the child process there is a workaround
3123 which isn't too painful. Put a call to @code{sleep} in the code which
3124 the child process executes after the fork. It may be useful to sleep
3125 only if a certain environment variable is set, or a certain file exists,
3126 so that the delay need not occur when you don't want to run @value{GDBN}
3127 on the child. While the child is sleeping, use the @code{ps} program to
3128 get its process ID. Then tell @value{GDBN} (a new invocation of
3129 @value{GDBN} if you are also debugging the parent process) to attach to
3130 the child process (@pxref{Attach}). From that point on you can debug
3131 the child process just like any other process which you attached to.
3133 On some systems, @value{GDBN} provides support for debugging programs that
3134 create additional processes using the @code{fork} or @code{vfork} functions.
3135 Currently, the only platforms with this feature are HP-UX (11.x and later
3136 only?) and @sc{gnu}/Linux (kernel version 2.5.60 and later).
3138 The fork debugging commands are supported in both native mode and when
3139 connected to @code{gdbserver} using @kbd{target extended-remote}.
3141 By default, when a program forks, @value{GDBN} will continue to debug
3142 the parent process and the child process will run unimpeded.
3144 If you want to follow the child process instead of the parent process,
3145 use the command @w{@code{set follow-fork-mode}}.
3148 @kindex set follow-fork-mode
3149 @item set follow-fork-mode @var{mode}
3150 Set the debugger response to a program call of @code{fork} or
3151 @code{vfork}. A call to @code{fork} or @code{vfork} creates a new
3152 process. The @var{mode} argument can be:
3156 The original process is debugged after a fork. The child process runs
3157 unimpeded. This is the default.
3160 The new process is debugged after a fork. The parent process runs
3165 @kindex show follow-fork-mode
3166 @item show follow-fork-mode
3167 Display the current debugger response to a @code{fork} or @code{vfork} call.
3170 @cindex debugging multiple processes
3171 On Linux, if you want to debug both the parent and child processes, use the
3172 command @w{@code{set detach-on-fork}}.
3175 @kindex set detach-on-fork
3176 @item set detach-on-fork @var{mode}
3177 Tells gdb whether to detach one of the processes after a fork, or
3178 retain debugger control over them both.
3182 The child process (or parent process, depending on the value of
3183 @code{follow-fork-mode}) will be detached and allowed to run
3184 independently. This is the default.
3187 Both processes will be held under the control of @value{GDBN}.
3188 One process (child or parent, depending on the value of
3189 @code{follow-fork-mode}) is debugged as usual, while the other
3194 @kindex show detach-on-fork
3195 @item show detach-on-fork
3196 Show whether detach-on-fork mode is on/off.
3199 If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN}
3200 will retain control of all forked processes (including nested forks).
3201 You can list the forked processes under the control of @value{GDBN} by
3202 using the @w{@code{info inferiors}} command, and switch from one fork
3203 to another by using the @code{inferior} command (@pxref{Inferiors and
3204 Programs, ,Debugging Multiple Inferiors and Programs}).
3206 To quit debugging one of the forked processes, you can either detach
3207 from it by using the @w{@code{detach inferiors}} command (allowing it
3208 to run independently), or kill it using the @w{@code{kill inferiors}}
3209 command. @xref{Inferiors and Programs, ,Debugging Multiple Inferiors
3212 If you ask to debug a child process and a @code{vfork} is followed by an
3213 @code{exec}, @value{GDBN} executes the new target up to the first
3214 breakpoint in the new target. If you have a breakpoint set on
3215 @code{main} in your original program, the breakpoint will also be set on
3216 the child process's @code{main}.
3218 On some systems, when a child process is spawned by @code{vfork}, you
3219 cannot debug the child or parent until an @code{exec} call completes.
3221 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
3222 call executes, the new target restarts. To restart the parent
3223 process, use the @code{file} command with the parent executable name
3224 as its argument. By default, after an @code{exec} call executes,
3225 @value{GDBN} discards the symbols of the previous executable image.
3226 You can change this behaviour with the @w{@code{set follow-exec-mode}}
3230 @kindex set follow-exec-mode
3231 @item set follow-exec-mode @var{mode}
3233 Set debugger response to a program call of @code{exec}. An
3234 @code{exec} call replaces the program image of a process.
3236 @code{follow-exec-mode} can be:
3240 @value{GDBN} creates a new inferior and rebinds the process to this
3241 new inferior. The program the process was running before the
3242 @code{exec} call can be restarted afterwards by restarting the
3248 (@value{GDBP}) info inferiors
3250 Id Description Executable
3253 process 12020 is executing new program: prog2
3254 Program exited normally.
3255 (@value{GDBP}) info inferiors
3256 Id Description Executable
3262 @value{GDBN} keeps the process bound to the same inferior. The new
3263 executable image replaces the previous executable loaded in the
3264 inferior. Restarting the inferior after the @code{exec} call, with
3265 e.g., the @code{run} command, restarts the executable the process was
3266 running after the @code{exec} call. This is the default mode.
3271 (@value{GDBP}) info inferiors
3272 Id Description Executable
3275 process 12020 is executing new program: prog2
3276 Program exited normally.
3277 (@value{GDBP}) info inferiors
3278 Id Description Executable
3285 You can use the @code{catch} command to make @value{GDBN} stop whenever
3286 a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set
3287 Catchpoints, ,Setting Catchpoints}.
3289 @node Checkpoint/Restart
3290 @section Setting a @emph{Bookmark} to Return to Later
3295 @cindex snapshot of a process
3296 @cindex rewind program state
3298 On certain operating systems@footnote{Currently, only
3299 @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a
3300 program's state, called a @dfn{checkpoint}, and come back to it
3303 Returning to a checkpoint effectively undoes everything that has
3304 happened in the program since the @code{checkpoint} was saved. This
3305 includes changes in memory, registers, and even (within some limits)
3306 system state. Effectively, it is like going back in time to the
3307 moment when the checkpoint was saved.
3309 Thus, if you're stepping thru a program and you think you're
3310 getting close to the point where things go wrong, you can save
3311 a checkpoint. Then, if you accidentally go too far and miss
3312 the critical statement, instead of having to restart your program
3313 from the beginning, you can just go back to the checkpoint and
3314 start again from there.
3316 This can be especially useful if it takes a lot of time or
3317 steps to reach the point where you think the bug occurs.
3319 To use the @code{checkpoint}/@code{restart} method of debugging:
3324 Save a snapshot of the debugged program's current execution state.
3325 The @code{checkpoint} command takes no arguments, but each checkpoint
3326 is assigned a small integer id, similar to a breakpoint id.
3328 @kindex info checkpoints
3329 @item info checkpoints
3330 List the checkpoints that have been saved in the current debugging
3331 session. For each checkpoint, the following information will be
3338 @item Source line, or label
3341 @kindex restart @var{checkpoint-id}
3342 @item restart @var{checkpoint-id}
3343 Restore the program state that was saved as checkpoint number
3344 @var{checkpoint-id}. All program variables, registers, stack frames
3345 etc.@: will be returned to the values that they had when the checkpoint
3346 was saved. In essence, gdb will ``wind back the clock'' to the point
3347 in time when the checkpoint was saved.
3349 Note that breakpoints, @value{GDBN} variables, command history etc.
3350 are not affected by restoring a checkpoint. In general, a checkpoint
3351 only restores things that reside in the program being debugged, not in
3354 @kindex delete checkpoint @var{checkpoint-id}
3355 @item delete checkpoint @var{checkpoint-id}
3356 Delete the previously-saved checkpoint identified by @var{checkpoint-id}.
3360 Returning to a previously saved checkpoint will restore the user state
3361 of the program being debugged, plus a significant subset of the system
3362 (OS) state, including file pointers. It won't ``un-write'' data from
3363 a file, but it will rewind the file pointer to the previous location,
3364 so that the previously written data can be overwritten. For files
3365 opened in read mode, the pointer will also be restored so that the
3366 previously read data can be read again.
3368 Of course, characters that have been sent to a printer (or other
3369 external device) cannot be ``snatched back'', and characters received
3370 from eg.@: a serial device can be removed from internal program buffers,
3371 but they cannot be ``pushed back'' into the serial pipeline, ready to
3372 be received again. Similarly, the actual contents of files that have
3373 been changed cannot be restored (at this time).
3375 However, within those constraints, you actually can ``rewind'' your
3376 program to a previously saved point in time, and begin debugging it
3377 again --- and you can change the course of events so as to debug a
3378 different execution path this time.
3380 @cindex checkpoints and process id
3381 Finally, there is one bit of internal program state that will be
3382 different when you return to a checkpoint --- the program's process
3383 id. Each checkpoint will have a unique process id (or @var{pid}),
3384 and each will be different from the program's original @var{pid}.
3385 If your program has saved a local copy of its process id, this could
3386 potentially pose a problem.
3388 @subsection A Non-obvious Benefit of Using Checkpoints
3390 On some systems such as @sc{gnu}/Linux, address space randomization
3391 is performed on new processes for security reasons. This makes it
3392 difficult or impossible to set a breakpoint, or watchpoint, on an
3393 absolute address if you have to restart the program, since the
3394 absolute location of a symbol will change from one execution to the
3397 A checkpoint, however, is an @emph{identical} copy of a process.
3398 Therefore if you create a checkpoint at (eg.@:) the start of main,
3399 and simply return to that checkpoint instead of restarting the
3400 process, you can avoid the effects of address randomization and
3401 your symbols will all stay in the same place.
3404 @chapter Stopping and Continuing
3406 The principal purposes of using a debugger are so that you can stop your
3407 program before it terminates; or so that, if your program runs into
3408 trouble, you can investigate and find out why.
3410 Inside @value{GDBN}, your program may stop for any of several reasons,
3411 such as a signal, a breakpoint, or reaching a new line after a
3412 @value{GDBN} command such as @code{step}. You may then examine and
3413 change variables, set new breakpoints or remove old ones, and then
3414 continue execution. Usually, the messages shown by @value{GDBN} provide
3415 ample explanation of the status of your program---but you can also
3416 explicitly request this information at any time.
3419 @kindex info program
3421 Display information about the status of your program: whether it is
3422 running or not, what process it is, and why it stopped.
3426 * Breakpoints:: Breakpoints, watchpoints, and catchpoints
3427 * Continuing and Stepping:: Resuming execution
3428 * Skipping Over Functions and Files::
3429 Skipping over functions and files
3431 * Thread Stops:: Stopping and starting multi-thread programs
3435 @section Breakpoints, Watchpoints, and Catchpoints
3438 A @dfn{breakpoint} makes your program stop whenever a certain point in
3439 the program is reached. For each breakpoint, you can add conditions to
3440 control in finer detail whether your program stops. You can set
3441 breakpoints with the @code{break} command and its variants (@pxref{Set
3442 Breaks, ,Setting Breakpoints}), to specify the place where your program
3443 should stop by line number, function name or exact address in the
3446 On some systems, you can set breakpoints in shared libraries before
3447 the executable is run. There is a minor limitation on HP-UX systems:
3448 you must wait until the executable is run in order to set breakpoints
3449 in shared library routines that are not called directly by the program
3450 (for example, routines that are arguments in a @code{pthread_create}
3454 @cindex data breakpoints
3455 @cindex memory tracing
3456 @cindex breakpoint on memory address
3457 @cindex breakpoint on variable modification
3458 A @dfn{watchpoint} is a special breakpoint that stops your program
3459 when the value of an expression changes. The expression may be a value
3460 of a variable, or it could involve values of one or more variables
3461 combined by operators, such as @samp{a + b}. This is sometimes called
3462 @dfn{data breakpoints}. You must use a different command to set
3463 watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside
3464 from that, you can manage a watchpoint like any other breakpoint: you
3465 enable, disable, and delete both breakpoints and watchpoints using the
3468 You can arrange to have values from your program displayed automatically
3469 whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,,
3473 @cindex breakpoint on events
3474 A @dfn{catchpoint} is another special breakpoint that stops your program
3475 when a certain kind of event occurs, such as the throwing of a C@t{++}
3476 exception or the loading of a library. As with watchpoints, you use a
3477 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
3478 Catchpoints}), but aside from that, you can manage a catchpoint like any
3479 other breakpoint. (To stop when your program receives a signal, use the
3480 @code{handle} command; see @ref{Signals, ,Signals}.)
3482 @cindex breakpoint numbers
3483 @cindex numbers for breakpoints
3484 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
3485 catchpoint when you create it; these numbers are successive integers
3486 starting with one. In many of the commands for controlling various
3487 features of breakpoints you use the breakpoint number to say which
3488 breakpoint you want to change. Each breakpoint may be @dfn{enabled} or
3489 @dfn{disabled}; if disabled, it has no effect on your program until you
3492 @cindex breakpoint ranges
3493 @cindex ranges of breakpoints
3494 Some @value{GDBN} commands accept a range of breakpoints on which to
3495 operate. A breakpoint range is either a single breakpoint number, like
3496 @samp{5}, or two such numbers, in increasing order, separated by a
3497 hyphen, like @samp{5-7}. When a breakpoint range is given to a command,
3498 all breakpoints in that range are operated on.
3501 * Set Breaks:: Setting breakpoints
3502 * Set Watchpoints:: Setting watchpoints
3503 * Set Catchpoints:: Setting catchpoints
3504 * Delete Breaks:: Deleting breakpoints
3505 * Disabling:: Disabling breakpoints
3506 * Conditions:: Break conditions
3507 * Break Commands:: Breakpoint command lists
3508 * Dynamic Printf:: Dynamic printf
3509 * Save Breakpoints:: How to save breakpoints in a file
3510 * Static Probe Points:: Listing static probe points
3511 * Error in Breakpoints:: ``Cannot insert breakpoints''
3512 * Breakpoint-related Warnings:: ``Breakpoint address adjusted...''
3516 @subsection Setting Breakpoints
3518 @c FIXME LMB what does GDB do if no code on line of breakpt?
3519 @c consider in particular declaration with/without initialization.
3521 @c FIXME 2 is there stuff on this already? break at fun start, already init?
3524 @kindex b @r{(@code{break})}
3525 @vindex $bpnum@r{, convenience variable}
3526 @cindex latest breakpoint
3527 Breakpoints are set with the @code{break} command (abbreviated
3528 @code{b}). The debugger convenience variable @samp{$bpnum} records the
3529 number of the breakpoint you've set most recently; see @ref{Convenience
3530 Vars,, Convenience Variables}, for a discussion of what you can do with
3531 convenience variables.
3534 @item break @var{location}
3535 Set a breakpoint at the given @var{location}, which can specify a
3536 function name, a line number, or an address of an instruction.
3537 (@xref{Specify Location}, for a list of all the possible ways to
3538 specify a @var{location}.) The breakpoint will stop your program just
3539 before it executes any of the code in the specified @var{location}.
3541 When using source languages that permit overloading of symbols, such as
3542 C@t{++}, a function name may refer to more than one possible place to break.
3543 @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of
3546 It is also possible to insert a breakpoint that will stop the program
3547 only if a specific thread (@pxref{Thread-Specific Breakpoints})
3548 or a specific task (@pxref{Ada Tasks}) hits that breakpoint.
3551 When called without any arguments, @code{break} sets a breakpoint at
3552 the next instruction to be executed in the selected stack frame
3553 (@pxref{Stack, ,Examining the Stack}). In any selected frame but the
3554 innermost, this makes your program stop as soon as control
3555 returns to that frame. This is similar to the effect of a
3556 @code{finish} command in the frame inside the selected frame---except
3557 that @code{finish} does not leave an active breakpoint. If you use
3558 @code{break} without an argument in the innermost frame, @value{GDBN} stops
3559 the next time it reaches the current location; this may be useful
3562 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
3563 least one instruction has been executed. If it did not do this, you
3564 would be unable to proceed past a breakpoint without first disabling the
3565 breakpoint. This rule applies whether or not the breakpoint already
3566 existed when your program stopped.
3568 @item break @dots{} if @var{cond}
3569 Set a breakpoint with condition @var{cond}; evaluate the expression
3570 @var{cond} each time the breakpoint is reached, and stop only if the
3571 value is nonzero---that is, if @var{cond} evaluates as true.
3572 @samp{@dots{}} stands for one of the possible arguments described
3573 above (or no argument) specifying where to break. @xref{Conditions,
3574 ,Break Conditions}, for more information on breakpoint conditions.
3577 @item tbreak @var{args}
3578 Set a breakpoint enabled only for one stop. The @var{args} are the
3579 same as for the @code{break} command, and the breakpoint is set in the same
3580 way, but the breakpoint is automatically deleted after the first time your
3581 program stops there. @xref{Disabling, ,Disabling Breakpoints}.
3584 @cindex hardware breakpoints
3585 @item hbreak @var{args}
3586 Set a hardware-assisted breakpoint. The @var{args} are the same as for the
3587 @code{break} command and the breakpoint is set in the same way, but the
3588 breakpoint requires hardware support and some target hardware may not
3589 have this support. The main purpose of this is EPROM/ROM code
3590 debugging, so you can set a breakpoint at an instruction without
3591 changing the instruction. This can be used with the new trap-generation
3592 provided by SPARClite DSU and most x86-based targets. These targets
3593 will generate traps when a program accesses some data or instruction
3594 address that is assigned to the debug registers. However the hardware
3595 breakpoint registers can take a limited number of breakpoints. For
3596 example, on the DSU, only two data breakpoints can be set at a time, and
3597 @value{GDBN} will reject this command if more than two are used. Delete
3598 or disable unused hardware breakpoints before setting new ones
3599 (@pxref{Disabling, ,Disabling Breakpoints}).
3600 @xref{Conditions, ,Break Conditions}.
3601 For remote targets, you can restrict the number of hardware
3602 breakpoints @value{GDBN} will use, see @ref{set remote
3603 hardware-breakpoint-limit}.
3606 @item thbreak @var{args}
3607 Set a hardware-assisted breakpoint enabled only for one stop. The @var{args}
3608 are the same as for the @code{hbreak} command and the breakpoint is set in
3609 the same way. However, like the @code{tbreak} command,
3610 the breakpoint is automatically deleted after the
3611 first time your program stops there. Also, like the @code{hbreak}
3612 command, the breakpoint requires hardware support and some target hardware
3613 may not have this support. @xref{Disabling, ,Disabling Breakpoints}.
3614 See also @ref{Conditions, ,Break Conditions}.
3617 @cindex regular expression
3618 @cindex breakpoints at functions matching a regexp
3619 @cindex set breakpoints in many functions
3620 @item rbreak @var{regex}
3621 Set breakpoints on all functions matching the regular expression
3622 @var{regex}. This command sets an unconditional breakpoint on all
3623 matches, printing a list of all breakpoints it set. Once these
3624 breakpoints are set, they are treated just like the breakpoints set with
3625 the @code{break} command. You can delete them, disable them, or make
3626 them conditional the same way as any other breakpoint.
3628 The syntax of the regular expression is the standard one used with tools
3629 like @file{grep}. Note that this is different from the syntax used by
3630 shells, so for instance @code{foo*} matches all functions that include
3631 an @code{fo} followed by zero or more @code{o}s. There is an implicit
3632 @code{.*} leading and trailing the regular expression you supply, so to
3633 match only functions that begin with @code{foo}, use @code{^foo}.
3635 @cindex non-member C@t{++} functions, set breakpoint in
3636 When debugging C@t{++} programs, @code{rbreak} is useful for setting
3637 breakpoints on overloaded functions that are not members of any special
3640 @cindex set breakpoints on all functions
3641 The @code{rbreak} command can be used to set breakpoints in
3642 @strong{all} the functions in a program, like this:
3645 (@value{GDBP}) rbreak .
3648 @item rbreak @var{file}:@var{regex}
3649 If @code{rbreak} is called with a filename qualification, it limits
3650 the search for functions matching the given regular expression to the
3651 specified @var{file}. This can be used, for example, to set breakpoints on
3652 every function in a given file:
3655 (@value{GDBP}) rbreak file.c:.
3658 The colon separating the filename qualifier from the regex may
3659 optionally be surrounded by spaces.
3661 @kindex info breakpoints
3662 @cindex @code{$_} and @code{info breakpoints}
3663 @item info breakpoints @r{[}@var{n}@dots{}@r{]}
3664 @itemx info break @r{[}@var{n}@dots{}@r{]}
3665 Print a table of all breakpoints, watchpoints, and catchpoints set and
3666 not deleted. Optional argument @var{n} means print information only
3667 about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)).
3668 For each breakpoint, following columns are printed:
3671 @item Breakpoint Numbers
3673 Breakpoint, watchpoint, or catchpoint.
3675 Whether the breakpoint is marked to be disabled or deleted when hit.
3676 @item Enabled or Disabled
3677 Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints
3678 that are not enabled.
3680 Where the breakpoint is in your program, as a memory address. For a
3681 pending breakpoint whose address is not yet known, this field will
3682 contain @samp{<PENDING>}. Such breakpoint won't fire until a shared
3683 library that has the symbol or line referred by breakpoint is loaded.
3684 See below for details. A breakpoint with several locations will
3685 have @samp{<MULTIPLE>} in this field---see below for details.
3687 Where the breakpoint is in the source for your program, as a file and
3688 line number. For a pending breakpoint, the original string passed to
3689 the breakpoint command will be listed as it cannot be resolved until
3690 the appropriate shared library is loaded in the future.
3694 If a breakpoint is conditional, there are two evaluation modes: ``host'' and
3695 ``target''. If mode is ``host'', breakpoint condition evaluation is done by
3696 @value{GDBN} on the host's side. If it is ``target'', then the condition
3697 is evaluated by the target. The @code{info break} command shows
3698 the condition on the line following the affected breakpoint, together with
3699 its condition evaluation mode in between parentheses.
3701 Breakpoint commands, if any, are listed after that. A pending breakpoint is
3702 allowed to have a condition specified for it. The condition is not parsed for
3703 validity until a shared library is loaded that allows the pending
3704 breakpoint to resolve to a valid location.
3707 @code{info break} with a breakpoint
3708 number @var{n} as argument lists only that breakpoint. The
3709 convenience variable @code{$_} and the default examining-address for
3710 the @code{x} command are set to the address of the last breakpoint
3711 listed (@pxref{Memory, ,Examining Memory}).
3714 @code{info break} displays a count of the number of times the breakpoint
3715 has been hit. This is especially useful in conjunction with the
3716 @code{ignore} command. You can ignore a large number of breakpoint
3717 hits, look at the breakpoint info to see how many times the breakpoint
3718 was hit, and then run again, ignoring one less than that number. This
3719 will get you quickly to the last hit of that breakpoint.
3722 For a breakpoints with an enable count (xref) greater than 1,
3723 @code{info break} also displays that count.
3727 @value{GDBN} allows you to set any number of breakpoints at the same place in
3728 your program. There is nothing silly or meaningless about this. When
3729 the breakpoints are conditional, this is even useful
3730 (@pxref{Conditions, ,Break Conditions}).
3732 @cindex multiple locations, breakpoints
3733 @cindex breakpoints, multiple locations
3734 It is possible that a breakpoint corresponds to several locations
3735 in your program. Examples of this situation are:
3739 Multiple functions in the program may have the same name.
3742 For a C@t{++} constructor, the @value{NGCC} compiler generates several
3743 instances of the function body, used in different cases.
3746 For a C@t{++} template function, a given line in the function can
3747 correspond to any number of instantiations.
3750 For an inlined function, a given source line can correspond to
3751 several places where that function is inlined.
3754 In all those cases, @value{GDBN} will insert a breakpoint at all
3755 the relevant locations.
3757 A breakpoint with multiple locations is displayed in the breakpoint
3758 table using several rows---one header row, followed by one row for
3759 each breakpoint location. The header row has @samp{<MULTIPLE>} in the
3760 address column. The rows for individual locations contain the actual
3761 addresses for locations, and show the functions to which those
3762 locations belong. The number column for a location is of the form
3763 @var{breakpoint-number}.@var{location-number}.
3768 Num Type Disp Enb Address What
3769 1 breakpoint keep y <MULTIPLE>
3771 breakpoint already hit 1 time
3772 1.1 y 0x080486a2 in void foo<int>() at t.cc:8
3773 1.2 y 0x080486ca in void foo<double>() at t.cc:8
3776 Each location can be individually enabled or disabled by passing
3777 @var{breakpoint-number}.@var{location-number} as argument to the
3778 @code{enable} and @code{disable} commands. Note that you cannot
3779 delete the individual locations from the list, you can only delete the
3780 entire list of locations that belong to their parent breakpoint (with
3781 the @kbd{delete @var{num}} command, where @var{num} is the number of
3782 the parent breakpoint, 1 in the above example). Disabling or enabling
3783 the parent breakpoint (@pxref{Disabling}) affects all of the locations
3784 that belong to that breakpoint.
3786 @cindex pending breakpoints
3787 It's quite common to have a breakpoint inside a shared library.
3788 Shared libraries can be loaded and unloaded explicitly,
3789 and possibly repeatedly, as the program is executed. To support
3790 this use case, @value{GDBN} updates breakpoint locations whenever
3791 any shared library is loaded or unloaded. Typically, you would
3792 set a breakpoint in a shared library at the beginning of your
3793 debugging session, when the library is not loaded, and when the
3794 symbols from the library are not available. When you try to set
3795 breakpoint, @value{GDBN} will ask you if you want to set
3796 a so called @dfn{pending breakpoint}---breakpoint whose address
3797 is not yet resolved.
3799 After the program is run, whenever a new shared library is loaded,
3800 @value{GDBN} reevaluates all the breakpoints. When a newly loaded
3801 shared library contains the symbol or line referred to by some
3802 pending breakpoint, that breakpoint is resolved and becomes an
3803 ordinary breakpoint. When a library is unloaded, all breakpoints
3804 that refer to its symbols or source lines become pending again.
3806 This logic works for breakpoints with multiple locations, too. For
3807 example, if you have a breakpoint in a C@t{++} template function, and
3808 a newly loaded shared library has an instantiation of that template,
3809 a new location is added to the list of locations for the breakpoint.
3811 Except for having unresolved address, pending breakpoints do not
3812 differ from regular breakpoints. You can set conditions or commands,
3813 enable and disable them and perform other breakpoint operations.
3815 @value{GDBN} provides some additional commands for controlling what
3816 happens when the @samp{break} command cannot resolve breakpoint
3817 address specification to an address:
3819 @kindex set breakpoint pending
3820 @kindex show breakpoint pending
3822 @item set breakpoint pending auto
3823 This is the default behavior. When @value{GDBN} cannot find the breakpoint
3824 location, it queries you whether a pending breakpoint should be created.
3826 @item set breakpoint pending on
3827 This indicates that an unrecognized breakpoint location should automatically
3828 result in a pending breakpoint being created.
3830 @item set breakpoint pending off
3831 This indicates that pending breakpoints are not to be created. Any
3832 unrecognized breakpoint location results in an error. This setting does
3833 not affect any pending breakpoints previously created.
3835 @item show breakpoint pending
3836 Show the current behavior setting for creating pending breakpoints.
3839 The settings above only affect the @code{break} command and its
3840 variants. Once breakpoint is set, it will be automatically updated
3841 as shared libraries are loaded and unloaded.
3843 @cindex automatic hardware breakpoints
3844 For some targets, @value{GDBN} can automatically decide if hardware or
3845 software breakpoints should be used, depending on whether the
3846 breakpoint address is read-only or read-write. This applies to
3847 breakpoints set with the @code{break} command as well as to internal
3848 breakpoints set by commands like @code{next} and @code{finish}. For
3849 breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware
3852 You can control this automatic behaviour with the following commands::
3854 @kindex set breakpoint auto-hw
3855 @kindex show breakpoint auto-hw
3857 @item set breakpoint auto-hw on
3858 This is the default behavior. When @value{GDBN} sets a breakpoint, it
3859 will try to use the target memory map to decide if software or hardware
3860 breakpoint must be used.
3862 @item set breakpoint auto-hw off
3863 This indicates @value{GDBN} should not automatically select breakpoint
3864 type. If the target provides a memory map, @value{GDBN} will warn when
3865 trying to set software breakpoint at a read-only address.
3868 @value{GDBN} normally implements breakpoints by replacing the program code
3869 at the breakpoint address with a special instruction, which, when
3870 executed, given control to the debugger. By default, the program
3871 code is so modified only when the program is resumed. As soon as
3872 the program stops, @value{GDBN} restores the original instructions. This
3873 behaviour guards against leaving breakpoints inserted in the
3874 target should gdb abrubptly disconnect. However, with slow remote
3875 targets, inserting and removing breakpoint can reduce the performance.
3876 This behavior can be controlled with the following commands::
3878 @kindex set breakpoint always-inserted
3879 @kindex show breakpoint always-inserted
3881 @item set breakpoint always-inserted off
3882 All breakpoints, including newly added by the user, are inserted in
3883 the target only when the target is resumed. All breakpoints are
3884 removed from the target when it stops. This is the default mode.
3886 @item set breakpoint always-inserted on
3887 Causes all breakpoints to be inserted in the target at all times. If
3888 the user adds a new breakpoint, or changes an existing breakpoint, the
3889 breakpoints in the target are updated immediately. A breakpoint is
3890 removed from the target only when breakpoint itself is deleted.
3893 @value{GDBN} handles conditional breakpoints by evaluating these conditions
3894 when a breakpoint breaks. If the condition is true, then the process being
3895 debugged stops, otherwise the process is resumed.
3897 If the target supports evaluating conditions on its end, @value{GDBN} may
3898 download the breakpoint, together with its conditions, to it.
3900 This feature can be controlled via the following commands:
3902 @kindex set breakpoint condition-evaluation
3903 @kindex show breakpoint condition-evaluation
3905 @item set breakpoint condition-evaluation host
3906 This option commands @value{GDBN} to evaluate the breakpoint
3907 conditions on the host's side. Unconditional breakpoints are sent to
3908 the target which in turn receives the triggers and reports them back to GDB
3909 for condition evaluation. This is the standard evaluation mode.
3911 @item set breakpoint condition-evaluation target
3912 This option commands @value{GDBN} to download breakpoint conditions
3913 to the target at the moment of their insertion. The target
3914 is responsible for evaluating the conditional expression and reporting
3915 breakpoint stop events back to @value{GDBN} whenever the condition
3916 is true. Due to limitations of target-side evaluation, some conditions
3917 cannot be evaluated there, e.g., conditions that depend on local data
3918 that is only known to the host. Examples include
3919 conditional expressions involving convenience variables, complex types
3920 that cannot be handled by the agent expression parser and expressions
3921 that are too long to be sent over to the target, specially when the
3922 target is a remote system. In these cases, the conditions will be
3923 evaluated by @value{GDBN}.
3925 @item set breakpoint condition-evaluation auto
3926 This is the default mode. If the target supports evaluating breakpoint
3927 conditions on its end, @value{GDBN} will download breakpoint conditions to
3928 the target (limitations mentioned previously apply). If the target does
3929 not support breakpoint condition evaluation, then @value{GDBN} will fallback
3930 to evaluating all these conditions on the host's side.
3934 @cindex negative breakpoint numbers
3935 @cindex internal @value{GDBN} breakpoints
3936 @value{GDBN} itself sometimes sets breakpoints in your program for
3937 special purposes, such as proper handling of @code{longjmp} (in C
3938 programs). These internal breakpoints are assigned negative numbers,
3939 starting with @code{-1}; @samp{info breakpoints} does not display them.
3940 You can see these breakpoints with the @value{GDBN} maintenance command
3941 @samp{maint info breakpoints} (@pxref{maint info breakpoints}).
3944 @node Set Watchpoints
3945 @subsection Setting Watchpoints
3947 @cindex setting watchpoints
3948 You can use a watchpoint to stop execution whenever the value of an
3949 expression changes, without having to predict a particular place where
3950 this may happen. (This is sometimes called a @dfn{data breakpoint}.)
3951 The expression may be as simple as the value of a single variable, or
3952 as complex as many variables combined by operators. Examples include:
3956 A reference to the value of a single variable.
3959 An address cast to an appropriate data type. For example,
3960 @samp{*(int *)0x12345678} will watch a 4-byte region at the specified
3961 address (assuming an @code{int} occupies 4 bytes).
3964 An arbitrarily complex expression, such as @samp{a*b + c/d}. The
3965 expression can use any operators valid in the program's native
3966 language (@pxref{Languages}).
3969 You can set a watchpoint on an expression even if the expression can
3970 not be evaluated yet. For instance, you can set a watchpoint on
3971 @samp{*global_ptr} before @samp{global_ptr} is initialized.
3972 @value{GDBN} will stop when your program sets @samp{global_ptr} and
3973 the expression produces a valid value. If the expression becomes
3974 valid in some other way than changing a variable (e.g.@: if the memory
3975 pointed to by @samp{*global_ptr} becomes readable as the result of a
3976 @code{malloc} call), @value{GDBN} may not stop until the next time
3977 the expression changes.
3979 @cindex software watchpoints
3980 @cindex hardware watchpoints
3981 Depending on your system, watchpoints may be implemented in software or
3982 hardware. @value{GDBN} does software watchpointing by single-stepping your
3983 program and testing the variable's value each time, which is hundreds of
3984 times slower than normal execution. (But this may still be worth it, to
3985 catch errors where you have no clue what part of your program is the
3988 On some systems, such as HP-UX, PowerPC, @sc{gnu}/Linux and most other
3989 x86-based targets, @value{GDBN} includes support for hardware
3990 watchpoints, which do not slow down the running of your program.
3994 @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]}
3995 Set a watchpoint for an expression. @value{GDBN} will break when the
3996 expression @var{expr} is written into by the program and its value
3997 changes. The simplest (and the most popular) use of this command is
3998 to watch the value of a single variable:
4001 (@value{GDBP}) watch foo
4004 If the command includes a @code{@r{[}thread @var{threadnum}@r{]}}
4005 argument, @value{GDBN} breaks only when the thread identified by
4006 @var{threadnum} changes the value of @var{expr}. If any other threads
4007 change the value of @var{expr}, @value{GDBN} will not break. Note
4008 that watchpoints restricted to a single thread in this way only work
4009 with Hardware Watchpoints.
4011 Ordinarily a watchpoint respects the scope of variables in @var{expr}
4012 (see below). The @code{-location} argument tells @value{GDBN} to
4013 instead watch the memory referred to by @var{expr}. In this case,
4014 @value{GDBN} will evaluate @var{expr}, take the address of the result,
4015 and watch the memory at that address. The type of the result is used
4016 to determine the size of the watched memory. If the expression's
4017 result does not have an address, then @value{GDBN} will print an
4020 The @code{@r{[}mask @var{maskvalue}@r{]}} argument allows creation
4021 of masked watchpoints, if the current architecture supports this
4022 feature (e.g., PowerPC Embedded architecture, see @ref{PowerPC
4023 Embedded}.) A @dfn{masked watchpoint} specifies a mask in addition
4024 to an address to watch. The mask specifies that some bits of an address
4025 (the bits which are reset in the mask) should be ignored when matching
4026 the address accessed by the inferior against the watchpoint address.
4027 Thus, a masked watchpoint watches many addresses simultaneously---those
4028 addresses whose unmasked bits are identical to the unmasked bits in the
4029 watchpoint address. The @code{mask} argument implies @code{-location}.
4033 (@value{GDBP}) watch foo mask 0xffff00ff
4034 (@value{GDBP}) watch *0xdeadbeef mask 0xffffff00
4038 @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]}
4039 Set a watchpoint that will break when the value of @var{expr} is read
4043 @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]}
4044 Set a watchpoint that will break when @var{expr} is either read from
4045 or written into by the program.
4047 @kindex info watchpoints @r{[}@var{n}@dots{}@r{]}
4048 @item info watchpoints @r{[}@var{n}@dots{}@r{]}
4049 This command prints a list of watchpoints, using the same format as
4050 @code{info break} (@pxref{Set Breaks}).
4053 If you watch for a change in a numerically entered address you need to
4054 dereference it, as the address itself is just a constant number which will
4055 never change. @value{GDBN} refuses to create a watchpoint that watches
4056 a never-changing value:
4059 (@value{GDBP}) watch 0x600850
4060 Cannot watch constant value 0x600850.
4061 (@value{GDBP}) watch *(int *) 0x600850
4062 Watchpoint 1: *(int *) 6293584
4065 @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware
4066 watchpoints execute very quickly, and the debugger reports a change in
4067 value at the exact instruction where the change occurs. If @value{GDBN}
4068 cannot set a hardware watchpoint, it sets a software watchpoint, which
4069 executes more slowly and reports the change in value at the next
4070 @emph{statement}, not the instruction, after the change occurs.
4072 @cindex use only software watchpoints
4073 You can force @value{GDBN} to use only software watchpoints with the
4074 @kbd{set can-use-hw-watchpoints 0} command. With this variable set to
4075 zero, @value{GDBN} will never try to use hardware watchpoints, even if
4076 the underlying system supports them. (Note that hardware-assisted
4077 watchpoints that were set @emph{before} setting
4078 @code{can-use-hw-watchpoints} to zero will still use the hardware
4079 mechanism of watching expression values.)
4082 @item set can-use-hw-watchpoints
4083 @kindex set can-use-hw-watchpoints
4084 Set whether or not to use hardware watchpoints.
4086 @item show can-use-hw-watchpoints
4087 @kindex show can-use-hw-watchpoints
4088 Show the current mode of using hardware watchpoints.
4091 For remote targets, you can restrict the number of hardware
4092 watchpoints @value{GDBN} will use, see @ref{set remote
4093 hardware-breakpoint-limit}.
4095 When you issue the @code{watch} command, @value{GDBN} reports
4098 Hardware watchpoint @var{num}: @var{expr}
4102 if it was able to set a hardware watchpoint.
4104 Currently, the @code{awatch} and @code{rwatch} commands can only set
4105 hardware watchpoints, because accesses to data that don't change the
4106 value of the watched expression cannot be detected without examining
4107 every instruction as it is being executed, and @value{GDBN} does not do
4108 that currently. If @value{GDBN} finds that it is unable to set a
4109 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
4110 will print a message like this:
4113 Expression cannot be implemented with read/access watchpoint.
4116 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
4117 data type of the watched expression is wider than what a hardware
4118 watchpoint on the target machine can handle. For example, some systems
4119 can only watch regions that are up to 4 bytes wide; on such systems you
4120 cannot set hardware watchpoints for an expression that yields a
4121 double-precision floating-point number (which is typically 8 bytes
4122 wide). As a work-around, it might be possible to break the large region
4123 into a series of smaller ones and watch them with separate watchpoints.
4125 If you set too many hardware watchpoints, @value{GDBN} might be unable
4126 to insert all of them when you resume the execution of your program.
4127 Since the precise number of active watchpoints is unknown until such
4128 time as the program is about to be resumed, @value{GDBN} might not be
4129 able to warn you about this when you set the watchpoints, and the
4130 warning will be printed only when the program is resumed:
4133 Hardware watchpoint @var{num}: Could not insert watchpoint
4137 If this happens, delete or disable some of the watchpoints.
4139 Watching complex expressions that reference many variables can also
4140 exhaust the resources available for hardware-assisted watchpoints.
4141 That's because @value{GDBN} needs to watch every variable in the
4142 expression with separately allocated resources.
4144 If you call a function interactively using @code{print} or @code{call},
4145 any watchpoints you have set will be inactive until @value{GDBN} reaches another
4146 kind of breakpoint or the call completes.
4148 @value{GDBN} automatically deletes watchpoints that watch local
4149 (automatic) variables, or expressions that involve such variables, when
4150 they go out of scope, that is, when the execution leaves the block in
4151 which these variables were defined. In particular, when the program
4152 being debugged terminates, @emph{all} local variables go out of scope,
4153 and so only watchpoints that watch global variables remain set. If you
4154 rerun the program, you will need to set all such watchpoints again. One
4155 way of doing that would be to set a code breakpoint at the entry to the
4156 @code{main} function and when it breaks, set all the watchpoints.
4158 @cindex watchpoints and threads
4159 @cindex threads and watchpoints
4160 In multi-threaded programs, watchpoints will detect changes to the
4161 watched expression from every thread.
4164 @emph{Warning:} In multi-threaded programs, software watchpoints
4165 have only limited usefulness. If @value{GDBN} creates a software
4166 watchpoint, it can only watch the value of an expression @emph{in a
4167 single thread}. If you are confident that the expression can only
4168 change due to the current thread's activity (and if you are also
4169 confident that no other thread can become current), then you can use
4170 software watchpoints as usual. However, @value{GDBN} may not notice
4171 when a non-current thread's activity changes the expression. (Hardware
4172 watchpoints, in contrast, watch an expression in all threads.)
4175 @xref{set remote hardware-watchpoint-limit}.
4177 @node Set Catchpoints
4178 @subsection Setting Catchpoints
4179 @cindex catchpoints, setting
4180 @cindex exception handlers
4181 @cindex event handling
4183 You can use @dfn{catchpoints} to cause the debugger to stop for certain
4184 kinds of program events, such as C@t{++} exceptions or the loading of a
4185 shared library. Use the @code{catch} command to set a catchpoint.
4189 @item catch @var{event}
4190 Stop when @var{event} occurs. The @var{event} can be any of the following:
4193 @item throw @r{[}@var{regexp}@r{]}
4194 @itemx rethrow @r{[}@var{regexp}@r{]}
4195 @itemx catch @r{[}@var{regexp}@r{]}
4197 @kindex catch rethrow
4199 @cindex stop on C@t{++} exceptions
4200 The throwing, re-throwing, or catching of a C@t{++} exception.
4202 If @var{regexp} is given, then only exceptions whose type matches the
4203 regular expression will be caught.
4205 @vindex $_exception@r{, convenience variable}
4206 The convenience variable @code{$_exception} is available at an
4207 exception-related catchpoint, on some systems. This holds the
4208 exception being thrown.
4210 There are currently some limitations to C@t{++} exception handling in
4215 The support for these commands is system-dependent. Currently, only
4216 systems using the @samp{gnu-v3} C@t{++} ABI (@pxref{ABI}) are
4220 The regular expression feature and the @code{$_exception} convenience
4221 variable rely on the presence of some SDT probes in @code{libstdc++}.
4222 If these probes are not present, then these features cannot be used.
4223 These probes were first available in the GCC 4.8 release, but whether
4224 or not they are available in your GCC also depends on how it was
4228 The @code{$_exception} convenience variable is only valid at the
4229 instruction at which an exception-related catchpoint is set.
4232 When an exception-related catchpoint is hit, @value{GDBN} stops at a
4233 location in the system library which implements runtime exception
4234 support for C@t{++}, usually @code{libstdc++}. You can use @code{up}
4235 (@pxref{Selection}) to get to your code.
4238 If you call a function interactively, @value{GDBN} normally returns
4239 control to you when the function has finished executing. If the call
4240 raises an exception, however, the call may bypass the mechanism that
4241 returns control to you and cause your program either to abort or to
4242 simply continue running until it hits a breakpoint, catches a signal
4243 that @value{GDBN} is listening for, or exits. This is the case even if
4244 you set a catchpoint for the exception; catchpoints on exceptions are
4245 disabled within interactive calls. @xref{Calling}, for information on
4246 controlling this with @code{set unwind-on-terminating-exception}.
4249 You cannot raise an exception interactively.
4252 You cannot install an exception handler interactively.
4256 @kindex catch exception
4257 @cindex Ada exception catching
4258 @cindex catch Ada exceptions
4259 An Ada exception being raised. If an exception name is specified
4260 at the end of the command (eg @code{catch exception Program_Error}),
4261 the debugger will stop only when this specific exception is raised.
4262 Otherwise, the debugger stops execution when any Ada exception is raised.
4264 When inserting an exception catchpoint on a user-defined exception whose
4265 name is identical to one of the exceptions defined by the language, the
4266 fully qualified name must be used as the exception name. Otherwise,
4267 @value{GDBN} will assume that it should stop on the pre-defined exception
4268 rather than the user-defined one. For instance, assuming an exception
4269 called @code{Constraint_Error} is defined in package @code{Pck}, then
4270 the command to use to catch such exceptions is @kbd{catch exception
4271 Pck.Constraint_Error}.
4273 @item exception unhandled
4274 @kindex catch exception unhandled
4275 An exception that was raised but is not handled by the program.
4278 @kindex catch assert
4279 A failed Ada assertion.
4283 @cindex break on fork/exec
4284 A call to @code{exec}. This is currently only available for HP-UX
4288 @itemx syscall @r{[}@var{name} @r{|} @var{number}@r{]} @dots{}
4289 @kindex catch syscall
4290 @cindex break on a system call.
4291 A call to or return from a system call, a.k.a.@: @dfn{syscall}. A
4292 syscall is a mechanism for application programs to request a service
4293 from the operating system (OS) or one of the OS system services.
4294 @value{GDBN} can catch some or all of the syscalls issued by the
4295 debuggee, and show the related information for each syscall. If no
4296 argument is specified, calls to and returns from all system calls
4299 @var{name} can be any system call name that is valid for the
4300 underlying OS. Just what syscalls are valid depends on the OS. On
4301 GNU and Unix systems, you can find the full list of valid syscall
4302 names on @file{/usr/include/asm/unistd.h}.
4304 @c For MS-Windows, the syscall names and the corresponding numbers
4305 @c can be found, e.g., on this URL:
4306 @c http://www.metasploit.com/users/opcode/syscalls.html
4307 @c but we don't support Windows syscalls yet.
4309 Normally, @value{GDBN} knows in advance which syscalls are valid for
4310 each OS, so you can use the @value{GDBN} command-line completion
4311 facilities (@pxref{Completion,, command completion}) to list the
4314 You may also specify the system call numerically. A syscall's
4315 number is the value passed to the OS's syscall dispatcher to
4316 identify the requested service. When you specify the syscall by its
4317 name, @value{GDBN} uses its database of syscalls to convert the name
4318 into the corresponding numeric code, but using the number directly
4319 may be useful if @value{GDBN}'s database does not have the complete
4320 list of syscalls on your system (e.g., because @value{GDBN} lags
4321 behind the OS upgrades).
4323 The example below illustrates how this command works if you don't provide
4327 (@value{GDBP}) catch syscall
4328 Catchpoint 1 (syscall)
4330 Starting program: /tmp/catch-syscall
4332 Catchpoint 1 (call to syscall 'close'), \
4333 0xffffe424 in __kernel_vsyscall ()
4337 Catchpoint 1 (returned from syscall 'close'), \
4338 0xffffe424 in __kernel_vsyscall ()
4342 Here is an example of catching a system call by name:
4345 (@value{GDBP}) catch syscall chroot
4346 Catchpoint 1 (syscall 'chroot' [61])
4348 Starting program: /tmp/catch-syscall
4350 Catchpoint 1 (call to syscall 'chroot'), \
4351 0xffffe424 in __kernel_vsyscall ()
4355 Catchpoint 1 (returned from syscall 'chroot'), \
4356 0xffffe424 in __kernel_vsyscall ()
4360 An example of specifying a system call numerically. In the case
4361 below, the syscall number has a corresponding entry in the XML
4362 file, so @value{GDBN} finds its name and prints it:
4365 (@value{GDBP}) catch syscall 252
4366 Catchpoint 1 (syscall(s) 'exit_group')
4368 Starting program: /tmp/catch-syscall
4370 Catchpoint 1 (call to syscall 'exit_group'), \
4371 0xffffe424 in __kernel_vsyscall ()
4375 Program exited normally.
4379 However, there can be situations when there is no corresponding name
4380 in XML file for that syscall number. In this case, @value{GDBN} prints
4381 a warning message saying that it was not able to find the syscall name,
4382 but the catchpoint will be set anyway. See the example below:
4385 (@value{GDBP}) catch syscall 764
4386 warning: The number '764' does not represent a known syscall.
4387 Catchpoint 2 (syscall 764)
4391 If you configure @value{GDBN} using the @samp{--without-expat} option,
4392 it will not be able to display syscall names. Also, if your
4393 architecture does not have an XML file describing its system calls,
4394 you will not be able to see the syscall names. It is important to
4395 notice that these two features are used for accessing the syscall
4396 name database. In either case, you will see a warning like this:
4399 (@value{GDBP}) catch syscall
4400 warning: Could not open "syscalls/i386-linux.xml"
4401 warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'.
4402 GDB will not be able to display syscall names.
4403 Catchpoint 1 (syscall)
4407 Of course, the file name will change depending on your architecture and system.
4409 Still using the example above, you can also try to catch a syscall by its
4410 number. In this case, you would see something like:
4413 (@value{GDBP}) catch syscall 252
4414 Catchpoint 1 (syscall(s) 252)
4417 Again, in this case @value{GDBN} would not be able to display syscall's names.
4421 A call to @code{fork}. This is currently only available for HP-UX
4426 A call to @code{vfork}. This is currently only available for HP-UX
4429 @item load @r{[}regexp@r{]}
4430 @itemx unload @r{[}regexp@r{]}
4432 @kindex catch unload
4433 The loading or unloading of a shared library. If @var{regexp} is
4434 given, then the catchpoint will stop only if the regular expression
4435 matches one of the affected libraries.
4437 @item signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
4438 @kindex catch signal
4439 The delivery of a signal.
4441 With no arguments, this catchpoint will catch any signal that is not
4442 used internally by @value{GDBN}, specifically, all signals except
4443 @samp{SIGTRAP} and @samp{SIGINT}.
4445 With the argument @samp{all}, all signals, including those used by
4446 @value{GDBN}, will be caught. This argument cannot be used with other
4449 Otherwise, the arguments are a list of signal names as given to
4450 @code{handle} (@pxref{Signals}). Only signals specified in this list
4453 One reason that @code{catch signal} can be more useful than
4454 @code{handle} is that you can attach commands and conditions to the
4457 When a signal is caught by a catchpoint, the signal's @code{stop} and
4458 @code{print} settings, as specified by @code{handle}, are ignored.
4459 However, whether the signal is still delivered to the inferior depends
4460 on the @code{pass} setting; this can be changed in the catchpoint's
4465 @item tcatch @var{event}
4467 Set a catchpoint that is enabled only for one stop. The catchpoint is
4468 automatically deleted after the first time the event is caught.
4472 Use the @code{info break} command to list the current catchpoints.
4476 @subsection Deleting Breakpoints
4478 @cindex clearing breakpoints, watchpoints, catchpoints
4479 @cindex deleting breakpoints, watchpoints, catchpoints
4480 It is often necessary to eliminate a breakpoint, watchpoint, or
4481 catchpoint once it has done its job and you no longer want your program
4482 to stop there. This is called @dfn{deleting} the breakpoint. A
4483 breakpoint that has been deleted no longer exists; it is forgotten.
4485 With the @code{clear} command you can delete breakpoints according to
4486 where they are in your program. With the @code{delete} command you can
4487 delete individual breakpoints, watchpoints, or catchpoints by specifying
4488 their breakpoint numbers.
4490 It is not necessary to delete a breakpoint to proceed past it. @value{GDBN}
4491 automatically ignores breakpoints on the first instruction to be executed
4492 when you continue execution without changing the execution address.
4497 Delete any breakpoints at the next instruction to be executed in the
4498 selected stack frame (@pxref{Selection, ,Selecting a Frame}). When
4499 the innermost frame is selected, this is a good way to delete a
4500 breakpoint where your program just stopped.
4502 @item clear @var{location}
4503 Delete any breakpoints set at the specified @var{location}.
4504 @xref{Specify Location}, for the various forms of @var{location}; the
4505 most useful ones are listed below:
4508 @item clear @var{function}
4509 @itemx clear @var{filename}:@var{function}
4510 Delete any breakpoints set at entry to the named @var{function}.
4512 @item clear @var{linenum}
4513 @itemx clear @var{filename}:@var{linenum}
4514 Delete any breakpoints set at or within the code of the specified
4515 @var{linenum} of the specified @var{filename}.
4518 @cindex delete breakpoints
4520 @kindex d @r{(@code{delete})}
4521 @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4522 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
4523 ranges specified as arguments. If no argument is specified, delete all
4524 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
4525 confirm off}). You can abbreviate this command as @code{d}.
4529 @subsection Disabling Breakpoints
4531 @cindex enable/disable a breakpoint
4532 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
4533 prefer to @dfn{disable} it. This makes the breakpoint inoperative as if
4534 it had been deleted, but remembers the information on the breakpoint so
4535 that you can @dfn{enable} it again later.
4537 You disable and enable breakpoints, watchpoints, and catchpoints with
4538 the @code{enable} and @code{disable} commands, optionally specifying
4539 one or more breakpoint numbers as arguments. Use @code{info break} to
4540 print a list of all breakpoints, watchpoints, and catchpoints if you
4541 do not know which numbers to use.
4543 Disabling and enabling a breakpoint that has multiple locations
4544 affects all of its locations.
4546 A breakpoint, watchpoint, or catchpoint can have any of several
4547 different states of enablement:
4551 Enabled. The breakpoint stops your program. A breakpoint set
4552 with the @code{break} command starts out in this state.
4554 Disabled. The breakpoint has no effect on your program.
4556 Enabled once. The breakpoint stops your program, but then becomes
4559 Enabled for a count. The breakpoint stops your program for the next
4560 N times, then becomes disabled.
4562 Enabled for deletion. The breakpoint stops your program, but
4563 immediately after it does so it is deleted permanently. A breakpoint
4564 set with the @code{tbreak} command starts out in this state.
4567 You can use the following commands to enable or disable breakpoints,
4568 watchpoints, and catchpoints:
4572 @kindex dis @r{(@code{disable})}
4573 @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4574 Disable the specified breakpoints---or all breakpoints, if none are
4575 listed. A disabled breakpoint has no effect but is not forgotten. All
4576 options such as ignore-counts, conditions and commands are remembered in
4577 case the breakpoint is enabled again later. You may abbreviate
4578 @code{disable} as @code{dis}.
4581 @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4582 Enable the specified breakpoints (or all defined breakpoints). They
4583 become effective once again in stopping your program.
4585 @item enable @r{[}breakpoints@r{]} once @var{range}@dots{}
4586 Enable the specified breakpoints temporarily. @value{GDBN} disables any
4587 of these breakpoints immediately after stopping your program.
4589 @item enable @r{[}breakpoints@r{]} count @var{count} @var{range}@dots{}
4590 Enable the specified breakpoints temporarily. @value{GDBN} records
4591 @var{count} with each of the specified breakpoints, and decrements a
4592 breakpoint's count when it is hit. When any count reaches 0,
4593 @value{GDBN} disables that breakpoint. If a breakpoint has an ignore
4594 count (@pxref{Conditions, ,Break Conditions}), that will be
4595 decremented to 0 before @var{count} is affected.
4597 @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{}
4598 Enable the specified breakpoints to work once, then die. @value{GDBN}
4599 deletes any of these breakpoints as soon as your program stops there.
4600 Breakpoints set by the @code{tbreak} command start out in this state.
4603 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
4604 @c confusing: tbreak is also initially enabled.
4605 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
4606 ,Setting Breakpoints}), breakpoints that you set are initially enabled;
4607 subsequently, they become disabled or enabled only when you use one of
4608 the commands above. (The command @code{until} can set and delete a
4609 breakpoint of its own, but it does not change the state of your other
4610 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
4614 @subsection Break Conditions
4615 @cindex conditional breakpoints
4616 @cindex breakpoint conditions
4618 @c FIXME what is scope of break condition expr? Context where wanted?
4619 @c in particular for a watchpoint?
4620 The simplest sort of breakpoint breaks every time your program reaches a
4621 specified place. You can also specify a @dfn{condition} for a
4622 breakpoint. A condition is just a Boolean expression in your
4623 programming language (@pxref{Expressions, ,Expressions}). A breakpoint with
4624 a condition evaluates the expression each time your program reaches it,
4625 and your program stops only if the condition is @emph{true}.
4627 This is the converse of using assertions for program validation; in that
4628 situation, you want to stop when the assertion is violated---that is,
4629 when the condition is false. In C, if you want to test an assertion expressed
4630 by the condition @var{assert}, you should set the condition
4631 @samp{! @var{assert}} on the appropriate breakpoint.
4633 Conditions are also accepted for watchpoints; you may not need them,
4634 since a watchpoint is inspecting the value of an expression anyhow---but
4635 it might be simpler, say, to just set a watchpoint on a variable name,
4636 and specify a condition that tests whether the new value is an interesting
4639 Break conditions can have side effects, and may even call functions in
4640 your program. This can be useful, for example, to activate functions
4641 that log program progress, or to use your own print functions to
4642 format special data structures. The effects are completely predictable
4643 unless there is another enabled breakpoint at the same address. (In
4644 that case, @value{GDBN} might see the other breakpoint first and stop your
4645 program without checking the condition of this one.) Note that
4646 breakpoint commands are usually more convenient and flexible than break
4648 purpose of performing side effects when a breakpoint is reached
4649 (@pxref{Break Commands, ,Breakpoint Command Lists}).
4651 Breakpoint conditions can also be evaluated on the target's side if
4652 the target supports it. Instead of evaluating the conditions locally,
4653 @value{GDBN} encodes the expression into an agent expression
4654 (@pxref{Agent Expressions}) suitable for execution on the target,
4655 independently of @value{GDBN}. Global variables become raw memory
4656 locations, locals become stack accesses, and so forth.
4658 In this case, @value{GDBN} will only be notified of a breakpoint trigger
4659 when its condition evaluates to true. This mechanism may provide faster
4660 response times depending on the performance characteristics of the target
4661 since it does not need to keep @value{GDBN} informed about
4662 every breakpoint trigger, even those with false conditions.
4664 Break conditions can be specified when a breakpoint is set, by using
4665 @samp{if} in the arguments to the @code{break} command. @xref{Set
4666 Breaks, ,Setting Breakpoints}. They can also be changed at any time
4667 with the @code{condition} command.
4669 You can also use the @code{if} keyword with the @code{watch} command.
4670 The @code{catch} command does not recognize the @code{if} keyword;
4671 @code{condition} is the only way to impose a further condition on a
4676 @item condition @var{bnum} @var{expression}
4677 Specify @var{expression} as the break condition for breakpoint,
4678 watchpoint, or catchpoint number @var{bnum}. After you set a condition,
4679 breakpoint @var{bnum} stops your program only if the value of
4680 @var{expression} is true (nonzero, in C). When you use
4681 @code{condition}, @value{GDBN} checks @var{expression} immediately for
4682 syntactic correctness, and to determine whether symbols in it have
4683 referents in the context of your breakpoint. If @var{expression} uses
4684 symbols not referenced in the context of the breakpoint, @value{GDBN}
4685 prints an error message:
4688 No symbol "foo" in current context.
4693 not actually evaluate @var{expression} at the time the @code{condition}
4694 command (or a command that sets a breakpoint with a condition, like
4695 @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}.
4697 @item condition @var{bnum}
4698 Remove the condition from breakpoint number @var{bnum}. It becomes
4699 an ordinary unconditional breakpoint.
4702 @cindex ignore count (of breakpoint)
4703 A special case of a breakpoint condition is to stop only when the
4704 breakpoint has been reached a certain number of times. This is so
4705 useful that there is a special way to do it, using the @dfn{ignore
4706 count} of the breakpoint. Every breakpoint has an ignore count, which
4707 is an integer. Most of the time, the ignore count is zero, and
4708 therefore has no effect. But if your program reaches a breakpoint whose
4709 ignore count is positive, then instead of stopping, it just decrements
4710 the ignore count by one and continues. As a result, if the ignore count
4711 value is @var{n}, the breakpoint does not stop the next @var{n} times
4712 your program reaches it.
4716 @item ignore @var{bnum} @var{count}
4717 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
4718 The next @var{count} times the breakpoint is reached, your program's
4719 execution does not stop; other than to decrement the ignore count, @value{GDBN}
4722 To make the breakpoint stop the next time it is reached, specify
4725 When you use @code{continue} to resume execution of your program from a
4726 breakpoint, you can specify an ignore count directly as an argument to
4727 @code{continue}, rather than using @code{ignore}. @xref{Continuing and
4728 Stepping,,Continuing and Stepping}.
4730 If a breakpoint has a positive ignore count and a condition, the
4731 condition is not checked. Once the ignore count reaches zero,
4732 @value{GDBN} resumes checking the condition.
4734 You could achieve the effect of the ignore count with a condition such
4735 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
4736 is decremented each time. @xref{Convenience Vars, ,Convenience
4740 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
4743 @node Break Commands
4744 @subsection Breakpoint Command Lists
4746 @cindex breakpoint commands
4747 You can give any breakpoint (or watchpoint or catchpoint) a series of
4748 commands to execute when your program stops due to that breakpoint. For
4749 example, you might want to print the values of certain expressions, or
4750 enable other breakpoints.
4754 @kindex end@r{ (breakpoint commands)}
4755 @item commands @r{[}@var{range}@dots{}@r{]}
4756 @itemx @dots{} @var{command-list} @dots{}
4758 Specify a list of commands for the given breakpoints. The commands
4759 themselves appear on the following lines. Type a line containing just
4760 @code{end} to terminate the commands.
4762 To remove all commands from a breakpoint, type @code{commands} and
4763 follow it immediately with @code{end}; that is, give no commands.
4765 With no argument, @code{commands} refers to the last breakpoint,
4766 watchpoint, or catchpoint set (not to the breakpoint most recently
4767 encountered). If the most recent breakpoints were set with a single
4768 command, then the @code{commands} will apply to all the breakpoints
4769 set by that command. This applies to breakpoints set by
4770 @code{rbreak}, and also applies when a single @code{break} command
4771 creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous
4775 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
4776 disabled within a @var{command-list}.
4778 You can use breakpoint commands to start your program up again. Simply
4779 use the @code{continue} command, or @code{step}, or any other command
4780 that resumes execution.
4782 Any other commands in the command list, after a command that resumes
4783 execution, are ignored. This is because any time you resume execution
4784 (even with a simple @code{next} or @code{step}), you may encounter
4785 another breakpoint---which could have its own command list, leading to
4786 ambiguities about which list to execute.
4789 If the first command you specify in a command list is @code{silent}, the
4790 usual message about stopping at a breakpoint is not printed. This may
4791 be desirable for breakpoints that are to print a specific message and
4792 then continue. If none of the remaining commands print anything, you
4793 see no sign that the breakpoint was reached. @code{silent} is
4794 meaningful only at the beginning of a breakpoint command list.
4796 The commands @code{echo}, @code{output}, and @code{printf} allow you to
4797 print precisely controlled output, and are often useful in silent
4798 breakpoints. @xref{Output, ,Commands for Controlled Output}.
4800 For example, here is how you could use breakpoint commands to print the
4801 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
4807 printf "x is %d\n",x
4812 One application for breakpoint commands is to compensate for one bug so
4813 you can test for another. Put a breakpoint just after the erroneous line
4814 of code, give it a condition to detect the case in which something
4815 erroneous has been done, and give it commands to assign correct values
4816 to any variables that need them. End with the @code{continue} command
4817 so that your program does not stop, and start with the @code{silent}
4818 command so that no output is produced. Here is an example:
4829 @node Dynamic Printf
4830 @subsection Dynamic Printf
4832 @cindex dynamic printf
4834 The dynamic printf command @code{dprintf} combines a breakpoint with
4835 formatted printing of your program's data to give you the effect of
4836 inserting @code{printf} calls into your program on-the-fly, without
4837 having to recompile it.
4839 In its most basic form, the output goes to the GDB console. However,
4840 you can set the variable @code{dprintf-style} for alternate handling.
4841 For instance, you can ask to format the output by calling your
4842 program's @code{printf} function. This has the advantage that the
4843 characters go to the program's output device, so they can recorded in
4844 redirects to files and so forth.
4846 If you are doing remote debugging with a stub or agent, you can also
4847 ask to have the printf handled by the remote agent. In addition to
4848 ensuring that the output goes to the remote program's device along
4849 with any other output the program might produce, you can also ask that
4850 the dprintf remain active even after disconnecting from the remote
4851 target. Using the stub/agent is also more efficient, as it can do
4852 everything without needing to communicate with @value{GDBN}.
4856 @item dprintf @var{location},@var{template},@var{expression}[,@var{expression}@dots{}]
4857 Whenever execution reaches @var{location}, print the values of one or
4858 more @var{expressions} under the control of the string @var{template}.
4859 To print several values, separate them with commas.
4861 @item set dprintf-style @var{style}
4862 Set the dprintf output to be handled in one of several different
4863 styles enumerated below. A change of style affects all existing
4864 dynamic printfs immediately. (If you need individual control over the
4865 print commands, simply define normal breakpoints with
4866 explicitly-supplied command lists.)
4869 @kindex dprintf-style gdb
4870 Handle the output using the @value{GDBN} @code{printf} command.
4873 @kindex dprintf-style call
4874 Handle the output by calling a function in your program (normally
4878 @kindex dprintf-style agent
4879 Have the remote debugging agent (such as @code{gdbserver}) handle
4880 the output itself. This style is only available for agents that
4881 support running commands on the target.
4883 @item set dprintf-function @var{function}
4884 Set the function to call if the dprintf style is @code{call}. By
4885 default its value is @code{printf}. You may set it to any expression.
4886 that @value{GDBN} can evaluate to a function, as per the @code{call}
4889 @item set dprintf-channel @var{channel}
4890 Set a ``channel'' for dprintf. If set to a non-empty value,
4891 @value{GDBN} will evaluate it as an expression and pass the result as
4892 a first argument to the @code{dprintf-function}, in the manner of
4893 @code{fprintf} and similar functions. Otherwise, the dprintf format
4894 string will be the first argument, in the manner of @code{printf}.
4896 As an example, if you wanted @code{dprintf} output to go to a logfile
4897 that is a standard I/O stream assigned to the variable @code{mylog},
4898 you could do the following:
4901 (gdb) set dprintf-style call
4902 (gdb) set dprintf-function fprintf
4903 (gdb) set dprintf-channel mylog
4904 (gdb) dprintf 25,"at line 25, glob=%d\n",glob
4905 Dprintf 1 at 0x123456: file main.c, line 25.
4907 1 dprintf keep y 0x00123456 in main at main.c:25
4908 call (void) fprintf (mylog,"at line 25, glob=%d\n",glob)
4913 Note that the @code{info break} displays the dynamic printf commands
4914 as normal breakpoint commands; you can thus easily see the effect of
4915 the variable settings.
4917 @item set disconnected-dprintf on
4918 @itemx set disconnected-dprintf off
4919 @kindex set disconnected-dprintf
4920 Choose whether @code{dprintf} commands should continue to run if
4921 @value{GDBN} has disconnected from the target. This only applies
4922 if the @code{dprintf-style} is @code{agent}.
4924 @item show disconnected-dprintf off
4925 @kindex show disconnected-dprintf
4926 Show the current choice for disconnected @code{dprintf}.
4930 @value{GDBN} does not check the validity of function and channel,
4931 relying on you to supply values that are meaningful for the contexts
4932 in which they are being used. For instance, the function and channel
4933 may be the values of local variables, but if that is the case, then
4934 all enabled dynamic prints must be at locations within the scope of
4935 those locals. If evaluation fails, @value{GDBN} will report an error.
4937 @node Save Breakpoints
4938 @subsection How to save breakpoints to a file
4940 To save breakpoint definitions to a file use the @w{@code{save
4941 breakpoints}} command.
4944 @kindex save breakpoints
4945 @cindex save breakpoints to a file for future sessions
4946 @item save breakpoints [@var{filename}]
4947 This command saves all current breakpoint definitions together with
4948 their commands and ignore counts, into a file @file{@var{filename}}
4949 suitable for use in a later debugging session. This includes all
4950 types of breakpoints (breakpoints, watchpoints, catchpoints,
4951 tracepoints). To read the saved breakpoint definitions, use the
4952 @code{source} command (@pxref{Command Files}). Note that watchpoints
4953 with expressions involving local variables may fail to be recreated
4954 because it may not be possible to access the context where the
4955 watchpoint is valid anymore. Because the saved breakpoint definitions
4956 are simply a sequence of @value{GDBN} commands that recreate the
4957 breakpoints, you can edit the file in your favorite editing program,
4958 and remove the breakpoint definitions you're not interested in, or
4959 that can no longer be recreated.
4962 @node Static Probe Points
4963 @subsection Static Probe Points
4965 @cindex static probe point, SystemTap
4966 @cindex static probe point, DTrace
4967 @value{GDBN} supports @dfn{SDT} probes in the code. @acronym{SDT} stands
4968 for Statically Defined Tracing, and the probes are designed to have a tiny
4969 runtime code and data footprint, and no dynamic relocations.
4971 Currently, the following types of probes are supported on
4972 ELF-compatible systems:
4976 @item @code{SystemTap} (@uref{http://sourceware.org/systemtap/})
4977 @acronym{SDT} probes@footnote{See
4978 @uref{http://sourceware.org/systemtap/wiki/AddingUserSpaceProbingToApps}
4979 for more information on how to add @code{SystemTap} @acronym{SDT}
4980 probes in your applications.}. @code{SystemTap} probes are usable
4981 from assembly, C and C@t{++} languages@footnote{See
4982 @uref{http://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation}
4983 for a good reference on how the @acronym{SDT} probes are implemented.}.
4985 @item @code{DTrace} (@uref{http://oss.oracle.com/projects/DTrace})
4986 @acronym{USDT} probes. @code{DTrace} probes are usable from C and
4990 @cindex semaphores on static probe points
4991 Some @code{SystemTap} probes have an associated semaphore variable;
4992 for instance, this happens automatically if you defined your probe
4993 using a DTrace-style @file{.d} file. If your probe has a semaphore,
4994 @value{GDBN} will automatically enable it when you specify a
4995 breakpoint using the @samp{-probe-stap} notation. But, if you put a
4996 breakpoint at a probe's location by some other method (e.g.,
4997 @code{break file:line}), then @value{GDBN} will not automatically set
4998 the semaphore. @code{DTrace} probes do not support semaphores.
5000 You can examine the available static static probes using @code{info
5001 probes}, with optional arguments:
5005 @item info probes @r{[}@var{type}@r{]} @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5006 If given, @var{type} is either @code{stap} for listing
5007 @code{SystemTap} probes or @code{dtrace} for listing @code{DTrace}
5008 probes. If omitted all probes are listed regardless of their types.
5010 If given, @var{provider} is a regular expression used to match against provider
5011 names when selecting which probes to list. If omitted, probes by all
5012 probes from all providers are listed.
5014 If given, @var{name} is a regular expression to match against probe names
5015 when selecting which probes to list. If omitted, probe names are not
5016 considered when deciding whether to display them.
5018 If given, @var{objfile} is a regular expression used to select which
5019 object files (executable or shared libraries) to examine. If not
5020 given, all object files are considered.
5022 @item info probes all
5023 List the available static probes, from all types.
5026 @cindex enabling and disabling probes
5027 Some probe points can be enabled and/or disabled. The effect of
5028 enabling or disabling a probe depends on the type of probe being
5029 handled. Some @code{DTrace} probes can be enabled or
5030 disabled, but @code{SystemTap} probes cannot be disabled.
5032 You can enable (or disable) one or more probes using the following
5033 commands, with optional arguments:
5036 @kindex enable probes
5037 @item enable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5038 If given, @var{provider} is a regular expression used to match against
5039 provider names when selecting which probes to enable. If omitted,
5040 all probes from all providers are enabled.
5042 If given, @var{name} is a regular expression to match against probe
5043 names when selecting which probes to enable. If omitted, probe names
5044 are not considered when deciding whether to enable them.
5046 If given, @var{objfile} is a regular expression used to select which
5047 object files (executable or shared libraries) to examine. If not
5048 given, all object files are considered.
5050 @kindex disable probes
5051 @item disable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5052 See the @code{enable probes} command above for a description of the
5053 optional arguments accepted by this command.
5056 @vindex $_probe_arg@r{, convenience variable}
5057 A probe may specify up to twelve arguments. These are available at the
5058 point at which the probe is defined---that is, when the current PC is
5059 at the probe's location. The arguments are available using the
5060 convenience variables (@pxref{Convenience Vars})
5061 @code{$_probe_arg0}@dots{}@code{$_probe_arg11}. In @code{SystemTap}
5062 probes each probe argument is an integer of the appropriate size;
5063 types are not preserved. In @code{DTrace} probes types are preserved
5064 provided that they are recognized as such by @value{GDBN}; otherwise
5065 the value of the probe argument will be a long integer. The
5066 convenience variable @code{$_probe_argc} holds the number of arguments
5067 at the current probe point.
5069 These variables are always available, but attempts to access them at
5070 any location other than a probe point will cause @value{GDBN} to give
5074 @c @ifclear BARETARGET
5075 @node Error in Breakpoints
5076 @subsection ``Cannot insert breakpoints''
5078 If you request too many active hardware-assisted breakpoints and
5079 watchpoints, you will see this error message:
5081 @c FIXME: the precise wording of this message may change; the relevant
5082 @c source change is not committed yet (Sep 3, 1999).
5084 Stopped; cannot insert breakpoints.
5085 You may have requested too many hardware breakpoints and watchpoints.
5089 This message is printed when you attempt to resume the program, since
5090 only then @value{GDBN} knows exactly how many hardware breakpoints and
5091 watchpoints it needs to insert.
5093 When this message is printed, you need to disable or remove some of the
5094 hardware-assisted breakpoints and watchpoints, and then continue.
5096 @node Breakpoint-related Warnings
5097 @subsection ``Breakpoint address adjusted...''
5098 @cindex breakpoint address adjusted
5100 Some processor architectures place constraints on the addresses at
5101 which breakpoints may be placed. For architectures thus constrained,
5102 @value{GDBN} will attempt to adjust the breakpoint's address to comply
5103 with the constraints dictated by the architecture.
5105 One example of such an architecture is the Fujitsu FR-V. The FR-V is
5106 a VLIW architecture in which a number of RISC-like instructions may be
5107 bundled together for parallel execution. The FR-V architecture
5108 constrains the location of a breakpoint instruction within such a
5109 bundle to the instruction with the lowest address. @value{GDBN}
5110 honors this constraint by adjusting a breakpoint's address to the
5111 first in the bundle.
5113 It is not uncommon for optimized code to have bundles which contain
5114 instructions from different source statements, thus it may happen that
5115 a breakpoint's address will be adjusted from one source statement to
5116 another. Since this adjustment may significantly alter @value{GDBN}'s
5117 breakpoint related behavior from what the user expects, a warning is
5118 printed when the breakpoint is first set and also when the breakpoint
5121 A warning like the one below is printed when setting a breakpoint
5122 that's been subject to address adjustment:
5125 warning: Breakpoint address adjusted from 0x00010414 to 0x00010410.
5128 Such warnings are printed both for user settable and @value{GDBN}'s
5129 internal breakpoints. If you see one of these warnings, you should
5130 verify that a breakpoint set at the adjusted address will have the
5131 desired affect. If not, the breakpoint in question may be removed and
5132 other breakpoints may be set which will have the desired behavior.
5133 E.g., it may be sufficient to place the breakpoint at a later
5134 instruction. A conditional breakpoint may also be useful in some
5135 cases to prevent the breakpoint from triggering too often.
5137 @value{GDBN} will also issue a warning when stopping at one of these
5138 adjusted breakpoints:
5141 warning: Breakpoint 1 address previously adjusted from 0x00010414
5145 When this warning is encountered, it may be too late to take remedial
5146 action except in cases where the breakpoint is hit earlier or more
5147 frequently than expected.
5149 @node Continuing and Stepping
5150 @section Continuing and Stepping
5154 @cindex resuming execution
5155 @dfn{Continuing} means resuming program execution until your program
5156 completes normally. In contrast, @dfn{stepping} means executing just
5157 one more ``step'' of your program, where ``step'' may mean either one
5158 line of source code, or one machine instruction (depending on what
5159 particular command you use). Either when continuing or when stepping,
5160 your program may stop even sooner, due to a breakpoint or a signal. (If
5161 it stops due to a signal, you may want to use @code{handle}, or use
5162 @samp{signal 0} to resume execution (@pxref{Signals, ,Signals}),
5163 or you may step into the signal's handler (@pxref{stepping and signal
5168 @kindex c @r{(@code{continue})}
5169 @kindex fg @r{(resume foreground execution)}
5170 @item continue @r{[}@var{ignore-count}@r{]}
5171 @itemx c @r{[}@var{ignore-count}@r{]}
5172 @itemx fg @r{[}@var{ignore-count}@r{]}
5173 Resume program execution, at the address where your program last stopped;
5174 any breakpoints set at that address are bypassed. The optional argument
5175 @var{ignore-count} allows you to specify a further number of times to
5176 ignore a breakpoint at this location; its effect is like that of
5177 @code{ignore} (@pxref{Conditions, ,Break Conditions}).
5179 The argument @var{ignore-count} is meaningful only when your program
5180 stopped due to a breakpoint. At other times, the argument to
5181 @code{continue} is ignored.
5183 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
5184 debugged program is deemed to be the foreground program) are provided
5185 purely for convenience, and have exactly the same behavior as
5189 To resume execution at a different place, you can use @code{return}
5190 (@pxref{Returning, ,Returning from a Function}) to go back to the
5191 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
5192 Different Address}) to go to an arbitrary location in your program.
5194 A typical technique for using stepping is to set a breakpoint
5195 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the
5196 beginning of the function or the section of your program where a problem
5197 is believed to lie, run your program until it stops at that breakpoint,
5198 and then step through the suspect area, examining the variables that are
5199 interesting, until you see the problem happen.
5203 @kindex s @r{(@code{step})}
5205 Continue running your program until control reaches a different source
5206 line, then stop it and return control to @value{GDBN}. This command is
5207 abbreviated @code{s}.
5210 @c "without debugging information" is imprecise; actually "without line
5211 @c numbers in the debugging information". (gcc -g1 has debugging info but
5212 @c not line numbers). But it seems complex to try to make that
5213 @c distinction here.
5214 @emph{Warning:} If you use the @code{step} command while control is
5215 within a function that was compiled without debugging information,
5216 execution proceeds until control reaches a function that does have
5217 debugging information. Likewise, it will not step into a function which
5218 is compiled without debugging information. To step through functions
5219 without debugging information, use the @code{stepi} command, described
5223 The @code{step} command only stops at the first instruction of a source
5224 line. This prevents the multiple stops that could otherwise occur in
5225 @code{switch} statements, @code{for} loops, etc. @code{step} continues
5226 to stop if a function that has debugging information is called within
5227 the line. In other words, @code{step} @emph{steps inside} any functions
5228 called within the line.
5230 Also, the @code{step} command only enters a function if there is line
5231 number information for the function. Otherwise it acts like the
5232 @code{next} command. This avoids problems when using @code{cc -gl}
5233 on @acronym{MIPS} machines. Previously, @code{step} entered subroutines if there
5234 was any debugging information about the routine.
5236 @item step @var{count}
5237 Continue running as in @code{step}, but do so @var{count} times. If a
5238 breakpoint is reached, or a signal not related to stepping occurs before
5239 @var{count} steps, stepping stops right away.
5242 @kindex n @r{(@code{next})}
5243 @item next @r{[}@var{count}@r{]}
5244 Continue to the next source line in the current (innermost) stack frame.
5245 This is similar to @code{step}, but function calls that appear within
5246 the line of code are executed without stopping. Execution stops when
5247 control reaches a different line of code at the original stack level
5248 that was executing when you gave the @code{next} command. This command
5249 is abbreviated @code{n}.
5251 An argument @var{count} is a repeat count, as for @code{step}.
5254 @c FIX ME!! Do we delete this, or is there a way it fits in with
5255 @c the following paragraph? --- Vctoria
5257 @c @code{next} within a function that lacks debugging information acts like
5258 @c @code{step}, but any function calls appearing within the code of the
5259 @c function are executed without stopping.
5261 The @code{next} command only stops at the first instruction of a
5262 source line. This prevents multiple stops that could otherwise occur in
5263 @code{switch} statements, @code{for} loops, etc.
5265 @kindex set step-mode
5267 @cindex functions without line info, and stepping
5268 @cindex stepping into functions with no line info
5269 @itemx set step-mode on
5270 The @code{set step-mode on} command causes the @code{step} command to
5271 stop at the first instruction of a function which contains no debug line
5272 information rather than stepping over it.
5274 This is useful in cases where you may be interested in inspecting the
5275 machine instructions of a function which has no symbolic info and do not
5276 want @value{GDBN} to automatically skip over this function.
5278 @item set step-mode off
5279 Causes the @code{step} command to step over any functions which contains no
5280 debug information. This is the default.
5282 @item show step-mode
5283 Show whether @value{GDBN} will stop in or step over functions without
5284 source line debug information.
5287 @kindex fin @r{(@code{finish})}
5289 Continue running until just after function in the selected stack frame
5290 returns. Print the returned value (if any). This command can be
5291 abbreviated as @code{fin}.
5293 Contrast this with the @code{return} command (@pxref{Returning,
5294 ,Returning from a Function}).
5297 @kindex u @r{(@code{until})}
5298 @cindex run until specified location
5301 Continue running until a source line past the current line, in the
5302 current stack frame, is reached. This command is used to avoid single
5303 stepping through a loop more than once. It is like the @code{next}
5304 command, except that when @code{until} encounters a jump, it
5305 automatically continues execution until the program counter is greater
5306 than the address of the jump.
5308 This means that when you reach the end of a loop after single stepping
5309 though it, @code{until} makes your program continue execution until it
5310 exits the loop. In contrast, a @code{next} command at the end of a loop
5311 simply steps back to the beginning of the loop, which forces you to step
5312 through the next iteration.
5314 @code{until} always stops your program if it attempts to exit the current
5317 @code{until} may produce somewhat counterintuitive results if the order
5318 of machine code does not match the order of the source lines. For
5319 example, in the following excerpt from a debugging session, the @code{f}
5320 (@code{frame}) command shows that execution is stopped at line
5321 @code{206}; yet when we use @code{until}, we get to line @code{195}:
5325 #0 main (argc=4, argv=0xf7fffae8) at m4.c:206
5327 (@value{GDBP}) until
5328 195 for ( ; argc > 0; NEXTARG) @{
5331 This happened because, for execution efficiency, the compiler had
5332 generated code for the loop closure test at the end, rather than the
5333 start, of the loop---even though the test in a C @code{for}-loop is
5334 written before the body of the loop. The @code{until} command appeared
5335 to step back to the beginning of the loop when it advanced to this
5336 expression; however, it has not really gone to an earlier
5337 statement---not in terms of the actual machine code.
5339 @code{until} with no argument works by means of single
5340 instruction stepping, and hence is slower than @code{until} with an
5343 @item until @var{location}
5344 @itemx u @var{location}
5345 Continue running your program until either the specified @var{location} is
5346 reached, or the current stack frame returns. The location is any of
5347 the forms described in @ref{Specify Location}.
5348 This form of the command uses temporary breakpoints, and
5349 hence is quicker than @code{until} without an argument. The specified
5350 location is actually reached only if it is in the current frame. This
5351 implies that @code{until} can be used to skip over recursive function
5352 invocations. For instance in the code below, if the current location is
5353 line @code{96}, issuing @code{until 99} will execute the program up to
5354 line @code{99} in the same invocation of factorial, i.e., after the inner
5355 invocations have returned.
5358 94 int factorial (int value)
5360 96 if (value > 1) @{
5361 97 value *= factorial (value - 1);
5368 @kindex advance @var{location}
5369 @item advance @var{location}
5370 Continue running the program up to the given @var{location}. An argument is
5371 required, which should be of one of the forms described in
5372 @ref{Specify Location}.
5373 Execution will also stop upon exit from the current stack
5374 frame. This command is similar to @code{until}, but @code{advance} will
5375 not skip over recursive function calls, and the target location doesn't
5376 have to be in the same frame as the current one.
5380 @kindex si @r{(@code{stepi})}
5382 @itemx stepi @var{arg}
5384 Execute one machine instruction, then stop and return to the debugger.
5386 It is often useful to do @samp{display/i $pc} when stepping by machine
5387 instructions. This makes @value{GDBN} automatically display the next
5388 instruction to be executed, each time your program stops. @xref{Auto
5389 Display,, Automatic Display}.
5391 An argument is a repeat count, as in @code{step}.
5395 @kindex ni @r{(@code{nexti})}
5397 @itemx nexti @var{arg}
5399 Execute one machine instruction, but if it is a function call,
5400 proceed until the function returns.
5402 An argument is a repeat count, as in @code{next}.
5406 @anchor{range stepping}
5407 @cindex range stepping
5408 @cindex target-assisted range stepping
5409 By default, and if available, @value{GDBN} makes use of
5410 target-assisted @dfn{range stepping}. In other words, whenever you
5411 use a stepping command (e.g., @code{step}, @code{next}), @value{GDBN}
5412 tells the target to step the corresponding range of instruction
5413 addresses instead of issuing multiple single-steps. This speeds up
5414 line stepping, particularly for remote targets. Ideally, there should
5415 be no reason you would want to turn range stepping off. However, it's
5416 possible that a bug in the debug info, a bug in the remote stub (for
5417 remote targets), or even a bug in @value{GDBN} could make line
5418 stepping behave incorrectly when target-assisted range stepping is
5419 enabled. You can use the following command to turn off range stepping
5423 @kindex set range-stepping
5424 @kindex show range-stepping
5425 @item set range-stepping
5426 @itemx show range-stepping
5427 Control whether range stepping is enabled.
5429 If @code{on}, and the target supports it, @value{GDBN} tells the
5430 target to step a range of addresses itself, instead of issuing
5431 multiple single-steps. If @code{off}, @value{GDBN} always issues
5432 single-steps, even if range stepping is supported by the target. The
5433 default is @code{on}.
5437 @node Skipping Over Functions and Files
5438 @section Skipping Over Functions and Files
5439 @cindex skipping over functions and files
5441 The program you are debugging may contain some functions which are
5442 uninteresting to debug. The @code{skip} comand lets you tell @value{GDBN} to
5443 skip a function or all functions in a file when stepping.
5445 For example, consider the following C function:
5456 Suppose you wish to step into the functions @code{foo} and @code{bar}, but you
5457 are not interested in stepping through @code{boring}. If you run @code{step}
5458 at line 103, you'll enter @code{boring()}, but if you run @code{next}, you'll
5459 step over both @code{foo} and @code{boring}!
5461 One solution is to @code{step} into @code{boring} and use the @code{finish}
5462 command to immediately exit it. But this can become tedious if @code{boring}
5463 is called from many places.
5465 A more flexible solution is to execute @kbd{skip boring}. This instructs
5466 @value{GDBN} never to step into @code{boring}. Now when you execute
5467 @code{step} at line 103, you'll step over @code{boring} and directly into
5470 You can also instruct @value{GDBN} to skip all functions in a file, with, for
5471 example, @code{skip file boring.c}.
5474 @kindex skip function
5475 @item skip @r{[}@var{linespec}@r{]}
5476 @itemx skip function @r{[}@var{linespec}@r{]}
5477 After running this command, the function named by @var{linespec} or the
5478 function containing the line named by @var{linespec} will be skipped over when
5479 stepping. @xref{Specify Location}.
5481 If you do not specify @var{linespec}, the function you're currently debugging
5484 (If you have a function called @code{file} that you want to skip, use
5485 @kbd{skip function file}.)
5488 @item skip file @r{[}@var{filename}@r{]}
5489 After running this command, any function whose source lives in @var{filename}
5490 will be skipped over when stepping.
5492 If you do not specify @var{filename}, functions whose source lives in the file
5493 you're currently debugging will be skipped.
5496 Skips can be listed, deleted, disabled, and enabled, much like breakpoints.
5497 These are the commands for managing your list of skips:
5501 @item info skip @r{[}@var{range}@r{]}
5502 Print details about the specified skip(s). If @var{range} is not specified,
5503 print a table with details about all functions and files marked for skipping.
5504 @code{info skip} prints the following information about each skip:
5508 A number identifying this skip.
5510 The type of this skip, either @samp{function} or @samp{file}.
5511 @item Enabled or Disabled
5512 Enabled skips are marked with @samp{y}. Disabled skips are marked with @samp{n}.
5514 For function skips, this column indicates the address in memory of the function
5515 being skipped. If you've set a function skip on a function which has not yet
5516 been loaded, this field will contain @samp{<PENDING>}. Once a shared library
5517 which has the function is loaded, @code{info skip} will show the function's
5520 For file skips, this field contains the filename being skipped. For functions
5521 skips, this field contains the function name and its line number in the file
5522 where it is defined.
5526 @item skip delete @r{[}@var{range}@r{]}
5527 Delete the specified skip(s). If @var{range} is not specified, delete all
5531 @item skip enable @r{[}@var{range}@r{]}
5532 Enable the specified skip(s). If @var{range} is not specified, enable all
5535 @kindex skip disable
5536 @item skip disable @r{[}@var{range}@r{]}
5537 Disable the specified skip(s). If @var{range} is not specified, disable all
5546 A signal is an asynchronous event that can happen in a program. The
5547 operating system defines the possible kinds of signals, and gives each
5548 kind a name and a number. For example, in Unix @code{SIGINT} is the
5549 signal a program gets when you type an interrupt character (often @kbd{Ctrl-c});
5550 @code{SIGSEGV} is the signal a program gets from referencing a place in
5551 memory far away from all the areas in use; @code{SIGALRM} occurs when
5552 the alarm clock timer goes off (which happens only if your program has
5553 requested an alarm).
5555 @cindex fatal signals
5556 Some signals, including @code{SIGALRM}, are a normal part of the
5557 functioning of your program. Others, such as @code{SIGSEGV}, indicate
5558 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
5559 program has not specified in advance some other way to handle the signal.
5560 @code{SIGINT} does not indicate an error in your program, but it is normally
5561 fatal so it can carry out the purpose of the interrupt: to kill the program.
5563 @value{GDBN} has the ability to detect any occurrence of a signal in your
5564 program. You can tell @value{GDBN} in advance what to do for each kind of
5567 @cindex handling signals
5568 Normally, @value{GDBN} is set up to let the non-erroneous signals like
5569 @code{SIGALRM} be silently passed to your program
5570 (so as not to interfere with their role in the program's functioning)
5571 but to stop your program immediately whenever an error signal happens.
5572 You can change these settings with the @code{handle} command.
5575 @kindex info signals
5579 Print a table of all the kinds of signals and how @value{GDBN} has been told to
5580 handle each one. You can use this to see the signal numbers of all
5581 the defined types of signals.
5583 @item info signals @var{sig}
5584 Similar, but print information only about the specified signal number.
5586 @code{info handle} is an alias for @code{info signals}.
5588 @item catch signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
5589 Set a catchpoint for the indicated signals. @xref{Set Catchpoints},
5590 for details about this command.
5593 @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
5594 Change the way @value{GDBN} handles signal @var{signal}. The @var{signal}
5595 can be the number of a signal or its name (with or without the
5596 @samp{SIG} at the beginning); a list of signal numbers of the form
5597 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
5598 known signals. Optional arguments @var{keywords}, described below,
5599 say what change to make.
5603 The keywords allowed by the @code{handle} command can be abbreviated.
5604 Their full names are:
5608 @value{GDBN} should not stop your program when this signal happens. It may
5609 still print a message telling you that the signal has come in.
5612 @value{GDBN} should stop your program when this signal happens. This implies
5613 the @code{print} keyword as well.
5616 @value{GDBN} should print a message when this signal happens.
5619 @value{GDBN} should not mention the occurrence of the signal at all. This
5620 implies the @code{nostop} keyword as well.
5624 @value{GDBN} should allow your program to see this signal; your program
5625 can handle the signal, or else it may terminate if the signal is fatal
5626 and not handled. @code{pass} and @code{noignore} are synonyms.
5630 @value{GDBN} should not allow your program to see this signal.
5631 @code{nopass} and @code{ignore} are synonyms.
5635 When a signal stops your program, the signal is not visible to the
5637 continue. Your program sees the signal then, if @code{pass} is in
5638 effect for the signal in question @emph{at that time}. In other words,
5639 after @value{GDBN} reports a signal, you can use the @code{handle}
5640 command with @code{pass} or @code{nopass} to control whether your
5641 program sees that signal when you continue.
5643 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
5644 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
5645 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
5648 You can also use the @code{signal} command to prevent your program from
5649 seeing a signal, or cause it to see a signal it normally would not see,
5650 or to give it any signal at any time. For example, if your program stopped
5651 due to some sort of memory reference error, you might store correct
5652 values into the erroneous variables and continue, hoping to see more
5653 execution; but your program would probably terminate immediately as
5654 a result of the fatal signal once it saw the signal. To prevent this,
5655 you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your
5658 @cindex stepping and signal handlers
5659 @anchor{stepping and signal handlers}
5661 @value{GDBN} optimizes for stepping the mainline code. If a signal
5662 that has @code{handle nostop} and @code{handle pass} set arrives while
5663 a stepping command (e.g., @code{stepi}, @code{step}, @code{next}) is
5664 in progress, @value{GDBN} lets the signal handler run and then resumes
5665 stepping the mainline code once the signal handler returns. In other
5666 words, @value{GDBN} steps over the signal handler. This prevents
5667 signals that you've specified as not interesting (with @code{handle
5668 nostop}) from changing the focus of debugging unexpectedly. Note that
5669 the signal handler itself may still hit a breakpoint, stop for another
5670 signal that has @code{handle stop} in effect, or for any other event
5671 that normally results in stopping the stepping command sooner. Also
5672 note that @value{GDBN} still informs you that the program received a
5673 signal if @code{handle print} is set.
5675 @anchor{stepping into signal handlers}
5677 If you set @code{handle pass} for a signal, and your program sets up a
5678 handler for it, then issuing a stepping command, such as @code{step}
5679 or @code{stepi}, when your program is stopped due to the signal will
5680 step @emph{into} the signal handler (if the target supports that).
5682 Likewise, if you use the @code{queue-signal} command to queue a signal
5683 to be delivered to the current thread when execution of the thread
5684 resumes (@pxref{Signaling, ,Giving your Program a Signal}), then a
5685 stepping command will step into the signal handler.
5687 Here's an example, using @code{stepi} to step to the first instruction
5688 of @code{SIGUSR1}'s handler:
5691 (@value{GDBP}) handle SIGUSR1
5692 Signal Stop Print Pass to program Description
5693 SIGUSR1 Yes Yes Yes User defined signal 1
5697 Program received signal SIGUSR1, User defined signal 1.
5698 main () sigusr1.c:28
5701 sigusr1_handler () at sigusr1.c:9
5705 The same, but using @code{queue-signal} instead of waiting for the
5706 program to receive the signal first:
5711 (@value{GDBP}) queue-signal SIGUSR1
5713 sigusr1_handler () at sigusr1.c:9
5718 @cindex extra signal information
5719 @anchor{extra signal information}
5721 On some targets, @value{GDBN} can inspect extra signal information
5722 associated with the intercepted signal, before it is actually
5723 delivered to the program being debugged. This information is exported
5724 by the convenience variable @code{$_siginfo}, and consists of data
5725 that is passed by the kernel to the signal handler at the time of the
5726 receipt of a signal. The data type of the information itself is
5727 target dependent. You can see the data type using the @code{ptype
5728 $_siginfo} command. On Unix systems, it typically corresponds to the
5729 standard @code{siginfo_t} type, as defined in the @file{signal.h}
5732 Here's an example, on a @sc{gnu}/Linux system, printing the stray
5733 referenced address that raised a segmentation fault.
5737 (@value{GDBP}) continue
5738 Program received signal SIGSEGV, Segmentation fault.
5739 0x0000000000400766 in main ()
5741 (@value{GDBP}) ptype $_siginfo
5748 struct @{...@} _kill;
5749 struct @{...@} _timer;
5751 struct @{...@} _sigchld;
5752 struct @{...@} _sigfault;
5753 struct @{...@} _sigpoll;
5756 (@value{GDBP}) ptype $_siginfo._sifields._sigfault
5760 (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr
5761 $1 = (void *) 0x7ffff7ff7000
5765 Depending on target support, @code{$_siginfo} may also be writable.
5768 @section Stopping and Starting Multi-thread Programs
5770 @cindex stopped threads
5771 @cindex threads, stopped
5773 @cindex continuing threads
5774 @cindex threads, continuing
5776 @value{GDBN} supports debugging programs with multiple threads
5777 (@pxref{Threads,, Debugging Programs with Multiple Threads}). There
5778 are two modes of controlling execution of your program within the
5779 debugger. In the default mode, referred to as @dfn{all-stop mode},
5780 when any thread in your program stops (for example, at a breakpoint
5781 or while being stepped), all other threads in the program are also stopped by
5782 @value{GDBN}. On some targets, @value{GDBN} also supports
5783 @dfn{non-stop mode}, in which other threads can continue to run freely while
5784 you examine the stopped thread in the debugger.
5787 * All-Stop Mode:: All threads stop when GDB takes control
5788 * Non-Stop Mode:: Other threads continue to execute
5789 * Background Execution:: Running your program asynchronously
5790 * Thread-Specific Breakpoints:: Controlling breakpoints
5791 * Interrupted System Calls:: GDB may interfere with system calls
5792 * Observer Mode:: GDB does not alter program behavior
5796 @subsection All-Stop Mode
5798 @cindex all-stop mode
5800 In all-stop mode, whenever your program stops under @value{GDBN} for any reason,
5801 @emph{all} threads of execution stop, not just the current thread. This
5802 allows you to examine the overall state of the program, including
5803 switching between threads, without worrying that things may change
5806 Conversely, whenever you restart the program, @emph{all} threads start
5807 executing. @emph{This is true even when single-stepping} with commands
5808 like @code{step} or @code{next}.
5810 In particular, @value{GDBN} cannot single-step all threads in lockstep.
5811 Since thread scheduling is up to your debugging target's operating
5812 system (not controlled by @value{GDBN}), other threads may
5813 execute more than one statement while the current thread completes a
5814 single step. Moreover, in general other threads stop in the middle of a
5815 statement, rather than at a clean statement boundary, when the program
5818 You might even find your program stopped in another thread after
5819 continuing or even single-stepping. This happens whenever some other
5820 thread runs into a breakpoint, a signal, or an exception before the
5821 first thread completes whatever you requested.
5823 @cindex automatic thread selection
5824 @cindex switching threads automatically
5825 @cindex threads, automatic switching
5826 Whenever @value{GDBN} stops your program, due to a breakpoint or a
5827 signal, it automatically selects the thread where that breakpoint or
5828 signal happened. @value{GDBN} alerts you to the context switch with a
5829 message such as @samp{[Switching to Thread @var{n}]} to identify the
5832 On some OSes, you can modify @value{GDBN}'s default behavior by
5833 locking the OS scheduler to allow only a single thread to run.
5836 @item set scheduler-locking @var{mode}
5837 @cindex scheduler locking mode
5838 @cindex lock scheduler
5839 Set the scheduler locking mode. It applies to normal execution,
5840 record mode, and replay mode. If it is @code{off}, then there is no
5841 locking and any thread may run at any time. If @code{on}, then only
5842 the current thread may run when the inferior is resumed. The
5843 @code{step} mode optimizes for single-stepping; it prevents other
5844 threads from preempting the current thread while you are stepping, so
5845 that the focus of debugging does not change unexpectedly. Other
5846 threads never get a chance to run when you step, and they are
5847 completely free to run when you use commands like @samp{continue},
5848 @samp{until}, or @samp{finish}. However, unless another thread hits a
5849 breakpoint during its timeslice, @value{GDBN} does not change the
5850 current thread away from the thread that you are debugging. The
5851 @code{replay} mode behaves like @code{off} in record mode and like
5852 @code{on} in replay mode.
5854 @item show scheduler-locking
5855 Display the current scheduler locking mode.
5858 @cindex resume threads of multiple processes simultaneously
5859 By default, when you issue one of the execution commands such as
5860 @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only
5861 threads of the current inferior to run. For example, if @value{GDBN}
5862 is attached to two inferiors, each with two threads, the
5863 @code{continue} command resumes only the two threads of the current
5864 inferior. This is useful, for example, when you debug a program that
5865 forks and you want to hold the parent stopped (so that, for instance,
5866 it doesn't run to exit), while you debug the child. In other
5867 situations, you may not be interested in inspecting the current state
5868 of any of the processes @value{GDBN} is attached to, and you may want
5869 to resume them all until some breakpoint is hit. In the latter case,
5870 you can instruct @value{GDBN} to allow all threads of all the
5871 inferiors to run with the @w{@code{set schedule-multiple}} command.
5874 @kindex set schedule-multiple
5875 @item set schedule-multiple
5876 Set the mode for allowing threads of multiple processes to be resumed
5877 when an execution command is issued. When @code{on}, all threads of
5878 all processes are allowed to run. When @code{off}, only the threads
5879 of the current process are resumed. The default is @code{off}. The
5880 @code{scheduler-locking} mode takes precedence when set to @code{on},
5881 or while you are stepping and set to @code{step}.
5883 @item show schedule-multiple
5884 Display the current mode for resuming the execution of threads of
5889 @subsection Non-Stop Mode
5891 @cindex non-stop mode
5893 @c This section is really only a place-holder, and needs to be expanded
5894 @c with more details.
5896 For some multi-threaded targets, @value{GDBN} supports an optional
5897 mode of operation in which you can examine stopped program threads in
5898 the debugger while other threads continue to execute freely. This
5899 minimizes intrusion when debugging live systems, such as programs
5900 where some threads have real-time constraints or must continue to
5901 respond to external events. This is referred to as @dfn{non-stop} mode.
5903 In non-stop mode, when a thread stops to report a debugging event,
5904 @emph{only} that thread is stopped; @value{GDBN} does not stop other
5905 threads as well, in contrast to the all-stop mode behavior. Additionally,
5906 execution commands such as @code{continue} and @code{step} apply by default
5907 only to the current thread in non-stop mode, rather than all threads as
5908 in all-stop mode. This allows you to control threads explicitly in
5909 ways that are not possible in all-stop mode --- for example, stepping
5910 one thread while allowing others to run freely, stepping
5911 one thread while holding all others stopped, or stepping several threads
5912 independently and simultaneously.
5914 To enter non-stop mode, use this sequence of commands before you run
5915 or attach to your program:
5918 # If using the CLI, pagination breaks non-stop.
5921 # Finally, turn it on!
5925 You can use these commands to manipulate the non-stop mode setting:
5928 @kindex set non-stop
5929 @item set non-stop on
5930 Enable selection of non-stop mode.
5931 @item set non-stop off
5932 Disable selection of non-stop mode.
5933 @kindex show non-stop
5935 Show the current non-stop enablement setting.
5938 Note these commands only reflect whether non-stop mode is enabled,
5939 not whether the currently-executing program is being run in non-stop mode.
5940 In particular, the @code{set non-stop} preference is only consulted when
5941 @value{GDBN} starts or connects to the target program, and it is generally
5942 not possible to switch modes once debugging has started. Furthermore,
5943 since not all targets support non-stop mode, even when you have enabled
5944 non-stop mode, @value{GDBN} may still fall back to all-stop operation by
5947 In non-stop mode, all execution commands apply only to the current thread
5948 by default. That is, @code{continue} only continues one thread.
5949 To continue all threads, issue @code{continue -a} or @code{c -a}.
5951 You can use @value{GDBN}'s background execution commands
5952 (@pxref{Background Execution}) to run some threads in the background
5953 while you continue to examine or step others from @value{GDBN}.
5954 The MI execution commands (@pxref{GDB/MI Program Execution}) are
5955 always executed asynchronously in non-stop mode.
5957 Suspending execution is done with the @code{interrupt} command when
5958 running in the background, or @kbd{Ctrl-c} during foreground execution.
5959 In all-stop mode, this stops the whole process;
5960 but in non-stop mode the interrupt applies only to the current thread.
5961 To stop the whole program, use @code{interrupt -a}.
5963 Other execution commands do not currently support the @code{-a} option.
5965 In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make
5966 that thread current, as it does in all-stop mode. This is because the
5967 thread stop notifications are asynchronous with respect to @value{GDBN}'s
5968 command interpreter, and it would be confusing if @value{GDBN} unexpectedly
5969 changed to a different thread just as you entered a command to operate on the
5970 previously current thread.
5972 @node Background Execution
5973 @subsection Background Execution
5975 @cindex foreground execution
5976 @cindex background execution
5977 @cindex asynchronous execution
5978 @cindex execution, foreground, background and asynchronous
5980 @value{GDBN}'s execution commands have two variants: the normal
5981 foreground (synchronous) behavior, and a background
5982 (asynchronous) behavior. In foreground execution, @value{GDBN} waits for
5983 the program to report that some thread has stopped before prompting for
5984 another command. In background execution, @value{GDBN} immediately gives
5985 a command prompt so that you can issue other commands while your program runs.
5987 If the target doesn't support async mode, @value{GDBN} issues an error
5988 message if you attempt to use the background execution commands.
5990 To specify background execution, add a @code{&} to the command. For example,
5991 the background form of the @code{continue} command is @code{continue&}, or
5992 just @code{c&}. The execution commands that accept background execution
5998 @xref{Starting, , Starting your Program}.
6002 @xref{Attach, , Debugging an Already-running Process}.
6006 @xref{Continuing and Stepping, step}.
6010 @xref{Continuing and Stepping, stepi}.
6014 @xref{Continuing and Stepping, next}.
6018 @xref{Continuing and Stepping, nexti}.
6022 @xref{Continuing and Stepping, continue}.
6026 @xref{Continuing and Stepping, finish}.
6030 @xref{Continuing and Stepping, until}.
6034 Background execution is especially useful in conjunction with non-stop
6035 mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}.
6036 However, you can also use these commands in the normal all-stop mode with
6037 the restriction that you cannot issue another execution command until the
6038 previous one finishes. Examples of commands that are valid in all-stop
6039 mode while the program is running include @code{help} and @code{info break}.
6041 You can interrupt your program while it is running in the background by
6042 using the @code{interrupt} command.
6049 Suspend execution of the running program. In all-stop mode,
6050 @code{interrupt} stops the whole process, but in non-stop mode, it stops
6051 only the current thread. To stop the whole program in non-stop mode,
6052 use @code{interrupt -a}.
6055 @node Thread-Specific Breakpoints
6056 @subsection Thread-Specific Breakpoints
6058 When your program has multiple threads (@pxref{Threads,, Debugging
6059 Programs with Multiple Threads}), you can choose whether to set
6060 breakpoints on all threads, or on a particular thread.
6063 @cindex breakpoints and threads
6064 @cindex thread breakpoints
6065 @kindex break @dots{} thread @var{threadno}
6066 @item break @var{location} thread @var{threadno}
6067 @itemx break @var{location} thread @var{threadno} if @dots{}
6068 @var{location} specifies source lines; there are several ways of
6069 writing them (@pxref{Specify Location}), but the effect is always to
6070 specify some source line.
6072 Use the qualifier @samp{thread @var{threadno}} with a breakpoint command
6073 to specify that you only want @value{GDBN} to stop the program when a
6074 particular thread reaches this breakpoint. The @var{threadno} specifier
6075 is one of the numeric thread identifiers assigned by @value{GDBN}, shown
6076 in the first column of the @samp{info threads} display.
6078 If you do not specify @samp{thread @var{threadno}} when you set a
6079 breakpoint, the breakpoint applies to @emph{all} threads of your
6082 You can use the @code{thread} qualifier on conditional breakpoints as
6083 well; in this case, place @samp{thread @var{threadno}} before or
6084 after the breakpoint condition, like this:
6087 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
6092 Thread-specific breakpoints are automatically deleted when
6093 @value{GDBN} detects the corresponding thread is no longer in the
6094 thread list. For example:
6098 Thread-specific breakpoint 3 deleted - thread 28 no longer in the thread list.
6101 There are several ways for a thread to disappear, such as a regular
6102 thread exit, but also when you detach from the process with the
6103 @code{detach} command (@pxref{Attach, ,Debugging an Already-running
6104 Process}), or if @value{GDBN} loses the remote connection
6105 (@pxref{Remote Debugging}), etc. Note that with some targets,
6106 @value{GDBN} is only able to detect a thread has exited when the user
6107 explictly asks for the thread list with the @code{info threads}
6110 @node Interrupted System Calls
6111 @subsection Interrupted System Calls
6113 @cindex thread breakpoints and system calls
6114 @cindex system calls and thread breakpoints
6115 @cindex premature return from system calls
6116 There is an unfortunate side effect when using @value{GDBN} to debug
6117 multi-threaded programs. If one thread stops for a
6118 breakpoint, or for some other reason, and another thread is blocked in a
6119 system call, then the system call may return prematurely. This is a
6120 consequence of the interaction between multiple threads and the signals
6121 that @value{GDBN} uses to implement breakpoints and other events that
6124 To handle this problem, your program should check the return value of
6125 each system call and react appropriately. This is good programming
6128 For example, do not write code like this:
6134 The call to @code{sleep} will return early if a different thread stops
6135 at a breakpoint or for some other reason.
6137 Instead, write this:
6142 unslept = sleep (unslept);
6145 A system call is allowed to return early, so the system is still
6146 conforming to its specification. But @value{GDBN} does cause your
6147 multi-threaded program to behave differently than it would without
6150 Also, @value{GDBN} uses internal breakpoints in the thread library to
6151 monitor certain events such as thread creation and thread destruction.
6152 When such an event happens, a system call in another thread may return
6153 prematurely, even though your program does not appear to stop.
6156 @subsection Observer Mode
6158 If you want to build on non-stop mode and observe program behavior
6159 without any chance of disruption by @value{GDBN}, you can set
6160 variables to disable all of the debugger's attempts to modify state,
6161 whether by writing memory, inserting breakpoints, etc. These operate
6162 at a low level, intercepting operations from all commands.
6164 When all of these are set to @code{off}, then @value{GDBN} is said to
6165 be @dfn{observer mode}. As a convenience, the variable
6166 @code{observer} can be set to disable these, plus enable non-stop
6169 Note that @value{GDBN} will not prevent you from making nonsensical
6170 combinations of these settings. For instance, if you have enabled
6171 @code{may-insert-breakpoints} but disabled @code{may-write-memory},
6172 then breakpoints that work by writing trap instructions into the code
6173 stream will still not be able to be placed.
6178 @item set observer on
6179 @itemx set observer off
6180 When set to @code{on}, this disables all the permission variables
6181 below (except for @code{insert-fast-tracepoints}), plus enables
6182 non-stop debugging. Setting this to @code{off} switches back to
6183 normal debugging, though remaining in non-stop mode.
6186 Show whether observer mode is on or off.
6188 @kindex may-write-registers
6189 @item set may-write-registers on
6190 @itemx set may-write-registers off
6191 This controls whether @value{GDBN} will attempt to alter the values of
6192 registers, such as with assignment expressions in @code{print}, or the
6193 @code{jump} command. It defaults to @code{on}.
6195 @item show may-write-registers
6196 Show the current permission to write registers.
6198 @kindex may-write-memory
6199 @item set may-write-memory on
6200 @itemx set may-write-memory off
6201 This controls whether @value{GDBN} will attempt to alter the contents
6202 of memory, such as with assignment expressions in @code{print}. It
6203 defaults to @code{on}.
6205 @item show may-write-memory
6206 Show the current permission to write memory.
6208 @kindex may-insert-breakpoints
6209 @item set may-insert-breakpoints on
6210 @itemx set may-insert-breakpoints off
6211 This controls whether @value{GDBN} will attempt to insert breakpoints.
6212 This affects all breakpoints, including internal breakpoints defined
6213 by @value{GDBN}. It defaults to @code{on}.
6215 @item show may-insert-breakpoints
6216 Show the current permission to insert breakpoints.
6218 @kindex may-insert-tracepoints
6219 @item set may-insert-tracepoints on
6220 @itemx set may-insert-tracepoints off
6221 This controls whether @value{GDBN} will attempt to insert (regular)
6222 tracepoints at the beginning of a tracing experiment. It affects only
6223 non-fast tracepoints, fast tracepoints being under the control of
6224 @code{may-insert-fast-tracepoints}. It defaults to @code{on}.
6226 @item show may-insert-tracepoints
6227 Show the current permission to insert tracepoints.
6229 @kindex may-insert-fast-tracepoints
6230 @item set may-insert-fast-tracepoints on
6231 @itemx set may-insert-fast-tracepoints off
6232 This controls whether @value{GDBN} will attempt to insert fast
6233 tracepoints at the beginning of a tracing experiment. It affects only
6234 fast tracepoints, regular (non-fast) tracepoints being under the
6235 control of @code{may-insert-tracepoints}. It defaults to @code{on}.
6237 @item show may-insert-fast-tracepoints
6238 Show the current permission to insert fast tracepoints.
6240 @kindex may-interrupt
6241 @item set may-interrupt on
6242 @itemx set may-interrupt off
6243 This controls whether @value{GDBN} will attempt to interrupt or stop
6244 program execution. When this variable is @code{off}, the
6245 @code{interrupt} command will have no effect, nor will
6246 @kbd{Ctrl-c}. It defaults to @code{on}.
6248 @item show may-interrupt
6249 Show the current permission to interrupt or stop the program.
6253 @node Reverse Execution
6254 @chapter Running programs backward
6255 @cindex reverse execution
6256 @cindex running programs backward
6258 When you are debugging a program, it is not unusual to realize that
6259 you have gone too far, and some event of interest has already happened.
6260 If the target environment supports it, @value{GDBN} can allow you to
6261 ``rewind'' the program by running it backward.
6263 A target environment that supports reverse execution should be able
6264 to ``undo'' the changes in machine state that have taken place as the
6265 program was executing normally. Variables, registers etc.@: should
6266 revert to their previous values. Obviously this requires a great
6267 deal of sophistication on the part of the target environment; not
6268 all target environments can support reverse execution.
6270 When a program is executed in reverse, the instructions that
6271 have most recently been executed are ``un-executed'', in reverse
6272 order. The program counter runs backward, following the previous
6273 thread of execution in reverse. As each instruction is ``un-executed'',
6274 the values of memory and/or registers that were changed by that
6275 instruction are reverted to their previous states. After executing
6276 a piece of source code in reverse, all side effects of that code
6277 should be ``undone'', and all variables should be returned to their
6278 prior values@footnote{
6279 Note that some side effects are easier to undo than others. For instance,
6280 memory and registers are relatively easy, but device I/O is hard. Some
6281 targets may be able undo things like device I/O, and some may not.
6283 The contract between @value{GDBN} and the reverse executing target
6284 requires only that the target do something reasonable when
6285 @value{GDBN} tells it to execute backwards, and then report the
6286 results back to @value{GDBN}. Whatever the target reports back to
6287 @value{GDBN}, @value{GDBN} will report back to the user. @value{GDBN}
6288 assumes that the memory and registers that the target reports are in a
6289 consistant state, but @value{GDBN} accepts whatever it is given.
6292 If you are debugging in a target environment that supports
6293 reverse execution, @value{GDBN} provides the following commands.
6296 @kindex reverse-continue
6297 @kindex rc @r{(@code{reverse-continue})}
6298 @item reverse-continue @r{[}@var{ignore-count}@r{]}
6299 @itemx rc @r{[}@var{ignore-count}@r{]}
6300 Beginning at the point where your program last stopped, start executing
6301 in reverse. Reverse execution will stop for breakpoints and synchronous
6302 exceptions (signals), just like normal execution. Behavior of
6303 asynchronous signals depends on the target environment.
6305 @kindex reverse-step
6306 @kindex rs @r{(@code{step})}
6307 @item reverse-step @r{[}@var{count}@r{]}
6308 Run the program backward until control reaches the start of a
6309 different source line; then stop it, and return control to @value{GDBN}.
6311 Like the @code{step} command, @code{reverse-step} will only stop
6312 at the beginning of a source line. It ``un-executes'' the previously
6313 executed source line. If the previous source line included calls to
6314 debuggable functions, @code{reverse-step} will step (backward) into
6315 the called function, stopping at the beginning of the @emph{last}
6316 statement in the called function (typically a return statement).
6318 Also, as with the @code{step} command, if non-debuggable functions are
6319 called, @code{reverse-step} will run thru them backward without stopping.
6321 @kindex reverse-stepi
6322 @kindex rsi @r{(@code{reverse-stepi})}
6323 @item reverse-stepi @r{[}@var{count}@r{]}
6324 Reverse-execute one machine instruction. Note that the instruction
6325 to be reverse-executed is @emph{not} the one pointed to by the program
6326 counter, but the instruction executed prior to that one. For instance,
6327 if the last instruction was a jump, @code{reverse-stepi} will take you
6328 back from the destination of the jump to the jump instruction itself.
6330 @kindex reverse-next
6331 @kindex rn @r{(@code{reverse-next})}
6332 @item reverse-next @r{[}@var{count}@r{]}
6333 Run backward to the beginning of the previous line executed in
6334 the current (innermost) stack frame. If the line contains function
6335 calls, they will be ``un-executed'' without stopping. Starting from
6336 the first line of a function, @code{reverse-next} will take you back
6337 to the caller of that function, @emph{before} the function was called,
6338 just as the normal @code{next} command would take you from the last
6339 line of a function back to its return to its caller
6340 @footnote{Unless the code is too heavily optimized.}.
6342 @kindex reverse-nexti
6343 @kindex rni @r{(@code{reverse-nexti})}
6344 @item reverse-nexti @r{[}@var{count}@r{]}
6345 Like @code{nexti}, @code{reverse-nexti} executes a single instruction
6346 in reverse, except that called functions are ``un-executed'' atomically.
6347 That is, if the previously executed instruction was a return from
6348 another function, @code{reverse-nexti} will continue to execute
6349 in reverse until the call to that function (from the current stack
6352 @kindex reverse-finish
6353 @item reverse-finish
6354 Just as the @code{finish} command takes you to the point where the
6355 current function returns, @code{reverse-finish} takes you to the point
6356 where it was called. Instead of ending up at the end of the current
6357 function invocation, you end up at the beginning.
6359 @kindex set exec-direction
6360 @item set exec-direction
6361 Set the direction of target execution.
6362 @item set exec-direction reverse
6363 @cindex execute forward or backward in time
6364 @value{GDBN} will perform all execution commands in reverse, until the
6365 exec-direction mode is changed to ``forward''. Affected commands include
6366 @code{step, stepi, next, nexti, continue, and finish}. The @code{return}
6367 command cannot be used in reverse mode.
6368 @item set exec-direction forward
6369 @value{GDBN} will perform all execution commands in the normal fashion.
6370 This is the default.
6374 @node Process Record and Replay
6375 @chapter Recording Inferior's Execution and Replaying It
6376 @cindex process record and replay
6377 @cindex recording inferior's execution and replaying it
6379 On some platforms, @value{GDBN} provides a special @dfn{process record
6380 and replay} target that can record a log of the process execution, and
6381 replay it later with both forward and reverse execution commands.
6384 When this target is in use, if the execution log includes the record
6385 for the next instruction, @value{GDBN} will debug in @dfn{replay
6386 mode}. In the replay mode, the inferior does not really execute code
6387 instructions. Instead, all the events that normally happen during
6388 code execution are taken from the execution log. While code is not
6389 really executed in replay mode, the values of registers (including the
6390 program counter register) and the memory of the inferior are still
6391 changed as they normally would. Their contents are taken from the
6395 If the record for the next instruction is not in the execution log,
6396 @value{GDBN} will debug in @dfn{record mode}. In this mode, the
6397 inferior executes normally, and @value{GDBN} records the execution log
6400 The process record and replay target supports reverse execution
6401 (@pxref{Reverse Execution}), even if the platform on which the
6402 inferior runs does not. However, the reverse execution is limited in
6403 this case by the range of the instructions recorded in the execution
6404 log. In other words, reverse execution on platforms that don't
6405 support it directly can only be done in the replay mode.
6407 When debugging in the reverse direction, @value{GDBN} will work in
6408 replay mode as long as the execution log includes the record for the
6409 previous instruction; otherwise, it will work in record mode, if the
6410 platform supports reverse execution, or stop if not.
6412 For architecture environments that support process record and replay,
6413 @value{GDBN} provides the following commands:
6416 @kindex target record
6417 @kindex target record-full
6418 @kindex target record-btrace
6421 @kindex record btrace
6422 @kindex record btrace bts
6423 @kindex record btrace pt
6429 @kindex rec btrace bts
6430 @kindex rec btrace pt
6433 @item record @var{method}
6434 This command starts the process record and replay target. The
6435 recording method can be specified as parameter. Without a parameter
6436 the command uses the @code{full} recording method. The following
6437 recording methods are available:
6441 Full record/replay recording using @value{GDBN}'s software record and
6442 replay implementation. This method allows replaying and reverse
6445 @item btrace @var{format}
6446 Hardware-supported instruction recording. This method does not record
6447 data. Further, the data is collected in a ring buffer so old data will
6448 be overwritten when the buffer is full. It allows limited reverse
6449 execution. Variables and registers are not available during reverse
6452 The recording format can be specified as parameter. Without a parameter
6453 the command chooses the recording format. The following recording
6454 formats are available:
6458 @cindex branch trace store
6459 Use the @dfn{Branch Trace Store} (@acronym{BTS}) recording format. In
6460 this format, the processor stores a from/to record for each executed
6461 branch in the btrace ring buffer.
6464 @cindex Intel(R) Processor Trace
6465 Use the @dfn{Intel(R) Processor Trace} recording format. In this
6466 format, the processor stores the execution trace in a compressed form
6467 that is afterwards decoded by @value{GDBN}.
6469 The trace can be recorded with very low overhead. The compressed
6470 trace format also allows small trace buffers to already contain a big
6471 number of instructions compared to @acronym{BTS}.
6473 Decoding the recorded execution trace, on the other hand, is more
6474 expensive than decoding @acronym{BTS} trace. This is mostly due to the
6475 increased number of instructions to process. You should increase the
6476 buffer-size with care.
6479 Not all recording formats may be available on all processors.
6482 The process record and replay target can only debug a process that is
6483 already running. Therefore, you need first to start the process with
6484 the @kbd{run} or @kbd{start} commands, and then start the recording
6485 with the @kbd{record @var{method}} command.
6487 @cindex displaced stepping, and process record and replay
6488 Displaced stepping (@pxref{Maintenance Commands,, displaced stepping})
6489 will be automatically disabled when process record and replay target
6490 is started. That's because the process record and replay target
6491 doesn't support displaced stepping.
6493 @cindex non-stop mode, and process record and replay
6494 @cindex asynchronous execution, and process record and replay
6495 If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in
6496 the asynchronous execution mode (@pxref{Background Execution}), not
6497 all recording methods are available. The @code{full} recording method
6498 does not support these two modes.
6503 Stop the process record and replay target. When process record and
6504 replay target stops, the entire execution log will be deleted and the
6505 inferior will either be terminated, or will remain in its final state.
6507 When you stop the process record and replay target in record mode (at
6508 the end of the execution log), the inferior will be stopped at the
6509 next instruction that would have been recorded. In other words, if
6510 you record for a while and then stop recording, the inferior process
6511 will be left in the same state as if the recording never happened.
6513 On the other hand, if the process record and replay target is stopped
6514 while in replay mode (that is, not at the end of the execution log,
6515 but at some earlier point), the inferior process will become ``live''
6516 at that earlier state, and it will then be possible to continue the
6517 usual ``live'' debugging of the process from that state.
6519 When the inferior process exits, or @value{GDBN} detaches from it,
6520 process record and replay target will automatically stop itself.
6524 Go to a specific location in the execution log. There are several
6525 ways to specify the location to go to:
6528 @item record goto begin
6529 @itemx record goto start
6530 Go to the beginning of the execution log.
6532 @item record goto end
6533 Go to the end of the execution log.
6535 @item record goto @var{n}
6536 Go to instruction number @var{n} in the execution log.
6540 @item record save @var{filename}
6541 Save the execution log to a file @file{@var{filename}}.
6542 Default filename is @file{gdb_record.@var{process_id}}, where
6543 @var{process_id} is the process ID of the inferior.
6545 This command may not be available for all recording methods.
6547 @kindex record restore
6548 @item record restore @var{filename}
6549 Restore the execution log from a file @file{@var{filename}}.
6550 File must have been created with @code{record save}.
6552 @kindex set record full
6553 @item set record full insn-number-max @var{limit}
6554 @itemx set record full insn-number-max unlimited
6555 Set the limit of instructions to be recorded for the @code{full}
6556 recording method. Default value is 200000.
6558 If @var{limit} is a positive number, then @value{GDBN} will start
6559 deleting instructions from the log once the number of the record
6560 instructions becomes greater than @var{limit}. For every new recorded
6561 instruction, @value{GDBN} will delete the earliest recorded
6562 instruction to keep the number of recorded instructions at the limit.
6563 (Since deleting recorded instructions loses information, @value{GDBN}
6564 lets you control what happens when the limit is reached, by means of
6565 the @code{stop-at-limit} option, described below.)
6567 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will never
6568 delete recorded instructions from the execution log. The number of
6569 recorded instructions is limited only by the available memory.
6571 @kindex show record full
6572 @item show record full insn-number-max
6573 Show the limit of instructions to be recorded with the @code{full}
6576 @item set record full stop-at-limit
6577 Control the behavior of the @code{full} recording method when the
6578 number of recorded instructions reaches the limit. If ON (the
6579 default), @value{GDBN} will stop when the limit is reached for the
6580 first time and ask you whether you want to stop the inferior or
6581 continue running it and recording the execution log. If you decide
6582 to continue recording, each new recorded instruction will cause the
6583 oldest one to be deleted.
6585 If this option is OFF, @value{GDBN} will automatically delete the
6586 oldest record to make room for each new one, without asking.
6588 @item show record full stop-at-limit
6589 Show the current setting of @code{stop-at-limit}.
6591 @item set record full memory-query
6592 Control the behavior when @value{GDBN} is unable to record memory
6593 changes caused by an instruction for the @code{full} recording method.
6594 If ON, @value{GDBN} will query whether to stop the inferior in that
6597 If this option is OFF (the default), @value{GDBN} will automatically
6598 ignore the effect of such instructions on memory. Later, when
6599 @value{GDBN} replays this execution log, it will mark the log of this
6600 instruction as not accessible, and it will not affect the replay
6603 @item show record full memory-query
6604 Show the current setting of @code{memory-query}.
6606 @kindex set record btrace
6607 The @code{btrace} record target does not trace data. As a
6608 convenience, when replaying, @value{GDBN} reads read-only memory off
6609 the live program directly, assuming that the addresses of the
6610 read-only areas don't change. This for example makes it possible to
6611 disassemble code while replaying, but not to print variables.
6612 In some cases, being able to inspect variables might be useful.
6613 You can use the following command for that:
6615 @item set record btrace replay-memory-access
6616 Control the behavior of the @code{btrace} recording method when
6617 accessing memory during replay. If @code{read-only} (the default),
6618 @value{GDBN} will only allow accesses to read-only memory.
6619 If @code{read-write}, @value{GDBN} will allow accesses to read-only
6620 and to read-write memory. Beware that the accessed memory corresponds
6621 to the live target and not necessarily to the current replay
6624 @kindex show record btrace
6625 @item show record btrace replay-memory-access
6626 Show the current setting of @code{replay-memory-access}.
6628 @kindex set record btrace bts
6629 @item set record btrace bts buffer-size @var{size}
6630 @itemx set record btrace bts buffer-size unlimited
6631 Set the requested ring buffer size for branch tracing in @acronym{BTS}
6632 format. Default is 64KB.
6634 If @var{size} is a positive number, then @value{GDBN} will try to
6635 allocate a buffer of at least @var{size} bytes for each new thread
6636 that uses the btrace recording method and the @acronym{BTS} format.
6637 The actually obtained buffer size may differ from the requested
6638 @var{size}. Use the @code{info record} command to see the actual
6639 buffer size for each thread that uses the btrace recording method and
6640 the @acronym{BTS} format.
6642 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6643 allocate a buffer of 4MB.
6645 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
6646 also need longer to process the branch trace data before it can be used.
6648 @item show record btrace bts buffer-size @var{size}
6649 Show the current setting of the requested ring buffer size for branch
6650 tracing in @acronym{BTS} format.
6652 @kindex set record btrace pt
6653 @item set record btrace pt buffer-size @var{size}
6654 @itemx set record btrace pt buffer-size unlimited
6655 Set the requested ring buffer size for branch tracing in Intel(R)
6656 Processor Trace format. Default is 16KB.
6658 If @var{size} is a positive number, then @value{GDBN} will try to
6659 allocate a buffer of at least @var{size} bytes for each new thread
6660 that uses the btrace recording method and the Intel(R) Processor Trace
6661 format. The actually obtained buffer size may differ from the
6662 requested @var{size}. Use the @code{info record} command to see the
6663 actual buffer size for each thread.
6665 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6666 allocate a buffer of 4MB.
6668 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
6669 also need longer to process the branch trace data before it can be used.
6671 @item show record btrace pt buffer-size @var{size}
6672 Show the current setting of the requested ring buffer size for branch
6673 tracing in Intel(R) Processor Trace format.
6677 Show various statistics about the recording depending on the recording
6682 For the @code{full} recording method, it shows the state of process
6683 record and its in-memory execution log buffer, including:
6687 Whether in record mode or replay mode.
6689 Lowest recorded instruction number (counting from when the current execution log started recording instructions).
6691 Highest recorded instruction number.
6693 Current instruction about to be replayed (if in replay mode).
6695 Number of instructions contained in the execution log.
6697 Maximum number of instructions that may be contained in the execution log.
6701 For the @code{btrace} recording method, it shows:
6707 Number of instructions that have been recorded.
6709 Number of blocks of sequential control-flow formed by the recorded
6712 Whether in record mode or replay mode.
6715 For the @code{bts} recording format, it also shows:
6718 Size of the perf ring buffer.
6721 For the @code{pt} recording format, it also shows:
6724 Size of the perf ring buffer.
6728 @kindex record delete
6731 When record target runs in replay mode (``in the past''), delete the
6732 subsequent execution log and begin to record a new execution log starting
6733 from the current address. This means you will abandon the previously
6734 recorded ``future'' and begin recording a new ``future''.
6736 @kindex record instruction-history
6737 @kindex rec instruction-history
6738 @item record instruction-history
6739 Disassembles instructions from the recorded execution log. By
6740 default, ten instructions are disassembled. This can be changed using
6741 the @code{set record instruction-history-size} command. Instructions
6742 are printed in execution order.
6744 Speculatively executed instructions are prefixed with @samp{?}. This
6745 feature is not available for all recording formats.
6747 There are several ways to specify what part of the execution log to
6751 @item record instruction-history @var{insn}
6752 Disassembles ten instructions starting from instruction number
6755 @item record instruction-history @var{insn}, +/-@var{n}
6756 Disassembles @var{n} instructions around instruction number
6757 @var{insn}. If @var{n} is preceded with @code{+}, disassembles
6758 @var{n} instructions after instruction number @var{insn}. If
6759 @var{n} is preceded with @code{-}, disassembles @var{n}
6760 instructions before instruction number @var{insn}.
6762 @item record instruction-history
6763 Disassembles ten more instructions after the last disassembly.
6765 @item record instruction-history -
6766 Disassembles ten more instructions before the last disassembly.
6768 @item record instruction-history @var{begin}, @var{end}
6769 Disassembles instructions beginning with instruction number
6770 @var{begin} until instruction number @var{end}. The instruction
6771 number @var{end} is included.
6774 This command may not be available for all recording methods.
6777 @item set record instruction-history-size @var{size}
6778 @itemx set record instruction-history-size unlimited
6779 Define how many instructions to disassemble in the @code{record
6780 instruction-history} command. The default value is 10.
6781 A @var{size} of @code{unlimited} means unlimited instructions.
6784 @item show record instruction-history-size
6785 Show how many instructions to disassemble in the @code{record
6786 instruction-history} command.
6788 @kindex record function-call-history
6789 @kindex rec function-call-history
6790 @item record function-call-history
6791 Prints the execution history at function granularity. It prints one
6792 line for each sequence of instructions that belong to the same
6793 function giving the name of that function, the source lines
6794 for this instruction sequence (if the @code{/l} modifier is
6795 specified), and the instructions numbers that form the sequence (if
6796 the @code{/i} modifier is specified). The function names are indented
6797 to reflect the call stack depth if the @code{/c} modifier is
6798 specified. The @code{/l}, @code{/i}, and @code{/c} modifiers can be
6802 (@value{GDBP}) @b{list 1, 10}
6813 (@value{GDBP}) @b{record function-call-history /ilc}
6814 1 bar inst 1,4 at foo.c:6,8
6815 2 foo inst 5,10 at foo.c:2,3
6816 3 bar inst 11,13 at foo.c:9,10
6819 By default, ten lines are printed. This can be changed using the
6820 @code{set record function-call-history-size} command. Functions are
6821 printed in execution order. There are several ways to specify what
6825 @item record function-call-history @var{func}
6826 Prints ten functions starting from function number @var{func}.
6828 @item record function-call-history @var{func}, +/-@var{n}
6829 Prints @var{n} functions around function number @var{func}. If
6830 @var{n} is preceded with @code{+}, prints @var{n} functions after
6831 function number @var{func}. If @var{n} is preceded with @code{-},
6832 prints @var{n} functions before function number @var{func}.
6834 @item record function-call-history
6835 Prints ten more functions after the last ten-line print.
6837 @item record function-call-history -
6838 Prints ten more functions before the last ten-line print.
6840 @item record function-call-history @var{begin}, @var{end}
6841 Prints functions beginning with function number @var{begin} until
6842 function number @var{end}. The function number @var{end} is included.
6845 This command may not be available for all recording methods.
6847 @item set record function-call-history-size @var{size}
6848 @itemx set record function-call-history-size unlimited
6849 Define how many lines to print in the
6850 @code{record function-call-history} command. The default value is 10.
6851 A size of @code{unlimited} means unlimited lines.
6853 @item show record function-call-history-size
6854 Show how many lines to print in the
6855 @code{record function-call-history} command.
6860 @chapter Examining the Stack
6862 When your program has stopped, the first thing you need to know is where it
6863 stopped and how it got there.
6866 Each time your program performs a function call, information about the call
6868 That information includes the location of the call in your program,
6869 the arguments of the call,
6870 and the local variables of the function being called.
6871 The information is saved in a block of data called a @dfn{stack frame}.
6872 The stack frames are allocated in a region of memory called the @dfn{call
6875 When your program stops, the @value{GDBN} commands for examining the
6876 stack allow you to see all of this information.
6878 @cindex selected frame
6879 One of the stack frames is @dfn{selected} by @value{GDBN} and many
6880 @value{GDBN} commands refer implicitly to the selected frame. In
6881 particular, whenever you ask @value{GDBN} for the value of a variable in
6882 your program, the value is found in the selected frame. There are
6883 special @value{GDBN} commands to select whichever frame you are
6884 interested in. @xref{Selection, ,Selecting a Frame}.
6886 When your program stops, @value{GDBN} automatically selects the
6887 currently executing frame and describes it briefly, similar to the
6888 @code{frame} command (@pxref{Frame Info, ,Information about a Frame}).
6891 * Frames:: Stack frames
6892 * Backtrace:: Backtraces
6893 * Frame Filter Management:: Managing frame filters
6894 * Selection:: Selecting a frame
6895 * Frame Info:: Information on a frame
6900 @section Stack Frames
6902 @cindex frame, definition
6904 The call stack is divided up into contiguous pieces called @dfn{stack
6905 frames}, or @dfn{frames} for short; each frame is the data associated
6906 with one call to one function. The frame contains the arguments given
6907 to the function, the function's local variables, and the address at
6908 which the function is executing.
6910 @cindex initial frame
6911 @cindex outermost frame
6912 @cindex innermost frame
6913 When your program is started, the stack has only one frame, that of the
6914 function @code{main}. This is called the @dfn{initial} frame or the
6915 @dfn{outermost} frame. Each time a function is called, a new frame is
6916 made. Each time a function returns, the frame for that function invocation
6917 is eliminated. If a function is recursive, there can be many frames for
6918 the same function. The frame for the function in which execution is
6919 actually occurring is called the @dfn{innermost} frame. This is the most
6920 recently created of all the stack frames that still exist.
6922 @cindex frame pointer
6923 Inside your program, stack frames are identified by their addresses. A
6924 stack frame consists of many bytes, each of which has its own address; each
6925 kind of computer has a convention for choosing one byte whose
6926 address serves as the address of the frame. Usually this address is kept
6927 in a register called the @dfn{frame pointer register}
6928 (@pxref{Registers, $fp}) while execution is going on in that frame.
6930 @cindex frame number
6931 @value{GDBN} assigns numbers to all existing stack frames, starting with
6932 zero for the innermost frame, one for the frame that called it,
6933 and so on upward. These numbers do not really exist in your program;
6934 they are assigned by @value{GDBN} to give you a way of designating stack
6935 frames in @value{GDBN} commands.
6937 @c The -fomit-frame-pointer below perennially causes hbox overflow
6938 @c underflow problems.
6939 @cindex frameless execution
6940 Some compilers provide a way to compile functions so that they operate
6941 without stack frames. (For example, the @value{NGCC} option
6943 @samp{-fomit-frame-pointer}
6945 generates functions without a frame.)
6946 This is occasionally done with heavily used library functions to save
6947 the frame setup time. @value{GDBN} has limited facilities for dealing
6948 with these function invocations. If the innermost function invocation
6949 has no stack frame, @value{GDBN} nevertheless regards it as though
6950 it had a separate frame, which is numbered zero as usual, allowing
6951 correct tracing of the function call chain. However, @value{GDBN} has
6952 no provision for frameless functions elsewhere in the stack.
6958 @cindex call stack traces
6959 A backtrace is a summary of how your program got where it is. It shows one
6960 line per frame, for many frames, starting with the currently executing
6961 frame (frame zero), followed by its caller (frame one), and on up the
6964 @anchor{backtrace-command}
6967 @kindex bt @r{(@code{backtrace})}
6970 Print a backtrace of the entire stack: one line per frame for all
6971 frames in the stack.
6973 You can stop the backtrace at any time by typing the system interrupt
6974 character, normally @kbd{Ctrl-c}.
6976 @item backtrace @var{n}
6978 Similar, but print only the innermost @var{n} frames.
6980 @item backtrace -@var{n}
6982 Similar, but print only the outermost @var{n} frames.
6984 @item backtrace full
6986 @itemx bt full @var{n}
6987 @itemx bt full -@var{n}
6988 Print the values of the local variables also. As described above,
6989 @var{n} specifies the number of frames to print.
6991 @item backtrace no-filters
6992 @itemx bt no-filters
6993 @itemx bt no-filters @var{n}
6994 @itemx bt no-filters -@var{n}
6995 @itemx bt no-filters full
6996 @itemx bt no-filters full @var{n}
6997 @itemx bt no-filters full -@var{n}
6998 Do not run Python frame filters on this backtrace. @xref{Frame
6999 Filter API}, for more information. Additionally use @ref{disable
7000 frame-filter all} to turn off all frame filters. This is only
7001 relevant when @value{GDBN} has been configured with @code{Python}
7007 The names @code{where} and @code{info stack} (abbreviated @code{info s})
7008 are additional aliases for @code{backtrace}.
7010 @cindex multiple threads, backtrace
7011 In a multi-threaded program, @value{GDBN} by default shows the
7012 backtrace only for the current thread. To display the backtrace for
7013 several or all of the threads, use the command @code{thread apply}
7014 (@pxref{Threads, thread apply}). For example, if you type @kbd{thread
7015 apply all backtrace}, @value{GDBN} will display the backtrace for all
7016 the threads; this is handy when you debug a core dump of a
7017 multi-threaded program.
7019 Each line in the backtrace shows the frame number and the function name.
7020 The program counter value is also shown---unless you use @code{set
7021 print address off}. The backtrace also shows the source file name and
7022 line number, as well as the arguments to the function. The program
7023 counter value is omitted if it is at the beginning of the code for that
7026 Here is an example of a backtrace. It was made with the command
7027 @samp{bt 3}, so it shows the innermost three frames.
7031 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7033 #1 0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242
7034 #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
7036 (More stack frames follow...)
7041 The display for frame zero does not begin with a program counter
7042 value, indicating that your program has stopped at the beginning of the
7043 code for line @code{993} of @code{builtin.c}.
7046 The value of parameter @code{data} in frame 1 has been replaced by
7047 @code{@dots{}}. By default, @value{GDBN} prints the value of a parameter
7048 only if it is a scalar (integer, pointer, enumeration, etc). See command
7049 @kbd{set print frame-arguments} in @ref{Print Settings} for more details
7050 on how to configure the way function parameter values are printed.
7052 @cindex optimized out, in backtrace
7053 @cindex function call arguments, optimized out
7054 If your program was compiled with optimizations, some compilers will
7055 optimize away arguments passed to functions if those arguments are
7056 never used after the call. Such optimizations generate code that
7057 passes arguments through registers, but doesn't store those arguments
7058 in the stack frame. @value{GDBN} has no way of displaying such
7059 arguments in stack frames other than the innermost one. Here's what
7060 such a backtrace might look like:
7064 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7066 #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242
7067 #2 0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08)
7069 (More stack frames follow...)
7074 The values of arguments that were not saved in their stack frames are
7075 shown as @samp{<optimized out>}.
7077 If you need to display the values of such optimized-out arguments,
7078 either deduce that from other variables whose values depend on the one
7079 you are interested in, or recompile without optimizations.
7081 @cindex backtrace beyond @code{main} function
7082 @cindex program entry point
7083 @cindex startup code, and backtrace
7084 Most programs have a standard user entry point---a place where system
7085 libraries and startup code transition into user code. For C this is
7086 @code{main}@footnote{
7087 Note that embedded programs (the so-called ``free-standing''
7088 environment) are not required to have a @code{main} function as the
7089 entry point. They could even have multiple entry points.}.
7090 When @value{GDBN} finds the entry function in a backtrace
7091 it will terminate the backtrace, to avoid tracing into highly
7092 system-specific (and generally uninteresting) code.
7094 If you need to examine the startup code, or limit the number of levels
7095 in a backtrace, you can change this behavior:
7098 @item set backtrace past-main
7099 @itemx set backtrace past-main on
7100 @kindex set backtrace
7101 Backtraces will continue past the user entry point.
7103 @item set backtrace past-main off
7104 Backtraces will stop when they encounter the user entry point. This is the
7107 @item show backtrace past-main
7108 @kindex show backtrace
7109 Display the current user entry point backtrace policy.
7111 @item set backtrace past-entry
7112 @itemx set backtrace past-entry on
7113 Backtraces will continue past the internal entry point of an application.
7114 This entry point is encoded by the linker when the application is built,
7115 and is likely before the user entry point @code{main} (or equivalent) is called.
7117 @item set backtrace past-entry off
7118 Backtraces will stop when they encounter the internal entry point of an
7119 application. This is the default.
7121 @item show backtrace past-entry
7122 Display the current internal entry point backtrace policy.
7124 @item set backtrace limit @var{n}
7125 @itemx set backtrace limit 0
7126 @itemx set backtrace limit unlimited
7127 @cindex backtrace limit
7128 Limit the backtrace to @var{n} levels. A value of @code{unlimited}
7129 or zero means unlimited levels.
7131 @item show backtrace limit
7132 Display the current limit on backtrace levels.
7135 You can control how file names are displayed.
7138 @item set filename-display
7139 @itemx set filename-display relative
7140 @cindex filename-display
7141 Display file names relative to the compilation directory. This is the default.
7143 @item set filename-display basename
7144 Display only basename of a filename.
7146 @item set filename-display absolute
7147 Display an absolute filename.
7149 @item show filename-display
7150 Show the current way to display filenames.
7154 @section Selecting a Frame
7156 Most commands for examining the stack and other data in your program work on
7157 whichever stack frame is selected at the moment. Here are the commands for
7158 selecting a stack frame; all of them finish by printing a brief description
7159 of the stack frame just selected.
7162 @kindex frame@r{, selecting}
7163 @kindex f @r{(@code{frame})}
7166 Select frame number @var{n}. Recall that frame zero is the innermost
7167 (currently executing) frame, frame one is the frame that called the
7168 innermost one, and so on. The highest-numbered frame is the one for
7171 @item frame @var{stack-addr} [ @var{pc-addr} ]
7172 @itemx f @var{stack-addr} [ @var{pc-addr} ]
7173 Select the frame at address @var{stack-addr}. This is useful mainly if the
7174 chaining of stack frames has been damaged by a bug, making it
7175 impossible for @value{GDBN} to assign numbers properly to all frames. In
7176 addition, this can be useful when your program has multiple stacks and
7177 switches between them. The optional @var{pc-addr} can also be given to
7178 specify the value of PC for the stack frame.
7182 Move @var{n} frames up the stack; @var{n} defaults to 1. For positive
7183 numbers @var{n}, this advances toward the outermost frame, to higher
7184 frame numbers, to frames that have existed longer.
7187 @kindex do @r{(@code{down})}
7189 Move @var{n} frames down the stack; @var{n} defaults to 1. For
7190 positive numbers @var{n}, this advances toward the innermost frame, to
7191 lower frame numbers, to frames that were created more recently.
7192 You may abbreviate @code{down} as @code{do}.
7195 All of these commands end by printing two lines of output describing the
7196 frame. The first line shows the frame number, the function name, the
7197 arguments, and the source file and line number of execution in that
7198 frame. The second line shows the text of that source line.
7206 #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
7208 10 read_input_file (argv[i]);
7212 After such a printout, the @code{list} command with no arguments
7213 prints ten lines centered on the point of execution in the frame.
7214 You can also edit the program at the point of execution with your favorite
7215 editing program by typing @code{edit}.
7216 @xref{List, ,Printing Source Lines},
7220 @kindex select-frame
7222 The @code{select-frame} command is a variant of @code{frame} that does
7223 not display the new frame after selecting it. This command is
7224 intended primarily for use in @value{GDBN} command scripts, where the
7225 output might be unnecessary and distracting.
7227 @kindex down-silently
7229 @item up-silently @var{n}
7230 @itemx down-silently @var{n}
7231 These two commands are variants of @code{up} and @code{down},
7232 respectively; they differ in that they do their work silently, without
7233 causing display of the new frame. They are intended primarily for use
7234 in @value{GDBN} command scripts, where the output might be unnecessary and
7239 @section Information About a Frame
7241 There are several other commands to print information about the selected
7247 When used without any argument, this command does not change which
7248 frame is selected, but prints a brief description of the currently
7249 selected stack frame. It can be abbreviated @code{f}. With an
7250 argument, this command is used to select a stack frame.
7251 @xref{Selection, ,Selecting a Frame}.
7254 @kindex info f @r{(@code{info frame})}
7257 This command prints a verbose description of the selected stack frame,
7262 the address of the frame
7264 the address of the next frame down (called by this frame)
7266 the address of the next frame up (caller of this frame)
7268 the language in which the source code corresponding to this frame is written
7270 the address of the frame's arguments
7272 the address of the frame's local variables
7274 the program counter saved in it (the address of execution in the caller frame)
7276 which registers were saved in the frame
7279 @noindent The verbose description is useful when
7280 something has gone wrong that has made the stack format fail to fit
7281 the usual conventions.
7283 @item info frame @var{addr}
7284 @itemx info f @var{addr}
7285 Print a verbose description of the frame at address @var{addr}, without
7286 selecting that frame. The selected frame remains unchanged by this
7287 command. This requires the same kind of address (more than one for some
7288 architectures) that you specify in the @code{frame} command.
7289 @xref{Selection, ,Selecting a Frame}.
7293 Print the arguments of the selected frame, each on a separate line.
7297 Print the local variables of the selected frame, each on a separate
7298 line. These are all variables (declared either static or automatic)
7299 accessible at the point of execution of the selected frame.
7303 @node Frame Filter Management
7304 @section Management of Frame Filters.
7305 @cindex managing frame filters
7307 Frame filters are Python based utilities to manage and decorate the
7308 output of frames. @xref{Frame Filter API}, for further information.
7310 Managing frame filters is performed by several commands available
7311 within @value{GDBN}, detailed here.
7314 @kindex info frame-filter
7315 @item info frame-filter
7316 Print a list of installed frame filters from all dictionaries, showing
7317 their name, priority and enabled status.
7319 @kindex disable frame-filter
7320 @anchor{disable frame-filter all}
7321 @item disable frame-filter @var{filter-dictionary} @var{filter-name}
7322 Disable a frame filter in the dictionary matching
7323 @var{filter-dictionary} and @var{filter-name}. The
7324 @var{filter-dictionary} may be @code{all}, @code{global},
7325 @code{progspace}, or the name of the object file where the frame filter
7326 dictionary resides. When @code{all} is specified, all frame filters
7327 across all dictionaries are disabled. The @var{filter-name} is the name
7328 of the frame filter and is used when @code{all} is not the option for
7329 @var{filter-dictionary}. A disabled frame-filter is not deleted, it
7330 may be enabled again later.
7332 @kindex enable frame-filter
7333 @item enable frame-filter @var{filter-dictionary} @var{filter-name}
7334 Enable a frame filter in the dictionary matching
7335 @var{filter-dictionary} and @var{filter-name}. The
7336 @var{filter-dictionary} may be @code{all}, @code{global},
7337 @code{progspace} or the name of the object file where the frame filter
7338 dictionary resides. When @code{all} is specified, all frame filters across
7339 all dictionaries are enabled. The @var{filter-name} is the name of the frame
7340 filter and is used when @code{all} is not the option for
7341 @var{filter-dictionary}.
7346 (gdb) info frame-filter
7348 global frame-filters:
7349 Priority Enabled Name
7350 1000 No PrimaryFunctionFilter
7353 progspace /build/test frame-filters:
7354 Priority Enabled Name
7355 100 Yes ProgspaceFilter
7357 objfile /build/test frame-filters:
7358 Priority Enabled Name
7359 999 Yes BuildProgra Filter
7361 (gdb) disable frame-filter /build/test BuildProgramFilter
7362 (gdb) info frame-filter
7364 global frame-filters:
7365 Priority Enabled Name
7366 1000 No PrimaryFunctionFilter
7369 progspace /build/test frame-filters:
7370 Priority Enabled Name
7371 100 Yes ProgspaceFilter
7373 objfile /build/test frame-filters:
7374 Priority Enabled Name
7375 999 No BuildProgramFilter
7377 (gdb) enable frame-filter global PrimaryFunctionFilter
7378 (gdb) info frame-filter
7380 global frame-filters:
7381 Priority Enabled Name
7382 1000 Yes PrimaryFunctionFilter
7385 progspace /build/test frame-filters:
7386 Priority Enabled Name
7387 100 Yes ProgspaceFilter
7389 objfile /build/test frame-filters:
7390 Priority Enabled Name
7391 999 No BuildProgramFilter
7394 @kindex set frame-filter priority
7395 @item set frame-filter priority @var{filter-dictionary} @var{filter-name} @var{priority}
7396 Set the @var{priority} of a frame filter in the dictionary matching
7397 @var{filter-dictionary}, and the frame filter name matching
7398 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
7399 @code{progspace} or the name of the object file where the frame filter
7400 dictionary resides. The @var{priority} is an integer.
7402 @kindex show frame-filter priority
7403 @item show frame-filter priority @var{filter-dictionary} @var{filter-name}
7404 Show the @var{priority} of a frame filter in the dictionary matching
7405 @var{filter-dictionary}, and the frame filter name matching
7406 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
7407 @code{progspace} or the name of the object file where the frame filter
7413 (gdb) info frame-filter
7415 global frame-filters:
7416 Priority Enabled Name
7417 1000 Yes PrimaryFunctionFilter
7420 progspace /build/test frame-filters:
7421 Priority Enabled Name
7422 100 Yes ProgspaceFilter
7424 objfile /build/test frame-filters:
7425 Priority Enabled Name
7426 999 No BuildProgramFilter
7428 (gdb) set frame-filter priority global Reverse 50
7429 (gdb) info frame-filter
7431 global frame-filters:
7432 Priority Enabled Name
7433 1000 Yes PrimaryFunctionFilter
7436 progspace /build/test frame-filters:
7437 Priority Enabled Name
7438 100 Yes ProgspaceFilter
7440 objfile /build/test frame-filters:
7441 Priority Enabled Name
7442 999 No BuildProgramFilter
7447 @chapter Examining Source Files
7449 @value{GDBN} can print parts of your program's source, since the debugging
7450 information recorded in the program tells @value{GDBN} what source files were
7451 used to build it. When your program stops, @value{GDBN} spontaneously prints
7452 the line where it stopped. Likewise, when you select a stack frame
7453 (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where
7454 execution in that frame has stopped. You can print other portions of
7455 source files by explicit command.
7457 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
7458 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
7459 @value{GDBN} under @sc{gnu} Emacs}.
7462 * List:: Printing source lines
7463 * Specify Location:: How to specify code locations
7464 * Edit:: Editing source files
7465 * Search:: Searching source files
7466 * Source Path:: Specifying source directories
7467 * Machine Code:: Source and machine code
7471 @section Printing Source Lines
7474 @kindex l @r{(@code{list})}
7475 To print lines from a source file, use the @code{list} command
7476 (abbreviated @code{l}). By default, ten lines are printed.
7477 There are several ways to specify what part of the file you want to
7478 print; see @ref{Specify Location}, for the full list.
7480 Here are the forms of the @code{list} command most commonly used:
7483 @item list @var{linenum}
7484 Print lines centered around line number @var{linenum} in the
7485 current source file.
7487 @item list @var{function}
7488 Print lines centered around the beginning of function
7492 Print more lines. If the last lines printed were printed with a
7493 @code{list} command, this prints lines following the last lines
7494 printed; however, if the last line printed was a solitary line printed
7495 as part of displaying a stack frame (@pxref{Stack, ,Examining the
7496 Stack}), this prints lines centered around that line.
7499 Print lines just before the lines last printed.
7502 @cindex @code{list}, how many lines to display
7503 By default, @value{GDBN} prints ten source lines with any of these forms of
7504 the @code{list} command. You can change this using @code{set listsize}:
7507 @kindex set listsize
7508 @item set listsize @var{count}
7509 @itemx set listsize unlimited
7510 Make the @code{list} command display @var{count} source lines (unless
7511 the @code{list} argument explicitly specifies some other number).
7512 Setting @var{count} to @code{unlimited} or 0 means there's no limit.
7514 @kindex show listsize
7516 Display the number of lines that @code{list} prints.
7519 Repeating a @code{list} command with @key{RET} discards the argument,
7520 so it is equivalent to typing just @code{list}. This is more useful
7521 than listing the same lines again. An exception is made for an
7522 argument of @samp{-}; that argument is preserved in repetition so that
7523 each repetition moves up in the source file.
7525 In general, the @code{list} command expects you to supply zero, one or two
7526 @dfn{locations}. Locations specify source lines; there are several ways
7527 of writing them (@pxref{Specify Location}), but the effect is always
7528 to specify some source line.
7530 Here is a complete description of the possible arguments for @code{list}:
7533 @item list @var{location}
7534 Print lines centered around the line specified by @var{location}.
7536 @item list @var{first},@var{last}
7537 Print lines from @var{first} to @var{last}. Both arguments are
7538 locations. When a @code{list} command has two locations, and the
7539 source file of the second location is omitted, this refers to
7540 the same source file as the first location.
7542 @item list ,@var{last}
7543 Print lines ending with @var{last}.
7545 @item list @var{first},
7546 Print lines starting with @var{first}.
7549 Print lines just after the lines last printed.
7552 Print lines just before the lines last printed.
7555 As described in the preceding table.
7558 @node Specify Location
7559 @section Specifying a Location
7560 @cindex specifying location
7562 @cindex source location
7565 * Linespec Locations:: Linespec locations
7566 * Explicit Locations:: Explicit locations
7567 * Address Locations:: Address locations
7570 Several @value{GDBN} commands accept arguments that specify a location
7571 of your program's code. Since @value{GDBN} is a source-level
7572 debugger, a location usually specifies some line in the source code.
7573 Locations may be specified using three different formats:
7574 linespec locations, explicit locations, or address locations.
7576 @node Linespec Locations
7577 @subsection Linespec Locations
7578 @cindex linespec locations
7580 A @dfn{linespec} is a colon-separated list of source location parameters such
7581 as file name, function name, etc. Here are all the different ways of
7582 specifying a linespec:
7586 Specifies the line number @var{linenum} of the current source file.
7589 @itemx +@var{offset}
7590 Specifies the line @var{offset} lines before or after the @dfn{current
7591 line}. For the @code{list} command, the current line is the last one
7592 printed; for the breakpoint commands, this is the line at which
7593 execution stopped in the currently selected @dfn{stack frame}
7594 (@pxref{Frames, ,Frames}, for a description of stack frames.) When
7595 used as the second of the two linespecs in a @code{list} command,
7596 this specifies the line @var{offset} lines up or down from the first
7599 @item @var{filename}:@var{linenum}
7600 Specifies the line @var{linenum} in the source file @var{filename}.
7601 If @var{filename} is a relative file name, then it will match any
7602 source file name with the same trailing components. For example, if
7603 @var{filename} is @samp{gcc/expr.c}, then it will match source file
7604 name of @file{/build/trunk/gcc/expr.c}, but not
7605 @file{/build/trunk/libcpp/expr.c} or @file{/build/trunk/gcc/x-expr.c}.
7607 @item @var{function}
7608 Specifies the line that begins the body of the function @var{function}.
7609 For example, in C, this is the line with the open brace.
7611 @item @var{function}:@var{label}
7612 Specifies the line where @var{label} appears in @var{function}.
7614 @item @var{filename}:@var{function}
7615 Specifies the line that begins the body of the function @var{function}
7616 in the file @var{filename}. You only need the file name with a
7617 function name to avoid ambiguity when there are identically named
7618 functions in different source files.
7621 Specifies the line at which the label named @var{label} appears
7622 in the function corresponding to the currently selected stack frame.
7623 If there is no current selected stack frame (for instance, if the inferior
7624 is not running), then @value{GDBN} will not search for a label.
7626 @cindex breakpoint at static probe point
7627 @item -pstap|-probe-stap @r{[}@var{objfile}:@r{[}@var{provider}:@r{]}@r{]}@var{name}
7628 The @sc{gnu}/Linux tool @code{SystemTap} provides a way for
7629 applications to embed static probes. @xref{Static Probe Points}, for more
7630 information on finding and using static probes. This form of linespec
7631 specifies the location of such a static probe.
7633 If @var{objfile} is given, only probes coming from that shared library
7634 or executable matching @var{objfile} as a regular expression are considered.
7635 If @var{provider} is given, then only probes from that provider are considered.
7636 If several probes match the spec, @value{GDBN} will insert a breakpoint at
7637 each one of those probes.
7640 @node Explicit Locations
7641 @subsection Explicit Locations
7642 @cindex explicit locations
7644 @dfn{Explicit locations} allow the user to directly specify the source
7645 location's parameters using option-value pairs.
7647 Explicit locations are useful when several functions, labels, or
7648 file names have the same name (base name for files) in the program's
7649 sources. In these cases, explicit locations point to the source
7650 line you meant more accurately and unambiguously. Also, using
7651 explicit locations might be faster in large programs.
7653 For example, the linespec @samp{foo:bar} may refer to a function @code{bar}
7654 defined in the file named @file{foo} or the label @code{bar} in a function
7655 named @code{foo}. @value{GDBN} must search either the file system or
7656 the symbol table to know.
7658 The list of valid explicit location options is summarized in the
7662 @item -source @var{filename}
7663 The value specifies the source file name. To differentiate between
7664 files with the same base name, prepend as many directories as is necessary
7665 to uniquely identify the desired file, e.g., @file{foo/bar/baz.c}. Otherwise
7666 @value{GDBN} will use the first file it finds with the given base
7667 name. This option requires the use of either @code{-function} or @code{-line}.
7669 @item -function @var{function}
7670 The value specifies the name of a function. Operations
7671 on function locations unmodified by other options (such as @code{-label}
7672 or @code{-line}) refer to the line that begins the body of the function.
7673 In C, for example, this is the line with the open brace.
7675 @item -label @var{label}
7676 The value specifies the name of a label. When the function
7677 name is not specified, the label is searched in the function of the currently
7678 selected stack frame.
7680 @item -line @var{number}
7681 The value specifies a line offset for the location. The offset may either
7682 be absolute (@code{-line 3}) or relative (@code{-line +3}), depending on
7683 the command. When specified without any other options, the line offset is
7684 relative to the current line.
7687 Explicit location options may be abbreviated by omitting any non-unique
7688 trailing characters from the option name, e.g., @code{break -s main.c -li 3}.
7690 @node Address Locations
7691 @subsection Address Locations
7692 @cindex address locations
7694 @dfn{Address locations} indicate a specific program address. They have
7695 the generalized form *@var{address}.
7697 For line-oriented commands, such as @code{list} and @code{edit}, this
7698 specifies a source line that contains @var{address}. For @code{break} and
7699 other breakpoint-oriented commands, this can be used to set breakpoints in
7700 parts of your program which do not have debugging information or
7703 Here @var{address} may be any expression valid in the current working
7704 language (@pxref{Languages, working language}) that specifies a code
7705 address. In addition, as a convenience, @value{GDBN} extends the
7706 semantics of expressions used in locations to cover several situations
7707 that frequently occur during debugging. Here are the various forms
7711 @item @var{expression}
7712 Any expression valid in the current working language.
7714 @item @var{funcaddr}
7715 An address of a function or procedure derived from its name. In C,
7716 C@t{++}, Java, Objective-C, Fortran, minimal, and assembly, this is
7717 simply the function's name @var{function} (and actually a special case
7718 of a valid expression). In Pascal and Modula-2, this is
7719 @code{&@var{function}}. In Ada, this is @code{@var{function}'Address}
7720 (although the Pascal form also works).
7722 This form specifies the address of the function's first instruction,
7723 before the stack frame and arguments have been set up.
7725 @item '@var{filename}':@var{funcaddr}
7726 Like @var{funcaddr} above, but also specifies the name of the source
7727 file explicitly. This is useful if the name of the function does not
7728 specify the function unambiguously, e.g., if there are several
7729 functions with identical names in different source files.
7733 @section Editing Source Files
7734 @cindex editing source files
7737 @kindex e @r{(@code{edit})}
7738 To edit the lines in a source file, use the @code{edit} command.
7739 The editing program of your choice
7740 is invoked with the current line set to
7741 the active line in the program.
7742 Alternatively, there are several ways to specify what part of the file you
7743 want to print if you want to see other parts of the program:
7746 @item edit @var{location}
7747 Edit the source file specified by @code{location}. Editing starts at
7748 that @var{location}, e.g., at the specified source line of the
7749 specified file. @xref{Specify Location}, for all the possible forms
7750 of the @var{location} argument; here are the forms of the @code{edit}
7751 command most commonly used:
7754 @item edit @var{number}
7755 Edit the current source file with @var{number} as the active line number.
7757 @item edit @var{function}
7758 Edit the file containing @var{function} at the beginning of its definition.
7763 @subsection Choosing your Editor
7764 You can customize @value{GDBN} to use any editor you want
7766 The only restriction is that your editor (say @code{ex}), recognizes the
7767 following command-line syntax:
7769 ex +@var{number} file
7771 The optional numeric value +@var{number} specifies the number of the line in
7772 the file where to start editing.}.
7773 By default, it is @file{@value{EDITOR}}, but you can change this
7774 by setting the environment variable @code{EDITOR} before using
7775 @value{GDBN}. For example, to configure @value{GDBN} to use the
7776 @code{vi} editor, you could use these commands with the @code{sh} shell:
7782 or in the @code{csh} shell,
7784 setenv EDITOR /usr/bin/vi
7789 @section Searching Source Files
7790 @cindex searching source files
7792 There are two commands for searching through the current source file for a
7797 @kindex forward-search
7798 @kindex fo @r{(@code{forward-search})}
7799 @item forward-search @var{regexp}
7800 @itemx search @var{regexp}
7801 The command @samp{forward-search @var{regexp}} checks each line,
7802 starting with the one following the last line listed, for a match for
7803 @var{regexp}. It lists the line that is found. You can use the
7804 synonym @samp{search @var{regexp}} or abbreviate the command name as
7807 @kindex reverse-search
7808 @item reverse-search @var{regexp}
7809 The command @samp{reverse-search @var{regexp}} checks each line, starting
7810 with the one before the last line listed and going backward, for a match
7811 for @var{regexp}. It lists the line that is found. You can abbreviate
7812 this command as @code{rev}.
7816 @section Specifying Source Directories
7819 @cindex directories for source files
7820 Executable programs sometimes do not record the directories of the source
7821 files from which they were compiled, just the names. Even when they do,
7822 the directories could be moved between the compilation and your debugging
7823 session. @value{GDBN} has a list of directories to search for source files;
7824 this is called the @dfn{source path}. Each time @value{GDBN} wants a source file,
7825 it tries all the directories in the list, in the order they are present
7826 in the list, until it finds a file with the desired name.
7828 For example, suppose an executable references the file
7829 @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is
7830 @file{/mnt/cross}. The file is first looked up literally; if this
7831 fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this
7832 fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error
7833 message is printed. @value{GDBN} does not look up the parts of the
7834 source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}.
7835 Likewise, the subdirectories of the source path are not searched: if
7836 the source path is @file{/mnt/cross}, and the binary refers to
7837 @file{foo.c}, @value{GDBN} would not find it under
7838 @file{/mnt/cross/usr/src/foo-1.0/lib}.
7840 Plain file names, relative file names with leading directories, file
7841 names containing dots, etc.@: are all treated as described above; for
7842 instance, if the source path is @file{/mnt/cross}, and the source file
7843 is recorded as @file{../lib/foo.c}, @value{GDBN} would first try
7844 @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after
7845 that---@file{/mnt/cross/foo.c}.
7847 Note that the executable search path is @emph{not} used to locate the
7850 Whenever you reset or rearrange the source path, @value{GDBN} clears out
7851 any information it has cached about where source files are found and where
7852 each line is in the file.
7856 When you start @value{GDBN}, its source path includes only @samp{cdir}
7857 and @samp{cwd}, in that order.
7858 To add other directories, use the @code{directory} command.
7860 The search path is used to find both program source files and @value{GDBN}
7861 script files (read using the @samp{-command} option and @samp{source} command).
7863 In addition to the source path, @value{GDBN} provides a set of commands
7864 that manage a list of source path substitution rules. A @dfn{substitution
7865 rule} specifies how to rewrite source directories stored in the program's
7866 debug information in case the sources were moved to a different
7867 directory between compilation and debugging. A rule is made of
7868 two strings, the first specifying what needs to be rewritten in
7869 the path, and the second specifying how it should be rewritten.
7870 In @ref{set substitute-path}, we name these two parts @var{from} and
7871 @var{to} respectively. @value{GDBN} does a simple string replacement
7872 of @var{from} with @var{to} at the start of the directory part of the
7873 source file name, and uses that result instead of the original file
7874 name to look up the sources.
7876 Using the previous example, suppose the @file{foo-1.0} tree has been
7877 moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell
7878 @value{GDBN} to replace @file{/usr/src} in all source path names with
7879 @file{/mnt/cross}. The first lookup will then be
7880 @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location
7881 of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path
7882 substitution rule, use the @code{set substitute-path} command
7883 (@pxref{set substitute-path}).
7885 To avoid unexpected substitution results, a rule is applied only if the
7886 @var{from} part of the directory name ends at a directory separator.
7887 For instance, a rule substituting @file{/usr/source} into
7888 @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but
7889 not to @file{/usr/sourceware/foo-2.0}. And because the substitution
7890 is applied only at the beginning of the directory name, this rule will
7891 not be applied to @file{/root/usr/source/baz.c} either.
7893 In many cases, you can achieve the same result using the @code{directory}
7894 command. However, @code{set substitute-path} can be more efficient in
7895 the case where the sources are organized in a complex tree with multiple
7896 subdirectories. With the @code{directory} command, you need to add each
7897 subdirectory of your project. If you moved the entire tree while
7898 preserving its internal organization, then @code{set substitute-path}
7899 allows you to direct the debugger to all the sources with one single
7902 @code{set substitute-path} is also more than just a shortcut command.
7903 The source path is only used if the file at the original location no
7904 longer exists. On the other hand, @code{set substitute-path} modifies
7905 the debugger behavior to look at the rewritten location instead. So, if
7906 for any reason a source file that is not relevant to your executable is
7907 located at the original location, a substitution rule is the only
7908 method available to point @value{GDBN} at the new location.
7910 @cindex @samp{--with-relocated-sources}
7911 @cindex default source path substitution
7912 You can configure a default source path substitution rule by
7913 configuring @value{GDBN} with the
7914 @samp{--with-relocated-sources=@var{dir}} option. The @var{dir}
7915 should be the name of a directory under @value{GDBN}'s configured
7916 prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and
7917 directory names in debug information under @var{dir} will be adjusted
7918 automatically if the installed @value{GDBN} is moved to a new
7919 location. This is useful if @value{GDBN}, libraries or executables
7920 with debug information and corresponding source code are being moved
7924 @item directory @var{dirname} @dots{}
7925 @item dir @var{dirname} @dots{}
7926 Add directory @var{dirname} to the front of the source path. Several
7927 directory names may be given to this command, separated by @samp{:}
7928 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
7929 part of absolute file names) or
7930 whitespace. You may specify a directory that is already in the source
7931 path; this moves it forward, so @value{GDBN} searches it sooner.
7935 @vindex $cdir@r{, convenience variable}
7936 @vindex $cwd@r{, convenience variable}
7937 @cindex compilation directory
7938 @cindex current directory
7939 @cindex working directory
7940 @cindex directory, current
7941 @cindex directory, compilation
7942 You can use the string @samp{$cdir} to refer to the compilation
7943 directory (if one is recorded), and @samp{$cwd} to refer to the current
7944 working directory. @samp{$cwd} is not the same as @samp{.}---the former
7945 tracks the current working directory as it changes during your @value{GDBN}
7946 session, while the latter is immediately expanded to the current
7947 directory at the time you add an entry to the source path.
7950 Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation.
7952 @c RET-repeat for @code{directory} is explicitly disabled, but since
7953 @c repeating it would be a no-op we do not say that. (thanks to RMS)
7955 @item set directories @var{path-list}
7956 @kindex set directories
7957 Set the source path to @var{path-list}.
7958 @samp{$cdir:$cwd} are added if missing.
7960 @item show directories
7961 @kindex show directories
7962 Print the source path: show which directories it contains.
7964 @anchor{set substitute-path}
7965 @item set substitute-path @var{from} @var{to}
7966 @kindex set substitute-path
7967 Define a source path substitution rule, and add it at the end of the
7968 current list of existing substitution rules. If a rule with the same
7969 @var{from} was already defined, then the old rule is also deleted.
7971 For example, if the file @file{/foo/bar/baz.c} was moved to
7972 @file{/mnt/cross/baz.c}, then the command
7975 (@value{GDBP}) set substitute-path /foo/bar /mnt/cross
7979 will tell @value{GDBN} to replace @samp{/foo/bar} with
7980 @samp{/mnt/cross}, which will allow @value{GDBN} to find the file
7981 @file{baz.c} even though it was moved.
7983 In the case when more than one substitution rule have been defined,
7984 the rules are evaluated one by one in the order where they have been
7985 defined. The first one matching, if any, is selected to perform
7988 For instance, if we had entered the following commands:
7991 (@value{GDBP}) set substitute-path /usr/src/include /mnt/include
7992 (@value{GDBP}) set substitute-path /usr/src /mnt/src
7996 @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into
7997 @file{/mnt/include/defs.h} by using the first rule. However, it would
7998 use the second rule to rewrite @file{/usr/src/lib/foo.c} into
7999 @file{/mnt/src/lib/foo.c}.
8002 @item unset substitute-path [path]
8003 @kindex unset substitute-path
8004 If a path is specified, search the current list of substitution rules
8005 for a rule that would rewrite that path. Delete that rule if found.
8006 A warning is emitted by the debugger if no rule could be found.
8008 If no path is specified, then all substitution rules are deleted.
8010 @item show substitute-path [path]
8011 @kindex show substitute-path
8012 If a path is specified, then print the source path substitution rule
8013 which would rewrite that path, if any.
8015 If no path is specified, then print all existing source path substitution
8020 If your source path is cluttered with directories that are no longer of
8021 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
8022 versions of source. You can correct the situation as follows:
8026 Use @code{directory} with no argument to reset the source path to its default value.
8029 Use @code{directory} with suitable arguments to reinstall the
8030 directories you want in the source path. You can add all the
8031 directories in one command.
8035 @section Source and Machine Code
8036 @cindex source line and its code address
8038 You can use the command @code{info line} to map source lines to program
8039 addresses (and vice versa), and the command @code{disassemble} to display
8040 a range of addresses as machine instructions. You can use the command
8041 @code{set disassemble-next-line} to set whether to disassemble next
8042 source line when execution stops. When run under @sc{gnu} Emacs
8043 mode, the @code{info line} command causes the arrow to point to the
8044 line specified. Also, @code{info line} prints addresses in symbolic form as
8049 @item info line @var{location}
8050 Print the starting and ending addresses of the compiled code for
8051 source line @var{location}. You can specify source lines in any of
8052 the ways documented in @ref{Specify Location}.
8055 For example, we can use @code{info line} to discover the location of
8056 the object code for the first line of function
8057 @code{m4_changequote}:
8059 @c FIXME: I think this example should also show the addresses in
8060 @c symbolic form, as they usually would be displayed.
8062 (@value{GDBP}) info line m4_changequote
8063 Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
8067 @cindex code address and its source line
8068 We can also inquire (using @code{*@var{addr}} as the form for
8069 @var{location}) what source line covers a particular address:
8071 (@value{GDBP}) info line *0x63ff
8072 Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
8075 @cindex @code{$_} and @code{info line}
8076 @cindex @code{x} command, default address
8077 @kindex x@r{(examine), and} info line
8078 After @code{info line}, the default address for the @code{x} command
8079 is changed to the starting address of the line, so that @samp{x/i} is
8080 sufficient to begin examining the machine code (@pxref{Memory,
8081 ,Examining Memory}). Also, this address is saved as the value of the
8082 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
8087 @cindex assembly instructions
8088 @cindex instructions, assembly
8089 @cindex machine instructions
8090 @cindex listing machine instructions
8092 @itemx disassemble /m
8093 @itemx disassemble /s
8094 @itemx disassemble /r
8095 This specialized command dumps a range of memory as machine
8096 instructions. It can also print mixed source+disassembly by specifying
8097 the @code{/m} or @code{/s} modifier and print the raw instructions in hex
8098 as well as in symbolic form by specifying the @code{/r} modifier.
8099 The default memory range is the function surrounding the
8100 program counter of the selected frame. A single argument to this
8101 command is a program counter value; @value{GDBN} dumps the function
8102 surrounding this value. When two arguments are given, they should
8103 be separated by a comma, possibly surrounded by whitespace. The
8104 arguments specify a range of addresses to dump, in one of two forms:
8107 @item @var{start},@var{end}
8108 the addresses from @var{start} (inclusive) to @var{end} (exclusive)
8109 @item @var{start},+@var{length}
8110 the addresses from @var{start} (inclusive) to
8111 @code{@var{start}+@var{length}} (exclusive).
8115 When 2 arguments are specified, the name of the function is also
8116 printed (since there could be several functions in the given range).
8118 The argument(s) can be any expression yielding a numeric value, such as
8119 @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}.
8121 If the range of memory being disassembled contains current program counter,
8122 the instruction at that location is shown with a @code{=>} marker.
8125 The following example shows the disassembly of a range of addresses of
8126 HP PA-RISC 2.0 code:
8129 (@value{GDBP}) disas 0x32c4, 0x32e4
8130 Dump of assembler code from 0x32c4 to 0x32e4:
8131 0x32c4 <main+204>: addil 0,dp
8132 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26
8133 0x32cc <main+212>: ldil 0x3000,r31
8134 0x32d0 <main+216>: ble 0x3f8(sr4,r31)
8135 0x32d4 <main+220>: ldo 0(r31),rp
8136 0x32d8 <main+224>: addil -0x800,dp
8137 0x32dc <main+228>: ldo 0x588(r1),r26
8138 0x32e0 <main+232>: ldil 0x3000,r31
8139 End of assembler dump.
8142 Here is an example showing mixed source+assembly for Intel x86
8143 with @code{/m} or @code{/s}, when the program is stopped just after
8144 function prologue in a non-optimized function with no inline code.
8147 (@value{GDBP}) disas /m main
8148 Dump of assembler code for function main:
8150 0x08048330 <+0>: push %ebp
8151 0x08048331 <+1>: mov %esp,%ebp
8152 0x08048333 <+3>: sub $0x8,%esp
8153 0x08048336 <+6>: and $0xfffffff0,%esp
8154 0x08048339 <+9>: sub $0x10,%esp
8156 6 printf ("Hello.\n");
8157 => 0x0804833c <+12>: movl $0x8048440,(%esp)
8158 0x08048343 <+19>: call 0x8048284 <puts@@plt>
8162 0x08048348 <+24>: mov $0x0,%eax
8163 0x0804834d <+29>: leave
8164 0x0804834e <+30>: ret
8166 End of assembler dump.
8169 The @code{/m} option is deprecated as its output is not useful when
8170 there is either inlined code or re-ordered code.
8171 The @code{/s} option is the preferred choice.
8172 Here is an example for AMD x86-64 showing the difference between
8173 @code{/m} output and @code{/s} output.
8174 This example has one inline function defined in a header file,
8175 and the code is compiled with @samp{-O2} optimization.
8176 Note how the @code{/m} output is missing the disassembly of
8177 several instructions that are present in the @code{/s} output.
8207 (@value{GDBP}) disas /m main
8208 Dump of assembler code for function main:
8212 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
8213 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
8217 0x000000000040041d <+29>: xor %eax,%eax
8218 0x000000000040041f <+31>: retq
8219 0x0000000000400420 <+32>: add %eax,%eax
8220 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
8222 End of assembler dump.
8223 (@value{GDBP}) disas /s main
8224 Dump of assembler code for function main:
8228 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
8232 0x0000000000400406 <+6>: test %eax,%eax
8233 0x0000000000400408 <+8>: js 0x400420 <main+32>
8238 0x000000000040040a <+10>: lea 0xa(%rax),%edx
8239 0x000000000040040d <+13>: test %eax,%eax
8240 0x000000000040040f <+15>: mov $0x1,%eax
8241 0x0000000000400414 <+20>: cmovne %edx,%eax
8245 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
8249 0x000000000040041d <+29>: xor %eax,%eax
8250 0x000000000040041f <+31>: retq
8254 0x0000000000400420 <+32>: add %eax,%eax
8255 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
8256 End of assembler dump.
8259 Here is another example showing raw instructions in hex for AMD x86-64,
8262 (gdb) disas /r 0x400281,+10
8263 Dump of assembler code from 0x400281 to 0x40028b:
8264 0x0000000000400281: 38 36 cmp %dh,(%rsi)
8265 0x0000000000400283: 2d 36 34 2e 73 sub $0x732e3436,%eax
8266 0x0000000000400288: 6f outsl %ds:(%rsi),(%dx)
8267 0x0000000000400289: 2e 32 00 xor %cs:(%rax),%al
8268 End of assembler dump.
8271 Addresses cannot be specified as a location (@pxref{Specify Location}).
8272 So, for example, if you want to disassemble function @code{bar}
8273 in file @file{foo.c}, you must type @samp{disassemble 'foo.c'::bar}
8274 and not @samp{disassemble foo.c:bar}.
8276 Some architectures have more than one commonly-used set of instruction
8277 mnemonics or other syntax.
8279 For programs that were dynamically linked and use shared libraries,
8280 instructions that call functions or branch to locations in the shared
8281 libraries might show a seemingly bogus location---it's actually a
8282 location of the relocation table. On some architectures, @value{GDBN}
8283 might be able to resolve these to actual function names.
8286 @kindex set disassembly-flavor
8287 @cindex Intel disassembly flavor
8288 @cindex AT&T disassembly flavor
8289 @item set disassembly-flavor @var{instruction-set}
8290 Select the instruction set to use when disassembling the
8291 program via the @code{disassemble} or @code{x/i} commands.
8293 Currently this command is only defined for the Intel x86 family. You
8294 can set @var{instruction-set} to either @code{intel} or @code{att}.
8295 The default is @code{att}, the AT&T flavor used by default by Unix
8296 assemblers for x86-based targets.
8298 @kindex show disassembly-flavor
8299 @item show disassembly-flavor
8300 Show the current setting of the disassembly flavor.
8304 @kindex set disassemble-next-line
8305 @kindex show disassemble-next-line
8306 @item set disassemble-next-line
8307 @itemx show disassemble-next-line
8308 Control whether or not @value{GDBN} will disassemble the next source
8309 line or instruction when execution stops. If ON, @value{GDBN} will
8310 display disassembly of the next source line when execution of the
8311 program being debugged stops. This is @emph{in addition} to
8312 displaying the source line itself, which @value{GDBN} always does if
8313 possible. If the next source line cannot be displayed for some reason
8314 (e.g., if @value{GDBN} cannot find the source file, or there's no line
8315 info in the debug info), @value{GDBN} will display disassembly of the
8316 next @emph{instruction} instead of showing the next source line. If
8317 AUTO, @value{GDBN} will display disassembly of next instruction only
8318 if the source line cannot be displayed. This setting causes
8319 @value{GDBN} to display some feedback when you step through a function
8320 with no line info or whose source file is unavailable. The default is
8321 OFF, which means never display the disassembly of the next line or
8327 @chapter Examining Data
8329 @cindex printing data
8330 @cindex examining data
8333 The usual way to examine data in your program is with the @code{print}
8334 command (abbreviated @code{p}), or its synonym @code{inspect}. It
8335 evaluates and prints the value of an expression of the language your
8336 program is written in (@pxref{Languages, ,Using @value{GDBN} with
8337 Different Languages}). It may also print the expression using a
8338 Python-based pretty-printer (@pxref{Pretty Printing}).
8341 @item print @var{expr}
8342 @itemx print /@var{f} @var{expr}
8343 @var{expr} is an expression (in the source language). By default the
8344 value of @var{expr} is printed in a format appropriate to its data type;
8345 you can choose a different format by specifying @samp{/@var{f}}, where
8346 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
8350 @itemx print /@var{f}
8351 @cindex reprint the last value
8352 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
8353 @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to
8354 conveniently inspect the same value in an alternative format.
8357 A more low-level way of examining data is with the @code{x} command.
8358 It examines data in memory at a specified address and prints it in a
8359 specified format. @xref{Memory, ,Examining Memory}.
8361 If you are interested in information about types, or about how the
8362 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
8363 command rather than @code{print}. @xref{Symbols, ,Examining the Symbol
8366 @cindex exploring hierarchical data structures
8368 Another way of examining values of expressions and type information is
8369 through the Python extension command @code{explore} (available only if
8370 the @value{GDBN} build is configured with @code{--with-python}). It
8371 offers an interactive way to start at the highest level (or, the most
8372 abstract level) of the data type of an expression (or, the data type
8373 itself) and explore all the way down to leaf scalar values/fields
8374 embedded in the higher level data types.
8377 @item explore @var{arg}
8378 @var{arg} is either an expression (in the source language), or a type
8379 visible in the current context of the program being debugged.
8382 The working of the @code{explore} command can be illustrated with an
8383 example. If a data type @code{struct ComplexStruct} is defined in your
8393 struct ComplexStruct
8395 struct SimpleStruct *ss_p;
8401 followed by variable declarations as
8404 struct SimpleStruct ss = @{ 10, 1.11 @};
8405 struct ComplexStruct cs = @{ &ss, @{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 @} @};
8409 then, the value of the variable @code{cs} can be explored using the
8410 @code{explore} command as follows.
8414 The value of `cs' is a struct/class of type `struct ComplexStruct' with
8415 the following fields:
8417 ss_p = <Enter 0 to explore this field of type `struct SimpleStruct *'>
8418 arr = <Enter 1 to explore this field of type `int [10]'>
8420 Enter the field number of choice:
8424 Since the fields of @code{cs} are not scalar values, you are being
8425 prompted to chose the field you want to explore. Let's say you choose
8426 the field @code{ss_p} by entering @code{0}. Then, since this field is a
8427 pointer, you will be asked if it is pointing to a single value. From
8428 the declaration of @code{cs} above, it is indeed pointing to a single
8429 value, hence you enter @code{y}. If you enter @code{n}, then you will
8430 be asked if it were pointing to an array of values, in which case this
8431 field will be explored as if it were an array.
8434 `cs.ss_p' is a pointer to a value of type `struct SimpleStruct'
8435 Continue exploring it as a pointer to a single value [y/n]: y
8436 The value of `*(cs.ss_p)' is a struct/class of type `struct
8437 SimpleStruct' with the following fields:
8439 i = 10 .. (Value of type `int')
8440 d = 1.1100000000000001 .. (Value of type `double')
8442 Press enter to return to parent value:
8446 If the field @code{arr} of @code{cs} was chosen for exploration by
8447 entering @code{1} earlier, then since it is as array, you will be
8448 prompted to enter the index of the element in the array that you want
8452 `cs.arr' is an array of `int'.
8453 Enter the index of the element you want to explore in `cs.arr': 5
8455 `(cs.arr)[5]' is a scalar value of type `int'.
8459 Press enter to return to parent value:
8462 In general, at any stage of exploration, you can go deeper towards the
8463 leaf values by responding to the prompts appropriately, or hit the
8464 return key to return to the enclosing data structure (the @i{higher}
8465 level data structure).
8467 Similar to exploring values, you can use the @code{explore} command to
8468 explore types. Instead of specifying a value (which is typically a
8469 variable name or an expression valid in the current context of the
8470 program being debugged), you specify a type name. If you consider the
8471 same example as above, your can explore the type
8472 @code{struct ComplexStruct} by passing the argument
8473 @code{struct ComplexStruct} to the @code{explore} command.
8476 (gdb) explore struct ComplexStruct
8480 By responding to the prompts appropriately in the subsequent interactive
8481 session, you can explore the type @code{struct ComplexStruct} in a
8482 manner similar to how the value @code{cs} was explored in the above
8485 The @code{explore} command also has two sub-commands,
8486 @code{explore value} and @code{explore type}. The former sub-command is
8487 a way to explicitly specify that value exploration of the argument is
8488 being invoked, while the latter is a way to explicitly specify that type
8489 exploration of the argument is being invoked.
8492 @item explore value @var{expr}
8493 @cindex explore value
8494 This sub-command of @code{explore} explores the value of the
8495 expression @var{expr} (if @var{expr} is an expression valid in the
8496 current context of the program being debugged). The behavior of this
8497 command is identical to that of the behavior of the @code{explore}
8498 command being passed the argument @var{expr}.
8500 @item explore type @var{arg}
8501 @cindex explore type
8502 This sub-command of @code{explore} explores the type of @var{arg} (if
8503 @var{arg} is a type visible in the current context of program being
8504 debugged), or the type of the value/expression @var{arg} (if @var{arg}
8505 is an expression valid in the current context of the program being
8506 debugged). If @var{arg} is a type, then the behavior of this command is
8507 identical to that of the @code{explore} command being passed the
8508 argument @var{arg}. If @var{arg} is an expression, then the behavior of
8509 this command will be identical to that of the @code{explore} command
8510 being passed the type of @var{arg} as the argument.
8514 * Expressions:: Expressions
8515 * Ambiguous Expressions:: Ambiguous Expressions
8516 * Variables:: Program variables
8517 * Arrays:: Artificial arrays
8518 * Output Formats:: Output formats
8519 * Memory:: Examining memory
8520 * Auto Display:: Automatic display
8521 * Print Settings:: Print settings
8522 * Pretty Printing:: Python pretty printing
8523 * Value History:: Value history
8524 * Convenience Vars:: Convenience variables
8525 * Convenience Funs:: Convenience functions
8526 * Registers:: Registers
8527 * Floating Point Hardware:: Floating point hardware
8528 * Vector Unit:: Vector Unit
8529 * OS Information:: Auxiliary data provided by operating system
8530 * Memory Region Attributes:: Memory region attributes
8531 * Dump/Restore Files:: Copy between memory and a file
8532 * Core File Generation:: Cause a program dump its core
8533 * Character Sets:: Debugging programs that use a different
8534 character set than GDB does
8535 * Caching Target Data:: Data caching for targets
8536 * Searching Memory:: Searching memory for a sequence of bytes
8540 @section Expressions
8543 @code{print} and many other @value{GDBN} commands accept an expression and
8544 compute its value. Any kind of constant, variable or operator defined
8545 by the programming language you are using is valid in an expression in
8546 @value{GDBN}. This includes conditional expressions, function calls,
8547 casts, and string constants. It also includes preprocessor macros, if
8548 you compiled your program to include this information; see
8551 @cindex arrays in expressions
8552 @value{GDBN} supports array constants in expressions input by
8553 the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example,
8554 you can use the command @code{print @{1, 2, 3@}} to create an array
8555 of three integers. If you pass an array to a function or assign it
8556 to a program variable, @value{GDBN} copies the array to memory that
8557 is @code{malloc}ed in the target program.
8559 Because C is so widespread, most of the expressions shown in examples in
8560 this manual are in C. @xref{Languages, , Using @value{GDBN} with Different
8561 Languages}, for information on how to use expressions in other
8564 In this section, we discuss operators that you can use in @value{GDBN}
8565 expressions regardless of your programming language.
8567 @cindex casts, in expressions
8568 Casts are supported in all languages, not just in C, because it is so
8569 useful to cast a number into a pointer in order to examine a structure
8570 at that address in memory.
8571 @c FIXME: casts supported---Mod2 true?
8573 @value{GDBN} supports these operators, in addition to those common
8574 to programming languages:
8578 @samp{@@} is a binary operator for treating parts of memory as arrays.
8579 @xref{Arrays, ,Artificial Arrays}, for more information.
8582 @samp{::} allows you to specify a variable in terms of the file or
8583 function where it is defined. @xref{Variables, ,Program Variables}.
8585 @cindex @{@var{type}@}
8586 @cindex type casting memory
8587 @cindex memory, viewing as typed object
8588 @cindex casts, to view memory
8589 @item @{@var{type}@} @var{addr}
8590 Refers to an object of type @var{type} stored at address @var{addr} in
8591 memory. The address @var{addr} may be any expression whose value is
8592 an integer or pointer (but parentheses are required around binary
8593 operators, just as in a cast). This construct is allowed regardless
8594 of what kind of data is normally supposed to reside at @var{addr}.
8597 @node Ambiguous Expressions
8598 @section Ambiguous Expressions
8599 @cindex ambiguous expressions
8601 Expressions can sometimes contain some ambiguous elements. For instance,
8602 some programming languages (notably Ada, C@t{++} and Objective-C) permit
8603 a single function name to be defined several times, for application in
8604 different contexts. This is called @dfn{overloading}. Another example
8605 involving Ada is generics. A @dfn{generic package} is similar to C@t{++}
8606 templates and is typically instantiated several times, resulting in
8607 the same function name being defined in different contexts.
8609 In some cases and depending on the language, it is possible to adjust
8610 the expression to remove the ambiguity. For instance in C@t{++}, you
8611 can specify the signature of the function you want to break on, as in
8612 @kbd{break @var{function}(@var{types})}. In Ada, using the fully
8613 qualified name of your function often makes the expression unambiguous
8616 When an ambiguity that needs to be resolved is detected, the debugger
8617 has the capability to display a menu of numbered choices for each
8618 possibility, and then waits for the selection with the prompt @samp{>}.
8619 The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}}
8620 aborts the current command. If the command in which the expression was
8621 used allows more than one choice to be selected, the next option in the
8622 menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible
8625 For example, the following session excerpt shows an attempt to set a
8626 breakpoint at the overloaded symbol @code{String::after}.
8627 We choose three particular definitions of that function name:
8629 @c FIXME! This is likely to change to show arg type lists, at least
8632 (@value{GDBP}) b String::after
8635 [2] file:String.cc; line number:867
8636 [3] file:String.cc; line number:860
8637 [4] file:String.cc; line number:875
8638 [5] file:String.cc; line number:853
8639 [6] file:String.cc; line number:846
8640 [7] file:String.cc; line number:735
8642 Breakpoint 1 at 0xb26c: file String.cc, line 867.
8643 Breakpoint 2 at 0xb344: file String.cc, line 875.
8644 Breakpoint 3 at 0xafcc: file String.cc, line 846.
8645 Multiple breakpoints were set.
8646 Use the "delete" command to delete unwanted
8653 @kindex set multiple-symbols
8654 @item set multiple-symbols @var{mode}
8655 @cindex multiple-symbols menu
8657 This option allows you to adjust the debugger behavior when an expression
8660 By default, @var{mode} is set to @code{all}. If the command with which
8661 the expression is used allows more than one choice, then @value{GDBN}
8662 automatically selects all possible choices. For instance, inserting
8663 a breakpoint on a function using an ambiguous name results in a breakpoint
8664 inserted on each possible match. However, if a unique choice must be made,
8665 then @value{GDBN} uses the menu to help you disambiguate the expression.
8666 For instance, printing the address of an overloaded function will result
8667 in the use of the menu.
8669 When @var{mode} is set to @code{ask}, the debugger always uses the menu
8670 when an ambiguity is detected.
8672 Finally, when @var{mode} is set to @code{cancel}, the debugger reports
8673 an error due to the ambiguity and the command is aborted.
8675 @kindex show multiple-symbols
8676 @item show multiple-symbols
8677 Show the current value of the @code{multiple-symbols} setting.
8681 @section Program Variables
8683 The most common kind of expression to use is the name of a variable
8686 Variables in expressions are understood in the selected stack frame
8687 (@pxref{Selection, ,Selecting a Frame}); they must be either:
8691 global (or file-static)
8698 visible according to the scope rules of the
8699 programming language from the point of execution in that frame
8702 @noindent This means that in the function
8717 you can examine and use the variable @code{a} whenever your program is
8718 executing within the function @code{foo}, but you can only use or
8719 examine the variable @code{b} while your program is executing inside
8720 the block where @code{b} is declared.
8722 @cindex variable name conflict
8723 There is an exception: you can refer to a variable or function whose
8724 scope is a single source file even if the current execution point is not
8725 in this file. But it is possible to have more than one such variable or
8726 function with the same name (in different source files). If that
8727 happens, referring to that name has unpredictable effects. If you wish,
8728 you can specify a static variable in a particular function or file by
8729 using the colon-colon (@code{::}) notation:
8731 @cindex colon-colon, context for variables/functions
8733 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
8734 @cindex @code{::}, context for variables/functions
8737 @var{file}::@var{variable}
8738 @var{function}::@var{variable}
8742 Here @var{file} or @var{function} is the name of the context for the
8743 static @var{variable}. In the case of file names, you can use quotes to
8744 make sure @value{GDBN} parses the file name as a single word---for example,
8745 to print a global value of @code{x} defined in @file{f2.c}:
8748 (@value{GDBP}) p 'f2.c'::x
8751 The @code{::} notation is normally used for referring to
8752 static variables, since you typically disambiguate uses of local variables
8753 in functions by selecting the appropriate frame and using the
8754 simple name of the variable. However, you may also use this notation
8755 to refer to local variables in frames enclosing the selected frame:
8764 process (a); /* Stop here */
8775 For example, if there is a breakpoint at the commented line,
8776 here is what you might see
8777 when the program stops after executing the call @code{bar(0)}:
8782 (@value{GDBP}) p bar::a
8785 #2 0x080483d0 in foo (a=5) at foobar.c:12
8788 (@value{GDBP}) p bar::a
8792 @cindex C@t{++} scope resolution
8793 These uses of @samp{::} are very rarely in conflict with the very
8794 similar use of the same notation in C@t{++}. When they are in
8795 conflict, the C@t{++} meaning takes precedence; however, this can be
8796 overridden by quoting the file or function name with single quotes.
8798 For example, suppose the program is stopped in a method of a class
8799 that has a field named @code{includefile}, and there is also an
8800 include file named @file{includefile} that defines a variable,
8804 (@value{GDBP}) p includefile
8806 (@value{GDBP}) p includefile::some_global
8807 A syntax error in expression, near `'.
8808 (@value{GDBP}) p 'includefile'::some_global
8812 @cindex wrong values
8813 @cindex variable values, wrong
8814 @cindex function entry/exit, wrong values of variables
8815 @cindex optimized code, wrong values of variables
8817 @emph{Warning:} Occasionally, a local variable may appear to have the
8818 wrong value at certain points in a function---just after entry to a new
8819 scope, and just before exit.
8821 You may see this problem when you are stepping by machine instructions.
8822 This is because, on most machines, it takes more than one instruction to
8823 set up a stack frame (including local variable definitions); if you are
8824 stepping by machine instructions, variables may appear to have the wrong
8825 values until the stack frame is completely built. On exit, it usually
8826 also takes more than one machine instruction to destroy a stack frame;
8827 after you begin stepping through that group of instructions, local
8828 variable definitions may be gone.
8830 This may also happen when the compiler does significant optimizations.
8831 To be sure of always seeing accurate values, turn off all optimization
8834 @cindex ``No symbol "foo" in current context''
8835 Another possible effect of compiler optimizations is to optimize
8836 unused variables out of existence, or assign variables to registers (as
8837 opposed to memory addresses). Depending on the support for such cases
8838 offered by the debug info format used by the compiler, @value{GDBN}
8839 might not be able to display values for such local variables. If that
8840 happens, @value{GDBN} will print a message like this:
8843 No symbol "foo" in current context.
8846 To solve such problems, either recompile without optimizations, or use a
8847 different debug info format, if the compiler supports several such
8848 formats. @xref{Compilation}, for more information on choosing compiler
8849 options. @xref{C, ,C and C@t{++}}, for more information about debug
8850 info formats that are best suited to C@t{++} programs.
8852 If you ask to print an object whose contents are unknown to
8853 @value{GDBN}, e.g., because its data type is not completely specified
8854 by the debug information, @value{GDBN} will say @samp{<incomplete
8855 type>}. @xref{Symbols, incomplete type}, for more about this.
8857 If you append @kbd{@@entry} string to a function parameter name you get its
8858 value at the time the function got called. If the value is not available an
8859 error message is printed. Entry values are available only with some compilers.
8860 Entry values are normally also printed at the function parameter list according
8861 to @ref{set print entry-values}.
8864 Breakpoint 1, d (i=30) at gdb.base/entry-value.c:29
8870 (gdb) print i@@entry
8874 Strings are identified as arrays of @code{char} values without specified
8875 signedness. Arrays of either @code{signed char} or @code{unsigned char} get
8876 printed as arrays of 1 byte sized integers. @code{-fsigned-char} or
8877 @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
8878 defines literal string type @code{"char"} as @code{char} without a sign.
8883 signed char var1[] = "A";
8886 You get during debugging
8891 $2 = @{65 'A', 0 '\0'@}
8895 @section Artificial Arrays
8897 @cindex artificial array
8899 @kindex @@@r{, referencing memory as an array}
8900 It is often useful to print out several successive objects of the
8901 same type in memory; a section of an array, or an array of
8902 dynamically determined size for which only a pointer exists in the
8905 You can do this by referring to a contiguous span of memory as an
8906 @dfn{artificial array}, using the binary operator @samp{@@}. The left
8907 operand of @samp{@@} should be the first element of the desired array
8908 and be an individual object. The right operand should be the desired length
8909 of the array. The result is an array value whose elements are all of
8910 the type of the left argument. The first element is actually the left
8911 argument; the second element comes from bytes of memory immediately
8912 following those that hold the first element, and so on. Here is an
8913 example. If a program says
8916 int *array = (int *) malloc (len * sizeof (int));
8920 you can print the contents of @code{array} with
8926 The left operand of @samp{@@} must reside in memory. Array values made
8927 with @samp{@@} in this way behave just like other arrays in terms of
8928 subscripting, and are coerced to pointers when used in expressions.
8929 Artificial arrays most often appear in expressions via the value history
8930 (@pxref{Value History, ,Value History}), after printing one out.
8932 Another way to create an artificial array is to use a cast.
8933 This re-interprets a value as if it were an array.
8934 The value need not be in memory:
8936 (@value{GDBP}) p/x (short[2])0x12345678
8937 $1 = @{0x1234, 0x5678@}
8940 As a convenience, if you leave the array length out (as in
8941 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
8942 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
8944 (@value{GDBP}) p/x (short[])0x12345678
8945 $2 = @{0x1234, 0x5678@}
8948 Sometimes the artificial array mechanism is not quite enough; in
8949 moderately complex data structures, the elements of interest may not
8950 actually be adjacent---for example, if you are interested in the values
8951 of pointers in an array. One useful work-around in this situation is
8952 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
8953 Variables}) as a counter in an expression that prints the first
8954 interesting value, and then repeat that expression via @key{RET}. For
8955 instance, suppose you have an array @code{dtab} of pointers to
8956 structures, and you are interested in the values of a field @code{fv}
8957 in each structure. Here is an example of what you might type:
8967 @node Output Formats
8968 @section Output Formats
8970 @cindex formatted output
8971 @cindex output formats
8972 By default, @value{GDBN} prints a value according to its data type. Sometimes
8973 this is not what you want. For example, you might want to print a number
8974 in hex, or a pointer in decimal. Or you might want to view data in memory
8975 at a certain address as a character string or as an instruction. To do
8976 these things, specify an @dfn{output format} when you print a value.
8978 The simplest use of output formats is to say how to print a value
8979 already computed. This is done by starting the arguments of the
8980 @code{print} command with a slash and a format letter. The format
8981 letters supported are:
8985 Regard the bits of the value as an integer, and print the integer in
8989 Print as integer in signed decimal.
8992 Print as integer in unsigned decimal.
8995 Print as integer in octal.
8998 Print as integer in binary. The letter @samp{t} stands for ``two''.
8999 @footnote{@samp{b} cannot be used because these format letters are also
9000 used with the @code{x} command, where @samp{b} stands for ``byte'';
9001 see @ref{Memory,,Examining Memory}.}
9004 @cindex unknown address, locating
9005 @cindex locate address
9006 Print as an address, both absolute in hexadecimal and as an offset from
9007 the nearest preceding symbol. You can use this format used to discover
9008 where (in what function) an unknown address is located:
9011 (@value{GDBP}) p/a 0x54320
9012 $3 = 0x54320 <_initialize_vx+396>
9016 The command @code{info symbol 0x54320} yields similar results.
9017 @xref{Symbols, info symbol}.
9020 Regard as an integer and print it as a character constant. This
9021 prints both the numerical value and its character representation. The
9022 character representation is replaced with the octal escape @samp{\nnn}
9023 for characters outside the 7-bit @sc{ascii} range.
9025 Without this format, @value{GDBN} displays @code{char},
9026 @w{@code{unsigned char}}, and @w{@code{signed char}} data as character
9027 constants. Single-byte members of vectors are displayed as integer
9031 Regard the bits of the value as a floating point number and print
9032 using typical floating point syntax.
9035 @cindex printing strings
9036 @cindex printing byte arrays
9037 Regard as a string, if possible. With this format, pointers to single-byte
9038 data are displayed as null-terminated strings and arrays of single-byte data
9039 are displayed as fixed-length strings. Other values are displayed in their
9042 Without this format, @value{GDBN} displays pointers to and arrays of
9043 @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as
9044 strings. Single-byte members of a vector are displayed as an integer
9048 Like @samp{x} formatting, the value is treated as an integer and
9049 printed as hexadecimal, but leading zeros are printed to pad the value
9050 to the size of the integer type.
9053 @cindex raw printing
9054 Print using the @samp{raw} formatting. By default, @value{GDBN} will
9055 use a Python-based pretty-printer, if one is available (@pxref{Pretty
9056 Printing}). This typically results in a higher-level display of the
9057 value's contents. The @samp{r} format bypasses any Python
9058 pretty-printer which might exist.
9061 For example, to print the program counter in hex (@pxref{Registers}), type
9068 Note that no space is required before the slash; this is because command
9069 names in @value{GDBN} cannot contain a slash.
9071 To reprint the last value in the value history with a different format,
9072 you can use the @code{print} command with just a format and no
9073 expression. For example, @samp{p/x} reprints the last value in hex.
9076 @section Examining Memory
9078 You can use the command @code{x} (for ``examine'') to examine memory in
9079 any of several formats, independently of your program's data types.
9081 @cindex examining memory
9083 @kindex x @r{(examine memory)}
9084 @item x/@var{nfu} @var{addr}
9087 Use the @code{x} command to examine memory.
9090 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
9091 much memory to display and how to format it; @var{addr} is an
9092 expression giving the address where you want to start displaying memory.
9093 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
9094 Several commands set convenient defaults for @var{addr}.
9097 @item @var{n}, the repeat count
9098 The repeat count is a decimal integer; the default is 1. It specifies
9099 how much memory (counting by units @var{u}) to display.
9100 @c This really is **decimal**; unaffected by 'set radix' as of GDB
9103 @item @var{f}, the display format
9104 The display format is one of the formats used by @code{print}
9105 (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c},
9106 @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions).
9107 The default is @samp{x} (hexadecimal) initially. The default changes
9108 each time you use either @code{x} or @code{print}.
9110 @item @var{u}, the unit size
9111 The unit size is any of
9117 Halfwords (two bytes).
9119 Words (four bytes). This is the initial default.
9121 Giant words (eight bytes).
9124 Each time you specify a unit size with @code{x}, that size becomes the
9125 default unit the next time you use @code{x}. For the @samp{i} format,
9126 the unit size is ignored and is normally not written. For the @samp{s} format,
9127 the unit size defaults to @samp{b}, unless it is explicitly given.
9128 Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display
9129 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings.
9130 Note that the results depend on the programming language of the
9131 current compilation unit. If the language is C, the @samp{s}
9132 modifier will use the UTF-16 encoding while @samp{w} will use
9133 UTF-32. The encoding is set by the programming language and cannot
9136 @item @var{addr}, starting display address
9137 @var{addr} is the address where you want @value{GDBN} to begin displaying
9138 memory. The expression need not have a pointer value (though it may);
9139 it is always interpreted as an integer address of a byte of memory.
9140 @xref{Expressions, ,Expressions}, for more information on expressions. The default for
9141 @var{addr} is usually just after the last address examined---but several
9142 other commands also set the default address: @code{info breakpoints} (to
9143 the address of the last breakpoint listed), @code{info line} (to the
9144 starting address of a line), and @code{print} (if you use it to display
9145 a value from memory).
9148 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
9149 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
9150 starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four
9151 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
9152 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
9154 Since the letters indicating unit sizes are all distinct from the
9155 letters specifying output formats, you do not have to remember whether
9156 unit size or format comes first; either order works. The output
9157 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
9158 (However, the count @var{n} must come first; @samp{wx4} does not work.)
9160 Even though the unit size @var{u} is ignored for the formats @samp{s}
9161 and @samp{i}, you might still want to use a count @var{n}; for example,
9162 @samp{3i} specifies that you want to see three machine instructions,
9163 including any operands. For convenience, especially when used with
9164 the @code{display} command, the @samp{i} format also prints branch delay
9165 slot instructions, if any, beyond the count specified, which immediately
9166 follow the last instruction that is within the count. The command
9167 @code{disassemble} gives an alternative way of inspecting machine
9168 instructions; see @ref{Machine Code,,Source and Machine Code}.
9170 All the defaults for the arguments to @code{x} are designed to make it
9171 easy to continue scanning memory with minimal specifications each time
9172 you use @code{x}. For example, after you have inspected three machine
9173 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
9174 with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command,
9175 the repeat count @var{n} is used again; the other arguments default as
9176 for successive uses of @code{x}.
9178 When examining machine instructions, the instruction at current program
9179 counter is shown with a @code{=>} marker. For example:
9182 (@value{GDBP}) x/5i $pc-6
9183 0x804837f <main+11>: mov %esp,%ebp
9184 0x8048381 <main+13>: push %ecx
9185 0x8048382 <main+14>: sub $0x4,%esp
9186 => 0x8048385 <main+17>: movl $0x8048460,(%esp)
9187 0x804838c <main+24>: call 0x80482d4 <puts@@plt>
9190 @cindex @code{$_}, @code{$__}, and value history
9191 The addresses and contents printed by the @code{x} command are not saved
9192 in the value history because there is often too much of them and they
9193 would get in the way. Instead, @value{GDBN} makes these values available for
9194 subsequent use in expressions as values of the convenience variables
9195 @code{$_} and @code{$__}. After an @code{x} command, the last address
9196 examined is available for use in expressions in the convenience variable
9197 @code{$_}. The contents of that address, as examined, are available in
9198 the convenience variable @code{$__}.
9200 If the @code{x} command has a repeat count, the address and contents saved
9201 are from the last memory unit printed; this is not the same as the last
9202 address printed if several units were printed on the last line of output.
9204 @anchor{addressable memory unit}
9205 @cindex addressable memory unit
9206 Most targets have an addressable memory unit size of 8 bits. This means
9207 that to each memory address are associated 8 bits of data. Some
9208 targets, however, have other addressable memory unit sizes.
9209 Within @value{GDBN} and this document, the term
9210 @dfn{addressable memory unit} (or @dfn{memory unit} for short) is used
9211 when explicitly referring to a chunk of data of that size. The word
9212 @dfn{byte} is used to refer to a chunk of data of 8 bits, regardless of
9213 the addressable memory unit size of the target. For most systems,
9214 addressable memory unit is a synonym of byte.
9216 @cindex remote memory comparison
9217 @cindex target memory comparison
9218 @cindex verify remote memory image
9219 @cindex verify target memory image
9220 When you are debugging a program running on a remote target machine
9221 (@pxref{Remote Debugging}), you may wish to verify the program's image
9222 in the remote machine's memory against the executable file you
9223 downloaded to the target. Or, on any target, you may want to check
9224 whether the program has corrupted its own read-only sections. The
9225 @code{compare-sections} command is provided for such situations.
9228 @kindex compare-sections
9229 @item compare-sections @r{[}@var{section-name}@r{|}@code{-r}@r{]}
9230 Compare the data of a loadable section @var{section-name} in the
9231 executable file of the program being debugged with the same section in
9232 the target machine's memory, and report any mismatches. With no
9233 arguments, compares all loadable sections. With an argument of
9234 @code{-r}, compares all loadable read-only sections.
9236 Note: for remote targets, this command can be accelerated if the
9237 target supports computing the CRC checksum of a block of memory
9238 (@pxref{qCRC packet}).
9242 @section Automatic Display
9243 @cindex automatic display
9244 @cindex display of expressions
9246 If you find that you want to print the value of an expression frequently
9247 (to see how it changes), you might want to add it to the @dfn{automatic
9248 display list} so that @value{GDBN} prints its value each time your program stops.
9249 Each expression added to the list is given a number to identify it;
9250 to remove an expression from the list, you specify that number.
9251 The automatic display looks like this:
9255 3: bar[5] = (struct hack *) 0x3804
9259 This display shows item numbers, expressions and their current values. As with
9260 displays you request manually using @code{x} or @code{print}, you can
9261 specify the output format you prefer; in fact, @code{display} decides
9262 whether to use @code{print} or @code{x} depending your format
9263 specification---it uses @code{x} if you specify either the @samp{i}
9264 or @samp{s} format, or a unit size; otherwise it uses @code{print}.
9268 @item display @var{expr}
9269 Add the expression @var{expr} to the list of expressions to display
9270 each time your program stops. @xref{Expressions, ,Expressions}.
9272 @code{display} does not repeat if you press @key{RET} again after using it.
9274 @item display/@var{fmt} @var{expr}
9275 For @var{fmt} specifying only a display format and not a size or
9276 count, add the expression @var{expr} to the auto-display list but
9277 arrange to display it each time in the specified format @var{fmt}.
9278 @xref{Output Formats,,Output Formats}.
9280 @item display/@var{fmt} @var{addr}
9281 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
9282 number of units, add the expression @var{addr} as a memory address to
9283 be examined each time your program stops. Examining means in effect
9284 doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}.
9287 For example, @samp{display/i $pc} can be helpful, to see the machine
9288 instruction about to be executed each time execution stops (@samp{$pc}
9289 is a common name for the program counter; @pxref{Registers, ,Registers}).
9292 @kindex delete display
9294 @item undisplay @var{dnums}@dots{}
9295 @itemx delete display @var{dnums}@dots{}
9296 Remove items from the list of expressions to display. Specify the
9297 numbers of the displays that you want affected with the command
9298 argument @var{dnums}. It can be a single display number, one of the
9299 numbers shown in the first field of the @samp{info display} display;
9300 or it could be a range of display numbers, as in @code{2-4}.
9302 @code{undisplay} does not repeat if you press @key{RET} after using it.
9303 (Otherwise you would just get the error @samp{No display number @dots{}}.)
9305 @kindex disable display
9306 @item disable display @var{dnums}@dots{}
9307 Disable the display of item numbers @var{dnums}. A disabled display
9308 item is not printed automatically, but is not forgotten. It may be
9309 enabled again later. Specify the numbers of the displays that you
9310 want affected with the command argument @var{dnums}. It can be a
9311 single display number, one of the numbers shown in the first field of
9312 the @samp{info display} display; or it could be a range of display
9313 numbers, as in @code{2-4}.
9315 @kindex enable display
9316 @item enable display @var{dnums}@dots{}
9317 Enable display of item numbers @var{dnums}. It becomes effective once
9318 again in auto display of its expression, until you specify otherwise.
9319 Specify the numbers of the displays that you want affected with the
9320 command argument @var{dnums}. It can be a single display number, one
9321 of the numbers shown in the first field of the @samp{info display}
9322 display; or it could be a range of display numbers, as in @code{2-4}.
9325 Display the current values of the expressions on the list, just as is
9326 done when your program stops.
9328 @kindex info display
9330 Print the list of expressions previously set up to display
9331 automatically, each one with its item number, but without showing the
9332 values. This includes disabled expressions, which are marked as such.
9333 It also includes expressions which would not be displayed right now
9334 because they refer to automatic variables not currently available.
9337 @cindex display disabled out of scope
9338 If a display expression refers to local variables, then it does not make
9339 sense outside the lexical context for which it was set up. Such an
9340 expression is disabled when execution enters a context where one of its
9341 variables is not defined. For example, if you give the command
9342 @code{display last_char} while inside a function with an argument
9343 @code{last_char}, @value{GDBN} displays this argument while your program
9344 continues to stop inside that function. When it stops elsewhere---where
9345 there is no variable @code{last_char}---the display is disabled
9346 automatically. The next time your program stops where @code{last_char}
9347 is meaningful, you can enable the display expression once again.
9349 @node Print Settings
9350 @section Print Settings
9352 @cindex format options
9353 @cindex print settings
9354 @value{GDBN} provides the following ways to control how arrays, structures,
9355 and symbols are printed.
9358 These settings are useful for debugging programs in any language:
9362 @item set print address
9363 @itemx set print address on
9364 @cindex print/don't print memory addresses
9365 @value{GDBN} prints memory addresses showing the location of stack
9366 traces, structure values, pointer values, breakpoints, and so forth,
9367 even when it also displays the contents of those addresses. The default
9368 is @code{on}. For example, this is what a stack frame display looks like with
9369 @code{set print address on}:
9374 #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
9376 530 if (lquote != def_lquote)
9380 @item set print address off
9381 Do not print addresses when displaying their contents. For example,
9382 this is the same stack frame displayed with @code{set print address off}:
9386 (@value{GDBP}) set print addr off
9388 #0 set_quotes (lq="<<", rq=">>") at input.c:530
9389 530 if (lquote != def_lquote)
9393 You can use @samp{set print address off} to eliminate all machine
9394 dependent displays from the @value{GDBN} interface. For example, with
9395 @code{print address off}, you should get the same text for backtraces on
9396 all machines---whether or not they involve pointer arguments.
9399 @item show print address
9400 Show whether or not addresses are to be printed.
9403 When @value{GDBN} prints a symbolic address, it normally prints the
9404 closest earlier symbol plus an offset. If that symbol does not uniquely
9405 identify the address (for example, it is a name whose scope is a single
9406 source file), you may need to clarify. One way to do this is with
9407 @code{info line}, for example @samp{info line *0x4537}. Alternately,
9408 you can set @value{GDBN} to print the source file and line number when
9409 it prints a symbolic address:
9412 @item set print symbol-filename on
9413 @cindex source file and line of a symbol
9414 @cindex symbol, source file and line
9415 Tell @value{GDBN} to print the source file name and line number of a
9416 symbol in the symbolic form of an address.
9418 @item set print symbol-filename off
9419 Do not print source file name and line number of a symbol. This is the
9422 @item show print symbol-filename
9423 Show whether or not @value{GDBN} will print the source file name and
9424 line number of a symbol in the symbolic form of an address.
9427 Another situation where it is helpful to show symbol filenames and line
9428 numbers is when disassembling code; @value{GDBN} shows you the line
9429 number and source file that corresponds to each instruction.
9431 Also, you may wish to see the symbolic form only if the address being
9432 printed is reasonably close to the closest earlier symbol:
9435 @item set print max-symbolic-offset @var{max-offset}
9436 @itemx set print max-symbolic-offset unlimited
9437 @cindex maximum value for offset of closest symbol
9438 Tell @value{GDBN} to only display the symbolic form of an address if the
9439 offset between the closest earlier symbol and the address is less than
9440 @var{max-offset}. The default is @code{unlimited}, which tells @value{GDBN}
9441 to always print the symbolic form of an address if any symbol precedes
9442 it. Zero is equivalent to @code{unlimited}.
9444 @item show print max-symbolic-offset
9445 Ask how large the maximum offset is that @value{GDBN} prints in a
9449 @cindex wild pointer, interpreting
9450 @cindex pointer, finding referent
9451 If you have a pointer and you are not sure where it points, try
9452 @samp{set print symbol-filename on}. Then you can determine the name
9453 and source file location of the variable where it points, using
9454 @samp{p/a @var{pointer}}. This interprets the address in symbolic form.
9455 For example, here @value{GDBN} shows that a variable @code{ptt} points
9456 at another variable @code{t}, defined in @file{hi2.c}:
9459 (@value{GDBP}) set print symbol-filename on
9460 (@value{GDBP}) p/a ptt
9461 $4 = 0xe008 <t in hi2.c>
9465 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
9466 does not show the symbol name and filename of the referent, even with
9467 the appropriate @code{set print} options turned on.
9470 You can also enable @samp{/a}-like formatting all the time using
9471 @samp{set print symbol on}:
9474 @item set print symbol on
9475 Tell @value{GDBN} to print the symbol corresponding to an address, if
9478 @item set print symbol off
9479 Tell @value{GDBN} not to print the symbol corresponding to an
9480 address. In this mode, @value{GDBN} will still print the symbol
9481 corresponding to pointers to functions. This is the default.
9483 @item show print symbol
9484 Show whether @value{GDBN} will display the symbol corresponding to an
9488 Other settings control how different kinds of objects are printed:
9491 @item set print array
9492 @itemx set print array on
9493 @cindex pretty print arrays
9494 Pretty print arrays. This format is more convenient to read,
9495 but uses more space. The default is off.
9497 @item set print array off
9498 Return to compressed format for arrays.
9500 @item show print array
9501 Show whether compressed or pretty format is selected for displaying
9504 @cindex print array indexes
9505 @item set print array-indexes
9506 @itemx set print array-indexes on
9507 Print the index of each element when displaying arrays. May be more
9508 convenient to locate a given element in the array or quickly find the
9509 index of a given element in that printed array. The default is off.
9511 @item set print array-indexes off
9512 Stop printing element indexes when displaying arrays.
9514 @item show print array-indexes
9515 Show whether the index of each element is printed when displaying
9518 @item set print elements @var{number-of-elements}
9519 @itemx set print elements unlimited
9520 @cindex number of array elements to print
9521 @cindex limit on number of printed array elements
9522 Set a limit on how many elements of an array @value{GDBN} will print.
9523 If @value{GDBN} is printing a large array, it stops printing after it has
9524 printed the number of elements set by the @code{set print elements} command.
9525 This limit also applies to the display of strings.
9526 When @value{GDBN} starts, this limit is set to 200.
9527 Setting @var{number-of-elements} to @code{unlimited} or zero means
9528 that the number of elements to print is unlimited.
9530 @item show print elements
9531 Display the number of elements of a large array that @value{GDBN} will print.
9532 If the number is 0, then the printing is unlimited.
9534 @item set print frame-arguments @var{value}
9535 @kindex set print frame-arguments
9536 @cindex printing frame argument values
9537 @cindex print all frame argument values
9538 @cindex print frame argument values for scalars only
9539 @cindex do not print frame argument values
9540 This command allows to control how the values of arguments are printed
9541 when the debugger prints a frame (@pxref{Frames}). The possible
9546 The values of all arguments are printed.
9549 Print the value of an argument only if it is a scalar. The value of more
9550 complex arguments such as arrays, structures, unions, etc, is replaced
9551 by @code{@dots{}}. This is the default. Here is an example where
9552 only scalar arguments are shown:
9555 #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green)
9560 None of the argument values are printed. Instead, the value of each argument
9561 is replaced by @code{@dots{}}. In this case, the example above now becomes:
9564 #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{})
9569 By default, only scalar arguments are printed. This command can be used
9570 to configure the debugger to print the value of all arguments, regardless
9571 of their type. However, it is often advantageous to not print the value
9572 of more complex parameters. For instance, it reduces the amount of
9573 information printed in each frame, making the backtrace more readable.
9574 Also, it improves performance when displaying Ada frames, because
9575 the computation of large arguments can sometimes be CPU-intensive,
9576 especially in large applications. Setting @code{print frame-arguments}
9577 to @code{scalars} (the default) or @code{none} avoids this computation,
9578 thus speeding up the display of each Ada frame.
9580 @item show print frame-arguments
9581 Show how the value of arguments should be displayed when printing a frame.
9583 @item set print raw frame-arguments on
9584 Print frame arguments in raw, non pretty-printed, form.
9586 @item set print raw frame-arguments off
9587 Print frame arguments in pretty-printed form, if there is a pretty-printer
9588 for the value (@pxref{Pretty Printing}),
9589 otherwise print the value in raw form.
9590 This is the default.
9592 @item show print raw frame-arguments
9593 Show whether to print frame arguments in raw form.
9595 @anchor{set print entry-values}
9596 @item set print entry-values @var{value}
9597 @kindex set print entry-values
9598 Set printing of frame argument values at function entry. In some cases
9599 @value{GDBN} can determine the value of function argument which was passed by
9600 the function caller, even if the value was modified inside the called function
9601 and therefore is different. With optimized code, the current value could be
9602 unavailable, but the entry value may still be known.
9604 The default value is @code{default} (see below for its description). Older
9605 @value{GDBN} behaved as with the setting @code{no}. Compilers not supporting
9606 this feature will behave in the @code{default} setting the same way as with the
9609 This functionality is currently supported only by DWARF 2 debugging format and
9610 the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With
9611 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
9614 The @var{value} parameter can be one of the following:
9618 Print only actual parameter values, never print values from function entry
9622 #0 different (val=6)
9623 #0 lost (val=<optimized out>)
9625 #0 invalid (val=<optimized out>)
9629 Print only parameter values from function entry point. The actual parameter
9630 values are never printed.
9632 #0 equal (val@@entry=5)
9633 #0 different (val@@entry=5)
9634 #0 lost (val@@entry=5)
9635 #0 born (val@@entry=<optimized out>)
9636 #0 invalid (val@@entry=<optimized out>)
9640 Print only parameter values from function entry point. If value from function
9641 entry point is not known while the actual value is known, print the actual
9642 value for such parameter.
9644 #0 equal (val@@entry=5)
9645 #0 different (val@@entry=5)
9646 #0 lost (val@@entry=5)
9648 #0 invalid (val@@entry=<optimized out>)
9652 Print actual parameter values. If actual parameter value is not known while
9653 value from function entry point is known, print the entry point value for such
9657 #0 different (val=6)
9658 #0 lost (val@@entry=5)
9660 #0 invalid (val=<optimized out>)
9664 Always print both the actual parameter value and its value from function entry
9665 point, even if values of one or both are not available due to compiler
9668 #0 equal (val=5, val@@entry=5)
9669 #0 different (val=6, val@@entry=5)
9670 #0 lost (val=<optimized out>, val@@entry=5)
9671 #0 born (val=10, val@@entry=<optimized out>)
9672 #0 invalid (val=<optimized out>, val@@entry=<optimized out>)
9676 Print the actual parameter value if it is known and also its value from
9677 function entry point if it is known. If neither is known, print for the actual
9678 value @code{<optimized out>}. If not in MI mode (@pxref{GDB/MI}) and if both
9679 values are known and identical, print the shortened
9680 @code{param=param@@entry=VALUE} notation.
9682 #0 equal (val=val@@entry=5)
9683 #0 different (val=6, val@@entry=5)
9684 #0 lost (val@@entry=5)
9686 #0 invalid (val=<optimized out>)
9690 Always print the actual parameter value. Print also its value from function
9691 entry point, but only if it is known. If not in MI mode (@pxref{GDB/MI}) and
9692 if both values are known and identical, print the shortened
9693 @code{param=param@@entry=VALUE} notation.
9695 #0 equal (val=val@@entry=5)
9696 #0 different (val=6, val@@entry=5)
9697 #0 lost (val=<optimized out>, val@@entry=5)
9699 #0 invalid (val=<optimized out>)
9703 For analysis messages on possible failures of frame argument values at function
9704 entry resolution see @ref{set debug entry-values}.
9706 @item show print entry-values
9707 Show the method being used for printing of frame argument values at function
9710 @item set print repeats @var{number-of-repeats}
9711 @itemx set print repeats unlimited
9712 @cindex repeated array elements
9713 Set the threshold for suppressing display of repeated array
9714 elements. When the number of consecutive identical elements of an
9715 array exceeds the threshold, @value{GDBN} prints the string
9716 @code{"<repeats @var{n} times>"}, where @var{n} is the number of
9717 identical repetitions, instead of displaying the identical elements
9718 themselves. Setting the threshold to @code{unlimited} or zero will
9719 cause all elements to be individually printed. The default threshold
9722 @item show print repeats
9723 Display the current threshold for printing repeated identical
9726 @item set print null-stop
9727 @cindex @sc{null} elements in arrays
9728 Cause @value{GDBN} to stop printing the characters of an array when the first
9729 @sc{null} is encountered. This is useful when large arrays actually
9730 contain only short strings.
9733 @item show print null-stop
9734 Show whether @value{GDBN} stops printing an array on the first
9735 @sc{null} character.
9737 @item set print pretty on
9738 @cindex print structures in indented form
9739 @cindex indentation in structure display
9740 Cause @value{GDBN} to print structures in an indented format with one member
9741 per line, like this:
9756 @item set print pretty off
9757 Cause @value{GDBN} to print structures in a compact format, like this:
9761 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
9762 meat = 0x54 "Pork"@}
9767 This is the default format.
9769 @item show print pretty
9770 Show which format @value{GDBN} is using to print structures.
9772 @item set print sevenbit-strings on
9773 @cindex eight-bit characters in strings
9774 @cindex octal escapes in strings
9775 Print using only seven-bit characters; if this option is set,
9776 @value{GDBN} displays any eight-bit characters (in strings or
9777 character values) using the notation @code{\}@var{nnn}. This setting is
9778 best if you are working in English (@sc{ascii}) and you use the
9779 high-order bit of characters as a marker or ``meta'' bit.
9781 @item set print sevenbit-strings off
9782 Print full eight-bit characters. This allows the use of more
9783 international character sets, and is the default.
9785 @item show print sevenbit-strings
9786 Show whether or not @value{GDBN} is printing only seven-bit characters.
9788 @item set print union on
9789 @cindex unions in structures, printing
9790 Tell @value{GDBN} to print unions which are contained in structures
9791 and other unions. This is the default setting.
9793 @item set print union off
9794 Tell @value{GDBN} not to print unions which are contained in
9795 structures and other unions. @value{GDBN} will print @code{"@{...@}"}
9798 @item show print union
9799 Ask @value{GDBN} whether or not it will print unions which are contained in
9800 structures and other unions.
9802 For example, given the declarations
9805 typedef enum @{Tree, Bug@} Species;
9806 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
9807 typedef enum @{Caterpillar, Cocoon, Butterfly@}
9818 struct thing foo = @{Tree, @{Acorn@}@};
9822 with @code{set print union on} in effect @samp{p foo} would print
9825 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
9829 and with @code{set print union off} in effect it would print
9832 $1 = @{it = Tree, form = @{...@}@}
9836 @code{set print union} affects programs written in C-like languages
9842 These settings are of interest when debugging C@t{++} programs:
9845 @cindex demangling C@t{++} names
9846 @item set print demangle
9847 @itemx set print demangle on
9848 Print C@t{++} names in their source form rather than in the encoded
9849 (``mangled'') form passed to the assembler and linker for type-safe
9850 linkage. The default is on.
9852 @item show print demangle
9853 Show whether C@t{++} names are printed in mangled or demangled form.
9855 @item set print asm-demangle
9856 @itemx set print asm-demangle on
9857 Print C@t{++} names in their source form rather than their mangled form, even
9858 in assembler code printouts such as instruction disassemblies.
9861 @item show print asm-demangle
9862 Show whether C@t{++} names in assembly listings are printed in mangled
9865 @cindex C@t{++} symbol decoding style
9866 @cindex symbol decoding style, C@t{++}
9867 @kindex set demangle-style
9868 @item set demangle-style @var{style}
9869 Choose among several encoding schemes used by different compilers to
9870 represent C@t{++} names. The choices for @var{style} are currently:
9874 Allow @value{GDBN} to choose a decoding style by inspecting your program.
9875 This is the default.
9878 Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm.
9881 Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm.
9884 Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm.
9887 Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}.
9888 @strong{Warning:} this setting alone is not sufficient to allow
9889 debugging @code{cfront}-generated executables. @value{GDBN} would
9890 require further enhancement to permit that.
9893 If you omit @var{style}, you will see a list of possible formats.
9895 @item show demangle-style
9896 Display the encoding style currently in use for decoding C@t{++} symbols.
9898 @item set print object
9899 @itemx set print object on
9900 @cindex derived type of an object, printing
9901 @cindex display derived types
9902 When displaying a pointer to an object, identify the @emph{actual}
9903 (derived) type of the object rather than the @emph{declared} type, using
9904 the virtual function table. Note that the virtual function table is
9905 required---this feature can only work for objects that have run-time
9906 type identification; a single virtual method in the object's declared
9907 type is sufficient. Note that this setting is also taken into account when
9908 working with variable objects via MI (@pxref{GDB/MI}).
9910 @item set print object off
9911 Display only the declared type of objects, without reference to the
9912 virtual function table. This is the default setting.
9914 @item show print object
9915 Show whether actual, or declared, object types are displayed.
9917 @item set print static-members
9918 @itemx set print static-members on
9919 @cindex static members of C@t{++} objects
9920 Print static members when displaying a C@t{++} object. The default is on.
9922 @item set print static-members off
9923 Do not print static members when displaying a C@t{++} object.
9925 @item show print static-members
9926 Show whether C@t{++} static members are printed or not.
9928 @item set print pascal_static-members
9929 @itemx set print pascal_static-members on
9930 @cindex static members of Pascal objects
9931 @cindex Pascal objects, static members display
9932 Print static members when displaying a Pascal object. The default is on.
9934 @item set print pascal_static-members off
9935 Do not print static members when displaying a Pascal object.
9937 @item show print pascal_static-members
9938 Show whether Pascal static members are printed or not.
9940 @c These don't work with HP ANSI C++ yet.
9941 @item set print vtbl
9942 @itemx set print vtbl on
9943 @cindex pretty print C@t{++} virtual function tables
9944 @cindex virtual functions (C@t{++}) display
9945 @cindex VTBL display
9946 Pretty print C@t{++} virtual function tables. The default is off.
9947 (The @code{vtbl} commands do not work on programs compiled with the HP
9948 ANSI C@t{++} compiler (@code{aCC}).)
9950 @item set print vtbl off
9951 Do not pretty print C@t{++} virtual function tables.
9953 @item show print vtbl
9954 Show whether C@t{++} virtual function tables are pretty printed, or not.
9957 @node Pretty Printing
9958 @section Pretty Printing
9960 @value{GDBN} provides a mechanism to allow pretty-printing of values using
9961 Python code. It greatly simplifies the display of complex objects. This
9962 mechanism works for both MI and the CLI.
9965 * Pretty-Printer Introduction:: Introduction to pretty-printers
9966 * Pretty-Printer Example:: An example pretty-printer
9967 * Pretty-Printer Commands:: Pretty-printer commands
9970 @node Pretty-Printer Introduction
9971 @subsection Pretty-Printer Introduction
9973 When @value{GDBN} prints a value, it first sees if there is a pretty-printer
9974 registered for the value. If there is then @value{GDBN} invokes the
9975 pretty-printer to print the value. Otherwise the value is printed normally.
9977 Pretty-printers are normally named. This makes them easy to manage.
9978 The @samp{info pretty-printer} command will list all the installed
9979 pretty-printers with their names.
9980 If a pretty-printer can handle multiple data types, then its
9981 @dfn{subprinters} are the printers for the individual data types.
9982 Each such subprinter has its own name.
9983 The format of the name is @var{printer-name};@var{subprinter-name}.
9985 Pretty-printers are installed by @dfn{registering} them with @value{GDBN}.
9986 Typically they are automatically loaded and registered when the corresponding
9987 debug information is loaded, thus making them available without having to
9988 do anything special.
9990 There are three places where a pretty-printer can be registered.
9994 Pretty-printers registered globally are available when debugging
9998 Pretty-printers registered with a program space are available only
9999 when debugging that program.
10000 @xref{Progspaces In Python}, for more details on program spaces in Python.
10003 Pretty-printers registered with an objfile are loaded and unloaded
10004 with the corresponding objfile (e.g., shared library).
10005 @xref{Objfiles In Python}, for more details on objfiles in Python.
10008 @xref{Selecting Pretty-Printers}, for further information on how
10009 pretty-printers are selected,
10011 @xref{Writing a Pretty-Printer}, for implementing pretty printers
10014 @node Pretty-Printer Example
10015 @subsection Pretty-Printer Example
10017 Here is how a C@t{++} @code{std::string} looks without a pretty-printer:
10020 (@value{GDBP}) print s
10022 static npos = 4294967295,
10024 <std::allocator<char>> = @{
10025 <__gnu_cxx::new_allocator<char>> = @{
10026 <No data fields>@}, <No data fields>
10028 members of std::basic_string<char, std::char_traits<char>,
10029 std::allocator<char> >::_Alloc_hider:
10030 _M_p = 0x804a014 "abcd"
10035 With a pretty-printer for @code{std::string} only the contents are printed:
10038 (@value{GDBP}) print s
10042 @node Pretty-Printer Commands
10043 @subsection Pretty-Printer Commands
10044 @cindex pretty-printer commands
10047 @kindex info pretty-printer
10048 @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10049 Print the list of installed pretty-printers.
10050 This includes disabled pretty-printers, which are marked as such.
10052 @var{object-regexp} is a regular expression matching the objects
10053 whose pretty-printers to list.
10054 Objects can be @code{global}, the program space's file
10055 (@pxref{Progspaces In Python}),
10056 and the object files within that program space (@pxref{Objfiles In Python}).
10057 @xref{Selecting Pretty-Printers}, for details on how @value{GDBN}
10058 looks up a printer from these three objects.
10060 @var{name-regexp} is a regular expression matching the name of the printers
10063 @kindex disable pretty-printer
10064 @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10065 Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10066 A disabled pretty-printer is not forgotten, it may be enabled again later.
10068 @kindex enable pretty-printer
10069 @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10070 Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10075 Suppose we have three pretty-printers installed: one from library1.so
10076 named @code{foo} that prints objects of type @code{foo}, and
10077 another from library2.so named @code{bar} that prints two types of objects,
10078 @code{bar1} and @code{bar2}.
10081 (gdb) info pretty-printer
10088 (gdb) info pretty-printer library2
10093 (gdb) disable pretty-printer library1
10095 2 of 3 printers enabled
10096 (gdb) info pretty-printer
10103 (gdb) disable pretty-printer library2 bar:bar1
10105 1 of 3 printers enabled
10106 (gdb) info pretty-printer library2
10113 (gdb) disable pretty-printer library2 bar
10115 0 of 3 printers enabled
10116 (gdb) info pretty-printer library2
10125 Note that for @code{bar} the entire printer can be disabled,
10126 as can each individual subprinter.
10128 @node Value History
10129 @section Value History
10131 @cindex value history
10132 @cindex history of values printed by @value{GDBN}
10133 Values printed by the @code{print} command are saved in the @value{GDBN}
10134 @dfn{value history}. This allows you to refer to them in other expressions.
10135 Values are kept until the symbol table is re-read or discarded
10136 (for example with the @code{file} or @code{symbol-file} commands).
10137 When the symbol table changes, the value history is discarded,
10138 since the values may contain pointers back to the types defined in the
10143 @cindex history number
10144 The values printed are given @dfn{history numbers} by which you can
10145 refer to them. These are successive integers starting with one.
10146 @code{print} shows you the history number assigned to a value by
10147 printing @samp{$@var{num} = } before the value; here @var{num} is the
10150 To refer to any previous value, use @samp{$} followed by the value's
10151 history number. The way @code{print} labels its output is designed to
10152 remind you of this. Just @code{$} refers to the most recent value in
10153 the history, and @code{$$} refers to the value before that.
10154 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
10155 is the value just prior to @code{$$}, @code{$$1} is equivalent to
10156 @code{$$}, and @code{$$0} is equivalent to @code{$}.
10158 For example, suppose you have just printed a pointer to a structure and
10159 want to see the contents of the structure. It suffices to type
10165 If you have a chain of structures where the component @code{next} points
10166 to the next one, you can print the contents of the next one with this:
10173 You can print successive links in the chain by repeating this
10174 command---which you can do by just typing @key{RET}.
10176 Note that the history records values, not expressions. If the value of
10177 @code{x} is 4 and you type these commands:
10185 then the value recorded in the value history by the @code{print} command
10186 remains 4 even though the value of @code{x} has changed.
10189 @kindex show values
10191 Print the last ten values in the value history, with their item numbers.
10192 This is like @samp{p@ $$9} repeated ten times, except that @code{show
10193 values} does not change the history.
10195 @item show values @var{n}
10196 Print ten history values centered on history item number @var{n}.
10198 @item show values +
10199 Print ten history values just after the values last printed. If no more
10200 values are available, @code{show values +} produces no display.
10203 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
10204 same effect as @samp{show values +}.
10206 @node Convenience Vars
10207 @section Convenience Variables
10209 @cindex convenience variables
10210 @cindex user-defined variables
10211 @value{GDBN} provides @dfn{convenience variables} that you can use within
10212 @value{GDBN} to hold on to a value and refer to it later. These variables
10213 exist entirely within @value{GDBN}; they are not part of your program, and
10214 setting a convenience variable has no direct effect on further execution
10215 of your program. That is why you can use them freely.
10217 Convenience variables are prefixed with @samp{$}. Any name preceded by
10218 @samp{$} can be used for a convenience variable, unless it is one of
10219 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
10220 (Value history references, in contrast, are @emph{numbers} preceded
10221 by @samp{$}. @xref{Value History, ,Value History}.)
10223 You can save a value in a convenience variable with an assignment
10224 expression, just as you would set a variable in your program.
10228 set $foo = *object_ptr
10232 would save in @code{$foo} the value contained in the object pointed to by
10235 Using a convenience variable for the first time creates it, but its
10236 value is @code{void} until you assign a new value. You can alter the
10237 value with another assignment at any time.
10239 Convenience variables have no fixed types. You can assign a convenience
10240 variable any type of value, including structures and arrays, even if
10241 that variable already has a value of a different type. The convenience
10242 variable, when used as an expression, has the type of its current value.
10245 @kindex show convenience
10246 @cindex show all user variables and functions
10247 @item show convenience
10248 Print a list of convenience variables used so far, and their values,
10249 as well as a list of the convenience functions.
10250 Abbreviated @code{show conv}.
10252 @kindex init-if-undefined
10253 @cindex convenience variables, initializing
10254 @item init-if-undefined $@var{variable} = @var{expression}
10255 Set a convenience variable if it has not already been set. This is useful
10256 for user-defined commands that keep some state. It is similar, in concept,
10257 to using local static variables with initializers in C (except that
10258 convenience variables are global). It can also be used to allow users to
10259 override default values used in a command script.
10261 If the variable is already defined then the expression is not evaluated so
10262 any side-effects do not occur.
10265 One of the ways to use a convenience variable is as a counter to be
10266 incremented or a pointer to be advanced. For example, to print
10267 a field from successive elements of an array of structures:
10271 print bar[$i++]->contents
10275 Repeat that command by typing @key{RET}.
10277 Some convenience variables are created automatically by @value{GDBN} and given
10278 values likely to be useful.
10281 @vindex $_@r{, convenience variable}
10283 The variable @code{$_} is automatically set by the @code{x} command to
10284 the last address examined (@pxref{Memory, ,Examining Memory}). Other
10285 commands which provide a default address for @code{x} to examine also
10286 set @code{$_} to that address; these commands include @code{info line}
10287 and @code{info breakpoint}. The type of @code{$_} is @code{void *}
10288 except when set by the @code{x} command, in which case it is a pointer
10289 to the type of @code{$__}.
10291 @vindex $__@r{, convenience variable}
10293 The variable @code{$__} is automatically set by the @code{x} command
10294 to the value found in the last address examined. Its type is chosen
10295 to match the format in which the data was printed.
10298 @vindex $_exitcode@r{, convenience variable}
10299 When the program being debugged terminates normally, @value{GDBN}
10300 automatically sets this variable to the exit code of the program, and
10301 resets @code{$_exitsignal} to @code{void}.
10304 @vindex $_exitsignal@r{, convenience variable}
10305 When the program being debugged dies due to an uncaught signal,
10306 @value{GDBN} automatically sets this variable to that signal's number,
10307 and resets @code{$_exitcode} to @code{void}.
10309 To distinguish between whether the program being debugged has exited
10310 (i.e., @code{$_exitcode} is not @code{void}) or signalled (i.e.,
10311 @code{$_exitsignal} is not @code{void}), the convenience function
10312 @code{$_isvoid} can be used (@pxref{Convenience Funs,, Convenience
10313 Functions}). For example, considering the following source code:
10316 #include <signal.h>
10319 main (int argc, char *argv[])
10326 A valid way of telling whether the program being debugged has exited
10327 or signalled would be:
10330 (@value{GDBP}) define has_exited_or_signalled
10331 Type commands for definition of ``has_exited_or_signalled''.
10332 End with a line saying just ``end''.
10333 >if $_isvoid ($_exitsignal)
10334 >echo The program has exited\n
10336 >echo The program has signalled\n
10342 Program terminated with signal SIGALRM, Alarm clock.
10343 The program no longer exists.
10344 (@value{GDBP}) has_exited_or_signalled
10345 The program has signalled
10348 As can be seen, @value{GDBN} correctly informs that the program being
10349 debugged has signalled, since it calls @code{raise} and raises a
10350 @code{SIGALRM} signal. If the program being debugged had not called
10351 @code{raise}, then @value{GDBN} would report a normal exit:
10354 (@value{GDBP}) has_exited_or_signalled
10355 The program has exited
10359 The variable @code{$_exception} is set to the exception object being
10360 thrown at an exception-related catchpoint. @xref{Set Catchpoints}.
10363 @itemx $_probe_arg0@dots{}$_probe_arg11
10364 Arguments to a static probe. @xref{Static Probe Points}.
10367 @vindex $_sdata@r{, inspect, convenience variable}
10368 The variable @code{$_sdata} contains extra collected static tracepoint
10369 data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that
10370 @code{$_sdata} could be empty, if not inspecting a trace buffer, or
10371 if extra static tracepoint data has not been collected.
10374 @vindex $_siginfo@r{, convenience variable}
10375 The variable @code{$_siginfo} contains extra signal information
10376 (@pxref{extra signal information}). Note that @code{$_siginfo}
10377 could be empty, if the application has not yet received any signals.
10378 For example, it will be empty before you execute the @code{run} command.
10381 @vindex $_tlb@r{, convenience variable}
10382 The variable @code{$_tlb} is automatically set when debugging
10383 applications running on MS-Windows in native mode or connected to
10384 gdbserver that supports the @code{qGetTIBAddr} request.
10385 @xref{General Query Packets}.
10386 This variable contains the address of the thread information block.
10390 On HP-UX systems, if you refer to a function or variable name that
10391 begins with a dollar sign, @value{GDBN} searches for a user or system
10392 name first, before it searches for a convenience variable.
10394 @node Convenience Funs
10395 @section Convenience Functions
10397 @cindex convenience functions
10398 @value{GDBN} also supplies some @dfn{convenience functions}. These
10399 have a syntax similar to convenience variables. A convenience
10400 function can be used in an expression just like an ordinary function;
10401 however, a convenience function is implemented internally to
10404 These functions do not require @value{GDBN} to be configured with
10405 @code{Python} support, which means that they are always available.
10409 @item $_isvoid (@var{expr})
10410 @findex $_isvoid@r{, convenience function}
10411 Return one if the expression @var{expr} is @code{void}. Otherwise it
10414 A @code{void} expression is an expression where the type of the result
10415 is @code{void}. For example, you can examine a convenience variable
10416 (see @ref{Convenience Vars,, Convenience Variables}) to check whether
10420 (@value{GDBP}) print $_exitcode
10422 (@value{GDBP}) print $_isvoid ($_exitcode)
10425 Starting program: ./a.out
10426 [Inferior 1 (process 29572) exited normally]
10427 (@value{GDBP}) print $_exitcode
10429 (@value{GDBP}) print $_isvoid ($_exitcode)
10433 In the example above, we used @code{$_isvoid} to check whether
10434 @code{$_exitcode} is @code{void} before and after the execution of the
10435 program being debugged. Before the execution there is no exit code to
10436 be examined, therefore @code{$_exitcode} is @code{void}. After the
10437 execution the program being debugged returned zero, therefore
10438 @code{$_exitcode} is zero, which means that it is not @code{void}
10441 The @code{void} expression can also be a call of a function from the
10442 program being debugged. For example, given the following function:
10451 The result of calling it inside @value{GDBN} is @code{void}:
10454 (@value{GDBP}) print foo ()
10456 (@value{GDBP}) print $_isvoid (foo ())
10458 (@value{GDBP}) set $v = foo ()
10459 (@value{GDBP}) print $v
10461 (@value{GDBP}) print $_isvoid ($v)
10467 These functions require @value{GDBN} to be configured with
10468 @code{Python} support.
10472 @item $_memeq(@var{buf1}, @var{buf2}, @var{length})
10473 @findex $_memeq@r{, convenience function}
10474 Returns one if the @var{length} bytes at the addresses given by
10475 @var{buf1} and @var{buf2} are equal.
10476 Otherwise it returns zero.
10478 @item $_regex(@var{str}, @var{regex})
10479 @findex $_regex@r{, convenience function}
10480 Returns one if the string @var{str} matches the regular expression
10481 @var{regex}. Otherwise it returns zero.
10482 The syntax of the regular expression is that specified by @code{Python}'s
10483 regular expression support.
10485 @item $_streq(@var{str1}, @var{str2})
10486 @findex $_streq@r{, convenience function}
10487 Returns one if the strings @var{str1} and @var{str2} are equal.
10488 Otherwise it returns zero.
10490 @item $_strlen(@var{str})
10491 @findex $_strlen@r{, convenience function}
10492 Returns the length of string @var{str}.
10494 @item $_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10495 @findex $_caller_is@r{, convenience function}
10496 Returns one if the calling function's name is equal to @var{name}.
10497 Otherwise it returns zero.
10499 If the optional argument @var{number_of_frames} is provided,
10500 it is the number of frames up in the stack to look.
10508 at testsuite/gdb.python/py-caller-is.c:21
10509 #1 0x00000000004005a0 in middle_func ()
10510 at testsuite/gdb.python/py-caller-is.c:27
10511 #2 0x00000000004005ab in top_func ()
10512 at testsuite/gdb.python/py-caller-is.c:33
10513 #3 0x00000000004005b6 in main ()
10514 at testsuite/gdb.python/py-caller-is.c:39
10515 (gdb) print $_caller_is ("middle_func")
10517 (gdb) print $_caller_is ("top_func", 2)
10521 @item $_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10522 @findex $_caller_matches@r{, convenience function}
10523 Returns one if the calling function's name matches the regular expression
10524 @var{regexp}. Otherwise it returns zero.
10526 If the optional argument @var{number_of_frames} is provided,
10527 it is the number of frames up in the stack to look.
10530 @item $_any_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10531 @findex $_any_caller_is@r{, convenience function}
10532 Returns one if any calling function's name is equal to @var{name}.
10533 Otherwise it returns zero.
10535 If the optional argument @var{number_of_frames} is provided,
10536 it is the number of frames up in the stack to look.
10539 This function differs from @code{$_caller_is} in that this function
10540 checks all stack frames from the immediate caller to the frame specified
10541 by @var{number_of_frames}, whereas @code{$_caller_is} only checks the
10542 frame specified by @var{number_of_frames}.
10544 @item $_any_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10545 @findex $_any_caller_matches@r{, convenience function}
10546 Returns one if any calling function's name matches the regular expression
10547 @var{regexp}. Otherwise it returns zero.
10549 If the optional argument @var{number_of_frames} is provided,
10550 it is the number of frames up in the stack to look.
10553 This function differs from @code{$_caller_matches} in that this function
10554 checks all stack frames from the immediate caller to the frame specified
10555 by @var{number_of_frames}, whereas @code{$_caller_matches} only checks the
10556 frame specified by @var{number_of_frames}.
10560 @value{GDBN} provides the ability to list and get help on
10561 convenience functions.
10564 @item help function
10565 @kindex help function
10566 @cindex show all convenience functions
10567 Print a list of all convenience functions.
10574 You can refer to machine register contents, in expressions, as variables
10575 with names starting with @samp{$}. The names of registers are different
10576 for each machine; use @code{info registers} to see the names used on
10580 @kindex info registers
10581 @item info registers
10582 Print the names and values of all registers except floating-point
10583 and vector registers (in the selected stack frame).
10585 @kindex info all-registers
10586 @cindex floating point registers
10587 @item info all-registers
10588 Print the names and values of all registers, including floating-point
10589 and vector registers (in the selected stack frame).
10591 @item info registers @var{regname} @dots{}
10592 Print the @dfn{relativized} value of each specified register @var{regname}.
10593 As discussed in detail below, register values are normally relative to
10594 the selected stack frame. The @var{regname} may be any register name valid on
10595 the machine you are using, with or without the initial @samp{$}.
10598 @anchor{standard registers}
10599 @cindex stack pointer register
10600 @cindex program counter register
10601 @cindex process status register
10602 @cindex frame pointer register
10603 @cindex standard registers
10604 @value{GDBN} has four ``standard'' register names that are available (in
10605 expressions) on most machines---whenever they do not conflict with an
10606 architecture's canonical mnemonics for registers. The register names
10607 @code{$pc} and @code{$sp} are used for the program counter register and
10608 the stack pointer. @code{$fp} is used for a register that contains a
10609 pointer to the current stack frame, and @code{$ps} is used for a
10610 register that contains the processor status. For example,
10611 you could print the program counter in hex with
10618 or print the instruction to be executed next with
10625 or add four to the stack pointer@footnote{This is a way of removing
10626 one word from the stack, on machines where stacks grow downward in
10627 memory (most machines, nowadays). This assumes that the innermost
10628 stack frame is selected; setting @code{$sp} is not allowed when other
10629 stack frames are selected. To pop entire frames off the stack,
10630 regardless of machine architecture, use @code{return};
10631 see @ref{Returning, ,Returning from a Function}.} with
10637 Whenever possible, these four standard register names are available on
10638 your machine even though the machine has different canonical mnemonics,
10639 so long as there is no conflict. The @code{info registers} command
10640 shows the canonical names. For example, on the SPARC, @code{info
10641 registers} displays the processor status register as @code{$psr} but you
10642 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
10643 is an alias for the @sc{eflags} register.
10645 @value{GDBN} always considers the contents of an ordinary register as an
10646 integer when the register is examined in this way. Some machines have
10647 special registers which can hold nothing but floating point; these
10648 registers are considered to have floating point values. There is no way
10649 to refer to the contents of an ordinary register as floating point value
10650 (although you can @emph{print} it as a floating point value with
10651 @samp{print/f $@var{regname}}).
10653 Some registers have distinct ``raw'' and ``virtual'' data formats. This
10654 means that the data format in which the register contents are saved by
10655 the operating system is not the same one that your program normally
10656 sees. For example, the registers of the 68881 floating point
10657 coprocessor are always saved in ``extended'' (raw) format, but all C
10658 programs expect to work with ``double'' (virtual) format. In such
10659 cases, @value{GDBN} normally works with the virtual format only (the format
10660 that makes sense for your program), but the @code{info registers} command
10661 prints the data in both formats.
10663 @cindex SSE registers (x86)
10664 @cindex MMX registers (x86)
10665 Some machines have special registers whose contents can be interpreted
10666 in several different ways. For example, modern x86-based machines
10667 have SSE and MMX registers that can hold several values packed
10668 together in several different formats. @value{GDBN} refers to such
10669 registers in @code{struct} notation:
10672 (@value{GDBP}) print $xmm1
10674 v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@},
10675 v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@},
10676 v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000",
10677 v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@},
10678 v4_int32 = @{0, 20657912, 11, 13@},
10679 v2_int64 = @{88725056443645952, 55834574859@},
10680 uint128 = 0x0000000d0000000b013b36f800000000
10685 To set values of such registers, you need to tell @value{GDBN} which
10686 view of the register you wish to change, as if you were assigning
10687 value to a @code{struct} member:
10690 (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF
10693 Normally, register values are relative to the selected stack frame
10694 (@pxref{Selection, ,Selecting a Frame}). This means that you get the
10695 value that the register would contain if all stack frames farther in
10696 were exited and their saved registers restored. In order to see the
10697 true contents of hardware registers, you must select the innermost
10698 frame (with @samp{frame 0}).
10700 @cindex caller-saved registers
10701 @cindex call-clobbered registers
10702 @cindex volatile registers
10703 @cindex <not saved> values
10704 Usually ABIs reserve some registers as not needed to be saved by the
10705 callee (a.k.a.: ``caller-saved'', ``call-clobbered'' or ``volatile''
10706 registers). It may therefore not be possible for @value{GDBN} to know
10707 the value a register had before the call (in other words, in the outer
10708 frame), if the register value has since been changed by the callee.
10709 @value{GDBN} tries to deduce where the inner frame saved
10710 (``callee-saved'') registers, from the debug info, unwind info, or the
10711 machine code generated by your compiler. If some register is not
10712 saved, and @value{GDBN} knows the register is ``caller-saved'' (via
10713 its own knowledge of the ABI, or because the debug/unwind info
10714 explicitly says the register's value is undefined), @value{GDBN}
10715 displays @w{@samp{<not saved>}} as the register's value. With targets
10716 that @value{GDBN} has no knowledge of the register saving convention,
10717 if a register was not saved by the callee, then its value and location
10718 in the outer frame are assumed to be the same of the inner frame.
10719 This is usually harmless, because if the register is call-clobbered,
10720 the caller either does not care what is in the register after the
10721 call, or has code to restore the value that it does care about. Note,
10722 however, that if you change such a register in the outer frame, you
10723 may also be affecting the inner frame. Also, the more ``outer'' the
10724 frame is you're looking at, the more likely a call-clobbered
10725 register's value is to be wrong, in the sense that it doesn't actually
10726 represent the value the register had just before the call.
10728 @node Floating Point Hardware
10729 @section Floating Point Hardware
10730 @cindex floating point
10732 Depending on the configuration, @value{GDBN} may be able to give
10733 you more information about the status of the floating point hardware.
10738 Display hardware-dependent information about the floating
10739 point unit. The exact contents and layout vary depending on the
10740 floating point chip. Currently, @samp{info float} is supported on
10741 the ARM and x86 machines.
10745 @section Vector Unit
10746 @cindex vector unit
10748 Depending on the configuration, @value{GDBN} may be able to give you
10749 more information about the status of the vector unit.
10752 @kindex info vector
10754 Display information about the vector unit. The exact contents and
10755 layout vary depending on the hardware.
10758 @node OS Information
10759 @section Operating System Auxiliary Information
10760 @cindex OS information
10762 @value{GDBN} provides interfaces to useful OS facilities that can help
10763 you debug your program.
10765 @cindex auxiliary vector
10766 @cindex vector, auxiliary
10767 Some operating systems supply an @dfn{auxiliary vector} to programs at
10768 startup. This is akin to the arguments and environment that you
10769 specify for a program, but contains a system-dependent variety of
10770 binary values that tell system libraries important details about the
10771 hardware, operating system, and process. Each value's purpose is
10772 identified by an integer tag; the meanings are well-known but system-specific.
10773 Depending on the configuration and operating system facilities,
10774 @value{GDBN} may be able to show you this information. For remote
10775 targets, this functionality may further depend on the remote stub's
10776 support of the @samp{qXfer:auxv:read} packet, see
10777 @ref{qXfer auxiliary vector read}.
10782 Display the auxiliary vector of the inferior, which can be either a
10783 live process or a core dump file. @value{GDBN} prints each tag value
10784 numerically, and also shows names and text descriptions for recognized
10785 tags. Some values in the vector are numbers, some bit masks, and some
10786 pointers to strings or other data. @value{GDBN} displays each value in the
10787 most appropriate form for a recognized tag, and in hexadecimal for
10788 an unrecognized tag.
10791 On some targets, @value{GDBN} can access operating system-specific
10792 information and show it to you. The types of information available
10793 will differ depending on the type of operating system running on the
10794 target. The mechanism used to fetch the data is described in
10795 @ref{Operating System Information}. For remote targets, this
10796 functionality depends on the remote stub's support of the
10797 @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}.
10801 @item info os @var{infotype}
10803 Display OS information of the requested type.
10805 On @sc{gnu}/Linux, the following values of @var{infotype} are valid:
10807 @anchor{linux info os infotypes}
10809 @kindex info os cpus
10811 Display the list of all CPUs/cores. For each CPU/core, @value{GDBN} prints
10812 the available fields from /proc/cpuinfo. For each supported architecture
10813 different fields are available. Two common entries are processor which gives
10814 CPU number and bogomips; a system constant that is calculated during
10815 kernel initialization.
10817 @kindex info os files
10819 Display the list of open file descriptors on the target. For each
10820 file descriptor, @value{GDBN} prints the identifier of the process
10821 owning the descriptor, the command of the owning process, the value
10822 of the descriptor, and the target of the descriptor.
10824 @kindex info os modules
10826 Display the list of all loaded kernel modules on the target. For each
10827 module, @value{GDBN} prints the module name, the size of the module in
10828 bytes, the number of times the module is used, the dependencies of the
10829 module, the status of the module, and the address of the loaded module
10832 @kindex info os msg
10834 Display the list of all System V message queues on the target. For each
10835 message queue, @value{GDBN} prints the message queue key, the message
10836 queue identifier, the access permissions, the current number of bytes
10837 on the queue, the current number of messages on the queue, the processes
10838 that last sent and received a message on the queue, the user and group
10839 of the owner and creator of the message queue, the times at which a
10840 message was last sent and received on the queue, and the time at which
10841 the message queue was last changed.
10843 @kindex info os processes
10845 Display the list of processes on the target. For each process,
10846 @value{GDBN} prints the process identifier, the name of the user, the
10847 command corresponding to the process, and the list of processor cores
10848 that the process is currently running on. (To understand what these
10849 properties mean, for this and the following info types, please consult
10850 the general @sc{gnu}/Linux documentation.)
10852 @kindex info os procgroups
10854 Display the list of process groups on the target. For each process,
10855 @value{GDBN} prints the identifier of the process group that it belongs
10856 to, the command corresponding to the process group leader, the process
10857 identifier, and the command line of the process. The list is sorted
10858 first by the process group identifier, then by the process identifier,
10859 so that processes belonging to the same process group are grouped together
10860 and the process group leader is listed first.
10862 @kindex info os semaphores
10864 Display the list of all System V semaphore sets on the target. For each
10865 semaphore set, @value{GDBN} prints the semaphore set key, the semaphore
10866 set identifier, the access permissions, the number of semaphores in the
10867 set, the user and group of the owner and creator of the semaphore set,
10868 and the times at which the semaphore set was operated upon and changed.
10870 @kindex info os shm
10872 Display the list of all System V shared-memory regions on the target.
10873 For each shared-memory region, @value{GDBN} prints the region key,
10874 the shared-memory identifier, the access permissions, the size of the
10875 region, the process that created the region, the process that last
10876 attached to or detached from the region, the current number of live
10877 attaches to the region, and the times at which the region was last
10878 attached to, detach from, and changed.
10880 @kindex info os sockets
10882 Display the list of Internet-domain sockets on the target. For each
10883 socket, @value{GDBN} prints the address and port of the local and
10884 remote endpoints, the current state of the connection, the creator of
10885 the socket, the IP address family of the socket, and the type of the
10888 @kindex info os threads
10890 Display the list of threads running on the target. For each thread,
10891 @value{GDBN} prints the identifier of the process that the thread
10892 belongs to, the command of the process, the thread identifier, and the
10893 processor core that it is currently running on. The main thread of a
10894 process is not listed.
10898 If @var{infotype} is omitted, then list the possible values for
10899 @var{infotype} and the kind of OS information available for each
10900 @var{infotype}. If the target does not return a list of possible
10901 types, this command will report an error.
10904 @node Memory Region Attributes
10905 @section Memory Region Attributes
10906 @cindex memory region attributes
10908 @dfn{Memory region attributes} allow you to describe special handling
10909 required by regions of your target's memory. @value{GDBN} uses
10910 attributes to determine whether to allow certain types of memory
10911 accesses; whether to use specific width accesses; and whether to cache
10912 target memory. By default the description of memory regions is
10913 fetched from the target (if the current target supports this), but the
10914 user can override the fetched regions.
10916 Defined memory regions can be individually enabled and disabled. When a
10917 memory region is disabled, @value{GDBN} uses the default attributes when
10918 accessing memory in that region. Similarly, if no memory regions have
10919 been defined, @value{GDBN} uses the default attributes when accessing
10922 When a memory region is defined, it is given a number to identify it;
10923 to enable, disable, or remove a memory region, you specify that number.
10927 @item mem @var{lower} @var{upper} @var{attributes}@dots{}
10928 Define a memory region bounded by @var{lower} and @var{upper} with
10929 attributes @var{attributes}@dots{}, and add it to the list of regions
10930 monitored by @value{GDBN}. Note that @var{upper} == 0 is a special
10931 case: it is treated as the target's maximum memory address.
10932 (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.)
10935 Discard any user changes to the memory regions and use target-supplied
10936 regions, if available, or no regions if the target does not support.
10939 @item delete mem @var{nums}@dots{}
10940 Remove memory regions @var{nums}@dots{} from the list of regions
10941 monitored by @value{GDBN}.
10943 @kindex disable mem
10944 @item disable mem @var{nums}@dots{}
10945 Disable monitoring of memory regions @var{nums}@dots{}.
10946 A disabled memory region is not forgotten.
10947 It may be enabled again later.
10950 @item enable mem @var{nums}@dots{}
10951 Enable monitoring of memory regions @var{nums}@dots{}.
10955 Print a table of all defined memory regions, with the following columns
10959 @item Memory Region Number
10960 @item Enabled or Disabled.
10961 Enabled memory regions are marked with @samp{y}.
10962 Disabled memory regions are marked with @samp{n}.
10965 The address defining the inclusive lower bound of the memory region.
10968 The address defining the exclusive upper bound of the memory region.
10971 The list of attributes set for this memory region.
10976 @subsection Attributes
10978 @subsubsection Memory Access Mode
10979 The access mode attributes set whether @value{GDBN} may make read or
10980 write accesses to a memory region.
10982 While these attributes prevent @value{GDBN} from performing invalid
10983 memory accesses, they do nothing to prevent the target system, I/O DMA,
10984 etc.@: from accessing memory.
10988 Memory is read only.
10990 Memory is write only.
10992 Memory is read/write. This is the default.
10995 @subsubsection Memory Access Size
10996 The access size attribute tells @value{GDBN} to use specific sized
10997 accesses in the memory region. Often memory mapped device registers
10998 require specific sized accesses. If no access size attribute is
10999 specified, @value{GDBN} may use accesses of any size.
11003 Use 8 bit memory accesses.
11005 Use 16 bit memory accesses.
11007 Use 32 bit memory accesses.
11009 Use 64 bit memory accesses.
11012 @c @subsubsection Hardware/Software Breakpoints
11013 @c The hardware/software breakpoint attributes set whether @value{GDBN}
11014 @c will use hardware or software breakpoints for the internal breakpoints
11015 @c used by the step, next, finish, until, etc. commands.
11019 @c Always use hardware breakpoints
11020 @c @item swbreak (default)
11023 @subsubsection Data Cache
11024 The data cache attributes set whether @value{GDBN} will cache target
11025 memory. While this generally improves performance by reducing debug
11026 protocol overhead, it can lead to incorrect results because @value{GDBN}
11027 does not know about volatile variables or memory mapped device
11032 Enable @value{GDBN} to cache target memory.
11034 Disable @value{GDBN} from caching target memory. This is the default.
11037 @subsection Memory Access Checking
11038 @value{GDBN} can be instructed to refuse accesses to memory that is
11039 not explicitly described. This can be useful if accessing such
11040 regions has undesired effects for a specific target, or to provide
11041 better error checking. The following commands control this behaviour.
11044 @kindex set mem inaccessible-by-default
11045 @item set mem inaccessible-by-default [on|off]
11046 If @code{on} is specified, make @value{GDBN} treat memory not
11047 explicitly described by the memory ranges as non-existent and refuse accesses
11048 to such memory. The checks are only performed if there's at least one
11049 memory range defined. If @code{off} is specified, make @value{GDBN}
11050 treat the memory not explicitly described by the memory ranges as RAM.
11051 The default value is @code{on}.
11052 @kindex show mem inaccessible-by-default
11053 @item show mem inaccessible-by-default
11054 Show the current handling of accesses to unknown memory.
11058 @c @subsubsection Memory Write Verification
11059 @c The memory write verification attributes set whether @value{GDBN}
11060 @c will re-reads data after each write to verify the write was successful.
11064 @c @item noverify (default)
11067 @node Dump/Restore Files
11068 @section Copy Between Memory and a File
11069 @cindex dump/restore files
11070 @cindex append data to a file
11071 @cindex dump data to a file
11072 @cindex restore data from a file
11074 You can use the commands @code{dump}, @code{append}, and
11075 @code{restore} to copy data between target memory and a file. The
11076 @code{dump} and @code{append} commands write data to a file, and the
11077 @code{restore} command reads data from a file back into the inferior's
11078 memory. Files may be in binary, Motorola S-record, Intel hex,
11079 Tektronix Hex, or Verilog Hex format; however, @value{GDBN} can only
11080 append to binary files, and cannot read from Verilog Hex files.
11085 @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11086 @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr}
11087 Dump the contents of memory from @var{start_addr} to @var{end_addr},
11088 or the value of @var{expr}, to @var{filename} in the given format.
11090 The @var{format} parameter may be any one of:
11097 Motorola S-record format.
11099 Tektronix Hex format.
11101 Verilog Hex format.
11104 @value{GDBN} uses the same definitions of these formats as the
11105 @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If
11106 @var{format} is omitted, @value{GDBN} dumps the data in raw binary
11110 @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11111 @itemx append @r{[}binary@r{]} value @var{filename} @var{expr}
11112 Append the contents of memory from @var{start_addr} to @var{end_addr},
11113 or the value of @var{expr}, to the file @var{filename}, in raw binary form.
11114 (@value{GDBN} can only append data to files in raw binary form.)
11117 @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end}
11118 Restore the contents of file @var{filename} into memory. The
11119 @code{restore} command can automatically recognize any known @sc{bfd}
11120 file format, except for raw binary. To restore a raw binary file you
11121 must specify the optional keyword @code{binary} after the filename.
11123 If @var{bias} is non-zero, its value will be added to the addresses
11124 contained in the file. Binary files always start at address zero, so
11125 they will be restored at address @var{bias}. Other bfd files have
11126 a built-in location; they will be restored at offset @var{bias}
11127 from that location.
11129 If @var{start} and/or @var{end} are non-zero, then only data between
11130 file offset @var{start} and file offset @var{end} will be restored.
11131 These offsets are relative to the addresses in the file, before
11132 the @var{bias} argument is applied.
11136 @node Core File Generation
11137 @section How to Produce a Core File from Your Program
11138 @cindex dump core from inferior
11140 A @dfn{core file} or @dfn{core dump} is a file that records the memory
11141 image of a running process and its process status (register values
11142 etc.). Its primary use is post-mortem debugging of a program that
11143 crashed while it ran outside a debugger. A program that crashes
11144 automatically produces a core file, unless this feature is disabled by
11145 the user. @xref{Files}, for information on invoking @value{GDBN} in
11146 the post-mortem debugging mode.
11148 Occasionally, you may wish to produce a core file of the program you
11149 are debugging in order to preserve a snapshot of its state.
11150 @value{GDBN} has a special command for that.
11154 @kindex generate-core-file
11155 @item generate-core-file [@var{file}]
11156 @itemx gcore [@var{file}]
11157 Produce a core dump of the inferior process. The optional argument
11158 @var{file} specifies the file name where to put the core dump. If not
11159 specified, the file name defaults to @file{core.@var{pid}}, where
11160 @var{pid} is the inferior process ID.
11162 Note that this command is implemented only for some systems (as of
11163 this writing, @sc{gnu}/Linux, FreeBSD, Solaris, and S390).
11165 On @sc{gnu}/Linux, this command can take into account the value of the
11166 file @file{/proc/@var{pid}/coredump_filter} when generating the core
11167 dump (@pxref{set use-coredump-filter}).
11169 @kindex set use-coredump-filter
11170 @anchor{set use-coredump-filter}
11171 @item set use-coredump-filter on
11172 @itemx set use-coredump-filter off
11173 Enable or disable the use of the file
11174 @file{/proc/@var{pid}/coredump_filter} when generating core dump
11175 files. This file is used by the Linux kernel to decide what types of
11176 memory mappings will be dumped or ignored when generating a core dump
11177 file. @var{pid} is the process ID of a currently running process.
11179 To make use of this feature, you have to write in the
11180 @file{/proc/@var{pid}/coredump_filter} file a value, in hexadecimal,
11181 which is a bit mask representing the memory mapping types. If a bit
11182 is set in the bit mask, then the memory mappings of the corresponding
11183 types will be dumped; otherwise, they will be ignored. This
11184 configuration is inherited by child processes. For more information
11185 about the bits that can be set in the
11186 @file{/proc/@var{pid}/coredump_filter} file, please refer to the
11187 manpage of @code{core(5)}.
11189 By default, this option is @code{on}. If this option is turned
11190 @code{off}, @value{GDBN} does not read the @file{coredump_filter} file
11191 and instead uses the same default value as the Linux kernel in order
11192 to decide which pages will be dumped in the core dump file. This
11193 value is currently @code{0x33}, which means that bits @code{0}
11194 (anonymous private mappings), @code{1} (anonymous shared mappings),
11195 @code{4} (ELF headers) and @code{5} (private huge pages) are active.
11196 This will cause these memory mappings to be dumped automatically.
11199 @node Character Sets
11200 @section Character Sets
11201 @cindex character sets
11203 @cindex translating between character sets
11204 @cindex host character set
11205 @cindex target character set
11207 If the program you are debugging uses a different character set to
11208 represent characters and strings than the one @value{GDBN} uses itself,
11209 @value{GDBN} can automatically translate between the character sets for
11210 you. The character set @value{GDBN} uses we call the @dfn{host
11211 character set}; the one the inferior program uses we call the
11212 @dfn{target character set}.
11214 For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which
11215 uses the ISO Latin 1 character set, but you are using @value{GDBN}'s
11216 remote protocol (@pxref{Remote Debugging}) to debug a program
11217 running on an IBM mainframe, which uses the @sc{ebcdic} character set,
11218 then the host character set is Latin-1, and the target character set is
11219 @sc{ebcdic}. If you give @value{GDBN} the command @code{set
11220 target-charset EBCDIC-US}, then @value{GDBN} translates between
11221 @sc{ebcdic} and Latin 1 as you print character or string values, or use
11222 character and string literals in expressions.
11224 @value{GDBN} has no way to automatically recognize which character set
11225 the inferior program uses; you must tell it, using the @code{set
11226 target-charset} command, described below.
11228 Here are the commands for controlling @value{GDBN}'s character set
11232 @item set target-charset @var{charset}
11233 @kindex set target-charset
11234 Set the current target character set to @var{charset}. To display the
11235 list of supported target character sets, type
11236 @kbd{@w{set target-charset @key{TAB}@key{TAB}}}.
11238 @item set host-charset @var{charset}
11239 @kindex set host-charset
11240 Set the current host character set to @var{charset}.
11242 By default, @value{GDBN} uses a host character set appropriate to the
11243 system it is running on; you can override that default using the
11244 @code{set host-charset} command. On some systems, @value{GDBN} cannot
11245 automatically determine the appropriate host character set. In this
11246 case, @value{GDBN} uses @samp{UTF-8}.
11248 @value{GDBN} can only use certain character sets as its host character
11249 set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}},
11250 @value{GDBN} will list the host character sets it supports.
11252 @item set charset @var{charset}
11253 @kindex set charset
11254 Set the current host and target character sets to @var{charset}. As
11255 above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}},
11256 @value{GDBN} will list the names of the character sets that can be used
11257 for both host and target.
11260 @kindex show charset
11261 Show the names of the current host and target character sets.
11263 @item show host-charset
11264 @kindex show host-charset
11265 Show the name of the current host character set.
11267 @item show target-charset
11268 @kindex show target-charset
11269 Show the name of the current target character set.
11271 @item set target-wide-charset @var{charset}
11272 @kindex set target-wide-charset
11273 Set the current target's wide character set to @var{charset}. This is
11274 the character set used by the target's @code{wchar_t} type. To
11275 display the list of supported wide character sets, type
11276 @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}.
11278 @item show target-wide-charset
11279 @kindex show target-wide-charset
11280 Show the name of the current target's wide character set.
11283 Here is an example of @value{GDBN}'s character set support in action.
11284 Assume that the following source code has been placed in the file
11285 @file{charset-test.c}:
11291 = @{72, 101, 108, 108, 111, 44, 32, 119,
11292 111, 114, 108, 100, 33, 10, 0@};
11293 char ibm1047_hello[]
11294 = @{200, 133, 147, 147, 150, 107, 64, 166,
11295 150, 153, 147, 132, 90, 37, 0@};
11299 printf ("Hello, world!\n");
11303 In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays
11304 containing the string @samp{Hello, world!} followed by a newline,
11305 encoded in the @sc{ascii} and @sc{ibm1047} character sets.
11307 We compile the program, and invoke the debugger on it:
11310 $ gcc -g charset-test.c -o charset-test
11311 $ gdb -nw charset-test
11312 GNU gdb 2001-12-19-cvs
11313 Copyright 2001 Free Software Foundation, Inc.
11318 We can use the @code{show charset} command to see what character sets
11319 @value{GDBN} is currently using to interpret and display characters and
11323 (@value{GDBP}) show charset
11324 The current host and target character set is `ISO-8859-1'.
11328 For the sake of printing this manual, let's use @sc{ascii} as our
11329 initial character set:
11331 (@value{GDBP}) set charset ASCII
11332 (@value{GDBP}) show charset
11333 The current host and target character set is `ASCII'.
11337 Let's assume that @sc{ascii} is indeed the correct character set for our
11338 host system --- in other words, let's assume that if @value{GDBN} prints
11339 characters using the @sc{ascii} character set, our terminal will display
11340 them properly. Since our current target character set is also
11341 @sc{ascii}, the contents of @code{ascii_hello} print legibly:
11344 (@value{GDBP}) print ascii_hello
11345 $1 = 0x401698 "Hello, world!\n"
11346 (@value{GDBP}) print ascii_hello[0]
11351 @value{GDBN} uses the target character set for character and string
11352 literals you use in expressions:
11355 (@value{GDBP}) print '+'
11360 The @sc{ascii} character set uses the number 43 to encode the @samp{+}
11363 @value{GDBN} relies on the user to tell it which character set the
11364 target program uses. If we print @code{ibm1047_hello} while our target
11365 character set is still @sc{ascii}, we get jibberish:
11368 (@value{GDBP}) print ibm1047_hello
11369 $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%"
11370 (@value{GDBP}) print ibm1047_hello[0]
11375 If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB},
11376 @value{GDBN} tells us the character sets it supports:
11379 (@value{GDBP}) set target-charset
11380 ASCII EBCDIC-US IBM1047 ISO-8859-1
11381 (@value{GDBP}) set target-charset
11384 We can select @sc{ibm1047} as our target character set, and examine the
11385 program's strings again. Now the @sc{ascii} string is wrong, but
11386 @value{GDBN} translates the contents of @code{ibm1047_hello} from the
11387 target character set, @sc{ibm1047}, to the host character set,
11388 @sc{ascii}, and they display correctly:
11391 (@value{GDBP}) set target-charset IBM1047
11392 (@value{GDBP}) show charset
11393 The current host character set is `ASCII'.
11394 The current target character set is `IBM1047'.
11395 (@value{GDBP}) print ascii_hello
11396 $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012"
11397 (@value{GDBP}) print ascii_hello[0]
11399 (@value{GDBP}) print ibm1047_hello
11400 $8 = 0x4016a8 "Hello, world!\n"
11401 (@value{GDBP}) print ibm1047_hello[0]
11406 As above, @value{GDBN} uses the target character set for character and
11407 string literals you use in expressions:
11410 (@value{GDBP}) print '+'
11415 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
11418 @node Caching Target Data
11419 @section Caching Data of Targets
11420 @cindex caching data of targets
11422 @value{GDBN} caches data exchanged between the debugger and a target.
11423 Each cache is associated with the address space of the inferior.
11424 @xref{Inferiors and Programs}, about inferior and address space.
11425 Such caching generally improves performance in remote debugging
11426 (@pxref{Remote Debugging}), because it reduces the overhead of the
11427 remote protocol by bundling memory reads and writes into large chunks.
11428 Unfortunately, simply caching everything would lead to incorrect results,
11429 since @value{GDBN} does not necessarily know anything about volatile
11430 values, memory-mapped I/O addresses, etc. Furthermore, in non-stop mode
11431 (@pxref{Non-Stop Mode}) memory can be changed @emph{while} a gdb command
11433 Therefore, by default, @value{GDBN} only caches data
11434 known to be on the stack@footnote{In non-stop mode, it is moderately
11435 rare for a running thread to modify the stack of a stopped thread
11436 in a way that would interfere with a backtrace, and caching of
11437 stack reads provides a significant speed up of remote backtraces.} or
11438 in the code segment.
11439 Other regions of memory can be explicitly marked as
11440 cacheable; @pxref{Memory Region Attributes}.
11443 @kindex set remotecache
11444 @item set remotecache on
11445 @itemx set remotecache off
11446 This option no longer does anything; it exists for compatibility
11449 @kindex show remotecache
11450 @item show remotecache
11451 Show the current state of the obsolete remotecache flag.
11453 @kindex set stack-cache
11454 @item set stack-cache on
11455 @itemx set stack-cache off
11456 Enable or disable caching of stack accesses. When @code{on}, use
11457 caching. By default, this option is @code{on}.
11459 @kindex show stack-cache
11460 @item show stack-cache
11461 Show the current state of data caching for memory accesses.
11463 @kindex set code-cache
11464 @item set code-cache on
11465 @itemx set code-cache off
11466 Enable or disable caching of code segment accesses. When @code{on},
11467 use caching. By default, this option is @code{on}. This improves
11468 performance of disassembly in remote debugging.
11470 @kindex show code-cache
11471 @item show code-cache
11472 Show the current state of target memory cache for code segment
11475 @kindex info dcache
11476 @item info dcache @r{[}line@r{]}
11477 Print the information about the performance of data cache of the
11478 current inferior's address space. The information displayed
11479 includes the dcache width and depth, and for each cache line, its
11480 number, address, and how many times it was referenced. This
11481 command is useful for debugging the data cache operation.
11483 If a line number is specified, the contents of that line will be
11486 @item set dcache size @var{size}
11487 @cindex dcache size
11488 @kindex set dcache size
11489 Set maximum number of entries in dcache (dcache depth above).
11491 @item set dcache line-size @var{line-size}
11492 @cindex dcache line-size
11493 @kindex set dcache line-size
11494 Set number of bytes each dcache entry caches (dcache width above).
11495 Must be a power of 2.
11497 @item show dcache size
11498 @kindex show dcache size
11499 Show maximum number of dcache entries. @xref{Caching Target Data, info dcache}.
11501 @item show dcache line-size
11502 @kindex show dcache line-size
11503 Show default size of dcache lines.
11507 @node Searching Memory
11508 @section Search Memory
11509 @cindex searching memory
11511 Memory can be searched for a particular sequence of bytes with the
11512 @code{find} command.
11516 @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11517 @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11518 Search memory for the sequence of bytes specified by @var{val1}, @var{val2},
11519 etc. The search begins at address @var{start_addr} and continues for either
11520 @var{len} bytes or through to @var{end_addr} inclusive.
11523 @var{s} and @var{n} are optional parameters.
11524 They may be specified in either order, apart or together.
11527 @item @var{s}, search query size
11528 The size of each search query value.
11534 halfwords (two bytes)
11538 giant words (eight bytes)
11541 All values are interpreted in the current language.
11542 This means, for example, that if the current source language is C/C@t{++}
11543 then searching for the string ``hello'' includes the trailing '\0'.
11545 If the value size is not specified, it is taken from the
11546 value's type in the current language.
11547 This is useful when one wants to specify the search
11548 pattern as a mixture of types.
11549 Note that this means, for example, that in the case of C-like languages
11550 a search for an untyped 0x42 will search for @samp{(int) 0x42}
11551 which is typically four bytes.
11553 @item @var{n}, maximum number of finds
11554 The maximum number of matches to print. The default is to print all finds.
11557 You can use strings as search values. Quote them with double-quotes
11559 The string value is copied into the search pattern byte by byte,
11560 regardless of the endianness of the target and the size specification.
11562 The address of each match found is printed as well as a count of the
11563 number of matches found.
11565 The address of the last value found is stored in convenience variable
11567 A count of the number of matches is stored in @samp{$numfound}.
11569 For example, if stopped at the @code{printf} in this function:
11575 static char hello[] = "hello-hello";
11576 static struct @{ char c; short s; int i; @}
11577 __attribute__ ((packed)) mixed
11578 = @{ 'c', 0x1234, 0x87654321 @};
11579 printf ("%s\n", hello);
11584 you get during debugging:
11587 (gdb) find &hello[0], +sizeof(hello), "hello"
11588 0x804956d <hello.1620+6>
11590 (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o'
11591 0x8049567 <hello.1620>
11592 0x804956d <hello.1620+6>
11594 (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l'
11595 0x8049567 <hello.1620>
11597 (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321
11598 0x8049560 <mixed.1625>
11600 (gdb) print $numfound
11603 $2 = (void *) 0x8049560
11606 @node Optimized Code
11607 @chapter Debugging Optimized Code
11608 @cindex optimized code, debugging
11609 @cindex debugging optimized code
11611 Almost all compilers support optimization. With optimization
11612 disabled, the compiler generates assembly code that corresponds
11613 directly to your source code, in a simplistic way. As the compiler
11614 applies more powerful optimizations, the generated assembly code
11615 diverges from your original source code. With help from debugging
11616 information generated by the compiler, @value{GDBN} can map from
11617 the running program back to constructs from your original source.
11619 @value{GDBN} is more accurate with optimization disabled. If you
11620 can recompile without optimization, it is easier to follow the
11621 progress of your program during debugging. But, there are many cases
11622 where you may need to debug an optimized version.
11624 When you debug a program compiled with @samp{-g -O}, remember that the
11625 optimizer has rearranged your code; the debugger shows you what is
11626 really there. Do not be too surprised when the execution path does not
11627 exactly match your source file! An extreme example: if you define a
11628 variable, but never use it, @value{GDBN} never sees that
11629 variable---because the compiler optimizes it out of existence.
11631 Some things do not work as well with @samp{-g -O} as with just
11632 @samp{-g}, particularly on machines with instruction scheduling. If in
11633 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
11634 please report it to us as a bug (including a test case!).
11635 @xref{Variables}, for more information about debugging optimized code.
11638 * Inline Functions:: How @value{GDBN} presents inlining
11639 * Tail Call Frames:: @value{GDBN} analysis of jumps to functions
11642 @node Inline Functions
11643 @section Inline Functions
11644 @cindex inline functions, debugging
11646 @dfn{Inlining} is an optimization that inserts a copy of the function
11647 body directly at each call site, instead of jumping to a shared
11648 routine. @value{GDBN} displays inlined functions just like
11649 non-inlined functions. They appear in backtraces. You can view their
11650 arguments and local variables, step into them with @code{step}, skip
11651 them with @code{next}, and escape from them with @code{finish}.
11652 You can check whether a function was inlined by using the
11653 @code{info frame} command.
11655 For @value{GDBN} to support inlined functions, the compiler must
11656 record information about inlining in the debug information ---
11657 @value{NGCC} using the @sc{dwarf 2} format does this, and several
11658 other compilers do also. @value{GDBN} only supports inlined functions
11659 when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1
11660 do not emit two required attributes (@samp{DW_AT_call_file} and
11661 @samp{DW_AT_call_line}); @value{GDBN} does not display inlined
11662 function calls with earlier versions of @value{NGCC}. It instead
11663 displays the arguments and local variables of inlined functions as
11664 local variables in the caller.
11666 The body of an inlined function is directly included at its call site;
11667 unlike a non-inlined function, there are no instructions devoted to
11668 the call. @value{GDBN} still pretends that the call site and the
11669 start of the inlined function are different instructions. Stepping to
11670 the call site shows the call site, and then stepping again shows
11671 the first line of the inlined function, even though no additional
11672 instructions are executed.
11674 This makes source-level debugging much clearer; you can see both the
11675 context of the call and then the effect of the call. Only stepping by
11676 a single instruction using @code{stepi} or @code{nexti} does not do
11677 this; single instruction steps always show the inlined body.
11679 There are some ways that @value{GDBN} does not pretend that inlined
11680 function calls are the same as normal calls:
11684 Setting breakpoints at the call site of an inlined function may not
11685 work, because the call site does not contain any code. @value{GDBN}
11686 may incorrectly move the breakpoint to the next line of the enclosing
11687 function, after the call. This limitation will be removed in a future
11688 version of @value{GDBN}; until then, set a breakpoint on an earlier line
11689 or inside the inlined function instead.
11692 @value{GDBN} cannot locate the return value of inlined calls after
11693 using the @code{finish} command. This is a limitation of compiler-generated
11694 debugging information; after @code{finish}, you can step to the next line
11695 and print a variable where your program stored the return value.
11699 @node Tail Call Frames
11700 @section Tail Call Frames
11701 @cindex tail call frames, debugging
11703 Function @code{B} can call function @code{C} in its very last statement. In
11704 unoptimized compilation the call of @code{C} is immediately followed by return
11705 instruction at the end of @code{B} code. Optimizing compiler may replace the
11706 call and return in function @code{B} into one jump to function @code{C}
11707 instead. Such use of a jump instruction is called @dfn{tail call}.
11709 During execution of function @code{C}, there will be no indication in the
11710 function call stack frames that it was tail-called from @code{B}. If function
11711 @code{A} regularly calls function @code{B} which tail-calls function @code{C},
11712 then @value{GDBN} will see @code{A} as the caller of @code{C}. However, in
11713 some cases @value{GDBN} can determine that @code{C} was tail-called from
11714 @code{B}, and it will then create fictitious call frame for that, with the
11715 return address set up as if @code{B} called @code{C} normally.
11717 This functionality is currently supported only by DWARF 2 debugging format and
11718 the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With
11719 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
11722 @kbd{info frame} command (@pxref{Frame Info}) will indicate the tail call frame
11723 kind by text @code{tail call frame} such as in this sample @value{GDBN} output:
11727 0x40066b <b(int, double)+11>: jmp 0x400640 <c(int, double)>
11729 Stack level 1, frame at 0x7fffffffda30:
11730 rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5
11731 tail call frame, caller of frame at 0x7fffffffda30
11732 source language c++.
11733 Arglist at unknown address.
11734 Locals at unknown address, Previous frame's sp is 0x7fffffffda30
11737 The detection of all the possible code path executions can find them ambiguous.
11738 There is no execution history stored (possible @ref{Reverse Execution} is never
11739 used for this purpose) and the last known caller could have reached the known
11740 callee by multiple different jump sequences. In such case @value{GDBN} still
11741 tries to show at least all the unambiguous top tail callers and all the
11742 unambiguous bottom tail calees, if any.
11745 @anchor{set debug entry-values}
11746 @item set debug entry-values
11747 @kindex set debug entry-values
11748 When set to on, enables printing of analysis messages for both frame argument
11749 values at function entry and tail calls. It will show all the possible valid
11750 tail calls code paths it has considered. It will also print the intersection
11751 of them with the final unambiguous (possibly partial or even empty) code path
11754 @item show debug entry-values
11755 @kindex show debug entry-values
11756 Show the current state of analysis messages printing for both frame argument
11757 values at function entry and tail calls.
11760 The analysis messages for tail calls can for example show why the virtual tail
11761 call frame for function @code{c} has not been recognized (due to the indirect
11762 reference by variable @code{x}):
11765 static void __attribute__((noinline, noclone)) c (void);
11766 void (*x) (void) = c;
11767 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
11768 static void __attribute__((noinline, noclone)) c (void) @{ a (); @}
11769 int main (void) @{ x (); return 0; @}
11771 Breakpoint 1, DW_OP_GNU_entry_value resolving cannot find
11772 DW_TAG_GNU_call_site 0x40039a in main
11774 3 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
11777 #1 0x000000000040039a in main () at t.c:5
11780 Another possibility is an ambiguous virtual tail call frames resolution:
11784 static void __attribute__((noinline, noclone)) f (void) @{ i++; @}
11785 static void __attribute__((noinline, noclone)) e (void) @{ f (); @}
11786 static void __attribute__((noinline, noclone)) d (void) @{ f (); @}
11787 static void __attribute__((noinline, noclone)) c (void) @{ d (); @}
11788 static void __attribute__((noinline, noclone)) b (void)
11789 @{ if (i) c (); else e (); @}
11790 static void __attribute__((noinline, noclone)) a (void) @{ b (); @}
11791 int main (void) @{ a (); return 0; @}
11793 tailcall: initial: 0x4004d2(a) 0x4004ce(b) 0x4004b2(c) 0x4004a2(d)
11794 tailcall: compare: 0x4004d2(a) 0x4004cc(b) 0x400492(e)
11795 tailcall: reduced: 0x4004d2(a) |
11798 #1 0x00000000004004d2 in a () at t.c:8
11799 #2 0x0000000000400395 in main () at t.c:9
11802 @set CALLSEQ1A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}c@value{ARROW}d@value{ARROW}f}
11803 @set CALLSEQ2A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}e@value{ARROW}f}
11805 @c Convert CALLSEQ#A to CALLSEQ#B depending on HAVE_MAKEINFO_CLICK.
11806 @ifset HAVE_MAKEINFO_CLICK
11807 @set ARROW @click{}
11808 @set CALLSEQ1B @clicksequence{@value{CALLSEQ1A}}
11809 @set CALLSEQ2B @clicksequence{@value{CALLSEQ2A}}
11811 @ifclear HAVE_MAKEINFO_CLICK
11813 @set CALLSEQ1B @value{CALLSEQ1A}
11814 @set CALLSEQ2B @value{CALLSEQ2A}
11817 Frames #0 and #2 are real, #1 is a virtual tail call frame.
11818 The code can have possible execution paths @value{CALLSEQ1B} or
11819 @value{CALLSEQ2B}, @value{GDBN} cannot find which one from the inferior state.
11821 @code{initial:} state shows some random possible calling sequence @value{GDBN}
11822 has found. It then finds another possible calling sequcen - that one is
11823 prefixed by @code{compare:}. The non-ambiguous intersection of these two is
11824 printed as the @code{reduced:} calling sequence. That one could have many
11825 futher @code{compare:} and @code{reduced:} statements as long as there remain
11826 any non-ambiguous sequence entries.
11828 For the frame of function @code{b} in both cases there are different possible
11829 @code{$pc} values (@code{0x4004cc} or @code{0x4004ce}), therefore this frame is
11830 also ambigous. The only non-ambiguous frame is the one for function @code{a},
11831 therefore this one is displayed to the user while the ambiguous frames are
11834 There can be also reasons why printing of frame argument values at function
11839 static void __attribute__((noinline, noclone)) c (int i) @{ v++; @}
11840 static void __attribute__((noinline, noclone)) a (int i);
11841 static void __attribute__((noinline, noclone)) b (int i) @{ a (i); @}
11842 static void __attribute__((noinline, noclone)) a (int i)
11843 @{ if (i) b (i - 1); else c (0); @}
11844 int main (void) @{ a (5); return 0; @}
11847 #0 c (i=i@@entry=0) at t.c:2
11848 #1 0x0000000000400428 in a (DW_OP_GNU_entry_value resolving has found
11849 function "a" at 0x400420 can call itself via tail calls
11850 i=<optimized out>) at t.c:6
11851 #2 0x000000000040036e in main () at t.c:7
11854 @value{GDBN} cannot find out from the inferior state if and how many times did
11855 function @code{a} call itself (via function @code{b}) as these calls would be
11856 tail calls. Such tail calls would modify thue @code{i} variable, therefore
11857 @value{GDBN} cannot be sure the value it knows would be right - @value{GDBN}
11858 prints @code{<optimized out>} instead.
11861 @chapter C Preprocessor Macros
11863 Some languages, such as C and C@t{++}, provide a way to define and invoke
11864 ``preprocessor macros'' which expand into strings of tokens.
11865 @value{GDBN} can evaluate expressions containing macro invocations, show
11866 the result of macro expansion, and show a macro's definition, including
11867 where it was defined.
11869 You may need to compile your program specially to provide @value{GDBN}
11870 with information about preprocessor macros. Most compilers do not
11871 include macros in their debugging information, even when you compile
11872 with the @option{-g} flag. @xref{Compilation}.
11874 A program may define a macro at one point, remove that definition later,
11875 and then provide a different definition after that. Thus, at different
11876 points in the program, a macro may have different definitions, or have
11877 no definition at all. If there is a current stack frame, @value{GDBN}
11878 uses the macros in scope at that frame's source code line. Otherwise,
11879 @value{GDBN} uses the macros in scope at the current listing location;
11882 Whenever @value{GDBN} evaluates an expression, it always expands any
11883 macro invocations present in the expression. @value{GDBN} also provides
11884 the following commands for working with macros explicitly.
11888 @kindex macro expand
11889 @cindex macro expansion, showing the results of preprocessor
11890 @cindex preprocessor macro expansion, showing the results of
11891 @cindex expanding preprocessor macros
11892 @item macro expand @var{expression}
11893 @itemx macro exp @var{expression}
11894 Show the results of expanding all preprocessor macro invocations in
11895 @var{expression}. Since @value{GDBN} simply expands macros, but does
11896 not parse the result, @var{expression} need not be a valid expression;
11897 it can be any string of tokens.
11900 @item macro expand-once @var{expression}
11901 @itemx macro exp1 @var{expression}
11902 @cindex expand macro once
11903 @i{(This command is not yet implemented.)} Show the results of
11904 expanding those preprocessor macro invocations that appear explicitly in
11905 @var{expression}. Macro invocations appearing in that expansion are
11906 left unchanged. This command allows you to see the effect of a
11907 particular macro more clearly, without being confused by further
11908 expansions. Since @value{GDBN} simply expands macros, but does not
11909 parse the result, @var{expression} need not be a valid expression; it
11910 can be any string of tokens.
11913 @cindex macro definition, showing
11914 @cindex definition of a macro, showing
11915 @cindex macros, from debug info
11916 @item info macro [-a|-all] [--] @var{macro}
11917 Show the current definition or all definitions of the named @var{macro},
11918 and describe the source location or compiler command-line where that
11919 definition was established. The optional double dash is to signify the end of
11920 argument processing and the beginning of @var{macro} for non C-like macros where
11921 the macro may begin with a hyphen.
11923 @kindex info macros
11924 @item info macros @var{location}
11925 Show all macro definitions that are in effect at the location specified
11926 by @var{location}, and describe the source location or compiler
11927 command-line where those definitions were established.
11929 @kindex macro define
11930 @cindex user-defined macros
11931 @cindex defining macros interactively
11932 @cindex macros, user-defined
11933 @item macro define @var{macro} @var{replacement-list}
11934 @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list}
11935 Introduce a definition for a preprocessor macro named @var{macro},
11936 invocations of which are replaced by the tokens given in
11937 @var{replacement-list}. The first form of this command defines an
11938 ``object-like'' macro, which takes no arguments; the second form
11939 defines a ``function-like'' macro, which takes the arguments given in
11942 A definition introduced by this command is in scope in every
11943 expression evaluated in @value{GDBN}, until it is removed with the
11944 @code{macro undef} command, described below. The definition overrides
11945 all definitions for @var{macro} present in the program being debugged,
11946 as well as any previous user-supplied definition.
11948 @kindex macro undef
11949 @item macro undef @var{macro}
11950 Remove any user-supplied definition for the macro named @var{macro}.
11951 This command only affects definitions provided with the @code{macro
11952 define} command, described above; it cannot remove definitions present
11953 in the program being debugged.
11957 List all the macros defined using the @code{macro define} command.
11960 @cindex macros, example of debugging with
11961 Here is a transcript showing the above commands in action. First, we
11962 show our source files:
11967 #include "sample.h"
11970 #define ADD(x) (M + x)
11975 printf ("Hello, world!\n");
11977 printf ("We're so creative.\n");
11979 printf ("Goodbye, world!\n");
11986 Now, we compile the program using the @sc{gnu} C compiler,
11987 @value{NGCC}. We pass the @option{-gdwarf-2}@footnote{This is the
11988 minimum. Recent versions of @value{NGCC} support @option{-gdwarf-3}
11989 and @option{-gdwarf-4}; we recommend always choosing the most recent
11990 version of DWARF.} @emph{and} @option{-g3} flags to ensure the compiler
11991 includes information about preprocessor macros in the debugging
11995 $ gcc -gdwarf-2 -g3 sample.c -o sample
11999 Now, we start @value{GDBN} on our sample program:
12003 GNU gdb 2002-05-06-cvs
12004 Copyright 2002 Free Software Foundation, Inc.
12005 GDB is free software, @dots{}
12009 We can expand macros and examine their definitions, even when the
12010 program is not running. @value{GDBN} uses the current listing position
12011 to decide which macro definitions are in scope:
12014 (@value{GDBP}) list main
12017 5 #define ADD(x) (M + x)
12022 10 printf ("Hello, world!\n");
12024 12 printf ("We're so creative.\n");
12025 (@value{GDBP}) info macro ADD
12026 Defined at /home/jimb/gdb/macros/play/sample.c:5
12027 #define ADD(x) (M + x)
12028 (@value{GDBP}) info macro Q
12029 Defined at /home/jimb/gdb/macros/play/sample.h:1
12030 included at /home/jimb/gdb/macros/play/sample.c:2
12032 (@value{GDBP}) macro expand ADD(1)
12033 expands to: (42 + 1)
12034 (@value{GDBP}) macro expand-once ADD(1)
12035 expands to: once (M + 1)
12039 In the example above, note that @code{macro expand-once} expands only
12040 the macro invocation explicit in the original text --- the invocation of
12041 @code{ADD} --- but does not expand the invocation of the macro @code{M},
12042 which was introduced by @code{ADD}.
12044 Once the program is running, @value{GDBN} uses the macro definitions in
12045 force at the source line of the current stack frame:
12048 (@value{GDBP}) break main
12049 Breakpoint 1 at 0x8048370: file sample.c, line 10.
12051 Starting program: /home/jimb/gdb/macros/play/sample
12053 Breakpoint 1, main () at sample.c:10
12054 10 printf ("Hello, world!\n");
12058 At line 10, the definition of the macro @code{N} at line 9 is in force:
12061 (@value{GDBP}) info macro N
12062 Defined at /home/jimb/gdb/macros/play/sample.c:9
12064 (@value{GDBP}) macro expand N Q M
12065 expands to: 28 < 42
12066 (@value{GDBP}) print N Q M
12071 As we step over directives that remove @code{N}'s definition, and then
12072 give it a new definition, @value{GDBN} finds the definition (or lack
12073 thereof) in force at each point:
12076 (@value{GDBP}) next
12078 12 printf ("We're so creative.\n");
12079 (@value{GDBP}) info macro N
12080 The symbol `N' has no definition as a C/C++ preprocessor macro
12081 at /home/jimb/gdb/macros/play/sample.c:12
12082 (@value{GDBP}) next
12084 14 printf ("Goodbye, world!\n");
12085 (@value{GDBP}) info macro N
12086 Defined at /home/jimb/gdb/macros/play/sample.c:13
12088 (@value{GDBP}) macro expand N Q M
12089 expands to: 1729 < 42
12090 (@value{GDBP}) print N Q M
12095 In addition to source files, macros can be defined on the compilation command
12096 line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in
12097 such a way, @value{GDBN} displays the location of their definition as line zero
12098 of the source file submitted to the compiler.
12101 (@value{GDBP}) info macro __STDC__
12102 Defined at /home/jimb/gdb/macros/play/sample.c:0
12109 @chapter Tracepoints
12110 @c This chapter is based on the documentation written by Michael
12111 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
12113 @cindex tracepoints
12114 In some applications, it is not feasible for the debugger to interrupt
12115 the program's execution long enough for the developer to learn
12116 anything helpful about its behavior. If the program's correctness
12117 depends on its real-time behavior, delays introduced by a debugger
12118 might cause the program to change its behavior drastically, or perhaps
12119 fail, even when the code itself is correct. It is useful to be able
12120 to observe the program's behavior without interrupting it.
12122 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
12123 specify locations in the program, called @dfn{tracepoints}, and
12124 arbitrary expressions to evaluate when those tracepoints are reached.
12125 Later, using the @code{tfind} command, you can examine the values
12126 those expressions had when the program hit the tracepoints. The
12127 expressions may also denote objects in memory---structures or arrays,
12128 for example---whose values @value{GDBN} should record; while visiting
12129 a particular tracepoint, you may inspect those objects as if they were
12130 in memory at that moment. However, because @value{GDBN} records these
12131 values without interacting with you, it can do so quickly and
12132 unobtrusively, hopefully not disturbing the program's behavior.
12134 The tracepoint facility is currently available only for remote
12135 targets. @xref{Targets}. In addition, your remote target must know
12136 how to collect trace data. This functionality is implemented in the
12137 remote stub; however, none of the stubs distributed with @value{GDBN}
12138 support tracepoints as of this writing. The format of the remote
12139 packets used to implement tracepoints are described in @ref{Tracepoint
12142 It is also possible to get trace data from a file, in a manner reminiscent
12143 of corefiles; you specify the filename, and use @code{tfind} to search
12144 through the file. @xref{Trace Files}, for more details.
12146 This chapter describes the tracepoint commands and features.
12149 * Set Tracepoints::
12150 * Analyze Collected Data::
12151 * Tracepoint Variables::
12155 @node Set Tracepoints
12156 @section Commands to Set Tracepoints
12158 Before running such a @dfn{trace experiment}, an arbitrary number of
12159 tracepoints can be set. A tracepoint is actually a special type of
12160 breakpoint (@pxref{Set Breaks}), so you can manipulate it using
12161 standard breakpoint commands. For instance, as with breakpoints,
12162 tracepoint numbers are successive integers starting from one, and many
12163 of the commands associated with tracepoints take the tracepoint number
12164 as their argument, to identify which tracepoint to work on.
12166 For each tracepoint, you can specify, in advance, some arbitrary set
12167 of data that you want the target to collect in the trace buffer when
12168 it hits that tracepoint. The collected data can include registers,
12169 local variables, or global data. Later, you can use @value{GDBN}
12170 commands to examine the values these data had at the time the
12171 tracepoint was hit.
12173 Tracepoints do not support every breakpoint feature. Ignore counts on
12174 tracepoints have no effect, and tracepoints cannot run @value{GDBN}
12175 commands when they are hit. Tracepoints may not be thread-specific
12178 @cindex fast tracepoints
12179 Some targets may support @dfn{fast tracepoints}, which are inserted in
12180 a different way (such as with a jump instead of a trap), that is
12181 faster but possibly restricted in where they may be installed.
12183 @cindex static tracepoints
12184 @cindex markers, static tracepoints
12185 @cindex probing markers, static tracepoints
12186 Regular and fast tracepoints are dynamic tracing facilities, meaning
12187 that they can be used to insert tracepoints at (almost) any location
12188 in the target. Some targets may also support controlling @dfn{static
12189 tracepoints} from @value{GDBN}. With static tracing, a set of
12190 instrumentation points, also known as @dfn{markers}, are embedded in
12191 the target program, and can be activated or deactivated by name or
12192 address. These are usually placed at locations which facilitate
12193 investigating what the target is actually doing. @value{GDBN}'s
12194 support for static tracing includes being able to list instrumentation
12195 points, and attach them with @value{GDBN} defined high level
12196 tracepoints that expose the whole range of convenience of
12197 @value{GDBN}'s tracepoints support. Namely, support for collecting
12198 registers values and values of global or local (to the instrumentation
12199 point) variables; tracepoint conditions and trace state variables.
12200 The act of installing a @value{GDBN} static tracepoint on an
12201 instrumentation point, or marker, is referred to as @dfn{probing} a
12202 static tracepoint marker.
12204 @code{gdbserver} supports tracepoints on some target systems.
12205 @xref{Server,,Tracepoints support in @code{gdbserver}}.
12207 This section describes commands to set tracepoints and associated
12208 conditions and actions.
12211 * Create and Delete Tracepoints::
12212 * Enable and Disable Tracepoints::
12213 * Tracepoint Passcounts::
12214 * Tracepoint Conditions::
12215 * Trace State Variables::
12216 * Tracepoint Actions::
12217 * Listing Tracepoints::
12218 * Listing Static Tracepoint Markers::
12219 * Starting and Stopping Trace Experiments::
12220 * Tracepoint Restrictions::
12223 @node Create and Delete Tracepoints
12224 @subsection Create and Delete Tracepoints
12227 @cindex set tracepoint
12229 @item trace @var{location}
12230 The @code{trace} command is very similar to the @code{break} command.
12231 Its argument @var{location} can be any valid location.
12232 @xref{Specify Location}. The @code{trace} command defines a tracepoint,
12233 which is a point in the target program where the debugger will briefly stop,
12234 collect some data, and then allow the program to continue. Setting a tracepoint
12235 or changing its actions takes effect immediately if the remote stub
12236 supports the @samp{InstallInTrace} feature (@pxref{install tracepoint
12238 If remote stub doesn't support the @samp{InstallInTrace} feature, all
12239 these changes don't take effect until the next @code{tstart}
12240 command, and once a trace experiment is running, further changes will
12241 not have any effect until the next trace experiment starts. In addition,
12242 @value{GDBN} supports @dfn{pending tracepoints}---tracepoints whose
12243 address is not yet resolved. (This is similar to pending breakpoints.)
12244 Pending tracepoints are not downloaded to the target and not installed
12245 until they are resolved. The resolution of pending tracepoints requires
12246 @value{GDBN} support---when debugging with the remote target, and
12247 @value{GDBN} disconnects from the remote stub (@pxref{disconnected
12248 tracing}), pending tracepoints can not be resolved (and downloaded to
12249 the remote stub) while @value{GDBN} is disconnected.
12251 Here are some examples of using the @code{trace} command:
12254 (@value{GDBP}) @b{trace foo.c:121} // a source file and line number
12256 (@value{GDBP}) @b{trace +2} // 2 lines forward
12258 (@value{GDBP}) @b{trace my_function} // first source line of function
12260 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
12262 (@value{GDBP}) @b{trace *0x2117c4} // an address
12266 You can abbreviate @code{trace} as @code{tr}.
12268 @item trace @var{location} if @var{cond}
12269 Set a tracepoint with condition @var{cond}; evaluate the expression
12270 @var{cond} each time the tracepoint is reached, and collect data only
12271 if the value is nonzero---that is, if @var{cond} evaluates as true.
12272 @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more
12273 information on tracepoint conditions.
12275 @item ftrace @var{location} [ if @var{cond} ]
12276 @cindex set fast tracepoint
12277 @cindex fast tracepoints, setting
12279 The @code{ftrace} command sets a fast tracepoint. For targets that
12280 support them, fast tracepoints will use a more efficient but possibly
12281 less general technique to trigger data collection, such as a jump
12282 instruction instead of a trap, or some sort of hardware support. It
12283 may not be possible to create a fast tracepoint at the desired
12284 location, in which case the command will exit with an explanatory
12287 @value{GDBN} handles arguments to @code{ftrace} exactly as for
12290 On 32-bit x86-architecture systems, fast tracepoints normally need to
12291 be placed at an instruction that is 5 bytes or longer, but can be
12292 placed at 4-byte instructions if the low 64K of memory of the target
12293 program is available to install trampolines. Some Unix-type systems,
12294 such as @sc{gnu}/Linux, exclude low addresses from the program's
12295 address space; but for instance with the Linux kernel it is possible
12296 to let @value{GDBN} use this area by doing a @command{sysctl} command
12297 to set the @code{mmap_min_addr} kernel parameter, as in
12300 sudo sysctl -w vm.mmap_min_addr=32768
12304 which sets the low address to 32K, which leaves plenty of room for
12305 trampolines. The minimum address should be set to a page boundary.
12307 @item strace @var{location} [ if @var{cond} ]
12308 @cindex set static tracepoint
12309 @cindex static tracepoints, setting
12310 @cindex probe static tracepoint marker
12312 The @code{strace} command sets a static tracepoint. For targets that
12313 support it, setting a static tracepoint probes a static
12314 instrumentation point, or marker, found at @var{location}. It may not
12315 be possible to set a static tracepoint at the desired location, in
12316 which case the command will exit with an explanatory message.
12318 @value{GDBN} handles arguments to @code{strace} exactly as for
12319 @code{trace}, with the addition that the user can also specify
12320 @code{-m @var{marker}} as @var{location}. This probes the marker
12321 identified by the @var{marker} string identifier. This identifier
12322 depends on the static tracepoint backend library your program is
12323 using. You can find all the marker identifiers in the @samp{ID} field
12324 of the @code{info static-tracepoint-markers} command output.
12325 @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint
12326 Markers}. For example, in the following small program using the UST
12332 trace_mark(ust, bar33, "str %s", "FOOBAZ");
12337 the marker id is composed of joining the first two arguments to the
12338 @code{trace_mark} call with a slash, which translates to:
12341 (@value{GDBP}) info static-tracepoint-markers
12342 Cnt Enb ID Address What
12343 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22
12349 so you may probe the marker above with:
12352 (@value{GDBP}) strace -m ust/bar33
12355 Static tracepoints accept an extra collect action --- @code{collect
12356 $_sdata}. This collects arbitrary user data passed in the probe point
12357 call to the tracing library. In the UST example above, you'll see
12358 that the third argument to @code{trace_mark} is a printf-like format
12359 string. The user data is then the result of running that formating
12360 string against the following arguments. Note that @code{info
12361 static-tracepoint-markers} command output lists that format string in
12362 the @samp{Data:} field.
12364 You can inspect this data when analyzing the trace buffer, by printing
12365 the $_sdata variable like any other variable available to
12366 @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}.
12369 @cindex last tracepoint number
12370 @cindex recent tracepoint number
12371 @cindex tracepoint number
12372 The convenience variable @code{$tpnum} records the tracepoint number
12373 of the most recently set tracepoint.
12375 @kindex delete tracepoint
12376 @cindex tracepoint deletion
12377 @item delete tracepoint @r{[}@var{num}@r{]}
12378 Permanently delete one or more tracepoints. With no argument, the
12379 default is to delete all tracepoints. Note that the regular
12380 @code{delete} command can remove tracepoints also.
12385 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
12387 (@value{GDBP}) @b{delete trace} // remove all tracepoints
12391 You can abbreviate this command as @code{del tr}.
12394 @node Enable and Disable Tracepoints
12395 @subsection Enable and Disable Tracepoints
12397 These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}.
12400 @kindex disable tracepoint
12401 @item disable tracepoint @r{[}@var{num}@r{]}
12402 Disable tracepoint @var{num}, or all tracepoints if no argument
12403 @var{num} is given. A disabled tracepoint will have no effect during
12404 a trace experiment, but it is not forgotten. You can re-enable
12405 a disabled tracepoint using the @code{enable tracepoint} command.
12406 If the command is issued during a trace experiment and the debug target
12407 has support for disabling tracepoints during a trace experiment, then the
12408 change will be effective immediately. Otherwise, it will be applied to the
12409 next trace experiment.
12411 @kindex enable tracepoint
12412 @item enable tracepoint @r{[}@var{num}@r{]}
12413 Enable tracepoint @var{num}, or all tracepoints. If this command is
12414 issued during a trace experiment and the debug target supports enabling
12415 tracepoints during a trace experiment, then the enabled tracepoints will
12416 become effective immediately. Otherwise, they will become effective the
12417 next time a trace experiment is run.
12420 @node Tracepoint Passcounts
12421 @subsection Tracepoint Passcounts
12425 @cindex tracepoint pass count
12426 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
12427 Set the @dfn{passcount} of a tracepoint. The passcount is a way to
12428 automatically stop a trace experiment. If a tracepoint's passcount is
12429 @var{n}, then the trace experiment will be automatically stopped on
12430 the @var{n}'th time that tracepoint is hit. If the tracepoint number
12431 @var{num} is not specified, the @code{passcount} command sets the
12432 passcount of the most recently defined tracepoint. If no passcount is
12433 given, the trace experiment will run until stopped explicitly by the
12439 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of
12440 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2}
12442 (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the
12443 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.}
12444 (@value{GDBP}) @b{trace foo}
12445 (@value{GDBP}) @b{pass 3}
12446 (@value{GDBP}) @b{trace bar}
12447 (@value{GDBP}) @b{pass 2}
12448 (@value{GDBP}) @b{trace baz}
12449 (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been
12450 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has}
12451 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times}
12452 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.}
12456 @node Tracepoint Conditions
12457 @subsection Tracepoint Conditions
12458 @cindex conditional tracepoints
12459 @cindex tracepoint conditions
12461 The simplest sort of tracepoint collects data every time your program
12462 reaches a specified place. You can also specify a @dfn{condition} for
12463 a tracepoint. A condition is just a Boolean expression in your
12464 programming language (@pxref{Expressions, ,Expressions}). A
12465 tracepoint with a condition evaluates the expression each time your
12466 program reaches it, and data collection happens only if the condition
12469 Tracepoint conditions can be specified when a tracepoint is set, by
12470 using @samp{if} in the arguments to the @code{trace} command.
12471 @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can
12472 also be set or changed at any time with the @code{condition} command,
12473 just as with breakpoints.
12475 Unlike breakpoint conditions, @value{GDBN} does not actually evaluate
12476 the conditional expression itself. Instead, @value{GDBN} encodes the
12477 expression into an agent expression (@pxref{Agent Expressions})
12478 suitable for execution on the target, independently of @value{GDBN}.
12479 Global variables become raw memory locations, locals become stack
12480 accesses, and so forth.
12482 For instance, suppose you have a function that is usually called
12483 frequently, but should not be called after an error has occurred. You
12484 could use the following tracepoint command to collect data about calls
12485 of that function that happen while the error code is propagating
12486 through the program; an unconditional tracepoint could end up
12487 collecting thousands of useless trace frames that you would have to
12491 (@value{GDBP}) @kbd{trace normal_operation if errcode > 0}
12494 @node Trace State Variables
12495 @subsection Trace State Variables
12496 @cindex trace state variables
12498 A @dfn{trace state variable} is a special type of variable that is
12499 created and managed by target-side code. The syntax is the same as
12500 that for GDB's convenience variables (a string prefixed with ``$''),
12501 but they are stored on the target. They must be created explicitly,
12502 using a @code{tvariable} command. They are always 64-bit signed
12505 Trace state variables are remembered by @value{GDBN}, and downloaded
12506 to the target along with tracepoint information when the trace
12507 experiment starts. There are no intrinsic limits on the number of
12508 trace state variables, beyond memory limitations of the target.
12510 @cindex convenience variables, and trace state variables
12511 Although trace state variables are managed by the target, you can use
12512 them in print commands and expressions as if they were convenience
12513 variables; @value{GDBN} will get the current value from the target
12514 while the trace experiment is running. Trace state variables share
12515 the same namespace as other ``$'' variables, which means that you
12516 cannot have trace state variables with names like @code{$23} or
12517 @code{$pc}, nor can you have a trace state variable and a convenience
12518 variable with the same name.
12522 @item tvariable $@var{name} [ = @var{expression} ]
12524 The @code{tvariable} command creates a new trace state variable named
12525 @code{$@var{name}}, and optionally gives it an initial value of
12526 @var{expression}. The @var{expression} is evaluated when this command is
12527 entered; the result will be converted to an integer if possible,
12528 otherwise @value{GDBN} will report an error. A subsequent
12529 @code{tvariable} command specifying the same name does not create a
12530 variable, but instead assigns the supplied initial value to the
12531 existing variable of that name, overwriting any previous initial
12532 value. The default initial value is 0.
12534 @item info tvariables
12535 @kindex info tvariables
12536 List all the trace state variables along with their initial values.
12537 Their current values may also be displayed, if the trace experiment is
12540 @item delete tvariable @r{[} $@var{name} @dots{} @r{]}
12541 @kindex delete tvariable
12542 Delete the given trace state variables, or all of them if no arguments
12547 @node Tracepoint Actions
12548 @subsection Tracepoint Action Lists
12552 @cindex tracepoint actions
12553 @item actions @r{[}@var{num}@r{]}
12554 This command will prompt for a list of actions to be taken when the
12555 tracepoint is hit. If the tracepoint number @var{num} is not
12556 specified, this command sets the actions for the one that was most
12557 recently defined (so that you can define a tracepoint and then say
12558 @code{actions} without bothering about its number). You specify the
12559 actions themselves on the following lines, one action at a time, and
12560 terminate the actions list with a line containing just @code{end}. So
12561 far, the only defined actions are @code{collect}, @code{teval}, and
12562 @code{while-stepping}.
12564 @code{actions} is actually equivalent to @code{commands} (@pxref{Break
12565 Commands, ,Breakpoint Command Lists}), except that only the defined
12566 actions are allowed; any other @value{GDBN} command is rejected.
12568 @cindex remove actions from a tracepoint
12569 To remove all actions from a tracepoint, type @samp{actions @var{num}}
12570 and follow it immediately with @samp{end}.
12573 (@value{GDBP}) @b{collect @var{data}} // collect some data
12575 (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data
12577 (@value{GDBP}) @b{end} // signals the end of actions.
12580 In the following example, the action list begins with @code{collect}
12581 commands indicating the things to be collected when the tracepoint is
12582 hit. Then, in order to single-step and collect additional data
12583 following the tracepoint, a @code{while-stepping} command is used,
12584 followed by the list of things to be collected after each step in a
12585 sequence of single steps. The @code{while-stepping} command is
12586 terminated by its own separate @code{end} command. Lastly, the action
12587 list is terminated by an @code{end} command.
12590 (@value{GDBP}) @b{trace foo}
12591 (@value{GDBP}) @b{actions}
12592 Enter actions for tracepoint 1, one per line:
12595 > while-stepping 12
12596 > collect $pc, arr[i]
12601 @kindex collect @r{(tracepoints)}
12602 @item collect@r{[}/@var{mods}@r{]} @var{expr1}, @var{expr2}, @dots{}
12603 Collect values of the given expressions when the tracepoint is hit.
12604 This command accepts a comma-separated list of any valid expressions.
12605 In addition to global, static, or local variables, the following
12606 special arguments are supported:
12610 Collect all registers.
12613 Collect all function arguments.
12616 Collect all local variables.
12619 Collect the return address. This is helpful if you want to see more
12623 Collects the number of arguments from the static probe at which the
12624 tracepoint is located.
12625 @xref{Static Probe Points}.
12627 @item $_probe_arg@var{n}
12628 @var{n} is an integer between 0 and 11. Collects the @var{n}th argument
12629 from the static probe at which the tracepoint is located.
12630 @xref{Static Probe Points}.
12633 @vindex $_sdata@r{, collect}
12634 Collect static tracepoint marker specific data. Only available for
12635 static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action
12636 Lists}. On the UST static tracepoints library backend, an
12637 instrumentation point resembles a @code{printf} function call. The
12638 tracing library is able to collect user specified data formatted to a
12639 character string using the format provided by the programmer that
12640 instrumented the program. Other backends have similar mechanisms.
12641 Here's an example of a UST marker call:
12644 const char master_name[] = "$your_name";
12645 trace_mark(channel1, marker1, "hello %s", master_name)
12648 In this case, collecting @code{$_sdata} collects the string
12649 @samp{hello $yourname}. When analyzing the trace buffer, you can
12650 inspect @samp{$_sdata} like any other variable available to
12654 You can give several consecutive @code{collect} commands, each one
12655 with a single argument, or one @code{collect} command with several
12656 arguments separated by commas; the effect is the same.
12658 The optional @var{mods} changes the usual handling of the arguments.
12659 @code{s} requests that pointers to chars be handled as strings, in
12660 particular collecting the contents of the memory being pointed at, up
12661 to the first zero. The upper bound is by default the value of the
12662 @code{print elements} variable; if @code{s} is followed by a decimal
12663 number, that is the upper bound instead. So for instance
12664 @samp{collect/s25 mystr} collects as many as 25 characters at
12667 The command @code{info scope} (@pxref{Symbols, info scope}) is
12668 particularly useful for figuring out what data to collect.
12670 @kindex teval @r{(tracepoints)}
12671 @item teval @var{expr1}, @var{expr2}, @dots{}
12672 Evaluate the given expressions when the tracepoint is hit. This
12673 command accepts a comma-separated list of expressions. The results
12674 are discarded, so this is mainly useful for assigning values to trace
12675 state variables (@pxref{Trace State Variables}) without adding those
12676 values to the trace buffer, as would be the case if the @code{collect}
12679 @kindex while-stepping @r{(tracepoints)}
12680 @item while-stepping @var{n}
12681 Perform @var{n} single-step instruction traces after the tracepoint,
12682 collecting new data after each step. The @code{while-stepping}
12683 command is followed by the list of what to collect while stepping
12684 (followed by its own @code{end} command):
12687 > while-stepping 12
12688 > collect $regs, myglobal
12694 Note that @code{$pc} is not automatically collected by
12695 @code{while-stepping}; you need to explicitly collect that register if
12696 you need it. You may abbreviate @code{while-stepping} as @code{ws} or
12699 @item set default-collect @var{expr1}, @var{expr2}, @dots{}
12700 @kindex set default-collect
12701 @cindex default collection action
12702 This variable is a list of expressions to collect at each tracepoint
12703 hit. It is effectively an additional @code{collect} action prepended
12704 to every tracepoint action list. The expressions are parsed
12705 individually for each tracepoint, so for instance a variable named
12706 @code{xyz} may be interpreted as a global for one tracepoint, and a
12707 local for another, as appropriate to the tracepoint's location.
12709 @item show default-collect
12710 @kindex show default-collect
12711 Show the list of expressions that are collected by default at each
12716 @node Listing Tracepoints
12717 @subsection Listing Tracepoints
12720 @kindex info tracepoints @r{[}@var{n}@dots{}@r{]}
12721 @kindex info tp @r{[}@var{n}@dots{}@r{]}
12722 @cindex information about tracepoints
12723 @item info tracepoints @r{[}@var{num}@dots{}@r{]}
12724 Display information about the tracepoint @var{num}. If you don't
12725 specify a tracepoint number, displays information about all the
12726 tracepoints defined so far. The format is similar to that used for
12727 @code{info breakpoints}; in fact, @code{info tracepoints} is the same
12728 command, simply restricting itself to tracepoints.
12730 A tracepoint's listing may include additional information specific to
12735 its passcount as given by the @code{passcount @var{n}} command
12738 the state about installed on target of each location
12742 (@value{GDBP}) @b{info trace}
12743 Num Type Disp Enb Address What
12744 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7
12746 collect globfoo, $regs
12751 2 tracepoint keep y <MULTIPLE>
12753 2.1 y 0x0804859c in func4 at change-loc.h:35
12754 installed on target
12755 2.2 y 0xb7ffc480 in func4 at change-loc.h:35
12756 installed on target
12757 2.3 y <PENDING> set_tracepoint
12758 3 tracepoint keep y 0x080485b1 in foo at change-loc.c:29
12759 not installed on target
12764 This command can be abbreviated @code{info tp}.
12767 @node Listing Static Tracepoint Markers
12768 @subsection Listing Static Tracepoint Markers
12771 @kindex info static-tracepoint-markers
12772 @cindex information about static tracepoint markers
12773 @item info static-tracepoint-markers
12774 Display information about all static tracepoint markers defined in the
12777 For each marker, the following columns are printed:
12781 An incrementing counter, output to help readability. This is not a
12784 The marker ID, as reported by the target.
12785 @item Enabled or Disabled
12786 Probed markers are tagged with @samp{y}. @samp{n} identifies marks
12787 that are not enabled.
12789 Where the marker is in your program, as a memory address.
12791 Where the marker is in the source for your program, as a file and line
12792 number. If the debug information included in the program does not
12793 allow @value{GDBN} to locate the source of the marker, this column
12794 will be left blank.
12798 In addition, the following information may be printed for each marker:
12802 User data passed to the tracing library by the marker call. In the
12803 UST backend, this is the format string passed as argument to the
12805 @item Static tracepoints probing the marker
12806 The list of static tracepoints attached to the marker.
12810 (@value{GDBP}) info static-tracepoint-markers
12811 Cnt ID Enb Address What
12812 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25
12813 Data: number1 %d number2 %d
12814 Probed by static tracepoints: #2
12815 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24
12821 @node Starting and Stopping Trace Experiments
12822 @subsection Starting and Stopping Trace Experiments
12825 @kindex tstart [ @var{notes} ]
12826 @cindex start a new trace experiment
12827 @cindex collected data discarded
12829 This command starts the trace experiment, and begins collecting data.
12830 It has the side effect of discarding all the data collected in the
12831 trace buffer during the previous trace experiment. If any arguments
12832 are supplied, they are taken as a note and stored with the trace
12833 experiment's state. The notes may be arbitrary text, and are
12834 especially useful with disconnected tracing in a multi-user context;
12835 the notes can explain what the trace is doing, supply user contact
12836 information, and so forth.
12838 @kindex tstop [ @var{notes} ]
12839 @cindex stop a running trace experiment
12841 This command stops the trace experiment. If any arguments are
12842 supplied, they are recorded with the experiment as a note. This is
12843 useful if you are stopping a trace started by someone else, for
12844 instance if the trace is interfering with the system's behavior and
12845 needs to be stopped quickly.
12847 @strong{Note}: a trace experiment and data collection may stop
12848 automatically if any tracepoint's passcount is reached
12849 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
12852 @cindex status of trace data collection
12853 @cindex trace experiment, status of
12855 This command displays the status of the current trace data
12859 Here is an example of the commands we described so far:
12862 (@value{GDBP}) @b{trace gdb_c_test}
12863 (@value{GDBP}) @b{actions}
12864 Enter actions for tracepoint #1, one per line.
12865 > collect $regs,$locals,$args
12866 > while-stepping 11
12870 (@value{GDBP}) @b{tstart}
12871 [time passes @dots{}]
12872 (@value{GDBP}) @b{tstop}
12875 @anchor{disconnected tracing}
12876 @cindex disconnected tracing
12877 You can choose to continue running the trace experiment even if
12878 @value{GDBN} disconnects from the target, voluntarily or
12879 involuntarily. For commands such as @code{detach}, the debugger will
12880 ask what you want to do with the trace. But for unexpected
12881 terminations (@value{GDBN} crash, network outage), it would be
12882 unfortunate to lose hard-won trace data, so the variable
12883 @code{disconnected-tracing} lets you decide whether the trace should
12884 continue running without @value{GDBN}.
12887 @item set disconnected-tracing on
12888 @itemx set disconnected-tracing off
12889 @kindex set disconnected-tracing
12890 Choose whether a tracing run should continue to run if @value{GDBN}
12891 has disconnected from the target. Note that @code{detach} or
12892 @code{quit} will ask you directly what to do about a running trace no
12893 matter what this variable's setting, so the variable is mainly useful
12894 for handling unexpected situations, such as loss of the network.
12896 @item show disconnected-tracing
12897 @kindex show disconnected-tracing
12898 Show the current choice for disconnected tracing.
12902 When you reconnect to the target, the trace experiment may or may not
12903 still be running; it might have filled the trace buffer in the
12904 meantime, or stopped for one of the other reasons. If it is running,
12905 it will continue after reconnection.
12907 Upon reconnection, the target will upload information about the
12908 tracepoints in effect. @value{GDBN} will then compare that
12909 information to the set of tracepoints currently defined, and attempt
12910 to match them up, allowing for the possibility that the numbers may
12911 have changed due to creation and deletion in the meantime. If one of
12912 the target's tracepoints does not match any in @value{GDBN}, the
12913 debugger will create a new tracepoint, so that you have a number with
12914 which to specify that tracepoint. This matching-up process is
12915 necessarily heuristic, and it may result in useless tracepoints being
12916 created; you may simply delete them if they are of no use.
12918 @cindex circular trace buffer
12919 If your target agent supports a @dfn{circular trace buffer}, then you
12920 can run a trace experiment indefinitely without filling the trace
12921 buffer; when space runs out, the agent deletes already-collected trace
12922 frames, oldest first, until there is enough room to continue
12923 collecting. This is especially useful if your tracepoints are being
12924 hit too often, and your trace gets terminated prematurely because the
12925 buffer is full. To ask for a circular trace buffer, simply set
12926 @samp{circular-trace-buffer} to on. You can set this at any time,
12927 including during tracing; if the agent can do it, it will change
12928 buffer handling on the fly, otherwise it will not take effect until
12932 @item set circular-trace-buffer on
12933 @itemx set circular-trace-buffer off
12934 @kindex set circular-trace-buffer
12935 Choose whether a tracing run should use a linear or circular buffer
12936 for trace data. A linear buffer will not lose any trace data, but may
12937 fill up prematurely, while a circular buffer will discard old trace
12938 data, but it will have always room for the latest tracepoint hits.
12940 @item show circular-trace-buffer
12941 @kindex show circular-trace-buffer
12942 Show the current choice for the trace buffer. Note that this may not
12943 match the agent's current buffer handling, nor is it guaranteed to
12944 match the setting that might have been in effect during a past run,
12945 for instance if you are looking at frames from a trace file.
12950 @item set trace-buffer-size @var{n}
12951 @itemx set trace-buffer-size unlimited
12952 @kindex set trace-buffer-size
12953 Request that the target use a trace buffer of @var{n} bytes. Not all
12954 targets will honor the request; they may have a compiled-in size for
12955 the trace buffer, or some other limitation. Set to a value of
12956 @code{unlimited} or @code{-1} to let the target use whatever size it
12957 likes. This is also the default.
12959 @item show trace-buffer-size
12960 @kindex show trace-buffer-size
12961 Show the current requested size for the trace buffer. Note that this
12962 will only match the actual size if the target supports size-setting,
12963 and was able to handle the requested size. For instance, if the
12964 target can only change buffer size between runs, this variable will
12965 not reflect the change until the next run starts. Use @code{tstatus}
12966 to get a report of the actual buffer size.
12970 @item set trace-user @var{text}
12971 @kindex set trace-user
12973 @item show trace-user
12974 @kindex show trace-user
12976 @item set trace-notes @var{text}
12977 @kindex set trace-notes
12978 Set the trace run's notes.
12980 @item show trace-notes
12981 @kindex show trace-notes
12982 Show the trace run's notes.
12984 @item set trace-stop-notes @var{text}
12985 @kindex set trace-stop-notes
12986 Set the trace run's stop notes. The handling of the note is as for
12987 @code{tstop} arguments; the set command is convenient way to fix a
12988 stop note that is mistaken or incomplete.
12990 @item show trace-stop-notes
12991 @kindex show trace-stop-notes
12992 Show the trace run's stop notes.
12996 @node Tracepoint Restrictions
12997 @subsection Tracepoint Restrictions
12999 @cindex tracepoint restrictions
13000 There are a number of restrictions on the use of tracepoints. As
13001 described above, tracepoint data gathering occurs on the target
13002 without interaction from @value{GDBN}. Thus the full capabilities of
13003 the debugger are not available during data gathering, and then at data
13004 examination time, you will be limited by only having what was
13005 collected. The following items describe some common problems, but it
13006 is not exhaustive, and you may run into additional difficulties not
13012 Tracepoint expressions are intended to gather objects (lvalues). Thus
13013 the full flexibility of GDB's expression evaluator is not available.
13014 You cannot call functions, cast objects to aggregate types, access
13015 convenience variables or modify values (except by assignment to trace
13016 state variables). Some language features may implicitly call
13017 functions (for instance Objective-C fields with accessors), and therefore
13018 cannot be collected either.
13021 Collection of local variables, either individually or in bulk with
13022 @code{$locals} or @code{$args}, during @code{while-stepping} may
13023 behave erratically. The stepping action may enter a new scope (for
13024 instance by stepping into a function), or the location of the variable
13025 may change (for instance it is loaded into a register). The
13026 tracepoint data recorded uses the location information for the
13027 variables that is correct for the tracepoint location. When the
13028 tracepoint is created, it is not possible, in general, to determine
13029 where the steps of a @code{while-stepping} sequence will advance the
13030 program---particularly if a conditional branch is stepped.
13033 Collection of an incompletely-initialized or partially-destroyed object
13034 may result in something that @value{GDBN} cannot display, or displays
13035 in a misleading way.
13038 When @value{GDBN} displays a pointer to character it automatically
13039 dereferences the pointer to also display characters of the string
13040 being pointed to. However, collecting the pointer during tracing does
13041 not automatically collect the string. You need to explicitly
13042 dereference the pointer and provide size information if you want to
13043 collect not only the pointer, but the memory pointed to. For example,
13044 @code{*ptr@@50} can be used to collect the 50 element array pointed to
13048 It is not possible to collect a complete stack backtrace at a
13049 tracepoint. Instead, you may collect the registers and a few hundred
13050 bytes from the stack pointer with something like @code{*(unsigned char *)$esp@@300}
13051 (adjust to use the name of the actual stack pointer register on your
13052 target architecture, and the amount of stack you wish to capture).
13053 Then the @code{backtrace} command will show a partial backtrace when
13054 using a trace frame. The number of stack frames that can be examined
13055 depends on the sizes of the frames in the collected stack. Note that
13056 if you ask for a block so large that it goes past the bottom of the
13057 stack, the target agent may report an error trying to read from an
13061 If you do not collect registers at a tracepoint, @value{GDBN} can
13062 infer that the value of @code{$pc} must be the same as the address of
13063 the tracepoint and use that when you are looking at a trace frame
13064 for that tracepoint. However, this cannot work if the tracepoint has
13065 multiple locations (for instance if it was set in a function that was
13066 inlined), or if it has a @code{while-stepping} loop. In those cases
13067 @value{GDBN} will warn you that it can't infer @code{$pc}, and default
13072 @node Analyze Collected Data
13073 @section Using the Collected Data
13075 After the tracepoint experiment ends, you use @value{GDBN} commands
13076 for examining the trace data. The basic idea is that each tracepoint
13077 collects a trace @dfn{snapshot} every time it is hit and another
13078 snapshot every time it single-steps. All these snapshots are
13079 consecutively numbered from zero and go into a buffer, and you can
13080 examine them later. The way you examine them is to @dfn{focus} on a
13081 specific trace snapshot. When the remote stub is focused on a trace
13082 snapshot, it will respond to all @value{GDBN} requests for memory and
13083 registers by reading from the buffer which belongs to that snapshot,
13084 rather than from @emph{real} memory or registers of the program being
13085 debugged. This means that @strong{all} @value{GDBN} commands
13086 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
13087 behave as if we were currently debugging the program state as it was
13088 when the tracepoint occurred. Any requests for data that are not in
13089 the buffer will fail.
13092 * tfind:: How to select a trace snapshot
13093 * tdump:: How to display all data for a snapshot
13094 * save tracepoints:: How to save tracepoints for a future run
13098 @subsection @code{tfind @var{n}}
13101 @cindex select trace snapshot
13102 @cindex find trace snapshot
13103 The basic command for selecting a trace snapshot from the buffer is
13104 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
13105 counting from zero. If no argument @var{n} is given, the next
13106 snapshot is selected.
13108 Here are the various forms of using the @code{tfind} command.
13112 Find the first snapshot in the buffer. This is a synonym for
13113 @code{tfind 0} (since 0 is the number of the first snapshot).
13116 Stop debugging trace snapshots, resume @emph{live} debugging.
13119 Same as @samp{tfind none}.
13122 No argument means find the next trace snapshot.
13125 Find the previous trace snapshot before the current one. This permits
13126 retracing earlier steps.
13128 @item tfind tracepoint @var{num}
13129 Find the next snapshot associated with tracepoint @var{num}. Search
13130 proceeds forward from the last examined trace snapshot. If no
13131 argument @var{num} is given, it means find the next snapshot collected
13132 for the same tracepoint as the current snapshot.
13134 @item tfind pc @var{addr}
13135 Find the next snapshot associated with the value @var{addr} of the
13136 program counter. Search proceeds forward from the last examined trace
13137 snapshot. If no argument @var{addr} is given, it means find the next
13138 snapshot with the same value of PC as the current snapshot.
13140 @item tfind outside @var{addr1}, @var{addr2}
13141 Find the next snapshot whose PC is outside the given range of
13142 addresses (exclusive).
13144 @item tfind range @var{addr1}, @var{addr2}
13145 Find the next snapshot whose PC is between @var{addr1} and
13146 @var{addr2} (inclusive).
13148 @item tfind line @r{[}@var{file}:@r{]}@var{n}
13149 Find the next snapshot associated with the source line @var{n}. If
13150 the optional argument @var{file} is given, refer to line @var{n} in
13151 that source file. Search proceeds forward from the last examined
13152 trace snapshot. If no argument @var{n} is given, it means find the
13153 next line other than the one currently being examined; thus saying
13154 @code{tfind line} repeatedly can appear to have the same effect as
13155 stepping from line to line in a @emph{live} debugging session.
13158 The default arguments for the @code{tfind} commands are specifically
13159 designed to make it easy to scan through the trace buffer. For
13160 instance, @code{tfind} with no argument selects the next trace
13161 snapshot, and @code{tfind -} with no argument selects the previous
13162 trace snapshot. So, by giving one @code{tfind} command, and then
13163 simply hitting @key{RET} repeatedly you can examine all the trace
13164 snapshots in order. Or, by saying @code{tfind -} and then hitting
13165 @key{RET} repeatedly you can examine the snapshots in reverse order.
13166 The @code{tfind line} command with no argument selects the snapshot
13167 for the next source line executed. The @code{tfind pc} command with
13168 no argument selects the next snapshot with the same program counter
13169 (PC) as the current frame. The @code{tfind tracepoint} command with
13170 no argument selects the next trace snapshot collected by the same
13171 tracepoint as the current one.
13173 In addition to letting you scan through the trace buffer manually,
13174 these commands make it easy to construct @value{GDBN} scripts that
13175 scan through the trace buffer and print out whatever collected data
13176 you are interested in. Thus, if we want to examine the PC, FP, and SP
13177 registers from each trace frame in the buffer, we can say this:
13180 (@value{GDBP}) @b{tfind start}
13181 (@value{GDBP}) @b{while ($trace_frame != -1)}
13182 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
13183 $trace_frame, $pc, $sp, $fp
13187 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
13188 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
13189 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
13190 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
13191 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
13192 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
13193 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
13194 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
13195 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
13196 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
13197 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
13200 Or, if we want to examine the variable @code{X} at each source line in
13204 (@value{GDBP}) @b{tfind start}
13205 (@value{GDBP}) @b{while ($trace_frame != -1)}
13206 > printf "Frame %d, X == %d\n", $trace_frame, X
13216 @subsection @code{tdump}
13218 @cindex dump all data collected at tracepoint
13219 @cindex tracepoint data, display
13221 This command takes no arguments. It prints all the data collected at
13222 the current trace snapshot.
13225 (@value{GDBP}) @b{trace 444}
13226 (@value{GDBP}) @b{actions}
13227 Enter actions for tracepoint #2, one per line:
13228 > collect $regs, $locals, $args, gdb_long_test
13231 (@value{GDBP}) @b{tstart}
13233 (@value{GDBP}) @b{tfind line 444}
13234 #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
13236 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
13238 (@value{GDBP}) @b{tdump}
13239 Data collected at tracepoint 2, trace frame 1:
13240 d0 0xc4aa0085 -995491707
13244 d4 0x71aea3d 119204413
13247 d7 0x380035 3670069
13248 a0 0x19e24a 1696330
13249 a1 0x3000668 50333288
13251 a3 0x322000 3284992
13252 a4 0x3000698 50333336
13253 a5 0x1ad3cc 1758156
13254 fp 0x30bf3c 0x30bf3c
13255 sp 0x30bf34 0x30bf34
13257 pc 0x20b2c8 0x20b2c8
13261 p = 0x20e5b4 "gdb-test"
13268 gdb_long_test = 17 '\021'
13273 @code{tdump} works by scanning the tracepoint's current collection
13274 actions and printing the value of each expression listed. So
13275 @code{tdump} can fail, if after a run, you change the tracepoint's
13276 actions to mention variables that were not collected during the run.
13278 Also, for tracepoints with @code{while-stepping} loops, @code{tdump}
13279 uses the collected value of @code{$pc} to distinguish between trace
13280 frames that were collected at the tracepoint hit, and frames that were
13281 collected while stepping. This allows it to correctly choose whether
13282 to display the basic list of collections, or the collections from the
13283 body of the while-stepping loop. However, if @code{$pc} was not collected,
13284 then @code{tdump} will always attempt to dump using the basic collection
13285 list, and may fail if a while-stepping frame does not include all the
13286 same data that is collected at the tracepoint hit.
13287 @c This is getting pretty arcane, example would be good.
13289 @node save tracepoints
13290 @subsection @code{save tracepoints @var{filename}}
13291 @kindex save tracepoints
13292 @kindex save-tracepoints
13293 @cindex save tracepoints for future sessions
13295 This command saves all current tracepoint definitions together with
13296 their actions and passcounts, into a file @file{@var{filename}}
13297 suitable for use in a later debugging session. To read the saved
13298 tracepoint definitions, use the @code{source} command (@pxref{Command
13299 Files}). The @w{@code{save-tracepoints}} command is a deprecated
13300 alias for @w{@code{save tracepoints}}
13302 @node Tracepoint Variables
13303 @section Convenience Variables for Tracepoints
13304 @cindex tracepoint variables
13305 @cindex convenience variables for tracepoints
13308 @vindex $trace_frame
13309 @item (int) $trace_frame
13310 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
13311 snapshot is selected.
13313 @vindex $tracepoint
13314 @item (int) $tracepoint
13315 The tracepoint for the current trace snapshot.
13317 @vindex $trace_line
13318 @item (int) $trace_line
13319 The line number for the current trace snapshot.
13321 @vindex $trace_file
13322 @item (char []) $trace_file
13323 The source file for the current trace snapshot.
13325 @vindex $trace_func
13326 @item (char []) $trace_func
13327 The name of the function containing @code{$tracepoint}.
13330 Note: @code{$trace_file} is not suitable for use in @code{printf},
13331 use @code{output} instead.
13333 Here's a simple example of using these convenience variables for
13334 stepping through all the trace snapshots and printing some of their
13335 data. Note that these are not the same as trace state variables,
13336 which are managed by the target.
13339 (@value{GDBP}) @b{tfind start}
13341 (@value{GDBP}) @b{while $trace_frame != -1}
13342 > output $trace_file
13343 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
13349 @section Using Trace Files
13350 @cindex trace files
13352 In some situations, the target running a trace experiment may no
13353 longer be available; perhaps it crashed, or the hardware was needed
13354 for a different activity. To handle these cases, you can arrange to
13355 dump the trace data into a file, and later use that file as a source
13356 of trace data, via the @code{target tfile} command.
13361 @item tsave [ -r ] @var{filename}
13362 @itemx tsave [-ctf] @var{dirname}
13363 Save the trace data to @var{filename}. By default, this command
13364 assumes that @var{filename} refers to the host filesystem, so if
13365 necessary @value{GDBN} will copy raw trace data up from the target and
13366 then save it. If the target supports it, you can also supply the
13367 optional argument @code{-r} (``remote'') to direct the target to save
13368 the data directly into @var{filename} in its own filesystem, which may be
13369 more efficient if the trace buffer is very large. (Note, however, that
13370 @code{target tfile} can only read from files accessible to the host.)
13371 By default, this command will save trace frame in tfile format.
13372 You can supply the optional argument @code{-ctf} to save date in CTF
13373 format. The @dfn{Common Trace Format} (CTF) is proposed as a trace format
13374 that can be shared by multiple debugging and tracing tools. Please go to
13375 @indicateurl{http://www.efficios.com/ctf} to get more information.
13377 @kindex target tfile
13381 @item target tfile @var{filename}
13382 @itemx target ctf @var{dirname}
13383 Use the file named @var{filename} or directory named @var{dirname} as
13384 a source of trace data. Commands that examine data work as they do with
13385 a live target, but it is not possible to run any new trace experiments.
13386 @code{tstatus} will report the state of the trace run at the moment
13387 the data was saved, as well as the current trace frame you are examining.
13388 Both @var{filename} and @var{dirname} must be on a filesystem accessible to
13392 (@value{GDBP}) target ctf ctf.ctf
13393 (@value{GDBP}) tfind
13394 Found trace frame 0, tracepoint 2
13395 39 ++a; /* set tracepoint 1 here */
13396 (@value{GDBP}) tdump
13397 Data collected at tracepoint 2, trace frame 0:
13401 c = @{"123", "456", "789", "123", "456", "789"@}
13402 d = @{@{@{a = 1, b = 2@}, @{a = 3, b = 4@}@}, @{@{a = 5, b = 6@}, @{a = 7, b = 8@}@}@}
13410 @chapter Debugging Programs That Use Overlays
13413 If your program is too large to fit completely in your target system's
13414 memory, you can sometimes use @dfn{overlays} to work around this
13415 problem. @value{GDBN} provides some support for debugging programs that
13419 * How Overlays Work:: A general explanation of overlays.
13420 * Overlay Commands:: Managing overlays in @value{GDBN}.
13421 * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are
13422 mapped by asking the inferior.
13423 * Overlay Sample Program:: A sample program using overlays.
13426 @node How Overlays Work
13427 @section How Overlays Work
13428 @cindex mapped overlays
13429 @cindex unmapped overlays
13430 @cindex load address, overlay's
13431 @cindex mapped address
13432 @cindex overlay area
13434 Suppose you have a computer whose instruction address space is only 64
13435 kilobytes long, but which has much more memory which can be accessed by
13436 other means: special instructions, segment registers, or memory
13437 management hardware, for example. Suppose further that you want to
13438 adapt a program which is larger than 64 kilobytes to run on this system.
13440 One solution is to identify modules of your program which are relatively
13441 independent, and need not call each other directly; call these modules
13442 @dfn{overlays}. Separate the overlays from the main program, and place
13443 their machine code in the larger memory. Place your main program in
13444 instruction memory, but leave at least enough space there to hold the
13445 largest overlay as well.
13447 Now, to call a function located in an overlay, you must first copy that
13448 overlay's machine code from the large memory into the space set aside
13449 for it in the instruction memory, and then jump to its entry point
13452 @c NB: In the below the mapped area's size is greater or equal to the
13453 @c size of all overlays. This is intentional to remind the developer
13454 @c that overlays don't necessarily need to be the same size.
13458 Data Instruction Larger
13459 Address Space Address Space Address Space
13460 +-----------+ +-----------+ +-----------+
13462 +-----------+ +-----------+ +-----------+<-- overlay 1
13463 | program | | main | .----| overlay 1 | load address
13464 | variables | | program | | +-----------+
13465 | and heap | | | | | |
13466 +-----------+ | | | +-----------+<-- overlay 2
13467 | | +-----------+ | | | load address
13468 +-----------+ | | | .-| overlay 2 |
13470 mapped --->+-----------+ | | +-----------+
13471 address | | | | | |
13472 | overlay | <-' | | |
13473 | area | <---' +-----------+<-- overlay 3
13474 | | <---. | | load address
13475 +-----------+ `--| overlay 3 |
13482 @anchor{A code overlay}A code overlay
13486 The diagram (@pxref{A code overlay}) shows a system with separate data
13487 and instruction address spaces. To map an overlay, the program copies
13488 its code from the larger address space to the instruction address space.
13489 Since the overlays shown here all use the same mapped address, only one
13490 may be mapped at a time. For a system with a single address space for
13491 data and instructions, the diagram would be similar, except that the
13492 program variables and heap would share an address space with the main
13493 program and the overlay area.
13495 An overlay loaded into instruction memory and ready for use is called a
13496 @dfn{mapped} overlay; its @dfn{mapped address} is its address in the
13497 instruction memory. An overlay not present (or only partially present)
13498 in instruction memory is called @dfn{unmapped}; its @dfn{load address}
13499 is its address in the larger memory. The mapped address is also called
13500 the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also
13501 called the @dfn{load memory address}, or @dfn{LMA}.
13503 Unfortunately, overlays are not a completely transparent way to adapt a
13504 program to limited instruction memory. They introduce a new set of
13505 global constraints you must keep in mind as you design your program:
13510 Before calling or returning to a function in an overlay, your program
13511 must make sure that overlay is actually mapped. Otherwise, the call or
13512 return will transfer control to the right address, but in the wrong
13513 overlay, and your program will probably crash.
13516 If the process of mapping an overlay is expensive on your system, you
13517 will need to choose your overlays carefully to minimize their effect on
13518 your program's performance.
13521 The executable file you load onto your system must contain each
13522 overlay's instructions, appearing at the overlay's load address, not its
13523 mapped address. However, each overlay's instructions must be relocated
13524 and its symbols defined as if the overlay were at its mapped address.
13525 You can use GNU linker scripts to specify different load and relocation
13526 addresses for pieces of your program; see @ref{Overlay Description,,,
13527 ld.info, Using ld: the GNU linker}.
13530 The procedure for loading executable files onto your system must be able
13531 to load their contents into the larger address space as well as the
13532 instruction and data spaces.
13536 The overlay system described above is rather simple, and could be
13537 improved in many ways:
13542 If your system has suitable bank switch registers or memory management
13543 hardware, you could use those facilities to make an overlay's load area
13544 contents simply appear at their mapped address in instruction space.
13545 This would probably be faster than copying the overlay to its mapped
13546 area in the usual way.
13549 If your overlays are small enough, you could set aside more than one
13550 overlay area, and have more than one overlay mapped at a time.
13553 You can use overlays to manage data, as well as instructions. In
13554 general, data overlays are even less transparent to your design than
13555 code overlays: whereas code overlays only require care when you call or
13556 return to functions, data overlays require care every time you access
13557 the data. Also, if you change the contents of a data overlay, you
13558 must copy its contents back out to its load address before you can copy a
13559 different data overlay into the same mapped area.
13564 @node Overlay Commands
13565 @section Overlay Commands
13567 To use @value{GDBN}'s overlay support, each overlay in your program must
13568 correspond to a separate section of the executable file. The section's
13569 virtual memory address and load memory address must be the overlay's
13570 mapped and load addresses. Identifying overlays with sections allows
13571 @value{GDBN} to determine the appropriate address of a function or
13572 variable, depending on whether the overlay is mapped or not.
13574 @value{GDBN}'s overlay commands all start with the word @code{overlay};
13575 you can abbreviate this as @code{ov} or @code{ovly}. The commands are:
13580 Disable @value{GDBN}'s overlay support. When overlay support is
13581 disabled, @value{GDBN} assumes that all functions and variables are
13582 always present at their mapped addresses. By default, @value{GDBN}'s
13583 overlay support is disabled.
13585 @item overlay manual
13586 @cindex manual overlay debugging
13587 Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN}
13588 relies on you to tell it which overlays are mapped, and which are not,
13589 using the @code{overlay map-overlay} and @code{overlay unmap-overlay}
13590 commands described below.
13592 @item overlay map-overlay @var{overlay}
13593 @itemx overlay map @var{overlay}
13594 @cindex map an overlay
13595 Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must
13596 be the name of the object file section containing the overlay. When an
13597 overlay is mapped, @value{GDBN} assumes it can find the overlay's
13598 functions and variables at their mapped addresses. @value{GDBN} assumes
13599 that any other overlays whose mapped ranges overlap that of
13600 @var{overlay} are now unmapped.
13602 @item overlay unmap-overlay @var{overlay}
13603 @itemx overlay unmap @var{overlay}
13604 @cindex unmap an overlay
13605 Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay}
13606 must be the name of the object file section containing the overlay.
13607 When an overlay is unmapped, @value{GDBN} assumes it can find the
13608 overlay's functions and variables at their load addresses.
13611 Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN}
13612 consults a data structure the overlay manager maintains in the inferior
13613 to see which overlays are mapped. For details, see @ref{Automatic
13614 Overlay Debugging}.
13616 @item overlay load-target
13617 @itemx overlay load
13618 @cindex reloading the overlay table
13619 Re-read the overlay table from the inferior. Normally, @value{GDBN}
13620 re-reads the table @value{GDBN} automatically each time the inferior
13621 stops, so this command should only be necessary if you have changed the
13622 overlay mapping yourself using @value{GDBN}. This command is only
13623 useful when using automatic overlay debugging.
13625 @item overlay list-overlays
13626 @itemx overlay list
13627 @cindex listing mapped overlays
13628 Display a list of the overlays currently mapped, along with their mapped
13629 addresses, load addresses, and sizes.
13633 Normally, when @value{GDBN} prints a code address, it includes the name
13634 of the function the address falls in:
13637 (@value{GDBP}) print main
13638 $3 = @{int ()@} 0x11a0 <main>
13641 When overlay debugging is enabled, @value{GDBN} recognizes code in
13642 unmapped overlays, and prints the names of unmapped functions with
13643 asterisks around them. For example, if @code{foo} is a function in an
13644 unmapped overlay, @value{GDBN} prints it this way:
13647 (@value{GDBP}) overlay list
13648 No sections are mapped.
13649 (@value{GDBP}) print foo
13650 $5 = @{int (int)@} 0x100000 <*foo*>
13653 When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's
13657 (@value{GDBP}) overlay list
13658 Section .ov.foo.text, loaded at 0x100000 - 0x100034,
13659 mapped at 0x1016 - 0x104a
13660 (@value{GDBP}) print foo
13661 $6 = @{int (int)@} 0x1016 <foo>
13664 When overlay debugging is enabled, @value{GDBN} can find the correct
13665 address for functions and variables in an overlay, whether or not the
13666 overlay is mapped. This allows most @value{GDBN} commands, like
13667 @code{break} and @code{disassemble}, to work normally, even on unmapped
13668 code. However, @value{GDBN}'s breakpoint support has some limitations:
13672 @cindex breakpoints in overlays
13673 @cindex overlays, setting breakpoints in
13674 You can set breakpoints in functions in unmapped overlays, as long as
13675 @value{GDBN} can write to the overlay at its load address.
13677 @value{GDBN} can not set hardware or simulator-based breakpoints in
13678 unmapped overlays. However, if you set a breakpoint at the end of your
13679 overlay manager (and tell @value{GDBN} which overlays are now mapped, if
13680 you are using manual overlay management), @value{GDBN} will re-set its
13681 breakpoints properly.
13685 @node Automatic Overlay Debugging
13686 @section Automatic Overlay Debugging
13687 @cindex automatic overlay debugging
13689 @value{GDBN} can automatically track which overlays are mapped and which
13690 are not, given some simple co-operation from the overlay manager in the
13691 inferior. If you enable automatic overlay debugging with the
13692 @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN}
13693 looks in the inferior's memory for certain variables describing the
13694 current state of the overlays.
13696 Here are the variables your overlay manager must define to support
13697 @value{GDBN}'s automatic overlay debugging:
13701 @item @code{_ovly_table}:
13702 This variable must be an array of the following structures:
13707 /* The overlay's mapped address. */
13710 /* The size of the overlay, in bytes. */
13711 unsigned long size;
13713 /* The overlay's load address. */
13716 /* Non-zero if the overlay is currently mapped;
13718 unsigned long mapped;
13722 @item @code{_novlys}:
13723 This variable must be a four-byte signed integer, holding the total
13724 number of elements in @code{_ovly_table}.
13728 To decide whether a particular overlay is mapped or not, @value{GDBN}
13729 looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and
13730 @code{lma} members equal the VMA and LMA of the overlay's section in the
13731 executable file. When @value{GDBN} finds a matching entry, it consults
13732 the entry's @code{mapped} member to determine whether the overlay is
13735 In addition, your overlay manager may define a function called
13736 @code{_ovly_debug_event}. If this function is defined, @value{GDBN}
13737 will silently set a breakpoint there. If the overlay manager then
13738 calls this function whenever it has changed the overlay table, this
13739 will enable @value{GDBN} to accurately keep track of which overlays
13740 are in program memory, and update any breakpoints that may be set
13741 in overlays. This will allow breakpoints to work even if the
13742 overlays are kept in ROM or other non-writable memory while they
13743 are not being executed.
13745 @node Overlay Sample Program
13746 @section Overlay Sample Program
13747 @cindex overlay example program
13749 When linking a program which uses overlays, you must place the overlays
13750 at their load addresses, while relocating them to run at their mapped
13751 addresses. To do this, you must write a linker script (@pxref{Overlay
13752 Description,,, ld.info, Using ld: the GNU linker}). Unfortunately,
13753 since linker scripts are specific to a particular host system, target
13754 architecture, and target memory layout, this manual cannot provide
13755 portable sample code demonstrating @value{GDBN}'s overlay support.
13757 However, the @value{GDBN} source distribution does contain an overlaid
13758 program, with linker scripts for a few systems, as part of its test
13759 suite. The program consists of the following files from
13760 @file{gdb/testsuite/gdb.base}:
13764 The main program file.
13766 A simple overlay manager, used by @file{overlays.c}.
13771 Overlay modules, loaded and used by @file{overlays.c}.
13774 Linker scripts for linking the test program on the @code{d10v-elf}
13775 and @code{m32r-elf} targets.
13778 You can build the test program using the @code{d10v-elf} GCC
13779 cross-compiler like this:
13782 $ d10v-elf-gcc -g -c overlays.c
13783 $ d10v-elf-gcc -g -c ovlymgr.c
13784 $ d10v-elf-gcc -g -c foo.c
13785 $ d10v-elf-gcc -g -c bar.c
13786 $ d10v-elf-gcc -g -c baz.c
13787 $ d10v-elf-gcc -g -c grbx.c
13788 $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \
13789 baz.o grbx.o -Wl,-Td10v.ld -o overlays
13792 The build process is identical for any other architecture, except that
13793 you must substitute the appropriate compiler and linker script for the
13794 target system for @code{d10v-elf-gcc} and @code{d10v.ld}.
13798 @chapter Using @value{GDBN} with Different Languages
13801 Although programming languages generally have common aspects, they are
13802 rarely expressed in the same manner. For instance, in ANSI C,
13803 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
13804 Modula-2, it is accomplished by @code{p^}. Values can also be
13805 represented (and displayed) differently. Hex numbers in C appear as
13806 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
13808 @cindex working language
13809 Language-specific information is built into @value{GDBN} for some languages,
13810 allowing you to express operations like the above in your program's
13811 native language, and allowing @value{GDBN} to output values in a manner
13812 consistent with the syntax of your program's native language. The
13813 language you use to build expressions is called the @dfn{working
13817 * Setting:: Switching between source languages
13818 * Show:: Displaying the language
13819 * Checks:: Type and range checks
13820 * Supported Languages:: Supported languages
13821 * Unsupported Languages:: Unsupported languages
13825 @section Switching Between Source Languages
13827 There are two ways to control the working language---either have @value{GDBN}
13828 set it automatically, or select it manually yourself. You can use the
13829 @code{set language} command for either purpose. On startup, @value{GDBN}
13830 defaults to setting the language automatically. The working language is
13831 used to determine how expressions you type are interpreted, how values
13834 In addition to the working language, every source file that
13835 @value{GDBN} knows about has its own working language. For some object
13836 file formats, the compiler might indicate which language a particular
13837 source file is in. However, most of the time @value{GDBN} infers the
13838 language from the name of the file. The language of a source file
13839 controls whether C@t{++} names are demangled---this way @code{backtrace} can
13840 show each frame appropriately for its own language. There is no way to
13841 set the language of a source file from within @value{GDBN}, but you can
13842 set the language associated with a filename extension. @xref{Show, ,
13843 Displaying the Language}.
13845 This is most commonly a problem when you use a program, such
13846 as @code{cfront} or @code{f2c}, that generates C but is written in
13847 another language. In that case, make the
13848 program use @code{#line} directives in its C output; that way
13849 @value{GDBN} will know the correct language of the source code of the original
13850 program, and will display that source code, not the generated C code.
13853 * Filenames:: Filename extensions and languages.
13854 * Manually:: Setting the working language manually
13855 * Automatically:: Having @value{GDBN} infer the source language
13859 @subsection List of Filename Extensions and Languages
13861 If a source file name ends in one of the following extensions, then
13862 @value{GDBN} infers that its language is the one indicated.
13880 C@t{++} source file
13886 Objective-C source file
13890 Fortran source file
13893 Modula-2 source file
13897 Assembler source file. This actually behaves almost like C, but
13898 @value{GDBN} does not skip over function prologues when stepping.
13901 In addition, you may set the language associated with a filename
13902 extension. @xref{Show, , Displaying the Language}.
13905 @subsection Setting the Working Language
13907 If you allow @value{GDBN} to set the language automatically,
13908 expressions are interpreted the same way in your debugging session and
13911 @kindex set language
13912 If you wish, you may set the language manually. To do this, issue the
13913 command @samp{set language @var{lang}}, where @var{lang} is the name of
13914 a language, such as
13915 @code{c} or @code{modula-2}.
13916 For a list of the supported languages, type @samp{set language}.
13918 Setting the language manually prevents @value{GDBN} from updating the working
13919 language automatically. This can lead to confusion if you try
13920 to debug a program when the working language is not the same as the
13921 source language, when an expression is acceptable to both
13922 languages---but means different things. For instance, if the current
13923 source file were written in C, and @value{GDBN} was parsing Modula-2, a
13931 might not have the effect you intended. In C, this means to add
13932 @code{b} and @code{c} and place the result in @code{a}. The result
13933 printed would be the value of @code{a}. In Modula-2, this means to compare
13934 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
13936 @node Automatically
13937 @subsection Having @value{GDBN} Infer the Source Language
13939 To have @value{GDBN} set the working language automatically, use
13940 @samp{set language local} or @samp{set language auto}. @value{GDBN}
13941 then infers the working language. That is, when your program stops in a
13942 frame (usually by encountering a breakpoint), @value{GDBN} sets the
13943 working language to the language recorded for the function in that
13944 frame. If the language for a frame is unknown (that is, if the function
13945 or block corresponding to the frame was defined in a source file that
13946 does not have a recognized extension), the current working language is
13947 not changed, and @value{GDBN} issues a warning.
13949 This may not seem necessary for most programs, which are written
13950 entirely in one source language. However, program modules and libraries
13951 written in one source language can be used by a main program written in
13952 a different source language. Using @samp{set language auto} in this
13953 case frees you from having to set the working language manually.
13956 @section Displaying the Language
13958 The following commands help you find out which language is the
13959 working language, and also what language source files were written in.
13962 @item show language
13963 @anchor{show language}
13964 @kindex show language
13965 Display the current working language. This is the
13966 language you can use with commands such as @code{print} to
13967 build and compute expressions that may involve variables in your program.
13970 @kindex info frame@r{, show the source language}
13971 Display the source language for this frame. This language becomes the
13972 working language if you use an identifier from this frame.
13973 @xref{Frame Info, ,Information about a Frame}, to identify the other
13974 information listed here.
13977 @kindex info source@r{, show the source language}
13978 Display the source language of this source file.
13979 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
13980 information listed here.
13983 In unusual circumstances, you may have source files with extensions
13984 not in the standard list. You can then set the extension associated
13985 with a language explicitly:
13988 @item set extension-language @var{ext} @var{language}
13989 @kindex set extension-language
13990 Tell @value{GDBN} that source files with extension @var{ext} are to be
13991 assumed as written in the source language @var{language}.
13993 @item info extensions
13994 @kindex info extensions
13995 List all the filename extensions and the associated languages.
13999 @section Type and Range Checking
14001 Some languages are designed to guard you against making seemingly common
14002 errors through a series of compile- and run-time checks. These include
14003 checking the type of arguments to functions and operators and making
14004 sure mathematical overflows are caught at run time. Checks such as
14005 these help to ensure a program's correctness once it has been compiled
14006 by eliminating type mismatches and providing active checks for range
14007 errors when your program is running.
14009 By default @value{GDBN} checks for these errors according to the
14010 rules of the current source language. Although @value{GDBN} does not check
14011 the statements in your program, it can check expressions entered directly
14012 into @value{GDBN} for evaluation via the @code{print} command, for example.
14015 * Type Checking:: An overview of type checking
14016 * Range Checking:: An overview of range checking
14019 @cindex type checking
14020 @cindex checks, type
14021 @node Type Checking
14022 @subsection An Overview of Type Checking
14024 Some languages, such as C and C@t{++}, are strongly typed, meaning that the
14025 arguments to operators and functions have to be of the correct type,
14026 otherwise an error occurs. These checks prevent type mismatch
14027 errors from ever causing any run-time problems. For example,
14030 int klass::my_method(char *b) @{ return b ? 1 : 2; @}
14032 (@value{GDBP}) print obj.my_method (0)
14035 (@value{GDBP}) print obj.my_method (0x1234)
14036 Cannot resolve method klass::my_method to any overloaded instance
14039 The second example fails because in C@t{++} the integer constant
14040 @samp{0x1234} is not type-compatible with the pointer parameter type.
14042 For the expressions you use in @value{GDBN} commands, you can tell
14043 @value{GDBN} to not enforce strict type checking or
14044 to treat any mismatches as errors and abandon the expression;
14045 When type checking is disabled, @value{GDBN} successfully evaluates
14046 expressions like the second example above.
14048 Even if type checking is off, there may be other reasons
14049 related to type that prevent @value{GDBN} from evaluating an expression.
14050 For instance, @value{GDBN} does not know how to add an @code{int} and
14051 a @code{struct foo}. These particular type errors have nothing to do
14052 with the language in use and usually arise from expressions which make
14053 little sense to evaluate anyway.
14055 @value{GDBN} provides some additional commands for controlling type checking:
14057 @kindex set check type
14058 @kindex show check type
14060 @item set check type on
14061 @itemx set check type off
14062 Set strict type checking on or off. If any type mismatches occur in
14063 evaluating an expression while type checking is on, @value{GDBN} prints a
14064 message and aborts evaluation of the expression.
14066 @item show check type
14067 Show the current setting of type checking and whether @value{GDBN}
14068 is enforcing strict type checking rules.
14071 @cindex range checking
14072 @cindex checks, range
14073 @node Range Checking
14074 @subsection An Overview of Range Checking
14076 In some languages (such as Modula-2), it is an error to exceed the
14077 bounds of a type; this is enforced with run-time checks. Such range
14078 checking is meant to ensure program correctness by making sure
14079 computations do not overflow, or indices on an array element access do
14080 not exceed the bounds of the array.
14082 For expressions you use in @value{GDBN} commands, you can tell
14083 @value{GDBN} to treat range errors in one of three ways: ignore them,
14084 always treat them as errors and abandon the expression, or issue
14085 warnings but evaluate the expression anyway.
14087 A range error can result from numerical overflow, from exceeding an
14088 array index bound, or when you type a constant that is not a member
14089 of any type. Some languages, however, do not treat overflows as an
14090 error. In many implementations of C, mathematical overflow causes the
14091 result to ``wrap around'' to lower values---for example, if @var{m} is
14092 the largest integer value, and @var{s} is the smallest, then
14095 @var{m} + 1 @result{} @var{s}
14098 This, too, is specific to individual languages, and in some cases
14099 specific to individual compilers or machines. @xref{Supported Languages, ,
14100 Supported Languages}, for further details on specific languages.
14102 @value{GDBN} provides some additional commands for controlling the range checker:
14104 @kindex set check range
14105 @kindex show check range
14107 @item set check range auto
14108 Set range checking on or off based on the current working language.
14109 @xref{Supported Languages, ,Supported Languages}, for the default settings for
14112 @item set check range on
14113 @itemx set check range off
14114 Set range checking on or off, overriding the default setting for the
14115 current working language. A warning is issued if the setting does not
14116 match the language default. If a range error occurs and range checking is on,
14117 then a message is printed and evaluation of the expression is aborted.
14119 @item set check range warn
14120 Output messages when the @value{GDBN} range checker detects a range error,
14121 but attempt to evaluate the expression anyway. Evaluating the
14122 expression may still be impossible for other reasons, such as accessing
14123 memory that the process does not own (a typical example from many Unix
14127 Show the current setting of the range checker, and whether or not it is
14128 being set automatically by @value{GDBN}.
14131 @node Supported Languages
14132 @section Supported Languages
14134 @value{GDBN} supports C, C@t{++}, D, Go, Objective-C, Fortran, Java,
14135 OpenCL C, Pascal, assembly, Modula-2, and Ada.
14136 @c This is false ...
14137 Some @value{GDBN} features may be used in expressions regardless of the
14138 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
14139 and the @samp{@{type@}addr} construct (@pxref{Expressions,
14140 ,Expressions}) can be used with the constructs of any supported
14143 The following sections detail to what degree each source language is
14144 supported by @value{GDBN}. These sections are not meant to be language
14145 tutorials or references, but serve only as a reference guide to what the
14146 @value{GDBN} expression parser accepts, and what input and output
14147 formats should look like for different languages. There are many good
14148 books written on each of these languages; please look to these for a
14149 language reference or tutorial.
14152 * C:: C and C@t{++}
14155 * Objective-C:: Objective-C
14156 * OpenCL C:: OpenCL C
14157 * Fortran:: Fortran
14159 * Modula-2:: Modula-2
14164 @subsection C and C@t{++}
14166 @cindex C and C@t{++}
14167 @cindex expressions in C or C@t{++}
14169 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
14170 to both languages. Whenever this is the case, we discuss those languages
14174 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
14175 @cindex @sc{gnu} C@t{++}
14176 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
14177 compiler and @value{GDBN}. Therefore, to debug your C@t{++} code
14178 effectively, you must compile your C@t{++} programs with a supported
14179 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
14180 compiler (@code{aCC}).
14183 * C Operators:: C and C@t{++} operators
14184 * C Constants:: C and C@t{++} constants
14185 * C Plus Plus Expressions:: C@t{++} expressions
14186 * C Defaults:: Default settings for C and C@t{++}
14187 * C Checks:: C and C@t{++} type and range checks
14188 * Debugging C:: @value{GDBN} and C
14189 * Debugging C Plus Plus:: @value{GDBN} features for C@t{++}
14190 * Decimal Floating Point:: Numbers in Decimal Floating Point format
14194 @subsubsection C and C@t{++} Operators
14196 @cindex C and C@t{++} operators
14198 Operators must be defined on values of specific types. For instance,
14199 @code{+} is defined on numbers, but not on structures. Operators are
14200 often defined on groups of types.
14202 For the purposes of C and C@t{++}, the following definitions hold:
14207 @emph{Integral types} include @code{int} with any of its storage-class
14208 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
14211 @emph{Floating-point types} include @code{float}, @code{double}, and
14212 @code{long double} (if supported by the target platform).
14215 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
14218 @emph{Scalar types} include all of the above.
14223 The following operators are supported. They are listed here
14224 in order of increasing precedence:
14228 The comma or sequencing operator. Expressions in a comma-separated list
14229 are evaluated from left to right, with the result of the entire
14230 expression being the last expression evaluated.
14233 Assignment. The value of an assignment expression is the value
14234 assigned. Defined on scalar types.
14237 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
14238 and translated to @w{@code{@var{a} = @var{a op b}}}.
14239 @w{@code{@var{op}=}} and @code{=} have the same precedence. The operator
14240 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
14241 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
14244 The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought
14245 of as: if @var{a} then @var{b} else @var{c}. The argument @var{a}
14246 should be of an integral type.
14249 Logical @sc{or}. Defined on integral types.
14252 Logical @sc{and}. Defined on integral types.
14255 Bitwise @sc{or}. Defined on integral types.
14258 Bitwise exclusive-@sc{or}. Defined on integral types.
14261 Bitwise @sc{and}. Defined on integral types.
14264 Equality and inequality. Defined on scalar types. The value of these
14265 expressions is 0 for false and non-zero for true.
14267 @item <@r{, }>@r{, }<=@r{, }>=
14268 Less than, greater than, less than or equal, greater than or equal.
14269 Defined on scalar types. The value of these expressions is 0 for false
14270 and non-zero for true.
14273 left shift, and right shift. Defined on integral types.
14276 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
14279 Addition and subtraction. Defined on integral types, floating-point types and
14282 @item *@r{, }/@r{, }%
14283 Multiplication, division, and modulus. Multiplication and division are
14284 defined on integral and floating-point types. Modulus is defined on
14288 Increment and decrement. When appearing before a variable, the
14289 operation is performed before the variable is used in an expression;
14290 when appearing after it, the variable's value is used before the
14291 operation takes place.
14294 Pointer dereferencing. Defined on pointer types. Same precedence as
14298 Address operator. Defined on variables. Same precedence as @code{++}.
14300 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
14301 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
14302 to examine the address
14303 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
14307 Negative. Defined on integral and floating-point types. Same
14308 precedence as @code{++}.
14311 Logical negation. Defined on integral types. Same precedence as
14315 Bitwise complement operator. Defined on integral types. Same precedence as
14320 Structure member, and pointer-to-structure member. For convenience,
14321 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
14322 pointer based on the stored type information.
14323 Defined on @code{struct} and @code{union} data.
14326 Dereferences of pointers to members.
14329 Array indexing. @code{@var{a}[@var{i}]} is defined as
14330 @code{*(@var{a}+@var{i})}. Same precedence as @code{->}.
14333 Function parameter list. Same precedence as @code{->}.
14336 C@t{++} scope resolution operator. Defined on @code{struct}, @code{union},
14337 and @code{class} types.
14340 Doubled colons also represent the @value{GDBN} scope operator
14341 (@pxref{Expressions, ,Expressions}). Same precedence as @code{::},
14345 If an operator is redefined in the user code, @value{GDBN} usually
14346 attempts to invoke the redefined version instead of using the operator's
14347 predefined meaning.
14350 @subsubsection C and C@t{++} Constants
14352 @cindex C and C@t{++} constants
14354 @value{GDBN} allows you to express the constants of C and C@t{++} in the
14359 Integer constants are a sequence of digits. Octal constants are
14360 specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants
14361 by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter
14362 @samp{l}, specifying that the constant should be treated as a
14366 Floating point constants are a sequence of digits, followed by a decimal
14367 point, followed by a sequence of digits, and optionally followed by an
14368 exponent. An exponent is of the form:
14369 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
14370 sequence of digits. The @samp{+} is optional for positive exponents.
14371 A floating-point constant may also end with a letter @samp{f} or
14372 @samp{F}, specifying that the constant should be treated as being of
14373 the @code{float} (as opposed to the default @code{double}) type; or with
14374 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
14378 Enumerated constants consist of enumerated identifiers, or their
14379 integral equivalents.
14382 Character constants are a single character surrounded by single quotes
14383 (@code{'}), or a number---the ordinal value of the corresponding character
14384 (usually its @sc{ascii} value). Within quotes, the single character may
14385 be represented by a letter or by @dfn{escape sequences}, which are of
14386 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
14387 of the character's ordinal value; or of the form @samp{\@var{x}}, where
14388 @samp{@var{x}} is a predefined special character---for example,
14389 @samp{\n} for newline.
14391 Wide character constants can be written by prefixing a character
14392 constant with @samp{L}, as in C. For example, @samp{L'x'} is the wide
14393 form of @samp{x}. The target wide character set is used when
14394 computing the value of this constant (@pxref{Character Sets}).
14397 String constants are a sequence of character constants surrounded by
14398 double quotes (@code{"}). Any valid character constant (as described
14399 above) may appear. Double quotes within the string must be preceded by
14400 a backslash, so for instance @samp{"a\"b'c"} is a string of five
14403 Wide string constants can be written by prefixing a string constant
14404 with @samp{L}, as in C. The target wide character set is used when
14405 computing the value of this constant (@pxref{Character Sets}).
14408 Pointer constants are an integral value. You can also write pointers
14409 to constants using the C operator @samp{&}.
14412 Array constants are comma-separated lists surrounded by braces @samp{@{}
14413 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
14414 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
14415 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
14418 @node C Plus Plus Expressions
14419 @subsubsection C@t{++} Expressions
14421 @cindex expressions in C@t{++}
14422 @value{GDBN} expression handling can interpret most C@t{++} expressions.
14424 @cindex debugging C@t{++} programs
14425 @cindex C@t{++} compilers
14426 @cindex debug formats and C@t{++}
14427 @cindex @value{NGCC} and C@t{++}
14429 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use
14430 the proper compiler and the proper debug format. Currently,
14431 @value{GDBN} works best when debugging C@t{++} code that is compiled
14432 with the most recent version of @value{NGCC} possible. The DWARF
14433 debugging format is preferred; @value{NGCC} defaults to this on most
14434 popular platforms. Other compilers and/or debug formats are likely to
14435 work badly or not at all when using @value{GDBN} to debug C@t{++}
14436 code. @xref{Compilation}.
14441 @cindex member functions
14443 Member function calls are allowed; you can use expressions like
14446 count = aml->GetOriginal(x, y)
14449 @vindex this@r{, inside C@t{++} member functions}
14450 @cindex namespace in C@t{++}
14452 While a member function is active (in the selected stack frame), your
14453 expressions have the same namespace available as the member function;
14454 that is, @value{GDBN} allows implicit references to the class instance
14455 pointer @code{this} following the same rules as C@t{++}. @code{using}
14456 declarations in the current scope are also respected by @value{GDBN}.
14458 @cindex call overloaded functions
14459 @cindex overloaded functions, calling
14460 @cindex type conversions in C@t{++}
14462 You can call overloaded functions; @value{GDBN} resolves the function
14463 call to the right definition, with some restrictions. @value{GDBN} does not
14464 perform overload resolution involving user-defined type conversions,
14465 calls to constructors, or instantiations of templates that do not exist
14466 in the program. It also cannot handle ellipsis argument lists or
14469 It does perform integral conversions and promotions, floating-point
14470 promotions, arithmetic conversions, pointer conversions, conversions of
14471 class objects to base classes, and standard conversions such as those of
14472 functions or arrays to pointers; it requires an exact match on the
14473 number of function arguments.
14475 Overload resolution is always performed, unless you have specified
14476 @code{set overload-resolution off}. @xref{Debugging C Plus Plus,
14477 ,@value{GDBN} Features for C@t{++}}.
14479 You must specify @code{set overload-resolution off} in order to use an
14480 explicit function signature to call an overloaded function, as in
14482 p 'foo(char,int)'('x', 13)
14485 The @value{GDBN} command-completion facility can simplify this;
14486 see @ref{Completion, ,Command Completion}.
14488 @cindex reference declarations
14490 @value{GDBN} understands variables declared as C@t{++} references; you can use
14491 them in expressions just as you do in C@t{++} source---they are automatically
14494 In the parameter list shown when @value{GDBN} displays a frame, the values of
14495 reference variables are not displayed (unlike other variables); this
14496 avoids clutter, since references are often used for large structures.
14497 The @emph{address} of a reference variable is always shown, unless
14498 you have specified @samp{set print address off}.
14501 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
14502 expressions can use it just as expressions in your program do. Since
14503 one scope may be defined in another, you can use @code{::} repeatedly if
14504 necessary, for example in an expression like
14505 @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows
14506 resolving name scope by reference to source files, in both C and C@t{++}
14507 debugging (@pxref{Variables, ,Program Variables}).
14510 @value{GDBN} performs argument-dependent lookup, following the C@t{++}
14515 @subsubsection C and C@t{++} Defaults
14517 @cindex C and C@t{++} defaults
14519 If you allow @value{GDBN} to set range checking automatically, it
14520 defaults to @code{off} whenever the working language changes to
14521 C or C@t{++}. This happens regardless of whether you or @value{GDBN}
14522 selects the working language.
14524 If you allow @value{GDBN} to set the language automatically, it
14525 recognizes source files whose names end with @file{.c}, @file{.C}, or
14526 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
14527 these files, it sets the working language to C or C@t{++}.
14528 @xref{Automatically, ,Having @value{GDBN} Infer the Source Language},
14529 for further details.
14532 @subsubsection C and C@t{++} Type and Range Checks
14534 @cindex C and C@t{++} checks
14536 By default, when @value{GDBN} parses C or C@t{++} expressions, strict type
14537 checking is used. However, if you turn type checking off, @value{GDBN}
14538 will allow certain non-standard conversions, such as promoting integer
14539 constants to pointers.
14541 Range checking, if turned on, is done on mathematical operations. Array
14542 indices are not checked, since they are often used to index a pointer
14543 that is not itself an array.
14546 @subsubsection @value{GDBN} and C
14548 The @code{set print union} and @code{show print union} commands apply to
14549 the @code{union} type. When set to @samp{on}, any @code{union} that is
14550 inside a @code{struct} or @code{class} is also printed. Otherwise, it
14551 appears as @samp{@{...@}}.
14553 The @code{@@} operator aids in the debugging of dynamic arrays, formed
14554 with pointers and a memory allocation function. @xref{Expressions,
14557 @node Debugging C Plus Plus
14558 @subsubsection @value{GDBN} Features for C@t{++}
14560 @cindex commands for C@t{++}
14562 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
14563 designed specifically for use with C@t{++}. Here is a summary:
14566 @cindex break in overloaded functions
14567 @item @r{breakpoint menus}
14568 When you want a breakpoint in a function whose name is overloaded,
14569 @value{GDBN} has the capability to display a menu of possible breakpoint
14570 locations to help you specify which function definition you want.
14571 @xref{Ambiguous Expressions,,Ambiguous Expressions}.
14573 @cindex overloading in C@t{++}
14574 @item rbreak @var{regex}
14575 Setting breakpoints using regular expressions is helpful for setting
14576 breakpoints on overloaded functions that are not members of any special
14578 @xref{Set Breaks, ,Setting Breakpoints}.
14580 @cindex C@t{++} exception handling
14582 @itemx catch rethrow
14584 Debug C@t{++} exception handling using these commands. @xref{Set
14585 Catchpoints, , Setting Catchpoints}.
14587 @cindex inheritance
14588 @item ptype @var{typename}
14589 Print inheritance relationships as well as other information for type
14591 @xref{Symbols, ,Examining the Symbol Table}.
14593 @item info vtbl @var{expression}.
14594 The @code{info vtbl} command can be used to display the virtual
14595 method tables of the object computed by @var{expression}. This shows
14596 one entry per virtual table; there may be multiple virtual tables when
14597 multiple inheritance is in use.
14599 @cindex C@t{++} demangling
14600 @item demangle @var{name}
14601 Demangle @var{name}.
14602 @xref{Symbols}, for a more complete description of the @code{demangle} command.
14604 @cindex C@t{++} symbol display
14605 @item set print demangle
14606 @itemx show print demangle
14607 @itemx set print asm-demangle
14608 @itemx show print asm-demangle
14609 Control whether C@t{++} symbols display in their source form, both when
14610 displaying code as C@t{++} source and when displaying disassemblies.
14611 @xref{Print Settings, ,Print Settings}.
14613 @item set print object
14614 @itemx show print object
14615 Choose whether to print derived (actual) or declared types of objects.
14616 @xref{Print Settings, ,Print Settings}.
14618 @item set print vtbl
14619 @itemx show print vtbl
14620 Control the format for printing virtual function tables.
14621 @xref{Print Settings, ,Print Settings}.
14622 (The @code{vtbl} commands do not work on programs compiled with the HP
14623 ANSI C@t{++} compiler (@code{aCC}).)
14625 @kindex set overload-resolution
14626 @cindex overloaded functions, overload resolution
14627 @item set overload-resolution on
14628 Enable overload resolution for C@t{++} expression evaluation. The default
14629 is on. For overloaded functions, @value{GDBN} evaluates the arguments
14630 and searches for a function whose signature matches the argument types,
14631 using the standard C@t{++} conversion rules (see @ref{C Plus Plus
14632 Expressions, ,C@t{++} Expressions}, for details).
14633 If it cannot find a match, it emits a message.
14635 @item set overload-resolution off
14636 Disable overload resolution for C@t{++} expression evaluation. For
14637 overloaded functions that are not class member functions, @value{GDBN}
14638 chooses the first function of the specified name that it finds in the
14639 symbol table, whether or not its arguments are of the correct type. For
14640 overloaded functions that are class member functions, @value{GDBN}
14641 searches for a function whose signature @emph{exactly} matches the
14644 @kindex show overload-resolution
14645 @item show overload-resolution
14646 Show the current setting of overload resolution.
14648 @item @r{Overloaded symbol names}
14649 You can specify a particular definition of an overloaded symbol, using
14650 the same notation that is used to declare such symbols in C@t{++}: type
14651 @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can
14652 also use the @value{GDBN} command-line word completion facilities to list the
14653 available choices, or to finish the type list for you.
14654 @xref{Completion,, Command Completion}, for details on how to do this.
14657 @node Decimal Floating Point
14658 @subsubsection Decimal Floating Point format
14659 @cindex decimal floating point format
14661 @value{GDBN} can examine, set and perform computations with numbers in
14662 decimal floating point format, which in the C language correspond to the
14663 @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as
14664 specified by the extension to support decimal floating-point arithmetic.
14666 There are two encodings in use, depending on the architecture: BID (Binary
14667 Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for
14668 PowerPC and S/390. @value{GDBN} will use the appropriate encoding for the
14671 Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN}
14672 to manipulate decimal floating point numbers, it is not possible to convert
14673 (using a cast, for example) integers wider than 32-bit to decimal float.
14675 In addition, in order to imitate @value{GDBN}'s behaviour with binary floating
14676 point computations, error checking in decimal float operations ignores
14677 underflow, overflow and divide by zero exceptions.
14679 In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers
14680 to inspect @code{_Decimal128} values stored in floating point registers.
14681 See @ref{PowerPC,,PowerPC} for more details.
14687 @value{GDBN} can be used to debug programs written in D and compiled with
14688 GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D
14689 specific feature --- dynamic arrays.
14694 @cindex Go (programming language)
14695 @value{GDBN} can be used to debug programs written in Go and compiled with
14696 @file{gccgo} or @file{6g} compilers.
14698 Here is a summary of the Go-specific features and restrictions:
14701 @cindex current Go package
14702 @item The current Go package
14703 The name of the current package does not need to be specified when
14704 specifying global variables and functions.
14706 For example, given the program:
14710 var myglob = "Shall we?"
14716 When stopped inside @code{main} either of these work:
14720 (gdb) p main.myglob
14723 @cindex builtin Go types
14724 @item Builtin Go types
14725 The @code{string} type is recognized by @value{GDBN} and is printed
14728 @cindex builtin Go functions
14729 @item Builtin Go functions
14730 The @value{GDBN} expression parser recognizes the @code{unsafe.Sizeof}
14731 function and handles it internally.
14733 @cindex restrictions on Go expressions
14734 @item Restrictions on Go expressions
14735 All Go operators are supported except @code{&^}.
14736 The Go @code{_} ``blank identifier'' is not supported.
14737 Automatic dereferencing of pointers is not supported.
14741 @subsection Objective-C
14743 @cindex Objective-C
14744 This section provides information about some commands and command
14745 options that are useful for debugging Objective-C code. See also
14746 @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a
14747 few more commands specific to Objective-C support.
14750 * Method Names in Commands::
14751 * The Print Command with Objective-C::
14754 @node Method Names in Commands
14755 @subsubsection Method Names in Commands
14757 The following commands have been extended to accept Objective-C method
14758 names as line specifications:
14760 @kindex clear@r{, and Objective-C}
14761 @kindex break@r{, and Objective-C}
14762 @kindex info line@r{, and Objective-C}
14763 @kindex jump@r{, and Objective-C}
14764 @kindex list@r{, and Objective-C}
14768 @item @code{info line}
14773 A fully qualified Objective-C method name is specified as
14776 -[@var{Class} @var{methodName}]
14779 where the minus sign is used to indicate an instance method and a
14780 plus sign (not shown) is used to indicate a class method. The class
14781 name @var{Class} and method name @var{methodName} are enclosed in
14782 brackets, similar to the way messages are specified in Objective-C
14783 source code. For example, to set a breakpoint at the @code{create}
14784 instance method of class @code{Fruit} in the program currently being
14788 break -[Fruit create]
14791 To list ten program lines around the @code{initialize} class method,
14795 list +[NSText initialize]
14798 In the current version of @value{GDBN}, the plus or minus sign is
14799 required. In future versions of @value{GDBN}, the plus or minus
14800 sign will be optional, but you can use it to narrow the search. It
14801 is also possible to specify just a method name:
14807 You must specify the complete method name, including any colons. If
14808 your program's source files contain more than one @code{create} method,
14809 you'll be presented with a numbered list of classes that implement that
14810 method. Indicate your choice by number, or type @samp{0} to exit if
14813 As another example, to clear a breakpoint established at the
14814 @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter:
14817 clear -[NSWindow makeKeyAndOrderFront:]
14820 @node The Print Command with Objective-C
14821 @subsubsection The Print Command With Objective-C
14822 @cindex Objective-C, print objects
14823 @kindex print-object
14824 @kindex po @r{(@code{print-object})}
14826 The print command has also been extended to accept methods. For example:
14829 print -[@var{object} hash]
14832 @cindex print an Objective-C object description
14833 @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects
14835 will tell @value{GDBN} to send the @code{hash} message to @var{object}
14836 and print the result. Also, an additional command has been added,
14837 @code{print-object} or @code{po} for short, which is meant to print
14838 the description of an object. However, this command may only work
14839 with certain Objective-C libraries that have a particular hook
14840 function, @code{_NSPrintForDebugger}, defined.
14843 @subsection OpenCL C
14846 This section provides information about @value{GDBN}s OpenCL C support.
14849 * OpenCL C Datatypes::
14850 * OpenCL C Expressions::
14851 * OpenCL C Operators::
14854 @node OpenCL C Datatypes
14855 @subsubsection OpenCL C Datatypes
14857 @cindex OpenCL C Datatypes
14858 @value{GDBN} supports the builtin scalar and vector datatypes specified
14859 by OpenCL 1.1. In addition the half- and double-precision floating point
14860 data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL
14861 extensions are also known to @value{GDBN}.
14863 @node OpenCL C Expressions
14864 @subsubsection OpenCL C Expressions
14866 @cindex OpenCL C Expressions
14867 @value{GDBN} supports accesses to vector components including the access as
14868 lvalue where possible. Since OpenCL C is based on C99 most C expressions
14869 supported by @value{GDBN} can be used as well.
14871 @node OpenCL C Operators
14872 @subsubsection OpenCL C Operators
14874 @cindex OpenCL C Operators
14875 @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and
14879 @subsection Fortran
14880 @cindex Fortran-specific support in @value{GDBN}
14882 @value{GDBN} can be used to debug programs written in Fortran, but it
14883 currently supports only the features of Fortran 77 language.
14885 @cindex trailing underscore, in Fortran symbols
14886 Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers
14887 among them) append an underscore to the names of variables and
14888 functions. When you debug programs compiled by those compilers, you
14889 will need to refer to variables and functions with a trailing
14893 * Fortran Operators:: Fortran operators and expressions
14894 * Fortran Defaults:: Default settings for Fortran
14895 * Special Fortran Commands:: Special @value{GDBN} commands for Fortran
14898 @node Fortran Operators
14899 @subsubsection Fortran Operators and Expressions
14901 @cindex Fortran operators and expressions
14903 Operators must be defined on values of specific types. For instance,
14904 @code{+} is defined on numbers, but not on characters or other non-
14905 arithmetic types. Operators are often defined on groups of types.
14909 The exponentiation operator. It raises the first operand to the power
14913 The range operator. Normally used in the form of array(low:high) to
14914 represent a section of array.
14917 The access component operator. Normally used to access elements in derived
14918 types. Also suitable for unions. As unions aren't part of regular Fortran,
14919 this can only happen when accessing a register that uses a gdbarch-defined
14923 @node Fortran Defaults
14924 @subsubsection Fortran Defaults
14926 @cindex Fortran Defaults
14928 Fortran symbols are usually case-insensitive, so @value{GDBN} by
14929 default uses case-insensitive matches for Fortran symbols. You can
14930 change that with the @samp{set case-insensitive} command, see
14931 @ref{Symbols}, for the details.
14933 @node Special Fortran Commands
14934 @subsubsection Special Fortran Commands
14936 @cindex Special Fortran commands
14938 @value{GDBN} has some commands to support Fortran-specific features,
14939 such as displaying common blocks.
14942 @cindex @code{COMMON} blocks, Fortran
14943 @kindex info common
14944 @item info common @r{[}@var{common-name}@r{]}
14945 This command prints the values contained in the Fortran @code{COMMON}
14946 block whose name is @var{common-name}. With no argument, the names of
14947 all @code{COMMON} blocks visible at the current program location are
14954 @cindex Pascal support in @value{GDBN}, limitations
14955 Debugging Pascal programs which use sets, subranges, file variables, or
14956 nested functions does not currently work. @value{GDBN} does not support
14957 entering expressions, printing values, or similar features using Pascal
14960 The Pascal-specific command @code{set print pascal_static-members}
14961 controls whether static members of Pascal objects are displayed.
14962 @xref{Print Settings, pascal_static-members}.
14965 @subsection Modula-2
14967 @cindex Modula-2, @value{GDBN} support
14969 The extensions made to @value{GDBN} to support Modula-2 only support
14970 output from the @sc{gnu} Modula-2 compiler (which is currently being
14971 developed). Other Modula-2 compilers are not currently supported, and
14972 attempting to debug executables produced by them is most likely
14973 to give an error as @value{GDBN} reads in the executable's symbol
14976 @cindex expressions in Modula-2
14978 * M2 Operators:: Built-in operators
14979 * Built-In Func/Proc:: Built-in functions and procedures
14980 * M2 Constants:: Modula-2 constants
14981 * M2 Types:: Modula-2 types
14982 * M2 Defaults:: Default settings for Modula-2
14983 * Deviations:: Deviations from standard Modula-2
14984 * M2 Checks:: Modula-2 type and range checks
14985 * M2 Scope:: The scope operators @code{::} and @code{.}
14986 * GDB/M2:: @value{GDBN} and Modula-2
14990 @subsubsection Operators
14991 @cindex Modula-2 operators
14993 Operators must be defined on values of specific types. For instance,
14994 @code{+} is defined on numbers, but not on structures. Operators are
14995 often defined on groups of types. For the purposes of Modula-2, the
14996 following definitions hold:
15001 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
15005 @emph{Character types} consist of @code{CHAR} and its subranges.
15008 @emph{Floating-point types} consist of @code{REAL}.
15011 @emph{Pointer types} consist of anything declared as @code{POINTER TO
15015 @emph{Scalar types} consist of all of the above.
15018 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
15021 @emph{Boolean types} consist of @code{BOOLEAN}.
15025 The following operators are supported, and appear in order of
15026 increasing precedence:
15030 Function argument or array index separator.
15033 Assignment. The value of @var{var} @code{:=} @var{value} is
15037 Less than, greater than on integral, floating-point, or enumerated
15041 Less than or equal to, greater than or equal to
15042 on integral, floating-point and enumerated types, or set inclusion on
15043 set types. Same precedence as @code{<}.
15045 @item =@r{, }<>@r{, }#
15046 Equality and two ways of expressing inequality, valid on scalar types.
15047 Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is
15048 available for inequality, since @code{#} conflicts with the script
15052 Set membership. Defined on set types and the types of their members.
15053 Same precedence as @code{<}.
15056 Boolean disjunction. Defined on boolean types.
15059 Boolean conjunction. Defined on boolean types.
15062 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
15065 Addition and subtraction on integral and floating-point types, or union
15066 and difference on set types.
15069 Multiplication on integral and floating-point types, or set intersection
15073 Division on floating-point types, or symmetric set difference on set
15074 types. Same precedence as @code{*}.
15077 Integer division and remainder. Defined on integral types. Same
15078 precedence as @code{*}.
15081 Negative. Defined on @code{INTEGER} and @code{REAL} data.
15084 Pointer dereferencing. Defined on pointer types.
15087 Boolean negation. Defined on boolean types. Same precedence as
15091 @code{RECORD} field selector. Defined on @code{RECORD} data. Same
15092 precedence as @code{^}.
15095 Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}.
15098 Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence
15102 @value{GDBN} and Modula-2 scope operators.
15106 @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN}
15107 treats the use of the operator @code{IN}, or the use of operators
15108 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
15109 @code{<=}, and @code{>=} on sets as an error.
15113 @node Built-In Func/Proc
15114 @subsubsection Built-in Functions and Procedures
15115 @cindex Modula-2 built-ins
15117 Modula-2 also makes available several built-in procedures and functions.
15118 In describing these, the following metavariables are used:
15123 represents an @code{ARRAY} variable.
15126 represents a @code{CHAR} constant or variable.
15129 represents a variable or constant of integral type.
15132 represents an identifier that belongs to a set. Generally used in the
15133 same function with the metavariable @var{s}. The type of @var{s} should
15134 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
15137 represents a variable or constant of integral or floating-point type.
15140 represents a variable or constant of floating-point type.
15146 represents a variable.
15149 represents a variable or constant of one of many types. See the
15150 explanation of the function for details.
15153 All Modula-2 built-in procedures also return a result, described below.
15157 Returns the absolute value of @var{n}.
15160 If @var{c} is a lower case letter, it returns its upper case
15161 equivalent, otherwise it returns its argument.
15164 Returns the character whose ordinal value is @var{i}.
15167 Decrements the value in the variable @var{v} by one. Returns the new value.
15169 @item DEC(@var{v},@var{i})
15170 Decrements the value in the variable @var{v} by @var{i}. Returns the
15173 @item EXCL(@var{m},@var{s})
15174 Removes the element @var{m} from the set @var{s}. Returns the new
15177 @item FLOAT(@var{i})
15178 Returns the floating point equivalent of the integer @var{i}.
15180 @item HIGH(@var{a})
15181 Returns the index of the last member of @var{a}.
15184 Increments the value in the variable @var{v} by one. Returns the new value.
15186 @item INC(@var{v},@var{i})
15187 Increments the value in the variable @var{v} by @var{i}. Returns the
15190 @item INCL(@var{m},@var{s})
15191 Adds the element @var{m} to the set @var{s} if it is not already
15192 there. Returns the new set.
15195 Returns the maximum value of the type @var{t}.
15198 Returns the minimum value of the type @var{t}.
15201 Returns boolean TRUE if @var{i} is an odd number.
15204 Returns the ordinal value of its argument. For example, the ordinal
15205 value of a character is its @sc{ascii} value (on machines supporting
15206 the @sc{ascii} character set). The argument @var{x} must be of an
15207 ordered type, which include integral, character and enumerated types.
15209 @item SIZE(@var{x})
15210 Returns the size of its argument. The argument @var{x} can be a
15211 variable or a type.
15213 @item TRUNC(@var{r})
15214 Returns the integral part of @var{r}.
15216 @item TSIZE(@var{x})
15217 Returns the size of its argument. The argument @var{x} can be a
15218 variable or a type.
15220 @item VAL(@var{t},@var{i})
15221 Returns the member of the type @var{t} whose ordinal value is @var{i}.
15225 @emph{Warning:} Sets and their operations are not yet supported, so
15226 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
15230 @cindex Modula-2 constants
15232 @subsubsection Constants
15234 @value{GDBN} allows you to express the constants of Modula-2 in the following
15240 Integer constants are simply a sequence of digits. When used in an
15241 expression, a constant is interpreted to be type-compatible with the
15242 rest of the expression. Hexadecimal integers are specified by a
15243 trailing @samp{H}, and octal integers by a trailing @samp{B}.
15246 Floating point constants appear as a sequence of digits, followed by a
15247 decimal point and another sequence of digits. An optional exponent can
15248 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
15249 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the
15250 digits of the floating point constant must be valid decimal (base 10)
15254 Character constants consist of a single character enclosed by a pair of
15255 like quotes, either single (@code{'}) or double (@code{"}). They may
15256 also be expressed by their ordinal value (their @sc{ascii} value, usually)
15257 followed by a @samp{C}.
15260 String constants consist of a sequence of characters enclosed by a
15261 pair of like quotes, either single (@code{'}) or double (@code{"}).
15262 Escape sequences in the style of C are also allowed. @xref{C
15263 Constants, ,C and C@t{++} Constants}, for a brief explanation of escape
15267 Enumerated constants consist of an enumerated identifier.
15270 Boolean constants consist of the identifiers @code{TRUE} and
15274 Pointer constants consist of integral values only.
15277 Set constants are not yet supported.
15281 @subsubsection Modula-2 Types
15282 @cindex Modula-2 types
15284 Currently @value{GDBN} can print the following data types in Modula-2
15285 syntax: array types, record types, set types, pointer types, procedure
15286 types, enumerated types, subrange types and base types. You can also
15287 print the contents of variables declared using these type.
15288 This section gives a number of simple source code examples together with
15289 sample @value{GDBN} sessions.
15291 The first example contains the following section of code:
15300 and you can request @value{GDBN} to interrogate the type and value of
15301 @code{r} and @code{s}.
15304 (@value{GDBP}) print s
15306 (@value{GDBP}) ptype s
15308 (@value{GDBP}) print r
15310 (@value{GDBP}) ptype r
15315 Likewise if your source code declares @code{s} as:
15319 s: SET ['A'..'Z'] ;
15323 then you may query the type of @code{s} by:
15326 (@value{GDBP}) ptype s
15327 type = SET ['A'..'Z']
15331 Note that at present you cannot interactively manipulate set
15332 expressions using the debugger.
15334 The following example shows how you might declare an array in Modula-2
15335 and how you can interact with @value{GDBN} to print its type and contents:
15339 s: ARRAY [-10..10] OF CHAR ;
15343 (@value{GDBP}) ptype s
15344 ARRAY [-10..10] OF CHAR
15347 Note that the array handling is not yet complete and although the type
15348 is printed correctly, expression handling still assumes that all
15349 arrays have a lower bound of zero and not @code{-10} as in the example
15352 Here are some more type related Modula-2 examples:
15356 colour = (blue, red, yellow, green) ;
15357 t = [blue..yellow] ;
15365 The @value{GDBN} interaction shows how you can query the data type
15366 and value of a variable.
15369 (@value{GDBP}) print s
15371 (@value{GDBP}) ptype t
15372 type = [blue..yellow]
15376 In this example a Modula-2 array is declared and its contents
15377 displayed. Observe that the contents are written in the same way as
15378 their @code{C} counterparts.
15382 s: ARRAY [1..5] OF CARDINAL ;
15388 (@value{GDBP}) print s
15389 $1 = @{1, 0, 0, 0, 0@}
15390 (@value{GDBP}) ptype s
15391 type = ARRAY [1..5] OF CARDINAL
15394 The Modula-2 language interface to @value{GDBN} also understands
15395 pointer types as shown in this example:
15399 s: POINTER TO ARRAY [1..5] OF CARDINAL ;
15406 and you can request that @value{GDBN} describes the type of @code{s}.
15409 (@value{GDBP}) ptype s
15410 type = POINTER TO ARRAY [1..5] OF CARDINAL
15413 @value{GDBN} handles compound types as we can see in this example.
15414 Here we combine array types, record types, pointer types and subrange
15425 myarray = ARRAY myrange OF CARDINAL ;
15426 myrange = [-2..2] ;
15428 s: POINTER TO ARRAY myrange OF foo ;
15432 and you can ask @value{GDBN} to describe the type of @code{s} as shown
15436 (@value{GDBP}) ptype s
15437 type = POINTER TO ARRAY [-2..2] OF foo = RECORD
15440 f3 : ARRAY [-2..2] OF CARDINAL;
15445 @subsubsection Modula-2 Defaults
15446 @cindex Modula-2 defaults
15448 If type and range checking are set automatically by @value{GDBN}, they
15449 both default to @code{on} whenever the working language changes to
15450 Modula-2. This happens regardless of whether you or @value{GDBN}
15451 selected the working language.
15453 If you allow @value{GDBN} to set the language automatically, then entering
15454 code compiled from a file whose name ends with @file{.mod} sets the
15455 working language to Modula-2. @xref{Automatically, ,Having @value{GDBN}
15456 Infer the Source Language}, for further details.
15459 @subsubsection Deviations from Standard Modula-2
15460 @cindex Modula-2, deviations from
15462 A few changes have been made to make Modula-2 programs easier to debug.
15463 This is done primarily via loosening its type strictness:
15467 Unlike in standard Modula-2, pointer constants can be formed by
15468 integers. This allows you to modify pointer variables during
15469 debugging. (In standard Modula-2, the actual address contained in a
15470 pointer variable is hidden from you; it can only be modified
15471 through direct assignment to another pointer variable or expression that
15472 returned a pointer.)
15475 C escape sequences can be used in strings and characters to represent
15476 non-printable characters. @value{GDBN} prints out strings with these
15477 escape sequences embedded. Single non-printable characters are
15478 printed using the @samp{CHR(@var{nnn})} format.
15481 The assignment operator (@code{:=}) returns the value of its right-hand
15485 All built-in procedures both modify @emph{and} return their argument.
15489 @subsubsection Modula-2 Type and Range Checks
15490 @cindex Modula-2 checks
15493 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
15496 @c FIXME remove warning when type/range checks added
15498 @value{GDBN} considers two Modula-2 variables type equivalent if:
15502 They are of types that have been declared equivalent via a @code{TYPE
15503 @var{t1} = @var{t2}} statement
15506 They have been declared on the same line. (Note: This is true of the
15507 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
15510 As long as type checking is enabled, any attempt to combine variables
15511 whose types are not equivalent is an error.
15513 Range checking is done on all mathematical operations, assignment, array
15514 index bounds, and all built-in functions and procedures.
15517 @subsubsection The Scope Operators @code{::} and @code{.}
15519 @cindex @code{.}, Modula-2 scope operator
15520 @cindex colon, doubled as scope operator
15522 @vindex colon-colon@r{, in Modula-2}
15523 @c Info cannot handle :: but TeX can.
15526 @vindex ::@r{, in Modula-2}
15529 There are a few subtle differences between the Modula-2 scope operator
15530 (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have
15535 @var{module} . @var{id}
15536 @var{scope} :: @var{id}
15540 where @var{scope} is the name of a module or a procedure,
15541 @var{module} the name of a module, and @var{id} is any declared
15542 identifier within your program, except another module.
15544 Using the @code{::} operator makes @value{GDBN} search the scope
15545 specified by @var{scope} for the identifier @var{id}. If it is not
15546 found in the specified scope, then @value{GDBN} searches all scopes
15547 enclosing the one specified by @var{scope}.
15549 Using the @code{.} operator makes @value{GDBN} search the current scope for
15550 the identifier specified by @var{id} that was imported from the
15551 definition module specified by @var{module}. With this operator, it is
15552 an error if the identifier @var{id} was not imported from definition
15553 module @var{module}, or if @var{id} is not an identifier in
15557 @subsubsection @value{GDBN} and Modula-2
15559 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
15560 Five subcommands of @code{set print} and @code{show print} apply
15561 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
15562 @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four
15563 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
15564 analogue in Modula-2.
15566 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
15567 with any language, is not useful with Modula-2. Its
15568 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
15569 created in Modula-2 as they can in C or C@t{++}. However, because an
15570 address can be specified by an integral constant, the construct
15571 @samp{@{@var{type}@}@var{adrexp}} is still useful.
15573 @cindex @code{#} in Modula-2
15574 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
15575 interpreted as the beginning of a comment. Use @code{<>} instead.
15581 The extensions made to @value{GDBN} for Ada only support
15582 output from the @sc{gnu} Ada (GNAT) compiler.
15583 Other Ada compilers are not currently supported, and
15584 attempting to debug executables produced by them is most likely
15588 @cindex expressions in Ada
15590 * Ada Mode Intro:: General remarks on the Ada syntax
15591 and semantics supported by Ada mode
15593 * Omissions from Ada:: Restrictions on the Ada expression syntax.
15594 * Additions to Ada:: Extensions of the Ada expression syntax.
15595 * Stopping Before Main Program:: Debugging the program during elaboration.
15596 * Ada Exceptions:: Ada Exceptions
15597 * Ada Tasks:: Listing and setting breakpoints in tasks.
15598 * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files
15599 * Ravenscar Profile:: Tasking Support when using the Ravenscar
15601 * Ada Glitches:: Known peculiarities of Ada mode.
15604 @node Ada Mode Intro
15605 @subsubsection Introduction
15606 @cindex Ada mode, general
15608 The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression
15609 syntax, with some extensions.
15610 The philosophy behind the design of this subset is
15614 That @value{GDBN} should provide basic literals and access to operations for
15615 arithmetic, dereferencing, field selection, indexing, and subprogram calls,
15616 leaving more sophisticated computations to subprograms written into the
15617 program (which therefore may be called from @value{GDBN}).
15620 That type safety and strict adherence to Ada language restrictions
15621 are not particularly important to the @value{GDBN} user.
15624 That brevity is important to the @value{GDBN} user.
15627 Thus, for brevity, the debugger acts as if all names declared in
15628 user-written packages are directly visible, even if they are not visible
15629 according to Ada rules, thus making it unnecessary to fully qualify most
15630 names with their packages, regardless of context. Where this causes
15631 ambiguity, @value{GDBN} asks the user's intent.
15633 The debugger will start in Ada mode if it detects an Ada main program.
15634 As for other languages, it will enter Ada mode when stopped in a program that
15635 was translated from an Ada source file.
15637 While in Ada mode, you may use `@t{--}' for comments. This is useful
15638 mostly for documenting command files. The standard @value{GDBN} comment
15639 (@samp{#}) still works at the beginning of a line in Ada mode, but not in the
15640 middle (to allow based literals).
15642 The debugger supports limited overloading. Given a subprogram call in which
15643 the function symbol has multiple definitions, it will use the number of
15644 actual parameters and some information about their types to attempt to narrow
15645 the set of definitions. It also makes very limited use of context, preferring
15646 procedures to functions in the context of the @code{call} command, and
15647 functions to procedures elsewhere.
15649 @node Omissions from Ada
15650 @subsubsection Omissions from Ada
15651 @cindex Ada, omissions from
15653 Here are the notable omissions from the subset:
15657 Only a subset of the attributes are supported:
15661 @t{'First}, @t{'Last}, and @t{'Length}
15662 on array objects (not on types and subtypes).
15665 @t{'Min} and @t{'Max}.
15668 @t{'Pos} and @t{'Val}.
15674 @t{'Range} on array objects (not subtypes), but only as the right
15675 operand of the membership (@code{in}) operator.
15678 @t{'Access}, @t{'Unchecked_Access}, and
15679 @t{'Unrestricted_Access} (a GNAT extension).
15687 @code{Characters.Latin_1} are not available and
15688 concatenation is not implemented. Thus, escape characters in strings are
15689 not currently available.
15692 Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise
15693 equality of representations. They will generally work correctly
15694 for strings and arrays whose elements have integer or enumeration types.
15695 They may not work correctly for arrays whose element
15696 types have user-defined equality, for arrays of real values
15697 (in particular, IEEE-conformant floating point, because of negative
15698 zeroes and NaNs), and for arrays whose elements contain unused bits with
15699 indeterminate values.
15702 The other component-by-component array operations (@code{and}, @code{or},
15703 @code{xor}, @code{not}, and relational tests other than equality)
15704 are not implemented.
15707 @cindex array aggregates (Ada)
15708 @cindex record aggregates (Ada)
15709 @cindex aggregates (Ada)
15710 There is limited support for array and record aggregates. They are
15711 permitted only on the right sides of assignments, as in these examples:
15714 (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6)
15715 (@value{GDBP}) set An_Array := (1, others => 0)
15716 (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6)
15717 (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9))
15718 (@value{GDBP}) set A_Record := (1, "Peter", True);
15719 (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True)
15723 discriminant's value by assigning an aggregate has an
15724 undefined effect if that discriminant is used within the record.
15725 However, you can first modify discriminants by directly assigning to
15726 them (which normally would not be allowed in Ada), and then performing an
15727 aggregate assignment. For example, given a variable @code{A_Rec}
15728 declared to have a type such as:
15731 type Rec (Len : Small_Integer := 0) is record
15733 Vals : IntArray (1 .. Len);
15737 you can assign a value with a different size of @code{Vals} with two
15741 (@value{GDBP}) set A_Rec.Len := 4
15742 (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4))
15745 As this example also illustrates, @value{GDBN} is very loose about the usual
15746 rules concerning aggregates. You may leave out some of the
15747 components of an array or record aggregate (such as the @code{Len}
15748 component in the assignment to @code{A_Rec} above); they will retain their
15749 original values upon assignment. You may freely use dynamic values as
15750 indices in component associations. You may even use overlapping or
15751 redundant component associations, although which component values are
15752 assigned in such cases is not defined.
15755 Calls to dispatching subprograms are not implemented.
15758 The overloading algorithm is much more limited (i.e., less selective)
15759 than that of real Ada. It makes only limited use of the context in
15760 which a subexpression appears to resolve its meaning, and it is much
15761 looser in its rules for allowing type matches. As a result, some
15762 function calls will be ambiguous, and the user will be asked to choose
15763 the proper resolution.
15766 The @code{new} operator is not implemented.
15769 Entry calls are not implemented.
15772 Aside from printing, arithmetic operations on the native VAX floating-point
15773 formats are not supported.
15776 It is not possible to slice a packed array.
15779 The names @code{True} and @code{False}, when not part of a qualified name,
15780 are interpreted as if implicitly prefixed by @code{Standard}, regardless of
15782 Should your program
15783 redefine these names in a package or procedure (at best a dubious practice),
15784 you will have to use fully qualified names to access their new definitions.
15787 @node Additions to Ada
15788 @subsubsection Additions to Ada
15789 @cindex Ada, deviations from
15791 As it does for other languages, @value{GDBN} makes certain generic
15792 extensions to Ada (@pxref{Expressions}):
15796 If the expression @var{E} is a variable residing in memory (typically
15797 a local variable or array element) and @var{N} is a positive integer,
15798 then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
15799 @var{N}-1 adjacent variables following it in memory as an array. In
15800 Ada, this operator is generally not necessary, since its prime use is
15801 in displaying parts of an array, and slicing will usually do this in
15802 Ada. However, there are occasional uses when debugging programs in
15803 which certain debugging information has been optimized away.
15806 @code{@var{B}::@var{var}} means ``the variable named @var{var} that
15807 appears in function or file @var{B}.'' When @var{B} is a file name,
15808 you must typically surround it in single quotes.
15811 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
15812 @var{type} that appears at address @var{addr}.''
15815 A name starting with @samp{$} is a convenience variable
15816 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
15819 In addition, @value{GDBN} provides a few other shortcuts and outright
15820 additions specific to Ada:
15824 The assignment statement is allowed as an expression, returning
15825 its right-hand operand as its value. Thus, you may enter
15828 (@value{GDBP}) set x := y + 3
15829 (@value{GDBP}) print A(tmp := y + 1)
15833 The semicolon is allowed as an ``operator,'' returning as its value
15834 the value of its right-hand operand.
15835 This allows, for example,
15836 complex conditional breaks:
15839 (@value{GDBP}) break f
15840 (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100)
15844 Rather than use catenation and symbolic character names to introduce special
15845 characters into strings, one may instead use a special bracket notation,
15846 which is also used to print strings. A sequence of characters of the form
15847 @samp{["@var{XX}"]} within a string or character literal denotes the
15848 (single) character whose numeric encoding is @var{XX} in hexadecimal. The
15849 sequence of characters @samp{["""]} also denotes a single quotation mark
15850 in strings. For example,
15852 "One line.["0a"]Next line.["0a"]"
15855 contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
15859 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
15860 @t{'Max} is optional (and is ignored in any case). For example, it is valid
15864 (@value{GDBP}) print 'max(x, y)
15868 When printing arrays, @value{GDBN} uses positional notation when the
15869 array has a lower bound of 1, and uses a modified named notation otherwise.
15870 For example, a one-dimensional array of three integers with a lower bound
15871 of 3 might print as
15878 That is, in contrast to valid Ada, only the first component has a @code{=>}
15882 You may abbreviate attributes in expressions with any unique,
15883 multi-character subsequence of
15884 their names (an exact match gets preference).
15885 For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh}
15886 in place of @t{a'length}.
15889 @cindex quoting Ada internal identifiers
15890 Since Ada is case-insensitive, the debugger normally maps identifiers you type
15891 to lower case. The GNAT compiler uses upper-case characters for
15892 some of its internal identifiers, which are normally of no interest to users.
15893 For the rare occasions when you actually have to look at them,
15894 enclose them in angle brackets to avoid the lower-case mapping.
15897 (@value{GDBP}) print <JMPBUF_SAVE>[0]
15901 Printing an object of class-wide type or dereferencing an
15902 access-to-class-wide value will display all the components of the object's
15903 specific type (as indicated by its run-time tag). Likewise, component
15904 selection on such a value will operate on the specific type of the
15909 @node Stopping Before Main Program
15910 @subsubsection Stopping at the Very Beginning
15912 @cindex breakpointing Ada elaboration code
15913 It is sometimes necessary to debug the program during elaboration, and
15914 before reaching the main procedure.
15915 As defined in the Ada Reference
15916 Manual, the elaboration code is invoked from a procedure called
15917 @code{adainit}. To run your program up to the beginning of
15918 elaboration, simply use the following two commands:
15919 @code{tbreak adainit} and @code{run}.
15921 @node Ada Exceptions
15922 @subsubsection Ada Exceptions
15924 A command is provided to list all Ada exceptions:
15927 @kindex info exceptions
15928 @item info exceptions
15929 @itemx info exceptions @var{regexp}
15930 The @code{info exceptions} command allows you to list all Ada exceptions
15931 defined within the program being debugged, as well as their addresses.
15932 With a regular expression, @var{regexp}, as argument, only those exceptions
15933 whose names match @var{regexp} are listed.
15936 Below is a small example, showing how the command can be used, first
15937 without argument, and next with a regular expression passed as an
15941 (@value{GDBP}) info exceptions
15942 All defined Ada exceptions:
15943 constraint_error: 0x613da0
15944 program_error: 0x613d20
15945 storage_error: 0x613ce0
15946 tasking_error: 0x613ca0
15947 const.aint_global_e: 0x613b00
15948 (@value{GDBP}) info exceptions const.aint
15949 All Ada exceptions matching regular expression "const.aint":
15950 constraint_error: 0x613da0
15951 const.aint_global_e: 0x613b00
15954 It is also possible to ask @value{GDBN} to stop your program's execution
15955 when an exception is raised. For more details, see @ref{Set Catchpoints}.
15958 @subsubsection Extensions for Ada Tasks
15959 @cindex Ada, tasking
15961 Support for Ada tasks is analogous to that for threads (@pxref{Threads}).
15962 @value{GDBN} provides the following task-related commands:
15967 This command shows a list of current Ada tasks, as in the following example:
15974 (@value{GDBP}) info tasks
15975 ID TID P-ID Pri State Name
15976 1 8088000 0 15 Child Activation Wait main_task
15977 2 80a4000 1 15 Accept Statement b
15978 3 809a800 1 15 Child Activation Wait a
15979 * 4 80ae800 3 15 Runnable c
15984 In this listing, the asterisk before the last task indicates it to be the
15985 task currently being inspected.
15989 Represents @value{GDBN}'s internal task number.
15995 The parent's task ID (@value{GDBN}'s internal task number).
15998 The base priority of the task.
16001 Current state of the task.
16005 The task has been created but has not been activated. It cannot be
16009 The task is not blocked for any reason known to Ada. (It may be waiting
16010 for a mutex, though.) It is conceptually "executing" in normal mode.
16013 The task is terminated, in the sense of ARM 9.3 (5). Any dependents
16014 that were waiting on terminate alternatives have been awakened and have
16015 terminated themselves.
16017 @item Child Activation Wait
16018 The task is waiting for created tasks to complete activation.
16020 @item Accept Statement
16021 The task is waiting on an accept or selective wait statement.
16023 @item Waiting on entry call
16024 The task is waiting on an entry call.
16026 @item Async Select Wait
16027 The task is waiting to start the abortable part of an asynchronous
16031 The task is waiting on a select statement with only a delay
16034 @item Child Termination Wait
16035 The task is sleeping having completed a master within itself, and is
16036 waiting for the tasks dependent on that master to become terminated or
16037 waiting on a terminate Phase.
16039 @item Wait Child in Term Alt
16040 The task is sleeping waiting for tasks on terminate alternatives to
16041 finish terminating.
16043 @item Accepting RV with @var{taskno}
16044 The task is accepting a rendez-vous with the task @var{taskno}.
16048 Name of the task in the program.
16052 @kindex info task @var{taskno}
16053 @item info task @var{taskno}
16054 This command shows detailled informations on the specified task, as in
16055 the following example:
16060 (@value{GDBP}) info tasks
16061 ID TID P-ID Pri State Name
16062 1 8077880 0 15 Child Activation Wait main_task
16063 * 2 807c468 1 15 Runnable task_1
16064 (@value{GDBP}) info task 2
16065 Ada Task: 0x807c468
16068 Parent: 1 (main_task)
16074 @kindex task@r{ (Ada)}
16075 @cindex current Ada task ID
16076 This command prints the ID of the current task.
16082 (@value{GDBP}) info tasks
16083 ID TID P-ID Pri State Name
16084 1 8077870 0 15 Child Activation Wait main_task
16085 * 2 807c458 1 15 Runnable t
16086 (@value{GDBP}) task
16087 [Current task is 2]
16090 @item task @var{taskno}
16091 @cindex Ada task switching
16092 This command is like the @code{thread @var{threadno}}
16093 command (@pxref{Threads}). It switches the context of debugging
16094 from the current task to the given task.
16100 (@value{GDBP}) info tasks
16101 ID TID P-ID Pri State Name
16102 1 8077870 0 15 Child Activation Wait main_task
16103 * 2 807c458 1 15 Runnable t
16104 (@value{GDBP}) task 1
16105 [Switching to task 1]
16106 #0 0x8067726 in pthread_cond_wait ()
16108 #0 0x8067726 in pthread_cond_wait ()
16109 #1 0x8056714 in system.os_interface.pthread_cond_wait ()
16110 #2 0x805cb63 in system.task_primitives.operations.sleep ()
16111 #3 0x806153e in system.tasking.stages.activate_tasks ()
16112 #4 0x804aacc in un () at un.adb:5
16115 @item break @var{location} task @var{taskno}
16116 @itemx break @var{location} task @var{taskno} if @dots{}
16117 @cindex breakpoints and tasks, in Ada
16118 @cindex task breakpoints, in Ada
16119 @kindex break @dots{} task @var{taskno}@r{ (Ada)}
16120 These commands are like the @code{break @dots{} thread @dots{}}
16121 command (@pxref{Thread Stops}). The
16122 @var{location} argument specifies source lines, as described
16123 in @ref{Specify Location}.
16125 Use the qualifier @samp{task @var{taskno}} with a breakpoint command
16126 to specify that you only want @value{GDBN} to stop the program when a
16127 particular Ada task reaches this breakpoint. The @var{taskno} is one of the
16128 numeric task identifiers assigned by @value{GDBN}, shown in the first
16129 column of the @samp{info tasks} display.
16131 If you do not specify @samp{task @var{taskno}} when you set a
16132 breakpoint, the breakpoint applies to @emph{all} tasks of your
16135 You can use the @code{task} qualifier on conditional breakpoints as
16136 well; in this case, place @samp{task @var{taskno}} before the
16137 breakpoint condition (before the @code{if}).
16145 (@value{GDBP}) info tasks
16146 ID TID P-ID Pri State Name
16147 1 140022020 0 15 Child Activation Wait main_task
16148 2 140045060 1 15 Accept/Select Wait t2
16149 3 140044840 1 15 Runnable t1
16150 * 4 140056040 1 15 Runnable t3
16151 (@value{GDBP}) b 15 task 2
16152 Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15.
16153 (@value{GDBP}) cont
16158 Breakpoint 5, test_task_debug () at test_task_debug.adb:15
16160 (@value{GDBP}) info tasks
16161 ID TID P-ID Pri State Name
16162 1 140022020 0 15 Child Activation Wait main_task
16163 * 2 140045060 1 15 Runnable t2
16164 3 140044840 1 15 Runnable t1
16165 4 140056040 1 15 Delay Sleep t3
16169 @node Ada Tasks and Core Files
16170 @subsubsection Tasking Support when Debugging Core Files
16171 @cindex Ada tasking and core file debugging
16173 When inspecting a core file, as opposed to debugging a live program,
16174 tasking support may be limited or even unavailable, depending on
16175 the platform being used.
16176 For instance, on x86-linux, the list of tasks is available, but task
16177 switching is not supported.
16179 On certain platforms, the debugger needs to perform some
16180 memory writes in order to provide Ada tasking support. When inspecting
16181 a core file, this means that the core file must be opened with read-write
16182 privileges, using the command @samp{"set write on"} (@pxref{Patching}).
16183 Under these circumstances, you should make a backup copy of the core
16184 file before inspecting it with @value{GDBN}.
16186 @node Ravenscar Profile
16187 @subsubsection Tasking Support when using the Ravenscar Profile
16188 @cindex Ravenscar Profile
16190 The @dfn{Ravenscar Profile} is a subset of the Ada tasking features,
16191 specifically designed for systems with safety-critical real-time
16195 @kindex set ravenscar task-switching on
16196 @cindex task switching with program using Ravenscar Profile
16197 @item set ravenscar task-switching on
16198 Allows task switching when debugging a program that uses the Ravenscar
16199 Profile. This is the default.
16201 @kindex set ravenscar task-switching off
16202 @item set ravenscar task-switching off
16203 Turn off task switching when debugging a program that uses the Ravenscar
16204 Profile. This is mostly intended to disable the code that adds support
16205 for the Ravenscar Profile, in case a bug in either @value{GDBN} or in
16206 the Ravenscar runtime is preventing @value{GDBN} from working properly.
16207 To be effective, this command should be run before the program is started.
16209 @kindex show ravenscar task-switching
16210 @item show ravenscar task-switching
16211 Show whether it is possible to switch from task to task in a program
16212 using the Ravenscar Profile.
16217 @subsubsection Known Peculiarities of Ada Mode
16218 @cindex Ada, problems
16220 Besides the omissions listed previously (@pxref{Omissions from Ada}),
16221 we know of several problems with and limitations of Ada mode in
16223 some of which will be fixed with planned future releases of the debugger
16224 and the GNU Ada compiler.
16228 Static constants that the compiler chooses not to materialize as objects in
16229 storage are invisible to the debugger.
16232 Named parameter associations in function argument lists are ignored (the
16233 argument lists are treated as positional).
16236 Many useful library packages are currently invisible to the debugger.
16239 Fixed-point arithmetic, conversions, input, and output is carried out using
16240 floating-point arithmetic, and may give results that only approximate those on
16244 The GNAT compiler never generates the prefix @code{Standard} for any of
16245 the standard symbols defined by the Ada language. @value{GDBN} knows about
16246 this: it will strip the prefix from names when you use it, and will never
16247 look for a name you have so qualified among local symbols, nor match against
16248 symbols in other packages or subprograms. If you have
16249 defined entities anywhere in your program other than parameters and
16250 local variables whose simple names match names in @code{Standard},
16251 GNAT's lack of qualification here can cause confusion. When this happens,
16252 you can usually resolve the confusion
16253 by qualifying the problematic names with package
16254 @code{Standard} explicitly.
16257 Older versions of the compiler sometimes generate erroneous debugging
16258 information, resulting in the debugger incorrectly printing the value
16259 of affected entities. In some cases, the debugger is able to work
16260 around an issue automatically. In other cases, the debugger is able
16261 to work around the issue, but the work-around has to be specifically
16264 @kindex set ada trust-PAD-over-XVS
16265 @kindex show ada trust-PAD-over-XVS
16268 @item set ada trust-PAD-over-XVS on
16269 Configure GDB to strictly follow the GNAT encoding when computing the
16270 value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS}
16271 types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for
16272 a complete description of the encoding used by the GNAT compiler).
16273 This is the default.
16275 @item set ada trust-PAD-over-XVS off
16276 This is related to the encoding using by the GNAT compiler. If @value{GDBN}
16277 sometimes prints the wrong value for certain entities, changing @code{ada
16278 trust-PAD-over-XVS} to @code{off} activates a work-around which may fix
16279 the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to
16280 @code{off}, but this incurs a slight performance penalty, so it is
16281 recommended to leave this setting to @code{on} unless necessary.
16285 @cindex GNAT descriptive types
16286 @cindex GNAT encoding
16287 Internally, the debugger also relies on the compiler following a number
16288 of conventions known as the @samp{GNAT Encoding}, all documented in
16289 @file{gcc/ada/exp_dbug.ads} in the GCC sources. This encoding describes
16290 how the debugging information should be generated for certain types.
16291 In particular, this convention makes use of @dfn{descriptive types},
16292 which are artificial types generated purely to help the debugger.
16294 These encodings were defined at a time when the debugging information
16295 format used was not powerful enough to describe some of the more complex
16296 types available in Ada. Since DWARF allows us to express nearly all
16297 Ada features, the long-term goal is to slowly replace these descriptive
16298 types by their pure DWARF equivalent. To facilitate that transition,
16299 a new maintenance option is available to force the debugger to ignore
16300 those descriptive types. It allows the user to quickly evaluate how
16301 well @value{GDBN} works without them.
16305 @kindex maint ada set ignore-descriptive-types
16306 @item maintenance ada set ignore-descriptive-types [on|off]
16307 Control whether the debugger should ignore descriptive types.
16308 The default is not to ignore descriptives types (@code{off}).
16310 @kindex maint ada show ignore-descriptive-types
16311 @item maintenance ada show ignore-descriptive-types
16312 Show if descriptive types are ignored by @value{GDBN}.
16316 @node Unsupported Languages
16317 @section Unsupported Languages
16319 @cindex unsupported languages
16320 @cindex minimal language
16321 In addition to the other fully-supported programming languages,
16322 @value{GDBN} also provides a pseudo-language, called @code{minimal}.
16323 It does not represent a real programming language, but provides a set
16324 of capabilities close to what the C or assembly languages provide.
16325 This should allow most simple operations to be performed while debugging
16326 an application that uses a language currently not supported by @value{GDBN}.
16328 If the language is set to @code{auto}, @value{GDBN} will automatically
16329 select this language if the current frame corresponds to an unsupported
16333 @chapter Examining the Symbol Table
16335 The commands described in this chapter allow you to inquire about the
16336 symbols (names of variables, functions and types) defined in your
16337 program. This information is inherent in the text of your program and
16338 does not change as your program executes. @value{GDBN} finds it in your
16339 program's symbol table, in the file indicated when you started @value{GDBN}
16340 (@pxref{File Options, ,Choosing Files}), or by one of the
16341 file-management commands (@pxref{Files, ,Commands to Specify Files}).
16343 @cindex symbol names
16344 @cindex names of symbols
16345 @cindex quoting names
16346 Occasionally, you may need to refer to symbols that contain unusual
16347 characters, which @value{GDBN} ordinarily treats as word delimiters. The
16348 most frequent case is in referring to static variables in other
16349 source files (@pxref{Variables,,Program Variables}). File names
16350 are recorded in object files as debugging symbols, but @value{GDBN} would
16351 ordinarily parse a typical file name, like @file{foo.c}, as the three words
16352 @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize
16353 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
16360 looks up the value of @code{x} in the scope of the file @file{foo.c}.
16363 @cindex case-insensitive symbol names
16364 @cindex case sensitivity in symbol names
16365 @kindex set case-sensitive
16366 @item set case-sensitive on
16367 @itemx set case-sensitive off
16368 @itemx set case-sensitive auto
16369 Normally, when @value{GDBN} looks up symbols, it matches their names
16370 with case sensitivity determined by the current source language.
16371 Occasionally, you may wish to control that. The command @code{set
16372 case-sensitive} lets you do that by specifying @code{on} for
16373 case-sensitive matches or @code{off} for case-insensitive ones. If
16374 you specify @code{auto}, case sensitivity is reset to the default
16375 suitable for the source language. The default is case-sensitive
16376 matches for all languages except for Fortran, for which the default is
16377 case-insensitive matches.
16379 @kindex show case-sensitive
16380 @item show case-sensitive
16381 This command shows the current setting of case sensitivity for symbols
16384 @kindex set print type methods
16385 @item set print type methods
16386 @itemx set print type methods on
16387 @itemx set print type methods off
16388 Normally, when @value{GDBN} prints a class, it displays any methods
16389 declared in that class. You can control this behavior either by
16390 passing the appropriate flag to @code{ptype}, or using @command{set
16391 print type methods}. Specifying @code{on} will cause @value{GDBN} to
16392 display the methods; this is the default. Specifying @code{off} will
16393 cause @value{GDBN} to omit the methods.
16395 @kindex show print type methods
16396 @item show print type methods
16397 This command shows the current setting of method display when printing
16400 @kindex set print type typedefs
16401 @item set print type typedefs
16402 @itemx set print type typedefs on
16403 @itemx set print type typedefs off
16405 Normally, when @value{GDBN} prints a class, it displays any typedefs
16406 defined in that class. You can control this behavior either by
16407 passing the appropriate flag to @code{ptype}, or using @command{set
16408 print type typedefs}. Specifying @code{on} will cause @value{GDBN} to
16409 display the typedef definitions; this is the default. Specifying
16410 @code{off} will cause @value{GDBN} to omit the typedef definitions.
16411 Note that this controls whether the typedef definition itself is
16412 printed, not whether typedef names are substituted when printing other
16415 @kindex show print type typedefs
16416 @item show print type typedefs
16417 This command shows the current setting of typedef display when
16420 @kindex info address
16421 @cindex address of a symbol
16422 @item info address @var{symbol}
16423 Describe where the data for @var{symbol} is stored. For a register
16424 variable, this says which register it is kept in. For a non-register
16425 local variable, this prints the stack-frame offset at which the variable
16428 Note the contrast with @samp{print &@var{symbol}}, which does not work
16429 at all for a register variable, and for a stack local variable prints
16430 the exact address of the current instantiation of the variable.
16432 @kindex info symbol
16433 @cindex symbol from address
16434 @cindex closest symbol and offset for an address
16435 @item info symbol @var{addr}
16436 Print the name of a symbol which is stored at the address @var{addr}.
16437 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
16438 nearest symbol and an offset from it:
16441 (@value{GDBP}) info symbol 0x54320
16442 _initialize_vx + 396 in section .text
16446 This is the opposite of the @code{info address} command. You can use
16447 it to find out the name of a variable or a function given its address.
16449 For dynamically linked executables, the name of executable or shared
16450 library containing the symbol is also printed:
16453 (@value{GDBP}) info symbol 0x400225
16454 _start + 5 in section .text of /tmp/a.out
16455 (@value{GDBP}) info symbol 0x2aaaac2811cf
16456 __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6
16461 @item demangle @r{[}-l @var{language}@r{]} @r{[}@var{--}@r{]} @var{name}
16462 Demangle @var{name}.
16463 If @var{language} is provided it is the name of the language to demangle
16464 @var{name} in. Otherwise @var{name} is demangled in the current language.
16466 The @samp{--} option specifies the end of options,
16467 and is useful when @var{name} begins with a dash.
16469 The parameter @code{demangle-style} specifies how to interpret the kind
16470 of mangling used. @xref{Print Settings}.
16473 @item whatis[/@var{flags}] [@var{arg}]
16474 Print the data type of @var{arg}, which can be either an expression
16475 or a name of a data type. With no argument, print the data type of
16476 @code{$}, the last value in the value history.
16478 If @var{arg} is an expression (@pxref{Expressions, ,Expressions}), it
16479 is not actually evaluated, and any side-effecting operations (such as
16480 assignments or function calls) inside it do not take place.
16482 If @var{arg} is a variable or an expression, @code{whatis} prints its
16483 literal type as it is used in the source code. If the type was
16484 defined using a @code{typedef}, @code{whatis} will @emph{not} print
16485 the data type underlying the @code{typedef}. If the type of the
16486 variable or the expression is a compound data type, such as
16487 @code{struct} or @code{class}, @code{whatis} never prints their
16488 fields or methods. It just prints the @code{struct}/@code{class}
16489 name (a.k.a.@: its @dfn{tag}). If you want to see the members of
16490 such a compound data type, use @code{ptype}.
16492 If @var{arg} is a type name that was defined using @code{typedef},
16493 @code{whatis} @dfn{unrolls} only one level of that @code{typedef}.
16494 Unrolling means that @code{whatis} will show the underlying type used
16495 in the @code{typedef} declaration of @var{arg}. However, if that
16496 underlying type is also a @code{typedef}, @code{whatis} will not
16499 For C code, the type names may also have the form @samp{class
16500 @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union
16501 @var{union-tag}} or @samp{enum @var{enum-tag}}.
16503 @var{flags} can be used to modify how the type is displayed.
16504 Available flags are:
16508 Display in ``raw'' form. Normally, @value{GDBN} substitutes template
16509 parameters and typedefs defined in a class when printing the class'
16510 members. The @code{/r} flag disables this.
16513 Do not print methods defined in the class.
16516 Print methods defined in the class. This is the default, but the flag
16517 exists in case you change the default with @command{set print type methods}.
16520 Do not print typedefs defined in the class. Note that this controls
16521 whether the typedef definition itself is printed, not whether typedef
16522 names are substituted when printing other types.
16525 Print typedefs defined in the class. This is the default, but the flag
16526 exists in case you change the default with @command{set print type typedefs}.
16530 @item ptype[/@var{flags}] [@var{arg}]
16531 @code{ptype} accepts the same arguments as @code{whatis}, but prints a
16532 detailed description of the type, instead of just the name of the type.
16533 @xref{Expressions, ,Expressions}.
16535 Contrary to @code{whatis}, @code{ptype} always unrolls any
16536 @code{typedef}s in its argument declaration, whether the argument is
16537 a variable, expression, or a data type. This means that @code{ptype}
16538 of a variable or an expression will not print literally its type as
16539 present in the source code---use @code{whatis} for that. @code{typedef}s at
16540 the pointer or reference targets are also unrolled. Only @code{typedef}s of
16541 fields, methods and inner @code{class typedef}s of @code{struct}s,
16542 @code{class}es and @code{union}s are not unrolled even with @code{ptype}.
16544 For example, for this variable declaration:
16547 typedef double real_t;
16548 struct complex @{ real_t real; double imag; @};
16549 typedef struct complex complex_t;
16551 real_t *real_pointer_var;
16555 the two commands give this output:
16559 (@value{GDBP}) whatis var
16561 (@value{GDBP}) ptype var
16562 type = struct complex @{
16566 (@value{GDBP}) whatis complex_t
16567 type = struct complex
16568 (@value{GDBP}) whatis struct complex
16569 type = struct complex
16570 (@value{GDBP}) ptype struct complex
16571 type = struct complex @{
16575 (@value{GDBP}) whatis real_pointer_var
16577 (@value{GDBP}) ptype real_pointer_var
16583 As with @code{whatis}, using @code{ptype} without an argument refers to
16584 the type of @code{$}, the last value in the value history.
16586 @cindex incomplete type
16587 Sometimes, programs use opaque data types or incomplete specifications
16588 of complex data structure. If the debug information included in the
16589 program does not allow @value{GDBN} to display a full declaration of
16590 the data type, it will say @samp{<incomplete type>}. For example,
16591 given these declarations:
16595 struct foo *fooptr;
16599 but no definition for @code{struct foo} itself, @value{GDBN} will say:
16602 (@value{GDBP}) ptype foo
16603 $1 = <incomplete type>
16607 ``Incomplete type'' is C terminology for data types that are not
16608 completely specified.
16611 @item info types @var{regexp}
16613 Print a brief description of all types whose names match the regular
16614 expression @var{regexp} (or all types in your program, if you supply
16615 no argument). Each complete typename is matched as though it were a
16616 complete line; thus, @samp{i type value} gives information on all
16617 types in your program whose names include the string @code{value}, but
16618 @samp{i type ^value$} gives information only on types whose complete
16619 name is @code{value}.
16621 This command differs from @code{ptype} in two ways: first, like
16622 @code{whatis}, it does not print a detailed description; second, it
16623 lists all source files where a type is defined.
16625 @kindex info type-printers
16626 @item info type-printers
16627 Versions of @value{GDBN} that ship with Python scripting enabled may
16628 have ``type printers'' available. When using @command{ptype} or
16629 @command{whatis}, these printers are consulted when the name of a type
16630 is needed. @xref{Type Printing API}, for more information on writing
16633 @code{info type-printers} displays all the available type printers.
16635 @kindex enable type-printer
16636 @kindex disable type-printer
16637 @item enable type-printer @var{name}@dots{}
16638 @item disable type-printer @var{name}@dots{}
16639 These commands can be used to enable or disable type printers.
16642 @cindex local variables
16643 @item info scope @var{location}
16644 List all the variables local to a particular scope. This command
16645 accepts a @var{location} argument---a function name, a source line, or
16646 an address preceded by a @samp{*}, and prints all the variables local
16647 to the scope defined by that location. (@xref{Specify Location}, for
16648 details about supported forms of @var{location}.) For example:
16651 (@value{GDBP}) @b{info scope command_line_handler}
16652 Scope for command_line_handler:
16653 Symbol rl is an argument at stack/frame offset 8, length 4.
16654 Symbol linebuffer is in static storage at address 0x150a18, length 4.
16655 Symbol linelength is in static storage at address 0x150a1c, length 4.
16656 Symbol p is a local variable in register $esi, length 4.
16657 Symbol p1 is a local variable in register $ebx, length 4.
16658 Symbol nline is a local variable in register $edx, length 4.
16659 Symbol repeat is a local variable at frame offset -8, length 4.
16663 This command is especially useful for determining what data to collect
16664 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
16667 @kindex info source
16669 Show information about the current source file---that is, the source file for
16670 the function containing the current point of execution:
16673 the name of the source file, and the directory containing it,
16675 the directory it was compiled in,
16677 its length, in lines,
16679 which programming language it is written in,
16681 if the debug information provides it, the program that compiled the file
16682 (which may include, e.g., the compiler version and command line arguments),
16684 whether the executable includes debugging information for that file, and
16685 if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and
16687 whether the debugging information includes information about
16688 preprocessor macros.
16692 @kindex info sources
16694 Print the names of all source files in your program for which there is
16695 debugging information, organized into two lists: files whose symbols
16696 have already been read, and files whose symbols will be read when needed.
16698 @kindex info functions
16699 @item info functions
16700 Print the names and data types of all defined functions.
16702 @item info functions @var{regexp}
16703 Print the names and data types of all defined functions
16704 whose names contain a match for regular expression @var{regexp}.
16705 Thus, @samp{info fun step} finds all functions whose names
16706 include @code{step}; @samp{info fun ^step} finds those whose names
16707 start with @code{step}. If a function name contains characters
16708 that conflict with the regular expression language (e.g.@:
16709 @samp{operator*()}), they may be quoted with a backslash.
16711 @kindex info variables
16712 @item info variables
16713 Print the names and data types of all variables that are defined
16714 outside of functions (i.e.@: excluding local variables).
16716 @item info variables @var{regexp}
16717 Print the names and data types of all variables (except for local
16718 variables) whose names contain a match for regular expression
16721 @kindex info classes
16722 @cindex Objective-C, classes and selectors
16724 @itemx info classes @var{regexp}
16725 Display all Objective-C classes in your program, or
16726 (with the @var{regexp} argument) all those matching a particular regular
16729 @kindex info selectors
16730 @item info selectors
16731 @itemx info selectors @var{regexp}
16732 Display all Objective-C selectors in your program, or
16733 (with the @var{regexp} argument) all those matching a particular regular
16737 This was never implemented.
16738 @kindex info methods
16740 @itemx info methods @var{regexp}
16741 The @code{info methods} command permits the user to examine all defined
16742 methods within C@t{++} program, or (with the @var{regexp} argument) a
16743 specific set of methods found in the various C@t{++} classes. Many
16744 C@t{++} classes provide a large number of methods. Thus, the output
16745 from the @code{ptype} command can be overwhelming and hard to use. The
16746 @code{info-methods} command filters the methods, printing only those
16747 which match the regular-expression @var{regexp}.
16750 @cindex opaque data types
16751 @kindex set opaque-type-resolution
16752 @item set opaque-type-resolution on
16753 Tell @value{GDBN} to resolve opaque types. An opaque type is a type
16754 declared as a pointer to a @code{struct}, @code{class}, or
16755 @code{union}---for example, @code{struct MyType *}---that is used in one
16756 source file although the full declaration of @code{struct MyType} is in
16757 another source file. The default is on.
16759 A change in the setting of this subcommand will not take effect until
16760 the next time symbols for a file are loaded.
16762 @item set opaque-type-resolution off
16763 Tell @value{GDBN} not to resolve opaque types. In this case, the type
16764 is printed as follows:
16766 @{<no data fields>@}
16769 @kindex show opaque-type-resolution
16770 @item show opaque-type-resolution
16771 Show whether opaque types are resolved or not.
16773 @kindex set print symbol-loading
16774 @cindex print messages when symbols are loaded
16775 @item set print symbol-loading
16776 @itemx set print symbol-loading full
16777 @itemx set print symbol-loading brief
16778 @itemx set print symbol-loading off
16779 The @code{set print symbol-loading} command allows you to control the
16780 printing of messages when @value{GDBN} loads symbol information.
16781 By default a message is printed for the executable and one for each
16782 shared library, and normally this is what you want. However, when
16783 debugging apps with large numbers of shared libraries these messages
16785 When set to @code{brief} a message is printed for each executable,
16786 and when @value{GDBN} loads a collection of shared libraries at once
16787 it will only print one message regardless of the number of shared
16788 libraries. When set to @code{off} no messages are printed.
16790 @kindex show print symbol-loading
16791 @item show print symbol-loading
16792 Show whether messages will be printed when a @value{GDBN} command
16793 entered from the keyboard causes symbol information to be loaded.
16795 @kindex maint print symbols
16796 @cindex symbol dump
16797 @kindex maint print psymbols
16798 @cindex partial symbol dump
16799 @kindex maint print msymbols
16800 @cindex minimal symbol dump
16801 @item maint print symbols @var{filename}
16802 @itemx maint print psymbols @var{filename}
16803 @itemx maint print msymbols @var{filename}
16804 Write a dump of debugging symbol data into the file @var{filename}.
16805 These commands are used to debug the @value{GDBN} symbol-reading code. Only
16806 symbols with debugging data are included. If you use @samp{maint print
16807 symbols}, @value{GDBN} includes all the symbols for which it has already
16808 collected full details: that is, @var{filename} reflects symbols for
16809 only those files whose symbols @value{GDBN} has read. You can use the
16810 command @code{info sources} to find out which files these are. If you
16811 use @samp{maint print psymbols} instead, the dump shows information about
16812 symbols that @value{GDBN} only knows partially---that is, symbols defined in
16813 files that @value{GDBN} has skimmed, but not yet read completely. Finally,
16814 @samp{maint print msymbols} dumps just the minimal symbol information
16815 required for each object file from which @value{GDBN} has read some symbols.
16816 @xref{Files, ,Commands to Specify Files}, for a discussion of how
16817 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
16819 @kindex maint info symtabs
16820 @kindex maint info psymtabs
16821 @cindex listing @value{GDBN}'s internal symbol tables
16822 @cindex symbol tables, listing @value{GDBN}'s internal
16823 @cindex full symbol tables, listing @value{GDBN}'s internal
16824 @cindex partial symbol tables, listing @value{GDBN}'s internal
16825 @item maint info symtabs @r{[} @var{regexp} @r{]}
16826 @itemx maint info psymtabs @r{[} @var{regexp} @r{]}
16828 List the @code{struct symtab} or @code{struct partial_symtab}
16829 structures whose names match @var{regexp}. If @var{regexp} is not
16830 given, list them all. The output includes expressions which you can
16831 copy into a @value{GDBN} debugging this one to examine a particular
16832 structure in more detail. For example:
16835 (@value{GDBP}) maint info psymtabs dwarf2read
16836 @{ objfile /home/gnu/build/gdb/gdb
16837 ((struct objfile *) 0x82e69d0)
16838 @{ psymtab /home/gnu/src/gdb/dwarf2read.c
16839 ((struct partial_symtab *) 0x8474b10)
16842 text addresses 0x814d3c8 -- 0x8158074
16843 globals (* (struct partial_symbol **) 0x8507a08 @@ 9)
16844 statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882)
16845 dependencies (none)
16848 (@value{GDBP}) maint info symtabs
16852 We see that there is one partial symbol table whose filename contains
16853 the string @samp{dwarf2read}, belonging to the @samp{gdb} executable;
16854 and we see that @value{GDBN} has not read in any symtabs yet at all.
16855 If we set a breakpoint on a function, that will cause @value{GDBN} to
16856 read the symtab for the compilation unit containing that function:
16859 (@value{GDBP}) break dwarf2_psymtab_to_symtab
16860 Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c,
16862 (@value{GDBP}) maint info symtabs
16863 @{ objfile /home/gnu/build/gdb/gdb
16864 ((struct objfile *) 0x82e69d0)
16865 @{ symtab /home/gnu/src/gdb/dwarf2read.c
16866 ((struct symtab *) 0x86c1f38)
16869 blockvector ((struct blockvector *) 0x86c1bd0) (primary)
16870 linetable ((struct linetable *) 0x8370fa0)
16871 debugformat DWARF 2
16877 @kindex maint set symbol-cache-size
16878 @cindex symbol cache size
16879 @item maint set symbol-cache-size @var{size}
16880 Set the size of the symbol cache to @var{size}.
16881 The default size is intended to be good enough for debugging
16882 most applications. This option exists to allow for experimenting
16883 with different sizes.
16885 @kindex maint show symbol-cache-size
16886 @item maint show symbol-cache-size
16887 Show the size of the symbol cache.
16889 @kindex maint print symbol-cache
16890 @cindex symbol cache, printing its contents
16891 @item maint print symbol-cache
16892 Print the contents of the symbol cache.
16893 This is useful when debugging symbol cache issues.
16895 @kindex maint print symbol-cache-statistics
16896 @cindex symbol cache, printing usage statistics
16897 @item maint print symbol-cache-statistics
16898 Print symbol cache usage statistics.
16899 This helps determine how well the cache is being utilized.
16901 @kindex maint flush-symbol-cache
16902 @cindex symbol cache, flushing
16903 @item maint flush-symbol-cache
16904 Flush the contents of the symbol cache, all entries are removed.
16905 This command is useful when debugging the symbol cache.
16906 It is also useful when collecting performance data.
16911 @chapter Altering Execution
16913 Once you think you have found an error in your program, you might want to
16914 find out for certain whether correcting the apparent error would lead to
16915 correct results in the rest of the run. You can find the answer by
16916 experiment, using the @value{GDBN} features for altering execution of the
16919 For example, you can store new values into variables or memory
16920 locations, give your program a signal, restart it at a different
16921 address, or even return prematurely from a function.
16924 * Assignment:: Assignment to variables
16925 * Jumping:: Continuing at a different address
16926 * Signaling:: Giving your program a signal
16927 * Returning:: Returning from a function
16928 * Calling:: Calling your program's functions
16929 * Patching:: Patching your program
16930 * Compiling and Injecting Code:: Compiling and injecting code in @value{GDBN}
16934 @section Assignment to Variables
16937 @cindex setting variables
16938 To alter the value of a variable, evaluate an assignment expression.
16939 @xref{Expressions, ,Expressions}. For example,
16946 stores the value 4 into the variable @code{x}, and then prints the
16947 value of the assignment expression (which is 4).
16948 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
16949 information on operators in supported languages.
16951 @kindex set variable
16952 @cindex variables, setting
16953 If you are not interested in seeing the value of the assignment, use the
16954 @code{set} command instead of the @code{print} command. @code{set} is
16955 really the same as @code{print} except that the expression's value is
16956 not printed and is not put in the value history (@pxref{Value History,
16957 ,Value History}). The expression is evaluated only for its effects.
16959 If the beginning of the argument string of the @code{set} command
16960 appears identical to a @code{set} subcommand, use the @code{set
16961 variable} command instead of just @code{set}. This command is identical
16962 to @code{set} except for its lack of subcommands. For example, if your
16963 program has a variable @code{width}, you get an error if you try to set
16964 a new value with just @samp{set width=13}, because @value{GDBN} has the
16965 command @code{set width}:
16968 (@value{GDBP}) whatis width
16970 (@value{GDBP}) p width
16972 (@value{GDBP}) set width=47
16973 Invalid syntax in expression.
16977 The invalid expression, of course, is @samp{=47}. In
16978 order to actually set the program's variable @code{width}, use
16981 (@value{GDBP}) set var width=47
16984 Because the @code{set} command has many subcommands that can conflict
16985 with the names of program variables, it is a good idea to use the
16986 @code{set variable} command instead of just @code{set}. For example, if
16987 your program has a variable @code{g}, you run into problems if you try
16988 to set a new value with just @samp{set g=4}, because @value{GDBN} has
16989 the command @code{set gnutarget}, abbreviated @code{set g}:
16993 (@value{GDBP}) whatis g
16997 (@value{GDBP}) set g=4
17001 The program being debugged has been started already.
17002 Start it from the beginning? (y or n) y
17003 Starting program: /home/smith/cc_progs/a.out
17004 "/home/smith/cc_progs/a.out": can't open to read symbols:
17005 Invalid bfd target.
17006 (@value{GDBP}) show g
17007 The current BFD target is "=4".
17012 The program variable @code{g} did not change, and you silently set the
17013 @code{gnutarget} to an invalid value. In order to set the variable
17017 (@value{GDBP}) set var g=4
17020 @value{GDBN} allows more implicit conversions in assignments than C; you can
17021 freely store an integer value into a pointer variable or vice versa,
17022 and you can convert any structure to any other structure that is the
17023 same length or shorter.
17024 @comment FIXME: how do structs align/pad in these conversions?
17025 @comment /doc@cygnus.com 18dec1990
17027 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
17028 construct to generate a value of specified type at a specified address
17029 (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers
17030 to memory location @code{0x83040} as an integer (which implies a certain size
17031 and representation in memory), and
17034 set @{int@}0x83040 = 4
17038 stores the value 4 into that memory location.
17041 @section Continuing at a Different Address
17043 Ordinarily, when you continue your program, you do so at the place where
17044 it stopped, with the @code{continue} command. You can instead continue at
17045 an address of your own choosing, with the following commands:
17049 @kindex j @r{(@code{jump})}
17050 @item jump @var{location}
17051 @itemx j @var{location}
17052 Resume execution at @var{location}. Execution stops again immediately
17053 if there is a breakpoint there. @xref{Specify Location}, for a description
17054 of the different forms of @var{location}. It is common
17055 practice to use the @code{tbreak} command in conjunction with
17056 @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}.
17058 The @code{jump} command does not change the current stack frame, or
17059 the stack pointer, or the contents of any memory location or any
17060 register other than the program counter. If @var{location} is in
17061 a different function from the one currently executing, the results may
17062 be bizarre if the two functions expect different patterns of arguments or
17063 of local variables. For this reason, the @code{jump} command requests
17064 confirmation if the specified line is not in the function currently
17065 executing. However, even bizarre results are predictable if you are
17066 well acquainted with the machine-language code of your program.
17069 @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt.
17070 On many systems, you can get much the same effect as the @code{jump}
17071 command by storing a new value into the register @code{$pc}. The
17072 difference is that this does not start your program running; it only
17073 changes the address of where it @emph{will} run when you continue. For
17081 makes the next @code{continue} command or stepping command execute at
17082 address @code{0x485}, rather than at the address where your program stopped.
17083 @xref{Continuing and Stepping, ,Continuing and Stepping}.
17085 The most common occasion to use the @code{jump} command is to back
17086 up---perhaps with more breakpoints set---over a portion of a program
17087 that has already executed, in order to examine its execution in more
17092 @section Giving your Program a Signal
17093 @cindex deliver a signal to a program
17097 @item signal @var{signal}
17098 Resume execution where your program is stopped, but immediately give it the
17099 signal @var{signal}. The @var{signal} can be the name or the number of a
17100 signal. For example, on many systems @code{signal 2} and @code{signal
17101 SIGINT} are both ways of sending an interrupt signal.
17103 Alternatively, if @var{signal} is zero, continue execution without
17104 giving a signal. This is useful when your program stopped on account of
17105 a signal and would ordinarily see the signal when resumed with the
17106 @code{continue} command; @samp{signal 0} causes it to resume without a
17109 @emph{Note:} When resuming a multi-threaded program, @var{signal} is
17110 delivered to the currently selected thread, not the thread that last
17111 reported a stop. This includes the situation where a thread was
17112 stopped due to a signal. So if you want to continue execution
17113 suppressing the signal that stopped a thread, you should select that
17114 same thread before issuing the @samp{signal 0} command. If you issue
17115 the @samp{signal 0} command with another thread as the selected one,
17116 @value{GDBN} detects that and asks for confirmation.
17118 Invoking the @code{signal} command is not the same as invoking the
17119 @code{kill} utility from the shell. Sending a signal with @code{kill}
17120 causes @value{GDBN} to decide what to do with the signal depending on
17121 the signal handling tables (@pxref{Signals}). The @code{signal} command
17122 passes the signal directly to your program.
17124 @code{signal} does not repeat when you press @key{RET} a second time
17125 after executing the command.
17127 @kindex queue-signal
17128 @item queue-signal @var{signal}
17129 Queue @var{signal} to be delivered immediately to the current thread
17130 when execution of the thread resumes. The @var{signal} can be the name or
17131 the number of a signal. For example, on many systems @code{signal 2} and
17132 @code{signal SIGINT} are both ways of sending an interrupt signal.
17133 The handling of the signal must be set to pass the signal to the program,
17134 otherwise @value{GDBN} will report an error.
17135 You can control the handling of signals from @value{GDBN} with the
17136 @code{handle} command (@pxref{Signals}).
17138 Alternatively, if @var{signal} is zero, any currently queued signal
17139 for the current thread is discarded and when execution resumes no signal
17140 will be delivered. This is useful when your program stopped on account
17141 of a signal and would ordinarily see the signal when resumed with the
17142 @code{continue} command.
17144 This command differs from the @code{signal} command in that the signal
17145 is just queued, execution is not resumed. And @code{queue-signal} cannot
17146 be used to pass a signal whose handling state has been set to @code{nopass}
17151 @xref{stepping into signal handlers}, for information on how stepping
17152 commands behave when the thread has a signal queued.
17155 @section Returning from a Function
17158 @cindex returning from a function
17161 @itemx return @var{expression}
17162 You can cancel execution of a function call with the @code{return}
17163 command. If you give an
17164 @var{expression} argument, its value is used as the function's return
17168 When you use @code{return}, @value{GDBN} discards the selected stack frame
17169 (and all frames within it). You can think of this as making the
17170 discarded frame return prematurely. If you wish to specify a value to
17171 be returned, give that value as the argument to @code{return}.
17173 This pops the selected stack frame (@pxref{Selection, ,Selecting a
17174 Frame}), and any other frames inside of it, leaving its caller as the
17175 innermost remaining frame. That frame becomes selected. The
17176 specified value is stored in the registers used for returning values
17179 The @code{return} command does not resume execution; it leaves the
17180 program stopped in the state that would exist if the function had just
17181 returned. In contrast, the @code{finish} command (@pxref{Continuing
17182 and Stepping, ,Continuing and Stepping}) resumes execution until the
17183 selected stack frame returns naturally.
17185 @value{GDBN} needs to know how the @var{expression} argument should be set for
17186 the inferior. The concrete registers assignment depends on the OS ABI and the
17187 type being returned by the selected stack frame. For example it is common for
17188 OS ABI to return floating point values in FPU registers while integer values in
17189 CPU registers. Still some ABIs return even floating point values in CPU
17190 registers. Larger integer widths (such as @code{long long int}) also have
17191 specific placement rules. @value{GDBN} already knows the OS ABI from its
17192 current target so it needs to find out also the type being returned to make the
17193 assignment into the right register(s).
17195 Normally, the selected stack frame has debug info. @value{GDBN} will always
17196 use the debug info instead of the implicit type of @var{expression} when the
17197 debug info is available. For example, if you type @kbd{return -1}, and the
17198 function in the current stack frame is declared to return a @code{long long
17199 int}, @value{GDBN} transparently converts the implicit @code{int} value of -1
17200 into a @code{long long int}:
17203 Breakpoint 1, func () at gdb.base/return-nodebug.c:29
17205 (@value{GDBP}) return -1
17206 Make func return now? (y or n) y
17207 #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43
17208 43 printf ("result=%lld\n", func ());
17212 However, if the selected stack frame does not have a debug info, e.g., if the
17213 function was compiled without debug info, @value{GDBN} has to find out the type
17214 to return from user. Specifying a different type by mistake may set the value
17215 in different inferior registers than the caller code expects. For example,
17216 typing @kbd{return -1} with its implicit type @code{int} would set only a part
17217 of a @code{long long int} result for a debug info less function (on 32-bit
17218 architectures). Therefore the user is required to specify the return type by
17219 an appropriate cast explicitly:
17222 Breakpoint 2, 0x0040050b in func ()
17223 (@value{GDBP}) return -1
17224 Return value type not available for selected stack frame.
17225 Please use an explicit cast of the value to return.
17226 (@value{GDBP}) return (long long int) -1
17227 Make selected stack frame return now? (y or n) y
17228 #0 0x00400526 in main ()
17233 @section Calling Program Functions
17236 @cindex calling functions
17237 @cindex inferior functions, calling
17238 @item print @var{expr}
17239 Evaluate the expression @var{expr} and display the resulting value.
17240 The expression may include calls to functions in the program being
17244 @item call @var{expr}
17245 Evaluate the expression @var{expr} without displaying @code{void}
17248 You can use this variant of the @code{print} command if you want to
17249 execute a function from your program that does not return anything
17250 (a.k.a.@: @dfn{a void function}), but without cluttering the output
17251 with @code{void} returned values that @value{GDBN} will otherwise
17252 print. If the result is not void, it is printed and saved in the
17256 It is possible for the function you call via the @code{print} or
17257 @code{call} command to generate a signal (e.g., if there's a bug in
17258 the function, or if you passed it incorrect arguments). What happens
17259 in that case is controlled by the @code{set unwindonsignal} command.
17261 Similarly, with a C@t{++} program it is possible for the function you
17262 call via the @code{print} or @code{call} command to generate an
17263 exception that is not handled due to the constraints of the dummy
17264 frame. In this case, any exception that is raised in the frame, but has
17265 an out-of-frame exception handler will not be found. GDB builds a
17266 dummy-frame for the inferior function call, and the unwinder cannot
17267 seek for exception handlers outside of this dummy-frame. What happens
17268 in that case is controlled by the
17269 @code{set unwind-on-terminating-exception} command.
17272 @item set unwindonsignal
17273 @kindex set unwindonsignal
17274 @cindex unwind stack in called functions
17275 @cindex call dummy stack unwinding
17276 Set unwinding of the stack if a signal is received while in a function
17277 that @value{GDBN} called in the program being debugged. If set to on,
17278 @value{GDBN} unwinds the stack it created for the call and restores
17279 the context to what it was before the call. If set to off (the
17280 default), @value{GDBN} stops in the frame where the signal was
17283 @item show unwindonsignal
17284 @kindex show unwindonsignal
17285 Show the current setting of stack unwinding in the functions called by
17288 @item set unwind-on-terminating-exception
17289 @kindex set unwind-on-terminating-exception
17290 @cindex unwind stack in called functions with unhandled exceptions
17291 @cindex call dummy stack unwinding on unhandled exception.
17292 Set unwinding of the stack if a C@t{++} exception is raised, but left
17293 unhandled while in a function that @value{GDBN} called in the program being
17294 debugged. If set to on (the default), @value{GDBN} unwinds the stack
17295 it created for the call and restores the context to what it was before
17296 the call. If set to off, @value{GDBN} the exception is delivered to
17297 the default C@t{++} exception handler and the inferior terminated.
17299 @item show unwind-on-terminating-exception
17300 @kindex show unwind-on-terminating-exception
17301 Show the current setting of stack unwinding in the functions called by
17306 @cindex weak alias functions
17307 Sometimes, a function you wish to call is actually a @dfn{weak alias}
17308 for another function. In such case, @value{GDBN} might not pick up
17309 the type information, including the types of the function arguments,
17310 which causes @value{GDBN} to call the inferior function incorrectly.
17311 As a result, the called function will function erroneously and may
17312 even crash. A solution to that is to use the name of the aliased
17316 @section Patching Programs
17318 @cindex patching binaries
17319 @cindex writing into executables
17320 @cindex writing into corefiles
17322 By default, @value{GDBN} opens the file containing your program's
17323 executable code (or the corefile) read-only. This prevents accidental
17324 alterations to machine code; but it also prevents you from intentionally
17325 patching your program's binary.
17327 If you'd like to be able to patch the binary, you can specify that
17328 explicitly with the @code{set write} command. For example, you might
17329 want to turn on internal debugging flags, or even to make emergency
17335 @itemx set write off
17336 If you specify @samp{set write on}, @value{GDBN} opens executable and
17337 core files for both reading and writing; if you specify @kbd{set write
17338 off} (the default), @value{GDBN} opens them read-only.
17340 If you have already loaded a file, you must load it again (using the
17341 @code{exec-file} or @code{core-file} command) after changing @code{set
17342 write}, for your new setting to take effect.
17346 Display whether executable files and core files are opened for writing
17347 as well as reading.
17350 @node Compiling and Injecting Code
17351 @section Compiling and injecting code in @value{GDBN}
17352 @cindex injecting code
17353 @cindex writing into executables
17354 @cindex compiling code
17356 @value{GDBN} supports on-demand compilation and code injection into
17357 programs running under @value{GDBN}. GCC 5.0 or higher built with
17358 @file{libcc1.so} must be installed for this functionality to be enabled.
17359 This functionality is implemented with the following commands.
17362 @kindex compile code
17363 @item compile code @var{source-code}
17364 @itemx compile code -raw @var{--} @var{source-code}
17365 Compile @var{source-code} with the compiler language found as the current
17366 language in @value{GDBN} (@pxref{Languages}). If compilation and
17367 injection is not supported with the current language specified in
17368 @value{GDBN}, or the compiler does not support this feature, an error
17369 message will be printed. If @var{source-code} compiles and links
17370 successfully, @value{GDBN} will load the object-code emitted,
17371 and execute it within the context of the currently selected inferior.
17372 It is important to note that the compiled code is executed immediately.
17373 After execution, the compiled code is removed from @value{GDBN} and any
17374 new types or variables you have defined will be deleted.
17376 The command allows you to specify @var{source-code} in two ways.
17377 The simplest method is to provide a single line of code to the command.
17381 compile code printf ("hello world\n");
17384 If you specify options on the command line as well as source code, they
17385 may conflict. The @samp{--} delimiter can be used to separate options
17386 from actual source code. E.g.:
17389 compile code -r -- printf ("hello world\n");
17392 Alternatively you can enter source code as multiple lines of text. To
17393 enter this mode, invoke the @samp{compile code} command without any text
17394 following the command. This will start the multiple-line editor and
17395 allow you to type as many lines of source code as required. When you
17396 have completed typing, enter @samp{end} on its own line to exit the
17401 >printf ("hello\n");
17402 >printf ("world\n");
17406 Specifying @samp{-raw}, prohibits @value{GDBN} from wrapping the
17407 provided @var{source-code} in a callable scope. In this case, you must
17408 specify the entry point of the code by defining a function named
17409 @code{_gdb_expr_}. The @samp{-raw} code cannot access variables of the
17410 inferior. Using @samp{-raw} option may be needed for example when
17411 @var{source-code} requires @samp{#include} lines which may conflict with
17412 inferior symbols otherwise.
17414 @kindex compile file
17415 @item compile file @var{filename}
17416 @itemx compile file -raw @var{filename}
17417 Like @code{compile code}, but take the source code from @var{filename}.
17420 compile file /home/user/example.c
17425 @item compile print @var{expr}
17426 @itemx compile print /@var{f} @var{expr}
17427 Compile and execute @var{expr} with the compiler language found as the
17428 current language in @value{GDBN} (@pxref{Languages}). By default the
17429 value of @var{expr} is printed in a format appropriate to its data type;
17430 you can choose a different format by specifying @samp{/@var{f}}, where
17431 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
17434 @item compile print
17435 @itemx compile print /@var{f}
17436 @cindex reprint the last value
17437 Alternatively you can enter the expression (source code producing it) as
17438 multiple lines of text. To enter this mode, invoke the @samp{compile print}
17439 command without any text following the command. This will start the
17440 multiple-line editor.
17444 The process of compiling and injecting the code can be inspected using:
17447 @anchor{set debug compile}
17448 @item set debug compile
17449 @cindex compile command debugging info
17450 Turns on or off display of @value{GDBN} process of compiling and
17451 injecting the code. The default is off.
17453 @item show debug compile
17454 Displays the current state of displaying @value{GDBN} process of
17455 compiling and injecting the code.
17458 @subsection Compilation options for the @code{compile} command
17460 @value{GDBN} needs to specify the right compilation options for the code
17461 to be injected, in part to make its ABI compatible with the inferior
17462 and in part to make the injected code compatible with @value{GDBN}'s
17466 The options used, in increasing precedence:
17469 @item target architecture and OS options (@code{gdbarch})
17470 These options depend on target processor type and target operating
17471 system, usually they specify at least 32-bit (@code{-m32}) or 64-bit
17472 (@code{-m64}) compilation option.
17474 @item compilation options recorded in the target
17475 @value{NGCC} (since version 4.7) stores the options used for compilation
17476 into @code{DW_AT_producer} part of DWARF debugging information according
17477 to the @value{NGCC} option @code{-grecord-gcc-switches}. One has to
17478 explicitly specify @code{-g} during inferior compilation otherwise
17479 @value{NGCC} produces no DWARF. This feature is only relevant for
17480 platforms where @code{-g} produces DWARF by default, otherwise one may
17481 try to enforce DWARF by using @code{-gdwarf-4}.
17483 @item compilation options set by @code{set compile-args}
17487 You can override compilation options using the following command:
17490 @item set compile-args
17491 @cindex compile command options override
17492 Set compilation options used for compiling and injecting code with the
17493 @code{compile} commands. These options override any conflicting ones
17494 from the target architecture and/or options stored during inferior
17497 @item show compile-args
17498 Displays the current state of compilation options override.
17499 This does not show all the options actually used during compilation,
17500 use @ref{set debug compile} for that.
17503 @subsection Caveats when using the @code{compile} command
17505 There are a few caveats to keep in mind when using the @code{compile}
17506 command. As the caveats are different per language, the table below
17507 highlights specific issues on a per language basis.
17510 @item C code examples and caveats
17511 When the language in @value{GDBN} is set to @samp{C}, the compiler will
17512 attempt to compile the source code with a @samp{C} compiler. The source
17513 code provided to the @code{compile} command will have much the same
17514 access to variables and types as it normally would if it were part of
17515 the program currently being debugged in @value{GDBN}.
17517 Below is a sample program that forms the basis of the examples that
17518 follow. This program has been compiled and loaded into @value{GDBN},
17519 much like any other normal debugging session.
17522 void function1 (void)
17525 printf ("function 1\n");
17528 void function2 (void)
17543 For the purposes of the examples in this section, the program above has
17544 been compiled, loaded into @value{GDBN}, stopped at the function
17545 @code{main}, and @value{GDBN} is awaiting input from the user.
17547 To access variables and types for any program in @value{GDBN}, the
17548 program must be compiled and packaged with debug information. The
17549 @code{compile} command is not an exception to this rule. Without debug
17550 information, you can still use the @code{compile} command, but you will
17551 be very limited in what variables and types you can access.
17553 So with that in mind, the example above has been compiled with debug
17554 information enabled. The @code{compile} command will have access to
17555 all variables and types (except those that may have been optimized
17556 out). Currently, as @value{GDBN} has stopped the program in the
17557 @code{main} function, the @code{compile} command would have access to
17558 the variable @code{k}. You could invoke the @code{compile} command
17559 and type some source code to set the value of @code{k}. You can also
17560 read it, or do anything with that variable you would normally do in
17561 @code{C}. Be aware that changes to inferior variables in the
17562 @code{compile} command are persistent. In the following example:
17565 compile code k = 3;
17569 the variable @code{k} is now 3. It will retain that value until
17570 something else in the example program changes it, or another
17571 @code{compile} command changes it.
17573 Normal scope and access rules apply to source code compiled and
17574 injected by the @code{compile} command. In the example, the variables
17575 @code{j} and @code{k} are not accessible yet, because the program is
17576 currently stopped in the @code{main} function, where these variables
17577 are not in scope. Therefore, the following command
17580 compile code j = 3;
17584 will result in a compilation error message.
17586 Once the program is continued, execution will bring these variables in
17587 scope, and they will become accessible; then the code you specify via
17588 the @code{compile} command will be able to access them.
17590 You can create variables and types with the @code{compile} command as
17591 part of your source code. Variables and types that are created as part
17592 of the @code{compile} command are not visible to the rest of the program for
17593 the duration of its run. This example is valid:
17596 compile code int ff = 5; printf ("ff is %d\n", ff);
17599 However, if you were to type the following into @value{GDBN} after that
17600 command has completed:
17603 compile code printf ("ff is %d\n'', ff);
17607 a compiler error would be raised as the variable @code{ff} no longer
17608 exists. Object code generated and injected by the @code{compile}
17609 command is removed when its execution ends. Caution is advised
17610 when assigning to program variables values of variables created by the
17611 code submitted to the @code{compile} command. This example is valid:
17614 compile code int ff = 5; k = ff;
17617 The value of the variable @code{ff} is assigned to @code{k}. The variable
17618 @code{k} does not require the existence of @code{ff} to maintain the value
17619 it has been assigned. However, pointers require particular care in
17620 assignment. If the source code compiled with the @code{compile} command
17621 changed the address of a pointer in the example program, perhaps to a
17622 variable created in the @code{compile} command, that pointer would point
17623 to an invalid location when the command exits. The following example
17624 would likely cause issues with your debugged program:
17627 compile code int ff = 5; p = &ff;
17630 In this example, @code{p} would point to @code{ff} when the
17631 @code{compile} command is executing the source code provided to it.
17632 However, as variables in the (example) program persist with their
17633 assigned values, the variable @code{p} would point to an invalid
17634 location when the command exists. A general rule should be followed
17635 in that you should either assign @code{NULL} to any assigned pointers,
17636 or restore a valid location to the pointer before the command exits.
17638 Similar caution must be exercised with any structs, unions, and typedefs
17639 defined in @code{compile} command. Types defined in the @code{compile}
17640 command will no longer be available in the next @code{compile} command.
17641 Therefore, if you cast a variable to a type defined in the
17642 @code{compile} command, care must be taken to ensure that any future
17643 need to resolve the type can be achieved.
17646 (gdb) compile code static struct a @{ int a; @} v = @{ 42 @}; argv = &v;
17647 (gdb) compile code printf ("%d\n", ((struct a *) argv)->a);
17648 gdb command line:1:36: error: dereferencing pointer to incomplete type ‘struct a’
17649 Compilation failed.
17650 (gdb) compile code struct a @{ int a; @}; printf ("%d\n", ((struct a *) argv)->a);
17654 Variables that have been optimized away by the compiler are not
17655 accessible to the code submitted to the @code{compile} command.
17656 Access to those variables will generate a compiler error which @value{GDBN}
17657 will print to the console.
17660 @subsection Compiler search for the @code{compile} command
17662 @value{GDBN} needs to find @value{NGCC} for the inferior being debugged which
17663 may not be obvious for remote targets of different architecture than where
17664 @value{GDBN} is running. Environment variable @code{PATH} (@code{PATH} from
17665 shell that executed @value{GDBN}, not the one set by @value{GDBN}
17666 command @code{set environment}). @xref{Environment}. @code{PATH} on
17667 @value{GDBN} host is searched for @value{NGCC} binary matching the
17668 target architecture and operating system.
17670 Specifically @code{PATH} is searched for binaries matching regular expression
17671 @code{@var{arch}(-[^-]*)?-@var{os}-gcc} according to the inferior target being
17672 debugged. @var{arch} is processor name --- multiarch is supported, so for
17673 example both @code{i386} and @code{x86_64} targets look for pattern
17674 @code{(x86_64|i.86)} and both @code{s390} and @code{s390x} targets look
17675 for pattern @code{s390x?}. @var{os} is currently supported only for
17676 pattern @code{linux(-gnu)?}.
17679 @chapter @value{GDBN} Files
17681 @value{GDBN} needs to know the file name of the program to be debugged,
17682 both in order to read its symbol table and in order to start your
17683 program. To debug a core dump of a previous run, you must also tell
17684 @value{GDBN} the name of the core dump file.
17687 * Files:: Commands to specify files
17688 * File Caching:: Information about @value{GDBN}'s file caching
17689 * Separate Debug Files:: Debugging information in separate files
17690 * MiniDebugInfo:: Debugging information in a special section
17691 * Index Files:: Index files speed up GDB
17692 * Symbol Errors:: Errors reading symbol files
17693 * Data Files:: GDB data files
17697 @section Commands to Specify Files
17699 @cindex symbol table
17700 @cindex core dump file
17702 You may want to specify executable and core dump file names. The usual
17703 way to do this is at start-up time, using the arguments to
17704 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
17705 Out of @value{GDBN}}).
17707 Occasionally it is necessary to change to a different file during a
17708 @value{GDBN} session. Or you may run @value{GDBN} and forget to
17709 specify a file you want to use. Or you are debugging a remote target
17710 via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver}
17711 Program}). In these situations the @value{GDBN} commands to specify
17712 new files are useful.
17715 @cindex executable file
17717 @item file @var{filename}
17718 Use @var{filename} as the program to be debugged. It is read for its
17719 symbols and for the contents of pure memory. It is also the program
17720 executed when you use the @code{run} command. If you do not specify a
17721 directory and the file is not found in the @value{GDBN} working directory,
17722 @value{GDBN} uses the environment variable @code{PATH} as a list of
17723 directories to search, just as the shell does when looking for a program
17724 to run. You can change the value of this variable, for both @value{GDBN}
17725 and your program, using the @code{path} command.
17727 @cindex unlinked object files
17728 @cindex patching object files
17729 You can load unlinked object @file{.o} files into @value{GDBN} using
17730 the @code{file} command. You will not be able to ``run'' an object
17731 file, but you can disassemble functions and inspect variables. Also,
17732 if the underlying BFD functionality supports it, you could use
17733 @kbd{gdb -write} to patch object files using this technique. Note
17734 that @value{GDBN} can neither interpret nor modify relocations in this
17735 case, so branches and some initialized variables will appear to go to
17736 the wrong place. But this feature is still handy from time to time.
17739 @code{file} with no argument makes @value{GDBN} discard any information it
17740 has on both executable file and the symbol table.
17743 @item exec-file @r{[} @var{filename} @r{]}
17744 Specify that the program to be run (but not the symbol table) is found
17745 in @var{filename}. @value{GDBN} searches the environment variable @code{PATH}
17746 if necessary to locate your program. Omitting @var{filename} means to
17747 discard information on the executable file.
17749 @kindex symbol-file
17750 @item symbol-file @r{[} @var{filename} @r{]}
17751 Read symbol table information from file @var{filename}. @code{PATH} is
17752 searched when necessary. Use the @code{file} command to get both symbol
17753 table and program to run from the same file.
17755 @code{symbol-file} with no argument clears out @value{GDBN} information on your
17756 program's symbol table.
17758 The @code{symbol-file} command causes @value{GDBN} to forget the contents of
17759 some breakpoints and auto-display expressions. This is because they may
17760 contain pointers to the internal data recording symbols and data types,
17761 which are part of the old symbol table data being discarded inside
17764 @code{symbol-file} does not repeat if you press @key{RET} again after
17767 When @value{GDBN} is configured for a particular environment, it
17768 understands debugging information in whatever format is the standard
17769 generated for that environment; you may use either a @sc{gnu} compiler, or
17770 other compilers that adhere to the local conventions.
17771 Best results are usually obtained from @sc{gnu} compilers; for example,
17772 using @code{@value{NGCC}} you can generate debugging information for
17775 For most kinds of object files, with the exception of old SVR3 systems
17776 using COFF, the @code{symbol-file} command does not normally read the
17777 symbol table in full right away. Instead, it scans the symbol table
17778 quickly to find which source files and which symbols are present. The
17779 details are read later, one source file at a time, as they are needed.
17781 The purpose of this two-stage reading strategy is to make @value{GDBN}
17782 start up faster. For the most part, it is invisible except for
17783 occasional pauses while the symbol table details for a particular source
17784 file are being read. (The @code{set verbose} command can turn these
17785 pauses into messages if desired. @xref{Messages/Warnings, ,Optional
17786 Warnings and Messages}.)
17788 We have not implemented the two-stage strategy for COFF yet. When the
17789 symbol table is stored in COFF format, @code{symbol-file} reads the
17790 symbol table data in full right away. Note that ``stabs-in-COFF''
17791 still does the two-stage strategy, since the debug info is actually
17795 @cindex reading symbols immediately
17796 @cindex symbols, reading immediately
17797 @item symbol-file @r{[} -readnow @r{]} @var{filename}
17798 @itemx file @r{[} -readnow @r{]} @var{filename}
17799 You can override the @value{GDBN} two-stage strategy for reading symbol
17800 tables by using the @samp{-readnow} option with any of the commands that
17801 load symbol table information, if you want to be sure @value{GDBN} has the
17802 entire symbol table available.
17804 @c FIXME: for now no mention of directories, since this seems to be in
17805 @c flux. 13mar1992 status is that in theory GDB would look either in
17806 @c current dir or in same dir as myprog; but issues like competing
17807 @c GDB's, or clutter in system dirs, mean that in practice right now
17808 @c only current dir is used. FFish says maybe a special GDB hierarchy
17809 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
17813 @item core-file @r{[}@var{filename}@r{]}
17815 Specify the whereabouts of a core dump file to be used as the ``contents
17816 of memory''. Traditionally, core files contain only some parts of the
17817 address space of the process that generated them; @value{GDBN} can access the
17818 executable file itself for other parts.
17820 @code{core-file} with no argument specifies that no core file is
17823 Note that the core file is ignored when your program is actually running
17824 under @value{GDBN}. So, if you have been running your program and you
17825 wish to debug a core file instead, you must kill the subprocess in which
17826 the program is running. To do this, use the @code{kill} command
17827 (@pxref{Kill Process, ,Killing the Child Process}).
17829 @kindex add-symbol-file
17830 @cindex dynamic linking
17831 @item add-symbol-file @var{filename} @var{address}
17832 @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]}
17833 @itemx add-symbol-file @var{filename} @var{address} -s @var{section} @var{address} @dots{}
17834 The @code{add-symbol-file} command reads additional symbol table
17835 information from the file @var{filename}. You would use this command
17836 when @var{filename} has been dynamically loaded (by some other means)
17837 into the program that is running. The @var{address} should give the memory
17838 address at which the file has been loaded; @value{GDBN} cannot figure
17839 this out for itself. You can additionally specify an arbitrary number
17840 of @samp{-s @var{section} @var{address}} pairs, to give an explicit
17841 section name and base address for that section. You can specify any
17842 @var{address} as an expression.
17844 The symbol table of the file @var{filename} is added to the symbol table
17845 originally read with the @code{symbol-file} command. You can use the
17846 @code{add-symbol-file} command any number of times; the new symbol data
17847 thus read is kept in addition to the old.
17849 Changes can be reverted using the command @code{remove-symbol-file}.
17851 @cindex relocatable object files, reading symbols from
17852 @cindex object files, relocatable, reading symbols from
17853 @cindex reading symbols from relocatable object files
17854 @cindex symbols, reading from relocatable object files
17855 @cindex @file{.o} files, reading symbols from
17856 Although @var{filename} is typically a shared library file, an
17857 executable file, or some other object file which has been fully
17858 relocated for loading into a process, you can also load symbolic
17859 information from relocatable @file{.o} files, as long as:
17863 the file's symbolic information refers only to linker symbols defined in
17864 that file, not to symbols defined by other object files,
17866 every section the file's symbolic information refers to has actually
17867 been loaded into the inferior, as it appears in the file, and
17869 you can determine the address at which every section was loaded, and
17870 provide these to the @code{add-symbol-file} command.
17874 Some embedded operating systems, like Sun Chorus and VxWorks, can load
17875 relocatable files into an already running program; such systems
17876 typically make the requirements above easy to meet. However, it's
17877 important to recognize that many native systems use complex link
17878 procedures (@code{.linkonce} section factoring and C@t{++} constructor table
17879 assembly, for example) that make the requirements difficult to meet. In
17880 general, one cannot assume that using @code{add-symbol-file} to read a
17881 relocatable object file's symbolic information will have the same effect
17882 as linking the relocatable object file into the program in the normal
17885 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
17887 @kindex remove-symbol-file
17888 @item remove-symbol-file @var{filename}
17889 @item remove-symbol-file -a @var{address}
17890 Remove a symbol file added via the @code{add-symbol-file} command. The
17891 file to remove can be identified by its @var{filename} or by an @var{address}
17892 that lies within the boundaries of this symbol file in memory. Example:
17895 (gdb) add-symbol-file /home/user/gdb/mylib.so 0x7ffff7ff9480
17896 add symbol table from file "/home/user/gdb/mylib.so" at
17897 .text_addr = 0x7ffff7ff9480
17899 Reading symbols from /home/user/gdb/mylib.so...done.
17900 (gdb) remove-symbol-file -a 0x7ffff7ff9480
17901 Remove symbol table from file "/home/user/gdb/mylib.so"? (y or n) y
17906 @code{remove-symbol-file} does not repeat if you press @key{RET} after using it.
17908 @kindex add-symbol-file-from-memory
17909 @cindex @code{syscall DSO}
17910 @cindex load symbols from memory
17911 @item add-symbol-file-from-memory @var{address}
17912 Load symbols from the given @var{address} in a dynamically loaded
17913 object file whose image is mapped directly into the inferior's memory.
17914 For example, the Linux kernel maps a @code{syscall DSO} into each
17915 process's address space; this DSO provides kernel-specific code for
17916 some system calls. The argument can be any expression whose
17917 evaluation yields the address of the file's shared object file header.
17918 For this command to work, you must have used @code{symbol-file} or
17919 @code{exec-file} commands in advance.
17922 @item section @var{section} @var{addr}
17923 The @code{section} command changes the base address of the named
17924 @var{section} of the exec file to @var{addr}. This can be used if the
17925 exec file does not contain section addresses, (such as in the
17926 @code{a.out} format), or when the addresses specified in the file
17927 itself are wrong. Each section must be changed separately. The
17928 @code{info files} command, described below, lists all the sections and
17932 @kindex info target
17935 @code{info files} and @code{info target} are synonymous; both print the
17936 current target (@pxref{Targets, ,Specifying a Debugging Target}),
17937 including the names of the executable and core dump files currently in
17938 use by @value{GDBN}, and the files from which symbols were loaded. The
17939 command @code{help target} lists all possible targets rather than
17942 @kindex maint info sections
17943 @item maint info sections
17944 Another command that can give you extra information about program sections
17945 is @code{maint info sections}. In addition to the section information
17946 displayed by @code{info files}, this command displays the flags and file
17947 offset of each section in the executable and core dump files. In addition,
17948 @code{maint info sections} provides the following command options (which
17949 may be arbitrarily combined):
17953 Display sections for all loaded object files, including shared libraries.
17954 @item @var{sections}
17955 Display info only for named @var{sections}.
17956 @item @var{section-flags}
17957 Display info only for sections for which @var{section-flags} are true.
17958 The section flags that @value{GDBN} currently knows about are:
17961 Section will have space allocated in the process when loaded.
17962 Set for all sections except those containing debug information.
17964 Section will be loaded from the file into the child process memory.
17965 Set for pre-initialized code and data, clear for @code{.bss} sections.
17967 Section needs to be relocated before loading.
17969 Section cannot be modified by the child process.
17971 Section contains executable code only.
17973 Section contains data only (no executable code).
17975 Section will reside in ROM.
17977 Section contains data for constructor/destructor lists.
17979 Section is not empty.
17981 An instruction to the linker to not output the section.
17982 @item COFF_SHARED_LIBRARY
17983 A notification to the linker that the section contains
17984 COFF shared library information.
17986 Section contains common symbols.
17989 @kindex set trust-readonly-sections
17990 @cindex read-only sections
17991 @item set trust-readonly-sections on
17992 Tell @value{GDBN} that readonly sections in your object file
17993 really are read-only (i.e.@: that their contents will not change).
17994 In that case, @value{GDBN} can fetch values from these sections
17995 out of the object file, rather than from the target program.
17996 For some targets (notably embedded ones), this can be a significant
17997 enhancement to debugging performance.
17999 The default is off.
18001 @item set trust-readonly-sections off
18002 Tell @value{GDBN} not to trust readonly sections. This means that
18003 the contents of the section might change while the program is running,
18004 and must therefore be fetched from the target when needed.
18006 @item show trust-readonly-sections
18007 Show the current setting of trusting readonly sections.
18010 All file-specifying commands allow both absolute and relative file names
18011 as arguments. @value{GDBN} always converts the file name to an absolute file
18012 name and remembers it that way.
18014 @cindex shared libraries
18015 @anchor{Shared Libraries}
18016 @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, HP-UX, SunOS, SVr4, Irix,
18017 and IBM RS/6000 AIX shared libraries.
18019 On MS-Windows @value{GDBN} must be linked with the Expat library to support
18020 shared libraries. @xref{Expat}.
18022 @value{GDBN} automatically loads symbol definitions from shared libraries
18023 when you use the @code{run} command, or when you examine a core file.
18024 (Before you issue the @code{run} command, @value{GDBN} does not understand
18025 references to a function in a shared library, however---unless you are
18026 debugging a core file).
18028 On HP-UX, if the program loads a library explicitly, @value{GDBN}
18029 automatically loads the symbols at the time of the @code{shl_load} call.
18031 @c FIXME: some @value{GDBN} release may permit some refs to undef
18032 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
18033 @c FIXME...lib; check this from time to time when updating manual
18035 There are times, however, when you may wish to not automatically load
18036 symbol definitions from shared libraries, such as when they are
18037 particularly large or there are many of them.
18039 To control the automatic loading of shared library symbols, use the
18043 @kindex set auto-solib-add
18044 @item set auto-solib-add @var{mode}
18045 If @var{mode} is @code{on}, symbols from all shared object libraries
18046 will be loaded automatically when the inferior begins execution, you
18047 attach to an independently started inferior, or when the dynamic linker
18048 informs @value{GDBN} that a new library has been loaded. If @var{mode}
18049 is @code{off}, symbols must be loaded manually, using the
18050 @code{sharedlibrary} command. The default value is @code{on}.
18052 @cindex memory used for symbol tables
18053 If your program uses lots of shared libraries with debug info that
18054 takes large amounts of memory, you can decrease the @value{GDBN}
18055 memory footprint by preventing it from automatically loading the
18056 symbols from shared libraries. To that end, type @kbd{set
18057 auto-solib-add off} before running the inferior, then load each
18058 library whose debug symbols you do need with @kbd{sharedlibrary
18059 @var{regexp}}, where @var{regexp} is a regular expression that matches
18060 the libraries whose symbols you want to be loaded.
18062 @kindex show auto-solib-add
18063 @item show auto-solib-add
18064 Display the current autoloading mode.
18067 @cindex load shared library
18068 To explicitly load shared library symbols, use the @code{sharedlibrary}
18072 @kindex info sharedlibrary
18074 @item info share @var{regex}
18075 @itemx info sharedlibrary @var{regex}
18076 Print the names of the shared libraries which are currently loaded
18077 that match @var{regex}. If @var{regex} is omitted then print
18078 all shared libraries that are loaded.
18081 @item info dll @var{regex}
18082 This is an alias of @code{info sharedlibrary}.
18084 @kindex sharedlibrary
18086 @item sharedlibrary @var{regex}
18087 @itemx share @var{regex}
18088 Load shared object library symbols for files matching a
18089 Unix regular expression.
18090 As with files loaded automatically, it only loads shared libraries
18091 required by your program for a core file or after typing @code{run}. If
18092 @var{regex} is omitted all shared libraries required by your program are
18095 @item nosharedlibrary
18096 @kindex nosharedlibrary
18097 @cindex unload symbols from shared libraries
18098 Unload all shared object library symbols. This discards all symbols
18099 that have been loaded from all shared libraries. Symbols from shared
18100 libraries that were loaded by explicit user requests are not
18104 Sometimes you may wish that @value{GDBN} stops and gives you control
18105 when any of shared library events happen. The best way to do this is
18106 to use @code{catch load} and @code{catch unload} (@pxref{Set
18109 @value{GDBN} also supports the the @code{set stop-on-solib-events}
18110 command for this. This command exists for historical reasons. It is
18111 less useful than setting a catchpoint, because it does not allow for
18112 conditions or commands as a catchpoint does.
18115 @item set stop-on-solib-events
18116 @kindex set stop-on-solib-events
18117 This command controls whether @value{GDBN} should give you control
18118 when the dynamic linker notifies it about some shared library event.
18119 The most common event of interest is loading or unloading of a new
18122 @item show stop-on-solib-events
18123 @kindex show stop-on-solib-events
18124 Show whether @value{GDBN} stops and gives you control when shared
18125 library events happen.
18128 Shared libraries are also supported in many cross or remote debugging
18129 configurations. @value{GDBN} needs to have access to the target's libraries;
18130 this can be accomplished either by providing copies of the libraries
18131 on the host system, or by asking @value{GDBN} to automatically retrieve the
18132 libraries from the target. If copies of the target libraries are
18133 provided, they need to be the same as the target libraries, although the
18134 copies on the target can be stripped as long as the copies on the host are
18137 @cindex where to look for shared libraries
18138 For remote debugging, you need to tell @value{GDBN} where the target
18139 libraries are, so that it can load the correct copies---otherwise, it
18140 may try to load the host's libraries. @value{GDBN} has two variables
18141 to specify the search directories for target libraries.
18144 @cindex prefix for executable and shared library file names
18145 @cindex system root, alternate
18146 @kindex set solib-absolute-prefix
18147 @kindex set sysroot
18148 @item set sysroot @var{path}
18149 Use @var{path} as the system root for the program being debugged. Any
18150 absolute shared library paths will be prefixed with @var{path}; many
18151 runtime loaders store the absolute paths to the shared library in the
18152 target program's memory. When starting processes remotely, and when
18153 attaching to already-running processes (local or remote), their
18154 executable filenames will be prefixed with @var{path} if reported to
18155 @value{GDBN} as absolute by the operating system. If you use
18156 @code{set sysroot} to find executables and shared libraries, they need
18157 to be laid out in the same way that they are on the target, with
18158 e.g.@: a @file{/bin}, @file{/lib} and @file{/usr/lib} hierarchy under
18161 If @var{path} starts with the sequence @file{target:} and the target
18162 system is remote then @value{GDBN} will retrieve the target binaries
18163 from the remote system. This is only supported when using a remote
18164 target that supports the @code{remote get} command (@pxref{File
18165 Transfer,,Sending files to a remote system}). The part of @var{path}
18166 following the initial @file{target:} (if present) is used as system
18167 root prefix on the remote file system. If @var{path} starts with the
18168 sequence @file{remote:} this is converted to the sequence
18169 @file{target:} by @code{set sysroot}@footnote{Historically the
18170 functionality to retrieve binaries from the remote system was
18171 provided by prefixing @var{path} with @file{remote:}}. If you want
18172 to specify a local system root using a directory that happens to be
18173 named @file{target:} or @file{remote:}, you need to use some
18174 equivalent variant of the name like @file{./target:}.
18176 For targets with an MS-DOS based filesystem, such as MS-Windows and
18177 SymbianOS, @value{GDBN} tries prefixing a few variants of the target
18178 absolute file name with @var{path}. But first, on Unix hosts,
18179 @value{GDBN} converts all backslash directory separators into forward
18180 slashes, because the backslash is not a directory separator on Unix:
18183 c:\foo\bar.dll @result{} c:/foo/bar.dll
18186 Then, @value{GDBN} attempts prefixing the target file name with
18187 @var{path}, and looks for the resulting file name in the host file
18191 c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll
18194 If that does not find the binary, @value{GDBN} tries removing
18195 the @samp{:} character from the drive spec, both for convenience, and,
18196 for the case of the host file system not supporting file names with
18200 c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll
18203 This makes it possible to have a system root that mirrors a target
18204 with more than one drive. E.g., you may want to setup your local
18205 copies of the target system shared libraries like so (note @samp{c} vs
18209 @file{/path/to/sysroot/c/sys/bin/foo.dll}
18210 @file{/path/to/sysroot/c/sys/bin/bar.dll}
18211 @file{/path/to/sysroot/z/sys/bin/bar.dll}
18215 and point the system root at @file{/path/to/sysroot}, so that
18216 @value{GDBN} can find the correct copies of both
18217 @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}.
18219 If that still does not find the binary, @value{GDBN} tries
18220 removing the whole drive spec from the target file name:
18223 c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll
18226 This last lookup makes it possible to not care about the drive name,
18227 if you don't want or need to.
18229 The @code{set solib-absolute-prefix} command is an alias for @code{set
18232 @cindex default system root
18233 @cindex @samp{--with-sysroot}
18234 You can set the default system root by using the configure-time
18235 @samp{--with-sysroot} option. If the system root is inside
18236 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
18237 @samp{--exec-prefix}), then the default system root will be updated
18238 automatically if the installed @value{GDBN} is moved to a new
18241 @kindex show sysroot
18243 Display the current executable and shared library prefix.
18245 @kindex set solib-search-path
18246 @item set solib-search-path @var{path}
18247 If this variable is set, @var{path} is a colon-separated list of
18248 directories to search for shared libraries. @samp{solib-search-path}
18249 is used after @samp{sysroot} fails to locate the library, or if the
18250 path to the library is relative instead of absolute. If you want to
18251 use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set
18252 @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from
18253 finding your host's libraries. @samp{sysroot} is preferred; setting
18254 it to a nonexistent directory may interfere with automatic loading
18255 of shared library symbols.
18257 @kindex show solib-search-path
18258 @item show solib-search-path
18259 Display the current shared library search path.
18261 @cindex DOS file-name semantics of file names.
18262 @kindex set target-file-system-kind (unix|dos-based|auto)
18263 @kindex show target-file-system-kind
18264 @item set target-file-system-kind @var{kind}
18265 Set assumed file system kind for target reported file names.
18267 Shared library file names as reported by the target system may not
18268 make sense as is on the system @value{GDBN} is running on. For
18269 example, when remote debugging a target that has MS-DOS based file
18270 system semantics, from a Unix host, the target may be reporting to
18271 @value{GDBN} a list of loaded shared libraries with file names such as
18272 @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of
18273 drive letters, so the @samp{c:\} prefix is not normally understood as
18274 indicating an absolute file name, and neither is the backslash
18275 normally considered a directory separator character. In that case,
18276 the native file system would interpret this whole absolute file name
18277 as a relative file name with no directory components. This would make
18278 it impossible to point @value{GDBN} at a copy of the remote target's
18279 shared libraries on the host using @code{set sysroot}, and impractical
18280 with @code{set solib-search-path}. Setting
18281 @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN}
18282 to interpret such file names similarly to how the target would, and to
18283 map them to file names valid on @value{GDBN}'s native file system
18284 semantics. The value of @var{kind} can be @code{"auto"}, in addition
18285 to one of the supported file system kinds. In that case, @value{GDBN}
18286 tries to determine the appropriate file system variant based on the
18287 current target's operating system (@pxref{ABI, ,Configuring the
18288 Current ABI}). The supported file system settings are:
18292 Instruct @value{GDBN} to assume the target file system is of Unix
18293 kind. Only file names starting the forward slash (@samp{/}) character
18294 are considered absolute, and the directory separator character is also
18298 Instruct @value{GDBN} to assume the target file system is DOS based.
18299 File names starting with either a forward slash, or a drive letter
18300 followed by a colon (e.g., @samp{c:}), are considered absolute, and
18301 both the slash (@samp{/}) and the backslash (@samp{\\}) characters are
18302 considered directory separators.
18305 Instruct @value{GDBN} to use the file system kind associated with the
18306 target operating system (@pxref{ABI, ,Configuring the Current ABI}).
18307 This is the default.
18311 @cindex file name canonicalization
18312 @cindex base name differences
18313 When processing file names provided by the user, @value{GDBN}
18314 frequently needs to compare them to the file names recorded in the
18315 program's debug info. Normally, @value{GDBN} compares just the
18316 @dfn{base names} of the files as strings, which is reasonably fast
18317 even for very large programs. (The base name of a file is the last
18318 portion of its name, after stripping all the leading directories.)
18319 This shortcut in comparison is based upon the assumption that files
18320 cannot have more than one base name. This is usually true, but
18321 references to files that use symlinks or similar filesystem
18322 facilities violate that assumption. If your program records files
18323 using such facilities, or if you provide file names to @value{GDBN}
18324 using symlinks etc., you can set @code{basenames-may-differ} to
18325 @code{true} to instruct @value{GDBN} to completely canonicalize each
18326 pair of file names it needs to compare. This will make file-name
18327 comparisons accurate, but at a price of a significant slowdown.
18330 @item set basenames-may-differ
18331 @kindex set basenames-may-differ
18332 Set whether a source file may have multiple base names.
18334 @item show basenames-may-differ
18335 @kindex show basenames-may-differ
18336 Show whether a source file may have multiple base names.
18340 @section File Caching
18341 @cindex caching of opened files
18342 @cindex caching of bfd objects
18344 To speed up file loading, and reduce memory usage, @value{GDBN} will
18345 reuse the @code{bfd} objects used to track open files. @xref{Top, ,
18346 BFD, bfd, The Binary File Descriptor Library}. The following commands
18347 allow visibility and control of the caching behavior.
18350 @kindex maint info bfds
18351 @item maint info bfds
18352 This prints information about each @code{bfd} object that is known to
18355 @kindex maint set bfd-sharing
18356 @kindex maint show bfd-sharing
18357 @kindex bfd caching
18358 @item maint set bfd-sharing
18359 @item maint show bfd-sharing
18360 Control whether @code{bfd} objects can be shared. When sharing is
18361 enabled @value{GDBN} reuses already open @code{bfd} objects rather
18362 than reopening the same file. Turning sharing off does not cause
18363 already shared @code{bfd} objects to be unshared, but all future files
18364 that are opened will create a new @code{bfd} object. Similarly,
18365 re-enabling sharing does not cause multiple existing @code{bfd}
18366 objects to be collapsed into a single shared @code{bfd} object.
18368 @kindex set debug bfd-cache @var{level}
18369 @kindex bfd caching
18370 @item set debug bfd-cache @var{level}
18371 Turns on debugging of the bfd cache, setting the level to @var{level}.
18373 @kindex show debug bfd-cache
18374 @kindex bfd caching
18375 @item show debug bfd-cache
18376 Show the current debugging level of the bfd cache.
18379 @node Separate Debug Files
18380 @section Debugging Information in Separate Files
18381 @cindex separate debugging information files
18382 @cindex debugging information in separate files
18383 @cindex @file{.debug} subdirectories
18384 @cindex debugging information directory, global
18385 @cindex global debugging information directories
18386 @cindex build ID, and separate debugging files
18387 @cindex @file{.build-id} directory
18389 @value{GDBN} allows you to put a program's debugging information in a
18390 file separate from the executable itself, in a way that allows
18391 @value{GDBN} to find and load the debugging information automatically.
18392 Since debugging information can be very large---sometimes larger
18393 than the executable code itself---some systems distribute debugging
18394 information for their executables in separate files, which users can
18395 install only when they need to debug a problem.
18397 @value{GDBN} supports two ways of specifying the separate debug info
18402 The executable contains a @dfn{debug link} that specifies the name of
18403 the separate debug info file. The separate debug file's name is
18404 usually @file{@var{executable}.debug}, where @var{executable} is the
18405 name of the corresponding executable file without leading directories
18406 (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the
18407 debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC)
18408 checksum for the debug file, which @value{GDBN} uses to validate that
18409 the executable and the debug file came from the same build.
18412 The executable contains a @dfn{build ID}, a unique bit string that is
18413 also present in the corresponding debug info file. (This is supported
18414 only on some operating systems, when using the ELF or PE file formats
18415 for binary files and the @sc{gnu} Binutils.) For more details about
18416 this feature, see the description of the @option{--build-id}
18417 command-line option in @ref{Options, , Command Line Options, ld.info,
18418 The GNU Linker}. The debug info file's name is not specified
18419 explicitly by the build ID, but can be computed from the build ID, see
18423 Depending on the way the debug info file is specified, @value{GDBN}
18424 uses two different methods of looking for the debug file:
18428 For the ``debug link'' method, @value{GDBN} looks up the named file in
18429 the directory of the executable file, then in a subdirectory of that
18430 directory named @file{.debug}, and finally under each one of the global debug
18431 directories, in a subdirectory whose name is identical to the leading
18432 directories of the executable's absolute file name.
18435 For the ``build ID'' method, @value{GDBN} looks in the
18436 @file{.build-id} subdirectory of each one of the global debug directories for
18437 a file named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
18438 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
18439 are the rest of the bit string. (Real build ID strings are 32 or more
18440 hex characters, not 10.)
18443 So, for example, suppose you ask @value{GDBN} to debug
18444 @file{/usr/bin/ls}, which has a debug link that specifies the
18445 file @file{ls.debug}, and a build ID whose value in hex is
18446 @code{abcdef1234}. If the list of the global debug directories includes
18447 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
18448 debug information files, in the indicated order:
18452 @file{/usr/lib/debug/.build-id/ab/cdef1234.debug}
18454 @file{/usr/bin/ls.debug}
18456 @file{/usr/bin/.debug/ls.debug}
18458 @file{/usr/lib/debug/usr/bin/ls.debug}.
18461 @anchor{debug-file-directory}
18462 Global debugging info directories default to what is set by @value{GDBN}
18463 configure option @option{--with-separate-debug-dir}. During @value{GDBN} run
18464 you can also set the global debugging info directories, and view the list
18465 @value{GDBN} is currently using.
18469 @kindex set debug-file-directory
18470 @item set debug-file-directory @var{directories}
18471 Set the directories which @value{GDBN} searches for separate debugging
18472 information files to @var{directory}. Multiple path components can be set
18473 concatenating them by a path separator.
18475 @kindex show debug-file-directory
18476 @item show debug-file-directory
18477 Show the directories @value{GDBN} searches for separate debugging
18482 @cindex @code{.gnu_debuglink} sections
18483 @cindex debug link sections
18484 A debug link is a special section of the executable file named
18485 @code{.gnu_debuglink}. The section must contain:
18489 A filename, with any leading directory components removed, followed by
18492 zero to three bytes of padding, as needed to reach the next four-byte
18493 boundary within the section, and
18495 a four-byte CRC checksum, stored in the same endianness used for the
18496 executable file itself. The checksum is computed on the debugging
18497 information file's full contents by the function given below, passing
18498 zero as the @var{crc} argument.
18501 Any executable file format can carry a debug link, as long as it can
18502 contain a section named @code{.gnu_debuglink} with the contents
18505 @cindex @code{.note.gnu.build-id} sections
18506 @cindex build ID sections
18507 The build ID is a special section in the executable file (and in other
18508 ELF binary files that @value{GDBN} may consider). This section is
18509 often named @code{.note.gnu.build-id}, but that name is not mandatory.
18510 It contains unique identification for the built files---the ID remains
18511 the same across multiple builds of the same build tree. The default
18512 algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the
18513 content for the build ID string. The same section with an identical
18514 value is present in the original built binary with symbols, in its
18515 stripped variant, and in the separate debugging information file.
18517 The debugging information file itself should be an ordinary
18518 executable, containing a full set of linker symbols, sections, and
18519 debugging information. The sections of the debugging information file
18520 should have the same names, addresses, and sizes as the original file,
18521 but they need not contain any data---much like a @code{.bss} section
18522 in an ordinary executable.
18524 The @sc{gnu} binary utilities (Binutils) package includes the
18525 @samp{objcopy} utility that can produce
18526 the separated executable / debugging information file pairs using the
18527 following commands:
18530 @kbd{objcopy --only-keep-debug foo foo.debug}
18535 These commands remove the debugging
18536 information from the executable file @file{foo} and place it in the file
18537 @file{foo.debug}. You can use the first, second or both methods to link the
18542 The debug link method needs the following additional command to also leave
18543 behind a debug link in @file{foo}:
18546 @kbd{objcopy --add-gnu-debuglink=foo.debug foo}
18549 Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains
18550 a version of the @code{strip} command such that the command @kbd{strip foo -f
18551 foo.debug} has the same functionality as the two @code{objcopy} commands and
18552 the @code{ln -s} command above, together.
18555 Build ID gets embedded into the main executable using @code{ld --build-id} or
18556 the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus
18557 compatibility fixes for debug files separation are present in @sc{gnu} binary
18558 utilities (Binutils) package since version 2.18.
18563 @cindex CRC algorithm definition
18564 The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in
18565 IEEE 802.3 using the polynomial:
18567 @c TexInfo requires naked braces for multi-digit exponents for Tex
18568 @c output, but this causes HTML output to barf. HTML has to be set using
18569 @c raw commands. So we end up having to specify this equation in 2
18574 <em>x</em><sup>32</sup> + <em>x</em><sup>26</sup> + <em>x</em><sup>23</sup> + <em>x</em><sup>22</sup> + <em>x</em><sup>16</sup> + <em>x</em><sup>12</sup> + <em>x</em><sup>11</sup>
18575 + <em>x</em><sup>10</sup> + <em>x</em><sup>8</sup> + <em>x</em><sup>7</sup> + <em>x</em><sup>5</sup> + <em>x</em><sup>4</sup> + <em>x</em><sup>2</sup> + <em>x</em> + 1
18581 @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}}
18582 @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1}
18586 The function is computed byte at a time, taking the least
18587 significant bit of each byte first. The initial pattern
18588 @code{0xffffffff} is used, to ensure leading zeros affect the CRC and
18589 the final result is inverted to ensure trailing zeros also affect the
18592 @emph{Note:} This is the same CRC polynomial as used in handling the
18593 @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{qCRC packet}).
18594 However in the case of the Remote Serial Protocol, the CRC is computed
18595 @emph{most} significant bit first, and the result is not inverted, so
18596 trailing zeros have no effect on the CRC value.
18598 To complete the description, we show below the code of the function
18599 which produces the CRC used in @code{.gnu_debuglink}. Inverting the
18600 initially supplied @code{crc} argument means that an initial call to
18601 this function passing in zero will start computing the CRC using
18604 @kindex gnu_debuglink_crc32
18607 gnu_debuglink_crc32 (unsigned long crc,
18608 unsigned char *buf, size_t len)
18610 static const unsigned long crc32_table[256] =
18612 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
18613 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
18614 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
18615 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
18616 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
18617 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
18618 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
18619 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
18620 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
18621 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
18622 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
18623 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
18624 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
18625 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
18626 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
18627 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
18628 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
18629 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
18630 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
18631 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
18632 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
18633 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
18634 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
18635 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
18636 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
18637 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
18638 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
18639 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
18640 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
18641 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
18642 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
18643 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
18644 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
18645 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
18646 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
18647 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
18648 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
18649 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
18650 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
18651 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
18652 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
18653 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
18654 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
18655 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
18656 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
18657 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
18658 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
18659 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
18660 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
18661 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
18662 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
18665 unsigned char *end;
18667 crc = ~crc & 0xffffffff;
18668 for (end = buf + len; buf < end; ++buf)
18669 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
18670 return ~crc & 0xffffffff;
18675 This computation does not apply to the ``build ID'' method.
18677 @node MiniDebugInfo
18678 @section Debugging information in a special section
18679 @cindex separate debug sections
18680 @cindex @samp{.gnu_debugdata} section
18682 Some systems ship pre-built executables and libraries that have a
18683 special @samp{.gnu_debugdata} section. This feature is called
18684 @dfn{MiniDebugInfo}. This section holds an LZMA-compressed object and
18685 is used to supply extra symbols for backtraces.
18687 The intent of this section is to provide extra minimal debugging
18688 information for use in simple backtraces. It is not intended to be a
18689 replacement for full separate debugging information (@pxref{Separate
18690 Debug Files}). The example below shows the intended use; however,
18691 @value{GDBN} does not currently put restrictions on what sort of
18692 debugging information might be included in the section.
18694 @value{GDBN} has support for this extension. If the section exists,
18695 then it is used provided that no other source of debugging information
18696 can be found, and that @value{GDBN} was configured with LZMA support.
18698 This section can be easily created using @command{objcopy} and other
18699 standard utilities:
18702 # Extract the dynamic symbols from the main binary, there is no need
18703 # to also have these in the normal symbol table.
18704 nm -D @var{binary} --format=posix --defined-only \
18705 | awk '@{ print $1 @}' | sort > dynsyms
18707 # Extract all the text (i.e. function) symbols from the debuginfo.
18708 # (Note that we actually also accept "D" symbols, for the benefit
18709 # of platforms like PowerPC64 that use function descriptors.)
18710 nm @var{binary} --format=posix --defined-only \
18711 | awk '@{ if ($2 == "T" || $2 == "t" || $2 == "D") print $1 @}' \
18714 # Keep all the function symbols not already in the dynamic symbol
18716 comm -13 dynsyms funcsyms > keep_symbols
18718 # Separate full debug info into debug binary.
18719 objcopy --only-keep-debug @var{binary} debug
18721 # Copy the full debuginfo, keeping only a minimal set of symbols and
18722 # removing some unnecessary sections.
18723 objcopy -S --remove-section .gdb_index --remove-section .comment \
18724 --keep-symbols=keep_symbols debug mini_debuginfo
18726 # Drop the full debug info from the original binary.
18727 strip --strip-all -R .comment @var{binary}
18729 # Inject the compressed data into the .gnu_debugdata section of the
18732 objcopy --add-section .gnu_debugdata=mini_debuginfo.xz @var{binary}
18736 @section Index Files Speed Up @value{GDBN}
18737 @cindex index files
18738 @cindex @samp{.gdb_index} section
18740 When @value{GDBN} finds a symbol file, it scans the symbols in the
18741 file in order to construct an internal symbol table. This lets most
18742 @value{GDBN} operations work quickly---at the cost of a delay early
18743 on. For large programs, this delay can be quite lengthy, so
18744 @value{GDBN} provides a way to build an index, which speeds up
18747 The index is stored as a section in the symbol file. @value{GDBN} can
18748 write the index to a file, then you can put it into the symbol file
18749 using @command{objcopy}.
18751 To create an index file, use the @code{save gdb-index} command:
18754 @item save gdb-index @var{directory}
18755 @kindex save gdb-index
18756 Create an index file for each symbol file currently known by
18757 @value{GDBN}. Each file is named after its corresponding symbol file,
18758 with @samp{.gdb-index} appended, and is written into the given
18762 Once you have created an index file you can merge it into your symbol
18763 file, here named @file{symfile}, using @command{objcopy}:
18766 $ objcopy --add-section .gdb_index=symfile.gdb-index \
18767 --set-section-flags .gdb_index=readonly symfile symfile
18770 @value{GDBN} will normally ignore older versions of @file{.gdb_index}
18771 sections that have been deprecated. Usually they are deprecated because
18772 they are missing a new feature or have performance issues.
18773 To tell @value{GDBN} to use a deprecated index section anyway
18774 specify @code{set use-deprecated-index-sections on}.
18775 The default is @code{off}.
18776 This can speed up startup, but may result in some functionality being lost.
18777 @xref{Index Section Format}.
18779 @emph{Warning:} Setting @code{use-deprecated-index-sections} to @code{on}
18780 must be done before gdb reads the file. The following will not work:
18783 $ gdb -ex "set use-deprecated-index-sections on" <program>
18786 Instead you must do, for example,
18789 $ gdb -iex "set use-deprecated-index-sections on" <program>
18792 There are currently some limitation on indices. They only work when
18793 for DWARF debugging information, not stabs. And, they do not
18794 currently work for programs using Ada.
18796 @node Symbol Errors
18797 @section Errors Reading Symbol Files
18799 While reading a symbol file, @value{GDBN} occasionally encounters problems,
18800 such as symbol types it does not recognize, or known bugs in compiler
18801 output. By default, @value{GDBN} does not notify you of such problems, since
18802 they are relatively common and primarily of interest to people
18803 debugging compilers. If you are interested in seeing information
18804 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
18805 only one message about each such type of problem, no matter how many
18806 times the problem occurs; or you can ask @value{GDBN} to print more messages,
18807 to see how many times the problems occur, with the @code{set
18808 complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
18811 The messages currently printed, and their meanings, include:
18814 @item inner block not inside outer block in @var{symbol}
18816 The symbol information shows where symbol scopes begin and end
18817 (such as at the start of a function or a block of statements). This
18818 error indicates that an inner scope block is not fully contained
18819 in its outer scope blocks.
18821 @value{GDBN} circumvents the problem by treating the inner block as if it had
18822 the same scope as the outer block. In the error message, @var{symbol}
18823 may be shown as ``@code{(don't know)}'' if the outer block is not a
18826 @item block at @var{address} out of order
18828 The symbol information for symbol scope blocks should occur in
18829 order of increasing addresses. This error indicates that it does not
18832 @value{GDBN} does not circumvent this problem, and has trouble
18833 locating symbols in the source file whose symbols it is reading. (You
18834 can often determine what source file is affected by specifying
18835 @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and
18838 @item bad block start address patched
18840 The symbol information for a symbol scope block has a start address
18841 smaller than the address of the preceding source line. This is known
18842 to occur in the SunOS 4.1.1 (and earlier) C compiler.
18844 @value{GDBN} circumvents the problem by treating the symbol scope block as
18845 starting on the previous source line.
18847 @item bad string table offset in symbol @var{n}
18850 Symbol number @var{n} contains a pointer into the string table which is
18851 larger than the size of the string table.
18853 @value{GDBN} circumvents the problem by considering the symbol to have the
18854 name @code{foo}, which may cause other problems if many symbols end up
18857 @item unknown symbol type @code{0x@var{nn}}
18859 The symbol information contains new data types that @value{GDBN} does
18860 not yet know how to read. @code{0x@var{nn}} is the symbol type of the
18861 uncomprehended information, in hexadecimal.
18863 @value{GDBN} circumvents the error by ignoring this symbol information.
18864 This usually allows you to debug your program, though certain symbols
18865 are not accessible. If you encounter such a problem and feel like
18866 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
18867 on @code{complain}, then go up to the function @code{read_dbx_symtab}
18868 and examine @code{*bufp} to see the symbol.
18870 @item stub type has NULL name
18872 @value{GDBN} could not find the full definition for a struct or class.
18874 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
18875 The symbol information for a C@t{++} member function is missing some
18876 information that recent versions of the compiler should have output for
18879 @item info mismatch between compiler and debugger
18881 @value{GDBN} could not parse a type specification output by the compiler.
18886 @section GDB Data Files
18888 @cindex prefix for data files
18889 @value{GDBN} will sometimes read an auxiliary data file. These files
18890 are kept in a directory known as the @dfn{data directory}.
18892 You can set the data directory's name, and view the name @value{GDBN}
18893 is currently using.
18896 @kindex set data-directory
18897 @item set data-directory @var{directory}
18898 Set the directory which @value{GDBN} searches for auxiliary data files
18899 to @var{directory}.
18901 @kindex show data-directory
18902 @item show data-directory
18903 Show the directory @value{GDBN} searches for auxiliary data files.
18906 @cindex default data directory
18907 @cindex @samp{--with-gdb-datadir}
18908 You can set the default data directory by using the configure-time
18909 @samp{--with-gdb-datadir} option. If the data directory is inside
18910 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
18911 @samp{--exec-prefix}), then the default data directory will be updated
18912 automatically if the installed @value{GDBN} is moved to a new
18915 The data directory may also be specified with the
18916 @code{--data-directory} command line option.
18917 @xref{Mode Options}.
18920 @chapter Specifying a Debugging Target
18922 @cindex debugging target
18923 A @dfn{target} is the execution environment occupied by your program.
18925 Often, @value{GDBN} runs in the same host environment as your program;
18926 in that case, the debugging target is specified as a side effect when
18927 you use the @code{file} or @code{core} commands. When you need more
18928 flexibility---for example, running @value{GDBN} on a physically separate
18929 host, or controlling a standalone system over a serial port or a
18930 realtime system over a TCP/IP connection---you can use the @code{target}
18931 command to specify one of the target types configured for @value{GDBN}
18932 (@pxref{Target Commands, ,Commands for Managing Targets}).
18934 @cindex target architecture
18935 It is possible to build @value{GDBN} for several different @dfn{target
18936 architectures}. When @value{GDBN} is built like that, you can choose
18937 one of the available architectures with the @kbd{set architecture}
18941 @kindex set architecture
18942 @kindex show architecture
18943 @item set architecture @var{arch}
18944 This command sets the current target architecture to @var{arch}. The
18945 value of @var{arch} can be @code{"auto"}, in addition to one of the
18946 supported architectures.
18948 @item show architecture
18949 Show the current target architecture.
18951 @item set processor
18953 @kindex set processor
18954 @kindex show processor
18955 These are alias commands for, respectively, @code{set architecture}
18956 and @code{show architecture}.
18960 * Active Targets:: Active targets
18961 * Target Commands:: Commands for managing targets
18962 * Byte Order:: Choosing target byte order
18965 @node Active Targets
18966 @section Active Targets
18968 @cindex stacking targets
18969 @cindex active targets
18970 @cindex multiple targets
18972 There are multiple classes of targets such as: processes, executable files or
18973 recording sessions. Core files belong to the process class, making core file
18974 and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently
18975 on multiple active targets, one in each class. This allows you to (for
18976 example) start a process and inspect its activity, while still having access to
18977 the executable file after the process finishes. Or if you start process
18978 recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are
18979 presented a virtual layer of the recording target, while the process target
18980 remains stopped at the chronologically last point of the process execution.
18982 Use the @code{core-file} and @code{exec-file} commands to select a new core
18983 file or executable target (@pxref{Files, ,Commands to Specify Files}). To
18984 specify as a target a process that is already running, use the @code{attach}
18985 command (@pxref{Attach, ,Debugging an Already-running Process}).
18987 @node Target Commands
18988 @section Commands for Managing Targets
18991 @item target @var{type} @var{parameters}
18992 Connects the @value{GDBN} host environment to a target machine or
18993 process. A target is typically a protocol for talking to debugging
18994 facilities. You use the argument @var{type} to specify the type or
18995 protocol of the target machine.
18997 Further @var{parameters} are interpreted by the target protocol, but
18998 typically include things like device names or host names to connect
18999 with, process numbers, and baud rates.
19001 The @code{target} command does not repeat if you press @key{RET} again
19002 after executing the command.
19004 @kindex help target
19006 Displays the names of all targets available. To display targets
19007 currently selected, use either @code{info target} or @code{info files}
19008 (@pxref{Files, ,Commands to Specify Files}).
19010 @item help target @var{name}
19011 Describe a particular target, including any parameters necessary to
19014 @kindex set gnutarget
19015 @item set gnutarget @var{args}
19016 @value{GDBN} uses its own library BFD to read your files. @value{GDBN}
19017 knows whether it is reading an @dfn{executable},
19018 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
19019 with the @code{set gnutarget} command. Unlike most @code{target} commands,
19020 with @code{gnutarget} the @code{target} refers to a program, not a machine.
19023 @emph{Warning:} To specify a file format with @code{set gnutarget},
19024 you must know the actual BFD name.
19028 @xref{Files, , Commands to Specify Files}.
19030 @kindex show gnutarget
19031 @item show gnutarget
19032 Use the @code{show gnutarget} command to display what file format
19033 @code{gnutarget} is set to read. If you have not set @code{gnutarget},
19034 @value{GDBN} will determine the file format for each file automatically,
19035 and @code{show gnutarget} displays @samp{The current BFD target is "auto"}.
19038 @cindex common targets
19039 Here are some common targets (available, or not, depending on the GDB
19044 @item target exec @var{program}
19045 @cindex executable file target
19046 An executable file. @samp{target exec @var{program}} is the same as
19047 @samp{exec-file @var{program}}.
19049 @item target core @var{filename}
19050 @cindex core dump file target
19051 A core dump file. @samp{target core @var{filename}} is the same as
19052 @samp{core-file @var{filename}}.
19054 @item target remote @var{medium}
19055 @cindex remote target
19056 A remote system connected to @value{GDBN} via a serial line or network
19057 connection. This command tells @value{GDBN} to use its own remote
19058 protocol over @var{medium} for debugging. @xref{Remote Debugging}.
19060 For example, if you have a board connected to @file{/dev/ttya} on the
19061 machine running @value{GDBN}, you could say:
19064 target remote /dev/ttya
19067 @code{target remote} supports the @code{load} command. This is only
19068 useful if you have some other way of getting the stub to the target
19069 system, and you can put it somewhere in memory where it won't get
19070 clobbered by the download.
19072 @item target sim @r{[}@var{simargs}@r{]} @dots{}
19073 @cindex built-in simulator target
19074 Builtin CPU simulator. @value{GDBN} includes simulators for most architectures.
19082 works; however, you cannot assume that a specific memory map, device
19083 drivers, or even basic I/O is available, although some simulators do
19084 provide these. For info about any processor-specific simulator details,
19085 see the appropriate section in @ref{Embedded Processors, ,Embedded
19088 @item target native
19089 @cindex native target
19090 Setup for local/native process debugging. Useful to make the
19091 @code{run} command spawn native processes (likewise @code{attach},
19092 etc.@:) even when @code{set auto-connect-native-target} is @code{off}
19093 (@pxref{set auto-connect-native-target}).
19097 Different targets are available on different configurations of @value{GDBN};
19098 your configuration may have more or fewer targets.
19100 Many remote targets require you to download the executable's code once
19101 you've successfully established a connection. You may wish to control
19102 various aspects of this process.
19107 @kindex set hash@r{, for remote monitors}
19108 @cindex hash mark while downloading
19109 This command controls whether a hash mark @samp{#} is displayed while
19110 downloading a file to the remote monitor. If on, a hash mark is
19111 displayed after each S-record is successfully downloaded to the
19115 @kindex show hash@r{, for remote monitors}
19116 Show the current status of displaying the hash mark.
19118 @item set debug monitor
19119 @kindex set debug monitor
19120 @cindex display remote monitor communications
19121 Enable or disable display of communications messages between
19122 @value{GDBN} and the remote monitor.
19124 @item show debug monitor
19125 @kindex show debug monitor
19126 Show the current status of displaying communications between
19127 @value{GDBN} and the remote monitor.
19132 @kindex load @var{filename}
19133 @item load @var{filename}
19135 Depending on what remote debugging facilities are configured into
19136 @value{GDBN}, the @code{load} command may be available. Where it exists, it
19137 is meant to make @var{filename} (an executable) available for debugging
19138 on the remote system---by downloading, or dynamic linking, for example.
19139 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
19140 the @code{add-symbol-file} command.
19142 If your @value{GDBN} does not have a @code{load} command, attempting to
19143 execute it gets the error message ``@code{You can't do that when your
19144 target is @dots{}}''
19146 The file is loaded at whatever address is specified in the executable.
19147 For some object file formats, you can specify the load address when you
19148 link the program; for other formats, like a.out, the object file format
19149 specifies a fixed address.
19150 @c FIXME! This would be a good place for an xref to the GNU linker doc.
19152 Depending on the remote side capabilities, @value{GDBN} may be able to
19153 load programs into flash memory.
19155 @code{load} does not repeat if you press @key{RET} again after using it.
19159 @section Choosing Target Byte Order
19161 @cindex choosing target byte order
19162 @cindex target byte order
19164 Some types of processors, such as the @acronym{MIPS}, PowerPC, and Renesas SH,
19165 offer the ability to run either big-endian or little-endian byte
19166 orders. Usually the executable or symbol will include a bit to
19167 designate the endian-ness, and you will not need to worry about
19168 which to use. However, you may still find it useful to adjust
19169 @value{GDBN}'s idea of processor endian-ness manually.
19173 @item set endian big
19174 Instruct @value{GDBN} to assume the target is big-endian.
19176 @item set endian little
19177 Instruct @value{GDBN} to assume the target is little-endian.
19179 @item set endian auto
19180 Instruct @value{GDBN} to use the byte order associated with the
19184 Display @value{GDBN}'s current idea of the target byte order.
19188 Note that these commands merely adjust interpretation of symbolic
19189 data on the host, and that they have absolutely no effect on the
19193 @node Remote Debugging
19194 @chapter Debugging Remote Programs
19195 @cindex remote debugging
19197 If you are trying to debug a program running on a machine that cannot run
19198 @value{GDBN} in the usual way, it is often useful to use remote debugging.
19199 For example, you might use remote debugging on an operating system kernel,
19200 or on a small system which does not have a general purpose operating system
19201 powerful enough to run a full-featured debugger.
19203 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
19204 to make this work with particular debugging targets. In addition,
19205 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
19206 but not specific to any particular target system) which you can use if you
19207 write the remote stubs---the code that runs on the remote system to
19208 communicate with @value{GDBN}.
19210 Other remote targets may be available in your
19211 configuration of @value{GDBN}; use @code{help target} to list them.
19214 * Connecting:: Connecting to a remote target
19215 * File Transfer:: Sending files to a remote system
19216 * Server:: Using the gdbserver program
19217 * Remote Configuration:: Remote configuration
19218 * Remote Stub:: Implementing a remote stub
19222 @section Connecting to a Remote Target
19224 @value{GDBN} needs an unstripped copy of your program to access symbol
19225 and debugging information. Some remote targets (@pxref{qXfer
19226 executable filename read}, and @pxref{Host I/O Packets}) allow
19227 @value{GDBN} to access program files over the same connection used to
19228 communicate with @value{GDBN}. With such a target, if the remote
19229 program is unstripped, the only command you need is @code{target
19230 remote}. Otherwise, start up @value{GDBN} using the name of the local
19231 unstripped copy of your program as the first argument, or use the
19232 @code{file} command.
19234 @cindex @code{target remote}
19235 @value{GDBN} can communicate with the target over a serial line, or
19236 over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In
19237 each case, @value{GDBN} uses the same protocol for debugging your
19238 program; only the medium carrying the debugging packets varies. The
19239 @code{target remote} command establishes a connection to the target.
19240 Its arguments indicate which medium to use:
19244 @item target remote @var{serial-device}
19245 @cindex serial line, @code{target remote}
19246 Use @var{serial-device} to communicate with the target. For example,
19247 to use a serial line connected to the device named @file{/dev/ttyb}:
19250 target remote /dev/ttyb
19253 If you're using a serial line, you may want to give @value{GDBN} the
19254 @samp{--baud} option, or use the @code{set serial baud} command
19255 (@pxref{Remote Configuration, set serial baud}) before the
19256 @code{target} command.
19258 @item target remote @code{@var{host}:@var{port}}
19259 @itemx target remote @code{tcp:@var{host}:@var{port}}
19260 @cindex @acronym{TCP} port, @code{target remote}
19261 Debug using a @acronym{TCP} connection to @var{port} on @var{host}.
19262 The @var{host} may be either a host name or a numeric @acronym{IP}
19263 address; @var{port} must be a decimal number. The @var{host} could be
19264 the target machine itself, if it is directly connected to the net, or
19265 it might be a terminal server which in turn has a serial line to the
19268 For example, to connect to port 2828 on a terminal server named
19272 target remote manyfarms:2828
19275 If your remote target is actually running on the same machine as your
19276 debugger session (e.g.@: a simulator for your target running on the
19277 same host), you can omit the hostname. For example, to connect to
19278 port 1234 on your local machine:
19281 target remote :1234
19285 Note that the colon is still required here.
19287 @item target remote @code{udp:@var{host}:@var{port}}
19288 @cindex @acronym{UDP} port, @code{target remote}
19289 Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to
19290 connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}:
19293 target remote udp:manyfarms:2828
19296 When using a @acronym{UDP} connection for remote debugging, you should
19297 keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP}
19298 can silently drop packets on busy or unreliable networks, which will
19299 cause havoc with your debugging session.
19301 @item target remote | @var{command}
19302 @cindex pipe, @code{target remote} to
19303 Run @var{command} in the background and communicate with it using a
19304 pipe. The @var{command} is a shell command, to be parsed and expanded
19305 by the system's command shell, @code{/bin/sh}; it should expect remote
19306 protocol packets on its standard input, and send replies on its
19307 standard output. You could use this to run a stand-alone simulator
19308 that speaks the remote debugging protocol, to make net connections
19309 using programs like @code{ssh}, or for other similar tricks.
19311 If @var{command} closes its standard output (perhaps by exiting),
19312 @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the
19313 program has already exited, this will have no effect.)
19317 Once the connection has been established, you can use all the usual
19318 commands to examine and change data. The remote program is already
19319 running; you can use @kbd{step} and @kbd{continue}, and you do not
19320 need to use @kbd{run}.
19322 @cindex interrupting remote programs
19323 @cindex remote programs, interrupting
19324 Whenever @value{GDBN} is waiting for the remote program, if you type the
19325 interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the
19326 program. This may or may not succeed, depending in part on the hardware
19327 and the serial drivers the remote system uses. If you type the
19328 interrupt character once again, @value{GDBN} displays this prompt:
19331 Interrupted while waiting for the program.
19332 Give up (and stop debugging it)? (y or n)
19335 If you type @kbd{y}, @value{GDBN} abandons the remote debugging session.
19336 (If you decide you want to try again later, you can use @samp{target
19337 remote} again to connect once more.) If you type @kbd{n}, @value{GDBN}
19338 goes back to waiting.
19341 @kindex detach (remote)
19343 When you have finished debugging the remote program, you can use the
19344 @code{detach} command to release it from @value{GDBN} control.
19345 Detaching from the target normally resumes its execution, but the results
19346 will depend on your particular remote stub. After the @code{detach}
19347 command, @value{GDBN} is free to connect to another target.
19351 The @code{disconnect} command behaves like @code{detach}, except that
19352 the target is generally not resumed. It will wait for @value{GDBN}
19353 (this instance or another one) to connect and continue debugging. After
19354 the @code{disconnect} command, @value{GDBN} is again free to connect to
19357 @cindex send command to remote monitor
19358 @cindex extend @value{GDBN} for remote targets
19359 @cindex add new commands for external monitor
19361 @item monitor @var{cmd}
19362 This command allows you to send arbitrary commands directly to the
19363 remote monitor. Since @value{GDBN} doesn't care about the commands it
19364 sends like this, this command is the way to extend @value{GDBN}---you
19365 can add new commands that only the external monitor will understand
19369 @node File Transfer
19370 @section Sending files to a remote system
19371 @cindex remote target, file transfer
19372 @cindex file transfer
19373 @cindex sending files to remote systems
19375 Some remote targets offer the ability to transfer files over the same
19376 connection used to communicate with @value{GDBN}. This is convenient
19377 for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems
19378 running @code{gdbserver} over a network interface. For other targets,
19379 e.g.@: embedded devices with only a single serial port, this may be
19380 the only way to upload or download files.
19382 Not all remote targets support these commands.
19386 @item remote put @var{hostfile} @var{targetfile}
19387 Copy file @var{hostfile} from the host system (the machine running
19388 @value{GDBN}) to @var{targetfile} on the target system.
19391 @item remote get @var{targetfile} @var{hostfile}
19392 Copy file @var{targetfile} from the target system to @var{hostfile}
19393 on the host system.
19395 @kindex remote delete
19396 @item remote delete @var{targetfile}
19397 Delete @var{targetfile} from the target system.
19402 @section Using the @code{gdbserver} Program
19405 @cindex remote connection without stubs
19406 @code{gdbserver} is a control program for Unix-like systems, which
19407 allows you to connect your program with a remote @value{GDBN} via
19408 @code{target remote}---but without linking in the usual debugging stub.
19410 @code{gdbserver} is not a complete replacement for the debugging stubs,
19411 because it requires essentially the same operating-system facilities
19412 that @value{GDBN} itself does. In fact, a system that can run
19413 @code{gdbserver} to connect to a remote @value{GDBN} could also run
19414 @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless,
19415 because it is a much smaller program than @value{GDBN} itself. It is
19416 also easier to port than all of @value{GDBN}, so you may be able to get
19417 started more quickly on a new system by using @code{gdbserver}.
19418 Finally, if you develop code for real-time systems, you may find that
19419 the tradeoffs involved in real-time operation make it more convenient to
19420 do as much development work as possible on another system, for example
19421 by cross-compiling. You can use @code{gdbserver} to make a similar
19422 choice for debugging.
19424 @value{GDBN} and @code{gdbserver} communicate via either a serial line
19425 or a TCP connection, using the standard @value{GDBN} remote serial
19429 @emph{Warning:} @code{gdbserver} does not have any built-in security.
19430 Do not run @code{gdbserver} connected to any public network; a
19431 @value{GDBN} connection to @code{gdbserver} provides access to the
19432 target system with the same privileges as the user running
19436 @subsection Running @code{gdbserver}
19437 @cindex arguments, to @code{gdbserver}
19438 @cindex @code{gdbserver}, command-line arguments
19440 Run @code{gdbserver} on the target system. You need a copy of the
19441 program you want to debug, including any libraries it requires.
19442 @code{gdbserver} does not need your program's symbol table, so you can
19443 strip the program if necessary to save space. @value{GDBN} on the host
19444 system does all the symbol handling.
19446 To use the server, you must tell it how to communicate with @value{GDBN};
19447 the name of your program; and the arguments for your program. The usual
19451 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
19454 @var{comm} is either a device name (to use a serial line), or a TCP
19455 hostname and portnumber, or @code{-} or @code{stdio} to use
19456 stdin/stdout of @code{gdbserver}.
19457 For example, to debug Emacs with the argument
19458 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
19462 target> gdbserver /dev/com1 emacs foo.txt
19465 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
19468 To use a TCP connection instead of a serial line:
19471 target> gdbserver host:2345 emacs foo.txt
19474 The only difference from the previous example is the first argument,
19475 specifying that you are communicating with the host @value{GDBN} via
19476 TCP. The @samp{host:2345} argument means that @code{gdbserver} is to
19477 expect a TCP connection from machine @samp{host} to local TCP port 2345.
19478 (Currently, the @samp{host} part is ignored.) You can choose any number
19479 you want for the port number as long as it does not conflict with any
19480 TCP ports already in use on the target system (for example, @code{23} is
19481 reserved for @code{telnet}).@footnote{If you choose a port number that
19482 conflicts with another service, @code{gdbserver} prints an error message
19483 and exits.} You must use the same port number with the host @value{GDBN}
19484 @code{target remote} command.
19486 The @code{stdio} connection is useful when starting @code{gdbserver}
19490 (gdb) target remote | ssh -T hostname gdbserver - hello
19493 The @samp{-T} option to ssh is provided because we don't need a remote pty,
19494 and we don't want escape-character handling. Ssh does this by default when
19495 a command is provided, the flag is provided to make it explicit.
19496 You could elide it if you want to.
19498 Programs started with stdio-connected gdbserver have @file{/dev/null} for
19499 @code{stdin}, and @code{stdout},@code{stderr} are sent back to gdb for
19500 display through a pipe connected to gdbserver.
19501 Both @code{stdout} and @code{stderr} use the same pipe.
19503 @subsubsection Attaching to a Running Program
19504 @cindex attach to a program, @code{gdbserver}
19505 @cindex @option{--attach}, @code{gdbserver} option
19507 On some targets, @code{gdbserver} can also attach to running programs.
19508 This is accomplished via the @code{--attach} argument. The syntax is:
19511 target> gdbserver --attach @var{comm} @var{pid}
19514 @var{pid} is the process ID of a currently running process. It isn't necessary
19515 to point @code{gdbserver} at a binary for the running process.
19518 You can debug processes by name instead of process ID if your target has the
19519 @code{pidof} utility:
19522 target> gdbserver --attach @var{comm} `pidof @var{program}`
19525 In case more than one copy of @var{program} is running, or @var{program}
19526 has multiple threads, most versions of @code{pidof} support the
19527 @code{-s} option to only return the first process ID.
19529 @subsubsection Multi-Process Mode for @code{gdbserver}
19530 @cindex @code{gdbserver}, multiple processes
19531 @cindex multiple processes with @code{gdbserver}
19533 When you connect to @code{gdbserver} using @code{target remote},
19534 @code{gdbserver} debugs the specified program only once. When the
19535 program exits, or you detach from it, @value{GDBN} closes the connection
19536 and @code{gdbserver} exits.
19538 If you connect using @kbd{target extended-remote}, @code{gdbserver}
19539 enters multi-process mode. When the debugged program exits, or you
19540 detach from it, @value{GDBN} stays connected to @code{gdbserver} even
19541 though no program is running. The @code{run} and @code{attach}
19542 commands instruct @code{gdbserver} to run or attach to a new program.
19543 The @code{run} command uses @code{set remote exec-file} (@pxref{set
19544 remote exec-file}) to select the program to run. Command line
19545 arguments are supported, except for wildcard expansion and I/O
19546 redirection (@pxref{Arguments}).
19548 @cindex @option{--multi}, @code{gdbserver} option
19549 To start @code{gdbserver} without supplying an initial command to run
19550 or process ID to attach, use the @option{--multi} command line option.
19551 Then you can connect using @kbd{target extended-remote} and start
19552 the program you want to debug.
19554 In multi-process mode @code{gdbserver} does not automatically exit unless you
19555 use the option @option{--once}. You can terminate it by using
19556 @code{monitor exit} (@pxref{Monitor Commands for gdbserver}). Note that the
19557 conditions under which @code{gdbserver} terminates depend on how @value{GDBN}
19558 connects to it (@kbd{target remote} or @kbd{target extended-remote}). The
19559 @option{--multi} option to @code{gdbserver} has no influence on that.
19561 @subsubsection TCP port allocation lifecycle of @code{gdbserver}
19563 This section applies only when @code{gdbserver} is run to listen on a TCP port.
19565 @code{gdbserver} normally terminates after all of its debugged processes have
19566 terminated in @kbd{target remote} mode. On the other hand, for @kbd{target
19567 extended-remote}, @code{gdbserver} stays running even with no processes left.
19568 @value{GDBN} normally terminates the spawned debugged process on its exit,
19569 which normally also terminates @code{gdbserver} in the @kbd{target remote}
19570 mode. Therefore, when the connection drops unexpectedly, and @value{GDBN}
19571 cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver}
19572 stays running even in the @kbd{target remote} mode.
19574 When @code{gdbserver} stays running, @value{GDBN} can connect to it again later.
19575 Such reconnecting is useful for features like @ref{disconnected tracing}. For
19576 completeness, at most one @value{GDBN} can be connected at a time.
19578 @cindex @option{--once}, @code{gdbserver} option
19579 By default, @code{gdbserver} keeps the listening TCP port open, so that
19580 subsequent connections are possible. However, if you start @code{gdbserver}
19581 with the @option{--once} option, it will stop listening for any further
19582 connection attempts after connecting to the first @value{GDBN} session. This
19583 means no further connections to @code{gdbserver} will be possible after the
19584 first one. It also means @code{gdbserver} will terminate after the first
19585 connection with remote @value{GDBN} has closed, even for unexpectedly closed
19586 connections and even in the @kbd{target extended-remote} mode. The
19587 @option{--once} option allows reusing the same port number for connecting to
19588 multiple instances of @code{gdbserver} running on the same host, since each
19589 instance closes its port after the first connection.
19591 @anchor{Other Command-Line Arguments for gdbserver}
19592 @subsubsection Other Command-Line Arguments for @code{gdbserver}
19594 @cindex @option{--debug}, @code{gdbserver} option
19595 The @option{--debug} option tells @code{gdbserver} to display extra
19596 status information about the debugging process.
19597 @cindex @option{--remote-debug}, @code{gdbserver} option
19598 The @option{--remote-debug} option tells @code{gdbserver} to display
19599 remote protocol debug output. These options are intended for
19600 @code{gdbserver} development and for bug reports to the developers.
19602 @cindex @option{--debug-format}, @code{gdbserver} option
19603 The @option{--debug-format=option1[,option2,...]} option tells
19604 @code{gdbserver} to include additional information in each output.
19605 Possible options are:
19609 Turn off all extra information in debugging output.
19611 Turn on all extra information in debugging output.
19613 Include a timestamp in each line of debugging output.
19616 Options are processed in order. Thus, for example, if @option{none}
19617 appears last then no additional information is added to debugging output.
19619 @cindex @option{--wrapper}, @code{gdbserver} option
19620 The @option{--wrapper} option specifies a wrapper to launch programs
19621 for debugging. The option should be followed by the name of the
19622 wrapper, then any command-line arguments to pass to the wrapper, then
19623 @kbd{--} indicating the end of the wrapper arguments.
19625 @code{gdbserver} runs the specified wrapper program with a combined
19626 command line including the wrapper arguments, then the name of the
19627 program to debug, then any arguments to the program. The wrapper
19628 runs until it executes your program, and then @value{GDBN} gains control.
19630 You can use any program that eventually calls @code{execve} with
19631 its arguments as a wrapper. Several standard Unix utilities do
19632 this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending
19633 with @code{exec "$@@"} will also work.
19635 For example, you can use @code{env} to pass an environment variable to
19636 the debugged program, without setting the variable in @code{gdbserver}'s
19640 $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog
19643 @subsection Connecting to @code{gdbserver}
19645 Run @value{GDBN} on the host system.
19647 First make sure you have the necessary symbol files. Load symbols for
19648 your application using the @code{file} command before you connect. Use
19649 @code{set sysroot} to locate target libraries (unless your @value{GDBN}
19650 was compiled with the correct sysroot using @code{--with-sysroot}).
19652 The symbol file and target libraries must exactly match the executable
19653 and libraries on the target, with one exception: the files on the host
19654 system should not be stripped, even if the files on the target system
19655 are. Mismatched or missing files will lead to confusing results
19656 during debugging. On @sc{gnu}/Linux targets, mismatched or missing
19657 files may also prevent @code{gdbserver} from debugging multi-threaded
19660 Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
19661 For TCP connections, you must start up @code{gdbserver} prior to using
19662 the @code{target remote} command. Otherwise you may get an error whose
19663 text depends on the host system, but which usually looks something like
19664 @samp{Connection refused}. Don't use the @code{load}
19665 command in @value{GDBN} when using @code{gdbserver}, since the program is
19666 already on the target.
19668 @subsection Monitor Commands for @code{gdbserver}
19669 @cindex monitor commands, for @code{gdbserver}
19670 @anchor{Monitor Commands for gdbserver}
19672 During a @value{GDBN} session using @code{gdbserver}, you can use the
19673 @code{monitor} command to send special requests to @code{gdbserver}.
19674 Here are the available commands.
19678 List the available monitor commands.
19680 @item monitor set debug 0
19681 @itemx monitor set debug 1
19682 Disable or enable general debugging messages.
19684 @item monitor set remote-debug 0
19685 @itemx monitor set remote-debug 1
19686 Disable or enable specific debugging messages associated with the remote
19687 protocol (@pxref{Remote Protocol}).
19689 @item monitor set debug-format option1@r{[},option2,...@r{]}
19690 Specify additional text to add to debugging messages.
19691 Possible options are:
19695 Turn off all extra information in debugging output.
19697 Turn on all extra information in debugging output.
19699 Include a timestamp in each line of debugging output.
19702 Options are processed in order. Thus, for example, if @option{none}
19703 appears last then no additional information is added to debugging output.
19705 @item monitor set libthread-db-search-path [PATH]
19706 @cindex gdbserver, search path for @code{libthread_db}
19707 When this command is issued, @var{path} is a colon-separated list of
19708 directories to search for @code{libthread_db} (@pxref{Threads,,set
19709 libthread-db-search-path}). If you omit @var{path},
19710 @samp{libthread-db-search-path} will be reset to its default value.
19712 The special entry @samp{$pdir} for @samp{libthread-db-search-path} is
19713 not supported in @code{gdbserver}.
19716 Tell gdbserver to exit immediately. This command should be followed by
19717 @code{disconnect} to close the debugging session. @code{gdbserver} will
19718 detach from any attached processes and kill any processes it created.
19719 Use @code{monitor exit} to terminate @code{gdbserver} at the end
19720 of a multi-process mode debug session.
19724 @subsection Tracepoints support in @code{gdbserver}
19725 @cindex tracepoints support in @code{gdbserver}
19727 On some targets, @code{gdbserver} supports tracepoints, fast
19728 tracepoints and static tracepoints.
19730 For fast or static tracepoints to work, a special library called the
19731 @dfn{in-process agent} (IPA), must be loaded in the inferior process.
19732 This library is built and distributed as an integral part of
19733 @code{gdbserver}. In addition, support for static tracepoints
19734 requires building the in-process agent library with static tracepoints
19735 support. At present, the UST (LTTng Userspace Tracer,
19736 @url{http://lttng.org/ust}) tracing engine is supported. This support
19737 is automatically available if UST development headers are found in the
19738 standard include path when @code{gdbserver} is built, or if
19739 @code{gdbserver} was explicitly configured using @option{--with-ust}
19740 to point at such headers. You can explicitly disable the support
19741 using @option{--with-ust=no}.
19743 There are several ways to load the in-process agent in your program:
19746 @item Specifying it as dependency at link time
19748 You can link your program dynamically with the in-process agent
19749 library. On most systems, this is accomplished by adding
19750 @code{-linproctrace} to the link command.
19752 @item Using the system's preloading mechanisms
19754 You can force loading the in-process agent at startup time by using
19755 your system's support for preloading shared libraries. Many Unixes
19756 support the concept of preloading user defined libraries. In most
19757 cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so}
19758 in the environment. See also the description of @code{gdbserver}'s
19759 @option{--wrapper} command line option.
19761 @item Using @value{GDBN} to force loading the agent at run time
19763 On some systems, you can force the inferior to load a shared library,
19764 by calling a dynamic loader function in the inferior that takes care
19765 of dynamically looking up and loading a shared library. On most Unix
19766 systems, the function is @code{dlopen}. You'll use the @code{call}
19767 command for that. For example:
19770 (@value{GDBP}) call dlopen ("libinproctrace.so", ...)
19773 Note that on most Unix systems, for the @code{dlopen} function to be
19774 available, the program needs to be linked with @code{-ldl}.
19777 On systems that have a userspace dynamic loader, like most Unix
19778 systems, when you connect to @code{gdbserver} using @code{target
19779 remote}, you'll find that the program is stopped at the dynamic
19780 loader's entry point, and no shared library has been loaded in the
19781 program's address space yet, including the in-process agent. In that
19782 case, before being able to use any of the fast or static tracepoints
19783 features, you need to let the loader run and load the shared
19784 libraries. The simplest way to do that is to run the program to the
19785 main procedure. E.g., if debugging a C or C@t{++} program, start
19786 @code{gdbserver} like so:
19789 $ gdbserver :9999 myprogram
19792 Start GDB and connect to @code{gdbserver} like so, and run to main:
19796 (@value{GDBP}) target remote myhost:9999
19797 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2
19798 (@value{GDBP}) b main
19799 (@value{GDBP}) continue
19802 The in-process tracing agent library should now be loaded into the
19803 process; you can confirm it with the @code{info sharedlibrary}
19804 command, which will list @file{libinproctrace.so} as loaded in the
19805 process. You are now ready to install fast tracepoints, list static
19806 tracepoint markers, probe static tracepoints markers, and start
19809 @node Remote Configuration
19810 @section Remote Configuration
19813 @kindex show remote
19814 This section documents the configuration options available when
19815 debugging remote programs. For the options related to the File I/O
19816 extensions of the remote protocol, see @ref{system,
19817 system-call-allowed}.
19820 @item set remoteaddresssize @var{bits}
19821 @cindex address size for remote targets
19822 @cindex bits in remote address
19823 Set the maximum size of address in a memory packet to the specified
19824 number of bits. @value{GDBN} will mask off the address bits above
19825 that number, when it passes addresses to the remote target. The
19826 default value is the number of bits in the target's address.
19828 @item show remoteaddresssize
19829 Show the current value of remote address size in bits.
19831 @item set serial baud @var{n}
19832 @cindex baud rate for remote targets
19833 Set the baud rate for the remote serial I/O to @var{n} baud. The
19834 value is used to set the speed of the serial port used for debugging
19837 @item show serial baud
19838 Show the current speed of the remote connection.
19840 @item set serial parity @var{parity}
19841 Set the parity for the remote serial I/O. Supported values of @var{parity} are:
19842 @code{even}, @code{none}, and @code{odd}. The default is @code{none}.
19844 @item show serial parity
19845 Show the current parity of the serial port.
19847 @item set remotebreak
19848 @cindex interrupt remote programs
19849 @cindex BREAK signal instead of Ctrl-C
19850 @anchor{set remotebreak}
19851 If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote
19852 when you type @kbd{Ctrl-c} to interrupt the program running
19853 on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C}
19854 character instead. The default is off, since most remote systems
19855 expect to see @samp{Ctrl-C} as the interrupt signal.
19857 @item show remotebreak
19858 Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to
19859 interrupt the remote program.
19861 @item set remoteflow on
19862 @itemx set remoteflow off
19863 @kindex set remoteflow
19864 Enable or disable hardware flow control (@code{RTS}/@code{CTS})
19865 on the serial port used to communicate to the remote target.
19867 @item show remoteflow
19868 @kindex show remoteflow
19869 Show the current setting of hardware flow control.
19871 @item set remotelogbase @var{base}
19872 Set the base (a.k.a.@: radix) of logging serial protocol
19873 communications to @var{base}. Supported values of @var{base} are:
19874 @code{ascii}, @code{octal}, and @code{hex}. The default is
19877 @item show remotelogbase
19878 Show the current setting of the radix for logging remote serial
19881 @item set remotelogfile @var{file}
19882 @cindex record serial communications on file
19883 Record remote serial communications on the named @var{file}. The
19884 default is not to record at all.
19886 @item show remotelogfile.
19887 Show the current setting of the file name on which to record the
19888 serial communications.
19890 @item set remotetimeout @var{num}
19891 @cindex timeout for serial communications
19892 @cindex remote timeout
19893 Set the timeout limit to wait for the remote target to respond to
19894 @var{num} seconds. The default is 2 seconds.
19896 @item show remotetimeout
19897 Show the current number of seconds to wait for the remote target
19900 @cindex limit hardware breakpoints and watchpoints
19901 @cindex remote target, limit break- and watchpoints
19902 @anchor{set remote hardware-watchpoint-limit}
19903 @anchor{set remote hardware-breakpoint-limit}
19904 @item set remote hardware-watchpoint-limit @var{limit}
19905 @itemx set remote hardware-breakpoint-limit @var{limit}
19906 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
19907 watchpoints. A limit of -1, the default, is treated as unlimited.
19909 @cindex limit hardware watchpoints length
19910 @cindex remote target, limit watchpoints length
19911 @anchor{set remote hardware-watchpoint-length-limit}
19912 @item set remote hardware-watchpoint-length-limit @var{limit}
19913 Restrict @value{GDBN} to using @var{limit} bytes for the maximum length of
19914 a remote hardware watchpoint. A limit of -1, the default, is treated
19917 @item show remote hardware-watchpoint-length-limit
19918 Show the current limit (in bytes) of the maximum length of
19919 a remote hardware watchpoint.
19921 @item set remote exec-file @var{filename}
19922 @itemx show remote exec-file
19923 @anchor{set remote exec-file}
19924 @cindex executable file, for remote target
19925 Select the file used for @code{run} with @code{target
19926 extended-remote}. This should be set to a filename valid on the
19927 target system. If it is not set, the target will use a default
19928 filename (e.g.@: the last program run).
19930 @item set remote interrupt-sequence
19931 @cindex interrupt remote programs
19932 @cindex select Ctrl-C, BREAK or BREAK-g
19933 Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or
19934 @samp{BREAK-g} as the
19935 sequence to the remote target in order to interrupt the execution.
19936 @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which
19937 is high level of serial line for some certain time.
19938 Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g.
19939 It is @code{BREAK} signal followed by character @code{g}.
19941 @item show interrupt-sequence
19942 Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g}
19943 is sent by @value{GDBN} to interrupt the remote program.
19944 @code{BREAK-g} is BREAK signal followed by @code{g} and
19945 also known as Magic SysRq g.
19947 @item set remote interrupt-on-connect
19948 @cindex send interrupt-sequence on start
19949 Specify whether interrupt-sequence is sent to remote target when
19950 @value{GDBN} connects to it. This is mostly needed when you debug
19951 Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g}
19952 which is known as Magic SysRq g in order to connect @value{GDBN}.
19954 @item show interrupt-on-connect
19955 Show whether interrupt-sequence is sent
19956 to remote target when @value{GDBN} connects to it.
19960 @item set tcp auto-retry on
19961 @cindex auto-retry, for remote TCP target
19962 Enable auto-retry for remote TCP connections. This is useful if the remote
19963 debugging agent is launched in parallel with @value{GDBN}; there is a race
19964 condition because the agent may not become ready to accept the connection
19965 before @value{GDBN} attempts to connect. When auto-retry is
19966 enabled, if the initial attempt to connect fails, @value{GDBN} reattempts
19967 to establish the connection using the timeout specified by
19968 @code{set tcp connect-timeout}.
19970 @item set tcp auto-retry off
19971 Do not auto-retry failed TCP connections.
19973 @item show tcp auto-retry
19974 Show the current auto-retry setting.
19976 @item set tcp connect-timeout @var{seconds}
19977 @itemx set tcp connect-timeout unlimited
19978 @cindex connection timeout, for remote TCP target
19979 @cindex timeout, for remote target connection
19980 Set the timeout for establishing a TCP connection to the remote target to
19981 @var{seconds}. The timeout affects both polling to retry failed connections
19982 (enabled by @code{set tcp auto-retry on}) and waiting for connections
19983 that are merely slow to complete, and represents an approximate cumulative
19984 value. If @var{seconds} is @code{unlimited}, there is no timeout and
19985 @value{GDBN} will keep attempting to establish a connection forever,
19986 unless interrupted with @kbd{Ctrl-c}. The default is 15 seconds.
19988 @item show tcp connect-timeout
19989 Show the current connection timeout setting.
19992 @cindex remote packets, enabling and disabling
19993 The @value{GDBN} remote protocol autodetects the packets supported by
19994 your debugging stub. If you need to override the autodetection, you
19995 can use these commands to enable or disable individual packets. Each
19996 packet can be set to @samp{on} (the remote target supports this
19997 packet), @samp{off} (the remote target does not support this packet),
19998 or @samp{auto} (detect remote target support for this packet). They
19999 all default to @samp{auto}. For more information about each packet,
20000 see @ref{Remote Protocol}.
20002 During normal use, you should not have to use any of these commands.
20003 If you do, that may be a bug in your remote debugging stub, or a bug
20004 in @value{GDBN}. You may want to report the problem to the
20005 @value{GDBN} developers.
20007 For each packet @var{name}, the command to enable or disable the
20008 packet is @code{set remote @var{name}-packet}. The available settings
20011 @multitable @columnfractions 0.28 0.32 0.25
20014 @tab Related Features
20016 @item @code{fetch-register}
20018 @tab @code{info registers}
20020 @item @code{set-register}
20024 @item @code{binary-download}
20026 @tab @code{load}, @code{set}
20028 @item @code{read-aux-vector}
20029 @tab @code{qXfer:auxv:read}
20030 @tab @code{info auxv}
20032 @item @code{symbol-lookup}
20033 @tab @code{qSymbol}
20034 @tab Detecting multiple threads
20036 @item @code{attach}
20037 @tab @code{vAttach}
20040 @item @code{verbose-resume}
20042 @tab Stepping or resuming multiple threads
20048 @item @code{software-breakpoint}
20052 @item @code{hardware-breakpoint}
20056 @item @code{write-watchpoint}
20060 @item @code{read-watchpoint}
20064 @item @code{access-watchpoint}
20068 @item @code{pid-to-exec-file}
20069 @tab @code{qXfer:exec-file:read}
20070 @tab @code{attach}, @code{run}
20072 @item @code{target-features}
20073 @tab @code{qXfer:features:read}
20074 @tab @code{set architecture}
20076 @item @code{library-info}
20077 @tab @code{qXfer:libraries:read}
20078 @tab @code{info sharedlibrary}
20080 @item @code{memory-map}
20081 @tab @code{qXfer:memory-map:read}
20082 @tab @code{info mem}
20084 @item @code{read-sdata-object}
20085 @tab @code{qXfer:sdata:read}
20086 @tab @code{print $_sdata}
20088 @item @code{read-spu-object}
20089 @tab @code{qXfer:spu:read}
20090 @tab @code{info spu}
20092 @item @code{write-spu-object}
20093 @tab @code{qXfer:spu:write}
20094 @tab @code{info spu}
20096 @item @code{read-siginfo-object}
20097 @tab @code{qXfer:siginfo:read}
20098 @tab @code{print $_siginfo}
20100 @item @code{write-siginfo-object}
20101 @tab @code{qXfer:siginfo:write}
20102 @tab @code{set $_siginfo}
20104 @item @code{threads}
20105 @tab @code{qXfer:threads:read}
20106 @tab @code{info threads}
20108 @item @code{get-thread-local-@*storage-address}
20109 @tab @code{qGetTLSAddr}
20110 @tab Displaying @code{__thread} variables
20112 @item @code{get-thread-information-block-address}
20113 @tab @code{qGetTIBAddr}
20114 @tab Display MS-Windows Thread Information Block.
20116 @item @code{search-memory}
20117 @tab @code{qSearch:memory}
20120 @item @code{supported-packets}
20121 @tab @code{qSupported}
20122 @tab Remote communications parameters
20124 @item @code{pass-signals}
20125 @tab @code{QPassSignals}
20126 @tab @code{handle @var{signal}}
20128 @item @code{program-signals}
20129 @tab @code{QProgramSignals}
20130 @tab @code{handle @var{signal}}
20132 @item @code{hostio-close-packet}
20133 @tab @code{vFile:close}
20134 @tab @code{remote get}, @code{remote put}
20136 @item @code{hostio-open-packet}
20137 @tab @code{vFile:open}
20138 @tab @code{remote get}, @code{remote put}
20140 @item @code{hostio-pread-packet}
20141 @tab @code{vFile:pread}
20142 @tab @code{remote get}, @code{remote put}
20144 @item @code{hostio-pwrite-packet}
20145 @tab @code{vFile:pwrite}
20146 @tab @code{remote get}, @code{remote put}
20148 @item @code{hostio-unlink-packet}
20149 @tab @code{vFile:unlink}
20150 @tab @code{remote delete}
20152 @item @code{hostio-readlink-packet}
20153 @tab @code{vFile:readlink}
20156 @item @code{hostio-fstat-packet}
20157 @tab @code{vFile:fstat}
20160 @item @code{hostio-setfs-packet}
20161 @tab @code{vFile:setfs}
20164 @item @code{noack-packet}
20165 @tab @code{QStartNoAckMode}
20166 @tab Packet acknowledgment
20168 @item @code{osdata}
20169 @tab @code{qXfer:osdata:read}
20170 @tab @code{info os}
20172 @item @code{query-attached}
20173 @tab @code{qAttached}
20174 @tab Querying remote process attach state.
20176 @item @code{trace-buffer-size}
20177 @tab @code{QTBuffer:size}
20178 @tab @code{set trace-buffer-size}
20180 @item @code{trace-status}
20181 @tab @code{qTStatus}
20182 @tab @code{tstatus}
20184 @item @code{traceframe-info}
20185 @tab @code{qXfer:traceframe-info:read}
20186 @tab Traceframe info
20188 @item @code{install-in-trace}
20189 @tab @code{InstallInTrace}
20190 @tab Install tracepoint in tracing
20192 @item @code{disable-randomization}
20193 @tab @code{QDisableRandomization}
20194 @tab @code{set disable-randomization}
20196 @item @code{conditional-breakpoints-packet}
20197 @tab @code{Z0 and Z1}
20198 @tab @code{Support for target-side breakpoint condition evaluation}
20200 @item @code{multiprocess-extensions}
20201 @tab @code{multiprocess extensions}
20202 @tab Debug multiple processes and remote process PID awareness
20204 @item @code{swbreak-feature}
20205 @tab @code{swbreak stop reason}
20208 @item @code{hwbreak-feature}
20209 @tab @code{hwbreak stop reason}
20212 @item @code{fork-event-feature}
20213 @tab @code{fork stop reason}
20216 @item @code{vfork-event-feature}
20217 @tab @code{vfork stop reason}
20220 @item @code{exec-event-feature}
20221 @tab @code{exec stop reason}
20227 @section Implementing a Remote Stub
20229 @cindex debugging stub, example
20230 @cindex remote stub, example
20231 @cindex stub example, remote debugging
20232 The stub files provided with @value{GDBN} implement the target side of the
20233 communication protocol, and the @value{GDBN} side is implemented in the
20234 @value{GDBN} source file @file{remote.c}. Normally, you can simply allow
20235 these subroutines to communicate, and ignore the details. (If you're
20236 implementing your own stub file, you can still ignore the details: start
20237 with one of the existing stub files. @file{sparc-stub.c} is the best
20238 organized, and therefore the easiest to read.)
20240 @cindex remote serial debugging, overview
20241 To debug a program running on another machine (the debugging
20242 @dfn{target} machine), you must first arrange for all the usual
20243 prerequisites for the program to run by itself. For example, for a C
20248 A startup routine to set up the C runtime environment; these usually
20249 have a name like @file{crt0}. The startup routine may be supplied by
20250 your hardware supplier, or you may have to write your own.
20253 A C subroutine library to support your program's
20254 subroutine calls, notably managing input and output.
20257 A way of getting your program to the other machine---for example, a
20258 download program. These are often supplied by the hardware
20259 manufacturer, but you may have to write your own from hardware
20263 The next step is to arrange for your program to use a serial port to
20264 communicate with the machine where @value{GDBN} is running (the @dfn{host}
20265 machine). In general terms, the scheme looks like this:
20269 @value{GDBN} already understands how to use this protocol; when everything
20270 else is set up, you can simply use the @samp{target remote} command
20271 (@pxref{Targets,,Specifying a Debugging Target}).
20273 @item On the target,
20274 you must link with your program a few special-purpose subroutines that
20275 implement the @value{GDBN} remote serial protocol. The file containing these
20276 subroutines is called a @dfn{debugging stub}.
20278 On certain remote targets, you can use an auxiliary program
20279 @code{gdbserver} instead of linking a stub into your program.
20280 @xref{Server,,Using the @code{gdbserver} Program}, for details.
20283 The debugging stub is specific to the architecture of the remote
20284 machine; for example, use @file{sparc-stub.c} to debug programs on
20287 @cindex remote serial stub list
20288 These working remote stubs are distributed with @value{GDBN}:
20293 @cindex @file{i386-stub.c}
20296 For Intel 386 and compatible architectures.
20299 @cindex @file{m68k-stub.c}
20300 @cindex Motorola 680x0
20302 For Motorola 680x0 architectures.
20305 @cindex @file{sh-stub.c}
20308 For Renesas SH architectures.
20311 @cindex @file{sparc-stub.c}
20313 For @sc{sparc} architectures.
20315 @item sparcl-stub.c
20316 @cindex @file{sparcl-stub.c}
20319 For Fujitsu @sc{sparclite} architectures.
20323 The @file{README} file in the @value{GDBN} distribution may list other
20324 recently added stubs.
20327 * Stub Contents:: What the stub can do for you
20328 * Bootstrapping:: What you must do for the stub
20329 * Debug Session:: Putting it all together
20332 @node Stub Contents
20333 @subsection What the Stub Can Do for You
20335 @cindex remote serial stub
20336 The debugging stub for your architecture supplies these three
20340 @item set_debug_traps
20341 @findex set_debug_traps
20342 @cindex remote serial stub, initialization
20343 This routine arranges for @code{handle_exception} to run when your
20344 program stops. You must call this subroutine explicitly in your
20345 program's startup code.
20347 @item handle_exception
20348 @findex handle_exception
20349 @cindex remote serial stub, main routine
20350 This is the central workhorse, but your program never calls it
20351 explicitly---the setup code arranges for @code{handle_exception} to
20352 run when a trap is triggered.
20354 @code{handle_exception} takes control when your program stops during
20355 execution (for example, on a breakpoint), and mediates communications
20356 with @value{GDBN} on the host machine. This is where the communications
20357 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
20358 representative on the target machine. It begins by sending summary
20359 information on the state of your program, then continues to execute,
20360 retrieving and transmitting any information @value{GDBN} needs, until you
20361 execute a @value{GDBN} command that makes your program resume; at that point,
20362 @code{handle_exception} returns control to your own code on the target
20366 @cindex @code{breakpoint} subroutine, remote
20367 Use this auxiliary subroutine to make your program contain a
20368 breakpoint. Depending on the particular situation, this may be the only
20369 way for @value{GDBN} to get control. For instance, if your target
20370 machine has some sort of interrupt button, you won't need to call this;
20371 pressing the interrupt button transfers control to
20372 @code{handle_exception}---in effect, to @value{GDBN}. On some machines,
20373 simply receiving characters on the serial port may also trigger a trap;
20374 again, in that situation, you don't need to call @code{breakpoint} from
20375 your own program---simply running @samp{target remote} from the host
20376 @value{GDBN} session gets control.
20378 Call @code{breakpoint} if none of these is true, or if you simply want
20379 to make certain your program stops at a predetermined point for the
20380 start of your debugging session.
20383 @node Bootstrapping
20384 @subsection What You Must Do for the Stub
20386 @cindex remote stub, support routines
20387 The debugging stubs that come with @value{GDBN} are set up for a particular
20388 chip architecture, but they have no information about the rest of your
20389 debugging target machine.
20391 First of all you need to tell the stub how to communicate with the
20395 @item int getDebugChar()
20396 @findex getDebugChar
20397 Write this subroutine to read a single character from the serial port.
20398 It may be identical to @code{getchar} for your target system; a
20399 different name is used to allow you to distinguish the two if you wish.
20401 @item void putDebugChar(int)
20402 @findex putDebugChar
20403 Write this subroutine to write a single character to the serial port.
20404 It may be identical to @code{putchar} for your target system; a
20405 different name is used to allow you to distinguish the two if you wish.
20408 @cindex control C, and remote debugging
20409 @cindex interrupting remote targets
20410 If you want @value{GDBN} to be able to stop your program while it is
20411 running, you need to use an interrupt-driven serial driver, and arrange
20412 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
20413 character). That is the character which @value{GDBN} uses to tell the
20414 remote system to stop.
20416 Getting the debugging target to return the proper status to @value{GDBN}
20417 probably requires changes to the standard stub; one quick and dirty way
20418 is to just execute a breakpoint instruction (the ``dirty'' part is that
20419 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
20421 Other routines you need to supply are:
20424 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
20425 @findex exceptionHandler
20426 Write this function to install @var{exception_address} in the exception
20427 handling tables. You need to do this because the stub does not have any
20428 way of knowing what the exception handling tables on your target system
20429 are like (for example, the processor's table might be in @sc{rom},
20430 containing entries which point to a table in @sc{ram}).
20431 The @var{exception_number} specifies the exception which should be changed;
20432 its meaning is architecture-dependent (for example, different numbers
20433 might represent divide by zero, misaligned access, etc). When this
20434 exception occurs, control should be transferred directly to
20435 @var{exception_address}, and the processor state (stack, registers,
20436 and so on) should be just as it is when a processor exception occurs. So if
20437 you want to use a jump instruction to reach @var{exception_address}, it
20438 should be a simple jump, not a jump to subroutine.
20440 For the 386, @var{exception_address} should be installed as an interrupt
20441 gate so that interrupts are masked while the handler runs. The gate
20442 should be at privilege level 0 (the most privileged level). The
20443 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
20444 help from @code{exceptionHandler}.
20446 @item void flush_i_cache()
20447 @findex flush_i_cache
20448 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
20449 instruction cache, if any, on your target machine. If there is no
20450 instruction cache, this subroutine may be a no-op.
20452 On target machines that have instruction caches, @value{GDBN} requires this
20453 function to make certain that the state of your program is stable.
20457 You must also make sure this library routine is available:
20460 @item void *memset(void *, int, int)
20462 This is the standard library function @code{memset} that sets an area of
20463 memory to a known value. If you have one of the free versions of
20464 @code{libc.a}, @code{memset} can be found there; otherwise, you must
20465 either obtain it from your hardware manufacturer, or write your own.
20468 If you do not use the GNU C compiler, you may need other standard
20469 library subroutines as well; this varies from one stub to another,
20470 but in general the stubs are likely to use any of the common library
20471 subroutines which @code{@value{NGCC}} generates as inline code.
20474 @node Debug Session
20475 @subsection Putting it All Together
20477 @cindex remote serial debugging summary
20478 In summary, when your program is ready to debug, you must follow these
20483 Make sure you have defined the supporting low-level routines
20484 (@pxref{Bootstrapping,,What You Must Do for the Stub}):
20486 @code{getDebugChar}, @code{putDebugChar},
20487 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
20491 Insert these lines in your program's startup code, before the main
20492 procedure is called:
20499 On some machines, when a breakpoint trap is raised, the hardware
20500 automatically makes the PC point to the instruction after the
20501 breakpoint. If your machine doesn't do that, you may need to adjust
20502 @code{handle_exception} to arrange for it to return to the instruction
20503 after the breakpoint on this first invocation, so that your program
20504 doesn't keep hitting the initial breakpoint instead of making
20508 For the 680x0 stub only, you need to provide a variable called
20509 @code{exceptionHook}. Normally you just use:
20512 void (*exceptionHook)() = 0;
20516 but if before calling @code{set_debug_traps}, you set it to point to a
20517 function in your program, that function is called when
20518 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
20519 error). The function indicated by @code{exceptionHook} is called with
20520 one parameter: an @code{int} which is the exception number.
20523 Compile and link together: your program, the @value{GDBN} debugging stub for
20524 your target architecture, and the supporting subroutines.
20527 Make sure you have a serial connection between your target machine and
20528 the @value{GDBN} host, and identify the serial port on the host.
20531 @c The "remote" target now provides a `load' command, so we should
20532 @c document that. FIXME.
20533 Download your program to your target machine (or get it there by
20534 whatever means the manufacturer provides), and start it.
20537 Start @value{GDBN} on the host, and connect to the target
20538 (@pxref{Connecting,,Connecting to a Remote Target}).
20542 @node Configurations
20543 @chapter Configuration-Specific Information
20545 While nearly all @value{GDBN} commands are available for all native and
20546 cross versions of the debugger, there are some exceptions. This chapter
20547 describes things that are only available in certain configurations.
20549 There are three major categories of configurations: native
20550 configurations, where the host and target are the same, embedded
20551 operating system configurations, which are usually the same for several
20552 different processor architectures, and bare embedded processors, which
20553 are quite different from each other.
20558 * Embedded Processors::
20565 This section describes details specific to particular native
20570 * BSD libkvm Interface:: Debugging BSD kernel memory images
20571 * SVR4 Process Information:: SVR4 process information
20572 * DJGPP Native:: Features specific to the DJGPP port
20573 * Cygwin Native:: Features specific to the Cygwin port
20574 * Hurd Native:: Features specific to @sc{gnu} Hurd
20575 * Darwin:: Features specific to Darwin
20581 On HP-UX systems, if you refer to a function or variable name that
20582 begins with a dollar sign, @value{GDBN} searches for a user or system
20583 name first, before it searches for a convenience variable.
20586 @node BSD libkvm Interface
20587 @subsection BSD libkvm Interface
20590 @cindex kernel memory image
20591 @cindex kernel crash dump
20593 BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
20594 interface that provides a uniform interface for accessing kernel virtual
20595 memory images, including live systems and crash dumps. @value{GDBN}
20596 uses this interface to allow you to debug live kernels and kernel crash
20597 dumps on many native BSD configurations. This is implemented as a
20598 special @code{kvm} debugging target. For debugging a live system, load
20599 the currently running kernel into @value{GDBN} and connect to the
20603 (@value{GDBP}) @b{target kvm}
20606 For debugging crash dumps, provide the file name of the crash dump as an
20610 (@value{GDBP}) @b{target kvm /var/crash/bsd.0}
20613 Once connected to the @code{kvm} target, the following commands are
20619 Set current context from the @dfn{Process Control Block} (PCB) address.
20622 Set current context from proc address. This command isn't available on
20623 modern FreeBSD systems.
20626 @node SVR4 Process Information
20627 @subsection SVR4 Process Information
20629 @cindex examine process image
20630 @cindex process info via @file{/proc}
20632 Many versions of SVR4 and compatible systems provide a facility called
20633 @samp{/proc} that can be used to examine the image of a running
20634 process using file-system subroutines.
20636 If @value{GDBN} is configured for an operating system with this
20637 facility, the command @code{info proc} is available to report
20638 information about the process running your program, or about any
20639 process running on your system. This includes, as of this writing,
20640 @sc{gnu}/Linux and Solaris, but not HP-UX, for example.
20642 This command may also work on core files that were created on a system
20643 that has the @samp{/proc} facility.
20649 @itemx info proc @var{process-id}
20650 Summarize available information about any running process. If a
20651 process ID is specified by @var{process-id}, display information about
20652 that process; otherwise display information about the program being
20653 debugged. The summary includes the debugged process ID, the command
20654 line used to invoke it, its current working directory, and its
20655 executable file's absolute file name.
20657 On some systems, @var{process-id} can be of the form
20658 @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID
20659 within a process. If the optional @var{pid} part is missing, it means
20660 a thread from the process being debugged (the leading @samp{/} still
20661 needs to be present, or else @value{GDBN} will interpret the number as
20662 a process ID rather than a thread ID).
20664 @item info proc cmdline
20665 @cindex info proc cmdline
20666 Show the original command line of the process. This command is
20667 specific to @sc{gnu}/Linux.
20669 @item info proc cwd
20670 @cindex info proc cwd
20671 Show the current working directory of the process. This command is
20672 specific to @sc{gnu}/Linux.
20674 @item info proc exe
20675 @cindex info proc exe
20676 Show the name of executable of the process. This command is specific
20679 @item info proc mappings
20680 @cindex memory address space mappings
20681 Report the memory address space ranges accessible in the program, with
20682 information on whether the process has read, write, or execute access
20683 rights to each range. On @sc{gnu}/Linux systems, each memory range
20684 includes the object file which is mapped to that range, instead of the
20685 memory access rights to that range.
20687 @item info proc stat
20688 @itemx info proc status
20689 @cindex process detailed status information
20690 These subcommands are specific to @sc{gnu}/Linux systems. They show
20691 the process-related information, including the user ID and group ID;
20692 how many threads are there in the process; its virtual memory usage;
20693 the signals that are pending, blocked, and ignored; its TTY; its
20694 consumption of system and user time; its stack size; its @samp{nice}
20695 value; etc. For more information, see the @samp{proc} man page
20696 (type @kbd{man 5 proc} from your shell prompt).
20698 @item info proc all
20699 Show all the information about the process described under all of the
20700 above @code{info proc} subcommands.
20703 @comment These sub-options of 'info proc' were not included when
20704 @comment procfs.c was re-written. Keep their descriptions around
20705 @comment against the day when someone finds the time to put them back in.
20706 @kindex info proc times
20707 @item info proc times
20708 Starting time, user CPU time, and system CPU time for your program and
20711 @kindex info proc id
20713 Report on the process IDs related to your program: its own process ID,
20714 the ID of its parent, the process group ID, and the session ID.
20717 @item set procfs-trace
20718 @kindex set procfs-trace
20719 @cindex @code{procfs} API calls
20720 This command enables and disables tracing of @code{procfs} API calls.
20722 @item show procfs-trace
20723 @kindex show procfs-trace
20724 Show the current state of @code{procfs} API call tracing.
20726 @item set procfs-file @var{file}
20727 @kindex set procfs-file
20728 Tell @value{GDBN} to write @code{procfs} API trace to the named
20729 @var{file}. @value{GDBN} appends the trace info to the previous
20730 contents of the file. The default is to display the trace on the
20733 @item show procfs-file
20734 @kindex show procfs-file
20735 Show the file to which @code{procfs} API trace is written.
20737 @item proc-trace-entry
20738 @itemx proc-trace-exit
20739 @itemx proc-untrace-entry
20740 @itemx proc-untrace-exit
20741 @kindex proc-trace-entry
20742 @kindex proc-trace-exit
20743 @kindex proc-untrace-entry
20744 @kindex proc-untrace-exit
20745 These commands enable and disable tracing of entries into and exits
20746 from the @code{syscall} interface.
20749 @kindex info pidlist
20750 @cindex process list, QNX Neutrino
20751 For QNX Neutrino only, this command displays the list of all the
20752 processes and all the threads within each process.
20755 @kindex info meminfo
20756 @cindex mapinfo list, QNX Neutrino
20757 For QNX Neutrino only, this command displays the list of all mapinfos.
20761 @subsection Features for Debugging @sc{djgpp} Programs
20762 @cindex @sc{djgpp} debugging
20763 @cindex native @sc{djgpp} debugging
20764 @cindex MS-DOS-specific commands
20767 @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and
20768 MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs
20769 that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on
20770 top of real-mode DOS systems and their emulations.
20772 @value{GDBN} supports native debugging of @sc{djgpp} programs, and
20773 defines a few commands specific to the @sc{djgpp} port. This
20774 subsection describes those commands.
20779 This is a prefix of @sc{djgpp}-specific commands which print
20780 information about the target system and important OS structures.
20783 @cindex MS-DOS system info
20784 @cindex free memory information (MS-DOS)
20785 @item info dos sysinfo
20786 This command displays assorted information about the underlying
20787 platform: the CPU type and features, the OS version and flavor, the
20788 DPMI version, and the available conventional and DPMI memory.
20793 @cindex segment descriptor tables
20794 @cindex descriptor tables display
20796 @itemx info dos ldt
20797 @itemx info dos idt
20798 These 3 commands display entries from, respectively, Global, Local,
20799 and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor
20800 tables are data structures which store a descriptor for each segment
20801 that is currently in use. The segment's selector is an index into a
20802 descriptor table; the table entry for that index holds the
20803 descriptor's base address and limit, and its attributes and access
20806 A typical @sc{djgpp} program uses 3 segments: a code segment, a data
20807 segment (used for both data and the stack), and a DOS segment (which
20808 allows access to DOS/BIOS data structures and absolute addresses in
20809 conventional memory). However, the DPMI host will usually define
20810 additional segments in order to support the DPMI environment.
20812 @cindex garbled pointers
20813 These commands allow to display entries from the descriptor tables.
20814 Without an argument, all entries from the specified table are
20815 displayed. An argument, which should be an integer expression, means
20816 display a single entry whose index is given by the argument. For
20817 example, here's a convenient way to display information about the
20818 debugged program's data segment:
20821 @exdent @code{(@value{GDBP}) info dos ldt $ds}
20822 @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)}
20826 This comes in handy when you want to see whether a pointer is outside
20827 the data segment's limit (i.e.@: @dfn{garbled}).
20829 @cindex page tables display (MS-DOS)
20831 @itemx info dos pte
20832 These two commands display entries from, respectively, the Page
20833 Directory and the Page Tables. Page Directories and Page Tables are
20834 data structures which control how virtual memory addresses are mapped
20835 into physical addresses. A Page Table includes an entry for every
20836 page of memory that is mapped into the program's address space; there
20837 may be several Page Tables, each one holding up to 4096 entries. A
20838 Page Directory has up to 4096 entries, one each for every Page Table
20839 that is currently in use.
20841 Without an argument, @kbd{info dos pde} displays the entire Page
20842 Directory, and @kbd{info dos pte} displays all the entries in all of
20843 the Page Tables. An argument, an integer expression, given to the
20844 @kbd{info dos pde} command means display only that entry from the Page
20845 Directory table. An argument given to the @kbd{info dos pte} command
20846 means display entries from a single Page Table, the one pointed to by
20847 the specified entry in the Page Directory.
20849 @cindex direct memory access (DMA) on MS-DOS
20850 These commands are useful when your program uses @dfn{DMA} (Direct
20851 Memory Access), which needs physical addresses to program the DMA
20854 These commands are supported only with some DPMI servers.
20856 @cindex physical address from linear address
20857 @item info dos address-pte @var{addr}
20858 This command displays the Page Table entry for a specified linear
20859 address. The argument @var{addr} is a linear address which should
20860 already have the appropriate segment's base address added to it,
20861 because this command accepts addresses which may belong to @emph{any}
20862 segment. For example, here's how to display the Page Table entry for
20863 the page where a variable @code{i} is stored:
20866 @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i}
20867 @exdent @code{Page Table entry for address 0x11a00d30:}
20868 @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30}
20872 This says that @code{i} is stored at offset @code{0xd30} from the page
20873 whose physical base address is @code{0x02698000}, and shows all the
20874 attributes of that page.
20876 Note that you must cast the addresses of variables to a @code{char *},
20877 since otherwise the value of @code{__djgpp_base_address}, the base
20878 address of all variables and functions in a @sc{djgpp} program, will
20879 be added using the rules of C pointer arithmetics: if @code{i} is
20880 declared an @code{int}, @value{GDBN} will add 4 times the value of
20881 @code{__djgpp_base_address} to the address of @code{i}.
20883 Here's another example, it displays the Page Table entry for the
20887 @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)}
20888 @exdent @code{Page Table entry for address 0x29110:}
20889 @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110}
20893 (The @code{+ 3} offset is because the transfer buffer's address is the
20894 3rd member of the @code{_go32_info_block} structure.) The output
20895 clearly shows that this DPMI server maps the addresses in conventional
20896 memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and
20897 linear (@code{0x29110}) addresses are identical.
20899 This command is supported only with some DPMI servers.
20902 @cindex DOS serial data link, remote debugging
20903 In addition to native debugging, the DJGPP port supports remote
20904 debugging via a serial data link. The following commands are specific
20905 to remote serial debugging in the DJGPP port of @value{GDBN}.
20908 @kindex set com1base
20909 @kindex set com1irq
20910 @kindex set com2base
20911 @kindex set com2irq
20912 @kindex set com3base
20913 @kindex set com3irq
20914 @kindex set com4base
20915 @kindex set com4irq
20916 @item set com1base @var{addr}
20917 This command sets the base I/O port address of the @file{COM1} serial
20920 @item set com1irq @var{irq}
20921 This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use
20922 for the @file{COM1} serial port.
20924 There are similar commands @samp{set com2base}, @samp{set com3irq},
20925 etc.@: for setting the port address and the @code{IRQ} lines for the
20928 @kindex show com1base
20929 @kindex show com1irq
20930 @kindex show com2base
20931 @kindex show com2irq
20932 @kindex show com3base
20933 @kindex show com3irq
20934 @kindex show com4base
20935 @kindex show com4irq
20936 The related commands @samp{show com1base}, @samp{show com1irq} etc.@:
20937 display the current settings of the base address and the @code{IRQ}
20938 lines used by the COM ports.
20941 @kindex info serial
20942 @cindex DOS serial port status
20943 This command prints the status of the 4 DOS serial ports. For each
20944 port, it prints whether it's active or not, its I/O base address and
20945 IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the
20946 counts of various errors encountered so far.
20950 @node Cygwin Native
20951 @subsection Features for Debugging MS Windows PE Executables
20952 @cindex MS Windows debugging
20953 @cindex native Cygwin debugging
20954 @cindex Cygwin-specific commands
20956 @value{GDBN} supports native debugging of MS Windows programs, including
20957 DLLs with and without symbolic debugging information.
20959 @cindex Ctrl-BREAK, MS-Windows
20960 @cindex interrupt debuggee on MS-Windows
20961 MS-Windows programs that call @code{SetConsoleMode} to switch off the
20962 special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted
20963 by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows
20964 supports @kbd{C-@key{BREAK}} as an alternative interrupt key
20965 sequence, which can be used to interrupt the debuggee even if it
20968 There are various additional Cygwin-specific commands, described in
20969 this section. Working with DLLs that have no debugging symbols is
20970 described in @ref{Non-debug DLL Symbols}.
20975 This is a prefix of MS Windows-specific commands which print
20976 information about the target system and important OS structures.
20978 @item info w32 selector
20979 This command displays information returned by
20980 the Win32 API @code{GetThreadSelectorEntry} function.
20981 It takes an optional argument that is evaluated to
20982 a long value to give the information about this given selector.
20983 Without argument, this command displays information
20984 about the six segment registers.
20986 @item info w32 thread-information-block
20987 This command displays thread specific information stored in the
20988 Thread Information Block (readable on the X86 CPU family using @code{$fs}
20989 selector for 32-bit programs and @code{$gs} for 64-bit programs).
20991 @kindex set cygwin-exceptions
20992 @cindex debugging the Cygwin DLL
20993 @cindex Cygwin DLL, debugging
20994 @item set cygwin-exceptions @var{mode}
20995 If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that
20996 happen inside the Cygwin DLL. If @var{mode} is @code{off},
20997 @value{GDBN} will delay recognition of exceptions, and may ignore some
20998 exceptions which seem to be caused by internal Cygwin DLL
20999 ``bookkeeping''. This option is meant primarily for debugging the
21000 Cygwin DLL itself; the default value is @code{off} to avoid annoying
21001 @value{GDBN} users with false @code{SIGSEGV} signals.
21003 @kindex show cygwin-exceptions
21004 @item show cygwin-exceptions
21005 Displays whether @value{GDBN} will break on exceptions that happen
21006 inside the Cygwin DLL itself.
21008 @kindex set new-console
21009 @item set new-console @var{mode}
21010 If @var{mode} is @code{on} the debuggee will
21011 be started in a new console on next start.
21012 If @var{mode} is @code{off}, the debuggee will
21013 be started in the same console as the debugger.
21015 @kindex show new-console
21016 @item show new-console
21017 Displays whether a new console is used
21018 when the debuggee is started.
21020 @kindex set new-group
21021 @item set new-group @var{mode}
21022 This boolean value controls whether the debuggee should
21023 start a new group or stay in the same group as the debugger.
21024 This affects the way the Windows OS handles
21027 @kindex show new-group
21028 @item show new-group
21029 Displays current value of new-group boolean.
21031 @kindex set debugevents
21032 @item set debugevents
21033 This boolean value adds debug output concerning kernel events related
21034 to the debuggee seen by the debugger. This includes events that
21035 signal thread and process creation and exit, DLL loading and
21036 unloading, console interrupts, and debugging messages produced by the
21037 Windows @code{OutputDebugString} API call.
21039 @kindex set debugexec
21040 @item set debugexec
21041 This boolean value adds debug output concerning execute events
21042 (such as resume thread) seen by the debugger.
21044 @kindex set debugexceptions
21045 @item set debugexceptions
21046 This boolean value adds debug output concerning exceptions in the
21047 debuggee seen by the debugger.
21049 @kindex set debugmemory
21050 @item set debugmemory
21051 This boolean value adds debug output concerning debuggee memory reads
21052 and writes by the debugger.
21056 This boolean values specifies whether the debuggee is called
21057 via a shell or directly (default value is on).
21061 Displays if the debuggee will be started with a shell.
21066 * Non-debug DLL Symbols:: Support for DLLs without debugging symbols
21069 @node Non-debug DLL Symbols
21070 @subsubsection Support for DLLs without Debugging Symbols
21071 @cindex DLLs with no debugging symbols
21072 @cindex Minimal symbols and DLLs
21074 Very often on windows, some of the DLLs that your program relies on do
21075 not include symbolic debugging information (for example,
21076 @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging
21077 symbols in a DLL, it relies on the minimal amount of symbolic
21078 information contained in the DLL's export table. This section
21079 describes working with such symbols, known internally to @value{GDBN} as
21080 ``minimal symbols''.
21082 Note that before the debugged program has started execution, no DLLs
21083 will have been loaded. The easiest way around this problem is simply to
21084 start the program --- either by setting a breakpoint or letting the
21085 program run once to completion.
21087 @subsubsection DLL Name Prefixes
21089 In keeping with the naming conventions used by the Microsoft debugging
21090 tools, DLL export symbols are made available with a prefix based on the
21091 DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is
21092 also entered into the symbol table, so @code{CreateFileA} is often
21093 sufficient. In some cases there will be name clashes within a program
21094 (particularly if the executable itself includes full debugging symbols)
21095 necessitating the use of the fully qualified name when referring to the
21096 contents of the DLL. Use single-quotes around the name to avoid the
21097 exclamation mark (``!'') being interpreted as a language operator.
21099 Note that the internal name of the DLL may be all upper-case, even
21100 though the file name of the DLL is lower-case, or vice-versa. Since
21101 symbols within @value{GDBN} are @emph{case-sensitive} this may cause
21102 some confusion. If in doubt, try the @code{info functions} and
21103 @code{info variables} commands or even @code{maint print msymbols}
21104 (@pxref{Symbols}). Here's an example:
21107 (@value{GDBP}) info function CreateFileA
21108 All functions matching regular expression "CreateFileA":
21110 Non-debugging symbols:
21111 0x77e885f4 CreateFileA
21112 0x77e885f4 KERNEL32!CreateFileA
21116 (@value{GDBP}) info function !
21117 All functions matching regular expression "!":
21119 Non-debugging symbols:
21120 0x6100114c cygwin1!__assert
21121 0x61004034 cygwin1!_dll_crt0@@0
21122 0x61004240 cygwin1!dll_crt0(per_process *)
21126 @subsubsection Working with Minimal Symbols
21128 Symbols extracted from a DLL's export table do not contain very much
21129 type information. All that @value{GDBN} can do is guess whether a symbol
21130 refers to a function or variable depending on the linker section that
21131 contains the symbol. Also note that the actual contents of the memory
21132 contained in a DLL are not available unless the program is running. This
21133 means that you cannot examine the contents of a variable or disassemble
21134 a function within a DLL without a running program.
21136 Variables are generally treated as pointers and dereferenced
21137 automatically. For this reason, it is often necessary to prefix a
21138 variable name with the address-of operator (``&'') and provide explicit
21139 type information in the command. Here's an example of the type of
21143 (@value{GDBP}) print 'cygwin1!__argv'
21148 (@value{GDBP}) x 'cygwin1!__argv'
21149 0x10021610: "\230y\""
21152 And two possible solutions:
21155 (@value{GDBP}) print ((char **)'cygwin1!__argv')[0]
21156 $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram"
21160 (@value{GDBP}) x/2x &'cygwin1!__argv'
21161 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000
21162 (@value{GDBP}) x/x 0x10021608
21163 0x10021608: 0x0022fd98
21164 (@value{GDBP}) x/s 0x0022fd98
21165 0x22fd98: "/cygdrive/c/mydirectory/myprogram"
21168 Setting a break point within a DLL is possible even before the program
21169 starts execution. However, under these circumstances, @value{GDBN} can't
21170 examine the initial instructions of the function in order to skip the
21171 function's frame set-up code. You can work around this by using ``*&''
21172 to set the breakpoint at a raw memory address:
21175 (@value{GDBP}) break *&'python22!PyOS_Readline'
21176 Breakpoint 1 at 0x1e04eff0
21179 The author of these extensions is not entirely convinced that setting a
21180 break point within a shared DLL like @file{kernel32.dll} is completely
21184 @subsection Commands Specific to @sc{gnu} Hurd Systems
21185 @cindex @sc{gnu} Hurd debugging
21187 This subsection describes @value{GDBN} commands specific to the
21188 @sc{gnu} Hurd native debugging.
21193 @kindex set signals@r{, Hurd command}
21194 @kindex set sigs@r{, Hurd command}
21195 This command toggles the state of inferior signal interception by
21196 @value{GDBN}. Mach exceptions, such as breakpoint traps, are not
21197 affected by this command. @code{sigs} is a shorthand alias for
21202 @kindex show signals@r{, Hurd command}
21203 @kindex show sigs@r{, Hurd command}
21204 Show the current state of intercepting inferior's signals.
21206 @item set signal-thread
21207 @itemx set sigthread
21208 @kindex set signal-thread
21209 @kindex set sigthread
21210 This command tells @value{GDBN} which thread is the @code{libc} signal
21211 thread. That thread is run when a signal is delivered to a running
21212 process. @code{set sigthread} is the shorthand alias of @code{set
21215 @item show signal-thread
21216 @itemx show sigthread
21217 @kindex show signal-thread
21218 @kindex show sigthread
21219 These two commands show which thread will run when the inferior is
21220 delivered a signal.
21223 @kindex set stopped@r{, Hurd command}
21224 This commands tells @value{GDBN} that the inferior process is stopped,
21225 as with the @code{SIGSTOP} signal. The stopped process can be
21226 continued by delivering a signal to it.
21229 @kindex show stopped@r{, Hurd command}
21230 This command shows whether @value{GDBN} thinks the debuggee is
21233 @item set exceptions
21234 @kindex set exceptions@r{, Hurd command}
21235 Use this command to turn off trapping of exceptions in the inferior.
21236 When exception trapping is off, neither breakpoints nor
21237 single-stepping will work. To restore the default, set exception
21240 @item show exceptions
21241 @kindex show exceptions@r{, Hurd command}
21242 Show the current state of trapping exceptions in the inferior.
21244 @item set task pause
21245 @kindex set task@r{, Hurd commands}
21246 @cindex task attributes (@sc{gnu} Hurd)
21247 @cindex pause current task (@sc{gnu} Hurd)
21248 This command toggles task suspension when @value{GDBN} has control.
21249 Setting it to on takes effect immediately, and the task is suspended
21250 whenever @value{GDBN} gets control. Setting it to off will take
21251 effect the next time the inferior is continued. If this option is set
21252 to off, you can use @code{set thread default pause on} or @code{set
21253 thread pause on} (see below) to pause individual threads.
21255 @item show task pause
21256 @kindex show task@r{, Hurd commands}
21257 Show the current state of task suspension.
21259 @item set task detach-suspend-count
21260 @cindex task suspend count
21261 @cindex detach from task, @sc{gnu} Hurd
21262 This command sets the suspend count the task will be left with when
21263 @value{GDBN} detaches from it.
21265 @item show task detach-suspend-count
21266 Show the suspend count the task will be left with when detaching.
21268 @item set task exception-port
21269 @itemx set task excp
21270 @cindex task exception port, @sc{gnu} Hurd
21271 This command sets the task exception port to which @value{GDBN} will
21272 forward exceptions. The argument should be the value of the @dfn{send
21273 rights} of the task. @code{set task excp} is a shorthand alias.
21275 @item set noninvasive
21276 @cindex noninvasive task options
21277 This command switches @value{GDBN} to a mode that is the least
21278 invasive as far as interfering with the inferior is concerned. This
21279 is the same as using @code{set task pause}, @code{set exceptions}, and
21280 @code{set signals} to values opposite to the defaults.
21282 @item info send-rights
21283 @itemx info receive-rights
21284 @itemx info port-rights
21285 @itemx info port-sets
21286 @itemx info dead-names
21289 @cindex send rights, @sc{gnu} Hurd
21290 @cindex receive rights, @sc{gnu} Hurd
21291 @cindex port rights, @sc{gnu} Hurd
21292 @cindex port sets, @sc{gnu} Hurd
21293 @cindex dead names, @sc{gnu} Hurd
21294 These commands display information about, respectively, send rights,
21295 receive rights, port rights, port sets, and dead names of a task.
21296 There are also shorthand aliases: @code{info ports} for @code{info
21297 port-rights} and @code{info psets} for @code{info port-sets}.
21299 @item set thread pause
21300 @kindex set thread@r{, Hurd command}
21301 @cindex thread properties, @sc{gnu} Hurd
21302 @cindex pause current thread (@sc{gnu} Hurd)
21303 This command toggles current thread suspension when @value{GDBN} has
21304 control. Setting it to on takes effect immediately, and the current
21305 thread is suspended whenever @value{GDBN} gets control. Setting it to
21306 off will take effect the next time the inferior is continued.
21307 Normally, this command has no effect, since when @value{GDBN} has
21308 control, the whole task is suspended. However, if you used @code{set
21309 task pause off} (see above), this command comes in handy to suspend
21310 only the current thread.
21312 @item show thread pause
21313 @kindex show thread@r{, Hurd command}
21314 This command shows the state of current thread suspension.
21316 @item set thread run
21317 This command sets whether the current thread is allowed to run.
21319 @item show thread run
21320 Show whether the current thread is allowed to run.
21322 @item set thread detach-suspend-count
21323 @cindex thread suspend count, @sc{gnu} Hurd
21324 @cindex detach from thread, @sc{gnu} Hurd
21325 This command sets the suspend count @value{GDBN} will leave on a
21326 thread when detaching. This number is relative to the suspend count
21327 found by @value{GDBN} when it notices the thread; use @code{set thread
21328 takeover-suspend-count} to force it to an absolute value.
21330 @item show thread detach-suspend-count
21331 Show the suspend count @value{GDBN} will leave on the thread when
21334 @item set thread exception-port
21335 @itemx set thread excp
21336 Set the thread exception port to which to forward exceptions. This
21337 overrides the port set by @code{set task exception-port} (see above).
21338 @code{set thread excp} is the shorthand alias.
21340 @item set thread takeover-suspend-count
21341 Normally, @value{GDBN}'s thread suspend counts are relative to the
21342 value @value{GDBN} finds when it notices each thread. This command
21343 changes the suspend counts to be absolute instead.
21345 @item set thread default
21346 @itemx show thread default
21347 @cindex thread default settings, @sc{gnu} Hurd
21348 Each of the above @code{set thread} commands has a @code{set thread
21349 default} counterpart (e.g., @code{set thread default pause}, @code{set
21350 thread default exception-port}, etc.). The @code{thread default}
21351 variety of commands sets the default thread properties for all
21352 threads; you can then change the properties of individual threads with
21353 the non-default commands.
21360 @value{GDBN} provides the following commands specific to the Darwin target:
21363 @item set debug darwin @var{num}
21364 @kindex set debug darwin
21365 When set to a non zero value, enables debugging messages specific to
21366 the Darwin support. Higher values produce more verbose output.
21368 @item show debug darwin
21369 @kindex show debug darwin
21370 Show the current state of Darwin messages.
21372 @item set debug mach-o @var{num}
21373 @kindex set debug mach-o
21374 When set to a non zero value, enables debugging messages while
21375 @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the
21376 file format used on Darwin for object and executable files.) Higher
21377 values produce more verbose output. This is a command to diagnose
21378 problems internal to @value{GDBN} and should not be needed in normal
21381 @item show debug mach-o
21382 @kindex show debug mach-o
21383 Show the current state of Mach-O file messages.
21385 @item set mach-exceptions on
21386 @itemx set mach-exceptions off
21387 @kindex set mach-exceptions
21388 On Darwin, faults are first reported as a Mach exception and are then
21389 mapped to a Posix signal. Use this command to turn on trapping of
21390 Mach exceptions in the inferior. This might be sometimes useful to
21391 better understand the cause of a fault. The default is off.
21393 @item show mach-exceptions
21394 @kindex show mach-exceptions
21395 Show the current state of exceptions trapping.
21400 @section Embedded Operating Systems
21402 This section describes configurations involving the debugging of
21403 embedded operating systems that are available for several different
21406 @value{GDBN} includes the ability to debug programs running on
21407 various real-time operating systems.
21409 @node Embedded Processors
21410 @section Embedded Processors
21412 This section goes into details specific to particular embedded
21415 @cindex send command to simulator
21416 Whenever a specific embedded processor has a simulator, @value{GDBN}
21417 allows to send an arbitrary command to the simulator.
21420 @item sim @var{command}
21421 @kindex sim@r{, a command}
21422 Send an arbitrary @var{command} string to the simulator. Consult the
21423 documentation for the specific simulator in use for information about
21424 acceptable commands.
21430 * M32R/SDI:: Renesas M32R/SDI
21431 * M68K:: Motorola M68K
21432 * MicroBlaze:: Xilinx MicroBlaze
21433 * MIPS Embedded:: MIPS Embedded
21434 * PowerPC Embedded:: PowerPC Embedded
21437 * Super-H:: Renesas Super-H
21443 @value{GDBN} provides the following ARM-specific commands:
21446 @item set arm disassembler
21448 This commands selects from a list of disassembly styles. The
21449 @code{"std"} style is the standard style.
21451 @item show arm disassembler
21453 Show the current disassembly style.
21455 @item set arm apcs32
21456 @cindex ARM 32-bit mode
21457 This command toggles ARM operation mode between 32-bit and 26-bit.
21459 @item show arm apcs32
21460 Display the current usage of the ARM 32-bit mode.
21462 @item set arm fpu @var{fputype}
21463 This command sets the ARM floating-point unit (FPU) type. The
21464 argument @var{fputype} can be one of these:
21468 Determine the FPU type by querying the OS ABI.
21470 Software FPU, with mixed-endian doubles on little-endian ARM
21473 GCC-compiled FPA co-processor.
21475 Software FPU with pure-endian doubles.
21481 Show the current type of the FPU.
21484 This command forces @value{GDBN} to use the specified ABI.
21487 Show the currently used ABI.
21489 @item set arm fallback-mode (arm|thumb|auto)
21490 @value{GDBN} uses the symbol table, when available, to determine
21491 whether instructions are ARM or Thumb. This command controls
21492 @value{GDBN}'s default behavior when the symbol table is not
21493 available. The default is @samp{auto}, which causes @value{GDBN} to
21494 use the current execution mode (from the @code{T} bit in the @code{CPSR}
21497 @item show arm fallback-mode
21498 Show the current fallback instruction mode.
21500 @item set arm force-mode (arm|thumb|auto)
21501 This command overrides use of the symbol table to determine whether
21502 instructions are ARM or Thumb. The default is @samp{auto}, which
21503 causes @value{GDBN} to use the symbol table and then the setting
21504 of @samp{set arm fallback-mode}.
21506 @item show arm force-mode
21507 Show the current forced instruction mode.
21509 @item set debug arm
21510 Toggle whether to display ARM-specific debugging messages from the ARM
21511 target support subsystem.
21513 @item show debug arm
21514 Show whether ARM-specific debugging messages are enabled.
21518 @item target sim @r{[}@var{simargs}@r{]} @dots{}
21519 The @value{GDBN} ARM simulator accepts the following optional arguments.
21522 @item --swi-support=@var{type}
21523 Tell the simulator which SWI interfaces to support. The argument
21524 @var{type} may be a comma separated list of the following values.
21525 The default value is @code{all}.
21538 @subsection Renesas M32R/SDI
21540 The following commands are available for M32R/SDI:
21545 @cindex reset SDI connection, M32R
21546 This command resets the SDI connection.
21550 This command shows the SDI connection status.
21553 @kindex debug_chaos
21554 @cindex M32R/Chaos debugging
21555 Instructs the remote that M32R/Chaos debugging is to be used.
21557 @item use_debug_dma
21558 @kindex use_debug_dma
21559 Instructs the remote to use the DEBUG_DMA method of accessing memory.
21562 @kindex use_mon_code
21563 Instructs the remote to use the MON_CODE method of accessing memory.
21566 @kindex use_ib_break
21567 Instructs the remote to set breakpoints by IB break.
21569 @item use_dbt_break
21570 @kindex use_dbt_break
21571 Instructs the remote to set breakpoints by DBT.
21577 The Motorola m68k configuration includes ColdFire support.
21580 @subsection MicroBlaze
21581 @cindex Xilinx MicroBlaze
21582 @cindex XMD, Xilinx Microprocessor Debugger
21584 The MicroBlaze is a soft-core processor supported on various Xilinx
21585 FPGAs, such as Spartan or Virtex series. Boards with these processors
21586 usually have JTAG ports which connect to a host system running the Xilinx
21587 Embedded Development Kit (EDK) or Software Development Kit (SDK).
21588 This host system is used to download the configuration bitstream to
21589 the target FPGA. The Xilinx Microprocessor Debugger (XMD) program
21590 communicates with the target board using the JTAG interface and
21591 presents a @code{gdbserver} interface to the board. By default
21592 @code{xmd} uses port @code{1234}. (While it is possible to change
21593 this default port, it requires the use of undocumented @code{xmd}
21594 commands. Contact Xilinx support if you need to do this.)
21596 Use these GDB commands to connect to the MicroBlaze target processor.
21599 @item target remote :1234
21600 Use this command to connect to the target if you are running @value{GDBN}
21601 on the same system as @code{xmd}.
21603 @item target remote @var{xmd-host}:1234
21604 Use this command to connect to the target if it is connected to @code{xmd}
21605 running on a different system named @var{xmd-host}.
21608 Use this command to download a program to the MicroBlaze target.
21610 @item set debug microblaze @var{n}
21611 Enable MicroBlaze-specific debugging messages if non-zero.
21613 @item show debug microblaze @var{n}
21614 Show MicroBlaze-specific debugging level.
21617 @node MIPS Embedded
21618 @subsection @acronym{MIPS} Embedded
21620 @cindex @acronym{MIPS} boards
21621 @value{GDBN} can use the @acronym{MIPS} remote debugging protocol to talk to a
21622 @acronym{MIPS} board attached to a serial line. This is available when
21623 you configure @value{GDBN} with @samp{--target=mips-elf}.
21626 Use these @value{GDBN} commands to specify the connection to your target board:
21629 @item target mips @var{port}
21630 @kindex target mips @var{port}
21631 To run a program on the board, start up @code{@value{GDBP}} with the
21632 name of your program as the argument. To connect to the board, use the
21633 command @samp{target mips @var{port}}, where @var{port} is the name of
21634 the serial port connected to the board. If the program has not already
21635 been downloaded to the board, you may use the @code{load} command to
21636 download it. You can then use all the usual @value{GDBN} commands.
21638 For example, this sequence connects to the target board through a serial
21639 port, and loads and runs a program called @var{prog} through the
21643 host$ @value{GDBP} @var{prog}
21644 @value{GDBN} is free software and @dots{}
21645 (@value{GDBP}) target mips /dev/ttyb
21646 (@value{GDBP}) load @var{prog}
21650 @item target mips @var{hostname}:@var{portnumber}
21651 On some @value{GDBN} host configurations, you can specify a TCP
21652 connection (for instance, to a serial line managed by a terminal
21653 concentrator) instead of a serial port, using the syntax
21654 @samp{@var{hostname}:@var{portnumber}}.
21656 @item target pmon @var{port}
21657 @kindex target pmon @var{port}
21660 @item target ddb @var{port}
21661 @kindex target ddb @var{port}
21662 NEC's DDB variant of PMON for Vr4300.
21664 @item target lsi @var{port}
21665 @kindex target lsi @var{port}
21666 LSI variant of PMON.
21672 @value{GDBN} also supports these special commands for @acronym{MIPS} targets:
21675 @item set mipsfpu double
21676 @itemx set mipsfpu single
21677 @itemx set mipsfpu none
21678 @itemx set mipsfpu auto
21679 @itemx show mipsfpu
21680 @kindex set mipsfpu
21681 @kindex show mipsfpu
21682 @cindex @acronym{MIPS} remote floating point
21683 @cindex floating point, @acronym{MIPS} remote
21684 If your target board does not support the @acronym{MIPS} floating point
21685 coprocessor, you should use the command @samp{set mipsfpu none} (if you
21686 need this, you may wish to put the command in your @value{GDBN} init
21687 file). This tells @value{GDBN} how to find the return value of
21688 functions which return floating point values. It also allows
21689 @value{GDBN} to avoid saving the floating point registers when calling
21690 functions on the board. If you are using a floating point coprocessor
21691 with only single precision floating point support, as on the @sc{r4650}
21692 processor, use the command @samp{set mipsfpu single}. The default
21693 double precision floating point coprocessor may be selected using
21694 @samp{set mipsfpu double}.
21696 In previous versions the only choices were double precision or no
21697 floating point, so @samp{set mipsfpu on} will select double precision
21698 and @samp{set mipsfpu off} will select no floating point.
21700 As usual, you can inquire about the @code{mipsfpu} variable with
21701 @samp{show mipsfpu}.
21703 @item set timeout @var{seconds}
21704 @itemx set retransmit-timeout @var{seconds}
21705 @itemx show timeout
21706 @itemx show retransmit-timeout
21707 @cindex @code{timeout}, @acronym{MIPS} protocol
21708 @cindex @code{retransmit-timeout}, @acronym{MIPS} protocol
21709 @kindex set timeout
21710 @kindex show timeout
21711 @kindex set retransmit-timeout
21712 @kindex show retransmit-timeout
21713 You can control the timeout used while waiting for a packet, in the @acronym{MIPS}
21714 remote protocol, with the @code{set timeout @var{seconds}} command. The
21715 default is 5 seconds. Similarly, you can control the timeout used while
21716 waiting for an acknowledgment of a packet with the @code{set
21717 retransmit-timeout @var{seconds}} command. The default is 3 seconds.
21718 You can inspect both values with @code{show timeout} and @code{show
21719 retransmit-timeout}. (These commands are @emph{only} available when
21720 @value{GDBN} is configured for @samp{--target=mips-elf}.)
21722 The timeout set by @code{set timeout} does not apply when @value{GDBN}
21723 is waiting for your program to stop. In that case, @value{GDBN} waits
21724 forever because it has no way of knowing how long the program is going
21725 to run before stopping.
21727 @item set syn-garbage-limit @var{num}
21728 @kindex set syn-garbage-limit@r{, @acronym{MIPS} remote}
21729 @cindex synchronize with remote @acronym{MIPS} target
21730 Limit the maximum number of characters @value{GDBN} should ignore when
21731 it tries to synchronize with the remote target. The default is 10
21732 characters. Setting the limit to -1 means there's no limit.
21734 @item show syn-garbage-limit
21735 @kindex show syn-garbage-limit@r{, @acronym{MIPS} remote}
21736 Show the current limit on the number of characters to ignore when
21737 trying to synchronize with the remote system.
21739 @item set monitor-prompt @var{prompt}
21740 @kindex set monitor-prompt@r{, @acronym{MIPS} remote}
21741 @cindex remote monitor prompt
21742 Tell @value{GDBN} to expect the specified @var{prompt} string from the
21743 remote monitor. The default depends on the target:
21753 @item show monitor-prompt
21754 @kindex show monitor-prompt@r{, @acronym{MIPS} remote}
21755 Show the current strings @value{GDBN} expects as the prompt from the
21758 @item set monitor-warnings
21759 @kindex set monitor-warnings@r{, @acronym{MIPS} remote}
21760 Enable or disable monitor warnings about hardware breakpoints. This
21761 has effect only for the @code{lsi} target. When on, @value{GDBN} will
21762 display warning messages whose codes are returned by the @code{lsi}
21763 PMON monitor for breakpoint commands.
21765 @item show monitor-warnings
21766 @kindex show monitor-warnings@r{, @acronym{MIPS} remote}
21767 Show the current setting of printing monitor warnings.
21769 @item pmon @var{command}
21770 @kindex pmon@r{, @acronym{MIPS} remote}
21771 @cindex send PMON command
21772 This command allows sending an arbitrary @var{command} string to the
21773 monitor. The monitor must be in debug mode for this to work.
21776 @node PowerPC Embedded
21777 @subsection PowerPC Embedded
21779 @cindex DVC register
21780 @value{GDBN} supports using the DVC (Data Value Compare) register to
21781 implement in hardware simple hardware watchpoint conditions of the form:
21784 (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \
21785 if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION}
21788 The DVC register will be automatically used when @value{GDBN} detects
21789 such pattern in a condition expression, and the created watchpoint uses one
21790 debug register (either the @code{exact-watchpoints} option is on and the
21791 variable is scalar, or the variable has a length of one byte). This feature
21792 is available in native @value{GDBN} running on a Linux kernel version 2.6.34
21795 When running on PowerPC embedded processors, @value{GDBN} automatically uses
21796 ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on,
21797 in which case watchpoints using only one debug register are created when
21798 watching variables of scalar types.
21800 You can create an artificial array to watch an arbitrary memory
21801 region using one of the following commands (@pxref{Expressions}):
21804 (@value{GDBP}) watch *((char *) @var{address})@@@var{length}
21805 (@value{GDBP}) watch @{char[@var{length}]@} @var{address}
21808 PowerPC embedded processors support masked watchpoints. See the discussion
21809 about the @code{mask} argument in @ref{Set Watchpoints}.
21811 @cindex ranged breakpoint
21812 PowerPC embedded processors support hardware accelerated
21813 @dfn{ranged breakpoints}. A ranged breakpoint stops execution of
21814 the inferior whenever it executes an instruction at any address within
21815 the range it specifies. To set a ranged breakpoint in @value{GDBN},
21816 use the @code{break-range} command.
21818 @value{GDBN} provides the following PowerPC-specific commands:
21821 @kindex break-range
21822 @item break-range @var{start-location}, @var{end-location}
21823 Set a breakpoint for an address range given by
21824 @var{start-location} and @var{end-location}, which can specify a function name,
21825 a line number, an offset of lines from the current line or from the start
21826 location, or an address of an instruction (see @ref{Specify Location},
21827 for a list of all the possible ways to specify a @var{location}.)
21828 The breakpoint will stop execution of the inferior whenever it
21829 executes an instruction at any address within the specified range,
21830 (including @var{start-location} and @var{end-location}.)
21832 @kindex set powerpc
21833 @item set powerpc soft-float
21834 @itemx show powerpc soft-float
21835 Force @value{GDBN} to use (or not use) a software floating point calling
21836 convention. By default, @value{GDBN} selects the calling convention based
21837 on the selected architecture and the provided executable file.
21839 @item set powerpc vector-abi
21840 @itemx show powerpc vector-abi
21841 Force @value{GDBN} to use the specified calling convention for vector
21842 arguments and return values. The valid options are @samp{auto};
21843 @samp{generic}, to avoid vector registers even if they are present;
21844 @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE
21845 registers. By default, @value{GDBN} selects the calling convention
21846 based on the selected architecture and the provided executable file.
21848 @item set powerpc exact-watchpoints
21849 @itemx show powerpc exact-watchpoints
21850 Allow @value{GDBN} to use only one debug register when watching a variable
21851 of scalar type, thus assuming that the variable is accessed through the
21852 address of its first byte.
21857 @subsection Atmel AVR
21860 When configured for debugging the Atmel AVR, @value{GDBN} supports the
21861 following AVR-specific commands:
21864 @item info io_registers
21865 @kindex info io_registers@r{, AVR}
21866 @cindex I/O registers (Atmel AVR)
21867 This command displays information about the AVR I/O registers. For
21868 each register, @value{GDBN} prints its number and value.
21875 When configured for debugging CRIS, @value{GDBN} provides the
21876 following CRIS-specific commands:
21879 @item set cris-version @var{ver}
21880 @cindex CRIS version
21881 Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
21882 The CRIS version affects register names and sizes. This command is useful in
21883 case autodetection of the CRIS version fails.
21885 @item show cris-version
21886 Show the current CRIS version.
21888 @item set cris-dwarf2-cfi
21889 @cindex DWARF-2 CFI and CRIS
21890 Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}.
21891 Change to @samp{off} when using @code{gcc-cris} whose version is below
21894 @item show cris-dwarf2-cfi
21895 Show the current state of using DWARF-2 CFI.
21897 @item set cris-mode @var{mode}
21899 Set the current CRIS mode to @var{mode}. It should only be changed when
21900 debugging in guru mode, in which case it should be set to
21901 @samp{guru} (the default is @samp{normal}).
21903 @item show cris-mode
21904 Show the current CRIS mode.
21908 @subsection Renesas Super-H
21911 For the Renesas Super-H processor, @value{GDBN} provides these
21915 @item set sh calling-convention @var{convention}
21916 @kindex set sh calling-convention
21917 Set the calling-convention used when calling functions from @value{GDBN}.
21918 Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}.
21919 With the @samp{gcc} setting, functions are called using the @value{NGCC} calling
21920 convention. If the DWARF-2 information of the called function specifies
21921 that the function follows the Renesas calling convention, the function
21922 is called using the Renesas calling convention. If the calling convention
21923 is set to @samp{renesas}, the Renesas calling convention is always used,
21924 regardless of the DWARF-2 information. This can be used to override the
21925 default of @samp{gcc} if debug information is missing, or the compiler
21926 does not emit the DWARF-2 calling convention entry for a function.
21928 @item show sh calling-convention
21929 @kindex show sh calling-convention
21930 Show the current calling convention setting.
21935 @node Architectures
21936 @section Architectures
21938 This section describes characteristics of architectures that affect
21939 all uses of @value{GDBN} with the architecture, both native and cross.
21946 * HPPA:: HP PA architecture
21947 * SPU:: Cell Broadband Engine SPU architecture
21953 @subsection AArch64
21954 @cindex AArch64 support
21956 When @value{GDBN} is debugging the AArch64 architecture, it provides the
21957 following special commands:
21960 @item set debug aarch64
21961 @kindex set debug aarch64
21962 This command determines whether AArch64 architecture-specific debugging
21963 messages are to be displayed.
21965 @item show debug aarch64
21966 Show whether AArch64 debugging messages are displayed.
21971 @subsection x86 Architecture-specific Issues
21974 @item set struct-convention @var{mode}
21975 @kindex set struct-convention
21976 @cindex struct return convention
21977 @cindex struct/union returned in registers
21978 Set the convention used by the inferior to return @code{struct}s and
21979 @code{union}s from functions to @var{mode}. Possible values of
21980 @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the
21981 default). @code{"default"} or @code{"pcc"} means that @code{struct}s
21982 are returned on the stack, while @code{"reg"} means that a
21983 @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will
21984 be returned in a register.
21986 @item show struct-convention
21987 @kindex show struct-convention
21988 Show the current setting of the convention to return @code{struct}s
21993 @subsubsection Intel(R) @dfn{Memory Protection Extensions} (MPX).
21994 @cindex Intel(R) Memory Protection Extensions (MPX).
21996 Memory Protection Extension (MPX) adds the bound registers @samp{BND0}
21997 @footnote{The register named with capital letters represent the architecture
21998 registers.} through @samp{BND3}. Bound registers store a pair of 64-bit values
21999 which are the lower bound and upper bound. Bounds are effective addresses or
22000 memory locations. The upper bounds are architecturally represented in 1's
22001 complement form. A bound having lower bound = 0, and upper bound = 0
22002 (1's complement of all bits set) will allow access to the entire address space.
22004 @samp{BND0} through @samp{BND3} are represented in @value{GDBN} as @samp{bnd0raw}
22005 through @samp{bnd3raw}. Pseudo registers @samp{bnd0} through @samp{bnd3}
22006 display the upper bound performing the complement of one operation on the
22007 upper bound value, i.e.@ when upper bound in @samp{bnd0raw} is 0 in the
22008 @value{GDBN} @samp{bnd0} it will be @code{0xfff@dots{}}. In this sense it
22009 can also be noted that the upper bounds are inclusive.
22011 As an example, assume that the register BND0 holds bounds for a pointer having
22012 access allowed for the range between 0x32 and 0x71. The values present on
22013 bnd0raw and bnd registers are presented as follows:
22016 bnd0raw = @{0x32, 0xffffffff8e@}
22017 bnd0 = @{lbound = 0x32, ubound = 0x71@} : size 64
22020 This way the raw value can be accessed via bnd0raw@dots{}bnd3raw. Any
22021 change on bnd0@dots{}bnd3 or bnd0raw@dots{}bnd3raw is reflect on its
22022 counterpart. When the bnd0@dots{}bnd3 registers are displayed via
22023 Python, the display includes the memory size, in bits, accessible to
22026 Bounds can also be stored in bounds tables, which are stored in
22027 application memory. These tables store bounds for pointers by specifying
22028 the bounds pointer's value along with its bounds. Evaluating and changing
22029 bounds located in bound tables is therefore interesting while investigating
22030 bugs on MPX context. @value{GDBN} provides commands for this purpose:
22033 @item show mpx bound @var{pointer}
22034 @kindex show mpx bound
22035 Display bounds of the given @var{pointer}.
22037 @item set mpx bound @var{pointer}, @var{lbound}, @var{ubound}
22038 @kindex set mpx bound
22039 Set the bounds of a pointer in the bound table.
22040 This command takes three parameters: @var{pointer} is the pointers
22041 whose bounds are to be changed, @var{lbound} and @var{ubound} are new values
22042 for lower and upper bounds respectively.
22048 See the following section.
22051 @subsection @acronym{MIPS}
22053 @cindex stack on Alpha
22054 @cindex stack on @acronym{MIPS}
22055 @cindex Alpha stack
22056 @cindex @acronym{MIPS} stack
22057 Alpha- and @acronym{MIPS}-based computers use an unusual stack frame, which
22058 sometimes requires @value{GDBN} to search backward in the object code to
22059 find the beginning of a function.
22061 @cindex response time, @acronym{MIPS} debugging
22062 To improve response time (especially for embedded applications, where
22063 @value{GDBN} may be restricted to a slow serial line for this search)
22064 you may want to limit the size of this search, using one of these
22068 @cindex @code{heuristic-fence-post} (Alpha, @acronym{MIPS})
22069 @item set heuristic-fence-post @var{limit}
22070 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
22071 search for the beginning of a function. A value of @var{0} (the
22072 default) means there is no limit. However, except for @var{0}, the
22073 larger the limit the more bytes @code{heuristic-fence-post} must search
22074 and therefore the longer it takes to run. You should only need to use
22075 this command when debugging a stripped executable.
22077 @item show heuristic-fence-post
22078 Display the current limit.
22082 These commands are available @emph{only} when @value{GDBN} is configured
22083 for debugging programs on Alpha or @acronym{MIPS} processors.
22085 Several @acronym{MIPS}-specific commands are available when debugging @acronym{MIPS}
22089 @item set mips abi @var{arg}
22090 @kindex set mips abi
22091 @cindex set ABI for @acronym{MIPS}
22092 Tell @value{GDBN} which @acronym{MIPS} ABI is used by the inferior. Possible
22093 values of @var{arg} are:
22097 The default ABI associated with the current binary (this is the
22107 @item show mips abi
22108 @kindex show mips abi
22109 Show the @acronym{MIPS} ABI used by @value{GDBN} to debug the inferior.
22111 @item set mips compression @var{arg}
22112 @kindex set mips compression
22113 @cindex code compression, @acronym{MIPS}
22114 Tell @value{GDBN} which @acronym{MIPS} compressed
22115 @acronym{ISA, Instruction Set Architecture} encoding is used by the
22116 inferior. @value{GDBN} uses this for code disassembly and other
22117 internal interpretation purposes. This setting is only referred to
22118 when no executable has been associated with the debugging session or
22119 the executable does not provide information about the encoding it uses.
22120 Otherwise this setting is automatically updated from information
22121 provided by the executable.
22123 Possible values of @var{arg} are @samp{mips16} and @samp{micromips}.
22124 The default compressed @acronym{ISA} encoding is @samp{mips16}, as
22125 executables containing @acronym{MIPS16} code frequently are not
22126 identified as such.
22128 This setting is ``sticky''; that is, it retains its value across
22129 debugging sessions until reset either explicitly with this command or
22130 implicitly from an executable.
22132 The compiler and/or assembler typically add symbol table annotations to
22133 identify functions compiled for the @acronym{MIPS16} or
22134 @acronym{microMIPS} @acronym{ISA}s. If these function-scope annotations
22135 are present, @value{GDBN} uses them in preference to the global
22136 compressed @acronym{ISA} encoding setting.
22138 @item show mips compression
22139 @kindex show mips compression
22140 Show the @acronym{MIPS} compressed @acronym{ISA} encoding used by
22141 @value{GDBN} to debug the inferior.
22144 @itemx show mipsfpu
22145 @xref{MIPS Embedded, set mipsfpu}.
22147 @item set mips mask-address @var{arg}
22148 @kindex set mips mask-address
22149 @cindex @acronym{MIPS} addresses, masking
22150 This command determines whether the most-significant 32 bits of 64-bit
22151 @acronym{MIPS} addresses are masked off. The argument @var{arg} can be
22152 @samp{on}, @samp{off}, or @samp{auto}. The latter is the default
22153 setting, which lets @value{GDBN} determine the correct value.
22155 @item show mips mask-address
22156 @kindex show mips mask-address
22157 Show whether the upper 32 bits of @acronym{MIPS} addresses are masked off or
22160 @item set remote-mips64-transfers-32bit-regs
22161 @kindex set remote-mips64-transfers-32bit-regs
22162 This command controls compatibility with 64-bit @acronym{MIPS} targets that
22163 transfer data in 32-bit quantities. If you have an old @acronym{MIPS} 64 target
22164 that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr},
22165 and 64 bits for other registers, set this option to @samp{on}.
22167 @item show remote-mips64-transfers-32bit-regs
22168 @kindex show remote-mips64-transfers-32bit-regs
22169 Show the current setting of compatibility with older @acronym{MIPS} 64 targets.
22171 @item set debug mips
22172 @kindex set debug mips
22173 This command turns on and off debugging messages for the @acronym{MIPS}-specific
22174 target code in @value{GDBN}.
22176 @item show debug mips
22177 @kindex show debug mips
22178 Show the current setting of @acronym{MIPS} debugging messages.
22184 @cindex HPPA support
22186 When @value{GDBN} is debugging the HP PA architecture, it provides the
22187 following special commands:
22190 @item set debug hppa
22191 @kindex set debug hppa
22192 This command determines whether HPPA architecture-specific debugging
22193 messages are to be displayed.
22195 @item show debug hppa
22196 Show whether HPPA debugging messages are displayed.
22198 @item maint print unwind @var{address}
22199 @kindex maint print unwind@r{, HPPA}
22200 This command displays the contents of the unwind table entry at the
22201 given @var{address}.
22207 @subsection Cell Broadband Engine SPU architecture
22208 @cindex Cell Broadband Engine
22211 When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture,
22212 it provides the following special commands:
22215 @item info spu event
22217 Display SPU event facility status. Shows current event mask
22218 and pending event status.
22220 @item info spu signal
22221 Display SPU signal notification facility status. Shows pending
22222 signal-control word and signal notification mode of both signal
22223 notification channels.
22225 @item info spu mailbox
22226 Display SPU mailbox facility status. Shows all pending entries,
22227 in order of processing, in each of the SPU Write Outbound,
22228 SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes.
22231 Display MFC DMA status. Shows all pending commands in the MFC
22232 DMA queue. For each entry, opcode, tag, class IDs, effective
22233 and local store addresses and transfer size are shown.
22235 @item info spu proxydma
22236 Display MFC Proxy-DMA status. Shows all pending commands in the MFC
22237 Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective
22238 and local store addresses and transfer size are shown.
22242 When @value{GDBN} is debugging a combined PowerPC/SPU application
22243 on the Cell Broadband Engine, it provides in addition the following
22247 @item set spu stop-on-load @var{arg}
22249 Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN}
22250 will give control to the user when a new SPE thread enters its @code{main}
22251 function. The default is @code{off}.
22253 @item show spu stop-on-load
22255 Show whether to stop for new SPE threads.
22257 @item set spu auto-flush-cache @var{arg}
22258 Set whether to automatically flush the software-managed cache. When set to
22259 @code{on}, @value{GDBN} will automatically cause the SPE software-managed
22260 cache to be flushed whenever SPE execution stops. This provides a consistent
22261 view of PowerPC memory that is accessed via the cache. If an application
22262 does not use the software-managed cache, this option has no effect.
22264 @item show spu auto-flush-cache
22265 Show whether to automatically flush the software-managed cache.
22270 @subsection PowerPC
22271 @cindex PowerPC architecture
22273 When @value{GDBN} is debugging the PowerPC architecture, it provides a set of
22274 pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point
22275 numbers stored in the floating point registers. These values must be stored
22276 in two consecutive registers, always starting at an even register like
22277 @code{f0} or @code{f2}.
22279 The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed
22280 by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0},
22281 @code{f2} and @code{f3} for @code{$dl1} and so on.
22283 For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit
22284 wide Extended Floating Point Registers (@samp{f32} through @samp{f63}).
22287 @subsection Nios II
22288 @cindex Nios II architecture
22290 When @value{GDBN} is debugging the Nios II architecture,
22291 it provides the following special commands:
22295 @item set debug nios2
22296 @kindex set debug nios2
22297 This command turns on and off debugging messages for the Nios II
22298 target code in @value{GDBN}.
22300 @item show debug nios2
22301 @kindex show debug nios2
22302 Show the current setting of Nios II debugging messages.
22305 @node Controlling GDB
22306 @chapter Controlling @value{GDBN}
22308 You can alter the way @value{GDBN} interacts with you by using the
22309 @code{set} command. For commands controlling how @value{GDBN} displays
22310 data, see @ref{Print Settings, ,Print Settings}. Other settings are
22315 * Editing:: Command editing
22316 * Command History:: Command history
22317 * Screen Size:: Screen size
22318 * Numbers:: Numbers
22319 * ABI:: Configuring the current ABI
22320 * Auto-loading:: Automatically loading associated files
22321 * Messages/Warnings:: Optional warnings and messages
22322 * Debugging Output:: Optional messages about internal happenings
22323 * Other Misc Settings:: Other Miscellaneous Settings
22331 @value{GDBN} indicates its readiness to read a command by printing a string
22332 called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You
22333 can change the prompt string with the @code{set prompt} command. For
22334 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
22335 the prompt in one of the @value{GDBN} sessions so that you can always tell
22336 which one you are talking to.
22338 @emph{Note:} @code{set prompt} does not add a space for you after the
22339 prompt you set. This allows you to set a prompt which ends in a space
22340 or a prompt that does not.
22344 @item set prompt @var{newprompt}
22345 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
22347 @kindex show prompt
22349 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
22352 Versions of @value{GDBN} that ship with Python scripting enabled have
22353 prompt extensions. The commands for interacting with these extensions
22357 @kindex set extended-prompt
22358 @item set extended-prompt @var{prompt}
22359 Set an extended prompt that allows for substitutions.
22360 @xref{gdb.prompt}, for a list of escape sequences that can be used for
22361 substitution. Any escape sequences specified as part of the prompt
22362 string are replaced with the corresponding strings each time the prompt
22368 set extended-prompt Current working directory: \w (gdb)
22371 Note that when an extended-prompt is set, it takes control of the
22372 @var{prompt_hook} hook. @xref{prompt_hook}, for further information.
22374 @kindex show extended-prompt
22375 @item show extended-prompt
22376 Prints the extended prompt. Any escape sequences specified as part of
22377 the prompt string with @code{set extended-prompt}, are replaced with the
22378 corresponding strings each time the prompt is displayed.
22382 @section Command Editing
22384 @cindex command line editing
22386 @value{GDBN} reads its input commands via the @dfn{Readline} interface. This
22387 @sc{gnu} library provides consistent behavior for programs which provide a
22388 command line interface to the user. Advantages are @sc{gnu} Emacs-style
22389 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
22390 substitution, and a storage and recall of command history across
22391 debugging sessions.
22393 You may control the behavior of command line editing in @value{GDBN} with the
22394 command @code{set}.
22397 @kindex set editing
22400 @itemx set editing on
22401 Enable command line editing (enabled by default).
22403 @item set editing off
22404 Disable command line editing.
22406 @kindex show editing
22408 Show whether command line editing is enabled.
22411 @ifset SYSTEM_READLINE
22412 @xref{Command Line Editing, , , rluserman, GNU Readline Library},
22414 @ifclear SYSTEM_READLINE
22415 @xref{Command Line Editing},
22417 for more details about the Readline
22418 interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are
22419 encouraged to read that chapter.
22421 @node Command History
22422 @section Command History
22423 @cindex command history
22425 @value{GDBN} can keep track of the commands you type during your
22426 debugging sessions, so that you can be certain of precisely what
22427 happened. Use these commands to manage the @value{GDBN} command
22430 @value{GDBN} uses the @sc{gnu} History library, a part of the Readline
22431 package, to provide the history facility.
22432 @ifset SYSTEM_READLINE
22433 @xref{Using History Interactively, , , history, GNU History Library},
22435 @ifclear SYSTEM_READLINE
22436 @xref{Using History Interactively},
22438 for the detailed description of the History library.
22440 To issue a command to @value{GDBN} without affecting certain aspects of
22441 the state which is seen by users, prefix it with @samp{server }
22442 (@pxref{Server Prefix}). This
22443 means that this command will not affect the command history, nor will it
22444 affect @value{GDBN}'s notion of which command to repeat if @key{RET} is
22445 pressed on a line by itself.
22447 @cindex @code{server}, command prefix
22448 The server prefix does not affect the recording of values into the value
22449 history; to print a value without recording it into the value history,
22450 use the @code{output} command instead of the @code{print} command.
22452 Here is the description of @value{GDBN} commands related to command
22456 @cindex history substitution
22457 @cindex history file
22458 @kindex set history filename
22459 @cindex @env{GDBHISTFILE}, environment variable
22460 @item set history filename @var{fname}
22461 Set the name of the @value{GDBN} command history file to @var{fname}.
22462 This is the file where @value{GDBN} reads an initial command history
22463 list, and where it writes the command history from this session when it
22464 exits. You can access this list through history expansion or through
22465 the history command editing characters listed below. This file defaults
22466 to the value of the environment variable @code{GDBHISTFILE}, or to
22467 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
22470 @cindex save command history
22471 @kindex set history save
22472 @item set history save
22473 @itemx set history save on
22474 Record command history in a file, whose name may be specified with the
22475 @code{set history filename} command. By default, this option is disabled.
22477 @item set history save off
22478 Stop recording command history in a file.
22480 @cindex history size
22481 @kindex set history size
22482 @cindex @env{GDBHISTSIZE}, environment variable
22483 @item set history size @var{size}
22484 @itemx set history size unlimited
22485 Set the number of commands which @value{GDBN} keeps in its history list.
22486 This defaults to the value of the environment variable @env{GDBHISTSIZE}, or
22487 to 256 if this variable is not set. Non-numeric values of @env{GDBHISTSIZE}
22488 are ignored. If @var{size} is @code{unlimited} or if @env{GDBHISTSIZE} is
22489 either a negative number or the empty string, then the number of commands
22490 @value{GDBN} keeps in the history list is unlimited.
22492 @cindex remove duplicate history
22493 @kindex set history remove-duplicates
22494 @item set history remove-duplicates @var{count}
22495 @itemx set history remove-duplicates unlimited
22496 Control the removal of duplicate history entries in the command history list.
22497 If @var{count} is non-zero, @value{GDBN} will look back at the last @var{count}
22498 history entries and remove the first entry that is a duplicate of the current
22499 entry being added to the command history list. If @var{count} is
22500 @code{unlimited} then this lookbehind is unbounded. If @var{count} is 0, then
22501 removal of duplicate history entries is disabled.
22503 Only history entries added during the current session are considered for
22504 removal. This option is set to 0 by default.
22508 History expansion assigns special meaning to the character @kbd{!}.
22509 @ifset SYSTEM_READLINE
22510 @xref{Event Designators, , , history, GNU History Library},
22512 @ifclear SYSTEM_READLINE
22513 @xref{Event Designators},
22517 @cindex history expansion, turn on/off
22518 Since @kbd{!} is also the logical not operator in C, history expansion
22519 is off by default. If you decide to enable history expansion with the
22520 @code{set history expansion on} command, you may sometimes need to
22521 follow @kbd{!} (when it is used as logical not, in an expression) with
22522 a space or a tab to prevent it from being expanded. The readline
22523 history facilities do not attempt substitution on the strings
22524 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
22526 The commands to control history expansion are:
22529 @item set history expansion on
22530 @itemx set history expansion
22531 @kindex set history expansion
22532 Enable history expansion. History expansion is off by default.
22534 @item set history expansion off
22535 Disable history expansion.
22538 @kindex show history
22540 @itemx show history filename
22541 @itemx show history save
22542 @itemx show history size
22543 @itemx show history expansion
22544 These commands display the state of the @value{GDBN} history parameters.
22545 @code{show history} by itself displays all four states.
22550 @kindex show commands
22551 @cindex show last commands
22552 @cindex display command history
22553 @item show commands
22554 Display the last ten commands in the command history.
22556 @item show commands @var{n}
22557 Print ten commands centered on command number @var{n}.
22559 @item show commands +
22560 Print ten commands just after the commands last printed.
22564 @section Screen Size
22565 @cindex size of screen
22566 @cindex screen size
22569 @cindex pauses in output
22571 Certain commands to @value{GDBN} may produce large amounts of
22572 information output to the screen. To help you read all of it,
22573 @value{GDBN} pauses and asks you for input at the end of each page of
22574 output. Type @key{RET} when you want to continue the output, or @kbd{q}
22575 to discard the remaining output. Also, the screen width setting
22576 determines when to wrap lines of output. Depending on what is being
22577 printed, @value{GDBN} tries to break the line at a readable place,
22578 rather than simply letting it overflow onto the following line.
22580 Normally @value{GDBN} knows the size of the screen from the terminal
22581 driver software. For example, on Unix @value{GDBN} uses the termcap data base
22582 together with the value of the @code{TERM} environment variable and the
22583 @code{stty rows} and @code{stty cols} settings. If this is not correct,
22584 you can override it with the @code{set height} and @code{set
22591 @kindex show height
22592 @item set height @var{lpp}
22593 @itemx set height unlimited
22595 @itemx set width @var{cpl}
22596 @itemx set width unlimited
22598 These @code{set} commands specify a screen height of @var{lpp} lines and
22599 a screen width of @var{cpl} characters. The associated @code{show}
22600 commands display the current settings.
22602 If you specify a height of either @code{unlimited} or zero lines,
22603 @value{GDBN} does not pause during output no matter how long the
22604 output is. This is useful if output is to a file or to an editor
22607 Likewise, you can specify @samp{set width unlimited} or @samp{set
22608 width 0} to prevent @value{GDBN} from wrapping its output.
22610 @item set pagination on
22611 @itemx set pagination off
22612 @kindex set pagination
22613 Turn the output pagination on or off; the default is on. Turning
22614 pagination off is the alternative to @code{set height unlimited}. Note that
22615 running @value{GDBN} with the @option{--batch} option (@pxref{Mode
22616 Options, -batch}) also automatically disables pagination.
22618 @item show pagination
22619 @kindex show pagination
22620 Show the current pagination mode.
22625 @cindex number representation
22626 @cindex entering numbers
22628 You can always enter numbers in octal, decimal, or hexadecimal in
22629 @value{GDBN} by the usual conventions: octal numbers begin with
22630 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
22631 begin with @samp{0x}. Numbers that neither begin with @samp{0} or
22632 @samp{0x}, nor end with a @samp{.} are, by default, entered in base
22633 10; likewise, the default display for numbers---when no particular
22634 format is specified---is base 10. You can change the default base for
22635 both input and output with the commands described below.
22638 @kindex set input-radix
22639 @item set input-radix @var{base}
22640 Set the default base for numeric input. Supported choices
22641 for @var{base} are decimal 8, 10, or 16. The base must itself be
22642 specified either unambiguously or using the current input radix; for
22646 set input-radix 012
22647 set input-radix 10.
22648 set input-radix 0xa
22652 sets the input base to decimal. On the other hand, @samp{set input-radix 10}
22653 leaves the input radix unchanged, no matter what it was, since
22654 @samp{10}, being without any leading or trailing signs of its base, is
22655 interpreted in the current radix. Thus, if the current radix is 16,
22656 @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't
22659 @kindex set output-radix
22660 @item set output-radix @var{base}
22661 Set the default base for numeric display. Supported choices
22662 for @var{base} are decimal 8, 10, or 16. The base must itself be
22663 specified either unambiguously or using the current input radix.
22665 @kindex show input-radix
22666 @item show input-radix
22667 Display the current default base for numeric input.
22669 @kindex show output-radix
22670 @item show output-radix
22671 Display the current default base for numeric display.
22673 @item set radix @r{[}@var{base}@r{]}
22677 These commands set and show the default base for both input and output
22678 of numbers. @code{set radix} sets the radix of input and output to
22679 the same base; without an argument, it resets the radix back to its
22680 default value of 10.
22685 @section Configuring the Current ABI
22687 @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your
22688 application automatically. However, sometimes you need to override its
22689 conclusions. Use these commands to manage @value{GDBN}'s view of the
22695 @cindex Newlib OS ABI and its influence on the longjmp handling
22697 One @value{GDBN} configuration can debug binaries for multiple operating
22698 system targets, either via remote debugging or native emulation.
22699 @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use,
22700 but you can override its conclusion using the @code{set osabi} command.
22701 One example where this is useful is in debugging of binaries which use
22702 an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does
22703 not have the same identifying marks that the standard C library for your
22706 When @value{GDBN} is debugging the AArch64 architecture, it provides a
22707 ``Newlib'' OS ABI. This is useful for handling @code{setjmp} and
22708 @code{longjmp} when debugging binaries that use the @sc{newlib} C library.
22709 The ``Newlib'' OS ABI can be selected by @code{set osabi Newlib}.
22713 Show the OS ABI currently in use.
22716 With no argument, show the list of registered available OS ABI's.
22718 @item set osabi @var{abi}
22719 Set the current OS ABI to @var{abi}.
22722 @cindex float promotion
22724 Generally, the way that an argument of type @code{float} is passed to a
22725 function depends on whether the function is prototyped. For a prototyped
22726 (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged,
22727 according to the architecture's convention for @code{float}. For unprototyped
22728 (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type
22729 @code{double} and then passed.
22731 Unfortunately, some forms of debug information do not reliably indicate whether
22732 a function is prototyped. If @value{GDBN} calls a function that is not marked
22733 as prototyped, it consults @kbd{set coerce-float-to-double}.
22736 @kindex set coerce-float-to-double
22737 @item set coerce-float-to-double
22738 @itemx set coerce-float-to-double on
22739 Arguments of type @code{float} will be promoted to @code{double} when passed
22740 to an unprototyped function. This is the default setting.
22742 @item set coerce-float-to-double off
22743 Arguments of type @code{float} will be passed directly to unprototyped
22746 @kindex show coerce-float-to-double
22747 @item show coerce-float-to-double
22748 Show the current setting of promoting @code{float} to @code{double}.
22752 @kindex show cp-abi
22753 @value{GDBN} needs to know the ABI used for your program's C@t{++}
22754 objects. The correct C@t{++} ABI depends on which C@t{++} compiler was
22755 used to build your application. @value{GDBN} only fully supports
22756 programs with a single C@t{++} ABI; if your program contains code using
22757 multiple C@t{++} ABI's or if @value{GDBN} can not identify your
22758 program's ABI correctly, you can tell @value{GDBN} which ABI to use.
22759 Currently supported ABI's include ``gnu-v2'', for @code{g++} versions
22760 before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and
22761 ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may
22762 use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is
22767 Show the C@t{++} ABI currently in use.
22770 With no argument, show the list of supported C@t{++} ABI's.
22772 @item set cp-abi @var{abi}
22773 @itemx set cp-abi auto
22774 Set the current C@t{++} ABI to @var{abi}, or return to automatic detection.
22778 @section Automatically loading associated files
22779 @cindex auto-loading
22781 @value{GDBN} sometimes reads files with commands and settings automatically,
22782 without being explicitly told so by the user. We call this feature
22783 @dfn{auto-loading}. While auto-loading is useful for automatically adapting
22784 @value{GDBN} to the needs of your project, it can sometimes produce unexpected
22785 results or introduce security risks (e.g., if the file comes from untrusted
22789 * Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
22790 * libthread_db.so.1 file:: @samp{set/show/info auto-load libthread-db}
22792 * Auto-loading safe path:: @samp{set/show/info auto-load safe-path}
22793 * Auto-loading verbose mode:: @samp{set/show debug auto-load}
22796 There are various kinds of files @value{GDBN} can automatically load.
22797 In addition to these files, @value{GDBN} supports auto-loading code written
22798 in various extension languages. @xref{Auto-loading extensions}.
22800 Note that loading of these associated files (including the local @file{.gdbinit}
22801 file) requires accordingly configured @code{auto-load safe-path}
22802 (@pxref{Auto-loading safe path}).
22804 For these reasons, @value{GDBN} includes commands and options to let you
22805 control when to auto-load files and which files should be auto-loaded.
22808 @anchor{set auto-load off}
22809 @kindex set auto-load off
22810 @item set auto-load off
22811 Globally disable loading of all auto-loaded files.
22812 You may want to use this command with the @samp{-iex} option
22813 (@pxref{Option -init-eval-command}) such as:
22815 $ @kbd{gdb -iex "set auto-load off" untrusted-executable corefile}
22818 Be aware that system init file (@pxref{System-wide configuration})
22819 and init files from your home directory (@pxref{Home Directory Init File})
22820 still get read (as they come from generally trusted directories).
22821 To prevent @value{GDBN} from auto-loading even those init files, use the
22822 @option{-nx} option (@pxref{Mode Options}), in addition to
22823 @code{set auto-load no}.
22825 @anchor{show auto-load}
22826 @kindex show auto-load
22827 @item show auto-load
22828 Show whether auto-loading of each specific @samp{auto-load} file(s) is enabled
22832 (gdb) show auto-load
22833 gdb-scripts: Auto-loading of canned sequences of commands scripts is on.
22834 libthread-db: Auto-loading of inferior specific libthread_db is on.
22835 local-gdbinit: Auto-loading of .gdbinit script from current directory
22837 python-scripts: Auto-loading of Python scripts is on.
22838 safe-path: List of directories from which it is safe to auto-load files
22839 is $debugdir:$datadir/auto-load.
22840 scripts-directory: List of directories from which to load auto-loaded scripts
22841 is $debugdir:$datadir/auto-load.
22844 @anchor{info auto-load}
22845 @kindex info auto-load
22846 @item info auto-load
22847 Print whether each specific @samp{auto-load} file(s) have been auto-loaded or
22851 (gdb) info auto-load
22854 Yes /home/user/gdb/gdb-gdb.gdb
22855 libthread-db: No auto-loaded libthread-db.
22856 local-gdbinit: Local .gdbinit file "/home/user/gdb/.gdbinit" has been
22860 Yes /home/user/gdb/gdb-gdb.py
22864 These are @value{GDBN} control commands for the auto-loading:
22866 @multitable @columnfractions .5 .5
22867 @item @xref{set auto-load off}.
22868 @tab Disable auto-loading globally.
22869 @item @xref{show auto-load}.
22870 @tab Show setting of all kinds of files.
22871 @item @xref{info auto-load}.
22872 @tab Show state of all kinds of files.
22873 @item @xref{set auto-load gdb-scripts}.
22874 @tab Control for @value{GDBN} command scripts.
22875 @item @xref{show auto-load gdb-scripts}.
22876 @tab Show setting of @value{GDBN} command scripts.
22877 @item @xref{info auto-load gdb-scripts}.
22878 @tab Show state of @value{GDBN} command scripts.
22879 @item @xref{set auto-load python-scripts}.
22880 @tab Control for @value{GDBN} Python scripts.
22881 @item @xref{show auto-load python-scripts}.
22882 @tab Show setting of @value{GDBN} Python scripts.
22883 @item @xref{info auto-load python-scripts}.
22884 @tab Show state of @value{GDBN} Python scripts.
22885 @item @xref{set auto-load guile-scripts}.
22886 @tab Control for @value{GDBN} Guile scripts.
22887 @item @xref{show auto-load guile-scripts}.
22888 @tab Show setting of @value{GDBN} Guile scripts.
22889 @item @xref{info auto-load guile-scripts}.
22890 @tab Show state of @value{GDBN} Guile scripts.
22891 @item @xref{set auto-load scripts-directory}.
22892 @tab Control for @value{GDBN} auto-loaded scripts location.
22893 @item @xref{show auto-load scripts-directory}.
22894 @tab Show @value{GDBN} auto-loaded scripts location.
22895 @item @xref{add-auto-load-scripts-directory}.
22896 @tab Add directory for auto-loaded scripts location list.
22897 @item @xref{set auto-load local-gdbinit}.
22898 @tab Control for init file in the current directory.
22899 @item @xref{show auto-load local-gdbinit}.
22900 @tab Show setting of init file in the current directory.
22901 @item @xref{info auto-load local-gdbinit}.
22902 @tab Show state of init file in the current directory.
22903 @item @xref{set auto-load libthread-db}.
22904 @tab Control for thread debugging library.
22905 @item @xref{show auto-load libthread-db}.
22906 @tab Show setting of thread debugging library.
22907 @item @xref{info auto-load libthread-db}.
22908 @tab Show state of thread debugging library.
22909 @item @xref{set auto-load safe-path}.
22910 @tab Control directories trusted for automatic loading.
22911 @item @xref{show auto-load safe-path}.
22912 @tab Show directories trusted for automatic loading.
22913 @item @xref{add-auto-load-safe-path}.
22914 @tab Add directory trusted for automatic loading.
22917 @node Init File in the Current Directory
22918 @subsection Automatically loading init file in the current directory
22919 @cindex auto-loading init file in the current directory
22921 By default, @value{GDBN} reads and executes the canned sequences of commands
22922 from init file (if any) in the current working directory,
22923 see @ref{Init File in the Current Directory during Startup}.
22925 Note that loading of this local @file{.gdbinit} file also requires accordingly
22926 configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
22929 @anchor{set auto-load local-gdbinit}
22930 @kindex set auto-load local-gdbinit
22931 @item set auto-load local-gdbinit [on|off]
22932 Enable or disable the auto-loading of canned sequences of commands
22933 (@pxref{Sequences}) found in init file in the current directory.
22935 @anchor{show auto-load local-gdbinit}
22936 @kindex show auto-load local-gdbinit
22937 @item show auto-load local-gdbinit
22938 Show whether auto-loading of canned sequences of commands from init file in the
22939 current directory is enabled or disabled.
22941 @anchor{info auto-load local-gdbinit}
22942 @kindex info auto-load local-gdbinit
22943 @item info auto-load local-gdbinit
22944 Print whether canned sequences of commands from init file in the
22945 current directory have been auto-loaded.
22948 @node libthread_db.so.1 file
22949 @subsection Automatically loading thread debugging library
22950 @cindex auto-loading libthread_db.so.1
22952 This feature is currently present only on @sc{gnu}/Linux native hosts.
22954 @value{GDBN} reads in some cases thread debugging library from places specific
22955 to the inferior (@pxref{set libthread-db-search-path}).
22957 The special @samp{libthread-db-search-path} entry @samp{$sdir} is processed
22958 without checking this @samp{set auto-load libthread-db} switch as system
22959 libraries have to be trusted in general. In all other cases of
22960 @samp{libthread-db-search-path} entries @value{GDBN} checks first if @samp{set
22961 auto-load libthread-db} is enabled before trying to open such thread debugging
22964 Note that loading of this debugging library also requires accordingly configured
22965 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
22968 @anchor{set auto-load libthread-db}
22969 @kindex set auto-load libthread-db
22970 @item set auto-load libthread-db [on|off]
22971 Enable or disable the auto-loading of inferior specific thread debugging library.
22973 @anchor{show auto-load libthread-db}
22974 @kindex show auto-load libthread-db
22975 @item show auto-load libthread-db
22976 Show whether auto-loading of inferior specific thread debugging library is
22977 enabled or disabled.
22979 @anchor{info auto-load libthread-db}
22980 @kindex info auto-load libthread-db
22981 @item info auto-load libthread-db
22982 Print the list of all loaded inferior specific thread debugging libraries and
22983 for each such library print list of inferior @var{pid}s using it.
22986 @node Auto-loading safe path
22987 @subsection Security restriction for auto-loading
22988 @cindex auto-loading safe-path
22990 As the files of inferior can come from untrusted source (such as submitted by
22991 an application user) @value{GDBN} does not always load any files automatically.
22992 @value{GDBN} provides the @samp{set auto-load safe-path} setting to list
22993 directories trusted for loading files not explicitly requested by user.
22994 Each directory can also be a shell wildcard pattern.
22996 If the path is not set properly you will see a warning and the file will not
23001 Reading symbols from /home/user/gdb/gdb...done.
23002 warning: File "/home/user/gdb/gdb-gdb.gdb" auto-loading has been
23003 declined by your `auto-load safe-path' set
23004 to "$debugdir:$datadir/auto-load".
23005 warning: File "/home/user/gdb/gdb-gdb.py" auto-loading has been
23006 declined by your `auto-load safe-path' set
23007 to "$debugdir:$datadir/auto-load".
23011 To instruct @value{GDBN} to go ahead and use the init files anyway,
23012 invoke @value{GDBN} like this:
23015 $ gdb -q -iex "set auto-load safe-path /home/user/gdb" ./gdb
23018 The list of trusted directories is controlled by the following commands:
23021 @anchor{set auto-load safe-path}
23022 @kindex set auto-load safe-path
23023 @item set auto-load safe-path @r{[}@var{directories}@r{]}
23024 Set the list of directories (and their subdirectories) trusted for automatic
23025 loading and execution of scripts. You can also enter a specific trusted file.
23026 Each directory can also be a shell wildcard pattern; wildcards do not match
23027 directory separator - see @code{FNM_PATHNAME} for system function @code{fnmatch}
23028 (@pxref{Wildcard Matching, fnmatch, , libc, GNU C Library Reference Manual}).
23029 If you omit @var{directories}, @samp{auto-load safe-path} will be reset to
23030 its default value as specified during @value{GDBN} compilation.
23032 The list of directories uses path separator (@samp{:} on GNU and Unix
23033 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
23034 to the @env{PATH} environment variable.
23036 @anchor{show auto-load safe-path}
23037 @kindex show auto-load safe-path
23038 @item show auto-load safe-path
23039 Show the list of directories trusted for automatic loading and execution of
23042 @anchor{add-auto-load-safe-path}
23043 @kindex add-auto-load-safe-path
23044 @item add-auto-load-safe-path
23045 Add an entry (or list of entries) to the list of directories trusted for
23046 automatic loading and execution of scripts. Multiple entries may be delimited
23047 by the host platform path separator in use.
23050 This variable defaults to what @code{--with-auto-load-dir} has been configured
23051 to (@pxref{with-auto-load-dir}). @file{$debugdir} and @file{$datadir}
23052 substitution applies the same as for @ref{set auto-load scripts-directory}.
23053 The default @code{set auto-load safe-path} value can be also overriden by
23054 @value{GDBN} configuration option @option{--with-auto-load-safe-path}.
23056 Setting this variable to @file{/} disables this security protection,
23057 corresponding @value{GDBN} configuration option is
23058 @option{--without-auto-load-safe-path}.
23059 This variable is supposed to be set to the system directories writable by the
23060 system superuser only. Users can add their source directories in init files in
23061 their home directories (@pxref{Home Directory Init File}). See also deprecated
23062 init file in the current directory
23063 (@pxref{Init File in the Current Directory during Startup}).
23065 To force @value{GDBN} to load the files it declined to load in the previous
23066 example, you could use one of the following ways:
23069 @item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
23070 Specify this trusted directory (or a file) as additional component of the list.
23071 You have to specify also any existing directories displayed by
23072 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
23074 @item @kbd{gdb -iex "set auto-load safe-path /usr:/bin:~/src/gdb" @dots{}}
23075 Specify this directory as in the previous case but just for a single
23076 @value{GDBN} session.
23078 @item @kbd{gdb -iex "set auto-load safe-path /" @dots{}}
23079 Disable auto-loading safety for a single @value{GDBN} session.
23080 This assumes all the files you debug during this @value{GDBN} session will come
23081 from trusted sources.
23083 @item @kbd{./configure --without-auto-load-safe-path}
23084 During compilation of @value{GDBN} you may disable any auto-loading safety.
23085 This assumes all the files you will ever debug with this @value{GDBN} come from
23089 On the other hand you can also explicitly forbid automatic files loading which
23090 also suppresses any such warning messages:
23093 @item @kbd{gdb -iex "set auto-load no" @dots{}}
23094 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
23096 @item @file{~/.gdbinit}: @samp{set auto-load no}
23097 Disable auto-loading globally for the user
23098 (@pxref{Home Directory Init File}). While it is improbable, you could also
23099 use system init file instead (@pxref{System-wide configuration}).
23102 This setting applies to the file names as entered by user. If no entry matches
23103 @value{GDBN} tries as a last resort to also resolve all the file names into
23104 their canonical form (typically resolving symbolic links) and compare the
23105 entries again. @value{GDBN} already canonicalizes most of the filenames on its
23106 own before starting the comparison so a canonical form of directories is
23107 recommended to be entered.
23109 @node Auto-loading verbose mode
23110 @subsection Displaying files tried for auto-load
23111 @cindex auto-loading verbose mode
23113 For better visibility of all the file locations where you can place scripts to
23114 be auto-loaded with inferior --- or to protect yourself against accidental
23115 execution of untrusted scripts --- @value{GDBN} provides a feature for printing
23116 all the files attempted to be loaded. Both existing and non-existing files may
23119 For example the list of directories from which it is safe to auto-load files
23120 (@pxref{Auto-loading safe path}) applies also to canonicalized filenames which
23121 may not be too obvious while setting it up.
23124 (gdb) set debug auto-load on
23125 (gdb) file ~/src/t/true
23126 auto-load: Loading canned sequences of commands script "/tmp/true-gdb.gdb"
23127 for objfile "/tmp/true".
23128 auto-load: Updating directories of "/usr:/opt".
23129 auto-load: Using directory "/usr".
23130 auto-load: Using directory "/opt".
23131 warning: File "/tmp/true-gdb.gdb" auto-loading has been declined
23132 by your `auto-load safe-path' set to "/usr:/opt".
23136 @anchor{set debug auto-load}
23137 @kindex set debug auto-load
23138 @item set debug auto-load [on|off]
23139 Set whether to print the filenames attempted to be auto-loaded.
23141 @anchor{show debug auto-load}
23142 @kindex show debug auto-load
23143 @item show debug auto-load
23144 Show whether printing of the filenames attempted to be auto-loaded is turned
23148 @node Messages/Warnings
23149 @section Optional Warnings and Messages
23151 @cindex verbose operation
23152 @cindex optional warnings
23153 By default, @value{GDBN} is silent about its inner workings. If you are
23154 running on a slow machine, you may want to use the @code{set verbose}
23155 command. This makes @value{GDBN} tell you when it does a lengthy
23156 internal operation, so you will not think it has crashed.
23158 Currently, the messages controlled by @code{set verbose} are those
23159 which announce that the symbol table for a source file is being read;
23160 see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
23163 @kindex set verbose
23164 @item set verbose on
23165 Enables @value{GDBN} output of certain informational messages.
23167 @item set verbose off
23168 Disables @value{GDBN} output of certain informational messages.
23170 @kindex show verbose
23172 Displays whether @code{set verbose} is on or off.
23175 By default, if @value{GDBN} encounters bugs in the symbol table of an
23176 object file, it is silent; but if you are debugging a compiler, you may
23177 find this information useful (@pxref{Symbol Errors, ,Errors Reading
23182 @kindex set complaints
23183 @item set complaints @var{limit}
23184 Permits @value{GDBN} to output @var{limit} complaints about each type of
23185 unusual symbols before becoming silent about the problem. Set
23186 @var{limit} to zero to suppress all complaints; set it to a large number
23187 to prevent complaints from being suppressed.
23189 @kindex show complaints
23190 @item show complaints
23191 Displays how many symbol complaints @value{GDBN} is permitted to produce.
23195 @anchor{confirmation requests}
23196 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
23197 lot of stupid questions to confirm certain commands. For example, if
23198 you try to run a program which is already running:
23202 The program being debugged has been started already.
23203 Start it from the beginning? (y or n)
23206 If you are willing to unflinchingly face the consequences of your own
23207 commands, you can disable this ``feature'':
23211 @kindex set confirm
23213 @cindex confirmation
23214 @cindex stupid questions
23215 @item set confirm off
23216 Disables confirmation requests. Note that running @value{GDBN} with
23217 the @option{--batch} option (@pxref{Mode Options, -batch}) also
23218 automatically disables confirmation requests.
23220 @item set confirm on
23221 Enables confirmation requests (the default).
23223 @kindex show confirm
23225 Displays state of confirmation requests.
23229 @cindex command tracing
23230 If you need to debug user-defined commands or sourced files you may find it
23231 useful to enable @dfn{command tracing}. In this mode each command will be
23232 printed as it is executed, prefixed with one or more @samp{+} symbols, the
23233 quantity denoting the call depth of each command.
23236 @kindex set trace-commands
23237 @cindex command scripts, debugging
23238 @item set trace-commands on
23239 Enable command tracing.
23240 @item set trace-commands off
23241 Disable command tracing.
23242 @item show trace-commands
23243 Display the current state of command tracing.
23246 @node Debugging Output
23247 @section Optional Messages about Internal Happenings
23248 @cindex optional debugging messages
23250 @value{GDBN} has commands that enable optional debugging messages from
23251 various @value{GDBN} subsystems; normally these commands are of
23252 interest to @value{GDBN} maintainers, or when reporting a bug. This
23253 section documents those commands.
23256 @kindex set exec-done-display
23257 @item set exec-done-display
23258 Turns on or off the notification of asynchronous commands'
23259 completion. When on, @value{GDBN} will print a message when an
23260 asynchronous command finishes its execution. The default is off.
23261 @kindex show exec-done-display
23262 @item show exec-done-display
23263 Displays the current setting of asynchronous command completion
23266 @cindex ARM AArch64
23267 @item set debug aarch64
23268 Turns on or off display of debugging messages related to ARM AArch64.
23269 The default is off.
23271 @item show debug aarch64
23272 Displays the current state of displaying debugging messages related to
23274 @cindex gdbarch debugging info
23275 @cindex architecture debugging info
23276 @item set debug arch
23277 Turns on or off display of gdbarch debugging info. The default is off
23278 @item show debug arch
23279 Displays the current state of displaying gdbarch debugging info.
23280 @item set debug aix-solib
23281 @cindex AIX shared library debugging
23282 Control display of debugging messages from the AIX shared library
23283 support module. The default is off.
23284 @item show debug aix-thread
23285 Show the current state of displaying AIX shared library debugging messages.
23286 @item set debug aix-thread
23287 @cindex AIX threads
23288 Display debugging messages about inner workings of the AIX thread
23290 @item show debug aix-thread
23291 Show the current state of AIX thread debugging info display.
23292 @item set debug check-physname
23294 Check the results of the ``physname'' computation. When reading DWARF
23295 debugging information for C@t{++}, @value{GDBN} attempts to compute
23296 each entity's name. @value{GDBN} can do this computation in two
23297 different ways, depending on exactly what information is present.
23298 When enabled, this setting causes @value{GDBN} to compute the names
23299 both ways and display any discrepancies.
23300 @item show debug check-physname
23301 Show the current state of ``physname'' checking.
23302 @item set debug coff-pe-read
23303 @cindex COFF/PE exported symbols
23304 Control display of debugging messages related to reading of COFF/PE
23305 exported symbols. The default is off.
23306 @item show debug coff-pe-read
23307 Displays the current state of displaying debugging messages related to
23308 reading of COFF/PE exported symbols.
23309 @item set debug dwarf-die
23311 Dump DWARF DIEs after they are read in.
23312 The value is the number of nesting levels to print.
23313 A value of zero turns off the display.
23314 @item show debug dwarf-die
23315 Show the current state of DWARF DIE debugging.
23316 @item set debug dwarf-line
23317 @cindex DWARF Line Tables
23318 Turns on or off display of debugging messages related to reading
23319 DWARF line tables. The default is 0 (off).
23320 A value of 1 provides basic information.
23321 A value greater than 1 provides more verbose information.
23322 @item show debug dwarf-line
23323 Show the current state of DWARF line table debugging.
23324 @item set debug dwarf-read
23325 @cindex DWARF Reading
23326 Turns on or off display of debugging messages related to reading
23327 DWARF debug info. The default is 0 (off).
23328 A value of 1 provides basic information.
23329 A value greater than 1 provides more verbose information.
23330 @item show debug dwarf-read
23331 Show the current state of DWARF reader debugging.
23332 @item set debug displaced
23333 @cindex displaced stepping debugging info
23334 Turns on or off display of @value{GDBN} debugging info for the
23335 displaced stepping support. The default is off.
23336 @item show debug displaced
23337 Displays the current state of displaying @value{GDBN} debugging info
23338 related to displaced stepping.
23339 @item set debug event
23340 @cindex event debugging info
23341 Turns on or off display of @value{GDBN} event debugging info. The
23343 @item show debug event
23344 Displays the current state of displaying @value{GDBN} event debugging
23346 @item set debug expression
23347 @cindex expression debugging info
23348 Turns on or off display of debugging info about @value{GDBN}
23349 expression parsing. The default is off.
23350 @item show debug expression
23351 Displays the current state of displaying debugging info about
23352 @value{GDBN} expression parsing.
23353 @item set debug frame
23354 @cindex frame debugging info
23355 Turns on or off display of @value{GDBN} frame debugging info. The
23357 @item show debug frame
23358 Displays the current state of displaying @value{GDBN} frame debugging
23360 @item set debug gnu-nat
23361 @cindex @sc{gnu}/Hurd debug messages
23362 Turns on or off debugging messages from the @sc{gnu}/Hurd debug support.
23363 @item show debug gnu-nat
23364 Show the current state of @sc{gnu}/Hurd debugging messages.
23365 @item set debug infrun
23366 @cindex inferior debugging info
23367 Turns on or off display of @value{GDBN} debugging info for running the inferior.
23368 The default is off. @file{infrun.c} contains GDB's runtime state machine used
23369 for implementing operations such as single-stepping the inferior.
23370 @item show debug infrun
23371 Displays the current state of @value{GDBN} inferior debugging.
23372 @item set debug jit
23373 @cindex just-in-time compilation, debugging messages
23374 Turns on or off debugging messages from JIT debug support.
23375 @item show debug jit
23376 Displays the current state of @value{GDBN} JIT debugging.
23377 @item set debug lin-lwp
23378 @cindex @sc{gnu}/Linux LWP debug messages
23379 @cindex Linux lightweight processes
23380 Turns on or off debugging messages from the Linux LWP debug support.
23381 @item show debug lin-lwp
23382 Show the current state of Linux LWP debugging messages.
23383 @item set debug linux-namespaces
23384 @cindex @sc{gnu}/Linux namespaces debug messages
23385 Turns on or off debugging messages from the Linux namespaces debug support.
23386 @item show debug linux-namespaces
23387 Show the current state of Linux namespaces debugging messages.
23388 @item set debug mach-o
23389 @cindex Mach-O symbols processing
23390 Control display of debugging messages related to Mach-O symbols
23391 processing. The default is off.
23392 @item show debug mach-o
23393 Displays the current state of displaying debugging messages related to
23394 reading of COFF/PE exported symbols.
23395 @item set debug notification
23396 @cindex remote async notification debugging info
23397 Turns on or off debugging messages about remote async notification.
23398 The default is off.
23399 @item show debug notification
23400 Displays the current state of remote async notification debugging messages.
23401 @item set debug observer
23402 @cindex observer debugging info
23403 Turns on or off display of @value{GDBN} observer debugging. This
23404 includes info such as the notification of observable events.
23405 @item show debug observer
23406 Displays the current state of observer debugging.
23407 @item set debug overload
23408 @cindex C@t{++} overload debugging info
23409 Turns on or off display of @value{GDBN} C@t{++} overload debugging
23410 info. This includes info such as ranking of functions, etc. The default
23412 @item show debug overload
23413 Displays the current state of displaying @value{GDBN} C@t{++} overload
23415 @cindex expression parser, debugging info
23416 @cindex debug expression parser
23417 @item set debug parser
23418 Turns on or off the display of expression parser debugging output.
23419 Internally, this sets the @code{yydebug} variable in the expression
23420 parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for
23421 details. The default is off.
23422 @item show debug parser
23423 Show the current state of expression parser debugging.
23424 @cindex packets, reporting on stdout
23425 @cindex serial connections, debugging
23426 @cindex debug remote protocol
23427 @cindex remote protocol debugging
23428 @cindex display remote packets
23429 @item set debug remote
23430 Turns on or off display of reports on all packets sent back and forth across
23431 the serial line to the remote machine. The info is printed on the
23432 @value{GDBN} standard output stream. The default is off.
23433 @item show debug remote
23434 Displays the state of display of remote packets.
23435 @item set debug serial
23436 Turns on or off display of @value{GDBN} serial debugging info. The
23438 @item show debug serial
23439 Displays the current state of displaying @value{GDBN} serial debugging
23441 @item set debug solib-frv
23442 @cindex FR-V shared-library debugging
23443 Turns on or off debugging messages for FR-V shared-library code.
23444 @item show debug solib-frv
23445 Display the current state of FR-V shared-library code debugging
23447 @item set debug symbol-lookup
23448 @cindex symbol lookup
23449 Turns on or off display of debugging messages related to symbol lookup.
23450 The default is 0 (off).
23451 A value of 1 provides basic information.
23452 A value greater than 1 provides more verbose information.
23453 @item show debug symbol-lookup
23454 Show the current state of symbol lookup debugging messages.
23455 @item set debug symfile
23456 @cindex symbol file functions
23457 Turns on or off display of debugging messages related to symbol file functions.
23458 The default is off. @xref{Files}.
23459 @item show debug symfile
23460 Show the current state of symbol file debugging messages.
23461 @item set debug symtab-create
23462 @cindex symbol table creation
23463 Turns on or off display of debugging messages related to symbol table creation.
23464 The default is 0 (off).
23465 A value of 1 provides basic information.
23466 A value greater than 1 provides more verbose information.
23467 @item show debug symtab-create
23468 Show the current state of symbol table creation debugging.
23469 @item set debug target
23470 @cindex target debugging info
23471 Turns on or off display of @value{GDBN} target debugging info. This info
23472 includes what is going on at the target level of GDB, as it happens. The
23473 default is 0. Set it to 1 to track events, and to 2 to also track the
23474 value of large memory transfers.
23475 @item show debug target
23476 Displays the current state of displaying @value{GDBN} target debugging
23478 @item set debug timestamp
23479 @cindex timestampping debugging info
23480 Turns on or off display of timestamps with @value{GDBN} debugging info.
23481 When enabled, seconds and microseconds are displayed before each debugging
23483 @item show debug timestamp
23484 Displays the current state of displaying timestamps with @value{GDBN}
23486 @item set debug varobj
23487 @cindex variable object debugging info
23488 Turns on or off display of @value{GDBN} variable object debugging
23489 info. The default is off.
23490 @item show debug varobj
23491 Displays the current state of displaying @value{GDBN} variable object
23493 @item set debug xml
23494 @cindex XML parser debugging
23495 Turns on or off debugging messages for built-in XML parsers.
23496 @item show debug xml
23497 Displays the current state of XML debugging messages.
23500 @node Other Misc Settings
23501 @section Other Miscellaneous Settings
23502 @cindex miscellaneous settings
23505 @kindex set interactive-mode
23506 @item set interactive-mode
23507 If @code{on}, forces @value{GDBN} to assume that GDB was started
23508 in a terminal. In practice, this means that @value{GDBN} should wait
23509 for the user to answer queries generated by commands entered at
23510 the command prompt. If @code{off}, forces @value{GDBN} to operate
23511 in the opposite mode, and it uses the default answers to all queries.
23512 If @code{auto} (the default), @value{GDBN} tries to determine whether
23513 its standard input is a terminal, and works in interactive-mode if it
23514 is, non-interactively otherwise.
23516 In the vast majority of cases, the debugger should be able to guess
23517 correctly which mode should be used. But this setting can be useful
23518 in certain specific cases, such as running a MinGW @value{GDBN}
23519 inside a cygwin window.
23521 @kindex show interactive-mode
23522 @item show interactive-mode
23523 Displays whether the debugger is operating in interactive mode or not.
23526 @node Extending GDB
23527 @chapter Extending @value{GDBN}
23528 @cindex extending GDB
23530 @value{GDBN} provides several mechanisms for extension.
23531 @value{GDBN} also provides the ability to automatically load
23532 extensions when it reads a file for debugging. This allows the
23533 user to automatically customize @value{GDBN} for the program
23537 * Sequences:: Canned Sequences of @value{GDBN} Commands
23538 * Python:: Extending @value{GDBN} using Python
23539 * Guile:: Extending @value{GDBN} using Guile
23540 * Auto-loading extensions:: Automatically loading extensions
23541 * Multiple Extension Languages:: Working with multiple extension languages
23542 * Aliases:: Creating new spellings of existing commands
23545 To facilitate the use of extension languages, @value{GDBN} is capable
23546 of evaluating the contents of a file. When doing so, @value{GDBN}
23547 can recognize which extension language is being used by looking at
23548 the filename extension. Files with an unrecognized filename extension
23549 are always treated as a @value{GDBN} Command Files.
23550 @xref{Command Files,, Command files}.
23552 You can control how @value{GDBN} evaluates these files with the following
23556 @kindex set script-extension
23557 @kindex show script-extension
23558 @item set script-extension off
23559 All scripts are always evaluated as @value{GDBN} Command Files.
23561 @item set script-extension soft
23562 The debugger determines the scripting language based on filename
23563 extension. If this scripting language is supported, @value{GDBN}
23564 evaluates the script using that language. Otherwise, it evaluates
23565 the file as a @value{GDBN} Command File.
23567 @item set script-extension strict
23568 The debugger determines the scripting language based on filename
23569 extension, and evaluates the script using that language. If the
23570 language is not supported, then the evaluation fails.
23572 @item show script-extension
23573 Display the current value of the @code{script-extension} option.
23578 @section Canned Sequences of Commands
23580 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
23581 Command Lists}), @value{GDBN} provides two ways to store sequences of
23582 commands for execution as a unit: user-defined commands and command
23586 * Define:: How to define your own commands
23587 * Hooks:: Hooks for user-defined commands
23588 * Command Files:: How to write scripts of commands to be stored in a file
23589 * Output:: Commands for controlled output
23590 * Auto-loading sequences:: Controlling auto-loaded command files
23594 @subsection User-defined Commands
23596 @cindex user-defined command
23597 @cindex arguments, to user-defined commands
23598 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
23599 which you assign a new name as a command. This is done with the
23600 @code{define} command. User commands may accept up to 10 arguments
23601 separated by whitespace. Arguments are accessed within the user command
23602 via @code{$arg0@dots{}$arg9}. A trivial example:
23606 print $arg0 + $arg1 + $arg2
23611 To execute the command use:
23618 This defines the command @code{adder}, which prints the sum of
23619 its three arguments. Note the arguments are text substitutions, so they may
23620 reference variables, use complex expressions, or even perform inferior
23623 @cindex argument count in user-defined commands
23624 @cindex how many arguments (user-defined commands)
23625 In addition, @code{$argc} may be used to find out how many arguments have
23626 been passed. This expands to a number in the range 0@dots{}10.
23631 print $arg0 + $arg1
23634 print $arg0 + $arg1 + $arg2
23642 @item define @var{commandname}
23643 Define a command named @var{commandname}. If there is already a command
23644 by that name, you are asked to confirm that you want to redefine it.
23645 The argument @var{commandname} may be a bare command name consisting of letters,
23646 numbers, dashes, and underscores. It may also start with any predefined
23647 prefix command. For example, @samp{define target my-target} creates
23648 a user-defined @samp{target my-target} command.
23650 The definition of the command is made up of other @value{GDBN} command lines,
23651 which are given following the @code{define} command. The end of these
23652 commands is marked by a line containing @code{end}.
23655 @kindex end@r{ (user-defined commands)}
23656 @item document @var{commandname}
23657 Document the user-defined command @var{commandname}, so that it can be
23658 accessed by @code{help}. The command @var{commandname} must already be
23659 defined. This command reads lines of documentation just as @code{define}
23660 reads the lines of the command definition, ending with @code{end}.
23661 After the @code{document} command is finished, @code{help} on command
23662 @var{commandname} displays the documentation you have written.
23664 You may use the @code{document} command again to change the
23665 documentation of a command. Redefining the command with @code{define}
23666 does not change the documentation.
23668 @kindex dont-repeat
23669 @cindex don't repeat command
23671 Used inside a user-defined command, this tells @value{GDBN} that this
23672 command should not be repeated when the user hits @key{RET}
23673 (@pxref{Command Syntax, repeat last command}).
23675 @kindex help user-defined
23676 @item help user-defined
23677 List all user-defined commands and all python commands defined in class
23678 COMAND_USER. The first line of the documentation or docstring is
23683 @itemx show user @var{commandname}
23684 Display the @value{GDBN} commands used to define @var{commandname} (but
23685 not its documentation). If no @var{commandname} is given, display the
23686 definitions for all user-defined commands.
23687 This does not work for user-defined python commands.
23689 @cindex infinite recursion in user-defined commands
23690 @kindex show max-user-call-depth
23691 @kindex set max-user-call-depth
23692 @item show max-user-call-depth
23693 @itemx set max-user-call-depth
23694 The value of @code{max-user-call-depth} controls how many recursion
23695 levels are allowed in user-defined commands before @value{GDBN} suspects an
23696 infinite recursion and aborts the command.
23697 This does not apply to user-defined python commands.
23700 In addition to the above commands, user-defined commands frequently
23701 use control flow commands, described in @ref{Command Files}.
23703 When user-defined commands are executed, the
23704 commands of the definition are not printed. An error in any command
23705 stops execution of the user-defined command.
23707 If used interactively, commands that would ask for confirmation proceed
23708 without asking when used inside a user-defined command. Many @value{GDBN}
23709 commands that normally print messages to say what they are doing omit the
23710 messages when used in a user-defined command.
23713 @subsection User-defined Command Hooks
23714 @cindex command hooks
23715 @cindex hooks, for commands
23716 @cindex hooks, pre-command
23719 You may define @dfn{hooks}, which are a special kind of user-defined
23720 command. Whenever you run the command @samp{foo}, if the user-defined
23721 command @samp{hook-foo} exists, it is executed (with no arguments)
23722 before that command.
23724 @cindex hooks, post-command
23726 A hook may also be defined which is run after the command you executed.
23727 Whenever you run the command @samp{foo}, if the user-defined command
23728 @samp{hookpost-foo} exists, it is executed (with no arguments) after
23729 that command. Post-execution hooks may exist simultaneously with
23730 pre-execution hooks, for the same command.
23732 It is valid for a hook to call the command which it hooks. If this
23733 occurs, the hook is not re-executed, thereby avoiding infinite recursion.
23735 @c It would be nice if hookpost could be passed a parameter indicating
23736 @c if the command it hooks executed properly or not. FIXME!
23738 @kindex stop@r{, a pseudo-command}
23739 In addition, a pseudo-command, @samp{stop} exists. Defining
23740 (@samp{hook-stop}) makes the associated commands execute every time
23741 execution stops in your program: before breakpoint commands are run,
23742 displays are printed, or the stack frame is printed.
23744 For example, to ignore @code{SIGALRM} signals while
23745 single-stepping, but treat them normally during normal execution,
23750 handle SIGALRM nopass
23754 handle SIGALRM pass
23757 define hook-continue
23758 handle SIGALRM pass
23762 As a further example, to hook at the beginning and end of the @code{echo}
23763 command, and to add extra text to the beginning and end of the message,
23771 define hookpost-echo
23775 (@value{GDBP}) echo Hello World
23776 <<<---Hello World--->>>
23781 You can define a hook for any single-word command in @value{GDBN}, but
23782 not for command aliases; you should define a hook for the basic command
23783 name, e.g.@: @code{backtrace} rather than @code{bt}.
23784 @c FIXME! So how does Joe User discover whether a command is an alias
23786 You can hook a multi-word command by adding @code{hook-} or
23787 @code{hookpost-} to the last word of the command, e.g.@:
23788 @samp{define target hook-remote} to add a hook to @samp{target remote}.
23790 If an error occurs during the execution of your hook, execution of
23791 @value{GDBN} commands stops and @value{GDBN} issues a prompt
23792 (before the command that you actually typed had a chance to run).
23794 If you try to define a hook which does not match any known command, you
23795 get a warning from the @code{define} command.
23797 @node Command Files
23798 @subsection Command Files
23800 @cindex command files
23801 @cindex scripting commands
23802 A command file for @value{GDBN} is a text file made of lines that are
23803 @value{GDBN} commands. Comments (lines starting with @kbd{#}) may
23804 also be included. An empty line in a command file does nothing; it
23805 does not mean to repeat the last command, as it would from the
23808 You can request the execution of a command file with the @code{source}
23809 command. Note that the @code{source} command is also used to evaluate
23810 scripts that are not Command Files. The exact behavior can be configured
23811 using the @code{script-extension} setting.
23812 @xref{Extending GDB,, Extending GDB}.
23816 @cindex execute commands from a file
23817 @item source [-s] [-v] @var{filename}
23818 Execute the command file @var{filename}.
23821 The lines in a command file are generally executed sequentially,
23822 unless the order of execution is changed by one of the
23823 @emph{flow-control commands} described below. The commands are not
23824 printed as they are executed. An error in any command terminates
23825 execution of the command file and control is returned to the console.
23827 @value{GDBN} first searches for @var{filename} in the current directory.
23828 If the file is not found there, and @var{filename} does not specify a
23829 directory, then @value{GDBN} also looks for the file on the source search path
23830 (specified with the @samp{directory} command);
23831 except that @file{$cdir} is not searched because the compilation directory
23832 is not relevant to scripts.
23834 If @code{-s} is specified, then @value{GDBN} searches for @var{filename}
23835 on the search path even if @var{filename} specifies a directory.
23836 The search is done by appending @var{filename} to each element of the
23837 search path. So, for example, if @var{filename} is @file{mylib/myscript}
23838 and the search path contains @file{/home/user} then @value{GDBN} will
23839 look for the script @file{/home/user/mylib/myscript}.
23840 The search is also done if @var{filename} is an absolute path.
23841 For example, if @var{filename} is @file{/tmp/myscript} and
23842 the search path contains @file{/home/user} then @value{GDBN} will
23843 look for the script @file{/home/user/tmp/myscript}.
23844 For DOS-like systems, if @var{filename} contains a drive specification,
23845 it is stripped before concatenation. For example, if @var{filename} is
23846 @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN}
23847 will look for the script @file{c:/tmp/myscript}.
23849 If @code{-v}, for verbose mode, is given then @value{GDBN} displays
23850 each command as it is executed. The option must be given before
23851 @var{filename}, and is interpreted as part of the filename anywhere else.
23853 Commands that would ask for confirmation if used interactively proceed
23854 without asking when used in a command file. Many @value{GDBN} commands that
23855 normally print messages to say what they are doing omit the messages
23856 when called from command files.
23858 @value{GDBN} also accepts command input from standard input. In this
23859 mode, normal output goes to standard output and error output goes to
23860 standard error. Errors in a command file supplied on standard input do
23861 not terminate execution of the command file---execution continues with
23865 gdb < cmds > log 2>&1
23868 (The syntax above will vary depending on the shell used.) This example
23869 will execute commands from the file @file{cmds}. All output and errors
23870 would be directed to @file{log}.
23872 Since commands stored on command files tend to be more general than
23873 commands typed interactively, they frequently need to deal with
23874 complicated situations, such as different or unexpected values of
23875 variables and symbols, changes in how the program being debugged is
23876 built, etc. @value{GDBN} provides a set of flow-control commands to
23877 deal with these complexities. Using these commands, you can write
23878 complex scripts that loop over data structures, execute commands
23879 conditionally, etc.
23886 This command allows to include in your script conditionally executed
23887 commands. The @code{if} command takes a single argument, which is an
23888 expression to evaluate. It is followed by a series of commands that
23889 are executed only if the expression is true (its value is nonzero).
23890 There can then optionally be an @code{else} line, followed by a series
23891 of commands that are only executed if the expression was false. The
23892 end of the list is marked by a line containing @code{end}.
23896 This command allows to write loops. Its syntax is similar to
23897 @code{if}: the command takes a single argument, which is an expression
23898 to evaluate, and must be followed by the commands to execute, one per
23899 line, terminated by an @code{end}. These commands are called the
23900 @dfn{body} of the loop. The commands in the body of @code{while} are
23901 executed repeatedly as long as the expression evaluates to true.
23905 This command exits the @code{while} loop in whose body it is included.
23906 Execution of the script continues after that @code{while}s @code{end}
23909 @kindex loop_continue
23910 @item loop_continue
23911 This command skips the execution of the rest of the body of commands
23912 in the @code{while} loop in whose body it is included. Execution
23913 branches to the beginning of the @code{while} loop, where it evaluates
23914 the controlling expression.
23916 @kindex end@r{ (if/else/while commands)}
23918 Terminate the block of commands that are the body of @code{if},
23919 @code{else}, or @code{while} flow-control commands.
23924 @subsection Commands for Controlled Output
23926 During the execution of a command file or a user-defined command, normal
23927 @value{GDBN} output is suppressed; the only output that appears is what is
23928 explicitly printed by the commands in the definition. This section
23929 describes three commands useful for generating exactly the output you
23934 @item echo @var{text}
23935 @c I do not consider backslash-space a standard C escape sequence
23936 @c because it is not in ANSI.
23937 Print @var{text}. Nonprinting characters can be included in
23938 @var{text} using C escape sequences, such as @samp{\n} to print a
23939 newline. @strong{No newline is printed unless you specify one.}
23940 In addition to the standard C escape sequences, a backslash followed
23941 by a space stands for a space. This is useful for displaying a
23942 string with spaces at the beginning or the end, since leading and
23943 trailing spaces are otherwise trimmed from all arguments.
23944 To print @samp{@w{ }and foo =@w{ }}, use the command
23945 @samp{echo \@w{ }and foo = \@w{ }}.
23947 A backslash at the end of @var{text} can be used, as in C, to continue
23948 the command onto subsequent lines. For example,
23951 echo This is some text\n\
23952 which is continued\n\
23953 onto several lines.\n
23956 produces the same output as
23959 echo This is some text\n
23960 echo which is continued\n
23961 echo onto several lines.\n
23965 @item output @var{expression}
23966 Print the value of @var{expression} and nothing but that value: no
23967 newlines, no @samp{$@var{nn} = }. The value is not entered in the
23968 value history either. @xref{Expressions, ,Expressions}, for more information
23971 @item output/@var{fmt} @var{expression}
23972 Print the value of @var{expression} in format @var{fmt}. You can use
23973 the same formats as for @code{print}. @xref{Output Formats,,Output
23974 Formats}, for more information.
23977 @item printf @var{template}, @var{expressions}@dots{}
23978 Print the values of one or more @var{expressions} under the control of
23979 the string @var{template}. To print several values, make
23980 @var{expressions} be a comma-separated list of individual expressions,
23981 which may be either numbers or pointers. Their values are printed as
23982 specified by @var{template}, exactly as a C program would do by
23983 executing the code below:
23986 printf (@var{template}, @var{expressions}@dots{});
23989 As in @code{C} @code{printf}, ordinary characters in @var{template}
23990 are printed verbatim, while @dfn{conversion specification} introduced
23991 by the @samp{%} character cause subsequent @var{expressions} to be
23992 evaluated, their values converted and formatted according to type and
23993 style information encoded in the conversion specifications, and then
23996 For example, you can print two values in hex like this:
23999 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
24002 @code{printf} supports all the standard @code{C} conversion
24003 specifications, including the flags and modifiers between the @samp{%}
24004 character and the conversion letter, with the following exceptions:
24008 The argument-ordering modifiers, such as @samp{2$}, are not supported.
24011 The modifier @samp{*} is not supported for specifying precision or
24015 The @samp{'} flag (for separation of digits into groups according to
24016 @code{LC_NUMERIC'}) is not supported.
24019 The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not
24023 The conversion letter @samp{n} (as in @samp{%n}) is not supported.
24026 The conversion letters @samp{a} and @samp{A} are not supported.
24030 Note that the @samp{ll} type modifier is supported only if the
24031 underlying @code{C} implementation used to build @value{GDBN} supports
24032 the @code{long long int} type, and the @samp{L} type modifier is
24033 supported only if @code{long double} type is available.
24035 As in @code{C}, @code{printf} supports simple backslash-escape
24036 sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"},
24037 @samp{\a}, and @samp{\f}, that consist of backslash followed by a
24038 single character. Octal and hexadecimal escape sequences are not
24041 Additionally, @code{printf} supports conversion specifications for DFP
24042 (@dfn{Decimal Floating Point}) types using the following length modifiers
24043 together with a floating point specifier.
24048 @samp{H} for printing @code{Decimal32} types.
24051 @samp{D} for printing @code{Decimal64} types.
24054 @samp{DD} for printing @code{Decimal128} types.
24057 If the underlying @code{C} implementation used to build @value{GDBN} has
24058 support for the three length modifiers for DFP types, other modifiers
24059 such as width and precision will also be available for @value{GDBN} to use.
24061 In case there is no such @code{C} support, no additional modifiers will be
24062 available and the value will be printed in the standard way.
24064 Here's an example of printing DFP types using the above conversion letters:
24066 printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl
24070 @item eval @var{template}, @var{expressions}@dots{}
24071 Convert the values of one or more @var{expressions} under the control of
24072 the string @var{template} to a command line, and call it.
24076 @node Auto-loading sequences
24077 @subsection Controlling auto-loading native @value{GDBN} scripts
24078 @cindex native script auto-loading
24080 When a new object file is read (for example, due to the @code{file}
24081 command, or because the inferior has loaded a shared library),
24082 @value{GDBN} will look for the command file @file{@var{objfile}-gdb.gdb}.
24083 @xref{Auto-loading extensions}.
24085 Auto-loading can be enabled or disabled,
24086 and the list of auto-loaded scripts can be printed.
24089 @anchor{set auto-load gdb-scripts}
24090 @kindex set auto-load gdb-scripts
24091 @item set auto-load gdb-scripts [on|off]
24092 Enable or disable the auto-loading of canned sequences of commands scripts.
24094 @anchor{show auto-load gdb-scripts}
24095 @kindex show auto-load gdb-scripts
24096 @item show auto-load gdb-scripts
24097 Show whether auto-loading of canned sequences of commands scripts is enabled or
24100 @anchor{info auto-load gdb-scripts}
24101 @kindex info auto-load gdb-scripts
24102 @cindex print list of auto-loaded canned sequences of commands scripts
24103 @item info auto-load gdb-scripts [@var{regexp}]
24104 Print the list of all canned sequences of commands scripts that @value{GDBN}
24108 If @var{regexp} is supplied only canned sequences of commands scripts with
24109 matching names are printed.
24111 @c Python docs live in a separate file.
24112 @include python.texi
24114 @c Guile docs live in a separate file.
24115 @include guile.texi
24117 @node Auto-loading extensions
24118 @section Auto-loading extensions
24119 @cindex auto-loading extensions
24121 @value{GDBN} provides two mechanisms for automatically loading extensions
24122 when a new object file is read (for example, due to the @code{file}
24123 command, or because the inferior has loaded a shared library):
24124 @file{@var{objfile}-gdb.@var{ext}} and the @code{.debug_gdb_scripts}
24125 section of modern file formats like ELF.
24128 * objfile-gdb.ext file: objfile-gdbdotext file. The @file{@var{objfile}-gdb.@var{ext}} file
24129 * .debug_gdb_scripts section: dotdebug_gdb_scripts section. The @code{.debug_gdb_scripts} section
24130 * Which flavor to choose?::
24133 The auto-loading feature is useful for supplying application-specific
24134 debugging commands and features.
24136 Auto-loading can be enabled or disabled,
24137 and the list of auto-loaded scripts can be printed.
24138 See the @samp{auto-loading} section of each extension language
24139 for more information.
24140 For @value{GDBN} command files see @ref{Auto-loading sequences}.
24141 For Python files see @ref{Python Auto-loading}.
24143 Note that loading of this script file also requires accordingly configured
24144 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24146 @node objfile-gdbdotext file
24147 @subsection The @file{@var{objfile}-gdb.@var{ext}} file
24148 @cindex @file{@var{objfile}-gdb.gdb}
24149 @cindex @file{@var{objfile}-gdb.py}
24150 @cindex @file{@var{objfile}-gdb.scm}
24152 When a new object file is read, @value{GDBN} looks for a file named
24153 @file{@var{objfile}-gdb.@var{ext}} (we call it @var{script-name} below),
24154 where @var{objfile} is the object file's name and
24155 where @var{ext} is the file extension for the extension language:
24158 @item @file{@var{objfile}-gdb.gdb}
24159 GDB's own command language
24160 @item @file{@var{objfile}-gdb.py}
24162 @item @file{@var{objfile}-gdb.scm}
24166 @var{script-name} is formed by ensuring that the file name of @var{objfile}
24167 is absolute, following all symlinks, and resolving @code{.} and @code{..}
24168 components, and appending the @file{-gdb.@var{ext}} suffix.
24169 If this file exists and is readable, @value{GDBN} will evaluate it as a
24170 script in the specified extension language.
24172 If this file does not exist, then @value{GDBN} will look for
24173 @var{script-name} file in all of the directories as specified below.
24175 Note that loading of these files requires an accordingly configured
24176 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24178 For object files using @file{.exe} suffix @value{GDBN} tries to load first the
24179 scripts normally according to its @file{.exe} filename. But if no scripts are
24180 found @value{GDBN} also tries script filenames matching the object file without
24181 its @file{.exe} suffix. This @file{.exe} stripping is case insensitive and it
24182 is attempted on any platform. This makes the script filenames compatible
24183 between Unix and MS-Windows hosts.
24186 @anchor{set auto-load scripts-directory}
24187 @kindex set auto-load scripts-directory
24188 @item set auto-load scripts-directory @r{[}@var{directories}@r{]}
24189 Control @value{GDBN} auto-loaded scripts location. Multiple directory entries
24190 may be delimited by the host platform path separator in use
24191 (@samp{:} on Unix, @samp{;} on MS-Windows and MS-DOS).
24193 Each entry here needs to be covered also by the security setting
24194 @code{set auto-load safe-path} (@pxref{set auto-load safe-path}).
24196 @anchor{with-auto-load-dir}
24197 This variable defaults to @file{$debugdir:$datadir/auto-load}. The default
24198 @code{set auto-load safe-path} value can be also overriden by @value{GDBN}
24199 configuration option @option{--with-auto-load-dir}.
24201 Any reference to @file{$debugdir} will get replaced by
24202 @var{debug-file-directory} value (@pxref{Separate Debug Files}) and any
24203 reference to @file{$datadir} will get replaced by @var{data-directory} which is
24204 determined at @value{GDBN} startup (@pxref{Data Files}). @file{$debugdir} and
24205 @file{$datadir} must be placed as a directory component --- either alone or
24206 delimited by @file{/} or @file{\} directory separators, depending on the host
24209 The list of directories uses path separator (@samp{:} on GNU and Unix
24210 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
24211 to the @env{PATH} environment variable.
24213 @anchor{show auto-load scripts-directory}
24214 @kindex show auto-load scripts-directory
24215 @item show auto-load scripts-directory
24216 Show @value{GDBN} auto-loaded scripts location.
24218 @anchor{add-auto-load-scripts-directory}
24219 @kindex add-auto-load-scripts-directory
24220 @item add-auto-load-scripts-directory @r{[}@var{directories}@dots{}@r{]}
24221 Add an entry (or list of entries) to the list of auto-loaded scripts locations.
24222 Multiple entries may be delimited by the host platform path separator in use.
24225 @value{GDBN} does not track which files it has already auto-loaded this way.
24226 @value{GDBN} will load the associated script every time the corresponding
24227 @var{objfile} is opened.
24228 So your @file{-gdb.@var{ext}} file should be careful to avoid errors if it
24229 is evaluated more than once.
24231 @node dotdebug_gdb_scripts section
24232 @subsection The @code{.debug_gdb_scripts} section
24233 @cindex @code{.debug_gdb_scripts} section
24235 For systems using file formats like ELF and COFF,
24236 when @value{GDBN} loads a new object file
24237 it will look for a special section named @code{.debug_gdb_scripts}.
24238 If this section exists, its contents is a list of null-terminated entries
24239 specifying scripts to load. Each entry begins with a non-null prefix byte that
24240 specifies the kind of entry, typically the extension language and whether the
24241 script is in a file or inlined in @code{.debug_gdb_scripts}.
24243 The following entries are supported:
24246 @item SECTION_SCRIPT_ID_PYTHON_FILE = 1
24247 @item SECTION_SCRIPT_ID_SCHEME_FILE = 3
24248 @item SECTION_SCRIPT_ID_PYTHON_TEXT = 4
24249 @item SECTION_SCRIPT_ID_SCHEME_TEXT = 6
24252 @subsubsection Script File Entries
24254 If the entry specifies a file, @value{GDBN} will look for the file first
24255 in the current directory and then along the source search path
24256 (@pxref{Source Path, ,Specifying Source Directories}),
24257 except that @file{$cdir} is not searched, since the compilation
24258 directory is not relevant to scripts.
24260 File entries can be placed in section @code{.debug_gdb_scripts} with,
24261 for example, this GCC macro for Python scripts.
24264 /* Note: The "MS" section flags are to remove duplicates. */
24265 #define DEFINE_GDB_PY_SCRIPT(script_name) \
24267 .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\
24268 .byte 1 /* Python */\n\
24269 .asciz \"" script_name "\"\n\
24275 For Guile scripts, replace @code{.byte 1} with @code{.byte 3}.
24276 Then one can reference the macro in a header or source file like this:
24279 DEFINE_GDB_PY_SCRIPT ("my-app-scripts.py")
24282 The script name may include directories if desired.
24284 Note that loading of this script file also requires accordingly configured
24285 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24287 If the macro invocation is put in a header, any application or library
24288 using this header will get a reference to the specified script,
24289 and with the use of @code{"MS"} attributes on the section, the linker
24290 will remove duplicates.
24292 @subsubsection Script Text Entries
24294 Script text entries allow to put the executable script in the entry
24295 itself instead of loading it from a file.
24296 The first line of the entry, everything after the prefix byte and up to
24297 the first newline (@code{0xa}) character, is the script name, and must not
24298 contain any kind of space character, e.g., spaces or tabs.
24299 The rest of the entry, up to the trailing null byte, is the script to
24300 execute in the specified language. The name needs to be unique among
24301 all script names, as @value{GDBN} executes each script only once based
24304 Here is an example from file @file{py-section-script.c} in the @value{GDBN}
24308 #include "symcat.h"
24309 #include "gdb/section-scripts.h"
24311 ".pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n"
24312 ".byte " XSTRING (SECTION_SCRIPT_ID_PYTHON_TEXT) "\n"
24313 ".ascii \"gdb.inlined-script\\n\"\n"
24314 ".ascii \"class test_cmd (gdb.Command):\\n\"\n"
24315 ".ascii \" def __init__ (self):\\n\"\n"
24316 ".ascii \" super (test_cmd, self).__init__ ("
24317 "\\\"test-cmd\\\", gdb.COMMAND_OBSCURE)\\n\"\n"
24318 ".ascii \" def invoke (self, arg, from_tty):\\n\"\n"
24319 ".ascii \" print (\\\"test-cmd output, arg = %s\\\" % arg)\\n\"\n"
24320 ".ascii \"test_cmd ()\\n\"\n"
24326 Loading of inlined scripts requires a properly configured
24327 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24328 The path to specify in @code{auto-load safe-path} is the path of the file
24329 containing the @code{.debug_gdb_scripts} section.
24331 @node Which flavor to choose?
24332 @subsection Which flavor to choose?
24334 Given the multiple ways of auto-loading extensions, it might not always
24335 be clear which one to choose. This section provides some guidance.
24338 Benefits of the @file{-gdb.@var{ext}} way:
24342 Can be used with file formats that don't support multiple sections.
24345 Ease of finding scripts for public libraries.
24347 Scripts specified in the @code{.debug_gdb_scripts} section are searched for
24348 in the source search path.
24349 For publicly installed libraries, e.g., @file{libstdc++}, there typically
24350 isn't a source directory in which to find the script.
24353 Doesn't require source code additions.
24357 Benefits of the @code{.debug_gdb_scripts} way:
24361 Works with static linking.
24363 Scripts for libraries done the @file{-gdb.@var{ext}} way require an objfile to
24364 trigger their loading. When an application is statically linked the only
24365 objfile available is the executable, and it is cumbersome to attach all the
24366 scripts from all the input libraries to the executable's
24367 @file{-gdb.@var{ext}} script.
24370 Works with classes that are entirely inlined.
24372 Some classes can be entirely inlined, and thus there may not be an associated
24373 shared library to attach a @file{-gdb.@var{ext}} script to.
24376 Scripts needn't be copied out of the source tree.
24378 In some circumstances, apps can be built out of large collections of internal
24379 libraries, and the build infrastructure necessary to install the
24380 @file{-gdb.@var{ext}} scripts in a place where @value{GDBN} can find them is
24381 cumbersome. It may be easier to specify the scripts in the
24382 @code{.debug_gdb_scripts} section as relative paths, and add a path to the
24383 top of the source tree to the source search path.
24386 @node Multiple Extension Languages
24387 @section Multiple Extension Languages
24389 The Guile and Python extension languages do not share any state,
24390 and generally do not interfere with each other.
24391 There are some things to be aware of, however.
24393 @subsection Python comes first
24395 Python was @value{GDBN}'s first extension language, and to avoid breaking
24396 existing behaviour Python comes first. This is generally solved by the
24397 ``first one wins'' principle. @value{GDBN} maintains a list of enabled
24398 extension languages, and when it makes a call to an extension language,
24399 (say to pretty-print a value), it tries each in turn until an extension
24400 language indicates it has performed the request (e.g., has returned the
24401 pretty-printed form of a value).
24402 This extends to errors while performing such requests: If an error happens
24403 while, for example, trying to pretty-print an object then the error is
24404 reported and any following extension languages are not tried.
24407 @section Creating new spellings of existing commands
24408 @cindex aliases for commands
24410 It is often useful to define alternate spellings of existing commands.
24411 For example, if a new @value{GDBN} command defined in Python has
24412 a long name to type, it is handy to have an abbreviated version of it
24413 that involves less typing.
24415 @value{GDBN} itself uses aliases. For example @samp{s} is an alias
24416 of the @samp{step} command even though it is otherwise an ambiguous
24417 abbreviation of other commands like @samp{set} and @samp{show}.
24419 Aliases are also used to provide shortened or more common versions
24420 of multi-word commands. For example, @value{GDBN} provides the
24421 @samp{tty} alias of the @samp{set inferior-tty} command.
24423 You can define a new alias with the @samp{alias} command.
24428 @item alias [-a] [--] @var{ALIAS} = @var{COMMAND}
24432 @var{ALIAS} specifies the name of the new alias.
24433 Each word of @var{ALIAS} must consist of letters, numbers, dashes and
24436 @var{COMMAND} specifies the name of an existing command
24437 that is being aliased.
24439 The @samp{-a} option specifies that the new alias is an abbreviation
24440 of the command. Abbreviations are not shown in command
24441 lists displayed by the @samp{help} command.
24443 The @samp{--} option specifies the end of options,
24444 and is useful when @var{ALIAS} begins with a dash.
24446 Here is a simple example showing how to make an abbreviation
24447 of a command so that there is less to type.
24448 Suppose you were tired of typing @samp{disas}, the current
24449 shortest unambiguous abbreviation of the @samp{disassemble} command
24450 and you wanted an even shorter version named @samp{di}.
24451 The following will accomplish this.
24454 (gdb) alias -a di = disas
24457 Note that aliases are different from user-defined commands.
24458 With a user-defined command, you also need to write documentation
24459 for it with the @samp{document} command.
24460 An alias automatically picks up the documentation of the existing command.
24462 Here is an example where we make @samp{elms} an abbreviation of
24463 @samp{elements} in the @samp{set print elements} command.
24464 This is to show that you can make an abbreviation of any part
24468 (gdb) alias -a set print elms = set print elements
24469 (gdb) alias -a show print elms = show print elements
24470 (gdb) set p elms 20
24472 Limit on string chars or array elements to print is 200.
24475 Note that if you are defining an alias of a @samp{set} command,
24476 and you want to have an alias for the corresponding @samp{show}
24477 command, then you need to define the latter separately.
24479 Unambiguously abbreviated commands are allowed in @var{COMMAND} and
24480 @var{ALIAS}, just as they are normally.
24483 (gdb) alias -a set pr elms = set p ele
24486 Finally, here is an example showing the creation of a one word
24487 alias for a more complex command.
24488 This creates alias @samp{spe} of the command @samp{set print elements}.
24491 (gdb) alias spe = set print elements
24496 @chapter Command Interpreters
24497 @cindex command interpreters
24499 @value{GDBN} supports multiple command interpreters, and some command
24500 infrastructure to allow users or user interface writers to switch
24501 between interpreters or run commands in other interpreters.
24503 @value{GDBN} currently supports two command interpreters, the console
24504 interpreter (sometimes called the command-line interpreter or @sc{cli})
24505 and the machine interface interpreter (or @sc{gdb/mi}). This manual
24506 describes both of these interfaces in great detail.
24508 By default, @value{GDBN} will start with the console interpreter.
24509 However, the user may choose to start @value{GDBN} with another
24510 interpreter by specifying the @option{-i} or @option{--interpreter}
24511 startup options. Defined interpreters include:
24515 @cindex console interpreter
24516 The traditional console or command-line interpreter. This is the most often
24517 used interpreter with @value{GDBN}. With no interpreter specified at runtime,
24518 @value{GDBN} will use this interpreter.
24521 @cindex mi interpreter
24522 The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily
24523 by programs wishing to use @value{GDBN} as a backend for a debugger GUI
24524 or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi}
24528 @cindex mi2 interpreter
24529 The current @sc{gdb/mi} interface.
24532 @cindex mi1 interpreter
24533 The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
24537 @cindex invoke another interpreter
24538 The interpreter being used by @value{GDBN} may not be dynamically
24539 switched at runtime. Although possible, this could lead to a very
24540 precarious situation. Consider an IDE using @sc{gdb/mi}. If a user
24541 enters the command "interpreter-set console" in a console view,
24542 @value{GDBN} would switch to using the console interpreter, rendering
24543 the IDE inoperable!
24545 @kindex interpreter-exec
24546 Although you may only choose a single interpreter at startup, you may execute
24547 commands in any interpreter from the current interpreter using the appropriate
24548 command. If you are running the console interpreter, simply use the
24549 @code{interpreter-exec} command:
24552 interpreter-exec mi "-data-list-register-names"
24555 @sc{gdb/mi} has a similar command, although it is only available in versions of
24556 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
24559 @chapter @value{GDBN} Text User Interface
24561 @cindex Text User Interface
24564 * TUI Overview:: TUI overview
24565 * TUI Keys:: TUI key bindings
24566 * TUI Single Key Mode:: TUI single key mode
24567 * TUI Commands:: TUI-specific commands
24568 * TUI Configuration:: TUI configuration variables
24571 The @value{GDBN} Text User Interface (TUI) is a terminal
24572 interface which uses the @code{curses} library to show the source
24573 file, the assembly output, the program registers and @value{GDBN}
24574 commands in separate text windows. The TUI mode is supported only
24575 on platforms where a suitable version of the @code{curses} library
24578 The TUI mode is enabled by default when you invoke @value{GDBN} as
24579 @samp{@value{GDBP} -tui}.
24580 You can also switch in and out of TUI mode while @value{GDBN} runs by
24581 using various TUI commands and key bindings, such as @command{tui
24582 enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and
24583 @ref{TUI Keys, ,TUI Key Bindings}.
24586 @section TUI Overview
24588 In TUI mode, @value{GDBN} can display several text windows:
24592 This window is the @value{GDBN} command window with the @value{GDBN}
24593 prompt and the @value{GDBN} output. The @value{GDBN} input is still
24594 managed using readline.
24597 The source window shows the source file of the program. The current
24598 line and active breakpoints are displayed in this window.
24601 The assembly window shows the disassembly output of the program.
24604 This window shows the processor registers. Registers are highlighted
24605 when their values change.
24608 The source and assembly windows show the current program position
24609 by highlighting the current line and marking it with a @samp{>} marker.
24610 Breakpoints are indicated with two markers. The first marker
24611 indicates the breakpoint type:
24615 Breakpoint which was hit at least once.
24618 Breakpoint which was never hit.
24621 Hardware breakpoint which was hit at least once.
24624 Hardware breakpoint which was never hit.
24627 The second marker indicates whether the breakpoint is enabled or not:
24631 Breakpoint is enabled.
24634 Breakpoint is disabled.
24637 The source, assembly and register windows are updated when the current
24638 thread changes, when the frame changes, or when the program counter
24641 These windows are not all visible at the same time. The command
24642 window is always visible. The others can be arranged in several
24653 source and assembly,
24656 source and registers, or
24659 assembly and registers.
24662 A status line above the command window shows the following information:
24666 Indicates the current @value{GDBN} target.
24667 (@pxref{Targets, ,Specifying a Debugging Target}).
24670 Gives the current process or thread number.
24671 When no process is being debugged, this field is set to @code{No process}.
24674 Gives the current function name for the selected frame.
24675 The name is demangled if demangling is turned on (@pxref{Print Settings}).
24676 When there is no symbol corresponding to the current program counter,
24677 the string @code{??} is displayed.
24680 Indicates the current line number for the selected frame.
24681 When the current line number is not known, the string @code{??} is displayed.
24684 Indicates the current program counter address.
24688 @section TUI Key Bindings
24689 @cindex TUI key bindings
24691 The TUI installs several key bindings in the readline keymaps
24692 @ifset SYSTEM_READLINE
24693 (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}).
24695 @ifclear SYSTEM_READLINE
24696 (@pxref{Command Line Editing}).
24698 The following key bindings are installed for both TUI mode and the
24699 @value{GDBN} standard mode.
24708 Enter or leave the TUI mode. When leaving the TUI mode,
24709 the curses window management stops and @value{GDBN} operates using
24710 its standard mode, writing on the terminal directly. When reentering
24711 the TUI mode, control is given back to the curses windows.
24712 The screen is then refreshed.
24716 Use a TUI layout with only one window. The layout will
24717 either be @samp{source} or @samp{assembly}. When the TUI mode
24718 is not active, it will switch to the TUI mode.
24720 Think of this key binding as the Emacs @kbd{C-x 1} binding.
24724 Use a TUI layout with at least two windows. When the current
24725 layout already has two windows, the next layout with two windows is used.
24726 When a new layout is chosen, one window will always be common to the
24727 previous layout and the new one.
24729 Think of it as the Emacs @kbd{C-x 2} binding.
24733 Change the active window. The TUI associates several key bindings
24734 (like scrolling and arrow keys) with the active window. This command
24735 gives the focus to the next TUI window.
24737 Think of it as the Emacs @kbd{C-x o} binding.
24741 Switch in and out of the TUI SingleKey mode that binds single
24742 keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}).
24745 The following key bindings only work in the TUI mode:
24750 Scroll the active window one page up.
24754 Scroll the active window one page down.
24758 Scroll the active window one line up.
24762 Scroll the active window one line down.
24766 Scroll the active window one column left.
24770 Scroll the active window one column right.
24774 Refresh the screen.
24777 Because the arrow keys scroll the active window in the TUI mode, they
24778 are not available for their normal use by readline unless the command
24779 window has the focus. When another window is active, you must use
24780 other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b}
24781 and @kbd{C-f} to control the command window.
24783 @node TUI Single Key Mode
24784 @section TUI Single Key Mode
24785 @cindex TUI single key mode
24787 The TUI also provides a @dfn{SingleKey} mode, which binds several
24788 frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to
24789 switch into this mode, where the following key bindings are used:
24792 @kindex c @r{(SingleKey TUI key)}
24796 @kindex d @r{(SingleKey TUI key)}
24800 @kindex f @r{(SingleKey TUI key)}
24804 @kindex n @r{(SingleKey TUI key)}
24808 @kindex q @r{(SingleKey TUI key)}
24810 exit the SingleKey mode.
24812 @kindex r @r{(SingleKey TUI key)}
24816 @kindex s @r{(SingleKey TUI key)}
24820 @kindex u @r{(SingleKey TUI key)}
24824 @kindex v @r{(SingleKey TUI key)}
24828 @kindex w @r{(SingleKey TUI key)}
24833 Other keys temporarily switch to the @value{GDBN} command prompt.
24834 The key that was pressed is inserted in the editing buffer so that
24835 it is possible to type most @value{GDBN} commands without interaction
24836 with the TUI SingleKey mode. Once the command is entered the TUI
24837 SingleKey mode is restored. The only way to permanently leave
24838 this mode is by typing @kbd{q} or @kbd{C-x s}.
24842 @section TUI-specific Commands
24843 @cindex TUI commands
24845 The TUI has specific commands to control the text windows.
24846 These commands are always available, even when @value{GDBN} is not in
24847 the TUI mode. When @value{GDBN} is in the standard mode, most
24848 of these commands will automatically switch to the TUI mode.
24850 Note that if @value{GDBN}'s @code{stdout} is not connected to a
24851 terminal, or @value{GDBN} has been started with the machine interface
24852 interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of
24853 these commands will fail with an error, because it would not be
24854 possible or desirable to enable curses window management.
24859 Activate TUI mode. The last active TUI window layout will be used if
24860 TUI mode has prevsiouly been used in the current debugging session,
24861 otherwise a default layout is used.
24864 @kindex tui disable
24865 Disable TUI mode, returning to the console interpreter.
24869 List and give the size of all displayed windows.
24871 @item layout @var{name}
24873 Changes which TUI windows are displayed. In each layout the command
24874 window is always displayed, the @var{name} parameter controls which
24875 additional windows are displayed, and can be any of the following:
24879 Display the next layout.
24882 Display the previous layout.
24885 Display the source and command windows.
24888 Display the assembly and command windows.
24891 Display the source, assembly, and command windows.
24894 When in @code{src} layout display the register, source, and command
24895 windows. When in @code{asm} or @code{split} layout display the
24896 register, assembler, and command windows.
24899 @item focus @var{name}
24901 Changes which TUI window is currently active for scrolling. The
24902 @var{name} parameter can be any of the following:
24906 Make the next window active for scrolling.
24909 Make the previous window active for scrolling.
24912 Make the source window active for scrolling.
24915 Make the assembly window active for scrolling.
24918 Make the register window active for scrolling.
24921 Make the command window active for scrolling.
24926 Refresh the screen. This is similar to typing @kbd{C-L}.
24928 @item tui reg @var{group}
24930 Changes the register group displayed in the tui register window to
24931 @var{group}. If the register window is not currently displayed this
24932 command will cause the register window to be displayed. The list of
24933 register groups, as well as their order is target specific. The
24934 following groups are available on most targets:
24937 Repeatedly selecting this group will cause the display to cycle
24938 through all of the available register groups.
24941 Repeatedly selecting this group will cause the display to cycle
24942 through all of the available register groups in the reverse order to
24946 Display the general registers.
24948 Display the floating point registers.
24950 Display the system registers.
24952 Display the vector registers.
24954 Display all registers.
24959 Update the source window and the current execution point.
24961 @item winheight @var{name} +@var{count}
24962 @itemx winheight @var{name} -@var{count}
24964 Change the height of the window @var{name} by @var{count}
24965 lines. Positive counts increase the height, while negative counts
24966 decrease it. The @var{name} parameter can be one of @code{src} (the
24967 source window), @code{cmd} (the command window), @code{asm} (the
24968 disassembly window), or @code{regs} (the register display window).
24970 @item tabset @var{nchars}
24972 Set the width of tab stops to be @var{nchars} characters. This
24973 setting affects the display of TAB characters in the source and
24977 @node TUI Configuration
24978 @section TUI Configuration Variables
24979 @cindex TUI configuration variables
24981 Several configuration variables control the appearance of TUI windows.
24984 @item set tui border-kind @var{kind}
24985 @kindex set tui border-kind
24986 Select the border appearance for the source, assembly and register windows.
24987 The possible values are the following:
24990 Use a space character to draw the border.
24993 Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border.
24996 Use the Alternate Character Set to draw the border. The border is
24997 drawn using character line graphics if the terminal supports them.
25000 @item set tui border-mode @var{mode}
25001 @kindex set tui border-mode
25002 @itemx set tui active-border-mode @var{mode}
25003 @kindex set tui active-border-mode
25004 Select the display attributes for the borders of the inactive windows
25005 or the active window. The @var{mode} can be one of the following:
25008 Use normal attributes to display the border.
25014 Use reverse video mode.
25017 Use half bright mode.
25019 @item half-standout
25020 Use half bright and standout mode.
25023 Use extra bright or bold mode.
25025 @item bold-standout
25026 Use extra bright or bold and standout mode.
25031 @chapter Using @value{GDBN} under @sc{gnu} Emacs
25034 @cindex @sc{gnu} Emacs
25035 A special interface allows you to use @sc{gnu} Emacs to view (and
25036 edit) the source files for the program you are debugging with
25039 To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the
25040 executable file you want to debug as an argument. This command starts
25041 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
25042 created Emacs buffer.
25043 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
25045 Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two
25050 All ``terminal'' input and output goes through an Emacs buffer, called
25053 This applies both to @value{GDBN} commands and their output, and to the input
25054 and output done by the program you are debugging.
25056 This is useful because it means that you can copy the text of previous
25057 commands and input them again; you can even use parts of the output
25060 All the facilities of Emacs' Shell mode are available for interacting
25061 with your program. In particular, you can send signals the usual
25062 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
25066 @value{GDBN} displays source code through Emacs.
25068 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
25069 source file for that frame and puts an arrow (@samp{=>}) at the
25070 left margin of the current line. Emacs uses a separate buffer for
25071 source display, and splits the screen to show both your @value{GDBN} session
25074 Explicit @value{GDBN} @code{list} or search commands still produce output as
25075 usual, but you probably have no reason to use them from Emacs.
25078 We call this @dfn{text command mode}. Emacs 22.1, and later, also uses
25079 a graphical mode, enabled by default, which provides further buffers
25080 that can control the execution and describe the state of your program.
25081 @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}.
25083 If you specify an absolute file name when prompted for the @kbd{M-x
25084 gdb} argument, then Emacs sets your current working directory to where
25085 your program resides. If you only specify the file name, then Emacs
25086 sets your current working directory to the directory associated
25087 with the previous buffer. In this case, @value{GDBN} may find your
25088 program by searching your environment's @code{PATH} variable, but on
25089 some operating systems it might not find the source. So, although the
25090 @value{GDBN} input and output session proceeds normally, the auxiliary
25091 buffer does not display the current source and line of execution.
25093 The initial working directory of @value{GDBN} is printed on the top
25094 line of the GUD buffer and this serves as a default for the commands
25095 that specify files for @value{GDBN} to operate on. @xref{Files,
25096 ,Commands to Specify Files}.
25098 By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you
25099 need to call @value{GDBN} by a different name (for example, if you
25100 keep several configurations around, with different names) you can
25101 customize the Emacs variable @code{gud-gdb-command-name} to run the
25104 In the GUD buffer, you can use these special Emacs commands in
25105 addition to the standard Shell mode commands:
25109 Describe the features of Emacs' GUD Mode.
25112 Execute to another source line, like the @value{GDBN} @code{step} command; also
25113 update the display window to show the current file and location.
25116 Execute to next source line in this function, skipping all function
25117 calls, like the @value{GDBN} @code{next} command. Then update the display window
25118 to show the current file and location.
25121 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
25122 display window accordingly.
25125 Execute until exit from the selected stack frame, like the @value{GDBN}
25126 @code{finish} command.
25129 Continue execution of your program, like the @value{GDBN} @code{continue}
25133 Go up the number of frames indicated by the numeric argument
25134 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
25135 like the @value{GDBN} @code{up} command.
25138 Go down the number of frames indicated by the numeric argument, like the
25139 @value{GDBN} @code{down} command.
25142 In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break})
25143 tells @value{GDBN} to set a breakpoint on the source line point is on.
25145 In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a
25146 separate frame which shows a backtrace when the GUD buffer is current.
25147 Move point to any frame in the stack and type @key{RET} to make it
25148 become the current frame and display the associated source in the
25149 source buffer. Alternatively, click @kbd{Mouse-2} to make the
25150 selected frame become the current one. In graphical mode, the
25151 speedbar displays watch expressions.
25153 If you accidentally delete the source-display buffer, an easy way to get
25154 it back is to type the command @code{f} in the @value{GDBN} buffer, to
25155 request a frame display; when you run under Emacs, this recreates
25156 the source buffer if necessary to show you the context of the current
25159 The source files displayed in Emacs are in ordinary Emacs buffers
25160 which are visiting the source files in the usual way. You can edit
25161 the files with these buffers if you wish; but keep in mind that @value{GDBN}
25162 communicates with Emacs in terms of line numbers. If you add or
25163 delete lines from the text, the line numbers that @value{GDBN} knows cease
25164 to correspond properly with the code.
25166 A more detailed description of Emacs' interaction with @value{GDBN} is
25167 given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu}
25171 @chapter The @sc{gdb/mi} Interface
25173 @unnumberedsec Function and Purpose
25175 @cindex @sc{gdb/mi}, its purpose
25176 @sc{gdb/mi} is a line based machine oriented text interface to
25177 @value{GDBN} and is activated by specifying using the
25178 @option{--interpreter} command line option (@pxref{Mode Options}). It
25179 is specifically intended to support the development of systems which
25180 use the debugger as just one small component of a larger system.
25182 This chapter is a specification of the @sc{gdb/mi} interface. It is written
25183 in the form of a reference manual.
25185 Note that @sc{gdb/mi} is still under construction, so some of the
25186 features described below are incomplete and subject to change
25187 (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}).
25189 @unnumberedsec Notation and Terminology
25191 @cindex notational conventions, for @sc{gdb/mi}
25192 This chapter uses the following notation:
25196 @code{|} separates two alternatives.
25199 @code{[ @var{something} ]} indicates that @var{something} is optional:
25200 it may or may not be given.
25203 @code{( @var{group} )*} means that @var{group} inside the parentheses
25204 may repeat zero or more times.
25207 @code{( @var{group} )+} means that @var{group} inside the parentheses
25208 may repeat one or more times.
25211 @code{"@var{string}"} means a literal @var{string}.
25215 @heading Dependencies
25219 * GDB/MI General Design::
25220 * GDB/MI Command Syntax::
25221 * GDB/MI Compatibility with CLI::
25222 * GDB/MI Development and Front Ends::
25223 * GDB/MI Output Records::
25224 * GDB/MI Simple Examples::
25225 * GDB/MI Command Description Format::
25226 * GDB/MI Breakpoint Commands::
25227 * GDB/MI Catchpoint Commands::
25228 * GDB/MI Program Context::
25229 * GDB/MI Thread Commands::
25230 * GDB/MI Ada Tasking Commands::
25231 * GDB/MI Program Execution::
25232 * GDB/MI Stack Manipulation::
25233 * GDB/MI Variable Objects::
25234 * GDB/MI Data Manipulation::
25235 * GDB/MI Tracepoint Commands::
25236 * GDB/MI Symbol Query::
25237 * GDB/MI File Commands::
25239 * GDB/MI Kod Commands::
25240 * GDB/MI Memory Overlay Commands::
25241 * GDB/MI Signal Handling Commands::
25243 * GDB/MI Target Manipulation::
25244 * GDB/MI File Transfer Commands::
25245 * GDB/MI Ada Exceptions Commands::
25246 * GDB/MI Support Commands::
25247 * GDB/MI Miscellaneous Commands::
25250 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25251 @node GDB/MI General Design
25252 @section @sc{gdb/mi} General Design
25253 @cindex GDB/MI General Design
25255 Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three
25256 parts---commands sent to @value{GDBN}, responses to those commands
25257 and notifications. Each command results in exactly one response,
25258 indicating either successful completion of the command, or an error.
25259 For the commands that do not resume the target, the response contains the
25260 requested information. For the commands that resume the target, the
25261 response only indicates whether the target was successfully resumed.
25262 Notifications is the mechanism for reporting changes in the state of the
25263 target, or in @value{GDBN} state, that cannot conveniently be associated with
25264 a command and reported as part of that command response.
25266 The important examples of notifications are:
25270 Exec notifications. These are used to report changes in
25271 target state---when a target is resumed, or stopped. It would not
25272 be feasible to include this information in response of resuming
25273 commands, because one resume commands can result in multiple events in
25274 different threads. Also, quite some time may pass before any event
25275 happens in the target, while a frontend needs to know whether the resuming
25276 command itself was successfully executed.
25279 Console output, and status notifications. Console output
25280 notifications are used to report output of CLI commands, as well as
25281 diagnostics for other commands. Status notifications are used to
25282 report the progress of a long-running operation. Naturally, including
25283 this information in command response would mean no output is produced
25284 until the command is finished, which is undesirable.
25287 General notifications. Commands may have various side effects on
25288 the @value{GDBN} or target state beyond their official purpose. For example,
25289 a command may change the selected thread. Although such changes can
25290 be included in command response, using notification allows for more
25291 orthogonal frontend design.
25295 There's no guarantee that whenever an MI command reports an error,
25296 @value{GDBN} or the target are in any specific state, and especially,
25297 the state is not reverted to the state before the MI command was
25298 processed. Therefore, whenever an MI command results in an error,
25299 we recommend that the frontend refreshes all the information shown in
25300 the user interface.
25304 * Context management::
25305 * Asynchronous and non-stop modes::
25309 @node Context management
25310 @subsection Context management
25312 @subsubsection Threads and Frames
25314 In most cases when @value{GDBN} accesses the target, this access is
25315 done in context of a specific thread and frame (@pxref{Frames}).
25316 Often, even when accessing global data, the target requires that a thread
25317 be specified. The CLI interface maintains the selected thread and frame,
25318 and supplies them to target on each command. This is convenient,
25319 because a command line user would not want to specify that information
25320 explicitly on each command, and because user interacts with
25321 @value{GDBN} via a single terminal, so no confusion is possible as
25322 to what thread and frame are the current ones.
25324 In the case of MI, the concept of selected thread and frame is less
25325 useful. First, a frontend can easily remember this information
25326 itself. Second, a graphical frontend can have more than one window,
25327 each one used for debugging a different thread, and the frontend might
25328 want to access additional threads for internal purposes. This
25329 increases the risk that by relying on implicitly selected thread, the
25330 frontend may be operating on a wrong one. Therefore, each MI command
25331 should explicitly specify which thread and frame to operate on. To
25332 make it possible, each MI command accepts the @samp{--thread} and
25333 @samp{--frame} options, the value to each is @value{GDBN} identifier
25334 for thread and frame to operate on.
25336 Usually, each top-level window in a frontend allows the user to select
25337 a thread and a frame, and remembers the user selection for further
25338 operations. However, in some cases @value{GDBN} may suggest that the
25339 current thread be changed. For example, when stopping on a breakpoint
25340 it is reasonable to switch to the thread where breakpoint is hit. For
25341 another example, if the user issues the CLI @samp{thread} command via
25342 the frontend, it is desirable to change the frontend's selected thread to the
25343 one specified by user. @value{GDBN} communicates the suggestion to
25344 change current thread using the @samp{=thread-selected} notification.
25345 No such notification is available for the selected frame at the moment.
25347 Note that historically, MI shares the selected thread with CLI, so
25348 frontends used the @code{-thread-select} to execute commands in the
25349 right context. However, getting this to work right is cumbersome. The
25350 simplest way is for frontend to emit @code{-thread-select} command
25351 before every command. This doubles the number of commands that need
25352 to be sent. The alternative approach is to suppress @code{-thread-select}
25353 if the selected thread in @value{GDBN} is supposed to be identical to the
25354 thread the frontend wants to operate on. However, getting this
25355 optimization right can be tricky. In particular, if the frontend
25356 sends several commands to @value{GDBN}, and one of the commands changes the
25357 selected thread, then the behaviour of subsequent commands will
25358 change. So, a frontend should either wait for response from such
25359 problematic commands, or explicitly add @code{-thread-select} for
25360 all subsequent commands. No frontend is known to do this exactly
25361 right, so it is suggested to just always pass the @samp{--thread} and
25362 @samp{--frame} options.
25364 @subsubsection Language
25366 The execution of several commands depends on which language is selected.
25367 By default, the current language (@pxref{show language}) is used.
25368 But for commands known to be language-sensitive, it is recommended
25369 to use the @samp{--language} option. This option takes one argument,
25370 which is the name of the language to use while executing the command.
25374 -data-evaluate-expression --language c "sizeof (void*)"
25379 The valid language names are the same names accepted by the
25380 @samp{set language} command (@pxref{Manually}), excluding @samp{auto},
25381 @samp{local} or @samp{unknown}.
25383 @node Asynchronous and non-stop modes
25384 @subsection Asynchronous command execution and non-stop mode
25386 On some targets, @value{GDBN} is capable of processing MI commands
25387 even while the target is running. This is called @dfn{asynchronous
25388 command execution} (@pxref{Background Execution}). The frontend may
25389 specify a preferrence for asynchronous execution using the
25390 @code{-gdb-set mi-async 1} command, which should be emitted before
25391 either running the executable or attaching to the target. After the
25392 frontend has started the executable or attached to the target, it can
25393 find if asynchronous execution is enabled using the
25394 @code{-list-target-features} command.
25397 @item -gdb-set mi-async on
25398 @item -gdb-set mi-async off
25399 Set whether MI is in asynchronous mode.
25401 When @code{off}, which is the default, MI execution commands (e.g.,
25402 @code{-exec-continue}) are foreground commands, and @value{GDBN} waits
25403 for the program to stop before processing further commands.
25405 When @code{on}, MI execution commands are background execution
25406 commands (e.g., @code{-exec-continue} becomes the equivalent of the
25407 @code{c&} CLI command), and so @value{GDBN} is capable of processing
25408 MI commands even while the target is running.
25410 @item -gdb-show mi-async
25411 Show whether MI asynchronous mode is enabled.
25414 Note: In @value{GDBN} version 7.7 and earlier, this option was called
25415 @code{target-async} instead of @code{mi-async}, and it had the effect
25416 of both putting MI in asynchronous mode and making CLI background
25417 commands possible. CLI background commands are now always possible
25418 ``out of the box'' if the target supports them. The old spelling is
25419 kept as a deprecated alias for backwards compatibility.
25421 Even if @value{GDBN} can accept a command while target is running,
25422 many commands that access the target do not work when the target is
25423 running. Therefore, asynchronous command execution is most useful
25424 when combined with non-stop mode (@pxref{Non-Stop Mode}). Then,
25425 it is possible to examine the state of one thread, while other threads
25428 When a given thread is running, MI commands that try to access the
25429 target in the context of that thread may not work, or may work only on
25430 some targets. In particular, commands that try to operate on thread's
25431 stack will not work, on any target. Commands that read memory, or
25432 modify breakpoints, may work or not work, depending on the target. Note
25433 that even commands that operate on global state, such as @code{print},
25434 @code{set}, and breakpoint commands, still access the target in the
25435 context of a specific thread, so frontend should try to find a
25436 stopped thread and perform the operation on that thread (using the
25437 @samp{--thread} option).
25439 Which commands will work in the context of a running thread is
25440 highly target dependent. However, the two commands
25441 @code{-exec-interrupt}, to stop a thread, and @code{-thread-info},
25442 to find the state of a thread, will always work.
25444 @node Thread groups
25445 @subsection Thread groups
25446 @value{GDBN} may be used to debug several processes at the same time.
25447 On some platfroms, @value{GDBN} may support debugging of several
25448 hardware systems, each one having several cores with several different
25449 processes running on each core. This section describes the MI
25450 mechanism to support such debugging scenarios.
25452 The key observation is that regardless of the structure of the
25453 target, MI can have a global list of threads, because most commands that
25454 accept the @samp{--thread} option do not need to know what process that
25455 thread belongs to. Therefore, it is not necessary to introduce
25456 neither additional @samp{--process} option, nor an notion of the
25457 current process in the MI interface. The only strictly new feature
25458 that is required is the ability to find how the threads are grouped
25461 To allow the user to discover such grouping, and to support arbitrary
25462 hierarchy of machines/cores/processes, MI introduces the concept of a
25463 @dfn{thread group}. Thread group is a collection of threads and other
25464 thread groups. A thread group always has a string identifier, a type,
25465 and may have additional attributes specific to the type. A new
25466 command, @code{-list-thread-groups}, returns the list of top-level
25467 thread groups, which correspond to processes that @value{GDBN} is
25468 debugging at the moment. By passing an identifier of a thread group
25469 to the @code{-list-thread-groups} command, it is possible to obtain
25470 the members of specific thread group.
25472 To allow the user to easily discover processes, and other objects, he
25473 wishes to debug, a concept of @dfn{available thread group} is
25474 introduced. Available thread group is an thread group that
25475 @value{GDBN} is not debugging, but that can be attached to, using the
25476 @code{-target-attach} command. The list of available top-level thread
25477 groups can be obtained using @samp{-list-thread-groups --available}.
25478 In general, the content of a thread group may be only retrieved only
25479 after attaching to that thread group.
25481 Thread groups are related to inferiors (@pxref{Inferiors and
25482 Programs}). Each inferior corresponds to a thread group of a special
25483 type @samp{process}, and some additional operations are permitted on
25484 such thread groups.
25486 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25487 @node GDB/MI Command Syntax
25488 @section @sc{gdb/mi} Command Syntax
25491 * GDB/MI Input Syntax::
25492 * GDB/MI Output Syntax::
25495 @node GDB/MI Input Syntax
25496 @subsection @sc{gdb/mi} Input Syntax
25498 @cindex input syntax for @sc{gdb/mi}
25499 @cindex @sc{gdb/mi}, input syntax
25501 @item @var{command} @expansion{}
25502 @code{@var{cli-command} | @var{mi-command}}
25504 @item @var{cli-command} @expansion{}
25505 @code{[ @var{token} ] @var{cli-command} @var{nl}}, where
25506 @var{cli-command} is any existing @value{GDBN} CLI command.
25508 @item @var{mi-command} @expansion{}
25509 @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*
25510 @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
25512 @item @var{token} @expansion{}
25513 "any sequence of digits"
25515 @item @var{option} @expansion{}
25516 @code{"-" @var{parameter} [ " " @var{parameter} ]}
25518 @item @var{parameter} @expansion{}
25519 @code{@var{non-blank-sequence} | @var{c-string}}
25521 @item @var{operation} @expansion{}
25522 @emph{any of the operations described in this chapter}
25524 @item @var{non-blank-sequence} @expansion{}
25525 @emph{anything, provided it doesn't contain special characters such as
25526 "-", @var{nl}, """ and of course " "}
25528 @item @var{c-string} @expansion{}
25529 @code{""" @var{seven-bit-iso-c-string-content} """}
25531 @item @var{nl} @expansion{}
25540 The CLI commands are still handled by the @sc{mi} interpreter; their
25541 output is described below.
25544 The @code{@var{token}}, when present, is passed back when the command
25548 Some @sc{mi} commands accept optional arguments as part of the parameter
25549 list. Each option is identified by a leading @samp{-} (dash) and may be
25550 followed by an optional argument parameter. Options occur first in the
25551 parameter list and can be delimited from normal parameters using
25552 @samp{--} (this is useful when some parameters begin with a dash).
25559 We want easy access to the existing CLI syntax (for debugging).
25562 We want it to be easy to spot a @sc{mi} operation.
25565 @node GDB/MI Output Syntax
25566 @subsection @sc{gdb/mi} Output Syntax
25568 @cindex output syntax of @sc{gdb/mi}
25569 @cindex @sc{gdb/mi}, output syntax
25570 The output from @sc{gdb/mi} consists of zero or more out-of-band records
25571 followed, optionally, by a single result record. This result record
25572 is for the most recent command. The sequence of output records is
25573 terminated by @samp{(gdb)}.
25575 If an input command was prefixed with a @code{@var{token}} then the
25576 corresponding output for that command will also be prefixed by that same
25580 @item @var{output} @expansion{}
25581 @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}
25583 @item @var{result-record} @expansion{}
25584 @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}
25586 @item @var{out-of-band-record} @expansion{}
25587 @code{@var{async-record} | @var{stream-record}}
25589 @item @var{async-record} @expansion{}
25590 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
25592 @item @var{exec-async-output} @expansion{}
25593 @code{[ @var{token} ] "*" @var{async-output nl}}
25595 @item @var{status-async-output} @expansion{}
25596 @code{[ @var{token} ] "+" @var{async-output nl}}
25598 @item @var{notify-async-output} @expansion{}
25599 @code{[ @var{token} ] "=" @var{async-output nl}}
25601 @item @var{async-output} @expansion{}
25602 @code{@var{async-class} ( "," @var{result} )*}
25604 @item @var{result-class} @expansion{}
25605 @code{"done" | "running" | "connected" | "error" | "exit"}
25607 @item @var{async-class} @expansion{}
25608 @code{"stopped" | @var{others}} (where @var{others} will be added
25609 depending on the needs---this is still in development).
25611 @item @var{result} @expansion{}
25612 @code{ @var{variable} "=" @var{value}}
25614 @item @var{variable} @expansion{}
25615 @code{ @var{string} }
25617 @item @var{value} @expansion{}
25618 @code{ @var{const} | @var{tuple} | @var{list} }
25620 @item @var{const} @expansion{}
25621 @code{@var{c-string}}
25623 @item @var{tuple} @expansion{}
25624 @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" }
25626 @item @var{list} @expansion{}
25627 @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "["
25628 @var{result} ( "," @var{result} )* "]" }
25630 @item @var{stream-record} @expansion{}
25631 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
25633 @item @var{console-stream-output} @expansion{}
25634 @code{"~" @var{c-string nl}}
25636 @item @var{target-stream-output} @expansion{}
25637 @code{"@@" @var{c-string nl}}
25639 @item @var{log-stream-output} @expansion{}
25640 @code{"&" @var{c-string nl}}
25642 @item @var{nl} @expansion{}
25645 @item @var{token} @expansion{}
25646 @emph{any sequence of digits}.
25654 All output sequences end in a single line containing a period.
25657 The @code{@var{token}} is from the corresponding request. Note that
25658 for all async output, while the token is allowed by the grammar and
25659 may be output by future versions of @value{GDBN} for select async
25660 output messages, it is generally omitted. Frontends should treat
25661 all async output as reporting general changes in the state of the
25662 target and there should be no need to associate async output to any
25666 @cindex status output in @sc{gdb/mi}
25667 @var{status-async-output} contains on-going status information about the
25668 progress of a slow operation. It can be discarded. All status output is
25669 prefixed by @samp{+}.
25672 @cindex async output in @sc{gdb/mi}
25673 @var{exec-async-output} contains asynchronous state change on the target
25674 (stopped, started, disappeared). All async output is prefixed by
25678 @cindex notify output in @sc{gdb/mi}
25679 @var{notify-async-output} contains supplementary information that the
25680 client should handle (e.g., a new breakpoint information). All notify
25681 output is prefixed by @samp{=}.
25684 @cindex console output in @sc{gdb/mi}
25685 @var{console-stream-output} is output that should be displayed as is in the
25686 console. It is the textual response to a CLI command. All the console
25687 output is prefixed by @samp{~}.
25690 @cindex target output in @sc{gdb/mi}
25691 @var{target-stream-output} is the output produced by the target program.
25692 All the target output is prefixed by @samp{@@}.
25695 @cindex log output in @sc{gdb/mi}
25696 @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for
25697 instance messages that should be displayed as part of an error log. All
25698 the log output is prefixed by @samp{&}.
25701 @cindex list output in @sc{gdb/mi}
25702 New @sc{gdb/mi} commands should only output @var{lists} containing
25708 @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more
25709 details about the various output records.
25711 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25712 @node GDB/MI Compatibility with CLI
25713 @section @sc{gdb/mi} Compatibility with CLI
25715 @cindex compatibility, @sc{gdb/mi} and CLI
25716 @cindex @sc{gdb/mi}, compatibility with CLI
25718 For the developers convenience CLI commands can be entered directly,
25719 but there may be some unexpected behaviour. For example, commands
25720 that query the user will behave as if the user replied yes, breakpoint
25721 command lists are not executed and some CLI commands, such as
25722 @code{if}, @code{when} and @code{define}, prompt for further input with
25723 @samp{>}, which is not valid MI output.
25725 This feature may be removed at some stage in the future and it is
25726 recommended that front ends use the @code{-interpreter-exec} command
25727 (@pxref{-interpreter-exec}).
25729 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25730 @node GDB/MI Development and Front Ends
25731 @section @sc{gdb/mi} Development and Front Ends
25732 @cindex @sc{gdb/mi} development
25734 The application which takes the MI output and presents the state of the
25735 program being debugged to the user is called a @dfn{front end}.
25737 Although @sc{gdb/mi} is still incomplete, it is currently being used
25738 by a variety of front ends to @value{GDBN}. This makes it difficult
25739 to introduce new functionality without breaking existing usage. This
25740 section tries to minimize the problems by describing how the protocol
25743 Some changes in MI need not break a carefully designed front end, and
25744 for these the MI version will remain unchanged. The following is a
25745 list of changes that may occur within one level, so front ends should
25746 parse MI output in a way that can handle them:
25750 New MI commands may be added.
25753 New fields may be added to the output of any MI command.
25756 The range of values for fields with specified values, e.g.,
25757 @code{in_scope} (@pxref{-var-update}) may be extended.
25759 @c The format of field's content e.g type prefix, may change so parse it
25760 @c at your own risk. Yes, in general?
25762 @c The order of fields may change? Shouldn't really matter but it might
25763 @c resolve inconsistencies.
25766 If the changes are likely to break front ends, the MI version level
25767 will be increased by one. This will allow the front end to parse the
25768 output according to the MI version. Apart from mi0, new versions of
25769 @value{GDBN} will not support old versions of MI and it will be the
25770 responsibility of the front end to work with the new one.
25772 @c Starting with mi3, add a new command -mi-version that prints the MI
25775 The best way to avoid unexpected changes in MI that might break your front
25776 end is to make your project known to @value{GDBN} developers and
25777 follow development on @email{gdb@@sourceware.org} and
25778 @email{gdb-patches@@sourceware.org}.
25779 @cindex mailing lists
25781 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25782 @node GDB/MI Output Records
25783 @section @sc{gdb/mi} Output Records
25786 * GDB/MI Result Records::
25787 * GDB/MI Stream Records::
25788 * GDB/MI Async Records::
25789 * GDB/MI Breakpoint Information::
25790 * GDB/MI Frame Information::
25791 * GDB/MI Thread Information::
25792 * GDB/MI Ada Exception Information::
25795 @node GDB/MI Result Records
25796 @subsection @sc{gdb/mi} Result Records
25798 @cindex result records in @sc{gdb/mi}
25799 @cindex @sc{gdb/mi}, result records
25800 In addition to a number of out-of-band notifications, the response to a
25801 @sc{gdb/mi} command includes one of the following result indications:
25805 @item "^done" [ "," @var{results} ]
25806 The synchronous operation was successful, @code{@var{results}} are the return
25811 This result record is equivalent to @samp{^done}. Historically, it
25812 was output instead of @samp{^done} if the command has resumed the
25813 target. This behaviour is maintained for backward compatibility, but
25814 all frontends should treat @samp{^done} and @samp{^running}
25815 identically and rely on the @samp{*running} output record to determine
25816 which threads are resumed.
25820 @value{GDBN} has connected to a remote target.
25822 @item "^error" "," "msg=" @var{c-string} [ "," "code=" @var{c-string} ]
25824 The operation failed. The @code{msg=@var{c-string}} variable contains
25825 the corresponding error message.
25827 If present, the @code{code=@var{c-string}} variable provides an error
25828 code on which consumers can rely on to detect the corresponding
25829 error condition. At present, only one error code is defined:
25832 @item "undefined-command"
25833 Indicates that the command causing the error does not exist.
25838 @value{GDBN} has terminated.
25842 @node GDB/MI Stream Records
25843 @subsection @sc{gdb/mi} Stream Records
25845 @cindex @sc{gdb/mi}, stream records
25846 @cindex stream records in @sc{gdb/mi}
25847 @value{GDBN} internally maintains a number of output streams: the console, the
25848 target, and the log. The output intended for each of these streams is
25849 funneled through the @sc{gdb/mi} interface using @dfn{stream records}.
25851 Each stream record begins with a unique @dfn{prefix character} which
25852 identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output
25853 Syntax}). In addition to the prefix, each stream record contains a
25854 @code{@var{string-output}}. This is either raw text (with an implicit new
25855 line) or a quoted C string (which does not contain an implicit newline).
25858 @item "~" @var{string-output}
25859 The console output stream contains text that should be displayed in the
25860 CLI console window. It contains the textual responses to CLI commands.
25862 @item "@@" @var{string-output}
25863 The target output stream contains any textual output from the running
25864 target. This is only present when GDB's event loop is truly
25865 asynchronous, which is currently only the case for remote targets.
25867 @item "&" @var{string-output}
25868 The log stream contains debugging messages being produced by @value{GDBN}'s
25872 @node GDB/MI Async Records
25873 @subsection @sc{gdb/mi} Async Records
25875 @cindex async records in @sc{gdb/mi}
25876 @cindex @sc{gdb/mi}, async records
25877 @dfn{Async} records are used to notify the @sc{gdb/mi} client of
25878 additional changes that have occurred. Those changes can either be a
25879 consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of
25880 target activity (e.g., target stopped).
25882 The following is the list of possible async records:
25886 @item *running,thread-id="@var{thread}"
25887 The target is now running. The @var{thread} field tells which
25888 specific thread is now running, and can be @samp{all} if all threads
25889 are running. The frontend should assume that no interaction with a
25890 running thread is possible after this notification is produced.
25891 The frontend should not assume that this notification is output
25892 only once for any command. @value{GDBN} may emit this notification
25893 several times, either for different threads, because it cannot resume
25894 all threads together, or even for a single thread, if the thread must
25895 be stepped though some code before letting it run freely.
25897 @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}"
25898 The target has stopped. The @var{reason} field can have one of the
25902 @item breakpoint-hit
25903 A breakpoint was reached.
25904 @item watchpoint-trigger
25905 A watchpoint was triggered.
25906 @item read-watchpoint-trigger
25907 A read watchpoint was triggered.
25908 @item access-watchpoint-trigger
25909 An access watchpoint was triggered.
25910 @item function-finished
25911 An -exec-finish or similar CLI command was accomplished.
25912 @item location-reached
25913 An -exec-until or similar CLI command was accomplished.
25914 @item watchpoint-scope
25915 A watchpoint has gone out of scope.
25916 @item end-stepping-range
25917 An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or
25918 similar CLI command was accomplished.
25919 @item exited-signalled
25920 The inferior exited because of a signal.
25922 The inferior exited.
25923 @item exited-normally
25924 The inferior exited normally.
25925 @item signal-received
25926 A signal was received by the inferior.
25928 The inferior has stopped due to a library being loaded or unloaded.
25929 This can happen when @code{stop-on-solib-events} (@pxref{Files}) is
25930 set or when a @code{catch load} or @code{catch unload} catchpoint is
25931 in use (@pxref{Set Catchpoints}).
25933 The inferior has forked. This is reported when @code{catch fork}
25934 (@pxref{Set Catchpoints}) has been used.
25936 The inferior has vforked. This is reported in when @code{catch vfork}
25937 (@pxref{Set Catchpoints}) has been used.
25938 @item syscall-entry
25939 The inferior entered a system call. This is reported when @code{catch
25940 syscall} (@pxref{Set Catchpoints}) has been used.
25941 @item syscall-return
25942 The inferior returned from a system call. This is reported when
25943 @code{catch syscall} (@pxref{Set Catchpoints}) has been used.
25945 The inferior called @code{exec}. This is reported when @code{catch exec}
25946 (@pxref{Set Catchpoints}) has been used.
25949 The @var{id} field identifies the thread that directly caused the stop
25950 -- for example by hitting a breakpoint. Depending on whether all-stop
25951 mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either
25952 stop all threads, or only the thread that directly triggered the stop.
25953 If all threads are stopped, the @var{stopped} field will have the
25954 value of @code{"all"}. Otherwise, the value of the @var{stopped}
25955 field will be a list of thread identifiers. Presently, this list will
25956 always include a single thread, but frontend should be prepared to see
25957 several threads in the list. The @var{core} field reports the
25958 processor core on which the stop event has happened. This field may be absent
25959 if such information is not available.
25961 @item =thread-group-added,id="@var{id}"
25962 @itemx =thread-group-removed,id="@var{id}"
25963 A thread group was either added or removed. The @var{id} field
25964 contains the @value{GDBN} identifier of the thread group. When a thread
25965 group is added, it generally might not be associated with a running
25966 process. When a thread group is removed, its id becomes invalid and
25967 cannot be used in any way.
25969 @item =thread-group-started,id="@var{id}",pid="@var{pid}"
25970 A thread group became associated with a running program,
25971 either because the program was just started or the thread group
25972 was attached to a program. The @var{id} field contains the
25973 @value{GDBN} identifier of the thread group. The @var{pid} field
25974 contains process identifier, specific to the operating system.
25976 @item =thread-group-exited,id="@var{id}"[,exit-code="@var{code}"]
25977 A thread group is no longer associated with a running program,
25978 either because the program has exited, or because it was detached
25979 from. The @var{id} field contains the @value{GDBN} identifier of the
25980 thread group. The @var{code} field is the exit code of the inferior; it exists
25981 only when the inferior exited with some code.
25983 @item =thread-created,id="@var{id}",group-id="@var{gid}"
25984 @itemx =thread-exited,id="@var{id}",group-id="@var{gid}"
25985 A thread either was created, or has exited. The @var{id} field
25986 contains the @value{GDBN} identifier of the thread. The @var{gid}
25987 field identifies the thread group this thread belongs to.
25989 @item =thread-selected,id="@var{id}"
25990 Informs that the selected thread was changed as result of the last
25991 command. This notification is not emitted as result of @code{-thread-select}
25992 command but is emitted whenever an MI command that is not documented
25993 to change the selected thread actually changes it. In particular,
25994 invoking, directly or indirectly (via user-defined command), the CLI
25995 @code{thread} command, will generate this notification.
25997 We suggest that in response to this notification, front ends
25998 highlight the selected thread and cause subsequent commands to apply to
26001 @item =library-loaded,...
26002 Reports that a new library file was loaded by the program. This
26003 notification has 4 fields---@var{id}, @var{target-name},
26004 @var{host-name}, and @var{symbols-loaded}. The @var{id} field is an
26005 opaque identifier of the library. For remote debugging case,
26006 @var{target-name} and @var{host-name} fields give the name of the
26007 library file on the target, and on the host respectively. For native
26008 debugging, both those fields have the same value. The
26009 @var{symbols-loaded} field is emitted only for backward compatibility
26010 and should not be relied on to convey any useful information. The
26011 @var{thread-group} field, if present, specifies the id of the thread
26012 group in whose context the library was loaded. If the field is
26013 absent, it means the library was loaded in the context of all present
26016 @item =library-unloaded,...
26017 Reports that a library was unloaded by the program. This notification
26018 has 3 fields---@var{id}, @var{target-name} and @var{host-name} with
26019 the same meaning as for the @code{=library-loaded} notification.
26020 The @var{thread-group} field, if present, specifies the id of the
26021 thread group in whose context the library was unloaded. If the field is
26022 absent, it means the library was unloaded in the context of all present
26025 @item =traceframe-changed,num=@var{tfnum},tracepoint=@var{tpnum}
26026 @itemx =traceframe-changed,end
26027 Reports that the trace frame was changed and its new number is
26028 @var{tfnum}. The number of the tracepoint associated with this trace
26029 frame is @var{tpnum}.
26031 @item =tsv-created,name=@var{name},initial=@var{initial}
26032 Reports that the new trace state variable @var{name} is created with
26033 initial value @var{initial}.
26035 @item =tsv-deleted,name=@var{name}
26036 @itemx =tsv-deleted
26037 Reports that the trace state variable @var{name} is deleted or all
26038 trace state variables are deleted.
26040 @item =tsv-modified,name=@var{name},initial=@var{initial}[,current=@var{current}]
26041 Reports that the trace state variable @var{name} is modified with
26042 the initial value @var{initial}. The current value @var{current} of
26043 trace state variable is optional and is reported if the current
26044 value of trace state variable is known.
26046 @item =breakpoint-created,bkpt=@{...@}
26047 @itemx =breakpoint-modified,bkpt=@{...@}
26048 @itemx =breakpoint-deleted,id=@var{number}
26049 Reports that a breakpoint was created, modified, or deleted,
26050 respectively. Only user-visible breakpoints are reported to the MI
26053 The @var{bkpt} argument is of the same form as returned by the various
26054 breakpoint commands; @xref{GDB/MI Breakpoint Commands}. The
26055 @var{number} is the ordinal number of the breakpoint.
26057 Note that if a breakpoint is emitted in the result record of a
26058 command, then it will not also be emitted in an async record.
26060 @item =record-started,thread-group="@var{id}"
26061 @itemx =record-stopped,thread-group="@var{id}"
26062 Execution log recording was either started or stopped on an
26063 inferior. The @var{id} is the @value{GDBN} identifier of the thread
26064 group corresponding to the affected inferior.
26066 @item =cmd-param-changed,param=@var{param},value=@var{value}
26067 Reports that a parameter of the command @code{set @var{param}} is
26068 changed to @var{value}. In the multi-word @code{set} command,
26069 the @var{param} is the whole parameter list to @code{set} command.
26070 For example, In command @code{set check type on}, @var{param}
26071 is @code{check type} and @var{value} is @code{on}.
26073 @item =memory-changed,thread-group=@var{id},addr=@var{addr},len=@var{len}[,type="code"]
26074 Reports that bytes from @var{addr} to @var{data} + @var{len} were
26075 written in an inferior. The @var{id} is the identifier of the
26076 thread group corresponding to the affected inferior. The optional
26077 @code{type="code"} part is reported if the memory written to holds
26081 @node GDB/MI Breakpoint Information
26082 @subsection @sc{gdb/mi} Breakpoint Information
26084 When @value{GDBN} reports information about a breakpoint, a
26085 tracepoint, a watchpoint, or a catchpoint, it uses a tuple with the
26090 The breakpoint number. For a breakpoint that represents one location
26091 of a multi-location breakpoint, this will be a dotted pair, like
26095 The type of the breakpoint. For ordinary breakpoints this will be
26096 @samp{breakpoint}, but many values are possible.
26099 If the type of the breakpoint is @samp{catchpoint}, then this
26100 indicates the exact type of catchpoint.
26103 This is the breakpoint disposition---either @samp{del}, meaning that
26104 the breakpoint will be deleted at the next stop, or @samp{keep},
26105 meaning that the breakpoint will not be deleted.
26108 This indicates whether the breakpoint is enabled, in which case the
26109 value is @samp{y}, or disabled, in which case the value is @samp{n}.
26110 Note that this is not the same as the field @code{enable}.
26113 The address of the breakpoint. This may be a hexidecimal number,
26114 giving the address; or the string @samp{<PENDING>}, for a pending
26115 breakpoint; or the string @samp{<MULTIPLE>}, for a breakpoint with
26116 multiple locations. This field will not be present if no address can
26117 be determined. For example, a watchpoint does not have an address.
26120 If known, the function in which the breakpoint appears.
26121 If not known, this field is not present.
26124 The name of the source file which contains this function, if known.
26125 If not known, this field is not present.
26128 The full file name of the source file which contains this function, if
26129 known. If not known, this field is not present.
26132 The line number at which this breakpoint appears, if known.
26133 If not known, this field is not present.
26136 If the source file is not known, this field may be provided. If
26137 provided, this holds the address of the breakpoint, possibly followed
26141 If this breakpoint is pending, this field is present and holds the
26142 text used to set the breakpoint, as entered by the user.
26145 Where this breakpoint's condition is evaluated, either @samp{host} or
26149 If this is a thread-specific breakpoint, then this identifies the
26150 thread in which the breakpoint can trigger.
26153 If this breakpoint is restricted to a particular Ada task, then this
26154 field will hold the task identifier.
26157 If the breakpoint is conditional, this is the condition expression.
26160 The ignore count of the breakpoint.
26163 The enable count of the breakpoint.
26165 @item traceframe-usage
26168 @item static-tracepoint-marker-string-id
26169 For a static tracepoint, the name of the static tracepoint marker.
26172 For a masked watchpoint, this is the mask.
26175 A tracepoint's pass count.
26177 @item original-location
26178 The location of the breakpoint as originally specified by the user.
26179 This field is optional.
26182 The number of times the breakpoint has been hit.
26185 This field is only given for tracepoints. This is either @samp{y},
26186 meaning that the tracepoint is installed, or @samp{n}, meaning that it
26190 Some extra data, the exact contents of which are type-dependent.
26194 For example, here is what the output of @code{-break-insert}
26195 (@pxref{GDB/MI Breakpoint Commands}) might be:
26198 -> -break-insert main
26199 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26200 enabled="y",addr="0x08048564",func="main",file="myprog.c",
26201 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
26206 @node GDB/MI Frame Information
26207 @subsection @sc{gdb/mi} Frame Information
26209 Response from many MI commands includes an information about stack
26210 frame. This information is a tuple that may have the following
26215 The level of the stack frame. The innermost frame has the level of
26216 zero. This field is always present.
26219 The name of the function corresponding to the frame. This field may
26220 be absent if @value{GDBN} is unable to determine the function name.
26223 The code address for the frame. This field is always present.
26226 The name of the source files that correspond to the frame's code
26227 address. This field may be absent.
26230 The source line corresponding to the frames' code address. This field
26234 The name of the binary file (either executable or shared library) the
26235 corresponds to the frame's code address. This field may be absent.
26239 @node GDB/MI Thread Information
26240 @subsection @sc{gdb/mi} Thread Information
26242 Whenever @value{GDBN} has to report an information about a thread, it
26243 uses a tuple with the following fields:
26247 The numeric id assigned to the thread by @value{GDBN}. This field is
26251 Target-specific string identifying the thread. This field is always present.
26254 Additional information about the thread provided by the target.
26255 It is supposed to be human-readable and not interpreted by the
26256 frontend. This field is optional.
26259 Either @samp{stopped} or @samp{running}, depending on whether the
26260 thread is presently running. This field is always present.
26263 The value of this field is an integer number of the processor core the
26264 thread was last seen on. This field is optional.
26267 @node GDB/MI Ada Exception Information
26268 @subsection @sc{gdb/mi} Ada Exception Information
26270 Whenever a @code{*stopped} record is emitted because the program
26271 stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}),
26272 @value{GDBN} provides the name of the exception that was raised via
26273 the @code{exception-name} field.
26275 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26276 @node GDB/MI Simple Examples
26277 @section Simple Examples of @sc{gdb/mi} Interaction
26278 @cindex @sc{gdb/mi}, simple examples
26280 This subsection presents several simple examples of interaction using
26281 the @sc{gdb/mi} interface. In these examples, @samp{->} means that the
26282 following line is passed to @sc{gdb/mi} as input, while @samp{<-} means
26283 the output received from @sc{gdb/mi}.
26285 Note the line breaks shown in the examples are here only for
26286 readability, they don't appear in the real output.
26288 @subheading Setting a Breakpoint
26290 Setting a breakpoint generates synchronous output which contains detailed
26291 information of the breakpoint.
26294 -> -break-insert main
26295 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26296 enabled="y",addr="0x08048564",func="main",file="myprog.c",
26297 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
26302 @subheading Program Execution
26304 Program execution generates asynchronous records and MI gives the
26305 reason that execution stopped.
26311 <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
26312 frame=@{addr="0x08048564",func="main",
26313 args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}],
26314 file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@}
26319 <- *stopped,reason="exited-normally"
26323 @subheading Quitting @value{GDBN}
26325 Quitting @value{GDBN} just prints the result class @samp{^exit}.
26333 Please note that @samp{^exit} is printed immediately, but it might
26334 take some time for @value{GDBN} to actually exit. During that time, @value{GDBN}
26335 performs necessary cleanups, including killing programs being debugged
26336 or disconnecting from debug hardware, so the frontend should wait till
26337 @value{GDBN} exits and should only forcibly kill @value{GDBN} if it
26338 fails to exit in reasonable time.
26340 @subheading A Bad Command
26342 Here's what happens if you pass a non-existent command:
26346 <- ^error,msg="Undefined MI command: rubbish"
26351 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26352 @node GDB/MI Command Description Format
26353 @section @sc{gdb/mi} Command Description Format
26355 The remaining sections describe blocks of commands. Each block of
26356 commands is laid out in a fashion similar to this section.
26358 @subheading Motivation
26360 The motivation for this collection of commands.
26362 @subheading Introduction
26364 A brief introduction to this collection of commands as a whole.
26366 @subheading Commands
26368 For each command in the block, the following is described:
26370 @subsubheading Synopsis
26373 -command @var{args}@dots{}
26376 @subsubheading Result
26378 @subsubheading @value{GDBN} Command
26380 The corresponding @value{GDBN} CLI command(s), if any.
26382 @subsubheading Example
26384 Example(s) formatted for readability. Some of the described commands have
26385 not been implemented yet and these are labeled N.A.@: (not available).
26388 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26389 @node GDB/MI Breakpoint Commands
26390 @section @sc{gdb/mi} Breakpoint Commands
26392 @cindex breakpoint commands for @sc{gdb/mi}
26393 @cindex @sc{gdb/mi}, breakpoint commands
26394 This section documents @sc{gdb/mi} commands for manipulating
26397 @subheading The @code{-break-after} Command
26398 @findex -break-after
26400 @subsubheading Synopsis
26403 -break-after @var{number} @var{count}
26406 The breakpoint number @var{number} is not in effect until it has been
26407 hit @var{count} times. To see how this is reflected in the output of
26408 the @samp{-break-list} command, see the description of the
26409 @samp{-break-list} command below.
26411 @subsubheading @value{GDBN} Command
26413 The corresponding @value{GDBN} command is @samp{ignore}.
26415 @subsubheading Example
26420 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26421 enabled="y",addr="0x000100d0",func="main",file="hello.c",
26422 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
26430 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26431 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26432 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26433 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26434 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26435 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26436 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26437 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26438 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26439 line="5",thread-groups=["i1"],times="0",ignore="3"@}]@}
26444 @subheading The @code{-break-catch} Command
26445 @findex -break-catch
26448 @subheading The @code{-break-commands} Command
26449 @findex -break-commands
26451 @subsubheading Synopsis
26454 -break-commands @var{number} [ @var{command1} ... @var{commandN} ]
26457 Specifies the CLI commands that should be executed when breakpoint
26458 @var{number} is hit. The parameters @var{command1} to @var{commandN}
26459 are the commands. If no command is specified, any previously-set
26460 commands are cleared. @xref{Break Commands}. Typical use of this
26461 functionality is tracing a program, that is, printing of values of
26462 some variables whenever breakpoint is hit and then continuing.
26464 @subsubheading @value{GDBN} Command
26466 The corresponding @value{GDBN} command is @samp{commands}.
26468 @subsubheading Example
26473 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26474 enabled="y",addr="0x000100d0",func="main",file="hello.c",
26475 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
26478 -break-commands 1 "print v" "continue"
26483 @subheading The @code{-break-condition} Command
26484 @findex -break-condition
26486 @subsubheading Synopsis
26489 -break-condition @var{number} @var{expr}
26492 Breakpoint @var{number} will stop the program only if the condition in
26493 @var{expr} is true. The condition becomes part of the
26494 @samp{-break-list} output (see the description of the @samp{-break-list}
26497 @subsubheading @value{GDBN} Command
26499 The corresponding @value{GDBN} command is @samp{condition}.
26501 @subsubheading Example
26505 -break-condition 1 1
26509 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26510 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26511 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26512 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26513 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26514 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26515 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26516 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26517 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26518 line="5",cond="1",thread-groups=["i1"],times="0",ignore="3"@}]@}
26522 @subheading The @code{-break-delete} Command
26523 @findex -break-delete
26525 @subsubheading Synopsis
26528 -break-delete ( @var{breakpoint} )+
26531 Delete the breakpoint(s) whose number(s) are specified in the argument
26532 list. This is obviously reflected in the breakpoint list.
26534 @subsubheading @value{GDBN} Command
26536 The corresponding @value{GDBN} command is @samp{delete}.
26538 @subsubheading Example
26546 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
26547 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26548 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26549 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26550 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26551 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26552 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26557 @subheading The @code{-break-disable} Command
26558 @findex -break-disable
26560 @subsubheading Synopsis
26563 -break-disable ( @var{breakpoint} )+
26566 Disable the named @var{breakpoint}(s). The field @samp{enabled} in the
26567 break list is now set to @samp{n} for the named @var{breakpoint}(s).
26569 @subsubheading @value{GDBN} Command
26571 The corresponding @value{GDBN} command is @samp{disable}.
26573 @subsubheading Example
26581 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26582 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26583 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26584 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26585 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26586 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26587 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26588 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
26589 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26590 line="5",thread-groups=["i1"],times="0"@}]@}
26594 @subheading The @code{-break-enable} Command
26595 @findex -break-enable
26597 @subsubheading Synopsis
26600 -break-enable ( @var{breakpoint} )+
26603 Enable (previously disabled) @var{breakpoint}(s).
26605 @subsubheading @value{GDBN} Command
26607 The corresponding @value{GDBN} command is @samp{enable}.
26609 @subsubheading Example
26617 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26618 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26619 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26620 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26621 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26622 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26623 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26624 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
26625 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26626 line="5",thread-groups=["i1"],times="0"@}]@}
26630 @subheading The @code{-break-info} Command
26631 @findex -break-info
26633 @subsubheading Synopsis
26636 -break-info @var{breakpoint}
26640 Get information about a single breakpoint.
26642 The result is a table of breakpoints. @xref{GDB/MI Breakpoint
26643 Information}, for details on the format of each breakpoint in the
26646 @subsubheading @value{GDBN} Command
26648 The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}.
26650 @subsubheading Example
26653 @subheading The @code{-break-insert} Command
26654 @findex -break-insert
26655 @anchor{-break-insert}
26657 @subsubheading Synopsis
26660 -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ]
26661 [ -c @var{condition} ] [ -i @var{ignore-count} ]
26662 [ -p @var{thread-id} ] [ @var{location} ]
26666 If specified, @var{location}, can be one of:
26669 @item linespec location
26670 A linespec location. @xref{Linespec Locations}.
26672 @item explicit location
26673 An explicit location. @sc{gdb/mi} explicit locations are
26674 analogous to the CLI's explicit locations using the option names
26675 listed below. @xref{Explicit Locations}.
26678 @item --source @var{filename}
26679 The source file name of the location. This option requires the use
26680 of either @samp{--function} or @samp{--line}.
26682 @item --function @var{function}
26683 The name of a function or method.
26685 @item --label @var{label}
26686 The name of a label.
26688 @item --line @var{lineoffset}
26689 An absolute or relative line offset from the start of the location.
26692 @item address location
26693 An address location, *@var{address}. @xref{Address Locations}.
26697 The possible optional parameters of this command are:
26701 Insert a temporary breakpoint.
26703 Insert a hardware breakpoint.
26705 If @var{location} cannot be parsed (for example if it
26706 refers to unknown files or functions), create a pending
26707 breakpoint. Without this flag, @value{GDBN} will report
26708 an error, and won't create a breakpoint, if @var{location}
26711 Create a disabled breakpoint.
26713 Create a tracepoint. @xref{Tracepoints}. When this parameter
26714 is used together with @samp{-h}, a fast tracepoint is created.
26715 @item -c @var{condition}
26716 Make the breakpoint conditional on @var{condition}.
26717 @item -i @var{ignore-count}
26718 Initialize the @var{ignore-count}.
26719 @item -p @var{thread-id}
26720 Restrict the breakpoint to the specified @var{thread-id}.
26723 @subsubheading Result
26725 @xref{GDB/MI Breakpoint Information}, for details on the format of the
26726 resulting breakpoint.
26728 Note: this format is open to change.
26729 @c An out-of-band breakpoint instead of part of the result?
26731 @subsubheading @value{GDBN} Command
26733 The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak},
26734 @samp{hbreak}, and @samp{thbreak}. @c and @samp{rbreak}.
26736 @subsubheading Example
26741 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
26742 fullname="/home/foo/recursive2.c,line="4",thread-groups=["i1"],
26745 -break-insert -t foo
26746 ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
26747 fullname="/home/foo/recursive2.c,line="11",thread-groups=["i1"],
26751 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
26752 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26753 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26754 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26755 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26756 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26757 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26758 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26759 addr="0x0001072c", func="main",file="recursive2.c",
26760 fullname="/home/foo/recursive2.c,"line="4",thread-groups=["i1"],
26762 bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",
26763 addr="0x00010774",func="foo",file="recursive2.c",
26764 fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
26767 @c -break-insert -r foo.*
26768 @c ~int foo(int, int);
26769 @c ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c,
26770 @c "fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
26775 @subheading The @code{-dprintf-insert} Command
26776 @findex -dprintf-insert
26778 @subsubheading Synopsis
26781 -dprintf-insert [ -t ] [ -f ] [ -d ]
26782 [ -c @var{condition} ] [ -i @var{ignore-count} ]
26783 [ -p @var{thread-id} ] [ @var{location} ] [ @var{format} ]
26788 If supplied, @var{location} may be specified the same way as for
26789 the @code{-break-insert} command. @xref{-break-insert}.
26791 The possible optional parameters of this command are:
26795 Insert a temporary breakpoint.
26797 If @var{location} cannot be parsed (for example, if it
26798 refers to unknown files or functions), create a pending
26799 breakpoint. Without this flag, @value{GDBN} will report
26800 an error, and won't create a breakpoint, if @var{location}
26803 Create a disabled breakpoint.
26804 @item -c @var{condition}
26805 Make the breakpoint conditional on @var{condition}.
26806 @item -i @var{ignore-count}
26807 Set the ignore count of the breakpoint (@pxref{Conditions, ignore count})
26808 to @var{ignore-count}.
26809 @item -p @var{thread-id}
26810 Restrict the breakpoint to the specified @var{thread-id}.
26813 @subsubheading Result
26815 @xref{GDB/MI Breakpoint Information}, for details on the format of the
26816 resulting breakpoint.
26818 @c An out-of-band breakpoint instead of part of the result?
26820 @subsubheading @value{GDBN} Command
26822 The corresponding @value{GDBN} command is @samp{dprintf}.
26824 @subsubheading Example
26828 4-dprintf-insert foo "At foo entry\n"
26829 4^done,bkpt=@{number="1",type="dprintf",disp="keep",enabled="y",
26830 addr="0x000000000040061b",func="foo",file="mi-dprintf.c",
26831 fullname="mi-dprintf.c",line="25",thread-groups=["i1"],
26832 times="0",script=@{"printf \"At foo entry\\n\"","continue"@},
26833 original-location="foo"@}
26835 5-dprintf-insert 26 "arg=%d, g=%d\n" arg g
26836 5^done,bkpt=@{number="2",type="dprintf",disp="keep",enabled="y",
26837 addr="0x000000000040062a",func="foo",file="mi-dprintf.c",
26838 fullname="mi-dprintf.c",line="26",thread-groups=["i1"],
26839 times="0",script=@{"printf \"arg=%d, g=%d\\n\", arg, g","continue"@},
26840 original-location="mi-dprintf.c:26"@}
26844 @subheading The @code{-break-list} Command
26845 @findex -break-list
26847 @subsubheading Synopsis
26853 Displays the list of inserted breakpoints, showing the following fields:
26857 number of the breakpoint
26859 type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}
26861 should the breakpoint be deleted or disabled when it is hit: @samp{keep}
26864 is the breakpoint enabled or no: @samp{y} or @samp{n}
26866 memory location at which the breakpoint is set
26868 logical location of the breakpoint, expressed by function name, file
26870 @item Thread-groups
26871 list of thread groups to which this breakpoint applies
26873 number of times the breakpoint has been hit
26876 If there are no breakpoints or watchpoints, the @code{BreakpointTable}
26877 @code{body} field is an empty list.
26879 @subsubheading @value{GDBN} Command
26881 The corresponding @value{GDBN} command is @samp{info break}.
26883 @subsubheading Example
26888 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
26889 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26890 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26891 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26892 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26893 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26894 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26895 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26896 addr="0x000100d0",func="main",file="hello.c",line="5",thread-groups=["i1"],
26898 bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
26899 addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
26900 line="13",thread-groups=["i1"],times="0"@}]@}
26904 Here's an example of the result when there are no breakpoints:
26909 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
26910 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26911 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26912 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26913 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26914 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26915 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26920 @subheading The @code{-break-passcount} Command
26921 @findex -break-passcount
26923 @subsubheading Synopsis
26926 -break-passcount @var{tracepoint-number} @var{passcount}
26929 Set the passcount for tracepoint @var{tracepoint-number} to
26930 @var{passcount}. If the breakpoint referred to by @var{tracepoint-number}
26931 is not a tracepoint, error is emitted. This corresponds to CLI
26932 command @samp{passcount}.
26934 @subheading The @code{-break-watch} Command
26935 @findex -break-watch
26937 @subsubheading Synopsis
26940 -break-watch [ -a | -r ]
26943 Create a watchpoint. With the @samp{-a} option it will create an
26944 @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a
26945 read from or on a write to the memory location. With the @samp{-r}
26946 option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will
26947 trigger only when the memory location is accessed for reading. Without
26948 either of the options, the watchpoint created is a regular watchpoint,
26949 i.e., it will trigger when the memory location is accessed for writing.
26950 @xref{Set Watchpoints, , Setting Watchpoints}.
26952 Note that @samp{-break-list} will report a single list of watchpoints and
26953 breakpoints inserted.
26955 @subsubheading @value{GDBN} Command
26957 The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and
26960 @subsubheading Example
26962 Setting a watchpoint on a variable in the @code{main} function:
26967 ^done,wpt=@{number="2",exp="x"@}
26972 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
26973 value=@{old="-268439212",new="55"@},
26974 frame=@{func="main",args=[],file="recursive2.c",
26975 fullname="/home/foo/bar/recursive2.c",line="5"@}
26979 Setting a watchpoint on a variable local to a function. @value{GDBN} will stop
26980 the program execution twice: first for the variable changing value, then
26981 for the watchpoint going out of scope.
26986 ^done,wpt=@{number="5",exp="C"@}
26991 *stopped,reason="watchpoint-trigger",
26992 wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
26993 frame=@{func="callee4",args=[],
26994 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
26995 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
27000 *stopped,reason="watchpoint-scope",wpnum="5",
27001 frame=@{func="callee3",args=[@{name="strarg",
27002 value="0x11940 \"A string argument.\""@}],
27003 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27004 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
27008 Listing breakpoints and watchpoints, at different points in the program
27009 execution. Note that once the watchpoint goes out of scope, it is
27015 ^done,wpt=@{number="2",exp="C"@}
27018 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27019 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27020 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27021 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27022 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27023 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27024 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27025 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27026 addr="0x00010734",func="callee4",
27027 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27028 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",thread-groups=["i1"],
27030 bkpt=@{number="2",type="watchpoint",disp="keep",
27031 enabled="y",addr="",what="C",thread-groups=["i1"],times="0"@}]@}
27036 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
27037 value=@{old="-276895068",new="3"@},
27038 frame=@{func="callee4",args=[],
27039 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27040 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
27043 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27044 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27045 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27046 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27047 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27048 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27049 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27050 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27051 addr="0x00010734",func="callee4",
27052 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27053 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",thread-groups=["i1"],
27055 bkpt=@{number="2",type="watchpoint",disp="keep",
27056 enabled="y",addr="",what="C",thread-groups=["i1"],times="-5"@}]@}
27060 ^done,reason="watchpoint-scope",wpnum="2",
27061 frame=@{func="callee3",args=[@{name="strarg",
27062 value="0x11940 \"A string argument.\""@}],
27063 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27064 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
27067 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27068 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27069 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27070 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27071 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27072 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27073 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27074 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27075 addr="0x00010734",func="callee4",
27076 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27077 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
27078 thread-groups=["i1"],times="1"@}]@}
27083 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27084 @node GDB/MI Catchpoint Commands
27085 @section @sc{gdb/mi} Catchpoint Commands
27087 This section documents @sc{gdb/mi} commands for manipulating
27091 * Shared Library GDB/MI Catchpoint Commands::
27092 * Ada Exception GDB/MI Catchpoint Commands::
27095 @node Shared Library GDB/MI Catchpoint Commands
27096 @subsection Shared Library @sc{gdb/mi} Catchpoints
27098 @subheading The @code{-catch-load} Command
27099 @findex -catch-load
27101 @subsubheading Synopsis
27104 -catch-load [ -t ] [ -d ] @var{regexp}
27107 Add a catchpoint for library load events. If the @samp{-t} option is used,
27108 the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
27109 Breakpoints}). If the @samp{-d} option is used, the catchpoint is created
27110 in a disabled state. The @samp{regexp} argument is a regular
27111 expression used to match the name of the loaded library.
27114 @subsubheading @value{GDBN} Command
27116 The corresponding @value{GDBN} command is @samp{catch load}.
27118 @subsubheading Example
27121 -catch-load -t foo.so
27122 ^done,bkpt=@{number="1",type="catchpoint",disp="del",enabled="y",
27123 what="load of library matching foo.so",catch-type="load",times="0"@}
27128 @subheading The @code{-catch-unload} Command
27129 @findex -catch-unload
27131 @subsubheading Synopsis
27134 -catch-unload [ -t ] [ -d ] @var{regexp}
27137 Add a catchpoint for library unload events. If the @samp{-t} option is
27138 used, the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
27139 Breakpoints}). If the @samp{-d} option is used, the catchpoint is
27140 created in a disabled state. The @samp{regexp} argument is a regular
27141 expression used to match the name of the unloaded library.
27143 @subsubheading @value{GDBN} Command
27145 The corresponding @value{GDBN} command is @samp{catch unload}.
27147 @subsubheading Example
27150 -catch-unload -d bar.so
27151 ^done,bkpt=@{number="2",type="catchpoint",disp="keep",enabled="n",
27152 what="load of library matching bar.so",catch-type="unload",times="0"@}
27156 @node Ada Exception GDB/MI Catchpoint Commands
27157 @subsection Ada Exception @sc{gdb/mi} Catchpoints
27159 The following @sc{gdb/mi} commands can be used to create catchpoints
27160 that stop the execution when Ada exceptions are being raised.
27162 @subheading The @code{-catch-assert} Command
27163 @findex -catch-assert
27165 @subsubheading Synopsis
27168 -catch-assert [ -c @var{condition}] [ -d ] [ -t ]
27171 Add a catchpoint for failed Ada assertions.
27173 The possible optional parameters for this command are:
27176 @item -c @var{condition}
27177 Make the catchpoint conditional on @var{condition}.
27179 Create a disabled catchpoint.
27181 Create a temporary catchpoint.
27184 @subsubheading @value{GDBN} Command
27186 The corresponding @value{GDBN} command is @samp{catch assert}.
27188 @subsubheading Example
27192 ^done,bkptno="5",bkpt=@{number="5",type="breakpoint",disp="keep",
27193 enabled="y",addr="0x0000000000404888",what="failed Ada assertions",
27194 thread-groups=["i1"],times="0",
27195 original-location="__gnat_debug_raise_assert_failure"@}
27199 @subheading The @code{-catch-exception} Command
27200 @findex -catch-exception
27202 @subsubheading Synopsis
27205 -catch-exception [ -c @var{condition}] [ -d ] [ -e @var{exception-name} ]
27209 Add a catchpoint stopping when Ada exceptions are raised.
27210 By default, the command stops the program when any Ada exception
27211 gets raised. But it is also possible, by using some of the
27212 optional parameters described below, to create more selective
27215 The possible optional parameters for this command are:
27218 @item -c @var{condition}
27219 Make the catchpoint conditional on @var{condition}.
27221 Create a disabled catchpoint.
27222 @item -e @var{exception-name}
27223 Only stop when @var{exception-name} is raised. This option cannot
27224 be used combined with @samp{-u}.
27226 Create a temporary catchpoint.
27228 Stop only when an unhandled exception gets raised. This option
27229 cannot be used combined with @samp{-e}.
27232 @subsubheading @value{GDBN} Command
27234 The corresponding @value{GDBN} commands are @samp{catch exception}
27235 and @samp{catch exception unhandled}.
27237 @subsubheading Example
27240 -catch-exception -e Program_Error
27241 ^done,bkptno="4",bkpt=@{number="4",type="breakpoint",disp="keep",
27242 enabled="y",addr="0x0000000000404874",
27243 what="`Program_Error' Ada exception", thread-groups=["i1"],
27244 times="0",original-location="__gnat_debug_raise_exception"@}
27248 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27249 @node GDB/MI Program Context
27250 @section @sc{gdb/mi} Program Context
27252 @subheading The @code{-exec-arguments} Command
27253 @findex -exec-arguments
27256 @subsubheading Synopsis
27259 -exec-arguments @var{args}
27262 Set the inferior program arguments, to be used in the next
27265 @subsubheading @value{GDBN} Command
27267 The corresponding @value{GDBN} command is @samp{set args}.
27269 @subsubheading Example
27273 -exec-arguments -v word
27280 @subheading The @code{-exec-show-arguments} Command
27281 @findex -exec-show-arguments
27283 @subsubheading Synopsis
27286 -exec-show-arguments
27289 Print the arguments of the program.
27291 @subsubheading @value{GDBN} Command
27293 The corresponding @value{GDBN} command is @samp{show args}.
27295 @subsubheading Example
27300 @subheading The @code{-environment-cd} Command
27301 @findex -environment-cd
27303 @subsubheading Synopsis
27306 -environment-cd @var{pathdir}
27309 Set @value{GDBN}'s working directory.
27311 @subsubheading @value{GDBN} Command
27313 The corresponding @value{GDBN} command is @samp{cd}.
27315 @subsubheading Example
27319 -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
27325 @subheading The @code{-environment-directory} Command
27326 @findex -environment-directory
27328 @subsubheading Synopsis
27331 -environment-directory [ -r ] [ @var{pathdir} ]+
27334 Add directories @var{pathdir} to beginning of search path for source files.
27335 If the @samp{-r} option is used, the search path is reset to the default
27336 search path. If directories @var{pathdir} are supplied in addition to the
27337 @samp{-r} option, the search path is first reset and then addition
27339 Multiple directories may be specified, separated by blanks. Specifying
27340 multiple directories in a single command
27341 results in the directories added to the beginning of the
27342 search path in the same order they were presented in the command.
27343 If blanks are needed as
27344 part of a directory name, double-quotes should be used around
27345 the name. In the command output, the path will show up separated
27346 by the system directory-separator character. The directory-separator
27347 character must not be used
27348 in any directory name.
27349 If no directories are specified, the current search path is displayed.
27351 @subsubheading @value{GDBN} Command
27353 The corresponding @value{GDBN} command is @samp{dir}.
27355 @subsubheading Example
27359 -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
27360 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
27362 -environment-directory ""
27363 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
27365 -environment-directory -r /home/jjohnstn/src/gdb /usr/src
27366 ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
27368 -environment-directory -r
27369 ^done,source-path="$cdir:$cwd"
27374 @subheading The @code{-environment-path} Command
27375 @findex -environment-path
27377 @subsubheading Synopsis
27380 -environment-path [ -r ] [ @var{pathdir} ]+
27383 Add directories @var{pathdir} to beginning of search path for object files.
27384 If the @samp{-r} option is used, the search path is reset to the original
27385 search path that existed at gdb start-up. If directories @var{pathdir} are
27386 supplied in addition to the
27387 @samp{-r} option, the search path is first reset and then addition
27389 Multiple directories may be specified, separated by blanks. Specifying
27390 multiple directories in a single command
27391 results in the directories added to the beginning of the
27392 search path in the same order they were presented in the command.
27393 If blanks are needed as
27394 part of a directory name, double-quotes should be used around
27395 the name. In the command output, the path will show up separated
27396 by the system directory-separator character. The directory-separator
27397 character must not be used
27398 in any directory name.
27399 If no directories are specified, the current path is displayed.
27402 @subsubheading @value{GDBN} Command
27404 The corresponding @value{GDBN} command is @samp{path}.
27406 @subsubheading Example
27411 ^done,path="/usr/bin"
27413 -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
27414 ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
27416 -environment-path -r /usr/local/bin
27417 ^done,path="/usr/local/bin:/usr/bin"
27422 @subheading The @code{-environment-pwd} Command
27423 @findex -environment-pwd
27425 @subsubheading Synopsis
27431 Show the current working directory.
27433 @subsubheading @value{GDBN} Command
27435 The corresponding @value{GDBN} command is @samp{pwd}.
27437 @subsubheading Example
27442 ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
27446 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27447 @node GDB/MI Thread Commands
27448 @section @sc{gdb/mi} Thread Commands
27451 @subheading The @code{-thread-info} Command
27452 @findex -thread-info
27454 @subsubheading Synopsis
27457 -thread-info [ @var{thread-id} ]
27460 Reports information about either a specific thread, if
27461 the @var{thread-id} parameter is present, or about all
27462 threads. When printing information about all threads,
27463 also reports the current thread.
27465 @subsubheading @value{GDBN} Command
27467 The @samp{info thread} command prints the same information
27470 @subsubheading Result
27472 The result is a list of threads. The following attributes are
27473 defined for a given thread:
27477 This field exists only for the current thread. It has the value @samp{*}.
27480 The identifier that @value{GDBN} uses to refer to the thread.
27483 The identifier that the target uses to refer to the thread.
27486 Extra information about the thread, in a target-specific format. This
27490 The name of the thread. If the user specified a name using the
27491 @code{thread name} command, then this name is given. Otherwise, if
27492 @value{GDBN} can extract the thread name from the target, then that
27493 name is given. If @value{GDBN} cannot find the thread name, then this
27497 The stack frame currently executing in the thread.
27500 The thread's state. The @samp{state} field may have the following
27505 The thread is stopped. Frame information is available for stopped
27509 The thread is running. There's no frame information for running
27515 If @value{GDBN} can find the CPU core on which this thread is running,
27516 then this field is the core identifier. This field is optional.
27520 @subsubheading Example
27525 @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
27526 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",
27527 args=[]@},state="running"@},
27528 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
27529 frame=@{level="0",addr="0x0804891f",func="foo",
27530 args=[@{name="i",value="10"@}],
27531 file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},
27532 state="running"@}],
27533 current-thread-id="1"
27537 @subheading The @code{-thread-list-ids} Command
27538 @findex -thread-list-ids
27540 @subsubheading Synopsis
27546 Produces a list of the currently known @value{GDBN} thread ids. At the
27547 end of the list it also prints the total number of such threads.
27549 This command is retained for historical reasons, the
27550 @code{-thread-info} command should be used instead.
27552 @subsubheading @value{GDBN} Command
27554 Part of @samp{info threads} supplies the same information.
27556 @subsubheading Example
27561 ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
27562 current-thread-id="1",number-of-threads="3"
27567 @subheading The @code{-thread-select} Command
27568 @findex -thread-select
27570 @subsubheading Synopsis
27573 -thread-select @var{threadnum}
27576 Make @var{threadnum} the current thread. It prints the number of the new
27577 current thread, and the topmost frame for that thread.
27579 This command is deprecated in favor of explicitly using the
27580 @samp{--thread} option to each command.
27582 @subsubheading @value{GDBN} Command
27584 The corresponding @value{GDBN} command is @samp{thread}.
27586 @subsubheading Example
27593 *stopped,reason="end-stepping-range",thread-id="2",line="187",
27594 file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
27598 thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
27599 number-of-threads="3"
27602 ^done,new-thread-id="3",
27603 frame=@{level="0",func="vprintf",
27604 args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
27605 @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@}
27609 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27610 @node GDB/MI Ada Tasking Commands
27611 @section @sc{gdb/mi} Ada Tasking Commands
27613 @subheading The @code{-ada-task-info} Command
27614 @findex -ada-task-info
27616 @subsubheading Synopsis
27619 -ada-task-info [ @var{task-id} ]
27622 Reports information about either a specific Ada task, if the
27623 @var{task-id} parameter is present, or about all Ada tasks.
27625 @subsubheading @value{GDBN} Command
27627 The @samp{info tasks} command prints the same information
27628 about all Ada tasks (@pxref{Ada Tasks}).
27630 @subsubheading Result
27632 The result is a table of Ada tasks. The following columns are
27633 defined for each Ada task:
27637 This field exists only for the current thread. It has the value @samp{*}.
27640 The identifier that @value{GDBN} uses to refer to the Ada task.
27643 The identifier that the target uses to refer to the Ada task.
27646 The identifier of the thread corresponding to the Ada task.
27648 This field should always exist, as Ada tasks are always implemented
27649 on top of a thread. But if @value{GDBN} cannot find this corresponding
27650 thread for any reason, the field is omitted.
27653 This field exists only when the task was created by another task.
27654 In this case, it provides the ID of the parent task.
27657 The base priority of the task.
27660 The current state of the task. For a detailed description of the
27661 possible states, see @ref{Ada Tasks}.
27664 The name of the task.
27668 @subsubheading Example
27672 ^done,tasks=@{nr_rows="3",nr_cols="8",
27673 hdr=[@{width="1",alignment="-1",col_name="current",colhdr=""@},
27674 @{width="3",alignment="1",col_name="id",colhdr="ID"@},
27675 @{width="9",alignment="1",col_name="task-id",colhdr="TID"@},
27676 @{width="4",alignment="1",col_name="thread-id",colhdr=""@},
27677 @{width="4",alignment="1",col_name="parent-id",colhdr="P-ID"@},
27678 @{width="3",alignment="1",col_name="priority",colhdr="Pri"@},
27679 @{width="22",alignment="-1",col_name="state",colhdr="State"@},
27680 @{width="1",alignment="2",col_name="name",colhdr="Name"@}],
27681 body=[@{current="*",id="1",task-id=" 644010",thread-id="1",priority="48",
27682 state="Child Termination Wait",name="main_task"@}]@}
27686 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27687 @node GDB/MI Program Execution
27688 @section @sc{gdb/mi} Program Execution
27690 These are the asynchronous commands which generate the out-of-band
27691 record @samp{*stopped}. Currently @value{GDBN} only really executes
27692 asynchronously with remote targets and this interaction is mimicked in
27695 @subheading The @code{-exec-continue} Command
27696 @findex -exec-continue
27698 @subsubheading Synopsis
27701 -exec-continue [--reverse] [--all|--thread-group N]
27704 Resumes the execution of the inferior program, which will continue
27705 to execute until it reaches a debugger stop event. If the
27706 @samp{--reverse} option is specified, execution resumes in reverse until
27707 it reaches a stop event. Stop events may include
27710 breakpoints or watchpoints
27712 signals or exceptions
27714 the end of the process (or its beginning under @samp{--reverse})
27716 the end or beginning of a replay log if one is being used.
27718 In all-stop mode (@pxref{All-Stop
27719 Mode}), may resume only one thread, or all threads, depending on the
27720 value of the @samp{scheduler-locking} variable. If @samp{--all} is
27721 specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is
27722 ignored in all-stop mode. If the @samp{--thread-group} options is
27723 specified, then all threads in that thread group are resumed.
27725 @subsubheading @value{GDBN} Command
27727 The corresponding @value{GDBN} corresponding is @samp{continue}.
27729 @subsubheading Example
27736 *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{
27737 func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
27743 @subheading The @code{-exec-finish} Command
27744 @findex -exec-finish
27746 @subsubheading Synopsis
27749 -exec-finish [--reverse]
27752 Resumes the execution of the inferior program until the current
27753 function is exited. Displays the results returned by the function.
27754 If the @samp{--reverse} option is specified, resumes the reverse
27755 execution of the inferior program until the point where current
27756 function was called.
27758 @subsubheading @value{GDBN} Command
27760 The corresponding @value{GDBN} command is @samp{finish}.
27762 @subsubheading Example
27764 Function returning @code{void}.
27771 *stopped,reason="function-finished",frame=@{func="main",args=[],
27772 file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@}
27776 Function returning other than @code{void}. The name of the internal
27777 @value{GDBN} variable storing the result is printed, together with the
27784 *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
27785 args=[@{name="a",value="1"],@{name="b",value="9"@}@},
27786 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
27787 gdb-result-var="$1",return-value="0"
27792 @subheading The @code{-exec-interrupt} Command
27793 @findex -exec-interrupt
27795 @subsubheading Synopsis
27798 -exec-interrupt [--all|--thread-group N]
27801 Interrupts the background execution of the target. Note how the token
27802 associated with the stop message is the one for the execution command
27803 that has been interrupted. The token for the interrupt itself only
27804 appears in the @samp{^done} output. If the user is trying to
27805 interrupt a non-running program, an error message will be printed.
27807 Note that when asynchronous execution is enabled, this command is
27808 asynchronous just like other execution commands. That is, first the
27809 @samp{^done} response will be printed, and the target stop will be
27810 reported after that using the @samp{*stopped} notification.
27812 In non-stop mode, only the context thread is interrupted by default.
27813 All threads (in all inferiors) will be interrupted if the
27814 @samp{--all} option is specified. If the @samp{--thread-group}
27815 option is specified, all threads in that group will be interrupted.
27817 @subsubheading @value{GDBN} Command
27819 The corresponding @value{GDBN} command is @samp{interrupt}.
27821 @subsubheading Example
27832 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
27833 frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
27834 fullname="/home/foo/bar/try.c",line="13"@}
27839 ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
27843 @subheading The @code{-exec-jump} Command
27846 @subsubheading Synopsis
27849 -exec-jump @var{location}
27852 Resumes execution of the inferior program at the location specified by
27853 parameter. @xref{Specify Location}, for a description of the
27854 different forms of @var{location}.
27856 @subsubheading @value{GDBN} Command
27858 The corresponding @value{GDBN} command is @samp{jump}.
27860 @subsubheading Example
27863 -exec-jump foo.c:10
27864 *running,thread-id="all"
27869 @subheading The @code{-exec-next} Command
27872 @subsubheading Synopsis
27875 -exec-next [--reverse]
27878 Resumes execution of the inferior program, stopping when the beginning
27879 of the next source line is reached.
27881 If the @samp{--reverse} option is specified, resumes reverse execution
27882 of the inferior program, stopping at the beginning of the previous
27883 source line. If you issue this command on the first line of a
27884 function, it will take you back to the caller of that function, to the
27885 source line where the function was called.
27888 @subsubheading @value{GDBN} Command
27890 The corresponding @value{GDBN} command is @samp{next}.
27892 @subsubheading Example
27898 *stopped,reason="end-stepping-range",line="8",file="hello.c"
27903 @subheading The @code{-exec-next-instruction} Command
27904 @findex -exec-next-instruction
27906 @subsubheading Synopsis
27909 -exec-next-instruction [--reverse]
27912 Executes one machine instruction. If the instruction is a function
27913 call, continues until the function returns. If the program stops at an
27914 instruction in the middle of a source line, the address will be
27917 If the @samp{--reverse} option is specified, resumes reverse execution
27918 of the inferior program, stopping at the previous instruction. If the
27919 previously executed instruction was a return from another function,
27920 it will continue to execute in reverse until the call to that function
27921 (from the current stack frame) is reached.
27923 @subsubheading @value{GDBN} Command
27925 The corresponding @value{GDBN} command is @samp{nexti}.
27927 @subsubheading Example
27931 -exec-next-instruction
27935 *stopped,reason="end-stepping-range",
27936 addr="0x000100d4",line="5",file="hello.c"
27941 @subheading The @code{-exec-return} Command
27942 @findex -exec-return
27944 @subsubheading Synopsis
27950 Makes current function return immediately. Doesn't execute the inferior.
27951 Displays the new current frame.
27953 @subsubheading @value{GDBN} Command
27955 The corresponding @value{GDBN} command is @samp{return}.
27957 @subsubheading Example
27961 200-break-insert callee4
27962 200^done,bkpt=@{number="1",addr="0x00010734",
27963 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
27968 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
27969 frame=@{func="callee4",args=[],
27970 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27971 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
27977 111^done,frame=@{level="0",func="callee3",
27978 args=[@{name="strarg",
27979 value="0x11940 \"A string argument.\""@}],
27980 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27981 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
27986 @subheading The @code{-exec-run} Command
27989 @subsubheading Synopsis
27992 -exec-run [ --all | --thread-group N ] [ --start ]
27995 Starts execution of the inferior from the beginning. The inferior
27996 executes until either a breakpoint is encountered or the program
27997 exits. In the latter case the output will include an exit code, if
27998 the program has exited exceptionally.
28000 When neither the @samp{--all} nor the @samp{--thread-group} option
28001 is specified, the current inferior is started. If the
28002 @samp{--thread-group} option is specified, it should refer to a thread
28003 group of type @samp{process}, and that thread group will be started.
28004 If the @samp{--all} option is specified, then all inferiors will be started.
28006 Using the @samp{--start} option instructs the debugger to stop
28007 the execution at the start of the inferior's main subprogram,
28008 following the same behavior as the @code{start} command
28009 (@pxref{Starting}).
28011 @subsubheading @value{GDBN} Command
28013 The corresponding @value{GDBN} command is @samp{run}.
28015 @subsubheading Examples
28020 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
28025 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
28026 frame=@{func="main",args=[],file="recursive2.c",
28027 fullname="/home/foo/bar/recursive2.c",line="4"@}
28032 Program exited normally:
28040 *stopped,reason="exited-normally"
28045 Program exited exceptionally:
28053 *stopped,reason="exited",exit-code="01"
28057 Another way the program can terminate is if it receives a signal such as
28058 @code{SIGINT}. In this case, @sc{gdb/mi} displays this:
28062 *stopped,reason="exited-signalled",signal-name="SIGINT",
28063 signal-meaning="Interrupt"
28067 @c @subheading -exec-signal
28070 @subheading The @code{-exec-step} Command
28073 @subsubheading Synopsis
28076 -exec-step [--reverse]
28079 Resumes execution of the inferior program, stopping when the beginning
28080 of the next source line is reached, if the next source line is not a
28081 function call. If it is, stop at the first instruction of the called
28082 function. If the @samp{--reverse} option is specified, resumes reverse
28083 execution of the inferior program, stopping at the beginning of the
28084 previously executed source line.
28086 @subsubheading @value{GDBN} Command
28088 The corresponding @value{GDBN} command is @samp{step}.
28090 @subsubheading Example
28092 Stepping into a function:
28098 *stopped,reason="end-stepping-range",
28099 frame=@{func="foo",args=[@{name="a",value="10"@},
28100 @{name="b",value="0"@}],file="recursive2.c",
28101 fullname="/home/foo/bar/recursive2.c",line="11"@}
28111 *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
28116 @subheading The @code{-exec-step-instruction} Command
28117 @findex -exec-step-instruction
28119 @subsubheading Synopsis
28122 -exec-step-instruction [--reverse]
28125 Resumes the inferior which executes one machine instruction. If the
28126 @samp{--reverse} option is specified, resumes reverse execution of the
28127 inferior program, stopping at the previously executed instruction.
28128 The output, once @value{GDBN} has stopped, will vary depending on
28129 whether we have stopped in the middle of a source line or not. In the
28130 former case, the address at which the program stopped will be printed
28133 @subsubheading @value{GDBN} Command
28135 The corresponding @value{GDBN} command is @samp{stepi}.
28137 @subsubheading Example
28141 -exec-step-instruction
28145 *stopped,reason="end-stepping-range",
28146 frame=@{func="foo",args=[],file="try.c",
28147 fullname="/home/foo/bar/try.c",line="10"@}
28149 -exec-step-instruction
28153 *stopped,reason="end-stepping-range",
28154 frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
28155 fullname="/home/foo/bar/try.c",line="10"@}
28160 @subheading The @code{-exec-until} Command
28161 @findex -exec-until
28163 @subsubheading Synopsis
28166 -exec-until [ @var{location} ]
28169 Executes the inferior until the @var{location} specified in the
28170 argument is reached. If there is no argument, the inferior executes
28171 until a source line greater than the current one is reached. The
28172 reason for stopping in this case will be @samp{location-reached}.
28174 @subsubheading @value{GDBN} Command
28176 The corresponding @value{GDBN} command is @samp{until}.
28178 @subsubheading Example
28182 -exec-until recursive2.c:6
28186 *stopped,reason="location-reached",frame=@{func="main",args=[],
28187 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@}
28192 @subheading -file-clear
28193 Is this going away????
28196 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28197 @node GDB/MI Stack Manipulation
28198 @section @sc{gdb/mi} Stack Manipulation Commands
28200 @subheading The @code{-enable-frame-filters} Command
28201 @findex -enable-frame-filters
28204 -enable-frame-filters
28207 @value{GDBN} allows Python-based frame filters to affect the output of
28208 the MI commands relating to stack traces. As there is no way to
28209 implement this in a fully backward-compatible way, a front end must
28210 request that this functionality be enabled.
28212 Once enabled, this feature cannot be disabled.
28214 Note that if Python support has not been compiled into @value{GDBN},
28215 this command will still succeed (and do nothing).
28217 @subheading The @code{-stack-info-frame} Command
28218 @findex -stack-info-frame
28220 @subsubheading Synopsis
28226 Get info on the selected frame.
28228 @subsubheading @value{GDBN} Command
28230 The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame}
28231 (without arguments).
28233 @subsubheading Example
28238 ^done,frame=@{level="1",addr="0x0001076c",func="callee3",
28239 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28240 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}
28244 @subheading The @code{-stack-info-depth} Command
28245 @findex -stack-info-depth
28247 @subsubheading Synopsis
28250 -stack-info-depth [ @var{max-depth} ]
28253 Return the depth of the stack. If the integer argument @var{max-depth}
28254 is specified, do not count beyond @var{max-depth} frames.
28256 @subsubheading @value{GDBN} Command
28258 There's no equivalent @value{GDBN} command.
28260 @subsubheading Example
28262 For a stack with frame levels 0 through 11:
28269 -stack-info-depth 4
28272 -stack-info-depth 12
28275 -stack-info-depth 11
28278 -stack-info-depth 13
28283 @anchor{-stack-list-arguments}
28284 @subheading The @code{-stack-list-arguments} Command
28285 @findex -stack-list-arguments
28287 @subsubheading Synopsis
28290 -stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28291 [ @var{low-frame} @var{high-frame} ]
28294 Display a list of the arguments for the frames between @var{low-frame}
28295 and @var{high-frame} (inclusive). If @var{low-frame} and
28296 @var{high-frame} are not provided, list the arguments for the whole
28297 call stack. If the two arguments are equal, show the single frame
28298 at the corresponding level. It is an error if @var{low-frame} is
28299 larger than the actual number of frames. On the other hand,
28300 @var{high-frame} may be larger than the actual number of frames, in
28301 which case only existing frames will be returned.
28303 If @var{print-values} is 0 or @code{--no-values}, print only the names of
28304 the variables; if it is 1 or @code{--all-values}, print also their
28305 values; and if it is 2 or @code{--simple-values}, print the name,
28306 type and value for simple data types, and the name and type for arrays,
28307 structures and unions. If the option @code{--no-frame-filters} is
28308 supplied, then Python frame filters will not be executed.
28310 If the @code{--skip-unavailable} option is specified, arguments that
28311 are not available are not listed. Partially available arguments
28312 are still displayed, however.
28314 Use of this command to obtain arguments in a single frame is
28315 deprecated in favor of the @samp{-stack-list-variables} command.
28317 @subsubheading @value{GDBN} Command
28319 @value{GDBN} does not have an equivalent command. @code{gdbtk} has a
28320 @samp{gdb_get_args} command which partially overlaps with the
28321 functionality of @samp{-stack-list-arguments}.
28323 @subsubheading Example
28330 frame=@{level="0",addr="0x00010734",func="callee4",
28331 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28332 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@},
28333 frame=@{level="1",addr="0x0001076c",func="callee3",
28334 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28335 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@},
28336 frame=@{level="2",addr="0x0001078c",func="callee2",
28337 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28338 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@},
28339 frame=@{level="3",addr="0x000107b4",func="callee1",
28340 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28341 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@},
28342 frame=@{level="4",addr="0x000107e0",func="main",
28343 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28344 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}]
28346 -stack-list-arguments 0
28349 frame=@{level="0",args=[]@},
28350 frame=@{level="1",args=[name="strarg"]@},
28351 frame=@{level="2",args=[name="intarg",name="strarg"]@},
28352 frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
28353 frame=@{level="4",args=[]@}]
28355 -stack-list-arguments 1
28358 frame=@{level="0",args=[]@},
28360 args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@},
28361 frame=@{level="2",args=[
28362 @{name="intarg",value="2"@},
28363 @{name="strarg",value="0x11940 \"A string argument.\""@}]@},
28364 @{frame=@{level="3",args=[
28365 @{name="intarg",value="2"@},
28366 @{name="strarg",value="0x11940 \"A string argument.\""@},
28367 @{name="fltarg",value="3.5"@}]@},
28368 frame=@{level="4",args=[]@}]
28370 -stack-list-arguments 0 2 2
28371 ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
28373 -stack-list-arguments 1 2 2
28374 ^done,stack-args=[frame=@{level="2",
28375 args=[@{name="intarg",value="2"@},
28376 @{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
28380 @c @subheading -stack-list-exception-handlers
28383 @anchor{-stack-list-frames}
28384 @subheading The @code{-stack-list-frames} Command
28385 @findex -stack-list-frames
28387 @subsubheading Synopsis
28390 -stack-list-frames [ --no-frame-filters @var{low-frame} @var{high-frame} ]
28393 List the frames currently on the stack. For each frame it displays the
28398 The frame number, 0 being the topmost frame, i.e., the innermost function.
28400 The @code{$pc} value for that frame.
28404 File name of the source file where the function lives.
28405 @item @var{fullname}
28406 The full file name of the source file where the function lives.
28408 Line number corresponding to the @code{$pc}.
28410 The shared library where this function is defined. This is only given
28411 if the frame's function is not known.
28414 If invoked without arguments, this command prints a backtrace for the
28415 whole stack. If given two integer arguments, it shows the frames whose
28416 levels are between the two arguments (inclusive). If the two arguments
28417 are equal, it shows the single frame at the corresponding level. It is
28418 an error if @var{low-frame} is larger than the actual number of
28419 frames. On the other hand, @var{high-frame} may be larger than the
28420 actual number of frames, in which case only existing frames will be
28421 returned. If the option @code{--no-frame-filters} is supplied, then
28422 Python frame filters will not be executed.
28424 @subsubheading @value{GDBN} Command
28426 The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}.
28428 @subsubheading Example
28430 Full stack backtrace:
28436 [frame=@{level="0",addr="0x0001076c",func="foo",
28437 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@},
28438 frame=@{level="1",addr="0x000107a4",func="foo",
28439 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28440 frame=@{level="2",addr="0x000107a4",func="foo",
28441 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28442 frame=@{level="3",addr="0x000107a4",func="foo",
28443 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28444 frame=@{level="4",addr="0x000107a4",func="foo",
28445 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28446 frame=@{level="5",addr="0x000107a4",func="foo",
28447 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28448 frame=@{level="6",addr="0x000107a4",func="foo",
28449 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28450 frame=@{level="7",addr="0x000107a4",func="foo",
28451 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28452 frame=@{level="8",addr="0x000107a4",func="foo",
28453 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28454 frame=@{level="9",addr="0x000107a4",func="foo",
28455 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28456 frame=@{level="10",addr="0x000107a4",func="foo",
28457 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28458 frame=@{level="11",addr="0x00010738",func="main",
28459 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}]
28463 Show frames between @var{low_frame} and @var{high_frame}:
28467 -stack-list-frames 3 5
28469 [frame=@{level="3",addr="0x000107a4",func="foo",
28470 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28471 frame=@{level="4",addr="0x000107a4",func="foo",
28472 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28473 frame=@{level="5",addr="0x000107a4",func="foo",
28474 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
28478 Show a single frame:
28482 -stack-list-frames 3 3
28484 [frame=@{level="3",addr="0x000107a4",func="foo",
28485 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
28490 @subheading The @code{-stack-list-locals} Command
28491 @findex -stack-list-locals
28492 @anchor{-stack-list-locals}
28494 @subsubheading Synopsis
28497 -stack-list-locals [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28500 Display the local variable names for the selected frame. If
28501 @var{print-values} is 0 or @code{--no-values}, print only the names of
28502 the variables; if it is 1 or @code{--all-values}, print also their
28503 values; and if it is 2 or @code{--simple-values}, print the name,
28504 type and value for simple data types, and the name and type for arrays,
28505 structures and unions. In this last case, a frontend can immediately
28506 display the value of simple data types and create variable objects for
28507 other data types when the user wishes to explore their values in
28508 more detail. If the option @code{--no-frame-filters} is supplied, then
28509 Python frame filters will not be executed.
28511 If the @code{--skip-unavailable} option is specified, local variables
28512 that are not available are not listed. Partially available local
28513 variables are still displayed, however.
28515 This command is deprecated in favor of the
28516 @samp{-stack-list-variables} command.
28518 @subsubheading @value{GDBN} Command
28520 @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}.
28522 @subsubheading Example
28526 -stack-list-locals 0
28527 ^done,locals=[name="A",name="B",name="C"]
28529 -stack-list-locals --all-values
28530 ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
28531 @{name="C",value="@{1, 2, 3@}"@}]
28532 -stack-list-locals --simple-values
28533 ^done,locals=[@{name="A",type="int",value="1"@},
28534 @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
28538 @anchor{-stack-list-variables}
28539 @subheading The @code{-stack-list-variables} Command
28540 @findex -stack-list-variables
28542 @subsubheading Synopsis
28545 -stack-list-variables [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28548 Display the names of local variables and function arguments for the selected frame. If
28549 @var{print-values} is 0 or @code{--no-values}, print only the names of
28550 the variables; if it is 1 or @code{--all-values}, print also their
28551 values; and if it is 2 or @code{--simple-values}, print the name,
28552 type and value for simple data types, and the name and type for arrays,
28553 structures and unions. If the option @code{--no-frame-filters} is
28554 supplied, then Python frame filters will not be executed.
28556 If the @code{--skip-unavailable} option is specified, local variables
28557 and arguments that are not available are not listed. Partially
28558 available arguments and local variables are still displayed, however.
28560 @subsubheading Example
28564 -stack-list-variables --thread 1 --frame 0 --all-values
28565 ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}]
28570 @subheading The @code{-stack-select-frame} Command
28571 @findex -stack-select-frame
28573 @subsubheading Synopsis
28576 -stack-select-frame @var{framenum}
28579 Change the selected frame. Select a different frame @var{framenum} on
28582 This command in deprecated in favor of passing the @samp{--frame}
28583 option to every command.
28585 @subsubheading @value{GDBN} Command
28587 The corresponding @value{GDBN} commands are @samp{frame}, @samp{up},
28588 @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}.
28590 @subsubheading Example
28594 -stack-select-frame 2
28599 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28600 @node GDB/MI Variable Objects
28601 @section @sc{gdb/mi} Variable Objects
28605 @subheading Motivation for Variable Objects in @sc{gdb/mi}
28607 For the implementation of a variable debugger window (locals, watched
28608 expressions, etc.), we are proposing the adaptation of the existing code
28609 used by @code{Insight}.
28611 The two main reasons for that are:
28615 It has been proven in practice (it is already on its second generation).
28618 It will shorten development time (needless to say how important it is
28622 The original interface was designed to be used by Tcl code, so it was
28623 slightly changed so it could be used through @sc{gdb/mi}. This section
28624 describes the @sc{gdb/mi} operations that will be available and gives some
28625 hints about their use.
28627 @emph{Note}: In addition to the set of operations described here, we
28628 expect the @sc{gui} implementation of a variable window to require, at
28629 least, the following operations:
28632 @item @code{-gdb-show} @code{output-radix}
28633 @item @code{-stack-list-arguments}
28634 @item @code{-stack-list-locals}
28635 @item @code{-stack-select-frame}
28640 @subheading Introduction to Variable Objects
28642 @cindex variable objects in @sc{gdb/mi}
28644 Variable objects are "object-oriented" MI interface for examining and
28645 changing values of expressions. Unlike some other MI interfaces that
28646 work with expressions, variable objects are specifically designed for
28647 simple and efficient presentation in the frontend. A variable object
28648 is identified by string name. When a variable object is created, the
28649 frontend specifies the expression for that variable object. The
28650 expression can be a simple variable, or it can be an arbitrary complex
28651 expression, and can even involve CPU registers. After creating a
28652 variable object, the frontend can invoke other variable object
28653 operations---for example to obtain or change the value of a variable
28654 object, or to change display format.
28656 Variable objects have hierarchical tree structure. Any variable object
28657 that corresponds to a composite type, such as structure in C, has
28658 a number of child variable objects, for example corresponding to each
28659 element of a structure. A child variable object can itself have
28660 children, recursively. Recursion ends when we reach
28661 leaf variable objects, which always have built-in types. Child variable
28662 objects are created only by explicit request, so if a frontend
28663 is not interested in the children of a particular variable object, no
28664 child will be created.
28666 For a leaf variable object it is possible to obtain its value as a
28667 string, or set the value from a string. String value can be also
28668 obtained for a non-leaf variable object, but it's generally a string
28669 that only indicates the type of the object, and does not list its
28670 contents. Assignment to a non-leaf variable object is not allowed.
28672 A frontend does not need to read the values of all variable objects each time
28673 the program stops. Instead, MI provides an update command that lists all
28674 variable objects whose values has changed since the last update
28675 operation. This considerably reduces the amount of data that must
28676 be transferred to the frontend. As noted above, children variable
28677 objects are created on demand, and only leaf variable objects have a
28678 real value. As result, gdb will read target memory only for leaf
28679 variables that frontend has created.
28681 The automatic update is not always desirable. For example, a frontend
28682 might want to keep a value of some expression for future reference,
28683 and never update it. For another example, fetching memory is
28684 relatively slow for embedded targets, so a frontend might want
28685 to disable automatic update for the variables that are either not
28686 visible on the screen, or ``closed''. This is possible using so
28687 called ``frozen variable objects''. Such variable objects are never
28688 implicitly updated.
28690 Variable objects can be either @dfn{fixed} or @dfn{floating}. For the
28691 fixed variable object, the expression is parsed when the variable
28692 object is created, including associating identifiers to specific
28693 variables. The meaning of expression never changes. For a floating
28694 variable object the values of variables whose names appear in the
28695 expressions are re-evaluated every time in the context of the current
28696 frame. Consider this example:
28701 struct work_state state;
28708 If a fixed variable object for the @code{state} variable is created in
28709 this function, and we enter the recursive call, the variable
28710 object will report the value of @code{state} in the top-level
28711 @code{do_work} invocation. On the other hand, a floating variable
28712 object will report the value of @code{state} in the current frame.
28714 If an expression specified when creating a fixed variable object
28715 refers to a local variable, the variable object becomes bound to the
28716 thread and frame in which the variable object is created. When such
28717 variable object is updated, @value{GDBN} makes sure that the
28718 thread/frame combination the variable object is bound to still exists,
28719 and re-evaluates the variable object in context of that thread/frame.
28721 The following is the complete set of @sc{gdb/mi} operations defined to
28722 access this functionality:
28724 @multitable @columnfractions .4 .6
28725 @item @strong{Operation}
28726 @tab @strong{Description}
28728 @item @code{-enable-pretty-printing}
28729 @tab enable Python-based pretty-printing
28730 @item @code{-var-create}
28731 @tab create a variable object
28732 @item @code{-var-delete}
28733 @tab delete the variable object and/or its children
28734 @item @code{-var-set-format}
28735 @tab set the display format of this variable
28736 @item @code{-var-show-format}
28737 @tab show the display format of this variable
28738 @item @code{-var-info-num-children}
28739 @tab tells how many children this object has
28740 @item @code{-var-list-children}
28741 @tab return a list of the object's children
28742 @item @code{-var-info-type}
28743 @tab show the type of this variable object
28744 @item @code{-var-info-expression}
28745 @tab print parent-relative expression that this variable object represents
28746 @item @code{-var-info-path-expression}
28747 @tab print full expression that this variable object represents
28748 @item @code{-var-show-attributes}
28749 @tab is this variable editable? does it exist here?
28750 @item @code{-var-evaluate-expression}
28751 @tab get the value of this variable
28752 @item @code{-var-assign}
28753 @tab set the value of this variable
28754 @item @code{-var-update}
28755 @tab update the variable and its children
28756 @item @code{-var-set-frozen}
28757 @tab set frozeness attribute
28758 @item @code{-var-set-update-range}
28759 @tab set range of children to display on update
28762 In the next subsection we describe each operation in detail and suggest
28763 how it can be used.
28765 @subheading Description And Use of Operations on Variable Objects
28767 @subheading The @code{-enable-pretty-printing} Command
28768 @findex -enable-pretty-printing
28771 -enable-pretty-printing
28774 @value{GDBN} allows Python-based visualizers to affect the output of the
28775 MI variable object commands. However, because there was no way to
28776 implement this in a fully backward-compatible way, a front end must
28777 request that this functionality be enabled.
28779 Once enabled, this feature cannot be disabled.
28781 Note that if Python support has not been compiled into @value{GDBN},
28782 this command will still succeed (and do nothing).
28784 This feature is currently (as of @value{GDBN} 7.0) experimental, and
28785 may work differently in future versions of @value{GDBN}.
28787 @subheading The @code{-var-create} Command
28788 @findex -var-create
28790 @subsubheading Synopsis
28793 -var-create @{@var{name} | "-"@}
28794 @{@var{frame-addr} | "*" | "@@"@} @var{expression}
28797 This operation creates a variable object, which allows the monitoring of
28798 a variable, the result of an expression, a memory cell or a CPU
28801 The @var{name} parameter is the string by which the object can be
28802 referenced. It must be unique. If @samp{-} is specified, the varobj
28803 system will generate a string ``varNNNNNN'' automatically. It will be
28804 unique provided that one does not specify @var{name} of that format.
28805 The command fails if a duplicate name is found.
28807 The frame under which the expression should be evaluated can be
28808 specified by @var{frame-addr}. A @samp{*} indicates that the current
28809 frame should be used. A @samp{@@} indicates that a floating variable
28810 object must be created.
28812 @var{expression} is any expression valid on the current language set (must not
28813 begin with a @samp{*}), or one of the following:
28817 @samp{*@var{addr}}, where @var{addr} is the address of a memory cell
28820 @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
28823 @samp{$@var{regname}} --- a CPU register name
28826 @cindex dynamic varobj
28827 A varobj's contents may be provided by a Python-based pretty-printer. In this
28828 case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs
28829 have slightly different semantics in some cases. If the
28830 @code{-enable-pretty-printing} command is not sent, then @value{GDBN}
28831 will never create a dynamic varobj. This ensures backward
28832 compatibility for existing clients.
28834 @subsubheading Result
28836 This operation returns attributes of the newly-created varobj. These
28841 The name of the varobj.
28844 The number of children of the varobj. This number is not necessarily
28845 reliable for a dynamic varobj. Instead, you must examine the
28846 @samp{has_more} attribute.
28849 The varobj's scalar value. For a varobj whose type is some sort of
28850 aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value
28851 will not be interesting.
28854 The varobj's type. This is a string representation of the type, as
28855 would be printed by the @value{GDBN} CLI. If @samp{print object}
28856 (@pxref{Print Settings, set print object}) is set to @code{on}, the
28857 @emph{actual} (derived) type of the object is shown rather than the
28858 @emph{declared} one.
28861 If a variable object is bound to a specific thread, then this is the
28862 thread's identifier.
28865 For a dynamic varobj, this indicates whether there appear to be any
28866 children available. For a non-dynamic varobj, this will be 0.
28869 This attribute will be present and have the value @samp{1} if the
28870 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
28871 then this attribute will not be present.
28874 A dynamic varobj can supply a display hint to the front end. The
28875 value comes directly from the Python pretty-printer object's
28876 @code{display_hint} method. @xref{Pretty Printing API}.
28879 Typical output will look like this:
28882 name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}",
28883 has_more="@var{has_more}"
28887 @subheading The @code{-var-delete} Command
28888 @findex -var-delete
28890 @subsubheading Synopsis
28893 -var-delete [ -c ] @var{name}
28896 Deletes a previously created variable object and all of its children.
28897 With the @samp{-c} option, just deletes the children.
28899 Returns an error if the object @var{name} is not found.
28902 @subheading The @code{-var-set-format} Command
28903 @findex -var-set-format
28905 @subsubheading Synopsis
28908 -var-set-format @var{name} @var{format-spec}
28911 Sets the output format for the value of the object @var{name} to be
28914 @anchor{-var-set-format}
28915 The syntax for the @var{format-spec} is as follows:
28918 @var{format-spec} @expansion{}
28919 @{binary | decimal | hexadecimal | octal | natural@}
28922 The natural format is the default format choosen automatically
28923 based on the variable type (like decimal for an @code{int}, hex
28924 for pointers, etc.).
28926 For a variable with children, the format is set only on the
28927 variable itself, and the children are not affected.
28929 @subheading The @code{-var-show-format} Command
28930 @findex -var-show-format
28932 @subsubheading Synopsis
28935 -var-show-format @var{name}
28938 Returns the format used to display the value of the object @var{name}.
28941 @var{format} @expansion{}
28946 @subheading The @code{-var-info-num-children} Command
28947 @findex -var-info-num-children
28949 @subsubheading Synopsis
28952 -var-info-num-children @var{name}
28955 Returns the number of children of a variable object @var{name}:
28961 Note that this number is not completely reliable for a dynamic varobj.
28962 It will return the current number of children, but more children may
28966 @subheading The @code{-var-list-children} Command
28967 @findex -var-list-children
28969 @subsubheading Synopsis
28972 -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}]
28974 @anchor{-var-list-children}
28976 Return a list of the children of the specified variable object and
28977 create variable objects for them, if they do not already exist. With
28978 a single argument or if @var{print-values} has a value of 0 or
28979 @code{--no-values}, print only the names of the variables; if
28980 @var{print-values} is 1 or @code{--all-values}, also print their
28981 values; and if it is 2 or @code{--simple-values} print the name and
28982 value for simple data types and just the name for arrays, structures
28985 @var{from} and @var{to}, if specified, indicate the range of children
28986 to report. If @var{from} or @var{to} is less than zero, the range is
28987 reset and all children will be reported. Otherwise, children starting
28988 at @var{from} (zero-based) and up to and excluding @var{to} will be
28991 If a child range is requested, it will only affect the current call to
28992 @code{-var-list-children}, but not future calls to @code{-var-update}.
28993 For this, you must instead use @code{-var-set-update-range}. The
28994 intent of this approach is to enable a front end to implement any
28995 update approach it likes; for example, scrolling a view may cause the
28996 front end to request more children with @code{-var-list-children}, and
28997 then the front end could call @code{-var-set-update-range} with a
28998 different range to ensure that future updates are restricted to just
29001 For each child the following results are returned:
29006 Name of the variable object created for this child.
29009 The expression to be shown to the user by the front end to designate this child.
29010 For example this may be the name of a structure member.
29012 For a dynamic varobj, this value cannot be used to form an
29013 expression. There is no way to do this at all with a dynamic varobj.
29015 For C/C@t{++} structures there are several pseudo children returned to
29016 designate access qualifiers. For these pseudo children @var{exp} is
29017 @samp{public}, @samp{private}, or @samp{protected}. In this case the
29018 type and value are not present.
29020 A dynamic varobj will not report the access qualifying
29021 pseudo-children, regardless of the language. This information is not
29022 available at all with a dynamic varobj.
29025 Number of children this child has. For a dynamic varobj, this will be
29029 The type of the child. If @samp{print object}
29030 (@pxref{Print Settings, set print object}) is set to @code{on}, the
29031 @emph{actual} (derived) type of the object is shown rather than the
29032 @emph{declared} one.
29035 If values were requested, this is the value.
29038 If this variable object is associated with a thread, this is the thread id.
29039 Otherwise this result is not present.
29042 If the variable object is frozen, this variable will be present with a value of 1.
29045 A dynamic varobj can supply a display hint to the front end. The
29046 value comes directly from the Python pretty-printer object's
29047 @code{display_hint} method. @xref{Pretty Printing API}.
29050 This attribute will be present and have the value @samp{1} if the
29051 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
29052 then this attribute will not be present.
29056 The result may have its own attributes:
29060 A dynamic varobj can supply a display hint to the front end. The
29061 value comes directly from the Python pretty-printer object's
29062 @code{display_hint} method. @xref{Pretty Printing API}.
29065 This is an integer attribute which is nonzero if there are children
29066 remaining after the end of the selected range.
29069 @subsubheading Example
29073 -var-list-children n
29074 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
29075 numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
29077 -var-list-children --all-values n
29078 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
29079 numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
29083 @subheading The @code{-var-info-type} Command
29084 @findex -var-info-type
29086 @subsubheading Synopsis
29089 -var-info-type @var{name}
29092 Returns the type of the specified variable @var{name}. The type is
29093 returned as a string in the same format as it is output by the
29097 type=@var{typename}
29101 @subheading The @code{-var-info-expression} Command
29102 @findex -var-info-expression
29104 @subsubheading Synopsis
29107 -var-info-expression @var{name}
29110 Returns a string that is suitable for presenting this
29111 variable object in user interface. The string is generally
29112 not valid expression in the current language, and cannot be evaluated.
29114 For example, if @code{a} is an array, and variable object
29115 @code{A} was created for @code{a}, then we'll get this output:
29118 (gdb) -var-info-expression A.1
29119 ^done,lang="C",exp="1"
29123 Here, the value of @code{lang} is the language name, which can be
29124 found in @ref{Supported Languages}.
29126 Note that the output of the @code{-var-list-children} command also
29127 includes those expressions, so the @code{-var-info-expression} command
29130 @subheading The @code{-var-info-path-expression} Command
29131 @findex -var-info-path-expression
29133 @subsubheading Synopsis
29136 -var-info-path-expression @var{name}
29139 Returns an expression that can be evaluated in the current
29140 context and will yield the same value that a variable object has.
29141 Compare this with the @code{-var-info-expression} command, which
29142 result can be used only for UI presentation. Typical use of
29143 the @code{-var-info-path-expression} command is creating a
29144 watchpoint from a variable object.
29146 This command is currently not valid for children of a dynamic varobj,
29147 and will give an error when invoked on one.
29149 For example, suppose @code{C} is a C@t{++} class, derived from class
29150 @code{Base}, and that the @code{Base} class has a member called
29151 @code{m_size}. Assume a variable @code{c} is has the type of
29152 @code{C} and a variable object @code{C} was created for variable
29153 @code{c}. Then, we'll get this output:
29155 (gdb) -var-info-path-expression C.Base.public.m_size
29156 ^done,path_expr=((Base)c).m_size)
29159 @subheading The @code{-var-show-attributes} Command
29160 @findex -var-show-attributes
29162 @subsubheading Synopsis
29165 -var-show-attributes @var{name}
29168 List attributes of the specified variable object @var{name}:
29171 status=@var{attr} [ ( ,@var{attr} )* ]
29175 where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}.
29177 @subheading The @code{-var-evaluate-expression} Command
29178 @findex -var-evaluate-expression
29180 @subsubheading Synopsis
29183 -var-evaluate-expression [-f @var{format-spec}] @var{name}
29186 Evaluates the expression that is represented by the specified variable
29187 object and returns its value as a string. The format of the string
29188 can be specified with the @samp{-f} option. The possible values of
29189 this option are the same as for @code{-var-set-format}
29190 (@pxref{-var-set-format}). If the @samp{-f} option is not specified,
29191 the current display format will be used. The current display format
29192 can be changed using the @code{-var-set-format} command.
29198 Note that one must invoke @code{-var-list-children} for a variable
29199 before the value of a child variable can be evaluated.
29201 @subheading The @code{-var-assign} Command
29202 @findex -var-assign
29204 @subsubheading Synopsis
29207 -var-assign @var{name} @var{expression}
29210 Assigns the value of @var{expression} to the variable object specified
29211 by @var{name}. The object must be @samp{editable}. If the variable's
29212 value is altered by the assign, the variable will show up in any
29213 subsequent @code{-var-update} list.
29215 @subsubheading Example
29223 ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
29227 @subheading The @code{-var-update} Command
29228 @findex -var-update
29230 @subsubheading Synopsis
29233 -var-update [@var{print-values}] @{@var{name} | "*"@}
29236 Reevaluate the expressions corresponding to the variable object
29237 @var{name} and all its direct and indirect children, and return the
29238 list of variable objects whose values have changed; @var{name} must
29239 be a root variable object. Here, ``changed'' means that the result of
29240 @code{-var-evaluate-expression} before and after the
29241 @code{-var-update} is different. If @samp{*} is used as the variable
29242 object names, all existing variable objects are updated, except
29243 for frozen ones (@pxref{-var-set-frozen}). The option
29244 @var{print-values} determines whether both names and values, or just
29245 names are printed. The possible values of this option are the same
29246 as for @code{-var-list-children} (@pxref{-var-list-children}). It is
29247 recommended to use the @samp{--all-values} option, to reduce the
29248 number of MI commands needed on each program stop.
29250 With the @samp{*} parameter, if a variable object is bound to a
29251 currently running thread, it will not be updated, without any
29254 If @code{-var-set-update-range} was previously used on a varobj, then
29255 only the selected range of children will be reported.
29257 @code{-var-update} reports all the changed varobjs in a tuple named
29260 Each item in the change list is itself a tuple holding:
29264 The name of the varobj.
29267 If values were requested for this update, then this field will be
29268 present and will hold the value of the varobj.
29271 @anchor{-var-update}
29272 This field is a string which may take one of three values:
29276 The variable object's current value is valid.
29279 The variable object does not currently hold a valid value but it may
29280 hold one in the future if its associated expression comes back into
29284 The variable object no longer holds a valid value.
29285 This can occur when the executable file being debugged has changed,
29286 either through recompilation or by using the @value{GDBN} @code{file}
29287 command. The front end should normally choose to delete these variable
29291 In the future new values may be added to this list so the front should
29292 be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}.
29295 This is only present if the varobj is still valid. If the type
29296 changed, then this will be the string @samp{true}; otherwise it will
29299 When a varobj's type changes, its children are also likely to have
29300 become incorrect. Therefore, the varobj's children are automatically
29301 deleted when this attribute is @samp{true}. Also, the varobj's update
29302 range, when set using the @code{-var-set-update-range} command, is
29306 If the varobj's type changed, then this field will be present and will
29309 @item new_num_children
29310 For a dynamic varobj, if the number of children changed, or if the
29311 type changed, this will be the new number of children.
29313 The @samp{numchild} field in other varobj responses is generally not
29314 valid for a dynamic varobj -- it will show the number of children that
29315 @value{GDBN} knows about, but because dynamic varobjs lazily
29316 instantiate their children, this will not reflect the number of
29317 children which may be available.
29319 The @samp{new_num_children} attribute only reports changes to the
29320 number of children known by @value{GDBN}. This is the only way to
29321 detect whether an update has removed children (which necessarily can
29322 only happen at the end of the update range).
29325 The display hint, if any.
29328 This is an integer value, which will be 1 if there are more children
29329 available outside the varobj's update range.
29332 This attribute will be present and have the value @samp{1} if the
29333 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
29334 then this attribute will not be present.
29337 If new children were added to a dynamic varobj within the selected
29338 update range (as set by @code{-var-set-update-range}), then they will
29339 be listed in this attribute.
29342 @subsubheading Example
29349 -var-update --all-values var1
29350 ^done,changelist=[@{name="var1",value="3",in_scope="true",
29351 type_changed="false"@}]
29355 @subheading The @code{-var-set-frozen} Command
29356 @findex -var-set-frozen
29357 @anchor{-var-set-frozen}
29359 @subsubheading Synopsis
29362 -var-set-frozen @var{name} @var{flag}
29365 Set the frozenness flag on the variable object @var{name}. The
29366 @var{flag} parameter should be either @samp{1} to make the variable
29367 frozen or @samp{0} to make it unfrozen. If a variable object is
29368 frozen, then neither itself, nor any of its children, are
29369 implicitly updated by @code{-var-update} of
29370 a parent variable or by @code{-var-update *}. Only
29371 @code{-var-update} of the variable itself will update its value and
29372 values of its children. After a variable object is unfrozen, it is
29373 implicitly updated by all subsequent @code{-var-update} operations.
29374 Unfreezing a variable does not update it, only subsequent
29375 @code{-var-update} does.
29377 @subsubheading Example
29381 -var-set-frozen V 1
29386 @subheading The @code{-var-set-update-range} command
29387 @findex -var-set-update-range
29388 @anchor{-var-set-update-range}
29390 @subsubheading Synopsis
29393 -var-set-update-range @var{name} @var{from} @var{to}
29396 Set the range of children to be returned by future invocations of
29397 @code{-var-update}.
29399 @var{from} and @var{to} indicate the range of children to report. If
29400 @var{from} or @var{to} is less than zero, the range is reset and all
29401 children will be reported. Otherwise, children starting at @var{from}
29402 (zero-based) and up to and excluding @var{to} will be reported.
29404 @subsubheading Example
29408 -var-set-update-range V 1 2
29412 @subheading The @code{-var-set-visualizer} command
29413 @findex -var-set-visualizer
29414 @anchor{-var-set-visualizer}
29416 @subsubheading Synopsis
29419 -var-set-visualizer @var{name} @var{visualizer}
29422 Set a visualizer for the variable object @var{name}.
29424 @var{visualizer} is the visualizer to use. The special value
29425 @samp{None} means to disable any visualizer in use.
29427 If not @samp{None}, @var{visualizer} must be a Python expression.
29428 This expression must evaluate to a callable object which accepts a
29429 single argument. @value{GDBN} will call this object with the value of
29430 the varobj @var{name} as an argument (this is done so that the same
29431 Python pretty-printing code can be used for both the CLI and MI).
29432 When called, this object must return an object which conforms to the
29433 pretty-printing interface (@pxref{Pretty Printing API}).
29435 The pre-defined function @code{gdb.default_visualizer} may be used to
29436 select a visualizer by following the built-in process
29437 (@pxref{Selecting Pretty-Printers}). This is done automatically when
29438 a varobj is created, and so ordinarily is not needed.
29440 This feature is only available if Python support is enabled. The MI
29441 command @code{-list-features} (@pxref{GDB/MI Support Commands})
29442 can be used to check this.
29444 @subsubheading Example
29446 Resetting the visualizer:
29450 -var-set-visualizer V None
29454 Reselecting the default (type-based) visualizer:
29458 -var-set-visualizer V gdb.default_visualizer
29462 Suppose @code{SomeClass} is a visualizer class. A lambda expression
29463 can be used to instantiate this class for a varobj:
29467 -var-set-visualizer V "lambda val: SomeClass()"
29471 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29472 @node GDB/MI Data Manipulation
29473 @section @sc{gdb/mi} Data Manipulation
29475 @cindex data manipulation, in @sc{gdb/mi}
29476 @cindex @sc{gdb/mi}, data manipulation
29477 This section describes the @sc{gdb/mi} commands that manipulate data:
29478 examine memory and registers, evaluate expressions, etc.
29480 For details about what an addressable memory unit is,
29481 @pxref{addressable memory unit}.
29483 @c REMOVED FROM THE INTERFACE.
29484 @c @subheading -data-assign
29485 @c Change the value of a program variable. Plenty of side effects.
29486 @c @subsubheading GDB Command
29488 @c @subsubheading Example
29491 @subheading The @code{-data-disassemble} Command
29492 @findex -data-disassemble
29494 @subsubheading Synopsis
29498 [ -s @var{start-addr} -e @var{end-addr} ]
29499 | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
29507 @item @var{start-addr}
29508 is the beginning address (or @code{$pc})
29509 @item @var{end-addr}
29511 @item @var{filename}
29512 is the name of the file to disassemble
29513 @item @var{linenum}
29514 is the line number to disassemble around
29516 is the number of disassembly lines to be produced. If it is -1,
29517 the whole function will be disassembled, in case no @var{end-addr} is
29518 specified. If @var{end-addr} is specified as a non-zero value, and
29519 @var{lines} is lower than the number of disassembly lines between
29520 @var{start-addr} and @var{end-addr}, only @var{lines} lines are
29521 displayed; if @var{lines} is higher than the number of lines between
29522 @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
29527 @item 0 disassembly only
29528 @item 1 mixed source and disassembly (deprecated)
29529 @item 2 disassembly with raw opcodes
29530 @item 3 mixed source and disassembly with raw opcodes (deprecated)
29531 @item 4 mixed source and disassembly
29532 @item 5 mixed source and disassembly with raw opcodes
29535 Modes 1 and 3 are deprecated. The output is ``source centric''
29536 which hasn't proved useful in practice.
29537 @xref{Machine Code}, for a discussion of the difference between
29538 @code{/m} and @code{/s} output of the @code{disassemble} command.
29541 @subsubheading Result
29543 The result of the @code{-data-disassemble} command will be a list named
29544 @samp{asm_insns}, the contents of this list depend on the @var{mode}
29545 used with the @code{-data-disassemble} command.
29547 For modes 0 and 2 the @samp{asm_insns} list contains tuples with the
29552 The address at which this instruction was disassembled.
29555 The name of the function this instruction is within.
29558 The decimal offset in bytes from the start of @samp{func-name}.
29561 The text disassembly for this @samp{address}.
29564 This field is only present for modes 2, 3 and 5. This contains the raw opcode
29565 bytes for the @samp{inst} field.
29569 For modes 1, 3, 4 and 5 the @samp{asm_insns} list contains tuples named
29570 @samp{src_and_asm_line}, each of which has the following fields:
29574 The line number within @samp{file}.
29577 The file name from the compilation unit. This might be an absolute
29578 file name or a relative file name depending on the compile command
29582 Absolute file name of @samp{file}. It is converted to a canonical form
29583 using the source file search path
29584 (@pxref{Source Path, ,Specifying Source Directories})
29585 and after resolving all the symbolic links.
29587 If the source file is not found this field will contain the path as
29588 present in the debug information.
29590 @item line_asm_insn
29591 This is a list of tuples containing the disassembly for @samp{line} in
29592 @samp{file}. The fields of each tuple are the same as for
29593 @code{-data-disassemble} in @var{mode} 0 and 2, so @samp{address},
29594 @samp{func-name}, @samp{offset}, @samp{inst}, and optionally
29599 Note that whatever included in the @samp{inst} field, is not
29600 manipulated directly by @sc{gdb/mi}, i.e., it is not possible to
29603 @subsubheading @value{GDBN} Command
29605 The corresponding @value{GDBN} command is @samp{disassemble}.
29607 @subsubheading Example
29609 Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
29613 -data-disassemble -s $pc -e "$pc + 20" -- 0
29616 @{address="0x000107c0",func-name="main",offset="4",
29617 inst="mov 2, %o0"@},
29618 @{address="0x000107c4",func-name="main",offset="8",
29619 inst="sethi %hi(0x11800), %o2"@},
29620 @{address="0x000107c8",func-name="main",offset="12",
29621 inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@},
29622 @{address="0x000107cc",func-name="main",offset="16",
29623 inst="sethi %hi(0x11800), %o2"@},
29624 @{address="0x000107d0",func-name="main",offset="20",
29625 inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
29629 Disassemble the whole @code{main} function. Line 32 is part of
29633 -data-disassemble -f basics.c -l 32 -- 0
29635 @{address="0x000107bc",func-name="main",offset="0",
29636 inst="save %sp, -112, %sp"@},
29637 @{address="0x000107c0",func-name="main",offset="4",
29638 inst="mov 2, %o0"@},
29639 @{address="0x000107c4",func-name="main",offset="8",
29640 inst="sethi %hi(0x11800), %o2"@},
29642 @{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
29643 @{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
29647 Disassemble 3 instructions from the start of @code{main}:
29651 -data-disassemble -f basics.c -l 32 -n 3 -- 0
29653 @{address="0x000107bc",func-name="main",offset="0",
29654 inst="save %sp, -112, %sp"@},
29655 @{address="0x000107c0",func-name="main",offset="4",
29656 inst="mov 2, %o0"@},
29657 @{address="0x000107c4",func-name="main",offset="8",
29658 inst="sethi %hi(0x11800), %o2"@}]
29662 Disassemble 3 instructions from the start of @code{main} in mixed mode:
29666 -data-disassemble -f basics.c -l 32 -n 3 -- 1
29668 src_and_asm_line=@{line="31",
29669 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
29670 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
29671 line_asm_insn=[@{address="0x000107bc",
29672 func-name="main",offset="0",inst="save %sp, -112, %sp"@}]@},
29673 src_and_asm_line=@{line="32",
29674 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
29675 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
29676 line_asm_insn=[@{address="0x000107c0",
29677 func-name="main",offset="4",inst="mov 2, %o0"@},
29678 @{address="0x000107c4",func-name="main",offset="8",
29679 inst="sethi %hi(0x11800), %o2"@}]@}]
29684 @subheading The @code{-data-evaluate-expression} Command
29685 @findex -data-evaluate-expression
29687 @subsubheading Synopsis
29690 -data-evaluate-expression @var{expr}
29693 Evaluate @var{expr} as an expression. The expression could contain an
29694 inferior function call. The function call will execute synchronously.
29695 If the expression contains spaces, it must be enclosed in double quotes.
29697 @subsubheading @value{GDBN} Command
29699 The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and
29700 @samp{call}. In @code{gdbtk} only, there's a corresponding
29701 @samp{gdb_eval} command.
29703 @subsubheading Example
29705 In the following example, the numbers that precede the commands are the
29706 @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi}
29707 Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its
29711 211-data-evaluate-expression A
29714 311-data-evaluate-expression &A
29715 311^done,value="0xefffeb7c"
29717 411-data-evaluate-expression A+3
29720 511-data-evaluate-expression "A + 3"
29726 @subheading The @code{-data-list-changed-registers} Command
29727 @findex -data-list-changed-registers
29729 @subsubheading Synopsis
29732 -data-list-changed-registers
29735 Display a list of the registers that have changed.
29737 @subsubheading @value{GDBN} Command
29739 @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk}
29740 has the corresponding command @samp{gdb_changed_register_list}.
29742 @subsubheading Example
29744 On a PPC MBX board:
29752 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{
29753 func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c",
29756 -data-list-changed-registers
29757 ^done,changed-registers=["0","1","2","4","5","6","7","8","9",
29758 "10","11","13","14","15","16","17","18","19","20","21","22","23",
29759 "24","25","26","27","28","30","31","64","65","66","67","69"]
29764 @subheading The @code{-data-list-register-names} Command
29765 @findex -data-list-register-names
29767 @subsubheading Synopsis
29770 -data-list-register-names [ ( @var{regno} )+ ]
29773 Show a list of register names for the current target. If no arguments
29774 are given, it shows a list of the names of all the registers. If
29775 integer numbers are given as arguments, it will print a list of the
29776 names of the registers corresponding to the arguments. To ensure
29777 consistency between a register name and its number, the output list may
29778 include empty register names.
29780 @subsubheading @value{GDBN} Command
29782 @value{GDBN} does not have a command which corresponds to
29783 @samp{-data-list-register-names}. In @code{gdbtk} there is a
29784 corresponding command @samp{gdb_regnames}.
29786 @subsubheading Example
29788 For the PPC MBX board:
29791 -data-list-register-names
29792 ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
29793 "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
29794 "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
29795 "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
29796 "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
29797 "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
29798 "", "pc","ps","cr","lr","ctr","xer"]
29800 -data-list-register-names 1 2 3
29801 ^done,register-names=["r1","r2","r3"]
29805 @subheading The @code{-data-list-register-values} Command
29806 @findex -data-list-register-values
29808 @subsubheading Synopsis
29811 -data-list-register-values
29812 [ @code{--skip-unavailable} ] @var{fmt} [ ( @var{regno} )*]
29815 Display the registers' contents. The format according to which the
29816 registers' contents are to be returned is given by @var{fmt}, followed
29817 by an optional list of numbers specifying the registers to display. A
29818 missing list of numbers indicates that the contents of all the
29819 registers must be returned. The @code{--skip-unavailable} option
29820 indicates that only the available registers are to be returned.
29822 Allowed formats for @var{fmt} are:
29839 @subsubheading @value{GDBN} Command
29841 The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info
29842 all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}.
29844 @subsubheading Example
29846 For a PPC MBX board (note: line breaks are for readability only, they
29847 don't appear in the actual output):
29851 -data-list-register-values r 64 65
29852 ^done,register-values=[@{number="64",value="0xfe00a300"@},
29853 @{number="65",value="0x00029002"@}]
29855 -data-list-register-values x
29856 ^done,register-values=[@{number="0",value="0xfe0043c8"@},
29857 @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
29858 @{number="3",value="0x0"@},@{number="4",value="0xa"@},
29859 @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@},
29860 @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@},
29861 @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@},
29862 @{number="11",value="0x1"@},@{number="12",value="0x0"@},
29863 @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@},
29864 @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@},
29865 @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@},
29866 @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@},
29867 @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@},
29868 @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@},
29869 @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@},
29870 @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@},
29871 @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@},
29872 @{number="31",value="0x0"@},@{number="32",value="0x0"@},
29873 @{number="33",value="0x0"@},@{number="34",value="0x0"@},
29874 @{number="35",value="0x0"@},@{number="36",value="0x0"@},
29875 @{number="37",value="0x0"@},@{number="38",value="0x0"@},
29876 @{number="39",value="0x0"@},@{number="40",value="0x0"@},
29877 @{number="41",value="0x0"@},@{number="42",value="0x0"@},
29878 @{number="43",value="0x0"@},@{number="44",value="0x0"@},
29879 @{number="45",value="0x0"@},@{number="46",value="0x0"@},
29880 @{number="47",value="0x0"@},@{number="48",value="0x0"@},
29881 @{number="49",value="0x0"@},@{number="50",value="0x0"@},
29882 @{number="51",value="0x0"@},@{number="52",value="0x0"@},
29883 @{number="53",value="0x0"@},@{number="54",value="0x0"@},
29884 @{number="55",value="0x0"@},@{number="56",value="0x0"@},
29885 @{number="57",value="0x0"@},@{number="58",value="0x0"@},
29886 @{number="59",value="0x0"@},@{number="60",value="0x0"@},
29887 @{number="61",value="0x0"@},@{number="62",value="0x0"@},
29888 @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@},
29889 @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
29890 @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
29891 @{number="69",value="0x20002b03"@}]
29896 @subheading The @code{-data-read-memory} Command
29897 @findex -data-read-memory
29899 This command is deprecated, use @code{-data-read-memory-bytes} instead.
29901 @subsubheading Synopsis
29904 -data-read-memory [ -o @var{byte-offset} ]
29905 @var{address} @var{word-format} @var{word-size}
29906 @var{nr-rows} @var{nr-cols} [ @var{aschar} ]
29913 @item @var{address}
29914 An expression specifying the address of the first memory word to be
29915 read. Complex expressions containing embedded white space should be
29916 quoted using the C convention.
29918 @item @var{word-format}
29919 The format to be used to print the memory words. The notation is the
29920 same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats,
29923 @item @var{word-size}
29924 The size of each memory word in bytes.
29926 @item @var{nr-rows}
29927 The number of rows in the output table.
29929 @item @var{nr-cols}
29930 The number of columns in the output table.
29933 If present, indicates that each row should include an @sc{ascii} dump. The
29934 value of @var{aschar} is used as a padding character when a byte is not a
29935 member of the printable @sc{ascii} character set (printable @sc{ascii}
29936 characters are those whose code is between 32 and 126, inclusively).
29938 @item @var{byte-offset}
29939 An offset to add to the @var{address} before fetching memory.
29942 This command displays memory contents as a table of @var{nr-rows} by
29943 @var{nr-cols} words, each word being @var{word-size} bytes. In total,
29944 @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
29945 (returned as @samp{total-bytes}). Should less than the requested number
29946 of bytes be returned by the target, the missing words are identified
29947 using @samp{N/A}. The number of bytes read from the target is returned
29948 in @samp{nr-bytes} and the starting address used to read memory in
29951 The address of the next/previous row or page is available in
29952 @samp{next-row} and @samp{prev-row}, @samp{next-page} and
29955 @subsubheading @value{GDBN} Command
29957 The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has
29958 @samp{gdb_get_mem} memory read command.
29960 @subsubheading Example
29962 Read six bytes of memory starting at @code{bytes+6} but then offset by
29963 @code{-6} bytes. Format as three rows of two columns. One byte per
29964 word. Display each word in hex.
29968 9-data-read-memory -o -6 -- bytes+6 x 1 3 2
29969 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
29970 next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
29971 prev-page="0x0000138a",memory=[
29972 @{addr="0x00001390",data=["0x00","0x01"]@},
29973 @{addr="0x00001392",data=["0x02","0x03"]@},
29974 @{addr="0x00001394",data=["0x04","0x05"]@}]
29978 Read two bytes of memory starting at address @code{shorts + 64} and
29979 display as a single word formatted in decimal.
29983 5-data-read-memory shorts+64 d 2 1 1
29984 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
29985 next-row="0x00001512",prev-row="0x0000150e",
29986 next-page="0x00001512",prev-page="0x0000150e",memory=[
29987 @{addr="0x00001510",data=["128"]@}]
29991 Read thirty two bytes of memory starting at @code{bytes+16} and format
29992 as eight rows of four columns. Include a string encoding with @samp{x}
29993 used as the non-printable character.
29997 4-data-read-memory bytes+16 x 1 8 4 x
29998 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
29999 next-row="0x000013c0",prev-row="0x0000139c",
30000 next-page="0x000013c0",prev-page="0x00001380",memory=[
30001 @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@},
30002 @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@},
30003 @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@},
30004 @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@},
30005 @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@},
30006 @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
30007 @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
30008 @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
30012 @subheading The @code{-data-read-memory-bytes} Command
30013 @findex -data-read-memory-bytes
30015 @subsubheading Synopsis
30018 -data-read-memory-bytes [ -o @var{offset} ]
30019 @var{address} @var{count}
30026 @item @var{address}
30027 An expression specifying the address of the first addressable memory unit
30028 to be read. Complex expressions containing embedded white space should be
30029 quoted using the C convention.
30032 The number of addressable memory units to read. This should be an integer
30036 The offset relative to @var{address} at which to start reading. This
30037 should be an integer literal. This option is provided so that a frontend
30038 is not required to first evaluate address and then perform address
30039 arithmetics itself.
30043 This command attempts to read all accessible memory regions in the
30044 specified range. First, all regions marked as unreadable in the memory
30045 map (if one is defined) will be skipped. @xref{Memory Region
30046 Attributes}. Second, @value{GDBN} will attempt to read the remaining
30047 regions. For each one, if reading full region results in an errors,
30048 @value{GDBN} will try to read a subset of the region.
30050 In general, every single memory unit in the region may be readable or not,
30051 and the only way to read every readable unit is to try a read at
30052 every address, which is not practical. Therefore, @value{GDBN} will
30053 attempt to read all accessible memory units at either beginning or the end
30054 of the region, using a binary division scheme. This heuristic works
30055 well for reading accross a memory map boundary. Note that if a region
30056 has a readable range that is neither at the beginning or the end,
30057 @value{GDBN} will not read it.
30059 The result record (@pxref{GDB/MI Result Records}) that is output of
30060 the command includes a field named @samp{memory} whose content is a
30061 list of tuples. Each tuple represent a successfully read memory block
30062 and has the following fields:
30066 The start address of the memory block, as hexadecimal literal.
30069 The end address of the memory block, as hexadecimal literal.
30072 The offset of the memory block, as hexadecimal literal, relative to
30073 the start address passed to @code{-data-read-memory-bytes}.
30076 The contents of the memory block, in hex.
30082 @subsubheading @value{GDBN} Command
30084 The corresponding @value{GDBN} command is @samp{x}.
30086 @subsubheading Example
30090 -data-read-memory-bytes &a 10
30091 ^done,memory=[@{begin="0xbffff154",offset="0x00000000",
30093 contents="01000000020000000300"@}]
30098 @subheading The @code{-data-write-memory-bytes} Command
30099 @findex -data-write-memory-bytes
30101 @subsubheading Synopsis
30104 -data-write-memory-bytes @var{address} @var{contents}
30105 -data-write-memory-bytes @var{address} @var{contents} @r{[}@var{count}@r{]}
30112 @item @var{address}
30113 An expression specifying the address of the first addressable memory unit
30114 to be written. Complex expressions containing embedded white space should
30115 be quoted using the C convention.
30117 @item @var{contents}
30118 The hex-encoded data to write. It is an error if @var{contents} does
30119 not represent an integral number of addressable memory units.
30122 Optional argument indicating the number of addressable memory units to be
30123 written. If @var{count} is greater than @var{contents}' length,
30124 @value{GDBN} will repeatedly write @var{contents} until it fills
30125 @var{count} memory units.
30129 @subsubheading @value{GDBN} Command
30131 There's no corresponding @value{GDBN} command.
30133 @subsubheading Example
30137 -data-write-memory-bytes &a "aabbccdd"
30144 -data-write-memory-bytes &a "aabbccdd" 16e
30149 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30150 @node GDB/MI Tracepoint Commands
30151 @section @sc{gdb/mi} Tracepoint Commands
30153 The commands defined in this section implement MI support for
30154 tracepoints. For detailed introduction, see @ref{Tracepoints}.
30156 @subheading The @code{-trace-find} Command
30157 @findex -trace-find
30159 @subsubheading Synopsis
30162 -trace-find @var{mode} [@var{parameters}@dots{}]
30165 Find a trace frame using criteria defined by @var{mode} and
30166 @var{parameters}. The following table lists permissible
30167 modes and their parameters. For details of operation, see @ref{tfind}.
30172 No parameters are required. Stops examining trace frames.
30175 An integer is required as parameter. Selects tracepoint frame with
30178 @item tracepoint-number
30179 An integer is required as parameter. Finds next
30180 trace frame that corresponds to tracepoint with the specified number.
30183 An address is required as parameter. Finds
30184 next trace frame that corresponds to any tracepoint at the specified
30187 @item pc-inside-range
30188 Two addresses are required as parameters. Finds next trace
30189 frame that corresponds to a tracepoint at an address inside the
30190 specified range. Both bounds are considered to be inside the range.
30192 @item pc-outside-range
30193 Two addresses are required as parameters. Finds
30194 next trace frame that corresponds to a tracepoint at an address outside
30195 the specified range. Both bounds are considered to be inside the range.
30198 Line specification is required as parameter. @xref{Specify Location}.
30199 Finds next trace frame that corresponds to a tracepoint at
30200 the specified location.
30204 If @samp{none} was passed as @var{mode}, the response does not
30205 have fields. Otherwise, the response may have the following fields:
30209 This field has either @samp{0} or @samp{1} as the value, depending
30210 on whether a matching tracepoint was found.
30213 The index of the found traceframe. This field is present iff
30214 the @samp{found} field has value of @samp{1}.
30217 The index of the found tracepoint. This field is present iff
30218 the @samp{found} field has value of @samp{1}.
30221 The information about the frame corresponding to the found trace
30222 frame. This field is present only if a trace frame was found.
30223 @xref{GDB/MI Frame Information}, for description of this field.
30227 @subsubheading @value{GDBN} Command
30229 The corresponding @value{GDBN} command is @samp{tfind}.
30231 @subheading -trace-define-variable
30232 @findex -trace-define-variable
30234 @subsubheading Synopsis
30237 -trace-define-variable @var{name} [ @var{value} ]
30240 Create trace variable @var{name} if it does not exist. If
30241 @var{value} is specified, sets the initial value of the specified
30242 trace variable to that value. Note that the @var{name} should start
30243 with the @samp{$} character.
30245 @subsubheading @value{GDBN} Command
30247 The corresponding @value{GDBN} command is @samp{tvariable}.
30249 @subheading The @code{-trace-frame-collected} Command
30250 @findex -trace-frame-collected
30252 @subsubheading Synopsis
30255 -trace-frame-collected
30256 [--var-print-values @var{var_pval}]
30257 [--comp-print-values @var{comp_pval}]
30258 [--registers-format @var{regformat}]
30259 [--memory-contents]
30262 This command returns the set of collected objects, register names,
30263 trace state variable names, memory ranges and computed expressions
30264 that have been collected at a particular trace frame. The optional
30265 parameters to the command affect the output format in different ways.
30266 See the output description table below for more details.
30268 The reported names can be used in the normal manner to create
30269 varobjs and inspect the objects themselves. The items returned by
30270 this command are categorized so that it is clear which is a variable,
30271 which is a register, which is a trace state variable, which is a
30272 memory range and which is a computed expression.
30274 For instance, if the actions were
30276 collect myVar, myArray[myIndex], myObj.field, myPtr->field, myCount + 2
30277 collect *(int*)0xaf02bef0@@40
30281 the object collected in its entirety would be @code{myVar}. The
30282 object @code{myArray} would be partially collected, because only the
30283 element at index @code{myIndex} would be collected. The remaining
30284 objects would be computed expressions.
30286 An example output would be:
30290 -trace-frame-collected
30292 explicit-variables=[@{name="myVar",value="1"@}],
30293 computed-expressions=[@{name="myArray[myIndex]",value="0"@},
30294 @{name="myObj.field",value="0"@},
30295 @{name="myPtr->field",value="1"@},
30296 @{name="myCount + 2",value="3"@},
30297 @{name="$tvar1 + 1",value="43970027"@}],
30298 registers=[@{number="0",value="0x7fe2c6e79ec8"@},
30299 @{number="1",value="0x0"@},
30300 @{number="2",value="0x4"@},
30302 @{number="125",value="0x0"@}],
30303 tvars=[@{name="$tvar1",current="43970026"@}],
30304 memory=[@{address="0x0000000000602264",length="4"@},
30305 @{address="0x0000000000615bc0",length="4"@}]
30312 @item explicit-variables
30313 The set of objects that have been collected in their entirety (as
30314 opposed to collecting just a few elements of an array or a few struct
30315 members). For each object, its name and value are printed.
30316 The @code{--var-print-values} option affects how or whether the value
30317 field is output. If @var{var_pval} is 0, then print only the names;
30318 if it is 1, print also their values; and if it is 2, print the name,
30319 type and value for simple data types, and the name and type for
30320 arrays, structures and unions.
30322 @item computed-expressions
30323 The set of computed expressions that have been collected at the
30324 current trace frame. The @code{--comp-print-values} option affects
30325 this set like the @code{--var-print-values} option affects the
30326 @code{explicit-variables} set. See above.
30329 The registers that have been collected at the current trace frame.
30330 For each register collected, the name and current value are returned.
30331 The value is formatted according to the @code{--registers-format}
30332 option. See the @command{-data-list-register-values} command for a
30333 list of the allowed formats. The default is @samp{x}.
30336 The trace state variables that have been collected at the current
30337 trace frame. For each trace state variable collected, the name and
30338 current value are returned.
30341 The set of memory ranges that have been collected at the current trace
30342 frame. Its content is a list of tuples. Each tuple represents a
30343 collected memory range and has the following fields:
30347 The start address of the memory range, as hexadecimal literal.
30350 The length of the memory range, as decimal literal.
30353 The contents of the memory block, in hex. This field is only present
30354 if the @code{--memory-contents} option is specified.
30360 @subsubheading @value{GDBN} Command
30362 There is no corresponding @value{GDBN} command.
30364 @subsubheading Example
30366 @subheading -trace-list-variables
30367 @findex -trace-list-variables
30369 @subsubheading Synopsis
30372 -trace-list-variables
30375 Return a table of all defined trace variables. Each element of the
30376 table has the following fields:
30380 The name of the trace variable. This field is always present.
30383 The initial value. This is a 64-bit signed integer. This
30384 field is always present.
30387 The value the trace variable has at the moment. This is a 64-bit
30388 signed integer. This field is absent iff current value is
30389 not defined, for example if the trace was never run, or is
30394 @subsubheading @value{GDBN} Command
30396 The corresponding @value{GDBN} command is @samp{tvariables}.
30398 @subsubheading Example
30402 -trace-list-variables
30403 ^done,trace-variables=@{nr_rows="1",nr_cols="3",
30404 hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@},
30405 @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@},
30406 @{width="11",alignment="-1",col_name="current",colhdr="Current"@}],
30407 body=[variable=@{name="$trace_timestamp",initial="0"@}
30408 variable=@{name="$foo",initial="10",current="15"@}]@}
30412 @subheading -trace-save
30413 @findex -trace-save
30415 @subsubheading Synopsis
30418 -trace-save [-r ] @var{filename}
30421 Saves the collected trace data to @var{filename}. Without the
30422 @samp{-r} option, the data is downloaded from the target and saved
30423 in a local file. With the @samp{-r} option the target is asked
30424 to perform the save.
30426 @subsubheading @value{GDBN} Command
30428 The corresponding @value{GDBN} command is @samp{tsave}.
30431 @subheading -trace-start
30432 @findex -trace-start
30434 @subsubheading Synopsis
30440 Starts a tracing experiments. The result of this command does not
30443 @subsubheading @value{GDBN} Command
30445 The corresponding @value{GDBN} command is @samp{tstart}.
30447 @subheading -trace-status
30448 @findex -trace-status
30450 @subsubheading Synopsis
30456 Obtains the status of a tracing experiment. The result may include
30457 the following fields:
30462 May have a value of either @samp{0}, when no tracing operations are
30463 supported, @samp{1}, when all tracing operations are supported, or
30464 @samp{file} when examining trace file. In the latter case, examining
30465 of trace frame is possible but new tracing experiement cannot be
30466 started. This field is always present.
30469 May have a value of either @samp{0} or @samp{1} depending on whether
30470 tracing experiement is in progress on target. This field is present
30471 if @samp{supported} field is not @samp{0}.
30474 Report the reason why the tracing was stopped last time. This field
30475 may be absent iff tracing was never stopped on target yet. The
30476 value of @samp{request} means the tracing was stopped as result of
30477 the @code{-trace-stop} command. The value of @samp{overflow} means
30478 the tracing buffer is full. The value of @samp{disconnection} means
30479 tracing was automatically stopped when @value{GDBN} has disconnected.
30480 The value of @samp{passcount} means tracing was stopped when a
30481 tracepoint was passed a maximal number of times for that tracepoint.
30482 This field is present if @samp{supported} field is not @samp{0}.
30484 @item stopping-tracepoint
30485 The number of tracepoint whose passcount as exceeded. This field is
30486 present iff the @samp{stop-reason} field has the value of
30490 @itemx frames-created
30491 The @samp{frames} field is a count of the total number of trace frames
30492 in the trace buffer, while @samp{frames-created} is the total created
30493 during the run, including ones that were discarded, such as when a
30494 circular trace buffer filled up. Both fields are optional.
30498 These fields tell the current size of the tracing buffer and the
30499 remaining space. These fields are optional.
30502 The value of the circular trace buffer flag. @code{1} means that the
30503 trace buffer is circular and old trace frames will be discarded if
30504 necessary to make room, @code{0} means that the trace buffer is linear
30508 The value of the disconnected tracing flag. @code{1} means that
30509 tracing will continue after @value{GDBN} disconnects, @code{0} means
30510 that the trace run will stop.
30513 The filename of the trace file being examined. This field is
30514 optional, and only present when examining a trace file.
30518 @subsubheading @value{GDBN} Command
30520 The corresponding @value{GDBN} command is @samp{tstatus}.
30522 @subheading -trace-stop
30523 @findex -trace-stop
30525 @subsubheading Synopsis
30531 Stops a tracing experiment. The result of this command has the same
30532 fields as @code{-trace-status}, except that the @samp{supported} and
30533 @samp{running} fields are not output.
30535 @subsubheading @value{GDBN} Command
30537 The corresponding @value{GDBN} command is @samp{tstop}.
30540 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30541 @node GDB/MI Symbol Query
30542 @section @sc{gdb/mi} Symbol Query Commands
30546 @subheading The @code{-symbol-info-address} Command
30547 @findex -symbol-info-address
30549 @subsubheading Synopsis
30552 -symbol-info-address @var{symbol}
30555 Describe where @var{symbol} is stored.
30557 @subsubheading @value{GDBN} Command
30559 The corresponding @value{GDBN} command is @samp{info address}.
30561 @subsubheading Example
30565 @subheading The @code{-symbol-info-file} Command
30566 @findex -symbol-info-file
30568 @subsubheading Synopsis
30574 Show the file for the symbol.
30576 @subsubheading @value{GDBN} Command
30578 There's no equivalent @value{GDBN} command. @code{gdbtk} has
30579 @samp{gdb_find_file}.
30581 @subsubheading Example
30585 @subheading The @code{-symbol-info-function} Command
30586 @findex -symbol-info-function
30588 @subsubheading Synopsis
30591 -symbol-info-function
30594 Show which function the symbol lives in.
30596 @subsubheading @value{GDBN} Command
30598 @samp{gdb_get_function} in @code{gdbtk}.
30600 @subsubheading Example
30604 @subheading The @code{-symbol-info-line} Command
30605 @findex -symbol-info-line
30607 @subsubheading Synopsis
30613 Show the core addresses of the code for a source line.
30615 @subsubheading @value{GDBN} Command
30617 The corresponding @value{GDBN} command is @samp{info line}.
30618 @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands.
30620 @subsubheading Example
30624 @subheading The @code{-symbol-info-symbol} Command
30625 @findex -symbol-info-symbol
30627 @subsubheading Synopsis
30630 -symbol-info-symbol @var{addr}
30633 Describe what symbol is at location @var{addr}.
30635 @subsubheading @value{GDBN} Command
30637 The corresponding @value{GDBN} command is @samp{info symbol}.
30639 @subsubheading Example
30643 @subheading The @code{-symbol-list-functions} Command
30644 @findex -symbol-list-functions
30646 @subsubheading Synopsis
30649 -symbol-list-functions
30652 List the functions in the executable.
30654 @subsubheading @value{GDBN} Command
30656 @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and
30657 @samp{gdb_search} in @code{gdbtk}.
30659 @subsubheading Example
30664 @subheading The @code{-symbol-list-lines} Command
30665 @findex -symbol-list-lines
30667 @subsubheading Synopsis
30670 -symbol-list-lines @var{filename}
30673 Print the list of lines that contain code and their associated program
30674 addresses for the given source filename. The entries are sorted in
30675 ascending PC order.
30677 @subsubheading @value{GDBN} Command
30679 There is no corresponding @value{GDBN} command.
30681 @subsubheading Example
30684 -symbol-list-lines basics.c
30685 ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
30691 @subheading The @code{-symbol-list-types} Command
30692 @findex -symbol-list-types
30694 @subsubheading Synopsis
30700 List all the type names.
30702 @subsubheading @value{GDBN} Command
30704 The corresponding commands are @samp{info types} in @value{GDBN},
30705 @samp{gdb_search} in @code{gdbtk}.
30707 @subsubheading Example
30711 @subheading The @code{-symbol-list-variables} Command
30712 @findex -symbol-list-variables
30714 @subsubheading Synopsis
30717 -symbol-list-variables
30720 List all the global and static variable names.
30722 @subsubheading @value{GDBN} Command
30724 @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}.
30726 @subsubheading Example
30730 @subheading The @code{-symbol-locate} Command
30731 @findex -symbol-locate
30733 @subsubheading Synopsis
30739 @subsubheading @value{GDBN} Command
30741 @samp{gdb_loc} in @code{gdbtk}.
30743 @subsubheading Example
30747 @subheading The @code{-symbol-type} Command
30748 @findex -symbol-type
30750 @subsubheading Synopsis
30753 -symbol-type @var{variable}
30756 Show type of @var{variable}.
30758 @subsubheading @value{GDBN} Command
30760 The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has
30761 @samp{gdb_obj_variable}.
30763 @subsubheading Example
30768 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30769 @node GDB/MI File Commands
30770 @section @sc{gdb/mi} File Commands
30772 This section describes the GDB/MI commands to specify executable file names
30773 and to read in and obtain symbol table information.
30775 @subheading The @code{-file-exec-and-symbols} Command
30776 @findex -file-exec-and-symbols
30778 @subsubheading Synopsis
30781 -file-exec-and-symbols @var{file}
30784 Specify the executable file to be debugged. This file is the one from
30785 which the symbol table is also read. If no file is specified, the
30786 command clears the executable and symbol information. If breakpoints
30787 are set when using this command with no arguments, @value{GDBN} will produce
30788 error messages. Otherwise, no output is produced, except a completion
30791 @subsubheading @value{GDBN} Command
30793 The corresponding @value{GDBN} command is @samp{file}.
30795 @subsubheading Example
30799 -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
30805 @subheading The @code{-file-exec-file} Command
30806 @findex -file-exec-file
30808 @subsubheading Synopsis
30811 -file-exec-file @var{file}
30814 Specify the executable file to be debugged. Unlike
30815 @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read
30816 from this file. If used without argument, @value{GDBN} clears the information
30817 about the executable file. No output is produced, except a completion
30820 @subsubheading @value{GDBN} Command
30822 The corresponding @value{GDBN} command is @samp{exec-file}.
30824 @subsubheading Example
30828 -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
30835 @subheading The @code{-file-list-exec-sections} Command
30836 @findex -file-list-exec-sections
30838 @subsubheading Synopsis
30841 -file-list-exec-sections
30844 List the sections of the current executable file.
30846 @subsubheading @value{GDBN} Command
30848 The @value{GDBN} command @samp{info file} shows, among the rest, the same
30849 information as this command. @code{gdbtk} has a corresponding command
30850 @samp{gdb_load_info}.
30852 @subsubheading Example
30857 @subheading The @code{-file-list-exec-source-file} Command
30858 @findex -file-list-exec-source-file
30860 @subsubheading Synopsis
30863 -file-list-exec-source-file
30866 List the line number, the current source file, and the absolute path
30867 to the current source file for the current executable. The macro
30868 information field has a value of @samp{1} or @samp{0} depending on
30869 whether or not the file includes preprocessor macro information.
30871 @subsubheading @value{GDBN} Command
30873 The @value{GDBN} equivalent is @samp{info source}
30875 @subsubheading Example
30879 123-file-list-exec-source-file
30880 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1"
30885 @subheading The @code{-file-list-exec-source-files} Command
30886 @findex -file-list-exec-source-files
30888 @subsubheading Synopsis
30891 -file-list-exec-source-files
30894 List the source files for the current executable.
30896 It will always output both the filename and fullname (absolute file
30897 name) of a source file.
30899 @subsubheading @value{GDBN} Command
30901 The @value{GDBN} equivalent is @samp{info sources}.
30902 @code{gdbtk} has an analogous command @samp{gdb_listfiles}.
30904 @subsubheading Example
30907 -file-list-exec-source-files
30909 @{file=foo.c,fullname=/home/foo.c@},
30910 @{file=/home/bar.c,fullname=/home/bar.c@},
30911 @{file=gdb_could_not_find_fullpath.c@}]
30916 @subheading The @code{-file-list-shared-libraries} Command
30917 @findex -file-list-shared-libraries
30919 @subsubheading Synopsis
30922 -file-list-shared-libraries
30925 List the shared libraries in the program.
30927 @subsubheading @value{GDBN} Command
30929 The corresponding @value{GDBN} command is @samp{info shared}.
30931 @subsubheading Example
30935 @subheading The @code{-file-list-symbol-files} Command
30936 @findex -file-list-symbol-files
30938 @subsubheading Synopsis
30941 -file-list-symbol-files
30946 @subsubheading @value{GDBN} Command
30948 The corresponding @value{GDBN} command is @samp{info file} (part of it).
30950 @subsubheading Example
30955 @subheading The @code{-file-symbol-file} Command
30956 @findex -file-symbol-file
30958 @subsubheading Synopsis
30961 -file-symbol-file @var{file}
30964 Read symbol table info from the specified @var{file} argument. When
30965 used without arguments, clears @value{GDBN}'s symbol table info. No output is
30966 produced, except for a completion notification.
30968 @subsubheading @value{GDBN} Command
30970 The corresponding @value{GDBN} command is @samp{symbol-file}.
30972 @subsubheading Example
30976 -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
30982 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30983 @node GDB/MI Memory Overlay Commands
30984 @section @sc{gdb/mi} Memory Overlay Commands
30986 The memory overlay commands are not implemented.
30988 @c @subheading -overlay-auto
30990 @c @subheading -overlay-list-mapping-state
30992 @c @subheading -overlay-list-overlays
30994 @c @subheading -overlay-map
30996 @c @subheading -overlay-off
30998 @c @subheading -overlay-on
31000 @c @subheading -overlay-unmap
31002 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31003 @node GDB/MI Signal Handling Commands
31004 @section @sc{gdb/mi} Signal Handling Commands
31006 Signal handling commands are not implemented.
31008 @c @subheading -signal-handle
31010 @c @subheading -signal-list-handle-actions
31012 @c @subheading -signal-list-signal-types
31016 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31017 @node GDB/MI Target Manipulation
31018 @section @sc{gdb/mi} Target Manipulation Commands
31021 @subheading The @code{-target-attach} Command
31022 @findex -target-attach
31024 @subsubheading Synopsis
31027 -target-attach @var{pid} | @var{gid} | @var{file}
31030 Attach to a process @var{pid} or a file @var{file} outside of
31031 @value{GDBN}, or a thread group @var{gid}. If attaching to a thread
31032 group, the id previously returned by
31033 @samp{-list-thread-groups --available} must be used.
31035 @subsubheading @value{GDBN} Command
31037 The corresponding @value{GDBN} command is @samp{attach}.
31039 @subsubheading Example
31043 =thread-created,id="1"
31044 *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@}
31050 @subheading The @code{-target-compare-sections} Command
31051 @findex -target-compare-sections
31053 @subsubheading Synopsis
31056 -target-compare-sections [ @var{section} ]
31059 Compare data of section @var{section} on target to the exec file.
31060 Without the argument, all sections are compared.
31062 @subsubheading @value{GDBN} Command
31064 The @value{GDBN} equivalent is @samp{compare-sections}.
31066 @subsubheading Example
31071 @subheading The @code{-target-detach} Command
31072 @findex -target-detach
31074 @subsubheading Synopsis
31077 -target-detach [ @var{pid} | @var{gid} ]
31080 Detach from the remote target which normally resumes its execution.
31081 If either @var{pid} or @var{gid} is specified, detaches from either
31082 the specified process, or specified thread group. There's no output.
31084 @subsubheading @value{GDBN} Command
31086 The corresponding @value{GDBN} command is @samp{detach}.
31088 @subsubheading Example
31098 @subheading The @code{-target-disconnect} Command
31099 @findex -target-disconnect
31101 @subsubheading Synopsis
31107 Disconnect from the remote target. There's no output and the target is
31108 generally not resumed.
31110 @subsubheading @value{GDBN} Command
31112 The corresponding @value{GDBN} command is @samp{disconnect}.
31114 @subsubheading Example
31124 @subheading The @code{-target-download} Command
31125 @findex -target-download
31127 @subsubheading Synopsis
31133 Loads the executable onto the remote target.
31134 It prints out an update message every half second, which includes the fields:
31138 The name of the section.
31140 The size of what has been sent so far for that section.
31142 The size of the section.
31144 The total size of what was sent so far (the current and the previous sections).
31146 The size of the overall executable to download.
31150 Each message is sent as status record (@pxref{GDB/MI Output Syntax, ,
31151 @sc{gdb/mi} Output Syntax}).
31153 In addition, it prints the name and size of the sections, as they are
31154 downloaded. These messages include the following fields:
31158 The name of the section.
31160 The size of the section.
31162 The size of the overall executable to download.
31166 At the end, a summary is printed.
31168 @subsubheading @value{GDBN} Command
31170 The corresponding @value{GDBN} command is @samp{load}.
31172 @subsubheading Example
31174 Note: each status message appears on a single line. Here the messages
31175 have been broken down so that they can fit onto a page.
31180 +download,@{section=".text",section-size="6668",total-size="9880"@}
31181 +download,@{section=".text",section-sent="512",section-size="6668",
31182 total-sent="512",total-size="9880"@}
31183 +download,@{section=".text",section-sent="1024",section-size="6668",
31184 total-sent="1024",total-size="9880"@}
31185 +download,@{section=".text",section-sent="1536",section-size="6668",
31186 total-sent="1536",total-size="9880"@}
31187 +download,@{section=".text",section-sent="2048",section-size="6668",
31188 total-sent="2048",total-size="9880"@}
31189 +download,@{section=".text",section-sent="2560",section-size="6668",
31190 total-sent="2560",total-size="9880"@}
31191 +download,@{section=".text",section-sent="3072",section-size="6668",
31192 total-sent="3072",total-size="9880"@}
31193 +download,@{section=".text",section-sent="3584",section-size="6668",
31194 total-sent="3584",total-size="9880"@}
31195 +download,@{section=".text",section-sent="4096",section-size="6668",
31196 total-sent="4096",total-size="9880"@}
31197 +download,@{section=".text",section-sent="4608",section-size="6668",
31198 total-sent="4608",total-size="9880"@}
31199 +download,@{section=".text",section-sent="5120",section-size="6668",
31200 total-sent="5120",total-size="9880"@}
31201 +download,@{section=".text",section-sent="5632",section-size="6668",
31202 total-sent="5632",total-size="9880"@}
31203 +download,@{section=".text",section-sent="6144",section-size="6668",
31204 total-sent="6144",total-size="9880"@}
31205 +download,@{section=".text",section-sent="6656",section-size="6668",
31206 total-sent="6656",total-size="9880"@}
31207 +download,@{section=".init",section-size="28",total-size="9880"@}
31208 +download,@{section=".fini",section-size="28",total-size="9880"@}
31209 +download,@{section=".data",section-size="3156",total-size="9880"@}
31210 +download,@{section=".data",section-sent="512",section-size="3156",
31211 total-sent="7236",total-size="9880"@}
31212 +download,@{section=".data",section-sent="1024",section-size="3156",
31213 total-sent="7748",total-size="9880"@}
31214 +download,@{section=".data",section-sent="1536",section-size="3156",
31215 total-sent="8260",total-size="9880"@}
31216 +download,@{section=".data",section-sent="2048",section-size="3156",
31217 total-sent="8772",total-size="9880"@}
31218 +download,@{section=".data",section-sent="2560",section-size="3156",
31219 total-sent="9284",total-size="9880"@}
31220 +download,@{section=".data",section-sent="3072",section-size="3156",
31221 total-sent="9796",total-size="9880"@}
31222 ^done,address="0x10004",load-size="9880",transfer-rate="6586",
31229 @subheading The @code{-target-exec-status} Command
31230 @findex -target-exec-status
31232 @subsubheading Synopsis
31235 -target-exec-status
31238 Provide information on the state of the target (whether it is running or
31239 not, for instance).
31241 @subsubheading @value{GDBN} Command
31243 There's no equivalent @value{GDBN} command.
31245 @subsubheading Example
31249 @subheading The @code{-target-list-available-targets} Command
31250 @findex -target-list-available-targets
31252 @subsubheading Synopsis
31255 -target-list-available-targets
31258 List the possible targets to connect to.
31260 @subsubheading @value{GDBN} Command
31262 The corresponding @value{GDBN} command is @samp{help target}.
31264 @subsubheading Example
31268 @subheading The @code{-target-list-current-targets} Command
31269 @findex -target-list-current-targets
31271 @subsubheading Synopsis
31274 -target-list-current-targets
31277 Describe the current target.
31279 @subsubheading @value{GDBN} Command
31281 The corresponding information is printed by @samp{info file} (among
31284 @subsubheading Example
31288 @subheading The @code{-target-list-parameters} Command
31289 @findex -target-list-parameters
31291 @subsubheading Synopsis
31294 -target-list-parameters
31300 @subsubheading @value{GDBN} Command
31304 @subsubheading Example
31308 @subheading The @code{-target-select} Command
31309 @findex -target-select
31311 @subsubheading Synopsis
31314 -target-select @var{type} @var{parameters @dots{}}
31317 Connect @value{GDBN} to the remote target. This command takes two args:
31321 The type of target, for instance @samp{remote}, etc.
31322 @item @var{parameters}
31323 Device names, host names and the like. @xref{Target Commands, ,
31324 Commands for Managing Targets}, for more details.
31327 The output is a connection notification, followed by the address at
31328 which the target program is, in the following form:
31331 ^connected,addr="@var{address}",func="@var{function name}",
31332 args=[@var{arg list}]
31335 @subsubheading @value{GDBN} Command
31337 The corresponding @value{GDBN} command is @samp{target}.
31339 @subsubheading Example
31343 -target-select remote /dev/ttya
31344 ^connected,addr="0xfe00a300",func="??",args=[]
31348 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31349 @node GDB/MI File Transfer Commands
31350 @section @sc{gdb/mi} File Transfer Commands
31353 @subheading The @code{-target-file-put} Command
31354 @findex -target-file-put
31356 @subsubheading Synopsis
31359 -target-file-put @var{hostfile} @var{targetfile}
31362 Copy file @var{hostfile} from the host system (the machine running
31363 @value{GDBN}) to @var{targetfile} on the target system.
31365 @subsubheading @value{GDBN} Command
31367 The corresponding @value{GDBN} command is @samp{remote put}.
31369 @subsubheading Example
31373 -target-file-put localfile remotefile
31379 @subheading The @code{-target-file-get} Command
31380 @findex -target-file-get
31382 @subsubheading Synopsis
31385 -target-file-get @var{targetfile} @var{hostfile}
31388 Copy file @var{targetfile} from the target system to @var{hostfile}
31389 on the host system.
31391 @subsubheading @value{GDBN} Command
31393 The corresponding @value{GDBN} command is @samp{remote get}.
31395 @subsubheading Example
31399 -target-file-get remotefile localfile
31405 @subheading The @code{-target-file-delete} Command
31406 @findex -target-file-delete
31408 @subsubheading Synopsis
31411 -target-file-delete @var{targetfile}
31414 Delete @var{targetfile} from the target system.
31416 @subsubheading @value{GDBN} Command
31418 The corresponding @value{GDBN} command is @samp{remote delete}.
31420 @subsubheading Example
31424 -target-file-delete remotefile
31430 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31431 @node GDB/MI Ada Exceptions Commands
31432 @section Ada Exceptions @sc{gdb/mi} Commands
31434 @subheading The @code{-info-ada-exceptions} Command
31435 @findex -info-ada-exceptions
31437 @subsubheading Synopsis
31440 -info-ada-exceptions [ @var{regexp}]
31443 List all Ada exceptions defined within the program being debugged.
31444 With a regular expression @var{regexp}, only those exceptions whose
31445 names match @var{regexp} are listed.
31447 @subsubheading @value{GDBN} Command
31449 The corresponding @value{GDBN} command is @samp{info exceptions}.
31451 @subsubheading Result
31453 The result is a table of Ada exceptions. The following columns are
31454 defined for each exception:
31458 The name of the exception.
31461 The address of the exception.
31465 @subsubheading Example
31468 -info-ada-exceptions aint
31469 ^done,ada-exceptions=@{nr_rows="2",nr_cols="2",
31470 hdr=[@{width="1",alignment="-1",col_name="name",colhdr="Name"@},
31471 @{width="1",alignment="-1",col_name="address",colhdr="Address"@}],
31472 body=[@{name="constraint_error",address="0x0000000000613da0"@},
31473 @{name="const.aint_global_e",address="0x0000000000613b00"@}]@}
31476 @subheading Catching Ada Exceptions
31478 The commands describing how to ask @value{GDBN} to stop when a program
31479 raises an exception are described at @ref{Ada Exception GDB/MI
31480 Catchpoint Commands}.
31483 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31484 @node GDB/MI Support Commands
31485 @section @sc{gdb/mi} Support Commands
31487 Since new commands and features get regularly added to @sc{gdb/mi},
31488 some commands are available to help front-ends query the debugger
31489 about support for these capabilities. Similarly, it is also possible
31490 to query @value{GDBN} about target support of certain features.
31492 @subheading The @code{-info-gdb-mi-command} Command
31493 @cindex @code{-info-gdb-mi-command}
31494 @findex -info-gdb-mi-command
31496 @subsubheading Synopsis
31499 -info-gdb-mi-command @var{cmd_name}
31502 Query support for the @sc{gdb/mi} command named @var{cmd_name}.
31504 Note that the dash (@code{-}) starting all @sc{gdb/mi} commands
31505 is technically not part of the command name (@pxref{GDB/MI Input
31506 Syntax}), and thus should be omitted in @var{cmd_name}. However,
31507 for ease of use, this command also accepts the form with the leading
31510 @subsubheading @value{GDBN} Command
31512 There is no corresponding @value{GDBN} command.
31514 @subsubheading Result
31516 The result is a tuple. There is currently only one field:
31520 This field is equal to @code{"true"} if the @sc{gdb/mi} command exists,
31521 @code{"false"} otherwise.
31525 @subsubheading Example
31527 Here is an example where the @sc{gdb/mi} command does not exist:
31530 -info-gdb-mi-command unsupported-command
31531 ^done,command=@{exists="false"@}
31535 And here is an example where the @sc{gdb/mi} command is known
31539 -info-gdb-mi-command symbol-list-lines
31540 ^done,command=@{exists="true"@}
31543 @subheading The @code{-list-features} Command
31544 @findex -list-features
31545 @cindex supported @sc{gdb/mi} features, list
31547 Returns a list of particular features of the MI protocol that
31548 this version of gdb implements. A feature can be a command,
31549 or a new field in an output of some command, or even an
31550 important bugfix. While a frontend can sometimes detect presence
31551 of a feature at runtime, it is easier to perform detection at debugger
31554 The command returns a list of strings, with each string naming an
31555 available feature. Each returned string is just a name, it does not
31556 have any internal structure. The list of possible feature names
31562 (gdb) -list-features
31563 ^done,result=["feature1","feature2"]
31566 The current list of features is:
31569 @item frozen-varobjs
31570 Indicates support for the @code{-var-set-frozen} command, as well
31571 as possible presense of the @code{frozen} field in the output
31572 of @code{-varobj-create}.
31573 @item pending-breakpoints
31574 Indicates support for the @option{-f} option to the @code{-break-insert}
31577 Indicates Python scripting support, Python-based
31578 pretty-printing commands, and possible presence of the
31579 @samp{display_hint} field in the output of @code{-var-list-children}
31581 Indicates support for the @code{-thread-info} command.
31582 @item data-read-memory-bytes
31583 Indicates support for the @code{-data-read-memory-bytes} and the
31584 @code{-data-write-memory-bytes} commands.
31585 @item breakpoint-notifications
31586 Indicates that changes to breakpoints and breakpoints created via the
31587 CLI will be announced via async records.
31588 @item ada-task-info
31589 Indicates support for the @code{-ada-task-info} command.
31590 @item language-option
31591 Indicates that all @sc{gdb/mi} commands accept the @option{--language}
31592 option (@pxref{Context management}).
31593 @item info-gdb-mi-command
31594 Indicates support for the @code{-info-gdb-mi-command} command.
31595 @item undefined-command-error-code
31596 Indicates support for the "undefined-command" error code in error result
31597 records, produced when trying to execute an undefined @sc{gdb/mi} command
31598 (@pxref{GDB/MI Result Records}).
31599 @item exec-run-start-option
31600 Indicates that the @code{-exec-run} command supports the @option{--start}
31601 option (@pxref{GDB/MI Program Execution}).
31604 @subheading The @code{-list-target-features} Command
31605 @findex -list-target-features
31607 Returns a list of particular features that are supported by the
31608 target. Those features affect the permitted MI commands, but
31609 unlike the features reported by the @code{-list-features} command, the
31610 features depend on which target GDB is using at the moment. Whenever
31611 a target can change, due to commands such as @code{-target-select},
31612 @code{-target-attach} or @code{-exec-run}, the list of target features
31613 may change, and the frontend should obtain it again.
31617 (gdb) -list-target-features
31618 ^done,result=["async"]
31621 The current list of features is:
31625 Indicates that the target is capable of asynchronous command
31626 execution, which means that @value{GDBN} will accept further commands
31627 while the target is running.
31630 Indicates that the target is capable of reverse execution.
31631 @xref{Reverse Execution}, for more information.
31635 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31636 @node GDB/MI Miscellaneous Commands
31637 @section Miscellaneous @sc{gdb/mi} Commands
31639 @c @subheading -gdb-complete
31641 @subheading The @code{-gdb-exit} Command
31644 @subsubheading Synopsis
31650 Exit @value{GDBN} immediately.
31652 @subsubheading @value{GDBN} Command
31654 Approximately corresponds to @samp{quit}.
31656 @subsubheading Example
31666 @subheading The @code{-exec-abort} Command
31667 @findex -exec-abort
31669 @subsubheading Synopsis
31675 Kill the inferior running program.
31677 @subsubheading @value{GDBN} Command
31679 The corresponding @value{GDBN} command is @samp{kill}.
31681 @subsubheading Example
31686 @subheading The @code{-gdb-set} Command
31689 @subsubheading Synopsis
31695 Set an internal @value{GDBN} variable.
31696 @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ?????
31698 @subsubheading @value{GDBN} Command
31700 The corresponding @value{GDBN} command is @samp{set}.
31702 @subsubheading Example
31712 @subheading The @code{-gdb-show} Command
31715 @subsubheading Synopsis
31721 Show the current value of a @value{GDBN} variable.
31723 @subsubheading @value{GDBN} Command
31725 The corresponding @value{GDBN} command is @samp{show}.
31727 @subsubheading Example
31736 @c @subheading -gdb-source
31739 @subheading The @code{-gdb-version} Command
31740 @findex -gdb-version
31742 @subsubheading Synopsis
31748 Show version information for @value{GDBN}. Used mostly in testing.
31750 @subsubheading @value{GDBN} Command
31752 The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by
31753 default shows this information when you start an interactive session.
31755 @subsubheading Example
31757 @c This example modifies the actual output from GDB to avoid overfull
31763 ~Copyright 2000 Free Software Foundation, Inc.
31764 ~GDB is free software, covered by the GNU General Public License, and
31765 ~you are welcome to change it and/or distribute copies of it under
31766 ~ certain conditions.
31767 ~Type "show copying" to see the conditions.
31768 ~There is absolutely no warranty for GDB. Type "show warranty" for
31770 ~This GDB was configured as
31771 "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
31776 @subheading The @code{-list-thread-groups} Command
31777 @findex -list-thread-groups
31779 @subheading Synopsis
31782 -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ]
31785 Lists thread groups (@pxref{Thread groups}). When a single thread
31786 group is passed as the argument, lists the children of that group.
31787 When several thread group are passed, lists information about those
31788 thread groups. Without any parameters, lists information about all
31789 top-level thread groups.
31791 Normally, thread groups that are being debugged are reported.
31792 With the @samp{--available} option, @value{GDBN} reports thread groups
31793 available on the target.
31795 The output of this command may have either a @samp{threads} result or
31796 a @samp{groups} result. The @samp{thread} result has a list of tuples
31797 as value, with each tuple describing a thread (@pxref{GDB/MI Thread
31798 Information}). The @samp{groups} result has a list of tuples as value,
31799 each tuple describing a thread group. If top-level groups are
31800 requested (that is, no parameter is passed), or when several groups
31801 are passed, the output always has a @samp{groups} result. The format
31802 of the @samp{group} result is described below.
31804 To reduce the number of roundtrips it's possible to list thread groups
31805 together with their children, by passing the @samp{--recurse} option
31806 and the recursion depth. Presently, only recursion depth of 1 is
31807 permitted. If this option is present, then every reported thread group
31808 will also include its children, either as @samp{group} or
31809 @samp{threads} field.
31811 In general, any combination of option and parameters is permitted, with
31812 the following caveats:
31816 When a single thread group is passed, the output will typically
31817 be the @samp{threads} result. Because threads may not contain
31818 anything, the @samp{recurse} option will be ignored.
31821 When the @samp{--available} option is passed, limited information may
31822 be available. In particular, the list of threads of a process might
31823 be inaccessible. Further, specifying specific thread groups might
31824 not give any performance advantage over listing all thread groups.
31825 The frontend should assume that @samp{-list-thread-groups --available}
31826 is always an expensive operation and cache the results.
31830 The @samp{groups} result is a list of tuples, where each tuple may
31831 have the following fields:
31835 Identifier of the thread group. This field is always present.
31836 The identifier is an opaque string; frontends should not try to
31837 convert it to an integer, even though it might look like one.
31840 The type of the thread group. At present, only @samp{process} is a
31844 The target-specific process identifier. This field is only present
31845 for thread groups of type @samp{process} and only if the process exists.
31848 The exit code of this group's last exited thread, formatted in octal.
31849 This field is only present for thread groups of type @samp{process} and
31850 only if the process is not running.
31853 The number of children this thread group has. This field may be
31854 absent for an available thread group.
31857 This field has a list of tuples as value, each tuple describing a
31858 thread. It may be present if the @samp{--recurse} option is
31859 specified, and it's actually possible to obtain the threads.
31862 This field is a list of integers, each identifying a core that one
31863 thread of the group is running on. This field may be absent if
31864 such information is not available.
31867 The name of the executable file that corresponds to this thread group.
31868 The field is only present for thread groups of type @samp{process},
31869 and only if there is a corresponding executable file.
31873 @subheading Example
31877 -list-thread-groups
31878 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}]
31879 -list-thread-groups 17
31880 ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
31881 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@},
31882 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
31883 frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}],
31884 file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]]
31885 -list-thread-groups --available
31886 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}]
31887 -list-thread-groups --available --recurse 1
31888 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
31889 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
31890 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..]
31891 -list-thread-groups --available --recurse 1 17 18
31892 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
31893 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
31894 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...]
31897 @subheading The @code{-info-os} Command
31900 @subsubheading Synopsis
31903 -info-os [ @var{type} ]
31906 If no argument is supplied, the command returns a table of available
31907 operating-system-specific information types. If one of these types is
31908 supplied as an argument @var{type}, then the command returns a table
31909 of data of that type.
31911 The types of information available depend on the target operating
31914 @subsubheading @value{GDBN} Command
31916 The corresponding @value{GDBN} command is @samp{info os}.
31918 @subsubheading Example
31920 When run on a @sc{gnu}/Linux system, the output will look something
31926 ^done,OSDataTable=@{nr_rows="10",nr_cols="3",
31927 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="Type"@},
31928 @{width="10",alignment="-1",col_name="col1",colhdr="Description"@},
31929 @{width="10",alignment="-1",col_name="col2",colhdr="Title"@}],
31930 body=[item=@{col0="cpus",col1="Listing of all cpus/cores on the system",
31932 item=@{col0="files",col1="Listing of all file descriptors",
31933 col2="File descriptors"@},
31934 item=@{col0="modules",col1="Listing of all loaded kernel modules",
31935 col2="Kernel modules"@},
31936 item=@{col0="msg",col1="Listing of all message queues",
31937 col2="Message queues"@},
31938 item=@{col0="processes",col1="Listing of all processes",
31939 col2="Processes"@},
31940 item=@{col0="procgroups",col1="Listing of all process groups",
31941 col2="Process groups"@},
31942 item=@{col0="semaphores",col1="Listing of all semaphores",
31943 col2="Semaphores"@},
31944 item=@{col0="shm",col1="Listing of all shared-memory regions",
31945 col2="Shared-memory regions"@},
31946 item=@{col0="sockets",col1="Listing of all internet-domain sockets",
31948 item=@{col0="threads",col1="Listing of all threads",
31952 ^done,OSDataTable=@{nr_rows="190",nr_cols="4",
31953 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="pid"@},
31954 @{width="10",alignment="-1",col_name="col1",colhdr="user"@},
31955 @{width="10",alignment="-1",col_name="col2",colhdr="command"@},
31956 @{width="10",alignment="-1",col_name="col3",colhdr="cores"@}],
31957 body=[item=@{col0="1",col1="root",col2="/sbin/init",col3="0"@},
31958 item=@{col0="2",col1="root",col2="[kthreadd]",col3="1"@},
31959 item=@{col0="3",col1="root",col2="[ksoftirqd/0]",col3="0"@},
31961 item=@{col0="26446",col1="stan",col2="bash",col3="0"@},
31962 item=@{col0="28152",col1="stan",col2="bash",col3="1"@}]@}
31966 (Note that the MI output here includes a @code{"Title"} column that
31967 does not appear in command-line @code{info os}; this column is useful
31968 for MI clients that want to enumerate the types of data, such as in a
31969 popup menu, but is needless clutter on the command line, and
31970 @code{info os} omits it.)
31972 @subheading The @code{-add-inferior} Command
31973 @findex -add-inferior
31975 @subheading Synopsis
31981 Creates a new inferior (@pxref{Inferiors and Programs}). The created
31982 inferior is not associated with any executable. Such association may
31983 be established with the @samp{-file-exec-and-symbols} command
31984 (@pxref{GDB/MI File Commands}). The command response has a single
31985 field, @samp{inferior}, whose value is the identifier of the
31986 thread group corresponding to the new inferior.
31988 @subheading Example
31993 ^done,inferior="i3"
31996 @subheading The @code{-interpreter-exec} Command
31997 @findex -interpreter-exec
31999 @subheading Synopsis
32002 -interpreter-exec @var{interpreter} @var{command}
32004 @anchor{-interpreter-exec}
32006 Execute the specified @var{command} in the given @var{interpreter}.
32008 @subheading @value{GDBN} Command
32010 The corresponding @value{GDBN} command is @samp{interpreter-exec}.
32012 @subheading Example
32016 -interpreter-exec console "break main"
32017 &"During symbol reading, couldn't parse type; debugger out of date?.\n"
32018 &"During symbol reading, bad structure-type format.\n"
32019 ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
32024 @subheading The @code{-inferior-tty-set} Command
32025 @findex -inferior-tty-set
32027 @subheading Synopsis
32030 -inferior-tty-set /dev/pts/1
32033 Set terminal for future runs of the program being debugged.
32035 @subheading @value{GDBN} Command
32037 The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1.
32039 @subheading Example
32043 -inferior-tty-set /dev/pts/1
32048 @subheading The @code{-inferior-tty-show} Command
32049 @findex -inferior-tty-show
32051 @subheading Synopsis
32057 Show terminal for future runs of program being debugged.
32059 @subheading @value{GDBN} Command
32061 The corresponding @value{GDBN} command is @samp{show inferior-tty}.
32063 @subheading Example
32067 -inferior-tty-set /dev/pts/1
32071 ^done,inferior_tty_terminal="/dev/pts/1"
32075 @subheading The @code{-enable-timings} Command
32076 @findex -enable-timings
32078 @subheading Synopsis
32081 -enable-timings [yes | no]
32084 Toggle the printing of the wallclock, user and system times for an MI
32085 command as a field in its output. This command is to help frontend
32086 developers optimize the performance of their code. No argument is
32087 equivalent to @samp{yes}.
32089 @subheading @value{GDBN} Command
32093 @subheading Example
32101 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
32102 addr="0x080484ed",func="main",file="myprog.c",
32103 fullname="/home/nickrob/myprog.c",line="73",thread-groups=["i1"],
32105 time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
32113 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
32114 frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
32115 @{name="argv",value="0xbfb60364"@}],file="myprog.c",
32116 fullname="/home/nickrob/myprog.c",line="73"@}
32121 @chapter @value{GDBN} Annotations
32123 This chapter describes annotations in @value{GDBN}. Annotations were
32124 designed to interface @value{GDBN} to graphical user interfaces or other
32125 similar programs which want to interact with @value{GDBN} at a
32126 relatively high level.
32128 The annotation mechanism has largely been superseded by @sc{gdb/mi}
32132 This is Edition @value{EDITION}, @value{DATE}.
32136 * Annotations Overview:: What annotations are; the general syntax.
32137 * Server Prefix:: Issuing a command without affecting user state.
32138 * Prompting:: Annotations marking @value{GDBN}'s need for input.
32139 * Errors:: Annotations for error messages.
32140 * Invalidation:: Some annotations describe things now invalid.
32141 * Annotations for Running::
32142 Whether the program is running, how it stopped, etc.
32143 * Source Annotations:: Annotations describing source code.
32146 @node Annotations Overview
32147 @section What is an Annotation?
32148 @cindex annotations
32150 Annotations start with a newline character, two @samp{control-z}
32151 characters, and the name of the annotation. If there is no additional
32152 information associated with this annotation, the name of the annotation
32153 is followed immediately by a newline. If there is additional
32154 information, the name of the annotation is followed by a space, the
32155 additional information, and a newline. The additional information
32156 cannot contain newline characters.
32158 Any output not beginning with a newline and two @samp{control-z}
32159 characters denotes literal output from @value{GDBN}. Currently there is
32160 no need for @value{GDBN} to output a newline followed by two
32161 @samp{control-z} characters, but if there was such a need, the
32162 annotations could be extended with an @samp{escape} annotation which
32163 means those three characters as output.
32165 The annotation @var{level}, which is specified using the
32166 @option{--annotate} command line option (@pxref{Mode Options}), controls
32167 how much information @value{GDBN} prints together with its prompt,
32168 values of expressions, source lines, and other types of output. Level 0
32169 is for no annotations, level 1 is for use when @value{GDBN} is run as a
32170 subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable
32171 for programs that control @value{GDBN}, and level 2 annotations have
32172 been made obsolete (@pxref{Limitations, , Limitations of the Annotation
32173 Interface, annotate, GDB's Obsolete Annotations}).
32176 @kindex set annotate
32177 @item set annotate @var{level}
32178 The @value{GDBN} command @code{set annotate} sets the level of
32179 annotations to the specified @var{level}.
32181 @item show annotate
32182 @kindex show annotate
32183 Show the current annotation level.
32186 This chapter describes level 3 annotations.
32188 A simple example of starting up @value{GDBN} with annotations is:
32191 $ @kbd{gdb --annotate=3}
32193 Copyright 2003 Free Software Foundation, Inc.
32194 GDB is free software, covered by the GNU General Public License,
32195 and you are welcome to change it and/or distribute copies of it
32196 under certain conditions.
32197 Type "show copying" to see the conditions.
32198 There is absolutely no warranty for GDB. Type "show warranty"
32200 This GDB was configured as "i386-pc-linux-gnu"
32211 Here @samp{quit} is input to @value{GDBN}; the rest is output from
32212 @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z}
32213 denotes a @samp{control-z} character) are annotations; the rest is
32214 output from @value{GDBN}.
32216 @node Server Prefix
32217 @section The Server Prefix
32218 @cindex server prefix
32220 If you prefix a command with @samp{server } then it will not affect
32221 the command history, nor will it affect @value{GDBN}'s notion of which
32222 command to repeat if @key{RET} is pressed on a line by itself. This
32223 means that commands can be run behind a user's back by a front-end in
32224 a transparent manner.
32226 The @code{server } prefix does not affect the recording of values into
32227 the value history; to print a value without recording it into the
32228 value history, use the @code{output} command instead of the
32229 @code{print} command.
32231 Using this prefix also disables confirmation requests
32232 (@pxref{confirmation requests}).
32235 @section Annotation for @value{GDBN} Input
32237 @cindex annotations for prompts
32238 When @value{GDBN} prompts for input, it annotates this fact so it is possible
32239 to know when to send output, when the output from a given command is
32242 Different kinds of input each have a different @dfn{input type}. Each
32243 input type has three annotations: a @code{pre-} annotation, which
32244 denotes the beginning of any prompt which is being output, a plain
32245 annotation, which denotes the end of the prompt, and then a @code{post-}
32246 annotation which denotes the end of any echo which may (or may not) be
32247 associated with the input. For example, the @code{prompt} input type
32248 features the following annotations:
32256 The input types are
32259 @findex pre-prompt annotation
32260 @findex prompt annotation
32261 @findex post-prompt annotation
32263 When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
32265 @findex pre-commands annotation
32266 @findex commands annotation
32267 @findex post-commands annotation
32269 When @value{GDBN} prompts for a set of commands, like in the @code{commands}
32270 command. The annotations are repeated for each command which is input.
32272 @findex pre-overload-choice annotation
32273 @findex overload-choice annotation
32274 @findex post-overload-choice annotation
32275 @item overload-choice
32276 When @value{GDBN} wants the user to select between various overloaded functions.
32278 @findex pre-query annotation
32279 @findex query annotation
32280 @findex post-query annotation
32282 When @value{GDBN} wants the user to confirm a potentially dangerous operation.
32284 @findex pre-prompt-for-continue annotation
32285 @findex prompt-for-continue annotation
32286 @findex post-prompt-for-continue annotation
32287 @item prompt-for-continue
32288 When @value{GDBN} is asking the user to press return to continue. Note: Don't
32289 expect this to work well; instead use @code{set height 0} to disable
32290 prompting. This is because the counting of lines is buggy in the
32291 presence of annotations.
32296 @cindex annotations for errors, warnings and interrupts
32298 @findex quit annotation
32303 This annotation occurs right before @value{GDBN} responds to an interrupt.
32305 @findex error annotation
32310 This annotation occurs right before @value{GDBN} responds to an error.
32312 Quit and error annotations indicate that any annotations which @value{GDBN} was
32313 in the middle of may end abruptly. For example, if a
32314 @code{value-history-begin} annotation is followed by a @code{error}, one
32315 cannot expect to receive the matching @code{value-history-end}. One
32316 cannot expect not to receive it either, however; an error annotation
32317 does not necessarily mean that @value{GDBN} is immediately returning all the way
32320 @findex error-begin annotation
32321 A quit or error annotation may be preceded by
32327 Any output between that and the quit or error annotation is the error
32330 Warning messages are not yet annotated.
32331 @c If we want to change that, need to fix warning(), type_error(),
32332 @c range_error(), and possibly other places.
32335 @section Invalidation Notices
32337 @cindex annotations for invalidation messages
32338 The following annotations say that certain pieces of state may have
32342 @findex frames-invalid annotation
32343 @item ^Z^Zframes-invalid
32345 The frames (for example, output from the @code{backtrace} command) may
32348 @findex breakpoints-invalid annotation
32349 @item ^Z^Zbreakpoints-invalid
32351 The breakpoints may have changed. For example, the user just added or
32352 deleted a breakpoint.
32355 @node Annotations for Running
32356 @section Running the Program
32357 @cindex annotations for running programs
32359 @findex starting annotation
32360 @findex stopping annotation
32361 When the program starts executing due to a @value{GDBN} command such as
32362 @code{step} or @code{continue},
32368 is output. When the program stops,
32374 is output. Before the @code{stopped} annotation, a variety of
32375 annotations describe how the program stopped.
32378 @findex exited annotation
32379 @item ^Z^Zexited @var{exit-status}
32380 The program exited, and @var{exit-status} is the exit status (zero for
32381 successful exit, otherwise nonzero).
32383 @findex signalled annotation
32384 @findex signal-name annotation
32385 @findex signal-name-end annotation
32386 @findex signal-string annotation
32387 @findex signal-string-end annotation
32388 @item ^Z^Zsignalled
32389 The program exited with a signal. After the @code{^Z^Zsignalled}, the
32390 annotation continues:
32396 ^Z^Zsignal-name-end
32400 ^Z^Zsignal-string-end
32405 where @var{name} is the name of the signal, such as @code{SIGILL} or
32406 @code{SIGSEGV}, and @var{string} is the explanation of the signal, such
32407 as @code{Illegal Instruction} or @code{Segmentation fault}. The arguments
32408 @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
32409 user's benefit and have no particular format.
32411 @findex signal annotation
32413 The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
32414 just saying that the program received the signal, not that it was
32415 terminated with it.
32417 @findex breakpoint annotation
32418 @item ^Z^Zbreakpoint @var{number}
32419 The program hit breakpoint number @var{number}.
32421 @findex watchpoint annotation
32422 @item ^Z^Zwatchpoint @var{number}
32423 The program hit watchpoint number @var{number}.
32426 @node Source Annotations
32427 @section Displaying Source
32428 @cindex annotations for source display
32430 @findex source annotation
32431 The following annotation is used instead of displaying source code:
32434 ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr}
32437 where @var{filename} is an absolute file name indicating which source
32438 file, @var{line} is the line number within that file (where 1 is the
32439 first line in the file), @var{character} is the character position
32440 within the file (where 0 is the first character in the file) (for most
32441 debug formats this will necessarily point to the beginning of a line),
32442 @var{middle} is @samp{middle} if @var{addr} is in the middle of the
32443 line, or @samp{beg} if @var{addr} is at the beginning of the line, and
32444 @var{addr} is the address in the target program associated with the
32445 source which is being displayed. The @var{addr} is in the form @samp{0x}
32446 followed by one or more lowercase hex digits (note that this does not
32447 depend on the language).
32449 @node JIT Interface
32450 @chapter JIT Compilation Interface
32451 @cindex just-in-time compilation
32452 @cindex JIT compilation interface
32454 This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation
32455 interface. A JIT compiler is a program or library that generates native
32456 executable code at runtime and executes it, usually in order to achieve good
32457 performance while maintaining platform independence.
32459 Programs that use JIT compilation are normally difficult to debug because
32460 portions of their code are generated at runtime, instead of being loaded from
32461 object files, which is where @value{GDBN} normally finds the program's symbols
32462 and debug information. In order to debug programs that use JIT compilation,
32463 @value{GDBN} has an interface that allows the program to register in-memory
32464 symbol files with @value{GDBN} at runtime.
32466 If you are using @value{GDBN} to debug a program that uses this interface, then
32467 it should work transparently so long as you have not stripped the binary. If
32468 you are developing a JIT compiler, then the interface is documented in the rest
32469 of this chapter. At this time, the only known client of this interface is the
32472 Broadly speaking, the JIT interface mirrors the dynamic loader interface. The
32473 JIT compiler communicates with @value{GDBN} by writing data into a global
32474 variable and calling a fuction at a well-known symbol. When @value{GDBN}
32475 attaches, it reads a linked list of symbol files from the global variable to
32476 find existing code, and puts a breakpoint in the function so that it can find
32477 out about additional code.
32480 * Declarations:: Relevant C struct declarations
32481 * Registering Code:: Steps to register code
32482 * Unregistering Code:: Steps to unregister code
32483 * Custom Debug Info:: Emit debug information in a custom format
32487 @section JIT Declarations
32489 These are the relevant struct declarations that a C program should include to
32490 implement the interface:
32500 struct jit_code_entry
32502 struct jit_code_entry *next_entry;
32503 struct jit_code_entry *prev_entry;
32504 const char *symfile_addr;
32505 uint64_t symfile_size;
32508 struct jit_descriptor
32511 /* This type should be jit_actions_t, but we use uint32_t
32512 to be explicit about the bitwidth. */
32513 uint32_t action_flag;
32514 struct jit_code_entry *relevant_entry;
32515 struct jit_code_entry *first_entry;
32518 /* GDB puts a breakpoint in this function. */
32519 void __attribute__((noinline)) __jit_debug_register_code() @{ @};
32521 /* Make sure to specify the version statically, because the
32522 debugger may check the version before we can set it. */
32523 struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @};
32526 If the JIT is multi-threaded, then it is important that the JIT synchronize any
32527 modifications to this global data properly, which can easily be done by putting
32528 a global mutex around modifications to these structures.
32530 @node Registering Code
32531 @section Registering Code
32533 To register code with @value{GDBN}, the JIT should follow this protocol:
32537 Generate an object file in memory with symbols and other desired debug
32538 information. The file must include the virtual addresses of the sections.
32541 Create a code entry for the file, which gives the start and size of the symbol
32545 Add it to the linked list in the JIT descriptor.
32548 Point the relevant_entry field of the descriptor at the entry.
32551 Set @code{action_flag} to @code{JIT_REGISTER} and call
32552 @code{__jit_debug_register_code}.
32555 When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the
32556 @code{relevant_entry} pointer so it doesn't have to walk the list looking for
32557 new code. However, the linked list must still be maintained in order to allow
32558 @value{GDBN} to attach to a running process and still find the symbol files.
32560 @node Unregistering Code
32561 @section Unregistering Code
32563 If code is freed, then the JIT should use the following protocol:
32567 Remove the code entry corresponding to the code from the linked list.
32570 Point the @code{relevant_entry} field of the descriptor at the code entry.
32573 Set @code{action_flag} to @code{JIT_UNREGISTER} and call
32574 @code{__jit_debug_register_code}.
32577 If the JIT frees or recompiles code without unregistering it, then @value{GDBN}
32578 and the JIT will leak the memory used for the associated symbol files.
32580 @node Custom Debug Info
32581 @section Custom Debug Info
32582 @cindex custom JIT debug info
32583 @cindex JIT debug info reader
32585 Generating debug information in platform-native file formats (like ELF
32586 or COFF) may be an overkill for JIT compilers; especially if all the
32587 debug info is used for is displaying a meaningful backtrace. The
32588 issue can be resolved by having the JIT writers decide on a debug info
32589 format and also provide a reader that parses the debug info generated
32590 by the JIT compiler. This section gives a brief overview on writing
32591 such a parser. More specific details can be found in the source file
32592 @file{gdb/jit-reader.in}, which is also installed as a header at
32593 @file{@var{includedir}/gdb/jit-reader.h} for easy inclusion.
32595 The reader is implemented as a shared object (so this functionality is
32596 not available on platforms which don't allow loading shared objects at
32597 runtime). Two @value{GDBN} commands, @code{jit-reader-load} and
32598 @code{jit-reader-unload} are provided, to be used to load and unload
32599 the readers from a preconfigured directory. Once loaded, the shared
32600 object is used the parse the debug information emitted by the JIT
32604 * Using JIT Debug Info Readers:: How to use supplied readers correctly
32605 * Writing JIT Debug Info Readers:: Creating a debug-info reader
32608 @node Using JIT Debug Info Readers
32609 @subsection Using JIT Debug Info Readers
32610 @kindex jit-reader-load
32611 @kindex jit-reader-unload
32613 Readers can be loaded and unloaded using the @code{jit-reader-load}
32614 and @code{jit-reader-unload} commands.
32617 @item jit-reader-load @var{reader}
32618 Load the JIT reader named @var{reader}, which is a shared
32619 object specified as either an absolute or a relative file name. In
32620 the latter case, @value{GDBN} will try to load the reader from a
32621 pre-configured directory, usually @file{@var{libdir}/gdb/} on a UNIX
32622 system (here @var{libdir} is the system library directory, often
32623 @file{/usr/local/lib}).
32625 Only one reader can be active at a time; trying to load a second
32626 reader when one is already loaded will result in @value{GDBN}
32627 reporting an error. A new JIT reader can be loaded by first unloading
32628 the current one using @code{jit-reader-unload} and then invoking
32629 @code{jit-reader-load}.
32631 @item jit-reader-unload
32632 Unload the currently loaded JIT reader.
32636 @node Writing JIT Debug Info Readers
32637 @subsection Writing JIT Debug Info Readers
32638 @cindex writing JIT debug info readers
32640 As mentioned, a reader is essentially a shared object conforming to a
32641 certain ABI. This ABI is described in @file{jit-reader.h}.
32643 @file{jit-reader.h} defines the structures, macros and functions
32644 required to write a reader. It is installed (along with
32645 @value{GDBN}), in @file{@var{includedir}/gdb} where @var{includedir} is
32646 the system include directory.
32648 Readers need to be released under a GPL compatible license. A reader
32649 can be declared as released under such a license by placing the macro
32650 @code{GDB_DECLARE_GPL_COMPATIBLE_READER} in a source file.
32652 The entry point for readers is the symbol @code{gdb_init_reader},
32653 which is expected to be a function with the prototype
32655 @findex gdb_init_reader
32657 extern struct gdb_reader_funcs *gdb_init_reader (void);
32660 @cindex @code{struct gdb_reader_funcs}
32662 @code{struct gdb_reader_funcs} contains a set of pointers to callback
32663 functions. These functions are executed to read the debug info
32664 generated by the JIT compiler (@code{read}), to unwind stack frames
32665 (@code{unwind}) and to create canonical frame IDs
32666 (@code{get_Frame_id}). It also has a callback that is called when the
32667 reader is being unloaded (@code{destroy}). The struct looks like this
32670 struct gdb_reader_funcs
32672 /* Must be set to GDB_READER_INTERFACE_VERSION. */
32673 int reader_version;
32675 /* For use by the reader. */
32678 gdb_read_debug_info *read;
32679 gdb_unwind_frame *unwind;
32680 gdb_get_frame_id *get_frame_id;
32681 gdb_destroy_reader *destroy;
32685 @cindex @code{struct gdb_symbol_callbacks}
32686 @cindex @code{struct gdb_unwind_callbacks}
32688 The callbacks are provided with another set of callbacks by
32689 @value{GDBN} to do their job. For @code{read}, these callbacks are
32690 passed in a @code{struct gdb_symbol_callbacks} and for @code{unwind}
32691 and @code{get_frame_id}, in a @code{struct gdb_unwind_callbacks}.
32692 @code{struct gdb_symbol_callbacks} has callbacks to create new object
32693 files and new symbol tables inside those object files. @code{struct
32694 gdb_unwind_callbacks} has callbacks to read registers off the current
32695 frame and to write out the values of the registers in the previous
32696 frame. Both have a callback (@code{target_read}) to read bytes off the
32697 target's address space.
32699 @node In-Process Agent
32700 @chapter In-Process Agent
32701 @cindex debugging agent
32702 The traditional debugging model is conceptually low-speed, but works fine,
32703 because most bugs can be reproduced in debugging-mode execution. However,
32704 as multi-core or many-core processors are becoming mainstream, and
32705 multi-threaded programs become more and more popular, there should be more
32706 and more bugs that only manifest themselves at normal-mode execution, for
32707 example, thread races, because debugger's interference with the program's
32708 timing may conceal the bugs. On the other hand, in some applications,
32709 it is not feasible for the debugger to interrupt the program's execution
32710 long enough for the developer to learn anything helpful about its behavior.
32711 If the program's correctness depends on its real-time behavior, delays
32712 introduced by a debugger might cause the program to fail, even when the
32713 code itself is correct. It is useful to be able to observe the program's
32714 behavior without interrupting it.
32716 Therefore, traditional debugging model is too intrusive to reproduce
32717 some bugs. In order to reduce the interference with the program, we can
32718 reduce the number of operations performed by debugger. The
32719 @dfn{In-Process Agent}, a shared library, is running within the same
32720 process with inferior, and is able to perform some debugging operations
32721 itself. As a result, debugger is only involved when necessary, and
32722 performance of debugging can be improved accordingly. Note that
32723 interference with program can be reduced but can't be removed completely,
32724 because the in-process agent will still stop or slow down the program.
32726 The in-process agent can interpret and execute Agent Expressions
32727 (@pxref{Agent Expressions}) during performing debugging operations. The
32728 agent expressions can be used for different purposes, such as collecting
32729 data in tracepoints, and condition evaluation in breakpoints.
32731 @anchor{Control Agent}
32732 You can control whether the in-process agent is used as an aid for
32733 debugging with the following commands:
32736 @kindex set agent on
32738 Causes the in-process agent to perform some operations on behalf of the
32739 debugger. Just which operations requested by the user will be done
32740 by the in-process agent depends on the its capabilities. For example,
32741 if you request to evaluate breakpoint conditions in the in-process agent,
32742 and the in-process agent has such capability as well, then breakpoint
32743 conditions will be evaluated in the in-process agent.
32745 @kindex set agent off
32746 @item set agent off
32747 Disables execution of debugging operations by the in-process agent. All
32748 of the operations will be performed by @value{GDBN}.
32752 Display the current setting of execution of debugging operations by
32753 the in-process agent.
32757 * In-Process Agent Protocol::
32760 @node In-Process Agent Protocol
32761 @section In-Process Agent Protocol
32762 @cindex in-process agent protocol
32764 The in-process agent is able to communicate with both @value{GDBN} and
32765 GDBserver (@pxref{In-Process Agent}). This section documents the protocol
32766 used for communications between @value{GDBN} or GDBserver and the IPA.
32767 In general, @value{GDBN} or GDBserver sends commands
32768 (@pxref{IPA Protocol Commands}) and data to in-process agent, and then
32769 in-process agent replies back with the return result of the command, or
32770 some other information. The data sent to in-process agent is composed
32771 of primitive data types, such as 4-byte or 8-byte type, and composite
32772 types, which are called objects (@pxref{IPA Protocol Objects}).
32775 * IPA Protocol Objects::
32776 * IPA Protocol Commands::
32779 @node IPA Protocol Objects
32780 @subsection IPA Protocol Objects
32781 @cindex ipa protocol objects
32783 The commands sent to and results received from agent may contain some
32784 complex data types called @dfn{objects}.
32786 The in-process agent is running on the same machine with @value{GDBN}
32787 or GDBserver, so it doesn't have to handle as much differences between
32788 two ends as remote protocol (@pxref{Remote Protocol}) tries to handle.
32789 However, there are still some differences of two ends in two processes:
32793 word size. On some 64-bit machines, @value{GDBN} or GDBserver can be
32794 compiled as a 64-bit executable, while in-process agent is a 32-bit one.
32796 ABI. Some machines may have multiple types of ABI, @value{GDBN} or
32797 GDBserver is compiled with one, and in-process agent is compiled with
32801 Here are the IPA Protocol Objects:
32805 agent expression object. It represents an agent expression
32806 (@pxref{Agent Expressions}).
32807 @anchor{agent expression object}
32809 tracepoint action object. It represents a tracepoint action
32810 (@pxref{Tracepoint Actions,,Tracepoint Action Lists}) to collect registers,
32811 memory, static trace data and to evaluate expression.
32812 @anchor{tracepoint action object}
32814 tracepoint object. It represents a tracepoint (@pxref{Tracepoints}).
32815 @anchor{tracepoint object}
32819 The following table describes important attributes of each IPA protocol
32822 @multitable @columnfractions .30 .20 .50
32823 @headitem Name @tab Size @tab Description
32824 @item @emph{agent expression object} @tab @tab
32825 @item length @tab 4 @tab length of bytes code
32826 @item byte code @tab @var{length} @tab contents of byte code
32827 @item @emph{tracepoint action for collecting memory} @tab @tab
32828 @item 'M' @tab 1 @tab type of tracepoint action
32829 @item addr @tab 8 @tab if @var{basereg} is @samp{-1}, @var{addr} is the
32830 address of the lowest byte to collect, otherwise @var{addr} is the offset
32831 of @var{basereg} for memory collecting.
32832 @item len @tab 8 @tab length of memory for collecting
32833 @item basereg @tab 4 @tab the register number containing the starting
32834 memory address for collecting.
32835 @item @emph{tracepoint action for collecting registers} @tab @tab
32836 @item 'R' @tab 1 @tab type of tracepoint action
32837 @item @emph{tracepoint action for collecting static trace data} @tab @tab
32838 @item 'L' @tab 1 @tab type of tracepoint action
32839 @item @emph{tracepoint action for expression evaluation} @tab @tab
32840 @item 'X' @tab 1 @tab type of tracepoint action
32841 @item agent expression @tab length of @tab @ref{agent expression object}
32842 @item @emph{tracepoint object} @tab @tab
32843 @item number @tab 4 @tab number of tracepoint
32844 @item address @tab 8 @tab address of tracepoint inserted on
32845 @item type @tab 4 @tab type of tracepoint
32846 @item enabled @tab 1 @tab enable or disable of tracepoint
32847 @item step_count @tab 8 @tab step
32848 @item pass_count @tab 8 @tab pass
32849 @item numactions @tab 4 @tab number of tracepoint actions
32850 @item hit count @tab 8 @tab hit count
32851 @item trace frame usage @tab 8 @tab trace frame usage
32852 @item compiled_cond @tab 8 @tab compiled condition
32853 @item orig_size @tab 8 @tab orig size
32854 @item condition @tab 4 if condition is NULL otherwise length of
32855 @ref{agent expression object}
32856 @tab zero if condition is NULL, otherwise is
32857 @ref{agent expression object}
32858 @item actions @tab variable
32859 @tab numactions number of @ref{tracepoint action object}
32862 @node IPA Protocol Commands
32863 @subsection IPA Protocol Commands
32864 @cindex ipa protocol commands
32866 The spaces in each command are delimiters to ease reading this commands
32867 specification. They don't exist in real commands.
32871 @item FastTrace:@var{tracepoint_object} @var{gdb_jump_pad_head}
32872 Installs a new fast tracepoint described by @var{tracepoint_object}
32873 (@pxref{tracepoint object}). The @var{gdb_jump_pad_head}, 8-byte long, is the
32874 head of @dfn{jumppad}, which is used to jump to data collection routine
32879 @item OK @var{target_address} @var{gdb_jump_pad_head} @var{fjump_size} @var{fjump}
32880 @var{target_address} is address of tracepoint in the inferior.
32881 The @var{gdb_jump_pad_head} is updated head of jumppad. Both of
32882 @var{target_address} and @var{gdb_jump_pad_head} are 8-byte long.
32883 The @var{fjump} contains a sequence of instructions jump to jumppad entry.
32884 The @var{fjump_size}, 4-byte long, is the size of @var{fjump}.
32891 Closes the in-process agent. This command is sent when @value{GDBN} or GDBserver
32892 is about to kill inferiors.
32900 @item probe_marker_at:@var{address}
32901 Asks in-process agent to probe the marker at @var{address}.
32908 @item unprobe_marker_at:@var{address}
32909 Asks in-process agent to unprobe the marker at @var{address}.
32913 @chapter Reporting Bugs in @value{GDBN}
32914 @cindex bugs in @value{GDBN}
32915 @cindex reporting bugs in @value{GDBN}
32917 Your bug reports play an essential role in making @value{GDBN} reliable.
32919 Reporting a bug may help you by bringing a solution to your problem, or it
32920 may not. But in any case the principal function of a bug report is to help
32921 the entire community by making the next version of @value{GDBN} work better. Bug
32922 reports are your contribution to the maintenance of @value{GDBN}.
32924 In order for a bug report to serve its purpose, you must include the
32925 information that enables us to fix the bug.
32928 * Bug Criteria:: Have you found a bug?
32929 * Bug Reporting:: How to report bugs
32933 @section Have You Found a Bug?
32934 @cindex bug criteria
32936 If you are not sure whether you have found a bug, here are some guidelines:
32939 @cindex fatal signal
32940 @cindex debugger crash
32941 @cindex crash of debugger
32943 If the debugger gets a fatal signal, for any input whatever, that is a
32944 @value{GDBN} bug. Reliable debuggers never crash.
32946 @cindex error on valid input
32948 If @value{GDBN} produces an error message for valid input, that is a
32949 bug. (Note that if you're cross debugging, the problem may also be
32950 somewhere in the connection to the target.)
32952 @cindex invalid input
32954 If @value{GDBN} does not produce an error message for invalid input,
32955 that is a bug. However, you should note that your idea of
32956 ``invalid input'' might be our idea of ``an extension'' or ``support
32957 for traditional practice''.
32960 If you are an experienced user of debugging tools, your suggestions
32961 for improvement of @value{GDBN} are welcome in any case.
32964 @node Bug Reporting
32965 @section How to Report Bugs
32966 @cindex bug reports
32967 @cindex @value{GDBN} bugs, reporting
32969 A number of companies and individuals offer support for @sc{gnu} products.
32970 If you obtained @value{GDBN} from a support organization, we recommend you
32971 contact that organization first.
32973 You can find contact information for many support companies and
32974 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
32976 @c should add a web page ref...
32979 @ifset BUGURL_DEFAULT
32980 In any event, we also recommend that you submit bug reports for
32981 @value{GDBN}. The preferred method is to submit them directly using
32982 @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web
32983 page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can
32986 @strong{Do not send bug reports to @samp{info-gdb}, or to
32987 @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do
32988 not want to receive bug reports. Those that do have arranged to receive
32991 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
32992 serves as a repeater. The mailing list and the newsgroup carry exactly
32993 the same messages. Often people think of posting bug reports to the
32994 newsgroup instead of mailing them. This appears to work, but it has one
32995 problem which can be crucial: a newsgroup posting often lacks a mail
32996 path back to the sender. Thus, if we need to ask for more information,
32997 we may be unable to reach you. For this reason, it is better to send
32998 bug reports to the mailing list.
33000 @ifclear BUGURL_DEFAULT
33001 In any event, we also recommend that you submit bug reports for
33002 @value{GDBN} to @value{BUGURL}.
33006 The fundamental principle of reporting bugs usefully is this:
33007 @strong{report all the facts}. If you are not sure whether to state a
33008 fact or leave it out, state it!
33010 Often people omit facts because they think they know what causes the
33011 problem and assume that some details do not matter. Thus, you might
33012 assume that the name of the variable you use in an example does not matter.
33013 Well, probably it does not, but one cannot be sure. Perhaps the bug is a
33014 stray memory reference which happens to fetch from the location where that
33015 name is stored in memory; perhaps, if the name were different, the contents
33016 of that location would fool the debugger into doing the right thing despite
33017 the bug. Play it safe and give a specific, complete example. That is the
33018 easiest thing for you to do, and the most helpful.
33020 Keep in mind that the purpose of a bug report is to enable us to fix the
33021 bug. It may be that the bug has been reported previously, but neither
33022 you nor we can know that unless your bug report is complete and
33025 Sometimes people give a few sketchy facts and ask, ``Does this ring a
33026 bell?'' Those bug reports are useless, and we urge everyone to
33027 @emph{refuse to respond to them} except to chide the sender to report
33030 To enable us to fix the bug, you should include all these things:
33034 The version of @value{GDBN}. @value{GDBN} announces it if you start
33035 with no arguments; you can also print it at any time using @code{show
33038 Without this, we will not know whether there is any point in looking for
33039 the bug in the current version of @value{GDBN}.
33042 The type of machine you are using, and the operating system name and
33046 The details of the @value{GDBN} build-time configuration.
33047 @value{GDBN} shows these details if you invoke it with the
33048 @option{--configuration} command-line option, or if you type
33049 @code{show configuration} at @value{GDBN}'s prompt.
33052 What compiler (and its version) was used to compile @value{GDBN}---e.g.@:
33053 ``@value{GCC}--2.8.1''.
33056 What compiler (and its version) was used to compile the program you are
33057 debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
33058 C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version}
33059 to get this information; for other compilers, see the documentation for
33063 The command arguments you gave the compiler to compile your example and
33064 observe the bug. For example, did you use @samp{-O}? To guarantee
33065 you will not omit something important, list them all. A copy of the
33066 Makefile (or the output from make) is sufficient.
33068 If we were to try to guess the arguments, we would probably guess wrong
33069 and then we might not encounter the bug.
33072 A complete input script, and all necessary source files, that will
33076 A description of what behavior you observe that you believe is
33077 incorrect. For example, ``It gets a fatal signal.''
33079 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
33080 will certainly notice it. But if the bug is incorrect output, we might
33081 not notice unless it is glaringly wrong. You might as well not give us
33082 a chance to make a mistake.
33084 Even if the problem you experience is a fatal signal, you should still
33085 say so explicitly. Suppose something strange is going on, such as, your
33086 copy of @value{GDBN} is out of synch, or you have encountered a bug in
33087 the C library on your system. (This has happened!) Your copy might
33088 crash and ours would not. If you told us to expect a crash, then when
33089 ours fails to crash, we would know that the bug was not happening for
33090 us. If you had not told us to expect a crash, then we would not be able
33091 to draw any conclusion from our observations.
33094 @cindex recording a session script
33095 To collect all this information, you can use a session recording program
33096 such as @command{script}, which is available on many Unix systems.
33097 Just run your @value{GDBN} session inside @command{script} and then
33098 include the @file{typescript} file with your bug report.
33100 Another way to record a @value{GDBN} session is to run @value{GDBN}
33101 inside Emacs and then save the entire buffer to a file.
33104 If you wish to suggest changes to the @value{GDBN} source, send us context
33105 diffs. If you even discuss something in the @value{GDBN} source, refer to
33106 it by context, not by line number.
33108 The line numbers in our development sources will not match those in your
33109 sources. Your line numbers would convey no useful information to us.
33113 Here are some things that are not necessary:
33117 A description of the envelope of the bug.
33119 Often people who encounter a bug spend a lot of time investigating
33120 which changes to the input file will make the bug go away and which
33121 changes will not affect it.
33123 This is often time consuming and not very useful, because the way we
33124 will find the bug is by running a single example under the debugger
33125 with breakpoints, not by pure deduction from a series of examples.
33126 We recommend that you save your time for something else.
33128 Of course, if you can find a simpler example to report @emph{instead}
33129 of the original one, that is a convenience for us. Errors in the
33130 output will be easier to spot, running under the debugger will take
33131 less time, and so on.
33133 However, simplification is not vital; if you do not want to do this,
33134 report the bug anyway and send us the entire test case you used.
33137 A patch for the bug.
33139 A patch for the bug does help us if it is a good one. But do not omit
33140 the necessary information, such as the test case, on the assumption that
33141 a patch is all we need. We might see problems with your patch and decide
33142 to fix the problem another way, or we might not understand it at all.
33144 Sometimes with a program as complicated as @value{GDBN} it is very hard to
33145 construct an example that will make the program follow a certain path
33146 through the code. If you do not send us the example, we will not be able
33147 to construct one, so we will not be able to verify that the bug is fixed.
33149 And if we cannot understand what bug you are trying to fix, or why your
33150 patch should be an improvement, we will not install it. A test case will
33151 help us to understand.
33154 A guess about what the bug is or what it depends on.
33156 Such guesses are usually wrong. Even we cannot guess right about such
33157 things without first using the debugger to find the facts.
33160 @c The readline documentation is distributed with the readline code
33161 @c and consists of the two following files:
33164 @c Use -I with makeinfo to point to the appropriate directory,
33165 @c environment var TEXINPUTS with TeX.
33166 @ifclear SYSTEM_READLINE
33167 @include rluser.texi
33168 @include hsuser.texi
33172 @appendix In Memoriam
33174 The @value{GDBN} project mourns the loss of the following long-time
33179 Fred was a long-standing contributor to @value{GDBN} (1991-2006), and
33180 to Free Software in general. Outside of @value{GDBN}, he was known in
33181 the Amiga world for his series of Fish Disks, and the GeekGadget project.
33183 @item Michael Snyder
33184 Michael was one of the Global Maintainers of the @value{GDBN} project,
33185 with contributions recorded as early as 1996, until 2011. In addition
33186 to his day to day participation, he was a large driving force behind
33187 adding Reverse Debugging to @value{GDBN}.
33190 Beyond their technical contributions to the project, they were also
33191 enjoyable members of the Free Software Community. We will miss them.
33193 @node Formatting Documentation
33194 @appendix Formatting Documentation
33196 @cindex @value{GDBN} reference card
33197 @cindex reference card
33198 The @value{GDBN} 4 release includes an already-formatted reference card, ready
33199 for printing with PostScript or Ghostscript, in the @file{gdb}
33200 subdirectory of the main source directory@footnote{In
33201 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
33202 release.}. If you can use PostScript or Ghostscript with your printer,
33203 you can print the reference card immediately with @file{refcard.ps}.
33205 The release also includes the source for the reference card. You
33206 can format it, using @TeX{}, by typing:
33212 The @value{GDBN} reference card is designed to print in @dfn{landscape}
33213 mode on US ``letter'' size paper;
33214 that is, on a sheet 11 inches wide by 8.5 inches
33215 high. You will need to specify this form of printing as an option to
33216 your @sc{dvi} output program.
33218 @cindex documentation
33220 All the documentation for @value{GDBN} comes as part of the machine-readable
33221 distribution. The documentation is written in Texinfo format, which is
33222 a documentation system that uses a single source file to produce both
33223 on-line information and a printed manual. You can use one of the Info
33224 formatting commands to create the on-line version of the documentation
33225 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
33227 @value{GDBN} includes an already formatted copy of the on-line Info
33228 version of this manual in the @file{gdb} subdirectory. The main Info
33229 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
33230 subordinate files matching @samp{gdb.info*} in the same directory. If
33231 necessary, you can print out these files, or read them with any editor;
33232 but they are easier to read using the @code{info} subsystem in @sc{gnu}
33233 Emacs or the standalone @code{info} program, available as part of the
33234 @sc{gnu} Texinfo distribution.
33236 If you want to format these Info files yourself, you need one of the
33237 Info formatting programs, such as @code{texinfo-format-buffer} or
33240 If you have @code{makeinfo} installed, and are in the top level
33241 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
33242 version @value{GDBVN}), you can make the Info file by typing:
33249 If you want to typeset and print copies of this manual, you need @TeX{},
33250 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
33251 Texinfo definitions file.
33253 @TeX{} is a typesetting program; it does not print files directly, but
33254 produces output files called @sc{dvi} files. To print a typeset
33255 document, you need a program to print @sc{dvi} files. If your system
33256 has @TeX{} installed, chances are it has such a program. The precise
33257 command to use depends on your system; @kbd{lpr -d} is common; another
33258 (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may
33259 require a file name without any extension or a @samp{.dvi} extension.
33261 @TeX{} also requires a macro definitions file called
33262 @file{texinfo.tex}. This file tells @TeX{} how to typeset a document
33263 written in Texinfo format. On its own, @TeX{} cannot either read or
33264 typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB
33265 and is located in the @file{gdb-@var{version-number}/texinfo}
33268 If you have @TeX{} and a @sc{dvi} printer program installed, you can
33269 typeset and print this manual. First switch to the @file{gdb}
33270 subdirectory of the main source directory (for example, to
33271 @file{gdb-@value{GDBVN}/gdb}) and type:
33277 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
33279 @node Installing GDB
33280 @appendix Installing @value{GDBN}
33281 @cindex installation
33284 * Requirements:: Requirements for building @value{GDBN}
33285 * Running Configure:: Invoking the @value{GDBN} @file{configure} script
33286 * Separate Objdir:: Compiling @value{GDBN} in another directory
33287 * Config Names:: Specifying names for hosts and targets
33288 * Configure Options:: Summary of options for configure
33289 * System-wide configuration:: Having a system-wide init file
33293 @section Requirements for Building @value{GDBN}
33294 @cindex building @value{GDBN}, requirements for
33296 Building @value{GDBN} requires various tools and packages to be available.
33297 Other packages will be used only if they are found.
33299 @heading Tools/Packages Necessary for Building @value{GDBN}
33301 @item ISO C90 compiler
33302 @value{GDBN} is written in ISO C90. It should be buildable with any
33303 working C90 compiler, e.g.@: GCC.
33307 @heading Tools/Packages Optional for Building @value{GDBN}
33311 @value{GDBN} can use the Expat XML parsing library. This library may be
33312 included with your operating system distribution; if it is not, you
33313 can get the latest version from @url{http://expat.sourceforge.net}.
33314 The @file{configure} script will search for this library in several
33315 standard locations; if it is installed in an unusual path, you can
33316 use the @option{--with-libexpat-prefix} option to specify its location.
33322 Remote protocol memory maps (@pxref{Memory Map Format})
33324 Target descriptions (@pxref{Target Descriptions})
33326 Remote shared library lists (@xref{Library List Format},
33327 or alternatively @pxref{Library List Format for SVR4 Targets})
33329 MS-Windows shared libraries (@pxref{Shared Libraries})
33331 Traceframe info (@pxref{Traceframe Info Format})
33333 Branch trace (@pxref{Branch Trace Format},
33334 @pxref{Branch Trace Configuration Format})
33338 @cindex compressed debug sections
33339 @value{GDBN} will use the @samp{zlib} library, if available, to read
33340 compressed debug sections. Some linkers, such as GNU gold, are capable
33341 of producing binaries with compressed debug sections. If @value{GDBN}
33342 is compiled with @samp{zlib}, it will be able to read the debug
33343 information in such binaries.
33345 The @samp{zlib} library is likely included with your operating system
33346 distribution; if it is not, you can get the latest version from
33347 @url{http://zlib.net}.
33350 @value{GDBN}'s features related to character sets (@pxref{Character
33351 Sets}) require a functioning @code{iconv} implementation. If you are
33352 on a GNU system, then this is provided by the GNU C Library. Some
33353 other systems also provide a working @code{iconv}.
33355 If @value{GDBN} is using the @code{iconv} program which is installed
33356 in a non-standard place, you will need to tell @value{GDBN} where to find it.
33357 This is done with @option{--with-iconv-bin} which specifies the
33358 directory that contains the @code{iconv} program.
33360 On systems without @code{iconv}, you can install GNU Libiconv. If you
33361 have previously installed Libiconv, you can use the
33362 @option{--with-libiconv-prefix} option to configure.
33364 @value{GDBN}'s top-level @file{configure} and @file{Makefile} will
33365 arrange to build Libiconv if a directory named @file{libiconv} appears
33366 in the top-most source directory. If Libiconv is built this way, and
33367 if the operating system does not provide a suitable @code{iconv}
33368 implementation, then the just-built library will automatically be used
33369 by @value{GDBN}. One easy way to set this up is to download GNU
33370 Libiconv, unpack it, and then rename the directory holding the
33371 Libiconv source code to @samp{libiconv}.
33374 @node Running Configure
33375 @section Invoking the @value{GDBN} @file{configure} Script
33376 @cindex configuring @value{GDBN}
33377 @value{GDBN} comes with a @file{configure} script that automates the process
33378 of preparing @value{GDBN} for installation; you can then use @code{make} to
33379 build the @code{gdb} program.
33381 @c irrelevant in info file; it's as current as the code it lives with.
33382 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
33383 look at the @file{README} file in the sources; we may have improved the
33384 installation procedures since publishing this manual.}
33387 The @value{GDBN} distribution includes all the source code you need for
33388 @value{GDBN} in a single directory, whose name is usually composed by
33389 appending the version number to @samp{gdb}.
33391 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
33392 @file{gdb-@value{GDBVN}} directory. That directory contains:
33395 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
33396 script for configuring @value{GDBN} and all its supporting libraries
33398 @item gdb-@value{GDBVN}/gdb
33399 the source specific to @value{GDBN} itself
33401 @item gdb-@value{GDBVN}/bfd
33402 source for the Binary File Descriptor library
33404 @item gdb-@value{GDBVN}/include
33405 @sc{gnu} include files
33407 @item gdb-@value{GDBVN}/libiberty
33408 source for the @samp{-liberty} free software library
33410 @item gdb-@value{GDBVN}/opcodes
33411 source for the library of opcode tables and disassemblers
33413 @item gdb-@value{GDBVN}/readline
33414 source for the @sc{gnu} command-line interface
33416 @item gdb-@value{GDBVN}/glob
33417 source for the @sc{gnu} filename pattern-matching subroutine
33419 @item gdb-@value{GDBVN}/mmalloc
33420 source for the @sc{gnu} memory-mapped malloc package
33423 The simplest way to configure and build @value{GDBN} is to run @file{configure}
33424 from the @file{gdb-@var{version-number}} source directory, which in
33425 this example is the @file{gdb-@value{GDBVN}} directory.
33427 First switch to the @file{gdb-@var{version-number}} source directory
33428 if you are not already in it; then run @file{configure}. Pass the
33429 identifier for the platform on which @value{GDBN} will run as an
33435 cd gdb-@value{GDBVN}
33436 ./configure @var{host}
33441 where @var{host} is an identifier such as @samp{sun4} or
33442 @samp{decstation}, that identifies the platform where @value{GDBN} will run.
33443 (You can often leave off @var{host}; @file{configure} tries to guess the
33444 correct value by examining your system.)
33446 Running @samp{configure @var{host}} and then running @code{make} builds the
33447 @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
33448 libraries, then @code{gdb} itself. The configured source files, and the
33449 binaries, are left in the corresponding source directories.
33452 @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
33453 system does not recognize this automatically when you run a different
33454 shell, you may need to run @code{sh} on it explicitly:
33457 sh configure @var{host}
33460 If you run @file{configure} from a directory that contains source
33461 directories for multiple libraries or programs, such as the
33462 @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN},
33464 creates configuration files for every directory level underneath (unless
33465 you tell it not to, with the @samp{--norecursion} option).
33467 You should run the @file{configure} script from the top directory in the
33468 source tree, the @file{gdb-@var{version-number}} directory. If you run
33469 @file{configure} from one of the subdirectories, you will configure only
33470 that subdirectory. That is usually not what you want. In particular,
33471 if you run the first @file{configure} from the @file{gdb} subdirectory
33472 of the @file{gdb-@var{version-number}} directory, you will omit the
33473 configuration of @file{bfd}, @file{readline}, and other sibling
33474 directories of the @file{gdb} subdirectory. This leads to build errors
33475 about missing include files such as @file{bfd/bfd.h}.
33477 You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
33478 However, you should make sure that the shell on your path (named by
33479 the @samp{SHELL} environment variable) is publicly readable. Remember
33480 that @value{GDBN} uses the shell to start your program---some systems refuse to
33481 let @value{GDBN} debug child processes whose programs are not readable.
33483 @node Separate Objdir
33484 @section Compiling @value{GDBN} in Another Directory
33486 If you want to run @value{GDBN} versions for several host or target machines,
33487 you need a different @code{gdb} compiled for each combination of
33488 host and target. @file{configure} is designed to make this easy by
33489 allowing you to generate each configuration in a separate subdirectory,
33490 rather than in the source directory. If your @code{make} program
33491 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
33492 @code{make} in each of these directories builds the @code{gdb}
33493 program specified there.
33495 To build @code{gdb} in a separate directory, run @file{configure}
33496 with the @samp{--srcdir} option to specify where to find the source.
33497 (You also need to specify a path to find @file{configure}
33498 itself from your working directory. If the path to @file{configure}
33499 would be the same as the argument to @samp{--srcdir}, you can leave out
33500 the @samp{--srcdir} option; it is assumed.)
33502 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
33503 separate directory for a Sun 4 like this:
33507 cd gdb-@value{GDBVN}
33510 ../gdb-@value{GDBVN}/configure sun4
33515 When @file{configure} builds a configuration using a remote source
33516 directory, it creates a tree for the binaries with the same structure
33517 (and using the same names) as the tree under the source directory. In
33518 the example, you'd find the Sun 4 library @file{libiberty.a} in the
33519 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
33520 @file{gdb-sun4/gdb}.
33522 Make sure that your path to the @file{configure} script has just one
33523 instance of @file{gdb} in it. If your path to @file{configure} looks
33524 like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
33525 one subdirectory of @value{GDBN}, not the whole package. This leads to
33526 build errors about missing include files such as @file{bfd/bfd.h}.
33528 One popular reason to build several @value{GDBN} configurations in separate
33529 directories is to configure @value{GDBN} for cross-compiling (where
33530 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
33531 programs that run on another machine---the @dfn{target}).
33532 You specify a cross-debugging target by
33533 giving the @samp{--target=@var{target}} option to @file{configure}.
33535 When you run @code{make} to build a program or library, you must run
33536 it in a configured directory---whatever directory you were in when you
33537 called @file{configure} (or one of its subdirectories).
33539 The @code{Makefile} that @file{configure} generates in each source
33540 directory also runs recursively. If you type @code{make} in a source
33541 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
33542 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
33543 will build all the required libraries, and then build GDB.
33545 When you have multiple hosts or targets configured in separate
33546 directories, you can run @code{make} on them in parallel (for example,
33547 if they are NFS-mounted on each of the hosts); they will not interfere
33551 @section Specifying Names for Hosts and Targets
33553 The specifications used for hosts and targets in the @file{configure}
33554 script are based on a three-part naming scheme, but some short predefined
33555 aliases are also supported. The full naming scheme encodes three pieces
33556 of information in the following pattern:
33559 @var{architecture}-@var{vendor}-@var{os}
33562 For example, you can use the alias @code{sun4} as a @var{host} argument,
33563 or as the value for @var{target} in a @code{--target=@var{target}}
33564 option. The equivalent full name is @samp{sparc-sun-sunos4}.
33566 The @file{configure} script accompanying @value{GDBN} does not provide
33567 any query facility to list all supported host and target names or
33568 aliases. @file{configure} calls the Bourne shell script
33569 @code{config.sub} to map abbreviations to full names; you can read the
33570 script, if you wish, or you can use it to test your guesses on
33571 abbreviations---for example:
33574 % sh config.sub i386-linux
33576 % sh config.sub alpha-linux
33577 alpha-unknown-linux-gnu
33578 % sh config.sub hp9k700
33580 % sh config.sub sun4
33581 sparc-sun-sunos4.1.1
33582 % sh config.sub sun3
33583 m68k-sun-sunos4.1.1
33584 % sh config.sub i986v
33585 Invalid configuration `i986v': machine `i986v' not recognized
33589 @code{config.sub} is also distributed in the @value{GDBN} source
33590 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
33592 @node Configure Options
33593 @section @file{configure} Options
33595 Here is a summary of the @file{configure} options and arguments that
33596 are most often useful for building @value{GDBN}. @file{configure} also has
33597 several other options not listed here. @inforef{What Configure
33598 Does,,configure.info}, for a full explanation of @file{configure}.
33601 configure @r{[}--help@r{]}
33602 @r{[}--prefix=@var{dir}@r{]}
33603 @r{[}--exec-prefix=@var{dir}@r{]}
33604 @r{[}--srcdir=@var{dirname}@r{]}
33605 @r{[}--norecursion@r{]} @r{[}--rm@r{]}
33606 @r{[}--target=@var{target}@r{]}
33611 You may introduce options with a single @samp{-} rather than
33612 @samp{--} if you prefer; but you may abbreviate option names if you use
33617 Display a quick summary of how to invoke @file{configure}.
33619 @item --prefix=@var{dir}
33620 Configure the source to install programs and files under directory
33623 @item --exec-prefix=@var{dir}
33624 Configure the source to install programs under directory
33627 @c avoid splitting the warning from the explanation:
33629 @item --srcdir=@var{dirname}
33630 @strong{Warning: using this option requires @sc{gnu} @code{make}, or another
33631 @code{make} that implements the @code{VPATH} feature.}@*
33632 Use this option to make configurations in directories separate from the
33633 @value{GDBN} source directories. Among other things, you can use this to
33634 build (or maintain) several configurations simultaneously, in separate
33635 directories. @file{configure} writes configuration-specific files in
33636 the current directory, but arranges for them to use the source in the
33637 directory @var{dirname}. @file{configure} creates directories under
33638 the working directory in parallel to the source directories below
33641 @item --norecursion
33642 Configure only the directory level where @file{configure} is executed; do not
33643 propagate configuration to subdirectories.
33645 @item --target=@var{target}
33646 Configure @value{GDBN} for cross-debugging programs running on the specified
33647 @var{target}. Without this option, @value{GDBN} is configured to debug
33648 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
33650 There is no convenient way to generate a list of all available targets.
33652 @item @var{host} @dots{}
33653 Configure @value{GDBN} to run on the specified @var{host}.
33655 There is no convenient way to generate a list of all available hosts.
33658 There are many other options available as well, but they are generally
33659 needed for special purposes only.
33661 @node System-wide configuration
33662 @section System-wide configuration and settings
33663 @cindex system-wide init file
33665 @value{GDBN} can be configured to have a system-wide init file;
33666 this file will be read and executed at startup (@pxref{Startup, , What
33667 @value{GDBN} does during startup}).
33669 Here is the corresponding configure option:
33672 @item --with-system-gdbinit=@var{file}
33673 Specify that the default location of the system-wide init file is
33677 If @value{GDBN} has been configured with the option @option{--prefix=$prefix},
33678 it may be subject to relocation. Two possible cases:
33682 If the default location of this init file contains @file{$prefix},
33683 it will be subject to relocation. Suppose that the configure options
33684 are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit};
33685 if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system
33686 init file is looked for as @file{$install/etc/gdbinit} instead of
33687 @file{$prefix/etc/gdbinit}.
33690 By contrast, if the default location does not contain the prefix,
33691 it will not be relocated. E.g.@: if @value{GDBN} has been configured with
33692 @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit},
33693 then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit},
33694 wherever @value{GDBN} is installed.
33697 If the configured location of the system-wide init file (as given by the
33698 @option{--with-system-gdbinit} option at configure time) is in the
33699 data-directory (as specified by @option{--with-gdb-datadir} at configure
33700 time) or in one of its subdirectories, then @value{GDBN} will look for the
33701 system-wide init file in the directory specified by the
33702 @option{--data-directory} command-line option.
33703 Note that the system-wide init file is only read once, during @value{GDBN}
33704 initialization. If the data-directory is changed after @value{GDBN} has
33705 started with the @code{set data-directory} command, the file will not be
33709 * System-wide Configuration Scripts:: Installed System-wide Configuration Scripts
33712 @node System-wide Configuration Scripts
33713 @subsection Installed System-wide Configuration Scripts
33714 @cindex system-wide configuration scripts
33716 The @file{system-gdbinit} directory, located inside the data-directory
33717 (as specified by @option{--with-gdb-datadir} at configure time) contains
33718 a number of scripts which can be used as system-wide init files. To
33719 automatically source those scripts at startup, @value{GDBN} should be
33720 configured with @option{--with-system-gdbinit}. Otherwise, any user
33721 should be able to source them by hand as needed.
33723 The following scripts are currently available:
33726 @item @file{elinos.py}
33728 @cindex ELinOS system-wide configuration script
33729 This script is useful when debugging a program on an ELinOS target.
33730 It takes advantage of the environment variables defined in a standard
33731 ELinOS environment in order to determine the location of the system
33732 shared libraries, and then sets the @samp{solib-absolute-prefix}
33733 and @samp{solib-search-path} variables appropriately.
33735 @item @file{wrs-linux.py}
33736 @pindex wrs-linux.py
33737 @cindex Wind River Linux system-wide configuration script
33738 This script is useful when debugging a program on a target running
33739 Wind River Linux. It expects the @env{ENV_PREFIX} to be set to
33740 the host-side sysroot used by the target system.
33744 @node Maintenance Commands
33745 @appendix Maintenance Commands
33746 @cindex maintenance commands
33747 @cindex internal commands
33749 In addition to commands intended for @value{GDBN} users, @value{GDBN}
33750 includes a number of commands intended for @value{GDBN} developers,
33751 that are not documented elsewhere in this manual. These commands are
33752 provided here for reference. (For commands that turn on debugging
33753 messages, see @ref{Debugging Output}.)
33756 @kindex maint agent
33757 @kindex maint agent-eval
33758 @item maint agent @r{[}-at @var{location}@r{,}@r{]} @var{expression}
33759 @itemx maint agent-eval @r{[}-at @var{location}@r{,}@r{]} @var{expression}
33760 Translate the given @var{expression} into remote agent bytecodes.
33761 This command is useful for debugging the Agent Expression mechanism
33762 (@pxref{Agent Expressions}). The @samp{agent} version produces an
33763 expression useful for data collection, such as by tracepoints, while
33764 @samp{maint agent-eval} produces an expression that evaluates directly
33765 to a result. For instance, a collection expression for @code{globa +
33766 globb} will include bytecodes to record four bytes of memory at each
33767 of the addresses of @code{globa} and @code{globb}, while discarding
33768 the result of the addition, while an evaluation expression will do the
33769 addition and return the sum.
33770 If @code{-at} is given, generate remote agent bytecode for @var{location}.
33771 If not, generate remote agent bytecode for current frame PC address.
33773 @kindex maint agent-printf
33774 @item maint agent-printf @var{format},@var{expr},...
33775 Translate the given format string and list of argument expressions
33776 into remote agent bytecodes and display them as a disassembled list.
33777 This command is useful for debugging the agent version of dynamic
33778 printf (@pxref{Dynamic Printf}).
33780 @kindex maint info breakpoints
33781 @item @anchor{maint info breakpoints}maint info breakpoints
33782 Using the same format as @samp{info breakpoints}, display both the
33783 breakpoints you've set explicitly, and those @value{GDBN} is using for
33784 internal purposes. Internal breakpoints are shown with negative
33785 breakpoint numbers. The type column identifies what kind of breakpoint
33790 Normal, explicitly set breakpoint.
33793 Normal, explicitly set watchpoint.
33796 Internal breakpoint, used to handle correctly stepping through
33797 @code{longjmp} calls.
33799 @item longjmp resume
33800 Internal breakpoint at the target of a @code{longjmp}.
33803 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
33806 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
33809 Shared library events.
33813 @kindex maint info btrace
33814 @item maint info btrace
33815 Pint information about raw branch tracing data.
33817 @kindex maint btrace packet-history
33818 @item maint btrace packet-history
33819 Print the raw branch trace packets that are used to compute the
33820 execution history for the @samp{record btrace} command. Both the
33821 information and the format in which it is printed depend on the btrace
33826 For the BTS recording format, print a list of blocks of sequential
33827 code. For each block, the following information is printed:
33831 Newer blocks have higher numbers. The oldest block has number zero.
33832 @item Lowest @samp{PC}
33833 @item Highest @samp{PC}
33837 For the Intel(R) Processor Trace recording format, print a list of
33838 Intel(R) Processor Trace packets. For each packet, the following
33839 information is printed:
33842 @item Packet number
33843 Newer packets have higher numbers. The oldest packet has number zero.
33845 The packet's offset in the trace stream.
33846 @item Packet opcode and payload
33850 @kindex maint btrace clear-packet-history
33851 @item maint btrace clear-packet-history
33852 Discards the cached packet history printed by the @samp{maint btrace
33853 packet-history} command. The history will be computed again when
33856 @kindex maint btrace clear
33857 @item maint btrace clear
33858 Discard the branch trace data. The data will be fetched anew and the
33859 branch trace will be recomputed when needed.
33861 This implicitly truncates the branch trace to a single branch trace
33862 buffer. When updating branch trace incrementally, the branch trace
33863 available to @value{GDBN} may be bigger than a single branch trace
33866 @kindex maint set btrace pt skip-pad
33867 @item maint set btrace pt skip-pad
33868 @kindex maint show btrace pt skip-pad
33869 @item maint show btrace pt skip-pad
33870 Control whether @value{GDBN} will skip PAD packets when computing the
33873 @kindex set displaced-stepping
33874 @kindex show displaced-stepping
33875 @cindex displaced stepping support
33876 @cindex out-of-line single-stepping
33877 @item set displaced-stepping
33878 @itemx show displaced-stepping
33879 Control whether or not @value{GDBN} will do @dfn{displaced stepping}
33880 if the target supports it. Displaced stepping is a way to single-step
33881 over breakpoints without removing them from the inferior, by executing
33882 an out-of-line copy of the instruction that was originally at the
33883 breakpoint location. It is also known as out-of-line single-stepping.
33886 @item set displaced-stepping on
33887 If the target architecture supports it, @value{GDBN} will use
33888 displaced stepping to step over breakpoints.
33890 @item set displaced-stepping off
33891 @value{GDBN} will not use displaced stepping to step over breakpoints,
33892 even if such is supported by the target architecture.
33894 @cindex non-stop mode, and @samp{set displaced-stepping}
33895 @item set displaced-stepping auto
33896 This is the default mode. @value{GDBN} will use displaced stepping
33897 only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target
33898 architecture supports displaced stepping.
33901 @kindex maint check-psymtabs
33902 @item maint check-psymtabs
33903 Check the consistency of currently expanded psymtabs versus symtabs.
33904 Use this to check, for example, whether a symbol is in one but not the other.
33906 @kindex maint check-symtabs
33907 @item maint check-symtabs
33908 Check the consistency of currently expanded symtabs.
33910 @kindex maint expand-symtabs
33911 @item maint expand-symtabs [@var{regexp}]
33912 Expand symbol tables.
33913 If @var{regexp} is specified, only expand symbol tables for file
33914 names matching @var{regexp}.
33916 @kindex maint set catch-demangler-crashes
33917 @kindex maint show catch-demangler-crashes
33918 @cindex demangler crashes
33919 @item maint set catch-demangler-crashes [on|off]
33920 @itemx maint show catch-demangler-crashes
33921 Control whether @value{GDBN} should attempt to catch crashes in the
33922 symbol name demangler. The default is to attempt to catch crashes.
33923 If enabled, the first time a crash is caught, a core file is created,
33924 the offending symbol is displayed and the user is presented with the
33925 option to terminate the current session.
33927 @kindex maint cplus first_component
33928 @item maint cplus first_component @var{name}
33929 Print the first C@t{++} class/namespace component of @var{name}.
33931 @kindex maint cplus namespace
33932 @item maint cplus namespace
33933 Print the list of possible C@t{++} namespaces.
33935 @kindex maint deprecate
33936 @kindex maint undeprecate
33937 @cindex deprecated commands
33938 @item maint deprecate @var{command} @r{[}@var{replacement}@r{]}
33939 @itemx maint undeprecate @var{command}
33940 Deprecate or undeprecate the named @var{command}. Deprecated commands
33941 cause @value{GDBN} to issue a warning when you use them. The optional
33942 argument @var{replacement} says which newer command should be used in
33943 favor of the deprecated one; if it is given, @value{GDBN} will mention
33944 the replacement as part of the warning.
33946 @kindex maint dump-me
33947 @item maint dump-me
33948 @cindex @code{SIGQUIT} signal, dump core of @value{GDBN}
33949 Cause a fatal signal in the debugger and force it to dump its core.
33950 This is supported only on systems which support aborting a program
33951 with the @code{SIGQUIT} signal.
33953 @kindex maint internal-error
33954 @kindex maint internal-warning
33955 @kindex maint demangler-warning
33956 @cindex demangler crashes
33957 @item maint internal-error @r{[}@var{message-text}@r{]}
33958 @itemx maint internal-warning @r{[}@var{message-text}@r{]}
33959 @itemx maint demangler-warning @r{[}@var{message-text}@r{]}
33961 Cause @value{GDBN} to call the internal function @code{internal_error},
33962 @code{internal_warning} or @code{demangler_warning} and hence behave
33963 as though an internal problem has been detected. In addition to
33964 reporting the internal problem, these functions give the user the
33965 opportunity to either quit @value{GDBN} or (for @code{internal_error}
33966 and @code{internal_warning}) create a core file of the current
33967 @value{GDBN} session.
33969 These commands take an optional parameter @var{message-text} that is
33970 used as the text of the error or warning message.
33972 Here's an example of using @code{internal-error}:
33975 (@value{GDBP}) @kbd{maint internal-error testing, 1, 2}
33976 @dots{}/maint.c:121: internal-error: testing, 1, 2
33977 A problem internal to GDB has been detected. Further
33978 debugging may prove unreliable.
33979 Quit this debugging session? (y or n) @kbd{n}
33980 Create a core file? (y or n) @kbd{n}
33984 @cindex @value{GDBN} internal error
33985 @cindex internal errors, control of @value{GDBN} behavior
33986 @cindex demangler crashes
33988 @kindex maint set internal-error
33989 @kindex maint show internal-error
33990 @kindex maint set internal-warning
33991 @kindex maint show internal-warning
33992 @kindex maint set demangler-warning
33993 @kindex maint show demangler-warning
33994 @item maint set internal-error @var{action} [ask|yes|no]
33995 @itemx maint show internal-error @var{action}
33996 @itemx maint set internal-warning @var{action} [ask|yes|no]
33997 @itemx maint show internal-warning @var{action}
33998 @itemx maint set demangler-warning @var{action} [ask|yes|no]
33999 @itemx maint show demangler-warning @var{action}
34000 When @value{GDBN} reports an internal problem (error or warning) it
34001 gives the user the opportunity to both quit @value{GDBN} and create a
34002 core file of the current @value{GDBN} session. These commands let you
34003 override the default behaviour for each particular @var{action},
34004 described in the table below.
34008 You can specify that @value{GDBN} should always (yes) or never (no)
34009 quit. The default is to ask the user what to do.
34012 You can specify that @value{GDBN} should always (yes) or never (no)
34013 create a core file. The default is to ask the user what to do. Note
34014 that there is no @code{corefile} option for @code{demangler-warning}:
34015 demangler warnings always create a core file and this cannot be
34019 @kindex maint packet
34020 @item maint packet @var{text}
34021 If @value{GDBN} is talking to an inferior via the serial protocol,
34022 then this command sends the string @var{text} to the inferior, and
34023 displays the response packet. @value{GDBN} supplies the initial
34024 @samp{$} character, the terminating @samp{#} character, and the
34027 @kindex maint print architecture
34028 @item maint print architecture @r{[}@var{file}@r{]}
34029 Print the entire architecture configuration. The optional argument
34030 @var{file} names the file where the output goes.
34032 @kindex maint print c-tdesc
34033 @item maint print c-tdesc
34034 Print the current target description (@pxref{Target Descriptions}) as
34035 a C source file. The created source file can be used in @value{GDBN}
34036 when an XML parser is not available to parse the description.
34038 @kindex maint print dummy-frames
34039 @item maint print dummy-frames
34040 Prints the contents of @value{GDBN}'s internal dummy-frame stack.
34043 (@value{GDBP}) @kbd{b add}
34045 (@value{GDBP}) @kbd{print add(2,3)}
34046 Breakpoint 2, add (a=2, b=3) at @dots{}
34048 The program being debugged stopped while in a function called from GDB.
34050 (@value{GDBP}) @kbd{maint print dummy-frames}
34051 0xa8206d8: id=@{stack=0xbfffe734,code=0xbfffe73f,!special@}, ptid=process 9353
34055 Takes an optional file parameter.
34057 @kindex maint print registers
34058 @kindex maint print raw-registers
34059 @kindex maint print cooked-registers
34060 @kindex maint print register-groups
34061 @kindex maint print remote-registers
34062 @item maint print registers @r{[}@var{file}@r{]}
34063 @itemx maint print raw-registers @r{[}@var{file}@r{]}
34064 @itemx maint print cooked-registers @r{[}@var{file}@r{]}
34065 @itemx maint print register-groups @r{[}@var{file}@r{]}
34066 @itemx maint print remote-registers @r{[}@var{file}@r{]}
34067 Print @value{GDBN}'s internal register data structures.
34069 The command @code{maint print raw-registers} includes the contents of
34070 the raw register cache; the command @code{maint print
34071 cooked-registers} includes the (cooked) value of all registers,
34072 including registers which aren't available on the target nor visible
34073 to user; the command @code{maint print register-groups} includes the
34074 groups that each register is a member of; and the command @code{maint
34075 print remote-registers} includes the remote target's register numbers
34076 and offsets in the `G' packets.
34078 These commands take an optional parameter, a file name to which to
34079 write the information.
34081 @kindex maint print reggroups
34082 @item maint print reggroups @r{[}@var{file}@r{]}
34083 Print @value{GDBN}'s internal register group data structures. The
34084 optional argument @var{file} tells to what file to write the
34087 The register groups info looks like this:
34090 (@value{GDBP}) @kbd{maint print reggroups}
34103 This command forces @value{GDBN} to flush its internal register cache.
34105 @kindex maint print objfiles
34106 @cindex info for known object files
34107 @item maint print objfiles @r{[}@var{regexp}@r{]}
34108 Print a dump of all known object files.
34109 If @var{regexp} is specified, only print object files whose names
34110 match @var{regexp}. For each object file, this command prints its name,
34111 address in memory, and all of its psymtabs and symtabs.
34113 @kindex maint print user-registers
34114 @cindex user registers
34115 @item maint print user-registers
34116 List all currently available @dfn{user registers}. User registers
34117 typically provide alternate names for actual hardware registers. They
34118 include the four ``standard'' registers @code{$fp}, @code{$pc},
34119 @code{$sp}, and @code{$ps}. @xref{standard registers}. User
34120 registers can be used in expressions in the same way as the canonical
34121 register names, but only the latter are listed by the @code{info
34122 registers} and @code{maint print registers} commands.
34124 @kindex maint print section-scripts
34125 @cindex info for known .debug_gdb_scripts-loaded scripts
34126 @item maint print section-scripts [@var{regexp}]
34127 Print a dump of scripts specified in the @code{.debug_gdb_section} section.
34128 If @var{regexp} is specified, only print scripts loaded by object files
34129 matching @var{regexp}.
34130 For each script, this command prints its name as specified in the objfile,
34131 and the full path if known.
34132 @xref{dotdebug_gdb_scripts section}.
34134 @kindex maint print statistics
34135 @cindex bcache statistics
34136 @item maint print statistics
34137 This command prints, for each object file in the program, various data
34138 about that object file followed by the byte cache (@dfn{bcache})
34139 statistics for the object file. The objfile data includes the number
34140 of minimal, partial, full, and stabs symbols, the number of types
34141 defined by the objfile, the number of as yet unexpanded psym tables,
34142 the number of line tables and string tables, and the amount of memory
34143 used by the various tables. The bcache statistics include the counts,
34144 sizes, and counts of duplicates of all and unique objects, max,
34145 average, and median entry size, total memory used and its overhead and
34146 savings, and various measures of the hash table size and chain
34149 @kindex maint print target-stack
34150 @cindex target stack description
34151 @item maint print target-stack
34152 A @dfn{target} is an interface between the debugger and a particular
34153 kind of file or process. Targets can be stacked in @dfn{strata},
34154 so that more than one target can potentially respond to a request.
34155 In particular, memory accesses will walk down the stack of targets
34156 until they find a target that is interested in handling that particular
34159 This command prints a short description of each layer that was pushed on
34160 the @dfn{target stack}, starting from the top layer down to the bottom one.
34162 @kindex maint print type
34163 @cindex type chain of a data type
34164 @item maint print type @var{expr}
34165 Print the type chain for a type specified by @var{expr}. The argument
34166 can be either a type name or a symbol. If it is a symbol, the type of
34167 that symbol is described. The type chain produced by this command is
34168 a recursive definition of the data type as stored in @value{GDBN}'s
34169 data structures, including its flags and contained types.
34171 @kindex maint set dwarf always-disassemble
34172 @kindex maint show dwarf always-disassemble
34173 @item maint set dwarf always-disassemble
34174 @item maint show dwarf always-disassemble
34175 Control the behavior of @code{info address} when using DWARF debugging
34178 The default is @code{off}, which means that @value{GDBN} should try to
34179 describe a variable's location in an easily readable format. When
34180 @code{on}, @value{GDBN} will instead display the DWARF location
34181 expression in an assembly-like format. Note that some locations are
34182 too complex for @value{GDBN} to describe simply; in this case you will
34183 always see the disassembly form.
34185 Here is an example of the resulting disassembly:
34188 (gdb) info addr argc
34189 Symbol "argc" is a complex DWARF expression:
34193 For more information on these expressions, see
34194 @uref{http://www.dwarfstd.org/, the DWARF standard}.
34196 @kindex maint set dwarf max-cache-age
34197 @kindex maint show dwarf max-cache-age
34198 @item maint set dwarf max-cache-age
34199 @itemx maint show dwarf max-cache-age
34200 Control the DWARF compilation unit cache.
34202 @cindex DWARF compilation units cache
34203 In object files with inter-compilation-unit references, such as those
34204 produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF
34205 reader needs to frequently refer to previously read compilation units.
34206 This setting controls how long a compilation unit will remain in the
34207 cache if it is not referenced. A higher limit means that cached
34208 compilation units will be stored in memory longer, and more total
34209 memory will be used. Setting it to zero disables caching, which will
34210 slow down @value{GDBN} startup, but reduce memory consumption.
34212 @kindex maint set profile
34213 @kindex maint show profile
34214 @cindex profiling GDB
34215 @item maint set profile
34216 @itemx maint show profile
34217 Control profiling of @value{GDBN}.
34219 Profiling will be disabled until you use the @samp{maint set profile}
34220 command to enable it. When you enable profiling, the system will begin
34221 collecting timing and execution count data; when you disable profiling or
34222 exit @value{GDBN}, the results will be written to a log file. Remember that
34223 if you use profiling, @value{GDBN} will overwrite the profiling log file
34224 (often called @file{gmon.out}). If you have a record of important profiling
34225 data in a @file{gmon.out} file, be sure to move it to a safe location.
34227 Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
34228 compiled with the @samp{-pg} compiler option.
34230 @kindex maint set show-debug-regs
34231 @kindex maint show show-debug-regs
34232 @cindex hardware debug registers
34233 @item maint set show-debug-regs
34234 @itemx maint show show-debug-regs
34235 Control whether to show variables that mirror the hardware debug
34236 registers. Use @code{on} to enable, @code{off} to disable. If
34237 enabled, the debug registers values are shown when @value{GDBN} inserts or
34238 removes a hardware breakpoint or watchpoint, and when the inferior
34239 triggers a hardware-assisted breakpoint or watchpoint.
34241 @kindex maint set show-all-tib
34242 @kindex maint show show-all-tib
34243 @item maint set show-all-tib
34244 @itemx maint show show-all-tib
34245 Control whether to show all non zero areas within a 1k block starting
34246 at thread local base, when using the @samp{info w32 thread-information-block}
34249 @kindex maint set target-async
34250 @kindex maint show target-async
34251 @item maint set target-async
34252 @itemx maint show target-async
34253 This controls whether @value{GDBN} targets operate in synchronous or
34254 asynchronous mode (@pxref{Background Execution}). Normally the
34255 default is asynchronous, if it is available; but this can be changed
34256 to more easily debug problems occurring only in synchronous mode.
34258 @kindex maint set target-non-stop @var{mode} [on|off|auto]
34259 @kindex maint show target-non-stop
34260 @item maint set target-non-stop
34261 @itemx maint show target-non-stop
34263 This controls whether @value{GDBN} targets always operate in non-stop
34264 mode even if @code{set non-stop} is @code{off} (@pxref{Non-Stop
34265 Mode}). The default is @code{auto}, meaning non-stop mode is enabled
34266 if supported by the target.
34269 @item maint set target-non-stop auto
34270 This is the default mode. @value{GDBN} controls the target in
34271 non-stop mode if the target supports it.
34273 @item maint set target-non-stop on
34274 @value{GDBN} controls the target in non-stop mode even if the target
34275 does not indicate support.
34277 @item maint set target-non-stop off
34278 @value{GDBN} does not control the target in non-stop mode even if the
34279 target supports it.
34282 @kindex maint set per-command
34283 @kindex maint show per-command
34284 @item maint set per-command
34285 @itemx maint show per-command
34286 @cindex resources used by commands
34288 @value{GDBN} can display the resources used by each command.
34289 This is useful in debugging performance problems.
34292 @item maint set per-command space [on|off]
34293 @itemx maint show per-command space
34294 Enable or disable the printing of the memory used by GDB for each command.
34295 If enabled, @value{GDBN} will display how much memory each command
34296 took, following the command's own output.
34297 This can also be requested by invoking @value{GDBN} with the
34298 @option{--statistics} command-line switch (@pxref{Mode Options}).
34300 @item maint set per-command time [on|off]
34301 @itemx maint show per-command time
34302 Enable or disable the printing of the execution time of @value{GDBN}
34304 If enabled, @value{GDBN} will display how much time it
34305 took to execute each command, following the command's own output.
34306 Both CPU time and wallclock time are printed.
34307 Printing both is useful when trying to determine whether the cost is
34308 CPU or, e.g., disk/network latency.
34309 Note that the CPU time printed is for @value{GDBN} only, it does not include
34310 the execution time of the inferior because there's no mechanism currently
34311 to compute how much time was spent by @value{GDBN} and how much time was
34312 spent by the program been debugged.
34313 This can also be requested by invoking @value{GDBN} with the
34314 @option{--statistics} command-line switch (@pxref{Mode Options}).
34316 @item maint set per-command symtab [on|off]
34317 @itemx maint show per-command symtab
34318 Enable or disable the printing of basic symbol table statistics
34320 If enabled, @value{GDBN} will display the following information:
34324 number of symbol tables
34326 number of primary symbol tables
34328 number of blocks in the blockvector
34332 @kindex maint space
34333 @cindex memory used by commands
34334 @item maint space @var{value}
34335 An alias for @code{maint set per-command space}.
34336 A non-zero value enables it, zero disables it.
34339 @cindex time of command execution
34340 @item maint time @var{value}
34341 An alias for @code{maint set per-command time}.
34342 A non-zero value enables it, zero disables it.
34344 @kindex maint translate-address
34345 @item maint translate-address @r{[}@var{section}@r{]} @var{addr}
34346 Find the symbol stored at the location specified by the address
34347 @var{addr} and an optional section name @var{section}. If found,
34348 @value{GDBN} prints the name of the closest symbol and an offset from
34349 the symbol's location to the specified address. This is similar to
34350 the @code{info address} command (@pxref{Symbols}), except that this
34351 command also allows to find symbols in other sections.
34353 If section was not specified, the section in which the symbol was found
34354 is also printed. For dynamically linked executables, the name of
34355 executable or shared library containing the symbol is printed as well.
34359 The following command is useful for non-interactive invocations of
34360 @value{GDBN}, such as in the test suite.
34363 @item set watchdog @var{nsec}
34364 @kindex set watchdog
34365 @cindex watchdog timer
34366 @cindex timeout for commands
34367 Set the maximum number of seconds @value{GDBN} will wait for the
34368 target operation to finish. If this time expires, @value{GDBN}
34369 reports and error and the command is aborted.
34371 @item show watchdog
34372 Show the current setting of the target wait timeout.
34375 @node Remote Protocol
34376 @appendix @value{GDBN} Remote Serial Protocol
34381 * Stop Reply Packets::
34382 * General Query Packets::
34383 * Architecture-Specific Protocol Details::
34384 * Tracepoint Packets::
34385 * Host I/O Packets::
34387 * Notification Packets::
34388 * Remote Non-Stop::
34389 * Packet Acknowledgment::
34391 * File-I/O Remote Protocol Extension::
34392 * Library List Format::
34393 * Library List Format for SVR4 Targets::
34394 * Memory Map Format::
34395 * Thread List Format::
34396 * Traceframe Info Format::
34397 * Branch Trace Format::
34398 * Branch Trace Configuration Format::
34404 There may be occasions when you need to know something about the
34405 protocol---for example, if there is only one serial port to your target
34406 machine, you might want your program to do something special if it
34407 recognizes a packet meant for @value{GDBN}.
34409 In the examples below, @samp{->} and @samp{<-} are used to indicate
34410 transmitted and received data, respectively.
34412 @cindex protocol, @value{GDBN} remote serial
34413 @cindex serial protocol, @value{GDBN} remote
34414 @cindex remote serial protocol
34415 All @value{GDBN} commands and responses (other than acknowledgments
34416 and notifications, see @ref{Notification Packets}) are sent as a
34417 @var{packet}. A @var{packet} is introduced with the character
34418 @samp{$}, the actual @var{packet-data}, and the terminating character
34419 @samp{#} followed by a two-digit @var{checksum}:
34422 @code{$}@var{packet-data}@code{#}@var{checksum}
34426 @cindex checksum, for @value{GDBN} remote
34428 The two-digit @var{checksum} is computed as the modulo 256 sum of all
34429 characters between the leading @samp{$} and the trailing @samp{#} (an
34430 eight bit unsigned checksum).
34432 Implementors should note that prior to @value{GDBN} 5.0 the protocol
34433 specification also included an optional two-digit @var{sequence-id}:
34436 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
34439 @cindex sequence-id, for @value{GDBN} remote
34441 That @var{sequence-id} was appended to the acknowledgment. @value{GDBN}
34442 has never output @var{sequence-id}s. Stubs that handle packets added
34443 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
34445 When either the host or the target machine receives a packet, the first
34446 response expected is an acknowledgment: either @samp{+} (to indicate
34447 the package was received correctly) or @samp{-} (to request
34451 -> @code{$}@var{packet-data}@code{#}@var{checksum}
34456 The @samp{+}/@samp{-} acknowledgments can be disabled
34457 once a connection is established.
34458 @xref{Packet Acknowledgment}, for details.
34460 The host (@value{GDBN}) sends @var{command}s, and the target (the
34461 debugging stub incorporated in your program) sends a @var{response}. In
34462 the case of step and continue @var{command}s, the response is only sent
34463 when the operation has completed, and the target has again stopped all
34464 threads in all attached processes. This is the default all-stop mode
34465 behavior, but the remote protocol also supports @value{GDBN}'s non-stop
34466 execution mode; see @ref{Remote Non-Stop}, for details.
34468 @var{packet-data} consists of a sequence of characters with the
34469 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
34472 @cindex remote protocol, field separator
34473 Fields within the packet should be separated using @samp{,} @samp{;} or
34474 @samp{:}. Except where otherwise noted all numbers are represented in
34475 @sc{hex} with leading zeros suppressed.
34477 Implementors should note that prior to @value{GDBN} 5.0, the character
34478 @samp{:} could not appear as the third character in a packet (as it
34479 would potentially conflict with the @var{sequence-id}).
34481 @cindex remote protocol, binary data
34482 @anchor{Binary Data}
34483 Binary data in most packets is encoded either as two hexadecimal
34484 digits per byte of binary data. This allowed the traditional remote
34485 protocol to work over connections which were only seven-bit clean.
34486 Some packets designed more recently assume an eight-bit clean
34487 connection, and use a more efficient encoding to send and receive
34490 The binary data representation uses @code{7d} (@sc{ascii} @samp{@}})
34491 as an escape character. Any escaped byte is transmitted as the escape
34492 character followed by the original character XORed with @code{0x20}.
34493 For example, the byte @code{0x7d} would be transmitted as the two
34494 bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}),
34495 @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii}
34496 @samp{@}}) must always be escaped. Responses sent by the stub
34497 must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it
34498 is not interpreted as the start of a run-length encoded sequence
34501 Response @var{data} can be run-length encoded to save space.
34502 Run-length encoding replaces runs of identical characters with one
34503 instance of the repeated character, followed by a @samp{*} and a
34504 repeat count. The repeat count is itself sent encoded, to avoid
34505 binary characters in @var{data}: a value of @var{n} is sent as
34506 @code{@var{n}+29}. For a repeat count greater or equal to 3, this
34507 produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii}
34508 code 32) for a repeat count of 3. (This is because run-length
34509 encoding starts to win for counts 3 or more.) Thus, for example,
34510 @samp{0* } is a run-length encoding of ``0000'': the space character
34511 after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 =
34514 The printable characters @samp{#} and @samp{$} or with a numeric value
34515 greater than 126 must not be used. Runs of six repeats (@samp{#}) or
34516 seven repeats (@samp{$}) can be expanded using a repeat count of only
34517 five (@samp{"}). For example, @samp{00000000} can be encoded as
34520 The error response returned for some packets includes a two character
34521 error number. That number is not well defined.
34523 @cindex empty response, for unsupported packets
34524 For any @var{command} not supported by the stub, an empty response
34525 (@samp{$#00}) should be returned. That way it is possible to extend the
34526 protocol. A newer @value{GDBN} can tell if a packet is supported based
34529 At a minimum, a stub is required to support the @samp{g} and @samp{G}
34530 commands for register access, and the @samp{m} and @samp{M} commands
34531 for memory access. Stubs that only control single-threaded targets
34532 can implement run control with the @samp{c} (continue), and @samp{s}
34533 (step) commands. Stubs that support multi-threading targets should
34534 support the @samp{vCont} command. All other commands are optional.
34539 The following table provides a complete list of all currently defined
34540 @var{command}s and their corresponding response @var{data}.
34541 @xref{File-I/O Remote Protocol Extension}, for details about the File
34542 I/O extension of the remote protocol.
34544 Each packet's description has a template showing the packet's overall
34545 syntax, followed by an explanation of the packet's meaning. We
34546 include spaces in some of the templates for clarity; these are not
34547 part of the packet's syntax. No @value{GDBN} packet uses spaces to
34548 separate its components. For example, a template like @samp{foo
34549 @var{bar} @var{baz}} describes a packet beginning with the three ASCII
34550 bytes @samp{foo}, followed by a @var{bar}, followed directly by a
34551 @var{baz}. @value{GDBN} does not transmit a space character between the
34552 @samp{foo} and the @var{bar}, or between the @var{bar} and the
34555 @cindex @var{thread-id}, in remote protocol
34556 @anchor{thread-id syntax}
34557 Several packets and replies include a @var{thread-id} field to identify
34558 a thread. Normally these are positive numbers with a target-specific
34559 interpretation, formatted as big-endian hex strings. A @var{thread-id}
34560 can also be a literal @samp{-1} to indicate all threads, or @samp{0} to
34563 In addition, the remote protocol supports a multiprocess feature in
34564 which the @var{thread-id} syntax is extended to optionally include both
34565 process and thread ID fields, as @samp{p@var{pid}.@var{tid}}.
34566 The @var{pid} (process) and @var{tid} (thread) components each have the
34567 format described above: a positive number with target-specific
34568 interpretation formatted as a big-endian hex string, literal @samp{-1}
34569 to indicate all processes or threads (respectively), or @samp{0} to
34570 indicate an arbitrary process or thread. Specifying just a process, as
34571 @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an
34572 error to specify all processes but a specific thread, such as
34573 @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used
34574 for those packets and replies explicitly documented to include a process
34575 ID, rather than a @var{thread-id}.
34577 The multiprocess @var{thread-id} syntax extensions are only used if both
34578 @value{GDBN} and the stub report support for the @samp{multiprocess}
34579 feature using @samp{qSupported}. @xref{multiprocess extensions}, for
34582 Note that all packet forms beginning with an upper- or lower-case
34583 letter, other than those described here, are reserved for future use.
34585 Here are the packet descriptions.
34590 @cindex @samp{!} packet
34591 @anchor{extended mode}
34592 Enable extended mode. In extended mode, the remote server is made
34593 persistent. The @samp{R} packet is used to restart the program being
34599 The remote target both supports and has enabled extended mode.
34603 @cindex @samp{?} packet
34605 Indicate the reason the target halted. The reply is the same as for
34606 step and continue. This packet has a special interpretation when the
34607 target is in non-stop mode; see @ref{Remote Non-Stop}.
34610 @xref{Stop Reply Packets}, for the reply specifications.
34612 @item A @var{arglen},@var{argnum},@var{arg},@dots{}
34613 @cindex @samp{A} packet
34614 Initialized @code{argv[]} array passed into program. @var{arglen}
34615 specifies the number of bytes in the hex encoded byte stream
34616 @var{arg}. See @code{gdbserver} for more details.
34621 The arguments were set.
34627 @cindex @samp{b} packet
34628 (Don't use this packet; its behavior is not well-defined.)
34629 Change the serial line speed to @var{baud}.
34631 JTC: @emph{When does the transport layer state change? When it's
34632 received, or after the ACK is transmitted. In either case, there are
34633 problems if the command or the acknowledgment packet is dropped.}
34635 Stan: @emph{If people really wanted to add something like this, and get
34636 it working for the first time, they ought to modify ser-unix.c to send
34637 some kind of out-of-band message to a specially-setup stub and have the
34638 switch happen "in between" packets, so that from remote protocol's point
34639 of view, nothing actually happened.}
34641 @item B @var{addr},@var{mode}
34642 @cindex @samp{B} packet
34643 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
34644 breakpoint at @var{addr}.
34646 Don't use this packet. Use the @samp{Z} and @samp{z} packets instead
34647 (@pxref{insert breakpoint or watchpoint packet}).
34649 @cindex @samp{bc} packet
34652 Backward continue. Execute the target system in reverse. No parameter.
34653 @xref{Reverse Execution}, for more information.
34656 @xref{Stop Reply Packets}, for the reply specifications.
34658 @cindex @samp{bs} packet
34661 Backward single step. Execute one instruction in reverse. No parameter.
34662 @xref{Reverse Execution}, for more information.
34665 @xref{Stop Reply Packets}, for the reply specifications.
34667 @item c @r{[}@var{addr}@r{]}
34668 @cindex @samp{c} packet
34669 Continue at @var{addr}, which is the address to resume. If @var{addr}
34670 is omitted, resume at current address.
34672 This packet is deprecated for multi-threading support. @xref{vCont
34676 @xref{Stop Reply Packets}, for the reply specifications.
34678 @item C @var{sig}@r{[};@var{addr}@r{]}
34679 @cindex @samp{C} packet
34680 Continue with signal @var{sig} (hex signal number). If
34681 @samp{;@var{addr}} is omitted, resume at same address.
34683 This packet is deprecated for multi-threading support. @xref{vCont
34687 @xref{Stop Reply Packets}, for the reply specifications.
34690 @cindex @samp{d} packet
34693 Don't use this packet; instead, define a general set packet
34694 (@pxref{General Query Packets}).
34698 @cindex @samp{D} packet
34699 The first form of the packet is used to detach @value{GDBN} from the
34700 remote system. It is sent to the remote target
34701 before @value{GDBN} disconnects via the @code{detach} command.
34703 The second form, including a process ID, is used when multiprocess
34704 protocol extensions are enabled (@pxref{multiprocess extensions}), to
34705 detach only a specific process. The @var{pid} is specified as a
34706 big-endian hex string.
34716 @item F @var{RC},@var{EE},@var{CF};@var{XX}
34717 @cindex @samp{F} packet
34718 A reply from @value{GDBN} to an @samp{F} packet sent by the target.
34719 This is part of the File-I/O protocol extension. @xref{File-I/O
34720 Remote Protocol Extension}, for the specification.
34723 @anchor{read registers packet}
34724 @cindex @samp{g} packet
34725 Read general registers.
34729 @item @var{XX@dots{}}
34730 Each byte of register data is described by two hex digits. The bytes
34731 with the register are transmitted in target byte order. The size of
34732 each register and their position within the @samp{g} packet are
34733 determined by the @value{GDBN} internal gdbarch functions
34734 @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The
34735 specification of several standard @samp{g} packets is specified below.
34737 When reading registers from a trace frame (@pxref{Analyze Collected
34738 Data,,Using the Collected Data}), the stub may also return a string of
34739 literal @samp{x}'s in place of the register data digits, to indicate
34740 that the corresponding register has not been collected, thus its value
34741 is unavailable. For example, for an architecture with 4 registers of
34742 4 bytes each, the following reply indicates to @value{GDBN} that
34743 registers 0 and 2 have not been collected, while registers 1 and 3
34744 have been collected, and both have zero value:
34748 <- @code{xxxxxxxx00000000xxxxxxxx00000000}
34755 @item G @var{XX@dots{}}
34756 @cindex @samp{G} packet
34757 Write general registers. @xref{read registers packet}, for a
34758 description of the @var{XX@dots{}} data.
34768 @item H @var{op} @var{thread-id}
34769 @cindex @samp{H} packet
34770 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
34771 @samp{G}, et.al.). Depending on the operation to be performed, @var{op}
34772 should be @samp{c} for step and continue operations (note that this
34773 is deprecated, supporting the @samp{vCont} command is a better
34774 option), and @samp{g} for other operations. The thread designator
34775 @var{thread-id} has the format and interpretation described in
34776 @ref{thread-id syntax}.
34787 @c 'H': How restrictive (or permissive) is the thread model. If a
34788 @c thread is selected and stopped, are other threads allowed
34789 @c to continue to execute? As I mentioned above, I think the
34790 @c semantics of each command when a thread is selected must be
34791 @c described. For example:
34793 @c 'g': If the stub supports threads and a specific thread is
34794 @c selected, returns the register block from that thread;
34795 @c otherwise returns current registers.
34797 @c 'G' If the stub supports threads and a specific thread is
34798 @c selected, sets the registers of the register block of
34799 @c that thread; otherwise sets current registers.
34801 @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]}
34802 @anchor{cycle step packet}
34803 @cindex @samp{i} packet
34804 Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is
34805 present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle
34806 step starting at that address.
34809 @cindex @samp{I} packet
34810 Signal, then cycle step. @xref{step with signal packet}. @xref{cycle
34814 @cindex @samp{k} packet
34817 The exact effect of this packet is not specified.
34819 For a bare-metal target, it may power cycle or reset the target
34820 system. For that reason, the @samp{k} packet has no reply.
34822 For a single-process target, it may kill that process if possible.
34824 A multiple-process target may choose to kill just one process, or all
34825 that are under @value{GDBN}'s control. For more precise control, use
34826 the vKill packet (@pxref{vKill packet}).
34828 If the target system immediately closes the connection in response to
34829 @samp{k}, @value{GDBN} does not consider the lack of packet
34830 acknowledgment to be an error, and assumes the kill was successful.
34832 If connected using @kbd{target extended-remote}, and the target does
34833 not close the connection in response to a kill request, @value{GDBN}
34834 probes the target state as if a new connection was opened
34835 (@pxref{? packet}).
34837 @item m @var{addr},@var{length}
34838 @cindex @samp{m} packet
34839 Read @var{length} addressable memory units starting at address @var{addr}
34840 (@pxref{addressable memory unit}). Note that @var{addr} may not be aligned to
34841 any particular boundary.
34843 The stub need not use any particular size or alignment when gathering
34844 data from memory for the response; even if @var{addr} is word-aligned
34845 and @var{length} is a multiple of the word size, the stub is free to
34846 use byte accesses, or not. For this reason, this packet may not be
34847 suitable for accessing memory-mapped I/O devices.
34848 @cindex alignment of remote memory accesses
34849 @cindex size of remote memory accesses
34850 @cindex memory, alignment and size of remote accesses
34854 @item @var{XX@dots{}}
34855 Memory contents; each byte is transmitted as a two-digit hexadecimal number.
34856 The reply may contain fewer addressable memory units than requested if the
34857 server was able to read only part of the region of memory.
34862 @item M @var{addr},@var{length}:@var{XX@dots{}}
34863 @cindex @samp{M} packet
34864 Write @var{length} addressable memory units starting at address @var{addr}
34865 (@pxref{addressable memory unit}). The data is given by @var{XX@dots{}}; each
34866 byte is transmitted as a two-digit hexadecimal number.
34873 for an error (this includes the case where only part of the data was
34878 @cindex @samp{p} packet
34879 Read the value of register @var{n}; @var{n} is in hex.
34880 @xref{read registers packet}, for a description of how the returned
34881 register value is encoded.
34885 @item @var{XX@dots{}}
34886 the register's value
34890 Indicating an unrecognized @var{query}.
34893 @item P @var{n@dots{}}=@var{r@dots{}}
34894 @anchor{write register packet}
34895 @cindex @samp{P} packet
34896 Write register @var{n@dots{}} with value @var{r@dots{}}. The register
34897 number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex
34898 digits for each byte in the register (target byte order).
34908 @item q @var{name} @var{params}@dots{}
34909 @itemx Q @var{name} @var{params}@dots{}
34910 @cindex @samp{q} packet
34911 @cindex @samp{Q} packet
34912 General query (@samp{q}) and set (@samp{Q}). These packets are
34913 described fully in @ref{General Query Packets}.
34916 @cindex @samp{r} packet
34917 Reset the entire system.
34919 Don't use this packet; use the @samp{R} packet instead.
34922 @cindex @samp{R} packet
34923 Restart the program being debugged. The @var{XX}, while needed, is ignored.
34924 This packet is only available in extended mode (@pxref{extended mode}).
34926 The @samp{R} packet has no reply.
34928 @item s @r{[}@var{addr}@r{]}
34929 @cindex @samp{s} packet
34930 Single step, resuming at @var{addr}. If
34931 @var{addr} is omitted, resume at same address.
34933 This packet is deprecated for multi-threading support. @xref{vCont
34937 @xref{Stop Reply Packets}, for the reply specifications.
34939 @item S @var{sig}@r{[};@var{addr}@r{]}
34940 @anchor{step with signal packet}
34941 @cindex @samp{S} packet
34942 Step with signal. This is analogous to the @samp{C} packet, but
34943 requests a single-step, rather than a normal resumption of execution.
34945 This packet is deprecated for multi-threading support. @xref{vCont
34949 @xref{Stop Reply Packets}, for the reply specifications.
34951 @item t @var{addr}:@var{PP},@var{MM}
34952 @cindex @samp{t} packet
34953 Search backwards starting at address @var{addr} for a match with pattern
34954 @var{PP} and mask @var{MM}, both of which are are 4 byte long.
34955 There must be at least 3 digits in @var{addr}.
34957 @item T @var{thread-id}
34958 @cindex @samp{T} packet
34959 Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}.
34964 thread is still alive
34970 Packets starting with @samp{v} are identified by a multi-letter name,
34971 up to the first @samp{;} or @samp{?} (or the end of the packet).
34973 @item vAttach;@var{pid}
34974 @cindex @samp{vAttach} packet
34975 Attach to a new process with the specified process ID @var{pid}.
34976 The process ID is a
34977 hexadecimal integer identifying the process. In all-stop mode, all
34978 threads in the attached process are stopped; in non-stop mode, it may be
34979 attached without being stopped if that is supported by the target.
34981 @c In non-stop mode, on a successful vAttach, the stub should set the
34982 @c current thread to a thread of the newly-attached process. After
34983 @c attaching, GDB queries for the attached process's thread ID with qC.
34984 @c Also note that, from a user perspective, whether or not the
34985 @c target is stopped on attach in non-stop mode depends on whether you
34986 @c use the foreground or background version of the attach command, not
34987 @c on what vAttach does; GDB does the right thing with respect to either
34988 @c stopping or restarting threads.
34990 This packet is only available in extended mode (@pxref{extended mode}).
34996 @item @r{Any stop packet}
34997 for success in all-stop mode (@pxref{Stop Reply Packets})
34999 for success in non-stop mode (@pxref{Remote Non-Stop})
35002 @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{}
35003 @cindex @samp{vCont} packet
35004 @anchor{vCont packet}
35005 Resume the inferior, specifying different actions for each thread.
35006 If an action is specified with no @var{thread-id}, then it is applied to any
35007 threads that don't have a specific action specified; if no default action is
35008 specified then other threads should remain stopped in all-stop mode and
35009 in their current state in non-stop mode.
35010 Specifying multiple
35011 default actions is an error; specifying no actions is also an error.
35012 Thread IDs are specified using the syntax described in @ref{thread-id syntax}.
35014 Currently supported actions are:
35020 Continue with signal @var{sig}. The signal @var{sig} should be two hex digits.
35024 Step with signal @var{sig}. The signal @var{sig} should be two hex digits.
35027 @item r @var{start},@var{end}
35028 Step once, and then keep stepping as long as the thread stops at
35029 addresses between @var{start} (inclusive) and @var{end} (exclusive).
35030 The remote stub reports a stop reply when either the thread goes out
35031 of the range or is stopped due to an unrelated reason, such as hitting
35032 a breakpoint. @xref{range stepping}.
35034 If the range is empty (@var{start} == @var{end}), then the action
35035 becomes equivalent to the @samp{s} action. In other words,
35036 single-step once, and report the stop (even if the stepped instruction
35037 jumps to @var{start}).
35039 (A stop reply may be sent at any point even if the PC is still within
35040 the stepping range; for example, it is valid to implement this packet
35041 in a degenerate way as a single instruction step operation.)
35045 The optional argument @var{addr} normally associated with the
35046 @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is
35047 not supported in @samp{vCont}.
35049 The @samp{t} action is only relevant in non-stop mode
35050 (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise.
35051 A stop reply should be generated for any affected thread not already stopped.
35052 When a thread is stopped by means of a @samp{t} action,
35053 the corresponding stop reply should indicate that the thread has stopped with
35054 signal @samp{0}, regardless of whether the target uses some other signal
35055 as an implementation detail.
35057 The stub must support @samp{vCont} if it reports support for
35058 multiprocess extensions (@pxref{multiprocess extensions}). Note that in
35059 this case @samp{vCont} actions can be specified to apply to all threads
35060 in a process by using the @samp{p@var{pid}.-1} form of the
35064 @xref{Stop Reply Packets}, for the reply specifications.
35067 @cindex @samp{vCont?} packet
35068 Request a list of actions supported by the @samp{vCont} packet.
35072 @item vCont@r{[};@var{action}@dots{}@r{]}
35073 The @samp{vCont} packet is supported. Each @var{action} is a supported
35074 command in the @samp{vCont} packet.
35076 The @samp{vCont} packet is not supported.
35079 @item vFile:@var{operation}:@var{parameter}@dots{}
35080 @cindex @samp{vFile} packet
35081 Perform a file operation on the target system. For details,
35082 see @ref{Host I/O Packets}.
35084 @item vFlashErase:@var{addr},@var{length}
35085 @cindex @samp{vFlashErase} packet
35086 Direct the stub to erase @var{length} bytes of flash starting at
35087 @var{addr}. The region may enclose any number of flash blocks, but
35088 its start and end must fall on block boundaries, as indicated by the
35089 flash block size appearing in the memory map (@pxref{Memory Map
35090 Format}). @value{GDBN} groups flash memory programming operations
35091 together, and sends a @samp{vFlashDone} request after each group; the
35092 stub is allowed to delay erase operation until the @samp{vFlashDone}
35093 packet is received.
35103 @item vFlashWrite:@var{addr}:@var{XX@dots{}}
35104 @cindex @samp{vFlashWrite} packet
35105 Direct the stub to write data to flash address @var{addr}. The data
35106 is passed in binary form using the same encoding as for the @samp{X}
35107 packet (@pxref{Binary Data}). The memory ranges specified by
35108 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
35109 not overlap, and must appear in order of increasing addresses
35110 (although @samp{vFlashErase} packets for higher addresses may already
35111 have been received; the ordering is guaranteed only between
35112 @samp{vFlashWrite} packets). If a packet writes to an address that was
35113 neither erased by a preceding @samp{vFlashErase} packet nor by some other
35114 target-specific method, the results are unpredictable.
35122 for vFlashWrite addressing non-flash memory
35128 @cindex @samp{vFlashDone} packet
35129 Indicate to the stub that flash programming operation is finished.
35130 The stub is permitted to delay or batch the effects of a group of
35131 @samp{vFlashErase} and @samp{vFlashWrite} packets until a
35132 @samp{vFlashDone} packet is received. The contents of the affected
35133 regions of flash memory are unpredictable until the @samp{vFlashDone}
35134 request is completed.
35136 @item vKill;@var{pid}
35137 @cindex @samp{vKill} packet
35138 @anchor{vKill packet}
35139 Kill the process with the specified process ID @var{pid}, which is a
35140 hexadecimal integer identifying the process. This packet is used in
35141 preference to @samp{k} when multiprocess protocol extensions are
35142 supported; see @ref{multiprocess extensions}.
35152 @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{}
35153 @cindex @samp{vRun} packet
35154 Run the program @var{filename}, passing it each @var{argument} on its
35155 command line. The file and arguments are hex-encoded strings. If
35156 @var{filename} is an empty string, the stub may use a default program
35157 (e.g.@: the last program run). The program is created in the stopped
35160 @c FIXME: What about non-stop mode?
35162 This packet is only available in extended mode (@pxref{extended mode}).
35168 @item @r{Any stop packet}
35169 for success (@pxref{Stop Reply Packets})
35173 @cindex @samp{vStopped} packet
35174 @xref{Notification Packets}.
35176 @item X @var{addr},@var{length}:@var{XX@dots{}}
35178 @cindex @samp{X} packet
35179 Write data to memory, where the data is transmitted in binary.
35180 Memory is specified by its address @var{addr} and number of addressable memory
35181 units @var{length} (@pxref{addressable memory unit});
35182 @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}).
35192 @item z @var{type},@var{addr},@var{kind}
35193 @itemx Z @var{type},@var{addr},@var{kind}
35194 @anchor{insert breakpoint or watchpoint packet}
35195 @cindex @samp{z} packet
35196 @cindex @samp{Z} packets
35197 Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or
35198 watchpoint starting at address @var{address} of kind @var{kind}.
35200 Each breakpoint and watchpoint packet @var{type} is documented
35203 @emph{Implementation notes: A remote target shall return an empty string
35204 for an unrecognized breakpoint or watchpoint packet @var{type}. A
35205 remote target shall support either both or neither of a given
35206 @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To
35207 avoid potential problems with duplicate packets, the operations should
35208 be implemented in an idempotent way.}
35210 @item z0,@var{addr},@var{kind}
35211 @itemx Z0,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
35212 @cindex @samp{z0} packet
35213 @cindex @samp{Z0} packet
35214 Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address
35215 @var{addr} of type @var{kind}.
35217 A memory breakpoint is implemented by replacing the instruction at
35218 @var{addr} with a software breakpoint or trap instruction. The
35219 @var{kind} is target-specific and typically indicates the size of
35220 the breakpoint in bytes that should be inserted. E.g., the @sc{arm}
35221 and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some
35222 architectures have additional meanings for @var{kind};
35223 @var{cond_list} is an optional list of conditional expressions in bytecode
35224 form that should be evaluated on the target's side. These are the
35225 conditions that should be taken into consideration when deciding if
35226 the breakpoint trigger should be reported back to @var{GDBN}.
35228 See also the @samp{swbreak} stop reason (@pxref{swbreak stop reason})
35229 for how to best report a memory breakpoint event to @value{GDBN}.
35231 The @var{cond_list} parameter is comprised of a series of expressions,
35232 concatenated without separators. Each expression has the following form:
35236 @item X @var{len},@var{expr}
35237 @var{len} is the length of the bytecode expression and @var{expr} is the
35238 actual conditional expression in bytecode form.
35242 The optional @var{cmd_list} parameter introduces commands that may be
35243 run on the target, rather than being reported back to @value{GDBN}.
35244 The parameter starts with a numeric flag @var{persist}; if the flag is
35245 nonzero, then the breakpoint may remain active and the commands
35246 continue to be run even when @value{GDBN} disconnects from the target.
35247 Following this flag is a series of expressions concatenated with no
35248 separators. Each expression has the following form:
35252 @item X @var{len},@var{expr}
35253 @var{len} is the length of the bytecode expression and @var{expr} is the
35254 actual conditional expression in bytecode form.
35258 see @ref{Architecture-Specific Protocol Details}.
35260 @emph{Implementation note: It is possible for a target to copy or move
35261 code that contains memory breakpoints (e.g., when implementing
35262 overlays). The behavior of this packet, in the presence of such a
35263 target, is not defined.}
35275 @item z1,@var{addr},@var{kind}
35276 @itemx Z1,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}
35277 @cindex @samp{z1} packet
35278 @cindex @samp{Z1} packet
35279 Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
35280 address @var{addr}.
35282 A hardware breakpoint is implemented using a mechanism that is not
35283 dependant on being able to modify the target's memory. The @var{kind}
35284 and @var{cond_list} have the same meaning as in @samp{Z0} packets.
35286 @emph{Implementation note: A hardware breakpoint is not affected by code
35299 @item z2,@var{addr},@var{kind}
35300 @itemx Z2,@var{addr},@var{kind}
35301 @cindex @samp{z2} packet
35302 @cindex @samp{Z2} packet
35303 Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}.
35304 The number of bytes to watch is specified by @var{kind}.
35316 @item z3,@var{addr},@var{kind}
35317 @itemx Z3,@var{addr},@var{kind}
35318 @cindex @samp{z3} packet
35319 @cindex @samp{Z3} packet
35320 Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}.
35321 The number of bytes to watch is specified by @var{kind}.
35333 @item z4,@var{addr},@var{kind}
35334 @itemx Z4,@var{addr},@var{kind}
35335 @cindex @samp{z4} packet
35336 @cindex @samp{Z4} packet
35337 Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}.
35338 The number of bytes to watch is specified by @var{kind}.
35352 @node Stop Reply Packets
35353 @section Stop Reply Packets
35354 @cindex stop reply packets
35356 The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont},
35357 @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can
35358 receive any of the below as a reply. Except for @samp{?}
35359 and @samp{vStopped}, that reply is only returned
35360 when the target halts. In the below the exact meaning of @dfn{signal
35361 number} is defined by the header @file{include/gdb/signals.h} in the
35362 @value{GDBN} source code.
35364 As in the description of request packets, we include spaces in the
35365 reply templates for clarity; these are not part of the reply packet's
35366 syntax. No @value{GDBN} stop reply packet uses spaces to separate its
35372 The program received signal number @var{AA} (a two-digit hexadecimal
35373 number). This is equivalent to a @samp{T} response with no
35374 @var{n}:@var{r} pairs.
35376 @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{}
35377 @cindex @samp{T} packet reply
35378 The program received signal number @var{AA} (a two-digit hexadecimal
35379 number). This is equivalent to an @samp{S} response, except that the
35380 @samp{@var{n}:@var{r}} pairs can carry values of important registers
35381 and other information directly in the stop reply packet, reducing
35382 round-trip latency. Single-step and breakpoint traps are reported
35383 this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows:
35387 If @var{n} is a hexadecimal number, it is a register number, and the
35388 corresponding @var{r} gives that register's value. The data @var{r} is a
35389 series of bytes in target byte order, with each byte given by a
35390 two-digit hex number.
35393 If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of
35394 the stopped thread, as specified in @ref{thread-id syntax}.
35397 If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of
35398 the core on which the stop event was detected.
35401 If @var{n} is a recognized @dfn{stop reason}, it describes a more
35402 specific event that stopped the target. The currently defined stop
35403 reasons are listed below. The @var{aa} should be @samp{05}, the trap
35404 signal. At most one stop reason should be present.
35407 Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair
35408 and go on to the next; this allows us to extend the protocol in the
35412 The currently defined stop reasons are:
35418 The packet indicates a watchpoint hit, and @var{r} is the data address, in
35421 @cindex shared library events, remote reply
35423 The packet indicates that the loaded libraries have changed.
35424 @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
35425 list of loaded libraries. The @var{r} part is ignored.
35427 @cindex replay log events, remote reply
35429 The packet indicates that the target cannot continue replaying
35430 logged execution events, because it has reached the end (or the
35431 beginning when executing backward) of the log. The value of @var{r}
35432 will be either @samp{begin} or @samp{end}. @xref{Reverse Execution},
35433 for more information.
35436 @anchor{swbreak stop reason}
35437 The packet indicates a memory breakpoint instruction was executed,
35438 irrespective of whether it was @value{GDBN} that planted the
35439 breakpoint or the breakpoint is hardcoded in the program. The @var{r}
35440 part must be left empty.
35442 On some architectures, such as x86, at the architecture level, when a
35443 breakpoint instruction executes the program counter points at the
35444 breakpoint address plus an offset. On such targets, the stub is
35445 responsible for adjusting the PC to point back at the breakpoint
35448 This packet should not be sent by default; older @value{GDBN} versions
35449 did not support it. @value{GDBN} requests it, by supplying an
35450 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35451 remote stub must also supply the appropriate @samp{qSupported} feature
35452 indicating support.
35454 This packet is required for correct non-stop mode operation.
35457 The packet indicates the target stopped for a hardware breakpoint.
35458 The @var{r} part must be left empty.
35460 The same remarks about @samp{qSupported} and non-stop mode above
35463 @cindex fork events, remote reply
35465 The packet indicates that @code{fork} was called, and @var{r}
35466 is the thread ID of the new child process. Refer to
35467 @ref{thread-id syntax} for the format of the @var{thread-id}
35468 field. This packet is only applicable to targets that support
35471 This packet should not be sent by default; older @value{GDBN} versions
35472 did not support it. @value{GDBN} requests it, by supplying an
35473 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35474 remote stub must also supply the appropriate @samp{qSupported} feature
35475 indicating support.
35477 @cindex vfork events, remote reply
35479 The packet indicates that @code{vfork} was called, and @var{r}
35480 is the thread ID of the new child process. Refer to
35481 @ref{thread-id syntax} for the format of the @var{thread-id}
35482 field. This packet is only applicable to targets that support
35485 This packet should not be sent by default; older @value{GDBN} versions
35486 did not support it. @value{GDBN} requests it, by supplying an
35487 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35488 remote stub must also supply the appropriate @samp{qSupported} feature
35489 indicating support.
35491 @cindex vforkdone events, remote reply
35493 The packet indicates that a child process created by a vfork
35494 has either called @code{exec} or terminated, so that the
35495 address spaces of the parent and child process are no longer
35496 shared. The @var{r} part is ignored. This packet is only
35497 applicable to targets that support vforkdone events.
35499 This packet should not be sent by default; older @value{GDBN} versions
35500 did not support it. @value{GDBN} requests it, by supplying an
35501 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35502 remote stub must also supply the appropriate @samp{qSupported} feature
35503 indicating support.
35505 @cindex exec events, remote reply
35507 The packet indicates that @code{execve} was called, and @var{r}
35508 is the absolute pathname of the file that was executed, in hex.
35509 This packet is only applicable to targets that support exec events.
35511 This packet should not be sent by default; older @value{GDBN} versions
35512 did not support it. @value{GDBN} requests it, by supplying an
35513 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35514 remote stub must also supply the appropriate @samp{qSupported} feature
35515 indicating support.
35520 @itemx W @var{AA} ; process:@var{pid}
35521 The process exited, and @var{AA} is the exit status. This is only
35522 applicable to certain targets.
35524 The second form of the response, including the process ID of the exited
35525 process, can be used only when @value{GDBN} has reported support for
35526 multiprocess protocol extensions; see @ref{multiprocess extensions}.
35527 The @var{pid} is formatted as a big-endian hex string.
35530 @itemx X @var{AA} ; process:@var{pid}
35531 The process terminated with signal @var{AA}.
35533 The second form of the response, including the process ID of the
35534 terminated process, can be used only when @value{GDBN} has reported
35535 support for multiprocess protocol extensions; see @ref{multiprocess
35536 extensions}. The @var{pid} is formatted as a big-endian hex string.
35538 @item O @var{XX}@dots{}
35539 @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be
35540 written as the program's console output. This can happen at any time
35541 while the program is running and the debugger should continue to wait
35542 for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode.
35544 @item F @var{call-id},@var{parameter}@dots{}
35545 @var{call-id} is the identifier which says which host system call should
35546 be called. This is just the name of the function. Translation into the
35547 correct system call is only applicable as it's defined in @value{GDBN}.
35548 @xref{File-I/O Remote Protocol Extension}, for a list of implemented
35551 @samp{@var{parameter}@dots{}} is a list of parameters as defined for
35552 this very system call.
35554 The target replies with this packet when it expects @value{GDBN} to
35555 call a host system call on behalf of the target. @value{GDBN} replies
35556 with an appropriate @samp{F} packet and keeps up waiting for the next
35557 reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S}
35558 or @samp{s} action is expected to be continued. @xref{File-I/O Remote
35559 Protocol Extension}, for more details.
35563 @node General Query Packets
35564 @section General Query Packets
35565 @cindex remote query requests
35567 Packets starting with @samp{q} are @dfn{general query packets};
35568 packets starting with @samp{Q} are @dfn{general set packets}. General
35569 query and set packets are a semi-unified form for retrieving and
35570 sending information to and from the stub.
35572 The initial letter of a query or set packet is followed by a name
35573 indicating what sort of thing the packet applies to. For example,
35574 @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
35575 definitions with the stub. These packet names follow some
35580 The name must not contain commas, colons or semicolons.
35582 Most @value{GDBN} query and set packets have a leading upper case
35585 The names of custom vendor packets should use a company prefix, in
35586 lower case, followed by a period. For example, packets designed at
35587 the Acme Corporation might begin with @samp{qacme.foo} (for querying
35588 foos) or @samp{Qacme.bar} (for setting bars).
35591 The name of a query or set packet should be separated from any
35592 parameters by a @samp{:}; the parameters themselves should be
35593 separated by @samp{,} or @samp{;}. Stubs must be careful to match the
35594 full packet name, and check for a separator or the end of the packet,
35595 in case two packet names share a common prefix. New packets should not begin
35596 with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL}
35597 packets predate these conventions, and have arguments without any terminator
35598 for the packet name; we suspect they are in widespread use in places that
35599 are difficult to upgrade. The @samp{qC} packet has no arguments, but some
35600 existing stubs (e.g.@: RedBoot) are known to not check for the end of the
35603 Like the descriptions of the other packets, each description here
35604 has a template showing the packet's overall syntax, followed by an
35605 explanation of the packet's meaning. We include spaces in some of the
35606 templates for clarity; these are not part of the packet's syntax. No
35607 @value{GDBN} packet uses spaces to separate its components.
35609 Here are the currently defined query and set packets:
35615 Turn on or off the agent as a helper to perform some debugging operations
35616 delegated from @value{GDBN} (@pxref{Control Agent}).
35618 @item QAllow:@var{op}:@var{val}@dots{}
35619 @cindex @samp{QAllow} packet
35620 Specify which operations @value{GDBN} expects to request of the
35621 target, as a semicolon-separated list of operation name and value
35622 pairs. Possible values for @var{op} include @samp{WriteReg},
35623 @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace},
35624 @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0,
35625 indicating that @value{GDBN} will not request the operation, or 1,
35626 indicating that it may. (The target can then use this to set up its
35627 own internals optimally, for instance if the debugger never expects to
35628 insert breakpoints, it may not need to install its own trap handler.)
35631 @cindex current thread, remote request
35632 @cindex @samp{qC} packet
35633 Return the current thread ID.
35637 @item QC @var{thread-id}
35638 Where @var{thread-id} is a thread ID as documented in
35639 @ref{thread-id syntax}.
35640 @item @r{(anything else)}
35641 Any other reply implies the old thread ID.
35644 @item qCRC:@var{addr},@var{length}
35645 @cindex CRC of memory block, remote request
35646 @cindex @samp{qCRC} packet
35647 @anchor{qCRC packet}
35648 Compute the CRC checksum of a block of memory using CRC-32 defined in
35649 IEEE 802.3. The CRC is computed byte at a time, taking the most
35650 significant bit of each byte first. The initial pattern code
35651 @code{0xffffffff} is used to ensure leading zeros affect the CRC.
35653 @emph{Note:} This is the same CRC used in validating separate debug
35654 files (@pxref{Separate Debug Files, , Debugging Information in Separate
35655 Files}). However the algorithm is slightly different. When validating
35656 separate debug files, the CRC is computed taking the @emph{least}
35657 significant bit of each byte first, and the final result is inverted to
35658 detect trailing zeros.
35663 An error (such as memory fault)
35664 @item C @var{crc32}
35665 The specified memory region's checksum is @var{crc32}.
35668 @item QDisableRandomization:@var{value}
35669 @cindex disable address space randomization, remote request
35670 @cindex @samp{QDisableRandomization} packet
35671 Some target operating systems will randomize the virtual address space
35672 of the inferior process as a security feature, but provide a feature
35673 to disable such randomization, e.g.@: to allow for a more deterministic
35674 debugging experience. On such systems, this packet with a @var{value}
35675 of 1 directs the target to disable address space randomization for
35676 processes subsequently started via @samp{vRun} packets, while a packet
35677 with a @var{value} of 0 tells the target to enable address space
35680 This packet is only available in extended mode (@pxref{extended mode}).
35685 The request succeeded.
35688 An error occurred. The error number @var{nn} is given as hex digits.
35691 An empty reply indicates that @samp{QDisableRandomization} is not supported
35695 This packet is not probed by default; the remote stub must request it,
35696 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
35697 This should only be done on targets that actually support disabling
35698 address space randomization.
35701 @itemx qsThreadInfo
35702 @cindex list active threads, remote request
35703 @cindex @samp{qfThreadInfo} packet
35704 @cindex @samp{qsThreadInfo} packet
35705 Obtain a list of all active thread IDs from the target (OS). Since there
35706 may be too many active threads to fit into one reply packet, this query
35707 works iteratively: it may require more than one query/reply sequence to
35708 obtain the entire list of threads. The first query of the sequence will
35709 be the @samp{qfThreadInfo} query; subsequent queries in the
35710 sequence will be the @samp{qsThreadInfo} query.
35712 NOTE: This packet replaces the @samp{qL} query (see below).
35716 @item m @var{thread-id}
35718 @item m @var{thread-id},@var{thread-id}@dots{}
35719 a comma-separated list of thread IDs
35721 (lower case letter @samp{L}) denotes end of list.
35724 In response to each query, the target will reply with a list of one or
35725 more thread IDs, separated by commas.
35726 @value{GDBN} will respond to each reply with a request for more thread
35727 ids (using the @samp{qs} form of the query), until the target responds
35728 with @samp{l} (lower-case ell, for @dfn{last}).
35729 Refer to @ref{thread-id syntax}, for the format of the @var{thread-id}
35732 @emph{Note: @value{GDBN} will send the @code{qfThreadInfo} query during the
35733 initial connection with the remote target, and the very first thread ID
35734 mentioned in the reply will be stopped by @value{GDBN} in a subsequent
35735 message. Therefore, the stub should ensure that the first thread ID in
35736 the @code{qfThreadInfo} reply is suitable for being stopped by @value{GDBN}.}
35738 @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm}
35739 @cindex get thread-local storage address, remote request
35740 @cindex @samp{qGetTLSAddr} packet
35741 Fetch the address associated with thread local storage specified
35742 by @var{thread-id}, @var{offset}, and @var{lm}.
35744 @var{thread-id} is the thread ID associated with the
35745 thread for which to fetch the TLS address. @xref{thread-id syntax}.
35747 @var{offset} is the (big endian, hex encoded) offset associated with the
35748 thread local variable. (This offset is obtained from the debug
35749 information associated with the variable.)
35751 @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the
35752 load module associated with the thread local storage. For example,
35753 a @sc{gnu}/Linux system will pass the link map address of the shared
35754 object associated with the thread local storage under consideration.
35755 Other operating environments may choose to represent the load module
35756 differently, so the precise meaning of this parameter will vary.
35760 @item @var{XX}@dots{}
35761 Hex encoded (big endian) bytes representing the address of the thread
35762 local storage requested.
35765 An error occurred. The error number @var{nn} is given as hex digits.
35768 An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub.
35771 @item qGetTIBAddr:@var{thread-id}
35772 @cindex get thread information block address
35773 @cindex @samp{qGetTIBAddr} packet
35774 Fetch address of the Windows OS specific Thread Information Block.
35776 @var{thread-id} is the thread ID associated with the thread.
35780 @item @var{XX}@dots{}
35781 Hex encoded (big endian) bytes representing the linear address of the
35782 thread information block.
35785 An error occured. This means that either the thread was not found, or the
35786 address could not be retrieved.
35789 An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub.
35792 @item qL @var{startflag} @var{threadcount} @var{nextthread}
35793 Obtain thread information from RTOS. Where: @var{startflag} (one hex
35794 digit) is one to indicate the first query and zero to indicate a
35795 subsequent query; @var{threadcount} (two hex digits) is the maximum
35796 number of threads the response packet can contain; and @var{nextthread}
35797 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
35798 returned in the response as @var{argthread}.
35800 Don't use this packet; use the @samp{qfThreadInfo} query instead (see above).
35804 @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{}
35805 Where: @var{count} (two hex digits) is the number of threads being
35806 returned; @var{done} (one hex digit) is zero to indicate more threads
35807 and one indicates no further threads; @var{argthreadid} (eight hex
35808 digits) is @var{nextthread} from the request packet; @var{thread}@dots{}
35809 is a sequence of thread IDs, @var{threadid} (eight hex
35810 digits), from the target. See @code{remote.c:parse_threadlist_response()}.
35814 @cindex section offsets, remote request
35815 @cindex @samp{qOffsets} packet
35816 Get section offsets that the target used when relocating the downloaded
35821 @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]}
35822 Relocate the @code{Text} section by @var{xxx} from its original address.
35823 Relocate the @code{Data} section by @var{yyy} from its original address.
35824 If the object file format provides segment information (e.g.@: @sc{elf}
35825 @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire
35826 segments by the supplied offsets.
35828 @emph{Note: while a @code{Bss} offset may be included in the response,
35829 @value{GDBN} ignores this and instead applies the @code{Data} offset
35830 to the @code{Bss} section.}
35832 @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]}
35833 Relocate the first segment of the object file, which conventionally
35834 contains program code, to a starting address of @var{xxx}. If
35835 @samp{DataSeg} is specified, relocate the second segment, which
35836 conventionally contains modifiable data, to a starting address of
35837 @var{yyy}. @value{GDBN} will report an error if the object file
35838 does not contain segment information, or does not contain at least
35839 as many segments as mentioned in the reply. Extra segments are
35840 kept at fixed offsets relative to the last relocated segment.
35843 @item qP @var{mode} @var{thread-id}
35844 @cindex thread information, remote request
35845 @cindex @samp{qP} packet
35846 Returns information on @var{thread-id}. Where: @var{mode} is a hex
35847 encoded 32 bit mode; @var{thread-id} is a thread ID
35848 (@pxref{thread-id syntax}).
35850 Don't use this packet; use the @samp{qThreadExtraInfo} query instead
35853 Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
35857 @cindex non-stop mode, remote request
35858 @cindex @samp{QNonStop} packet
35860 Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode.
35861 @xref{Remote Non-Stop}, for more information.
35866 The request succeeded.
35869 An error occurred. The error number @var{nn} is given as hex digits.
35872 An empty reply indicates that @samp{QNonStop} is not supported by
35876 This packet is not probed by default; the remote stub must request it,
35877 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
35878 Use of this packet is controlled by the @code{set non-stop} command;
35879 @pxref{Non-Stop Mode}.
35881 @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
35882 @cindex pass signals to inferior, remote request
35883 @cindex @samp{QPassSignals} packet
35884 @anchor{QPassSignals}
35885 Each listed @var{signal} should be passed directly to the inferior process.
35886 Signals are numbered identically to continue packets and stop replies
35887 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
35888 strictly greater than the previous item. These signals do not need to stop
35889 the inferior, or be reported to @value{GDBN}. All other signals should be
35890 reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not
35891 combine; any earlier @samp{QPassSignals} list is completely replaced by the
35892 new list. This packet improves performance when using @samp{handle
35893 @var{signal} nostop noprint pass}.
35898 The request succeeded.
35901 An error occurred. The error number @var{nn} is given as hex digits.
35904 An empty reply indicates that @samp{QPassSignals} is not supported by
35908 Use of this packet is controlled by the @code{set remote pass-signals}
35909 command (@pxref{Remote Configuration, set remote pass-signals}).
35910 This packet is not probed by default; the remote stub must request it,
35911 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
35913 @item QProgramSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
35914 @cindex signals the inferior may see, remote request
35915 @cindex @samp{QProgramSignals} packet
35916 @anchor{QProgramSignals}
35917 Each listed @var{signal} may be delivered to the inferior process.
35918 Others should be silently discarded.
35920 In some cases, the remote stub may need to decide whether to deliver a
35921 signal to the program or not without @value{GDBN} involvement. One
35922 example of that is while detaching --- the program's threads may have
35923 stopped for signals that haven't yet had a chance of being reported to
35924 @value{GDBN}, and so the remote stub can use the signal list specified
35925 by this packet to know whether to deliver or ignore those pending
35928 This does not influence whether to deliver a signal as requested by a
35929 resumption packet (@pxref{vCont packet}).
35931 Signals are numbered identically to continue packets and stop replies
35932 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
35933 strictly greater than the previous item. Multiple
35934 @samp{QProgramSignals} packets do not combine; any earlier
35935 @samp{QProgramSignals} list is completely replaced by the new list.
35940 The request succeeded.
35943 An error occurred. The error number @var{nn} is given as hex digits.
35946 An empty reply indicates that @samp{QProgramSignals} is not supported
35950 Use of this packet is controlled by the @code{set remote program-signals}
35951 command (@pxref{Remote Configuration, set remote program-signals}).
35952 This packet is not probed by default; the remote stub must request it,
35953 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
35955 @item qRcmd,@var{command}
35956 @cindex execute remote command, remote request
35957 @cindex @samp{qRcmd} packet
35958 @var{command} (hex encoded) is passed to the local interpreter for
35959 execution. Invalid commands should be reported using the output
35960 string. Before the final result packet, the target may also respond
35961 with a number of intermediate @samp{O@var{output}} console output
35962 packets. @emph{Implementors should note that providing access to a
35963 stubs's interpreter may have security implications}.
35968 A command response with no output.
35970 A command response with the hex encoded output string @var{OUTPUT}.
35972 Indicate a badly formed request.
35974 An empty reply indicates that @samp{qRcmd} is not recognized.
35977 (Note that the @code{qRcmd} packet's name is separated from the
35978 command by a @samp{,}, not a @samp{:}, contrary to the naming
35979 conventions above. Please don't use this packet as a model for new
35982 @item qSearch:memory:@var{address};@var{length};@var{search-pattern}
35983 @cindex searching memory, in remote debugging
35985 @cindex @samp{qSearch:memory} packet
35987 @cindex @samp{qSearch memory} packet
35988 @anchor{qSearch memory}
35989 Search @var{length} bytes at @var{address} for @var{search-pattern}.
35990 Both @var{address} and @var{length} are encoded in hex;
35991 @var{search-pattern} is a sequence of bytes, also hex encoded.
35996 The pattern was not found.
35998 The pattern was found at @var{address}.
36000 A badly formed request or an error was encountered while searching memory.
36002 An empty reply indicates that @samp{qSearch:memory} is not recognized.
36005 @item QStartNoAckMode
36006 @cindex @samp{QStartNoAckMode} packet
36007 @anchor{QStartNoAckMode}
36008 Request that the remote stub disable the normal @samp{+}/@samp{-}
36009 protocol acknowledgments (@pxref{Packet Acknowledgment}).
36014 The stub has switched to no-acknowledgment mode.
36015 @value{GDBN} acknowledges this reponse,
36016 but neither the stub nor @value{GDBN} shall send or expect further
36017 @samp{+}/@samp{-} acknowledgments in the current connection.
36019 An empty reply indicates that the stub does not support no-acknowledgment mode.
36022 @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]}
36023 @cindex supported packets, remote query
36024 @cindex features of the remote protocol
36025 @cindex @samp{qSupported} packet
36026 @anchor{qSupported}
36027 Tell the remote stub about features supported by @value{GDBN}, and
36028 query the stub for features it supports. This packet allows
36029 @value{GDBN} and the remote stub to take advantage of each others'
36030 features. @samp{qSupported} also consolidates multiple feature probes
36031 at startup, to improve @value{GDBN} performance---a single larger
36032 packet performs better than multiple smaller probe packets on
36033 high-latency links. Some features may enable behavior which must not
36034 be on by default, e.g.@: because it would confuse older clients or
36035 stubs. Other features may describe packets which could be
36036 automatically probed for, but are not. These features must be
36037 reported before @value{GDBN} will use them. This ``default
36038 unsupported'' behavior is not appropriate for all packets, but it
36039 helps to keep the initial connection time under control with new
36040 versions of @value{GDBN} which support increasing numbers of packets.
36044 @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{}
36045 The stub supports or does not support each returned @var{stubfeature},
36046 depending on the form of each @var{stubfeature} (see below for the
36049 An empty reply indicates that @samp{qSupported} is not recognized,
36050 or that no features needed to be reported to @value{GDBN}.
36053 The allowed forms for each feature (either a @var{gdbfeature} in the
36054 @samp{qSupported} packet, or a @var{stubfeature} in the response)
36058 @item @var{name}=@var{value}
36059 The remote protocol feature @var{name} is supported, and associated
36060 with the specified @var{value}. The format of @var{value} depends
36061 on the feature, but it must not include a semicolon.
36063 The remote protocol feature @var{name} is supported, and does not
36064 need an associated value.
36066 The remote protocol feature @var{name} is not supported.
36068 The remote protocol feature @var{name} may be supported, and
36069 @value{GDBN} should auto-detect support in some other way when it is
36070 needed. This form will not be used for @var{gdbfeature} notifications,
36071 but may be used for @var{stubfeature} responses.
36074 Whenever the stub receives a @samp{qSupported} request, the
36075 supplied set of @value{GDBN} features should override any previous
36076 request. This allows @value{GDBN} to put the stub in a known
36077 state, even if the stub had previously been communicating with
36078 a different version of @value{GDBN}.
36080 The following values of @var{gdbfeature} (for the packet sent by @value{GDBN})
36085 This feature indicates whether @value{GDBN} supports multiprocess
36086 extensions to the remote protocol. @value{GDBN} does not use such
36087 extensions unless the stub also reports that it supports them by
36088 including @samp{multiprocess+} in its @samp{qSupported} reply.
36089 @xref{multiprocess extensions}, for details.
36092 This feature indicates that @value{GDBN} supports the XML target
36093 description. If the stub sees @samp{xmlRegisters=} with target
36094 specific strings separated by a comma, it will report register
36098 This feature indicates whether @value{GDBN} supports the
36099 @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate
36100 instruction reply packet}).
36103 This feature indicates whether @value{GDBN} supports the swbreak stop
36104 reason in stop replies. @xref{swbreak stop reason}, for details.
36107 This feature indicates whether @value{GDBN} supports the hwbreak stop
36108 reason in stop replies. @xref{swbreak stop reason}, for details.
36111 This feature indicates whether @value{GDBN} supports fork event
36112 extensions to the remote protocol. @value{GDBN} does not use such
36113 extensions unless the stub also reports that it supports them by
36114 including @samp{fork-events+} in its @samp{qSupported} reply.
36117 This feature indicates whether @value{GDBN} supports vfork event
36118 extensions to the remote protocol. @value{GDBN} does not use such
36119 extensions unless the stub also reports that it supports them by
36120 including @samp{vfork-events+} in its @samp{qSupported} reply.
36123 This feature indicates whether @value{GDBN} supports exec event
36124 extensions to the remote protocol. @value{GDBN} does not use such
36125 extensions unless the stub also reports that it supports them by
36126 including @samp{exec-events+} in its @samp{qSupported} reply.
36128 @item vContSupported
36129 This feature indicates whether @value{GDBN} wants to know the
36130 supported actions in the reply to @samp{vCont?} packet.
36133 Stubs should ignore any unknown values for
36134 @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported}
36135 packet supports receiving packets of unlimited length (earlier
36136 versions of @value{GDBN} may reject overly long responses). Additional values
36137 for @var{gdbfeature} may be defined in the future to let the stub take
36138 advantage of new features in @value{GDBN}, e.g.@: incompatible
36139 improvements in the remote protocol---the @samp{multiprocess} feature is
36140 an example of such a feature. The stub's reply should be independent
36141 of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN}
36142 describes all the features it supports, and then the stub replies with
36143 all the features it supports.
36145 Similarly, @value{GDBN} will silently ignore unrecognized stub feature
36146 responses, as long as each response uses one of the standard forms.
36148 Some features are flags. A stub which supports a flag feature
36149 should respond with a @samp{+} form response. Other features
36150 require values, and the stub should respond with an @samp{=}
36153 Each feature has a default value, which @value{GDBN} will use if
36154 @samp{qSupported} is not available or if the feature is not mentioned
36155 in the @samp{qSupported} response. The default values are fixed; a
36156 stub is free to omit any feature responses that match the defaults.
36158 Not all features can be probed, but for those which can, the probing
36159 mechanism is useful: in some cases, a stub's internal
36160 architecture may not allow the protocol layer to know some information
36161 about the underlying target in advance. This is especially common in
36162 stubs which may be configured for multiple targets.
36164 These are the currently defined stub features and their properties:
36166 @multitable @columnfractions 0.35 0.2 0.12 0.2
36167 @c NOTE: The first row should be @headitem, but we do not yet require
36168 @c a new enough version of Texinfo (4.7) to use @headitem.
36170 @tab Value Required
36174 @item @samp{PacketSize}
36179 @item @samp{qXfer:auxv:read}
36184 @item @samp{qXfer:btrace:read}
36189 @item @samp{qXfer:btrace-conf:read}
36194 @item @samp{qXfer:exec-file:read}
36199 @item @samp{qXfer:features:read}
36204 @item @samp{qXfer:libraries:read}
36209 @item @samp{qXfer:libraries-svr4:read}
36214 @item @samp{augmented-libraries-svr4-read}
36219 @item @samp{qXfer:memory-map:read}
36224 @item @samp{qXfer:sdata:read}
36229 @item @samp{qXfer:spu:read}
36234 @item @samp{qXfer:spu:write}
36239 @item @samp{qXfer:siginfo:read}
36244 @item @samp{qXfer:siginfo:write}
36249 @item @samp{qXfer:threads:read}
36254 @item @samp{qXfer:traceframe-info:read}
36259 @item @samp{qXfer:uib:read}
36264 @item @samp{qXfer:fdpic:read}
36269 @item @samp{Qbtrace:off}
36274 @item @samp{Qbtrace:bts}
36279 @item @samp{Qbtrace:pt}
36284 @item @samp{Qbtrace-conf:bts:size}
36289 @item @samp{Qbtrace-conf:pt:size}
36294 @item @samp{QNonStop}
36299 @item @samp{QPassSignals}
36304 @item @samp{QStartNoAckMode}
36309 @item @samp{multiprocess}
36314 @item @samp{ConditionalBreakpoints}
36319 @item @samp{ConditionalTracepoints}
36324 @item @samp{ReverseContinue}
36329 @item @samp{ReverseStep}
36334 @item @samp{TracepointSource}
36339 @item @samp{QAgent}
36344 @item @samp{QAllow}
36349 @item @samp{QDisableRandomization}
36354 @item @samp{EnableDisableTracepoints}
36359 @item @samp{QTBuffer:size}
36364 @item @samp{tracenz}
36369 @item @samp{BreakpointCommands}
36374 @item @samp{swbreak}
36379 @item @samp{hwbreak}
36384 @item @samp{fork-events}
36389 @item @samp{vfork-events}
36394 @item @samp{exec-events}
36401 These are the currently defined stub features, in more detail:
36404 @cindex packet size, remote protocol
36405 @item PacketSize=@var{bytes}
36406 The remote stub can accept packets up to at least @var{bytes} in
36407 length. @value{GDBN} will send packets up to this size for bulk
36408 transfers, and will never send larger packets. This is a limit on the
36409 data characters in the packet, including the frame and checksum.
36410 There is no trailing NUL byte in a remote protocol packet; if the stub
36411 stores packets in a NUL-terminated format, it should allow an extra
36412 byte in its buffer for the NUL. If this stub feature is not supported,
36413 @value{GDBN} guesses based on the size of the @samp{g} packet response.
36415 @item qXfer:auxv:read
36416 The remote stub understands the @samp{qXfer:auxv:read} packet
36417 (@pxref{qXfer auxiliary vector read}).
36419 @item qXfer:btrace:read
36420 The remote stub understands the @samp{qXfer:btrace:read}
36421 packet (@pxref{qXfer btrace read}).
36423 @item qXfer:btrace-conf:read
36424 The remote stub understands the @samp{qXfer:btrace-conf:read}
36425 packet (@pxref{qXfer btrace-conf read}).
36427 @item qXfer:exec-file:read
36428 The remote stub understands the @samp{qXfer:exec-file:read} packet
36429 (@pxref{qXfer executable filename read}).
36431 @item qXfer:features:read
36432 The remote stub understands the @samp{qXfer:features:read} packet
36433 (@pxref{qXfer target description read}).
36435 @item qXfer:libraries:read
36436 The remote stub understands the @samp{qXfer:libraries:read} packet
36437 (@pxref{qXfer library list read}).
36439 @item qXfer:libraries-svr4:read
36440 The remote stub understands the @samp{qXfer:libraries-svr4:read} packet
36441 (@pxref{qXfer svr4 library list read}).
36443 @item augmented-libraries-svr4-read
36444 The remote stub understands the augmented form of the
36445 @samp{qXfer:libraries-svr4:read} packet
36446 (@pxref{qXfer svr4 library list read}).
36448 @item qXfer:memory-map:read
36449 The remote stub understands the @samp{qXfer:memory-map:read} packet
36450 (@pxref{qXfer memory map read}).
36452 @item qXfer:sdata:read
36453 The remote stub understands the @samp{qXfer:sdata:read} packet
36454 (@pxref{qXfer sdata read}).
36456 @item qXfer:spu:read
36457 The remote stub understands the @samp{qXfer:spu:read} packet
36458 (@pxref{qXfer spu read}).
36460 @item qXfer:spu:write
36461 The remote stub understands the @samp{qXfer:spu:write} packet
36462 (@pxref{qXfer spu write}).
36464 @item qXfer:siginfo:read
36465 The remote stub understands the @samp{qXfer:siginfo:read} packet
36466 (@pxref{qXfer siginfo read}).
36468 @item qXfer:siginfo:write
36469 The remote stub understands the @samp{qXfer:siginfo:write} packet
36470 (@pxref{qXfer siginfo write}).
36472 @item qXfer:threads:read
36473 The remote stub understands the @samp{qXfer:threads:read} packet
36474 (@pxref{qXfer threads read}).
36476 @item qXfer:traceframe-info:read
36477 The remote stub understands the @samp{qXfer:traceframe-info:read}
36478 packet (@pxref{qXfer traceframe info read}).
36480 @item qXfer:uib:read
36481 The remote stub understands the @samp{qXfer:uib:read}
36482 packet (@pxref{qXfer unwind info block}).
36484 @item qXfer:fdpic:read
36485 The remote stub understands the @samp{qXfer:fdpic:read}
36486 packet (@pxref{qXfer fdpic loadmap read}).
36489 The remote stub understands the @samp{QNonStop} packet
36490 (@pxref{QNonStop}).
36493 The remote stub understands the @samp{QPassSignals} packet
36494 (@pxref{QPassSignals}).
36496 @item QStartNoAckMode
36497 The remote stub understands the @samp{QStartNoAckMode} packet and
36498 prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}.
36501 @anchor{multiprocess extensions}
36502 @cindex multiprocess extensions, in remote protocol
36503 The remote stub understands the multiprocess extensions to the remote
36504 protocol syntax. The multiprocess extensions affect the syntax of
36505 thread IDs in both packets and replies (@pxref{thread-id syntax}), and
36506 add process IDs to the @samp{D} packet and @samp{W} and @samp{X}
36507 replies. Note that reporting this feature indicates support for the
36508 syntactic extensions only, not that the stub necessarily supports
36509 debugging of more than one process at a time. The stub must not use
36510 multiprocess extensions in packet replies unless @value{GDBN} has also
36511 indicated it supports them in its @samp{qSupported} request.
36513 @item qXfer:osdata:read
36514 The remote stub understands the @samp{qXfer:osdata:read} packet
36515 ((@pxref{qXfer osdata read}).
36517 @item ConditionalBreakpoints
36518 The target accepts and implements evaluation of conditional expressions
36519 defined for breakpoints. The target will only report breakpoint triggers
36520 when such conditions are true (@pxref{Conditions, ,Break Conditions}).
36522 @item ConditionalTracepoints
36523 The remote stub accepts and implements conditional expressions defined
36524 for tracepoints (@pxref{Tracepoint Conditions}).
36526 @item ReverseContinue
36527 The remote stub accepts and implements the reverse continue packet
36531 The remote stub accepts and implements the reverse step packet
36534 @item TracepointSource
36535 The remote stub understands the @samp{QTDPsrc} packet that supplies
36536 the source form of tracepoint definitions.
36539 The remote stub understands the @samp{QAgent} packet.
36542 The remote stub understands the @samp{QAllow} packet.
36544 @item QDisableRandomization
36545 The remote stub understands the @samp{QDisableRandomization} packet.
36547 @item StaticTracepoint
36548 @cindex static tracepoints, in remote protocol
36549 The remote stub supports static tracepoints.
36551 @item InstallInTrace
36552 @anchor{install tracepoint in tracing}
36553 The remote stub supports installing tracepoint in tracing.
36555 @item EnableDisableTracepoints
36556 The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and
36557 @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints
36558 to be enabled and disabled while a trace experiment is running.
36560 @item QTBuffer:size
36561 The remote stub supports the @samp{QTBuffer:size} (@pxref{QTBuffer-size})
36562 packet that allows to change the size of the trace buffer.
36565 @cindex string tracing, in remote protocol
36566 The remote stub supports the @samp{tracenz} bytecode for collecting strings.
36567 See @ref{Bytecode Descriptions} for details about the bytecode.
36569 @item BreakpointCommands
36570 @cindex breakpoint commands, in remote protocol
36571 The remote stub supports running a breakpoint's command list itself,
36572 rather than reporting the hit to @value{GDBN}.
36575 The remote stub understands the @samp{Qbtrace:off} packet.
36578 The remote stub understands the @samp{Qbtrace:bts} packet.
36581 The remote stub understands the @samp{Qbtrace:pt} packet.
36583 @item Qbtrace-conf:bts:size
36584 The remote stub understands the @samp{Qbtrace-conf:bts:size} packet.
36586 @item Qbtrace-conf:pt:size
36587 The remote stub understands the @samp{Qbtrace-conf:pt:size} packet.
36590 The remote stub reports the @samp{swbreak} stop reason for memory
36594 The remote stub reports the @samp{hwbreak} stop reason for hardware
36598 The remote stub reports the @samp{fork} stop reason for fork events.
36601 The remote stub reports the @samp{vfork} stop reason for vfork events
36602 and vforkdone events.
36605 The remote stub reports the @samp{exec} stop reason for exec events.
36607 @item vContSupported
36608 The remote stub reports the supported actions in the reply to
36609 @samp{vCont?} packet.
36614 @cindex symbol lookup, remote request
36615 @cindex @samp{qSymbol} packet
36616 Notify the target that @value{GDBN} is prepared to serve symbol lookup
36617 requests. Accept requests from the target for the values of symbols.
36622 The target does not need to look up any (more) symbols.
36623 @item qSymbol:@var{sym_name}
36624 The target requests the value of symbol @var{sym_name} (hex encoded).
36625 @value{GDBN} may provide the value by using the
36626 @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described
36630 @item qSymbol:@var{sym_value}:@var{sym_name}
36631 Set the value of @var{sym_name} to @var{sym_value}.
36633 @var{sym_name} (hex encoded) is the name of a symbol whose value the
36634 target has previously requested.
36636 @var{sym_value} (hex) is the value for symbol @var{sym_name}. If
36637 @value{GDBN} cannot supply a value for @var{sym_name}, then this field
36643 The target does not need to look up any (more) symbols.
36644 @item qSymbol:@var{sym_name}
36645 The target requests the value of a new symbol @var{sym_name} (hex
36646 encoded). @value{GDBN} will continue to supply the values of symbols
36647 (if available), until the target ceases to request them.
36652 @itemx QTDisconnected
36659 @itemx qTMinFTPILen
36661 @xref{Tracepoint Packets}.
36663 @item qThreadExtraInfo,@var{thread-id}
36664 @cindex thread attributes info, remote request
36665 @cindex @samp{qThreadExtraInfo} packet
36666 Obtain from the target OS a printable string description of thread
36667 attributes for the thread @var{thread-id}; see @ref{thread-id syntax},
36668 for the forms of @var{thread-id}. This
36669 string may contain anything that the target OS thinks is interesting
36670 for @value{GDBN} to tell the user about the thread. The string is
36671 displayed in @value{GDBN}'s @code{info threads} display. Some
36672 examples of possible thread extra info strings are @samp{Runnable}, or
36673 @samp{Blocked on Mutex}.
36677 @item @var{XX}@dots{}
36678 Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data,
36679 comprising the printable string containing the extra information about
36680 the thread's attributes.
36683 (Note that the @code{qThreadExtraInfo} packet's name is separated from
36684 the command by a @samp{,}, not a @samp{:}, contrary to the naming
36685 conventions above. Please don't use this packet as a model for new
36704 @xref{Tracepoint Packets}.
36706 @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length}
36707 @cindex read special object, remote request
36708 @cindex @samp{qXfer} packet
36709 @anchor{qXfer read}
36710 Read uninterpreted bytes from the target's special data area
36711 identified by the keyword @var{object}. Request @var{length} bytes
36712 starting at @var{offset} bytes into the data. The content and
36713 encoding of @var{annex} is specific to @var{object}; it can supply
36714 additional details about what data to access.
36716 Here are the specific requests of this form defined so far. All
36717 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
36718 formats, listed below.
36721 @item qXfer:auxv:read::@var{offset},@var{length}
36722 @anchor{qXfer auxiliary vector read}
36723 Access the target's @dfn{auxiliary vector}. @xref{OS Information,
36724 auxiliary vector}. Note @var{annex} must be empty.
36726 This packet is not probed by default; the remote stub must request it,
36727 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36729 @item qXfer:btrace:read:@var{annex}:@var{offset},@var{length}
36730 @anchor{qXfer btrace read}
36732 Return a description of the current branch trace.
36733 @xref{Branch Trace Format}. The annex part of the generic @samp{qXfer}
36734 packet may have one of the following values:
36738 Returns all available branch trace.
36741 Returns all available branch trace if the branch trace changed since
36742 the last read request.
36745 Returns the new branch trace since the last read request. Adds a new
36746 block to the end of the trace that begins at zero and ends at the source
36747 location of the first branch in the trace buffer. This extra block is
36748 used to stitch traces together.
36750 If the trace buffer overflowed, returns an error indicating the overflow.
36753 This packet is not probed by default; the remote stub must request it
36754 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36756 @item qXfer:btrace-conf:read::@var{offset},@var{length}
36757 @anchor{qXfer btrace-conf read}
36759 Return a description of the current branch trace configuration.
36760 @xref{Branch Trace Configuration Format}.
36762 This packet is not probed by default; the remote stub must request it
36763 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36765 @item qXfer:exec-file:read:@var{annex}:@var{offset},@var{length}
36766 @anchor{qXfer executable filename read}
36767 Return the full absolute name of the file that was executed to create
36768 a process running on the remote system. The annex specifies the
36769 numeric process ID of the process to query, encoded as a hexadecimal
36770 number. If the annex part is empty the remote stub should return the
36771 filename corresponding to the currently executing process.
36773 This packet is not probed by default; the remote stub must request it,
36774 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36776 @item qXfer:features:read:@var{annex}:@var{offset},@var{length}
36777 @anchor{qXfer target description read}
36778 Access the @dfn{target description}. @xref{Target Descriptions}. The
36779 annex specifies which XML document to access. The main description is
36780 always loaded from the @samp{target.xml} annex.
36782 This packet is not probed by default; the remote stub must request it,
36783 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36785 @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length}
36786 @anchor{qXfer library list read}
36787 Access the target's list of loaded libraries. @xref{Library List Format}.
36788 The annex part of the generic @samp{qXfer} packet must be empty
36789 (@pxref{qXfer read}).
36791 Targets which maintain a list of libraries in the program's memory do
36792 not need to implement this packet; it is designed for platforms where
36793 the operating system manages the list of loaded libraries.
36795 This packet is not probed by default; the remote stub must request it,
36796 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36798 @item qXfer:libraries-svr4:read:@var{annex}:@var{offset},@var{length}
36799 @anchor{qXfer svr4 library list read}
36800 Access the target's list of loaded libraries when the target is an SVR4
36801 platform. @xref{Library List Format for SVR4 Targets}. The annex part
36802 of the generic @samp{qXfer} packet must be empty unless the remote
36803 stub indicated it supports the augmented form of this packet
36804 by supplying an appropriate @samp{qSupported} response
36805 (@pxref{qXfer read}, @ref{qSupported}).
36807 This packet is optional for better performance on SVR4 targets.
36808 @value{GDBN} uses memory read packets to read the SVR4 library list otherwise.
36810 This packet is not probed by default; the remote stub must request it,
36811 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36813 If the remote stub indicates it supports the augmented form of this
36814 packet then the annex part of the generic @samp{qXfer} packet may
36815 contain a semicolon-separated list of @samp{@var{name}=@var{value}}
36816 arguments. The currently supported arguments are:
36819 @item start=@var{address}
36820 A hexadecimal number specifying the address of the @samp{struct
36821 link_map} to start reading the library list from. If unset or zero
36822 then the first @samp{struct link_map} in the library list will be
36823 chosen as the starting point.
36825 @item prev=@var{address}
36826 A hexadecimal number specifying the address of the @samp{struct
36827 link_map} immediately preceding the @samp{struct link_map}
36828 specified by the @samp{start} argument. If unset or zero then
36829 the remote stub will expect that no @samp{struct link_map}
36830 exists prior to the starting point.
36834 Arguments that are not understood by the remote stub will be silently
36837 @item qXfer:memory-map:read::@var{offset},@var{length}
36838 @anchor{qXfer memory map read}
36839 Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The
36840 annex part of the generic @samp{qXfer} packet must be empty
36841 (@pxref{qXfer read}).
36843 This packet is not probed by default; the remote stub must request it,
36844 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36846 @item qXfer:sdata:read::@var{offset},@var{length}
36847 @anchor{qXfer sdata read}
36849 Read contents of the extra collected static tracepoint marker
36850 information. The annex part of the generic @samp{qXfer} packet must
36851 be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint
36854 This packet is not probed by default; the remote stub must request it,
36855 by supplying an appropriate @samp{qSupported} response
36856 (@pxref{qSupported}).
36858 @item qXfer:siginfo:read::@var{offset},@var{length}
36859 @anchor{qXfer siginfo read}
36860 Read contents of the extra signal information on the target
36861 system. The annex part of the generic @samp{qXfer} packet must be
36862 empty (@pxref{qXfer read}).
36864 This packet is not probed by default; the remote stub must request it,
36865 by supplying an appropriate @samp{qSupported} response
36866 (@pxref{qSupported}).
36868 @item qXfer:spu:read:@var{annex}:@var{offset},@var{length}
36869 @anchor{qXfer spu read}
36870 Read contents of an @code{spufs} file on the target system. The
36871 annex specifies which file to read; it must be of the form
36872 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
36873 in the target process, and @var{name} identifes the @code{spufs} file
36874 in that context to be accessed.
36876 This packet is not probed by default; the remote stub must request it,
36877 by supplying an appropriate @samp{qSupported} response
36878 (@pxref{qSupported}).
36880 @item qXfer:threads:read::@var{offset},@var{length}
36881 @anchor{qXfer threads read}
36882 Access the list of threads on target. @xref{Thread List Format}. The
36883 annex part of the generic @samp{qXfer} packet must be empty
36884 (@pxref{qXfer read}).
36886 This packet is not probed by default; the remote stub must request it,
36887 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36889 @item qXfer:traceframe-info:read::@var{offset},@var{length}
36890 @anchor{qXfer traceframe info read}
36892 Return a description of the current traceframe's contents.
36893 @xref{Traceframe Info Format}. The annex part of the generic
36894 @samp{qXfer} packet must be empty (@pxref{qXfer read}).
36896 This packet is not probed by default; the remote stub must request it,
36897 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36899 @item qXfer:uib:read:@var{pc}:@var{offset},@var{length}
36900 @anchor{qXfer unwind info block}
36902 Return the unwind information block for @var{pc}. This packet is used
36903 on OpenVMS/ia64 to ask the kernel unwind information.
36905 This packet is not probed by default.
36907 @item qXfer:fdpic:read:@var{annex}:@var{offset},@var{length}
36908 @anchor{qXfer fdpic loadmap read}
36909 Read contents of @code{loadmap}s on the target system. The
36910 annex, either @samp{exec} or @samp{interp}, specifies which @code{loadmap},
36911 executable @code{loadmap} or interpreter @code{loadmap} to read.
36913 This packet is not probed by default; the remote stub must request it,
36914 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36916 @item qXfer:osdata:read::@var{offset},@var{length}
36917 @anchor{qXfer osdata read}
36918 Access the target's @dfn{operating system information}.
36919 @xref{Operating System Information}.
36926 Data @var{data} (@pxref{Binary Data}) has been read from the
36927 target. There may be more data at a higher address (although
36928 it is permitted to return @samp{m} even for the last valid
36929 block of data, as long as at least one byte of data was read).
36930 It is possible for @var{data} to have fewer bytes than the @var{length} in the
36934 Data @var{data} (@pxref{Binary Data}) has been read from the target.
36935 There is no more data to be read. It is possible for @var{data} to
36936 have fewer bytes than the @var{length} in the request.
36939 The @var{offset} in the request is at the end of the data.
36940 There is no more data to be read.
36943 The request was malformed, or @var{annex} was invalid.
36946 The offset was invalid, or there was an error encountered reading the data.
36947 The @var{nn} part is a hex-encoded @code{errno} value.
36950 An empty reply indicates the @var{object} string was not recognized by
36951 the stub, or that the object does not support reading.
36954 @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{}
36955 @cindex write data into object, remote request
36956 @anchor{qXfer write}
36957 Write uninterpreted bytes into the target's special data area
36958 identified by the keyword @var{object}, starting at @var{offset} bytes
36959 into the data. The binary-encoded data (@pxref{Binary Data}) to be
36960 written is given by @var{data}@dots{}. The content and encoding of @var{annex}
36961 is specific to @var{object}; it can supply additional details about what data
36964 Here are the specific requests of this form defined so far. All
36965 @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply
36966 formats, listed below.
36969 @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{}
36970 @anchor{qXfer siginfo write}
36971 Write @var{data} to the extra signal information on the target system.
36972 The annex part of the generic @samp{qXfer} packet must be
36973 empty (@pxref{qXfer write}).
36975 This packet is not probed by default; the remote stub must request it,
36976 by supplying an appropriate @samp{qSupported} response
36977 (@pxref{qSupported}).
36979 @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{}
36980 @anchor{qXfer spu write}
36981 Write @var{data} to an @code{spufs} file on the target system. The
36982 annex specifies which file to write; it must be of the form
36983 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
36984 in the target process, and @var{name} identifes the @code{spufs} file
36985 in that context to be accessed.
36987 This packet is not probed by default; the remote stub must request it,
36988 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36994 @var{nn} (hex encoded) is the number of bytes written.
36995 This may be fewer bytes than supplied in the request.
36998 The request was malformed, or @var{annex} was invalid.
37001 The offset was invalid, or there was an error encountered writing the data.
37002 The @var{nn} part is a hex-encoded @code{errno} value.
37005 An empty reply indicates the @var{object} string was not
37006 recognized by the stub, or that the object does not support writing.
37009 @item qXfer:@var{object}:@var{operation}:@dots{}
37010 Requests of this form may be added in the future. When a stub does
37011 not recognize the @var{object} keyword, or its support for
37012 @var{object} does not recognize the @var{operation} keyword, the stub
37013 must respond with an empty packet.
37015 @item qAttached:@var{pid}
37016 @cindex query attached, remote request
37017 @cindex @samp{qAttached} packet
37018 Return an indication of whether the remote server attached to an
37019 existing process or created a new process. When the multiprocess
37020 protocol extensions are supported (@pxref{multiprocess extensions}),
37021 @var{pid} is an integer in hexadecimal format identifying the target
37022 process. Otherwise, @value{GDBN} will omit the @var{pid} field and
37023 the query packet will be simplified as @samp{qAttached}.
37025 This query is used, for example, to know whether the remote process
37026 should be detached or killed when a @value{GDBN} session is ended with
37027 the @code{quit} command.
37032 The remote server attached to an existing process.
37034 The remote server created a new process.
37036 A badly formed request or an error was encountered.
37040 Enable branch tracing for the current thread using Branch Trace Store.
37045 Branch tracing has been enabled.
37047 A badly formed request or an error was encountered.
37051 Enable branch tracing for the current thread using Intel(R) Processor Trace.
37056 Branch tracing has been enabled.
37058 A badly formed request or an error was encountered.
37062 Disable branch tracing for the current thread.
37067 Branch tracing has been disabled.
37069 A badly formed request or an error was encountered.
37072 @item Qbtrace-conf:bts:size=@var{value}
37073 Set the requested ring buffer size for new threads that use the
37074 btrace recording method in bts format.
37079 The ring buffer size has been set.
37081 A badly formed request or an error was encountered.
37084 @item Qbtrace-conf:pt:size=@var{value}
37085 Set the requested ring buffer size for new threads that use the
37086 btrace recording method in pt format.
37091 The ring buffer size has been set.
37093 A badly formed request or an error was encountered.
37098 @node Architecture-Specific Protocol Details
37099 @section Architecture-Specific Protocol Details
37101 This section describes how the remote protocol is applied to specific
37102 target architectures. Also see @ref{Standard Target Features}, for
37103 details of XML target descriptions for each architecture.
37106 * ARM-Specific Protocol Details::
37107 * MIPS-Specific Protocol Details::
37110 @node ARM-Specific Protocol Details
37111 @subsection @acronym{ARM}-specific Protocol Details
37114 * ARM Breakpoint Kinds::
37117 @node ARM Breakpoint Kinds
37118 @subsubsection @acronym{ARM} Breakpoint Kinds
37119 @cindex breakpoint kinds, @acronym{ARM}
37121 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
37126 16-bit Thumb mode breakpoint.
37129 32-bit Thumb mode (Thumb-2) breakpoint.
37132 32-bit @acronym{ARM} mode breakpoint.
37136 @node MIPS-Specific Protocol Details
37137 @subsection @acronym{MIPS}-specific Protocol Details
37140 * MIPS Register packet Format::
37141 * MIPS Breakpoint Kinds::
37144 @node MIPS Register packet Format
37145 @subsubsection @acronym{MIPS} Register Packet Format
37146 @cindex register packet format, @acronym{MIPS}
37148 The following @code{g}/@code{G} packets have previously been defined.
37149 In the below, some thirty-two bit registers are transferred as
37150 sixty-four bits. Those registers should be zero/sign extended (which?)
37151 to fill the space allocated. Register bytes are transferred in target
37152 byte order. The two nibbles within a register byte are transferred
37153 most-significant -- least-significant.
37158 All registers are transferred as thirty-two bit quantities in the order:
37159 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
37160 registers; fsr; fir; fp.
37163 All registers are transferred as sixty-four bit quantities (including
37164 thirty-two bit registers such as @code{sr}). The ordering is the same
37169 @node MIPS Breakpoint Kinds
37170 @subsubsection @acronym{MIPS} Breakpoint Kinds
37171 @cindex breakpoint kinds, @acronym{MIPS}
37173 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
37178 16-bit @acronym{MIPS16} mode breakpoint.
37181 16-bit @acronym{microMIPS} mode breakpoint.
37184 32-bit standard @acronym{MIPS} mode breakpoint.
37187 32-bit @acronym{microMIPS} mode breakpoint.
37191 @node Tracepoint Packets
37192 @section Tracepoint Packets
37193 @cindex tracepoint packets
37194 @cindex packets, tracepoint
37196 Here we describe the packets @value{GDBN} uses to implement
37197 tracepoints (@pxref{Tracepoints}).
37201 @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]}
37202 @cindex @samp{QTDP} packet
37203 Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena}
37204 is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then
37205 the tracepoint is disabled. The @var{step} gives the tracepoint's step
37206 count, and @var{pass} gives its pass count. If an @samp{F} is present,
37207 then the tracepoint is to be a fast tracepoint, and the @var{flen} is
37208 the number of bytes that the target should copy elsewhere to make room
37209 for the tracepoint. If an @samp{X} is present, it introduces a
37210 tracepoint condition, which consists of a hexadecimal length, followed
37211 by a comma and hex-encoded bytes, in a manner similar to action
37212 encodings as described below. If the trailing @samp{-} is present,
37213 further @samp{QTDP} packets will follow to specify this tracepoint's
37219 The packet was understood and carried out.
37221 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
37223 The packet was not recognized.
37226 @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]}
37227 Define actions to be taken when a tracepoint is hit. The @var{n} and
37228 @var{addr} must be the same as in the initial @samp{QTDP} packet for
37229 this tracepoint. This packet may only be sent immediately after
37230 another @samp{QTDP} packet that ended with a @samp{-}. If the
37231 trailing @samp{-} is present, further @samp{QTDP} packets will follow,
37232 specifying more actions for this tracepoint.
37234 In the series of action packets for a given tracepoint, at most one
37235 can have an @samp{S} before its first @var{action}. If such a packet
37236 is sent, it and the following packets define ``while-stepping''
37237 actions. Any prior packets define ordinary actions --- that is, those
37238 taken when the tracepoint is first hit. If no action packet has an
37239 @samp{S}, then all the packets in the series specify ordinary
37240 tracepoint actions.
37242 The @samp{@var{action}@dots{}} portion of the packet is a series of
37243 actions, concatenated without separators. Each action has one of the
37249 Collect the registers whose bits are set in @var{mask},
37250 a hexadecimal number whose @var{i}'th bit is set if register number
37251 @var{i} should be collected. (The least significant bit is numbered
37252 zero.) Note that @var{mask} may be any number of digits long; it may
37253 not fit in a 32-bit word.
37255 @item M @var{basereg},@var{offset},@var{len}
37256 Collect @var{len} bytes of memory starting at the address in register
37257 number @var{basereg}, plus @var{offset}. If @var{basereg} is
37258 @samp{-1}, then the range has a fixed address: @var{offset} is the
37259 address of the lowest byte to collect. The @var{basereg},
37260 @var{offset}, and @var{len} parameters are all unsigned hexadecimal
37261 values (the @samp{-1} value for @var{basereg} is a special case).
37263 @item X @var{len},@var{expr}
37264 Evaluate @var{expr}, whose length is @var{len}, and collect memory as
37265 it directs. The agent expression @var{expr} is as described in
37266 @ref{Agent Expressions}. Each byte of the expression is encoded as a
37267 two-digit hex number in the packet; @var{len} is the number of bytes
37268 in the expression (and thus one-half the number of hex digits in the
37273 Any number of actions may be packed together in a single @samp{QTDP}
37274 packet, as long as the packet does not exceed the maximum packet
37275 length (400 bytes, for many stubs). There may be only one @samp{R}
37276 action per tracepoint, and it must precede any @samp{M} or @samp{X}
37277 actions. Any registers referred to by @samp{M} and @samp{X} actions
37278 must be collected by a preceding @samp{R} action. (The
37279 ``while-stepping'' actions are treated as if they were attached to a
37280 separate tracepoint, as far as these restrictions are concerned.)
37285 The packet was understood and carried out.
37287 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
37289 The packet was not recognized.
37292 @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes}
37293 @cindex @samp{QTDPsrc} packet
37294 Specify a source string of tracepoint @var{n} at address @var{addr}.
37295 This is useful to get accurate reproduction of the tracepoints
37296 originally downloaded at the beginning of the trace run. The @var{type}
37297 is the name of the tracepoint part, such as @samp{cond} for the
37298 tracepoint's conditional expression (see below for a list of types), while
37299 @var{bytes} is the string, encoded in hexadecimal.
37301 @var{start} is the offset of the @var{bytes} within the overall source
37302 string, while @var{slen} is the total length of the source string.
37303 This is intended for handling source strings that are longer than will
37304 fit in a single packet.
37305 @c Add detailed example when this info is moved into a dedicated
37306 @c tracepoint descriptions section.
37308 The available string types are @samp{at} for the location,
37309 @samp{cond} for the conditional, and @samp{cmd} for an action command.
37310 @value{GDBN} sends a separate packet for each command in the action
37311 list, in the same order in which the commands are stored in the list.
37313 The target does not need to do anything with source strings except
37314 report them back as part of the replies to the @samp{qTfP}/@samp{qTsP}
37317 Although this packet is optional, and @value{GDBN} will only send it
37318 if the target replies with @samp{TracepointSource} @xref{General
37319 Query Packets}, it makes both disconnected tracing and trace files
37320 much easier to use. Otherwise the user must be careful that the
37321 tracepoints in effect while looking at trace frames are identical to
37322 the ones in effect during the trace run; even a small discrepancy
37323 could cause @samp{tdump} not to work, or a particular trace frame not
37326 @item QTDV:@var{n}:@var{value}:@var{builtin}:@var{name}
37327 @cindex define trace state variable, remote request
37328 @cindex @samp{QTDV} packet
37329 Create a new trace state variable, number @var{n}, with an initial
37330 value of @var{value}, which is a 64-bit signed integer. Both @var{n}
37331 and @var{value} are encoded as hexadecimal values. @value{GDBN} has
37332 the option of not using this packet for initial values of zero; the
37333 target should simply create the trace state variables as they are
37334 mentioned in expressions. The value @var{builtin} should be 1 (one)
37335 if the trace state variable is builtin and 0 (zero) if it is not builtin.
37336 @value{GDBN} only sets @var{builtin} to 1 if a previous @samp{qTfV} or
37337 @samp{qTsV} packet had it set. The contents of @var{name} is the
37338 hex-encoded name (without the leading @samp{$}) of the trace state
37341 @item QTFrame:@var{n}
37342 @cindex @samp{QTFrame} packet
37343 Select the @var{n}'th tracepoint frame from the buffer, and use the
37344 register and memory contents recorded there to answer subsequent
37345 request packets from @value{GDBN}.
37347 A successful reply from the stub indicates that the stub has found the
37348 requested frame. The response is a series of parts, concatenated
37349 without separators, describing the frame we selected. Each part has
37350 one of the following forms:
37354 The selected frame is number @var{n} in the trace frame buffer;
37355 @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there
37356 was no frame matching the criteria in the request packet.
37359 The selected trace frame records a hit of tracepoint number @var{t};
37360 @var{t} is a hexadecimal number.
37364 @item QTFrame:pc:@var{addr}
37365 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37366 currently selected frame whose PC is @var{addr};
37367 @var{addr} is a hexadecimal number.
37369 @item QTFrame:tdp:@var{t}
37370 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37371 currently selected frame that is a hit of tracepoint @var{t}; @var{t}
37372 is a hexadecimal number.
37374 @item QTFrame:range:@var{start}:@var{end}
37375 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37376 currently selected frame whose PC is between @var{start} (inclusive)
37377 and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal
37380 @item QTFrame:outside:@var{start}:@var{end}
37381 Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first
37382 frame @emph{outside} the given range of addresses (exclusive).
37385 @cindex @samp{qTMinFTPILen} packet
37386 This packet requests the minimum length of instruction at which a fast
37387 tracepoint (@pxref{Set Tracepoints}) may be placed. For instance, on
37388 the 32-bit x86 architecture, it is possible to use a 4-byte jump, but
37389 it depends on the target system being able to create trampolines in
37390 the first 64K of memory, which might or might not be possible for that
37391 system. So the reply to this packet will be 4 if it is able to
37398 The minimum instruction length is currently unknown.
37400 The minimum instruction length is @var{length}, where @var{length}
37401 is a hexadecimal number greater or equal to 1. A reply
37402 of 1 means that a fast tracepoint may be placed on any instruction
37403 regardless of size.
37405 An error has occurred.
37407 An empty reply indicates that the request is not supported by the stub.
37411 @cindex @samp{QTStart} packet
37412 Begin the tracepoint experiment. Begin collecting data from
37413 tracepoint hits in the trace frame buffer. This packet supports the
37414 @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate
37415 instruction reply packet}).
37418 @cindex @samp{QTStop} packet
37419 End the tracepoint experiment. Stop collecting trace frames.
37421 @item QTEnable:@var{n}:@var{addr}
37423 @cindex @samp{QTEnable} packet
37424 Enable tracepoint @var{n} at address @var{addr} in a started tracepoint
37425 experiment. If the tracepoint was previously disabled, then collection
37426 of data from it will resume.
37428 @item QTDisable:@var{n}:@var{addr}
37430 @cindex @samp{QTDisable} packet
37431 Disable tracepoint @var{n} at address @var{addr} in a started tracepoint
37432 experiment. No more data will be collected from the tracepoint unless
37433 @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued.
37436 @cindex @samp{QTinit} packet
37437 Clear the table of tracepoints, and empty the trace frame buffer.
37439 @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{}
37440 @cindex @samp{QTro} packet
37441 Establish the given ranges of memory as ``transparent''. The stub
37442 will answer requests for these ranges from memory's current contents,
37443 if they were not collected as part of the tracepoint hit.
37445 @value{GDBN} uses this to mark read-only regions of memory, like those
37446 containing program code. Since these areas never change, they should
37447 still have the same contents they did when the tracepoint was hit, so
37448 there's no reason for the stub to refuse to provide their contents.
37450 @item QTDisconnected:@var{value}
37451 @cindex @samp{QTDisconnected} packet
37452 Set the choice to what to do with the tracing run when @value{GDBN}
37453 disconnects from the target. A @var{value} of 1 directs the target to
37454 continue the tracing run, while 0 tells the target to stop tracing if
37455 @value{GDBN} is no longer in the picture.
37458 @cindex @samp{qTStatus} packet
37459 Ask the stub if there is a trace experiment running right now.
37461 The reply has the form:
37465 @item T@var{running}@r{[};@var{field}@r{]}@dots{}
37466 @var{running} is a single digit @code{1} if the trace is presently
37467 running, or @code{0} if not. It is followed by semicolon-separated
37468 optional fields that an agent may use to report additional status.
37472 If the trace is not running, the agent may report any of several
37473 explanations as one of the optional fields:
37478 No trace has been run yet.
37480 @item tstop[:@var{text}]:0
37481 The trace was stopped by a user-originated stop command. The optional
37482 @var{text} field is a user-supplied string supplied as part of the
37483 stop command (for instance, an explanation of why the trace was
37484 stopped manually). It is hex-encoded.
37487 The trace stopped because the trace buffer filled up.
37489 @item tdisconnected:0
37490 The trace stopped because @value{GDBN} disconnected from the target.
37492 @item tpasscount:@var{tpnum}
37493 The trace stopped because tracepoint @var{tpnum} exceeded its pass count.
37495 @item terror:@var{text}:@var{tpnum}
37496 The trace stopped because tracepoint @var{tpnum} had an error. The
37497 string @var{text} is available to describe the nature of the error
37498 (for instance, a divide by zero in the condition expression); it
37502 The trace stopped for some other reason.
37506 Additional optional fields supply statistical and other information.
37507 Although not required, they are extremely useful for users monitoring
37508 the progress of a trace run. If a trace has stopped, and these
37509 numbers are reported, they must reflect the state of the just-stopped
37514 @item tframes:@var{n}
37515 The number of trace frames in the buffer.
37517 @item tcreated:@var{n}
37518 The total number of trace frames created during the run. This may
37519 be larger than the trace frame count, if the buffer is circular.
37521 @item tsize:@var{n}
37522 The total size of the trace buffer, in bytes.
37524 @item tfree:@var{n}
37525 The number of bytes still unused in the buffer.
37527 @item circular:@var{n}
37528 The value of the circular trace buffer flag. @code{1} means that the
37529 trace buffer is circular and old trace frames will be discarded if
37530 necessary to make room, @code{0} means that the trace buffer is linear
37533 @item disconn:@var{n}
37534 The value of the disconnected tracing flag. @code{1} means that
37535 tracing will continue after @value{GDBN} disconnects, @code{0} means
37536 that the trace run will stop.
37540 @item qTP:@var{tp}:@var{addr}
37541 @cindex tracepoint status, remote request
37542 @cindex @samp{qTP} packet
37543 Ask the stub for the current state of tracepoint number @var{tp} at
37544 address @var{addr}.
37548 @item V@var{hits}:@var{usage}
37549 The tracepoint has been hit @var{hits} times so far during the trace
37550 run, and accounts for @var{usage} in the trace buffer. Note that
37551 @code{while-stepping} steps are not counted as separate hits, but the
37552 steps' space consumption is added into the usage number.
37556 @item qTV:@var{var}
37557 @cindex trace state variable value, remote request
37558 @cindex @samp{qTV} packet
37559 Ask the stub for the value of the trace state variable number @var{var}.
37564 The value of the variable is @var{value}. This will be the current
37565 value of the variable if the user is examining a running target, or a
37566 saved value if the variable was collected in the trace frame that the
37567 user is looking at. Note that multiple requests may result in
37568 different reply values, such as when requesting values while the
37569 program is running.
37572 The value of the variable is unknown. This would occur, for example,
37573 if the user is examining a trace frame in which the requested variable
37578 @cindex @samp{qTfP} packet
37580 @cindex @samp{qTsP} packet
37581 These packets request data about tracepoints that are being used by
37582 the target. @value{GDBN} sends @code{qTfP} to get the first piece
37583 of data, and multiple @code{qTsP} to get additional pieces. Replies
37584 to these packets generally take the form of the @code{QTDP} packets
37585 that define tracepoints. (FIXME add detailed syntax)
37588 @cindex @samp{qTfV} packet
37590 @cindex @samp{qTsV} packet
37591 These packets request data about trace state variables that are on the
37592 target. @value{GDBN} sends @code{qTfV} to get the first vari of data,
37593 and multiple @code{qTsV} to get additional variables. Replies to
37594 these packets follow the syntax of the @code{QTDV} packets that define
37595 trace state variables.
37601 @cindex @samp{qTfSTM} packet
37602 @cindex @samp{qTsSTM} packet
37603 These packets request data about static tracepoint markers that exist
37604 in the target program. @value{GDBN} sends @code{qTfSTM} to get the
37605 first piece of data, and multiple @code{qTsSTM} to get additional
37606 pieces. Replies to these packets take the following form:
37610 @item m @var{address}:@var{id}:@var{extra}
37612 @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{}
37613 a comma-separated list of markers
37615 (lower case letter @samp{L}) denotes end of list.
37617 An error occurred. The error number @var{nn} is given as hex digits.
37619 An empty reply indicates that the request is not supported by the
37623 The @var{address} is encoded in hex;
37624 @var{id} and @var{extra} are strings encoded in hex.
37626 In response to each query, the target will reply with a list of one or
37627 more markers, separated by commas. @value{GDBN} will respond to each
37628 reply with a request for more markers (using the @samp{qs} form of the
37629 query), until the target responds with @samp{l} (lower-case ell, for
37632 @item qTSTMat:@var{address}
37634 @cindex @samp{qTSTMat} packet
37635 This packets requests data about static tracepoint markers in the
37636 target program at @var{address}. Replies to this packet follow the
37637 syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static
37638 tracepoint markers.
37640 @item QTSave:@var{filename}
37641 @cindex @samp{QTSave} packet
37642 This packet directs the target to save trace data to the file name
37643 @var{filename} in the target's filesystem. The @var{filename} is encoded
37644 as a hex string; the interpretation of the file name (relative vs
37645 absolute, wild cards, etc) is up to the target.
37647 @item qTBuffer:@var{offset},@var{len}
37648 @cindex @samp{qTBuffer} packet
37649 Return up to @var{len} bytes of the current contents of trace buffer,
37650 starting at @var{offset}. The trace buffer is treated as if it were
37651 a contiguous collection of traceframes, as per the trace file format.
37652 The reply consists as many hex-encoded bytes as the target can deliver
37653 in a packet; it is not an error to return fewer than were asked for.
37654 A reply consisting of just @code{l} indicates that no bytes are
37657 @item QTBuffer:circular:@var{value}
37658 This packet directs the target to use a circular trace buffer if
37659 @var{value} is 1, or a linear buffer if the value is 0.
37661 @item QTBuffer:size:@var{size}
37662 @anchor{QTBuffer-size}
37663 @cindex @samp{QTBuffer size} packet
37664 This packet directs the target to make the trace buffer be of size
37665 @var{size} if possible. A value of @code{-1} tells the target to
37666 use whatever size it prefers.
37668 @item QTNotes:@r{[}@var{type}:@var{text}@r{]}@r{[};@var{type}:@var{text}@r{]}@dots{}
37669 @cindex @samp{QTNotes} packet
37670 This packet adds optional textual notes to the trace run. Allowable
37671 types include @code{user}, @code{notes}, and @code{tstop}, the
37672 @var{text} fields are arbitrary strings, hex-encoded.
37676 @subsection Relocate instruction reply packet
37677 When installing fast tracepoints in memory, the target may need to
37678 relocate the instruction currently at the tracepoint address to a
37679 different address in memory. For most instructions, a simple copy is
37680 enough, but, for example, call instructions that implicitly push the
37681 return address on the stack, and relative branches or other
37682 PC-relative instructions require offset adjustment, so that the effect
37683 of executing the instruction at a different address is the same as if
37684 it had executed in the original location.
37686 In response to several of the tracepoint packets, the target may also
37687 respond with a number of intermediate @samp{qRelocInsn} request
37688 packets before the final result packet, to have @value{GDBN} handle
37689 this relocation operation. If a packet supports this mechanism, its
37690 documentation will explicitly say so. See for example the above
37691 descriptions for the @samp{QTStart} and @samp{QTDP} packets. The
37692 format of the request is:
37695 @item qRelocInsn:@var{from};@var{to}
37697 This requests @value{GDBN} to copy instruction at address @var{from}
37698 to address @var{to}, possibly adjusted so that executing the
37699 instruction at @var{to} has the same effect as executing it at
37700 @var{from}. @value{GDBN} writes the adjusted instruction to target
37701 memory starting at @var{to}.
37706 @item qRelocInsn:@var{adjusted_size}
37707 Informs the stub the relocation is complete. The @var{adjusted_size} is
37708 the length in bytes of resulting relocated instruction sequence.
37710 A badly formed request was detected, or an error was encountered while
37711 relocating the instruction.
37714 @node Host I/O Packets
37715 @section Host I/O Packets
37716 @cindex Host I/O, remote protocol
37717 @cindex file transfer, remote protocol
37719 The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O
37720 operations on the far side of a remote link. For example, Host I/O is
37721 used to upload and download files to a remote target with its own
37722 filesystem. Host I/O uses the same constant values and data structure
37723 layout as the target-initiated File-I/O protocol. However, the
37724 Host I/O packets are structured differently. The target-initiated
37725 protocol relies on target memory to store parameters and buffers.
37726 Host I/O requests are initiated by @value{GDBN}, and the
37727 target's memory is not involved. @xref{File-I/O Remote Protocol
37728 Extension}, for more details on the target-initiated protocol.
37730 The Host I/O request packets all encode a single operation along with
37731 its arguments. They have this format:
37735 @item vFile:@var{operation}: @var{parameter}@dots{}
37736 @var{operation} is the name of the particular request; the target
37737 should compare the entire packet name up to the second colon when checking
37738 for a supported operation. The format of @var{parameter} depends on
37739 the operation. Numbers are always passed in hexadecimal. Negative
37740 numbers have an explicit minus sign (i.e.@: two's complement is not
37741 used). Strings (e.g.@: filenames) are encoded as a series of
37742 hexadecimal bytes. The last argument to a system call may be a
37743 buffer of escaped binary data (@pxref{Binary Data}).
37747 The valid responses to Host I/O packets are:
37751 @item F @var{result} [, @var{errno}] [; @var{attachment}]
37752 @var{result} is the integer value returned by this operation, usually
37753 non-negative for success and -1 for errors. If an error has occured,
37754 @var{errno} will be included in the result specifying a
37755 value defined by the File-I/O protocol (@pxref{Errno Values}). For
37756 operations which return data, @var{attachment} supplies the data as a
37757 binary buffer. Binary buffers in response packets are escaped in the
37758 normal way (@pxref{Binary Data}). See the individual packet
37759 documentation for the interpretation of @var{result} and
37763 An empty response indicates that this operation is not recognized.
37767 These are the supported Host I/O operations:
37770 @item vFile:open: @var{filename}, @var{flags}, @var{mode}
37771 Open a file at @var{filename} and return a file descriptor for it, or
37772 return -1 if an error occurs. The @var{filename} is a string,
37773 @var{flags} is an integer indicating a mask of open flags
37774 (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask
37775 of mode bits to use if the file is created (@pxref{mode_t Values}).
37776 @xref{open}, for details of the open flags and mode values.
37778 @item vFile:close: @var{fd}
37779 Close the open file corresponding to @var{fd} and return 0, or
37780 -1 if an error occurs.
37782 @item vFile:pread: @var{fd}, @var{count}, @var{offset}
37783 Read data from the open file corresponding to @var{fd}. Up to
37784 @var{count} bytes will be read from the file, starting at @var{offset}
37785 relative to the start of the file. The target may read fewer bytes;
37786 common reasons include packet size limits and an end-of-file
37787 condition. The number of bytes read is returned. Zero should only be
37788 returned for a successful read at the end of the file, or if
37789 @var{count} was zero.
37791 The data read should be returned as a binary attachment on success.
37792 If zero bytes were read, the response should include an empty binary
37793 attachment (i.e.@: a trailing semicolon). The return value is the
37794 number of target bytes read; the binary attachment may be longer if
37795 some characters were escaped.
37797 @item vFile:pwrite: @var{fd}, @var{offset}, @var{data}
37798 Write @var{data} (a binary buffer) to the open file corresponding
37799 to @var{fd}. Start the write at @var{offset} from the start of the
37800 file. Unlike many @code{write} system calls, there is no
37801 separate @var{count} argument; the length of @var{data} in the
37802 packet is used. @samp{vFile:write} returns the number of bytes written,
37803 which may be shorter than the length of @var{data}, or -1 if an
37806 @item vFile:fstat: @var{fd}
37807 Get information about the open file corresponding to @var{fd}.
37808 On success the information is returned as a binary attachment
37809 and the return value is the size of this attachment in bytes.
37810 If an error occurs the return value is -1. The format of the
37811 returned binary attachment is as described in @ref{struct stat}.
37813 @item vFile:unlink: @var{filename}
37814 Delete the file at @var{filename} on the target. Return 0,
37815 or -1 if an error occurs. The @var{filename} is a string.
37817 @item vFile:readlink: @var{filename}
37818 Read value of symbolic link @var{filename} on the target. Return
37819 the number of bytes read, or -1 if an error occurs.
37821 The data read should be returned as a binary attachment on success.
37822 If zero bytes were read, the response should include an empty binary
37823 attachment (i.e.@: a trailing semicolon). The return value is the
37824 number of target bytes read; the binary attachment may be longer if
37825 some characters were escaped.
37827 @item vFile:setfs: @var{pid}
37828 Select the filesystem on which @code{vFile} operations with
37829 @var{filename} arguments will operate. This is required for
37830 @value{GDBN} to be able to access files on remote targets where
37831 the remote stub does not share a common filesystem with the
37834 If @var{pid} is nonzero, select the filesystem as seen by process
37835 @var{pid}. If @var{pid} is zero, select the filesystem as seen by
37836 the remote stub. Return 0 on success, or -1 if an error occurs.
37837 If @code{vFile:setfs:} indicates success, the selected filesystem
37838 remains selected until the next successful @code{vFile:setfs:}
37844 @section Interrupts
37845 @cindex interrupts (remote protocol)
37847 When a program on the remote target is running, @value{GDBN} may
37848 attempt to interrupt it by sending a @samp{Ctrl-C}, @code{BREAK} or
37849 a @code{BREAK} followed by @code{g},
37850 control of which is specified via @value{GDBN}'s @samp{interrupt-sequence}.
37852 The precise meaning of @code{BREAK} is defined by the transport
37853 mechanism and may, in fact, be undefined. @value{GDBN} does not
37854 currently define a @code{BREAK} mechanism for any of the network
37855 interfaces except for TCP, in which case @value{GDBN} sends the
37856 @code{telnet} BREAK sequence.
37858 @samp{Ctrl-C}, on the other hand, is defined and implemented for all
37859 transport mechanisms. It is represented by sending the single byte
37860 @code{0x03} without any of the usual packet overhead described in
37861 the Overview section (@pxref{Overview}). When a @code{0x03} byte is
37862 transmitted as part of a packet, it is considered to be packet data
37863 and does @emph{not} represent an interrupt. E.g., an @samp{X} packet
37864 (@pxref{X packet}), used for binary downloads, may include an unescaped
37865 @code{0x03} as part of its packet.
37867 @code{BREAK} followed by @code{g} is also known as Magic SysRq g.
37868 When Linux kernel receives this sequence from serial port,
37869 it stops execution and connects to gdb.
37871 Stubs are not required to recognize these interrupt mechanisms and the
37872 precise meaning associated with receipt of the interrupt is
37873 implementation defined. If the target supports debugging of multiple
37874 threads and/or processes, it should attempt to interrupt all
37875 currently-executing threads and processes.
37876 If the stub is successful at interrupting the
37877 running program, it should send one of the stop
37878 reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result
37879 of successfully stopping the program in all-stop mode, and a stop reply
37880 for each stopped thread in non-stop mode.
37881 Interrupts received while the
37882 program is stopped are discarded.
37884 @node Notification Packets
37885 @section Notification Packets
37886 @cindex notification packets
37887 @cindex packets, notification
37889 The @value{GDBN} remote serial protocol includes @dfn{notifications},
37890 packets that require no acknowledgment. Both the GDB and the stub
37891 may send notifications (although the only notifications defined at
37892 present are sent by the stub). Notifications carry information
37893 without incurring the round-trip latency of an acknowledgment, and so
37894 are useful for low-impact communications where occasional packet loss
37897 A notification packet has the form @samp{% @var{data} #
37898 @var{checksum}}, where @var{data} is the content of the notification,
37899 and @var{checksum} is a checksum of @var{data}, computed and formatted
37900 as for ordinary @value{GDBN} packets. A notification's @var{data}
37901 never contains @samp{$}, @samp{%} or @samp{#} characters. Upon
37902 receiving a notification, the recipient sends no @samp{+} or @samp{-}
37903 to acknowledge the notification's receipt or to report its corruption.
37905 Every notification's @var{data} begins with a name, which contains no
37906 colon characters, followed by a colon character.
37908 Recipients should silently ignore corrupted notifications and
37909 notifications they do not understand. Recipients should restart
37910 timeout periods on receipt of a well-formed notification, whether or
37911 not they understand it.
37913 Senders should only send the notifications described here when this
37914 protocol description specifies that they are permitted. In the
37915 future, we may extend the protocol to permit existing notifications in
37916 new contexts; this rule helps older senders avoid confusing newer
37919 (Older versions of @value{GDBN} ignore bytes received until they see
37920 the @samp{$} byte that begins an ordinary packet, so new stubs may
37921 transmit notifications without fear of confusing older clients. There
37922 are no notifications defined for @value{GDBN} to send at the moment, but we
37923 assume that most older stubs would ignore them, as well.)
37925 Each notification is comprised of three parts:
37927 @item @var{name}:@var{event}
37928 The notification packet is sent by the side that initiates the
37929 exchange (currently, only the stub does that), with @var{event}
37930 carrying the specific information about the notification, and
37931 @var{name} specifying the name of the notification.
37933 The acknowledge sent by the other side, usually @value{GDBN}, to
37934 acknowledge the exchange and request the event.
37937 The purpose of an asynchronous notification mechanism is to report to
37938 @value{GDBN} that something interesting happened in the remote stub.
37940 The remote stub may send notification @var{name}:@var{event}
37941 at any time, but @value{GDBN} acknowledges the notification when
37942 appropriate. The notification event is pending before @value{GDBN}
37943 acknowledges. Only one notification at a time may be pending; if
37944 additional events occur before @value{GDBN} has acknowledged the
37945 previous notification, they must be queued by the stub for later
37946 synchronous transmission in response to @var{ack} packets from
37947 @value{GDBN}. Because the notification mechanism is unreliable,
37948 the stub is permitted to resend a notification if it believes
37949 @value{GDBN} may not have received it.
37951 Specifically, notifications may appear when @value{GDBN} is not
37952 otherwise reading input from the stub, or when @value{GDBN} is
37953 expecting to read a normal synchronous response or a
37954 @samp{+}/@samp{-} acknowledgment to a packet it has sent.
37955 Notification packets are distinct from any other communication from
37956 the stub so there is no ambiguity.
37958 After receiving a notification, @value{GDBN} shall acknowledge it by
37959 sending a @var{ack} packet as a regular, synchronous request to the
37960 stub. Such acknowledgment is not required to happen immediately, as
37961 @value{GDBN} is permitted to send other, unrelated packets to the
37962 stub first, which the stub should process normally.
37964 Upon receiving a @var{ack} packet, if the stub has other queued
37965 events to report to @value{GDBN}, it shall respond by sending a
37966 normal @var{event}. @value{GDBN} shall then send another @var{ack}
37967 packet to solicit further responses; again, it is permitted to send
37968 other, unrelated packets as well which the stub should process
37971 If the stub receives a @var{ack} packet and there are no additional
37972 @var{event} to report, the stub shall return an @samp{OK} response.
37973 At this point, @value{GDBN} has finished processing a notification
37974 and the stub has completed sending any queued events. @value{GDBN}
37975 won't accept any new notifications until the final @samp{OK} is
37976 received . If further notification events occur, the stub shall send
37977 a new notification, @value{GDBN} shall accept the notification, and
37978 the process shall be repeated.
37980 The process of asynchronous notification can be illustrated by the
37983 <- @code{%%Stop:T0505:98e7ffbf;04:4ce6ffbf;08:b1b6e54c;thread:p7526.7526;core:0;}
37986 <- @code{T0505:68f37db7;04:40f37db7;08:63850408;thread:p7526.7528;core:0;}
37988 <- @code{T0505:68e3fdb6;04:40e3fdb6;08:63850408;thread:p7526.7529;core:0;}
37993 The following notifications are defined:
37994 @multitable @columnfractions 0.12 0.12 0.38 0.38
38003 @tab @var{reply}. The @var{reply} has the form of a stop reply, as
38004 described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop},
38005 for information on how these notifications are acknowledged by
38007 @tab Report an asynchronous stop event in non-stop mode.
38011 @node Remote Non-Stop
38012 @section Remote Protocol Support for Non-Stop Mode
38014 @value{GDBN}'s remote protocol supports non-stop debugging of
38015 multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub
38016 supports non-stop mode, it should report that to @value{GDBN} by including
38017 @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}).
38019 @value{GDBN} typically sends a @samp{QNonStop} packet only when
38020 establishing a new connection with the stub. Entering non-stop mode
38021 does not alter the state of any currently-running threads, but targets
38022 must stop all threads in any already-attached processes when entering
38023 all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to
38024 probe the target state after a mode change.
38026 In non-stop mode, when an attached process encounters an event that
38027 would otherwise be reported with a stop reply, it uses the
38028 asynchronous notification mechanism (@pxref{Notification Packets}) to
38029 inform @value{GDBN}. In contrast to all-stop mode, where all threads
38030 in all processes are stopped when a stop reply is sent, in non-stop
38031 mode only the thread reporting the stop event is stopped. That is,
38032 when reporting a @samp{S} or @samp{T} response to indicate completion
38033 of a step operation, hitting a breakpoint, or a fault, only the
38034 affected thread is stopped; any other still-running threads continue
38035 to run. When reporting a @samp{W} or @samp{X} response, all running
38036 threads belonging to other attached processes continue to run.
38038 In non-stop mode, the target shall respond to the @samp{?} packet as
38039 follows. First, any incomplete stop reply notification/@samp{vStopped}
38040 sequence in progress is abandoned. The target must begin a new
38041 sequence reporting stop events for all stopped threads, whether or not
38042 it has previously reported those events to @value{GDBN}. The first
38043 stop reply is sent as a synchronous reply to the @samp{?} packet, and
38044 subsequent stop replies are sent as responses to @samp{vStopped} packets
38045 using the mechanism described above. The target must not send
38046 asynchronous stop reply notifications until the sequence is complete.
38047 If all threads are running when the target receives the @samp{?} packet,
38048 or if the target is not attached to any process, it shall respond
38051 If the stub supports non-stop mode, it should also support the
38052 @samp{swbreak} stop reason if software breakpoints are supported, and
38053 the @samp{hwbreak} stop reason if hardware breakpoints are supported
38054 (@pxref{swbreak stop reason}). This is because given the asynchronous
38055 nature of non-stop mode, between the time a thread hits a breakpoint
38056 and the time the event is finally processed by @value{GDBN}, the
38057 breakpoint may have already been removed from the target. Due to
38058 this, @value{GDBN} needs to be able to tell whether a trap stop was
38059 caused by a delayed breakpoint event, which should be ignored, as
38060 opposed to a random trap signal, which should be reported to the user.
38061 Note the @samp{swbreak} feature implies that the target is responsible
38062 for adjusting the PC when a software breakpoint triggers, if
38063 necessary, such as on the x86 architecture.
38065 @node Packet Acknowledgment
38066 @section Packet Acknowledgment
38068 @cindex acknowledgment, for @value{GDBN} remote
38069 @cindex packet acknowledgment, for @value{GDBN} remote
38070 By default, when either the host or the target machine receives a packet,
38071 the first response expected is an acknowledgment: either @samp{+} (to indicate
38072 the package was received correctly) or @samp{-} (to request retransmission).
38073 This mechanism allows the @value{GDBN} remote protocol to operate over
38074 unreliable transport mechanisms, such as a serial line.
38076 In cases where the transport mechanism is itself reliable (such as a pipe or
38077 TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant.
38078 It may be desirable to disable them in that case to reduce communication
38079 overhead, or for other reasons. This can be accomplished by means of the
38080 @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}.
38082 When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or
38083 expect @samp{+}/@samp{-} protocol acknowledgments. The packet
38084 and response format still includes the normal checksum, as described in
38085 @ref{Overview}, but the checksum may be ignored by the receiver.
38087 If the stub supports @samp{QStartNoAckMode} and prefers to operate in
38088 no-acknowledgment mode, it should report that to @value{GDBN}
38089 by including @samp{QStartNoAckMode+} in its response to @samp{qSupported};
38090 @pxref{qSupported}.
38091 If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been
38092 disabled via the @code{set remote noack-packet off} command
38093 (@pxref{Remote Configuration}),
38094 @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub.
38095 Only then may the stub actually turn off packet acknowledgments.
38096 @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK}
38097 response, which can be safely ignored by the stub.
38099 Note that @code{set remote noack-packet} command only affects negotiation
38100 between @value{GDBN} and the stub when subsequent connections are made;
38101 it does not affect the protocol acknowledgment state for any current
38103 Since @samp{+}/@samp{-} acknowledgments are enabled by default when a
38104 new connection is established,
38105 there is also no protocol request to re-enable the acknowledgments
38106 for the current connection, once disabled.
38111 Example sequence of a target being re-started. Notice how the restart
38112 does not get any direct output:
38117 @emph{target restarts}
38120 <- @code{T001:1234123412341234}
38124 Example sequence of a target being stepped by a single instruction:
38127 -> @code{G1445@dots{}}
38132 <- @code{T001:1234123412341234}
38136 <- @code{1455@dots{}}
38140 @node File-I/O Remote Protocol Extension
38141 @section File-I/O Remote Protocol Extension
38142 @cindex File-I/O remote protocol extension
38145 * File-I/O Overview::
38146 * Protocol Basics::
38147 * The F Request Packet::
38148 * The F Reply Packet::
38149 * The Ctrl-C Message::
38151 * List of Supported Calls::
38152 * Protocol-specific Representation of Datatypes::
38154 * File-I/O Examples::
38157 @node File-I/O Overview
38158 @subsection File-I/O Overview
38159 @cindex file-i/o overview
38161 The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the
38162 target to use the host's file system and console I/O to perform various
38163 system calls. System calls on the target system are translated into a
38164 remote protocol packet to the host system, which then performs the needed
38165 actions and returns a response packet to the target system.
38166 This simulates file system operations even on targets that lack file systems.
38168 The protocol is defined to be independent of both the host and target systems.
38169 It uses its own internal representation of datatypes and values. Both
38170 @value{GDBN} and the target's @value{GDBN} stub are responsible for
38171 translating the system-dependent value representations into the internal
38172 protocol representations when data is transmitted.
38174 The communication is synchronous. A system call is possible only when
38175 @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S}
38176 or @samp{s} packets. While @value{GDBN} handles the request for a system call,
38177 the target is stopped to allow deterministic access to the target's
38178 memory. Therefore File-I/O is not interruptible by target signals. On
38179 the other hand, it is possible to interrupt File-I/O by a user interrupt
38180 (@samp{Ctrl-C}) within @value{GDBN}.
38182 The target's request to perform a host system call does not finish
38183 the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means,
38184 after finishing the system call, the target returns to continuing the
38185 previous activity (continue, step). No additional continue or step
38186 request from @value{GDBN} is required.
38189 (@value{GDBP}) continue
38190 <- target requests 'system call X'
38191 target is stopped, @value{GDBN} executes system call
38192 -> @value{GDBN} returns result
38193 ... target continues, @value{GDBN} returns to wait for the target
38194 <- target hits breakpoint and sends a Txx packet
38197 The protocol only supports I/O on the console and to regular files on
38198 the host file system. Character or block special devices, pipes,
38199 named pipes, sockets or any other communication method on the host
38200 system are not supported by this protocol.
38202 File I/O is not supported in non-stop mode.
38204 @node Protocol Basics
38205 @subsection Protocol Basics
38206 @cindex protocol basics, file-i/o
38208 The File-I/O protocol uses the @code{F} packet as the request as well
38209 as reply packet. Since a File-I/O system call can only occur when
38210 @value{GDBN} is waiting for a response from the continuing or stepping target,
38211 the File-I/O request is a reply that @value{GDBN} has to expect as a result
38212 of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet.
38213 This @code{F} packet contains all information needed to allow @value{GDBN}
38214 to call the appropriate host system call:
38218 A unique identifier for the requested system call.
38221 All parameters to the system call. Pointers are given as addresses
38222 in the target memory address space. Pointers to strings are given as
38223 pointer/length pair. Numerical values are given as they are.
38224 Numerical control flags are given in a protocol-specific representation.
38228 At this point, @value{GDBN} has to perform the following actions.
38232 If the parameters include pointer values to data needed as input to a
38233 system call, @value{GDBN} requests this data from the target with a
38234 standard @code{m} packet request. This additional communication has to be
38235 expected by the target implementation and is handled as any other @code{m}
38239 @value{GDBN} translates all value from protocol representation to host
38240 representation as needed. Datatypes are coerced into the host types.
38243 @value{GDBN} calls the system call.
38246 It then coerces datatypes back to protocol representation.
38249 If the system call is expected to return data in buffer space specified
38250 by pointer parameters to the call, the data is transmitted to the
38251 target using a @code{M} or @code{X} packet. This packet has to be expected
38252 by the target implementation and is handled as any other @code{M} or @code{X}
38257 Eventually @value{GDBN} replies with another @code{F} packet which contains all
38258 necessary information for the target to continue. This at least contains
38265 @code{errno}, if has been changed by the system call.
38272 After having done the needed type and value coercion, the target continues
38273 the latest continue or step action.
38275 @node The F Request Packet
38276 @subsection The @code{F} Request Packet
38277 @cindex file-i/o request packet
38278 @cindex @code{F} request packet
38280 The @code{F} request packet has the following format:
38283 @item F@var{call-id},@var{parameter@dots{}}
38285 @var{call-id} is the identifier to indicate the host system call to be called.
38286 This is just the name of the function.
38288 @var{parameter@dots{}} are the parameters to the system call.
38289 Parameters are hexadecimal integer values, either the actual values in case
38290 of scalar datatypes, pointers to target buffer space in case of compound
38291 datatypes and unspecified memory areas, or pointer/length pairs in case
38292 of string parameters. These are appended to the @var{call-id} as a
38293 comma-delimited list. All values are transmitted in ASCII
38294 string representation, pointer/length pairs separated by a slash.
38300 @node The F Reply Packet
38301 @subsection The @code{F} Reply Packet
38302 @cindex file-i/o reply packet
38303 @cindex @code{F} reply packet
38305 The @code{F} reply packet has the following format:
38309 @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment}
38311 @var{retcode} is the return code of the system call as hexadecimal value.
38313 @var{errno} is the @code{errno} set by the call, in protocol-specific
38315 This parameter can be omitted if the call was successful.
38317 @var{Ctrl-C flag} is only sent if the user requested a break. In this
38318 case, @var{errno} must be sent as well, even if the call was successful.
38319 The @var{Ctrl-C flag} itself consists of the character @samp{C}:
38326 or, if the call was interrupted before the host call has been performed:
38333 assuming 4 is the protocol-specific representation of @code{EINTR}.
38338 @node The Ctrl-C Message
38339 @subsection The @samp{Ctrl-C} Message
38340 @cindex ctrl-c message, in file-i/o protocol
38342 If the @samp{Ctrl-C} flag is set in the @value{GDBN}
38343 reply packet (@pxref{The F Reply Packet}),
38344 the target should behave as if it had
38345 gotten a break message. The meaning for the target is ``system call
38346 interrupted by @code{SIGINT}''. Consequentially, the target should actually stop
38347 (as with a break message) and return to @value{GDBN} with a @code{T02}
38350 It's important for the target to know in which
38351 state the system call was interrupted. There are two possible cases:
38355 The system call hasn't been performed on the host yet.
38358 The system call on the host has been finished.
38362 These two states can be distinguished by the target by the value of the
38363 returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system
38364 call hasn't been performed. This is equivalent to the @code{EINTR} handling
38365 on POSIX systems. In any other case, the target may presume that the
38366 system call has been finished --- successfully or not --- and should behave
38367 as if the break message arrived right after the system call.
38369 @value{GDBN} must behave reliably. If the system call has not been called
38370 yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as
38371 @code{errno} in the packet. If the system call on the host has been finished
38372 before the user requests a break, the full action must be finished by
38373 @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary.
38374 The @code{F} packet may only be sent when either nothing has happened
38375 or the full action has been completed.
38378 @subsection Console I/O
38379 @cindex console i/o as part of file-i/o
38381 By default and if not explicitly closed by the target system, the file
38382 descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output
38383 on the @value{GDBN} console is handled as any other file output operation
38384 (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled
38385 by @value{GDBN} so that after the target read request from file descriptor
38386 0 all following typing is buffered until either one of the following
38391 The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the
38393 system call is treated as finished.
38396 The user presses @key{RET}. This is treated as end of input with a trailing
38400 The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing
38401 character (neither newline nor @samp{Ctrl-D}) is appended to the input.
38405 If the user has typed more characters than fit in the buffer given to
38406 the @code{read} call, the trailing characters are buffered in @value{GDBN} until
38407 either another @code{read(0, @dots{})} is requested by the target, or debugging
38408 is stopped at the user's request.
38411 @node List of Supported Calls
38412 @subsection List of Supported Calls
38413 @cindex list of supported file-i/o calls
38430 @unnumberedsubsubsec open
38431 @cindex open, file-i/o system call
38436 int open(const char *pathname, int flags);
38437 int open(const char *pathname, int flags, mode_t mode);
38441 @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}}
38444 @var{flags} is the bitwise @code{OR} of the following values:
38448 If the file does not exist it will be created. The host
38449 rules apply as far as file ownership and time stamps
38453 When used with @code{O_CREAT}, if the file already exists it is
38454 an error and open() fails.
38457 If the file already exists and the open mode allows
38458 writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be
38459 truncated to zero length.
38462 The file is opened in append mode.
38465 The file is opened for reading only.
38468 The file is opened for writing only.
38471 The file is opened for reading and writing.
38475 Other bits are silently ignored.
38479 @var{mode} is the bitwise @code{OR} of the following values:
38483 User has read permission.
38486 User has write permission.
38489 Group has read permission.
38492 Group has write permission.
38495 Others have read permission.
38498 Others have write permission.
38502 Other bits are silently ignored.
38505 @item Return value:
38506 @code{open} returns the new file descriptor or -1 if an error
38513 @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used.
38516 @var{pathname} refers to a directory.
38519 The requested access is not allowed.
38522 @var{pathname} was too long.
38525 A directory component in @var{pathname} does not exist.
38528 @var{pathname} refers to a device, pipe, named pipe or socket.
38531 @var{pathname} refers to a file on a read-only filesystem and
38532 write access was requested.
38535 @var{pathname} is an invalid pointer value.
38538 No space on device to create the file.
38541 The process already has the maximum number of files open.
38544 The limit on the total number of files open on the system
38548 The call was interrupted by the user.
38554 @unnumberedsubsubsec close
38555 @cindex close, file-i/o system call
38564 @samp{Fclose,@var{fd}}
38566 @item Return value:
38567 @code{close} returns zero on success, or -1 if an error occurred.
38573 @var{fd} isn't a valid open file descriptor.
38576 The call was interrupted by the user.
38582 @unnumberedsubsubsec read
38583 @cindex read, file-i/o system call
38588 int read(int fd, void *buf, unsigned int count);
38592 @samp{Fread,@var{fd},@var{bufptr},@var{count}}
38594 @item Return value:
38595 On success, the number of bytes read is returned.
38596 Zero indicates end of file. If count is zero, read
38597 returns zero as well. On error, -1 is returned.
38603 @var{fd} is not a valid file descriptor or is not open for
38607 @var{bufptr} is an invalid pointer value.
38610 The call was interrupted by the user.
38616 @unnumberedsubsubsec write
38617 @cindex write, file-i/o system call
38622 int write(int fd, const void *buf, unsigned int count);
38626 @samp{Fwrite,@var{fd},@var{bufptr},@var{count}}
38628 @item Return value:
38629 On success, the number of bytes written are returned.
38630 Zero indicates nothing was written. On error, -1
38637 @var{fd} is not a valid file descriptor or is not open for
38641 @var{bufptr} is an invalid pointer value.
38644 An attempt was made to write a file that exceeds the
38645 host-specific maximum file size allowed.
38648 No space on device to write the data.
38651 The call was interrupted by the user.
38657 @unnumberedsubsubsec lseek
38658 @cindex lseek, file-i/o system call
38663 long lseek (int fd, long offset, int flag);
38667 @samp{Flseek,@var{fd},@var{offset},@var{flag}}
38669 @var{flag} is one of:
38673 The offset is set to @var{offset} bytes.
38676 The offset is set to its current location plus @var{offset}
38680 The offset is set to the size of the file plus @var{offset}
38684 @item Return value:
38685 On success, the resulting unsigned offset in bytes from
38686 the beginning of the file is returned. Otherwise, a
38687 value of -1 is returned.
38693 @var{fd} is not a valid open file descriptor.
38696 @var{fd} is associated with the @value{GDBN} console.
38699 @var{flag} is not a proper value.
38702 The call was interrupted by the user.
38708 @unnumberedsubsubsec rename
38709 @cindex rename, file-i/o system call
38714 int rename(const char *oldpath, const char *newpath);
38718 @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}}
38720 @item Return value:
38721 On success, zero is returned. On error, -1 is returned.
38727 @var{newpath} is an existing directory, but @var{oldpath} is not a
38731 @var{newpath} is a non-empty directory.
38734 @var{oldpath} or @var{newpath} is a directory that is in use by some
38738 An attempt was made to make a directory a subdirectory
38742 A component used as a directory in @var{oldpath} or new
38743 path is not a directory. Or @var{oldpath} is a directory
38744 and @var{newpath} exists but is not a directory.
38747 @var{oldpathptr} or @var{newpathptr} are invalid pointer values.
38750 No access to the file or the path of the file.
38754 @var{oldpath} or @var{newpath} was too long.
38757 A directory component in @var{oldpath} or @var{newpath} does not exist.
38760 The file is on a read-only filesystem.
38763 The device containing the file has no room for the new
38767 The call was interrupted by the user.
38773 @unnumberedsubsubsec unlink
38774 @cindex unlink, file-i/o system call
38779 int unlink(const char *pathname);
38783 @samp{Funlink,@var{pathnameptr}/@var{len}}
38785 @item Return value:
38786 On success, zero is returned. On error, -1 is returned.
38792 No access to the file or the path of the file.
38795 The system does not allow unlinking of directories.
38798 The file @var{pathname} cannot be unlinked because it's
38799 being used by another process.
38802 @var{pathnameptr} is an invalid pointer value.
38805 @var{pathname} was too long.
38808 A directory component in @var{pathname} does not exist.
38811 A component of the path is not a directory.
38814 The file is on a read-only filesystem.
38817 The call was interrupted by the user.
38823 @unnumberedsubsubsec stat/fstat
38824 @cindex fstat, file-i/o system call
38825 @cindex stat, file-i/o system call
38830 int stat(const char *pathname, struct stat *buf);
38831 int fstat(int fd, struct stat *buf);
38835 @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@*
38836 @samp{Ffstat,@var{fd},@var{bufptr}}
38838 @item Return value:
38839 On success, zero is returned. On error, -1 is returned.
38845 @var{fd} is not a valid open file.
38848 A directory component in @var{pathname} does not exist or the
38849 path is an empty string.
38852 A component of the path is not a directory.
38855 @var{pathnameptr} is an invalid pointer value.
38858 No access to the file or the path of the file.
38861 @var{pathname} was too long.
38864 The call was interrupted by the user.
38870 @unnumberedsubsubsec gettimeofday
38871 @cindex gettimeofday, file-i/o system call
38876 int gettimeofday(struct timeval *tv, void *tz);
38880 @samp{Fgettimeofday,@var{tvptr},@var{tzptr}}
38882 @item Return value:
38883 On success, 0 is returned, -1 otherwise.
38889 @var{tz} is a non-NULL pointer.
38892 @var{tvptr} and/or @var{tzptr} is an invalid pointer value.
38898 @unnumberedsubsubsec isatty
38899 @cindex isatty, file-i/o system call
38904 int isatty(int fd);
38908 @samp{Fisatty,@var{fd}}
38910 @item Return value:
38911 Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise.
38917 The call was interrupted by the user.
38922 Note that the @code{isatty} call is treated as a special case: it returns
38923 1 to the target if the file descriptor is attached
38924 to the @value{GDBN} console, 0 otherwise. Implementing through system calls
38925 would require implementing @code{ioctl} and would be more complex than
38930 @unnumberedsubsubsec system
38931 @cindex system, file-i/o system call
38936 int system(const char *command);
38940 @samp{Fsystem,@var{commandptr}/@var{len}}
38942 @item Return value:
38943 If @var{len} is zero, the return value indicates whether a shell is
38944 available. A zero return value indicates a shell is not available.
38945 For non-zero @var{len}, the value returned is -1 on error and the
38946 return status of the command otherwise. Only the exit status of the
38947 command is returned, which is extracted from the host's @code{system}
38948 return value by calling @code{WEXITSTATUS(retval)}. In case
38949 @file{/bin/sh} could not be executed, 127 is returned.
38955 The call was interrupted by the user.
38960 @value{GDBN} takes over the full task of calling the necessary host calls
38961 to perform the @code{system} call. The return value of @code{system} on
38962 the host is simplified before it's returned
38963 to the target. Any termination signal information from the child process
38964 is discarded, and the return value consists
38965 entirely of the exit status of the called command.
38967 Due to security concerns, the @code{system} call is by default refused
38968 by @value{GDBN}. The user has to allow this call explicitly with the
38969 @code{set remote system-call-allowed 1} command.
38972 @item set remote system-call-allowed
38973 @kindex set remote system-call-allowed
38974 Control whether to allow the @code{system} calls in the File I/O
38975 protocol for the remote target. The default is zero (disabled).
38977 @item show remote system-call-allowed
38978 @kindex show remote system-call-allowed
38979 Show whether the @code{system} calls are allowed in the File I/O
38983 @node Protocol-specific Representation of Datatypes
38984 @subsection Protocol-specific Representation of Datatypes
38985 @cindex protocol-specific representation of datatypes, in file-i/o protocol
38988 * Integral Datatypes::
38990 * Memory Transfer::
38995 @node Integral Datatypes
38996 @unnumberedsubsubsec Integral Datatypes
38997 @cindex integral datatypes, in file-i/o protocol
38999 The integral datatypes used in the system calls are @code{int},
39000 @code{unsigned int}, @code{long}, @code{unsigned long},
39001 @code{mode_t}, and @code{time_t}.
39003 @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are
39004 implemented as 32 bit values in this protocol.
39006 @code{long} and @code{unsigned long} are implemented as 64 bit types.
39008 @xref{Limits}, for corresponding MIN and MAX values (similar to those
39009 in @file{limits.h}) to allow range checking on host and target.
39011 @code{time_t} datatypes are defined as seconds since the Epoch.
39013 All integral datatypes transferred as part of a memory read or write of a
39014 structured datatype e.g.@: a @code{struct stat} have to be given in big endian
39017 @node Pointer Values
39018 @unnumberedsubsubsec Pointer Values
39019 @cindex pointer values, in file-i/o protocol
39021 Pointers to target data are transmitted as they are. An exception
39022 is made for pointers to buffers for which the length isn't
39023 transmitted as part of the function call, namely strings. Strings
39024 are transmitted as a pointer/length pair, both as hex values, e.g.@:
39031 which is a pointer to data of length 18 bytes at position 0x1aaf.
39032 The length is defined as the full string length in bytes, including
39033 the trailing null byte. For example, the string @code{"hello world"}
39034 at address 0x123456 is transmitted as
39040 @node Memory Transfer
39041 @unnumberedsubsubsec Memory Transfer
39042 @cindex memory transfer, in file-i/o protocol
39044 Structured data which is transferred using a memory read or write (for
39045 example, a @code{struct stat}) is expected to be in a protocol-specific format
39046 with all scalar multibyte datatypes being big endian. Translation to
39047 this representation needs to be done both by the target before the @code{F}
39048 packet is sent, and by @value{GDBN} before
39049 it transfers memory to the target. Transferred pointers to structured
39050 data should point to the already-coerced data at any time.
39054 @unnumberedsubsubsec struct stat
39055 @cindex struct stat, in file-i/o protocol
39057 The buffer of type @code{struct stat} used by the target and @value{GDBN}
39058 is defined as follows:
39062 unsigned int st_dev; /* device */
39063 unsigned int st_ino; /* inode */
39064 mode_t st_mode; /* protection */
39065 unsigned int st_nlink; /* number of hard links */
39066 unsigned int st_uid; /* user ID of owner */
39067 unsigned int st_gid; /* group ID of owner */
39068 unsigned int st_rdev; /* device type (if inode device) */
39069 unsigned long st_size; /* total size, in bytes */
39070 unsigned long st_blksize; /* blocksize for filesystem I/O */
39071 unsigned long st_blocks; /* number of blocks allocated */
39072 time_t st_atime; /* time of last access */
39073 time_t st_mtime; /* time of last modification */
39074 time_t st_ctime; /* time of last change */
39078 The integral datatypes conform to the definitions given in the
39079 appropriate section (see @ref{Integral Datatypes}, for details) so this
39080 structure is of size 64 bytes.
39082 The values of several fields have a restricted meaning and/or
39088 A value of 0 represents a file, 1 the console.
39091 No valid meaning for the target. Transmitted unchanged.
39094 Valid mode bits are described in @ref{Constants}. Any other
39095 bits have currently no meaning for the target.
39100 No valid meaning for the target. Transmitted unchanged.
39105 These values have a host and file system dependent
39106 accuracy. Especially on Windows hosts, the file system may not
39107 support exact timing values.
39110 The target gets a @code{struct stat} of the above representation and is
39111 responsible for coercing it to the target representation before
39114 Note that due to size differences between the host, target, and protocol
39115 representations of @code{struct stat} members, these members could eventually
39116 get truncated on the target.
39118 @node struct timeval
39119 @unnumberedsubsubsec struct timeval
39120 @cindex struct timeval, in file-i/o protocol
39122 The buffer of type @code{struct timeval} used by the File-I/O protocol
39123 is defined as follows:
39127 time_t tv_sec; /* second */
39128 long tv_usec; /* microsecond */
39132 The integral datatypes conform to the definitions given in the
39133 appropriate section (see @ref{Integral Datatypes}, for details) so this
39134 structure is of size 8 bytes.
39137 @subsection Constants
39138 @cindex constants, in file-i/o protocol
39140 The following values are used for the constants inside of the
39141 protocol. @value{GDBN} and target are responsible for translating these
39142 values before and after the call as needed.
39153 @unnumberedsubsubsec Open Flags
39154 @cindex open flags, in file-i/o protocol
39156 All values are given in hexadecimal representation.
39168 @node mode_t Values
39169 @unnumberedsubsubsec mode_t Values
39170 @cindex mode_t values, in file-i/o protocol
39172 All values are given in octal representation.
39189 @unnumberedsubsubsec Errno Values
39190 @cindex errno values, in file-i/o protocol
39192 All values are given in decimal representation.
39217 @code{EUNKNOWN} is used as a fallback error value if a host system returns
39218 any error value not in the list of supported error numbers.
39221 @unnumberedsubsubsec Lseek Flags
39222 @cindex lseek flags, in file-i/o protocol
39231 @unnumberedsubsubsec Limits
39232 @cindex limits, in file-i/o protocol
39234 All values are given in decimal representation.
39237 INT_MIN -2147483648
39239 UINT_MAX 4294967295
39240 LONG_MIN -9223372036854775808
39241 LONG_MAX 9223372036854775807
39242 ULONG_MAX 18446744073709551615
39245 @node File-I/O Examples
39246 @subsection File-I/O Examples
39247 @cindex file-i/o examples
39249 Example sequence of a write call, file descriptor 3, buffer is at target
39250 address 0x1234, 6 bytes should be written:
39253 <- @code{Fwrite,3,1234,6}
39254 @emph{request memory read from target}
39257 @emph{return "6 bytes written"}
39261 Example sequence of a read call, file descriptor 3, buffer is at target
39262 address 0x1234, 6 bytes should be read:
39265 <- @code{Fread,3,1234,6}
39266 @emph{request memory write to target}
39267 -> @code{X1234,6:XXXXXX}
39268 @emph{return "6 bytes read"}
39272 Example sequence of a read call, call fails on the host due to invalid
39273 file descriptor (@code{EBADF}):
39276 <- @code{Fread,3,1234,6}
39280 Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on
39284 <- @code{Fread,3,1234,6}
39289 Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on
39293 <- @code{Fread,3,1234,6}
39294 -> @code{X1234,6:XXXXXX}
39298 @node Library List Format
39299 @section Library List Format
39300 @cindex library list format, remote protocol
39302 On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the
39303 same process as your application to manage libraries. In this case,
39304 @value{GDBN} can use the loader's symbol table and normal memory
39305 operations to maintain a list of shared libraries. On other
39306 platforms, the operating system manages loaded libraries.
39307 @value{GDBN} can not retrieve the list of currently loaded libraries
39308 through memory operations, so it uses the @samp{qXfer:libraries:read}
39309 packet (@pxref{qXfer library list read}) instead. The remote stub
39310 queries the target's operating system and reports which libraries
39313 The @samp{qXfer:libraries:read} packet returns an XML document which
39314 lists loaded libraries and their offsets. Each library has an
39315 associated name and one or more segment or section base addresses,
39316 which report where the library was loaded in memory.
39318 For the common case of libraries that are fully linked binaries, the
39319 library should have a list of segments. If the target supports
39320 dynamic linking of a relocatable object file, its library XML element
39321 should instead include a list of allocated sections. The segment or
39322 section bases are start addresses, not relocation offsets; they do not
39323 depend on the library's link-time base addresses.
39325 @value{GDBN} must be linked with the Expat library to support XML
39326 library lists. @xref{Expat}.
39328 A simple memory map, with one loaded library relocated by a single
39329 offset, looks like this:
39333 <library name="/lib/libc.so.6">
39334 <segment address="0x10000000"/>
39339 Another simple memory map, with one loaded library with three
39340 allocated sections (.text, .data, .bss), looks like this:
39344 <library name="sharedlib.o">
39345 <section address="0x10000000"/>
39346 <section address="0x20000000"/>
39347 <section address="0x30000000"/>
39352 The format of a library list is described by this DTD:
39355 <!-- library-list: Root element with versioning -->
39356 <!ELEMENT library-list (library)*>
39357 <!ATTLIST library-list version CDATA #FIXED "1.0">
39358 <!ELEMENT library (segment*, section*)>
39359 <!ATTLIST library name CDATA #REQUIRED>
39360 <!ELEMENT segment EMPTY>
39361 <!ATTLIST segment address CDATA #REQUIRED>
39362 <!ELEMENT section EMPTY>
39363 <!ATTLIST section address CDATA #REQUIRED>
39366 In addition, segments and section descriptors cannot be mixed within a
39367 single library element, and you must supply at least one segment or
39368 section for each library.
39370 @node Library List Format for SVR4 Targets
39371 @section Library List Format for SVR4 Targets
39372 @cindex library list format, remote protocol
39374 On SVR4 platforms @value{GDBN} can use the symbol table of a dynamic loader
39375 (e.g.@: @file{ld.so}) and normal memory operations to maintain a list of
39376 shared libraries. Still a special library list provided by this packet is
39377 more efficient for the @value{GDBN} remote protocol.
39379 The @samp{qXfer:libraries-svr4:read} packet returns an XML document which lists
39380 loaded libraries and their SVR4 linker parameters. For each library on SVR4
39381 target, the following parameters are reported:
39385 @code{name}, the absolute file name from the @code{l_name} field of
39386 @code{struct link_map}.
39388 @code{lm} with address of @code{struct link_map} used for TLS
39389 (Thread Local Storage) access.
39391 @code{l_addr}, the displacement as read from the field @code{l_addr} of
39392 @code{struct link_map}. For prelinked libraries this is not an absolute
39393 memory address. It is a displacement of absolute memory address against
39394 address the file was prelinked to during the library load.
39396 @code{l_ld}, which is memory address of the @code{PT_DYNAMIC} segment
39399 Additionally the single @code{main-lm} attribute specifies address of
39400 @code{struct link_map} used for the main executable. This parameter is used
39401 for TLS access and its presence is optional.
39403 @value{GDBN} must be linked with the Expat library to support XML
39404 SVR4 library lists. @xref{Expat}.
39406 A simple memory map, with two loaded libraries (which do not use prelink),
39410 <library-list-svr4 version="1.0" main-lm="0xe4f8f8">
39411 <library name="/lib/ld-linux.so.2" lm="0xe4f51c" l_addr="0xe2d000"
39413 <library name="/lib/libc.so.6" lm="0xe4fbe8" l_addr="0x154000"
39415 </library-list-svr>
39418 The format of an SVR4 library list is described by this DTD:
39421 <!-- library-list-svr4: Root element with versioning -->
39422 <!ELEMENT library-list-svr4 (library)*>
39423 <!ATTLIST library-list-svr4 version CDATA #FIXED "1.0">
39424 <!ATTLIST library-list-svr4 main-lm CDATA #IMPLIED>
39425 <!ELEMENT library EMPTY>
39426 <!ATTLIST library name CDATA #REQUIRED>
39427 <!ATTLIST library lm CDATA #REQUIRED>
39428 <!ATTLIST library l_addr CDATA #REQUIRED>
39429 <!ATTLIST library l_ld CDATA #REQUIRED>
39432 @node Memory Map Format
39433 @section Memory Map Format
39434 @cindex memory map format
39436 To be able to write into flash memory, @value{GDBN} needs to obtain a
39437 memory map from the target. This section describes the format of the
39440 The memory map is obtained using the @samp{qXfer:memory-map:read}
39441 (@pxref{qXfer memory map read}) packet and is an XML document that
39442 lists memory regions.
39444 @value{GDBN} must be linked with the Expat library to support XML
39445 memory maps. @xref{Expat}.
39447 The top-level structure of the document is shown below:
39450 <?xml version="1.0"?>
39451 <!DOCTYPE memory-map
39452 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
39453 "http://sourceware.org/gdb/gdb-memory-map.dtd">
39459 Each region can be either:
39464 A region of RAM starting at @var{addr} and extending for @var{length}
39468 <memory type="ram" start="@var{addr}" length="@var{length}"/>
39473 A region of read-only memory:
39476 <memory type="rom" start="@var{addr}" length="@var{length}"/>
39481 A region of flash memory, with erasure blocks @var{blocksize}
39485 <memory type="flash" start="@var{addr}" length="@var{length}">
39486 <property name="blocksize">@var{blocksize}</property>
39492 Regions must not overlap. @value{GDBN} assumes that areas of memory not covered
39493 by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X}
39494 packets to write to addresses in such ranges.
39496 The formal DTD for memory map format is given below:
39499 <!-- ................................................... -->
39500 <!-- Memory Map XML DTD ................................ -->
39501 <!-- File: memory-map.dtd .............................. -->
39502 <!-- .................................... .............. -->
39503 <!-- memory-map.dtd -->
39504 <!-- memory-map: Root element with versioning -->
39505 <!ELEMENT memory-map (memory | property)>
39506 <!ATTLIST memory-map version CDATA #FIXED "1.0.0">
39507 <!ELEMENT memory (property)>
39508 <!-- memory: Specifies a memory region,
39509 and its type, or device. -->
39510 <!ATTLIST memory type CDATA #REQUIRED
39511 start CDATA #REQUIRED
39512 length CDATA #REQUIRED
39513 device CDATA #IMPLIED>
39514 <!-- property: Generic attribute tag -->
39515 <!ELEMENT property (#PCDATA | property)*>
39516 <!ATTLIST property name CDATA #REQUIRED>
39519 @node Thread List Format
39520 @section Thread List Format
39521 @cindex thread list format
39523 To efficiently update the list of threads and their attributes,
39524 @value{GDBN} issues the @samp{qXfer:threads:read} packet
39525 (@pxref{qXfer threads read}) and obtains the XML document with
39526 the following structure:
39529 <?xml version="1.0"?>
39531 <thread id="id" core="0">
39532 ... description ...
39537 Each @samp{thread} element must have the @samp{id} attribute that
39538 identifies the thread (@pxref{thread-id syntax}). The
39539 @samp{core} attribute, if present, specifies which processor core
39540 the thread was last executing on. The content of the of @samp{thread}
39541 element is interpreted as human-readable auxilliary information.
39543 @node Traceframe Info Format
39544 @section Traceframe Info Format
39545 @cindex traceframe info format
39547 To be able to know which objects in the inferior can be examined when
39548 inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of
39549 memory ranges, registers and trace state variables that have been
39550 collected in a traceframe.
39552 This list is obtained using the @samp{qXfer:traceframe-info:read}
39553 (@pxref{qXfer traceframe info read}) packet and is an XML document.
39555 @value{GDBN} must be linked with the Expat library to support XML
39556 traceframe info discovery. @xref{Expat}.
39558 The top-level structure of the document is shown below:
39561 <?xml version="1.0"?>
39562 <!DOCTYPE traceframe-info
39563 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
39564 "http://sourceware.org/gdb/gdb-traceframe-info.dtd">
39570 Each traceframe block can be either:
39575 A region of collected memory starting at @var{addr} and extending for
39576 @var{length} bytes from there:
39579 <memory start="@var{addr}" length="@var{length}"/>
39583 A block indicating trace state variable numbered @var{number} has been
39587 <tvar id="@var{number}"/>
39592 The formal DTD for the traceframe info format is given below:
39595 <!ELEMENT traceframe-info (memory | tvar)* >
39596 <!ATTLIST traceframe-info version CDATA #FIXED "1.0">
39598 <!ELEMENT memory EMPTY>
39599 <!ATTLIST memory start CDATA #REQUIRED
39600 length CDATA #REQUIRED>
39602 <!ATTLIST tvar id CDATA #REQUIRED>
39605 @node Branch Trace Format
39606 @section Branch Trace Format
39607 @cindex branch trace format
39609 In order to display the branch trace of an inferior thread,
39610 @value{GDBN} needs to obtain the list of branches. This list is
39611 represented as list of sequential code blocks that are connected via
39612 branches. The code in each block has been executed sequentially.
39614 This list is obtained using the @samp{qXfer:btrace:read}
39615 (@pxref{qXfer btrace read}) packet and is an XML document.
39617 @value{GDBN} must be linked with the Expat library to support XML
39618 traceframe info discovery. @xref{Expat}.
39620 The top-level structure of the document is shown below:
39623 <?xml version="1.0"?>
39625 PUBLIC "+//IDN gnu.org//DTD GDB Branch Trace V1.0//EN"
39626 "http://sourceware.org/gdb/gdb-btrace.dtd">
39635 A block of sequentially executed instructions starting at @var{begin}
39636 and ending at @var{end}:
39639 <block begin="@var{begin}" end="@var{end}"/>
39644 The formal DTD for the branch trace format is given below:
39647 <!ELEMENT btrace (block* | pt) >
39648 <!ATTLIST btrace version CDATA #FIXED "1.0">
39650 <!ELEMENT block EMPTY>
39651 <!ATTLIST block begin CDATA #REQUIRED
39652 end CDATA #REQUIRED>
39654 <!ELEMENT pt (pt-config?, raw?)>
39656 <!ELEMENT pt-config (cpu?)>
39658 <!ELEMENT cpu EMPTY>
39659 <!ATTLIST cpu vendor CDATA #REQUIRED
39660 family CDATA #REQUIRED
39661 model CDATA #REQUIRED
39662 stepping CDATA #REQUIRED>
39664 <!ELEMENT raw (#PCDATA)>
39667 @node Branch Trace Configuration Format
39668 @section Branch Trace Configuration Format
39669 @cindex branch trace configuration format
39671 For each inferior thread, @value{GDBN} can obtain the branch trace
39672 configuration using the @samp{qXfer:btrace-conf:read}
39673 (@pxref{qXfer btrace-conf read}) packet.
39675 The configuration describes the branch trace format and configuration
39676 settings for that format. The following information is described:
39680 This thread uses the @dfn{Branch Trace Store} (@acronym{BTS}) format.
39683 The size of the @acronym{BTS} ring buffer in bytes.
39686 This thread uses the @dfn{Intel(R) Processor Trace} (@acronym{Intel(R)
39690 The size of the @acronym{Intel(R) PT} ring buffer in bytes.
39694 @value{GDBN} must be linked with the Expat library to support XML
39695 branch trace configuration discovery. @xref{Expat}.
39697 The formal DTD for the branch trace configuration format is given below:
39700 <!ELEMENT btrace-conf (bts?, pt?)>
39701 <!ATTLIST btrace-conf version CDATA #FIXED "1.0">
39703 <!ELEMENT bts EMPTY>
39704 <!ATTLIST bts size CDATA #IMPLIED>
39706 <!ELEMENT pt EMPTY>
39707 <!ATTLIST pt size CDATA #IMPLIED>
39710 @include agentexpr.texi
39712 @node Target Descriptions
39713 @appendix Target Descriptions
39714 @cindex target descriptions
39716 One of the challenges of using @value{GDBN} to debug embedded systems
39717 is that there are so many minor variants of each processor
39718 architecture in use. It is common practice for vendors to start with
39719 a standard processor core --- ARM, PowerPC, or @acronym{MIPS}, for example ---
39720 and then make changes to adapt it to a particular market niche. Some
39721 architectures have hundreds of variants, available from dozens of
39722 vendors. This leads to a number of problems:
39726 With so many different customized processors, it is difficult for
39727 the @value{GDBN} maintainers to keep up with the changes.
39729 Since individual variants may have short lifetimes or limited
39730 audiences, it may not be worthwhile to carry information about every
39731 variant in the @value{GDBN} source tree.
39733 When @value{GDBN} does support the architecture of the embedded system
39734 at hand, the task of finding the correct architecture name to give the
39735 @command{set architecture} command can be error-prone.
39738 To address these problems, the @value{GDBN} remote protocol allows a
39739 target system to not only identify itself to @value{GDBN}, but to
39740 actually describe its own features. This lets @value{GDBN} support
39741 processor variants it has never seen before --- to the extent that the
39742 descriptions are accurate, and that @value{GDBN} understands them.
39744 @value{GDBN} must be linked with the Expat library to support XML
39745 target descriptions. @xref{Expat}.
39748 * Retrieving Descriptions:: How descriptions are fetched from a target.
39749 * Target Description Format:: The contents of a target description.
39750 * Predefined Target Types:: Standard types available for target
39752 * Standard Target Features:: Features @value{GDBN} knows about.
39755 @node Retrieving Descriptions
39756 @section Retrieving Descriptions
39758 Target descriptions can be read from the target automatically, or
39759 specified by the user manually. The default behavior is to read the
39760 description from the target. @value{GDBN} retrieves it via the remote
39761 protocol using @samp{qXfer} requests (@pxref{General Query Packets,
39762 qXfer}). The @var{annex} in the @samp{qXfer} packet will be
39763 @samp{target.xml}. The contents of the @samp{target.xml} annex are an
39764 XML document, of the form described in @ref{Target Description
39767 Alternatively, you can specify a file to read for the target description.
39768 If a file is set, the target will not be queried. The commands to
39769 specify a file are:
39772 @cindex set tdesc filename
39773 @item set tdesc filename @var{path}
39774 Read the target description from @var{path}.
39776 @cindex unset tdesc filename
39777 @item unset tdesc filename
39778 Do not read the XML target description from a file. @value{GDBN}
39779 will use the description supplied by the current target.
39781 @cindex show tdesc filename
39782 @item show tdesc filename
39783 Show the filename to read for a target description, if any.
39787 @node Target Description Format
39788 @section Target Description Format
39789 @cindex target descriptions, XML format
39791 A target description annex is an @uref{http://www.w3.org/XML/, XML}
39792 document which complies with the Document Type Definition provided in
39793 the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This
39794 means you can use generally available tools like @command{xmllint} to
39795 check that your feature descriptions are well-formed and valid.
39796 However, to help people unfamiliar with XML write descriptions for
39797 their targets, we also describe the grammar here.
39799 Target descriptions can identify the architecture of the remote target
39800 and (for some architectures) provide information about custom register
39801 sets. They can also identify the OS ABI of the remote target.
39802 @value{GDBN} can use this information to autoconfigure for your
39803 target, or to warn you if you connect to an unsupported target.
39805 Here is a simple target description:
39808 <target version="1.0">
39809 <architecture>i386:x86-64</architecture>
39814 This minimal description only says that the target uses
39815 the x86-64 architecture.
39817 A target description has the following overall form, with [ ] marking
39818 optional elements and @dots{} marking repeatable elements. The elements
39819 are explained further below.
39822 <?xml version="1.0"?>
39823 <!DOCTYPE target SYSTEM "gdb-target.dtd">
39824 <target version="1.0">
39825 @r{[}@var{architecture}@r{]}
39826 @r{[}@var{osabi}@r{]}
39827 @r{[}@var{compatible}@r{]}
39828 @r{[}@var{feature}@dots{}@r{]}
39833 The description is generally insensitive to whitespace and line
39834 breaks, under the usual common-sense rules. The XML version
39835 declaration and document type declaration can generally be omitted
39836 (@value{GDBN} does not require them), but specifying them may be
39837 useful for XML validation tools. The @samp{version} attribute for
39838 @samp{<target>} may also be omitted, but we recommend
39839 including it; if future versions of @value{GDBN} use an incompatible
39840 revision of @file{gdb-target.dtd}, they will detect and report
39841 the version mismatch.
39843 @subsection Inclusion
39844 @cindex target descriptions, inclusion
39847 @cindex <xi:include>
39850 It can sometimes be valuable to split a target description up into
39851 several different annexes, either for organizational purposes, or to
39852 share files between different possible target descriptions. You can
39853 divide a description into multiple files by replacing any element of
39854 the target description with an inclusion directive of the form:
39857 <xi:include href="@var{document}"/>
39861 When @value{GDBN} encounters an element of this form, it will retrieve
39862 the named XML @var{document}, and replace the inclusion directive with
39863 the contents of that document. If the current description was read
39864 using @samp{qXfer}, then so will be the included document;
39865 @var{document} will be interpreted as the name of an annex. If the
39866 current description was read from a file, @value{GDBN} will look for
39867 @var{document} as a file in the same directory where it found the
39868 original description.
39870 @subsection Architecture
39871 @cindex <architecture>
39873 An @samp{<architecture>} element has this form:
39876 <architecture>@var{arch}</architecture>
39879 @var{arch} is one of the architectures from the set accepted by
39880 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
39883 @cindex @code{<osabi>}
39885 This optional field was introduced in @value{GDBN} version 7.0.
39886 Previous versions of @value{GDBN} ignore it.
39888 An @samp{<osabi>} element has this form:
39891 <osabi>@var{abi-name}</osabi>
39894 @var{abi-name} is an OS ABI name from the same selection accepted by
39895 @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}).
39897 @subsection Compatible Architecture
39898 @cindex @code{<compatible>}
39900 This optional field was introduced in @value{GDBN} version 7.0.
39901 Previous versions of @value{GDBN} ignore it.
39903 A @samp{<compatible>} element has this form:
39906 <compatible>@var{arch}</compatible>
39909 @var{arch} is one of the architectures from the set accepted by
39910 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
39912 A @samp{<compatible>} element is used to specify that the target
39913 is able to run binaries in some other than the main target architecture
39914 given by the @samp{<architecture>} element. For example, on the
39915 Cell Broadband Engine, the main architecture is @code{powerpc:common}
39916 or @code{powerpc:common64}, but the system is able to run binaries
39917 in the @code{spu} architecture as well. The way to describe this
39918 capability with @samp{<compatible>} is as follows:
39921 <architecture>powerpc:common</architecture>
39922 <compatible>spu</compatible>
39925 @subsection Features
39928 Each @samp{<feature>} describes some logical portion of the target
39929 system. Features are currently used to describe available CPU
39930 registers and the types of their contents. A @samp{<feature>} element
39934 <feature name="@var{name}">
39935 @r{[}@var{type}@dots{}@r{]}
39941 Each feature's name should be unique within the description. The name
39942 of a feature does not matter unless @value{GDBN} has some special
39943 knowledge of the contents of that feature; if it does, the feature
39944 should have its standard name. @xref{Standard Target Features}.
39948 Any register's value is a collection of bits which @value{GDBN} must
39949 interpret. The default interpretation is a two's complement integer,
39950 but other types can be requested by name in the register description.
39951 Some predefined types are provided by @value{GDBN} (@pxref{Predefined
39952 Target Types}), and the description can define additional composite types.
39954 Each type element must have an @samp{id} attribute, which gives
39955 a unique (within the containing @samp{<feature>}) name to the type.
39956 Types must be defined before they are used.
39959 Some targets offer vector registers, which can be treated as arrays
39960 of scalar elements. These types are written as @samp{<vector>} elements,
39961 specifying the array element type, @var{type}, and the number of elements,
39965 <vector id="@var{id}" type="@var{type}" count="@var{count}"/>
39969 If a register's value is usefully viewed in multiple ways, define it
39970 with a union type containing the useful representations. The
39971 @samp{<union>} element contains one or more @samp{<field>} elements,
39972 each of which has a @var{name} and a @var{type}:
39975 <union id="@var{id}">
39976 <field name="@var{name}" type="@var{type}"/>
39982 If a register's value is composed from several separate values, define
39983 it with a structure type. There are two forms of the @samp{<struct>}
39984 element; a @samp{<struct>} element must either contain only bitfields
39985 or contain no bitfields. If the structure contains only bitfields,
39986 its total size in bytes must be specified, each bitfield must have an
39987 explicit start and end, and bitfields are automatically assigned an
39988 integer type. The field's @var{start} should be less than or
39989 equal to its @var{end}, and zero represents the least significant bit.
39992 <struct id="@var{id}" size="@var{size}">
39993 <field name="@var{name}" start="@var{start}" end="@var{end}"/>
39998 If the structure contains no bitfields, then each field has an
39999 explicit type, and no implicit padding is added.
40002 <struct id="@var{id}">
40003 <field name="@var{name}" type="@var{type}"/>
40009 If a register's value is a series of single-bit flags, define it with
40010 a flags type. The @samp{<flags>} element has an explicit @var{size}
40011 and contains one or more @samp{<field>} elements. Each field has a
40012 @var{name}, a @var{start}, and an @var{end}. Only single-bit flags
40016 <flags id="@var{id}" size="@var{size}">
40017 <field name="@var{name}" start="@var{start}" end="@var{end}"/>
40022 @subsection Registers
40025 Each register is represented as an element with this form:
40028 <reg name="@var{name}"
40029 bitsize="@var{size}"
40030 @r{[}regnum="@var{num}"@r{]}
40031 @r{[}save-restore="@var{save-restore}"@r{]}
40032 @r{[}type="@var{type}"@r{]}
40033 @r{[}group="@var{group}"@r{]}/>
40037 The components are as follows:
40042 The register's name; it must be unique within the target description.
40045 The register's size, in bits.
40048 The register's number. If omitted, a register's number is one greater
40049 than that of the previous register (either in the current feature or in
40050 a preceding feature); the first register in the target description
40051 defaults to zero. This register number is used to read or write
40052 the register; e.g.@: it is used in the remote @code{p} and @code{P}
40053 packets, and registers appear in the @code{g} and @code{G} packets
40054 in order of increasing register number.
40057 Whether the register should be preserved across inferior function
40058 calls; this must be either @code{yes} or @code{no}. The default is
40059 @code{yes}, which is appropriate for most registers except for
40060 some system control registers; this is not related to the target's
40064 The type of the register. It may be a predefined type, a type
40065 defined in the current feature, or one of the special types @code{int}
40066 and @code{float}. @code{int} is an integer type of the correct size
40067 for @var{bitsize}, and @code{float} is a floating point type (in the
40068 architecture's normal floating point format) of the correct size for
40069 @var{bitsize}. The default is @code{int}.
40072 The register group to which this register belongs. It must
40073 be either @code{general}, @code{float}, or @code{vector}. If no
40074 @var{group} is specified, @value{GDBN} will not display the register
40075 in @code{info registers}.
40079 @node Predefined Target Types
40080 @section Predefined Target Types
40081 @cindex target descriptions, predefined types
40083 Type definitions in the self-description can build up composite types
40084 from basic building blocks, but can not define fundamental types. Instead,
40085 standard identifiers are provided by @value{GDBN} for the fundamental
40086 types. The currently supported types are:
40095 Signed integer types holding the specified number of bits.
40102 Unsigned integer types holding the specified number of bits.
40106 Pointers to unspecified code and data. The program counter and
40107 any dedicated return address register may be marked as code
40108 pointers; printing a code pointer converts it into a symbolic
40109 address. The stack pointer and any dedicated address registers
40110 may be marked as data pointers.
40113 Single precision IEEE floating point.
40116 Double precision IEEE floating point.
40119 The 12-byte extended precision format used by ARM FPA registers.
40122 The 10-byte extended precision format used by x87 registers.
40125 32bit @sc{eflags} register used by x86.
40128 32bit @sc{mxcsr} register used by x86.
40132 @node Standard Target Features
40133 @section Standard Target Features
40134 @cindex target descriptions, standard features
40136 A target description must contain either no registers or all the
40137 target's registers. If the description contains no registers, then
40138 @value{GDBN} will assume a default register layout, selected based on
40139 the architecture. If the description contains any registers, the
40140 default layout will not be used; the standard registers must be
40141 described in the target description, in such a way that @value{GDBN}
40142 can recognize them.
40144 This is accomplished by giving specific names to feature elements
40145 which contain standard registers. @value{GDBN} will look for features
40146 with those names and verify that they contain the expected registers;
40147 if any known feature is missing required registers, or if any required
40148 feature is missing, @value{GDBN} will reject the target
40149 description. You can add additional registers to any of the
40150 standard features --- @value{GDBN} will display them just as if
40151 they were added to an unrecognized feature.
40153 This section lists the known features and their expected contents.
40154 Sample XML documents for these features are included in the
40155 @value{GDBN} source tree, in the directory @file{gdb/features}.
40157 Names recognized by @value{GDBN} should include the name of the
40158 company or organization which selected the name, and the overall
40159 architecture to which the feature applies; so e.g.@: the feature
40160 containing ARM core registers is named @samp{org.gnu.gdb.arm.core}.
40162 The names of registers are not case sensitive for the purpose
40163 of recognizing standard features, but @value{GDBN} will only display
40164 registers using the capitalization used in the description.
40167 * AArch64 Features::
40170 * MicroBlaze Features::
40173 * Nios II Features::
40174 * PowerPC Features::
40175 * S/390 and System z Features::
40180 @node AArch64 Features
40181 @subsection AArch64 Features
40182 @cindex target descriptions, AArch64 features
40184 The @samp{org.gnu.gdb.aarch64.core} feature is required for AArch64
40185 targets. It should contain registers @samp{x0} through @samp{x30},
40186 @samp{sp}, @samp{pc}, and @samp{cpsr}.
40188 The @samp{org.gnu.gdb.aarch64.fpu} feature is optional. If present,
40189 it should contain registers @samp{v0} through @samp{v31}, @samp{fpsr},
40193 @subsection ARM Features
40194 @cindex target descriptions, ARM features
40196 The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile
40198 It should contain registers @samp{r0} through @samp{r13}, @samp{sp},
40199 @samp{lr}, @samp{pc}, and @samp{cpsr}.
40201 For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core}
40202 feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain
40203 registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc},
40206 The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it
40207 should contain registers @samp{f0} through @samp{f7} and @samp{fps}.
40209 The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present,
40210 it should contain at least registers @samp{wR0} through @samp{wR15} and
40211 @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon},
40212 @samp{wCSSF}, and @samp{wCASF} registers are optional.
40214 The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it
40215 should contain at least registers @samp{d0} through @samp{d15}. If
40216 they are present, @samp{d16} through @samp{d31} should also be included.
40217 @value{GDBN} will synthesize the single-precision registers from
40218 halves of the double-precision registers.
40220 The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not
40221 need to contain registers; it instructs @value{GDBN} to display the
40222 VFP double-precision registers as vectors and to synthesize the
40223 quad-precision registers from pairs of double-precision registers.
40224 If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also
40225 be present and include 32 double-precision registers.
40227 @node i386 Features
40228 @subsection i386 Features
40229 @cindex target descriptions, i386 features
40231 The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64
40232 targets. It should describe the following registers:
40236 @samp{eax} through @samp{edi} plus @samp{eip} for i386
40238 @samp{rax} through @samp{r15} plus @samp{rip} for amd64
40240 @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es},
40241 @samp{fs}, @samp{gs}
40243 @samp{st0} through @samp{st7}
40245 @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff},
40246 @samp{foseg}, @samp{fooff} and @samp{fop}
40249 The register sets may be different, depending on the target.
40251 The @samp{org.gnu.gdb.i386.sse} feature is optional. It should
40252 describe registers:
40256 @samp{xmm0} through @samp{xmm7} for i386
40258 @samp{xmm0} through @samp{xmm15} for amd64
40263 The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the
40264 @samp{org.gnu.gdb.i386.sse} feature. It should
40265 describe the upper 128 bits of @sc{ymm} registers:
40269 @samp{ymm0h} through @samp{ymm7h} for i386
40271 @samp{ymm0h} through @samp{ymm15h} for amd64
40274 The @samp{org.gnu.gdb.i386.mpx} is an optional feature representing Intel(R)
40275 Memory Protection Extension (MPX). It should describe the following registers:
40279 @samp{bnd0raw} through @samp{bnd3raw} for i386 and amd64.
40281 @samp{bndcfgu} and @samp{bndstatus} for i386 and amd64.
40284 The @samp{org.gnu.gdb.i386.linux} feature is optional. It should
40285 describe a single register, @samp{orig_eax}.
40287 The @samp{org.gnu.gdb.i386.avx512} feature is optional and requires the
40288 @samp{org.gnu.gdb.i386.avx} feature. It should
40289 describe additional @sc{xmm} registers:
40293 @samp{xmm16h} through @samp{xmm31h}, only valid for amd64.
40296 It should describe the upper 128 bits of additional @sc{ymm} registers:
40300 @samp{ymm16h} through @samp{ymm31h}, only valid for amd64.
40304 describe the upper 256 bits of @sc{zmm} registers:
40308 @samp{zmm0h} through @samp{zmm7h} for i386.
40310 @samp{zmm0h} through @samp{zmm15h} for amd64.
40314 describe the additional @sc{zmm} registers:
40318 @samp{zmm16h} through @samp{zmm31h}, only valid for amd64.
40321 @node MicroBlaze Features
40322 @subsection MicroBlaze Features
40323 @cindex target descriptions, MicroBlaze features
40325 The @samp{org.gnu.gdb.microblaze.core} feature is required for MicroBlaze
40326 targets. It should contain registers @samp{r0} through @samp{r31},
40327 @samp{rpc}, @samp{rmsr}, @samp{rear}, @samp{resr}, @samp{rfsr}, @samp{rbtr},
40328 @samp{rpvr}, @samp{rpvr1} through @samp{rpvr11}, @samp{redr}, @samp{rpid},
40329 @samp{rzpr}, @samp{rtlbx}, @samp{rtlbsx}, @samp{rtlblo}, and @samp{rtlbhi}.
40331 The @samp{org.gnu.gdb.microblaze.stack-protect} feature is optional.
40332 If present, it should contain registers @samp{rshr} and @samp{rslr}
40334 @node MIPS Features
40335 @subsection @acronym{MIPS} Features
40336 @cindex target descriptions, @acronym{MIPS} features
40338 The @samp{org.gnu.gdb.mips.cpu} feature is required for @acronym{MIPS} targets.
40339 It should contain registers @samp{r0} through @samp{r31}, @samp{lo},
40340 @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending
40343 The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should
40344 contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause}
40345 registers. They may be 32-bit or 64-bit depending on the target.
40347 The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though
40348 it may be optional in a future version of @value{GDBN}. It should
40349 contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and
40350 @samp{fir}. They may be 32-bit or 64-bit depending on the target.
40352 The @samp{org.gnu.gdb.mips.dsp} feature is optional. It should
40353 contain registers @samp{hi1} through @samp{hi3}, @samp{lo1} through
40354 @samp{lo3}, and @samp{dspctl}. The @samp{dspctl} register should
40355 be 32-bit and the rest may be 32-bit or 64-bit depending on the target.
40357 The @samp{org.gnu.gdb.mips.linux} feature is optional. It should
40358 contain a single register, @samp{restart}, which is used by the
40359 Linux kernel to control restartable syscalls.
40361 @node M68K Features
40362 @subsection M68K Features
40363 @cindex target descriptions, M68K features
40366 @item @samp{org.gnu.gdb.m68k.core}
40367 @itemx @samp{org.gnu.gdb.coldfire.core}
40368 @itemx @samp{org.gnu.gdb.fido.core}
40369 One of those features must be always present.
40370 The feature that is present determines which flavor of m68k is
40371 used. The feature that is present should contain registers
40372 @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
40373 @samp{sp}, @samp{ps} and @samp{pc}.
40375 @item @samp{org.gnu.gdb.coldfire.fp}
40376 This feature is optional. If present, it should contain registers
40377 @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
40381 @node Nios II Features
40382 @subsection Nios II Features
40383 @cindex target descriptions, Nios II features
40385 The @samp{org.gnu.gdb.nios2.cpu} feature is required for Nios II
40386 targets. It should contain the 32 core registers (@samp{zero},
40387 @samp{at}, @samp{r2} through @samp{r23}, @samp{et} through @samp{ra}),
40388 @samp{pc}, and the 16 control registers (@samp{status} through
40391 @node PowerPC Features
40392 @subsection PowerPC Features
40393 @cindex target descriptions, PowerPC features
40395 The @samp{org.gnu.gdb.power.core} feature is required for PowerPC
40396 targets. It should contain registers @samp{r0} through @samp{r31},
40397 @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and
40398 @samp{xer}. They may be 32-bit or 64-bit depending on the target.
40400 The @samp{org.gnu.gdb.power.fpu} feature is optional. It should
40401 contain registers @samp{f0} through @samp{f31} and @samp{fpscr}.
40403 The @samp{org.gnu.gdb.power.altivec} feature is optional. It should
40404 contain registers @samp{vr0} through @samp{vr31}, @samp{vscr},
40407 The @samp{org.gnu.gdb.power.vsx} feature is optional. It should
40408 contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN}
40409 will combine these registers with the floating point registers
40410 (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0}
40411 through @samp{vr31}) to present the 128-bit wide registers @samp{vs0}
40412 through @samp{vs63}, the set of vector registers for POWER7.
40414 The @samp{org.gnu.gdb.power.spe} feature is optional. It should
40415 contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and
40416 @samp{spefscr}. SPE targets should provide 32-bit registers in
40417 @samp{org.gnu.gdb.power.core} and provide the upper halves in
40418 @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine
40419 these to present registers @samp{ev0} through @samp{ev31} to the
40422 @node S/390 and System z Features
40423 @subsection S/390 and System z Features
40424 @cindex target descriptions, S/390 features
40425 @cindex target descriptions, System z features
40427 The @samp{org.gnu.gdb.s390.core} feature is required for S/390 and
40428 System z targets. It should contain the PSW and the 16 general
40429 registers. In particular, System z targets should provide the 64-bit
40430 registers @samp{pswm}, @samp{pswa}, and @samp{r0} through @samp{r15}.
40431 S/390 targets should provide the 32-bit versions of these registers.
40432 A System z target that runs in 31-bit addressing mode should provide
40433 32-bit versions of @samp{pswm} and @samp{pswa}, as well as the general
40434 register's upper halves @samp{r0h} through @samp{r15h}, and their
40435 lower halves @samp{r0l} through @samp{r15l}.
40437 The @samp{org.gnu.gdb.s390.fpr} feature is required. It should
40438 contain the 64-bit registers @samp{f0} through @samp{f15}, and
40441 The @samp{org.gnu.gdb.s390.acr} feature is required. It should
40442 contain the 32-bit registers @samp{acr0} through @samp{acr15}.
40444 The @samp{org.gnu.gdb.s390.linux} feature is optional. It should
40445 contain the register @samp{orig_r2}, which is 64-bit wide on System z
40446 targets and 32-bit otherwise. In addition, the feature may contain
40447 the @samp{last_break} register, whose width depends on the addressing
40448 mode, as well as the @samp{system_call} register, which is always
40451 The @samp{org.gnu.gdb.s390.tdb} feature is optional. It should
40452 contain the 64-bit registers @samp{tdb0}, @samp{tac}, @samp{tct},
40453 @samp{atia}, and @samp{tr0} through @samp{tr15}.
40455 The @samp{org.gnu.gdb.s390.vx} feature is optional. It should contain
40456 64-bit wide registers @samp{v0l} through @samp{v15l}, which will be
40457 combined by @value{GDBN} with the floating point registers @samp{f0}
40458 through @samp{f15} to present the 128-bit wide vector registers
40459 @samp{v0} through @samp{v15}. In addition, this feature should
40460 contain the 128-bit wide vector registers @samp{v16} through
40463 @node TIC6x Features
40464 @subsection TMS320C6x Features
40465 @cindex target descriptions, TIC6x features
40466 @cindex target descriptions, TMS320C6x features
40467 The @samp{org.gnu.gdb.tic6x.core} feature is required for TMS320C6x
40468 targets. It should contain registers @samp{A0} through @samp{A15},
40469 registers @samp{B0} through @samp{B15}, @samp{CSR} and @samp{PC}.
40471 The @samp{org.gnu.gdb.tic6x.gp} feature is optional. It should
40472 contain registers @samp{A16} through @samp{A31} and @samp{B16}
40473 through @samp{B31}.
40475 The @samp{org.gnu.gdb.tic6x.c6xp} feature is optional. It should
40476 contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}.
40478 @node Operating System Information
40479 @appendix Operating System Information
40480 @cindex operating system information
40486 Users of @value{GDBN} often wish to obtain information about the state of
40487 the operating system running on the target---for example the list of
40488 processes, or the list of open files. This section describes the
40489 mechanism that makes it possible. This mechanism is similar to the
40490 target features mechanism (@pxref{Target Descriptions}), but focuses
40491 on a different aspect of target.
40493 Operating system information is retrived from the target via the
40494 remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata
40495 read}). The object name in the request should be @samp{osdata}, and
40496 the @var{annex} identifies the data to be fetched.
40499 @appendixsection Process list
40500 @cindex operating system information, process list
40502 When requesting the process list, the @var{annex} field in the
40503 @samp{qXfer} request should be @samp{processes}. The returned data is
40504 an XML document. The formal syntax of this document is defined in
40505 @file{gdb/features/osdata.dtd}.
40507 An example document is:
40510 <?xml version="1.0"?>
40511 <!DOCTYPE target SYSTEM "osdata.dtd">
40512 <osdata type="processes">
40514 <column name="pid">1</column>
40515 <column name="user">root</column>
40516 <column name="command">/sbin/init</column>
40517 <column name="cores">1,2,3</column>
40522 Each item should include a column whose name is @samp{pid}. The value
40523 of that column should identify the process on the target. The
40524 @samp{user} and @samp{command} columns are optional, and will be
40525 displayed by @value{GDBN}. The @samp{cores} column, if present,
40526 should contain a comma-separated list of cores that this process
40527 is running on. Target may provide additional columns,
40528 which @value{GDBN} currently ignores.
40530 @node Trace File Format
40531 @appendix Trace File Format
40532 @cindex trace file format
40534 The trace file comes in three parts: a header, a textual description
40535 section, and a trace frame section with binary data.
40537 The header has the form @code{\x7fTRACE0\n}. The first byte is
40538 @code{0x7f} so as to indicate that the file contains binary data,
40539 while the @code{0} is a version number that may have different values
40542 The description section consists of multiple lines of @sc{ascii} text
40543 separated by newline characters (@code{0xa}). The lines may include a
40544 variety of optional descriptive or context-setting information, such
40545 as tracepoint definitions or register set size. @value{GDBN} will
40546 ignore any line that it does not recognize. An empty line marks the end
40549 @c FIXME add some specific types of data
40551 The trace frame section consists of a number of consecutive frames.
40552 Each frame begins with a two-byte tracepoint number, followed by a
40553 four-byte size giving the amount of data in the frame. The data in
40554 the frame consists of a number of blocks, each introduced by a
40555 character indicating its type (at least register, memory, and trace
40556 state variable). The data in this section is raw binary, not a
40557 hexadecimal or other encoding; its endianness matches the target's
40560 @c FIXME bi-arch may require endianness/arch info in description section
40563 @item R @var{bytes}
40564 Register block. The number and ordering of bytes matches that of a
40565 @code{g} packet in the remote protocol. Note that these are the
40566 actual bytes, in target order and @value{GDBN} register order, not a
40567 hexadecimal encoding.
40569 @item M @var{address} @var{length} @var{bytes}...
40570 Memory block. This is a contiguous block of memory, at the 8-byte
40571 address @var{address}, with a 2-byte length @var{length}, followed by
40572 @var{length} bytes.
40574 @item V @var{number} @var{value}
40575 Trace state variable block. This records the 8-byte signed value
40576 @var{value} of trace state variable numbered @var{number}.
40580 Future enhancements of the trace file format may include additional types
40583 @node Index Section Format
40584 @appendix @code{.gdb_index} section format
40585 @cindex .gdb_index section format
40586 @cindex index section format
40588 This section documents the index section that is created by @code{save
40589 gdb-index} (@pxref{Index Files}). The index section is
40590 DWARF-specific; some knowledge of DWARF is assumed in this
40593 The mapped index file format is designed to be directly
40594 @code{mmap}able on any architecture. In most cases, a datum is
40595 represented using a little-endian 32-bit integer value, called an
40596 @code{offset_type}. Big endian machines must byte-swap the values
40597 before using them. Exceptions to this rule are noted. The data is
40598 laid out such that alignment is always respected.
40600 A mapped index consists of several areas, laid out in order.
40604 The file header. This is a sequence of values, of @code{offset_type}
40605 unless otherwise noted:
40609 The version number, currently 8. Versions 1, 2 and 3 are obsolete.
40610 Version 4 uses a different hashing function from versions 5 and 6.
40611 Version 6 includes symbols for inlined functions, whereas versions 4
40612 and 5 do not. Version 7 adds attributes to the CU indices in the
40613 symbol table. Version 8 specifies that symbols from DWARF type units
40614 (@samp{DW_TAG_type_unit}) refer to the type unit's symbol table and not the
40615 compilation unit (@samp{DW_TAG_comp_unit}) using the type.
40617 @value{GDBN} will only read version 4, 5, or 6 indices
40618 by specifying @code{set use-deprecated-index-sections on}.
40619 GDB has a workaround for potentially broken version 7 indices so it is
40620 currently not flagged as deprecated.
40623 The offset, from the start of the file, of the CU list.
40626 The offset, from the start of the file, of the types CU list. Note
40627 that this area can be empty, in which case this offset will be equal
40628 to the next offset.
40631 The offset, from the start of the file, of the address area.
40634 The offset, from the start of the file, of the symbol table.
40637 The offset, from the start of the file, of the constant pool.
40641 The CU list. This is a sequence of pairs of 64-bit little-endian
40642 values, sorted by the CU offset. The first element in each pair is
40643 the offset of a CU in the @code{.debug_info} section. The second
40644 element in each pair is the length of that CU. References to a CU
40645 elsewhere in the map are done using a CU index, which is just the
40646 0-based index into this table. Note that if there are type CUs, then
40647 conceptually CUs and type CUs form a single list for the purposes of
40651 The types CU list. This is a sequence of triplets of 64-bit
40652 little-endian values. In a triplet, the first value is the CU offset,
40653 the second value is the type offset in the CU, and the third value is
40654 the type signature. The types CU list is not sorted.
40657 The address area. The address area consists of a sequence of address
40658 entries. Each address entry has three elements:
40662 The low address. This is a 64-bit little-endian value.
40665 The high address. This is a 64-bit little-endian value. Like
40666 @code{DW_AT_high_pc}, the value is one byte beyond the end.
40669 The CU index. This is an @code{offset_type} value.
40673 The symbol table. This is an open-addressed hash table. The size of
40674 the hash table is always a power of 2.
40676 Each slot in the hash table consists of a pair of @code{offset_type}
40677 values. The first value is the offset of the symbol's name in the
40678 constant pool. The second value is the offset of the CU vector in the
40681 If both values are 0, then this slot in the hash table is empty. This
40682 is ok because while 0 is a valid constant pool index, it cannot be a
40683 valid index for both a string and a CU vector.
40685 The hash value for a table entry is computed by applying an
40686 iterative hash function to the symbol's name. Starting with an
40687 initial value of @code{r = 0}, each (unsigned) character @samp{c} in
40688 the string is incorporated into the hash using the formula depending on the
40693 The formula is @code{r = r * 67 + c - 113}.
40695 @item Versions 5 to 7
40696 The formula is @code{r = r * 67 + tolower (c) - 113}.
40699 The terminating @samp{\0} is not incorporated into the hash.
40701 The step size used in the hash table is computed via
40702 @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash
40703 value, and @samp{size} is the size of the hash table. The step size
40704 is used to find the next candidate slot when handling a hash
40707 The names of C@t{++} symbols in the hash table are canonicalized. We
40708 don't currently have a simple description of the canonicalization
40709 algorithm; if you intend to create new index sections, you must read
40713 The constant pool. This is simply a bunch of bytes. It is organized
40714 so that alignment is correct: CU vectors are stored first, followed by
40717 A CU vector in the constant pool is a sequence of @code{offset_type}
40718 values. The first value is the number of CU indices in the vector.
40719 Each subsequent value is the index and symbol attributes of a CU in
40720 the CU list. This element in the hash table is used to indicate which
40721 CUs define the symbol and how the symbol is used.
40722 See below for the format of each CU index+attributes entry.
40724 A string in the constant pool is zero-terminated.
40727 Attributes were added to CU index values in @code{.gdb_index} version 7.
40728 If a symbol has multiple uses within a CU then there is one
40729 CU index+attributes value for each use.
40731 The format of each CU index+attributes entry is as follows
40737 This is the index of the CU in the CU list.
40739 These bits are reserved for future purposes and must be zero.
40741 The kind of the symbol in the CU.
40745 This value is reserved and should not be used.
40746 By reserving zero the full @code{offset_type} value is backwards compatible
40747 with previous versions of the index.
40749 The symbol is a type.
40751 The symbol is a variable or an enum value.
40753 The symbol is a function.
40755 Any other kind of symbol.
40757 These values are reserved.
40761 This bit is zero if the value is global and one if it is static.
40763 The determination of whether a symbol is global or static is complicated.
40764 The authorative reference is the file @file{dwarf2read.c} in
40765 @value{GDBN} sources.
40769 This pseudo-code describes the computation of a symbol's kind and
40770 global/static attributes in the index.
40773 is_external = get_attribute (die, DW_AT_external);
40774 language = get_attribute (cu_die, DW_AT_language);
40777 case DW_TAG_typedef:
40778 case DW_TAG_base_type:
40779 case DW_TAG_subrange_type:
40783 case DW_TAG_enumerator:
40785 is_static = (language != CPLUS && language != JAVA);
40787 case DW_TAG_subprogram:
40789 is_static = ! (is_external || language == ADA);
40791 case DW_TAG_constant:
40793 is_static = ! is_external;
40795 case DW_TAG_variable:
40797 is_static = ! is_external;
40799 case DW_TAG_namespace:
40803 case DW_TAG_class_type:
40804 case DW_TAG_interface_type:
40805 case DW_TAG_structure_type:
40806 case DW_TAG_union_type:
40807 case DW_TAG_enumeration_type:
40809 is_static = (language != CPLUS && language != JAVA);
40817 @appendix Manual pages
40821 * gdb man:: The GNU Debugger man page
40822 * gdbserver man:: Remote Server for the GNU Debugger man page
40823 * gcore man:: Generate a core file of a running program
40824 * gdbinit man:: gdbinit scripts
40830 @c man title gdb The GNU Debugger
40832 @c man begin SYNOPSIS gdb
40833 gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
40834 [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
40835 [@option{-b}@w{ }@var{bps}]
40836 [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
40837 [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
40838 [@option{-c}@w{ }@var{core}] [@option{-p}@w{ }@var{procID}]
40839 [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}]
40840 [@var{prog}|@var{prog} @var{procID}|@var{prog} @var{core}]
40843 @c man begin DESCRIPTION gdb
40844 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
40845 going on ``inside'' another program while it executes -- or what another
40846 program was doing at the moment it crashed.
40848 @value{GDBN} can do four main kinds of things (plus other things in support of
40849 these) to help you catch bugs in the act:
40853 Start your program, specifying anything that might affect its behavior.
40856 Make your program stop on specified conditions.
40859 Examine what has happened, when your program has stopped.
40862 Change things in your program, so you can experiment with correcting the
40863 effects of one bug and go on to learn about another.
40866 You can use @value{GDBN} to debug programs written in C, C@t{++}, Fortran and
40869 @value{GDBN} is invoked with the shell command @code{gdb}. Once started, it reads
40870 commands from the terminal until you tell it to exit with the @value{GDBN}
40871 command @code{quit}. You can get online help from @value{GDBN} itself
40872 by using the command @code{help}.
40874 You can run @code{gdb} with no arguments or options; but the most
40875 usual way to start @value{GDBN} is with one argument or two, specifying an
40876 executable program as the argument:
40882 You can also start with both an executable program and a core file specified:
40888 You can, instead, specify a process ID as a second argument, if you want
40889 to debug a running process:
40897 would attach @value{GDBN} to process @code{1234} (unless you also have a file
40898 named @file{1234}; @value{GDBN} does check for a core file first).
40899 With option @option{-p} you can omit the @var{program} filename.
40901 Here are some of the most frequently needed @value{GDBN} commands:
40903 @c pod2man highlights the right hand side of the @item lines.
40905 @item break [@var{file}:]@var{functiop}
40906 Set a breakpoint at @var{function} (in @var{file}).
40908 @item run [@var{arglist}]
40909 Start your program (with @var{arglist}, if specified).
40912 Backtrace: display the program stack.
40914 @item print @var{expr}
40915 Display the value of an expression.
40918 Continue running your program (after stopping, e.g. at a breakpoint).
40921 Execute next program line (after stopping); step @emph{over} any
40922 function calls in the line.
40924 @item edit [@var{file}:]@var{function}
40925 look at the program line where it is presently stopped.
40927 @item list [@var{file}:]@var{function}
40928 type the text of the program in the vicinity of where it is presently stopped.
40931 Execute next program line (after stopping); step @emph{into} any
40932 function calls in the line.
40934 @item help [@var{name}]
40935 Show information about @value{GDBN} command @var{name}, or general information
40936 about using @value{GDBN}.
40939 Exit from @value{GDBN}.
40943 For full details on @value{GDBN},
40944 see @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
40945 by Richard M. Stallman and Roland H. Pesch. The same text is available online
40946 as the @code{gdb} entry in the @code{info} program.
40950 @c man begin OPTIONS gdb
40951 Any arguments other than options specify an executable
40952 file and core file (or process ID); that is, the first argument
40953 encountered with no
40954 associated option flag is equivalent to a @option{-se} option, and the second,
40955 if any, is equivalent to a @option{-c} option if it's the name of a file.
40957 both long and short forms; both are shown here. The long forms are also
40958 recognized if you truncate them, so long as enough of the option is
40959 present to be unambiguous. (If you prefer, you can flag option
40960 arguments with @option{+} rather than @option{-}, though we illustrate the
40961 more usual convention.)
40963 All the options and command line arguments you give are processed
40964 in sequential order. The order makes a difference when the @option{-x}
40970 List all options, with brief explanations.
40972 @item -symbols=@var{file}
40973 @itemx -s @var{file}
40974 Read symbol table from file @var{file}.
40977 Enable writing into executable and core files.
40979 @item -exec=@var{file}
40980 @itemx -e @var{file}
40981 Use file @var{file} as the executable file to execute when
40982 appropriate, and for examining pure data in conjunction with a core
40985 @item -se=@var{file}
40986 Read symbol table from file @var{file} and use it as the executable
40989 @item -core=@var{file}
40990 @itemx -c @var{file}
40991 Use file @var{file} as a core dump to examine.
40993 @item -command=@var{file}
40994 @itemx -x @var{file}
40995 Execute @value{GDBN} commands from file @var{file}.
40997 @item -ex @var{command}
40998 Execute given @value{GDBN} @var{command}.
41000 @item -directory=@var{directory}
41001 @itemx -d @var{directory}
41002 Add @var{directory} to the path to search for source files.
41005 Do not execute commands from @file{~/.gdbinit}.
41009 Do not execute commands from any @file{.gdbinit} initialization files.
41013 ``Quiet''. Do not print the introductory and copyright messages. These
41014 messages are also suppressed in batch mode.
41017 Run in batch mode. Exit with status @code{0} after processing all the command
41018 files specified with @option{-x} (and @file{.gdbinit}, if not inhibited).
41019 Exit with nonzero status if an error occurs in executing the @value{GDBN}
41020 commands in the command files.
41022 Batch mode may be useful for running @value{GDBN} as a filter, for example to
41023 download and run a program on another computer; in order to make this
41024 more useful, the message
41027 Program exited normally.
41031 (which is ordinarily issued whenever a program running under @value{GDBN} control
41032 terminates) is not issued when running in batch mode.
41034 @item -cd=@var{directory}
41035 Run @value{GDBN} using @var{directory} as its working directory,
41036 instead of the current directory.
41040 Emacs sets this option when it runs @value{GDBN} as a subprocess. It tells
41041 @value{GDBN} to output the full file name and line number in a standard,
41042 recognizable fashion each time a stack frame is displayed (which
41043 includes each time the program stops). This recognizable format looks
41044 like two @samp{\032} characters, followed by the file name, line number
41045 and character position separated by colons, and a newline. The
41046 Emacs-to-@value{GDBN} interface program uses the two @samp{\032}
41047 characters as a signal to display the source code for the frame.
41050 Set the line speed (baud rate or bits per second) of any serial
41051 interface used by @value{GDBN} for remote debugging.
41053 @item -tty=@var{device}
41054 Run using @var{device} for your program's standard input and output.
41058 @c man begin SEEALSO gdb
41060 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41061 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41062 documentation are properly installed at your site, the command
41069 should give you access to the complete manual.
41071 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41072 Richard M. Stallman and Roland H. Pesch, July 1991.
41076 @node gdbserver man
41077 @heading gdbserver man
41079 @c man title gdbserver Remote Server for the GNU Debugger
41081 @c man begin SYNOPSIS gdbserver
41082 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
41084 gdbserver --attach @var{comm} @var{pid}
41086 gdbserver --multi @var{comm}
41090 @c man begin DESCRIPTION gdbserver
41091 @command{gdbserver} is a program that allows you to run @value{GDBN} on a different machine
41092 than the one which is running the program being debugged.
41095 @subheading Usage (server (target) side)
41098 Usage (server (target) side):
41101 First, you need to have a copy of the program you want to debug put onto
41102 the target system. The program can be stripped to save space if needed, as
41103 @command{gdbserver} doesn't care about symbols. All symbol handling is taken care of by
41104 the @value{GDBN} running on the host system.
41106 To use the server, you log on to the target system, and run the @command{gdbserver}
41107 program. You must tell it (a) how to communicate with @value{GDBN}, (b) the name of
41108 your program, and (c) its arguments. The general syntax is:
41111 target> gdbserver @var{comm} @var{program} [@var{args} ...]
41114 For example, using a serial port, you might say:
41118 @c @file would wrap it as F</dev/com1>.
41119 target> gdbserver /dev/com1 emacs foo.txt
41122 target> gdbserver @file{/dev/com1} emacs foo.txt
41126 This tells @command{gdbserver} to debug emacs with an argument of foo.txt, and
41127 to communicate with @value{GDBN} via @file{/dev/com1}. @command{gdbserver} now
41128 waits patiently for the host @value{GDBN} to communicate with it.
41130 To use a TCP connection, you could say:
41133 target> gdbserver host:2345 emacs foo.txt
41136 This says pretty much the same thing as the last example, except that we are
41137 going to communicate with the @code{host} @value{GDBN} via TCP. The @code{host:2345} argument means
41138 that we are expecting to see a TCP connection from @code{host} to local TCP port
41139 2345. (Currently, the @code{host} part is ignored.) You can choose any number you
41140 want for the port number as long as it does not conflict with any existing TCP
41141 ports on the target system. This same port number must be used in the host
41142 @value{GDBN}s @code{target remote} command, which will be described shortly. Note that if
41143 you chose a port number that conflicts with another service, @command{gdbserver} will
41144 print an error message and exit.
41146 @command{gdbserver} can also attach to running programs.
41147 This is accomplished via the @option{--attach} argument. The syntax is:
41150 target> gdbserver --attach @var{comm} @var{pid}
41153 @var{pid} is the process ID of a currently running process. It isn't
41154 necessary to point @command{gdbserver} at a binary for the running process.
41156 To start @code{gdbserver} without supplying an initial command to run
41157 or process ID to attach, use the @option{--multi} command line option.
41158 In such case you should connect using @kbd{target extended-remote} to start
41159 the program you want to debug.
41162 target> gdbserver --multi @var{comm}
41166 @subheading Usage (host side)
41172 You need an unstripped copy of the target program on your host system, since
41173 @value{GDBN} needs to examine it's symbol tables and such. Start up @value{GDBN} as you normally
41174 would, with the target program as the first argument. (You may need to use the
41175 @option{--baud} option if the serial line is running at anything except 9600 baud.)
41176 That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only
41177 new command you need to know about is @code{target remote}
41178 (or @code{target extended-remote}). Its argument is either
41179 a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT}
41180 descriptor. For example:
41184 @c @file would wrap it as F</dev/ttyb>.
41185 (gdb) target remote /dev/ttyb
41188 (gdb) target remote @file{/dev/ttyb}
41193 communicates with the server via serial line @file{/dev/ttyb}, and:
41196 (gdb) target remote the-target:2345
41200 communicates via a TCP connection to port 2345 on host `the-target', where
41201 you previously started up @command{gdbserver} with the same port number. Note that for
41202 TCP connections, you must start up @command{gdbserver} prior to using the `target remote'
41203 command, otherwise you may get an error that looks something like
41204 `Connection refused'.
41206 @command{gdbserver} can also debug multiple inferiors at once,
41209 the @value{GDBN} manual in node @code{Inferiors and Programs}
41210 -- shell command @code{info -f gdb -n 'Inferiors and Programs'}.
41213 @ref{Inferiors and Programs}.
41215 In such case use the @code{extended-remote} @value{GDBN} command variant:
41218 (gdb) target extended-remote the-target:2345
41221 The @command{gdbserver} option @option{--multi} may or may not be used in such
41225 @c man begin OPTIONS gdbserver
41226 There are three different modes for invoking @command{gdbserver}:
41231 Debug a specific program specified by its program name:
41234 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
41237 The @var{comm} parameter specifies how should the server communicate
41238 with @value{GDBN}; it is either a device name (to use a serial line),
41239 a TCP port number (@code{:1234}), or @code{-} or @code{stdio} to use
41240 stdin/stdout of @code{gdbserver}. Specify the name of the program to
41241 debug in @var{prog}. Any remaining arguments will be passed to the
41242 program verbatim. When the program exits, @value{GDBN} will close the
41243 connection, and @code{gdbserver} will exit.
41246 Debug a specific program by specifying the process ID of a running
41250 gdbserver --attach @var{comm} @var{pid}
41253 The @var{comm} parameter is as described above. Supply the process ID
41254 of a running program in @var{pid}; @value{GDBN} will do everything
41255 else. Like with the previous mode, when the process @var{pid} exits,
41256 @value{GDBN} will close the connection, and @code{gdbserver} will exit.
41259 Multi-process mode -- debug more than one program/process:
41262 gdbserver --multi @var{comm}
41265 In this mode, @value{GDBN} can instruct @command{gdbserver} which
41266 command(s) to run. Unlike the other 2 modes, @value{GDBN} will not
41267 close the connection when a process being debugged exits, so you can
41268 debug several processes in the same session.
41271 In each of the modes you may specify these options:
41276 List all options, with brief explanations.
41279 This option causes @command{gdbserver} to print its version number and exit.
41282 @command{gdbserver} will attach to a running program. The syntax is:
41285 target> gdbserver --attach @var{comm} @var{pid}
41288 @var{pid} is the process ID of a currently running process. It isn't
41289 necessary to point @command{gdbserver} at a binary for the running process.
41292 To start @code{gdbserver} without supplying an initial command to run
41293 or process ID to attach, use this command line option.
41294 Then you can connect using @kbd{target extended-remote} and start
41295 the program you want to debug. The syntax is:
41298 target> gdbserver --multi @var{comm}
41302 Instruct @code{gdbserver} to display extra status information about the debugging
41304 This option is intended for @code{gdbserver} development and for bug reports to
41307 @item --remote-debug
41308 Instruct @code{gdbserver} to display remote protocol debug output.
41309 This option is intended for @code{gdbserver} development and for bug reports to
41312 @item --debug-format=option1@r{[},option2,...@r{]}
41313 Instruct @code{gdbserver} to include extra information in each line
41314 of debugging output.
41315 @xref{Other Command-Line Arguments for gdbserver}.
41318 Specify a wrapper to launch programs
41319 for debugging. The option should be followed by the name of the
41320 wrapper, then any command-line arguments to pass to the wrapper, then
41321 @kbd{--} indicating the end of the wrapper arguments.
41324 By default, @command{gdbserver} keeps the listening TCP port open, so that
41325 additional connections are possible. However, if you start @code{gdbserver}
41326 with the @option{--once} option, it will stop listening for any further
41327 connection attempts after connecting to the first @value{GDBN} session.
41329 @c --disable-packet is not documented for users.
41331 @c --disable-randomization and --no-disable-randomization are superseded by
41332 @c QDisableRandomization.
41337 @c man begin SEEALSO gdbserver
41339 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41340 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41341 documentation are properly installed at your site, the command
41347 should give you access to the complete manual.
41349 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41350 Richard M. Stallman and Roland H. Pesch, July 1991.
41357 @c man title gcore Generate a core file of a running program
41360 @c man begin SYNOPSIS gcore
41361 gcore [-o @var{filename}] @var{pid}
41365 @c man begin DESCRIPTION gcore
41366 Generate a core dump of a running program with process ID @var{pid}.
41367 Produced file is equivalent to a kernel produced core file as if the process
41368 crashed (and if @kbd{ulimit -c} were used to set up an appropriate core dump
41369 limit). Unlike after a crash, after @command{gcore} the program remains
41370 running without any change.
41373 @c man begin OPTIONS gcore
41375 @item -o @var{filename}
41376 The optional argument
41377 @var{filename} specifies the file name where to put the core dump.
41378 If not specified, the file name defaults to @file{core.@var{pid}},
41379 where @var{pid} is the running program process ID.
41383 @c man begin SEEALSO gcore
41385 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41386 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41387 documentation are properly installed at your site, the command
41394 should give you access to the complete manual.
41396 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41397 Richard M. Stallman and Roland H. Pesch, July 1991.
41404 @c man title gdbinit GDB initialization scripts
41407 @c man begin SYNOPSIS gdbinit
41408 @ifset SYSTEM_GDBINIT
41409 @value{SYSTEM_GDBINIT}
41418 @c man begin DESCRIPTION gdbinit
41419 These files contain @value{GDBN} commands to automatically execute during
41420 @value{GDBN} startup. The lines of contents are canned sequences of commands,
41423 the @value{GDBN} manual in node @code{Sequences}
41424 -- shell command @code{info -f gdb -n Sequences}.
41430 Please read more in
41432 the @value{GDBN} manual in node @code{Startup}
41433 -- shell command @code{info -f gdb -n Startup}.
41440 @ifset SYSTEM_GDBINIT
41441 @item @value{SYSTEM_GDBINIT}
41443 @ifclear SYSTEM_GDBINIT
41444 @item (not enabled with @code{--with-system-gdbinit} during compilation)
41446 System-wide initialization file. It is executed unless user specified
41447 @value{GDBN} option @code{-nx} or @code{-n}.
41450 the @value{GDBN} manual in node @code{System-wide configuration}
41451 -- shell command @code{info -f gdb -n 'System-wide configuration'}.
41454 @ref{System-wide configuration}.
41458 User initialization file. It is executed unless user specified
41459 @value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
41462 Initialization file for current directory. It may need to be enabled with
41463 @value{GDBN} security command @code{set auto-load local-gdbinit}.
41466 the @value{GDBN} manual in node @code{Init File in the Current Directory}
41467 -- shell command @code{info -f gdb -n 'Init File in the Current Directory'}.
41470 @ref{Init File in the Current Directory}.
41475 @c man begin SEEALSO gdbinit
41477 gdb(1), @code{info -f gdb -n Startup}
41479 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41480 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41481 documentation are properly installed at your site, the command
41487 should give you access to the complete manual.
41489 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41490 Richard M. Stallman and Roland H. Pesch, July 1991.
41496 @node GNU Free Documentation License
41497 @appendix GNU Free Documentation License
41500 @node Concept Index
41501 @unnumbered Concept Index
41505 @node Command and Variable Index
41506 @unnumbered Command, Variable, and Function Index
41511 % I think something like @@colophon should be in texinfo. In the
41513 \long\def\colophon{\hbox to0pt{}\vfill
41514 \centerline{The body of this manual is set in}
41515 \centerline{\fontname\tenrm,}
41516 \centerline{with headings in {\bf\fontname\tenbf}}
41517 \centerline{and examples in {\tt\fontname\tentt}.}
41518 \centerline{{\it\fontname\tenit\/},}
41519 \centerline{{\bf\fontname\tenbf}, and}
41520 \centerline{{\sl\fontname\tensl\/}}
41521 \centerline{are used for emphasis.}\vfill}
41523 % Blame: doc@@cygnus.com, 1991.